include/llvm/CodeGen/MachineMemOperand.h

   1 //==- llvm/CodeGen/MachineMemOperand.h - MachineMemOperand class -*- C++ -*-==//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the declaration of the MachineMemOperand class, which is a
  11 // description of a memory reference. It is used to help track dependencies
  12 // in the backend.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_CODEGEN_MACHINEMEMOPERAND_H
  17 #define LLVM_CODEGEN_MACHINEMEMOPERAND_H
  18
  19 #include "llvm/System/DataTypes.h"
  20
  21 namespace llvm {
  22
  23 class Value;
  24 class FoldingSetNodeID;
  25 class raw_ostream;
  26
  27 /// MachinePointerInfo - This class contains a discriminated union of
  28 /// information about pointers in memory operands, relating them back to LLVM IR
  29 /// or to virtual locations (such as frame indices) that are exposed during
  30 /// codegen.
  31 struct MachinePointerInfo {
  32   /// V - This is the IR pointer value for the access, or it is null if unknown.
  33   /// If this is null, then the access is to a pointer in the default address
  34   /// space.
  35   const Value *V;
  36
  37   /// Offset - This is an offset from the base Value*.
  38   int64_t Offset;
  39
  40   explicit MachinePointerInfo(const Value *v, int64_t offset = 0)
  41     : V(v), Offset(offset) {}
  42 };
  43
  44
  45 //===----------------------------------------------------------------------===//
  46 /// MachineMemOperand - A description of a memory reference used in the backend.
  47 /// Instead of holding a StoreInst or LoadInst, this class holds the address
  48 /// Value of the reference along with a byte size and offset. This allows it
  49 /// to describe lowered loads and stores. Also, the special PseudoSourceValue
  50 /// objects can be used to represent loads and stores to memory locations
  51 /// that aren't explicit in the regular LLVM IR.
  52 ///
  53 class MachineMemOperand {
  54   MachinePointerInfo PtrInfo;
  55   uint64_t Size;
  56   unsigned Flags;
  57
  58 public:
  59   /// Flags values. These may be or'd together.
  60   enum MemOperandFlags {
  61     /// The memory access reads data.
  62     MOLoad = 1,
  63     /// The memory access writes data.
  64     MOStore = 2,
  65     /// The memory access is volatile.
  66     MOVolatile = 4,
  67     /// The memory access is non-temporal.
  68     MONonTemporal = 8,
  69     // This is the number of bits we need to represent flags.
  70     MOMaxBits = 4
  71   };
  72
  73   /// MachineMemOperand - Construct an MachineMemOperand object with the
  74   /// specified PtrInfo, flags, size, and base alignment.
  75   MachineMemOperand(MachinePointerInfo PtrInfo, unsigned flags, uint64_t s,
  76                     unsigned base_alignment);
  77
  78   const MachinePointerInfo &getPointerInfo() const { return PtrInfo; }
  79
  80   /// getValue - Return the base address of the memory access. This may either
  81   /// be a normal LLVM IR Value, or one of the special values used in CodeGen.
  82   /// Special values are those obtained via
  83   /// PseudoSourceValue::getFixedStack(int), PseudoSourceValue::getStack, and
  84   /// other PseudoSourceValue member functions which return objects which stand
  85   /// for frame/stack pointer relative references and other special references
  86   /// which are not representable in the high-level IR.
  87   const Value *getValue() const { return PtrInfo.V; }
  88
  89   /// getFlags - Return the raw flags of the source value, \see MemOperandFlags.
  90   unsigned int getFlags() const { return Flags & ((1 << MOMaxBits) - 1); }
  91
  92   /// getOffset - For normal values, this is a byte offset added to the base
  93   /// address. For PseudoSourceValue::FPRel values, this is the FrameIndex
  94   /// number.
  95   int64_t getOffset() const { return PtrInfo.Offset; }
  96
  97   /// getSize - Return the size in bytes of the memory reference.
  98   uint64_t getSize() const { return Size; }
  99
 100   /// getAlignment - Return the minimum known alignment in bytes of the
 101   /// actual memory reference.
 102   uint64_t getAlignment() const;
 103
 104   /// getBaseAlignment - Return the minimum known alignment in bytes of the
 105   /// base address, without the offset.
 106   uint64_t getBaseAlignment() const { return (1u << (Flags >> MOMaxBits)) >> 1; }
 107
 108   bool isLoad() const { return Flags & MOLoad; }
 109   bool isStore() const { return Flags & MOStore; }
 110   bool isVolatile() const { return Flags & MOVolatile; }
 111   bool isNonTemporal() const { return Flags & MONonTemporal; }
 112
 113   /// refineAlignment - Update this MachineMemOperand to reflect the alignment
 114   /// of MMO, if it has a greater alignment. This must only be used when the
 115   /// new alignment applies to all users of this MachineMemOperand.
 116   void refineAlignment(const MachineMemOperand *MMO);
 117
 118   /// setValue - Change the SourceValue for this MachineMemOperand. This
 119   /// should only be used when an object is being relocated and all references
 120   /// to it are being updated.
 121   void setValue(const Value *NewSV) { PtrInfo.V = NewSV; }
 122   void setOffset(int64_t NewOffset) { PtrInfo.Offset = NewOffset; }
 123
 124   /// Profile - Gather unique data for the object.
 125   ///
 126   void Profile(FoldingSetNodeID &ID) const;
 127 };
 128
 129 raw_ostream &operator<<(raw_ostream &OS, const MachineMemOperand &MRO);
 130
 131 } // End llvm namespace
 132
 133 #endif