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