LIEF: Library to Instrument Executable Formats Version 0.17.0
Loading...
Searching...
No Matches
DataDirectory.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_DATADIRECTORY_H
17#define LIEF_PE_DATADIRECTORY_H
18
19#include <cstdint>
20#include <ostream>
21#include <memory>
22
23#include "LIEF/Object.hpp"
24#include "LIEF/visibility.h"
25#include "LIEF/span.hpp"
26
27namespace LIEF {
28class SpanStream;
29
30namespace PE {
31
32class Builder;
33class Parser;
34class Binary;
35class Section;
36
37namespace details {
38struct pe_data_directory;
39}
40class LIEF_API DataDirectory : public Object {
43
44 friend class Builder;
45 friend class Parser;
46 friend class Binary;
47
48 public:
49 static constexpr size_t DEFAULT_NB = 16;
50
51 enum class TYPES: uint32_t {
52 EXPORT_TABLE = 0,
53 IMPORT_TABLE,
54 RESOURCE_TABLE,
55 EXCEPTION_TABLE,
56 CERTIFICATE_TABLE,
57 BASE_RELOCATION_TABLE,
58 DEBUG_DIR,
59 ARCHITECTURE,
60 GLOBAL_PTR,
61 TLS_TABLE,
62 LOAD_CONFIG_TABLE,
63 BOUND_IMPORT,
64 IAT,
65 DELAY_IMPORT_DESCRIPTOR,
66 CLR_RUNTIME_HEADER,
67 RESERVED,
68
69 UNKNOWN,
70 };
71 DataDirectory() = default;
72 DataDirectory(TYPES type) :
73 type_{type}
74 {}
75
76 DataDirectory(const details::pe_data_directory& header, TYPES type);
77
78 DataDirectory(const DataDirectory& other) = default;
79 DataDirectory& operator=(const DataDirectory& other) = default;
80
81 DataDirectory(DataDirectory&& other) noexcept = default;
82 DataDirectory& operator=(DataDirectory&& other) noexcept = default;
83
84 ~DataDirectory() override = default;
85 uint32_t RVA() const {
89 return rva_;
90 }
91 uint32_t size() const {
94 return size_;
95 }
96 bool has_section() const {
100 return section_ != nullptr;
101 }
102 span<const uint8_t> content() const {
105 return const_cast<DataDirectory*>(this)->content();
106 }
107
108 span<uint8_t> content();
109 Section* section() {
112 return section_;
113 }
114
115 const Section* section() const {
116 return section_;
117 }
118 TYPES type() const {
121 return type_;
122 }
123
124 void size(uint32_t size) {
125 size_ = size;
126 }
127
128 void RVA(uint32_t rva) {
129 rva_ = rva;
130 }
131
132 void accept(Visitor& visitor) const override;
133
134 LIEF_API friend
135 std::ostream& operator<<(std::ostream& os, const DataDirectory& entry);
136 LIEF_LOCAL
139 std::unique_ptr<SpanStream> stream(bool sized = true) const;
140
141 private:
142 uint32_t rva_ = 0;
143 uint32_t size_ = 0;
144 TYPES type_ = TYPES::UNKNOWN;
145 Section* section_ = nullptr;
146};
147
148LIEF_API const char* to_string(DataDirectory::TYPES e);
149
150}
151}
152
153#endif /* LIEF_PE_DATADIRECTORY_H */
Object.hpp
LIEF::PE::Binary
Class which represents a PE binary This is the main interface to manage and modify a PE executable.
Definition PE/Binary.hpp:56
LIEF::PE::Builder
Class that is used to rebuild a raw PE binary from a PE::Binary object.
Definition PE/Builder.hpp:45
LIEF::PE::DataDirectory
Class that represents a PE data directory entry.
Definition DataDirectory.hpp:42
LIEF::PE::DataDirectory::section
const Section * section() const
Definition DataDirectory.hpp:115
LIEF::PE::DataDirectory::content
span< uint8_t > content()
LIEF::PE::DataDirectory::DataDirectory
DataDirectory(TYPES type)
Definition DataDirectory.hpp:72
LIEF::PE::DataDirectory::RVA
uint32_t RVA() const
The relative virtual address of the content of this data directory.
Definition DataDirectory.hpp:88
LIEF::PE::DataDirectory::operator=
DataDirectory & operator=(DataDirectory &&other) noexcept=default
LIEF::PE::DataDirectory::DataDirectory
DataDirectory(const details::pe_data_directory &header, TYPES type)
LIEF::PE::DataDirectory::~DataDirectory
~DataDirectory() override=default
LIEF::PE::DataDirectory::DataDirectory
DataDirectory(DataDirectory &&other) noexcept=default
LIEF::PE::DataDirectory::has_section
bool has_section() const
Check if the content of this data directory is associated with a PE Section.
Definition DataDirectory.hpp:99
LIEF::PE::DataDirectory::accept
void accept(Visitor &visitor) const override
LIEF::PE::DataDirectory::RVA
void RVA(uint32_t rva)
Definition DataDirectory.hpp:128
LIEF::PE::DataDirectory::content
span< const uint8_t > content() const
Raw content (bytes) referenced by this data directory.
Definition DataDirectory.hpp:104
LIEF::PE::DataDirectory::DataDirectory
DataDirectory()=default
LIEF::PE::DataDirectory::size
void size(uint32_t size)
Definition DataDirectory.hpp:124
LIEF::PE::DataDirectory::DataDirectory
DataDirectory(const DataDirectory &other)=default
LIEF::PE::DataDirectory::type
TYPES type() const
Type of the data directory.
Definition DataDirectory.hpp:120
LIEF::PE::DataDirectory::TYPES
TYPES
Definition DataDirectory.hpp:51
LIEF::PE::DataDirectory::operator=
DataDirectory & operator=(const DataDirectory &other)=default
LIEF::PE::DataDirectory::operator<<
friend std::ostream & operator<<(std::ostream &os, const DataDirectory &entry)
LIEF::PE::DataDirectory::section
Section * section()
Section associated with the DataDirectory.
Definition DataDirectory.hpp:111
LIEF::PE::DataDirectory::size
uint32_t size() const
The size of the content.
Definition DataDirectory.hpp:93
LIEF::PE::Parser
Main interface to parse PE binaries. In particular the static functions: Parser::parse should be used...
Definition PE/Parser.hpp:52
LIEF::PE::Section
Class which represents a PE section.
Definition PE/Section.hpp:43
LIEF::SpanStream
Definition SpanStream.hpp:32
LIEF::PE::details
Definition DataDirectory.hpp:37
LIEF::PE
Namespace related to the LIEF's PE module.
Definition Abstract/Header.hpp:32
LIEF::PE::to_string
const char * to_string(AuxiliaryWeakExternal::CHARACTERISTICS e)
LIEF
LIEF namespace.
Definition Abstract/Binary.hpp:36
span.hpp
visibility.h
LIEF_API
#define LIEF_API
Definition visibility.h:41
LIEF_LOCAL
#define LIEF_LOCAL
Definition visibility.h:42