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