include/llvm/MC/MCContext.h

   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/SetVector.h"
  15 #include "llvm/ADT/SmallString.h"
  16 #include "llvm/ADT/SmallVector.h"
  17 #include "llvm/ADT/StringMap.h"
  18 #include "llvm/MC/MCDwarf.h"
  19 #include "llvm/MC/MCStreamer.h"
  20 #include "llvm/MC/SectionKind.h"
  21 #include "llvm/Support/Allocator.h"
  22 #include "llvm/Support/Compiler.h"
  23 #include "llvm/Support/raw_ostream.h"
  24 #include <map>
  25 #include <tuple>
  26 #include <vector> // FIXME: Shouldn't be needed.
  27
  28 namespace llvm {
  29   class MCAsmInfo;
  30   class MCExpr;
  31   class MCSection;
  32   class MCSymbol;
  33   class MCLabel;
  34   struct MCDwarfFile;
  35   class MCDwarfLoc;
  36   class MCObjectFileInfo;
  37   class MCRegisterInfo;
  38   class MCLineSection;
  39   class SMLoc;
  40   class StringRef;
  41   class Twine;
  42   class MCSectionMachO;
  43   class MCSectionELF;
  44   class MCSectionCOFF;
  45
  46   /// MCContext - Context object for machine code objects.  This class owns all
  47   /// of the sections that it creates.
  48   ///
  49   class MCContext {
  50     MCContext(const MCContext&) LLVM_DELETED_FUNCTION;
  51     MCContext &operator=(const MCContext&) LLVM_DELETED_FUNCTION;
  52   public:
  53     typedef StringMap<MCSymbol*, BumpPtrAllocator&> SymbolTable;
  54   private:
  55     /// The SourceMgr for this object, if any.
  56     const SourceMgr *SrcMgr;
  57
  58     /// The MCAsmInfo for this target.
  59     const MCAsmInfo *MAI;
  60
  61     /// The MCRegisterInfo for this target.
  62     const MCRegisterInfo *MRI;
  63
  64     /// The MCObjectFileInfo for this target.
  65     const MCObjectFileInfo *MOFI;
  66
  67     /// Allocator - Allocator object used for creating machine code objects.
  68     ///
  69     /// We use a bump pointer allocator to avoid the need to track all allocated
  70     /// objects.
  71     BumpPtrAllocator Allocator;
  72
  73     /// Symbols - Bindings of names to symbols.
  74     SymbolTable Symbols;
  75
  76     /// ELF sections can have a corresponding symbol. This maps one to the
  77     /// other.
  78     DenseMap<const MCSectionELF*, MCSymbol*> SectionSymbols;
  79
  80     /// A maping from a local label number and an instance count to a symbol.
  81     /// For example, in the assembly
  82     ///     1:
  83     ///     2:
  84     ///     1:
  85     /// We have three labels represented by the pairs (1, 0), (2, 0) and (1, 1)
  86     DenseMap<std::pair<unsigned, unsigned>, MCSymbol*> LocalSymbols;
  87
  88     /// UsedNames - Keeps tracks of names that were used both for used declared
  89     /// and artificial symbols.
  90     StringMap<bool, BumpPtrAllocator&> UsedNames;
  91
  92     /// NextUniqueID - The next ID to dole out to an unnamed assembler temporary
  93     /// symbol.
  94     unsigned NextUniqueID;
  95
  96     /// Instances of directional local labels.
  97     DenseMap<unsigned, MCLabel *> Instances;
  98     /// NextInstance() creates the next instance of the directional local label
  99     /// for the LocalLabelVal and adds it to the map if needed.
 100     unsigned NextInstance(unsigned LocalLabelVal);
 101     /// GetInstance() gets the current instance of the directional local label
 102     /// for the LocalLabelVal and adds it to the map if needed.
 103     unsigned GetInstance(unsigned LocalLabelVal);
 104
 105     /// The file name of the log file from the environment variable
 106     /// AS_SECURE_LOG_FILE.  Which must be set before the .secure_log_unique
 107     /// directive is used or it is an error.
 108     char *SecureLogFile;
 109     /// The stream that gets written to for the .secure_log_unique directive.
 110     raw_ostream *SecureLog;
 111     /// Boolean toggled when .secure_log_unique / .secure_log_reset is seen to
 112     /// catch errors if .secure_log_unique appears twice without
 113     /// .secure_log_reset appearing between them.
 114     bool SecureLogUsed;
 115
 116     /// The compilation directory to use for DW_AT_comp_dir.
 117     SmallString<128> CompilationDir;
 118
 119     /// The main file name if passed in explicitly.
 120     std::string MainFileName;
 121
 122     /// The dwarf file and directory tables from the dwarf .file directive.
 123     /// We now emit a line table for each compile unit. To reduce the prologue
 124     /// size of each line table, the files and directories used by each compile
 125     /// unit are separated.
 126     std::map<unsigned, MCDwarfLineTable> MCDwarfLineTablesCUMap;
 127
 128     /// The current dwarf line information from the last dwarf .loc directive.
 129     MCDwarfLoc CurrentDwarfLoc;
 130     bool DwarfLocSeen;
 131
 132     /// Generate dwarf debugging info for assembly source files.
 133     bool GenDwarfForAssembly;
 134
 135     /// The current dwarf file number when generate dwarf debugging info for
 136     /// assembly source files.
 137     unsigned GenDwarfFileNumber;
 138
 139     /// Symbols created for the start and end of each section, used for
 140     /// generating the .debug_ranges and .debug_aranges sections.
 141     MapVector<const MCSection *, std::pair<MCSymbol *, MCSymbol *> >
 142     SectionStartEndSyms;
 143
 144     /// The information gathered from labels that will have dwarf label
 145     /// entries when generating dwarf assembly source files.
 146     std::vector<MCGenDwarfLabelEntry> MCGenDwarfLabelEntries;
 147
 148     /// The string to embed in the debug information for the compile unit, if
 149     /// non-empty.
 150     StringRef DwarfDebugFlags;
 151
 152     /// The string to embed in as the dwarf AT_producer for the compile unit, if
 153     /// non-empty.
 154     StringRef DwarfDebugProducer;
 155
 156     /// The maximum version of dwarf that we should emit.
 157     uint16_t DwarfVersion;
 158
 159     /// Honor temporary labels, this is useful for debugging semantic
 160     /// differences between temporary and non-temporary labels (primarily on
 161     /// Darwin).
 162     bool AllowTemporaryLabels;
 163
 164     /// The Compile Unit ID that we are currently processing.
 165     unsigned DwarfCompileUnitID;
 166
 167     typedef std::pair<std::string, std::string> SectionGroupPair;
 168     typedef std::tuple<std::string, std::string, int> SectionGroupTriple;
 169
 170     StringMap<const MCSectionMachO*> MachOUniquingMap;
 171     std::map<SectionGroupPair, const MCSectionELF *> ELFUniquingMap;
 172     std::map<SectionGroupTriple, const MCSectionCOFF *> COFFUniquingMap;
 173
 174     /// Do automatic reset in destructor
 175     bool AutoReset;
 176
 177     MCSymbol *CreateSymbol(StringRef Name);
 178
 179     MCSymbol *getOrCreateDirectionalLocalSymbol(unsigned LocalLabelVal,
 180                                                 unsigned Instance);
 181
 182   public:
 183     explicit MCContext(const MCAsmInfo *MAI, const MCRegisterInfo *MRI,
 184                        const MCObjectFileInfo *MOFI,
 185                        const SourceMgr *Mgr = nullptr, bool DoAutoReset = true);
 186     ~MCContext();
 187
 188     const SourceMgr *getSourceManager() const { return SrcMgr; }
 189
 190     const MCAsmInfo *getAsmInfo() const { return MAI; }
 191
 192     const MCRegisterInfo *getRegisterInfo() const { return MRI; }
 193
 194     const MCObjectFileInfo *getObjectFileInfo() const { return MOFI; }
 195
 196     void setAllowTemporaryLabels(bool Value) { AllowTemporaryLabels = Value; }
 197
 198     /// @name Module Lifetime Management
 199     /// @{
 200
 201     /// reset - return object to right after construction state to prepare
 202     /// to process a new module
 203     void reset();
 204
 205     /// @}
 206
 207     /// @name Symbol Management
 208     /// @{
 209
 210     /// CreateLinkerPrivateTempSymbol - Create and return a new linker temporary
 211     /// symbol with a unique but unspecified name.
 212     MCSymbol *CreateLinkerPrivateTempSymbol();
 213
 214     /// CreateTempSymbol - Create and return a new assembler temporary symbol
 215     /// with a unique but unspecified name.
 216     MCSymbol *CreateTempSymbol();
 217
 218     /// getUniqueSymbolID() - Return a unique identifier for use in constructing
 219     /// symbol names.
 220     unsigned getUniqueSymbolID() { return NextUniqueID++; }
 221
 222     /// Create the definition of a directional local symbol for numbered label
 223     /// (used for "1:" definitions).
 224     MCSymbol *CreateDirectionalLocalSymbol(unsigned LocalLabelVal);
 225
 226     /// Create and return a directional local symbol for numbered label (used
 227     /// for "1b" or 1f" references).
 228     MCSymbol *GetDirectionalLocalSymbol(unsigned LocalLabelVal, bool Before);
 229
 230     /// GetOrCreateSymbol - Lookup the symbol inside with the specified
 231     /// @p Name.  If it exists, return it.  If not, create a forward
 232     /// reference and return it.
 233     ///
 234     /// @param Name - The symbol name, which must be unique across all symbols.
 235     MCSymbol *GetOrCreateSymbol(StringRef Name);
 236     MCSymbol *GetOrCreateSymbol(const Twine &Name);
 237
 238     MCSymbol *getOrCreateSectionSymbol(const MCSectionELF &Section);
 239
 240     /// LookupSymbol - Get the symbol for \p Name, or null.
 241     MCSymbol *LookupSymbol(StringRef Name) const;
 242     MCSymbol *LookupSymbol(const Twine &Name) const;
 243
 244     /// getSymbols - Get a reference for the symbol table for clients that
 245     /// want to, for example, iterate over all symbols. 'const' because we
 246     /// still want any modifications to the table itself to use the MCContext
 247     /// APIs.
 248     const SymbolTable &getSymbols() const {
 249       return Symbols;
 250     }
 251
 252     /// @}
 253
 254     /// @name Section Management
 255     /// @{
 256
 257     /// getMachOSection - Return the MCSection for the specified mach-o section.
 258     /// This requires the operands to be valid.
 259     const MCSectionMachO *getMachOSection(StringRef Segment,
 260                                           StringRef Section,
 261                                           unsigned TypeAndAttributes,
 262                                           unsigned Reserved2,
 263                                           SectionKind K);
 264     const MCSectionMachO *getMachOSection(StringRef Segment,
 265                                           StringRef Section,
 266                                           unsigned TypeAndAttributes,
 267                                           SectionKind K) {
 268       return getMachOSection(Segment, Section, TypeAndAttributes, 0, K);
 269     }
 270
 271     const MCSectionELF *getELFSection(StringRef Section, unsigned Type,
 272                                       unsigned Flags, SectionKind Kind);
 273
 274     const MCSectionELF *getELFSection(StringRef Section, unsigned Type,
 275                                       unsigned Flags, SectionKind Kind,
 276                                       unsigned EntrySize, StringRef Group);
 277
 278     void renameELFSection(const MCSectionELF *Section, StringRef Name);
 279
 280     const MCSectionELF *CreateELFGroupSection();
 281
 282     const MCSectionCOFF *getCOFFSection(StringRef Section,
 283                                         unsigned Characteristics,
 284                                         SectionKind Kind,
 285                                         StringRef COMDATSymName, int Selection);
 286
 287     const MCSectionCOFF *getCOFFSection(StringRef Section,
 288                                         unsigned Characteristics,
 289                                         SectionKind Kind);
 290
 291     const MCSectionCOFF *getCOFFSection(StringRef Section);
 292
 293     /// Gets or creates a section equivalent to Sec that is associated with the
 294     /// section containing KeySym. For example, to create a debug info section
 295     /// associated with an inline function, pass the normal debug info section
 296     /// as Sec and the function symbol as KeySym.
 297     const MCSectionCOFF *getAssociativeCOFFSection(const MCSectionCOFF *Sec,
 298                                                    const MCSymbol *KeySym);
 299
 300     /// @}
 301
 302     /// @name Dwarf Management
 303     /// @{
 304
 305     /// \brief Get the compilation directory for DW_AT_comp_dir
 306     /// This can be overridden by clients which want to control the reported
 307     /// compilation directory and have it be something other than the current
 308     /// working directory.
 309     /// Returns an empty string if the current directory cannot be determined.
 310     StringRef getCompilationDir() const { return CompilationDir; }
 311
 312     /// \brief Set the compilation directory for DW_AT_comp_dir
 313     /// Override the default (CWD) compilation directory.
 314     void setCompilationDir(StringRef S) { CompilationDir = S.str(); }
 315
 316     /// \brief Get the main file name for use in error messages and debug
 317     /// info. This can be set to ensure we've got the correct file name
 318     /// after preprocessing or for -save-temps.
 319     const std::string &getMainFileName() const { return MainFileName; }
 320
 321     /// \brief Set the main file name and override the default.
 322     void setMainFileName(StringRef S) { MainFileName = S; }
 323
 324     /// GetDwarfFile - creates an entry in the dwarf file and directory tables.
 325     unsigned GetDwarfFile(StringRef Directory, StringRef FileName,
 326                           unsigned FileNumber, unsigned CUID);
 327
 328     bool isValidDwarfFileNumber(unsigned FileNumber, unsigned CUID = 0);
 329
 330     const std::map<unsigned, MCDwarfLineTable> &getMCDwarfLineTables() const {
 331       return MCDwarfLineTablesCUMap;
 332     }
 333
 334     MCDwarfLineTable &getMCDwarfLineTable(unsigned CUID) {
 335       return MCDwarfLineTablesCUMap[CUID];
 336     }
 337
 338     const MCDwarfLineTable &getMCDwarfLineTable(unsigned CUID) const {
 339       auto I = MCDwarfLineTablesCUMap.find(CUID);
 340       assert(I != MCDwarfLineTablesCUMap.end());
 341       return I->second;
 342     }
 343
 344     const SmallVectorImpl<MCDwarfFile> &getMCDwarfFiles(unsigned CUID = 0) {
 345       return getMCDwarfLineTable(CUID).getMCDwarfFiles();
 346     }
 347     const SmallVectorImpl<std::string> &getMCDwarfDirs(unsigned CUID = 0) {
 348       return getMCDwarfLineTable(CUID).getMCDwarfDirs();
 349     }
 350
 351     bool hasMCLineSections() const {
 352       for (const auto &Table : MCDwarfLineTablesCUMap)
 353         if (!Table.second.getMCDwarfFiles().empty() || Table.second.getLabel())
 354           return true;
 355       return false;
 356     }
 357     unsigned getDwarfCompileUnitID() {
 358       return DwarfCompileUnitID;
 359     }
 360     void setDwarfCompileUnitID(unsigned CUIndex) {
 361       DwarfCompileUnitID = CUIndex;
 362     }
 363     void setMCLineTableCompilationDir(unsigned CUID, StringRef CompilationDir) {
 364       getMCDwarfLineTable(CUID).setCompilationDir(CompilationDir);
 365     }
 366
 367     /// setCurrentDwarfLoc - saves the information from the currently parsed
 368     /// dwarf .loc directive and sets DwarfLocSeen.  When the next instruction
 369     /// is assembled an entry in the line number table with this information and
 370     /// the address of the instruction will be created.
 371     void setCurrentDwarfLoc(unsigned FileNum, unsigned Line, unsigned Column,
 372                             unsigned Flags, unsigned Isa,
 373                             unsigned Discriminator) {
 374       CurrentDwarfLoc.setFileNum(FileNum);
 375       CurrentDwarfLoc.setLine(Line);
 376       CurrentDwarfLoc.setColumn(Column);
 377       CurrentDwarfLoc.setFlags(Flags);
 378       CurrentDwarfLoc.setIsa(Isa);
 379       CurrentDwarfLoc.setDiscriminator(Discriminator);
 380       DwarfLocSeen = true;
 381     }
 382     void ClearDwarfLocSeen() { DwarfLocSeen = false; }
 383
 384     bool getDwarfLocSeen() { return DwarfLocSeen; }
 385     const MCDwarfLoc &getCurrentDwarfLoc() { return CurrentDwarfLoc; }
 386
 387     bool getGenDwarfForAssembly() { return GenDwarfForAssembly; }
 388     void setGenDwarfForAssembly(bool Value) { GenDwarfForAssembly = Value; }
 389     unsigned getGenDwarfFileNumber() { return GenDwarfFileNumber; }
 390     void setGenDwarfFileNumber(unsigned FileNumber) {
 391       GenDwarfFileNumber = FileNumber;
 392     }
 393     MapVector<const MCSection *, std::pair<MCSymbol *, MCSymbol *> > &
 394     getGenDwarfSectionSyms() {
 395       return SectionStartEndSyms;
 396     }
 397     std::pair<MapVector<const MCSection *,
 398                         std::pair<MCSymbol *, MCSymbol *> >::iterator,
 399               bool>
 400     addGenDwarfSection(const MCSection *Sec) {
 401       return SectionStartEndSyms.insert(
 402           std::make_pair(Sec, std::make_pair(nullptr, nullptr)));
 403     }
 404     void finalizeDwarfSections(MCStreamer &MCOS);
 405     const std::vector<MCGenDwarfLabelEntry> &getMCGenDwarfLabelEntries() const {
 406       return MCGenDwarfLabelEntries;
 407     }
 408     void addMCGenDwarfLabelEntry(const MCGenDwarfLabelEntry &E) {
 409       MCGenDwarfLabelEntries.push_back(E);
 410     }
 411
 412     void setDwarfDebugFlags(StringRef S) { DwarfDebugFlags = S; }
 413     StringRef getDwarfDebugFlags() { return DwarfDebugFlags; }
 414
 415     void setDwarfDebugProducer(StringRef S) { DwarfDebugProducer = S; }
 416     StringRef getDwarfDebugProducer() { return DwarfDebugProducer; }
 417
 418     void setDwarfVersion(uint16_t v) { DwarfVersion = v; }
 419     uint16_t getDwarfVersion() const { return DwarfVersion; }
 420
 421     /// @}
 422
 423     char *getSecureLogFile() { return SecureLogFile; }
 424     raw_ostream *getSecureLog() { return SecureLog; }
 425     bool getSecureLogUsed() { return SecureLogUsed; }
 426     void setSecureLog(raw_ostream *Value) {
 427       SecureLog = Value;
 428     }
 429     void setSecureLogUsed(bool Value) {
 430       SecureLogUsed = Value;
 431     }
 432
 433     void *Allocate(unsigned Size, unsigned Align = 8) {
 434       return Allocator.Allocate(Size, Align);
 435     }
 436     void Deallocate(void *Ptr) {
 437     }
 438
 439     // Unrecoverable error has occurred. Display the best diagnostic we can
 440     // and bail via exit(1). For now, most MC backend errors are unrecoverable.
 441     // FIXME: We should really do something about that.
 442     LLVM_ATTRIBUTE_NORETURN void FatalError(SMLoc L, const Twine &Msg) const;
 443   };
 444
 445 } // end namespace llvm
 446
 447 // operator new and delete aren't allowed inside namespaces.
 448 // The throw specifications are mandated by the standard.
 449 /// @brief Placement new for using the MCContext's allocator.
 450 ///
 451 /// This placement form of operator new uses the MCContext's allocator for
 452 /// obtaining memory. It is a non-throwing new, which means that it returns
 453 /// null on error. (If that is what the allocator does. The current does, so if
 454 /// this ever changes, this operator will have to be changed, too.)
 455 /// Usage looks like this (assuming there's an MCContext 'Context' in scope):
 456 /// @code
 457 /// // Default alignment (16)
 458 /// IntegerLiteral *Ex = new (Context) IntegerLiteral(arguments);
 459 /// // Specific alignment
 460 /// IntegerLiteral *Ex2 = new (Context, 8) IntegerLiteral(arguments);
 461 /// @endcode
 462 /// Please note that you cannot use delete on the pointer; it must be
 463 /// deallocated using an explicit destructor call followed by
 464 /// @c Context.Deallocate(Ptr).
 465 ///
 466 /// @param Bytes The number of bytes to allocate. Calculated by the compiler.
 467 /// @param C The MCContext that provides the allocator.
 468 /// @param Alignment The alignment of the allocated memory (if the underlying
 469 ///                  allocator supports it).
 470 /// @return The allocated memory. Could be NULL.
 471 inline void *operator new(size_t Bytes, llvm::MCContext &C,
 472                           size_t Alignment = 16) throw () {
 473   return C.Allocate(Bytes, Alignment);
 474 }
 475 /// @brief Placement delete companion to the new above.
 476 ///
 477 /// This operator is just a companion to the new above. There is no way of
 478 /// invoking it directly; see the new operator for more details. This operator
 479 /// is called implicitly by the compiler if a placement new expression using
 480 /// the MCContext throws in the object constructor.
 481 inline void operator delete(void *Ptr, llvm::MCContext &C, size_t)
 482               throw () {
 483   C.Deallocate(Ptr);
 484 }
 485
 486 /// This placement form of operator new[] uses the MCContext's allocator for
 487 /// obtaining memory. It is a non-throwing new[], which means that it returns
 488 /// null on error.
 489 /// Usage looks like this (assuming there's an MCContext 'Context' in scope):
 490 /// @code
 491 /// // Default alignment (16)
 492 /// char *data = new (Context) char[10];
 493 /// // Specific alignment
 494 /// char *data = new (Context, 8) char[10];
 495 /// @endcode
 496 /// Please note that you cannot use delete on the pointer; it must be
 497 /// deallocated using an explicit destructor call followed by
 498 /// @c Context.Deallocate(Ptr).
 499 ///
 500 /// @param Bytes The number of bytes to allocate. Calculated by the compiler.
 501 /// @param C The MCContext that provides the allocator.
 502 /// @param Alignment The alignment of the allocated memory (if the underlying
 503 ///                  allocator supports it).
 504 /// @return The allocated memory. Could be NULL.
 505 inline void *operator new[](size_t Bytes, llvm::MCContext& C,
 506                             size_t Alignment = 16) throw () {
 507   return C.Allocate(Bytes, Alignment);
 508 }
 509
 510 /// @brief Placement delete[] companion to the new[] above.
 511 ///
 512 /// This operator is just a companion to the new[] above. There is no way of
 513 /// invoking it directly; see the new[] operator for more details. This operator
 514 /// is called implicitly by the compiler if a placement new[] expression using
 515 /// the MCContext throws in the object constructor.
 516 inline void operator delete[](void *Ptr, llvm::MCContext &C) throw () {
 517   C.Deallocate(Ptr);
 518 }
 519
 520 #endif