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/DerivedTypes.h"
29 #include "llvm/IR/Function.h"
30 #include "llvm/IR/GlobalVariable.h"
31 #include "llvm/IR/Instructions.h"
32 #include "llvm/IR/Intrinsics.h"
33 #include "llvm/IR/Metadata.h"
34 #include "llvm/IR/Value.h"
35 #include "llvm/Support/Casting.h"
41 /// A wrapper class for inspecting calls to intrinsic functions.
42 /// This allows the standard isa/dyncast/cast functionality to work with calls
43 /// to intrinsic functions.
44 class IntrinsicInst : public CallInst {
46 IntrinsicInst() = delete;
47 IntrinsicInst(const IntrinsicInst &) = delete;
48 IntrinsicInst &operator=(const IntrinsicInst &) = delete;
50 /// Return the intrinsic ID of this intrinsic.
51 Intrinsic::ID getIntrinsicID() const {
52 return getCalledFunction()->getIntrinsicID();
55 // Methods for support type inquiry through isa, cast, and dyn_cast:
56 static inline bool classof(const CallInst *I) {
57 if (const Function *CF = I->getCalledFunction())
58 return CF->isIntrinsic();
61 static inline bool classof(const Value *V) {
62 return isa<CallInst>(V) && classof(cast<CallInst>(V));
66 /// This is the common base class for debug info intrinsics.
67 class DbgInfoIntrinsic : public IntrinsicInst {
69 /// Get the location corresponding to the variable referenced by the debug
70 /// info intrinsic. Depending on the intrinsic, this could be the
71 /// variable's value or its address.
72 Value *getVariableLocation(bool AllowNullOp = true) const;
74 // Methods for support type inquiry through isa, cast, and dyn_cast:
75 static inline bool classof(const IntrinsicInst *I) {
76 switch (I->getIntrinsicID()) {
77 case Intrinsic::dbg_declare:
78 case Intrinsic::dbg_value:
80 default: return false;
83 static inline bool classof(const Value *V) {
84 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
88 /// This represents the llvm.dbg.declare instruction.
89 class DbgDeclareInst : public DbgInfoIntrinsic {
91 Value *getAddress() const { return getVariableLocation(); }
93 DILocalVariable *getVariable() const {
94 return cast<DILocalVariable>(getRawVariable());
97 DIExpression *getExpression() const {
98 return cast<DIExpression>(getRawExpression());
101 Metadata *getRawVariable() const {
102 return cast<MetadataAsValue>(getArgOperand(1))->getMetadata();
105 Metadata *getRawExpression() const {
106 return cast<MetadataAsValue>(getArgOperand(2))->getMetadata();
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_declare;
113 static inline bool classof(const Value *V) {
114 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
118 /// This represents the llvm.dbg.value instruction.
119 class DbgValueInst : public DbgInfoIntrinsic {
121 Value *getValue() const {
122 return getVariableLocation(/* AllowNullOp = */ false);
125 uint64_t getOffset() const {
126 return cast<ConstantInt>(
127 const_cast<Value*>(getArgOperand(1)))->getZExtValue();
130 DILocalVariable *getVariable() const {
131 return cast<DILocalVariable>(getRawVariable());
134 DIExpression *getExpression() const {
135 return cast<DIExpression>(getRawExpression());
138 Metadata *getRawVariable() const {
139 return cast<MetadataAsValue>(getArgOperand(2))->getMetadata();
142 Metadata *getRawExpression() const {
143 return cast<MetadataAsValue>(getArgOperand(3))->getMetadata();
146 // Methods for support type inquiry through isa, cast, and dyn_cast:
147 static inline bool classof(const IntrinsicInst *I) {
148 return I->getIntrinsicID() == Intrinsic::dbg_value;
150 static inline bool classof(const Value *V) {
151 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
155 /// This is the common base class for memset/memcpy/memmove.
156 class MemIntrinsic : public IntrinsicInst {
158 Value *getRawDest() const { return const_cast<Value*>(getArgOperand(0)); }
159 const Use &getRawDestUse() const { return getArgOperandUse(0); }
160 Use &getRawDestUse() { return getArgOperandUse(0); }
162 Value *getLength() const { return const_cast<Value*>(getArgOperand(2)); }
163 const Use &getLengthUse() const { return getArgOperandUse(2); }
164 Use &getLengthUse() { return getArgOperandUse(2); }
166 ConstantInt *getAlignmentCst() const {
167 return cast<ConstantInt>(const_cast<Value*>(getArgOperand(3)));
170 unsigned getAlignment() const {
171 return getAlignmentCst()->getZExtValue();
174 ConstantInt *getVolatileCst() const {
175 return cast<ConstantInt>(const_cast<Value*>(getArgOperand(4)));
178 bool isVolatile() const {
179 return !getVolatileCst()->isZero();
182 unsigned getDestAddressSpace() const {
183 return cast<PointerType>(getRawDest()->getType())->getAddressSpace();
186 /// This is just like getRawDest, but it strips off any cast
187 /// instructions that feed it, giving the original input. The returned
188 /// value is guaranteed to be a pointer.
189 Value *getDest() const { return getRawDest()->stripPointerCasts(); }
191 /// Set the specified arguments of the instruction.
192 void setDest(Value *Ptr) {
193 assert(getRawDest()->getType() == Ptr->getType() &&
194 "setDest called with pointer of wrong type!");
195 setArgOperand(0, Ptr);
198 void setLength(Value *L) {
199 assert(getLength()->getType() == L->getType() &&
200 "setLength called with value of wrong type!");
204 void setAlignment(Constant* A) {
208 void setVolatile(Constant* V) {
212 Type *getAlignmentType() const {
213 return getArgOperand(3)->getType();
216 // Methods for support type inquiry through isa, cast, and dyn_cast:
217 static inline bool classof(const IntrinsicInst *I) {
218 switch (I->getIntrinsicID()) {
219 case Intrinsic::memcpy:
220 case Intrinsic::memmove:
221 case Intrinsic::memset:
223 default: return false;
226 static inline bool classof(const Value *V) {
227 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
231 /// This class wraps the llvm.memset intrinsic.
232 class MemSetInst : public MemIntrinsic {
234 /// Return the arguments to the instruction.
235 Value *getValue() const { return const_cast<Value*>(getArgOperand(1)); }
236 const Use &getValueUse() const { return getArgOperandUse(1); }
237 Use &getValueUse() { return getArgOperandUse(1); }
239 void setValue(Value *Val) {
240 assert(getValue()->getType() == Val->getType() &&
241 "setValue called with value of wrong type!");
242 setArgOperand(1, Val);
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::memset;
249 static inline bool classof(const Value *V) {
250 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
254 /// This class wraps the llvm.memcpy/memmove intrinsics.
255 class MemTransferInst : public MemIntrinsic {
257 /// Return the arguments to the instruction.
258 Value *getRawSource() const { return const_cast<Value*>(getArgOperand(1)); }
259 const Use &getRawSourceUse() const { return getArgOperandUse(1); }
260 Use &getRawSourceUse() { return getArgOperandUse(1); }
262 /// This is just like getRawSource, but it strips off any cast
263 /// instructions that feed it, giving the original input. The returned
264 /// value is guaranteed to be a pointer.
265 Value *getSource() const { return getRawSource()->stripPointerCasts(); }
267 unsigned getSourceAddressSpace() const {
268 return cast<PointerType>(getRawSource()->getType())->getAddressSpace();
271 void setSource(Value *Ptr) {
272 assert(getRawSource()->getType() == Ptr->getType() &&
273 "setSource called with pointer of wrong type!");
274 setArgOperand(1, Ptr);
277 // Methods for support type inquiry through isa, cast, and dyn_cast:
278 static inline bool classof(const IntrinsicInst *I) {
279 return I->getIntrinsicID() == Intrinsic::memcpy ||
280 I->getIntrinsicID() == Intrinsic::memmove;
282 static inline bool classof(const Value *V) {
283 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
287 /// This class wraps the llvm.memcpy intrinsic.
288 class MemCpyInst : public MemTransferInst {
290 // Methods for support type inquiry through isa, cast, and dyn_cast:
291 static inline bool classof(const IntrinsicInst *I) {
292 return I->getIntrinsicID() == Intrinsic::memcpy;
294 static inline bool classof(const Value *V) {
295 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
299 /// This class wraps the llvm.memmove intrinsic.
300 class MemMoveInst : public MemTransferInst {
302 // Methods for support type inquiry through isa, cast, and dyn_cast:
303 static inline bool classof(const IntrinsicInst *I) {
304 return I->getIntrinsicID() == Intrinsic::memmove;
306 static inline bool classof(const Value *V) {
307 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
311 /// This represents the llvm.va_start intrinsic.
312 class VAStartInst : public IntrinsicInst {
314 static inline bool classof(const IntrinsicInst *I) {
315 return I->getIntrinsicID() == Intrinsic::vastart;
317 static inline bool classof(const Value *V) {
318 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
321 Value *getArgList() const { return const_cast<Value*>(getArgOperand(0)); }
324 /// This represents the llvm.va_end intrinsic.
325 class VAEndInst : public IntrinsicInst {
327 static inline bool classof(const IntrinsicInst *I) {
328 return I->getIntrinsicID() == Intrinsic::vaend;
330 static inline bool classof(const Value *V) {
331 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
334 Value *getArgList() const { return const_cast<Value*>(getArgOperand(0)); }
337 /// This represents the llvm.va_copy intrinsic.
338 class VACopyInst : public IntrinsicInst {
340 static inline bool classof(const IntrinsicInst *I) {
341 return I->getIntrinsicID() == Intrinsic::vacopy;
343 static inline bool classof(const Value *V) {
344 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
347 Value *getDest() const { return const_cast<Value*>(getArgOperand(0)); }
348 Value *getSrc() const { return const_cast<Value*>(getArgOperand(1)); }
351 /// This represents the llvm.instrprof_increment intrinsic.
352 class InstrProfIncrementInst : public IntrinsicInst {
354 static inline bool classof(const IntrinsicInst *I) {
355 return I->getIntrinsicID() == Intrinsic::instrprof_increment;
357 static inline bool classof(const Value *V) {
358 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
361 GlobalVariable *getName() const {
362 return cast<GlobalVariable>(
363 const_cast<Value *>(getArgOperand(0))->stripPointerCasts());
366 ConstantInt *getHash() const {
367 return cast<ConstantInt>(const_cast<Value *>(getArgOperand(1)));
370 ConstantInt *getNumCounters() const {
371 return cast<ConstantInt>(const_cast<Value *>(getArgOperand(2)));
374 ConstantInt *getIndex() const {
375 return cast<ConstantInt>(const_cast<Value *>(getArgOperand(3)));
378 Value *getStep() const;
381 class InstrProfIncrementInstStep : public InstrProfIncrementInst {
383 static inline bool classof(const IntrinsicInst *I) {
384 return I->getIntrinsicID() == Intrinsic::instrprof_increment_step;
386 static inline bool classof(const Value *V) {
387 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
391 /// This represents the llvm.instrprof_value_profile intrinsic.
392 class InstrProfValueProfileInst : public IntrinsicInst {
394 static inline bool classof(const IntrinsicInst *I) {
395 return I->getIntrinsicID() == Intrinsic::instrprof_value_profile;
397 static inline bool classof(const Value *V) {
398 return isa<IntrinsicInst>(V) && classof(cast<IntrinsicInst>(V));
401 GlobalVariable *getName() const {
402 return cast<GlobalVariable>(
403 const_cast<Value *>(getArgOperand(0))->stripPointerCasts());
406 ConstantInt *getHash() const {
407 return cast<ConstantInt>(const_cast<Value *>(getArgOperand(1)));
410 Value *getTargetValue() const {
411 return cast<Value>(const_cast<Value *>(getArgOperand(2)));
414 ConstantInt *getValueKind() const {
415 return cast<ConstantInt>(const_cast<Value *>(getArgOperand(3)));
418 // Returns the value site index.
419 ConstantInt *getIndex() const {
420 return cast<ConstantInt>(const_cast<Value *>(getArgOperand(4)));
424 } // end namespace llvm
426 #endif // LLVM_IR_INTRINSICINST_H