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 environment 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;
83 /// We need a deterministic iteration order, so we remember the order
84 /// the elements were added.
85 std::vector<const MCSection *> MCLineSectionOrder;
87 /// Allocator - Allocator object used for creating machine code objects.
89 /// We use a bump pointer allocator to avoid the need to track all allocated
91 BumpPtrAllocator Allocator;
93 void *MachOUniquingMap, *ELFUniquingMap, *COFFUniquingMap;
95 explicit MCContext(const MCAsmInfo &MAI);
98 const MCAsmInfo &getAsmInfo() const { return MAI; }
100 /// @name Symbol Management
103 /// CreateTempSymbol - Create and return a new assembler temporary symbol
104 /// with a unique but unspecified name.
105 MCSymbol *CreateTempSymbol();
107 /// CreateDirectionalLocalSymbol - Create the definition of a directional
108 /// local symbol for numbered label (used for "1:" definitions).
109 MCSymbol *CreateDirectionalLocalSymbol(int64_t LocalLabelVal);
111 /// GetDirectionalLocalSymbol - Create and return a directional local
112 /// symbol for numbered label (used for "1b" or 1f" references).
113 MCSymbol *GetDirectionalLocalSymbol(int64_t LocalLabelVal, int bORf);
115 /// GetOrCreateSymbol - Lookup the symbol inside with the specified
116 /// @p Name. If it exists, return it. If not, create a forward
117 /// reference and return it.
119 /// @param Name - The symbol name, which must be unique across all symbols.
120 MCSymbol *GetOrCreateSymbol(StringRef Name);
121 MCSymbol *GetOrCreateSymbol(const Twine &Name);
123 /// LookupSymbol - Get the symbol for \p Name, or null.
124 MCSymbol *LookupSymbol(StringRef Name) const;
128 /// @name Section Management
131 /// getMachOSection - Return the MCSection for the specified mach-o section.
132 /// This requires the operands to be valid.
133 const MCSectionMachO *getMachOSection(StringRef Segment,
135 unsigned TypeAndAttributes,
138 const MCSectionMachO *getMachOSection(StringRef Segment,
140 unsigned TypeAndAttributes,
142 return getMachOSection(Segment, Section, TypeAndAttributes, 0, K);
145 const MCSectionELF *getELFSection(StringRef Section, unsigned Type,
146 unsigned Flags, SectionKind Kind);
148 const MCSectionELF *getELFSection(StringRef Section, unsigned Type,
149 unsigned Flags, SectionKind Kind,
150 unsigned EntrySize, StringRef Group);
152 const MCSectionELF *CreateELFGroupSection();
154 const MCSection *getCOFFSection(StringRef Section, unsigned Characteristics,
155 int Selection, SectionKind Kind);
157 const MCSection *getCOFFSection(StringRef Section, unsigned Characteristics,
159 return getCOFFSection (Section, Characteristics, 0, Kind);
165 /// @name Dwarf Management
168 /// GetDwarfFile - creates an entry in the dwarf file and directory tables.
169 unsigned GetDwarfFile(StringRef FileName, unsigned FileNumber);
171 bool isValidDwarfFileNumber(unsigned FileNumber);
173 bool hasDwarfFiles(void) {
174 return MCDwarfFiles.size() != 0;
177 const std::vector<MCDwarfFile *> &getMCDwarfFiles() {
180 const std::vector<StringRef> &getMCDwarfDirs() {
184 const DenseMap<const MCSection *, MCLineSection *>
185 &getMCLineSections() const {
186 return MCLineSections;
188 const std::vector<const MCSection *> &getMCLineSectionOrder() const {
189 return MCLineSectionOrder;
191 void addMCLineSection(const MCSection *Sec, MCLineSection *Line) {
192 MCLineSections[Sec] = Line;
193 MCLineSectionOrder.push_back(Sec);
196 /// setCurrentDwarfLoc - saves the information from the currently parsed
197 /// dwarf .loc directive and sets DwarfLocSeen. When the next instruction
198 /// is assembled an entry in the line number table with this information and
199 /// the address of the instruction will be created.
200 void setCurrentDwarfLoc(unsigned FileNum, unsigned Line, unsigned Column,
201 unsigned Flags, unsigned Isa,
202 unsigned Discriminator) {
203 CurrentDwarfLoc.setFileNum(FileNum);
204 CurrentDwarfLoc.setLine(Line);
205 CurrentDwarfLoc.setColumn(Column);
206 CurrentDwarfLoc.setFlags(Flags);
207 CurrentDwarfLoc.setIsa(Isa);
208 CurrentDwarfLoc.setDiscriminator(Discriminator);
211 void ClearDwarfLocSeen() { DwarfLocSeen = false; }
213 bool getDwarfLocSeen() { return DwarfLocSeen; }
214 const MCDwarfLoc &getCurrentDwarfLoc() { return CurrentDwarfLoc; }
218 char *getSecureLogFile() { return SecureLogFile; }
219 raw_ostream *getSecureLog() { return SecureLog; }
220 bool getSecureLogUsed() { return SecureLogUsed; }
221 void setSecureLog(raw_ostream *Value) {
224 void setSecureLogUsed(bool Value) {
225 SecureLogUsed = Value;
228 void *Allocate(unsigned Size, unsigned Align = 8) {
229 return Allocator.Allocate(Size, Align);
231 void Deallocate(void *Ptr) {
235 } // end namespace llvm
237 // operator new and delete aren't allowed inside namespaces.
238 // The throw specifications are mandated by the standard.
239 /// @brief Placement new for using the MCContext's allocator.
241 /// This placement form of operator new uses the MCContext's allocator for
242 /// obtaining memory. It is a non-throwing new, which means that it returns
243 /// null on error. (If that is what the allocator does. The current does, so if
244 /// this ever changes, this operator will have to be changed, too.)
245 /// Usage looks like this (assuming there's an MCContext 'Context' in scope):
247 /// // Default alignment (16)
248 /// IntegerLiteral *Ex = new (Context) IntegerLiteral(arguments);
249 /// // Specific alignment
250 /// IntegerLiteral *Ex2 = new (Context, 8) IntegerLiteral(arguments);
252 /// Please note that you cannot use delete on the pointer; it must be
253 /// deallocated using an explicit destructor call followed by
254 /// @c Context.Deallocate(Ptr).
256 /// @param Bytes The number of bytes to allocate. Calculated by the compiler.
257 /// @param C The MCContext that provides the allocator.
258 /// @param Alignment The alignment of the allocated memory (if the underlying
259 /// allocator supports it).
260 /// @return The allocated memory. Could be NULL.
261 inline void *operator new(size_t Bytes, llvm::MCContext &C,
262 size_t Alignment = 16) throw () {
263 return C.Allocate(Bytes, Alignment);
265 /// @brief Placement delete companion to the new above.
267 /// This operator is just a companion to the new above. There is no way of
268 /// invoking it directly; see the new operator for more details. This operator
269 /// is called implicitly by the compiler if a placement new expression using
270 /// the MCContext throws in the object constructor.
271 inline void operator delete(void *Ptr, llvm::MCContext &C, size_t)
276 /// This placement form of operator new[] uses the MCContext's allocator for
277 /// obtaining memory. It is a non-throwing new[], which means that it returns
279 /// Usage looks like this (assuming there's an MCContext 'Context' in scope):
281 /// // Default alignment (16)
282 /// char *data = new (Context) char[10];
283 /// // Specific alignment
284 /// char *data = new (Context, 8) char[10];
286 /// Please note that you cannot use delete on the pointer; it must be
287 /// deallocated using an explicit destructor call followed by
288 /// @c Context.Deallocate(Ptr).
290 /// @param Bytes The number of bytes to allocate. Calculated by the compiler.
291 /// @param C The MCContext that provides the allocator.
292 /// @param Alignment The alignment of the allocated memory (if the underlying
293 /// allocator supports it).
294 /// @return The allocated memory. Could be NULL.
295 inline void *operator new[](size_t Bytes, llvm::MCContext& C,
296 size_t Alignment = 16) throw () {
297 return C.Allocate(Bytes, Alignment);
300 /// @brief Placement delete[] companion to the new[] above.
302 /// This operator is just a companion to the new[] above. There is no way of
303 /// invoking it directly; see the new[] operator for more details. This operator
304 /// is called implicitly by the compiler if a placement new[] expression using
305 /// the MCContext throws in the object constructor.
306 inline void operator delete[](void *Ptr, llvm::MCContext &C) throw () {