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