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