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