1 //===- MCContext.h - Machine Code Context -----------------------*- 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 #ifndef LLVM_MC_MCCONTEXT_H
11 #define LLVM_MC_MCCONTEXT_H
13 #include "llvm/MC/SectionKind.h"
14 #include "llvm/MC/MCDwarf.h"
15 #include "llvm/ADT/DenseMap.h"
16 #include "llvm/ADT/StringMap.h"
17 #include "llvm/Support/Allocator.h"
18 #include "llvm/Support/raw_ostream.h"
19 #include <vector> // FIXME: Shouldn't be needed.
34 /// MCContext - Context object for machine code objects. This class owns all
35 /// of the sections that it creates.
38 MCContext(const MCContext&); // DO NOT IMPLEMENT
39 MCContext &operator=(const MCContext&); // DO NOT IMPLEMENT
41 /// The MCAsmInfo for this target.
44 /// Symbols - Bindings of names to symbols.
45 StringMap<MCSymbol*> Symbols;
47 /// NextUniqueID - The next ID to dole out to an unnamed assembler temporary
49 unsigned NextUniqueID;
51 /// Instances of directional local labels.
52 DenseMap<unsigned, MCLabel *> Instances;
53 /// NextInstance() creates the next instance of the directional local label
54 /// for the LocalLabelVal and adds it to the map if needed.
55 unsigned NextInstance(int64_t LocalLabelVal);
56 /// GetInstance() gets the current instance of the directional local label
57 /// for the LocalLabelVal and adds it to the map if needed.
58 unsigned GetInstance(int64_t LocalLabelVal);
60 /// The file name of the log file from the enviromment variable
61 /// AS_SECURE_LOG_FILE. Which must be set before the .secure_log_unique
62 /// directive is used or it is an error.
64 /// The stream that gets written to for the .secure_log_unique directive.
65 raw_ostream *SecureLog;
66 /// Boolean toggled when .secure_log_unique / .secure_log_reset is seen to
67 /// catch errors if .secure_log_unique appears twice without
68 /// .secure_log_reset appearing between them.
71 /// The dwarf file and directory tables from the dwarf .file directive.
72 std::vector<MCDwarfFile *> MCDwarfFiles;
73 std::vector<StringRef> MCDwarfDirs;
75 /// The current dwarf line information from the last dwarf .loc directive.
76 MCDwarfLoc CurrentDwarfLoc;
79 /// The dwarf line information from the .loc directives for the sections
80 /// with assembled machine instructions have after seeing .loc directives.
81 DenseMap<const MCSection *, MCLineSection *> MCLineSections;
83 /// Allocator - Allocator object used for creating machine code objects.
85 /// We use a bump pointer allocator to avoid the need to track all allocated
87 BumpPtrAllocator Allocator;
89 void *MachOUniquingMap, *ELFUniquingMap, *COFFUniquingMap;
91 explicit MCContext(const MCAsmInfo &MAI);
94 const MCAsmInfo &getAsmInfo() const { return MAI; }
96 /// @name Symbol Managment
99 /// CreateTempSymbol - Create and return a new assembler temporary symbol
100 /// with a unique but unspecified name.
101 MCSymbol *CreateTempSymbol();
103 /// CreateDirectionalLocalSymbol - Create the defintion of a directional
104 /// local symbol for numbered label (used for "1:" defintions).
105 MCSymbol *CreateDirectionalLocalSymbol(int64_t LocalLabelVal);
107 /// GetDirectionalLocalSymbol - Create and return a directional local
108 /// symbol for numbered label (used for "1b" or 1f" references).
109 MCSymbol *GetDirectionalLocalSymbol(int64_t LocalLabelVal, int bORf);
111 /// GetOrCreateSymbol - Lookup the symbol inside with the specified
112 /// @p Name. If it exists, return it. If not, create a forward
113 /// reference and return it.
115 /// @param Name - The symbol name, which must be unique across all symbols.
116 MCSymbol *GetOrCreateSymbol(StringRef Name);
117 MCSymbol *GetOrCreateSymbol(const Twine &Name);
119 /// LookupSymbol - Get the symbol for \p Name, or null.
120 MCSymbol *LookupSymbol(StringRef Name) const;
124 /// @name Section Managment
127 /// getMachOSection - Return the MCSection for the specified mach-o section.
128 /// This requires the operands to be valid.
129 const MCSectionMachO *getMachOSection(StringRef Segment,
131 unsigned TypeAndAttributes,
134 const MCSectionMachO *getMachOSection(StringRef Segment,
136 unsigned TypeAndAttributes,
138 return getMachOSection(Segment, Section, TypeAndAttributes, 0, K);
141 const MCSection *getELFSection(StringRef Section, unsigned Type,
142 unsigned Flags, SectionKind Kind,
143 bool IsExplicit = false,
144 unsigned EntrySize = 0);
146 const MCSection *getCOFFSection(StringRef Section, unsigned Characteristics,
147 int Selection, SectionKind Kind);
149 const MCSection *getCOFFSection(StringRef Section, unsigned Characteristics,
151 return getCOFFSection (Section, Characteristics, 0, Kind);
157 /// @name Dwarf Managment
160 /// GetDwarfFile - creates an entry in the dwarf file and directory tables.
161 unsigned GetDwarfFile(StringRef FileName, unsigned FileNumber);
163 bool ValidateDwarfFileNumber(unsigned FileNumber);
165 const std::vector<MCDwarfFile *> &getMCDwarfFiles() {
168 const std::vector<StringRef> &getMCDwarfDirs() {
171 DenseMap<const MCSection *, MCLineSection *> &getMCLineSections() {
172 return MCLineSections;
175 /// setCurrentDwarfLoc - saves the information from the currently parsed
176 /// dwarf .loc directive and sets DwarfLocSeen. When the next instruction /// is assembled an entry in the line number table with this information and
177 /// the address of the instruction will be created.
178 void setCurrentDwarfLoc(unsigned FileNum, unsigned Line, unsigned Column,
179 unsigned Flags, unsigned Isa) {
180 CurrentDwarfLoc.setFileNum(FileNum);
181 CurrentDwarfLoc.setLine(Line);
182 CurrentDwarfLoc.setColumn(Column);
183 CurrentDwarfLoc.setFlags(Flags);
184 CurrentDwarfLoc.setIsa(Isa);
187 void clearDwarfLocSeen() { DwarfLocSeen = false; }
189 bool getDwarfLocSeen() { return DwarfLocSeen; }
190 const MCDwarfLoc &getCurrentDwarfLoc() { return CurrentDwarfLoc; }
194 char *getSecureLogFile() { return SecureLogFile; }
195 raw_ostream *getSecureLog() { return SecureLog; }
196 bool getSecureLogUsed() { return SecureLogUsed; }
197 void setSecureLog(raw_ostream *Value) {
200 void setSecureLogUsed(bool Value) {
201 SecureLogUsed = Value;
204 void *Allocate(unsigned Size, unsigned Align = 8) {
205 return Allocator.Allocate(Size, Align);
207 void Deallocate(void *Ptr) {
211 } // end namespace llvm
213 // operator new and delete aren't allowed inside namespaces.
214 // The throw specifications are mandated by the standard.
215 /// @brief Placement new for using the MCContext's allocator.
217 /// This placement form of operator new uses the MCContext's allocator for
218 /// obtaining memory. It is a non-throwing new, which means that it returns
219 /// null on error. (If that is what the allocator does. The current does, so if
220 /// this ever changes, this operator will have to be changed, too.)
221 /// Usage looks like this (assuming there's an MCContext 'Context' in scope):
223 /// // Default alignment (16)
224 /// IntegerLiteral *Ex = new (Context) IntegerLiteral(arguments);
225 /// // Specific alignment
226 /// IntegerLiteral *Ex2 = new (Context, 8) IntegerLiteral(arguments);
228 /// Please note that you cannot use delete on the pointer; it must be
229 /// deallocated using an explicit destructor call followed by
230 /// @c Context.Deallocate(Ptr).
232 /// @param Bytes The number of bytes to allocate. Calculated by the compiler.
233 /// @param C The MCContext that provides the allocator.
234 /// @param Alignment The alignment of the allocated memory (if the underlying
235 /// allocator supports it).
236 /// @return The allocated memory. Could be NULL.
237 inline void *operator new(size_t Bytes, llvm::MCContext &C,
238 size_t Alignment = 16) throw () {
239 return C.Allocate(Bytes, Alignment);
241 /// @brief Placement delete companion to the new above.
243 /// This operator is just a companion to the new above. There is no way of
244 /// invoking it directly; see the new operator for more details. This operator
245 /// is called implicitly by the compiler if a placement new expression using
246 /// the MCContext throws in the object constructor.
247 inline void operator delete(void *Ptr, llvm::MCContext &C, size_t)
252 /// This placement form of operator new[] uses the MCContext's allocator for
253 /// obtaining memory. It is a non-throwing new[], which means that it returns
255 /// Usage looks like this (assuming there's an MCContext 'Context' in scope):
257 /// // Default alignment (16)
258 /// char *data = new (Context) char[10];
259 /// // Specific alignment
260 /// char *data = new (Context, 8) char[10];
262 /// Please note that you cannot use delete on the pointer; it must be
263 /// deallocated using an explicit destructor call followed by
264 /// @c Context.Deallocate(Ptr).
266 /// @param Bytes The number of bytes to allocate. Calculated by the compiler.
267 /// @param C The MCContext that provides the allocator.
268 /// @param Alignment The alignment of the allocated memory (if the underlying
269 /// allocator supports it).
270 /// @return The allocated memory. Could be NULL.
271 inline void *operator new[](size_t Bytes, llvm::MCContext& C,
272 size_t Alignment = 16) throw () {
273 return C.Allocate(Bytes, Alignment);
276 /// @brief Placement delete[] companion to the new[] above.
278 /// This operator is just a companion to the new[] above. There is no way of
279 /// invoking it directly; see the new[] operator for more details. This operator
280 /// is called implicitly by the compiler if a placement new[] expression using
281 /// the MCContext throws in the object constructor.
282 inline void operator delete[](void *Ptr, llvm::MCContext &C) throw () {