vm/vm.hpp

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