CallEvent.h revision 16e6a7cb41319459ded69b4d47f405c1035dd347
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_Block, 36740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_BEG_SIMPLE_CALLS = CE_Function, 37740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_END_SIMPLE_CALLS = CE_Block, 38645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CE_CXXMember, 39645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CE_CXXMemberOperator, 408d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose CE_CXXDestructor, 41645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CE_BEG_CXX_INSTANCE_CALLS = CE_CXXMember, 42645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CE_END_CXX_INSTANCE_CALLS = CE_CXXDestructor, 43645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CE_CXXConstructor, 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 711becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks/// \class RuntimeDefinition 725960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks/// \brief Defines the runtime definition of the called function. 731becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks/// 741becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks/// Encapsulates the information we have about which Decl will be used 751becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks/// when the call is executed on the given path. When dealing with dynamic 761becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks/// dispatch, the information is based on DynamicTypeInfo and might not be 771becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks/// precise. 78fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaksclass RuntimeDefinition { 791becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// The Declaration of the function which could be called at runtime. 801becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// NULL if not available. 81fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks const Decl *D; 825960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks 835960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks /// The region representing an object (ObjC/C++) on which the method is 845960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks /// called. With dynamic dispatch, the method definition depends on the 851becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// runtime type of this object. NULL when the DynamicTypeInfo is 861becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// precise. 87fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks const MemRegion *R; 885960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks 89fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zakspublic: 90fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks RuntimeDefinition(): D(0), R(0) {} 91fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks RuntimeDefinition(const Decl *InD): D(InD), R(0) {} 92fc05decf08feefd2ffe8cc250219aee6eab3119cAnna Zaks RuntimeDefinition(const Decl *InD, const MemRegion *InR): D(InD), R(InR) {} 935960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks const Decl *getDecl() { return D; } 941becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks 951becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// \brief Check if the definition we have is precise. 961becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// If not, it is possible that the call dispatches to another definition at 971becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// execution time. 985960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks bool mayHaveOtherDefinitions() { return R != 0; } 991becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks 1001becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// When other definitions are possible, returns the region whose runtime type 1011becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks /// determines the method definition. 1021becab2120142b1be87d684a68d3bea98f5abfb5Anna Zaks const MemRegion *getDispatchRegion() { return R; } 103e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks}; 104e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks 105740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents an abstract call to a function or method along a 106740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// particular path. 107972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// 108972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEvents are created through the factory methods of CallEventManager. 109972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// 110972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEvents should always be cheap to create and destroy. In order for 111972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEventManager to be able to re-use CallEvent-sized memory blocks, 112972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// subclasses of CallEvent may not add any data members to the base class. 113972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// Use the "Data" and "Location" fields instead. 114740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass CallEvent { 115740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 116740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef CallEventKind Kind; 117740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 118b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Roseprivate: 1197c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose ProgramStateRef State; 1207c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx; 121b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose llvm::PointerUnion<const Expr *, const Decl *> Origin; 122b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 123972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // DO NOT IMPLEMENT 1247c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose CallEvent &operator=(const CallEvent &); 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 1457c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose CallEvent(const Expr *E, ProgramStateRef state, const LocationContext *lctx) 146972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : State(state), LCtx(lctx), Origin(E), RefCount(0) {} 147b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 1487c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose CallEvent(const Decl *D, ProgramStateRef state, const LocationContext *lctx) 149972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : State(state), LCtx(lctx), Origin(D), RefCount(0) {} 150972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 151972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // DO NOT MAKE PUBLIC 152972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEvent(const CallEvent &Original) 153972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : State(Original.State), LCtx(Original.LCtx), Origin(Original.Origin), 154972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Data(Original.Data), Location(Original.Location), RefCount(0) {} 155b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 156972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Copies this CallEvent, with vtable intact, into a new block of memory. 157972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const = 0; 158972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 159740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Get the value of arbitrary expressions at this point in the path. 160740d490593e0de8732a697c9f77b90ddd463863bJordan Rose SVal getSVal(const Stmt *S) const { 161b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getState()->getSVal(S, getLocationContext()); 162740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 163740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 164972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 165740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef SmallVectorImpl<const MemRegion *> RegionList; 166740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 167740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Used to specify non-argument regions that will be invalidated as a 168740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// result of this call. 1697c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const {} 170740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 171740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 1727c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual ~CallEvent() {} 1737c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 174b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \brief Returns the kind of call this is. 1757c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const = 0; 176b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 177740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the declaration of the function or method that will be 178740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// called. May be null. 1797c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getDecl() const { 1807c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return Origin.dyn_cast<const Decl *>(); 1817c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 182740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 1835a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks /// \brief The state in which the call is being evaluated. 1845a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks ProgramStateRef getState() const { 1855a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks return State; 1865a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 1875a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 1885a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks /// \brief The context in which the call is being evaluated. 1895a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks const LocationContext *getLocationContext() const { 1905a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks return LCtx; 1915a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 1925a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 193ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose /// \brief Returns the definition of the function or method that will be 1945960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks /// called. 195e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks virtual RuntimeDefinition getRuntimeDefinition() const = 0; 196ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 197740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the expression whose value will be the result of this call. 198740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// May be null. 199b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose const Expr *getOriginExpr() const { 200b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return Origin.dyn_cast<const Expr *>(); 201b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 202740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 203740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the number of arguments (explicit and implicit). 204740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// 205740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// Note that this may be greater than the number of parameters in the 206740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// callee's declaration, and that it may include arguments not written in 207740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// the source. 2087c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const = 0; 209740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 210740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns true if the callee is known to be from a system header. 211740d490593e0de8732a697c9f77b90ddd463863bJordan Rose bool isInSystemHeader() const { 212740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const Decl *D = getDecl(); 213740d490593e0de8732a697c9f77b90ddd463863bJordan Rose if (!D) 214740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return false; 215740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 216740d490593e0de8732a697c9f77b90ddd463863bJordan Rose SourceLocation Loc = D->getLocation(); 217740d490593e0de8732a697c9f77b90ddd463863bJordan Rose if (Loc.isValid()) { 218740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const SourceManager &SM = 219b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose getState()->getStateManager().getContext().getSourceManager(); 220740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return SM.isInSystemHeader(D->getLocation()); 221740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 222740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 223740d490593e0de8732a697c9f77b90ddd463863bJordan Rose // Special case for implicitly-declared global operator new/delete. 224740d490593e0de8732a697c9f77b90ddd463863bJordan Rose // These should be considered system functions. 225740d490593e0de8732a697c9f77b90ddd463863bJordan Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) 226740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return FD->isOverloadedOperator() && FD->isImplicit() && FD->isGlobal(); 227740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 228740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return false; 229740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 230740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 231de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose /// \brief Returns a source range for the entire call, suitable for 232de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose /// outputting in diagnostics. 2337c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getSourceRange() const { 2347c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return getOriginExpr()->getSourceRange(); 2357c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 236de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose 237740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the value of a given argument at the time of the call. 2387c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getArgSVal(unsigned Index) const; 239740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 240740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the expression associated with a given argument. 241740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// May be null if this expression does not appear in the source. 2427c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { return 0; } 243740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 244740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the source range for errors associated with this argument. 2457c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose /// 246740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// May be invalid if the argument is not written in the source. 2477c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getArgSourceRange(unsigned Index) const; 248740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 249740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the result type, adjusted for references. 250740d490593e0de8732a697c9f77b90ddd463863bJordan Rose QualType getResultType() const; 251740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 252740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns true if any of the arguments appear to represent callbacks. 253740d490593e0de8732a697c9f77b90ddd463863bJordan Rose bool hasNonZeroCallbackArg() const; 254740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 25585d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose /// \brief Returns true if any of the arguments are known to escape to long- 25685d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose /// term storage, even if this method will not modify them. 25785d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose // NOTE: The exact semantics of this are still being defined! 25885d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose // We don't really want a list of hardcoded exceptions in the long run, 25985d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose // but we don't want duplicated lists of known APIs in the short term either. 2607c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual bool argumentsMayEscape() const { 2617c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return hasNonZeroCallbackArg(); 2627c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 26385d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose 26428038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose /// \brief Returns an appropriate ProgramPoint for this call. 2658d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose ProgramPoint getProgramPoint(bool IsPreVisit = false, 26628038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose const ProgramPointTag *Tag = 0) const; 26728038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 268740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns a new state with all argument regions invalidated. 269740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// 270740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// This accepts an alternate state in case some processing has already 271740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// occurred. 272740d490593e0de8732a697c9f77b90ddd463863bJordan Rose ProgramStateRef invalidateRegions(unsigned BlockCount, 273740d490593e0de8732a697c9f77b90ddd463863bJordan Rose ProgramStateRef Orig = 0) const; 274740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 275ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose typedef std::pair<Loc, SVal> FrameBindingTy; 276ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose typedef SmallVectorImpl<FrameBindingTy> BindingsTy; 277ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 278ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// Populates the given SmallVector with the bindings in the callee's stack 279ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// frame at the start of this call. 280ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 281ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const = 0; 282ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 283972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Returns a copy of this CallEvent, but using the given state. 284972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose template <typename T> 285d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<T> cloneWithState(ProgramStateRef NewState) const; 286972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 287972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Returns a copy of this CallEvent, but using the given state. 288d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<> cloneWithState(ProgramStateRef NewState) const { 289972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return cloneWithState<CallEvent>(NewState); 290972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 291972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 2926062334cc388bce69fb3978c4ecb26c6485a5c2bJordan Rose /// \brief Returns true if this is a statement is a function or method call 2936062334cc388bce69fb3978c4ecb26c6485a5c2bJordan Rose /// of some kind. 2946062334cc388bce69fb3978c4ecb26c6485a5c2bJordan Rose static bool isCallStmt(const Stmt *S); 29585d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose 29616e6a7cb41319459ded69b4d47f405c1035dd347Anna Zaks /// \brief Returns the result type of a function, method declaration. 29716e6a7cb41319459ded69b4d47f405c1035dd347Anna Zaks static QualType getDeclaredResultType(const Decl *D); 29816e6a7cb41319459ded69b4d47f405c1035dd347Anna Zaks 299e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // Iterator access to formal parameters and their types. 300740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprivate: 301740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef std::const_mem_fun_t<QualType, ParmVarDecl> get_type_fun; 302740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 303740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 304e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose typedef const ParmVarDecl * const *param_iterator; 305e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 306e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// Returns an iterator over the call's formal parameters. 307e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 308e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// If UseDefinitionParams is set, this will return the parameter decls 309e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// used in the callee's definition (suitable for inlining). Most of the 310e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// time it is better to use the decl found by name lookup, which likely 311e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// carries more annotations. 312e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 313e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// Remember that the number of formal parameters may not match the number 314e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// of arguments for all calls. However, the first parameter will always 315e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// correspond with the argument value returned by \c getArgSVal(0). 316e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 317e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// If the call has no accessible declaration (or definition, if 318e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \p UseDefinitionParams is set), \c param_begin() will be equal to 319e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \c param_end(). 320ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_begin() const =0; 321e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \sa param_begin() 322ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_end() const = 0; 323e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 324740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef llvm::mapped_iterator<param_iterator, get_type_fun> 325740d490593e0de8732a697c9f77b90ddd463863bJordan Rose param_type_iterator; 326740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 327e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// Returns an iterator over the types of the call's formal parameters. 328e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 329e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// This uses the callee decl found by default name lookup rather than the 330e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// definition because it represents a public interface, and probably has 331e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// more annotations. 332740d490593e0de8732a697c9f77b90ddd463863bJordan Rose param_type_iterator param_type_begin() const { 333740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return llvm::map_iterator(param_begin(), 334740d490593e0de8732a697c9f77b90ddd463863bJordan Rose get_type_fun(&ParmVarDecl::getType)); 335740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 336e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \sa param_type_begin() 337740d490593e0de8732a697c9f77b90ddd463863bJordan Rose param_type_iterator param_type_end() const { 338740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return llvm::map_iterator(param_end(), get_type_fun(&ParmVarDecl::getType)); 339740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 340740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 3410ffbfd1a7f80f9a3c07317cb8f44c562f2ba1ba5Jordan Rose // For debugging purposes only 342b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose void dump(raw_ostream &Out) const; 34342c72c258e08ca79c9267346b4badcddd8fcd001Benjamin Kramer LLVM_ATTRIBUTE_USED void dump() const; 3440ffbfd1a7f80f9a3c07317cb8f44c562f2ba1ba5Jordan Rose 345740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *) { return true; } 346740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 347740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 348b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 349740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a call to any sort of function that might have a 350740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// FunctionDecl. 351740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass AnyFunctionCall : public CallEvent { 352740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 353b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose AnyFunctionCall(const Expr *E, ProgramStateRef St, 3547c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 3557c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CallEvent(E, St, LCtx) {} 356b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose AnyFunctionCall(const Decl *D, ProgramStateRef St, 3577c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 3587c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CallEvent(D, St, LCtx) {} 359972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose AnyFunctionCall(const AnyFunctionCall &Other) : CallEvent(Other) {} 360740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 361740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 362b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose // This function is overridden by subclasses, but they must return 363b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose // a FunctionDecl. 3647c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const FunctionDecl *getDecl() const { 3657c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return cast<FunctionDecl>(CallEvent::getDecl()); 366b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 367740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 368e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks virtual RuntimeDefinition getRuntimeDefinition() const { 369ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose const FunctionDecl *FD = getDecl(); 370ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose // Note that hasBody() will fill FD with the definition FunctionDecl. 371ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose if (FD && FD->hasBody(FD)) 3725960f4aeac9760198c80e05d70d8dadb1db0ff0eAnna Zaks return RuntimeDefinition(FD); 373e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks return RuntimeDefinition(); 374ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose } 375ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 3767c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual bool argumentsMayEscape() const; 377b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 378ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 379ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 380ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 381ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_begin() const; 382ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_end() const; 383b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 384740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 385740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() >= CE_BEG_FUNCTION_CALLS && 386740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CA->getKind() <= CE_END_FUNCTION_CALLS; 387740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 388740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 389740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 390645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// \brief Represents a call to a non-C++ function, written as a CallExpr. 391740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass SimpleCall : public AnyFunctionCall { 392740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 393b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose SimpleCall(const CallExpr *CE, ProgramStateRef St, 3947c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 395972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : AnyFunctionCall(CE, St, LCtx) {} 396972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose SimpleCall(const SimpleCall &Other) : AnyFunctionCall(Other) {} 397740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 398740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 3997c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CallExpr *getOriginExpr() const { 400b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return cast<CallExpr>(AnyFunctionCall::getOriginExpr()); 401b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 402740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 4037c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const FunctionDecl *getDecl() const; 404740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 4057c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { return getOriginExpr()->getNumArgs(); } 4067c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 4077c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 408b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getArg(Index); 409740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 410740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 411740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 412740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() >= CE_BEG_SIMPLE_CALLS && 413740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CA->getKind() <= CE_END_SIMPLE_CALLS; 414740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 415740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 416740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 417740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a C function or static C++ member function call. 418740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// 419740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// Example: \c fun() 420740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass FunctionCall : public SimpleCall { 421d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 422972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 423d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 424740d490593e0de8732a697c9f77b90ddd463863bJordan Rose FunctionCall(const CallExpr *CE, ProgramStateRef St, 425740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const LocationContext *LCtx) 4267c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : SimpleCall(CE, St, LCtx) {} 427740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 428d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose FunctionCall(const FunctionCall &Other) : SimpleCall(Other) {} 429d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) FunctionCall(*this); } 430d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 431d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 4327c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_Function; } 433b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 434740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 435740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_Function; 436740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 437740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 438740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 439645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// \brief Represents a call to a block. 440645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// 441645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// Example: <tt>^{ /* ... */ }()</tt> 442645baeed6800f952e9ad1d5666e01080385531a2Jordan Roseclass BlockCall : public SimpleCall { 443645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose friend class CallEventManager; 444645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 445645baeed6800f952e9ad1d5666e01080385531a2Jordan Roseprotected: 446645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose BlockCall(const CallExpr *CE, ProgramStateRef St, 447645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const LocationContext *LCtx) 448645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose : SimpleCall(CE, St, LCtx) {} 449645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 450645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose BlockCall(const BlockCall &Other) : SimpleCall(Other) {} 451645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) BlockCall(*this); } 452645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 453645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 454645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 455645baeed6800f952e9ad1d5666e01080385531a2Jordan Rosepublic: 456645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \brief Returns the region associated with this instance of the block. 457645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// 458645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// This may be NULL if the block's origin is unknown. 459645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const BlockDataRegion *getBlockRegion() const; 460645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 461645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \brief Gets the declaration of the block. 462645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// 463645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// This is not an override of getDecl() because AnyFunctionCall has already 464645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// assumed that it's a FunctionDecl. 465645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const BlockDecl *getBlockDecl() const { 466645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const BlockDataRegion *BR = getBlockRegion(); 467645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose if (!BR) 468645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return 0; 469645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return BR->getDecl(); 470645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose } 471645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 472645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual RuntimeDefinition getRuntimeDefinition() const { 473645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return RuntimeDefinition(getBlockDecl()); 474645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose } 475645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 476645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 477645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose BindingsTy &Bindings) const; 478645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 479645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual param_iterator param_begin() const; 480645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual param_iterator param_end() const; 481645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 482645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual Kind getKind() const { return CE_Block; } 483645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 484645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose static bool classof(const CallEvent *CA) { 485645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return CA->getKind() == CE_Block; 486645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose } 487645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose}; 488645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 489c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// \brief Represents a non-static C++ member function call, no matter how 490c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// it is written. 491645baeed6800f952e9ad1d5666e01080385531a2Jordan Roseclass CXXInstanceCall : public AnyFunctionCall { 492740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 4937c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 494740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 495c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CXXInstanceCall(const CallExpr *CE, ProgramStateRef St, 4967c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 497645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose : AnyFunctionCall(CE, St, LCtx) {} 498645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CXXInstanceCall(const FunctionDecl *D, ProgramStateRef St, 499645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose const LocationContext *LCtx) 500645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose : AnyFunctionCall(D, St, LCtx) {} 501645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 502c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose 503645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CXXInstanceCall(const CXXInstanceCall &Other) : AnyFunctionCall(Other) {} 504972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 505c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rosepublic: 5069da59a67a27a4d3fc9d59552f07808a32f85e9d3Jordan Rose /// \brief Returns the expression representing the implicit 'this' object. 507645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual const Expr *getCXXThisExpr() const { return 0; } 5089da59a67a27a4d3fc9d59552f07808a32f85e9d3Jordan Rose 509ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// \brief Returns the value of the implicit 'this' object. 5106ebea89be233eaba5e29de8cf3524ad150c860bbJordan Rose virtual SVal getCXXThisVal() const; 511ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 512645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual const FunctionDecl *getDecl() const; 513645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 514e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks virtual RuntimeDefinition getRuntimeDefinition() const; 515c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose 516ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 517ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 518ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 519c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose static bool classof(const CallEvent *CA) { 520c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose return CA->getKind() >= CE_BEG_CXX_INSTANCE_CALLS && 521c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CA->getKind() <= CE_END_CXX_INSTANCE_CALLS; 522c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose } 523c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose}; 524c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose 525c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// \brief Represents a non-static C++ member function call. 526c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// 527c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// Example: \c obj.fun() 528c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Roseclass CXXMemberCall : public CXXInstanceCall { 529d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 530972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 531d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 532740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CXXMemberCall(const CXXMemberCallExpr *CE, ProgramStateRef St, 533c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const LocationContext *LCtx) 5347c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CXXInstanceCall(CE, St, LCtx) {} 535740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 536d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXMemberCall(const CXXMemberCall &Other) : CXXInstanceCall(Other) {} 537d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXMemberCall(*this); } 538d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 539d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 5407c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXMemberCallExpr *getOriginExpr() const { 541645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return cast<CXXMemberCallExpr>(CXXInstanceCall::getOriginExpr()); 542645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose } 543645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 544645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual unsigned getNumArgs() const { 545645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose if (const CallExpr *CE = getOriginExpr()) 546645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return CE->getNumArgs(); 547645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return 0; 548645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose } 549645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose 550645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 551645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return getOriginExpr()->getArg(Index); 552740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 553740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 5549da59a67a27a4d3fc9d59552f07808a32f85e9d3Jordan Rose virtual const Expr *getCXXThisExpr() const; 55500b4f64ecb26b031c1f4888f39be6c706156356aJordan Rose 55600b4f64ecb26b031c1f4888f39be6c706156356aJordan Rose virtual RuntimeDefinition getRuntimeDefinition() const; 5577c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 5587c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXMember; } 559e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 560740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 561740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_CXXMember; 562740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 563740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 564740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 565fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// \brief Represents a C++ overloaded operator call where the operator is 566fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// implemented as a non-static member function. 567fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// 568fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// Example: <tt>iter + 1</tt> 569c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Roseclass CXXMemberOperatorCall : public CXXInstanceCall { 570d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 571d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 572972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprotected: 573d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXMemberOperatorCall(const CXXOperatorCallExpr *CE, ProgramStateRef St, 574d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) 575d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose : CXXInstanceCall(CE, St, LCtx) {} 576d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 577972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CXXMemberOperatorCall(const CXXMemberOperatorCall &Other) 578972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : CXXInstanceCall(Other) {} 579972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { 580972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose new (Dest) CXXMemberOperatorCall(*this); 581972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 582972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 583fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rosepublic: 5847c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXOperatorCallExpr *getOriginExpr() const { 585645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return cast<CXXOperatorCallExpr>(CXXInstanceCall::getOriginExpr()); 586fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 587fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 5887c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { 5897c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return getOriginExpr()->getNumArgs() - 1; 5907c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 5917c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 592fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return getOriginExpr()->getArg(Index + 1); 593fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 594fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 5959da59a67a27a4d3fc9d59552f07808a32f85e9d3Jordan Rose virtual const Expr *getCXXThisExpr() const; 5967c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 5977c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXMemberOperator; } 598e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 599fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose static bool classof(const CallEvent *CA) { 600fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return CA->getKind() == CE_CXXMemberOperator; 601fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 602fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose}; 603fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 604645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// \brief Represents an implicit call to a C++ destructor. 605740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// 606645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// This can occur at the end of a scope (for automatic objects), at the end 607645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose/// of a full-expression (for temporaries), or as part of a delete. 608645baeed6800f952e9ad1d5666e01080385531a2Jordan Roseclass CXXDestructorCall : public CXXInstanceCall { 609d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 610d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 611740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 612200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose typedef llvm::PointerIntPair<const MemRegion *, 1, bool> DtorDataTy; 613200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose 614645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// Creates an implicit destructor. 61569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// 616645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \param DD The destructor that will be called. 617645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \param Trigger The statement whose completion causes this destructor call. 618645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \param Target The object region to be destructed. 619645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \param St The path-sensitive state at this point in the program. 620645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \param LCtx The location context at this point in the program. 621645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger, 622200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose const MemRegion *Target, bool IsBaseDestructor, 623200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose ProgramStateRef St, const LocationContext *LCtx) 624645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose : CXXInstanceCall(DD, St, LCtx) { 625200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose Data = DtorDataTy(Target, IsBaseDestructor).getOpaqueValue(); 626645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose Location = Trigger->getLocEnd(); 627740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 628740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 629645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CXXDestructorCall(const CXXDestructorCall &Other) : CXXInstanceCall(Other) {} 630645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXDestructorCall(*this); } 631ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 632645baeed6800f952e9ad1d5666e01080385531a2Jordan Rosepublic: 633645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual SourceRange getSourceRange() const { return Location; } 634645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual unsigned getNumArgs() const { return 0; } 635ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 636200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose virtual RuntimeDefinition getRuntimeDefinition() const; 637200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose 638645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose /// \brief Returns the value of the implicit 'this' object. 639645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual SVal getCXXThisVal() const; 640b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 641200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose /// Returns true if this is a call to a base class destructor. 642200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose bool isBaseDestructor() const { 643200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose return DtorDataTy::getFromOpaqueValue(Data).getInt(); 644200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose } 645200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose 646645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose virtual Kind getKind() const { return CE_CXXDestructor; } 647b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 648740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 649645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose return CA->getKind() == CE_CXXDestructor; 650740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 651740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 652740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 653740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a call to a C++ constructor. 654740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// 655740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// Example: \c T(1) 656740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass CXXConstructorCall : public AnyFunctionCall { 657d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 658b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 659d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 660d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// Creates a constructor call. 661d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// 662d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// \param CE The constructor expression as written in the source. 663d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// \param Target The region where the object should be constructed. If NULL, 664d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// a new symbolic region will be used. 665d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// \param St The path-sensitive state at this point in the program. 666d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose /// \param LCtx The location context at this point in the program. 66770517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko CXXConstructorCall(const CXXConstructExpr *CE, const MemRegion *Target, 668740d490593e0de8732a697c9f77b90ddd463863bJordan Rose ProgramStateRef St, const LocationContext *LCtx) 6697c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : AnyFunctionCall(CE, St, LCtx) { 67070517ca5c07c4b41ff8662b94ee22047b0299f8cDmitri Gribenko Data = Target; 671b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 672740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 673d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXConstructorCall(const CXXConstructorCall &Other) : AnyFunctionCall(Other){} 674d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXConstructorCall(*this); } 675d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 676d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 677d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 678d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 6797c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXConstructExpr *getOriginExpr() const { 680b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return cast<CXXConstructExpr>(AnyFunctionCall::getOriginExpr()); 681b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 682b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 6837c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXConstructorDecl *getDecl() const { 684b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getConstructor(); 685740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 686740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 6877c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { return getOriginExpr()->getNumArgs(); } 688740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 6897c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 690b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getArg(Index); 691740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 692740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 693ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose /// \brief Returns the value of the implicit 'this' object. 694645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose SVal getCXXThisVal() const; 6957c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 696ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 697ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 698ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 6997c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXConstructor; } 700e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 701740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 702740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_CXXConstructor; 703740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 704740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 705740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 7060e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose/// \brief Represents the memory allocation call in a C++ new-expression. 7070e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose/// 7080e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose/// This is a call to "operator new". 70970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Roseclass CXXAllocatorCall : public AnyFunctionCall { 710d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 711972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 712d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Roseprotected: 713b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose CXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef St, 71470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose const LocationContext *LCtx) 7157c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : AnyFunctionCall(E, St, LCtx) {} 71670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 717d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CXXAllocatorCall(const CXXAllocatorCall &Other) : AnyFunctionCall(Other) {} 718d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXAllocatorCall(*this); } 719d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 720d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rosepublic: 7217c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXNewExpr *getOriginExpr() const { 722b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return cast<CXXNewExpr>(AnyFunctionCall::getOriginExpr()); 723b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 724b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 7257c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const FunctionDecl *getDecl() const { 726b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getOperatorNew(); 72770cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose } 72870cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 7297c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { 730b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getNumPlacementArgs() + 1; 731b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 73270cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 7337c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 73470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // The first argument of an allocator call is the size of the allocation. 73570cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose if (Index == 0) 73670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return 0; 737b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getPlacementArg(Index - 1); 73870cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose } 73970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 7407c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXAllocator; } 741b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 74270cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose static bool classof(const CallEvent *CE) { 74370cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return CE->getKind() == CE_CXXAllocator; 74470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose } 74570cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose}; 74670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 7478919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose/// \brief Represents the ways an Objective-C message send can occur. 7488919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose// 7498919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose// Note to maintainers: OCM_Message should always be last, since it does not 7508919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose// need to fit in the Data field's low bits. 7518919e688dc610d1f632a4d43f7f1489f67255476Jordan Roseenum ObjCMessageKind { 7528919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose OCM_PropertyAccess, 7538919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose OCM_Subscript, 7548919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose OCM_Message 7558919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose}; 7568919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 757cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose/// \brief Represents any expression that calls an Objective-C method. 7588919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose/// 7598919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose/// This includes all of the kinds listed in ObjCMessageKind. 760cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Roseclass ObjCMethodCall : public CallEvent { 761d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose friend class CallEventManager; 762d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 7638919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose const PseudoObjectExpr *getContainingPseudoObjectExpr() const; 764cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose 7658919e688dc610d1f632a4d43f7f1489f67255476Jordan Roseprotected: 766d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ObjCMethodCall(const ObjCMessageExpr *Msg, ProgramStateRef St, 767d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) 768d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose : CallEvent(Msg, St, LCtx) { 769d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose Data = 0; 770d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 771d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 772972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose ObjCMethodCall(const ObjCMethodCall &Other) : CallEvent(Other) {} 773972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { new (Dest) ObjCMethodCall(*this); } 774972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 7757c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 776740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 7773f558af01643787d209a133215b0abec81b5fe30Anna Zaks /// Check if the selector may have multiple definitions (may have overrides). 7783f558af01643787d209a133215b0abec81b5fe30Anna Zaks virtual bool canBeOverridenInSubclass(ObjCInterfaceDecl *IDecl, 7793f558af01643787d209a133215b0abec81b5fe30Anna Zaks Selector Sel) const; 7803f558af01643787d209a133215b0abec81b5fe30Anna Zaks 781740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 7827c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const ObjCMessageExpr *getOriginExpr() const { 7838919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return cast<ObjCMessageExpr>(CallEvent::getOriginExpr()); 784cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose } 7857c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const ObjCMethodDecl *getDecl() const { 786b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getMethodDecl(); 787b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 7887c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { 789b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getNumArgs(); 790b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 7917c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 792b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getArg(Index); 793b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 794740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 7958919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose bool isInstanceMessage() const { 7968919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getOriginExpr()->isInstanceMessage(); 7978919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 7988919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ObjCMethodFamily getMethodFamily() const { 7998919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getOriginExpr()->getMethodFamily(); 8008919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 8018919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose Selector getSelector() const { 8028919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getOriginExpr()->getSelector(); 8038919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 8048919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 8057c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getSourceRange() const; 8068919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 8070e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// \brief Returns the value of the receiver at the time of this call. 808740d490593e0de8732a697c9f77b90ddd463863bJordan Rose SVal getReceiverSVal() const; 809740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 8105a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks /// \brief Return the value of 'self' if available. 8115a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks SVal getSelfSVal() const; 8125a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 8130e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// \brief Get the interface for the receiver. 8140e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// 8150e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// This works whether this is an instance message or a class message. 8160e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// However, it currently just uses the static type of the receiver. 817cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const ObjCInterfaceDecl *getReceiverInterface() const { 818b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getReceiverInterface(); 819cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose } 820cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose 8215a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks /// \brief Checks if the receiver refers to 'self' or 'super'. 8225a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks bool isReceiverSelfOrSuper() const; 8235a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 82409647f28d7955d0c948ebbbb376a46844056f11aJordan Rose /// Returns how the message was written in the source (property access, 82509647f28d7955d0c948ebbbb376a46844056f11aJordan Rose /// subscript, or explicit message send). 8268919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ObjCMessageKind getMessageKind() const; 8278919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 82809647f28d7955d0c948ebbbb376a46844056f11aJordan Rose /// Returns true if this property access or subscript is a setter (has the 82909647f28d7955d0c948ebbbb376a46844056f11aJordan Rose /// form of an assignment). 8308919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose bool isSetter() const { 8318919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose switch (getMessageKind()) { 8328919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Message: 8338919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose llvm_unreachable("This is not a pseudo-object access!"); 8348919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_PropertyAccess: 8358919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getNumArgs() > 0; 8368919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Subscript: 8378919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getNumArgs() > 1; 8388919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 8398919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose llvm_unreachable("Unknown message kind"); 840740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 841740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 842e90d3f847dcce76237078b67db8895eb7a24189eAnna Zaks virtual RuntimeDefinition getRuntimeDefinition() const; 843ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 844ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 845ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose BindingsTy &Bindings) const; 846ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose 847ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_begin() const; 848ef15831780b705475e7b237ac16418e9b53cb7a6Jordan Rose virtual param_iterator param_end() const; 849b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 8507c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_ObjCMessage; } 851b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 852740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 853740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_ObjCMessage; 854740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 855740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 856740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 857972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 858972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// \brief Manages the lifetime of CallEvent objects. 859972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// 860972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEventManager provides a way to create arbitrary CallEvents "on the 861972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// stack" as if they were value objects by keeping a cache of CallEvent-sized 862972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// memory blocks. The CallEvents created by CallEventManager are only valid 863972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// for the lifetime of the OwnedCallEvent that holds them; right now these 864972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// objects cannot be copied and ownership cannot be transferred. 865972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseclass CallEventManager { 866972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose friend class CallEvent; 867972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 868972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose llvm::BumpPtrAllocator &Alloc; 869d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose SmallVector<void *, 8> Cache; 870972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 871972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void reclaim(const void *Memory) { 872972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Cache.push_back(const_cast<void *>(Memory)); 873972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 874972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 875972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Returns memory that can be initialized as a CallEvent. 876972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void *allocate() { 877972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose if (Cache.empty()) 878972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return Alloc.Allocate<FunctionCall>(); 879972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose else 880972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return Cache.pop_back_val(); 881972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 882972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 883d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose template <typename T, typename Arg> 884d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose T *create(Arg A, ProgramStateRef St, const LocationContext *LCtx) { 885d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return new (allocate()) T(A, St, LCtx); 886d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 887d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 888d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose template <typename T, typename Arg1, typename Arg2> 889d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose T *create(Arg1 A1, Arg2 A2, ProgramStateRef St, const LocationContext *LCtx) { 890d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return new (allocate()) T(A1, A2, St, LCtx); 891d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 892d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 893d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose template <typename T, typename Arg1, typename Arg2, typename Arg3> 894d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose T *create(Arg1 A1, Arg2 A2, Arg3 A3, ProgramStateRef St, 895d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) { 896d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return new (allocate()) T(A1, A2, A3, St, LCtx); 897d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 898d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 899200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose template <typename T, typename Arg1, typename Arg2, typename Arg3, 900200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose typename Arg4> 901200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose T *create(Arg1 A1, Arg2 A2, Arg3 A3, Arg4 A4, ProgramStateRef St, 902200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose const LocationContext *LCtx) { 903200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose return new (allocate()) T(A1, A2, A3, A4, St, LCtx); 904200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose } 905200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose 906972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rosepublic: 907972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager(llvm::BumpPtrAllocator &alloc) : Alloc(alloc) {} 908d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 90957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 91057c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose CallEventRef<> 91157c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getCaller(const StackFrameContext *CalleeCtx, ProgramStateRef State); 91257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 91357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 914645baeed6800f952e9ad1d5666e01080385531a2Jordan Rose CallEventRef<> 915d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getSimpleCall(const CallExpr *E, ProgramStateRef State, 916d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx); 917d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 918d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<ObjCMethodCall> 919d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getObjCMethodCall(const ObjCMessageExpr *E, ProgramStateRef State, 920d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) { 921d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return create<ObjCMethodCall>(E, State, LCtx); 922d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 923d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 924d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<CXXConstructorCall> 925d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getCXXConstructorCall(const CXXConstructExpr *E, const MemRegion *Target, 926d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose ProgramStateRef State, const LocationContext *LCtx) { 927d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return create<CXXConstructorCall>(E, Target, State, LCtx); 928d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 929d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 930d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<CXXDestructorCall> 931d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getCXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger, 932200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose const MemRegion *Target, bool IsBase, 933200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose ProgramStateRef State, const LocationContext *LCtx) { 934200fa2e70d52ae6d620e81cd45536071fdde70c0Jordan Rose return create<CXXDestructorCall>(DD, Trigger, Target, IsBase, State, LCtx); 935d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 936d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 937d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<CXXAllocatorCall> 938d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose getCXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef State, 939d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose const LocationContext *LCtx) { 940d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return create<CXXAllocatorCall>(E, State, LCtx); 941d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose } 942972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose}; 943972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 944972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 945972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rosetemplate <typename T> 946d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan RoseCallEventRef<T> CallEvent::cloneWithState(ProgramStateRef NewState) const { 947972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(isa<T>(*this) && "Cloning to unrelated type"); 948972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(sizeof(T) == sizeof(CallEvent) && "Subclasses may not add fields"); 949972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 950d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose if (NewState == State) 951d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose return cast<T>(this); 952d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 953972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager &Mgr = State->getStateManager().getCallEventManager(); 954972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose T *Copy = static_cast<T *>(Mgr.allocate()); 955972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose cloneTo(Copy); 956972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(Copy->getKind() == this->getKind() && "Bad copy"); 957972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 958972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Copy->State = NewState; 959972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return Copy; 960972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose} 961972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 962972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseinline void CallEvent::Release() const { 963972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(RefCount > 0 && "Reference count is already zero."); 964972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose --RefCount; 965972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 966972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose if (RefCount > 0) 967972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return; 968972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 969972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager &Mgr = State->getStateManager().getCallEventManager(); 970972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Mgr.reclaim(this); 971972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 972972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose this->~CallEvent(); 973972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose} 974972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 975740d490593e0de8732a697c9f77b90ddd463863bJordan Rose} // end namespace ento 976740d490593e0de8732a697c9f77b90ddd463863bJordan Rose} // end namespace clang 977740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 97857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rosenamespace llvm { 97957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose // Support isa<>, cast<>, and dyn_cast<> for CallEventRef. 98057c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose template<class T> struct simplify_type< clang::ento::CallEventRef<T> > { 98157c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose typedef const T *SimpleType; 98257c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 98357c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose static SimpleType 98457c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose getSimplifiedValue(const clang::ento::CallEventRef<T>& Val) { 98557c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose return Val.getPtr(); 98657c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose } 98757c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose }; 98857c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose} 98957c033621dacd8720ac9ff65a09025f14f70e22fJordan Rose 990740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#endif 991