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.
35 /// MCContext - Context object for machine code objects. This class owns all
36 /// of the sections that it creates.
39 MCContext(const MCContext&); // DO NOT IMPLEMENT
40 MCContext &operator=(const MCContext&); // DO NOT IMPLEMENT
42 /// The MCAsmInfo for this target.
45 /// Symbols - Bindings of names to symbols.
46 StringMap<MCSymbol*> Symbols;
48 /// NextUniqueID - The next ID to dole out to an unnamed assembler temporary
50 unsigned NextUniqueID;
52 /// Instances of directional local labels.
53 DenseMap<unsigned, MCLabel *> Instances;
54 /// NextInstance() creates the next instance of the directional local label
55 /// for the LocalLabelVal and adds it to the map if needed.
56 unsigned NextInstance(int64_t LocalLabelVal);
57 /// GetInstance() gets the current instance of the directional local label
58 /// for the LocalLabelVal and adds it to the map if needed.
59 unsigned GetInstance(int64_t LocalLabelVal);
61 /// The file name of the log file from the enviromment variable
62 /// AS_SECURE_LOG_FILE. Which must be set before the .secure_log_unique
63 /// directive is used or it is an error.
65 /// The stream that gets written to for the .secure_log_unique directive.
66 raw_ostream *SecureLog;
67 /// Boolean toggled when .secure_log_unique / .secure_log_reset is seen to
68 /// catch errors if .secure_log_unique appears twice without
69 /// .secure_log_reset appearing between them.
72 /// The dwarf file and directory tables from the dwarf .file directive.
73 std::vector<MCDwarfFile *> MCDwarfFiles;
74 std::vector<StringRef> MCDwarfDirs;
76 /// The current dwarf line information from the last dwarf .loc directive.
77 MCDwarfLoc CurrentDwarfLoc;
80 /// The dwarf line information from the .loc directives for the sections
81 /// with assembled machine instructions have after seeing .loc directives.
82 DenseMap<const MCSection *, MCLineSection *> MCLineSections;
84 /// Allocator - Allocator object used for creating machine code objects.
86 /// We use a bump pointer allocator to avoid the need to track all allocated
88 BumpPtrAllocator Allocator;
90 void *MachOUniquingMap, *ELFUniquingMap, *COFFUniquingMap;
92 explicit MCContext(const MCAsmInfo &MAI);
95 const MCAsmInfo &getAsmInfo() const { return MAI; }
97 /// @name Symbol Managment
100 /// CreateTempSymbol - Create and return a new assembler temporary symbol
101 /// with a unique but unspecified name.
102 MCSymbol *CreateTempSymbol();
104 /// CreateDirectionalLocalSymbol - Create the defintion of a directional
105 /// local symbol for numbered label (used for "1:" defintions).
106 MCSymbol *CreateDirectionalLocalSymbol(int64_t LocalLabelVal);
108 /// GetDirectionalLocalSymbol - Create and return a directional local
109 /// symbol for numbered label (used for "1b" or 1f" references).
110 MCSymbol *GetDirectionalLocalSymbol(int64_t LocalLabelVal, int bORf);
112 /// GetOrCreateSymbol - Lookup the symbol inside with the specified
113 /// @p Name. If it exists, return it. If not, create a forward
114 /// reference and return it.
116 /// @param Name - The symbol name, which must be unique across all symbols.
117 MCSymbol *GetOrCreateSymbol(StringRef Name);
118 MCSymbol *GetOrCreateSymbol(const Twine &Name);
120 /// LookupSymbol - Get the symbol for \p Name, or null.
121 MCSymbol *LookupSymbol(StringRef Name) const;
125 /// @name Section Managment
128 /// getMachOSection - Return the MCSection for the specified mach-o section.
129 /// This requires the operands to be valid.
130 const MCSectionMachO *getMachOSection(StringRef Segment,
132 unsigned TypeAndAttributes,
135 const MCSectionMachO *getMachOSection(StringRef Segment,
137 unsigned TypeAndAttributes,
139 return getMachOSection(Segment, Section, TypeAndAttributes, 0, K);
142 const MCSectionELF *getELFSection(StringRef Section, unsigned Type,
143 unsigned Flags, SectionKind Kind);
145 const MCSectionELF *getELFSection(StringRef Section, unsigned Type,
146 unsigned Flags, SectionKind Kind,
147 unsigned EntrySize, StringRef Group);
149 const MCSectionELF *CreateELFGroupSection();
151 const MCSection *getCOFFSection(StringRef Section, unsigned Characteristics,
152 int Selection, SectionKind Kind);
154 const MCSection *getCOFFSection(StringRef Section, unsigned Characteristics,
156 return getCOFFSection (Section, Characteristics, 0, Kind);
162 /// @name Dwarf Managment
165 /// GetDwarfFile - creates an entry in the dwarf file and directory tables.
166 unsigned GetDwarfFile(StringRef FileName, unsigned FileNumber);
168 bool isValidDwarfFileNumber(unsigned FileNumber);
170 bool hasDwarfFiles(void) {
171 return MCDwarfFiles.size() != 0;
174 const std::vector<MCDwarfFile *> &getMCDwarfFiles() {
177 const std::vector<StringRef> &getMCDwarfDirs() {
180 DenseMap<const MCSection *, MCLineSection *> &getMCLineSections() {
181 return MCLineSections;
184 /// setCurrentDwarfLoc - saves the information from the currently parsed
185 /// dwarf .loc directive and sets DwarfLocSeen. When the next instruction
186 /// is assembled an entry in the line number table with this information and
187 /// the address of the instruction will be created.
188 void setCurrentDwarfLoc(unsigned FileNum, unsigned Line, unsigned Column,
189 unsigned Flags, unsigned Isa) {
190 CurrentDwarfLoc.setFileNum(FileNum);
191 CurrentDwarfLoc.setLine(Line);
192 CurrentDwarfLoc.setColumn(Column);
193 CurrentDwarfLoc.setFlags(Flags);
194 CurrentDwarfLoc.setIsa(Isa);
197 void ClearDwarfLocSeen() { DwarfLocSeen = false; }
199 bool getDwarfLocSeen() { return DwarfLocSeen; }
200 const MCDwarfLoc &getCurrentDwarfLoc() { return CurrentDwarfLoc; }
204 char *getSecureLogFile() { return SecureLogFile; }
205 raw_ostream *getSecureLog() { return SecureLog; }
206 bool getSecureLogUsed() { return SecureLogUsed; }
207 void setSecureLog(raw_ostream *Value) {
210 void setSecureLogUsed(bool Value) {
211 SecureLogUsed = Value;
214 void *Allocate(unsigned Size, unsigned Align = 8) {
215 return Allocator.Allocate(Size, Align);
217 void Deallocate(void *Ptr) {
221 } // end namespace llvm
223 // operator new and delete aren't allowed inside namespaces.
224 // The throw specifications are mandated by the standard.
225 /// @brief Placement new for using the MCContext's allocator.
227 /// This placement form of operator new uses the MCContext's allocator for
228 /// obtaining memory. It is a non-throwing new, which means that it returns
229 /// null on error. (If that is what the allocator does. The current does, so if
230 /// this ever changes, this operator will have to be changed, too.)
231 /// Usage looks like this (assuming there's an MCContext 'Context' in scope):
233 /// // Default alignment (16)
234 /// IntegerLiteral *Ex = new (Context) IntegerLiteral(arguments);
235 /// // Specific alignment
236 /// IntegerLiteral *Ex2 = new (Context, 8) IntegerLiteral(arguments);
238 /// Please note that you cannot use delete on the pointer; it must be
239 /// deallocated using an explicit destructor call followed by
240 /// @c Context.Deallocate(Ptr).
242 /// @param Bytes The number of bytes to allocate. Calculated by the compiler.
243 /// @param C The MCContext that provides the allocator.
244 /// @param Alignment The alignment of the allocated memory (if the underlying
245 /// allocator supports it).
246 /// @return The allocated memory. Could be NULL.
247 inline void *operator new(size_t Bytes, llvm::MCContext &C,
248 size_t Alignment = 16) throw () {
249 return C.Allocate(Bytes, Alignment);
251 /// @brief Placement delete companion to the new above.
253 /// This operator is just a companion to the new above. There is no way of
254 /// invoking it directly; see the new operator for more details. This operator
255 /// is called implicitly by the compiler if a placement new expression using
256 /// the MCContext throws in the object constructor.
257 inline void operator delete(void *Ptr, llvm::MCContext &C, size_t)
262 /// This placement form of operator new[] uses the MCContext's allocator for
263 /// obtaining memory. It is a non-throwing new[], which means that it returns
265 /// Usage looks like this (assuming there's an MCContext 'Context' in scope):
267 /// // Default alignment (16)
268 /// char *data = new (Context) char[10];
269 /// // Specific alignment
270 /// char *data = new (Context, 8) char[10];
272 /// Please note that you cannot use delete on the pointer; it must be
273 /// deallocated using an explicit destructor call followed by
274 /// @c Context.Deallocate(Ptr).
276 /// @param Bytes The number of bytes to allocate. Calculated by the compiler.
277 /// @param C The MCContext that provides the allocator.
278 /// @param Alignment The alignment of the allocated memory (if the underlying
279 /// allocator supports it).
280 /// @return The allocated memory. Could be NULL.
281 inline void *operator new[](size_t Bytes, llvm::MCContext& C,
282 size_t Alignment = 16) throw () {
283 return C.Allocate(Bytes, Alignment);
286 /// @brief Placement delete[] companion to the new[] above.
288 /// This operator is just a companion to the new[] above. There is no way of
289 /// invoking it directly; see the new[] operator for more details. This operator
290 /// is called implicitly by the compiler if a placement new[] expression using
291 /// the MCContext throws in the object constructor.
292 inline void operator delete[](void *Ptr, llvm::MCContext &C) throw () {