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 /// 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 /// 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 /// 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 /// Retrieve the type of the temporary object whose lifetime was 1495 /// extended by a local reference with the given initializer. 1496 static QualType getReferenceInitTemporaryType(const Expr *Init, 1497 bool *FoundMTE = nullptr) { 1498 while (true) { 1499 // Skip parentheses. 1500 Init = Init->IgnoreParens(); 1501 1502 // Skip through cleanups. 1503 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) { 1504 Init = EWC->getSubExpr(); 1505 continue; 1506 } 1507 1508 // Skip through the temporary-materialization expression. 1509 if (const MaterializeTemporaryExpr *MTE 1510 = dyn_cast<MaterializeTemporaryExpr>(Init)) { 1511 Init = MTE->GetTemporaryExpr(); 1512 if (FoundMTE) 1513 *FoundMTE = true; 1514 continue; 1515 } 1516 1517 // Skip sub-object accesses into rvalues. 1518 SmallVector<const Expr *, 2> CommaLHSs; 1519 SmallVector<SubobjectAdjustment, 2> Adjustments; 1520 const Expr *SkippedInit = 1521 Init->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments); 1522 if (SkippedInit != Init) { 1523 Init = SkippedInit; 1524 continue; 1525 } 1526 1527 break; 1528 } 1529 1530 return Init->getType(); 1531 } 1532 1533 // TODO: Support adding LoopExit element to the CFG in case where the loop is 1534 // ended by ReturnStmt, GotoStmt or ThrowExpr. 1535 void CFGBuilder::addLoopExit(const Stmt *LoopStmt){ 1536 if(!BuildOpts.AddLoopExit) 1537 return; 1538 autoCreateBlock(); 1539 appendLoopExit(Block, LoopStmt); 1540 } 1541 1542 void CFGBuilder::getDeclsWithEndedScope(LocalScope::const_iterator B, 1543 LocalScope::const_iterator E, Stmt *S) { 1544 if (!BuildOpts.AddScopes) 1545 return; 1546 1547 if (B == E) 1548 return; 1549 1550 // To go from B to E, one first goes up the scopes from B to P 1551 // then sideways in one scope from P to P' and then down 1552 // the scopes from P' to E. 1553 // The lifetime of all objects between B and P end. 1554 LocalScope::const_iterator P = B.shared_parent(E); 1555 int Dist = B.distance(P); 1556 if (Dist <= 0) 1557 return; 1558 1559 for (LocalScope::const_iterator I = B; I != P; ++I) 1560 if (I.pointsToFirstDeclaredVar()) 1561 DeclsWithEndedScope.insert(*I); 1562 } 1563 1564 void CFGBuilder::addAutomaticObjHandling(LocalScope::const_iterator B, 1565 LocalScope::const_iterator E, 1566 Stmt *S) { 1567 getDeclsWithEndedScope(B, E, S); 1568 if (BuildOpts.AddScopes) 1569 addScopesEnd(B, E, S); 1570 if (BuildOpts.AddImplicitDtors) 1571 addAutomaticObjDtors(B, E, S); 1572 if (BuildOpts.AddLifetime) 1573 addLifetimeEnds(B, E, S); 1574 } 1575 1576 /// Add to current block automatic objects that leave the scope. 1577 void CFGBuilder::addLifetimeEnds(LocalScope::const_iterator B, 1578 LocalScope::const_iterator E, Stmt *S) { 1579 if (!BuildOpts.AddLifetime) 1580 return; 1581 1582 if (B == E) 1583 return; 1584 1585 // To go from B to E, one first goes up the scopes from B to P 1586 // then sideways in one scope from P to P' and then down 1587 // the scopes from P' to E. 1588 // The lifetime of all objects between B and P end. 1589 LocalScope::const_iterator P = B.shared_parent(E); 1590 int dist = B.distance(P); 1591 if (dist <= 0) 1592 return; 1593 1594 // We need to perform the scope leaving in reverse order 1595 SmallVector<VarDecl *, 10> DeclsTrivial; 1596 SmallVector<VarDecl *, 10> DeclsNonTrivial; 1597 DeclsTrivial.reserve(dist); 1598 DeclsNonTrivial.reserve(dist); 1599 1600 for (LocalScope::const_iterator I = B; I != P; ++I) 1601 if (hasTrivialDestructor(*I)) 1602 DeclsTrivial.push_back(*I); 1603 else 1604 DeclsNonTrivial.push_back(*I); 1605 1606 autoCreateBlock(); 1607 // object with trivial destructor end their lifetime last (when storage 1608 // duration ends) 1609 for (SmallVectorImpl<VarDecl *>::reverse_iterator I = DeclsTrivial.rbegin(), 1610 E = DeclsTrivial.rend(); 1611 I != E; ++I) 1612 appendLifetimeEnds(Block, *I, S); 1613 1614 for (SmallVectorImpl<VarDecl *>::reverse_iterator 1615 I = DeclsNonTrivial.rbegin(), 1616 E = DeclsNonTrivial.rend(); 1617 I != E; ++I) 1618 appendLifetimeEnds(Block, *I, S); 1619 } 1620 1621 /// Add to current block markers for ending scopes. 1622 void CFGBuilder::addScopesEnd(LocalScope::const_iterator B, 1623 LocalScope::const_iterator E, Stmt *S) { 1624 // If implicit destructors are enabled, we'll add scope ends in 1625 // addAutomaticObjDtors. 1626 if (BuildOpts.AddImplicitDtors) 1627 return; 1628 1629 autoCreateBlock(); 1630 1631 for (auto I = DeclsWithEndedScope.rbegin(), E = DeclsWithEndedScope.rend(); 1632 I != E; ++I) 1633 appendScopeEnd(Block, *I, S); 1634 1635 return; 1636 } 1637 1638 /// addAutomaticObjDtors - Add to current block automatic objects destructors 1639 /// for objects in range of local scope positions. Use S as trigger statement 1640 /// for destructors. 1641 void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B, 1642 LocalScope::const_iterator E, Stmt *S) { 1643 if (!BuildOpts.AddImplicitDtors) 1644 return; 1645 1646 if (B == E) 1647 return; 1648 1649 // We need to append the destructors in reverse order, but any one of them 1650 // may be a no-return destructor which changes the CFG. As a result, buffer 1651 // this sequence up and replay them in reverse order when appending onto the 1652 // CFGBlock(s). 1653 SmallVector<VarDecl*, 10> Decls; 1654 Decls.reserve(B.distance(E)); 1655 for (LocalScope::const_iterator I = B; I != E; ++I) 1656 Decls.push_back(*I); 1657 1658 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(), 1659 E = Decls.rend(); 1660 I != E; ++I) { 1661 if (hasTrivialDestructor(*I)) { 1662 // If AddScopes is enabled and *I is a first variable in a scope, add a 1663 // ScopeEnd marker in a Block. 1664 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I)) { 1665 autoCreateBlock(); 1666 appendScopeEnd(Block, *I, S); 1667 } 1668 continue; 1669 } 1670 // If this destructor is marked as a no-return destructor, we need to 1671 // create a new block for the destructor which does not have as a successor 1672 // anything built thus far: control won't flow out of this block. 1673 QualType Ty = (*I)->getType(); 1674 if (Ty->isReferenceType()) { 1675 Ty = getReferenceInitTemporaryType((*I)->getInit()); 1676 } 1677 Ty = Context->getBaseElementType(Ty); 1678 1679 if (Ty->getAsCXXRecordDecl()->isAnyDestructorNoReturn()) 1680 Block = createNoReturnBlock(); 1681 else 1682 autoCreateBlock(); 1683 1684 // Add ScopeEnd just after automatic obj destructor. 1685 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I)) 1686 appendScopeEnd(Block, *I, S); 1687 appendAutomaticObjDtor(Block, *I, S); 1688 } 1689 } 1690 1691 /// addImplicitDtorsForDestructor - Add implicit destructors generated for 1692 /// base and member objects in destructor. 1693 void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) { 1694 assert(BuildOpts.AddImplicitDtors && 1695 "Can be called only when dtors should be added"); 1696 const CXXRecordDecl *RD = DD->getParent(); 1697 1698 // At the end destroy virtual base objects. 1699 for (const auto &VI : RD->vbases()) { 1700 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl(); 1701 if (!CD->hasTrivialDestructor()) { 1702 autoCreateBlock(); 1703 appendBaseDtor(Block, &VI); 1704 } 1705 } 1706 1707 // Before virtual bases destroy direct base objects. 1708 for (const auto &BI : RD->bases()) { 1709 if (!BI.isVirtual()) { 1710 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl(); 1711 if (!CD->hasTrivialDestructor()) { 1712 autoCreateBlock(); 1713 appendBaseDtor(Block, &BI); 1714 } 1715 } 1716 } 1717 1718 // First destroy member objects. 1719 for (auto *FI : RD->fields()) { 1720 // Check for constant size array. Set type to array element type. 1721 QualType QT = FI->getType(); 1722 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) { 1723 if (AT->getSize() == 0) 1724 continue; 1725 QT = AT->getElementType(); 1726 } 1727 1728 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl()) 1729 if (!CD->hasTrivialDestructor()) { 1730 autoCreateBlock(); 1731 appendMemberDtor(Block, FI); 1732 } 1733 } 1734 } 1735 1736 /// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either 1737 /// way return valid LocalScope object. 1738 LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) { 1739 if (Scope) 1740 return Scope; 1741 llvm::BumpPtrAllocator &alloc = cfg->getAllocator(); 1742 return new (alloc.Allocate<LocalScope>()) 1743 LocalScope(BumpVectorContext(alloc), ScopePos); 1744 } 1745 1746 /// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement 1747 /// that should create implicit scope (e.g. if/else substatements). 1748 void CFGBuilder::addLocalScopeForStmt(Stmt *S) { 1749 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime && 1750 !BuildOpts.AddScopes) 1751 return; 1752 1753 LocalScope *Scope = nullptr; 1754 1755 // For compound statement we will be creating explicit scope. 1756 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) { 1757 for (auto *BI : CS->body()) { 1758 Stmt *SI = BI->stripLabelLikeStatements(); 1759 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI)) 1760 Scope = addLocalScopeForDeclStmt(DS, Scope); 1761 } 1762 return; 1763 } 1764 1765 // For any other statement scope will be implicit and as such will be 1766 // interesting only for DeclStmt. 1767 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements())) 1768 addLocalScopeForDeclStmt(DS); 1769 } 1770 1771 /// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will 1772 /// reuse Scope if not NULL. 1773 LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS, 1774 LocalScope* Scope) { 1775 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime && 1776 !BuildOpts.AddScopes) 1777 return Scope; 1778 1779 for (auto *DI : DS->decls()) 1780 if (VarDecl *VD = dyn_cast<VarDecl>(DI)) 1781 Scope = addLocalScopeForVarDecl(VD, Scope); 1782 return Scope; 1783 } 1784 1785 bool CFGBuilder::hasTrivialDestructor(VarDecl *VD) { 1786 // Check for const references bound to temporary. Set type to pointee. 1787 QualType QT = VD->getType(); 1788 if (QT->isReferenceType()) { 1789 // Attempt to determine whether this declaration lifetime-extends a 1790 // temporary. 1791 // 1792 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend 1793 // temporaries, and a single declaration can extend multiple temporaries. 1794 // We should look at the storage duration on each nested 1795 // MaterializeTemporaryExpr instead. 1796 1797 const Expr *Init = VD->getInit(); 1798 if (!Init) { 1799 // Probably an exception catch-by-reference variable. 1800 // FIXME: It doesn't really mean that the object has a trivial destructor. 1801 // Also are there other cases? 1802 return true; 1803 } 1804 1805 // Lifetime-extending a temporary? 1806 bool FoundMTE = false; 1807 QT = getReferenceInitTemporaryType(Init, &FoundMTE); 1808 if (!FoundMTE) 1809 return true; 1810 } 1811 1812 // Check for constant size array. Set type to array element type. 1813 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) { 1814 if (AT->getSize() == 0) 1815 return true; 1816 QT = AT->getElementType(); 1817 } 1818 1819 // Check if type is a C++ class with non-trivial destructor. 1820 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl()) 1821 return !CD->hasDefinition() || CD->hasTrivialDestructor(); 1822 return true; 1823 } 1824 1825 /// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will 1826 /// create add scope for automatic objects and temporary objects bound to 1827 /// const reference. Will reuse Scope if not NULL. 1828 LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD, 1829 LocalScope* Scope) { 1830 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) && 1831 "AddImplicitDtors and AddLifetime cannot be used at the same time"); 1832 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime && 1833 !BuildOpts.AddScopes) 1834 return Scope; 1835 1836 // Check if variable is local. 1837 switch (VD->getStorageClass()) { 1838 case SC_None: 1839 case SC_Auto: 1840 case SC_Register: 1841 break; 1842 default: return Scope; 1843 } 1844 1845 if (BuildOpts.AddImplicitDtors) { 1846 if (!hasTrivialDestructor(VD) || BuildOpts.AddScopes) { 1847 // Add the variable to scope 1848 Scope = createOrReuseLocalScope(Scope); 1849 Scope->addVar(VD); 1850 ScopePos = Scope->begin(); 1851 } 1852 return Scope; 1853 } 1854 1855 assert(BuildOpts.AddLifetime); 1856 // Add the variable to scope 1857 Scope = createOrReuseLocalScope(Scope); 1858 Scope->addVar(VD); 1859 ScopePos = Scope->begin(); 1860 return Scope; 1861 } 1862 1863 /// addLocalScopeAndDtors - For given statement add local scope for it and 1864 /// add destructors that will cleanup the scope. Will reuse Scope if not NULL. 1865 void CFGBuilder::addLocalScopeAndDtors(Stmt *S) { 1866 LocalScope::const_iterator scopeBeginPos = ScopePos; 1867 addLocalScopeForStmt(S); 1868 addAutomaticObjHandling(ScopePos, scopeBeginPos, S); 1869 } 1870 1871 /// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for 1872 /// variables with automatic storage duration to CFGBlock's elements vector. 1873 /// Elements will be prepended to physical beginning of the vector which 1874 /// happens to be logical end. Use blocks terminator as statement that specifies 1875 /// destructors call site. 1876 /// FIXME: This mechanism for adding automatic destructors doesn't handle 1877 /// no-return destructors properly. 1878 void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk, 1879 LocalScope::const_iterator B, LocalScope::const_iterator E) { 1880 if (!BuildOpts.AddImplicitDtors) 1881 return; 1882 BumpVectorContext &C = cfg->getBumpVectorContext(); 1883 CFGBlock::iterator InsertPos 1884 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C); 1885 for (LocalScope::const_iterator I = B; I != E; ++I) 1886 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I, 1887 Blk->getTerminator()); 1888 } 1889 1890 /// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for 1891 /// variables with automatic storage duration to CFGBlock's elements vector. 1892 /// Elements will be prepended to physical beginning of the vector which 1893 /// happens to be logical end. Use blocks terminator as statement that specifies 1894 /// where lifetime ends. 1895 void CFGBuilder::prependAutomaticObjLifetimeWithTerminator( 1896 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) { 1897 if (!BuildOpts.AddLifetime) 1898 return; 1899 BumpVectorContext &C = cfg->getBumpVectorContext(); 1900 CFGBlock::iterator InsertPos = 1901 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C); 1902 for (LocalScope::const_iterator I = B; I != E; ++I) 1903 InsertPos = Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminator()); 1904 } 1905 1906 /// prependAutomaticObjScopeEndWithTerminator - Prepend scope end CFGElements for 1907 /// variables with automatic storage duration to CFGBlock's elements vector. 1908 /// Elements will be prepended to physical beginning of the vector which 1909 /// happens to be logical end. Use blocks terminator as statement that specifies 1910 /// where scope ends. 1911 const VarDecl * 1912 CFGBuilder::prependAutomaticObjScopeEndWithTerminator( 1913 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) { 1914 if (!BuildOpts.AddScopes) 1915 return nullptr; 1916 BumpVectorContext &C = cfg->getBumpVectorContext(); 1917 CFGBlock::iterator InsertPos = 1918 Blk->beginScopeEndInsert(Blk->end(), 1, C); 1919 LocalScope::const_iterator PlaceToInsert = B; 1920 for (LocalScope::const_iterator I = B; I != E; ++I) 1921 PlaceToInsert = I; 1922 Blk->insertScopeEnd(InsertPos, *PlaceToInsert, Blk->getTerminator()); 1923 return *PlaceToInsert; 1924 } 1925 1926 /// Visit - Walk the subtree of a statement and add extra 1927 /// blocks for ternary operators, &&, and ||. We also process "," and 1928 /// DeclStmts (which may contain nested control-flow). 1929 CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) { 1930 if (!S) { 1931 badCFG = true; 1932 return nullptr; 1933 } 1934 1935 if (Expr *E = dyn_cast<Expr>(S)) 1936 S = E->IgnoreParens(); 1937 1938 switch (S->getStmtClass()) { 1939 default: 1940 return VisitStmt(S, asc); 1941 1942 case Stmt::AddrLabelExprClass: 1943 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc); 1944 1945 case Stmt::BinaryConditionalOperatorClass: 1946 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc); 1947 1948 case Stmt::BinaryOperatorClass: 1949 return VisitBinaryOperator(cast<BinaryOperator>(S), asc); 1950 1951 case Stmt::BlockExprClass: 1952 return VisitBlockExpr(cast<BlockExpr>(S), asc); 1953 1954 case Stmt::BreakStmtClass: 1955 return VisitBreakStmt(cast<BreakStmt>(S)); 1956 1957 case Stmt::CallExprClass: 1958 case Stmt::CXXOperatorCallExprClass: 1959 case Stmt::CXXMemberCallExprClass: 1960 case Stmt::UserDefinedLiteralClass: 1961 return VisitCallExpr(cast<CallExpr>(S), asc); 1962 1963 case Stmt::CaseStmtClass: 1964 return VisitCaseStmt(cast<CaseStmt>(S)); 1965 1966 case Stmt::ChooseExprClass: 1967 return VisitChooseExpr(cast<ChooseExpr>(S), asc); 1968 1969 case Stmt::CompoundStmtClass: 1970 return VisitCompoundStmt(cast<CompoundStmt>(S)); 1971 1972 case Stmt::ConditionalOperatorClass: 1973 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc); 1974 1975 case Stmt::ContinueStmtClass: 1976 return VisitContinueStmt(cast<ContinueStmt>(S)); 1977 1978 case Stmt::CXXCatchStmtClass: 1979 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S)); 1980 1981 case Stmt::ExprWithCleanupsClass: 1982 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc); 1983 1984 case Stmt::CXXDefaultArgExprClass: 1985 case Stmt::CXXDefaultInitExprClass: 1986 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the 1987 // called function's declaration, not by the caller. If we simply add 1988 // this expression to the CFG, we could end up with the same Expr 1989 // appearing multiple times. 1990 // PR13385 / <rdar://problem/12156507> 1991 // 1992 // It's likewise possible for multiple CXXDefaultInitExprs for the same 1993 // expression to be used in the same function (through aggregate 1994 // initialization). 1995 return VisitStmt(S, asc); 1996 1997 case Stmt::CXXBindTemporaryExprClass: 1998 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc); 1999 2000 case Stmt::CXXConstructExprClass: 2001 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc); 2002 2003 case Stmt::CXXNewExprClass: 2004 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc); 2005 2006 case Stmt::CXXDeleteExprClass: 2007 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc); 2008 2009 case Stmt::CXXFunctionalCastExprClass: 2010 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc); 2011 2012 case Stmt::CXXTemporaryObjectExprClass: 2013 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc); 2014 2015 case Stmt::CXXThrowExprClass: 2016 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S)); 2017 2018 case Stmt::CXXTryStmtClass: 2019 return VisitCXXTryStmt(cast<CXXTryStmt>(S)); 2020 2021 case Stmt::CXXForRangeStmtClass: 2022 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S)); 2023 2024 case Stmt::DeclStmtClass: 2025 return VisitDeclStmt(cast<DeclStmt>(S)); 2026 2027 case Stmt::DefaultStmtClass: 2028 return VisitDefaultStmt(cast<DefaultStmt>(S)); 2029 2030 case Stmt::DoStmtClass: 2031 return VisitDoStmt(cast<DoStmt>(S)); 2032 2033 case Stmt::ForStmtClass: 2034 return VisitForStmt(cast<ForStmt>(S)); 2035 2036 case Stmt::GotoStmtClass: 2037 return VisitGotoStmt(cast<GotoStmt>(S)); 2038 2039 case Stmt::IfStmtClass: 2040 return VisitIfStmt(cast<IfStmt>(S)); 2041 2042 case Stmt::ImplicitCastExprClass: 2043 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc); 2044 2045 case Stmt::IndirectGotoStmtClass: 2046 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S)); 2047 2048 case Stmt::LabelStmtClass: 2049 return VisitLabelStmt(cast<LabelStmt>(S)); 2050 2051 case Stmt::LambdaExprClass: 2052 return VisitLambdaExpr(cast<LambdaExpr>(S), asc); 2053 2054 case Stmt::MaterializeTemporaryExprClass: 2055 return VisitMaterializeTemporaryExpr(cast<MaterializeTemporaryExpr>(S), 2056 asc); 2057 2058 case Stmt::MemberExprClass: 2059 return VisitMemberExpr(cast<MemberExpr>(S), asc); 2060 2061 case Stmt::NullStmtClass: 2062 return Block; 2063 2064 case Stmt::ObjCAtCatchStmtClass: 2065 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S)); 2066 2067 case Stmt::ObjCAutoreleasePoolStmtClass: 2068 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S)); 2069 2070 case Stmt::ObjCAtSynchronizedStmtClass: 2071 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S)); 2072 2073 case Stmt::ObjCAtThrowStmtClass: 2074 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S)); 2075 2076 case Stmt::ObjCAtTryStmtClass: 2077 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S)); 2078 2079 case Stmt::ObjCForCollectionStmtClass: 2080 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S)); 2081 2082 case Stmt::OpaqueValueExprClass: 2083 return Block; 2084 2085 case Stmt::PseudoObjectExprClass: 2086 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S)); 2087 2088 case Stmt::ReturnStmtClass: 2089 return VisitReturnStmt(cast<ReturnStmt>(S)); 2090 2091 case Stmt::SEHExceptStmtClass: 2092 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S)); 2093 2094 case Stmt::SEHFinallyStmtClass: 2095 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S)); 2096 2097 case Stmt::SEHLeaveStmtClass: 2098 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S)); 2099 2100 case Stmt::SEHTryStmtClass: 2101 return VisitSEHTryStmt(cast<SEHTryStmt>(S)); 2102 2103 case Stmt::UnaryExprOrTypeTraitExprClass: 2104 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S), 2105 asc); 2106 2107 case Stmt::StmtExprClass: 2108 return VisitStmtExpr(cast<StmtExpr>(S), asc); 2109 2110 case Stmt::SwitchStmtClass: 2111 return VisitSwitchStmt(cast<SwitchStmt>(S)); 2112 2113 case Stmt::UnaryOperatorClass: 2114 return VisitUnaryOperator(cast<UnaryOperator>(S), asc); 2115 2116 case Stmt::WhileStmtClass: 2117 return VisitWhileStmt(cast<WhileStmt>(S)); 2118 } 2119 } 2120 2121 CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) { 2122 if (asc.alwaysAdd(*this, S)) { 2123 autoCreateBlock(); 2124 appendStmt(Block, S); 2125 } 2126 2127 return VisitChildren(S); 2128 } 2129 2130 /// VisitChildren - Visit the children of a Stmt. 2131 CFGBlock *CFGBuilder::VisitChildren(Stmt *S) { 2132 CFGBlock *B = Block; 2133 2134 // Visit the children in their reverse order so that they appear in 2135 // left-to-right (natural) order in the CFG. 2136 reverse_children RChildren(S); 2137 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end(); 2138 I != E; ++I) { 2139 if (Stmt *Child = *I) 2140 if (CFGBlock *R = Visit(Child)) 2141 B = R; 2142 } 2143 return B; 2144 } 2145 2146 CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A, 2147 AddStmtChoice asc) { 2148 AddressTakenLabels.insert(A->getLabel()); 2149 2150 if (asc.alwaysAdd(*this, A)) { 2151 autoCreateBlock(); 2152 appendStmt(Block, A); 2153 } 2154 2155 return Block; 2156 } 2157 2158 CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U, 2159 AddStmtChoice asc) { 2160 if (asc.alwaysAdd(*this, U)) { 2161 autoCreateBlock(); 2162 appendStmt(Block, U); 2163 } 2164 2165 return Visit(U->getSubExpr(), AddStmtChoice()); 2166 } 2167 2168 CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) { 2169 CFGBlock *ConfluenceBlock = Block ? Block : createBlock(); 2170 appendStmt(ConfluenceBlock, B); 2171 2172 if (badCFG) 2173 return nullptr; 2174 2175 return VisitLogicalOperator(B, nullptr, ConfluenceBlock, 2176 ConfluenceBlock).first; 2177 } 2178 2179 std::pair<CFGBlock*, CFGBlock*> 2180 CFGBuilder::VisitLogicalOperator(BinaryOperator *B, 2181 Stmt *Term, 2182 CFGBlock *TrueBlock, 2183 CFGBlock *FalseBlock) { 2184 // Introspect the RHS. If it is a nested logical operation, we recursively 2185 // build the CFG using this function. Otherwise, resort to default 2186 // CFG construction behavior. 2187 Expr *RHS = B->getRHS()->IgnoreParens(); 2188 CFGBlock *RHSBlock, *ExitBlock; 2189 2190 do { 2191 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS)) 2192 if (B_RHS->isLogicalOp()) { 2193 std::tie(RHSBlock, ExitBlock) = 2194 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock); 2195 break; 2196 } 2197 2198 // The RHS is not a nested logical operation. Don't push the terminator 2199 // down further, but instead visit RHS and construct the respective 2200 // pieces of the CFG, and link up the RHSBlock with the terminator 2201 // we have been provided. 2202 ExitBlock = RHSBlock = createBlock(false); 2203 2204 // Even though KnownVal is only used in the else branch of the next 2205 // conditional, tryEvaluateBool performs additional checking on the 2206 // Expr, so it should be called unconditionally. 2207 TryResult KnownVal = tryEvaluateBool(RHS); 2208 if (!KnownVal.isKnown()) 2209 KnownVal = tryEvaluateBool(B); 2210 2211 if (!Term) { 2212 assert(TrueBlock == FalseBlock); 2213 addSuccessor(RHSBlock, TrueBlock); 2214 } 2215 else { 2216 RHSBlock->setTerminator(Term); 2217 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse()); 2218 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue()); 2219 } 2220 2221 Block = RHSBlock; 2222 RHSBlock = addStmt(RHS); 2223 } 2224 while (false); 2225 2226 if (badCFG) 2227 return std::make_pair(nullptr, nullptr); 2228 2229 // Generate the blocks for evaluating the LHS. 2230 Expr *LHS = B->getLHS()->IgnoreParens(); 2231 2232 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS)) 2233 if (B_LHS->isLogicalOp()) { 2234 if (B->getOpcode() == BO_LOr) 2235 FalseBlock = RHSBlock; 2236 else 2237 TrueBlock = RHSBlock; 2238 2239 // For the LHS, treat 'B' as the terminator that we want to sink 2240 // into the nested branch. The RHS always gets the top-most 2241 // terminator. 2242 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock); 2243 } 2244 2245 // Create the block evaluating the LHS. 2246 // This contains the '&&' or '||' as the terminator. 2247 CFGBlock *LHSBlock = createBlock(false); 2248 LHSBlock->setTerminator(B); 2249 2250 Block = LHSBlock; 2251 CFGBlock *EntryLHSBlock = addStmt(LHS); 2252 2253 if (badCFG) 2254 return std::make_pair(nullptr, nullptr); 2255 2256 // See if this is a known constant. 2257 TryResult KnownVal = tryEvaluateBool(LHS); 2258 2259 // Now link the LHSBlock with RHSBlock. 2260 if (B->getOpcode() == BO_LOr) { 2261 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse()); 2262 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue()); 2263 } else { 2264 assert(B->getOpcode() == BO_LAnd); 2265 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse()); 2266 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue()); 2267 } 2268 2269 return std::make_pair(EntryLHSBlock, ExitBlock); 2270 } 2271 2272 CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B, 2273 AddStmtChoice asc) { 2274 // && or || 2275 if (B->isLogicalOp()) 2276 return VisitLogicalOperator(B); 2277 2278 if (B->getOpcode() == BO_Comma) { // , 2279 autoCreateBlock(); 2280 appendStmt(Block, B); 2281 addStmt(B->getRHS()); 2282 return addStmt(B->getLHS()); 2283 } 2284 2285 if (B->isAssignmentOp()) { 2286 if (asc.alwaysAdd(*this, B)) { 2287 autoCreateBlock(); 2288 appendStmt(Block, B); 2289 } 2290 Visit(B->getLHS()); 2291 return Visit(B->getRHS()); 2292 } 2293 2294 if (asc.alwaysAdd(*this, B)) { 2295 autoCreateBlock(); 2296 appendStmt(Block, B); 2297 } 2298 2299 CFGBlock *RBlock = Visit(B->getRHS()); 2300 CFGBlock *LBlock = Visit(B->getLHS()); 2301 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr 2302 // containing a DoStmt, and the LHS doesn't create a new block, then we should 2303 // return RBlock. Otherwise we'll incorrectly return NULL. 2304 return (LBlock ? LBlock : RBlock); 2305 } 2306 2307 CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) { 2308 if (asc.alwaysAdd(*this, E)) { 2309 autoCreateBlock(); 2310 appendStmt(Block, E); 2311 } 2312 return Block; 2313 } 2314 2315 CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) { 2316 // "break" is a control-flow statement. Thus we stop processing the current 2317 // block. 2318 if (badCFG) 2319 return nullptr; 2320 2321 // Now create a new block that ends with the break statement. 2322 Block = createBlock(false); 2323 Block->setTerminator(B); 2324 2325 // If there is no target for the break, then we are looking at an incomplete 2326 // AST. This means that the CFG cannot be constructed. 2327 if (BreakJumpTarget.block) { 2328 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B); 2329 addSuccessor(Block, BreakJumpTarget.block); 2330 } else 2331 badCFG = true; 2332 2333 return Block; 2334 } 2335 2336 static bool CanThrow(Expr *E, ASTContext &Ctx) { 2337 QualType Ty = E->getType(); 2338 if (Ty->isFunctionPointerType()) 2339 Ty = Ty->getAs<PointerType>()->getPointeeType(); 2340 else if (Ty->isBlockPointerType()) 2341 Ty = Ty->getAs<BlockPointerType>()->getPointeeType(); 2342 2343 const FunctionType *FT = Ty->getAs<FunctionType>(); 2344 if (FT) { 2345 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT)) 2346 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) && 2347 Proto->isNothrow()) 2348 return false; 2349 } 2350 return true; 2351 } 2352 2353 CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) { 2354 // Compute the callee type. 2355 QualType calleeType = C->getCallee()->getType(); 2356 if (calleeType == Context->BoundMemberTy) { 2357 QualType boundType = Expr::findBoundMemberType(C->getCallee()); 2358 2359 // We should only get a null bound type if processing a dependent 2360 // CFG. Recover by assuming nothing. 2361 if (!boundType.isNull()) calleeType = boundType; 2362 } 2363 2364 // FIXME: Once actually implemented, this construction context layer should 2365 // include the number of the argument as well. 2366 for (auto Arg: C->arguments()) { 2367 findConstructionContexts( 2368 ConstructionContextLayer::create(cfg->getBumpVectorContext(), C), Arg); 2369 } 2370 2371 // If this is a call to a no-return function, this stops the block here. 2372 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn(); 2373 2374 bool AddEHEdge = false; 2375 2376 // Languages without exceptions are assumed to not throw. 2377 if (Context->getLangOpts().Exceptions) { 2378 if (BuildOpts.AddEHEdges) 2379 AddEHEdge = true; 2380 } 2381 2382 // If this is a call to a builtin function, it might not actually evaluate 2383 // its arguments. Don't add them to the CFG if this is the case. 2384 bool OmitArguments = false; 2385 2386 if (FunctionDecl *FD = C->getDirectCallee()) { 2387 if (FD->isNoReturn() || C->isBuiltinAssumeFalse(*Context)) 2388 NoReturn = true; 2389 if (FD->hasAttr<NoThrowAttr>()) 2390 AddEHEdge = false; 2391 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size) 2392 OmitArguments = true; 2393 } 2394 2395 if (!CanThrow(C->getCallee(), *Context)) 2396 AddEHEdge = false; 2397 2398 if (OmitArguments) { 2399 assert(!NoReturn && "noreturn calls with unevaluated args not implemented"); 2400 assert(!AddEHEdge && "EH calls with unevaluated args not implemented"); 2401 autoCreateBlock(); 2402 appendStmt(Block, C); 2403 return Visit(C->getCallee()); 2404 } 2405 2406 if (!NoReturn && !AddEHEdge) { 2407 autoCreateBlock(); 2408 appendCall(Block, C); 2409 2410 return VisitChildren(C); 2411 } 2412 2413 if (Block) { 2414 Succ = Block; 2415 if (badCFG) 2416 return nullptr; 2417 } 2418 2419 if (NoReturn) 2420 Block = createNoReturnBlock(); 2421 else 2422 Block = createBlock(); 2423 2424 appendCall(Block, C); 2425 2426 if (AddEHEdge) { 2427 // Add exceptional edges. 2428 if (TryTerminatedBlock) 2429 addSuccessor(Block, TryTerminatedBlock); 2430 else 2431 addSuccessor(Block, &cfg->getExit()); 2432 } 2433 2434 return VisitChildren(C); 2435 } 2436 2437 CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C, 2438 AddStmtChoice asc) { 2439 CFGBlock *ConfluenceBlock = Block ? Block : createBlock(); 2440 appendStmt(ConfluenceBlock, C); 2441 if (badCFG) 2442 return nullptr; 2443 2444 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true); 2445 Succ = ConfluenceBlock; 2446 Block = nullptr; 2447 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd); 2448 if (badCFG) 2449 return nullptr; 2450 2451 Succ = ConfluenceBlock; 2452 Block = nullptr; 2453 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd); 2454 if (badCFG) 2455 return nullptr; 2456 2457 Block = createBlock(false); 2458 // See if this is a known constant. 2459 const TryResult& KnownVal = tryEvaluateBool(C->getCond()); 2460 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock); 2461 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock); 2462 Block->setTerminator(C); 2463 return addStmt(C->getCond()); 2464 } 2465 2466 CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) { 2467 LocalScope::const_iterator scopeBeginPos = ScopePos; 2468 addLocalScopeForStmt(C); 2469 2470 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) { 2471 // If the body ends with a ReturnStmt, the dtors will be added in 2472 // VisitReturnStmt. 2473 addAutomaticObjHandling(ScopePos, scopeBeginPos, C); 2474 } 2475 2476 CFGBlock *LastBlock = Block; 2477 2478 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend(); 2479 I != E; ++I ) { 2480 // If we hit a segment of code just containing ';' (NullStmts), we can 2481 // get a null block back. In such cases, just use the LastBlock 2482 if (CFGBlock *newBlock = addStmt(*I)) 2483 LastBlock = newBlock; 2484 2485 if (badCFG) 2486 return nullptr; 2487 } 2488 2489 return LastBlock; 2490 } 2491 2492 CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C, 2493 AddStmtChoice asc) { 2494 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C); 2495 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr); 2496 2497 // Create the confluence block that will "merge" the results of the ternary 2498 // expression. 2499 CFGBlock *ConfluenceBlock = Block ? Block : createBlock(); 2500 appendStmt(ConfluenceBlock, C); 2501 if (badCFG) 2502 return nullptr; 2503 2504 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true); 2505 2506 // Create a block for the LHS expression if there is an LHS expression. A 2507 // GCC extension allows LHS to be NULL, causing the condition to be the 2508 // value that is returned instead. 2509 // e.g: x ?: y is shorthand for: x ? x : y; 2510 Succ = ConfluenceBlock; 2511 Block = nullptr; 2512 CFGBlock *LHSBlock = nullptr; 2513 const Expr *trueExpr = C->getTrueExpr(); 2514 if (trueExpr != opaqueValue) { 2515 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd); 2516 if (badCFG) 2517 return nullptr; 2518 Block = nullptr; 2519 } 2520 else 2521 LHSBlock = ConfluenceBlock; 2522 2523 // Create the block for the RHS expression. 2524 Succ = ConfluenceBlock; 2525 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd); 2526 if (badCFG) 2527 return nullptr; 2528 2529 // If the condition is a logical '&&' or '||', build a more accurate CFG. 2530 if (BinaryOperator *Cond = 2531 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens())) 2532 if (Cond->isLogicalOp()) 2533 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first; 2534 2535 // Create the block that will contain the condition. 2536 Block = createBlock(false); 2537 2538 // See if this is a known constant. 2539 const TryResult& KnownVal = tryEvaluateBool(C->getCond()); 2540 addSuccessor(Block, LHSBlock, !KnownVal.isFalse()); 2541 addSuccessor(Block, RHSBlock, !KnownVal.isTrue()); 2542 Block->setTerminator(C); 2543 Expr *condExpr = C->getCond(); 2544 2545 if (opaqueValue) { 2546 // Run the condition expression if it's not trivially expressed in 2547 // terms of the opaque value (or if there is no opaque value). 2548 if (condExpr != opaqueValue) 2549 addStmt(condExpr); 2550 2551 // Before that, run the common subexpression if there was one. 2552 // At least one of this or the above will be run. 2553 return addStmt(BCO->getCommon()); 2554 } 2555 2556 return addStmt(condExpr); 2557 } 2558 2559 CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) { 2560 // Check if the Decl is for an __label__. If so, elide it from the 2561 // CFG entirely. 2562 if (isa<LabelDecl>(*DS->decl_begin())) 2563 return Block; 2564 2565 // This case also handles static_asserts. 2566 if (DS->isSingleDecl()) 2567 return VisitDeclSubExpr(DS); 2568 2569 CFGBlock *B = nullptr; 2570 2571 // Build an individual DeclStmt for each decl. 2572 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(), 2573 E = DS->decl_rend(); 2574 I != E; ++I) { 2575 // Get the alignment of the new DeclStmt, padding out to >=8 bytes. 2576 unsigned A = alignof(DeclStmt) < 8 ? 8 : alignof(DeclStmt); 2577 2578 // Allocate the DeclStmt using the BumpPtrAllocator. It will get 2579 // automatically freed with the CFG. 2580 DeclGroupRef DG(*I); 2581 Decl *D = *I; 2582 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A); 2583 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D)); 2584 cfg->addSyntheticDeclStmt(DSNew, DS); 2585 2586 // Append the fake DeclStmt to block. 2587 B = VisitDeclSubExpr(DSNew); 2588 } 2589 2590 return B; 2591 } 2592 2593 /// VisitDeclSubExpr - Utility method to add block-level expressions for 2594 /// DeclStmts and initializers in them. 2595 CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) { 2596 assert(DS->isSingleDecl() && "Can handle single declarations only."); 2597 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl()); 2598 2599 if (!VD) { 2600 // Of everything that can be declared in a DeclStmt, only VarDecls impact 2601 // runtime semantics. 2602 return Block; 2603 } 2604 2605 bool HasTemporaries = false; 2606 2607 // Guard static initializers under a branch. 2608 CFGBlock *blockAfterStaticInit = nullptr; 2609 2610 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) { 2611 // For static variables, we need to create a branch to track 2612 // whether or not they are initialized. 2613 if (Block) { 2614 Succ = Block; 2615 Block = nullptr; 2616 if (badCFG) 2617 return nullptr; 2618 } 2619 blockAfterStaticInit = Succ; 2620 } 2621 2622 // Destructors of temporaries in initialization expression should be called 2623 // after initialization finishes. 2624 Expr *Init = VD->getInit(); 2625 if (Init) { 2626 HasTemporaries = isa<ExprWithCleanups>(Init); 2627 2628 if (BuildOpts.AddTemporaryDtors && HasTemporaries) { 2629 // Generate destructors for temporaries in initialization expression. 2630 TempDtorContext Context; 2631 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(), 2632 /*BindToTemporary=*/false, Context); 2633 } 2634 } 2635 2636 autoCreateBlock(); 2637 appendStmt(Block, DS); 2638 2639 findConstructionContexts( 2640 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS), 2641 Init); 2642 2643 // Keep track of the last non-null block, as 'Block' can be nulled out 2644 // if the initializer expression is something like a 'while' in a 2645 // statement-expression. 2646 CFGBlock *LastBlock = Block; 2647 2648 if (Init) { 2649 if (HasTemporaries) { 2650 // For expression with temporaries go directly to subexpression to omit 2651 // generating destructors for the second time. 2652 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init); 2653 if (CFGBlock *newBlock = Visit(EC->getSubExpr())) 2654 LastBlock = newBlock; 2655 } 2656 else { 2657 if (CFGBlock *newBlock = Visit(Init)) 2658 LastBlock = newBlock; 2659 } 2660 } 2661 2662 // If the type of VD is a VLA, then we must process its size expressions. 2663 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr()); 2664 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) { 2665 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr())) 2666 LastBlock = newBlock; 2667 } 2668 2669 maybeAddScopeBeginForVarDecl(Block, VD, DS); 2670 2671 // Remove variable from local scope. 2672 if (ScopePos && VD == *ScopePos) 2673 ++ScopePos; 2674 2675 CFGBlock *B = LastBlock; 2676 if (blockAfterStaticInit) { 2677 Succ = B; 2678 Block = createBlock(false); 2679 Block->setTerminator(DS); 2680 addSuccessor(Block, blockAfterStaticInit); 2681 addSuccessor(Block, B); 2682 B = Block; 2683 } 2684 2685 return B; 2686 } 2687 2688 CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) { 2689 // We may see an if statement in the middle of a basic block, or it may be the 2690 // first statement we are processing. In either case, we create a new basic 2691 // block. First, we create the blocks for the then...else statements, and 2692 // then we create the block containing the if statement. If we were in the 2693 // middle of a block, we stop processing that block. That block is then the 2694 // implicit successor for the "then" and "else" clauses. 2695 2696 // Save local scope position because in case of condition variable ScopePos 2697 // won't be restored when traversing AST. 2698 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 2699 2700 // Create local scope for C++17 if init-stmt if one exists. 2701 if (Stmt *Init = I->getInit()) 2702 addLocalScopeForStmt(Init); 2703 2704 // Create local scope for possible condition variable. 2705 // Store scope position. Add implicit destructor. 2706 if (VarDecl *VD = I->getConditionVariable()) 2707 addLocalScopeForVarDecl(VD); 2708 2709 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I); 2710 2711 // The block we were processing is now finished. Make it the successor 2712 // block. 2713 if (Block) { 2714 Succ = Block; 2715 if (badCFG) 2716 return nullptr; 2717 } 2718 2719 // Process the false branch. 2720 CFGBlock *ElseBlock = Succ; 2721 2722 if (Stmt *Else = I->getElse()) { 2723 SaveAndRestore<CFGBlock*> sv(Succ); 2724 2725 // NULL out Block so that the recursive call to Visit will 2726 // create a new basic block. 2727 Block = nullptr; 2728 2729 // If branch is not a compound statement create implicit scope 2730 // and add destructors. 2731 if (!isa<CompoundStmt>(Else)) 2732 addLocalScopeAndDtors(Else); 2733 2734 ElseBlock = addStmt(Else); 2735 2736 if (!ElseBlock) // Can occur when the Else body has all NullStmts. 2737 ElseBlock = sv.get(); 2738 else if (Block) { 2739 if (badCFG) 2740 return nullptr; 2741 } 2742 } 2743 2744 // Process the true branch. 2745 CFGBlock *ThenBlock; 2746 { 2747 Stmt *Then = I->getThen(); 2748 assert(Then); 2749 SaveAndRestore<CFGBlock*> sv(Succ); 2750 Block = nullptr; 2751 2752 // If branch is not a compound statement create implicit scope 2753 // and add destructors. 2754 if (!isa<CompoundStmt>(Then)) 2755 addLocalScopeAndDtors(Then); 2756 2757 ThenBlock = addStmt(Then); 2758 2759 if (!ThenBlock) { 2760 // We can reach here if the "then" body has all NullStmts. 2761 // Create an empty block so we can distinguish between true and false 2762 // branches in path-sensitive analyses. 2763 ThenBlock = createBlock(false); 2764 addSuccessor(ThenBlock, sv.get()); 2765 } else if (Block) { 2766 if (badCFG) 2767 return nullptr; 2768 } 2769 } 2770 2771 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by 2772 // having these handle the actual control-flow jump. Note that 2773 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)" 2774 // we resort to the old control-flow behavior. This special handling 2775 // removes infeasible paths from the control-flow graph by having the 2776 // control-flow transfer of '&&' or '||' go directly into the then/else 2777 // blocks directly. 2778 BinaryOperator *Cond = 2779 I->getConditionVariable() 2780 ? nullptr 2781 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens()); 2782 CFGBlock *LastBlock; 2783 if (Cond && Cond->isLogicalOp()) 2784 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first; 2785 else { 2786 // Now create a new block containing the if statement. 2787 Block = createBlock(false); 2788 2789 // Set the terminator of the new block to the If statement. 2790 Block->setTerminator(I); 2791 2792 // See if this is a known constant. 2793 const TryResult &KnownVal = tryEvaluateBool(I->getCond()); 2794 2795 // Add the successors. If we know that specific branches are 2796 // unreachable, inform addSuccessor() of that knowledge. 2797 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse()); 2798 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue()); 2799 2800 // Add the condition as the last statement in the new block. This may 2801 // create new blocks as the condition may contain control-flow. Any newly 2802 // created blocks will be pointed to be "Block". 2803 LastBlock = addStmt(I->getCond()); 2804 2805 // If the IfStmt contains a condition variable, add it and its 2806 // initializer to the CFG. 2807 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) { 2808 autoCreateBlock(); 2809 LastBlock = addStmt(const_cast<DeclStmt *>(DS)); 2810 } 2811 } 2812 2813 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG. 2814 if (Stmt *Init = I->getInit()) { 2815 autoCreateBlock(); 2816 LastBlock = addStmt(Init); 2817 } 2818 2819 return LastBlock; 2820 } 2821 2822 CFGBlock *CFGBuilder::VisitReturnStmt(ReturnStmt *R) { 2823 // If we were in the middle of a block we stop processing that block. 2824 // 2825 // NOTE: If a "return" appears in the middle of a block, this means that the 2826 // code afterwards is DEAD (unreachable). We still keep a basic block 2827 // for that code; a simple "mark-and-sweep" from the entry block will be 2828 // able to report such dead blocks. 2829 2830 // Create the new block. 2831 Block = createBlock(false); 2832 2833 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), R); 2834 2835 findConstructionContexts( 2836 ConstructionContextLayer::create(cfg->getBumpVectorContext(), R), 2837 R->getRetValue()); 2838 2839 // If the one of the destructors does not return, we already have the Exit 2840 // block as a successor. 2841 if (!Block->hasNoReturnElement()) 2842 addSuccessor(Block, &cfg->getExit()); 2843 2844 // Add the return statement to the block. This may create new blocks if R 2845 // contains control-flow (short-circuit operations). 2846 return VisitStmt(R, AddStmtChoice::AlwaysAdd); 2847 } 2848 2849 CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) { 2850 // SEHExceptStmt are treated like labels, so they are the first statement in a 2851 // block. 2852 2853 // Save local scope position because in case of exception variable ScopePos 2854 // won't be restored when traversing AST. 2855 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 2856 2857 addStmt(ES->getBlock()); 2858 CFGBlock *SEHExceptBlock = Block; 2859 if (!SEHExceptBlock) 2860 SEHExceptBlock = createBlock(); 2861 2862 appendStmt(SEHExceptBlock, ES); 2863 2864 // Also add the SEHExceptBlock as a label, like with regular labels. 2865 SEHExceptBlock->setLabel(ES); 2866 2867 // Bail out if the CFG is bad. 2868 if (badCFG) 2869 return nullptr; 2870 2871 // We set Block to NULL to allow lazy creation of a new block (if necessary). 2872 Block = nullptr; 2873 2874 return SEHExceptBlock; 2875 } 2876 2877 CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) { 2878 return VisitCompoundStmt(FS->getBlock()); 2879 } 2880 2881 CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) { 2882 // "__leave" is a control-flow statement. Thus we stop processing the current 2883 // block. 2884 if (badCFG) 2885 return nullptr; 2886 2887 // Now create a new block that ends with the __leave statement. 2888 Block = createBlock(false); 2889 Block->setTerminator(LS); 2890 2891 // If there is no target for the __leave, then we are looking at an incomplete 2892 // AST. This means that the CFG cannot be constructed. 2893 if (SEHLeaveJumpTarget.block) { 2894 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS); 2895 addSuccessor(Block, SEHLeaveJumpTarget.block); 2896 } else 2897 badCFG = true; 2898 2899 return Block; 2900 } 2901 2902 CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) { 2903 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop 2904 // processing the current block. 2905 CFGBlock *SEHTrySuccessor = nullptr; 2906 2907 if (Block) { 2908 if (badCFG) 2909 return nullptr; 2910 SEHTrySuccessor = Block; 2911 } else SEHTrySuccessor = Succ; 2912 2913 // FIXME: Implement __finally support. 2914 if (Terminator->getFinallyHandler()) 2915 return NYS(); 2916 2917 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock; 2918 2919 // Create a new block that will contain the __try statement. 2920 CFGBlock *NewTryTerminatedBlock = createBlock(false); 2921 2922 // Add the terminator in the __try block. 2923 NewTryTerminatedBlock->setTerminator(Terminator); 2924 2925 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) { 2926 // The code after the try is the implicit successor if there's an __except. 2927 Succ = SEHTrySuccessor; 2928 Block = nullptr; 2929 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except); 2930 if (!ExceptBlock) 2931 return nullptr; 2932 // Add this block to the list of successors for the block with the try 2933 // statement. 2934 addSuccessor(NewTryTerminatedBlock, ExceptBlock); 2935 } 2936 if (PrevSEHTryTerminatedBlock) 2937 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock); 2938 else 2939 addSuccessor(NewTryTerminatedBlock, &cfg->getExit()); 2940 2941 // The code after the try is the implicit successor. 2942 Succ = SEHTrySuccessor; 2943 2944 // Save the current "__try" context. 2945 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock, 2946 NewTryTerminatedBlock); 2947 cfg->addTryDispatchBlock(TryTerminatedBlock); 2948 2949 // Save the current value for the __leave target. 2950 // All __leaves should go to the code following the __try 2951 // (FIXME: or if the __try has a __finally, to the __finally.) 2952 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget); 2953 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos); 2954 2955 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body"); 2956 Block = nullptr; 2957 return addStmt(Terminator->getTryBlock()); 2958 } 2959 2960 CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) { 2961 // Get the block of the labeled statement. Add it to our map. 2962 addStmt(L->getSubStmt()); 2963 CFGBlock *LabelBlock = Block; 2964 2965 if (!LabelBlock) // This can happen when the body is empty, i.e. 2966 LabelBlock = createBlock(); // scopes that only contains NullStmts. 2967 2968 assert(LabelMap.find(L->getDecl()) == LabelMap.end() && 2969 "label already in map"); 2970 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos); 2971 2972 // Labels partition blocks, so this is the end of the basic block we were 2973 // processing (L is the block's label). Because this is label (and we have 2974 // already processed the substatement) there is no extra control-flow to worry 2975 // about. 2976 LabelBlock->setLabel(L); 2977 if (badCFG) 2978 return nullptr; 2979 2980 // We set Block to NULL to allow lazy creation of a new block (if necessary); 2981 Block = nullptr; 2982 2983 // This block is now the implicit successor of other blocks. 2984 Succ = LabelBlock; 2985 2986 return LabelBlock; 2987 } 2988 2989 CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) { 2990 CFGBlock *LastBlock = VisitNoRecurse(E, asc); 2991 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) { 2992 if (Expr *CopyExpr = CI.getCopyExpr()) { 2993 CFGBlock *Tmp = Visit(CopyExpr); 2994 if (Tmp) 2995 LastBlock = Tmp; 2996 } 2997 } 2998 return LastBlock; 2999 } 3000 3001 CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) { 3002 CFGBlock *LastBlock = VisitNoRecurse(E, asc); 3003 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(), 3004 et = E->capture_init_end(); it != et; ++it) { 3005 if (Expr *Init = *it) { 3006 CFGBlock *Tmp = Visit(Init); 3007 if (Tmp) 3008 LastBlock = Tmp; 3009 } 3010 } 3011 return LastBlock; 3012 } 3013 3014 CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) { 3015 // Goto is a control-flow statement. Thus we stop processing the current 3016 // block and create a new one. 3017 3018 Block = createBlock(false); 3019 Block->setTerminator(G); 3020 3021 // If we already know the mapping to the label block add the successor now. 3022 LabelMapTy::iterator I = LabelMap.find(G->getLabel()); 3023 3024 if (I == LabelMap.end()) 3025 // We will need to backpatch this block later. 3026 BackpatchBlocks.push_back(JumpSource(Block, ScopePos)); 3027 else { 3028 JumpTarget JT = I->second; 3029 addAutomaticObjHandling(ScopePos, JT.scopePosition, G); 3030 addSuccessor(Block, JT.block); 3031 } 3032 3033 return Block; 3034 } 3035 3036 CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) { 3037 CFGBlock *LoopSuccessor = nullptr; 3038 3039 // Save local scope position because in case of condition variable ScopePos 3040 // won't be restored when traversing AST. 3041 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 3042 3043 // Create local scope for init statement and possible condition variable. 3044 // Add destructor for init statement and condition variable. 3045 // Store scope position for continue statement. 3046 if (Stmt *Init = F->getInit()) 3047 addLocalScopeForStmt(Init); 3048 LocalScope::const_iterator LoopBeginScopePos = ScopePos; 3049 3050 if (VarDecl *VD = F->getConditionVariable()) 3051 addLocalScopeForVarDecl(VD); 3052 LocalScope::const_iterator ContinueScopePos = ScopePos; 3053 3054 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F); 3055 3056 addLoopExit(F); 3057 3058 // "for" is a control-flow statement. Thus we stop processing the current 3059 // block. 3060 if (Block) { 3061 if (badCFG) 3062 return nullptr; 3063 LoopSuccessor = Block; 3064 } else 3065 LoopSuccessor = Succ; 3066 3067 // Save the current value for the break targets. 3068 // All breaks should go to the code following the loop. 3069 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget); 3070 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos); 3071 3072 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr; 3073 3074 // Now create the loop body. 3075 { 3076 assert(F->getBody()); 3077 3078 // Save the current values for Block, Succ, continue and break targets. 3079 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ); 3080 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget); 3081 3082 // Create an empty block to represent the transition block for looping back 3083 // to the head of the loop. If we have increment code, it will 3084 // go in this block as well. 3085 Block = Succ = TransitionBlock = createBlock(false); 3086 TransitionBlock->setLoopTarget(F); 3087 3088 if (Stmt *I = F->getInc()) { 3089 // Generate increment code in its own basic block. This is the target of 3090 // continue statements. 3091 Succ = addStmt(I); 3092 } 3093 3094 // Finish up the increment (or empty) block if it hasn't been already. 3095 if (Block) { 3096 assert(Block == Succ); 3097 if (badCFG) 3098 return nullptr; 3099 Block = nullptr; 3100 } 3101 3102 // The starting block for the loop increment is the block that should 3103 // represent the 'loop target' for looping back to the start of the loop. 3104 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos); 3105 ContinueJumpTarget.block->setLoopTarget(F); 3106 3107 // Loop body should end with destructor of Condition variable (if any). 3108 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F); 3109 3110 // If body is not a compound statement create implicit scope 3111 // and add destructors. 3112 if (!isa<CompoundStmt>(F->getBody())) 3113 addLocalScopeAndDtors(F->getBody()); 3114 3115 // Now populate the body block, and in the process create new blocks as we 3116 // walk the body of the loop. 3117 BodyBlock = addStmt(F->getBody()); 3118 3119 if (!BodyBlock) { 3120 // In the case of "for (...;...;...);" we can have a null BodyBlock. 3121 // Use the continue jump target as the proxy for the body. 3122 BodyBlock = ContinueJumpTarget.block; 3123 } 3124 else if (badCFG) 3125 return nullptr; 3126 } 3127 3128 // Because of short-circuit evaluation, the condition of the loop can span 3129 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that 3130 // evaluate the condition. 3131 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr; 3132 3133 do { 3134 Expr *C = F->getCond(); 3135 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 3136 3137 // Specially handle logical operators, which have a slightly 3138 // more optimal CFG representation. 3139 if (BinaryOperator *Cond = 3140 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr)) 3141 if (Cond->isLogicalOp()) { 3142 std::tie(EntryConditionBlock, ExitConditionBlock) = 3143 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor); 3144 break; 3145 } 3146 3147 // The default case when not handling logical operators. 3148 EntryConditionBlock = ExitConditionBlock = createBlock(false); 3149 ExitConditionBlock->setTerminator(F); 3150 3151 // See if this is a known constant. 3152 TryResult KnownVal(true); 3153 3154 if (C) { 3155 // Now add the actual condition to the condition block. 3156 // Because the condition itself may contain control-flow, new blocks may 3157 // be created. Thus we update "Succ" after adding the condition. 3158 Block = ExitConditionBlock; 3159 EntryConditionBlock = addStmt(C); 3160 3161 // If this block contains a condition variable, add both the condition 3162 // variable and initializer to the CFG. 3163 if (VarDecl *VD = F->getConditionVariable()) { 3164 if (Expr *Init = VD->getInit()) { 3165 autoCreateBlock(); 3166 const DeclStmt *DS = F->getConditionVariableDeclStmt(); 3167 assert(DS->isSingleDecl()); 3168 findConstructionContexts( 3169 ConstructionContextLayer::create(cfg->getBumpVectorContext(), 3170 const_cast<DeclStmt *>(DS)), 3171 Init); 3172 appendStmt(Block, DS); 3173 EntryConditionBlock = addStmt(Init); 3174 assert(Block == EntryConditionBlock); 3175 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C); 3176 } 3177 } 3178 3179 if (Block && badCFG) 3180 return nullptr; 3181 3182 KnownVal = tryEvaluateBool(C); 3183 } 3184 3185 // Add the loop body entry as a successor to the condition. 3186 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock); 3187 // Link up the condition block with the code that follows the loop. (the 3188 // false branch). 3189 addSuccessor(ExitConditionBlock, 3190 KnownVal.isTrue() ? nullptr : LoopSuccessor); 3191 } while (false); 3192 3193 // Link up the loop-back block to the entry condition block. 3194 addSuccessor(TransitionBlock, EntryConditionBlock); 3195 3196 // The condition block is the implicit successor for any code above the loop. 3197 Succ = EntryConditionBlock; 3198 3199 // If the loop contains initialization, create a new block for those 3200 // statements. This block can also contain statements that precede the loop. 3201 if (Stmt *I = F->getInit()) { 3202 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 3203 ScopePos = LoopBeginScopePos; 3204 Block = createBlock(); 3205 return addStmt(I); 3206 } 3207 3208 // There is no loop initialization. We are thus basically a while loop. 3209 // NULL out Block to force lazy block construction. 3210 Block = nullptr; 3211 Succ = EntryConditionBlock; 3212 return EntryConditionBlock; 3213 } 3214 3215 CFGBlock * 3216 CFGBuilder::VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE, 3217 AddStmtChoice asc) { 3218 findConstructionContexts( 3219 ConstructionContextLayer::create(cfg->getBumpVectorContext(), MTE), 3220 MTE->getTemporary()); 3221 3222 return VisitStmt(MTE, asc); 3223 } 3224 3225 CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) { 3226 if (asc.alwaysAdd(*this, M)) { 3227 autoCreateBlock(); 3228 appendStmt(Block, M); 3229 } 3230 return Visit(M->getBase()); 3231 } 3232 3233 CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) { 3234 // Objective-C fast enumeration 'for' statements: 3235 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC 3236 // 3237 // for ( Type newVariable in collection_expression ) { statements } 3238 // 3239 // becomes: 3240 // 3241 // prologue: 3242 // 1. collection_expression 3243 // T. jump to loop_entry 3244 // loop_entry: 3245 // 1. side-effects of element expression 3246 // 1. ObjCForCollectionStmt [performs binding to newVariable] 3247 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil] 3248 // TB: 3249 // statements 3250 // T. jump to loop_entry 3251 // FB: 3252 // what comes after 3253 // 3254 // and 3255 // 3256 // Type existingItem; 3257 // for ( existingItem in expression ) { statements } 3258 // 3259 // becomes: 3260 // 3261 // the same with newVariable replaced with existingItem; the binding works 3262 // the same except that for one ObjCForCollectionStmt::getElement() returns 3263 // a DeclStmt and the other returns a DeclRefExpr. 3264 3265 CFGBlock *LoopSuccessor = nullptr; 3266 3267 if (Block) { 3268 if (badCFG) 3269 return nullptr; 3270 LoopSuccessor = Block; 3271 Block = nullptr; 3272 } else 3273 LoopSuccessor = Succ; 3274 3275 // Build the condition blocks. 3276 CFGBlock *ExitConditionBlock = createBlock(false); 3277 3278 // Set the terminator for the "exit" condition block. 3279 ExitConditionBlock->setTerminator(S); 3280 3281 // The last statement in the block should be the ObjCForCollectionStmt, which 3282 // performs the actual binding to 'element' and determines if there are any 3283 // more items in the collection. 3284 appendStmt(ExitConditionBlock, S); 3285 Block = ExitConditionBlock; 3286 3287 // Walk the 'element' expression to see if there are any side-effects. We 3288 // generate new blocks as necessary. We DON'T add the statement by default to 3289 // the CFG unless it contains control-flow. 3290 CFGBlock *EntryConditionBlock = Visit(S->getElement(), 3291 AddStmtChoice::NotAlwaysAdd); 3292 if (Block) { 3293 if (badCFG) 3294 return nullptr; 3295 Block = nullptr; 3296 } 3297 3298 // The condition block is the implicit successor for the loop body as well as 3299 // any code above the loop. 3300 Succ = EntryConditionBlock; 3301 3302 // Now create the true branch. 3303 { 3304 // Save the current values for Succ, continue and break targets. 3305 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ); 3306 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget), 3307 save_break(BreakJumpTarget); 3308 3309 // Add an intermediate block between the BodyBlock and the 3310 // EntryConditionBlock to represent the "loop back" transition, for looping 3311 // back to the head of the loop. 3312 CFGBlock *LoopBackBlock = nullptr; 3313 Succ = LoopBackBlock = createBlock(); 3314 LoopBackBlock->setLoopTarget(S); 3315 3316 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos); 3317 ContinueJumpTarget = JumpTarget(Succ, ScopePos); 3318 3319 CFGBlock *BodyBlock = addStmt(S->getBody()); 3320 3321 if (!BodyBlock) 3322 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;" 3323 else if (Block) { 3324 if (badCFG) 3325 return nullptr; 3326 } 3327 3328 // This new body block is a successor to our "exit" condition block. 3329 addSuccessor(ExitConditionBlock, BodyBlock); 3330 } 3331 3332 // Link up the condition block with the code that follows the loop. 3333 // (the false branch). 3334 addSuccessor(ExitConditionBlock, LoopSuccessor); 3335 3336 // Now create a prologue block to contain the collection expression. 3337 Block = createBlock(); 3338 return addStmt(S->getCollection()); 3339 } 3340 3341 CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) { 3342 // Inline the body. 3343 return addStmt(S->getSubStmt()); 3344 // TODO: consider adding cleanups for the end of @autoreleasepool scope. 3345 } 3346 3347 CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) { 3348 // FIXME: Add locking 'primitives' to CFG for @synchronized. 3349 3350 // Inline the body. 3351 CFGBlock *SyncBlock = addStmt(S->getSynchBody()); 3352 3353 // The sync body starts its own basic block. This makes it a little easier 3354 // for diagnostic clients. 3355 if (SyncBlock) { 3356 if (badCFG) 3357 return nullptr; 3358 3359 Block = nullptr; 3360 Succ = SyncBlock; 3361 } 3362 3363 // Add the @synchronized to the CFG. 3364 autoCreateBlock(); 3365 appendStmt(Block, S); 3366 3367 // Inline the sync expression. 3368 return addStmt(S->getSynchExpr()); 3369 } 3370 3371 CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) { 3372 // FIXME 3373 return NYS(); 3374 } 3375 3376 CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) { 3377 autoCreateBlock(); 3378 3379 // Add the PseudoObject as the last thing. 3380 appendStmt(Block, E); 3381 3382 CFGBlock *lastBlock = Block; 3383 3384 // Before that, evaluate all of the semantics in order. In 3385 // CFG-land, that means appending them in reverse order. 3386 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) { 3387 Expr *Semantic = E->getSemanticExpr(--i); 3388 3389 // If the semantic is an opaque value, we're being asked to bind 3390 // it to its source expression. 3391 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic)) 3392 Semantic = OVE->getSourceExpr(); 3393 3394 if (CFGBlock *B = Visit(Semantic)) 3395 lastBlock = B; 3396 } 3397 3398 return lastBlock; 3399 } 3400 3401 CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) { 3402 CFGBlock *LoopSuccessor = nullptr; 3403 3404 // Save local scope position because in case of condition variable ScopePos 3405 // won't be restored when traversing AST. 3406 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 3407 3408 // Create local scope for possible condition variable. 3409 // Store scope position for continue statement. 3410 LocalScope::const_iterator LoopBeginScopePos = ScopePos; 3411 if (VarDecl *VD = W->getConditionVariable()) { 3412 addLocalScopeForVarDecl(VD); 3413 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W); 3414 } 3415 addLoopExit(W); 3416 3417 // "while" is a control-flow statement. Thus we stop processing the current 3418 // block. 3419 if (Block) { 3420 if (badCFG) 3421 return nullptr; 3422 LoopSuccessor = Block; 3423 Block = nullptr; 3424 } else { 3425 LoopSuccessor = Succ; 3426 } 3427 3428 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr; 3429 3430 // Process the loop body. 3431 { 3432 assert(W->getBody()); 3433 3434 // Save the current values for Block, Succ, continue and break targets. 3435 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ); 3436 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget), 3437 save_break(BreakJumpTarget); 3438 3439 // Create an empty block to represent the transition block for looping back 3440 // to the head of the loop. 3441 Succ = TransitionBlock = createBlock(false); 3442 TransitionBlock->setLoopTarget(W); 3443 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos); 3444 3445 // All breaks should go to the code following the loop. 3446 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos); 3447 3448 // Loop body should end with destructor of Condition variable (if any). 3449 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W); 3450 3451 // If body is not a compound statement create implicit scope 3452 // and add destructors. 3453 if (!isa<CompoundStmt>(W->getBody())) 3454 addLocalScopeAndDtors(W->getBody()); 3455 3456 // Create the body. The returned block is the entry to the loop body. 3457 BodyBlock = addStmt(W->getBody()); 3458 3459 if (!BodyBlock) 3460 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;" 3461 else if (Block && badCFG) 3462 return nullptr; 3463 } 3464 3465 // Because of short-circuit evaluation, the condition of the loop can span 3466 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that 3467 // evaluate the condition. 3468 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr; 3469 3470 do { 3471 Expr *C = W->getCond(); 3472 3473 // Specially handle logical operators, which have a slightly 3474 // more optimal CFG representation. 3475 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens())) 3476 if (Cond->isLogicalOp()) { 3477 std::tie(EntryConditionBlock, ExitConditionBlock) = 3478 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor); 3479 break; 3480 } 3481 3482 // The default case when not handling logical operators. 3483 ExitConditionBlock = createBlock(false); 3484 ExitConditionBlock->setTerminator(W); 3485 3486 // Now add the actual condition to the condition block. 3487 // Because the condition itself may contain control-flow, new blocks may 3488 // be created. Thus we update "Succ" after adding the condition. 3489 Block = ExitConditionBlock; 3490 Block = EntryConditionBlock = addStmt(C); 3491 3492 // If this block contains a condition variable, add both the condition 3493 // variable and initializer to the CFG. 3494 if (VarDecl *VD = W->getConditionVariable()) { 3495 if (Expr *Init = VD->getInit()) { 3496 autoCreateBlock(); 3497 const DeclStmt *DS = W->getConditionVariableDeclStmt(); 3498 assert(DS->isSingleDecl()); 3499 findConstructionContexts( 3500 ConstructionContextLayer::create(cfg->getBumpVectorContext(), 3501 const_cast<DeclStmt *>(DS)), 3502 Init); 3503 appendStmt(Block, DS); 3504 EntryConditionBlock = addStmt(Init); 3505 assert(Block == EntryConditionBlock); 3506 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C); 3507 } 3508 } 3509 3510 if (Block && badCFG) 3511 return nullptr; 3512 3513 // See if this is a known constant. 3514 const TryResult& KnownVal = tryEvaluateBool(C); 3515 3516 // Add the loop body entry as a successor to the condition. 3517 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock); 3518 // Link up the condition block with the code that follows the loop. (the 3519 // false branch). 3520 addSuccessor(ExitConditionBlock, 3521 KnownVal.isTrue() ? nullptr : LoopSuccessor); 3522 } while(false); 3523 3524 // Link up the loop-back block to the entry condition block. 3525 addSuccessor(TransitionBlock, EntryConditionBlock); 3526 3527 // There can be no more statements in the condition block since we loop back 3528 // to this block. NULL out Block to force lazy creation of another block. 3529 Block = nullptr; 3530 3531 // Return the condition block, which is the dominating block for the loop. 3532 Succ = EntryConditionBlock; 3533 return EntryConditionBlock; 3534 } 3535 3536 CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) { 3537 // FIXME: For now we pretend that @catch and the code it contains does not 3538 // exit. 3539 return Block; 3540 } 3541 3542 CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) { 3543 // FIXME: This isn't complete. We basically treat @throw like a return 3544 // statement. 3545 3546 // If we were in the middle of a block we stop processing that block. 3547 if (badCFG) 3548 return nullptr; 3549 3550 // Create the new block. 3551 Block = createBlock(false); 3552 3553 // The Exit block is the only successor. 3554 addSuccessor(Block, &cfg->getExit()); 3555 3556 // Add the statement to the block. This may create new blocks if S contains 3557 // control-flow (short-circuit operations). 3558 return VisitStmt(S, AddStmtChoice::AlwaysAdd); 3559 } 3560 3561 CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) { 3562 // If we were in the middle of a block we stop processing that block. 3563 if (badCFG) 3564 return nullptr; 3565 3566 // Create the new block. 3567 Block = createBlock(false); 3568 3569 if (TryTerminatedBlock) 3570 // The current try statement is the only successor. 3571 addSuccessor(Block, TryTerminatedBlock); 3572 else 3573 // otherwise the Exit block is the only successor. 3574 addSuccessor(Block, &cfg->getExit()); 3575 3576 // Add the statement to the block. This may create new blocks if S contains 3577 // control-flow (short-circuit operations). 3578 return VisitStmt(T, AddStmtChoice::AlwaysAdd); 3579 } 3580 3581 CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) { 3582 CFGBlock *LoopSuccessor = nullptr; 3583 3584 addLoopExit(D); 3585 3586 // "do...while" is a control-flow statement. Thus we stop processing the 3587 // current block. 3588 if (Block) { 3589 if (badCFG) 3590 return nullptr; 3591 LoopSuccessor = Block; 3592 } else 3593 LoopSuccessor = Succ; 3594 3595 // Because of short-circuit evaluation, the condition of the loop can span 3596 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that 3597 // evaluate the condition. 3598 CFGBlock *ExitConditionBlock = createBlock(false); 3599 CFGBlock *EntryConditionBlock = ExitConditionBlock; 3600 3601 // Set the terminator for the "exit" condition block. 3602 ExitConditionBlock->setTerminator(D); 3603 3604 // Now add the actual condition to the condition block. Because the condition 3605 // itself may contain control-flow, new blocks may be created. 3606 if (Stmt *C = D->getCond()) { 3607 Block = ExitConditionBlock; 3608 EntryConditionBlock = addStmt(C); 3609 if (Block) { 3610 if (badCFG) 3611 return nullptr; 3612 } 3613 } 3614 3615 // The condition block is the implicit successor for the loop body. 3616 Succ = EntryConditionBlock; 3617 3618 // See if this is a known constant. 3619 const TryResult &KnownVal = tryEvaluateBool(D->getCond()); 3620 3621 // Process the loop body. 3622 CFGBlock *BodyBlock = nullptr; 3623 { 3624 assert(D->getBody()); 3625 3626 // Save the current values for Block, Succ, and continue and break targets 3627 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ); 3628 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget), 3629 save_break(BreakJumpTarget); 3630 3631 // All continues within this loop should go to the condition block 3632 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos); 3633 3634 // All breaks should go to the code following the loop. 3635 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos); 3636 3637 // NULL out Block to force lazy instantiation of blocks for the body. 3638 Block = nullptr; 3639 3640 // If body is not a compound statement create implicit scope 3641 // and add destructors. 3642 if (!isa<CompoundStmt>(D->getBody())) 3643 addLocalScopeAndDtors(D->getBody()); 3644 3645 // Create the body. The returned block is the entry to the loop body. 3646 BodyBlock = addStmt(D->getBody()); 3647 3648 if (!BodyBlock) 3649 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)" 3650 else if (Block) { 3651 if (badCFG) 3652 return nullptr; 3653 } 3654 3655 // Add an intermediate block between the BodyBlock and the 3656 // ExitConditionBlock to represent the "loop back" transition. Create an 3657 // empty block to represent the transition block for looping back to the 3658 // head of the loop. 3659 // FIXME: Can we do this more efficiently without adding another block? 3660 Block = nullptr; 3661 Succ = BodyBlock; 3662 CFGBlock *LoopBackBlock = createBlock(); 3663 LoopBackBlock->setLoopTarget(D); 3664 3665 if (!KnownVal.isFalse()) 3666 // Add the loop body entry as a successor to the condition. 3667 addSuccessor(ExitConditionBlock, LoopBackBlock); 3668 else 3669 addSuccessor(ExitConditionBlock, nullptr); 3670 } 3671 3672 // Link up the condition block with the code that follows the loop. 3673 // (the false branch). 3674 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor); 3675 3676 // There can be no more statements in the body block(s) since we loop back to 3677 // the body. NULL out Block to force lazy creation of another block. 3678 Block = nullptr; 3679 3680 // Return the loop body, which is the dominating block for the loop. 3681 Succ = BodyBlock; 3682 return BodyBlock; 3683 } 3684 3685 CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) { 3686 // "continue" is a control-flow statement. Thus we stop processing the 3687 // current block. 3688 if (badCFG) 3689 return nullptr; 3690 3691 // Now create a new block that ends with the continue statement. 3692 Block = createBlock(false); 3693 Block->setTerminator(C); 3694 3695 // If there is no target for the continue, then we are looking at an 3696 // incomplete AST. This means the CFG cannot be constructed. 3697 if (ContinueJumpTarget.block) { 3698 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C); 3699 addSuccessor(Block, ContinueJumpTarget.block); 3700 } else 3701 badCFG = true; 3702 3703 return Block; 3704 } 3705 3706 CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E, 3707 AddStmtChoice asc) { 3708 if (asc.alwaysAdd(*this, E)) { 3709 autoCreateBlock(); 3710 appendStmt(Block, E); 3711 } 3712 3713 // VLA types have expressions that must be evaluated. 3714 CFGBlock *lastBlock = Block; 3715 3716 if (E->isArgumentType()) { 3717 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr()); 3718 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) 3719 lastBlock = addStmt(VA->getSizeExpr()); 3720 } 3721 return lastBlock; 3722 } 3723 3724 /// VisitStmtExpr - Utility method to handle (nested) statement 3725 /// expressions (a GCC extension). 3726 CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) { 3727 if (asc.alwaysAdd(*this, SE)) { 3728 autoCreateBlock(); 3729 appendStmt(Block, SE); 3730 } 3731 return VisitCompoundStmt(SE->getSubStmt()); 3732 } 3733 3734 CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) { 3735 // "switch" is a control-flow statement. Thus we stop processing the current 3736 // block. 3737 CFGBlock *SwitchSuccessor = nullptr; 3738 3739 // Save local scope position because in case of condition variable ScopePos 3740 // won't be restored when traversing AST. 3741 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 3742 3743 // Create local scope for C++17 switch init-stmt if one exists. 3744 if (Stmt *Init = Terminator->getInit()) 3745 addLocalScopeForStmt(Init); 3746 3747 // Create local scope for possible condition variable. 3748 // Store scope position. Add implicit destructor. 3749 if (VarDecl *VD = Terminator->getConditionVariable()) 3750 addLocalScopeForVarDecl(VD); 3751 3752 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator); 3753 3754 if (Block) { 3755 if (badCFG) 3756 return nullptr; 3757 SwitchSuccessor = Block; 3758 } else SwitchSuccessor = Succ; 3759 3760 // Save the current "switch" context. 3761 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock), 3762 save_default(DefaultCaseBlock); 3763 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget); 3764 3765 // Set the "default" case to be the block after the switch statement. If the 3766 // switch statement contains a "default:", this value will be overwritten with 3767 // the block for that code. 3768 DefaultCaseBlock = SwitchSuccessor; 3769 3770 // Create a new block that will contain the switch statement. 3771 SwitchTerminatedBlock = createBlock(false); 3772 3773 // Now process the switch body. The code after the switch is the implicit 3774 // successor. 3775 Succ = SwitchSuccessor; 3776 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos); 3777 3778 // When visiting the body, the case statements should automatically get linked 3779 // up to the switch. We also don't keep a pointer to the body, since all 3780 // control-flow from the switch goes to case/default statements. 3781 assert(Terminator->getBody() && "switch must contain a non-NULL body"); 3782 Block = nullptr; 3783 3784 // For pruning unreachable case statements, save the current state 3785 // for tracking the condition value. 3786 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered, 3787 false); 3788 3789 // Determine if the switch condition can be explicitly evaluated. 3790 assert(Terminator->getCond() && "switch condition must be non-NULL"); 3791 Expr::EvalResult result; 3792 bool b = tryEvaluate(Terminator->getCond(), result); 3793 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond, 3794 b ? &result : nullptr); 3795 3796 // If body is not a compound statement create implicit scope 3797 // and add destructors. 3798 if (!isa<CompoundStmt>(Terminator->getBody())) 3799 addLocalScopeAndDtors(Terminator->getBody()); 3800 3801 addStmt(Terminator->getBody()); 3802 if (Block) { 3803 if (badCFG) 3804 return nullptr; 3805 } 3806 3807 // If we have no "default:" case, the default transition is to the code 3808 // following the switch body. Moreover, take into account if all the 3809 // cases of a switch are covered (e.g., switching on an enum value). 3810 // 3811 // Note: We add a successor to a switch that is considered covered yet has no 3812 // case statements if the enumeration has no enumerators. 3813 bool SwitchAlwaysHasSuccessor = false; 3814 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered; 3815 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() && 3816 Terminator->getSwitchCaseList(); 3817 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock, 3818 !SwitchAlwaysHasSuccessor); 3819 3820 // Add the terminator and condition in the switch block. 3821 SwitchTerminatedBlock->setTerminator(Terminator); 3822 Block = SwitchTerminatedBlock; 3823 CFGBlock *LastBlock = addStmt(Terminator->getCond()); 3824 3825 // If the SwitchStmt contains a condition variable, add both the 3826 // SwitchStmt and the condition variable initialization to the CFG. 3827 if (VarDecl *VD = Terminator->getConditionVariable()) { 3828 if (Expr *Init = VD->getInit()) { 3829 autoCreateBlock(); 3830 appendStmt(Block, Terminator->getConditionVariableDeclStmt()); 3831 LastBlock = addStmt(Init); 3832 maybeAddScopeBeginForVarDecl(LastBlock, VD, Init); 3833 } 3834 } 3835 3836 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG. 3837 if (Stmt *Init = Terminator->getInit()) { 3838 autoCreateBlock(); 3839 LastBlock = addStmt(Init); 3840 } 3841 3842 return LastBlock; 3843 } 3844 3845 static bool shouldAddCase(bool &switchExclusivelyCovered, 3846 const Expr::EvalResult *switchCond, 3847 const CaseStmt *CS, 3848 ASTContext &Ctx) { 3849 if (!switchCond) 3850 return true; 3851 3852 bool addCase = false; 3853 3854 if (!switchExclusivelyCovered) { 3855 if (switchCond->Val.isInt()) { 3856 // Evaluate the LHS of the case value. 3857 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx); 3858 const llvm::APSInt &condInt = switchCond->Val.getInt(); 3859 3860 if (condInt == lhsInt) { 3861 addCase = true; 3862 switchExclusivelyCovered = true; 3863 } 3864 else if (condInt > lhsInt) { 3865 if (const Expr *RHS = CS->getRHS()) { 3866 // Evaluate the RHS of the case value. 3867 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx); 3868 if (V2 >= condInt) { 3869 addCase = true; 3870 switchExclusivelyCovered = true; 3871 } 3872 } 3873 } 3874 } 3875 else 3876 addCase = true; 3877 } 3878 return addCase; 3879 } 3880 3881 CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) { 3882 // CaseStmts are essentially labels, so they are the first statement in a 3883 // block. 3884 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr; 3885 3886 if (Stmt *Sub = CS->getSubStmt()) { 3887 // For deeply nested chains of CaseStmts, instead of doing a recursion 3888 // (which can blow out the stack), manually unroll and create blocks 3889 // along the way. 3890 while (isa<CaseStmt>(Sub)) { 3891 CFGBlock *currentBlock = createBlock(false); 3892 currentBlock->setLabel(CS); 3893 3894 if (TopBlock) 3895 addSuccessor(LastBlock, currentBlock); 3896 else 3897 TopBlock = currentBlock; 3898 3899 addSuccessor(SwitchTerminatedBlock, 3900 shouldAddCase(switchExclusivelyCovered, switchCond, 3901 CS, *Context) 3902 ? currentBlock : nullptr); 3903 3904 LastBlock = currentBlock; 3905 CS = cast<CaseStmt>(Sub); 3906 Sub = CS->getSubStmt(); 3907 } 3908 3909 addStmt(Sub); 3910 } 3911 3912 CFGBlock *CaseBlock = Block; 3913 if (!CaseBlock) 3914 CaseBlock = createBlock(); 3915 3916 // Cases statements partition blocks, so this is the top of the basic block we 3917 // were processing (the "case XXX:" is the label). 3918 CaseBlock->setLabel(CS); 3919 3920 if (badCFG) 3921 return nullptr; 3922 3923 // Add this block to the list of successors for the block with the switch 3924 // statement. 3925 assert(SwitchTerminatedBlock); 3926 addSuccessor(SwitchTerminatedBlock, CaseBlock, 3927 shouldAddCase(switchExclusivelyCovered, switchCond, 3928 CS, *Context)); 3929 3930 // We set Block to NULL to allow lazy creation of a new block (if necessary) 3931 Block = nullptr; 3932 3933 if (TopBlock) { 3934 addSuccessor(LastBlock, CaseBlock); 3935 Succ = TopBlock; 3936 } else { 3937 // This block is now the implicit successor of other blocks. 3938 Succ = CaseBlock; 3939 } 3940 3941 return Succ; 3942 } 3943 3944 CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) { 3945 if (Terminator->getSubStmt()) 3946 addStmt(Terminator->getSubStmt()); 3947 3948 DefaultCaseBlock = Block; 3949 3950 if (!DefaultCaseBlock) 3951 DefaultCaseBlock = createBlock(); 3952 3953 // Default statements partition blocks, so this is the top of the basic block 3954 // we were processing (the "default:" is the label). 3955 DefaultCaseBlock->setLabel(Terminator); 3956 3957 if (badCFG) 3958 return nullptr; 3959 3960 // Unlike case statements, we don't add the default block to the successors 3961 // for the switch statement immediately. This is done when we finish 3962 // processing the switch statement. This allows for the default case 3963 // (including a fall-through to the code after the switch statement) to always 3964 // be the last successor of a switch-terminated block. 3965 3966 // We set Block to NULL to allow lazy creation of a new block (if necessary) 3967 Block = nullptr; 3968 3969 // This block is now the implicit successor of other blocks. 3970 Succ = DefaultCaseBlock; 3971 3972 return DefaultCaseBlock; 3973 } 3974 3975 CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) { 3976 // "try"/"catch" is a control-flow statement. Thus we stop processing the 3977 // current block. 3978 CFGBlock *TrySuccessor = nullptr; 3979 3980 if (Block) { 3981 if (badCFG) 3982 return nullptr; 3983 TrySuccessor = Block; 3984 } else TrySuccessor = Succ; 3985 3986 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock; 3987 3988 // Create a new block that will contain the try statement. 3989 CFGBlock *NewTryTerminatedBlock = createBlock(false); 3990 // Add the terminator in the try block. 3991 NewTryTerminatedBlock->setTerminator(Terminator); 3992 3993 bool HasCatchAll = false; 3994 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) { 3995 // The code after the try is the implicit successor. 3996 Succ = TrySuccessor; 3997 CXXCatchStmt *CS = Terminator->getHandler(h); 3998 if (CS->getExceptionDecl() == nullptr) { 3999 HasCatchAll = true; 4000 } 4001 Block = nullptr; 4002 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS); 4003 if (!CatchBlock) 4004 return nullptr; 4005 // Add this block to the list of successors for the block with the try 4006 // statement. 4007 addSuccessor(NewTryTerminatedBlock, CatchBlock); 4008 } 4009 if (!HasCatchAll) { 4010 if (PrevTryTerminatedBlock) 4011 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock); 4012 else 4013 addSuccessor(NewTryTerminatedBlock, &cfg->getExit()); 4014 } 4015 4016 // The code after the try is the implicit successor. 4017 Succ = TrySuccessor; 4018 4019 // Save the current "try" context. 4020 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock); 4021 cfg->addTryDispatchBlock(TryTerminatedBlock); 4022 4023 assert(Terminator->getTryBlock() && "try must contain a non-NULL body"); 4024 Block = nullptr; 4025 return addStmt(Terminator->getTryBlock()); 4026 } 4027 4028 CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) { 4029 // CXXCatchStmt are treated like labels, so they are the first statement in a 4030 // block. 4031 4032 // Save local scope position because in case of exception variable ScopePos 4033 // won't be restored when traversing AST. 4034 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 4035 4036 // Create local scope for possible exception variable. 4037 // Store scope position. Add implicit destructor. 4038 if (VarDecl *VD = CS->getExceptionDecl()) { 4039 LocalScope::const_iterator BeginScopePos = ScopePos; 4040 addLocalScopeForVarDecl(VD); 4041 addAutomaticObjHandling(ScopePos, BeginScopePos, CS); 4042 } 4043 4044 if (CS->getHandlerBlock()) 4045 addStmt(CS->getHandlerBlock()); 4046 4047 CFGBlock *CatchBlock = Block; 4048 if (!CatchBlock) 4049 CatchBlock = createBlock(); 4050 4051 // CXXCatchStmt is more than just a label. They have semantic meaning 4052 // as well, as they implicitly "initialize" the catch variable. Add 4053 // it to the CFG as a CFGElement so that the control-flow of these 4054 // semantics gets captured. 4055 appendStmt(CatchBlock, CS); 4056 4057 // Also add the CXXCatchStmt as a label, to mirror handling of regular 4058 // labels. 4059 CatchBlock->setLabel(CS); 4060 4061 // Bail out if the CFG is bad. 4062 if (badCFG) 4063 return nullptr; 4064 4065 // We set Block to NULL to allow lazy creation of a new block (if necessary) 4066 Block = nullptr; 4067 4068 return CatchBlock; 4069 } 4070 4071 CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) { 4072 // C++0x for-range statements are specified as [stmt.ranged]: 4073 // 4074 // { 4075 // auto && __range = range-init; 4076 // for ( auto __begin = begin-expr, 4077 // __end = end-expr; 4078 // __begin != __end; 4079 // ++__begin ) { 4080 // for-range-declaration = *__begin; 4081 // statement 4082 // } 4083 // } 4084 4085 // Save local scope position before the addition of the implicit variables. 4086 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos); 4087 4088 // Create local scopes and destructors for range, begin and end variables. 4089 if (Stmt *Range = S->getRangeStmt()) 4090 addLocalScopeForStmt(Range); 4091 if (Stmt *Begin = S->getBeginStmt()) 4092 addLocalScopeForStmt(Begin); 4093 if (Stmt *End = S->getEndStmt()) 4094 addLocalScopeForStmt(End); 4095 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S); 4096 4097 LocalScope::const_iterator ContinueScopePos = ScopePos; 4098 4099 // "for" is a control-flow statement. Thus we stop processing the current 4100 // block. 4101 CFGBlock *LoopSuccessor = nullptr; 4102 if (Block) { 4103 if (badCFG) 4104 return nullptr; 4105 LoopSuccessor = Block; 4106 } else 4107 LoopSuccessor = Succ; 4108 4109 // Save the current value for the break targets. 4110 // All breaks should go to the code following the loop. 4111 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget); 4112 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos); 4113 4114 // The block for the __begin != __end expression. 4115 CFGBlock *ConditionBlock = createBlock(false); 4116 ConditionBlock->setTerminator(S); 4117 4118 // Now add the actual condition to the condition block. 4119 if (Expr *C = S->getCond()) { 4120 Block = ConditionBlock; 4121 CFGBlock *BeginConditionBlock = addStmt(C); 4122 if (badCFG) 4123 return nullptr; 4124 assert(BeginConditionBlock == ConditionBlock && 4125 "condition block in for-range was unexpectedly complex"); 4126 (void)BeginConditionBlock; 4127 } 4128 4129 // The condition block is the implicit successor for the loop body as well as 4130 // any code above the loop. 4131 Succ = ConditionBlock; 4132 4133 // See if this is a known constant. 4134 TryResult KnownVal(true); 4135 4136 if (S->getCond()) 4137 KnownVal = tryEvaluateBool(S->getCond()); 4138 4139 // Now create the loop body. 4140 { 4141 assert(S->getBody()); 4142 4143 // Save the current values for Block, Succ, and continue targets. 4144 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ); 4145 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget); 4146 4147 // Generate increment code in its own basic block. This is the target of 4148 // continue statements. 4149 Block = nullptr; 4150 Succ = addStmt(S->getInc()); 4151 if (badCFG) 4152 return nullptr; 4153 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos); 4154 4155 // The starting block for the loop increment is the block that should 4156 // represent the 'loop target' for looping back to the start of the loop. 4157 ContinueJumpTarget.block->setLoopTarget(S); 4158 4159 // Finish up the increment block and prepare to start the loop body. 4160 assert(Block); 4161 if (badCFG) 4162 return nullptr; 4163 Block = nullptr; 4164 4165 // Add implicit scope and dtors for loop variable. 4166 addLocalScopeAndDtors(S->getLoopVarStmt()); 4167 4168 // Populate a new block to contain the loop body and loop variable. 4169 addStmt(S->getBody()); 4170 if (badCFG) 4171 return nullptr; 4172 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt()); 4173 if (badCFG) 4174 return nullptr; 4175 4176 // This new body block is a successor to our condition block. 4177 addSuccessor(ConditionBlock, 4178 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock); 4179 } 4180 4181 // Link up the condition block with the code that follows the loop (the 4182 // false branch). 4183 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor); 4184 4185 // Add the initialization statements. 4186 Block = createBlock(); 4187 addStmt(S->getBeginStmt()); 4188 addStmt(S->getEndStmt()); 4189 return addStmt(S->getRangeStmt()); 4190 } 4191 4192 CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E, 4193 AddStmtChoice asc) { 4194 if (BuildOpts.AddTemporaryDtors) { 4195 // If adding implicit destructors visit the full expression for adding 4196 // destructors of temporaries. 4197 TempDtorContext Context; 4198 VisitForTemporaryDtors(E->getSubExpr(), false, Context); 4199 4200 // Full expression has to be added as CFGStmt so it will be sequenced 4201 // before destructors of it's temporaries. 4202 asc = asc.withAlwaysAdd(true); 4203 } 4204 return Visit(E->getSubExpr(), asc); 4205 } 4206 4207 CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E, 4208 AddStmtChoice asc) { 4209 if (asc.alwaysAdd(*this, E)) { 4210 autoCreateBlock(); 4211 appendStmt(Block, E); 4212 4213 findConstructionContexts( 4214 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E), 4215 E->getSubExpr()); 4216 4217 // We do not want to propagate the AlwaysAdd property. 4218 asc = asc.withAlwaysAdd(false); 4219 } 4220 return Visit(E->getSubExpr(), asc); 4221 } 4222 4223 CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C, 4224 AddStmtChoice asc) { 4225 autoCreateBlock(); 4226 appendConstructor(Block, C); 4227 4228 return VisitChildren(C); 4229 } 4230 4231 CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE, 4232 AddStmtChoice asc) { 4233 autoCreateBlock(); 4234 appendStmt(Block, NE); 4235 4236 findConstructionContexts( 4237 ConstructionContextLayer::create(cfg->getBumpVectorContext(), NE), 4238 const_cast<CXXConstructExpr *>(NE->getConstructExpr())); 4239 4240 if (NE->getInitializer()) 4241 Block = Visit(NE->getInitializer()); 4242 4243 if (BuildOpts.AddCXXNewAllocator) 4244 appendNewAllocator(Block, NE); 4245 4246 if (NE->isArray()) 4247 Block = Visit(NE->getArraySize()); 4248 4249 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(), 4250 E = NE->placement_arg_end(); I != E; ++I) 4251 Block = Visit(*I); 4252 4253 return Block; 4254 } 4255 4256 CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE, 4257 AddStmtChoice asc) { 4258 autoCreateBlock(); 4259 appendStmt(Block, DE); 4260 QualType DTy = DE->getDestroyedType(); 4261 if (!DTy.isNull()) { 4262 DTy = DTy.getNonReferenceType(); 4263 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl(); 4264 if (RD) { 4265 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor()) 4266 appendDeleteDtor(Block, RD, DE); 4267 } 4268 } 4269 4270 return VisitChildren(DE); 4271 } 4272 4273 CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E, 4274 AddStmtChoice asc) { 4275 if (asc.alwaysAdd(*this, E)) { 4276 autoCreateBlock(); 4277 appendStmt(Block, E); 4278 // We do not want to propagate the AlwaysAdd property. 4279 asc = asc.withAlwaysAdd(false); 4280 } 4281 return Visit(E->getSubExpr(), asc); 4282 } 4283 4284 CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C, 4285 AddStmtChoice asc) { 4286 autoCreateBlock(); 4287 appendConstructor(Block, C); 4288 return VisitChildren(C); 4289 } 4290 4291 CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E, 4292 AddStmtChoice asc) { 4293 if (asc.alwaysAdd(*this, E)) { 4294 autoCreateBlock(); 4295 appendStmt(Block, E); 4296 } 4297 return Visit(E->getSubExpr(), AddStmtChoice()); 4298 } 4299 4300 CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) { 4301 // Lazily create the indirect-goto dispatch block if there isn't one already. 4302 CFGBlock *IBlock = cfg->getIndirectGotoBlock(); 4303 4304 if (!IBlock) { 4305 IBlock = createBlock(false); 4306 cfg->setIndirectGotoBlock(IBlock); 4307 } 4308 4309 // IndirectGoto is a control-flow statement. Thus we stop processing the 4310 // current block and create a new one. 4311 if (badCFG) 4312 return nullptr; 4313 4314 Block = createBlock(false); 4315 Block->setTerminator(I); 4316 addSuccessor(Block, IBlock); 4317 return addStmt(I->getTarget()); 4318 } 4319 4320 CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary, 4321 TempDtorContext &Context) { 4322 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors); 4323 4324 tryAgain: 4325 if (!E) { 4326 badCFG = true; 4327 return nullptr; 4328 } 4329 switch (E->getStmtClass()) { 4330 default: 4331 return VisitChildrenForTemporaryDtors(E, Context); 4332 4333 case Stmt::BinaryOperatorClass: 4334 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E), 4335 Context); 4336 4337 case Stmt::CXXBindTemporaryExprClass: 4338 return VisitCXXBindTemporaryExprForTemporaryDtors( 4339 cast<CXXBindTemporaryExpr>(E), BindToTemporary, Context); 4340 4341 case Stmt::BinaryConditionalOperatorClass: 4342 case Stmt::ConditionalOperatorClass: 4343 return VisitConditionalOperatorForTemporaryDtors( 4344 cast<AbstractConditionalOperator>(E), BindToTemporary, Context); 4345 4346 case Stmt::ImplicitCastExprClass: 4347 // For implicit cast we want BindToTemporary to be passed further. 4348 E = cast<CastExpr>(E)->getSubExpr(); 4349 goto tryAgain; 4350 4351 case Stmt::CXXFunctionalCastExprClass: 4352 // For functional cast we want BindToTemporary to be passed further. 4353 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr(); 4354 goto tryAgain; 4355 4356 case Stmt::ParenExprClass: 4357 E = cast<ParenExpr>(E)->getSubExpr(); 4358 goto tryAgain; 4359 4360 case Stmt::MaterializeTemporaryExprClass: { 4361 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E); 4362 BindToTemporary = (MTE->getStorageDuration() != SD_FullExpression); 4363 SmallVector<const Expr *, 2> CommaLHSs; 4364 SmallVector<SubobjectAdjustment, 2> Adjustments; 4365 // Find the expression whose lifetime needs to be extended. 4366 E = const_cast<Expr *>( 4367 cast<MaterializeTemporaryExpr>(E) 4368 ->GetTemporaryExpr() 4369 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments)); 4370 // Visit the skipped comma operator left-hand sides for other temporaries. 4371 for (const Expr *CommaLHS : CommaLHSs) { 4372 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS), 4373 /*BindToTemporary=*/false, Context); 4374 } 4375 goto tryAgain; 4376 } 4377 4378 case Stmt::BlockExprClass: 4379 // Don't recurse into blocks; their subexpressions don't get evaluated 4380 // here. 4381 return Block; 4382 4383 case Stmt::LambdaExprClass: { 4384 // For lambda expressions, only recurse into the capture initializers, 4385 // and not the body. 4386 auto *LE = cast<LambdaExpr>(E); 4387 CFGBlock *B = Block; 4388 for (Expr *Init : LE->capture_inits()) { 4389 if (CFGBlock *R = VisitForTemporaryDtors( 4390 Init, /*BindToTemporary=*/false, Context)) 4391 B = R; 4392 } 4393 return B; 4394 } 4395 4396 case Stmt::CXXDefaultArgExprClass: 4397 E = cast<CXXDefaultArgExpr>(E)->getExpr(); 4398 goto tryAgain; 4399 4400 case Stmt::CXXDefaultInitExprClass: 4401 E = cast<CXXDefaultInitExpr>(E)->getExpr(); 4402 goto tryAgain; 4403 } 4404 } 4405 4406 CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E, 4407 TempDtorContext &Context) { 4408 if (isa<LambdaExpr>(E)) { 4409 // Do not visit the children of lambdas; they have their own CFGs. 4410 return Block; 4411 } 4412 4413 // When visiting children for destructors we want to visit them in reverse 4414 // order that they will appear in the CFG. Because the CFG is built 4415 // bottom-up, this means we visit them in their natural order, which 4416 // reverses them in the CFG. 4417 CFGBlock *B = Block; 4418 for (Stmt *Child : E->children()) 4419 if (Child) 4420 if (CFGBlock *R = VisitForTemporaryDtors(Child, false, Context)) 4421 B = R; 4422 4423 return B; 4424 } 4425 4426 CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors( 4427 BinaryOperator *E, TempDtorContext &Context) { 4428 if (E->isLogicalOp()) { 4429 VisitForTemporaryDtors(E->getLHS(), false, Context); 4430 TryResult RHSExecuted = tryEvaluateBool(E->getLHS()); 4431 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr) 4432 RHSExecuted.negate(); 4433 4434 // We do not know at CFG-construction time whether the right-hand-side was 4435 // executed, thus we add a branch node that depends on the temporary 4436 // constructor call. 4437 TempDtorContext RHSContext( 4438 bothKnownTrue(Context.KnownExecuted, RHSExecuted)); 4439 VisitForTemporaryDtors(E->getRHS(), false, RHSContext); 4440 InsertTempDtorDecisionBlock(RHSContext); 4441 4442 return Block; 4443 } 4444 4445 if (E->isAssignmentOp()) { 4446 // For assignment operator (=) LHS expression is visited 4447 // before RHS expression. For destructors visit them in reverse order. 4448 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context); 4449 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context); 4450 return LHSBlock ? LHSBlock : RHSBlock; 4451 } 4452 4453 // For any other binary operator RHS expression is visited before 4454 // LHS expression (order of children). For destructors visit them in reverse 4455 // order. 4456 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context); 4457 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context); 4458 return RHSBlock ? RHSBlock : LHSBlock; 4459 } 4460 4461 CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors( 4462 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context) { 4463 // First add destructors for temporaries in subexpression. 4464 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), false, Context); 4465 if (!BindToTemporary) { 4466 // If lifetime of temporary is not prolonged (by assigning to constant 4467 // reference) add destructor for it. 4468 4469 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor(); 4470 4471 if (Dtor->getParent()->isAnyDestructorNoReturn()) { 4472 // If the destructor is marked as a no-return destructor, we need to 4473 // create a new block for the destructor which does not have as a 4474 // successor anything built thus far. Control won't flow out of this 4475 // block. 4476 if (B) Succ = B; 4477 Block = createNoReturnBlock(); 4478 } else if (Context.needsTempDtorBranch()) { 4479 // If we need to introduce a branch, we add a new block that we will hook 4480 // up to a decision block later. 4481 if (B) Succ = B; 4482 Block = createBlock(); 4483 } else { 4484 autoCreateBlock(); 4485 } 4486 if (Context.needsTempDtorBranch()) { 4487 Context.setDecisionPoint(Succ, E); 4488 } 4489 appendTemporaryDtor(Block, E); 4490 4491 B = Block; 4492 } 4493 return B; 4494 } 4495 4496 void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context, 4497 CFGBlock *FalseSucc) { 4498 if (!Context.TerminatorExpr) { 4499 // If no temporary was found, we do not need to insert a decision point. 4500 return; 4501 } 4502 assert(Context.TerminatorExpr); 4503 CFGBlock *Decision = createBlock(false); 4504 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr, true)); 4505 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse()); 4506 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ, 4507 !Context.KnownExecuted.isTrue()); 4508 Block = Decision; 4509 } 4510 4511 CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors( 4512 AbstractConditionalOperator *E, bool BindToTemporary, 4513 TempDtorContext &Context) { 4514 VisitForTemporaryDtors(E->getCond(), false, Context); 4515 CFGBlock *ConditionBlock = Block; 4516 CFGBlock *ConditionSucc = Succ; 4517 TryResult ConditionVal = tryEvaluateBool(E->getCond()); 4518 TryResult NegatedVal = ConditionVal; 4519 if (NegatedVal.isKnown()) NegatedVal.negate(); 4520 4521 TempDtorContext TrueContext( 4522 bothKnownTrue(Context.KnownExecuted, ConditionVal)); 4523 VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary, TrueContext); 4524 CFGBlock *TrueBlock = Block; 4525 4526 Block = ConditionBlock; 4527 Succ = ConditionSucc; 4528 TempDtorContext FalseContext( 4529 bothKnownTrue(Context.KnownExecuted, NegatedVal)); 4530 VisitForTemporaryDtors(E->getFalseExpr(), BindToTemporary, FalseContext); 4531 4532 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) { 4533 InsertTempDtorDecisionBlock(FalseContext, TrueBlock); 4534 } else if (TrueContext.TerminatorExpr) { 4535 Block = TrueBlock; 4536 InsertTempDtorDecisionBlock(TrueContext); 4537 } else { 4538 InsertTempDtorDecisionBlock(FalseContext); 4539 } 4540 return Block; 4541 } 4542 4543 /// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has 4544 /// no successors or predecessors. If this is the first block created in the 4545 /// CFG, it is automatically set to be the Entry and Exit of the CFG. 4546 CFGBlock *CFG::createBlock() { 4547 bool first_block = begin() == end(); 4548 4549 // Create the block. 4550 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>(); 4551 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this); 4552 Blocks.push_back(Mem, BlkBVC); 4553 4554 // If this is the first block, set it as the Entry and Exit. 4555 if (first_block) 4556 Entry = Exit = &back(); 4557 4558 // Return the block. 4559 return &back(); 4560 } 4561 4562 /// buildCFG - Constructs a CFG from an AST. 4563 std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement, 4564 ASTContext *C, const BuildOptions &BO) { 4565 CFGBuilder Builder(C, BO); 4566 return Builder.buildCFG(D, Statement); 4567 } 4568 4569 const CXXDestructorDecl * 4570 CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const { 4571 switch (getKind()) { 4572 case CFGElement::Initializer: 4573 case CFGElement::NewAllocator: 4574 case CFGElement::LoopExit: 4575 case CFGElement::LifetimeEnds: 4576 case CFGElement::Statement: 4577 case CFGElement::Constructor: 4578 case CFGElement::CXXRecordTypedCall: 4579 case CFGElement::ScopeBegin: 4580 case CFGElement::ScopeEnd: 4581 llvm_unreachable("getDestructorDecl should only be used with " 4582 "ImplicitDtors"); 4583 case CFGElement::AutomaticObjectDtor: { 4584 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl(); 4585 QualType ty = var->getType(); 4586 4587 // FIXME: See CFGBuilder::addLocalScopeForVarDecl. 4588 // 4589 // Lifetime-extending constructs are handled here. This works for a single 4590 // temporary in an initializer expression. 4591 if (ty->isReferenceType()) { 4592 if (const Expr *Init = var->getInit()) { 4593 ty = getReferenceInitTemporaryType(Init); 4594 } 4595 } 4596 4597 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) { 4598 ty = arrayType->getElementType(); 4599 } 4600 const RecordType *recordType = ty->getAs<RecordType>(); 4601 const CXXRecordDecl *classDecl = 4602 cast<CXXRecordDecl>(recordType->getDecl()); 4603 return classDecl->getDestructor(); 4604 } 4605 case CFGElement::DeleteDtor: { 4606 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr(); 4607 QualType DTy = DE->getDestroyedType(); 4608 DTy = DTy.getNonReferenceType(); 4609 const CXXRecordDecl *classDecl = 4610 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl(); 4611 return classDecl->getDestructor(); 4612 } 4613 case CFGElement::TemporaryDtor: { 4614 const CXXBindTemporaryExpr *bindExpr = 4615 castAs<CFGTemporaryDtor>().getBindTemporaryExpr(); 4616 const CXXTemporary *temp = bindExpr->getTemporary(); 4617 return temp->getDestructor(); 4618 } 4619 case CFGElement::BaseDtor: 4620 case CFGElement::MemberDtor: 4621 // Not yet supported. 4622 return nullptr; 4623 } 4624 llvm_unreachable("getKind() returned bogus value"); 4625 } 4626 4627 bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const { 4628 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext)) 4629 return DD->isNoReturn(); 4630 return false; 4631 } 4632 4633 //===----------------------------------------------------------------------===// 4634 // CFGBlock operations. 4635 //===----------------------------------------------------------------------===// 4636 4637 CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable) 4638 : ReachableBlock(IsReachable ? B : nullptr), 4639 UnreachableBlock(!IsReachable ? B : nullptr, 4640 B && IsReachable ? AB_Normal : AB_Unreachable) {} 4641 4642 CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock) 4643 : ReachableBlock(B), 4644 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock, 4645 B == AlternateBlock ? AB_Alternate : AB_Normal) {} 4646 4647 void CFGBlock::addSuccessor(AdjacentBlock Succ, 4648 BumpVectorContext &C) { 4649 if (CFGBlock *B = Succ.getReachableBlock()) 4650 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C); 4651 4652 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock()) 4653 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C); 4654 4655 Succs.push_back(Succ, C); 4656 } 4657 4658 bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F, 4659 const CFGBlock *From, const CFGBlock *To) { 4660 if (F.IgnoreNullPredecessors && !From) 4661 return true; 4662 4663 if (To && From && F.IgnoreDefaultsWithCoveredEnums) { 4664 // If the 'To' has no label or is labeled but the label isn't a 4665 // CaseStmt then filter this edge. 4666 if (const SwitchStmt *S = 4667 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) { 4668 if (S->isAllEnumCasesCovered()) { 4669 const Stmt *L = To->getLabel(); 4670 if (!L || !isa<CaseStmt>(L)) 4671 return true; 4672 } 4673 } 4674 } 4675 4676 return false; 4677 } 4678 4679 //===----------------------------------------------------------------------===// 4680 // CFG pretty printing 4681 //===----------------------------------------------------------------------===// 4682 4683 namespace { 4684 4685 class StmtPrinterHelper : public PrinterHelper { 4686 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>; 4687 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>; 4688 4689 StmtMapTy StmtMap; 4690 DeclMapTy DeclMap; 4691 signed currentBlock = 0; 4692 unsigned currStmt = 0; 4693 const LangOptions &LangOpts; 4694 4695 public: 4696 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO) 4697 : LangOpts(LO) { 4698 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) { 4699 unsigned j = 1; 4700 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ; 4701 BI != BEnd; ++BI, ++j ) { 4702 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) { 4703 const Stmt *stmt= SE->getStmt(); 4704 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j); 4705 StmtMap[stmt] = P; 4706 4707 switch (stmt->getStmtClass()) { 4708 case Stmt::DeclStmtClass: 4709 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P; 4710 break; 4711 case Stmt::IfStmtClass: { 4712 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable(); 4713 if (var) 4714 DeclMap[var] = P; 4715 break; 4716 } 4717 case Stmt::ForStmtClass: { 4718 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable(); 4719 if (var) 4720 DeclMap[var] = P; 4721 break; 4722 } 4723 case Stmt::WhileStmtClass: { 4724 const VarDecl *var = 4725 cast<WhileStmt>(stmt)->getConditionVariable(); 4726 if (var) 4727 DeclMap[var] = P; 4728 break; 4729 } 4730 case Stmt::SwitchStmtClass: { 4731 const VarDecl *var = 4732 cast<SwitchStmt>(stmt)->getConditionVariable(); 4733 if (var) 4734 DeclMap[var] = P; 4735 break; 4736 } 4737 case Stmt::CXXCatchStmtClass: { 4738 const VarDecl *var = 4739 cast<CXXCatchStmt>(stmt)->getExceptionDecl(); 4740 if (var) 4741 DeclMap[var] = P; 4742 break; 4743 } 4744 default: 4745 break; 4746 } 4747 } 4748 } 4749 } 4750 } 4751 4752 ~StmtPrinterHelper() override = default; 4753 4754 const LangOptions &getLangOpts() const { return LangOpts; } 4755 void setBlockID(signed i) { currentBlock = i; } 4756 void setStmtID(unsigned i) { currStmt = i; } 4757 4758 bool handledStmt(Stmt *S, raw_ostream &OS) override { 4759 StmtMapTy::iterator I = StmtMap.find(S); 4760 4761 if (I == StmtMap.end()) 4762 return false; 4763 4764 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock 4765 && I->second.second == currStmt) { 4766 return false; 4767 } 4768 4769 OS << "[B" << I->second.first << "." << I->second.second << "]"; 4770 return true; 4771 } 4772 4773 bool handleDecl(const Decl *D, raw_ostream &OS) { 4774 DeclMapTy::iterator I = DeclMap.find(D); 4775 4776 if (I == DeclMap.end()) 4777 return false; 4778 4779 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock 4780 && I->second.second == currStmt) { 4781 return false; 4782 } 4783 4784 OS << "[B" << I->second.first << "." << I->second.second << "]"; 4785 return true; 4786 } 4787 }; 4788 4789 class CFGBlockTerminatorPrint 4790 : public StmtVisitor<CFGBlockTerminatorPrint,void> { 4791 raw_ostream &OS; 4792 StmtPrinterHelper* Helper; 4793 PrintingPolicy Policy; 4794 4795 public: 4796 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper, 4797 const PrintingPolicy &Policy) 4798 : OS(os), Helper(helper), Policy(Policy) { 4799 this->Policy.IncludeNewlines = false; 4800 } 4801 4802 void VisitIfStmt(IfStmt *I) { 4803 OS << "if "; 4804 if (Stmt *C = I->getCond()) 4805 C->printPretty(OS, Helper, Policy); 4806 } 4807 4808 // Default case. 4809 void VisitStmt(Stmt *Terminator) { 4810 Terminator->printPretty(OS, Helper, Policy); 4811 } 4812 4813 void VisitDeclStmt(DeclStmt *DS) { 4814 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl()); 4815 OS << "static init " << VD->getName(); 4816 } 4817 4818 void VisitForStmt(ForStmt *F) { 4819 OS << "for (" ; 4820 if (F->getInit()) 4821 OS << "..."; 4822 OS << "; "; 4823 if (Stmt *C = F->getCond()) 4824 C->printPretty(OS, Helper, Policy); 4825 OS << "; "; 4826 if (F->getInc()) 4827 OS << "..."; 4828 OS << ")"; 4829 } 4830 4831 void VisitWhileStmt(WhileStmt *W) { 4832 OS << "while " ; 4833 if (Stmt *C = W->getCond()) 4834 C->printPretty(OS, Helper, Policy); 4835 } 4836 4837 void VisitDoStmt(DoStmt *D) { 4838 OS << "do ... while "; 4839 if (Stmt *C = D->getCond()) 4840 C->printPretty(OS, Helper, Policy); 4841 } 4842 4843 void VisitSwitchStmt(SwitchStmt *Terminator) { 4844 OS << "switch "; 4845 Terminator->getCond()->printPretty(OS, Helper, Policy); 4846 } 4847 4848 void VisitCXXTryStmt(CXXTryStmt *CS) { 4849 OS << "try ..."; 4850 } 4851 4852 void VisitSEHTryStmt(SEHTryStmt *CS) { 4853 OS << "__try ..."; 4854 } 4855 4856 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) { 4857 if (Stmt *Cond = C->getCond()) 4858 Cond->printPretty(OS, Helper, Policy); 4859 OS << " ? ... : ..."; 4860 } 4861 4862 void VisitChooseExpr(ChooseExpr *C) { 4863 OS << "__builtin_choose_expr( "; 4864 if (Stmt *Cond = C->getCond()) 4865 Cond->printPretty(OS, Helper, Policy); 4866 OS << " )"; 4867 } 4868 4869 void VisitIndirectGotoStmt(IndirectGotoStmt *I) { 4870 OS << "goto *"; 4871 if (Stmt *T = I->getTarget()) 4872 T->printPretty(OS, Helper, Policy); 4873 } 4874 4875 void VisitBinaryOperator(BinaryOperator* B) { 4876 if (!B->isLogicalOp()) { 4877 VisitExpr(B); 4878 return; 4879 } 4880 4881 if (B->getLHS()) 4882 B->getLHS()->printPretty(OS, Helper, Policy); 4883 4884 switch (B->getOpcode()) { 4885 case BO_LOr: 4886 OS << " || ..."; 4887 return; 4888 case BO_LAnd: 4889 OS << " && ..."; 4890 return; 4891 default: 4892 llvm_unreachable("Invalid logical operator."); 4893 } 4894 } 4895 4896 void VisitExpr(Expr *E) { 4897 E->printPretty(OS, Helper, Policy); 4898 } 4899 4900 public: 4901 void print(CFGTerminator T) { 4902 if (T.isTemporaryDtorsBranch()) 4903 OS << "(Temp Dtor) "; 4904 Visit(T.getStmt()); 4905 } 4906 }; 4907 4908 } // namespace 4909 4910 static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper, 4911 const CXXCtorInitializer *I) { 4912 if (I->isBaseInitializer()) 4913 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName(); 4914 else if (I->isDelegatingInitializer()) 4915 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName(); 4916 else 4917 OS << I->getAnyMember()->getName(); 4918 OS << "("; 4919 if (Expr *IE = I->getInit()) 4920 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts())); 4921 OS << ")"; 4922 4923 if (I->isBaseInitializer()) 4924 OS << " (Base initializer)"; 4925 else if (I->isDelegatingInitializer()) 4926 OS << " (Delegating initializer)"; 4927 else 4928 OS << " (Member initializer)"; 4929 } 4930 4931 static void print_construction_context(raw_ostream &OS, 4932 StmtPrinterHelper &Helper, 4933 const ConstructionContext *CC) { 4934 const Stmt *S1 = nullptr, *S2 = nullptr; 4935 switch (CC->getKind()) { 4936 case ConstructionContext::SimpleConstructorInitializerKind: { 4937 OS << ", "; 4938 const auto *SICC = cast<SimpleConstructorInitializerConstructionContext>(CC); 4939 print_initializer(OS, Helper, SICC->getCXXCtorInitializer()); 4940 break; 4941 } 4942 case ConstructionContext::CXX17ElidedCopyConstructorInitializerKind: { 4943 OS << ", "; 4944 const auto *CICC = 4945 cast<CXX17ElidedCopyConstructorInitializerConstructionContext>(CC); 4946 print_initializer(OS, Helper, CICC->getCXXCtorInitializer()); 4947 S2 = CICC->getCXXBindTemporaryExpr(); 4948 break; 4949 } 4950 case ConstructionContext::SimpleVariableKind: { 4951 const auto *SDSCC = cast<SimpleVariableConstructionContext>(CC); 4952 S1 = SDSCC->getDeclStmt(); 4953 break; 4954 } 4955 case ConstructionContext::CXX17ElidedCopyVariableKind: { 4956 const auto *CDSCC = cast<CXX17ElidedCopyVariableConstructionContext>(CC); 4957 S1 = CDSCC->getDeclStmt(); 4958 S2 = CDSCC->getCXXBindTemporaryExpr(); 4959 break; 4960 } 4961 case ConstructionContext::NewAllocatedObjectKind: { 4962 const auto *NECC = cast<NewAllocatedObjectConstructionContext>(CC); 4963 S1 = NECC->getCXXNewExpr(); 4964 break; 4965 } 4966 case ConstructionContext::SimpleReturnedValueKind: { 4967 const auto *RSCC = cast<SimpleReturnedValueConstructionContext>(CC); 4968 S1 = RSCC->getReturnStmt(); 4969 break; 4970 } 4971 case ConstructionContext::CXX17ElidedCopyReturnedValueKind: { 4972 const auto *RSCC = 4973 cast<CXX17ElidedCopyReturnedValueConstructionContext>(CC); 4974 S1 = RSCC->getReturnStmt(); 4975 S2 = RSCC->getCXXBindTemporaryExpr(); 4976 break; 4977 } 4978 case ConstructionContext::TemporaryObjectKind: { 4979 const auto *TOCC = cast<TemporaryObjectConstructionContext>(CC); 4980 S1 = TOCC->getCXXBindTemporaryExpr(); 4981 S2 = TOCC->getMaterializedTemporaryExpr(); 4982 break; 4983 } 4984 } 4985 if (S1) { 4986 OS << ", "; 4987 Helper.handledStmt(const_cast<Stmt *>(S1), OS); 4988 } 4989 if (S2) { 4990 OS << ", "; 4991 Helper.handledStmt(const_cast<Stmt *>(S2), OS); 4992 } 4993 } 4994 4995 static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper, 4996 const CFGElement &E) { 4997 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) { 4998 const Stmt *S = CS->getStmt(); 4999 assert(S != nullptr && "Expecting non-null Stmt"); 5000 5001 // special printing for statement-expressions. 5002 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) { 5003 const CompoundStmt *Sub = SE->getSubStmt(); 5004 5005 auto Children = Sub->children(); 5006 if (Children.begin() != Children.end()) { 5007 OS << "({ ... ; "; 5008 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS); 5009 OS << " })\n"; 5010 return; 5011 } 5012 } 5013 // special printing for comma expressions. 5014 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) { 5015 if (B->getOpcode() == BO_Comma) { 5016 OS << "... , "; 5017 Helper.handledStmt(B->getRHS(),OS); 5018 OS << '\n'; 5019 return; 5020 } 5021 } 5022 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts())); 5023 5024 if (auto VTC = E.getAs<CFGCXXRecordTypedCall>()) { 5025 if (isa<CXXOperatorCallExpr>(S)) 5026 OS << " (OperatorCall)"; 5027 OS << " (CXXRecordTypedCall"; 5028 print_construction_context(OS, Helper, VTC->getConstructionContext()); 5029 OS << ")"; 5030 } else if (isa<CXXOperatorCallExpr>(S)) { 5031 OS << " (OperatorCall)"; 5032 } else if (isa<CXXBindTemporaryExpr>(S)) { 5033 OS << " (BindTemporary)"; 5034 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) { 5035 OS << " (CXXConstructExpr"; 5036 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) { 5037 print_construction_context(OS, Helper, CE->getConstructionContext()); 5038 } 5039 OS << ", " << CCE->getType().getAsString() << ")"; 5040 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) { 5041 OS << " (" << CE->getStmtClassName() << ", " 5042 << CE->getCastKindName() 5043 << ", " << CE->getType().getAsString() 5044 << ")"; 5045 } 5046 5047 // Expressions need a newline. 5048 if (isa<Expr>(S)) 5049 OS << '\n'; 5050 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) { 5051 print_initializer(OS, Helper, IE->getInitializer()); 5052 OS << '\n'; 5053 } else if (Optional<CFGAutomaticObjDtor> DE = 5054 E.getAs<CFGAutomaticObjDtor>()) { 5055 const VarDecl *VD = DE->getVarDecl(); 5056 Helper.handleDecl(VD, OS); 5057 5058 ASTContext &ACtx = VD->getASTContext(); 5059 QualType T = VD->getType(); 5060 if (T->isReferenceType()) 5061 T = getReferenceInitTemporaryType(VD->getInit(), nullptr); 5062 if (const ArrayType *AT = ACtx.getAsArrayType(T)) 5063 T = ACtx.getBaseElementType(AT); 5064 5065 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()"; 5066 OS << " (Implicit destructor)\n"; 5067 } else if (Optional<CFGLifetimeEnds> DE = E.getAs<CFGLifetimeEnds>()) { 5068 const VarDecl *VD = DE->getVarDecl(); 5069 Helper.handleDecl(VD, OS); 5070 5071 OS << " (Lifetime ends)\n"; 5072 } else if (Optional<CFGLoopExit> LE = E.getAs<CFGLoopExit>()) { 5073 const Stmt *LoopStmt = LE->getLoopStmt(); 5074 OS << LoopStmt->getStmtClassName() << " (LoopExit)\n"; 5075 } else if (Optional<CFGScopeBegin> SB = E.getAs<CFGScopeBegin>()) { 5076 OS << "CFGScopeBegin("; 5077 if (const VarDecl *VD = SB->getVarDecl()) 5078 OS << VD->getQualifiedNameAsString(); 5079 OS << ")\n"; 5080 } else if (Optional<CFGScopeEnd> SE = E.getAs<CFGScopeEnd>()) { 5081 OS << "CFGScopeEnd("; 5082 if (const VarDecl *VD = SE->getVarDecl()) 5083 OS << VD->getQualifiedNameAsString(); 5084 OS << ")\n"; 5085 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) { 5086 OS << "CFGNewAllocator("; 5087 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr()) 5088 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts())); 5089 OS << ")\n"; 5090 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) { 5091 const CXXRecordDecl *RD = DE->getCXXRecordDecl(); 5092 if (!RD) 5093 return; 5094 CXXDeleteExpr *DelExpr = 5095 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr()); 5096 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS); 5097 OS << "->~" << RD->getName().str() << "()"; 5098 OS << " (Implicit destructor)\n"; 5099 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) { 5100 const CXXBaseSpecifier *BS = BE->getBaseSpecifier(); 5101 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()"; 5102 OS << " (Base object destructor)\n"; 5103 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) { 5104 const FieldDecl *FD = ME->getFieldDecl(); 5105 const Type *T = FD->getType()->getBaseElementTypeUnsafe(); 5106 OS << "this->" << FD->getName(); 5107 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()"; 5108 OS << " (Member object destructor)\n"; 5109 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) { 5110 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr(); 5111 OS << "~"; 5112 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts())); 5113 OS << "() (Temporary object destructor)\n"; 5114 } 5115 } 5116 5117 static void print_block(raw_ostream &OS, const CFG* cfg, 5118 const CFGBlock &B, 5119 StmtPrinterHelper &Helper, bool print_edges, 5120 bool ShowColors) { 5121 Helper.setBlockID(B.getBlockID()); 5122 5123 // Print the header. 5124 if (ShowColors) 5125 OS.changeColor(raw_ostream::YELLOW, true); 5126 5127 OS << "\n [B" << B.getBlockID(); 5128 5129 if (&B == &cfg->getEntry()) 5130 OS << " (ENTRY)]\n"; 5131 else if (&B == &cfg->getExit()) 5132 OS << " (EXIT)]\n"; 5133 else if (&B == cfg->getIndirectGotoBlock()) 5134 OS << " (INDIRECT GOTO DISPATCH)]\n"; 5135 else if (B.hasNoReturnElement()) 5136 OS << " (NORETURN)]\n"; 5137 else 5138 OS << "]\n"; 5139 5140 if (ShowColors) 5141 OS.resetColor(); 5142 5143 // Print the label of this block. 5144 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) { 5145 if (print_edges) 5146 OS << " "; 5147 5148 if (LabelStmt *L = dyn_cast<LabelStmt>(Label)) 5149 OS << L->getName(); 5150 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) { 5151 OS << "case "; 5152 if (C->getLHS()) 5153 C->getLHS()->printPretty(OS, &Helper, 5154 PrintingPolicy(Helper.getLangOpts())); 5155 if (C->getRHS()) { 5156 OS << " ... "; 5157 C->getRHS()->printPretty(OS, &Helper, 5158 PrintingPolicy(Helper.getLangOpts())); 5159 } 5160 } else if (isa<DefaultStmt>(Label)) 5161 OS << "default"; 5162 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) { 5163 OS << "catch ("; 5164 if (CS->getExceptionDecl()) 5165 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()), 5166 0); 5167 else 5168 OS << "..."; 5169 OS << ")"; 5170 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) { 5171 OS << "__except ("; 5172 ES->getFilterExpr()->printPretty(OS, &Helper, 5173 PrintingPolicy(Helper.getLangOpts()), 0); 5174 OS << ")"; 5175 } else 5176 llvm_unreachable("Invalid label statement in CFGBlock."); 5177 5178 OS << ":\n"; 5179 } 5180 5181 // Iterate through the statements in the block and print them. 5182 unsigned j = 1; 5183 5184 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ; 5185 I != E ; ++I, ++j ) { 5186 // Print the statement # in the basic block and the statement itself. 5187 if (print_edges) 5188 OS << " "; 5189 5190 OS << llvm::format("%3d", j) << ": "; 5191 5192 Helper.setStmtID(j); 5193 5194 print_elem(OS, Helper, *I); 5195 } 5196 5197 // Print the terminator of this block. 5198 if (B.getTerminator()) { 5199 if (ShowColors) 5200 OS.changeColor(raw_ostream::GREEN); 5201 5202 OS << " T: "; 5203 5204 Helper.setBlockID(-1); 5205 5206 PrintingPolicy PP(Helper.getLangOpts()); 5207 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP); 5208 TPrinter.print(B.getTerminator()); 5209 OS << '\n'; 5210 5211 if (ShowColors) 5212 OS.resetColor(); 5213 } 5214 5215 if (print_edges) { 5216 // Print the predecessors of this block. 5217 if (!B.pred_empty()) { 5218 const raw_ostream::Colors Color = raw_ostream::BLUE; 5219 if (ShowColors) 5220 OS.changeColor(Color); 5221 OS << " Preds " ; 5222 if (ShowColors) 5223 OS.resetColor(); 5224 OS << '(' << B.pred_size() << "):"; 5225 unsigned i = 0; 5226 5227 if (ShowColors) 5228 OS.changeColor(Color); 5229 5230 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end(); 5231 I != E; ++I, ++i) { 5232 if (i % 10 == 8) 5233 OS << "\n "; 5234 5235 CFGBlock *B = *I; 5236 bool Reachable = true; 5237 if (!B) { 5238 Reachable = false; 5239 B = I->getPossiblyUnreachableBlock(); 5240 } 5241 5242 OS << " B" << B->getBlockID(); 5243 if (!Reachable) 5244 OS << "(Unreachable)"; 5245 } 5246 5247 if (ShowColors) 5248 OS.resetColor(); 5249 5250 OS << '\n'; 5251 } 5252 5253 // Print the successors of this block. 5254 if (!B.succ_empty()) { 5255 const raw_ostream::Colors Color = raw_ostream::MAGENTA; 5256 if (ShowColors) 5257 OS.changeColor(Color); 5258 OS << " Succs "; 5259 if (ShowColors) 5260 OS.resetColor(); 5261 OS << '(' << B.succ_size() << "):"; 5262 unsigned i = 0; 5263 5264 if (ShowColors) 5265 OS.changeColor(Color); 5266 5267 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end(); 5268 I != E; ++I, ++i) { 5269 if (i % 10 == 8) 5270 OS << "\n "; 5271 5272 CFGBlock *B = *I; 5273 5274 bool Reachable = true; 5275 if (!B) { 5276 Reachable = false; 5277 B = I->getPossiblyUnreachableBlock(); 5278 } 5279 5280 if (B) { 5281 OS << " B" << B->getBlockID(); 5282 if (!Reachable) 5283 OS << "(Unreachable)"; 5284 } 5285 else { 5286 OS << " NULL"; 5287 } 5288 } 5289 5290 if (ShowColors) 5291 OS.resetColor(); 5292 OS << '\n'; 5293 } 5294 } 5295 } 5296 5297 /// dump - A simple pretty printer of a CFG that outputs to stderr. 5298 void CFG::dump(const LangOptions &LO, bool ShowColors) const { 5299 print(llvm::errs(), LO, ShowColors); 5300 } 5301 5302 /// print - A simple pretty printer of a CFG that outputs to an ostream. 5303 void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const { 5304 StmtPrinterHelper Helper(this, LO); 5305 5306 // Print the entry block. 5307 print_block(OS, this, getEntry(), Helper, true, ShowColors); 5308 5309 // Iterate through the CFGBlocks and print them one by one. 5310 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) { 5311 // Skip the entry block, because we already printed it. 5312 if (&(**I) == &getEntry() || &(**I) == &getExit()) 5313 continue; 5314 5315 print_block(OS, this, **I, Helper, true, ShowColors); 5316 } 5317 5318 // Print the exit block. 5319 print_block(OS, this, getExit(), Helper, true, ShowColors); 5320 OS << '\n'; 5321 OS.flush(); 5322 } 5323 5324 /// dump - A simply pretty printer of a CFGBlock that outputs to stderr. 5325 void CFGBlock::dump(const CFG* cfg, const LangOptions &LO, 5326 bool ShowColors) const { 5327 print(llvm::errs(), cfg, LO, ShowColors); 5328 } 5329 5330 LLVM_DUMP_METHOD void CFGBlock::dump() const { 5331 dump(getParent(), LangOptions(), false); 5332 } 5333 5334 /// print - A simple pretty printer of a CFGBlock that outputs to an ostream. 5335 /// Generally this will only be called from CFG::print. 5336 void CFGBlock::print(raw_ostream &OS, const CFG* cfg, 5337 const LangOptions &LO, bool ShowColors) const { 5338 StmtPrinterHelper Helper(cfg, LO); 5339 print_block(OS, cfg, *this, Helper, true, ShowColors); 5340 OS << '\n'; 5341 } 5342 5343 /// printTerminator - A simple pretty printer of the terminator of a CFGBlock. 5344 void CFGBlock::printTerminator(raw_ostream &OS, 5345 const LangOptions &LO) const { 5346 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO)); 5347 TPrinter.print(getTerminator()); 5348 } 5349 5350 Stmt *CFGBlock::getTerminatorCondition(bool StripParens) { 5351 Stmt *Terminator = this->Terminator; 5352 if (!Terminator) 5353 return nullptr; 5354 5355 Expr *E = nullptr; 5356 5357 switch (Terminator->getStmtClass()) { 5358 default: 5359 break; 5360 5361 case Stmt::CXXForRangeStmtClass: 5362 E = cast<CXXForRangeStmt>(Terminator)->getCond(); 5363 break; 5364 5365 case Stmt::ForStmtClass: 5366 E = cast<ForStmt>(Terminator)->getCond(); 5367 break; 5368 5369 case Stmt::WhileStmtClass: 5370 E = cast<WhileStmt>(Terminator)->getCond(); 5371 break; 5372 5373 case Stmt::DoStmtClass: 5374 E = cast<DoStmt>(Terminator)->getCond(); 5375 break; 5376 5377 case Stmt::IfStmtClass: 5378 E = cast<IfStmt>(Terminator)->getCond(); 5379 break; 5380 5381 case Stmt::ChooseExprClass: 5382 E = cast<ChooseExpr>(Terminator)->getCond(); 5383 break; 5384 5385 case Stmt::IndirectGotoStmtClass: 5386 E = cast<IndirectGotoStmt>(Terminator)->getTarget(); 5387 break; 5388 5389 case Stmt::SwitchStmtClass: 5390 E = cast<SwitchStmt>(Terminator)->getCond(); 5391 break; 5392 5393 case Stmt::BinaryConditionalOperatorClass: 5394 E = cast<BinaryConditionalOperator>(Terminator)->getCond(); 5395 break; 5396 5397 case Stmt::ConditionalOperatorClass: 5398 E = cast<ConditionalOperator>(Terminator)->getCond(); 5399 break; 5400 5401 case Stmt::BinaryOperatorClass: // '&&' and '||' 5402 E = cast<BinaryOperator>(Terminator)->getLHS(); 5403 break; 5404 5405 case Stmt::ObjCForCollectionStmtClass: 5406 return Terminator; 5407 } 5408 5409 if (!StripParens) 5410 return E; 5411 5412 return E ? E->IgnoreParens() : nullptr; 5413 } 5414 5415 //===----------------------------------------------------------------------===// 5416 // CFG Graphviz Visualization 5417 //===----------------------------------------------------------------------===// 5418 5419 #ifndef NDEBUG 5420 static StmtPrinterHelper* GraphHelper; 5421 #endif 5422 5423 void CFG::viewCFG(const LangOptions &LO) const { 5424 #ifndef NDEBUG 5425 StmtPrinterHelper H(this, LO); 5426 GraphHelper = &H; 5427 llvm::ViewGraph(this,"CFG"); 5428 GraphHelper = nullptr; 5429 #endif 5430 } 5431 5432 namespace llvm { 5433 5434 template<> 5435 struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits { 5436 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {} 5437 5438 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) { 5439 #ifndef NDEBUG 5440 std::string OutSStr; 5441 llvm::raw_string_ostream Out(OutSStr); 5442 print_block(Out,Graph, *Node, *GraphHelper, false, false); 5443 std::string& OutStr = Out.str(); 5444 5445 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin()); 5446 5447 // Process string output to make it nicer... 5448 for (unsigned i = 0; i != OutStr.length(); ++i) 5449 if (OutStr[i] == '\n') { // Left justify 5450 OutStr[i] = '\\'; 5451 OutStr.insert(OutStr.begin()+i+1, 'l'); 5452 } 5453 5454 return OutStr; 5455 #else 5456 return {}; 5457 #endif 5458 } 5459 }; 5460 5461 } // namespace llvm 5462