vm/instruction_operands.hpp

   1 namespace factor
   2 {
   3
   4 enum relocation_type {
   5         /* arg is a literal table index, holding a pair (symbol/dll) */
   6         RT_DLSYM,
   7         /* a word or quotation's general entry point */
   8         RT_ENTRY_POINT,
   9         /* a word's PIC entry point */
  10         RT_ENTRY_POINT_PIC,
  11         /* a word's tail-call PIC entry point */
  12         RT_ENTRY_POINT_PIC_TAIL,
  13         /* current offset */
  14         RT_HERE,
  15         /* current code block */
  16         RT_THIS,
  17         /* data heap literal */
  18         RT_LITERAL,
  19         /* untagged fixnum literal */
  20         RT_UNTAGGED,
  21         /* address of megamorphic_cache_hits var */
  22         RT_MEGAMORPHIC_CACHE_HITS,
  23         /* address of vm object */
  24         RT_VM,
  25         /* value of vm->cards_offset */
  26         RT_CARDS_OFFSET,
  27         /* value of vm->decks_offset */
  28         RT_DECKS_OFFSET,
  29         /* address of exception_handler -- this exists as a separate relocation
  30         type since its used in a situation where relocation arguments cannot
  31         be passed in, and so RT_DLSYM is inappropriate (Windows only) */
  32         RT_EXCEPTION_HANDLER,
  33         /* pointer to a float's payload */
  34         RT_FLOAT,
  35         /* pointer to a byte array's payload */
  36         RT_BYTE_ARRAY,
  37
  38 };
  39
  40 enum relocation_class {
  41         /* absolute address in a pointer-width location */
  42         RC_ABSOLUTE_CELL,
  43         /* absolute address in a 4 byte location */
  44         RC_ABSOLUTE,
  45         /* relative address in a 4 byte location */
  46         RC_RELATIVE,
  47         /* absolute address in a PowerPC LIS/ORI sequence */
  48         RC_ABSOLUTE_PPC_2_2,
  49         /* absolute address in a PowerPC LWZ instruction */
  50         RC_ABSOLUTE_PPC_2,
  51         /* relative address in a PowerPC LWZ/STW/BC instruction */
  52         RC_RELATIVE_PPC_2,
  53         /* relative address in a PowerPC B/BL instruction */
  54         RC_RELATIVE_PPC_3,
  55         /* relative address in an ARM B/BL instruction */
  56         RC_RELATIVE_ARM_3,
  57         /* pointer to address in an ARM LDR/STR instruction */
  58         RC_INDIRECT_ARM,
  59         /* pointer to address in an ARM LDR/STR instruction offset by 8 bytes */
  60         RC_INDIRECT_ARM_PC,
  61         /* absolute address in a 2 byte location */
  62         RC_ABSOLUTE_2,
  63         /* absolute address in a 1 byte location */
  64         RC_ABSOLUTE_1,
  65 };
  66
  67 static const cell rel_absolute_ppc_2_mask = 0xffff;
  68 static const cell rel_relative_ppc_2_mask = 0xfffc;
  69 static const cell rel_relative_ppc_3_mask = 0x3fffffc;
  70 static const cell rel_indirect_arm_mask = 0xfff;
  71 static const cell rel_relative_arm_3_mask = 0xffffff;
  72
  73 /* code relocation table consists of a table of entries for each fixup */
  74 struct relocation_entry {
  75         u32 value;
  76
  77         explicit relocation_entry(u32 value_) : value(value_) {}
  78
  79         relocation_entry(relocation_type rel_type,
  80                 relocation_class rel_class,
  81                 cell offset)
  82         {
  83                 value = (u32)((rel_type << 28) | (rel_class << 24) | offset);
  84         }
  85
  86         relocation_type rel_type()
  87         {
  88                 return (relocation_type)((value & 0xf0000000) >> 28);
  89         }
  90
  91         relocation_class rel_class()
  92         {
  93                 return (relocation_class)((value & 0x0f000000) >> 24);
  94         }
  95
  96         cell rel_offset()
  97         {
  98                 return (value & 0x00ffffff);
  99         }
 100
 101         int number_of_parameters()
 102         {
 103                 switch(rel_type())
 104                 {
 105                 case RT_VM:
 106                         return 1;
 107                 case RT_DLSYM:
 108                         return 2;
 109                 case RT_ENTRY_POINT:
 110                 case RT_ENTRY_POINT_PIC:
 111                 case RT_ENTRY_POINT_PIC_TAIL:
 112                 case RT_LITERAL:
 113                 case RT_HERE:
 114                 case RT_UNTAGGED:
 115                 case RT_THIS:
 116                 case RT_MEGAMORPHIC_CACHE_HITS:
 117                 case RT_CARDS_OFFSET:
 118                 case RT_DECKS_OFFSET:
 119                 case RT_EXCEPTION_HANDLER:
 120                 case RT_FLOAT:
 121                 case RT_BYTE_ARRAY:
 122                         return 0;
 123                 default:
 124                         critical_error("Bad rel type in number_of_parameters()",rel_type());
 125                         return -1; /* Can't happen */
 126                 }
 127         }
 128 };
 129
 130 struct instruction_operand {
 131         relocation_entry rel;
 132         code_block *compiled;
 133         cell index;
 134         cell pointer;
 135
 136         instruction_operand(relocation_entry rel_, code_block *compiled_, cell index_);
 137
 138         relocation_type rel_type()
 139         {
 140                 return rel.rel_type();
 141         }
 142
 143         cell rel_offset()
 144         {
 145                 return rel.rel_offset();
 146         }
 147
 148         cell parameter_index()
 149         {
 150                 return index;
 151         }
 152
 153         code_block *parent_code_block()
 154         {
 155                 return compiled;
 156         }
 157
 158         fixnum load_value_2_2();
 159         fixnum load_value_masked(cell mask, cell bits, cell shift);
 160         fixnum load_value(cell relative_to);
 161         fixnum load_value();
 162         cell load_float(cell relative_to);
 163         cell load_float();
 164         cell load_byte_array(cell relative_to);
 165         cell load_byte_array();
 166         code_block *load_code_block(cell relative_to);
 167         code_block *load_code_block();
 168
 169         void store_value_2_2(fixnum value);
 170         void store_value_masked(fixnum value, cell mask, cell shift);
 171         void store_value(fixnum value);
 172         void store_float(cell value);
 173         void store_byte_array(cell value);
 174         void store_code_block(code_block *compiled);
 175 };
 176
 177 }