1 //==- llvm/CodeGen/MachineMemOperand.h - MachineMemOperand class -*- 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 contains the declaration of the MachineMemOperand class, which is a
11 // description of a memory reference. It is used to help track dependencies
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CODEGEN_MEMOPERAND_H
17 #define LLVM_CODEGEN_MEMOPERAND_H
23 //===----------------------------------------------------------------------===//
24 /// MachineMemOperand - A description of a memory reference used in the backend.
25 /// Instead of holding a StoreInst or LoadInst, this class holds the address
26 /// Value of the reference along with a byte size and offset. This allows it
27 /// to describe lowered loads and stores. Also, the special PseudoSourceValue
28 /// objects can be used to represent loads and stores to memory locations
29 /// that aren't explicit in the regular LLVM IR.
31 class MachineMemOperand {
36 unsigned int Alignment;
39 /// Flags values. These may be or'd together.
40 enum MemOperandFlags {
41 /// The memory access reads data.
43 /// The memory access writes data.
45 /// The memory access is volatile.
49 /// MachineMemOperand - Construct an MachineMemOperand object with the
50 /// specified address Value, flags, offset, size, and alignment.
51 MachineMemOperand(const Value *v, unsigned int f, int64_t o, uint64_t s,
53 : V(v), Flags(f), Offset(o), Size(s), Alignment(a) {}
55 /// getValue - Return the base address of the memory access.
56 /// Special values are PseudoSourceValue::FPRel, PseudoSourceValue::SPRel,
57 /// and the other PseudoSourceValue members which indicate references to
58 /// frame/stack pointer relative references and other special references.
59 const Value *getValue() const { return V; }
61 /// getFlags - Return the raw flags of the source value, \see MemOperandFlags.
62 unsigned int getFlags() const { return Flags; }
64 /// getOffset - For normal values, this is a byte offset added to the base
65 /// address. For PseudoSourceValue::FPRel values, this is the FrameIndex
67 int64_t getOffset() const { return Offset; }
69 /// getSize - Return the size in bytes of the memory reference.
70 uint64_t getSize() const { return Size; }
72 /// getAlignment - Return the minimum known alignment in bytes of the
74 unsigned int getAlignment() const { return Alignment; }
76 bool isLoad() const { return Flags & MOLoad; }
77 bool isStore() const { return Flags & MOStore; }
78 bool isVolatile() const { return Flags & MOVolatile; }
81 } // End llvm namespace