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         /* arg is a literal table index, holding a pair (symbol/dll) */
  34         RT_DLSYM_TOC,
  35 };
  36
  37 enum relocation_class {
  38         /* absolute address in a pointer-width location */
  39         RC_ABSOLUTE_CELL,
  40         /* absolute address in a 4 byte location */
  41         RC_ABSOLUTE,
  42         /* relative address in a 4 byte location */
  43         RC_RELATIVE,
  44         /* absolute address in a PowerPC LIS/ORI sequence */
  45         RC_ABSOLUTE_PPC_2_2,
  46         /* absolute address in a PowerPC LWZ instruction */
  47         RC_ABSOLUTE_PPC_2,
  48         /* relative address in a PowerPC LWZ/STW/BC instruction */
  49         RC_RELATIVE_PPC_2_PC,
  50         /* relative address in a PowerPC B/BL instruction */
  51         RC_RELATIVE_PPC_3_PC,
  52         /* relative address in an ARM B/BL instruction */
  53         RC_RELATIVE_ARM_3,
  54         /* pointer to address in an ARM LDR/STR instruction */
  55         RC_INDIRECT_ARM,
  56         /* pointer to address in an ARM LDR/STR instruction offset by 8 bytes */
  57         RC_INDIRECT_ARM_PC,
  58         /* absolute address in a 2 byte location */
  59         RC_ABSOLUTE_2,
  60         /* absolute address in a 1 byte location */
  61         RC_ABSOLUTE_1,
  62         /* absolute address in a PowerPC LIS/ORI/SLDI/ORIS/ORI sequence */
  63         RC_ABSOLUTE_PPC_2_2_2_2,
  64 };
  65
  66 static const cell rel_absolute_ppc_2_mask = 0x0000ffff;
  67 static const cell rel_relative_ppc_2_mask = 0x0000fffc;
  68 static const cell rel_relative_ppc_3_mask = 0x03fffffc;
  69 static const cell rel_indirect_arm_mask   = 0x00000fff;
  70 static const cell rel_relative_arm_3_mask = 0x00ffffff;
  71
  72 /* code relocation table consists of a table of entries for each fixup */
  73 struct relocation_entry {
  74         u32 value;
  75
  76         explicit relocation_entry(u32 value_) : value(value_) {}
  77
  78         relocation_entry(relocation_type rel_type,
  79                 relocation_class rel_class,
  80                 cell offset)
  81         {
  82                 value = (u32)((rel_type << 28) | (rel_class << 24) | offset);
  83         }
  84
  85         relocation_type rel_type()
  86         {
  87                 return (relocation_type)((value & 0xf0000000) >> 28);
  88         }
  89
  90         relocation_class rel_class()
  91         {
  92                 return (relocation_class)((value & 0x0f000000) >> 24);
  93         }
  94
  95         cell rel_offset()
  96         {
  97                 return (value & 0x00ffffff);
  98         }
  99
 100         int number_of_parameters()
 101         {
 102                 switch(rel_type())
 103                 {
 104                 case RT_VM:
 105                         return 1;
 106                 case RT_DLSYM:
 107                 case RT_DLSYM_TOC:
 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                         return 0;
 121                 default:
 122                         critical_error("Bad rel type in number_of_parameters()",rel_type());
 123                         return -1; /* Can't happen */
 124                 }
 125         }
 126 };
 127
 128 struct instruction_operand {
 129         relocation_entry rel;
 130         code_block *compiled;
 131         cell index;
 132         cell pointer;
 133
 134         instruction_operand(relocation_entry rel_, code_block *compiled_, cell index_);
 135
 136         relocation_type rel_type()
 137         {
 138                 return rel.rel_type();
 139         }
 140
 141         cell rel_offset()
 142         {
 143                 return rel.rel_offset();
 144         }
 145
 146         cell parameter_index()
 147         {
 148                 return index;
 149         }
 150
 151         code_block *parent_code_block()
 152         {
 153                 return compiled;
 154         }
 155
 156         fixnum load_value_2_2();
 157         fixnum load_value_2_2_2_2();
 158         fixnum load_value_masked(cell mask, cell bits, cell shift);
 159         fixnum load_value(cell relative_to);
 160         fixnum load_value();
 161         code_block *load_code_block(cell relative_to);
 162         code_block *load_code_block();
 163
 164         void store_value_2_2(fixnum value);
 165         void store_value_2_2_2_2(fixnum value);
 166         void store_value_masked(fixnum value, cell mask, cell shift);
 167         void store_value(fixnum value);
 168         void store_code_block(code_block *compiled);
 169 };
 170
 171 }