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 was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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
  26 namespace llvm {
  27
  28 class CallInst;
  29 class InvokeInst;
  30
  31 class CallSite {
  32   Instruction *I;
  33 public:
  34   CallSite() : I(0) {}
  35   CallSite(CallInst *CI) : I((Instruction*)CI) {}
  36   CallSite(InvokeInst *II) : I((Instruction*)II) {}
  37   CallSite(const CallSite &CS) : I(CS.I) {}
  38   CallSite &operator=(const CallSite &CS) { I = CS.I; return *this; }
  39
  40   /// CallSite::get - This static method is sort of like a constructor.  It will
  41   /// create an appropriate call site for a Call or Invoke instruction, but it
  42   /// can also create a null initialized CallSite object for something which is
  43   /// NOT a call site.
  44   ///
  45   static CallSite get(Value *V) {
  46     if (Instruction *I = dyn_cast<Instruction>(V)) {
  47       if (I->getOpcode() == Instruction::Call)
  48         return CallSite((CallInst*)I);
  49       else if (I->getOpcode() == Instruction::Invoke)
  50         return CallSite((InvokeInst*)I);
  51     }
  52     return CallSite();
  53   }
  54
  55   /// getType - Return the type of the instruction that generated this call site
  56   ///
  57   const Type *getType() const { return I->getType(); }
  58
  59   /// getInstruction - Return the instruction this call site corresponds to
  60   ///
  61   Instruction *getInstruction() const { return I; }
  62
  63   /// getCaller - Return the caller function for this call site
  64   ///
  65   Function *getCaller() const { return I->getParent()->getParent(); }
  66
  67   /// getCalledValue - Return the pointer to function that is being called...
  68   ///
  69   Value *getCalledValue() const {
  70     assert(I && "Not a call or invoke instruction!");
  71     return I->getOperand(0);
  72   }
  73
  74   /// getCalledFunction - Return the function being called if this is a direct
  75   /// call, otherwise return null (if it's an indirect call).
  76   ///
  77   /// FIXME: This should be inlined once ConstantPointerRefs are gone.  :(
  78   Function *getCalledFunction() const;
  79
  80   /// setCalledFunction - Set the callee to the specified value...
  81   ///
  82   void setCalledFunction(Value *V) {
  83     assert(I && "Not a call or invoke instruction!");
  84     I->setOperand(0, V);
  85   }
  86
  87   Value *getArgument(unsigned ArgNo) const {
  88     assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
  89     return *(arg_begin()+ArgNo);
  90   }
  91
  92   /// arg_iterator - The type of iterator to use when looping over actual
  93   /// arguments at this call site...
  94   typedef User::op_iterator arg_iterator;
  95
  96   /// arg_begin/arg_end - Return iterators corresponding to the actual argument
  97   /// list for a call site.
  98   ///
  99   arg_iterator arg_begin() const {
 100     assert(I && "Not a call or invoke instruction!");
 101     if (I->getOpcode() == Instruction::Call)
 102       return I->op_begin()+1; // Skip Function
 103     else
 104       return I->op_begin()+3; // Skip Function, BB, BB
 105   }
 106   arg_iterator arg_end() const { return I->op_end(); }
 107   unsigned arg_size() const { return unsigned(arg_end() - arg_begin()); }
 108
 109   bool operator<(const CallSite &CS) const {
 110     return getInstruction() < CS.getInstruction();
 111   }
 112 };
 113
 114 } // End llvm namespace
 115
 116 #endif