hphp/runtime/vm/jit/llvm-stack-maps.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-2014 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 #ifndef incl_HPHP_RUNTIME_VM_JIT_LLVM_STACK_MAPS_H_
  17 #define incl_HPHP_RUNTIME_VM_JIT_LLVM_STACK_MAPS_H_
  18
  19 #include "hphp/runtime/vm/jit/containers.h"
  20
  21 #include <cstdint>
  22
  23 namespace HPHP { namespace jit {
  24
  25 /*
  26  * Our representation of the data parsed out from LLVM stack maps:
  27  * http://llvm.org/docs/StackMaps.html
  28  */
  29 struct StackMaps {
  30   uint8_t version;
  31
  32   struct StkSizeRecord {
  33     uint8_t* funcAddr;
  34     uint64_t stkSize;
  35   };
  36   jit::vector<StkSizeRecord> stkSizeRecords;
  37
  38   jit::vector<uint64_t> constants;
  39
  40   struct Record {
  41     uint64_t id;
  42     uint32_t offset;
  43
  44     struct Location {
  45       enum class Kind : uint8_t {
  46         Register   = 0x1,
  47         Direct     = 0x2,
  48         Indirect   = 0x3,
  49         Constant   = 0x4,
  50         ConstIndex = 0x5,
  51       };
  52
  53       Kind kind;
  54       uint16_t regNum;
  55       int32_t offsetOrConst;
  56     };
  57     jit::vector<Location> locations;
  58
  59     struct LiveOut {
  60       uint16_t regNum;
  61       uint8_t size;
  62     };
  63     jit::vector<LiveOut> liveOuts;
  64   };
  65
  66   jit::flat_map<uint64_t, Record> records;
  67 };
  68
  69 /*
  70  * Parse the stack map section from LLVM codegen into a StackMaps struct.
  71  */
  72 StackMaps parseStackMaps(const uint8_t* ptr);
  73
  74 /*
  75  * Pretty-print a StackMaps struct.
  76  */
  77 std::string show(const StackMaps& maps);
  78
  79 } }
  80
  81 #endif