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