vm/vm.hpp

   1 namespace factor
   2 {
   3
   4 struct growable_array;
   5
   6 struct factor_vm
   7 {
   8         // First five fields accessed directly by assembler. See vm.factor
   9
  10         /* Current stacks */
  11         context *ctx;
  12
  13         /* New objects are allocated here */
  14         zone nursery;
  15
  16         /* Add this to a shifted address to compute write barrier offsets */
  17         cell cards_offset;
  18         cell decks_offset;
  19
  20         /* TAGGED user environment data; see getenv/setenv prims */
  21         cell userenv[USER_ENV];
  22
  23         /* Data stack and retain stack sizes */
  24         cell ds_size, rs_size;
  25
  26         /* Pooling unused contexts to make callbacks cheaper */
  27         context *unused_contexts;
  28
  29         /* Canonical truth value. In Factor, 't' */
  30         cell true_object;
  31
  32         /* Is call counting enabled? */
  33         bool profiling_p;
  34
  35         /* Global variables used to pass fault handler state from signal handler to
  36            user-space */
  37         cell signal_number;
  38         cell signal_fault_addr;
  39         unsigned int signal_fpu_status;
  40         stack_frame *signal_callstack_top;
  41
  42         /* Zeroes out deallocated memory; set by the -securegc command line argument */
  43         bool secure_gc;
  44
  45         /* A heap walk allows useful things to be done, like finding all
  46            references to an object for debugging purposes. */
  47         cell heap_scan_ptr;
  48
  49         /* GC is off during heap walking */
  50         bool gc_off;
  51
  52         /* Data heap */
  53         data_heap *data;
  54
  55         /* Code heap */
  56         code_heap *code;
  57
  58         /* Pinned callback stubs */
  59         callback_heap *callbacks;
  60
  61         /* Only set if we're performing a GC */
  62         gc_state *current_gc;
  63
  64         /* Statistics */
  65         gc_statistics gc_stats;
  66
  67         /* If a runtime function needs to call another function which potentially
  68            allocates memory, it must wrap any local variable references to Factor
  69            objects in gc_root instances */
  70         std::vector<cell> gc_locals;
  71         std::vector<cell> gc_bignums;
  72
  73         /* Debugger */
  74         bool fep_disabled;
  75         bool full_output;
  76
  77         /* Canonical bignums */
  78         cell bignum_zero;
  79         cell bignum_pos_one;
  80         cell bignum_neg_one;
  81
  82         /* Method dispatch statistics */
  83         cell megamorphic_cache_hits;
  84         cell megamorphic_cache_misses;
  85
  86         cell cold_call_to_ic_transitions;
  87         cell ic_to_pic_transitions;
  88         cell pic_to_mega_transitions;
  89         /* Indexed by PIC_TAG, PIC_HI_TAG, PIC_TUPLE, PIC_HI_TAG_TUPLE */
  90         cell pic_counts[4];
  91
  92         /* Number of entries in a polymorphic inline cache */
  93         cell max_pic_size;
  94
  95         // contexts
  96         void reset_datastack();
  97         void reset_retainstack();
  98         void fix_stacks();
  99         void save_stacks();
 100         context *alloc_context();
 101         void dealloc_context(context *old_context);
 102         void nest_stacks(stack_frame *magic_frame);
 103         void unnest_stacks();
 104         void init_stacks(cell ds_size_, cell rs_size_);
 105         bool stack_to_array(cell bottom, cell top);
 106         cell array_to_stack(array *array, cell bottom);
 107         void primitive_datastack();
 108         void primitive_retainstack();
 109         void primitive_set_datastack();
 110         void primitive_set_retainstack();
 111         void primitive_check_datastack();
 112
 113         template<typename Iterator> void iterate_active_frames(Iterator &iter)
 114         {
 115                 context *ctx = this->ctx;
 116
 117                 while(ctx)
 118                 {
 119                         iterate_callstack(ctx,iter);
 120                         if(ctx->magic_frame) iter(ctx->magic_frame);
 121                         ctx = ctx->next;
 122                 }
 123         }
 124
 125         // run
 126         void primitive_getenv();
 127         void primitive_setenv();
 128         void primitive_exit();
 129         void primitive_micros();
 130         void primitive_sleep();
 131         void primitive_set_slot();
 132         void primitive_load_locals();
 133         cell clone_object(cell obj_);
 134         void primitive_clone();
 135
 136         // profiler
 137         void init_profiler();
 138         code_block *compile_profiling_stub(cell word_);
 139         void set_profiling(bool profiling);
 140         void primitive_profiling();
 141
 142         // errors
 143         void throw_error(cell error, stack_frame *callstack_top);
 144         void not_implemented_error();
 145         bool in_page(cell fault, cell area, cell area_size, int offset);
 146         void memory_protection_error(cell addr, stack_frame *native_stack);
 147         void signal_error(int signal, stack_frame *native_stack);
 148         void divide_by_zero_error();
 149         void fp_trap_error(unsigned int fpu_status, stack_frame *signal_callstack_top);
 150         void primitive_call_clear();
 151         void primitive_unimplemented();
 152         void memory_signal_handler_impl();
 153         void misc_signal_handler_impl();
 154         void fp_signal_handler_impl();
 155         void type_error(cell type, cell tagged);
 156         void general_error(vm_error_type error, cell arg1, cell arg2, stack_frame *native_stack);
 157
 158         // bignum
 159         int bignum_equal_p(bignum * x, bignum * y);
 160         enum bignum_comparison bignum_compare(bignum * x, bignum * y);
 161         bignum *bignum_add(bignum * x, bignum * y);
 162         bignum *bignum_subtract(bignum * x, bignum * y);
 163         bignum *bignum_multiply(bignum * x, bignum * y);
 164         void bignum_divide(bignum * numerator, bignum * denominator, bignum * * quotient, bignum * * remainder);
 165         bignum *bignum_quotient(bignum * numerator, bignum * denominator);
 166         bignum *bignum_remainder(bignum * numerator, bignum * denominator);
 167         cell bignum_to_cell(bignum * bignum);
 168         fixnum bignum_to_fixnum(bignum * bignum);
 169         s64 bignum_to_long_long(bignum * bignum);
 170         u64 bignum_to_ulong_long(bignum * bignum);
 171         double bignum_to_double(bignum * bignum);
 172         bignum *double_to_bignum(double x);
 173         int bignum_equal_p_unsigned(bignum * x, bignum * y);
 174         enum bignum_comparison bignum_compare_unsigned(bignum * x, bignum * y);
 175         bignum *bignum_add_unsigned(bignum * x, bignum * y, int negative_p);
 176         bignum *bignum_subtract_unsigned(bignum * x, bignum * y);
 177         bignum *bignum_multiply_unsigned(bignum * x, bignum * y, int negative_p);
 178         bignum *bignum_multiply_unsigned_small_factor(bignum * x, bignum_digit_type y,int negative_p);
 179         void bignum_destructive_add(bignum * bignum, bignum_digit_type n);
 180         void bignum_destructive_scale_up(bignum * bignum, bignum_digit_type factor);
 181         void bignum_divide_unsigned_large_denominator(bignum * numerator, bignum * denominator,
 182                                                       bignum * * quotient, bignum * * remainder, int q_negative_p, int r_negative_p);
 183         void bignum_divide_unsigned_normalized(bignum * u, bignum * v, bignum * q);
 184         bignum_digit_type bignum_divide_subtract(bignum_digit_type * v_start, bignum_digit_type * v_end,
 185                                                  bignum_digit_type guess, bignum_digit_type * u_start);
 186         void bignum_divide_unsigned_medium_denominator(bignum * numerator,bignum_digit_type denominator,
 187                                                        bignum * * quotient, bignum * * remainder,int q_negative_p, int r_negative_p);
 188         void bignum_destructive_normalization(bignum * source, bignum * target, int shift_left);
 189         void bignum_destructive_unnormalization(bignum * bignum, int shift_right);
 190         bignum_digit_type bignum_digit_divide(bignum_digit_type uh, bignum_digit_type ul,
 191                                               bignum_digit_type v, bignum_digit_type * q) /* return value */;
 192         bignum_digit_type bignum_digit_divide_subtract(bignum_digit_type v1, bignum_digit_type v2,
 193                                                        bignum_digit_type guess, bignum_digit_type * u);
 194         void bignum_divide_unsigned_small_denominator(bignum * numerator, bignum_digit_type denominator,
 195                                                       bignum * * quotient, bignum * * remainder,int q_negative_p, int r_negative_p);
 196         bignum_digit_type bignum_destructive_scale_down(bignum * bignum, bignum_digit_type denominator);
 197         bignum * bignum_remainder_unsigned_small_denominator(bignum * n, bignum_digit_type d, int negative_p);
 198         bignum *bignum_digit_to_bignum(bignum_digit_type digit, int negative_p);
 199         bignum *allot_bignum(bignum_length_type length, int negative_p);
 200         bignum * allot_bignum_zeroed(bignum_length_type length, int negative_p);
 201         bignum *bignum_shorten_length(bignum * bignum, bignum_length_type length);
 202         bignum *bignum_trim(bignum * bignum);
 203         bignum *bignum_new_sign(bignum * x, int negative_p);
 204         bignum *bignum_maybe_new_sign(bignum * x, int negative_p);
 205         void bignum_destructive_copy(bignum * source, bignum * target);
 206         bignum *bignum_bitwise_not(bignum * x);
 207         bignum *bignum_arithmetic_shift(bignum * arg1, fixnum n);
 208         bignum *bignum_bitwise_and(bignum * arg1, bignum * arg2);
 209         bignum *bignum_bitwise_ior(bignum * arg1, bignum * arg2);
 210         bignum *bignum_bitwise_xor(bignum * arg1, bignum * arg2);
 211         bignum *bignum_magnitude_ash(bignum * arg1, fixnum n);
 212         bignum *bignum_pospos_bitwise_op(int op, bignum * arg1, bignum * arg2);
 213         bignum *bignum_posneg_bitwise_op(int op, bignum * arg1, bignum * arg2);
 214         bignum *bignum_negneg_bitwise_op(int op, bignum * arg1, bignum * arg2);
 215         void bignum_negate_magnitude(bignum * arg);
 216         bignum *bignum_integer_length(bignum * x);
 217         int bignum_logbitp(int shift, bignum * arg);
 218         int bignum_unsigned_logbitp(int shift, bignum * bignum);
 219         bignum *digit_stream_to_bignum(unsigned int n_digits, unsigned int (*producer)(unsigned int, factor_vm *), unsigned int radix, int negative_p);
 220
 221         //data heap
 222         void init_card_decks();
 223         void clear_cards(old_space *gen);
 224         void clear_decks(old_space *gen);
 225         void reset_generation(old_space *gen);
 226         void set_data_heap(data_heap *data_);
 227         void init_data_heap(cell young_size, cell aging_size, cell tenured_size, bool secure_gc_);
 228         cell untagged_object_size(object *pointer);
 229         cell unaligned_object_size(object *pointer);
 230         void primitive_size();
 231         cell binary_payload_start(object *pointer);
 232         void primitive_data_room();
 233         void begin_scan();
 234         void end_scan();
 235         void primitive_begin_scan();
 236         cell next_object();
 237         void primitive_next_object();
 238         void primitive_end_scan();
 239         template<typename Iterator> void each_object(Iterator &iterator);
 240         cell find_all_words();
 241         cell object_size(cell tagged);
 242
 243         /* the write barrier must be called any time we are potentially storing a
 244            pointer from an older generation to a younger one */
 245         inline void write_barrier(cell *slot_ptr)
 246         {
 247                 *(char *)(cards_offset + ((cell)slot_ptr >> card_bits)) = card_mark_mask;
 248                 *(char *)(decks_offset + ((cell)slot_ptr >> deck_bits)) = card_mark_mask;
 249         }
 250
 251         // gc
 252         void update_code_heap_for_minor_gc(std::set<code_block *> *remembered_set);
 253         void collect_nursery();
 254         void collect_aging();
 255         void collect_to_tenured();
 256         void collect_full_impl(bool trace_contexts_p);
 257         void collect_growing_heap(cell requested_bytes, bool trace_contexts_p, bool compact_code_heap_p);
 258         void collect_full(bool trace_contexts_p, bool compact_code_heap_p);
 259         void record_gc_stats(generation_statistics *stats);
 260         void gc(gc_op op, cell requested_bytes, bool trace_contexts_p, bool compact_code_heap_p);
 261         void primitive_minor_gc();
 262         void primitive_full_gc();
 263         void primitive_compact_gc();
 264         void primitive_gc_stats();
 265         void clear_gc_stats();
 266         void primitive_become();
 267         void inline_gc(cell *gc_roots_base, cell gc_roots_size);
 268         object *allot_object(header header, cell size);
 269         void add_gc_stats(generation_statistics *stats, growable_array *result);
 270         void primitive_clear_gc_stats();
 271
 272         template<typename Type> Type *allot(cell size)
 273         {
 274                 return (Type *)allot_object(header(Type::type_number),size);
 275         }
 276
 277         inline void check_data_pointer(object *pointer)
 278         {
 279         #ifdef FACTOR_DEBUG
 280                 if(!(current_gc && current_gc->op == collect_growing_heap_op))
 281                 {
 282                         assert((cell)pointer >= data->seg->start
 283                                && (cell)pointer < data->seg->end);
 284                 }
 285         #endif
 286         }
 287
 288         inline void check_tagged_pointer(cell tagged)
 289         {
 290         #ifdef FACTOR_DEBUG
 291                 if(!immediate_p(tagged))
 292                 {
 293                         object *obj = untag<object>(tagged);
 294                         check_data_pointer(obj);
 295                         obj->h.hi_tag();
 296                 }
 297         #endif
 298         }
 299
 300         // generic arrays
 301         template<typename Array> Array *allot_array_internal(cell capacity);
 302         template<typename Array> bool reallot_array_in_place_p(Array *array, cell capacity);
 303         template<typename Array> Array *reallot_array(Array *array_, cell capacity);
 304
 305         //debug
 306         void print_chars(string* str);
 307         void print_word(word* word, cell nesting);
 308         void print_factor_string(string* str);
 309         void print_array(array* array, cell nesting);
 310         void print_tuple(tuple *tuple, cell nesting);
 311         void print_nested_obj(cell obj, fixnum nesting);
 312         void print_obj(cell obj);
 313         void print_objects(cell *start, cell *end);
 314         void print_datastack();
 315         void print_retainstack();
 316         void print_callstack();
 317         void dump_cell(cell x);
 318         void dump_memory(cell from, cell to);
 319         void dump_zone(const char *name, zone *z);
 320         void dump_generations();
 321         void dump_objects(cell type);
 322         void find_data_references_step(cell *scan);
 323         void find_data_references(cell look_for_);
 324         void dump_code_heap();
 325         void factorbug();
 326         void primitive_die();
 327
 328         //arrays
 329         array *allot_array(cell capacity, cell fill_);
 330         void primitive_array();
 331         cell allot_array_1(cell obj_);
 332         cell allot_array_2(cell v1_, cell v2_);
 333         cell allot_array_4(cell v1_, cell v2_, cell v3_, cell v4_);
 334         void primitive_resize_array();
 335         inline void set_array_nth(array *array, cell slot, cell value);
 336
 337         //strings
 338         cell string_nth(string* str, cell index);
 339         void set_string_nth_fast(string *str, cell index, cell ch);
 340         void set_string_nth_slow(string *str_, cell index, cell ch);
 341         void set_string_nth(string *str, cell index, cell ch);
 342         string *allot_string_internal(cell capacity);
 343         void fill_string(string *str_, cell start, cell capacity, cell fill);
 344         string *allot_string(cell capacity, cell fill);
 345         void primitive_string();
 346         bool reallot_string_in_place_p(string *str, cell capacity);
 347         string* reallot_string(string *str_, cell capacity);
 348         void primitive_resize_string();
 349         void primitive_string_nth();
 350         void primitive_set_string_nth_fast();
 351         void primitive_set_string_nth_slow();
 352
 353         //booleans
 354         void box_boolean(bool value);
 355         bool to_boolean(cell value);
 356         inline cell tag_boolean(cell untagged);
 357
 358         //byte arrays
 359         byte_array *allot_byte_array(cell size);
 360         void primitive_byte_array();
 361         void primitive_uninitialized_byte_array();
 362         void primitive_resize_byte_array();
 363
 364         //tuples
 365         tuple *allot_tuple(cell layout_);
 366         void primitive_tuple();
 367         void primitive_tuple_boa();
 368
 369         //words
 370         word *allot_word(cell name_, cell vocab_, cell hashcode_);
 371         void primitive_word();
 372         void primitive_word_xt();
 373         void update_word_xt(cell w_);
 374         void primitive_optimized_p();
 375         void primitive_wrapper();
 376
 377         //math
 378         void primitive_bignum_to_fixnum();
 379         void primitive_float_to_fixnum();
 380         void primitive_fixnum_divint();
 381         void primitive_fixnum_divmod();
 382         bignum *fixnum_to_bignum(fixnum);
 383         bignum *cell_to_bignum(cell);
 384         bignum *long_long_to_bignum(s64 n);
 385         bignum *ulong_long_to_bignum(u64 n);
 386         inline fixnum sign_mask(fixnum x);
 387         inline fixnum branchless_max(fixnum x, fixnum y);
 388         inline fixnum branchless_abs(fixnum x);
 389         void primitive_fixnum_shift();
 390         void primitive_fixnum_to_bignum();
 391         void primitive_float_to_bignum();
 392         void primitive_bignum_eq();
 393         void primitive_bignum_add();
 394         void primitive_bignum_subtract();
 395         void primitive_bignum_multiply();
 396         void primitive_bignum_divint();
 397         void primitive_bignum_divmod();
 398         void primitive_bignum_mod();
 399         void primitive_bignum_and();
 400         void primitive_bignum_or();
 401         void primitive_bignum_xor();
 402         void primitive_bignum_shift();
 403         void primitive_bignum_less();
 404         void primitive_bignum_lesseq();
 405         void primitive_bignum_greater();
 406         void primitive_bignum_greatereq();
 407         void primitive_bignum_not();
 408         void primitive_bignum_bitp();
 409         void primitive_bignum_log2();
 410         unsigned int bignum_producer(unsigned int digit);
 411         void primitive_byte_array_to_bignum();
 412         cell unbox_array_size();
 413         void primitive_fixnum_to_float();
 414         void primitive_bignum_to_float();
 415         void primitive_str_to_float();
 416         void primitive_float_to_str();
 417         void primitive_float_eq();
 418         void primitive_float_add();
 419         void primitive_float_subtract();
 420         void primitive_float_multiply();
 421         void primitive_float_divfloat();
 422         void primitive_float_mod();
 423         void primitive_float_less();
 424         void primitive_float_lesseq();
 425         void primitive_float_greater();
 426         void primitive_float_greatereq();
 427         void primitive_float_bits();
 428         void primitive_bits_float();
 429         void primitive_double_bits();
 430         void primitive_bits_double();
 431         fixnum to_fixnum(cell tagged);
 432         cell to_cell(cell tagged);
 433         void box_signed_1(s8 n);
 434         void box_unsigned_1(u8 n);
 435         void box_signed_2(s16 n);
 436         void box_unsigned_2(u16 n);
 437         void box_signed_4(s32 n);
 438         void box_unsigned_4(u32 n);
 439         void box_signed_cell(fixnum integer);
 440         void box_unsigned_cell(cell cell);
 441         void box_signed_8(s64 n);
 442         s64 to_signed_8(cell obj);
 443         void box_unsigned_8(u64 n);
 444         u64 to_unsigned_8(cell obj);
 445         void box_float(float flo);
 446         float to_float(cell value);
 447         void box_double(double flo);
 448         double to_double(cell value);
 449         inline void overflow_fixnum_add(fixnum x, fixnum y);
 450         inline void overflow_fixnum_subtract(fixnum x, fixnum y);
 451         inline void overflow_fixnum_multiply(fixnum x, fixnum y);
 452         inline cell allot_integer(fixnum x);
 453         inline cell allot_cell(cell x);
 454         inline cell allot_float(double n);
 455         inline bignum *float_to_bignum(cell tagged);
 456         inline double bignum_to_float(cell tagged);
 457         inline double untag_float(cell tagged);
 458         inline double untag_float_check(cell tagged);
 459         inline fixnum float_to_fixnum(cell tagged);
 460         inline double fixnum_to_float(cell tagged);
 461         template<typename Type> Type *untag_check(cell value);
 462         template<typename Type> Type *untag(cell value);
 463
 464         //io
 465         void init_c_io();
 466         void io_error();
 467         void primitive_fopen();
 468         void primitive_fgetc();
 469         void primitive_fread();
 470         void primitive_fputc();
 471         void primitive_fwrite();
 472         void primitive_ftell();
 473         void primitive_fseek();
 474         void primitive_fflush();
 475         void primitive_fclose();
 476
 477         //code_block
 478         relocation_type relocation_type_of(relocation_entry r);
 479         relocation_class relocation_class_of(relocation_entry r);
 480         cell relocation_offset_of(relocation_entry r);
 481         void flush_icache_for(code_block *block);
 482         int number_of_parameters(relocation_type type);
 483         void *object_xt(cell obj);
 484         void *xt_pic(word *w, cell tagged_quot);
 485         void *word_xt_pic(word *w);
 486         void *word_xt_pic_tail(word *w);
 487         void undefined_symbol();
 488         void *get_rel_symbol(array *literals, cell index);
 489         cell compute_relocation(relocation_entry rel, cell index, code_block *compiled);
 490         template<typename Iterator> void iterate_relocations(code_block *compiled, Iterator &iter);
 491         void store_address_2_2(cell *ptr, cell value);
 492         void store_address_masked(cell *ptr, fixnum value, cell mask, fixnum shift);
 493         void store_address_in_code_block(cell klass, cell offset, fixnum absolute_value);
 494         void update_literal_references(code_block *compiled);
 495         void relocate_code_block_step(relocation_entry rel, cell index, code_block *compiled);
 496         void update_word_references(code_block *compiled);
 497         void update_code_block_for_full_gc(code_block *compiled);
 498         void check_code_address(cell address);
 499         void relocate_code_block(code_block *compiled);
 500         void fixup_labels(array *labels, code_block *compiled);
 501         code_block *allot_code_block(cell size, cell type);
 502         code_block *add_code_block(cell type, cell code_, cell labels_, cell owner_, cell relocation_, cell literals_);
 503
 504         //code heap
 505         inline void check_code_pointer(cell ptr)
 506         {
 507         #ifdef FACTOR_DEBUG
 508                 assert(in_code_heap_p(ptr));
 509         #endif
 510         }
 511
 512         void init_code_heap(cell size);
 513         bool in_code_heap_p(cell ptr);
 514         void jit_compile_word(cell word_, cell def_, bool relocate);
 515         void update_code_heap_words();
 516         void primitive_modify_code_heap();
 517         void primitive_code_room();
 518         void forward_object_xts();
 519         void forward_context_xts();
 520         void forward_callback_xts();
 521         void compact_code_heap(bool trace_contexts_p);
 522         void primitive_strip_stack_traces();
 523
 524         /* Apply a function to every code block */
 525         template<typename Iterator> void iterate_code_heap(Iterator &iter)
 526         {
 527                 heap_block *scan = code->first_block();
 528
 529                 while(scan)
 530                 {
 531                         if(scan->type() != FREE_BLOCK_TYPE)
 532                                 iter((code_block *)scan);
 533                         scan = code->next_block(scan);
 534                 }
 535         }
 536
 537         //callbacks
 538         void init_callbacks(cell size);
 539         void primitive_callback();
 540
 541         //image
 542         void init_objects(image_header *h);
 543         void load_data_heap(FILE *file, image_header *h, vm_parameters *p);
 544         void load_code_heap(FILE *file, image_header *h, vm_parameters *p);
 545         bool save_image(const vm_char *filename);
 546         void primitive_save_image();
 547         void primitive_save_image_and_exit();
 548         void data_fixup(cell *handle, cell data_relocation_base);
 549         template<typename Type> void code_fixup(Type **handle, cell code_relocation_base);
 550         void fixup_word(word *word, cell code_relocation_base);
 551         void fixup_quotation(quotation *quot, cell code_relocation_base);
 552         void fixup_alien(alien *d);
 553         void fixup_callstack_object(callstack *stack, cell code_relocation_base);
 554         void relocate_object(object *object, cell data_relocation_base, cell code_relocation_base);
 555         void relocate_data(cell data_relocation_base, cell code_relocation_base);
 556         void fixup_code_block(code_block *compiled, cell data_relocation_base);
 557         void relocate_code(cell data_relocation_base);
 558         void load_image(vm_parameters *p);
 559
 560         //callstack
 561         template<typename Iterator> void iterate_callstack_object(callstack *stack_, Iterator &iterator);
 562         void check_frame(stack_frame *frame);
 563         callstack *allot_callstack(cell size);
 564         stack_frame *fix_callstack_top(stack_frame *top, stack_frame *bottom);
 565         stack_frame *capture_start();
 566         void primitive_callstack();
 567         void primitive_set_callstack();
 568         code_block *frame_code(stack_frame *frame);
 569         cell frame_type(stack_frame *frame);
 570         cell frame_executing(stack_frame *frame);
 571         stack_frame *frame_successor(stack_frame *frame);
 572         cell frame_scan(stack_frame *frame);
 573         void primitive_callstack_to_array();
 574         stack_frame *innermost_stack_frame(callstack *stack);
 575         stack_frame *innermost_stack_frame_quot(callstack *callstack);
 576         void primitive_innermost_stack_frame_executing();
 577         void primitive_innermost_stack_frame_scan();
 578         void primitive_set_innermost_stack_frame_quot();
 579         void save_callstack_bottom(stack_frame *callstack_bottom);
 580         template<typename Iterator> void iterate_callstack(context *ctx, Iterator &iterator);
 581
 582         /* Every object has a regular representation in the runtime, which makes GC
 583         much simpler. Every slot of the object until binary_payload_start is a pointer
 584         to some other object. */
 585         template<typename Iterator> void do_slots(cell obj, Iterator &iter)
 586         {
 587                 cell scan = obj;
 588                 cell payload_start = binary_payload_start((object *)obj);
 589                 cell end = obj + payload_start;
 590
 591                 scan += sizeof(cell);
 592
 593                 while(scan < end)
 594                 {
 595                         iter((cell *)scan);
 596                         scan += sizeof(cell);
 597                 }
 598         }
 599
 600         //alien
 601         char *pinned_alien_offset(cell obj);
 602         cell allot_alien(cell delegate_, cell displacement);
 603         void primitive_displaced_alien();
 604         void primitive_alien_address();
 605         void *alien_pointer();
 606         void primitive_dlopen();
 607         void primitive_dlsym();
 608         void primitive_dlclose();
 609         void primitive_dll_validp();
 610         void primitive_vm_ptr();
 611         char *alien_offset(cell obj);
 612         char *unbox_alien();
 613         void box_alien(void *ptr);
 614         void to_value_struct(cell src, void *dest, cell size);
 615         void box_value_struct(void *src, cell size);
 616         void box_small_struct(cell x, cell y, cell size);
 617         void box_medium_struct(cell x1, cell x2, cell x3, cell x4, cell size);
 618
 619         //quotations
 620         void primitive_jit_compile();
 621         void primitive_array_to_quotation();
 622         void primitive_quotation_xt();
 623         void set_quot_xt(quotation *quot, code_block *code);
 624         void jit_compile(cell quot_, bool relocating);
 625         void compile_all_words();
 626         fixnum quot_code_offset_to_scan(cell quot_, cell offset);
 627         cell lazy_jit_compile_impl(cell quot_, stack_frame *stack);
 628         void primitive_quot_compiled_p();
 629
 630         //dispatch
 631         cell search_lookup_alist(cell table, cell klass);
 632         cell search_lookup_hash(cell table, cell klass, cell hashcode);
 633         cell nth_superclass(tuple_layout *layout, fixnum echelon);
 634         cell nth_hashcode(tuple_layout *layout, fixnum echelon);
 635         cell lookup_tuple_method(cell obj, cell methods);
 636         cell lookup_hi_tag_method(cell obj, cell methods);
 637         cell lookup_hairy_method(cell obj, cell methods);
 638         cell lookup_method(cell obj, cell methods);
 639         void primitive_lookup_method();
 640         cell object_class(cell obj);
 641         cell method_cache_hashcode(cell klass, array *array);
 642         void update_method_cache(cell cache, cell klass, cell method);
 643         void primitive_mega_cache_miss();
 644         void primitive_reset_dispatch_stats();
 645         void primitive_dispatch_stats();
 646
 647         //inline cache
 648         void init_inline_caching(int max_size);
 649         void deallocate_inline_cache(cell return_address);
 650         cell determine_inline_cache_type(array *cache_entries);
 651         void update_pic_count(cell type);
 652         code_block *compile_inline_cache(fixnum index,cell generic_word_,cell methods_,cell cache_entries_,bool tail_call_p);
 653         void *megamorphic_call_stub(cell generic_word);
 654         cell inline_cache_size(cell cache_entries);
 655         cell add_inline_cache_entry(cell cache_entries_, cell klass_, cell method_);
 656         void update_pic_transitions(cell pic_size);
 657         void *inline_cache_miss(cell return_address);
 658         void primitive_reset_inline_cache_stats();
 659         void primitive_inline_cache_stats();
 660
 661         //factor
 662         void default_parameters(vm_parameters *p);
 663         bool factor_arg(const vm_char* str, const vm_char* arg, cell* value);
 664         void init_parameters_from_args(vm_parameters *p, int argc, vm_char **argv);
 665         void do_stage1_init();
 666         void init_factor(vm_parameters *p);
 667         void pass_args_to_factor(int argc, vm_char **argv);
 668         void start_factor(vm_parameters *p);
 669         void stop_factor();
 670         void start_embedded_factor(vm_parameters *p);
 671         void start_standalone_factor(int argc, vm_char **argv);
 672         char *factor_eval_string(char *string);
 673         void factor_eval_free(char *result);
 674         void factor_yield();
 675         void factor_sleep(long us);
 676
 677         // os-*
 678         void primitive_existsp();
 679         void init_ffi();
 680         void ffi_dlopen(dll *dll);
 681         void *ffi_dlsym(dll *dll, symbol_char *symbol);
 682         void ffi_dlclose(dll *dll);
 683         void c_to_factor_toplevel(cell quot);
 684
 685         // os-windows
 686   #if defined(WINDOWS)
 687         void sleep_micros(u64 usec);
 688         const vm_char *vm_executable_path();
 689         const vm_char *default_image_path();
 690         void windows_image_path(vm_char *full_path, vm_char *temp_path, unsigned int length);
 691         bool windows_stat(vm_char *path);
 692
 693    #if defined(WINNT)
 694         void open_console();
 695         LONG exception_handler(PEXCEPTION_POINTERS pe);
 696         // next method here:
 697    #endif
 698   #else  // UNIX
 699         void memory_signal_handler(int signal, siginfo_t *siginfo, void *uap);
 700         void misc_signal_handler(int signal, siginfo_t *siginfo, void *uap);
 701         void fpe_signal_handler(int signal, siginfo_t *siginfo, void *uap);
 702         stack_frame *uap_stack_pointer(void *uap);
 703
 704   #endif
 705
 706   #ifdef __APPLE__
 707         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);
 708   #endif
 709
 710         factor_vm();
 711
 712 };
 713
 714 extern unordered_map<THREADHANDLE, factor_vm *> thread_vms;
 715
 716 }