vm/vm.hpp

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