1 //===-- MipsAsmBackend.cpp - Mips Asm Backend ----------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the MipsAsmBackend class.
12 //===----------------------------------------------------------------------===//
15 #include "MCTargetDesc/MipsFixupKinds.h"
16 #include "MCTargetDesc/MipsAsmBackend.h"
17 #include "MCTargetDesc/MipsMCTargetDesc.h"
18 #include "llvm/MC/MCAsmBackend.h"
19 #include "llvm/MC/MCAssembler.h"
20 #include "llvm/MC/MCContext.h"
21 #include "llvm/MC/MCDirectives.h"
22 #include "llvm/MC/MCELFObjectWriter.h"
23 #include "llvm/MC/MCFixupKindInfo.h"
24 #include "llvm/MC/MCObjectWriter.h"
25 #include "llvm/MC/MCSubtargetInfo.h"
26 #include "llvm/Support/ErrorHandling.h"
27 #include "llvm/Support/MathExtras.h"
28 #include "llvm/Support/raw_ostream.h"
32 // Prepare value for the target space for it
33 static unsigned adjustFixupValue(const MCFixup &Fixup, uint64_t Value,
34 MCContext *Ctx = nullptr) {
36 unsigned Kind = Fixup.getKind();
38 // Add/subtract and shift
46 case Mips::fixup_Mips_LO16:
47 case Mips::fixup_Mips_GPREL16:
48 case Mips::fixup_Mips_GPOFF_HI:
49 case Mips::fixup_Mips_GPOFF_LO:
50 case Mips::fixup_Mips_GOT_PAGE:
51 case Mips::fixup_Mips_GOT_OFST:
52 case Mips::fixup_Mips_GOT_DISP:
53 case Mips::fixup_Mips_GOT_LO16:
54 case Mips::fixup_Mips_CALL_LO16:
55 case Mips::fixup_MICROMIPS_LO16:
56 case Mips::fixup_MICROMIPS_GOT_PAGE:
57 case Mips::fixup_MICROMIPS_GOT_OFST:
58 case Mips::fixup_MICROMIPS_GOT_DISP:
59 case Mips::fixup_MIPS_PCLO16:
61 case Mips::fixup_Mips_PC16:
62 // So far we are only using this type for branches.
63 // For branches we start 1 instruction after the branch
64 // so the displacement will be one instruction size less.
66 // The displacement is then divided by 4 to give us an 18 bit
67 // address range. Forcing a signed division because Value can be negative.
68 Value = (int64_t)Value / 4;
69 // We now check if Value can be encoded as a 16-bit signed immediate.
70 if (!isIntN(16, Value) && Ctx)
71 Ctx->FatalError(Fixup.getLoc(), "out of range PC16 fixup");
73 case Mips::fixup_MIPS_PC19_S2:
74 // Forcing a signed division because Value can be negative.
75 Value = (int64_t)Value / 4;
76 // We now check if Value can be encoded as a 19-bit signed immediate.
77 if (!isIntN(19, Value) && Ctx)
78 Ctx->FatalError(Fixup.getLoc(), "out of range PC19 fixup");
80 case Mips::fixup_Mips_26:
81 // So far we are only using this type for jumps.
82 // The displacement is then divided by 4 to give us an 28 bit
86 case Mips::fixup_Mips_HI16:
87 case Mips::fixup_Mips_GOT_Local:
88 case Mips::fixup_Mips_GOT_HI16:
89 case Mips::fixup_Mips_CALL_HI16:
90 case Mips::fixup_MICROMIPS_HI16:
91 case Mips::fixup_MIPS_PCHI16:
92 // Get the 2nd 16-bits. Also add 1 if bit 15 is 1.
93 Value = ((Value + 0x8000) >> 16) & 0xffff;
95 case Mips::fixup_Mips_HIGHER:
96 // Get the 3rd 16-bits.
97 Value = ((Value + 0x80008000LL) >> 32) & 0xffff;
99 case Mips::fixup_Mips_HIGHEST:
100 // Get the 4th 16-bits.
101 Value = ((Value + 0x800080008000LL) >> 48) & 0xffff;
103 case Mips::fixup_MICROMIPS_26_S1:
106 case Mips::fixup_MICROMIPS_PC7_S1:
108 // Forcing a signed division because Value can be negative.
109 Value = (int64_t) Value / 2;
110 // We now check if Value can be encoded as a 7-bit signed immediate.
111 if (!isIntN(7, Value) && Ctx)
112 Ctx->FatalError(Fixup.getLoc(), "out of range PC7 fixup");
114 case Mips::fixup_MICROMIPS_PC10_S1:
116 // Forcing a signed division because Value can be negative.
117 Value = (int64_t) Value / 2;
118 // We now check if Value can be encoded as a 10-bit signed immediate.
119 if (!isIntN(10, Value) && Ctx)
120 Ctx->FatalError(Fixup.getLoc(), "out of range PC10 fixup");
122 case Mips::fixup_MICROMIPS_PC16_S1:
124 // Forcing a signed division because Value can be negative.
125 Value = (int64_t)Value / 2;
126 // We now check if Value can be encoded as a 16-bit signed immediate.
127 if (!isIntN(16, Value) && Ctx)
128 Ctx->FatalError(Fixup.getLoc(), "out of range PC16 fixup");
130 case Mips::fixup_MIPS_PC18_S3:
131 // Forcing a signed division because Value can be negative.
132 Value = (int64_t)Value / 8;
133 // We now check if Value can be encoded as a 18-bit signed immediate.
134 if (!isIntN(18, Value) && Ctx)
135 Ctx->FatalError(Fixup.getLoc(), "out of range PC18 fixup");
137 case Mips::fixup_MIPS_PC21_S2:
139 // Forcing a signed division because Value can be negative.
140 Value = (int64_t) Value / 4;
141 // We now check if Value can be encoded as a 21-bit signed immediate.
142 if (!isIntN(21, Value) && Ctx)
143 Ctx->FatalError(Fixup.getLoc(), "out of range PC21 fixup");
145 case Mips::fixup_MIPS_PC26_S2:
147 // Forcing a signed division because Value can be negative.
148 Value = (int64_t) Value / 4;
149 // We now check if Value can be encoded as a 26-bit signed immediate.
150 if (!isIntN(26, Value) && Ctx)
151 Ctx->FatalError(Fixup.getLoc(), "out of range PC26 fixup");
158 MCObjectWriter *MipsAsmBackend::createObjectWriter(raw_ostream &OS) const {
159 return createMipsELFObjectWriter(OS,
160 MCELFObjectTargetWriter::getOSABI(OSType), IsLittle, Is64Bit);
163 // Little-endian fixup data byte ordering:
164 // mips32r2: a | b | x | x
165 // microMIPS: x | x | a | b
167 static bool needsMMLEByteOrder(unsigned Kind) {
168 return Kind != Mips::fixup_MICROMIPS_PC10_S1 &&
169 Kind >= Mips::fixup_MICROMIPS_26_S1 &&
170 Kind < Mips::LastTargetFixupKind;
173 // Calculate index for microMIPS specific little endian byte order
174 static unsigned calculateMMLEIndex(unsigned i) {
175 assert(i <= 3 && "Index out of range!");
177 return (1 - i / 2) * 2 + i % 2;
180 /// ApplyFixup - Apply the \p Value for given \p Fixup into the provided
181 /// data fragment, at the offset specified by the fixup and following the
182 /// fixup kind as appropriate.
183 void MipsAsmBackend::applyFixup(const MCFixup &Fixup, char *Data,
184 unsigned DataSize, uint64_t Value,
185 bool IsPCRel) const {
186 MCFixupKind Kind = Fixup.getKind();
187 Value = adjustFixupValue(Fixup, Value);
190 return; // Doesn't change encoding.
192 // Where do we start in the object
193 unsigned Offset = Fixup.getOffset();
194 // Number of bytes we need to fixup
195 unsigned NumBytes = (getFixupKindInfo(Kind).TargetSize + 7) / 8;
196 // Used to point to big endian bytes
199 switch ((unsigned)Kind) {
201 case Mips::fixup_Mips_16:
202 case Mips::fixup_MICROMIPS_PC10_S1:
206 case Mips::fixup_Mips_64:
215 // Grab current value, if any, from bits.
218 bool microMipsLEByteOrder = needsMMLEByteOrder((unsigned) Kind);
220 for (unsigned i = 0; i != NumBytes; ++i) {
221 unsigned Idx = IsLittle ? (microMipsLEByteOrder ? calculateMMLEIndex(i)
223 : (FullSize - 1 - i);
224 CurVal |= (uint64_t)((uint8_t)Data[Offset + Idx]) << (i*8);
227 uint64_t Mask = ((uint64_t)(-1) >>
228 (64 - getFixupKindInfo(Kind).TargetSize));
229 CurVal |= Value & Mask;
231 // Write out the fixed up bytes back to the code/data bits.
232 for (unsigned i = 0; i != NumBytes; ++i) {
233 unsigned Idx = IsLittle ? (microMipsLEByteOrder ? calculateMMLEIndex(i)
235 : (FullSize - 1 - i);
236 Data[Offset + Idx] = (uint8_t)((CurVal >> (i*8)) & 0xff);
240 const MCFixupKindInfo &MipsAsmBackend::
241 getFixupKindInfo(MCFixupKind Kind) const {
242 const static MCFixupKindInfo LittleEndianInfos[Mips::NumTargetFixupKinds] = {
243 // This table *must* be in same the order of fixup_* kinds in
246 // name offset bits flags
247 { "fixup_Mips_16", 0, 16, 0 },
248 { "fixup_Mips_32", 0, 32, 0 },
249 { "fixup_Mips_REL32", 0, 32, 0 },
250 { "fixup_Mips_26", 0, 26, 0 },
251 { "fixup_Mips_HI16", 0, 16, 0 },
252 { "fixup_Mips_LO16", 0, 16, 0 },
253 { "fixup_Mips_GPREL16", 0, 16, 0 },
254 { "fixup_Mips_LITERAL", 0, 16, 0 },
255 { "fixup_Mips_GOT_Global", 0, 16, 0 },
256 { "fixup_Mips_GOT_Local", 0, 16, 0 },
257 { "fixup_Mips_PC16", 0, 16, MCFixupKindInfo::FKF_IsPCRel },
258 { "fixup_Mips_CALL16", 0, 16, 0 },
259 { "fixup_Mips_GPREL32", 0, 32, 0 },
260 { "fixup_Mips_SHIFT5", 6, 5, 0 },
261 { "fixup_Mips_SHIFT6", 6, 5, 0 },
262 { "fixup_Mips_64", 0, 64, 0 },
263 { "fixup_Mips_TLSGD", 0, 16, 0 },
264 { "fixup_Mips_GOTTPREL", 0, 16, 0 },
265 { "fixup_Mips_TPREL_HI", 0, 16, 0 },
266 { "fixup_Mips_TPREL_LO", 0, 16, 0 },
267 { "fixup_Mips_TLSLDM", 0, 16, 0 },
268 { "fixup_Mips_DTPREL_HI", 0, 16, 0 },
269 { "fixup_Mips_DTPREL_LO", 0, 16, 0 },
270 { "fixup_Mips_Branch_PCRel", 0, 16, MCFixupKindInfo::FKF_IsPCRel },
271 { "fixup_Mips_GPOFF_HI", 0, 16, 0 },
272 { "fixup_Mips_GPOFF_LO", 0, 16, 0 },
273 { "fixup_Mips_GOT_PAGE", 0, 16, 0 },
274 { "fixup_Mips_GOT_OFST", 0, 16, 0 },
275 { "fixup_Mips_GOT_DISP", 0, 16, 0 },
276 { "fixup_Mips_HIGHER", 0, 16, 0 },
277 { "fixup_Mips_HIGHEST", 0, 16, 0 },
278 { "fixup_Mips_GOT_HI16", 0, 16, 0 },
279 { "fixup_Mips_GOT_LO16", 0, 16, 0 },
280 { "fixup_Mips_CALL_HI16", 0, 16, 0 },
281 { "fixup_Mips_CALL_LO16", 0, 16, 0 },
282 { "fixup_Mips_PC18_S3", 0, 18, MCFixupKindInfo::FKF_IsPCRel },
283 { "fixup_MIPS_PC19_S2", 0, 19, MCFixupKindInfo::FKF_IsPCRel },
284 { "fixup_MIPS_PC21_S2", 0, 21, MCFixupKindInfo::FKF_IsPCRel },
285 { "fixup_MIPS_PC26_S2", 0, 26, MCFixupKindInfo::FKF_IsPCRel },
286 { "fixup_MIPS_PCHI16", 0, 16, MCFixupKindInfo::FKF_IsPCRel },
287 { "fixup_MIPS_PCLO16", 0, 16, MCFixupKindInfo::FKF_IsPCRel },
288 { "fixup_MICROMIPS_26_S1", 0, 26, 0 },
289 { "fixup_MICROMIPS_HI16", 0, 16, 0 },
290 { "fixup_MICROMIPS_LO16", 0, 16, 0 },
291 { "fixup_MICROMIPS_GOT16", 0, 16, 0 },
292 { "fixup_MICROMIPS_PC7_S1", 0, 7, MCFixupKindInfo::FKF_IsPCRel },
293 { "fixup_MICROMIPS_PC10_S1", 0, 10, MCFixupKindInfo::FKF_IsPCRel },
294 { "fixup_MICROMIPS_PC16_S1", 0, 16, MCFixupKindInfo::FKF_IsPCRel },
295 { "fixup_MICROMIPS_CALL16", 0, 16, 0 },
296 { "fixup_MICROMIPS_GOT_DISP", 0, 16, 0 },
297 { "fixup_MICROMIPS_GOT_PAGE", 0, 16, 0 },
298 { "fixup_MICROMIPS_GOT_OFST", 0, 16, 0 },
299 { "fixup_MICROMIPS_TLS_GD", 0, 16, 0 },
300 { "fixup_MICROMIPS_TLS_LDM", 0, 16, 0 },
301 { "fixup_MICROMIPS_TLS_DTPREL_HI16", 0, 16, 0 },
302 { "fixup_MICROMIPS_TLS_DTPREL_LO16", 0, 16, 0 },
303 { "fixup_MICROMIPS_TLS_TPREL_HI16", 0, 16, 0 },
304 { "fixup_MICROMIPS_TLS_TPREL_LO16", 0, 16, 0 }
307 const static MCFixupKindInfo BigEndianInfos[Mips::NumTargetFixupKinds] = {
308 // This table *must* be in same the order of fixup_* kinds in
311 // name offset bits flags
312 { "fixup_Mips_16", 16, 16, 0 },
313 { "fixup_Mips_32", 0, 32, 0 },
314 { "fixup_Mips_REL32", 0, 32, 0 },
315 { "fixup_Mips_26", 6, 26, 0 },
316 { "fixup_Mips_HI16", 16, 16, 0 },
317 { "fixup_Mips_LO16", 16, 16, 0 },
318 { "fixup_Mips_GPREL16", 16, 16, 0 },
319 { "fixup_Mips_LITERAL", 16, 16, 0 },
320 { "fixup_Mips_GOT_Global", 16, 16, 0 },
321 { "fixup_Mips_GOT_Local", 16, 16, 0 },
322 { "fixup_Mips_PC16", 16, 16, MCFixupKindInfo::FKF_IsPCRel },
323 { "fixup_Mips_CALL16", 16, 16, 0 },
324 { "fixup_Mips_GPREL32", 0, 32, 0 },
325 { "fixup_Mips_SHIFT5", 21, 5, 0 },
326 { "fixup_Mips_SHIFT6", 21, 5, 0 },
327 { "fixup_Mips_64", 0, 64, 0 },
328 { "fixup_Mips_TLSGD", 16, 16, 0 },
329 { "fixup_Mips_GOTTPREL", 16, 16, 0 },
330 { "fixup_Mips_TPREL_HI", 16, 16, 0 },
331 { "fixup_Mips_TPREL_LO", 16, 16, 0 },
332 { "fixup_Mips_TLSLDM", 16, 16, 0 },
333 { "fixup_Mips_DTPREL_HI", 16, 16, 0 },
334 { "fixup_Mips_DTPREL_LO", 16, 16, 0 },
335 { "fixup_Mips_Branch_PCRel",16, 16, MCFixupKindInfo::FKF_IsPCRel },
336 { "fixup_Mips_GPOFF_HI", 16, 16, 0 },
337 { "fixup_Mips_GPOFF_LO", 16, 16, 0 },
338 { "fixup_Mips_GOT_PAGE", 16, 16, 0 },
339 { "fixup_Mips_GOT_OFST", 16, 16, 0 },
340 { "fixup_Mips_GOT_DISP", 16, 16, 0 },
341 { "fixup_Mips_HIGHER", 16, 16, 0 },
342 { "fixup_Mips_HIGHEST", 16, 16, 0 },
343 { "fixup_Mips_GOT_HI16", 16, 16, 0 },
344 { "fixup_Mips_GOT_LO16", 16, 16, 0 },
345 { "fixup_Mips_CALL_HI16", 16, 16, 0 },
346 { "fixup_Mips_CALL_LO16", 16, 16, 0 },
347 { "fixup_Mips_PC18_S3", 14, 18, MCFixupKindInfo::FKF_IsPCRel },
348 { "fixup_MIPS_PC19_S2", 13, 19, MCFixupKindInfo::FKF_IsPCRel },
349 { "fixup_MIPS_PC21_S2", 11, 21, MCFixupKindInfo::FKF_IsPCRel },
350 { "fixup_MIPS_PC26_S2", 6, 26, MCFixupKindInfo::FKF_IsPCRel },
351 { "fixup_MIPS_PCHI16", 16, 16, MCFixupKindInfo::FKF_IsPCRel },
352 { "fixup_MIPS_PCLO16", 16, 16, MCFixupKindInfo::FKF_IsPCRel },
353 { "fixup_MICROMIPS_26_S1", 6, 26, 0 },
354 { "fixup_MICROMIPS_HI16", 16, 16, 0 },
355 { "fixup_MICROMIPS_LO16", 16, 16, 0 },
356 { "fixup_MICROMIPS_GOT16", 16, 16, 0 },
357 { "fixup_MICROMIPS_PC7_S1", 9, 7, MCFixupKindInfo::FKF_IsPCRel },
358 { "fixup_MICROMIPS_PC10_S1", 6, 10, MCFixupKindInfo::FKF_IsPCRel },
359 { "fixup_MICROMIPS_PC16_S1",16, 16, MCFixupKindInfo::FKF_IsPCRel },
360 { "fixup_MICROMIPS_CALL16", 16, 16, 0 },
361 { "fixup_MICROMIPS_GOT_DISP", 16, 16, 0 },
362 { "fixup_MICROMIPS_GOT_PAGE", 16, 16, 0 },
363 { "fixup_MICROMIPS_GOT_OFST", 16, 16, 0 },
364 { "fixup_MICROMIPS_TLS_GD", 16, 16, 0 },
365 { "fixup_MICROMIPS_TLS_LDM", 16, 16, 0 },
366 { "fixup_MICROMIPS_TLS_DTPREL_HI16", 16, 16, 0 },
367 { "fixup_MICROMIPS_TLS_DTPREL_LO16", 16, 16, 0 },
368 { "fixup_MICROMIPS_TLS_TPREL_HI16", 16, 16, 0 },
369 { "fixup_MICROMIPS_TLS_TPREL_LO16", 16, 16, 0 }
372 if (Kind < FirstTargetFixupKind)
373 return MCAsmBackend::getFixupKindInfo(Kind);
375 assert(unsigned(Kind - FirstTargetFixupKind) < getNumFixupKinds() &&
379 return LittleEndianInfos[Kind - FirstTargetFixupKind];
380 return BigEndianInfos[Kind - FirstTargetFixupKind];
383 /// WriteNopData - Write an (optimal) nop sequence of Count bytes
384 /// to the given output. If the target cannot generate such a sequence,
385 /// it should return an error.
387 /// \return - True on success.
388 bool MipsAsmBackend::writeNopData(uint64_t Count, MCObjectWriter *OW) const {
389 // Check for a less than instruction size number of bytes
390 // FIXME: 16 bit instructions are not handled yet here.
391 // We shouldn't be using a hard coded number for instruction size.
393 // If the count is not 4-byte aligned, we must be writing data into the text
394 // section (otherwise we have unaligned instructions, and thus have far
395 // bigger problems), so just write zeros instead.
396 for (uint64_t i = 0, e = Count % 4; i != e; ++i)
399 uint64_t NumNops = Count / 4;
400 for (uint64_t i = 0; i != NumNops; ++i)
405 /// processFixupValue - Target hook to process the literal value of a fixup
407 void MipsAsmBackend::processFixupValue(const MCAssembler &Asm,
408 const MCAsmLayout &Layout,
409 const MCFixup &Fixup,
410 const MCFragment *DF,
411 const MCValue &Target,
414 // At this point we'll ignore the value returned by adjustFixupValue as
415 // we are only checking if the fixup can be applied correctly. We have
416 // access to MCContext from here which allows us to report a fatal error
417 // with *possibly* a source code location.
418 (void)adjustFixupValue(Fixup, Value, &Asm.getContext());
422 MCAsmBackend *llvm::createMipsAsmBackendEL32(const Target &T,
423 const MCRegisterInfo &MRI,
426 return new MipsAsmBackend(T, Triple(TT).getOS(),
427 /*IsLittle*/true, /*Is64Bit*/false);
430 MCAsmBackend *llvm::createMipsAsmBackendEB32(const Target &T,
431 const MCRegisterInfo &MRI,
434 return new MipsAsmBackend(T, Triple(TT).getOS(),
435 /*IsLittle*/false, /*Is64Bit*/false);
438 MCAsmBackend *llvm::createMipsAsmBackendEL64(const Target &T,
439 const MCRegisterInfo &MRI,
442 return new MipsAsmBackend(T, Triple(TT).getOS(),
443 /*IsLittle*/true, /*Is64Bit*/true);
446 MCAsmBackend *llvm::createMipsAsmBackendEB64(const Target &T,
447 const MCRegisterInfo &MRI,
450 return new MipsAsmBackend(T, Triple(TT).getOS(),
451 /*IsLittle*/false, /*Is64Bit*/true);