1 //===-- llvm/Support/CallSite.h - Abstract Call & Invoke instrs -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // 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"
25 #include "llvm/ParameterAttributes.h"
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; }
42 bool operator==(const CallSite &CS) const { return I == CS.I; }
43 bool operator!=(const CallSite &CS) const { return I != CS.I; }
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
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));
60 /// getCallingConv/setCallingConv - get or set the calling convention of the
62 unsigned getCallingConv() const;
63 void setCallingConv(unsigned CC);
65 /// getParamAttrs/setParamAttrs - get or set the parameter attributes of
67 const PAListPtr &getParamAttrs() const;
68 void setParamAttrs(const PAListPtr &PAL);
70 /// paramHasAttr - whether the call or the callee has the given attribute.
71 bool paramHasAttr(uint16_t i, ParameterAttributes attr) const;
73 /// @brief Extract the alignment for a call or parameter (0=unknown).
74 uint16_t getParamAlignment(uint16_t i) const;
76 /// @brief Determine if the call does not access memory.
77 bool doesNotAccessMemory() const;
78 void setDoesNotAccessMemory(bool doesNotAccessMemory = true);
80 /// @brief Determine if the call does not access or only reads memory.
81 bool onlyReadsMemory() const;
82 void setOnlyReadsMemory(bool onlyReadsMemory = true);
84 /// @brief Determine if the call cannot return.
85 bool doesNotReturn() const;
86 void setDoesNotReturn(bool doesNotReturn = true);
88 /// @brief Determine if the call cannot unwind.
89 bool doesNotThrow() const;
90 void setDoesNotThrow(bool doesNotThrow = true);
92 /// getType - Return the type of the instruction that generated this call site
94 const Type *getType() const { return I->getType(); }
96 /// getInstruction - Return the instruction this call site corresponds to
98 Instruction *getInstruction() const { return I; }
100 /// getCaller - Return the caller function for this call site
102 Function *getCaller() const { return I->getParent()->getParent(); }
104 /// getCalledValue - Return the pointer to function that is being called...
106 Value *getCalledValue() const {
107 assert(I && "Not a call or invoke instruction!");
108 return I->getOperand(0);
111 /// getCalledFunction - Return the function being called if this is a direct
112 /// call, otherwise return null (if it's an indirect call).
114 Function *getCalledFunction() const {
115 return dyn_cast<Function>(getCalledValue());
118 /// setCalledFunction - Set the callee to the specified value...
120 void setCalledFunction(Value *V) {
121 assert(I && "Not a call or invoke instruction!");
125 Value *getArgument(unsigned ArgNo) const {
126 assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
127 return *(arg_begin()+ArgNo);
130 void setArgument(unsigned ArgNo, Value* newVal) {
131 assert(I && "Not a call or invoke instruction!");
132 assert(arg_begin() + ArgNo < arg_end() && "Argument # out of range!");
133 I->setOperand(getArgumentOffset() + ArgNo, newVal);
136 /// Given an operand number, returns the argument that corresponds to it.
137 /// OperandNo must be a valid operand number that actually corresponds to an
139 unsigned getArgumentNo(unsigned OperandNo) const {
140 assert(OperandNo >= getArgumentOffset() && "Operand number passed was not "
142 return OperandNo - getArgumentOffset();
145 /// hasArgument - Returns true if this CallSite passes the given Value* as an
146 /// argument to the called function.
147 bool hasArgument(const Value *Arg) const;
149 /// arg_iterator - The type of iterator to use when looping over actual
150 /// arguments at this call site...
151 typedef User::op_iterator arg_iterator;
153 /// arg_begin/arg_end - Return iterators corresponding to the actual argument
154 /// list for a call site.
155 arg_iterator arg_begin() const {
156 assert(I && "Not a call or invoke instruction!");
157 return I->op_begin() + getArgumentOffset(); // Skip non-arguments
160 arg_iterator arg_end() const { return I->op_end(); }
161 bool arg_empty() const { return arg_end() == arg_begin(); }
162 unsigned arg_size() const { return unsigned(arg_end() - arg_begin()); }
164 bool operator<(const CallSite &CS) const {
165 return getInstruction() < CS.getInstruction();
169 /// Returns the operand number of the first argument
170 unsigned getArgumentOffset() const {
171 if (I->getOpcode() == Instruction::Call)
172 return 1; // Skip Function
174 return 3; // Skip Function, BB, BB
178 } // End llvm namespace