LIEF: Library to Instrument Executable Formats Version 2.0.0
Loading...
Searching...
No Matches
DyldChainedFixups.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_DYLD_CHAINED_FIXUPS_H
16#define LIEF_MACHO_DYLD_CHAINED_FIXUPS_H
20#include "LIEF/iterators.hpp"
21#include "LIEF/span.hpp"
22#include "LIEF/visibility.h"
23#include <memory>
24
25
26namespace LIEF::MachO {
27
28class Binary;
29class BinaryParser;
31class Builder;
33class ChainedBindingInfoList;
35class LinkEdit;
36class SegmentCommand;
37
38namespace details {
39struct linkedit_data_command;
40struct dyld_chained_fixups_header;
41struct dyld_chained_starts_in_segment;
42}
43
50 friend class BinaryParser;
51 friend class Builder;
52 friend class LinkEdit;
53 friend class BindingInfoIterator;
54 friend class Binary;
56
57 public:
63 struct chained_starts_in_segment {
66 uint32_t offset = 0;
67
69 uint32_t size = 0;
70
73 uint16_t page_size = 0;
74
77 uint64_t segment_offset = 0;
78
80 uint32_t max_valid_pointer = 0;
81
84
86 size_t page_count() const {
87 return page_start.size();
88 }
89
92 std::vector<uint16_t> page_start;
93
95 std::vector<uint16_t> chain_starts;
96
99
100 LIEF_API friend std::ostream&
101 operator<<(std::ostream& os, const chained_starts_in_segment& info);
102
103 static chained_starts_in_segment
107
108 private:
109 friend class BinaryParser;
111 chained_starts_in_segment(uint32_t offset, SegmentCommand& segment) :
112 offset(offset),
113 segment(segment) {}
114 chained_starts_in_segment(uint32_t offset,
115 const details::dyld_chained_starts_in_segment& info,
116 SegmentCommand& segment);
117 };
118
120 using chained_starts_in_segments_t = std::vector<chained_starts_in_segment>;
121
125
129
131 using binding_info_t = std::vector<std::unique_ptr<ChainedBindingInfo>>;
132
135
139
140
142 DyldChainedFixups(const details::linkedit_data_command& cmd);
143 std::unique_ptr<LoadCommand> clone() const override {
144 return std::unique_ptr<DyldChainedFixups>(new DyldChainedFixups(*this));
145 }
146
148
151 uint32_t data_offset() const {
152 return data_offset_;
153 }
154
156 uint32_t data_size() const {
157 return data_size_;
158 }
159
160 void data_offset(uint32_t offset) {
161 data_offset_ = offset;
162 }
163
164 void data_size(uint32_t size) {
165 data_size_ = size;
166 }
167
170 return content_;
171 }
172
175 return all_bindings_;
176 }
177
180 return all_bindings_;
181 }
182
185 return chained_starts_in_segment_;
186 }
187
188 it_const_chained_starts_in_segments_t
190 return chained_starts_in_segment_;
191 }
192
195 uint32_t fixups_version() const {
196 return fixups_version_;
197 }
198
199 void fixups_version(uint32_t version) {
200 fixups_version_ = version;
201 }
202
204 uint32_t starts_offset() const {
205 return starts_offset_;
206 }
207
208 void starts_offset(uint32_t offset) {
209 starts_offset_ = offset;
210 }
211
213 uint32_t imports_offset() const {
214 return imports_offset_;
215 }
216
217 void imports_offset(uint32_t offset) {
218 imports_offset_ = offset;
219 }
220
222 uint32_t symbols_offset() const {
223 return symbols_offset_;
224 }
225
226 void symbols_offset(uint32_t offset) {
227 symbols_offset_ = offset;
228 }
229
231 uint32_t imports_count() const {
232 return imports_count_;
233 }
234
235 void imports_count(uint32_t cnt) {
236 imports_count_ = cnt;
237 }
238
244 uint32_t symbols_format() const {
245 return symbols_format_;
246 }
247
248 void symbols_format(uint32_t fmt) {
249 symbols_format_ = fmt;
250 }
251
254 return imports_format_;
255 }
256
258 imports_format_ = fmt;
259 }
260
262 chained_starts_in_segment_.push_back(std::move(start_info));
263 return chained_starts_in_segment_.back();
264 }
265
266 void accept(Visitor& visitor) const override;
267
268 std::ostream& print(std::ostream& os) const override;
269
270 static bool classof(const LoadCommand* cmd) {
272 }
273
274 private:
275 LIEF_LOCAL void update_with(const details::dyld_chained_fixups_header& header);
276 LIEF_LOCAL DyldChainedFixups& operator=(const DyldChainedFixups& other);
278
279 uint32_t data_offset_ = 0;
280 uint32_t data_size_ = 0;
281
282 // Raw payload of the DyldChainedFixups.
283 // This payload is located in the __LINKEDIT segment
284 span<uint8_t> content_;
285
286 uint32_t fixups_version_ = 0;
287 uint32_t starts_offset_ = 0;
288 uint32_t imports_offset_ = 0;
289 uint32_t symbols_offset_ = 0;
290 uint32_t imports_count_ = 0;
291 uint32_t symbols_format_ = 0;
293
294 chained_starts_in_segments_t chained_starts_in_segment_;
295
296 std::vector<std::unique_ptr<ChainedBindingInfoList>> internal_bindings_;
297 binding_info_t all_bindings_;
298};
299
300}
301
302#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
Definition BindingInfoIterator.hpp:31
Class used to rebuild a Mach-O file.
Definition MachO/Builder.hpp:63
This class represents a symbol binding operation associated with the LC_DYLD_CHAINED_FIXUPS command.
Definition ChainedBindingInfo.hpp:47
Definition DyldChainedFixupsCreator.hpp:41
Class that represents the LC_DYLD_CHAINED_FIXUPS command.
Definition DyldChainedFixups.hpp:49
uint32_t data_offset() const
Offset of the LC_DYLD_CHAINED_FIXUPS chained payload. This offset should point in the __LINKEDIT segm...
Definition DyldChainedFixups.hpp:151
it_const_binding_info bindings() const
Iterator over the bindings (ChainedBindingInfo) associated with this command.
Definition DyldChainedFixups.hpp:179
friend class BindingInfoIterator
Definition DyldChainedFixups.hpp:53
void imports_count(uint32_t cnt)
Definition DyldChainedFixups.hpp:235
void starts_offset(uint32_t offset)
Definition DyldChainedFixups.hpp:208
it_binding_info bindings()
Iterator over the bindings (ChainedBindingInfo) associated with this command.
Definition DyldChainedFixups.hpp:174
it_chained_starts_in_segments_t chained_starts_in_segments()
Iterator over the chained fixup metadata.
Definition DyldChainedFixups.hpp:184
it_const_chained_starts_in_segments_t chained_starts_in_segments() const
Definition DyldChainedFixups.hpp:189
friend class BinaryParser
Definition DyldChainedFixups.hpp:50
void data_size(uint32_t size)
Definition DyldChainedFixups.hpp:164
const_ref_iterator< const chained_starts_in_segments_t & > it_const_chained_starts_in_segments_t
Iterator that outputs const chained_starts_in_segment&.
Definition DyldChainedFixups.hpp:127
uint32_t data_size() const
Size of the LC_DYLD_CHAINED_FIXUPS payload.
Definition DyldChainedFixups.hpp:156
uint32_t symbols_offset() const
Offset of symbol strings in chain data.
Definition DyldChainedFixups.hpp:222
chained_starts_in_segment & add(chained_starts_in_segment start_info)
Definition DyldChainedFixups.hpp:261
void data_offset(uint32_t offset)
Definition DyldChainedFixups.hpp:160
uint32_t symbols_format() const
The compression algorithm (if any) used to store the symbols 0 means uncompressed while 1 means zlib ...
Definition DyldChainedFixups.hpp:244
friend class DyldChainedFixupsCreator
Definition DyldChainedFixups.hpp:55
ref_iterator< binding_info_t &, ChainedBindingInfo * > it_binding_info
Iterator which outputs DyldBindingInfo&.
Definition DyldChainedFixups.hpp:134
std::vector< chained_starts_in_segment > chained_starts_in_segments_t
Internal container for storing chained_starts_in_segment.
Definition DyldChainedFixups.hpp:120
span< const uint8_t > payload() const
Return the raw content of the command.
Definition DyldChainedFixups.hpp:169
friend class Builder
Definition DyldChainedFixups.hpp:51
uint32_t fixups_version() const
Chained fixups version. The loader (dyld v852.2) checks that this value is set to 0.
Definition DyldChainedFixups.hpp:195
const_ref_iterator< const binding_info_t &, ChainedBindingInfo * > it_const_binding_info
Iterator which outputs const DyldBindingInfo&.
Definition DyldChainedFixups.hpp:137
uint32_t imports_offset() const
Offset of imports table in chain data.
Definition DyldChainedFixups.hpp:213
uint32_t imports_count() const
Number of imported symbol names.
Definition DyldChainedFixups.hpp:231
friend class Binary
Definition DyldChainedFixups.hpp:54
friend class LinkEdit
Definition DyldChainedFixups.hpp:52
DYLD_CHAINED_FORMAT imports_format() const
The format of the imports (ChainedBindingInfo).
Definition DyldChainedFixups.hpp:253
void symbols_format(uint32_t fmt)
Definition DyldChainedFixups.hpp:248
void imports_format(DYLD_CHAINED_FORMAT fmt)
Definition DyldChainedFixups.hpp:257
void accept(Visitor &visitor) const override
ref_iterator< chained_starts_in_segments_t & > it_chained_starts_in_segments_t
Iterator that outputs chained_starts_in_segment&.
Definition DyldChainedFixups.hpp:123
std::unique_ptr< LoadCommand > clone() const override
Definition DyldChainedFixups.hpp:143
void imports_offset(uint32_t offset)
Definition DyldChainedFixups.hpp:217
std::ostream & print(std::ostream &os) const override
void fixups_version(uint32_t version)
Definition DyldChainedFixups.hpp:199
void symbols_offset(uint32_t offset)
Definition DyldChainedFixups.hpp:226
std::vector< std::unique_ptr< ChainedBindingInfo > > binding_info_t
Internal container for storing DyldBindingInfo.
Definition DyldChainedFixups.hpp:131
static bool classof(const LoadCommand *cmd)
Definition DyldChainedFixups.hpp:270
uint32_t starts_offset() const
offset of dyld_chained_starts_in_image in chain_data
Definition DyldChainedFixups.hpp:204
DyldChainedFixups(const details::linkedit_data_command &cmd)
Definition LinkEdit.hpp:46
uint32_t size() const
Size of the command (should be greater than sizeof(load_command)).
Definition LoadCommand.hpp:136
LoadCommand::TYPE command() const
Command type.
Definition LoadCommand.hpp:131
@ DYLD_CHAINED_FIXUPS
Definition LoadCommand.hpp:100
Class which represents a LoadCommand::TYPE::SEGMENT / LoadCommand::TYPE::SEGMENT_64 command.
Definition SegmentCommand.hpp:53
Definition Visitor.hpp:211
Iterator which returns reference on container's values.
Definition iterators.hpp:120
#define LIEF_LIFETIMEBOUND
Definition compiler_attributes.hpp:72
Definition endianness_support.hpp:62
Namespace related to the LIEF's Mach-O module.
Definition Abstract/Header.hpp:35
DYLD_CHAINED_FORMAT
Definition DyldChainedFormat.hpp:22
@ IMPORT
Originally: DYLD_CHAINED_IMPORT.
Definition DyldChainedFormat.hpp:24
DYLD_CHAINED_PTR_FORMAT
Definition DyldChainedFormat.hpp:34
@ NONE
Definition DyldChainedFormat.hpp:35
tcb::span< ElementType, Extent > span
Definition span.hpp:22
lief_version_t version()
Return the current version.
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
Structure that mirrors the raw dyld_chained_starts_in_segment which aims at providing information abo...
Definition DyldChainedFixups.hpp:63
std::vector< uint16_t > chain_starts
Currently not supported.
Definition DyldChainedFixups.hpp:95
uint16_t page_size
Likely 0x1000 for x86/x86_64 architectures and 0x4000 for ARM64 architecture.
Definition DyldChainedFixups.hpp:73
uint64_t segment_offset
Offset of the segment's data from the beginning of the file (it should match SegmentCommand::file_off...
Definition DyldChainedFixups.hpp:77
friend class BinaryParser
Definition DyldChainedFixups.hpp:109
DYLD_CHAINED_PTR_FORMAT pointer_format
How pointers are encoded.
Definition DyldChainedFixups.hpp:83
friend std::ostream & operator<<(std::ostream &os, const chained_starts_in_segment &info)
friend class DyldChainedFixupsCreator
Definition DyldChainedFixups.hpp:110
uint32_t max_valid_pointer
for 32-bit OS, any value beyond this is not a pointer
Definition DyldChainedFixups.hpp:80
SegmentCommand & segment
Segment in which the rebase/bind fixups take place.
Definition DyldChainedFixups.hpp:98
std::vector< uint16_t > page_start
Offset in the SegmentCommand of the first element of the chain.
Definition DyldChainedFixups.hpp:92
static chained_starts_in_segment create_empty_chained(SegmentCommand &segment)
Definition DyldChainedFixups.hpp:104
uint32_t offset
Original offset of the structure, relative to DyldChainedFixups::starts_offset.
Definition DyldChainedFixups.hpp:66
size_t page_count() const
How many pages are in the page_start array.
Definition DyldChainedFixups.hpp:86
uint32_t size
sizeof(size) + sizeof(page_size) + ... + sizeof(pointer_format)
Definition DyldChainedFixups.hpp:69
#define LIEF_API
Definition visibility.h:44
#define LIEF_LOCAL
Definition visibility.h:45