1
//===-- CodeGen/MachineConstantPool.h - Abstract Constant Pool --*- 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
//===----------------------------------------------------------------------===//
11
/// This file declares the MachineConstantPool class which is an abstract
12
/// constant pool to keep track of constants referenced by a function.
14
//===----------------------------------------------------------------------===//
16
#ifndef LLVM_CODEGEN_MACHINECONSTANTPOOL_H
17
#define LLVM_CODEGEN_MACHINECONSTANTPOOL_H
26
class FoldingSetNodeID;
30
class MachineConstantPool;
33
/// Abstract base class for all machine specific constantpool value subclasses.
35
class MachineConstantPoolValue {
39
explicit MachineConstantPoolValue(const Type *ty) : Ty(ty) {}
40
virtual ~MachineConstantPoolValue() {}
42
/// getType - get type of this MachineConstantPoolValue.
44
const Type *getType() const { return Ty; }
47
/// getRelocationInfo - This method classifies the entry according to
48
/// whether or not it may generate a relocation entry. This must be
49
/// conservative, so if it might codegen to a relocatable entry, it should say
50
/// so. The return values are the same as Constant::getRelocationInfo().
51
virtual unsigned getRelocationInfo() const = 0;
53
virtual int getExistingMachineCPValue(MachineConstantPool *CP,
54
unsigned Alignment) = 0;
56
virtual void AddSelectionDAGCSEId(FoldingSetNodeID &ID) = 0;
58
/// print - Implement operator<<
59
virtual void print(raw_ostream &O) const = 0;
62
inline raw_ostream &operator<<(raw_ostream &OS,
63
const MachineConstantPoolValue &V) {
69
/// This class is a data container for one entry in a MachineConstantPool.
70
/// It contains a pointer to the value and an offset from the start of
71
/// the constant pool.
72
/// @brief An entry in a MachineConstantPool
73
class MachineConstantPoolEntry {
75
/// The constant itself.
78
MachineConstantPoolValue *MachineCPVal;
81
/// The required alignment for this entry. The top bit is set when Val is
82
/// a MachineConstantPoolValue.
85
MachineConstantPoolEntry(Constant *V, unsigned A)
89
MachineConstantPoolEntry(MachineConstantPoolValue *V, unsigned A)
92
Alignment |= 1U << (sizeof(unsigned)*CHAR_BIT-1);
95
bool isMachineConstantPoolEntry() const {
96
return (int)Alignment < 0;
99
int getAlignment() const {
100
return Alignment & ~(1 << (sizeof(unsigned)*CHAR_BIT-1));
103
const Type *getType() const;
105
/// getRelocationInfo - This method classifies the entry according to
106
/// whether or not it may generate a relocation entry. This must be
107
/// conservative, so if it might codegen to a relocatable entry, it should say
108
/// so. The return values are:
110
/// 0: This constant pool entry is guaranteed to never have a relocation
111
/// applied to it (because it holds a simple constant like '4').
112
/// 1: This entry has relocations, but the entries are guaranteed to be
113
/// resolvable by the static linker, so the dynamic linker will never see
115
/// 2: This entry may have arbitrary relocations.
116
unsigned getRelocationInfo() const;
119
/// The MachineConstantPool class keeps track of constants referenced by a
120
/// function which must be spilled to memory. This is used for constants which
121
/// are unable to be used directly as operands to instructions, which typically
122
/// include floating point and large integer constants.
124
/// Instructions reference the address of these constant pool constants through
125
/// the use of MO_ConstantPoolIndex values. When emitting assembly or machine
126
/// code, these virtual address references are converted to refer to the
127
/// address of the function constant pool values.
128
/// @brief The machine constant pool.
129
class MachineConstantPool {
130
const TargetData *TD; ///< The machine's TargetData.
131
unsigned PoolAlignment; ///< The alignment for the pool.
132
std::vector<MachineConstantPoolEntry> Constants; ///< The pool of constants.
134
/// @brief The only constructor.
135
explicit MachineConstantPool(const TargetData *td)
136
: TD(td), PoolAlignment(1) {}
137
~MachineConstantPool();
139
/// getConstantPoolAlignment - Return the alignment required by
140
/// the whole constant pool, of which the first element must be aligned.
141
unsigned getConstantPoolAlignment() const { return PoolAlignment; }
143
/// getConstantPoolIndex - Create a new entry in the constant pool or return
144
/// an existing one. User must specify the minimum required alignment for
146
unsigned getConstantPoolIndex(Constant *C, unsigned Alignment);
147
unsigned getConstantPoolIndex(MachineConstantPoolValue *V,unsigned Alignment);
149
/// isEmpty - Return true if this constant pool contains no constants.
150
bool isEmpty() const { return Constants.empty(); }
152
const std::vector<MachineConstantPoolEntry> &getConstants() const {
156
/// print - Used by the MachineFunction printer to print information about
157
/// constant pool objects. Implemented in MachineFunction.cpp
159
void print(raw_ostream &OS) const;
161
/// dump - Call print(cerr) to be called from the debugger.
165
} // End llvm namespace