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