blob: c110ffd3a772400fdcecee931225a0a8877da519 [file] [log] [blame]
Andrew Scull5e1ddfa2018-08-14 10:06:54 +01001//===- 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/ADT/DenseMap.h"
14#include "llvm/ADT/Optional.h"
15#include "llvm/ADT/SetVector.h"
16#include "llvm/ADT/SmallString.h"
17#include "llvm/ADT/SmallVector.h"
18#include "llvm/ADT/StringMap.h"
19#include "llvm/ADT/StringRef.h"
20#include "llvm/ADT/Twine.h"
21#include "llvm/BinaryFormat/Dwarf.h"
22#include "llvm/MC/MCAsmMacro.h"
23#include "llvm/MC/MCDwarf.h"
24#include "llvm/MC/MCSubtargetInfo.h"
25#include "llvm/MC/SectionKind.h"
26#include "llvm/Support/Allocator.h"
27#include "llvm/Support/Compiler.h"
28#include "llvm/Support/Error.h"
29#include "llvm/Support/MD5.h"
30#include "llvm/Support/raw_ostream.h"
31#include <algorithm>
32#include <cassert>
33#include <cstddef>
34#include <cstdint>
35#include <map>
36#include <memory>
37#include <string>
38#include <utility>
39#include <vector>
40
41namespace llvm {
42
43 class CodeViewContext;
44 class MCAsmInfo;
45 class MCLabel;
46 class MCObjectFileInfo;
47 class MCRegisterInfo;
48 class MCSection;
49 class MCSectionCOFF;
50 class MCSectionELF;
51 class MCSectionMachO;
52 class MCSectionWasm;
53 class MCStreamer;
54 class MCSymbol;
55 class MCSymbolELF;
56 class MCSymbolWasm;
57 class SMLoc;
58 class SourceMgr;
59
60 /// Context object for machine code objects. This class owns all of the
61 /// sections that it creates.
62 ///
63 class MCContext {
64 public:
65 using SymbolTable = StringMap<MCSymbol *, BumpPtrAllocator &>;
66
67 private:
68 /// The SourceMgr for this object, if any.
69 const SourceMgr *SrcMgr;
70
71 /// The SourceMgr for inline assembly, if any.
72 SourceMgr *InlineSrcMgr;
73
74 /// The MCAsmInfo for this target.
75 const MCAsmInfo *MAI;
76
77 /// The MCRegisterInfo for this target.
78 const MCRegisterInfo *MRI;
79
80 /// The MCObjectFileInfo for this target.
81 const MCObjectFileInfo *MOFI;
82
83 std::unique_ptr<CodeViewContext> CVContext;
84
85 /// Allocator object used for creating machine code objects.
86 ///
87 /// We use a bump pointer allocator to avoid the need to track all allocated
88 /// objects.
89 BumpPtrAllocator Allocator;
90
91 SpecificBumpPtrAllocator<MCSectionCOFF> COFFAllocator;
92 SpecificBumpPtrAllocator<MCSectionELF> ELFAllocator;
93 SpecificBumpPtrAllocator<MCSectionMachO> MachOAllocator;
94 SpecificBumpPtrAllocator<MCSectionWasm> WasmAllocator;
95
96 /// Bindings of names to symbols.
97 SymbolTable Symbols;
98
99 /// A mapping from a local label number and an instance count to a symbol.
100 /// For example, in the assembly
101 /// 1:
102 /// 2:
103 /// 1:
104 /// We have three labels represented by the pairs (1, 0), (2, 0) and (1, 1)
105 DenseMap<std::pair<unsigned, unsigned>, MCSymbol *> LocalSymbols;
106
107 /// Keeps tracks of names that were used both for used declared and
108 /// artificial symbols. The value is "true" if the name has been used for a
109 /// non-section symbol (there can be at most one of those, plus an unlimited
110 /// number of section symbols with the same name).
111 StringMap<bool, BumpPtrAllocator &> UsedNames;
112
113 /// The next ID to dole out to an unnamed assembler temporary symbol with
114 /// a given prefix.
115 StringMap<unsigned> NextID;
116
117 /// Instances of directional local labels.
118 DenseMap<unsigned, MCLabel *> Instances;
119 /// NextInstance() creates the next instance of the directional local label
120 /// for the LocalLabelVal and adds it to the map if needed.
121 unsigned NextInstance(unsigned LocalLabelVal);
122 /// GetInstance() gets the current instance of the directional local label
123 /// for the LocalLabelVal and adds it to the map if needed.
124 unsigned GetInstance(unsigned LocalLabelVal);
125
126 /// The file name of the log file from the environment variable
127 /// AS_SECURE_LOG_FILE. Which must be set before the .secure_log_unique
128 /// directive is used or it is an error.
129 char *SecureLogFile;
130 /// The stream that gets written to for the .secure_log_unique directive.
131 std::unique_ptr<raw_fd_ostream> SecureLog;
132 /// Boolean toggled when .secure_log_unique / .secure_log_reset is seen to
133 /// catch errors if .secure_log_unique appears twice without
134 /// .secure_log_reset appearing between them.
135 bool SecureLogUsed = false;
136
137 /// The compilation directory to use for DW_AT_comp_dir.
138 SmallString<128> CompilationDir;
139
140 /// The main file name if passed in explicitly.
141 std::string MainFileName;
142
143 /// The dwarf file and directory tables from the dwarf .file directive.
144 /// We now emit a line table for each compile unit. To reduce the prologue
145 /// size of each line table, the files and directories used by each compile
146 /// unit are separated.
147 std::map<unsigned, MCDwarfLineTable> MCDwarfLineTablesCUMap;
148
149 /// The current dwarf line information from the last dwarf .loc directive.
150 MCDwarfLoc CurrentDwarfLoc;
151 bool DwarfLocSeen = false;
152
153 /// Generate dwarf debugging info for assembly source files.
154 bool GenDwarfForAssembly = false;
155
156 /// The current dwarf file number when generate dwarf debugging info for
157 /// assembly source files.
158 unsigned GenDwarfFileNumber = 0;
159
160 /// Sections for generating the .debug_ranges and .debug_aranges sections.
161 SetVector<MCSection *> SectionsForRanges;
162
163 /// The information gathered from labels that will have dwarf label
164 /// entries when generating dwarf assembly source files.
165 std::vector<MCGenDwarfLabelEntry> MCGenDwarfLabelEntries;
166
167 /// The string to embed in the debug information for the compile unit, if
168 /// non-empty.
169 StringRef DwarfDebugFlags;
170
171 /// The string to embed in as the dwarf AT_producer for the compile unit, if
172 /// non-empty.
173 StringRef DwarfDebugProducer;
174
175 /// The maximum version of dwarf that we should emit.
176 uint16_t DwarfVersion = 4;
177
178 /// Honor temporary labels, this is useful for debugging semantic
179 /// differences between temporary and non-temporary labels (primarily on
180 /// Darwin).
181 bool AllowTemporaryLabels = true;
182 bool UseNamesOnTempLabels = true;
183
184 /// The Compile Unit ID that we are currently processing.
185 unsigned DwarfCompileUnitID = 0;
186
187 struct ELFSectionKey {
188 std::string SectionName;
189 StringRef GroupName;
190 unsigned UniqueID;
191
192 ELFSectionKey(StringRef SectionName, StringRef GroupName,
193 unsigned UniqueID)
194 : SectionName(SectionName), GroupName(GroupName), UniqueID(UniqueID) {
195 }
196
197 bool operator<(const ELFSectionKey &Other) const {
198 if (SectionName != Other.SectionName)
199 return SectionName < Other.SectionName;
200 if (GroupName != Other.GroupName)
201 return GroupName < Other.GroupName;
202 return UniqueID < Other.UniqueID;
203 }
204 };
205
206 struct COFFSectionKey {
207 std::string SectionName;
208 StringRef GroupName;
209 int SelectionKey;
210 unsigned UniqueID;
211
212 COFFSectionKey(StringRef SectionName, StringRef GroupName,
213 int SelectionKey, unsigned UniqueID)
214 : SectionName(SectionName), GroupName(GroupName),
215 SelectionKey(SelectionKey), UniqueID(UniqueID) {}
216
217 bool operator<(const COFFSectionKey &Other) const {
218 if (SectionName != Other.SectionName)
219 return SectionName < Other.SectionName;
220 if (GroupName != Other.GroupName)
221 return GroupName < Other.GroupName;
222 if (SelectionKey != Other.SelectionKey)
223 return SelectionKey < Other.SelectionKey;
224 return UniqueID < Other.UniqueID;
225 }
226 };
227
228 struct WasmSectionKey {
229 std::string SectionName;
230 StringRef GroupName;
231 unsigned UniqueID;
232
233 WasmSectionKey(StringRef SectionName, StringRef GroupName,
234 unsigned UniqueID)
235 : SectionName(SectionName), GroupName(GroupName), UniqueID(UniqueID) {
236 }
237
238 bool operator<(const WasmSectionKey &Other) const {
239 if (SectionName != Other.SectionName)
240 return SectionName < Other.SectionName;
241 if (GroupName != Other.GroupName)
242 return GroupName < Other.GroupName;
243 return UniqueID < Other.UniqueID;
244 }
245 };
246
247 StringMap<MCSectionMachO *> MachOUniquingMap;
248 std::map<ELFSectionKey, MCSectionELF *> ELFUniquingMap;
249 std::map<COFFSectionKey, MCSectionCOFF *> COFFUniquingMap;
250 std::map<WasmSectionKey, MCSectionWasm *> WasmUniquingMap;
251 StringMap<bool> RelSecNames;
252
253 SpecificBumpPtrAllocator<MCSubtargetInfo> MCSubtargetAllocator;
254
255 /// Do automatic reset in destructor
256 bool AutoReset;
257
258 bool HadError = false;
259
260 MCSymbol *createSymbolImpl(const StringMapEntry<bool> *Name,
261 bool CanBeUnnamed);
262 MCSymbol *createSymbol(StringRef Name, bool AlwaysAddSuffix,
263 bool IsTemporary);
264
265 MCSymbol *getOrCreateDirectionalLocalSymbol(unsigned LocalLabelVal,
266 unsigned Instance);
267
268 MCSectionELF *createELFSectionImpl(StringRef Section, unsigned Type,
269 unsigned Flags, SectionKind K,
270 unsigned EntrySize,
271 const MCSymbolELF *Group,
272 unsigned UniqueID,
273 const MCSymbolELF *Associated);
274
275 /// \brief Map of currently defined macros.
276 StringMap<MCAsmMacro> MacroMap;
277
278 public:
279 explicit MCContext(const MCAsmInfo *MAI, const MCRegisterInfo *MRI,
280 const MCObjectFileInfo *MOFI,
281 const SourceMgr *Mgr = nullptr, bool DoAutoReset = true);
282 MCContext(const MCContext &) = delete;
283 MCContext &operator=(const MCContext &) = delete;
284 ~MCContext();
285
286 const SourceMgr *getSourceManager() const { return SrcMgr; }
287
288 void setInlineSourceManager(SourceMgr *SM) { InlineSrcMgr = SM; }
289
290 const MCAsmInfo *getAsmInfo() const { return MAI; }
291
292 const MCRegisterInfo *getRegisterInfo() const { return MRI; }
293
294 const MCObjectFileInfo *getObjectFileInfo() const { return MOFI; }
295
296 CodeViewContext &getCVContext();
297
298 void setAllowTemporaryLabels(bool Value) { AllowTemporaryLabels = Value; }
299 void setUseNamesOnTempLabels(bool Value) { UseNamesOnTempLabels = Value; }
300
301 /// \name Module Lifetime Management
302 /// @{
303
304 /// reset - return object to right after construction state to prepare
305 /// to process a new module
306 void reset();
307
308 /// @}
309
310 /// \name Symbol Management
311 /// @{
312
313 /// Create and return a new linker temporary symbol with a unique but
314 /// unspecified name.
315 MCSymbol *createLinkerPrivateTempSymbol();
316
317 /// Create and return a new assembler temporary symbol with a unique but
318 /// unspecified name.
319 MCSymbol *createTempSymbol(bool CanBeUnnamed = true);
320
321 MCSymbol *createTempSymbol(const Twine &Name, bool AlwaysAddSuffix,
322 bool CanBeUnnamed = true);
323
324 /// Create the definition of a directional local symbol for numbered label
325 /// (used for "1:" definitions).
326 MCSymbol *createDirectionalLocalSymbol(unsigned LocalLabelVal);
327
328 /// Create and return a directional local symbol for numbered label (used
329 /// for "1b" or 1f" references).
330 MCSymbol *getDirectionalLocalSymbol(unsigned LocalLabelVal, bool Before);
331
332 /// Lookup the symbol inside with the specified \p Name. If it exists,
333 /// return it. If not, create a forward reference and return it.
334 ///
335 /// \param Name - The symbol name, which must be unique across all symbols.
336 MCSymbol *getOrCreateSymbol(const Twine &Name);
337
338 /// Gets a symbol that will be defined to the final stack offset of a local
339 /// variable after codegen.
340 ///
341 /// \param Idx - The index of a local variable passed to @llvm.localescape.
342 MCSymbol *getOrCreateFrameAllocSymbol(StringRef FuncName, unsigned Idx);
343
344 MCSymbol *getOrCreateParentFrameOffsetSymbol(StringRef FuncName);
345
346 MCSymbol *getOrCreateLSDASymbol(StringRef FuncName);
347
348 /// Get the symbol for \p Name, or null.
349 MCSymbol *lookupSymbol(const Twine &Name) const;
350
351 /// Set value for a symbol.
352 void setSymbolValue(MCStreamer &Streamer, StringRef Sym, uint64_t Val);
353
354 /// getSymbols - Get a reference for the symbol table for clients that
355 /// want to, for example, iterate over all symbols. 'const' because we
356 /// still want any modifications to the table itself to use the MCContext
357 /// APIs.
358 const SymbolTable &getSymbols() const { return Symbols; }
359
360 /// @}
361
362 /// \name Section Management
363 /// @{
364
365 enum : unsigned {
366 /// Pass this value as the UniqueID during section creation to get the
367 /// generic section with the given name and characteristics. The usual
368 /// sections such as .text use this ID.
369 GenericSectionID = ~0U
370 };
371
372 /// Return the MCSection for the specified mach-o section. This requires
373 /// the operands to be valid.
374 MCSectionMachO *getMachOSection(StringRef Segment, StringRef Section,
375 unsigned TypeAndAttributes,
376 unsigned Reserved2, SectionKind K,
377 const char *BeginSymName = nullptr);
378
379 MCSectionMachO *getMachOSection(StringRef Segment, StringRef Section,
380 unsigned TypeAndAttributes, SectionKind K,
381 const char *BeginSymName = nullptr) {
382 return getMachOSection(Segment, Section, TypeAndAttributes, 0, K,
383 BeginSymName);
384 }
385
386 MCSectionELF *getELFSection(const Twine &Section, unsigned Type,
387 unsigned Flags) {
388 return getELFSection(Section, Type, Flags, 0, "");
389 }
390
391 MCSectionELF *getELFSection(const Twine &Section, unsigned Type,
392 unsigned Flags, unsigned EntrySize,
393 const Twine &Group) {
394 return getELFSection(Section, Type, Flags, EntrySize, Group, ~0);
395 }
396
397 MCSectionELF *getELFSection(const Twine &Section, unsigned Type,
398 unsigned Flags, unsigned EntrySize,
399 const Twine &Group, unsigned UniqueID) {
400 return getELFSection(Section, Type, Flags, EntrySize, Group, UniqueID,
401 nullptr);
402 }
403
404 MCSectionELF *getELFSection(const Twine &Section, unsigned Type,
405 unsigned Flags, unsigned EntrySize,
406 const Twine &Group, unsigned UniqueID,
407 const MCSymbolELF *Associated);
408
409 MCSectionELF *getELFSection(const Twine &Section, unsigned Type,
410 unsigned Flags, unsigned EntrySize,
411 const MCSymbolELF *Group, unsigned UniqueID,
412 const MCSymbolELF *Associated);
413
414 /// Get a section with the provided group identifier. This section is
415 /// named by concatenating \p Prefix with '.' then \p Suffix. The \p Type
416 /// describes the type of the section and \p Flags are used to further
417 /// configure this named section.
418 MCSectionELF *getELFNamedSection(const Twine &Prefix, const Twine &Suffix,
419 unsigned Type, unsigned Flags,
420 unsigned EntrySize = 0);
421
422 MCSectionELF *createELFRelSection(const Twine &Name, unsigned Type,
423 unsigned Flags, unsigned EntrySize,
424 const MCSymbolELF *Group,
425 const MCSectionELF *RelInfoSection);
426
427 void renameELFSection(MCSectionELF *Section, StringRef Name);
428
429 MCSectionELF *createELFGroupSection(const MCSymbolELF *Group);
430
431 MCSectionCOFF *getCOFFSection(StringRef Section, unsigned Characteristics,
432 SectionKind Kind, StringRef COMDATSymName,
433 int Selection,
434 unsigned UniqueID = GenericSectionID,
435 const char *BeginSymName = nullptr);
436
437 MCSectionCOFF *getCOFFSection(StringRef Section, unsigned Characteristics,
438 SectionKind Kind,
439 const char *BeginSymName = nullptr);
440
441 MCSectionCOFF *getCOFFSection(StringRef Section);
442
443 /// Gets or creates a section equivalent to Sec that is associated with the
444 /// section containing KeySym. For example, to create a debug info section
445 /// associated with an inline function, pass the normal debug info section
446 /// as Sec and the function symbol as KeySym.
447 MCSectionCOFF *
448 getAssociativeCOFFSection(MCSectionCOFF *Sec, const MCSymbol *KeySym,
449 unsigned UniqueID = GenericSectionID);
450
451 MCSectionWasm *getWasmSection(const Twine &Section, SectionKind K) {
452 return getWasmSection(Section, K, nullptr);
453 }
454
455 MCSectionWasm *getWasmSection(const Twine &Section, SectionKind K,
456 const char *BeginSymName) {
457 return getWasmSection(Section, K, "", ~0, BeginSymName);
458 }
459
460 MCSectionWasm *getWasmSection(const Twine &Section, SectionKind K,
461 const Twine &Group, unsigned UniqueID) {
462 return getWasmSection(Section, K, Group, UniqueID, nullptr);
463 }
464
465 MCSectionWasm *getWasmSection(const Twine &Section, SectionKind K,
466 const Twine &Group, unsigned UniqueID,
467 const char *BeginSymName);
468
469 MCSectionWasm *getWasmSection(const Twine &Section, SectionKind K,
470 const MCSymbolWasm *Group, unsigned UniqueID,
471 const char *BeginSymName);
472
473 // Create and save a copy of STI and return a reference to the copy.
474 MCSubtargetInfo &getSubtargetCopy(const MCSubtargetInfo &STI);
475
476 /// @}
477
478 /// \name Dwarf Management
479 /// @{
480
481 /// \brief Get the compilation directory for DW_AT_comp_dir
482 /// The compilation directory should be set with \c setCompilationDir before
483 /// calling this function. If it is unset, an empty string will be returned.
484 StringRef getCompilationDir() const { return CompilationDir; }
485
486 /// \brief Set the compilation directory for DW_AT_comp_dir
487 void setCompilationDir(StringRef S) { CompilationDir = S.str(); }
488
489 /// \brief Get the main file name for use in error messages and debug
490 /// info. This can be set to ensure we've got the correct file name
491 /// after preprocessing or for -save-temps.
492 const std::string &getMainFileName() const { return MainFileName; }
493
494 /// \brief Set the main file name and override the default.
495 void setMainFileName(StringRef S) { MainFileName = S; }
496
497 /// Creates an entry in the dwarf file and directory tables.
498 Expected<unsigned> getDwarfFile(StringRef Directory, StringRef FileName,
499 unsigned FileNumber,
500 MD5::MD5Result *Checksum,
501 Optional<StringRef> Source, unsigned CUID);
502
503 bool isValidDwarfFileNumber(unsigned FileNumber, unsigned CUID = 0);
504
505 const std::map<unsigned, MCDwarfLineTable> &getMCDwarfLineTables() const {
506 return MCDwarfLineTablesCUMap;
507 }
508
509 MCDwarfLineTable &getMCDwarfLineTable(unsigned CUID) {
510 return MCDwarfLineTablesCUMap[CUID];
511 }
512
513 const MCDwarfLineTable &getMCDwarfLineTable(unsigned CUID) const {
514 auto I = MCDwarfLineTablesCUMap.find(CUID);
515 assert(I != MCDwarfLineTablesCUMap.end());
516 return I->second;
517 }
518
519 const SmallVectorImpl<MCDwarfFile> &getMCDwarfFiles(unsigned CUID = 0) {
520 return getMCDwarfLineTable(CUID).getMCDwarfFiles();
521 }
522
523 const SmallVectorImpl<std::string> &getMCDwarfDirs(unsigned CUID = 0) {
524 return getMCDwarfLineTable(CUID).getMCDwarfDirs();
525 }
526
527 bool hasMCLineSections() const {
528 for (const auto &Table : MCDwarfLineTablesCUMap)
529 if (!Table.second.getMCDwarfFiles().empty() || Table.second.getLabel())
530 return true;
531 return false;
532 }
533
534 unsigned getDwarfCompileUnitID() { return DwarfCompileUnitID; }
535
536 void setDwarfCompileUnitID(unsigned CUIndex) {
537 DwarfCompileUnitID = CUIndex;
538 }
539
540 /// Specifies the "root" file and directory of the compilation unit.
541 /// These are "file 0" and "directory 0" in DWARF v5.
542 void setMCLineTableRootFile(unsigned CUID, StringRef CompilationDir,
543 StringRef Filename, MD5::MD5Result *Checksum,
544 Optional<StringRef> Source) {
545 getMCDwarfLineTable(CUID).setRootFile(CompilationDir, Filename, Checksum,
546 Source);
547 }
548
549 /// Saves the information from the currently parsed dwarf .loc directive
550 /// and sets DwarfLocSeen. When the next instruction is assembled an entry
551 /// in the line number table with this information and the address of the
552 /// instruction will be created.
553 void setCurrentDwarfLoc(unsigned FileNum, unsigned Line, unsigned Column,
554 unsigned Flags, unsigned Isa,
555 unsigned Discriminator) {
556 CurrentDwarfLoc.setFileNum(FileNum);
557 CurrentDwarfLoc.setLine(Line);
558 CurrentDwarfLoc.setColumn(Column);
559 CurrentDwarfLoc.setFlags(Flags);
560 CurrentDwarfLoc.setIsa(Isa);
561 CurrentDwarfLoc.setDiscriminator(Discriminator);
562 DwarfLocSeen = true;
563 }
564
565 void clearDwarfLocSeen() { DwarfLocSeen = false; }
566
567 bool getDwarfLocSeen() { return DwarfLocSeen; }
568 const MCDwarfLoc &getCurrentDwarfLoc() { return CurrentDwarfLoc; }
569
570 bool getGenDwarfForAssembly() { return GenDwarfForAssembly; }
571 void setGenDwarfForAssembly(bool Value) { GenDwarfForAssembly = Value; }
572 unsigned getGenDwarfFileNumber() { return GenDwarfFileNumber; }
573
574 void setGenDwarfFileNumber(unsigned FileNumber) {
575 GenDwarfFileNumber = FileNumber;
576 }
577
578 const SetVector<MCSection *> &getGenDwarfSectionSyms() {
579 return SectionsForRanges;
580 }
581
582 bool addGenDwarfSection(MCSection *Sec) {
583 return SectionsForRanges.insert(Sec);
584 }
585
586 void finalizeDwarfSections(MCStreamer &MCOS);
587
588 const std::vector<MCGenDwarfLabelEntry> &getMCGenDwarfLabelEntries() const {
589 return MCGenDwarfLabelEntries;
590 }
591
592 void addMCGenDwarfLabelEntry(const MCGenDwarfLabelEntry &E) {
593 MCGenDwarfLabelEntries.push_back(E);
594 }
595
596 void setDwarfDebugFlags(StringRef S) { DwarfDebugFlags = S; }
597 StringRef getDwarfDebugFlags() { return DwarfDebugFlags; }
598
599 void setDwarfDebugProducer(StringRef S) { DwarfDebugProducer = S; }
600 StringRef getDwarfDebugProducer() { return DwarfDebugProducer; }
601
602 dwarf::DwarfFormat getDwarfFormat() const {
603 // TODO: Support DWARF64
604 return dwarf::DWARF32;
605 }
606
607 void setDwarfVersion(uint16_t v) { DwarfVersion = v; }
608 uint16_t getDwarfVersion() const { return DwarfVersion; }
609
610 /// @}
611
612 char *getSecureLogFile() { return SecureLogFile; }
613 raw_fd_ostream *getSecureLog() { return SecureLog.get(); }
614
615 void setSecureLog(std::unique_ptr<raw_fd_ostream> Value) {
616 SecureLog = std::move(Value);
617 }
618
619 bool getSecureLogUsed() { return SecureLogUsed; }
620 void setSecureLogUsed(bool Value) { SecureLogUsed = Value; }
621
622 void *allocate(unsigned Size, unsigned Align = 8) {
623 return Allocator.Allocate(Size, Align);
624 }
625
626 void deallocate(void *Ptr) {}
627
628 bool hadError() { return HadError; }
629 void reportError(SMLoc L, const Twine &Msg);
630 // Unrecoverable error has occurred. Display the best diagnostic we can
631 // and bail via exit(1). For now, most MC backend errors are unrecoverable.
632 // FIXME: We should really do something about that.
633 LLVM_ATTRIBUTE_NORETURN void reportFatalError(SMLoc L,
634 const Twine &Msg);
635
636 const MCAsmMacro *lookupMacro(StringRef Name) {
637 StringMap<MCAsmMacro>::iterator I = MacroMap.find(Name);
638 return (I == MacroMap.end()) ? nullptr : &I->getValue();
639 }
640
641 void defineMacro(StringRef Name, MCAsmMacro Macro) {
642 MacroMap.insert(std::make_pair(Name, std::move(Macro)));
643 }
644
645 void undefineMacro(StringRef Name) { MacroMap.erase(Name); }
646 };
647
648} // end namespace llvm
649
650// operator new and delete aren't allowed inside namespaces.
651// The throw specifications are mandated by the standard.
652/// \brief Placement new for using the MCContext's allocator.
653///
654/// This placement form of operator new uses the MCContext's allocator for
655/// obtaining memory. It is a non-throwing new, which means that it returns
656/// null on error. (If that is what the allocator does. The current does, so if
657/// this ever changes, this operator will have to be changed, too.)
658/// Usage looks like this (assuming there's an MCContext 'Context' in scope):
659/// \code
660/// // Default alignment (8)
661/// IntegerLiteral *Ex = new (Context) IntegerLiteral(arguments);
662/// // Specific alignment
663/// IntegerLiteral *Ex2 = new (Context, 4) IntegerLiteral(arguments);
664/// \endcode
665/// Please note that you cannot use delete on the pointer; it must be
666/// deallocated using an explicit destructor call followed by
667/// \c Context.Deallocate(Ptr).
668///
669/// \param Bytes The number of bytes to allocate. Calculated by the compiler.
670/// \param C The MCContext that provides the allocator.
671/// \param Alignment The alignment of the allocated memory (if the underlying
672/// allocator supports it).
673/// \return The allocated memory. Could be NULL.
674inline void *operator new(size_t Bytes, llvm::MCContext &C,
675 size_t Alignment = 8) noexcept {
676 return C.allocate(Bytes, Alignment);
677}
678/// \brief Placement delete companion to the new above.
679///
680/// This operator is just a companion to the new above. There is no way of
681/// invoking it directly; see the new operator for more details. This operator
682/// is called implicitly by the compiler if a placement new expression using
683/// the MCContext throws in the object constructor.
684inline void operator delete(void *Ptr, llvm::MCContext &C, size_t) noexcept {
685 C.deallocate(Ptr);
686}
687
688/// This placement form of operator new[] uses the MCContext's allocator for
689/// obtaining memory. It is a non-throwing new[], which means that it returns
690/// null on error.
691/// Usage looks like this (assuming there's an MCContext 'Context' in scope):
692/// \code
693/// // Default alignment (8)
694/// char *data = new (Context) char[10];
695/// // Specific alignment
696/// char *data = new (Context, 4) char[10];
697/// \endcode
698/// Please note that you cannot use delete on the pointer; it must be
699/// deallocated using an explicit destructor call followed by
700/// \c Context.Deallocate(Ptr).
701///
702/// \param Bytes The number of bytes to allocate. Calculated by the compiler.
703/// \param C The MCContext that provides the allocator.
704/// \param Alignment The alignment of the allocated memory (if the underlying
705/// allocator supports it).
706/// \return The allocated memory. Could be NULL.
707inline void *operator new[](size_t Bytes, llvm::MCContext &C,
708 size_t Alignment = 8) noexcept {
709 return C.allocate(Bytes, Alignment);
710}
711
712/// \brief Placement delete[] companion to the new[] above.
713///
714/// This operator is just a companion to the new[] above. There is no way of
715/// invoking it directly; see the new[] operator for more details. This operator
716/// is called implicitly by the compiler if a placement new[] expression using
717/// the MCContext throws in the object constructor.
718inline void operator delete[](void *Ptr, llvm::MCContext &C) noexcept {
719 C.deallocate(Ptr);
720}
721
722#endif // LLVM_MC_MCCONTEXT_H