hphp/runtime/vm/jit/vasm-gen.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_VASM_GEN_H_
  18 #define incl_HPHP_JIT_VASM_GEN_H_
  19
  20 #include "hphp/runtime/vm/jit/cg-meta.h"
  21 #include "hphp/runtime/vm/jit/containers.h"
  22 #include "hphp/runtime/vm/jit/types.h"
  23 #include "hphp/runtime/vm/jit/vasm-text.h"
  24 #include "hphp/runtime/vm/jit/vasm-unit.h"
  25 #include "hphp/runtime/vm/jit/vasm.h"
  26
  27 #include "hphp/util/data-block.h"
  28
  29 #include <boost/type_traits.hpp>
  30
  31 namespace HPHP { namespace jit {
  32 ///////////////////////////////////////////////////////////////////////////////
  33
  34 struct IRInstruction;
  35 struct Vinstr;
  36 struct Vreg;
  37
  38 ///////////////////////////////////////////////////////////////////////////////
  39
  40 /*
  41  * Writer stream for adding instructions to a Vblock.
  42  */
  43 struct Vout {
  44   Vout(Vunit& u, Vlabel b, const IRInstruction* origin = nullptr)
  45     : m_unit(u)
  46     , m_block(b)
  47     , m_origin(origin)
  48   {}
  49
  50   Vout(Vout&&) = default;
  51   Vout(const Vout&) = delete;
  52
  53   Vout& operator=(const Vout&);
  54   Vout& operator=(Vlabel);
  55
  56   /*
  57    * Implicit cast to label for initializing branch instructions.
  58    */
  59   /* implicit */ operator Vlabel() const;
  60
  61   /*
  62    * Instruction emitter.
  63    */
  64   Vout& operator<<(const Vinstr& inst);
  65
  66   /*
  67    * Create a stream connected to a new empty block.
  68    */
  69   Vout makeBlock();
  70
  71   /////////////////////////////////////////////////////////////////////////////
  72
  73   /*
  74    * Whether the stream is empty or terminated (because a block-terminating
  75    * instruction has been emitted).
  76    */
  77   bool empty() const;
  78   bool closed() const;
  79
  80   /*
  81    * Return the managed Vunit.
  82    */
  83   Vunit& unit() { return m_unit; }
  84
  85   /*
  86    * Return the code area of the currently-managed block.
  87    */
  88   AreaIndex area() const;
  89
  90   /*
  91    * Set the current block and Vinstr origin.
  92    */
  93   void use(Vlabel b)                     { m_block = b; }
  94   void setOrigin(const IRInstruction* i) { m_origin = i; }
  95
  96   /*
  97    * Vunit delegations.
  98    */
  99   Vreg makeReg();
 100   Vtuple makeTuple(const VregList& regs) const;
 101   Vtuple makeTuple(VregList&& regs) const;
 102   VcallArgsId makeVcallArgs(VcallArgs&& args) const;
 103   template<class T> Vreg cns(T v);
 104
 105 private:
 106   Vunit& m_unit;
 107   Vlabel m_block;
 108   const IRInstruction* m_origin;
 109 };
 110
 111 ///////////////////////////////////////////////////////////////////////////////
 112
 113 /*
 114  * Vasm assembler.
 115  *
 116  * A Vasm manages Vout streams for a Vunit.
 117  */
 118 struct Vasm {
 119   Vasm() { m_outs.reserve(kNumAreas); }
 120
 121   /*
 122    * Obtain the managed Vunit.
 123    */
 124   Vunit& unit() { return m_unit; }
 125
 126   /*
 127    * Get or create the stream for the corresponding Varea.
 128    */
 129   Vout& main() { return out(AreaIndex::Main); }
 130   Vout& cold() { return out(AreaIndex::Cold); }
 131   Vout& frozen() { return out(AreaIndex::Frozen); }
 132
 133 private:
 134   Vout& out(AreaIndex i);
 135
 136 private:
 137   Vunit m_unit;
 138   jit::vector<Vout> m_outs; // one for each AreaIndex
 139 };
 140
 141 ///////////////////////////////////////////////////////////////////////////////
 142
 143 /*
 144  * Helper for emitting small amounts of machine code using vasm.
 145  *
 146  * Vauto manages a Vunit with a single area.  When the Vauto goes out of scope,
 147  * it will finalize and emit any code it contains.
 148  */
 149 struct Vauto {
 150   explicit Vauto(CodeBlock& code, CGMeta& fixups,
 151                  CodeKind kind = CodeKind::Helper)
 152     : m_text{code, code}
 153     , m_fixups(fixups)
 154     , m_main{m_unit, m_unit.makeBlock(AreaIndex::Main)}
 155     , m_cold{m_unit, m_unit.makeBlock(AreaIndex::Cold)}
 156     , m_kind{kind}
 157   {
 158     m_unit.entry = Vlabel(main());
 159   }
 160
 161   Vunit& unit() { return m_unit; }
 162   Vout& main() { return m_main; }
 163   Vout& cold() { return m_cold; }
 164
 165   ~Vauto();
 166
 167 private:
 168   Vunit m_unit;
 169   Vtext m_text;
 170   CGMeta& m_fixups;
 171   Vout m_main;
 172   Vout m_cold;
 173   CodeKind m_kind;
 174 };
 175
 176 namespace detail {
 177   template<class GenFunc>
 178   TCA vwrap_impl(CodeBlock& cb, CGMeta* meta, GenFunc gen, CodeKind kind);
 179 }
 180
 181 /*
 182  * Convenience wrappers around Vauto for cross-trace or helper code.
 183  */
 184 template<class GenFunc>
 185 TCA vwrap(CodeBlock& cb, CGMeta& meta, GenFunc gen,
 186           CodeKind kind = CodeKind::CrossTrace) {
 187   return detail::vwrap_impl(cb, &meta, [&] (Vout& v, Vout&) { gen(v); }, kind);
 188 }
 189 template<class GenFunc>
 190 TCA vwrap(CodeBlock& cb, GenFunc gen) {
 191   return detail::vwrap_impl(cb, nullptr, [&] (Vout& v, Vout&) { gen(v); },
 192                             CodeKind::CrossTrace);
 193 }
 194 template<class GenFunc>
 195 TCA vwrap2(CodeBlock& cb, GenFunc gen) {
 196   return detail::vwrap_impl(cb, nullptr, gen, CodeKind::CrossTrace);
 197 }
 198
 199 ///////////////////////////////////////////////////////////////////////////////
 200 }}
 201
 202 #include "hphp/runtime/vm/jit/vasm-gen-inl.h"
 203
 204 #endif