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