1//===-- SparcMCExpr.cpp - Sparc specific MC expression classes --------===//
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// This file contains the implementation of the assembly expression modifiers
10// accepted by the Sparc architecture (e.g. "%hi", "%lo", ...).
11//
12//===----------------------------------------------------------------------===//
13
14#include "SparcMCExpr.h"
15#include "llvm/BinaryFormat/ELF.h"
16#include "llvm/MC/MCAssembler.h"
17#include "llvm/MC/MCContext.h"
18#include "llvm/MC/MCObjectStreamer.h"
19#include "llvm/MC/MCSymbolELF.h"
20#include "llvm/Support/Casting.h"
21
22using namespace llvm;
23
24#define DEBUG_TYPE "sparcmcexpr"
25
26const SparcMCExpr*
27SparcMCExpr::create(VariantKind Kind, const MCExpr *Expr,
28 MCContext &Ctx) {
29 return new (Ctx) SparcMCExpr(Kind, Expr);
30}
31
32void SparcMCExpr::printImpl(raw_ostream &OS, const MCAsmInfo *MAI) const {
33
34 bool closeParen = printVariantKind(OS, Kind);
35
36 const MCExpr *Expr = getSubExpr();
37 Expr->print(OS, MAI);
38
39 if (closeParen)
40 OS << ')';
41}
42
43bool SparcMCExpr::printVariantKind(raw_ostream &OS, VariantKind Kind)
44{
45 switch (Kind) {
46 case VK_Sparc_None: return false;
47 case VK_Sparc_LO: OS << "%lo("; return true;
48 case VK_Sparc_HI: OS << "%hi("; return true;
49 case VK_Sparc_H44: OS << "%h44("; return true;
50 case VK_Sparc_M44: OS << "%m44("; return true;
51 case VK_Sparc_L44: OS << "%l44("; return true;
52 case VK_Sparc_HH: OS << "%hh("; return true;
53 case VK_Sparc_HM: OS << "%hm("; return true;
54 case VK_Sparc_LM: OS << "%lm("; return true;
55 // FIXME: use %pc22/%pc10, if system assembler supports them.
56 case VK_Sparc_PC22: OS << "%hi("; return true;
57 case VK_Sparc_PC10: OS << "%lo("; return true;
58 // FIXME: use %got22/%got10, if system assembler supports them.
59 case VK_Sparc_GOT22: OS << "%hi("; return true;
60 case VK_Sparc_GOT10: OS << "%lo("; return true;
61 case VK_Sparc_GOT13: return false;
62 case VK_Sparc_13: return false;
63 case VK_Sparc_WDISP30: return false;
64 case VK_Sparc_WPLT30: return false;
65 case VK_Sparc_R_DISP32: OS << "%r_disp32("; return true;
66 case VK_Sparc_TLS_GD_HI22: OS << "%tgd_hi22("; return true;
67 case VK_Sparc_TLS_GD_LO10: OS << "%tgd_lo10("; return true;
68 case VK_Sparc_TLS_GD_ADD: OS << "%tgd_add("; return true;
69 case VK_Sparc_TLS_GD_CALL: OS << "%tgd_call("; return true;
70 case VK_Sparc_TLS_LDM_HI22: OS << "%tldm_hi22("; return true;
71 case VK_Sparc_TLS_LDM_LO10: OS << "%tldm_lo10("; return true;
72 case VK_Sparc_TLS_LDM_ADD: OS << "%tldm_add("; return true;
73 case VK_Sparc_TLS_LDM_CALL: OS << "%tldm_call("; return true;
74 case VK_Sparc_TLS_LDO_HIX22: OS << "%tldo_hix22("; return true;
75 case VK_Sparc_TLS_LDO_LOX10: OS << "%tldo_lox10("; return true;
76 case VK_Sparc_TLS_LDO_ADD: OS << "%tldo_add("; return true;
77 case VK_Sparc_TLS_IE_HI22: OS << "%tie_hi22("; return true;
78 case VK_Sparc_TLS_IE_LO10: OS << "%tie_lo10("; return true;
79 case VK_Sparc_TLS_IE_LD: OS << "%tie_ld("; return true;
80 case VK_Sparc_TLS_IE_LDX: OS << "%tie_ldx("; return true;
81 case VK_Sparc_TLS_IE_ADD: OS << "%tie_add("; return true;
82 case VK_Sparc_TLS_LE_HIX22: OS << "%tle_hix22("; return true;
83 case VK_Sparc_TLS_LE_LOX10: OS << "%tle_lox10("; return true;
84 case VK_Sparc_HIX22: OS << "%hix("; return true;
85 case VK_Sparc_LOX10: OS << "%lox("; return true;
86 case VK_Sparc_GOTDATA_HIX22: OS << "%gdop_hix22("; return true;
87 case VK_Sparc_GOTDATA_LOX10: OS << "%gdop_lox10("; return true;
88 case VK_Sparc_GOTDATA_OP: OS << "%gdop("; return true;
89 }
90 llvm_unreachable("Unhandled SparcMCExpr::VariantKind");
91}
92
93SparcMCExpr::VariantKind SparcMCExpr::parseVariantKind(StringRef name)
94{
95 return StringSwitch<SparcMCExpr::VariantKind>(name)
96 .Case(S: "lo", Value: VK_Sparc_LO)
97 .Case(S: "hi", Value: VK_Sparc_HI)
98 .Case(S: "h44", Value: VK_Sparc_H44)
99 .Case(S: "m44", Value: VK_Sparc_M44)
100 .Case(S: "l44", Value: VK_Sparc_L44)
101 .Case(S: "hh", Value: VK_Sparc_HH)
102 .Case(S: "uhi", Value: VK_Sparc_HH) // Nonstandard GNU extension
103 .Case(S: "hm", Value: VK_Sparc_HM)
104 .Case(S: "ulo", Value: VK_Sparc_HM) // Nonstandard GNU extension
105 .Case(S: "lm", Value: VK_Sparc_LM)
106 .Case(S: "pc22", Value: VK_Sparc_PC22)
107 .Case(S: "pc10", Value: VK_Sparc_PC10)
108 .Case(S: "got22", Value: VK_Sparc_GOT22)
109 .Case(S: "got10", Value: VK_Sparc_GOT10)
110 .Case(S: "got13", Value: VK_Sparc_GOT13)
111 .Case(S: "r_disp32", Value: VK_Sparc_R_DISP32)
112 .Case(S: "tgd_hi22", Value: VK_Sparc_TLS_GD_HI22)
113 .Case(S: "tgd_lo10", Value: VK_Sparc_TLS_GD_LO10)
114 .Case(S: "tgd_add", Value: VK_Sparc_TLS_GD_ADD)
115 .Case(S: "tgd_call", Value: VK_Sparc_TLS_GD_CALL)
116 .Case(S: "tldm_hi22", Value: VK_Sparc_TLS_LDM_HI22)
117 .Case(S: "tldm_lo10", Value: VK_Sparc_TLS_LDM_LO10)
118 .Case(S: "tldm_add", Value: VK_Sparc_TLS_LDM_ADD)
119 .Case(S: "tldm_call", Value: VK_Sparc_TLS_LDM_CALL)
120 .Case(S: "tldo_hix22", Value: VK_Sparc_TLS_LDO_HIX22)
121 .Case(S: "tldo_lox10", Value: VK_Sparc_TLS_LDO_LOX10)
122 .Case(S: "tldo_add", Value: VK_Sparc_TLS_LDO_ADD)
123 .Case(S: "tie_hi22", Value: VK_Sparc_TLS_IE_HI22)
124 .Case(S: "tie_lo10", Value: VK_Sparc_TLS_IE_LO10)
125 .Case(S: "tie_ld", Value: VK_Sparc_TLS_IE_LD)
126 .Case(S: "tie_ldx", Value: VK_Sparc_TLS_IE_LDX)
127 .Case(S: "tie_add", Value: VK_Sparc_TLS_IE_ADD)
128 .Case(S: "tle_hix22", Value: VK_Sparc_TLS_LE_HIX22)
129 .Case(S: "tle_lox10", Value: VK_Sparc_TLS_LE_LOX10)
130 .Case(S: "hix", Value: VK_Sparc_HIX22)
131 .Case(S: "lox", Value: VK_Sparc_LOX10)
132 .Case(S: "gdop_hix22", Value: VK_Sparc_GOTDATA_HIX22)
133 .Case(S: "gdop_lox10", Value: VK_Sparc_GOTDATA_LOX10)
134 .Case(S: "gdop", Value: VK_Sparc_GOTDATA_OP)
135 .Default(Value: VK_Sparc_None);
136}
137
138Sparc::Fixups SparcMCExpr::getFixupKind(SparcMCExpr::VariantKind Kind) {
139 switch (Kind) {
140 default: llvm_unreachable("Unhandled SparcMCExpr::VariantKind");
141 case VK_Sparc_LO: return Sparc::fixup_sparc_lo10;
142 case VK_Sparc_HI: return Sparc::fixup_sparc_hi22;
143 case VK_Sparc_H44: return Sparc::fixup_sparc_h44;
144 case VK_Sparc_M44: return Sparc::fixup_sparc_m44;
145 case VK_Sparc_L44: return Sparc::fixup_sparc_l44;
146 case VK_Sparc_HH: return Sparc::fixup_sparc_hh;
147 case VK_Sparc_HM: return Sparc::fixup_sparc_hm;
148 case VK_Sparc_LM: return Sparc::fixup_sparc_lm;
149 case VK_Sparc_PC22: return Sparc::fixup_sparc_pc22;
150 case VK_Sparc_PC10: return Sparc::fixup_sparc_pc10;
151 case VK_Sparc_GOT22: return Sparc::fixup_sparc_got22;
152 case VK_Sparc_GOT10: return Sparc::fixup_sparc_got10;
153 case VK_Sparc_GOT13: return Sparc::fixup_sparc_got13;
154 case VK_Sparc_13: return Sparc::fixup_sparc_13;
155 case VK_Sparc_WPLT30: return Sparc::fixup_sparc_wplt30;
156 case VK_Sparc_WDISP30: return Sparc::fixup_sparc_call30;
157 case VK_Sparc_TLS_GD_HI22: return Sparc::fixup_sparc_tls_gd_hi22;
158 case VK_Sparc_TLS_GD_LO10: return Sparc::fixup_sparc_tls_gd_lo10;
159 case VK_Sparc_TLS_GD_ADD: return Sparc::fixup_sparc_tls_gd_add;
160 case VK_Sparc_TLS_GD_CALL: return Sparc::fixup_sparc_tls_gd_call;
161 case VK_Sparc_TLS_LDM_HI22: return Sparc::fixup_sparc_tls_ldm_hi22;
162 case VK_Sparc_TLS_LDM_LO10: return Sparc::fixup_sparc_tls_ldm_lo10;
163 case VK_Sparc_TLS_LDM_ADD: return Sparc::fixup_sparc_tls_ldm_add;
164 case VK_Sparc_TLS_LDM_CALL: return Sparc::fixup_sparc_tls_ldm_call;
165 case VK_Sparc_TLS_LDO_HIX22: return Sparc::fixup_sparc_tls_ldo_hix22;
166 case VK_Sparc_TLS_LDO_LOX10: return Sparc::fixup_sparc_tls_ldo_lox10;
167 case VK_Sparc_TLS_LDO_ADD: return Sparc::fixup_sparc_tls_ldo_add;
168 case VK_Sparc_TLS_IE_HI22: return Sparc::fixup_sparc_tls_ie_hi22;
169 case VK_Sparc_TLS_IE_LO10: return Sparc::fixup_sparc_tls_ie_lo10;
170 case VK_Sparc_TLS_IE_LD: return Sparc::fixup_sparc_tls_ie_ld;
171 case VK_Sparc_TLS_IE_LDX: return Sparc::fixup_sparc_tls_ie_ldx;
172 case VK_Sparc_TLS_IE_ADD: return Sparc::fixup_sparc_tls_ie_add;
173 case VK_Sparc_TLS_LE_HIX22: return Sparc::fixup_sparc_tls_le_hix22;
174 case VK_Sparc_TLS_LE_LOX10: return Sparc::fixup_sparc_tls_le_lox10;
175 case VK_Sparc_HIX22: return Sparc::fixup_sparc_hix22;
176 case VK_Sparc_LOX10: return Sparc::fixup_sparc_lox10;
177 case VK_Sparc_GOTDATA_HIX22: return Sparc::fixup_sparc_gotdata_hix22;
178 case VK_Sparc_GOTDATA_LOX10: return Sparc::fixup_sparc_gotdata_lox10;
179 case VK_Sparc_GOTDATA_OP: return Sparc::fixup_sparc_gotdata_op;
180 }
181}
182
183bool SparcMCExpr::evaluateAsRelocatableImpl(MCValue &Res,
184 const MCAssembler *Asm,
185 const MCFixup *Fixup) const {
186 return getSubExpr()->evaluateAsRelocatable(Res, Asm, Fixup);
187}
188
189static void fixELFSymbolsInTLSFixupsImpl(const MCExpr *Expr, MCAssembler &Asm) {
190 switch (Expr->getKind()) {
191 case MCExpr::Target:
192 llvm_unreachable("Can't handle nested target expr!");
193 break;
194
195 case MCExpr::Constant:
196 break;
197
198 case MCExpr::Binary: {
199 const MCBinaryExpr *BE = cast<MCBinaryExpr>(Val: Expr);
200 fixELFSymbolsInTLSFixupsImpl(Expr: BE->getLHS(), Asm);
201 fixELFSymbolsInTLSFixupsImpl(Expr: BE->getRHS(), Asm);
202 break;
203 }
204
205 case MCExpr::SymbolRef: {
206 const MCSymbolRefExpr &SymRef = *cast<MCSymbolRefExpr>(Val: Expr);
207 cast<MCSymbolELF>(Val: SymRef.getSymbol()).setType(ELF::STT_TLS);
208 break;
209 }
210
211 case MCExpr::Unary:
212 fixELFSymbolsInTLSFixupsImpl(Expr: cast<MCUnaryExpr>(Val: Expr)->getSubExpr(), Asm);
213 break;
214 }
215
216}
217
218void SparcMCExpr::fixELFSymbolsInTLSFixups(MCAssembler &Asm) const {
219 switch(getKind()) {
220 default: return;
221 case VK_Sparc_TLS_GD_CALL:
222 case VK_Sparc_TLS_LDM_CALL: {
223 // The corresponding relocations reference __tls_get_addr, as they call it,
224 // but this is only implicit; we must explicitly add it to our symbol table
225 // to bind it for these uses.
226 MCSymbol *Symbol = Asm.getContext().getOrCreateSymbol(Name: "__tls_get_addr");
227 Asm.registerSymbol(Symbol: *Symbol);
228 auto ELFSymbol = cast<MCSymbolELF>(Val: Symbol);
229 if (!ELFSymbol->isBindingSet())
230 ELFSymbol->setBinding(ELF::STB_GLOBAL);
231 [[fallthrough]];
232 }
233 case VK_Sparc_TLS_GD_HI22:
234 case VK_Sparc_TLS_GD_LO10:
235 case VK_Sparc_TLS_GD_ADD:
236 case VK_Sparc_TLS_LDM_HI22:
237 case VK_Sparc_TLS_LDM_LO10:
238 case VK_Sparc_TLS_LDM_ADD:
239 case VK_Sparc_TLS_LDO_HIX22:
240 case VK_Sparc_TLS_LDO_LOX10:
241 case VK_Sparc_TLS_LDO_ADD:
242 case VK_Sparc_TLS_IE_HI22:
243 case VK_Sparc_TLS_IE_LO10:
244 case VK_Sparc_TLS_IE_LD:
245 case VK_Sparc_TLS_IE_LDX:
246 case VK_Sparc_TLS_IE_ADD:
247 case VK_Sparc_TLS_LE_HIX22:
248 case VK_Sparc_TLS_LE_LOX10: break;
249 }
250 fixELFSymbolsInTLSFixupsImpl(Expr: getSubExpr(), Asm);
251}
252
253void SparcMCExpr::visitUsedExpr(MCStreamer &Streamer) const {
254 Streamer.visitUsedExpr(Expr: *getSubExpr());
255}
256