1*c9157d92SDimitry Andric //===-- SystemZELFObjectWriter.cpp - SystemZ ELF writer -------------------===//
2*c9157d92SDimitry Andric //
3*c9157d92SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*c9157d92SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*c9157d92SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*c9157d92SDimitry Andric //
7*c9157d92SDimitry Andric //===----------------------------------------------------------------------===//
8*c9157d92SDimitry Andric 
9*c9157d92SDimitry Andric #include "MCTargetDesc/SystemZMCFixups.h"
10*c9157d92SDimitry Andric #include "MCTargetDesc/SystemZMCTargetDesc.h"
11*c9157d92SDimitry Andric #include "llvm/BinaryFormat/ELF.h"
12*c9157d92SDimitry Andric #include "llvm/MC/MCContext.h"
13*c9157d92SDimitry Andric #include "llvm/MC/MCELFObjectWriter.h"
14*c9157d92SDimitry Andric #include "llvm/MC/MCExpr.h"
15*c9157d92SDimitry Andric #include "llvm/MC/MCFixup.h"
16*c9157d92SDimitry Andric #include "llvm/MC/MCObjectWriter.h"
17*c9157d92SDimitry Andric #include "llvm/MC/MCValue.h"
18*c9157d92SDimitry Andric #include "llvm/Support/ErrorHandling.h"
19*c9157d92SDimitry Andric #include <cassert>
20*c9157d92SDimitry Andric #include <cstdint>
21*c9157d92SDimitry Andric #include <memory>
22*c9157d92SDimitry Andric 
23*c9157d92SDimitry Andric using namespace llvm;
24*c9157d92SDimitry Andric 
25*c9157d92SDimitry Andric namespace {
26*c9157d92SDimitry Andric 
27*c9157d92SDimitry Andric class SystemZELFObjectWriter : public MCELFObjectTargetWriter {
28*c9157d92SDimitry Andric public:
29*c9157d92SDimitry Andric   SystemZELFObjectWriter(uint8_t OSABI);
30*c9157d92SDimitry Andric   ~SystemZELFObjectWriter() override = default;
31*c9157d92SDimitry Andric 
32*c9157d92SDimitry Andric protected:
33*c9157d92SDimitry Andric   // Override MCELFObjectTargetWriter.
34*c9157d92SDimitry Andric   unsigned getRelocType(MCContext &Ctx, const MCValue &Target,
35*c9157d92SDimitry Andric                         const MCFixup &Fixup, bool IsPCRel) const override;
36*c9157d92SDimitry Andric };
37*c9157d92SDimitry Andric 
38*c9157d92SDimitry Andric } // end anonymous namespace
39*c9157d92SDimitry Andric 
SystemZELFObjectWriter(uint8_t OSABI)40*c9157d92SDimitry Andric SystemZELFObjectWriter::SystemZELFObjectWriter(uint8_t OSABI)
41*c9157d92SDimitry Andric     : MCELFObjectTargetWriter(/*Is64Bit_=*/true, OSABI, ELF::EM_S390,
42*c9157d92SDimitry Andric                               /*HasRelocationAddend_=*/true) {}
43*c9157d92SDimitry Andric 
44*c9157d92SDimitry Andric // Return the relocation type for an absolute value of MCFixupKind Kind.
getAbsoluteReloc(MCContext & Ctx,SMLoc Loc,unsigned Kind)45*c9157d92SDimitry Andric static unsigned getAbsoluteReloc(MCContext &Ctx, SMLoc Loc, unsigned Kind) {
46*c9157d92SDimitry Andric   switch (Kind) {
47*c9157d92SDimitry Andric   case FK_Data_1:
48*c9157d92SDimitry Andric   case SystemZ::FK_390_U8Imm:
49*c9157d92SDimitry Andric   case SystemZ::FK_390_S8Imm:
50*c9157d92SDimitry Andric     return ELF::R_390_8;
51*c9157d92SDimitry Andric   case SystemZ::FK_390_U12Imm:
52*c9157d92SDimitry Andric     return ELF::R_390_12;
53*c9157d92SDimitry Andric   case FK_Data_2:
54*c9157d92SDimitry Andric   case SystemZ::FK_390_U16Imm:
55*c9157d92SDimitry Andric   case SystemZ::FK_390_S16Imm:
56*c9157d92SDimitry Andric     return ELF::R_390_16;
57*c9157d92SDimitry Andric   case SystemZ::FK_390_S20Imm:
58*c9157d92SDimitry Andric     return ELF::R_390_20;
59*c9157d92SDimitry Andric   case FK_Data_4:
60*c9157d92SDimitry Andric   case SystemZ::FK_390_U32Imm:
61*c9157d92SDimitry Andric   case SystemZ::FK_390_S32Imm:
62*c9157d92SDimitry Andric     return ELF::R_390_32;
63*c9157d92SDimitry Andric   case FK_Data_8:
64*c9157d92SDimitry Andric     return ELF::R_390_64;
65*c9157d92SDimitry Andric   }
66*c9157d92SDimitry Andric   Ctx.reportError(Loc, "Unsupported absolute address");
67*c9157d92SDimitry Andric   return 0;
68*c9157d92SDimitry Andric }
69*c9157d92SDimitry Andric 
70*c9157d92SDimitry Andric // Return the relocation type for a PC-relative value of MCFixupKind Kind.
getPCRelReloc(MCContext & Ctx,SMLoc Loc,unsigned Kind)71*c9157d92SDimitry Andric static unsigned getPCRelReloc(MCContext &Ctx, SMLoc Loc, unsigned Kind) {
72*c9157d92SDimitry Andric   switch (Kind) {
73*c9157d92SDimitry Andric   case FK_Data_2:
74*c9157d92SDimitry Andric   case SystemZ::FK_390_U16Imm:
75*c9157d92SDimitry Andric   case SystemZ::FK_390_S16Imm:
76*c9157d92SDimitry Andric     return ELF::R_390_PC16;
77*c9157d92SDimitry Andric   case FK_Data_4:
78*c9157d92SDimitry Andric   case SystemZ::FK_390_U32Imm:
79*c9157d92SDimitry Andric   case SystemZ::FK_390_S32Imm:
80*c9157d92SDimitry Andric     return ELF::R_390_PC32;
81*c9157d92SDimitry Andric   case FK_Data_8:
82*c9157d92SDimitry Andric     return ELF::R_390_PC64;
83*c9157d92SDimitry Andric   case SystemZ::FK_390_PC12DBL:
84*c9157d92SDimitry Andric     return ELF::R_390_PC12DBL;
85*c9157d92SDimitry Andric   case SystemZ::FK_390_PC16DBL:
86*c9157d92SDimitry Andric     return ELF::R_390_PC16DBL;
87*c9157d92SDimitry Andric   case SystemZ::FK_390_PC24DBL:
88*c9157d92SDimitry Andric     return ELF::R_390_PC24DBL;
89*c9157d92SDimitry Andric   case SystemZ::FK_390_PC32DBL:
90*c9157d92SDimitry Andric     return ELF::R_390_PC32DBL;
91*c9157d92SDimitry Andric   }
92*c9157d92SDimitry Andric   Ctx.reportError(Loc, "Unsupported PC-relative address");
93*c9157d92SDimitry Andric   return 0;
94*c9157d92SDimitry Andric }
95*c9157d92SDimitry Andric 
96*c9157d92SDimitry Andric // Return the R_390_TLS_LE* relocation type for MCFixupKind Kind.
getTLSLEReloc(MCContext & Ctx,SMLoc Loc,unsigned Kind)97*c9157d92SDimitry Andric static unsigned getTLSLEReloc(MCContext &Ctx, SMLoc Loc, unsigned Kind) {
98*c9157d92SDimitry Andric   switch (Kind) {
99*c9157d92SDimitry Andric   case FK_Data_4: return ELF::R_390_TLS_LE32;
100*c9157d92SDimitry Andric   case FK_Data_8: return ELF::R_390_TLS_LE64;
101*c9157d92SDimitry Andric   }
102*c9157d92SDimitry Andric   Ctx.reportError(Loc, "Unsupported thread-local address (local-exec)");
103*c9157d92SDimitry Andric   return 0;
104*c9157d92SDimitry Andric }
105*c9157d92SDimitry Andric 
106*c9157d92SDimitry Andric // Return the R_390_TLS_LDO* relocation type for MCFixupKind Kind.
getTLSLDOReloc(MCContext & Ctx,SMLoc Loc,unsigned Kind)107*c9157d92SDimitry Andric static unsigned getTLSLDOReloc(MCContext &Ctx, SMLoc Loc, unsigned Kind) {
108*c9157d92SDimitry Andric   switch (Kind) {
109*c9157d92SDimitry Andric   case FK_Data_4: return ELF::R_390_TLS_LDO32;
110*c9157d92SDimitry Andric   case FK_Data_8: return ELF::R_390_TLS_LDO64;
111*c9157d92SDimitry Andric   }
112*c9157d92SDimitry Andric   Ctx.reportError(Loc, "Unsupported thread-local address (local-dynamic)");
113*c9157d92SDimitry Andric   return 0;
114*c9157d92SDimitry Andric }
115*c9157d92SDimitry Andric 
116*c9157d92SDimitry Andric // Return the R_390_TLS_LDM* relocation type for MCFixupKind Kind.
getTLSLDMReloc(MCContext & Ctx,SMLoc Loc,unsigned Kind)117*c9157d92SDimitry Andric static unsigned getTLSLDMReloc(MCContext &Ctx, SMLoc Loc, unsigned Kind) {
118*c9157d92SDimitry Andric   switch (Kind) {
119*c9157d92SDimitry Andric   case FK_Data_4: return ELF::R_390_TLS_LDM32;
120*c9157d92SDimitry Andric   case FK_Data_8: return ELF::R_390_TLS_LDM64;
121*c9157d92SDimitry Andric   case SystemZ::FK_390_TLS_CALL: return ELF::R_390_TLS_LDCALL;
122*c9157d92SDimitry Andric   }
123*c9157d92SDimitry Andric   Ctx.reportError(Loc, "Unsupported thread-local address (local-dynamic)");
124*c9157d92SDimitry Andric   return 0;
125*c9157d92SDimitry Andric }
126*c9157d92SDimitry Andric 
127*c9157d92SDimitry Andric // Return the R_390_TLS_GD* relocation type for MCFixupKind Kind.
getTLSGDReloc(MCContext & Ctx,SMLoc Loc,unsigned Kind)128*c9157d92SDimitry Andric static unsigned getTLSGDReloc(MCContext &Ctx, SMLoc Loc, unsigned Kind) {
129*c9157d92SDimitry Andric   switch (Kind) {
130*c9157d92SDimitry Andric   case FK_Data_4: return ELF::R_390_TLS_GD32;
131*c9157d92SDimitry Andric   case FK_Data_8: return ELF::R_390_TLS_GD64;
132*c9157d92SDimitry Andric   case SystemZ::FK_390_TLS_CALL: return ELF::R_390_TLS_GDCALL;
133*c9157d92SDimitry Andric   }
134*c9157d92SDimitry Andric   Ctx.reportError(Loc, "Unsupported thread-local address (general-dynamic)");
135*c9157d92SDimitry Andric   return 0;
136*c9157d92SDimitry Andric }
137*c9157d92SDimitry Andric 
138*c9157d92SDimitry Andric // Return the PLT relocation counterpart of MCFixupKind Kind.
getPLTReloc(MCContext & Ctx,SMLoc Loc,unsigned Kind)139*c9157d92SDimitry Andric static unsigned getPLTReloc(MCContext &Ctx, SMLoc Loc, unsigned Kind) {
140*c9157d92SDimitry Andric   switch (Kind) {
141*c9157d92SDimitry Andric   case SystemZ::FK_390_PC12DBL: return ELF::R_390_PLT12DBL;
142*c9157d92SDimitry Andric   case SystemZ::FK_390_PC16DBL: return ELF::R_390_PLT16DBL;
143*c9157d92SDimitry Andric   case SystemZ::FK_390_PC24DBL: return ELF::R_390_PLT24DBL;
144*c9157d92SDimitry Andric   case SystemZ::FK_390_PC32DBL: return ELF::R_390_PLT32DBL;
145*c9157d92SDimitry Andric   }
146*c9157d92SDimitry Andric   Ctx.reportError(Loc, "Unsupported PC-relative PLT address");
147*c9157d92SDimitry Andric   return 0;
148*c9157d92SDimitry Andric }
149*c9157d92SDimitry Andric 
getRelocType(MCContext & Ctx,const MCValue & Target,const MCFixup & Fixup,bool IsPCRel) const150*c9157d92SDimitry Andric unsigned SystemZELFObjectWriter::getRelocType(MCContext &Ctx,
151*c9157d92SDimitry Andric                                               const MCValue &Target,
152*c9157d92SDimitry Andric                                               const MCFixup &Fixup,
153*c9157d92SDimitry Andric                                               bool IsPCRel) const {
154*c9157d92SDimitry Andric   SMLoc Loc = Fixup.getLoc();
155*c9157d92SDimitry Andric   unsigned Kind = Fixup.getKind();
156*c9157d92SDimitry Andric   if (Kind >= FirstLiteralRelocationKind)
157*c9157d92SDimitry Andric     return Kind - FirstLiteralRelocationKind;
158*c9157d92SDimitry Andric   MCSymbolRefExpr::VariantKind Modifier = Target.getAccessVariant();
159*c9157d92SDimitry Andric   switch (Modifier) {
160*c9157d92SDimitry Andric   case MCSymbolRefExpr::VK_None:
161*c9157d92SDimitry Andric     if (IsPCRel)
162*c9157d92SDimitry Andric       return getPCRelReloc(Ctx, Loc, Kind);
163*c9157d92SDimitry Andric     return getAbsoluteReloc(Ctx, Loc, Kind);
164*c9157d92SDimitry Andric 
165*c9157d92SDimitry Andric   case MCSymbolRefExpr::VK_NTPOFF:
166*c9157d92SDimitry Andric     assert(!IsPCRel && "NTPOFF shouldn't be PC-relative");
167*c9157d92SDimitry Andric     return getTLSLEReloc(Ctx, Loc, Kind);
168*c9157d92SDimitry Andric 
169*c9157d92SDimitry Andric   case MCSymbolRefExpr::VK_INDNTPOFF:
170*c9157d92SDimitry Andric     if (IsPCRel && Kind == SystemZ::FK_390_PC32DBL)
171*c9157d92SDimitry Andric       return ELF::R_390_TLS_IEENT;
172*c9157d92SDimitry Andric     Ctx.reportError(Loc, "Only PC-relative INDNTPOFF accesses are supported for now");
173*c9157d92SDimitry Andric     return 0;
174*c9157d92SDimitry Andric 
175*c9157d92SDimitry Andric   case MCSymbolRefExpr::VK_DTPOFF:
176*c9157d92SDimitry Andric     assert(!IsPCRel && "DTPOFF shouldn't be PC-relative");
177*c9157d92SDimitry Andric     return getTLSLDOReloc(Ctx, Loc, Kind);
178*c9157d92SDimitry Andric 
179*c9157d92SDimitry Andric   case MCSymbolRefExpr::VK_TLSLDM:
180*c9157d92SDimitry Andric     assert(!IsPCRel && "TLSLDM shouldn't be PC-relative");
181*c9157d92SDimitry Andric     return getTLSLDMReloc(Ctx, Loc, Kind);
182*c9157d92SDimitry Andric 
183*c9157d92SDimitry Andric   case MCSymbolRefExpr::VK_TLSGD:
184*c9157d92SDimitry Andric     assert(!IsPCRel && "TLSGD shouldn't be PC-relative");
185*c9157d92SDimitry Andric     return getTLSGDReloc(Ctx, Loc, Kind);
186*c9157d92SDimitry Andric 
187*c9157d92SDimitry Andric   case MCSymbolRefExpr::VK_GOT:
188*c9157d92SDimitry Andric     if (IsPCRel && Kind == SystemZ::FK_390_PC32DBL)
189*c9157d92SDimitry Andric       return ELF::R_390_GOTENT;
190*c9157d92SDimitry Andric     Ctx.reportError(Loc, "Only PC-relative GOT accesses are supported for now");
191*c9157d92SDimitry Andric     return 0;
192*c9157d92SDimitry Andric 
193*c9157d92SDimitry Andric   case MCSymbolRefExpr::VK_PLT:
194*c9157d92SDimitry Andric     assert(IsPCRel && "@PLT shouldn't be PC-relative");
195*c9157d92SDimitry Andric     return getPLTReloc(Ctx, Loc, Kind);
196*c9157d92SDimitry Andric 
197*c9157d92SDimitry Andric   default:
198*c9157d92SDimitry Andric     llvm_unreachable("Modifier not supported");
199*c9157d92SDimitry Andric   }
200*c9157d92SDimitry Andric }
201*c9157d92SDimitry Andric 
202*c9157d92SDimitry Andric std::unique_ptr<MCObjectTargetWriter>
createSystemZELFObjectWriter(uint8_t OSABI)203*c9157d92SDimitry Andric llvm::createSystemZELFObjectWriter(uint8_t OSABI) {
204*c9157d92SDimitry Andric   return std::make_unique<SystemZELFObjectWriter>(OSABI);
205*c9157d92SDimitry Andric }
206