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/MC/SectionKind.h"
  14 #include "llvm/MC/MCDwarf.h"
  15 #include "llvm/ADT/DenseMap.h"
  16 #include "llvm/ADT/StringMap.h"
  17 #include "llvm/Support/Allocator.h"
  18 #include "llvm/Support/raw_ostream.h"
  19 #include <vector> // FIXME: Shouldn't be needed.
  20
  21 namespace llvm {
  22   class MCAsmInfo;
  23   class MCExpr;
  24   class MCSection;
  25   class MCSymbol;
  26   class MCLabel;
  27   class MCDwarfFile;
  28   class MCDwarfLoc;
  29   class MCLineSection;
  30   class StringRef;
  31   class Twine;
  32   class MCSectionMachO;
  33
  34   /// MCContext - Context object for machine code objects.  This class owns all
  35   /// of the sections that it creates.
  36   ///
  37   class MCContext {
  38     MCContext(const MCContext&); // DO NOT IMPLEMENT
  39     MCContext &operator=(const MCContext&); // DO NOT IMPLEMENT
  40
  41     /// The MCAsmInfo for this target.
  42     const MCAsmInfo &MAI;
  43
  44     /// Symbols - Bindings of names to symbols.
  45     StringMap<MCSymbol*> Symbols;
  46
  47     /// NextUniqueID - The next ID to dole out to an unnamed assembler temporary
  48     /// symbol.
  49     unsigned NextUniqueID;
  50
  51     /// Instances of directional local labels.
  52     DenseMap<unsigned, MCLabel *> Instances;
  53     /// NextInstance() creates the next instance of the directional local label
  54     /// for the LocalLabelVal and adds it to the map if needed.
  55     unsigned NextInstance(int64_t LocalLabelVal);
  56     /// GetInstance() gets the current instance of the directional local label
  57     /// for the LocalLabelVal and adds it to the map if needed.
  58     unsigned GetInstance(int64_t LocalLabelVal);
  59
  60     /// The file name of the log file from the enviromment variable
  61     /// AS_SECURE_LOG_FILE.  Which must be set before the .secure_log_unique
  62     /// directive is used or it is an error.
  63     char *SecureLogFile;
  64     /// The stream that gets written to for the .secure_log_unique directive.
  65     raw_ostream *SecureLog;
  66     /// Boolean toggled when .secure_log_unique / .secure_log_reset is seen to
  67     /// catch errors if .secure_log_unique appears twice without
  68     /// .secure_log_reset appearing between them.
  69     bool SecureLogUsed;
  70
  71     /// The dwarf file and directory tables from the dwarf .file directive.
  72     std::vector<MCDwarfFile *> MCDwarfFiles;
  73     std::vector<StringRef> MCDwarfDirs;
  74
  75     /// The current dwarf line information from the last dwarf .loc directive.
  76     MCDwarfLoc CurrentDwarfLoc;
  77     bool DwarfLocSeen;
  78
  79     /// The dwarf line information from the .loc directives for the sections
  80     /// with assembled machine instructions have after seeing .loc directives.
  81     DenseMap<const MCSection *, MCLineSection *> MCLineSections;
  82
  83     /// Allocator - Allocator object used for creating machine code objects.
  84     ///
  85     /// We use a bump pointer allocator to avoid the need to track all allocated
  86     /// objects.
  87     BumpPtrAllocator Allocator;
  88
  89     void *MachOUniquingMap, *ELFUniquingMap, *COFFUniquingMap;
  90   public:
  91     explicit MCContext(const MCAsmInfo &MAI);
  92     ~MCContext();
  93
  94     const MCAsmInfo &getAsmInfo() const { return MAI; }
  95
  96     /// @name Symbol Managment
  97     /// @{
  98
  99     /// CreateTempSymbol - Create and return a new assembler temporary symbol
 100     /// with a unique but unspecified name.
 101     MCSymbol *CreateTempSymbol();
 102
 103     /// CreateDirectionalLocalSymbol - Create the defintion of a directional
 104     /// local symbol for numbered label (used for "1:" defintions).
 105     MCSymbol *CreateDirectionalLocalSymbol(int64_t LocalLabelVal);
 106
 107     /// GetDirectionalLocalSymbol - Create and return a directional local
 108     /// symbol for numbered label (used for "1b" or 1f" references).
 109     MCSymbol *GetDirectionalLocalSymbol(int64_t LocalLabelVal, int bORf);
 110
 111     /// GetOrCreateSymbol - Lookup the symbol inside with the specified
 112     /// @p Name.  If it exists, return it.  If not, create a forward
 113     /// reference and return it.
 114     ///
 115     /// @param Name - The symbol name, which must be unique across all symbols.
 116     MCSymbol *GetOrCreateSymbol(StringRef Name);
 117     MCSymbol *GetOrCreateSymbol(const Twine &Name);
 118
 119     /// LookupSymbol - Get the symbol for \p Name, or null.
 120     MCSymbol *LookupSymbol(StringRef Name) const;
 121
 122     /// @}
 123
 124     /// @name Section Managment
 125     /// @{
 126
 127     /// getMachOSection - Return the MCSection for the specified mach-o section.
 128     /// This requires the operands to be valid.
 129     const MCSectionMachO *getMachOSection(StringRef Segment,
 130                                           StringRef Section,
 131                                           unsigned TypeAndAttributes,
 132                                           unsigned Reserved2,
 133                                           SectionKind K);
 134     const MCSectionMachO *getMachOSection(StringRef Segment,
 135                                           StringRef Section,
 136                                           unsigned TypeAndAttributes,
 137                                           SectionKind K) {
 138       return getMachOSection(Segment, Section, TypeAndAttributes, 0, K);
 139     }
 140
 141     const MCSection *getELFSection(StringRef Section, unsigned Type,
 142                                    unsigned Flags, SectionKind Kind,
 143                                    bool IsExplicit = false,
 144                                    unsigned EntrySize = 0);
 145
 146     const MCSection *getCOFFSection(StringRef Section, unsigned Characteristics,
 147                                     int Selection, SectionKind Kind);
 148
 149     const MCSection *getCOFFSection(StringRef Section, unsigned Characteristics,
 150                                     SectionKind Kind) {
 151       return getCOFFSection (Section, Characteristics, 0, Kind);
 152     }
 153
 154
 155     /// @}
 156
 157     /// @name Dwarf Managment
 158     /// @{
 159
 160     /// GetDwarfFile - creates an entry in the dwarf file and directory tables.
 161     unsigned GetDwarfFile(StringRef FileName, unsigned FileNumber);
 162
 163     bool isValidDwarfFileNumber(unsigned FileNumber);
 164
 165     bool hasDwarfFiles(void) {
 166       return MCDwarfFiles.size() != 0;
 167     }
 168
 169     const std::vector<MCDwarfFile *> &getMCDwarfFiles() {
 170       return MCDwarfFiles;
 171     }
 172     const std::vector<StringRef> &getMCDwarfDirs() {
 173       return MCDwarfDirs;
 174     }
 175     DenseMap<const MCSection *, MCLineSection *> &getMCLineSections() {
 176       return MCLineSections;
 177     }
 178
 179     /// setCurrentDwarfLoc - saves the information from the currently parsed
 180     /// dwarf .loc directive and sets DwarfLocSeen.  When the next instruction
 181     /// is assembled an entry in the line number table with this information and
 182     /// the address of the instruction will be created.
 183     void setCurrentDwarfLoc(unsigned FileNum, unsigned Line, unsigned Column,
 184                             unsigned Flags, unsigned Isa) {
 185       CurrentDwarfLoc.setFileNum(FileNum);
 186       CurrentDwarfLoc.setLine(Line);
 187       CurrentDwarfLoc.setColumn(Column);
 188       CurrentDwarfLoc.setFlags(Flags);
 189       CurrentDwarfLoc.setIsa(Isa);
 190       DwarfLocSeen = true;
 191     }
 192     void ClearDwarfLocSeen() { DwarfLocSeen = false; }
 193
 194     bool getDwarfLocSeen() { return DwarfLocSeen; }
 195     const MCDwarfLoc &getCurrentDwarfLoc() { return CurrentDwarfLoc; }
 196
 197     /// @}
 198
 199     char *getSecureLogFile() { return SecureLogFile; }
 200     raw_ostream *getSecureLog() { return SecureLog; }
 201     bool getSecureLogUsed() { return SecureLogUsed; }
 202     void setSecureLog(raw_ostream *Value) {
 203       SecureLog = Value;
 204     }
 205     void setSecureLogUsed(bool Value) {
 206       SecureLogUsed = Value;
 207     }
 208
 209     void *Allocate(unsigned Size, unsigned Align = 8) {
 210       return Allocator.Allocate(Size, Align);
 211     }
 212     void Deallocate(void *Ptr) {
 213     }
 214   };
 215
 216 } // end namespace llvm
 217
 218 // operator new and delete aren't allowed inside namespaces.
 219 // The throw specifications are mandated by the standard.
 220 /// @brief Placement new for using the MCContext's allocator.
 221 ///
 222 /// This placement form of operator new uses the MCContext's allocator for
 223 /// obtaining memory. It is a non-throwing new, which means that it returns
 224 /// null on error. (If that is what the allocator does. The current does, so if
 225 /// this ever changes, this operator will have to be changed, too.)
 226 /// Usage looks like this (assuming there's an MCContext 'Context' in scope):
 227 /// @code
 228 /// // Default alignment (16)
 229 /// IntegerLiteral *Ex = new (Context) IntegerLiteral(arguments);
 230 /// // Specific alignment
 231 /// IntegerLiteral *Ex2 = new (Context, 8) IntegerLiteral(arguments);
 232 /// @endcode
 233 /// Please note that you cannot use delete on the pointer; it must be
 234 /// deallocated using an explicit destructor call followed by
 235 /// @c Context.Deallocate(Ptr).
 236 ///
 237 /// @param Bytes The number of bytes to allocate. Calculated by the compiler.
 238 /// @param C The MCContext that provides the allocator.
 239 /// @param Alignment The alignment of the allocated memory (if the underlying
 240 ///                  allocator supports it).
 241 /// @return The allocated memory. Could be NULL.
 242 inline void *operator new(size_t Bytes, llvm::MCContext &C,
 243                           size_t Alignment = 16) throw () {
 244   return C.Allocate(Bytes, Alignment);
 245 }
 246 /// @brief Placement delete companion to the new above.
 247 ///
 248 /// This operator is just a companion to the new above. There is no way of
 249 /// invoking it directly; see the new operator for more details. This operator
 250 /// is called implicitly by the compiler if a placement new expression using
 251 /// the MCContext throws in the object constructor.
 252 inline void operator delete(void *Ptr, llvm::MCContext &C, size_t)
 253               throw () {
 254   C.Deallocate(Ptr);
 255 }
 256
 257 /// This placement form of operator new[] uses the MCContext's allocator for
 258 /// obtaining memory. It is a non-throwing new[], which means that it returns
 259 /// null on error.
 260 /// Usage looks like this (assuming there's an MCContext 'Context' in scope):
 261 /// @code
 262 /// // Default alignment (16)
 263 /// char *data = new (Context) char[10];
 264 /// // Specific alignment
 265 /// char *data = new (Context, 8) char[10];
 266 /// @endcode
 267 /// Please note that you cannot use delete on the pointer; it must be
 268 /// deallocated using an explicit destructor call followed by
 269 /// @c Context.Deallocate(Ptr).
 270 ///
 271 /// @param Bytes The number of bytes to allocate. Calculated by the compiler.
 272 /// @param C The MCContext that provides the allocator.
 273 /// @param Alignment The alignment of the allocated memory (if the underlying
 274 ///                  allocator supports it).
 275 /// @return The allocated memory. Could be NULL.
 276 inline void *operator new[](size_t Bytes, llvm::MCContext& C,
 277                             size_t Alignment = 16) throw () {
 278   return C.Allocate(Bytes, Alignment);
 279 }
 280
 281 /// @brief Placement delete[] companion to the new[] above.
 282 ///
 283 /// This operator is just a companion to the new[] above. There is no way of
 284 /// invoking it directly; see the new[] operator for more details. This operator
 285 /// is called implicitly by the compiler if a placement new[] expression using
 286 /// the MCContext throws in the object constructor.
 287 inline void operator delete[](void *Ptr, llvm::MCContext &C) throw () {
 288   C.Deallocate(Ptr);
 289 }
 290
 291 #endif