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 <cstdint>
19#include <memory>
20#include <string>
21#include <vector>
22
23#include "LIEF/visibility.h"
24#include "LIEF/iterators.hpp"
25
26namespace LIEF {
27class BinaryStream;
28namespace PE {
29class Parser;
36 public:
37 struct range_t {
38 uint32_t start = 0;
39 uint32_t size = 0;
40 uint32_t end() const {
41 return start + size;
42 }
43 };
44
45 using access_table_t = std::vector<uint32_t>;
46
47 using info_ranges_t = std::vector<range_t>;
48 using it_info_ranges_t = ref_iterator<info_ranges_t&>;
49 using it_const_info_ranges_t = const_ref_iterator<const info_ranges_t&>;
50
51 VolatileMetadata() = default;
52 VolatileMetadata(const VolatileMetadata&) = default;
53 VolatileMetadata& operator=(const VolatileMetadata&) = default;
54
55 VolatileMetadata(VolatileMetadata&&) = default;
56 VolatileMetadata& operator=(VolatileMetadata&&) = default;
57
58 std::unique_ptr<VolatileMetadata> clone() const {
59 return std::unique_ptr<VolatileMetadata>(new VolatileMetadata(*this));
60 }
61 uint32_t size() const {
64 return size_;
65 }
66
67 uint16_t min_version() const {
68 return min_version_;
69 }
70
71 uint16_t max_version() const {
72 return max_version_;
73 }
74
75 uint32_t access_table_rva() const {
76 return access_table_rva_;
77 }
78
79 const access_table_t& access_table() const {
80 return access_table_;
81 }
82
83 uint32_t access_table_size() const {
84 return access_table_.size() * sizeof(uint32_t);
85 }
86
87 uint32_t info_range_rva() const {
88 return info_range_rva_;
89 }
90
91 uint32_t info_ranges_size() const {
92 static_assert(sizeof(range_t) == 8, "Can't be used for computing the raw size");
93 return info_ranges_.size() * sizeof(range_t);
94 }
95
96 it_const_info_ranges_t info_ranges() const {
97 return info_ranges_;
98 }
99
100 it_info_ranges_t info_ranges() {
101 return info_ranges_;
102 }
103
104 VolatileMetadata& size(uint32_t value) {
105 size_ = value;
106 return *this;
107 }
108
109 VolatileMetadata& min_version(uint16_t min) {
110 min_version_ = min;
111 return *this;
112 }
113
114 VolatileMetadata& max_version(uint16_t max) {
115 max_version_ = max;
116 return *this;
117 }
118
119 VolatileMetadata& access_table_rva(uint32_t value) {
120 access_table_rva_ = value;
121 return *this;
122 }
123
124 VolatileMetadata& info_range_rva(uint32_t value) {
125 info_range_rva_ = value;
126 return *this;
127 }
128
129 std::string to_string() const;
130
131 LIEF_API friend
132 std::ostream& operator<<(std::ostream& os, const VolatileMetadata& meta)
133 {
134 os << meta.to_string();
135 return os;
136 }
137 LIEF_LOCAL static std::unique_ptr<VolatileMetadata>
140 parse(Parser& ctx, BinaryStream& stream);
141
142 private:
143 uint32_t size_ = 0;
144 uint16_t min_version_ = 0;
145 uint16_t max_version_ = 0;
146 uint32_t access_table_rva_ = 0;
147
148 uint32_t info_range_rva_ = 0;
149
150 access_table_t access_table_;
151 info_ranges_t info_ranges_;
152
153};
154}
155}
156
157#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:35
uint32_t info_range_rva() const
Definition VolatileMetadata.hpp:87
VolatileMetadata & size(uint32_t value)
Definition VolatileMetadata.hpp:104
VolatileMetadata(VolatileMetadata &&)=default
uint32_t size() const
Size (in bytes) of the current raw structure.
Definition VolatileMetadata.hpp:63
VolatileMetadata & access_table_rva(uint32_t value)
Definition VolatileMetadata.hpp:119
std::unique_ptr< VolatileMetadata > clone() const
Definition VolatileMetadata.hpp:58
const access_table_t & access_table() const
Definition VolatileMetadata.hpp:79
it_info_ranges_t info_ranges()
Definition VolatileMetadata.hpp:100
uint16_t max_version() const
Definition VolatileMetadata.hpp:71
it_const_info_ranges_t info_ranges() const
Definition VolatileMetadata.hpp:96
VolatileMetadata & operator=(const VolatileMetadata &)=default
VolatileMetadata(const VolatileMetadata &)=default
VolatileMetadata & operator=(VolatileMetadata &&)=default
uint32_t access_table_rva() const
Definition VolatileMetadata.hpp:75
uint16_t min_version() const
Definition VolatileMetadata.hpp:67
VolatileMetadata & min_version(uint16_t min)
Definition VolatileMetadata.hpp:109
friend std::ostream & operator<<(std::ostream &os, const VolatileMetadata &meta)
Definition VolatileMetadata.hpp:132
VolatileMetadata & info_range_rva(uint32_t value)
Definition VolatileMetadata.hpp:124
uint32_t info_ranges_size() const
Definition VolatileMetadata.hpp:91
VolatileMetadata()=default
std::string to_string() const
uint32_t access_table_size() const
Definition VolatileMetadata.hpp:83
VolatileMetadata & max_version(uint16_t max)
Definition VolatileMetadata.hpp:114
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:40
#define LIEF_API
Definition visibility.h:41
#define LIEF_LOCAL
Definition visibility.h:42