include/llvm/MC/MCSymbol.h

   1 //===- MCSymbol.h - Machine Code Symbols ------------------------*- 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 // This file contains the declaration of the MCSymbol class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_MC_MCSYMBOL_H
  15 #define LLVM_MC_MCSYMBOL_H
  16
  17 #include "llvm/ADT/PointerUnion.h"
  18 #include "llvm/ADT/StringMap.h"
  19 #include "llvm/MC/MCAssembler.h"
  20 #include "llvm/MC/MCExpr.h"
  21 #include "llvm/Support/Compiler.h"
  22
  23 namespace llvm {
  24 class MCAsmInfo;
  25 class MCExpr;
  26 class MCSymbol;
  27 class MCFragment;
  28 class MCSection;
  29 class MCContext;
  30 class raw_ostream;
  31
  32 /// MCSymbol - Instances of this class represent a symbol name in the MC file,
  33 /// and MCSymbols are created and uniqued by the MCContext class.  MCSymbols
  34 /// should only be constructed with valid names for the object file.
  35 ///
  36 /// If the symbol is defined/emitted into the current translation unit, the
  37 /// Section member is set to indicate what section it lives in.  Otherwise, if
  38 /// it is a reference to an external entity, it has a null section.
  39 class MCSymbol {
  40 protected:
  41   /// The kind of the symbol.  If it is any value other than unset then this
  42   /// class is actually one of the appropriate subclasses of MCSymbol.
  43   enum SymbolKind {
  44     SymbolKindUnset,
  45     SymbolKindCOFF,
  46     SymbolKindELF,
  47     SymbolKindMachO,
  48   };
  49
  50   // Special sentinal value for the absolute pseudo section.
  51   //
  52   // FIXME: Use a PointerInt wrapper for this?
  53   static MCSection *AbsolutePseudoSection;
  54
  55   /// If a symbol has a Fragment, the section is implied, so we only need
  56   /// one pointer.
  57   /// FIXME: We might be able to simplify this by having the asm streamer create
  58   /// dummy fragments.
  59   /// If this is a section, then it gives the symbol is defined in. This is null
  60   /// for undefined symbols, and the special AbsolutePseudoSection value for
  61   /// absolute symbols. If this is a variable symbol, this caches the variable
  62   /// value's section.
  63   ///
  64   /// If this is a fragment, then it gives the fragment this symbol's value is
  65   /// relative to, if any.
  66   mutable PointerUnion<MCSection *, MCFragment *> SectionOrFragment;
  67
  68   /// Value - If non-null, the value for a variable symbol.
  69   const MCExpr *Value;
  70
  71   /// IsTemporary - True if this is an assembler temporary label, which
  72   /// typically does not survive in the .o file's symbol table.  Usually
  73   /// "Lfoo" or ".foo".
  74   unsigned IsTemporary : 1;
  75
  76   /// \brief True if this symbol can be redefined.
  77   unsigned IsRedefinable : 1;
  78
  79   /// IsUsed - True if this symbol has been used.
  80   mutable unsigned IsUsed : 1;
  81
  82   mutable bool IsRegistered : 1;
  83
  84   /// This symbol is visible outside this translation unit.
  85   mutable unsigned IsExternal : 1;
  86
  87   /// This symbol is private extern.
  88   mutable unsigned IsPrivateExtern : 1;
  89
  90   /// True if this symbol is named.
  91   /// A named symbol will have a pointer to the name allocated in the bytes
  92   /// immediately prior to the MCSymbol.
  93   unsigned HasName : 1;
  94
  95   /// LLVM RTTI discriminator. This is actually a SymbolKind enumerator, but is
  96   /// unsigned to avoid sign extension and achieve better bitpacking with MSVC.
  97   unsigned Kind : 2;
  98
  99   /// Index field, for use by the object file implementation.
 100   mutable uint32_t Index = 0;
 101
 102   union {
 103     /// The offset to apply to the fragment address to form this symbol's value.
 104     uint64_t Offset;
 105
 106     /// The size of the symbol, if it is 'common'.
 107     uint64_t CommonSize;
 108   };
 109
 110   /// The alignment of the symbol, if it is 'common', or -1.
 111   //
 112   // FIXME: Pack this in with other fields?
 113   unsigned CommonAlign = -1U;
 114
 115   /// The Flags field is used by object file implementations to store
 116   /// additional per symbol information which is not easily classified.
 117   mutable uint32_t Flags = 0;
 118
 119 protected: // MCContext creates and uniques these.
 120   friend class MCExpr;
 121   friend class MCContext;
 122
 123   /// \brief The name for a symbol.
 124   /// MCSymbol contains a uint64_t so is probably aligned to 8.  On a 32-bit
 125   /// system, the name is a pointer so isn't going to satisfy the 8 byte
 126   /// alignment of uint64_t.  Account for that here.
 127   typedef union {
 128     const StringMapEntry<bool> *NameEntry;
 129     uint64_t AlignmentPadding;
 130   } NameEntryStorageTy;
 131
 132   MCSymbol(SymbolKind Kind, const StringMapEntry<bool> *Name, bool isTemporary)
 133       : Value(nullptr), IsTemporary(isTemporary),
 134         IsRedefinable(false), IsUsed(false), IsRegistered(false),
 135         IsExternal(false), IsPrivateExtern(false), HasName(!!Name),
 136         Kind(Kind) {
 137     Offset = 0;
 138     if (Name)
 139       getNameEntryPtr() = Name;
 140   }
 141
 142   // Provide custom new/delete as we will only allocate space for a name
 143   // if we need one.
 144   void *operator new(size_t s, const StringMapEntry<bool> *Name,
 145                      MCContext &Ctx);
 146
 147 private:
 148
 149   void operator delete(void *);
 150   /// \brief Placement delete - required by std, but never called.
 151   void operator delete(void*, unsigned) {
 152     llvm_unreachable("Constructor throws?");
 153   }
 154   /// \brief Placement delete - required by std, but never called.
 155   void operator delete(void*, unsigned, bool) {
 156     llvm_unreachable("Constructor throws?");
 157   }
 158
 159   MCSymbol(const MCSymbol &) = delete;
 160   void operator=(const MCSymbol &) = delete;
 161   MCSection *getSectionPtr() const {
 162     if (MCFragment *F = getFragment())
 163       return F->getParent();
 164     assert(!SectionOrFragment.is<MCFragment *>() && "Section or null expected");
 165     MCSection *Section = SectionOrFragment.dyn_cast<MCSection *>();
 166     if (Section || !Value)
 167       return Section;
 168     return Section = Value->findAssociatedSection();
 169   }
 170
 171   /// \brief Get a reference to the name field.  Requires that we have a name
 172   const StringMapEntry<bool> *&getNameEntryPtr() {
 173     assert(HasName && "Name is required");
 174     NameEntryStorageTy *Name = reinterpret_cast<NameEntryStorageTy *>(this);
 175     return (*(Name - 1)).NameEntry;
 176   }
 177   const StringMapEntry<bool> *&getNameEntryPtr() const {
 178     return const_cast<MCSymbol*>(this)->getNameEntryPtr();
 179   }
 180
 181 public:
 182   /// getName - Get the symbol name.
 183   StringRef getName() const {
 184     if (!HasName)
 185       return StringRef();
 186
 187     return getNameEntryPtr()->first();
 188   }
 189
 190   bool isRegistered() const { return IsRegistered; }
 191   void setIsRegistered(bool Value) const { IsRegistered = Value; }
 192
 193   /// \name Accessors
 194   /// @{
 195
 196   /// isTemporary - Check if this is an assembler temporary symbol.
 197   bool isTemporary() const { return IsTemporary; }
 198
 199   /// isUsed - Check if this is used.
 200   bool isUsed() const { return IsUsed; }
 201   void setUsed(bool Value) const { IsUsed = Value; }
 202
 203   /// \brief Check if this symbol is redefinable.
 204   bool isRedefinable() const { return IsRedefinable; }
 205   /// \brief Mark this symbol as redefinable.
 206   void setRedefinable(bool Value) { IsRedefinable = Value; }
 207   /// \brief Prepare this symbol to be redefined.
 208   void redefineIfPossible() {
 209     if (IsRedefinable) {
 210       Value = nullptr;
 211       SectionOrFragment = nullptr;
 212       IsRedefinable = false;
 213     }
 214   }
 215
 216   /// @}
 217   /// \name Associated Sections
 218   /// @{
 219
 220   /// isDefined - Check if this symbol is defined (i.e., it has an address).
 221   ///
 222   /// Defined symbols are either absolute or in some section.
 223   bool isDefined() const { return getSectionPtr() != nullptr; }
 224
 225   /// isInSection - Check if this symbol is defined in some section (i.e., it
 226   /// is defined but not absolute).
 227   bool isInSection() const { return isDefined() && !isAbsolute(); }
 228
 229   /// isUndefined - Check if this symbol undefined (i.e., implicitly defined).
 230   bool isUndefined() const { return !isDefined(); }
 231
 232   /// isAbsolute - Check if this is an absolute symbol.
 233   bool isAbsolute() const { return getSectionPtr() == AbsolutePseudoSection; }
 234
 235   /// Get the section associated with a defined, non-absolute symbol.
 236   MCSection &getSection() const {
 237     assert(isInSection() && "Invalid accessor!");
 238     return *getSectionPtr();
 239   }
 240
 241   /// Mark the symbol as defined in the section \p S.
 242   void setSection(MCSection &S) {
 243     assert(!isVariable() && "Cannot set section of variable");
 244     assert(!SectionOrFragment.is<MCFragment *>() && "Section or null expected");
 245     SectionOrFragment = &S;
 246   }
 247
 248   /// Mark the symbol as undefined.
 249   void setUndefined() {
 250     SectionOrFragment = nullptr;
 251   }
 252
 253   bool isELF() const { return Kind == SymbolKindELF; }
 254
 255   bool isCOFF() const { return Kind == SymbolKindCOFF; }
 256
 257   bool isMachO() const { return Kind == SymbolKindMachO; }
 258
 259   /// @}
 260   /// \name Variable Symbols
 261   /// @{
 262
 263   /// isVariable - Check if this is a variable symbol.
 264   bool isVariable() const { return Value != nullptr; }
 265
 266   /// getVariableValue() - Get the value for variable symbols.
 267   const MCExpr *getVariableValue() const {
 268     assert(isVariable() && "Invalid accessor!");
 269     IsUsed = true;
 270     return Value;
 271   }
 272
 273   void setVariableValue(const MCExpr *Value);
 274
 275   /// @}
 276
 277   /// Get the (implementation defined) index.
 278   uint32_t getIndex() const {
 279     return Index;
 280   }
 281
 282   /// Set the (implementation defined) index.
 283   void setIndex(uint32_t Value) const {
 284     Index = Value;
 285   }
 286
 287   uint64_t getOffset() const {
 288     assert(!isCommon());
 289     return Offset;
 290   }
 291   void setOffset(uint64_t Value) {
 292     assert(!isCommon());
 293     Offset = Value;
 294   }
 295
 296   /// Return the size of a 'common' symbol.
 297   uint64_t getCommonSize() const {
 298     assert(isCommon() && "Not a 'common' symbol!");
 299     return CommonSize;
 300   }
 301
 302   /// Mark this symbol as being 'common'.
 303   ///
 304   /// \param Size - The size of the symbol.
 305   /// \param Align - The alignment of the symbol.
 306   void setCommon(uint64_t Size, unsigned Align) {
 307     assert(getOffset() == 0);
 308     CommonSize = Size;
 309     CommonAlign = Align;
 310   }
 311
 312   ///  Return the alignment of a 'common' symbol.
 313   unsigned getCommonAlignment() const {
 314     assert(isCommon() && "Not a 'common' symbol!");
 315     return CommonAlign;
 316   }
 317
 318   /// Declare this symbol as being 'common'.
 319   ///
 320   /// \param Size - The size of the symbol.
 321   /// \param Align - The alignment of the symbol.
 322   /// \return True if symbol was already declared as a different type
 323   bool declareCommon(uint64_t Size, unsigned Align) {
 324     assert(isCommon() || getOffset() == 0);
 325     if(isCommon()) {
 326       if(CommonSize != Size || CommonAlign != Align)
 327        return true;
 328     } else
 329       setCommon(Size, Align);
 330     return false;
 331   }
 332
 333   /// Is this a 'common' symbol.
 334   bool isCommon() const { return CommonAlign != -1U; }
 335
 336   MCFragment *getFragment() const {
 337     return SectionOrFragment.dyn_cast<MCFragment *>();
 338   }
 339   void setFragment(MCFragment *Value) const {
 340     SectionOrFragment = Value;
 341   }
 342
 343   bool isExternal() const { return IsExternal; }
 344   void setExternal(bool Value) const { IsExternal = Value; }
 345
 346   bool isPrivateExtern() const { return IsPrivateExtern; }
 347   void setPrivateExtern(bool Value) { IsPrivateExtern = Value; }
 348
 349   /// print - Print the value to the stream \p OS.
 350   void print(raw_ostream &OS, const MCAsmInfo *MAI) const;
 351
 352   /// dump - Print the value to stderr.
 353   void dump() const;
 354
 355 protected:
 356   /// Get the (implementation defined) symbol flags.
 357   uint32_t getFlags() const { return Flags; }
 358
 359   /// Set the (implementation defined) symbol flags.
 360   void setFlags(uint32_t Value) const { Flags = Value; }
 361
 362   /// Modify the flags via a mask
 363   void modifyFlags(uint32_t Value, uint32_t Mask) const {
 364     Flags = (Flags & ~Mask) | Value;
 365   }
 366 };
 367
 368 inline raw_ostream &operator<<(raw_ostream &OS, const MCSymbol &Sym) {
 369   Sym.print(OS, nullptr);
 370   return OS;
 371 }
 372 } // end namespace llvm
 373
 374 #endif