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() 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->getIntrinsicID() != 0;
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)); }
86 // Methods for support type inquiry through isa, cast, and dyn_cast:
87 static inline bool classof(const IntrinsicInst *I) {
88 return I->getIntrinsicID() == Intrinsic::dbg_declare;
90 static inline bool classof(const Value *V) {
91 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
95 /// DbgValueInst - This represents the llvm.dbg.value instruction.
97 class DbgValueInst : public DbgInfoIntrinsic {
99 const Value *getValue() const;
101 uint64_t getOffset() const {
102 return cast<ConstantInt>(
103 const_cast<Value*>(getArgOperand(1)))->getZExtValue();
105 MDNode *getVariable() const { return cast<MDNode>(getArgOperand(2)); }
107 // Methods for support type inquiry through isa, cast, and dyn_cast:
108 static inline bool classof(const IntrinsicInst *I) {
109 return I->getIntrinsicID() == Intrinsic::dbg_value;
111 static inline bool classof(const Value *V) {
112 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
116 /// MemIntrinsic - This is the common base class for memset/memcpy/memmove.
118 class MemIntrinsic : public IntrinsicInst {
120 Value *getRawDest() const { return const_cast<Value*>(getArgOperand(0)); }
122 Value *getLength() const { return const_cast<Value*>(getArgOperand(2)); }
123 ConstantInt *getAlignmentCst() const {
124 return cast<ConstantInt>(const_cast<Value*>(getArgOperand(3)));
127 unsigned getAlignment() const {
128 return getAlignmentCst()->getZExtValue();
131 ConstantInt *getVolatileCst() const {
132 return cast<ConstantInt>(const_cast<Value*>(getArgOperand(4)));
134 bool isVolatile() const {
135 return !getVolatileCst()->isZero();
138 unsigned getDestAddressSpace() const {
139 return cast<PointerType>(getRawDest()->getType())->getAddressSpace();
142 /// getDest - This is just like getRawDest, but it strips off any cast
143 /// instructions that feed it, giving the original input. The returned
144 /// value is guaranteed to be a pointer.
145 Value *getDest() const { return getRawDest()->stripPointerCasts(); }
147 /// set* - Set the specified arguments of the instruction.
149 void setDest(Value *Ptr) {
150 assert(getRawDest()->getType() == Ptr->getType() &&
151 "setDest called with pointer of wrong type!");
152 setArgOperand(0, Ptr);
155 void setLength(Value *L) {
156 assert(getLength()->getType() == L->getType() &&
157 "setLength called with value of wrong type!");
161 void setAlignment(Constant* A) {
165 void setVolatile(Constant* V) {
169 Type *getAlignmentType() const {
170 return getArgOperand(3)->getType();
173 // Methods for support type inquiry through isa, cast, and dyn_cast:
174 static inline bool classof(const IntrinsicInst *I) {
175 switch (I->getIntrinsicID()) {
176 case Intrinsic::memcpy:
177 case Intrinsic::memmove:
178 case Intrinsic::memset:
180 default: return false;
183 static inline bool classof(const Value *V) {
184 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
188 /// MemSetInst - This class wraps the llvm.memset intrinsic.
190 class MemSetInst : public MemIntrinsic {
192 /// get* - Return the arguments to the instruction.
194 Value *getValue() const { return const_cast<Value*>(getArgOperand(1)); }
196 void setValue(Value *Val) {
197 assert(getValue()->getType() == Val->getType() &&
198 "setValue called with value of wrong type!");
199 setArgOperand(1, Val);
202 // Methods for support type inquiry through isa, cast, and dyn_cast:
203 static inline bool classof(const IntrinsicInst *I) {
204 return I->getIntrinsicID() == Intrinsic::memset;
206 static inline bool classof(const Value *V) {
207 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
211 /// MemTransferInst - This class wraps the llvm.memcpy/memmove intrinsics.
213 class MemTransferInst : public MemIntrinsic {
215 /// get* - Return the arguments to the instruction.
217 Value *getRawSource() const { return const_cast<Value*>(getArgOperand(1)); }
219 /// getSource - This is just like getRawSource, but it strips off any cast
220 /// instructions that feed it, giving the original input. The returned
221 /// value is guaranteed to be a pointer.
222 Value *getSource() const { return getRawSource()->stripPointerCasts(); }
224 unsigned getSourceAddressSpace() const {
225 return cast<PointerType>(getRawSource()->getType())->getAddressSpace();
228 void setSource(Value *Ptr) {
229 assert(getRawSource()->getType() == Ptr->getType() &&
230 "setSource called with pointer of wrong type!");
231 setArgOperand(1, Ptr);
234 // Methods for support type inquiry through isa, cast, and dyn_cast:
235 static inline bool classof(const IntrinsicInst *I) {
236 return I->getIntrinsicID() == Intrinsic::memcpy ||
237 I->getIntrinsicID() == Intrinsic::memmove;
239 static inline bool classof(const Value *V) {
240 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
245 /// MemCpyInst - This class wraps the llvm.memcpy intrinsic.
247 class MemCpyInst : public MemTransferInst {
249 // Methods for support type inquiry through isa, cast, and dyn_cast:
250 static inline bool classof(const IntrinsicInst *I) {
251 return I->getIntrinsicID() == Intrinsic::memcpy;
253 static inline bool classof(const Value *V) {
254 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
258 /// MemMoveInst - This class wraps the llvm.memmove intrinsic.
260 class MemMoveInst : public MemTransferInst {
262 // Methods for support type inquiry through isa, cast, and dyn_cast:
263 static inline bool classof(const IntrinsicInst *I) {
264 return I->getIntrinsicID() == Intrinsic::memmove;
266 static inline bool classof(const Value *V) {
267 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));