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