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