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