LIEF: Library to Instrument Executable Formats Version 2.0.0
Loading...
Searching...
No Matches
DosHeader.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_DOS_HEADER_H
16#define LIEF_PE_DOS_HEADER_H
17#include <array>
18#include <cstdint>
19#include <ostream>
20
21#include "LIEF/Object.hpp"
22#include "LIEF/visibility.h"
23
24namespace LIEF {
25class vector_iostream;
26}
27
28namespace LIEF::PE {
29
30enum class PE_TYPE : uint16_t;
31
32namespace details {
33struct pe_dos_header;
34}
35
40class LIEF_API DosHeader : public Object {
41 public:
42 using reserved_t = std::array<uint16_t, 4>;
43 using reserved2_t = std::array<uint16_t, 10>;
44
45 static constexpr uint16_t MAGIC = 0x5a4d; // MZ
46
47 DosHeader(const details::pe_dos_header& header);
48 DosHeader(const DosHeader&) = default;
49 DosHeader& operator=(const DosHeader&) = default;
50
51 DosHeader(DosHeader&&) = default;
53
54 ~DosHeader() override = default;
55
57 uint16_t magic() const {
58 return magic_;
59 }
60
61 uint16_t used_bytes_in_last_page() const {
62 return used_bytes_in_last_page_;
63 }
64
65 uint16_t file_size_in_pages() const {
66 return file_sz_in_pages_;
67 }
68
69 uint16_t numberof_relocation() const {
70 return nb_relocations_;
71 }
72
73 uint16_t header_size_in_paragraphs() const {
74 return header_sz_in_paragraphs_;
75 }
76
77 uint16_t minimum_extra_paragraphs() const {
78 return min_extra_paragraphs_;
79 }
80
81 uint16_t maximum_extra_paragraphs() const {
82 return max_extra_paragraphs_;
83 }
84
85 uint16_t initial_relative_ss() const {
86 return init_relative_ss_;
87 }
88
89 uint16_t initial_sp() const {
90 return init_sp_;
91 }
92
93 uint16_t checksum() const {
94 return checksum_;
95 }
96
97 uint16_t initial_ip() const {
98 return init_ip_;
99 }
100
101 uint16_t initial_relative_cs() const {
102 return init_rel_cs_;
103 }
104
105 uint16_t addressof_relocation_table() const {
106 return addr_reloc_table_;
107 }
108
109 uint16_t overlay_number() const {
110 return overlay_number_;
111 }
112
113 const reserved_t& reserved() const {
114 return reserved_;
115 }
116
117 uint16_t oem_id() const {
118 return oem_id_;
119 }
120
121 uint16_t oem_info() const {
122 return oem_info_;
123 }
124
125 const reserved2_t& reserved2() const {
126 return reserved2_;
127 }
128
130 uint32_t addressof_new_exeheader() const {
131 return addr_new_exe_header_;
132 }
133
134 void magic(uint16_t magic) {
135 magic_ = magic;
136 }
137
138 void used_bytes_in_last_page(uint16_t value) {
139 used_bytes_in_last_page_ = value;
140 }
141
142 void file_size_in_pages(uint16_t value) {
143 file_sz_in_pages_ = value;
144 }
145
146 void numberof_relocation(uint16_t value) {
147 nb_relocations_ = value;
148 }
149
150 void header_size_in_paragraphs(uint16_t value) {
151 header_sz_in_paragraphs_ = value;
152 }
153
154 void minimum_extra_paragraphs(uint16_t value) {
155 min_extra_paragraphs_ = value;
156 }
157
158 void maximum_extra_paragraphs(uint16_t value) {
159 max_extra_paragraphs_ = value;
160 }
161
162 void initial_relative_ss(uint16_t value) {
163 init_relative_ss_ = value;
164 }
165
166 void initial_sp(uint16_t value) {
167 init_sp_ = value;
168 }
169
170 void checksum(uint16_t value) {
171 checksum_ = value;
172 }
173
174 void initial_ip(uint16_t value) {
175 init_ip_ = value;
176 }
177
178 void initial_relative_cs(uint16_t value) {
179 init_rel_cs_ = value;
180 }
181
182 void addressof_relocation_table(uint16_t value) {
183 addr_reloc_table_ = value;
184 }
185
186 void overlay_number(uint16_t value) {
187 overlay_number_ = value;
188 }
189
191 reserved_ = reserved;
192 }
193
194 void oem_id(uint16_t value) {
195 oem_id_ = value;
196 }
197
198 void oem_info(uint16_t value) {
199 oem_info_ = value;
200 }
201
203 reserved2_ = reserved2;
204 }
205
206 void addressof_new_exeheader(uint32_t value) {
207 addr_new_exe_header_ = value;
208 }
209
210 void accept(Visitor& visitor) const override;
211
212 LIEF_API friend std::ostream& operator<<(std::ostream& os,
213 const DosHeader& entry);
214
216
218 LIEF_LOCAL DosHeader() = default;
219
221 LIEF_LOCAL size_t serialize(vector_iostream& ios) const;
222
223 private:
224 uint16_t magic_ = 0;
225 uint16_t used_bytes_in_last_page_ = 0;
226 uint16_t file_sz_in_pages_ = 0;
227 uint16_t nb_relocations_ = 0;
228 uint16_t header_sz_in_paragraphs_ = 0;
229 uint16_t min_extra_paragraphs_ = 0;
230 uint16_t max_extra_paragraphs_ = 0;
231 uint16_t init_relative_ss_ = 0;
232 uint16_t init_sp_ = 0;
233 uint16_t checksum_ = 0;
234 uint16_t init_ip_ = 0;
235 uint16_t init_rel_cs_ = 0;
236 uint16_t addr_reloc_table_ = 0;
237 uint16_t overlay_number_ = 0;
238 reserved_t reserved_ = {0};
239 uint16_t oem_id_ = 0;
240 uint16_t oem_info_ = 0;
241 reserved2_t reserved2_ = {0};
242 uint32_t addr_new_exe_header_ = 0;
243};
244}
245
246
247#endif
void minimum_extra_paragraphs(uint16_t value)
Definition DosHeader.hpp:154
uint16_t magic() const
Magic bytes identifying a DOS/PE binary.
Definition DosHeader.hpp:57
void file_size_in_pages(uint16_t value)
Definition DosHeader.hpp:142
uint16_t numberof_relocation() const
Definition DosHeader.hpp:69
static constexpr uint16_t MAGIC
Definition DosHeader.hpp:45
DosHeader & operator=(const DosHeader &)=default
DosHeader & operator=(DosHeader &&)=default
uint16_t initial_relative_cs() const
Definition DosHeader.hpp:101
DosHeader(DosHeader &&)=default
void oem_id(uint16_t value)
Definition DosHeader.hpp:194
void reserved(const reserved_t &reserved)
Definition DosHeader.hpp:190
uint16_t addressof_relocation_table() const
Definition DosHeader.hpp:105
uint16_t initial_sp() const
Definition DosHeader.hpp:89
uint16_t header_size_in_paragraphs() const
Definition DosHeader.hpp:73
const reserved_t & reserved() const
Definition DosHeader.hpp:113
void accept(Visitor &visitor) const override
uint16_t oem_id() const
Definition DosHeader.hpp:117
void oem_info(uint16_t value)
Definition DosHeader.hpp:198
void used_bytes_in_last_page(uint16_t value)
Definition DosHeader.hpp:138
void header_size_in_paragraphs(uint16_t value)
Definition DosHeader.hpp:150
void reserved2(const reserved2_t &reserved2)
Definition DosHeader.hpp:202
void overlay_number(uint16_t value)
Definition DosHeader.hpp:186
uint16_t initial_ip() const
Definition DosHeader.hpp:97
std::array< uint16_t, 10 > reserved2_t
Definition DosHeader.hpp:43
uint32_t addressof_new_exeheader() const
Return the offset to the PE::Header structure.
Definition DosHeader.hpp:130
void numberof_relocation(uint16_t value)
Definition DosHeader.hpp:146
friend std::ostream & operator<<(std::ostream &os, const DosHeader &entry)
void addressof_relocation_table(uint16_t value)
Definition DosHeader.hpp:182
const reserved2_t & reserved2() const
Definition DosHeader.hpp:125
void magic(uint16_t magic)
Definition DosHeader.hpp:134
void initial_sp(uint16_t value)
Definition DosHeader.hpp:166
uint16_t overlay_number() const
Definition DosHeader.hpp:109
uint16_t maximum_extra_paragraphs() const
Definition DosHeader.hpp:81
DosHeader(const DosHeader &)=default
~DosHeader() override=default
uint16_t oem_info() const
Definition DosHeader.hpp:121
uint16_t file_size_in_pages() const
Definition DosHeader.hpp:65
uint16_t checksum() const
Definition DosHeader.hpp:93
void initial_relative_cs(uint16_t value)
Definition DosHeader.hpp:178
std::array< uint16_t, 4 > reserved_t
Definition DosHeader.hpp:42
uint16_t minimum_extra_paragraphs() const
Definition DosHeader.hpp:77
void initial_ip(uint16_t value)
Definition DosHeader.hpp:174
void maximum_extra_paragraphs(uint16_t value)
Definition DosHeader.hpp:158
DosHeader(const details::pe_dos_header &header)
static DosHeader create(PE_TYPE type)
void initial_relative_ss(uint16_t value)
Definition DosHeader.hpp:162
void addressof_new_exeheader(uint32_t value)
Definition DosHeader.hpp:206
uint16_t used_bytes_in_last_page() const
Definition DosHeader.hpp:61
void checksum(uint16_t value)
Definition DosHeader.hpp:170
uint16_t initial_relative_ss() const
Definition DosHeader.hpp:85
Definition Visitor.hpp:211
Definition iostream.hpp:33
Definition DataDirectory.hpp:37
Namespace related to the LIEF's PE module.
Definition Abstract/Header.hpp:31
PE_TYPE
Definition PE/enums.hpp:22
LIEF namespace.
Definition Abstract/Binary.hpp:41
#define LIEF_API
Definition visibility.h:44
#define LIEF_LOCAL
Definition visibility.h:45