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