1 //==- llvm/CodeGen/MachineMemOperand.h - MachineMemOperand class -*- C++ -*-==//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains the declaration of the MachineMemOperand class, which is a
10 // description of a memory reference. It is used to help track dependencies
11 // in the backend.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_CODEGEN_MACHINEMEMOPERAND_H
16 #define LLVM_CODEGEN_MACHINEMEMOPERAND_H
17 
18 #include "llvm/ADT/BitmaskEnum.h"
19 #include "llvm/ADT/PointerUnion.h"
20 #include "llvm/CodeGen/PseudoSourceValue.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/Value.h" // PointerLikeTypeTraits<Value*>
23 #include "llvm/Support/AtomicOrdering.h"
24 #include "llvm/Support/DataTypes.h"
25 #include "llvm/Support/LowLevelTypeImpl.h"
26 
27 namespace llvm {
28 
29 class FoldingSetNodeID;
30 class MDNode;
31 class raw_ostream;
32 class MachineFunction;
33 class ModuleSlotTracker;
34 
35 /// This class contains a discriminated union of information about pointers in
36 /// memory operands, relating them back to LLVM IR or to virtual locations (such
37 /// as frame indices) that are exposed during codegen.
38 struct MachinePointerInfo {
39   /// This is the IR pointer value for the access, or it is null if unknown.
40   /// If this is null, then the access is to a pointer in the default address
41   /// space.
42   PointerUnion<const Value *, const PseudoSourceValue *> V;
43 
44   /// Offset - This is an offset from the base Value*.
45   int64_t Offset;
46 
47   unsigned AddrSpace = 0;
48 
49   uint8_t StackID;
50 
51   explicit MachinePointerInfo(const Value *v, int64_t offset = 0,
52                               uint8_t ID = 0)
53       : V(v), Offset(offset), StackID(ID) {
54     AddrSpace = v ? v->getType()->getPointerAddressSpace() : 0;
55   }
56 
57   explicit MachinePointerInfo(const PseudoSourceValue *v, int64_t offset = 0,
58                               uint8_t ID = 0)
59       : V(v), Offset(offset), StackID(ID) {
60     AddrSpace = v ? v->getAddressSpace() : 0;
61   }
62 
63   explicit MachinePointerInfo(unsigned AddressSpace = 0, int64_t offset = 0)
64       : V((const Value *)nullptr), Offset(offset), AddrSpace(AddressSpace),
65         StackID(0) {}
66 
67   explicit MachinePointerInfo(
68     PointerUnion<const Value *, const PseudoSourceValue *> v,
69     int64_t offset = 0,
70     uint8_t ID = 0)
71     : V(v), Offset(offset), StackID(ID) {
72     if (V) {
73       if (const auto *ValPtr = V.dyn_cast<const Value*>())
74         AddrSpace = ValPtr->getType()->getPointerAddressSpace();
75       else
76         AddrSpace = V.get<const PseudoSourceValue*>()->getAddressSpace();
77     }
78   }
79 
80   MachinePointerInfo getWithOffset(int64_t O) const {
81     if (V.isNull())
82       return MachinePointerInfo(AddrSpace, Offset + O);
83     if (V.is<const Value*>())
84       return MachinePointerInfo(V.get<const Value*>(), Offset + O, StackID);
85     return MachinePointerInfo(V.get<const PseudoSourceValue*>(), Offset + O,
86                               StackID);
87   }
88 
89   /// Return true if memory region [V, V+Offset+Size) is known to be
90   /// dereferenceable.
91   bool isDereferenceable(unsigned Size, LLVMContext &C,
92                          const DataLayout &DL) const;
93 
94   /// Return the LLVM IR address space number that this pointer points into.
95   unsigned getAddrSpace() const;
96 
97   /// Return a MachinePointerInfo record that refers to the constant pool.
98   static MachinePointerInfo getConstantPool(MachineFunction &MF);
99 
100   /// Return a MachinePointerInfo record that refers to the specified
101   /// FrameIndex.
102   static MachinePointerInfo getFixedStack(MachineFunction &MF, int FI,
103                                           int64_t Offset = 0);
104 
105   /// Return a MachinePointerInfo record that refers to a jump table entry.
106   static MachinePointerInfo getJumpTable(MachineFunction &MF);
107 
108   /// Return a MachinePointerInfo record that refers to a GOT entry.
109   static MachinePointerInfo getGOT(MachineFunction &MF);
110 
111   /// Stack pointer relative access.
112   static MachinePointerInfo getStack(MachineFunction &MF, int64_t Offset,
113                                      uint8_t ID = 0);
114 
115   /// Stack memory without other information.
116   static MachinePointerInfo getUnknownStack(MachineFunction &MF);
117 };
118 
119 
120 //===----------------------------------------------------------------------===//
121 /// A description of a memory reference used in the backend.
122 /// Instead of holding a StoreInst or LoadInst, this class holds the address
123 /// Value of the reference along with a byte size and offset. This allows it
124 /// to describe lowered loads and stores. Also, the special PseudoSourceValue
125 /// objects can be used to represent loads and stores to memory locations
126 /// that aren't explicit in the regular LLVM IR.
127 ///
128 class MachineMemOperand {
129 public:
130   /// Flags values. These may be or'd together.
131   enum Flags : uint16_t {
132     // No flags set.
133     MONone = 0,
134     /// The memory access reads data.
135     MOLoad = 1u << 0,
136     /// The memory access writes data.
137     MOStore = 1u << 1,
138     /// The memory access is volatile.
139     MOVolatile = 1u << 2,
140     /// The memory access is non-temporal.
141     MONonTemporal = 1u << 3,
142     /// The memory access is dereferenceable (i.e., doesn't trap).
143     MODereferenceable = 1u << 4,
144     /// The memory access always returns the same value (or traps).
145     MOInvariant = 1u << 5,
146 
147     // Reserved for use by target-specific passes.
148     // Targets may override getSerializableMachineMemOperandTargetFlags() to
149     // enable MIR serialization/parsing of these flags.  If more of these flags
150     // are added, the MIR printing/parsing code will need to be updated as well.
151     MOTargetFlag1 = 1u << 6,
152     MOTargetFlag2 = 1u << 7,
153     MOTargetFlag3 = 1u << 8,
154 
155     LLVM_MARK_AS_BITMASK_ENUM(/* LargestFlag = */ MOTargetFlag3)
156   };
157 
158 private:
159   /// Atomic information for this memory operation.
160   struct MachineAtomicInfo {
161     /// Synchronization scope ID for this memory operation.
162     unsigned SSID : 8;            // SyncScope::ID
163     /// Atomic ordering requirements for this memory operation. For cmpxchg
164     /// atomic operations, atomic ordering requirements when store occurs.
165     unsigned Ordering : 4;        // enum AtomicOrdering
166     /// For cmpxchg atomic operations, atomic ordering requirements when store
167     /// does not occur.
168     unsigned FailureOrdering : 4; // enum AtomicOrdering
169   };
170 
171   MachinePointerInfo PtrInfo;
172 
173   /// Track the memory type of the access. An access size which is unknown or
174   /// too large to be represented by LLT should use the invalid LLT.
175   LLT MemoryType;
176 
177   Flags FlagVals;
178   Align BaseAlign;
179   MachineAtomicInfo AtomicInfo;
180   AAMDNodes AAInfo;
181   const MDNode *Ranges;
182 
183 public:
184   /// Construct a MachineMemOperand object with the specified PtrInfo, flags,
185   /// size, and base alignment. For atomic operations the synchronization scope
186   /// and atomic ordering requirements must also be specified. For cmpxchg
187   /// atomic operations the atomic ordering requirements when store does not
188   /// occur must also be specified.
189   MachineMemOperand(MachinePointerInfo PtrInfo, Flags flags, uint64_t s,
190                     Align a, const AAMDNodes &AAInfo = AAMDNodes(),
191                     const MDNode *Ranges = nullptr,
192                     SyncScope::ID SSID = SyncScope::System,
193                     AtomicOrdering Ordering = AtomicOrdering::NotAtomic,
194                     AtomicOrdering FailureOrdering = AtomicOrdering::NotAtomic);
195   MachineMemOperand(MachinePointerInfo PtrInfo, Flags flags, LLT type, Align a,
196                     const AAMDNodes &AAInfo = AAMDNodes(),
197                     const MDNode *Ranges = nullptr,
198                     SyncScope::ID SSID = SyncScope::System,
199                     AtomicOrdering Ordering = AtomicOrdering::NotAtomic,
200                     AtomicOrdering FailureOrdering = AtomicOrdering::NotAtomic);
201 
202   const MachinePointerInfo &getPointerInfo() const { return PtrInfo; }
203 
204   /// Return the base address of the memory access. This may either be a normal
205   /// LLVM IR Value, or one of the special values used in CodeGen.
206   /// Special values are those obtained via
207   /// PseudoSourceValue::getFixedStack(int), PseudoSourceValue::getStack, and
208   /// other PseudoSourceValue member functions which return objects which stand
209   /// for frame/stack pointer relative references and other special references
210   /// which are not representable in the high-level IR.
211   const Value *getValue() const { return PtrInfo.V.dyn_cast<const Value*>(); }
212 
213   const PseudoSourceValue *getPseudoValue() const {
214     return PtrInfo.V.dyn_cast<const PseudoSourceValue*>();
215   }
216 
217   const void *getOpaqueValue() const { return PtrInfo.V.getOpaqueValue(); }
218 
219   /// Return the raw flags of the source value, \see Flags.
220   Flags getFlags() const { return FlagVals; }
221 
222   /// Bitwise OR the current flags with the given flags.
223   void setFlags(Flags f) { FlagVals |= f; }
224 
225   /// For normal values, this is a byte offset added to the base address.
226   /// For PseudoSourceValue::FPRel values, this is the FrameIndex number.
227   int64_t getOffset() const { return PtrInfo.Offset; }
228 
229   unsigned getAddrSpace() const { return PtrInfo.getAddrSpace(); }
230 
231   /// Return the memory type of the memory reference. This should only be relied
232   /// on for GlobalISel G_* operation legalization.
233   LLT getMemoryType() const { return MemoryType; }
234 
235   /// Return the size in bytes of the memory reference.
236   uint64_t getSize() const {
237     return MemoryType.isValid() ? MemoryType.getSizeInBytes() : ~UINT64_C(0);
238   }
239 
240   /// Return the size in bits of the memory reference.
241   uint64_t getSizeInBits() const {
242     return MemoryType.isValid() ? MemoryType.getSizeInBits() : ~UINT64_C(0);
243   }
244 
245   LLT getType() const {
246     return MemoryType;
247   }
248 
249   /// Return the minimum known alignment in bytes of the actual memory
250   /// reference.
251   Align getAlign() const;
252 
253   /// Return the minimum known alignment in bytes of the base address, without
254   /// the offset.
255   Align getBaseAlign() const { return BaseAlign; }
256 
257   /// Return the AA tags for the memory reference.
258   AAMDNodes getAAInfo() const { return AAInfo; }
259 
260   /// Return the range tag for the memory reference.
261   const MDNode *getRanges() const { return Ranges; }
262 
263   /// Returns the synchronization scope ID for this memory operation.
264   SyncScope::ID getSyncScopeID() const {
265     return static_cast<SyncScope::ID>(AtomicInfo.SSID);
266   }
267 
268   /// Return the atomic ordering requirements for this memory operation. For
269   /// cmpxchg atomic operations, return the atomic ordering requirements when
270   /// store occurs.
271   AtomicOrdering getSuccessOrdering() const {
272     return static_cast<AtomicOrdering>(AtomicInfo.Ordering);
273   }
274 
275   /// For cmpxchg atomic operations, return the atomic ordering requirements
276   /// when store does not occur.
277   AtomicOrdering getFailureOrdering() const {
278     return static_cast<AtomicOrdering>(AtomicInfo.FailureOrdering);
279   }
280 
281   /// Return a single atomic ordering that is at least as strong as both the
282   /// success and failure orderings for an atomic operation.  (For operations
283   /// other than cmpxchg, this is equivalent to getSuccessOrdering().)
284   AtomicOrdering getMergedOrdering() const {
285     return getMergedAtomicOrdering(getSuccessOrdering(), getFailureOrdering());
286   }
287 
288   bool isLoad() const { return FlagVals & MOLoad; }
289   bool isStore() const { return FlagVals & MOStore; }
290   bool isVolatile() const { return FlagVals & MOVolatile; }
291   bool isNonTemporal() const { return FlagVals & MONonTemporal; }
292   bool isDereferenceable() const { return FlagVals & MODereferenceable; }
293   bool isInvariant() const { return FlagVals & MOInvariant; }
294 
295   /// Returns true if this operation has an atomic ordering requirement of
296   /// unordered or higher, false otherwise.
297   bool isAtomic() const {
298     return getSuccessOrdering() != AtomicOrdering::NotAtomic;
299   }
300 
301   /// Returns true if this memory operation doesn't have any ordering
302   /// constraints other than normal aliasing. Volatile and (ordered) atomic
303   /// memory operations can't be reordered.
304   bool isUnordered() const {
305     return (getSuccessOrdering() == AtomicOrdering::NotAtomic ||
306             getSuccessOrdering() == AtomicOrdering::Unordered) &&
307            !isVolatile();
308   }
309 
310   /// Update this MachineMemOperand to reflect the alignment of MMO, if it has a
311   /// greater alignment. This must only be used when the new alignment applies
312   /// to all users of this MachineMemOperand.
313   void refineAlignment(const MachineMemOperand *MMO);
314 
315   /// Change the SourceValue for this MachineMemOperand. This should only be
316   /// used when an object is being relocated and all references to it are being
317   /// updated.
318   void setValue(const Value *NewSV) { PtrInfo.V = NewSV; }
319   void setValue(const PseudoSourceValue *NewSV) { PtrInfo.V = NewSV; }
320   void setOffset(int64_t NewOffset) { PtrInfo.Offset = NewOffset; }
321 
322   /// Reset the tracked memory type.
323   void setType(LLT NewTy) {
324     MemoryType = NewTy;
325   }
326 
327   /// Profile - Gather unique data for the object.
328   ///
329   void Profile(FoldingSetNodeID &ID) const;
330 
331   /// Support for operator<<.
332   /// @{
333   void print(raw_ostream &OS, ModuleSlotTracker &MST,
334              SmallVectorImpl<StringRef> &SSNs, const LLVMContext &Context,
335              const MachineFrameInfo *MFI, const TargetInstrInfo *TII) const;
336   /// @}
337 
338   friend bool operator==(const MachineMemOperand &LHS,
339                          const MachineMemOperand &RHS) {
340     return LHS.getValue() == RHS.getValue() &&
341            LHS.getPseudoValue() == RHS.getPseudoValue() &&
342            LHS.getSize() == RHS.getSize() &&
343            LHS.getOffset() == RHS.getOffset() &&
344            LHS.getFlags() == RHS.getFlags() &&
345            LHS.getAAInfo() == RHS.getAAInfo() &&
346            LHS.getRanges() == RHS.getRanges() &&
347            LHS.getAlign() == RHS.getAlign() &&
348            LHS.getAddrSpace() == RHS.getAddrSpace();
349   }
350 
351   friend bool operator!=(const MachineMemOperand &LHS,
352                          const MachineMemOperand &RHS) {
353     return !(LHS == RHS);
354   }
355 };
356 
357 } // End llvm namespace
358 
359 #endif
360