Grammer correction.
[oota-llvm.git] / include / llvm / CodeGen / MachineConstantPool.h
1 //===-- CodeGen/MachineConstantPool.h - Abstract Constant Pool --*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // The MachineConstantPool class keeps track of constants referenced by a
11 // function which must be spilled to memory.  This is used for constants which
12 // are unable to be used directly as operands to instructions, which typically
13 // include floating point and large integer constants.
14 //
15 // Instructions reference the address of these constant pool constants through
16 // the use of MO_ConstantPoolIndex values.  When emitting assembly or machine
17 // code, these virtual address references are converted to refer to the
18 // address of the function constant pool values.
19 //
20 //===----------------------------------------------------------------------===//
21
22 #ifndef LLVM_CODEGEN_MACHINECONSTANTPOOL_H
23 #define LLVM_CODEGEN_MACHINECONSTANTPOOL_H
24
25 #include <vector>
26 #include <iosfwd>
27
28 namespace llvm {
29
30 class Constant;
31
32 class MachineConstantPool {
33   std::vector<Constant*> Constants;
34 public:
35
36   /// getConstantPoolIndex - Create a new entry in the constant pool or return
37   /// an existing one.
38   ///
39   unsigned getConstantPoolIndex(Constant *C) {
40     // Check to see if we already have this constant.
41     //
42     // FIXME, this could be made much more efficient for large constant pools.
43     for (unsigned i = 0, e = Constants.size(); i != e; ++i)
44       if (Constants[i] == C)
45         return i;
46     Constants.push_back(C);
47     return Constants.size()-1;
48   }
49
50   /// isEmpty - Return true if this constant pool contains no constants.
51   ///
52   bool isEmpty() const { return Constants.empty(); }
53
54   const std::vector<Constant*> &getConstants() const { return Constants; }
55
56   /// print - Used by the MachineFunction printer to print information about
57   /// stack objects.  Implemented in MachineFunction.cpp
58   ///
59   void print(std::ostream &OS) const;
60
61   /// dump - Call print(std::cerr) to be called from the debugger.
62   void dump() const;
63 };
64
65 } // End llvm namespace
66
67 #endif