vm/vm.hpp

   1 #include "vm-data.hpp"
   2
   3 namespace factor
   4 {
   5
   6 struct factor_vm : factor_vm_data {
   7
   8         // contexts
   9         void reset_datastack();
  10         void reset_retainstack();
  11         void fix_stacks();
  12         void save_stacks();
  13         context *alloc_context();
  14         void dealloc_context(context *old_context);
  15         void nest_stacks();
  16         void unnest_stacks();
  17         void init_stacks(cell ds_size_, cell rs_size_);
  18         bool stack_to_array(cell bottom, cell top);
  19         cell array_to_stack(array *array, cell bottom);
  20         inline void primitive_datastack();
  21         inline void primitive_retainstack();
  22         inline void primitive_set_datastack();
  23         inline void primitive_set_retainstack();
  24         inline void primitive_check_datastack();
  25
  26         // run
  27         inline void primitive_getenv();
  28         inline void primitive_setenv();
  29         inline void primitive_exit();
  30         inline void primitive_micros();
  31         inline void primitive_sleep();
  32         inline void primitive_set_slot();
  33         inline void primitive_load_locals();
  34         cell clone_object(cell obj_);
  35         inline void primitive_clone();
  36
  37         // profiler
  38         void init_profiler();
  39         code_block *compile_profiling_stub(cell word_);
  40         void set_profiling(bool profiling);
  41         inline void primitive_profiling();
  42
  43         // errors
  44         void out_of_memory();
  45         void critical_error(const char* msg, cell tagged);
  46         void throw_error(cell error, stack_frame *callstack_top);
  47         void not_implemented_error();
  48         bool in_page(cell fault, cell area, cell area_size, int offset);
  49         void memory_protection_error(cell addr, stack_frame *native_stack);
  50         void signal_error(int signal, stack_frame *native_stack);
  51         void divide_by_zero_error();
  52         void fp_trap_error(unsigned int fpu_status, stack_frame *signal_callstack_top);
  53         inline void primitive_call_clear();
  54         inline void primitive_unimplemented();
  55         void memory_signal_handler_impl();
  56         void misc_signal_handler_impl();
  57         void fp_signal_handler_impl();
  58         void type_error(cell type, cell tagged);
  59         void general_error(vm_error_type error, cell arg1, cell arg2, stack_frame *native_stack);
  60
  61         //callstack
  62
  63         // bignum
  64         int bignum_equal_p(bignum * x, bignum * y);
  65         enum bignum_comparison bignum_compare(bignum * x, bignum * y);
  66         bignum *bignum_add(bignum * x, bignum * y);
  67         bignum *bignum_subtract(bignum * x, bignum * y);
  68         bignum *bignum_multiply(bignum * x, bignum * y);
  69         void bignum_divide(bignum * numerator, bignum * denominator, bignum * * quotient, bignum * * remainder);
  70         bignum *bignum_quotient(bignum * numerator, bignum * denominator);
  71         bignum *bignum_remainder(bignum * numerator, bignum * denominator);
  72         cell bignum_to_cell(bignum * bignum);
  73         fixnum bignum_to_fixnum(bignum * bignum);
  74         s64 bignum_to_long_long(bignum * bignum);
  75         u64 bignum_to_ulong_long(bignum * bignum);
  76         double bignum_to_double(bignum * bignum);
  77         bignum *double_to_bignum(double x);
  78         int bignum_equal_p_unsigned(bignum * x, bignum * y);
  79         enum bignum_comparison bignum_compare_unsigned(bignum * x, bignum * y);
  80         bignum *bignum_add_unsigned(bignum * x, bignum * y, int negative_p);
  81         bignum *bignum_subtract_unsigned(bignum * x, bignum * y);
  82         bignum *bignum_multiply_unsigned(bignum * x, bignum * y, int negative_p);
  83         bignum *bignum_multiply_unsigned_small_factor(bignum * x, bignum_digit_type y,int negative_p);
  84         void bignum_destructive_add(bignum * bignum, bignum_digit_type n);
  85         void bignum_destructive_scale_up(bignum * bignum, bignum_digit_type factor);
  86         void bignum_divide_unsigned_large_denominator(bignum * numerator, bignum * denominator,
  87                                                                                                   bignum * * quotient, bignum * * remainder, int q_negative_p, int r_negative_p);
  88         void bignum_divide_unsigned_normalized(bignum * u, bignum * v, bignum * q);
  89         bignum_digit_type bignum_divide_subtract(bignum_digit_type * v_start, bignum_digit_type * v_end,
  90                                                                                          bignum_digit_type guess, bignum_digit_type * u_start);
  91         void bignum_divide_unsigned_medium_denominator(bignum * numerator,bignum_digit_type denominator,
  92                                                                                                    bignum * * quotient, bignum * * remainder,int q_negative_p, int r_negative_p);
  93         void bignum_destructive_normalization(bignum * source, bignum * target, int shift_left);
  94         void bignum_destructive_unnormalization(bignum * bignum, int shift_right);
  95         bignum_digit_type bignum_digit_divide(bignum_digit_type uh, bignum_digit_type ul,
  96                                                                                   bignum_digit_type v, bignum_digit_type * q) /* return value */;
  97         bignum_digit_type bignum_digit_divide_subtract(bignum_digit_type v1, bignum_digit_type v2,
  98                                                                                                    bignum_digit_type guess, bignum_digit_type * u);
  99         void bignum_divide_unsigned_small_denominator(bignum * numerator, bignum_digit_type denominator,
 100                                                                                                   bignum * * quotient, bignum * * remainder,int q_negative_p, int r_negative_p);
 101         bignum_digit_type bignum_destructive_scale_down(bignum * bignum, bignum_digit_type denominator);
 102         bignum * bignum_remainder_unsigned_small_denominator(bignum * n, bignum_digit_type d, int negative_p);
 103         bignum *bignum_digit_to_bignum(bignum_digit_type digit, int negative_p);
 104         bignum *allot_bignum(bignum_length_type length, int negative_p);
 105         bignum * allot_bignum_zeroed(bignum_length_type length, int negative_p);
 106         bignum *bignum_shorten_length(bignum * bignum, bignum_length_type length);
 107         bignum *bignum_trim(bignum * bignum);
 108         bignum *bignum_new_sign(bignum * x, int negative_p);
 109         bignum *bignum_maybe_new_sign(bignum * x, int negative_p);
 110         void bignum_destructive_copy(bignum * source, bignum * target);
 111         bignum *bignum_bitwise_not(bignum * x);
 112         bignum *bignum_arithmetic_shift(bignum * arg1, fixnum n);
 113         bignum *bignum_bitwise_and(bignum * arg1, bignum * arg2);
 114         bignum *bignum_bitwise_ior(bignum * arg1, bignum * arg2);
 115         bignum *bignum_bitwise_xor(bignum * arg1, bignum * arg2);
 116         bignum *bignum_magnitude_ash(bignum * arg1, fixnum n);
 117         bignum *bignum_pospos_bitwise_op(int op, bignum * arg1, bignum * arg2);
 118         bignum *bignum_posneg_bitwise_op(int op, bignum * arg1, bignum * arg2);
 119         bignum *bignum_negneg_bitwise_op(int op, bignum * arg1, bignum * arg2);
 120         void bignum_negate_magnitude(bignum * arg);
 121         bignum *bignum_integer_length(bignum * x);
 122         int bignum_logbitp(int shift, bignum * arg);
 123         int bignum_unsigned_logbitp(int shift, bignum * bignum);
 124         bignum *digit_stream_to_bignum(unsigned int n_digits, unsigned int (*producer)(unsigned int, factor_vm *), unsigned int radix, int negative_p);
 125
 126         //data_heap
 127         void init_card_decks();
 128         data_heap *grow_data_heap(data_heap *data, cell requested_bytes);
 129         void clear_cards(cell from, cell to);
 130         void clear_decks(cell from, cell to);
 131         void clear_allot_markers(cell from, cell to);
 132         void reset_generation(cell i);
 133         void reset_generations(cell from, cell to);
 134         void set_data_heap(data_heap *data_);
 135         void init_data_heap(cell gens,cell young_size,cell aging_size,cell tenured_size,bool secure_gc_);
 136         cell untagged_object_size(object *pointer);
 137         cell unaligned_object_size(object *pointer);
 138         inline void primitive_size();
 139         cell binary_payload_start(object *pointer);
 140         inline void primitive_data_room();
 141         void begin_scan();
 142         void end_scan();
 143         inline void primitive_begin_scan();
 144         cell next_object();
 145         inline void primitive_next_object();
 146         inline void primitive_end_scan();
 147         template<typename T> void each_object(T &functor);
 148         cell find_all_words();
 149         cell object_size(cell tagged);
 150
 151
 152         //write barrier
 153         inline card *addr_to_card(cell a);
 154         inline cell card_to_addr(card *c);
 155         inline cell card_offset(card *c);
 156         inline card_deck *addr_to_deck(cell a);
 157         inline cell deck_to_addr(card_deck *c);
 158         inline card *deck_to_card(card_deck *d);
 159         inline card *addr_to_allot_marker(object *a);
 160         inline void write_barrier(object *obj);
 161         inline void allot_barrier(object *address);
 162
 163         //data_gc
 164         void init_data_gc();
 165         object *copy_untagged_object_impl(object *pointer, cell size);
 166         object *copy_object_impl(object *untagged);
 167         bool should_copy_p(object *untagged);
 168         object *resolve_forwarding(object *untagged);
 169         template <typename T> T *copy_untagged_object(T *untagged);
 170         cell copy_object(cell pointer);
 171         void copy_handle(cell *handle);
 172         void copy_card(card *ptr, cell gen, cell here);
 173         void copy_card_deck(card_deck *deck, cell gen, card mask, card unmask);
 174         void copy_gen_cards(cell gen);
 175         void copy_cards();
 176         void copy_stack_elements(segment *region, cell top);
 177         void copy_registered_locals();
 178         void copy_registered_bignums();
 179         void copy_roots();
 180         cell copy_next_from_nursery(cell scan);
 181         cell copy_next_from_aging(cell scan);
 182         cell copy_next_from_tenured(cell scan);
 183         void copy_reachable_objects(cell scan, cell *end);
 184         void begin_gc(cell requested_bytes);
 185         void end_gc(cell gc_elapsed);
 186         void garbage_collection(cell gen,bool growing_data_heap_,cell requested_bytes);
 187         void gc();
 188         inline void primitive_gc();
 189         inline void primitive_gc_stats();
 190         void clear_gc_stats();
 191         inline void primitive_become();
 192         void inline_gc(cell *gc_roots_base, cell gc_roots_size);
 193         inline bool collecting_accumulation_gen_p();
 194         inline object *allot_zone(zone *z, cell a);
 195         inline object *allot_object(header header, cell size);
 196         template <typename TYPE> TYPE *allot(cell size);
 197         inline void check_data_pointer(object *pointer);
 198         inline void check_tagged_pointer(cell tagged);
 199         inline void primitive_clear_gc_stats();
 200
 201         // generic arrays
 202         template <typename T> T *allot_array_internal(cell capacity);
 203         template <typename T> bool reallot_array_in_place_p(T *array, cell capacity);
 204         template <typename TYPE> TYPE *reallot_array(TYPE *array_, cell capacity);
 205
 206         //debug
 207         void print_chars(string* str);
 208         void print_word(word* word, cell nesting);
 209         void print_factor_string(string* str);
 210         void print_array(array* array, cell nesting);
 211         void print_tuple(tuple *tuple, cell nesting);
 212         void print_nested_obj(cell obj, fixnum nesting);
 213         void print_obj(cell obj);
 214         void print_objects(cell *start, cell *end);
 215         void print_datastack();
 216         void print_retainstack();
 217         void print_stack_frame(stack_frame *frame);
 218         void print_callstack();
 219         void dump_cell(cell x);
 220         void dump_memory(cell from, cell to);
 221         void dump_zone(zone *z);
 222         void dump_generations();
 223         void dump_objects(cell type);
 224         void find_data_references_step(cell *scan);
 225         void find_data_references(cell look_for_);
 226         void dump_code_heap();
 227         void factorbug();
 228         inline void primitive_die();
 229
 230         //arrays
 231         array *allot_array(cell capacity, cell fill_);
 232         inline void primitive_array();
 233         cell allot_array_1(cell obj_);
 234         cell allot_array_2(cell v1_, cell v2_);
 235         cell allot_array_4(cell v1_, cell v2_, cell v3_, cell v4_);
 236         inline void primitive_resize_array();
 237         inline void set_array_nth(array *array, cell slot, cell value);
 238
 239         //strings
 240         cell string_nth(string* str, cell index);
 241         void set_string_nth_fast(string *str, cell index, cell ch);
 242         void set_string_nth_slow(string *str_, cell index, cell ch);
 243         void set_string_nth(string *str, cell index, cell ch);
 244         string *allot_string_internal(cell capacity);
 245         void fill_string(string *str_, cell start, cell capacity, cell fill);
 246         string *allot_string(cell capacity, cell fill);
 247         inline void primitive_string();
 248         bool reallot_string_in_place_p(string *str, cell capacity);
 249         string* reallot_string(string *str_, cell capacity);
 250         inline void primitive_resize_string();
 251         inline void primitive_string_nth();
 252         inline void primitive_set_string_nth_fast();
 253         inline void primitive_set_string_nth_slow();
 254
 255         //booleans
 256         void box_boolean(bool value);
 257         bool to_boolean(cell value);
 258         inline cell tag_boolean(cell untagged);
 259
 260         //byte arrays
 261         byte_array *allot_byte_array(cell size);
 262         inline void primitive_byte_array();
 263         inline void primitive_uninitialized_byte_array();
 264         inline void primitive_resize_byte_array();
 265
 266         //tuples
 267         tuple *allot_tuple(cell layout_);
 268         inline void primitive_tuple();
 269         inline void primitive_tuple_boa();
 270
 271         //words
 272         word *allot_word(cell name_, cell vocab_, cell hashcode_);
 273         inline void primitive_word();
 274         inline void primitive_word_xt();
 275         void update_word_xt(cell w_);
 276         inline void primitive_optimized_p();
 277         inline void primitive_wrapper();
 278
 279         //math
 280         inline void primitive_bignum_to_fixnum();
 281         inline void primitive_float_to_fixnum();
 282         inline void primitive_fixnum_divint();
 283         inline void primitive_fixnum_divmod();
 284         bignum *fixnum_to_bignum(fixnum);
 285         bignum *cell_to_bignum(cell);
 286         bignum *long_long_to_bignum(s64 n);
 287         bignum *ulong_long_to_bignum(u64 n);
 288         inline fixnum sign_mask(fixnum x);
 289         inline fixnum branchless_max(fixnum x, fixnum y);
 290         inline fixnum branchless_abs(fixnum x);
 291         inline void primitive_fixnum_shift();
 292         inline void primitive_fixnum_to_bignum();
 293         inline void primitive_float_to_bignum();
 294         inline void primitive_bignum_eq();
 295         inline void primitive_bignum_add();
 296         inline void primitive_bignum_subtract();
 297         inline void primitive_bignum_multiply();
 298         inline void primitive_bignum_divint();
 299         inline void primitive_bignum_divmod();
 300         inline void primitive_bignum_mod();
 301         inline void primitive_bignum_and();
 302         inline void primitive_bignum_or();
 303         inline void primitive_bignum_xor();
 304         inline void primitive_bignum_shift();
 305         inline void primitive_bignum_less();
 306         inline void primitive_bignum_lesseq();
 307         inline void primitive_bignum_greater();
 308         inline void primitive_bignum_greatereq();
 309         inline void primitive_bignum_not();
 310         inline void primitive_bignum_bitp();
 311         inline void primitive_bignum_log2();
 312         unsigned int bignum_producer(unsigned int digit);
 313         inline void primitive_byte_array_to_bignum();
 314         cell unbox_array_size();
 315         inline void primitive_fixnum_to_float();
 316         inline void primitive_bignum_to_float();
 317         inline void primitive_str_to_float();
 318         inline void primitive_float_to_str();
 319         inline void primitive_float_eq();
 320         inline void primitive_float_add();
 321         inline void primitive_float_subtract();
 322         inline void primitive_float_multiply();
 323         inline void primitive_float_divfloat();
 324         inline void primitive_float_mod();
 325         inline void primitive_float_less();
 326         inline void primitive_float_lesseq();
 327         inline void primitive_float_greater();
 328         inline void primitive_float_greatereq();
 329         inline void primitive_float_bits();
 330         inline void primitive_bits_float();
 331         inline void primitive_double_bits();
 332         inline void primitive_bits_double();
 333         fixnum to_fixnum(cell tagged);
 334         cell to_cell(cell tagged);
 335         void box_signed_1(s8 n);
 336         void box_unsigned_1(u8 n);
 337         void box_signed_2(s16 n);
 338         void box_unsigned_2(u16 n);
 339         void box_signed_4(s32 n);
 340         void box_unsigned_4(u32 n);
 341         void box_signed_cell(fixnum integer);
 342         void box_unsigned_cell(cell cell);
 343         void box_signed_8(s64 n);
 344         s64 to_signed_8(cell obj);
 345         void box_unsigned_8(u64 n);
 346         u64 to_unsigned_8(cell obj);
 347         void box_float(float flo);
 348         float to_float(cell value);
 349         void box_double(double flo);
 350         double to_double(cell value);
 351         inline void overflow_fixnum_add(fixnum x, fixnum y);
 352         inline void overflow_fixnum_subtract(fixnum x, fixnum y);
 353         inline void overflow_fixnum_multiply(fixnum x, fixnum y);
 354         inline cell allot_integer(fixnum x);
 355         inline cell allot_cell(cell x);
 356         inline cell allot_float(double n);
 357         inline bignum *float_to_bignum(cell tagged);
 358         inline double bignum_to_float(cell tagged);
 359         inline double untag_float(cell tagged);
 360         inline double untag_float_check(cell tagged);
 361         inline fixnum float_to_fixnum(cell tagged);
 362         inline double fixnum_to_float(cell tagged);
 363         template <typename T> T *untag_check(cell value);
 364         template <typename T> T *untag(cell value);
 365
 366         //io
 367         void init_c_io();
 368         void io_error();
 369         inline void primitive_fopen();
 370         inline void primitive_fgetc();
 371         inline void primitive_fread();
 372         inline void primitive_fputc();
 373         inline void primitive_fwrite();
 374         inline void primitive_fseek();
 375         inline void primitive_fflush();
 376         inline void primitive_fclose();
 377
 378         //code_block
 379         relocation_type relocation_type_of(relocation_entry r);
 380         relocation_class relocation_class_of(relocation_entry r);
 381         cell relocation_offset_of(relocation_entry r);
 382         void flush_icache_for(code_block *block);
 383         int number_of_parameters(relocation_type type);
 384         void *object_xt(cell obj);
 385         void *xt_pic(word *w, cell tagged_quot);
 386         void *word_xt_pic(word *w);
 387         void *word_xt_pic_tail(word *w);
 388         void undefined_symbol();
 389         void *get_rel_symbol(array *literals, cell index);
 390         cell compute_relocation(relocation_entry rel, cell index, code_block *compiled);
 391         void iterate_relocations(code_block *compiled, relocation_iterator iter);
 392         void store_address_2_2(cell *ptr, cell value);
 393         void store_address_masked(cell *ptr, fixnum value, cell mask, fixnum shift);
 394         void store_address_in_code_block(cell klass, cell offset, fixnum absolute_value);
 395         void update_literal_references_step(relocation_entry rel, cell index, code_block *compiled);
 396         void update_literal_references(code_block *compiled);
 397         void copy_literal_references(code_block *compiled);
 398         void relocate_code_block_step(relocation_entry rel, cell index, code_block *compiled);
 399         void update_word_references_step(relocation_entry rel, cell index, code_block *compiled);
 400         void update_word_references(code_block *compiled);
 401         void update_literal_and_word_references(code_block *compiled);
 402         void check_code_address(cell address);
 403         void mark_code_block(code_block *compiled);
 404         void mark_stack_frame_step(stack_frame *frame);
 405         void mark_active_blocks(context *stacks);
 406         void mark_object_code_block(object *object);
 407         void relocate_code_block(code_block *compiled);
 408         void fixup_labels(array *labels, code_block *compiled);
 409         code_block *allot_code_block(cell size);
 410         code_block *add_code_block(cell type,cell code_,cell labels_,cell relocation_,cell literals_);
 411         inline bool stack_traces_p()
 412         {
 413                 return userenv[STACK_TRACES_ENV] != F;
 414         }
 415
 416         //code_heap
 417         void init_code_heap(cell size);
 418         bool in_code_heap_p(cell ptr);
 419         void jit_compile_word(cell word_, cell def_, bool relocate);
 420         void iterate_code_heap(code_heap_iterator iter);
 421         void copy_code_heap_roots();
 422         void update_code_heap_words();
 423         inline void primitive_modify_code_heap();
 424         inline void primitive_code_room();
 425         code_block *forward_xt(code_block *compiled);
 426         void forward_frame_xt(stack_frame *frame);
 427         void forward_object_xts();
 428         void fixup_object_xts();
 429         void compact_code_heap();
 430         inline void check_code_pointer(cell ptr);
 431
 432         //image
 433         void init_objects(image_header *h);
 434         void load_data_heap(FILE *file, image_header *h, vm_parameters *p);
 435         void load_code_heap(FILE *file, image_header *h, vm_parameters *p);
 436         bool save_image(const vm_char *filename);
 437         inline void primitive_save_image();
 438         inline void primitive_save_image_and_exit();
 439         void data_fixup(cell *cell);
 440         template <typename T> void code_fixup(T **handle);
 441         void fixup_word(word *word);
 442         void fixup_quotation(quotation *quot);
 443         void fixup_alien(alien *d);
 444         void fixup_stack_frame(stack_frame *frame);
 445         void fixup_callstack_object(callstack *stack);
 446         void relocate_object(object *object);
 447         void relocate_data();
 448         void fixup_code_block(code_block *compiled);
 449         void relocate_code();
 450         void load_image(vm_parameters *p);
 451
 452         //callstack
 453         template<typename T> void iterate_callstack_object(callstack *stack_, T &iterator);
 454         void check_frame(stack_frame *frame);
 455         callstack *allot_callstack(cell size);
 456         stack_frame *fix_callstack_top(stack_frame *top, stack_frame *bottom);
 457         stack_frame *capture_start();
 458         inline void primitive_callstack();
 459         inline void primitive_set_callstack();
 460         code_block *frame_code(stack_frame *frame);
 461         cell frame_type(stack_frame *frame);
 462         cell frame_executing(stack_frame *frame);
 463         stack_frame *frame_successor(stack_frame *frame);
 464         cell frame_scan(stack_frame *frame);
 465         inline void primitive_callstack_to_array();
 466         stack_frame *innermost_stack_frame(callstack *stack);
 467         stack_frame *innermost_stack_frame_quot(callstack *callstack);
 468         inline void primitive_innermost_stack_frame_executing();
 469         inline void primitive_innermost_stack_frame_scan();
 470         inline void primitive_set_innermost_stack_frame_quot();
 471         void save_callstack_bottom(stack_frame *callstack_bottom);
 472         template<typename T> void iterate_callstack(cell top, cell bottom, T &iterator);
 473         inline void do_slots(cell obj, void (* iter)(cell *,factor_vm*));
 474
 475         //alien
 476         char *pinned_alien_offset(cell obj);
 477         cell allot_alien(cell delegate_, cell displacement);
 478         inline void primitive_displaced_alien();
 479         inline void primitive_alien_address();
 480         void *alien_pointer();
 481         inline void primitive_dlopen();
 482         inline void primitive_dlsym();
 483         inline void primitive_dlclose();
 484         inline void primitive_dll_validp();
 485         inline void primitive_vm_ptr();
 486         char *alien_offset(cell obj);
 487         char *unbox_alien();
 488         void box_alien(void *ptr);
 489         void to_value_struct(cell src, void *dest, cell size);
 490         void box_value_struct(void *src, cell size);
 491         void box_small_struct(cell x, cell y, cell size);
 492         void box_medium_struct(cell x1, cell x2, cell x3, cell x4, cell size);
 493
 494         //quotations
 495         inline void primitive_jit_compile();
 496         inline void primitive_array_to_quotation();
 497         inline void primitive_quotation_xt();
 498         void set_quot_xt(quotation *quot, code_block *code);
 499         void jit_compile(cell quot_, bool relocating);
 500         void compile_all_words();
 501         fixnum quot_code_offset_to_scan(cell quot_, cell offset);
 502         cell lazy_jit_compile_impl(cell quot_, stack_frame *stack);
 503         inline void primitive_quot_compiled_p();
 504
 505         //dispatch
 506         cell search_lookup_alist(cell table, cell klass);
 507         cell search_lookup_hash(cell table, cell klass, cell hashcode);
 508         cell nth_superclass(tuple_layout *layout, fixnum echelon);
 509         cell nth_hashcode(tuple_layout *layout, fixnum echelon);
 510         cell lookup_tuple_method(cell obj, cell methods);
 511         cell lookup_hi_tag_method(cell obj, cell methods);
 512         cell lookup_hairy_method(cell obj, cell methods);
 513         cell lookup_method(cell obj, cell methods);
 514         inline void primitive_lookup_method();
 515         cell object_class(cell obj);
 516         cell method_cache_hashcode(cell klass, array *array);
 517         void update_method_cache(cell cache, cell klass, cell method);
 518         inline void primitive_mega_cache_miss();
 519         inline void primitive_reset_dispatch_stats();
 520         inline void primitive_dispatch_stats();
 521
 522         //inline cache
 523         void init_inline_caching(int max_size);
 524         void deallocate_inline_cache(cell return_address);
 525         cell determine_inline_cache_type(array *cache_entries);
 526         void update_pic_count(cell type);
 527         code_block *compile_inline_cache(fixnum index,cell generic_word_,cell methods_,cell cache_entries_,bool tail_call_p);
 528         void *megamorphic_call_stub(cell generic_word);
 529         cell inline_cache_size(cell cache_entries);
 530         cell add_inline_cache_entry(cell cache_entries_, cell klass_, cell method_);
 531         void update_pic_transitions(cell pic_size);
 532         void *inline_cache_miss(cell return_address);
 533         inline void primitive_reset_inline_cache_stats();
 534         inline void primitive_inline_cache_stats();
 535
 536         //factor
 537         void default_parameters(vm_parameters *p);
 538         bool factor_arg(const vm_char* str, const vm_char* arg, cell* value);
 539         void init_parameters_from_args(vm_parameters *p, int argc, vm_char **argv);
 540         void do_stage1_init();
 541         void init_factor(vm_parameters *p);
 542         void pass_args_to_factor(int argc, vm_char **argv);
 543         void start_factor(vm_parameters *p);
 544         void start_embedded_factor(vm_parameters *p);
 545         void start_standalone_factor(int argc, vm_char **argv);
 546         char *factor_eval_string(char *string);
 547         void factor_eval_free(char *result);
 548         void factor_yield();
 549         void factor_sleep(long us);
 550
 551         // os-*
 552         inline void primitive_existsp();
 553         void init_ffi();
 554         void ffi_dlopen(dll *dll);
 555         void *ffi_dlsym(dll *dll, symbol_char *symbol);
 556         void ffi_dlclose(dll *dll);
 557         void c_to_factor_toplevel(cell quot);
 558
 559         // os-windows
 560   #if defined(WINDOWS)
 561         void sleep_micros(u64 usec);
 562         const vm_char *vm_executable_path();
 563         const vm_char *default_image_path();
 564         void windows_image_path(vm_char *full_path, vm_char *temp_path, unsigned int length);
 565         bool windows_stat(vm_char *path);
 566
 567    #if defined(WINNT)
 568         void open_console();
 569         LONG exception_handler(PEXCEPTION_POINTERS pe);
 570         // next method here:
 571    #endif
 572   #else  // UNIX
 573         void memory_signal_handler(int signal, siginfo_t *siginfo, void *uap);
 574         void misc_signal_handler(int signal, siginfo_t *siginfo, void *uap);
 575         void fpe_signal_handler(int signal, siginfo_t *siginfo, void *uap);
 576         stack_frame *uap_stack_pointer(void *uap);
 577
 578   #endif
 579
 580   #ifdef __APPLE__
 581         void call_fault_handler(exception_type_t exception, exception_data_type_t code, MACH_EXC_STATE_TYPE *exc_state, MACH_THREAD_STATE_TYPE *thread_state, MACH_FLOAT_STATE_TYPE *float_state);
 582   #endif
 583
 584         void print_vm_data();
 585 };
 586
 587 #ifndef FACTOR_REENTRANT
 588    #define FACTOR_SINGLE_THREADED_SINGLETON
 589 #endif
 590
 591 #ifdef FACTOR_SINGLE_THREADED_SINGLETON
 592 /* calls are dispatched using the singleton vm ptr */
 593   extern factor_vm *vm;
 594   #define PRIMITIVE_GETVM() vm
 595   #define PRIMITIVE_OVERFLOW_GETVM() vm
 596   #define VM_PTR vm
 597   #define ASSERTVM()
 598   #define SIGNAL_VM_PTR() vm
 599 #endif
 600
 601 #ifdef FACTOR_SINGLE_THREADED_TESTING
 602 /* calls are dispatched as per multithreaded, but checked against singleton */
 603   extern factor_vm *vm;
 604   #define ASSERTVM() assert(vm==myvm)
 605   #define PRIMITIVE_GETVM() ((factor_vm*)myvm)
 606   #define PRIMITIVE_OVERFLOW_GETVM() ASSERTVM(); myvm
 607   #define VM_PTR myvm
 608   #define SIGNAL_VM_PTR() tls_vm()
 609 #endif
 610
 611 #ifdef FACTOR_REENTRANT_TLS
 612 /* uses thread local storage to obtain vm ptr */
 613   #define PRIMITIVE_GETVM() tls_vm()
 614   #define PRIMITIVE_OVERFLOW_GETVM() tls_vm()
 615   #define VM_PTR tls_vm()
 616   #define ASSERTVM()
 617   #define SIGNAL_VM_PTR() tls_vm()
 618 #endif
 619
 620 #ifdef FACTOR_REENTRANT
 621   #define PRIMITIVE_GETVM() ((factor_vm*)myvm)
 622   #define PRIMITIVE_OVERFLOW_GETVM() ((factor_vm*)myvm)
 623   #define VM_PTR myvm
 624   #define ASSERTVM()
 625   #define SIGNAL_VM_PTR() tls_vm()
 626 #endif
 627
 628 }