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 and MipsELFObjectWriter classes.
  11 //
  12 //===----------------------------------------------------------------------===//
  13 //
  14
  15 #include "MipsFixupKinds.h"
  16 #include "MCTargetDesc/MipsMCTargetDesc.h"
  17 #include "llvm/MC/MCAsmBackend.h"
  18 #include "llvm/MC/MCAssembler.h"
  19 #include "llvm/MC/MCDirectives.h"
  20 #include "llvm/MC/MCELFObjectWriter.h"
  21 #include "llvm/MC/MCFixupKindInfo.h"
  22 #include "llvm/MC/MCObjectWriter.h"
  23 #include "llvm/MC/MCSubtargetInfo.h"
  24 #include "llvm/Support/ErrorHandling.h"
  25 #include "llvm/Support/raw_ostream.h"
  26
  27 using namespace llvm;
  28
  29 // Prepare value for the target space for it
  30 static unsigned adjustFixupValue(unsigned Kind, uint64_t Value) {
  31
  32   // Add/subtract and shift
  33   switch (Kind) {
  34   default:
  35     return 0;
  36   case FK_GPRel_4:
  37   case FK_Data_4:
  38   case Mips::fixup_Mips_LO16:
  39     break;
  40   case Mips::fixup_Mips_PC16:
  41     // So far we are only using this type for branches.
  42     // For branches we start 1 instruction after the branch
  43     // so the displacement will be one instruction size less.
  44     Value -= 4;
  45     // The displacement is then divided by 4 to give us an 18 bit
  46     // address range.
  47     Value >>= 2;
  48     break;
  49   case Mips::fixup_Mips_26:
  50     // So far we are only using this type for jumps.
  51     // The displacement is then divided by 4 to give us an 28 bit
  52     // address range.
  53     Value >>= 2;
  54     break;
  55   case Mips::fixup_Mips_HI16:
  56   case Mips::fixup_Mips_GOT_Local:
  57     // Get the higher 16-bits. Also add 1 if bit 15 is 1.
  58     Value = ((Value + 0x8000) >> 16) & 0xffff;
  59     break;
  60   }
  61
  62   return Value;
  63 }
  64
  65 namespace {
  66 class MipsAsmBackend : public MCAsmBackend {
  67   Triple::OSType OSType;
  68   bool IsLittle; // Big or little endian
  69
  70 public:
  71   MipsAsmBackend(const Target &T,  Triple::OSType _OSType, bool _isLittle) :
  72     MCAsmBackend(), OSType(_OSType), IsLittle(_isLittle) {}
  73
  74   MCObjectWriter *createObjectWriter(raw_ostream &OS) const {
  75     return createMipsELFObjectWriter(OS, OSType, IsLittle);
  76   }
  77
  78   /// ApplyFixup - Apply the \arg Value for given \arg Fixup into the provided
  79   /// data fragment, at the offset specified by the fixup and following the
  80   /// fixup kind as appropriate.
  81   void applyFixup(const MCFixup &Fixup, char *Data, unsigned DataSize,
  82                   uint64_t Value) const {
  83     MCFixupKind Kind = Fixup.getKind();
  84     Value = adjustFixupValue((unsigned)Kind, Value);
  85
  86     if (!Value)
  87       return; // Doesn't change encoding.
  88
  89     // Where do we start in the object
  90     unsigned Offset = Fixup.getOffset();
  91     // Number of bytes we need to fixup
  92     unsigned NumBytes = (getFixupKindInfo(Kind).TargetSize + 7) / 8;
  93     // Used to point to big endian bytes
  94     unsigned FullSize;
  95
  96     switch ((unsigned)Kind) {
  97     case Mips::fixup_Mips_16:
  98       FullSize = 2;
  99       break;
 100     case Mips::fixup_Mips_64:
 101       FullSize = 8;
 102       break;
 103     default:
 104       FullSize = 4;
 105       break;
 106     }
 107
 108     // Grab current value, if any, from bits.
 109     uint64_t CurVal = 0;
 110
 111     for (unsigned i = 0; i != NumBytes; ++i) {
 112       unsigned Idx = IsLittle ? i : (FullSize - 1 - i);
 113       CurVal |= (uint64_t)((uint8_t)Data[Offset + Idx]) << (i*8);
 114     }
 115
 116     uint64_t Mask = ((uint64_t)(-1) >> (64 - getFixupKindInfo(Kind).TargetSize));
 117     CurVal = (CurVal & ~Mask) | ((CurVal + Value) & Mask);
 118
 119     // Write out the fixed up bytes back to the code/data bits.
 120     for (unsigned i = 0; i != NumBytes; ++i) {
 121       unsigned Idx = IsLittle ? i : (FullSize - 1 - i);
 122       Data[Offset + Idx] = (uint8_t)((CurVal >> (i*8)) & 0xff);
 123     }
 124   }
 125
 126   unsigned getNumFixupKinds() const { return Mips::NumTargetFixupKinds; }
 127
 128   const MCFixupKindInfo &getFixupKindInfo(MCFixupKind Kind) const {
 129     const static MCFixupKindInfo Infos[Mips::NumTargetFixupKinds] = {
 130       // This table *must* be in same the order of fixup_* kinds in
 131       // MipsFixupKinds.h.
 132       //
 133       // name                    offset  bits  flags
 134       { "fixup_Mips_16",           0,     16,   0 },
 135       { "fixup_Mips_32",           0,     32,   0 },
 136       { "fixup_Mips_REL32",        0,     32,   0 },
 137       { "fixup_Mips_26",           0,     26,   0 },
 138       { "fixup_Mips_HI16",         0,     16,   0 },
 139       { "fixup_Mips_LO16",         0,     16,   0 },
 140       { "fixup_Mips_GPREL16",      0,     16,   0 },
 141       { "fixup_Mips_LITERAL",      0,     16,   0 },
 142       { "fixup_Mips_GOT_Global",   0,     16,   0 },
 143       { "fixup_Mips_GOT_Local",    0,     16,   0 },
 144       { "fixup_Mips_PC16",         0,     16,  MCFixupKindInfo::FKF_IsPCRel },
 145       { "fixup_Mips_CALL16",       0,     16,   0 },
 146       { "fixup_Mips_GPREL32",      0,     32,   0 },
 147       { "fixup_Mips_SHIFT5",       6,      5,   0 },
 148       { "fixup_Mips_SHIFT6",       6,      5,   0 },
 149       { "fixup_Mips_64",           0,     64,   0 },
 150       { "fixup_Mips_TLSGD",        0,     16,   0 },
 151       { "fixup_Mips_GOTTPREL",     0,     16,   0 },
 152       { "fixup_Mips_TPREL_HI",     0,     16,   0 },
 153       { "fixup_Mips_TPREL_LO",     0,     16,   0 },
 154       { "fixup_Mips_TLSLDM",       0,     16,   0 },
 155       { "fixup_Mips_DTPREL_HI",    0,     16,   0 },
 156       { "fixup_Mips_DTPREL_LO",    0,     16,   0 },
 157       { "fixup_Mips_Branch_PCRel", 0,     16,  MCFixupKindInfo::FKF_IsPCRel }
 158     };
 159
 160     if (Kind < FirstTargetFixupKind)
 161       return MCAsmBackend::getFixupKindInfo(Kind);
 162
 163     assert(unsigned(Kind - FirstTargetFixupKind) < getNumFixupKinds() &&
 164            "Invalid kind!");
 165     return Infos[Kind - FirstTargetFixupKind];
 166   }
 167
 168   /// @name Target Relaxation Interfaces
 169   /// @{
 170
 171   /// MayNeedRelaxation - Check whether the given instruction may need
 172   /// relaxation.
 173   ///
 174   /// \param Inst - The instruction to test.
 175   bool mayNeedRelaxation(const MCInst &Inst) const {
 176     return false;
 177   }
 178
 179   /// fixupNeedsRelaxation - Target specific predicate for whether a given
 180   /// fixup requires the associated instruction to be relaxed.
 181   bool fixupNeedsRelaxation(const MCFixup &Fixup,
 182                             uint64_t Value,
 183                             const MCInstFragment *DF,
 184                             const MCAsmLayout &Layout) const {
 185     // FIXME.
 186     assert(0 && "RelaxInstruction() unimplemented");
 187     return false;
 188   }
 189
 190   /// RelaxInstruction - Relax the instruction in the given fragment
 191   /// to the next wider instruction.
 192   ///
 193   /// \param Inst - The instruction to relax, which may be the same
 194   /// as the output.
 195   /// \parm Res [output] - On return, the relaxed instruction.
 196   void relaxInstruction(const MCInst &Inst, MCInst &Res) const {
 197   }
 198
 199   /// @}
 200
 201   /// WriteNopData - Write an (optimal) nop sequence of Count bytes
 202   /// to the given output. If the target cannot generate such a sequence,
 203   /// it should return an error.
 204   ///
 205   /// \return - True on success.
 206   bool writeNopData(uint64_t Count, MCObjectWriter *OW) const {
 207     return true;
 208   }
 209 };
 210
 211 } // namespace
 212
 213 // MCAsmBackend
 214 MCAsmBackend *llvm::createMipsAsmBackendEL(const Target &T, StringRef TT) {
 215   return new MipsAsmBackend(T, Triple(TT).getOS(),
 216                             /*IsLittle*/true);
 217 }
 218
 219 MCAsmBackend *llvm::createMipsAsmBackendEB(const Target &T, StringRef TT) {
 220   return new MipsAsmBackend(T, Triple(TT).getOS(),
 221                             /*IsLittle*/false);
 222 }