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   ValTy *getArgument(unsigned ArgNo) const {
 122     assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
 123     return *(arg_begin() + ArgNo);
 124   }
 125
 126   void setArgument(unsigned ArgNo, Value* newVal) {
 127     assert(getInstruction() && "Not a call or invoke instruction!");
 128     assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
 129     getInstruction()->setOperand(ArgNo, newVal);
 130   }
 131
 132   /// Given a value use iterator, returns the argument that corresponds to it.
 133   /// Iterator must actually correspond to an argument.
 134   unsigned getArgumentNo(Value::const_user_iterator I) const {
 135     return getArgumentNo(&I.getUse());
 136   }
 137
 138   /// Given a use for an argument, get the argument number that corresponds to
 139   /// it.
 140   unsigned getArgumentNo(const Use *U) const {
 141     assert(getInstruction() && "Not a call or invoke instruction!");
 142     assert(arg_begin() <= U && U < arg_end()
 143            && "Argument # out of range!");
 144     return U - arg_begin();
 145   }
 146
 147   /// arg_iterator - The type of iterator to use when looping over actual
 148   /// arguments at this call site.
 149   typedef IterTy arg_iterator;
 150
 151   /// arg_begin/arg_end - Return iterators corresponding to the actual argument
 152   /// list for a call site.
 153   IterTy arg_begin() const {
 154     assert(getInstruction() && "Not a call or invoke instruction!");
 155     // Skip non-arguments
 156     return (*this)->op_begin();
 157   }
 158
 159   IterTy arg_end() const { return (*this)->op_end() - getArgumentEndOffset(); }
 160   iterator_range<IterTy> args() const {
 161     return iterator_range<IterTy>(arg_begin(), arg_end());
 162   }
 163   bool arg_empty() const { return arg_end() == arg_begin(); }
 164   unsigned arg_size() const { return unsigned(arg_end() - arg_begin()); }
 165
 166   /// Type of iterator to use when looping over data operands at this call site
 167   /// (see below).
 168   typedef IterTy data_operand_iterator;
 169
 170   /// data_operands_begin/data_operands_end - Return iterators iterating over
 171   /// the call / invoke argument list and bundle operands.  For invokes, this is
 172   /// the set of instruction operands except the invoke target and the two
 173   /// successor blocks; and for calls this is the set of instruction operands
 174   /// except the call target.
 175
 176   IterTy data_operands_begin() const {
 177     assert(getInstruction() && "Not a call or invoke instruction!");
 178     return (*this)->op_begin();
 179   }
 180   IterTy data_operands_end() const {
 181     assert(getInstruction() && "Not a call or invoke instruction!");
 182     return (*this)->op_end() - (isCall() ? 1 : 3);
 183   }
 184   iterator_range<IterTy> data_ops() const {
 185     return iterator_range<IterTy>(data_operands_begin(), data_operands_end());
 186   }
 187   bool data_operands_empty() const {
 188     return data_operands_end() == data_operands_begin();
 189   }
 190   unsigned data_operands_size() const {
 191     return std::distance(data_operands_begin(), data_operands_end());
 192   }
 193
 194   /// getType - Return the type of the instruction that generated this call site
 195   ///
 196   Type *getType() const { return (*this)->getType(); }
 197
 198   /// getCaller - Return the caller function for this call site
 199   ///
 200   FunTy *getCaller() const { return (*this)->getParent()->getParent(); }
 201
 202   /// \brief Tests if this call site must be tail call optimized.  Only a
 203   /// CallInst can be tail call optimized.
 204   bool isMustTailCall() const {
 205     return isCall() && cast<CallInst>(getInstruction())->isMustTailCall();
 206   }
 207
 208   /// \brief Tests if this call site is marked as a tail call.
 209   bool isTailCall() const {
 210     return isCall() && cast<CallInst>(getInstruction())->isTailCall();
 211   }
 212
 213 #define CALLSITE_DELEGATE_GETTER(METHOD) \
 214   InstrTy *II = getInstruction();    \
 215   return isCall()                        \
 216     ? cast<CallInst>(II)->METHOD         \
 217     : cast<InvokeInst>(II)->METHOD
 218
 219 #define CALLSITE_DELEGATE_SETTER(METHOD) \
 220   InstrTy *II = getInstruction();    \
 221   if (isCall())                          \
 222     cast<CallInst>(II)->METHOD;          \
 223   else                                   \
 224     cast<InvokeInst>(II)->METHOD
 225
 226   unsigned getNumArgOperands() const {
 227     CALLSITE_DELEGATE_GETTER(getNumArgOperands());
 228   }
 229
 230   ValTy *getArgOperand(unsigned i) const {
 231     CALLSITE_DELEGATE_GETTER(getArgOperand(i));
 232   }
 233
 234   bool isInlineAsm() const {
 235     if (isCall())
 236       return cast<CallInst>(getInstruction())->isInlineAsm();
 237     return false;
 238   }
 239
 240   /// getCallingConv/setCallingConv - get or set the calling convention of the
 241   /// call.
 242   CallingConv::ID getCallingConv() const {
 243     CALLSITE_DELEGATE_GETTER(getCallingConv());
 244   }
 245   void setCallingConv(CallingConv::ID CC) {
 246     CALLSITE_DELEGATE_SETTER(setCallingConv(CC));
 247   }
 248
 249   FunctionType *getFunctionType() const {
 250     CALLSITE_DELEGATE_GETTER(getFunctionType());
 251   }
 252
 253   void mutateFunctionType(FunctionType *Ty) const {
 254     CALLSITE_DELEGATE_SETTER(mutateFunctionType(Ty));
 255   }
 256
 257   /// getAttributes/setAttributes - get or set the parameter attributes of
 258   /// the call.
 259   const AttributeSet &getAttributes() const {
 260     CALLSITE_DELEGATE_GETTER(getAttributes());
 261   }
 262   void setAttributes(const AttributeSet &PAL) {
 263     CALLSITE_DELEGATE_SETTER(setAttributes(PAL));
 264   }
 265
 266   /// \brief Return true if this function has the given attribute.
 267   bool hasFnAttr(Attribute::AttrKind A) const {
 268     CALLSITE_DELEGATE_GETTER(hasFnAttr(A));
 269   }
 270
 271   /// \brief Return true if the call or the callee has the given attribute.
 272   bool paramHasAttr(unsigned i, Attribute::AttrKind A) const {
 273     CALLSITE_DELEGATE_GETTER(paramHasAttr(i, A));
 274   }
 275
 276   /// \brief Return true if the data operand at index \p i directly or
 277   /// indirectly has the attribute \p A.
 278   ///
 279   /// Normal call or invoke arguments have per operand attributes, as specified
 280   /// in the attribute set attached to this instruction, while operand bundle
 281   /// operands may have some attributes implied by the type of its containing
 282   /// operand bundle.
 283   bool dataOperandHasImpliedAttr(unsigned i, Attribute::AttrKind A) const {
 284     CALLSITE_DELEGATE_GETTER(dataOperandHasImpliedAttr(i, A));
 285   }
 286
 287   /// @brief Extract the alignment for a call or parameter (0=unknown).
 288   uint16_t getParamAlignment(uint16_t i) const {
 289     CALLSITE_DELEGATE_GETTER(getParamAlignment(i));
 290   }
 291
 292   /// @brief Extract the number of dereferenceable bytes for a call or
 293   /// parameter (0=unknown).
 294   uint64_t getDereferenceableBytes(uint16_t i) const {
 295     CALLSITE_DELEGATE_GETTER(getDereferenceableBytes(i));
 296   }
 297
 298   /// @brief Extract the number of dereferenceable_or_null bytes for a call or
 299   /// parameter (0=unknown).
 300   uint64_t getDereferenceableOrNullBytes(uint16_t i) const {
 301     CALLSITE_DELEGATE_GETTER(getDereferenceableOrNullBytes(i));
 302   }
 303
 304   /// @brief Determine if the parameter or return value is marked with NoAlias
 305   /// attribute.
 306   /// @param n The parameter to check. 1 is the first parameter, 0 is the return
 307   bool doesNotAlias(unsigned n) const {
 308     CALLSITE_DELEGATE_GETTER(doesNotAlias(n));
 309   }
 310
 311   /// \brief Return true if the call should not be treated as a call to a
 312   /// builtin.
 313   bool isNoBuiltin() const {
 314     CALLSITE_DELEGATE_GETTER(isNoBuiltin());
 315   }
 316
 317   /// @brief Return true if the call should not be inlined.
 318   bool isNoInline() const {
 319     CALLSITE_DELEGATE_GETTER(isNoInline());
 320   }
 321   void setIsNoInline(bool Value = true) {
 322     CALLSITE_DELEGATE_SETTER(setIsNoInline(Value));
 323   }
 324
 325   /// @brief Determine if the call does not access memory.
 326   bool doesNotAccessMemory() const {
 327     CALLSITE_DELEGATE_GETTER(doesNotAccessMemory());
 328   }
 329   void setDoesNotAccessMemory() {
 330     CALLSITE_DELEGATE_SETTER(setDoesNotAccessMemory());
 331   }
 332
 333   /// @brief Determine if the call does not access or only reads memory.
 334   bool onlyReadsMemory() const {
 335     CALLSITE_DELEGATE_GETTER(onlyReadsMemory());
 336   }
 337   void setOnlyReadsMemory() {
 338     CALLSITE_DELEGATE_SETTER(setOnlyReadsMemory());
 339   }
 340
 341   /// @brief Determine if the call can access memmory only using pointers based
 342   /// on its arguments.
 343   bool onlyAccessesArgMemory() const {
 344     CALLSITE_DELEGATE_GETTER(onlyAccessesArgMemory());
 345   }
 346   void setOnlyAccessesArgMemory() {
 347     CALLSITE_DELEGATE_SETTER(setOnlyAccessesArgMemory());
 348   }
 349
 350   /// @brief Determine if the call cannot return.
 351   bool doesNotReturn() const {
 352     CALLSITE_DELEGATE_GETTER(doesNotReturn());
 353   }
 354   void setDoesNotReturn() {
 355     CALLSITE_DELEGATE_SETTER(setDoesNotReturn());
 356   }
 357
 358   /// @brief Determine if the call cannot unwind.
 359   bool doesNotThrow() const {
 360     CALLSITE_DELEGATE_GETTER(doesNotThrow());
 361   }
 362   void setDoesNotThrow() {
 363     CALLSITE_DELEGATE_SETTER(setDoesNotThrow());
 364   }
 365
 366   int getNumOperandBundles() const {
 367     CALLSITE_DELEGATE_GETTER(getNumOperandBundles());
 368   }
 369
 370   bool hasOperandBundles() const {
 371     CALLSITE_DELEGATE_GETTER(hasOperandBundles());
 372   }
 373
 374   int getNumTotalBundleOperands() const {
 375     CALLSITE_DELEGATE_GETTER(getNumTotalBundleOperands());
 376   }
 377
 378   OperandBundleUse getOperandBundle(unsigned Index) const {
 379     CALLSITE_DELEGATE_GETTER(getOperandBundle(Index));
 380   }
 381
 382   Optional<OperandBundleUse> getOperandBundle(StringRef Name) const {
 383     CALLSITE_DELEGATE_GETTER(getOperandBundle(Name));
 384   }
 385
 386 #undef CALLSITE_DELEGATE_GETTER
 387 #undef CALLSITE_DELEGATE_SETTER
 388
 389   /// @brief Determine whether this data operand is not captured.
 390   bool doesNotCapture(unsigned OpNo) const {
 391     return dataOperandHasImpliedAttr(OpNo + 1, Attribute::NoCapture);
 392   }
 393
 394   /// @brief Determine whether this argument is passed by value.
 395   bool isByValArgument(unsigned ArgNo) const {
 396     return paramHasAttr(ArgNo + 1, Attribute::ByVal);
 397   }
 398
 399   /// @brief Determine whether this argument is passed in an alloca.
 400   bool isInAllocaArgument(unsigned ArgNo) const {
 401     return paramHasAttr(ArgNo + 1, Attribute::InAlloca);
 402   }
 403
 404   /// @brief Determine whether this argument is passed by value or in an alloca.
 405   bool isByValOrInAllocaArgument(unsigned ArgNo) const {
 406     return paramHasAttr(ArgNo + 1, Attribute::ByVal) ||
 407            paramHasAttr(ArgNo + 1, Attribute::InAlloca);
 408   }
 409
 410   /// @brief Determine if there are is an inalloca argument.  Only the last
 411   /// argument can have the inalloca attribute.
 412   bool hasInAllocaArgument() const {
 413     return paramHasAttr(arg_size(), Attribute::InAlloca);
 414   }
 415
 416   bool doesNotAccessMemory(unsigned OpNo) const {
 417     return dataOperandHasImpliedAttr(OpNo + 1, Attribute::ReadNone);
 418   }
 419
 420   bool onlyReadsMemory(unsigned OpNo) const {
 421     return dataOperandHasImpliedAttr(OpNo + 1, Attribute::ReadOnly) ||
 422            dataOperandHasImpliedAttr(OpNo + 1, Attribute::ReadNone);
 423   }
 424
 425   /// @brief Return true if the return value is known to be not null.
 426   /// This may be because it has the nonnull attribute, or because at least
 427   /// one byte is dereferenceable and the pointer is in addrspace(0).
 428   bool isReturnNonNull() const {
 429     if (paramHasAttr(0, Attribute::NonNull))
 430       return true;
 431     else if (getDereferenceableBytes(0) > 0 &&
 432              getType()->getPointerAddressSpace() == 0)
 433       return true;
 434
 435     return false;
 436   }
 437
 438   /// hasArgument - Returns true if this CallSite passes the given Value* as an
 439   /// argument to the called function.
 440   bool hasArgument(const Value *Arg) const {
 441     for (arg_iterator AI = this->arg_begin(), E = this->arg_end(); AI != E;
 442          ++AI)
 443       if (AI->get() == Arg)
 444         return true;
 445     return false;
 446   }
 447
 448 private:
 449   unsigned getArgumentEndOffset() const {
 450     if (isCall()) {
 451       // Skip [ operand bundles ], Callee
 452       auto *CI = cast<CallInst>(getInstruction());
 453       return 1 + CI->getNumTotalBundleOperands();
 454     } else {
 455       // Skip [ operand bundles ], BB, BB, Callee
 456       auto *II = cast<InvokeInst>(getInstruction());
 457       return 3 + II->getNumTotalBundleOperands();
 458     }
 459   }
 460
 461   IterTy getCallee() const {
 462     if (isCall()) // Skip Callee
 463       return cast<CallInst>(getInstruction())->op_end() - 1;
 464     else // Skip BB, BB, Callee
 465       return cast<InvokeInst>(getInstruction())->op_end() - 3;
 466   }
 467 };
 468
 469 class CallSite : public CallSiteBase<Function, BasicBlock, Value, User, Use,
 470                                      Instruction, CallInst, InvokeInst,
 471                                      User::op_iterator> {
 472 public:
 473   CallSite() {}
 474   CallSite(CallSiteBase B) : CallSiteBase(B) {}
 475   CallSite(CallInst *CI) : CallSiteBase(CI) {}
 476   CallSite(InvokeInst *II) : CallSiteBase(II) {}
 477   explicit CallSite(Instruction *II) : CallSiteBase(II) {}
 478   explicit CallSite(Value *V) : CallSiteBase(V) {}
 479
 480   bool operator==(const CallSite &CS) const { return I == CS.I; }
 481   bool operator!=(const CallSite &CS) const { return I != CS.I; }
 482   bool operator<(const CallSite &CS) const {
 483     return getInstruction() < CS.getInstruction();
 484   }
 485
 486 private:
 487   User::op_iterator getCallee() const;
 488 };
 489
 490 /// ImmutableCallSite - establish a view to a call site for examination
 491 class ImmutableCallSite : public CallSiteBase<> {
 492 public:
 493   ImmutableCallSite() {}
 494   ImmutableCallSite(const CallInst *CI) : CallSiteBase(CI) {}
 495   ImmutableCallSite(const InvokeInst *II) : CallSiteBase(II) {}
 496   explicit ImmutableCallSite(const Instruction *II) : CallSiteBase(II) {}
 497   explicit ImmutableCallSite(const Value *V) : CallSiteBase(V) {}
 498   ImmutableCallSite(CallSite CS) : CallSiteBase(CS.getInstruction()) {}
 499 };
 500
 501 } // End llvm namespace
 502
 503 #endif