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