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