1 //===--- CFG.cpp - Classes for representing and building CFGs----*- C++ -*-===// 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 // This file defines the CFG and CFGBuilder classes for representing and 11 // building Control-Flow Graphs (CFGs) from ASTs. 12 // 13 //===----------------------------------------------------------------------===// 14 15 #include "clang/Analysis/CFG.h" 16 #include "clang/AST/ASTContext.h" 17 #include "clang/AST/Attr.h" 18 #include "clang/AST/CharUnits.h" 19 #include "clang/AST/DeclCXX.h" 20 #include "clang/AST/PrettyPrinter.h" 21 #include "clang/AST/StmtVisitor.h" 22 #include "clang/Basic/Builtins.h" 23 #include "llvm/ADT/DenseMap.h" 24 #include <memory> 25 #include "llvm/ADT/SmallPtrSet.h" 26 #include "llvm/Support/Allocator.h" 27 #include "llvm/Support/Format.h" 28 #include "llvm/Support/GraphWriter.h" 29 #include "llvm/Support/SaveAndRestore.h" 30 31 using namespace clang; 32 33 namespace { 34 35 static SourceLocation GetEndLoc(Decl *D) { 36 if (VarDecl *VD = dyn_cast<VarDecl>(D)) 37 if (Expr *Ex = VD->getInit()) 38 return Ex->getSourceRange().getEnd(); 39 return D->getLocation(); 40 } 41 42 class CFGBuilder; 43 44 /// The CFG builder uses a recursive algorithm to build the CFG. When 45 /// we process an expression, sometimes we know that we must add the 46 /// subexpressions as block-level expressions. For example: 47 /// 48 /// exp1 || exp2 49 /// 50 /// When processing the '||' expression, we know that exp1 and exp2 51 /// need to be added as block-level expressions, even though they 52 /// might not normally need to be. AddStmtChoice records this 53 /// contextual information. If AddStmtChoice is 'NotAlwaysAdd', then 54 /// the builder has an option not to add a subexpression as a 55 /// block-level expression. 56 /// 57 class AddStmtChoice { 58 public: 59 enum Kind { NotAlwaysAdd = 0, AlwaysAdd = 1 }; 60 61 AddStmtChoice(Kind a_kind = NotAlwaysAdd) : kind(a_kind) {} 62 63 bool alwaysAdd(CFGBuilder &builder, 64 const Stmt *stmt) const; 65 66 /// Return a copy of this object, except with the 'always-add' bit 67 /// set as specified. 68 AddStmtChoice withAlwaysAdd(bool alwaysAdd) const { 69 return AddStmtChoice(alwaysAdd ? AlwaysAdd : NotAlwaysAdd); 70 } 71 72 private: 73 Kind kind; 74 }; 75 76 /// LocalScope - Node in tree of local scopes created for C++ implicit 77 /// destructor calls generation. It contains list of automatic variables 78 /// declared in the scope and link to position in previous scope this scope 79 /// began in. 80 /// 81 /// The process of creating local scopes is as follows: 82 /// - Init CFGBuilder::ScopePos with invalid position (equivalent for null), 83 /// - Before processing statements in scope (e.g. CompoundStmt) create 84 /// LocalScope object using CFGBuilder::ScopePos as link to previous scope 85 /// and set CFGBuilder::ScopePos to the end of new scope, 86 /// - On every occurrence of VarDecl increase CFGBuilder::ScopePos if it points 87 /// at this VarDecl, 88 /// - For every normal (without jump) end of scope add to CFGBlock destructors 89 /// for objects in the current scope, 90 /// - For every jump add to CFGBlock destructors for objects 91 /// between CFGBuilder::ScopePos and local scope position saved for jump 92 /// target. Thanks to C++ restrictions on goto jumps we can be sure that 93 /// jump target position will be on the path to root from CFGBuilder::ScopePos 94 /// (adding any variable that doesn't need constructor to be called to 95 /// LocalScope can break this assumption), 96 /// 97 class LocalScope { 98 public: 99 typedef BumpVector<VarDecl*> AutomaticVarsTy; 100 101 /// const_iterator - Iterates local scope backwards and jumps to previous 102 /// scope on reaching the beginning of currently iterated scope. 103 class const_iterator { 104 const LocalScope* Scope; 105 106 /// VarIter is guaranteed to be greater then 0 for every valid iterator. 107 /// Invalid iterator (with null Scope) has VarIter equal to 0. 108 unsigned VarIter; 109 110 public: 111 /// Create invalid iterator. Dereferencing invalid iterator is not allowed. 112 /// Incrementing invalid iterator is allowed and will result in invalid 113 /// iterator. 114 const_iterator() 115 : Scope(NULL), VarIter(0) {} 116 117 /// Create valid iterator. In case when S.Prev is an invalid iterator and 118 /// I is equal to 0, this will create invalid iterator. 119 const_iterator(const LocalScope& S, unsigned I) 120 : Scope(&S), VarIter(I) { 121 // Iterator to "end" of scope is not allowed. Handle it by going up 122 // in scopes tree possibly up to invalid iterator in the root. 123 if (VarIter == 0 && Scope) 124 *this = Scope->Prev; 125 } 126 127 VarDecl *const* operator->() const { 128 assert (Scope && "Dereferencing invalid iterator is not allowed"); 129 assert (VarIter != 0 && "Iterator has invalid value of VarIter member"); 130 return &Scope->Vars[VarIter - 1]; 131 } 132 VarDecl *operator*() const { 133 return *this->operator->(); 134 } 135 136 const_iterator &operator++() { 137 if (!Scope) 138 return *this; 139 140 assert (VarIter != 0 && "Iterator has invalid value of VarIter member"); 141 --VarIter; 142 if (VarIter == 0) 143 *this = Scope->Prev; 144 return *this; 145 } 146 const_iterator operator++(int) { 147 const_iterator P = *this; 148 ++*this; 149 return P; 150 } 151 152 bool operator==(const const_iterator &rhs) const { 153 return Scope == rhs.Scope && VarIter == rhs.VarIter; 154 } 155 bool operator!=(const const_iterator &rhs) const { 156 return !(*this == rhs); 157 } 158 159 LLVM_EXPLICIT operator bool() const { 160 return *this != const_iterator(); 161 } 162 163 int distance(const_iterator L); 164 }; 165 166 friend class const_iterator; 167 168 private: 169 BumpVectorContext ctx; 170 171 /// Automatic variables in order of declaration. 172 AutomaticVarsTy Vars; 173 /// Iterator to variable in previous scope that was declared just before 174 /// begin of this scope. 175 const_iterator Prev; 176 177 public: 178 /// Constructs empty scope linked to previous scope in specified place. 179 LocalScope(BumpVectorContext &ctx, const_iterator P) 180 : ctx(ctx), Vars(ctx, 4), Prev(P) {} 181 182 /// Begin of scope in direction of CFG building (backwards). 183 const_iterator begin() const { return const_iterator(*this, Vars.size()); } 184 185 void addVar(VarDecl *VD) { 186 Vars.push_back(VD, ctx); 187 } 188 }; 189 190 /// distance - Calculates distance from this to L. L must be reachable from this 191 /// (with use of ++ operator). Cost of calculating the distance is linear w.r.t. 192 /// number of scopes between this and L. 193 int LocalScope::const_iterator::distance(LocalScope::const_iterator L) { 194 int D = 0; 195 const_iterator F = *this; 196 while (F.Scope != L.Scope) { 197 assert (F != const_iterator() 198 && "L iterator is not reachable from F iterator."); 199 D += F.VarIter; 200 F = F.Scope->Prev; 201 } 202 D += F.VarIter - L.VarIter; 203 return D; 204 } 205 206 /// BlockScopePosPair - Structure for specifying position in CFG during its 207 /// build process. It consists of CFGBlock that specifies position in CFG graph 208 /// and LocalScope::const_iterator that specifies position in LocalScope graph. 209 struct BlockScopePosPair { 210 BlockScopePosPair() : block(0) {} 211 BlockScopePosPair(CFGBlock *b, LocalScope::const_iterator scopePos) 212 : block(b), scopePosition(scopePos) {} 213 214 CFGBlock *block; 215 LocalScope::const_iterator scopePosition; 216 }; 217 218 /// TryResult - a class representing a variant over the values 219 /// 'true', 'false', or 'unknown'. This is returned by tryEvaluateBool, 220 /// and is used by the CFGBuilder to decide if a branch condition 221 /// can be decided up front during CFG construction. 222 class TryResult { 223 int X; 224 public: 225 TryResult(bool b) : X(b ? 1 : 0) {} 226 TryResult() : X(-1) {} 227 228 bool isTrue() const { return X == 1; } 229 bool isFalse() const { return X == 0; } 230 bool isKnown() const { return X >= 0; } 231 void negate() { 232 assert(isKnown()); 233 X ^= 0x1; 234 } 235 }; 236 237 class reverse_children { 238 llvm::SmallVector<Stmt *, 12> childrenBuf; 239 ArrayRef<Stmt*> children; 240 public: 241 reverse_children(Stmt *S); 242 243 typedef ArrayRef<Stmt*>::reverse_iterator iterator; 244 iterator begin() const { return children.rbegin(); } 245 iterator end() const { return children.rend(); } 246 }; 247 248 249 reverse_children::reverse_children(Stmt *S) { 250 if (CallExpr *CE = dyn_cast<CallExpr>(S)) { 251 children = CE->getRawSubExprs(); 252 return; 253 } 254 switch (S->getStmtClass()) { 255 // Note: Fill in this switch with more cases we want to optimize. 256 case Stmt::InitListExprClass: { 257 InitListExpr *IE = cast<InitListExpr>(S); 258 children = llvm::makeArrayRef(reinterpret_cast<Stmt**>(IE->getInits()), 259 IE->getNumInits()); 260 return; 261 } 262 default: 263 break; 264 } 265 266 // Default case for all other statements. 267 for (Stmt::child_range I = S->children(); I; ++I) { 268 childrenBuf.push_back(*I); 269 } 270 271 // This needs to be done *after* childrenBuf has been populated. 272 children = childrenBuf; 273 } 274 275 /// CFGBuilder - This class implements CFG construction from an AST. 276 /// The builder is stateful: an instance of the builder should be used to only 277 /// construct a single CFG. 278 /// 279 /// Example usage: 280 /// 281 /// CFGBuilder builder; 282 /// CFG* cfg = builder.BuildAST(stmt1); 283 /// 284 /// CFG construction is done via a recursive walk of an AST. We actually parse 285 /// the AST in reverse order so that the successor of a basic block is 286 /// constructed prior to its predecessor. This allows us to nicely capture 287 /// implicit fall-throughs without extra basic blocks. 288 /// 289 class CFGBuilder { 290 typedef BlockScopePosPair JumpTarget; 291 typedef BlockScopePosPair JumpSource; 292 293 ASTContext *Context; 294 std::unique_ptr<CFG> cfg; 295 296 CFGBlock *Block; 297 CFGBlock *Succ; 298 JumpTarget ContinueJumpTarget; 299 JumpTarget BreakJumpTarget; 300 CFGBlock *SwitchTerminatedBlock; 301 CFGBlock *DefaultCaseBlock; 302 CFGBlock *TryTerminatedBlock; 303 304 // Current position in local scope. 305 LocalScope::const_iterator ScopePos; 306 307 // LabelMap records the mapping from Label expressions to their jump targets. 308 typedef llvm::DenseMap<LabelDecl*, JumpTarget> LabelMapTy; 309 LabelMapTy LabelMap; 310 311 // A list of blocks that end with a "goto" that must be backpatched to their 312 // resolved targets upon completion of CFG construction. 313 typedef std::vector<JumpSource> BackpatchBlocksTy; 314 BackpatchBlocksTy BackpatchBlocks; 315 316 // A list of labels whose address has been taken (for indirect gotos). 317 typedef llvm::SmallPtrSet<LabelDecl*, 5> LabelSetTy; 318 LabelSetTy AddressTakenLabels; 319 320 bool badCFG; 321 const CFG::BuildOptions &BuildOpts; 322 323 // State to track for building switch statements. 324 bool switchExclusivelyCovered; 325 Expr::EvalResult *switchCond; 326 327 CFG::BuildOptions::ForcedBlkExprs::value_type *cachedEntry; 328 const Stmt *lastLookup; 329 330 // Caches boolean evaluations of expressions to avoid multiple re-evaluations 331 // during construction of branches for chained logical operators. 332 typedef llvm::DenseMap<Expr *, TryResult> CachedBoolEvalsTy; 333 CachedBoolEvalsTy CachedBoolEvals; 334 335 public: 336 explicit CFGBuilder(ASTContext *astContext, 337 const CFG::BuildOptions &buildOpts) 338 : Context(astContext), cfg(new CFG()), // crew a new CFG 339 Block(NULL), Succ(NULL), 340 SwitchTerminatedBlock(NULL), DefaultCaseBlock(NULL), 341 TryTerminatedBlock(NULL), badCFG(false), BuildOpts(buildOpts), 342 switchExclusivelyCovered(false), switchCond(0), 343 cachedEntry(0), lastLookup(0) {} 344 345 // buildCFG - Used by external clients to construct the CFG. 346 CFG* buildCFG(const Decl *D, Stmt *Statement); 347 348 bool alwaysAdd(const Stmt *stmt); 349 350 private: 351 // Visitors to walk an AST and construct the CFG. 352 CFGBlock *VisitAddrLabelExpr(AddrLabelExpr *A, AddStmtChoice asc); 353 CFGBlock *VisitBinaryOperator(BinaryOperator *B, AddStmtChoice asc); 354 CFGBlock *VisitBreakStmt(BreakStmt *B); 355 CFGBlock *VisitCallExpr(CallExpr *C, AddStmtChoice asc); 356 CFGBlock *VisitCaseStmt(CaseStmt *C); 357 CFGBlock *VisitChooseExpr(ChooseExpr *C, AddStmtChoice asc); 358 CFGBlock *VisitCompoundStmt(CompoundStmt *C); 359 CFGBlock *VisitConditionalOperator(AbstractConditionalOperator *C, 360 AddStmtChoice asc); 361 CFGBlock *VisitContinueStmt(ContinueStmt *C); 362 CFGBlock *VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E, 363 AddStmtChoice asc); 364 CFGBlock *VisitCXXCatchStmt(CXXCatchStmt *S); 365 CFGBlock *VisitCXXConstructExpr(CXXConstructExpr *C, AddStmtChoice asc); 366 CFGBlock *VisitCXXNewExpr(CXXNewExpr *DE, AddStmtChoice asc); 367 CFGBlock *VisitCXXDeleteExpr(CXXDeleteExpr *DE, AddStmtChoice asc); 368 CFGBlock *VisitCXXForRangeStmt(CXXForRangeStmt *S); 369 CFGBlock *VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E, 370 AddStmtChoice asc); 371 CFGBlock *VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C, 372 AddStmtChoice asc); 373 CFGBlock *VisitCXXThrowExpr(CXXThrowExpr *T); 374 CFGBlock *VisitCXXTryStmt(CXXTryStmt *S); 375 CFGBlock *VisitDeclStmt(DeclStmt *DS); 376 CFGBlock *VisitDeclSubExpr(DeclStmt *DS); 377 CFGBlock *VisitDefaultStmt(DefaultStmt *D); 378 CFGBlock *VisitDoStmt(DoStmt *D); 379 CFGBlock *VisitExprWithCleanups(ExprWithCleanups *E, AddStmtChoice asc); 380 CFGBlock *VisitForStmt(ForStmt *F); 381 CFGBlock *VisitGotoStmt(GotoStmt *G); 382 CFGBlock *VisitIfStmt(IfStmt *I); 383 CFGBlock *VisitImplicitCastExpr(ImplicitCastExpr *E, AddStmtChoice asc); 384 CFGBlock *VisitIndirectGotoStmt(IndirectGotoStmt *I); 385 CFGBlock *VisitLabelStmt(LabelStmt *L); 386 CFGBlock *VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc); 387 CFGBlock *VisitLogicalOperator(BinaryOperator *B); 388 std::pair<CFGBlock *, CFGBlock *> VisitLogicalOperator(BinaryOperator *B, 389 Stmt *Term, 390 CFGBlock *TrueBlock, 391 CFGBlock *FalseBlock); 392 CFGBlock *VisitMemberExpr(MemberExpr *M, AddStmtChoice asc); 393 CFGBlock *VisitObjCAtCatchStmt(ObjCAtCatchStmt *S); 394 CFGBlock *VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S); 395 CFGBlock *VisitObjCAtThrowStmt(ObjCAtThrowStmt *S); 396 CFGBlock *VisitObjCAtTryStmt(ObjCAtTryStmt *S); 397 CFGBlock *VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S); 398 CFGBlock *VisitObjCForCollectionStmt(ObjCForCollectionStmt *S); 399 CFGBlock *VisitPseudoObjectExpr(PseudoObjectExpr *E); 400 CFGBlock *VisitReturnStmt(ReturnStmt *R); 401 CFGBlock *VisitStmtExpr(StmtExpr *S, AddStmtChoice asc); 402 CFGBlock *VisitSwitchStmt(SwitchStmt *S); 403 CFGBlock *VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E, 404 AddStmtChoice asc); 405 CFGBlock *VisitUnaryOperator(UnaryOperator *U, AddStmtChoice asc); 406 CFGBlock *VisitWhileStmt(WhileStmt *W); 407 408 CFGBlock *Visit(Stmt *S, AddStmtChoice asc = AddStmtChoice::NotAlwaysAdd); 409 CFGBlock *VisitStmt(Stmt *S, AddStmtChoice asc); 410 CFGBlock *VisitChildren(Stmt *S); 411 CFGBlock *VisitNoRecurse(Expr *E, AddStmtChoice asc); 412 413 // Visitors to walk an AST and generate destructors of temporaries in 414 // full expression. 415 CFGBlock *VisitForTemporaryDtors(Stmt *E, bool BindToTemporary = false); 416 CFGBlock *VisitChildrenForTemporaryDtors(Stmt *E); 417 CFGBlock *VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E); 418 CFGBlock *VisitCXXBindTemporaryExprForTemporaryDtors(CXXBindTemporaryExpr *E, 419 bool BindToTemporary); 420 CFGBlock * 421 VisitConditionalOperatorForTemporaryDtors(AbstractConditionalOperator *E, 422 bool BindToTemporary); 423 424 // NYS == Not Yet Supported 425 CFGBlock *NYS() { 426 badCFG = true; 427 return Block; 428 } 429 430 void autoCreateBlock() { if (!Block) Block = createBlock(); } 431 CFGBlock *createBlock(bool add_successor = true); 432 CFGBlock *createNoReturnBlock(); 433 434 CFGBlock *addStmt(Stmt *S) { 435 return Visit(S, AddStmtChoice::AlwaysAdd); 436 } 437 CFGBlock *addInitializer(CXXCtorInitializer *I); 438 void addAutomaticObjDtors(LocalScope::const_iterator B, 439 LocalScope::const_iterator E, Stmt *S); 440 void addImplicitDtorsForDestructor(const CXXDestructorDecl *DD); 441 442 // Local scopes creation. 443 LocalScope* createOrReuseLocalScope(LocalScope* Scope); 444 445 void addLocalScopeForStmt(Stmt *S); 446 LocalScope* addLocalScopeForDeclStmt(DeclStmt *DS, LocalScope* Scope = NULL); 447 LocalScope* addLocalScopeForVarDecl(VarDecl *VD, LocalScope* Scope = NULL); 448 449 void addLocalScopeAndDtors(Stmt *S); 450 451 // Interface to CFGBlock - adding CFGElements. 452 void appendStmt(CFGBlock *B, const Stmt *S) { 453 if (alwaysAdd(S) && cachedEntry) 454 cachedEntry->second = B; 455 456 // All block-level expressions should have already been IgnoreParens()ed. 457 assert(!isa<Expr>(S) || cast<Expr>(S)->IgnoreParens() == S); 458 B->appendStmt(const_cast<Stmt*>(S), cfg->getBumpVectorContext()); 459 } 460 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) { 461 B->appendInitializer(I, cfg->getBumpVectorContext()); 462 } 463 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) { 464 B->appendNewAllocator(NE, cfg->getBumpVectorContext()); 465 } 466 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) { 467 B->appendBaseDtor(BS, cfg->getBumpVectorContext()); 468 } 469 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) { 470 B->appendMemberDtor(FD, cfg->getBumpVectorContext()); 471 } 472 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) { 473 B->appendTemporaryDtor(E, cfg->getBumpVectorContext()); 474 } 475 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) { 476 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext()); 477 } 478 479 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) { 480 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext()); 481 } 482 483 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk, 484 LocalScope::const_iterator B, LocalScope::const_iterator E); 485 486 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) { 487 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable), 488 cfg->getBumpVectorContext()); 489 } 490 491 /// Add a reachable successor to a block, with the alternate variant that is 492 /// unreachable. 493 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) { 494 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock), 495 cfg->getBumpVectorContext()); 496 } 497 498 /// \brief Find a relational comparison with an expression evaluating to a 499 /// boolean and a constant other than 0 and 1. 500 /// e.g. if ((x < y) == 10) 501 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) { 502 const Expr *LHSExpr = B->getLHS()->IgnoreParens(); 503 const Expr *RHSExpr = B->getRHS()->IgnoreParens(); 504 505 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr); 506 const Expr *BoolExpr = RHSExpr; 507 bool IntFirst = true; 508 if (!IntLiteral) { 509 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr); 510 BoolExpr = LHSExpr; 511 IntFirst = false; 512 } 513 514 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue()) 515 return TryResult(); 516 517 llvm::APInt IntValue = IntLiteral->getValue(); 518 if ((IntValue == 1) || (IntValue == 0)) 519 return TryResult(); 520 521 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() || 522 !IntValue.isNegative(); 523 524 BinaryOperatorKind Bok = B->getOpcode(); 525 if (Bok == BO_GT || Bok == BO_GE) { 526 // Always true for 10 > bool and bool > -1 527 // Always false for -1 > bool and bool > 10 528 return TryResult(IntFirst == IntLarger); 529 } else { 530 // Always true for -1 < bool and bool < 10 531 // Always false for 10 < bool and bool < -1 532 return TryResult(IntFirst != IntLarger); 533 } 534 } 535 536 /// Find a equality comparison with an expression evaluating to a boolean and 537 /// a constant other than 0 and 1. 538 /// e.g. if (!x == 10) 539 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) { 540 const Expr *LHSExpr = B->getLHS()->IgnoreParens(); 541 const Expr *RHSExpr = B->getRHS()->IgnoreParens(); 542 543 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr); 544 const Expr *BoolExpr = RHSExpr; 545 546 if (!IntLiteral) { 547 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr); 548 BoolExpr = LHSExpr; 549 } 550 551 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue()) 552 return TryResult(); 553 554 llvm::APInt IntValue = IntLiteral->getValue(); 555 if ((IntValue == 1) || (IntValue == 0)) { 556 return TryResult(); 557 } 558 559 return TryResult(B->getOpcode() != BO_EQ); 560 } 561 562 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation, 563 const llvm::APSInt &Value1, 564 const llvm::APSInt &Value2) { 565 assert(Value1.isSigned() == Value2.isSigned()); 566 switch (Relation) { 567 default: 568 return TryResult(); 569 case BO_EQ: 570 return TryResult(Value1 == Value2); 571 case BO_NE: 572 return TryResult(Value1 != Value2); 573 case BO_LT: 574 return TryResult(Value1 < Value2); 575 case BO_LE: 576 return TryResult(Value1 <= Value2); 577 case BO_GT: 578 return TryResult(Value1 > Value2); 579 case BO_GE: 580 return TryResult(Value1 >= Value2); 581 } 582 } 583 584 /// \brief Find a pair of comparison expressions with or without parentheses 585 /// with a shared variable and constants and a logical operator between them 586 /// that always evaluates to either true or false. 587 /// e.g. if (x != 3 || x != 4) 588 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) { 589 assert(B->isLogicalOp()); 590 const BinaryOperator *LHS = 591 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens()); 592 const BinaryOperator *RHS = 593 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens()); 594 if (!LHS || !RHS) 595 return TryResult(); 596 597 if (!LHS->isComparisonOp() || !RHS->isComparisonOp()) 598 return TryResult(); 599 600 BinaryOperatorKind BO1 = LHS->getOpcode(); 601 const DeclRefExpr *Decl1 = 602 dyn_cast<DeclRefExpr>(LHS->getLHS()->IgnoreParenImpCasts()); 603 const IntegerLiteral *Literal1 = 604 dyn_cast<IntegerLiteral>(LHS->getRHS()->IgnoreParens()); 605 if (!Decl1 && !Literal1) { 606 if (BO1 == BO_GT) 607 BO1 = BO_LT; 608 else if (BO1 == BO_GE) 609 BO1 = BO_LE; 610 else if (BO1 == BO_LT) 611 BO1 = BO_GT; 612 else if (BO1 == BO_LE) 613 BO1 = BO_GE; 614 Decl1 = dyn_cast<DeclRefExpr>(LHS->getRHS()->IgnoreParenImpCasts()); 615 Literal1 = dyn_cast<IntegerLiteral>(LHS->getLHS()->IgnoreParens()); 616 } 617 618 if (!Decl1 || !Literal1) 619 return TryResult(); 620 621 BinaryOperatorKind BO2 = RHS->getOpcode(); 622 const DeclRefExpr *Decl2 = 623 dyn_cast<DeclRefExpr>(RHS->getLHS()->IgnoreParenImpCasts()); 624 const IntegerLiteral *Literal2 = 625 dyn_cast<IntegerLiteral>(RHS->getRHS()->IgnoreParens()); 626 if (!Decl2 && !Literal2) { 627 if (BO2 == BO_GT) 628 BO2 = BO_LT; 629 else if (BO2 == BO_GE) 630 BO2 = BO_LE; 631 else if (BO2 == BO_LT) 632 BO2 = BO_GT; 633 else if (BO2 == BO_LE) 634 BO2 = BO_GE; 635 Decl2 = dyn_cast<DeclRefExpr>(RHS->getRHS()->IgnoreParenImpCasts()); 636 Literal2 = dyn_cast<IntegerLiteral>(RHS->getLHS()->IgnoreParens()); 637 } 638 639 if (!Decl2 || !Literal2) 640 return TryResult(); 641 642 // Check that it is the same variable on both sides. 643 if (Decl1->getDecl() != Decl2->getDecl()) 644 return TryResult(); 645 646 llvm::APSInt L1, L2; 647 648 if (!Literal1->EvaluateAsInt(L1, *Context) || 649 !Literal2->EvaluateAsInt(L2, *Context)) 650 return TryResult(); 651 652 // Can't compare signed with unsigned or with different bit width. 653 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth()) 654 return TryResult(); 655 656 // Values that will be used to determine if result of logical 657 // operator is always true/false 658 const llvm::APSInt Values[] = { 659 // Value less than both Value1 and Value2 660 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()), 661 // L1 662 L1, 663 // Value between Value1 and Value2 664 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1), 665 L1.isUnsigned()), 666 // L2 667 L2, 668 // Value greater than both Value1 and Value2 669 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()), 670 }; 671 672 // Check whether expression is always true/false by evaluating the following 673 // * variable x is less than the smallest literal. 674 // * variable x is equal to the smallest literal. 675 // * Variable x is between smallest and largest literal. 676 // * Variable x is equal to the largest literal. 677 // * Variable x is greater than largest literal. 678 bool AlwaysTrue = true, AlwaysFalse = true; 679 for (unsigned int ValueIndex = 0; 680 ValueIndex < sizeof(Values) / sizeof(Values[0]); 681 ++ValueIndex) { 682 llvm::APSInt Value = Values[ValueIndex]; 683 TryResult Res1, Res2; 684 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1); 685 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2); 686 687 if (!Res1.isKnown() || !Res2.isKnown()) 688 return TryResult(); 689 690 if (B->getOpcode() == BO_LAnd) { 691 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue()); 692 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue()); 693 } else { 694 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue()); 695 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue()); 696 } 697 } 698 699 if (AlwaysTrue || AlwaysFalse) { 700 if (BuildOpts.Observer) 701 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue); 702 return TryResult(AlwaysTrue); 703 } 704 return TryResult(); 705 } 706 707 /// Try and evaluate an expression to an integer constant. 708 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) { 709 if (!BuildOpts.PruneTriviallyFalseEdges) 710 return false; 711 return !S->isTypeDependent() && 712 !S->isValueDependent() && 713 S->EvaluateAsRValue(outResult, *Context); 714 } 715 716 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1 717 /// if we can evaluate to a known value, otherwise return -1. 718 TryResult tryEvaluateBool(Expr *S) { 719 if (!BuildOpts.PruneTriviallyFalseEdges || 720 S->isTypeDependent() || S->isValueDependent()) 721 return TryResult(); 722 723 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) { 724 if (Bop->isLogicalOp()) { 725 // Check the cache first. 726 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S); 727 if (I != CachedBoolEvals.end()) 728 return I->second; // already in map; 729 730 // Retrieve result at first, or the map might be updated. 731 TryResult Result = evaluateAsBooleanConditionNoCache(S); 732 CachedBoolEvals[S] = Result; // update or insert 733 return Result; 734 } 735 else { 736 switch (Bop->getOpcode()) { 737 default: break; 738 // For 'x & 0' and 'x * 0', we can determine that 739 // the value is always false. 740 case BO_Mul: 741 case BO_And: { 742 // If either operand is zero, we know the value 743 // must be false. 744 llvm::APSInt IntVal; 745 if (Bop->getLHS()->EvaluateAsInt(IntVal, *Context)) { 746 if (IntVal.getBoolValue() == false) { 747 return TryResult(false); 748 } 749 } 750 if (Bop->getRHS()->EvaluateAsInt(IntVal, *Context)) { 751 if (IntVal.getBoolValue() == false) { 752 return TryResult(false); 753 } 754 } 755 } 756 break; 757 } 758 } 759 } 760 761 return evaluateAsBooleanConditionNoCache(S); 762 } 763 764 /// \brief Evaluate as boolean \param E without using the cache. 765 TryResult evaluateAsBooleanConditionNoCache(Expr *E) { 766 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) { 767 if (Bop->isLogicalOp()) { 768 TryResult LHS = tryEvaluateBool(Bop->getLHS()); 769 if (LHS.isKnown()) { 770 // We were able to evaluate the LHS, see if we can get away with not 771 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1 772 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr)) 773 return LHS.isTrue(); 774 775 TryResult RHS = tryEvaluateBool(Bop->getRHS()); 776 if (RHS.isKnown()) { 777 if (Bop->getOpcode() == BO_LOr) 778 return LHS.isTrue() || RHS.isTrue(); 779 else 780 return LHS.isTrue() && RHS.isTrue(); 781 } 782 } else { 783 TryResult RHS = tryEvaluateBool(Bop->getRHS()); 784 if (RHS.isKnown()) { 785 // We can't evaluate the LHS; however, sometimes the result 786 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1. 787 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr)) 788 return RHS.isTrue(); 789 } else { 790 TryResult BopRes = checkIncorrectLogicOperator(Bop); 791 if (BopRes.isKnown()) 792 return BopRes.isTrue(); 793 } 794 } 795 796 return TryResult(); 797 } else if (Bop->isEqualityOp()) { 798 TryResult BopRes = checkIncorrectEqualityOperator(Bop); 799 if (BopRes.isKnown()) 800 return BopRes.isTrue(); 801 } else if (Bop->isRelationalOp()) { 802 TryResult BopRes = checkIncorrectRelationalOperator(Bop); 803 if (BopRes.isKnown()) 804 return BopRes.isTrue(); 805 } 806 } 807 808 bool Result; 809 if (E->EvaluateAsBooleanCondition(Result, *Context)) 810 return Result; 811 812 return TryResult(); 813 } 814 815 }; 816 817 inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder, 818 const Stmt *stmt) const { 819 return builder.alwaysAdd(stmt) || kind == AlwaysAdd; 820 } 821 822 bool CFGBuilder::alwaysAdd(const Stmt *stmt) { 823 bool shouldAdd = BuildOpts.alwaysAdd(stmt); 824 825 if (!BuildOpts.forcedBlkExprs) 826 return shouldAdd; 827 828 if (lastLookup == stmt) { 829 if (cachedEntry) { 830 assert(cachedEntry->first == stmt); 831 return true; 832 } 833 return shouldAdd; 834 } 835 836 lastLookup = stmt; 837 838 // Perform the lookup! 839 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs; 840 841 if (!fb) { 842 // No need to update 'cachedEntry', since it will always be null. 843 assert(cachedEntry == 0); 844 return shouldAdd; 845 } 846 847 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt); 848 if (itr == fb->end()) { 849 cachedEntry = 0; 850 return shouldAdd; 851 } 852 853 cachedEntry = &*itr; 854 return true; 855 } 856 857 // FIXME: Add support for dependent-sized array types in C++? 858 // Does it even make sense to build a CFG for an uninstantiated template? 859 static const VariableArrayType *FindVA(const Type *t) { 860 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) { 861 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt)) 862 if (vat->getSizeExpr()) 863 return vat; 864 865 t = vt->getElementType().getTypePtr(); 866 } 867 868 return 0; 869 } 870 871 /// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an 872 /// arbitrary statement. Examples include a single expression or a function 873 /// body (compound statement). The ownership of the returned CFG is 874 /// transferred to the caller. If CFG construction fails, this method returns 875 /// NULL. 876 CFG* CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) { 877 assert(cfg.get()); 878 if (!Statement) 879 return NULL; 880 881 // Create an empty block that will serve as the exit block for the CFG. Since 882 // this is the first block added to the CFG, it will be implicitly registered 883 // as the exit block. 884 Succ = createBlock(); 885 assert(Succ == &cfg->getExit()); 886 Block = NULL; // the EXIT block is empty. Create all other blocks lazily. 887 888 if (BuildOpts.AddImplicitDtors) 889 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D)) 890 addImplicitDtorsForDestructor(DD); 891 892 // Visit the statements and create the CFG. 893 CFGBlock *B = addStmt(Statement); 894 895 if (badCFG) 896 return NULL; 897 898 // For C++ constructor add initializers to CFG. 899 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) { 900 for (CXXConstructorDecl::init_const_reverse_iterator I = CD->init_rbegin(), 901 E = CD->init_rend(); I != E; ++I) { 902 B = addInitializer(*I); 903 if (badCFG) 904 return NULL; 905 } 906 } 907 908 if (B) 909 Succ = B; 910 911 // Backpatch the gotos whose label -> block mappings we didn't know when we 912 // encountered them. 913 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(), 914 E = BackpatchBlocks.end(); I != E; ++I ) { 915 916 CFGBlock *B = I->block; 917 const GotoStmt *G = cast<GotoStmt>(B->getTerminator()); 918 LabelMapTy::iterator LI = LabelMap.find(G->getLabel()); 919 920 // If there is no target for the goto, then we are looking at an 921 // incomplete AST. Handle this by not registering a successor. 922 if (LI == LabelMap.end()) continue; 923 924 JumpTarget JT = LI->second; 925 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition, 926 JT.scopePosition); 927 addSuccessor(B, JT.block); 928 } 929 930 // Add successors to the Indirect Goto Dispatch block (if we have one). 931 if (CFGBlock *B = cfg->getIndirectGotoBlock()) 932 for (LabelSetTy::iterator I = AddressTakenLabels.begin(), 933 E = AddressTakenLabels.end(); I != E; ++I ) { 934 935 // Lookup the target block. 936 LabelMapTy::iterator LI = LabelMap.find(*I); 937 938 // If there is no target block that contains label, then we are looking 939 // at an incomplete AST. Handle this by not registering a successor. 940 if (LI == LabelMap.end()) continue; 941 942 addSuccessor(B, LI->second.block); 943 } 944 945 // Create an empty entry block that has no predecessors. 946 cfg->setEntry(createBlock()); 947 948 return cfg.release(); 949 } 950 951 /// createBlock - Used to lazily create blocks that are connected 952 /// to the current (global) succcessor. 953 CFGBlock *CFGBuilder::createBlock(bool add_successor) { 954 CFGBlock *B = cfg->createBlock(); 955 if (add_successor && Succ) 956 addSuccessor(B, Succ); 957 return B; 958 } 959 960 /// createNoReturnBlock - Used to create a block is a 'noreturn' point in the 961 /// CFG. It is *not* connected to the current (global) successor, and instead 962 /// directly tied to the exit block in order to be reachable. 963 CFGBlock *CFGBuilder::createNoReturnBlock() { 964 CFGBlock *B = createBlock(false); 965 B->setHasNoReturnElement(); 966 addSuccessor(B, &cfg->getExit(), Succ); 967 return B; 968 } 969 970 /// addInitializer - Add C++ base or member initializer element to CFG. 971 CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) { 972 if (!BuildOpts.AddInitializers) 973 return Block; 974 975 bool IsReference = false; 976 bool HasTemporaries = false; 977 978 // Destructors of temporaries in initialization expression should be called 979 // after initialization finishes. 980 Expr *Init = I->getInit(); 981 if (Init) { 982 if (FieldDecl *FD = I->getAnyMember()) 983 IsReference = FD->getType()->isReferenceType(); 984 HasTemporaries = isa<ExprWithCleanups>(Init); 985 986 if (BuildOpts.AddTemporaryDtors && HasTemporaries) { 987 // Generate destructors for temporaries in initialization expression. 988 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(), 989 IsReference); 990 } 991 } 992 993 autoCreateBlock(); 994 appendInitializer(Block, I); 995 996 if (Init) { 997 if (HasTemporaries) { 998 // For expression with temporaries go directly to subexpression to omit 999 // generating destructors for the second time. 1000 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr()); 1001 } 1002 return Visit(Init); 1003 } 1004 1005 return Block; 1006 } 1007 1008 /// \brief Retrieve the type of the temporary object whose lifetime was 1009 /// extended by a local reference with the given initializer. 1010 static QualType getReferenceInitTemporaryType(ASTContext &Context, 1011 const Expr *Init) { 1012 while (true) { 1013 // Skip parentheses. 1014 Init = Init->IgnoreParens(); 1015 1016 // Skip through cleanups. 1017 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) { 1018 Init = EWC->getSubExpr(); 1019 continue; 1020 } 1021 1022 // Skip through the temporary-materialization expression. 1023 if (const MaterializeTemporaryExpr *MTE 1024 = dyn_cast<MaterializeTemporaryExpr>(Init)) { 1025 Init = MTE->GetTemporaryExpr(); 1026 continue; 1027 } 1028 1029 // Skip derived-to-base and no-op casts. 1030 if (const CastExpr *CE = dyn_cast<CastExpr>(Init)) { 1031 if ((CE->getCastKind() == CK_DerivedToBase || 1032 CE->getCastKind() == CK_UncheckedDerivedToBase || 1033 CE->getCastKind() == CK_NoOp) && 1034 Init->getType()->isRecordType()) { 1035 Init = CE->getSubExpr(); 1036 continue; 1037 } 1038 } 1039 1040 // Skip member accesses into rvalues. 1041 if (const MemberExpr *ME = dyn_cast<MemberExpr>(Init)) { 1042 if (!ME->isArrow() && ME->getBase()->isRValue()) { 1043 Init = ME->getBase(); 1044 continue; 1045 } 1046 } 1047 1048 break; 1049 } 1050 1051 return Init->getType(); 1052 } 1053 1054 /// addAutomaticObjDtors - Add to current block automatic objects destructors 1055 /// for objects in range of local scope positions. Use S as trigger statement 1056 /// for destructors. 1057 void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B, 1058 LocalScope::const_iterator E, Stmt *S) { 1059 if (!BuildOpts.AddImplicitDtors) 1060 return; 1061 1062 if (B == E) 1063 return; 1064 1065 // We need to append the destructors in reverse order, but any one of them 1066 // may be a no-return destructor which changes the CFG. As a result, buffer 1067 // this sequence up and replay them in reverse order when appending onto the 1068 // CFGBlock(s). 1069 SmallVector<VarDecl*, 10> Decls; 1070 Decls.reserve(B.distance(E)); 1071 for (LocalScope::const_iterator I = B; I != E; ++I) 1072 Decls.push_back(*I); 1073 1074 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(), 1075 E = Decls.rend(); 1076 I != E; ++I) { 1077 // If this destructor is marked as a no-return destructor, we need to 1078 // create a new block for the destructor which does not have as a successor 1079 // anything built thus far: control won't flow out of this block. 1080 QualType Ty = (*I)->getType(); 1081 if (Ty->isReferenceType()) { 1082 Ty = getReferenceInitTemporaryType(*Context, (*I)->getInit()); 1083 } 1084 Ty = Context->getBaseElementType(Ty); 1085 1086 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor(); 1087 if (Dtor->isNoReturn()) 1088 Block = createNoReturnBlock(); 1089 else 1090 autoCreateBlock(); 1091 1092 appendAutomaticObjDtor(Block, *I, S); 1093 } 1094 } 1095 1096 /// addImplicitDtorsForDestructor - Add implicit destructors generated for 1097 /// base and member objects in destructor. 1098 void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) { 1099 assert (BuildOpts.AddImplicitDtors 1100 && "Can be called only when dtors should be added"); 1101 const CXXRecordDecl *RD = DD->getParent(); 1102 1103 // At the end destroy virtual base objects. 1104 for (const auto &VI : RD->vbases()) { 1105 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl(); 1106 if (!CD->hasTrivialDestructor()) { 1107 autoCreateBlock(); 1108 appendBaseDtor(Block, &VI); 1109 } 1110 } 1111 1112 // Before virtual bases destroy direct base objects. 1113 for (const auto &BI : RD->bases()) { 1114 if (!BI.isVirtual()) { 1115 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl(); 1116 if (!CD->hasTrivialDestructor()) { 1117 autoCreateBlock(); 1118 appendBaseDtor(Block, &BI); 1119 } 1120 } 1121 } 1122 1123 // First destroy member objects. 1124 for (auto *FI : RD->fields()) { 1125 // Check for constant size array. Set type to array element type. 1126 QualType QT = FI->getType(); 1127 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) { 1128 if (AT->getSize() == 0) 1129 continue; 1130 QT = AT->getElementType(); 1131 } 1132 1133 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl()) 1134 if (!CD->hasTrivialDestructor()) { 1135 autoCreateBlock(); 1136 appendMemberDtor(Block, FI); 1137 } 1138 } 1139 } 1140 1141 /// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either 1142 /// way return valid LocalScope object. 1143 LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) { 1144 if (!Scope) { 1145 llvm::BumpPtrAllocator &alloc = cfg->getAllocator(); 1146 Scope = alloc.Allocate<LocalScope>(); 1147 BumpVectorContext ctx(alloc); 1148 new (Scope) LocalScope(ctx, ScopePos); 1149 } 1150 return Scope; 1151 } 1152 1153 /// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement 1154 /// that should create implicit scope (e.g. if/else substatements). 1155 void CFGBuilder::addLocalScopeForStmt(Stmt *S) { 1156 if (!BuildOpts.AddImplicitDtors) 1157 return; 1158 1159 LocalScope *Scope = 0; 1160 1161 // For compound statement we will be creating explicit scope. 1162 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) { 1163 for (auto *BI : CS->body()) { 1164 Stmt *SI = BI->stripLabelLikeStatements(); 1165 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI)) 1166 Scope = addLocalScopeForDeclStmt(DS, Scope); 1167 } 1168 return; 1169 } 1170 1171 // For any other statement scope will be implicit and as such will be 1172 // interesting only for DeclStmt. 1173 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements())) 1174 addLocalScopeForDeclStmt(DS); 1175 } 1176 1177 /// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will 1178 /// reuse Scope if not NULL. 1179 LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS, 1180 LocalScope* Scope) { 1181 if (!BuildOpts.AddImplicitDtors) 1182 return Scope; 1183 1184 for (auto *DI : DS->decls()) 1185 if (VarDecl *VD = dyn_cast<VarDecl>(DI)) 1186 Scope = addLocalScopeForVarDecl(VD, Scope); 1187 return Scope; 1188 } 1189 1190 /// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will 1191 /// create add scope for automatic objects and temporary objects bound to 1192 /// const reference. Will reuse Scope if not NULL. 1193 LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD, 1194 LocalScope* Scope) { 1195 if (!BuildOpts.AddImplicitDtors) 1196 return Scope; 1197 1198 // Check if variable is local. 1199 switch (VD->getStorageClass()) { 1200 case SC_None: 1201 case SC_Auto: 1202 case SC_Register: 1203 break; 1204 default: return Scope; 1205 } 1206 1207 // Check for const references bound to temporary. Set type to pointee. 1208 QualType QT = VD->getType(); 1209 if (QT.getTypePtr()->isReferenceType()) { 1210 // Attempt to determine whether this declaration lifetime-extends a 1211 // temporary. 1212 // 1213 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend 1214 // temporaries, and a single declaration can extend multiple temporaries. 1215 // We should look at the storage duration on each nested 1216 // MaterializeTemporaryExpr instead. 1217 const Expr *Init = VD->getInit(); 1218 if (!Init) 1219 return Scope; 1220 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) 1221 Init = EWC->getSubExpr(); 1222 if (!isa<MaterializeTemporaryExpr>(Init)) 1223 return Scope; 1224 1225 // Lifetime-extending a temporary. 1226 QT = getReferenceInitTemporaryType(*Context, Init); 1227 } 1228 1229 // Check for constant size array. Set type to array element type. 1230 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) { 1231 if (AT->getSize() == 0) 1232 return Scope; 1233 QT = AT->getElementType(); 1234 } 1235 1236 // Check if type is a C++ class with non-trivial destructor. 1237 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl()) 1238 if (!CD->hasTrivialDestructor()) { 1239 // Add the variable to scope 1240 Scope = createOrReuseLocalScope(Scope); 1241 Scope->addVar(VD); 1242 ScopePos = Scope->begin(); 1243 } 1244 return Scope; 1245 } 1246 1247 /// addLocalScopeAndDtors - For given statement add local scope for it and 1248 /// add destructors that will cleanup the scope. Will reuse Scope if not NULL. 1249 void CFGBuilder::addLocalScopeAndDtors(Stmt *S) { 1250 if (!BuildOpts.AddImplicitDtors) 1251 return; 1252 1253 LocalScope::const_iterator scopeBeginPos = ScopePos; 1254 addLocalScopeForStmt(S); 1255 addAutomaticObjDtors(ScopePos, scopeBeginPos, S); 1256 } 1257 1258 /// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for 1259 /// variables with automatic storage duration to CFGBlock's elements vector. 1260 /// Elements will be prepended to physical beginning of the vector which 1261 /// happens to be logical end. Use blocks terminator as statement that specifies 1262 /// destructors call site. 1263 /// FIXME: This mechanism for adding automatic destructors doesn't handle 1264 /// no-return destructors properly. 1265 void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk, 1266 LocalScope::const_iterator B, LocalScope::const_iterator E) { 1267 BumpVectorContext &C = cfg->getBumpVectorContext(); 1268 CFGBlock::iterator InsertPos 1269 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C); 1270 for (LocalScope::const_iterator I = B; I != E; ++I) 1271 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I, 1272 Blk->getTerminator()); 1273 } 1274 1275 /// Visit - Walk the subtree of a statement and add extra 1276 /// blocks for ternary operators, &&, and ||. We also process "," and 1277 /// DeclStmts (which may contain nested control-flow). 1278 CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) { 1279 if (!S) { 1280 badCFG = true; 1281 return 0; 1282 } 1283 1284 if (Expr *E = dyn_cast<Expr>(S)) 1285 S = E->IgnoreParens(); 1286 1287 switch (S->getStmtClass()) { 1288 default: 1289 return VisitStmt(S, asc); 1290 1291 case Stmt::AddrLabelExprClass: 1292 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc); 1293 1294 case Stmt::BinaryConditionalOperatorClass: 1295 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc); 1296 1297 case Stmt::BinaryOperatorClass: 1298 return VisitBinaryOperator(cast<BinaryOperator>(S), asc); 1299 1300 case Stmt::BlockExprClass: 1301 return VisitNoRecurse(cast<Expr>(S), asc); 1302 1303 case Stmt::BreakStmtClass: 1304 return VisitBreakStmt(cast<BreakStmt>(S)); 1305 1306 case Stmt::CallExprClass: 1307 case Stmt::CXXOperatorCallExprClass: 1308 case Stmt::CXXMemberCallExprClass: 1309 case Stmt::UserDefinedLiteralClass: 1310 return VisitCallExpr(cast<CallExpr>(S), asc); 1311 1312 case Stmt::CaseStmtClass: 1313 return VisitCaseStmt(cast<CaseStmt>(S)); 1314 1315 case Stmt::ChooseExprClass: 1316 return VisitChooseExpr(cast<ChooseExpr>(S), asc); 1317 1318 case Stmt::CompoundStmtClass: 1319 return VisitCompoundStmt(cast<CompoundStmt>(S)); 1320 1321 case Stmt::ConditionalOperatorClass: 1322 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc); 1323 1324 case Stmt::ContinueStmtClass: 1325 return VisitContinueStmt(cast<ContinueStmt>(S)); 1326 1327 case Stmt::CXXCatchStmtClass: 1328 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S)); 1329 1330 case Stmt::ExprWithCleanupsClass: 1331 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc); 1332 1333 case Stmt::CXXDefaultArgExprClass: 1334 case Stmt::CXXDefaultInitExprClass: 1335 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the 1336 // called function's declaration, not by the caller. If we simply add 1337 // this expression to the CFG, we could end up with the same Expr 1338 // appearing multiple times. 1339 // PR13385 / <rdar://problem/12156507> 1340 // 1341 // It's likewise possible for multiple CXXDefaultInitExprs for the same 1342 // expression to be used in the same function (through aggregate 1343 // initialization). 1344 return VisitStmt(S, asc); 1345 1346 case Stmt::CXXBindTemporaryExprClass: 1347 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc); 1348 1349 case Stmt::CXXConstructExprClass: 1350 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc); 1351 1352 case Stmt::CXXNewExprClass: 1353 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc); 1354 1355 case Stmt::CXXDeleteExprClass: 1356 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc); 1357 1358 case Stmt::CXXFunctionalCastExprClass: 1359 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc); 1360 1361 case Stmt::CXXTemporaryObjectExprClass: 1362 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc); 1363 1364 case Stmt::CXXThrowExprClass: 1365 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S)); 1366 1367 case Stmt::CXXTryStmtClass: 1368 return VisitCXXTryStmt(cast<CXXTryStmt>(S)); 1369 1370 case Stmt::CXXForRangeStmtClass: 1371 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S)); 1372 1373 case Stmt::DeclStmtClass: 1374 return VisitDeclStmt(cast<DeclStmt>(S)); 1375 1376 case Stmt::DefaultStmtClass: 1377 return VisitDefaultStmt(cast<DefaultStmt>(S)); 1378 1379 case Stmt::DoStmtClass: 1380 return VisitDoStmt(cast<DoStmt>(S)); 1381 1382 case Stmt::ForStmtClass: 1383 return VisitForStmt(cast<ForStmt>(S)); 1384 1385 case Stmt::GotoStmtClass: 1386 return VisitGotoStmt(cast<GotoStmt>(S)); 1387 1388 case Stmt::IfStmtClass: 1389 return VisitIfStmt(cast<IfStmt>(S)); 1390 1391 case Stmt::ImplicitCastExprClass: 1392 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc); 1393 1394 case Stmt::IndirectGotoStmtClass: 1395 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S)); 1396 1397 case Stmt::LabelStmtClass: 1398 return VisitLabelStmt(cast<LabelStmt>(S)); 1399 1400 case Stmt::LambdaExprClass: 1401 return VisitLambdaExpr(cast<LambdaExpr>(S), asc); 1402 1403 case Stmt::MemberExprClass: 1404 return VisitMemberExpr(cast<MemberExpr>(S), asc); 1405 1406 case Stmt::NullStmtClass: 1407 return Block; 1408 1409 case Stmt::ObjCAtCatchStmtClass: 1410 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S)); 1411 1412 case Stmt::ObjCAutoreleasePoolStmtClass: 1413 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S)); 1414 1415 case Stmt::ObjCAtSynchronizedStmtClass: 1416 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S)); 1417 1418 case Stmt::ObjCAtThrowStmtClass: 1419 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S)); 1420 1421 case Stmt::ObjCAtTryStmtClass: 1422 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S)); 1423 1424 case Stmt::ObjCForCollectionStmtClass: 1425 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S)); 1426 1427 case Stmt::OpaqueValueExprClass: 1428 return Block; 1429 1430 case Stmt::PseudoObjectExprClass: 1431 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S)); 1432 1433 case Stmt::ReturnStmtClass: 1434 return VisitReturnStmt(cast<ReturnStmt>(S)); 1435 1436 case Stmt::UnaryExprOrTypeTraitExprClass: 1437 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S), 1438 asc); 1439 1440 case Stmt::StmtExprClass: 1441 return VisitStmtExpr(cast<StmtExpr>(S), asc); 1442 1443 case Stmt::SwitchStmtClass: 1444 return VisitSwitchStmt(cast<SwitchStmt>(S)); 1445 1446 case Stmt::UnaryOperatorClass: 1447 return VisitUnaryOperator(cast<UnaryOperator>(S), asc); 1448 1449 case Stmt::WhileStmtClass: 1450 return VisitWhileStmt(cast<WhileStmt>(S)); 1451 } 1452 } 1453 1454 CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) { 1455 if (asc.alwaysAdd(*this, S)) { 1456 autoCreateBlock(); 1457 appendStmt(Block, S); 1458 } 1459 1460 return VisitChildren(S); 1461 } 1462 1463 /// VisitChildren - Visit the children of a Stmt. 1464 CFGBlock *CFGBuilder::VisitChildren(Stmt *S) { 1465 CFGBlock *B = Block; 1466 1467 // Visit the children in their reverse order so that they appear in 1468 // left-to-right (natural) order in the CFG. 1469 reverse_children RChildren(S); 1470 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end(); 1471 I != E; ++I) { 1472 if (Stmt *Child = *I) 1473 if (CFGBlock *R = Visit(Child)) 1474 B = R; 1475 } 1476 return B; 1477 } 1478 1479 CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A, 1480 AddStmtChoice asc) { 1481 AddressTakenLabels.insert(A->getLabel()); 1482 1483 if (asc.alwaysAdd(*this, A)) { 1484 autoCreateBlock(); 1485 appendStmt(Block, A); 1486 } 1487 1488 return Block; 1489 } 1490 1491 CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U, 1492 AddStmtChoice asc) { 1493 if (asc.alwaysAdd(*this, U)) { 1494 autoCreateBlock(); 1495 appendStmt(Block, U); 1496 } 1497 1498 return Visit(U->getSubExpr(), AddStmtChoice()); 1499 } 1500 1501 CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) { 1502 CFGBlock *ConfluenceBlock = Block ? Block : createBlock(); 1503 appendStmt(ConfluenceBlock, B); 1504 1505 if (badCFG) 1506 return 0; 1507 1508 return VisitLogicalOperator(B, 0, ConfluenceBlock, ConfluenceBlock).first; 1509 } 1510 1511 std::pair<CFGBlock*, CFGBlock*> 1512 CFGBuilder::VisitLogicalOperator(BinaryOperator *B, 1513 Stmt *Term, 1514 CFGBlock *TrueBlock, 1515 CFGBlock *FalseBlock) { 1516 1517 // Introspect the RHS. If it is a nested logical operation, we recursively 1518 // build the CFG using this function. Otherwise, resort to default 1519 // CFG construction behavior. 1520 Expr *RHS = B->getRHS()->IgnoreParens(); 1521 CFGBlock *RHSBlock, *ExitBlock; 1522 1523 do { 1524 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS)) 1525 if (B_RHS->isLogicalOp()) { 1526 std::tie(RHSBlock, ExitBlock) = 1527 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock); 1528 break; 1529 } 1530 1531 // The RHS is not a nested logical operation. Don't push the terminator 1532 // down further, but instead visit RHS and construct the respective 1533 // pieces of the CFG, and link up the RHSBlock with the terminator 1534 // we have been provided. 1535 ExitBlock = RHSBlock = createBlock(false); 1536 1537 if (!Term) { 1538 assert(TrueBlock == FalseBlock); 1539 addSuccessor(RHSBlock, TrueBlock); 1540 } 1541 else { 1542 RHSBlock->setTerminator(Term); 1543 TryResult KnownVal = tryEvaluateBool(RHS); 1544 if (!KnownVal.isKnown()) 1545 KnownVal = tryEvaluateBool(B); 1546 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse()); 1547 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue()); 1548 } 1549 1550 Block = RHSBlock; 1551 RHSBlock = addStmt(RHS); 1552 } 1553 while (false); 1554 1555 if (badCFG) 1556 return std::make_pair((CFGBlock*)0, (CFGBlock*)0); 1557 1558 // Generate the blocks for evaluating the LHS. 1559 Expr *LHS = B->getLHS()->IgnoreParens(); 1560 1561 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS)) 1562 if (B_LHS->isLogicalOp()) { 1563 if (B->getOpcode() == BO_LOr) 1564 FalseBlock = RHSBlock; 1565 else 1566 TrueBlock = RHSBlock; 1567 1568 // For the LHS, treat 'B' as the terminator that we want to sink 1569 // into the nested branch. The RHS always gets the top-most 1570 // terminator. 1571 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock); 1572 } 1573 1574 // Create the block evaluating the LHS. 1575 // This contains the '&&' or '||' as the terminator. 1576 CFGBlock *LHSBlock = createBlock(false); 1577 LHSBlock->setTerminator(B); 1578 1579 Block = LHSBlock; 1580 CFGBlock *EntryLHSBlock = addStmt(LHS); 1581 1582 if (badCFG) 1583 return std::make_pair((CFGBlock*)0, (CFGBlock*)0); 1584 1585 // See if this is a known constant. 1586 TryResult KnownVal = tryEvaluateBool(LHS); 1587 1588 // Now link the LHSBlock with RHSBlock. 1589 if (B->getOpcode() == BO_LOr) { 1590 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse()); 1591 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue()); 1592 } else { 1593 assert(B->getOpcode() == BO_LAnd); 1594 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse()); 1595 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue()); 1596 } 1597 1598 return std::make_pair(EntryLHSBlock, ExitBlock); 1599 } 1600 1601 1602 CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B, 1603 AddStmtChoice asc) { 1604 // && or || 1605 if (B->isLogicalOp()) 1606 return VisitLogicalOperator(B); 1607 1608 if (B->getOpcode() == BO_Comma) { // , 1609 autoCreateBlock(); 1610 appendStmt(Block, B); 1611 addStmt(B->getRHS()); 1612 return addStmt(B->getLHS()); 1613 } 1614 1615 if (B->isAssignmentOp()) { 1616 if (asc.alwaysAdd(*this, B)) { 1617 autoCreateBlock(); 1618 appendStmt(Block, B); 1619 } 1620 Visit(B->getLHS()); 1621 return Visit(B->getRHS()); 1622 } 1623 1624 if (asc.alwaysAdd(*this, B)) { 1625 autoCreateBlock(); 1626 appendStmt(Block, B); 1627 } 1628 1629 CFGBlock *RBlock = Visit(B->getRHS()); 1630 CFGBlock *LBlock = Visit(B->getLHS()); 1631 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr 1632 // containing a DoStmt, and the LHS doesn't create a new block, then we should 1633 // return RBlock. Otherwise we'll incorrectly return NULL. 1634 return (LBlock ? LBlock : RBlock); 1635 } 1636 1637 CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) { 1638 if (asc.alwaysAdd(*this, E)) { 1639 autoCreateBlock(); 1640 appendStmt(Block, E); 1641 } 1642 return Block; 1643 } 1644 1645 CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) { 1646 // "break" is a control-flow statement. Thus we stop processing the current 1647 // block. 1648 if (badCFG) 1649 return 0; 1650 1651 // Now create a new block that ends with the break statement. 1652 Block = createBlock(false); 1653 Block->setTerminator(B); 1654 1655 // If there is no target for the break, then we are looking at an incomplete 1656 // AST. This means that the CFG cannot be constructed. 1657 if (BreakJumpTarget.block) { 1658 addAutomaticObjDtors(ScopePos, BreakJumpTarget.scopePosition, B); 1659 addSuccessor(Block, BreakJumpTarget.block); 1660 } else 1661 badCFG = true; 1662 1663 1664 return Block; 1665 } 1666 1667 static bool CanThrow(Expr *E, ASTContext &Ctx) { 1668 QualType Ty = E->getType(); 1669 if (Ty->isFunctionPointerType()) 1670 Ty = Ty->getAs<PointerType>()->getPointeeType(); 1671 else if (Ty->isBlockPointerType()) 1672 Ty = Ty->getAs<BlockPointerType>()->getPointeeType(); 1673 1674 const FunctionType *FT = Ty->getAs<FunctionType>(); 1675 if (FT) { 1676 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT)) 1677 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) && 1678 Proto->isNothrow(Ctx)) 1679 return false; 1680 } 1681 return true; 1682 } 1683 1684 CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) { 1685 // Compute the callee type. 1686 QualType calleeType = C->getCallee()->getType(); 1687 if (calleeType == Context->BoundMemberTy) { 1688 QualType boundType = Expr::findBoundMemberType(C->getCallee()); 1689 1690 // We should only get a null bound type if processing a dependent 1691 // CFG. Recover by assuming nothing. 1692 if (!boundType.isNull()) calleeType = boundType; 1693 } 1694 1695 // If this is a call to a no-return function, this stops the block here. 1696 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn(); 1697 1698 bool AddEHEdge = false; 1699 1700 // Languages without exceptions are assumed to not throw. 1701 if (Context->getLangOpts().Exceptions) { 1702 if (BuildOpts.AddEHEdges) 1703 AddEHEdge = true; 1704 } 1705 1706 // If this is a call to a builtin function, it might not actually evaluate 1707 // its arguments. Don't add them to the CFG if this is the case. 1708 bool OmitArguments = false; 1709 1710 if (FunctionDecl *FD = C->getDirectCallee()) { 1711 if (FD->isNoReturn()) 1712 NoReturn = true; 1713 if (FD->hasAttr<NoThrowAttr>()) 1714 AddEHEdge = false; 1715 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size) 1716 OmitArguments = true; 1717 } 1718 1719 if (!CanThrow(C->getCallee(), *Context)) 1720 AddEHEdge = false; 1721 1722 if (OmitArguments) { 1723 assert(!NoReturn && "noreturn calls with unevaluated args not implemented"); 1724 assert(!AddEHEdge && "EH calls with unevaluated args not implemented"); 1725 autoCreateBlock(); 1726 appendStmt(Block, C); 1727 return Visit(C->getCallee()); 1728 } 1729 1730 if (!NoReturn && !AddEHEdge) { 1731 return VisitStmt(C, asc.withAlwaysAdd(true)); 1732 } 1733 1734 if (Block) { 1735 Succ = Block; 1736 if (badCFG) 1737 return 0; 1738 } 1739 1740 if (NoReturn) 1741 Block = createNoReturnBlock(); 1742 else 1743 Block = createBlock(); 1744 1745 appendStmt(Block, C); 1746 1747 if (AddEHEdge) { 1748 // Add exceptional edges. 1749 if (TryTerminatedBlock) 1750 addSuccessor(Block, TryTerminatedBlock); 1751 else 1752 addSuccessor(Block, &cfg->getExit()); 1753 } 1754 1755 return VisitChildren(C); 1756 } 1757 1758 CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C, 1759 AddStmtChoice asc) { 1760 CFGBlock *ConfluenceBlock = Block ? Block : createBlock(); 1761 appendStmt(ConfluenceBlock, C); 1762 if (badCFG) 1763 return 0; 1764 1765 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true); 1766 Succ = ConfluenceBlock; 1767 Block = NULL; 1768 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd); 1769 if (badCFG) 1770 return 0; 1771 1772 Succ = ConfluenceBlock; 1773 Block = NULL; 1774 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd); 1775 if (badCFG) 1776 return 0; 1777 1778 Block = createBlock(false); 1779 // See if this is a known constant. 1780 const TryResult& KnownVal = tryEvaluateBool(C->getCond()); 1781 addSuccessor(Block, KnownVal.isFalse() ? NULL : LHSBlock); 1782 addSuccessor(Block, KnownVal.isTrue() ? NULL : RHSBlock); 1783 Block->setTerminator(C); 1784 return addStmt(C->getCond()); 1785 } 1786 1787 1788 CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) { 1789 addLocalScopeAndDtors(C); 1790 CFGBlock *LastBlock = Block; 1791 1792 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend(); 1793 I != E; ++I ) { 1794 // If we hit a segment of code just containing ';' (NullStmts), we can 1795 // get a null block back. In such cases, just use the LastBlock 1796 if (CFGBlock *newBlock = addStmt(*I)) 1797 LastBlock = newBlock; 1798 1799 if (badCFG) 1800 return NULL; 1801 } 1802 1803 return LastBlock; 1804 } 1805 1806 CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C, 1807 AddStmtChoice asc) { 1808 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C); 1809 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : NULL); 1810 1811 // Create the confluence block that will "merge" the results of the ternary 1812 // expression. 1813 CFGBlock *ConfluenceBlock = Block ? Block : createBlock(); 1814 appendStmt(ConfluenceBlock, C); 1815 if (badCFG) 1816 return 0; 1817 1818 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true); 1819 1820 // Create a block for the LHS expression if there is an LHS expression. A 1821 // GCC extension allows LHS to be NULL, causing the condition to be the 1822 // value that is returned instead. 1823 // e.g: x ?: y is shorthand for: x ? x : y; 1824 Succ = ConfluenceBlock; 1825 Block = NULL; 1826 CFGBlock *LHSBlock = 0; 1827 const Expr *trueExpr = C->getTrueExpr(); 1828 if (trueExpr != opaqueValue) { 1829 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd); 1830 if (badCFG) 1831 return 0; 1832 Block = NULL; 1833 } 1834 else 1835 LHSBlock = ConfluenceBlock; 1836 1837 // Create the block for the RHS expression. 1838 Succ = ConfluenceBlock; 1839 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd); 1840 if (badCFG) 1841 return 0; 1842 1843 // If the condition is a logical '&&' or '||', build a more accurate CFG. 1844 if (BinaryOperator *Cond = 1845 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens())) 1846 if (Cond->isLogicalOp()) 1847 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first; 1848 1849 // Create the block that will contain the condition. 1850 Block = createBlock(false); 1851 1852 // See if this is a known constant. 1853 const TryResult& KnownVal = tryEvaluateBool(C->getCond()); 1854 addSuccessor(Block, LHSBlock, !KnownVal.isFalse()); 1855 addSuccessor(Block, RHSBlock, !KnownVal.isTrue()); 1856 Block->setTerminator(C); 1857 Expr *condExpr = C->getCond(); 1858 1859 if (opaqueValue) { 1860 // Run the condition expression if it's not trivially expressed in 1861 // terms of the opaque value (or if there is no opaque value). 1862 if (condExpr != opaqueValue) 1863 addStmt(condExpr); 1864 1865 // Before that, run the common subexpression if there was one. 1866 // At least one of this or the above will be run. 1867 return addStmt(BCO->getCommon()); 1868 } 1869 1870 return addStmt(condExpr); 1871 } 1872 1873 CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) { 1874 // Check if the Decl is for an __label__. If so, elide it from the 1875 // CFG entirely. 1876 if (isa<LabelDecl>(*DS->decl_begin())) 1877 return Block; 1878 1879 // This case also handles static_asserts. 1880 if (DS->isSingleDecl()) 1881 return VisitDeclSubExpr(DS); 1882 1883 CFGBlock *B = 0; 1884 1885 // Build an individual DeclStmt for each decl. 1886 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(), 1887 E = DS->decl_rend(); 1888 I != E; ++I) { 1889 // Get the alignment of the new DeclStmt, padding out to >=8 bytes. 1890 unsigned A = llvm::AlignOf<DeclStmt>::Alignment < 8 1891 ? 8 : llvm::AlignOf<DeclStmt>::Alignment; 1892 1893 // Allocate the DeclStmt using the BumpPtrAllocator. It will get 1894 // automatically freed with the CFG. 1895 DeclGroupRef DG(*I); 1896 Decl *D = *I; 1897 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A); 1898 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D)); 1899 cfg->addSyntheticDeclStmt(DSNew, DS); 1900 1901 // Append the fake DeclStmt to block. 1902 B = VisitDeclSubExpr(DSNew); 1903 } 1904 1905 return B; 1906 } 1907 1908 /// VisitDeclSubExpr - Utility method to add block-level expressions for 1909 /// DeclStmts and initializers in them. 1910 CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) { 1911 assert(DS->isSingleDecl() && "Can handle single declarations only."); 1912 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl()); 1913 1914 if (!VD) { 1915 // Of everything that can be declared in a DeclStmt, only VarDecls impact 1916 // runtime semantics. 1917 return Block; 1918 } 1919 1920 bool IsReference = false; 1921 bool HasTemporaries = false; 1922 1923 // Guard static initializers under a branch. 1924 CFGBlock *blockAfterStaticInit = 0; 1925 1926 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) { 1927 // For static variables, we need to create a branch to track 1928 // whether or not they are initialized. 1929 if (Block) { 1930 Succ = Block; 1931 Block = 0; 1932 if (badCFG) 1933 return 0; 1934 } 1935 blockAfterStaticInit = Succ; 1936 } 1937 1938 // Destructors of temporaries in initialization expression should be called 1939 // after initialization finishes. 1940 Expr *Init = VD->getInit(); 1941 if (Init) { 1942 IsReference = VD->getType()->isReferenceType(); 1943 HasTemporaries = isa<ExprWithCleanups>(Init); 1944 1945 if (BuildOpts.AddTemporaryDtors && HasTemporaries) { 1946 // Generate destructors for temporaries in initialization expression. 1947 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(), 1948 IsReference); 1949 } 1950 } 1951 1952 autoCreateBlock(); 1953 appendStmt(Block, DS); 1954 1955 // Keep track of the last non-null block, as 'Block' can be nulled out 1956 // if the initializer expression is something like a 'while' in a 1957 // statement-expression. 1958 CFGBlock *LastBlock = Block; 1959 1960 if (Init) { 1961 if (HasTemporaries) { 1962 // For expression with temporaries go directly to subexpression to omit 1963 // generating destructors for the second time. 1964 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init); 1965 if (CFGBlock *newBlock = Visit(EC->getSubExpr())) 1966 LastBlock = newBlock; 1967 } 1968 else { 1969 if (CFGBlock *newBlock = Visit(Init)) 1970 LastBlock = newBlock; 1971 } 1972 } 1973 1974 // If the type of VD is a VLA, then we must process its size expressions. 1975 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr()); 1976 VA != 0; VA = FindVA(VA->getElementType().getTypePtr())) { 1977 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr())) 1978 LastBlock = newBlock; 1979 } 1980 1981 // Remove variable from local scope. 1982 if (ScopePos && VD == *ScopePos) 1983 ++ScopePos; 1984 1985 CFGBlock *B = LastBlock; 1986 if (blockAfterStaticInit) { 1987 Succ = B; 1988 Block = createBlock(false); 1989 Block->setTerminator(DS); 1990 addSuccessor(Block, blockAfterStaticInit); 1991 addSuccessor(Block, B); 1992 B = Block; 1993 } 1994 1995 return B; 1996 } 1997 1998 CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) { 1999 // We may see an if statement in the middle of a basic block, or it may be the 2000 // first statement we are processing. In either case, we create a new basic 2001 // block. First, we create the blocks for the then...else statements, and 2002 // then we create the block containing the if statement. If we were in the 2003 // middle of a block, we stop processing that block. That block is then the 2004 // implicit successor for the "then" and "else" clauses. 2005 2006 // Save local scope position because in case of condition variable ScopePos 2007 // won't be restored when traversing AST. 2008 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 2009 2010 // Create local scope for possible condition variable. 2011 // Store scope position. Add implicit destructor. 2012 if (VarDecl *VD = I->getConditionVariable()) { 2013 LocalScope::const_iterator BeginScopePos = ScopePos; 2014 addLocalScopeForVarDecl(VD); 2015 addAutomaticObjDtors(ScopePos, BeginScopePos, I); 2016 } 2017 2018 // The block we were processing is now finished. Make it the successor 2019 // block. 2020 if (Block) { 2021 Succ = Block; 2022 if (badCFG) 2023 return 0; 2024 } 2025 2026 // Process the false branch. 2027 CFGBlock *ElseBlock = Succ; 2028 2029 if (Stmt *Else = I->getElse()) { 2030 SaveAndRestore<CFGBlock*> sv(Succ); 2031 2032 // NULL out Block so that the recursive call to Visit will 2033 // create a new basic block. 2034 Block = NULL; 2035 2036 // If branch is not a compound statement create implicit scope 2037 // and add destructors. 2038 if (!isa<CompoundStmt>(Else)) 2039 addLocalScopeAndDtors(Else); 2040 2041 ElseBlock = addStmt(Else); 2042 2043 if (!ElseBlock) // Can occur when the Else body has all NullStmts. 2044 ElseBlock = sv.get(); 2045 else if (Block) { 2046 if (badCFG) 2047 return 0; 2048 } 2049 } 2050 2051 // Process the true branch. 2052 CFGBlock *ThenBlock; 2053 { 2054 Stmt *Then = I->getThen(); 2055 assert(Then); 2056 SaveAndRestore<CFGBlock*> sv(Succ); 2057 Block = NULL; 2058 2059 // If branch is not a compound statement create implicit scope 2060 // and add destructors. 2061 if (!isa<CompoundStmt>(Then)) 2062 addLocalScopeAndDtors(Then); 2063 2064 ThenBlock = addStmt(Then); 2065 2066 if (!ThenBlock) { 2067 // We can reach here if the "then" body has all NullStmts. 2068 // Create an empty block so we can distinguish between true and false 2069 // branches in path-sensitive analyses. 2070 ThenBlock = createBlock(false); 2071 addSuccessor(ThenBlock, sv.get()); 2072 } else if (Block) { 2073 if (badCFG) 2074 return 0; 2075 } 2076 } 2077 2078 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by 2079 // having these handle the actual control-flow jump. Note that 2080 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)" 2081 // we resort to the old control-flow behavior. This special handling 2082 // removes infeasible paths from the control-flow graph by having the 2083 // control-flow transfer of '&&' or '||' go directly into the then/else 2084 // blocks directly. 2085 if (!I->getConditionVariable()) 2086 if (BinaryOperator *Cond = 2087 dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens())) 2088 if (Cond->isLogicalOp()) 2089 return VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first; 2090 2091 // Now create a new block containing the if statement. 2092 Block = createBlock(false); 2093 2094 // Set the terminator of the new block to the If statement. 2095 Block->setTerminator(I); 2096 2097 // See if this is a known constant. 2098 const TryResult &KnownVal = tryEvaluateBool(I->getCond()); 2099 2100 // Add the successors. If we know that specific branches are 2101 // unreachable, inform addSuccessor() of that knowledge. 2102 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse()); 2103 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue()); 2104 2105 // Add the condition as the last statement in the new block. This may create 2106 // new blocks as the condition may contain control-flow. Any newly created 2107 // blocks will be pointed to be "Block". 2108 CFGBlock *LastBlock = addStmt(I->getCond()); 2109 2110 // Finally, if the IfStmt contains a condition variable, add both the IfStmt 2111 // and the condition variable initialization to the CFG. 2112 if (VarDecl *VD = I->getConditionVariable()) { 2113 if (Expr *Init = VD->getInit()) { 2114 autoCreateBlock(); 2115 appendStmt(Block, I->getConditionVariableDeclStmt()); 2116 LastBlock = addStmt(Init); 2117 } 2118 } 2119 2120 return LastBlock; 2121 } 2122 2123 2124 CFGBlock *CFGBuilder::VisitReturnStmt(ReturnStmt *R) { 2125 // If we were in the middle of a block we stop processing that block. 2126 // 2127 // NOTE: If a "return" appears in the middle of a block, this means that the 2128 // code afterwards is DEAD (unreachable). We still keep a basic block 2129 // for that code; a simple "mark-and-sweep" from the entry block will be 2130 // able to report such dead blocks. 2131 2132 // Create the new block. 2133 Block = createBlock(false); 2134 2135 addAutomaticObjDtors(ScopePos, LocalScope::const_iterator(), R); 2136 2137 // If the one of the destructors does not return, we already have the Exit 2138 // block as a successor. 2139 if (!Block->hasNoReturnElement()) 2140 addSuccessor(Block, &cfg->getExit()); 2141 2142 // Add the return statement to the block. This may create new blocks if R 2143 // contains control-flow (short-circuit operations). 2144 return VisitStmt(R, AddStmtChoice::AlwaysAdd); 2145 } 2146 2147 CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) { 2148 // Get the block of the labeled statement. Add it to our map. 2149 addStmt(L->getSubStmt()); 2150 CFGBlock *LabelBlock = Block; 2151 2152 if (!LabelBlock) // This can happen when the body is empty, i.e. 2153 LabelBlock = createBlock(); // scopes that only contains NullStmts. 2154 2155 assert(LabelMap.find(L->getDecl()) == LabelMap.end() && 2156 "label already in map"); 2157 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos); 2158 2159 // Labels partition blocks, so this is the end of the basic block we were 2160 // processing (L is the block's label). Because this is label (and we have 2161 // already processed the substatement) there is no extra control-flow to worry 2162 // about. 2163 LabelBlock->setLabel(L); 2164 if (badCFG) 2165 return 0; 2166 2167 // We set Block to NULL to allow lazy creation of a new block (if necessary); 2168 Block = NULL; 2169 2170 // This block is now the implicit successor of other blocks. 2171 Succ = LabelBlock; 2172 2173 return LabelBlock; 2174 } 2175 2176 CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) { 2177 CFGBlock *LastBlock = VisitNoRecurse(E, asc); 2178 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(), 2179 et = E->capture_init_end(); it != et; ++it) { 2180 if (Expr *Init = *it) { 2181 CFGBlock *Tmp = Visit(Init); 2182 if (Tmp != 0) 2183 LastBlock = Tmp; 2184 } 2185 } 2186 return LastBlock; 2187 } 2188 2189 CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) { 2190 // Goto is a control-flow statement. Thus we stop processing the current 2191 // block and create a new one. 2192 2193 Block = createBlock(false); 2194 Block->setTerminator(G); 2195 2196 // If we already know the mapping to the label block add the successor now. 2197 LabelMapTy::iterator I = LabelMap.find(G->getLabel()); 2198 2199 if (I == LabelMap.end()) 2200 // We will need to backpatch this block later. 2201 BackpatchBlocks.push_back(JumpSource(Block, ScopePos)); 2202 else { 2203 JumpTarget JT = I->second; 2204 addAutomaticObjDtors(ScopePos, JT.scopePosition, G); 2205 addSuccessor(Block, JT.block); 2206 } 2207 2208 return Block; 2209 } 2210 2211 CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) { 2212 CFGBlock *LoopSuccessor = NULL; 2213 2214 // Save local scope position because in case of condition variable ScopePos 2215 // won't be restored when traversing AST. 2216 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 2217 2218 // Create local scope for init statement and possible condition variable. 2219 // Add destructor for init statement and condition variable. 2220 // Store scope position for continue statement. 2221 if (Stmt *Init = F->getInit()) 2222 addLocalScopeForStmt(Init); 2223 LocalScope::const_iterator LoopBeginScopePos = ScopePos; 2224 2225 if (VarDecl *VD = F->getConditionVariable()) 2226 addLocalScopeForVarDecl(VD); 2227 LocalScope::const_iterator ContinueScopePos = ScopePos; 2228 2229 addAutomaticObjDtors(ScopePos, save_scope_pos.get(), F); 2230 2231 // "for" is a control-flow statement. Thus we stop processing the current 2232 // block. 2233 if (Block) { 2234 if (badCFG) 2235 return 0; 2236 LoopSuccessor = Block; 2237 } else 2238 LoopSuccessor = Succ; 2239 2240 // Save the current value for the break targets. 2241 // All breaks should go to the code following the loop. 2242 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget); 2243 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos); 2244 2245 CFGBlock *BodyBlock = 0, *TransitionBlock = 0; 2246 2247 // Now create the loop body. 2248 { 2249 assert(F->getBody()); 2250 2251 // Save the current values for Block, Succ, continue and break targets. 2252 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ); 2253 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget); 2254 2255 // Create an empty block to represent the transition block for looping back 2256 // to the head of the loop. If we have increment code, it will 2257 // go in this block as well. 2258 Block = Succ = TransitionBlock = createBlock(false); 2259 TransitionBlock->setLoopTarget(F); 2260 2261 if (Stmt *I = F->getInc()) { 2262 // Generate increment code in its own basic block. This is the target of 2263 // continue statements. 2264 Succ = addStmt(I); 2265 } 2266 2267 // Finish up the increment (or empty) block if it hasn't been already. 2268 if (Block) { 2269 assert(Block == Succ); 2270 if (badCFG) 2271 return 0; 2272 Block = 0; 2273 } 2274 2275 // The starting block for the loop increment is the block that should 2276 // represent the 'loop target' for looping back to the start of the loop. 2277 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos); 2278 ContinueJumpTarget.block->setLoopTarget(F); 2279 2280 // Loop body should end with destructor of Condition variable (if any). 2281 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, F); 2282 2283 // If body is not a compound statement create implicit scope 2284 // and add destructors. 2285 if (!isa<CompoundStmt>(F->getBody())) 2286 addLocalScopeAndDtors(F->getBody()); 2287 2288 // Now populate the body block, and in the process create new blocks as we 2289 // walk the body of the loop. 2290 BodyBlock = addStmt(F->getBody()); 2291 2292 if (!BodyBlock) { 2293 // In the case of "for (...;...;...);" we can have a null BodyBlock. 2294 // Use the continue jump target as the proxy for the body. 2295 BodyBlock = ContinueJumpTarget.block; 2296 } 2297 else if (badCFG) 2298 return 0; 2299 } 2300 2301 // Because of short-circuit evaluation, the condition of the loop can span 2302 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that 2303 // evaluate the condition. 2304 CFGBlock *EntryConditionBlock = 0, *ExitConditionBlock = 0; 2305 2306 do { 2307 Expr *C = F->getCond(); 2308 2309 // Specially handle logical operators, which have a slightly 2310 // more optimal CFG representation. 2311 if (BinaryOperator *Cond = 2312 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : 0)) 2313 if (Cond->isLogicalOp()) { 2314 std::tie(EntryConditionBlock, ExitConditionBlock) = 2315 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor); 2316 break; 2317 } 2318 2319 // The default case when not handling logical operators. 2320 EntryConditionBlock = ExitConditionBlock = createBlock(false); 2321 ExitConditionBlock->setTerminator(F); 2322 2323 // See if this is a known constant. 2324 TryResult KnownVal(true); 2325 2326 if (C) { 2327 // Now add the actual condition to the condition block. 2328 // Because the condition itself may contain control-flow, new blocks may 2329 // be created. Thus we update "Succ" after adding the condition. 2330 Block = ExitConditionBlock; 2331 EntryConditionBlock = addStmt(C); 2332 2333 // If this block contains a condition variable, add both the condition 2334 // variable and initializer to the CFG. 2335 if (VarDecl *VD = F->getConditionVariable()) { 2336 if (Expr *Init = VD->getInit()) { 2337 autoCreateBlock(); 2338 appendStmt(Block, F->getConditionVariableDeclStmt()); 2339 EntryConditionBlock = addStmt(Init); 2340 assert(Block == EntryConditionBlock); 2341 } 2342 } 2343 2344 if (Block && badCFG) 2345 return 0; 2346 2347 KnownVal = tryEvaluateBool(C); 2348 } 2349 2350 // Add the loop body entry as a successor to the condition. 2351 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? NULL : BodyBlock); 2352 // Link up the condition block with the code that follows the loop. (the 2353 // false branch). 2354 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? NULL : LoopSuccessor); 2355 2356 } while (false); 2357 2358 // Link up the loop-back block to the entry condition block. 2359 addSuccessor(TransitionBlock, EntryConditionBlock); 2360 2361 // The condition block is the implicit successor for any code above the loop. 2362 Succ = EntryConditionBlock; 2363 2364 // If the loop contains initialization, create a new block for those 2365 // statements. This block can also contain statements that precede the loop. 2366 if (Stmt *I = F->getInit()) { 2367 Block = createBlock(); 2368 return addStmt(I); 2369 } 2370 2371 // There is no loop initialization. We are thus basically a while loop. 2372 // NULL out Block to force lazy block construction. 2373 Block = NULL; 2374 Succ = EntryConditionBlock; 2375 return EntryConditionBlock; 2376 } 2377 2378 CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) { 2379 if (asc.alwaysAdd(*this, M)) { 2380 autoCreateBlock(); 2381 appendStmt(Block, M); 2382 } 2383 return Visit(M->getBase()); 2384 } 2385 2386 CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) { 2387 // Objective-C fast enumeration 'for' statements: 2388 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC 2389 // 2390 // for ( Type newVariable in collection_expression ) { statements } 2391 // 2392 // becomes: 2393 // 2394 // prologue: 2395 // 1. collection_expression 2396 // T. jump to loop_entry 2397 // loop_entry: 2398 // 1. side-effects of element expression 2399 // 1. ObjCForCollectionStmt [performs binding to newVariable] 2400 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil] 2401 // TB: 2402 // statements 2403 // T. jump to loop_entry 2404 // FB: 2405 // what comes after 2406 // 2407 // and 2408 // 2409 // Type existingItem; 2410 // for ( existingItem in expression ) { statements } 2411 // 2412 // becomes: 2413 // 2414 // the same with newVariable replaced with existingItem; the binding works 2415 // the same except that for one ObjCForCollectionStmt::getElement() returns 2416 // a DeclStmt and the other returns a DeclRefExpr. 2417 // 2418 2419 CFGBlock *LoopSuccessor = 0; 2420 2421 if (Block) { 2422 if (badCFG) 2423 return 0; 2424 LoopSuccessor = Block; 2425 Block = 0; 2426 } else 2427 LoopSuccessor = Succ; 2428 2429 // Build the condition blocks. 2430 CFGBlock *ExitConditionBlock = createBlock(false); 2431 2432 // Set the terminator for the "exit" condition block. 2433 ExitConditionBlock->setTerminator(S); 2434 2435 // The last statement in the block should be the ObjCForCollectionStmt, which 2436 // performs the actual binding to 'element' and determines if there are any 2437 // more items in the collection. 2438 appendStmt(ExitConditionBlock, S); 2439 Block = ExitConditionBlock; 2440 2441 // Walk the 'element' expression to see if there are any side-effects. We 2442 // generate new blocks as necessary. We DON'T add the statement by default to 2443 // the CFG unless it contains control-flow. 2444 CFGBlock *EntryConditionBlock = Visit(S->getElement(), 2445 AddStmtChoice::NotAlwaysAdd); 2446 if (Block) { 2447 if (badCFG) 2448 return 0; 2449 Block = 0; 2450 } 2451 2452 // The condition block is the implicit successor for the loop body as well as 2453 // any code above the loop. 2454 Succ = EntryConditionBlock; 2455 2456 // Now create the true branch. 2457 { 2458 // Save the current values for Succ, continue and break targets. 2459 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ); 2460 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget), 2461 save_break(BreakJumpTarget); 2462 2463 // Add an intermediate block between the BodyBlock and the 2464 // EntryConditionBlock to represent the "loop back" transition, for looping 2465 // back to the head of the loop. 2466 CFGBlock *LoopBackBlock = 0; 2467 Succ = LoopBackBlock = createBlock(); 2468 LoopBackBlock->setLoopTarget(S); 2469 2470 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos); 2471 ContinueJumpTarget = JumpTarget(Succ, ScopePos); 2472 2473 CFGBlock *BodyBlock = addStmt(S->getBody()); 2474 2475 if (!BodyBlock) 2476 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;" 2477 else if (Block) { 2478 if (badCFG) 2479 return 0; 2480 } 2481 2482 // This new body block is a successor to our "exit" condition block. 2483 addSuccessor(ExitConditionBlock, BodyBlock); 2484 } 2485 2486 // Link up the condition block with the code that follows the loop. 2487 // (the false branch). 2488 addSuccessor(ExitConditionBlock, LoopSuccessor); 2489 2490 // Now create a prologue block to contain the collection expression. 2491 Block = createBlock(); 2492 return addStmt(S->getCollection()); 2493 } 2494 2495 CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) { 2496 // Inline the body. 2497 return addStmt(S->getSubStmt()); 2498 // TODO: consider adding cleanups for the end of @autoreleasepool scope. 2499 } 2500 2501 CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) { 2502 // FIXME: Add locking 'primitives' to CFG for @synchronized. 2503 2504 // Inline the body. 2505 CFGBlock *SyncBlock = addStmt(S->getSynchBody()); 2506 2507 // The sync body starts its own basic block. This makes it a little easier 2508 // for diagnostic clients. 2509 if (SyncBlock) { 2510 if (badCFG) 2511 return 0; 2512 2513 Block = 0; 2514 Succ = SyncBlock; 2515 } 2516 2517 // Add the @synchronized to the CFG. 2518 autoCreateBlock(); 2519 appendStmt(Block, S); 2520 2521 // Inline the sync expression. 2522 return addStmt(S->getSynchExpr()); 2523 } 2524 2525 CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) { 2526 // FIXME 2527 return NYS(); 2528 } 2529 2530 CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) { 2531 autoCreateBlock(); 2532 2533 // Add the PseudoObject as the last thing. 2534 appendStmt(Block, E); 2535 2536 CFGBlock *lastBlock = Block; 2537 2538 // Before that, evaluate all of the semantics in order. In 2539 // CFG-land, that means appending them in reverse order. 2540 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) { 2541 Expr *Semantic = E->getSemanticExpr(--i); 2542 2543 // If the semantic is an opaque value, we're being asked to bind 2544 // it to its source expression. 2545 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic)) 2546 Semantic = OVE->getSourceExpr(); 2547 2548 if (CFGBlock *B = Visit(Semantic)) 2549 lastBlock = B; 2550 } 2551 2552 return lastBlock; 2553 } 2554 2555 CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) { 2556 CFGBlock *LoopSuccessor = NULL; 2557 2558 // Save local scope position because in case of condition variable ScopePos 2559 // won't be restored when traversing AST. 2560 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 2561 2562 // Create local scope for possible condition variable. 2563 // Store scope position for continue statement. 2564 LocalScope::const_iterator LoopBeginScopePos = ScopePos; 2565 if (VarDecl *VD = W->getConditionVariable()) { 2566 addLocalScopeForVarDecl(VD); 2567 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, W); 2568 } 2569 2570 // "while" is a control-flow statement. Thus we stop processing the current 2571 // block. 2572 if (Block) { 2573 if (badCFG) 2574 return 0; 2575 LoopSuccessor = Block; 2576 Block = 0; 2577 } else { 2578 LoopSuccessor = Succ; 2579 } 2580 2581 CFGBlock *BodyBlock = 0, *TransitionBlock = 0; 2582 2583 // Process the loop body. 2584 { 2585 assert(W->getBody()); 2586 2587 // Save the current values for Block, Succ, continue and break targets. 2588 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ); 2589 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget), 2590 save_break(BreakJumpTarget); 2591 2592 // Create an empty block to represent the transition block for looping back 2593 // to the head of the loop. 2594 Succ = TransitionBlock = createBlock(false); 2595 TransitionBlock->setLoopTarget(W); 2596 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos); 2597 2598 // All breaks should go to the code following the loop. 2599 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos); 2600 2601 // Loop body should end with destructor of Condition variable (if any). 2602 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, W); 2603 2604 // If body is not a compound statement create implicit scope 2605 // and add destructors. 2606 if (!isa<CompoundStmt>(W->getBody())) 2607 addLocalScopeAndDtors(W->getBody()); 2608 2609 // Create the body. The returned block is the entry to the loop body. 2610 BodyBlock = addStmt(W->getBody()); 2611 2612 if (!BodyBlock) 2613 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;" 2614 else if (Block && badCFG) 2615 return 0; 2616 } 2617 2618 // Because of short-circuit evaluation, the condition of the loop can span 2619 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that 2620 // evaluate the condition. 2621 CFGBlock *EntryConditionBlock = 0, *ExitConditionBlock = 0; 2622 2623 do { 2624 Expr *C = W->getCond(); 2625 2626 // Specially handle logical operators, which have a slightly 2627 // more optimal CFG representation. 2628 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens())) 2629 if (Cond->isLogicalOp()) { 2630 std::tie(EntryConditionBlock, ExitConditionBlock) = 2631 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor); 2632 break; 2633 } 2634 2635 // The default case when not handling logical operators. 2636 ExitConditionBlock = createBlock(false); 2637 ExitConditionBlock->setTerminator(W); 2638 2639 // Now add the actual condition to the condition block. 2640 // Because the condition itself may contain control-flow, new blocks may 2641 // be created. Thus we update "Succ" after adding the condition. 2642 Block = ExitConditionBlock; 2643 Block = EntryConditionBlock = addStmt(C); 2644 2645 // If this block contains a condition variable, add both the condition 2646 // variable and initializer to the CFG. 2647 if (VarDecl *VD = W->getConditionVariable()) { 2648 if (Expr *Init = VD->getInit()) { 2649 autoCreateBlock(); 2650 appendStmt(Block, W->getConditionVariableDeclStmt()); 2651 EntryConditionBlock = addStmt(Init); 2652 assert(Block == EntryConditionBlock); 2653 } 2654 } 2655 2656 if (Block && badCFG) 2657 return 0; 2658 2659 // See if this is a known constant. 2660 const TryResult& KnownVal = tryEvaluateBool(C); 2661 2662 // Add the loop body entry as a successor to the condition. 2663 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? NULL : BodyBlock); 2664 // Link up the condition block with the code that follows the loop. (the 2665 // false branch). 2666 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? NULL : LoopSuccessor); 2667 2668 } while(false); 2669 2670 // Link up the loop-back block to the entry condition block. 2671 addSuccessor(TransitionBlock, EntryConditionBlock); 2672 2673 // There can be no more statements in the condition block since we loop back 2674 // to this block. NULL out Block to force lazy creation of another block. 2675 Block = NULL; 2676 2677 // Return the condition block, which is the dominating block for the loop. 2678 Succ = EntryConditionBlock; 2679 return EntryConditionBlock; 2680 } 2681 2682 2683 CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) { 2684 // FIXME: For now we pretend that @catch and the code it contains does not 2685 // exit. 2686 return Block; 2687 } 2688 2689 CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) { 2690 // FIXME: This isn't complete. We basically treat @throw like a return 2691 // statement. 2692 2693 // If we were in the middle of a block we stop processing that block. 2694 if (badCFG) 2695 return 0; 2696 2697 // Create the new block. 2698 Block = createBlock(false); 2699 2700 // The Exit block is the only successor. 2701 addSuccessor(Block, &cfg->getExit()); 2702 2703 // Add the statement to the block. This may create new blocks if S contains 2704 // control-flow (short-circuit operations). 2705 return VisitStmt(S, AddStmtChoice::AlwaysAdd); 2706 } 2707 2708 CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) { 2709 // If we were in the middle of a block we stop processing that block. 2710 if (badCFG) 2711 return 0; 2712 2713 // Create the new block. 2714 Block = createBlock(false); 2715 2716 if (TryTerminatedBlock) 2717 // The current try statement is the only successor. 2718 addSuccessor(Block, TryTerminatedBlock); 2719 else 2720 // otherwise the Exit block is the only successor. 2721 addSuccessor(Block, &cfg->getExit()); 2722 2723 // Add the statement to the block. This may create new blocks if S contains 2724 // control-flow (short-circuit operations). 2725 return VisitStmt(T, AddStmtChoice::AlwaysAdd); 2726 } 2727 2728 CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) { 2729 CFGBlock *LoopSuccessor = NULL; 2730 2731 // "do...while" is a control-flow statement. Thus we stop processing the 2732 // current block. 2733 if (Block) { 2734 if (badCFG) 2735 return 0; 2736 LoopSuccessor = Block; 2737 } else 2738 LoopSuccessor = Succ; 2739 2740 // Because of short-circuit evaluation, the condition of the loop can span 2741 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that 2742 // evaluate the condition. 2743 CFGBlock *ExitConditionBlock = createBlock(false); 2744 CFGBlock *EntryConditionBlock = ExitConditionBlock; 2745 2746 // Set the terminator for the "exit" condition block. 2747 ExitConditionBlock->setTerminator(D); 2748 2749 // Now add the actual condition to the condition block. Because the condition 2750 // itself may contain control-flow, new blocks may be created. 2751 if (Stmt *C = D->getCond()) { 2752 Block = ExitConditionBlock; 2753 EntryConditionBlock = addStmt(C); 2754 if (Block) { 2755 if (badCFG) 2756 return 0; 2757 } 2758 } 2759 2760 // The condition block is the implicit successor for the loop body. 2761 Succ = EntryConditionBlock; 2762 2763 // See if this is a known constant. 2764 const TryResult &KnownVal = tryEvaluateBool(D->getCond()); 2765 2766 // Process the loop body. 2767 CFGBlock *BodyBlock = NULL; 2768 { 2769 assert(D->getBody()); 2770 2771 // Save the current values for Block, Succ, and continue and break targets 2772 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ); 2773 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget), 2774 save_break(BreakJumpTarget); 2775 2776 // All continues within this loop should go to the condition block 2777 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos); 2778 2779 // All breaks should go to the code following the loop. 2780 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos); 2781 2782 // NULL out Block to force lazy instantiation of blocks for the body. 2783 Block = NULL; 2784 2785 // If body is not a compound statement create implicit scope 2786 // and add destructors. 2787 if (!isa<CompoundStmt>(D->getBody())) 2788 addLocalScopeAndDtors(D->getBody()); 2789 2790 // Create the body. The returned block is the entry to the loop body. 2791 BodyBlock = addStmt(D->getBody()); 2792 2793 if (!BodyBlock) 2794 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)" 2795 else if (Block) { 2796 if (badCFG) 2797 return 0; 2798 } 2799 2800 if (!KnownVal.isFalse()) { 2801 // Add an intermediate block between the BodyBlock and the 2802 // ExitConditionBlock to represent the "loop back" transition. Create an 2803 // empty block to represent the transition block for looping back to the 2804 // head of the loop. 2805 // FIXME: Can we do this more efficiently without adding another block? 2806 Block = NULL; 2807 Succ = BodyBlock; 2808 CFGBlock *LoopBackBlock = createBlock(); 2809 LoopBackBlock->setLoopTarget(D); 2810 2811 // Add the loop body entry as a successor to the condition. 2812 addSuccessor(ExitConditionBlock, LoopBackBlock); 2813 } 2814 else 2815 addSuccessor(ExitConditionBlock, NULL); 2816 } 2817 2818 // Link up the condition block with the code that follows the loop. 2819 // (the false branch). 2820 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? NULL : LoopSuccessor); 2821 2822 // There can be no more statements in the body block(s) since we loop back to 2823 // the body. NULL out Block to force lazy creation of another block. 2824 Block = NULL; 2825 2826 // Return the loop body, which is the dominating block for the loop. 2827 Succ = BodyBlock; 2828 return BodyBlock; 2829 } 2830 2831 CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) { 2832 // "continue" is a control-flow statement. Thus we stop processing the 2833 // current block. 2834 if (badCFG) 2835 return 0; 2836 2837 // Now create a new block that ends with the continue statement. 2838 Block = createBlock(false); 2839 Block->setTerminator(C); 2840 2841 // If there is no target for the continue, then we are looking at an 2842 // incomplete AST. This means the CFG cannot be constructed. 2843 if (ContinueJumpTarget.block) { 2844 addAutomaticObjDtors(ScopePos, ContinueJumpTarget.scopePosition, C); 2845 addSuccessor(Block, ContinueJumpTarget.block); 2846 } else 2847 badCFG = true; 2848 2849 return Block; 2850 } 2851 2852 CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E, 2853 AddStmtChoice asc) { 2854 2855 if (asc.alwaysAdd(*this, E)) { 2856 autoCreateBlock(); 2857 appendStmt(Block, E); 2858 } 2859 2860 // VLA types have expressions that must be evaluated. 2861 CFGBlock *lastBlock = Block; 2862 2863 if (E->isArgumentType()) { 2864 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr()); 2865 VA != 0; VA = FindVA(VA->getElementType().getTypePtr())) 2866 lastBlock = addStmt(VA->getSizeExpr()); 2867 } 2868 return lastBlock; 2869 } 2870 2871 /// VisitStmtExpr - Utility method to handle (nested) statement 2872 /// expressions (a GCC extension). 2873 CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) { 2874 if (asc.alwaysAdd(*this, SE)) { 2875 autoCreateBlock(); 2876 appendStmt(Block, SE); 2877 } 2878 return VisitCompoundStmt(SE->getSubStmt()); 2879 } 2880 2881 CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) { 2882 // "switch" is a control-flow statement. Thus we stop processing the current 2883 // block. 2884 CFGBlock *SwitchSuccessor = NULL; 2885 2886 // Save local scope position because in case of condition variable ScopePos 2887 // won't be restored when traversing AST. 2888 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 2889 2890 // Create local scope for possible condition variable. 2891 // Store scope position. Add implicit destructor. 2892 if (VarDecl *VD = Terminator->getConditionVariable()) { 2893 LocalScope::const_iterator SwitchBeginScopePos = ScopePos; 2894 addLocalScopeForVarDecl(VD); 2895 addAutomaticObjDtors(ScopePos, SwitchBeginScopePos, Terminator); 2896 } 2897 2898 if (Block) { 2899 if (badCFG) 2900 return 0; 2901 SwitchSuccessor = Block; 2902 } else SwitchSuccessor = Succ; 2903 2904 // Save the current "switch" context. 2905 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock), 2906 save_default(DefaultCaseBlock); 2907 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget); 2908 2909 // Set the "default" case to be the block after the switch statement. If the 2910 // switch statement contains a "default:", this value will be overwritten with 2911 // the block for that code. 2912 DefaultCaseBlock = SwitchSuccessor; 2913 2914 // Create a new block that will contain the switch statement. 2915 SwitchTerminatedBlock = createBlock(false); 2916 2917 // Now process the switch body. The code after the switch is the implicit 2918 // successor. 2919 Succ = SwitchSuccessor; 2920 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos); 2921 2922 // When visiting the body, the case statements should automatically get linked 2923 // up to the switch. We also don't keep a pointer to the body, since all 2924 // control-flow from the switch goes to case/default statements. 2925 assert(Terminator->getBody() && "switch must contain a non-NULL body"); 2926 Block = NULL; 2927 2928 // For pruning unreachable case statements, save the current state 2929 // for tracking the condition value. 2930 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered, 2931 false); 2932 2933 // Determine if the switch condition can be explicitly evaluated. 2934 assert(Terminator->getCond() && "switch condition must be non-NULL"); 2935 Expr::EvalResult result; 2936 bool b = tryEvaluate(Terminator->getCond(), result); 2937 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond, 2938 b ? &result : 0); 2939 2940 // If body is not a compound statement create implicit scope 2941 // and add destructors. 2942 if (!isa<CompoundStmt>(Terminator->getBody())) 2943 addLocalScopeAndDtors(Terminator->getBody()); 2944 2945 addStmt(Terminator->getBody()); 2946 if (Block) { 2947 if (badCFG) 2948 return 0; 2949 } 2950 2951 // If we have no "default:" case, the default transition is to the code 2952 // following the switch body. Moreover, take into account if all the 2953 // cases of a switch are covered (e.g., switching on an enum value). 2954 // 2955 // Note: We add a successor to a switch that is considered covered yet has no 2956 // case statements if the enumeration has no enumerators. 2957 bool SwitchAlwaysHasSuccessor = false; 2958 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered; 2959 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() && 2960 Terminator->getSwitchCaseList(); 2961 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock, 2962 !SwitchAlwaysHasSuccessor); 2963 2964 // Add the terminator and condition in the switch block. 2965 SwitchTerminatedBlock->setTerminator(Terminator); 2966 Block = SwitchTerminatedBlock; 2967 CFGBlock *LastBlock = addStmt(Terminator->getCond()); 2968 2969 // Finally, if the SwitchStmt contains a condition variable, add both the 2970 // SwitchStmt and the condition variable initialization to the CFG. 2971 if (VarDecl *VD = Terminator->getConditionVariable()) { 2972 if (Expr *Init = VD->getInit()) { 2973 autoCreateBlock(); 2974 appendStmt(Block, Terminator->getConditionVariableDeclStmt()); 2975 LastBlock = addStmt(Init); 2976 } 2977 } 2978 2979 return LastBlock; 2980 } 2981 2982 static bool shouldAddCase(bool &switchExclusivelyCovered, 2983 const Expr::EvalResult *switchCond, 2984 const CaseStmt *CS, 2985 ASTContext &Ctx) { 2986 if (!switchCond) 2987 return true; 2988 2989 bool addCase = false; 2990 2991 if (!switchExclusivelyCovered) { 2992 if (switchCond->Val.isInt()) { 2993 // Evaluate the LHS of the case value. 2994 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx); 2995 const llvm::APSInt &condInt = switchCond->Val.getInt(); 2996 2997 if (condInt == lhsInt) { 2998 addCase = true; 2999 switchExclusivelyCovered = true; 3000 } 3001 else if (condInt < lhsInt) { 3002 if (const Expr *RHS = CS->getRHS()) { 3003 // Evaluate the RHS of the case value. 3004 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx); 3005 if (V2 <= condInt) { 3006 addCase = true; 3007 switchExclusivelyCovered = true; 3008 } 3009 } 3010 } 3011 } 3012 else 3013 addCase = true; 3014 } 3015 return addCase; 3016 } 3017 3018 CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) { 3019 // CaseStmts are essentially labels, so they are the first statement in a 3020 // block. 3021 CFGBlock *TopBlock = 0, *LastBlock = 0; 3022 3023 if (Stmt *Sub = CS->getSubStmt()) { 3024 // For deeply nested chains of CaseStmts, instead of doing a recursion 3025 // (which can blow out the stack), manually unroll and create blocks 3026 // along the way. 3027 while (isa<CaseStmt>(Sub)) { 3028 CFGBlock *currentBlock = createBlock(false); 3029 currentBlock->setLabel(CS); 3030 3031 if (TopBlock) 3032 addSuccessor(LastBlock, currentBlock); 3033 else 3034 TopBlock = currentBlock; 3035 3036 addSuccessor(SwitchTerminatedBlock, 3037 shouldAddCase(switchExclusivelyCovered, switchCond, 3038 CS, *Context) 3039 ? currentBlock : 0); 3040 3041 LastBlock = currentBlock; 3042 CS = cast<CaseStmt>(Sub); 3043 Sub = CS->getSubStmt(); 3044 } 3045 3046 addStmt(Sub); 3047 } 3048 3049 CFGBlock *CaseBlock = Block; 3050 if (!CaseBlock) 3051 CaseBlock = createBlock(); 3052 3053 // Cases statements partition blocks, so this is the top of the basic block we 3054 // were processing (the "case XXX:" is the label). 3055 CaseBlock->setLabel(CS); 3056 3057 if (badCFG) 3058 return 0; 3059 3060 // Add this block to the list of successors for the block with the switch 3061 // statement. 3062 assert(SwitchTerminatedBlock); 3063 addSuccessor(SwitchTerminatedBlock, CaseBlock, 3064 shouldAddCase(switchExclusivelyCovered, switchCond, 3065 CS, *Context)); 3066 3067 // We set Block to NULL to allow lazy creation of a new block (if necessary) 3068 Block = NULL; 3069 3070 if (TopBlock) { 3071 addSuccessor(LastBlock, CaseBlock); 3072 Succ = TopBlock; 3073 } else { 3074 // This block is now the implicit successor of other blocks. 3075 Succ = CaseBlock; 3076 } 3077 3078 return Succ; 3079 } 3080 3081 CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) { 3082 if (Terminator->getSubStmt()) 3083 addStmt(Terminator->getSubStmt()); 3084 3085 DefaultCaseBlock = Block; 3086 3087 if (!DefaultCaseBlock) 3088 DefaultCaseBlock = createBlock(); 3089 3090 // Default statements partition blocks, so this is the top of the basic block 3091 // we were processing (the "default:" is the label). 3092 DefaultCaseBlock->setLabel(Terminator); 3093 3094 if (badCFG) 3095 return 0; 3096 3097 // Unlike case statements, we don't add the default block to the successors 3098 // for the switch statement immediately. This is done when we finish 3099 // processing the switch statement. This allows for the default case 3100 // (including a fall-through to the code after the switch statement) to always 3101 // be the last successor of a switch-terminated block. 3102 3103 // We set Block to NULL to allow lazy creation of a new block (if necessary) 3104 Block = NULL; 3105 3106 // This block is now the implicit successor of other blocks. 3107 Succ = DefaultCaseBlock; 3108 3109 return DefaultCaseBlock; 3110 } 3111 3112 CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) { 3113 // "try"/"catch" is a control-flow statement. Thus we stop processing the 3114 // current block. 3115 CFGBlock *TrySuccessor = NULL; 3116 3117 if (Block) { 3118 if (badCFG) 3119 return 0; 3120 TrySuccessor = Block; 3121 } else TrySuccessor = Succ; 3122 3123 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock; 3124 3125 // Create a new block that will contain the try statement. 3126 CFGBlock *NewTryTerminatedBlock = createBlock(false); 3127 // Add the terminator in the try block. 3128 NewTryTerminatedBlock->setTerminator(Terminator); 3129 3130 bool HasCatchAll = false; 3131 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) { 3132 // The code after the try is the implicit successor. 3133 Succ = TrySuccessor; 3134 CXXCatchStmt *CS = Terminator->getHandler(h); 3135 if (CS->getExceptionDecl() == 0) { 3136 HasCatchAll = true; 3137 } 3138 Block = NULL; 3139 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS); 3140 if (CatchBlock == 0) 3141 return 0; 3142 // Add this block to the list of successors for the block with the try 3143 // statement. 3144 addSuccessor(NewTryTerminatedBlock, CatchBlock); 3145 } 3146 if (!HasCatchAll) { 3147 if (PrevTryTerminatedBlock) 3148 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock); 3149 else 3150 addSuccessor(NewTryTerminatedBlock, &cfg->getExit()); 3151 } 3152 3153 // The code after the try is the implicit successor. 3154 Succ = TrySuccessor; 3155 3156 // Save the current "try" context. 3157 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock); 3158 cfg->addTryDispatchBlock(TryTerminatedBlock); 3159 3160 assert(Terminator->getTryBlock() && "try must contain a non-NULL body"); 3161 Block = NULL; 3162 return addStmt(Terminator->getTryBlock()); 3163 } 3164 3165 CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) { 3166 // CXXCatchStmt are treated like labels, so they are the first statement in a 3167 // block. 3168 3169 // Save local scope position because in case of exception variable ScopePos 3170 // won't be restored when traversing AST. 3171 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 3172 3173 // Create local scope for possible exception variable. 3174 // Store scope position. Add implicit destructor. 3175 if (VarDecl *VD = CS->getExceptionDecl()) { 3176 LocalScope::const_iterator BeginScopePos = ScopePos; 3177 addLocalScopeForVarDecl(VD); 3178 addAutomaticObjDtors(ScopePos, BeginScopePos, CS); 3179 } 3180 3181 if (CS->getHandlerBlock()) 3182 addStmt(CS->getHandlerBlock()); 3183 3184 CFGBlock *CatchBlock = Block; 3185 if (!CatchBlock) 3186 CatchBlock = createBlock(); 3187 3188 // CXXCatchStmt is more than just a label. They have semantic meaning 3189 // as well, as they implicitly "initialize" the catch variable. Add 3190 // it to the CFG as a CFGElement so that the control-flow of these 3191 // semantics gets captured. 3192 appendStmt(CatchBlock, CS); 3193 3194 // Also add the CXXCatchStmt as a label, to mirror handling of regular 3195 // labels. 3196 CatchBlock->setLabel(CS); 3197 3198 // Bail out if the CFG is bad. 3199 if (badCFG) 3200 return 0; 3201 3202 // We set Block to NULL to allow lazy creation of a new block (if necessary) 3203 Block = NULL; 3204 3205 return CatchBlock; 3206 } 3207 3208 CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) { 3209 // C++0x for-range statements are specified as [stmt.ranged]: 3210 // 3211 // { 3212 // auto && __range = range-init; 3213 // for ( auto __begin = begin-expr, 3214 // __end = end-expr; 3215 // __begin != __end; 3216 // ++__begin ) { 3217 // for-range-declaration = *__begin; 3218 // statement 3219 // } 3220 // } 3221 3222 // Save local scope position before the addition of the implicit variables. 3223 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 3224 3225 // Create local scopes and destructors for range, begin and end variables. 3226 if (Stmt *Range = S->getRangeStmt()) 3227 addLocalScopeForStmt(Range); 3228 if (Stmt *BeginEnd = S->getBeginEndStmt()) 3229 addLocalScopeForStmt(BeginEnd); 3230 addAutomaticObjDtors(ScopePos, save_scope_pos.get(), S); 3231 3232 LocalScope::const_iterator ContinueScopePos = ScopePos; 3233 3234 // "for" is a control-flow statement. Thus we stop processing the current 3235 // block. 3236 CFGBlock *LoopSuccessor = NULL; 3237 if (Block) { 3238 if (badCFG) 3239 return 0; 3240 LoopSuccessor = Block; 3241 } else 3242 LoopSuccessor = Succ; 3243 3244 // Save the current value for the break targets. 3245 // All breaks should go to the code following the loop. 3246 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget); 3247 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos); 3248 3249 // The block for the __begin != __end expression. 3250 CFGBlock *ConditionBlock = createBlock(false); 3251 ConditionBlock->setTerminator(S); 3252 3253 // Now add the actual condition to the condition block. 3254 if (Expr *C = S->getCond()) { 3255 Block = ConditionBlock; 3256 CFGBlock *BeginConditionBlock = addStmt(C); 3257 if (badCFG) 3258 return 0; 3259 assert(BeginConditionBlock == ConditionBlock && 3260 "condition block in for-range was unexpectedly complex"); 3261 (void)BeginConditionBlock; 3262 } 3263 3264 // The condition block is the implicit successor for the loop body as well as 3265 // any code above the loop. 3266 Succ = ConditionBlock; 3267 3268 // See if this is a known constant. 3269 TryResult KnownVal(true); 3270 3271 if (S->getCond()) 3272 KnownVal = tryEvaluateBool(S->getCond()); 3273 3274 // Now create the loop body. 3275 { 3276 assert(S->getBody()); 3277 3278 // Save the current values for Block, Succ, and continue targets. 3279 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ); 3280 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget); 3281 3282 // Generate increment code in its own basic block. This is the target of 3283 // continue statements. 3284 Block = 0; 3285 Succ = addStmt(S->getInc()); 3286 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos); 3287 3288 // The starting block for the loop increment is the block that should 3289 // represent the 'loop target' for looping back to the start of the loop. 3290 ContinueJumpTarget.block->setLoopTarget(S); 3291 3292 // Finish up the increment block and prepare to start the loop body. 3293 assert(Block); 3294 if (badCFG) 3295 return 0; 3296 Block = 0; 3297 3298 3299 // Add implicit scope and dtors for loop variable. 3300 addLocalScopeAndDtors(S->getLoopVarStmt()); 3301 3302 // Populate a new block to contain the loop body and loop variable. 3303 addStmt(S->getBody()); 3304 if (badCFG) 3305 return 0; 3306 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt()); 3307 if (badCFG) 3308 return 0; 3309 3310 // This new body block is a successor to our condition block. 3311 addSuccessor(ConditionBlock, KnownVal.isFalse() ? 0 : LoopVarStmtBlock); 3312 } 3313 3314 // Link up the condition block with the code that follows the loop (the 3315 // false branch). 3316 addSuccessor(ConditionBlock, KnownVal.isTrue() ? 0 : LoopSuccessor); 3317 3318 // Add the initialization statements. 3319 Block = createBlock(); 3320 addStmt(S->getBeginEndStmt()); 3321 return addStmt(S->getRangeStmt()); 3322 } 3323 3324 CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E, 3325 AddStmtChoice asc) { 3326 if (BuildOpts.AddTemporaryDtors) { 3327 // If adding implicit destructors visit the full expression for adding 3328 // destructors of temporaries. 3329 VisitForTemporaryDtors(E->getSubExpr()); 3330 3331 // Full expression has to be added as CFGStmt so it will be sequenced 3332 // before destructors of it's temporaries. 3333 asc = asc.withAlwaysAdd(true); 3334 } 3335 return Visit(E->getSubExpr(), asc); 3336 } 3337 3338 CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E, 3339 AddStmtChoice asc) { 3340 if (asc.alwaysAdd(*this, E)) { 3341 autoCreateBlock(); 3342 appendStmt(Block, E); 3343 3344 // We do not want to propagate the AlwaysAdd property. 3345 asc = asc.withAlwaysAdd(false); 3346 } 3347 return Visit(E->getSubExpr(), asc); 3348 } 3349 3350 CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C, 3351 AddStmtChoice asc) { 3352 autoCreateBlock(); 3353 appendStmt(Block, C); 3354 3355 return VisitChildren(C); 3356 } 3357 3358 CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE, 3359 AddStmtChoice asc) { 3360 3361 autoCreateBlock(); 3362 appendStmt(Block, NE); 3363 3364 if (NE->getInitializer()) 3365 Block = Visit(NE->getInitializer()); 3366 if (BuildOpts.AddCXXNewAllocator) 3367 appendNewAllocator(Block, NE); 3368 if (NE->isArray()) 3369 Block = Visit(NE->getArraySize()); 3370 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(), 3371 E = NE->placement_arg_end(); I != E; ++I) 3372 Block = Visit(*I); 3373 return Block; 3374 } 3375 3376 CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE, 3377 AddStmtChoice asc) { 3378 autoCreateBlock(); 3379 appendStmt(Block, DE); 3380 QualType DTy = DE->getDestroyedType(); 3381 DTy = DTy.getNonReferenceType(); 3382 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl(); 3383 if (RD) { 3384 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor()) 3385 appendDeleteDtor(Block, RD, DE); 3386 } 3387 3388 return VisitChildren(DE); 3389 } 3390 3391 CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E, 3392 AddStmtChoice asc) { 3393 if (asc.alwaysAdd(*this, E)) { 3394 autoCreateBlock(); 3395 appendStmt(Block, E); 3396 // We do not want to propagate the AlwaysAdd property. 3397 asc = asc.withAlwaysAdd(false); 3398 } 3399 return Visit(E->getSubExpr(), asc); 3400 } 3401 3402 CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C, 3403 AddStmtChoice asc) { 3404 autoCreateBlock(); 3405 appendStmt(Block, C); 3406 return VisitChildren(C); 3407 } 3408 3409 CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E, 3410 AddStmtChoice asc) { 3411 if (asc.alwaysAdd(*this, E)) { 3412 autoCreateBlock(); 3413 appendStmt(Block, E); 3414 } 3415 return Visit(E->getSubExpr(), AddStmtChoice()); 3416 } 3417 3418 CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) { 3419 // Lazily create the indirect-goto dispatch block if there isn't one already. 3420 CFGBlock *IBlock = cfg->getIndirectGotoBlock(); 3421 3422 if (!IBlock) { 3423 IBlock = createBlock(false); 3424 cfg->setIndirectGotoBlock(IBlock); 3425 } 3426 3427 // IndirectGoto is a control-flow statement. Thus we stop processing the 3428 // current block and create a new one. 3429 if (badCFG) 3430 return 0; 3431 3432 Block = createBlock(false); 3433 Block->setTerminator(I); 3434 addSuccessor(Block, IBlock); 3435 return addStmt(I->getTarget()); 3436 } 3437 3438 CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary) { 3439 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors); 3440 3441 tryAgain: 3442 if (!E) { 3443 badCFG = true; 3444 return NULL; 3445 } 3446 switch (E->getStmtClass()) { 3447 default: 3448 return VisitChildrenForTemporaryDtors(E); 3449 3450 case Stmt::BinaryOperatorClass: 3451 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E)); 3452 3453 case Stmt::CXXBindTemporaryExprClass: 3454 return VisitCXXBindTemporaryExprForTemporaryDtors( 3455 cast<CXXBindTemporaryExpr>(E), BindToTemporary); 3456 3457 case Stmt::BinaryConditionalOperatorClass: 3458 case Stmt::ConditionalOperatorClass: 3459 return VisitConditionalOperatorForTemporaryDtors( 3460 cast<AbstractConditionalOperator>(E), BindToTemporary); 3461 3462 case Stmt::ImplicitCastExprClass: 3463 // For implicit cast we want BindToTemporary to be passed further. 3464 E = cast<CastExpr>(E)->getSubExpr(); 3465 goto tryAgain; 3466 3467 case Stmt::ParenExprClass: 3468 E = cast<ParenExpr>(E)->getSubExpr(); 3469 goto tryAgain; 3470 3471 case Stmt::MaterializeTemporaryExprClass: 3472 E = cast<MaterializeTemporaryExpr>(E)->GetTemporaryExpr(); 3473 goto tryAgain; 3474 } 3475 } 3476 3477 CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E) { 3478 // When visiting children for destructors we want to visit them in reverse 3479 // order that they will appear in the CFG. Because the CFG is built 3480 // bottom-up, this means we visit them in their natural order, which 3481 // reverses them in the CFG. 3482 CFGBlock *B = Block; 3483 for (Stmt::child_range I = E->children(); I; ++I) { 3484 if (Stmt *Child = *I) 3485 if (CFGBlock *R = VisitForTemporaryDtors(Child)) 3486 B = R; 3487 } 3488 return B; 3489 } 3490 3491 CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E) { 3492 if (E->isLogicalOp()) { 3493 // Destructors for temporaries in LHS expression should be called after 3494 // those for RHS expression. Even if this will unnecessarily create a block, 3495 // this block will be used at least by the full expression. 3496 autoCreateBlock(); 3497 CFGBlock *ConfluenceBlock = VisitForTemporaryDtors(E->getLHS()); 3498 if (badCFG) 3499 return NULL; 3500 3501 Succ = ConfluenceBlock; 3502 Block = NULL; 3503 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS()); 3504 3505 if (RHSBlock) { 3506 if (badCFG) 3507 return NULL; 3508 3509 // If RHS expression did produce destructors we need to connect created 3510 // blocks to CFG in same manner as for binary operator itself. 3511 CFGBlock *LHSBlock = createBlock(false); 3512 LHSBlock->setTerminator(CFGTerminator(E, true)); 3513 3514 // For binary operator LHS block is before RHS in list of predecessors 3515 // of ConfluenceBlock. 3516 std::reverse(ConfluenceBlock->pred_begin(), 3517 ConfluenceBlock->pred_end()); 3518 3519 // See if this is a known constant. 3520 TryResult KnownVal = tryEvaluateBool(E->getLHS()); 3521 if (KnownVal.isKnown() && (E->getOpcode() == BO_LOr)) 3522 KnownVal.negate(); 3523 3524 // Link LHSBlock with RHSBlock exactly the same way as for binary operator 3525 // itself. 3526 if (E->getOpcode() == BO_LOr) { 3527 addSuccessor(LHSBlock, KnownVal.isTrue() ? NULL : ConfluenceBlock); 3528 addSuccessor(LHSBlock, KnownVal.isFalse() ? NULL : RHSBlock); 3529 } else { 3530 assert (E->getOpcode() == BO_LAnd); 3531 addSuccessor(LHSBlock, KnownVal.isFalse() ? NULL : RHSBlock); 3532 addSuccessor(LHSBlock, KnownVal.isTrue() ? NULL : ConfluenceBlock); 3533 } 3534 3535 Block = LHSBlock; 3536 return LHSBlock; 3537 } 3538 3539 Block = ConfluenceBlock; 3540 return ConfluenceBlock; 3541 } 3542 3543 if (E->isAssignmentOp()) { 3544 // For assignment operator (=) LHS expression is visited 3545 // before RHS expression. For destructors visit them in reverse order. 3546 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS()); 3547 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS()); 3548 return LHSBlock ? LHSBlock : RHSBlock; 3549 } 3550 3551 // For any other binary operator RHS expression is visited before 3552 // LHS expression (order of children). For destructors visit them in reverse 3553 // order. 3554 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS()); 3555 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS()); 3556 return RHSBlock ? RHSBlock : LHSBlock; 3557 } 3558 3559 CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors( 3560 CXXBindTemporaryExpr *E, bool BindToTemporary) { 3561 // First add destructors for temporaries in subexpression. 3562 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr()); 3563 if (!BindToTemporary) { 3564 // If lifetime of temporary is not prolonged (by assigning to constant 3565 // reference) add destructor for it. 3566 3567 // If the destructor is marked as a no-return destructor, we need to create 3568 // a new block for the destructor which does not have as a successor 3569 // anything built thus far. Control won't flow out of this block. 3570 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor(); 3571 if (Dtor->isNoReturn()) { 3572 Succ = B; 3573 Block = createNoReturnBlock(); 3574 } else { 3575 autoCreateBlock(); 3576 } 3577 3578 appendTemporaryDtor(Block, E); 3579 B = Block; 3580 } 3581 return B; 3582 } 3583 3584 CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors( 3585 AbstractConditionalOperator *E, bool BindToTemporary) { 3586 // First add destructors for condition expression. Even if this will 3587 // unnecessarily create a block, this block will be used at least by the full 3588 // expression. 3589 autoCreateBlock(); 3590 CFGBlock *ConfluenceBlock = VisitForTemporaryDtors(E->getCond()); 3591 if (badCFG) 3592 return NULL; 3593 if (BinaryConditionalOperator *BCO 3594 = dyn_cast<BinaryConditionalOperator>(E)) { 3595 ConfluenceBlock = VisitForTemporaryDtors(BCO->getCommon()); 3596 if (badCFG) 3597 return NULL; 3598 } 3599 3600 // Try to add block with destructors for LHS expression. 3601 CFGBlock *LHSBlock = NULL; 3602 Succ = ConfluenceBlock; 3603 Block = NULL; 3604 LHSBlock = VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary); 3605 if (badCFG) 3606 return NULL; 3607 3608 // Try to add block with destructors for RHS expression; 3609 Succ = ConfluenceBlock; 3610 Block = NULL; 3611 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getFalseExpr(), 3612 BindToTemporary); 3613 if (badCFG) 3614 return NULL; 3615 3616 if (!RHSBlock && !LHSBlock) { 3617 // If neither LHS nor RHS expression had temporaries to destroy don't create 3618 // more blocks. 3619 Block = ConfluenceBlock; 3620 return Block; 3621 } 3622 3623 Block = createBlock(false); 3624 Block->setTerminator(CFGTerminator(E, true)); 3625 assert(Block->getTerminator().isTemporaryDtorsBranch()); 3626 3627 // See if this is a known constant. 3628 const TryResult &KnownVal = tryEvaluateBool(E->getCond()); 3629 3630 if (LHSBlock) { 3631 addSuccessor(Block, LHSBlock, !KnownVal.isFalse()); 3632 } else if (KnownVal.isFalse()) { 3633 addSuccessor(Block, NULL); 3634 } else { 3635 addSuccessor(Block, ConfluenceBlock); 3636 std::reverse(ConfluenceBlock->pred_begin(), ConfluenceBlock->pred_end()); 3637 } 3638 3639 if (!RHSBlock) 3640 RHSBlock = ConfluenceBlock; 3641 3642 addSuccessor(Block, RHSBlock, !KnownVal.isTrue()); 3643 3644 return Block; 3645 } 3646 3647 } // end anonymous namespace 3648 3649 /// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has 3650 /// no successors or predecessors. If this is the first block created in the 3651 /// CFG, it is automatically set to be the Entry and Exit of the CFG. 3652 CFGBlock *CFG::createBlock() { 3653 bool first_block = begin() == end(); 3654 3655 // Create the block. 3656 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>(); 3657 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this); 3658 Blocks.push_back(Mem, BlkBVC); 3659 3660 // If this is the first block, set it as the Entry and Exit. 3661 if (first_block) 3662 Entry = Exit = &back(); 3663 3664 // Return the block. 3665 return &back(); 3666 } 3667 3668 /// buildCFG - Constructs a CFG from an AST. Ownership of the returned 3669 /// CFG is returned to the caller. 3670 CFG* CFG::buildCFG(const Decl *D, Stmt *Statement, ASTContext *C, 3671 const BuildOptions &BO) { 3672 CFGBuilder Builder(C, BO); 3673 return Builder.buildCFG(D, Statement); 3674 } 3675 3676 const CXXDestructorDecl * 3677 CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const { 3678 switch (getKind()) { 3679 case CFGElement::Statement: 3680 case CFGElement::Initializer: 3681 case CFGElement::NewAllocator: 3682 llvm_unreachable("getDestructorDecl should only be used with " 3683 "ImplicitDtors"); 3684 case CFGElement::AutomaticObjectDtor: { 3685 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl(); 3686 QualType ty = var->getType(); 3687 ty = ty.getNonReferenceType(); 3688 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) { 3689 ty = arrayType->getElementType(); 3690 } 3691 const RecordType *recordType = ty->getAs<RecordType>(); 3692 const CXXRecordDecl *classDecl = 3693 cast<CXXRecordDecl>(recordType->getDecl()); 3694 return classDecl->getDestructor(); 3695 } 3696 case CFGElement::DeleteDtor: { 3697 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr(); 3698 QualType DTy = DE->getDestroyedType(); 3699 DTy = DTy.getNonReferenceType(); 3700 const CXXRecordDecl *classDecl = 3701 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl(); 3702 return classDecl->getDestructor(); 3703 } 3704 case CFGElement::TemporaryDtor: { 3705 const CXXBindTemporaryExpr *bindExpr = 3706 castAs<CFGTemporaryDtor>().getBindTemporaryExpr(); 3707 const CXXTemporary *temp = bindExpr->getTemporary(); 3708 return temp->getDestructor(); 3709 } 3710 case CFGElement::BaseDtor: 3711 case CFGElement::MemberDtor: 3712 3713 // Not yet supported. 3714 return 0; 3715 } 3716 llvm_unreachable("getKind() returned bogus value"); 3717 } 3718 3719 bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const { 3720 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext)) 3721 return DD->isNoReturn(); 3722 return false; 3723 } 3724 3725 //===----------------------------------------------------------------------===// 3726 // CFGBlock operations. 3727 //===----------------------------------------------------------------------===// 3728 3729 CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable) 3730 : ReachableBlock(IsReachable ? B : 0), 3731 UnreachableBlock(!IsReachable ? B : 0, 3732 B && IsReachable ? AB_Normal : AB_Unreachable) {} 3733 3734 CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock) 3735 : ReachableBlock(B), 3736 UnreachableBlock(B == AlternateBlock ? 0 : AlternateBlock, 3737 B == AlternateBlock ? AB_Alternate : AB_Normal) {} 3738 3739 void CFGBlock::addSuccessor(AdjacentBlock Succ, 3740 BumpVectorContext &C) { 3741 if (CFGBlock *B = Succ.getReachableBlock()) 3742 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C); 3743 3744 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock()) 3745 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C); 3746 3747 Succs.push_back(Succ, C); 3748 } 3749 3750 bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F, 3751 const CFGBlock *From, const CFGBlock *To) { 3752 3753 if (F.IgnoreNullPredecessors && !From) 3754 return true; 3755 3756 if (To && From && F.IgnoreDefaultsWithCoveredEnums) { 3757 // If the 'To' has no label or is labeled but the label isn't a 3758 // CaseStmt then filter this edge. 3759 if (const SwitchStmt *S = 3760 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) { 3761 if (S->isAllEnumCasesCovered()) { 3762 const Stmt *L = To->getLabel(); 3763 if (!L || !isa<CaseStmt>(L)) 3764 return true; 3765 } 3766 } 3767 } 3768 3769 return false; 3770 } 3771 3772 //===----------------------------------------------------------------------===// 3773 // CFG pretty printing 3774 //===----------------------------------------------------------------------===// 3775 3776 namespace { 3777 3778 class StmtPrinterHelper : public PrinterHelper { 3779 typedef llvm::DenseMap<const Stmt*,std::pair<unsigned,unsigned> > StmtMapTy; 3780 typedef llvm::DenseMap<const Decl*,std::pair<unsigned,unsigned> > DeclMapTy; 3781 StmtMapTy StmtMap; 3782 DeclMapTy DeclMap; 3783 signed currentBlock; 3784 unsigned currStmt; 3785 const LangOptions &LangOpts; 3786 public: 3787 3788 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO) 3789 : currentBlock(0), currStmt(0), LangOpts(LO) 3790 { 3791 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) { 3792 unsigned j = 1; 3793 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ; 3794 BI != BEnd; ++BI, ++j ) { 3795 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) { 3796 const Stmt *stmt= SE->getStmt(); 3797 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j); 3798 StmtMap[stmt] = P; 3799 3800 switch (stmt->getStmtClass()) { 3801 case Stmt::DeclStmtClass: 3802 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P; 3803 break; 3804 case Stmt::IfStmtClass: { 3805 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable(); 3806 if (var) 3807 DeclMap[var] = P; 3808 break; 3809 } 3810 case Stmt::ForStmtClass: { 3811 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable(); 3812 if (var) 3813 DeclMap[var] = P; 3814 break; 3815 } 3816 case Stmt::WhileStmtClass: { 3817 const VarDecl *var = 3818 cast<WhileStmt>(stmt)->getConditionVariable(); 3819 if (var) 3820 DeclMap[var] = P; 3821 break; 3822 } 3823 case Stmt::SwitchStmtClass: { 3824 const VarDecl *var = 3825 cast<SwitchStmt>(stmt)->getConditionVariable(); 3826 if (var) 3827 DeclMap[var] = P; 3828 break; 3829 } 3830 case Stmt::CXXCatchStmtClass: { 3831 const VarDecl *var = 3832 cast<CXXCatchStmt>(stmt)->getExceptionDecl(); 3833 if (var) 3834 DeclMap[var] = P; 3835 break; 3836 } 3837 default: 3838 break; 3839 } 3840 } 3841 } 3842 } 3843 } 3844 3845 3846 virtual ~StmtPrinterHelper() {} 3847 3848 const LangOptions &getLangOpts() const { return LangOpts; } 3849 void setBlockID(signed i) { currentBlock = i; } 3850 void setStmtID(unsigned i) { currStmt = i; } 3851 3852 bool handledStmt(Stmt *S, raw_ostream &OS) override { 3853 StmtMapTy::iterator I = StmtMap.find(S); 3854 3855 if (I == StmtMap.end()) 3856 return false; 3857 3858 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock 3859 && I->second.second == currStmt) { 3860 return false; 3861 } 3862 3863 OS << "[B" << I->second.first << "." << I->second.second << "]"; 3864 return true; 3865 } 3866 3867 bool handleDecl(const Decl *D, raw_ostream &OS) { 3868 DeclMapTy::iterator I = DeclMap.find(D); 3869 3870 if (I == DeclMap.end()) 3871 return false; 3872 3873 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock 3874 && I->second.second == currStmt) { 3875 return false; 3876 } 3877 3878 OS << "[B" << I->second.first << "." << I->second.second << "]"; 3879 return true; 3880 } 3881 }; 3882 } // end anonymous namespace 3883 3884 3885 namespace { 3886 class CFGBlockTerminatorPrint 3887 : public StmtVisitor<CFGBlockTerminatorPrint,void> { 3888 3889 raw_ostream &OS; 3890 StmtPrinterHelper* Helper; 3891 PrintingPolicy Policy; 3892 public: 3893 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper, 3894 const PrintingPolicy &Policy) 3895 : OS(os), Helper(helper), Policy(Policy) { 3896 this->Policy.IncludeNewlines = false; 3897 } 3898 3899 void VisitIfStmt(IfStmt *I) { 3900 OS << "if "; 3901 I->getCond()->printPretty(OS,Helper,Policy); 3902 } 3903 3904 // Default case. 3905 void VisitStmt(Stmt *Terminator) { 3906 Terminator->printPretty(OS, Helper, Policy); 3907 } 3908 3909 void VisitDeclStmt(DeclStmt *DS) { 3910 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl()); 3911 OS << "static init " << VD->getName(); 3912 } 3913 3914 void VisitForStmt(ForStmt *F) { 3915 OS << "for (" ; 3916 if (F->getInit()) 3917 OS << "..."; 3918 OS << "; "; 3919 if (Stmt *C = F->getCond()) 3920 C->printPretty(OS, Helper, Policy); 3921 OS << "; "; 3922 if (F->getInc()) 3923 OS << "..."; 3924 OS << ")"; 3925 } 3926 3927 void VisitWhileStmt(WhileStmt *W) { 3928 OS << "while " ; 3929 if (Stmt *C = W->getCond()) 3930 C->printPretty(OS, Helper, Policy); 3931 } 3932 3933 void VisitDoStmt(DoStmt *D) { 3934 OS << "do ... while "; 3935 if (Stmt *C = D->getCond()) 3936 C->printPretty(OS, Helper, Policy); 3937 } 3938 3939 void VisitSwitchStmt(SwitchStmt *Terminator) { 3940 OS << "switch "; 3941 Terminator->getCond()->printPretty(OS, Helper, Policy); 3942 } 3943 3944 void VisitCXXTryStmt(CXXTryStmt *CS) { 3945 OS << "try ..."; 3946 } 3947 3948 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) { 3949 C->getCond()->printPretty(OS, Helper, Policy); 3950 OS << " ? ... : ..."; 3951 } 3952 3953 void VisitChooseExpr(ChooseExpr *C) { 3954 OS << "__builtin_choose_expr( "; 3955 C->getCond()->printPretty(OS, Helper, Policy); 3956 OS << " )"; 3957 } 3958 3959 void VisitIndirectGotoStmt(IndirectGotoStmt *I) { 3960 OS << "goto *"; 3961 I->getTarget()->printPretty(OS, Helper, Policy); 3962 } 3963 3964 void VisitBinaryOperator(BinaryOperator* B) { 3965 if (!B->isLogicalOp()) { 3966 VisitExpr(B); 3967 return; 3968 } 3969 3970 B->getLHS()->printPretty(OS, Helper, Policy); 3971 3972 switch (B->getOpcode()) { 3973 case BO_LOr: 3974 OS << " || ..."; 3975 return; 3976 case BO_LAnd: 3977 OS << " && ..."; 3978 return; 3979 default: 3980 llvm_unreachable("Invalid logical operator."); 3981 } 3982 } 3983 3984 void VisitExpr(Expr *E) { 3985 E->printPretty(OS, Helper, Policy); 3986 } 3987 3988 public: 3989 void print(CFGTerminator T) { 3990 if (T.isTemporaryDtorsBranch()) 3991 OS << "(Temp Dtor) "; 3992 Visit(T.getStmt()); 3993 } 3994 }; 3995 } // end anonymous namespace 3996 3997 static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper, 3998 const CFGElement &E) { 3999 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) { 4000 const Stmt *S = CS->getStmt(); 4001 4002 // special printing for statement-expressions. 4003 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) { 4004 const CompoundStmt *Sub = SE->getSubStmt(); 4005 4006 if (Sub->children()) { 4007 OS << "({ ... ; "; 4008 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS); 4009 OS << " })\n"; 4010 return; 4011 } 4012 } 4013 // special printing for comma expressions. 4014 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) { 4015 if (B->getOpcode() == BO_Comma) { 4016 OS << "... , "; 4017 Helper.handledStmt(B->getRHS(),OS); 4018 OS << '\n'; 4019 return; 4020 } 4021 } 4022 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts())); 4023 4024 if (isa<CXXOperatorCallExpr>(S)) { 4025 OS << " (OperatorCall)"; 4026 } 4027 else if (isa<CXXBindTemporaryExpr>(S)) { 4028 OS << " (BindTemporary)"; 4029 } 4030 else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) { 4031 OS << " (CXXConstructExpr, " << CCE->getType().getAsString() << ")"; 4032 } 4033 else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) { 4034 OS << " (" << CE->getStmtClassName() << ", " 4035 << CE->getCastKindName() 4036 << ", " << CE->getType().getAsString() 4037 << ")"; 4038 } 4039 4040 // Expressions need a newline. 4041 if (isa<Expr>(S)) 4042 OS << '\n'; 4043 4044 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) { 4045 const CXXCtorInitializer *I = IE->getInitializer(); 4046 if (I->isBaseInitializer()) 4047 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName(); 4048 else if (I->isDelegatingInitializer()) 4049 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName(); 4050 else OS << I->getAnyMember()->getName(); 4051 4052 OS << "("; 4053 if (Expr *IE = I->getInit()) 4054 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts())); 4055 OS << ")"; 4056 4057 if (I->isBaseInitializer()) 4058 OS << " (Base initializer)\n"; 4059 else if (I->isDelegatingInitializer()) 4060 OS << " (Delegating initializer)\n"; 4061 else OS << " (Member initializer)\n"; 4062 4063 } else if (Optional<CFGAutomaticObjDtor> DE = 4064 E.getAs<CFGAutomaticObjDtor>()) { 4065 const VarDecl *VD = DE->getVarDecl(); 4066 Helper.handleDecl(VD, OS); 4067 4068 const Type* T = VD->getType().getTypePtr(); 4069 if (const ReferenceType* RT = T->getAs<ReferenceType>()) 4070 T = RT->getPointeeType().getTypePtr(); 4071 T = T->getBaseElementTypeUnsafe(); 4072 4073 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()"; 4074 OS << " (Implicit destructor)\n"; 4075 4076 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) { 4077 OS << "CFGNewAllocator("; 4078 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr()) 4079 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts())); 4080 OS << ")\n"; 4081 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) { 4082 const CXXRecordDecl *RD = DE->getCXXRecordDecl(); 4083 if (!RD) 4084 return; 4085 CXXDeleteExpr *DelExpr = 4086 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr()); 4087 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS); 4088 OS << "->~" << RD->getName().str() << "()"; 4089 OS << " (Implicit destructor)\n"; 4090 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) { 4091 const CXXBaseSpecifier *BS = BE->getBaseSpecifier(); 4092 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()"; 4093 OS << " (Base object destructor)\n"; 4094 4095 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) { 4096 const FieldDecl *FD = ME->getFieldDecl(); 4097 const Type *T = FD->getType()->getBaseElementTypeUnsafe(); 4098 OS << "this->" << FD->getName(); 4099 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()"; 4100 OS << " (Member object destructor)\n"; 4101 4102 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) { 4103 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr(); 4104 OS << "~"; 4105 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts())); 4106 OS << "() (Temporary object destructor)\n"; 4107 } 4108 } 4109 4110 static void print_block(raw_ostream &OS, const CFG* cfg, 4111 const CFGBlock &B, 4112 StmtPrinterHelper &Helper, bool print_edges, 4113 bool ShowColors) { 4114 4115 Helper.setBlockID(B.getBlockID()); 4116 4117 // Print the header. 4118 if (ShowColors) 4119 OS.changeColor(raw_ostream::YELLOW, true); 4120 4121 OS << "\n [B" << B.getBlockID(); 4122 4123 if (&B == &cfg->getEntry()) 4124 OS << " (ENTRY)]\n"; 4125 else if (&B == &cfg->getExit()) 4126 OS << " (EXIT)]\n"; 4127 else if (&B == cfg->getIndirectGotoBlock()) 4128 OS << " (INDIRECT GOTO DISPATCH)]\n"; 4129 else if (B.hasNoReturnElement()) 4130 OS << " (NORETURN)]\n"; 4131 else 4132 OS << "]\n"; 4133 4134 if (ShowColors) 4135 OS.resetColor(); 4136 4137 // Print the label of this block. 4138 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) { 4139 4140 if (print_edges) 4141 OS << " "; 4142 4143 if (LabelStmt *L = dyn_cast<LabelStmt>(Label)) 4144 OS << L->getName(); 4145 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) { 4146 OS << "case "; 4147 C->getLHS()->printPretty(OS, &Helper, 4148 PrintingPolicy(Helper.getLangOpts())); 4149 if (C->getRHS()) { 4150 OS << " ... "; 4151 C->getRHS()->printPretty(OS, &Helper, 4152 PrintingPolicy(Helper.getLangOpts())); 4153 } 4154 } else if (isa<DefaultStmt>(Label)) 4155 OS << "default"; 4156 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) { 4157 OS << "catch ("; 4158 if (CS->getExceptionDecl()) 4159 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()), 4160 0); 4161 else 4162 OS << "..."; 4163 OS << ")"; 4164 4165 } else 4166 llvm_unreachable("Invalid label statement in CFGBlock."); 4167 4168 OS << ":\n"; 4169 } 4170 4171 // Iterate through the statements in the block and print them. 4172 unsigned j = 1; 4173 4174 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ; 4175 I != E ; ++I, ++j ) { 4176 4177 // Print the statement # in the basic block and the statement itself. 4178 if (print_edges) 4179 OS << " "; 4180 4181 OS << llvm::format("%3d", j) << ": "; 4182 4183 Helper.setStmtID(j); 4184 4185 print_elem(OS, Helper, *I); 4186 } 4187 4188 // Print the terminator of this block. 4189 if (B.getTerminator()) { 4190 if (ShowColors) 4191 OS.changeColor(raw_ostream::GREEN); 4192 4193 OS << " T: "; 4194 4195 Helper.setBlockID(-1); 4196 4197 PrintingPolicy PP(Helper.getLangOpts()); 4198 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP); 4199 TPrinter.print(B.getTerminator()); 4200 OS << '\n'; 4201 4202 if (ShowColors) 4203 OS.resetColor(); 4204 } 4205 4206 if (print_edges) { 4207 // Print the predecessors of this block. 4208 if (!B.pred_empty()) { 4209 const raw_ostream::Colors Color = raw_ostream::BLUE; 4210 if (ShowColors) 4211 OS.changeColor(Color); 4212 OS << " Preds " ; 4213 if (ShowColors) 4214 OS.resetColor(); 4215 OS << '(' << B.pred_size() << "):"; 4216 unsigned i = 0; 4217 4218 if (ShowColors) 4219 OS.changeColor(Color); 4220 4221 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end(); 4222 I != E; ++I, ++i) { 4223 4224 if (i % 10 == 8) 4225 OS << "\n "; 4226 4227 CFGBlock *B = *I; 4228 bool Reachable = true; 4229 if (!B) { 4230 Reachable = false; 4231 B = I->getPossiblyUnreachableBlock(); 4232 } 4233 4234 OS << " B" << B->getBlockID(); 4235 if (!Reachable) 4236 OS << "(Unreachable)"; 4237 } 4238 4239 if (ShowColors) 4240 OS.resetColor(); 4241 4242 OS << '\n'; 4243 } 4244 4245 // Print the successors of this block. 4246 if (!B.succ_empty()) { 4247 const raw_ostream::Colors Color = raw_ostream::MAGENTA; 4248 if (ShowColors) 4249 OS.changeColor(Color); 4250 OS << " Succs "; 4251 if (ShowColors) 4252 OS.resetColor(); 4253 OS << '(' << B.succ_size() << "):"; 4254 unsigned i = 0; 4255 4256 if (ShowColors) 4257 OS.changeColor(Color); 4258 4259 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end(); 4260 I != E; ++I, ++i) { 4261 4262 if (i % 10 == 8) 4263 OS << "\n "; 4264 4265 CFGBlock *B = *I; 4266 4267 bool Reachable = true; 4268 if (!B) { 4269 Reachable = false; 4270 B = I->getPossiblyUnreachableBlock(); 4271 } 4272 4273 if (B) { 4274 OS << " B" << B->getBlockID(); 4275 if (!Reachable) 4276 OS << "(Unreachable)"; 4277 } 4278 else { 4279 OS << " NULL"; 4280 } 4281 } 4282 4283 if (ShowColors) 4284 OS.resetColor(); 4285 OS << '\n'; 4286 } 4287 } 4288 } 4289 4290 4291 /// dump - A simple pretty printer of a CFG that outputs to stderr. 4292 void CFG::dump(const LangOptions &LO, bool ShowColors) const { 4293 print(llvm::errs(), LO, ShowColors); 4294 } 4295 4296 /// print - A simple pretty printer of a CFG that outputs to an ostream. 4297 void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const { 4298 StmtPrinterHelper Helper(this, LO); 4299 4300 // Print the entry block. 4301 print_block(OS, this, getEntry(), Helper, true, ShowColors); 4302 4303 // Iterate through the CFGBlocks and print them one by one. 4304 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) { 4305 // Skip the entry block, because we already printed it. 4306 if (&(**I) == &getEntry() || &(**I) == &getExit()) 4307 continue; 4308 4309 print_block(OS, this, **I, Helper, true, ShowColors); 4310 } 4311 4312 // Print the exit block. 4313 print_block(OS, this, getExit(), Helper, true, ShowColors); 4314 OS << '\n'; 4315 OS.flush(); 4316 } 4317 4318 /// dump - A simply pretty printer of a CFGBlock that outputs to stderr. 4319 void CFGBlock::dump(const CFG* cfg, const LangOptions &LO, 4320 bool ShowColors) const { 4321 print(llvm::errs(), cfg, LO, ShowColors); 4322 } 4323 4324 /// print - A simple pretty printer of a CFGBlock that outputs to an ostream. 4325 /// Generally this will only be called from CFG::print. 4326 void CFGBlock::print(raw_ostream &OS, const CFG* cfg, 4327 const LangOptions &LO, bool ShowColors) const { 4328 StmtPrinterHelper Helper(cfg, LO); 4329 print_block(OS, cfg, *this, Helper, true, ShowColors); 4330 OS << '\n'; 4331 } 4332 4333 /// printTerminator - A simple pretty printer of the terminator of a CFGBlock. 4334 void CFGBlock::printTerminator(raw_ostream &OS, 4335 const LangOptions &LO) const { 4336 CFGBlockTerminatorPrint TPrinter(OS, NULL, PrintingPolicy(LO)); 4337 TPrinter.print(getTerminator()); 4338 } 4339 4340 Stmt *CFGBlock::getTerminatorCondition(bool StripParens) { 4341 Stmt *Terminator = this->Terminator; 4342 if (!Terminator) 4343 return NULL; 4344 4345 Expr *E = NULL; 4346 4347 switch (Terminator->getStmtClass()) { 4348 default: 4349 break; 4350 4351 case Stmt::CXXForRangeStmtClass: 4352 E = cast<CXXForRangeStmt>(Terminator)->getCond(); 4353 break; 4354 4355 case Stmt::ForStmtClass: 4356 E = cast<ForStmt>(Terminator)->getCond(); 4357 break; 4358 4359 case Stmt::WhileStmtClass: 4360 E = cast<WhileStmt>(Terminator)->getCond(); 4361 break; 4362 4363 case Stmt::DoStmtClass: 4364 E = cast<DoStmt>(Terminator)->getCond(); 4365 break; 4366 4367 case Stmt::IfStmtClass: 4368 E = cast<IfStmt>(Terminator)->getCond(); 4369 break; 4370 4371 case Stmt::ChooseExprClass: 4372 E = cast<ChooseExpr>(Terminator)->getCond(); 4373 break; 4374 4375 case Stmt::IndirectGotoStmtClass: 4376 E = cast<IndirectGotoStmt>(Terminator)->getTarget(); 4377 break; 4378 4379 case Stmt::SwitchStmtClass: 4380 E = cast<SwitchStmt>(Terminator)->getCond(); 4381 break; 4382 4383 case Stmt::BinaryConditionalOperatorClass: 4384 E = cast<BinaryConditionalOperator>(Terminator)->getCond(); 4385 break; 4386 4387 case Stmt::ConditionalOperatorClass: 4388 E = cast<ConditionalOperator>(Terminator)->getCond(); 4389 break; 4390 4391 case Stmt::BinaryOperatorClass: // '&&' and '||' 4392 E = cast<BinaryOperator>(Terminator)->getLHS(); 4393 break; 4394 4395 case Stmt::ObjCForCollectionStmtClass: 4396 return Terminator; 4397 } 4398 4399 if (!StripParens) 4400 return E; 4401 4402 return E ? E->IgnoreParens() : NULL; 4403 } 4404 4405 //===----------------------------------------------------------------------===// 4406 // CFG Graphviz Visualization 4407 //===----------------------------------------------------------------------===// 4408 4409 4410 #ifndef NDEBUG 4411 static StmtPrinterHelper* GraphHelper; 4412 #endif 4413 4414 void CFG::viewCFG(const LangOptions &LO) const { 4415 #ifndef NDEBUG 4416 StmtPrinterHelper H(this, LO); 4417 GraphHelper = &H; 4418 llvm::ViewGraph(this,"CFG"); 4419 GraphHelper = NULL; 4420 #endif 4421 } 4422 4423 namespace llvm { 4424 template<> 4425 struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits { 4426 4427 DOTGraphTraits (bool isSimple=false) : DefaultDOTGraphTraits(isSimple) {} 4428 4429 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) { 4430 4431 #ifndef NDEBUG 4432 std::string OutSStr; 4433 llvm::raw_string_ostream Out(OutSStr); 4434 print_block(Out,Graph, *Node, *GraphHelper, false, false); 4435 std::string& OutStr = Out.str(); 4436 4437 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin()); 4438 4439 // Process string output to make it nicer... 4440 for (unsigned i = 0; i != OutStr.length(); ++i) 4441 if (OutStr[i] == '\n') { // Left justify 4442 OutStr[i] = '\\'; 4443 OutStr.insert(OutStr.begin()+i+1, 'l'); 4444 } 4445 4446 return OutStr; 4447 #else 4448 return ""; 4449 #endif 4450 } 4451 }; 4452 } // end namespace llvm 4453