xref: /llvm-project/llvm/lib/ExecutionEngine/JITLink/ELF_riscv.cpp (revision a2c9f12dd6acf0134e6e6d6e78d7e8ae3083cf24)
1 //===------- ELF_riscv.cpp -JIT linker implementation for ELF/riscv -------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // ELF/riscv jit-link implementation.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/ExecutionEngine/JITLink/ELF_riscv.h"
14 #include "ELFLinkGraphBuilder.h"
15 #include "JITLinkGeneric.h"
16 #include "PerGraphGOTAndPLTStubsBuilder.h"
17 #include "llvm/BinaryFormat/ELF.h"
18 #include "llvm/ExecutionEngine/JITLink/JITLink.h"
19 #include "llvm/ExecutionEngine/JITLink/riscv.h"
20 #include "llvm/Object/ELF.h"
21 #include "llvm/Object/ELFObjectFile.h"
22 #include "llvm/Support/Endian.h"
23 
24 #define DEBUG_TYPE "jitlink"
25 using namespace llvm;
26 using namespace llvm::jitlink;
27 using namespace llvm::jitlink::riscv;
28 
29 namespace {
30 
31 class PerGraphGOTAndPLTStubsBuilder_ELF_riscv
32     : public PerGraphGOTAndPLTStubsBuilder<
33           PerGraphGOTAndPLTStubsBuilder_ELF_riscv> {
34 public:
35   static constexpr size_t StubEntrySize = 16;
36   static const uint8_t NullGOTEntryContent[8];
37   static const uint8_t RV64StubContent[StubEntrySize];
38   static const uint8_t RV32StubContent[StubEntrySize];
39 
40   using PerGraphGOTAndPLTStubsBuilder<
41       PerGraphGOTAndPLTStubsBuilder_ELF_riscv>::PerGraphGOTAndPLTStubsBuilder;
42 
43   bool isRV64() const { return G.getPointerSize() == 8; }
44 
45   bool isGOTEdgeToFix(Edge &E) const { return E.getKind() == R_RISCV_GOT_HI20; }
46 
47   Symbol &createGOTEntry(Symbol &Target) {
48     Block &GOTBlock =
49         G.createContentBlock(getGOTSection(), getGOTEntryBlockContent(),
50                              orc::ExecutorAddr(), G.getPointerSize(), 0);
51     GOTBlock.addEdge(isRV64() ? R_RISCV_64 : R_RISCV_32, 0, Target, 0);
52     return G.addAnonymousSymbol(GOTBlock, 0, G.getPointerSize(), false, false);
53   }
54 
55   Symbol &createPLTStub(Symbol &Target) {
56     Block &StubContentBlock = G.createContentBlock(
57         getStubsSection(), getStubBlockContent(), orc::ExecutorAddr(), 4, 0);
58     auto &GOTEntrySymbol = getGOTEntry(Target);
59     StubContentBlock.addEdge(R_RISCV_CALL, 0, GOTEntrySymbol, 0);
60     return G.addAnonymousSymbol(StubContentBlock, 0, StubEntrySize, true,
61                                 false);
62   }
63 
64   void fixGOTEdge(Edge &E, Symbol &GOTEntry) {
65     // Replace the relocation pair (R_RISCV_GOT_HI20, R_RISCV_PCREL_LO12)
66     // with (R_RISCV_PCREL_HI20, R_RISCV_PCREL_LO12)
67     // Therefore, here just change the R_RISCV_GOT_HI20 to R_RISCV_PCREL_HI20
68     E.setKind(R_RISCV_PCREL_HI20);
69     E.setTarget(GOTEntry);
70   }
71 
72   void fixPLTEdge(Edge &E, Symbol &PLTStubs) {
73     assert(E.getKind() == R_RISCV_CALL_PLT && "Not a R_RISCV_CALL_PLT edge?");
74     E.setKind(R_RISCV_CALL);
75     E.setTarget(PLTStubs);
76   }
77 
78   bool isExternalBranchEdge(Edge &E) const {
79     return E.getKind() == R_RISCV_CALL_PLT;
80   }
81 
82 private:
83   Section &getGOTSection() const {
84     if (!GOTSection)
85       GOTSection = &G.createSection("$__GOT", orc::MemProt::Read);
86     return *GOTSection;
87   }
88 
89   Section &getStubsSection() const {
90     if (!StubsSection)
91       StubsSection =
92           &G.createSection("$__STUBS", orc::MemProt::Read | orc::MemProt::Exec);
93     return *StubsSection;
94   }
95 
96   ArrayRef<char> getGOTEntryBlockContent() {
97     return {reinterpret_cast<const char *>(NullGOTEntryContent),
98             G.getPointerSize()};
99   }
100 
101   ArrayRef<char> getStubBlockContent() {
102     auto StubContent = isRV64() ? RV64StubContent : RV32StubContent;
103     return {reinterpret_cast<const char *>(StubContent), StubEntrySize};
104   }
105 
106   mutable Section *GOTSection = nullptr;
107   mutable Section *StubsSection = nullptr;
108 };
109 
110 const uint8_t PerGraphGOTAndPLTStubsBuilder_ELF_riscv::NullGOTEntryContent[8] =
111     {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
112 
113 const uint8_t
114     PerGraphGOTAndPLTStubsBuilder_ELF_riscv::RV64StubContent[StubEntrySize] = {
115         0x17, 0x0e, 0x00, 0x00,  // auipc t3, literal
116         0x03, 0x3e, 0x0e, 0x00,  // ld    t3, literal(t3)
117         0x67, 0x00, 0x0e, 0x00,  // jr    t3
118         0x13, 0x00, 0x00, 0x00}; // nop
119 
120 const uint8_t
121     PerGraphGOTAndPLTStubsBuilder_ELF_riscv::RV32StubContent[StubEntrySize] = {
122         0x17, 0x0e, 0x00, 0x00,  // auipc t3, literal
123         0x03, 0x2e, 0x0e, 0x00,  // lw    t3, literal(t3)
124         0x67, 0x00, 0x0e, 0x00,  // jr    t3
125         0x13, 0x00, 0x00, 0x00}; // nop
126 } // namespace
127 namespace llvm {
128 namespace jitlink {
129 
130 static Expected<const Edge &> getRISCVPCRelHi20(const Edge &E) {
131   using namespace riscv;
132   assert((E.getKind() == R_RISCV_PCREL_LO12_I ||
133           E.getKind() == R_RISCV_PCREL_LO12_S) &&
134          "Can only have high relocation for R_RISCV_PCREL_LO12_I or "
135          "R_RISCV_PCREL_LO12_S");
136 
137   const Symbol &Sym = E.getTarget();
138   const Block &B = Sym.getBlock();
139   orc::ExecutorAddrDiff Offset = Sym.getOffset();
140 
141   struct Comp {
142     bool operator()(const Edge &Lhs, orc::ExecutorAddrDiff Offset) {
143       return Lhs.getOffset() < Offset;
144     }
145     bool operator()(orc::ExecutorAddrDiff Offset, const Edge &Rhs) {
146       return Offset < Rhs.getOffset();
147     }
148   };
149 
150   auto Bound =
151       std::equal_range(B.edges().begin(), B.edges().end(), Offset, Comp{});
152 
153   for (auto It = Bound.first; It != Bound.second; ++It) {
154     if (It->getKind() == R_RISCV_PCREL_HI20)
155       return *It;
156   }
157 
158   return make_error<JITLinkError>(
159       "No HI20 PCREL relocation type be found for LO12 PCREL relocation type");
160 }
161 
162 static uint32_t extractBits(uint32_t Num, unsigned Low, unsigned Size) {
163   return (Num & (((1ULL << Size) - 1) << Low)) >> Low;
164 }
165 
166 static inline bool isAlignmentCorrect(uint64_t Value, int N) {
167   return (Value & (N - 1)) ? false : true;
168 }
169 
170 // Requires 0 < N <= 64.
171 static inline bool isInRangeForImm(int64_t Value, int N) {
172   return Value == llvm::SignExtend64(Value, N);
173 }
174 
175 class ELFJITLinker_riscv : public JITLinker<ELFJITLinker_riscv> {
176   friend class JITLinker<ELFJITLinker_riscv>;
177 
178 public:
179   ELFJITLinker_riscv(std::unique_ptr<JITLinkContext> Ctx,
180                      std::unique_ptr<LinkGraph> G, PassConfiguration PassConfig)
181       : JITLinker(std::move(Ctx), std::move(G), std::move(PassConfig)) {}
182 
183 private:
184   Error applyFixup(LinkGraph &G, Block &B, const Edge &E) const {
185     using namespace riscv;
186     using namespace llvm::support;
187 
188     char *BlockWorkingMem = B.getAlreadyMutableContent().data();
189     char *FixupPtr = BlockWorkingMem + E.getOffset();
190     orc::ExecutorAddr FixupAddress = B.getAddress() + E.getOffset();
191     switch (E.getKind()) {
192     case R_RISCV_32: {
193       int64_t Value = (E.getTarget().getAddress() + E.getAddend()).getValue();
194       *(little32_t *)FixupPtr = static_cast<uint32_t>(Value);
195       break;
196     }
197     case R_RISCV_64: {
198       int64_t Value = (E.getTarget().getAddress() + E.getAddend()).getValue();
199       *(little64_t *)FixupPtr = static_cast<uint64_t>(Value);
200       break;
201     }
202     case R_RISCV_BRANCH: {
203       int64_t Value = E.getTarget().getAddress() + E.getAddend() - FixupAddress;
204       if (LLVM_UNLIKELY(!isInRangeForImm(Value >> 1, 12)))
205         return makeTargetOutOfRangeError(G, B, E);
206       if (LLVM_UNLIKELY(!isAlignmentCorrect(Value, 2)))
207         return makeAlignmentError(FixupAddress, Value, 2, E);
208       uint32_t Imm31_25 =
209           extractBits(Value, 5, 6) << 25 | extractBits(Value, 12, 1) << 31;
210       uint32_t Imm11_7 =
211           extractBits(Value, 1, 4) << 8 | extractBits(Value, 11, 1) << 7;
212       uint32_t RawInstr = *(little32_t *)FixupPtr;
213       *(little32_t *)FixupPtr = (RawInstr & 0x1FFF07F) | Imm31_25 | Imm11_7;
214       break;
215     }
216     case R_RISCV_JAL: {
217       int64_t Value = E.getTarget().getAddress() + E.getAddend() - FixupAddress;
218       if (LLVM_UNLIKELY(!isInRangeForImm(Value >> 1, 20)))
219         return makeTargetOutOfRangeError(G, B, E);
220       if (LLVM_UNLIKELY(!isAlignmentCorrect(Value, 2)))
221         return makeAlignmentError(FixupAddress, Value, 2, E);
222       uint32_t Imm20 = extractBits(Value, 20, 1) << 31;
223       uint32_t Imm10_1 = extractBits(Value, 1, 10) << 21;
224       uint32_t Imm11 = extractBits(Value, 11, 1) << 20;
225       uint32_t Imm19_12 = extractBits(Value, 12, 8) << 12;
226       uint32_t RawInstr = *(little32_t *)FixupPtr;
227       *(little32_t *)FixupPtr = RawInstr | Imm20 | Imm10_1 | Imm11 | Imm19_12;
228       break;
229     }
230     case R_RISCV_HI20: {
231       int64_t Value = (E.getTarget().getAddress() + E.getAddend()).getValue();
232       int64_t Hi = Value + 0x800;
233       if (LLVM_UNLIKELY(!isInRangeForImm(Hi, 32)))
234         return makeTargetOutOfRangeError(G, B, E);
235       uint32_t RawInstr = *(little32_t *)FixupPtr;
236       *(little32_t *)FixupPtr =
237           (RawInstr & 0xFFF) | (static_cast<uint32_t>(Hi & 0xFFFFF000));
238       break;
239     }
240     case R_RISCV_LO12_I: {
241       // FIXME: We assume that R_RISCV_HI20 is present in object code and pairs
242       // with current relocation R_RISCV_LO12_I. So here may need a check.
243       int64_t Value = (E.getTarget().getAddress() + E.getAddend()).getValue();
244       int32_t Lo = Value & 0xFFF;
245       uint32_t RawInstr = *(little32_t *)FixupPtr;
246       *(little32_t *)FixupPtr =
247           (RawInstr & 0xFFFFF) | (static_cast<uint32_t>(Lo & 0xFFF) << 20);
248       break;
249     }
250     case R_RISCV_LO12_S: {
251       // FIXME: We assume that R_RISCV_HI20 is present in object code and pairs
252       // with current relocation R_RISCV_LO12_S. So here may need a check.
253       int64_t Value = (E.getTarget().getAddress() + E.getAddend()).getValue();
254       int64_t Lo = Value & 0xFFF;
255       uint32_t Imm31_25 = extractBits(Lo, 5, 7) << 25;
256       uint32_t Imm11_7 = extractBits(Lo, 0, 5) << 7;
257       uint32_t RawInstr = *(little32_t *)FixupPtr;
258       *(little32_t *)FixupPtr = (RawInstr & 0x1FFF07F) | Imm31_25 | Imm11_7;
259       break;
260     }
261     case R_RISCV_CALL: {
262       int64_t Value = E.getTarget().getAddress() + E.getAddend() - FixupAddress;
263       int64_t Hi = Value + 0x800;
264       if (LLVM_UNLIKELY(!isInRangeForImm(Hi, 32)))
265         return makeTargetOutOfRangeError(G, B, E);
266       int32_t Lo = Value & 0xFFF;
267       uint32_t RawInstrAuipc = *(little32_t *)FixupPtr;
268       uint32_t RawInstrJalr = *(little32_t *)(FixupPtr + 4);
269       *(little32_t *)FixupPtr =
270           RawInstrAuipc | (static_cast<uint32_t>(Hi & 0xFFFFF000));
271       *(little32_t *)(FixupPtr + 4) =
272           RawInstrJalr | (static_cast<uint32_t>(Lo) << 20);
273       break;
274     }
275     case R_RISCV_PCREL_HI20: {
276       int64_t Value = E.getTarget().getAddress() + E.getAddend() - FixupAddress;
277       int64_t Hi = Value + 0x800;
278       if (LLVM_UNLIKELY(!isInRangeForImm(Hi, 32)))
279         return makeTargetOutOfRangeError(G, B, E);
280       uint32_t RawInstr = *(little32_t *)FixupPtr;
281       *(little32_t *)FixupPtr =
282           (RawInstr & 0xFFF) | (static_cast<uint32_t>(Hi & 0xFFFFF000));
283       break;
284     }
285     case R_RISCV_PCREL_LO12_I: {
286       // FIXME: We assume that R_RISCV_PCREL_HI20 is present in object code and
287       // pairs with current relocation R_RISCV_PCREL_LO12_I. So here may need a
288       // check.
289       auto RelHI20 = getRISCVPCRelHi20(E);
290       if (!RelHI20)
291         return RelHI20.takeError();
292       int64_t Value = RelHI20->getTarget().getAddress() +
293                       RelHI20->getAddend() - E.getTarget().getAddress();
294       int64_t Lo = Value & 0xFFF;
295       uint32_t RawInstr = *(little32_t *)FixupPtr;
296       *(little32_t *)FixupPtr =
297           (RawInstr & 0xFFFFF) | (static_cast<uint32_t>(Lo & 0xFFF) << 20);
298       break;
299     }
300     case R_RISCV_PCREL_LO12_S: {
301       // FIXME: We assume that R_RISCV_PCREL_HI20 is present in object code and
302       // pairs with current relocation R_RISCV_PCREL_LO12_S. So here may need a
303       // check.
304       auto RelHI20 = getRISCVPCRelHi20(E);
305       if (!RelHI20)
306         return RelHI20.takeError();
307       int64_t Value = RelHI20->getTarget().getAddress() +
308                       RelHI20->getAddend() - E.getTarget().getAddress();
309       int64_t Lo = Value & 0xFFF;
310       uint32_t Imm31_25 = extractBits(Lo, 5, 7) << 25;
311       uint32_t Imm11_7 = extractBits(Lo, 0, 5) << 7;
312       uint32_t RawInstr = *(little32_t *)FixupPtr;
313 
314       *(little32_t *)FixupPtr = (RawInstr & 0x1FFF07F) | Imm31_25 | Imm11_7;
315       break;
316     }
317     case R_RISCV_ADD64: {
318       int64_t Value = (E.getTarget().getAddress() +
319                        support::endian::read64le(reinterpret_cast<const void *>(
320                            FixupAddress.getValue())) +
321                        E.getAddend())
322                           .getValue();
323       *(little64_t *)FixupPtr = static_cast<uint64_t>(Value);
324       break;
325     }
326     case R_RISCV_ADD32: {
327       int64_t Value = (E.getTarget().getAddress() +
328                        support::endian::read32le(reinterpret_cast<const void *>(
329                            FixupAddress.getValue())) +
330                        E.getAddend())
331                           .getValue();
332       *(little32_t *)FixupPtr = static_cast<uint32_t>(Value);
333       break;
334     }
335     case R_RISCV_ADD16: {
336       int64_t Value = (E.getTarget().getAddress() +
337                        support::endian::read16le(reinterpret_cast<const void *>(
338                            FixupAddress.getValue())) +
339                        E.getAddend())
340                           .getValue();
341       *(little16_t *)FixupPtr = static_cast<uint32_t>(Value);
342       break;
343     }
344     case R_RISCV_ADD8: {
345       int64_t Value =
346           (E.getTarget().getAddress() +
347            *(reinterpret_cast<const uint8_t *>(FixupAddress.getValue())) +
348            E.getAddend())
349               .getValue();
350       *FixupPtr = static_cast<uint8_t>(Value);
351       break;
352     }
353     case R_RISCV_SUB64: {
354       int64_t Value = support::endian::read64le(reinterpret_cast<const void *>(
355                           FixupAddress.getValue())) -
356                       E.getTarget().getAddress().getValue() - E.getAddend();
357       *(little64_t *)FixupPtr = static_cast<uint64_t>(Value);
358       break;
359     }
360     case R_RISCV_SUB32: {
361       int64_t Value = support::endian::read32le(reinterpret_cast<const void *>(
362                           FixupAddress.getValue())) -
363                       E.getTarget().getAddress().getValue() - E.getAddend();
364       *(little32_t *)FixupPtr = static_cast<uint32_t>(Value);
365       break;
366     }
367     case R_RISCV_SUB16: {
368       int64_t Value = support::endian::read16le(reinterpret_cast<const void *>(
369                           FixupAddress.getValue())) -
370                       E.getTarget().getAddress().getValue() - E.getAddend();
371       *(little16_t *)FixupPtr = static_cast<uint32_t>(Value);
372       break;
373     }
374     case R_RISCV_SUB8: {
375       int64_t Value =
376           *(reinterpret_cast<const uint8_t *>(FixupAddress.getValue())) -
377           E.getTarget().getAddress().getValue() - E.getAddend();
378       *FixupPtr = static_cast<uint8_t>(Value);
379       break;
380     }
381     case R_RISCV_SUB6: {
382       int64_t Value =
383           *(reinterpret_cast<const uint8_t *>(FixupAddress.getValue())) & 0x3f;
384       Value -= E.getTarget().getAddress().getValue() - E.getAddend();
385       *FixupPtr = (*FixupPtr & 0xc0) | (static_cast<uint8_t>(Value) & 0x3f);
386       break;
387     }
388     case R_RISCV_SET6: {
389       int64_t Value = (E.getTarget().getAddress() + E.getAddend()).getValue();
390       uint32_t RawData = *(little32_t *)FixupPtr;
391       int64_t Word6 = Value & 0x3f;
392       *(little32_t *)FixupPtr = (RawData & 0xffffffc0) | Word6;
393       break;
394     }
395     case R_RISCV_SET8: {
396       int64_t Value = (E.getTarget().getAddress() + E.getAddend()).getValue();
397       uint32_t RawData = *(little32_t *)FixupPtr;
398       int64_t Word8 = Value & 0xff;
399       *(little32_t *)FixupPtr = (RawData & 0xffffff00) | Word8;
400       break;
401     }
402     case R_RISCV_SET16: {
403       int64_t Value = (E.getTarget().getAddress() + E.getAddend()).getValue();
404       uint32_t RawData = *(little32_t *)FixupPtr;
405       int64_t Word16 = Value & 0xffff;
406       *(little32_t *)FixupPtr = (RawData & 0xffff0000) | Word16;
407       break;
408     }
409     case R_RISCV_SET32: {
410       int64_t Value = (E.getTarget().getAddress() + E.getAddend()).getValue();
411       int64_t Word32 = Value & 0xffffffff;
412       *(little32_t *)FixupPtr = Word32;
413       break;
414     }
415     case R_RISCV_32_PCREL: {
416       int64_t Value = E.getTarget().getAddress() + E.getAddend() - FixupAddress;
417       int64_t Word32 = Value & 0xffffffff;
418       *(little32_t *)FixupPtr = Word32;
419       break;
420     }
421     }
422     return Error::success();
423   }
424 };
425 
426 template <typename ELFT>
427 class ELFLinkGraphBuilder_riscv : public ELFLinkGraphBuilder<ELFT> {
428 private:
429   static Expected<riscv::EdgeKind_riscv>
430   getRelocationKind(const uint32_t Type) {
431     using namespace riscv;
432     switch (Type) {
433     case ELF::R_RISCV_32:
434       return EdgeKind_riscv::R_RISCV_32;
435     case ELF::R_RISCV_64:
436       return EdgeKind_riscv::R_RISCV_64;
437     case ELF::R_RISCV_BRANCH:
438       return EdgeKind_riscv::R_RISCV_BRANCH;
439     case ELF::R_RISCV_JAL:
440       return EdgeKind_riscv::R_RISCV_JAL;
441     case ELF::R_RISCV_HI20:
442       return EdgeKind_riscv::R_RISCV_HI20;
443     case ELF::R_RISCV_LO12_I:
444       return EdgeKind_riscv::R_RISCV_LO12_I;
445     case ELF::R_RISCV_LO12_S:
446       return EdgeKind_riscv::R_RISCV_LO12_S;
447     case ELF::R_RISCV_CALL:
448       return EdgeKind_riscv::R_RISCV_CALL;
449     case ELF::R_RISCV_PCREL_HI20:
450       return EdgeKind_riscv::R_RISCV_PCREL_HI20;
451     case ELF::R_RISCV_PCREL_LO12_I:
452       return EdgeKind_riscv::R_RISCV_PCREL_LO12_I;
453     case ELF::R_RISCV_PCREL_LO12_S:
454       return EdgeKind_riscv::R_RISCV_PCREL_LO12_S;
455     case ELF::R_RISCV_GOT_HI20:
456       return EdgeKind_riscv::R_RISCV_GOT_HI20;
457     case ELF::R_RISCV_CALL_PLT:
458       return EdgeKind_riscv::R_RISCV_CALL_PLT;
459     case ELF::R_RISCV_ADD64:
460       return EdgeKind_riscv::R_RISCV_ADD64;
461     case ELF::R_RISCV_ADD32:
462       return EdgeKind_riscv::R_RISCV_ADD32;
463     case ELF::R_RISCV_ADD16:
464       return EdgeKind_riscv::R_RISCV_ADD16;
465     case ELF::R_RISCV_ADD8:
466       return EdgeKind_riscv::R_RISCV_ADD8;
467     case ELF::R_RISCV_SUB64:
468       return EdgeKind_riscv::R_RISCV_SUB64;
469     case ELF::R_RISCV_SUB32:
470       return EdgeKind_riscv::R_RISCV_SUB32;
471     case ELF::R_RISCV_SUB16:
472       return EdgeKind_riscv::R_RISCV_SUB16;
473     case ELF::R_RISCV_SUB8:
474       return EdgeKind_riscv::R_RISCV_SUB8;
475     case ELF::R_RISCV_SUB6:
476       return EdgeKind_riscv::R_RISCV_SUB6;
477     case ELF::R_RISCV_SET6:
478       return EdgeKind_riscv::R_RISCV_SET6;
479     case ELF::R_RISCV_SET8:
480       return EdgeKind_riscv::R_RISCV_SET8;
481     case ELF::R_RISCV_SET16:
482       return EdgeKind_riscv::R_RISCV_SET16;
483     case ELF::R_RISCV_SET32:
484       return EdgeKind_riscv::R_RISCV_SET32;
485     case ELF::R_RISCV_32_PCREL:
486       return EdgeKind_riscv::R_RISCV_32_PCREL;
487     }
488 
489     return make_error<JITLinkError>(
490         "Unsupported riscv relocation:" + formatv("{0:d}: ", Type) +
491         object::getELFRelocationTypeName(ELF::EM_RISCV, Type));
492   }
493 
494   Error addRelocations() override {
495     LLVM_DEBUG(dbgs() << "Processing relocations:\n");
496 
497     using Base = ELFLinkGraphBuilder<ELFT>;
498     using Self = ELFLinkGraphBuilder_riscv<ELFT>;
499     for (const auto &RelSect : Base::Sections)
500       if (Error Err = Base::forEachRelaRelocation(RelSect, this,
501                                                   &Self::addSingleRelocation))
502         return Err;
503 
504     return Error::success();
505   }
506 
507   Error addSingleRelocation(const typename ELFT::Rela &Rel,
508                             const typename ELFT::Shdr &FixupSect,
509                             Block &BlockToFix) {
510     using Base = ELFLinkGraphBuilder<ELFT>;
511 
512     uint32_t Type = Rel.getType(false);
513     // We do not implement linker relaxation, except what is required for
514     // alignment (see below).
515     if (Type == llvm::ELF::R_RISCV_RELAX)
516       return Error::success();
517 
518     int64_t Addend = Rel.r_addend;
519     if (Type == llvm::ELF::R_RISCV_ALIGN) {
520       uint64_t Alignment = PowerOf2Ceil(Addend);
521       // FIXME: Implement support for ensuring alignment together with linker
522       // relaxation; 2 bytes are guaranteed by the length of compressed
523       // instructions, so this does not need any action from our side.
524       if (Alignment > 2)
525         return make_error<JITLinkError>(
526             formatv("Unsupported relocation R_RISCV_ALIGN with alignment {0} "
527                     "larger than 2 (addend: {1})",
528                     Alignment, Addend));
529       return Error::success();
530     }
531 
532     Expected<riscv::EdgeKind_riscv> Kind = getRelocationKind(Type);
533     if (!Kind)
534       return Kind.takeError();
535 
536     uint32_t SymbolIndex = Rel.getSymbol(false);
537     auto ObjSymbol = Base::Obj.getRelocationSymbol(Rel, Base::SymTabSec);
538     if (!ObjSymbol)
539       return ObjSymbol.takeError();
540 
541     Symbol *GraphSymbol = Base::getGraphSymbol(SymbolIndex);
542     if (!GraphSymbol)
543       return make_error<StringError>(
544           formatv("Could not find symbol at given index, did you add it to "
545                   "JITSymbolTable? index: {0}, shndx: {1} Size of table: {2}",
546                   SymbolIndex, (*ObjSymbol)->st_shndx,
547                   Base::GraphSymbols.size()),
548           inconvertibleErrorCode());
549 
550     auto FixupAddress = orc::ExecutorAddr(FixupSect.sh_addr) + Rel.r_offset;
551     Edge::OffsetT Offset = FixupAddress - BlockToFix.getAddress();
552     Edge GE(*Kind, Offset, *GraphSymbol, Addend);
553     LLVM_DEBUG({
554       dbgs() << "    ";
555       printEdge(dbgs(), BlockToFix, GE, riscv::getEdgeKindName(*Kind));
556       dbgs() << "\n";
557     });
558 
559     BlockToFix.addEdge(std::move(GE));
560     return Error::success();
561   }
562 
563 public:
564   ELFLinkGraphBuilder_riscv(StringRef FileName,
565                             const object::ELFFile<ELFT> &Obj, const Triple T)
566       : ELFLinkGraphBuilder<ELFT>(Obj, std::move(T), FileName,
567                                   riscv::getEdgeKindName) {}
568 };
569 
570 Expected<std::unique_ptr<LinkGraph>>
571 createLinkGraphFromELFObject_riscv(MemoryBufferRef ObjectBuffer) {
572   LLVM_DEBUG({
573     dbgs() << "Building jitlink graph for new input "
574            << ObjectBuffer.getBufferIdentifier() << "...\n";
575   });
576 
577   auto ELFObj = object::ObjectFile::createELFObjectFile(ObjectBuffer);
578   if (!ELFObj)
579     return ELFObj.takeError();
580 
581   if ((*ELFObj)->getArch() == Triple::riscv64) {
582     auto &ELFObjFile = cast<object::ELFObjectFile<object::ELF64LE>>(**ELFObj);
583     return ELFLinkGraphBuilder_riscv<object::ELF64LE>(
584                (*ELFObj)->getFileName(), ELFObjFile.getELFFile(),
585                (*ELFObj)->makeTriple())
586         .buildGraph();
587   } else {
588     assert((*ELFObj)->getArch() == Triple::riscv32 &&
589            "Invalid triple for RISCV ELF object file");
590     auto &ELFObjFile = cast<object::ELFObjectFile<object::ELF32LE>>(**ELFObj);
591     return ELFLinkGraphBuilder_riscv<object::ELF32LE>(
592                (*ELFObj)->getFileName(), ELFObjFile.getELFFile(),
593                (*ELFObj)->makeTriple())
594         .buildGraph();
595   }
596 }
597 
598 void link_ELF_riscv(std::unique_ptr<LinkGraph> G,
599                     std::unique_ptr<JITLinkContext> Ctx) {
600   PassConfiguration Config;
601   const Triple &TT = G->getTargetTriple();
602   if (Ctx->shouldAddDefaultTargetPasses(TT)) {
603     if (auto MarkLive = Ctx->getMarkLivePass(TT))
604       Config.PrePrunePasses.push_back(std::move(MarkLive));
605     else
606       Config.PrePrunePasses.push_back(markAllSymbolsLive);
607     Config.PostPrunePasses.push_back(
608         PerGraphGOTAndPLTStubsBuilder_ELF_riscv::asPass);
609   }
610   if (auto Err = Ctx->modifyPassConfig(*G, Config))
611     return Ctx->notifyFailed(std::move(Err));
612 
613   ELFJITLinker_riscv::link(std::move(Ctx), std::move(G), std::move(Config));
614 }
615 
616 } // namespace jitlink
617 } // namespace llvm
618