ExprEngineCallAndReturn.cpp revision d563d3fb73879df7147b8a5302c3bf0e1402ba18
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 14d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek#include "clang/Analysis/Analyses/LiveVariables.h" 15294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/StaticAnalyzer/Core/CheckerManager.h" 16294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h" 17f540c54701e3eeb34cb619a3a4eb18f1ac70ef2dJordan Rose#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h" 18294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/AST/DeclCXX.h" 194a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/ADT/SmallSet.h" 204a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/Support/SaveAndRestore.h" 21294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 22294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekusing namespace clang; 23294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekusing namespace ento; 24294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 253070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenekvoid ExprEngine::processCallEnter(CallEnter CE, ExplodedNode *Pred) { 263070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Get the entry block in the CFG of the callee. 270849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek const StackFrameContext *calleeCtx = CE.getCalleeContext(); 280849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek const CFG *CalleeCFG = calleeCtx->getCFG(); 293070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek const CFGBlock *Entry = &(CalleeCFG->getEntry()); 303070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 313070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Validate the CFG. 323070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek assert(Entry->empty()); 333070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek assert(Entry->succ_size() == 1); 343070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 353070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Get the solitary sucessor. 363070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek const CFGBlock *Succ = *(Entry->succ_begin()); 373070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 383070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Construct an edge representing the starting location in the callee. 390849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek BlockEdge Loc(Entry, Succ, calleeCtx); 403070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 41e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose ProgramStateRef state = Pred->getState(); 423070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 433070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Construct a new node and add it to the worklist. 443070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek bool isNew; 453070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek ExplodedNode *Node = G.getNode(Loc, state, false, &isNew); 463070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek Node->addPredecessor(Pred, G); 473070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek if (isNew) 483070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek Engine.getWorkList()->enqueue(Node); 49294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 50294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 510b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// Find the last statement on the path to the exploded node and the 520b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// corresponding Block. 530b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksstatic std::pair<const Stmt*, 540b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock*> getLastStmt(const ExplodedNode *Node) { 550b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const Stmt *S = 0; 560b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *SF = 570b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Node->getLocation().getLocationContext()->getCurrentStackFrame(); 58888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 59888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // Back up through the ExplodedGraph until we reach a statement node. 60256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek while (Node) { 61256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const ProgramPoint &PP = Node->getLocation(); 62888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 63256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (const StmtPoint *SP = dyn_cast<StmtPoint>(&PP)) { 640b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks S = SP->getStmt(); 650b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks break; 66888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } else if (const CallExitEnd *CEE = dyn_cast<CallExitEnd>(&PP)) { 67888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose S = CEE->getCalleeContext()->getCallSite(); 68888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (S) 69888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 70888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // If we have an implicit call, we'll probably end up with a 71888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // StmtPoint inside the callee, which is acceptable. 72888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // (It's possible a function ONLY contains implicit calls -- such as an 73888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // implicitly-generated destructor -- so we shouldn't just skip back to 74888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // the CallEnter node and keep going.) 75888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } else if (const CallEnter *CE = dyn_cast<CallEnter>(&PP)) { 76888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // If we reached the CallEnter for this function, it has no statements. 77888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (CE->getCalleeContext() == SF) 78888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 79256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 80888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 81888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose Node = *Node->pred_begin(); 82256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 83888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 84888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose const CFGBlock *Blk = 0; 85888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (S) { 86888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // Now, get the enclosing basic block. 87888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose while (Node && Node->pred_size() >=1 ) { 88888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose const ProgramPoint &PP = Node->getLocation(); 89888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (isa<BlockEdge>(PP) && 90888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose (PP.getLocationContext()->getCurrentStackFrame() == SF)) { 91888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose BlockEdge &EPP = cast<BlockEdge>(PP); 92888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose Blk = EPP.getDst(); 93888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 94888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } 95888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose Node = *Node->pred_begin(); 96888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } 97888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } 98888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 990b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return std::pair<const Stmt*, const CFGBlock*>(S, Blk); 100256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 101256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 1020b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// The call exit is simulated with a sequence of nodes, which occur between 1030b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// CallExitBegin and CallExitEnd. The following operations occur between the 1040b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// two program points: 1050b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 1. CallExitBegin (triggers the start of call exit sequence) 1060b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 2. Bind the return value 1070b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 3. Run Remove dead bindings to clean up the dead symbols from the callee. 1080b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 4. CallExitEnd (switch to the caller context) 1090b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 5. PostStmt<CallExpr> 1100b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksvoid ExprEngine::processCallExit(ExplodedNode *CEBNode) { 1110b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 1 CEBNode was generated before the call. 1120b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1130b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *calleeCtx = 1140b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEBNode->getLocationContext()->getCurrentStackFrame(); 1157fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 1167fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // The parent context might not be a stack frame, so make sure we 1177fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // look up the first enclosing stack frame. 1187fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *callerCtx = 1197fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek calleeCtx->getParent()->getCurrentStackFrame(); 1207fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 121294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek const Stmt *CE = calleeCtx->getCallSite(); 1220b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramStateRef state = CEBNode->getState(); 1230b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Find the last statement in the function and the corresponding basic block. 1240b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const Stmt *LastSt = 0; 1250b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock *Blk = 0; 1260b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks llvm::tie(LastSt, Blk) = getLastStmt(CEBNode); 1270b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 128852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Step 2: generate node with bound return value: CEBNode -> BindedRetNode. 1290b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 130294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // If the callee returns an expression, bind its value to CallExpr. 131852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (CE) { 132852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const ReturnStmt *RS = dyn_cast_or_null<ReturnStmt>(LastSt)) { 133852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose const LocationContext *LCtx = CEBNode->getLocationContext(); 134852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal V = state->getSVal(RS, LCtx); 13548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose state = state->BindExpr(CE, calleeCtx->getParent(), V); 136852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 1370b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 138852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Bind the constructed object value to CXXConstructExpr. 139852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(CE)) { 140852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose loc::MemRegionVal This = 141852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose svalBuilder.getCXXThis(CCE->getConstructor()->getParent(), calleeCtx); 142852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal ThisV = state->getSVal(This); 1430b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 144852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Always bind the region to the CXXConstructExpr. 14548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose state = state->BindExpr(CCE, calleeCtx->getParent(), ThisV); 146852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 147294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 1480b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1490b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 3: BindedRetNode -> CleanedNodes 1500b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // If we can find a statement and a block in the inlined function, run remove 1510b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // dead bindings before returning from the call. This is important to ensure 1520b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // that we report the issues such as leaks in the stack contexts in which 1530b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // they occurred. 1540b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNodeSet CleanedNodes; 1550b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (LastSt && Blk) { 15648b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose static SimpleProgramPointTag retValBind("ExprEngine : Bind Return Value"); 15748b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose PostStmt Loc(LastSt, calleeCtx, &retValBind); 15848b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose bool isNew; 15948b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *BindedRetNode = G.getNode(Loc, state, false, &isNew); 16048b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose BindedRetNode->addPredecessor(CEBNode, G); 16148b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose if (!isNew) 16248b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose return; 16348b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose 1640b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(getCoreEngine(), Blk, BindedRetNode); 1650b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks currentBuilderContext = &Ctx; 1660b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Here, we call the Symbol Reaper with 0 statement and caller location 1670b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // context, telling it to clean up everything in the callee's context 1680b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // (and it's children). We use LastStmt as a diagnostic statement, which 1690b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // which the PreStmtPurge Dead point will be associated. 1700b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks removeDead(BindedRetNode, CleanedNodes, 0, callerCtx, LastSt, 1710b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramPoint::PostStmtPurgeDeadSymbolsKind); 1720b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks currentBuilderContext = 0; 173144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks } else { 174144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks CleanedNodes.Add(CEBNode); 1750b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 1760b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1770b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator I = CleanedNodes.begin(), 1780b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks E = CleanedNodes.end(); I != E; ++I) { 1790b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1800b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 4: Generate the CallExit and leave the callee's context. 1810b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CleanedNodes -> CEENode 182852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose CallExitEnd Loc(calleeCtx, callerCtx); 1830b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks bool isNew; 18448b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ProgramStateRef CEEState = (*I == CEBNode) ? state : (*I)->getState(); 18548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *CEENode = G.getNode(Loc, CEEState, false, &isNew); 1860b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEENode->addPredecessor(*I, G); 1870b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (!isNew) 1880b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return; 1890b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1900b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 5: Perform the post-condition check of the CallExpr and enqueue the 1910b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // result onto the work list. 1920b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CEENode -> Dst -> WorkList 1930b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNodeSet Dst; 1940b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(Engine, calleeCtx->getCallSiteBlock(), CEENode); 1950b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks SaveAndRestore<const NodeBuilderContext*> NBCSave(currentBuilderContext, 1960b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks &Ctx); 1970b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks SaveAndRestore<unsigned> CBISave(currentStmtIdx, calleeCtx->getIndex()); 1980b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 199852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // FIXME: This needs to call PostCall. 20048b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose // FIXME: If/when we inline Objective-C messages, this also needs to call 20148b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose // PostObjCMessage. 202852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (CE) 203852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose getCheckerManager().runCheckersForPostStmt(Dst, CEENode, CE, *this, true); 20448b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose else 20548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose Dst.Add(CEENode); 2060b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2070b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Enqueue the next element in the block. 2080b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator PSI = Dst.begin(), PSE = Dst.end(); 2090b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks PSI != PSE; ++PSI) { 2100b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Engine.getWorkList()->enqueue(*PSI, calleeCtx->getCallSiteBlock(), 2110b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks calleeCtx->getIndex()+1); 2120b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 213242384ddb0e0b65dd7e9e0ac0cf3c31cf98b06a6Ted Kremenek } 214294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 215294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 2160849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenekstatic unsigned getNumberStackFrames(const LocationContext *LCtx) { 2170849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek unsigned count = 0; 2180849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek while (LCtx) { 2190849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek if (isa<StackFrameContext>(LCtx)) 2200849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek ++count; 2210849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek LCtx = LCtx->getParent(); 2220849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek } 2230849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek return count; 2240849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek} 2250849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek 2266cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks// Determine if we should inline the call. 2277fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenekbool ExprEngine::shouldInlineDecl(const Decl *D, ExplodedNode *Pred) { 2287fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 2296cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 2306cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 23101561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // It is possible that the CFG cannot be constructed. 23201561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // Be safe, and check if the CalleeCFG is valid. 23301561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek if (!CalleeCFG) 23401561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek return false; 23501561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek 2366cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks if (getNumberStackFrames(Pred->getLocationContext()) 2376cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks == AMgr.InlineMaxStackDepth) 2386cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 2396cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 2407fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (Engine.FunctionSummaries->hasReachedMaxBlockCount(D)) 2413bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks return false; 2423bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks 2436cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks if (CalleeCFG->getNumBlockIDs() > AMgr.InlineMaxFunctionSize) 2446cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 2456cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 24610f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek // Do not inline variadic calls (for now). 24710f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) { 24810f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (BD->isVariadic()) 24910f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return false; 25010f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek } 25110f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { 25210f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (FD->isVariadic()) 25310f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return false; 2545903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks } 2555903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 256d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek // It is possible that the live variables analysis cannot be 257d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek // run. If so, bail out. 258d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek if (!CalleeADC->getAnalysis<RelaxedLiveVariables>()) 259d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek return false; 260d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek 26110f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return true; 2625903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks} 2635903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 264e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksbool ExprEngine::inlineCall(const CallEvent &Call, 265256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNode *Pred) { 26610f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (!getAnalysisManager().shouldInlineCall()) 2675903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return false; 2685903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 2699dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks const Decl *D = Call.getRuntimeDefinition(); 2709dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks if (!D) 271ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose return false; 272ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 273c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const LocationContext *CurLC = Pred->getLocationContext(); 274c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const StackFrameContext *CallerSFC = CurLC->getCurrentStackFrame(); 2757fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const LocationContext *ParentOfCallee = 0; 27669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 27769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose switch (Call.getKind()) { 27869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_Function: 27969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_CXXMember: 280e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose case CE_CXXMemberOperator: 28169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // These are always at least possible to inline. 28269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose break; 28370cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXConstructor: 284da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose case CE_CXXDestructor: { 285da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose // Only inline constructors and destructors if we built the CFGs for them 286da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose // properly. 287da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 288da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose if (!ADC->getCFGBuildOptions().AddImplicitDtors || 289da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose !ADC->getCFGBuildOptions().AddInitializers) 290da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose return false; 2913a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose 292e460c46c5d602f65354cab0879c458890273591cJordan Rose // FIXME: We don't handle constructors or destructors for arrays properly. 293e460c46c5d602f65354cab0879c458890273591cJordan Rose const MemRegion *Target = Call.getCXXThisVal().getAsRegion(); 294e460c46c5d602f65354cab0879c458890273591cJordan Rose if (Target && isa<ElementRegion>(Target)) 295e460c46c5d602f65354cab0879c458890273591cJordan Rose return false; 296e460c46c5d602f65354cab0879c458890273591cJordan Rose 2973a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose // FIXME: This is a hack. We don't handle temporary destructors 298888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // right now, so we shouldn't inline their constructors. 299888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (const CXXConstructorCall *Ctor = dyn_cast<CXXConstructorCall>(&Call)) { 300888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose const CXXConstructExpr *CtorExpr = Ctor->getOriginExpr(); 301888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (CtorExpr->getConstructionKind() == CXXConstructExpr::CK_Complete) 302e460c46c5d602f65354cab0879c458890273591cJordan Rose if (!Target || !isa<DeclRegion>(Target)) 303e460c46c5d602f65354cab0879c458890273591cJordan Rose return false; 304888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } 305da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose break; 306da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose } 30770cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXAllocator: 30870cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // Do not inline allocators until we model deallocators. 30970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // This is unfortunate, but basically necessary for smart pointers and such. 31070cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return false; 31169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_Block: { 31269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDataRegion *BR = cast<BlockCall>(Call).getBlockRegion(); 313ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose assert(BR && "If we have the block definition we should have its region"); 31469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose AnalysisDeclContext *BlockCtx = AMgr.getAnalysisDeclContext(D); 3157fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = BlockCtx->getBlockInvocationContext(CallerSFC, 31669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose cast<BlockDecl>(D), 3177fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek BR); 31869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose break; 31969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 32069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_ObjCMessage: 3219dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks break; 322256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 323ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 324ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose if (!shouldInlineDecl(D, Pred)) 3257fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return false; 3267fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 3277fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (!ParentOfCallee) 3287fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = CallerSFC; 3297fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 330852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // This may be NULL, but that's fine. 33169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Expr *CallE = Call.getOriginExpr(); 33269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 3337fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // Construct a new stack frame for the callee. 3347fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 3357fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *CalleeSFC = 33669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose CalleeADC->getStackFrame(ParentOfCallee, CallE, 3377fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek currentBuilderContext->getBlock(), 3387fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek currentStmtIdx); 3397fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 340c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CallEnter Loc(CallE, CalleeSFC, CurLC); 341e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 342e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // Construct a new state which contains the mapping from actual to 343e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // formal arguments. 344e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose ProgramStateRef State = Pred->getState()->enterStackFrame(Call, CalleeSFC); 345e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 3467fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek bool isNew; 347e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose if (ExplodedNode *N = G.getNode(Loc, State, false, &isNew)) { 3487fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek N->addPredecessor(Pred, G); 3497fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (isNew) 3507fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek Engine.getWorkList()->enqueue(N); 3517fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek } 3527fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return true; 353256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 354256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 355e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksstatic ProgramStateRef getInlineFailedState(ProgramStateRef State, 35669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Stmt *CallE) { 357e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks void *ReplayState = State->get<ReplayWithoutInlining>(); 3585903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!ReplayState) 3595903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return 0; 36028038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 36128038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose assert(ReplayState == (const void*)CallE && "Backtracked to the wrong call."); 36228038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose (void)CallE; 36328038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 364e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->remove<ReplayWithoutInlining>(); 36510520d76044e8fff71d414f30c21b449fd104960Ted Kremenek} 36610520d76044e8fff71d414f30c21b449fd104960Ted Kremenek 367294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred, 368294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &dst) { 369294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Perform the previsit of the CallExpr. 370294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstPreVisit; 371294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, CE, *this); 372500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 373d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Get the call in its initial state. We use this as a template to perform 374d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // all the checks. 375d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 376d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<SimpleCall> CallTemplate 377d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose = CEMgr.getSimpleCall(CE, Pred->getState(), Pred->getLocationContext()); 37869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 37969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Evaluate the function call. We try each of the checkers 380294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // to see if the can evaluate the function call. 381294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstCallEvaluated; 38269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose for (ExplodedNodeSet::iterator I = dstPreVisit.begin(), E = dstPreVisit.end(); 38369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose I != E; ++I) { 384d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose evalCall(dstCallEvaluated, *I, *CallTemplate); 38569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 38669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 387294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Finally, perform the post-condition check of the CallExpr and store 388294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // the created nodes in 'Dst'. 38969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Note that if the call was inlined, dstCallEvaluated will be empty. 39069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // The post-CallExpr check will occur in processCallExit. 391294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPostStmt(dst, dstCallEvaluated, CE, 392294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek *this); 393294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 394294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 39569f87c956b3ac2b80124fd9604af012e1061473aJordan Rosevoid ExprEngine::evalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred, 39669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const SimpleCall &Call) { 397d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // WARNING: At this time, the state attached to 'Call' may be older than the 398d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // state in 'Pred'. This is a minor optimization since CheckerManager will 399d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // use an updated CallEvent instance when calling checkers, but if 'Call' is 400d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // ever used directly in this function all callers should be updated to pass 401d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // the most recent state. (It is probably not worth doing the work here since 402d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // for some callers this will not be necessary.) 403d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 40496479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Run any pre-call checks using the generic call interface. 40596479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstPreVisit; 40696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPreCall(dstPreVisit, Pred, Call, *this); 40796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 40896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Actually evaluate the function call. We try each of the checkers 40996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // to see if the can evaluate the function call, and get a callback at 41096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // defaultEvalCall if all of them fail. 41196479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstCallEvaluated; 41296479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForEvalCall(dstCallEvaluated, dstPreVisit, 41396479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 41496479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 41596479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Finally, run any post-call checks. 41696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPostCall(Dst, dstCallEvaluated, 41796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 41869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 41969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 420e81ce256b62717dd846bd19aecc4115a0dcd4995Anna ZaksProgramStateRef ExprEngine::bindReturnValue(const CallEvent &Call, 421e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const LocationContext *LCtx, 422e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks ProgramStateRef State) { 423e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const Expr *E = Call.getOriginExpr(); 424e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (!E) 425e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State; 426e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 427e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Some method families have known return values. 428e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(&Call)) { 429e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks switch (Msg->getMethodFamily()) { 430e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks default: 431e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks break; 432e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_autorelease: 433e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_retain: 434e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_self: { 435e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // These methods return their receivers. 436e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, Msg->getReceiverSVal()); 437e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 438e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 439e460c46c5d602f65354cab0879c458890273591cJordan Rose } else if (const CXXConstructorCall *C = dyn_cast<CXXConstructorCall>(&Call)){ 440e460c46c5d602f65354cab0879c458890273591cJordan Rose return State->BindExpr(E, LCtx, C->getCXXThisVal()); 441e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 442e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 443e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Conjure a symbol if the return value is unknown. 444e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks QualType ResultTy = Call.getResultType(); 445e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks SValBuilder &SVB = getSValBuilder(); 446e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks unsigned Count = currentBuilderContext->getCurrentBlockCount(); 447e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks SVal R = SVB.getConjuredSymbolVal(0, E, LCtx, ResultTy, Count); 448e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, R); 449e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks} 450e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 451e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksvoid ExprEngine::defaultEvalCall(NodeBuilder &Bldr, ExplodedNode *Pred, 452d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const CallEvent &CallTemplate) { 453d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Make sure we have the most recent state attached to the call. 454d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef State = Pred->getState(); 455d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<> Call = CallTemplate.cloneWithState(State); 456e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 45769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Try to inline the call. 45828038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // The origin expression here is just used as a kind of checksum; 459d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // this should still be safe even for CallEvents that don't come from exprs. 460d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const Expr *E = Call->getOriginExpr(); 461d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef InlinedFailedState = getInlineFailedState(State, E); 462d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 463d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose if (InlinedFailedState) { 464d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // If we already tried once and failed, make sure we don't retry later. 465d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose State = InlinedFailedState; 466d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } else if (inlineCall(*Call, Pred)) { 467d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // If we decided to inline the call, the successor has been manually 468d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // added onto the work list and we should not perform our generic 469d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // call-handling steps. 4709dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks Bldr.takeNodes(Pred); 4719dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks return; 472e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 47369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 47469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // If we can't inline it, handle the return value and invalidate the regions. 47569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose unsigned Count = currentBuilderContext->getCurrentBlockCount(); 476d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose State = Call->invalidateRegions(Count, State); 477d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose State = bindReturnValue(*Call, Pred->getLocationContext(), State); 47869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 47969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // And make the result node. 480d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose Bldr.generateNode(Call->getProgramPoint(), State, Pred); 48169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 48269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 483294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitReturnStmt(const ReturnStmt *RS, ExplodedNode *Pred, 484294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &Dst) { 485256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 486256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNodeSet dstPreVisit; 487256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, RS, *this); 488256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 489256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek StmtNodeBuilder B(dstPreVisit, Dst, *currentBuilderContext); 490256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 491256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (RS->getRetValue()) { 492256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek for (ExplodedNodeSet::iterator it = dstPreVisit.begin(), 493256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ei = dstPreVisit.end(); it != ei; ++it) { 494256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek B.generateNode(RS, *it, (*it)->getState()); 495294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 496294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 497294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 498