ExprEngineCallAndReturn.cpp revision 4ecca28e20410f5e2816c5ddff5cdeaf45fb74b5
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 16294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h" 1748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose#include "clang/AST/CXXInheritance.h" 18294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/AST/DeclCXX.h" 196fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose#include "clang/AST/ParentMap.h" 2055fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Analysis/Analyses/LiveVariables.h" 2155fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/StaticAnalyzer/Core/CheckerManager.h" 2255fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.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; 674ecca28e20410f5e2816c5ddff5cdeaf45fb74b5Jordan Rose const CFGBlock *Blk = 0; 680b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *SF = 690b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Node->getLocation().getLocationContext()->getCurrentStackFrame(); 70888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 71632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // Back up through the ExplodedGraph until we reach a statement node in this 72632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // stack frame. 73256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek while (Node) { 74256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const ProgramPoint &PP = Node->getLocation(); 75888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 76632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose if (PP.getLocationContext()->getCurrentStackFrame() == SF) { 77632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose if (const StmtPoint *SP = dyn_cast<StmtPoint>(&PP)) { 78632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose S = SP->getStmt(); 79888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 80632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose } else if (const CallExitEnd *CEE = dyn_cast<CallExitEnd>(&PP)) { 81632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose S = CEE->getCalleeContext()->getCallSite(); 82632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose if (S) 83632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose break; 84632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose 85632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // If there is no statement, this is an implicitly-generated call. 86632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // We'll walk backwards over it and then continue the loop to find 87632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // an actual statement. 88632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose const CallEnter *CE; 89632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose do { 90632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose Node = Node->getFirstPred(); 91632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose CE = Node->getLocationAs<CallEnter>(); 92632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose } while (!CE || CE->getCalleeContext() != CEE->getCalleeContext()); 93632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose 94632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // Continue searching the graph. 954ecca28e20410f5e2816c5ddff5cdeaf45fb74b5Jordan Rose } else if (const BlockEdge *BE = dyn_cast<BlockEdge>(&PP)) { 964ecca28e20410f5e2816c5ddff5cdeaf45fb74b5Jordan Rose Blk = BE->getSrc(); 97632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose } 98888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose } else if (const CallEnter *CE = dyn_cast<CallEnter>(&PP)) { 99888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // If we reached the CallEnter for this function, it has no statements. 100888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (CE->getCalleeContext() == SF) 101888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 102256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 103888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 1048501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks if (Node->pred_empty()) 1050a591c242b867844d483091cae546e294bbee312NAKAMURA Takumi return std::pair<const Stmt*, const CFGBlock*>((Stmt*)0, (CFGBlock*)0); 1068501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 107888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose Node = *Node->pred_begin(); 108256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 109888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 1100b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return std::pair<const Stmt*, const CFGBlock*>(S, Blk); 111256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 112256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 11348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// Adjusts a return value when the called function's return type does not 11448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// match the caller's expression type. This can happen when a dynamic call 11548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// is devirtualized, and the overridding method has a covariant (more specific) 11648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// return type than the parent's method. For C++ objects, this means we need 11748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// to add base casts. 11848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rosestatic SVal adjustReturnValue(SVal V, QualType ExpectedTy, QualType ActualTy, 11948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose StoreManager &StoreMgr) { 12048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // For now, the only adjustments we handle apply only to locations. 12148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (!isa<Loc>(V)) 12248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 12348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 12448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // If the types already match, don't do any unnecessary work. 125e7ad14e18247ec6fc3d46b208829e3dac6d85a1dAnna Zaks ExpectedTy = ExpectedTy.getCanonicalType(); 126e7ad14e18247ec6fc3d46b208829e3dac6d85a1dAnna Zaks ActualTy = ActualTy.getCanonicalType(); 12748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedTy == ActualTy) 12848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 12948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 13048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // No adjustment is needed between Objective-C pointer types. 13148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedTy->isObjCObjectPointerType() && 13248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose ActualTy->isObjCObjectPointerType()) 13348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 13448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 13548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // C++ object pointers may need "derived-to-base" casts. 13648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose const CXXRecordDecl *ExpectedClass = ExpectedTy->getPointeeCXXRecordDecl(); 13748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose const CXXRecordDecl *ActualClass = ActualTy->getPointeeCXXRecordDecl(); 13848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedClass && ActualClass) { 13948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CXXBasePaths Paths(/*FindAmbiguities=*/true, /*RecordPaths=*/true, 14048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose /*DetectVirtual=*/false); 14148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ActualClass->isDerivedFrom(ExpectedClass, Paths) && 14248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose !Paths.isAmbiguous(ActualTy->getCanonicalTypeUnqualified())) { 14348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return StoreMgr.evalDerivedToBase(V, Paths.front()); 14448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 14548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 14648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 14748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Unfortunately, Objective-C does not enforce that overridden methods have 14848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // covariant return types, so we can't assert that that never happens. 14948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Be safe and return UnknownVal(). 15048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return UnknownVal(); 15148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose} 15248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 1538501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaksvoid ExprEngine::removeDeadOnEndOfFunction(NodeBuilderContext& BC, 1548501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks ExplodedNode *Pred, 1558501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks ExplodedNodeSet &Dst) { 1568501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks // Find the last statement in the function and the corresponding basic block. 1578501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks const Stmt *LastSt = 0; 1588501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks const CFGBlock *Blk = 0; 1598501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks llvm::tie(LastSt, Blk) = getLastStmt(Pred); 1608501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks if (!Blk || !LastSt) { 16184c484545c5906ba55143e212b4a5275ab55889fJordan Rose Dst.Add(Pred); 1628501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks return; 1638501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks } 1648501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 16563bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // Here, we destroy the current location context. We use the current 16663bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // function's entire body as a diagnostic statement, with which the program 16763bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // point will be associated. However, we only want to use LastStmt as a 16863bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // reference for what to clean up if it's a ReturnStmt; otherwise, everything 16963bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // is dead. 17084c484545c5906ba55143e212b4a5275ab55889fJordan Rose SaveAndRestore<const NodeBuilderContext *> NodeContextRAII(currBldrCtx, &BC); 17163bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose const LocationContext *LCtx = Pred->getLocationContext(); 17263bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose removeDead(Pred, Dst, dyn_cast<ReturnStmt>(LastSt), LCtx, 17363bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose LCtx->getAnalysisDeclContext()->getBody(), 1748501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks ProgramPoint::PostStmtPurgeDeadSymbolsKind); 1758501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks} 1768501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 177bae930d4c69a624881e66f1628ee615e149362f7Anna Zaksstatic bool wasDifferentDeclUsedForInlining(CallEventRef<> Call, 178d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks const StackFrameContext *calleeCtx) { 179d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks const Decl *RuntimeCallee = calleeCtx->getDecl(); 180d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks const Decl *StaticDecl = Call->getDecl(); 181bae930d4c69a624881e66f1628ee615e149362f7Anna Zaks assert(RuntimeCallee); 182bae930d4c69a624881e66f1628ee615e149362f7Anna Zaks if (!StaticDecl) 183bae930d4c69a624881e66f1628ee615e149362f7Anna Zaks return true; 184d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks return RuntimeCallee->getCanonicalDecl() != StaticDecl->getCanonicalDecl(); 185d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks} 186d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks 1870b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// The call exit is simulated with a sequence of nodes, which occur between 1880b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// CallExitBegin and CallExitEnd. The following operations occur between the 1890b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// two program points: 1900b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 1. CallExitBegin (triggers the start of call exit sequence) 1910b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 2. Bind the return value 1920b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 3. Run Remove dead bindings to clean up the dead symbols from the callee. 1930b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 4. CallExitEnd (switch to the caller context) 1940b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 5. PostStmt<CallExpr> 1950b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksvoid ExprEngine::processCallExit(ExplodedNode *CEBNode) { 1960b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 1 CEBNode was generated before the call. 1970b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 1980b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *calleeCtx = 1990b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEBNode->getLocationContext()->getCurrentStackFrame(); 2007fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 2017fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // The parent context might not be a stack frame, so make sure we 2027fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // look up the first enclosing stack frame. 2037fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *callerCtx = 2047fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek calleeCtx->getParent()->getCurrentStackFrame(); 2057fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 206294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek const Stmt *CE = calleeCtx->getCallSite(); 2070b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramStateRef state = CEBNode->getState(); 2080b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Find the last statement in the function and the corresponding basic block. 2090b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const Stmt *LastSt = 0; 2100b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock *Blk = 0; 2110b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks llvm::tie(LastSt, Blk) = getLastStmt(CEBNode); 2120b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 21348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Generate a CallEvent /before/ cleaning the state, so that we can get the 21448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // correct value for 'this' (if necessary). 21548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 21648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CallEventRef<> Call = CEMgr.getCaller(calleeCtx, state); 21748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 218852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Step 2: generate node with bound return value: CEBNode -> BindedRetNode. 2190b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 220294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // If the callee returns an expression, bind its value to CallExpr. 221852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (CE) { 222852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const ReturnStmt *RS = dyn_cast_or_null<ReturnStmt>(LastSt)) { 223852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose const LocationContext *LCtx = CEBNode->getLocationContext(); 224852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal V = state->getSVal(RS, LCtx); 22548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 226d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks // Ensure that the return type matches the type of the returned Expr. 227bae930d4c69a624881e66f1628ee615e149362f7Anna Zaks if (wasDifferentDeclUsedForInlining(Call, calleeCtx)) { 228d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks QualType ReturnedTy = 229d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks CallEvent::getDeclaredResultType(calleeCtx->getDecl()); 23048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (!ReturnedTy.isNull()) { 23148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (const Expr *Ex = dyn_cast<Expr>(CE)) { 23248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose V = adjustReturnValue(V, Ex->getType(), ReturnedTy, 23348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose getStoreManager()); 23448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 23548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 23648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 23748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 23857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose state = state->BindExpr(CE, callerCtx, V); 239852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 2400b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 241852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Bind the constructed object value to CXXConstructExpr. 242852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(CE)) { 243852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose loc::MemRegionVal This = 244852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose svalBuilder.getCXXThis(CCE->getConstructor()->getParent(), calleeCtx); 245852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal ThisV = state->getSVal(This); 2460b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2470504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose // If the constructed object is a prvalue, get its bindings. 2480504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose // Note that we have to be careful here because constructors embedded 2490504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose // in DeclStmts are not marked as lvalues. 2500504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose if (!CCE->isGLValue()) 2510504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose if (const MemRegion *MR = ThisV.getAsRegion()) 2520504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose if (isa<CXXTempObjectRegion>(MR)) 2530504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose ThisV = state->getSVal(cast<Loc>(ThisV)); 2540504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose 25557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose state = state->BindExpr(CCE, callerCtx, ThisV); 256852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 257294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 2580b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2590b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 3: BindedRetNode -> CleanedNodes 2600b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // If we can find a statement and a block in the inlined function, run remove 2610b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // dead bindings before returning from the call. This is important to ensure 2620b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // that we report the issues such as leaks in the stack contexts in which 2630b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // they occurred. 2640b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNodeSet CleanedNodes; 265255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (LastSt && Blk && AMgr.options.AnalysisPurgeOpt != PurgeNone) { 26648b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose static SimpleProgramPointTag retValBind("ExprEngine : Bind Return Value"); 26748b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose PostStmt Loc(LastSt, calleeCtx, &retValBind); 26848b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose bool isNew; 26948b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *BindedRetNode = G.getNode(Loc, state, false, &isNew); 27048b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose BindedRetNode->addPredecessor(CEBNode, G); 27148b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose if (!isNew) 27248b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose return; 27348b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose 2740b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(getCoreEngine(), Blk, BindedRetNode); 27566c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx = &Ctx; 27684c484545c5906ba55143e212b4a5275ab55889fJordan Rose // Here, we call the Symbol Reaper with 0 statement and callee location 2770b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // context, telling it to clean up everything in the callee's context 27863bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // (and its children). We use the callee's function body as a diagnostic 27963bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // statement, with which the program point will be associated. 28063bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose removeDead(BindedRetNode, CleanedNodes, 0, calleeCtx, 28163bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose calleeCtx->getAnalysisDeclContext()->getBody(), 2820b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramPoint::PostStmtPurgeDeadSymbolsKind); 28366c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx = 0; 284144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks } else { 285144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks CleanedNodes.Add(CEBNode); 2860b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 2870b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2880b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator I = CleanedNodes.begin(), 2890b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks E = CleanedNodes.end(); I != E; ++I) { 2900b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2910b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 4: Generate the CallExit and leave the callee's context. 2920b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CleanedNodes -> CEENode 293852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose CallExitEnd Loc(calleeCtx, callerCtx); 2940b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks bool isNew; 29548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ProgramStateRef CEEState = (*I == CEBNode) ? state : (*I)->getState(); 29648b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *CEENode = G.getNode(Loc, CEEState, false, &isNew); 2970b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEENode->addPredecessor(*I, G); 2980b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (!isNew) 2990b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return; 3000b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3010b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 5: Perform the post-condition check of the CallExpr and enqueue the 3020b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // result onto the work list. 3030b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CEENode -> Dst -> WorkList 3040b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(Engine, calleeCtx->getCallSiteBlock(), CEENode); 30566c486f275531df6362b3511fc3af6563561801bTed Kremenek SaveAndRestore<const NodeBuilderContext*> NBCSave(currBldrCtx, 3060b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks &Ctx); 30766c486f275531df6362b3511fc3af6563561801bTed Kremenek SaveAndRestore<unsigned> CBISave(currStmtIdx, calleeCtx->getIndex()); 3080b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3094e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose CallEventRef<> UpdatedCall = Call.cloneWithState(CEEState); 31057c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 31157c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose ExplodedNodeSet DstPostCall; 3124e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose getCheckerManager().runCheckersForPostCall(DstPostCall, CEENode, 3134e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *UpdatedCall, *this, 3144e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose /*WasInlined=*/true); 31557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 31657c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose ExplodedNodeSet Dst; 3174e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(Call)) { 3184e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose getCheckerManager().runCheckersForPostObjCMessage(Dst, DstPostCall, *Msg, 3194e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *this, 3204e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose /*WasInlined=*/true); 32157c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } else if (CE) { 32257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getCheckerManager().runCheckersForPostStmt(Dst, DstPostCall, CE, 3234e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *this, /*WasInlined=*/true); 32457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } else { 32557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose Dst.insert(DstPostCall); 32657c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } 3270b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3280b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Enqueue the next element in the block. 3290b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator PSI = Dst.begin(), PSE = Dst.end(); 3300b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks PSI != PSE; ++PSI) { 3310b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Engine.getWorkList()->enqueue(*PSI, calleeCtx->getCallSiteBlock(), 3320b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks calleeCtx->getIndex()+1); 3330b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 334242384ddb0e0b65dd7e9e0ac0cf3c31cf98b06a6Ted Kremenek } 335294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 336294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 3374ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaksvoid ExprEngine::examineStackFrames(const Decl *D, const LocationContext *LCtx, 3387229d0011766c174beffe6a846d78f448f845b39Anna Zaks bool &IsRecursive, unsigned &StackDepth) { 3397229d0011766c174beffe6a846d78f448f845b39Anna Zaks IsRecursive = false; 3407229d0011766c174beffe6a846d78f448f845b39Anna Zaks StackDepth = 0; 3414ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3420849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek while (LCtx) { 3437229d0011766c174beffe6a846d78f448f845b39Anna Zaks if (const StackFrameContext *SFC = dyn_cast<StackFrameContext>(LCtx)) { 3444ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks const Decl *DI = SFC->getDecl(); 3454ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3464ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // Mark recursive (and mutually recursive) functions and always count 3474ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // them when measuring the stack depth. 3484ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks if (DI == D) { 3497229d0011766c174beffe6a846d78f448f845b39Anna Zaks IsRecursive = true; 3504ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks ++StackDepth; 3514ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks LCtx = LCtx->getParent(); 3524ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks continue; 3534ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks } 3544ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3554ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // Do not count the small functions when determining the stack depth. 3564ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(DI); 3574ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 3584ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks if (CalleeCFG->getNumBlockIDs() > AMgr.options.getAlwaysInlineSize()) 3594ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks ++StackDepth; 3607229d0011766c174beffe6a846d78f448f845b39Anna Zaks } 3610849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek LCtx = LCtx->getParent(); 3620849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek } 3634ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3640849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek} 3650849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek 36681fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rosestatic bool IsInStdNamespace(const FunctionDecl *FD) { 36781fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose const DeclContext *DC = FD->getEnclosingNamespaceContext(); 36881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose const NamespaceDecl *ND = dyn_cast<NamespaceDecl>(DC); 36981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!ND) 37081fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return false; 37181fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 37281fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose while (const DeclContext *Parent = ND->getParent()) { 37381fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!isa<NamespaceDecl>(Parent)) 37481fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose break; 37581fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose ND = cast<NamespaceDecl>(Parent); 37681fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose } 37781fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 37881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return ND->getName() == "std"; 37981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose} 38081fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 3816cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks// Determine if we should inline the call. 3827fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenekbool ExprEngine::shouldInlineDecl(const Decl *D, ExplodedNode *Pred) { 3837fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 3846cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 3856cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 38601561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // It is possible that the CFG cannot be constructed. 38701561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek // Be safe, and check if the CalleeCFG is valid. 38801561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek if (!CalleeCFG) 38901561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek return false; 39001561d1039bfdda61edd20eed939011a8632c7c7Ted Kremenek 3917229d0011766c174beffe6a846d78f448f845b39Anna Zaks bool IsRecursive = false; 3927229d0011766c174beffe6a846d78f448f845b39Anna Zaks unsigned StackDepth = 0; 3937229d0011766c174beffe6a846d78f448f845b39Anna Zaks examineStackFrames(D, Pred->getLocationContext(), IsRecursive, StackDepth); 3947229d0011766c174beffe6a846d78f448f845b39Anna Zaks if ((StackDepth >= AMgr.options.InlineMaxStackDepth) && 3957229d0011766c174beffe6a846d78f448f845b39Anna Zaks ((CalleeCFG->getNumBlockIDs() > AMgr.options.getAlwaysInlineSize()) 3967229d0011766c174beffe6a846d78f448f845b39Anna Zaks || IsRecursive)) 3976cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 3986cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 3997fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (Engine.FunctionSummaries->hasReachedMaxBlockCount(D)) 4003bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks return false; 4013bbd8cd831788c506f2980293eb3c7e1b3ca2501Anna Zaks 402255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (CalleeCFG->getNumBlockIDs() > AMgr.options.InlineMaxFunctionSize) 4036cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks return false; 4046cc0969ab37c614d6cf496f2ed6d2fca397a0133Anna Zaks 40510f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek // Do not inline variadic calls (for now). 40610f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) { 40710f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (BD->isVariadic()) 40810f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return false; 40910f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek } 41010f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { 41110f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek if (FD->isVariadic()) 41210f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return false; 4135903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks } 4145903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 41581fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (getContext().getLangOpts().CPlusPlus) { 41681fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { 41781fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose // Conditionally allow the inlining of template functions. 41881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!getAnalysisManager().options.mayInlineTemplateFunctions()) 41981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (FD->getTemplatedKind() != FunctionDecl::TK_NonTemplate) 42081fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return false; 42181fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 42281fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose // Conditionally allow the inlining of C++ standard library functions. 42381fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!getAnalysisManager().options.mayInlineCXXStandardLibrary()) 42481fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (getContext().getSourceManager().isInSystemHeader(FD->getLocation())) 42581fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (IsInStdNamespace(FD)) 42681fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return false; 42781fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose } 42881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose } 42981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 430d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek // It is possible that the live variables analysis cannot be 431d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek // run. If so, bail out. 432d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek if (!CalleeADC->getAnalysis<RelaxedLiveVariables>()) 433d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek return false; 434d4aeb8050a1d0fe47c53a73361c8b0b8ac310f46Ted Kremenek 43510f77ad7fc5e5cf3f37a9b14ff5843468b8b84d2Ted Kremenek return true; 4365903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks} 4375903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 438166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// The GDM component containing the dynamic dispatch bifurcation info. When 439166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// the exact type of the receiver is not known, we want to explore both paths - 440166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// one on which we do inline it and the other one on which we don't. This is 441166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// done to ensure we do not drop coverage. 442166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// This is the map from the receiver region to a bool, specifying either we 443166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// consider this region's information precise or not along the given path. 444166d502d5367ceacd1313a33cac43b1048b8524dJordan Rosenamespace { 445166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose enum DynamicDispatchMode { 446166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose DynamicDispatchModeInlined = 1, 447166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose DynamicDispatchModeConservative 448166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose }; 449166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose} 45040d8551890bc8454c4e0a28c9072c9c1d1dd588aJordan RoseREGISTER_TRAIT_WITH_PROGRAMSTATE(DynamicDispatchBifurcationMap, 45140d8551890bc8454c4e0a28c9072c9c1d1dd588aJordan Rose CLANG_ENTO_PROGRAMSTATE_MAP(const MemRegion *, 45240d8551890bc8454c4e0a28c9072c9c1d1dd588aJordan Rose unsigned)) 453e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 454e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksbool ExprEngine::inlineCall(const CallEvent &Call, const Decl *D, 455e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NodeBuilder &Bldr, ExplodedNode *Pred, 456e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef State) { 457e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks assert(D); 458ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 459c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const LocationContext *CurLC = Pred->getLocationContext(); 460c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const StackFrameContext *CallerSFC = CurLC->getCurrentStackFrame(); 4617fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const LocationContext *ParentOfCallee = 0; 46269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 463622b6fb0a1d280c16e135c7e427b79cafffbde1fTed Kremenek AnalyzerOptions &Opts = getAnalysisManager().options; 464de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose 465ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose // FIXME: Refactor this check into a hypothetical CallEvent::canInline. 46669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose switch (Call.getKind()) { 46769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_Function: 4682f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose break; 46969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_CXXMember: 470e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose case CE_CXXMemberOperator: 471de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose if (!Opts.mayInlineCXXMemberFunction(CIMK_MemberFunctions)) 4722f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose return false; 47369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose break; 474ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose case CE_CXXConstructor: { 475de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose if (!Opts.mayInlineCXXMemberFunction(CIMK_Constructors)) 4762f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose return false; 4772f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose 478ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const CXXConstructorCall &Ctor = cast<CXXConstructorCall>(Call); 479ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 480e460c46c5d602f65354cab0879c458890273591cJordan Rose // FIXME: We don't handle constructors or destructors for arrays properly. 481ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const MemRegion *Target = Ctor.getCXXThisVal().getAsRegion(); 482e460c46c5d602f65354cab0879c458890273591cJordan Rose if (Target && isa<ElementRegion>(Target)) 483e460c46c5d602f65354cab0879c458890273591cJordan Rose return false; 484e460c46c5d602f65354cab0879c458890273591cJordan Rose 4856fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose // FIXME: This is a hack. We don't use the correct region for a new 4866fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose // expression, so if we inline the constructor its result will just be 4876fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose // thrown away. This short-term hack is tracked in <rdar://problem/12180598> 4886fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose // and the longer-term possible fix is discussed in PR12014. 4896fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose const CXXConstructExpr *CtorExpr = Ctor.getOriginExpr(); 4906fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose if (const Stmt *Parent = CurLC->getParentMap().getParent(CtorExpr)) 4916fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose if (isa<CXXNewExpr>(Parent)) 4926fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose return false; 4936fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose 494de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose // Inlining constructors requires including initializers in the CFG. 495de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 496de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose assert(ADC->getCFGBuildOptions().AddInitializers && "No CFG initializers"); 4979eb214a691663a04ee61197e7d605128c85e09f7Jordan Rose (void)ADC; 498de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose 499c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose // If the destructor is trivial, it's always safe to inline the constructor. 500c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose if (Ctor.getDecl()->getParent()->hasTrivialDestructor()) 501c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose break; 502c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose 503de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose // For other types, only inline constructors if destructor inlining is 504de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose // also enabled. 505de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose if (!Opts.mayInlineCXXMemberFunction(CIMK_Destructors)) 506c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose return false; 507c210cb7a358d14cdd93b58562f33ff5ed2d895c1Jordan Rose 5083a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose // FIXME: This is a hack. We don't handle temporary destructors 509888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // right now, so we shouldn't inline their constructors. 510ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose if (CtorExpr->getConstructionKind() == CXXConstructExpr::CK_Complete) 511ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose if (!Target || !isa<DeclRegion>(Target)) 512ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose return false; 513ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 514ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose break; 515ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose } 516ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose case CE_CXXDestructor: { 517de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose if (!Opts.mayInlineCXXMemberFunction(CIMK_Destructors)) 5182f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose return false; 5192f9c40a915593849f6b0f5c4de516e2f597d0d66Jordan Rose 520de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose // Inlining destructors requires building the CFG correctly. 521ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 522de5277fc555551857602bd7a7e5e616274e2d4a6Jordan Rose assert(ADC->getCFGBuildOptions().AddImplicitDtors && "No CFG destructors"); 5239eb214a691663a04ee61197e7d605128c85e09f7Jordan Rose (void)ADC; 524ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 525ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const CXXDestructorCall &Dtor = cast<CXXDestructorCall>(Call); 526ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 527ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose // FIXME: We don't handle constructors or destructors for arrays properly. 528ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose const MemRegion *Target = Dtor.getCXXThisVal().getAsRegion(); 529ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose if (Target && isa<ElementRegion>(Target)) 530ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose return false; 531ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 532da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose break; 533da5fc53d6b024872c4c1d2c8c5da11e08bf116aaJordan Rose } 53470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXAllocator: 53570cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // Do not inline allocators until we model deallocators. 53670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // This is unfortunate, but basically necessary for smart pointers and such. 53770cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return false; 53869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_Block: { 53969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDataRegion *BR = cast<BlockCall>(Call).getBlockRegion(); 540ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose assert(BR && "If we have the block definition we should have its region"); 54169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose AnalysisDeclContext *BlockCtx = AMgr.getAnalysisDeclContext(D); 5427fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = BlockCtx->getBlockInvocationContext(CallerSFC, 54369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose cast<BlockDecl>(D), 5447fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek BR); 54569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose break; 54669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 54769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose case CE_ObjCMessage: 54857330eed3fbe530cb05996e4a346cc5fc217c0d9Anna Zaks if (!Opts.mayInlineObjCMethod()) 54957330eed3fbe530cb05996e4a346cc5fc217c0d9Anna Zaks return false; 550255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (!(getAnalysisManager().options.IPAMode == DynamicDispatch || 551255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek getAnalysisManager().options.IPAMode == DynamicDispatchBifurcate)) 552e13056a8bb532ddfdc07952a13169aa422bacd3bAnna Zaks return false; 5539dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks break; 554256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 555ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 556ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose if (!shouldInlineDecl(D, Pred)) 5577fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return false; 5587fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 5597fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (!ParentOfCallee) 5607fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = CallerSFC; 5617fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 562852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // This may be NULL, but that's fine. 56369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Expr *CallE = Call.getOriginExpr(); 56469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 5657fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // Construct a new stack frame for the callee. 5667fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 5677fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *CalleeSFC = 56869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose CalleeADC->getStackFrame(ParentOfCallee, CallE, 56966c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx->getBlock(), 57066c486f275531df6362b3511fc3af6563561801bTed Kremenek currStmtIdx); 5717fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 572c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CallEnter Loc(CallE, CalleeSFC, CurLC); 573e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 574e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // Construct a new state which contains the mapping from actual to 575e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // formal arguments. 576e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks State = State->enterStackFrame(Call, CalleeSFC); 577e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 5787fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek bool isNew; 579e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose if (ExplodedNode *N = G.getNode(Loc, State, false, &isNew)) { 5807fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek N->addPredecessor(Pred, G); 5817fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (isNew) 5827fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek Engine.getWorkList()->enqueue(N); 5837fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek } 584e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 585e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // If we decided to inline the call, the successor has been manually 586e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // added onto the work list so remove it from the node builder. 587e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks Bldr.takeNodes(Pred); 588e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 589210f5a28227c90d739298e3e6729e827858fe397Anna Zaks NumInlinedCalls++; 590210f5a28227c90d739298e3e6729e827858fe397Anna Zaks 591fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks // Mark the decl as visited. 592fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks if (VisitedCallees) 593fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks VisitedCallees->insert(D); 594fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks 5957fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return true; 596256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 597256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 598e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksstatic ProgramStateRef getInlineFailedState(ProgramStateRef State, 59969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Stmt *CallE) { 600e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks void *ReplayState = State->get<ReplayWithoutInlining>(); 6015903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!ReplayState) 6025903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return 0; 60328038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 60428038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose assert(ReplayState == (const void*)CallE && "Backtracked to the wrong call."); 60528038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose (void)CallE; 60628038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 607e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->remove<ReplayWithoutInlining>(); 60810520d76044e8fff71d414f30c21b449fd104960Ted Kremenek} 60910520d76044e8fff71d414f30c21b449fd104960Ted Kremenek 610294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred, 611294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &dst) { 612294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Perform the previsit of the CallExpr. 613294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstPreVisit; 614294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, CE, *this); 615500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 616d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Get the call in its initial state. We use this as a template to perform 617d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // all the checks. 618d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 619645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CallEventRef<> CallTemplate 620d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose = CEMgr.getSimpleCall(CE, Pred->getState(), Pred->getLocationContext()); 62169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 62269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Evaluate the function call. We try each of the checkers 623294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // to see if the can evaluate the function call. 624294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstCallEvaluated; 62569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose for (ExplodedNodeSet::iterator I = dstPreVisit.begin(), E = dstPreVisit.end(); 62669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose I != E; ++I) { 627d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose evalCall(dstCallEvaluated, *I, *CallTemplate); 62869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 62969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 630294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Finally, perform the post-condition check of the CallExpr and store 631294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // the created nodes in 'Dst'. 63269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Note that if the call was inlined, dstCallEvaluated will be empty. 63369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // The post-CallExpr check will occur in processCallExit. 634294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPostStmt(dst, dstCallEvaluated, CE, 635294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek *this); 636294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 637294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 63869f87c956b3ac2b80124fd9604af012e1061473aJordan Rosevoid ExprEngine::evalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred, 639645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const CallEvent &Call) { 640d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // WARNING: At this time, the state attached to 'Call' may be older than the 641d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // state in 'Pred'. This is a minor optimization since CheckerManager will 642d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // use an updated CallEvent instance when calling checkers, but if 'Call' is 643d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // ever used directly in this function all callers should be updated to pass 644d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // the most recent state. (It is probably not worth doing the work here since 645d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // for some callers this will not be necessary.) 646d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 64796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Run any pre-call checks using the generic call interface. 64896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstPreVisit; 64996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPreCall(dstPreVisit, Pred, Call, *this); 65096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 65196479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Actually evaluate the function call. We try each of the checkers 65296479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // to see if the can evaluate the function call, and get a callback at 65396479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // defaultEvalCall if all of them fail. 65496479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstCallEvaluated; 65596479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForEvalCall(dstCallEvaluated, dstPreVisit, 65696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 65796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 65896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Finally, run any post-call checks. 65996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPostCall(Dst, dstCallEvaluated, 66096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 66169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 66269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 663e81ce256b62717dd846bd19aecc4115a0dcd4995Anna ZaksProgramStateRef ExprEngine::bindReturnValue(const CallEvent &Call, 664e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const LocationContext *LCtx, 665e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks ProgramStateRef State) { 666e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const Expr *E = Call.getOriginExpr(); 667e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (!E) 668e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State; 669e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 670e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Some method families have known return values. 671e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(&Call)) { 672e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks switch (Msg->getMethodFamily()) { 673e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks default: 674e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks break; 675e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_autorelease: 676e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_retain: 677e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_self: { 678e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // These methods return their receivers. 679e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, Msg->getReceiverSVal()); 680e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 681e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 682e460c46c5d602f65354cab0879c458890273591cJordan Rose } else if (const CXXConstructorCall *C = dyn_cast<CXXConstructorCall>(&Call)){ 683e460c46c5d602f65354cab0879c458890273591cJordan Rose return State->BindExpr(E, LCtx, C->getCXXThisVal()); 684e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 685e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 686e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Conjure a symbol if the return value is unknown. 687e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks QualType ResultTy = Call.getResultType(); 688e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks SValBuilder &SVB = getSValBuilder(); 68966c486f275531df6362b3511fc3af6563561801bTed Kremenek unsigned Count = currBldrCtx->blockCount(); 6903b1df8bb941a18c4a7256d7cfcbccb9de7e39995Ted Kremenek SVal R = SVB.conjureSymbolVal(0, E, LCtx, ResultTy, Count); 691e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, R); 692e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks} 693e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 694e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks// Conservatively evaluate call by invalidating regions and binding 695e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks// a conjured return value. 696e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksvoid ExprEngine::conservativeEvalCall(const CallEvent &Call, NodeBuilder &Bldr, 697e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ExplodedNode *Pred, ProgramStateRef State) { 69866c486f275531df6362b3511fc3af6563561801bTed Kremenek State = Call.invalidateRegions(currBldrCtx->blockCount(), State); 699e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks State = bindReturnValue(Call, Pred->getLocationContext(), State); 700e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 701e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // And make the result node. 702e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks Bldr.generateNode(Call.getProgramPoint(), State, Pred); 703e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks} 704e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 705e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksvoid ExprEngine::defaultEvalCall(NodeBuilder &Bldr, ExplodedNode *Pred, 706d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const CallEvent &CallTemplate) { 707d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Make sure we have the most recent state attached to the call. 708d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef State = Pred->getState(); 709d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<> Call = CallTemplate.cloneWithState(State); 710e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 7115960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (!getAnalysisManager().shouldInlineCall()) { 7125960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks conservativeEvalCall(*Call, Bldr, Pred, State); 7135960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 7145960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks } 71569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Try to inline the call. 71628038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // The origin expression here is just used as a kind of checksum; 717d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // this should still be safe even for CallEvents that don't come from exprs. 718d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const Expr *E = Call->getOriginExpr(); 719d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef InlinedFailedState = getInlineFailedState(State, E); 720d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 721d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose if (InlinedFailedState) { 722d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // If we already tried once and failed, make sure we don't retry later. 723d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose State = InlinedFailedState; 7245960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks } else { 725ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek RuntimeDefinition RD = Call->getRuntimeDefinition(); 726fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks const Decl *D = RD.getDecl(); 727e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks if (D) { 728b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose if (RD.mayHaveOtherDefinitions()) { 729b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose // Explore with and without inlining the call. 730255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (getAnalysisManager().options.IPAMode == DynamicDispatchBifurcate) { 731b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose BifurcateCall(RD.getDispatchRegion(), *Call, D, Bldr, Pred); 732b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose return; 733b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose } 734b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose 735b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose // Don't inline if we're not in any dynamic dispatch mode. 736255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (getAnalysisManager().options.IPAMode != DynamicDispatch) { 737da29ac527063fc9714547088bf841bfa30557bf0Jordan Rose conservativeEvalCall(*Call, Bldr, Pred, State); 738b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose return; 739da29ac527063fc9714547088bf841bfa30557bf0Jordan Rose } 740e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 741b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose 7425960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // We are not bifurcating and we do have a Decl, so just inline. 7435960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (inlineCall(*Call, D, Bldr, Pred, State)) 7445960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 745e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 746e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 74769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 74869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // If we can't inline it, handle the return value and invalidate the regions. 749e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks conservativeEvalCall(*Call, Bldr, Pred, State); 750e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks} 75169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 752e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksvoid ExprEngine::BifurcateCall(const MemRegion *BifurReg, 753e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks const CallEvent &Call, const Decl *D, 754e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NodeBuilder &Bldr, ExplodedNode *Pred) { 755e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks assert(BifurReg); 756b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose BifurReg = BifurReg->StripCasts(); 757e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 758e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // Check if we've performed the split already - note, we only want 759e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // to split the path once per memory region. 760e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef State = Pred->getState(); 761166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose const unsigned *BState = 7626960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->get<DynamicDispatchBifurcationMap>(BifurReg); 7635960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (BState) { 7645960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // If we are on "inline path", keep inlining if possible. 7656960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks if (*BState == DynamicDispatchModeInlined) 7665960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (inlineCall(Call, D, Bldr, Pred, State)) 7675960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 7685960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // If inline failed, or we are on the path where we assume we 7695960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // don't have enough info about the receiver to inline, conjure the 7705960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // return value and invalidate the regions. 7715960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks conservativeEvalCall(Call, Bldr, Pred, State); 7725960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 773e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 774e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 775e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // If we got here, this is the first time we process a message to this 776e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // region, so split the path. 777e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef IState = 7786960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->set<DynamicDispatchBifurcationMap>(BifurReg, 7796960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks DynamicDispatchModeInlined); 780e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks inlineCall(Call, D, Bldr, Pred, IState); 781e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 782e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef NoIState = 7836960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->set<DynamicDispatchBifurcationMap>(BifurReg, 7846960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks DynamicDispatchModeConservative); 785e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks conservativeEvalCall(Call, Bldr, Pred, NoIState); 786e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 787e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NumOfDynamicDispatchPathSplits++; 788e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks return; 78969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 79069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 791e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 792294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitReturnStmt(const ReturnStmt *RS, ExplodedNode *Pred, 793294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &Dst) { 794256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 795256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNodeSet dstPreVisit; 796256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, RS, *this); 797256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 79866c486f275531df6362b3511fc3af6563561801bTed Kremenek StmtNodeBuilder B(dstPreVisit, Dst, *currBldrCtx); 799256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 800256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (RS->getRetValue()) { 801256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek for (ExplodedNodeSet::iterator it = dstPreVisit.begin(), 802256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ei = dstPreVisit.end(); it != ei; ++it) { 803256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek B.generateNode(RS, *it, (*it)->getState()); 804294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 805294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 806294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 807