ExprEngineCallAndReturn.cpp revision 0b3ade86a1c60cf0c7b56aa238aff458eb7f5974
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 14294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/StaticAnalyzer/Core/CheckerManager.h" 15294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h" 16e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose#include "clang/StaticAnalyzer/Core/PathSensitive/ObjCMessage.h" 17294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/AST/DeclCXX.h" 184a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/ADT/SmallSet.h" 194a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/Support/SaveAndRestore.h" 20294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 21294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekusing namespace clang; 22294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekusing namespace ento; 23294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 243070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenekvoid ExprEngine::processCallEnter(CallEnter CE, ExplodedNode *Pred) { 253070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Get the entry block in the CFG of the callee. 260849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek const StackFrameContext *calleeCtx = CE.getCalleeContext(); 270849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek const CFG *CalleeCFG = calleeCtx->getCFG(); 283070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek const CFGBlock *Entry = &(CalleeCFG->getEntry()); 293070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 303070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Validate the CFG. 313070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek assert(Entry->empty()); 323070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek assert(Entry->succ_size() == 1); 333070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 343070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Get the solitary sucessor. 353070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek const CFGBlock *Succ = *(Entry->succ_begin()); 363070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 373070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Construct an edge representing the starting location in the callee. 380849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek BlockEdge Loc(Entry, Succ, calleeCtx); 393070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 403070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Construct a new state which contains the mapping from actual to 413070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // formal arguments. 420849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek const LocationContext *callerCtx = Pred->getLocationContext(); 438bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = Pred->getState()->enterStackFrame(callerCtx, 440849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek calleeCtx); 453070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 463070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Construct a new node and add it to the worklist. 473070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek bool isNew; 483070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek ExplodedNode *Node = G.getNode(Loc, state, false, &isNew); 493070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek Node->addPredecessor(Pred, G); 503070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek if (isNew) 513070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek Engine.getWorkList()->enqueue(Node); 52294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 53294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 540b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// Find the last statement on the path to the exploded node and the 550b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// corresponding Block. 560b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksstatic std::pair<const Stmt*, 570b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock*> getLastStmt(const ExplodedNode *Node) { 580b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const Stmt *S = 0; 590b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock *Blk = 0; 600b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *SF = 610b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Node->getLocation().getLocationContext()->getCurrentStackFrame(); 62256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek while (Node) { 63256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const ProgramPoint &PP = Node->getLocation(); 640b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Skip any BlockEdges, empty blocks, and the CallExitBegin node. 650b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (isa<BlockEdge>(PP) || isa<CallExitBegin>(PP) || isa<BlockEntrance>(PP)){ 66256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek assert(Node->pred_size() == 1); 67256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek Node = *Node->pred_begin(); 68256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek continue; 690b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 700b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // If we reached the CallEnter, the function has no statements. 710b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (isa<CallEnter>(PP)) 720b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks break; 73256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (const StmtPoint *SP = dyn_cast<StmtPoint>(&PP)) { 740b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks S = SP->getStmt(); 750b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Now, get the enclosing basic block. 760b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks while (Node && Node->pred_size() >=1 ) { 770b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const ProgramPoint &PP = Node->getLocation(); 780b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (isa<BlockEdge>(PP) && 790b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks (PP.getLocationContext()->getCurrentStackFrame() == SF)) { 800b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks BlockEdge &EPP = cast<BlockEdge>(PP); 810b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Blk = EPP.getDst(); 820b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks break; 830b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 840b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Node = *Node->pred_begin(); 850b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 860b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks break; 87256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 88256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek break; 89256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 900b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return std::pair<const Stmt*, const CFGBlock*>(S, Blk); 91256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 92256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 930b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// The call exit is simulated with a sequence of nodes, which occur between 940b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// CallExitBegin and CallExitEnd. The following operations occur between the 950b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// two program points: 960b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 1. CallExitBegin (triggers the start of call exit sequence) 970b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 2. Bind the return value 980b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 3. Run Remove dead bindings to clean up the dead symbols from the callee. 990b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 4. CallExitEnd (switch to the caller context) 1000b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 5. PostStmt<CallExpr> 1010b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksvoid ExprEngine::processCallExit(ExplodedNode *CEBNode) { 1020b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 1 CEBNode was generated before the call. 1030b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1040b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *calleeCtx = 1050b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEBNode->getLocationContext()->getCurrentStackFrame(); 106256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const LocationContext *callerCtx = calleeCtx->getParent(); 107294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek const Stmt *CE = calleeCtx->getCallSite(); 1080b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramStateRef state = CEBNode->getState(); 1090b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Find the last statement in the function and the corresponding basic block. 1100b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const Stmt *LastSt = 0; 1110b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock *Blk = 0; 1120b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks llvm::tie(LastSt, Blk) = getLastStmt(CEBNode); 1130b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1140b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 2: generate node with binded return value: CEBNode -> BindedRetNode. 1150b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 116294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // If the callee returns an expression, bind its value to CallExpr. 1170b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (const ReturnStmt *RS = dyn_cast_or_null<ReturnStmt>(LastSt)) { 1180b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const LocationContext *LCtx = CEBNode->getLocationContext(); 119256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek SVal V = state->getSVal(RS, LCtx); 120256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek state = state->BindExpr(CE, callerCtx, V); 121294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 1220b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 123294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Bind the constructed object value to CXXConstructExpr. 124294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(CE)) { 125294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek const CXXThisRegion *ThisR = 1260b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks getCXXThisRegion(CCE->getConstructor()->getParent(), calleeCtx); 1270b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 128294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek SVal ThisV = state->getSVal(ThisR); 129294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Always bind the region to the CXXConstructExpr. 1300b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks state = state->BindExpr(CCE, CEBNode->getLocationContext(), ThisV); 131294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 1320b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1330b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks static SimpleProgramPointTag retValBindTag("ExprEngine : Bind Return Value"); 1340b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks PostStmt Loc(LastSt, calleeCtx, &retValBindTag); 135894212e9510299abb203801e014fec76b7926a05Ted Kremenek bool isNew; 1360b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNode *BindedRetNode = G.getNode(Loc, state, false, &isNew); 1370b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks BindedRetNode->addPredecessor(CEBNode, G); 138894212e9510299abb203801e014fec76b7926a05Ted Kremenek if (!isNew) 139894212e9510299abb203801e014fec76b7926a05Ted Kremenek return; 1400b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1410b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 3: BindedRetNode -> CleanedNodes 1420b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // If we can find a statement and a block in the inlined function, run remove 1430b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // dead bindings before returning from the call. This is important to ensure 1440b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // that we report the issues such as leaks in the stack contexts in which 1450b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // they occurred. 1460b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNodeSet CleanedNodes; 1470b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (LastSt && Blk) { 1480b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(getCoreEngine(), Blk, BindedRetNode); 1490b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks currentBuilderContext = &Ctx; 1500b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Here, we call the Symbol Reaper with 0 statement and caller location 1510b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // context, telling it to clean up everything in the callee's context 1520b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // (and it's children). We use LastStmt as a diagnostic statement, which 1530b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // which the PreStmtPurge Dead point will be associated. 1540b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks removeDead(BindedRetNode, CleanedNodes, 0, callerCtx, LastSt, 1550b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramPoint::PostStmtPurgeDeadSymbolsKind); 1560b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks currentBuilderContext = 0; 1570b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 1580b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1590b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator I = CleanedNodes.begin(), 1600b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks E = CleanedNodes.end(); I != E; ++I) { 1610b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1620b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 4: Generate the CallExit and leave the callee's context. 1630b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CleanedNodes -> CEENode 1640b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CallExitEnd Loc(CE, callerCtx); 1650b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks bool isNew; 1660b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNode *CEENode = G.getNode(Loc, (*I)->getState(), false, &isNew); 1670b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEENode->addPredecessor(*I, G); 1680b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (!isNew) 1690b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return; 1700b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1710b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 5: Perform the post-condition check of the CallExpr and enqueue the 1720b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // result onto the work list. 1730b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CEENode -> Dst -> WorkList 1740b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNodeSet Dst; 1750b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(Engine, calleeCtx->getCallSiteBlock(), CEENode); 1760b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks SaveAndRestore<const NodeBuilderContext*> NBCSave(currentBuilderContext, 1770b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks &Ctx); 1780b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks SaveAndRestore<unsigned> CBISave(currentStmtIdx, calleeCtx->getIndex()); 1790b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1800b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks getCheckerManager().runCheckersForPostStmt(Dst, CEENode, CE, *this, true); 1810b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1820b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Enqueue the next element in the block. 1830b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator PSI = Dst.begin(), PSE = Dst.end(); 1840b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks PSI != PSE; ++PSI) { 1850b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Engine.getWorkList()->enqueue(*PSI, calleeCtx->getCallSiteBlock(), 1860b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks calleeCtx->getIndex()+1); 1870b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 188242384ddb0e0b65dd7e9e0ac0cf3c31cf98b06a6Ted Kremenek } 189294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 190294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 1910849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenekstatic unsigned getNumberStackFrames(const LocationContext *LCtx) { 1920849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek unsigned count = 0; 1930849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek while (LCtx) { 1940849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek if (isa<StackFrameContext>(LCtx)) 1950849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek ++count; 1960849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek LCtx = LCtx->getParent(); 1970849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek } 1980849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek return count; 1990849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek} 2000849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek 2016cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks// Determine if we should inline the call. 2025903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaksbool ExprEngine::shouldInlineDecl(const FunctionDecl *FD, ExplodedNode *Pred) { 2036cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(FD); 2046cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 2056cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 20601561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // It is possible that the CFG cannot be constructed. 20701561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // Be safe, and check if the CalleeCFG is valid. 20801561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek if (!CalleeCFG) 20901561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek return false; 21001561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek 2116cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks if (getNumberStackFrames(Pred->getLocationContext()) 2126cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks == AMgr.InlineMaxStackDepth) 2136cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 2146cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 215e62f048960645b79363408fdead53fec2a063c52Anna Zaks if (Engine.FunctionSummaries->hasReachedMaxBlockCount(FD)) 2163bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks return false; 2173bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks 2186cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks if (CalleeCFG->getNumBlockIDs() > AMgr.InlineMaxFunctionSize) 2196cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 2206cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 2216cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return true; 2226cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks} 2236cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 2245903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks// For now, skip inlining variadic functions. 2255903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks// We also don't inline blocks. 2265903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaksstatic bool shouldInlineCallExpr(const CallExpr *CE, ExprEngine *E) { 2275903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!E->getAnalysisManager().shouldInlineCall()) 2285903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return false; 2295903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks QualType callee = CE->getCallee()->getType(); 2305903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks const FunctionProtoType *FT = 0; 2315903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (const PointerType *PT = callee->getAs<PointerType>()) 2325903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks FT = dyn_cast<FunctionProtoType>(PT->getPointeeType()); 2335903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks else if (const BlockPointerType *BT = callee->getAs<BlockPointerType>()) { 2345903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks // FIXME: inline blocks. 2355903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks // FT = dyn_cast<FunctionProtoType>(BT->getPointeeType()); 2365903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks (void) BT; 2375903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return false; 2385903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks } 2395903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks // If we have no prototype, assume the function is okay. 2405903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!FT) 2415903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return true; 2425903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 2435903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks // Skip inlining of variadic functions. 2445903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return !FT->isVariadic(); 2455903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks} 2465903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 247256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenekbool ExprEngine::InlineCall(ExplodedNodeSet &Dst, 248256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const CallExpr *CE, 249256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNode *Pred) { 2505903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!shouldInlineCallExpr(CE, this)) 2515903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return false; 2525903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 2538bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = Pred->getState(); 254256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const Expr *Callee = CE->getCallee(); 255256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const FunctionDecl *FD = 2566cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks state->getSVal(Callee, Pred->getLocationContext()).getAsFunctionDecl(); 257256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (!FD || !FD->hasBody(FD)) 258256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek return false; 259256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 260256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek switch (CE->getStmtClass()) { 261256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek default: 262256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek // FIXME: Handle C++. 263256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek break; 264256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek case Stmt::CallExprClass: { 2655903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!shouldInlineDecl(FD, Pred)) 2668235f9c9c8b3d1737d1c6bd57f7ba3f616b92392Anna Zaks return false; 2678235f9c9c8b3d1737d1c6bd57f7ba3f616b92392Anna Zaks 2688235f9c9c8b3d1737d1c6bd57f7ba3f616b92392Anna Zaks // Construct a new stack frame for the callee. 2696cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(FD); 270256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const StackFrameContext *CallerSFC = 271256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek Pred->getLocationContext()->getCurrentStackFrame(); 272256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const StackFrameContext *CalleeSFC = 273256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek CalleeADC->getStackFrame(CallerSFC, CE, 274256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek currentBuilderContext->getBlock(), 275256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek currentStmtIdx); 276256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 277256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek CallEnter Loc(CE, CalleeSFC, Pred->getLocationContext()); 278256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek bool isNew; 279d9b795524eb3dc035523f82f135d0a8adf15cd72Ted Kremenek if (ExplodedNode *N = G.getNode(Loc, state, false, &isNew)) { 280d9b795524eb3dc035523f82f135d0a8adf15cd72Ted Kremenek N->addPredecessor(Pred, G); 281d9b795524eb3dc035523f82f135d0a8adf15cd72Ted Kremenek if (isNew) 282d9b795524eb3dc035523f82f135d0a8adf15cd72Ted Kremenek Engine.getWorkList()->enqueue(N); 283d9b795524eb3dc035523f82f135d0a8adf15cd72Ted Kremenek } 284256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek return true; 285256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 286256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 287256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek return false; 288256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 289256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 2902cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaksstatic bool isPointerToConst(const ParmVarDecl *ParamDecl) { 2912cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks QualType PointeeTy = ParamDecl->getOriginalType()->getPointeeType(); 2922cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks if (PointeeTy != QualType() && PointeeTy.isConstQualified() && 2932cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks !PointeeTy->isAnyPointerType() && !PointeeTy->isReferenceType()) { 2942cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks return true; 2952cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks } 2962cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks return false; 2972cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks} 2982cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks 2992cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks// Try to retrieve the function declaration and find the function parameter 3002cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks// types which are pointers/references to a non-pointer const. 3012cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks// We do not invalidate the corresponding argument regions. 3022cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaksstatic void findPtrToConstParams(llvm::SmallSet<unsigned, 1> &PreserveArgs, 3032cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks const CallOrObjCMessage &Call) { 3042cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks const Decl *CallDecl = Call.getDecl(); 3052cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks if (!CallDecl) 3062cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks return; 3072cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks 3082cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks if (const FunctionDecl *FDecl = dyn_cast<FunctionDecl>(CallDecl)) { 3090d389b819c33bdf0375694a8f141c8f02e002b18Anna Zaks const IdentifierInfo *II = FDecl->getIdentifier(); 3100d389b819c33bdf0375694a8f141c8f02e002b18Anna Zaks 3110d389b819c33bdf0375694a8f141c8f02e002b18Anna Zaks // List the cases, where the region should be invalidated even if the 3120d389b819c33bdf0375694a8f141c8f02e002b18Anna Zaks // argument is const. 3130d389b819c33bdf0375694a8f141c8f02e002b18Anna Zaks if (II) { 3140d389b819c33bdf0375694a8f141c8f02e002b18Anna Zaks StringRef FName = II->getName(); 31507d39a479cf8f20294407e749f9933da34ebecb7Anna Zaks // - 'int pthread_setspecific(ptheread_key k, const void *)' stores a 31607d39a479cf8f20294407e749f9933da34ebecb7Anna Zaks // value into thread local storage. The value can later be retrieved with 3170d389b819c33bdf0375694a8f141c8f02e002b18Anna Zaks // 'void *ptheread_getspecific(pthread_key)'. So even thought the 3180d389b819c33bdf0375694a8f141c8f02e002b18Anna Zaks // parameter is 'const void *', the region escapes through the call. 319ca23eb212c78ac5bc62d0881635579dbe7095639Anna Zaks // - funopen - sets a buffer for future IO calls. 32007d39a479cf8f20294407e749f9933da34ebecb7Anna Zaks // - ObjC functions that end with "NoCopy" can free memory, of the passed 32107d39a479cf8f20294407e749f9933da34ebecb7Anna Zaks // in buffer. 322ca23eb212c78ac5bc62d0881635579dbe7095639Anna Zaks // - Many CF containers allow objects to escape through custom 323ca23eb212c78ac5bc62d0881635579dbe7095639Anna Zaks // allocators/deallocators upon container construction. 32462a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks // - NSXXInsertXX, for example NSMapInsertIfAbsent, since they can 32562a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks // be deallocated by NSMapRemove. 32607d39a479cf8f20294407e749f9933da34ebecb7Anna Zaks if (FName == "pthread_setspecific" || 327ca23eb212c78ac5bc62d0881635579dbe7095639Anna Zaks FName == "funopen" || 328ca23eb212c78ac5bc62d0881635579dbe7095639Anna Zaks FName.endswith("NoCopy") || 32962a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks (FName.startswith("NS") && 33062a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks (FName.find("Insert") != StringRef::npos)) || 331ca23eb212c78ac5bc62d0881635579dbe7095639Anna Zaks Call.isCFCGAllowingEscape(FName)) 3320d389b819c33bdf0375694a8f141c8f02e002b18Anna Zaks return; 3330d389b819c33bdf0375694a8f141c8f02e002b18Anna Zaks } 3340d389b819c33bdf0375694a8f141c8f02e002b18Anna Zaks 3352cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks for (unsigned Idx = 0, E = Call.getNumArgs(); Idx != E; ++Idx) { 3362cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks if (FDecl && Idx < FDecl->getNumParams()) { 3372cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks if (isPointerToConst(FDecl->getParamDecl(Idx))) 3382cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks PreserveArgs.insert(Idx); 3392cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks } 3402cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks } 3412cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks return; 3422cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks } 3432cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks 3442cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks if (const ObjCMethodDecl *MDecl = dyn_cast<ObjCMethodDecl>(CallDecl)) { 3452cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks assert(MDecl->param_size() <= Call.getNumArgs()); 3462cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks unsigned Idx = 0; 3472cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks for (clang::ObjCMethodDecl::param_const_iterator 3482cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks I = MDecl->param_begin(), E = MDecl->param_end(); I != E; ++I, ++Idx) { 3492cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks if (isPointerToConst(*I)) 3502cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks PreserveArgs.insert(Idx); 3512cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks } 3522cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks return; 3532cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks } 3542cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks} 3552cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks 3568bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 3578bef8238181a30e52dea380789a7e2d760eac532Ted KremenekExprEngine::invalidateArguments(ProgramStateRef State, 358e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose const CallOrObjCMessage &Call, 359e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose const LocationContext *LC) { 360e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose SmallVector<const MemRegion *, 8> RegionsToInvalidate; 361e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 362e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (Call.isObjCMessage()) { 363e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // Invalidate all instance variables of the receiver of an ObjC message. 364e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // FIXME: We should be able to do better with inter-procedural analysis. 365e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (const MemRegion *MR = Call.getInstanceMessageReceiver(LC).getAsRegion()) 366e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose RegionsToInvalidate.push_back(MR); 367e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 368e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose } else if (Call.isCXXCall()) { 369e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // Invalidate all instance variables for the callee of a C++ method call. 370e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // FIXME: We should be able to do better with inter-procedural analysis. 371e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // FIXME: We can probably do better for const versus non-const methods. 372e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (const MemRegion *Callee = Call.getCXXCallee().getAsRegion()) 373e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose RegionsToInvalidate.push_back(Callee); 374e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 375e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose } else if (Call.isFunctionCall()) { 376e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // Block calls invalidate all captured-by-reference values. 3772cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks SVal CalleeVal = Call.getFunctionCallee(); 3782cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks if (const MemRegion *Callee = CalleeVal.getAsRegion()) { 379e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (isa<BlockDataRegion>(Callee)) 380e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose RegionsToInvalidate.push_back(Callee); 381e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose } 382e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose } 383e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 3842cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks // Indexes of arguments whose values will be preserved by the call. 3852cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks llvm::SmallSet<unsigned, 1> PreserveArgs; 3862cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks findPtrToConstParams(PreserveArgs, Call); 3872cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks 388e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose for (unsigned idx = 0, e = Call.getNumArgs(); idx != e; ++idx) { 3892cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks if (PreserveArgs.count(idx)) 3902cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks continue; 3912cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks 392e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose SVal V = Call.getArgSVal(idx); 393e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 394e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // If we are passing a location wrapped as an integer, unwrap it and 395e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // invalidate the values referred by the location. 396e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (nonloc::LocAsInteger *Wrapped = dyn_cast<nonloc::LocAsInteger>(&V)) 397e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose V = Wrapped->getLoc(); 398e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose else if (!isa<Loc>(V)) 399e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose continue; 400e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 401e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (const MemRegion *R = V.getAsRegion()) { 402e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // Invalidate the value of the variable passed by reference. 403e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 404e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // Are we dealing with an ElementRegion? If the element type is 4052cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks // a basic integer type (e.g., char, int) and the underlying region 406e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // is a variable region then strip off the ElementRegion. 407e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // FIXME: We really need to think about this for the general case 408e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // as sometimes we are reasoning about arrays and other times 409e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // about (char*), etc., is just a form of passing raw bytes. 410e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // e.g., void *p = alloca(); foo((char*)p); 411e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (const ElementRegion *ER = dyn_cast<ElementRegion>(R)) { 412e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // Checking for 'integral type' is probably too promiscuous, but 413e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // we'll leave it in for now until we have a systematic way of 414e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // handling all of these cases. Eventually we need to come up 415e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // with an interface to StoreManager so that this logic can be 4162cbe791d3e9b26f30196c4852da75d9ad67b4ad9Anna Zaks // appropriately delegated to the respective StoreManagers while 417e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // still allowing us to do checker-specific logic (e.g., 418e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // invalidating reference counts), probably via callbacks. 419e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (ER->getElementType()->isIntegralOrEnumerationType()) { 420e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose const MemRegion *superReg = ER->getSuperRegion(); 421e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (isa<VarRegion>(superReg) || isa<FieldRegion>(superReg) || 422e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose isa<ObjCIvarRegion>(superReg)) 423e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose R = cast<TypedRegion>(superReg); 424e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose } 425e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // FIXME: What about layers of ElementRegions? 426e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose } 427e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 428e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // Mark this region for invalidation. We batch invalidate regions 429e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // below for efficiency. 430e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose RegionsToInvalidate.push_back(R); 431e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose } else { 432e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // Nuke all other arguments passed by reference. 433e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // FIXME: is this necessary or correct? This handles the non-Region 434e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // cases. Is it ever valid to store to these? 435e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose State = State->unbindLoc(cast<Loc>(V)); 436e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose } 437e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose } 438e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 439e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // Invalidate designated regions using the batch invalidation API. 440e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 441e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // FIXME: We can have collisions on the conjured symbol if the 442e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // expression *I also creates conjured symbols. We probably want 443e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // to identify conjured symbols by an expression pair: the enclosing 444e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // expression (the context) and the expression itself. This should 445e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // disambiguate conjured symbols. 446ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks unsigned Count = currentBuilderContext->getCurrentBlockCount(); 447e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose StoreManager::InvalidatedSymbols IS; 448e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 449e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // NOTE: Even if RegionsToInvalidate is empty, we may still invalidate 450e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // global variables. 451e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose return State->invalidateRegions(RegionsToInvalidate, 4523133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek Call.getOriginExpr(), Count, LC, 453eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks &IS, &Call); 454e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 455e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose} 456e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 4575903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaksstatic ProgramStateRef getReplayWithoutInliningState(ExplodedNode *&N, 4585903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks const CallExpr *CE) { 4595903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks void *ReplayState = N->getState()->get<ReplayWithoutInlining>(); 4605903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!ReplayState) 4615903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return 0; 4625903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks const CallExpr *ReplayCE = reinterpret_cast<const CallExpr*>(ReplayState); 4635903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (CE == ReplayCE) { 4645903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return N->getState()->remove<ReplayWithoutInlining>(); 46510520d76044e8fff71d414f30c21b449fd104960Ted Kremenek } 4665903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return 0; 46710520d76044e8fff71d414f30c21b449fd104960Ted Kremenek} 46810520d76044e8fff71d414f30c21b449fd104960Ted Kremenek 469294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred, 470294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &dst) { 471294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Perform the previsit of the CallExpr. 472294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstPreVisit; 473294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, CE, *this); 474294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 475294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Now evaluate the call itself. 476294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek class DefaultEval : public GraphExpander { 477294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExprEngine &Eng; 478294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek const CallExpr *CE; 479294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek public: 480294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 481294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek DefaultEval(ExprEngine &eng, const CallExpr *ce) 482294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek : Eng(eng), CE(ce) {} 483294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek virtual void expandGraph(ExplodedNodeSet &Dst, ExplodedNode *Pred) { 4845903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 4855903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks ProgramStateRef state = getReplayWithoutInliningState(Pred, CE); 4865903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 4875903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks // First, try to inline the call. 4885903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (state == 0 && Eng.InlineCall(Dst, CE, Pred)) 489294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek return; 490500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 491500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose // First handle the return value. 492aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks StmtNodeBuilder Bldr(Pred, Dst, *Eng.currentBuilderContext); 493500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 494500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose // Get the callee. 495294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek const Expr *Callee = CE->getCallee()->IgnoreParens(); 4965903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (state == 0) 4975903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks state = Pred->getState(); 4985eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal L = state->getSVal(Callee, Pred->getLocationContext()); 499500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 500500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose // Figure out the result type. We do this dance to handle references. 501500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose QualType ResultTy; 502500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose if (const FunctionDecl *FD = L.getAsFunctionDecl()) 503500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose ResultTy = FD->getResultType(); 504500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose else 505500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose ResultTy = CE->getType(); 506500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 507500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose if (CE->isLValue()) 508500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose ResultTy = Eng.getContext().getPointerType(ResultTy); 509500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 510500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose // Conjure a symbol value to use as the result. 511500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose SValBuilder &SVB = Eng.getSValBuilder(); 512ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks unsigned Count = Eng.currentBuilderContext->getCurrentBlockCount(); 5133133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek const LocationContext *LCtx = Pred->getLocationContext(); 5143133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek SVal RetVal = SVB.getConjuredSymbolVal(0, CE, LCtx, ResultTy, Count); 515500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 516e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // Generate a new state with the return value set. 5175eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state = state->BindExpr(CE, LCtx, RetVal); 518e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose 519e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose // Invalidate the arguments. 5205eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state = Eng.invalidateArguments(state, CallOrObjCMessage(CE, state, LCtx), 5215eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek LCtx); 522500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 523fe27971d54d26997149d6b84057f04ff398d1d5dJordy Rose // And make the result node. 524ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks Bldr.generateNode(CE, Pred, state); 525294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 526294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek }; 527294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 528294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Finally, evaluate the function call. We try each of the checkers 529294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // to see if the can evaluate the function call. 530294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstCallEvaluated; 531294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek DefaultEval defEval(*this, CE); 532294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForEvalCall(dstCallEvaluated, 533294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek dstPreVisit, 534294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek CE, *this, &defEval); 535294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 536294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Finally, perform the post-condition check of the CallExpr and store 537294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // the created nodes in 'Dst'. 538294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPostStmt(dst, dstCallEvaluated, CE, 539294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek *this); 540294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 541294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 542294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitReturnStmt(const ReturnStmt *RS, ExplodedNode *Pred, 543294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &Dst) { 544256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 545256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNodeSet dstPreVisit; 546256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, RS, *this); 547256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 548256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek StmtNodeBuilder B(dstPreVisit, Dst, *currentBuilderContext); 549256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 550256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (RS->getRetValue()) { 551256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek for (ExplodedNodeSet::iterator it = dstPreVisit.begin(), 552256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ei = dstPreVisit.end(); it != ei; ++it) { 553256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek B.generateNode(RS, *it, (*it)->getState()); 554294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 555294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 556294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 557