CallEvent.h revision 972a3680bdd95f2e9d6316b391f1c47513dc78cc
1f540c54701e3eeb34cb619a3a4eb18f1ac70ef2dJordan Rose//===- CallEvent.h - Wrapper for all function and method calls ----*- C++ -*--// 2740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// 3740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// The LLVM Compiler Infrastructure 4740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// 5740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// This file is distributed under the University of Illinois Open Source 6740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// License. See LICENSE.TXT for details. 7740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// 8740d490593e0de8732a697c9f77b90ddd463863bJordan Rose//===----------------------------------------------------------------------===// 9740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// 10740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \file This file defines CallEvent and its subclasses, which represent path- 11740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// sensitive instances of different kinds of function and method calls 12740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// (C, C++, and Objective-C). 13740d490593e0de8732a697c9f77b90ddd463863bJordan Rose// 14740d490593e0de8732a697c9f77b90ddd463863bJordan Rose//===----------------------------------------------------------------------===// 15740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 16740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#ifndef LLVM_CLANG_STATICANALYZER_PATHSENSITIVE_CALL 17740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#define LLVM_CLANG_STATICANALYZER_PATHSENSITIVE_CALL 18740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 19740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/Basic/SourceManager.h" 20740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/AST/DeclCXX.h" 21740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/AST/ExprCXX.h" 22740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/AST/ExprObjC.h" 23de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h" 24740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h" 25b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose#include "llvm/ADT/PointerIntPair.h" 26740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 27740d490593e0de8732a697c9f77b90ddd463863bJordan Rosenamespace clang { 2828038f33aa2db4833881fea757a1f0daf85ac02bJordan Roseclass ProgramPoint; 2928038f33aa2db4833881fea757a1f0daf85ac02bJordan Roseclass ProgramPointTag; 3028038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 31740d490593e0de8732a697c9f77b90ddd463863bJordan Rosenamespace ento { 32740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 33740d490593e0de8732a697c9f77b90ddd463863bJordan Roseenum CallEventKind { 34740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_Function, 35740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_CXXMember, 36fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose CE_CXXMemberOperator, 37c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CE_BEG_CXX_INSTANCE_CALLS = CE_CXXMember, 38c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CE_END_CXX_INSTANCE_CALLS = CE_CXXMemberOperator, 39740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_Block, 40740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_BEG_SIMPLE_CALLS = CE_Function, 41740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_END_SIMPLE_CALLS = CE_Block, 42740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_CXXConstructor, 438d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose CE_CXXDestructor, 4470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose CE_CXXAllocator, 45740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CE_BEG_FUNCTION_CALLS = CE_Function, 4670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose CE_END_FUNCTION_CALLS = CE_CXXAllocator, 478919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose CE_ObjCMessage 48740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 49740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 50972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseclass CallEvent; 51972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rosetypedef IntrusiveRefCntPtr<CallEvent> CallEventRef; 52972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 53b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 54740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents an abstract call to a function or method along a 55740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// particular path. 56972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// 57972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEvents are created through the factory methods of CallEventManager. 58972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// 59972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEvents should always be cheap to create and destroy. In order for 60972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEventManager to be able to re-use CallEvent-sized memory blocks, 61972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// subclasses of CallEvent may not add any data members to the base class. 62972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// Use the "Data" and "Location" fields instead. 63740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass CallEvent { 64740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 65740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef CallEventKind Kind; 66740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 67b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Roseprivate: 687c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose ProgramStateRef State; 697c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx; 70b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose llvm::PointerUnion<const Expr *, const Decl *> Origin; 71b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 72972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // DO NOT IMPLEMENT 737c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose CallEvent &operator=(const CallEvent &); 747c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 75740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 76b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose // This is user data for subclasses. 77b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose const void *Data; 78972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 79972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // This is user data for subclasses. 80972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // This should come right before RefCount, so that the two fields can be 81972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // packed together on LP64 platforms. 82b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose SourceLocation Location; 83b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 84972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprivate: 85972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose mutable unsigned RefCount; 86972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 87972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose template <typename T> friend struct llvm::IntrusiveRefCntPtrInfo; 88972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void Retain() const { ++RefCount; } 89972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void Release() const; 90972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 91972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprotected: 927c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose CallEvent(const Expr *E, ProgramStateRef state, const LocationContext *lctx) 93972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : State(state), LCtx(lctx), Origin(E), RefCount(0) {} 94b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 957c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose CallEvent(const Decl *D, ProgramStateRef state, const LocationContext *lctx) 96972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : State(state), LCtx(lctx), Origin(D), RefCount(0) {} 97972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 98972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose // DO NOT MAKE PUBLIC 99972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEvent(const CallEvent &Original) 100972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : State(Original.State), LCtx(Original.LCtx), Origin(Original.Origin), 101972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Data(Original.Data), Location(Original.Location), RefCount(0) {} 102b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 1037c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose ProgramStateRef getState() const { 1047c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return State; 105b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 106b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 107b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose const LocationContext *getLocationContext() const { 1087c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return LCtx; 109b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 110740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 111740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 112972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Copies this CallEvent, with vtable intact, into a new block of memory. 113972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const = 0; 114972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 115740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Get the value of arbitrary expressions at this point in the path. 116740d490593e0de8732a697c9f77b90ddd463863bJordan Rose SVal getSVal(const Stmt *S) const { 117b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getState()->getSVal(S, getLocationContext()); 118740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 119740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 120972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 121740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef SmallVectorImpl<const MemRegion *> RegionList; 122740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 123740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Used to specify non-argument regions that will be invalidated as a 124740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// result of this call. 1257c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const {} 126740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 1277c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual QualType getDeclaredResultType() const = 0; 128740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 129740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 1307c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual ~CallEvent() {} 1317c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 132b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \brief Returns the kind of call this is. 1337c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const = 0; 134b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 135740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the declaration of the function or method that will be 136740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// called. May be null. 1377c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getDecl() const { 1387c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return Origin.dyn_cast<const Decl *>(); 1397c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 140740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 141ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose /// \brief Returns the definition of the function or method that will be 1429dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks /// called. Returns NULL if the definition cannot be found; ex: due to 1439dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks /// dynamic dispatch in ObjC methods. 1447c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getRuntimeDefinition() const = 0; 145ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 146740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the expression whose value will be the result of this call. 147740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// May be null. 148b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose const Expr *getOriginExpr() const { 149b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return Origin.dyn_cast<const Expr *>(); 150b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 151740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 152740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the number of arguments (explicit and implicit). 153740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// 154740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// Note that this may be greater than the number of parameters in the 155740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// callee's declaration, and that it may include arguments not written in 156740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// the source. 1577c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const = 0; 158740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 159740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns true if the callee is known to be from a system header. 160740d490593e0de8732a697c9f77b90ddd463863bJordan Rose bool isInSystemHeader() const { 161740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const Decl *D = getDecl(); 162740d490593e0de8732a697c9f77b90ddd463863bJordan Rose if (!D) 163740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return false; 164740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 165740d490593e0de8732a697c9f77b90ddd463863bJordan Rose SourceLocation Loc = D->getLocation(); 166740d490593e0de8732a697c9f77b90ddd463863bJordan Rose if (Loc.isValid()) { 167740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const SourceManager &SM = 168b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose getState()->getStateManager().getContext().getSourceManager(); 169740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return SM.isInSystemHeader(D->getLocation()); 170740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 171740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 172740d490593e0de8732a697c9f77b90ddd463863bJordan Rose // Special case for implicitly-declared global operator new/delete. 173740d490593e0de8732a697c9f77b90ddd463863bJordan Rose // These should be considered system functions. 174740d490593e0de8732a697c9f77b90ddd463863bJordan Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) 175740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return FD->isOverloadedOperator() && FD->isImplicit() && FD->isGlobal(); 176740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 177740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return false; 178740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 179740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 180de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose /// \brief Returns a source range for the entire call, suitable for 181de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose /// outputting in diagnostics. 1827c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getSourceRange() const { 1837c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return getOriginExpr()->getSourceRange(); 1847c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 185de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose 186740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the value of a given argument at the time of the call. 1877c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getArgSVal(unsigned Index) const; 188740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 189740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the expression associated with a given argument. 190740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// May be null if this expression does not appear in the source. 1917c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { return 0; } 192740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 193740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the source range for errors associated with this argument. 1947c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose /// 195740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// May be invalid if the argument is not written in the source. 1967c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getArgSourceRange(unsigned Index) const; 197740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 198740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns the result type, adjusted for references. 199740d490593e0de8732a697c9f77b90ddd463863bJordan Rose QualType getResultType() const; 200740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 201e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \brief Returns the value of the implicit 'this' object, or UndefinedVal if 202e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// this is not a C++ member function call. 2037c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getCXXThisVal() const { 2047c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return UndefinedVal(); 2057c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 206e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 207740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns true if any of the arguments appear to represent callbacks. 208740d490593e0de8732a697c9f77b90ddd463863bJordan Rose bool hasNonZeroCallbackArg() const; 209740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 21085d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose /// \brief Returns true if any of the arguments are known to escape to long- 21185d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose /// term storage, even if this method will not modify them. 21285d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose // NOTE: The exact semantics of this are still being defined! 21385d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose // We don't really want a list of hardcoded exceptions in the long run, 21485d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose // but we don't want duplicated lists of known APIs in the short term either. 2157c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual bool argumentsMayEscape() const { 2167c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return hasNonZeroCallbackArg(); 2177c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 21885d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose 21928038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose /// \brief Returns an appropriate ProgramPoint for this call. 2208d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose ProgramPoint getProgramPoint(bool IsPreVisit = false, 22128038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose const ProgramPointTag *Tag = 0) const; 22228038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose 223740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// \brief Returns a new state with all argument regions invalidated. 224740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// 225740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// This accepts an alternate state in case some processing has already 226740d490593e0de8732a697c9f77b90ddd463863bJordan Rose /// occurred. 227740d490593e0de8732a697c9f77b90ddd463863bJordan Rose ProgramStateRef invalidateRegions(unsigned BlockCount, 228740d490593e0de8732a697c9f77b90ddd463863bJordan Rose ProgramStateRef Orig = 0) const; 229740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 230972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Returns a copy of this CallEvent, but using the given state. 231972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose template <typename T> 232972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose IntrusiveRefCntPtr<T> cloneWithState(ProgramStateRef NewState) const; 233972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 234972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Returns a copy of this CallEvent, but using the given state. 235972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventRef cloneWithState(ProgramStateRef NewState) const { 236972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return cloneWithState<CallEvent>(NewState); 237972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 238972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 23985d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose /// \brief Returns true if this is a statement that can be considered for 24085d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose /// inlining. 2417c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose /// 2427c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose /// FIXME: This should go away once CallEvents are cheap and easy to 2437c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose /// construct from ExplodedNodes. 24485d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose static bool mayBeInlined(const Stmt *S); 24585d7e01cf639b257d70f8a129709a2d7594d7b22Jordan Rose 246e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose // Iterator access to formal parameters and their types. 247740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprivate: 248740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef std::const_mem_fun_t<QualType, ParmVarDecl> get_type_fun; 249740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 250740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 251e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose typedef const ParmVarDecl * const *param_iterator; 252e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 253e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// Returns an iterator over the call's formal parameters. 254e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 255e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// If UseDefinitionParams is set, this will return the parameter decls 256e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// used in the callee's definition (suitable for inlining). Most of the 257e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// time it is better to use the decl found by name lookup, which likely 258e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// carries more annotations. 259e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 260e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// Remember that the number of formal parameters may not match the number 261e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// of arguments for all calls. However, the first parameter will always 262e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// correspond with the argument value returned by \c getArgSVal(0). 263e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 264e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// If the call has no accessible declaration (or definition, if 265e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \p UseDefinitionParams is set), \c param_begin() will be equal to 266e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \c param_end(). 2677c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual param_iterator param_begin(bool UseDefinitionParams = false) const =0; 268e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \sa param_begin() 2697c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual param_iterator param_end(bool UseDefinitionParams = false) const = 0; 270e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 271740d490593e0de8732a697c9f77b90ddd463863bJordan Rose typedef llvm::mapped_iterator<param_iterator, get_type_fun> 272740d490593e0de8732a697c9f77b90ddd463863bJordan Rose param_type_iterator; 273740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 274e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// Returns an iterator over the types of the call's formal parameters. 275e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// 276e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// This uses the callee decl found by default name lookup rather than the 277e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// definition because it represents a public interface, and probably has 278e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// more annotations. 279740d490593e0de8732a697c9f77b90ddd463863bJordan Rose param_type_iterator param_type_begin() const { 280740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return llvm::map_iterator(param_begin(), 281740d490593e0de8732a697c9f77b90ddd463863bJordan Rose get_type_fun(&ParmVarDecl::getType)); 282740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 283e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose /// \sa param_type_begin() 284740d490593e0de8732a697c9f77b90ddd463863bJordan Rose param_type_iterator param_type_end() const { 285740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return llvm::map_iterator(param_end(), get_type_fun(&ParmVarDecl::getType)); 286740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 287740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 2880ffbfd1a7f80f9a3c07317cb8f44c562f2ba1ba5Jordan Rose // For debugging purposes only 289b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose void dump(raw_ostream &Out) const; 2900ffbfd1a7f80f9a3c07317cb8f44c562f2ba1ba5Jordan Rose LLVM_ATTRIBUTE_USED void dump() const { dump(llvm::errs()); } 2910ffbfd1a7f80f9a3c07317cb8f44c562f2ba1ba5Jordan Rose 292740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *) { return true; } 293740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 294740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 295b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 296740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a call to any sort of function that might have a 297740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// FunctionDecl. 298740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass AnyFunctionCall : public CallEvent { 299740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 300b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose AnyFunctionCall(const Expr *E, ProgramStateRef St, 3017c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 3027c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CallEvent(E, St, LCtx) {} 303b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose AnyFunctionCall(const Decl *D, ProgramStateRef St, 3047c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 3057c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CallEvent(D, St, LCtx) {} 306972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose AnyFunctionCall(const AnyFunctionCall &Other) : CallEvent(Other) {} 307740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 3087c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual QualType getDeclaredResultType() const; 309740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 310740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 311b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose // This function is overridden by subclasses, but they must return 312b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose // a FunctionDecl. 3137c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const FunctionDecl *getDecl() const { 3147c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return cast<FunctionDecl>(CallEvent::getDecl()); 315b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 316740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 3177c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getRuntimeDefinition() const { 318ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose const FunctionDecl *FD = getDecl(); 319ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose // Note that hasBody() will fill FD with the definition FunctionDecl. 320ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose if (FD && FD->hasBody(FD)) 321ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose return FD; 322ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose return 0; 323ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose } 324ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 3257c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual bool argumentsMayEscape() const; 326b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 3277c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual param_iterator param_begin(bool UseDefinitionParams = false) const; 3287c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual param_iterator param_end(bool UseDefinitionParams = false) const; 329b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 330740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 331740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() >= CE_BEG_FUNCTION_CALLS && 332740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CA->getKind() <= CE_END_FUNCTION_CALLS; 333740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 334740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 335740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 336740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a call to a written as a CallExpr. 337740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass SimpleCall : public AnyFunctionCall { 338740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 339b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose SimpleCall(const CallExpr *CE, ProgramStateRef St, 3407c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 341972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : AnyFunctionCall(CE, St, LCtx) {} 342972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose SimpleCall(const SimpleCall &Other) : AnyFunctionCall(Other) {} 343740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 344740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 3457c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CallExpr *getOriginExpr() const { 346b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return cast<CallExpr>(AnyFunctionCall::getOriginExpr()); 347b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 348740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 3497c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const FunctionDecl *getDecl() const; 350740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 3517c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { return getOriginExpr()->getNumArgs(); } 3527c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 3537c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 354b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getArg(Index); 355740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 356740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 357740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 358740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() >= CE_BEG_SIMPLE_CALLS && 359740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CA->getKind() <= CE_END_SIMPLE_CALLS; 360740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 361740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 362740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 363740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a C function or static C++ member function call. 364740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// 365740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// Example: \c fun() 366740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass FunctionCall : public SimpleCall { 367972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprotected: 368972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose FunctionCall(const FunctionCall &Other) : SimpleCall(Other) {} 369972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { new (Dest) FunctionCall(*this); } 370972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 371740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 372740d490593e0de8732a697c9f77b90ddd463863bJordan Rose FunctionCall(const CallExpr *CE, ProgramStateRef St, 373740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const LocationContext *LCtx) 3747c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : SimpleCall(CE, St, LCtx) {} 375740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 3767c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_Function; } 377b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 378740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 379740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_Function; 380740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 381740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 382740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 383c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// \brief Represents a non-static C++ member function call, no matter how 384c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// it is written. 385c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Roseclass CXXInstanceCall : public SimpleCall { 386740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 3877c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 388740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 389c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CXXInstanceCall(const CallExpr *CE, ProgramStateRef St, 3907c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose const LocationContext *LCtx) 3917c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : SimpleCall(CE, St, LCtx) {} 392c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose 393972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CXXInstanceCall(const CXXInstanceCall &Other) : SimpleCall(Other) {} 394972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 395c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rosepublic: 3967c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getRuntimeDefinition() const; 397c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose 398c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose static bool classof(const CallEvent *CA) { 399c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose return CA->getKind() >= CE_BEG_CXX_INSTANCE_CALLS && 400c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose CA->getKind() <= CE_END_CXX_INSTANCE_CALLS; 401c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose } 402c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose}; 403c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose 404c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// \brief Represents a non-static C++ member function call. 405c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// 406c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose/// Example: \c obj.fun() 407c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Roseclass CXXMemberCall : public CXXInstanceCall { 408972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprotected: 409972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CXXMemberCall(const CXXMemberCall &Other) : CXXInstanceCall(Other) {} 410972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXMemberCall(*this); } 411972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 412740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 413740d490593e0de8732a697c9f77b90ddd463863bJordan Rose CXXMemberCall(const CXXMemberCallExpr *CE, ProgramStateRef St, 414c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Rose const LocationContext *LCtx) 4157c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CXXInstanceCall(CE, St, LCtx) {} 416740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 4177c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXMemberCallExpr *getOriginExpr() const { 418740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return cast<CXXMemberCallExpr>(SimpleCall::getOriginExpr()); 419740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 420740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 4217c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getCXXThisVal() const; 4227c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 4237c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXMember; } 424e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 425740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 426740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_CXXMember; 427740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 428740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 429740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 430fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// \brief Represents a C++ overloaded operator call where the operator is 431fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// implemented as a non-static member function. 432fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// 433fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// Example: <tt>iter + 1</tt> 434c36b30c92c78b95fd29fb5d9d6214d737b3bcb02Jordan Roseclass CXXMemberOperatorCall : public CXXInstanceCall { 435972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprotected: 436972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CXXMemberOperatorCall(const CXXMemberOperatorCall &Other) 437972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose : CXXInstanceCall(Other) {} 438972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { 439972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose new (Dest) CXXMemberOperatorCall(*this); 440972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 441972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 442fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rosepublic: 443fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose CXXMemberOperatorCall(const CXXOperatorCallExpr *CE, ProgramStateRef St, 444fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose const LocationContext *LCtx) 4457c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CXXInstanceCall(CE, St, LCtx) {} 446fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 4477c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXOperatorCallExpr *getOriginExpr() const { 448fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return cast<CXXOperatorCallExpr>(SimpleCall::getOriginExpr()); 449fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 450fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 4517c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { 4527c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose return getOriginExpr()->getNumArgs() - 1; 4537c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose } 4547c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 455fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return getOriginExpr()->getArg(Index + 1); 456fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 457fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 4587c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getCXXThisVal() const; 4597c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 4607c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXMemberOperator; } 461e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 462fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose static bool classof(const CallEvent *CA) { 463fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose return CA->getKind() == CE_CXXMemberOperator; 464fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose } 465fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose}; 466fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose 467740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a call to a block. 468740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// 469fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose/// Example: <tt>^{ /* ... */ }()</tt> 470740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass BlockCall : public SimpleCall { 471740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 472972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose BlockCall(const BlockCall &Other) : SimpleCall(Other) {} 473972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { new (Dest) BlockCall(*this); } 474972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 4757c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 476740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 4777c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual QualType getDeclaredResultType() const; 478740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 479740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 480740d490593e0de8732a697c9f77b90ddd463863bJordan Rose BlockCall(const CallExpr *CE, ProgramStateRef St, 481740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const LocationContext *LCtx) 4827c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : SimpleCall(CE, St, LCtx) {} 48369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 48469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// \brief Returns the region associated with this instance of the block. 48569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// 48669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// This may be NULL if the block's origin is unknown. 48769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDataRegion *getBlockRegion() const; 48869f87c956b3ac2b80124fd9604af012e1061473aJordan Rose 48969f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// \brief Gets the declaration of the block. 49069f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// 49169f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// This is not an override of getDecl() because AnyFunctionCall has already 49269f87c956b3ac2b80124fd9604af012e1061473aJordan Rose /// assumed that it's a FunctionDecl. 49369f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDecl *getBlockDecl() const { 49469f87c956b3ac2b80124fd9604af012e1061473aJordan Rose const BlockDataRegion *BR = getBlockRegion(); 49569f87c956b3ac2b80124fd9604af012e1061473aJordan Rose if (!BR) 49669f87c956b3ac2b80124fd9604af012e1061473aJordan Rose return 0; 49769f87c956b3ac2b80124fd9604af012e1061473aJordan Rose return BR->getDecl(); 498740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 499740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 5007c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getRuntimeDefinition() const { 501ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose return getBlockDecl(); 502ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose } 503ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 5047c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual param_iterator param_begin(bool UseDefinitionParams = false) const; 5057c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual param_iterator param_end(bool UseDefinitionParams = false) const; 506b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 5077c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_Block; } 508b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 509740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 510740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_Block; 511740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 512740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 513740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 514740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// \brief Represents a call to a C++ constructor. 515740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// 516740d490593e0de8732a697c9f77b90ddd463863bJordan Rose/// Example: \c T(1) 517740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass CXXConstructorCall : public AnyFunctionCall { 518740d490593e0de8732a697c9f77b90ddd463863bJordan Roseprotected: 519972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CXXConstructorCall(const CXXConstructorCall &Other) : AnyFunctionCall(Other){} 520972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXConstructorCall(*this); } 521972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 5227c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 523740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 524740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 525b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// Represents a constructor call to a new or unknown region. 526b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose CXXConstructorCall(const CXXConstructExpr *CE, ProgramStateRef St, 527740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const LocationContext *LCtx) 5287c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : AnyFunctionCall(CE, St, LCtx) { 529b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose Data = 0; 530b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 531b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 532b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// Represents a constructor call on an existing object region. 533b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose CXXConstructorCall(const CXXConstructExpr *CE, const MemRegion *target, 534740d490593e0de8732a697c9f77b90ddd463863bJordan Rose ProgramStateRef St, const LocationContext *LCtx) 5357c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : AnyFunctionCall(CE, St, LCtx) { 536b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose Data = target; 537b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 538740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 5397c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXConstructExpr *getOriginExpr() const { 540b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return cast<CXXConstructExpr>(AnyFunctionCall::getOriginExpr()); 541b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 542b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 5437c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXConstructorDecl *getDecl() const { 544b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getConstructor(); 545740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 546740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 5477c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { return getOriginExpr()->getNumArgs(); } 548740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 5497c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 550b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getArg(Index); 551740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 552740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 5537c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getCXXThisVal() const; 5547c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 5557c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXConstructor; } 556e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 557740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 558740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_CXXConstructor; 559740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 560740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 561740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 5628d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose/// \brief Represents an implicit call to a C++ destructor. 5638d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose/// 5648d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose/// This can occur at the end of a scope (for automatic objects), at the end 5658d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose/// of a full-expression (for temporaries), or as part of a delete. 5668d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Roseclass CXXDestructorCall : public AnyFunctionCall { 5678d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Roseprotected: 568972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CXXDestructorCall(const CXXDestructorCall &Other) : AnyFunctionCall(Other) {} 569972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXDestructorCall(*this); } 570972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 5717c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 5728d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose 5738d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rosepublic: 574b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// Creates an implicit destructor. 575b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// 576b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \param DD The destructor that will be called. 577b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \param Trigger The statement whose completion causes this destructor call. 578b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \param Target The object region to be destructed. 579b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \param St The path-sensitive state at this point in the program. 580b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose /// \param LCtx The location context at this point in the program. 581b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose CXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger, 582b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose const MemRegion *Target, ProgramStateRef St, 5838d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose const LocationContext *LCtx) 5847c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : AnyFunctionCall(DD, St, LCtx) { 585b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose Data = Target; 586b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose Location = Trigger->getLocEnd(); 587b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 5888d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose 5897c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getSourceRange() const { return Location; } 5907c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { return 0; } 5917c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose 5927c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SVal getCXXThisVal() const; 5937c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getRuntimeDefinition() const; 5948d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose 5957c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXDestructor; } 596e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose 5978d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose static bool classof(const CallEvent *CA) { 5988d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose return CA->getKind() == CE_CXXDestructor; 5998d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose } 6008d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose}; 6018d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose 6020e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose/// \brief Represents the memory allocation call in a C++ new-expression. 6030e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose/// 6040e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose/// This is a call to "operator new". 60570cbf3cc09eb21db1108396d30a414ea66d842ccJordan Roseclass CXXAllocatorCall : public AnyFunctionCall { 606972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseprotected: 607972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CXXAllocatorCall(const CXXAllocatorCall &Other) : AnyFunctionCall(Other) {} 608972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { new (Dest) CXXAllocatorCall(*this); } 609972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 61070cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rosepublic: 611b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose CXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef St, 61270cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose const LocationContext *LCtx) 6137c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : AnyFunctionCall(E, St, LCtx) {} 61470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 6157c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const CXXNewExpr *getOriginExpr() const { 616b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return cast<CXXNewExpr>(AnyFunctionCall::getOriginExpr()); 617b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 618b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 6197c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const FunctionDecl *getDecl() const { 620b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getOperatorNew(); 62170cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose } 62270cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 6237c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { 624b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getNumPlacementArgs() + 1; 625b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 62670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 6277c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 62870cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose // The first argument of an allocator call is the size of the allocation. 62970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose if (Index == 0) 63070cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return 0; 631b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getPlacementArg(Index - 1); 63270cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose } 63370cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 6347c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_CXXAllocator; } 635b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 63670cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose static bool classof(const CallEvent *CE) { 63770cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose return CE->getKind() == CE_CXXAllocator; 63870cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose } 63970cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose}; 64070cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose 6418919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose/// \brief Represents the ways an Objective-C message send can occur. 6428919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose// 6438919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose// Note to maintainers: OCM_Message should always be last, since it does not 6448919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose// need to fit in the Data field's low bits. 6458919e688dc610d1f632a4d43f7f1489f67255476Jordan Roseenum ObjCMessageKind { 6468919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose OCM_PropertyAccess, 6478919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose OCM_Subscript, 6488919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose OCM_Message 6498919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose}; 6508919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 651cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose/// \brief Represents any expression that calls an Objective-C method. 6528919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose/// 6538919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose/// This includes all of the kinds listed in ObjCMessageKind. 654cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Roseclass ObjCMethodCall : public CallEvent { 6558919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose const PseudoObjectExpr *getContainingPseudoObjectExpr() const; 656cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose 6578919e688dc610d1f632a4d43f7f1489f67255476Jordan Roseprotected: 658972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose ObjCMethodCall(const ObjCMethodCall &Other) : CallEvent(Other) {} 659972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose virtual void cloneTo(void *Dest) const { new (Dest) ObjCMethodCall(*this); } 660972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 6617c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 662740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 6637c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual QualType getDeclaredResultType() const; 6649dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks ObjCMethodDecl *LookupClassMethodDefinition(Selector Sel, 6659dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks ObjCInterfaceDecl *ClassDecl) const; 666740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 667740d490593e0de8732a697c9f77b90ddd463863bJordan Rosepublic: 6688919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ObjCMethodCall(const ObjCMessageExpr *Msg, ProgramStateRef St, 6698919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose const LocationContext *LCtx) 6707c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose : CallEvent(Msg, St, LCtx) { 6718919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose Data = 0; 672b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 673de507eaf3cb54d3cb234dc14499c10ab3373d15fJordan Rose 6747c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const ObjCMessageExpr *getOriginExpr() const { 6758919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return cast<ObjCMessageExpr>(CallEvent::getOriginExpr()); 676cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose } 6777c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const ObjCMethodDecl *getDecl() const { 678b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getMethodDecl(); 679b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 6807c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual unsigned getNumArgs() const { 681b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getNumArgs(); 682b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 6837c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Expr *getArgExpr(unsigned Index) const { 684b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getArg(Index); 685b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose } 686740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 6878919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose bool isInstanceMessage() const { 6888919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getOriginExpr()->isInstanceMessage(); 6898919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 6908919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ObjCMethodFamily getMethodFamily() const { 6918919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getOriginExpr()->getMethodFamily(); 6928919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 6938919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose Selector getSelector() const { 6948919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getOriginExpr()->getSelector(); 6958919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 6968919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 6977c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual SourceRange getSourceRange() const; 6988919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 6990e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// \brief Returns the value of the receiver at the time of this call. 700740d490593e0de8732a697c9f77b90ddd463863bJordan Rose SVal getReceiverSVal() const; 701740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 7020e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// \brief Get the interface for the receiver. 7030e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// 7040e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// This works whether this is an instance message or a class message. 7050e020adcb69e91826f4ee14a0c1d381f7b624a34Jordan Rose /// However, it currently just uses the static type of the receiver. 706cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const ObjCInterfaceDecl *getReceiverInterface() const { 707b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose return getOriginExpr()->getReceiverInterface(); 708cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose } 709cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose 7108919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ObjCMessageKind getMessageKind() const; 7118919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose 7128919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose bool isSetter() const { 7138919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose switch (getMessageKind()) { 7148919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Message: 7158919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose llvm_unreachable("This is not a pseudo-object access!"); 7168919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_PropertyAccess: 7178919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getNumArgs() > 0; 7188919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Subscript: 7198919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose return getNumArgs() > 1; 7208919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 7218919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose llvm_unreachable("Unknown message kind"); 722740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 723740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 7249dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks // TODO: We might want to only compute this once (or change the API for 7259dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks // getting the parameters). Currently, this gets called 3 times during 7269dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks // inlining. 7277c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual const Decl *getRuntimeDefinition() const { 7289dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks const ObjCMessageExpr *E = getOriginExpr(); 7296fbe0317aa38dbac22a29f7519c52db838aa1990Anna Zaks assert(E); 7306fbe0317aa38dbac22a29f7519c52db838aa1990Anna Zaks 7319dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks if (E->isInstanceMessage()) { 7329dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks return 0; 7339dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks } else { 7346fbe0317aa38dbac22a29f7519c52db838aa1990Anna Zaks // This is a class method. 7359dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks // If we have type info for the receiver class, we are calling via 7369dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks // class name. 7376fbe0317aa38dbac22a29f7519c52db838aa1990Anna Zaks if (ObjCInterfaceDecl *IDecl = E->getReceiverInterface()) 7389dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks return LookupClassMethodDefinition(E->getSelector(), IDecl); 739ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose } 7409dc5167e4017ef4c8b327abb6f72225eec2e0f19Anna Zaks 741ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose return 0; 742ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose } 743ee158bc29bc12ce544996f7cdfde14aba63acf4dJordan Rose 7447c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual param_iterator param_begin(bool UseDefinitionParams = false) const; 7457c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual param_iterator param_end(bool UseDefinitionParams = false) const; 746b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 7477c99aa385178c630e29f671299cdd9c104f1c885Jordan Rose virtual Kind getKind() const { return CE_ObjCMessage; } 748b7a23e05d1d8f07f2a6edce5c88c728fe894c2c7Jordan Rose 749740d490593e0de8732a697c9f77b90ddd463863bJordan Rose static bool classof(const CallEvent *CA) { 750740d490593e0de8732a697c9f77b90ddd463863bJordan Rose return CA->getKind() == CE_ObjCMessage; 751740d490593e0de8732a697c9f77b90ddd463863bJordan Rose } 752740d490593e0de8732a697c9f77b90ddd463863bJordan Rose}; 753740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 754972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 755972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// \brief Manages the lifetime of CallEvent objects. 756972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// 757972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// CallEventManager provides a way to create arbitrary CallEvents "on the 758972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// stack" as if they were value objects by keeping a cache of CallEvent-sized 759972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// memory blocks. The CallEvents created by CallEventManager are only valid 760972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// for the lifetime of the OwnedCallEvent that holds them; right now these 761972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose/// objects cannot be copied and ownership cannot be transferred. 762972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseclass CallEventManager { 763972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose friend class CallEvent; 764972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 765972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose llvm::BumpPtrAllocator &Alloc; 766972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose SmallVector<void *, 4> Cache; 767972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 768972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void reclaim(const void *Memory) { 769972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Cache.push_back(const_cast<void *>(Memory)); 770972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 771972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 772972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Returns memory that can be initialized as a CallEvent. 773972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose void *allocate() { 774972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose if (Cache.empty()) 775972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return Alloc.Allocate<FunctionCall>(); 776972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose else 777972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return Cache.pop_back_val(); 778972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose } 779972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 780972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rosepublic: 781972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager(llvm::BumpPtrAllocator &alloc) : Alloc(alloc) {} 782972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose}; 783972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 784972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 785972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rosetemplate <typename T> 786972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan RoseIntrusiveRefCntPtr<T> CallEvent::cloneWithState(ProgramStateRef NewState) const{ 787972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(isa<T>(*this) && "Cloning to unrelated type"); 788972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(sizeof(T) == sizeof(CallEvent) && "Subclasses may not add fields"); 789972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 790972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager &Mgr = State->getStateManager().getCallEventManager(); 791972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose T *Copy = static_cast<T *>(Mgr.allocate()); 792972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose cloneTo(Copy); 793972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(Copy->getKind() == this->getKind() && "Bad copy"); 794972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 795972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Copy->State = NewState; 796972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return Copy; 797972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose} 798972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 799972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseinline void CallEvent::Release() const { 800972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose assert(RefCount > 0 && "Reference count is already zero."); 801972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose --RefCount; 802972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 803972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose if (RefCount > 0) 804972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose return; 805972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 806972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager &Mgr = State->getStateManager().getCallEventManager(); 807972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose Mgr.reclaim(this); 808972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 809972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose this->~CallEvent(); 810972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose} 811972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 812740d490593e0de8732a697c9f77b90ddd463863bJordan Rose} // end namespace ento 813740d490593e0de8732a697c9f77b90ddd463863bJordan Rose} // end namespace clang 814740d490593e0de8732a697c9f77b90ddd463863bJordan Rose 815740d490593e0de8732a697c9f77b90ddd463863bJordan Rose#endif 816