contrib/llvm/tools/clang/lib/StaticAnalyzer/Core/ExprEngine.cpp

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