1 //===-- RelocVisitor.h - Visitor for object file relocations -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file provides a wrapper around all the different types of relocations
11 // in different file formats, such that a client can handle them in a unified
12 // manner by only implementing a minimal number of functions.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_OBJECT_RELOCVISITOR_H
17 #define LLVM_OBJECT_RELOCVISITOR_H
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/Object/ELFObjectFile.h"
21 #include "llvm/Object/ObjectFile.h"
22 #include "llvm/Support/Debug.h"
23 #include "llvm/Support/ELF.h"
24 #include "llvm/Support/raw_ostream.h"
30 // The computed value after applying the relevant relocations.
33 // The width of the value; how many bytes to touch when applying the
36 RelocToApply(const RelocToApply &In) : Value(In.Value), Width(In.Width) {}
37 RelocToApply(int64_t Value, char Width) : Value(Value), Width(Width) {}
38 RelocToApply() : Value(0), Width(0) {}
41 /// @brief Base class for object file relocation visitors.
44 explicit RelocVisitor(StringRef FileFormat)
45 : FileFormat(FileFormat), HasError(false) {}
47 // TODO: Should handle multiple applied relocations via either passing in the
48 // previously computed value or just count paired relocations as a single
50 RelocToApply visit(uint32_t RelocType, RelocationRef R, uint64_t SecAddr = 0,
52 if (FileFormat == "ELF64-x86-64") {
54 case llvm::ELF::R_X86_64_NONE:
55 return visitELF_X86_64_NONE(R);
56 case llvm::ELF::R_X86_64_64:
57 return visitELF_X86_64_64(R, Value);
58 case llvm::ELF::R_X86_64_PC32:
59 return visitELF_X86_64_PC32(R, Value, SecAddr);
60 case llvm::ELF::R_X86_64_32:
61 return visitELF_X86_64_32(R, Value);
62 case llvm::ELF::R_X86_64_32S:
63 return visitELF_X86_64_32S(R, Value);
66 return RelocToApply();
68 } else if (FileFormat == "ELF32-i386") {
70 case llvm::ELF::R_386_NONE:
71 return visitELF_386_NONE(R);
72 case llvm::ELF::R_386_32:
73 return visitELF_386_32(R, Value);
74 case llvm::ELF::R_386_PC32:
75 return visitELF_386_PC32(R, Value, SecAddr);
78 return RelocToApply();
80 } else if (FileFormat == "ELF64-ppc64") {
82 case llvm::ELF::R_PPC64_ADDR32:
83 return visitELF_PPC64_ADDR32(R, Value);
84 case llvm::ELF::R_PPC64_ADDR64:
85 return visitELF_PPC64_ADDR64(R, Value);
88 return RelocToApply();
90 } else if (FileFormat == "ELF32-ppc") {
92 case llvm::ELF::R_PPC_ADDR32:
93 return visitELF_PPC_ADDR32(R, Value);
96 return RelocToApply();
98 } else if (FileFormat == "ELF32-mips") {
100 case llvm::ELF::R_MIPS_32:
101 return visitELF_MIPS_32(R, Value);
104 return RelocToApply();
106 } else if (FileFormat == "ELF64-mips") {
108 case llvm::ELF::R_MIPS_32:
109 return visitELF_MIPS_32(R, Value);
110 case llvm::ELF::R_MIPS_64:
111 return visitELF_MIPS_64(R, Value);
114 return RelocToApply();
116 } else if (FileFormat == "ELF64-aarch64") {
118 case llvm::ELF::R_AARCH64_ABS32:
119 return visitELF_AARCH64_ABS32(R, Value);
120 case llvm::ELF::R_AARCH64_ABS64:
121 return visitELF_AARCH64_ABS64(R, Value);
124 return RelocToApply();
126 } else if (FileFormat == "ELF64-s390") {
128 case llvm::ELF::R_390_32:
129 return visitELF_390_32(R, Value);
130 case llvm::ELF::R_390_64:
131 return visitELF_390_64(R, Value);
134 return RelocToApply();
136 } else if (FileFormat == "ELF32-sparc") {
138 case llvm::ELF::R_SPARC_32:
139 case llvm::ELF::R_SPARC_UA32:
140 return visitELF_SPARC_32(R, Value);
143 return RelocToApply();
145 } else if (FileFormat == "ELF64-sparc") {
147 case llvm::ELF::R_SPARC_32:
148 case llvm::ELF::R_SPARC_UA32:
149 return visitELF_SPARCV9_32(R, Value);
150 case llvm::ELF::R_SPARC_64:
151 case llvm::ELF::R_SPARC_UA64:
152 return visitELF_SPARCV9_64(R, Value);
155 return RelocToApply();
159 return RelocToApply();
162 bool error() { return HasError; }
165 StringRef FileFormat;
168 int64_t getAddend32LE(RelocationRef R) {
169 const ELF32LEObjectFile *Obj = cast<ELF32LEObjectFile>(R.getObjectFile());
170 DataRefImpl DRI = R.getRawDataRefImpl();
172 Obj->getRelocationAddend(DRI, Addend);
176 int64_t getAddend64LE(RelocationRef R) {
177 const ELF64LEObjectFile *Obj = cast<ELF64LEObjectFile>(R.getObjectFile());
178 DataRefImpl DRI = R.getRawDataRefImpl();
180 Obj->getRelocationAddend(DRI, Addend);
184 int64_t getAddend32BE(RelocationRef R) {
185 const ELF32BEObjectFile *Obj = cast<ELF32BEObjectFile>(R.getObjectFile());
186 DataRefImpl DRI = R.getRawDataRefImpl();
188 Obj->getRelocationAddend(DRI, Addend);
192 int64_t getAddend64BE(RelocationRef R) {
193 const ELF64BEObjectFile *Obj = cast<ELF64BEObjectFile>(R.getObjectFile());
194 DataRefImpl DRI = R.getRawDataRefImpl();
196 Obj->getRelocationAddend(DRI, Addend);
202 RelocToApply visitELF_386_NONE(RelocationRef R) {
203 return RelocToApply(0, 0);
206 // Ideally the Addend here will be the addend in the data for
207 // the relocation. It's not actually the case for Rel relocations.
208 RelocToApply visitELF_386_32(RelocationRef R, uint64_t Value) {
209 int64_t Addend = getAddend32LE(R);
210 return RelocToApply(Value + Addend, 4);
213 RelocToApply visitELF_386_PC32(RelocationRef R, uint64_t Value,
215 int64_t Addend = getAddend32LE(R);
217 R.getOffset(Address);
218 return RelocToApply(Value + Addend - Address, 4);
222 RelocToApply visitELF_X86_64_NONE(RelocationRef R) {
223 return RelocToApply(0, 0);
225 RelocToApply visitELF_X86_64_64(RelocationRef R, uint64_t Value) {
226 int64_t Addend = getAddend64LE(R);
227 return RelocToApply(Value + Addend, 8);
229 RelocToApply visitELF_X86_64_PC32(RelocationRef R, uint64_t Value,
231 int64_t Addend = getAddend64LE(R);
233 R.getOffset(Address);
234 return RelocToApply(Value + Addend - Address, 4);
236 RelocToApply visitELF_X86_64_32(RelocationRef R, uint64_t Value) {
237 int64_t Addend = getAddend64LE(R);
238 uint32_t Res = (Value + Addend) & 0xFFFFFFFF;
239 return RelocToApply(Res, 4);
241 RelocToApply visitELF_X86_64_32S(RelocationRef R, uint64_t Value) {
242 int64_t Addend = getAddend64LE(R);
243 int32_t Res = (Value + Addend) & 0xFFFFFFFF;
244 return RelocToApply(Res, 4);
248 RelocToApply visitELF_PPC64_ADDR32(RelocationRef R, uint64_t Value) {
249 int64_t Addend = getAddend64BE(R);
250 uint32_t Res = (Value + Addend) & 0xFFFFFFFF;
251 return RelocToApply(Res, 4);
253 RelocToApply visitELF_PPC64_ADDR64(RelocationRef R, uint64_t Value) {
254 int64_t Addend = getAddend64BE(R);
255 return RelocToApply(Value + Addend, 8);
259 RelocToApply visitELF_PPC_ADDR32(RelocationRef R, uint64_t Value) {
260 int64_t Addend = getAddend32BE(R);
261 uint32_t Res = (Value + Addend) & 0xFFFFFFFF;
262 return RelocToApply(Res, 4);
266 RelocToApply visitELF_MIPS_32(RelocationRef R, uint64_t Value) {
268 getELFRelocationAddend(R, Addend);
269 uint32_t Res = (Value + Addend) & 0xFFFFFFFF;
270 return RelocToApply(Res, 4);
273 RelocToApply visitELF_MIPS_64(RelocationRef R, uint64_t Value) {
275 getELFRelocationAddend(R, Addend);
276 uint64_t Res = (Value + Addend);
277 return RelocToApply(Res, 8);
281 RelocToApply visitELF_AARCH64_ABS32(RelocationRef R, uint64_t Value) {
282 int64_t Addend = getAddend64LE(R);
283 int64_t Res = Value + Addend;
285 // Overflow check allows for both signed and unsigned interpretation.
286 if (Res < INT32_MIN || Res > UINT32_MAX)
289 return RelocToApply(static_cast<uint32_t>(Res), 4);
292 RelocToApply visitELF_AARCH64_ABS64(RelocationRef R, uint64_t Value) {
293 int64_t Addend = getAddend64LE(R);
294 return RelocToApply(Value + Addend, 8);
298 RelocToApply visitELF_390_32(RelocationRef R, uint64_t Value) {
299 int64_t Addend = getAddend64BE(R);
300 int64_t Res = Value + Addend;
302 // Overflow check allows for both signed and unsigned interpretation.
303 if (Res < INT32_MIN || Res > UINT32_MAX)
306 return RelocToApply(static_cast<uint32_t>(Res), 4);
309 RelocToApply visitELF_390_64(RelocationRef R, uint64_t Value) {
310 int64_t Addend = getAddend64BE(R);
311 return RelocToApply(Value + Addend, 8);
314 RelocToApply visitELF_SPARC_32(RelocationRef R, uint32_t Value) {
315 int32_t Addend = getAddend32BE(R);
316 return RelocToApply(Value + Addend, 4);
319 RelocToApply visitELF_SPARCV9_32(RelocationRef R, uint64_t Value) {
320 int32_t Addend = getAddend64BE(R);
321 return RelocToApply(Value + Addend, 4);
324 RelocToApply visitELF_SPARCV9_64(RelocationRef R, uint64_t Value) {
325 int64_t Addend = getAddend64BE(R);
326 return RelocToApply(Value + Addend, 8);