LIEF: Library to Instrument Executable Formats Version 0.17.0
Loading...
Searching...
No Matches
VolatileMetadata.hpp
Go to the documentation of this file.
1/* Copyright 2017 - 2025 R. Thomas
2 * Copyright 2017 - 2025 Quarkslab
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16#ifndef LIEF_PE_LOAD_CONFIGURATION_VOLATILE_METADATA_H
17#define LIEF_PE_LOAD_CONFIGURATION_VOLATILE_METADATA_H
18#include <memory>
19#include <string>
20#include <vector>
21
22#include "LIEF/visibility.h"
23#include "LIEF/iterators.hpp"
24
25namespace LIEF {
26class BinaryStream;
27namespace PE {
28class Parser;
35 public:
36 struct range_t {
37 uint32_t start = 0;
38 uint32_t size = 0;
39 uint32_t end() const {
40 return start + size;
41 }
42 };
43
44 using access_table_t = std::vector<uint32_t>;
45
46 using info_ranges_t = std::vector<range_t>;
47 using it_info_ranges_t = ref_iterator<info_ranges_t&>;
48 using it_const_info_ranges_t = const_ref_iterator<const info_ranges_t&>;
49
50 VolatileMetadata() = default;
51 VolatileMetadata(const VolatileMetadata&) = default;
52 VolatileMetadata& operator=(const VolatileMetadata&) = default;
53
54 VolatileMetadata(VolatileMetadata&&) = default;
55 VolatileMetadata& operator=(VolatileMetadata&&) = default;
56
57 std::unique_ptr<VolatileMetadata> clone() const {
58 return std::unique_ptr<VolatileMetadata>(new VolatileMetadata(*this));
59 }
60 uint32_t size() const {
63 return size_;
64 }
65
66 uint16_t min_version() const {
67 return min_version_;
68 }
69
70 uint16_t max_version() const {
71 return max_version_;
72 }
73
74 uint32_t access_table_rva() const {
75 return access_table_rva_;
76 }
77
78 const access_table_t& access_table() const {
79 return access_table_;
80 }
81
82 uint32_t access_table_size() const {
83 return access_table_.size() * sizeof(uint32_t);
84 }
85
86 uint32_t info_range_rva() const {
87 return info_range_rva_;
88 }
89
90 uint32_t info_ranges_size() const {
91 static_assert(sizeof(range_t) == 8, "Can't be used for computing the raw size");
92 return info_ranges_.size() * sizeof(range_t);
93 }
94
95 it_const_info_ranges_t info_ranges() const {
96 return info_ranges_;
97 }
98
99 it_info_ranges_t info_ranges() {
100 return info_ranges_;
101 }
102
103 VolatileMetadata& size(uint32_t value) {
104 size_ = value;
105 return *this;
106 }
107
108 VolatileMetadata& min_version(uint16_t min) {
109 min_version_ = min;
110 return *this;
111 }
112
113 VolatileMetadata& max_version(uint16_t max) {
114 max_version_ = max;
115 return *this;
116 }
117
118 VolatileMetadata& access_table_rva(uint32_t value) {
119 access_table_rva_ = value;
120 return *this;
121 }
122
123 VolatileMetadata& info_range_rva(uint32_t value) {
124 info_range_rva_ = value;
125 return *this;
126 }
127
128 std::string to_string() const;
129
130 LIEF_API friend
131 std::ostream& operator<<(std::ostream& os, const VolatileMetadata& meta)
132 {
133 os << meta.to_string();
134 return os;
135 }
136 LIEF_LOCAL static std::unique_ptr<VolatileMetadata>
139 parse(Parser& ctx, BinaryStream& stream);
140
141 private:
142 uint32_t size_ = 0;
143 uint16_t min_version_ = 0;
144 uint16_t max_version_ = 0;
145 uint32_t access_table_rva_ = 0;
146
147 uint32_t info_range_rva_ = 0;
148
149 access_table_t access_table_;
150 info_ranges_t info_ranges_;
151
152};
153}
154}
155
156#endif
Class that is used to a read stream of data from different sources.
Definition BinaryStream.hpp:33
Main interface to parse PE binaries. In particular the static functions: Parser::parse should be used...
Definition PE/Parser.hpp:52
This class represents volatile metadata which can be enabled at link time with /volatileMetadata.
Definition VolatileMetadata.hpp:34
uint32_t info_range_rva() const
Definition VolatileMetadata.hpp:86
VolatileMetadata & size(uint32_t value)
Definition VolatileMetadata.hpp:103
VolatileMetadata(VolatileMetadata &&)=default
uint32_t size() const
Size (in bytes) of the current raw structure.
Definition VolatileMetadata.hpp:62
VolatileMetadata & access_table_rva(uint32_t value)
Definition VolatileMetadata.hpp:118
std::unique_ptr< VolatileMetadata > clone() const
Definition VolatileMetadata.hpp:57
const access_table_t & access_table() const
Definition VolatileMetadata.hpp:78
it_info_ranges_t info_ranges()
Definition VolatileMetadata.hpp:99
uint16_t max_version() const
Definition VolatileMetadata.hpp:70
it_const_info_ranges_t info_ranges() const
Definition VolatileMetadata.hpp:95
VolatileMetadata & operator=(const VolatileMetadata &)=default
VolatileMetadata(const VolatileMetadata &)=default
VolatileMetadata & operator=(VolatileMetadata &&)=default
uint32_t access_table_rva() const
Definition VolatileMetadata.hpp:74
uint16_t min_version() const
Definition VolatileMetadata.hpp:66
VolatileMetadata & min_version(uint16_t min)
Definition VolatileMetadata.hpp:108
friend std::ostream & operator<<(std::ostream &os, const VolatileMetadata &meta)
Definition VolatileMetadata.hpp:131
VolatileMetadata & info_range_rva(uint32_t value)
Definition VolatileMetadata.hpp:123
uint32_t info_ranges_size() const
Definition VolatileMetadata.hpp:90
VolatileMetadata()=default
std::string to_string() const
uint32_t access_table_size() const
Definition VolatileMetadata.hpp:82
VolatileMetadata & max_version(uint16_t max)
Definition VolatileMetadata.hpp:113
Namespace related to the LIEF's PE module.
Definition Abstract/Header.hpp:32
LIEF namespace.
Definition Abstract/Binary.hpp:36
uint32_t end() const
Definition VolatileMetadata.hpp:39
#define LIEF_API
Definition visibility.h:41
#define LIEF_LOCAL
Definition visibility.h:42