/********************************************************************** yarvcore.h - $Author$ $Date$ created at: 04/01/01 19:41:38 JST Copyright (C) 2004-2006 Koichi Sasada **********************************************************************/ #ifndef _YARVCORE_H_INCLUDED_ #define _YARVCORE_H_INCLUDED_ #define RUBY_VM_THREAD_MODEL 2 #include #include "ruby.h" #include "rubysig.h" #include "st.h" #include "node.h" #include "debug.h" #include "vm_opts.h" #if defined(_WIN32) #include "thread_win32.h" #elif defined(HAVE_PTHREAD_H) #include "thread_pthread.h" #else #error "unsupported thread type" #endif #include #ifndef NSIG # ifdef DJGPP # define NSIG SIGMAX # else # define NSIG (_SIGMAX + 1) /* For QNX */ # endif #endif #define RUBY_NSIG NSIG /*****************/ /* configuration */ /*****************/ /* gcc ver. check */ #if defined(__GNUC__) && __GNUC__ >= 2 #if OPT_TOKEN_THREADED_CODE #if OPT_DIRECT_THREADED_CODE #undef OPT_DIRECT_THREADED_CODE #endif #endif #else /* defined(__GNUC__) && __GNUC__ >= 2 */ /* disable threaded code options */ #if OPT_DIRECT_THREADED_CODE #undef OPT_DIRECT_THREADED_CODE #endif #if OPT_TOKEN_THREADED_CODE #undef OPT_TOKEN_THREADED_CODE #endif #endif /* call threaded code */ #if OPT_CALL_THREADED_CODE #if OPT_DIRECT_THREADED_CODE #undef OPT_DIRECT_THREADED_CODE #endif /* OPT_DIRECT_THREADED_CODE */ #if OPT_STACK_CACHING #undef OPT_STACK_CACHING #endif /* OPT_STACK_CACHING */ #define YARV_AOT_COMPILED 1 #endif /* OPT_CALL_THREADED_CODE */ /* likely */ #if __GNUC__ >= 3 #define LIKELY(x) (__builtin_expect((x), 1)) #define UNLIKELY(x) (__builtin_expect((x), 0)) #else /* __GNUC__ >= 3 */ #define LIKELY(x) (x) #define UNLIKELY(x) (x) #endif /* __GNUC__ >= 3 */ #define YARVDEBUG 0 #define CPDEBUG 0 #define VMDEBUG 0 #define GCDEBUG 0 /* classes and modules */ extern VALUE symIFUNC; extern VALUE symCFUNC; /* special id */ extern ID idPLUS; extern ID idMINUS; extern ID idMULT; extern ID idDIV; extern ID idMOD; extern ID idLT; extern ID idLTLT; extern ID idLE; extern ID idGT; extern ID idGE; extern ID idEq; extern ID idEqq; extern ID idBackquote; extern ID idEqTilde; extern ID idThrowState; extern ID idAREF; extern ID idASET; extern ID idIntern; extern ID idMethodMissing; extern ID idLength; extern ID idGets; extern ID idSucc; extern ID idEach; extern ID idLambda; extern ID idRangeEachLT; extern ID idRangeEachLE; extern ID idArrayEach; extern ID idTimes; extern ID idEnd; extern ID idBitblt; extern ID idAnswer; extern ID idSvarPlaceholder; extern ID idSend; extern ID id__send__; extern ID id__send; extern ID idFuncall; extern ID id__send_bang; struct insn_info_struct { unsigned short position; unsigned short line_no; }; #define ISEQ_TYPE_TOP INT2FIX(1) #define ISEQ_TYPE_METHOD INT2FIX(2) #define ISEQ_TYPE_BLOCK INT2FIX(3) #define ISEQ_TYPE_CLASS INT2FIX(4) #define ISEQ_TYPE_RESCUE INT2FIX(5) #define ISEQ_TYPE_ENSURE INT2FIX(6) #define ISEQ_TYPE_EVAL INT2FIX(7) #define ISEQ_TYPE_DEFINED_GUARD INT2FIX(8) #define CATCH_TYPE_RESCUE INT2FIX(1) #define CATCH_TYPE_ENSURE INT2FIX(2) #define CATCH_TYPE_RETRY INT2FIX(3) #define CATCH_TYPE_BREAK INT2FIX(4) #define CATCH_TYPE_REDO INT2FIX(5) #define CATCH_TYPE_NEXT INT2FIX(6) struct catch_table_entry { VALUE type; VALUE iseq; unsigned long start; unsigned long end; unsigned long cont; unsigned long sp; }; #define INITIAL_ISEQ_COMPILE_DATA_STORAGE_BUFF_SIZE (512) struct iseq_compile_data_storage { struct iseq_compile_data_storage *next; unsigned long pos; unsigned long size; char *buff; }; struct iseq_compile_data_ensure_node_stack; typedef struct rb_compile_option_struct { int inline_const_cache; int peephole_optimization; int tailcall_optimization; int specialized_instruction; int operands_unification; int instructions_unification; int stack_caching; int trace_instruction; } rb_compile_option_t; struct iseq_compile_data { /* GC is needed */ VALUE err_info; VALUE mark_ary; VALUE catch_table_ary; /* Array */ /* GC is not needed */ struct iseq_label_data *start_label; struct iseq_label_data *end_label; struct iseq_label_data *redo_label; VALUE current_block; VALUE loopval_popped; /* used by NODE_BREAK */ VALUE ensure_node; VALUE for_iseq; struct iseq_compile_data_ensure_node_stack *ensure_node_stack; int cached_const; struct iseq_compile_data_storage *storage_head; struct iseq_compile_data_storage *storage_current; int last_line; const rb_compile_option_t *option; }; #define GetISeqPtr(obj, ptr) Data_Get_Struct(obj, rb_iseq_t, ptr) typedef struct rb_iseq_profile_struct { VALUE count; VALUE time_self; VALUE time_cumu; /* cumulative */ } rb_iseq_profile_t; struct rb_iseq_struct; struct rb_iseq_struct { /* instruction sequence type */ VALUE type; VALUE self; VALUE name; /* String: iseq name */ VALUE *iseq; /* iseq */ VALUE *iseq_encoded; VALUE iseq_mark_ary; /* Array: includes operands which should be GC marked */ /* sequence size */ unsigned long size; /* insn info, must be freed */ struct insn_info_struct *insn_info_tbl; /* insn info size, this value shows also instruction count */ unsigned int insn_info_size; /* file information where this sequence from */ VALUE filename; ID *local_table; /* must free */ int local_table_size; /* method, class frame: sizeof(vars) + 1, block frame: sizeof(vars) */ int local_size; /* jit compiled or not */ void *jit_compiled; void *iseq_orig; /** * argument information * * def m(a1, a2, ..., aM, b1=(...), b2=(...), ..., bN=(...), *c, &d) * => * * argc = M * arg_rest = M+N + 1 // if no rest arguments, rest is 0 * arg_opts = N * arg_opts_tbl = [ (N entries) ] * arg_block = M+N + 1 (rest) + 1 (block) * check: * M <= num */ int argc; int arg_simple; int arg_rest; int arg_block; int arg_opts; int arg_post_len; VALUE *arg_opt_tbl; /* for stack overflow check */ int stack_max; /* klass/module nest information stack (cref) */ NODE *cref_stack; VALUE klass; /* catch table */ struct catch_table_entry *catch_table; int catch_table_size; /* for child iseq */ struct rb_iseq_struct *parent_iseq; struct rb_iseq_struct *local_iseq; /* block inlining */ NODE *node; void *special_block_builder; void *cached_special_block_builder; VALUE cached_special_block; /* misc */ ID defined_method_id; /* for define_method */ rb_iseq_profile_t profile; struct iseq_compile_data *compile_data; }; typedef struct rb_iseq_struct rb_iseq_t; #define RUBY_EVENT_NONE 0x00 #define RUBY_EVENT_LINE 0x01 #define RUBY_EVENT_CLASS 0x02 #define RUBY_EVENT_END 0x04 #define RUBY_EVENT_CALL 0x08 #define RUBY_EVENT_RETURN 0x10 #define RUBY_EVENT_C_CALL 0x20 #define RUBY_EVENT_C_RETURN 0x40 #define RUBY_EVENT_RAISE 0x80 #define RUBY_EVENT_ALL 0xff #define RUBY_EVENT_VM 0x100 #define RUBY_EVENT_SWITCH 0x200 typedef unsigned int rb_event_flag_t; typedef void (*rb_event_hook_func_t)(rb_event_flag_t, VALUE data, VALUE, ID, VALUE klass); typedef struct rb_event_hook_struct { rb_event_flag_t flag; rb_event_hook_func_t func; VALUE data; struct rb_event_hook_struct *next; } rb_event_hook_t; #define GetVMPtr(obj, ptr) \ Data_Get_Struct(obj, rb_vm_t, ptr) typedef struct rb_vm_struct { VALUE self; rb_thread_lock_t global_interpreter_lock; struct rb_thread_struct *main_thread; struct rb_thread_struct *running_thread; st_table *living_threads; VALUE thgroup_default; VALUE last_status; /* $? */ int thread_abort_on_exception; unsigned long trace_flag; /* object management */ VALUE mark_object_ary; /* load */ VALUE loaded_features; struct st_table *loading_table; /* signal */ rb_atomic_t signal_buff[RUBY_NSIG]; rb_atomic_t bufferd_signal_size; /* hook */ rb_event_hook_t *event_hooks; } rb_vm_t; typedef struct { VALUE *pc; /* cfp[0] */ VALUE *sp; /* cfp[1] */ VALUE *bp; /* cfp[2] */ rb_iseq_t *iseq; /* cfp[3] */ VALUE magic; /* cfp[4] */ VALUE self; /* cfp[5] / block[0] */ VALUE *lfp; /* cfp[6] / block[1] */ VALUE *dfp; /* cfp[7] / block[2] */ rb_iseq_t *block_iseq; /* cfp[8] / block[3] */ VALUE proc; /* cfp[9] / block[4] */ ID method_id; /* cfp[10] saved in special case */ VALUE method_klass; /* cfp[11] saved in special case */ VALUE prof_time_self; /* cfp[12] */ VALUE prof_time_chld; /* cfp[13] */ } rb_control_frame_t; typedef struct { VALUE self; /* share with method frame if it's only block */ VALUE *lfp; /* share with method frame if it's only block */ VALUE *dfp; /* share with method frame if it's only block */ rb_iseq_t *iseq; VALUE proc; } rb_block_t; #define GetThreadPtr(obj, ptr) \ Data_Get_Struct(obj, rb_thread_t, ptr) enum rb_thread_status { THREAD_TO_KILL, THREAD_RUNNABLE, THREAD_STOPPED, THREAD_KILLED, }; typedef jmp_buf rb_jmpbuf_t; struct rb_vm_tag { rb_jmpbuf_t buf; VALUE tag; VALUE retval; struct rb_vm_tag *prev; }; #define RUBY_VM_VALUE_CACHE_SIZE 0x1000 #define USE_VALUE_CACHE 1 struct rb_thread_struct { VALUE self; rb_vm_t *vm; /* execution information */ VALUE *stack; /* must free, must mark */ unsigned long stack_size; rb_control_frame_t *cfp; int safe_level; int raised_flag; /* passing state */ int state; /* for rb_iterate */ rb_block_t *passed_block; /* for load(true) */ VALUE top_self; VALUE top_wrapper; /* eval env */ rb_block_t *base_block; VALUE *local_lfp; VALUE local_svar; /* thread control */ rb_thread_id_t thread_id; enum rb_thread_status status; int priority; native_thread_data_t native_thread_data; VALUE thgroup; VALUE value; VALUE errinfo; VALUE thrown_errinfo; int exec_signal; int interrupt_flag; rb_unblock_function_t *unblock_function; rb_thread_lock_t interrupt_lock; struct rb_vm_tag *tag; int parse_in_eval; /* storage */ st_table *local_storage; #if USE_VALUE_CACHE VALUE value_cache[RUBY_VM_VALUE_CACHE_SIZE + 1]; VALUE *value_cache_ptr; #endif struct rb_thread_struct *join_list_next; struct rb_thread_struct *join_list_head; VALUE first_proc; VALUE first_args; VALUE (*first_func)(ANYARGS); void *first_func_arg; /* for GC */ VALUE *machine_stack_start; VALUE *machine_stack_end; jmp_buf machine_regs; int mark_stack_len; /* statistics data for profiler */ VALUE stat_insn_usage; /* tracer */ rb_event_hook_t *event_hooks; rb_event_flag_t event_flags; int tracing; /* misc */ int method_missing_reason; int abort_on_exception; }; /** node -> yarv instruction sequence object */ VALUE rb_iseq_compile(VALUE self, NODE *node); VALUE rb_iseq_new(NODE*, VALUE, VALUE, VALUE, VALUE); VALUE rb_iseq_new_with_bopt(NODE*, VALUE, VALUE, VALUE, VALUE, VALUE); VALUE rb_iseq_new_with_opt(NODE*, VALUE, VALUE, VALUE, VALUE, const rb_compile_option_t*); /** disassemble instruction sequence */ VALUE ruby_iseq_disasm(VALUE self); VALUE ruby_iseq_disasm_insn(VALUE str, VALUE *iseqval, int pos, rb_iseq_t *iseq, VALUE child); char *ruby_node_name(int node); /* each thread has this size stack : 2MB */ #define RUBY_VM_THREAD_STACK_SIZE (128 * 1024) /* from ruby 1.9 variable.c */ struct global_entry { struct global_variable *var; ID id; }; #define GetProcPtr(obj, ptr) \ Data_Get_Struct(obj, rb_proc_t, ptr) typedef struct { rb_block_t block; VALUE envval; /* for GC mark */ VALUE blockprocval; int safe_level; int is_lambda; NODE *special_cref_stack; } rb_proc_t; #define GetEnvPtr(obj, ptr) \ Data_Get_Struct(obj, rb_env_t, ptr) typedef struct { VALUE *env; int env_size; int local_size; VALUE prev_envval; /* for GC mark */ rb_block_t block; } rb_env_t; #define GetBindingPtr(obj, ptr) \ Data_Get_Struct(obj, rb_binding_t, ptr) typedef struct { VALUE env; NODE *cref_stack; } rb_binding_t; /* used by compile time and send insn */ #define VM_CALL_ARGS_SPLAT_BIT (0x01 << 1) #define VM_CALL_ARGS_BLOCKARG_BIT (0x01 << 2) #define VM_CALL_FCALL_BIT (0x01 << 3) #define VM_CALL_VCALL_BIT (0x01 << 4) #define VM_CALL_TAILCALL_BIT (0x01 << 5) #define VM_CALL_TAILRECURSION_BIT (0x01 << 6) #define VM_CALL_SUPER_BIT (0x01 << 7) #define VM_CALL_SEND_BIT (0x01 << 8) /* inline (method|const) cache */ #define NEW_INLINE_CACHE_ENTRY() NEW_WHILE(Qundef, 0, 0) #define ic_klass u1.value #define ic_method u2.node #define ic_value u2.value #define ic_vmstat u3.cnt typedef NODE *IC; void rb_vm_change_state(void); typedef VALUE CDHASH; #define GC_GUARDED_PTR(p) ((VALUE)((VALUE)(p) | 0x01)) #define GC_GUARDED_PTR_REF(p) ((void *)(((VALUE)p) & ~0x03)) #define GC_GUARDED_PTR_P(p) (((VALUE)p) & 0x01) #define RUBY_VM_METHOD_NODE NODE_METHOD #define RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp) (cfp+1) #define RUBY_VM_NEXT_CONTROL_FRAME(cfp) (cfp-1) #define RUBY_VM_END_CONTROL_FRAME(th) \ ((rb_control_frame_t *)((th)->stack + (th)->stack_size)) #define RUBY_VM_VALID_CONTROL_FRAME_P(cfp, ecfp) \ ((void *)(ecfp) > (void *)(cfp)) #define RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(th, cfp) \ (!RUBY_VM_VALID_CONTROL_FRAME_P((cfp), RUBY_VM_END_CONTROL_FRAME(th))) #define RUBY_VM_IFUNC_P(ptr) (BUILTIN_TYPE(ptr) == T_NODE) #define RUBY_VM_NORMAL_ISEQ_P(ptr) \ (ptr && !RUBY_VM_IFUNC_P(ptr)) #define RUBY_VM_CLASS_SPECIAL_P(ptr) (((VALUE)(ptr)) & 0x02) #define RUBY_VM_GET_BLOCK_PTR_IN_CFP(cfp) ((rb_block_t *)(&(cfp)->self)) #define RUBY_VM_GET_CFP_FROM_BLOCK_PTR(b) \ ((rb_control_frame_t *)((VALUE *)(b) - 5)) /* defined? */ #define DEFINED_IVAR INT2FIX(1) #define DEFINED_IVAR2 INT2FIX(2) #define DEFINED_GVAR INT2FIX(3) #define DEFINED_CVAR INT2FIX(4) #define DEFINED_CONST INT2FIX(5) #define DEFINED_METHOD INT2FIX(6) #define DEFINED_YIELD INT2FIX(7) #define DEFINED_REF INT2FIX(8) #define DEFINED_ZSUPER INT2FIX(9) #define DEFINED_FUNC INT2FIX(10) /* VM related object allocate functions */ /* TODO: should be static functions */ VALUE rb_thread_alloc(VALUE klass); VALUE rb_proc_alloc(void); /* for debug */ extern void vm_stack_dump_raw(rb_thread_t *, rb_control_frame_t *); #define SDR() vm_stack_dump_raw(GET_THREAD(), GET_THREAD()->cfp) #define SDR2(cfp) vm_stack_dump_raw(GET_THREAD(), (cfp)) void yarv_bug(void); /* functions about thread/vm execution */ VALUE rb_thread_eval(rb_thread_t *th, VALUE iseqval); void rb_enable_interrupt(void); void rb_disable_interrupt(void); int rb_thread_method_id_and_klass(rb_thread_t *th, ID *idp, VALUE *klassp); VALUE th_eval_body(rb_thread_t *th); VALUE th_set_eval_stack(rb_thread_t *, VALUE iseq); VALUE th_invoke_proc(rb_thread_t *th, rb_proc_t *proc, VALUE self, int argc, VALUE *argv); VALUE th_make_proc(rb_thread_t *th, rb_control_frame_t *cfp, rb_block_t *block); VALUE th_make_env_object(rb_thread_t *th, rb_control_frame_t *cfp); VALUE th_backtrace(rb_thread_t *, int); VALUE th_yield(rb_thread_t *th, int argc, VALUE *argv); VALUE th_call0(rb_thread_t *th, VALUE klass, VALUE recv, VALUE id, ID oid, int argc, const VALUE *argv, NODE * body, int nosuper); int th_get_sourceline(rb_control_frame_t *); VALUE yarvcore_eval_parsed(NODE *node, VALUE file); VALUE yarvcore_eval(VALUE self, VALUE str, VALUE file, VALUE line); /* for thread */ #if RUBY_VM_THREAD_MODEL == 2 extern rb_thread_t *ruby_current_thread; extern rb_vm_t *ruby_current_vm; #define GET_VM() ruby_current_vm #define GET_THREAD() ruby_current_thread #define rb_thread_set_current_raw(th) (ruby_current_thread = th) #define rb_thread_set_current(th) do { \ rb_thread_set_current_raw(th); \ th->vm->running_thread = th; \ } while (0) #else #error "unsupported thread model" #endif void rb_thread_execute_interrupts(rb_thread_t *); #define RUBY_VM_CHECK_INTS_TH(th) do { \ if(th->interrupt_flag){ \ /* TODO: trap something event */ \ rb_thread_execute_interrupts(th); \ } \ } while (0) #define RUBY_VM_CHECK_INTS() \ RUBY_VM_CHECK_INTS_TH(GET_THREAD()) #endif /* _YARVCORE_H_INCLUDED_ */