vm/vm.hpp

   1 namespace factor
   2 {
   3
   4 struct growable_array;
   5 struct code_root;
   6
   7 struct factor_vm
   8 {
   9         // First five fields accessed directly by assembler. See vm.factor
  10
  11         /* Current stacks */
  12         context *ctx;
  13
  14         /* New objects are allocated here */
  15         nursery_space nursery;
  16
  17         /* Add this to a shifted address to compute write barrier offsets */
  18         cell cards_offset;
  19         cell decks_offset;
  20
  21         /* TAGGED user environment data; see getenv/setenv prims */
  22         cell special_objects[special_object_count];
  23
  24         /* Data stack and retain stack sizes */
  25         cell ds_size, rs_size;
  26
  27         /* Pooling unused contexts to make callbacks cheaper */
  28         context *unused_contexts;
  29
  30         /* Canonical truth value. In Factor, 't' */
  31         cell true_object;
  32
  33         /* Is call counting enabled? */
  34         bool profiling_p;
  35
  36         /* Global variables used to pass fault handler state from signal handler to
  37            user-space */
  38         cell signal_number;
  39         cell signal_fault_addr;
  40         unsigned int signal_fpu_status;
  41         stack_frame *signal_callstack_top;
  42
  43         /* GC is off during heap walking */
  44         bool gc_off;
  45
  46         /* Data heap */
  47         data_heap *data;
  48
  49         /* Code heap */
  50         code_heap *code;
  51
  52         /* Pinned callback stubs */
  53         callback_heap *callbacks;
  54
  55         /* Only set if we're performing a GC */
  56         gc_state *current_gc;
  57
  58         /* If not NULL, we push GC events here */
  59         std::vector<gc_event> *gc_events;
  60
  61         /* If a runtime function needs to call another function which potentially
  62            allocates memory, it must wrap any references to the data and code
  63            heaps with data_root and code_root smart pointers, which register
  64            themselves here. See data_roots.hpp and code_roots.hpp */
  65         std::vector<data_root_range> data_roots;
  66         std::vector<cell> bignum_roots;
  67         std::vector<code_root *> code_roots;
  68
  69         /* Debugger */
  70         bool fep_disabled;
  71         bool full_output;
  72
  73         /* Canonical bignums */
  74         cell bignum_zero;
  75         cell bignum_pos_one;
  76         cell bignum_neg_one;
  77
  78         /* Method dispatch statistics */
  79         dispatch_statistics dispatch_stats;
  80
  81         /* Number of entries in a polymorphic inline cache */
  82         cell max_pic_size;
  83
  84         /* Incrementing object counter for identity hashing */
  85         cell object_counter;
  86
  87         // contexts
  88         void reset_datastack();
  89         void reset_retainstack();
  90         void fix_stacks();
  91         void save_stacks();
  92         context *alloc_context();
  93         void dealloc_context(context *old_context);
  94         void nest_stacks(stack_frame *magic_frame);
  95         void unnest_stacks();
  96         void init_stacks(cell ds_size_, cell rs_size_);
  97         bool stack_to_array(cell bottom, cell top);
  98         cell array_to_stack(array *array, cell bottom);
  99         void primitive_datastack();
 100         void primitive_retainstack();
 101         void primitive_set_datastack();
 102         void primitive_set_retainstack();
 103         void primitive_check_datastack();
 104         void primitive_load_locals();
 105
 106         template<typename Iterator> void iterate_active_frames(Iterator &iter)
 107         {
 108                 context *ctx = this->ctx;
 109
 110                 while(ctx)
 111                 {
 112                         iterate_callstack(ctx,iter);
 113                         if(ctx->magic_frame) iter(ctx->magic_frame);
 114                         ctx = ctx->next;
 115                 }
 116         }
 117
 118         // run
 119         void primitive_exit();
 120         void primitive_system_micros();
 121         void primitive_nano_count();
 122         void primitive_sleep();
 123         void primitive_set_slot();
 124
 125         // objects
 126         void primitive_special_object();
 127         void primitive_set_special_object();
 128         void primitive_identity_hashcode();
 129         void compute_identity_hashcode(object *obj);
 130         void primitive_compute_identity_hashcode();
 131         cell object_size(cell tagged);
 132         cell clone_object(cell obj_);
 133         void primitive_clone();
 134         void primitive_become();
 135
 136         // profiler
 137         void init_profiler();
 138         code_block *compile_profiling_stub(cell word_);
 139         void set_profiling(bool profiling);
 140         void primitive_profiling();
 141
 142         // errors
 143         void throw_error(cell error, stack_frame *callstack_top);
 144         void not_implemented_error();
 145         bool in_page(cell fault, cell area, cell area_size, int offset);
 146         void memory_protection_error(cell addr, stack_frame *native_stack);
 147         void signal_error(int signal, stack_frame *native_stack);
 148         void divide_by_zero_error();
 149         void fp_trap_error(unsigned int fpu_status, stack_frame *signal_callstack_top);
 150         void primitive_call_clear();
 151         void primitive_unimplemented();
 152         void memory_signal_handler_impl();
 153         void misc_signal_handler_impl();
 154         void fp_signal_handler_impl();
 155         void type_error(cell type, cell tagged);
 156         void general_error(vm_error_type error, cell arg1, cell arg2, stack_frame *native_stack);
 157
 158         // bignum
 159         int bignum_equal_p(bignum * x, bignum * y);
 160         enum bignum_comparison bignum_compare(bignum * x, bignum * y);
 161         bignum *bignum_add(bignum * x, bignum * y);
 162         bignum *bignum_subtract(bignum * x, bignum * y);
 163         bignum *bignum_multiply(bignum * x, bignum * y);
 164         void bignum_divide(bignum * numerator, bignum * denominator, bignum * * quotient, bignum * * remainder);
 165         bignum *bignum_quotient(bignum * numerator, bignum * denominator);
 166         bignum *bignum_remainder(bignum * numerator, bignum * denominator);
 167         cell bignum_to_cell(bignum * bignum);
 168         fixnum bignum_to_fixnum(bignum * bignum);
 169         s64 bignum_to_long_long(bignum * bignum);
 170         u64 bignum_to_ulong_long(bignum * bignum);
 171         double bignum_to_double(bignum * bignum);
 172         bignum *double_to_bignum(double x);
 173         int bignum_equal_p_unsigned(bignum * x, bignum * y);
 174         enum bignum_comparison bignum_compare_unsigned(bignum * x, bignum * y);
 175         bignum *bignum_add_unsigned(bignum * x, bignum * y, int negative_p);
 176         bignum *bignum_subtract_unsigned(bignum * x, bignum * y);
 177         bignum *bignum_multiply_unsigned(bignum * x, bignum * y, int negative_p);
 178         bignum *bignum_multiply_unsigned_small_factor(bignum * x, bignum_digit_type y,int negative_p);
 179         void bignum_destructive_add(bignum * bignum, bignum_digit_type n);
 180         void bignum_destructive_scale_up(bignum * bignum, bignum_digit_type factor);
 181         void bignum_divide_unsigned_large_denominator(bignum * numerator, bignum * denominator,
 182                                                       bignum * * quotient, bignum * * remainder, int q_negative_p, int r_negative_p);
 183         void bignum_divide_unsigned_normalized(bignum * u, bignum * v, bignum * q);
 184         bignum_digit_type bignum_divide_subtract(bignum_digit_type * v_start, bignum_digit_type * v_end,
 185                                                  bignum_digit_type guess, bignum_digit_type * u_start);
 186         void bignum_divide_unsigned_medium_denominator(bignum * numerator,bignum_digit_type denominator,
 187                                                        bignum * * quotient, bignum * * remainder,int q_negative_p, int r_negative_p);
 188         void bignum_destructive_normalization(bignum * source, bignum * target, int shift_left);
 189         void bignum_destructive_unnormalization(bignum * bignum, int shift_right);
 190         bignum_digit_type bignum_digit_divide(bignum_digit_type uh, bignum_digit_type ul,
 191                                               bignum_digit_type v, bignum_digit_type * q) /* return value */;
 192         bignum_digit_type bignum_digit_divide_subtract(bignum_digit_type v1, bignum_digit_type v2,
 193                                                        bignum_digit_type guess, bignum_digit_type * u);
 194         void bignum_divide_unsigned_small_denominator(bignum * numerator, bignum_digit_type denominator,
 195                                                       bignum * * quotient, bignum * * remainder,int q_negative_p, int r_negative_p);
 196         bignum_digit_type bignum_destructive_scale_down(bignum * bignum, bignum_digit_type denominator);
 197         bignum * bignum_remainder_unsigned_small_denominator(bignum * n, bignum_digit_type d, int negative_p);
 198         bignum *bignum_digit_to_bignum(bignum_digit_type digit, int negative_p);
 199         bignum *allot_bignum(bignum_length_type length, int negative_p);
 200         bignum * allot_bignum_zeroed(bignum_length_type length, int negative_p);
 201         bignum *bignum_shorten_length(bignum * bignum, bignum_length_type length);
 202         bignum *bignum_trim(bignum * bignum);
 203         bignum *bignum_new_sign(bignum * x, int negative_p);
 204         bignum *bignum_maybe_new_sign(bignum * x, int negative_p);
 205         void bignum_destructive_copy(bignum * source, bignum * target);
 206         bignum *bignum_bitwise_not(bignum * x);
 207         bignum *bignum_arithmetic_shift(bignum * arg1, fixnum n);
 208         bignum *bignum_bitwise_and(bignum * arg1, bignum * arg2);
 209         bignum *bignum_bitwise_ior(bignum * arg1, bignum * arg2);
 210         bignum *bignum_bitwise_xor(bignum * arg1, bignum * arg2);
 211         bignum *bignum_magnitude_ash(bignum * arg1, fixnum n);
 212         bignum *bignum_pospos_bitwise_op(int op, bignum * arg1, bignum * arg2);
 213         bignum *bignum_posneg_bitwise_op(int op, bignum * arg1, bignum * arg2);
 214         bignum *bignum_negneg_bitwise_op(int op, bignum * arg1, bignum * arg2);
 215         void bignum_negate_magnitude(bignum * arg);
 216         bignum *bignum_integer_length(bignum * x);
 217         int bignum_logbitp(int shift, bignum * arg);
 218         int bignum_unsigned_logbitp(int shift, bignum * bignum);
 219         bignum *digit_stream_to_bignum(unsigned int n_digits, unsigned int (*producer)(unsigned int, factor_vm *), unsigned int radix, int negative_p);
 220
 221         //data heap
 222         void init_card_decks();
 223         void set_data_heap(data_heap *data_);
 224         void init_data_heap(cell young_size, cell aging_size, cell tenured_size);
 225         void primitive_size();
 226         data_heap_room data_room();
 227         void primitive_data_room();
 228         void begin_scan();
 229         void end_scan();
 230         cell instances(cell type);
 231         void primitive_all_instances();
 232         cell find_all_words();
 233
 234         template<typename Generation, typename Iterator>
 235         inline void each_object(Generation *gen, Iterator &iterator)
 236         {
 237                 cell obj = gen->first_object();
 238                 while(obj)
 239                 {
 240                         iterator((object *)obj);
 241                         obj = gen->next_object_after(obj);
 242                 }
 243         }
 244
 245         template<typename Iterator> inline void each_object(Iterator &iterator)
 246         {
 247                 gc_off = true;
 248
 249                 each_object(data->tenured,iterator);
 250                 each_object(data->aging,iterator);
 251                 each_object(data->nursery,iterator);
 252
 253                 gc_off = false;
 254         }
 255
 256         /* the write barrier must be called any time we are potentially storing a
 257            pointer from an older generation to a younger one */
 258         inline void write_barrier(cell *slot_ptr)
 259         {
 260                 *(char *)(cards_offset + ((cell)slot_ptr >> card_bits)) = card_mark_mask;
 261                 *(char *)(decks_offset + ((cell)slot_ptr >> deck_bits)) = card_mark_mask;
 262         }
 263
 264         inline void write_barrier(object *obj, cell size)
 265         {
 266                 cell start = (cell)obj & -card_size;
 267                 cell end = ((cell)obj + size + card_size - 1) & -card_size;
 268
 269                 for(cell offset = start; offset < end; offset += card_size)
 270                         write_barrier((cell *)offset);
 271         }
 272
 273         // data heap checker
 274         void check_data_heap();
 275
 276         // gc
 277         void end_gc();
 278         void start_gc_again();
 279         void update_code_heap_for_minor_gc(std::set<code_block *> *remembered_set);
 280         void collect_nursery();
 281         void collect_aging();
 282         void collect_to_tenured();
 283         void update_code_roots_for_sweep();
 284         void update_code_roots_for_compaction();
 285         void collect_mark_impl(bool trace_contexts_p);
 286         void collect_sweep_impl();
 287         void collect_full(bool trace_contexts_p);
 288         void collect_compact_impl(bool trace_contexts_p);
 289         void collect_compact_code_impl(bool trace_contexts_p);
 290         void collect_compact(bool trace_contexts_p);
 291         void collect_growing_heap(cell requested_bytes, bool trace_contexts_p);
 292         void gc(gc_op op, cell requested_bytes, bool trace_contexts_p);
 293         void primitive_minor_gc();
 294         void primitive_full_gc();
 295         void primitive_compact_gc();
 296         void inline_gc(cell *data_roots_base, cell data_roots_size);
 297         void primitive_enable_gc_events();
 298         void primitive_disable_gc_events();
 299         object *allot_object(cell type, cell size);
 300         object *allot_large_object(cell type, cell size);
 301
 302         template<typename Type> Type *allot(cell size)
 303         {
 304                 return (Type *)allot_object(Type::type_number,size);
 305         }
 306
 307         inline void check_data_pointer(object *pointer)
 308         {
 309         #ifdef FACTOR_DEBUG
 310                 if(!(current_gc && current_gc->op == collect_growing_heap_op))
 311                 {
 312                         assert((cell)pointer >= data->seg->start
 313                                && (cell)pointer < data->seg->end);
 314                 }
 315         #endif
 316         }
 317
 318         // generic arrays
 319         template<typename Array> Array *allot_uninitialized_array(cell capacity);
 320         template<typename Array> bool reallot_array_in_place_p(Array *array, cell capacity);
 321         template<typename Array> Array *reallot_array(Array *array_, cell capacity);
 322
 323         //debug
 324         void print_chars(string* str);
 325         void print_word(word* word, cell nesting);
 326         void print_factor_string(string* str);
 327         void print_array(array* array, cell nesting);
 328         void print_tuple(tuple *tuple, cell nesting);
 329         void print_nested_obj(cell obj, fixnum nesting);
 330         void print_obj(cell obj);
 331         void print_objects(cell *start, cell *end);
 332         void print_datastack();
 333         void print_retainstack();
 334         void print_callstack();
 335         void dump_cell(cell x);
 336         void dump_memory(cell from, cell to);
 337         template<typename Generation> void dump_generation(const char *name, Generation *gen);
 338         void dump_generations();
 339         void dump_objects(cell type);
 340         void find_data_references_step(cell *scan);
 341         void find_data_references(cell look_for_);
 342         void dump_code_heap();
 343         void factorbug();
 344         void primitive_die();
 345
 346         //arrays
 347         array *allot_array(cell capacity, cell fill_);
 348         void primitive_array();
 349         cell allot_array_1(cell obj_);
 350         cell allot_array_2(cell v1_, cell v2_);
 351         cell allot_array_4(cell v1_, cell v2_, cell v3_, cell v4_);
 352         void primitive_resize_array();
 353         inline void set_array_nth(array *array, cell slot, cell value);
 354
 355         //strings
 356         cell string_nth(const string *str, cell index);
 357         void set_string_nth_fast(string *str, cell index, cell ch);
 358         void set_string_nth_slow(string *str_, cell index, cell ch);
 359         void set_string_nth(string *str, cell index, cell ch);
 360         string *allot_string_internal(cell capacity);
 361         void fill_string(string *str_, cell start, cell capacity, cell fill);
 362         string *allot_string(cell capacity, cell fill);
 363         void primitive_string();
 364         bool reallot_string_in_place_p(string *str, cell capacity);
 365         string* reallot_string(string *str_, cell capacity);
 366         void primitive_resize_string();
 367         void primitive_string_nth();
 368         void primitive_set_string_nth_fast();
 369         void primitive_set_string_nth_slow();
 370
 371         //booleans
 372         void box_boolean(bool value);
 373         bool to_boolean(cell value);
 374         inline cell tag_boolean(cell untagged);
 375
 376         //byte arrays
 377         byte_array *allot_byte_array(cell size);
 378         void primitive_byte_array();
 379         void primitive_uninitialized_byte_array();
 380         void primitive_resize_byte_array();
 381
 382         template<typename Type> byte_array *byte_array_from_value(Type *value);
 383
 384         //tuples
 385         void primitive_tuple();
 386         void primitive_tuple_boa();
 387
 388         //words
 389         word *allot_word(cell name_, cell vocab_, cell hashcode_);
 390         void primitive_word();
 391         void primitive_word_xt();
 392         void update_word_xt(word *w_);
 393         void primitive_optimized_p();
 394         void primitive_wrapper();
 395
 396         //math
 397         void primitive_bignum_to_fixnum();
 398         void primitive_float_to_fixnum();
 399         void primitive_fixnum_divint();
 400         void primitive_fixnum_divmod();
 401         bignum *fixnum_to_bignum(fixnum);
 402         bignum *cell_to_bignum(cell);
 403         bignum *long_long_to_bignum(s64 n);
 404         bignum *ulong_long_to_bignum(u64 n);
 405         inline fixnum sign_mask(fixnum x);
 406         inline fixnum branchless_max(fixnum x, fixnum y);
 407         inline fixnum branchless_abs(fixnum x);
 408         void primitive_fixnum_shift();
 409         void primitive_fixnum_to_bignum();
 410         void primitive_float_to_bignum();
 411         void primitive_bignum_eq();
 412         void primitive_bignum_add();
 413         void primitive_bignum_subtract();
 414         void primitive_bignum_multiply();
 415         void primitive_bignum_divint();
 416         void primitive_bignum_divmod();
 417         void primitive_bignum_mod();
 418         void primitive_bignum_and();
 419         void primitive_bignum_or();
 420         void primitive_bignum_xor();
 421         void primitive_bignum_shift();
 422         void primitive_bignum_less();
 423         void primitive_bignum_lesseq();
 424         void primitive_bignum_greater();
 425         void primitive_bignum_greatereq();
 426         void primitive_bignum_not();
 427         void primitive_bignum_bitp();
 428         void primitive_bignum_log2();
 429         unsigned int bignum_producer(unsigned int digit);
 430         void primitive_byte_array_to_bignum();
 431         inline cell unbox_array_size();
 432         cell unbox_array_size_slow();
 433         void primitive_fixnum_to_float();
 434         void primitive_bignum_to_float();
 435         void primitive_str_to_float();
 436         void primitive_float_to_str();
 437         void primitive_float_eq();
 438         void primitive_float_add();
 439         void primitive_float_subtract();
 440         void primitive_float_multiply();
 441         void primitive_float_divfloat();
 442         void primitive_float_mod();
 443         void primitive_float_less();
 444         void primitive_float_lesseq();
 445         void primitive_float_greater();
 446         void primitive_float_greatereq();
 447         void primitive_float_bits();
 448         void primitive_bits_float();
 449         void primitive_double_bits();
 450         void primitive_bits_double();
 451         fixnum to_fixnum(cell tagged);
 452         cell to_cell(cell tagged);
 453         void box_signed_1(s8 n);
 454         void box_unsigned_1(u8 n);
 455         void box_signed_2(s16 n);
 456         void box_unsigned_2(u16 n);
 457         void box_signed_4(s32 n);
 458         void box_unsigned_4(u32 n);
 459         void box_signed_cell(fixnum integer);
 460         void box_unsigned_cell(cell cell);
 461         void box_signed_8(s64 n);
 462         s64 to_signed_8(cell obj);
 463         void box_unsigned_8(u64 n);
 464         u64 to_unsigned_8(cell obj);
 465         void box_float(float flo);
 466         float to_float(cell value);
 467         void box_double(double flo);
 468         double to_double(cell value);
 469         inline void overflow_fixnum_add(fixnum x, fixnum y);
 470         inline void overflow_fixnum_subtract(fixnum x, fixnum y);
 471         inline void overflow_fixnum_multiply(fixnum x, fixnum y);
 472         inline cell allot_integer(fixnum x);
 473         inline cell allot_cell(cell x);
 474         inline cell allot_float(double n);
 475         inline bignum *float_to_bignum(cell tagged);
 476         inline double bignum_to_float(cell tagged);
 477         inline double untag_float(cell tagged);
 478         inline double untag_float_check(cell tagged);
 479         inline fixnum float_to_fixnum(cell tagged);
 480         inline double fixnum_to_float(cell tagged);
 481
 482         // tagged
 483         template<typename Type> Type *untag_check(cell value);
 484
 485         //io
 486         void init_c_io();
 487         void io_error();
 488         void primitive_fopen();
 489         void primitive_fgetc();
 490         void primitive_fread();
 491         void primitive_fputc();
 492         void primitive_fwrite();
 493         void primitive_ftell();
 494         void primitive_fseek();
 495         void primitive_fflush();
 496         void primitive_fclose();
 497
 498         //code_block
 499         void flush_icache_for(code_block *block);
 500         void *object_xt(cell obj);
 501         void *xt_pic(word *w, cell tagged_quot);
 502         void *word_xt_pic(word *w);
 503         void *word_xt_pic_tail(word *w);
 504         void undefined_symbol();
 505         void *get_rel_symbol(array *literals, cell index);
 506         cell compute_relocation(relocation_entry rel, cell index, code_block *compiled);
 507         template<typename Iterator> void iterate_relocations(code_block *compiled, Iterator &iter);
 508         void update_literal_references(code_block *compiled);
 509         void relocate_code_block_step(relocation_entry rel, cell index, code_block *compiled);
 510         void update_word_references(code_block *compiled);
 511         void update_code_block_words_and_literals(code_block *compiled);
 512         void check_code_address(cell address);
 513         void relocate_code_block(code_block *compiled);
 514         void fixup_labels(array *labels, code_block *compiled);
 515         code_block *allot_code_block(cell size, code_block_type type);
 516         code_block *add_code_block(code_block_type type, cell code_, cell labels_, cell owner_, cell relocation_, cell literals_);
 517
 518         //code heap
 519         inline void check_code_pointer(cell ptr)
 520         {
 521         #ifdef FACTOR_DEBUG
 522                 assert(in_code_heap_p(ptr));
 523         #endif
 524         }
 525
 526         void init_code_heap(cell size);
 527         bool in_code_heap_p(cell ptr);
 528         void jit_compile_word(cell word_, cell def_, bool relocate);
 529         void update_code_heap_words();
 530         void update_code_heap_words_and_literals();
 531         void primitive_modify_code_heap();
 532         code_heap_room code_room();
 533         void primitive_code_room();
 534         void primitive_strip_stack_traces();
 535
 536         /* Apply a function to every code block */
 537         template<typename Iterator> void iterate_code_heap(Iterator &iter)
 538         {
 539                 code->allocator->iterate(iter);
 540         }
 541
 542         //callbacks
 543         void init_callbacks(cell size);
 544         void primitive_callback();
 545
 546         //image
 547         void init_objects(image_header *h);
 548         void load_data_heap(FILE *file, image_header *h, vm_parameters *p);
 549         void load_code_heap(FILE *file, image_header *h, vm_parameters *p);
 550         bool save_image(const vm_char *filename);
 551         void primitive_save_image();
 552         void primitive_save_image_and_exit();
 553         void data_fixup(cell *handle, cell data_relocation_base);
 554         template<typename Type> void code_fixup(Type **handle, cell code_relocation_base);
 555         void fixup_word(word *word, cell code_relocation_base);
 556         void fixup_quotation(quotation *quot, cell code_relocation_base);
 557         void fixup_alien(alien *d);
 558         void fixup_callstack_object(callstack *stack, cell code_relocation_base);
 559         void relocate_object(object *object, cell data_relocation_base, cell code_relocation_base);
 560         void relocate_data(cell data_relocation_base, cell code_relocation_base);
 561         void fixup_code_block(code_block *compiled, cell data_relocation_base);
 562         void relocate_code(cell data_relocation_base);
 563         void load_image(vm_parameters *p);
 564
 565         //callstack
 566         template<typename Iterator> void iterate_callstack_object(callstack *stack_, Iterator &iterator);
 567         void check_frame(stack_frame *frame);
 568         callstack *allot_callstack(cell size);
 569         stack_frame *fix_callstack_top(stack_frame *top, stack_frame *bottom);
 570         stack_frame *capture_start();
 571         void primitive_callstack();
 572         void primitive_set_callstack();
 573         code_block *frame_code(stack_frame *frame);
 574         code_block_type frame_type(stack_frame *frame);
 575         cell frame_executing(stack_frame *frame);
 576         stack_frame *frame_successor(stack_frame *frame);
 577         cell frame_scan(stack_frame *frame);
 578         void primitive_callstack_to_array();
 579         stack_frame *innermost_stack_frame(callstack *stack);
 580         stack_frame *innermost_stack_frame_quot(callstack *callstack);
 581         void primitive_innermost_stack_frame_executing();
 582         void primitive_innermost_stack_frame_scan();
 583         void primitive_set_innermost_stack_frame_quot();
 584         void save_callstack_bottom(stack_frame *callstack_bottom);
 585         template<typename Iterator> void iterate_callstack(context *ctx, Iterator &iterator);
 586
 587         //alien
 588         char *pinned_alien_offset(cell obj);
 589         cell allot_alien(cell delegate_, cell displacement);
 590         void primitive_displaced_alien();
 591         void primitive_alien_address();
 592         void *alien_pointer();
 593         void primitive_dlopen();
 594         void primitive_dlsym();
 595         void primitive_dlclose();
 596         void primitive_dll_validp();
 597         void primitive_vm_ptr();
 598         char *alien_offset(cell obj);
 599         char *unbox_alien();
 600         void box_alien(void *ptr);
 601         void to_value_struct(cell src, void *dest, cell size);
 602         void box_value_struct(void *src, cell size);
 603         void box_small_struct(cell x, cell y, cell size);
 604         void box_medium_struct(cell x1, cell x2, cell x3, cell x4, cell size);
 605
 606         //quotations
 607         void primitive_jit_compile();
 608         void primitive_array_to_quotation();
 609         void primitive_quotation_xt();
 610         void set_quot_xt(quotation *quot, code_block *code);
 611         void jit_compile(cell quot_, bool relocating);
 612         void compile_all_words();
 613         fixnum quot_code_offset_to_scan(cell quot_, cell offset);
 614         cell lazy_jit_compile_impl(cell quot_, stack_frame *stack);
 615         void primitive_quot_compiled_p();
 616
 617         //dispatch
 618         cell search_lookup_alist(cell table, cell klass);
 619         cell search_lookup_hash(cell table, cell klass, cell hashcode);
 620         cell nth_superclass(tuple_layout *layout, fixnum echelon);
 621         cell nth_hashcode(tuple_layout *layout, fixnum echelon);
 622         cell lookup_tuple_method(cell obj, cell methods);
 623         cell lookup_method(cell obj, cell methods);
 624         void primitive_lookup_method();
 625         cell object_class(cell obj);
 626         cell method_cache_hashcode(cell klass, array *array);
 627         void update_method_cache(cell cache, cell klass, cell method);
 628         void primitive_mega_cache_miss();
 629         void primitive_reset_dispatch_stats();
 630         void primitive_dispatch_stats();
 631
 632         //inline cache
 633         void init_inline_caching(int max_size);
 634         void deallocate_inline_cache(cell return_address);
 635         cell determine_inline_cache_type(array *cache_entries);
 636         void update_pic_count(cell type);
 637         code_block *compile_inline_cache(fixnum index,cell generic_word_,cell methods_,cell cache_entries_,bool tail_call_p);
 638         void *megamorphic_call_stub(cell generic_word);
 639         cell inline_cache_size(cell cache_entries);
 640         cell add_inline_cache_entry(cell cache_entries_, cell klass_, cell method_);
 641         void update_pic_transitions(cell pic_size);
 642         void *inline_cache_miss(cell return_address);
 643
 644         //factor
 645         void default_parameters(vm_parameters *p);
 646         bool factor_arg(const vm_char* str, const vm_char* arg, cell* value);
 647         void init_parameters_from_args(vm_parameters *p, int argc, vm_char **argv);
 648         void do_stage1_init();
 649         void init_factor(vm_parameters *p);
 650         void pass_args_to_factor(int argc, vm_char **argv);
 651         void start_factor(vm_parameters *p);
 652         void stop_factor();
 653         void start_embedded_factor(vm_parameters *p);
 654         void start_standalone_factor(int argc, vm_char **argv);
 655         char *factor_eval_string(char *string);
 656         void factor_eval_free(char *result);
 657         void factor_yield();
 658         void factor_sleep(long us);
 659
 660         // os-*
 661         void primitive_existsp();
 662         void init_ffi();
 663         void ffi_dlopen(dll *dll);
 664         void *ffi_dlsym(dll *dll, symbol_char *symbol);
 665         void ffi_dlclose(dll *dll);
 666         void c_to_factor_toplevel(cell quot);
 667
 668         // os-windows
 669   #if defined(WINDOWS)
 670         const vm_char *vm_executable_path();
 671         const vm_char *default_image_path();
 672         void windows_image_path(vm_char *full_path, vm_char *temp_path, unsigned int length);
 673         bool windows_stat(vm_char *path);
 674
 675   #if defined(WINNT)
 676         void open_console();
 677         LONG exception_handler(PEXCEPTION_POINTERS pe);
 678   #endif
 679   #else  // UNIX
 680         void dispatch_signal(void *uap, void (handler)());
 681   #endif
 682
 683   #ifdef __APPLE__
 684         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);
 685   #endif
 686
 687         factor_vm();
 688
 689 };
 690
 691 extern std::map<THREADHANDLE, factor_vm *> thread_vms;
 692
 693 }