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