1 //===- CallEvent.h - Wrapper for all function and method calls ----*- C++ -*--//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 /// \file This file defines CallEvent and its subclasses, which represent path-
11 /// sensitive instances of different kinds of function and method calls
12 /// (C, C++, and Objective-C).
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CLANG_STATICANALYZER_PATHSENSITIVE_CALL
17 #define LLVM_CLANG_STATICANALYZER_PATHSENSITIVE_CALL
19 #include "clang/AST/DeclCXX.h"
20 #include "clang/AST/ExprCXX.h"
21 #include "clang/AST/ExprObjC.h"
22 #include "clang/Analysis/AnalysisContext.h"
23 #include "clang/Basic/SourceManager.h"
24 #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h"
25 #include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h"
26 #include "llvm/ADT/PointerIntPair.h"
30 class ProgramPointTag;
37 CE_BEG_SIMPLE_CALLS = CE_Function,
38 CE_END_SIMPLE_CALLS = CE_Block,
42 CE_BEG_CXX_INSTANCE_CALLS = CE_CXXMember,
43 CE_END_CXX_INSTANCE_CALLS = CE_CXXDestructor,
46 CE_BEG_FUNCTION_CALLS = CE_Function,
47 CE_END_FUNCTION_CALLS = CE_CXXAllocator,
52 class CallEventManager;
54 template<typename T = CallEvent>
55 class CallEventRef : public IntrusiveRefCntPtr<const T> {
57 CallEventRef(const T *Call) : IntrusiveRefCntPtr<const T>(Call) {}
58 CallEventRef(const CallEventRef &Orig) : IntrusiveRefCntPtr<const T>(Orig) {}
60 CallEventRef<T> cloneWithState(ProgramStateRef State) const {
61 return this->getPtr()->template cloneWithState<T>(State);
64 // Allow implicit conversions to a superclass type, since CallEventRef
65 // behaves like a pointer-to-const.
66 template <typename SuperT>
67 operator CallEventRef<SuperT> () const {
68 return this->getPtr();
72 /// \class RuntimeDefinition
73 /// \brief Defines the runtime definition of the called function.
75 /// Encapsulates the information we have about which Decl will be used
76 /// when the call is executed on the given path. When dealing with dynamic
77 /// dispatch, the information is based on DynamicTypeInfo and might not be
79 class RuntimeDefinition {
80 /// The Declaration of the function which could be called at runtime.
81 /// NULL if not available.
84 /// The region representing an object (ObjC/C++) on which the method is
85 /// called. With dynamic dispatch, the method definition depends on the
86 /// runtime type of this object. NULL when the DynamicTypeInfo is
91 RuntimeDefinition(): D(0), R(0) {}
92 RuntimeDefinition(const Decl *InD): D(InD), R(0) {}
93 RuntimeDefinition(const Decl *InD, const MemRegion *InR): D(InD), R(InR) {}
94 const Decl *getDecl() { return D; }
96 /// \brief Check if the definition we have is precise.
97 /// If not, it is possible that the call dispatches to another definition at
99 bool mayHaveOtherDefinitions() { return R != 0; }
101 /// When other definitions are possible, returns the region whose runtime type
102 /// determines the method definition.
103 const MemRegion *getDispatchRegion() { return R; }
106 /// \brief Represents an abstract call to a function or method along a
109 /// CallEvents are created through the factory methods of CallEventManager.
111 /// CallEvents should always be cheap to create and destroy. In order for
112 /// CallEventManager to be able to re-use CallEvent-sized memory blocks,
113 /// subclasses of CallEvent may not add any data members to the base class.
114 /// Use the "Data" and "Location" fields instead.
117 typedef CallEventKind Kind;
120 ProgramStateRef State;
121 const LocationContext *LCtx;
122 llvm::PointerUnion<const Expr *, const Decl *> Origin;
124 void operator=(const CallEvent &) LLVM_DELETED_FUNCTION;
127 // This is user data for subclasses.
130 // This is user data for subclasses.
131 // This should come right before RefCount, so that the two fields can be
132 // packed together on LP64 platforms.
133 SourceLocation Location;
136 mutable unsigned RefCount;
138 template <typename T> friend struct llvm::IntrusiveRefCntPtrInfo;
139 void Retain() const { ++RefCount; }
140 void Release() const;
143 friend class CallEventManager;
145 CallEvent(const Expr *E, ProgramStateRef state, const LocationContext *lctx)
146 : State(state), LCtx(lctx), Origin(E), RefCount(0) {}
148 CallEvent(const Decl *D, ProgramStateRef state, const LocationContext *lctx)
149 : State(state), LCtx(lctx), Origin(D), RefCount(0) {}
151 // DO NOT MAKE PUBLIC
152 CallEvent(const CallEvent &Original)
153 : State(Original.State), LCtx(Original.LCtx), Origin(Original.Origin),
154 Data(Original.Data), Location(Original.Location), RefCount(0) {}
156 /// Copies this CallEvent, with vtable intact, into a new block of memory.
157 virtual void cloneTo(void *Dest) const = 0;
159 /// \brief Get the value of arbitrary expressions at this point in the path.
160 SVal getSVal(const Stmt *S) const {
161 return getState()->getSVal(S, getLocationContext());
165 typedef SmallVectorImpl<SVal> ValueList;
167 /// \brief Used to specify non-argument regions that will be invalidated as a
168 /// result of this call.
169 virtual void getExtraInvalidatedValues(ValueList &Values) const {}
172 virtual ~CallEvent() {}
174 /// \brief Returns the kind of call this is.
175 virtual Kind getKind() const = 0;
177 /// \brief Returns the declaration of the function or method that will be
178 /// called. May be null.
179 virtual const Decl *getDecl() const {
180 return Origin.dyn_cast<const Decl *>();
183 /// \brief The state in which the call is being evaluated.
184 const ProgramStateRef &getState() const {
188 /// \brief The context in which the call is being evaluated.
189 const LocationContext *getLocationContext() const {
193 /// \brief Returns the definition of the function or method that will be
195 virtual RuntimeDefinition getRuntimeDefinition() const = 0;
197 /// \brief Returns the expression whose value will be the result of this call.
199 const Expr *getOriginExpr() const {
200 return Origin.dyn_cast<const Expr *>();
203 /// \brief Returns the number of arguments (explicit and implicit).
205 /// Note that this may be greater than the number of parameters in the
206 /// callee's declaration, and that it may include arguments not written in
208 virtual unsigned getNumArgs() const = 0;
210 /// \brief Returns true if the callee is known to be from a system header.
211 bool isInSystemHeader() const {
212 const Decl *D = getDecl();
216 SourceLocation Loc = D->getLocation();
218 const SourceManager &SM =
219 getState()->getStateManager().getContext().getSourceManager();
220 return SM.isInSystemHeader(D->getLocation());
223 // Special case for implicitly-declared global operator new/delete.
224 // These should be considered system functions.
225 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
226 return FD->isOverloadedOperator() && FD->isImplicit() && FD->isGlobal();
231 /// \brief Returns a source range for the entire call, suitable for
232 /// outputting in diagnostics.
233 virtual SourceRange getSourceRange() const {
234 return getOriginExpr()->getSourceRange();
237 /// \brief Returns the value of a given argument at the time of the call.
238 virtual SVal getArgSVal(unsigned Index) const;
240 /// \brief Returns the expression associated with a given argument.
241 /// May be null if this expression does not appear in the source.
242 virtual const Expr *getArgExpr(unsigned Index) const { return 0; }
244 /// \brief Returns the source range for errors associated with this argument.
246 /// May be invalid if the argument is not written in the source.
247 virtual SourceRange getArgSourceRange(unsigned Index) const;
249 /// \brief Returns the result type, adjusted for references.
250 QualType getResultType() const;
252 /// \brief Returns the return value of the call.
254 /// This should only be called if the CallEvent was created using a state in
255 /// which the return value has already been bound to the origin expression.
256 SVal getReturnValue() const;
258 /// \brief Returns true if any of the arguments appear to represent callbacks.
259 bool hasNonZeroCallbackArg() const;
261 /// \brief Returns true if any of the arguments are known to escape to long-
262 /// term storage, even if this method will not modify them.
263 // NOTE: The exact semantics of this are still being defined!
264 // We don't really want a list of hardcoded exceptions in the long run,
265 // but we don't want duplicated lists of known APIs in the short term either.
266 virtual bool argumentsMayEscape() const {
267 return hasNonZeroCallbackArg();
270 /// \brief Returns true if the callee is an externally-visible function in the
271 /// top-level namespace, such as \c malloc.
273 /// You can use this call to determine that a particular function really is
274 /// a library function and not, say, a C++ member function with the same name.
276 /// If a name is provided, the function must additionally match the given
279 /// Note that this deliberately excludes C++ library functions in the \c std
280 /// namespace, but will include C library functions accessed through the
281 /// \c std namespace. This also does not check if the function is declared
282 /// as 'extern "C"', or if it uses C++ name mangling.
283 // FIXME: Add a helper for checking namespaces.
284 // FIXME: Move this down to AnyFunctionCall once checkers have more
285 // precise callbacks.
286 bool isGlobalCFunction(StringRef SpecificName = StringRef()) const;
288 /// \brief Returns the name of the callee, if its name is a simple identifier.
290 /// Note that this will fail for Objective-C methods, blocks, and C++
291 /// overloaded operators. The former is named by a Selector rather than a
292 /// simple identifier, and the latter two do not have names.
293 // FIXME: Move this down to AnyFunctionCall once checkers have more
294 // precise callbacks.
295 const IdentifierInfo *getCalleeIdentifier() const {
296 const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(getDecl());
299 return ND->getIdentifier();
302 /// \brief Returns an appropriate ProgramPoint for this call.
303 ProgramPoint getProgramPoint(bool IsPreVisit = false,
304 const ProgramPointTag *Tag = 0) const;
306 /// \brief Returns a new state with all argument regions invalidated.
308 /// This accepts an alternate state in case some processing has already
310 ProgramStateRef invalidateRegions(unsigned BlockCount,
311 ProgramStateRef Orig = 0) const;
313 typedef std::pair<Loc, SVal> FrameBindingTy;
314 typedef SmallVectorImpl<FrameBindingTy> BindingsTy;
316 /// Populates the given SmallVector with the bindings in the callee's stack
317 /// frame at the start of this call.
318 virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
319 BindingsTy &Bindings) const = 0;
321 /// Returns a copy of this CallEvent, but using the given state.
322 template <typename T>
323 CallEventRef<T> cloneWithState(ProgramStateRef NewState) const;
325 /// Returns a copy of this CallEvent, but using the given state.
326 CallEventRef<> cloneWithState(ProgramStateRef NewState) const {
327 return cloneWithState<CallEvent>(NewState);
330 /// \brief Returns true if this is a statement is a function or method call
332 static bool isCallStmt(const Stmt *S);
334 /// \brief Returns the result type of a function or method declaration.
336 /// This will return a null QualType if the result type cannot be determined.
337 static QualType getDeclaredResultType(const Decl *D);
339 /// \brief Returns true if the given decl is known to be variadic.
341 /// \p D must not be null.
342 static bool isVariadic(const Decl *D);
344 // Iterator access to formal parameters and their types.
346 typedef std::const_mem_fun_t<QualType, ParmVarDecl> get_type_fun;
349 typedef const ParmVarDecl * const *param_iterator;
351 /// Returns an iterator over the call's formal parameters.
353 /// Remember that the number of formal parameters may not match the number
354 /// of arguments for all calls. However, the first parameter will always
355 /// correspond with the argument value returned by \c getArgSVal(0).
357 /// If the call has no accessible declaration, \c param_begin() will be equal
358 /// to \c param_end().
359 virtual param_iterator param_begin() const = 0;
360 /// \sa param_begin()
361 virtual param_iterator param_end() const = 0;
363 typedef llvm::mapped_iterator<param_iterator, get_type_fun>
366 /// Returns an iterator over the types of the call's formal parameters.
368 /// This uses the callee decl found by default name lookup rather than the
369 /// definition because it represents a public interface, and probably has
370 /// more annotations.
371 param_type_iterator param_type_begin() const {
372 return llvm::map_iterator(param_begin(),
373 get_type_fun(&ParmVarDecl::getType));
375 /// \sa param_type_begin()
376 param_type_iterator param_type_end() const {
377 return llvm::map_iterator(param_end(), get_type_fun(&ParmVarDecl::getType));
380 // For debugging purposes only
381 void dump(raw_ostream &Out) const;
382 LLVM_ATTRIBUTE_USED void dump() const;
386 /// \brief Represents a call to any sort of function that might have a
388 class AnyFunctionCall : public CallEvent {
390 AnyFunctionCall(const Expr *E, ProgramStateRef St,
391 const LocationContext *LCtx)
392 : CallEvent(E, St, LCtx) {}
393 AnyFunctionCall(const Decl *D, ProgramStateRef St,
394 const LocationContext *LCtx)
395 : CallEvent(D, St, LCtx) {}
396 AnyFunctionCall(const AnyFunctionCall &Other) : CallEvent(Other) {}
399 // This function is overridden by subclasses, but they must return
401 virtual const FunctionDecl *getDecl() const {
402 return cast<FunctionDecl>(CallEvent::getDecl());
405 virtual RuntimeDefinition getRuntimeDefinition() const {
406 const FunctionDecl *FD = getDecl();
407 // Note that the AnalysisDeclContext will have the FunctionDecl with
408 // the definition (if one exists).
410 AnalysisDeclContext *AD =
411 getLocationContext()->getAnalysisDeclContext()->
412 getManager()->getContext(FD);
414 return RuntimeDefinition(AD->getDecl());
417 return RuntimeDefinition();
420 virtual bool argumentsMayEscape() const;
422 virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
423 BindingsTy &Bindings) const;
425 virtual param_iterator param_begin() const;
426 virtual param_iterator param_end() const;
428 static bool classof(const CallEvent *CA) {
429 return CA->getKind() >= CE_BEG_FUNCTION_CALLS &&
430 CA->getKind() <= CE_END_FUNCTION_CALLS;
434 /// \brief Represents a call to a non-C++ function, written as a CallExpr.
435 class SimpleCall : public AnyFunctionCall {
437 SimpleCall(const CallExpr *CE, ProgramStateRef St,
438 const LocationContext *LCtx)
439 : AnyFunctionCall(CE, St, LCtx) {}
440 SimpleCall(const SimpleCall &Other) : AnyFunctionCall(Other) {}
443 virtual const CallExpr *getOriginExpr() const {
444 return cast<CallExpr>(AnyFunctionCall::getOriginExpr());
447 virtual const FunctionDecl *getDecl() const;
449 virtual unsigned getNumArgs() const { return getOriginExpr()->getNumArgs(); }
451 virtual const Expr *getArgExpr(unsigned Index) const {
452 return getOriginExpr()->getArg(Index);
455 static bool classof(const CallEvent *CA) {
456 return CA->getKind() >= CE_BEG_SIMPLE_CALLS &&
457 CA->getKind() <= CE_END_SIMPLE_CALLS;
461 /// \brief Represents a C function or static C++ member function call.
463 /// Example: \c fun()
464 class FunctionCall : public SimpleCall {
465 friend class CallEventManager;
468 FunctionCall(const CallExpr *CE, ProgramStateRef St,
469 const LocationContext *LCtx)
470 : SimpleCall(CE, St, LCtx) {}
472 FunctionCall(const FunctionCall &Other) : SimpleCall(Other) {}
473 virtual void cloneTo(void *Dest) const { new (Dest) FunctionCall(*this); }
476 virtual Kind getKind() const { return CE_Function; }
478 static bool classof(const CallEvent *CA) {
479 return CA->getKind() == CE_Function;
483 /// \brief Represents a call to a block.
485 /// Example: <tt>^{ /* ... */ }()</tt>
486 class BlockCall : public SimpleCall {
487 friend class CallEventManager;
490 BlockCall(const CallExpr *CE, ProgramStateRef St,
491 const LocationContext *LCtx)
492 : SimpleCall(CE, St, LCtx) {}
494 BlockCall(const BlockCall &Other) : SimpleCall(Other) {}
495 virtual void cloneTo(void *Dest) const { new (Dest) BlockCall(*this); }
497 virtual void getExtraInvalidatedValues(ValueList &Values) const;
500 /// \brief Returns the region associated with this instance of the block.
502 /// This may be NULL if the block's origin is unknown.
503 const BlockDataRegion *getBlockRegion() const;
505 /// \brief Gets the declaration of the block.
507 /// This is not an override of getDecl() because AnyFunctionCall has already
508 /// assumed that it's a FunctionDecl.
509 const BlockDecl *getBlockDecl() const {
510 const BlockDataRegion *BR = getBlockRegion();
513 return BR->getDecl();
516 virtual RuntimeDefinition getRuntimeDefinition() const {
517 return RuntimeDefinition(getBlockDecl());
520 virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
521 BindingsTy &Bindings) const;
523 virtual param_iterator param_begin() const;
524 virtual param_iterator param_end() const;
526 virtual Kind getKind() const { return CE_Block; }
528 static bool classof(const CallEvent *CA) {
529 return CA->getKind() == CE_Block;
533 /// \brief Represents a non-static C++ member function call, no matter how
535 class CXXInstanceCall : public AnyFunctionCall {
537 virtual void getExtraInvalidatedValues(ValueList &Values) const;
539 CXXInstanceCall(const CallExpr *CE, ProgramStateRef St,
540 const LocationContext *LCtx)
541 : AnyFunctionCall(CE, St, LCtx) {}
542 CXXInstanceCall(const FunctionDecl *D, ProgramStateRef St,
543 const LocationContext *LCtx)
544 : AnyFunctionCall(D, St, LCtx) {}
547 CXXInstanceCall(const CXXInstanceCall &Other) : AnyFunctionCall(Other) {}
550 /// \brief Returns the expression representing the implicit 'this' object.
551 virtual const Expr *getCXXThisExpr() const { return 0; }
553 /// \brief Returns the value of the implicit 'this' object.
554 virtual SVal getCXXThisVal() const;
556 virtual const FunctionDecl *getDecl() const;
558 virtual RuntimeDefinition getRuntimeDefinition() const;
560 virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
561 BindingsTy &Bindings) const;
563 static bool classof(const CallEvent *CA) {
564 return CA->getKind() >= CE_BEG_CXX_INSTANCE_CALLS &&
565 CA->getKind() <= CE_END_CXX_INSTANCE_CALLS;
569 /// \brief Represents a non-static C++ member function call.
571 /// Example: \c obj.fun()
572 class CXXMemberCall : public CXXInstanceCall {
573 friend class CallEventManager;
576 CXXMemberCall(const CXXMemberCallExpr *CE, ProgramStateRef St,
577 const LocationContext *LCtx)
578 : CXXInstanceCall(CE, St, LCtx) {}
580 CXXMemberCall(const CXXMemberCall &Other) : CXXInstanceCall(Other) {}
581 virtual void cloneTo(void *Dest) const { new (Dest) CXXMemberCall(*this); }
584 virtual const CXXMemberCallExpr *getOriginExpr() const {
585 return cast<CXXMemberCallExpr>(CXXInstanceCall::getOriginExpr());
588 virtual unsigned getNumArgs() const {
589 if (const CallExpr *CE = getOriginExpr())
590 return CE->getNumArgs();
594 virtual const Expr *getArgExpr(unsigned Index) const {
595 return getOriginExpr()->getArg(Index);
598 virtual const Expr *getCXXThisExpr() const;
600 virtual RuntimeDefinition getRuntimeDefinition() const;
602 virtual Kind getKind() const { return CE_CXXMember; }
604 static bool classof(const CallEvent *CA) {
605 return CA->getKind() == CE_CXXMember;
609 /// \brief Represents a C++ overloaded operator call where the operator is
610 /// implemented as a non-static member function.
612 /// Example: <tt>iter + 1</tt>
613 class CXXMemberOperatorCall : public CXXInstanceCall {
614 friend class CallEventManager;
617 CXXMemberOperatorCall(const CXXOperatorCallExpr *CE, ProgramStateRef St,
618 const LocationContext *LCtx)
619 : CXXInstanceCall(CE, St, LCtx) {}
621 CXXMemberOperatorCall(const CXXMemberOperatorCall &Other)
622 : CXXInstanceCall(Other) {}
623 virtual void cloneTo(void *Dest) const {
624 new (Dest) CXXMemberOperatorCall(*this);
628 virtual const CXXOperatorCallExpr *getOriginExpr() const {
629 return cast<CXXOperatorCallExpr>(CXXInstanceCall::getOriginExpr());
632 virtual unsigned getNumArgs() const {
633 return getOriginExpr()->getNumArgs() - 1;
635 virtual const Expr *getArgExpr(unsigned Index) const {
636 return getOriginExpr()->getArg(Index + 1);
639 virtual const Expr *getCXXThisExpr() const;
641 virtual Kind getKind() const { return CE_CXXMemberOperator; }
643 static bool classof(const CallEvent *CA) {
644 return CA->getKind() == CE_CXXMemberOperator;
648 /// \brief Represents an implicit call to a C++ destructor.
650 /// This can occur at the end of a scope (for automatic objects), at the end
651 /// of a full-expression (for temporaries), or as part of a delete.
652 class CXXDestructorCall : public CXXInstanceCall {
653 friend class CallEventManager;
656 typedef llvm::PointerIntPair<const MemRegion *, 1, bool> DtorDataTy;
658 /// Creates an implicit destructor.
660 /// \param DD The destructor that will be called.
661 /// \param Trigger The statement whose completion causes this destructor call.
662 /// \param Target The object region to be destructed.
663 /// \param St The path-sensitive state at this point in the program.
664 /// \param LCtx The location context at this point in the program.
665 CXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger,
666 const MemRegion *Target, bool IsBaseDestructor,
667 ProgramStateRef St, const LocationContext *LCtx)
668 : CXXInstanceCall(DD, St, LCtx) {
669 Data = DtorDataTy(Target, IsBaseDestructor).getOpaqueValue();
670 Location = Trigger->getLocEnd();
673 CXXDestructorCall(const CXXDestructorCall &Other) : CXXInstanceCall(Other) {}
674 virtual void cloneTo(void *Dest) const { new (Dest) CXXDestructorCall(*this); }
677 virtual SourceRange getSourceRange() const { return Location; }
678 virtual unsigned getNumArgs() const { return 0; }
680 virtual RuntimeDefinition getRuntimeDefinition() const;
682 /// \brief Returns the value of the implicit 'this' object.
683 virtual SVal getCXXThisVal() const;
685 /// Returns true if this is a call to a base class destructor.
686 bool isBaseDestructor() const {
687 return DtorDataTy::getFromOpaqueValue(Data).getInt();
690 virtual Kind getKind() const { return CE_CXXDestructor; }
692 static bool classof(const CallEvent *CA) {
693 return CA->getKind() == CE_CXXDestructor;
697 /// \brief Represents a call to a C++ constructor.
700 class CXXConstructorCall : public AnyFunctionCall {
701 friend class CallEventManager;
704 /// Creates a constructor call.
706 /// \param CE The constructor expression as written in the source.
707 /// \param Target The region where the object should be constructed. If NULL,
708 /// a new symbolic region will be used.
709 /// \param St The path-sensitive state at this point in the program.
710 /// \param LCtx The location context at this point in the program.
711 CXXConstructorCall(const CXXConstructExpr *CE, const MemRegion *Target,
712 ProgramStateRef St, const LocationContext *LCtx)
713 : AnyFunctionCall(CE, St, LCtx) {
717 CXXConstructorCall(const CXXConstructorCall &Other) : AnyFunctionCall(Other){}
718 virtual void cloneTo(void *Dest) const { new (Dest) CXXConstructorCall(*this); }
720 virtual void getExtraInvalidatedValues(ValueList &Values) const;
723 virtual const CXXConstructExpr *getOriginExpr() const {
724 return cast<CXXConstructExpr>(AnyFunctionCall::getOriginExpr());
727 virtual const CXXConstructorDecl *getDecl() const {
728 return getOriginExpr()->getConstructor();
731 virtual unsigned getNumArgs() const { return getOriginExpr()->getNumArgs(); }
733 virtual const Expr *getArgExpr(unsigned Index) const {
734 return getOriginExpr()->getArg(Index);
737 /// \brief Returns the value of the implicit 'this' object.
738 SVal getCXXThisVal() const;
740 virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
741 BindingsTy &Bindings) const;
743 virtual Kind getKind() const { return CE_CXXConstructor; }
745 static bool classof(const CallEvent *CA) {
746 return CA->getKind() == CE_CXXConstructor;
750 /// \brief Represents the memory allocation call in a C++ new-expression.
752 /// This is a call to "operator new".
753 class CXXAllocatorCall : public AnyFunctionCall {
754 friend class CallEventManager;
757 CXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef St,
758 const LocationContext *LCtx)
759 : AnyFunctionCall(E, St, LCtx) {}
761 CXXAllocatorCall(const CXXAllocatorCall &Other) : AnyFunctionCall(Other) {}
762 virtual void cloneTo(void *Dest) const { new (Dest) CXXAllocatorCall(*this); }
765 virtual const CXXNewExpr *getOriginExpr() const {
766 return cast<CXXNewExpr>(AnyFunctionCall::getOriginExpr());
769 virtual const FunctionDecl *getDecl() const {
770 return getOriginExpr()->getOperatorNew();
773 virtual unsigned getNumArgs() const {
774 return getOriginExpr()->getNumPlacementArgs() + 1;
777 virtual const Expr *getArgExpr(unsigned Index) const {
778 // The first argument of an allocator call is the size of the allocation.
781 return getOriginExpr()->getPlacementArg(Index - 1);
784 virtual Kind getKind() const { return CE_CXXAllocator; }
786 static bool classof(const CallEvent *CE) {
787 return CE->getKind() == CE_CXXAllocator;
791 /// \brief Represents the ways an Objective-C message send can occur.
793 // Note to maintainers: OCM_Message should always be last, since it does not
794 // need to fit in the Data field's low bits.
795 enum ObjCMessageKind {
801 /// \brief Represents any expression that calls an Objective-C method.
803 /// This includes all of the kinds listed in ObjCMessageKind.
804 class ObjCMethodCall : public CallEvent {
805 friend class CallEventManager;
807 const PseudoObjectExpr *getContainingPseudoObjectExpr() const;
810 ObjCMethodCall(const ObjCMessageExpr *Msg, ProgramStateRef St,
811 const LocationContext *LCtx)
812 : CallEvent(Msg, St, LCtx) {
816 ObjCMethodCall(const ObjCMethodCall &Other) : CallEvent(Other) {}
817 virtual void cloneTo(void *Dest) const { new (Dest) ObjCMethodCall(*this); }
819 virtual void getExtraInvalidatedValues(ValueList &Values) const;
821 /// Check if the selector may have multiple definitions (may have overrides).
822 virtual bool canBeOverridenInSubclass(ObjCInterfaceDecl *IDecl,
826 virtual const ObjCMessageExpr *getOriginExpr() const {
827 return cast<ObjCMessageExpr>(CallEvent::getOriginExpr());
829 virtual const ObjCMethodDecl *getDecl() const {
830 return getOriginExpr()->getMethodDecl();
832 virtual unsigned getNumArgs() const {
833 return getOriginExpr()->getNumArgs();
835 virtual const Expr *getArgExpr(unsigned Index) const {
836 return getOriginExpr()->getArg(Index);
839 bool isInstanceMessage() const {
840 return getOriginExpr()->isInstanceMessage();
842 ObjCMethodFamily getMethodFamily() const {
843 return getOriginExpr()->getMethodFamily();
845 Selector getSelector() const {
846 return getOriginExpr()->getSelector();
849 virtual SourceRange getSourceRange() const;
851 /// \brief Returns the value of the receiver at the time of this call.
852 SVal getReceiverSVal() const;
854 /// \brief Return the value of 'self' if available.
855 SVal getSelfSVal() const;
857 /// \brief Get the interface for the receiver.
859 /// This works whether this is an instance message or a class message.
860 /// However, it currently just uses the static type of the receiver.
861 const ObjCInterfaceDecl *getReceiverInterface() const {
862 return getOriginExpr()->getReceiverInterface();
865 /// \brief Checks if the receiver refers to 'self' or 'super'.
866 bool isReceiverSelfOrSuper() const;
868 /// Returns how the message was written in the source (property access,
869 /// subscript, or explicit message send).
870 ObjCMessageKind getMessageKind() const;
872 /// Returns true if this property access or subscript is a setter (has the
873 /// form of an assignment).
874 bool isSetter() const {
875 switch (getMessageKind()) {
877 llvm_unreachable("This is not a pseudo-object access!");
878 case OCM_PropertyAccess:
879 return getNumArgs() > 0;
881 return getNumArgs() > 1;
883 llvm_unreachable("Unknown message kind");
886 virtual RuntimeDefinition getRuntimeDefinition() const;
888 virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
889 BindingsTy &Bindings) const;
891 virtual param_iterator param_begin() const;
892 virtual param_iterator param_end() const;
894 virtual Kind getKind() const { return CE_ObjCMessage; }
896 static bool classof(const CallEvent *CA) {
897 return CA->getKind() == CE_ObjCMessage;
902 /// \brief Manages the lifetime of CallEvent objects.
904 /// CallEventManager provides a way to create arbitrary CallEvents "on the
905 /// stack" as if they were value objects by keeping a cache of CallEvent-sized
906 /// memory blocks. The CallEvents created by CallEventManager are only valid
907 /// for the lifetime of the OwnedCallEvent that holds them; right now these
908 /// objects cannot be copied and ownership cannot be transferred.
909 class CallEventManager {
910 friend class CallEvent;
912 llvm::BumpPtrAllocator &Alloc;
913 SmallVector<void *, 8> Cache;
915 void reclaim(const void *Memory) {
916 Cache.push_back(const_cast<void *>(Memory));
919 /// Returns memory that can be initialized as a CallEvent.
922 return Alloc.Allocate<FunctionCall>();
924 return Cache.pop_back_val();
927 template <typename T, typename Arg>
928 T *create(Arg A, ProgramStateRef St, const LocationContext *LCtx) {
929 return new (allocate()) T(A, St, LCtx);
932 template <typename T, typename Arg1, typename Arg2>
933 T *create(Arg1 A1, Arg2 A2, ProgramStateRef St, const LocationContext *LCtx) {
934 return new (allocate()) T(A1, A2, St, LCtx);
937 template <typename T, typename Arg1, typename Arg2, typename Arg3>
938 T *create(Arg1 A1, Arg2 A2, Arg3 A3, ProgramStateRef St,
939 const LocationContext *LCtx) {
940 return new (allocate()) T(A1, A2, A3, St, LCtx);
943 template <typename T, typename Arg1, typename Arg2, typename Arg3,
945 T *create(Arg1 A1, Arg2 A2, Arg3 A3, Arg4 A4, ProgramStateRef St,
946 const LocationContext *LCtx) {
947 return new (allocate()) T(A1, A2, A3, A4, St, LCtx);
951 CallEventManager(llvm::BumpPtrAllocator &alloc) : Alloc(alloc) {}
955 getCaller(const StackFrameContext *CalleeCtx, ProgramStateRef State);
959 getSimpleCall(const CallExpr *E, ProgramStateRef State,
960 const LocationContext *LCtx);
962 CallEventRef<ObjCMethodCall>
963 getObjCMethodCall(const ObjCMessageExpr *E, ProgramStateRef State,
964 const LocationContext *LCtx) {
965 return create<ObjCMethodCall>(E, State, LCtx);
968 CallEventRef<CXXConstructorCall>
969 getCXXConstructorCall(const CXXConstructExpr *E, const MemRegion *Target,
970 ProgramStateRef State, const LocationContext *LCtx) {
971 return create<CXXConstructorCall>(E, Target, State, LCtx);
974 CallEventRef<CXXDestructorCall>
975 getCXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger,
976 const MemRegion *Target, bool IsBase,
977 ProgramStateRef State, const LocationContext *LCtx) {
978 return create<CXXDestructorCall>(DD, Trigger, Target, IsBase, State, LCtx);
981 CallEventRef<CXXAllocatorCall>
982 getCXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef State,
983 const LocationContext *LCtx) {
984 return create<CXXAllocatorCall>(E, State, LCtx);
989 template <typename T>
990 CallEventRef<T> CallEvent::cloneWithState(ProgramStateRef NewState) const {
991 assert(isa<T>(*this) && "Cloning to unrelated type");
992 assert(sizeof(T) == sizeof(CallEvent) && "Subclasses may not add fields");
994 if (NewState == State)
995 return cast<T>(this);
997 CallEventManager &Mgr = State->getStateManager().getCallEventManager();
998 T *Copy = static_cast<T *>(Mgr.allocate());
1000 assert(Copy->getKind() == this->getKind() && "Bad copy");
1002 Copy->State = NewState;
1006 inline void CallEvent::Release() const {
1007 assert(RefCount > 0 && "Reference count is already zero.");
1013 CallEventManager &Mgr = State->getStateManager().getCallEventManager();
1019 } // end namespace ento
1020 } // end namespace clang
1023 // Support isa<>, cast<>, and dyn_cast<> for CallEventRef.
1024 template<class T> struct simplify_type< clang::ento::CallEventRef<T> > {
1025 typedef const T *SimpleType;
1028 getSimplifiedValue(clang::ento::CallEventRef<T> Val) {
1029 return Val.getPtr();