xref: /llvm-project-15.0.7/lld/ELF/Thunks.cpp (revision f4bf4227)
1 //===- Thunks.cpp --------------------------------------------------------===//
2 //
3 //                             The LLVM Linker
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===---------------------------------------------------------------------===//
9 //
10 // This file contains Thunk subclasses.
11 //
12 // A thunk is a small piece of code written after an input section
13 // which is used to jump between "incompatible" functions
14 // such as MIPS PIC and non-PIC or ARM non-Thumb and Thumb functions.
15 //
16 // If a jump target is too far and its address doesn't fit to a
17 // short jump instruction, we need to create a thunk too, but we
18 // haven't supported it yet.
19 //
20 // i386 and x86-64 don't need thunks.
21 //
22 //===---------------------------------------------------------------------===//
23 
24 #include "Thunks.h"
25 #include "Config.h"
26 #include "InputSection.h"
27 #include "Memory.h"
28 #include "OutputSections.h"
29 #include "Symbols.h"
30 #include "SyntheticSections.h"
31 #include "Target.h"
32 #include "lld/Common/ErrorHandler.h"
33 #include "llvm/BinaryFormat/ELF.h"
34 #include "llvm/Support/Casting.h"
35 #include "llvm/Support/Endian.h"
36 #include "llvm/Support/ErrorHandling.h"
37 #include "llvm/Support/MathExtras.h"
38 #include <cstdint>
39 #include <cstring>
40 
41 using namespace llvm;
42 using namespace llvm::object;
43 using namespace llvm::support::endian;
44 using namespace llvm::ELF;
45 
46 namespace lld {
47 namespace elf {
48 
49 namespace {
50 
51 // Specific ARM Thunk implementations. The naming convention is:
52 // Source State, TargetState, Target Requirement, ABS or PI, Range
53 class ARMV7ABSLongThunk final : public Thunk {
54 public:
55   ARMV7ABSLongThunk(Symbol &Dest) : Thunk(Dest) {}
56 
57   uint32_t size() const override { return 12; }
58   void writeTo(uint8_t *Buf, ThunkSection &IS) const override;
59   void addSymbols(ThunkSection &IS) override;
60   bool isCompatibleWith(RelType Type) const override;
61 };
62 
63 class ARMV7PILongThunk final : public Thunk {
64 public:
65   ARMV7PILongThunk(Symbol &Dest) : Thunk(Dest) {}
66 
67   uint32_t size() const override { return 16; }
68   void writeTo(uint8_t *Buf, ThunkSection &IS) const override;
69   void addSymbols(ThunkSection &IS) override;
70   bool isCompatibleWith(RelType Type) const override;
71 };
72 
73 class ThumbV7ABSLongThunk final : public Thunk {
74 public:
75   ThumbV7ABSLongThunk(Symbol &Dest) : Thunk(Dest) { Alignment = 2; }
76 
77   uint32_t size() const override { return 10; }
78   void writeTo(uint8_t *Buf, ThunkSection &IS) const override;
79   void addSymbols(ThunkSection &IS) override;
80   bool isCompatibleWith(RelType Type) const override;
81 };
82 
83 class ThumbV7PILongThunk final : public Thunk {
84 public:
85   ThumbV7PILongThunk(Symbol &Dest) : Thunk(Dest) { Alignment = 2; }
86 
87   uint32_t size() const override { return 12; }
88   void writeTo(uint8_t *Buf, ThunkSection &IS) const override;
89   void addSymbols(ThunkSection &IS) override;
90   bool isCompatibleWith(RelType Type) const override;
91 };
92 
93 // MIPS LA25 thunk
94 class MipsThunk final : public Thunk {
95 public:
96   MipsThunk(Symbol &Dest) : Thunk(Dest) {}
97 
98   uint32_t size() const override { return 16; }
99   void writeTo(uint8_t *Buf, ThunkSection &IS) const override;
100   void addSymbols(ThunkSection &IS) override;
101   InputSection *getTargetInputSection() const override;
102 };
103 
104 // microMIPS R2-R5 LA25 thunk
105 class MicroMipsThunk final : public Thunk {
106 public:
107   MicroMipsThunk(Symbol &Dest) : Thunk(Dest) {}
108 
109   uint32_t size() const override { return 14; }
110   void writeTo(uint8_t *Buf, ThunkSection &IS) const override;
111   void addSymbols(ThunkSection &IS) override;
112   InputSection *getTargetInputSection() const override;
113 };
114 
115 // microMIPS R6 LA25 thunk
116 class MicroMipsR6Thunk final : public Thunk {
117 public:
118   MicroMipsR6Thunk(Symbol &Dest) : Thunk(Dest) {}
119 
120   uint32_t size() const override { return 12; }
121   void writeTo(uint8_t *Buf, ThunkSection &IS) const override;
122   void addSymbols(ThunkSection &IS) override;
123   InputSection *getTargetInputSection() const override;
124 };
125 
126 } // end anonymous namespace
127 
128 // ARM Target Thunks
129 static uint64_t getARMThunkDestVA(const Symbol &S) {
130   uint64_t V = S.isInPlt() ? S.getPltVA() : S.getVA();
131   return SignExtend64<32>(V);
132 }
133 
134 void ARMV7ABSLongThunk::writeTo(uint8_t *Buf, ThunkSection &IS) const {
135   const uint8_t Data[] = {
136       0x00, 0xc0, 0x00, 0xe3, // movw         ip,:lower16:S
137       0x00, 0xc0, 0x40, 0xe3, // movt         ip,:upper16:S
138       0x1c, 0xff, 0x2f, 0xe1, // bx   ip
139   };
140   uint64_t S = getARMThunkDestVA(Destination);
141   memcpy(Buf, Data, sizeof(Data));
142   Target->relocateOne(Buf, R_ARM_MOVW_ABS_NC, S);
143   Target->relocateOne(Buf + 4, R_ARM_MOVT_ABS, S);
144 }
145 
146 void ARMV7ABSLongThunk::addSymbols(ThunkSection &IS) {
147   ThunkSym = addSyntheticLocal(
148       Saver.save("__ARMv7ABSLongThunk_" + Destination.getName()), STT_FUNC,
149       Offset, size(), &IS);
150   addSyntheticLocal("$a", STT_NOTYPE, Offset, 0, &IS);
151 }
152 
153 bool ARMV7ABSLongThunk::isCompatibleWith(RelType Type) const {
154   // Thumb branch relocations can't use BLX
155   return Type != R_ARM_THM_JUMP19 && Type != R_ARM_THM_JUMP24;
156 }
157 
158 void ThumbV7ABSLongThunk::writeTo(uint8_t *Buf, ThunkSection &IS) const {
159   const uint8_t Data[] = {
160       0x40, 0xf2, 0x00, 0x0c, // movw         ip, :lower16:S
161       0xc0, 0xf2, 0x00, 0x0c, // movt         ip, :upper16:S
162       0x60, 0x47,             // bx   ip
163   };
164   uint64_t S = getARMThunkDestVA(Destination);
165   memcpy(Buf, Data, sizeof(Data));
166   Target->relocateOne(Buf, R_ARM_THM_MOVW_ABS_NC, S);
167   Target->relocateOne(Buf + 4, R_ARM_THM_MOVT_ABS, S);
168 }
169 
170 void ThumbV7ABSLongThunk::addSymbols(ThunkSection &IS) {
171   ThunkSym = addSyntheticLocal(
172       Saver.save("__Thumbv7ABSLongThunk_" + Destination.getName()), STT_FUNC,
173       Offset | 0x1, size(), &IS);
174   addSyntheticLocal("$t", STT_NOTYPE, Offset, 0, &IS);
175 }
176 
177 bool ThumbV7ABSLongThunk::isCompatibleWith(RelType Type) const {
178   // ARM branch relocations can't use BLX
179   return Type != R_ARM_JUMP24 && Type != R_ARM_PC24 && Type != R_ARM_PLT32;
180 }
181 
182 void ARMV7PILongThunk::writeTo(uint8_t *Buf, ThunkSection &IS) const {
183   const uint8_t Data[] = {
184       0xf0, 0xcf, 0x0f, 0xe3, // P:  movw ip,:lower16:S - (P + (L1-P) + 8)
185       0x00, 0xc0, 0x40, 0xe3, //     movt ip,:upper16:S - (P + (L1-P) + 8)
186       0x0f, 0xc0, 0x8c, 0xe0, // L1: add ip, ip, pc
187       0x1c, 0xff, 0x2f, 0xe1, //     bx r12
188   };
189   uint64_t S = getARMThunkDestVA(Destination);
190   uint64_t P = ThunkSym->getVA();
191   uint64_t Offset = S - P - 16;
192   memcpy(Buf, Data, sizeof(Data));
193   Target->relocateOne(Buf, R_ARM_MOVW_PREL_NC, Offset);
194   Target->relocateOne(Buf + 4, R_ARM_MOVT_PREL, Offset);
195 }
196 
197 void ARMV7PILongThunk::addSymbols(ThunkSection &IS) {
198   ThunkSym = addSyntheticLocal(
199       Saver.save("__ARMV7PILongThunk_" + Destination.getName()), STT_FUNC,
200       Offset, size(), &IS);
201   addSyntheticLocal("$a", STT_NOTYPE, Offset, 0, &IS);
202 }
203 
204 bool ARMV7PILongThunk::isCompatibleWith(RelType Type) const {
205   // Thumb branch relocations can't use BLX
206   return Type != R_ARM_THM_JUMP19 && Type != R_ARM_THM_JUMP24;
207 }
208 
209 void ThumbV7PILongThunk::writeTo(uint8_t *Buf, ThunkSection &IS) const {
210   const uint8_t Data[] = {
211       0x4f, 0xf6, 0xf4, 0x7c, // P:  movw ip,:lower16:S - (P + (L1-P) + 4)
212       0xc0, 0xf2, 0x00, 0x0c, //     movt ip,:upper16:S - (P + (L1-P) + 4)
213       0xfc, 0x44,             // L1: add  r12, pc
214       0x60, 0x47,             //     bx   r12
215   };
216   uint64_t S = getARMThunkDestVA(Destination);
217   uint64_t P = ThunkSym->getVA() & ~0x1;
218   uint64_t Offset = S - P - 12;
219   memcpy(Buf, Data, sizeof(Data));
220   Target->relocateOne(Buf, R_ARM_THM_MOVW_PREL_NC, Offset);
221   Target->relocateOne(Buf + 4, R_ARM_THM_MOVT_PREL, Offset);
222 }
223 
224 void ThumbV7PILongThunk::addSymbols(ThunkSection &IS) {
225   ThunkSym = addSyntheticLocal(
226       Saver.save("__ThumbV7PILongThunk_" + Destination.getName()), STT_FUNC,
227       Offset | 0x1, size(), &IS);
228   addSyntheticLocal("$t", STT_NOTYPE, Offset, 0, &IS);
229 }
230 
231 bool ThumbV7PILongThunk::isCompatibleWith(RelType Type) const {
232   // ARM branch relocations can't use BLX
233   return Type != R_ARM_JUMP24 && Type != R_ARM_PC24 && Type != R_ARM_PLT32;
234 }
235 
236 // Write MIPS LA25 thunk code to call PIC function from the non-PIC one.
237 void MipsThunk::writeTo(uint8_t *Buf, ThunkSection &) const {
238   uint64_t S = Destination.getVA();
239   write32(Buf, 0x3c190000, Config->Endianness); // lui   $25, %hi(func)
240   write32(Buf + 4, 0x08000000 | (S >> 2), Config->Endianness); // j     func
241   write32(Buf + 8, 0x27390000, Config->Endianness); // addiu $25, $25, %lo(func)
242   write32(Buf + 12, 0x00000000, Config->Endianness); // nop
243   Target->relocateOne(Buf, R_MIPS_HI16, S);
244   Target->relocateOne(Buf + 8, R_MIPS_LO16, S);
245 }
246 
247 void MipsThunk::addSymbols(ThunkSection &IS) {
248   ThunkSym =
249       addSyntheticLocal(Saver.save("__LA25Thunk_" + Destination.getName()),
250                         STT_FUNC, Offset, size(), &IS);
251 }
252 
253 InputSection *MipsThunk::getTargetInputSection() const {
254   auto *DR = dyn_cast<Defined>(&Destination);
255   return dyn_cast<InputSection>(DR->Section);
256 }
257 
258 // Write microMIPS R2-R5 LA25 thunk code
259 // to call PIC function from the non-PIC one.
260 void MicroMipsThunk::writeTo(uint8_t *Buf, ThunkSection &) const {
261   uint64_t S = Destination.getVA();
262   write16(Buf, 0x41b9, Config->Endianness);       // lui   $25, %hi(func)
263   write16(Buf + 4, 0xd400, Config->Endianness);   // j     func
264   write16(Buf + 8, 0x3339, Config->Endianness);   // addiu $25, $25, %lo(func)
265   write16(Buf + 12, 0x0c00, Config->Endianness);  // nop
266   Target->relocateOne(Buf, R_MICROMIPS_HI16, S);
267   Target->relocateOne(Buf + 4, R_MICROMIPS_26_S1, S);
268   Target->relocateOne(Buf + 8, R_MICROMIPS_LO16, S);
269 }
270 
271 void MicroMipsThunk::addSymbols(ThunkSection &IS) {
272   ThunkSym =
273       addSyntheticLocal(Saver.save("__microLA25Thunk_" + Destination.getName()),
274                         STT_FUNC, Offset, size(), &IS);
275   ThunkSym->StOther |= STO_MIPS_MICROMIPS;
276 }
277 
278 InputSection *MicroMipsThunk::getTargetInputSection() const {
279   auto *DR = dyn_cast<Defined>(&Destination);
280   return dyn_cast<InputSection>(DR->Section);
281 }
282 
283 // Write microMIPS R6 LA25 thunk code
284 // to call PIC function from the non-PIC one.
285 void MicroMipsR6Thunk::writeTo(uint8_t *Buf, ThunkSection &) const {
286   uint64_t S = Destination.getVA();
287   uint64_t P = ThunkSym->getVA();
288   write16(Buf, 0x1320, Config->Endianness);       // lui   $25, %hi(func)
289   write16(Buf + 4, 0x3339, Config->Endianness);   // addiu $25, $25, %lo(func)
290   write16(Buf + 8, 0x9400, Config->Endianness);   // bc    func
291   Target->relocateOne(Buf, R_MICROMIPS_HI16, S);
292   Target->relocateOne(Buf + 4, R_MICROMIPS_LO16, S);
293   Target->relocateOne(Buf + 8, R_MICROMIPS_PC26_S1, S - P - 12);
294 }
295 
296 void MicroMipsR6Thunk::addSymbols(ThunkSection &IS) {
297   ThunkSym =
298       addSyntheticLocal(Saver.save("__microLA25Thunk_" + Destination.getName()),
299                         STT_FUNC, Offset, size(), &IS);
300   ThunkSym->StOther |= STO_MIPS_MICROMIPS;
301 }
302 
303 InputSection *MicroMipsR6Thunk::getTargetInputSection() const {
304   auto *DR = dyn_cast<Defined>(&Destination);
305   return dyn_cast<InputSection>(DR->Section);
306 }
307 
308 Thunk::Thunk(Symbol &D) : Destination(D), Offset(0) {}
309 
310 Thunk::~Thunk() = default;
311 
312 // Creates a thunk for Thumb-ARM interworking.
313 static Thunk *addThunkArm(RelType Reloc, Symbol &S) {
314   // ARM relocations need ARM to Thumb interworking Thunks.
315   // Thumb relocations need Thumb to ARM relocations.
316   // Use position independent Thunks if we require position independent code.
317   switch (Reloc) {
318   case R_ARM_PC24:
319   case R_ARM_PLT32:
320   case R_ARM_JUMP24:
321   case R_ARM_CALL:
322     if (Config->Pic)
323       return make<ARMV7PILongThunk>(S);
324     return make<ARMV7ABSLongThunk>(S);
325   case R_ARM_THM_JUMP19:
326   case R_ARM_THM_JUMP24:
327   case R_ARM_THM_CALL:
328     if (Config->Pic)
329       return make<ThumbV7PILongThunk>(S);
330     return make<ThumbV7ABSLongThunk>(S);
331   }
332   fatal("unrecognized relocation type");
333 }
334 
335 static Thunk *addThunkMips(RelType Type, Symbol &S) {
336   if ((S.StOther & STO_MIPS_MICROMIPS) && isMipsR6())
337     return make<MicroMipsR6Thunk>(S);
338   if (S.StOther & STO_MIPS_MICROMIPS)
339     return make<MicroMipsThunk>(S);
340   return make<MipsThunk>(S);
341 }
342 
343 Thunk *addThunk(RelType Type, Symbol &S) {
344   if (Config->EMachine == EM_ARM)
345     return addThunkArm(Type, S);
346   else if (Config->EMachine == EM_MIPS)
347     return addThunkMips(Type, S);
348   llvm_unreachable("add Thunk only supported for ARM and Mips");
349   return nullptr;
350 }
351 
352 } // end namespace elf
353 } // end namespace lld
354