ExprEngineCallAndReturn.cpp revision 57c033621dacd8720ac9ff65a09025f14f70e22f
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); 13557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose state = state->BindExpr(CE, callerCtx, 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. 14557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose state = state->BindExpr(CCE, callerCtx, 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 NodeBuilderContext Ctx(Engine, calleeCtx->getCallSiteBlock(), CEENode); 1940b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks SaveAndRestore<const NodeBuilderContext*> NBCSave(currentBuilderContext, 1950b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks &Ctx); 1960b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks SaveAndRestore<unsigned> CBISave(currentStmtIdx, calleeCtx->getIndex()); 1970b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 19857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 19957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose CallEventRef<> Call = CEMgr.getCaller(calleeCtx, CEEState); 20057c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 20157c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose ExplodedNodeSet DstPostCall; 20257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getCheckerManager().runCheckersForPostCall(DstPostCall, CEENode, *Call, 20357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose *this, true); 20457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 20557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose ExplodedNodeSet Dst; 20657c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose if (isa<ObjCMethodCall>(Call)) { 20757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getCheckerManager().runCheckersForPostObjCMessage(Dst, DstPostCall, 20857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose cast<ObjCMethodCall>(*Call), 20957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose *this, true); 21057c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } else if (CE) { 21157c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getCheckerManager().runCheckersForPostStmt(Dst, DstPostCall, CE, 21257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose *this, true); 21357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } else { 21457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose Dst.insert(DstPostCall); 21557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } 2160b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2170b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Enqueue the next element in the block. 2180b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator PSI = Dst.begin(), PSE = Dst.end(); 2190b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks PSI != PSE; ++PSI) { 2200b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Engine.getWorkList()->enqueue(*PSI, calleeCtx->getCallSiteBlock(), 2210b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks calleeCtx->getIndex()+1); 2220b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 223242384ddb0e0b65dd7e9e0ac0cf3c31cf98b06a6Ted Kremenek } 224294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 225294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 2260849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenekstatic unsigned getNumberStackFrames(const LocationContext *LCtx) { 2270849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek unsigned count = 0; 2280849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek while (LCtx) { 2290849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek if (isa<StackFrameContext>(LCtx)) 2300849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek ++count; 2310849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek LCtx = LCtx->getParent(); 2320849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek } 2330849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek return count; 2340849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek} 2350849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek 2366cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks// Determine if we should inline the call. 2377fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenekbool ExprEngine::shouldInlineDecl(const Decl *D, ExplodedNode *Pred) { 2387fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 2396cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 2406cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 24101561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // It is possible that the CFG cannot be constructed. 24201561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // Be safe, and check if the CalleeCFG is valid. 24301561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek if (!CalleeCFG) 24401561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek return false; 24501561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek 2466cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks if (getNumberStackFrames(Pred->getLocationContext()) 2476cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks == AMgr.InlineMaxStackDepth) 2486cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 2496cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 2507fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (Engine.FunctionSummaries->hasReachedMaxBlockCount(D)) 2513bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks return false; 2523bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks 2536cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks if (CalleeCFG->getNumBlockIDs() > AMgr.InlineMaxFunctionSize) 2546cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 2556cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 25610f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek // Do not inline variadic calls (for now). 25710f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) { 25810f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (BD->isVariadic()) 25910f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return false; 26010f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek } 26110f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { 26210f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (FD->isVariadic()) 26310f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return false; 2645903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks } 2655903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 266d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek // It is possible that the live variables analysis cannot be 267d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek // run. If so, bail out. 268d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek if (!CalleeADC->getAnalysis<RelaxedLiveVariables>()) 269d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek return false; 270d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek 27110f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return true; 2725903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks} 2735903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 274e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksbool ExprEngine::inlineCall(const CallEvent &Call, 275256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNode *Pred) { 27610f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (!getAnalysisManager().shouldInlineCall()) 2775903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return false; 2785903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 2799dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks const Decl *D = Call.getRuntimeDefinition(); 2809dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks if (!D) 281ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose return false; 282ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 283c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const LocationContext *CurLC = Pred->getLocationContext(); 284c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const StackFrameContext *CallerSFC = CurLC->getCurrentStackFrame(); 2857fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const LocationContext *ParentOfCallee = 0; 28669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 28769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose switch (Call.getKind()) { 28869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_Function: 28969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_CXXMember: 290e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose case CE_CXXMemberOperator: 29169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // These are always at least possible to inline. 29269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose break; 29370cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXConstructor: 294da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose case CE_CXXDestructor: { 295da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose // Only inline constructors and destructors if we built the CFGs for them 296da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose // properly. 297da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 298da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose if (!ADC->getCFGBuildOptions().AddImplicitDtors || 299da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose !ADC->getCFGBuildOptions().AddInitializers) 300da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose return false; 3013a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose 302e460c46c5d602f65354cab0879c458890273591cJordan Rose // FIXME: We don't handle constructors or destructors for arrays properly. 303e460c46c5d602f65354cab0879c458890273591cJordan Rose const MemRegion *Target = Call.getCXXThisVal().getAsRegion(); 304e460c46c5d602f65354cab0879c458890273591cJordan Rose if (Target && isa<ElementRegion>(Target)) 305e460c46c5d602f65354cab0879c458890273591cJordan Rose return false; 306e460c46c5d602f65354cab0879c458890273591cJordan Rose 3073a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose // FIXME: This is a hack. We don't handle temporary destructors 308888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // right now, so we shouldn't inline their constructors. 309888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (const CXXConstructorCall *Ctor = dyn_cast<CXXConstructorCall>(&Call)) { 310888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose const CXXConstructExpr *CtorExpr = Ctor->getOriginExpr(); 311888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (CtorExpr->getConstructionKind() == CXXConstructExpr::CK_Complete) 312e460c46c5d602f65354cab0879c458890273591cJordan Rose if (!Target || !isa<DeclRegion>(Target)) 313e460c46c5d602f65354cab0879c458890273591cJordan Rose return false; 314888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } 315da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose break; 316da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose } 31770cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXAllocator: 31870cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // Do not inline allocators until we model deallocators. 31970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // This is unfortunate, but basically necessary for smart pointers and such. 32070cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return false; 32169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_Block: { 32269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDataRegion *BR = cast<BlockCall>(Call).getBlockRegion(); 323ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose assert(BR && "If we have the block definition we should have its region"); 32469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose AnalysisDeclContext *BlockCtx = AMgr.getAnalysisDeclContext(D); 3257fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = BlockCtx->getBlockInvocationContext(CallerSFC, 32669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose cast<BlockDecl>(D), 3277fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek BR); 32869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose break; 32969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 33069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_ObjCMessage: 331e13056a8bb532ddfdc07952a13169aa422bacd3bAnna Zaks if (getAnalysisManager().IPAMode != DynamicDispatch) 332e13056a8bb532ddfdc07952a13169aa422bacd3bAnna Zaks return false; 3339dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks break; 334256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 335ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 336ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose if (!shouldInlineDecl(D, Pred)) 3377fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return false; 3387fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 3397fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (!ParentOfCallee) 3407fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = CallerSFC; 3417fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 342852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // This may be NULL, but that's fine. 34369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Expr *CallE = Call.getOriginExpr(); 34469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 3457fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // Construct a new stack frame for the callee. 3467fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 3477fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *CalleeSFC = 34869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose CalleeADC->getStackFrame(ParentOfCallee, CallE, 3497fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek currentBuilderContext->getBlock(), 3507fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek currentStmtIdx); 3517fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 352c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CallEnter Loc(CallE, CalleeSFC, CurLC); 353e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 354e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // Construct a new state which contains the mapping from actual to 355e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // formal arguments. 356e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose ProgramStateRef State = Pred->getState()->enterStackFrame(Call, CalleeSFC); 357e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 3587fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek bool isNew; 359e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose if (ExplodedNode *N = G.getNode(Loc, State, false, &isNew)) { 3607fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek N->addPredecessor(Pred, G); 3617fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (isNew) 3627fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek Engine.getWorkList()->enqueue(N); 3637fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek } 3647fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return true; 365256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 366256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 367e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksstatic ProgramStateRef getInlineFailedState(ProgramStateRef State, 36869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Stmt *CallE) { 369e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks void *ReplayState = State->get<ReplayWithoutInlining>(); 3705903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!ReplayState) 3715903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return 0; 37228038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 37328038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose assert(ReplayState == (const void*)CallE && "Backtracked to the wrong call."); 37428038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose (void)CallE; 37528038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 376e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->remove<ReplayWithoutInlining>(); 37710520d76044e8fff71d414f30c21b449fd104960Ted Kremenek} 37810520d76044e8fff71d414f30c21b449fd104960Ted Kremenek 379294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred, 380294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &dst) { 381294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Perform the previsit of the CallExpr. 382294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstPreVisit; 383294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, CE, *this); 384500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 385d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Get the call in its initial state. We use this as a template to perform 386d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // all the checks. 387d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 388d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<SimpleCall> CallTemplate 389d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose = CEMgr.getSimpleCall(CE, Pred->getState(), Pred->getLocationContext()); 39069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 39169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Evaluate the function call. We try each of the checkers 392294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // to see if the can evaluate the function call. 393294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstCallEvaluated; 39469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose for (ExplodedNodeSet::iterator I = dstPreVisit.begin(), E = dstPreVisit.end(); 39569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose I != E; ++I) { 396d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose evalCall(dstCallEvaluated, *I, *CallTemplate); 39769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 39869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 399294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Finally, perform the post-condition check of the CallExpr and store 400294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // the created nodes in 'Dst'. 40169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Note that if the call was inlined, dstCallEvaluated will be empty. 40269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // The post-CallExpr check will occur in processCallExit. 403294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPostStmt(dst, dstCallEvaluated, CE, 404294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek *this); 405294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 406294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 40769f87c956b3ac2b80124fd9604af012e1061473aJordan Rosevoid ExprEngine::evalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred, 40869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const SimpleCall &Call) { 409d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // WARNING: At this time, the state attached to 'Call' may be older than the 410d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // state in 'Pred'. This is a minor optimization since CheckerManager will 411d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // use an updated CallEvent instance when calling checkers, but if 'Call' is 412d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // ever used directly in this function all callers should be updated to pass 413d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // the most recent state. (It is probably not worth doing the work here since 414d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // for some callers this will not be necessary.) 415d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 41696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Run any pre-call checks using the generic call interface. 41796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstPreVisit; 41896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPreCall(dstPreVisit, Pred, Call, *this); 41996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 42096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Actually evaluate the function call. We try each of the checkers 42196479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // to see if the can evaluate the function call, and get a callback at 42296479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // defaultEvalCall if all of them fail. 42396479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstCallEvaluated; 42496479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForEvalCall(dstCallEvaluated, dstPreVisit, 42596479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 42696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 42796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Finally, run any post-call checks. 42896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPostCall(Dst, dstCallEvaluated, 42996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 43069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 43169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 432e81ce256b62717dd846bd19aecc4115a0dcd4995Anna ZaksProgramStateRef ExprEngine::bindReturnValue(const CallEvent &Call, 433e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const LocationContext *LCtx, 434e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks ProgramStateRef State) { 435e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const Expr *E = Call.getOriginExpr(); 436e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (!E) 437e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State; 438e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 439e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Some method families have known return values. 440e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(&Call)) { 441e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks switch (Msg->getMethodFamily()) { 442e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks default: 443e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks break; 444e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_autorelease: 445e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_retain: 446e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_self: { 447e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // These methods return their receivers. 448e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, Msg->getReceiverSVal()); 449e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 450e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 451e460c46c5d602f65354cab0879c458890273591cJordan Rose } else if (const CXXConstructorCall *C = dyn_cast<CXXConstructorCall>(&Call)){ 452e460c46c5d602f65354cab0879c458890273591cJordan Rose return State->BindExpr(E, LCtx, C->getCXXThisVal()); 453e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 454e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 455e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Conjure a symbol if the return value is unknown. 456e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks QualType ResultTy = Call.getResultType(); 457e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks SValBuilder &SVB = getSValBuilder(); 458e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks unsigned Count = currentBuilderContext->getCurrentBlockCount(); 459e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks SVal R = SVB.getConjuredSymbolVal(0, E, LCtx, ResultTy, Count); 460e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, R); 461e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks} 462e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 463e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksvoid ExprEngine::defaultEvalCall(NodeBuilder &Bldr, ExplodedNode *Pred, 464d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const CallEvent &CallTemplate) { 465d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Make sure we have the most recent state attached to the call. 466d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef State = Pred->getState(); 467d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<> Call = CallTemplate.cloneWithState(State); 468e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 46969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Try to inline the call. 47028038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // The origin expression here is just used as a kind of checksum; 471d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // this should still be safe even for CallEvents that don't come from exprs. 472d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const Expr *E = Call->getOriginExpr(); 473d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef InlinedFailedState = getInlineFailedState(State, E); 474d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 475d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose if (InlinedFailedState) { 476d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // If we already tried once and failed, make sure we don't retry later. 477d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose State = InlinedFailedState; 478d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } else if (inlineCall(*Call, Pred)) { 479d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // If we decided to inline the call, the successor has been manually 480d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // added onto the work list and we should not perform our generic 481d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // call-handling steps. 4829dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks Bldr.takeNodes(Pred); 4839dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks return; 484e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 48569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 48669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // If we can't inline it, handle the return value and invalidate the regions. 48769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose unsigned Count = currentBuilderContext->getCurrentBlockCount(); 488d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose State = Call->invalidateRegions(Count, State); 489d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose State = bindReturnValue(*Call, Pred->getLocationContext(), State); 49069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 49169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // And make the result node. 492d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose Bldr.generateNode(Call->getProgramPoint(), State, Pred); 49369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 49469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 495294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitReturnStmt(const ReturnStmt *RS, ExplodedNode *Pred, 496294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &Dst) { 497256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 498256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNodeSet dstPreVisit; 499256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, RS, *this); 500256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 501256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek StmtNodeBuilder B(dstPreVisit, Dst, *currentBuilderContext); 502256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 503256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (RS->getRetValue()) { 504256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek for (ExplodedNodeSet::iterator it = dstPreVisit.begin(), 505256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ei = dstPreVisit.end(); it != ei; ++it) { 506256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek B.generateNode(RS, *it, (*it)->getState()); 507294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 508294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 509294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 510