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 
22 using namespace llvm;
23 
24 #define DEBUG_TYPE "sparcmcexpr"
25 
26 const SparcMCExpr*
27 SparcMCExpr::create(VariantKind Kind, const MCExpr *Expr,
28                       MCContext &Ctx) {
29     return new (Ctx) SparcMCExpr(Kind, Expr);
30 }
31 
32 void 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 
43 bool 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   }
85   llvm_unreachable("Unhandled SparcMCExpr::VariantKind");
86 }
87 
88 SparcMCExpr::VariantKind SparcMCExpr::parseVariantKind(StringRef name)
89 {
90   return StringSwitch<SparcMCExpr::VariantKind>(name)
91     .Case("lo",  VK_Sparc_LO)
92     .Case("hi",  VK_Sparc_HI)
93     .Case("h44", VK_Sparc_H44)
94     .Case("m44", VK_Sparc_M44)
95     .Case("l44", VK_Sparc_L44)
96     .Case("hh",  VK_Sparc_HH)
97     .Case("hm",  VK_Sparc_HM)
98     .Case("lm",  VK_Sparc_LM)
99     .Case("pc22",  VK_Sparc_PC22)
100     .Case("pc10",  VK_Sparc_PC10)
101     .Case("got22", VK_Sparc_GOT22)
102     .Case("got10", VK_Sparc_GOT10)
103     .Case("got13", VK_Sparc_GOT13)
104     .Case("r_disp32",   VK_Sparc_R_DISP32)
105     .Case("tgd_hi22",   VK_Sparc_TLS_GD_HI22)
106     .Case("tgd_lo10",   VK_Sparc_TLS_GD_LO10)
107     .Case("tgd_add",    VK_Sparc_TLS_GD_ADD)
108     .Case("tgd_call",   VK_Sparc_TLS_GD_CALL)
109     .Case("tldm_hi22",  VK_Sparc_TLS_LDM_HI22)
110     .Case("tldm_lo10",  VK_Sparc_TLS_LDM_LO10)
111     .Case("tldm_add",   VK_Sparc_TLS_LDM_ADD)
112     .Case("tldm_call",  VK_Sparc_TLS_LDM_CALL)
113     .Case("tldo_hix22", VK_Sparc_TLS_LDO_HIX22)
114     .Case("tldo_lox10", VK_Sparc_TLS_LDO_LOX10)
115     .Case("tldo_add",   VK_Sparc_TLS_LDO_ADD)
116     .Case("tie_hi22",   VK_Sparc_TLS_IE_HI22)
117     .Case("tie_lo10",   VK_Sparc_TLS_IE_LO10)
118     .Case("tie_ld",     VK_Sparc_TLS_IE_LD)
119     .Case("tie_ldx",    VK_Sparc_TLS_IE_LDX)
120     .Case("tie_add",    VK_Sparc_TLS_IE_ADD)
121     .Case("tle_hix22",  VK_Sparc_TLS_LE_HIX22)
122     .Case("tle_lox10",  VK_Sparc_TLS_LE_LOX10)
123     .Default(VK_Sparc_None);
124 }
125 
126 Sparc::Fixups SparcMCExpr::getFixupKind(SparcMCExpr::VariantKind Kind) {
127   switch (Kind) {
128   default: llvm_unreachable("Unhandled SparcMCExpr::VariantKind");
129   case VK_Sparc_LO:       return Sparc::fixup_sparc_lo10;
130   case VK_Sparc_HI:       return Sparc::fixup_sparc_hi22;
131   case VK_Sparc_H44:      return Sparc::fixup_sparc_h44;
132   case VK_Sparc_M44:      return Sparc::fixup_sparc_m44;
133   case VK_Sparc_L44:      return Sparc::fixup_sparc_l44;
134   case VK_Sparc_HH:       return Sparc::fixup_sparc_hh;
135   case VK_Sparc_HM:       return Sparc::fixup_sparc_hm;
136   case VK_Sparc_LM:       return Sparc::fixup_sparc_lm;
137   case VK_Sparc_PC22:     return Sparc::fixup_sparc_pc22;
138   case VK_Sparc_PC10:     return Sparc::fixup_sparc_pc10;
139   case VK_Sparc_GOT22:    return Sparc::fixup_sparc_got22;
140   case VK_Sparc_GOT10:    return Sparc::fixup_sparc_got10;
141   case VK_Sparc_GOT13:    return Sparc::fixup_sparc_got13;
142   case VK_Sparc_13:       return Sparc::fixup_sparc_13;
143   case VK_Sparc_WPLT30:   return Sparc::fixup_sparc_wplt30;
144   case VK_Sparc_WDISP30:  return Sparc::fixup_sparc_call30;
145   case VK_Sparc_TLS_GD_HI22:   return Sparc::fixup_sparc_tls_gd_hi22;
146   case VK_Sparc_TLS_GD_LO10:   return Sparc::fixup_sparc_tls_gd_lo10;
147   case VK_Sparc_TLS_GD_ADD:    return Sparc::fixup_sparc_tls_gd_add;
148   case VK_Sparc_TLS_GD_CALL:   return Sparc::fixup_sparc_tls_gd_call;
149   case VK_Sparc_TLS_LDM_HI22:  return Sparc::fixup_sparc_tls_ldm_hi22;
150   case VK_Sparc_TLS_LDM_LO10:  return Sparc::fixup_sparc_tls_ldm_lo10;
151   case VK_Sparc_TLS_LDM_ADD:   return Sparc::fixup_sparc_tls_ldm_add;
152   case VK_Sparc_TLS_LDM_CALL:  return Sparc::fixup_sparc_tls_ldm_call;
153   case VK_Sparc_TLS_LDO_HIX22: return Sparc::fixup_sparc_tls_ldo_hix22;
154   case VK_Sparc_TLS_LDO_LOX10: return Sparc::fixup_sparc_tls_ldo_lox10;
155   case VK_Sparc_TLS_LDO_ADD:   return Sparc::fixup_sparc_tls_ldo_add;
156   case VK_Sparc_TLS_IE_HI22:   return Sparc::fixup_sparc_tls_ie_hi22;
157   case VK_Sparc_TLS_IE_LO10:   return Sparc::fixup_sparc_tls_ie_lo10;
158   case VK_Sparc_TLS_IE_LD:     return Sparc::fixup_sparc_tls_ie_ld;
159   case VK_Sparc_TLS_IE_LDX:    return Sparc::fixup_sparc_tls_ie_ldx;
160   case VK_Sparc_TLS_IE_ADD:    return Sparc::fixup_sparc_tls_ie_add;
161   case VK_Sparc_TLS_LE_HIX22:  return Sparc::fixup_sparc_tls_le_hix22;
162   case VK_Sparc_TLS_LE_LOX10:  return Sparc::fixup_sparc_tls_le_lox10;
163   }
164 }
165 
166 bool
167 SparcMCExpr::evaluateAsRelocatableImpl(MCValue &Res,
168                                        const MCAsmLayout *Layout,
169                                        const MCFixup *Fixup) const {
170   return getSubExpr()->evaluateAsRelocatable(Res, Layout, Fixup);
171 }
172 
173 static void fixELFSymbolsInTLSFixupsImpl(const MCExpr *Expr, MCAssembler &Asm) {
174   switch (Expr->getKind()) {
175   case MCExpr::Target:
176     llvm_unreachable("Can't handle nested target expr!");
177     break;
178 
179   case MCExpr::Constant:
180     break;
181 
182   case MCExpr::Binary: {
183     const MCBinaryExpr *BE = cast<MCBinaryExpr>(Expr);
184     fixELFSymbolsInTLSFixupsImpl(BE->getLHS(), Asm);
185     fixELFSymbolsInTLSFixupsImpl(BE->getRHS(), Asm);
186     break;
187   }
188 
189   case MCExpr::SymbolRef: {
190     const MCSymbolRefExpr &SymRef = *cast<MCSymbolRefExpr>(Expr);
191     cast<MCSymbolELF>(SymRef.getSymbol()).setType(ELF::STT_TLS);
192     break;
193   }
194 
195   case MCExpr::Unary:
196     fixELFSymbolsInTLSFixupsImpl(cast<MCUnaryExpr>(Expr)->getSubExpr(), Asm);
197     break;
198   }
199 
200 }
201 
202 void SparcMCExpr::fixELFSymbolsInTLSFixups(MCAssembler &Asm) const {
203   switch(getKind()) {
204   default: return;
205   case VK_Sparc_TLS_GD_CALL:
206   case VK_Sparc_TLS_LDM_CALL: {
207     // The corresponding relocations reference __tls_get_addr, as they call it,
208     // but this is only implicit; we must explicitly add it to our symbol table
209     // to bind it for these uses.
210     MCSymbol *Symbol = Asm.getContext().getOrCreateSymbol("__tls_get_addr");
211     Asm.registerSymbol(*Symbol);
212     auto ELFSymbol = cast<MCSymbolELF>(Symbol);
213     if (!ELFSymbol->isBindingSet())
214       ELFSymbol->setBinding(ELF::STB_GLOBAL);
215     LLVM_FALLTHROUGH;
216   }
217   case VK_Sparc_TLS_GD_HI22:
218   case VK_Sparc_TLS_GD_LO10:
219   case VK_Sparc_TLS_GD_ADD:
220   case VK_Sparc_TLS_LDM_HI22:
221   case VK_Sparc_TLS_LDM_LO10:
222   case VK_Sparc_TLS_LDM_ADD:
223   case VK_Sparc_TLS_LDO_HIX22:
224   case VK_Sparc_TLS_LDO_LOX10:
225   case VK_Sparc_TLS_LDO_ADD:
226   case VK_Sparc_TLS_IE_HI22:
227   case VK_Sparc_TLS_IE_LO10:
228   case VK_Sparc_TLS_IE_LD:
229   case VK_Sparc_TLS_IE_LDX:
230   case VK_Sparc_TLS_IE_ADD:
231   case VK_Sparc_TLS_LE_HIX22:
232   case VK_Sparc_TLS_LE_LOX10: break;
233   }
234   fixELFSymbolsInTLSFixupsImpl(getSubExpr(), Asm);
235 }
236 
237 void SparcMCExpr::visitUsedExpr(MCStreamer &Streamer) const {
238   Streamer.visitUsedExpr(*getSubExpr());
239 }
240