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