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