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