CallEvent.h revision 00b4f64ecb26b031c1f4888f39be6c706156356a
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_PATHSENSITIVE_CALL 17#define LLVM_CLANG_STATICANALYZER_PATHSENSITIVE_CALL 18 19#include "clang/Basic/SourceManager.h" 20#include "clang/AST/DeclCXX.h" 21#include "clang/AST/ExprCXX.h" 22#include "clang/AST/ExprObjC.h" 23#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h" 24#include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h" 25#include "llvm/ADT/PointerIntPair.h" 26 27namespace clang { 28class ProgramPoint; 29class ProgramPointTag; 30 31namespace ento { 32 33enum CallEventKind { 34 CE_Function, 35 CE_Block, 36 CE_BEG_SIMPLE_CALLS = CE_Function, 37 CE_END_SIMPLE_CALLS = CE_Block, 38 CE_CXXMember, 39 CE_CXXMemberOperator, 40 CE_CXXDestructor, 41 CE_BEG_CXX_INSTANCE_CALLS = CE_CXXMember, 42 CE_END_CXX_INSTANCE_CALLS = CE_CXXDestructor, 43 CE_CXXConstructor, 44 CE_CXXAllocator, 45 CE_BEG_FUNCTION_CALLS = CE_Function, 46 CE_END_FUNCTION_CALLS = CE_CXXAllocator, 47 CE_ObjCMessage 48}; 49 50class CallEvent; 51class CallEventManager; 52 53template<typename T = CallEvent> 54class CallEventRef : public IntrusiveRefCntPtr<const T> { 55public: 56 CallEventRef(const T *Call) : IntrusiveRefCntPtr<const T>(Call) {} 57 CallEventRef(const CallEventRef &Orig) : IntrusiveRefCntPtr<const T>(Orig) {} 58 59 CallEventRef<T> cloneWithState(ProgramStateRef State) const { 60 return this->getPtr()->template cloneWithState<T>(State); 61 } 62 63 // Allow implicit conversions to a superclass type, since CallEventRef 64 // behaves like a pointer-to-const. 65 template <typename SuperT> 66 operator CallEventRef<SuperT> () const { 67 return this->getPtr(); 68 } 69}; 70 71/// \class RuntimeDefinition 72/// \brief Defines the runtime definition of the called function. 73/// 74/// Encapsulates the information we have about which Decl will be used 75/// when the call is executed on the given path. When dealing with dynamic 76/// dispatch, the information is based on DynamicTypeInfo and might not be 77/// precise. 78class RuntimeDefinition { 79 /// The Declaration of the function which could be called at runtime. 80 /// NULL if not available. 81 const Decl *D; 82 83 /// The region representing an object (ObjC/C++) on which the method is 84 /// called. With dynamic dispatch, the method definition depends on the 85 /// runtime type of this object. NULL when the DynamicTypeInfo is 86 /// precise. 87 const MemRegion *R; 88 89public: 90 RuntimeDefinition(): D(0), R(0) {} 91 RuntimeDefinition(const Decl *InD): D(InD), R(0) {} 92 RuntimeDefinition(const Decl *InD, const MemRegion *InR): D(InD), R(InR) {} 93 const Decl *getDecl() { return D; } 94 95 /// \brief Check if the definition we have is precise. 96 /// If not, it is possible that the call dispatches to another definition at 97 /// execution time. 98 bool mayHaveOtherDefinitions() { return R != 0; } 99 100 /// When other definitions are possible, returns the region whose runtime type 101 /// determines the method definition. 102 const MemRegion *getDispatchRegion() { return R; } 103}; 104 105/// \brief Represents an abstract call to a function or method along a 106/// particular path. 107/// 108/// CallEvents are created through the factory methods of CallEventManager. 109/// 110/// CallEvents should always be cheap to create and destroy. In order for 111/// CallEventManager to be able to re-use CallEvent-sized memory blocks, 112/// subclasses of CallEvent may not add any data members to the base class. 113/// Use the "Data" and "Location" fields instead. 114class CallEvent { 115public: 116 typedef CallEventKind Kind; 117 118private: 119 ProgramStateRef State; 120 const LocationContext *LCtx; 121 llvm::PointerUnion<const Expr *, const Decl *> Origin; 122 123 // DO NOT IMPLEMENT 124 CallEvent &operator=(const CallEvent &); 125 126protected: 127 // This is user data for subclasses. 128 const void *Data; 129 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; 134 135private: 136 mutable unsigned RefCount; 137 138 template <typename T> friend struct llvm::IntrusiveRefCntPtrInfo; 139 void Retain() const { ++RefCount; } 140 void Release() const; 141 142protected: 143 friend class CallEventManager; 144 145 CallEvent(const Expr *E, ProgramStateRef state, const LocationContext *lctx) 146 : State(state), LCtx(lctx), Origin(E), RefCount(0) {} 147 148 CallEvent(const Decl *D, ProgramStateRef state, const LocationContext *lctx) 149 : State(state), LCtx(lctx), Origin(D), RefCount(0) {} 150 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) {} 155 156 /// Copies this CallEvent, with vtable intact, into a new block of memory. 157 virtual void cloneTo(void *Dest) const = 0; 158 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()); 162 } 163 164 165 typedef SmallVectorImpl<const MemRegion *> RegionList; 166 167 /// \brief Used to specify non-argument regions that will be invalidated as a 168 /// result of this call. 169 virtual void getExtraInvalidatedRegions(RegionList &Regions) const {} 170 171public: 172 virtual ~CallEvent() {} 173 174 /// \brief Returns the kind of call this is. 175 virtual Kind getKind() const = 0; 176 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 *>(); 181 } 182 183 /// \brief The state in which the call is being evaluated. 184 ProgramStateRef getState() const { 185 return State; 186 } 187 188 /// \brief The context in which the call is being evaluated. 189 const LocationContext *getLocationContext() const { 190 return LCtx; 191 } 192 193 /// \brief Returns the definition of the function or method that will be 194 /// called. 195 virtual RuntimeDefinition getRuntimeDefinition() const = 0; 196 197 /// \brief Returns the expression whose value will be the result of this call. 198 /// May be null. 199 const Expr *getOriginExpr() const { 200 return Origin.dyn_cast<const Expr *>(); 201 } 202 203 /// \brief Returns the number of arguments (explicit and implicit). 204 /// 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 207 /// the source. 208 virtual unsigned getNumArgs() const = 0; 209 210 /// \brief Returns true if the callee is known to be from a system header. 211 bool isInSystemHeader() const { 212 const Decl *D = getDecl(); 213 if (!D) 214 return false; 215 216 SourceLocation Loc = D->getLocation(); 217 if (Loc.isValid()) { 218 const SourceManager &SM = 219 getState()->getStateManager().getContext().getSourceManager(); 220 return SM.isInSystemHeader(D->getLocation()); 221 } 222 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(); 227 228 return false; 229 } 230 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(); 235 } 236 237 /// \brief Returns the value of a given argument at the time of the call. 238 virtual SVal getArgSVal(unsigned Index) const; 239 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; } 243 244 /// \brief Returns the source range for errors associated with this argument. 245 /// 246 /// May be invalid if the argument is not written in the source. 247 virtual SourceRange getArgSourceRange(unsigned Index) const; 248 249 /// \brief Returns the result type, adjusted for references. 250 QualType getResultType() const; 251 252 /// \brief Returns true if any of the arguments appear to represent callbacks. 253 bool hasNonZeroCallbackArg() const; 254 255 /// \brief Returns true if any of the arguments are known to escape to long- 256 /// term storage, even if this method will not modify them. 257 // NOTE: The exact semantics of this are still being defined! 258 // We don't really want a list of hardcoded exceptions in the long run, 259 // but we don't want duplicated lists of known APIs in the short term either. 260 virtual bool argumentsMayEscape() const { 261 return hasNonZeroCallbackArg(); 262 } 263 264 /// \brief Returns an appropriate ProgramPoint for this call. 265 ProgramPoint getProgramPoint(bool IsPreVisit = false, 266 const ProgramPointTag *Tag = 0) const; 267 268 /// \brief Returns a new state with all argument regions invalidated. 269 /// 270 /// This accepts an alternate state in case some processing has already 271 /// occurred. 272 ProgramStateRef invalidateRegions(unsigned BlockCount, 273 ProgramStateRef Orig = 0) const; 274 275 typedef std::pair<Loc, SVal> FrameBindingTy; 276 typedef SmallVectorImpl<FrameBindingTy> BindingsTy; 277 278 /// Populates the given SmallVector with the bindings in the callee's stack 279 /// frame at the start of this call. 280 virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 281 BindingsTy &Bindings) const = 0; 282 283 /// Returns a copy of this CallEvent, but using the given state. 284 template <typename T> 285 CallEventRef<T> cloneWithState(ProgramStateRef NewState) const; 286 287 /// Returns a copy of this CallEvent, but using the given state. 288 CallEventRef<> cloneWithState(ProgramStateRef NewState) const { 289 return cloneWithState<CallEvent>(NewState); 290 } 291 292 /// \brief Returns true if this is a statement is a function or method call 293 /// of some kind. 294 static bool isCallStmt(const Stmt *S); 295 296 // Iterator access to formal parameters and their types. 297private: 298 typedef std::const_mem_fun_t<QualType, ParmVarDecl> get_type_fun; 299 300public: 301 typedef const ParmVarDecl * const *param_iterator; 302 303 /// Returns an iterator over the call's formal parameters. 304 /// 305 /// If UseDefinitionParams is set, this will return the parameter decls 306 /// used in the callee's definition (suitable for inlining). Most of the 307 /// time it is better to use the decl found by name lookup, which likely 308 /// carries more annotations. 309 /// 310 /// Remember that the number of formal parameters may not match the number 311 /// of arguments for all calls. However, the first parameter will always 312 /// correspond with the argument value returned by \c getArgSVal(0). 313 /// 314 /// If the call has no accessible declaration (or definition, if 315 /// \p UseDefinitionParams is set), \c param_begin() will be equal to 316 /// \c param_end(). 317 virtual param_iterator param_begin() const =0; 318 /// \sa param_begin() 319 virtual param_iterator param_end() const = 0; 320 321 typedef llvm::mapped_iterator<param_iterator, get_type_fun> 322 param_type_iterator; 323 324 /// Returns an iterator over the types of the call's formal parameters. 325 /// 326 /// This uses the callee decl found by default name lookup rather than the 327 /// definition because it represents a public interface, and probably has 328 /// more annotations. 329 param_type_iterator param_type_begin() const { 330 return llvm::map_iterator(param_begin(), 331 get_type_fun(&ParmVarDecl::getType)); 332 } 333 /// \sa param_type_begin() 334 param_type_iterator param_type_end() const { 335 return llvm::map_iterator(param_end(), get_type_fun(&ParmVarDecl::getType)); 336 } 337 338 // For debugging purposes only 339 void dump(raw_ostream &Out) const; 340 LLVM_ATTRIBUTE_USED void dump() const; 341 342 static bool classof(const CallEvent *) { return true; } 343}; 344 345 346/// \brief Represents a call to any sort of function that might have a 347/// FunctionDecl. 348class AnyFunctionCall : public CallEvent { 349protected: 350 AnyFunctionCall(const Expr *E, ProgramStateRef St, 351 const LocationContext *LCtx) 352 : CallEvent(E, St, LCtx) {} 353 AnyFunctionCall(const Decl *D, ProgramStateRef St, 354 const LocationContext *LCtx) 355 : CallEvent(D, St, LCtx) {} 356 AnyFunctionCall(const AnyFunctionCall &Other) : CallEvent(Other) {} 357 358public: 359 // This function is overridden by subclasses, but they must return 360 // a FunctionDecl. 361 virtual const FunctionDecl *getDecl() const { 362 return cast<FunctionDecl>(CallEvent::getDecl()); 363 } 364 365 virtual RuntimeDefinition getRuntimeDefinition() const { 366 const FunctionDecl *FD = getDecl(); 367 // Note that hasBody() will fill FD with the definition FunctionDecl. 368 if (FD && FD->hasBody(FD)) 369 return RuntimeDefinition(FD); 370 return RuntimeDefinition(); 371 } 372 373 virtual bool argumentsMayEscape() const; 374 375 virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 376 BindingsTy &Bindings) const; 377 378 virtual param_iterator param_begin() const; 379 virtual param_iterator param_end() const; 380 381 static bool classof(const CallEvent *CA) { 382 return CA->getKind() >= CE_BEG_FUNCTION_CALLS && 383 CA->getKind() <= CE_END_FUNCTION_CALLS; 384 } 385}; 386 387/// \brief Represents a call to a non-C++ function, written as a CallExpr. 388class SimpleCall : public AnyFunctionCall { 389protected: 390 SimpleCall(const CallExpr *CE, ProgramStateRef St, 391 const LocationContext *LCtx) 392 : AnyFunctionCall(CE, St, LCtx) {} 393 SimpleCall(const SimpleCall &Other) : AnyFunctionCall(Other) {} 394 395public: 396 virtual const CallExpr *getOriginExpr() const { 397 return cast<CallExpr>(AnyFunctionCall::getOriginExpr()); 398 } 399 400 virtual const FunctionDecl *getDecl() const; 401 402 virtual unsigned getNumArgs() const { return getOriginExpr()->getNumArgs(); } 403 404 virtual const Expr *getArgExpr(unsigned Index) const { 405 return getOriginExpr()->getArg(Index); 406 } 407 408 static bool classof(const CallEvent *CA) { 409 return CA->getKind() >= CE_BEG_SIMPLE_CALLS && 410 CA->getKind() <= CE_END_SIMPLE_CALLS; 411 } 412}; 413 414/// \brief Represents a C function or static C++ member function call. 415/// 416/// Example: \c fun() 417class FunctionCall : public SimpleCall { 418 friend class CallEventManager; 419 420protected: 421 FunctionCall(const CallExpr *CE, ProgramStateRef St, 422 const LocationContext *LCtx) 423 : SimpleCall(CE, St, LCtx) {} 424 425 FunctionCall(const FunctionCall &Other) : SimpleCall(Other) {} 426 virtual void cloneTo(void *Dest) const { new (Dest) FunctionCall(*this); } 427 428public: 429 virtual Kind getKind() const { return CE_Function; } 430 431 static bool classof(const CallEvent *CA) { 432 return CA->getKind() == CE_Function; 433 } 434}; 435 436/// \brief Represents a call to a block. 437/// 438/// Example: <tt>^{ /* ... */ }()</tt> 439class BlockCall : public SimpleCall { 440 friend class CallEventManager; 441 442protected: 443 BlockCall(const CallExpr *CE, ProgramStateRef St, 444 const LocationContext *LCtx) 445 : SimpleCall(CE, St, LCtx) {} 446 447 BlockCall(const BlockCall &Other) : SimpleCall(Other) {} 448 virtual void cloneTo(void *Dest) const { new (Dest) BlockCall(*this); } 449 450 virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 451 452public: 453 /// \brief Returns the region associated with this instance of the block. 454 /// 455 /// This may be NULL if the block's origin is unknown. 456 const BlockDataRegion *getBlockRegion() const; 457 458 /// \brief Gets the declaration of the block. 459 /// 460 /// This is not an override of getDecl() because AnyFunctionCall has already 461 /// assumed that it's a FunctionDecl. 462 const BlockDecl *getBlockDecl() const { 463 const BlockDataRegion *BR = getBlockRegion(); 464 if (!BR) 465 return 0; 466 return BR->getDecl(); 467 } 468 469 virtual RuntimeDefinition getRuntimeDefinition() const { 470 return RuntimeDefinition(getBlockDecl()); 471 } 472 473 virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 474 BindingsTy &Bindings) const; 475 476 virtual param_iterator param_begin() const; 477 virtual param_iterator param_end() const; 478 479 virtual Kind getKind() const { return CE_Block; } 480 481 static bool classof(const CallEvent *CA) { 482 return CA->getKind() == CE_Block; 483 } 484}; 485 486/// \brief Represents a non-static C++ member function call, no matter how 487/// it is written. 488class CXXInstanceCall : public AnyFunctionCall { 489protected: 490 virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 491 492 CXXInstanceCall(const CallExpr *CE, ProgramStateRef St, 493 const LocationContext *LCtx) 494 : AnyFunctionCall(CE, St, LCtx) {} 495 CXXInstanceCall(const FunctionDecl *D, ProgramStateRef St, 496 const LocationContext *LCtx) 497 : AnyFunctionCall(D, St, LCtx) {} 498 499 500 CXXInstanceCall(const CXXInstanceCall &Other) : AnyFunctionCall(Other) {} 501 502public: 503 /// \brief Returns the expression representing the implicit 'this' object. 504 virtual const Expr *getCXXThisExpr() const { return 0; } 505 506 /// \brief Returns the value of the implicit 'this' object. 507 virtual SVal getCXXThisVal() const; 508 509 virtual const FunctionDecl *getDecl() const; 510 511 virtual RuntimeDefinition getRuntimeDefinition() const; 512 513 virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 514 BindingsTy &Bindings) const; 515 516 static bool classof(const CallEvent *CA) { 517 return CA->getKind() >= CE_BEG_CXX_INSTANCE_CALLS && 518 CA->getKind() <= CE_END_CXX_INSTANCE_CALLS; 519 } 520}; 521 522/// \brief Represents a non-static C++ member function call. 523/// 524/// Example: \c obj.fun() 525class CXXMemberCall : public CXXInstanceCall { 526 friend class CallEventManager; 527 528protected: 529 CXXMemberCall(const CXXMemberCallExpr *CE, ProgramStateRef St, 530 const LocationContext *LCtx) 531 : CXXInstanceCall(CE, St, LCtx) {} 532 533 CXXMemberCall(const CXXMemberCall &Other) : CXXInstanceCall(Other) {} 534 virtual void cloneTo(void *Dest) const { new (Dest) CXXMemberCall(*this); } 535 536public: 537 virtual const CXXMemberCallExpr *getOriginExpr() const { 538 return cast<CXXMemberCallExpr>(CXXInstanceCall::getOriginExpr()); 539 } 540 541 virtual unsigned getNumArgs() const { 542 if (const CallExpr *CE = getOriginExpr()) 543 return CE->getNumArgs(); 544 return 0; 545 } 546 547 virtual const Expr *getArgExpr(unsigned Index) const { 548 return getOriginExpr()->getArg(Index); 549 } 550 551 virtual const Expr *getCXXThisExpr() const; 552 553 virtual RuntimeDefinition getRuntimeDefinition() const; 554 555 virtual Kind getKind() const { return CE_CXXMember; } 556 557 static bool classof(const CallEvent *CA) { 558 return CA->getKind() == CE_CXXMember; 559 } 560}; 561 562/// \brief Represents a C++ overloaded operator call where the operator is 563/// implemented as a non-static member function. 564/// 565/// Example: <tt>iter + 1</tt> 566class CXXMemberOperatorCall : public CXXInstanceCall { 567 friend class CallEventManager; 568 569protected: 570 CXXMemberOperatorCall(const CXXOperatorCallExpr *CE, ProgramStateRef St, 571 const LocationContext *LCtx) 572 : CXXInstanceCall(CE, St, LCtx) {} 573 574 CXXMemberOperatorCall(const CXXMemberOperatorCall &Other) 575 : CXXInstanceCall(Other) {} 576 virtual void cloneTo(void *Dest) const { 577 new (Dest) CXXMemberOperatorCall(*this); 578 } 579 580public: 581 virtual const CXXOperatorCallExpr *getOriginExpr() const { 582 return cast<CXXOperatorCallExpr>(CXXInstanceCall::getOriginExpr()); 583 } 584 585 virtual unsigned getNumArgs() const { 586 return getOriginExpr()->getNumArgs() - 1; 587 } 588 virtual const Expr *getArgExpr(unsigned Index) const { 589 return getOriginExpr()->getArg(Index + 1); 590 } 591 592 virtual const Expr *getCXXThisExpr() const; 593 594 virtual Kind getKind() const { return CE_CXXMemberOperator; } 595 596 static bool classof(const CallEvent *CA) { 597 return CA->getKind() == CE_CXXMemberOperator; 598 } 599}; 600 601/// \brief Represents an implicit call to a C++ destructor. 602/// 603/// This can occur at the end of a scope (for automatic objects), at the end 604/// of a full-expression (for temporaries), or as part of a delete. 605class CXXDestructorCall : public CXXInstanceCall { 606 friend class CallEventManager; 607 608protected: 609 typedef llvm::PointerIntPair<const MemRegion *, 1, bool> DtorDataTy; 610 611 /// Creates an implicit destructor. 612 /// 613 /// \param DD The destructor that will be called. 614 /// \param Trigger The statement whose completion causes this destructor call. 615 /// \param Target The object region to be destructed. 616 /// \param St The path-sensitive state at this point in the program. 617 /// \param LCtx The location context at this point in the program. 618 CXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger, 619 const MemRegion *Target, bool IsBaseDestructor, 620 ProgramStateRef St, const LocationContext *LCtx) 621 : CXXInstanceCall(DD, St, LCtx) { 622 Data = DtorDataTy(Target, IsBaseDestructor).getOpaqueValue(); 623 Location = Trigger->getLocEnd(); 624 } 625 626 CXXDestructorCall(const CXXDestructorCall &Other) : CXXInstanceCall(Other) {} 627 virtual void cloneTo(void *Dest) const { new (Dest) CXXDestructorCall(*this); } 628 629public: 630 virtual SourceRange getSourceRange() const { return Location; } 631 virtual unsigned getNumArgs() const { return 0; } 632 633 virtual RuntimeDefinition getRuntimeDefinition() const; 634 635 /// \brief Returns the value of the implicit 'this' object. 636 virtual SVal getCXXThisVal() const; 637 638 /// Returns true if this is a call to a base class destructor. 639 bool isBaseDestructor() const { 640 return DtorDataTy::getFromOpaqueValue(Data).getInt(); 641 } 642 643 virtual Kind getKind() const { return CE_CXXDestructor; } 644 645 static bool classof(const CallEvent *CA) { 646 return CA->getKind() == CE_CXXDestructor; 647 } 648}; 649 650/// \brief Represents a call to a C++ constructor. 651/// 652/// Example: \c T(1) 653class CXXConstructorCall : public AnyFunctionCall { 654 friend class CallEventManager; 655 656protected: 657 /// Creates a constructor call. 658 /// 659 /// \param CE The constructor expression as written in the source. 660 /// \param Target The region where the object should be constructed. If NULL, 661 /// a new symbolic region will be used. 662 /// \param St The path-sensitive state at this point in the program. 663 /// \param LCtx The location context at this point in the program. 664 CXXConstructorCall(const CXXConstructExpr *CE, const MemRegion *Target, 665 ProgramStateRef St, const LocationContext *LCtx) 666 : AnyFunctionCall(CE, St, LCtx) { 667 Data = Target; 668 } 669 670 CXXConstructorCall(const CXXConstructorCall &Other) : AnyFunctionCall(Other){} 671 virtual void cloneTo(void *Dest) const { new (Dest) CXXConstructorCall(*this); } 672 673 virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 674 675public: 676 virtual const CXXConstructExpr *getOriginExpr() const { 677 return cast<CXXConstructExpr>(AnyFunctionCall::getOriginExpr()); 678 } 679 680 virtual const CXXConstructorDecl *getDecl() const { 681 return getOriginExpr()->getConstructor(); 682 } 683 684 virtual unsigned getNumArgs() const { return getOriginExpr()->getNumArgs(); } 685 686 virtual const Expr *getArgExpr(unsigned Index) const { 687 return getOriginExpr()->getArg(Index); 688 } 689 690 /// \brief Returns the value of the implicit 'this' object. 691 SVal getCXXThisVal() const; 692 693 virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 694 BindingsTy &Bindings) const; 695 696 virtual Kind getKind() const { return CE_CXXConstructor; } 697 698 static bool classof(const CallEvent *CA) { 699 return CA->getKind() == CE_CXXConstructor; 700 } 701}; 702 703/// \brief Represents the memory allocation call in a C++ new-expression. 704/// 705/// This is a call to "operator new". 706class CXXAllocatorCall : public AnyFunctionCall { 707 friend class CallEventManager; 708 709protected: 710 CXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef St, 711 const LocationContext *LCtx) 712 : AnyFunctionCall(E, St, LCtx) {} 713 714 CXXAllocatorCall(const CXXAllocatorCall &Other) : AnyFunctionCall(Other) {} 715 virtual void cloneTo(void *Dest) const { new (Dest) CXXAllocatorCall(*this); } 716 717public: 718 virtual const CXXNewExpr *getOriginExpr() const { 719 return cast<CXXNewExpr>(AnyFunctionCall::getOriginExpr()); 720 } 721 722 virtual const FunctionDecl *getDecl() const { 723 return getOriginExpr()->getOperatorNew(); 724 } 725 726 virtual unsigned getNumArgs() const { 727 return getOriginExpr()->getNumPlacementArgs() + 1; 728 } 729 730 virtual const Expr *getArgExpr(unsigned Index) const { 731 // The first argument of an allocator call is the size of the allocation. 732 if (Index == 0) 733 return 0; 734 return getOriginExpr()->getPlacementArg(Index - 1); 735 } 736 737 virtual Kind getKind() const { return CE_CXXAllocator; } 738 739 static bool classof(const CallEvent *CE) { 740 return CE->getKind() == CE_CXXAllocator; 741 } 742}; 743 744/// \brief Represents the ways an Objective-C message send can occur. 745// 746// Note to maintainers: OCM_Message should always be last, since it does not 747// need to fit in the Data field's low bits. 748enum ObjCMessageKind { 749 OCM_PropertyAccess, 750 OCM_Subscript, 751 OCM_Message 752}; 753 754/// \brief Represents any expression that calls an Objective-C method. 755/// 756/// This includes all of the kinds listed in ObjCMessageKind. 757class ObjCMethodCall : public CallEvent { 758 friend class CallEventManager; 759 760 const PseudoObjectExpr *getContainingPseudoObjectExpr() const; 761 762protected: 763 ObjCMethodCall(const ObjCMessageExpr *Msg, ProgramStateRef St, 764 const LocationContext *LCtx) 765 : CallEvent(Msg, St, LCtx) { 766 Data = 0; 767 } 768 769 ObjCMethodCall(const ObjCMethodCall &Other) : CallEvent(Other) {} 770 virtual void cloneTo(void *Dest) const { new (Dest) ObjCMethodCall(*this); } 771 772 virtual void getExtraInvalidatedRegions(RegionList &Regions) const; 773 774 /// Check if the selector may have multiple definitions (may have overrides). 775 virtual bool canBeOverridenInSubclass(ObjCInterfaceDecl *IDecl, 776 Selector Sel) const; 777 778public: 779 virtual const ObjCMessageExpr *getOriginExpr() const { 780 return cast<ObjCMessageExpr>(CallEvent::getOriginExpr()); 781 } 782 virtual const ObjCMethodDecl *getDecl() const { 783 return getOriginExpr()->getMethodDecl(); 784 } 785 virtual unsigned getNumArgs() const { 786 return getOriginExpr()->getNumArgs(); 787 } 788 virtual const Expr *getArgExpr(unsigned Index) const { 789 return getOriginExpr()->getArg(Index); 790 } 791 792 bool isInstanceMessage() const { 793 return getOriginExpr()->isInstanceMessage(); 794 } 795 ObjCMethodFamily getMethodFamily() const { 796 return getOriginExpr()->getMethodFamily(); 797 } 798 Selector getSelector() const { 799 return getOriginExpr()->getSelector(); 800 } 801 802 virtual SourceRange getSourceRange() const; 803 804 /// \brief Returns the value of the receiver at the time of this call. 805 SVal getReceiverSVal() const; 806 807 /// \brief Return the value of 'self' if available. 808 SVal getSelfSVal() const; 809 810 /// \brief Get the interface for the receiver. 811 /// 812 /// This works whether this is an instance message or a class message. 813 /// However, it currently just uses the static type of the receiver. 814 const ObjCInterfaceDecl *getReceiverInterface() const { 815 return getOriginExpr()->getReceiverInterface(); 816 } 817 818 /// \brief Checks if the receiver refers to 'self' or 'super'. 819 bool isReceiverSelfOrSuper() const; 820 821 /// Returns how the message was written in the source (property access, 822 /// subscript, or explicit message send). 823 ObjCMessageKind getMessageKind() const; 824 825 /// Returns true if this property access or subscript is a setter (has the 826 /// form of an assignment). 827 bool isSetter() const { 828 switch (getMessageKind()) { 829 case OCM_Message: 830 llvm_unreachable("This is not a pseudo-object access!"); 831 case OCM_PropertyAccess: 832 return getNumArgs() > 0; 833 case OCM_Subscript: 834 return getNumArgs() > 1; 835 } 836 llvm_unreachable("Unknown message kind"); 837 } 838 839 virtual RuntimeDefinition getRuntimeDefinition() const; 840 841 virtual void getInitialStackFrameContents(const StackFrameContext *CalleeCtx, 842 BindingsTy &Bindings) const; 843 844 virtual param_iterator param_begin() const; 845 virtual param_iterator param_end() const; 846 847 virtual Kind getKind() const { return CE_ObjCMessage; } 848 849 static bool classof(const CallEvent *CA) { 850 return CA->getKind() == CE_ObjCMessage; 851 } 852}; 853 854 855/// \brief Manages the lifetime of CallEvent objects. 856/// 857/// CallEventManager provides a way to create arbitrary CallEvents "on the 858/// stack" as if they were value objects by keeping a cache of CallEvent-sized 859/// memory blocks. The CallEvents created by CallEventManager are only valid 860/// for the lifetime of the OwnedCallEvent that holds them; right now these 861/// objects cannot be copied and ownership cannot be transferred. 862class CallEventManager { 863 friend class CallEvent; 864 865 llvm::BumpPtrAllocator &Alloc; 866 SmallVector<void *, 8> Cache; 867 868 void reclaim(const void *Memory) { 869 Cache.push_back(const_cast<void *>(Memory)); 870 } 871 872 /// Returns memory that can be initialized as a CallEvent. 873 void *allocate() { 874 if (Cache.empty()) 875 return Alloc.Allocate<FunctionCall>(); 876 else 877 return Cache.pop_back_val(); 878 } 879 880 template <typename T, typename Arg> 881 T *create(Arg A, ProgramStateRef St, const LocationContext *LCtx) { 882 return new (allocate()) T(A, St, LCtx); 883 } 884 885 template <typename T, typename Arg1, typename Arg2> 886 T *create(Arg1 A1, Arg2 A2, ProgramStateRef St, const LocationContext *LCtx) { 887 return new (allocate()) T(A1, A2, St, LCtx); 888 } 889 890 template <typename T, typename Arg1, typename Arg2, typename Arg3> 891 T *create(Arg1 A1, Arg2 A2, Arg3 A3, ProgramStateRef St, 892 const LocationContext *LCtx) { 893 return new (allocate()) T(A1, A2, A3, St, LCtx); 894 } 895 896 template <typename T, typename Arg1, typename Arg2, typename Arg3, 897 typename Arg4> 898 T *create(Arg1 A1, Arg2 A2, Arg3 A3, Arg4 A4, ProgramStateRef St, 899 const LocationContext *LCtx) { 900 return new (allocate()) T(A1, A2, A3, A4, St, LCtx); 901 } 902 903public: 904 CallEventManager(llvm::BumpPtrAllocator &alloc) : Alloc(alloc) {} 905 906 907 CallEventRef<> 908 getCaller(const StackFrameContext *CalleeCtx, ProgramStateRef State); 909 910 911 CallEventRef<> 912 getSimpleCall(const CallExpr *E, ProgramStateRef State, 913 const LocationContext *LCtx); 914 915 CallEventRef<ObjCMethodCall> 916 getObjCMethodCall(const ObjCMessageExpr *E, ProgramStateRef State, 917 const LocationContext *LCtx) { 918 return create<ObjCMethodCall>(E, State, LCtx); 919 } 920 921 CallEventRef<CXXConstructorCall> 922 getCXXConstructorCall(const CXXConstructExpr *E, const MemRegion *Target, 923 ProgramStateRef State, const LocationContext *LCtx) { 924 return create<CXXConstructorCall>(E, Target, State, LCtx); 925 } 926 927 CallEventRef<CXXDestructorCall> 928 getCXXDestructorCall(const CXXDestructorDecl *DD, const Stmt *Trigger, 929 const MemRegion *Target, bool IsBase, 930 ProgramStateRef State, const LocationContext *LCtx) { 931 return create<CXXDestructorCall>(DD, Trigger, Target, IsBase, State, LCtx); 932 } 933 934 CallEventRef<CXXAllocatorCall> 935 getCXXAllocatorCall(const CXXNewExpr *E, ProgramStateRef State, 936 const LocationContext *LCtx) { 937 return create<CXXAllocatorCall>(E, State, LCtx); 938 } 939}; 940 941 942template <typename T> 943CallEventRef<T> CallEvent::cloneWithState(ProgramStateRef NewState) const { 944 assert(isa<T>(*this) && "Cloning to unrelated type"); 945 assert(sizeof(T) == sizeof(CallEvent) && "Subclasses may not add fields"); 946 947 if (NewState == State) 948 return cast<T>(this); 949 950 CallEventManager &Mgr = State->getStateManager().getCallEventManager(); 951 T *Copy = static_cast<T *>(Mgr.allocate()); 952 cloneTo(Copy); 953 assert(Copy->getKind() == this->getKind() && "Bad copy"); 954 955 Copy->State = NewState; 956 return Copy; 957} 958 959inline void CallEvent::Release() const { 960 assert(RefCount > 0 && "Reference count is already zero."); 961 --RefCount; 962 963 if (RefCount > 0) 964 return; 965 966 CallEventManager &Mgr = State->getStateManager().getCallEventManager(); 967 Mgr.reclaim(this); 968 969 this->~CallEvent(); 970} 971 972} // end namespace ento 973} // end namespace clang 974 975namespace llvm { 976 // Support isa<>, cast<>, and dyn_cast<> for CallEventRef. 977 template<class T> struct simplify_type< clang::ento::CallEventRef<T> > { 978 typedef const T *SimpleType; 979 980 static SimpleType 981 getSimplifiedValue(const clang::ento::CallEventRef<T>& Val) { 982 return Val.getPtr(); 983 } 984 }; 985} 986 987#endif 988