include/llvm/IR/CallSite.h

   1 //===- CallSite.h - Abstract Call & Invoke instrs ---------------*- 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 // This file defines the CallSite class, which is a handy wrapper for code that
  11 // wants to treat Call and Invoke instructions in a generic way. When in non-
  12 // mutation context (e.g. an analysis) ImmutableCallSite should be used.
  13 // Finally, when some degree of customization is necessary between these two
  14 // extremes, CallSiteBase<> can be supplied with fine-tuned parameters.
  15 //
  16 // NOTE: These classes are supposed to have "value semantics". So they should be
  17 // passed by value, not by reference; they should not be "new"ed or "delete"d.
  18 // They are efficiently copyable, assignable and constructable, with cost
  19 // equivalent to copying a pointer (notice that they have only a single data
  20 // member). The internal representation carries a flag which indicates which of
  21 // the two variants is enclosed. This allows for cheaper checks when various
  22 // accessors of CallSite are employed.
  23 //
  24 //===----------------------------------------------------------------------===//
  25
  26 #ifndef LLVM_IR_CALLSITE_H
  27 #define LLVM_IR_CALLSITE_H
  28
  29 #include "llvm/ADT/PointerIntPair.h"
  30 #include "llvm/ADT/iterator_range.h"
  31 #include "llvm/IR/Attributes.h"
  32 #include "llvm/IR/CallingConv.h"
  33 #include "llvm/IR/Instructions.h"
  34
  35 namespace llvm {
  36
  37 class CallInst;
  38 class InvokeInst;
  39
  40 template <typename FunTy = const Function,
  41           typename BBTy = const BasicBlock,
  42           typename ValTy = const Value,
  43           typename UserTy = const User,
  44           typename UseTy = const Use,
  45           typename InstrTy = const Instruction,
  46           typename CallTy = const CallInst,
  47           typename InvokeTy = const InvokeInst,
  48           typename IterTy = User::const_op_iterator>
  49 class CallSiteBase {
  50 protected:
  51   PointerIntPair<InstrTy*, 1, bool> I;
  52
  53   CallSiteBase() : I(nullptr, false) {}
  54   CallSiteBase(CallTy *CI) : I(CI, true) { assert(CI); }
  55   CallSiteBase(InvokeTy *II) : I(II, false) { assert(II); }
  56   explicit CallSiteBase(ValTy *II) { *this = get(II); }
  57
  58 private:
  59   /// CallSiteBase::get - This static method is sort of like a constructor.  It
  60   /// will create an appropriate call site for a Call or Invoke instruction, but
  61   /// it can also create a null initialized CallSiteBase object for something
  62   /// which is NOT a call site.
  63   ///
  64   static CallSiteBase get(ValTy *V) {
  65     if (InstrTy *II = dyn_cast<InstrTy>(V)) {
  66       if (II->getOpcode() == Instruction::Call)
  67         return CallSiteBase(static_cast<CallTy*>(II));
  68       else if (II->getOpcode() == Instruction::Invoke)
  69         return CallSiteBase(static_cast<InvokeTy*>(II));
  70     }
  71     return CallSiteBase();
  72   }
  73
  74 public:
  75   /// isCall - true if a CallInst is enclosed.
  76   /// Note that !isCall() does not mean it is an InvokeInst enclosed,
  77   /// it also could signify a NULL Instruction pointer.
  78   bool isCall() const { return I.getInt(); }
  79
  80   /// isInvoke - true if a InvokeInst is enclosed.
  81   ///
  82   bool isInvoke() const { return getInstruction() && !I.getInt(); }
  83
  84   InstrTy *getInstruction() const { return I.getPointer(); }
  85   InstrTy *operator->() const { return I.getPointer(); }
  86   explicit operator bool() const { return I.getPointer(); }
  87
  88   /// Get the basic block containing the call site
  89   BBTy* getParent() const { return getInstruction()->getParent(); }
  90
  91   /// getCalledValue - Return the pointer to function that is being called.
  92   ///
  93   ValTy *getCalledValue() const {
  94     assert(getInstruction() && "Not a call or invoke instruction!");
  95     return *getCallee();
  96   }
  97
  98   /// getCalledFunction - Return the function being called if this is a direct
  99   /// call, otherwise return null (if it's an indirect call).
 100   ///
 101   FunTy *getCalledFunction() const {
 102     return dyn_cast<FunTy>(getCalledValue());
 103   }
 104
 105   /// setCalledFunction - Set the callee to the specified value.
 106   ///
 107   void setCalledFunction(Value *V) {
 108     assert(getInstruction() && "Not a call or invoke instruction!");
 109     *getCallee() = V;
 110   }
 111
 112   /// isCallee - Determine whether the passed iterator points to the
 113   /// callee operand's Use.
 114   bool isCallee(Value::const_user_iterator UI) const {
 115     return isCallee(&UI.getUse());
 116   }
 117
 118   /// Determine whether this Use is the callee operand's Use.
 119   bool isCallee(const Use *U) const { return getCallee() == U; }
 120
 121   /// \brief Determine whether the passed iterator points to an argument
 122   /// operand.
 123   bool isArgOperand(Value::const_user_iterator UI) const {
 124     return isArgOperand(&UI.getUse());
 125   }
 126
 127   /// \brief Determine whether the passed use points to an argument operand.
 128   bool isArgOperand(const Use *U) const {
 129     return arg_begin() <= U && U < arg_end();
 130   }
 131
 132   /// \brief Determine whether the passed iterator points to a bundle operand.
 133   bool isBundleOperand(Value::const_user_iterator UI) const {
 134     return isBundleOperand(&UI.getUse());
 135   }
 136
 137   /// \brief Determine whether the passed use points to a bundle operand.
 138   bool isBundleOperand(const Use *U) const {
 139     if (!hasOperandBundles())
 140       return false;
 141     unsigned OperandNo = U->getOperandNo();
 142     return getBundleOperandsStartIndex() <= OperandNo &&
 143            OperandNo < getBundleOperandsEndIndex();
 144   }
 145
 146   ValTy *getArgument(unsigned ArgNo) const {
 147     assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
 148     return *(arg_begin() + ArgNo);
 149   }
 150
 151   void setArgument(unsigned ArgNo, Value* newVal) {
 152     assert(getInstruction() && "Not a call or invoke instruction!");
 153     assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
 154     getInstruction()->setOperand(ArgNo, newVal);
 155   }
 156
 157   /// Given a value use iterator, returns the argument that corresponds to it.
 158   /// Iterator must actually correspond to an argument.
 159   unsigned getArgumentNo(Value::const_user_iterator I) const {
 160     return getArgumentNo(&I.getUse());
 161   }
 162
 163   /// Given a use for an argument, get the argument number that corresponds to
 164   /// it.
 165   unsigned getArgumentNo(const Use *U) const {
 166     assert(getInstruction() && "Not a call or invoke instruction!");
 167     assert(isArgOperand(U) && "Argument # out of range!");
 168     return U - arg_begin();
 169   }
 170
 171   /// arg_iterator - The type of iterator to use when looping over actual
 172   /// arguments at this call site.
 173   typedef IterTy arg_iterator;
 174
 175   iterator_range<IterTy> args() const {
 176     return make_range(arg_begin(), arg_end());
 177   }
 178   bool arg_empty() const { return arg_end() == arg_begin(); }
 179   unsigned arg_size() const { return unsigned(arg_end() - arg_begin()); }
 180
 181   /// Type of iterator to use when looping over data operands at this call site
 182   /// (see below).
 183   typedef IterTy data_operand_iterator;
 184
 185   /// data_operands_begin/data_operands_end - Return iterators iterating over
 186   /// the call / invoke argument list and bundle operands.  For invokes, this is
 187   /// the set of instruction operands except the invoke target and the two
 188   /// successor blocks; and for calls this is the set of instruction operands
 189   /// except the call target.
 190
 191   IterTy data_operands_begin() const {
 192     assert(getInstruction() && "Not a call or invoke instruction!");
 193     return (*this)->op_begin();
 194   }
 195   IterTy data_operands_end() const {
 196     assert(getInstruction() && "Not a call or invoke instruction!");
 197     return (*this)->op_end() - (isCall() ? 1 : 3);
 198   }
 199   iterator_range<IterTy> data_ops() const {
 200     return make_range(data_operands_begin(), data_operands_end());
 201   }
 202   bool data_operands_empty() const {
 203     return data_operands_end() == data_operands_begin();
 204   }
 205   unsigned data_operands_size() const {
 206     return std::distance(data_operands_begin(), data_operands_end());
 207   }
 208
 209   /// getType - Return the type of the instruction that generated this call site
 210   ///
 211   Type *getType() const { return (*this)->getType(); }
 212
 213   /// getCaller - Return the caller function for this call site
 214   ///
 215   FunTy *getCaller() const { return (*this)->getParent()->getParent(); }
 216
 217   /// \brief Tests if this call site must be tail call optimized.  Only a
 218   /// CallInst can be tail call optimized.
 219   bool isMustTailCall() const {
 220     return isCall() && cast<CallInst>(getInstruction())->isMustTailCall();
 221   }
 222
 223   /// \brief Tests if this call site is marked as a tail call.
 224   bool isTailCall() const {
 225     return isCall() && cast<CallInst>(getInstruction())->isTailCall();
 226   }
 227
 228 #define CALLSITE_DELEGATE_GETTER(METHOD) \
 229   InstrTy *II = getInstruction();    \
 230   return isCall()                        \
 231     ? cast<CallInst>(II)->METHOD         \
 232     : cast<InvokeInst>(II)->METHOD
 233
 234 #define CALLSITE_DELEGATE_SETTER(METHOD) \
 235   InstrTy *II = getInstruction();    \
 236   if (isCall())                          \
 237     cast<CallInst>(II)->METHOD;          \
 238   else                                   \
 239     cast<InvokeInst>(II)->METHOD
 240
 241   unsigned getNumArgOperands() const {
 242     CALLSITE_DELEGATE_GETTER(getNumArgOperands());
 243   }
 244
 245   ValTy *getArgOperand(unsigned i) const {
 246     CALLSITE_DELEGATE_GETTER(getArgOperand(i));
 247   }
 248
 249   bool isInlineAsm() const {
 250     if (isCall())
 251       return cast<CallInst>(getInstruction())->isInlineAsm();
 252     return false;
 253   }
 254
 255   /// getCallingConv/setCallingConv - get or set the calling convention of the
 256   /// call.
 257   CallingConv::ID getCallingConv() const {
 258     CALLSITE_DELEGATE_GETTER(getCallingConv());
 259   }
 260   void setCallingConv(CallingConv::ID CC) {
 261     CALLSITE_DELEGATE_SETTER(setCallingConv(CC));
 262   }
 263
 264   FunctionType *getFunctionType() const {
 265     CALLSITE_DELEGATE_GETTER(getFunctionType());
 266   }
 267
 268   void mutateFunctionType(FunctionType *Ty) const {
 269     CALLSITE_DELEGATE_SETTER(mutateFunctionType(Ty));
 270   }
 271
 272   /// getAttributes/setAttributes - get or set the parameter attributes of
 273   /// the call.
 274   const AttributeSet &getAttributes() const {
 275     CALLSITE_DELEGATE_GETTER(getAttributes());
 276   }
 277   void setAttributes(const AttributeSet &PAL) {
 278     CALLSITE_DELEGATE_SETTER(setAttributes(PAL));
 279   }
 280
 281   /// \brief Return true if this function has the given attribute.
 282   bool hasFnAttr(Attribute::AttrKind A) const {
 283     CALLSITE_DELEGATE_GETTER(hasFnAttr(A));
 284   }
 285
 286   /// \brief Return true if the call or the callee has the given attribute.
 287   bool paramHasAttr(unsigned i, Attribute::AttrKind A) const {
 288     CALLSITE_DELEGATE_GETTER(paramHasAttr(i, A));
 289   }
 290
 291   /// \brief Return true if the data operand at index \p i directly or
 292   /// indirectly has the attribute \p A.
 293   ///
 294   /// Normal call or invoke arguments have per operand attributes, as specified
 295   /// in the attribute set attached to this instruction, while operand bundle
 296   /// operands may have some attributes implied by the type of its containing
 297   /// operand bundle.
 298   bool dataOperandHasImpliedAttr(unsigned i, Attribute::AttrKind A) const {
 299     CALLSITE_DELEGATE_GETTER(dataOperandHasImpliedAttr(i, A));
 300   }
 301
 302   /// @brief Extract the alignment for a call or parameter (0=unknown).
 303   uint16_t getParamAlignment(uint16_t i) const {
 304     CALLSITE_DELEGATE_GETTER(getParamAlignment(i));
 305   }
 306
 307   /// @brief Extract the number of dereferenceable bytes for a call or
 308   /// parameter (0=unknown).
 309   uint64_t getDereferenceableBytes(uint16_t i) const {
 310     CALLSITE_DELEGATE_GETTER(getDereferenceableBytes(i));
 311   }
 312
 313   /// @brief Extract the number of dereferenceable_or_null bytes for a call or
 314   /// parameter (0=unknown).
 315   uint64_t getDereferenceableOrNullBytes(uint16_t i) const {
 316     CALLSITE_DELEGATE_GETTER(getDereferenceableOrNullBytes(i));
 317   }
 318
 319   /// @brief Determine if the parameter or return value is marked with NoAlias
 320   /// attribute.
 321   /// @param n The parameter to check. 1 is the first parameter, 0 is the return
 322   bool doesNotAlias(unsigned n) const {
 323     CALLSITE_DELEGATE_GETTER(doesNotAlias(n));
 324   }
 325
 326   /// \brief Return true if the call should not be treated as a call to a
 327   /// builtin.
 328   bool isNoBuiltin() const {
 329     CALLSITE_DELEGATE_GETTER(isNoBuiltin());
 330   }
 331
 332   /// @brief Return true if the call should not be inlined.
 333   bool isNoInline() const {
 334     CALLSITE_DELEGATE_GETTER(isNoInline());
 335   }
 336   void setIsNoInline(bool Value = true) {
 337     CALLSITE_DELEGATE_SETTER(setIsNoInline(Value));
 338   }
 339
 340   /// @brief Determine if the call does not access memory.
 341   bool doesNotAccessMemory() const {
 342     CALLSITE_DELEGATE_GETTER(doesNotAccessMemory());
 343   }
 344   void setDoesNotAccessMemory() {
 345     CALLSITE_DELEGATE_SETTER(setDoesNotAccessMemory());
 346   }
 347
 348   /// @brief Determine if the call does not access or only reads memory.
 349   bool onlyReadsMemory() const {
 350     CALLSITE_DELEGATE_GETTER(onlyReadsMemory());
 351   }
 352   void setOnlyReadsMemory() {
 353     CALLSITE_DELEGATE_SETTER(setOnlyReadsMemory());
 354   }
 355
 356   /// @brief Determine if the call can access memmory only using pointers based
 357   /// on its arguments.
 358   bool onlyAccessesArgMemory() const {
 359     CALLSITE_DELEGATE_GETTER(onlyAccessesArgMemory());
 360   }
 361   void setOnlyAccessesArgMemory() {
 362     CALLSITE_DELEGATE_SETTER(setOnlyAccessesArgMemory());
 363   }
 364
 365   /// @brief Determine if the call cannot return.
 366   bool doesNotReturn() const {
 367     CALLSITE_DELEGATE_GETTER(doesNotReturn());
 368   }
 369   void setDoesNotReturn() {
 370     CALLSITE_DELEGATE_SETTER(setDoesNotReturn());
 371   }
 372
 373   /// @brief Determine if the call cannot unwind.
 374   bool doesNotThrow() const {
 375     CALLSITE_DELEGATE_GETTER(doesNotThrow());
 376   }
 377   void setDoesNotThrow() {
 378     CALLSITE_DELEGATE_SETTER(setDoesNotThrow());
 379   }
 380
 381   unsigned getNumOperandBundles() const {
 382     CALLSITE_DELEGATE_GETTER(getNumOperandBundles());
 383   }
 384
 385   bool hasOperandBundles() const {
 386     CALLSITE_DELEGATE_GETTER(hasOperandBundles());
 387   }
 388
 389   unsigned getBundleOperandsStartIndex() const {
 390     CALLSITE_DELEGATE_GETTER(getBundleOperandsStartIndex());
 391   }
 392
 393   unsigned getBundleOperandsEndIndex() const {
 394     CALLSITE_DELEGATE_GETTER(getBundleOperandsEndIndex());
 395   }
 396
 397   unsigned getNumTotalBundleOperands() const {
 398     CALLSITE_DELEGATE_GETTER(getNumTotalBundleOperands());
 399   }
 400
 401   OperandBundleUse getOperandBundleAt(unsigned Index) const {
 402     CALLSITE_DELEGATE_GETTER(getOperandBundleAt(Index));
 403   }
 404
 405   Optional<OperandBundleUse> getOperandBundle(StringRef Name) const {
 406     CALLSITE_DELEGATE_GETTER(getOperandBundle(Name));
 407   }
 408
 409   Optional<OperandBundleUse> getOperandBundle(uint32_t ID) const {
 410     CALLSITE_DELEGATE_GETTER(getOperandBundle(ID));
 411   }
 412
 413   IterTy arg_begin() const {
 414     CALLSITE_DELEGATE_GETTER(arg_begin());
 415   }
 416
 417   IterTy arg_end() const {
 418     CALLSITE_DELEGATE_GETTER(arg_end());
 419   }
 420
 421 #undef CALLSITE_DELEGATE_GETTER
 422 #undef CALLSITE_DELEGATE_SETTER
 423
 424   void getOperandBundlesAsDefs(SmallVectorImpl<OperandBundleDef> &Defs) const {
 425     const Instruction *II = getInstruction();
 426     // Since this is actually a getter that "looks like" a setter, don't use the
 427     // above macros to avoid confusion.
 428     if (isCall())
 429       cast<CallInst>(II)->getOperandBundlesAsDefs(Defs);
 430     else
 431       cast<InvokeInst>(II)->getOperandBundlesAsDefs(Defs);
 432   }
 433
 434   /// @brief Determine whether this data operand is not captured.
 435   bool doesNotCapture(unsigned OpNo) const {
 436     return dataOperandHasImpliedAttr(OpNo + 1, Attribute::NoCapture);
 437   }
 438
 439   /// @brief Determine whether this argument is passed by value.
 440   bool isByValArgument(unsigned ArgNo) const {
 441     return paramHasAttr(ArgNo + 1, Attribute::ByVal);
 442   }
 443
 444   /// @brief Determine whether this argument is passed in an alloca.
 445   bool isInAllocaArgument(unsigned ArgNo) const {
 446     return paramHasAttr(ArgNo + 1, Attribute::InAlloca);
 447   }
 448
 449   /// @brief Determine whether this argument is passed by value or in an alloca.
 450   bool isByValOrInAllocaArgument(unsigned ArgNo) const {
 451     return paramHasAttr(ArgNo + 1, Attribute::ByVal) ||
 452            paramHasAttr(ArgNo + 1, Attribute::InAlloca);
 453   }
 454
 455   /// @brief Determine if there are is an inalloca argument.  Only the last
 456   /// argument can have the inalloca attribute.
 457   bool hasInAllocaArgument() const {
 458     return paramHasAttr(arg_size(), Attribute::InAlloca);
 459   }
 460
 461   bool doesNotAccessMemory(unsigned OpNo) const {
 462     return dataOperandHasImpliedAttr(OpNo + 1, Attribute::ReadNone);
 463   }
 464
 465   bool onlyReadsMemory(unsigned OpNo) const {
 466     return dataOperandHasImpliedAttr(OpNo + 1, Attribute::ReadOnly) ||
 467            dataOperandHasImpliedAttr(OpNo + 1, Attribute::ReadNone);
 468   }
 469
 470   /// @brief Return true if the return value is known to be not null.
 471   /// This may be because it has the nonnull attribute, or because at least
 472   /// one byte is dereferenceable and the pointer is in addrspace(0).
 473   bool isReturnNonNull() const {
 474     if (paramHasAttr(0, Attribute::NonNull))
 475       return true;
 476     else if (getDereferenceableBytes(0) > 0 &&
 477              getType()->getPointerAddressSpace() == 0)
 478       return true;
 479
 480     return false;
 481   }
 482
 483   /// hasArgument - Returns true if this CallSite passes the given Value* as an
 484   /// argument to the called function.
 485   bool hasArgument(const Value *Arg) const {
 486     for (arg_iterator AI = this->arg_begin(), E = this->arg_end(); AI != E;
 487          ++AI)
 488       if (AI->get() == Arg)
 489         return true;
 490     return false;
 491   }
 492
 493 private:
 494   IterTy getCallee() const {
 495     if (isCall()) // Skip Callee
 496       return cast<CallInst>(getInstruction())->op_end() - 1;
 497     else // Skip BB, BB, Callee
 498       return cast<InvokeInst>(getInstruction())->op_end() - 3;
 499   }
 500 };
 501
 502 class CallSite : public CallSiteBase<Function, BasicBlock, Value, User, Use,
 503                                      Instruction, CallInst, InvokeInst,
 504                                      User::op_iterator> {
 505 public:
 506   CallSite() {}
 507   CallSite(CallSiteBase B) : CallSiteBase(B) {}
 508   CallSite(CallInst *CI) : CallSiteBase(CI) {}
 509   CallSite(InvokeInst *II) : CallSiteBase(II) {}
 510   explicit CallSite(Instruction *II) : CallSiteBase(II) {}
 511   explicit CallSite(Value *V) : CallSiteBase(V) {}
 512
 513   bool operator==(const CallSite &CS) const { return I == CS.I; }
 514   bool operator!=(const CallSite &CS) const { return I != CS.I; }
 515   bool operator<(const CallSite &CS) const {
 516     return getInstruction() < CS.getInstruction();
 517   }
 518
 519 private:
 520   User::op_iterator getCallee() const;
 521 };
 522
 523 /// ImmutableCallSite - establish a view to a call site for examination
 524 class ImmutableCallSite : public CallSiteBase<> {
 525 public:
 526   ImmutableCallSite() {}
 527   ImmutableCallSite(const CallInst *CI) : CallSiteBase(CI) {}
 528   ImmutableCallSite(const InvokeInst *II) : CallSiteBase(II) {}
 529   explicit ImmutableCallSite(const Instruction *II) : CallSiteBase(II) {}
 530   explicit ImmutableCallSite(const Value *V) : CallSiteBase(V) {}
 531   ImmutableCallSite(CallSite CS) : CallSiteBase(CS.getInstruction()) {}
 532 };
 533
 534 } // End llvm namespace
 535
 536 #endif