1 //===-- llvm/Support/CallSite.h - Abstract Call & Invoke instrs -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
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.
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).
18 //===----------------------------------------------------------------------===//
20 #ifndef LLVM_SUPPORT_CALLSITE_H
21 #define LLVM_SUPPORT_CALLSITE_H
23 #include "llvm/Instruction.h"
24 #include "llvm/BasicBlock.h"
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; }
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
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);
55 /// getType - Return the type of the instruction that generated this call site
57 const Type *getType() const { return I->getType(); }
59 /// getInstruction - Return the instruction this call site corresponds to
61 Instruction *getInstruction() const { return I; }
63 /// getCaller - Return the caller function for this call site
65 Function *getCaller() const { return I->getParent()->getParent(); }
67 /// getCalledValue - Return the pointer to function that is being called...
69 Value *getCalledValue() const {
70 assert(I && "Not a call or invoke instruction!");
71 return I->getOperand(0);
74 /// getCalledFunction - Return the function being called if this is a direct
75 /// call, otherwise return null (if it's an indirect call).
77 Function *getCalledFunction() const {
78 return dyn_cast<Function>(getCalledValue());
81 /// setCalledFunction - Set the callee to the specified value...
83 void setCalledFunction(Value *V) {
84 assert(I && "Not a call or invoke instruction!");
88 Value *getArgument(unsigned ArgNo) const {
89 assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
90 return *(arg_begin()+ArgNo);
93 /// arg_iterator - The type of iterator to use when looping over actual
94 /// arguments at this call site...
95 typedef User::op_iterator arg_iterator;
97 /// arg_begin/arg_end - Return iterators corresponding to the actual argument
98 /// list for a call site.
100 arg_iterator arg_begin() const {
101 assert(I && "Not a call or invoke instruction!");
102 if (I->getOpcode() == Instruction::Call)
103 return I->op_begin()+1; // Skip Function
105 return I->op_begin()+3; // Skip Function, BB, BB
107 arg_iterator arg_end() const { return I->op_end(); }
108 unsigned arg_size() const { return unsigned(arg_end() - arg_begin()); }
110 bool operator<(const CallSite &CS) const {
111 return getInstruction() < CS.getInstruction();
115 } // End llvm namespace