LLVM  15.0.0git
MCSection.h
Go to the documentation of this file.
1 //===- MCSection.h - Machine Code Sections ----------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file declares the MCSection class.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_MC_MCSECTION_H
14 #define LLVM_MC_MCSECTION_H
15 
16 #include "llvm/ADT/SmallVector.h"
17 #include "llvm/ADT/ilist.h"
18 #include "llvm/MC/MCFragment.h"
19 #include "llvm/MC/SectionKind.h"
20 #include "llvm/Support/Alignment.h"
21 #include <cassert>
22 #include <utility>
23 
24 namespace llvm {
25 
26 class MCAsmInfo;
27 class MCContext;
28 class MCExpr;
29 class MCSymbol;
30 class raw_ostream;
31 class Triple;
32 
33 template <> struct ilist_alloc_traits<MCFragment> {
34  static void deleteNode(MCFragment *V);
35 };
36 
37 /// Instances of this class represent a uniqued identifier for a section in the
38 /// current translation unit. The MCContext class uniques and creates these.
39 class MCSection {
40 public:
41  static constexpr unsigned NonUniqueID = ~0U;
42 
44  SV_COFF = 0,
51  };
52 
53  /// Express the state of bundle locked groups while emitting code.
58  };
59 
61 
64 
67 
68 private:
69  MCSymbol *Begin;
70  MCSymbol *End = nullptr;
71  /// The alignment requirement of this section.
72  Align Alignment;
73  /// The section index in the assemblers section list.
74  unsigned Ordinal = 0;
75  /// The index of this section in the layout order.
76  unsigned LayoutOrder;
77 
78  /// Keeping track of bundle-locked state.
79  BundleLockStateType BundleLockState = NotBundleLocked;
80 
81  /// Current nesting depth of bundle_lock directives.
82  unsigned BundleLockNestingDepth = 0;
83 
84  /// We've seen a bundle_lock directive but not its first instruction
85  /// yet.
86  bool BundleGroupBeforeFirstInst : 1;
87 
88  /// Whether this section has had instructions emitted into it.
89  bool HasInstructions : 1;
90 
91  bool IsRegistered : 1;
92 
93  MCDummyFragment DummyFragment;
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  /// State for tracking labels that don't yet have Fragments
102  struct PendingLabel {
103  MCSymbol* Sym;
104  unsigned Subsection;
105  PendingLabel(MCSymbol* Sym, unsigned Subsection = 0)
106  : Sym(Sym), Subsection(Subsection) {}
107  };
108  SmallVector<PendingLabel, 2> PendingLabels;
109 
110 protected:
111  // TODO Make Name private when possible.
115 
117  ~MCSection();
118 
119 public:
120  MCSection(const MCSection &) = delete;
121  MCSection &operator=(const MCSection &) = delete;
122 
123  StringRef getName() const { return Name; }
124  SectionKind getKind() const { return Kind; }
125 
126  SectionVariant getVariant() const { return Variant; }
127 
128  MCSymbol *getBeginSymbol() { return Begin; }
129  const MCSymbol *getBeginSymbol() const {
130  return const_cast<MCSection *>(this)->getBeginSymbol();
131  }
133  assert(!Begin);
134  Begin = Sym;
135  }
137  bool hasEnded() const;
138 
139  unsigned getAlignment() const { return Alignment.value(); }
140  void setAlignment(Align Value) { Alignment = Value; }
141 
142  unsigned getOrdinal() const { return Ordinal; }
143  void setOrdinal(unsigned Value) { Ordinal = Value; }
144 
145  unsigned getLayoutOrder() const { return LayoutOrder; }
146  void setLayoutOrder(unsigned Value) { LayoutOrder = Value; }
147 
148  BundleLockStateType getBundleLockState() const { return BundleLockState; }
150  bool isBundleLocked() const { return BundleLockState != NotBundleLocked; }
151 
153  return BundleGroupBeforeFirstInst;
154  }
155  void setBundleGroupBeforeFirstInst(bool IsFirst) {
156  BundleGroupBeforeFirstInst = IsFirst;
157  }
158 
159  bool hasInstructions() const { return HasInstructions; }
160  void setHasInstructions(bool Value) { HasInstructions = Value; }
161 
162  bool isRegistered() const { return IsRegistered; }
163  void setIsRegistered(bool Value) { IsRegistered = Value; }
164 
167  return const_cast<MCSection *>(this)->getFragmentList();
168  }
169 
170  /// Support for MCFragment::getNextNode().
172  return &MCSection::Fragments;
173  }
174 
175  const MCDummyFragment &getDummyFragment() const { return DummyFragment; }
176  MCDummyFragment &getDummyFragment() { return DummyFragment; }
177 
178  iterator begin() { return Fragments.begin(); }
179  const_iterator begin() const { return Fragments.begin(); }
180 
181  iterator end() { return Fragments.end(); }
182  const_iterator end() const { return Fragments.end(); }
183 
185 
186  void dump() const;
187 
188  virtual void printSwitchToSection(const MCAsmInfo &MAI, const Triple &T,
189  raw_ostream &OS,
190  const MCExpr *Subsection) const = 0;
191 
192  /// Return true if a .align directive should use "optimized nops" to fill
193  /// instead of 0s.
194  virtual bool useCodeAlign() const = 0;
195 
196  /// Check whether this section is "virtual", that is has no actual object
197  /// file contents.
198  virtual bool isVirtualSection() const = 0;
199 
200  virtual StringRef getVirtualSectionKind() const;
201 
202  /// Add a pending label for the requested subsection. This label will be
203  /// associated with a fragment in flushPendingLabels()
204  void addPendingLabel(MCSymbol* label, unsigned Subsection = 0);
205 
206  /// Associate all pending labels in a subsection with a fragment.
207  void flushPendingLabels(MCFragment *F, uint64_t FOffset = 0,
208  unsigned Subsection = 0);
209 
210  /// Associate all pending labels with empty data fragments. One fragment
211  /// will be created for each subsection as necessary.
212  void flushPendingLabels();
213 };
214 
215 } // end namespace llvm
216 
217 #endif // LLVM_MC_MCSECTION_H
llvm::MCSection::isBundleLocked
bool isBundleLocked() const
Definition: MCSection.h:150
llvm::MCSection::Name
StringRef Name
Definition: MCSection.h:112
llvm::MCSection::setIsRegistered
void setIsRegistered(bool Value)
Definition: MCSection.h:163
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:17
llvm::MCSection::SV_COFF
@ SV_COFF
Definition: MCSection.h:44
llvm::MCSymbol
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition: MCSymbol.h:41
llvm::MCSection::printSwitchToSection
virtual void printSwitchToSection(const MCAsmInfo &MAI, const Triple &T, raw_ostream &OS, const MCExpr *Subsection) const =0
llvm::MCSection::setBundleLockState
void setBundleLockState(BundleLockStateType NewState)
Definition: MCSection.cpp:39
llvm::MCContext
Context object for machine code objects.
Definition: MCContext.h:74
llvm::MCSection::addPendingLabel
void addPendingLabel(MCSymbol *label, unsigned Subsection=0)
Add a pending label for the requested subsection.
Definition: MCSection.cpp:91
llvm::MCSection::SV_XCOFF
@ SV_XCOFF
Definition: MCSection.h:49
llvm::MCAsmInfo
This class is intended to be used as a base class for asm properties and features specific to the tar...
Definition: MCAsmInfo.h:56
llvm::MCSection::getDummyFragment
MCDummyFragment & getDummyFragment()
Definition: MCSection.h:176
llvm::MCSection::getBeginSymbol
MCSymbol * getBeginSymbol()
Definition: MCSection.h:128
llvm::SmallVector
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1185
ilist.h
llvm::MCSection::SV_MachO
@ SV_MachO
Definition: MCSection.h:47
llvm::MCSection::dump
void dump() const
Definition: MCSection.cpp:127
llvm::MCSection::getLayoutOrder
unsigned getLayoutOrder() const
Definition: MCSection.h:145
llvm::MCSection::getSublistAccess
static FragmentListType MCSection::* getSublistAccess(MCFragment *)
Support for MCFragment::getNextNode().
Definition: MCSection.h:171
MCFragment.h
llvm::Triple
Triple - Helper class for working with autoconf configuration names.
Definition: Triple.h:44
llvm::iplist_impl< simple_ilist< MCFragment, Options... >, ilist_traits< MCFragment > >::const_reverse_iterator
base_list_type::const_reverse_iterator const_reverse_iterator
Definition: ilist.h:182
llvm::MCSection::getBundleLockState
BundleLockStateType getBundleLockState() const
Definition: MCSection.h:148
llvm::MCSection::getSubsectionInsertionPoint
MCSection::iterator getSubsectionInsertionPoint(unsigned Subsection)
Definition: MCSection.cpp:59
llvm::MCSection::MCSection
MCSection(SectionVariant V, StringRef Name, SectionKind K, MCSymbol *Begin)
Definition: MCSection.cpp:23
llvm::MCSection::setBundleGroupBeforeFirstInst
void setBundleGroupBeforeFirstInst(bool IsFirst)
Definition: MCSection.h:155
llvm::iplist< MCFragment >
llvm::MCSection::getFragmentList
MCSection::FragmentListType & getFragmentList()
Definition: MCSection.h:165
F
#define F(x, y, z)
Definition: MD5.cpp:55
llvm::MCSection::end
iterator end()
Definition: MCSection.h:181
llvm::MCFragment
Definition: MCFragment.h:30
llvm::MCDummyFragment
Definition: MCFragment.h:114
llvm::MCSection::setLayoutOrder
void setLayoutOrder(unsigned Value)
Definition: MCSection.h:146
llvm::MCSection::hasEnded
bool hasEnded() const
Definition: MCSection.cpp:35
llvm::MCSection::Variant
SectionVariant Variant
Definition: MCSection.h:113
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:54
llvm::MCSection::end
const_iterator end() const
Definition: MCSection.h:182
llvm::MCSection::getFragmentList
const MCSection::FragmentListType & getFragmentList() const
Definition: MCSection.h:166
llvm::Align
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition: Alignment.h:39
llvm::MCSection::getVariant
SectionVariant getVariant() const
Definition: MCSection.h:126
llvm::MCSection::getEndSymbol
MCSymbol * getEndSymbol(MCContext &Ctx)
Definition: MCSection.cpp:29
llvm::iplist_impl< simple_ilist< MCFragment, Options... >, ilist_traits< MCFragment > >::reverse_iterator
base_list_type::reverse_iterator reverse_iterator
Definition: ilist.h:180
llvm::MCSection::BundleLockedAlignToEnd
@ BundleLockedAlignToEnd
Definition: MCSection.h:57
llvm::MCSection::~MCSection
~MCSection()
uint64_t
llvm::iplist_impl< simple_ilist< MCFragment, Options... >, ilist_traits< MCFragment > >::iterator
base_list_type::iterator iterator
Definition: ilist.h:178
llvm::MCSection::operator=
MCSection & operator=(const MCSection &)=delete
llvm::ilist_alloc_traits
Use delete by default for iplist and ilist.
Definition: ilist.h:41
llvm::MCSection::NonUniqueID
static constexpr unsigned NonUniqueID
Definition: MCSection.h:41
assert
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
llvm::MCSection::getVirtualSectionKind
virtual StringRef getVirtualSectionKind() const
Definition: MCSection.cpp:89
llvm::MCSection::BundleLockStateType
BundleLockStateType
Express the state of bundle locked groups while emitting code.
Definition: MCSection.h:54
llvm::MCSection::setHasInstructions
void setHasInstructions(bool Value)
Definition: MCSection.h:160
llvm::MCSection::getAlignment
unsigned getAlignment() const
Definition: MCSection.h:139
llvm::MCSection::getDummyFragment
const MCDummyFragment & getDummyFragment() const
Definition: MCSection.h:175
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:58
llvm::MCSection::isVirtualSection
virtual bool isVirtualSection() const =0
Check whether this section is "virtual", that is has no actual object file contents.
llvm::MCSection
Instances of this class represent a uniqued identifier for a section in the current translation unit.
Definition: MCSection.h:39
llvm::MCSection::SV_GOFF
@ SV_GOFF
Definition: MCSection.h:46
llvm::MCSection::SV_ELF
@ SV_ELF
Definition: MCSection.h:45
llvm::MCSection::getName
StringRef getName() const
Definition: MCSection.h:123
llvm::MCSection::BundleLocked
@ BundleLocked
Definition: MCSection.h:56
llvm::MCSection::setAlignment
void setAlignment(Align Value)
Definition: MCSection.h:140
llvm::MCSection::isBundleGroupBeforeFirstInst
bool isBundleGroupBeforeFirstInst() const
Definition: MCSection.h:152
Alignment.h
llvm::MCSection::SectionVariant
SectionVariant
Definition: MCSection.h:43
llvm::SectionKind
SectionKind - This is a simple POD value that classifies the properties of a section.
Definition: SectionKind.h:22
llvm::MCSection::useCodeAlign
virtual bool useCodeAlign() const =0
Return true if a .align directive should use "optimized nops" to fill instead of 0s.
llvm::MCSection::hasInstructions
bool hasInstructions() const
Definition: MCSection.h:159
llvm::ilist_iterator
Iterator for intrusive lists based on ilist_node.
Definition: ilist_iterator.h:57
llvm::MCSection::flushPendingLabels
void flushPendingLabels()
Associate all pending labels with empty data fragments.
Definition: MCSection.cpp:112
llvm::MCSection::getBeginSymbol
const MCSymbol * getBeginSymbol() const
Definition: MCSection.h:129
llvm::TargetStackID::Value
Value
Definition: TargetFrameLowering.h:27
llvm::MCSection::setBeginSymbol
void setBeginSymbol(MCSymbol *Sym)
Definition: MCSection.h:132
llvm::MCSection::NotBundleLocked
@ NotBundleLocked
Definition: MCSection.h:55
llvm::MCSection::isRegistered
bool isRegistered() const
Definition: MCSection.h:162
SectionKind.h
llvm::MCSection::getKind
SectionKind getKind() const
Definition: MCSection.h:124
llvm::MCSection::begin
iterator begin()
Definition: MCSection.h:178
llvm::MCSection::SV_SPIRV
@ SV_SPIRV
Definition: MCSection.h:50
llvm::MCSection::begin
const_iterator begin() const
Definition: MCSection.h:179
SmallVector.h
llvm::MCSection::Kind
SectionKind Kind
Definition: MCSection.h:114
llvm::ilist_alloc_traits::deleteNode
static void deleteNode(NodeTy *V)
Definition: ilist.h:42
llvm::iplist_impl< simple_ilist< MCFragment, Options... >, ilist_traits< MCFragment > >::const_iterator
base_list_type::const_iterator const_iterator
Definition: ilist.h:179
llvm::MCSection::SV_Wasm
@ SV_Wasm
Definition: MCSection.h:48
llvm::MCSection::getOrdinal
unsigned getOrdinal() const
Definition: MCSection.h:142
llvm::Value
LLVM Value Representation.
Definition: Value.h:74
llvm::MCExpr
Base class for the full range of assembler expressions which are needed for parsing.
Definition: MCExpr.h:35
llvm::ISD::MCSymbol
@ MCSymbol
Definition: ISDOpcodes.h:172
llvm::MCSection::setOrdinal
void setOrdinal(unsigned Value)
Definition: MCSection.h:143