ExprEngineCallAndReturn.cpp revision e81ce256b62717dd846bd19aecc4115a0dcd4995
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" 17740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/StaticAnalyzer/Core/PathSensitive/Calls.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 25fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rosestatic CallEventKind classifyCallExpr(const CallExpr *CE) { 26fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose if (isa<CXXMemberCallExpr>(CE)) 27fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return CE_CXXMember; 28fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 29fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose const CXXOperatorCallExpr *OpCE = dyn_cast<CXXOperatorCallExpr>(CE); 30fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose if (OpCE) { 31fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose const FunctionDecl *DirectCallee = CE->getDirectCallee(); 32fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(DirectCallee)) 33fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose if (MD->isInstance()) 34fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return CE_CXXMemberOperator; 35fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } else if (CE->getCallee()->getType()->isBlockPointerType()) { 36fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return CE_Block; 37fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 38fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 39fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return CE_Function; 40fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose} 41fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 423070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenekvoid ExprEngine::processCallEnter(CallEnter CE, ExplodedNode *Pred) { 433070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Get the entry block in the CFG of the callee. 440849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek const StackFrameContext *calleeCtx = CE.getCalleeContext(); 450849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek const CFG *CalleeCFG = calleeCtx->getCFG(); 463070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek const CFGBlock *Entry = &(CalleeCFG->getEntry()); 473070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 483070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Validate the CFG. 493070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek assert(Entry->empty()); 503070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek assert(Entry->succ_size() == 1); 513070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 523070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Get the solitary sucessor. 533070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek const CFGBlock *Succ = *(Entry->succ_begin()); 543070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 553070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Construct an edge representing the starting location in the callee. 560849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek BlockEdge Loc(Entry, Succ, calleeCtx); 573070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 58e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose ProgramStateRef state = Pred->getState(); 593070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 603070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Construct a new node and add it to the worklist. 613070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek bool isNew; 623070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek ExplodedNode *Node = G.getNode(Loc, state, false, &isNew); 633070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek Node->addPredecessor(Pred, G); 643070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek if (isNew) 653070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek Engine.getWorkList()->enqueue(Node); 66294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 67294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 680b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// Find the last statement on the path to the exploded node and the 690b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// corresponding Block. 700b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksstatic std::pair<const Stmt*, 710b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock*> getLastStmt(const ExplodedNode *Node) { 720b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const Stmt *S = 0; 730b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock *Blk = 0; 740b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *SF = 750b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Node->getLocation().getLocationContext()->getCurrentStackFrame(); 76256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek while (Node) { 77256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const ProgramPoint &PP = Node->getLocation(); 780b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Skip any BlockEdges, empty blocks, and the CallExitBegin node. 790b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (isa<BlockEdge>(PP) || isa<CallExitBegin>(PP) || isa<BlockEntrance>(PP)){ 80256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek assert(Node->pred_size() == 1); 81256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek Node = *Node->pred_begin(); 82256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek continue; 830b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 840b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // If we reached the CallEnter, the function has no statements. 850b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (isa<CallEnter>(PP)) 860b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks break; 87256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (const StmtPoint *SP = dyn_cast<StmtPoint>(&PP)) { 880b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks S = SP->getStmt(); 890b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Now, get the enclosing basic block. 900b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks while (Node && Node->pred_size() >=1 ) { 910b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const ProgramPoint &PP = Node->getLocation(); 920b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (isa<BlockEdge>(PP) && 930b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks (PP.getLocationContext()->getCurrentStackFrame() == SF)) { 940b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks BlockEdge &EPP = cast<BlockEdge>(PP); 950b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Blk = EPP.getDst(); 960b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks break; 970b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 980b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Node = *Node->pred_begin(); 990b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 1000b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks break; 101256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 102256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek break; 103256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 1040b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return std::pair<const Stmt*, const CFGBlock*>(S, Blk); 105256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 106256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 1070b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// The call exit is simulated with a sequence of nodes, which occur between 1080b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// CallExitBegin and CallExitEnd. The following operations occur between the 1090b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// two program points: 1100b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 1. CallExitBegin (triggers the start of call exit sequence) 1110b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 2. Bind the return value 1120b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 3. Run Remove dead bindings to clean up the dead symbols from the callee. 1130b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 4. CallExitEnd (switch to the caller context) 1140b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 5. PostStmt<CallExpr> 1150b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksvoid ExprEngine::processCallExit(ExplodedNode *CEBNode) { 1160b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 1 CEBNode was generated before the call. 1170b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1180b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *calleeCtx = 1190b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEBNode->getLocationContext()->getCurrentStackFrame(); 1207fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 1217fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // The parent context might not be a stack frame, so make sure we 1227fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // look up the first enclosing stack frame. 1237fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *callerCtx = 1247fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek calleeCtx->getParent()->getCurrentStackFrame(); 1257fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 126294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek const Stmt *CE = calleeCtx->getCallSite(); 1270b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramStateRef state = CEBNode->getState(); 1280b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Find the last statement in the function and the corresponding basic block. 1290b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const Stmt *LastSt = 0; 1300b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock *Blk = 0; 1310b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks llvm::tie(LastSt, Blk) = getLastStmt(CEBNode); 1320b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 133852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Step 2: generate node with bound return value: CEBNode -> BindedRetNode. 1340b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 135294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // If the callee returns an expression, bind its value to CallExpr. 136852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (CE) { 137852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const ReturnStmt *RS = dyn_cast_or_null<ReturnStmt>(LastSt)) { 138852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose const LocationContext *LCtx = CEBNode->getLocationContext(); 139852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal V = state->getSVal(RS, LCtx); 14048b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose state = state->BindExpr(CE, calleeCtx->getParent(), V); 141852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 1420b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 143852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Bind the constructed object value to CXXConstructExpr. 144852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(CE)) { 145852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose loc::MemRegionVal This = 146852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose svalBuilder.getCXXThis(CCE->getConstructor()->getParent(), calleeCtx); 147852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal ThisV = state->getSVal(This); 1480b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 149852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Always bind the region to the CXXConstructExpr. 15048b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose state = state->BindExpr(CCE, calleeCtx->getParent(), ThisV); 151852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 152294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 1530b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1540b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 3: BindedRetNode -> CleanedNodes 1550b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // If we can find a statement and a block in the inlined function, run remove 1560b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // dead bindings before returning from the call. This is important to ensure 1570b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // that we report the issues such as leaks in the stack contexts in which 1580b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // they occurred. 1590b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNodeSet CleanedNodes; 1600b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (LastSt && Blk) { 16148b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose static SimpleProgramPointTag retValBind("ExprEngine : Bind Return Value"); 16248b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose PostStmt Loc(LastSt, calleeCtx, &retValBind); 16348b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose bool isNew; 16448b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *BindedRetNode = G.getNode(Loc, state, false, &isNew); 16548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose BindedRetNode->addPredecessor(CEBNode, G); 16648b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose if (!isNew) 16748b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose return; 16848b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose 1690b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(getCoreEngine(), Blk, BindedRetNode); 1700b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks currentBuilderContext = &Ctx; 1710b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Here, we call the Symbol Reaper with 0 statement and caller location 1720b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // context, telling it to clean up everything in the callee's context 1730b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // (and it's children). We use LastStmt as a diagnostic statement, which 1740b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // which the PreStmtPurge Dead point will be associated. 1750b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks removeDead(BindedRetNode, CleanedNodes, 0, callerCtx, LastSt, 1760b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramPoint::PostStmtPurgeDeadSymbolsKind); 1770b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks currentBuilderContext = 0; 178144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks } else { 179144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks CleanedNodes.Add(CEBNode); 1800b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 1810b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1820b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator I = CleanedNodes.begin(), 1830b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks E = CleanedNodes.end(); I != E; ++I) { 1840b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1850b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 4: Generate the CallExit and leave the callee's context. 1860b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CleanedNodes -> CEENode 187852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose CallExitEnd Loc(calleeCtx, callerCtx); 1880b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks bool isNew; 18948b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ProgramStateRef CEEState = (*I == CEBNode) ? state : (*I)->getState(); 19048b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *CEENode = G.getNode(Loc, CEEState, false, &isNew); 1910b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEENode->addPredecessor(*I, G); 1920b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (!isNew) 1930b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return; 1940b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1950b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 5: Perform the post-condition check of the CallExpr and enqueue the 1960b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // result onto the work list. 1970b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CEENode -> Dst -> WorkList 1980b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNodeSet Dst; 1990b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(Engine, calleeCtx->getCallSiteBlock(), CEENode); 2000b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks SaveAndRestore<const NodeBuilderContext*> NBCSave(currentBuilderContext, 2010b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks &Ctx); 2020b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks SaveAndRestore<unsigned> CBISave(currentStmtIdx, calleeCtx->getIndex()); 2030b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 204852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // FIXME: This needs to call PostCall. 20548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose // FIXME: If/when we inline Objective-C messages, this also needs to call 20648b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose // PostObjCMessage. 207852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (CE) 208852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose getCheckerManager().runCheckersForPostStmt(Dst, CEENode, CE, *this, true); 20948b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose else 21048b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose Dst.Add(CEENode); 2110b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2120b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Enqueue the next element in the block. 2130b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator PSI = Dst.begin(), PSE = Dst.end(); 2140b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks PSI != PSE; ++PSI) { 2150b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Engine.getWorkList()->enqueue(*PSI, calleeCtx->getCallSiteBlock(), 2160b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks calleeCtx->getIndex()+1); 2170b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 218242384ddb0e0b65dd7e9e0ac0cf3c31cf98b06a6Ted Kremenek } 219294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 220294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 2210849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenekstatic unsigned getNumberStackFrames(const LocationContext *LCtx) { 2220849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek unsigned count = 0; 2230849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek while (LCtx) { 2240849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek if (isa<StackFrameContext>(LCtx)) 2250849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek ++count; 2260849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek LCtx = LCtx->getParent(); 2270849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek } 2280849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek return count; 2290849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek} 2300849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek 2316cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks// Determine if we should inline the call. 2327fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenekbool ExprEngine::shouldInlineDecl(const Decl *D, ExplodedNode *Pred) { 2337fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 2346cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 2356cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 23601561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // It is possible that the CFG cannot be constructed. 23701561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // Be safe, and check if the CalleeCFG is valid. 23801561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek if (!CalleeCFG) 23901561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek return false; 24001561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek 2416cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks if (getNumberStackFrames(Pred->getLocationContext()) 2426cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks == AMgr.InlineMaxStackDepth) 2436cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 2446cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 2457fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (Engine.FunctionSummaries->hasReachedMaxBlockCount(D)) 2463bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks return false; 2473bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks 2486cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks if (CalleeCFG->getNumBlockIDs() > AMgr.InlineMaxFunctionSize) 2496cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 2506cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 25110f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek // Do not inline variadic calls (for now). 25210f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) { 25310f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (BD->isVariadic()) 25410f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return false; 25510f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek } 25610f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { 25710f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (FD->isVariadic()) 25810f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return false; 2595903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks } 2605903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 261d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek // It is possible that the live variables analysis cannot be 262d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek // run. If so, bail out. 263d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek if (!CalleeADC->getAnalysis<RelaxedLiveVariables>()) 264d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek return false; 265d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek 26610f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return true; 2675903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks} 2685903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 269e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksbool ExprEngine::inlineCall(const CallEvent &Call, 270256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNode *Pred) { 27110f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (!getAnalysisManager().shouldInlineCall()) 2725903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return false; 2735903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 274c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose bool IsDynamicDispatch; 275c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const Decl *D = Call.getDefinition(IsDynamicDispatch); 276c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose if (!D || IsDynamicDispatch) 277ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose return false; 278ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 279c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const LocationContext *CurLC = Pred->getLocationContext(); 280c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const StackFrameContext *CallerSFC = CurLC->getCurrentStackFrame(); 2817fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const LocationContext *ParentOfCallee = 0; 28269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 28369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose switch (Call.getKind()) { 28469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_Function: 28569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_CXXMember: 286e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose case CE_CXXMemberOperator: 28769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // These are always at least possible to inline. 28869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose break; 28970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXConstructor: 2908d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose case CE_CXXDestructor: 2918d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose // Do not inline constructors until we can really model destructors. 29270cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // This is unfortunate, but basically necessary for smart pointers and such. 29370cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return false; 29470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXAllocator: 29570cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // Do not inline allocators until we model deallocators. 29670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // This is unfortunate, but basically necessary for smart pointers and such. 29770cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return false; 29869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_Block: { 29969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDataRegion *BR = cast<BlockCall>(Call).getBlockRegion(); 300ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose assert(BR && "If we have the block definition we should have its region"); 30169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose AnalysisDeclContext *BlockCtx = AMgr.getAnalysisDeclContext(D); 3027fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = BlockCtx->getBlockInvocationContext(CallerSFC, 30369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose cast<BlockDecl>(D), 3047fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek BR); 30569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose break; 30669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 30769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_ObjCMessage: 30869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // These always use dynamic dispatch; enabling inlining means assuming 30969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // that a particular method will be called at runtime. 310c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose llvm_unreachable("Dynamic dispatch should be handled above."); 311256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 312ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 313ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose if (!shouldInlineDecl(D, Pred)) 3147fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return false; 3157fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 3167fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (!ParentOfCallee) 3177fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = CallerSFC; 3187fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 319852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // This may be NULL, but that's fine. 32069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Expr *CallE = Call.getOriginExpr(); 32169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 3227fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // Construct a new stack frame for the callee. 3237fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 3247fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *CalleeSFC = 32569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose CalleeADC->getStackFrame(ParentOfCallee, CallE, 3267fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek currentBuilderContext->getBlock(), 3277fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek currentStmtIdx); 3287fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 329c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CallEnter Loc(CallE, CalleeSFC, CurLC); 330e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 331e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // Construct a new state which contains the mapping from actual to 332e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // formal arguments. 333e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose ProgramStateRef State = Pred->getState()->enterStackFrame(Call, CalleeSFC); 334e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 3357fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek bool isNew; 336e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose if (ExplodedNode *N = G.getNode(Loc, State, false, &isNew)) { 3377fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek N->addPredecessor(Pred, G); 3387fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (isNew) 3397fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek Engine.getWorkList()->enqueue(N); 3407fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek } 3417fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return true; 342256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 343256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 344e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksstatic ProgramStateRef getInlineFailedState(ProgramStateRef State, 34569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Stmt *CallE) { 346e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks void *ReplayState = State->get<ReplayWithoutInlining>(); 3475903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!ReplayState) 3485903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return 0; 34928038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 35028038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose assert(ReplayState == (const void*)CallE && "Backtracked to the wrong call."); 35128038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose (void)CallE; 35228038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 353e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->remove<ReplayWithoutInlining>(); 35410520d76044e8fff71d414f30c21b449fd104960Ted Kremenek} 35510520d76044e8fff71d414f30c21b449fd104960Ted Kremenek 356294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred, 357294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &dst) { 358294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Perform the previsit of the CallExpr. 359294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstPreVisit; 360294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, CE, *this); 361500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 36269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Get the callee kind. 363fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose CallEventKind K = classifyCallExpr(CE); 36469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 36569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Evaluate the function call. We try each of the checkers 366294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // to see if the can evaluate the function call. 367294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstCallEvaluated; 36869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose for (ExplodedNodeSet::iterator I = dstPreVisit.begin(), E = dstPreVisit.end(); 36969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose I != E; ++I) { 37069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose ProgramStateRef State = (*I)->getState(); 37169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const LocationContext *LCtx = (*I)->getLocationContext(); 37269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 37369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Evaluate the call. 374fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose switch (K) { 375fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose case CE_Function: 37669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose evalCall(dstCallEvaluated, *I, FunctionCall(CE, State, LCtx)); 377fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose break; 378fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose case CE_CXXMember: 379fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose evalCall(dstCallEvaluated, *I, CXXMemberCall(cast<CXXMemberCallExpr>(CE), 380fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose State, LCtx)); 381fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose break; 382fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose case CE_CXXMemberOperator: 383fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose evalCall(dstCallEvaluated, *I, 384fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose CXXMemberOperatorCall(cast<CXXOperatorCallExpr>(CE), 385fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose State, LCtx)); 386fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose break; 387fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose case CE_Block: 388fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose evalCall(dstCallEvaluated, *I, BlockCall(CE, State, LCtx)); 389fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose break; 390fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose default: 391fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose llvm_unreachable("Non-CallExpr CallEventKind"); 392fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 39369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 39469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 395294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Finally, perform the post-condition check of the CallExpr and store 396294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // the created nodes in 'Dst'. 39769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Note that if the call was inlined, dstCallEvaluated will be empty. 39869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // The post-CallExpr check will occur in processCallExit. 399294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPostStmt(dst, dstCallEvaluated, CE, 400294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek *this); 401294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 402294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 40369f87c956b3ac2b80124fd9604af012e1061473aJordan Rosevoid ExprEngine::evalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred, 40469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const SimpleCall &Call) { 40596479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Run any pre-call checks using the generic call interface. 40696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstPreVisit; 40796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPreCall(dstPreVisit, Pred, Call, *this); 40896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 40996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Actually evaluate the function call. We try each of the checkers 41096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // to see if the can evaluate the function call, and get a callback at 41196479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // defaultEvalCall if all of them fail. 41296479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstCallEvaluated; 41396479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForEvalCall(dstCallEvaluated, dstPreVisit, 41496479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 41596479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 41696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Finally, run any post-call checks. 41796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPostCall(Dst, dstCallEvaluated, 41896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 41969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 42069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 421e81ce256b62717dd846bd19aecc4115a0dcd4995Anna ZaksProgramStateRef ExprEngine::bindReturnValue(const CallEvent &Call, 422e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const LocationContext *LCtx, 423e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks ProgramStateRef State) { 424e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const Expr *E = Call.getOriginExpr(); 425e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (!E) 426e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State; 427e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 428e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Some method families have known return values. 429e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(&Call)) { 430e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks switch (Msg->getMethodFamily()) { 431e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks default: 432e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks break; 433e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_autorelease: 434e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_retain: 435e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_self: { 436e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // These methods return their receivers. 437e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, Msg->getReceiverSVal()); 438e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks break; 439e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 440e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 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, 45269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const CallEvent &Call) { 453e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks ProgramStateRef State = 0; 454e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const Expr *E = Call.getOriginExpr(); 455e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 45669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Try to inline the call. 45728038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // The origin expression here is just used as a kind of checksum; 45828038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // for CallEvents that do not have origin expressions, this should still be 45928038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // safe. 460e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (!isa<ObjCMethodCall>(Call)) { 461e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks State = getInlineFailedState(Pred->getState(), E); 462e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (State == 0 && inlineCall(Call, Pred)) { 463e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // If we inlined the call, the successor has been manually added onto 464e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // the work list and we should not consider it for subsequent call 465e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // handling steps. 466e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks Bldr.takeNodes(Pred); 467e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return; 468e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 469e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 47069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 47169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // If we can't inline it, handle the return value and invalidate the regions. 472e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (State == 0) 473e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks State = Pred->getState(); 47469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 47569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Invalidate any regions touched by the call. 47669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose unsigned Count = currentBuilderContext->getCurrentBlockCount(); 477e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks State = Call.invalidateRegions(Count, State); 478e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 479e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Construct and bind the return value. 480e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks State = bindReturnValue(Call, Pred->getLocationContext(), State); 48169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 48269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // And make the result node. 483e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks Bldr.generateNode(Call.getProgramPoint(), State, Pred); 48469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 48569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 486294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitReturnStmt(const ReturnStmt *RS, ExplodedNode *Pred, 487294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &Dst) { 488256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 489256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNodeSet dstPreVisit; 490256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, RS, *this); 491256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 492256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek StmtNodeBuilder B(dstPreVisit, Dst, *currentBuilderContext); 493256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 494256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (RS->getRetValue()) { 495256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek for (ExplodedNodeSet::iterator it = dstPreVisit.begin(), 496256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ei = dstPreVisit.end(); it != ei; ++it) { 497256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek B.generateNode(RS, *it, (*it)->getState()); 498294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 499294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 500294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 501