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