1 //===-- llvm/iMemory.h - Memory Operator node definitions --------*- C++ -*--=//
3 // This file contains the declarations of all of the memory related operators.
4 // This includes: malloc, free, alloca, load, store, getfield, putfield
6 //===----------------------------------------------------------------------===//
11 #include "llvm/Instruction.h"
14 //===----------------------------------------------------------------------===//
15 // AllocationInst Class
16 //===----------------------------------------------------------------------===//
18 // AllocationInst - This class is the common base class of MallocInst and
21 class AllocationInst : public Instruction {
23 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy,
24 const std::string &Name = "");
27 // isArrayAllocation - Return true if there is an allocation size parameter
28 // to the allocation instruction that is not 1.
30 bool isArrayAllocation() const;
32 // getArraySize - Get the number of element allocated, for a simple allocation
33 // of a single element, this will return a constant 1 value.
35 inline const Value *getArraySize() const { return Operands[0]; }
36 inline Value *getArraySize() { return Operands[0]; }
38 // getType - Overload to return most specific pointer type...
39 inline const PointerType *getType() const {
40 return (const PointerType*)Instruction::getType();
43 // getAllocatedType - Return the type that is being allocated by the
46 const Type *getAllocatedType() const;
48 virtual Instruction *clone() const = 0;
50 // Methods for support type inquiry through isa, cast, and dyn_cast:
51 static inline bool classof(const AllocationInst *) { return true; }
52 static inline bool classof(const Instruction *I) {
53 return I->getOpcode() == Instruction::Alloca ||
54 I->getOpcode() == Instruction::Malloc;
56 static inline bool classof(const Value *V) {
57 return isa<Instruction>(V) && classof(cast<Instruction>(V));
62 //===----------------------------------------------------------------------===//
64 //===----------------------------------------------------------------------===//
66 struct MallocInst : public AllocationInst {
67 MallocInst(const Type *Ty, Value *ArraySize = 0, const std::string &Name = "")
68 : AllocationInst(Ty, ArraySize, Malloc, Name) {}
70 virtual Instruction *clone() const {
71 return new MallocInst((Type*)getType(), (Value*)Operands[0].get());
74 // Methods for support type inquiry through isa, cast, and dyn_cast:
75 static inline bool classof(const MallocInst *) { return true; }
76 static inline bool classof(const Instruction *I) {
77 return (I->getOpcode() == Instruction::Malloc);
79 static inline bool classof(const Value *V) {
80 return isa<Instruction>(V) && classof(cast<Instruction>(V));
85 //===----------------------------------------------------------------------===//
87 //===----------------------------------------------------------------------===//
89 struct AllocaInst : public AllocationInst {
90 AllocaInst(const Type *Ty, Value *ArraySize = 0, const std::string &Name = "")
91 : AllocationInst(Ty, ArraySize, Alloca, Name) {}
93 virtual Instruction *clone() const {
94 return new AllocaInst((Type*)getType(), (Value*)Operands[0].get());
97 // Methods for support type inquiry through isa, cast, and dyn_cast:
98 static inline bool classof(const AllocaInst *) { return true; }
99 static inline bool classof(const Instruction *I) {
100 return (I->getOpcode() == Instruction::Alloca);
102 static inline bool classof(const Value *V) {
103 return isa<Instruction>(V) && classof(cast<Instruction>(V));
108 //===----------------------------------------------------------------------===//
110 //===----------------------------------------------------------------------===//
112 struct FreeInst : public Instruction {
113 FreeInst(Value *Ptr);
115 virtual Instruction *clone() const { return new FreeInst(Operands[0]); }
117 virtual bool hasSideEffects() const { return true; }
119 // Methods for support type inquiry through isa, cast, and dyn_cast:
120 static inline bool classof(const FreeInst *) { return true; }
121 static inline bool classof(const Instruction *I) {
122 return (I->getOpcode() == Instruction::Free);
124 static inline bool classof(const Value *V) {
125 return isa<Instruction>(V) && classof(cast<Instruction>(V));
130 //===----------------------------------------------------------------------===//
132 //===----------------------------------------------------------------------===//
134 class LoadInst : public Instruction {
135 LoadInst(const LoadInst &LI) : Instruction(LI.getType(), Load) {
137 Operands.push_back(Use(LI.Operands[0], this));
140 LoadInst(Value *Ptr, const std::string &Name = "");
142 virtual Instruction *clone() const { return new LoadInst(*this); }
144 Value *getPointerOperand() { return getOperand(0); }
145 const Value *getPointerOperand() const { return getOperand(0); }
147 // Methods for support type inquiry through isa, cast, and dyn_cast:
148 static inline bool classof(const LoadInst *) { return true; }
149 static inline bool classof(const Instruction *I) {
150 return (I->getOpcode() == Instruction::Load);
152 static inline bool classof(const Value *V) {
153 return isa<Instruction>(V) && classof(cast<Instruction>(V));
158 //===----------------------------------------------------------------------===//
160 //===----------------------------------------------------------------------===//
162 class StoreInst : public Instruction {
163 StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store) {
165 Operands.push_back(Use(SI.Operands[0], this));
166 Operands.push_back(Use(SI.Operands[1], this));
169 StoreInst(Value *Val, Value *Ptr);
170 virtual Instruction *clone() const { return new StoreInst(*this); }
172 virtual bool hasSideEffects() const { return true; }
174 Value *getPointerOperand() { return getOperand(1); }
175 const Value *getPointerOperand() const { return getOperand(1); }
177 // Methods for support type inquiry through isa, cast, and dyn_cast:
178 static inline bool classof(const StoreInst *) { return true; }
179 static inline bool classof(const Instruction *I) {
180 return (I->getOpcode() == Instruction::Store);
182 static inline bool classof(const Value *V) {
183 return isa<Instruction>(V) && classof(cast<Instruction>(V));
188 //===----------------------------------------------------------------------===//
189 // GetElementPtrInst Class
190 //===----------------------------------------------------------------------===//
192 class GetElementPtrInst : public Instruction {
193 GetElementPtrInst(const GetElementPtrInst &EPI)
194 : Instruction((Type*)EPI.getType(), GetElementPtr) {
195 Operands.reserve(EPI.Operands.size());
196 for (unsigned i = 0, E = EPI.Operands.size(); i != E; ++i)
197 Operands.push_back(Use(EPI.Operands[i], this));
200 GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
201 const std::string &Name = "");
202 virtual Instruction *clone() const { return new GetElementPtrInst(*this); }
204 // getType - Overload to return most specific pointer type...
205 inline const PointerType *getType() const {
206 return (PointerType*)Instruction::getType();
209 /// getIndexedType - Returns the type of the element that would be loaded with
210 /// a load instruction with the specified parameters.
212 /// A null type is returned if the indices are invalid for the specified
215 static const Type *getIndexedType(const Type *Ptr,
216 const std::vector<Value*> &Indices,
217 bool AllowStructLeaf = false);
219 inline op_iterator idx_begin() {
222 inline const_op_iterator idx_begin() const {
225 inline op_iterator idx_end() { return op_end(); }
226 inline const_op_iterator idx_end() const { return op_end(); }
228 Value *getPointerOperand() {
229 return getOperand(0);
231 const Value *getPointerOperand() const {
232 return getOperand(0);
235 inline unsigned getNumIndices() const { // Note: always non-negative
236 return getNumOperands() - 1;
239 inline bool hasIndices() const {
240 return getNumOperands() > 1;
243 // Methods for support type inquiry through isa, cast, and dyn_cast:
244 static inline bool classof(const GetElementPtrInst *) { return true; }
245 static inline bool classof(const Instruction *I) {
246 return (I->getOpcode() == Instruction::GetElementPtr);
248 static inline bool classof(const Value *V) {
249 return isa<Instruction>(V) && classof(cast<Instruction>(V));
253 #endif // LLVM_IMEMORY_H