clang  6.0.0svn
CallEvent.h
Go to the documentation of this file.
1 //===- CallEvent.h - Wrapper for all function and method calls ----*- C++ -*--//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
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).
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #ifndef LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_CALLEVENT_H
17 #define LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_CALLEVENT_H
18 
19 #include "clang/AST/DeclCXX.h"
20 #include "clang/AST/ExprCXX.h"
21 #include "clang/AST/ExprObjC.h"
26 #include "llvm/ADT/PointerIntPair.h"
27 #include <utility>
28 
29 namespace clang {
30 class ProgramPoint;
31 class ProgramPointTag;
32 
33 namespace ento {
34 
48 };
49 
50 class CallEvent;
51 class CallEventManager;
52 
53 /// This class represents a description of a function call using the number of
54 /// arguments and the name of the function.
56  friend CallEvent;
57  mutable IdentifierInfo *II;
58  mutable bool IsLookupDone;
59  StringRef FuncName;
60  unsigned RequiredArgs;
61 
62 public:
63  const static unsigned NoArgRequirement = ~0;
64  /// \brief Constructs a CallDescription object.
65  ///
66  /// @param FuncName The name of the function that will be matched.
67  ///
68  /// @param RequiredArgs The number of arguments that is expected to match a
69  /// call. Omit this parameter to match every occurance of call with a given
70  /// name regardless the number of arguments.
71  CallDescription(StringRef FuncName, unsigned RequiredArgs = NoArgRequirement)
72  : II(nullptr), IsLookupDone(false), FuncName(FuncName),
73  RequiredArgs(RequiredArgs) {}
74 
75  /// \brief Get the name of the function that this object matches.
76  StringRef getFunctionName() const { return FuncName; }
77 };
78 
79 template<typename T = CallEvent>
80 class CallEventRef : public IntrusiveRefCntPtr<const T> {
81 public:
82  CallEventRef(const T *Call) : IntrusiveRefCntPtr<const T>(Call) {}
83  CallEventRef(const CallEventRef &Orig) : IntrusiveRefCntPtr<const T>(Orig) {}
84 
86  return this->get()->template cloneWithState<T>(State);
87  }
88 
89  // Allow implicit conversions to a superclass type, since CallEventRef
90  // behaves like a pointer-to-const.
91  template <typename SuperT>
92  operator CallEventRef<SuperT> () const {
93  return this->get();
94  }
95 };
96 
97 /// \class RuntimeDefinition
98 /// \brief Defines the runtime definition of the called function.
99 ///
100 /// Encapsulates the information we have about which Decl will be used
101 /// when the call is executed on the given path. When dealing with dynamic
102 /// dispatch, the information is based on DynamicTypeInfo and might not be
103 /// precise.
105  /// The Declaration of the function which could be called at runtime.
106  /// NULL if not available.
107  const Decl *D;
108 
109  /// The region representing an object (ObjC/C++) on which the method is
110  /// called. With dynamic dispatch, the method definition depends on the
111  /// runtime type of this object. NULL when the DynamicTypeInfo is
112  /// precise.
113  const MemRegion *R;
114 
115 public:
116  RuntimeDefinition(): D(nullptr), R(nullptr) {}
117  RuntimeDefinition(const Decl *InD): D(InD), R(nullptr) {}
118  RuntimeDefinition(const Decl *InD, const MemRegion *InR): D(InD), R(InR) {}
119  const Decl *getDecl() { return D; }
120 
121  /// \brief Check if the definition we have is precise.
122  /// If not, it is possible that the call dispatches to another definition at
123  /// execution time.
124  bool mayHaveOtherDefinitions() { return R != nullptr; }
125 
126  /// When other definitions are possible, returns the region whose runtime type
127  /// determines the method definition.
128  const MemRegion *getDispatchRegion() { return R; }
129 };
130 
131 /// \brief Represents an abstract call to a function or method along a
132 /// particular path.
133 ///
134 /// CallEvents are created through the factory methods of CallEventManager.
135 ///
136 /// CallEvents should always be cheap to create and destroy. In order for
137 /// CallEventManager to be able to re-use CallEvent-sized memory blocks,
138 /// subclasses of CallEvent may not add any data members to the base class.
139 /// Use the "Data" and "Location" fields instead.
140 class CallEvent {
141 public:
143 
144 private:
146  const LocationContext *LCtx;
147  llvm::PointerUnion<const Expr *, const Decl *> Origin;
148 
149  void operator=(const CallEvent &) = delete;
150 
151 protected:
152  // This is user data for subclasses.
153  const void *Data;
154 
155  // This is user data for subclasses.
156  // This should come right before RefCount, so that the two fields can be
157  // packed together on LP64 platforms.
159 
160 private:
161  mutable unsigned RefCount;
162 
163  template <typename T> friend struct llvm::IntrusiveRefCntPtrInfo;
164  void Retain() const { ++RefCount; }
165  void Release() const;
166 
167 protected:
168  friend class CallEventManager;
169 
171  : State(std::move(state)), LCtx(lctx), Origin(E), RefCount(0) {}
172 
174  : State(std::move(state)), LCtx(lctx), Origin(D), RefCount(0) {}
175 
176  // DO NOT MAKE PUBLIC
177  CallEvent(const CallEvent &Original)
178  : State(Original.State), LCtx(Original.LCtx), Origin(Original.Origin),
179  Data(Original.Data), Location(Original.Location), RefCount(0) {}
180 
181  /// Copies this CallEvent, with vtable intact, into a new block of memory.
182  virtual void cloneTo(void *Dest) const = 0;
183 
184  /// \brief Get the value of arbitrary expressions at this point in the path.
185  SVal getSVal(const Stmt *S) const {
186  return getState()->getSVal(S, getLocationContext());
187  }
188 
189 
191 
192  /// \brief Used to specify non-argument regions that will be invalidated as a
193  /// result of this call.
194  virtual void getExtraInvalidatedValues(ValueList &Values,
195  RegionAndSymbolInvalidationTraits *ETraits) const {}
196 
197 public:
198  virtual ~CallEvent() {}
199 
200  /// \brief Returns the kind of call this is.
201  virtual Kind getKind() const = 0;
202 
203  /// \brief Returns the declaration of the function or method that will be
204  /// called. May be null.
205  virtual const Decl *getDecl() const {
206  return Origin.dyn_cast<const Decl *>();
207  }
208 
209  /// \brief The state in which the call is being evaluated.
210  const ProgramStateRef &getState() const {
211  return State;
212  }
213 
214  /// \brief The context in which the call is being evaluated.
216  return LCtx;
217  }
218 
219  /// \brief Returns the definition of the function or method that will be
220  /// called.
221  virtual RuntimeDefinition getRuntimeDefinition() const = 0;
222 
223  /// \brief Returns the expression whose value will be the result of this call.
224  /// May be null.
225  const Expr *getOriginExpr() const {
226  return Origin.dyn_cast<const Expr *>();
227  }
228 
229  /// \brief Returns the number of arguments (explicit and implicit).
230  ///
231  /// Note that this may be greater than the number of parameters in the
232  /// callee's declaration, and that it may include arguments not written in
233  /// the source.
234  virtual unsigned getNumArgs() const = 0;
235 
236  /// \brief Returns true if the callee is known to be from a system header.
237  bool isInSystemHeader() const {
238  const Decl *D = getDecl();
239  if (!D)
240  return false;
241 
243  if (Loc.isValid()) {
244  const SourceManager &SM =
245  getState()->getStateManager().getContext().getSourceManager();
246  return SM.isInSystemHeader(D->getLocation());
247  }
248 
249  // Special case for implicitly-declared global operator new/delete.
250  // These should be considered system functions.
251  if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
252  return FD->isOverloadedOperator() && FD->isImplicit() && FD->isGlobal();
253 
254  return false;
255  }
256 
257  /// \brief Returns true if the CallEvent is a call to a function that matches
258  /// the CallDescription.
259  ///
260  /// Note that this function is not intended to be used to match Obj-C method
261  /// calls.
262  bool isCalled(const CallDescription &CD) const;
263 
264  /// \brief Returns a source range for the entire call, suitable for
265  /// outputting in diagnostics.
266  virtual SourceRange getSourceRange() const {
267  return getOriginExpr()->getSourceRange();
268  }
269 
270  /// \brief Returns the value of a given argument at the time of the call.
271  virtual SVal getArgSVal(unsigned Index) const;
272 
273  /// \brief Returns the expression associated with a given argument.
274  /// May be null if this expression does not appear in the source.
275  virtual const Expr *getArgExpr(unsigned Index) const { return nullptr; }
276 
277  /// \brief Returns the source range for errors associated with this argument.
278  ///
279  /// May be invalid if the argument is not written in the source.
280  virtual SourceRange getArgSourceRange(unsigned Index) const;
281 
282  /// \brief Returns the result type, adjusted for references.
283  QualType getResultType() const;
284 
285  /// \brief Returns the return value of the call.
286  ///
287  /// This should only be called if the CallEvent was created using a state in
288  /// which the return value has already been bound to the origin expression.
289  SVal getReturnValue() const;
290 
291  /// \brief Returns true if the type of any of the non-null arguments satisfies
292  /// the condition.
293  bool hasNonNullArgumentsWithType(bool (*Condition)(QualType)) const;
294 
295  /// \brief Returns true if any of the arguments appear to represent callbacks.
296  bool hasNonZeroCallbackArg() const;
297 
298  /// \brief Returns true if any of the arguments is void*.
299  bool hasVoidPointerToNonConstArg() const;
300 
301  /// \brief Returns true if any of the arguments are known to escape to long-
302  /// term storage, even if this method will not modify them.
303  // NOTE: The exact semantics of this are still being defined!
304  // We don't really want a list of hardcoded exceptions in the long run,
305  // but we don't want duplicated lists of known APIs in the short term either.
306  virtual bool argumentsMayEscape() const {
307  return hasNonZeroCallbackArg();
308  }
309 
310  /// \brief Returns true if the callee is an externally-visible function in the
311  /// top-level namespace, such as \c malloc.
312  ///
313  /// You can use this call to determine that a particular function really is
314  /// a library function and not, say, a C++ member function with the same name.
315  ///
316  /// If a name is provided, the function must additionally match the given
317  /// name.
318  ///
319  /// Note that this deliberately excludes C++ library functions in the \c std
320  /// namespace, but will include C library functions accessed through the
321  /// \c std namespace. This also does not check if the function is declared
322  /// as 'extern "C"', or if it uses C++ name mangling.
323  // FIXME: Add a helper for checking namespaces.
324  // FIXME: Move this down to AnyFunctionCall once checkers have more
325  // precise callbacks.
326  bool isGlobalCFunction(StringRef SpecificName = StringRef()) const;
327 
328  /// \brief Returns the name of the callee, if its name is a simple identifier.
329  ///
330  /// Note that this will fail for Objective-C methods, blocks, and C++
331  /// overloaded operators. The former is named by a Selector rather than a
332  /// simple identifier, and the latter two do not have names.
333  // FIXME: Move this down to AnyFunctionCall once checkers have more
334  // precise callbacks.
336  const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(getDecl());
337  if (!ND)
338  return nullptr;
339  return ND->getIdentifier();
340  }
341 
342  /// \brief Returns an appropriate ProgramPoint for this call.
343  ProgramPoint getProgramPoint(bool IsPreVisit = false,
344  const ProgramPointTag *Tag = nullptr) const;
345 
346  /// \brief Returns a new state with all argument regions invalidated.
347  ///
348  /// This accepts an alternate state in case some processing has already
349  /// occurred.
350  ProgramStateRef invalidateRegions(unsigned BlockCount,
351  ProgramStateRef Orig = nullptr) const;
352 
353  typedef std::pair<Loc, SVal> FrameBindingTy;
355 
356  /// Populates the given SmallVector with the bindings in the callee's stack
357  /// frame at the start of this call.
358  virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
359  BindingsTy &Bindings) const = 0;
360 
361  /// Returns a copy of this CallEvent, but using the given state.
362  template <typename T>
363  CallEventRef<T> cloneWithState(ProgramStateRef NewState) const;
364 
365  /// Returns a copy of this CallEvent, but using the given state.
367  return cloneWithState<CallEvent>(NewState);
368  }
369 
370  /// \brief Returns true if this is a statement is a function or method call
371  /// of some kind.
372  static bool isCallStmt(const Stmt *S);
373 
374  /// \brief Returns the result type of a function or method declaration.
375  ///
376  /// This will return a null QualType if the result type cannot be determined.
377  static QualType getDeclaredResultType(const Decl *D);
378 
379  /// \brief Returns true if the given decl is known to be variadic.
380  ///
381  /// \p D must not be null.
382  static bool isVariadic(const Decl *D);
383 
384  // Iterator access to formal parameters and their types.
385 private:
386  struct GetTypeFn {
387  QualType operator()(ParmVarDecl *PD) const { return PD->getType(); }
388  };
389 
390 public:
391  /// Return call's formal parameters.
392  ///
393  /// Remember that the number of formal parameters may not match the number
394  /// of arguments for all calls. However, the first parameter will always
395  /// correspond with the argument value returned by \c getArgSVal(0).
396  virtual ArrayRef<ParmVarDecl*> parameters() const = 0;
397 
398  typedef llvm::mapped_iterator<ArrayRef<ParmVarDecl*>::iterator, GetTypeFn>
400 
401  /// Returns an iterator over the types of the call's formal parameters.
402  ///
403  /// This uses the callee decl found by default name lookup rather than the
404  /// definition because it represents a public interface, and probably has
405  /// more annotations.
407  return llvm::map_iterator(parameters().begin(), GetTypeFn());
408  }
409  /// \sa param_type_begin()
411  return llvm::map_iterator(parameters().end(), GetTypeFn());
412  }
413 
414  // For debugging purposes only
415  void dump(raw_ostream &Out) const;
416  void dump() const;
417 };
418 
419 
420 /// \brief Represents a call to any sort of function that might have a
421 /// FunctionDecl.
422 class AnyFunctionCall : public CallEvent {
423 protected:
425  const LocationContext *LCtx)
426  : CallEvent(E, St, LCtx) {}
428  const LocationContext *LCtx)
429  : CallEvent(D, St, LCtx) {}
430  AnyFunctionCall(const AnyFunctionCall &Other) : CallEvent(Other) {}
431 
432 public:
433  // This function is overridden by subclasses, but they must return
434  // a FunctionDecl.
435  const FunctionDecl *getDecl() const override {
436  return cast<FunctionDecl>(CallEvent::getDecl());
437  }
438 
439  RuntimeDefinition getRuntimeDefinition() const override;
440 
441  bool argumentsMayEscape() const override;
442 
443  void getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
444  BindingsTy &Bindings) const override;
445 
446  ArrayRef<ParmVarDecl *> parameters() const override;
447 
448  static bool classof(const CallEvent *CA) {
449  return CA->getKind() >= CE_BEG_FUNCTION_CALLS &&
451  }
452 };
453 
454 /// \brief Represents a C function or static C++ member function call.
455 ///
456 /// Example: \c fun()
458  friend class CallEventManager;
459 
460 protected:
462  const LocationContext *LCtx)
463  : AnyFunctionCall(CE, St, LCtx) {}
465  : AnyFunctionCall(Other) {}
466  void cloneTo(void *Dest) const override {
467  new (Dest) SimpleFunctionCall(*this);
468  }
469 
470 public:
471  virtual const CallExpr *getOriginExpr() const {
472  return cast<CallExpr>(AnyFunctionCall::getOriginExpr());
473  }
474 
475  const FunctionDecl *getDecl() const override;
476 
477  unsigned getNumArgs() const override { return getOriginExpr()->getNumArgs(); }
478 
479  const Expr *getArgExpr(unsigned Index) const override {
480  return getOriginExpr()->getArg(Index);
481  }
482 
483  Kind getKind() const override { return CE_Function; }
484 
485  static bool classof(const CallEvent *CA) {
486  return CA->getKind() == CE_Function;
487  }
488 };
489 
490 /// \brief Represents a call to a block.
491 ///
492 /// Example: <tt>^{ /* ... */ }()</tt>
493 class BlockCall : public CallEvent {
494  friend class CallEventManager;
495 
496 protected:
498  const LocationContext *LCtx)
499  : CallEvent(CE, St, LCtx) {}
500 
501  BlockCall(const BlockCall &Other) : CallEvent(Other) {}
502  void cloneTo(void *Dest) const override { new (Dest) BlockCall(*this); }
503 
504  void getExtraInvalidatedValues(ValueList &Values,
505  RegionAndSymbolInvalidationTraits *ETraits) const override;
506 
507 public:
508  virtual const CallExpr *getOriginExpr() const {
509  return cast<CallExpr>(CallEvent::getOriginExpr());
510  }
511 
512  unsigned getNumArgs() const override { return getOriginExpr()->getNumArgs(); }
513 
514  const Expr *getArgExpr(unsigned Index) const override {
515  return getOriginExpr()->getArg(Index);
516  }
517 
518  /// \brief Returns the region associated with this instance of the block.
519  ///
520  /// This may be NULL if the block's origin is unknown.
521  const BlockDataRegion *getBlockRegion() const;
522 
523  const BlockDecl *getDecl() const override {
524  const BlockDataRegion *BR = getBlockRegion();
525  if (!BR)
526  return nullptr;
527  return BR->getDecl();
528  }
529 
530  bool isConversionFromLambda() const {
531  const BlockDecl *BD = getDecl();
532  if (!BD)
533  return false;
534 
535  return BD->isConversionFromLambda();
536  }
537 
538  /// \brief For a block converted from a C++ lambda, returns the block
539  /// VarRegion for the variable holding the captured C++ lambda record.
540  const VarRegion *getRegionStoringCapturedLambda() const {
541  assert(isConversionFromLambda());
542  const BlockDataRegion *BR = getBlockRegion();
543  assert(BR && "Block converted from lambda must have a block region");
544 
545  auto I = BR->referenced_vars_begin();
546  assert(I != BR->referenced_vars_end());
547 
548  return I.getCapturedRegion();
549  }
550 
551  RuntimeDefinition getRuntimeDefinition() const override {
552  if (!isConversionFromLambda())
553  return RuntimeDefinition(getDecl());
554 
555  // Clang converts lambdas to blocks with an implicit user-defined
556  // conversion operator method on the lambda record that looks (roughly)
557  // like:
558  //
559  // typedef R(^block_type)(P1, P2, ...);
560  // operator block_type() const {
561  // auto Lambda = *this;
562  // return ^(P1 p1, P2 p2, ...){
563  // /* return Lambda(p1, p2, ...); */
564  // };
565  // }
566  //
567  // Here R is the return type of the lambda and P1, P2, ... are
568  // its parameter types. 'Lambda' is a fake VarDecl captured by the block
569  // that is initialized to a copy of the lambda.
570  //
571  // Sema leaves the body of a lambda-converted block empty (it is
572  // produced by CodeGen), so we can't analyze it directly. Instead, we skip
573  // the block body and analyze the operator() method on the captured lambda.
574  const VarDecl *LambdaVD = getRegionStoringCapturedLambda()->getDecl();
575  const CXXRecordDecl *LambdaDecl = LambdaVD->getType()->getAsCXXRecordDecl();
576  CXXMethodDecl* LambdaCallOperator = LambdaDecl->getLambdaCallOperator();
577 
578  return RuntimeDefinition(LambdaCallOperator);
579  }
580 
581  bool argumentsMayEscape() const override {
582  return true;
583  }
584 
585  void getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
586  BindingsTy &Bindings) const override;
587 
588  ArrayRef<ParmVarDecl*> parameters() const override;
589 
590  Kind getKind() const override { return CE_Block; }
591 
592  static bool classof(const CallEvent *CA) {
593  return CA->getKind() == CE_Block;
594  }
595 };
596 
597 /// \brief Represents a non-static C++ member function call, no matter how
598 /// it is written.
600 protected:
601  void getExtraInvalidatedValues(ValueList &Values,
602  RegionAndSymbolInvalidationTraits *ETraits) const override;
603 
605  const LocationContext *LCtx)
606  : AnyFunctionCall(CE, St, LCtx) {}
608  const LocationContext *LCtx)
609  : AnyFunctionCall(D, St, LCtx) {}
610 
611 
613 
614 public:
615  /// \brief Returns the expression representing the implicit 'this' object.
616  virtual const Expr *getCXXThisExpr() const { return nullptr; }
617 
618  /// \brief Returns the value of the implicit 'this' object.
619  virtual SVal getCXXThisVal() const;
620 
621  const FunctionDecl *getDecl() const override;
622 
623  RuntimeDefinition getRuntimeDefinition() const override;
624 
625  void getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
626  BindingsTy &Bindings) const override;
627 
628  static bool classof(const CallEvent *CA) {
629  return CA->getKind() >= CE_BEG_CXX_INSTANCE_CALLS &&
630  CA->getKind() <= CE_END_CXX_INSTANCE_CALLS;
631  }
632 };
633 
634 /// \brief Represents a non-static C++ member function call.
635 ///
636 /// Example: \c obj.fun()
638  friend class CallEventManager;
639 
640 protected:
642  const LocationContext *LCtx)
643  : CXXInstanceCall(CE, St, LCtx) {}
644 
645  CXXMemberCall(const CXXMemberCall &Other) : CXXInstanceCall(Other) {}
646  void cloneTo(void *Dest) const override { new (Dest) CXXMemberCall(*this); }
647 
648 public:
649  virtual const CXXMemberCallExpr *getOriginExpr() const {
650  return cast<CXXMemberCallExpr>(CXXInstanceCall::getOriginExpr());
651  }
652 
653  unsigned getNumArgs() const override {
654  if (const CallExpr *CE = getOriginExpr())
655  return CE->getNumArgs();
656  return 0;
657  }
658 
659  const Expr *getArgExpr(unsigned Index) const override {
660  return getOriginExpr()->getArg(Index);
661  }
662 
663  const Expr *getCXXThisExpr() const override;
664 
665  RuntimeDefinition getRuntimeDefinition() const override;
666 
667  Kind getKind() const override { return CE_CXXMember; }
668 
669  static bool classof(const CallEvent *CA) {
670  return CA->getKind() == CE_CXXMember;
671  }
672 };
673 
674 /// \brief Represents a C++ overloaded operator call where the operator is
675 /// implemented as a non-static member function.
676 ///
677 /// Example: <tt>iter + 1</tt>
679  friend class CallEventManager;
680 
681 protected:
683  const LocationContext *LCtx)
684  : CXXInstanceCall(CE, St, LCtx) {}
685 
687  : CXXInstanceCall(Other) {}
688  void cloneTo(void *Dest) const override {
689  new (Dest) CXXMemberOperatorCall(*this);
690  }
691 
692 public:
693  virtual const CXXOperatorCallExpr *getOriginExpr() const {
694  return cast<CXXOperatorCallExpr>(CXXInstanceCall::getOriginExpr());
695  }
696 
697  unsigned getNumArgs() const override {
698  return getOriginExpr()->getNumArgs() - 1;
699  }
700  const Expr *getArgExpr(unsigned Index) const override {
701  return getOriginExpr()->getArg(Index + 1);
702  }
703 
704  const Expr *getCXXThisExpr() const override;
705 
706  Kind getKind() const override { return CE_CXXMemberOperator; }
707 
708  static bool classof(const CallEvent *CA) {
709  return CA->getKind() == CE_CXXMemberOperator;
710  }
711 };
712 
713 /// \brief Represents an implicit call to a C++ destructor.
714 ///
715 /// This can occur at the end of a scope (for automatic objects), at the end
716 /// of a full-expression (for temporaries), or as part of a delete.
718  friend class CallEventManager;
719 
720 protected:
721  typedef llvm::PointerIntPair<const MemRegion *, 1, bool> DtorDataTy;
722 
723  /// Creates an implicit destructor.
724  ///
725  /// \param DD The destructor that will be called.
726  /// \param Trigger The statement whose completion causes this destructor call.
727  /// \param Target The object region to be destructed.
728  /// \param St The path-sensitive state at this point in the program.
729  /// \param LCtx The location context at this point in the program.
730  CXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger,
731  const MemRegion *Target, bool IsBaseDestructor,
732  ProgramStateRef St, const LocationContext *LCtx)
733  : CXXInstanceCall(DD, St, LCtx) {
734  Data = DtorDataTy(Target, IsBaseDestructor).getOpaqueValue();
735  Location = Trigger->getLocEnd();
736  }
737 
739  void cloneTo(void *Dest) const override {new (Dest) CXXDestructorCall(*this);}
740 
741 public:
742  SourceRange getSourceRange() const override { return Location; }
743  unsigned getNumArgs() const override { return 0; }
744 
745  RuntimeDefinition getRuntimeDefinition() const override;
746 
747  /// \brief Returns the value of the implicit 'this' object.
748  SVal getCXXThisVal() const override;
749 
750  /// Returns true if this is a call to a base class destructor.
751  bool isBaseDestructor() const {
752  return DtorDataTy::getFromOpaqueValue(Data).getInt();
753  }
754 
755  Kind getKind() const override { return CE_CXXDestructor; }
756 
757  static bool classof(const CallEvent *CA) {
758  return CA->getKind() == CE_CXXDestructor;
759  }
760 };
761 
762 /// \brief Represents a call to a C++ constructor.
763 ///
764 /// Example: \c T(1)
766  friend class CallEventManager;
767 
768 protected:
769  /// Creates a constructor call.
770  ///
771  /// \param CE The constructor expression as written in the source.
772  /// \param Target The region where the object should be constructed. If NULL,
773  /// a new symbolic region will be used.
774  /// \param St The path-sensitive state at this point in the program.
775  /// \param LCtx The location context at this point in the program.
776  CXXConstructorCall(const CXXConstructExpr *CE, const MemRegion *Target,
777  ProgramStateRef St, const LocationContext *LCtx)
778  : AnyFunctionCall(CE, St, LCtx) {
779  Data = Target;
780  }
781 
783  void cloneTo(void *Dest) const override { new (Dest) CXXConstructorCall(*this); }
784 
785  void getExtraInvalidatedValues(ValueList &Values,
786  RegionAndSymbolInvalidationTraits *ETraits) const override;
787 
788 public:
789  virtual const CXXConstructExpr *getOriginExpr() const {
790  return cast<CXXConstructExpr>(AnyFunctionCall::getOriginExpr());
791  }
792 
793  const CXXConstructorDecl *getDecl() const override {
794  return getOriginExpr()->getConstructor();
795  }
796 
797  unsigned getNumArgs() const override { return getOriginExpr()->getNumArgs(); }
798 
799  const Expr *getArgExpr(unsigned Index) const override {
800  return getOriginExpr()->getArg(Index);
801  }
802 
803  /// \brief Returns the value of the implicit 'this' object.
804  SVal getCXXThisVal() const;
805 
806  void getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
807  BindingsTy &Bindings) const override;
808 
809  Kind getKind() const override { return CE_CXXConstructor; }
810 
811  static bool classof(const CallEvent *CA) {
812  return CA->getKind() == CE_CXXConstructor;
813  }
814 };
815 
816 /// \brief Represents the memory allocation call in a C++ new-expression.
817 ///
818 /// This is a call to "operator new".
820  friend class CallEventManager;
821 
822 protected:
824  const LocationContext *LCtx)
825  : AnyFunctionCall(E, St, LCtx) {}
826 
828  void cloneTo(void *Dest) const override { new (Dest) CXXAllocatorCall(*this); }
829 
830 public:
831  virtual const CXXNewExpr *getOriginExpr() const {
832  return cast<CXXNewExpr>(AnyFunctionCall::getOriginExpr());
833  }
834 
835  const FunctionDecl *getDecl() const override {
836  return getOriginExpr()->getOperatorNew();
837  }
838 
839  unsigned getNumArgs() const override {
840  return getOriginExpr()->getNumPlacementArgs() + 1;
841  }
842 
843  const Expr *getArgExpr(unsigned Index) const override {
844  // The first argument of an allocator call is the size of the allocation.
845  if (Index == 0)
846  return nullptr;
847  return getOriginExpr()->getPlacementArg(Index - 1);
848  }
849 
850  Kind getKind() const override { return CE_CXXAllocator; }
851 
852  static bool classof(const CallEvent *CE) {
853  return CE->getKind() == CE_CXXAllocator;
854  }
855 };
856 
857 /// \brief Represents the ways an Objective-C message send can occur.
858 //
859 // Note to maintainers: OCM_Message should always be last, since it does not
860 // need to fit in the Data field's low bits.
865 };
866 
867 /// \brief Represents any expression that calls an Objective-C method.
868 ///
869 /// This includes all of the kinds listed in ObjCMessageKind.
870 class ObjCMethodCall : public CallEvent {
871  friend class CallEventManager;
872 
873  const PseudoObjectExpr *getContainingPseudoObjectExpr() const;
874 
875 protected:
877  const LocationContext *LCtx)
878  : CallEvent(Msg, St, LCtx) {
879  Data = nullptr;
880  }
881 
882  ObjCMethodCall(const ObjCMethodCall &Other) : CallEvent(Other) {}
883  void cloneTo(void *Dest) const override { new (Dest) ObjCMethodCall(*this); }
884 
885  void getExtraInvalidatedValues(ValueList &Values,
886  RegionAndSymbolInvalidationTraits *ETraits) const override;
887 
888  /// Check if the selector may have multiple definitions (may have overrides).
889  virtual bool canBeOverridenInSubclass(ObjCInterfaceDecl *IDecl,
890  Selector Sel) const;
891 
892 public:
893  virtual const ObjCMessageExpr *getOriginExpr() const {
894  return cast<ObjCMessageExpr>(CallEvent::getOriginExpr());
895  }
896  const ObjCMethodDecl *getDecl() const override {
897  return getOriginExpr()->getMethodDecl();
898  }
899  unsigned getNumArgs() const override {
900  return getOriginExpr()->getNumArgs();
901  }
902  const Expr *getArgExpr(unsigned Index) const override {
903  return getOriginExpr()->getArg(Index);
904  }
905 
906  bool isInstanceMessage() const {
907  return getOriginExpr()->isInstanceMessage();
908  }
910  return getOriginExpr()->getMethodFamily();
911  }
913  return getOriginExpr()->getSelector();
914  }
915 
916  SourceRange getSourceRange() const override;
917 
918  /// \brief Returns the value of the receiver at the time of this call.
919  SVal getReceiverSVal() const;
920 
921  /// \brief Return the value of 'self' if available.
922  SVal getSelfSVal() const;
923 
924  /// \brief Get the interface for the receiver.
925  ///
926  /// This works whether this is an instance message or a class message.
927  /// However, it currently just uses the static type of the receiver.
929  return getOriginExpr()->getReceiverInterface();
930  }
931 
932  /// \brief Checks if the receiver refers to 'self' or 'super'.
933  bool isReceiverSelfOrSuper() const;
934 
935  /// Returns how the message was written in the source (property access,
936  /// subscript, or explicit message send).
937  ObjCMessageKind getMessageKind() const;
938 
939  /// Returns true if this property access or subscript is a setter (has the
940  /// form of an assignment).
941  bool isSetter() const {
942  switch (getMessageKind()) {
943  case OCM_Message:
944  llvm_unreachable("This is not a pseudo-object access!");
945  case OCM_PropertyAccess:
946  return getNumArgs() > 0;
947  case OCM_Subscript:
948  return getNumArgs() > 1;
949  }
950  llvm_unreachable("Unknown message kind");
951  }
952 
953  // Returns the property accessed by this method, either explicitly via
954  // property syntax or implicitly via a getter or setter method. Returns
955  // nullptr if the call is not a prooperty access.
956  const ObjCPropertyDecl *getAccessedProperty() const;
957 
958  RuntimeDefinition getRuntimeDefinition() const override;
959 
960  bool argumentsMayEscape() const override;
961 
962  void getInitialStackFrameContents(const StackFrameContext *CalleeCtx,
963  BindingsTy &Bindings) const override;
964 
965  ArrayRef<ParmVarDecl*> parameters() const override;
966 
967  Kind getKind() const override { return CE_ObjCMessage; }
968 
969  static bool classof(const CallEvent *CA) {
970  return CA->getKind() == CE_ObjCMessage;
971  }
972 };
973 
974 
975 /// \brief Manages the lifetime of CallEvent objects.
976 ///
977 /// CallEventManager provides a way to create arbitrary CallEvents "on the
978 /// stack" as if they were value objects by keeping a cache of CallEvent-sized
979 /// memory blocks. The CallEvents created by CallEventManager are only valid
980 /// for the lifetime of the OwnedCallEvent that holds them; right now these
981 /// objects cannot be copied and ownership cannot be transferred.
983  friend class CallEvent;
984 
985  llvm::BumpPtrAllocator &Alloc;
987  typedef SimpleFunctionCall CallEventTemplateTy;
988 
989  void reclaim(const void *Memory) {
990  Cache.push_back(const_cast<void *>(Memory));
991  }
992 
993  /// Returns memory that can be initialized as a CallEvent.
994  void *allocate() {
995  if (Cache.empty())
996  return Alloc.Allocate<CallEventTemplateTy>();
997  else
998  return Cache.pop_back_val();
999  }
1000 
1001  template <typename T, typename Arg>
1002  T *create(Arg A, ProgramStateRef St, const LocationContext *LCtx) {
1003  static_assert(sizeof(T) == sizeof(CallEventTemplateTy),
1004  "CallEvent subclasses are not all the same size");
1005  return new (allocate()) T(A, St, LCtx);
1006  }
1007 
1008  template <typename T, typename Arg1, typename Arg2>
1009  T *create(Arg1 A1, Arg2 A2, ProgramStateRef St, const LocationContext *LCtx) {
1010  static_assert(sizeof(T) == sizeof(CallEventTemplateTy),
1011  "CallEvent subclasses are not all the same size");
1012  return new (allocate()) T(A1, A2, St, LCtx);
1013  }
1014 
1015  template <typename T, typename Arg1, typename Arg2, typename Arg3>
1016  T *create(Arg1 A1, Arg2 A2, Arg3 A3, ProgramStateRef St,
1017  const LocationContext *LCtx) {
1018  static_assert(sizeof(T) == sizeof(CallEventTemplateTy),
1019  "CallEvent subclasses are not all the same size");
1020  return new (allocate()) T(A1, A2, A3, St, LCtx);
1021  }
1022 
1023  template <typename T, typename Arg1, typename Arg2, typename Arg3,
1024  typename Arg4>
1025  T *create(Arg1 A1, Arg2 A2, Arg3 A3, Arg4 A4, ProgramStateRef St,
1026  const LocationContext *LCtx) {
1027  static_assert(sizeof(T) == sizeof(CallEventTemplateTy),
1028  "CallEvent subclasses are not all the same size");
1029  return new (allocate()) T(A1, A2, A3, A4, St, LCtx);
1030  }
1031 
1032 public:
1033  CallEventManager(llvm::BumpPtrAllocator &alloc) : Alloc(alloc) {}
1034 
1035 
1036  CallEventRef<>
1037  getCaller(const StackFrameContext *CalleeCtx, ProgramStateRef State);
1038 
1039 
1040  CallEventRef<>
1041  getSimpleCall(const CallExpr *E, ProgramStateRef State,
1042  const LocationContext *LCtx);
1043 
1044  CallEventRef<ObjCMethodCall>
1046  const LocationContext *LCtx) {
1047  return create<ObjCMethodCall>(E, State, LCtx);
1048  }
1049 
1050  CallEventRef<CXXConstructorCall>
1051  getCXXConstructorCall(const CXXConstructExpr *E, const MemRegion *Target,
1052  ProgramStateRef State, const LocationContext *LCtx) {
1053  return create<CXXConstructorCall>(E, Target, State, LCtx);
1054  }
1055 
1056  CallEventRef<CXXDestructorCall>
1057  getCXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger,
1058  const MemRegion *Target, bool IsBase,
1059  ProgramStateRef State, const LocationContext *LCtx) {
1060  return create<CXXDestructorCall>(DD, Trigger, Target, IsBase, State, LCtx);
1061  }
1062 
1063  CallEventRef<CXXAllocatorCall>
1065  const LocationContext *LCtx) {
1066  return create<CXXAllocatorCall>(E, State, LCtx);
1067  }
1068 };
1069 
1070 
1071 template <typename T>
1073  assert(isa<T>(*this) && "Cloning to unrelated type");
1074  static_assert(sizeof(T) == sizeof(CallEvent),
1075  "Subclasses may not add fields");
1076 
1077  if (NewState == State)
1078  return cast<T>(this);
1079 
1080  CallEventManager &Mgr = State->getStateManager().getCallEventManager();
1081  T *Copy = static_cast<T *>(Mgr.allocate());
1082  cloneTo(Copy);
1083  assert(Copy->getKind() == this->getKind() && "Bad copy");
1084 
1085  Copy->State = NewState;
1086  return Copy;
1087 }
1088 
1089 inline void CallEvent::Release() const {
1090  assert(RefCount > 0 && "Reference count is already zero.");
1091  --RefCount;
1092 
1093  if (RefCount > 0)
1094  return;
1095 
1096  CallEventManager &Mgr = State->getStateManager().getCallEventManager();
1097  Mgr.reclaim(this);
1098 
1099  this->~CallEvent();
1100 }
1101 
1102 } // end namespace ento
1103 } // end namespace clang
1104 
1105 namespace llvm {
1106  // Support isa<>, cast<>, and dyn_cast<> for CallEventRef.
1107  template<class T> struct simplify_type< clang::ento::CallEventRef<T> > {
1108  typedef const T *SimpleType;
1109 
1110  static SimpleType
1112  return Val.get();
1113  }
1114  };
1115 }
1116 
1117 #endif
A call to an overloaded operator written using operator syntax.
Definition: ExprCXX.h:78
CallEvent(const CallEvent &Original)
Definition: CallEvent.h:177
CallEventKind Kind
Definition: CallEvent.h:142
Kind getKind() const override
Definition: CallEvent.h:967
An instance of this class is created to represent a function declaration or definition.
Definition: Decl.h:1697
RuntimeDefinition(const Decl *InD, const MemRegion *InR)
Definition: CallEvent.h:118
Smart pointer class that efficiently represents Objective-C method names.
A (possibly-)qualified type.
Definition: Type.h:653
MemRegion - The root abstract class for all memory regions.
Definition: MemRegion.h:79
CallEventRef< T > cloneWithState(ProgramStateRef NewState) const
Returns a copy of this CallEvent, but using the given state.
const CXXConstructorDecl * getDecl() const override
Definition: CallEvent.h:793
DominatorTree GraphTraits specialization so the DominatorTree can be iterable by generic graph iterat...
Definition: Dominators.h:26
CXXInstanceCall(const FunctionDecl *D, ProgramStateRef St, const LocationContext *LCtx)
Definition: CallEvent.h:607
static SimpleType getSimplifiedValue(clang::ento::CallEventRef< T > Val)
Definition: CallEvent.h:1111
TypePropertyCache< Private > Cache
Definition: Type.cpp:3396
void cloneTo(void *Dest) const override
Definition: CallEvent.h:828
Stmt - This represents one statement.
Definition: Stmt.h:66
Information about invalidation for a particular region/symbol.
Definition: MemRegion.h:1383
SimpleFunctionCall(const CallExpr *CE, ProgramStateRef St, const LocationContext *LCtx)
Definition: CallEvent.h:461
AnyFunctionCall(const Decl *D, ProgramStateRef St, const LocationContext *LCtx)
Definition: CallEvent.h:427
static bool classof(const CallEvent *CA)
Definition: CallEvent.h:969
Defines the SourceManager interface.
void cloneTo(void *Dest) const override
Definition: CallEvent.h:739
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:86
CXXMemberOperatorCall(const CXXOperatorCallExpr *CE, ProgramStateRef St, const LocationContext *LCtx)
Definition: CallEvent.h:682
Manages the lifetime of CallEvent objects.
Definition: CallEvent.h:982
IntrusiveRefCntPtr< const ProgramState > ProgramStateRef
static bool classof(const CallEvent *CA)
Definition: CallEvent.h:669
ObjCMethodCall(const ObjCMessageExpr *Msg, ProgramStateRef St, const LocationContext *LCtx)
Definition: CallEvent.h:876
CallEventRef< CXXDestructorCall > getCXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger, const MemRegion *Target, bool IsBase, ProgramStateRef State, const LocationContext *LCtx)
Definition: CallEvent.h:1057
Represents a call to a C++ constructor.
Definition: ExprCXX.h:1239
CXXAllocatorCall(const CXXAllocatorCall &Other)
Definition: CallEvent.h:827
Represents a C++ constructor within a class.
Definition: DeclCXX.h:2397
bool isBaseDestructor() const
Returns true if this is a call to a base class destructor.
Definition: CallEvent.h:751
const Expr * getOriginExpr() const
Returns the expression whose value will be the result of this call.
Definition: CallEvent.h:225
CXXConstructorCall(const CXXConstructorCall &Other)
Definition: CallEvent.h:782
VarDecl - An instance of this class is created to represent a variable declaration or definition...
Definition: Decl.h:806
static bool classof(const CallEvent *CA)
Definition: CallEvent.h:448
SVal getSVal(const Stmt *S) const
Get the value of arbitrary expressions at this point in the path.
Definition: CallEvent.h:185
ObjCMethodDecl - Represents an instance or class method declaration.
Definition: DeclObjC.h:139
static bool classof(const CallEvent *CA)
Definition: CallEvent.h:811
llvm::mapped_iterator< ArrayRef< ParmVarDecl * >::iterator, GetTypeFn > param_type_iterator
Definition: CallEvent.h:399
Represents a C++ overloaded operator call where the operator is implemented as a non-static member fu...
Definition: CallEvent.h:678
ParmVarDecl - Represents a parameter to a function.
Definition: Decl.h:1513
Defines the clang::Expr interface and subclasses for C++ expressions.
unsigned getNumArgs() const override
Returns the number of arguments (explicit and implicit).
Definition: CallEvent.h:477
ObjCMethodCall(const ObjCMethodCall &Other)
Definition: CallEvent.h:882
IdentifierInfo * getIdentifier() const
getIdentifier - Get the identifier that names this declaration, if there is one.
Definition: Decl.h:265
One of these records is kept for each identifier that is lexed.
unsigned getNumArgs() const override
Definition: CallEvent.h:743
SmallVectorImpl< FrameBindingTy > BindingsTy
Definition: CallEvent.h:354
param_type_iterator param_type_end() const
Definition: CallEvent.h:410
LineState State
ObjCMethodFamily
A family of Objective-C methods.
virtual const CallExpr * getOriginExpr() const
Definition: CallEvent.h:471
SourceLocation Location
Definition: CallEvent.h:158
Definition: Format.h:1900
const BlockDecl * getDecl() const override
Definition: CallEvent.h:523
const ObjCInterfaceDecl * getReceiverInterface() const
Get the interface for the receiver.
Definition: CallEvent.h:928
virtual const Expr * getArgExpr(unsigned Index) const
Returns the expression associated with a given argument.
Definition: CallEvent.h:275
i32 captured_struct **param SharedsTy A type which contains references the shared variables *param Shareds Context with the list of shared variables from the p *TaskFunction *param Data Additional data for task generation like final * state
bool argumentsMayEscape() const override
Definition: CallEvent.h:581
static bool classof(const CallEvent *CA)
Definition: CallEvent.h:708
Represents the memory allocation call in a C++ new-expression.
Definition: CallEvent.h:819
Kind getKind() const override
Definition: CallEvent.h:590
virtual const CXXOperatorCallExpr * getOriginExpr() const
Definition: CallEvent.h:693
Represents any expression that calls an Objective-C method.
Definition: CallEvent.h:870
static bool classof(const CallEvent *CA)
Definition: CallEvent.h:485
virtual Kind getKind() const =0
Returns the kind of call this is.
const FunctionDecl * getDecl() const override
Definition: CallEvent.h:835
static void dump(llvm::raw_ostream &OS, StringRef FunctionName, ArrayRef< CounterExpression > Expressions, ArrayRef< CounterMappingRegion > Regions)
bool isSetter() const
Returns true if this property access or subscript is a setter (has the form of an assignment)...
Definition: CallEvent.h:941
virtual const CXXConstructExpr * getOriginExpr() const
Definition: CallEvent.h:789
const FunctionDecl * getDecl() const override
Returns the declaration of the function or method that will be called.
Definition: CallEvent.h:435
param_type_iterator param_type_begin() const
Returns an iterator over the types of the call&#39;s formal parameters.
Definition: CallEvent.h:406
Represents an ObjC class declaration.
Definition: DeclObjC.h:1191
CXXInstanceCall(const CXXInstanceCall &Other)
Definition: CallEvent.h:612
BlockCall(const CallExpr *CE, ProgramStateRef St, const LocationContext *LCtx)
Definition: CallEvent.h:497
Represents a non-static C++ member function call.
Definition: CallEvent.h:637
RuntimeDefinition getRuntimeDefinition() const override
Definition: CallEvent.h:551
ObjCMessageKind
Represents the ways an Objective-C message send can occur.
Definition: CallEvent.h:861
CXXRecordDecl * getAsCXXRecordDecl() const
Retrieves the CXXRecordDecl that this type refers to, either because the type is a RecordType or beca...
Definition: Type.cpp:1590
Represents a non-static C++ member function call, no matter how it is written.
Definition: CallEvent.h:599
SourceLocation getLocEnd() const LLVM_READONLY
Definition: Stmt.cpp:290
const LocationContext * getLocationContext() const
The context in which the call is being evaluated.
Definition: CallEvent.h:215
CallEventManager(llvm::BumpPtrAllocator &alloc)
Definition: CallEvent.h:1033
BlockDecl - This represents a block literal declaration, which is like an unnamed FunctionDecl...
Definition: Decl.h:3685
Expr - This represents one expression.
Definition: Expr.h:106
const Expr * getArgExpr(unsigned Index) const override
Definition: CallEvent.h:659
unsigned getNumArgs() const override
Definition: CallEvent.h:512
bool isInSystemHeader(SourceLocation Loc) const
Returns if a SourceLocation is in a system header.
const FunctionProtoType * T
unsigned getNumArgs() const override
Definition: CallEvent.h:797
Represents an implicit call to a C++ destructor.
Definition: CallEvent.h:717
Kind getKind() const override
Definition: CallEvent.h:809
Represents a C++ destructor within a class.
Definition: DeclCXX.h:2620
SmallVectorImpl< SVal > ValueList
Definition: CallEvent.h:190
virtual const CXXNewExpr * getOriginExpr() const
Definition: CallEvent.h:831
Represents a call to any sort of function that might have a FunctionDecl.
Definition: CallEvent.h:422
bool isInSystemHeader() const
Returns true if the callee is known to be from a system header.
Definition: CallEvent.h:237
const IdentifierInfo * getCalleeIdentifier() const
Returns the name of the callee, if its name is a simple identifier.
Definition: CallEvent.h:335
Kind getKind() const override
Returns the kind of call this is.
Definition: CallEvent.h:483
virtual const CallExpr * getOriginExpr() const
Definition: CallEvent.h:508
StringRef getFunctionName() const
Get the name of the function that this object matches.
Definition: CallEvent.h:76
virtual const Decl * getDecl() const
Returns the declaration of the function or method that will be called.
Definition: CallEvent.h:205
Kind getKind() const override
Definition: CallEvent.h:667
CallEvent(const Decl *D, ProgramStateRef state, const LocationContext *lctx)
Definition: CallEvent.h:173
An expression that sends a message to the given Objective-C object or class.
Definition: ExprObjC.h:903
BlockCall(const BlockCall &Other)
Definition: CallEvent.h:501
virtual const Expr * getCXXThisExpr() const
Returns the expression representing the implicit &#39;this&#39; object.
Definition: CallEvent.h:616
CallEventRef< ObjCMethodCall > getObjCMethodCall(const ObjCMessageExpr *E, ProgramStateRef State, const LocationContext *LCtx)
Definition: CallEvent.h:1045
Represents a C function or static C++ member function call.
Definition: CallEvent.h:457
const SourceManager & SM
Definition: Format.cpp:1337
const VarRegion * getRegionStoringCapturedLambda() const
For a block converted from a C++ lambda, returns the block VarRegion for the variable holding the cap...
Definition: CallEvent.h:540
CXXMemberOperatorCall(const CXXMemberOperatorCall &Other)
Definition: CallEvent.h:686
unsigned getNumArgs() const override
Definition: CallEvent.h:653
virtual bool argumentsMayEscape() const
Returns true if any of the arguments are known to escape to long- term storage, even if this method w...
Definition: CallEvent.h:306
static bool classof(const CallEvent *CA)
Definition: CallEvent.h:592
const Expr * getArgExpr(unsigned Index) const override
Definition: CallEvent.h:514
virtual SourceRange getSourceRange() const
Returns a source range for the entire call, suitable for outputting in diagnostics.
Definition: CallEvent.h:266
CallDescription(StringRef FuncName, unsigned RequiredArgs=NoArgRequirement)
Constructs a CallDescription object.
Definition: CallEvent.h:71
void cloneTo(void *Dest) const override
Definition: CallEvent.h:502
Defines the runtime definition of the called function.
Definition: CallEvent.h:104
Kind getKind() const override
Definition: CallEvent.h:850
CXXMemberCall(const CXXMemberCallExpr *CE, ProgramStateRef St, const LocationContext *LCtx)
Definition: CallEvent.h:641
#define false
Definition: stdbool.h:33
Kind
PseudoObjectExpr - An expression which accesses a pseudo-object l-value.
Definition: Expr.h:4969
This class represents a description of a function call using the number of arguments and the name of ...
Definition: CallEvent.h:55
CallEventRef< CXXAllocatorCall > getCXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef State, const LocationContext *LCtx)
Definition: CallEvent.h:1064
Encodes a location in the source.
const Expr * getArgExpr(unsigned Index) const override
Definition: CallEvent.h:799
CallEventRef(const T *Call)
Definition: CallEvent.h:82
ProgramPoints can be "tagged" as representing points specific to a given analysis entity...
Definition: ProgramPoint.h:40
Represents a new-expression for memory allocation and constructor calls, e.g: "new CXXNewExpr(foo)"...
Definition: ExprCXX.h:1842
CXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef St, const LocationContext *LCtx)
Definition: CallEvent.h:823
Represents a call to a member function that may be written either with member call syntax (e...
Definition: ExprCXX.h:164
Represents a static or instance method of a struct/union/class.
Definition: DeclCXX.h:1964
const Expr * getArgExpr(unsigned Index) const override
Returns the expression associated with a given argument.
Definition: CallEvent.h:479
bool isConversionFromLambda() const
Definition: Decl.h:3820
SVal - This represents a symbolic expression, which can be either an L-value or an R-value...
Definition: SVals.h:63
Represents one property declaration in an Objective-C interface.
Definition: DeclObjC.h:746
unsigned getNumArgs() const override
Definition: CallEvent.h:839
void cloneTo(void *Dest) const override
Definition: CallEvent.h:646
void cloneTo(void *Dest) const override
Definition: CallEvent.h:883
const Expr * getArgExpr(unsigned Index) const override
Definition: CallEvent.h:843
CXXDestructorCall(const CXXDestructorCall &Other)
Definition: CallEvent.h:738
virtual void getExtraInvalidatedValues(ValueList &Values, RegionAndSymbolInvalidationTraits *ETraits) const
Used to specify non-argument regions that will be invalidated as a result of this call...
Definition: CallEvent.h:194
const MemRegion * getDispatchRegion()
When other definitions are possible, returns the region whose runtime type determines the method defi...
Definition: CallEvent.h:128
const ObjCMethodDecl * getDecl() const override
Definition: CallEvent.h:896
CXXConstructorCall(const CXXConstructExpr *CE, const MemRegion *Target, ProgramStateRef St, const LocationContext *LCtx)
Creates a constructor call.
Definition: CallEvent.h:776
void cloneTo(void *Dest) const override
Definition: CallEvent.h:783
virtual const ObjCMessageExpr * getOriginExpr() const
Definition: CallEvent.h:893
static const unsigned NoArgRequirement
Definition: CallEvent.h:63
Selector getSelector() const
Definition: CallEvent.h:912
Dataflow Directional Tag Classes.
bool isValid() const
Return true if this is a valid SourceLocation object.
CXXMethodDecl * getLambdaCallOperator() const
Retrieve the lambda call operator of the closure type if this is a closure type.
Definition: DeclCXX.cpp:1121
static bool classof(const CallEvent *CA)
Definition: CallEvent.h:628
bool isConversionFromLambda() const
Definition: CallEvent.h:530
SourceRange getSourceRange(const SourceRange &Range)
Returns the SourceRange of a SourceRange.
Definition: FixIt.h:34
static bool classof(const CallEvent *CA)
Definition: CallEvent.h:757
virtual const CXXMemberCallExpr * getOriginExpr() const
Definition: CallEvent.h:649
std::unique_ptr< DiagnosticConsumer > create(StringRef OutputFile, DiagnosticOptions *Diags, bool MergeChildRecords=false)
Returns a DiagnosticConsumer that serializes diagnostics to a bitcode file.
SimpleFunctionCall(const SimpleFunctionCall &Other)
Definition: CallEvent.h:464
Kind getKind() const override
Definition: CallEvent.h:755
RuntimeDefinition(const Decl *InD)
Definition: CallEvent.h:117
bool mayHaveOtherDefinitions()
Check if the definition we have is precise.
Definition: CallEvent.h:124
Represents an abstract call to a function or method along a particular path.
Definition: CallEvent.h:140
CXXMemberCall(const CXXMemberCall &Other)
Definition: CallEvent.h:645
SourceRange getSourceRange() const override
Definition: CallEvent.h:742
bool isInstanceMessage() const
Definition: CallEvent.h:906
CXXInstanceCall(const CallExpr *CE, ProgramStateRef St, const LocationContext *LCtx)
Definition: CallEvent.h:604
CallEventRef cloneWithState(ProgramStateRef NewState) const
Returns a copy of this CallEvent, but using the given state.
Definition: CallEvent.h:366
llvm::PointerIntPair< const MemRegion *, 1, bool > DtorDataTy
Definition: CallEvent.h:721
ObjCMethodFamily getMethodFamily() const
Definition: CallEvent.h:909
const Expr * getArgExpr(unsigned Index) const override
Definition: CallEvent.h:700
unsigned getNumArgs() const override
Definition: CallEvent.h:899
void cloneTo(void *Dest) const override
Definition: CallEvent.h:688
static bool classof(const CallEvent *CE)
Definition: CallEvent.h:852
CallEventRef< CXXConstructorCall > getCXXConstructorCall(const CXXConstructExpr *E, const MemRegion *Target, ProgramStateRef State, const LocationContext *LCtx)
Definition: CallEvent.h:1051
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate.h) and friends (in DeclFriend.h).
const ProgramStateRef & getState() const
The state in which the call is being evaluated.
Definition: CallEvent.h:210
const Expr * getArgExpr(unsigned Index) const override
Definition: CallEvent.h:902
Represents a C++ struct/union/class.
Definition: DeclCXX.h:299
unsigned getNumArgs() const override
Definition: CallEvent.h:697
CallEvent(const Expr *E, ProgramStateRef state, const LocationContext *lctx)
Definition: CallEvent.h:170
CallExpr - Represents a function call (C99 6.5.2.2, C++ [expr.call]).
Definition: Expr.h:2209
static Decl::Kind getKind(const Decl *D)
Definition: DeclBase.cpp:915
AnyFunctionCall(const AnyFunctionCall &Other)
Definition: CallEvent.h:430
std::pair< Loc, SVal > FrameBindingTy
Definition: CallEvent.h:353
AnyFunctionCall(const Expr *E, ProgramStateRef St, const LocationContext *LCtx)
Definition: CallEvent.h:424
QualType getType() const
Definition: Decl.h:638
const void * Data
Definition: CallEvent.h:153
A trivial tuple used to represent a source range.
NamedDecl - This represents a decl with a name.
Definition: Decl.h:245
CXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger, const MemRegion *Target, bool IsBaseDestructor, ProgramStateRef St, const LocationContext *LCtx)
Creates an implicit destructor.
Definition: CallEvent.h:730
Represents a call to a C++ constructor.
Definition: CallEvent.h:765
This class handles loading and caching of source files into memory.
void cloneTo(void *Dest) const override
Copies this CallEvent, with vtable intact, into a new block of memory.
Definition: CallEvent.h:466
SourceLocation getLocation() const
Definition: DeclBase.h:416
CallEventRef(const CallEventRef &Orig)
Definition: CallEvent.h:83
Kind getKind() const override
Definition: CallEvent.h:706
CallEventRef< T > cloneWithState(ProgramStateRef State) const
Definition: CallEvent.h:85
ArrayRef< SVal > ValueList