vm_core.h

   1 /**********************************************************************
   2
   3   vm_core.h -
   4
   5   $Author$
   6   created at: 04/01/01 19:41:38 JST
   7
   8   Copyright (C) 2004-2007 Koichi Sasada
   9
  10 **********************************************************************/
  11
  12 #ifndef RUBY_VM_CORE_H
  13 #define RUBY_VM_CORE_H
  14
  15 #define RUBY_VM_THREAD_MODEL 2
  16
  17 #include <setjmp.h>
  18
  19 #include "ruby/ruby.h"
  20 #include "ruby/mvm.h"
  21 #include "ruby/signal.h"
  22 #include "ruby/st.h"
  23 #include "ruby/node.h"
  24
  25 #include "debug.h"
  26 #include "vm_opts.h"
  27 #include "id.h"
  28
  29 #if   defined(_WIN32)
  30 #include "thread_win32.h"
  31 #elif defined(HAVE_PTHREAD_H)
  32 #include "thread_pthread.h"
  33 #else
  34 #error "unsupported thread type"
  35 #endif
  36
  37 #include <signal.h>
  38
  39 #ifndef NSIG
  40 # ifdef DJGPP
  41 #  define NSIG SIGMAX
  42 # else
  43 #  define NSIG (_SIGMAX + 1)      /* For QNX */
  44 # endif
  45 #endif
  46
  47 #define RUBY_NSIG NSIG
  48
  49 /*****************/
  50 /* configuration */
  51 /*****************/
  52
  53 /* gcc ver. check */
  54 #if defined(__GNUC__) && __GNUC__ >= 2
  55
  56 #if OPT_TOKEN_THREADED_CODE
  57 #if OPT_DIRECT_THREADED_CODE
  58 #undef OPT_DIRECT_THREADED_CODE
  59 #endif
  60 #endif
  61
  62 #else /* defined(__GNUC__) && __GNUC__ >= 2 */
  63
  64 /* disable threaded code options */
  65 #if OPT_DIRECT_THREADED_CODE
  66 #undef OPT_DIRECT_THREADED_CODE
  67 #endif
  68 #if OPT_TOKEN_THREADED_CODE
  69 #undef OPT_TOKEN_THREADED_CODE
  70 #endif
  71 #endif
  72
  73 /* call threaded code */
  74 #if    OPT_CALL_THREADED_CODE
  75 #if    OPT_DIRECT_THREADED_CODE
  76 #undef OPT_DIRECT_THREADED_CODE
  77 #endif /* OPT_DIRECT_THREADED_CODE */
  78 #if    OPT_STACK_CACHING
  79 #undef OPT_STACK_CACHING
  80 #endif /* OPT_STACK_CACHING */
  81 #endif /* OPT_CALL_THREADED_CODE */
  82
  83 /* likely */
  84 #if __GNUC__ >= 3
  85 #define LIKELY(x)   (__builtin_expect((x), 1))
  86 #define UNLIKELY(x) (__builtin_expect((x), 0))
  87 #else /* __GNUC__ >= 3 */
  88 #define LIKELY(x)   (x)
  89 #define UNLIKELY(x) (x)
  90 #endif /* __GNUC__ >= 3 */
  91
  92 typedef unsigned long rb_num_t;
  93
  94 #define ISEQ_TYPE_TOP    INT2FIX(1)
  95 #define ISEQ_TYPE_METHOD INT2FIX(2)
  96 #define ISEQ_TYPE_BLOCK  INT2FIX(3)
  97 #define ISEQ_TYPE_CLASS  INT2FIX(4)
  98 #define ISEQ_TYPE_RESCUE INT2FIX(5)
  99 #define ISEQ_TYPE_ENSURE INT2FIX(6)
 100 #define ISEQ_TYPE_EVAL   INT2FIX(7)
 101 #define ISEQ_TYPE_DEFINED_GUARD INT2FIX(8)
 102
 103 #define CATCH_TYPE_RESCUE INT2FIX(1)
 104 #define CATCH_TYPE_ENSURE INT2FIX(2)
 105 #define CATCH_TYPE_RETRY  INT2FIX(3)
 106 #define CATCH_TYPE_BREAK  INT2FIX(4)
 107 #define CATCH_TYPE_REDO   INT2FIX(5)
 108 #define CATCH_TYPE_NEXT   INT2FIX(6)
 109
 110 struct iseq_insn_info_entry {
 111     unsigned short position;
 112     unsigned short line_no;
 113     unsigned short sp;
 114 };
 115
 116 struct iseq_catch_table_entry {
 117     VALUE type;
 118     VALUE iseq;
 119     unsigned long start;
 120     unsigned long end;
 121     unsigned long cont;
 122     unsigned long sp;
 123 };
 124
 125 #define INITIAL_ISEQ_COMPILE_DATA_STORAGE_BUFF_SIZE (512)
 126
 127 struct iseq_compile_data_storage {
 128     struct iseq_compile_data_storage *next;
 129     unsigned long pos;
 130     unsigned long size;
 131     char *buff;
 132 };
 133
 134 struct iseq_compile_data_ensure_node_stack;
 135
 136 typedef struct rb_compile_option_struct {
 137     int inline_const_cache;
 138     int peephole_optimization;
 139     int tailcall_optimization;
 140     int specialized_instruction;
 141     int operands_unification;
 142     int instructions_unification;
 143     int stack_caching;
 144     int trace_instruction;
 145     int debug_level;
 146 } rb_compile_option_t;
 147
 148 struct iseq_compile_data {
 149     /* GC is needed */
 150     VALUE err_info;
 151     VALUE mark_ary;
 152     VALUE catch_table_ary;      /* Array */
 153
 154     /* GC is not needed */
 155     struct iseq_label_data *start_label;
 156     struct iseq_label_data *end_label;
 157     struct iseq_label_data *redo_label;
 158     VALUE current_block;
 159     VALUE loopval_popped;       /* used by NODE_BREAK */
 160     VALUE ensure_node;
 161     VALUE for_iseq;
 162     struct iseq_compile_data_ensure_node_stack *ensure_node_stack;
 163     int cached_const;
 164     struct iseq_compile_data_storage *storage_head;
 165     struct iseq_compile_data_storage *storage_current;
 166     int last_line;
 167     int flip_cnt;
 168     int label_no;
 169     int node_level;
 170     const rb_compile_option_t *option;
 171 };
 172
 173 #if 1
 174 #define GetCoreDataFromValue(obj, type, ptr) do { \
 175     ptr = (type*)DATA_PTR(obj); \
 176 } while (0)
 177 #else
 178 #define GetCoreDataFromValue(obj, type, ptr) Data_Get_Struct(obj, type, ptr)
 179 #endif
 180
 181 #define GetISeqPtr(obj, ptr) \
 182   GetCoreDataFromValue(obj, rb_iseq_t, ptr)
 183
 184 typedef struct rb_iseq_profile_struct {
 185     VALUE count;
 186     VALUE time_self;
 187     VALUE time_cumu; /* cumulative */
 188 } rb_iseq_profile_t;
 189
 190 struct rb_iseq_struct;
 191
 192 struct rb_iseq_struct {
 193     /***************/
 194     /* static data */
 195     /***************/
 196
 197     VALUE type;          /* instruction sequence type */
 198     VALUE name;          /* String: iseq name */
 199     VALUE filename;      /* file information where this sequence from */
 200     VALUE *iseq;         /* iseq (insn number and openrads) */
 201     VALUE *iseq_encoded; /* encoded iseq */
 202     unsigned long iseq_size;
 203     VALUE mark_ary;     /* Array: includes operands which should be GC marked */
 204     VALUE coverage;     /* coverage array */
 205
 206     /* insn info, must be freed */
 207     struct iseq_insn_info_entry *insn_info_table;
 208     unsigned long insn_info_size;
 209
 210     ID *local_table;            /* must free */
 211     int local_table_size;
 212
 213     /* method, class frame: sizeof(vars) + 1, block frame: sizeof(vars) */
 214     int local_size;
 215
 216     /**
 217      * argument information
 218      *
 219      *  def m(a1, a2, ..., aM,                    # mandatory
 220      *        b1=(...), b2=(...), ..., bN=(...),  # optinal
 221      *        *c,                                 # rest
 222      *        d1, d2, ..., dO,                    # post
 223      *        &e)                                 # block
 224      * =>
 225      *
 226      *  argc           = M
 227      *  arg_rest       = M+N+1 // or -1 if no rest arg
 228      *  arg_opts       = N
 229      *  arg_opts_tbl   = [ (N entries) ]
 230      *  arg_post_len   = O // 0 if no post arguments
 231      *  arg_post_start = M+N+2
 232      *  arg_block      = M+N + 1 + O + 1 // -1 if no block arg
 233      *  arg_simple     = 0 if not simple arguments.
 234      *                 = 1 if no opt, rest, post, block.
 235      *                 = 2 if ambiguos block parameter ({|a|}).
 236      *  arg_size       = argument size.
 237      */
 238
 239     int argc;
 240     int arg_simple;
 241     int arg_rest;
 242     int arg_block;
 243     int arg_opts;
 244     int arg_post_len;
 245     int arg_post_start;
 246     int arg_size;
 247     VALUE *arg_opt_table;
 248
 249     int stack_max; /* for stack overflow check */
 250
 251     /* catch table */
 252     struct iseq_catch_table_entry *catch_table;
 253     int catch_table_size;
 254
 255     /* for child iseq */
 256     struct rb_iseq_struct *parent_iseq;
 257     struct rb_iseq_struct *local_iseq;
 258
 259     /****************/
 260     /* dynamic data */
 261     /****************/
 262
 263     VALUE self;
 264     VALUE orig;                 /* non-NULL if its data have origin */
 265
 266     /* block inlining */
 267     /*
 268      * NODE *node;
 269      * void *special_block_builder;
 270      * void *cached_special_block_builder;
 271      * VALUE cached_special_block;
 272      */
 273
 274     /* klass/module nest information stack (cref) */
 275     NODE *cref_stack;
 276     VALUE klass;
 277
 278     /* misc */
 279     ID defined_method_id;       /* for define_method */
 280     rb_iseq_profile_t profile;
 281
 282     /* used at compile time */
 283     struct iseq_compile_data *compile_data;
 284 };
 285
 286 enum ruby_special_exceptions {
 287     ruby_error_reenter,
 288     ruby_error_nomemory,
 289     ruby_error_sysstack,
 290     ruby_special_error_count
 291 };
 292
 293 typedef struct rb_iseq_struct rb_iseq_t;
 294
 295 #define GetVMPtr(obj, ptr) \
 296   GetCoreDataFromValue(obj, rb_vm_t, ptr)
 297
 298 struct rb_vm_struct
 299 {
 300     VALUE self;
 301
 302     rb_thread_lock_t global_vm_lock;
 303
 304     struct rb_thread_struct *main_thread;
 305     struct rb_thread_struct *running_thread;
 306
 307     st_table *living_threads;
 308     VALUE thgroup_default;
 309
 310     int running;
 311     int thread_abort_on_exception;
 312     unsigned long trace_flag;
 313     volatile int sleeper;
 314
 315     /* object management */
 316     VALUE mark_object_ary;
 317
 318     VALUE special_exceptions[ruby_special_error_count];
 319
 320     /* load */
 321     VALUE top_self;
 322     VALUE load_path;
 323     VALUE loaded_features;
 324     struct st_table *loading_table;
 325
 326     /* signal */
 327     rb_atomic_t signal_buff[RUBY_NSIG];
 328     rb_atomic_t buffered_signal_size;
 329
 330     /* hook */
 331     rb_event_hook_t *event_hooks;
 332
 333     int src_encoding_index;
 334
 335     VALUE verbose, debug, progname;
 336     VALUE coverages;
 337
 338 #if defined(ENABLE_VM_OBJSPACE) && ENABLE_VM_OBJSPACE
 339     struct rb_objspace *objspace;
 340 #endif
 341 };
 342
 343 typedef struct {
 344     VALUE *pc;                  /* cfp[0] */
 345     VALUE *sp;                  /* cfp[1] */
 346     VALUE *bp;                  /* cfp[2] */
 347     rb_iseq_t *iseq;            /* cfp[3] */
 348     VALUE flag;                 /* cfp[4] */
 349     VALUE self;                 /* cfp[5] / block[0] */
 350     VALUE *lfp;                 /* cfp[6] / block[1] */
 351     VALUE *dfp;                 /* cfp[7] / block[2] */
 352     rb_iseq_t *block_iseq;      /* cfp[8] / block[3] */
 353     VALUE proc;                 /* cfp[9] / block[4] */
 354     ID method_id;               /* cfp[10] saved in special case */
 355     VALUE method_class;         /* cfp[11] saved in special case */
 356     VALUE prof_time_self;       /* cfp[12] */
 357     VALUE prof_time_chld;       /* cfp[13] */
 358 } rb_control_frame_t;
 359
 360 typedef struct rb_block_struct {
 361     VALUE self;                 /* share with method frame if it's only block */
 362     VALUE *lfp;                 /* share with method frame if it's only block */
 363     VALUE *dfp;                 /* share with method frame if it's only block */
 364     rb_iseq_t *iseq;
 365     VALUE proc;
 366 } rb_block_t;
 367
 368 #define GetThreadPtr(obj, ptr) \
 369   GetCoreDataFromValue(obj, rb_thread_t, ptr)
 370
 371 enum rb_thread_status {
 372     THREAD_TO_KILL,
 373     THREAD_RUNNABLE,
 374     THREAD_STOPPED,
 375     THREAD_STOPPED_FOREVER,
 376     THREAD_KILLED
 377 };
 378
 379 typedef RUBY_JMP_BUF rb_jmpbuf_t;
 380
 381 struct rb_vm_tag {
 382     rb_jmpbuf_t buf;
 383     VALUE tag;
 384     VALUE retval;
 385     struct rb_vm_tag *prev;
 386 };
 387
 388 struct rb_vm_trap_tag {
 389     struct rb_vm_trap_tag *prev;
 390 };
 391
 392 #define RUBY_VM_VALUE_CACHE_SIZE 0x1000
 393 #define USE_VALUE_CACHE 0
 394
 395 struct rb_unblock_callback {
 396     rb_unblock_function_t *func;
 397     void *arg;
 398 };
 399
 400 struct rb_mutex_struct;
 401
 402 struct rb_thread_struct
 403 {
 404     VALUE self;
 405     rb_vm_t *vm;
 406
 407     /* execution information */
 408     VALUE *stack;               /* must free, must mark */
 409     unsigned long stack_size;
 410     rb_control_frame_t *cfp;
 411     int safe_level;
 412     int raised_flag;
 413     VALUE last_status; /* $? */
 414
 415     /* passing state */
 416     int state;
 417
 418     /* for rb_iterate */
 419     rb_block_t *passed_block;
 420
 421     /* for load(true) */
 422     VALUE top_self;
 423     VALUE top_wrapper;
 424
 425     /* eval env */
 426     rb_block_t *base_block;
 427
 428     VALUE *local_lfp;
 429     VALUE local_svar;
 430
 431     /* thread control */
 432     rb_thread_id_t thread_id;
 433     enum rb_thread_status status;
 434     int priority;
 435
 436     native_thread_data_t native_thread_data;
 437
 438     VALUE thgroup;
 439     VALUE value;
 440
 441     VALUE errinfo;
 442     VALUE thrown_errinfo;
 443     int exec_signal;
 444
 445     int interrupt_flag;
 446     rb_thread_lock_t interrupt_lock;
 447     struct rb_unblock_callback unblock;
 448     VALUE locking_mutex;
 449     struct rb_mutex_struct *keeping_mutexes;
 450     int transition_for_lock;
 451
 452     struct rb_vm_tag *tag;
 453     struct rb_vm_trap_tag *trap_tag;
 454
 455     int parse_in_eval;
 456     int mild_compile_error;
 457
 458     /* storage */
 459     st_table *local_storage;
 460 #if USE_VALUE_CACHE
 461     VALUE value_cache[RUBY_VM_VALUE_CACHE_SIZE + 1];
 462     VALUE *value_cache_ptr;
 463 #endif
 464
 465     struct rb_thread_struct *join_list_next;
 466     struct rb_thread_struct *join_list_head;
 467
 468     VALUE first_proc;
 469     VALUE first_args;
 470     VALUE (*first_func)(ANYARGS);
 471
 472     /* for GC */
 473     VALUE *machine_stack_start;
 474     VALUE *machine_stack_end;
 475     size_t machine_stack_maxsize;
 476 #ifdef __ia64
 477     VALUE *machine_register_stack_start;
 478     VALUE *machine_register_stack_end;
 479     size_t machine_register_stack_maxsize;
 480 #endif
 481     jmp_buf machine_regs;
 482     int mark_stack_len;
 483
 484     /* statistics data for profiler */
 485     VALUE stat_insn_usage;
 486
 487     /* tracer */
 488     rb_event_hook_t *event_hooks;
 489     rb_event_flag_t event_flags;
 490     int tracing;
 491
 492     /* fiber */
 493     VALUE fiber;
 494     VALUE root_fiber;
 495     rb_jmpbuf_t root_jmpbuf;
 496
 497     /* misc */
 498     int method_missing_reason;
 499     int abort_on_exception;
 500 };
 501
 502 /* iseq.c */
 503 VALUE rb_iseq_new(NODE*, VALUE, VALUE, VALUE, VALUE);
 504 VALUE rb_iseq_new_with_bopt(NODE*, VALUE, VALUE, VALUE, VALUE, VALUE);
 505 VALUE rb_iseq_new_with_opt(NODE*, VALUE, VALUE, VALUE, VALUE, const rb_compile_option_t*);
 506 VALUE rb_iseq_compile(VALUE src, VALUE file, VALUE line);
 507 VALUE ruby_iseq_disasm(VALUE self);
 508 VALUE ruby_iseq_disasm_insn(VALUE str, VALUE *iseqval, int pos, rb_iseq_t *iseq, VALUE child);
 509 const char *ruby_node_name(int node);
 510 VALUE rb_iseq_clone(VALUE iseqval, VALUE newcbase);
 511
 512 RUBY_EXTERN VALUE rb_cISeq;
 513 RUBY_EXTERN VALUE rb_cRubyVM;
 514 RUBY_EXTERN VALUE rb_cEnv;
 515 RUBY_EXTERN VALUE rb_mRubyVMFrozenCore;
 516
 517 /* each thread has this size stack : 128KB */
 518 #define RUBY_VM_THREAD_STACK_SIZE (128 * 1024)
 519
 520 struct global_entry {
 521     struct global_variable *var;
 522     ID id;
 523 };
 524
 525 #define GetProcPtr(obj, ptr) \
 526   GetCoreDataFromValue(obj, rb_proc_t, ptr)
 527
 528 typedef struct {
 529     rb_block_t block;
 530
 531     VALUE envval;               /* for GC mark */
 532     VALUE blockprocval;
 533     int safe_level;
 534     int is_from_method;
 535     int is_lambda;
 536 } rb_proc_t;
 537
 538 #define GetEnvPtr(obj, ptr) \
 539   GetCoreDataFromValue(obj, rb_env_t, ptr)
 540
 541 typedef struct {
 542     VALUE *env;
 543     int env_size;
 544     int local_size;
 545     VALUE prev_envval;          /* for GC mark */
 546     rb_block_t block;
 547 } rb_env_t;
 548
 549 #define GetBindingPtr(obj, ptr) \
 550   GetCoreDataFromValue(obj, rb_binding_t, ptr)
 551
 552 typedef struct {
 553     VALUE env;
 554 } rb_binding_t;
 555
 556
 557 /* used by compile time and send insn */
 558 #define VM_CALL_ARGS_SPLAT_BIT     (0x01 << 1)
 559 #define VM_CALL_ARGS_BLOCKARG_BIT  (0x01 << 2)
 560 #define VM_CALL_FCALL_BIT          (0x01 << 3)
 561 #define VM_CALL_VCALL_BIT          (0x01 << 4)
 562 #define VM_CALL_TAILCALL_BIT       (0x01 << 5)
 563 #define VM_CALL_TAILRECURSION_BIT  (0x01 << 6)
 564 #define VM_CALL_SUPER_BIT          (0x01 << 7)
 565 #define VM_CALL_SEND_BIT           (0x01 << 8)
 566
 567 #define VM_SPECIAL_OBJECT_VMCORE   0x01
 568 #define VM_SPECIAL_OBJECT_CBASE    0x02
 569
 570 #define VM_FRAME_MAGIC_METHOD 0x11
 571 #define VM_FRAME_MAGIC_BLOCK  0x21
 572 #define VM_FRAME_MAGIC_CLASS  0x31
 573 #define VM_FRAME_MAGIC_TOP    0x41
 574 #define VM_FRAME_MAGIC_FINISH 0x51
 575 #define VM_FRAME_MAGIC_CFUNC  0x61
 576 #define VM_FRAME_MAGIC_PROC   0x71
 577 #define VM_FRAME_MAGIC_IFUNC  0x81
 578 #define VM_FRAME_MAGIC_EVAL   0x91
 579 #define VM_FRAME_MAGIC_LAMBDA 0xa1
 580 #define VM_FRAME_MAGIC_MASK_BITS   8
 581 #define VM_FRAME_MAGIC_MASK   (~(~0<<VM_FRAME_MAGIC_MASK_BITS))
 582
 583 #define VM_FRAME_TYPE(cfp) ((cfp)->flag & VM_FRAME_MAGIC_MASK)
 584
 585 /* other frame flag */
 586 #define VM_FRAME_FLAG_PASSED 0x0100
 587
 588
 589 #define RUBYVM_CFUNC_FRAME_P(cfp) \
 590   (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_CFUNC)
 591
 592
 593 /* inline (method|const) cache */
 594 #define NEW_INLINE_CACHE_ENTRY() NEW_WHILE(Qundef, 0, 0)
 595 #define ic_class  u1.value
 596 #define ic_method u2.node
 597 #define ic_value  u2.value
 598 #define ic_vmstat u3.cnt
 599 typedef NODE *IC;
 600
 601 void rb_vm_change_state(void);
 602
 603 typedef VALUE CDHASH;
 604
 605 #ifndef FUNC_FASTCALL
 606 #define FUNC_FASTCALL(x) x
 607 #endif
 608
 609 typedef rb_control_frame_t *
 610   (FUNC_FASTCALL(*rb_insn_func_t))(rb_thread_t *, rb_control_frame_t *);
 611
 612 #define GC_GUARDED_PTR(p)     ((VALUE)((VALUE)(p) | 0x01))
 613 #define GC_GUARDED_PTR_REF(p) ((void *)(((VALUE)p) & ~0x03))
 614 #define GC_GUARDED_PTR_P(p)   (((VALUE)p) & 0x01)
 615
 616 #define RUBY_VM_METHOD_NODE NODE_METHOD
 617
 618 #define RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp) (cfp+1)
 619 #define RUBY_VM_NEXT_CONTROL_FRAME(cfp) (cfp-1)
 620 #define RUBY_VM_END_CONTROL_FRAME(th) \
 621   ((rb_control_frame_t *)((th)->stack + (th)->stack_size))
 622 #define RUBY_VM_VALID_CONTROL_FRAME_P(cfp, ecfp) \
 623   ((void *)(ecfp) > (void *)(cfp))
 624 #define RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(th, cfp) \
 625   (!RUBY_VM_VALID_CONTROL_FRAME_P((cfp), RUBY_VM_END_CONTROL_FRAME(th)))
 626
 627 #define RUBY_VM_IFUNC_P(ptr)        (BUILTIN_TYPE(ptr) == T_NODE)
 628 #define RUBY_VM_NORMAL_ISEQ_P(ptr) \
 629   (ptr && !RUBY_VM_IFUNC_P(ptr))
 630
 631 #define RUBY_VM_CLASS_SPECIAL_P(ptr) (((VALUE)(ptr)) & 0x02)
 632
 633 #define RUBY_VM_GET_BLOCK_PTR_IN_CFP(cfp) ((rb_block_t *)(&(cfp)->self))
 634 #define RUBY_VM_GET_CFP_FROM_BLOCK_PTR(b) \
 635   ((rb_control_frame_t *)((VALUE *)(b) - 5))
 636
 637 /* defined? */
 638 #define DEFINED_IVAR   INT2FIX(1)
 639 #define DEFINED_IVAR2  INT2FIX(2)
 640 #define DEFINED_GVAR   INT2FIX(3)
 641 #define DEFINED_CVAR   INT2FIX(4)
 642 #define DEFINED_CONST  INT2FIX(5)
 643 #define DEFINED_METHOD INT2FIX(6)
 644 #define DEFINED_YIELD  INT2FIX(7)
 645 #define DEFINED_REF    INT2FIX(8)
 646 #define DEFINED_ZSUPER INT2FIX(9)
 647 #define DEFINED_FUNC   INT2FIX(10)
 648
 649 /* VM related object allocate functions */
 650 /* TODO: should be static functions */
 651 VALUE rb_thread_alloc(VALUE klass);
 652 VALUE rb_proc_alloc(VALUE klass);
 653
 654 /* for debug */
 655 extern void vm_stack_dump_raw(rb_thread_t *, rb_control_frame_t *);
 656 #define SDR() vm_stack_dump_raw(GET_THREAD(), GET_THREAD()->cfp)
 657 #define SDR2(cfp) vm_stack_dump_raw(GET_THREAD(), (cfp))
 658 void rb_vm_bugreport(void);
 659
 660
 661 /* functions about thread/vm execution */
 662
 663 VALUE rb_iseq_eval(VALUE iseqval);
 664 void rb_enable_interrupt(void);
 665 void rb_disable_interrupt(void);
 666 int rb_thread_method_id_and_class(rb_thread_t *th, ID *idp, VALUE *klassp);
 667
 668 VALUE vm_invoke_proc(rb_thread_t *th, rb_proc_t *proc, VALUE self,
 669                      int argc, const VALUE *argv, rb_block_t *blockptr);
 670 VALUE vm_make_proc(rb_thread_t *th, rb_control_frame_t *cfp, const rb_block_t *block);
 671 VALUE vm_make_env_object(rb_thread_t *th, rb_control_frame_t *cfp);
 672
 673 NOINLINE(void rb_gc_save_machine_context(rb_thread_t *));
 674
 675 #define sysstack_error GET_VM()->special_exceptions[ruby_error_sysstack]
 676
 677 /* for thread */
 678
 679 #if RUBY_VM_THREAD_MODEL == 2
 680 RUBY_EXTERN rb_thread_t *ruby_current_thread;
 681 extern rb_vm_t *ruby_current_vm;
 682
 683 #define GET_VM() ruby_current_vm
 684 #define GET_THREAD() ruby_current_thread
 685 #define rb_thread_set_current_raw(th) (ruby_current_thread = th)
 686 #define rb_thread_set_current(th) do { \
 687     rb_thread_set_current_raw(th); \
 688     th->vm->running_thread = th; \
 689 } while (0)
 690
 691 #else
 692 #error "unsupported thread model"
 693 #endif
 694
 695 #define RUBY_VM_SET_INTERRUPT(th) ((th)->interrupt_flag |= 0x02)
 696 #define RUBY_VM_SET_TIMER_INTERRUPT(th) ((th)->interrupt_flag |= 0x01)
 697 #define RUBY_VM_SET_FINALIZER_INTERRUPT(th) ((th)->interrupt_flag |= 0x04)
 698 #define RUBY_VM_INTERRUPTED(th) ((th)->interrupt_flag & 0x02)
 699
 700 void rb_thread_execute_interrupts(rb_thread_t *);
 701
 702 #define RUBY_VM_CHECK_INTS_TH(th) do { \
 703   if (th->interrupt_flag) { \
 704     /* TODO: trap something event */ \
 705     rb_thread_execute_interrupts(th); \
 706   } \
 707 } while (0)
 708
 709 #define RUBY_VM_CHECK_INTS() \
 710   RUBY_VM_CHECK_INTS_TH(GET_THREAD())
 711
 712 /* tracer */
 713 static inline void
 714 exec_event_hooks(rb_event_hook_t *hook, rb_event_flag_t flag, VALUE self, ID id, VALUE klass)
 715 {
 716     while (hook) {
 717         if (flag & hook->flag) {
 718             (*hook->func)(flag, hook->data, self, id, klass);
 719         }
 720         hook = hook->next;
 721     }
 722 }
 723
 724 #define EXEC_EVENT_HOOK(th, flag, self, id, klass) do { \
 725     rb_event_flag_t wait_event__ = th->event_flags; \
 726     if (UNLIKELY(wait_event__)) { \
 727         if (wait_event__ & (flag | RUBY_EVENT_VM)) { \
 728             VALUE self__ = (self), klass__ = (klass); \
 729             ID id__ = (id); \
 730             if (wait_event__ & flag) { \
 731                 exec_event_hooks(th->event_hooks, flag, self__, id__, klass__); \
 732             } \
 733             if (wait_event__ & RUBY_EVENT_VM) { \
 734                 exec_event_hooks(th->vm->event_hooks, flag, self__, id__, klass__); \
 735             } \
 736         } \
 737     } \
 738 } while (0)
 739
 740 #endif /* RUBY_VM_CORE_H */