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/IR/Attributes.h"
  31 #include "llvm/IR/CallingConv.h"
  32 #include "llvm/IR/Instructions.h"
  33
  34 namespace llvm {
  35
  36 class CallInst;
  37 class InvokeInst;
  38
  39 template <typename FunTy = const Function,
  40           typename ValTy = const Value,
  41           typename UserTy = const User,
  42           typename InstrTy = const Instruction,
  43           typename CallTy = const CallInst,
  44           typename InvokeTy = const InvokeInst,
  45           typename IterTy = User::const_op_iterator>
  46 class CallSiteBase {
  47 protected:
  48   PointerIntPair<InstrTy*, 1, bool> I;
  49 public:
  50   CallSiteBase() : I(nullptr, false) {}
  51   CallSiteBase(CallTy *CI) : I(CI, true) { assert(CI); }
  52   CallSiteBase(InvokeTy *II) : I(II, false) { assert(II); }
  53   CallSiteBase(ValTy *II) { *this = get(II); }
  54 protected:
  55   /// CallSiteBase::get - This static method is sort of like a constructor.  It
  56   /// will create an appropriate call site for a Call or Invoke instruction, but
  57   /// it can also create a null initialized CallSiteBase object for something
  58   /// which is NOT a call site.
  59   ///
  60   static CallSiteBase get(ValTy *V) {
  61     if (InstrTy *II = dyn_cast<InstrTy>(V)) {
  62       if (II->getOpcode() == Instruction::Call)
  63         return CallSiteBase(static_cast<CallTy*>(II));
  64       else if (II->getOpcode() == Instruction::Invoke)
  65         return CallSiteBase(static_cast<InvokeTy*>(II));
  66     }
  67     return CallSiteBase();
  68   }
  69 public:
  70   /// isCall - true if a CallInst is enclosed.
  71   /// Note that !isCall() does not mean it is an InvokeInst enclosed,
  72   /// it also could signify a NULL Instruction pointer.
  73   bool isCall() const { return I.getInt(); }
  74
  75   /// isInvoke - true if a InvokeInst is enclosed.
  76   ///
  77   bool isInvoke() const { return getInstruction() && !I.getInt(); }
  78
  79   InstrTy *getInstruction() const { return I.getPointer(); }
  80   InstrTy *operator->() const { return I.getPointer(); }
  81   LLVM_EXPLICIT operator bool() const { return I.getPointer(); }
  82
  83   /// getCalledValue - Return the pointer to function that is being called.
  84   ///
  85   ValTy *getCalledValue() const {
  86     assert(getInstruction() && "Not a call or invoke instruction!");
  87     return *getCallee();
  88   }
  89
  90   /// getCalledFunction - Return the function being called if this is a direct
  91   /// call, otherwise return null (if it's an indirect call).
  92   ///
  93   FunTy *getCalledFunction() const {
  94     return dyn_cast<FunTy>(getCalledValue());
  95   }
  96
  97   /// setCalledFunction - Set the callee to the specified value.
  98   ///
  99   void setCalledFunction(Value *V) {
 100     assert(getInstruction() && "Not a call or invoke instruction!");
 101     *getCallee() = V;
 102   }
 103
 104   /// isCallee - Determine whether the passed iterator points to the
 105   /// callee operand's Use.
 106   bool isCallee(Value::const_user_iterator UI) const {
 107     return isCallee(&UI.getUse());
 108   }
 109
 110   /// Determine whether this Use is the callee operand's Use.
 111   bool isCallee(const Use *U) const { return getCallee() == U; }
 112
 113   ValTy *getArgument(unsigned ArgNo) const {
 114     assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
 115     return *(arg_begin() + ArgNo);
 116   }
 117
 118   void setArgument(unsigned ArgNo, Value* newVal) {
 119     assert(getInstruction() && "Not a call or invoke instruction!");
 120     assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
 121     getInstruction()->setOperand(ArgNo, newVal);
 122   }
 123
 124   /// Given a value use iterator, returns the argument that corresponds to it.
 125   /// Iterator must actually correspond to an argument.
 126   unsigned getArgumentNo(Value::const_user_iterator I) const {
 127     return getArgumentNo(&I.getUse());
 128   }
 129
 130   /// Given a use for an argument, get the argument number that corresponds to
 131   /// it.
 132   unsigned getArgumentNo(const Use *U) const {
 133     assert(getInstruction() && "Not a call or invoke instruction!");
 134     assert(arg_begin() <= U && U < arg_end()
 135            && "Argument # out of range!");
 136     return U - arg_begin();
 137   }
 138
 139   /// arg_iterator - The type of iterator to use when looping over actual
 140   /// arguments at this call site.
 141   typedef IterTy arg_iterator;
 142
 143   /// arg_begin/arg_end - Return iterators corresponding to the actual argument
 144   /// list for a call site.
 145   IterTy arg_begin() const {
 146     assert(getInstruction() && "Not a call or invoke instruction!");
 147     // Skip non-arguments
 148     return (*this)->op_begin();
 149   }
 150
 151   IterTy arg_end() const { return (*this)->op_end() - getArgumentEndOffset(); }
 152   bool arg_empty() const { return arg_end() == arg_begin(); }
 153   unsigned arg_size() const { return unsigned(arg_end() - arg_begin()); }
 154
 155   /// getType - Return the type of the instruction that generated this call site
 156   ///
 157   Type *getType() const { return (*this)->getType(); }
 158
 159   /// getCaller - Return the caller function for this call site
 160   ///
 161   FunTy *getCaller() const { return (*this)->getParent()->getParent(); }
 162
 163   /// \brief Tests if this call site must be tail call optimized.  Only a
 164   /// CallInst can be tail call optimized.
 165   bool isMustTailCall() const {
 166     return isCall() && cast<CallInst>(getInstruction())->isMustTailCall();
 167   }
 168
 169 #define CALLSITE_DELEGATE_GETTER(METHOD) \
 170   InstrTy *II = getInstruction();    \
 171   return isCall()                        \
 172     ? cast<CallInst>(II)->METHOD         \
 173     : cast<InvokeInst>(II)->METHOD
 174
 175 #define CALLSITE_DELEGATE_SETTER(METHOD) \
 176   InstrTy *II = getInstruction();    \
 177   if (isCall())                          \
 178     cast<CallInst>(II)->METHOD;          \
 179   else                                   \
 180     cast<InvokeInst>(II)->METHOD
 181
 182   /// getCallingConv/setCallingConv - get or set the calling convention of the
 183   /// call.
 184   CallingConv::ID getCallingConv() const {
 185     CALLSITE_DELEGATE_GETTER(getCallingConv());
 186   }
 187   void setCallingConv(CallingConv::ID CC) {
 188     CALLSITE_DELEGATE_SETTER(setCallingConv(CC));
 189   }
 190
 191   /// getAttributes/setAttributes - get or set the parameter attributes of
 192   /// the call.
 193   const AttributeSet &getAttributes() const {
 194     CALLSITE_DELEGATE_GETTER(getAttributes());
 195   }
 196   void setAttributes(const AttributeSet &PAL) {
 197     CALLSITE_DELEGATE_SETTER(setAttributes(PAL));
 198   }
 199
 200   /// \brief Return true if this function has the given attribute.
 201   bool hasFnAttr(Attribute::AttrKind A) const {
 202     CALLSITE_DELEGATE_GETTER(hasFnAttr(A));
 203   }
 204
 205   /// \brief Return true if the call or the callee has the given attribute.
 206   bool paramHasAttr(unsigned i, Attribute::AttrKind A) const {
 207     CALLSITE_DELEGATE_GETTER(paramHasAttr(i, A));
 208   }
 209
 210   /// @brief Extract the alignment for a call or parameter (0=unknown).
 211   uint16_t getParamAlignment(uint16_t i) const {
 212     CALLSITE_DELEGATE_GETTER(getParamAlignment(i));
 213   }
 214
 215   /// \brief Return true if the call should not be treated as a call to a
 216   /// builtin.
 217   bool isNoBuiltin() const {
 218     CALLSITE_DELEGATE_GETTER(isNoBuiltin());
 219   }
 220
 221   /// @brief Return true if the call should not be inlined.
 222   bool isNoInline() const {
 223     CALLSITE_DELEGATE_GETTER(isNoInline());
 224   }
 225   void setIsNoInline(bool Value = true) {
 226     CALLSITE_DELEGATE_SETTER(setIsNoInline(Value));
 227   }
 228
 229   /// @brief Determine if the call does not access memory.
 230   bool doesNotAccessMemory() const {
 231     CALLSITE_DELEGATE_GETTER(doesNotAccessMemory());
 232   }
 233   void setDoesNotAccessMemory() {
 234     CALLSITE_DELEGATE_SETTER(setDoesNotAccessMemory());
 235   }
 236
 237   /// @brief Determine if the call does not access or only reads memory.
 238   bool onlyReadsMemory() const {
 239     CALLSITE_DELEGATE_GETTER(onlyReadsMemory());
 240   }
 241   void setOnlyReadsMemory() {
 242     CALLSITE_DELEGATE_SETTER(setOnlyReadsMemory());
 243   }
 244
 245   /// @brief Determine if the call cannot return.
 246   bool doesNotReturn() const {
 247     CALLSITE_DELEGATE_GETTER(doesNotReturn());
 248   }
 249   void setDoesNotReturn() {
 250     CALLSITE_DELEGATE_SETTER(setDoesNotReturn());
 251   }
 252
 253   /// @brief Determine if the call cannot unwind.
 254   bool doesNotThrow() const {
 255     CALLSITE_DELEGATE_GETTER(doesNotThrow());
 256   }
 257   void setDoesNotThrow() {
 258     CALLSITE_DELEGATE_SETTER(setDoesNotThrow());
 259   }
 260
 261 #undef CALLSITE_DELEGATE_GETTER
 262 #undef CALLSITE_DELEGATE_SETTER
 263
 264   /// @brief Determine whether this argument is not captured.
 265   bool doesNotCapture(unsigned ArgNo) const {
 266     return paramHasAttr(ArgNo + 1, Attribute::NoCapture);
 267   }
 268
 269   /// @brief Determine whether this argument is passed by value.
 270   bool isByValArgument(unsigned ArgNo) const {
 271     return paramHasAttr(ArgNo + 1, Attribute::ByVal);
 272   }
 273
 274   /// @brief Determine whether this argument is passed in an alloca.
 275   bool isInAllocaArgument(unsigned ArgNo) const {
 276     return paramHasAttr(ArgNo + 1, Attribute::InAlloca);
 277   }
 278
 279   /// @brief Determine whether this argument is passed by value or in an alloca.
 280   bool isByValOrInAllocaArgument(unsigned ArgNo) const {
 281     return paramHasAttr(ArgNo + 1, Attribute::ByVal) ||
 282            paramHasAttr(ArgNo + 1, Attribute::InAlloca);
 283   }
 284
 285   /// @brief Determine if there are is an inalloca argument.  Only the last
 286   /// argument can have the inalloca attribute.
 287   bool hasInAllocaArgument() const {
 288     return paramHasAttr(arg_size(), Attribute::InAlloca);
 289   }
 290
 291   bool doesNotAccessMemory(unsigned ArgNo) const {
 292     return paramHasAttr(ArgNo + 1, Attribute::ReadNone);
 293   }
 294
 295   bool onlyReadsMemory(unsigned ArgNo) const {
 296     return paramHasAttr(ArgNo + 1, Attribute::ReadOnly) ||
 297            paramHasAttr(ArgNo + 1, Attribute::ReadNone);
 298   }
 299
 300   /// hasArgument - Returns true if this CallSite passes the given Value* as an
 301   /// argument to the called function.
 302   bool hasArgument(const Value *Arg) const {
 303     for (arg_iterator AI = this->arg_begin(), E = this->arg_end(); AI != E;
 304          ++AI)
 305       if (AI->get() == Arg)
 306         return true;
 307     return false;
 308   }
 309
 310 private:
 311   unsigned getArgumentEndOffset() const {
 312     if (isCall())
 313       return 1; // Skip Callee
 314     else
 315       return 3; // Skip BB, BB, Callee
 316   }
 317
 318   IterTy getCallee() const {
 319     if (isCall()) // Skip Callee
 320       return cast<CallInst>(getInstruction())->op_end() - 1;
 321     else // Skip BB, BB, Callee
 322       return cast<InvokeInst>(getInstruction())->op_end() - 3;
 323   }
 324 };
 325
 326 class CallSite : public CallSiteBase<Function, Value, User, Instruction,
 327                                      CallInst, InvokeInst, User::op_iterator> {
 328   typedef CallSiteBase<Function, Value, User, Instruction,
 329                        CallInst, InvokeInst, User::op_iterator> Base;
 330 public:
 331   CallSite() {}
 332   CallSite(Base B) : Base(B) {}
 333   CallSite(Value* V) : Base(V) {}
 334   CallSite(CallInst *CI) : Base(CI) {}
 335   CallSite(InvokeInst *II) : Base(II) {}
 336   CallSite(Instruction *II) : Base(II) {}
 337
 338   bool operator==(const CallSite &CS) const { return I == CS.I; }
 339   bool operator!=(const CallSite &CS) const { return I != CS.I; }
 340   bool operator<(const CallSite &CS) const {
 341     return getInstruction() < CS.getInstruction();
 342   }
 343
 344 private:
 345   User::op_iterator getCallee() const;
 346 };
 347
 348 /// ImmutableCallSite - establish a view to a call site for examination
 349 class ImmutableCallSite : public CallSiteBase<> {
 350   typedef CallSiteBase<> Base;
 351 public:
 352   ImmutableCallSite(const Value* V) : Base(V) {}
 353   ImmutableCallSite(const CallInst *CI) : Base(CI) {}
 354   ImmutableCallSite(const InvokeInst *II) : Base(II) {}
 355   ImmutableCallSite(const Instruction *II) : Base(II) {}
 356   ImmutableCallSite(CallSite CS) : Base(CS.getInstruction()) {}
 357 };
 358
 359 } // End llvm namespace
 360
 361 #endif