include/llvm/MC/MCSection.h

   1 //===- MCSection.h - Machine Code Sections ----------------------*- 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 declares the MCSection class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_MC_MCSECTION_H
  15 #define LLVM_MC_MCSECTION_H
  16
  17 #include "llvm/ADT/SmallVector.h"
  18 #include "llvm/ADT/StringRef.h"
  19 #include "llvm/ADT/ilist.h"
  20 #include "llvm/ADT/ilist_node.h"
  21 #include "llvm/MC/SectionKind.h"
  22 #include "llvm/Support/Compiler.h"
  23
  24 namespace llvm {
  25 class MCAssembler;
  26 class MCAsmInfo;
  27 class MCContext;
  28 class MCExpr;
  29 class MCFragment;
  30 class MCSection;
  31 class MCSymbol;
  32 class raw_ostream;
  33
  34 class MCSectionData : public ilist_node<MCSectionData> {
  35   friend class MCAsmLayout;
  36
  37   MCSectionData(const MCSectionData &) = delete;
  38   void operator=(const MCSectionData &) = delete;
  39
  40 public:
  41   typedef iplist<MCFragment> FragmentListType;
  42
  43   typedef FragmentListType::const_iterator const_iterator;
  44   typedef FragmentListType::iterator iterator;
  45
  46   typedef FragmentListType::const_reverse_iterator const_reverse_iterator;
  47   typedef FragmentListType::reverse_iterator reverse_iterator;
  48
  49 private:
  50   FragmentListType Fragments;
  51   MCSection *Section;
  52
  53   /// \name Assembler Backend Data
  54   /// @{
  55   //
  56   // FIXME: This could all be kept private to the assembler implementation.
  57
  58   /// Mapping from subsection number to insertion point for subsection numbers
  59   /// below that number.
  60   SmallVector<std::pair<unsigned, MCFragment *>, 1> SubsectionFragmentMap;
  61
  62   /// @}
  63
  64 public:
  65   // Only for use as sentinel.
  66   MCSectionData();
  67   MCSectionData(MCSection &Section);
  68
  69   MCSection &getSection() const { return *Section; }
  70
  71   /// \name Fragment Access
  72   /// @{
  73
  74   const FragmentListType &getFragmentList() const { return Fragments; }
  75   FragmentListType &getFragmentList() { return Fragments; }
  76
  77   iterator begin();
  78   const_iterator begin() const {
  79     return const_cast<MCSectionData *>(this)->begin();
  80   }
  81
  82   iterator end();
  83   const_iterator end() const {
  84     return const_cast<MCSectionData *>(this)->end();
  85   }
  86
  87   reverse_iterator rbegin();
  88   const_reverse_iterator rbegin() const {
  89     return const_cast<MCSectionData *>(this)->rbegin();
  90   }
  91
  92   reverse_iterator rend();
  93   const_reverse_iterator rend() const {
  94     return const_cast<MCSectionData *>(this)->rend();
  95   }
  96
  97   size_t size() const;
  98
  99   bool empty() const;
 100
 101   iterator getSubsectionInsertionPoint(unsigned Subsection);
 102
 103   void dump();
 104
 105   /// @}
 106 };
 107
 108 /// Instances of this class represent a uniqued identifier for a section in the
 109 /// current translation unit.  The MCContext class uniques and creates these.
 110 class MCSection {
 111 public:
 112   enum SectionVariant { SV_COFF = 0, SV_ELF, SV_MachO };
 113
 114   /// \brief Express the state of bundle locked groups while emitting code.
 115   enum BundleLockStateType {
 116     NotBundleLocked,
 117     BundleLocked,
 118     BundleLockedAlignToEnd
 119   };
 120
 121 private:
 122   MCSection(const MCSection &) = delete;
 123   void operator=(const MCSection &) = delete;
 124
 125   MCSymbol *Begin;
 126   MCSymbol *End = nullptr;
 127   /// The alignment requirement of this section.
 128   unsigned Alignment = 1;
 129   /// The section index in the assemblers section list.
 130   unsigned Ordinal = 0;
 131   /// The index of this section in the layout order.
 132   unsigned LayoutOrder;
 133
 134   /// \brief Keeping track of bundle-locked state.
 135   BundleLockStateType BundleLockState = NotBundleLocked;
 136
 137   /// \brief Current nesting depth of bundle_lock directives.
 138   unsigned BundleLockNestingDepth = 0;
 139
 140   /// \brief We've seen a bundle_lock directive but not its first instruction
 141   /// yet.
 142   bool BundleGroupBeforeFirstInst = false;
 143
 144   /// Whether this section has had instructions emitted into it.
 145   unsigned HasInstructions : 1;
 146
 147 protected:
 148   MCSection(SectionVariant V, SectionKind K, MCSymbol *Begin)
 149       : Begin(Begin), HasInstructions(false), Variant(V), Kind(K) {}
 150   SectionVariant Variant;
 151   SectionKind Kind;
 152
 153 public:
 154   virtual ~MCSection();
 155
 156   SectionKind getKind() const { return Kind; }
 157
 158   SectionVariant getVariant() const { return Variant; }
 159
 160   MCSymbol *getBeginSymbol() { return Begin; }
 161   const MCSymbol *getBeginSymbol() const {
 162     return const_cast<MCSection *>(this)->getBeginSymbol();
 163   }
 164   void setBeginSymbol(MCSymbol *Sym) {
 165     assert(!Begin);
 166     Begin = Sym;
 167   }
 168   MCSymbol *getEndSymbol(MCContext &Ctx);
 169   bool hasEnded() const;
 170
 171   unsigned getAlignment() const { return Alignment; }
 172   void setAlignment(unsigned Value) { Alignment = Value; }
 173
 174   unsigned getOrdinal() const { return Ordinal; }
 175   void setOrdinal(unsigned Value) { Ordinal = Value; }
 176
 177   unsigned getLayoutOrder() const { return LayoutOrder; }
 178   void setLayoutOrder(unsigned Value) { LayoutOrder = Value; }
 179
 180   BundleLockStateType getBundleLockState() const { return BundleLockState; }
 181   void setBundleLockState(BundleLockStateType NewState);
 182   bool isBundleLocked() const { return BundleLockState != NotBundleLocked; }
 183
 184   bool isBundleGroupBeforeFirstInst() const {
 185     return BundleGroupBeforeFirstInst;
 186   }
 187   void setBundleGroupBeforeFirstInst(bool IsFirst) {
 188     BundleGroupBeforeFirstInst = IsFirst;
 189   }
 190
 191   bool hasInstructions() const { return HasInstructions; }
 192   void setHasInstructions(bool Value) { HasInstructions = Value; }
 193
 194   virtual void PrintSwitchToSection(const MCAsmInfo &MAI, raw_ostream &OS,
 195                                     const MCExpr *Subsection) const = 0;
 196
 197   /// Return true if a .align directive should use "optimized nops" to fill
 198   /// instead of 0s.
 199   virtual bool UseCodeAlign() const = 0;
 200
 201   /// Check whether this section is "virtual", that is has no actual object
 202   /// file contents.
 203   virtual bool isVirtualSection() const = 0;
 204 };
 205
 206 } // end namespace llvm
 207
 208 #endif