1294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//=-- ExprEngineCallAndReturn.cpp - Support for call/return -----*- C++ -*-===// 2294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// 3294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// The LLVM Compiler Infrastructure 4294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// 5294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// This file is distributed under the University of Illinois Open Source 6294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// License. See LICENSE.TXT for details. 7294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// 8294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//===----------------------------------------------------------------------===// 9294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// 10294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// This file defines ExprEngine's support for calls and returns. 11294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek// 12294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek//===----------------------------------------------------------------------===// 13294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 14294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h" 15ac7cc2d37e82181e73fcc265c1d0a619d18b7605Jordan Rose#include "PrettyStackTraceLocationContext.h" 1648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose#include "clang/AST/CXXInheritance.h" 17294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek#include "clang/AST/DeclCXX.h" 186fe4dfbc9e5a7018763b1d898876d9b2b8ec3425Jordan Rose#include "clang/AST/ParentMap.h" 1955fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Analysis/Analyses/LiveVariables.h" 2055fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/StaticAnalyzer/Core/CheckerManager.h" 2155fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h" 224a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/ADT/SmallSet.h" 23e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks#include "llvm/ADT/Statistic.h" 244a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/Support/SaveAndRestore.h" 25294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 26294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekusing namespace clang; 27294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekusing namespace ento; 28294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 296bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines#define DEBUG_TYPE "ExprEngine" 306bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 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 404967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainarvoid ExprEngine::processCallEnter(NodeBuilderContext& BC, CallEnter CE, 414967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar ExplodedNode *Pred) { 423070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Get the entry block in the CFG of the callee. 430849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek const StackFrameContext *calleeCtx = CE.getCalleeContext(); 44ac7cc2d37e82181e73fcc265c1d0a619d18b7605Jordan Rose PrettyStackTraceLocationContext CrashInfo(calleeCtx); 454967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar const CFGBlock *Entry = CE.getEntry(); 4687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 473070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Validate the CFG. 483070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek assert(Entry->empty()); 493070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek assert(Entry->succ_size() == 1); 5087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 51651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines // Get the solitary successor. 523070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek const CFGBlock *Succ = *(Entry->succ_begin()); 5387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 543070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek // Construct an edge representing the starting location in the callee. 550849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek BlockEdge Loc(Entry, Succ, calleeCtx); 563070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek 57e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose ProgramStateRef state = Pred->getState(); 5887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 594967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar // Construct a new node, notify checkers that analysis of the function has 604967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar // begun, and add the resultant nodes to the worklist. 613070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek bool isNew; 623070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek ExplodedNode *Node = G.getNode(Loc, state, false, &isNew); 633070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek Node->addPredecessor(Pred, G); 644967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar if (isNew) { 654967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar ExplodedNodeSet DstBegin; 664967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar processBeginOfFunction(BC, Node, DstBegin, Loc); 674967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar Engine.enqueue(DstBegin); 684967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar } 69294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 70294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 710b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// Find the last statement on the path to the exploded node and the 720b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks// corresponding Block. 730b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksstatic std::pair<const Stmt*, 740b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const CFGBlock*> getLastStmt(const ExplodedNode *Node) { 756bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const Stmt *S = nullptr; 766bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const CFGBlock *Blk = nullptr; 770b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *SF = 780b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Node->getLocation().getLocationContext()->getCurrentStackFrame(); 79888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 80632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // Back up through the ExplodedGraph until we reach a statement node in this 81632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // stack frame. 82256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek while (Node) { 83256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek const ProgramPoint &PP = Node->getLocation(); 84888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 85632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose if (PP.getLocationContext()->getCurrentStackFrame() == SF) { 867a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<StmtPoint> SP = PP.getAs<StmtPoint>()) { 87632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose S = SP->getStmt(); 88888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 897a95de68c093991047ed8d339479ccad51b88663David Blaikie } else if (Optional<CallExitEnd> CEE = PP.getAs<CallExitEnd>()) { 90632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose S = CEE->getCalleeContext()->getCallSite(); 91632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose if (S) 92632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose break; 93632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose 94632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // If there is no statement, this is an implicitly-generated call. 95632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // We'll walk backwards over it and then continue the loop to find 96632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // an actual statement. 977a95de68c093991047ed8d339479ccad51b88663David Blaikie Optional<CallEnter> CE; 98632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose do { 99632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose Node = Node->getFirstPred(); 100632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose CE = Node->getLocationAs<CallEnter>(); 101632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose } while (!CE || CE->getCalleeContext() != CEE->getCalleeContext()); 102632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose 103632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose // Continue searching the graph. 1047a95de68c093991047ed8d339479ccad51b88663David Blaikie } else if (Optional<BlockEdge> BE = PP.getAs<BlockEdge>()) { 1054ecca28e20410f5e2816c5ddff5cdeaf45fb74b5Jordan Rose Blk = BE->getSrc(); 106632e5022f68fcae3b68bbc90538a60f3ba20229fJordan Rose } 1077a95de68c093991047ed8d339479ccad51b88663David Blaikie } else if (Optional<CallEnter> CE = PP.getAs<CallEnter>()) { 108888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose // If we reached the CallEnter for this function, it has no statements. 109888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose if (CE->getCalleeContext() == SF) 110888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose break; 111256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 112888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 1138501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks if (Node->pred_empty()) 1146bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return std::make_pair(nullptr, nullptr); 1158501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 116888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose Node = *Node->pred_begin(); 117256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 118888c90ac0ef6baf7d47e86cf5cc4715707d223b1Jordan Rose 1196bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return std::make_pair(S, Blk); 120256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 121256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 12248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// Adjusts a return value when the called function's return type does not 12348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// match the caller's expression type. This can happen when a dynamic call 12448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// is devirtualized, and the overridding method has a covariant (more specific) 12548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// return type than the parent's method. For C++ objects, this means we need 12648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose/// to add base casts. 12748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rosestatic SVal adjustReturnValue(SVal V, QualType ExpectedTy, QualType ActualTy, 12848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose StoreManager &StoreMgr) { 12948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // For now, the only adjustments we handle apply only to locations. 1305251abea41b446c26e3239c8dd6c7edea6fc335dDavid Blaikie if (!V.getAs<Loc>()) 13148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 13248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 13348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // If the types already match, don't do any unnecessary work. 134e7ad14e18247ec6fc3d46b208829e3dac6d85a1dAnna Zaks ExpectedTy = ExpectedTy.getCanonicalType(); 135e7ad14e18247ec6fc3d46b208829e3dac6d85a1dAnna Zaks ActualTy = ActualTy.getCanonicalType(); 13648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedTy == ActualTy) 13748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 13848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 13948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // No adjustment is needed between Objective-C pointer types. 14048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedTy->isObjCObjectPointerType() && 14148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose ActualTy->isObjCObjectPointerType()) 14248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return V; 14348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 14448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // C++ object pointers may need "derived-to-base" casts. 14548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose const CXXRecordDecl *ExpectedClass = ExpectedTy->getPointeeCXXRecordDecl(); 14648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose const CXXRecordDecl *ActualClass = ActualTy->getPointeeCXXRecordDecl(); 14748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ExpectedClass && ActualClass) { 14848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CXXBasePaths Paths(/*FindAmbiguities=*/true, /*RecordPaths=*/true, 14948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose /*DetectVirtual=*/false); 15048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (ActualClass->isDerivedFrom(ExpectedClass, Paths) && 15148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose !Paths.isAmbiguous(ActualTy->getCanonicalTypeUnqualified())) { 15248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return StoreMgr.evalDerivedToBase(V, Paths.front()); 15348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 15448314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 15548314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 15648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Unfortunately, Objective-C does not enforce that overridden methods have 15748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // covariant return types, so we can't assert that that never happens. 15848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Be safe and return UnknownVal(). 15948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose return UnknownVal(); 16048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose} 16148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 1628501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaksvoid ExprEngine::removeDeadOnEndOfFunction(NodeBuilderContext& BC, 1638501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks ExplodedNode *Pred, 1648501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks ExplodedNodeSet &Dst) { 1658501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks // Find the last statement in the function and the corresponding basic block. 1666bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const Stmt *LastSt = nullptr; 1676bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const CFGBlock *Blk = nullptr; 168651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines std::tie(LastSt, Blk) = getLastStmt(Pred); 1698501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks if (!Blk || !LastSt) { 17084c484545c5906ba55143e212b4a5275ab55889fJordan Rose Dst.Add(Pred); 1718501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks return; 1728501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks } 1738501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 17463bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // Here, we destroy the current location context. We use the current 17563bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // function's entire body as a diagnostic statement, with which the program 17663bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // point will be associated. However, we only want to use LastStmt as a 17763bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // reference for what to clean up if it's a ReturnStmt; otherwise, everything 17863bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // is dead. 17984c484545c5906ba55143e212b4a5275ab55889fJordan Rose SaveAndRestore<const NodeBuilderContext *> NodeContextRAII(currBldrCtx, &BC); 18063bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose const LocationContext *LCtx = Pred->getLocationContext(); 18163bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose removeDead(Pred, Dst, dyn_cast<ReturnStmt>(LastSt), LCtx, 18263bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose LCtx->getAnalysisDeclContext()->getBody(), 1838501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks ProgramPoint::PostStmtPurgeDeadSymbolsKind); 1848501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks} 1858501b7a1c4c4a9ba0ea6cb8e500e601ef3759debAnna Zaks 186bae930d4c69a624881e66f1628ee615e149362f7Anna Zaksstatic bool wasDifferentDeclUsedForInlining(CallEventRef<> Call, 187d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks const StackFrameContext *calleeCtx) { 188d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks const Decl *RuntimeCallee = calleeCtx->getDecl(); 189d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks const Decl *StaticDecl = Call->getDecl(); 190bae930d4c69a624881e66f1628ee615e149362f7Anna Zaks assert(RuntimeCallee); 191bae930d4c69a624881e66f1628ee615e149362f7Anna Zaks if (!StaticDecl) 192bae930d4c69a624881e66f1628ee615e149362f7Anna Zaks return true; 193d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks return RuntimeCallee->getCanonicalDecl() != StaticDecl->getCanonicalDecl(); 194d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks} 195d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks 196bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose/// Returns true if the CXXConstructExpr \p E was intended to construct a 197bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose/// prvalue for the region in \p V. 198bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose/// 199bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose/// Note that we can't just test for rvalue vs. glvalue because 200bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose/// CXXConstructExprs embedded in DeclStmts and initializers are considered 201bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose/// rvalues by the AST, and the analyzer would like to treat them as lvalues. 202bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rosestatic bool isTemporaryPRValue(const CXXConstructExpr *E, SVal V) { 203bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose if (E->isGLValue()) 204bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose return false; 205bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose 206bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose const MemRegion *MR = V.getAsRegion(); 207bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose if (!MR) 208bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose return false; 209bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose 210bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose return isa<CXXTempObjectRegion>(MR); 211bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose} 212bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose 21387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar/// The call exit is simulated with a sequence of nodes, which occur between 21487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar/// CallExitBegin and CallExitEnd. The following operations occur between the 2150b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// two program points: 2160b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 1. CallExitBegin (triggers the start of call exit sequence) 2170b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 2. Bind the return value 2180b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 3. Run Remove dead bindings to clean up the dead symbols from the callee. 2190b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 4. CallExitEnd (switch to the caller context) 2200b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks/// 5. PostStmt<CallExpr> 2210b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaksvoid ExprEngine::processCallExit(ExplodedNode *CEBNode) { 2220b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 1 CEBNode was generated before the call. 223ac7cc2d37e82181e73fcc265c1d0a619d18b7605Jordan Rose PrettyStackTraceLocationContext CrashInfo(CEBNode->getLocationContext()); 2240b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks const StackFrameContext *calleeCtx = 2250b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEBNode->getLocationContext()->getCurrentStackFrame(); 22687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 2277fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // The parent context might not be a stack frame, so make sure we 2287fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // look up the first enclosing stack frame. 2297fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *callerCtx = 2307fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek calleeCtx->getParent()->getCurrentStackFrame(); 23187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 232294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek const Stmt *CE = calleeCtx->getCallSite(); 2330b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramStateRef state = CEBNode->getState(); 2340b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Find the last statement in the function and the corresponding basic block. 2356bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const Stmt *LastSt = nullptr; 2366bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const CFGBlock *Blk = nullptr; 237651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines std::tie(LastSt, Blk) = getLastStmt(CEBNode); 2380b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 23948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // Generate a CallEvent /before/ cleaning the state, so that we can get the 24048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose // correct value for 'this' (if necessary). 24148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 24248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose CallEventRef<> Call = CEMgr.getCaller(calleeCtx, state); 24348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 244852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Step 2: generate node with bound return value: CEBNode -> BindedRetNode. 2450b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 246294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // If the callee returns an expression, bind its value to CallExpr. 247852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (CE) { 248852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const ReturnStmt *RS = dyn_cast_or_null<ReturnStmt>(LastSt)) { 249852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose const LocationContext *LCtx = CEBNode->getLocationContext(); 250852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal V = state->getSVal(RS, LCtx); 25148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 252d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks // Ensure that the return type matches the type of the returned Expr. 253bae930d4c69a624881e66f1628ee615e149362f7Anna Zaks if (wasDifferentDeclUsedForInlining(Call, calleeCtx)) { 254d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks QualType ReturnedTy = 255d51db4935736fd943bfd46dfa74d41e9a3c2d41fAnna Zaks CallEvent::getDeclaredResultType(calleeCtx->getDecl()); 25648314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (!ReturnedTy.isNull()) { 25748314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose if (const Expr *Ex = dyn_cast<Expr>(CE)) { 25848314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose V = adjustReturnValue(V, Ex->getType(), ReturnedTy, 25948314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose getStoreManager()); 26048314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 26148314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 26248314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose } 26348314cf6a289bc5a082d8c769c58a38f924c93b7Jordan Rose 26457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose state = state->BindExpr(CE, callerCtx, V); 265852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 2660b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 267852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // Bind the constructed object value to CXXConstructExpr. 268852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(CE)) { 269852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose loc::MemRegionVal This = 270852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose svalBuilder.getCXXThis(CCE->getConstructor()->getParent(), calleeCtx); 271852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose SVal ThisV = state->getSVal(This); 2720b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 273bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose // If the constructed object is a temporary prvalue, get its bindings. 274bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose if (isTemporaryPRValue(CCE, ThisV)) 2755251abea41b446c26e3239c8dd6c7edea6fc335dDavid Blaikie ThisV = state->getSVal(ThisV.castAs<Loc>()); 2760504a598a5dc8f3f45e79d4f8ea206a926507859Jordan Rose 27757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose state = state->BindExpr(CCE, callerCtx, ThisV); 278852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 279294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 2800b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 2810b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 3: BindedRetNode -> CleanedNodes 2820b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // If we can find a statement and a block in the inlined function, run remove 2830b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // dead bindings before returning from the call. This is important to ensure 2840b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // that we report the issues such as leaks in the stack contexts in which 2850b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // they occurred. 2860b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ExplodedNodeSet CleanedNodes; 287255d4d4226b24036ceb11228fbb74286e58620f7Ted Kremenek if (LastSt && Blk && AMgr.options.AnalysisPurgeOpt != PurgeNone) { 288651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines static SimpleProgramPointTag retValBind("ExprEngine", "Bind Return Value"); 28948b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose PostStmt Loc(LastSt, calleeCtx, &retValBind); 29048b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose bool isNew; 29148b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *BindedRetNode = G.getNode(Loc, state, false, &isNew); 29248b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose BindedRetNode->addPredecessor(CEBNode, G); 29348b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose if (!isNew) 29448b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose return; 29548b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose 2960b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(getCoreEngine(), Blk, BindedRetNode); 29766c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx = &Ctx; 29884c484545c5906ba55143e212b4a5275ab55889fJordan Rose // Here, we call the Symbol Reaper with 0 statement and callee location 2990b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // context, telling it to clean up everything in the callee's context 30063bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // (and its children). We use the callee's function body as a diagnostic 30163bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose // statement, with which the program point will be associated. 3026bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines removeDead(BindedRetNode, CleanedNodes, nullptr, calleeCtx, 30363bc186d6ac0b44ba4ec6fccb5f471b05c79b666Jordan Rose calleeCtx->getAnalysisDeclContext()->getBody(), 3040b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks ProgramPoint::PostStmtPurgeDeadSymbolsKind); 3056bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines currBldrCtx = nullptr; 306144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks } else { 307144e52be486a3906aec90c51b0ac94a30313152eAnna Zaks CleanedNodes.Add(CEBNode); 3080b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 3090b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3100b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator I = CleanedNodes.begin(), 3110b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks E = CleanedNodes.end(); I != E; ++I) { 3120b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3130b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 4: Generate the CallExit and leave the callee's context. 3140b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CleanedNodes -> CEENode 315852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose CallExitEnd Loc(calleeCtx, callerCtx); 3160b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks bool isNew; 31748b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ProgramStateRef CEEState = (*I == CEBNode) ? state : (*I)->getState(); 31848b6247804eacc262cc5508e0fbb74ed819fbb6eJordan Rose ExplodedNode *CEENode = G.getNode(Loc, CEEState, false, &isNew); 3190b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks CEENode->addPredecessor(*I, G); 3200b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks if (!isNew) 3210b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks return; 3220b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3230b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Step 5: Perform the post-condition check of the CallExpr and enqueue the 3240b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // result onto the work list. 3250b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // CEENode -> Dst -> WorkList 3260b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks NodeBuilderContext Ctx(Engine, calleeCtx->getCallSiteBlock(), CEENode); 32766c486f275531df6362b3511fc3af6563561801bTed Kremenek SaveAndRestore<const NodeBuilderContext*> NBCSave(currBldrCtx, 3280b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks &Ctx); 32966c486f275531df6362b3511fc3af6563561801bTed Kremenek SaveAndRestore<unsigned> CBISave(currStmtIdx, calleeCtx->getIndex()); 3300b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3314e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose CallEventRef<> UpdatedCall = Call.cloneWithState(CEEState); 33257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 33357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose ExplodedNodeSet DstPostCall; 3344e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose getCheckerManager().runCheckersForPostCall(DstPostCall, CEENode, 3354e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *UpdatedCall, *this, 3364e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose /*WasInlined=*/true); 33757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 33857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose ExplodedNodeSet Dst; 3394e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(Call)) { 3404e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose getCheckerManager().runCheckersForPostObjCMessage(Dst, DstPostCall, *Msg, 3414e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *this, 3424e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose /*WasInlined=*/true); 34357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } else if (CE) { 34457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getCheckerManager().runCheckersForPostStmt(Dst, DstPostCall, CE, 3454e79fdfe22db1c982e8fdf8397fee426a8c57821Jordan Rose *this, /*WasInlined=*/true); 34657c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } else { 34757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose Dst.insert(DstPostCall); 34857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } 3490b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks 3500b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks // Enqueue the next element in the block. 3510b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks for (ExplodedNodeSet::iterator PSI = Dst.begin(), PSE = Dst.end(); 3520b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks PSI != PSE; ++PSI) { 3530b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks Engine.getWorkList()->enqueue(*PSI, calleeCtx->getCallSiteBlock(), 3540b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks calleeCtx->getIndex()+1); 3550b3ade86a1c60cf0c7b56aa238aff458eb7f5974Anna Zaks } 356242384ddb0e0b65dd7e9e0ac0cf3c31cf98b06a6Ted Kremenek } 357294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 358294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 3594ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaksvoid ExprEngine::examineStackFrames(const Decl *D, const LocationContext *LCtx, 3607229d0011766c174beffe6a846d78f448f845b39Anna Zaks bool &IsRecursive, unsigned &StackDepth) { 3617229d0011766c174beffe6a846d78f448f845b39Anna Zaks IsRecursive = false; 3627229d0011766c174beffe6a846d78f448f845b39Anna Zaks StackDepth = 0; 3634ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3640849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek while (LCtx) { 3657229d0011766c174beffe6a846d78f448f845b39Anna Zaks if (const StackFrameContext *SFC = dyn_cast<StackFrameContext>(LCtx)) { 3664ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks const Decl *DI = SFC->getDecl(); 3674ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3684ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // Mark recursive (and mutually recursive) functions and always count 3694ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // them when measuring the stack depth. 3704ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks if (DI == D) { 3717229d0011766c174beffe6a846d78f448f845b39Anna Zaks IsRecursive = true; 3724ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks ++StackDepth; 3734ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks LCtx = LCtx->getParent(); 3744ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks continue; 3754ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks } 3764ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks 3774ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks // Do not count the small functions when determining the stack depth. 3784ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(DI); 3794ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 3804ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks if (CalleeCFG->getNumBlockIDs() > AMgr.options.getAlwaysInlineSize()) 3814ea9b89ff6dc50d5404eb56cad5e5870bce49ef2Anna Zaks ++StackDepth; 3827229d0011766c174beffe6a846d78f448f845b39Anna Zaks } 3830849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek LCtx = LCtx->getParent(); 3840849ade4bb3e90c2fc0ce01ccd330f76f91da732Ted Kremenek } 38581fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose} 38681fb50e8b120fc95dc0245b4112972d4d7cca3b5Jordan Rose 387166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// The GDM component containing the dynamic dispatch bifurcation info. When 388166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// the exact type of the receiver is not known, we want to explore both paths - 389166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// one on which we do inline it and the other one on which we don't. This is 390166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// done to ensure we do not drop coverage. 391166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// This is the map from the receiver region to a bool, specifying either we 392166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose// consider this region's information precise or not along the given path. 393166d502d5367ceacd1313a33cac43b1048b8524dJordan Rosenamespace { 394166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose enum DynamicDispatchMode { 395166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose DynamicDispatchModeInlined = 1, 396166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose DynamicDispatchModeConservative 397166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose }; 3984967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar} // end anonymous namespace 3994967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar 40040d8551890bc8454c4e0a28c9072c9c1d1dd588aJordan RoseREGISTER_TRAIT_WITH_PROGRAMSTATE(DynamicDispatchBifurcationMap, 40140d8551890bc8454c4e0a28c9072c9c1d1dd588aJordan Rose CLANG_ENTO_PROGRAMSTATE_MAP(const MemRegion *, 40240d8551890bc8454c4e0a28c9072c9c1d1dd588aJordan Rose unsigned)) 403e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 404e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksbool ExprEngine::inlineCall(const CallEvent &Call, const Decl *D, 405e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NodeBuilder &Bldr, ExplodedNode *Pred, 406e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef State) { 407e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks assert(D); 408ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 409c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const LocationContext *CurLC = Pred->getLocationContext(); 410c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const StackFrameContext *CallerSFC = CurLC->getCurrentStackFrame(); 4118dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const LocationContext *ParentOfCallee = CallerSFC; 41287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar if (Call.getKind() == CE_Block && 41387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar !cast<BlockCall>(Call).isConversionFromLambda()) { 41469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDataRegion *BR = cast<BlockCall>(Call).getBlockRegion(); 415ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose assert(BR && "If we have the block definition we should have its region"); 41669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose AnalysisDeclContext *BlockCtx = AMgr.getAnalysisDeclContext(D); 4177fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ParentOfCallee = BlockCtx->getBlockInvocationContext(CallerSFC, 41869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose cast<BlockDecl>(D), 4197fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek BR); 420256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek } 42187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 422852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // This may be NULL, but that's fine. 42369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Expr *CallE = Call.getOriginExpr(); 42469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 4257fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // Construct a new stack frame for the callee. 4267fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 4277fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const StackFrameContext *CalleeSFC = 42869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose CalleeADC->getStackFrame(ParentOfCallee, CallE, 42966c486f275531df6362b3511fc3af6563561801bTed Kremenek currBldrCtx->getBlock(), 43066c486f275531df6362b3511fc3af6563561801bTed Kremenek currStmtIdx); 43187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 432c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CallEnter Loc(CallE, CalleeSFC, CurLC); 433e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 434e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // Construct a new state which contains the mapping from actual to 435e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // formal arguments. 436e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks State = State->enterStackFrame(Call, CalleeSFC); 437e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 4387fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek bool isNew; 439e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose if (ExplodedNode *N = G.getNode(Loc, State, false, &isNew)) { 4407fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek N->addPredecessor(Pred, G); 4417fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek if (isNew) 4427fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek Engine.getWorkList()->enqueue(N); 4437fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek } 444e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 445e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // If we decided to inline the call, the successor has been manually 446e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // added onto the work list so remove it from the node builder. 447e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks Bldr.takeNodes(Pred); 448e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 449210f5a28227c90d739298e3e6729e827858fe397Anna Zaks NumInlinedCalls++; 450210f5a28227c90d739298e3e6729e827858fe397Anna Zaks 451fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks // Mark the decl as visited. 452fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks if (VisitedCallees) 453fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks VisitedCallees->insert(D); 454fbcb3f11fc90e9f00e6074e9b118b8dc11ca604cAnna Zaks 4557fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek return true; 456256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek} 457256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 458e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksstatic ProgramStateRef getInlineFailedState(ProgramStateRef State, 45969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const Stmt *CallE) { 460bdc691f1d61765dd806d5ae3b75ae004f676a7c9Jordan Rose const void *ReplayState = State->get<ReplayWithoutInlining>(); 4615903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks if (!ReplayState) 4626bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 46328038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 464bdc691f1d61765dd806d5ae3b75ae004f676a7c9Jordan Rose assert(ReplayState == CallE && "Backtracked to the wrong call."); 46528038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose (void)CallE; 46628038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 467e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->remove<ReplayWithoutInlining>(); 46810520d76044e8fff71d414f30c21b449fd104960Ted Kremenek} 46910520d76044e8fff71d414f30c21b449fd104960Ted Kremenek 470294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred, 471294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &dst) { 472294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Perform the previsit of the CallExpr. 473294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstPreVisit; 474294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, CE, *this); 475500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose 476d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Get the call in its initial state. We use this as a template to perform 477d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // all the checks. 478d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventManager &CEMgr = getStateManager().getCallEventManager(); 479645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CallEventRef<> CallTemplate 480d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose = CEMgr.getSimpleCall(CE, Pred->getState(), Pred->getLocationContext()); 48169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 48269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Evaluate the function call. We try each of the checkers 483294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // to see if the can evaluate the function call. 484294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet dstCallEvaluated; 48569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose for (ExplodedNodeSet::iterator I = dstPreVisit.begin(), E = dstPreVisit.end(); 48669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose I != E; ++I) { 487d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose evalCall(dstCallEvaluated, *I, *CallTemplate); 48869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose } 48969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 490294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // Finally, perform the post-condition check of the CallExpr and store 491294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek // the created nodes in 'Dst'. 49269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Note that if the call was inlined, dstCallEvaluated will be empty. 49369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // The post-CallExpr check will occur in processCallExit. 494294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek getCheckerManager().runCheckersForPostStmt(dst, dstCallEvaluated, CE, 495294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek *this); 496294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 497294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek 49869f87c956b3ac2b80124fd9604af012e1061473aJordan Rosevoid ExprEngine::evalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred, 499645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const CallEvent &Call) { 500d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // WARNING: At this time, the state attached to 'Call' may be older than the 501d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // state in 'Pred'. This is a minor optimization since CheckerManager will 502d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // use an updated CallEvent instance when calling checkers, but if 'Call' is 503d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // ever used directly in this function all callers should be updated to pass 504d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // the most recent state. (It is probably not worth doing the work here since 505d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // for some callers this will not be necessary.) 506d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 50796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Run any pre-call checks using the generic call interface. 50896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstPreVisit; 50996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPreCall(dstPreVisit, Pred, Call, *this); 51096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 51196479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Actually evaluate the function call. We try each of the checkers 51296479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // to see if the can evaluate the function call, and get a callback at 51396479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // defaultEvalCall if all of them fail. 51496479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose ExplodedNodeSet dstCallEvaluated; 51596479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForEvalCall(dstCallEvaluated, dstPreVisit, 51696479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 51796479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose 51896479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose // Finally, run any post-call checks. 51996479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose getCheckerManager().runCheckersForPostCall(Dst, dstCallEvaluated, 52096479da6ad9d921d875e7be29fe1bfa127be8069Jordan Rose Call, *this); 52169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 52269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 523e81ce256b62717dd846bd19aecc4115a0dcd4995Anna ZaksProgramStateRef ExprEngine::bindReturnValue(const CallEvent &Call, 524e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const LocationContext *LCtx, 525e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks ProgramStateRef State) { 526e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks const Expr *E = Call.getOriginExpr(); 527e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (!E) 528e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State; 529e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 530e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Some method families have known return values. 531e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(&Call)) { 532e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks switch (Msg->getMethodFamily()) { 533e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks default: 534e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks break; 535e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_autorelease: 536e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_retain: 537e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks case OMF_self: { 538e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // These methods return their receivers. 539e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, Msg->getReceiverSVal()); 540e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 541e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 542e460c46c5d602f65354cab0879c458890273591cJordan Rose } else if (const CXXConstructorCall *C = dyn_cast<CXXConstructorCall>(&Call)){ 543bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose SVal ThisV = C->getCXXThisVal(); 544bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose 545bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose // If the constructed object is a temporary prvalue, get its bindings. 546bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose if (isTemporaryPRValue(cast<CXXConstructExpr>(E), ThisV)) 5475251abea41b446c26e3239c8dd6c7edea6fc335dDavid Blaikie ThisV = State->getSVal(ThisV.castAs<Loc>()); 548bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose 549bc403861bc4e6f7ad1371e9e129f0f25b38b3a9aJordan Rose return State->BindExpr(E, LCtx, ThisV); 550e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 551e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 552e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks // Conjure a symbol if the return value is unknown. 553e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks QualType ResultTy = Call.getResultType(); 554e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks SValBuilder &SVB = getSValBuilder(); 55566c486f275531df6362b3511fc3af6563561801bTed Kremenek unsigned Count = currBldrCtx->blockCount(); 5566bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines SVal R = SVB.conjureSymbolVal(nullptr, E, LCtx, ResultTy, Count); 557e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks return State->BindExpr(E, LCtx, R); 558e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks} 559e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 560e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks// Conservatively evaluate call by invalidating regions and binding 561e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks// a conjured return value. 562e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksvoid ExprEngine::conservativeEvalCall(const CallEvent &Call, NodeBuilder &Bldr, 56342f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks ExplodedNode *Pred, 56442f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks ProgramStateRef State) { 56566c486f275531df6362b3511fc3af6563561801bTed Kremenek State = Call.invalidateRegions(currBldrCtx->blockCount(), State); 566e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks State = bindReturnValue(Call, Pred->getLocationContext(), State); 567e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 568e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // And make the result node. 569e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks Bldr.generateNode(Call.getProgramPoint(), State, Pred); 570e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks} 571e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 572c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Roseenum CallInlinePolicy { 573c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose CIP_Allowed, 574c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose CIP_DisallowedOnce, 575c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose CIP_DisallowedAlways 576c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose}; 577c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 578c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rosestatic CallInlinePolicy mayInlineCallKind(const CallEvent &Call, 579c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose const ExplodedNode *Pred, 580c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose AnalyzerOptions &Opts) { 5818dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const LocationContext *CurLC = Pred->getLocationContext(); 5828dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const StackFrameContext *CallerSFC = CurLC->getCurrentStackFrame(); 5838dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks switch (Call.getKind()) { 5848dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_Function: 5858dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_Block: 5868dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks break; 5878dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_CXXMember: 5888dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_CXXMemberOperator: 5898dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!Opts.mayInlineCXXMemberFunction(CIMK_MemberFunctions)) 590c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 5918dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks break; 5928dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_CXXConstructor: { 5938dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!Opts.mayInlineCXXMemberFunction(CIMK_Constructors)) 594c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 5958dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 5968dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const CXXConstructorCall &Ctor = cast<CXXConstructorCall>(Call); 5978dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 5988dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // FIXME: We don't handle constructors or destructors for arrays properly. 599ecee1651c100342366a9417c85c6e50399039930Jordan Rose // Even once we do, we still need to be careful about implicitly-generated 600ecee1651c100342366a9417c85c6e50399039930Jordan Rose // initializers for array fields in default move/copy constructors. 6018dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const MemRegion *Target = Ctor.getCXXThisVal().getAsRegion(); 6028dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (Target && isa<ElementRegion>(Target)) 603c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedOnce; 6048dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6058dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // FIXME: This is a hack. We don't use the correct region for a new 6068dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // expression, so if we inline the constructor its result will just be 6078dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // thrown away. This short-term hack is tracked in <rdar://problem/12180598> 6088dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // and the longer-term possible fix is discussed in PR12014. 6098dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const CXXConstructExpr *CtorExpr = Ctor.getOriginExpr(); 6108dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (const Stmt *Parent = CurLC->getParentMap().getParent(CtorExpr)) 6118dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (isa<CXXNewExpr>(Parent)) 612c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedOnce; 6138dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6148dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // Inlining constructors requires including initializers in the CFG. 6158dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 6168dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks assert(ADC->getCFGBuildOptions().AddInitializers && "No CFG initializers"); 6178dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks (void)ADC; 6188dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6198dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // If the destructor is trivial, it's always safe to inline the constructor. 6208dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (Ctor.getDecl()->getParent()->hasTrivialDestructor()) 6218dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks break; 6228dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6238dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // For other types, only inline constructors if destructor inlining is 6248dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // also enabled. 6258dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!Opts.mayInlineCXXMemberFunction(CIMK_Destructors)) 626c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 6278dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6288dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // FIXME: This is a hack. We don't handle temporary destructors 6298dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // right now, so we shouldn't inline their constructors. 6308dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (CtorExpr->getConstructionKind() == CXXConstructExpr::CK_Complete) 6318dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!Target || !isa<DeclRegion>(Target)) 632c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedOnce; 6338dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6348dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks break; 6358dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks } 6368dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_CXXDestructor: { 6378dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!Opts.mayInlineCXXMemberFunction(CIMK_Destructors)) 638c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 6398dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6408dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // Inlining destructors requires building the CFG correctly. 6418dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 6428dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks assert(ADC->getCFGBuildOptions().AddImplicitDtors && "No CFG destructors"); 6438dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks (void)ADC; 6448dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6458dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const CXXDestructorCall &Dtor = cast<CXXDestructorCall>(Call); 6468dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6478dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // FIXME: We don't handle constructors or destructors for arrays properly. 6488dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const MemRegion *Target = Dtor.getCXXThisVal().getAsRegion(); 6498dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (Target && isa<ElementRegion>(Target)) 650c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedOnce; 6518dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 6528dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks break; 6538dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks } 6548dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_CXXAllocator: 655651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines if (Opts.mayInlineCXXAllocator()) 656651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines break; 6578dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // Do not inline allocators until we model deallocators. 6588dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // This is unfortunate, but basically necessary for smart pointers and such. 659c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 6608dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks case CE_ObjCMessage: 6618dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!Opts.mayInlineObjCMethod()) 662c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 6638dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (!(Opts.getIPAMode() == IPAK_DynamicDispatch || 6648dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks Opts.getIPAMode() == IPAK_DynamicDispatchBifurcate)) 665c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_DisallowedAlways; 6668dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks break; 6678dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks } 668c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 669c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return CIP_Allowed; 670c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose} 671c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 672776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose/// Returns true if the given C++ class contains a member with the given name. 673776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rosestatic bool hasMember(const ASTContext &Ctx, const CXXRecordDecl *RD, 674776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose StringRef Name) { 675776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose const IdentifierInfo &II = Ctx.Idents.get(Name); 676776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose DeclarationName DeclName = Ctx.DeclarationNames.getIdentifier(&II); 677776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose if (!RD->lookup(DeclName).empty()) 678c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose return true; 679776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose 680776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose CXXBasePaths Paths(false, false, false); 68187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar if (RD->lookupInBases( 68287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar [DeclName](const CXXBaseSpecifier *Specifier, CXXBasePath &Path) { 68387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar return CXXRecordDecl::FindOrdinaryMember(Specifier, Path, DeclName); 68487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar }, 68587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar Paths)) 686c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose return true; 687c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose 688c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose return false; 689c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose} 690c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose 691776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose/// Returns true if the given C++ class is a container or iterator. 692776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose/// 693776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose/// Our heuristic for this is whether it contains a method named 'begin()' or a 694776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose/// nested type named 'iterator' or 'iterator_category'. 695776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rosestatic bool isContainerClass(const ASTContext &Ctx, const CXXRecordDecl *RD) { 696776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose return hasMember(Ctx, RD, "begin") || 697776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose hasMember(Ctx, RD, "iterator") || 698776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose hasMember(Ctx, RD, "iterator_category"); 699776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose} 700776d3bb65c90278b9c65544b235d2ac40aea1d6eJordan Rose 701c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines/// Returns true if the given function refers to a method of a C++ container 702c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines/// or iterator. 703c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose/// 704c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines/// We generally do a poor job modeling most containers right now, and might 705c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines/// prefer not to inline their methods. 706c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hinesstatic bool isContainerMethod(const ASTContext &Ctx, 707c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines const FunctionDecl *FD) { 708c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) 709c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines return isContainerClass(Ctx, MD->getParent()); 710c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines return false; 711c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose} 712c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose 71350fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose/// Returns true if the given function is the destructor of a class named 71450fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose/// "shared_ptr". 71550fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rosestatic bool isCXXSharedPtrDtor(const FunctionDecl *FD) { 71650fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose const CXXDestructorDecl *Dtor = dyn_cast<CXXDestructorDecl>(FD); 71750fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose if (!Dtor) 71850fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose return false; 71950fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose 72050fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose const CXXRecordDecl *RD = Dtor->getParent(); 72150fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose if (const IdentifierInfo *II = RD->getDeclName().getAsIdentifierInfo()) 72250fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose if (II->isStr("shared_ptr")) 72350fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose return true; 72450fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose 72550fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose return false; 72650fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose} 72750fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose 728c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose/// Returns true if the function in \p CalleeADC may be inlined in general. 729c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose/// 730c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose/// This checks static properties of the function, such as its signature and 731c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose/// CFG, to determine whether the analyzer should ever consider inlining it, 732c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose/// in any context. 7339b072b31ee2f41b8e30d1d22142c9ab72ac5ff1fJordan Rosestatic bool mayInlineDecl(AnalysisDeclContext *CalleeADC, 734c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose AnalyzerOptions &Opts) { 735c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // FIXME: Do not inline variadic calls. 7369b072b31ee2f41b8e30d1d22142c9ab72ac5ff1fJordan Rose if (CallEvent::isVariadic(CalleeADC->getDecl())) 737c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 738c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 739c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Check certain C++-related inlining policies. 740c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose ASTContext &Ctx = CalleeADC->getASTContext(); 741c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (Ctx.getLangOpts().CPlusPlus) { 742c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CalleeADC->getDecl())) { 743c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Conditionally control the inlining of template functions. 744c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (!Opts.mayInlineTemplateFunctions()) 745c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (FD->getTemplatedKind() != FunctionDecl::TK_NonTemplate) 746c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 747c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 748c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Conditionally control the inlining of C++ standard library functions. 749c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (!Opts.mayInlineCXXStandardLibrary()) 750c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (Ctx.getSourceManager().isInSystemHeader(FD->getLocation())) 7514967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar if (AnalysisDeclContext::isInStdNamespace(FD)) 752c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 753c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose 754c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose // Conditionally control the inlining of methods on objects that look 755c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose // like C++ containers. 756c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines if (!Opts.mayInlineCXXContainerMethods()) 75724146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman if (!Ctx.getSourceManager().isInMainFile(FD->getLocation())) 758c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines if (isContainerMethod(Ctx, FD)) 759c63a460d78a7625ff38d2b3580f78030c44f07dbJordan Rose return false; 76087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 76150fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose // Conditionally control the inlining of the destructor of C++ shared_ptr. 76250fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose // We don't currently do a good job modeling shared_ptr because we can't 76350fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose // see the reference count, so treating as opaque is probably the best 76450fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose // idea. 76550fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose if (!Opts.mayInlineCXXSharedPtrDtor()) 76650fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose if (isCXXSharedPtrDtor(FD)) 76750fa64d4411a42e0b4f373a84d8d4f5cbf339ea3Jordan Rose return false; 768c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } 769c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } 770c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 771c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // It is possible that the CFG cannot be constructed. 772c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Be safe, and check if the CalleeCFG is valid. 773c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose const CFG *CalleeCFG = CalleeADC->getCFG(); 774c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (!CalleeCFG) 775c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 776c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 777c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Do not inline large functions. 778c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (CalleeCFG->getNumBlockIDs() > Opts.getMaxInlinableSize()) 779c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 780c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 781c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // It is possible that the live variables analysis cannot be 782c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // run. If so, bail out. 783c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (!CalleeADC->getAnalysis<RelaxedLiveVariables>()) 784c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 785c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 7868dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return true; 7878dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks} 7888dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 7898dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaksbool ExprEngine::shouldInlineCall(const CallEvent &Call, const Decl *D, 7908dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const ExplodedNode *Pred) { 79142f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks if (!D) 7928dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return false; 7938dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 79442f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks AnalysisManager &AMgr = getAnalysisManager(); 79542f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks AnalyzerOptions &Opts = AMgr.options; 79642f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks AnalysisDeclContextManager &ADCMgr = AMgr.getAnalysisDeclContextManager(); 79742f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks AnalysisDeclContext *CalleeADC = ADCMgr.getContext(D); 7988dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 79995ab9e306f4deefeabd89ea61987f4a8d67e0890Pavel Labath // Temporary object destructor processing is currently broken, so we never 80095ab9e306f4deefeabd89ea61987f4a8d67e0890Pavel Labath // inline them. 80195ab9e306f4deefeabd89ea61987f4a8d67e0890Pavel Labath // FIXME: Remove this once temp destructors are working. 80295ab9e306f4deefeabd89ea61987f4a8d67e0890Pavel Labath if (isa<CXXDestructorCall>(Call)) { 80395ab9e306f4deefeabd89ea61987f4a8d67e0890Pavel Labath if ((*currBldrCtx->getBlock())[currStmtIdx].getAs<CFGTemporaryDtor>()) 80495ab9e306f4deefeabd89ea61987f4a8d67e0890Pavel Labath return false; 80595ab9e306f4deefeabd89ea61987f4a8d67e0890Pavel Labath } 80695ab9e306f4deefeabd89ea61987f4a8d67e0890Pavel Labath 8078dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // The auto-synthesized bodies are essential to inline as they are 80842f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks // usually small and commonly used. Note: we should do this check early on to 8098dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // ensure we always inline these calls. 8108dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (CalleeADC->isBodyAutosynthesized()) 8118dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return true; 8128dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 8138a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks if (!AMgr.shouldInlineCall()) 8148dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return false; 8158dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 816c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Check if this function has been marked as non-inlinable. 817c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose Optional<bool> MayInline = Engine.FunctionSummaries->mayInline(D); 818c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (MayInline.hasValue()) { 819c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (!MayInline.getValue()) 820c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 821c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 822c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } else { 823c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // We haven't actually checked the static properties of this function yet. 824c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // Do that now, and record our decision in the function summaries. 8259b072b31ee2f41b8e30d1d22142c9ab72ac5ff1fJordan Rose if (mayInlineDecl(CalleeADC, Opts)) { 826c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose Engine.FunctionSummaries->markMayInline(D); 827c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } else { 828c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose Engine.FunctionSummaries->markShouldNotInline(D); 829c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose return false; 830c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } 831c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } 832c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose 83342f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks // Check if we should inline a call based on its kind. 834c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // FIXME: this checks both static and dynamic properties of the call, which 835c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // means we're redoing a bit of work that could be cached in the function 836c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose // summary. 837c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose CallInlinePolicy CIP = mayInlineCallKind(Call, Pred, Opts); 838c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (CIP != CIP_Allowed) { 839c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose if (CIP == CIP_DisallowedAlways) { 840c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose assert(!MayInline.hasValue() || MayInline.getValue()); 841c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose Engine.FunctionSummaries->markShouldNotInline(D); 842c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } 8438dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return false; 844c9092bb5eb67d859122abb69a0ef61e9249500cdJordan Rose } 8458dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 8468dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks const CFG *CalleeCFG = CalleeADC->getCFG(); 8478dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 8488dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // Do not inline if recursive or we've reached max stack frame count. 8498dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks bool IsRecursive = false; 8508dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks unsigned StackDepth = 0; 8518dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks examineStackFrames(D, Pred->getLocationContext(), IsRecursive, StackDepth); 8528dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if ((StackDepth >= Opts.InlineMaxStackDepth) && 8538dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks ((CalleeCFG->getNumBlockIDs() > Opts.getAlwaysInlineSize()) 8548dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks || IsRecursive)) 8558dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return false; 8568dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 8578dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks // Do not inline large functions too many times. 85842f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks if ((Engine.FunctionSummaries->getNumTimesInlined(D) > 85942f2309f739549bead6e5a6c34fd1be4d087998fAnna Zaks Opts.getMaxTimesInlineLarge()) && 86087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar CalleeCFG->getNumBlockIDs() >= 86187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar Opts.getMinCFGSizeTreatFunctionsAsLarge()) { 8628dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks NumReachedInlineCountMax++; 8638dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return false; 864453cb859a3c8dcafe79ae840dfc35ff8eae1b4b3Anna Zaks } 8658a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks 8668a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks if (HowToInline == Inline_Minimal && 8678a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks (CalleeCFG->getNumBlockIDs() > Opts.getAlwaysInlineSize() 8688a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks || IsRecursive)) 8698a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks return false; 8708a660eb1084294a903f6dcc00bf2fa4e3bc92cfcAnna Zaks 8718dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks Engine.FunctionSummaries->bumpNumTimesInlined(D); 8728dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks 8738dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks return true; 874453cb859a3c8dcafe79ae840dfc35ff8eae1b4b3Anna Zaks} 875453cb859a3c8dcafe79ae840dfc35ff8eae1b4b3Anna Zaks 876a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rosestatic bool isTrivialObjectAssignment(const CallEvent &Call) { 877a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose const CXXInstanceCall *ICall = dyn_cast<CXXInstanceCall>(&Call); 878a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose if (!ICall) 879a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose return false; 880a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose 881a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(ICall->getDecl()); 882a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose if (!MD) 883a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose return false; 884a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose if (!(MD->isCopyAssignmentOperator() || MD->isMoveAssignmentOperator())) 885a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose return false; 886a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose 887a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose return MD->isTrivial(); 888a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose} 889a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose 890e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaksvoid ExprEngine::defaultEvalCall(NodeBuilder &Bldr, ExplodedNode *Pred, 891d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const CallEvent &CallTemplate) { 892d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // Make sure we have the most recent state attached to the call. 893d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef State = Pred->getState(); 894d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<> Call = CallTemplate.cloneWithState(State); 895e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks 896a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose // Special-case trivial assignment operators. 897a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose if (isTrivialObjectAssignment(*Call)) { 898a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose performTrivialCopy(Bldr, Pred, *Call); 899a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose return; 900a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose } 901a8d937e4bdd39cdf503f77454e9dc4c9c730a9f7Jordan Rose 90269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // Try to inline the call. 90328038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // The origin expression here is just used as a kind of checksum; 904d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // this should still be safe even for CallEvents that don't come from exprs. 905d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const Expr *E = Call->getOriginExpr(); 906d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 9078dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks ProgramStateRef InlinedFailedState = getInlineFailedState(State, E); 908d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose if (InlinedFailedState) { 909d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose // If we already tried once and failed, make sure we don't retry later. 910d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose State = InlinedFailedState; 9115960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks } else { 912ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek RuntimeDefinition RD = Call->getRuntimeDefinition(); 913fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks const Decl *D = RD.getDecl(); 9148dadf15224f1a8df96793e5fc4e0b0e38a5ffbe4Anna Zaks if (shouldInlineCall(*Call, D, Pred)) { 915b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose if (RD.mayHaveOtherDefinitions()) { 91673f0563009a6715a5d3d41f664f5bfab5096d51fAnna Zaks AnalyzerOptions &Options = getAnalysisManager().options; 91773f0563009a6715a5d3d41f664f5bfab5096d51fAnna Zaks 918b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose // Explore with and without inlining the call. 919bfa9ab8183e2fdc74f8633d758cb0c6201314320Anna Zaks if (Options.getIPAMode() == IPAK_DynamicDispatchBifurcate) { 920b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose BifurcateCall(RD.getDispatchRegion(), *Call, D, Bldr, Pred); 921b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose return; 922b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose } 923b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose 924b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose // Don't inline if we're not in any dynamic dispatch mode. 925bfa9ab8183e2fdc74f8633d758cb0c6201314320Anna Zaks if (Options.getIPAMode() != IPAK_DynamicDispatch) { 926da29ac527063fc9714547088bf841bfa30557bf0Jordan Rose conservativeEvalCall(*Call, Bldr, Pred, State); 927b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose return; 928da29ac527063fc9714547088bf841bfa30557bf0Jordan Rose } 929e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 930b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose 9315960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // We are not bifurcating and we do have a Decl, so just inline. 9325960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (inlineCall(*Call, D, Bldr, Pred, State)) 9335960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 934e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 935e81ce256b62717dd846bd19aecc4115a0dcd4995Anna Zaks } 93669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 93769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose // If we can't inline it, handle the return value and invalidate the regions. 938e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks conservativeEvalCall(*Call, Bldr, Pred, State); 939e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks} 94069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 941e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaksvoid ExprEngine::BifurcateCall(const MemRegion *BifurReg, 942e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks const CallEvent &Call, const Decl *D, 943e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NodeBuilder &Bldr, ExplodedNode *Pred) { 944e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks assert(BifurReg); 945b763ede873c23c8651bd18eba0c62e929b496ba5Jordan Rose BifurReg = BifurReg->StripCasts(); 946e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 947e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // Check if we've performed the split already - note, we only want 948e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // to split the path once per memory region. 949e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef State = Pred->getState(); 950166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose const unsigned *BState = 9516960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->get<DynamicDispatchBifurcationMap>(BifurReg); 9525960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (BState) { 9535960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // If we are on "inline path", keep inlining if possible. 9546960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks if (*BState == DynamicDispatchModeInlined) 9555960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks if (inlineCall(Call, D, Bldr, Pred, State)) 9565960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 9575960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // If inline failed, or we are on the path where we assume we 9585960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // don't have enough info about the receiver to inline, conjure the 9595960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks // return value and invalidate the regions. 9605960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks conservativeEvalCall(Call, Bldr, Pred, State); 9615960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return; 962e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks } 963e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 964e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // If we got here, this is the first time we process a message to this 965e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks // region, so split the path. 966e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef IState = 9676960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->set<DynamicDispatchBifurcationMap>(BifurReg, 9686960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks DynamicDispatchModeInlined); 969e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks inlineCall(Call, D, Bldr, Pred, IState); 970e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 971e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks ProgramStateRef NoIState = 9726960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks State->set<DynamicDispatchBifurcationMap>(BifurReg, 9736960f6e53b0d9a69a460c99ec199470271ff9603Anna Zaks DynamicDispatchModeConservative); 974e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks conservativeEvalCall(Call, Bldr, Pred, NoIState); 975e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 976e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks NumOfDynamicDispatchPathSplits++; 97769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose} 97869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 979294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenekvoid ExprEngine::VisitReturnStmt(const ReturnStmt *RS, ExplodedNode *Pred, 980294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek ExplodedNodeSet &Dst) { 981256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ExplodedNodeSet dstPreVisit; 982256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, RS, *this); 983256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek 98466c486f275531df6362b3511fc3af6563561801bTed Kremenek StmtNodeBuilder B(dstPreVisit, Dst, *currBldrCtx); 98587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 986256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek if (RS->getRetValue()) { 987256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek for (ExplodedNodeSet::iterator it = dstPreVisit.begin(), 988256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek ei = dstPreVisit.end(); it != ei; ++it) { 989256ef642f8feef22fd53be7efa868e8e34752eedTed Kremenek B.generateNode(RS, *it, (*it)->getState()); 990294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 991294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek } 992294fd0a62b95f512637910bf85c7efa6c2354b50Ted Kremenek} 993