include/llvm/iMemory.h

   1 //===-- llvm/iMemory.h - Memory Operator node definitions --------*- C++ -*--=//
   2 //
   3 // This file contains the declarations of all of the memory related operators.
   4 // This includes: malloc, free, alloca, load, store, getfield, putfield
   5 //
   6 //===----------------------------------------------------------------------===//
   7
   8 #ifndef LLVM_IMEMORY_H
   9 #define LLVM_IMEMORY_H
  10
  11 #include "llvm/Instruction.h"
  12 class PointerType;
  13
  14 //===----------------------------------------------------------------------===//
  15 //                             AllocationInst Class
  16 //===----------------------------------------------------------------------===//
  17 //
  18 // AllocationInst - This class is the common base class of MallocInst and
  19 // AllocaInst.
  20 //
  21 class AllocationInst : public Instruction {
  22 protected:
  23   AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy,
  24                  const std::string &Name = "", Instruction *InsertBefore = 0);
  25 public:
  26
  27   // isArrayAllocation - Return true if there is an allocation size parameter
  28   // to the allocation instruction that is not 1.
  29   //
  30   bool isArrayAllocation() const;
  31
  32   // getArraySize - Get the number of element allocated, for a simple allocation
  33   // of a single element, this will return a constant 1 value.
  34   //
  35   inline const Value *getArraySize() const { return Operands[0]; }
  36   inline Value *getArraySize() { return Operands[0]; }
  37
  38   // getType - Overload to return most specific pointer type...
  39   inline const PointerType *getType() const {
  40     return (const PointerType*)Instruction::getType();
  41   }
  42
  43   // getAllocatedType - Return the type that is being allocated by the
  44   // instruction.
  45   //
  46   const Type *getAllocatedType() const;
  47
  48   virtual Instruction *clone() const = 0;
  49
  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;
  55   }
  56   static inline bool classof(const Value *V) {
  57     return isa<Instruction>(V) && classof(cast<Instruction>(V));
  58   }
  59 };
  60
  61
  62 //===----------------------------------------------------------------------===//
  63 //                                MallocInst Class
  64 //===----------------------------------------------------------------------===//
  65
  66 class MallocInst : public AllocationInst {
  67   MallocInst(const MallocInst &MI);
  68 public:
  69   MallocInst(const Type *Ty, Value *ArraySize = 0, const std::string &Name = "",
  70              Instruction *InsertBefore = 0)
  71     : AllocationInst(Ty, ArraySize, Malloc, Name, InsertBefore) {}
  72
  73   virtual Instruction *clone() const {
  74     return new MallocInst(*this);
  75   }
  76
  77   // Methods for support type inquiry through isa, cast, and dyn_cast:
  78   static inline bool classof(const MallocInst *) { return true; }
  79   static inline bool classof(const Instruction *I) {
  80     return (I->getOpcode() == Instruction::Malloc);
  81   }
  82   static inline bool classof(const Value *V) {
  83     return isa<Instruction>(V) && classof(cast<Instruction>(V));
  84   }
  85 };
  86
  87
  88 //===----------------------------------------------------------------------===//
  89 //                                AllocaInst Class
  90 //===----------------------------------------------------------------------===//
  91
  92 class AllocaInst : public AllocationInst {
  93   AllocaInst(const AllocaInst &);
  94 public:
  95   AllocaInst(const Type *Ty, Value *ArraySize = 0, const std::string &Name = "",
  96              Instruction *InsertBefore = 0)
  97     : AllocationInst(Ty, ArraySize, Alloca, Name, InsertBefore) {}
  98
  99   virtual Instruction *clone() const {
 100     return new AllocaInst(*this);
 101   }
 102
 103   // Methods for support type inquiry through isa, cast, and dyn_cast:
 104   static inline bool classof(const AllocaInst *) { return true; }
 105   static inline bool classof(const Instruction *I) {
 106     return (I->getOpcode() == Instruction::Alloca);
 107   }
 108   static inline bool classof(const Value *V) {
 109     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 110   }
 111 };
 112
 113
 114 //===----------------------------------------------------------------------===//
 115 //                                 FreeInst Class
 116 //===----------------------------------------------------------------------===//
 117
 118 struct FreeInst : public Instruction {
 119   FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
 120
 121   virtual Instruction *clone() const { return new FreeInst(Operands[0]); }
 122
 123   virtual bool hasSideEffects() const { return true; }
 124
 125   // Methods for support type inquiry through isa, cast, and dyn_cast:
 126   static inline bool classof(const FreeInst *) { return true; }
 127   static inline bool classof(const Instruction *I) {
 128     return (I->getOpcode() == Instruction::Free);
 129   }
 130   static inline bool classof(const Value *V) {
 131     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 132   }
 133 };
 134
 135
 136 //===----------------------------------------------------------------------===//
 137 //                                LoadInst Class
 138 //===----------------------------------------------------------------------===//
 139
 140 class LoadInst : public Instruction {
 141   LoadInst(const LoadInst &LI) : Instruction(LI.getType(), Load) {
 142     Operands.reserve(1);
 143     Operands.push_back(Use(LI.Operands[0], this));
 144   }
 145 public:
 146   LoadInst(Value *Ptr, const std::string &Name = "",
 147            Instruction *InsertBefore = 0);
 148
 149   virtual Instruction *clone() const { return new LoadInst(*this); }
 150
 151   Value *getPointerOperand() { return getOperand(0); }
 152   const Value *getPointerOperand() const { return getOperand(0); }
 153
 154   // Methods for support type inquiry through isa, cast, and dyn_cast:
 155   static inline bool classof(const LoadInst *) { return true; }
 156   static inline bool classof(const Instruction *I) {
 157     return (I->getOpcode() == Instruction::Load);
 158   }
 159   static inline bool classof(const Value *V) {
 160     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 161   }
 162 };
 163
 164
 165 //===----------------------------------------------------------------------===//
 166 //                                StoreInst Class
 167 //===----------------------------------------------------------------------===//
 168
 169 class StoreInst : public Instruction {
 170   StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store) {
 171     Operands.reserve(2);
 172     Operands.push_back(Use(SI.Operands[0], this));
 173     Operands.push_back(Use(SI.Operands[1], this));
 174   }
 175 public:
 176   StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore = 0);
 177   virtual Instruction *clone() const { return new StoreInst(*this); }
 178
 179   virtual bool hasSideEffects() const { return true; }
 180
 181   Value *getPointerOperand() { return getOperand(1); }
 182   const Value *getPointerOperand() const { return getOperand(1); }
 183
 184   // Methods for support type inquiry through isa, cast, and dyn_cast:
 185   static inline bool classof(const StoreInst *) { return true; }
 186   static inline bool classof(const Instruction *I) {
 187     return (I->getOpcode() == Instruction::Store);
 188   }
 189   static inline bool classof(const Value *V) {
 190     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 191   }
 192 };
 193
 194
 195 //===----------------------------------------------------------------------===//
 196 //                             GetElementPtrInst Class
 197 //===----------------------------------------------------------------------===//
 198
 199 class GetElementPtrInst : public Instruction {
 200   GetElementPtrInst(const GetElementPtrInst &EPI)
 201     : Instruction((Type*)EPI.getType(), GetElementPtr) {
 202     Operands.reserve(EPI.Operands.size());
 203     for (unsigned i = 0, E = EPI.Operands.size(); i != E; ++i)
 204       Operands.push_back(Use(EPI.Operands[i], this));
 205   }
 206 public:
 207   GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
 208                     const std::string &Name = "", Instruction *InsertBefore =0);
 209   virtual Instruction *clone() const { return new GetElementPtrInst(*this); }
 210
 211   // getType - Overload to return most specific pointer type...
 212   inline const PointerType *getType() const {
 213     return (PointerType*)Instruction::getType();
 214   }
 215
 216   /// getIndexedType - Returns the type of the element that would be loaded with
 217   /// a load instruction with the specified parameters.
 218   ///
 219   /// A null type is returned if the indices are invalid for the specified
 220   /// pointer type.
 221   ///
 222   static const Type *getIndexedType(const Type *Ptr,
 223                                     const std::vector<Value*> &Indices,
 224                                     bool AllowStructLeaf = false);
 225
 226   inline op_iterator       idx_begin()       {
 227     return op_begin()+1;
 228   }
 229   inline const_op_iterator idx_begin() const {
 230     return op_begin()+1;
 231   }
 232   inline op_iterator       idx_end()         { return op_end(); }
 233   inline const_op_iterator idx_end()   const { return op_end(); }
 234
 235   Value *getPointerOperand() {
 236     return getOperand(0);
 237   }
 238   const Value *getPointerOperand() const {
 239     return getOperand(0);
 240   }
 241
 242   inline unsigned getNumIndices() const {  // Note: always non-negative
 243     return getNumOperands() - 1;
 244   }
 245
 246   inline bool hasIndices() const {
 247     return getNumOperands() > 1;
 248   }
 249
 250   // Methods for support type inquiry through isa, cast, and dyn_cast:
 251   static inline bool classof(const GetElementPtrInst *) { return true; }
 252   static inline bool classof(const Instruction *I) {
 253     return (I->getOpcode() == Instruction::GetElementPtr);
 254   }
 255   static inline bool classof(const Value *V) {
 256     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 257   }
 258 };
 259
 260 #endif // LLVM_IMEMORY_H