LIEF: Library to Instrument Executable Formats Version 2.0.0
Loading...
Searching...
No Matches
COFF/Relocation.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_COFF_RELOCATION_H
16#define LIEF_COFF_RELOCATION_H
17#include <cstdint>
18#include <memory>
19#include <ostream>
20
22#include "LIEF/COFF/Header.hpp"
23#include "LIEF/visibility.h"
24
25namespace LIEF {
26class BinaryStream;
27namespace COFF {
28class Section;
29class Parser;
30class Symbol;
31
33class LIEF_API Relocation : public LIEF::Relocation {
34 public:
35 friend class Parser;
36
37 static constexpr uint32_t I386 = 1 << 17;
38 static constexpr uint32_t X64 = 1 << 18;
39 static constexpr uint32_t ARM = 1 << 19;
40 static constexpr uint32_t ARM64 = 1 << 20;
41 static constexpr uint32_t MIPS = 1 << 21;
42
47 enum class TYPE : uint32_t {
48 UNKNOWN = uint32_t(-1),
49 I386_ABSOLUTE = I386 + 0x0000,
50 I386_DIR16 = I386 + 0x0001,
51 I386_REL16 = I386 + 0x0002,
52 I386_DIR32 = I386 + 0x0006,
53 I386_DIR32NB = I386 + 0x0007,
54 I386_SEG12 = I386 + 0x0009,
55 I386_SECTION = I386 + 0x000A,
56 I386_SECREL = I386 + 0x000B,
57 I386_TOKEN = I386 + 0x000C,
58 I386_SECREL7 = I386 + 0x000D,
59 I386_REL32 = I386 + 0x0014,
60
61 AMD64_ABSOLUTE = X64 + 0x0000,
62 AMD64_ADDR64 = X64 + 0x0001,
63 AMD64_ADDR32 = X64 + 0x0002,
64 AMD64_ADDR32NB = X64 + 0x0003,
65 AMD64_REL32 = X64 + 0x0004,
66 AMD64_REL32_1 = X64 + 0x0005,
67 AMD64_REL32_2 = X64 + 0x0006,
68 AMD64_REL32_3 = X64 + 0x0007,
69 AMD64_REL32_4 = X64 + 0x0008,
70 AMD64_REL32_5 = X64 + 0x0009,
71 AMD64_SECTION = X64 + 0x000A,
72 AMD64_SECREL = X64 + 0x000B,
73 AMD64_SECREL7 = X64 + 0x000C,
74 AMD64_TOKEN = X64 + 0x000D,
75 AMD64_SREL32 = X64 + 0x000E,
76 AMD64_PAIR = X64 + 0x000F,
77 AMD64_SSPAN32 = X64 + 0x0010,
78
79 ARM_ABSOLUTE = ARM + 0x0000,
80 ARM_ADDR32 = ARM + 0x0001,
81 ARM_ADDR32NB = ARM + 0x0002,
82 ARM_BRANCH24 = ARM + 0x0003,
83 ARM_BRANCH11 = ARM + 0x0004,
84 ARM_TOKEN = ARM + 0x0005,
85 ARM_BLX24 = ARM + 0x0008,
86 ARM_BLX11 = ARM + 0x0009,
87 ARM_REL32 = ARM + 0x000A,
88 ARM_SECTION = ARM + 0x000E,
89 ARM_SECREL = ARM + 0x000F,
90 ARM_MOV32A = ARM + 0x0010,
91 ARM_MOV32T = ARM + 0x0011,
92 ARM_BRANCH20T = ARM + 0x0012,
93 ARM_BRANCH24T = ARM + 0x0014,
94 ARM_BLX23T = ARM + 0x0015,
95 ARM_PAIR = ARM + 0x0016,
96
97 ARM64_ABSOLUTE = ARM64 + 0x0000,
98 ARM64_ADDR32 = ARM64 + 0x0001,
99 ARM64_ADDR32NB = ARM64 + 0x0002,
100 ARM64_BRANCH26 = ARM64 + 0x0003,
101 ARM64_PAGEBASE_REL21 = ARM64 + 0x0004,
102 ARM64_REL21 = ARM64 + 0x0005,
103 ARM64_PAGEOFFSET_12A = ARM64 + 0x0006,
104 ARM64_PAGEOFFSET_12L = ARM64 + 0x0007,
105 ARM64_SECREL = ARM64 + 0x0008,
106 ARM64_SECREL_LOW12A = ARM64 + 0x0009,
107 ARM64_SECREL_HIGH12A = ARM64 + 0x000A,
108 ARM64_SECREL_LOW12L = ARM64 + 0x000B,
109 ARM64_TOKEN = ARM64 + 0x000C,
110 ARM64_SECTION = ARM64 + 0x000D,
111 ARM64_ADDR64 = ARM64 + 0x000E,
112 ARM64_BRANCH19 = ARM64 + 0x000F,
113 ARM64_BRANCH14 = ARM64 + 0x0010,
114 ARM64_REL32 = ARM64 + 0x0011,
115
116 MIPS_ABSOLUTE = MIPS + 0x0000,
117 MIPS_REFHALF = MIPS + 0x0001,
118 MIPS_REFWORD = MIPS + 0x0002,
119 MIPS_JMPADDR = MIPS + 0x0003,
120 MIPS_REFHI = MIPS + 0x0004,
121 MIPS_REFLO = MIPS + 0x0005,
122 MIPS_GPREL = MIPS + 0x0006,
123 MIPS_LITERAL = MIPS + 0x0007,
124 MIPS_SECTION = MIPS + 0x000A,
125 MIPS_SECREL = MIPS + 0x000B,
126 MIPS_SECRELLO = MIPS + 0x000C,
127 MIPS_SECRELHI = MIPS + 0x000D,
128 MIPS_JMPADDR16 = MIPS + 0x0010,
129 MIPS_REFWORDNB = MIPS + 0x0022,
130 MIPS_PAIR = MIPS + 0x0025,
131 };
132
134 static uint16_t to_value(TYPE rtype) {
135 return (uint16_t)rtype;
136 }
137
139 static TYPE from_value(uint16_t value, Header::MACHINE_TYPES arch) {
140 switch (arch) {
141 case Header::MACHINE_TYPES::ARM64: return TYPE(value + ARM64);
142
143 case Header::MACHINE_TYPES::AMD64: return TYPE(value + X64);
144
145 case Header::MACHINE_TYPES::I386: return TYPE(value + I386);
146
147 case Header::MACHINE_TYPES::ARM:
148 case Header::MACHINE_TYPES::ARMNT:
149 case Header::MACHINE_TYPES::THUMB: return TYPE(value + ARM);
150
151 case Header::MACHINE_TYPES::R4000: return TYPE(value + MIPS);
152
153 default: return TYPE::UNKNOWN;
154 }
155 return TYPE::UNKNOWN;
156 }
157
159 static std::unique_ptr<Relocation> parse(BinaryStream& stream,
161
163 uint32_t symbol_idx() const {
164 return symbol_idx_;
165 }
166
169 return symbol_;
170 }
171
172 const Symbol* symbol() const {
173 return symbol_;
174 }
175
177 TYPE type() const {
178 return type_;
179 }
180
183 return section_;
184 }
185
186 const Section* section() const {
187 return section_;
188 }
189
190 std::string to_string() const;
191
192 LIEF_API friend std::ostream& operator<<(std::ostream& os, const Relocation& R) {
193 os << R.to_string();
194 return os;
195 }
196
197 ~Relocation() override = default;
198
199 private:
200 Relocation() = default;
201 uint32_t symbol_idx_ = 0;
202 TYPE type_ = TYPE::UNKNOWN;
203 Section* section_ = nullptr;
204 Symbol* symbol_ = nullptr;
205};
206
208
209}
210}
211#endif
Class that is used to a read stream of data from different sources.
Definition BinaryStream.hpp:34
LIEF::PE::Header::MACHINE_TYPES MACHINE_TYPES
The different architectures (mirrored from PE).
Definition COFF/Header.hpp:41
Definition COFF/Parser.hpp:36
static constexpr uint32_t MIPS
Definition COFF/Relocation.hpp:41
TYPE type() const
Type of the relocation.
Definition COFF/Relocation.hpp:177
Section * section()
Section in which the relocation takes place.
Definition COFF/Relocation.hpp:182
static constexpr uint32_t X64
Definition COFF/Relocation.hpp:38
~Relocation() override=default
TYPE
The different relocation types.
Definition COFF/Relocation.hpp:47
@ UNKNOWN
Definition COFF/Relocation.hpp:48
static constexpr uint32_t ARM
Definition COFF/Relocation.hpp:39
static constexpr uint32_t I386
Definition COFF/Relocation.hpp:37
static constexpr uint32_t ARM64
Definition COFF/Relocation.hpp:40
static std::unique_ptr< Relocation > parse(BinaryStream &stream, Header::MACHINE_TYPES arch)
Create a relocation from the given stream.
static TYPE from_value(uint16_t value, Header::MACHINE_TYPES arch)
Create a relocation type from its raw value and the architecture.
Definition COFF/Relocation.hpp:139
friend std::ostream & operator<<(std::ostream &os, const Relocation &R)
Definition COFF/Relocation.hpp:192
uint32_t symbol_idx() const
Symbol index associated with this relocation.
Definition COFF/Relocation.hpp:163
const Symbol * symbol() const
Definition COFF/Relocation.hpp:172
std::string to_string() const
friend class Parser
Definition COFF/Relocation.hpp:35
Symbol * symbol()
Symbol associated with the relocation (if any).
Definition COFF/Relocation.hpp:168
static uint16_t to_value(TYPE rtype)
Convert a relocation enum type into a 16-bits value.
Definition COFF/Relocation.hpp:134
const Section * section() const
Definition COFF/Relocation.hpp:186
This class represents a COFF section.
Definition COFF/Section.hpp:40
This class represents a COFF symbol.
Definition COFF/Symbol.hpp:36
Class which represents an abstracted Relocation.
Definition Abstract/Relocation.hpp:26
Definition AuxiliarySymbol.hpp:29
const char * to_string(AuxiliarySectionDefinition::COMDAT_SELECTION e)
LIEF namespace.
Definition Abstract/Binary.hpp:41
#define LIEF_API
Definition visibility.h:44