hphp/runtime/vm/jit/irlower.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_IRLOWER_H_
  18 #define incl_HPHP_JIT_IRLOWER_H_
  19
  20 #include "hphp/runtime/vm/jit/code-cache.h"
  21 #include "hphp/runtime/vm/jit/state-vector.h"
  22 #include "hphp/runtime/vm/jit/types.h"
  23 #include "hphp/runtime/vm/jit/vasm-emit.h"
  24 #include "hphp/runtime/vm/jit/vasm-reg.h"
  25 #include "hphp/runtime/vm/jit/vasm-unit.h"
  26 #include "hphp/runtime/vm/jit/vasm.h"
  27
  28 namespace HPHP { namespace jit {
  29
  30 struct IRUnit;
  31 struct Vout;
  32
  33 ///////////////////////////////////////////////////////////////////////////////
  34
  35 namespace irlower {
  36
  37 ///////////////////////////////////////////////////////////////////////////////
  38
  39 enum class SyncOptions {
  40   None,
  41   Sync,
  42   SyncAdjustOne,
  43 };
  44
  45 /*
  46  * State updated and tracked across vasm generation for individual instructions
  47  * and blocks.
  48  */
  49 struct IRLS {
  50   explicit IRLS(const IRUnit& unit)
  51     : unit(unit)
  52     , labels(unit, Vlabel())
  53     , locs(unit, Vloc{})
  54   {}
  55
  56   /*
  57    * The unit being lowered to vasm.
  58    */
  59   const IRUnit& unit;
  60
  61   /*
  62    * The vasm output streams.
  63    *
  64    * These may be updated during codegen of an instruction to point to new
  65    * Vblocks.
  66    */
  67   Vout* vmain{nullptr};
  68   Vout* vcold{nullptr};
  69
  70   /*
  71    * Vasm block labels, one for each HHIR block.
  72    */
  73   StateVector<Block,Vlabel> labels;
  74
  75   /*
  76    * Vlocs for each SSATmp used or defined in a reachable block.
  77    */
  78   StateVector<SSATmp,Vloc> locs;
  79 };
  80
  81 /*
  82  * Estimate the cost of unit.
  83  */
  84 Vcost computeIRUnitCost(const IRUnit& unit);
  85
  86 /*
  87  * Lower the given HHIR unit to a Vunit, then optimize, regalloc, and return
  88  * the Vunit. Returns nullptr on failure.
  89  */
  90 std::unique_ptr<Vunit> lowerUnit(const IRUnit&, CodeKind = CodeKind::Trace,
  91                                  bool regAlloc = true) noexcept;
  92
  93 ///////////////////////////////////////////////////////////////////////////////
  94
  95 }}}
  96
  97 #endif