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 template<>
  35 struct ilist_node_traits<MCFragment> {
  36   MCFragment *createNode(const MCFragment &V);
  37   static void deleteNode(MCFragment *V);
  38
  39   void addNodeToList(MCFragment *) {}
  40   void removeNodeFromList(MCFragment *) {}
  41   void transferNodesFromList(ilist_node_traits &    /*SrcTraits*/,
  42                              ilist_iterator<MCFragment> /*first*/,
  43                              ilist_iterator<MCFragment> /*last*/) {}
  44 };
  45
  46 /// Instances of this class represent a uniqued identifier for a section in the
  47 /// current translation unit.  The MCContext class uniques and creates these.
  48 class MCSection {
  49 public:
  50   enum SectionVariant { SV_COFF = 0, SV_ELF, SV_MachO };
  51
  52   /// \brief Express the state of bundle locked groups while emitting code.
  53   enum BundleLockStateType {
  54     NotBundleLocked,
  55     BundleLocked,
  56     BundleLockedAlignToEnd
  57   };
  58
  59   typedef iplist<MCFragment> FragmentListType;
  60
  61   typedef FragmentListType::const_iterator const_iterator;
  62   typedef FragmentListType::iterator iterator;
  63
  64   typedef FragmentListType::const_reverse_iterator const_reverse_iterator;
  65   typedef FragmentListType::reverse_iterator reverse_iterator;
  66
  67 private:
  68   MCSection(const MCSection &) = delete;
  69   void operator=(const MCSection &) = delete;
  70
  71   MCSymbol *Begin;
  72   MCSymbol *End = nullptr;
  73   /// The alignment requirement of this section.
  74   unsigned Alignment = 1;
  75   /// The section index in the assemblers section list.
  76   unsigned Ordinal = 0;
  77   /// The index of this section in the layout order.
  78   unsigned LayoutOrder;
  79
  80   /// \brief Keeping track of bundle-locked state.
  81   BundleLockStateType BundleLockState = NotBundleLocked;
  82
  83   /// \brief Current nesting depth of bundle_lock directives.
  84   unsigned BundleLockNestingDepth = 0;
  85
  86   /// \brief We've seen a bundle_lock directive but not its first instruction
  87   /// yet.
  88   unsigned BundleGroupBeforeFirstInst : 1;
  89
  90   /// Whether this section has had instructions emitted into it.
  91   unsigned HasInstructions : 1;
  92
  93   unsigned IsRegistered : 1;
  94
  95   FragmentListType Fragments;
  96
  97   /// Mapping from subsection number to insertion point for subsection numbers
  98   /// below that number.
  99   SmallVector<std::pair<unsigned, MCFragment *>, 1> SubsectionFragmentMap;
 100
 101 protected:
 102   MCSection(SectionVariant V, SectionKind K, MCSymbol *Begin);
 103   SectionVariant Variant;
 104   SectionKind Kind;
 105
 106 public:
 107   virtual ~MCSection();
 108
 109   SectionKind getKind() const { return Kind; }
 110
 111   SectionVariant getVariant() const { return Variant; }
 112
 113   MCSymbol *getBeginSymbol() { return Begin; }
 114   const MCSymbol *getBeginSymbol() const {
 115     return const_cast<MCSection *>(this)->getBeginSymbol();
 116   }
 117   void setBeginSymbol(MCSymbol *Sym) {
 118     assert(!Begin);
 119     Begin = Sym;
 120   }
 121   MCSymbol *getEndSymbol(MCContext &Ctx);
 122   bool hasEnded() const;
 123
 124   unsigned getAlignment() const { return Alignment; }
 125   void setAlignment(unsigned Value) { Alignment = Value; }
 126
 127   unsigned getOrdinal() const { return Ordinal; }
 128   void setOrdinal(unsigned Value) { Ordinal = Value; }
 129
 130   unsigned getLayoutOrder() const { return LayoutOrder; }
 131   void setLayoutOrder(unsigned Value) { LayoutOrder = Value; }
 132
 133   BundleLockStateType getBundleLockState() const { return BundleLockState; }
 134   void setBundleLockState(BundleLockStateType NewState);
 135   bool isBundleLocked() const { return BundleLockState != NotBundleLocked; }
 136
 137   bool isBundleGroupBeforeFirstInst() const {
 138     return BundleGroupBeforeFirstInst;
 139   }
 140   void setBundleGroupBeforeFirstInst(bool IsFirst) {
 141     BundleGroupBeforeFirstInst = IsFirst;
 142   }
 143
 144   bool hasInstructions() const { return HasInstructions; }
 145   void setHasInstructions(bool Value) { HasInstructions = Value; }
 146
 147   bool isRegistered() const { return IsRegistered; }
 148   void setIsRegistered(bool Value) { IsRegistered = Value; }
 149
 150   MCSection::FragmentListType &getFragmentList() { return Fragments; }
 151   const MCSection::FragmentListType &getFragmentList() const {
 152     return const_cast<MCSection *>(this)->getFragmentList();
 153   }
 154
 155   MCSection::iterator begin();
 156   MCSection::const_iterator begin() const {
 157     return const_cast<MCSection *>(this)->begin();
 158   }
 159
 160   MCSection::iterator end();
 161   MCSection::const_iterator end() const {
 162     return const_cast<MCSection *>(this)->end();
 163   }
 164
 165   MCSection::reverse_iterator rbegin();
 166   MCSection::const_reverse_iterator rbegin() const {
 167     return const_cast<MCSection *>(this)->rbegin();
 168   }
 169
 170   MCSection::reverse_iterator rend();
 171   MCSection::const_reverse_iterator rend() const {
 172     return const_cast<MCSection *>(this)->rend();
 173   }
 174
 175   MCSection::iterator getSubsectionInsertionPoint(unsigned Subsection);
 176
 177   void dump();
 178
 179   virtual void PrintSwitchToSection(const MCAsmInfo &MAI, raw_ostream &OS,
 180                                     const MCExpr *Subsection) const = 0;
 181
 182   /// Return true if a .align directive should use "optimized nops" to fill
 183   /// instead of 0s.
 184   virtual bool UseCodeAlign() const = 0;
 185
 186   /// Check whether this section is "virtual", that is has no actual object
 187   /// file contents.
 188   virtual bool isVirtualSection() const = 0;
 189 };
 190
 191 } // end namespace llvm
 192
 193 #endif