ExprEngineCallAndReturn.cpp revision 255d4d4226b24036ceb11228fbb74286e58620f7
1294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//=-- ExprEngineCallAndReturn.cpp - Support for call/return -----*- C++ -*-===//
2294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//
3294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//                     The LLVM Compiler Infrastructure
4294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//
5294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// This file is distributed under the University of Illinois Open Source
6294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// License. See LICENSE.TXT for details.
7294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//
8294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//===----------------------------------------------------------------------===//
9294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//
10294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//  This file defines ExprEngine's support for calls and returns.
11294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//
12294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//===----------------------------------------------------------------------===//
13294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek
14e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks#define DEBUG_TYPE "ExprEngine"
15e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks
16d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek#include "clang/Analysis/Analyses/LiveVariables.h"
17294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/StaticAnalyzer/Core/CheckerManager.h"
18294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h"
19f540c54701e3eeb34cb619a3a4eb18f1ac70ef2dJordan Rose#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
20294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/AST/DeclCXX.h"
216fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose#include "clang/AST/ParentMap.h"
224a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/ADT/SmallSet.h"
23e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks#include "llvm/ADT/Statistic.h"
244a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/Support/SaveAndRestore.h"
25294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek
26294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekusing namespace clang;
27294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekusing namespace ento;
28294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek
29e90d3f847dcce76237078b67db8895eb7a24189eAnna ZaksSTATISTIC(NumOfDynamicDispatchPathSplits,
30e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  "The # of times we split the path due to imprecise dynamic dispatch info");
31e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks
32210f5a28227c90d739298e3e6729e827858fe397Anna ZaksSTATISTIC(NumInlinedCalls,
33210f5a28227c90d739298e3e6729e827858fe397Anna Zaks  "The # of times we inlined a call");
34210f5a28227c90d739298e3e6729e827858fe397Anna Zaks
353070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenekvoid ExprEngine::processCallEnter(CallEnter CE, ExplodedNode *Pred) {
363070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  // Get the entry block in the CFG of the callee.
370849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek  const StackFrameContext *calleeCtx = CE.getCalleeContext();
380849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek  const CFG *CalleeCFG = calleeCtx->getCFG();
393070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  const CFGBlock *Entry = &(CalleeCFG->getEntry());
403070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek
413070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  // Validate the CFG.
423070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  assert(Entry->empty());
433070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  assert(Entry->succ_size() == 1);
443070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek
453070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  // Get the solitary sucessor.
463070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  const CFGBlock *Succ = *(Entry->succ_begin());
473070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek
483070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  // Construct an edge representing the starting location in the callee.
490849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek  BlockEdge Loc(Entry, Succ, calleeCtx);
503070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek
51e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose  ProgramStateRef state = Pred->getState();
523070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek
533070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  // Construct a new node and add it to the worklist.
543070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  bool isNew;
553070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  ExplodedNode *Node = G.getNode(Loc, state, false, &isNew);
563070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  Node->addPredecessor(Pred, G);
573070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek  if (isNew)
583070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek    Engine.getWorkList()->enqueue(Node);
59294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek}
60294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek
610b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// Find the last statement on the path to the exploded node and the
620b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// corresponding Block.
630b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksstatic std::pair<const Stmt*,
640b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks                 const CFGBlock*> getLastStmt(const ExplodedNode *Node) {
650b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  const Stmt *S = 0;
660b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  const StackFrameContext *SF =
670b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks          Node->getLocation().getLocationContext()->getCurrentStackFrame();
68888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose
69632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose  // Back up through the ExplodedGraph until we reach a statement node in this
70632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose  // stack frame.
71256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek  while (Node) {
72256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek    const ProgramPoint &PP = Node->getLocation();
73888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose
74632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose    if (PP.getLocationContext()->getCurrentStackFrame() == SF) {
75632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose      if (const StmtPoint *SP = dyn_cast<StmtPoint>(&PP)) {
76632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose        S = SP->getStmt();
77888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose        break;
78632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose      } else if (const CallExitEnd *CEE = dyn_cast<CallExitEnd>(&PP)) {
79632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose        S = CEE->getCalleeContext()->getCallSite();
80632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose        if (S)
81632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose          break;
82632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose
83632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose        // If there is no statement, this is an implicitly-generated call.
84632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose        // We'll walk backwards over it and then continue the loop to find
85632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose        // an actual statement.
86632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose        const CallEnter *CE;
87632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose        do {
88632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose          Node = Node->getFirstPred();
89632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose          CE = Node->getLocationAs<CallEnter>();
90632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose        } while (!CE || CE->getCalleeContext() != CEE->getCalleeContext());
91632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose
92632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose        // Continue searching the graph.
93632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose      }
94888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose    } else if (const CallEnter *CE = dyn_cast<CallEnter>(&PP)) {
95888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose      // If we reached the CallEnter for this function, it has no statements.
96888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose      if (CE->getCalleeContext() == SF)
97888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose        break;
98256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek    }
99888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose
100888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose    Node = *Node->pred_begin();
101256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek  }
102888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose
103888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose  const CFGBlock *Blk = 0;
104888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose  if (S) {
105888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose    // Now, get the enclosing basic block.
106888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose    while (Node && Node->pred_size() >=1 ) {
107888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose      const ProgramPoint &PP = Node->getLocation();
108888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose      if (isa<BlockEdge>(PP) &&
109888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose          (PP.getLocationContext()->getCurrentStackFrame() == SF)) {
110888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose        BlockEdge &EPP = cast<BlockEdge>(PP);
111888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose        Blk = EPP.getDst();
112888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose        break;
113888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose      }
114888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose      Node = *Node->pred_begin();
115888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose    }
116888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose  }
117888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose
1180b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  return std::pair<const Stmt*, const CFGBlock*>(S, Blk);
119256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek}
120256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek
1210b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// The call exit is simulated with a sequence of nodes, which occur between
1220b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// CallExitBegin and CallExitEnd. The following operations occur between the
1230b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// two program points:
1240b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 1. CallExitBegin (triggers the start of call exit sequence)
1250b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 2. Bind the return value
1260b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 3. Run Remove dead bindings to clean up the dead symbols from the callee.
1270b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 4. CallExitEnd (switch to the caller context)
1280b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 5. PostStmt<CallExpr>
1290b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksvoid ExprEngine::processCallExit(ExplodedNode *CEBNode) {
1300b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  // Step 1 CEBNode was generated before the call.
1310b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks
1320b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  const StackFrameContext *calleeCtx =
1330b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks      CEBNode->getLocationContext()->getCurrentStackFrame();
1347fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek
1357fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  // The parent context might not be a stack frame, so make sure we
1367fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  // look up the first enclosing stack frame.
1377fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  const StackFrameContext *callerCtx =
1387fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek    calleeCtx->getParent()->getCurrentStackFrame();
1397fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek
140294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek  const Stmt *CE = calleeCtx->getCallSite();
1410b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  ProgramStateRef state = CEBNode->getState();
1420b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  // Find the last statement in the function and the corresponding basic block.
1430b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  const Stmt *LastSt = 0;
1440b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  const CFGBlock *Blk = 0;
1450b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  llvm::tie(LastSt, Blk) = getLastStmt(CEBNode);
1460b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks
147852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose  // Step 2: generate node with bound return value: CEBNode -> BindedRetNode.
1480b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks
149294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek  // If the callee returns an expression, bind its value to CallExpr.
150852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose  if (CE) {
151852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose    if (const ReturnStmt *RS = dyn_cast_or_null<ReturnStmt>(LastSt)) {
152852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose      const LocationContext *LCtx = CEBNode->getLocationContext();
153852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose      SVal V = state->getSVal(RS, LCtx);
15457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose      state = state->BindExpr(CE, callerCtx, V);
155852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose    }
1560b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks
157852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose    // Bind the constructed object value to CXXConstructExpr.
158852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose    if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(CE)) {
159852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose      loc::MemRegionVal This =
160852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose        svalBuilder.getCXXThis(CCE->getConstructor()->getParent(), calleeCtx);
161852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose      SVal ThisV = state->getSVal(This);
1620b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks
163852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose      // Always bind the region to the CXXConstructExpr.
16457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose      state = state->BindExpr(CCE, callerCtx, ThisV);
165852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose    }
166294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek  }
1670b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks
1684e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose  // Generate a CallEvent /before/ cleaning the state, so that we can get the
1694e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose  // correct value for 'this' (if necessary).
1704e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose  CallEventManager &CEMgr = getStateManager().getCallEventManager();
1714e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose  CallEventRef<> Call = CEMgr.getCaller(calleeCtx, state);
1724e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose
1730b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  // Step 3: BindedRetNode -> CleanedNodes
1740b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  // If we can find a statement and a block in the inlined function, run remove
1750b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  // dead bindings before returning from the call. This is important to ensure
1760b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  // that we report the issues such as leaks in the stack contexts in which
1770b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  // they occurred.
1780b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  ExplodedNodeSet CleanedNodes;
179255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek  if (LastSt && Blk && AMgr.options.AnalysisPurgeOpt != PurgeNone) {
18048b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose    static SimpleProgramPointTag retValBind("ExprEngine : Bind Return Value");
18148b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose    PostStmt Loc(LastSt, calleeCtx, &retValBind);
18248b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose    bool isNew;
18348b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose    ExplodedNode *BindedRetNode = G.getNode(Loc, state, false, &isNew);
18448b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose    BindedRetNode->addPredecessor(CEBNode, G);
18548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose    if (!isNew)
18648b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose      return;
18748b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose
1880b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    NodeBuilderContext Ctx(getCoreEngine(), Blk, BindedRetNode);
18966c486f275531df6362b3511fc3af6563561801bTed Kremenek    currBldrCtx = &Ctx;
1900b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    // Here, we call the Symbol Reaper with 0 statement and caller location
1910b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    // context, telling it to clean up everything in the callee's context
1920b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    // (and it's children). We use LastStmt as a diagnostic statement, which
1930b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    // which the PreStmtPurge Dead point will be associated.
1940b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    removeDead(BindedRetNode, CleanedNodes, 0, callerCtx, LastSt,
1950b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks               ProgramPoint::PostStmtPurgeDeadSymbolsKind);
19666c486f275531df6362b3511fc3af6563561801bTed Kremenek    currBldrCtx = 0;
197144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks  } else {
198144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks    CleanedNodes.Add(CEBNode);
1990b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  }
2000b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks
2010b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks  for (ExplodedNodeSet::iterator I = CleanedNodes.begin(),
2020b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks                                 E = CleanedNodes.end(); I != E; ++I) {
2030b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks
2040b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    // Step 4: Generate the CallExit and leave the callee's context.
2050b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    // CleanedNodes -> CEENode
206852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose    CallExitEnd Loc(calleeCtx, callerCtx);
2070b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    bool isNew;
20848b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose    ProgramStateRef CEEState = (*I == CEBNode) ? state : (*I)->getState();
20948b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose    ExplodedNode *CEENode = G.getNode(Loc, CEEState, false, &isNew);
2100b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    CEENode->addPredecessor(*I, G);
2110b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    if (!isNew)
2120b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks      return;
2130b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks
2140b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    // Step 5: Perform the post-condition check of the CallExpr and enqueue the
2150b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    // result onto the work list.
2160b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    // CEENode -> Dst -> WorkList
2170b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    NodeBuilderContext Ctx(Engine, calleeCtx->getCallSiteBlock(), CEENode);
21866c486f275531df6362b3511fc3af6563561801bTed Kremenek    SaveAndRestore<const NodeBuilderContext*> NBCSave(currBldrCtx,
2190b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks        &Ctx);
22066c486f275531df6362b3511fc3af6563561801bTed Kremenek    SaveAndRestore<unsigned> CBISave(currStmtIdx, calleeCtx->getIndex());
2210b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks
2224e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose    CallEventRef<> UpdatedCall = Call.cloneWithState(CEEState);
22357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose
22457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose    ExplodedNodeSet DstPostCall;
2254e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose    getCheckerManager().runCheckersForPostCall(DstPostCall, CEENode,
2264e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose                                               *UpdatedCall, *this,
2274e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose                                               /*WasInlined=*/true);
22857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose
22957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose    ExplodedNodeSet Dst;
2304e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose    if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(Call)) {
2314e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose      getCheckerManager().runCheckersForPostObjCMessage(Dst, DstPostCall, *Msg,
2324e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose                                                        *this,
2334e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose                                                        /*WasInlined=*/true);
23457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose    } else if (CE) {
23557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose      getCheckerManager().runCheckersForPostStmt(Dst, DstPostCall, CE,
2364e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose                                                 *this, /*WasInlined=*/true);
23757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose    } else {
23857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose      Dst.insert(DstPostCall);
23957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose    }
2400b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks
2410b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    // Enqueue the next element in the block.
2420b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    for (ExplodedNodeSet::iterator PSI = Dst.begin(), PSE = Dst.end();
2430b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks                                   PSI != PSE; ++PSI) {
2440b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks      Engine.getWorkList()->enqueue(*PSI, calleeCtx->getCallSiteBlock(),
2450b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks                                    calleeCtx->getIndex()+1);
2460b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks    }
247242384ddb0e0b65dd7e9e0ac0cf3c31cf98b06a6Ted Kremenek  }
248294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek}
249294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek
2500849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenekstatic unsigned getNumberStackFrames(const LocationContext *LCtx) {
2510849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek  unsigned count = 0;
2520849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek  while (LCtx) {
2530849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek    if (isa<StackFrameContext>(LCtx))
2540849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek      ++count;
2550849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek    LCtx = LCtx->getParent();
2560849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek  }
2570849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek  return count;
2580849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek}
2590849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek
2606cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks// Determine if we should inline the call.
2617fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenekbool ExprEngine::shouldInlineDecl(const Decl *D, ExplodedNode *Pred) {
2627fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D);
2636cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks  const CFG *CalleeCFG = CalleeADC->getCFG();
2646cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks
26501561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek  // It is possible that the CFG cannot be constructed.
26601561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek  // Be safe, and check if the CalleeCFG is valid.
26701561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek  if (!CalleeCFG)
26801561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek    return false;
26901561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek
2706cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks  if (getNumberStackFrames(Pred->getLocationContext())
271255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek        == AMgr.options.InlineMaxStackDepth)
2726cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks    return false;
2736cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks
2747fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  if (Engine.FunctionSummaries->hasReachedMaxBlockCount(D))
2753bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks    return false;
2763bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks
277255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek  if (CalleeCFG->getNumBlockIDs() > AMgr.options.InlineMaxFunctionSize)
2786cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks    return false;
2796cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks
28010f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek  // Do not inline variadic calls (for now).
28110f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek  if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
28210f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek    if (BD->isVariadic())
28310f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek      return false;
28410f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek  }
28510f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek  else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
28610f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek    if (FD->isVariadic())
28710f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek      return false;
2885903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks  }
2895903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks
290d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek  // It is possible that the live variables analysis cannot be
291d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek  // run.  If so, bail out.
292d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek  if (!CalleeADC->getAnalysis<RelaxedLiveVariables>())
293d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek    return false;
294d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek
29510f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek  return true;
2965903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks}
2975903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks
298e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks/// The GDM component containing the dynamic dispatch bifurcation info. When
299e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks/// the exact type of the receiver is not known, we want to explore both paths -
300e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks/// one on which we do inline it and the other one on which we don't. This is
301e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks/// done to ensure we do not drop coverage.
302e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks/// This is the map from the receiver region to a bool, specifying either we
303e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks/// consider this region's information precise or not along the given path.
304e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksnamespace clang {
305e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksnamespace ento {
3066960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaksenum DynamicDispatchMode { DynamicDispatchModeInlined = 1,
3076960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks                           DynamicDispatchModeConservative };
3086960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks
309e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksstruct DynamicDispatchBifurcationMap {};
310e90d3f847dcce76237078b67db8895eb7a24189eAnna Zakstypedef llvm::ImmutableMap<const MemRegion*,
3116960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks                           unsigned int> DynamicDispatchBifur;
312e90d3f847dcce76237078b67db8895eb7a24189eAnna Zakstemplate<> struct ProgramStateTrait<DynamicDispatchBifurcationMap>
313e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks    :  public ProgramStatePartialTrait<DynamicDispatchBifur> {
314e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  static void *GDMIndex() { static int index; return &index; }
315e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks};
3166960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks
317e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks}}
318e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks
319c568e2f801a62e442cbbd823b71f70175715661fJordan Rosestatic bool shouldInlineCXX(AnalysisManager &AMgr) {
320255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek  switch (AMgr.options.IPAMode) {
321c568e2f801a62e442cbbd823b71f70175715661fJordan Rose  case None:
322c568e2f801a62e442cbbd823b71f70175715661fJordan Rose  case BasicInlining:
323c568e2f801a62e442cbbd823b71f70175715661fJordan Rose    return false;
324c568e2f801a62e442cbbd823b71f70175715661fJordan Rose  case Inlining:
325c568e2f801a62e442cbbd823b71f70175715661fJordan Rose  case DynamicDispatch:
326c568e2f801a62e442cbbd823b71f70175715661fJordan Rose  case DynamicDispatchBifurcate:
327c568e2f801a62e442cbbd823b71f70175715661fJordan Rose    return true;
328c568e2f801a62e442cbbd823b71f70175715661fJordan Rose  case NumIPAModes:
329c568e2f801a62e442cbbd823b71f70175715661fJordan Rose    llvm_unreachable("not actually a valid option");
330c568e2f801a62e442cbbd823b71f70175715661fJordan Rose  }
33112e2fb0db76ca2705ce5169e04d9cd52762fc685Matt Beaumont-Gay  llvm_unreachable("bogus IPAMode");
332c568e2f801a62e442cbbd823b71f70175715661fJordan Rose}
333c568e2f801a62e442cbbd823b71f70175715661fJordan Rose
334e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksbool ExprEngine::inlineCall(const CallEvent &Call, const Decl *D,
335e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks                            NodeBuilder &Bldr, ExplodedNode *Pred,
336e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks                            ProgramStateRef State) {
337e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  assert(D);
338ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose
339c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose  const LocationContext *CurLC = Pred->getLocationContext();
340c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose  const StackFrameContext *CallerSFC = CurLC->getCurrentStackFrame();
3417fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  const LocationContext *ParentOfCallee = 0;
34269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose
343ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose  // FIXME: Refactor this check into a hypothetical CallEvent::canInline.
34469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  switch (Call.getKind()) {
34569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  case CE_Function:
3462f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose    break;
34769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  case CE_CXXMember:
348e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose  case CE_CXXMemberOperator:
349c568e2f801a62e442cbbd823b71f70175715661fJordan Rose    if (!shouldInlineCXX(getAnalysisManager()))
3502f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose      return false;
35169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose    break;
352ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose  case CE_CXXConstructor: {
353c568e2f801a62e442cbbd823b71f70175715661fJordan Rose    if (!shouldInlineCXX(getAnalysisManager()))
3542f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose      return false;
3552f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose
356ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose    const CXXConstructorCall &Ctor = cast<CXXConstructorCall>(Call);
357ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose
358e460c46c5d602f65354cab0879c458890273591cJordan Rose    // FIXME: We don't handle constructors or destructors for arrays properly.
359ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose    const MemRegion *Target = Ctor.getCXXThisVal().getAsRegion();
360e460c46c5d602f65354cab0879c458890273591cJordan Rose    if (Target && isa<ElementRegion>(Target))
361e460c46c5d602f65354cab0879c458890273591cJordan Rose      return false;
362e460c46c5d602f65354cab0879c458890273591cJordan Rose
3636fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose    // FIXME: This is a hack. We don't use the correct region for a new
3646fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose    // expression, so if we inline the constructor its result will just be
3656fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose    // thrown away. This short-term hack is tracked in <rdar://problem/12180598>
3666fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose    // and the longer-term possible fix is discussed in PR12014.
3676fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose    const CXXConstructExpr *CtorExpr = Ctor.getOriginExpr();
3686fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose    if (const Stmt *Parent = CurLC->getParentMap().getParent(CtorExpr))
3696fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose      if (isa<CXXNewExpr>(Parent))
3706fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose        return false;
3716fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose
372c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose    // If the destructor is trivial, it's always safe to inline the constructor.
373c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose    if (Ctor.getDecl()->getParent()->hasTrivialDestructor())
374c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose      break;
375c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose
376c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose    // For other types, only inline constructors if we built the CFGs for the
377c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose    // destructor properly.
378c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose    const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext();
379c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose    assert(ADC->getCFGBuildOptions().AddInitializers && "No CFG initializers");
380c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose    if (!ADC->getCFGBuildOptions().AddImplicitDtors)
381c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose      return false;
382c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose
3833a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose    // FIXME: This is a hack. We don't handle temporary destructors
384888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose    // right now, so we shouldn't inline their constructors.
385ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose    if (CtorExpr->getConstructionKind() == CXXConstructExpr::CK_Complete)
386ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose      if (!Target || !isa<DeclRegion>(Target))
387ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose        return false;
388ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose
389ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose    break;
390ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose  }
391ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose  case CE_CXXDestructor: {
392c568e2f801a62e442cbbd823b71f70175715661fJordan Rose    if (!shouldInlineCXX(getAnalysisManager()))
3932f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose      return false;
3942f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose
395ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose    // Only inline constructors and destructors if we built the CFGs for them
396ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose    // properly.
397ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose    const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext();
398c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose    if (!ADC->getCFGBuildOptions().AddImplicitDtors)
399ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose      return false;
400ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose
401ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose    const CXXDestructorCall &Dtor = cast<CXXDestructorCall>(Call);
402ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose
403ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose    // FIXME: We don't handle constructors or destructors for arrays properly.
404ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose    const MemRegion *Target = Dtor.getCXXThisVal().getAsRegion();
405ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose    if (Target && isa<ElementRegion>(Target))
406ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose      return false;
407ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose
408da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose    break;
409da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose  }
41070cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose  case CE_CXXAllocator:
411c568e2f801a62e442cbbd823b71f70175715661fJordan Rose    if (!shouldInlineCXX(getAnalysisManager()))
4122f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose      return false;
4132f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose
41470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose    // Do not inline allocators until we model deallocators.
41570cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose    // This is unfortunate, but basically necessary for smart pointers and such.
41670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose    return false;
41769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  case CE_Block: {
41869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose    const BlockDataRegion *BR = cast<BlockCall>(Call).getBlockRegion();
419ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose    assert(BR && "If we have the block definition we should have its region");
42069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose    AnalysisDeclContext *BlockCtx = AMgr.getAnalysisDeclContext(D);
4217fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek    ParentOfCallee = BlockCtx->getBlockInvocationContext(CallerSFC,
42269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose                                                         cast<BlockDecl>(D),
4237fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek                                                         BR);
42469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose    break;
42569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  }
42669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  case CE_ObjCMessage:
427255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek    if (!(getAnalysisManager().options.IPAMode == DynamicDispatch ||
428255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek          getAnalysisManager().options.IPAMode == DynamicDispatchBifurcate))
429e13056a8bb532ddfdc07952a13169aa422bacd3bAnna Zaks      return false;
4309dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks    break;
431256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek  }
432ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose
433ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose  if (!shouldInlineDecl(D, Pred))
4347fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek    return false;
4357fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek
4367fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  if (!ParentOfCallee)
4377fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek    ParentOfCallee = CallerSFC;
4387fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek
439852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose  // This may be NULL, but that's fine.
44069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  const Expr *CallE = Call.getOriginExpr();
44169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose
4427fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  // Construct a new stack frame for the callee.
4437fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D);
4447fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  const StackFrameContext *CalleeSFC =
44569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose    CalleeADC->getStackFrame(ParentOfCallee, CallE,
44666c486f275531df6362b3511fc3af6563561801bTed Kremenek                             currBldrCtx->getBlock(),
44766c486f275531df6362b3511fc3af6563561801bTed Kremenek                             currStmtIdx);
4487fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek
449c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose  CallEnter Loc(CallE, CalleeSFC, CurLC);
450e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose
451e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose  // Construct a new state which contains the mapping from actual to
452e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose  // formal arguments.
453e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  State = State->enterStackFrame(Call, CalleeSFC);
454e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose
4557fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  bool isNew;
456e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose  if (ExplodedNode *N = G.getNode(Loc, State, false, &isNew)) {
4577fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek    N->addPredecessor(Pred, G);
4587fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek    if (isNew)
4597fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek      Engine.getWorkList()->enqueue(N);
4607fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  }
461e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks
462e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  // If we decided to inline the call, the successor has been manually
463e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  // added onto the work list so remove it from the node builder.
464e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  Bldr.takeNodes(Pred);
465e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks
466210f5a28227c90d739298e3e6729e827858fe397Anna Zaks  NumInlinedCalls++;
467210f5a28227c90d739298e3e6729e827858fe397Anna Zaks
4687fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek  return true;
469256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek}
470256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek
471e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksstatic ProgramStateRef getInlineFailedState(ProgramStateRef State,
47269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose                                            const Stmt *CallE) {
473e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks  void *ReplayState = State->get<ReplayWithoutInlining>();
4745903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks  if (!ReplayState)
4755903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks    return 0;
47628038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose
47728038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose  assert(ReplayState == (const void*)CallE && "Backtracked to the wrong call.");
47828038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose  (void)CallE;
47928038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose
480e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks  return State->remove<ReplayWithoutInlining>();
48110520d76044e8fff71d414f30c21b449fd104960Ted Kremenek}
48210520d76044e8fff71d414f30c21b449fd104960Ted Kremenek
483294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred,
484294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek                               ExplodedNodeSet &dst) {
485294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek  // Perform the previsit of the CallExpr.
486294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek  ExplodedNodeSet dstPreVisit;
487294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek  getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, CE, *this);
488500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose
489d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  // Get the call in its initial state. We use this as a template to perform
490d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  // all the checks.
491d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  CallEventManager &CEMgr = getStateManager().getCallEventManager();
492645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose  CallEventRef<> CallTemplate
493d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose    = CEMgr.getSimpleCall(CE, Pred->getState(), Pred->getLocationContext());
49469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose
49569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  // Evaluate the function call.  We try each of the checkers
496294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek  // to see if the can evaluate the function call.
497294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek  ExplodedNodeSet dstCallEvaluated;
49869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  for (ExplodedNodeSet::iterator I = dstPreVisit.begin(), E = dstPreVisit.end();
49969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose       I != E; ++I) {
500d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose    evalCall(dstCallEvaluated, *I, *CallTemplate);
50169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  }
50269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose
503294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek  // Finally, perform the post-condition check of the CallExpr and store
504294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek  // the created nodes in 'Dst'.
50569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  // Note that if the call was inlined, dstCallEvaluated will be empty.
50669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  // The post-CallExpr check will occur in processCallExit.
507294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek  getCheckerManager().runCheckersForPostStmt(dst, dstCallEvaluated, CE,
508294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek                                             *this);
509294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek}
510294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek
51169f87c956b3ac2b80124fd9604af012e1061473aJordan Rosevoid ExprEngine::evalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred,
512645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose                          const CallEvent &Call) {
513d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  // WARNING: At this time, the state attached to 'Call' may be older than the
514d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  // state in 'Pred'. This is a minor optimization since CheckerManager will
515d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  // use an updated CallEvent instance when calling checkers, but if 'Call' is
516d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  // ever used directly in this function all callers should be updated to pass
517d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  // the most recent state. (It is probably not worth doing the work here since
518d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  // for some callers this will not be necessary.)
519d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose
52096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose  // Run any pre-call checks using the generic call interface.
52196479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose  ExplodedNodeSet dstPreVisit;
52296479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose  getCheckerManager().runCheckersForPreCall(dstPreVisit, Pred, Call, *this);
52396479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose
52496479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose  // Actually evaluate the function call.  We try each of the checkers
52596479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose  // to see if the can evaluate the function call, and get a callback at
52696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose  // defaultEvalCall if all of them fail.
52796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose  ExplodedNodeSet dstCallEvaluated;
52896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose  getCheckerManager().runCheckersForEvalCall(dstCallEvaluated, dstPreVisit,
52996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose                                             Call, *this);
53096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose
53196479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose  // Finally, run any post-call checks.
53296479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose  getCheckerManager().runCheckersForPostCall(Dst, dstCallEvaluated,
53396479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose                                             Call, *this);
53469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose}
53569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose
536e81ce256b62717dd846bd19aecc4115a0dcd4995Anna ZaksProgramStateRef ExprEngine::bindReturnValue(const CallEvent &Call,
537e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks                                            const LocationContext *LCtx,
538e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks                                            ProgramStateRef State) {
539e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks  const Expr *E = Call.getOriginExpr();
540e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks  if (!E)
541e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks    return State;
542e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks
543e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks  // Some method families have known return values.
544e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks  if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(&Call)) {
545e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks    switch (Msg->getMethodFamily()) {
546e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks    default:
547e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks      break;
548e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks    case OMF_autorelease:
549e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks    case OMF_retain:
550e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks    case OMF_self: {
551e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks      // These methods return their receivers.
552e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks      return State->BindExpr(E, LCtx, Msg->getReceiverSVal());
553e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks    }
554e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks    }
555e460c46c5d602f65354cab0879c458890273591cJordan Rose  } else if (const CXXConstructorCall *C = dyn_cast<CXXConstructorCall>(&Call)){
556e460c46c5d602f65354cab0879c458890273591cJordan Rose    return State->BindExpr(E, LCtx, C->getCXXThisVal());
557e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks  }
558e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks
559e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks  // Conjure a symbol if the return value is unknown.
560e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks  QualType ResultTy = Call.getResultType();
561e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks  SValBuilder &SVB = getSValBuilder();
56266c486f275531df6362b3511fc3af6563561801bTed Kremenek  unsigned Count = currBldrCtx->blockCount();
5633b1df8bb941a18c4a7256d7cfcbccb9de7e39995Ted Kremenek  SVal R = SVB.conjureSymbolVal(0, E, LCtx, ResultTy, Count);
564e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks  return State->BindExpr(E, LCtx, R);
565e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks}
566e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks
567e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks// Conservatively evaluate call by invalidating regions and binding
568e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks// a conjured return value.
569e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksvoid ExprEngine::conservativeEvalCall(const CallEvent &Call, NodeBuilder &Bldr,
570e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks                                      ExplodedNode *Pred, ProgramStateRef State) {
57166c486f275531df6362b3511fc3af6563561801bTed Kremenek  State = Call.invalidateRegions(currBldrCtx->blockCount(), State);
572e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  State = bindReturnValue(Call, Pred->getLocationContext(), State);
573e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks
574e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  // And make the result node.
575e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  Bldr.generateNode(Call.getProgramPoint(), State, Pred);
576e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks}
577e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks
578e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksvoid ExprEngine::defaultEvalCall(NodeBuilder &Bldr, ExplodedNode *Pred,
579d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose                                 const CallEvent &CallTemplate) {
580d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  // Make sure we have the most recent state attached to the call.
581d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  ProgramStateRef State = Pred->getState();
582d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  CallEventRef<> Call = CallTemplate.cloneWithState(State);
583e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks
5845960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks  if (!getAnalysisManager().shouldInlineCall()) {
5855960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks    conservativeEvalCall(*Call, Bldr, Pred, State);
5865960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks    return;
5875960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks  }
58869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  // Try to inline the call.
58928038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose  // The origin expression here is just used as a kind of checksum;
590d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  // this should still be safe even for CallEvents that don't come from exprs.
591d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  const Expr *E = Call->getOriginExpr();
592d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  ProgramStateRef InlinedFailedState = getInlineFailedState(State, E);
593d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose
594d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose  if (InlinedFailedState) {
595d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose    // If we already tried once and failed, make sure we don't retry later.
596d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose    State = InlinedFailedState;
5975960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks  } else {
598e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks    RuntimeDefinition RD = Call->getRuntimeDefinition();
599fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks    const Decl *D = RD.getDecl();
600e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks    if (D) {
601b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose      if (RD.mayHaveOtherDefinitions()) {
602b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose        // Explore with and without inlining the call.
603255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek        if (getAnalysisManager().options.IPAMode == DynamicDispatchBifurcate) {
604b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose          BifurcateCall(RD.getDispatchRegion(), *Call, D, Bldr, Pred);
605b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose          return;
606b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose        }
607b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose
608b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose        // Don't inline if we're not in any dynamic dispatch mode.
609255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek        if (getAnalysisManager().options.IPAMode != DynamicDispatch) {
610da29ac527063fc9714547088bf841bfa30557bf0Jordan Rose          conservativeEvalCall(*Call, Bldr, Pred, State);
611b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose          return;
612da29ac527063fc9714547088bf841bfa30557bf0Jordan Rose        }
613e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks      }
614b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose
6155960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks      // We are not bifurcating and we do have a Decl, so just inline.
6165960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks      if (inlineCall(*Call, D, Bldr, Pred, State))
6175960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks        return;
618e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks    }
619e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks  }
62069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose
62169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose  // If we can't inline it, handle the return value and invalidate the regions.
622e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  conservativeEvalCall(*Call, Bldr, Pred, State);
623e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks}
62469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose
625e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksvoid ExprEngine::BifurcateCall(const MemRegion *BifurReg,
626e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks                               const CallEvent &Call, const Decl *D,
627e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks                               NodeBuilder &Bldr, ExplodedNode *Pred) {
628e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  assert(BifurReg);
629b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose  BifurReg = BifurReg->StripCasts();
630e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks
631e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  // Check if we've performed the split already - note, we only want
632e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  // to split the path once per memory region.
633e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  ProgramStateRef State = Pred->getState();
6346960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks  const unsigned int *BState =
6356960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks                        State->get<DynamicDispatchBifurcationMap>(BifurReg);
6365960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks  if (BState) {
6375960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks    // If we are on "inline path", keep inlining if possible.
6386960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks    if (*BState == DynamicDispatchModeInlined)
6395960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks      if (inlineCall(Call, D, Bldr, Pred, State))
6405960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks        return;
6415960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks    // If inline failed, or we are on the path where we assume we
6425960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks    // don't have enough info about the receiver to inline, conjure the
6435960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks    // return value and invalidate the regions.
6445960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks    conservativeEvalCall(Call, Bldr, Pred, State);
6455960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks    return;
646e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  }
647e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks
648e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  // If we got here, this is the first time we process a message to this
649e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  // region, so split the path.
650e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  ProgramStateRef IState =
6516960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks      State->set<DynamicDispatchBifurcationMap>(BifurReg,
6526960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks                                               DynamicDispatchModeInlined);
653e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  inlineCall(Call, D, Bldr, Pred, IState);
654e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks
655e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  ProgramStateRef NoIState =
6566960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks      State->set<DynamicDispatchBifurcationMap>(BifurReg,
6576960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks                                               DynamicDispatchModeConservative);
658e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  conservativeEvalCall(Call, Bldr, Pred, NoIState);
659e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks
660e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  NumOfDynamicDispatchPathSplits++;
661e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks  return;
66269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose}
66369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose
664e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks
665294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitReturnStmt(const ReturnStmt *RS, ExplodedNode *Pred,
666294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek                                 ExplodedNodeSet &Dst) {
667256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek
668256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek  ExplodedNodeSet dstPreVisit;
669256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek  getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, RS, *this);
670256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek
67166c486f275531df6362b3511fc3af6563561801bTed Kremenek  StmtNodeBuilder B(dstPreVisit, Dst, *currBldrCtx);
672256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek
673256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek  if (RS->getRetValue()) {
674256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek    for (ExplodedNodeSet::iterator it = dstPreVisit.begin(),
675256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek                                  ei = dstPreVisit.end(); it != ei; ++it) {
676256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek      B.generateNode(RS, *it, (*it)->getState());
677294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek    }
678294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek  }
679294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek}
680