1 //===-- llvm/IntrinsicInst.h - Intrinsic Instruction Wrappers ---*- 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 classes that make it really easy to deal with intrinsic
11 // functions with the isa/dyncast family of functions. In particular, this
12 // allows you to do things like:
14 // if (MemCpyInst *MCI = dyn_cast<MemCpyInst>(Inst))
15 // ... MCI->getDest() ... MCI->getSource() ...
17 // All intrinsic function calls are instances of the call instruction, so these
18 // are all subclasses of the CallInst class. Note that none of these classes
19 // has state or virtual methods, which is an important part of this gross/neat
22 //===----------------------------------------------------------------------===//
24 #ifndef LLVM_IR_INTRINSICINST_H
25 #define LLVM_IR_INTRINSICINST_H
27 #include "llvm/IR/Constants.h"
28 #include "llvm/IR/Function.h"
29 #include "llvm/IR/Instructions.h"
30 #include "llvm/IR/Intrinsics.h"
33 /// IntrinsicInst - A useful wrapper class for inspecting calls to intrinsic
34 /// functions. This allows the standard isa/dyncast/cast functionality to
35 /// work with calls to intrinsic functions.
36 class IntrinsicInst : public CallInst {
37 IntrinsicInst() LLVM_DELETED_FUNCTION;
38 IntrinsicInst(const IntrinsicInst&) LLVM_DELETED_FUNCTION;
39 void operator=(const IntrinsicInst&) LLVM_DELETED_FUNCTION;
41 /// getIntrinsicID - Return the intrinsic ID of this intrinsic.
43 Intrinsic::ID getIntrinsicID() const {
44 return (Intrinsic::ID)getCalledFunction()->getIntrinsicID();
47 // Methods for support type inquiry through isa, cast, and dyn_cast:
48 static inline bool classof(const CallInst *I) {
49 if (const Function *CF = I->getCalledFunction())
50 return CF->isIntrinsic();
53 static inline bool classof(const Value *V) {
54 return isa<CallInst>(V) && classof(cast<CallInst>(V));
58 /// DbgInfoIntrinsic - This is the common base class for debug info intrinsics
60 class DbgInfoIntrinsic : public IntrinsicInst {
63 // Methods for support type inquiry through isa, cast, and dyn_cast:
64 static inline bool classof(const IntrinsicInst *I) {
65 switch (I->getIntrinsicID()) {
66 case Intrinsic::dbg_declare:
67 case Intrinsic::dbg_value:
69 default: return false;
72 static inline bool classof(const Value *V) {
73 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
76 static Value *StripCast(Value *C);
79 /// DbgDeclareInst - This represents the llvm.dbg.declare instruction.
81 class DbgDeclareInst : public DbgInfoIntrinsic {
83 Value *getAddress() const;
84 MDNode *getVariable() const { return cast<MDNode>(getArgOperand(1)); }
85 MDNode *getExpression() const { return cast<MDNode>(getArgOperand(2)); }
87 // Methods for support type inquiry through isa, cast, and dyn_cast:
88 static inline bool classof(const IntrinsicInst *I) {
89 return I->getIntrinsicID() == Intrinsic::dbg_declare;
91 static inline bool classof(const Value *V) {
92 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
96 /// DbgValueInst - This represents the llvm.dbg.value instruction.
98 class DbgValueInst : public DbgInfoIntrinsic {
100 const Value *getValue() const;
102 uint64_t getOffset() const {
103 return cast<ConstantInt>(
104 const_cast<Value*>(getArgOperand(1)))->getZExtValue();
106 MDNode *getVariable() const { return cast<MDNode>(getArgOperand(2)); }
107 MDNode *getExpression() const { return cast<MDNode>(getArgOperand(3)); }
109 // Methods for support type inquiry through isa, cast, and dyn_cast:
110 static inline bool classof(const IntrinsicInst *I) {
111 return I->getIntrinsicID() == Intrinsic::dbg_value;
113 static inline bool classof(const Value *V) {
114 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
118 /// MemIntrinsic - This is the common base class for memset/memcpy/memmove.
120 class MemIntrinsic : public IntrinsicInst {
122 Value *getRawDest() const { return const_cast<Value*>(getArgOperand(0)); }
123 const Use &getRawDestUse() const { return getArgOperandUse(0); }
124 Use &getRawDestUse() { return getArgOperandUse(0); }
126 Value *getLength() const { return const_cast<Value*>(getArgOperand(2)); }
127 const Use &getLengthUse() const { return getArgOperandUse(2); }
128 Use &getLengthUse() { return getArgOperandUse(2); }
130 ConstantInt *getAlignmentCst() const {
131 return cast<ConstantInt>(const_cast<Value*>(getArgOperand(3)));
134 unsigned getAlignment() const {
135 return getAlignmentCst()->getZExtValue();
138 ConstantInt *getVolatileCst() const {
139 return cast<ConstantInt>(const_cast<Value*>(getArgOperand(4)));
141 bool isVolatile() const {
142 return !getVolatileCst()->isZero();
145 unsigned getDestAddressSpace() const {
146 return cast<PointerType>(getRawDest()->getType())->getAddressSpace();
149 /// getDest - This is just like getRawDest, but it strips off any cast
150 /// instructions that feed it, giving the original input. The returned
151 /// value is guaranteed to be a pointer.
152 Value *getDest() const { return getRawDest()->stripPointerCasts(); }
154 /// set* - Set the specified arguments of the instruction.
156 void setDest(Value *Ptr) {
157 assert(getRawDest()->getType() == Ptr->getType() &&
158 "setDest called with pointer of wrong type!");
159 setArgOperand(0, Ptr);
162 void setLength(Value *L) {
163 assert(getLength()->getType() == L->getType() &&
164 "setLength called with value of wrong type!");
168 void setAlignment(Constant* A) {
172 void setVolatile(Constant* V) {
176 Type *getAlignmentType() const {
177 return getArgOperand(3)->getType();
180 // Methods for support type inquiry through isa, cast, and dyn_cast:
181 static inline bool classof(const IntrinsicInst *I) {
182 switch (I->getIntrinsicID()) {
183 case Intrinsic::memcpy:
184 case Intrinsic::memmove:
185 case Intrinsic::memset:
187 default: return false;
190 static inline bool classof(const Value *V) {
191 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
195 /// MemSetInst - This class wraps the llvm.memset intrinsic.
197 class MemSetInst : public MemIntrinsic {
199 /// get* - Return the arguments to the instruction.
201 Value *getValue() const { return const_cast<Value*>(getArgOperand(1)); }
202 const Use &getValueUse() const { return getArgOperandUse(1); }
203 Use &getValueUse() { return getArgOperandUse(1); }
205 void setValue(Value *Val) {
206 assert(getValue()->getType() == Val->getType() &&
207 "setValue called with value of wrong type!");
208 setArgOperand(1, Val);
211 // Methods for support type inquiry through isa, cast, and dyn_cast:
212 static inline bool classof(const IntrinsicInst *I) {
213 return I->getIntrinsicID() == Intrinsic::memset;
215 static inline bool classof(const Value *V) {
216 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
220 /// MemTransferInst - This class wraps the llvm.memcpy/memmove intrinsics.
222 class MemTransferInst : public MemIntrinsic {
224 /// get* - Return the arguments to the instruction.
226 Value *getRawSource() const { return const_cast<Value*>(getArgOperand(1)); }
227 const Use &getRawSourceUse() const { return getArgOperandUse(1); }
228 Use &getRawSourceUse() { return getArgOperandUse(1); }
230 /// getSource - This is just like getRawSource, but it strips off any cast
231 /// instructions that feed it, giving the original input. The returned
232 /// value is guaranteed to be a pointer.
233 Value *getSource() const { return getRawSource()->stripPointerCasts(); }
235 unsigned getSourceAddressSpace() const {
236 return cast<PointerType>(getRawSource()->getType())->getAddressSpace();
239 void setSource(Value *Ptr) {
240 assert(getRawSource()->getType() == Ptr->getType() &&
241 "setSource called with pointer of wrong type!");
242 setArgOperand(1, Ptr);
245 // Methods for support type inquiry through isa, cast, and dyn_cast:
246 static inline bool classof(const IntrinsicInst *I) {
247 return I->getIntrinsicID() == Intrinsic::memcpy ||
248 I->getIntrinsicID() == Intrinsic::memmove;
250 static inline bool classof(const Value *V) {
251 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
256 /// MemCpyInst - This class wraps the llvm.memcpy intrinsic.
258 class MemCpyInst : public MemTransferInst {
260 // Methods for support type inquiry through isa, cast, and dyn_cast:
261 static inline bool classof(const IntrinsicInst *I) {
262 return I->getIntrinsicID() == Intrinsic::memcpy;
264 static inline bool classof(const Value *V) {
265 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
269 /// MemMoveInst - This class wraps the llvm.memmove intrinsic.
271 class MemMoveInst : public MemTransferInst {
273 // Methods for support type inquiry through isa, cast, and dyn_cast:
274 static inline bool classof(const IntrinsicInst *I) {
275 return I->getIntrinsicID() == Intrinsic::memmove;
277 static inline bool classof(const Value *V) {
278 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
282 /// VAStartInst - This represents the llvm.va_start intrinsic.
284 class VAStartInst : public IntrinsicInst {
286 static inline bool classof(const IntrinsicInst *I) {
287 return I->getIntrinsicID() == Intrinsic::vastart;
289 static inline bool classof(const Value *V) {
290 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
293 Value *getArgList() const { return const_cast<Value*>(getArgOperand(0)); }
296 /// VAEndInst - This represents the llvm.va_end intrinsic.
298 class VAEndInst : public IntrinsicInst {
300 static inline bool classof(const IntrinsicInst *I) {
301 return I->getIntrinsicID() == Intrinsic::vaend;
303 static inline bool classof(const Value *V) {
304 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
307 Value *getArgList() const { return const_cast<Value*>(getArgOperand(0)); }
310 /// VACopyInst - This represents the llvm.va_copy intrinsic.
312 class VACopyInst : public IntrinsicInst {
314 static inline bool classof(const IntrinsicInst *I) {
315 return I->getIntrinsicID() == Intrinsic::vacopy;
317 static inline bool classof(const Value *V) {
318 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
321 Value *getDest() const { return const_cast<Value*>(getArgOperand(0)); }
322 Value *getSrc() const { return const_cast<Value*>(getArgOperand(1)); }