ExprEngineCallAndReturn.cpp revision 48314cf6a289bc5a082d8c769c58a38f924c93b7
1294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//=-- ExprEngineCallAndReturn.cpp - Support for call/return -----*- C++ -*-===// 2294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// 3294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// The LLVM Compiler Infrastructure 4294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// 5294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// This file is distributed under the University of Illinois Open Source 6294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// License. See LICENSE.TXT for details. 7294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// 8294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//===----------------------------------------------------------------------===// 9294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// 10294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// This file defines ExprEngine's support for calls and returns. 11294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// 12294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//===----------------------------------------------------------------------===// 13294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 14e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks#define DEBUG_TYPE "ExprEngine" 15e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 16d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek#include "clang/Analysis/Analyses/LiveVariables.h" 17294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/StaticAnalyzer/Core/CheckerManager.h" 18294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h" 19f540c54701e3eeb34cb619a3a4eb18f1ac70ef2dJordan Rose#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h" 2048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose#include "clang/AST/CXXInheritance.h" 21294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/AST/DeclCXX.h" 226fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose#include "clang/AST/ParentMap.h" 234a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/ADT/SmallSet.h" 24e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks#include "llvm/ADT/Statistic.h" 254a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/Support/SaveAndRestore.h" 26294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 27294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekusing namespace clang; 28294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekusing namespace ento; 29294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 30e90d3f847dcce76237078b67db8895eb7a24189eAnna ZaksSTATISTIC(NumOfDynamicDispatchPathSplits, 31e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks "The # of times we split the path due to imprecise dynamic dispatch info"); 32e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 33210f5a28227c90d739298e3e6729e827858fe397Anna ZaksSTATISTIC(NumInlinedCalls, 34210f5a28227c90d739298e3e6729e827858fe397Anna Zaks "The # of times we inlined a call"); 35210f5a28227c90d739298e3e6729e827858fe397Anna Zaks 363070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenekvoid ExprEngine::processCallEnter(CallEnter CE, ExplodedNode *Pred) { 373070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Get the entry block in the CFG of the callee. 380849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek const StackFrameContext *calleeCtx = CE.getCalleeContext(); 390849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek const CFG *CalleeCFG = calleeCtx->getCFG(); 403070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek const CFGBlock *Entry = &(CalleeCFG->getEntry()); 413070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 423070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Validate the CFG. 433070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek assert(Entry->empty()); 443070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek assert(Entry->succ_size() == 1); 453070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 463070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Get the solitary sucessor. 473070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek const CFGBlock *Succ = *(Entry->succ_begin()); 483070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 493070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Construct an edge representing the starting location in the callee. 500849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek BlockEdge Loc(Entry, Succ, calleeCtx); 513070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 52e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose ProgramStateRef state = Pred->getState(); 533070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 543070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Construct a new node and add it to the worklist. 553070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek bool isNew; 563070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek ExplodedNode *Node = G.getNode(Loc, state, false, &isNew); 573070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek Node->addPredecessor(Pred, G); 583070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek if (isNew) 593070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek Engine.getWorkList()->enqueue(Node); 60294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 61294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 620b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// Find the last statement on the path to the exploded node and the 630b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// corresponding Block. 640b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksstatic std::pair<const Stmt*, 650b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock*> getLastStmt(const ExplodedNode *Node) { 660b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const Stmt *S = 0; 670b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *SF = 680b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Node->getLocation().getLocationContext()->getCurrentStackFrame(); 69888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 70632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // Back up through the ExplodedGraph until we reach a statement node in this 71632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // stack frame. 72256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek while (Node) { 73256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const ProgramPoint &PP = Node->getLocation(); 74888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 75632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose if (PP.getLocationContext()->getCurrentStackFrame() == SF) { 76632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose if (const StmtPoint *SP = dyn_cast<StmtPoint>(&PP)) { 77632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose S = SP->getStmt(); 78888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 79632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose } else if (const CallExitEnd *CEE = dyn_cast<CallExitEnd>(&PP)) { 80632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose S = CEE->getCalleeContext()->getCallSite(); 81632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose if (S) 82632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose break; 83632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose 84632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // If there is no statement, this is an implicitly-generated call. 85632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // We'll walk backwards over it and then continue the loop to find 86632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // an actual statement. 87632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose const CallEnter *CE; 88632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose do { 89632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose Node = Node->getFirstPred(); 90632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose CE = Node->getLocationAs<CallEnter>(); 91632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose } while (!CE || CE->getCalleeContext() != CEE->getCalleeContext()); 92632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose 93632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // Continue searching the graph. 94632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose } 95888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } else if (const CallEnter *CE = dyn_cast<CallEnter>(&PP)) { 96888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // If we reached the CallEnter for this function, it has no statements. 97888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (CE->getCalleeContext() == SF) 98888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 99256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 100888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 101888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose Node = *Node->pred_begin(); 102256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 103888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 104888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose const CFGBlock *Blk = 0; 105888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (S) { 106888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // Now, get the enclosing basic block. 107888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose while (Node && Node->pred_size() >=1 ) { 108888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose const ProgramPoint &PP = Node->getLocation(); 109888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (isa<BlockEdge>(PP) && 110888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose (PP.getLocationContext()->getCurrentStackFrame() == SF)) { 111888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose BlockEdge &EPP = cast<BlockEdge>(PP); 112888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose Blk = EPP.getDst(); 113888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 114888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } 115888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose Node = *Node->pred_begin(); 116888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } 117888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } 118888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 1190b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return std::pair<const Stmt*, const CFGBlock*>(S, Blk); 120256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 121256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 12248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// Adjusts a return value when the called function's return type does not 12348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// match the caller's expression type. This can happen when a dynamic call 12448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// is devirtualized, and the overridding method has a covariant (more specific) 12548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// return type than the parent's method. For C++ objects, this means we need 12648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// to add base casts. 12748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rosestatic SVal adjustReturnValue(SVal V, QualType ExpectedTy, QualType ActualTy, 12848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose StoreManager &StoreMgr) { 12948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // For now, the only adjustments we handle apply only to locations. 13048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (!isa<Loc>(V)) 13148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 13248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 13348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // If the types already match, don't do any unnecessary work. 13448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedTy == ActualTy) 13548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 13648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 13748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // No adjustment is needed between Objective-C pointer types. 13848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedTy->isObjCObjectPointerType() && 13948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose ActualTy->isObjCObjectPointerType()) 14048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 14148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 14248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // C++ object pointers may need "derived-to-base" casts. 14348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose const CXXRecordDecl *ExpectedClass = ExpectedTy->getPointeeCXXRecordDecl(); 14448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose const CXXRecordDecl *ActualClass = ActualTy->getPointeeCXXRecordDecl(); 14548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedClass && ActualClass) { 14648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CXXBasePaths Paths(/*FindAmbiguities=*/true, /*RecordPaths=*/true, 14748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose /*DetectVirtual=*/false); 14848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ActualClass->isDerivedFrom(ExpectedClass, Paths) && 14948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose !Paths.isAmbiguous(ActualTy->getCanonicalTypeUnqualified())) { 15048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return StoreMgr.evalDerivedToBase(V, Paths.front()); 15148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 15248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 15348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 15448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Unfortunately, Objective-C does not enforce that overridden methods have 15548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // covariant return types, so we can't assert that that never happens. 15648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Be safe and return UnknownVal(). 15748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return UnknownVal(); 15848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose} 15948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 1600b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// The call exit is simulated with a sequence of nodes, which occur between 1610b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// CallExitBegin and CallExitEnd. The following operations occur between the 1620b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// two program points: 1630b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 1. CallExitBegin (triggers the start of call exit sequence) 1640b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 2. Bind the return value 1650b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 3. Run Remove dead bindings to clean up the dead symbols from the callee. 1660b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 4. CallExitEnd (switch to the caller context) 1670b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 5. PostStmt<CallExpr> 1680b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksvoid ExprEngine::processCallExit(ExplodedNode *CEBNode) { 1690b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 1 CEBNode was generated before the call. 1700b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1710b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *calleeCtx = 1720b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEBNode->getLocationContext()->getCurrentStackFrame(); 1737fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 1747fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // The parent context might not be a stack frame, so make sure we 1757fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // look up the first enclosing stack frame. 1767fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *callerCtx = 1777fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek calleeCtx->getParent()->getCurrentStackFrame(); 1787fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 179294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek const Stmt *CE = calleeCtx->getCallSite(); 1800b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramStateRef state = CEBNode->getState(); 1810b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Find the last statement in the function and the corresponding basic block. 1820b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const Stmt *LastSt = 0; 1830b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock *Blk = 0; 1840b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks llvm::tie(LastSt, Blk) = getLastStmt(CEBNode); 1850b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 18648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Generate a CallEvent /before/ cleaning the state, so that we can get the 18748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // correct value for 'this' (if necessary). 18848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 18948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CallEventRef<> Call = CEMgr.getCaller(calleeCtx, state); 19048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 191852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Step 2: generate node with bound return value: CEBNode -> BindedRetNode. 1920b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 193294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // If the callee returns an expression, bind its value to CallExpr. 194852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (CE) { 195852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const ReturnStmt *RS = dyn_cast_or_null<ReturnStmt>(LastSt)) { 196852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose const LocationContext *LCtx = CEBNode->getLocationContext(); 197852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal V = state->getSVal(RS, LCtx); 19848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 19948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose const Decl *Callee = calleeCtx->getDecl(); 20048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (Callee != Call->getDecl()) { 20148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose QualType ReturnedTy = CallEvent::getDeclaredResultType(Callee); 20248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (!ReturnedTy.isNull()) { 20348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (const Expr *Ex = dyn_cast<Expr>(CE)) { 20448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose V = adjustReturnValue(V, Ex->getType(), ReturnedTy, 20548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose getStoreManager()); 20648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 20748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 20848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 20948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 21057c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose state = state->BindExpr(CE, callerCtx, V); 211852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 2120b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 213852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Bind the constructed object value to CXXConstructExpr. 214852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(CE)) { 215852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose loc::MemRegionVal This = 216852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose svalBuilder.getCXXThis(CCE->getConstructor()->getParent(), calleeCtx); 217852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal ThisV = state->getSVal(This); 2180b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2190504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose // If the constructed object is a prvalue, get its bindings. 2200504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose // Note that we have to be careful here because constructors embedded 2210504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose // in DeclStmts are not marked as lvalues. 2220504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose if (!CCE->isGLValue()) 2230504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose if (const MemRegion *MR = ThisV.getAsRegion()) 2240504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose if (isa<CXXTempObjectRegion>(MR)) 2250504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose ThisV = state->getSVal(cast<Loc>(ThisV)); 2260504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose 22757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose state = state->BindExpr(CCE, callerCtx, ThisV); 228852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 229294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 2300b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2310b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 3: BindedRetNode -> CleanedNodes 2320b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // If we can find a statement and a block in the inlined function, run remove 2330b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // dead bindings before returning from the call. This is important to ensure 2340b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // that we report the issues such as leaks in the stack contexts in which 2350b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // they occurred. 2360b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNodeSet CleanedNodes; 237255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (LastSt && Blk && AMgr.options.AnalysisPurgeOpt != PurgeNone) { 23848b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose static SimpleProgramPointTag retValBind("ExprEngine : Bind Return Value"); 23948b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose PostStmt Loc(LastSt, calleeCtx, &retValBind); 24048b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose bool isNew; 24148b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *BindedRetNode = G.getNode(Loc, state, false, &isNew); 24248b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose BindedRetNode->addPredecessor(CEBNode, G); 24348b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose if (!isNew) 24448b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose return; 24548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose 2460b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(getCoreEngine(), Blk, BindedRetNode); 24766c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx = &Ctx; 2480b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Here, we call the Symbol Reaper with 0 statement and caller location 2490b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // context, telling it to clean up everything in the callee's context 2500b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // (and it's children). We use LastStmt as a diagnostic statement, which 2510b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // which the PreStmtPurge Dead point will be associated. 2520b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks removeDead(BindedRetNode, CleanedNodes, 0, callerCtx, LastSt, 2530b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramPoint::PostStmtPurgeDeadSymbolsKind); 25466c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx = 0; 255144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks } else { 256144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks CleanedNodes.Add(CEBNode); 2570b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 2580b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2590b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator I = CleanedNodes.begin(), 2600b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks E = CleanedNodes.end(); I != E; ++I) { 2610b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2620b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 4: Generate the CallExit and leave the callee's context. 2630b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CleanedNodes -> CEENode 264852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose CallExitEnd Loc(calleeCtx, callerCtx); 2650b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks bool isNew; 26648b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ProgramStateRef CEEState = (*I == CEBNode) ? state : (*I)->getState(); 26748b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *CEENode = G.getNode(Loc, CEEState, false, &isNew); 2680b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEENode->addPredecessor(*I, G); 2690b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (!isNew) 2700b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return; 2710b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2720b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 5: Perform the post-condition check of the CallExpr and enqueue the 2730b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // result onto the work list. 2740b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CEENode -> Dst -> WorkList 2750b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(Engine, calleeCtx->getCallSiteBlock(), CEENode); 27666c486f275531df6362b3511fc3af6563561801bTed Kremenek SaveAndRestore<const NodeBuilderContext*> NBCSave(currBldrCtx, 2770b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks &Ctx); 27866c486f275531df6362b3511fc3af6563561801bTed Kremenek SaveAndRestore<unsigned> CBISave(currStmtIdx, calleeCtx->getIndex()); 2790b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2804e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose CallEventRef<> UpdatedCall = Call.cloneWithState(CEEState); 28157c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 28257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose ExplodedNodeSet DstPostCall; 2834e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose getCheckerManager().runCheckersForPostCall(DstPostCall, CEENode, 2844e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *UpdatedCall, *this, 2854e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose /*WasInlined=*/true); 28657c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 28757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose ExplodedNodeSet Dst; 2884e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(Call)) { 2894e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose getCheckerManager().runCheckersForPostObjCMessage(Dst, DstPostCall, *Msg, 2904e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *this, 2914e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose /*WasInlined=*/true); 29257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } else if (CE) { 29357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getCheckerManager().runCheckersForPostStmt(Dst, DstPostCall, CE, 2944e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *this, /*WasInlined=*/true); 29557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } else { 29657c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose Dst.insert(DstPostCall); 29757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } 2980b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2990b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Enqueue the next element in the block. 3000b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator PSI = Dst.begin(), PSE = Dst.end(); 3010b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks PSI != PSE; ++PSI) { 3020b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Engine.getWorkList()->enqueue(*PSI, calleeCtx->getCallSiteBlock(), 3030b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks calleeCtx->getIndex()+1); 3040b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 305242384ddb0e0b65dd7e9e0ac0cf3c31cf98b06a6Ted Kremenek } 306294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 307294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 3084ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaksvoid ExprEngine::examineStackFrames(const Decl *D, const LocationContext *LCtx, 3097229d0011766c174beffe6a846d78f448f845b39Anna Zaks bool &IsRecursive, unsigned &StackDepth) { 3107229d0011766c174beffe6a846d78f448f845b39Anna Zaks IsRecursive = false; 3117229d0011766c174beffe6a846d78f448f845b39Anna Zaks StackDepth = 0; 3124ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3130849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek while (LCtx) { 3147229d0011766c174beffe6a846d78f448f845b39Anna Zaks if (const StackFrameContext *SFC = dyn_cast<StackFrameContext>(LCtx)) { 3154ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks const Decl *DI = SFC->getDecl(); 3164ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3174ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // Mark recursive (and mutually recursive) functions and always count 3184ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // them when measuring the stack depth. 3194ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks if (DI == D) { 3207229d0011766c174beffe6a846d78f448f845b39Anna Zaks IsRecursive = true; 3214ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks ++StackDepth; 3224ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks LCtx = LCtx->getParent(); 3234ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks continue; 3244ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks } 3254ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3264ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // Do not count the small functions when determining the stack depth. 3274ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(DI); 3284ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 3294ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks if (CalleeCFG->getNumBlockIDs() > AMgr.options.getAlwaysInlineSize()) 3304ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks ++StackDepth; 3317229d0011766c174beffe6a846d78f448f845b39Anna Zaks } 3320849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek LCtx = LCtx->getParent(); 3330849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek } 3344ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3350849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek} 3360849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek 33781fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rosestatic bool IsInStdNamespace(const FunctionDecl *FD) { 33881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose const DeclContext *DC = FD->getEnclosingNamespaceContext(); 33981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose const NamespaceDecl *ND = dyn_cast<NamespaceDecl>(DC); 34081fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!ND) 34181fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return false; 34281fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 34381fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose while (const DeclContext *Parent = ND->getParent()) { 34481fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!isa<NamespaceDecl>(Parent)) 34581fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose break; 34681fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose ND = cast<NamespaceDecl>(Parent); 34781fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose } 34881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 34981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return ND->getName() == "std"; 35081fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose} 35181fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 3526cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks// Determine if we should inline the call. 3537fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenekbool ExprEngine::shouldInlineDecl(const Decl *D, ExplodedNode *Pred) { 3547fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 3556cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 3566cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 35701561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // It is possible that the CFG cannot be constructed. 35801561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // Be safe, and check if the CalleeCFG is valid. 35901561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek if (!CalleeCFG) 36001561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek return false; 36101561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek 3627229d0011766c174beffe6a846d78f448f845b39Anna Zaks bool IsRecursive = false; 3637229d0011766c174beffe6a846d78f448f845b39Anna Zaks unsigned StackDepth = 0; 3647229d0011766c174beffe6a846d78f448f845b39Anna Zaks examineStackFrames(D, Pred->getLocationContext(), IsRecursive, StackDepth); 3657229d0011766c174beffe6a846d78f448f845b39Anna Zaks if ((StackDepth >= AMgr.options.InlineMaxStackDepth) && 3667229d0011766c174beffe6a846d78f448f845b39Anna Zaks ((CalleeCFG->getNumBlockIDs() > AMgr.options.getAlwaysInlineSize()) 3677229d0011766c174beffe6a846d78f448f845b39Anna Zaks || IsRecursive)) 3686cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 3696cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 3707fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (Engine.FunctionSummaries->hasReachedMaxBlockCount(D)) 3713bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks return false; 3723bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks 373255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (CalleeCFG->getNumBlockIDs() > AMgr.options.InlineMaxFunctionSize) 3746cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 3756cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 37610f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek // Do not inline variadic calls (for now). 37710f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) { 37810f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (BD->isVariadic()) 37910f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return false; 38010f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek } 38110f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { 38210f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (FD->isVariadic()) 38310f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return false; 3845903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks } 3855903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 38681fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (getContext().getLangOpts().CPlusPlus) { 38781fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { 38881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose // Conditionally allow the inlining of template functions. 38981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!getAnalysisManager().options.mayInlineTemplateFunctions()) 39081fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (FD->getTemplatedKind() != FunctionDecl::TK_NonTemplate) 39181fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return false; 39281fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 39381fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose // Conditionally allow the inlining of C++ standard library functions. 39481fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!getAnalysisManager().options.mayInlineCXXStandardLibrary()) 39581fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (getContext().getSourceManager().isInSystemHeader(FD->getLocation())) 39681fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (IsInStdNamespace(FD)) 39781fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return false; 39881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose } 39981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose } 40081fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 401d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek // It is possible that the live variables analysis cannot be 402d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek // run. If so, bail out. 403d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek if (!CalleeADC->getAnalysis<RelaxedLiveVariables>()) 404d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek return false; 405d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek 40610f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return true; 4075903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks} 4085903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 409e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks/// The GDM component containing the dynamic dispatch bifurcation info. When 410e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks/// the exact type of the receiver is not known, we want to explore both paths - 411e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks/// one on which we do inline it and the other one on which we don't. This is 412e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks/// done to ensure we do not drop coverage. 413e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks/// This is the map from the receiver region to a bool, specifying either we 414e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks/// consider this region's information precise or not along the given path. 415e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksnamespace clang { 416e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksnamespace ento { 4176960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaksenum DynamicDispatchMode { DynamicDispatchModeInlined = 1, 4186960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks DynamicDispatchModeConservative }; 4196960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks 420e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksstruct DynamicDispatchBifurcationMap {}; 421e90d3f847dcce76237078b67db8895eb7a24189eAnna Zakstypedef llvm::ImmutableMap<const MemRegion*, 4226960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks unsigned int> DynamicDispatchBifur; 423e90d3f847dcce76237078b67db8895eb7a24189eAnna Zakstemplate<> struct ProgramStateTrait<DynamicDispatchBifurcationMap> 424e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks : public ProgramStatePartialTrait<DynamicDispatchBifur> { 425e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks static void *GDMIndex() { static int index; return &index; } 426e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks}; 4276960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks 428e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks}} 429e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 430e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksbool ExprEngine::inlineCall(const CallEvent &Call, const Decl *D, 431e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NodeBuilder &Bldr, ExplodedNode *Pred, 432e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef State) { 433e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks assert(D); 434ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 435c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const LocationContext *CurLC = Pred->getLocationContext(); 436c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const StackFrameContext *CallerSFC = CurLC->getCurrentStackFrame(); 4377fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const LocationContext *ParentOfCallee = 0; 43869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 439622b6fb0a1d280c16e135c7e427b79cafffbde1fTed Kremenek AnalyzerOptions &Opts = getAnalysisManager().options; 440de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose 441ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose // FIXME: Refactor this check into a hypothetical CallEvent::canInline. 44269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose switch (Call.getKind()) { 44369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_Function: 4442f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose break; 44569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_CXXMember: 446e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose case CE_CXXMemberOperator: 447de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose if (!Opts.mayInlineCXXMemberFunction(CIMK_MemberFunctions)) 4482f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose return false; 44969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose break; 450ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose case CE_CXXConstructor: { 451de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose if (!Opts.mayInlineCXXMemberFunction(CIMK_Constructors)) 4522f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose return false; 4532f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose 454ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const CXXConstructorCall &Ctor = cast<CXXConstructorCall>(Call); 455ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 456e460c46c5d602f65354cab0879c458890273591cJordan Rose // FIXME: We don't handle constructors or destructors for arrays properly. 457ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const MemRegion *Target = Ctor.getCXXThisVal().getAsRegion(); 458e460c46c5d602f65354cab0879c458890273591cJordan Rose if (Target && isa<ElementRegion>(Target)) 459e460c46c5d602f65354cab0879c458890273591cJordan Rose return false; 460e460c46c5d602f65354cab0879c458890273591cJordan Rose 4616fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose // FIXME: This is a hack. We don't use the correct region for a new 4626fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose // expression, so if we inline the constructor its result will just be 4636fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose // thrown away. This short-term hack is tracked in <rdar://problem/12180598> 4646fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose // and the longer-term possible fix is discussed in PR12014. 4656fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose const CXXConstructExpr *CtorExpr = Ctor.getOriginExpr(); 4666fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose if (const Stmt *Parent = CurLC->getParentMap().getParent(CtorExpr)) 4676fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose if (isa<CXXNewExpr>(Parent)) 4686fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose return false; 4696fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose 470de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose // Inlining constructors requires including initializers in the CFG. 471de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 472de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose assert(ADC->getCFGBuildOptions().AddInitializers && "No CFG initializers"); 4739eb214a691663a04ee61197e7d605128c85e09f7Jordan Rose (void)ADC; 474de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose 475c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose // If the destructor is trivial, it's always safe to inline the constructor. 476c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose if (Ctor.getDecl()->getParent()->hasTrivialDestructor()) 477c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose break; 478c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose 479de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose // For other types, only inline constructors if destructor inlining is 480de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose // also enabled. 481de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose if (!Opts.mayInlineCXXMemberFunction(CIMK_Destructors)) 482c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose return false; 483c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose 4843a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose // FIXME: This is a hack. We don't handle temporary destructors 485888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // right now, so we shouldn't inline their constructors. 486ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose if (CtorExpr->getConstructionKind() == CXXConstructExpr::CK_Complete) 487ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose if (!Target || !isa<DeclRegion>(Target)) 488ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose return false; 489ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 490ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose break; 491ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose } 492ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose case CE_CXXDestructor: { 493de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose if (!Opts.mayInlineCXXMemberFunction(CIMK_Destructors)) 4942f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose return false; 4952f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose 496de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose // Inlining destructors requires building the CFG correctly. 497ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 498de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose assert(ADC->getCFGBuildOptions().AddImplicitDtors && "No CFG destructors"); 4999eb214a691663a04ee61197e7d605128c85e09f7Jordan Rose (void)ADC; 500ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 501ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const CXXDestructorCall &Dtor = cast<CXXDestructorCall>(Call); 502ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 503ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose // FIXME: We don't handle constructors or destructors for arrays properly. 504ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const MemRegion *Target = Dtor.getCXXThisVal().getAsRegion(); 505ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose if (Target && isa<ElementRegion>(Target)) 506ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose return false; 507ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 508da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose break; 509da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose } 51070cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXAllocator: 51170cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // Do not inline allocators until we model deallocators. 51270cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // This is unfortunate, but basically necessary for smart pointers and such. 51370cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return false; 51469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_Block: { 51569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDataRegion *BR = cast<BlockCall>(Call).getBlockRegion(); 516ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose assert(BR && "If we have the block definition we should have its region"); 51769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose AnalysisDeclContext *BlockCtx = AMgr.getAnalysisDeclContext(D); 5187fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = BlockCtx->getBlockInvocationContext(CallerSFC, 51969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose cast<BlockDecl>(D), 5207fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek BR); 52169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose break; 52269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 52369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_ObjCMessage: 52457330eed3fbe530cb05996e4a346cc5fc217c0d9Anna Zaks if (!Opts.mayInlineObjCMethod()) 52557330eed3fbe530cb05996e4a346cc5fc217c0d9Anna Zaks return false; 526255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (!(getAnalysisManager().options.IPAMode == DynamicDispatch || 527255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek getAnalysisManager().options.IPAMode == DynamicDispatchBifurcate)) 528e13056a8bb532ddfdc07952a13169aa422bacd3bAnna Zaks return false; 5299dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks break; 530256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 531ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 532ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose if (!shouldInlineDecl(D, Pred)) 5337fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return false; 5347fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 5357fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (!ParentOfCallee) 5367fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = CallerSFC; 5377fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 538852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // This may be NULL, but that's fine. 53969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Expr *CallE = Call.getOriginExpr(); 54069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 5417fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // Construct a new stack frame for the callee. 5427fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 5437fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *CalleeSFC = 54469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose CalleeADC->getStackFrame(ParentOfCallee, CallE, 54566c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx->getBlock(), 54666c486f275531df6362b3511fc3af6563561801bTed Kremenek currStmtIdx); 5477fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 548c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CallEnter Loc(CallE, CalleeSFC, CurLC); 549e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 550e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // Construct a new state which contains the mapping from actual to 551e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // formal arguments. 552e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks State = State->enterStackFrame(Call, CalleeSFC); 553e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 5547fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek bool isNew; 555e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose if (ExplodedNode *N = G.getNode(Loc, State, false, &isNew)) { 5567fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek N->addPredecessor(Pred, G); 5577fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (isNew) 5587fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek Engine.getWorkList()->enqueue(N); 5597fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek } 560e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 561e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // If we decided to inline the call, the successor has been manually 562e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // added onto the work list so remove it from the node builder. 563e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks Bldr.takeNodes(Pred); 564e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 565210f5a28227c90d739298e3e6729e827858fe397Anna Zaks NumInlinedCalls++; 566210f5a28227c90d739298e3e6729e827858fe397Anna Zaks 567fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks // Mark the decl as visited. 568fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks if (VisitedCallees) 569fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks VisitedCallees->insert(D); 570fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks 5717fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return true; 572256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 573256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 574e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksstatic ProgramStateRef getInlineFailedState(ProgramStateRef State, 57569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Stmt *CallE) { 576e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks void *ReplayState = State->get<ReplayWithoutInlining>(); 5775903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!ReplayState) 5785903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return 0; 57928038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 58028038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose assert(ReplayState == (const void*)CallE && "Backtracked to the wrong call."); 58128038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose (void)CallE; 58228038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 583e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->remove<ReplayWithoutInlining>(); 58410520d76044e8fff71d414f30c21b449fd104960Ted Kremenek} 58510520d76044e8fff71d414f30c21b449fd104960Ted Kremenek 586294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred, 587294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &dst) { 588294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Perform the previsit of the CallExpr. 589294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstPreVisit; 590294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, CE, *this); 591500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 592d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Get the call in its initial state. We use this as a template to perform 593d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // all the checks. 594d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 595645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CallEventRef<> CallTemplate 596d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose = CEMgr.getSimpleCall(CE, Pred->getState(), Pred->getLocationContext()); 59769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 59869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Evaluate the function call. We try each of the checkers 599294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // to see if the can evaluate the function call. 600294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstCallEvaluated; 60169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose for (ExplodedNodeSet::iterator I = dstPreVisit.begin(), E = dstPreVisit.end(); 60269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose I != E; ++I) { 603d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose evalCall(dstCallEvaluated, *I, *CallTemplate); 60469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 60569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 606294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Finally, perform the post-condition check of the CallExpr and store 607294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // the created nodes in 'Dst'. 60869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Note that if the call was inlined, dstCallEvaluated will be empty. 60969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // The post-CallExpr check will occur in processCallExit. 610294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPostStmt(dst, dstCallEvaluated, CE, 611294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek *this); 612294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 613294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 61469f87c956b3ac2b80124fd9604af012e1061473aJordan Rosevoid ExprEngine::evalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred, 615645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const CallEvent &Call) { 616d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // WARNING: At this time, the state attached to 'Call' may be older than the 617d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // state in 'Pred'. This is a minor optimization since CheckerManager will 618d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // use an updated CallEvent instance when calling checkers, but if 'Call' is 619d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // ever used directly in this function all callers should be updated to pass 620d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // the most recent state. (It is probably not worth doing the work here since 621d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // for some callers this will not be necessary.) 622d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 62396479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Run any pre-call checks using the generic call interface. 62496479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstPreVisit; 62596479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPreCall(dstPreVisit, Pred, Call, *this); 62696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 62796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Actually evaluate the function call. We try each of the checkers 62896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // to see if the can evaluate the function call, and get a callback at 62996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // defaultEvalCall if all of them fail. 63096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstCallEvaluated; 63196479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForEvalCall(dstCallEvaluated, dstPreVisit, 63296479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 63396479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 63496479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Finally, run any post-call checks. 63596479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPostCall(Dst, dstCallEvaluated, 63696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 63769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 63869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 639e81ce256b62717dd846bd19aecc4115a0dcd4995Anna ZaksProgramStateRef ExprEngine::bindReturnValue(const CallEvent &Call, 640e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const LocationContext *LCtx, 641e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks ProgramStateRef State) { 642e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const Expr *E = Call.getOriginExpr(); 643e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (!E) 644e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State; 645e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 646e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Some method families have known return values. 647e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(&Call)) { 648e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks switch (Msg->getMethodFamily()) { 649e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks default: 650e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks break; 651e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_autorelease: 652e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_retain: 653e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_self: { 654e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // These methods return their receivers. 655e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, Msg->getReceiverSVal()); 656e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 657e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 658e460c46c5d602f65354cab0879c458890273591cJordan Rose } else if (const CXXConstructorCall *C = dyn_cast<CXXConstructorCall>(&Call)){ 659e460c46c5d602f65354cab0879c458890273591cJordan Rose return State->BindExpr(E, LCtx, C->getCXXThisVal()); 660e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 661e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 662e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Conjure a symbol if the return value is unknown. 663e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks QualType ResultTy = Call.getResultType(); 664e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks SValBuilder &SVB = getSValBuilder(); 66566c486f275531df6362b3511fc3af6563561801bTed Kremenek unsigned Count = currBldrCtx->blockCount(); 6663b1df8bb941a18c4a7256d7cfcbccb9de7e39995Ted Kremenek SVal R = SVB.conjureSymbolVal(0, E, LCtx, ResultTy, Count); 667e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, R); 668e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks} 669e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 670e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks// Conservatively evaluate call by invalidating regions and binding 671e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks// a conjured return value. 672e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksvoid ExprEngine::conservativeEvalCall(const CallEvent &Call, NodeBuilder &Bldr, 673e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ExplodedNode *Pred, ProgramStateRef State) { 67466c486f275531df6362b3511fc3af6563561801bTed Kremenek State = Call.invalidateRegions(currBldrCtx->blockCount(), State); 675e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks State = bindReturnValue(Call, Pred->getLocationContext(), State); 676e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 677e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // And make the result node. 678e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks Bldr.generateNode(Call.getProgramPoint(), State, Pred); 679e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks} 680e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 681e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksvoid ExprEngine::defaultEvalCall(NodeBuilder &Bldr, ExplodedNode *Pred, 682d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const CallEvent &CallTemplate) { 683d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Make sure we have the most recent state attached to the call. 684d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef State = Pred->getState(); 685d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<> Call = CallTemplate.cloneWithState(State); 686e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 6875960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (!getAnalysisManager().shouldInlineCall()) { 6885960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks conservativeEvalCall(*Call, Bldr, Pred, State); 6895960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 6905960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks } 69169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Try to inline the call. 69228038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // The origin expression here is just used as a kind of checksum; 693d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // this should still be safe even for CallEvents that don't come from exprs. 694d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const Expr *E = Call->getOriginExpr(); 695d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef InlinedFailedState = getInlineFailedState(State, E); 696d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 697d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose if (InlinedFailedState) { 698d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // If we already tried once and failed, make sure we don't retry later. 699d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose State = InlinedFailedState; 7005960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks } else { 701ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek RuntimeDefinition RD = Call->getRuntimeDefinition(); 702fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks const Decl *D = RD.getDecl(); 703e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks if (D) { 704b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose if (RD.mayHaveOtherDefinitions()) { 705b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose // Explore with and without inlining the call. 706255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (getAnalysisManager().options.IPAMode == DynamicDispatchBifurcate) { 707b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose BifurcateCall(RD.getDispatchRegion(), *Call, D, Bldr, Pred); 708b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose return; 709b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose } 710b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose 711b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose // Don't inline if we're not in any dynamic dispatch mode. 712255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (getAnalysisManager().options.IPAMode != DynamicDispatch) { 713da29ac527063fc9714547088bf841bfa30557bf0Jordan Rose conservativeEvalCall(*Call, Bldr, Pred, State); 714b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose return; 715da29ac527063fc9714547088bf841bfa30557bf0Jordan Rose } 716e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 717b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose 7185960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // We are not bifurcating and we do have a Decl, so just inline. 7195960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (inlineCall(*Call, D, Bldr, Pred, State)) 7205960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 721e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 722e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 72369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 72469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // If we can't inline it, handle the return value and invalidate the regions. 725e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks conservativeEvalCall(*Call, Bldr, Pred, State); 726e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks} 72769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 728e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksvoid ExprEngine::BifurcateCall(const MemRegion *BifurReg, 729e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks const CallEvent &Call, const Decl *D, 730e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NodeBuilder &Bldr, ExplodedNode *Pred) { 731e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks assert(BifurReg); 732b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose BifurReg = BifurReg->StripCasts(); 733e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 734e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // Check if we've performed the split already - note, we only want 735e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // to split the path once per memory region. 736e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef State = Pred->getState(); 7376960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks const unsigned int *BState = 7386960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->get<DynamicDispatchBifurcationMap>(BifurReg); 7395960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (BState) { 7405960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // If we are on "inline path", keep inlining if possible. 7416960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks if (*BState == DynamicDispatchModeInlined) 7425960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (inlineCall(Call, D, Bldr, Pred, State)) 7435960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 7445960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // If inline failed, or we are on the path where we assume we 7455960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // don't have enough info about the receiver to inline, conjure the 7465960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // return value and invalidate the regions. 7475960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks conservativeEvalCall(Call, Bldr, Pred, State); 7485960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 749e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 750e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 751e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // If we got here, this is the first time we process a message to this 752e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // region, so split the path. 753e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef IState = 7546960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->set<DynamicDispatchBifurcationMap>(BifurReg, 7556960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks DynamicDispatchModeInlined); 756e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks inlineCall(Call, D, Bldr, Pred, IState); 757e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 758e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef NoIState = 7596960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->set<DynamicDispatchBifurcationMap>(BifurReg, 7606960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks DynamicDispatchModeConservative); 761e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks conservativeEvalCall(Call, Bldr, Pred, NoIState); 762e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 763e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NumOfDynamicDispatchPathSplits++; 764e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks return; 76569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 76669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 767e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 768294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitReturnStmt(const ReturnStmt *RS, ExplodedNode *Pred, 769294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &Dst) { 770256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 771256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNodeSet dstPreVisit; 772256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, RS, *this); 773256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 77466c486f275531df6362b3511fc3af6563561801bTed Kremenek StmtNodeBuilder B(dstPreVisit, Dst, *currBldrCtx); 775256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 776256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (RS->getRetValue()) { 777256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek for (ExplodedNodeSet::iterator it = dstPreVisit.begin(), 778256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ei = dstPreVisit.end(); it != ei; ++it) { 779256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek B.generateNode(RS, *it, (*it)->getState()); 780294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 781294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 782294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 783