hphp/runtime/vm/jit/vasm.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-2013 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_H_
  18 #define incl_HPHP_JIT_VASM_H_
  19
  20 #include "hphp/runtime/base/rds.h"
  21
  22 #include "hphp/runtime/vm/jit/types.h"
  23 #include "hphp/runtime/vm/jit/containers.h"
  24
  25 #include "hphp/util/safe-cast.h"
  26
  27 #include <boost/dynamic_bitset.hpp>
  28 #include <folly/Range.h>
  29 #include <iosfwd>
  30
  31 namespace HPHP { namespace jit {
  32 ///////////////////////////////////////////////////////////////////////////////
  33
  34 struct Vunit;
  35 struct Vinstr;
  36 struct Vblock;
  37 struct Vreg;
  38 struct Abi;
  39
  40 ///////////////////////////////////////////////////////////////////////////////
  41
  42 /*
  43  * If Trace::moduleEnabled(Trace::llvm) || RuntimeOption::EvalJitLLVMCounters,
  44  * these two RDS values are used to count the number of bytecodes executed by
  45  * code emitted from their respective backends.
  46  */
  47 extern rds::Link<uint64_t> g_bytecodesLLVM;
  48 extern rds::Link<uint64_t> g_bytecodesVasm;
  49
  50 ///////////////////////////////////////////////////////////////////////////////
  51
  52 #define DECLARE_VNUM(Vnum, check, prefix)                 \
  53 struct Vnum {                                             \
  54   Vnum() {}                                               \
  55   explicit Vnum(size_t n) : n(safe_cast<uint32_t>(n)) {}  \
  56                                                           \
  57   /* implicit */ operator size_t() const {                \
  58     if (check) assertx(n != kInvalidId);                   \
  59     return n;                                             \
  60   }                                                       \
  61                                                           \
  62   bool isValid() const {                                  \
  63     return n != kInvalidId;                               \
  64   }                                                       \
  65                                                           \
  66   std::string toString() const {                          \
  67     if (n == kInvalidId) return prefix "?";               \
  68     return folly::to<std::string>(prefix, n);             \
  69   }                                                       \
  70                                                           \
  71 private:                                                  \
  72   static constexpr uint32_t kInvalidId = 0xffffffff;      \
  73   uint32_t n{kInvalidId};                                 \
  74 }
  75
  76 /*
  77  * Vlabel wraps a block number.
  78  */
  79 DECLARE_VNUM(Vlabel, true, "B");
  80
  81 /*
  82  * Vpoint is a handle to record or retrieve a code address.
  83  */
  84 DECLARE_VNUM(Vpoint, false, "P");
  85
  86 /*
  87  * Vtuple is an index to a tuple in Vunit::tuples.
  88  */
  89 DECLARE_VNUM(Vtuple, true, "T");
  90
  91 /*
  92  * VcallArgsId is an index to a VcallArgs in Vunit::vcallArgs.
  93  */
  94 DECLARE_VNUM(VcallArgsId, true, "V");
  95
  96 #undef DECLARE_VNUM
  97
  98 /*
  99  * Vreg discriminator.
 100  */
 101 enum class VregKind : uint8_t { Any, Gpr, Simd, Sf };
 102
 103 ///////////////////////////////////////////////////////////////////////////////
 104
 105 /*
 106  * Assert invariants on a Vunit.
 107  */
 108 bool check(Vunit&);
 109
 110 /*
 111  * Check that each block has exactly one terminal instruction at the end.
 112  */
 113 bool checkBlockEnd(const Vunit& v, Vlabel b);
 114
 115 /*
 116  * Passes.
 117  */
 118 void allocateRegisters(Vunit&, const Abi&);
 119 void fuseBranches(Vunit&);
 120 void optimizeExits(Vunit&);
 121 void optimizeJmps(Vunit&);
 122 void optimizeCopies(Vunit&, const Abi&);
 123 void removeDeadCode(Vunit&);
 124 void removeTrivialNops(Vunit&);
 125 template<typename Folder> void foldImms(Vunit&);
 126
 127 ///////////////////////////////////////////////////////////////////////////////
 128
 129 /*
 130  * Get the successors of a block or instruction.  If given a non-const
 131  * reference, the resulting Range will allow mutation of the Vlabels.
 132  */
 133 folly::Range<Vlabel*> succs(Vinstr& inst);
 134 folly::Range<Vlabel*> succs(Vblock& block);
 135 folly::Range<const Vlabel*> succs(const Vinstr& inst);
 136 folly::Range<const Vlabel*> succs(const Vblock& block);
 137
 138 /*
 139  * Sort blocks in reverse-postorder starting from `unit.entry'.
 140  */
 141 jit::vector<Vlabel> sortBlocks(const Vunit& unit);
 142
 143 /*
 144  * Group blocks into main, cold, and frozen while preserving relative order
 145  * with each section.
 146  */
 147 jit::vector<Vlabel> layoutBlocks(const Vunit& unit);
 148
 149 /*
 150  * Return a bitset, keyed by Vlabel, indicating which blocks are targets of
 151  * backedges.
 152  */
 153 boost::dynamic_bitset<> backedgeTargets(const Vunit& unit,
 154                                         const jit::vector<Vlabel>& rpoBlocks);
 155
 156 ///////////////////////////////////////////////////////////////////////////////
 157 }}
 158
 159 #endif