1 //===-- PPCELFObjectWriter.cpp - PPC ELF Writer ---------------------------===//
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 #include "MCTargetDesc/PPCFixupKinds.h"
10 #include "MCTargetDesc/PPCMCExpr.h"
11 #include "MCTargetDesc/PPCMCTargetDesc.h"
12 #include "llvm/ADT/STLExtras.h"
13 #include "llvm/MC/MCELFObjectWriter.h"
14 #include "llvm/MC/MCExpr.h"
15 #include "llvm/MC/MCObjectWriter.h"
16 #include "llvm/MC/MCSymbolELF.h"
17 #include "llvm/MC/MCValue.h"
18 #include "llvm/Support/ErrorHandling.h"
19 
20 using namespace llvm;
21 
22 namespace {
23   class PPCELFObjectWriter : public MCELFObjectTargetWriter {
24   public:
25     PPCELFObjectWriter(bool Is64Bit, uint8_t OSABI);
26 
27   protected:
28     unsigned getRelocType(MCContext &Ctx, const MCValue &Target,
29                           const MCFixup &Fixup, bool IsPCRel) const override;
30 
31     bool needsRelocateWithSymbol(const MCSymbol &Sym,
32                                  unsigned Type) const override;
33   };
34 }
35 
36 PPCELFObjectWriter::PPCELFObjectWriter(bool Is64Bit, uint8_t OSABI)
37   : MCELFObjectTargetWriter(Is64Bit, OSABI,
38                             Is64Bit ?  ELF::EM_PPC64 : ELF::EM_PPC,
39                             /*HasRelocationAddend*/ true) {}
40 
41 static MCSymbolRefExpr::VariantKind getAccessVariant(const MCValue &Target,
42                                                      const MCFixup &Fixup) {
43   const MCExpr *Expr = Fixup.getValue();
44 
45   if (Expr->getKind() != MCExpr::Target)
46     return Target.getAccessVariant();
47 
48   switch (cast<PPCMCExpr>(Expr)->getKind()) {
49   case PPCMCExpr::VK_PPC_None:
50     return MCSymbolRefExpr::VK_None;
51   case PPCMCExpr::VK_PPC_LO:
52     return MCSymbolRefExpr::VK_PPC_LO;
53   case PPCMCExpr::VK_PPC_HI:
54     return MCSymbolRefExpr::VK_PPC_HI;
55   case PPCMCExpr::VK_PPC_HA:
56     return MCSymbolRefExpr::VK_PPC_HA;
57   case PPCMCExpr::VK_PPC_HIGH:
58     return MCSymbolRefExpr::VK_PPC_HIGH;
59   case PPCMCExpr::VK_PPC_HIGHA:
60     return MCSymbolRefExpr::VK_PPC_HIGHA;
61   case PPCMCExpr::VK_PPC_HIGHERA:
62     return MCSymbolRefExpr::VK_PPC_HIGHERA;
63   case PPCMCExpr::VK_PPC_HIGHER:
64     return MCSymbolRefExpr::VK_PPC_HIGHER;
65   case PPCMCExpr::VK_PPC_HIGHEST:
66     return MCSymbolRefExpr::VK_PPC_HIGHEST;
67   case PPCMCExpr::VK_PPC_HIGHESTA:
68     return MCSymbolRefExpr::VK_PPC_HIGHESTA;
69   }
70   llvm_unreachable("unknown PPCMCExpr kind");
71 }
72 
73 unsigned PPCELFObjectWriter::getRelocType(MCContext &Ctx, const MCValue &Target,
74                                           const MCFixup &Fixup,
75                                           bool IsPCRel) const {
76   MCFixupKind Kind = Fixup.getKind();
77   if (Kind >= FirstLiteralRelocationKind)
78     return Kind - FirstLiteralRelocationKind;
79   MCSymbolRefExpr::VariantKind Modifier = getAccessVariant(Target, Fixup);
80 
81   // determine the type of the relocation
82   unsigned Type;
83   if (IsPCRel) {
84     switch (Fixup.getTargetKind()) {
85     default:
86       llvm_unreachable("Unimplemented");
87     case PPC::fixup_ppc_br24:
88     case PPC::fixup_ppc_br24abs:
89     case PPC::fixup_ppc_br24_notoc:
90       switch (Modifier) {
91       default: llvm_unreachable("Unsupported Modifier");
92       case MCSymbolRefExpr::VK_None:
93         Type = ELF::R_PPC_REL24;
94         break;
95       case MCSymbolRefExpr::VK_PLT:
96         Type = ELF::R_PPC_PLTREL24;
97         break;
98       case MCSymbolRefExpr::VK_PPC_LOCAL:
99         Type = ELF::R_PPC_LOCAL24PC;
100         break;
101       case MCSymbolRefExpr::VK_PPC_NOTOC:
102         Type = ELF::R_PPC64_REL24_NOTOC;
103         break;
104       }
105       break;
106     case PPC::fixup_ppc_brcond14:
107     case PPC::fixup_ppc_brcond14abs:
108       Type = ELF::R_PPC_REL14;
109       break;
110     case PPC::fixup_ppc_half16:
111       switch (Modifier) {
112       default: llvm_unreachable("Unsupported Modifier");
113       case MCSymbolRefExpr::VK_None:
114         Type = ELF::R_PPC_REL16;
115         break;
116       case MCSymbolRefExpr::VK_PPC_LO:
117         Type = ELF::R_PPC_REL16_LO;
118         break;
119       case MCSymbolRefExpr::VK_PPC_HI:
120         Type = ELF::R_PPC_REL16_HI;
121         break;
122       case MCSymbolRefExpr::VK_PPC_HA:
123         Type = ELF::R_PPC_REL16_HA;
124         break;
125       }
126       break;
127     case PPC::fixup_ppc_half16ds:
128       Target.print(errs());
129       errs() << '\n';
130       report_fatal_error("Invalid PC-relative half16ds relocation");
131     case PPC::fixup_ppc_pcrel34:
132       Type = ELF::R_PPC64_PCREL34;
133       break;
134     case FK_Data_4:
135     case FK_PCRel_4:
136       Type = ELF::R_PPC_REL32;
137       break;
138     case FK_Data_8:
139     case FK_PCRel_8:
140       Type = ELF::R_PPC64_REL64;
141       break;
142     }
143   } else {
144     switch (Fixup.getTargetKind()) {
145       default: llvm_unreachable("invalid fixup kind!");
146     case PPC::fixup_ppc_br24abs:
147       Type = ELF::R_PPC_ADDR24;
148       break;
149     case PPC::fixup_ppc_brcond14abs:
150       Type = ELF::R_PPC_ADDR14; // XXX: or BRNTAKEN?_
151       break;
152     case PPC::fixup_ppc_half16:
153       switch (Modifier) {
154       default: llvm_unreachable("Unsupported Modifier");
155       case MCSymbolRefExpr::VK_None:
156         Type = ELF::R_PPC_ADDR16;
157         break;
158       case MCSymbolRefExpr::VK_PPC_LO:
159         Type = ELF::R_PPC_ADDR16_LO;
160         break;
161       case MCSymbolRefExpr::VK_PPC_HI:
162         Type = ELF::R_PPC_ADDR16_HI;
163         break;
164       case MCSymbolRefExpr::VK_PPC_HA:
165         Type = ELF::R_PPC_ADDR16_HA;
166         break;
167       case MCSymbolRefExpr::VK_PPC_HIGH:
168         Type = ELF::R_PPC64_ADDR16_HIGH;
169         break;
170       case MCSymbolRefExpr::VK_PPC_HIGHA:
171         Type = ELF::R_PPC64_ADDR16_HIGHA;
172         break;
173       case MCSymbolRefExpr::VK_PPC_HIGHER:
174         Type = ELF::R_PPC64_ADDR16_HIGHER;
175         break;
176       case MCSymbolRefExpr::VK_PPC_HIGHERA:
177         Type = ELF::R_PPC64_ADDR16_HIGHERA;
178         break;
179       case MCSymbolRefExpr::VK_PPC_HIGHEST:
180         Type = ELF::R_PPC64_ADDR16_HIGHEST;
181         break;
182       case MCSymbolRefExpr::VK_PPC_HIGHESTA:
183         Type = ELF::R_PPC64_ADDR16_HIGHESTA;
184         break;
185       case MCSymbolRefExpr::VK_GOT:
186         Type = ELF::R_PPC_GOT16;
187         break;
188       case MCSymbolRefExpr::VK_PPC_GOT_LO:
189         Type = ELF::R_PPC_GOT16_LO;
190         break;
191       case MCSymbolRefExpr::VK_PPC_GOT_HI:
192         Type = ELF::R_PPC_GOT16_HI;
193         break;
194       case MCSymbolRefExpr::VK_PPC_GOT_HA:
195         Type = ELF::R_PPC_GOT16_HA;
196         break;
197       case MCSymbolRefExpr::VK_PPC_TOC:
198         Type = ELF::R_PPC64_TOC16;
199         break;
200       case MCSymbolRefExpr::VK_PPC_TOC_LO:
201         Type = ELF::R_PPC64_TOC16_LO;
202         break;
203       case MCSymbolRefExpr::VK_PPC_TOC_HI:
204         Type = ELF::R_PPC64_TOC16_HI;
205         break;
206       case MCSymbolRefExpr::VK_PPC_TOC_HA:
207         Type = ELF::R_PPC64_TOC16_HA;
208         break;
209       case MCSymbolRefExpr::VK_TPREL:
210         Type = ELF::R_PPC_TPREL16;
211         break;
212       case MCSymbolRefExpr::VK_PPC_TPREL_LO:
213         Type = ELF::R_PPC_TPREL16_LO;
214         break;
215       case MCSymbolRefExpr::VK_PPC_TPREL_HI:
216         Type = ELF::R_PPC_TPREL16_HI;
217         break;
218       case MCSymbolRefExpr::VK_PPC_TPREL_HA:
219         Type = ELF::R_PPC_TPREL16_HA;
220         break;
221       case MCSymbolRefExpr::VK_PPC_TPREL_HIGH:
222         Type = ELF::R_PPC64_TPREL16_HIGH;
223         break;
224       case MCSymbolRefExpr::VK_PPC_TPREL_HIGHA:
225         Type = ELF::R_PPC64_TPREL16_HIGHA;
226         break;
227       case MCSymbolRefExpr::VK_PPC_TPREL_HIGHER:
228         Type = ELF::R_PPC64_TPREL16_HIGHER;
229         break;
230       case MCSymbolRefExpr::VK_PPC_TPREL_HIGHERA:
231         Type = ELF::R_PPC64_TPREL16_HIGHERA;
232         break;
233       case MCSymbolRefExpr::VK_PPC_TPREL_HIGHEST:
234         Type = ELF::R_PPC64_TPREL16_HIGHEST;
235         break;
236       case MCSymbolRefExpr::VK_PPC_TPREL_HIGHESTA:
237         Type = ELF::R_PPC64_TPREL16_HIGHESTA;
238         break;
239       case MCSymbolRefExpr::VK_DTPREL:
240         Type = ELF::R_PPC64_DTPREL16;
241         break;
242       case MCSymbolRefExpr::VK_PPC_DTPREL_LO:
243         Type = ELF::R_PPC64_DTPREL16_LO;
244         break;
245       case MCSymbolRefExpr::VK_PPC_DTPREL_HI:
246         Type = ELF::R_PPC64_DTPREL16_HI;
247         break;
248       case MCSymbolRefExpr::VK_PPC_DTPREL_HA:
249         Type = ELF::R_PPC64_DTPREL16_HA;
250         break;
251       case MCSymbolRefExpr::VK_PPC_DTPREL_HIGH:
252         Type = ELF::R_PPC64_DTPREL16_HIGH;
253         break;
254       case MCSymbolRefExpr::VK_PPC_DTPREL_HIGHA:
255         Type = ELF::R_PPC64_DTPREL16_HIGHA;
256         break;
257       case MCSymbolRefExpr::VK_PPC_DTPREL_HIGHER:
258         Type = ELF::R_PPC64_DTPREL16_HIGHER;
259         break;
260       case MCSymbolRefExpr::VK_PPC_DTPREL_HIGHERA:
261         Type = ELF::R_PPC64_DTPREL16_HIGHERA;
262         break;
263       case MCSymbolRefExpr::VK_PPC_DTPREL_HIGHEST:
264         Type = ELF::R_PPC64_DTPREL16_HIGHEST;
265         break;
266       case MCSymbolRefExpr::VK_PPC_DTPREL_HIGHESTA:
267         Type = ELF::R_PPC64_DTPREL16_HIGHESTA;
268         break;
269       case MCSymbolRefExpr::VK_PPC_GOT_TLSGD:
270         if (is64Bit())
271           Type = ELF::R_PPC64_GOT_TLSGD16;
272         else
273           Type = ELF::R_PPC_GOT_TLSGD16;
274         break;
275       case MCSymbolRefExpr::VK_PPC_GOT_TLSGD_LO:
276         Type = ELF::R_PPC64_GOT_TLSGD16_LO;
277         break;
278       case MCSymbolRefExpr::VK_PPC_GOT_TLSGD_HI:
279         Type = ELF::R_PPC64_GOT_TLSGD16_HI;
280         break;
281       case MCSymbolRefExpr::VK_PPC_GOT_TLSGD_HA:
282         Type = ELF::R_PPC64_GOT_TLSGD16_HA;
283         break;
284       case MCSymbolRefExpr::VK_PPC_GOT_TLSLD:
285         if (is64Bit())
286           Type = ELF::R_PPC64_GOT_TLSLD16;
287         else
288           Type = ELF::R_PPC_GOT_TLSLD16;
289         break;
290       case MCSymbolRefExpr::VK_PPC_GOT_TLSLD_LO:
291         Type = ELF::R_PPC64_GOT_TLSLD16_LO;
292         break;
293       case MCSymbolRefExpr::VK_PPC_GOT_TLSLD_HI:
294         Type = ELF::R_PPC64_GOT_TLSLD16_HI;
295         break;
296       case MCSymbolRefExpr::VK_PPC_GOT_TLSLD_HA:
297         Type = ELF::R_PPC64_GOT_TLSLD16_HA;
298         break;
299       case MCSymbolRefExpr::VK_PPC_GOT_TPREL:
300         /* We don't have R_PPC64_GOT_TPREL16, but since GOT offsets
301            are always 4-aligned, we can use R_PPC64_GOT_TPREL16_DS.  */
302         Type = ELF::R_PPC64_GOT_TPREL16_DS;
303         break;
304       case MCSymbolRefExpr::VK_PPC_GOT_TPREL_LO:
305         /* We don't have R_PPC64_GOT_TPREL16_LO, but since GOT offsets
306            are always 4-aligned, we can use R_PPC64_GOT_TPREL16_LO_DS.  */
307         Type = ELF::R_PPC64_GOT_TPREL16_LO_DS;
308         break;
309       case MCSymbolRefExpr::VK_PPC_GOT_TPREL_HI:
310         Type = ELF::R_PPC64_GOT_TPREL16_HI;
311         break;
312       case MCSymbolRefExpr::VK_PPC_GOT_DTPREL:
313         /* We don't have R_PPC64_GOT_DTPREL16, but since GOT offsets
314            are always 4-aligned, we can use R_PPC64_GOT_DTPREL16_DS.  */
315         Type = ELF::R_PPC64_GOT_DTPREL16_DS;
316         break;
317       case MCSymbolRefExpr::VK_PPC_GOT_DTPREL_LO:
318         /* We don't have R_PPC64_GOT_DTPREL16_LO, but since GOT offsets
319            are always 4-aligned, we can use R_PPC64_GOT_DTPREL16_LO_DS.  */
320         Type = ELF::R_PPC64_GOT_DTPREL16_LO_DS;
321         break;
322       case MCSymbolRefExpr::VK_PPC_GOT_TPREL_HA:
323         Type = ELF::R_PPC64_GOT_TPREL16_HA;
324         break;
325       case MCSymbolRefExpr::VK_PPC_GOT_DTPREL_HI:
326         Type = ELF::R_PPC64_GOT_DTPREL16_HI;
327         break;
328       case MCSymbolRefExpr::VK_PPC_GOT_DTPREL_HA:
329         Type = ELF::R_PPC64_GOT_DTPREL16_HA;
330         break;
331       }
332       break;
333     case PPC::fixup_ppc_half16ds:
334       switch (Modifier) {
335       default: llvm_unreachable("Unsupported Modifier");
336       case MCSymbolRefExpr::VK_None:
337         Type = ELF::R_PPC64_ADDR16_DS;
338         break;
339       case MCSymbolRefExpr::VK_PPC_LO:
340         Type = ELF::R_PPC64_ADDR16_LO_DS;
341         break;
342       case MCSymbolRefExpr::VK_GOT:
343         Type = ELF::R_PPC64_GOT16_DS;
344         break;
345       case MCSymbolRefExpr::VK_PPC_GOT_LO:
346         Type = ELF::R_PPC64_GOT16_LO_DS;
347         break;
348       case MCSymbolRefExpr::VK_PPC_TOC:
349         Type = ELF::R_PPC64_TOC16_DS;
350         break;
351       case MCSymbolRefExpr::VK_PPC_TOC_LO:
352         Type = ELF::R_PPC64_TOC16_LO_DS;
353         break;
354       case MCSymbolRefExpr::VK_TPREL:
355         Type = ELF::R_PPC64_TPREL16_DS;
356         break;
357       case MCSymbolRefExpr::VK_PPC_TPREL_LO:
358         Type = ELF::R_PPC64_TPREL16_LO_DS;
359         break;
360       case MCSymbolRefExpr::VK_DTPREL:
361         Type = ELF::R_PPC64_DTPREL16_DS;
362         break;
363       case MCSymbolRefExpr::VK_PPC_DTPREL_LO:
364         Type = ELF::R_PPC64_DTPREL16_LO_DS;
365         break;
366       case MCSymbolRefExpr::VK_PPC_GOT_TPREL:
367         Type = ELF::R_PPC64_GOT_TPREL16_DS;
368         break;
369       case MCSymbolRefExpr::VK_PPC_GOT_TPREL_LO:
370         Type = ELF::R_PPC64_GOT_TPREL16_LO_DS;
371         break;
372       case MCSymbolRefExpr::VK_PPC_GOT_DTPREL:
373         Type = ELF::R_PPC64_GOT_DTPREL16_DS;
374         break;
375       case MCSymbolRefExpr::VK_PPC_GOT_DTPREL_LO:
376         Type = ELF::R_PPC64_GOT_DTPREL16_LO_DS;
377         break;
378       }
379       break;
380     case PPC::fixup_ppc_nofixup:
381       switch (Modifier) {
382       default: llvm_unreachable("Unsupported Modifier");
383       case MCSymbolRefExpr::VK_PPC_TLSGD:
384         if (is64Bit())
385           Type = ELF::R_PPC64_TLSGD;
386         else
387           Type = ELF::R_PPC_TLSGD;
388         break;
389       case MCSymbolRefExpr::VK_PPC_TLSLD:
390         if (is64Bit())
391           Type = ELF::R_PPC64_TLSLD;
392         else
393           Type = ELF::R_PPC_TLSLD;
394         break;
395       case MCSymbolRefExpr::VK_PPC_TLS:
396         if (is64Bit())
397           Type = ELF::R_PPC64_TLS;
398         else
399           Type = ELF::R_PPC_TLS;
400         break;
401       }
402       break;
403     case FK_Data_8:
404       switch (Modifier) {
405       default: llvm_unreachable("Unsupported Modifier");
406       case MCSymbolRefExpr::VK_PPC_TOCBASE:
407         Type = ELF::R_PPC64_TOC;
408         break;
409       case MCSymbolRefExpr::VK_None:
410         Type = ELF::R_PPC64_ADDR64;
411         break;
412       case MCSymbolRefExpr::VK_PPC_DTPMOD:
413         Type = ELF::R_PPC64_DTPMOD64;
414         break;
415       case MCSymbolRefExpr::VK_TPREL:
416         Type = ELF::R_PPC64_TPREL64;
417         break;
418       case MCSymbolRefExpr::VK_DTPREL:
419         Type = ELF::R_PPC64_DTPREL64;
420         break;
421       }
422       break;
423     case FK_Data_4:
424       Type = ELF::R_PPC_ADDR32;
425       break;
426     case FK_Data_2:
427       Type = ELF::R_PPC_ADDR16;
428       break;
429     }
430   }
431   return Type;
432 }
433 
434 bool PPCELFObjectWriter::needsRelocateWithSymbol(const MCSymbol &Sym,
435                                                  unsigned Type) const {
436   switch (Type) {
437     default:
438       return false;
439 
440     case ELF::R_PPC_REL24:
441     case ELF::R_PPC64_REL24_NOTOC:
442       // If the target symbol has a local entry point, we must keep the
443       // target symbol to preserve that information for the linker.
444       // The "other" values are stored in the last 6 bits of the second byte.
445       // The traditional defines for STO values assume the full byte and thus
446       // the shift to pack it.
447       unsigned Other = cast<MCSymbolELF>(Sym).getOther() << 2;
448       return (Other & ELF::STO_PPC64_LOCAL_MASK) != 0;
449   }
450 }
451 
452 std::unique_ptr<MCObjectTargetWriter>
453 llvm::createPPCELFObjectWriter(bool Is64Bit, uint8_t OSABI) {
454   return std::make_unique<PPCELFObjectWriter>(Is64Bit, OSABI);
455 }
456