CallEvent.h revision ef15831780b705475e7b237ac16418e9b53cb7a6
1f540c54701e3eeb34cb619a3a4eb18f1ac70ef2dJordan Rose//===- CallEvent.h - Wrapper for all function and method calls ----*- C++ -*--// 2740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// 3740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// The LLVM Compiler Infrastructure 4740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// 5740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// This file is distributed under the University of Illinois Open Source 6740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// License. See LICENSE.TXT for details. 7740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// 8740d490593e0de8732a697c9f77b90ddd463863bJordan Rose//===----------------------------------------------------------------------===// 9740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// 10740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \file This file defines CallEvent and its subclasses, which represent path- 11740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// sensitive instances of different kinds of function and method calls 12740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// (C, C++, and Objective-C). 13740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// 14740d490593e0de8732a697c9f77b90ddd463863bJordan Rose//===----------------------------------------------------------------------===// 15740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 16740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#ifndef LLVM_CLANG_STATICANALYZER_PATHSENSITIVE_CALL 17740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#define LLVM_CLANG_STATICANALYZER_PATHSENSITIVE_CALL 18740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 19740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/Basic/SourceManager.h" 20740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/AST/DeclCXX.h" 21740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/AST/ExprCXX.h" 22740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/AST/ExprObjC.h" 23de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h" 24740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h" 25b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose#include "llvm/ADT/PointerIntPair.h" 26740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 27740d490593e0de8732a697c9f77b90ddd463863bJordan Rosenamespace clang { 2828038f33aa2db4833881fea757a1f0daf85ac02bJordan Roseclass ProgramPoint; 2928038f33aa2db4833881fea757a1f0daf85ac02bJordan Roseclass ProgramPointTag; 3028038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 31740d490593e0de8732a697c9f77b90ddd463863bJordan Rosenamespace ento { 32740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 33740d490593e0de8732a697c9f77b90ddd463863bJordan Roseenum CallEventKind { 34740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_Function, 35740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_CXXMember, 36fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose CE_CXXMemberOperator, 37c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CE_BEG_CXX_INSTANCE_CALLS = CE_CXXMember, 38c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CE_END_CXX_INSTANCE_CALLS = CE_CXXMemberOperator, 39740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_Block, 40740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_BEG_SIMPLE_CALLS = CE_Function, 41740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_END_SIMPLE_CALLS = CE_Block, 42740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_CXXConstructor, 438d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose CE_CXXDestructor, 4470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose CE_CXXAllocator, 45740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_BEG_FUNCTION_CALLS = CE_Function, 4670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose CE_END_FUNCTION_CALLS = CE_CXXAllocator, 478919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose CE_ObjCMessage 48740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 49740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 50972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseclass CallEvent; 51d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseclass CallEventManager; 52972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 53d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosetemplate<typename T = CallEvent> 54d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseclass CallEventRef : public IntrusiveRefCntPtr<const T> { 55d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 56d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef(const T *Call) : IntrusiveRefCntPtr<const T>(Call) {} 57d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef(const CallEventRef &Orig) : IntrusiveRefCntPtr<const T>(Orig) {} 58d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 59d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<T> cloneWithState(ProgramStateRef State) const { 60d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return this->getPtr()->template cloneWithState<T>(State); 61d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 6257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 6357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose // Allow implicit conversions to a superclass type, since CallEventRef 6457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose // behaves like a pointer-to-const. 6557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose template <typename SuperT> 6657c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose operator CallEventRef<SuperT> () const { 6757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose return this->getPtr(); 6857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } 69d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose}; 70b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 71740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents an abstract call to a function or method along a 72740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// particular path. 73972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// 74972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEvents are created through the factory methods of CallEventManager. 75972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// 76972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEvents should always be cheap to create and destroy. In order for 77972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEventManager to be able to re-use CallEvent-sized memory blocks, 78972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// subclasses of CallEvent may not add any data members to the base class. 79972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// Use the "Data" and "Location" fields instead. 80740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass CallEvent { 81740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 82740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef CallEventKind Kind; 83740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 84b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Roseprivate: 857c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose ProgramStateRef State; 867c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx; 87b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose llvm::PointerUnion<const Expr *, const Decl *> Origin; 88b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 89972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // DO NOT IMPLEMENT 907c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose CallEvent &operator=(const CallEvent &); 917c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 92740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 93b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose // This is user data for subclasses. 94b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose const void *Data; 95972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 96972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // This is user data for subclasses. 97972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // This should come right before RefCount, so that the two fields can be 98972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // packed together on LP64 platforms. 99b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose SourceLocation Location; 100b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 101972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprivate: 102972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose mutable unsigned RefCount; 103972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 104972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose template <typename T> friend struct llvm::IntrusiveRefCntPtrInfo; 105972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void Retain() const { ++RefCount; } 106972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void Release() const; 107972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 108972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprotected: 109d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 110d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 1117c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose CallEvent(const Expr *E, ProgramStateRef state, const LocationContext *lctx) 112972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : State(state), LCtx(lctx), Origin(E), RefCount(0) {} 113b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 1147c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose CallEvent(const Decl *D, ProgramStateRef state, const LocationContext *lctx) 115972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : State(state), LCtx(lctx), Origin(D), RefCount(0) {} 116972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 117972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // DO NOT MAKE PUBLIC 118972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEvent(const CallEvent &Original) 119972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : State(Original.State), LCtx(Original.LCtx), Origin(Original.Origin), 120972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Data(Original.Data), Location(Original.Location), RefCount(0) {} 121b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 122d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 1237c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose ProgramStateRef getState() const { 1247c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return State; 125b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 126b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 127b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose const LocationContext *getLocationContext() const { 1287c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return LCtx; 129b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 130740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 131740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 132972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Copies this CallEvent, with vtable intact, into a new block of memory. 133972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const = 0; 134972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 135740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Get the value of arbitrary expressions at this point in the path. 136740d490593e0de8732a697c9f77b90ddd463863bJordan Rose SVal getSVal(const Stmt *S) const { 137b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getState()->getSVal(S, getLocationContext()); 138740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 139740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 140972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 141740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef SmallVectorImpl<const MemRegion *> RegionList; 142740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 143740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Used to specify non-argument regions that will be invalidated as a 144740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// result of this call. 1457c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const {} 146740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 1477c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual QualType getDeclaredResultType() const = 0; 148740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 149740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 1507c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual ~CallEvent() {} 1517c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 152b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \brief Returns the kind of call this is. 1537c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const = 0; 154b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 155740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the declaration of the function or method that will be 156740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// called. May be null. 1577c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getDecl() const { 1587c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return Origin.dyn_cast<const Decl *>(); 1597c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 160740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 161ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose /// \brief Returns the definition of the function or method that will be 1629dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks /// called. Returns NULL if the definition cannot be found; ex: due to 1639dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks /// dynamic dispatch in ObjC methods. 1647c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getRuntimeDefinition() const = 0; 165ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 166740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the expression whose value will be the result of this call. 167740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// May be null. 168b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose const Expr *getOriginExpr() const { 169b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return Origin.dyn_cast<const Expr *>(); 170b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 171740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 172740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the number of arguments (explicit and implicit). 173740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// 174740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// Note that this may be greater than the number of parameters in the 175740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// callee's declaration, and that it may include arguments not written in 176740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// the source. 1777c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const = 0; 178740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 179740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns true if the callee is known to be from a system header. 180740d490593e0de8732a697c9f77b90ddd463863bJordan Rose bool isInSystemHeader() const { 181740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const Decl *D = getDecl(); 182740d490593e0de8732a697c9f77b90ddd463863bJordan Rose if (!D) 183740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return false; 184740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 185740d490593e0de8732a697c9f77b90ddd463863bJordan Rose SourceLocation Loc = D->getLocation(); 186740d490593e0de8732a697c9f77b90ddd463863bJordan Rose if (Loc.isValid()) { 187740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const SourceManager &SM = 188b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose getState()->getStateManager().getContext().getSourceManager(); 189740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return SM.isInSystemHeader(D->getLocation()); 190740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 191740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 192740d490593e0de8732a697c9f77b90ddd463863bJordan Rose // Special case for implicitly-declared global operator new/delete. 193740d490593e0de8732a697c9f77b90ddd463863bJordan Rose // These should be considered system functions. 194740d490593e0de8732a697c9f77b90ddd463863bJordan Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) 195740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return FD->isOverloadedOperator() && FD->isImplicit() && FD->isGlobal(); 196740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 197740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return false; 198740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 199740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 200de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose /// \brief Returns a source range for the entire call, suitable for 201de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose /// outputting in diagnostics. 2027c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getSourceRange() const { 2037c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return getOriginExpr()->getSourceRange(); 2047c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 205de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose 206740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the value of a given argument at the time of the call. 2077c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getArgSVal(unsigned Index) const; 208740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 209740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the expression associated with a given argument. 210740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// May be null if this expression does not appear in the source. 2117c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { return 0; } 212740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 213740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the source range for errors associated with this argument. 2147c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose /// 215740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// May be invalid if the argument is not written in the source. 2167c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getArgSourceRange(unsigned Index) const; 217740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 218740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the result type, adjusted for references. 219740d490593e0de8732a697c9f77b90ddd463863bJordan Rose QualType getResultType() const; 220740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 221740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns true if any of the arguments appear to represent callbacks. 222740d490593e0de8732a697c9f77b90ddd463863bJordan Rose bool hasNonZeroCallbackArg() const; 223740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 22485d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose /// \brief Returns true if any of the arguments are known to escape to long- 22585d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose /// term storage, even if this method will not modify them. 22685d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose // NOTE: The exact semantics of this are still being defined! 22785d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose // We don't really want a list of hardcoded exceptions in the long run, 22885d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose // but we don't want duplicated lists of known APIs in the short term either. 2297c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual bool argumentsMayEscape() const { 2307c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return hasNonZeroCallbackArg(); 2317c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 23285d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose 23328038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose /// \brief Returns an appropriate ProgramPoint for this call. 2348d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose ProgramPoint getProgramPoint(bool IsPreVisit = false, 23528038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose const ProgramPointTag *Tag = 0) const; 23628038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 237740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns a new state with all argument regions invalidated. 238740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// 239740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// This accepts an alternate state in case some processing has already 240740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// occurred. 241740d490593e0de8732a697c9f77b90ddd463863bJordan Rose ProgramStateRef invalidateRegions(unsigned BlockCount, 242740d490593e0de8732a697c9f77b90ddd463863bJordan Rose ProgramStateRef Orig = 0) const; 243740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 244ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose typedef std::pair<Loc, SVal> FrameBindingTy; 245ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose typedef SmallVectorImpl<FrameBindingTy> BindingsTy; 246ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 247ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// Populates the given SmallVector with the bindings in the callee's stack 248ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// frame at the start of this call. 249ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 250ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const = 0; 251ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 252972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Returns a copy of this CallEvent, but using the given state. 253972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose template <typename T> 254d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<T> cloneWithState(ProgramStateRef NewState) const; 255972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 256972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Returns a copy of this CallEvent, but using the given state. 257d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<> cloneWithState(ProgramStateRef NewState) const { 258972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return cloneWithState<CallEvent>(NewState); 259972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 260972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 26185d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose /// \brief Returns true if this is a statement that can be considered for 26285d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose /// inlining. 2637c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose /// 2647c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose /// FIXME: This should go away once CallEvents are cheap and easy to 2657c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose /// construct from ExplodedNodes. 26685d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose static bool mayBeInlined(const Stmt *S); 26785d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose 268e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // Iterator access to formal parameters and their types. 269740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprivate: 270740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef std::const_mem_fun_t<QualType, ParmVarDecl> get_type_fun; 271740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 272740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 273e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose typedef const ParmVarDecl * const *param_iterator; 274e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 275e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// Returns an iterator over the call's formal parameters. 276e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 277e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// If UseDefinitionParams is set, this will return the parameter decls 278e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// used in the callee's definition (suitable for inlining). Most of the 279e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// time it is better to use the decl found by name lookup, which likely 280e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// carries more annotations. 281e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 282e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// Remember that the number of formal parameters may not match the number 283e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// of arguments for all calls. However, the first parameter will always 284e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// correspond with the argument value returned by \c getArgSVal(0). 285e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 286e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// If the call has no accessible declaration (or definition, if 287e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \p UseDefinitionParams is set), \c param_begin() will be equal to 288e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \c param_end(). 289ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_begin() const =0; 290e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \sa param_begin() 291ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_end() const = 0; 292e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 293740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef llvm::mapped_iterator<param_iterator, get_type_fun> 294740d490593e0de8732a697c9f77b90ddd463863bJordan Rose param_type_iterator; 295740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 296e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// Returns an iterator over the types of the call's formal parameters. 297e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 298e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// This uses the callee decl found by default name lookup rather than the 299e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// definition because it represents a public interface, and probably has 300e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// more annotations. 301740d490593e0de8732a697c9f77b90ddd463863bJordan Rose param_type_iterator param_type_begin() const { 302740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return llvm::map_iterator(param_begin(), 303740d490593e0de8732a697c9f77b90ddd463863bJordan Rose get_type_fun(&ParmVarDecl::getType)); 304740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 305e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \sa param_type_begin() 306740d490593e0de8732a697c9f77b90ddd463863bJordan Rose param_type_iterator param_type_end() const { 307740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return llvm::map_iterator(param_end(), get_type_fun(&ParmVarDecl::getType)); 308740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 309740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 3100ffbfd1a7f80f9a3c07317cb8f44c562f2ba1ba5Jordan Rose // For debugging purposes only 311b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose void dump(raw_ostream &Out) const; 3120ffbfd1a7f80f9a3c07317cb8f44c562f2ba1ba5Jordan Rose LLVM_ATTRIBUTE_USED void dump() const { dump(llvm::errs()); } 3130ffbfd1a7f80f9a3c07317cb8f44c562f2ba1ba5Jordan Rose 314740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *) { return true; } 315740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 316740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 317b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 318740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a call to any sort of function that might have a 319740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// FunctionDecl. 320740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass AnyFunctionCall : public CallEvent { 321740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 322b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose AnyFunctionCall(const Expr *E, ProgramStateRef St, 3237c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 3247c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CallEvent(E, St, LCtx) {} 325b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose AnyFunctionCall(const Decl *D, ProgramStateRef St, 3267c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 3277c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CallEvent(D, St, LCtx) {} 328972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose AnyFunctionCall(const AnyFunctionCall &Other) : CallEvent(Other) {} 329740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 3307c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual QualType getDeclaredResultType() const; 331740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 332740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 333b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose // This function is overridden by subclasses, but they must return 334b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose // a FunctionDecl. 3357c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const FunctionDecl *getDecl() const { 3367c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return cast<FunctionDecl>(CallEvent::getDecl()); 337b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 338740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 3397c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getRuntimeDefinition() const { 340ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose const FunctionDecl *FD = getDecl(); 341ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose // Note that hasBody() will fill FD with the definition FunctionDecl. 342ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose if (FD && FD->hasBody(FD)) 343ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose return FD; 344ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose return 0; 345ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose } 346ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 3477c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual bool argumentsMayEscape() const; 348b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 349ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 350ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 351ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 352ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_begin() const; 353ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_end() const; 354b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 355740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 356740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() >= CE_BEG_FUNCTION_CALLS && 357740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CA->getKind() <= CE_END_FUNCTION_CALLS; 358740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 359740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 360740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 361740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a call to a written as a CallExpr. 362740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass SimpleCall : public AnyFunctionCall { 363740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 364b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose SimpleCall(const CallExpr *CE, ProgramStateRef St, 3657c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 366972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : AnyFunctionCall(CE, St, LCtx) {} 367972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose SimpleCall(const SimpleCall &Other) : AnyFunctionCall(Other) {} 368740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 369740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 3707c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CallExpr *getOriginExpr() const { 371b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return cast<CallExpr>(AnyFunctionCall::getOriginExpr()); 372b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 373740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 3747c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const FunctionDecl *getDecl() const; 375740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 3767c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { return getOriginExpr()->getNumArgs(); } 3777c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 3787c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 379b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getArg(Index); 380740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 381740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 382740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 383740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() >= CE_BEG_SIMPLE_CALLS && 384740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CA->getKind() <= CE_END_SIMPLE_CALLS; 385740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 386740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 387740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 388740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a C function or static C++ member function call. 389740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// 390740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// Example: \c fun() 391740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass FunctionCall : public SimpleCall { 392d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 393972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 394d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 395740d490593e0de8732a697c9f77b90ddd463863bJordan Rose FunctionCall(const CallExpr *CE, ProgramStateRef St, 396740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const LocationContext *LCtx) 3977c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : SimpleCall(CE, St, LCtx) {} 398740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 399d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose FunctionCall(const FunctionCall &Other) : SimpleCall(Other) {} 400d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) FunctionCall(*this); } 401d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 402d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 4037c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_Function; } 404b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 405740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 406740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_Function; 407740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 408740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 409740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 410c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// \brief Represents a non-static C++ member function call, no matter how 411c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// it is written. 412c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Roseclass CXXInstanceCall : public SimpleCall { 413740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 4147c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 415740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 416c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CXXInstanceCall(const CallExpr *CE, ProgramStateRef St, 4177c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 4187c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : SimpleCall(CE, St, LCtx) {} 419c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose 420972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CXXInstanceCall(const CXXInstanceCall &Other) : SimpleCall(Other) {} 421972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 422c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rosepublic: 423ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// \brief Returns the value of the implicit 'this' object. 424ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual SVal getCXXThisVal() const = 0; 425ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 4267c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getRuntimeDefinition() const; 427c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose 428ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 429ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 430ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 431c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose static bool classof(const CallEvent *CA) { 432c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose return CA->getKind() >= CE_BEG_CXX_INSTANCE_CALLS && 433c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CA->getKind() <= CE_END_CXX_INSTANCE_CALLS; 434c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose } 435c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose}; 436c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose 437c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// \brief Represents a non-static C++ member function call. 438c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// 439c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// Example: \c obj.fun() 440c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Roseclass CXXMemberCall : public CXXInstanceCall { 441d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 442972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 443d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 444740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CXXMemberCall(const CXXMemberCallExpr *CE, ProgramStateRef St, 445c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const LocationContext *LCtx) 4467c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CXXInstanceCall(CE, St, LCtx) {} 447740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 448d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXMemberCall(const CXXMemberCall &Other) : CXXInstanceCall(Other) {} 449d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXMemberCall(*this); } 450d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 451d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 4527c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXMemberCallExpr *getOriginExpr() const { 453740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return cast<CXXMemberCallExpr>(SimpleCall::getOriginExpr()); 454740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 455740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 4567c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getCXXThisVal() const; 4577c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 4587c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXMember; } 459e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 460740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 461740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_CXXMember; 462740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 463740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 464740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 465fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// \brief Represents a C++ overloaded operator call where the operator is 466fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// implemented as a non-static member function. 467fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// 468fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// Example: <tt>iter + 1</tt> 469c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Roseclass CXXMemberOperatorCall : public CXXInstanceCall { 470d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 471d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 472972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprotected: 473d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXMemberOperatorCall(const CXXOperatorCallExpr *CE, ProgramStateRef St, 474d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) 475d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose : CXXInstanceCall(CE, St, LCtx) {} 476d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 477972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CXXMemberOperatorCall(const CXXMemberOperatorCall &Other) 478972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : CXXInstanceCall(Other) {} 479972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { 480972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose new (Dest) CXXMemberOperatorCall(*this); 481972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 482972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 483fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rosepublic: 4847c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXOperatorCallExpr *getOriginExpr() const { 485fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return cast<CXXOperatorCallExpr>(SimpleCall::getOriginExpr()); 486fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 487fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 4887c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { 4897c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return getOriginExpr()->getNumArgs() - 1; 4907c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 4917c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 492fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return getOriginExpr()->getArg(Index + 1); 493fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 494fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 4957c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getCXXThisVal() const; 4967c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 4977c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXMemberOperator; } 498e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 499fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose static bool classof(const CallEvent *CA) { 500fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return CA->getKind() == CE_CXXMemberOperator; 501fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 502fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose}; 503fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 504740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a call to a block. 505740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// 506fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// Example: <tt>^{ /* ... */ }()</tt> 507740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass BlockCall : public SimpleCall { 508d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 509d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 510740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 511d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose BlockCall(const CallExpr *CE, ProgramStateRef St, 512d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) 513d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose : SimpleCall(CE, St, LCtx) {} 514d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 515972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose BlockCall(const BlockCall &Other) : SimpleCall(Other) {} 516972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { new (Dest) BlockCall(*this); } 517972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 5187c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 519740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 5207c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual QualType getDeclaredResultType() const; 521740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 522740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 52369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// \brief Returns the region associated with this instance of the block. 52469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// 52569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// This may be NULL if the block's origin is unknown. 52669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDataRegion *getBlockRegion() const; 52769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 52869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// \brief Gets the declaration of the block. 52969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// 53069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// This is not an override of getDecl() because AnyFunctionCall has already 53169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// assumed that it's a FunctionDecl. 53269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDecl *getBlockDecl() const { 53369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDataRegion *BR = getBlockRegion(); 53469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose if (!BR) 53569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose return 0; 53669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose return BR->getDecl(); 537740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 538740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 5397c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getRuntimeDefinition() const { 540ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose return getBlockDecl(); 541ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose } 542ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 543ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 544ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 545ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 546ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_begin() const; 547ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_end() const; 548b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 5497c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_Block; } 550b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 551740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 552740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_Block; 553740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 554740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 555740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 556740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a call to a C++ constructor. 557740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// 558740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// Example: \c T(1) 559740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass CXXConstructorCall : public AnyFunctionCall { 560d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 561b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 562d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 563d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// Creates a constructor call. 564d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// 565d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// \param CE The constructor expression as written in the source. 566d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// \param Target The region where the object should be constructed. If NULL, 567d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// a new symbolic region will be used. 568d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// \param St The path-sensitive state at this point in the program. 569d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// \param LCtx The location context at this point in the program. 570b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose CXXConstructorCall(const CXXConstructExpr *CE, const MemRegion *target, 571740d490593e0de8732a697c9f77b90ddd463863bJordan Rose ProgramStateRef St, const LocationContext *LCtx) 5727c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : AnyFunctionCall(CE, St, LCtx) { 573b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose Data = target; 574b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 575740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 576d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXConstructorCall(const CXXConstructorCall &Other) : AnyFunctionCall(Other){} 577d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXConstructorCall(*this); } 578d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 579d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 580d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 581d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 5827c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXConstructExpr *getOriginExpr() const { 583b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return cast<CXXConstructExpr>(AnyFunctionCall::getOriginExpr()); 584b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 585b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 5867c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXConstructorDecl *getDecl() const { 587b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getConstructor(); 588740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 589740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 5907c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { return getOriginExpr()->getNumArgs(); } 591740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 5927c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 593b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getArg(Index); 594740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 595740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 596ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// \brief Returns the value of the implicit 'this' object. 5977c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getCXXThisVal() const; 5987c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 599ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 600ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 601ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 6027c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXConstructor; } 603e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 604740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 605740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_CXXConstructor; 606740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 607740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 608740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 6098d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose/// \brief Represents an implicit call to a C++ destructor. 6108d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose/// 6118d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose/// This can occur at the end of a scope (for automatic objects), at the end 6128d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose/// of a full-expression (for temporaries), or as part of a delete. 6138d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Roseclass CXXDestructorCall : public AnyFunctionCall { 614d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 6158d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose 616d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 617b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// Creates an implicit destructor. 618b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// 619b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \param DD The destructor that will be called. 620b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \param Trigger The statement whose completion causes this destructor call. 621b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \param Target The object region to be destructed. 622b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \param St The path-sensitive state at this point in the program. 623b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \param LCtx The location context at this point in the program. 624b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose CXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger, 625b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose const MemRegion *Target, ProgramStateRef St, 6268d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose const LocationContext *LCtx) 6277c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : AnyFunctionCall(DD, St, LCtx) { 628b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose Data = Target; 629b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose Location = Trigger->getLocEnd(); 630b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 6318d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose 632d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXDestructorCall(const CXXDestructorCall &Other) : AnyFunctionCall(Other) {} 633d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXDestructorCall(*this); } 634d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 635d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 636d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 637d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 6387c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getSourceRange() const { return Location; } 6397c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { return 0; } 6407c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 641ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// \brief Returns the value of the implicit 'this' object. 6427c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getCXXThisVal() const; 643ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 6447c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getRuntimeDefinition() const; 6458d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose 646ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 647ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 648ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 6497c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXDestructor; } 650e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 6518d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose static bool classof(const CallEvent *CA) { 6528d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose return CA->getKind() == CE_CXXDestructor; 6538d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose } 6548d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose}; 6558d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose 6560e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose/// \brief Represents the memory allocation call in a C++ new-expression. 6570e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose/// 6580e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose/// This is a call to "operator new". 65970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Roseclass CXXAllocatorCall : public AnyFunctionCall { 660d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 661972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 662d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 663b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose CXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef St, 66470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose const LocationContext *LCtx) 6657c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : AnyFunctionCall(E, St, LCtx) {} 66670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 667d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXAllocatorCall(const CXXAllocatorCall &Other) : AnyFunctionCall(Other) {} 668d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXAllocatorCall(*this); } 669d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 670d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 6717c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXNewExpr *getOriginExpr() const { 672b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return cast<CXXNewExpr>(AnyFunctionCall::getOriginExpr()); 673b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 674b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 6757c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const FunctionDecl *getDecl() const { 676b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getOperatorNew(); 67770cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose } 67870cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 6797c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { 680b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getNumPlacementArgs() + 1; 681b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 68270cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 6837c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 68470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // The first argument of an allocator call is the size of the allocation. 68570cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose if (Index == 0) 68670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return 0; 687b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getPlacementArg(Index - 1); 68870cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose } 68970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 6907c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXAllocator; } 691b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 69270cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose static bool classof(const CallEvent *CE) { 69370cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return CE->getKind() == CE_CXXAllocator; 69470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose } 69570cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose}; 69670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 6978919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose/// \brief Represents the ways an Objective-C message send can occur. 6988919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose// 6998919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose// Note to maintainers: OCM_Message should always be last, since it does not 7008919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose// need to fit in the Data field's low bits. 7018919e688dc610d1f632a4d43f7f1489f67255476Jordan Roseenum ObjCMessageKind { 7028919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose OCM_PropertyAccess, 7038919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose OCM_Subscript, 7048919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose OCM_Message 7058919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose}; 7068919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 707cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose/// \brief Represents any expression that calls an Objective-C method. 7088919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose/// 7098919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose/// This includes all of the kinds listed in ObjCMessageKind. 710cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Roseclass ObjCMethodCall : public CallEvent { 711d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 712d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 7138919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose const PseudoObjectExpr *getContainingPseudoObjectExpr() const; 714cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose 7158919e688dc610d1f632a4d43f7f1489f67255476Jordan Roseprotected: 716d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ObjCMethodCall(const ObjCMessageExpr *Msg, ProgramStateRef St, 717d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) 718d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose : CallEvent(Msg, St, LCtx) { 719d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose Data = 0; 720d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 721d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 722972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose ObjCMethodCall(const ObjCMethodCall &Other) : CallEvent(Other) {} 723972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { new (Dest) ObjCMethodCall(*this); } 724972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 7257c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 726740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 7277c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual QualType getDeclaredResultType() const; 728740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 729740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 7307c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const ObjCMessageExpr *getOriginExpr() const { 7318919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return cast<ObjCMessageExpr>(CallEvent::getOriginExpr()); 732cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose } 7337c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const ObjCMethodDecl *getDecl() const { 734b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getMethodDecl(); 735b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 7367c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { 737b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getNumArgs(); 738b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 7397c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 740b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getArg(Index); 741b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 742740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 7438919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose bool isInstanceMessage() const { 7448919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getOriginExpr()->isInstanceMessage(); 7458919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 7468919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ObjCMethodFamily getMethodFamily() const { 7478919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getOriginExpr()->getMethodFamily(); 7488919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 7498919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose Selector getSelector() const { 7508919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getOriginExpr()->getSelector(); 7518919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 7528919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 7537c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getSourceRange() const; 7548919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 7550e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// \brief Returns the value of the receiver at the time of this call. 756740d490593e0de8732a697c9f77b90ddd463863bJordan Rose SVal getReceiverSVal() const; 757740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 7580e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// \brief Get the interface for the receiver. 7590e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// 7600e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// This works whether this is an instance message or a class message. 7610e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// However, it currently just uses the static type of the receiver. 762cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const ObjCInterfaceDecl *getReceiverInterface() const { 763b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getReceiverInterface(); 764cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose } 765cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose 7668919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ObjCMessageKind getMessageKind() const; 7678919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 7688919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose bool isSetter() const { 7698919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose switch (getMessageKind()) { 7708919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Message: 7718919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose llvm_unreachable("This is not a pseudo-object access!"); 7728919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_PropertyAccess: 7738919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getNumArgs() > 0; 7748919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Subscript: 7758919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getNumArgs() > 1; 7768919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 7778919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose llvm_unreachable("Unknown message kind"); 778740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 779740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 7802d18419a7c8f9a2975d4ed74a202de6467308ad1Anna Zaks virtual const Decl *getRuntimeDefinition() const; 781ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 782ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 783ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 784ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 785ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_begin() const; 786ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_end() const; 787b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 7887c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_ObjCMessage; } 789b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 790740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 791740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_ObjCMessage; 792740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 793740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 794740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 795972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 796972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// \brief Manages the lifetime of CallEvent objects. 797972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// 798972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEventManager provides a way to create arbitrary CallEvents "on the 799972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// stack" as if they were value objects by keeping a cache of CallEvent-sized 800972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// memory blocks. The CallEvents created by CallEventManager are only valid 801972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// for the lifetime of the OwnedCallEvent that holds them; right now these 802972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// objects cannot be copied and ownership cannot be transferred. 803972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseclass CallEventManager { 804972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose friend class CallEvent; 805972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 806972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose llvm::BumpPtrAllocator &Alloc; 807d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose SmallVector<void *, 8> Cache; 808972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 809972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void reclaim(const void *Memory) { 810972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Cache.push_back(const_cast<void *>(Memory)); 811972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 812972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 813972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Returns memory that can be initialized as a CallEvent. 814972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void *allocate() { 815972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose if (Cache.empty()) 816972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return Alloc.Allocate<FunctionCall>(); 817972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose else 818972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return Cache.pop_back_val(); 819972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 820972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 821d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose template <typename T, typename Arg> 822d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose T *create(Arg A, ProgramStateRef St, const LocationContext *LCtx) { 823d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return new (allocate()) T(A, St, LCtx); 824d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 825d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 826d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose template <typename T, typename Arg1, typename Arg2> 827d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose T *create(Arg1 A1, Arg2 A2, ProgramStateRef St, const LocationContext *LCtx) { 828d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return new (allocate()) T(A1, A2, St, LCtx); 829d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 830d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 831d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose template <typename T, typename Arg1, typename Arg2, typename Arg3> 832d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose T *create(Arg1 A1, Arg2 A2, Arg3 A3, ProgramStateRef St, 833d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) { 834d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return new (allocate()) T(A1, A2, A3, St, LCtx); 835d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 836d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 837972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rosepublic: 838972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager(llvm::BumpPtrAllocator &alloc) : Alloc(alloc) {} 839d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 84057c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 84157c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose CallEventRef<> 84257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getCaller(const StackFrameContext *CalleeCtx, ProgramStateRef State); 84357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 84457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 845d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<SimpleCall> 846d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getSimpleCall(const CallExpr *E, ProgramStateRef State, 847d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx); 848d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 849d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<ObjCMethodCall> 850d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getObjCMethodCall(const ObjCMessageExpr *E, ProgramStateRef State, 851d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) { 852d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return create<ObjCMethodCall>(E, State, LCtx); 853d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 854d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 855d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<CXXConstructorCall> 856d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getCXXConstructorCall(const CXXConstructExpr *E, const MemRegion *Target, 857d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef State, const LocationContext *LCtx) { 858d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return create<CXXConstructorCall>(E, Target, State, LCtx); 859d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 860d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 861d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<CXXDestructorCall> 862d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getCXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger, 863d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const MemRegion *Target, ProgramStateRef State, 864d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) { 865d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return create<CXXDestructorCall>(DD, Trigger, Target, State, LCtx); 866d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 867d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 868d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<CXXAllocatorCall> 869d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getCXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef State, 870d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) { 871d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return create<CXXAllocatorCall>(E, State, LCtx); 872d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 873972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose}; 874972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 875972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 876972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rosetemplate <typename T> 877d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan RoseCallEventRef<T> CallEvent::cloneWithState(ProgramStateRef NewState) const { 878972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(isa<T>(*this) && "Cloning to unrelated type"); 879972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(sizeof(T) == sizeof(CallEvent) && "Subclasses may not add fields"); 880972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 881d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose if (NewState == State) 882d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return cast<T>(this); 883d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 884972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager &Mgr = State->getStateManager().getCallEventManager(); 885972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose T *Copy = static_cast<T *>(Mgr.allocate()); 886972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose cloneTo(Copy); 887972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(Copy->getKind() == this->getKind() && "Bad copy"); 888972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 889972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Copy->State = NewState; 890972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return Copy; 891972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose} 892972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 893972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseinline void CallEvent::Release() const { 894972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(RefCount > 0 && "Reference count is already zero."); 895972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose --RefCount; 896972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 897972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose if (RefCount > 0) 898972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return; 899972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 900972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager &Mgr = State->getStateManager().getCallEventManager(); 901972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Mgr.reclaim(this); 902972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 903972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose this->~CallEvent(); 904972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose} 905972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 906740d490593e0de8732a697c9f77b90ddd463863bJordan Rose} // end namespace ento 907740d490593e0de8732a697c9f77b90ddd463863bJordan Rose} // end namespace clang 908740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 90957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rosenamespace llvm { 91057c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose // Support isa<>, cast<>, and dyn_cast<> for CallEventRef. 91157c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose template<class T> struct simplify_type< clang::ento::CallEventRef<T> > { 91257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose typedef const T *SimpleType; 91357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 91457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose static SimpleType 91557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getSimplifiedValue(const clang::ento::CallEventRef<T>& Val) { 91657c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose return Val.getPtr(); 91757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } 91857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose }; 91957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose} 92057c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 921740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#endif 922