vm/vm.hpp

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