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