1 //===--- AnalysisConsumer.cpp - ASTConsumer for running Analyses ----------===// 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 // "Meta" ASTConsumer for running different source analyses. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "clang/StaticAnalyzer/Frontend/AnalysisConsumer.h" 15 #include "ModelInjector.h" 16 #include "clang/AST/ASTConsumer.h" 17 #include "clang/AST/RecursiveASTVisitor.h" 18 #include "clang/AST/Decl.h" 19 #include "clang/AST/DeclCXX.h" 20 #include "clang/AST/DeclObjC.h" 21 #include "clang/AST/ParentMap.h" 22 #include "clang/Analysis/Analyses/LiveVariables.h" 23 #include "clang/Analysis/CFG.h" 24 #include "clang/Analysis/CallGraph.h" 25 #include "clang/Analysis/CodeInjector.h" 26 #include "clang/Basic/FileManager.h" 27 #include "clang/Basic/SourceManager.h" 28 #include "clang/Frontend/CompilerInstance.h" 29 #include "clang/Lex/Preprocessor.h" 30 #include "clang/StaticAnalyzer/Checkers/LocalCheckers.h" 31 #include "clang/StaticAnalyzer/Core/AnalyzerOptions.h" 32 #include "clang/StaticAnalyzer/Core/BugReporter/BugReporter.h" 33 #include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h" 34 #include "clang/StaticAnalyzer/Core/CheckerManager.h" 35 #include "clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h" 36 #include "clang/StaticAnalyzer/Core/PathSensitive/AnalysisManager.h" 37 #include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h" 38 #include "clang/StaticAnalyzer/Frontend/CheckerRegistration.h" 39 #include "llvm/ADT/DepthFirstIterator.h" 40 #include "llvm/ADT/PostOrderIterator.h" 41 #include "llvm/ADT/SmallPtrSet.h" 42 #include "llvm/ADT/Statistic.h" 43 #include "llvm/Support/FileSystem.h" 44 #include "llvm/Support/Path.h" 45 #include "llvm/Support/Program.h" 46 #include "llvm/Support/Timer.h" 47 #include "llvm/Support/raw_ostream.h" 48 #include <memory> 49 #include <queue> 50 51 using namespace clang; 52 using namespace ento; 53 using llvm::SmallPtrSet; 54 55 #define DEBUG_TYPE "AnalysisConsumer" 56 57 static std::unique_ptr<ExplodedNode::Auditor> CreateUbiViz(); 58 59 STATISTIC(NumFunctionTopLevel, "The # of functions at top level."); 60 STATISTIC(NumFunctionsAnalyzed, 61 "The # of functions and blocks analyzed (as top level " 62 "with inlining turned on)."); 63 STATISTIC(NumBlocksInAnalyzedFunctions, 64 "The # of basic blocks in the analyzed functions."); 65 STATISTIC(PercentReachableBlocks, "The % of reachable basic blocks."); 66 STATISTIC(MaxCFGSize, "The maximum number of basic blocks in a function."); 67 68 //===----------------------------------------------------------------------===// 69 // Special PathDiagnosticConsumers. 70 //===----------------------------------------------------------------------===// 71 72 void ento::createPlistHTMLDiagnosticConsumer(AnalyzerOptions &AnalyzerOpts, 73 PathDiagnosticConsumers &C, 74 const std::string &prefix, 75 const Preprocessor &PP) { 76 createHTMLDiagnosticConsumer(AnalyzerOpts, C, 77 llvm::sys::path::parent_path(prefix), PP); 78 createPlistDiagnosticConsumer(AnalyzerOpts, C, prefix, PP); 79 } 80 81 void ento::createTextPathDiagnosticConsumer(AnalyzerOptions &AnalyzerOpts, 82 PathDiagnosticConsumers &C, 83 const std::string &Prefix, 84 const clang::Preprocessor &PP) { 85 llvm_unreachable("'text' consumer should be enabled on ClangDiags"); 86 } 87 88 namespace { 89 class ClangDiagPathDiagConsumer : public PathDiagnosticConsumer { 90 DiagnosticsEngine &Diag; 91 bool IncludePath; 92 public: 93 ClangDiagPathDiagConsumer(DiagnosticsEngine &Diag) 94 : Diag(Diag), IncludePath(false) {} 95 ~ClangDiagPathDiagConsumer() override {} 96 StringRef getName() const override { return "ClangDiags"; } 97 98 bool supportsLogicalOpControlFlow() const override { return true; } 99 bool supportsCrossFileDiagnostics() const override { return true; } 100 101 PathGenerationScheme getGenerationScheme() const override { 102 return IncludePath ? Minimal : None; 103 } 104 105 void enablePaths() { 106 IncludePath = true; 107 } 108 109 void FlushDiagnosticsImpl(std::vector<const PathDiagnostic *> &Diags, 110 FilesMade *filesMade) override { 111 unsigned WarnID = Diag.getCustomDiagID(DiagnosticsEngine::Warning, "%0"); 112 unsigned NoteID = Diag.getCustomDiagID(DiagnosticsEngine::Note, "%0"); 113 114 for (std::vector<const PathDiagnostic*>::iterator I = Diags.begin(), 115 E = Diags.end(); I != E; ++I) { 116 const PathDiagnostic *PD = *I; 117 SourceLocation WarnLoc = PD->getLocation().asLocation(); 118 Diag.Report(WarnLoc, WarnID) << PD->getShortDescription() 119 << PD->path.back()->getRanges(); 120 121 if (!IncludePath) 122 continue; 123 124 PathPieces FlatPath = PD->path.flatten(/*ShouldFlattenMacros=*/true); 125 for (PathPieces::const_iterator PI = FlatPath.begin(), 126 PE = FlatPath.end(); 127 PI != PE; ++PI) { 128 SourceLocation NoteLoc = (*PI)->getLocation().asLocation(); 129 Diag.Report(NoteLoc, NoteID) << (*PI)->getString() 130 << (*PI)->getRanges(); 131 } 132 } 133 } 134 }; 135 } // end anonymous namespace 136 137 //===----------------------------------------------------------------------===// 138 // AnalysisConsumer declaration. 139 //===----------------------------------------------------------------------===// 140 141 namespace { 142 143 class AnalysisConsumer : public AnalysisASTConsumer, 144 public RecursiveASTVisitor<AnalysisConsumer> { 145 enum { 146 AM_None = 0, 147 AM_Syntax = 0x1, 148 AM_Path = 0x2 149 }; 150 typedef unsigned AnalysisMode; 151 152 /// Mode of the analyzes while recursively visiting Decls. 153 AnalysisMode RecVisitorMode; 154 /// Bug Reporter to use while recursively visiting Decls. 155 BugReporter *RecVisitorBR; 156 157 public: 158 ASTContext *Ctx; 159 const Preprocessor &PP; 160 const std::string OutDir; 161 AnalyzerOptionsRef Opts; 162 ArrayRef<std::string> Plugins; 163 CodeInjector *Injector; 164 165 /// \brief Stores the declarations from the local translation unit. 166 /// Note, we pre-compute the local declarations at parse time as an 167 /// optimization to make sure we do not deserialize everything from disk. 168 /// The local declaration to all declarations ratio might be very small when 169 /// working with a PCH file. 170 SetOfDecls LocalTUDecls; 171 172 // Set of PathDiagnosticConsumers. Owned by AnalysisManager. 173 PathDiagnosticConsumers PathConsumers; 174 175 StoreManagerCreator CreateStoreMgr; 176 ConstraintManagerCreator CreateConstraintMgr; 177 178 std::unique_ptr<CheckerManager> checkerMgr; 179 std::unique_ptr<AnalysisManager> Mgr; 180 181 /// Time the analyzes time of each translation unit. 182 static llvm::Timer* TUTotalTimer; 183 184 /// The information about analyzed functions shared throughout the 185 /// translation unit. 186 FunctionSummariesTy FunctionSummaries; 187 188 AnalysisConsumer(const Preprocessor& pp, 189 const std::string& outdir, 190 AnalyzerOptionsRef opts, 191 ArrayRef<std::string> plugins, 192 CodeInjector *injector) 193 : RecVisitorMode(0), RecVisitorBR(nullptr), Ctx(nullptr), PP(pp), 194 OutDir(outdir), Opts(opts), Plugins(plugins), Injector(injector) { 195 DigestAnalyzerOptions(); 196 if (Opts->PrintStats) { 197 llvm::EnableStatistics(); 198 TUTotalTimer = new llvm::Timer("Analyzer Total Time"); 199 } 200 } 201 202 ~AnalysisConsumer() override { 203 if (Opts->PrintStats) 204 delete TUTotalTimer; 205 } 206 207 void DigestAnalyzerOptions() { 208 if (Opts->AnalysisDiagOpt != PD_NONE) { 209 // Create the PathDiagnosticConsumer. 210 ClangDiagPathDiagConsumer *clangDiags = 211 new ClangDiagPathDiagConsumer(PP.getDiagnostics()); 212 PathConsumers.push_back(clangDiags); 213 214 if (Opts->AnalysisDiagOpt == PD_TEXT) { 215 clangDiags->enablePaths(); 216 217 } else if (!OutDir.empty()) { 218 switch (Opts->AnalysisDiagOpt) { 219 default: 220 #define ANALYSIS_DIAGNOSTICS(NAME, CMDFLAG, DESC, CREATEFN) \ 221 case PD_##NAME: \ 222 CREATEFN(*Opts.get(), PathConsumers, OutDir, PP); \ 223 break; 224 #include "clang/StaticAnalyzer/Core/Analyses.def" 225 } 226 } 227 } 228 229 // Create the analyzer component creators. 230 switch (Opts->AnalysisStoreOpt) { 231 default: 232 llvm_unreachable("Unknown store manager."); 233 #define ANALYSIS_STORE(NAME, CMDFLAG, DESC, CREATEFN) \ 234 case NAME##Model: CreateStoreMgr = CREATEFN; break; 235 #include "clang/StaticAnalyzer/Core/Analyses.def" 236 } 237 238 switch (Opts->AnalysisConstraintsOpt) { 239 default: 240 llvm_unreachable("Unknown constraint manager."); 241 #define ANALYSIS_CONSTRAINTS(NAME, CMDFLAG, DESC, CREATEFN) \ 242 case NAME##Model: CreateConstraintMgr = CREATEFN; break; 243 #include "clang/StaticAnalyzer/Core/Analyses.def" 244 } 245 } 246 247 void DisplayFunction(const Decl *D, AnalysisMode Mode, 248 ExprEngine::InliningModes IMode) { 249 if (!Opts->AnalyzerDisplayProgress) 250 return; 251 252 SourceManager &SM = Mgr->getASTContext().getSourceManager(); 253 PresumedLoc Loc = SM.getPresumedLoc(D->getLocation()); 254 if (Loc.isValid()) { 255 llvm::errs() << "ANALYZE"; 256 257 if (Mode == AM_Syntax) 258 llvm::errs() << " (Syntax)"; 259 else if (Mode == AM_Path) { 260 llvm::errs() << " (Path, "; 261 switch (IMode) { 262 case ExprEngine::Inline_Minimal: 263 llvm::errs() << " Inline_Minimal"; 264 break; 265 case ExprEngine::Inline_Regular: 266 llvm::errs() << " Inline_Regular"; 267 break; 268 } 269 llvm::errs() << ")"; 270 } 271 else 272 assert(Mode == (AM_Syntax | AM_Path) && "Unexpected mode!"); 273 274 llvm::errs() << ": " << Loc.getFilename(); 275 if (isa<FunctionDecl>(D) || isa<ObjCMethodDecl>(D)) { 276 const NamedDecl *ND = cast<NamedDecl>(D); 277 llvm::errs() << ' ' << *ND << '\n'; 278 } 279 else if (isa<BlockDecl>(D)) { 280 llvm::errs() << ' ' << "block(line:" << Loc.getLine() << ",col:" 281 << Loc.getColumn() << '\n'; 282 } 283 else if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) { 284 Selector S = MD->getSelector(); 285 llvm::errs() << ' ' << S.getAsString(); 286 } 287 } 288 } 289 290 void Initialize(ASTContext &Context) override { 291 Ctx = &Context; 292 checkerMgr = createCheckerManager(*Opts, PP.getLangOpts(), Plugins, 293 PP.getDiagnostics()); 294 295 Mgr = llvm::make_unique<AnalysisManager>( 296 *Ctx, PP.getDiagnostics(), PP.getLangOpts(), PathConsumers, 297 CreateStoreMgr, CreateConstraintMgr, checkerMgr.get(), *Opts, Injector); 298 } 299 300 /// \brief Store the top level decls in the set to be processed later on. 301 /// (Doing this pre-processing avoids deserialization of data from PCH.) 302 bool HandleTopLevelDecl(DeclGroupRef D) override; 303 void HandleTopLevelDeclInObjCContainer(DeclGroupRef D) override; 304 305 void HandleTranslationUnit(ASTContext &C) override; 306 307 /// \brief Determine which inlining mode should be used when this function is 308 /// analyzed. This allows to redefine the default inlining policies when 309 /// analyzing a given function. 310 ExprEngine::InliningModes 311 getInliningModeForFunction(const Decl *D, const SetOfConstDecls &Visited); 312 313 /// \brief Build the call graph for all the top level decls of this TU and 314 /// use it to define the order in which the functions should be visited. 315 void HandleDeclsCallGraph(const unsigned LocalTUDeclsSize); 316 317 /// \brief Run analyzes(syntax or path sensitive) on the given function. 318 /// \param Mode - determines if we are requesting syntax only or path 319 /// sensitive only analysis. 320 /// \param VisitedCallees - The output parameter, which is populated with the 321 /// set of functions which should be considered analyzed after analyzing the 322 /// given root function. 323 void HandleCode(Decl *D, AnalysisMode Mode, 324 ExprEngine::InliningModes IMode = ExprEngine::Inline_Minimal, 325 SetOfConstDecls *VisitedCallees = nullptr); 326 327 void RunPathSensitiveChecks(Decl *D, 328 ExprEngine::InliningModes IMode, 329 SetOfConstDecls *VisitedCallees); 330 void ActionExprEngine(Decl *D, bool ObjCGCEnabled, 331 ExprEngine::InliningModes IMode, 332 SetOfConstDecls *VisitedCallees); 333 334 /// Visitors for the RecursiveASTVisitor. 335 bool shouldWalkTypesOfTypeLocs() const { return false; } 336 337 /// Handle callbacks for arbitrary Decls. 338 bool VisitDecl(Decl *D) { 339 AnalysisMode Mode = getModeForDecl(D, RecVisitorMode); 340 if (Mode & AM_Syntax) 341 checkerMgr->runCheckersOnASTDecl(D, *Mgr, *RecVisitorBR); 342 return true; 343 } 344 345 bool VisitFunctionDecl(FunctionDecl *FD) { 346 IdentifierInfo *II = FD->getIdentifier(); 347 if (II && II->getName().startswith("__inline")) 348 return true; 349 350 // We skip function template definitions, as their semantics is 351 // only determined when they are instantiated. 352 if (FD->isThisDeclarationADefinition() && 353 !FD->isDependentContext()) { 354 assert(RecVisitorMode == AM_Syntax || Mgr->shouldInlineCall() == false); 355 HandleCode(FD, RecVisitorMode); 356 } 357 return true; 358 } 359 360 bool VisitObjCMethodDecl(ObjCMethodDecl *MD) { 361 if (MD->isThisDeclarationADefinition()) { 362 assert(RecVisitorMode == AM_Syntax || Mgr->shouldInlineCall() == false); 363 HandleCode(MD, RecVisitorMode); 364 } 365 return true; 366 } 367 368 bool VisitBlockDecl(BlockDecl *BD) { 369 if (BD->hasBody()) { 370 assert(RecVisitorMode == AM_Syntax || Mgr->shouldInlineCall() == false); 371 // Since we skip function template definitions, we should skip blocks 372 // declared in those functions as well. 373 if (!BD->isDependentContext()) { 374 HandleCode(BD, RecVisitorMode); 375 } 376 } 377 return true; 378 } 379 380 void AddDiagnosticConsumer(PathDiagnosticConsumer *Consumer) override { 381 PathConsumers.push_back(Consumer); 382 } 383 384 private: 385 void storeTopLevelDecls(DeclGroupRef DG); 386 387 /// \brief Check if we should skip (not analyze) the given function. 388 AnalysisMode getModeForDecl(Decl *D, AnalysisMode Mode); 389 390 }; 391 } // end anonymous namespace 392 393 394 //===----------------------------------------------------------------------===// 395 // AnalysisConsumer implementation. 396 //===----------------------------------------------------------------------===// 397 llvm::Timer* AnalysisConsumer::TUTotalTimer = nullptr; 398 399 bool AnalysisConsumer::HandleTopLevelDecl(DeclGroupRef DG) { 400 storeTopLevelDecls(DG); 401 return true; 402 } 403 404 void AnalysisConsumer::HandleTopLevelDeclInObjCContainer(DeclGroupRef DG) { 405 storeTopLevelDecls(DG); 406 } 407 408 void AnalysisConsumer::storeTopLevelDecls(DeclGroupRef DG) { 409 for (DeclGroupRef::iterator I = DG.begin(), E = DG.end(); I != E; ++I) { 410 411 // Skip ObjCMethodDecl, wait for the objc container to avoid 412 // analyzing twice. 413 if (isa<ObjCMethodDecl>(*I)) 414 continue; 415 416 LocalTUDecls.push_back(*I); 417 } 418 } 419 420 static bool shouldSkipFunction(const Decl *D, 421 const SetOfConstDecls &Visited, 422 const SetOfConstDecls &VisitedAsTopLevel) { 423 if (VisitedAsTopLevel.count(D)) 424 return true; 425 426 // We want to re-analyse the functions as top level in the following cases: 427 // - The 'init' methods should be reanalyzed because 428 // ObjCNonNilReturnValueChecker assumes that '[super init]' never returns 429 // 'nil' and unless we analyze the 'init' functions as top level, we will 430 // not catch errors within defensive code. 431 // - We want to reanalyze all ObjC methods as top level to report Retain 432 // Count naming convention errors more aggressively. 433 if (isa<ObjCMethodDecl>(D)) 434 return false; 435 436 // Otherwise, if we visited the function before, do not reanalyze it. 437 return Visited.count(D); 438 } 439 440 ExprEngine::InliningModes 441 AnalysisConsumer::getInliningModeForFunction(const Decl *D, 442 const SetOfConstDecls &Visited) { 443 // We want to reanalyze all ObjC methods as top level to report Retain 444 // Count naming convention errors more aggressively. But we should tune down 445 // inlining when reanalyzing an already inlined function. 446 if (Visited.count(D)) { 447 assert(isa<ObjCMethodDecl>(D) && 448 "We are only reanalyzing ObjCMethods."); 449 const ObjCMethodDecl *ObjCM = cast<ObjCMethodDecl>(D); 450 if (ObjCM->getMethodFamily() != OMF_init) 451 return ExprEngine::Inline_Minimal; 452 } 453 454 return ExprEngine::Inline_Regular; 455 } 456 457 void AnalysisConsumer::HandleDeclsCallGraph(const unsigned LocalTUDeclsSize) { 458 // Build the Call Graph by adding all the top level declarations to the graph. 459 // Note: CallGraph can trigger deserialization of more items from a pch 460 // (though HandleInterestingDecl); triggering additions to LocalTUDecls. 461 // We rely on random access to add the initially processed Decls to CG. 462 CallGraph CG; 463 for (unsigned i = 0 ; i < LocalTUDeclsSize ; ++i) { 464 CG.addToCallGraph(LocalTUDecls[i]); 465 } 466 467 // Walk over all of the call graph nodes in topological order, so that we 468 // analyze parents before the children. Skip the functions inlined into 469 // the previously processed functions. Use external Visited set to identify 470 // inlined functions. The topological order allows the "do not reanalyze 471 // previously inlined function" performance heuristic to be triggered more 472 // often. 473 SetOfConstDecls Visited; 474 SetOfConstDecls VisitedAsTopLevel; 475 llvm::ReversePostOrderTraversal<clang::CallGraph*> RPOT(&CG); 476 for (llvm::ReversePostOrderTraversal<clang::CallGraph*>::rpo_iterator 477 I = RPOT.begin(), E = RPOT.end(); I != E; ++I) { 478 NumFunctionTopLevel++; 479 480 CallGraphNode *N = *I; 481 Decl *D = N->getDecl(); 482 483 // Skip the abstract root node. 484 if (!D) 485 continue; 486 487 // Skip the functions which have been processed already or previously 488 // inlined. 489 if (shouldSkipFunction(D, Visited, VisitedAsTopLevel)) 490 continue; 491 492 // Analyze the function. 493 SetOfConstDecls VisitedCallees; 494 495 HandleCode(D, AM_Path, getInliningModeForFunction(D, Visited), 496 (Mgr->options.InliningMode == All ? nullptr : &VisitedCallees)); 497 498 // Add the visited callees to the global visited set. 499 for (SetOfConstDecls::iterator I = VisitedCallees.begin(), 500 E = VisitedCallees.end(); I != E; ++I) { 501 Visited.insert(*I); 502 } 503 VisitedAsTopLevel.insert(D); 504 } 505 } 506 507 void AnalysisConsumer::HandleTranslationUnit(ASTContext &C) { 508 // Don't run the actions if an error has occurred with parsing the file. 509 DiagnosticsEngine &Diags = PP.getDiagnostics(); 510 if (Diags.hasErrorOccurred() || Diags.hasFatalErrorOccurred()) 511 return; 512 513 // Don't analyze if the user explicitly asked for no checks to be performed 514 // on this file. 515 if (Opts->DisableAllChecks) 516 return; 517 518 { 519 if (TUTotalTimer) TUTotalTimer->startTimer(); 520 521 // Introduce a scope to destroy BR before Mgr. 522 BugReporter BR(*Mgr); 523 TranslationUnitDecl *TU = C.getTranslationUnitDecl(); 524 checkerMgr->runCheckersOnASTDecl(TU, *Mgr, BR); 525 526 // Run the AST-only checks using the order in which functions are defined. 527 // If inlining is not turned on, use the simplest function order for path 528 // sensitive analyzes as well. 529 RecVisitorMode = AM_Syntax; 530 if (!Mgr->shouldInlineCall()) 531 RecVisitorMode |= AM_Path; 532 RecVisitorBR = &BR; 533 534 // Process all the top level declarations. 535 // 536 // Note: TraverseDecl may modify LocalTUDecls, but only by appending more 537 // entries. Thus we don't use an iterator, but rely on LocalTUDecls 538 // random access. By doing so, we automatically compensate for iterators 539 // possibly being invalidated, although this is a bit slower. 540 const unsigned LocalTUDeclsSize = LocalTUDecls.size(); 541 for (unsigned i = 0 ; i < LocalTUDeclsSize ; ++i) { 542 TraverseDecl(LocalTUDecls[i]); 543 } 544 545 if (Mgr->shouldInlineCall()) 546 HandleDeclsCallGraph(LocalTUDeclsSize); 547 548 // After all decls handled, run checkers on the entire TranslationUnit. 549 checkerMgr->runCheckersOnEndOfTranslationUnit(TU, *Mgr, BR); 550 551 RecVisitorBR = nullptr; 552 } 553 554 // Explicitly destroy the PathDiagnosticConsumer. This will flush its output. 555 // FIXME: This should be replaced with something that doesn't rely on 556 // side-effects in PathDiagnosticConsumer's destructor. This is required when 557 // used with option -disable-free. 558 Mgr.reset(); 559 560 if (TUTotalTimer) TUTotalTimer->stopTimer(); 561 562 // Count how many basic blocks we have not covered. 563 NumBlocksInAnalyzedFunctions = FunctionSummaries.getTotalNumBasicBlocks(); 564 if (NumBlocksInAnalyzedFunctions > 0) 565 PercentReachableBlocks = 566 (FunctionSummaries.getTotalNumVisitedBasicBlocks() * 100) / 567 NumBlocksInAnalyzedFunctions; 568 569 } 570 571 static std::string getFunctionName(const Decl *D) { 572 if (const ObjCMethodDecl *ID = dyn_cast<ObjCMethodDecl>(D)) { 573 return ID->getSelector().getAsString(); 574 } 575 if (const FunctionDecl *ND = dyn_cast<FunctionDecl>(D)) { 576 IdentifierInfo *II = ND->getIdentifier(); 577 if (II) 578 return II->getName(); 579 } 580 return ""; 581 } 582 583 AnalysisConsumer::AnalysisMode 584 AnalysisConsumer::getModeForDecl(Decl *D, AnalysisMode Mode) { 585 if (!Opts->AnalyzeSpecificFunction.empty() && 586 getFunctionName(D) != Opts->AnalyzeSpecificFunction) 587 return AM_None; 588 589 // Unless -analyze-all is specified, treat decls differently depending on 590 // where they came from: 591 // - Main source file: run both path-sensitive and non-path-sensitive checks. 592 // - Header files: run non-path-sensitive checks only. 593 // - System headers: don't run any checks. 594 SourceManager &SM = Ctx->getSourceManager(); 595 const Stmt *Body = D->getBody(); 596 SourceLocation SL = Body ? Body->getLocStart() : D->getLocation(); 597 SL = SM.getExpansionLoc(SL); 598 599 if (!Opts->AnalyzeAll && !SM.isWrittenInMainFile(SL)) { 600 if (SL.isInvalid() || SM.isInSystemHeader(SL)) 601 return AM_None; 602 return Mode & ~AM_Path; 603 } 604 605 return Mode; 606 } 607 608 void AnalysisConsumer::HandleCode(Decl *D, AnalysisMode Mode, 609 ExprEngine::InliningModes IMode, 610 SetOfConstDecls *VisitedCallees) { 611 if (!D->hasBody()) 612 return; 613 Mode = getModeForDecl(D, Mode); 614 if (Mode == AM_None) 615 return; 616 617 DisplayFunction(D, Mode, IMode); 618 CFG *DeclCFG = Mgr->getCFG(D); 619 if (DeclCFG) { 620 unsigned CFGSize = DeclCFG->size(); 621 MaxCFGSize = MaxCFGSize < CFGSize ? CFGSize : MaxCFGSize; 622 } 623 624 // Clear the AnalysisManager of old AnalysisDeclContexts. 625 Mgr->ClearContexts(); 626 BugReporter BR(*Mgr); 627 628 if (Mode & AM_Syntax) 629 checkerMgr->runCheckersOnASTBody(D, *Mgr, BR); 630 if ((Mode & AM_Path) && checkerMgr->hasPathSensitiveCheckers()) { 631 RunPathSensitiveChecks(D, IMode, VisitedCallees); 632 if (IMode != ExprEngine::Inline_Minimal) 633 NumFunctionsAnalyzed++; 634 } 635 } 636 637 //===----------------------------------------------------------------------===// 638 // Path-sensitive checking. 639 //===----------------------------------------------------------------------===// 640 641 void AnalysisConsumer::ActionExprEngine(Decl *D, bool ObjCGCEnabled, 642 ExprEngine::InliningModes IMode, 643 SetOfConstDecls *VisitedCallees) { 644 // Construct the analysis engine. First check if the CFG is valid. 645 // FIXME: Inter-procedural analysis will need to handle invalid CFGs. 646 if (!Mgr->getCFG(D)) 647 return; 648 649 // See if the LiveVariables analysis scales. 650 if (!Mgr->getAnalysisDeclContext(D)->getAnalysis<RelaxedLiveVariables>()) 651 return; 652 653 ExprEngine Eng(*Mgr, ObjCGCEnabled, VisitedCallees, &FunctionSummaries,IMode); 654 655 // Set the graph auditor. 656 std::unique_ptr<ExplodedNode::Auditor> Auditor; 657 if (Mgr->options.visualizeExplodedGraphWithUbiGraph) { 658 Auditor = CreateUbiViz(); 659 ExplodedNode::SetAuditor(Auditor.get()); 660 } 661 662 // Execute the worklist algorithm. 663 Eng.ExecuteWorkList(Mgr->getAnalysisDeclContextManager().getStackFrame(D), 664 Mgr->options.getMaxNodesPerTopLevelFunction()); 665 666 // Release the auditor (if any) so that it doesn't monitor the graph 667 // created BugReporter. 668 ExplodedNode::SetAuditor(nullptr); 669 670 // Visualize the exploded graph. 671 if (Mgr->options.visualizeExplodedGraphWithGraphViz) 672 Eng.ViewGraph(Mgr->options.TrimGraph); 673 674 // Display warnings. 675 Eng.getBugReporter().FlushReports(); 676 } 677 678 void AnalysisConsumer::RunPathSensitiveChecks(Decl *D, 679 ExprEngine::InliningModes IMode, 680 SetOfConstDecls *Visited) { 681 682 switch (Mgr->getLangOpts().getGC()) { 683 case LangOptions::NonGC: 684 ActionExprEngine(D, false, IMode, Visited); 685 break; 686 687 case LangOptions::GCOnly: 688 ActionExprEngine(D, true, IMode, Visited); 689 break; 690 691 case LangOptions::HybridGC: 692 ActionExprEngine(D, false, IMode, Visited); 693 ActionExprEngine(D, true, IMode, Visited); 694 break; 695 } 696 } 697 698 //===----------------------------------------------------------------------===// 699 // AnalysisConsumer creation. 700 //===----------------------------------------------------------------------===// 701 702 std::unique_ptr<AnalysisASTConsumer> 703 ento::CreateAnalysisConsumer(CompilerInstance &CI) { 704 // Disable the effects of '-Werror' when using the AnalysisConsumer. 705 CI.getPreprocessor().getDiagnostics().setWarningsAsErrors(false); 706 707 AnalyzerOptionsRef analyzerOpts = CI.getAnalyzerOpts(); 708 bool hasModelPath = analyzerOpts->Config.count("model-path") > 0; 709 710 return llvm::make_unique<AnalysisConsumer>( 711 CI.getPreprocessor(), CI.getFrontendOpts().OutputFile, analyzerOpts, 712 CI.getFrontendOpts().Plugins, 713 hasModelPath ? new ModelInjector(CI) : nullptr); 714 } 715 716 //===----------------------------------------------------------------------===// 717 // Ubigraph Visualization. FIXME: Move to separate file. 718 //===----------------------------------------------------------------------===// 719 720 namespace { 721 722 class UbigraphViz : public ExplodedNode::Auditor { 723 std::unique_ptr<raw_ostream> Out; 724 std::string Filename; 725 unsigned Cntr; 726 727 typedef llvm::DenseMap<void*,unsigned> VMap; 728 VMap M; 729 730 public: 731 UbigraphViz(std::unique_ptr<raw_ostream> Out, StringRef Filename); 732 733 ~UbigraphViz() override; 734 735 void AddEdge(ExplodedNode *Src, ExplodedNode *Dst) override; 736 }; 737 738 } // end anonymous namespace 739 740 static std::unique_ptr<ExplodedNode::Auditor> CreateUbiViz() { 741 SmallString<128> P; 742 int FD; 743 llvm::sys::fs::createTemporaryFile("llvm_ubi", "", FD, P); 744 llvm::errs() << "Writing '" << P << "'.\n"; 745 746 auto Stream = llvm::make_unique<llvm::raw_fd_ostream>(FD, true); 747 748 return llvm::make_unique<UbigraphViz>(std::move(Stream), P); 749 } 750 751 void UbigraphViz::AddEdge(ExplodedNode *Src, ExplodedNode *Dst) { 752 753 assert (Src != Dst && "Self-edges are not allowed."); 754 755 // Lookup the Src. If it is a new node, it's a root. 756 VMap::iterator SrcI= M.find(Src); 757 unsigned SrcID; 758 759 if (SrcI == M.end()) { 760 M[Src] = SrcID = Cntr++; 761 *Out << "('vertex', " << SrcID << ", ('color','#00ff00'))\n"; 762 } 763 else 764 SrcID = SrcI->second; 765 766 // Lookup the Dst. 767 VMap::iterator DstI= M.find(Dst); 768 unsigned DstID; 769 770 if (DstI == M.end()) { 771 M[Dst] = DstID = Cntr++; 772 *Out << "('vertex', " << DstID << ")\n"; 773 } 774 else { 775 // We have hit DstID before. Change its style to reflect a cache hit. 776 DstID = DstI->second; 777 *Out << "('change_vertex_style', " << DstID << ", 1)\n"; 778 } 779 780 // Add the edge. 781 *Out << "('edge', " << SrcID << ", " << DstID 782 << ", ('arrow','true'), ('oriented', 'true'))\n"; 783 } 784 785 UbigraphViz::UbigraphViz(std::unique_ptr<raw_ostream> OutStream, 786 StringRef Filename) 787 : Out(std::move(OutStream)), Filename(Filename), Cntr(0) { 788 789 *Out << "('vertex_style_attribute', 0, ('shape', 'icosahedron'))\n"; 790 *Out << "('vertex_style', 1, 0, ('shape', 'sphere'), ('color', '#ffcc66')," 791 " ('size', '1.5'))\n"; 792 } 793 794 UbigraphViz::~UbigraphViz() { 795 Out.reset(); 796 llvm::errs() << "Running 'ubiviz' program... "; 797 std::string ErrMsg; 798 std::string Ubiviz; 799 if (auto Path = llvm::sys::findProgramByName("ubiviz")) 800 Ubiviz = *Path; 801 std::vector<const char*> args; 802 args.push_back(Ubiviz.c_str()); 803 args.push_back(Filename.c_str()); 804 args.push_back(nullptr); 805 806 if (llvm::sys::ExecuteAndWait(Ubiviz, &args[0], nullptr, nullptr, 0, 0, 807 &ErrMsg)) { 808 llvm::errs() << "Error viewing graph: " << ErrMsg << "\n"; 809 } 810 811 // Delete the file. 812 llvm::sys::fs::remove(Filename); 813 } 814