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