LIEF: Library to Instrument Executable Formats Version 0.17.0
Loading...
Searching...
No Matches
RelocationEntry.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_RELOCATION_ENTRY_H
17#define LIEF_PE_RELOCATION_ENTRY_H
18
19#include <ostream>
20#include <cassert>
21
23
24#include "LIEF/Object.hpp"
25#include "LIEF/visibility.h"
26#include "LIEF/PE/Header.hpp"
27
28namespace LIEF {
29namespace PE {
30
31class Relocation;
32
37
38 friend class Parser;
39 friend class Builder;
40 friend class PE::Relocation;
41
42 public:
43 static constexpr auto MAX_ADDR = 1 << 12;
44
47 enum class BASE_TYPES {
48 UNKNOWN = -1,
49
52 ABS = 0,
53
64 HIGH = 1,
65
74 LOW = 2,
75
87
96
97 MIPS_JMPADDR = 5 | (1 << 8),
98 ARM_MOV32 = 5 | (1 << 9),
99 RISCV_HI20 = 5 | (1 << 10),
100
102
103 THUMB_MOV32 = 7 | (1 << 11),
104 RISCV_LOW12I = 7 | (1 << 12),
105
106 RISCV_LOW12S = 8 | (1 << 13),
107 LOONARCH_MARK_LA = 8 | (1 << 14),
108
110
120 DIR64 = 10,
122 };
123
124 static uint16_t get_position(uint16_t data) {
125 return data & 0xFFF;
126 }
127
128 static uint16_t get_type(uint16_t data) {
129 return (data >> 12) & 0xFF;
130 }
131
133
134 RelocationEntry() = default;
136 LIEF::Relocation(other),
137 position_(other.position_),
138 type_(other.type_),
139 // Parent relocation is not forwarded during copy
140 relocation_(nullptr)
141 {}
142
144 swap(other);
145 return *this;
146 }
147
150
152 position_(position),
153 type_(type)
154 {
155 assert(position_ < MAX_ADDR);
156 }
157
158 ~RelocationEntry() override = default;
159
160 void swap(RelocationEntry& other) {
162 std::swap(position_, other.position_);
163 std::swap(type_, other.type_);
164 std::swap(relocation_, other.relocation_);
165 }
166
168 uint64_t address() const override;
169
170 void address(uint64_t address) override;
171
173 size_t size() const override;
174
175 void size(size_t size) override;
176
180 uint16_t data() const {
181 return (uint16_t((uint8_t)type_ & 0xFF) << 12) | position_;
182 }
183
185 uint16_t position() const {
186 return position_;
187 }
188
190 BASE_TYPES type() const {
191 return type_;
192 }
193
194 void position(uint16_t position) {
195 assert(position < MAX_ADDR);
196 position_ = position;
197 }
198
200 type_ = type;
201 }
202
203 void accept(Visitor& visitor) const override;
204
205 LIEF_API friend std::ostream& operator<<(std::ostream& os, const RelocationEntry& entry);
206
208 LIEF_LOCAL PE::Relocation* parent() {
209 return relocation_;
210 }
211
213 LIEF_LOCAL const PE::Relocation* parent() const {
214 return relocation_;
215 }
216
218 LIEF_LOCAL void parent(PE::Relocation& R) {
219 relocation_ = &R;
220 }
221
222 private:
223 uint16_t position_ = 0;
224 BASE_TYPES type_ = BASE_TYPES::ABS;
225 PE::Relocation* relocation_ = nullptr; // Used to compute some information
226};
227
229
230}
231}
232#endif
MACHINE_TYPES
Definition PE/Header.hpp:40
void address(uint64_t address) override
RelocationEntry & operator=(RelocationEntry other)
Definition RelocationEntry.hpp:143
void swap(RelocationEntry &other)
Definition RelocationEntry.hpp:160
size_t size() const override
The size of the relocatable pointer.
void size(size_t size) override
uint16_t position() const
Offset relative to Relocation::virtual_address where the relocation occurs.
Definition RelocationEntry.hpp:185
uint16_t data() const
Raw data of the relocation:
Definition RelocationEntry.hpp:180
RelocationEntry(uint16_t position, BASE_TYPES type)
Definition RelocationEntry.hpp:151
uint64_t address() const override
The address of the relocation.
friend std::ostream & operator<<(std::ostream &os, const RelocationEntry &entry)
friend class PE::Relocation
Definition RelocationEntry.hpp:40
void accept(Visitor &visitor) const override
Method so that the visitor can visit us.
RelocationEntry(const RelocationEntry &other)
Definition RelocationEntry.hpp:135
void position(uint16_t position)
Definition RelocationEntry.hpp:194
static BASE_TYPES type_from_data(Header::MACHINE_TYPES arch, uint16_t data)
friend class Builder
Definition RelocationEntry.hpp:39
~RelocationEntry() override=default
static uint16_t get_type(uint16_t data)
Definition RelocationEntry.hpp:128
BASE_TYPES
Relocation type as described in https://learn.microsoft.com/en-us/windows/win32/debug/pe-format#base-...
Definition RelocationEntry.hpp:47
@ LOONARCH_MARK_LA
Definition RelocationEntry.hpp:107
@ RISCV_LOW12S
Definition RelocationEntry.hpp:106
@ THUMB_MOV32
Definition RelocationEntry.hpp:103
@ SECTION
Definition RelocationEntry.hpp:101
@ LOW
The base relocation adds the low 16 bits of the difference to the 16-bit field at offset....
Definition RelocationEntry.hpp:74
@ HIGH3ADJ
Definition RelocationEntry.hpp:121
@ DIR64
This value matches IMAGE_REL_BASED_DIR64.
Definition RelocationEntry.hpp:120
@ UNKNOWN
Definition RelocationEntry.hpp:48
@ ABS
This value matches: IMAGE_REL_BASED_ABSOLUTE The base relocation is skipped. This type can be used to...
Definition RelocationEntry.hpp:52
@ RISCV_HI20
Definition RelocationEntry.hpp:99
@ ARM_MOV32
Definition RelocationEntry.hpp:98
@ RISCV_LOW12I
Definition RelocationEntry.hpp:104
@ HIGHADJ
This value matches IMAGE_REL_BASED_HIGHADJ.
Definition RelocationEntry.hpp:95
@ MIPS_JMPADDR16
Definition RelocationEntry.hpp:109
@ HIGH
This value matches: IMAGE_REL_BASED_HIGH The base relocation adds the high 16 bits of the difference...
Definition RelocationEntry.hpp:64
@ MIPS_JMPADDR
Definition RelocationEntry.hpp:97
@ HIGHLOW
This value matches IMAGE_REL_BASED_HIGHLOW.
Definition RelocationEntry.hpp:86
static uint16_t get_position(uint16_t data)
Definition RelocationEntry.hpp:124
friend class Parser
Definition RelocationEntry.hpp:38
RelocationEntry(RelocationEntry &&other)=default
static constexpr auto MAX_ADDR
Definition RelocationEntry.hpp:43
void type(BASE_TYPES type)
Definition RelocationEntry.hpp:199
BASE_TYPES type() const
Type of the relocation.
Definition RelocationEntry.hpp:190
RelocationEntry & operator=(RelocationEntry &&other)=default
Class which represents the Base Relocation Block We usually find this structure in the ....
Definition PE/Relocation.hpp:43
Class which represents an abstracted Relocation.
Definition Abstract/Relocation.hpp:27
void swap(Relocation &other)
Definition Abstract/Relocation.hpp:42
Definition Visitor.hpp:210
Namespace related to the LIEF's PE module.
Definition Abstract/Header.hpp:32
const char * to_string(CODE_PAGES e)
LIEF namespace.
Definition Abstract/Binary.hpp:40
#define LIEF_API
Definition visibility.h:41
#define LIEF_LOCAL
Definition visibility.h:42