CallEvent.h revision 0a6e09f67c719c318856be19d57e19972101f62c
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/AST/DeclCXX.h" 20740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/AST/ExprCXX.h" 21740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/AST/ExprObjC.h" 22a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek#include "clang/Analysis/AnalysisContext.h" 2330a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "clang/Basic/SourceManager.h" 24de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h" 25740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h" 26b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose#include "llvm/ADT/PointerIntPair.h" 27740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 28740d490593e0de8732a697c9f77b90ddd463863bJordan Rosenamespace clang { 2928038f33aa2db4833881fea757a1f0daf85ac02bJordan Roseclass ProgramPoint; 3028038f33aa2db4833881fea757a1f0daf85ac02bJordan Roseclass ProgramPointTag; 3128038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 32740d490593e0de8732a697c9f77b90ddd463863bJordan Rosenamespace ento { 33740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 34740d490593e0de8732a697c9f77b90ddd463863bJordan Roseenum CallEventKind { 35740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_Function, 36740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_Block, 37740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_BEG_SIMPLE_CALLS = CE_Function, 38740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_END_SIMPLE_CALLS = CE_Block, 39645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CE_CXXMember, 40645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CE_CXXMemberOperator, 418d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose CE_CXXDestructor, 42645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CE_BEG_CXX_INSTANCE_CALLS = CE_CXXMember, 43645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CE_END_CXX_INSTANCE_CALLS = CE_CXXDestructor, 44645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CE_CXXConstructor, 4570cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose CE_CXXAllocator, 46740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_BEG_FUNCTION_CALLS = CE_Function, 4770cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose CE_END_FUNCTION_CALLS = CE_CXXAllocator, 488919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose CE_ObjCMessage 49740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 50740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 51972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseclass CallEvent; 52d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseclass CallEventManager; 53972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 54d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosetemplate<typename T = CallEvent> 55d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseclass CallEventRef : public IntrusiveRefCntPtr<const T> { 56d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 57d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef(const T *Call) : IntrusiveRefCntPtr<const T>(Call) {} 58d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef(const CallEventRef &Orig) : IntrusiveRefCntPtr<const T>(Orig) {} 59d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 60d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<T> cloneWithState(ProgramStateRef State) const { 61d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return this->getPtr()->template cloneWithState<T>(State); 62d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 6357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 6457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose // Allow implicit conversions to a superclass type, since CallEventRef 6557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose // behaves like a pointer-to-const. 6657c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose template <typename SuperT> 6757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose operator CallEventRef<SuperT> () const { 6857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose return this->getPtr(); 6957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } 70d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose}; 71b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 721becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks/// \class RuntimeDefinition 735960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks/// \brief Defines the runtime definition of the called function. 741becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks/// 751becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks/// Encapsulates the information we have about which Decl will be used 761becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks/// when the call is executed on the given path. When dealing with dynamic 771becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks/// dispatch, the information is based on DynamicTypeInfo and might not be 781becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks/// precise. 79fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaksclass RuntimeDefinition { 801becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// The Declaration of the function which could be called at runtime. 811becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// NULL if not available. 82fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks const Decl *D; 835960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks 845960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks /// The region representing an object (ObjC/C++) on which the method is 855960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks /// called. With dynamic dispatch, the method definition depends on the 861becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// runtime type of this object. NULL when the DynamicTypeInfo is 871becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// precise. 88fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks const MemRegion *R; 895960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks 90fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zakspublic: 91fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks RuntimeDefinition(): D(0), R(0) {} 92fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks RuntimeDefinition(const Decl *InD): D(InD), R(0) {} 93fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks RuntimeDefinition(const Decl *InD, const MemRegion *InR): D(InD), R(InR) {} 945960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks const Decl *getDecl() { return D; } 951becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks 961becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// \brief Check if the definition we have is precise. 971becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// If not, it is possible that the call dispatches to another definition at 981becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// execution time. 995960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks bool mayHaveOtherDefinitions() { return R != 0; } 1001becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks 1011becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// When other definitions are possible, returns the region whose runtime type 1021becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// determines the method definition. 1031becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks const MemRegion *getDispatchRegion() { return R; } 104e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks}; 105e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 106740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents an abstract call to a function or method along a 107740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// particular path. 108972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// 109972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEvents are created through the factory methods of CallEventManager. 110972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// 111972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEvents should always be cheap to create and destroy. In order for 112972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEventManager to be able to re-use CallEvent-sized memory blocks, 113972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// subclasses of CallEvent may not add any data members to the base class. 114972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// Use the "Data" and "Location" fields instead. 115740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass CallEvent { 116740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 117740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef CallEventKind Kind; 118740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 119b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Roseprivate: 1207c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose ProgramStateRef State; 1217c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx; 122b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose llvm::PointerUnion<const Expr *, const Decl *> Origin; 123b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 124f56faa01936b9cf909623d7f06e3c2569ca4a78eDmitri Gribenko void operator=(const CallEvent &) LLVM_DELETED_FUNCTION; 1257c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 126740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 127b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose // This is user data for subclasses. 128b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose const void *Data; 129972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 130972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // This is user data for subclasses. 131972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // This should come right before RefCount, so that the two fields can be 132972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // packed together on LP64 platforms. 133b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose SourceLocation Location; 134b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 135972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprivate: 136972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose mutable unsigned RefCount; 137972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 138972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose template <typename T> friend struct llvm::IntrusiveRefCntPtrInfo; 139972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void Retain() const { ++RefCount; } 140972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void Release() const; 141972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 142972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprotected: 143d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 144d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 1450a6e09f67c719c318856be19d57e19972101f62cJordan Rose CallEvent(const Expr *E, const ProgramStateRef &state, 1460a6e09f67c719c318856be19d57e19972101f62cJordan Rose const LocationContext *lctx) 147972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : State(state), LCtx(lctx), Origin(E), RefCount(0) {} 148b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 1490a6e09f67c719c318856be19d57e19972101f62cJordan Rose CallEvent(const Decl *D, const ProgramStateRef &state, 1500a6e09f67c719c318856be19d57e19972101f62cJordan Rose const LocationContext *lctx) 151972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : State(state), LCtx(lctx), Origin(D), RefCount(0) {} 152972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 153972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // DO NOT MAKE PUBLIC 154972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEvent(const CallEvent &Original) 155972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : State(Original.State), LCtx(Original.LCtx), Origin(Original.Origin), 156972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Data(Original.Data), Location(Original.Location), RefCount(0) {} 157b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 158972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Copies this CallEvent, with vtable intact, into a new block of memory. 159972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const = 0; 160972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 161740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Get the value of arbitrary expressions at this point in the path. 162740d490593e0de8732a697c9f77b90ddd463863bJordan Rose SVal getSVal(const Stmt *S) const { 163b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getState()->getSVal(S, getLocationContext()); 164740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 165740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 166972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 167740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef SmallVectorImpl<const MemRegion *> RegionList; 168740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 169740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Used to specify non-argument regions that will be invalidated as a 170740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// result of this call. 1717c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const {} 172740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 173740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 1747c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual ~CallEvent() {} 1757c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 176b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \brief Returns the kind of call this is. 1777c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const = 0; 178b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 179740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the declaration of the function or method that will be 180740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// called. May be null. 1817c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getDecl() const { 1827c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return Origin.dyn_cast<const Decl *>(); 1837c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 184740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 1855a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks /// \brief The state in which the call is being evaluated. 1860a6e09f67c719c318856be19d57e19972101f62cJordan Rose const ProgramStateRef &getState() const { 1875a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks return State; 1885a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 1895a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 1905a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks /// \brief The context in which the call is being evaluated. 1915a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks const LocationContext *getLocationContext() const { 1925a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks return LCtx; 1935a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 1945a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 195ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose /// \brief Returns the definition of the function or method that will be 1965960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks /// called. 197ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek virtual RuntimeDefinition getRuntimeDefinition() const = 0; 198ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 199740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the expression whose value will be the result of this call. 200740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// May be null. 201b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose const Expr *getOriginExpr() const { 202b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return Origin.dyn_cast<const Expr *>(); 203b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 204740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 205740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the number of arguments (explicit and implicit). 206740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// 207740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// Note that this may be greater than the number of parameters in the 208740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// callee's declaration, and that it may include arguments not written in 209740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// the source. 2107c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const = 0; 211740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 212740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns true if the callee is known to be from a system header. 213740d490593e0de8732a697c9f77b90ddd463863bJordan Rose bool isInSystemHeader() const { 214740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const Decl *D = getDecl(); 215740d490593e0de8732a697c9f77b90ddd463863bJordan Rose if (!D) 216740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return false; 217740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 218740d490593e0de8732a697c9f77b90ddd463863bJordan Rose SourceLocation Loc = D->getLocation(); 219740d490593e0de8732a697c9f77b90ddd463863bJordan Rose if (Loc.isValid()) { 220740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const SourceManager &SM = 221b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose getState()->getStateManager().getContext().getSourceManager(); 222740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return SM.isInSystemHeader(D->getLocation()); 223740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 224740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 225740d490593e0de8732a697c9f77b90ddd463863bJordan Rose // Special case for implicitly-declared global operator new/delete. 226740d490593e0de8732a697c9f77b90ddd463863bJordan Rose // These should be considered system functions. 227740d490593e0de8732a697c9f77b90ddd463863bJordan Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) 228740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return FD->isOverloadedOperator() && FD->isImplicit() && FD->isGlobal(); 229740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 230740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return false; 231740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 232740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 233de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose /// \brief Returns a source range for the entire call, suitable for 234de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose /// outputting in diagnostics. 2357c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getSourceRange() const { 2367c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return getOriginExpr()->getSourceRange(); 2377c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 238de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose 239740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the value of a given argument at the time of the call. 2407c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getArgSVal(unsigned Index) const; 241740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 242740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the expression associated with a given argument. 243740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// May be null if this expression does not appear in the source. 2447c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { return 0; } 245740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 246740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the source range for errors associated with this argument. 2477c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose /// 248740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// May be invalid if the argument is not written in the source. 2497c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getArgSourceRange(unsigned Index) const; 250740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 251740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the result type, adjusted for references. 252740d490593e0de8732a697c9f77b90ddd463863bJordan Rose QualType getResultType() const; 253740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 2542f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// \brief Returns the return value of the call. 2552f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// 2562f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// This should only be called if the CallEvent was created using a state in 2572f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// which the return value has already been bound to the origin expression. 2582f3017f9cbd3774f690c979410bfec38423d03afJordan Rose SVal getReturnValue() const; 2592f3017f9cbd3774f690c979410bfec38423d03afJordan Rose 260740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns true if any of the arguments appear to represent callbacks. 261740d490593e0de8732a697c9f77b90ddd463863bJordan Rose bool hasNonZeroCallbackArg() const; 262740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 26385d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose /// \brief Returns true if any of the arguments are known to escape to long- 26485d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose /// term storage, even if this method will not modify them. 26585d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose // NOTE: The exact semantics of this are still being defined! 26685d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose // We don't really want a list of hardcoded exceptions in the long run, 26785d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose // but we don't want duplicated lists of known APIs in the short term either. 2687c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual bool argumentsMayEscape() const { 2697c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return hasNonZeroCallbackArg(); 2707c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 27185d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose 2722f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// \brief Returns true if the callee is an externally-visible function in the 2732f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// top-level namespace, such as \c malloc. 2742f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// 2752f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// You can use this call to determine that a particular function really is 2762f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// a library function and not, say, a C++ member function with the same name. 2772f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// 2782f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// If a name is provided, the function must additionally match the given 2792f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// name. 2802f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// 2812f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// Note that this deliberately excludes C++ library functions in the \c std 2822f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// namespace, but will include C library functions accessed through the 2832f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// \c std namespace. This also does not check if the function is declared 2842f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// as 'extern "C"', or if it uses C++ name mangling. 2852f3017f9cbd3774f690c979410bfec38423d03afJordan Rose // FIXME: Add a helper for checking namespaces. 2862f3017f9cbd3774f690c979410bfec38423d03afJordan Rose // FIXME: Move this down to AnyFunctionCall once checkers have more 2872f3017f9cbd3774f690c979410bfec38423d03afJordan Rose // precise callbacks. 2882f3017f9cbd3774f690c979410bfec38423d03afJordan Rose bool isGlobalCFunction(StringRef SpecificName = StringRef()) const; 2892f3017f9cbd3774f690c979410bfec38423d03afJordan Rose 2902f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// \brief Returns the name of the callee, if its name is a simple identifier. 2912f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// 2922f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// Note that this will fail for Objective-C methods, blocks, and C++ 2932f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// overloaded operators. The former is named by a Selector rather than a 2942f3017f9cbd3774f690c979410bfec38423d03afJordan Rose /// simple identifier, and the latter two do not have names. 2952f3017f9cbd3774f690c979410bfec38423d03afJordan Rose // FIXME: Move this down to AnyFunctionCall once checkers have more 2962f3017f9cbd3774f690c979410bfec38423d03afJordan Rose // precise callbacks. 2972f3017f9cbd3774f690c979410bfec38423d03afJordan Rose const IdentifierInfo *getCalleeIdentifier() const { 2982f3017f9cbd3774f690c979410bfec38423d03afJordan Rose const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(getDecl()); 2992f3017f9cbd3774f690c979410bfec38423d03afJordan Rose if (!ND) 3002f3017f9cbd3774f690c979410bfec38423d03afJordan Rose return 0; 3012f3017f9cbd3774f690c979410bfec38423d03afJordan Rose return ND->getIdentifier(); 3022f3017f9cbd3774f690c979410bfec38423d03afJordan Rose } 3032f3017f9cbd3774f690c979410bfec38423d03afJordan Rose 30428038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose /// \brief Returns an appropriate ProgramPoint for this call. 3058d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose ProgramPoint getProgramPoint(bool IsPreVisit = false, 30628038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose const ProgramPointTag *Tag = 0) const; 30728038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 308740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns a new state with all argument regions invalidated. 309740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// 310740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// This accepts an alternate state in case some processing has already 311740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// occurred. 312740d490593e0de8732a697c9f77b90ddd463863bJordan Rose ProgramStateRef invalidateRegions(unsigned BlockCount, 313740d490593e0de8732a697c9f77b90ddd463863bJordan Rose ProgramStateRef Orig = 0) const; 314740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 315ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose typedef std::pair<Loc, SVal> FrameBindingTy; 316ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose typedef SmallVectorImpl<FrameBindingTy> BindingsTy; 317ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 318ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// Populates the given SmallVector with the bindings in the callee's stack 319ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// frame at the start of this call. 320ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 321ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const = 0; 322ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 323972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Returns a copy of this CallEvent, but using the given state. 324972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose template <typename T> 325d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<T> cloneWithState(ProgramStateRef NewState) const; 326972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 327972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Returns a copy of this CallEvent, but using the given state. 328d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<> cloneWithState(ProgramStateRef NewState) const { 329972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return cloneWithState<CallEvent>(NewState); 330972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 331972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 3326062334cc388bce69fb3978c4ecb26c6485a5c2bJordan Rose /// \brief Returns true if this is a statement is a function or method call 3336062334cc388bce69fb3978c4ecb26c6485a5c2bJordan Rose /// of some kind. 3346062334cc388bce69fb3978c4ecb26c6485a5c2bJordan Rose static bool isCallStmt(const Stmt *S); 33585d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose 33616e6a7cb41319459ded69b4d47f405c1035dd347Anna Zaks /// \brief Returns the result type of a function, method declaration. 33716e6a7cb41319459ded69b4d47f405c1035dd347Anna Zaks static QualType getDeclaredResultType(const Decl *D); 33816e6a7cb41319459ded69b4d47f405c1035dd347Anna Zaks 339e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // Iterator access to formal parameters and their types. 340740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprivate: 341740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef std::const_mem_fun_t<QualType, ParmVarDecl> get_type_fun; 342740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 343740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 344e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose typedef const ParmVarDecl * const *param_iterator; 345e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 346e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// Returns an iterator over the call's formal parameters. 347e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 348e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// If UseDefinitionParams is set, this will return the parameter decls 349e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// used in the callee's definition (suitable for inlining). Most of the 350e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// time it is better to use the decl found by name lookup, which likely 351e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// carries more annotations. 352e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 353e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// Remember that the number of formal parameters may not match the number 354e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// of arguments for all calls. However, the first parameter will always 355e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// correspond with the argument value returned by \c getArgSVal(0). 356e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 357e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// If the call has no accessible declaration (or definition, if 358e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \p UseDefinitionParams is set), \c param_begin() will be equal to 359e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \c param_end(). 360ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_begin() const =0; 361e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \sa param_begin() 362ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_end() const = 0; 363e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 364740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef llvm::mapped_iterator<param_iterator, get_type_fun> 365740d490593e0de8732a697c9f77b90ddd463863bJordan Rose param_type_iterator; 366740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 367e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// Returns an iterator over the types of the call's formal parameters. 368e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 369e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// This uses the callee decl found by default name lookup rather than the 370e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// definition because it represents a public interface, and probably has 371e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// more annotations. 372740d490593e0de8732a697c9f77b90ddd463863bJordan Rose param_type_iterator param_type_begin() const { 373740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return llvm::map_iterator(param_begin(), 374740d490593e0de8732a697c9f77b90ddd463863bJordan Rose get_type_fun(&ParmVarDecl::getType)); 375740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 376e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \sa param_type_begin() 377740d490593e0de8732a697c9f77b90ddd463863bJordan Rose param_type_iterator param_type_end() const { 378740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return llvm::map_iterator(param_end(), get_type_fun(&ParmVarDecl::getType)); 379740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 380740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 3810ffbfd1a7f80f9a3c07317cb8f44c562f2ba1ba5Jordan Rose // For debugging purposes only 382b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose void dump(raw_ostream &Out) const; 38342c72c258e08ca79c9267346b4badcddd8fcd001Benjamin Kramer LLVM_ATTRIBUTE_USED void dump() const; 384740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 385740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 386b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 387740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a call to any sort of function that might have a 388740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// FunctionDecl. 389740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass AnyFunctionCall : public CallEvent { 390740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 391b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose AnyFunctionCall(const Expr *E, ProgramStateRef St, 3927c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 3937c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CallEvent(E, St, LCtx) {} 394b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose AnyFunctionCall(const Decl *D, ProgramStateRef St, 3957c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 3967c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CallEvent(D, St, LCtx) {} 397972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose AnyFunctionCall(const AnyFunctionCall &Other) : CallEvent(Other) {} 398740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 399740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 400b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose // This function is overridden by subclasses, but they must return 401b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose // a FunctionDecl. 4027c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const FunctionDecl *getDecl() const { 4037c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return cast<FunctionDecl>(CallEvent::getDecl()); 404b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 405740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 406ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek virtual RuntimeDefinition getRuntimeDefinition() const { 407ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose const FunctionDecl *FD = getDecl(); 408a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek // Note that the AnalysisDeclContext will have the FunctionDecl with 409a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek // the definition (if one exists). 410a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek if (FD) { 411ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek AnalysisDeclContext *AD = 412ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek getLocationContext()->getAnalysisDeclContext()-> 413ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek getManager()->getContext(FD); 414a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek if (AD->getBody()) 415a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek return RuntimeDefinition(AD->getDecl()); 416a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek } 417a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek 418e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks return RuntimeDefinition(); 419ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose } 420ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 4217c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual bool argumentsMayEscape() const; 422b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 423ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 424ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 425ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 426ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_begin() const; 427ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_end() const; 428b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 429740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 430740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() >= CE_BEG_FUNCTION_CALLS && 431740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CA->getKind() <= CE_END_FUNCTION_CALLS; 432740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 433740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 434740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 435645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// \brief Represents a call to a non-C++ function, written as a CallExpr. 436740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass SimpleCall : public AnyFunctionCall { 437740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 438b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose SimpleCall(const CallExpr *CE, ProgramStateRef St, 4397c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 440972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : AnyFunctionCall(CE, St, LCtx) {} 441972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose SimpleCall(const SimpleCall &Other) : AnyFunctionCall(Other) {} 442740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 443740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 4447c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CallExpr *getOriginExpr() const { 445b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return cast<CallExpr>(AnyFunctionCall::getOriginExpr()); 446b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 447740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 4487c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const FunctionDecl *getDecl() const; 449740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 4507c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { return getOriginExpr()->getNumArgs(); } 4517c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 4527c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 453b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getArg(Index); 454740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 455740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 456740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 457740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() >= CE_BEG_SIMPLE_CALLS && 458740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CA->getKind() <= CE_END_SIMPLE_CALLS; 459740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 460740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 461740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 462740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a C function or static C++ member function call. 463740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// 464740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// Example: \c fun() 465740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass FunctionCall : public SimpleCall { 466d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 467972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 468d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 469740d490593e0de8732a697c9f77b90ddd463863bJordan Rose FunctionCall(const CallExpr *CE, ProgramStateRef St, 470740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const LocationContext *LCtx) 4717c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : SimpleCall(CE, St, LCtx) {} 472740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 473d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose FunctionCall(const FunctionCall &Other) : SimpleCall(Other) {} 474d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) FunctionCall(*this); } 475d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 476d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 4777c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_Function; } 478b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 479740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 480740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_Function; 481740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 482740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 483740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 484645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// \brief Represents a call to a block. 485645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// 486645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// Example: <tt>^{ /* ... */ }()</tt> 487645baeed6800f952e9ad1d5666e01080385531a2Jordan Roseclass BlockCall : public SimpleCall { 488645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose friend class CallEventManager; 489645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 490645baeed6800f952e9ad1d5666e01080385531a2Jordan Roseprotected: 491645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose BlockCall(const CallExpr *CE, ProgramStateRef St, 492645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const LocationContext *LCtx) 493645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose : SimpleCall(CE, St, LCtx) {} 494645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 495645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose BlockCall(const BlockCall &Other) : SimpleCall(Other) {} 496645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) BlockCall(*this); } 497645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 498645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 499645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 500645baeed6800f952e9ad1d5666e01080385531a2Jordan Rosepublic: 501645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \brief Returns the region associated with this instance of the block. 502645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// 503645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// This may be NULL if the block's origin is unknown. 504645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const BlockDataRegion *getBlockRegion() const; 505645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 506645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \brief Gets the declaration of the block. 507645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// 508645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// This is not an override of getDecl() because AnyFunctionCall has already 509645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// assumed that it's a FunctionDecl. 510645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const BlockDecl *getBlockDecl() const { 511645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const BlockDataRegion *BR = getBlockRegion(); 512645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose if (!BR) 513645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return 0; 514645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return BR->getDecl(); 515645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose } 516645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 517ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek virtual RuntimeDefinition getRuntimeDefinition() const { 518645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return RuntimeDefinition(getBlockDecl()); 519645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose } 520645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 521645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 522645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose BindingsTy &Bindings) const; 523645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 524645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual param_iterator param_begin() const; 525645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual param_iterator param_end() const; 526645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 527645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual Kind getKind() const { return CE_Block; } 528645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 529645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose static bool classof(const CallEvent *CA) { 530645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return CA->getKind() == CE_Block; 531645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose } 532645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose}; 533645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 534c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// \brief Represents a non-static C++ member function call, no matter how 535c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// it is written. 536645baeed6800f952e9ad1d5666e01080385531a2Jordan Roseclass CXXInstanceCall : public AnyFunctionCall { 537740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 5387c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 539740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 540c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CXXInstanceCall(const CallExpr *CE, ProgramStateRef St, 5417c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 542645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose : AnyFunctionCall(CE, St, LCtx) {} 543645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CXXInstanceCall(const FunctionDecl *D, ProgramStateRef St, 544645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const LocationContext *LCtx) 545645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose : AnyFunctionCall(D, St, LCtx) {} 546645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 547c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose 548645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CXXInstanceCall(const CXXInstanceCall &Other) : AnyFunctionCall(Other) {} 549972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 550c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rosepublic: 5519da59a67a27a4d3fc9d59552f07808a32f85e9d3Jordan Rose /// \brief Returns the expression representing the implicit 'this' object. 552645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual const Expr *getCXXThisExpr() const { return 0; } 5539da59a67a27a4d3fc9d59552f07808a32f85e9d3Jordan Rose 554ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// \brief Returns the value of the implicit 'this' object. 5556ebea89be233eaba5e29de8cf3524ad150c860bbJordan Rose virtual SVal getCXXThisVal() const; 556ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 557645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual const FunctionDecl *getDecl() const; 558645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 559ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek virtual RuntimeDefinition getRuntimeDefinition() const; 560c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose 561ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 562ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 563ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 564c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose static bool classof(const CallEvent *CA) { 565c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose return CA->getKind() >= CE_BEG_CXX_INSTANCE_CALLS && 566c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CA->getKind() <= CE_END_CXX_INSTANCE_CALLS; 567c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose } 568c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose}; 569c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose 570c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// \brief Represents a non-static C++ member function call. 571c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// 572c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// Example: \c obj.fun() 573c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Roseclass CXXMemberCall : public CXXInstanceCall { 574d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 575972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 576d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 577740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CXXMemberCall(const CXXMemberCallExpr *CE, ProgramStateRef St, 578c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const LocationContext *LCtx) 5797c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CXXInstanceCall(CE, St, LCtx) {} 580740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 581d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXMemberCall(const CXXMemberCall &Other) : CXXInstanceCall(Other) {} 582d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXMemberCall(*this); } 583d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 584d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 5857c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXMemberCallExpr *getOriginExpr() const { 586645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return cast<CXXMemberCallExpr>(CXXInstanceCall::getOriginExpr()); 587645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose } 588645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 589645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual unsigned getNumArgs() const { 590645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose if (const CallExpr *CE = getOriginExpr()) 591645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return CE->getNumArgs(); 592645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return 0; 593645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose } 594645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 595645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 596645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return getOriginExpr()->getArg(Index); 597740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 598740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 5999da59a67a27a4d3fc9d59552f07808a32f85e9d3Jordan Rose virtual const Expr *getCXXThisExpr() const; 60000b4f64ecb26b031c1f4888f39be6c706156356aJordan Rose 601ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek virtual RuntimeDefinition getRuntimeDefinition() const; 6027c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 6037c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXMember; } 604e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 605740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 606740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_CXXMember; 607740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 608740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 609740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 610fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// \brief Represents a C++ overloaded operator call where the operator is 611fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// implemented as a non-static member function. 612fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// 613fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// Example: <tt>iter + 1</tt> 614c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Roseclass CXXMemberOperatorCall : public CXXInstanceCall { 615d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 616d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 617972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprotected: 618d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXMemberOperatorCall(const CXXOperatorCallExpr *CE, ProgramStateRef St, 619d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) 620d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose : CXXInstanceCall(CE, St, LCtx) {} 621d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 622972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CXXMemberOperatorCall(const CXXMemberOperatorCall &Other) 623972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : CXXInstanceCall(Other) {} 624972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { 625972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose new (Dest) CXXMemberOperatorCall(*this); 626972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 627972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 628fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rosepublic: 6297c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXOperatorCallExpr *getOriginExpr() const { 630645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return cast<CXXOperatorCallExpr>(CXXInstanceCall::getOriginExpr()); 631fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 632fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 6337c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { 6347c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return getOriginExpr()->getNumArgs() - 1; 6357c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 6367c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 637fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return getOriginExpr()->getArg(Index + 1); 638fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 639fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 6409da59a67a27a4d3fc9d59552f07808a32f85e9d3Jordan Rose virtual const Expr *getCXXThisExpr() const; 6417c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 6427c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXMemberOperator; } 643e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 644fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose static bool classof(const CallEvent *CA) { 645fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return CA->getKind() == CE_CXXMemberOperator; 646fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 647fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose}; 648fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 649645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// \brief Represents an implicit call to a C++ destructor. 650740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// 651645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// This can occur at the end of a scope (for automatic objects), at the end 652645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// of a full-expression (for temporaries), or as part of a delete. 653645baeed6800f952e9ad1d5666e01080385531a2Jordan Roseclass CXXDestructorCall : public CXXInstanceCall { 654d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 655d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 656740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 657200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose typedef llvm::PointerIntPair<const MemRegion *, 1, bool> DtorDataTy; 658200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose 659645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// Creates an implicit destructor. 66069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// 661645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \param DD The destructor that will be called. 662645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \param Trigger The statement whose completion causes this destructor call. 663645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \param Target The object region to be destructed. 664645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \param St The path-sensitive state at this point in the program. 665645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \param LCtx The location context at this point in the program. 666645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger, 667200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose const MemRegion *Target, bool IsBaseDestructor, 668200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose ProgramStateRef St, const LocationContext *LCtx) 669645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose : CXXInstanceCall(DD, St, LCtx) { 670200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose Data = DtorDataTy(Target, IsBaseDestructor).getOpaqueValue(); 671645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose Location = Trigger->getLocEnd(); 672740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 673740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 674645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CXXDestructorCall(const CXXDestructorCall &Other) : CXXInstanceCall(Other) {} 675645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXDestructorCall(*this); } 676ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 677645baeed6800f952e9ad1d5666e01080385531a2Jordan Rosepublic: 678645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual SourceRange getSourceRange() const { return Location; } 679645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual unsigned getNumArgs() const { return 0; } 680ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 681ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek virtual RuntimeDefinition getRuntimeDefinition() const; 682200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose 683645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \brief Returns the value of the implicit 'this' object. 684645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual SVal getCXXThisVal() const; 685b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 686200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose /// Returns true if this is a call to a base class destructor. 687200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose bool isBaseDestructor() const { 688200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose return DtorDataTy::getFromOpaqueValue(Data).getInt(); 689200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose } 690200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose 691645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual Kind getKind() const { return CE_CXXDestructor; } 692b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 693740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 694645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return CA->getKind() == CE_CXXDestructor; 695740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 696740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 697740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 698740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a call to a C++ constructor. 699740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// 700740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// Example: \c T(1) 701740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass CXXConstructorCall : public AnyFunctionCall { 702d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 703b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 704d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 705d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// Creates a constructor call. 706d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// 707d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// \param CE The constructor expression as written in the source. 708d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// \param Target The region where the object should be constructed. If NULL, 709d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// a new symbolic region will be used. 710d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// \param St The path-sensitive state at this point in the program. 711d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// \param LCtx The location context at this point in the program. 71270517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko CXXConstructorCall(const CXXConstructExpr *CE, const MemRegion *Target, 713740d490593e0de8732a697c9f77b90ddd463863bJordan Rose ProgramStateRef St, const LocationContext *LCtx) 7147c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : AnyFunctionCall(CE, St, LCtx) { 71570517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko Data = Target; 716b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 717740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 718d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXConstructorCall(const CXXConstructorCall &Other) : AnyFunctionCall(Other){} 719d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXConstructorCall(*this); } 720d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 721d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 722d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 723d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 7247c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXConstructExpr *getOriginExpr() const { 725b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return cast<CXXConstructExpr>(AnyFunctionCall::getOriginExpr()); 726b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 727b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 7287c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXConstructorDecl *getDecl() const { 729b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getConstructor(); 730740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 731740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 7327c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { return getOriginExpr()->getNumArgs(); } 733740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 7347c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 735b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getArg(Index); 736740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 737740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 738ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// \brief Returns the value of the implicit 'this' object. 739645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose SVal getCXXThisVal() const; 7407c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 741ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 742ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 743ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 7447c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXConstructor; } 745e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 746740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 747740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_CXXConstructor; 748740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 749740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 750740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 7510e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose/// \brief Represents the memory allocation call in a C++ new-expression. 7520e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose/// 7530e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose/// This is a call to "operator new". 75470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Roseclass CXXAllocatorCall : public AnyFunctionCall { 755d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 756972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 757d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 758b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose CXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef St, 75970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose const LocationContext *LCtx) 7607c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : AnyFunctionCall(E, St, LCtx) {} 76170cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 762d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXAllocatorCall(const CXXAllocatorCall &Other) : AnyFunctionCall(Other) {} 763d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXAllocatorCall(*this); } 764d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 765d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 7667c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXNewExpr *getOriginExpr() const { 767b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return cast<CXXNewExpr>(AnyFunctionCall::getOriginExpr()); 768b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 769b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 7707c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const FunctionDecl *getDecl() const { 771b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getOperatorNew(); 77270cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose } 77370cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 7747c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { 775b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getNumPlacementArgs() + 1; 776b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 77770cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 7787c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 77970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // The first argument of an allocator call is the size of the allocation. 78070cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose if (Index == 0) 78170cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return 0; 782b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getPlacementArg(Index - 1); 78370cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose } 78470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 7857c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXAllocator; } 786b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 78770cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose static bool classof(const CallEvent *CE) { 78870cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return CE->getKind() == CE_CXXAllocator; 78970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose } 79070cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose}; 79170cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 7928919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose/// \brief Represents the ways an Objective-C message send can occur. 7938919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose// 7948919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose// Note to maintainers: OCM_Message should always be last, since it does not 7958919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose// need to fit in the Data field's low bits. 7968919e688dc610d1f632a4d43f7f1489f67255476Jordan Roseenum ObjCMessageKind { 7978919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose OCM_PropertyAccess, 7988919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose OCM_Subscript, 7998919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose OCM_Message 8008919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose}; 8018919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 802cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose/// \brief Represents any expression that calls an Objective-C method. 8038919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose/// 8048919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose/// This includes all of the kinds listed in ObjCMessageKind. 805cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Roseclass ObjCMethodCall : public CallEvent { 806d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 807d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 8088919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose const PseudoObjectExpr *getContainingPseudoObjectExpr() const; 809cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose 8108919e688dc610d1f632a4d43f7f1489f67255476Jordan Roseprotected: 811d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ObjCMethodCall(const ObjCMessageExpr *Msg, ProgramStateRef St, 812d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) 813d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose : CallEvent(Msg, St, LCtx) { 814d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose Data = 0; 815d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 816d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 817972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose ObjCMethodCall(const ObjCMethodCall &Other) : CallEvent(Other) {} 818972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { new (Dest) ObjCMethodCall(*this); } 819972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 8207c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 821740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 8223f558af01643787d209a133215b0abec81b5fe30Anna Zaks /// Check if the selector may have multiple definitions (may have overrides). 8233f558af01643787d209a133215b0abec81b5fe30Anna Zaks virtual bool canBeOverridenInSubclass(ObjCInterfaceDecl *IDecl, 8243f558af01643787d209a133215b0abec81b5fe30Anna Zaks Selector Sel) const; 8253f558af01643787d209a133215b0abec81b5fe30Anna Zaks 826740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 8277c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const ObjCMessageExpr *getOriginExpr() const { 8288919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return cast<ObjCMessageExpr>(CallEvent::getOriginExpr()); 829cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose } 8307c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const ObjCMethodDecl *getDecl() const { 831b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getMethodDecl(); 832b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 8337c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { 834b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getNumArgs(); 835b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 8367c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 837b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getArg(Index); 838b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 839740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 8408919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose bool isInstanceMessage() const { 8418919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getOriginExpr()->isInstanceMessage(); 8428919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 8438919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ObjCMethodFamily getMethodFamily() const { 8448919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getOriginExpr()->getMethodFamily(); 8458919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 8468919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose Selector getSelector() const { 8478919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getOriginExpr()->getSelector(); 8488919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 8498919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 8507c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getSourceRange() const; 8518919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 8520e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// \brief Returns the value of the receiver at the time of this call. 853740d490593e0de8732a697c9f77b90ddd463863bJordan Rose SVal getReceiverSVal() const; 854740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 8555a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks /// \brief Return the value of 'self' if available. 8565a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks SVal getSelfSVal() const; 8575a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 8580e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// \brief Get the interface for the receiver. 8590e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// 8600e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// This works whether this is an instance message or a class message. 8610e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// However, it currently just uses the static type of the receiver. 862cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const ObjCInterfaceDecl *getReceiverInterface() const { 863b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getReceiverInterface(); 864cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose } 865cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose 8665a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks /// \brief Checks if the receiver refers to 'self' or 'super'. 8675a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks bool isReceiverSelfOrSuper() const; 8685a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 86909647f28d7955d0c948ebbbb376a46844056f11aJordan Rose /// Returns how the message was written in the source (property access, 87009647f28d7955d0c948ebbbb376a46844056f11aJordan Rose /// subscript, or explicit message send). 8718919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ObjCMessageKind getMessageKind() const; 8728919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 87309647f28d7955d0c948ebbbb376a46844056f11aJordan Rose /// Returns true if this property access or subscript is a setter (has the 87409647f28d7955d0c948ebbbb376a46844056f11aJordan Rose /// form of an assignment). 8758919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose bool isSetter() const { 8768919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose switch (getMessageKind()) { 8778919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Message: 8788919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose llvm_unreachable("This is not a pseudo-object access!"); 8798919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_PropertyAccess: 8808919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getNumArgs() > 0; 8818919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Subscript: 8828919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getNumArgs() > 1; 8838919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 8848919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose llvm_unreachable("Unknown message kind"); 885740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 886740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 887ddc0c4814788dda4ef224cd4d22d07154a6ede49Ted Kremenek virtual RuntimeDefinition getRuntimeDefinition() const; 888ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 889ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 890ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 891ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 892ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_begin() const; 893ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_end() const; 894b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 8957c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_ObjCMessage; } 896b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 897740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 898740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_ObjCMessage; 899740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 900740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 901740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 902972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 903972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// \brief Manages the lifetime of CallEvent objects. 904972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// 905972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEventManager provides a way to create arbitrary CallEvents "on the 906972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// stack" as if they were value objects by keeping a cache of CallEvent-sized 907972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// memory blocks. The CallEvents created by CallEventManager are only valid 908972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// for the lifetime of the OwnedCallEvent that holds them; right now these 909972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// objects cannot be copied and ownership cannot be transferred. 910972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseclass CallEventManager { 911972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose friend class CallEvent; 912972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 913972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose llvm::BumpPtrAllocator &Alloc; 914d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose SmallVector<void *, 8> Cache; 915972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 916972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void reclaim(const void *Memory) { 917972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Cache.push_back(const_cast<void *>(Memory)); 918972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 919972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 920972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Returns memory that can be initialized as a CallEvent. 921972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void *allocate() { 922972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose if (Cache.empty()) 923972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return Alloc.Allocate<FunctionCall>(); 924972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose else 925972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return Cache.pop_back_val(); 926972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 927972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 928d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose template <typename T, typename Arg> 929d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose T *create(Arg A, ProgramStateRef St, const LocationContext *LCtx) { 930d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return new (allocate()) T(A, St, LCtx); 931d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 932d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 933d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose template <typename T, typename Arg1, typename Arg2> 934d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose T *create(Arg1 A1, Arg2 A2, ProgramStateRef St, const LocationContext *LCtx) { 935d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return new (allocate()) T(A1, A2, St, LCtx); 936d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 937d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 938d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose template <typename T, typename Arg1, typename Arg2, typename Arg3> 939d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose T *create(Arg1 A1, Arg2 A2, Arg3 A3, ProgramStateRef St, 940d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) { 941d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return new (allocate()) T(A1, A2, A3, St, LCtx); 942d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 943d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 944200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose template <typename T, typename Arg1, typename Arg2, typename Arg3, 945200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose typename Arg4> 946200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose T *create(Arg1 A1, Arg2 A2, Arg3 A3, Arg4 A4, ProgramStateRef St, 947200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose const LocationContext *LCtx) { 948200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose return new (allocate()) T(A1, A2, A3, A4, St, LCtx); 949200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose } 950200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose 951972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rosepublic: 952972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager(llvm::BumpPtrAllocator &alloc) : Alloc(alloc) {} 953d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 95457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 95557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose CallEventRef<> 95657c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getCaller(const StackFrameContext *CalleeCtx, ProgramStateRef State); 95757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 95857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 959645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CallEventRef<> 960d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getSimpleCall(const CallExpr *E, ProgramStateRef State, 961d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx); 962d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 963d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<ObjCMethodCall> 964d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getObjCMethodCall(const ObjCMessageExpr *E, ProgramStateRef State, 965d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) { 966d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return create<ObjCMethodCall>(E, State, LCtx); 967d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 968d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 969d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<CXXConstructorCall> 970d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getCXXConstructorCall(const CXXConstructExpr *E, const MemRegion *Target, 971d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef State, const LocationContext *LCtx) { 972d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return create<CXXConstructorCall>(E, Target, State, LCtx); 973d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 974d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 975d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<CXXDestructorCall> 976d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getCXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger, 977200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose const MemRegion *Target, bool IsBase, 978200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose ProgramStateRef State, const LocationContext *LCtx) { 979200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose return create<CXXDestructorCall>(DD, Trigger, Target, IsBase, State, LCtx); 980d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 981d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 982d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<CXXAllocatorCall> 983d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getCXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef State, 984d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) { 985d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return create<CXXAllocatorCall>(E, State, LCtx); 986d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 987972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose}; 988972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 989972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 990972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rosetemplate <typename T> 991d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan RoseCallEventRef<T> CallEvent::cloneWithState(ProgramStateRef NewState) const { 992972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(isa<T>(*this) && "Cloning to unrelated type"); 993972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(sizeof(T) == sizeof(CallEvent) && "Subclasses may not add fields"); 994972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 995d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose if (NewState == State) 996d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return cast<T>(this); 997d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 998972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager &Mgr = State->getStateManager().getCallEventManager(); 999972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose T *Copy = static_cast<T *>(Mgr.allocate()); 1000972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose cloneTo(Copy); 1001972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(Copy->getKind() == this->getKind() && "Bad copy"); 1002972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 1003972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Copy->State = NewState; 1004972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return Copy; 1005972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose} 1006972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 1007972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseinline void CallEvent::Release() const { 1008972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(RefCount > 0 && "Reference count is already zero."); 1009972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose --RefCount; 1010972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 1011972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose if (RefCount > 0) 1012972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return; 1013972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 1014972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager &Mgr = State->getStateManager().getCallEventManager(); 1015972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Mgr.reclaim(this); 1016972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 1017972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose this->~CallEvent(); 1018972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose} 1019972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 1020740d490593e0de8732a697c9f77b90ddd463863bJordan Rose} // end namespace ento 1021740d490593e0de8732a697c9f77b90ddd463863bJordan Rose} // end namespace clang 1022740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 102357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rosenamespace llvm { 102457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose // Support isa<>, cast<>, and dyn_cast<> for CallEventRef. 102557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose template<class T> struct simplify_type< clang::ento::CallEventRef<T> > { 102657c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose typedef const T *SimpleType; 102757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 102857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose static SimpleType 102957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getSimplifiedValue(const clang::ento::CallEventRef<T>& Val) { 103057c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose return Val.getPtr(); 103157c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } 103257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose }; 103357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose} 103457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 1035740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#endif 1036