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