lib/Target/Mips/MCTargetDesc/MipsAsmBackend.cpp

   1 //===-- MipsAsmBackend.cpp - Mips Asm Backend  ----------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the MipsAsmBackend class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13 //
  14
  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"
  29
  30 using namespace llvm;
  31
  32 // Prepare value for the target space for it
  33 static unsigned adjustFixupValue(const MCFixup &Fixup, uint64_t Value,
  34                                  MCContext *Ctx = nullptr) {
  35
  36   unsigned Kind = Fixup.getKind();
  37
  38   // Add/subtract and shift
  39   switch (Kind) {
  40   default:
  41     return 0;
  42   case FK_Data_2:
  43   case FK_GPRel_4:
  44   case FK_Data_4:
  45   case FK_Data_8:
  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:
  60     break;
  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.
  65     Value -= 4;
  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");
  72     break;
  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");
  79     break;
  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
  83     // address range.
  84     Value >>= 2;
  85     break;
  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;
  94     break;
  95   case Mips::fixup_Mips_HIGHER:
  96     // Get the 3rd 16-bits.
  97     Value = ((Value + 0x80008000LL) >> 32) & 0xffff;
  98     break;
  99   case Mips::fixup_Mips_HIGHEST:
 100     // Get the 4th 16-bits.
 101     Value = ((Value + 0x800080008000LL) >> 48) & 0xffff;
 102     break;
 103   case Mips::fixup_MICROMIPS_26_S1:
 104     Value >>= 1;
 105     break;
 106   case Mips::fixup_MICROMIPS_PC16_S1:
 107     Value -= 4;
 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 16-bit signed immediate.
 111     if (!isIntN(16, Value) && Ctx)
 112       Ctx->FatalError(Fixup.getLoc(), "out of range PC16 fixup");
 113     break;
 114   case Mips::fixup_MIPS_PC21_S2:
 115     Value -= 4;
 116     // Forcing a signed division because Value can be negative.
 117     Value = (int64_t) Value / 4;
 118     // We now check if Value can be encoded as a 21-bit signed immediate.
 119     if (!isIntN(21, Value) && Ctx)
 120       Ctx->FatalError(Fixup.getLoc(), "out of range PC21 fixup");
 121     break;
 122   case Mips::fixup_MIPS_PC26_S2:
 123     Value -= 4;
 124     // Forcing a signed division because Value can be negative.
 125     Value = (int64_t) Value / 4;
 126     // We now check if Value can be encoded as a 26-bit signed immediate.
 127     if (!isIntN(26, Value) && Ctx)
 128       Ctx->FatalError(Fixup.getLoc(), "out of range PC26 fixup");
 129     break;
 130   }
 131
 132   return Value;
 133 }
 134
 135 MCObjectWriter *MipsAsmBackend::createObjectWriter(raw_ostream &OS) const {
 136   return createMipsELFObjectWriter(OS,
 137     MCELFObjectTargetWriter::getOSABI(OSType), IsLittle, Is64Bit);
 138 }
 139
 140 // Little-endian fixup data byte ordering:
 141 //   mips32r2:   a | b | x | x
 142 //   microMIPS:  x | x | a | b
 143
 144 static bool needsMMLEByteOrder(unsigned Kind) {
 145   return Kind >= Mips::fixup_MICROMIPS_26_S1 &&
 146          Kind < Mips::LastTargetFixupKind;
 147 }
 148
 149 // Calculate index for microMIPS specific little endian byte order
 150 static unsigned calculateMMLEIndex(unsigned i) {
 151   assert(i <= 3 && "Index out of range!");
 152
 153   return (1 - i / 2) * 2 + i % 2;
 154 }
 155
 156 /// ApplyFixup - Apply the \p Value for given \p Fixup into the provided
 157 /// data fragment, at the offset specified by the fixup and following the
 158 /// fixup kind as appropriate.
 159 void MipsAsmBackend::applyFixup(const MCFixup &Fixup, char *Data,
 160                                 unsigned DataSize, uint64_t Value,
 161                                 bool IsPCRel) const {
 162   MCFixupKind Kind = Fixup.getKind();
 163   Value = adjustFixupValue(Fixup, Value);
 164
 165   if (!Value)
 166     return; // Doesn't change encoding.
 167
 168   // Where do we start in the object
 169   unsigned Offset = Fixup.getOffset();
 170   // Number of bytes we need to fixup
 171   unsigned NumBytes = (getFixupKindInfo(Kind).TargetSize + 7) / 8;
 172   // Used to point to big endian bytes
 173   unsigned FullSize;
 174
 175   switch ((unsigned)Kind) {
 176   case FK_Data_2:
 177   case Mips::fixup_Mips_16:
 178     FullSize = 2;
 179     break;
 180   case FK_Data_8:
 181   case Mips::fixup_Mips_64:
 182     FullSize = 8;
 183     break;
 184   case FK_Data_4:
 185   default:
 186     FullSize = 4;
 187     break;
 188   }
 189
 190   // Grab current value, if any, from bits.
 191   uint64_t CurVal = 0;
 192
 193   bool microMipsLEByteOrder = needsMMLEByteOrder((unsigned) Kind);
 194
 195   for (unsigned i = 0; i != NumBytes; ++i) {
 196     unsigned Idx = IsLittle ? (microMipsLEByteOrder ? calculateMMLEIndex(i)
 197                                                     : i)
 198                             : (FullSize - 1 - i);
 199     CurVal |= (uint64_t)((uint8_t)Data[Offset + Idx]) << (i*8);
 200   }
 201
 202   uint64_t Mask = ((uint64_t)(-1) >>
 203                     (64 - getFixupKindInfo(Kind).TargetSize));
 204   CurVal |= Value & Mask;
 205
 206   // Write out the fixed up bytes back to the code/data bits.
 207   for (unsigned i = 0; i != NumBytes; ++i) {
 208     unsigned Idx = IsLittle ? (microMipsLEByteOrder ? calculateMMLEIndex(i)
 209                                                     : i)
 210                             : (FullSize - 1 - i);
 211     Data[Offset + Idx] = (uint8_t)((CurVal >> (i*8)) & 0xff);
 212   }
 213 }
 214
 215 const MCFixupKindInfo &MipsAsmBackend::
 216 getFixupKindInfo(MCFixupKind Kind) const {
 217   const static MCFixupKindInfo LittleEndianInfos[Mips::NumTargetFixupKinds] = {
 218     // This table *must* be in same the order of fixup_* kinds in
 219     // MipsFixupKinds.h.
 220     //
 221     // name                    offset  bits  flags
 222     { "fixup_Mips_16",           0,     16,   0 },
 223     { "fixup_Mips_32",           0,     32,   0 },
 224     { "fixup_Mips_REL32",        0,     32,   0 },
 225     { "fixup_Mips_26",           0,     26,   0 },
 226     { "fixup_Mips_HI16",         0,     16,   0 },
 227     { "fixup_Mips_LO16",         0,     16,   0 },
 228     { "fixup_Mips_GPREL16",      0,     16,   0 },
 229     { "fixup_Mips_LITERAL",      0,     16,   0 },
 230     { "fixup_Mips_GOT_Global",   0,     16,   0 },
 231     { "fixup_Mips_GOT_Local",    0,     16,   0 },
 232     { "fixup_Mips_PC16",         0,     16,  MCFixupKindInfo::FKF_IsPCRel },
 233     { "fixup_Mips_CALL16",       0,     16,   0 },
 234     { "fixup_Mips_GPREL32",      0,     32,   0 },
 235     { "fixup_Mips_SHIFT5",       6,      5,   0 },
 236     { "fixup_Mips_SHIFT6",       6,      5,   0 },
 237     { "fixup_Mips_64",           0,     64,   0 },
 238     { "fixup_Mips_TLSGD",        0,     16,   0 },
 239     { "fixup_Mips_GOTTPREL",     0,     16,   0 },
 240     { "fixup_Mips_TPREL_HI",     0,     16,   0 },
 241     { "fixup_Mips_TPREL_LO",     0,     16,   0 },
 242     { "fixup_Mips_TLSLDM",       0,     16,   0 },
 243     { "fixup_Mips_DTPREL_HI",    0,     16,   0 },
 244     { "fixup_Mips_DTPREL_LO",    0,     16,   0 },
 245     { "fixup_Mips_Branch_PCRel", 0,     16,  MCFixupKindInfo::FKF_IsPCRel },
 246     { "fixup_Mips_GPOFF_HI",     0,     16,   0 },
 247     { "fixup_Mips_GPOFF_LO",     0,     16,   0 },
 248     { "fixup_Mips_GOT_PAGE",     0,     16,   0 },
 249     { "fixup_Mips_GOT_OFST",     0,     16,   0 },
 250     { "fixup_Mips_GOT_DISP",     0,     16,   0 },
 251     { "fixup_Mips_HIGHER",       0,     16,   0 },
 252     { "fixup_Mips_HIGHEST",      0,     16,   0 },
 253     { "fixup_Mips_GOT_HI16",     0,     16,   0 },
 254     { "fixup_Mips_GOT_LO16",     0,     16,   0 },
 255     { "fixup_Mips_CALL_HI16",    0,     16,   0 },
 256     { "fixup_Mips_CALL_LO16",    0,     16,   0 },
 257     { "fixup_MIPS_PC19_S2",      0,     19,  MCFixupKindInfo::FKF_IsPCRel },
 258     { "fixup_MIPS_PC21_S2",      0,     21,  MCFixupKindInfo::FKF_IsPCRel },
 259     { "fixup_MIPS_PC26_S2",      0,     26,  MCFixupKindInfo::FKF_IsPCRel },
 260     { "fixup_MIPS_PCHI16",       0,     16,  MCFixupKindInfo::FKF_IsPCRel },
 261     { "fixup_MIPS_PCLO16",       0,     16,  MCFixupKindInfo::FKF_IsPCRel },
 262     { "fixup_MICROMIPS_26_S1",   0,     26,   0 },
 263     { "fixup_MICROMIPS_HI16",    0,     16,   0 },
 264     { "fixup_MICROMIPS_LO16",    0,     16,   0 },
 265     { "fixup_MICROMIPS_GOT16",   0,     16,   0 },
 266     { "fixup_MICROMIPS_PC16_S1", 0,     16,   MCFixupKindInfo::FKF_IsPCRel },
 267     { "fixup_MICROMIPS_CALL16",  0,     16,   0 },
 268     { "fixup_MICROMIPS_GOT_DISP",        0,     16,   0 },
 269     { "fixup_MICROMIPS_GOT_PAGE",        0,     16,   0 },
 270     { "fixup_MICROMIPS_GOT_OFST",        0,     16,   0 },
 271     { "fixup_MICROMIPS_TLS_GD",          0,     16,   0 },
 272     { "fixup_MICROMIPS_TLS_LDM",         0,     16,   0 },
 273     { "fixup_MICROMIPS_TLS_DTPREL_HI16", 0,     16,   0 },
 274     { "fixup_MICROMIPS_TLS_DTPREL_LO16", 0,     16,   0 },
 275     { "fixup_MICROMIPS_TLS_TPREL_HI16",  0,     16,   0 },
 276     { "fixup_MICROMIPS_TLS_TPREL_LO16",  0,     16,   0 }
 277   };
 278
 279   const static MCFixupKindInfo BigEndianInfos[Mips::NumTargetFixupKinds] = {
 280     // This table *must* be in same the order of fixup_* kinds in
 281     // MipsFixupKinds.h.
 282     //
 283     // name                    offset  bits  flags
 284     { "fixup_Mips_16",          16,     16,   0 },
 285     { "fixup_Mips_32",           0,     32,   0 },
 286     { "fixup_Mips_REL32",        0,     32,   0 },
 287     { "fixup_Mips_26",           6,     26,   0 },
 288     { "fixup_Mips_HI16",        16,     16,   0 },
 289     { "fixup_Mips_LO16",        16,     16,   0 },
 290     { "fixup_Mips_GPREL16",     16,     16,   0 },
 291     { "fixup_Mips_LITERAL",     16,     16,   0 },
 292     { "fixup_Mips_GOT_Global",  16,     16,   0 },
 293     { "fixup_Mips_GOT_Local",   16,     16,   0 },
 294     { "fixup_Mips_PC16",        16,     16,  MCFixupKindInfo::FKF_IsPCRel },
 295     { "fixup_Mips_CALL16",      16,     16,   0 },
 296     { "fixup_Mips_GPREL32",      0,     32,   0 },
 297     { "fixup_Mips_SHIFT5",      21,      5,   0 },
 298     { "fixup_Mips_SHIFT6",      21,      5,   0 },
 299     { "fixup_Mips_64",           0,     64,   0 },
 300     { "fixup_Mips_TLSGD",       16,     16,   0 },
 301     { "fixup_Mips_GOTTPREL",    16,     16,   0 },
 302     { "fixup_Mips_TPREL_HI",    16,     16,   0 },
 303     { "fixup_Mips_TPREL_LO",    16,     16,   0 },
 304     { "fixup_Mips_TLSLDM",      16,     16,   0 },
 305     { "fixup_Mips_DTPREL_HI",   16,     16,   0 },
 306     { "fixup_Mips_DTPREL_LO",   16,     16,   0 },
 307     { "fixup_Mips_Branch_PCRel",16,     16,  MCFixupKindInfo::FKF_IsPCRel },
 308     { "fixup_Mips_GPOFF_HI",    16,     16,   0 },
 309     { "fixup_Mips_GPOFF_LO",    16,     16,   0 },
 310     { "fixup_Mips_GOT_PAGE",    16,     16,   0 },
 311     { "fixup_Mips_GOT_OFST",    16,     16,   0 },
 312     { "fixup_Mips_GOT_DISP",    16,     16,   0 },
 313     { "fixup_Mips_HIGHER",      16,     16,   0 },
 314     { "fixup_Mips_HIGHEST",     16,     16,   0 },
 315     { "fixup_Mips_GOT_HI16",    16,     16,   0 },
 316     { "fixup_Mips_GOT_LO16",    16,     16,   0 },
 317     { "fixup_Mips_CALL_HI16",   16,     16,   0 },
 318     { "fixup_Mips_CALL_LO16",   16,     16,   0 },
 319     { "fixup_MIPS_PC19_S2",     13,     19,  MCFixupKindInfo::FKF_IsPCRel },
 320     { "fixup_MIPS_PC21_S2",     11,     21,  MCFixupKindInfo::FKF_IsPCRel },
 321     { "fixup_MIPS_PC26_S2",      6,     26,  MCFixupKindInfo::FKF_IsPCRel },
 322     { "fixup_MIPS_PCHI16",      16,     16,  MCFixupKindInfo::FKF_IsPCRel },
 323     { "fixup_MIPS_PCLO16",      16,     16,  MCFixupKindInfo::FKF_IsPCRel },
 324     { "fixup_MICROMIPS_26_S1",   6,     26,   0 },
 325     { "fixup_MICROMIPS_HI16",   16,     16,   0 },
 326     { "fixup_MICROMIPS_LO16",   16,     16,   0 },
 327     { "fixup_MICROMIPS_GOT16",  16,     16,   0 },
 328     { "fixup_MICROMIPS_PC16_S1",16,     16,   MCFixupKindInfo::FKF_IsPCRel },
 329     { "fixup_MICROMIPS_CALL16", 16,     16,   0 },
 330     { "fixup_MICROMIPS_GOT_DISP",        16,     16,   0 },
 331     { "fixup_MICROMIPS_GOT_PAGE",        16,     16,   0 },
 332     { "fixup_MICROMIPS_GOT_OFST",        16,     16,   0 },
 333     { "fixup_MICROMIPS_TLS_GD",          16,     16,   0 },
 334     { "fixup_MICROMIPS_TLS_LDM",         16,     16,   0 },
 335     { "fixup_MICROMIPS_TLS_DTPREL_HI16", 16,     16,   0 },
 336     { "fixup_MICROMIPS_TLS_DTPREL_LO16", 16,     16,   0 },
 337     { "fixup_MICROMIPS_TLS_TPREL_HI16",  16,     16,   0 },
 338     { "fixup_MICROMIPS_TLS_TPREL_LO16",  16,     16,   0 }
 339   };
 340
 341   if (Kind < FirstTargetFixupKind)
 342     return MCAsmBackend::getFixupKindInfo(Kind);
 343
 344   assert(unsigned(Kind - FirstTargetFixupKind) < getNumFixupKinds() &&
 345           "Invalid kind!");
 346
 347   if (IsLittle)
 348     return LittleEndianInfos[Kind - FirstTargetFixupKind];
 349   return BigEndianInfos[Kind - FirstTargetFixupKind];
 350 }
 351
 352 /// WriteNopData - Write an (optimal) nop sequence of Count bytes
 353 /// to the given output. If the target cannot generate such a sequence,
 354 /// it should return an error.
 355 ///
 356 /// \return - True on success.
 357 bool MipsAsmBackend::writeNopData(uint64_t Count, MCObjectWriter *OW) const {
 358   // Check for a less than instruction size number of bytes
 359   // FIXME: 16 bit instructions are not handled yet here.
 360   // We shouldn't be using a hard coded number for instruction size.
 361   if (Count % 4) return false;
 362
 363   uint64_t NumNops = Count / 4;
 364   for (uint64_t i = 0; i != NumNops; ++i)
 365     OW->Write32(0);
 366   return true;
 367 }
 368
 369 /// processFixupValue - Target hook to process the literal value of a fixup
 370 /// if necessary.
 371 void MipsAsmBackend::processFixupValue(const MCAssembler &Asm,
 372                                        const MCAsmLayout &Layout,
 373                                        const MCFixup &Fixup,
 374                                        const MCFragment *DF,
 375                                        const MCValue &Target,
 376                                        uint64_t &Value,
 377                                        bool &IsResolved) {
 378   // At this point we'll ignore the value returned by adjustFixupValue as
 379   // we are only checking if the fixup can be applied correctly. We have
 380   // access to MCContext from here which allows us to report a fatal error
 381   // with *possibly* a source code location.
 382   (void)adjustFixupValue(Fixup, Value, &Asm.getContext());
 383 }
 384
 385 // MCAsmBackend
 386 MCAsmBackend *llvm::createMipsAsmBackendEL32(const Target &T,
 387                                              const MCRegisterInfo &MRI,
 388                                              StringRef TT,
 389                                              StringRef CPU) {
 390   return new MipsAsmBackend(T, Triple(TT).getOS(),
 391                             /*IsLittle*/true, /*Is64Bit*/false);
 392 }
 393
 394 MCAsmBackend *llvm::createMipsAsmBackendEB32(const Target &T,
 395                                              const MCRegisterInfo &MRI,
 396                                              StringRef TT,
 397                                              StringRef CPU) {
 398   return new MipsAsmBackend(T, Triple(TT).getOS(),
 399                             /*IsLittle*/false, /*Is64Bit*/false);
 400 }
 401
 402 MCAsmBackend *llvm::createMipsAsmBackendEL64(const Target &T,
 403                                              const MCRegisterInfo &MRI,
 404                                              StringRef TT,
 405                                              StringRef CPU) {
 406   return new MipsAsmBackend(T, Triple(TT).getOS(),
 407                             /*IsLittle*/true, /*Is64Bit*/true);
 408 }
 409
 410 MCAsmBackend *llvm::createMipsAsmBackendEB64(const Target &T,
 411                                              const MCRegisterInfo &MRI,
 412                                              StringRef TT,
 413                                              StringRef CPU) {
 414   return new MipsAsmBackend(T, Triple(TT).getOS(),
 415                             /*IsLittle*/false, /*Is64Bit*/true);
 416 }