ExprEngineCallAndReturn.cpp revision 8501b7a1c4c4a9ba0ea6cb8e500e601ef3759deb
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 1018501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks if (Node->pred_empty()) 1028501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks return std::pair<const Stmt*, const CFGBlock*>(0, 0); 1038501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 104888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose Node = *Node->pred_begin(); 105256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 106888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 107888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose const CFGBlock *Blk = 0; 108888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (S) { 109888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // Now, get the enclosing basic block. 1108501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks while (Node) { 111888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose const ProgramPoint &PP = Node->getLocation(); 112888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (isa<BlockEdge>(PP) && 113888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose (PP.getLocationContext()->getCurrentStackFrame() == SF)) { 114888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose BlockEdge &EPP = cast<BlockEdge>(PP); 115888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose Blk = EPP.getDst(); 116888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 117888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } 1188501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks if (Node->pred_empty()) 1198501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks return std::pair<const Stmt*, const CFGBlock*>(S, 0); 1208501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 121888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose Node = *Node->pred_begin(); 122888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } 123888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } 124888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 1250b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return std::pair<const Stmt*, const CFGBlock*>(S, Blk); 126256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 127256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 12848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// Adjusts a return value when the called function's return type does not 12948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// match the caller's expression type. This can happen when a dynamic call 13048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// is devirtualized, and the overridding method has a covariant (more specific) 13148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// return type than the parent's method. For C++ objects, this means we need 13248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// to add base casts. 13348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rosestatic SVal adjustReturnValue(SVal V, QualType ExpectedTy, QualType ActualTy, 13448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose StoreManager &StoreMgr) { 13548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // For now, the only adjustments we handle apply only to locations. 13648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (!isa<Loc>(V)) 13748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 13848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 13948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // If the types already match, don't do any unnecessary work. 14048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedTy == ActualTy) 14148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 14248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 14348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // No adjustment is needed between Objective-C pointer types. 14448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedTy->isObjCObjectPointerType() && 14548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose ActualTy->isObjCObjectPointerType()) 14648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 14748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 14848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // C++ object pointers may need "derived-to-base" casts. 14948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose const CXXRecordDecl *ExpectedClass = ExpectedTy->getPointeeCXXRecordDecl(); 15048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose const CXXRecordDecl *ActualClass = ActualTy->getPointeeCXXRecordDecl(); 15148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedClass && ActualClass) { 15248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CXXBasePaths Paths(/*FindAmbiguities=*/true, /*RecordPaths=*/true, 15348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose /*DetectVirtual=*/false); 15448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ActualClass->isDerivedFrom(ExpectedClass, Paths) && 15548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose !Paths.isAmbiguous(ActualTy->getCanonicalTypeUnqualified())) { 15648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return StoreMgr.evalDerivedToBase(V, Paths.front()); 15748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 15848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 15948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 16048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Unfortunately, Objective-C does not enforce that overridden methods have 16148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // covariant return types, so we can't assert that that never happens. 16248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Be safe and return UnknownVal(). 16348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return UnknownVal(); 16448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose} 16548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 1668501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaksvoid ExprEngine::removeDeadOnEndOfFunction(NodeBuilderContext& BC, 1678501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks ExplodedNode *Pred, 1688501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks ExplodedNodeSet &Dst) { 1698501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks NodeBuilder Bldr(Pred, Dst, BC); 1708501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 1718501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks // Find the last statement in the function and the corresponding basic block. 1728501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks const Stmt *LastSt = 0; 1738501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks const CFGBlock *Blk = 0; 1748501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks llvm::tie(LastSt, Blk) = getLastStmt(Pred); 1758501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks if (!Blk || !LastSt) { 1768501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks return; 1778501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks } 1788501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 1798501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks // If the last statement is return, everything it references should stay live. 1808501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks if (isa<ReturnStmt>(LastSt)) 1818501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks return; 1828501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 1838501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks // Here, we call the Symbol Reaper with 0 stack context telling it to clean up 1848501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks // everything on the stack. We use LastStmt as a diagnostic statement, with 1858501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks // which the PreStmtPurgeDead point will be associated. 1868501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks currBldrCtx = &BC; 1878501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks removeDead(Pred, Dst, 0, 0, LastSt, 1888501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks ProgramPoint::PostStmtPurgeDeadSymbolsKind); 1898501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks currBldrCtx = 0; 1908501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks} 1918501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 1920b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// The call exit is simulated with a sequence of nodes, which occur between 1930b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// CallExitBegin and CallExitEnd. The following operations occur between the 1940b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// two program points: 1950b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 1. CallExitBegin (triggers the start of call exit sequence) 1960b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 2. Bind the return value 1970b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 3. Run Remove dead bindings to clean up the dead symbols from the callee. 1980b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 4. CallExitEnd (switch to the caller context) 1990b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 5. PostStmt<CallExpr> 2000b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksvoid ExprEngine::processCallExit(ExplodedNode *CEBNode) { 2010b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 1 CEBNode was generated before the call. 2020b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2030b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *calleeCtx = 2040b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEBNode->getLocationContext()->getCurrentStackFrame(); 2057fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 2067fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // The parent context might not be a stack frame, so make sure we 2077fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // look up the first enclosing stack frame. 2087fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *callerCtx = 2097fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek calleeCtx->getParent()->getCurrentStackFrame(); 2107fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 211294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek const Stmt *CE = calleeCtx->getCallSite(); 2120b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramStateRef state = CEBNode->getState(); 2130b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Find the last statement in the function and the corresponding basic block. 2140b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const Stmt *LastSt = 0; 2150b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock *Blk = 0; 2160b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks llvm::tie(LastSt, Blk) = getLastStmt(CEBNode); 2170b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 21848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Generate a CallEvent /before/ cleaning the state, so that we can get the 21948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // correct value for 'this' (if necessary). 22048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 22148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CallEventRef<> Call = CEMgr.getCaller(calleeCtx, state); 22248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 223852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Step 2: generate node with bound return value: CEBNode -> BindedRetNode. 2240b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 225294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // If the callee returns an expression, bind its value to CallExpr. 226852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (CE) { 227852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const ReturnStmt *RS = dyn_cast_or_null<ReturnStmt>(LastSt)) { 228852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose const LocationContext *LCtx = CEBNode->getLocationContext(); 229852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal V = state->getSVal(RS, LCtx); 23048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 23148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose const Decl *Callee = calleeCtx->getDecl(); 23248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (Callee != Call->getDecl()) { 23348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose QualType ReturnedTy = CallEvent::getDeclaredResultType(Callee); 23448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (!ReturnedTy.isNull()) { 23548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (const Expr *Ex = dyn_cast<Expr>(CE)) { 23648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose V = adjustReturnValue(V, Ex->getType(), ReturnedTy, 23748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose getStoreManager()); 23848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 23948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 24048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 24148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 24257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose state = state->BindExpr(CE, callerCtx, V); 243852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 2440b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 245852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Bind the constructed object value to CXXConstructExpr. 246852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(CE)) { 247852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose loc::MemRegionVal This = 248852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose svalBuilder.getCXXThis(CCE->getConstructor()->getParent(), calleeCtx); 249852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal ThisV = state->getSVal(This); 2500b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2510504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose // If the constructed object is a prvalue, get its bindings. 2520504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose // Note that we have to be careful here because constructors embedded 2530504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose // in DeclStmts are not marked as lvalues. 2540504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose if (!CCE->isGLValue()) 2550504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose if (const MemRegion *MR = ThisV.getAsRegion()) 2560504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose if (isa<CXXTempObjectRegion>(MR)) 2570504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose ThisV = state->getSVal(cast<Loc>(ThisV)); 2580504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose 25957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose state = state->BindExpr(CCE, callerCtx, ThisV); 260852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 261294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 2620b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2630b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 3: BindedRetNode -> CleanedNodes 2640b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // If we can find a statement and a block in the inlined function, run remove 2650b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // dead bindings before returning from the call. This is important to ensure 2660b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // that we report the issues such as leaks in the stack contexts in which 2670b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // they occurred. 2680b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNodeSet CleanedNodes; 269255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (LastSt && Blk && AMgr.options.AnalysisPurgeOpt != PurgeNone) { 27048b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose static SimpleProgramPointTag retValBind("ExprEngine : Bind Return Value"); 27148b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose PostStmt Loc(LastSt, calleeCtx, &retValBind); 27248b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose bool isNew; 27348b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *BindedRetNode = G.getNode(Loc, state, false, &isNew); 27448b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose BindedRetNode->addPredecessor(CEBNode, G); 27548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose if (!isNew) 27648b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose return; 27748b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose 2780b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(getCoreEngine(), Blk, BindedRetNode); 27966c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx = &Ctx; 2800b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Here, we call the Symbol Reaper with 0 statement and caller location 2810b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // context, telling it to clean up everything in the callee's context 2820b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // (and it's children). We use LastStmt as a diagnostic statement, which 2830b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // which the PreStmtPurge Dead point will be associated. 2840b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks removeDead(BindedRetNode, CleanedNodes, 0, callerCtx, LastSt, 2850b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramPoint::PostStmtPurgeDeadSymbolsKind); 28666c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx = 0; 287144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks } else { 288144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks CleanedNodes.Add(CEBNode); 2890b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 2900b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2910b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator I = CleanedNodes.begin(), 2920b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks E = CleanedNodes.end(); I != E; ++I) { 2930b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2940b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 4: Generate the CallExit and leave the callee's context. 2950b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CleanedNodes -> CEENode 296852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose CallExitEnd Loc(calleeCtx, callerCtx); 2970b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks bool isNew; 29848b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ProgramStateRef CEEState = (*I == CEBNode) ? state : (*I)->getState(); 29948b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *CEENode = G.getNode(Loc, CEEState, false, &isNew); 3000b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEENode->addPredecessor(*I, G); 3010b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (!isNew) 3020b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return; 3030b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3040b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 5: Perform the post-condition check of the CallExpr and enqueue the 3050b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // result onto the work list. 3060b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CEENode -> Dst -> WorkList 3070b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(Engine, calleeCtx->getCallSiteBlock(), CEENode); 30866c486f275531df6362b3511fc3af6563561801bTed Kremenek SaveAndRestore<const NodeBuilderContext*> NBCSave(currBldrCtx, 3090b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks &Ctx); 31066c486f275531df6362b3511fc3af6563561801bTed Kremenek SaveAndRestore<unsigned> CBISave(currStmtIdx, calleeCtx->getIndex()); 3110b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3124e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose CallEventRef<> UpdatedCall = Call.cloneWithState(CEEState); 31357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 31457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose ExplodedNodeSet DstPostCall; 3154e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose getCheckerManager().runCheckersForPostCall(DstPostCall, CEENode, 3164e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *UpdatedCall, *this, 3174e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose /*WasInlined=*/true); 31857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 31957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose ExplodedNodeSet Dst; 3204e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(Call)) { 3214e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose getCheckerManager().runCheckersForPostObjCMessage(Dst, DstPostCall, *Msg, 3224e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *this, 3234e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose /*WasInlined=*/true); 32457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } else if (CE) { 32557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getCheckerManager().runCheckersForPostStmt(Dst, DstPostCall, CE, 3264e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *this, /*WasInlined=*/true); 32757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } else { 32857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose Dst.insert(DstPostCall); 32957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } 3300b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3310b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Enqueue the next element in the block. 3320b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator PSI = Dst.begin(), PSE = Dst.end(); 3330b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks PSI != PSE; ++PSI) { 3340b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Engine.getWorkList()->enqueue(*PSI, calleeCtx->getCallSiteBlock(), 3350b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks calleeCtx->getIndex()+1); 3360b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 337242384ddb0e0b65dd7e9e0ac0cf3c31cf98b06a6Ted Kremenek } 338294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 339294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 3404ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaksvoid ExprEngine::examineStackFrames(const Decl *D, const LocationContext *LCtx, 3417229d0011766c174beffe6a846d78f448f845b39Anna Zaks bool &IsRecursive, unsigned &StackDepth) { 3427229d0011766c174beffe6a846d78f448f845b39Anna Zaks IsRecursive = false; 3437229d0011766c174beffe6a846d78f448f845b39Anna Zaks StackDepth = 0; 3444ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3450849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek while (LCtx) { 3467229d0011766c174beffe6a846d78f448f845b39Anna Zaks if (const StackFrameContext *SFC = dyn_cast<StackFrameContext>(LCtx)) { 3474ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks const Decl *DI = SFC->getDecl(); 3484ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3494ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // Mark recursive (and mutually recursive) functions and always count 3504ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // them when measuring the stack depth. 3514ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks if (DI == D) { 3527229d0011766c174beffe6a846d78f448f845b39Anna Zaks IsRecursive = true; 3534ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks ++StackDepth; 3544ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks LCtx = LCtx->getParent(); 3554ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks continue; 3564ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks } 3574ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3584ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // Do not count the small functions when determining the stack depth. 3594ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(DI); 3604ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 3614ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks if (CalleeCFG->getNumBlockIDs() > AMgr.options.getAlwaysInlineSize()) 3624ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks ++StackDepth; 3637229d0011766c174beffe6a846d78f448f845b39Anna Zaks } 3640849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek LCtx = LCtx->getParent(); 3650849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek } 3664ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3670849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek} 3680849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek 36981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rosestatic bool IsInStdNamespace(const FunctionDecl *FD) { 37081fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose const DeclContext *DC = FD->getEnclosingNamespaceContext(); 37181fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose const NamespaceDecl *ND = dyn_cast<NamespaceDecl>(DC); 37281fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!ND) 37381fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return false; 37481fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 37581fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose while (const DeclContext *Parent = ND->getParent()) { 37681fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!isa<NamespaceDecl>(Parent)) 37781fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose break; 37881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose ND = cast<NamespaceDecl>(Parent); 37981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose } 38081fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 38181fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return ND->getName() == "std"; 38281fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose} 38381fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 3846cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks// Determine if we should inline the call. 3857fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenekbool ExprEngine::shouldInlineDecl(const Decl *D, ExplodedNode *Pred) { 3867fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 3876cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 3886cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 38901561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // It is possible that the CFG cannot be constructed. 39001561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // Be safe, and check if the CalleeCFG is valid. 39101561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek if (!CalleeCFG) 39201561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek return false; 39301561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek 3947229d0011766c174beffe6a846d78f448f845b39Anna Zaks bool IsRecursive = false; 3957229d0011766c174beffe6a846d78f448f845b39Anna Zaks unsigned StackDepth = 0; 3967229d0011766c174beffe6a846d78f448f845b39Anna Zaks examineStackFrames(D, Pred->getLocationContext(), IsRecursive, StackDepth); 3977229d0011766c174beffe6a846d78f448f845b39Anna Zaks if ((StackDepth >= AMgr.options.InlineMaxStackDepth) && 3987229d0011766c174beffe6a846d78f448f845b39Anna Zaks ((CalleeCFG->getNumBlockIDs() > AMgr.options.getAlwaysInlineSize()) 3997229d0011766c174beffe6a846d78f448f845b39Anna Zaks || IsRecursive)) 4006cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 4016cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 4027fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (Engine.FunctionSummaries->hasReachedMaxBlockCount(D)) 4033bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks return false; 4043bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks 405255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (CalleeCFG->getNumBlockIDs() > AMgr.options.InlineMaxFunctionSize) 4066cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 4076cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 40810f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek // Do not inline variadic calls (for now). 40910f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) { 41010f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (BD->isVariadic()) 41110f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return false; 41210f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek } 41310f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { 41410f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (FD->isVariadic()) 41510f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return false; 4165903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks } 4175903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 41881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (getContext().getLangOpts().CPlusPlus) { 41981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { 42081fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose // Conditionally allow the inlining of template functions. 42181fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!getAnalysisManager().options.mayInlineTemplateFunctions()) 42281fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (FD->getTemplatedKind() != FunctionDecl::TK_NonTemplate) 42381fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return false; 42481fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 42581fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose // Conditionally allow the inlining of C++ standard library functions. 42681fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!getAnalysisManager().options.mayInlineCXXStandardLibrary()) 42781fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (getContext().getSourceManager().isInSystemHeader(FD->getLocation())) 42881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (IsInStdNamespace(FD)) 42981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return false; 43081fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose } 43181fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose } 43281fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 433d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek // It is possible that the live variables analysis cannot be 434d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek // run. If so, bail out. 435d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek if (!CalleeADC->getAnalysis<RelaxedLiveVariables>()) 436d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek return false; 437d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek 43810f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return true; 4395903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks} 4405903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 441166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// The GDM component containing the dynamic dispatch bifurcation info. When 442166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// the exact type of the receiver is not known, we want to explore both paths - 443166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// one on which we do inline it and the other one on which we don't. This is 444166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// done to ensure we do not drop coverage. 445166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// This is the map from the receiver region to a bool, specifying either we 446166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// consider this region's information precise or not along the given path. 447166d502d5367ceacd1313a33cac43b1048b8524dJordan Rosenamespace { 448166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose enum DynamicDispatchMode { 449166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose DynamicDispatchModeInlined = 1, 450166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose DynamicDispatchModeConservative 451166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose }; 452166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose} 453166d502d5367ceacd1313a33cac43b1048b8524dJordan RoseREGISTER_MAP_WITH_PROGRAMSTATE(DynamicDispatchBifurcationMap, 454166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose const MemRegion *, unsigned) 455e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 456e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksbool ExprEngine::inlineCall(const CallEvent &Call, const Decl *D, 457e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NodeBuilder &Bldr, ExplodedNode *Pred, 458e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef State) { 459e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks assert(D); 460ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 461c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const LocationContext *CurLC = Pred->getLocationContext(); 462c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const StackFrameContext *CallerSFC = CurLC->getCurrentStackFrame(); 4637fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const LocationContext *ParentOfCallee = 0; 46469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 465622b6fb0a1d280c16e135c7e427b79cafffbde1fTed Kremenek AnalyzerOptions &Opts = getAnalysisManager().options; 466de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose 467ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose // FIXME: Refactor this check into a hypothetical CallEvent::canInline. 46869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose switch (Call.getKind()) { 46969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_Function: 4702f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose break; 47169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_CXXMember: 472e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose case CE_CXXMemberOperator: 473de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose if (!Opts.mayInlineCXXMemberFunction(CIMK_MemberFunctions)) 4742f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose return false; 47569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose break; 476ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose case CE_CXXConstructor: { 477de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose if (!Opts.mayInlineCXXMemberFunction(CIMK_Constructors)) 4782f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose return false; 4792f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose 480ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const CXXConstructorCall &Ctor = cast<CXXConstructorCall>(Call); 481ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 482e460c46c5d602f65354cab0879c458890273591cJordan Rose // FIXME: We don't handle constructors or destructors for arrays properly. 483ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const MemRegion *Target = Ctor.getCXXThisVal().getAsRegion(); 484e460c46c5d602f65354cab0879c458890273591cJordan Rose if (Target && isa<ElementRegion>(Target)) 485e460c46c5d602f65354cab0879c458890273591cJordan Rose return false; 486e460c46c5d602f65354cab0879c458890273591cJordan Rose 4876fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose // FIXME: This is a hack. We don't use the correct region for a new 4886fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose // expression, so if we inline the constructor its result will just be 4896fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose // thrown away. This short-term hack is tracked in <rdar://problem/12180598> 4906fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose // and the longer-term possible fix is discussed in PR12014. 4916fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose const CXXConstructExpr *CtorExpr = Ctor.getOriginExpr(); 4926fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose if (const Stmt *Parent = CurLC->getParentMap().getParent(CtorExpr)) 4936fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose if (isa<CXXNewExpr>(Parent)) 4946fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose return false; 4956fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose 496de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose // Inlining constructors requires including initializers in the CFG. 497de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 498de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose assert(ADC->getCFGBuildOptions().AddInitializers && "No CFG initializers"); 4999eb214a691663a04ee61197e7d605128c85e09f7Jordan Rose (void)ADC; 500de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose 501c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose // If the destructor is trivial, it's always safe to inline the constructor. 502c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose if (Ctor.getDecl()->getParent()->hasTrivialDestructor()) 503c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose break; 504c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose 505de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose // For other types, only inline constructors if destructor inlining is 506de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose // also enabled. 507de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose if (!Opts.mayInlineCXXMemberFunction(CIMK_Destructors)) 508c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose return false; 509c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose 5103a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose // FIXME: This is a hack. We don't handle temporary destructors 511888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // right now, so we shouldn't inline their constructors. 512ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose if (CtorExpr->getConstructionKind() == CXXConstructExpr::CK_Complete) 513ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose if (!Target || !isa<DeclRegion>(Target)) 514ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose return false; 515ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 516ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose break; 517ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose } 518ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose case CE_CXXDestructor: { 519de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose if (!Opts.mayInlineCXXMemberFunction(CIMK_Destructors)) 5202f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose return false; 5212f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose 522de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose // Inlining destructors requires building the CFG correctly. 523ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 524de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose assert(ADC->getCFGBuildOptions().AddImplicitDtors && "No CFG destructors"); 5259eb214a691663a04ee61197e7d605128c85e09f7Jordan Rose (void)ADC; 526ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 527ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const CXXDestructorCall &Dtor = cast<CXXDestructorCall>(Call); 528ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 529ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose // FIXME: We don't handle constructors or destructors for arrays properly. 530ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const MemRegion *Target = Dtor.getCXXThisVal().getAsRegion(); 531ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose if (Target && isa<ElementRegion>(Target)) 532ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose return false; 533ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 534da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose break; 535da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose } 53670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXAllocator: 53770cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // Do not inline allocators until we model deallocators. 53870cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // This is unfortunate, but basically necessary for smart pointers and such. 53970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return false; 54069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_Block: { 54169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDataRegion *BR = cast<BlockCall>(Call).getBlockRegion(); 542ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose assert(BR && "If we have the block definition we should have its region"); 54369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose AnalysisDeclContext *BlockCtx = AMgr.getAnalysisDeclContext(D); 5447fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = BlockCtx->getBlockInvocationContext(CallerSFC, 54569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose cast<BlockDecl>(D), 5467fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek BR); 54769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose break; 54869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 54969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_ObjCMessage: 55057330eed3fbe530cb05996e4a346cc5fc217c0d9Anna Zaks if (!Opts.mayInlineObjCMethod()) 55157330eed3fbe530cb05996e4a346cc5fc217c0d9Anna Zaks return false; 552255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (!(getAnalysisManager().options.IPAMode == DynamicDispatch || 553255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek getAnalysisManager().options.IPAMode == DynamicDispatchBifurcate)) 554e13056a8bb532ddfdc07952a13169aa422bacd3bAnna Zaks return false; 5559dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks break; 556256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 557ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 558ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose if (!shouldInlineDecl(D, Pred)) 5597fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return false; 5607fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 5617fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (!ParentOfCallee) 5627fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = CallerSFC; 5637fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 564852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // This may be NULL, but that's fine. 56569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Expr *CallE = Call.getOriginExpr(); 56669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 5677fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // Construct a new stack frame for the callee. 5687fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 5697fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *CalleeSFC = 57069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose CalleeADC->getStackFrame(ParentOfCallee, CallE, 57166c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx->getBlock(), 57266c486f275531df6362b3511fc3af6563561801bTed Kremenek currStmtIdx); 5737fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 574c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CallEnter Loc(CallE, CalleeSFC, CurLC); 575e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 576e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // Construct a new state which contains the mapping from actual to 577e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // formal arguments. 578e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks State = State->enterStackFrame(Call, CalleeSFC); 579e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 5807fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek bool isNew; 581e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose if (ExplodedNode *N = G.getNode(Loc, State, false, &isNew)) { 5827fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek N->addPredecessor(Pred, G); 5837fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (isNew) 5847fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek Engine.getWorkList()->enqueue(N); 5857fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek } 586e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 587e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // If we decided to inline the call, the successor has been manually 588e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // added onto the work list so remove it from the node builder. 589e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks Bldr.takeNodes(Pred); 590e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 591210f5a28227c90d739298e3e6729e827858fe397Anna Zaks NumInlinedCalls++; 592210f5a28227c90d739298e3e6729e827858fe397Anna Zaks 593fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks // Mark the decl as visited. 594fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks if (VisitedCallees) 595fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks VisitedCallees->insert(D); 596fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks 5977fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return true; 598256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 599256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 600e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksstatic ProgramStateRef getInlineFailedState(ProgramStateRef State, 60169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Stmt *CallE) { 602e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks void *ReplayState = State->get<ReplayWithoutInlining>(); 6035903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!ReplayState) 6045903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return 0; 60528038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 60628038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose assert(ReplayState == (const void*)CallE && "Backtracked to the wrong call."); 60728038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose (void)CallE; 60828038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 609e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->remove<ReplayWithoutInlining>(); 61010520d76044e8fff71d414f30c21b449fd104960Ted Kremenek} 61110520d76044e8fff71d414f30c21b449fd104960Ted Kremenek 612294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred, 613294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &dst) { 614294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Perform the previsit of the CallExpr. 615294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstPreVisit; 616294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, CE, *this); 617500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 618d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Get the call in its initial state. We use this as a template to perform 619d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // all the checks. 620d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 621645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CallEventRef<> CallTemplate 622d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose = CEMgr.getSimpleCall(CE, Pred->getState(), Pred->getLocationContext()); 62369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 62469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Evaluate the function call. We try each of the checkers 625294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // to see if the can evaluate the function call. 626294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstCallEvaluated; 62769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose for (ExplodedNodeSet::iterator I = dstPreVisit.begin(), E = dstPreVisit.end(); 62869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose I != E; ++I) { 629d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose evalCall(dstCallEvaluated, *I, *CallTemplate); 63069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 63169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 632294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Finally, perform the post-condition check of the CallExpr and store 633294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // the created nodes in 'Dst'. 63469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Note that if the call was inlined, dstCallEvaluated will be empty. 63569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // The post-CallExpr check will occur in processCallExit. 636294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPostStmt(dst, dstCallEvaluated, CE, 637294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek *this); 638294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 639294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 64069f87c956b3ac2b80124fd9604af012e1061473aJordan Rosevoid ExprEngine::evalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred, 641645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const CallEvent &Call) { 642d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // WARNING: At this time, the state attached to 'Call' may be older than the 643d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // state in 'Pred'. This is a minor optimization since CheckerManager will 644d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // use an updated CallEvent instance when calling checkers, but if 'Call' is 645d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // ever used directly in this function all callers should be updated to pass 646d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // the most recent state. (It is probably not worth doing the work here since 647d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // for some callers this will not be necessary.) 648d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 64996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Run any pre-call checks using the generic call interface. 65096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstPreVisit; 65196479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPreCall(dstPreVisit, Pred, Call, *this); 65296479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 65396479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Actually evaluate the function call. We try each of the checkers 65496479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // to see if the can evaluate the function call, and get a callback at 65596479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // defaultEvalCall if all of them fail. 65696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstCallEvaluated; 65796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForEvalCall(dstCallEvaluated, dstPreVisit, 65896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 65996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 66096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Finally, run any post-call checks. 66196479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPostCall(Dst, dstCallEvaluated, 66296479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 66369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 66469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 665e81ce256b62717dd846bd19aecc4115a0dcd4995Anna ZaksProgramStateRef ExprEngine::bindReturnValue(const CallEvent &Call, 666e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const LocationContext *LCtx, 667e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks ProgramStateRef State) { 668e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const Expr *E = Call.getOriginExpr(); 669e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (!E) 670e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State; 671e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 672e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Some method families have known return values. 673e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(&Call)) { 674e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks switch (Msg->getMethodFamily()) { 675e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks default: 676e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks break; 677e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_autorelease: 678e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_retain: 679e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_self: { 680e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // These methods return their receivers. 681e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, Msg->getReceiverSVal()); 682e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 683e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 684e460c46c5d602f65354cab0879c458890273591cJordan Rose } else if (const CXXConstructorCall *C = dyn_cast<CXXConstructorCall>(&Call)){ 685e460c46c5d602f65354cab0879c458890273591cJordan Rose return State->BindExpr(E, LCtx, C->getCXXThisVal()); 686e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 687e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 688e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Conjure a symbol if the return value is unknown. 689e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks QualType ResultTy = Call.getResultType(); 690e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks SValBuilder &SVB = getSValBuilder(); 69166c486f275531df6362b3511fc3af6563561801bTed Kremenek unsigned Count = currBldrCtx->blockCount(); 6923b1df8bb941a18c4a7256d7cfcbccb9de7e39995Ted Kremenek SVal R = SVB.conjureSymbolVal(0, E, LCtx, ResultTy, Count); 693e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, R); 694e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks} 695e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 696e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks// Conservatively evaluate call by invalidating regions and binding 697e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks// a conjured return value. 698e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksvoid ExprEngine::conservativeEvalCall(const CallEvent &Call, NodeBuilder &Bldr, 699e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ExplodedNode *Pred, ProgramStateRef State) { 70066c486f275531df6362b3511fc3af6563561801bTed Kremenek State = Call.invalidateRegions(currBldrCtx->blockCount(), State); 701e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks State = bindReturnValue(Call, Pred->getLocationContext(), State); 702e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 703e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // And make the result node. 704e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks Bldr.generateNode(Call.getProgramPoint(), State, Pred); 705e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks} 706e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 707e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksvoid ExprEngine::defaultEvalCall(NodeBuilder &Bldr, ExplodedNode *Pred, 708d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const CallEvent &CallTemplate) { 709d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Make sure we have the most recent state attached to the call. 710d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef State = Pred->getState(); 711d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<> Call = CallTemplate.cloneWithState(State); 712e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 7135960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (!getAnalysisManager().shouldInlineCall()) { 7145960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks conservativeEvalCall(*Call, Bldr, Pred, State); 7155960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 7165960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks } 71769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Try to inline the call. 71828038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // The origin expression here is just used as a kind of checksum; 719d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // this should still be safe even for CallEvents that don't come from exprs. 720d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const Expr *E = Call->getOriginExpr(); 721d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef InlinedFailedState = getInlineFailedState(State, E); 722d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 723d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose if (InlinedFailedState) { 724d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // If we already tried once and failed, make sure we don't retry later. 725d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose State = InlinedFailedState; 7265960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks } else { 727ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek RuntimeDefinition RD = Call->getRuntimeDefinition(); 728fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks const Decl *D = RD.getDecl(); 729e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks if (D) { 730b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose if (RD.mayHaveOtherDefinitions()) { 731b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose // Explore with and without inlining the call. 732255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (getAnalysisManager().options.IPAMode == DynamicDispatchBifurcate) { 733b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose BifurcateCall(RD.getDispatchRegion(), *Call, D, Bldr, Pred); 734b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose return; 735b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose } 736b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose 737b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose // Don't inline if we're not in any dynamic dispatch mode. 738255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (getAnalysisManager().options.IPAMode != DynamicDispatch) { 739da29ac527063fc9714547088bf841bfa30557bf0Jordan Rose conservativeEvalCall(*Call, Bldr, Pred, State); 740b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose return; 741da29ac527063fc9714547088bf841bfa30557bf0Jordan Rose } 742e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 743b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose 7445960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // We are not bifurcating and we do have a Decl, so just inline. 7455960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (inlineCall(*Call, D, Bldr, Pred, State)) 7465960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 747e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 748e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 74969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 75069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // If we can't inline it, handle the return value and invalidate the regions. 751e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks conservativeEvalCall(*Call, Bldr, Pred, State); 752e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks} 75369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 754e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksvoid ExprEngine::BifurcateCall(const MemRegion *BifurReg, 755e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks const CallEvent &Call, const Decl *D, 756e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NodeBuilder &Bldr, ExplodedNode *Pred) { 757e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks assert(BifurReg); 758b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose BifurReg = BifurReg->StripCasts(); 759e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 760e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // Check if we've performed the split already - note, we only want 761e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // to split the path once per memory region. 762e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef State = Pred->getState(); 763166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose const unsigned *BState = 7646960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->get<DynamicDispatchBifurcationMap>(BifurReg); 7655960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (BState) { 7665960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // If we are on "inline path", keep inlining if possible. 7676960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks if (*BState == DynamicDispatchModeInlined) 7685960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (inlineCall(Call, D, Bldr, Pred, State)) 7695960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 7705960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // If inline failed, or we are on the path where we assume we 7715960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // don't have enough info about the receiver to inline, conjure the 7725960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // return value and invalidate the regions. 7735960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks conservativeEvalCall(Call, Bldr, Pred, State); 7745960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 775e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 776e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 777e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // If we got here, this is the first time we process a message to this 778e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // region, so split the path. 779e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef IState = 7806960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->set<DynamicDispatchBifurcationMap>(BifurReg, 7816960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks DynamicDispatchModeInlined); 782e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks inlineCall(Call, D, Bldr, Pred, IState); 783e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 784e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef NoIState = 7856960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->set<DynamicDispatchBifurcationMap>(BifurReg, 7866960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks DynamicDispatchModeConservative); 787e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks conservativeEvalCall(Call, Bldr, Pred, NoIState); 788e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 789e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NumOfDynamicDispatchPathSplits++; 790e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks return; 79169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 79269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 793e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 794294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitReturnStmt(const ReturnStmt *RS, ExplodedNode *Pred, 795294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &Dst) { 796256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 797256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNodeSet dstPreVisit; 798256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, RS, *this); 799256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 80066c486f275531df6362b3511fc3af6563561801bTed Kremenek StmtNodeBuilder B(dstPreVisit, Dst, *currBldrCtx); 801256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 802256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (RS->getRetValue()) { 803256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek for (ExplodedNodeSet::iterator it = dstPreVisit.begin(), 804256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ei = dstPreVisit.end(); it != ei; ++it) { 805256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek B.generateNode(RS, *it, (*it)->getState()); 806294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 807294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 808294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 809