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_INTRINSICINST_H
25 #define LLVM_INTRINSICINST_H
27 #include "llvm/Constants.h"
28 #include "llvm/Function.h"
29 #include "llvm/Instructions.h"
30 #include "llvm/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(); // DO NOT IMPLEMENT
38 IntrinsicInst(const IntrinsicInst&); // DO NOT IMPLEMENT
39 void operator=(const IntrinsicInst&); // DO NOT IMPLEMENT
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 IntrinsicInst *) { return true; }
49 static inline bool classof(const CallInst *I) {
50 if (const Function *CF = I->getCalledFunction())
51 return CF->getIntrinsicID() != 0;
54 static inline bool classof(const Value *V) {
55 return isa<CallInst>(V) && classof(cast<CallInst>(V));
59 /// DbgInfoIntrinsic - This is the common base class for debug info intrinsics
61 class DbgInfoIntrinsic : public IntrinsicInst {
64 // Methods for support type inquiry through isa, cast, and dyn_cast:
65 static inline bool classof(const DbgInfoIntrinsic *) { return true; }
66 static inline bool classof(const IntrinsicInst *I) {
67 switch (I->getIntrinsicID()) {
68 case Intrinsic::dbg_declare:
69 case Intrinsic::dbg_value:
71 default: return false;
74 static inline bool classof(const Value *V) {
75 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
78 static Value *StripCast(Value *C);
81 /// DbgDeclareInst - This represents the llvm.dbg.declare instruction.
83 class DbgDeclareInst : public DbgInfoIntrinsic {
85 Value *getAddress() const;
86 MDNode *getVariable() const { return cast<MDNode>(getArgOperand(1)); }
88 // Methods for support type inquiry through isa, cast, and dyn_cast:
89 static inline bool classof(const DbgDeclareInst *) { return true; }
90 static inline bool classof(const IntrinsicInst *I) {
91 return I->getIntrinsicID() == Intrinsic::dbg_declare;
93 static inline bool classof(const Value *V) {
94 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
98 /// DbgValueInst - This represents the llvm.dbg.value instruction.
100 class DbgValueInst : public DbgInfoIntrinsic {
102 const Value *getValue() const;
104 uint64_t getOffset() const {
105 return cast<ConstantInt>(
106 const_cast<Value*>(getArgOperand(1)))->getZExtValue();
108 MDNode *getVariable() const { return cast<MDNode>(getArgOperand(2)); }
110 // Methods for support type inquiry through isa, cast, and dyn_cast:
111 static inline bool classof(const DbgValueInst *) { return true; }
112 static inline bool classof(const IntrinsicInst *I) {
113 return I->getIntrinsicID() == Intrinsic::dbg_value;
115 static inline bool classof(const Value *V) {
116 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
120 /// MemIntrinsic - This is the common base class for memset/memcpy/memmove.
122 class MemIntrinsic : public IntrinsicInst {
124 Value *getRawDest() const { return const_cast<Value*>(getArgOperand(0)); }
126 Value *getLength() const { return const_cast<Value*>(getArgOperand(2)); }
127 ConstantInt *getAlignmentCst() const {
128 return cast<ConstantInt>(const_cast<Value*>(getArgOperand(3)));
131 unsigned getAlignment() const {
132 return getAlignmentCst()->getZExtValue();
135 ConstantInt *getVolatileCst() const {
136 return cast<ConstantInt>(const_cast<Value*>(getArgOperand(4)));
138 bool isVolatile() const {
139 return !getVolatileCst()->isZero();
142 unsigned getDestAddressSpace() const {
143 return cast<PointerType>(getRawDest()->getType())->getAddressSpace();
146 /// getDest - This is just like getRawDest, but it strips off any cast
147 /// instructions that feed it, giving the original input. The returned
148 /// value is guaranteed to be a pointer.
149 Value *getDest() const { return getRawDest()->stripPointerCasts(); }
151 /// set* - Set the specified arguments of the instruction.
153 void setDest(Value *Ptr) {
154 assert(getRawDest()->getType() == Ptr->getType() &&
155 "setDest called with pointer of wrong type!");
156 setArgOperand(0, Ptr);
159 void setLength(Value *L) {
160 assert(getLength()->getType() == L->getType() &&
161 "setLength called with value of wrong type!");
165 void setAlignment(Constant* A) {
169 void setVolatile(Constant* V) {
173 const Type *getAlignmentType() const {
174 return getArgOperand(3)->getType();
177 // Methods for support type inquiry through isa, cast, and dyn_cast:
178 static inline bool classof(const MemIntrinsic *) { return true; }
179 static inline bool classof(const IntrinsicInst *I) {
180 switch (I->getIntrinsicID()) {
181 case Intrinsic::memcpy:
182 case Intrinsic::memmove:
183 case Intrinsic::memset:
185 default: return false;
188 static inline bool classof(const Value *V) {
189 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
193 /// MemSetInst - This class wraps the llvm.memset intrinsic.
195 class MemSetInst : public MemIntrinsic {
197 /// get* - Return the arguments to the instruction.
199 Value *getValue() const { return const_cast<Value*>(getArgOperand(1)); }
201 void setValue(Value *Val) {
202 assert(getValue()->getType() == Val->getType() &&
203 "setValue called with value of wrong type!");
204 setArgOperand(1, Val);
207 // Methods for support type inquiry through isa, cast, and dyn_cast:
208 static inline bool classof(const MemSetInst *) { return true; }
209 static inline bool classof(const IntrinsicInst *I) {
210 return I->getIntrinsicID() == Intrinsic::memset;
212 static inline bool classof(const Value *V) {
213 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
217 /// MemTransferInst - This class wraps the llvm.memcpy/memmove intrinsics.
219 class MemTransferInst : public MemIntrinsic {
221 /// get* - Return the arguments to the instruction.
223 Value *getRawSource() const { return const_cast<Value*>(getArgOperand(1)); }
225 /// getSource - This is just like getRawSource, but it strips off any cast
226 /// instructions that feed it, giving the original input. The returned
227 /// value is guaranteed to be a pointer.
228 Value *getSource() const { return getRawSource()->stripPointerCasts(); }
230 unsigned getSourceAddressSpace() const {
231 return cast<PointerType>(getRawSource()->getType())->getAddressSpace();
234 void setSource(Value *Ptr) {
235 assert(getRawSource()->getType() == Ptr->getType() &&
236 "setSource called with pointer of wrong type!");
237 setArgOperand(1, Ptr);
240 // Methods for support type inquiry through isa, cast, and dyn_cast:
241 static inline bool classof(const MemTransferInst *) { return true; }
242 static inline bool classof(const IntrinsicInst *I) {
243 return I->getIntrinsicID() == Intrinsic::memcpy ||
244 I->getIntrinsicID() == Intrinsic::memmove;
246 static inline bool classof(const Value *V) {
247 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
252 /// MemCpyInst - This class wraps the llvm.memcpy intrinsic.
254 class MemCpyInst : public MemTransferInst {
256 // Methods for support type inquiry through isa, cast, and dyn_cast:
257 static inline bool classof(const MemCpyInst *) { return true; }
258 static inline bool classof(const IntrinsicInst *I) {
259 return I->getIntrinsicID() == Intrinsic::memcpy;
261 static inline bool classof(const Value *V) {
262 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
266 /// MemMoveInst - This class wraps the llvm.memmove intrinsic.
268 class MemMoveInst : public MemTransferInst {
270 // Methods for support type inquiry through isa, cast, and dyn_cast:
271 static inline bool classof(const MemMoveInst *) { return true; }
272 static inline bool classof(const IntrinsicInst *I) {
273 return I->getIntrinsicID() == Intrinsic::memmove;
275 static inline bool classof(const Value *V) {
276 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
280 /// EHExceptionInst - This represents the llvm.eh.exception instruction.
282 class EHExceptionInst : public IntrinsicInst {
284 // Methods for support type inquiry through isa, cast, and dyn_cast:
285 static inline bool classof(const EHExceptionInst *) { return true; }
286 static inline bool classof(const IntrinsicInst *I) {
287 return I->getIntrinsicID() == Intrinsic::eh_exception;
289 static inline bool classof(const Value *V) {
290 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
294 /// EHSelectorInst - This represents the llvm.eh.selector instruction.
296 class EHSelectorInst : public IntrinsicInst {
298 // Methods for support type inquiry through isa, cast, and dyn_cast:
299 static inline bool classof(const EHSelectorInst *) { return true; }
300 static inline bool classof(const IntrinsicInst *I) {
301 return I->getIntrinsicID() == Intrinsic::eh_selector;
303 static inline bool classof(const Value *V) {
304 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));