LIEF: Library to Instrument Executable Formats Version 2.0.0
Loading...
Searching...
No Matches
MachO/Section.hpp
Go to the documentation of this file.
1/* Copyright 2017 - 2026 R. Thomas
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15#ifndef LIEF_MACHO_SECTION_H
16#define LIEF_MACHO_SECTION_H
17#include <string_view>
18#include <cstdint>
19#include <memory>
20#include <ostream>
21#include <string>
22#include <vector>
23
25#include "LIEF/visibility.h"
26
28#include "LIEF/enums.hpp"
29
30#include "LIEF/iterators.hpp"
31
32namespace LIEF {
33class SpanStream;
34
35namespace MachO {
36
37class BinaryParser;
38class SegmentCommand;
39class Binary;
40class Relocation;
41
42namespace details {
43struct section_32;
44struct section_64;
45}
46
49
50 friend class BinaryParser;
51 friend class Binary;
52 friend class SegmentCommand;
53
54 public:
55 using content_t = std::vector<uint8_t>;
56
58 using relocations_t = std::vector<std::unique_ptr<Relocation>>;
59
62
66
67 static constexpr auto FLAGS_MASK = uint32_t(0xffffff00u);
68 static constexpr auto TYPE_MASK = uint32_t(0xff);
69
70 enum class TYPE : uint64_t {
72 REGULAR = 0x00u,
74 ZEROFILL = 0x01u,
76 CSTRING_LITERALS = 0x02u,
78 IS_4BYTE_LITERALS = 0x03u,
80 IS_8BYTE_LITERALS = 0x04u,
82 LITERAL_POINTERS = 0x05u,
84 NON_LAZY_SYMBOL_POINTERS = 0x06u,
86 LAZY_SYMBOL_POINTERS = 0x07u,
88 SYMBOL_STUBS = 0x08u,
90 MOD_INIT_FUNC_POINTERS = 0x09u,
92 MOD_TERM_FUNC_POINTERS = 0x0au,
94 COALESCED = 0x0bu,
96 GB_ZEROFILL = 0x0cu,
98 INTERPOSING = 0x0du,
100 IS_16BYTE_LITERALS = 0x0eu,
102 DTRACE_DOF = 0x0fu,
104 LAZY_DYLIB_SYMBOL_POINTERS = 0x10u,
106 THREAD_LOCAL_REGULAR = 0x11u,
108 THREAD_LOCAL_ZEROFILL = 0x12u,
110 THREAD_LOCAL_VARIABLES = 0x13u,
112 THREAD_LOCAL_VARIABLE_POINTERS = 0x14u,
114 THREAD_LOCAL_INIT_FUNCTION_POINTERS = 0x15u,
116 INIT_FUNC_OFFSETS = 0x16u,
117 };
118
119 enum class FLAGS : uint64_t {
121 PURE_INSTRUCTIONS = 0x80000000u,
124 NO_TOC = 0x40000000u,
127 STRIP_STATIC_SYMS = 0x20000000u,
129 NO_DEAD_STRIP = 0x10000000u,
131 LIVE_SUPPORT = 0x08000000u,
133 SELF_MODIFYING_CODE = 0x04000000u,
135 DEBUG_INFO = 0x02000000u,
137 SOME_INSTRUCTIONS = 0x00000400u,
139 EXT_RELOC = 0x00000200u,
141 LOC_RELOC = 0x00000100u,
142 };
143
144 public:
145 static std::unique_ptr<Section> create(const details::section_32& sec);
146 static std::unique_ptr<Section> create(const details::section_64& sec);
147
148 static std::unique_ptr<Section> create(std::string name,
149 const content_t& content,
151
152
153 static std::unique_ptr<Section> create(std::string name,
155 return create(std::move(name), /*content=*/{}, type);
156 }
157
158 Section(const details::section_32& sec);
159 Section(const details::section_64& sec);
160
163
164 ~Section() override;
165
166 virtual std::unique_ptr<Section> clone() const {
167 return std::unique_ptr<Section>(new Section(*this));
168 }
169
171
173 return as_writable(static_cast<const Section*>(this)->content());
174 }
175
177 void content(const content_t& data) override;
178
180 std::string_view segment_name() const LIEF_LIFETIMEBOUND;
181
183 uint64_t address() const {
184 return virtual_address();
185 }
186
188 uint32_t alignment() const {
189 return align_;
190 }
191
200 uint32_t relocation_offset() const {
201 return relocations_offset_;
202 }
203
205 uint32_t numberof_relocations() const {
206 return nbof_relocations_;
207 }
208
212 FLAGS flags() const {
213 return FLAGS(flags_ & FLAGS_MASK);
214 }
215
218 TYPE type() const {
219 return TYPE(flags_ & TYPE_MASK);
220 }
221
224 uint32_t reserved1() const {
225 return reserved1_;
226 }
227
237 uint32_t reserved2() const {
238 return reserved2_;
239 }
240
243 uint32_t reserved3() const {
244 return reserved3_;
245 }
246
249 std::vector<FLAGS> flags_list() const;
250
252 uint32_t raw_flags() const {
253 return flags_;
254 }
255
257 bool has_segment() const {
258 return segment() != nullptr;
259 }
260
264 return segment_;
265 }
266
268 return segment_;
269 }
270
272 std::unique_ptr<SpanStream> stream() const;
273
276 void clear(uint8_t v) {
277 span<uint8_t> write_content = content();
278 std::fill(write_content.begin(), write_content.end(), v);
279 }
280
286 return relocations_;
287 }
288
290 return relocations_;
291 }
292
293 void segment_name(std::string_view name);
294 void address(uint64_t address) {
296 }
297
298 void alignment(uint32_t align) {
299 align_ = align;
300 }
301
302 void relocation_offset(uint32_t offset) {
303 relocations_offset_ = offset;
304 }
305
306 void numberof_relocations(uint32_t nb_reloc) {
307 nbof_relocations_ = nb_reloc;
308 }
309
310 void flags(uint32_t flags) {
311 flags_ = flags_ | flags;
312 }
313 void flags(std::vector<FLAGS> flags);
314 void type(TYPE type) {
315 flags_ = (flags_ & FLAGS_MASK) | uint8_t(type);
316 }
317
318 void reserved1(uint32_t reserved1) {
319 reserved1_ = reserved1;
320 }
321
322 void reserved2(uint32_t reserved2) {
323 reserved2_ = reserved2;
324 }
325
326 void reserved3(uint32_t reserved3) {
327 reserved3_ = reserved3;
328 }
329
331 bool has(FLAGS flag) const;
332
334 void add(FLAGS flag);
335
337 void remove(FLAGS flag);
338
340 add(flag);
341 return *this;
342 }
343
345 remove(flag);
346 return *this;
347 }
348
349 template<class T>
350 const T* cast() const {
351 static_assert(std::is_base_of_v<Section, T>, "Require Section inheritance");
352 if (T::classof(this)) {
353 return static_cast<const T*>(this);
354 }
355 return nullptr;
356 }
357
358 template<class T>
359 T* cast() {
360 return const_cast<T*>(static_cast<const Section*>(this)->cast<T>());
361 }
362
363 void accept(Visitor& visitor) const override;
364
365 LIEF_API friend std::ostream& operator<<(std::ostream& os,
366 const Section& section);
367
368 protected:
369 Section();
370
371 Section& operator=(const Section& copy);
372 Section(const Section& copy);
373
374 std::string segment_name_;
375 uint64_t original_size_ = 0;
376 uint32_t align_ = 0;
377 uint32_t relocations_offset_ = 0;
378 uint32_t nbof_relocations_ = 0;
379 uint32_t flags_ = 0;
380 uint32_t reserved1_ = 0;
381 uint32_t reserved2_ = 0;
382 uint32_t reserved3_ = 0;
383 content_t content_;
384 SegmentCommand* segment_ = nullptr;
385 relocations_t relocations_;
386};
387
390
391}
392}
393
395
396#endif
Class used to parse a single binary (i.e. non-FAT).
Definition BinaryParser.hpp:80
Class which represents a MachO binary.
Definition MachO/Binary.hpp:93
Class that represents a Mach-O relocation.
Definition MachO/Relocation.hpp:39
span< const uint8_t > content() const override
Section's content.
void relocation_offset(uint32_t offset)
Definition MachO/Section.hpp:302
Section(const details::section_32 &sec)
uint32_t reserved1() const
According to the official loader.h file, this value is reserved for offset or index.
Definition MachO/Section.hpp:224
void address(uint64_t address)
Definition MachO/Section.hpp:294
ref_iterator< relocations_t &, Relocation * > it_relocations
Iterator which outputs Relocation&.
Definition MachO/Section.hpp:61
std::vector< FLAGS > flags_list() const
Return the Section::flags as a list of Section::FLAGS.
Section & operator+=(FLAGS flag)
Definition MachO/Section.hpp:339
const T * cast() const
Definition MachO/Section.hpp:350
void add(FLAGS flag)
Append a Section::FLAGS to the current section.
static std::unique_ptr< Section > create(const details::section_64 &sec)
void alignment(uint32_t align)
Definition MachO/Section.hpp:298
it_const_relocations relocations() const
Definition MachO/Section.hpp:289
static std::unique_ptr< Section > create(std::string name, const content_t &content, TYPE type=TYPE::REGULAR)
const_ref_iterator< const relocations_t &, const Relocation * > it_const_relocations
Iterator which outputs const Relocation&.
Definition MachO/Section.hpp:64
std::vector< std::unique_ptr< Relocation > > relocations_t
Internal container for storing Mach-O Relocation.
Definition MachO/Section.hpp:58
uint32_t raw_flags() const
Section flags without applying the SECTION_FLAGS_MASK mask.
Definition MachO/Section.hpp:252
T * cast()
Definition MachO/Section.hpp:359
SegmentCommand * segment()
The segment associated with this section or a nullptr if not present.
Definition MachO/Section.hpp:263
void type(TYPE type)
Definition MachO/Section.hpp:314
friend class BinaryParser
Definition MachO/Section.hpp:50
friend std::ostream & operator<<(std::ostream &os, const Section &section)
void flags(std::vector< FLAGS > flags)
static std::unique_ptr< Section > create(std::string name, TYPE type=TYPE::REGULAR)
Definition MachO/Section.hpp:153
std::vector< uint8_t > content_t
Definition MachO/Section.hpp:55
uint32_t relocation_offset() const
Offset of the relocation table. This value should be 0 for executable and libraries as the relocation...
Definition MachO/Section.hpp:200
friend class SegmentCommand
Definition MachO/Section.hpp:52
std::string_view segment_name() const
Return the name of the segment linked to this section.
void clear(uint8_t v)
Clear the content of this section by filling its values with the byte provided in parameter.
Definition MachO/Section.hpp:276
uint64_t address() const
Virtual base address of the section.
Definition MachO/Section.hpp:183
bool has_segment() const
Check if this section is correctly linked with a MachO::SegmentCommand.
Definition MachO/Section.hpp:257
uint32_t reserved3() const
This value is only present for 64 bits Mach-O files. In that case, the value is reserved.
Definition MachO/Section.hpp:243
std::unique_ptr< SpanStream > stream() const
Return a stream over the content of this section.
void remove(FLAGS flag)
Remove a Section::FLAGS to the current section.
friend class Binary
Definition MachO/Section.hpp:51
void content(const content_t &data) override
Update the content of the section.
FLAGS
Definition MachO/Section.hpp:119
Section & operator=(Section &&)
static std::unique_ptr< Section > create(const details::section_32 &sec)
void reserved3(uint32_t reserved3)
Definition MachO/Section.hpp:326
void reserved1(uint32_t reserved1)
Definition MachO/Section.hpp:318
uint32_t alignment() const
Section alignment as a power of 2.
Definition MachO/Section.hpp:188
it_relocations relocations()
Return an iterator over the MachO::Relocation associated with this section.
Definition MachO/Section.hpp:285
TYPE type() const
Type of the section. This value can help to determine the purpose of the section (e....
Definition MachO/Section.hpp:218
bool has(FLAGS flag) const
Check if the section has the given Section::FLAGS flag.
uint32_t numberof_relocations() const
Number of relocations associated with this section.
Definition MachO/Section.hpp:205
virtual std::unique_ptr< Section > clone() const
Definition MachO/Section.hpp:166
TYPE
Definition MachO/Section.hpp:70
@ REGULAR
Regular section.
Definition MachO/Section.hpp:72
void numberof_relocations(uint32_t nb_reloc)
Definition MachO/Section.hpp:306
static constexpr auto TYPE_MASK
Definition MachO/Section.hpp:68
static constexpr auto FLAGS_MASK
Definition MachO/Section.hpp:67
Section & operator-=(FLAGS flag)
Definition MachO/Section.hpp:344
const SegmentCommand * segment() const
Definition MachO/Section.hpp:267
void flags(uint32_t flags)
Definition MachO/Section.hpp:310
void accept(Visitor &visitor) const override
uint32_t reserved2() const
According to the official loader.h file, this value is reserved for count or sizeof.
Definition MachO/Section.hpp:237
void reserved2(uint32_t reserved2)
Definition MachO/Section.hpp:322
void segment_name(std::string_view name)
Section(const details::section_64 &sec)
FLAGS flags() const
Section's flags masked with SECTION_FLAGS_MASK (see: Section::FLAGS).
Definition MachO/Section.hpp:212
Class which represents a LoadCommand::TYPE::SEGMENT / LoadCommand::TYPE::SEGMENT_64 command.
Definition SegmentCommand.hpp:53
Class which represents an abstracted section.
Definition Abstract/Section.hpp:30
virtual uint64_t offset() const
Offset in the binary.
Definition Abstract/Section.hpp:70
virtual std::string_view name() const
Section's name.
Definition Abstract/Section.hpp:44
virtual uint64_t virtual_address() const
Address where the section should be mapped.
Definition Abstract/Section.hpp:75
Definition SpanStream.hpp:31
Definition Visitor.hpp:211
Iterator which returns reference on container's values.
Definition iterators.hpp:120
#define LIEF_LIFETIMEBOUND
Definition compiler_attributes.hpp:72
#define ENABLE_BITMASK_OPERATORS(X)
Definition enums.hpp:23
Definition endianness_support.hpp:62
Namespace related to the LIEF's Mach-O module.
Definition Abstract/Header.hpp:35
const char * to_string(BuildToolVersion::TOOLS tool)
LIEF namespace.
Definition Abstract/Binary.hpp:41
uint64_t align(uint64_t value, uint64_t align_on)
Definition utils.hpp:28
span< uint8_t > as_writable(span< const uint8_t > buffer)
Definition span.hpp:24
tcb::span< ElementType, Extent > span
Definition span.hpp:22
ref_iterator< CT, U, typename decay_t< CT >::const_iterator > const_ref_iterator
Iterator which returns a const ref on container's values.
Definition iterators.hpp:385
#define LIEF_API
Definition visibility.h:44