hphp/runtime/vm/jit/abi.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-present 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 // Calling convention registers.
  69
  70 /*
  71  * PHP return value registers.
  72  */
  73 PhysReg rret_data();
  74 PhysReg rret_type();
  75
  76 /*
  77  * Native return value registers.
  78  */
  79 PhysReg rret(size_t i = 0);
  80 PhysReg rret_simd(size_t i);
  81
  82 /*
  83  * Native argument registers.
  84  */
  85 PhysReg rarg(size_t i);
  86 PhysReg rarg_simd(size_t i);
  87 PhysReg rarg_ind_ret(size_t i);
  88
  89 /*
  90  * Number of available argument registers.
  91  */
  92 size_t num_arg_regs();
  93 size_t num_arg_regs_simd();
  94 size_t num_arg_regs_ind_ret();
  95
  96 /*
  97  * RegSet for a call with `n' arguments.
  98  */
  99 RegSet arg_regs(size_t n);
 100 RegSet arg_regs_simd(size_t n);
 101 RegSet arg_regs_ind_ret(size_t n);
 102
 103 /*
 104  * Service request argument registers.
 105  */
 106 PhysReg r_svcreq_req();
 107 PhysReg r_svcreq_stub();
 108 PhysReg r_svcreq_sf();
 109 PhysReg r_svcreq_arg(size_t i);
 110
 111
 112 ///////////////////////////////////////////////////////////////////////////////
 113 // JIT and TC boundary ABI registers.
 114 //
 115 // These registers should not be used for scratch purposes between tracelets,
 116 // and have to be specially handled if we are returning to the interpreter or
 117 // invoking the translator.
 118
 119 /*
 120  * VM register sets.  The other sets are defined relative to these.
 121  */
 122 RegSet vm_regs_with_sp();
 123 RegSet vm_regs_no_sp();
 124
 125 /*
 126  * Registers that are live between tracelets, in two flavors, depending whether
 127  * we are between tracelets in a resumed function.
 128  */
 129 inline RegSet cross_trace_regs()          { return vm_regs_no_sp(); }
 130 inline RegSet cross_trace_regs_resumed()  { return vm_regs_with_sp(); }
 131
 132 /*
 133  * Registers that are live when we reenter the JIT from the TC (e.g., via
 134  * service requests).
 135  */
 136 inline RegSet leave_trace_regs() { return vm_regs_with_sp(); }
 137
 138 /*
 139  * Registers that are live between the caller and the callee when making a PHP
 140  * function call.
 141  */
 142 inline RegSet php_call_regs() { return cross_trace_regs(); }
 143
 144 /*
 145  * Registers that are live after a PHP function return.
 146  *
 147  * TODO(#2288359): We don't want this to include rvmsp() eventually.
 148  */
 149 inline RegSet php_return_regs() {
 150   return vm_regs_with_sp() | rret_data() | rret_type();
 151 }
 152
 153 /*
 154  * Registers that are live on entry to fcallArrayHelper.
 155  *
 156  * TODO(#2288359): We don't want this to include rvmsp() eventually.
 157  */
 158 inline RegSet fcall_array_regs() { return vm_regs_with_sp(); }
 159
 160 ///////////////////////////////////////////////////////////////////////////////
 161
 162 /*
 163  * Return the status flags that must be set when testing 'cc'.
 164  */
 165 Vflags required_flags(ConditionCode cc);
 166
 167 ///////////////////////////////////////////////////////////////////////////////
 168
 169 }}
 170
 171 #endif