1
/**********************************************************************
6
$Date: 2007-08-28 01:48:14 +0900 (火, 28 8月 2007) $
7
created at: 04/01/01 19:41:38 JST
9
Copyright (C) 2004-2007 Koichi Sasada
11
**********************************************************************/
16
#define RUBY_VM_THREAD_MODEL 2
20
#include "ruby/ruby.h"
21
#include "ruby/signal.h"
23
#include "ruby/node.h"
30
#include "thread_win32.h"
31
#elif defined(HAVE_PTHREAD_H)
32
#include "thread_pthread.h"
34
#error "unsupported thread type"
43
# define NSIG (_SIGMAX + 1) /* For QNX */
47
#define RUBY_NSIG NSIG
54
#if defined(__GNUC__) && __GNUC__ >= 2
56
#if OPT_TOKEN_THREADED_CODE
57
#if OPT_DIRECT_THREADED_CODE
58
#undef OPT_DIRECT_THREADED_CODE
62
#else /* defined(__GNUC__) && __GNUC__ >= 2 */
64
/* disable threaded code options */
65
#if OPT_DIRECT_THREADED_CODE
66
#undef OPT_DIRECT_THREADED_CODE
68
#if OPT_TOKEN_THREADED_CODE
69
#undef OPT_TOKEN_THREADED_CODE
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 */
79
#undef OPT_STACK_CACHING
80
#endif /* OPT_STACK_CACHING */
81
#endif /* OPT_CALL_THREADED_CODE */
85
#define LIKELY(x) (__builtin_expect((x), 1))
86
#define UNLIKELY(x) (__builtin_expect((x), 0))
87
#else /* __GNUC__ >= 3 */
89
#define UNLIKELY(x) (x)
90
#endif /* __GNUC__ >= 3 */
92
#define ISEQ_TYPE_TOP INT2FIX(1)
93
#define ISEQ_TYPE_METHOD INT2FIX(2)
94
#define ISEQ_TYPE_BLOCK INT2FIX(3)
95
#define ISEQ_TYPE_CLASS INT2FIX(4)
96
#define ISEQ_TYPE_RESCUE INT2FIX(5)
97
#define ISEQ_TYPE_ENSURE INT2FIX(6)
98
#define ISEQ_TYPE_EVAL INT2FIX(7)
99
#define ISEQ_TYPE_DEFINED_GUARD INT2FIX(8)
101
#define CATCH_TYPE_RESCUE INT2FIX(1)
102
#define CATCH_TYPE_ENSURE INT2FIX(2)
103
#define CATCH_TYPE_RETRY INT2FIX(3)
104
#define CATCH_TYPE_BREAK INT2FIX(4)
105
#define CATCH_TYPE_REDO INT2FIX(5)
106
#define CATCH_TYPE_NEXT INT2FIX(6)
108
struct iseq_insn_info_entry {
109
unsigned short position;
110
unsigned short line_no;
113
struct iseq_catch_table_entry {
122
#define INITIAL_ISEQ_COMPILE_DATA_STORAGE_BUFF_SIZE (512)
124
struct iseq_compile_data_storage {
125
struct iseq_compile_data_storage *next;
131
struct iseq_compile_data_ensure_node_stack;
133
typedef struct rb_compile_option_struct {
134
int inline_const_cache;
135
int peephole_optimization;
136
int tailcall_optimization;
137
int specialized_instruction;
138
int operands_unification;
139
int instructions_unification;
141
int trace_instruction;
142
} rb_compile_option_t;
144
struct iseq_compile_data {
148
VALUE catch_table_ary; /* Array */
150
/* GC is not needed */
151
struct iseq_label_data *start_label;
152
struct iseq_label_data *end_label;
153
struct iseq_label_data *redo_label;
155
VALUE loopval_popped; /* used by NODE_BREAK */
158
struct iseq_compile_data_ensure_node_stack *ensure_node_stack;
160
struct iseq_compile_data_storage *storage_head;
161
struct iseq_compile_data_storage *storage_current;
164
const rb_compile_option_t *option;
168
#define GetCoreDataFromValue(obj, type, ptr) do { \
169
ptr = (type*)DATA_PTR(obj); \
172
#define GetCoreDataFromValue(obj, type, ptr) Data_Get_Struct(obj, type, ptr)
175
#define GetISeqPtr(obj, ptr) \
176
GetCoreDataFromValue(obj, rb_iseq_t, ptr)
178
typedef struct rb_iseq_profile_struct {
181
VALUE time_cumu; /* cumulative */
184
struct rb_iseq_struct;
186
struct rb_iseq_struct {
191
VALUE type; /* instruction sequence type */
192
VALUE name; /* String: iseq name */
193
VALUE filename; /* file information where this sequence from */
194
VALUE *iseq; /* iseq (insn number and openrads) */
195
VALUE *iseq_encoded; /* encoded iseq */
196
unsigned long iseq_size;
197
VALUE mark_ary; /* Array: includes operands which should be GC marked */
199
/* insn info, must be freed */
200
struct iseq_insn_info_entry *insn_info_table;
201
unsigned long insn_info_size;
203
ID *local_table; /* must free */
204
int local_table_size;
206
/* method, class frame: sizeof(vars) + 1, block frame: sizeof(vars) */
210
* argument information
212
* def m(a1, a2, ..., aM, # mandatory
213
* b1=(...), b2=(...), ..., bN=(...), # optinal
215
* d1, d2, ..., dO, # post
220
* arg_rest = M+N+1 // or -1 if no rest arg
222
* arg_opts_tbl = [ (N entries) ]
223
* arg_post_len = O // 0 if no post arguments
224
* arg_post_start = M+N+2
225
* arg_block = M+N + 1 + O + 1 // -1 if no block arg
226
* arg_simple = 0 if not simple arguments.
227
* = 1 if no opt, rest, post, block.
228
* = 2 if ambiguos block parameter ({|a|}).
229
* arg_size = argument size.
240
VALUE *arg_opt_table;
242
int stack_max; /* for stack overflow check */
245
struct iseq_catch_table_entry *catch_table;
246
int catch_table_size;
249
struct rb_iseq_struct *parent_iseq;
250
struct rb_iseq_struct *local_iseq;
260
void *special_block_builder;
261
void *cached_special_block_builder;
262
VALUE cached_special_block;
264
/* klass/module nest information stack (cref) */
269
ID defined_method_id; /* for define_method */
270
rb_iseq_profile_t profile;
272
/* used at compile time */
273
struct iseq_compile_data *compile_data;
276
typedef struct rb_iseq_struct rb_iseq_t;
278
#define RUBY_EVENT_NONE 0x00
279
#define RUBY_EVENT_LINE 0x01
280
#define RUBY_EVENT_CLASS 0x02
281
#define RUBY_EVENT_END 0x04
282
#define RUBY_EVENT_CALL 0x08
283
#define RUBY_EVENT_RETURN 0x10
284
#define RUBY_EVENT_C_CALL 0x20
285
#define RUBY_EVENT_C_RETURN 0x40
286
#define RUBY_EVENT_RAISE 0x80
287
#define RUBY_EVENT_ALL 0xff
288
#define RUBY_EVENT_VM 0x100
289
#define RUBY_EVENT_SWITCH 0x200
291
typedef unsigned int rb_event_flag_t;
292
typedef void (*rb_event_hook_func_t)(rb_event_flag_t, VALUE data, VALUE, ID, VALUE klass);
294
typedef struct rb_event_hook_struct {
295
rb_event_flag_t flag;
296
rb_event_hook_func_t func;
298
struct rb_event_hook_struct *next;
301
#define GetVMPtr(obj, ptr) \
302
GetCoreDataFromValue(obj, rb_vm_t, ptr)
304
typedef struct rb_vm_struct {
307
rb_thread_lock_t global_interpreter_lock;
309
struct rb_thread_struct *main_thread;
310
struct rb_thread_struct *running_thread;
312
st_table *living_threads;
313
VALUE thgroup_default;
314
VALUE last_status; /* $? */
316
int thread_abort_on_exception;
317
unsigned long trace_flag;
319
/* object management */
320
VALUE mark_object_ary;
324
VALUE loaded_features;
325
struct st_table *loading_table;
328
rb_atomic_t signal_buff[RUBY_NSIG];
329
rb_atomic_t bufferd_signal_size;
332
rb_event_hook_t *event_hooks;
336
VALUE *pc; /* cfp[0] */
337
VALUE *sp; /* cfp[1] */
338
VALUE *bp; /* cfp[2] */
339
rb_iseq_t *iseq; /* cfp[3] */
340
VALUE flag; /* cfp[4] */
341
VALUE self; /* cfp[5] / block[0] */
342
VALUE *lfp; /* cfp[6] / block[1] */
343
VALUE *dfp; /* cfp[7] / block[2] */
344
rb_iseq_t *block_iseq; /* cfp[8] / block[3] */
345
VALUE proc; /* cfp[9] / block[4] */
346
ID method_id; /* cfp[10] saved in special case */
347
VALUE method_klass; /* cfp[11] saved in special case */
348
VALUE prof_time_self; /* cfp[12] */
349
VALUE prof_time_chld; /* cfp[13] */
350
} rb_control_frame_t;
353
VALUE self; /* share with method frame if it's only block */
354
VALUE *lfp; /* share with method frame if it's only block */
355
VALUE *dfp; /* share with method frame if it's only block */
360
#define GetThreadPtr(obj, ptr) \
361
GetCoreDataFromValue(obj, rb_thread_t, ptr)
363
enum rb_thread_status {
370
typedef jmp_buf rb_jmpbuf_t;
376
struct rb_vm_tag *prev;
379
struct rb_vm_trap_tag {
380
struct rb_vm_trap_tag *prev;
383
#define RUBY_VM_VALUE_CACHE_SIZE 0x1000
384
#define USE_VALUE_CACHE 0
386
struct rb_thread_struct
391
/* execution information */
392
VALUE *stack; /* must free, must mark */
393
unsigned long stack_size;
394
rb_control_frame_t *cfp;
402
rb_block_t *passed_block;
409
rb_block_t *base_block;
415
rb_thread_id_t thread_id;
416
enum rb_thread_status status;
419
native_thread_data_t native_thread_data;
425
VALUE thrown_errinfo;
429
rb_unblock_function_t *unblock_function;
430
void *unblock_function_arg;
431
rb_thread_lock_t interrupt_lock;
433
struct rb_vm_tag *tag;
434
struct rb_vm_trap_tag *trap_tag;
439
st_table *local_storage;
441
VALUE value_cache[RUBY_VM_VALUE_CACHE_SIZE + 1];
442
VALUE *value_cache_ptr;
445
struct rb_thread_struct *join_list_next;
446
struct rb_thread_struct *join_list_head;
450
VALUE (*first_func)(ANYARGS);
453
VALUE *machine_stack_start;
454
VALUE *machine_stack_end;
456
VALUE *machine_register_stack_start;
457
VALUE *machine_register_stack_end;
459
jmp_buf machine_regs;
462
/* statistics data for profiler */
463
VALUE stat_insn_usage;
466
rb_event_hook_t *event_hooks;
467
rb_event_flag_t event_flags;
473
rb_jmpbuf_t root_jmpbuf;
476
int method_missing_reason;
477
int abort_on_exception;
481
VALUE rb_iseq_new(NODE*, VALUE, VALUE, VALUE, VALUE);
482
VALUE rb_iseq_new_with_bopt(NODE*, VALUE, VALUE, VALUE, VALUE, VALUE);
483
VALUE rb_iseq_new_with_opt(NODE*, VALUE, VALUE, VALUE, VALUE, const rb_compile_option_t*);
484
VALUE rb_iseq_compile(VALUE src, VALUE file, VALUE line);
485
VALUE ruby_iseq_disasm(VALUE self);
486
VALUE ruby_iseq_disasm_insn(VALUE str, VALUE *iseqval, int pos, rb_iseq_t *iseq, VALUE child);
487
const char *ruby_node_name(int node);
490
/* each thread has this size stack : 128KB */
491
#define RUBY_VM_THREAD_STACK_SIZE (128 * 1024)
493
struct global_entry {
494
struct global_variable *var;
498
#define GetProcPtr(obj, ptr) \
499
GetCoreDataFromValue(obj, rb_proc_t, ptr)
504
VALUE envval; /* for GC mark */
510
NODE *special_cref_stack;
513
#define GetEnvPtr(obj, ptr) \
514
GetCoreDataFromValue(obj, rb_env_t, ptr)
520
VALUE prev_envval; /* for GC mark */
524
#define GetBindingPtr(obj, ptr) \
525
GetCoreDataFromValue(obj, rb_binding_t, ptr)
533
/* used by compile time and send insn */
534
#define VM_CALL_ARGS_SPLAT_BIT (0x01 << 1)
535
#define VM_CALL_ARGS_BLOCKARG_BIT (0x01 << 2)
536
#define VM_CALL_FCALL_BIT (0x01 << 3)
537
#define VM_CALL_VCALL_BIT (0x01 << 4)
538
#define VM_CALL_TAILCALL_BIT (0x01 << 5)
539
#define VM_CALL_TAILRECURSION_BIT (0x01 << 6)
540
#define VM_CALL_SUPER_BIT (0x01 << 7)
541
#define VM_CALL_SEND_BIT (0x01 << 8)
543
/* inline (method|const) cache */
544
#define NEW_INLINE_CACHE_ENTRY() NEW_WHILE(Qundef, 0, 0)
545
#define ic_klass u1.value
546
#define ic_method u2.node
547
#define ic_value u2.value
548
#define ic_vmstat u3.cnt
551
void rb_vm_change_state(void);
553
typedef VALUE CDHASH;
555
#ifndef FUNC_FASTCALL
556
#define FUNC_FASTCALL(x) x
559
typedef rb_control_frame_t *
560
(FUNC_FASTCALL(*rb_insn_func_t))(rb_thread_t *, rb_control_frame_t *);
562
#define GC_GUARDED_PTR(p) ((VALUE)((VALUE)(p) | 0x01))
563
#define GC_GUARDED_PTR_REF(p) ((void *)(((VALUE)p) & ~0x03))
564
#define GC_GUARDED_PTR_P(p) (((VALUE)p) & 0x01)
566
#define RUBY_VM_METHOD_NODE NODE_METHOD
568
#define RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp) (cfp+1)
569
#define RUBY_VM_NEXT_CONTROL_FRAME(cfp) (cfp-1)
570
#define RUBY_VM_END_CONTROL_FRAME(th) \
571
((rb_control_frame_t *)((th)->stack + (th)->stack_size))
572
#define RUBY_VM_VALID_CONTROL_FRAME_P(cfp, ecfp) \
573
((void *)(ecfp) > (void *)(cfp))
574
#define RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(th, cfp) \
575
(!RUBY_VM_VALID_CONTROL_FRAME_P((cfp), RUBY_VM_END_CONTROL_FRAME(th)))
577
#define RUBY_VM_IFUNC_P(ptr) (BUILTIN_TYPE(ptr) == T_NODE)
578
#define RUBY_VM_NORMAL_ISEQ_P(ptr) \
579
(ptr && !RUBY_VM_IFUNC_P(ptr))
581
#define RUBY_VM_CLASS_SPECIAL_P(ptr) (((VALUE)(ptr)) & 0x02)
583
#define RUBY_VM_GET_BLOCK_PTR_IN_CFP(cfp) ((rb_block_t *)(&(cfp)->self))
584
#define RUBY_VM_GET_CFP_FROM_BLOCK_PTR(b) \
585
((rb_control_frame_t *)((VALUE *)(b) - 5))
588
#define DEFINED_IVAR INT2FIX(1)
589
#define DEFINED_IVAR2 INT2FIX(2)
590
#define DEFINED_GVAR INT2FIX(3)
591
#define DEFINED_CVAR INT2FIX(4)
592
#define DEFINED_CONST INT2FIX(5)
593
#define DEFINED_METHOD INT2FIX(6)
594
#define DEFINED_YIELD INT2FIX(7)
595
#define DEFINED_REF INT2FIX(8)
596
#define DEFINED_ZSUPER INT2FIX(9)
597
#define DEFINED_FUNC INT2FIX(10)
599
/* VM related object allocate functions */
600
/* TODO: should be static functions */
601
VALUE rb_thread_alloc(VALUE klass);
602
VALUE rb_proc_alloc(VALUE klass);
605
extern void vm_stack_dump_raw(rb_thread_t *, rb_control_frame_t *);
606
#define SDR() vm_stack_dump_raw(GET_THREAD(), GET_THREAD()->cfp)
607
#define SDR2(cfp) vm_stack_dump_raw(GET_THREAD(), (cfp))
608
void rb_vm_bugreport(void);
611
/* functions about thread/vm execution */
613
VALUE rb_iseq_eval(VALUE iseqval);
614
void rb_enable_interrupt(void);
615
void rb_disable_interrupt(void);
616
int rb_thread_method_id_and_klass(rb_thread_t *th, ID *idp, VALUE *klassp);
618
VALUE vm_eval_body(rb_thread_t *th);
619
VALUE vm_invoke_proc(rb_thread_t *th, rb_proc_t *proc, VALUE self, int argc, VALUE *argv);
620
VALUE vm_make_proc(rb_thread_t *th, rb_control_frame_t *cfp, rb_block_t *block);
621
VALUE vm_make_env_object(rb_thread_t *th, rb_control_frame_t *cfp);
622
VALUE vm_backtrace(rb_thread_t *, int);
624
VALUE vm_yield(rb_thread_t *th, int argc, VALUE *argv);
625
VALUE vm_call0(rb_thread_t *th, VALUE klass, VALUE recv, VALUE id, ID oid,
626
int argc, const VALUE *argv, NODE *body, int nosuper);
628
int vm_get_sourceline(rb_control_frame_t *);
630
RUBY_EXTERN VALUE sysstack_error;
634
#if RUBY_VM_THREAD_MODEL == 2
635
extern rb_thread_t *ruby_current_thread;
636
extern rb_vm_t *ruby_current_vm;
638
#define GET_VM() ruby_current_vm
639
#define GET_THREAD() ruby_current_thread
640
#define rb_thread_set_current_raw(th) (ruby_current_thread = th)
641
#define rb_thread_set_current(th) do { \
642
rb_thread_set_current_raw(th); \
643
th->vm->running_thread = th; \
647
#error "unsupported thread model"
650
void rb_thread_execute_interrupts(rb_thread_t *);
652
#define RUBY_VM_CHECK_INTS_TH(th) do { \
653
if(th->interrupt_flag){ \
654
/* TODO: trap something event */ \
655
rb_thread_execute_interrupts(th); \
659
#define RUBY_VM_CHECK_INTS() \
660
RUBY_VM_CHECK_INTS_TH(GET_THREAD())
664
exec_event_hooks(rb_event_hook_t *hook, rb_event_flag_t flag, VALUE self, ID id, VALUE klass)
667
if (flag & hook->flag) {
668
(*hook->func)(flag, hook->data, self, id, klass);
674
#define EXEC_EVENT_HOOK(th, flag, self, id, klass) do { \
675
rb_event_flag_t wait_event__ = th->event_flags; \
676
if (UNLIKELY(wait_event__)) { \
677
if (wait_event__ & (flag | RUBY_EVENT_VM)) { \
678
VALUE self__ = (self), klass__ = (klass); \
680
if (wait_event__ & flag) { \
681
exec_event_hooks(th->event_hooks, flag, self__, id__, klass__); \
683
if (wait_event__ & RUBY_EVENT_VM) { \
684
exec_event_hooks(th->vm->event_hooks, flag, self__, id__, klass__); \
690
#endif /* RUBY_CORE_H */