LIEF: Library to Instrument Executable Formats Version 2.0.0
Loading...
Searching...
No Matches
MetadataARM64.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_PE_LOAD_CONFIGURATION_CHPE_METADATA_ARM64_H
16#define LIEF_PE_LOAD_CONFIGURATION_CHPE_METADATA_ARM64_H
17#include <cstdint>
18#include <memory>
19
21#include "LIEF/errors.hpp"
22#include "LIEF/iterators.hpp"
23#include "LIEF/visibility.h"
24
25
26namespace LIEF::PE {
27
36 public:
39 static constexpr uint32_t TYPE_MASK = 3;
40
41 enum class TYPE {
43 ARM64 = 0,
44
46 ARM64EC = 1,
47
49 AMD64 = 2,
50 };
51
53 uint32_t start_offset = 0;
54
56 uint32_t length = 0;
57
59 uint32_t start() const {
60 return start_offset & ~TYPE_MASK;
61 }
62
64 TYPE type() const {
65 return TYPE(start_offset & TYPE_MASK);
66 }
67
69 uint32_t end() const {
70 return start() + length;
71 }
72 };
73
76 uint32_t src = 0;
77 uint32_t dst = 0;
78 };
79
84 uint32_t start_rva = 0;
85
87 uint32_t end_rva = 0;
88
90 uint32_t entrypoint = 0;
91 };
92
93 using range_entries_t = std::vector<range_entry_t>;
96
97 using redirection_entries_t = std::vector<redirection_entry_t>;
101
102 using code_range_entry_point_entries = std::vector<code_range_entry_point_t>;
106
108 CHPEMetadata(KIND::ARM64, version) {}
109
112
115
116 std::unique_ptr<CHPEMetadata> clone() const override {
117 return std::make_unique<CHPEMetadataARM64>(*this);
118 }
119
120 static std::unique_ptr<CHPEMetadataARM64>
121 parse(Parser& ctx, BinaryStream& stream, uint32_t version);
122
124
126
128 CHPEMetadataARM64& metadata);
129
131 uint32_t code_map() const {
132 return code_map_rva_;
133 }
134
136 uint32_t code_map_count() const {
137 return code_map_cnt_;
138 }
139
140 uint32_t code_ranges_to_entrypoints() const {
141 return code_ranges_to_ep_;
142 }
143
144 uint32_t redirection_metadata() const {
145 return redirection_metadata_;
146 }
147
149 return os_arm64x_dispatch_call_no_redirect_;
150 }
151
152 uint32_t os_arm64x_dispatch_ret() const {
153 return os_arm64x_dispatch_ret_;
154 }
155
156 uint32_t os_arm64x_dispatch_call() const {
157 return os_arm64x_dispatch_call_;
158 }
159
160 uint32_t os_arm64x_dispatch_icall() const {
161 return os_arm64x_dispatch_icall_;
162 }
163
165 return os_arm64x_dispatch_icall_cfg_;
166 }
167
168 uint32_t alternate_entry_point() const {
169 return alternate_ep_;
170 }
171
172 uint32_t auxiliary_iat() const {
173 return aux_iat_;
174 }
175
177 return code_ranges_to_ep_cnt_;
178 }
179
180 uint32_t redirection_metadata_count() const {
181 return redirection_metadata_cnt_;
182 }
183
185 return get_x64_information_function_pointer_;
186 }
187
189 return set_x64_information_function_pointer_;
190 }
191
193 uint32_t extra_rfe_table() const {
194 return extra_rfe_table_;
195 }
196
198 uint32_t extra_rfe_table_size() const {
199 return extra_rfe_table_size_;
200 }
201
202 uint32_t os_arm64x_dispatch_fptr() const {
203 return os_arm64x_dispatch_fptr_;
204 }
205
206 uint32_t auxiliary_iat_copy() const {
207 return aux_iat_copy_;
208 }
209
210 uint32_t auxiliary_delay_import() const {
211 return aux_delay_import_;
212 }
213
215 return aux_delay_import_copy_;
216 }
217
218 uint32_t bitfield_info() const {
219 return bitfield_info_;
220 }
221
223 return range_entries_;
224 }
225
227 return range_entries_;
228 }
229
231 return redirection_entries_;
232 }
233
235 return redirection_entries_;
236 }
237
239 return code_range_entry_point_entries_;
240 }
241
242 it_const_code_range_entry_point
244 return code_range_entry_point_entries_;
245 }
246
248 code_map_rva_ = value;
249 return *this;
250 }
251
253 code_map_cnt_ = value;
254 return *this;
255 }
256
259 code_ranges_to_ep_ = value;
260 return *this;
261 }
262
264 redirection_metadata_ = value;
265 return *this;
266 }
267
270 os_arm64x_dispatch_call_no_redirect_ = value;
271 return *this;
272 }
273
275 os_arm64x_dispatch_ret_ = value;
276 return *this;
277 }
278
280 os_arm64x_dispatch_call_ = value;
281 return *this;
282 }
283
285 os_arm64x_dispatch_icall_ = value;
286 return *this;
287 }
288
291 os_arm64x_dispatch_icall_cfg_ = value;
292 return *this;
293 }
294
296 alternate_ep_ = value;
297 return *this;
298 }
299
301 aux_iat_ = value;
302 return *this;
303 }
304
307 code_ranges_to_ep_cnt_ = value;
308 return *this;
309 }
310
313 redirection_metadata_cnt_ = value;
314 return *this;
315 }
316
319 get_x64_information_function_pointer_ = value;
320 return *this;
321 }
322
325 set_x64_information_function_pointer_ = value;
326 return *this;
327 }
328
330 extra_rfe_table_ = value;
331 return *this;
332 }
333
335 extra_rfe_table_size_ = value;
336 return *this;
337 }
338
340 os_arm64x_dispatch_fptr_ = value;
341 return *this;
342 }
343
345 aux_iat_copy_ = value;
346 return *this;
347 }
348
350 aux_delay_import_ = value;
351 return *this;
352 }
353
356 aux_delay_import_copy_ = value;
357 return *this;
358 }
359
361 bitfield_info_ = value;
362 return *this;
363 }
364
365 static bool classof(const CHPEMetadata* meta) {
366 return meta->kind() == KIND::ARM64;
367 }
368
369 std::string to_string() const override;
370
371 ~CHPEMetadataARM64() override = default;
372
373 private:
374 uint32_t code_map_rva_ = 0;
375 uint32_t code_map_cnt_ = 0;
376 uint32_t code_ranges_to_ep_ = 0;
377 uint32_t redirection_metadata_ = 0;
378 uint32_t os_arm64x_dispatch_call_no_redirect_ = 0;
379 uint32_t os_arm64x_dispatch_ret_ = 0;
380 uint32_t os_arm64x_dispatch_call_ = 0;
381 uint32_t os_arm64x_dispatch_icall_ = 0;
382 uint32_t os_arm64x_dispatch_icall_cfg_ = 0;
383 uint32_t alternate_ep_ = 0;
384 uint32_t aux_iat_ = 0;
385 uint32_t code_ranges_to_ep_cnt_ = 0;
386 uint32_t redirection_metadata_cnt_ = 0;
387 uint32_t get_x64_information_function_pointer_ = 0;
388 uint32_t set_x64_information_function_pointer_ = 0;
389 uint32_t extra_rfe_table_ = 0;
390 uint32_t extra_rfe_table_size_ = 0;
391 uint32_t os_arm64x_dispatch_fptr_ = 0;
392 uint32_t aux_iat_copy_ = 0;
393 uint32_t aux_delay_import_ = 0;
394 uint32_t aux_delay_import_copy_ = 0;
395 uint32_t bitfield_info_ = 0;
396
397 range_entries_t range_entries_;
398 redirection_entries_t redirection_entries_;
399 code_range_entry_point_entries code_range_entry_point_entries_;
400};
401
403}
404
405
406#endif
Class that is used to a read stream of data from different sources.
Definition BinaryStream.hpp:34
This class represents ARM64-specific metadata used in CHPE (Compatible Hybrid PE) binaries,...
Definition MetadataARM64.hpp:35
const_ref_iterator< const redirection_entries_t & > it_const_redirection_entries
Definition MetadataARM64.hpp:99
~CHPEMetadataARM64() override=default
CHPEMetadataARM64 & auxiliary_delay_import(uint32_t value)
Definition MetadataARM64.hpp:349
uint32_t os_arm64x_dispatch_fptr() const
Definition MetadataARM64.hpp:202
CHPEMetadataARM64 & os_arm64x_dispatch_icall_cfg(uint32_t value)
Definition MetadataARM64.hpp:290
CHPEMetadataARM64 & code_ranges_to_entrypoints(uint32_t value)
Definition MetadataARM64.hpp:258
it_const_code_range_entry_point code_range_entry_point() const
Definition MetadataARM64.hpp:243
CHPEMetadataARM64(CHPEMetadataARM64 &&)=default
static ok_error_t parse_code_map(Parser &ctx, CHPEMetadataARM64 &metadata)
it_const_redirection_entries redirections() const
Definition MetadataARM64.hpp:234
uint32_t auxiliary_delay_import_copy() const
Definition MetadataARM64.hpp:214
uint32_t extra_rfe_table_size() const
architecture-specific exception table size
Definition MetadataARM64.hpp:198
CHPEMetadataARM64(const CHPEMetadataARM64 &)=default
ref_iterator< redirection_entries_t & > it_redirection_entries
Definition MetadataARM64.hpp:98
CHPEMetadataARM64 & redirection_metadata_count(uint32_t value)
Definition MetadataARM64.hpp:312
CHPEMetadataARM64 & code_map(uint32_t value)
Definition MetadataARM64.hpp:247
CHPEMetadataARM64 & redirection_metadata(uint32_t value)
Definition MetadataARM64.hpp:263
const_ref_iterator< const code_range_entry_point_entries & > it_const_code_range_entry_point
Definition MetadataARM64.hpp:104
ref_iterator< code_range_entry_point_entries & > it_code_range_entry_point
Definition MetadataARM64.hpp:103
CHPEMetadataARM64 & alternate_entry_point(uint32_t value)
Definition MetadataARM64.hpp:295
CHPEMetadataARM64 & bitfield_info(uint32_t value)
Definition MetadataARM64.hpp:360
uint32_t code_map_count() const
Number of entries in the code map.
Definition MetadataARM64.hpp:136
CHPEMetadataARM64 & os_arm64x_dispatch_ret(uint32_t value)
Definition MetadataARM64.hpp:274
CHPEMetadataARM64 & os_arm64x_dispatch_icall(uint32_t value)
Definition MetadataARM64.hpp:284
CHPEMetadataARM64(uint32_t version)
Definition MetadataARM64.hpp:107
ref_iterator< range_entries_t & > it_range_entries
Definition MetadataARM64.hpp:94
CHPEMetadataARM64 & operator=(CHPEMetadataARM64 &&)=default
uint32_t extra_rfe_table() const
RVA to this architecture-specific exception table.
Definition MetadataARM64.hpp:193
uint32_t os_arm64x_dispatch_icall() const
Definition MetadataARM64.hpp:160
uint32_t os_arm64x_dispatch_call() const
Definition MetadataARM64.hpp:156
it_code_range_entry_point code_range_entry_point()
Definition MetadataARM64.hpp:238
uint32_t redirection_metadata() const
Definition MetadataARM64.hpp:144
std::unique_ptr< CHPEMetadata > clone() const override
Definition MetadataARM64.hpp:116
std::vector< redirection_entry_t > redirection_entries_t
Definition MetadataARM64.hpp:97
CHPEMetadataARM64 & operator=(const CHPEMetadataARM64 &)=default
uint32_t auxiliary_iat() const
Definition MetadataARM64.hpp:172
CHPEMetadataARM64 & extra_rfe_table_size(uint32_t value)
Definition MetadataARM64.hpp:334
uint32_t code_ranges_to_entry_points_count() const
Definition MetadataARM64.hpp:176
it_redirection_entries redirections()
Definition MetadataARM64.hpp:230
uint32_t alternate_entry_point() const
Definition MetadataARM64.hpp:168
uint32_t redirection_metadata_count() const
Definition MetadataARM64.hpp:180
uint32_t get_x64_information_function_pointer() const
Definition MetadataARM64.hpp:184
uint32_t set_x64_information_function_pointer() const
Definition MetadataARM64.hpp:188
it_range_entries code_ranges()
Definition MetadataARM64.hpp:222
CHPEMetadataARM64 & os_arm64x_dispatch_fptr(uint32_t value)
Definition MetadataARM64.hpp:339
CHPEMetadataARM64 & code_ranges_to_entry_points_count(uint32_t value)
Definition MetadataARM64.hpp:306
CHPEMetadataARM64 & set_x64_information_function_pointer(uint32_t value)
Definition MetadataARM64.hpp:324
static std::unique_ptr< CHPEMetadataARM64 > parse(Parser &ctx, BinaryStream &stream, uint32_t version)
CHPEMetadataARM64 & auxiliary_iat(uint32_t value)
Definition MetadataARM64.hpp:300
CHPEMetadataARM64 & code_map_count(uint32_t value)
Definition MetadataARM64.hpp:252
it_const_range_entries code_ranges() const
Definition MetadataARM64.hpp:226
std::vector< code_range_entry_point_t > code_range_entry_point_entries
Definition MetadataARM64.hpp:102
std::string to_string() const override
uint32_t code_map() const
RVA to the array that describes architecture-specific ranges.
Definition MetadataARM64.hpp:131
uint32_t os_arm64x_dispatch_call_no_redirect() const
Definition MetadataARM64.hpp:148
uint32_t bitfield_info() const
Definition MetadataARM64.hpp:218
uint32_t os_arm64x_dispatch_ret() const
Definition MetadataARM64.hpp:152
std::vector< range_entry_t > range_entries_t
Definition MetadataARM64.hpp:93
CHPEMetadataARM64 & os_arm64x_dispatch_call(uint32_t value)
Definition MetadataARM64.hpp:279
uint32_t code_ranges_to_entrypoints() const
Definition MetadataARM64.hpp:140
static ok_error_t parse_redirections(Parser &ctx, CHPEMetadataARM64 &metadata)
CHPEMetadataARM64 & auxiliary_delay_import_copy(uint32_t value)
Definition MetadataARM64.hpp:355
uint32_t os_arm64x_dispatch_icall_cfg() const
Definition MetadataARM64.hpp:164
CHPEMetadataARM64 & extra_rfe_table(uint32_t value)
Definition MetadataARM64.hpp:329
uint32_t auxiliary_delay_import() const
Definition MetadataARM64.hpp:210
CHPEMetadataARM64 & auxiliary_iat_copy(uint32_t value)
Definition MetadataARM64.hpp:344
static ok_error_t parse_code_ranges_to_entry_points(Parser &ctx, CHPEMetadataARM64 &metadata)
static bool classof(const CHPEMetadata *meta)
Definition MetadataARM64.hpp:365
CHPEMetadataARM64 & os_arm64x_dispatch_call_no_redirect(uint32_t value)
Definition MetadataARM64.hpp:269
uint32_t auxiliary_iat_copy() const
Definition MetadataARM64.hpp:206
const_ref_iterator< const range_entries_t & > it_const_range_entries
Definition MetadataARM64.hpp:95
CHPEMetadataARM64 & get_x64_information_function_pointer(uint32_t value)
Definition MetadataARM64.hpp:318
uint32_t version() const
Version of the structure.
Definition PE/LoadConfigurations/CHPEMetadata/Metadata.hpp:63
KIND kind() const
Determine the type of the concrete implementation.
Definition PE/LoadConfigurations/CHPEMetadata/Metadata.hpp:58
KIND
Discriminator for the subclasses.
Definition PE/LoadConfigurations/CHPEMetadata/Metadata.hpp:34
@ ARM64
Definition PE/LoadConfigurations/CHPEMetadata/Metadata.hpp:36
Main interface to parse PE binaries. In particular, the static Parser::parse functions should be used...
Definition PE/Parser.hpp:53
Opaque structure that is used by LIEF to avoid writing result<void> f(...). Instead,...
Definition errors.hpp:118
Iterator which returns reference on container's values.
Definition iterators.hpp:120
#define LIEF_LIFETIMEBOUND
Definition compiler_attributes.hpp:72
Namespace related to the LIEF's PE module.
Definition Abstract/Header.hpp:31
const char * to_string(CODE_PAGES e)
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
Mirror of IMAGE_ARM64EC_CODE_RANGE_ENTRY_POINT: Represents a mapping between code range and its entry...
Definition MetadataARM64.hpp:82
uint32_t end_rva
End of the code range (RVA).
Definition MetadataARM64.hpp:87
uint32_t entrypoint
RVA of the entry point for this range.
Definition MetadataARM64.hpp:90
uint32_t start_rva
Start of the code range.
Definition MetadataARM64.hpp:84
Structure that describes architecture-specific ranges.
Definition MetadataARM64.hpp:38
uint32_t length
Range's length.
Definition MetadataARM64.hpp:56
static constexpr uint32_t TYPE_MASK
Definition MetadataARM64.hpp:39
TYPE
Definition MetadataARM64.hpp:41
TYPE type() const
Architecture for this range.
Definition MetadataARM64.hpp:64
uint32_t start_offset
Raw data (include start RVA and type).
Definition MetadataARM64.hpp:53
uint32_t end() const
End of the range (RVA).
Definition MetadataARM64.hpp:69
uint32_t start() const
Start of the range (RVA).
Definition MetadataARM64.hpp:59
Structure that describes a redirection.
Definition MetadataARM64.hpp:75
uint32_t dst
Definition MetadataARM64.hpp:77
uint32_t src
Definition MetadataARM64.hpp:76
#define LIEF_API
Definition visibility.h:44