vm/vm.hpp

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