ExprEngineCallAndReturn.cpp revision ac7cc2d37e82181e73fcc265c1d0a619d18b7605
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" 17ac7cc2d37e82181e73fcc265c1d0a619d18b7605Jordan Rose#include "PrettyStackTraceLocationContext.h" 1848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose#include "clang/AST/CXXInheritance.h" 19294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/AST/DeclCXX.h" 206fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose#include "clang/AST/ParentMap.h" 2155fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Analysis/Analyses/LiveVariables.h" 2255fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/StaticAnalyzer/Core/CheckerManager.h" 2355fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h" 244a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/ADT/SmallSet.h" 25e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks#include "llvm/ADT/Statistic.h" 264a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/Support/SaveAndRestore.h" 27294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 28294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekusing namespace clang; 29294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekusing namespace ento; 30294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 31e90d3f847dcce76237078b67db8895eb7a24189eAnna ZaksSTATISTIC(NumOfDynamicDispatchPathSplits, 32e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks "The # of times we split the path due to imprecise dynamic dispatch info"); 33e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 34210f5a28227c90d739298e3e6729e827858fe397Anna ZaksSTATISTIC(NumInlinedCalls, 35210f5a28227c90d739298e3e6729e827858fe397Anna Zaks "The # of times we inlined a call"); 36210f5a28227c90d739298e3e6729e827858fe397Anna Zaks 377959671d456c916706a5f61af609d8f1fc95decfAnna ZaksSTATISTIC(NumReachedInlineCountMax, 387959671d456c916706a5f61af609d8f1fc95decfAnna Zaks "The # of times we reached inline count maximum"); 397959671d456c916706a5f61af609d8f1fc95decfAnna Zaks 403070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenekvoid ExprEngine::processCallEnter(CallEnter CE, ExplodedNode *Pred) { 413070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Get the entry block in the CFG of the callee. 420849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek const StackFrameContext *calleeCtx = CE.getCalleeContext(); 43ac7cc2d37e82181e73fcc265c1d0a619d18b7605Jordan Rose PrettyStackTraceLocationContext CrashInfo(calleeCtx); 44ac7cc2d37e82181e73fcc265c1d0a619d18b7605Jordan Rose 450849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek const CFG *CalleeCFG = calleeCtx->getCFG(); 463070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek const CFGBlock *Entry = &(CalleeCFG->getEntry()); 473070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 483070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Validate the CFG. 493070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek assert(Entry->empty()); 503070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek assert(Entry->succ_size() == 1); 513070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 523070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Get the solitary sucessor. 533070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek const CFGBlock *Succ = *(Entry->succ_begin()); 543070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 553070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Construct an edge representing the starting location in the callee. 560849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek BlockEdge Loc(Entry, Succ, calleeCtx); 573070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 58e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose ProgramStateRef state = Pred->getState(); 593070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 603070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Construct a new node and add it to the worklist. 613070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek bool isNew; 623070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek ExplodedNode *Node = G.getNode(Loc, state, false, &isNew); 633070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek Node->addPredecessor(Pred, G); 643070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek if (isNew) 653070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek Engine.getWorkList()->enqueue(Node); 66294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 67294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 680b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// Find the last statement on the path to the exploded node and the 690b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// corresponding Block. 700b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksstatic std::pair<const Stmt*, 710b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock*> getLastStmt(const ExplodedNode *Node) { 720b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const Stmt *S = 0; 734ecca28e20410f5e2816c5ddff5cdeaf45fb74b5Jordan Rose const CFGBlock *Blk = 0; 740b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *SF = 750b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Node->getLocation().getLocationContext()->getCurrentStackFrame(); 76888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 77632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // Back up through the ExplodedGraph until we reach a statement node in this 78632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // stack frame. 79256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek while (Node) { 80256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const ProgramPoint &PP = Node->getLocation(); 81888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 82632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose if (PP.getLocationContext()->getCurrentStackFrame() == SF) { 837a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<StmtPoint> SP = PP.getAs<StmtPoint>()) { 84632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose S = SP->getStmt(); 85888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 867a95de68c093991047ed8d339479ccad51b88663David Blaikie } else if (Optional<CallExitEnd> CEE = PP.getAs<CallExitEnd>()) { 87632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose S = CEE->getCalleeContext()->getCallSite(); 88632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose if (S) 89632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose break; 90632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose 91632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // If there is no statement, this is an implicitly-generated call. 92632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // We'll walk backwards over it and then continue the loop to find 93632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // an actual statement. 947a95de68c093991047ed8d339479ccad51b88663David Blaikie Optional<CallEnter> CE; 95632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose do { 96632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose Node = Node->getFirstPred(); 97632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose CE = Node->getLocationAs<CallEnter>(); 98632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose } while (!CE || CE->getCalleeContext() != CEE->getCalleeContext()); 99632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose 100632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // Continue searching the graph. 1017a95de68c093991047ed8d339479ccad51b88663David Blaikie } else if (Optional<BlockEdge> BE = PP.getAs<BlockEdge>()) { 1024ecca28e20410f5e2816c5ddff5cdeaf45fb74b5Jordan Rose Blk = BE->getSrc(); 103632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose } 1047a95de68c093991047ed8d339479ccad51b88663David Blaikie } else if (Optional<CallEnter> CE = PP.getAs<CallEnter>()) { 105888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // If we reached the CallEnter for this function, it has no statements. 106888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (CE->getCalleeContext() == SF) 107888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 108256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 109888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 1108501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks if (Node->pred_empty()) 1110a591c242b867844d483091cae546e294bbee312NAKAMURA Takumi return std::pair<const Stmt*, const CFGBlock*>((Stmt*)0, (CFGBlock*)0); 1128501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 113888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose Node = *Node->pred_begin(); 114256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 115888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 1160b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return std::pair<const Stmt*, const CFGBlock*>(S, Blk); 117256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 118256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 11948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// Adjusts a return value when the called function's return type does not 12048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// match the caller's expression type. This can happen when a dynamic call 12148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// is devirtualized, and the overridding method has a covariant (more specific) 12248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// return type than the parent's method. For C++ objects, this means we need 12348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// to add base casts. 12448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rosestatic SVal adjustReturnValue(SVal V, QualType ExpectedTy, QualType ActualTy, 12548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose StoreManager &StoreMgr) { 12648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // For now, the only adjustments we handle apply only to locations. 1275251abea41b446c26e3239c8dd6c7edea6fc335dDavid Blaikie if (!V.getAs<Loc>()) 12848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 12948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 13048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // If the types already match, don't do any unnecessary work. 131e7ad14e18247ec6fc3d46b208829e3dac6d85a1dAnna Zaks ExpectedTy = ExpectedTy.getCanonicalType(); 132e7ad14e18247ec6fc3d46b208829e3dac6d85a1dAnna Zaks ActualTy = ActualTy.getCanonicalType(); 13348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedTy == ActualTy) 13448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 13548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 13648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // No adjustment is needed between Objective-C pointer types. 13748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedTy->isObjCObjectPointerType() && 13848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose ActualTy->isObjCObjectPointerType()) 13948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 14048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 14148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // C++ object pointers may need "derived-to-base" casts. 14248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose const CXXRecordDecl *ExpectedClass = ExpectedTy->getPointeeCXXRecordDecl(); 14348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose const CXXRecordDecl *ActualClass = ActualTy->getPointeeCXXRecordDecl(); 14448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedClass && ActualClass) { 14548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CXXBasePaths Paths(/*FindAmbiguities=*/true, /*RecordPaths=*/true, 14648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose /*DetectVirtual=*/false); 14748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ActualClass->isDerivedFrom(ExpectedClass, Paths) && 14848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose !Paths.isAmbiguous(ActualTy->getCanonicalTypeUnqualified())) { 14948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return StoreMgr.evalDerivedToBase(V, Paths.front()); 15048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 15148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 15248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 15348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Unfortunately, Objective-C does not enforce that overridden methods have 15448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // covariant return types, so we can't assert that that never happens. 15548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Be safe and return UnknownVal(). 15648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return UnknownVal(); 15748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose} 15848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 1598501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaksvoid ExprEngine::removeDeadOnEndOfFunction(NodeBuilderContext& BC, 1608501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks ExplodedNode *Pred, 1618501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks ExplodedNodeSet &Dst) { 1628501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks // Find the last statement in the function and the corresponding basic block. 1638501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks const Stmt *LastSt = 0; 1648501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks const CFGBlock *Blk = 0; 1658501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks llvm::tie(LastSt, Blk) = getLastStmt(Pred); 1668501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks if (!Blk || !LastSt) { 16784c484545c5906ba55143e212b4a5275ab55889fJordan Rose Dst.Add(Pred); 1688501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks return; 1698501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks } 1708501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 17163bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // Here, we destroy the current location context. We use the current 17263bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // function's entire body as a diagnostic statement, with which the program 17363bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // point will be associated. However, we only want to use LastStmt as a 17463bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // reference for what to clean up if it's a ReturnStmt; otherwise, everything 17563bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // is dead. 17684c484545c5906ba55143e212b4a5275ab55889fJordan Rose SaveAndRestore<const NodeBuilderContext *> NodeContextRAII(currBldrCtx, &BC); 17763bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose const LocationContext *LCtx = Pred->getLocationContext(); 17863bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose removeDead(Pred, Dst, dyn_cast<ReturnStmt>(LastSt), LCtx, 17963bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose LCtx->getAnalysisDeclContext()->getBody(), 1808501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks ProgramPoint::PostStmtPurgeDeadSymbolsKind); 1818501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks} 1828501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 183bae930d4c69a624881e66f1628ee615e149362f7Anna Zaksstatic bool wasDifferentDeclUsedForInlining(CallEventRef<> Call, 184d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks const StackFrameContext *calleeCtx) { 185d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks const Decl *RuntimeCallee = calleeCtx->getDecl(); 186d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks const Decl *StaticDecl = Call->getDecl(); 187bae930d4c69a624881e66f1628ee615e149362f7Anna Zaks assert(RuntimeCallee); 188bae930d4c69a624881e66f1628ee615e149362f7Anna Zaks if (!StaticDecl) 189bae930d4c69a624881e66f1628ee615e149362f7Anna Zaks return true; 190d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks return RuntimeCallee->getCanonicalDecl() != StaticDecl->getCanonicalDecl(); 191d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks} 192d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks 193bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose/// Returns true if the CXXConstructExpr \p E was intended to construct a 194bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose/// prvalue for the region in \p V. 195bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose/// 196bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose/// Note that we can't just test for rvalue vs. glvalue because 197bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose/// CXXConstructExprs embedded in DeclStmts and initializers are considered 198bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose/// rvalues by the AST, and the analyzer would like to treat them as lvalues. 199bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rosestatic bool isTemporaryPRValue(const CXXConstructExpr *E, SVal V) { 200bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose if (E->isGLValue()) 201bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose return false; 202bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose 203bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose const MemRegion *MR = V.getAsRegion(); 204bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose if (!MR) 205bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose return false; 206bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose 207bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose return isa<CXXTempObjectRegion>(MR); 208bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose} 209bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose 2100b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// The call exit is simulated with a sequence of nodes, which occur between 2110b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// CallExitBegin and CallExitEnd. The following operations occur between the 2120b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// two program points: 2130b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 1. CallExitBegin (triggers the start of call exit sequence) 2140b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 2. Bind the return value 2150b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 3. Run Remove dead bindings to clean up the dead symbols from the callee. 2160b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 4. CallExitEnd (switch to the caller context) 2170b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 5. PostStmt<CallExpr> 2180b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksvoid ExprEngine::processCallExit(ExplodedNode *CEBNode) { 2190b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 1 CEBNode was generated before the call. 220ac7cc2d37e82181e73fcc265c1d0a619d18b7605Jordan Rose PrettyStackTraceLocationContext CrashInfo(CEBNode->getLocationContext()); 2210b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *calleeCtx = 2220b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEBNode->getLocationContext()->getCurrentStackFrame(); 2237fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 2247fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // The parent context might not be a stack frame, so make sure we 2257fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // look up the first enclosing stack frame. 2267fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *callerCtx = 2277fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek calleeCtx->getParent()->getCurrentStackFrame(); 2287fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 229294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek const Stmt *CE = calleeCtx->getCallSite(); 2300b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramStateRef state = CEBNode->getState(); 2310b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Find the last statement in the function and the corresponding basic block. 2320b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const Stmt *LastSt = 0; 2330b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock *Blk = 0; 2340b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks llvm::tie(LastSt, Blk) = getLastStmt(CEBNode); 2350b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 23648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Generate a CallEvent /before/ cleaning the state, so that we can get the 23748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // correct value for 'this' (if necessary). 23848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 23948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CallEventRef<> Call = CEMgr.getCaller(calleeCtx, state); 24048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 241852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Step 2: generate node with bound return value: CEBNode -> BindedRetNode. 2420b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 243294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // If the callee returns an expression, bind its value to CallExpr. 244852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (CE) { 245852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const ReturnStmt *RS = dyn_cast_or_null<ReturnStmt>(LastSt)) { 246852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose const LocationContext *LCtx = CEBNode->getLocationContext(); 247852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal V = state->getSVal(RS, LCtx); 24848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 249d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks // Ensure that the return type matches the type of the returned Expr. 250bae930d4c69a624881e66f1628ee615e149362f7Anna Zaks if (wasDifferentDeclUsedForInlining(Call, calleeCtx)) { 251d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks QualType ReturnedTy = 252d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks CallEvent::getDeclaredResultType(calleeCtx->getDecl()); 25348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (!ReturnedTy.isNull()) { 25448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (const Expr *Ex = dyn_cast<Expr>(CE)) { 25548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose V = adjustReturnValue(V, Ex->getType(), ReturnedTy, 25648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose getStoreManager()); 25748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 25848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 25948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 26048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 26157c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose state = state->BindExpr(CE, callerCtx, V); 262852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 2630b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 264852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Bind the constructed object value to CXXConstructExpr. 265852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(CE)) { 266852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose loc::MemRegionVal This = 267852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose svalBuilder.getCXXThis(CCE->getConstructor()->getParent(), calleeCtx); 268852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal ThisV = state->getSVal(This); 2690b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 270bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose // If the constructed object is a temporary prvalue, get its bindings. 271bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose if (isTemporaryPRValue(CCE, ThisV)) 2725251abea41b446c26e3239c8dd6c7edea6fc335dDavid Blaikie ThisV = state->getSVal(ThisV.castAs<Loc>()); 2730504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose 27457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose state = state->BindExpr(CCE, callerCtx, ThisV); 275852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 276294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 2770b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2780b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 3: BindedRetNode -> CleanedNodes 2790b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // If we can find a statement and a block in the inlined function, run remove 2800b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // dead bindings before returning from the call. This is important to ensure 2810b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // that we report the issues such as leaks in the stack contexts in which 2820b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // they occurred. 2830b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNodeSet CleanedNodes; 284255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (LastSt && Blk && AMgr.options.AnalysisPurgeOpt != PurgeNone) { 28548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose static SimpleProgramPointTag retValBind("ExprEngine : Bind Return Value"); 28648b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose PostStmt Loc(LastSt, calleeCtx, &retValBind); 28748b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose bool isNew; 28848b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *BindedRetNode = G.getNode(Loc, state, false, &isNew); 28948b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose BindedRetNode->addPredecessor(CEBNode, G); 29048b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose if (!isNew) 29148b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose return; 29248b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose 2930b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(getCoreEngine(), Blk, BindedRetNode); 29466c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx = &Ctx; 29584c484545c5906ba55143e212b4a5275ab55889fJordan Rose // Here, we call the Symbol Reaper with 0 statement and callee location 2960b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // context, telling it to clean up everything in the callee's context 29763bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // (and its children). We use the callee's function body as a diagnostic 29863bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // statement, with which the program point will be associated. 29963bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose removeDead(BindedRetNode, CleanedNodes, 0, calleeCtx, 30063bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose calleeCtx->getAnalysisDeclContext()->getBody(), 3010b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramPoint::PostStmtPurgeDeadSymbolsKind); 30266c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx = 0; 303144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks } else { 304144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks CleanedNodes.Add(CEBNode); 3050b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 3060b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3070b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator I = CleanedNodes.begin(), 3080b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks E = CleanedNodes.end(); I != E; ++I) { 3090b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3100b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 4: Generate the CallExit and leave the callee's context. 3110b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CleanedNodes -> CEENode 312852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose CallExitEnd Loc(calleeCtx, callerCtx); 3130b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks bool isNew; 31448b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ProgramStateRef CEEState = (*I == CEBNode) ? state : (*I)->getState(); 31548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *CEENode = G.getNode(Loc, CEEState, false, &isNew); 3160b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEENode->addPredecessor(*I, G); 3170b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (!isNew) 3180b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return; 3190b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3200b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 5: Perform the post-condition check of the CallExpr and enqueue the 3210b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // result onto the work list. 3220b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CEENode -> Dst -> WorkList 3230b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(Engine, calleeCtx->getCallSiteBlock(), CEENode); 32466c486f275531df6362b3511fc3af6563561801bTed Kremenek SaveAndRestore<const NodeBuilderContext*> NBCSave(currBldrCtx, 3250b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks &Ctx); 32666c486f275531df6362b3511fc3af6563561801bTed Kremenek SaveAndRestore<unsigned> CBISave(currStmtIdx, calleeCtx->getIndex()); 3270b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3284e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose CallEventRef<> UpdatedCall = Call.cloneWithState(CEEState); 32957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 33057c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose ExplodedNodeSet DstPostCall; 3314e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose getCheckerManager().runCheckersForPostCall(DstPostCall, CEENode, 3324e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *UpdatedCall, *this, 3334e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose /*WasInlined=*/true); 33457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 33557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose ExplodedNodeSet Dst; 3364e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(Call)) { 3374e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose getCheckerManager().runCheckersForPostObjCMessage(Dst, DstPostCall, *Msg, 3384e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *this, 3394e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose /*WasInlined=*/true); 34057c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } else if (CE) { 34157c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getCheckerManager().runCheckersForPostStmt(Dst, DstPostCall, CE, 3424e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *this, /*WasInlined=*/true); 34357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } else { 34457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose Dst.insert(DstPostCall); 34557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } 3460b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3470b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Enqueue the next element in the block. 3480b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator PSI = Dst.begin(), PSE = Dst.end(); 3490b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks PSI != PSE; ++PSI) { 3500b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Engine.getWorkList()->enqueue(*PSI, calleeCtx->getCallSiteBlock(), 3510b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks calleeCtx->getIndex()+1); 3520b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 353242384ddb0e0b65dd7e9e0ac0cf3c31cf98b06a6Ted Kremenek } 354294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 355294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 3564ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaksvoid ExprEngine::examineStackFrames(const Decl *D, const LocationContext *LCtx, 3577229d0011766c174beffe6a846d78f448f845b39Anna Zaks bool &IsRecursive, unsigned &StackDepth) { 3587229d0011766c174beffe6a846d78f448f845b39Anna Zaks IsRecursive = false; 3597229d0011766c174beffe6a846d78f448f845b39Anna Zaks StackDepth = 0; 3604ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3610849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek while (LCtx) { 3627229d0011766c174beffe6a846d78f448f845b39Anna Zaks if (const StackFrameContext *SFC = dyn_cast<StackFrameContext>(LCtx)) { 3634ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks const Decl *DI = SFC->getDecl(); 3644ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3654ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // Mark recursive (and mutually recursive) functions and always count 3664ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // them when measuring the stack depth. 3674ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks if (DI == D) { 3687229d0011766c174beffe6a846d78f448f845b39Anna Zaks IsRecursive = true; 3694ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks ++StackDepth; 3704ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks LCtx = LCtx->getParent(); 3714ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks continue; 3724ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks } 3734ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3744ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // Do not count the small functions when determining the stack depth. 3754ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(DI); 3764ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 3774ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks if (CalleeCFG->getNumBlockIDs() > AMgr.options.getAlwaysInlineSize()) 3784ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks ++StackDepth; 3797229d0011766c174beffe6a846d78f448f845b39Anna Zaks } 3800849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek LCtx = LCtx->getParent(); 3810849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek } 3824ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3830849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek} 3840849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek 38581fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rosestatic bool IsInStdNamespace(const FunctionDecl *FD) { 38681fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose const DeclContext *DC = FD->getEnclosingNamespaceContext(); 38781fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose const NamespaceDecl *ND = dyn_cast<NamespaceDecl>(DC); 38881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!ND) 38981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return false; 39081fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 39181fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose while (const DeclContext *Parent = ND->getParent()) { 39281fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose if (!isa<NamespaceDecl>(Parent)) 39381fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose break; 39481fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose ND = cast<NamespaceDecl>(Parent); 39581fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose } 39681fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 39781fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose return ND->getName() == "std"; 39881fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose} 39981fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 400166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// The GDM component containing the dynamic dispatch bifurcation info. When 401166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// the exact type of the receiver is not known, we want to explore both paths - 402166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// one on which we do inline it and the other one on which we don't. This is 403166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// done to ensure we do not drop coverage. 404166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// This is the map from the receiver region to a bool, specifying either we 405166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// consider this region's information precise or not along the given path. 406166d502d5367ceacd1313a33cac43b1048b8524dJordan Rosenamespace { 407166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose enum DynamicDispatchMode { 408166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose DynamicDispatchModeInlined = 1, 409166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose DynamicDispatchModeConservative 410166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose }; 411166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose} 41240d8551890bc8454c4e0a28c9072c9c1d1dd588aJordan RoseREGISTER_TRAIT_WITH_PROGRAMSTATE(DynamicDispatchBifurcationMap, 41340d8551890bc8454c4e0a28c9072c9c1d1dd588aJordan Rose CLANG_ENTO_PROGRAMSTATE_MAP(const MemRegion *, 41440d8551890bc8454c4e0a28c9072c9c1d1dd588aJordan Rose unsigned)) 415e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 416e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksbool ExprEngine::inlineCall(const CallEvent &Call, const Decl *D, 417e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NodeBuilder &Bldr, ExplodedNode *Pred, 418e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef State) { 419e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks assert(D); 420ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 421c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const LocationContext *CurLC = Pred->getLocationContext(); 422c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const StackFrameContext *CallerSFC = CurLC->getCurrentStackFrame(); 4238dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const LocationContext *ParentOfCallee = CallerSFC; 4248dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (Call.getKind() == CE_Block) { 42569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDataRegion *BR = cast<BlockCall>(Call).getBlockRegion(); 426ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose assert(BR && "If we have the block definition we should have its region"); 42769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose AnalysisDeclContext *BlockCtx = AMgr.getAnalysisDeclContext(D); 4287fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = BlockCtx->getBlockInvocationContext(CallerSFC, 42969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose cast<BlockDecl>(D), 4307fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek BR); 431256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 4327fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 433852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // This may be NULL, but that's fine. 43469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Expr *CallE = Call.getOriginExpr(); 43569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 4367fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // Construct a new stack frame for the callee. 4377fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 4387fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *CalleeSFC = 43969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose CalleeADC->getStackFrame(ParentOfCallee, CallE, 44066c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx->getBlock(), 44166c486f275531df6362b3511fc3af6563561801bTed Kremenek currStmtIdx); 4427fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 4438dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 444c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CallEnter Loc(CallE, CalleeSFC, CurLC); 445e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 446e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // Construct a new state which contains the mapping from actual to 447e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // formal arguments. 448e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks State = State->enterStackFrame(Call, CalleeSFC); 449e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 4507fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek bool isNew; 451e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose if (ExplodedNode *N = G.getNode(Loc, State, false, &isNew)) { 4527fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek N->addPredecessor(Pred, G); 4537fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (isNew) 4547fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek Engine.getWorkList()->enqueue(N); 4557fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek } 456e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 457e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // If we decided to inline the call, the successor has been manually 458e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // added onto the work list so remove it from the node builder. 459e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks Bldr.takeNodes(Pred); 460e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 461210f5a28227c90d739298e3e6729e827858fe397Anna Zaks NumInlinedCalls++; 462210f5a28227c90d739298e3e6729e827858fe397Anna Zaks 463fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks // Mark the decl as visited. 464fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks if (VisitedCallees) 465fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks VisitedCallees->insert(D); 466fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks 4677fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return true; 468256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 469256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 470e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksstatic ProgramStateRef getInlineFailedState(ProgramStateRef State, 47169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Stmt *CallE) { 472bdc691f1d61765dd806d5ae3b75ae004f676a7c9Jordan Rose const void *ReplayState = State->get<ReplayWithoutInlining>(); 4735903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!ReplayState) 4745903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks return 0; 47528038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 476bdc691f1d61765dd806d5ae3b75ae004f676a7c9Jordan Rose assert(ReplayState == CallE && "Backtracked to the wrong call."); 47728038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose (void)CallE; 47828038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 479e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->remove<ReplayWithoutInlining>(); 48010520d76044e8fff71d414f30c21b449fd104960Ted Kremenek} 48110520d76044e8fff71d414f30c21b449fd104960Ted Kremenek 482294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred, 483294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &dst) { 484294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Perform the previsit of the CallExpr. 485294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstPreVisit; 486294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, CE, *this); 487500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 488d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Get the call in its initial state. We use this as a template to perform 489d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // all the checks. 490d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 491645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CallEventRef<> CallTemplate 492d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose = CEMgr.getSimpleCall(CE, Pred->getState(), Pred->getLocationContext()); 49369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 49469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Evaluate the function call. We try each of the checkers 495294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // to see if the can evaluate the function call. 496294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstCallEvaluated; 49769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose for (ExplodedNodeSet::iterator I = dstPreVisit.begin(), E = dstPreVisit.end(); 49869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose I != E; ++I) { 499d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose evalCall(dstCallEvaluated, *I, *CallTemplate); 50069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 50169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 502294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Finally, perform the post-condition check of the CallExpr and store 503294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // the created nodes in 'Dst'. 50469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Note that if the call was inlined, dstCallEvaluated will be empty. 50569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // The post-CallExpr check will occur in processCallExit. 506294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPostStmt(dst, dstCallEvaluated, CE, 507294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek *this); 508294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 509294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 51069f87c956b3ac2b80124fd9604af012e1061473aJordan Rosevoid ExprEngine::evalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred, 511645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const CallEvent &Call) { 512d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // WARNING: At this time, the state attached to 'Call' may be older than the 513d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // state in 'Pred'. This is a minor optimization since CheckerManager will 514d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // use an updated CallEvent instance when calling checkers, but if 'Call' is 515d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // ever used directly in this function all callers should be updated to pass 516d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // the most recent state. (It is probably not worth doing the work here since 517d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // for some callers this will not be necessary.) 518d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 51996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Run any pre-call checks using the generic call interface. 52096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstPreVisit; 52196479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPreCall(dstPreVisit, Pred, Call, *this); 52296479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 52396479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Actually evaluate the function call. We try each of the checkers 52496479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // to see if the can evaluate the function call, and get a callback at 52596479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // defaultEvalCall if all of them fail. 52696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstCallEvaluated; 52796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForEvalCall(dstCallEvaluated, dstPreVisit, 52896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 52996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 53096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Finally, run any post-call checks. 53196479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPostCall(Dst, dstCallEvaluated, 53296479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 53369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 53469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 535e81ce256b62717dd846bd19aecc4115a0dcd4995Anna ZaksProgramStateRef ExprEngine::bindReturnValue(const CallEvent &Call, 536e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const LocationContext *LCtx, 537e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks ProgramStateRef State) { 538e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const Expr *E = Call.getOriginExpr(); 539e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (!E) 540e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State; 541e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 542e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Some method families have known return values. 543e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(&Call)) { 544e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks switch (Msg->getMethodFamily()) { 545e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks default: 546e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks break; 547e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_autorelease: 548e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_retain: 549e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_self: { 550e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // These methods return their receivers. 551e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, Msg->getReceiverSVal()); 552e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 553e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 554e460c46c5d602f65354cab0879c458890273591cJordan Rose } else if (const CXXConstructorCall *C = dyn_cast<CXXConstructorCall>(&Call)){ 555bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose SVal ThisV = C->getCXXThisVal(); 556bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose 557bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose // If the constructed object is a temporary prvalue, get its bindings. 558bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose if (isTemporaryPRValue(cast<CXXConstructExpr>(E), ThisV)) 5595251abea41b446c26e3239c8dd6c7edea6fc335dDavid Blaikie ThisV = State->getSVal(ThisV.castAs<Loc>()); 560bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose 561bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose return State->BindExpr(E, LCtx, ThisV); 562e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 563e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 564e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Conjure a symbol if the return value is unknown. 565e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks QualType ResultTy = Call.getResultType(); 566e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks SValBuilder &SVB = getSValBuilder(); 56766c486f275531df6362b3511fc3af6563561801bTed Kremenek unsigned Count = currBldrCtx->blockCount(); 5683b1df8bb941a18c4a7256d7cfcbccb9de7e39995Ted Kremenek SVal R = SVB.conjureSymbolVal(0, E, LCtx, ResultTy, Count); 569e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, R); 570e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks} 571e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 572e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks// Conservatively evaluate call by invalidating regions and binding 573e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks// a conjured return value. 574e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksvoid ExprEngine::conservativeEvalCall(const CallEvent &Call, NodeBuilder &Bldr, 57542f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks ExplodedNode *Pred, 57642f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks ProgramStateRef State) { 57766c486f275531df6362b3511fc3af6563561801bTed Kremenek State = Call.invalidateRegions(currBldrCtx->blockCount(), State); 578e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks State = bindReturnValue(Call, Pred->getLocationContext(), State); 579e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 580e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // And make the result node. 581e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks Bldr.generateNode(Call.getProgramPoint(), State, Pred); 582e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks} 583e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 584c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Roseenum CallInlinePolicy { 585c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose CIP_Allowed, 586c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose CIP_DisallowedOnce, 587c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose CIP_DisallowedAlways 588c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose}; 589c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 590c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rosestatic CallInlinePolicy mayInlineCallKind(const CallEvent &Call, 591c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose const ExplodedNode *Pred, 592c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose AnalyzerOptions &Opts) { 5938dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const LocationContext *CurLC = Pred->getLocationContext(); 5948dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const StackFrameContext *CallerSFC = CurLC->getCurrentStackFrame(); 5958dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks switch (Call.getKind()) { 5968dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_Function: 5978dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_Block: 5988dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks break; 5998dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_CXXMember: 6008dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_CXXMemberOperator: 6018dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!Opts.mayInlineCXXMemberFunction(CIMK_MemberFunctions)) 602c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 6038dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks break; 6048dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_CXXConstructor: { 6058dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!Opts.mayInlineCXXMemberFunction(CIMK_Constructors)) 606c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 6078dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6088dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const CXXConstructorCall &Ctor = cast<CXXConstructorCall>(Call); 6098dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6108dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // FIXME: We don't handle constructors or destructors for arrays properly. 611ecee1651c100342366a9417c85c6e50399039930Jordan Rose // Even once we do, we still need to be careful about implicitly-generated 612ecee1651c100342366a9417c85c6e50399039930Jordan Rose // initializers for array fields in default move/copy constructors. 6138dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const MemRegion *Target = Ctor.getCXXThisVal().getAsRegion(); 6148dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (Target && isa<ElementRegion>(Target)) 615c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedOnce; 6168dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6178dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // FIXME: This is a hack. We don't use the correct region for a new 6188dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // expression, so if we inline the constructor its result will just be 6198dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // thrown away. This short-term hack is tracked in <rdar://problem/12180598> 6208dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // and the longer-term possible fix is discussed in PR12014. 6218dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const CXXConstructExpr *CtorExpr = Ctor.getOriginExpr(); 6228dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (const Stmt *Parent = CurLC->getParentMap().getParent(CtorExpr)) 6238dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (isa<CXXNewExpr>(Parent)) 624c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedOnce; 6258dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6268dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // Inlining constructors requires including initializers in the CFG. 6278dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 6288dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks assert(ADC->getCFGBuildOptions().AddInitializers && "No CFG initializers"); 6298dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks (void)ADC; 6308dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6318dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // If the destructor is trivial, it's always safe to inline the constructor. 6328dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (Ctor.getDecl()->getParent()->hasTrivialDestructor()) 6338dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks break; 6348dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6358dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // For other types, only inline constructors if destructor inlining is 6368dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // also enabled. 6378dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!Opts.mayInlineCXXMemberFunction(CIMK_Destructors)) 638c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 6398dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6408dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // FIXME: This is a hack. We don't handle temporary destructors 6418dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // right now, so we shouldn't inline their constructors. 6428dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (CtorExpr->getConstructionKind() == CXXConstructExpr::CK_Complete) 6438dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!Target || !isa<DeclRegion>(Target)) 644c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedOnce; 6458dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6468dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks break; 6478dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks } 6488dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_CXXDestructor: { 6498dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!Opts.mayInlineCXXMemberFunction(CIMK_Destructors)) 650c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 6518dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6528dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // Inlining destructors requires building the CFG correctly. 6538dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 6548dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks assert(ADC->getCFGBuildOptions().AddImplicitDtors && "No CFG destructors"); 6558dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks (void)ADC; 6568dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6578dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const CXXDestructorCall &Dtor = cast<CXXDestructorCall>(Call); 6588dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6598dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // FIXME: We don't handle constructors or destructors for arrays properly. 6608dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const MemRegion *Target = Dtor.getCXXThisVal().getAsRegion(); 6618dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (Target && isa<ElementRegion>(Target)) 662c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedOnce; 6638dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6648dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks break; 6658dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks } 6668dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_CXXAllocator: 6678dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // Do not inline allocators until we model deallocators. 6688dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // This is unfortunate, but basically necessary for smart pointers and such. 669c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 6708dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_ObjCMessage: 6718dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!Opts.mayInlineObjCMethod()) 672c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 6738dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!(Opts.getIPAMode() == IPAK_DynamicDispatch || 6748dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks Opts.getIPAMode() == IPAK_DynamicDispatchBifurcate)) 675c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 6768dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks break; 6778dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks } 678c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 679c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_Allowed; 680c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose} 681c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 682776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose/// Returns true if the given C++ class contains a member with the given name. 683776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rosestatic bool hasMember(const ASTContext &Ctx, const CXXRecordDecl *RD, 684776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose StringRef Name) { 685776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose const IdentifierInfo &II = Ctx.Idents.get(Name); 686776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose DeclarationName DeclName = Ctx.DeclarationNames.getIdentifier(&II); 687776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose if (!RD->lookup(DeclName).empty()) 688c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose return true; 689776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose 690776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose CXXBasePaths Paths(false, false, false); 691c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose if (RD->lookupInBases(&CXXRecordDecl::FindOrdinaryMember, 692776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose DeclName.getAsOpaquePtr(), 693c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose Paths)) 694c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose return true; 695c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose 696c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose return false; 697c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose} 698c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose 699776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose/// Returns true if the given C++ class is a container or iterator. 700776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose/// 701776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose/// Our heuristic for this is whether it contains a method named 'begin()' or a 702776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose/// nested type named 'iterator' or 'iterator_category'. 703776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rosestatic bool isContainerClass(const ASTContext &Ctx, const CXXRecordDecl *RD) { 704776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose return hasMember(Ctx, RD, "begin") || 705776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose hasMember(Ctx, RD, "iterator") || 706776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose hasMember(Ctx, RD, "iterator_category"); 707776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose} 708776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose 709c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose/// Returns true if the given function refers to a constructor or destructor of 710776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose/// a C++ container or iterator. 711c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose/// 712c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose/// We generally do a poor job modeling most containers right now, and would 713776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose/// prefer not to inline their setup and teardown. 714c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rosestatic bool isContainerCtorOrDtor(const ASTContext &Ctx, 715c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose const FunctionDecl *FD) { 716c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD))) 717c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose return false; 718c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose 719c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose const CXXRecordDecl *RD = cast<CXXMethodDecl>(FD)->getParent(); 720c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose return isContainerClass(Ctx, RD); 721c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose} 722c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose 72350fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose/// Returns true if the given function is the destructor of a class named 72450fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose/// "shared_ptr". 72550fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rosestatic bool isCXXSharedPtrDtor(const FunctionDecl *FD) { 72650fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose const CXXDestructorDecl *Dtor = dyn_cast<CXXDestructorDecl>(FD); 72750fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose if (!Dtor) 72850fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose return false; 72950fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose 73050fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose const CXXRecordDecl *RD = Dtor->getParent(); 73150fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose if (const IdentifierInfo *II = RD->getDeclName().getAsIdentifierInfo()) 73250fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose if (II->isStr("shared_ptr")) 73350fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose return true; 73450fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose 73550fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose return false; 73650fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose} 73750fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose 738c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose/// Returns true if the function in \p CalleeADC may be inlined in general. 739c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose/// 740c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose/// This checks static properties of the function, such as its signature and 741c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose/// CFG, to determine whether the analyzer should ever consider inlining it, 742c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose/// in any context. 743c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rosestatic bool mayInlineDecl(const CallEvent &Call, AnalysisDeclContext *CalleeADC, 744c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose AnalyzerOptions &Opts) { 745c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // FIXME: Do not inline variadic calls. 746c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (Call.isVariadic()) 747c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 748c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 749c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Check certain C++-related inlining policies. 750c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose ASTContext &Ctx = CalleeADC->getASTContext(); 751c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (Ctx.getLangOpts().CPlusPlus) { 752c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CalleeADC->getDecl())) { 753c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Conditionally control the inlining of template functions. 754c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (!Opts.mayInlineTemplateFunctions()) 755c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (FD->getTemplatedKind() != FunctionDecl::TK_NonTemplate) 756c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 757c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 758c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Conditionally control the inlining of C++ standard library functions. 759c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (!Opts.mayInlineCXXStandardLibrary()) 760c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (Ctx.getSourceManager().isInSystemHeader(FD->getLocation())) 761c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (IsInStdNamespace(FD)) 762c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 763c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose 764c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose // Conditionally control the inlining of methods on objects that look 765c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose // like C++ containers. 766c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose if (!Opts.mayInlineCXXContainerCtorsAndDtors()) 767c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose if (!Ctx.getSourceManager().isFromMainFile(FD->getLocation())) 768c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose if (isContainerCtorOrDtor(Ctx, FD)) 769c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose return false; 77050fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose 77150fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose // Conditionally control the inlining of the destructor of C++ shared_ptr. 77250fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose // We don't currently do a good job modeling shared_ptr because we can't 77350fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose // see the reference count, so treating as opaque is probably the best 77450fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose // idea. 77550fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose if (!Opts.mayInlineCXXSharedPtrDtor()) 77650fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose if (isCXXSharedPtrDtor(FD)) 77750fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose return false; 77850fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose 779c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } 780c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } 781c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 782c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // It is possible that the CFG cannot be constructed. 783c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Be safe, and check if the CalleeCFG is valid. 784c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose const CFG *CalleeCFG = CalleeADC->getCFG(); 785c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (!CalleeCFG) 786c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 787c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 788c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Do not inline large functions. 789c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (CalleeCFG->getNumBlockIDs() > Opts.getMaxInlinableSize()) 790c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 791c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 792c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // It is possible that the live variables analysis cannot be 793c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // run. If so, bail out. 794c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (!CalleeADC->getAnalysis<RelaxedLiveVariables>()) 795c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 796c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 7978dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return true; 7988dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks} 7998dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 8008dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaksbool ExprEngine::shouldInlineCall(const CallEvent &Call, const Decl *D, 8018dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const ExplodedNode *Pred) { 80242f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks if (!D) 8038dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return false; 8048dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 80542f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks AnalysisManager &AMgr = getAnalysisManager(); 80642f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks AnalyzerOptions &Opts = AMgr.options; 80742f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks AnalysisDeclContextManager &ADCMgr = AMgr.getAnalysisDeclContextManager(); 80842f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks AnalysisDeclContext *CalleeADC = ADCMgr.getContext(D); 8098dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 810046e79a425bfa82b480b8a07ce11d96391fa0a9bPavel Labath // Temporary object destructor processing is currently broken, so we never 811046e79a425bfa82b480b8a07ce11d96391fa0a9bPavel Labath // inline them. 812046e79a425bfa82b480b8a07ce11d96391fa0a9bPavel Labath // FIME: Remove this once temp destructors are working. 813046e79a425bfa82b480b8a07ce11d96391fa0a9bPavel Labath if ((*currBldrCtx->getBlock())[currStmtIdx].getAs<CFGTemporaryDtor>()) 814046e79a425bfa82b480b8a07ce11d96391fa0a9bPavel Labath return false; 815046e79a425bfa82b480b8a07ce11d96391fa0a9bPavel Labath 8168dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // The auto-synthesized bodies are essential to inline as they are 81742f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks // usually small and commonly used. Note: we should do this check early on to 8188dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // ensure we always inline these calls. 8198dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (CalleeADC->isBodyAutosynthesized()) 8208dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return true; 8218dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 8228a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks if (!AMgr.shouldInlineCall()) 8238dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return false; 8248dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 825c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Check if this function has been marked as non-inlinable. 826c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose Optional<bool> MayInline = Engine.FunctionSummaries->mayInline(D); 827c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (MayInline.hasValue()) { 828c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (!MayInline.getValue()) 829c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 830c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 831c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } else { 832c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // We haven't actually checked the static properties of this function yet. 833c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Do that now, and record our decision in the function summaries. 834c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (mayInlineDecl(Call, CalleeADC, Opts)) { 835c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose Engine.FunctionSummaries->markMayInline(D); 836c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } else { 837c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose Engine.FunctionSummaries->markShouldNotInline(D); 838c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 839c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } 840c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } 841c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 84242f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks // Check if we should inline a call based on its kind. 843c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // FIXME: this checks both static and dynamic properties of the call, which 844c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // means we're redoing a bit of work that could be cached in the function 845c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // summary. 846c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose CallInlinePolicy CIP = mayInlineCallKind(Call, Pred, Opts); 847c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (CIP != CIP_Allowed) { 848c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (CIP == CIP_DisallowedAlways) { 849c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose assert(!MayInline.hasValue() || MayInline.getValue()); 850c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose Engine.FunctionSummaries->markShouldNotInline(D); 851c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } 8528dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return false; 853c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } 8548dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 8558dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 8568dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 8578dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // Do not inline if recursive or we've reached max stack frame count. 8588dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks bool IsRecursive = false; 8598dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks unsigned StackDepth = 0; 8608dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks examineStackFrames(D, Pred->getLocationContext(), IsRecursive, StackDepth); 8618dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if ((StackDepth >= Opts.InlineMaxStackDepth) && 8628dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks ((CalleeCFG->getNumBlockIDs() > Opts.getAlwaysInlineSize()) 8638dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks || IsRecursive)) 8648dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return false; 8658dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 8668dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // Do not inline large functions too many times. 86742f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks if ((Engine.FunctionSummaries->getNumTimesInlined(D) > 86842f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks Opts.getMaxTimesInlineLarge()) && 8698dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks CalleeCFG->getNumBlockIDs() > 13) { 8708dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks NumReachedInlineCountMax++; 8718dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return false; 872453cb859a3c8dcafe79ae840dfc35ff8eae1b4b3Anna Zaks } 8738a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks 8748a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks if (HowToInline == Inline_Minimal && 8758a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks (CalleeCFG->getNumBlockIDs() > Opts.getAlwaysInlineSize() 8768a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks || IsRecursive)) 8778a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks return false; 8788a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks 8798dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks Engine.FunctionSummaries->bumpNumTimesInlined(D); 8808dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 8818dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return true; 882453cb859a3c8dcafe79ae840dfc35ff8eae1b4b3Anna Zaks} 883453cb859a3c8dcafe79ae840dfc35ff8eae1b4b3Anna Zaks 884a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rosestatic bool isTrivialObjectAssignment(const CallEvent &Call) { 885a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose const CXXInstanceCall *ICall = dyn_cast<CXXInstanceCall>(&Call); 886a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose if (!ICall) 887a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose return false; 888a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose 889a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(ICall->getDecl()); 890a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose if (!MD) 891a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose return false; 892a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose if (!(MD->isCopyAssignmentOperator() || MD->isMoveAssignmentOperator())) 893a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose return false; 894a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose 895a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose return MD->isTrivial(); 896a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose} 897a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose 898e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksvoid ExprEngine::defaultEvalCall(NodeBuilder &Bldr, ExplodedNode *Pred, 899d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const CallEvent &CallTemplate) { 900d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Make sure we have the most recent state attached to the call. 901d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef State = Pred->getState(); 902d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<> Call = CallTemplate.cloneWithState(State); 903e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 904a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose // Special-case trivial assignment operators. 905a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose if (isTrivialObjectAssignment(*Call)) { 906a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose performTrivialCopy(Bldr, Pred, *Call); 907a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose return; 908a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose } 909a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose 91069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Try to inline the call. 91128038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // The origin expression here is just used as a kind of checksum; 912d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // this should still be safe even for CallEvents that don't come from exprs. 913d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const Expr *E = Call->getOriginExpr(); 914d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 9158dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks ProgramStateRef InlinedFailedState = getInlineFailedState(State, E); 916d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose if (InlinedFailedState) { 917d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // If we already tried once and failed, make sure we don't retry later. 918d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose State = InlinedFailedState; 9195960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks } else { 920ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek RuntimeDefinition RD = Call->getRuntimeDefinition(); 921fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks const Decl *D = RD.getDecl(); 9228dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (shouldInlineCall(*Call, D, Pred)) { 923b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose if (RD.mayHaveOtherDefinitions()) { 92473f0563009a6715a5d3d41f664f5bfab5096d51fAnna Zaks AnalyzerOptions &Options = getAnalysisManager().options; 92573f0563009a6715a5d3d41f664f5bfab5096d51fAnna Zaks 926b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose // Explore with and without inlining the call. 927bfa9ab8183e2fdc74f8633d758cb0c6201314320Anna Zaks if (Options.getIPAMode() == IPAK_DynamicDispatchBifurcate) { 928b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose BifurcateCall(RD.getDispatchRegion(), *Call, D, Bldr, Pred); 929b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose return; 930b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose } 931b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose 932b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose // Don't inline if we're not in any dynamic dispatch mode. 933bfa9ab8183e2fdc74f8633d758cb0c6201314320Anna Zaks if (Options.getIPAMode() != IPAK_DynamicDispatch) { 934da29ac527063fc9714547088bf841bfa30557bf0Jordan Rose conservativeEvalCall(*Call, Bldr, Pred, State); 935b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose return; 936da29ac527063fc9714547088bf841bfa30557bf0Jordan Rose } 937e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 938b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose 9395960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // We are not bifurcating and we do have a Decl, so just inline. 9405960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (inlineCall(*Call, D, Bldr, Pred, State)) 9415960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 942e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 943e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 94469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 94569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // If we can't inline it, handle the return value and invalidate the regions. 946e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks conservativeEvalCall(*Call, Bldr, Pred, State); 947e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks} 94869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 949e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksvoid ExprEngine::BifurcateCall(const MemRegion *BifurReg, 950e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks const CallEvent &Call, const Decl *D, 951e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NodeBuilder &Bldr, ExplodedNode *Pred) { 952e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks assert(BifurReg); 953b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose BifurReg = BifurReg->StripCasts(); 954e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 955e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // Check if we've performed the split already - note, we only want 956e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // to split the path once per memory region. 957e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef State = Pred->getState(); 958166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose const unsigned *BState = 9596960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->get<DynamicDispatchBifurcationMap>(BifurReg); 9605960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (BState) { 9615960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // If we are on "inline path", keep inlining if possible. 9626960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks if (*BState == DynamicDispatchModeInlined) 9635960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (inlineCall(Call, D, Bldr, Pred, State)) 9645960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 9655960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // If inline failed, or we are on the path where we assume we 9665960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // don't have enough info about the receiver to inline, conjure the 9675960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // return value and invalidate the regions. 9685960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks conservativeEvalCall(Call, Bldr, Pred, State); 9695960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 970e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 971e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 972e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // If we got here, this is the first time we process a message to this 973e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // region, so split the path. 974e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef IState = 9756960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->set<DynamicDispatchBifurcationMap>(BifurReg, 9766960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks DynamicDispatchModeInlined); 977e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks inlineCall(Call, D, Bldr, Pred, IState); 978e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 979e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef NoIState = 9806960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->set<DynamicDispatchBifurcationMap>(BifurReg, 9816960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks DynamicDispatchModeConservative); 982e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks conservativeEvalCall(Call, Bldr, Pred, NoIState); 983e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 984e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NumOfDynamicDispatchPathSplits++; 985e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks return; 98669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 98769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 988e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 989294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitReturnStmt(const ReturnStmt *RS, ExplodedNode *Pred, 990294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &Dst) { 991256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 992256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNodeSet dstPreVisit; 993256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, RS, *this); 994256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 99566c486f275531df6362b3511fc3af6563561801bTed Kremenek StmtNodeBuilder B(dstPreVisit, Dst, *currBldrCtx); 996256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 997256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (RS->getRetValue()) { 998256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek for (ExplodedNodeSet::iterator it = dstPreVisit.begin(), 999256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ei = dstPreVisit.end(); it != ei; ++it) { 1000256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek B.generateNode(RS, *it, (*it)->getState()); 1001294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 1002294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 1003294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 1004