include/llvm/Support/CallSite.h

   1 //===-- llvm/Support/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.
  12 //
  13 // NOTE: This class is supposed to have "value semantics". So it should be
  14 // passed by value, not by reference; it should not be "new"ed or "delete"d. It
  15 // is efficiently copyable, assignable and constructable, with cost equivalent
  16 // to copying a pointer (notice that it has only a single data member).
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #ifndef LLVM_SUPPORT_CALLSITE_H
  21 #define LLVM_SUPPORT_CALLSITE_H
  22
  23 #include "llvm/Instruction.h"
  24 #include "llvm/BasicBlock.h"
  25 #include "llvm/ParameterAttributes.h"
  26
  27 namespace llvm {
  28
  29 class CallInst;
  30 class InvokeInst;
  31
  32 class CallSite {
  33   Instruction *I;
  34 public:
  35   CallSite() : I(0) {}
  36   CallSite(CallInst *CI) : I(reinterpret_cast<Instruction*>(CI)) {}
  37   CallSite(InvokeInst *II) : I(reinterpret_cast<Instruction*>(II)) {}
  38   CallSite(Instruction *C);
  39   CallSite(const CallSite &CS) : I(CS.I) {}
  40   CallSite &operator=(const CallSite &CS) { I = CS.I; return *this; }
  41
  42   bool operator==(const CallSite &CS) const { return I == CS.I; }
  43   bool operator!=(const CallSite &CS) const { return I != CS.I; }
  44
  45   /// CallSite::get - This static method is sort of like a constructor.  It will
  46   /// create an appropriate call site for a Call or Invoke instruction, but it
  47   /// can also create a null initialized CallSite object for something which is
  48   /// NOT a call site.
  49   ///
  50   static CallSite get(Value *V) {
  51     if (Instruction *I = dyn_cast<Instruction>(V)) {
  52       if (I->getOpcode() == Instruction::Call)
  53         return CallSite(reinterpret_cast<CallInst*>(I));
  54       else if (I->getOpcode() == Instruction::Invoke)
  55         return CallSite(reinterpret_cast<InvokeInst*>(I));
  56     }
  57     return CallSite();
  58   }
  59
  60   /// getCallingConv/setCallingConv - get or set the calling convention of the
  61   /// call.
  62   unsigned getCallingConv() const;
  63   void setCallingConv(unsigned CC);
  64
  65   /// getParamAttrs/setParamAttrs - get or set the parameter attributes of
  66   /// the call.
  67   const PAListPtr &getParamAttrs() const;
  68   void setParamAttrs(const PAListPtr &PAL);
  69
  70   /// paramHasAttr - whether the call or the callee has the given attribute.
  71   bool paramHasAttr(uint16_t i, ParameterAttributes attr) const;
  72
  73   /// @brief Extract the alignment for a call or parameter (0=unknown).
  74   uint16_t getParamAlignment(uint16_t i) const;
  75
  76   /// @brief Determine if the call does not access memory.
  77   bool doesNotAccessMemory() const;
  78
  79   /// @brief Determine if the call does not access or only reads memory.
  80   bool onlyReadsMemory() const;
  81
  82   /// @brief Determine if the call cannot unwind.
  83   bool doesNotThrow() const;
  84   void setDoesNotThrow(bool doesNotThrow = true);
  85
  86   /// getType - Return the type of the instruction that generated this call site
  87   ///
  88   const Type *getType() const { return I->getType(); }
  89
  90   /// getInstruction - Return the instruction this call site corresponds to
  91   ///
  92   Instruction *getInstruction() const { return I; }
  93
  94   /// getCaller - Return the caller function for this call site
  95   ///
  96   Function *getCaller() const { return I->getParent()->getParent(); }
  97
  98   /// getCalledValue - Return the pointer to function that is being called...
  99   ///
 100   Value *getCalledValue() const {
 101     assert(I && "Not a call or invoke instruction!");
 102     return I->getOperand(0);
 103   }
 104
 105   /// getCalledFunction - Return the function being called if this is a direct
 106   /// call, otherwise return null (if it's an indirect call).
 107   ///
 108   Function *getCalledFunction() const {
 109     return dyn_cast<Function>(getCalledValue());
 110   }
 111
 112   /// setCalledFunction - Set the callee to the specified value...
 113   ///
 114   void setCalledFunction(Value *V) {
 115     assert(I && "Not a call or invoke instruction!");
 116     I->setOperand(0, V);
 117   }
 118
 119   Value *getArgument(unsigned ArgNo) const {
 120     assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
 121     return *(arg_begin()+ArgNo);
 122   }
 123
 124   void setArgument(unsigned ArgNo, Value* newVal) {
 125     assert(I && "Not a call or invoke instruction!");
 126     assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
 127     if (I->getOpcode() == Instruction::Call)
 128       I->setOperand(ArgNo+1, newVal); // Skip Function
 129     else
 130       I->setOperand(ArgNo+3, newVal); // Skip Function, BB, BB
 131   }
 132
 133   /// arg_iterator - The type of iterator to use when looping over actual
 134   /// arguments at this call site...
 135   typedef User::op_iterator arg_iterator;
 136
 137   /// arg_begin/arg_end - Return iterators corresponding to the actual argument
 138   /// list for a call site.
 139   ///
 140   arg_iterator arg_begin() const {
 141     assert(I && "Not a call or invoke instruction!");
 142     if (I->getOpcode() == Instruction::Call)
 143       return I->op_begin()+1; // Skip Function
 144     else
 145       return I->op_begin()+3; // Skip Function, BB, BB
 146   }
 147   arg_iterator arg_end() const { return I->op_end(); }
 148   bool arg_empty() const { return arg_end() == arg_begin(); }
 149   unsigned arg_size() const { return unsigned(arg_end() - arg_begin()); }
 150
 151   bool operator<(const CallSite &CS) const {
 152     return getInstruction() < CS.getInstruction();
 153   }
 154 };
 155
 156 } // End llvm namespace
 157
 158 #endif