move macho section uniquing from MCParser and TLOF to MCContext where
[oota-llvm.git] / include / llvm / MC / MCContext.h
1 //===- MCContext.h - Machine Code Context -----------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #ifndef LLVM_MC_MCCONTEXT_H
11 #define LLVM_MC_MCCONTEXT_H
12
13 #include "llvm/MC/SectionKind.h"
14 #include "llvm/ADT/DenseMap.h"
15 #include "llvm/ADT/StringMap.h"
16 #include "llvm/Support/Allocator.h"
17
18 namespace llvm {
19   class MCAsmInfo;
20   class MCExpr;
21   class MCSection;
22   class MCSymbol;
23   class StringRef;
24   class Twine;
25   class MCSectionMachO;
26
27   /// MCContext - Context object for machine code objects.  This class owns all
28   /// of the sections that it creates.
29   ///
30   class MCContext {
31     MCContext(const MCContext&); // DO NOT IMPLEMENT
32     MCContext &operator=(const MCContext&); // DO NOT IMPLEMENT
33
34     /// The MCAsmInfo for this target.
35     const MCAsmInfo &MAI;
36     
37     /// Sections - Bindings of names to allocated sections.
38     StringMap<MCSection*> Sections;
39
40     /// Symbols - Bindings of names to symbols.
41     StringMap<MCSymbol*> Symbols;
42
43     /// NextUniqueID - The next ID to dole out to an unnamed assembler temporary
44     /// symbol.
45     unsigned NextUniqueID;
46     
47     /// Allocator - Allocator object used for creating machine code objects.
48     ///
49     /// We use a bump pointer allocator to avoid the need to track all allocated
50     /// objects.
51     BumpPtrAllocator Allocator;
52     
53     void *MachOUniquingMap;
54   public:
55     explicit MCContext(const MCAsmInfo &MAI);
56     ~MCContext();
57     
58     const MCAsmInfo &getAsmInfo() const { return MAI; }
59
60     /// @name Symbol Managment
61     /// @{
62     
63     /// CreateTempSymbol - Create and return a new assembler temporary symbol
64     /// with a unique but unspecified name.
65     MCSymbol *CreateTempSymbol();
66
67     /// GetOrCreateSymbol - Lookup the symbol inside with the specified
68     /// @p Name.  If it exists, return it.  If not, create a forward
69     /// reference and return it.
70     ///
71     /// @param Name - The symbol name, which must be unique across all symbols.
72     MCSymbol *GetOrCreateSymbol(StringRef Name);
73     MCSymbol *GetOrCreateSymbol(const Twine &Name);
74
75     /// LookupSymbol - Get the symbol for \p Name, or null.
76     MCSymbol *LookupSymbol(StringRef Name) const;
77
78     /// @}
79     
80     /// @name Section Managment
81     /// @{
82
83     const MCSectionMachO *getMachOSection(StringRef Segment,
84                                           StringRef Section,
85                                           unsigned TypeAndAttributes,
86                                           unsigned Reserved2,
87                                           SectionKind K);
88     
89     /// @}
90
91     void *Allocate(unsigned Size, unsigned Align = 8) {
92       return Allocator.Allocate(Size, Align);
93     }
94     void Deallocate(void *Ptr) {
95     }
96   };
97
98 } // end namespace llvm
99
100 // operator new and delete aren't allowed inside namespaces.
101 // The throw specifications are mandated by the standard.
102 /// @brief Placement new for using the MCContext's allocator.
103 ///
104 /// This placement form of operator new uses the MCContext's allocator for
105 /// obtaining memory. It is a non-throwing new, which means that it returns
106 /// null on error. (If that is what the allocator does. The current does, so if
107 /// this ever changes, this operator will have to be changed, too.)
108 /// Usage looks like this (assuming there's an MCContext 'Context' in scope):
109 /// @code
110 /// // Default alignment (16)
111 /// IntegerLiteral *Ex = new (Context) IntegerLiteral(arguments);
112 /// // Specific alignment
113 /// IntegerLiteral *Ex2 = new (Context, 8) IntegerLiteral(arguments);
114 /// @endcode
115 /// Please note that you cannot use delete on the pointer; it must be
116 /// deallocated using an explicit destructor call followed by
117 /// @c Context.Deallocate(Ptr).
118 ///
119 /// @param Bytes The number of bytes to allocate. Calculated by the compiler.
120 /// @param C The MCContext that provides the allocator.
121 /// @param Alignment The alignment of the allocated memory (if the underlying
122 ///                  allocator supports it).
123 /// @return The allocated memory. Could be NULL.
124 inline void *operator new(size_t Bytes, llvm::MCContext &C,
125                           size_t Alignment = 16) throw () {
126   return C.Allocate(Bytes, Alignment);
127 }
128 /// @brief Placement delete companion to the new above.
129 ///
130 /// This operator is just a companion to the new above. There is no way of
131 /// invoking it directly; see the new operator for more details. This operator
132 /// is called implicitly by the compiler if a placement new expression using
133 /// the MCContext throws in the object constructor.
134 inline void operator delete(void *Ptr, llvm::MCContext &C, size_t)
135               throw () {
136   C.Deallocate(Ptr);
137 }
138
139 /// This placement form of operator new[] uses the MCContext's allocator for
140 /// obtaining memory. It is a non-throwing new[], which means that it returns
141 /// null on error.
142 /// Usage looks like this (assuming there's an MCContext 'Context' in scope):
143 /// @code
144 /// // Default alignment (16)
145 /// char *data = new (Context) char[10];
146 /// // Specific alignment
147 /// char *data = new (Context, 8) char[10];
148 /// @endcode
149 /// Please note that you cannot use delete on the pointer; it must be
150 /// deallocated using an explicit destructor call followed by
151 /// @c Context.Deallocate(Ptr).
152 ///
153 /// @param Bytes The number of bytes to allocate. Calculated by the compiler.
154 /// @param C The MCContext that provides the allocator.
155 /// @param Alignment The alignment of the allocated memory (if the underlying
156 ///                  allocator supports it).
157 /// @return The allocated memory. Could be NULL.
158 inline void *operator new[](size_t Bytes, llvm::MCContext& C,
159                             size_t Alignment = 16) throw () {
160   return C.Allocate(Bytes, Alignment);
161 }
162
163 /// @brief Placement delete[] companion to the new[] above.
164 ///
165 /// This operator is just a companion to the new[] above. There is no way of
166 /// invoking it directly; see the new[] operator for more details. This operator
167 /// is called implicitly by the compiler if a placement new[] expression using
168 /// the MCContext throws in the object constructor.
169 inline void operator delete[](void *Ptr, llvm::MCContext &C) throw () {
170   C.Deallocate(Ptr);
171 }
172
173 #endif