1 //===- ExprEngine.cpp - Path-Sensitive Expression-Level Dataflow ----------===//
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 a meta-engine for path-sensitive dataflow analysis that
10 //  is built on GREngine, but provides the boilerplate to execute transfer
11 //  functions and build the ExplodedGraph at the expression level.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h"
16 #include "PrettyStackTraceLocationContext.h"
17 #include "clang/AST/ASTContext.h"
18 #include "clang/AST/Decl.h"
19 #include "clang/AST/DeclBase.h"
20 #include "clang/AST/DeclCXX.h"
21 #include "clang/AST/DeclObjC.h"
22 #include "clang/AST/Expr.h"
23 #include "clang/AST/ExprCXX.h"
24 #include "clang/AST/ExprObjC.h"
25 #include "clang/AST/ParentMap.h"
26 #include "clang/AST/PrettyPrinter.h"
27 #include "clang/AST/Stmt.h"
28 #include "clang/AST/StmtCXX.h"
29 #include "clang/AST/StmtObjC.h"
30 #include "clang/AST/Type.h"
31 #include "clang/Analysis/AnalysisDeclContext.h"
32 #include "clang/Analysis/CFG.h"
33 #include "clang/Analysis/ConstructionContext.h"
34 #include "clang/Analysis/ProgramPoint.h"
35 #include "clang/Basic/IdentifierTable.h"
36 #include "clang/Basic/JsonSupport.h"
37 #include "clang/Basic/LLVM.h"
38 #include "clang/Basic/LangOptions.h"
39 #include "clang/Basic/PrettyStackTrace.h"
40 #include "clang/Basic/SourceLocation.h"
41 #include "clang/Basic/SourceManager.h"
42 #include "clang/Basic/Specifiers.h"
43 #include "clang/StaticAnalyzer/Core/AnalyzerOptions.h"
44 #include "clang/StaticAnalyzer/Core/BugReporter/BugReporter.h"
45 #include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
46 #include "clang/StaticAnalyzer/Core/CheckerManager.h"
47 #include "clang/StaticAnalyzer/Core/PathSensitive/AnalysisManager.h"
48 #include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
49 #include "clang/StaticAnalyzer/Core/PathSensitive/ConstraintManager.h"
50 #include "clang/StaticAnalyzer/Core/PathSensitive/CoreEngine.h"
51 #include "clang/StaticAnalyzer/Core/PathSensitive/ExplodedGraph.h"
52 #include "clang/StaticAnalyzer/Core/PathSensitive/LoopUnrolling.h"
53 #include "clang/StaticAnalyzer/Core/PathSensitive/LoopWidening.h"
54 #include "clang/StaticAnalyzer/Core/PathSensitive/MemRegion.h"
55 #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h"
56 #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.h"
57 #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState_Fwd.h"
58 #include "clang/StaticAnalyzer/Core/PathSensitive/SValBuilder.h"
59 #include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h"
60 #include "clang/StaticAnalyzer/Core/PathSensitive/Store.h"
61 #include "clang/StaticAnalyzer/Core/PathSensitive/SymExpr.h"
62 #include "clang/StaticAnalyzer/Core/PathSensitive/SymbolManager.h"
63 #include "llvm/ADT/APSInt.h"
64 #include "llvm/ADT/DenseMap.h"
65 #include "llvm/ADT/ImmutableMap.h"
66 #include "llvm/ADT/ImmutableSet.h"
67 #include "llvm/ADT/Optional.h"
68 #include "llvm/ADT/SmallVector.h"
69 #include "llvm/ADT/Statistic.h"
70 #include "llvm/Support/Casting.h"
71 #include "llvm/Support/Compiler.h"
72 #include "llvm/Support/DOTGraphTraits.h"
73 #include "llvm/Support/ErrorHandling.h"
74 #include "llvm/Support/GraphWriter.h"
75 #include "llvm/Support/SaveAndRestore.h"
76 #include "llvm/Support/raw_ostream.h"
77 #include <cassert>
78 #include <cstdint>
79 #include <memory>
80 #include <string>
81 #include <tuple>
82 #include <utility>
83 #include <vector>
84 
85 using namespace clang;
86 using namespace ento;
87 
88 #define DEBUG_TYPE "ExprEngine"
89 
90 STATISTIC(NumRemoveDeadBindings,
91             "The # of times RemoveDeadBindings is called");
92 STATISTIC(NumMaxBlockCountReached,
93             "The # of aborted paths due to reaching the maximum block count in "
94             "a top level function");
95 STATISTIC(NumMaxBlockCountReachedInInlined,
96             "The # of aborted paths due to reaching the maximum block count in "
97             "an inlined function");
98 STATISTIC(NumTimesRetriedWithoutInlining,
99             "The # of times we re-evaluated a call without inlining");
100 
101 //===----------------------------------------------------------------------===//
102 // Internal program state traits.
103 //===----------------------------------------------------------------------===//
104 
105 namespace {
106 
107 // When modeling a C++ constructor, for a variety of reasons we need to track
108 // the location of the object for the duration of its ConstructionContext.
109 // ObjectsUnderConstruction maps statements within the construction context
110 // to the object's location, so that on every such statement the location
111 // could have been retrieved.
112 
113 /// ConstructedObjectKey is used for being able to find the path-sensitive
114 /// memory region of a freshly constructed object while modeling the AST node
115 /// that syntactically represents the object that is being constructed.
116 /// Semantics of such nodes may sometimes require access to the region that's
117 /// not otherwise present in the program state, or to the very fact that
118 /// the construction context was present and contained references to these
119 /// AST nodes.
120 class ConstructedObjectKey {
121   typedef std::pair<ConstructionContextItem, const LocationContext *>
122       ConstructedObjectKeyImpl;
123 
124   const ConstructedObjectKeyImpl Impl;
125 
126   const void *getAnyASTNodePtr() const {
127     if (const Stmt *S = getItem().getStmtOrNull())
128       return S;
129     else
130       return getItem().getCXXCtorInitializer();
131   }
132 
133 public:
134   explicit ConstructedObjectKey(const ConstructionContextItem &Item,
135                        const LocationContext *LC)
136       : Impl(Item, LC) {}
137 
138   const ConstructionContextItem &getItem() const { return Impl.first; }
139   const LocationContext *getLocationContext() const { return Impl.second; }
140 
141   ASTContext &getASTContext() const {
142     return getLocationContext()->getDecl()->getASTContext();
143   }
144 
145   void printJson(llvm::raw_ostream &Out, PrinterHelper *Helper,
146                  PrintingPolicy &PP) const {
147     const Stmt *S = getItem().getStmtOrNull();
148     const CXXCtorInitializer *I = nullptr;
149     if (!S)
150       I = getItem().getCXXCtorInitializer();
151 
152     if (S)
153       Out << "\"stmt_id\": " << S->getID(getASTContext());
154     else
155       Out << "\"init_id\": " << I->getID(getASTContext());
156 
157     // Kind
158     Out << ", \"kind\": \"" << getItem().getKindAsString()
159         << "\", \"argument_index\": ";
160 
161     if (getItem().getKind() == ConstructionContextItem::ArgumentKind)
162       Out << getItem().getIndex();
163     else
164       Out << "null";
165 
166     // Pretty-print
167     Out << ", \"pretty\": ";
168 
169     if (S) {
170       S->printJson(Out, Helper, PP, /*AddQuotes=*/true);
171     } else {
172       Out << '\"' << I->getAnyMember()->getDeclName() << '\"';
173     }
174   }
175 
176   void Profile(llvm::FoldingSetNodeID &ID) const {
177     ID.Add(Impl.first);
178     ID.AddPointer(Impl.second);
179   }
180 
181   bool operator==(const ConstructedObjectKey &RHS) const {
182     return Impl == RHS.Impl;
183   }
184 
185   bool operator<(const ConstructedObjectKey &RHS) const {
186     return Impl < RHS.Impl;
187   }
188 };
189 } // namespace
190 
191 typedef llvm::ImmutableMap<ConstructedObjectKey, SVal>
192     ObjectsUnderConstructionMap;
193 REGISTER_TRAIT_WITH_PROGRAMSTATE(ObjectsUnderConstruction,
194                                  ObjectsUnderConstructionMap)
195 
196 //===----------------------------------------------------------------------===//
197 // Engine construction and deletion.
198 //===----------------------------------------------------------------------===//
199 
200 static const char* TagProviderName = "ExprEngine";
201 
202 ExprEngine::ExprEngine(cross_tu::CrossTranslationUnitContext &CTU,
203                        AnalysisManager &mgr,
204                        SetOfConstDecls *VisitedCalleesIn,
205                        FunctionSummariesTy *FS,
206                        InliningModes HowToInlineIn)
207     : CTU(CTU), AMgr(mgr),
208       AnalysisDeclContexts(mgr.getAnalysisDeclContextManager()),
209       Engine(*this, FS, mgr.getAnalyzerOptions()), G(Engine.getGraph()),
210       StateMgr(getContext(), mgr.getStoreManagerCreator(),
211                mgr.getConstraintManagerCreator(), G.getAllocator(),
212                this),
213       SymMgr(StateMgr.getSymbolManager()),
214       MRMgr(StateMgr.getRegionManager()),
215       svalBuilder(StateMgr.getSValBuilder()),
216       ObjCNoRet(mgr.getASTContext()),
217       BR(mgr, *this),
218       VisitedCallees(VisitedCalleesIn),
219       HowToInline(HowToInlineIn)
220   {
221   unsigned TrimInterval = mgr.options.GraphTrimInterval;
222   if (TrimInterval != 0) {
223     // Enable eager node reclamation when constructing the ExplodedGraph.
224     G.enableNodeReclamation(TrimInterval);
225   }
226 }
227 
228 //===----------------------------------------------------------------------===//
229 // Utility methods.
230 //===----------------------------------------------------------------------===//
231 
232 ProgramStateRef ExprEngine::getInitialState(const LocationContext *InitLoc) {
233   ProgramStateRef state = StateMgr.getInitialState(InitLoc);
234   const Decl *D = InitLoc->getDecl();
235 
236   // Preconditions.
237   // FIXME: It would be nice if we had a more general mechanism to add
238   // such preconditions.  Some day.
239   do {
240     if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
241       // Precondition: the first argument of 'main' is an integer guaranteed
242       //  to be > 0.
243       const IdentifierInfo *II = FD->getIdentifier();
244       if (!II || !(II->getName() == "main" && FD->getNumParams() > 0))
245         break;
246 
247       const ParmVarDecl *PD = FD->getParamDecl(0);
248       QualType T = PD->getType();
249       const auto *BT = dyn_cast<BuiltinType>(T);
250       if (!BT || !BT->isInteger())
251         break;
252 
253       const MemRegion *R = state->getRegion(PD, InitLoc);
254       if (!R)
255         break;
256 
257       SVal V = state->getSVal(loc::MemRegionVal(R));
258       SVal Constraint_untested = evalBinOp(state, BO_GT, V,
259                                            svalBuilder.makeZeroVal(T),
260                                            svalBuilder.getConditionType());
261 
262       Optional<DefinedOrUnknownSVal> Constraint =
263           Constraint_untested.getAs<DefinedOrUnknownSVal>();
264 
265       if (!Constraint)
266         break;
267 
268       if (ProgramStateRef newState = state->assume(*Constraint, true))
269         state = newState;
270     }
271     break;
272   }
273   while (false);
274 
275   if (const auto *MD = dyn_cast<ObjCMethodDecl>(D)) {
276     // Precondition: 'self' is always non-null upon entry to an Objective-C
277     // method.
278     const ImplicitParamDecl *SelfD = MD->getSelfDecl();
279     const MemRegion *R = state->getRegion(SelfD, InitLoc);
280     SVal V = state->getSVal(loc::MemRegionVal(R));
281 
282     if (Optional<Loc> LV = V.getAs<Loc>()) {
283       // Assume that the pointer value in 'self' is non-null.
284       state = state->assume(*LV, true);
285       assert(state && "'self' cannot be null");
286     }
287   }
288 
289   if (const auto *MD = dyn_cast<CXXMethodDecl>(D)) {
290     if (!MD->isStatic()) {
291       // Precondition: 'this' is always non-null upon entry to the
292       // top-level function.  This is our starting assumption for
293       // analyzing an "open" program.
294       const StackFrameContext *SFC = InitLoc->getStackFrame();
295       if (SFC->getParent() == nullptr) {
296         loc::MemRegionVal L = svalBuilder.getCXXThis(MD, SFC);
297         SVal V = state->getSVal(L);
298         if (Optional<Loc> LV = V.getAs<Loc>()) {
299           state = state->assume(*LV, true);
300           assert(state && "'this' cannot be null");
301         }
302       }
303     }
304   }
305 
306   return state;
307 }
308 
309 ProgramStateRef ExprEngine::createTemporaryRegionIfNeeded(
310     ProgramStateRef State, const LocationContext *LC,
311     const Expr *InitWithAdjustments, const Expr *Result,
312     const SubRegion **OutRegionWithAdjustments) {
313   // FIXME: This function is a hack that works around the quirky AST
314   // we're often having with respect to C++ temporaries. If only we modelled
315   // the actual execution order of statements properly in the CFG,
316   // all the hassle with adjustments would not be necessary,
317   // and perhaps the whole function would be removed.
318   SVal InitValWithAdjustments = State->getSVal(InitWithAdjustments, LC);
319   if (!Result) {
320     // If we don't have an explicit result expression, we're in "if needed"
321     // mode. Only create a region if the current value is a NonLoc.
322     if (!InitValWithAdjustments.getAs<NonLoc>()) {
323       if (OutRegionWithAdjustments)
324         *OutRegionWithAdjustments = nullptr;
325       return State;
326     }
327     Result = InitWithAdjustments;
328   } else {
329     // We need to create a region no matter what. Make sure we don't try to
330     // stuff a Loc into a non-pointer temporary region.
331     assert(!InitValWithAdjustments.getAs<Loc>() ||
332            Loc::isLocType(Result->getType()) ||
333            Result->getType()->isMemberPointerType());
334   }
335 
336   ProgramStateManager &StateMgr = State->getStateManager();
337   MemRegionManager &MRMgr = StateMgr.getRegionManager();
338   StoreManager &StoreMgr = StateMgr.getStoreManager();
339 
340   // MaterializeTemporaryExpr may appear out of place, after a few field and
341   // base-class accesses have been made to the object, even though semantically
342   // it is the whole object that gets materialized and lifetime-extended.
343   //
344   // For example:
345   //
346   //   `-MaterializeTemporaryExpr
347   //     `-MemberExpr
348   //       `-CXXTemporaryObjectExpr
349   //
350   // instead of the more natural
351   //
352   //   `-MemberExpr
353   //     `-MaterializeTemporaryExpr
354   //       `-CXXTemporaryObjectExpr
355   //
356   // Use the usual methods for obtaining the expression of the base object,
357   // and record the adjustments that we need to make to obtain the sub-object
358   // that the whole expression 'Ex' refers to. This trick is usual,
359   // in the sense that CodeGen takes a similar route.
360 
361   SmallVector<const Expr *, 2> CommaLHSs;
362   SmallVector<SubobjectAdjustment, 2> Adjustments;
363 
364   const Expr *Init = InitWithAdjustments->skipRValueSubobjectAdjustments(
365       CommaLHSs, Adjustments);
366 
367   // Take the region for Init, i.e. for the whole object. If we do not remember
368   // the region in which the object originally was constructed, come up with
369   // a new temporary region out of thin air and copy the contents of the object
370   // (which are currently present in the Environment, because Init is an rvalue)
371   // into that region. This is not correct, but it is better than nothing.
372   const TypedValueRegion *TR = nullptr;
373   if (const auto *MT = dyn_cast<MaterializeTemporaryExpr>(Result)) {
374     if (Optional<SVal> V = getObjectUnderConstruction(State, MT, LC)) {
375       State = finishObjectConstruction(State, MT, LC);
376       State = State->BindExpr(Result, LC, *V);
377       return State;
378     } else {
379       StorageDuration SD = MT->getStorageDuration();
380       // If this object is bound to a reference with static storage duration, we
381       // put it in a different region to prevent "address leakage" warnings.
382       if (SD == SD_Static || SD == SD_Thread) {
383         TR = MRMgr.getCXXStaticTempObjectRegion(Init);
384       } else {
385         TR = MRMgr.getCXXTempObjectRegion(Init, LC);
386       }
387     }
388   } else {
389     TR = MRMgr.getCXXTempObjectRegion(Init, LC);
390   }
391 
392   SVal Reg = loc::MemRegionVal(TR);
393   SVal BaseReg = Reg;
394 
395   // Make the necessary adjustments to obtain the sub-object.
396   for (const SubobjectAdjustment &Adj : llvm::reverse(Adjustments)) {
397     switch (Adj.Kind) {
398     case SubobjectAdjustment::DerivedToBaseAdjustment:
399       Reg = StoreMgr.evalDerivedToBase(Reg, Adj.DerivedToBase.BasePath);
400       break;
401     case SubobjectAdjustment::FieldAdjustment:
402       Reg = StoreMgr.getLValueField(Adj.Field, Reg);
403       break;
404     case SubobjectAdjustment::MemberPointerAdjustment:
405       // FIXME: Unimplemented.
406       State = State->invalidateRegions(Reg, InitWithAdjustments,
407                                        currBldrCtx->blockCount(), LC, true,
408                                        nullptr, nullptr, nullptr);
409       return State;
410     }
411   }
412 
413   // What remains is to copy the value of the object to the new region.
414   // FIXME: In other words, what we should always do is copy value of the
415   // Init expression (which corresponds to the bigger object) to the whole
416   // temporary region TR. However, this value is often no longer present
417   // in the Environment. If it has disappeared, we instead invalidate TR.
418   // Still, what we can do is assign the value of expression Ex (which
419   // corresponds to the sub-object) to the TR's sub-region Reg. At least,
420   // values inside Reg would be correct.
421   SVal InitVal = State->getSVal(Init, LC);
422   if (InitVal.isUnknown()) {
423     InitVal = getSValBuilder().conjureSymbolVal(Result, LC, Init->getType(),
424                                                 currBldrCtx->blockCount());
425     State = State->bindLoc(BaseReg.castAs<Loc>(), InitVal, LC, false);
426 
427     // Then we'd need to take the value that certainly exists and bind it
428     // over.
429     if (InitValWithAdjustments.isUnknown()) {
430       // Try to recover some path sensitivity in case we couldn't
431       // compute the value.
432       InitValWithAdjustments = getSValBuilder().conjureSymbolVal(
433           Result, LC, InitWithAdjustments->getType(),
434           currBldrCtx->blockCount());
435     }
436     State =
437         State->bindLoc(Reg.castAs<Loc>(), InitValWithAdjustments, LC, false);
438   } else {
439     State = State->bindLoc(BaseReg.castAs<Loc>(), InitVal, LC, false);
440   }
441 
442   // The result expression would now point to the correct sub-region of the
443   // newly created temporary region. Do this last in order to getSVal of Init
444   // correctly in case (Result == Init).
445   if (Result->isGLValue()) {
446     State = State->BindExpr(Result, LC, Reg);
447   } else {
448     State = State->BindExpr(Result, LC, InitValWithAdjustments);
449   }
450 
451   // Notify checkers once for two bindLoc()s.
452   State = processRegionChange(State, TR, LC);
453 
454   if (OutRegionWithAdjustments)
455     *OutRegionWithAdjustments = cast<SubRegion>(Reg.getAsRegion());
456   return State;
457 }
458 
459 ProgramStateRef
460 ExprEngine::addObjectUnderConstruction(ProgramStateRef State,
461                                        const ConstructionContextItem &Item,
462                                        const LocationContext *LC, SVal V) {
463   ConstructedObjectKey Key(Item, LC->getStackFrame());
464   // FIXME: Currently the state might already contain the marker due to
465   // incorrect handling of temporaries bound to default parameters.
466   assert(!State->get<ObjectsUnderConstruction>(Key) ||
467          Key.getItem().getKind() ==
468              ConstructionContextItem::TemporaryDestructorKind);
469   return State->set<ObjectsUnderConstruction>(Key, V);
470 }
471 
472 Optional<SVal>
473 ExprEngine::getObjectUnderConstruction(ProgramStateRef State,
474                                        const ConstructionContextItem &Item,
475                                        const LocationContext *LC) {
476   ConstructedObjectKey Key(Item, LC->getStackFrame());
477   return Optional<SVal>::create(State->get<ObjectsUnderConstruction>(Key));
478 }
479 
480 ProgramStateRef
481 ExprEngine::finishObjectConstruction(ProgramStateRef State,
482                                      const ConstructionContextItem &Item,
483                                      const LocationContext *LC) {
484   ConstructedObjectKey Key(Item, LC->getStackFrame());
485   assert(State->contains<ObjectsUnderConstruction>(Key));
486   return State->remove<ObjectsUnderConstruction>(Key);
487 }
488 
489 ProgramStateRef ExprEngine::elideDestructor(ProgramStateRef State,
490                                             const CXXBindTemporaryExpr *BTE,
491                                             const LocationContext *LC) {
492   ConstructedObjectKey Key({BTE, /*IsElided=*/true}, LC);
493   // FIXME: Currently the state might already contain the marker due to
494   // incorrect handling of temporaries bound to default parameters.
495   return State->set<ObjectsUnderConstruction>(Key, UnknownVal());
496 }
497 
498 ProgramStateRef
499 ExprEngine::cleanupElidedDestructor(ProgramStateRef State,
500                                     const CXXBindTemporaryExpr *BTE,
501                                     const LocationContext *LC) {
502   ConstructedObjectKey Key({BTE, /*IsElided=*/true}, LC);
503   assert(State->contains<ObjectsUnderConstruction>(Key));
504   return State->remove<ObjectsUnderConstruction>(Key);
505 }
506 
507 bool ExprEngine::isDestructorElided(ProgramStateRef State,
508                                     const CXXBindTemporaryExpr *BTE,
509                                     const LocationContext *LC) {
510   ConstructedObjectKey Key({BTE, /*IsElided=*/true}, LC);
511   return State->contains<ObjectsUnderConstruction>(Key);
512 }
513 
514 bool ExprEngine::areAllObjectsFullyConstructed(ProgramStateRef State,
515                                                const LocationContext *FromLC,
516                                                const LocationContext *ToLC) {
517   const LocationContext *LC = FromLC;
518   while (LC != ToLC) {
519     assert(LC && "ToLC must be a parent of FromLC!");
520     for (auto I : State->get<ObjectsUnderConstruction>())
521       if (I.first.getLocationContext() == LC)
522         return false;
523 
524     LC = LC->getParent();
525   }
526   return true;
527 }
528 
529 
530 //===----------------------------------------------------------------------===//
531 // Top-level transfer function logic (Dispatcher).
532 //===----------------------------------------------------------------------===//
533 
534 /// evalAssume - Called by ConstraintManager. Used to call checker-specific
535 ///  logic for handling assumptions on symbolic values.
536 ProgramStateRef ExprEngine::processAssume(ProgramStateRef state,
537                                               SVal cond, bool assumption) {
538   return getCheckerManager().runCheckersForEvalAssume(state, cond, assumption);
539 }
540 
541 ProgramStateRef
542 ExprEngine::processRegionChanges(ProgramStateRef state,
543                                  const InvalidatedSymbols *invalidated,
544                                  ArrayRef<const MemRegion *> Explicits,
545                                  ArrayRef<const MemRegion *> Regions,
546                                  const LocationContext *LCtx,
547                                  const CallEvent *Call) {
548   return getCheckerManager().runCheckersForRegionChanges(state, invalidated,
549                                                          Explicits, Regions,
550                                                          LCtx, Call);
551 }
552 
553 static void
554 printObjectsUnderConstructionJson(raw_ostream &Out, ProgramStateRef State,
555                                   const char *NL, const LocationContext *LCtx,
556                                   unsigned int Space = 0, bool IsDot = false) {
557   PrintingPolicy PP =
558       LCtx->getAnalysisDeclContext()->getASTContext().getPrintingPolicy();
559 
560   ++Space;
561   bool HasItem = false;
562 
563   // Store the last key.
564   const ConstructedObjectKey *LastKey = nullptr;
565   for (const auto &I : State->get<ObjectsUnderConstruction>()) {
566     const ConstructedObjectKey &Key = I.first;
567     if (Key.getLocationContext() != LCtx)
568       continue;
569 
570     if (!HasItem) {
571       Out << "[" << NL;
572       HasItem = true;
573     }
574 
575     LastKey = &Key;
576   }
577 
578   for (const auto &I : State->get<ObjectsUnderConstruction>()) {
579     const ConstructedObjectKey &Key = I.first;
580     SVal Value = I.second;
581     if (Key.getLocationContext() != LCtx)
582       continue;
583 
584     Indent(Out, Space, IsDot) << "{ ";
585     Key.printJson(Out, nullptr, PP);
586     Out << ", \"value\": \"" << Value << "\" }";
587 
588     if (&Key != LastKey)
589       Out << ',';
590     Out << NL;
591   }
592 
593   if (HasItem)
594     Indent(Out, --Space, IsDot) << ']'; // End of "location_context".
595   else {
596     Out << "null ";
597   }
598 }
599 
600 void ExprEngine::printJson(raw_ostream &Out, ProgramStateRef State,
601                            const LocationContext *LCtx, const char *NL,
602                            unsigned int Space, bool IsDot) const {
603   Indent(Out, Space, IsDot) << "\"constructing_objects\": ";
604 
605   if (LCtx && !State->get<ObjectsUnderConstruction>().isEmpty()) {
606     ++Space;
607     Out << '[' << NL;
608     LCtx->printJson(Out, NL, Space, IsDot, [&](const LocationContext *LC) {
609       printObjectsUnderConstructionJson(Out, State, NL, LC, Space, IsDot);
610     });
611 
612     --Space;
613     Indent(Out, Space, IsDot) << "]," << NL; // End of "constructing_objects".
614   } else {
615     Out << "null," << NL;
616   }
617 
618   getCheckerManager().runCheckersForPrintStateJson(Out, State, NL, Space,
619                                                    IsDot);
620 }
621 
622 void ExprEngine::processEndWorklist() {
623   getCheckerManager().runCheckersForEndAnalysis(G, BR, *this);
624 }
625 
626 void ExprEngine::processCFGElement(const CFGElement E, ExplodedNode *Pred,
627                                    unsigned StmtIdx, NodeBuilderContext *Ctx) {
628   PrettyStackTraceLocationContext CrashInfo(Pred->getLocationContext());
629   currStmtIdx = StmtIdx;
630   currBldrCtx = Ctx;
631 
632   switch (E.getKind()) {
633     case CFGElement::Statement:
634     case CFGElement::Constructor:
635     case CFGElement::CXXRecordTypedCall:
636       ProcessStmt(E.castAs<CFGStmt>().getStmt(), Pred);
637       return;
638     case CFGElement::Initializer:
639       ProcessInitializer(E.castAs<CFGInitializer>(), Pred);
640       return;
641     case CFGElement::NewAllocator:
642       ProcessNewAllocator(E.castAs<CFGNewAllocator>().getAllocatorExpr(),
643                           Pred);
644       return;
645     case CFGElement::AutomaticObjectDtor:
646     case CFGElement::DeleteDtor:
647     case CFGElement::BaseDtor:
648     case CFGElement::MemberDtor:
649     case CFGElement::TemporaryDtor:
650       ProcessImplicitDtor(E.castAs<CFGImplicitDtor>(), Pred);
651       return;
652     case CFGElement::LoopExit:
653       ProcessLoopExit(E.castAs<CFGLoopExit>().getLoopStmt(), Pred);
654       return;
655     case CFGElement::LifetimeEnds:
656     case CFGElement::ScopeBegin:
657     case CFGElement::ScopeEnd:
658       return;
659   }
660 }
661 
662 static bool shouldRemoveDeadBindings(AnalysisManager &AMgr,
663                                      const Stmt *S,
664                                      const ExplodedNode *Pred,
665                                      const LocationContext *LC) {
666   // Are we never purging state values?
667   if (AMgr.options.AnalysisPurgeOpt == PurgeNone)
668     return false;
669 
670   // Is this the beginning of a basic block?
671   if (Pred->getLocation().getAs<BlockEntrance>())
672     return true;
673 
674   // Is this on a non-expression?
675   if (!isa<Expr>(S))
676     return true;
677 
678   // Run before processing a call.
679   if (CallEvent::isCallStmt(S))
680     return true;
681 
682   // Is this an expression that is consumed by another expression?  If so,
683   // postpone cleaning out the state.
684   ParentMap &PM = LC->getAnalysisDeclContext()->getParentMap();
685   return !PM.isConsumedExpr(cast<Expr>(S));
686 }
687 
688 void ExprEngine::removeDead(ExplodedNode *Pred, ExplodedNodeSet &Out,
689                             const Stmt *ReferenceStmt,
690                             const LocationContext *LC,
691                             const Stmt *DiagnosticStmt,
692                             ProgramPoint::Kind K) {
693   assert((K == ProgramPoint::PreStmtPurgeDeadSymbolsKind ||
694           ReferenceStmt == nullptr || isa<ReturnStmt>(ReferenceStmt))
695           && "PostStmt is not generally supported by the SymbolReaper yet");
696   assert(LC && "Must pass the current (or expiring) LocationContext");
697 
698   if (!DiagnosticStmt) {
699     DiagnosticStmt = ReferenceStmt;
700     assert(DiagnosticStmt && "Required for clearing a LocationContext");
701   }
702 
703   NumRemoveDeadBindings++;
704   ProgramStateRef CleanedState = Pred->getState();
705 
706   // LC is the location context being destroyed, but SymbolReaper wants a
707   // location context that is still live. (If this is the top-level stack
708   // frame, this will be null.)
709   if (!ReferenceStmt) {
710     assert(K == ProgramPoint::PostStmtPurgeDeadSymbolsKind &&
711            "Use PostStmtPurgeDeadSymbolsKind for clearing a LocationContext");
712     LC = LC->getParent();
713   }
714 
715   const StackFrameContext *SFC = LC ? LC->getStackFrame() : nullptr;
716   SymbolReaper SymReaper(SFC, ReferenceStmt, SymMgr, getStoreManager());
717 
718   for (auto I : CleanedState->get<ObjectsUnderConstruction>()) {
719     if (SymbolRef Sym = I.second.getAsSymbol())
720       SymReaper.markLive(Sym);
721     if (const MemRegion *MR = I.second.getAsRegion())
722       SymReaper.markLive(MR);
723   }
724 
725   getCheckerManager().runCheckersForLiveSymbols(CleanedState, SymReaper);
726 
727   // Create a state in which dead bindings are removed from the environment
728   // and the store. TODO: The function should just return new env and store,
729   // not a new state.
730   CleanedState = StateMgr.removeDeadBindingsFromEnvironmentAndStore(
731       CleanedState, SFC, SymReaper);
732 
733   // Process any special transfer function for dead symbols.
734   // A tag to track convenience transitions, which can be removed at cleanup.
735   static SimpleProgramPointTag cleanupTag(TagProviderName, "Clean Node");
736   // Call checkers with the non-cleaned state so that they could query the
737   // values of the soon to be dead symbols.
738   ExplodedNodeSet CheckedSet;
739   getCheckerManager().runCheckersForDeadSymbols(CheckedSet, Pred, SymReaper,
740                                                 DiagnosticStmt, *this, K);
741 
742   // For each node in CheckedSet, generate CleanedNodes that have the
743   // environment, the store, and the constraints cleaned up but have the
744   // user-supplied states as the predecessors.
745   StmtNodeBuilder Bldr(CheckedSet, Out, *currBldrCtx);
746   for (const auto I : CheckedSet) {
747     ProgramStateRef CheckerState = I->getState();
748 
749     // The constraint manager has not been cleaned up yet, so clean up now.
750     CheckerState =
751         getConstraintManager().removeDeadBindings(CheckerState, SymReaper);
752 
753     assert(StateMgr.haveEqualEnvironments(CheckerState, Pred->getState()) &&
754            "Checkers are not allowed to modify the Environment as a part of "
755            "checkDeadSymbols processing.");
756     assert(StateMgr.haveEqualStores(CheckerState, Pred->getState()) &&
757            "Checkers are not allowed to modify the Store as a part of "
758            "checkDeadSymbols processing.");
759 
760     // Create a state based on CleanedState with CheckerState GDM and
761     // generate a transition to that state.
762     ProgramStateRef CleanedCheckerSt =
763         StateMgr.getPersistentStateWithGDM(CleanedState, CheckerState);
764     Bldr.generateNode(DiagnosticStmt, I, CleanedCheckerSt, &cleanupTag, K);
765   }
766 }
767 
768 void ExprEngine::ProcessStmt(const Stmt *currStmt, ExplodedNode *Pred) {
769   // Reclaim any unnecessary nodes in the ExplodedGraph.
770   G.reclaimRecentlyAllocatedNodes();
771 
772   PrettyStackTraceLoc CrashInfo(getContext().getSourceManager(),
773                                 currStmt->getBeginLoc(),
774                                 "Error evaluating statement");
775 
776   // Remove dead bindings and symbols.
777   ExplodedNodeSet CleanedStates;
778   if (shouldRemoveDeadBindings(AMgr, currStmt, Pred,
779                                Pred->getLocationContext())) {
780     removeDead(Pred, CleanedStates, currStmt,
781                                     Pred->getLocationContext());
782   } else
783     CleanedStates.Add(Pred);
784 
785   // Visit the statement.
786   ExplodedNodeSet Dst;
787   for (const auto I : CleanedStates) {
788     ExplodedNodeSet DstI;
789     // Visit the statement.
790     Visit(currStmt, I, DstI);
791     Dst.insert(DstI);
792   }
793 
794   // Enqueue the new nodes onto the work list.
795   Engine.enqueue(Dst, currBldrCtx->getBlock(), currStmtIdx);
796 }
797 
798 void ExprEngine::ProcessLoopExit(const Stmt* S, ExplodedNode *Pred) {
799   PrettyStackTraceLoc CrashInfo(getContext().getSourceManager(),
800                                 S->getBeginLoc(),
801                                 "Error evaluating end of the loop");
802   ExplodedNodeSet Dst;
803   Dst.Add(Pred);
804   NodeBuilder Bldr(Pred, Dst, *currBldrCtx);
805   ProgramStateRef NewState = Pred->getState();
806 
807   if(AMgr.options.ShouldUnrollLoops)
808     NewState = processLoopEnd(S, NewState);
809 
810   LoopExit PP(S, Pred->getLocationContext());
811   Bldr.generateNode(PP, NewState, Pred);
812   // Enqueue the new nodes onto the work list.
813   Engine.enqueue(Dst, currBldrCtx->getBlock(), currStmtIdx);
814 }
815 
816 void ExprEngine::ProcessInitializer(const CFGInitializer CFGInit,
817                                     ExplodedNode *Pred) {
818   const CXXCtorInitializer *BMI = CFGInit.getInitializer();
819   const Expr *Init = BMI->getInit()->IgnoreImplicit();
820   const LocationContext *LC = Pred->getLocationContext();
821 
822   PrettyStackTraceLoc CrashInfo(getContext().getSourceManager(),
823                                 BMI->getSourceLocation(),
824                                 "Error evaluating initializer");
825 
826   // We don't clean up dead bindings here.
827   const auto *stackFrame = cast<StackFrameContext>(Pred->getLocationContext());
828   const auto *decl = cast<CXXConstructorDecl>(stackFrame->getDecl());
829 
830   ProgramStateRef State = Pred->getState();
831   SVal thisVal = State->getSVal(svalBuilder.getCXXThis(decl, stackFrame));
832 
833   ExplodedNodeSet Tmp;
834   SVal FieldLoc;
835 
836   // Evaluate the initializer, if necessary
837   if (BMI->isAnyMemberInitializer()) {
838     // Constructors build the object directly in the field,
839     // but non-objects must be copied in from the initializer.
840     if (getObjectUnderConstruction(State, BMI, LC)) {
841       // The field was directly constructed, so there is no need to bind.
842       // But we still need to stop tracking the object under construction.
843       State = finishObjectConstruction(State, BMI, LC);
844       NodeBuilder Bldr(Pred, Tmp, *currBldrCtx);
845       PostStore PS(Init, LC, /*Loc*/ nullptr, /*tag*/ nullptr);
846       Bldr.generateNode(PS, State, Pred);
847     } else {
848       const ValueDecl *Field;
849       if (BMI->isIndirectMemberInitializer()) {
850         Field = BMI->getIndirectMember();
851         FieldLoc = State->getLValue(BMI->getIndirectMember(), thisVal);
852       } else {
853         Field = BMI->getMember();
854         FieldLoc = State->getLValue(BMI->getMember(), thisVal);
855       }
856 
857       SVal InitVal;
858       if (Init->getType()->isArrayType()) {
859         // Handle arrays of trivial type. We can represent this with a
860         // primitive load/copy from the base array region.
861         const ArraySubscriptExpr *ASE;
862         while ((ASE = dyn_cast<ArraySubscriptExpr>(Init)))
863           Init = ASE->getBase()->IgnoreImplicit();
864 
865         SVal LValue = State->getSVal(Init, stackFrame);
866         if (!Field->getType()->isReferenceType())
867           if (Optional<Loc> LValueLoc = LValue.getAs<Loc>())
868             InitVal = State->getSVal(*LValueLoc);
869 
870         // If we fail to get the value for some reason, use a symbolic value.
871         if (InitVal.isUnknownOrUndef()) {
872           SValBuilder &SVB = getSValBuilder();
873           InitVal = SVB.conjureSymbolVal(BMI->getInit(), stackFrame,
874                                          Field->getType(),
875                                          currBldrCtx->blockCount());
876         }
877       } else {
878         InitVal = State->getSVal(BMI->getInit(), stackFrame);
879       }
880 
881       PostInitializer PP(BMI, FieldLoc.getAsRegion(), stackFrame);
882       evalBind(Tmp, Init, Pred, FieldLoc, InitVal, /*isInit=*/true, &PP);
883     }
884   } else {
885     assert(BMI->isBaseInitializer() || BMI->isDelegatingInitializer());
886     Tmp.insert(Pred);
887     // We already did all the work when visiting the CXXConstructExpr.
888   }
889 
890   // Construct PostInitializer nodes whether the state changed or not,
891   // so that the diagnostics don't get confused.
892   PostInitializer PP(BMI, FieldLoc.getAsRegion(), stackFrame);
893   ExplodedNodeSet Dst;
894   NodeBuilder Bldr(Tmp, Dst, *currBldrCtx);
895   for (const auto I : Tmp) {
896     ProgramStateRef State = I->getState();
897     Bldr.generateNode(PP, State, I);
898   }
899 
900   // Enqueue the new nodes onto the work list.
901   Engine.enqueue(Dst, currBldrCtx->getBlock(), currStmtIdx);
902 }
903 
904 void ExprEngine::ProcessImplicitDtor(const CFGImplicitDtor D,
905                                      ExplodedNode *Pred) {
906   ExplodedNodeSet Dst;
907   switch (D.getKind()) {
908   case CFGElement::AutomaticObjectDtor:
909     ProcessAutomaticObjDtor(D.castAs<CFGAutomaticObjDtor>(), Pred, Dst);
910     break;
911   case CFGElement::BaseDtor:
912     ProcessBaseDtor(D.castAs<CFGBaseDtor>(), Pred, Dst);
913     break;
914   case CFGElement::MemberDtor:
915     ProcessMemberDtor(D.castAs<CFGMemberDtor>(), Pred, Dst);
916     break;
917   case CFGElement::TemporaryDtor:
918     ProcessTemporaryDtor(D.castAs<CFGTemporaryDtor>(), Pred, Dst);
919     break;
920   case CFGElement::DeleteDtor:
921     ProcessDeleteDtor(D.castAs<CFGDeleteDtor>(), Pred, Dst);
922     break;
923   default:
924     llvm_unreachable("Unexpected dtor kind.");
925   }
926 
927   // Enqueue the new nodes onto the work list.
928   Engine.enqueue(Dst, currBldrCtx->getBlock(), currStmtIdx);
929 }
930 
931 void ExprEngine::ProcessNewAllocator(const CXXNewExpr *NE,
932                                      ExplodedNode *Pred) {
933   ExplodedNodeSet Dst;
934   AnalysisManager &AMgr = getAnalysisManager();
935   AnalyzerOptions &Opts = AMgr.options;
936   // TODO: We're not evaluating allocators for all cases just yet as
937   // we're not handling the return value correctly, which causes false
938   // positives when the alpha.cplusplus.NewDeleteLeaks check is on.
939   if (Opts.MayInlineCXXAllocator)
940     VisitCXXNewAllocatorCall(NE, Pred, Dst);
941   else {
942     NodeBuilder Bldr(Pred, Dst, *currBldrCtx);
943     const LocationContext *LCtx = Pred->getLocationContext();
944     PostImplicitCall PP(NE->getOperatorNew(), NE->getBeginLoc(), LCtx);
945     Bldr.generateNode(PP, Pred->getState(), Pred);
946   }
947   Engine.enqueue(Dst, currBldrCtx->getBlock(), currStmtIdx);
948 }
949 
950 void ExprEngine::ProcessAutomaticObjDtor(const CFGAutomaticObjDtor Dtor,
951                                          ExplodedNode *Pred,
952                                          ExplodedNodeSet &Dst) {
953   const VarDecl *varDecl = Dtor.getVarDecl();
954   QualType varType = varDecl->getType();
955 
956   ProgramStateRef state = Pred->getState();
957   SVal dest = state->getLValue(varDecl, Pred->getLocationContext());
958   const MemRegion *Region = dest.castAs<loc::MemRegionVal>().getRegion();
959 
960   if (varType->isReferenceType()) {
961     const MemRegion *ValueRegion = state->getSVal(Region).getAsRegion();
962     if (!ValueRegion) {
963       // FIXME: This should not happen. The language guarantees a presence
964       // of a valid initializer here, so the reference shall not be undefined.
965       // It seems that we're calling destructors over variables that
966       // were not initialized yet.
967       return;
968     }
969     Region = ValueRegion->getBaseRegion();
970     varType = cast<TypedValueRegion>(Region)->getValueType();
971   }
972 
973   // FIXME: We need to run the same destructor on every element of the array.
974   // This workaround will just run the first destructor (which will still
975   // invalidate the entire array).
976   EvalCallOptions CallOpts;
977   Region = makeZeroElementRegion(state, loc::MemRegionVal(Region), varType,
978                                  CallOpts.IsArrayCtorOrDtor).getAsRegion();
979 
980   VisitCXXDestructor(varType, Region, Dtor.getTriggerStmt(),
981                      /*IsBase=*/false, Pred, Dst, CallOpts);
982 }
983 
984 void ExprEngine::ProcessDeleteDtor(const CFGDeleteDtor Dtor,
985                                    ExplodedNode *Pred,
986                                    ExplodedNodeSet &Dst) {
987   ProgramStateRef State = Pred->getState();
988   const LocationContext *LCtx = Pred->getLocationContext();
989   const CXXDeleteExpr *DE = Dtor.getDeleteExpr();
990   const Stmt *Arg = DE->getArgument();
991   QualType DTy = DE->getDestroyedType();
992   SVal ArgVal = State->getSVal(Arg, LCtx);
993 
994   // If the argument to delete is known to be a null value,
995   // don't run destructor.
996   if (State->isNull(ArgVal).isConstrainedTrue()) {
997     QualType BTy = getContext().getBaseElementType(DTy);
998     const CXXRecordDecl *RD = BTy->getAsCXXRecordDecl();
999     const CXXDestructorDecl *Dtor = RD->getDestructor();
1000 
1001     PostImplicitCall PP(Dtor, DE->getBeginLoc(), LCtx);
1002     NodeBuilder Bldr(Pred, Dst, *currBldrCtx);
1003     Bldr.generateNode(PP, Pred->getState(), Pred);
1004     return;
1005   }
1006 
1007   EvalCallOptions CallOpts;
1008   const MemRegion *ArgR = ArgVal.getAsRegion();
1009   if (DE->isArrayForm()) {
1010     // FIXME: We need to run the same destructor on every element of the array.
1011     // This workaround will just run the first destructor (which will still
1012     // invalidate the entire array).
1013     CallOpts.IsArrayCtorOrDtor = true;
1014     // Yes, it may even be a multi-dimensional array.
1015     while (const auto *AT = getContext().getAsArrayType(DTy))
1016       DTy = AT->getElementType();
1017     if (ArgR)
1018       ArgR = getStoreManager().GetElementZeroRegion(cast<SubRegion>(ArgR), DTy);
1019   }
1020 
1021   VisitCXXDestructor(DTy, ArgR, DE, /*IsBase=*/false, Pred, Dst, CallOpts);
1022 }
1023 
1024 void ExprEngine::ProcessBaseDtor(const CFGBaseDtor D,
1025                                  ExplodedNode *Pred, ExplodedNodeSet &Dst) {
1026   const LocationContext *LCtx = Pred->getLocationContext();
1027 
1028   const auto *CurDtor = cast<CXXDestructorDecl>(LCtx->getDecl());
1029   Loc ThisPtr = getSValBuilder().getCXXThis(CurDtor,
1030                                             LCtx->getStackFrame());
1031   SVal ThisVal = Pred->getState()->getSVal(ThisPtr);
1032 
1033   // Create the base object region.
1034   const CXXBaseSpecifier *Base = D.getBaseSpecifier();
1035   QualType BaseTy = Base->getType();
1036   SVal BaseVal = getStoreManager().evalDerivedToBase(ThisVal, BaseTy,
1037                                                      Base->isVirtual());
1038 
1039   EvalCallOptions CallOpts;
1040   VisitCXXDestructor(BaseTy, BaseVal.getAsRegion(), CurDtor->getBody(),
1041                      /*IsBase=*/true, Pred, Dst, CallOpts);
1042 }
1043 
1044 void ExprEngine::ProcessMemberDtor(const CFGMemberDtor D,
1045                                    ExplodedNode *Pred, ExplodedNodeSet &Dst) {
1046   const FieldDecl *Member = D.getFieldDecl();
1047   QualType T = Member->getType();
1048   ProgramStateRef State = Pred->getState();
1049   const LocationContext *LCtx = Pred->getLocationContext();
1050 
1051   const auto *CurDtor = cast<CXXDestructorDecl>(LCtx->getDecl());
1052   Loc ThisStorageLoc =
1053       getSValBuilder().getCXXThis(CurDtor, LCtx->getStackFrame());
1054   Loc ThisLoc = State->getSVal(ThisStorageLoc).castAs<Loc>();
1055   SVal FieldVal = State->getLValue(Member, ThisLoc);
1056 
1057   // FIXME: We need to run the same destructor on every element of the array.
1058   // This workaround will just run the first destructor (which will still
1059   // invalidate the entire array).
1060   EvalCallOptions CallOpts;
1061   FieldVal = makeZeroElementRegion(State, FieldVal, T,
1062                                    CallOpts.IsArrayCtorOrDtor);
1063 
1064   VisitCXXDestructor(T, FieldVal.getAsRegion(), CurDtor->getBody(),
1065                      /*IsBase=*/false, Pred, Dst, CallOpts);
1066 }
1067 
1068 void ExprEngine::ProcessTemporaryDtor(const CFGTemporaryDtor D,
1069                                       ExplodedNode *Pred,
1070                                       ExplodedNodeSet &Dst) {
1071   const CXXBindTemporaryExpr *BTE = D.getBindTemporaryExpr();
1072   ProgramStateRef State = Pred->getState();
1073   const LocationContext *LC = Pred->getLocationContext();
1074   const MemRegion *MR = nullptr;
1075 
1076   if (Optional<SVal> V =
1077           getObjectUnderConstruction(State, D.getBindTemporaryExpr(),
1078                                      Pred->getLocationContext())) {
1079     // FIXME: Currently we insert temporary destructors for default parameters,
1080     // but we don't insert the constructors, so the entry in
1081     // ObjectsUnderConstruction may be missing.
1082     State = finishObjectConstruction(State, D.getBindTemporaryExpr(),
1083                                      Pred->getLocationContext());
1084     MR = V->getAsRegion();
1085   }
1086 
1087   // If copy elision has occurred, and the constructor corresponding to the
1088   // destructor was elided, we need to skip the destructor as well.
1089   if (isDestructorElided(State, BTE, LC)) {
1090     State = cleanupElidedDestructor(State, BTE, LC);
1091     NodeBuilder Bldr(Pred, Dst, *currBldrCtx);
1092     PostImplicitCall PP(D.getDestructorDecl(getContext()),
1093                         D.getBindTemporaryExpr()->getBeginLoc(),
1094                         Pred->getLocationContext());
1095     Bldr.generateNode(PP, State, Pred);
1096     return;
1097   }
1098 
1099   ExplodedNodeSet CleanDtorState;
1100   StmtNodeBuilder StmtBldr(Pred, CleanDtorState, *currBldrCtx);
1101   StmtBldr.generateNode(D.getBindTemporaryExpr(), Pred, State);
1102 
1103   QualType T = D.getBindTemporaryExpr()->getSubExpr()->getType();
1104   // FIXME: Currently CleanDtorState can be empty here due to temporaries being
1105   // bound to default parameters.
1106   assert(CleanDtorState.size() <= 1);
1107   ExplodedNode *CleanPred =
1108       CleanDtorState.empty() ? Pred : *CleanDtorState.begin();
1109 
1110   EvalCallOptions CallOpts;
1111   CallOpts.IsTemporaryCtorOrDtor = true;
1112   if (!MR) {
1113     // If we have no MR, we still need to unwrap the array to avoid destroying
1114     // the whole array at once. Regardless, we'd eventually need to model array
1115     // destructors properly, element-by-element.
1116     while (const ArrayType *AT = getContext().getAsArrayType(T)) {
1117       T = AT->getElementType();
1118       CallOpts.IsArrayCtorOrDtor = true;
1119     }
1120   } else {
1121     // We'd eventually need to makeZeroElementRegion() trick here,
1122     // but for now we don't have the respective construction contexts,
1123     // so MR would always be null in this case. Do nothing for now.
1124   }
1125   VisitCXXDestructor(T, MR, D.getBindTemporaryExpr(),
1126                      /*IsBase=*/false, CleanPred, Dst, CallOpts);
1127 }
1128 
1129 void ExprEngine::processCleanupTemporaryBranch(const CXXBindTemporaryExpr *BTE,
1130                                                NodeBuilderContext &BldCtx,
1131                                                ExplodedNode *Pred,
1132                                                ExplodedNodeSet &Dst,
1133                                                const CFGBlock *DstT,
1134                                                const CFGBlock *DstF) {
1135   BranchNodeBuilder TempDtorBuilder(Pred, Dst, BldCtx, DstT, DstF);
1136   ProgramStateRef State = Pred->getState();
1137   const LocationContext *LC = Pred->getLocationContext();
1138   if (getObjectUnderConstruction(State, BTE, LC)) {
1139     TempDtorBuilder.markInfeasible(false);
1140     TempDtorBuilder.generateNode(State, true, Pred);
1141   } else {
1142     TempDtorBuilder.markInfeasible(true);
1143     TempDtorBuilder.generateNode(State, false, Pred);
1144   }
1145 }
1146 
1147 void ExprEngine::VisitCXXBindTemporaryExpr(const CXXBindTemporaryExpr *BTE,
1148                                            ExplodedNodeSet &PreVisit,
1149                                            ExplodedNodeSet &Dst) {
1150   // This is a fallback solution in case we didn't have a construction
1151   // context when we were constructing the temporary. Otherwise the map should
1152   // have been populated there.
1153   if (!getAnalysisManager().options.ShouldIncludeTemporaryDtorsInCFG) {
1154     // In case we don't have temporary destructors in the CFG, do not mark
1155     // the initialization - we would otherwise never clean it up.
1156     Dst = PreVisit;
1157     return;
1158   }
1159   StmtNodeBuilder StmtBldr(PreVisit, Dst, *currBldrCtx);
1160   for (ExplodedNode *Node : PreVisit) {
1161     ProgramStateRef State = Node->getState();
1162     const LocationContext *LC = Node->getLocationContext();
1163     if (!getObjectUnderConstruction(State, BTE, LC)) {
1164       // FIXME: Currently the state might also already contain the marker due to
1165       // incorrect handling of temporaries bound to default parameters; for
1166       // those, we currently skip the CXXBindTemporaryExpr but rely on adding
1167       // temporary destructor nodes.
1168       State = addObjectUnderConstruction(State, BTE, LC, UnknownVal());
1169     }
1170     StmtBldr.generateNode(BTE, Node, State);
1171   }
1172 }
1173 
1174 ProgramStateRef ExprEngine::escapeValues(ProgramStateRef State,
1175                                          ArrayRef<SVal> Vs,
1176                                          PointerEscapeKind K,
1177                                          const CallEvent *Call) const {
1178   class CollectReachableSymbolsCallback final : public SymbolVisitor {
1179     InvalidatedSymbols &Symbols;
1180 
1181   public:
1182     explicit CollectReachableSymbolsCallback(InvalidatedSymbols &Symbols)
1183         : Symbols(Symbols) {}
1184 
1185     const InvalidatedSymbols &getSymbols() const { return Symbols; }
1186 
1187     bool VisitSymbol(SymbolRef Sym) override {
1188       Symbols.insert(Sym);
1189       return true;
1190     }
1191   };
1192   InvalidatedSymbols Symbols;
1193   CollectReachableSymbolsCallback CallBack(Symbols);
1194   for (SVal V : Vs)
1195     State->scanReachableSymbols(V, CallBack);
1196 
1197   return getCheckerManager().runCheckersForPointerEscape(
1198       State, CallBack.getSymbols(), Call, K, nullptr);
1199 }
1200 
1201 void ExprEngine::Visit(const Stmt *S, ExplodedNode *Pred,
1202                        ExplodedNodeSet &DstTop) {
1203   PrettyStackTraceLoc CrashInfo(getContext().getSourceManager(),
1204                                 S->getBeginLoc(), "Error evaluating statement");
1205   ExplodedNodeSet Dst;
1206   StmtNodeBuilder Bldr(Pred, DstTop, *currBldrCtx);
1207 
1208   assert(!isa<Expr>(S) || S == cast<Expr>(S)->IgnoreParens());
1209 
1210   switch (S->getStmtClass()) {
1211     // C++, OpenMP and ARC stuff we don't support yet.
1212     case Stmt::CXXDependentScopeMemberExprClass:
1213     case Stmt::CXXTryStmtClass:
1214     case Stmt::CXXTypeidExprClass:
1215     case Stmt::CXXUuidofExprClass:
1216     case Stmt::CXXFoldExprClass:
1217     case Stmt::MSPropertyRefExprClass:
1218     case Stmt::MSPropertySubscriptExprClass:
1219     case Stmt::CXXUnresolvedConstructExprClass:
1220     case Stmt::DependentScopeDeclRefExprClass:
1221     case Stmt::ArrayTypeTraitExprClass:
1222     case Stmt::ExpressionTraitExprClass:
1223     case Stmt::UnresolvedLookupExprClass:
1224     case Stmt::UnresolvedMemberExprClass:
1225     case Stmt::TypoExprClass:
1226     case Stmt::RecoveryExprClass:
1227     case Stmt::CXXNoexceptExprClass:
1228     case Stmt::PackExpansionExprClass:
1229     case Stmt::SubstNonTypeTemplateParmPackExprClass:
1230     case Stmt::FunctionParmPackExprClass:
1231     case Stmt::CoroutineBodyStmtClass:
1232     case Stmt::CoawaitExprClass:
1233     case Stmt::DependentCoawaitExprClass:
1234     case Stmt::CoreturnStmtClass:
1235     case Stmt::CoyieldExprClass:
1236     case Stmt::SEHTryStmtClass:
1237     case Stmt::SEHExceptStmtClass:
1238     case Stmt::SEHLeaveStmtClass:
1239     case Stmt::SEHFinallyStmtClass:
1240     case Stmt::OMPCanonicalLoopClass:
1241     case Stmt::OMPParallelDirectiveClass:
1242     case Stmt::OMPSimdDirectiveClass:
1243     case Stmt::OMPForDirectiveClass:
1244     case Stmt::OMPForSimdDirectiveClass:
1245     case Stmt::OMPSectionsDirectiveClass:
1246     case Stmt::OMPSectionDirectiveClass:
1247     case Stmt::OMPSingleDirectiveClass:
1248     case Stmt::OMPMasterDirectiveClass:
1249     case Stmt::OMPCriticalDirectiveClass:
1250     case Stmt::OMPParallelForDirectiveClass:
1251     case Stmt::OMPParallelForSimdDirectiveClass:
1252     case Stmt::OMPParallelSectionsDirectiveClass:
1253     case Stmt::OMPParallelMasterDirectiveClass:
1254     case Stmt::OMPTaskDirectiveClass:
1255     case Stmt::OMPTaskyieldDirectiveClass:
1256     case Stmt::OMPBarrierDirectiveClass:
1257     case Stmt::OMPTaskwaitDirectiveClass:
1258     case Stmt::OMPTaskgroupDirectiveClass:
1259     case Stmt::OMPFlushDirectiveClass:
1260     case Stmt::OMPDepobjDirectiveClass:
1261     case Stmt::OMPScanDirectiveClass:
1262     case Stmt::OMPOrderedDirectiveClass:
1263     case Stmt::OMPAtomicDirectiveClass:
1264     case Stmt::OMPTargetDirectiveClass:
1265     case Stmt::OMPTargetDataDirectiveClass:
1266     case Stmt::OMPTargetEnterDataDirectiveClass:
1267     case Stmt::OMPTargetExitDataDirectiveClass:
1268     case Stmt::OMPTargetParallelDirectiveClass:
1269     case Stmt::OMPTargetParallelForDirectiveClass:
1270     case Stmt::OMPTargetUpdateDirectiveClass:
1271     case Stmt::OMPTeamsDirectiveClass:
1272     case Stmt::OMPCancellationPointDirectiveClass:
1273     case Stmt::OMPCancelDirectiveClass:
1274     case Stmt::OMPTaskLoopDirectiveClass:
1275     case Stmt::OMPTaskLoopSimdDirectiveClass:
1276     case Stmt::OMPMasterTaskLoopDirectiveClass:
1277     case Stmt::OMPMasterTaskLoopSimdDirectiveClass:
1278     case Stmt::OMPParallelMasterTaskLoopDirectiveClass:
1279     case Stmt::OMPParallelMasterTaskLoopSimdDirectiveClass:
1280     case Stmt::OMPDistributeDirectiveClass:
1281     case Stmt::OMPDistributeParallelForDirectiveClass:
1282     case Stmt::OMPDistributeParallelForSimdDirectiveClass:
1283     case Stmt::OMPDistributeSimdDirectiveClass:
1284     case Stmt::OMPTargetParallelForSimdDirectiveClass:
1285     case Stmt::OMPTargetSimdDirectiveClass:
1286     case Stmt::OMPTeamsDistributeDirectiveClass:
1287     case Stmt::OMPTeamsDistributeSimdDirectiveClass:
1288     case Stmt::OMPTeamsDistributeParallelForSimdDirectiveClass:
1289     case Stmt::OMPTeamsDistributeParallelForDirectiveClass:
1290     case Stmt::OMPTargetTeamsDirectiveClass:
1291     case Stmt::OMPTargetTeamsDistributeDirectiveClass:
1292     case Stmt::OMPTargetTeamsDistributeParallelForDirectiveClass:
1293     case Stmt::OMPTargetTeamsDistributeParallelForSimdDirectiveClass:
1294     case Stmt::OMPTargetTeamsDistributeSimdDirectiveClass:
1295     case Stmt::OMPTileDirectiveClass:
1296     case Stmt::OMPInteropDirectiveClass:
1297     case Stmt::OMPDispatchDirectiveClass:
1298     case Stmt::OMPMaskedDirectiveClass:
1299     case Stmt::OMPGenericLoopDirectiveClass:
1300     case Stmt::OMPTeamsGenericLoopDirectiveClass:
1301     case Stmt::OMPTargetTeamsGenericLoopDirectiveClass:
1302     case Stmt::OMPParallelGenericLoopDirectiveClass:
1303     case Stmt::CapturedStmtClass:
1304     case Stmt::OMPUnrollDirectiveClass:
1305     case Stmt::OMPMetaDirectiveClass: {
1306       const ExplodedNode *node = Bldr.generateSink(S, Pred, Pred->getState());
1307       Engine.addAbortedBlock(node, currBldrCtx->getBlock());
1308       break;
1309     }
1310 
1311     case Stmt::ParenExprClass:
1312       llvm_unreachable("ParenExprs already handled.");
1313     case Stmt::GenericSelectionExprClass:
1314       llvm_unreachable("GenericSelectionExprs already handled.");
1315     // Cases that should never be evaluated simply because they shouldn't
1316     // appear in the CFG.
1317     case Stmt::BreakStmtClass:
1318     case Stmt::CaseStmtClass:
1319     case Stmt::CompoundStmtClass:
1320     case Stmt::ContinueStmtClass:
1321     case Stmt::CXXForRangeStmtClass:
1322     case Stmt::DefaultStmtClass:
1323     case Stmt::DoStmtClass:
1324     case Stmt::ForStmtClass:
1325     case Stmt::GotoStmtClass:
1326     case Stmt::IfStmtClass:
1327     case Stmt::IndirectGotoStmtClass:
1328     case Stmt::LabelStmtClass:
1329     case Stmt::NoStmtClass:
1330     case Stmt::NullStmtClass:
1331     case Stmt::SwitchStmtClass:
1332     case Stmt::WhileStmtClass:
1333     case Expr::MSDependentExistsStmtClass:
1334       llvm_unreachable("Stmt should not be in analyzer evaluation loop");
1335     case Stmt::ImplicitValueInitExprClass:
1336       // These nodes are shared in the CFG and would case caching out.
1337       // Moreover, no additional evaluation required for them, the
1338       // analyzer can reconstruct these values from the AST.
1339       llvm_unreachable("Should be pruned from CFG");
1340 
1341     case Stmt::ObjCSubscriptRefExprClass:
1342     case Stmt::ObjCPropertyRefExprClass:
1343       llvm_unreachable("These are handled by PseudoObjectExpr");
1344 
1345     case Stmt::GNUNullExprClass: {
1346       // GNU __null is a pointer-width integer, not an actual pointer.
1347       ProgramStateRef state = Pred->getState();
1348       state = state->BindExpr(S, Pred->getLocationContext(),
1349                               svalBuilder.makeIntValWithPtrWidth(0, false));
1350       Bldr.generateNode(S, Pred, state);
1351       break;
1352     }
1353 
1354     case Stmt::ObjCAtSynchronizedStmtClass:
1355       Bldr.takeNodes(Pred);
1356       VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S), Pred, Dst);
1357       Bldr.addNodes(Dst);
1358       break;
1359 
1360     case Expr::ConstantExprClass:
1361     case Stmt::ExprWithCleanupsClass:
1362       // Handled due to fully linearised CFG.
1363       break;
1364 
1365     case Stmt::CXXBindTemporaryExprClass: {
1366       Bldr.takeNodes(Pred);
1367       ExplodedNodeSet PreVisit;
1368       getCheckerManager().runCheckersForPreStmt(PreVisit, Pred, S, *this);
1369       ExplodedNodeSet Next;
1370       VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), PreVisit, Next);
1371       getCheckerManager().runCheckersForPostStmt(Dst, Next, S, *this);
1372       Bldr.addNodes(Dst);
1373       break;
1374     }
1375 
1376     // Cases not handled yet; but will handle some day.
1377     case Stmt::DesignatedInitExprClass:
1378     case Stmt::DesignatedInitUpdateExprClass:
1379     case Stmt::ArrayInitLoopExprClass:
1380     case Stmt::ArrayInitIndexExprClass:
1381     case Stmt::ExtVectorElementExprClass:
1382     case Stmt::ImaginaryLiteralClass:
1383     case Stmt::ObjCAtCatchStmtClass:
1384     case Stmt::ObjCAtFinallyStmtClass:
1385     case Stmt::ObjCAtTryStmtClass:
1386     case Stmt::ObjCAutoreleasePoolStmtClass:
1387     case Stmt::ObjCEncodeExprClass:
1388     case Stmt::ObjCIsaExprClass:
1389     case Stmt::ObjCProtocolExprClass:
1390     case Stmt::ObjCSelectorExprClass:
1391     case Stmt::ParenListExprClass:
1392     case Stmt::ShuffleVectorExprClass:
1393     case Stmt::ConvertVectorExprClass:
1394     case Stmt::VAArgExprClass:
1395     case Stmt::CUDAKernelCallExprClass:
1396     case Stmt::OpaqueValueExprClass:
1397     case Stmt::AsTypeExprClass:
1398     case Stmt::ConceptSpecializationExprClass:
1399     case Stmt::CXXRewrittenBinaryOperatorClass:
1400     case Stmt::RequiresExprClass:
1401       // Fall through.
1402 
1403     // Cases we intentionally don't evaluate, since they don't need
1404     // to be explicitly evaluated.
1405     case Stmt::PredefinedExprClass:
1406     case Stmt::AddrLabelExprClass:
1407     case Stmt::AttributedStmtClass:
1408     case Stmt::IntegerLiteralClass:
1409     case Stmt::FixedPointLiteralClass:
1410     case Stmt::CharacterLiteralClass:
1411     case Stmt::CXXScalarValueInitExprClass:
1412     case Stmt::CXXBoolLiteralExprClass:
1413     case Stmt::ObjCBoolLiteralExprClass:
1414     case Stmt::ObjCAvailabilityCheckExprClass:
1415     case Stmt::FloatingLiteralClass:
1416     case Stmt::NoInitExprClass:
1417     case Stmt::SizeOfPackExprClass:
1418     case Stmt::StringLiteralClass:
1419     case Stmt::SourceLocExprClass:
1420     case Stmt::ObjCStringLiteralClass:
1421     case Stmt::CXXPseudoDestructorExprClass:
1422     case Stmt::SubstNonTypeTemplateParmExprClass:
1423     case Stmt::CXXNullPtrLiteralExprClass:
1424     case Stmt::OMPArraySectionExprClass:
1425     case Stmt::OMPArrayShapingExprClass:
1426     case Stmt::OMPIteratorExprClass:
1427     case Stmt::SYCLUniqueStableNameExprClass:
1428     case Stmt::TypeTraitExprClass: {
1429       Bldr.takeNodes(Pred);
1430       ExplodedNodeSet preVisit;
1431       getCheckerManager().runCheckersForPreStmt(preVisit, Pred, S, *this);
1432       getCheckerManager().runCheckersForPostStmt(Dst, preVisit, S, *this);
1433       Bldr.addNodes(Dst);
1434       break;
1435     }
1436 
1437     case Stmt::CXXDefaultArgExprClass:
1438     case Stmt::CXXDefaultInitExprClass: {
1439       Bldr.takeNodes(Pred);
1440       ExplodedNodeSet PreVisit;
1441       getCheckerManager().runCheckersForPreStmt(PreVisit, Pred, S, *this);
1442 
1443       ExplodedNodeSet Tmp;
1444       StmtNodeBuilder Bldr2(PreVisit, Tmp, *currBldrCtx);
1445 
1446       const Expr *ArgE;
1447       if (const auto *DefE = dyn_cast<CXXDefaultArgExpr>(S))
1448         ArgE = DefE->getExpr();
1449       else if (const auto *DefE = dyn_cast<CXXDefaultInitExpr>(S))
1450         ArgE = DefE->getExpr();
1451       else
1452         llvm_unreachable("unknown constant wrapper kind");
1453 
1454       bool IsTemporary = false;
1455       if (const auto *MTE = dyn_cast<MaterializeTemporaryExpr>(ArgE)) {
1456         ArgE = MTE->getSubExpr();
1457         IsTemporary = true;
1458       }
1459 
1460       Optional<SVal> ConstantVal = svalBuilder.getConstantVal(ArgE);
1461       if (!ConstantVal)
1462         ConstantVal = UnknownVal();
1463 
1464       const LocationContext *LCtx = Pred->getLocationContext();
1465       for (const auto I : PreVisit) {
1466         ProgramStateRef State = I->getState();
1467         State = State->BindExpr(S, LCtx, *ConstantVal);
1468         if (IsTemporary)
1469           State = createTemporaryRegionIfNeeded(State, LCtx,
1470                                                 cast<Expr>(S),
1471                                                 cast<Expr>(S));
1472         Bldr2.generateNode(S, I, State);
1473       }
1474 
1475       getCheckerManager().runCheckersForPostStmt(Dst, Tmp, S, *this);
1476       Bldr.addNodes(Dst);
1477       break;
1478     }
1479 
1480     // Cases we evaluate as opaque expressions, conjuring a symbol.
1481     case Stmt::CXXStdInitializerListExprClass:
1482     case Expr::ObjCArrayLiteralClass:
1483     case Expr::ObjCDictionaryLiteralClass:
1484     case Expr::ObjCBoxedExprClass: {
1485       Bldr.takeNodes(Pred);
1486 
1487       ExplodedNodeSet preVisit;
1488       getCheckerManager().runCheckersForPreStmt(preVisit, Pred, S, *this);
1489 
1490       ExplodedNodeSet Tmp;
1491       StmtNodeBuilder Bldr2(preVisit, Tmp, *currBldrCtx);
1492 
1493       const auto *Ex = cast<Expr>(S);
1494       QualType resultType = Ex->getType();
1495 
1496       for (const auto N : preVisit) {
1497         const LocationContext *LCtx = N->getLocationContext();
1498         SVal result = svalBuilder.conjureSymbolVal(nullptr, Ex, LCtx,
1499                                                    resultType,
1500                                                    currBldrCtx->blockCount());
1501         ProgramStateRef State = N->getState()->BindExpr(Ex, LCtx, result);
1502 
1503         // Escape pointers passed into the list, unless it's an ObjC boxed
1504         // expression which is not a boxable C structure.
1505         if (!(isa<ObjCBoxedExpr>(Ex) &&
1506               !cast<ObjCBoxedExpr>(Ex)->getSubExpr()
1507                                       ->getType()->isRecordType()))
1508           for (auto Child : Ex->children()) {
1509             assert(Child);
1510             SVal Val = State->getSVal(Child, LCtx);
1511             State = escapeValues(State, Val, PSK_EscapeOther);
1512           }
1513 
1514         Bldr2.generateNode(S, N, State);
1515       }
1516 
1517       getCheckerManager().runCheckersForPostStmt(Dst, Tmp, S, *this);
1518       Bldr.addNodes(Dst);
1519       break;
1520     }
1521 
1522     case Stmt::ArraySubscriptExprClass:
1523       Bldr.takeNodes(Pred);
1524       VisitArraySubscriptExpr(cast<ArraySubscriptExpr>(S), Pred, Dst);
1525       Bldr.addNodes(Dst);
1526       break;
1527 
1528     case Stmt::MatrixSubscriptExprClass:
1529       llvm_unreachable("Support for MatrixSubscriptExpr is not implemented.");
1530       break;
1531 
1532     case Stmt::GCCAsmStmtClass:
1533       Bldr.takeNodes(Pred);
1534       VisitGCCAsmStmt(cast<GCCAsmStmt>(S), Pred, Dst);
1535       Bldr.addNodes(Dst);
1536       break;
1537 
1538     case Stmt::MSAsmStmtClass:
1539       Bldr.takeNodes(Pred);
1540       VisitMSAsmStmt(cast<MSAsmStmt>(S), Pred, Dst);
1541       Bldr.addNodes(Dst);
1542       break;
1543 
1544     case Stmt::BlockExprClass:
1545       Bldr.takeNodes(Pred);
1546       VisitBlockExpr(cast<BlockExpr>(S), Pred, Dst);
1547       Bldr.addNodes(Dst);
1548       break;
1549 
1550     case Stmt::LambdaExprClass:
1551       if (AMgr.options.ShouldInlineLambdas) {
1552         Bldr.takeNodes(Pred);
1553         VisitLambdaExpr(cast<LambdaExpr>(S), Pred, Dst);
1554         Bldr.addNodes(Dst);
1555       } else {
1556         const ExplodedNode *node = Bldr.generateSink(S, Pred, Pred->getState());
1557         Engine.addAbortedBlock(node, currBldrCtx->getBlock());
1558       }
1559       break;
1560 
1561     case Stmt::BinaryOperatorClass: {
1562       const auto *B = cast<BinaryOperator>(S);
1563       if (B->isLogicalOp()) {
1564         Bldr.takeNodes(Pred);
1565         VisitLogicalExpr(B, Pred, Dst);
1566         Bldr.addNodes(Dst);
1567         break;
1568       }
1569       else if (B->getOpcode() == BO_Comma) {
1570         ProgramStateRef state = Pred->getState();
1571         Bldr.generateNode(B, Pred,
1572                           state->BindExpr(B, Pred->getLocationContext(),
1573                                           state->getSVal(B->getRHS(),
1574                                                   Pred->getLocationContext())));
1575         break;
1576       }
1577 
1578       Bldr.takeNodes(Pred);
1579 
1580       if (AMgr.options.ShouldEagerlyAssume &&
1581           (B->isRelationalOp() || B->isEqualityOp())) {
1582         ExplodedNodeSet Tmp;
1583         VisitBinaryOperator(cast<BinaryOperator>(S), Pred, Tmp);
1584         evalEagerlyAssumeBinOpBifurcation(Dst, Tmp, cast<Expr>(S));
1585       }
1586       else
1587         VisitBinaryOperator(cast<BinaryOperator>(S), Pred, Dst);
1588 
1589       Bldr.addNodes(Dst);
1590       break;
1591     }
1592 
1593     case Stmt::CXXOperatorCallExprClass: {
1594       const auto *OCE = cast<CXXOperatorCallExpr>(S);
1595 
1596       // For instance method operators, make sure the 'this' argument has a
1597       // valid region.
1598       const Decl *Callee = OCE->getCalleeDecl();
1599       if (const auto *MD = dyn_cast_or_null<CXXMethodDecl>(Callee)) {
1600         if (MD->isInstance()) {
1601           ProgramStateRef State = Pred->getState();
1602           const LocationContext *LCtx = Pred->getLocationContext();
1603           ProgramStateRef NewState =
1604             createTemporaryRegionIfNeeded(State, LCtx, OCE->getArg(0));
1605           if (NewState != State) {
1606             Pred = Bldr.generateNode(OCE, Pred, NewState, /*tag=*/nullptr,
1607                                      ProgramPoint::PreStmtKind);
1608             // Did we cache out?
1609             if (!Pred)
1610               break;
1611           }
1612         }
1613       }
1614       // FALLTHROUGH
1615       LLVM_FALLTHROUGH;
1616     }
1617 
1618     case Stmt::CallExprClass:
1619     case Stmt::CXXMemberCallExprClass:
1620     case Stmt::UserDefinedLiteralClass:
1621       Bldr.takeNodes(Pred);
1622       VisitCallExpr(cast<CallExpr>(S), Pred, Dst);
1623       Bldr.addNodes(Dst);
1624       break;
1625 
1626     case Stmt::CXXCatchStmtClass:
1627       Bldr.takeNodes(Pred);
1628       VisitCXXCatchStmt(cast<CXXCatchStmt>(S), Pred, Dst);
1629       Bldr.addNodes(Dst);
1630       break;
1631 
1632     case Stmt::CXXTemporaryObjectExprClass:
1633     case Stmt::CXXConstructExprClass:
1634       Bldr.takeNodes(Pred);
1635       VisitCXXConstructExpr(cast<CXXConstructExpr>(S), Pred, Dst);
1636       Bldr.addNodes(Dst);
1637       break;
1638 
1639     case Stmt::CXXInheritedCtorInitExprClass:
1640       Bldr.takeNodes(Pred);
1641       VisitCXXInheritedCtorInitExpr(cast<CXXInheritedCtorInitExpr>(S), Pred,
1642                                     Dst);
1643       Bldr.addNodes(Dst);
1644       break;
1645 
1646     case Stmt::CXXNewExprClass: {
1647       Bldr.takeNodes(Pred);
1648 
1649       ExplodedNodeSet PreVisit;
1650       getCheckerManager().runCheckersForPreStmt(PreVisit, Pred, S, *this);
1651 
1652       ExplodedNodeSet PostVisit;
1653       for (const auto i : PreVisit)
1654         VisitCXXNewExpr(cast<CXXNewExpr>(S), i, PostVisit);
1655 
1656       getCheckerManager().runCheckersForPostStmt(Dst, PostVisit, S, *this);
1657       Bldr.addNodes(Dst);
1658       break;
1659     }
1660 
1661     case Stmt::CXXDeleteExprClass: {
1662       Bldr.takeNodes(Pred);
1663       ExplodedNodeSet PreVisit;
1664       const auto *CDE = cast<CXXDeleteExpr>(S);
1665       getCheckerManager().runCheckersForPreStmt(PreVisit, Pred, S, *this);
1666       ExplodedNodeSet PostVisit;
1667       getCheckerManager().runCheckersForPostStmt(PostVisit, PreVisit, S, *this);
1668 
1669       for (const auto i : PostVisit)
1670         VisitCXXDeleteExpr(CDE, i, Dst);
1671 
1672       Bldr.addNodes(Dst);
1673       break;
1674     }
1675       // FIXME: ChooseExpr is really a constant.  We need to fix
1676       //        the CFG do not model them as explicit control-flow.
1677 
1678     case Stmt::ChooseExprClass: { // __builtin_choose_expr
1679       Bldr.takeNodes(Pred);
1680       const auto *C = cast<ChooseExpr>(S);
1681       VisitGuardedExpr(C, C->getLHS(), C->getRHS(), Pred, Dst);
1682       Bldr.addNodes(Dst);
1683       break;
1684     }
1685 
1686     case Stmt::CompoundAssignOperatorClass:
1687       Bldr.takeNodes(Pred);
1688       VisitBinaryOperator(cast<BinaryOperator>(S), Pred, Dst);
1689       Bldr.addNodes(Dst);
1690       break;
1691 
1692     case Stmt::CompoundLiteralExprClass:
1693       Bldr.takeNodes(Pred);
1694       VisitCompoundLiteralExpr(cast<CompoundLiteralExpr>(S), Pred, Dst);
1695       Bldr.addNodes(Dst);
1696       break;
1697 
1698     case Stmt::BinaryConditionalOperatorClass:
1699     case Stmt::ConditionalOperatorClass: { // '?' operator
1700       Bldr.takeNodes(Pred);
1701       const auto *C = cast<AbstractConditionalOperator>(S);
1702       VisitGuardedExpr(C, C->getTrueExpr(), C->getFalseExpr(), Pred, Dst);
1703       Bldr.addNodes(Dst);
1704       break;
1705     }
1706 
1707     case Stmt::CXXThisExprClass:
1708       Bldr.takeNodes(Pred);
1709       VisitCXXThisExpr(cast<CXXThisExpr>(S), Pred, Dst);
1710       Bldr.addNodes(Dst);
1711       break;
1712 
1713     case Stmt::DeclRefExprClass: {
1714       Bldr.takeNodes(Pred);
1715       const auto *DE = cast<DeclRefExpr>(S);
1716       VisitCommonDeclRefExpr(DE, DE->getDecl(), Pred, Dst);
1717       Bldr.addNodes(Dst);
1718       break;
1719     }
1720 
1721     case Stmt::DeclStmtClass:
1722       Bldr.takeNodes(Pred);
1723       VisitDeclStmt(cast<DeclStmt>(S), Pred, Dst);
1724       Bldr.addNodes(Dst);
1725       break;
1726 
1727     case Stmt::ImplicitCastExprClass:
1728     case Stmt::CStyleCastExprClass:
1729     case Stmt::CXXStaticCastExprClass:
1730     case Stmt::CXXDynamicCastExprClass:
1731     case Stmt::CXXReinterpretCastExprClass:
1732     case Stmt::CXXConstCastExprClass:
1733     case Stmt::CXXFunctionalCastExprClass:
1734     case Stmt::BuiltinBitCastExprClass:
1735     case Stmt::ObjCBridgedCastExprClass:
1736     case Stmt::CXXAddrspaceCastExprClass: {
1737       Bldr.takeNodes(Pred);
1738       const auto *C = cast<CastExpr>(S);
1739       ExplodedNodeSet dstExpr;
1740       VisitCast(C, C->getSubExpr(), Pred, dstExpr);
1741 
1742       // Handle the postvisit checks.
1743       getCheckerManager().runCheckersForPostStmt(Dst, dstExpr, C, *this);
1744       Bldr.addNodes(Dst);
1745       break;
1746     }
1747 
1748     case Expr::MaterializeTemporaryExprClass: {
1749       Bldr.takeNodes(Pred);
1750       const auto *MTE = cast<MaterializeTemporaryExpr>(S);
1751       ExplodedNodeSet dstPrevisit;
1752       getCheckerManager().runCheckersForPreStmt(dstPrevisit, Pred, MTE, *this);
1753       ExplodedNodeSet dstExpr;
1754       for (const auto i : dstPrevisit)
1755         CreateCXXTemporaryObject(MTE, i, dstExpr);
1756       getCheckerManager().runCheckersForPostStmt(Dst, dstExpr, MTE, *this);
1757       Bldr.addNodes(Dst);
1758       break;
1759     }
1760 
1761     case Stmt::InitListExprClass:
1762       Bldr.takeNodes(Pred);
1763       VisitInitListExpr(cast<InitListExpr>(S), Pred, Dst);
1764       Bldr.addNodes(Dst);
1765       break;
1766 
1767     case Stmt::MemberExprClass:
1768       Bldr.takeNodes(Pred);
1769       VisitMemberExpr(cast<MemberExpr>(S), Pred, Dst);
1770       Bldr.addNodes(Dst);
1771       break;
1772 
1773     case Stmt::AtomicExprClass:
1774       Bldr.takeNodes(Pred);
1775       VisitAtomicExpr(cast<AtomicExpr>(S), Pred, Dst);
1776       Bldr.addNodes(Dst);
1777       break;
1778 
1779     case Stmt::ObjCIvarRefExprClass:
1780       Bldr.takeNodes(Pred);
1781       VisitLvalObjCIvarRefExpr(cast<ObjCIvarRefExpr>(S), Pred, Dst);
1782       Bldr.addNodes(Dst);
1783       break;
1784 
1785     case Stmt::ObjCForCollectionStmtClass:
1786       Bldr.takeNodes(Pred);
1787       VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S), Pred, Dst);
1788       Bldr.addNodes(Dst);
1789       break;
1790 
1791     case Stmt::ObjCMessageExprClass:
1792       Bldr.takeNodes(Pred);
1793       VisitObjCMessage(cast<ObjCMessageExpr>(S), Pred, Dst);
1794       Bldr.addNodes(Dst);
1795       break;
1796 
1797     case Stmt::ObjCAtThrowStmtClass:
1798     case Stmt::CXXThrowExprClass:
1799       // FIXME: This is not complete.  We basically treat @throw as
1800       // an abort.
1801       Bldr.generateSink(S, Pred, Pred->getState());
1802       break;
1803 
1804     case Stmt::ReturnStmtClass:
1805       Bldr.takeNodes(Pred);
1806       VisitReturnStmt(cast<ReturnStmt>(S), Pred, Dst);
1807       Bldr.addNodes(Dst);
1808       break;
1809 
1810     case Stmt::OffsetOfExprClass: {
1811       Bldr.takeNodes(Pred);
1812       ExplodedNodeSet PreVisit;
1813       getCheckerManager().runCheckersForPreStmt(PreVisit, Pred, S, *this);
1814 
1815       ExplodedNodeSet PostVisit;
1816       for (const auto Node : PreVisit)
1817         VisitOffsetOfExpr(cast<OffsetOfExpr>(S), Node, PostVisit);
1818 
1819       getCheckerManager().runCheckersForPostStmt(Dst, PostVisit, S, *this);
1820       Bldr.addNodes(Dst);
1821       break;
1822     }
1823 
1824     case Stmt::UnaryExprOrTypeTraitExprClass:
1825       Bldr.takeNodes(Pred);
1826       VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
1827                                     Pred, Dst);
1828       Bldr.addNodes(Dst);
1829       break;
1830 
1831     case Stmt::StmtExprClass: {
1832       const auto *SE = cast<StmtExpr>(S);
1833 
1834       if (SE->getSubStmt()->body_empty()) {
1835         // Empty statement expression.
1836         assert(SE->getType() == getContext().VoidTy
1837                && "Empty statement expression must have void type.");
1838         break;
1839       }
1840 
1841       if (const auto *LastExpr =
1842               dyn_cast<Expr>(*SE->getSubStmt()->body_rbegin())) {
1843         ProgramStateRef state = Pred->getState();
1844         Bldr.generateNode(SE, Pred,
1845                           state->BindExpr(SE, Pred->getLocationContext(),
1846                                           state->getSVal(LastExpr,
1847                                                   Pred->getLocationContext())));
1848       }
1849       break;
1850     }
1851 
1852     case Stmt::UnaryOperatorClass: {
1853       Bldr.takeNodes(Pred);
1854       const auto *U = cast<UnaryOperator>(S);
1855       if (AMgr.options.ShouldEagerlyAssume && (U->getOpcode() == UO_LNot)) {
1856         ExplodedNodeSet Tmp;
1857         VisitUnaryOperator(U, Pred, Tmp);
1858         evalEagerlyAssumeBinOpBifurcation(Dst, Tmp, U);
1859       }
1860       else
1861         VisitUnaryOperator(U, Pred, Dst);
1862       Bldr.addNodes(Dst);
1863       break;
1864     }
1865 
1866     case Stmt::PseudoObjectExprClass: {
1867       Bldr.takeNodes(Pred);
1868       ProgramStateRef state = Pred->getState();
1869       const auto *PE = cast<PseudoObjectExpr>(S);
1870       if (const Expr *Result = PE->getResultExpr()) {
1871         SVal V = state->getSVal(Result, Pred->getLocationContext());
1872         Bldr.generateNode(S, Pred,
1873                           state->BindExpr(S, Pred->getLocationContext(), V));
1874       }
1875       else
1876         Bldr.generateNode(S, Pred,
1877                           state->BindExpr(S, Pred->getLocationContext(),
1878                                                    UnknownVal()));
1879 
1880       Bldr.addNodes(Dst);
1881       break;
1882     }
1883 
1884     case Expr::ObjCIndirectCopyRestoreExprClass: {
1885       // ObjCIndirectCopyRestoreExpr implies passing a temporary for
1886       // correctness of lifetime management.  Due to limited analysis
1887       // of ARC, this is implemented as direct arg passing.
1888       Bldr.takeNodes(Pred);
1889       ProgramStateRef state = Pred->getState();
1890       const auto *OIE = cast<ObjCIndirectCopyRestoreExpr>(S);
1891       const Expr *E = OIE->getSubExpr();
1892       SVal V = state->getSVal(E, Pred->getLocationContext());
1893       Bldr.generateNode(S, Pred,
1894               state->BindExpr(S, Pred->getLocationContext(), V));
1895       Bldr.addNodes(Dst);
1896       break;
1897     }
1898   }
1899 }
1900 
1901 bool ExprEngine::replayWithoutInlining(ExplodedNode *N,
1902                                        const LocationContext *CalleeLC) {
1903   const StackFrameContext *CalleeSF = CalleeLC->getStackFrame();
1904   const StackFrameContext *CallerSF = CalleeSF->getParent()->getStackFrame();
1905   assert(CalleeSF && CallerSF);
1906   ExplodedNode *BeforeProcessingCall = nullptr;
1907   const Stmt *CE = CalleeSF->getCallSite();
1908 
1909   // Find the first node before we started processing the call expression.
1910   while (N) {
1911     ProgramPoint L = N->getLocation();
1912     BeforeProcessingCall = N;
1913     N = N->pred_empty() ? nullptr : *(N->pred_begin());
1914 
1915     // Skip the nodes corresponding to the inlined code.
1916     if (L.getStackFrame() != CallerSF)
1917       continue;
1918     // We reached the caller. Find the node right before we started
1919     // processing the call.
1920     if (L.isPurgeKind())
1921       continue;
1922     if (L.getAs<PreImplicitCall>())
1923       continue;
1924     if (L.getAs<CallEnter>())
1925       continue;
1926     if (Optional<StmtPoint> SP = L.getAs<StmtPoint>())
1927       if (SP->getStmt() == CE)
1928         continue;
1929     break;
1930   }
1931 
1932   if (!BeforeProcessingCall)
1933     return false;
1934 
1935   // TODO: Clean up the unneeded nodes.
1936 
1937   // Build an Epsilon node from which we will restart the analyzes.
1938   // Note that CE is permitted to be NULL!
1939   ProgramPoint NewNodeLoc =
1940                EpsilonPoint(BeforeProcessingCall->getLocationContext(), CE);
1941   // Add the special flag to GDM to signal retrying with no inlining.
1942   // Note, changing the state ensures that we are not going to cache out.
1943   ProgramStateRef NewNodeState = BeforeProcessingCall->getState();
1944   NewNodeState =
1945     NewNodeState->set<ReplayWithoutInlining>(const_cast<Stmt *>(CE));
1946 
1947   // Make the new node a successor of BeforeProcessingCall.
1948   bool IsNew = false;
1949   ExplodedNode *NewNode = G.getNode(NewNodeLoc, NewNodeState, false, &IsNew);
1950   // We cached out at this point. Caching out is common due to us backtracking
1951   // from the inlined function, which might spawn several paths.
1952   if (!IsNew)
1953     return true;
1954 
1955   NewNode->addPredecessor(BeforeProcessingCall, G);
1956 
1957   // Add the new node to the work list.
1958   Engine.enqueueStmtNode(NewNode, CalleeSF->getCallSiteBlock(),
1959                                   CalleeSF->getIndex());
1960   NumTimesRetriedWithoutInlining++;
1961   return true;
1962 }
1963 
1964 /// Block entrance.  (Update counters).
1965 void ExprEngine::processCFGBlockEntrance(const BlockEdge &L,
1966                                          NodeBuilderWithSinks &nodeBuilder,
1967                                          ExplodedNode *Pred) {
1968   PrettyStackTraceLocationContext CrashInfo(Pred->getLocationContext());
1969   // If we reach a loop which has a known bound (and meets
1970   // other constraints) then consider completely unrolling it.
1971   if(AMgr.options.ShouldUnrollLoops) {
1972     unsigned maxBlockVisitOnPath = AMgr.options.maxBlockVisitOnPath;
1973     const Stmt *Term = nodeBuilder.getContext().getBlock()->getTerminatorStmt();
1974     if (Term) {
1975       ProgramStateRef NewState = updateLoopStack(Term, AMgr.getASTContext(),
1976                                                  Pred, maxBlockVisitOnPath);
1977       if (NewState != Pred->getState()) {
1978         ExplodedNode *UpdatedNode = nodeBuilder.generateNode(NewState, Pred);
1979         if (!UpdatedNode)
1980           return;
1981         Pred = UpdatedNode;
1982       }
1983     }
1984     // Is we are inside an unrolled loop then no need the check the counters.
1985     if(isUnrolledState(Pred->getState()))
1986       return;
1987   }
1988 
1989   // If this block is terminated by a loop and it has already been visited the
1990   // maximum number of times, widen the loop.
1991   unsigned int BlockCount = nodeBuilder.getContext().blockCount();
1992   if (BlockCount == AMgr.options.maxBlockVisitOnPath - 1 &&
1993       AMgr.options.ShouldWidenLoops) {
1994     const Stmt *Term = nodeBuilder.getContext().getBlock()->getTerminatorStmt();
1995     if (!isa_and_nonnull<ForStmt, WhileStmt, DoStmt>(Term))
1996       return;
1997     // Widen.
1998     const LocationContext *LCtx = Pred->getLocationContext();
1999     ProgramStateRef WidenedState =
2000         getWidenedLoopState(Pred->getState(), LCtx, BlockCount, Term);
2001     nodeBuilder.generateNode(WidenedState, Pred);
2002     return;
2003   }
2004 
2005   // FIXME: Refactor this into a checker.
2006   if (BlockCount >= AMgr.options.maxBlockVisitOnPath) {
2007     static SimpleProgramPointTag tag(TagProviderName, "Block count exceeded");
2008     const ExplodedNode *Sink =
2009                    nodeBuilder.generateSink(Pred->getState(), Pred, &tag);
2010 
2011     // Check if we stopped at the top level function or not.
2012     // Root node should have the location context of the top most function.
2013     const LocationContext *CalleeLC = Pred->getLocation().getLocationContext();
2014     const LocationContext *CalleeSF = CalleeLC->getStackFrame();
2015     const LocationContext *RootLC =
2016                         (*G.roots_begin())->getLocation().getLocationContext();
2017     if (RootLC->getStackFrame() != CalleeSF) {
2018       Engine.FunctionSummaries->markReachedMaxBlockCount(CalleeSF->getDecl());
2019 
2020       // Re-run the call evaluation without inlining it, by storing the
2021       // no-inlining policy in the state and enqueuing the new work item on
2022       // the list. Replay should almost never fail. Use the stats to catch it
2023       // if it does.
2024       if ((!AMgr.options.NoRetryExhausted &&
2025            replayWithoutInlining(Pred, CalleeLC)))
2026         return;
2027       NumMaxBlockCountReachedInInlined++;
2028     } else
2029       NumMaxBlockCountReached++;
2030 
2031     // Make sink nodes as exhausted(for stats) only if retry failed.
2032     Engine.blocksExhausted.push_back(std::make_pair(L, Sink));
2033   }
2034 }
2035 
2036 //===----------------------------------------------------------------------===//
2037 // Branch processing.
2038 //===----------------------------------------------------------------------===//
2039 
2040 /// RecoverCastedSymbol - A helper function for ProcessBranch that is used
2041 /// to try to recover some path-sensitivity for casts of symbolic
2042 /// integers that promote their values (which are currently not tracked well).
2043 /// This function returns the SVal bound to Condition->IgnoreCasts if all the
2044 //  cast(s) did was sign-extend the original value.
2045 static SVal RecoverCastedSymbol(ProgramStateRef state,
2046                                 const Stmt *Condition,
2047                                 const LocationContext *LCtx,
2048                                 ASTContext &Ctx) {
2049 
2050   const auto *Ex = dyn_cast<Expr>(Condition);
2051   if (!Ex)
2052     return UnknownVal();
2053 
2054   uint64_t bits = 0;
2055   bool bitsInit = false;
2056 
2057   while (const auto *CE = dyn_cast<CastExpr>(Ex)) {
2058     QualType T = CE->getType();
2059 
2060     if (!T->isIntegralOrEnumerationType())
2061       return UnknownVal();
2062 
2063     uint64_t newBits = Ctx.getTypeSize(T);
2064     if (!bitsInit || newBits < bits) {
2065       bitsInit = true;
2066       bits = newBits;
2067     }
2068 
2069     Ex = CE->getSubExpr();
2070   }
2071 
2072   // We reached a non-cast.  Is it a symbolic value?
2073   QualType T = Ex->getType();
2074 
2075   if (!bitsInit || !T->isIntegralOrEnumerationType() ||
2076       Ctx.getTypeSize(T) > bits)
2077     return UnknownVal();
2078 
2079   return state->getSVal(Ex, LCtx);
2080 }
2081 
2082 #ifndef NDEBUG
2083 static const Stmt *getRightmostLeaf(const Stmt *Condition) {
2084   while (Condition) {
2085     const auto *BO = dyn_cast<BinaryOperator>(Condition);
2086     if (!BO || !BO->isLogicalOp()) {
2087       return Condition;
2088     }
2089     Condition = BO->getRHS()->IgnoreParens();
2090   }
2091   return nullptr;
2092 }
2093 #endif
2094 
2095 // Returns the condition the branch at the end of 'B' depends on and whose value
2096 // has been evaluated within 'B'.
2097 // In most cases, the terminator condition of 'B' will be evaluated fully in
2098 // the last statement of 'B'; in those cases, the resolved condition is the
2099 // given 'Condition'.
2100 // If the condition of the branch is a logical binary operator tree, the CFG is
2101 // optimized: in that case, we know that the expression formed by all but the
2102 // rightmost leaf of the logical binary operator tree must be true, and thus
2103 // the branch condition is at this point equivalent to the truth value of that
2104 // rightmost leaf; the CFG block thus only evaluates this rightmost leaf
2105 // expression in its final statement. As the full condition in that case was
2106 // not evaluated, and is thus not in the SVal cache, we need to use that leaf
2107 // expression to evaluate the truth value of the condition in the current state
2108 // space.
2109 static const Stmt *ResolveCondition(const Stmt *Condition,
2110                                     const CFGBlock *B) {
2111   if (const auto *Ex = dyn_cast<Expr>(Condition))
2112     Condition = Ex->IgnoreParens();
2113 
2114   const auto *BO = dyn_cast<BinaryOperator>(Condition);
2115   if (!BO || !BO->isLogicalOp())
2116     return Condition;
2117 
2118   assert(B->getTerminator().isStmtBranch() &&
2119          "Other kinds of branches are handled separately!");
2120 
2121   // For logical operations, we still have the case where some branches
2122   // use the traditional "merge" approach and others sink the branch
2123   // directly into the basic blocks representing the logical operation.
2124   // We need to distinguish between those two cases here.
2125 
2126   // The invariants are still shifting, but it is possible that the
2127   // last element in a CFGBlock is not a CFGStmt.  Look for the last
2128   // CFGStmt as the value of the condition.
2129   CFGBlock::const_reverse_iterator I = B->rbegin(), E = B->rend();
2130   for (; I != E; ++I) {
2131     CFGElement Elem = *I;
2132     Optional<CFGStmt> CS = Elem.getAs<CFGStmt>();
2133     if (!CS)
2134       continue;
2135     const Stmt *LastStmt = CS->getStmt();
2136     assert(LastStmt == Condition || LastStmt == getRightmostLeaf(Condition));
2137     return LastStmt;
2138   }
2139   llvm_unreachable("could not resolve condition");
2140 }
2141 
2142 using ObjCForLctxPair =
2143     std::pair<const ObjCForCollectionStmt *, const LocationContext *>;
2144 
2145 REGISTER_MAP_WITH_PROGRAMSTATE(ObjCForHasMoreIterations, ObjCForLctxPair, bool)
2146 
2147 ProgramStateRef ExprEngine::setWhetherHasMoreIteration(
2148     ProgramStateRef State, const ObjCForCollectionStmt *O,
2149     const LocationContext *LC, bool HasMoreIteraton) {
2150   assert(!State->contains<ObjCForHasMoreIterations>({O, LC}));
2151   return State->set<ObjCForHasMoreIterations>({O, LC}, HasMoreIteraton);
2152 }
2153 
2154 ProgramStateRef
2155 ExprEngine::removeIterationState(ProgramStateRef State,
2156                                  const ObjCForCollectionStmt *O,
2157                                  const LocationContext *LC) {
2158   assert(State->contains<ObjCForHasMoreIterations>({O, LC}));
2159   return State->remove<ObjCForHasMoreIterations>({O, LC});
2160 }
2161 
2162 bool ExprEngine::hasMoreIteration(ProgramStateRef State,
2163                                   const ObjCForCollectionStmt *O,
2164                                   const LocationContext *LC) {
2165   assert(State->contains<ObjCForHasMoreIterations>({O, LC}));
2166   return *State->get<ObjCForHasMoreIterations>({O, LC});
2167 }
2168 
2169 /// Split the state on whether there are any more iterations left for this loop.
2170 /// Returns a (HasMoreIteration, HasNoMoreIteration) pair, or None when the
2171 /// acquisition of the loop condition value failed.
2172 static Optional<std::pair<ProgramStateRef, ProgramStateRef>>
2173 assumeCondition(const Stmt *Condition, ExplodedNode *N) {
2174   ProgramStateRef State = N->getState();
2175   if (const auto *ObjCFor = dyn_cast<ObjCForCollectionStmt>(Condition)) {
2176     bool HasMoreIteraton =
2177         ExprEngine::hasMoreIteration(State, ObjCFor, N->getLocationContext());
2178     // Checkers have already ran on branch conditions, so the current
2179     // information as to whether the loop has more iteration becomes outdated
2180     // after this point.
2181     State = ExprEngine::removeIterationState(State, ObjCFor,
2182                                              N->getLocationContext());
2183     if (HasMoreIteraton)
2184       return std::pair<ProgramStateRef, ProgramStateRef>{State, nullptr};
2185     else
2186       return std::pair<ProgramStateRef, ProgramStateRef>{nullptr, State};
2187   }
2188   SVal X = State->getSVal(Condition, N->getLocationContext());
2189 
2190   if (X.isUnknownOrUndef()) {
2191     // Give it a chance to recover from unknown.
2192     if (const auto *Ex = dyn_cast<Expr>(Condition)) {
2193       if (Ex->getType()->isIntegralOrEnumerationType()) {
2194         // Try to recover some path-sensitivity.  Right now casts of symbolic
2195         // integers that promote their values are currently not tracked well.
2196         // If 'Condition' is such an expression, try and recover the
2197         // underlying value and use that instead.
2198         SVal recovered =
2199             RecoverCastedSymbol(State, Condition, N->getLocationContext(),
2200                                 N->getState()->getStateManager().getContext());
2201 
2202         if (!recovered.isUnknown()) {
2203           X = recovered;
2204         }
2205       }
2206     }
2207   }
2208 
2209   // If the condition is still unknown, give up.
2210   if (X.isUnknownOrUndef())
2211     return None;
2212 
2213   DefinedSVal V = X.castAs<DefinedSVal>();
2214 
2215   ProgramStateRef StTrue, StFalse;
2216   return State->assume(V);
2217 }
2218 
2219 void ExprEngine::processBranch(const Stmt *Condition,
2220                                NodeBuilderContext& BldCtx,
2221                                ExplodedNode *Pred,
2222                                ExplodedNodeSet &Dst,
2223                                const CFGBlock *DstT,
2224                                const CFGBlock *DstF) {
2225   assert((!Condition || !isa<CXXBindTemporaryExpr>(Condition)) &&
2226          "CXXBindTemporaryExprs are handled by processBindTemporary.");
2227   const LocationContext *LCtx = Pred->getLocationContext();
2228   PrettyStackTraceLocationContext StackCrashInfo(LCtx);
2229   currBldrCtx = &BldCtx;
2230 
2231   // Check for NULL conditions; e.g. "for(;;)"
2232   if (!Condition) {
2233     BranchNodeBuilder NullCondBldr(Pred, Dst, BldCtx, DstT, DstF);
2234     NullCondBldr.markInfeasible(false);
2235     NullCondBldr.generateNode(Pred->getState(), true, Pred);
2236     return;
2237   }
2238 
2239   if (const auto *Ex = dyn_cast<Expr>(Condition))
2240     Condition = Ex->IgnoreParens();
2241 
2242   Condition = ResolveCondition(Condition, BldCtx.getBlock());
2243   PrettyStackTraceLoc CrashInfo(getContext().getSourceManager(),
2244                                 Condition->getBeginLoc(),
2245                                 "Error evaluating branch");
2246 
2247   ExplodedNodeSet CheckersOutSet;
2248   getCheckerManager().runCheckersForBranchCondition(Condition, CheckersOutSet,
2249                                                     Pred, *this);
2250   // We generated only sinks.
2251   if (CheckersOutSet.empty())
2252     return;
2253 
2254   BranchNodeBuilder builder(CheckersOutSet, Dst, BldCtx, DstT, DstF);
2255   for (ExplodedNode *PredN : CheckersOutSet) {
2256     if (PredN->isSink())
2257       continue;
2258 
2259     ProgramStateRef PrevState = PredN->getState();
2260 
2261     ProgramStateRef StTrue, StFalse;
2262     if (const auto KnownCondValueAssumption = assumeCondition(Condition, PredN))
2263       std::tie(StTrue, StFalse) = *KnownCondValueAssumption;
2264     else {
2265       assert(!isa<ObjCForCollectionStmt>(Condition));
2266       builder.generateNode(PrevState, true, PredN);
2267       builder.generateNode(PrevState, false, PredN);
2268       continue;
2269     }
2270     if (StTrue && StFalse)
2271       assert(!isa<ObjCForCollectionStmt>(Condition));
2272 
2273     // Process the true branch.
2274     if (builder.isFeasible(true)) {
2275       if (StTrue)
2276         builder.generateNode(StTrue, true, PredN);
2277       else
2278         builder.markInfeasible(true);
2279     }
2280 
2281     // Process the false branch.
2282     if (builder.isFeasible(false)) {
2283       if (StFalse)
2284         builder.generateNode(StFalse, false, PredN);
2285       else
2286         builder.markInfeasible(false);
2287     }
2288   }
2289   currBldrCtx = nullptr;
2290 }
2291 
2292 /// The GDM component containing the set of global variables which have been
2293 /// previously initialized with explicit initializers.
2294 REGISTER_TRAIT_WITH_PROGRAMSTATE(InitializedGlobalsSet,
2295                                  llvm::ImmutableSet<const VarDecl *>)
2296 
2297 void ExprEngine::processStaticInitializer(const DeclStmt *DS,
2298                                           NodeBuilderContext &BuilderCtx,
2299                                           ExplodedNode *Pred,
2300                                           ExplodedNodeSet &Dst,
2301                                           const CFGBlock *DstT,
2302                                           const CFGBlock *DstF) {
2303   PrettyStackTraceLocationContext CrashInfo(Pred->getLocationContext());
2304   currBldrCtx = &BuilderCtx;
2305 
2306   const auto *VD = cast<VarDecl>(DS->getSingleDecl());
2307   ProgramStateRef state = Pred->getState();
2308   bool initHasRun = state->contains<InitializedGlobalsSet>(VD);
2309   BranchNodeBuilder builder(Pred, Dst, BuilderCtx, DstT, DstF);
2310 
2311   if (!initHasRun) {
2312     state = state->add<InitializedGlobalsSet>(VD);
2313   }
2314 
2315   builder.generateNode(state, initHasRun, Pred);
2316   builder.markInfeasible(!initHasRun);
2317 
2318   currBldrCtx = nullptr;
2319 }
2320 
2321 /// processIndirectGoto - Called by CoreEngine.  Used to generate successor
2322 ///  nodes by processing the 'effects' of a computed goto jump.
2323 void ExprEngine::processIndirectGoto(IndirectGotoNodeBuilder &builder) {
2324   ProgramStateRef state = builder.getState();
2325   SVal V = state->getSVal(builder.getTarget(), builder.getLocationContext());
2326 
2327   // Three possibilities:
2328   //
2329   //   (1) We know the computed label.
2330   //   (2) The label is NULL (or some other constant), or Undefined.
2331   //   (3) We have no clue about the label.  Dispatch to all targets.
2332   //
2333 
2334   using iterator = IndirectGotoNodeBuilder::iterator;
2335 
2336   if (Optional<loc::GotoLabel> LV = V.getAs<loc::GotoLabel>()) {
2337     const LabelDecl *L = LV->getLabel();
2338 
2339     for (iterator I = builder.begin(), E = builder.end(); I != E; ++I) {
2340       if (I.getLabel() == L) {
2341         builder.generateNode(I, state);
2342         return;
2343       }
2344     }
2345 
2346     llvm_unreachable("No block with label.");
2347   }
2348 
2349   if (V.getAs<loc::ConcreteInt>() || V.getAs<UndefinedVal>()) {
2350     // Dispatch to the first target and mark it as a sink.
2351     //ExplodedNode* N = builder.generateNode(builder.begin(), state, true);
2352     // FIXME: add checker visit.
2353     //    UndefBranches.insert(N);
2354     return;
2355   }
2356 
2357   // This is really a catch-all.  We don't support symbolics yet.
2358   // FIXME: Implement dispatch for symbolic pointers.
2359 
2360   for (iterator I = builder.begin(), E = builder.end(); I != E; ++I)
2361     builder.generateNode(I, state);
2362 }
2363 
2364 void ExprEngine::processBeginOfFunction(NodeBuilderContext &BC,
2365                                         ExplodedNode *Pred,
2366                                         ExplodedNodeSet &Dst,
2367                                         const BlockEdge &L) {
2368   SaveAndRestore<const NodeBuilderContext *> NodeContextRAII(currBldrCtx, &BC);
2369   getCheckerManager().runCheckersForBeginFunction(Dst, L, Pred, *this);
2370 }
2371 
2372 /// ProcessEndPath - Called by CoreEngine.  Used to generate end-of-path
2373 ///  nodes when the control reaches the end of a function.
2374 void ExprEngine::processEndOfFunction(NodeBuilderContext& BC,
2375                                       ExplodedNode *Pred,
2376                                       const ReturnStmt *RS) {
2377   ProgramStateRef State = Pred->getState();
2378 
2379   if (!Pred->getStackFrame()->inTopFrame())
2380     State = finishArgumentConstruction(
2381         State, *getStateManager().getCallEventManager().getCaller(
2382                    Pred->getStackFrame(), Pred->getState()));
2383 
2384   // FIXME: We currently cannot assert that temporaries are clear, because
2385   // lifetime extended temporaries are not always modelled correctly. In some
2386   // cases when we materialize the temporary, we do
2387   // createTemporaryRegionIfNeeded(), and the region changes, and also the
2388   // respective destructor becomes automatic from temporary. So for now clean up
2389   // the state manually before asserting. Ideally, this braced block of code
2390   // should go away.
2391   {
2392     const LocationContext *FromLC = Pred->getLocationContext();
2393     const LocationContext *ToLC = FromLC->getStackFrame()->getParent();
2394     const LocationContext *LC = FromLC;
2395     while (LC != ToLC) {
2396       assert(LC && "ToLC must be a parent of FromLC!");
2397       for (auto I : State->get<ObjectsUnderConstruction>())
2398         if (I.first.getLocationContext() == LC) {
2399           // The comment above only pardons us for not cleaning up a
2400           // temporary destructor. If any other statements are found here,
2401           // it must be a separate problem.
2402           assert(I.first.getItem().getKind() ==
2403                      ConstructionContextItem::TemporaryDestructorKind ||
2404                  I.first.getItem().getKind() ==
2405                      ConstructionContextItem::ElidedDestructorKind);
2406           State = State->remove<ObjectsUnderConstruction>(I.first);
2407         }
2408       LC = LC->getParent();
2409     }
2410   }
2411 
2412   // Perform the transition with cleanups.
2413   if (State != Pred->getState()) {
2414     ExplodedNodeSet PostCleanup;
2415     NodeBuilder Bldr(Pred, PostCleanup, BC);
2416     Pred = Bldr.generateNode(Pred->getLocation(), State, Pred);
2417     if (!Pred) {
2418       // The node with clean temporaries already exists. We might have reached
2419       // it on a path on which we initialize different temporaries.
2420       return;
2421     }
2422   }
2423 
2424   assert(areAllObjectsFullyConstructed(Pred->getState(),
2425                                        Pred->getLocationContext(),
2426                                        Pred->getStackFrame()->getParent()));
2427 
2428   PrettyStackTraceLocationContext CrashInfo(Pred->getLocationContext());
2429 
2430   ExplodedNodeSet Dst;
2431   if (Pred->getLocationContext()->inTopFrame()) {
2432     // Remove dead symbols.
2433     ExplodedNodeSet AfterRemovedDead;
2434     removeDeadOnEndOfFunction(BC, Pred, AfterRemovedDead);
2435 
2436     // Notify checkers.
2437     for (const auto I : AfterRemovedDead)
2438       getCheckerManager().runCheckersForEndFunction(BC, Dst, I, *this, RS);
2439   } else {
2440     getCheckerManager().runCheckersForEndFunction(BC, Dst, Pred, *this, RS);
2441   }
2442 
2443   Engine.enqueueEndOfFunction(Dst, RS);
2444 }
2445 
2446 /// ProcessSwitch - Called by CoreEngine.  Used to generate successor
2447 ///  nodes by processing the 'effects' of a switch statement.
2448 void ExprEngine::processSwitch(SwitchNodeBuilder& builder) {
2449   using iterator = SwitchNodeBuilder::iterator;
2450 
2451   ProgramStateRef state = builder.getState();
2452   const Expr *CondE = builder.getCondition();
2453   SVal  CondV_untested = state->getSVal(CondE, builder.getLocationContext());
2454 
2455   if (CondV_untested.isUndef()) {
2456     //ExplodedNode* N = builder.generateDefaultCaseNode(state, true);
2457     // FIXME: add checker
2458     //UndefBranches.insert(N);
2459 
2460     return;
2461   }
2462   DefinedOrUnknownSVal CondV = CondV_untested.castAs<DefinedOrUnknownSVal>();
2463 
2464   ProgramStateRef DefaultSt = state;
2465 
2466   iterator I = builder.begin(), EI = builder.end();
2467   bool defaultIsFeasible = I == EI;
2468 
2469   for ( ; I != EI; ++I) {
2470     // Successor may be pruned out during CFG construction.
2471     if (!I.getBlock())
2472       continue;
2473 
2474     const CaseStmt *Case = I.getCase();
2475 
2476     // Evaluate the LHS of the case value.
2477     llvm::APSInt V1 = Case->getLHS()->EvaluateKnownConstInt(getContext());
2478     assert(V1.getBitWidth() == getContext().getIntWidth(CondE->getType()));
2479 
2480     // Get the RHS of the case, if it exists.
2481     llvm::APSInt V2;
2482     if (const Expr *E = Case->getRHS())
2483       V2 = E->EvaluateKnownConstInt(getContext());
2484     else
2485       V2 = V1;
2486 
2487     ProgramStateRef StateCase;
2488     if (Optional<NonLoc> NL = CondV.getAs<NonLoc>())
2489       std::tie(StateCase, DefaultSt) =
2490           DefaultSt->assumeInclusiveRange(*NL, V1, V2);
2491     else // UnknownVal
2492       StateCase = DefaultSt;
2493 
2494     if (StateCase)
2495       builder.generateCaseStmtNode(I, StateCase);
2496 
2497     // Now "assume" that the case doesn't match.  Add this state
2498     // to the default state (if it is feasible).
2499     if (DefaultSt)
2500       defaultIsFeasible = true;
2501     else {
2502       defaultIsFeasible = false;
2503       break;
2504     }
2505   }
2506 
2507   if (!defaultIsFeasible)
2508     return;
2509 
2510   // If we have switch(enum value), the default branch is not
2511   // feasible if all of the enum constants not covered by 'case:' statements
2512   // are not feasible values for the switch condition.
2513   //
2514   // Note that this isn't as accurate as it could be.  Even if there isn't
2515   // a case for a particular enum value as long as that enum value isn't
2516   // feasible then it shouldn't be considered for making 'default:' reachable.
2517   const SwitchStmt *SS = builder.getSwitch();
2518   const Expr *CondExpr = SS->getCond()->IgnoreParenImpCasts();
2519   if (CondExpr->getType()->getAs<EnumType>()) {
2520     if (SS->isAllEnumCasesCovered())
2521       return;
2522   }
2523 
2524   builder.generateDefaultCaseNode(DefaultSt);
2525 }
2526 
2527 //===----------------------------------------------------------------------===//
2528 // Transfer functions: Loads and stores.
2529 //===----------------------------------------------------------------------===//
2530 
2531 void ExprEngine::VisitCommonDeclRefExpr(const Expr *Ex, const NamedDecl *D,
2532                                         ExplodedNode *Pred,
2533                                         ExplodedNodeSet &Dst) {
2534   StmtNodeBuilder Bldr(Pred, Dst, *currBldrCtx);
2535 
2536   ProgramStateRef state = Pred->getState();
2537   const LocationContext *LCtx = Pred->getLocationContext();
2538 
2539   if (const auto *VD = dyn_cast<VarDecl>(D)) {
2540     // C permits "extern void v", and if you cast the address to a valid type,
2541     // you can even do things with it. We simply pretend
2542     assert(Ex->isGLValue() || VD->getType()->isVoidType());
2543     const LocationContext *LocCtxt = Pred->getLocationContext();
2544     const Decl *D = LocCtxt->getDecl();
2545     const auto *MD = dyn_cast_or_null<CXXMethodDecl>(D);
2546     const auto *DeclRefEx = dyn_cast<DeclRefExpr>(Ex);
2547     Optional<std::pair<SVal, QualType>> VInfo;
2548 
2549     if (AMgr.options.ShouldInlineLambdas && DeclRefEx &&
2550         DeclRefEx->refersToEnclosingVariableOrCapture() && MD &&
2551         MD->getParent()->isLambda()) {
2552       // Lookup the field of the lambda.
2553       const CXXRecordDecl *CXXRec = MD->getParent();
2554       llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
2555       FieldDecl *LambdaThisCaptureField;
2556       CXXRec->getCaptureFields(LambdaCaptureFields, LambdaThisCaptureField);
2557 
2558       // Sema follows a sequence of complex rules to determine whether the
2559       // variable should be captured.
2560       if (const FieldDecl *FD = LambdaCaptureFields[VD]) {
2561         Loc CXXThis =
2562             svalBuilder.getCXXThis(MD, LocCtxt->getStackFrame());
2563         SVal CXXThisVal = state->getSVal(CXXThis);
2564         VInfo = std::make_pair(state->getLValue(FD, CXXThisVal), FD->getType());
2565       }
2566     }
2567 
2568     if (!VInfo)
2569       VInfo = std::make_pair(state->getLValue(VD, LocCtxt), VD->getType());
2570 
2571     SVal V = VInfo->first;
2572     bool IsReference = VInfo->second->isReferenceType();
2573 
2574     // For references, the 'lvalue' is the pointer address stored in the
2575     // reference region.
2576     if (IsReference) {
2577       if (const MemRegion *R = V.getAsRegion())
2578         V = state->getSVal(R);
2579       else
2580         V = UnknownVal();
2581     }
2582 
2583     Bldr.generateNode(Ex, Pred, state->BindExpr(Ex, LCtx, V), nullptr,
2584                       ProgramPoint::PostLValueKind);
2585     return;
2586   }
2587   if (const auto *ED = dyn_cast<EnumConstantDecl>(D)) {
2588     assert(!Ex->isGLValue());
2589     SVal V = svalBuilder.makeIntVal(ED->getInitVal());
2590     Bldr.generateNode(Ex, Pred, state->BindExpr(Ex, LCtx, V));
2591     return;
2592   }
2593   if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
2594     SVal V = svalBuilder.getFunctionPointer(FD);
2595     Bldr.generateNode(Ex, Pred, state->BindExpr(Ex, LCtx, V), nullptr,
2596                       ProgramPoint::PostLValueKind);
2597     return;
2598   }
2599   if (isa<FieldDecl, IndirectFieldDecl>(D)) {
2600     // Delegate all work related to pointer to members to the surrounding
2601     // operator&.
2602     return;
2603   }
2604   if (isa<BindingDecl>(D)) {
2605     // FIXME: proper support for bound declarations.
2606     // For now, let's just prevent crashing.
2607     return;
2608   }
2609 
2610   llvm_unreachable("Support for this Decl not implemented.");
2611 }
2612 
2613 /// VisitArraySubscriptExpr - Transfer function for array accesses
2614 void ExprEngine::VisitArraySubscriptExpr(const ArraySubscriptExpr *A,
2615                                              ExplodedNode *Pred,
2616                                              ExplodedNodeSet &Dst){
2617   const Expr *Base = A->getBase()->IgnoreParens();
2618   const Expr *Idx  = A->getIdx()->IgnoreParens();
2619 
2620   ExplodedNodeSet CheckerPreStmt;
2621   getCheckerManager().runCheckersForPreStmt(CheckerPreStmt, Pred, A, *this);
2622 
2623   ExplodedNodeSet EvalSet;
2624   StmtNodeBuilder Bldr(CheckerPreStmt, EvalSet, *currBldrCtx);
2625 
2626   bool IsVectorType = A->getBase()->getType()->isVectorType();
2627 
2628   // The "like" case is for situations where C standard prohibits the type to
2629   // be an lvalue, e.g. taking the address of a subscript of an expression of
2630   // type "void *".
2631   bool IsGLValueLike = A->isGLValue() ||
2632     (A->getType().isCForbiddenLValueType() && !AMgr.getLangOpts().CPlusPlus);
2633 
2634   for (auto *Node : CheckerPreStmt) {
2635     const LocationContext *LCtx = Node->getLocationContext();
2636     ProgramStateRef state = Node->getState();
2637 
2638     if (IsGLValueLike) {
2639       QualType T = A->getType();
2640 
2641       // One of the forbidden LValue types! We still need to have sensible
2642       // symbolic locations to represent this stuff. Note that arithmetic on
2643       // void pointers is a GCC extension.
2644       if (T->isVoidType())
2645         T = getContext().CharTy;
2646 
2647       SVal V = state->getLValue(T,
2648                                 state->getSVal(Idx, LCtx),
2649                                 state->getSVal(Base, LCtx));
2650       Bldr.generateNode(A, Node, state->BindExpr(A, LCtx, V), nullptr,
2651           ProgramPoint::PostLValueKind);
2652     } else if (IsVectorType) {
2653       // FIXME: non-glvalue vector reads are not modelled.
2654       Bldr.generateNode(A, Node, state, nullptr);
2655     } else {
2656       llvm_unreachable("Array subscript should be an lValue when not \
2657 a vector and not a forbidden lvalue type");
2658     }
2659   }
2660 
2661   getCheckerManager().runCheckersForPostStmt(Dst, EvalSet, A, *this);
2662 }
2663 
2664 /// VisitMemberExpr - Transfer function for member expressions.
2665 void ExprEngine::VisitMemberExpr(const MemberExpr *M, ExplodedNode *Pred,
2666                                  ExplodedNodeSet &Dst) {
2667   // FIXME: Prechecks eventually go in ::Visit().
2668   ExplodedNodeSet CheckedSet;
2669   getCheckerManager().runCheckersForPreStmt(CheckedSet, Pred, M, *this);
2670 
2671   ExplodedNodeSet EvalSet;
2672   ValueDecl *Member = M->getMemberDecl();
2673 
2674   // Handle static member variables and enum constants accessed via
2675   // member syntax.
2676   if (isa<VarDecl, EnumConstantDecl>(Member)) {
2677     for (const auto I : CheckedSet)
2678       VisitCommonDeclRefExpr(M, Member, I, EvalSet);
2679   } else {
2680     StmtNodeBuilder Bldr(CheckedSet, EvalSet, *currBldrCtx);
2681     ExplodedNodeSet Tmp;
2682 
2683     for (const auto I : CheckedSet) {
2684       ProgramStateRef state = I->getState();
2685       const LocationContext *LCtx = I->getLocationContext();
2686       Expr *BaseExpr = M->getBase();
2687 
2688       // Handle C++ method calls.
2689       if (const auto *MD = dyn_cast<CXXMethodDecl>(Member)) {
2690         if (MD->isInstance())
2691           state = createTemporaryRegionIfNeeded(state, LCtx, BaseExpr);
2692 
2693         SVal MDVal = svalBuilder.getFunctionPointer(MD);
2694         state = state->BindExpr(M, LCtx, MDVal);
2695 
2696         Bldr.generateNode(M, I, state);
2697         continue;
2698       }
2699 
2700       // Handle regular struct fields / member variables.
2701       const SubRegion *MR = nullptr;
2702       state = createTemporaryRegionIfNeeded(state, LCtx, BaseExpr,
2703                                             /*Result=*/nullptr,
2704                                             /*OutRegionWithAdjustments=*/&MR);
2705       SVal baseExprVal =
2706           MR ? loc::MemRegionVal(MR) : state->getSVal(BaseExpr, LCtx);
2707 
2708       const auto *field = cast<FieldDecl>(Member);
2709       SVal L = state->getLValue(field, baseExprVal);
2710 
2711       if (M->isGLValue() || M->getType()->isArrayType()) {
2712         // We special-case rvalues of array type because the analyzer cannot
2713         // reason about them, since we expect all regions to be wrapped in Locs.
2714         // We instead treat these as lvalues and assume that they will decay to
2715         // pointers as soon as they are used.
2716         if (!M->isGLValue()) {
2717           assert(M->getType()->isArrayType());
2718           const auto *PE =
2719             dyn_cast<ImplicitCastExpr>(I->getParentMap().getParentIgnoreParens(M));
2720           if (!PE || PE->getCastKind() != CK_ArrayToPointerDecay) {
2721             llvm_unreachable("should always be wrapped in ArrayToPointerDecay");
2722           }
2723         }
2724 
2725         if (field->getType()->isReferenceType()) {
2726           if (const MemRegion *R = L.getAsRegion())
2727             L = state->getSVal(R);
2728           else
2729             L = UnknownVal();
2730         }
2731 
2732         Bldr.generateNode(M, I, state->BindExpr(M, LCtx, L), nullptr,
2733                           ProgramPoint::PostLValueKind);
2734       } else {
2735         Bldr.takeNodes(I);
2736         evalLoad(Tmp, M, M, I, state, L);
2737         Bldr.addNodes(Tmp);
2738       }
2739     }
2740   }
2741 
2742   getCheckerManager().runCheckersForPostStmt(Dst, EvalSet, M, *this);
2743 }
2744 
2745 void ExprEngine::VisitAtomicExpr(const AtomicExpr *AE, ExplodedNode *Pred,
2746                                  ExplodedNodeSet &Dst) {
2747   ExplodedNodeSet AfterPreSet;
2748   getCheckerManager().runCheckersForPreStmt(AfterPreSet, Pred, AE, *this);
2749 
2750   // For now, treat all the arguments to C11 atomics as escaping.
2751   // FIXME: Ideally we should model the behavior of the atomics precisely here.
2752 
2753   ExplodedNodeSet AfterInvalidateSet;
2754   StmtNodeBuilder Bldr(AfterPreSet, AfterInvalidateSet, *currBldrCtx);
2755 
2756   for (const auto I : AfterPreSet) {
2757     ProgramStateRef State = I->getState();
2758     const LocationContext *LCtx = I->getLocationContext();
2759 
2760     SmallVector<SVal, 8> ValuesToInvalidate;
2761     for (unsigned SI = 0, Count = AE->getNumSubExprs(); SI != Count; SI++) {
2762       const Expr *SubExpr = AE->getSubExprs()[SI];
2763       SVal SubExprVal = State->getSVal(SubExpr, LCtx);
2764       ValuesToInvalidate.push_back(SubExprVal);
2765     }
2766 
2767     State = State->invalidateRegions(ValuesToInvalidate, AE,
2768                                     currBldrCtx->blockCount(),
2769                                     LCtx,
2770                                     /*CausedByPointerEscape*/true,
2771                                     /*Symbols=*/nullptr);
2772 
2773     SVal ResultVal = UnknownVal();
2774     State = State->BindExpr(AE, LCtx, ResultVal);
2775     Bldr.generateNode(AE, I, State, nullptr,
2776                       ProgramPoint::PostStmtKind);
2777   }
2778 
2779   getCheckerManager().runCheckersForPostStmt(Dst, AfterInvalidateSet, AE, *this);
2780 }
2781 
2782 // A value escapes in four possible cases:
2783 // (1) We are binding to something that is not a memory region.
2784 // (2) We are binding to a MemRegion that does not have stack storage.
2785 // (3) We are binding to a top-level parameter region with a non-trivial
2786 //     destructor. We won't see the destructor during analysis, but it's there.
2787 // (4) We are binding to a MemRegion with stack storage that the store
2788 //     does not understand.
2789 ProgramStateRef ExprEngine::processPointerEscapedOnBind(
2790     ProgramStateRef State, ArrayRef<std::pair<SVal, SVal>> LocAndVals,
2791     const LocationContext *LCtx, PointerEscapeKind Kind,
2792     const CallEvent *Call) {
2793   SmallVector<SVal, 8> Escaped;
2794   for (const std::pair<SVal, SVal> &LocAndVal : LocAndVals) {
2795     // Cases (1) and (2).
2796     const MemRegion *MR = LocAndVal.first.getAsRegion();
2797     if (!MR || !MR->hasStackStorage()) {
2798       Escaped.push_back(LocAndVal.second);
2799       continue;
2800     }
2801 
2802     // Case (3).
2803     if (const auto *VR = dyn_cast<VarRegion>(MR->getBaseRegion()))
2804       if (VR->hasStackParametersStorage() && VR->getStackFrame()->inTopFrame())
2805         if (const auto *RD = VR->getValueType()->getAsCXXRecordDecl())
2806           if (!RD->hasTrivialDestructor()) {
2807             Escaped.push_back(LocAndVal.second);
2808             continue;
2809           }
2810 
2811     // Case (4): in order to test that, generate a new state with the binding
2812     // added. If it is the same state, then it escapes (since the store cannot
2813     // represent the binding).
2814     // Do this only if we know that the store is not supposed to generate the
2815     // same state.
2816     SVal StoredVal = State->getSVal(MR);
2817     if (StoredVal != LocAndVal.second)
2818       if (State ==
2819           (State->bindLoc(loc::MemRegionVal(MR), LocAndVal.second, LCtx)))
2820         Escaped.push_back(LocAndVal.second);
2821   }
2822 
2823   if (Escaped.empty())
2824     return State;
2825 
2826   return escapeValues(State, Escaped, Kind, Call);
2827 }
2828 
2829 ProgramStateRef
2830 ExprEngine::processPointerEscapedOnBind(ProgramStateRef State, SVal Loc,
2831                                         SVal Val, const LocationContext *LCtx) {
2832   std::pair<SVal, SVal> LocAndVal(Loc, Val);
2833   return processPointerEscapedOnBind(State, LocAndVal, LCtx, PSK_EscapeOnBind,
2834                                      nullptr);
2835 }
2836 
2837 ProgramStateRef
2838 ExprEngine::notifyCheckersOfPointerEscape(ProgramStateRef State,
2839     const InvalidatedSymbols *Invalidated,
2840     ArrayRef<const MemRegion *> ExplicitRegions,
2841     const CallEvent *Call,
2842     RegionAndSymbolInvalidationTraits &ITraits) {
2843   if (!Invalidated || Invalidated->empty())
2844     return State;
2845 
2846   if (!Call)
2847     return getCheckerManager().runCheckersForPointerEscape(State,
2848                                                            *Invalidated,
2849                                                            nullptr,
2850                                                            PSK_EscapeOther,
2851                                                            &ITraits);
2852 
2853   // If the symbols were invalidated by a call, we want to find out which ones
2854   // were invalidated directly due to being arguments to the call.
2855   InvalidatedSymbols SymbolsDirectlyInvalidated;
2856   for (const auto I : ExplicitRegions) {
2857     if (const SymbolicRegion *R = I->StripCasts()->getAs<SymbolicRegion>())
2858       SymbolsDirectlyInvalidated.insert(R->getSymbol());
2859   }
2860 
2861   InvalidatedSymbols SymbolsIndirectlyInvalidated;
2862   for (const auto &sym : *Invalidated) {
2863     if (SymbolsDirectlyInvalidated.count(sym))
2864       continue;
2865     SymbolsIndirectlyInvalidated.insert(sym);
2866   }
2867 
2868   if (!SymbolsDirectlyInvalidated.empty())
2869     State = getCheckerManager().runCheckersForPointerEscape(State,
2870         SymbolsDirectlyInvalidated, Call, PSK_DirectEscapeOnCall, &ITraits);
2871 
2872   // Notify about the symbols that get indirectly invalidated by the call.
2873   if (!SymbolsIndirectlyInvalidated.empty())
2874     State = getCheckerManager().runCheckersForPointerEscape(State,
2875         SymbolsIndirectlyInvalidated, Call, PSK_IndirectEscapeOnCall, &ITraits);
2876 
2877   return State;
2878 }
2879 
2880 /// evalBind - Handle the semantics of binding a value to a specific location.
2881 ///  This method is used by evalStore and (soon) VisitDeclStmt, and others.
2882 void ExprEngine::evalBind(ExplodedNodeSet &Dst, const Stmt *StoreE,
2883                           ExplodedNode *Pred,
2884                           SVal location, SVal Val,
2885                           bool atDeclInit, const ProgramPoint *PP) {
2886   const LocationContext *LC = Pred->getLocationContext();
2887   PostStmt PS(StoreE, LC);
2888   if (!PP)
2889     PP = &PS;
2890 
2891   // Do a previsit of the bind.
2892   ExplodedNodeSet CheckedSet;
2893   getCheckerManager().runCheckersForBind(CheckedSet, Pred, location, Val,
2894                                          StoreE, *this, *PP);
2895 
2896   StmtNodeBuilder Bldr(CheckedSet, Dst, *currBldrCtx);
2897 
2898   // If the location is not a 'Loc', it will already be handled by
2899   // the checkers.  There is nothing left to do.
2900   if (!location.getAs<Loc>()) {
2901     const ProgramPoint L = PostStore(StoreE, LC, /*Loc*/nullptr,
2902                                      /*tag*/nullptr);
2903     ProgramStateRef state = Pred->getState();
2904     state = processPointerEscapedOnBind(state, location, Val, LC);
2905     Bldr.generateNode(L, state, Pred);
2906     return;
2907   }
2908 
2909   for (const auto PredI : CheckedSet) {
2910     ProgramStateRef state = PredI->getState();
2911 
2912     state = processPointerEscapedOnBind(state, location, Val, LC);
2913 
2914     // When binding the value, pass on the hint that this is a initialization.
2915     // For initializations, we do not need to inform clients of region
2916     // changes.
2917     state = state->bindLoc(location.castAs<Loc>(),
2918                            Val, LC, /* notifyChanges = */ !atDeclInit);
2919 
2920     const MemRegion *LocReg = nullptr;
2921     if (Optional<loc::MemRegionVal> LocRegVal =
2922             location.getAs<loc::MemRegionVal>()) {
2923       LocReg = LocRegVal->getRegion();
2924     }
2925 
2926     const ProgramPoint L = PostStore(StoreE, LC, LocReg, nullptr);
2927     Bldr.generateNode(L, state, PredI);
2928   }
2929 }
2930 
2931 /// evalStore - Handle the semantics of a store via an assignment.
2932 ///  @param Dst The node set to store generated state nodes
2933 ///  @param AssignE The assignment expression if the store happens in an
2934 ///         assignment.
2935 ///  @param LocationE The location expression that is stored to.
2936 ///  @param state The current simulation state
2937 ///  @param location The location to store the value
2938 ///  @param Val The value to be stored
2939 void ExprEngine::evalStore(ExplodedNodeSet &Dst, const Expr *AssignE,
2940                              const Expr *LocationE,
2941                              ExplodedNode *Pred,
2942                              ProgramStateRef state, SVal location, SVal Val,
2943                              const ProgramPointTag *tag) {
2944   // Proceed with the store.  We use AssignE as the anchor for the PostStore
2945   // ProgramPoint if it is non-NULL, and LocationE otherwise.
2946   const Expr *StoreE = AssignE ? AssignE : LocationE;
2947 
2948   // Evaluate the location (checks for bad dereferences).
2949   ExplodedNodeSet Tmp;
2950   evalLocation(Tmp, AssignE, LocationE, Pred, state, location, false);
2951 
2952   if (Tmp.empty())
2953     return;
2954 
2955   if (location.isUndef())
2956     return;
2957 
2958   for (const auto I : Tmp)
2959     evalBind(Dst, StoreE, I, location, Val, false);
2960 }
2961 
2962 void ExprEngine::evalLoad(ExplodedNodeSet &Dst,
2963                           const Expr *NodeEx,
2964                           const Expr *BoundEx,
2965                           ExplodedNode *Pred,
2966                           ProgramStateRef state,
2967                           SVal location,
2968                           const ProgramPointTag *tag,
2969                           QualType LoadTy) {
2970   assert(!location.getAs<NonLoc>() && "location cannot be a NonLoc.");
2971   assert(NodeEx);
2972   assert(BoundEx);
2973   // Evaluate the location (checks for bad dereferences).
2974   ExplodedNodeSet Tmp;
2975   evalLocation(Tmp, NodeEx, BoundEx, Pred, state, location, true);
2976   if (Tmp.empty())
2977     return;
2978 
2979   StmtNodeBuilder Bldr(Tmp, Dst, *currBldrCtx);
2980   if (location.isUndef())
2981     return;
2982 
2983   // Proceed with the load.
2984   for (const auto I : Tmp) {
2985     state = I->getState();
2986     const LocationContext *LCtx = I->getLocationContext();
2987 
2988     SVal V = UnknownVal();
2989     if (location.isValid()) {
2990       if (LoadTy.isNull())
2991         LoadTy = BoundEx->getType();
2992       V = state->getSVal(location.castAs<Loc>(), LoadTy);
2993     }
2994 
2995     Bldr.generateNode(NodeEx, I, state->BindExpr(BoundEx, LCtx, V), tag,
2996                       ProgramPoint::PostLoadKind);
2997   }
2998 }
2999 
3000 void ExprEngine::evalLocation(ExplodedNodeSet &Dst,
3001                               const Stmt *NodeEx,
3002                               const Stmt *BoundEx,
3003                               ExplodedNode *Pred,
3004                               ProgramStateRef state,
3005                               SVal location,
3006                               bool isLoad) {
3007   StmtNodeBuilder BldrTop(Pred, Dst, *currBldrCtx);
3008   // Early checks for performance reason.
3009   if (location.isUnknown()) {
3010     return;
3011   }
3012 
3013   ExplodedNodeSet Src;
3014   BldrTop.takeNodes(Pred);
3015   StmtNodeBuilder Bldr(Pred, Src, *currBldrCtx);
3016   if (Pred->getState() != state) {
3017     // Associate this new state with an ExplodedNode.
3018     // FIXME: If I pass null tag, the graph is incorrect, e.g for
3019     //   int *p;
3020     //   p = 0;
3021     //   *p = 0xDEADBEEF;
3022     // "p = 0" is not noted as "Null pointer value stored to 'p'" but
3023     // instead "int *p" is noted as
3024     // "Variable 'p' initialized to a null pointer value"
3025 
3026     static SimpleProgramPointTag tag(TagProviderName, "Location");
3027     Bldr.generateNode(NodeEx, Pred, state, &tag);
3028   }
3029   ExplodedNodeSet Tmp;
3030   getCheckerManager().runCheckersForLocation(Tmp, Src, location, isLoad,
3031                                              NodeEx, BoundEx, *this);
3032   BldrTop.addNodes(Tmp);
3033 }
3034 
3035 std::pair<const ProgramPointTag *, const ProgramPointTag*>
3036 ExprEngine::geteagerlyAssumeBinOpBifurcationTags() {
3037   static SimpleProgramPointTag
3038          eagerlyAssumeBinOpBifurcationTrue(TagProviderName,
3039                                            "Eagerly Assume True"),
3040          eagerlyAssumeBinOpBifurcationFalse(TagProviderName,
3041                                             "Eagerly Assume False");
3042   return std::make_pair(&eagerlyAssumeBinOpBifurcationTrue,
3043                         &eagerlyAssumeBinOpBifurcationFalse);
3044 }
3045 
3046 void ExprEngine::evalEagerlyAssumeBinOpBifurcation(ExplodedNodeSet &Dst,
3047                                                    ExplodedNodeSet &Src,
3048                                                    const Expr *Ex) {
3049   StmtNodeBuilder Bldr(Src, Dst, *currBldrCtx);
3050 
3051   for (const auto Pred : Src) {
3052     // Test if the previous node was as the same expression.  This can happen
3053     // when the expression fails to evaluate to anything meaningful and
3054     // (as an optimization) we don't generate a node.
3055     ProgramPoint P = Pred->getLocation();
3056     if (!P.getAs<PostStmt>() || P.castAs<PostStmt>().getStmt() != Ex) {
3057       continue;
3058     }
3059 
3060     ProgramStateRef state = Pred->getState();
3061     SVal V = state->getSVal(Ex, Pred->getLocationContext());
3062     Optional<nonloc::SymbolVal> SEV = V.getAs<nonloc::SymbolVal>();
3063     if (SEV && SEV->isExpression()) {
3064       const std::pair<const ProgramPointTag *, const ProgramPointTag*> &tags =
3065         geteagerlyAssumeBinOpBifurcationTags();
3066 
3067       ProgramStateRef StateTrue, StateFalse;
3068       std::tie(StateTrue, StateFalse) = state->assume(*SEV);
3069 
3070       // First assume that the condition is true.
3071       if (StateTrue) {
3072         SVal Val = svalBuilder.makeIntVal(1U, Ex->getType());
3073         StateTrue = StateTrue->BindExpr(Ex, Pred->getLocationContext(), Val);
3074         Bldr.generateNode(Ex, Pred, StateTrue, tags.first);
3075       }
3076 
3077       // Next, assume that the condition is false.
3078       if (StateFalse) {
3079         SVal Val = svalBuilder.makeIntVal(0U, Ex->getType());
3080         StateFalse = StateFalse->BindExpr(Ex, Pred->getLocationContext(), Val);
3081         Bldr.generateNode(Ex, Pred, StateFalse, tags.second);
3082       }
3083     }
3084   }
3085 }
3086 
3087 void ExprEngine::VisitGCCAsmStmt(const GCCAsmStmt *A, ExplodedNode *Pred,
3088                                  ExplodedNodeSet &Dst) {
3089   StmtNodeBuilder Bldr(Pred, Dst, *currBldrCtx);
3090   // We have processed both the inputs and the outputs.  All of the outputs
3091   // should evaluate to Locs.  Nuke all of their values.
3092 
3093   // FIXME: Some day in the future it would be nice to allow a "plug-in"
3094   // which interprets the inline asm and stores proper results in the
3095   // outputs.
3096 
3097   ProgramStateRef state = Pred->getState();
3098 
3099   for (const Expr *O : A->outputs()) {
3100     SVal X = state->getSVal(O, Pred->getLocationContext());
3101     assert(!X.getAs<NonLoc>());  // Should be an Lval, or unknown, undef.
3102 
3103     if (Optional<Loc> LV = X.getAs<Loc>())
3104       state = state->bindLoc(*LV, UnknownVal(), Pred->getLocationContext());
3105   }
3106 
3107   Bldr.generateNode(A, Pred, state);
3108 }
3109 
3110 void ExprEngine::VisitMSAsmStmt(const MSAsmStmt *A, ExplodedNode *Pred,
3111                                 ExplodedNodeSet &Dst) {
3112   StmtNodeBuilder Bldr(Pred, Dst, *currBldrCtx);
3113   Bldr.generateNode(A, Pred, Pred->getState());
3114 }
3115 
3116 //===----------------------------------------------------------------------===//
3117 // Visualization.
3118 //===----------------------------------------------------------------------===//
3119 
3120 #ifndef NDEBUG
3121 namespace llvm {
3122 
3123 template<>
3124 struct DOTGraphTraits<ExplodedGraph*> : public DefaultDOTGraphTraits {
3125   DOTGraphTraits (bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
3126 
3127   static bool nodeHasBugReport(const ExplodedNode *N) {
3128     BugReporter &BR = static_cast<ExprEngine &>(
3129       N->getState()->getStateManager().getOwningEngine()).getBugReporter();
3130 
3131     const auto EQClasses =
3132         llvm::make_range(BR.EQClasses_begin(), BR.EQClasses_end());
3133 
3134     for (const auto &EQ : EQClasses) {
3135       for (const auto &I : EQ.getReports()) {
3136         const auto *PR = dyn_cast<PathSensitiveBugReport>(I.get());
3137         if (!PR)
3138           continue;
3139         const ExplodedNode *EN = PR->getErrorNode();
3140         if (EN->getState() == N->getState() &&
3141             EN->getLocation() == N->getLocation())
3142           return true;
3143       }
3144     }
3145     return false;
3146   }
3147 
3148   /// \p PreCallback: callback before break.
3149   /// \p PostCallback: callback after break.
3150   /// \p Stop: stop iteration if returns @c true
3151   /// \return Whether @c Stop ever returned @c true.
3152   static bool traverseHiddenNodes(
3153       const ExplodedNode *N,
3154       llvm::function_ref<void(const ExplodedNode *)> PreCallback,
3155       llvm::function_ref<void(const ExplodedNode *)> PostCallback,
3156       llvm::function_ref<bool(const ExplodedNode *)> Stop) {
3157     while (true) {
3158       PreCallback(N);
3159       if (Stop(N))
3160         return true;
3161 
3162       if (N->succ_size() != 1 || !isNodeHidden(N->getFirstSucc(), nullptr))
3163         break;
3164       PostCallback(N);
3165 
3166       N = N->getFirstSucc();
3167     }
3168     return false;
3169   }
3170 
3171   static bool isNodeHidden(const ExplodedNode *N, const ExplodedGraph *G) {
3172     return N->isTrivial();
3173   }
3174 
3175   static std::string getNodeLabel(const ExplodedNode *N, ExplodedGraph *G){
3176     std::string Buf;
3177     llvm::raw_string_ostream Out(Buf);
3178 
3179     const bool IsDot = true;
3180     const unsigned int Space = 1;
3181     ProgramStateRef State = N->getState();
3182 
3183     Out << "{ \"state_id\": " << State->getID()
3184         << ",\\l";
3185 
3186     Indent(Out, Space, IsDot) << "\"program_points\": [\\l";
3187 
3188     // Dump program point for all the previously skipped nodes.
3189     traverseHiddenNodes(
3190         N,
3191         [&](const ExplodedNode *OtherNode) {
3192           Indent(Out, Space + 1, IsDot) << "{ ";
3193           OtherNode->getLocation().printJson(Out, /*NL=*/"\\l");
3194           Out << ", \"tag\": ";
3195           if (const ProgramPointTag *Tag = OtherNode->getLocation().getTag())
3196             Out << '\"' << Tag->getTagDescription() << "\"";
3197           else
3198             Out << "null";
3199           Out << ", \"node_id\": " << OtherNode->getID() <<
3200                  ", \"is_sink\": " << OtherNode->isSink() <<
3201                  ", \"has_report\": " << nodeHasBugReport(OtherNode) << " }";
3202         },
3203         // Adds a comma and a new-line between each program point.
3204         [&](const ExplodedNode *) { Out << ",\\l"; },
3205         [&](const ExplodedNode *) { return false; });
3206 
3207     Out << "\\l"; // Adds a new-line to the last program point.
3208     Indent(Out, Space, IsDot) << "],\\l";
3209 
3210     State->printDOT(Out, N->getLocationContext(), Space);
3211 
3212     Out << "\\l}\\l";
3213     return Out.str();
3214   }
3215 };
3216 
3217 } // namespace llvm
3218 #endif
3219 
3220 void ExprEngine::ViewGraph(bool trim) {
3221 #ifndef NDEBUG
3222   std::string Filename = DumpGraph(trim);
3223   llvm::DisplayGraph(Filename, false, llvm::GraphProgram::DOT);
3224 #else
3225   llvm::errs() << "Warning: viewing graph requires assertions" << "\n";
3226 #endif
3227 }
3228 
3229 
3230 void ExprEngine::ViewGraph(ArrayRef<const ExplodedNode*> Nodes) {
3231 #ifndef NDEBUG
3232   std::string Filename = DumpGraph(Nodes);
3233   llvm::DisplayGraph(Filename, false, llvm::GraphProgram::DOT);
3234 #else
3235   llvm::errs() << "Warning: viewing graph requires assertions" << "\n";
3236 #endif
3237 }
3238 
3239 std::string ExprEngine::DumpGraph(bool trim, StringRef Filename) {
3240 #ifndef NDEBUG
3241   if (trim) {
3242     std::vector<const ExplodedNode *> Src;
3243 
3244     // Iterate through the reports and get their nodes.
3245     for (BugReporter::EQClasses_iterator
3246            EI = BR.EQClasses_begin(), EE = BR.EQClasses_end(); EI != EE; ++EI) {
3247       const auto *R =
3248           dyn_cast<PathSensitiveBugReport>(EI->getReports()[0].get());
3249       if (!R)
3250         continue;
3251       const auto *N = const_cast<ExplodedNode *>(R->getErrorNode());
3252       Src.push_back(N);
3253     }
3254     return DumpGraph(Src, Filename);
3255   } else {
3256     return llvm::WriteGraph(&G, "ExprEngine", /*ShortNames=*/false,
3257                             /*Title=*/"Exploded Graph",
3258                             /*Filename=*/std::string(Filename));
3259   }
3260 #else
3261   llvm::errs() << "Warning: dumping graph requires assertions" << "\n";
3262   return "";
3263 #endif
3264 }
3265 
3266 std::string ExprEngine::DumpGraph(ArrayRef<const ExplodedNode*> Nodes,
3267                                   StringRef Filename) {
3268 #ifndef NDEBUG
3269   std::unique_ptr<ExplodedGraph> TrimmedG(G.trim(Nodes));
3270 
3271   if (!TrimmedG.get()) {
3272     llvm::errs() << "warning: Trimmed ExplodedGraph is empty.\n";
3273     return "";
3274   } else {
3275     return llvm::WriteGraph(TrimmedG.get(), "TrimmedExprEngine",
3276                             /*ShortNames=*/false,
3277                             /*Title=*/"Trimmed Exploded Graph",
3278                             /*Filename=*/std::string(Filename));
3279   }
3280 #else
3281   llvm::errs() << "Warning: dumping graph requires assertions" << "\n";
3282   return "";
3283 #endif
3284 }
3285 
3286 void *ProgramStateTrait<ReplayWithoutInlining>::GDMIndex() {
3287   static int index = 0;
3288   return &index;
3289 }
3290 
3291 void ExprEngine::anchor() { }
3292