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