lib/Target/PowerPC/PPCJITInfo.cpp

   1 //===-- PPCJITInfo.cpp - Implement the JIT interfaces for the PowerPC -----===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the JIT interfaces for the 32-bit PowerPC target.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "jit"
  15 #include "PPCJITInfo.h"
  16 #include "PPCRelocations.h"
  17 #include "llvm/CodeGen/MachineCodeEmitter.h"
  18 #include "llvm/Config/alloca.h"
  19 #include "llvm/Support/Debug.h"
  20 #include <set>
  21 #include <iostream>
  22 using namespace llvm;
  23
  24 static TargetJITInfo::JITCompilerFn JITCompilerFunction;
  25
  26 #define BUILD_ADDIS(RD,RS,IMM16) \
  27   ((15 << 26) | ((RD) << 21) | ((RS) << 16) | ((IMM16) & 65535))
  28 #define BUILD_ORI(RD,RS,UIMM16) \
  29   ((24 << 26) | ((RS) << 21) | ((RD) << 16) | ((UIMM16) & 65535))
  30 #define BUILD_ORIS(RD,RS,UIMM16) \
  31   ((25 << 26) | ((RS) << 21) | ((RD) << 16) | ((UIMM16) & 65535))
  32 #define BUILD_RLDICR(RD,RS,SH,ME) \
  33   ((30 << 26) | ((RS) << 21) | ((RD) << 16) | (((SH) & 31) << 11) | \
  34    (((ME) & 63) << 6) | (1 << 3) | (((SH) >> 5) & 1))
  35 #define BUILD_MTSPR(RS,SPR)      \
  36   ((31 << 26) | ((RS) << 21) | ((SPR) << 16) | (467 << 1))
  37 #define BUILD_BCCTRx(BO,BI,LINK) \
  38   ((19 << 26) | ((BO) << 21) | ((BI) << 16) | (528 << 1) | ((LINK) & 1))
  39 #define BUILD_B(TARGET, LINK) \
  40   ((18 << 26) | (((TARGET) & 0x00FFFFFF) << 2) | ((LINK) & 1))
  41
  42 // Pseudo-ops
  43 #define BUILD_LIS(RD,IMM16)    BUILD_ADDIS(RD,0,IMM16)
  44 #define BUILD_SLDI(RD,RS,IMM6) BUILD_RLDICR(RD,RS,IMM6,63-IMM6)
  45 #define BUILD_MTCTR(RS)        BUILD_MTSPR(RS,9)
  46 #define BUILD_BCTR(LINK)       BUILD_BCCTRx(20,0,LINK)
  47
  48 static void EmitBranchToAt(uint64_t At, uint64_t To, bool isCall, bool is64Bit){
  49   intptr_t Offset = ((intptr_t)To - (intptr_t)At) >> 2;
  50   unsigned *AtI = (unsigned*)(intptr_t)At;
  51
  52   if (Offset >= -(1 << 23) && Offset < (1 << 23)) {   // In range?
  53     AtI[0] = BUILD_B(Offset, isCall);     // b/bl target
  54   } else if (!is64Bit) {
  55     AtI[0] = BUILD_LIS(12, To >> 16);     // lis r12, hi16(address)
  56     AtI[1] = BUILD_ORI(12, 12, To);       // ori r12, r12, lo16(address)
  57     AtI[2] = BUILD_MTCTR(12);             // mtctr r12
  58     AtI[3] = BUILD_BCTR(isCall);          // bctr/bctrl
  59   } else {
  60     AtI[0] = BUILD_LIS(12, To >> 48);      // lis r12, hi16(address)
  61     AtI[1] = BUILD_ORI(12, 12, To >> 32);  // ori r12, r12, lo16(address)
  62     AtI[2] = BUILD_SLDI(12, 12, 32);       // sldi r12, r12, 32
  63     AtI[3] = BUILD_ORIS(12, 12, To >> 16); // oris r12, r12, hi16(address)
  64     AtI[4] = BUILD_ORI(12, 12, To);        // ori r12, r12, lo16(address)
  65     AtI[5] = BUILD_MTCTR(12);              // mtctr r12
  66     AtI[6] = BUILD_BCTR(isCall);           // bctr/bctrl
  67   }
  68 }
  69
  70 extern "C" void PPC32CompilationCallback();
  71 extern "C" void PPC64CompilationCallback();
  72
  73 #if (defined(__POWERPC__) || defined (__ppc__) || defined(_POWER)) && !defined(__ppc64__)
  74 // CompilationCallback stub - We can't use a C function with inline assembly in
  75 // it, because we the prolog/epilog inserted by GCC won't work for us.  Instead,
  76 // write our own wrapper, which does things our way, so we have complete control
  77 // over register saving and restoring.
  78 asm(
  79     ".text\n"
  80     ".align 2\n"
  81     ".globl _PPC32CompilationCallback\n"
  82 "_PPC32CompilationCallback:\n"
  83     // Make space for 8 ints r[3-10] and 13 doubles f[1-13] and the
  84     // FIXME: need to save v[0-19] for altivec?
  85     // FIXME: could shrink frame
  86     // Set up a proper stack frame
  87     "stwu r1, -208(r1)\n"
  88     "mflr r0\n"
  89     "stw r0,  216(r1)\n"
  90     // Save all int arg registers
  91     "stw r10, 204(r1)\n"    "stw r9,  200(r1)\n"
  92     "stw r8,  196(r1)\n"    "stw r7,  192(r1)\n"
  93     "stw r6,  188(r1)\n"    "stw r5,  184(r1)\n"
  94     "stw r4,  180(r1)\n"    "stw r3,  176(r1)\n"
  95     // Save all call-clobbered FP regs.
  96     "stfd f13, 168(r1)\n"   "stfd f12, 160(r1)\n"
  97     "stfd f11, 152(r1)\n"   "stfd f10, 144(r1)\n"
  98     "stfd f9,  136(r1)\n"   "stfd f8,  128(r1)\n"
  99     "stfd f7,  120(r1)\n"   "stfd f6,  112(r1)\n"
 100     "stfd f5,  104(r1)\n"   "stfd f4,   96(r1)\n"
 101     "stfd f3,   88(r1)\n"   "stfd f2,   80(r1)\n"
 102     "stfd f1,   72(r1)\n"
 103     // Arguments to Compilation Callback:
 104     // r3 - our lr (address of the call instruction in stub plus 4)
 105     // r4 - stub's lr (address of instruction that called the stub plus 4)
 106     "mr   r3, r0\n"
 107     "lwz  r2, 208(r1)\n" // stub's frame
 108     "lwz  r4, 8(r2)\n" // stub's lr
 109     "li   r5, 0\n"       // 0 == 32 bit
 110     "bl _PPCCompilationCallbackC\n"
 111     "mtctr r3\n"
 112     // Restore all int arg registers
 113     "lwz r10, 204(r1)\n"    "lwz r9,  200(r1)\n"
 114     "lwz r8,  196(r1)\n"    "lwz r7,  192(r1)\n"
 115     "lwz r6,  188(r1)\n"    "lwz r5,  184(r1)\n"
 116     "lwz r4,  180(r1)\n"    "lwz r3,  176(r1)\n"
 117     // Restore all FP arg registers
 118     "lfd f13, 168(r1)\n"    "lfd f12, 160(r1)\n"
 119     "lfd f11, 152(r1)\n"    "lfd f10, 144(r1)\n"
 120     "lfd f9,  136(r1)\n"    "lfd f8,  128(r1)\n"
 121     "lfd f7,  120(r1)\n"    "lfd f6,  112(r1)\n"
 122     "lfd f5,  104(r1)\n"    "lfd f4,   96(r1)\n"
 123     "lfd f3,   88(r1)\n"    "lfd f2,   80(r1)\n"
 124     "lfd f1,   72(r1)\n"
 125     // Pop 3 frames off the stack and branch to target
 126     "lwz  r1, 208(r1)\n"
 127     "lwz  r2, 8(r1)\n"
 128     "mtlr r2\n"
 129     "bctr\n"
 130     );
 131 #else
 132 void PPC32CompilationCallback() {
 133   assert(0 && "This is not a power pc, you can't execute this!");
 134   abort();
 135 }
 136 #endif
 137
 138 #if (defined(__POWERPC__) || defined (__ppc__) || defined(_POWER)) && defined(__ppc64__)
 139 asm(
 140     ".text\n"
 141     ".align 2\n"
 142     ".globl _PPC64CompilationCallback\n"
 143 "_PPC64CompilationCallback:\n"
 144     // Make space for 8 ints r[3-10] and 13 doubles f[1-13] and the
 145     // FIXME: need to save v[0-19] for altivec?
 146     // Set up a proper stack frame
 147     "stdu r1, -208(r1)\n"
 148     "mflr r0\n"
 149     "std r0,  224(r1)\n"
 150     // Save all int arg registers
 151     "std r10, 200(r1)\n"    "std r9,  192(r1)\n"
 152     "std r8,  184(r1)\n"    "std r7,  176(r1)\n"
 153     "std r6,  168(r1)\n"    "std r5,  160(r1)\n"
 154     "std r4,  152(r1)\n"    "std r3,  144(r1)\n"
 155     // Save all call-clobbered FP regs.
 156     "stfd f13, 136(r1)\n"   "stfd f12, 128(r1)\n"
 157     "stfd f11, 120(r1)\n"   "stfd f10, 112(r1)\n"
 158     "stfd f9,  104(r1)\n"   "stfd f8,   96(r1)\n"
 159     "stfd f7,   88(r1)\n"   "stfd f6,   80(r1)\n"
 160     "stfd f5,   72(r1)\n"   "stfd f4,   64(r1)\n"
 161     "stfd f3,   56(r1)\n"   "stfd f2,   48(r1)\n"
 162     "stfd f1,   40(r1)\n"
 163     // Arguments to Compilation Callback:
 164     // r3 - our lr (address of the call instruction in stub plus 4)
 165     // r4 - stub's lr (address of instruction that called the stub plus 4)
 166     "mr   r3, r0\n"
 167     "ld   r2, 208(r1)\n" // stub's frame
 168     "ld   r4, 16(r2)\n"  // stub's lr
 169     "li   r5, 1\n"       // 1 == 64 bit
 170     "bl _PPCCompilationCallbackC\n"
 171     "mtctr r3\n"
 172     // Restore all int arg registers
 173     "ld r10, 200(r1)\n"    "ld r9,  192(r1)\n"
 174     "ld r8,  184(r1)\n"    "ld r7,  176(r1)\n"
 175     "ld r6,  168(r1)\n"    "ld r5,  160(r1)\n"
 176     "ld r4,  152(r1)\n"    "ld r3,  144(r1)\n"
 177     // Restore all FP arg registers
 178     "lfd f13, 136(r1)\n"    "lfd f12, 128(r1)\n"
 179     "lfd f11, 120(r1)\n"    "lfd f10, 112(r1)\n"
 180     "lfd f9,  104(r1)\n"    "lfd f8,   96(r1)\n"
 181     "lfd f7,   88(r1)\n"    "lfd f6,   80(r1)\n"
 182     "lfd f5,   72(r1)\n"    "lfd f4,   64(r1)\n"
 183     "lfd f3,   56(r1)\n"    "lfd f2,   48(r1)\n"
 184     "lfd f1,   40(r1)\n"
 185     // Pop 3 frames off the stack and branch to target
 186     "ld  r1, 208(r1)\n"
 187     "ld  r2, 16(r1)\n"
 188     "mtlr r2\n"
 189     "bctr\n"
 190     );
 191 #else
 192 void PPC64CompilationCallback() {
 193   assert(0 && "This is not a power pc, you can't execute this!");
 194   abort();
 195 }
 196 #endif
 197
 198 extern "C" void *PPCCompilationCallbackC(unsigned *StubCallAddrPlus4,
 199                                          unsigned *OrigCallAddrPlus4,
 200                                          bool is64Bit) {
 201   // Adjust the pointer to the address of the call instruction in the stub
 202   // emitted by emitFunctionStub, rather than the instruction after it.
 203   unsigned *StubCallAddr = StubCallAddrPlus4 - 1;
 204   unsigned *OrigCallAddr = OrigCallAddrPlus4 - 1;
 205
 206   void *Target = JITCompilerFunction(StubCallAddr);
 207
 208   // Check to see if *OrigCallAddr is a 'bl' instruction, and if we can rewrite
 209   // it to branch directly to the destination.  If so, rewrite it so it does not
 210   // need to go through the stub anymore.
 211   unsigned OrigCallInst = *OrigCallAddr;
 212   if ((OrigCallInst >> 26) == 18) {     // Direct call.
 213     intptr_t Offset = ((intptr_t)Target - (intptr_t)OrigCallAddr) >> 2;
 214
 215     if (Offset >= -(1 << 23) && Offset < (1 << 23)) {   // In range?
 216       // Clear the original target out.
 217       OrigCallInst &= (63 << 26) | 3;
 218       // Fill in the new target.
 219       OrigCallInst |= (Offset & ((1 << 24)-1)) << 2;
 220       // Replace the call.
 221       *OrigCallAddr = OrigCallInst;
 222     }
 223   }
 224
 225   // Assert that we are coming from a stub that was created with our
 226   // emitFunctionStub.
 227   if ((*StubCallAddr >> 26) == 18)
 228     StubCallAddr -= 3;
 229   else {
 230   assert((*StubCallAddr >> 26) == 19 && "Call in stub is not indirect!");
 231     StubCallAddr -= is64Bit ? 9 : 6;
 232   }
 233
 234   // Rewrite the stub with an unconditional branch to the target, for any users
 235   // who took the address of the stub.
 236   EmitBranchToAt((intptr_t)StubCallAddr, (intptr_t)Target, false, is64Bit);
 237
 238   // Put the address of the target function to call and the address to return to
 239   // after calling the target function in a place that is easy to get on the
 240   // stack after we restore all regs.
 241   return Target;
 242 }
 243
 244
 245
 246 TargetJITInfo::LazyResolverFn
 247 PPCJITInfo::getLazyResolverFunction(JITCompilerFn Fn) {
 248   JITCompilerFunction = Fn;
 249   return is64Bit ? PPC64CompilationCallback : PPC32CompilationCallback;
 250 }
 251
 252 void *PPCJITInfo::emitFunctionStub(void *Fn, MachineCodeEmitter &MCE) {
 253   // If this is just a call to an external function, emit a branch instead of a
 254   // call.  The code is the same except for one bit of the last instruction.
 255   if (Fn != (void*)(intptr_t)PPC32CompilationCallback &&
 256       Fn != (void*)(intptr_t)PPC64CompilationCallback) {
 257     MCE.startFunctionStub(7*4);
 258     intptr_t Addr = (intptr_t)MCE.getCurrentPCValue();
 259     MCE.emitWordBE(0);
 260     MCE.emitWordBE(0);
 261     MCE.emitWordBE(0);
 262     MCE.emitWordBE(0);
 263     MCE.emitWordBE(0);
 264     MCE.emitWordBE(0);
 265     MCE.emitWordBE(0);
 266     EmitBranchToAt(Addr, (intptr_t)Fn, false, is64Bit);
 267     return MCE.finishFunctionStub(0);
 268   }
 269
 270   MCE.startFunctionStub(10*4);
 271   if (is64Bit) {
 272     MCE.emitWordBE(0xf821ffb1);     // stdu r1,-80(r1)
 273     MCE.emitWordBE(0x7d6802a6);     // mflr r11
 274     MCE.emitWordBE(0xf9610060);     // std r11, 96(r1)
 275   } else {
 276     MCE.emitWordBE(0x9421ffe0);     // stwu r1,-32(r1)
 277     MCE.emitWordBE(0x7d6802a6);     // mflr r11
 278     MCE.emitWordBE(0x91610028);     // stw r11, 40(r1)
 279   }
 280   intptr_t Addr = (intptr_t)MCE.getCurrentPCValue();
 281   MCE.emitWordBE(0);
 282   MCE.emitWordBE(0);
 283   MCE.emitWordBE(0);
 284   MCE.emitWordBE(0);
 285   MCE.emitWordBE(0);
 286   MCE.emitWordBE(0);
 287   MCE.emitWordBE(0);
 288   EmitBranchToAt(Addr, (intptr_t)Fn, true, is64Bit);
 289   return MCE.finishFunctionStub(0);
 290 }
 291
 292
 293 void PPCJITInfo::relocate(void *Function, MachineRelocation *MR,
 294                           unsigned NumRelocs, unsigned char* GOTBase) {
 295   for (unsigned i = 0; i != NumRelocs; ++i, ++MR) {
 296     unsigned *RelocPos = (unsigned*)Function + MR->getMachineCodeOffset()/4;
 297     intptr_t ResultPtr = (intptr_t)MR->getResultPointer();
 298     switch ((PPC::RelocationType)MR->getRelocationType()) {
 299     default: assert(0 && "Unknown relocation type!");
 300     case PPC::reloc_pcrel_bx:
 301       // PC-relative relocation for b and bl instructions.
 302       ResultPtr = (ResultPtr-(intptr_t)RelocPos) >> 2;
 303       assert(ResultPtr >= -(1 << 23) && ResultPtr < (1 << 23) &&
 304              "Relocation out of range!");
 305       *RelocPos |= (ResultPtr & ((1 << 24)-1))  << 2;
 306       break;
 307     case PPC::reloc_pcrel_bcx:
 308       // PC-relative relocation for BLT,BLE,BEQ,BGE,BGT,BNE, or other
 309       // bcx instructions.
 310       ResultPtr = (ResultPtr-(intptr_t)RelocPos) >> 2;
 311       assert(ResultPtr >= -(1 << 13) && ResultPtr < (1 << 13) &&
 312              "Relocation out of range!");
 313       *RelocPos |= (ResultPtr & ((1 << 14)-1))  << 2;
 314       break;
 315     case PPC::reloc_absolute_high:     // high bits of ref -> low 16 of instr
 316     case PPC::reloc_absolute_low: {    // low bits of ref  -> low 16 of instr
 317       ResultPtr += MR->getConstantVal();
 318
 319       // If this is a high-part access, get the high-part.
 320       if (MR->getRelocationType() == PPC::reloc_absolute_high) {
 321         // If the low part will have a carry (really a borrow) from the low
 322         // 16-bits into the high 16, add a bit to borrow from.
 323         if (((int)ResultPtr << 16) < 0)
 324           ResultPtr += 1 << 16;
 325         ResultPtr >>= 16;
 326       }
 327
 328       // Do the addition then mask, so the addition does not overflow the 16-bit
 329       // immediate section of the instruction.
 330       unsigned LowBits  = (*RelocPos + ResultPtr) & 65535;
 331       unsigned HighBits = *RelocPos & ~65535;
 332       *RelocPos = LowBits | HighBits;  // Slam into low 16-bits
 333       break;
 334     }
 335     case PPC::reloc_absolute_low_ix: {  // low bits of ref  -> low 14 of instr
 336       ResultPtr += MR->getConstantVal();
 337       // Do the addition then mask, so the addition does not overflow the 16-bit
 338       // immediate section of the instruction.
 339       unsigned LowBits  = (*RelocPos + ResultPtr) & 0xFFFC;
 340       unsigned HighBits = *RelocPos & 0xFFFF0003;
 341       *RelocPos = LowBits | HighBits;  // Slam into low 14-bits.
 342       break;
 343     }
 344     }
 345   }
 346 }
 347
 348 void PPCJITInfo::replaceMachineCodeForFunction(void *Old, void *New) {
 349   EmitBranchToAt((intptr_t)Old, (intptr_t)New, false, is64Bit);
 350 }