* Wrap some comments to 80 cols
[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
27 namespace llvm {
28
29 class Constant;
30
31 class MachineConstantPool {
32   std::vector<Constant*> Constants;
33 public:
34
35   /// getConstantPoolIndex - Create a new entry in the constant pool or return
36   /// an existing one.
37   ///
38   unsigned getConstantPoolIndex(Constant *C) {
39     // Check to see if we already have this constant.
40     //
41     // FIXME, this could be made much more efficient for large constant pools.
42     for (unsigned i = 0, e = Constants.size(); i != e; ++i)
43       if (Constants[i] == C)
44         return i;
45     Constants.push_back(C);
46     return Constants.size()-1;
47   }
48
49   const std::vector<Constant*> &getConstants() const { return Constants; }
50
51   /// print - Used by the MachineFunction printer to print information about
52   /// stack objects.  Implemented in MachineFunction.cpp
53   ///
54   void print(std::ostream &OS) const;
55
56   /// dump - Call print(std::cerr) to be called from the debugger.
57   void dump() const;
58 };
59
60 } // End llvm namespace
61
62 #endif