hphp/runtime/vm/jit/abi.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-2016 Facebook, Inc. (http://www.facebook.com)     |
   6    +----------------------------------------------------------------------+
   7    | This source file is subject to version 3.01 of the PHP license,      |
   8    | that is bundled with this package in the file LICENSE, and is        |
   9    | available through the world-wide-web at the following url:           |
  10    | http://www.php.net/license/3_01.txt                                  |
  11    | If you did not receive a copy of the PHP license and are unable to   |
  12    | obtain it through the world-wide-web, please send a note to          |
  13    | license@php.net so we can mail you a copy immediately.               |
  14    +----------------------------------------------------------------------+
  15 */
  16
  17 #ifndef incl_HPHP_JIT_ABI_H
  18 #define incl_HPHP_JIT_ABI_H
  19
  20 #include "hphp/runtime/vm/jit/types.h"
  21 #include "hphp/runtime/vm/jit/abi-regs.h"
  22 #include "hphp/runtime/vm/jit/phys-reg.h"
  23
  24 namespace HPHP { namespace jit {
  25
  26 ///////////////////////////////////////////////////////////////////////////////
  27
  28 /*
  29  * Return a suitable ABI for the targeted architecture and `kind'.
  30  */
  31 const Abi& abi(CodeKind kind = CodeKind::Trace);
  32
  33
  34 ///////////////////////////////////////////////////////////////////////////////
  35 // Principal reserved registers.
  36 //
  37 // These registers have special purposes both during and between traces.
  38
  39 /*
  40  * Frame pointer.
  41  *
  42  * When mid-trace, points to the ActRec for the function currently executing.
  43  */
  44 PhysReg rvmfp();
  45
  46 /*
  47  * Stack pointer.
  48  *
  49  * When mid-trace, points to the top of the eval stack (lowest valid address)
  50  * at the start of the current tracelet.
  51  */
  52 PhysReg rvmsp();
  53
  54 /*
  55  * RDS base pointer.
  56  *
  57  * Always points to the base of the RDS block for the current request.
  58  */
  59 PhysReg rvmtl();
  60
  61 /*
  62  * Native stack pointer.
  63  */
  64 PhysReg rsp();
  65
  66
  67 ///////////////////////////////////////////////////////////////////////////////
  68 // JIT and TC boundary ABI registers.
  69 //
  70 // These registers should not be used for scratch purposes between tracelets,
  71 // and have to be specially handled if we are returning to the interpreter or
  72 // invoking the translator.
  73
  74 /*
  75  * VM register sets.  The other sets are defined relative to these.
  76  */
  77 RegSet vm_regs_with_sp();
  78 RegSet vm_regs_no_sp();
  79
  80 /*
  81  * Registers that are live between tracelets, in two flavors, depending whether
  82  * we are between tracelets in a resumed function.
  83  */
  84 inline RegSet cross_trace_regs()          { return vm_regs_no_sp(); }
  85 inline RegSet cross_trace_regs_resumed()  { return vm_regs_with_sp(); }
  86
  87 /*
  88  * Registers that are live when we reenter the JIT from the TC (e.g., via
  89  * service requests).
  90  */
  91 inline RegSet leave_trace_regs() { return vm_regs_with_sp(); }
  92
  93 /*
  94  * Registers that are live between the caller and the callee when making a PHP
  95  * function call.
  96  */
  97 inline RegSet php_call_regs() { return cross_trace_regs(); }
  98
  99 /*
 100  * Registers that are live after a PHP function return.
 101  *
 102  * TODO(#2288359): We don't want this to include rvmsp() eventually.
 103  */
 104 inline RegSet php_return_regs() { return vm_regs_with_sp(); }
 105
 106 /*
 107  * Registers that are live on entry to fcallArrayHelper.
 108  *
 109  * TODO(#2288359): We don't want this to include rvmsp() eventually.
 110  */
 111 inline RegSet fcall_array_regs() { return vm_regs_with_sp(); }
 112
 113
 114 ///////////////////////////////////////////////////////////////////////////////
 115 // Calling convention registers.
 116
 117 /*
 118  * Native return value registers.
 119  */
 120 PhysReg rret(size_t i = 0);
 121 PhysReg rret_simd(size_t i);
 122
 123 /*
 124  * Native argument registers.
 125  */
 126 PhysReg rarg(size_t i);
 127 PhysReg rarg_simd(size_t i);
 128
 129 /*
 130  * Number of available argument registers.
 131  */
 132 size_t num_arg_regs();
 133 size_t num_arg_regs_simd();
 134
 135 /*
 136  * RegSet for a call with `n' arguments.
 137  */
 138 RegSet arg_regs(size_t n);
 139 RegSet arg_regs_simd(size_t n);
 140
 141 /*
 142  * Service request argument registers.
 143  */
 144 PhysReg r_svcreq_req();
 145 PhysReg r_svcreq_stub();
 146 PhysReg r_svcreq_sf();
 147 PhysReg r_svcreq_arg(size_t i);
 148
 149 ///////////////////////////////////////////////////////////////////////////////
 150
 151 }}
 152
 153 #endif