LLVM  15.0.0git
MCSectionMachO.cpp
Go to the documentation of this file.
1 //===- lib/MC/MCSectionMachO.cpp - MachO Code Section Representation ------===//
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 
10 #include "llvm/MC/SectionKind.h"
12 
13 namespace llvm {
14 class MCAsmInfo;
15 class MCExpr;
16 class MCSymbol;
17 class Triple;
18 } // namespace llvm
19 
20 using namespace llvm;
21 
22 /// SectionTypeDescriptors - These are strings that describe the various section
23 /// types. This *must* be kept in order with and stay synchronized with the
24 /// section type list.
25 static constexpr struct {
28  {StringLiteral("regular"), StringLiteral("S_REGULAR")}, // 0x00
29  {StringLiteral(""), StringLiteral("S_ZEROFILL")}, // 0x01
30  {StringLiteral("cstring_literals"),
31  StringLiteral("S_CSTRING_LITERALS")}, // 0x02
32  {StringLiteral("4byte_literals"),
33  StringLiteral("S_4BYTE_LITERALS")}, // 0x03
34  {StringLiteral("8byte_literals"),
35  StringLiteral("S_8BYTE_LITERALS")}, // 0x04
36  {StringLiteral("literal_pointers"),
37  StringLiteral("S_LITERAL_POINTERS")}, // 0x05
38  {StringLiteral("non_lazy_symbol_pointers"),
39  StringLiteral("S_NON_LAZY_SYMBOL_POINTERS")}, // 0x06
40  {StringLiteral("lazy_symbol_pointers"),
41  StringLiteral("S_LAZY_SYMBOL_POINTERS")}, // 0x07
42  {StringLiteral("symbol_stubs"), StringLiteral("S_SYMBOL_STUBS")}, // 0x08
43  {StringLiteral("mod_init_funcs"),
44  StringLiteral("S_MOD_INIT_FUNC_POINTERS")}, // 0x09
45  {StringLiteral("mod_term_funcs"),
46  StringLiteral("S_MOD_TERM_FUNC_POINTERS")}, // 0x0A
47  {StringLiteral("coalesced"), StringLiteral("S_COALESCED")}, // 0x0B
48  {StringLiteral("") /*FIXME??*/, StringLiteral("S_GB_ZEROFILL")}, // 0x0C
49  {StringLiteral("interposing"), StringLiteral("S_INTERPOSING")}, // 0x0D
50  {StringLiteral("16byte_literals"),
51  StringLiteral("S_16BYTE_LITERALS")}, // 0x0E
52  {StringLiteral("") /*FIXME??*/, StringLiteral("S_DTRACE_DOF")}, // 0x0F
53  {StringLiteral("") /*FIXME??*/,
54  StringLiteral("S_LAZY_DYLIB_SYMBOL_POINTERS")}, // 0x10
55  {StringLiteral("thread_local_regular"),
56  StringLiteral("S_THREAD_LOCAL_REGULAR")}, // 0x11
57  {StringLiteral("thread_local_zerofill"),
58  StringLiteral("S_THREAD_LOCAL_ZEROFILL")}, // 0x12
59  {StringLiteral("thread_local_variables"),
60  StringLiteral("S_THREAD_LOCAL_VARIABLES")}, // 0x13
61  {StringLiteral("thread_local_variable_pointers"),
62  StringLiteral("S_THREAD_LOCAL_VARIABLE_POINTERS")}, // 0x14
63  {StringLiteral("thread_local_init_function_pointers"),
64  StringLiteral("S_THREAD_LOCAL_INIT_FUNCTION_POINTERS")}, // 0x15
65 };
66 
67 /// SectionAttrDescriptors - This is an array of descriptors for section
68 /// attributes. Unlike the SectionTypeDescriptors, this is not directly indexed
69 /// by attribute, instead it is searched.
70 static constexpr struct {
71  unsigned AttrFlag;
74 #define ENTRY(ASMNAME, ENUM) \
75  { MachO::ENUM, StringLiteral(ASMNAME), StringLiteral(#ENUM) },
76 ENTRY("pure_instructions", S_ATTR_PURE_INSTRUCTIONS)
77 ENTRY("no_toc", S_ATTR_NO_TOC)
78 ENTRY("strip_static_syms", S_ATTR_STRIP_STATIC_SYMS)
79 ENTRY("no_dead_strip", S_ATTR_NO_DEAD_STRIP)
80 ENTRY("live_support", S_ATTR_LIVE_SUPPORT)
81 ENTRY("self_modifying_code", S_ATTR_SELF_MODIFYING_CODE)
82 ENTRY("debug", S_ATTR_DEBUG)
83 ENTRY("" /*FIXME*/, S_ATTR_SOME_INSTRUCTIONS)
84 ENTRY("" /*FIXME*/, S_ATTR_EXT_RELOC)
85 ENTRY("" /*FIXME*/, S_ATTR_LOC_RELOC)
86 #undef ENTRY
87  { 0, StringLiteral("none"), StringLiteral("") }, // used if section has no attributes but has a stub size
88 };
89 
90 MCSectionMachO::MCSectionMachO(StringRef Segment, StringRef Section,
91  unsigned TAA, unsigned reserved2, SectionKind K,
92  MCSymbol *Begin)
93  : MCSection(SV_MachO, Section, K, Begin), TypeAndAttributes(TAA),
94  Reserved2(reserved2) {
95  assert(Segment.size() <= 16 && Section.size() <= 16 &&
96  "Segment or section string too long");
97  for (unsigned i = 0; i != 16; ++i) {
98  if (i < Segment.size())
99  SegmentName[i] = Segment[i];
100  else
101  SegmentName[i] = 0;
102  }
103 }
104 
105 void MCSectionMachO::printSwitchToSection(const MCAsmInfo &MAI, const Triple &T,
106  raw_ostream &OS,
107  const MCExpr *Subsection) const {
108  OS << "\t.section\t" << getSegmentName() << ',' << getName();
109 
110  // Get the section type and attributes.
111  unsigned TAA = getTypeAndAttributes();
112  if (TAA == 0) {
113  OS << '\n';
114  return;
115  }
116 
119  "Invalid SectionType specified!");
120 
122  OS << ',';
123  OS << SectionTypeDescriptors[SectionType].AssemblerName;
124  } else {
125  // If we have no name for the attribute, stop here.
126  OS << '\n';
127  return;
128  }
129 
130  // If we don't have any attributes, we're done.
131  unsigned SectionAttrs = TAA & MachO::SECTION_ATTRIBUTES;
132  if (SectionAttrs == 0) {
133  // If we have a S_SYMBOL_STUBS size specified, print it along with 'none' as
134  // the attribute specifier.
135  if (Reserved2 != 0)
136  OS << ",none," << Reserved2;
137  OS << '\n';
138  return;
139  }
140 
141  // Check each attribute to see if we have it.
142  char Separator = ',';
143  for (unsigned i = 0;
144  SectionAttrs != 0 && SectionAttrDescriptors[i].AttrFlag;
145  ++i) {
146  // Check to see if we have this attribute.
147  if ((SectionAttrDescriptors[i].AttrFlag & SectionAttrs) == 0)
148  continue;
149 
150  // Yep, clear it and print it.
151  SectionAttrs &= ~SectionAttrDescriptors[i].AttrFlag;
152 
153  OS << Separator;
155  OS << SectionAttrDescriptors[i].AssemblerName;
156  else
157  OS << "<<" << SectionAttrDescriptors[i].EnumName << ">>";
158  Separator = '+';
159  }
160 
161  assert(SectionAttrs == 0 && "Unknown section attributes!");
162 
163  // If we have a S_SYMBOL_STUBS size specified, print it.
164  if (Reserved2 != 0)
165  OS << ',' << Reserved2;
166  OS << '\n';
167 }
168 
171 }
172 
174  return (getType() == MachO::S_ZEROFILL ||
177 }
178 
179 /// ParseSectionSpecifier - Parse the section specifier indicated by "Spec".
180 /// This is a string that can appear after a .section directive in a mach-o
181 /// flavored .s file. If successful, this fills in the specified Out
182 /// parameters and returns an empty string. When an invalid section
183 /// specifier is present, this returns a string indicating the problem.
185  StringRef &Segment, // Out.
186  StringRef &Section, // Out.
187  unsigned &TAA, // Out.
188  bool &TAAParsed, // Out.
189  unsigned &StubSize) { // Out.
190  TAAParsed = false;
191 
192  SmallVector<StringRef, 5> SplitSpec;
193  Spec.split(SplitSpec, ',');
194  // Remove leading and trailing whitespace.
195  auto GetEmptyOrTrim = [&SplitSpec](size_t Idx) -> StringRef {
196  return SplitSpec.size() > Idx ? SplitSpec[Idx].trim() : StringRef();
197  };
198  Segment = GetEmptyOrTrim(0);
199  Section = GetEmptyOrTrim(1);
200  StringRef SectionType = GetEmptyOrTrim(2);
201  StringRef Attrs = GetEmptyOrTrim(3);
202  StringRef StubSizeStr = GetEmptyOrTrim(4);
203 
204  // Verify that the section is present.
205  if (Section.empty())
207  "mach-o section specifier requires a segment "
208  "and section separated by a comma");
209 
210  // Verify that the section is not too long.
211  if (Section.size() > 16)
213  "mach-o section specifier requires a section "
214  "whose length is between 1 and 16 characters");
215 
216  // If there is no comma after the section, we're done.
217  TAA = 0;
218  StubSize = 0;
219  if (SectionType.empty())
220  return Error::success();
221 
222  // Figure out which section type it is.
223  auto TypeDescriptor =
225  [&](decltype(*SectionTypeDescriptors) &Descriptor) {
226  return SectionType == Descriptor.AssemblerName;
227  });
228 
229  // If we didn't find the section type, reject it.
230  if (TypeDescriptor == std::end(SectionTypeDescriptors))
232  "mach-o section specifier uses an unknown "
233  "section type");
234 
235  // Remember the TypeID.
236  TAA = TypeDescriptor - std::begin(SectionTypeDescriptors);
237  TAAParsed = true;
238 
239  // If we have no comma after the section type, there are no attributes.
240  if (Attrs.empty()) {
241  // S_SYMBOL_STUBS always require a symbol stub size specifier.
242  if (TAA == MachO::S_SYMBOL_STUBS)
244  "mach-o section specifier of type "
245  "'symbol_stubs' requires a size specifier");
246  return Error::success();
247  }
248 
249  // The attribute list is a '+' separated list of attributes.
250  SmallVector<StringRef, 1> SectionAttrs;
251  Attrs.split(SectionAttrs, '+', /*MaxSplit=*/-1, /*KeepEmpty=*/false);
252 
253  for (StringRef &SectionAttr : SectionAttrs) {
254  auto AttrDescriptorI =
256  [&](decltype(*SectionAttrDescriptors) &Descriptor) {
257  return SectionAttr.trim() == Descriptor.AssemblerName;
258  });
259  if (AttrDescriptorI == std::end(SectionAttrDescriptors))
261  "mach-o section specifier has invalid "
262  "attribute");
263 
264  TAA |= AttrDescriptorI->AttrFlag;
265  }
266 
267  // Okay, we've parsed the section attributes, see if we have a stub size spec.
268  if (StubSizeStr.empty()) {
269  // S_SYMBOL_STUBS always require a symbol stub size specifier.
270  if (TAA == MachO::S_SYMBOL_STUBS)
272  "mach-o section specifier of type "
273  "'symbol_stubs' requires a size specifier");
274  return Error::success();
275  }
276 
277  // If we have a stub size spec, we must have a sectiontype of S_SYMBOL_STUBS.
280  "mach-o section specifier cannot have a stub "
281  "size specified because it does not have type "
282  "'symbol_stubs'");
283 
284  // Convert the stub size from a string to an integer.
285  if (StubSizeStr.getAsInteger(0, StubSize))
287  "mach-o section specifier has a malformed "
288  "stub size");
289 
290  return Error::success();
291 }
i
i
Definition: README.txt:29
Attrs
Function Attrs
Definition: README_ALTIVEC.txt:215
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:17
llvm::MCSymbol
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition: MCSymbol.h:41
llvm::Function::empty
bool empty() const
Definition: Function.h:731
T
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::SmallVector
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1185
llvm::Error::success
static ErrorSuccess success()
Create a success value.
Definition: Error.h:329
llvm::Triple
Triple - Helper class for working with autoconf configuration names.
Definition: Triple.h:44
llvm::MachO::S_GB_ZEROFILL
@ S_GB_ZEROFILL
S_GB_ZEROFILL - Zero fill on demand section (that can be larger than 4 gigabytes).
Definition: MachO.h:153
llvm::sys::path::end
const_iterator end(StringRef path)
Get end iterator over path.
Definition: Path.cpp:235
llvm::sys::path::begin
const_iterator begin(StringRef path, Style style=Style::native)
Get begin iterator over path.
Definition: Path.cpp:226
llvm::MachO::S_ZEROFILL
@ S_ZEROFILL
S_ZEROFILL - Zero fill on demand section.
Definition: MachO.h:127
llvm::MachO::S_SYMBOL_STUBS
@ S_SYMBOL_STUBS
S_SYMBOL_STUBS - Section with symbol stubs, byte size of stub in the Reserved2 field.
Definition: MachO.h:142
llvm::MachO::S_ATTR_EXT_RELOC
@ S_ATTR_EXT_RELOC
S_ATTR_EXT_RELOC - Section has external relocation entries.
Definition: MachO.h:210
llvm::MachO::S_ATTR_SOME_INSTRUCTIONS
@ S_ATTR_SOME_INSTRUCTIONS
S_ATTR_SOME_INSTRUCTIONS - Section contains some machine instructions.
Definition: MachO.h:208
llvm::MachO::S_ATTR_STRIP_STATIC_SYMS
@ S_ATTR_STRIP_STATIC_SYMS
S_ATTR_STRIP_STATIC_SYMS - Ok to strip static symbols in this section in files with the MY_DYLDLINK f...
Definition: MachO.h:193
llvm::ARMBuildAttrs::Section
@ Section
Legacy Tags.
Definition: ARMBuildAttributes.h:82
llvm::StringLiteral
A wrapper around a string literal that serves as a proxy for constructing global tables of StringRefs...
Definition: StringRef.h:910
llvm::MachO::SECTION_ATTRIBUTES
@ SECTION_ATTRIBUTES
Definition: MachO.h:113
llvm::MCSectionMachO::getType
MachO::SectionType getType() const
Definition: MCSectionMachO.h:50
llvm::StringRef::split
LLVM_NODISCARD std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Definition: StringRef.h:749
llvm::MCSectionMachO::ParseSectionSpecifier
static Error ParseSectionSpecifier(StringRef Spec, StringRef &Segment, StringRef &Section, unsigned &TAA, bool &TAAParsed, unsigned &StubSize)
Parse the section specifier indicated by "Spec".
Definition: MCSectionMachO.cpp:184
MCSectionMachO.h
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::MCSectionMachO::getTypeAndAttributes
unsigned getTypeAndAttributes() const
Definition: MCSectionMachO.h:47
llvm::MachO::S_ATTR_SELF_MODIFYING_CODE
@ S_ATTR_SELF_MODIFYING_CODE
S_ATTR_SELF_MODIFYING_CODE - Used with i386 code stubs written on by dyld.
Definition: MachO.h:200
llvm::MachO::S_ATTR_NO_DEAD_STRIP
@ S_ATTR_NO_DEAD_STRIP
S_ATTR_NO_DEAD_STRIP - No dead stripping.
Definition: MachO.h:195
AssemblerName
StringLiteral AssemblerName
Definition: MCSectionMachO.cpp:26
llvm::StringRef::getAsInteger
std::enable_if_t< std::numeric_limits< T >::is_signed, bool > getAsInteger(unsigned Radix, T &Result) const
Parse the current string as an integer of the specified radix.
Definition: StringRef.h:510
llvm::MCSectionMachO::hasAttribute
bool hasAttribute(unsigned Value) const
Definition: MCSectionMachO.h:54
llvm::MCSectionMachO::useCodeAlign
bool useCodeAlign() const override
Return true if a .align directive should use "optimized nops" to fill instead of 0s.
Definition: MCSectionMachO.cpp:169
llvm::StringRef::empty
constexpr LLVM_NODISCARD bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:153
llvm::MachO::S_ATTR_PURE_INSTRUCTIONS
@ S_ATTR_PURE_INSTRUCTIONS
S_ATTR_PURE_INSTRUCTIONS - Section contains only true machine instructions.
Definition: MachO.h:187
ENTRY
#define ENTRY(ASMNAME, ENUM)
assert
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
SectionTypeDescriptors
static constexpr struct @441 SectionTypeDescriptors[MachO::LAST_KNOWN_SECTION_TYPE+1]
SectionTypeDescriptors - These are strings that describe the various section types.
llvm::MachO::S_ATTR_LIVE_SUPPORT
@ S_ATTR_LIVE_SUPPORT
S_ATTR_LIVE_SUPPORT - Blocks are live if they reference live blocks.
Definition: MachO.h:197
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:58
llvm::MachO::S_ATTR_NO_TOC
@ S_ATTR_NO_TOC
S_ATTR_NO_TOC - Section contains coalesced symbols that are not to be in a ranlib table of contents.
Definition: MachO.h:190
llvm::MCSection
Instances of this class represent a uniqued identifier for a section in the current translation unit.
Definition: MCSection.h:39
llvm::MCSectionMachO::isVirtualSection
bool isVirtualSection() const override
Check whether this section is "virtual", that is has no actual object file contents.
Definition: MCSectionMachO.cpp:173
llvm::MachO::LAST_KNOWN_SECTION_TYPE
@ LAST_KNOWN_SECTION_TYPE
Definition: MachO.h:178
llvm::find_if
auto find_if(R &&Range, UnaryPredicate P)
Provide wrappers to std::find_if which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1634
llvm::MCSection::getName
StringRef getName() const
Definition: MCSection.h:123
llvm::MachO::SECTION_TYPE
@ SECTION_TYPE
Definition: MachO.h:112
llvm::StringRef::size
constexpr LLVM_NODISCARD size_t size() const
size - Get the string size.
Definition: StringRef.h:157
llvm::createStringError
Error createStringError(std::error_code EC, char const *Fmt, const Ts &... Vals)
Create formatted StringError object.
Definition: Error.h:1239
llvm::SectionKind
SectionKind - This is a simple POD value that classifies the properties of a section.
Definition: SectionKind.h:22
llvm::inconvertibleErrorCode
std::error_code inconvertibleErrorCode()
The value returned by this function can be returned from convertToErrorCode for Error values where no...
Definition: Error.cpp:77
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:155
llvm::MCSectionMachO::getSegmentName
StringRef getSegmentName() const
Definition: MCSectionMachO.h:40
AttrFlag
unsigned AttrFlag
Definition: MCSectionMachO.cpp:71
llvm::MachO::S_THREAD_LOCAL_ZEROFILL
@ S_THREAD_LOCAL_ZEROFILL
S_THREAD_LOCAL_ZEROFILL - Thread local zerofill section.
Definition: MachO.h:167
SectionKind.h
SectionAttrDescriptors
static constexpr struct @442 SectionAttrDescriptors[]
SectionAttrDescriptors - This is an array of descriptors for section attributes.
llvm::MachO::S_ATTR_LOC_RELOC
@ S_ATTR_LOC_RELOC
S_ATTR_LOC_RELOC - Section has local relocation entries.
Definition: MachO.h:212
EnumName
StringLiteral EnumName
Definition: MCSectionMachO.cpp:26
raw_ostream.h
llvm::MCExpr
Base class for the full range of assembler expressions which are needed for parsing.
Definition: MCExpr.h:35
llvm::MachO::S_ATTR_DEBUG
@ S_ATTR_DEBUG
S_ATTR_DEBUG - A debug section.
Definition: MachO.h:202
llvm::MachO::SectionType
SectionType
These are the section type and attributes fields.
Definition: MachO.h:120