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