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