Ruby  2.0.0p353(2013-11-22revision43784)
vm_core.h
Go to the documentation of this file.
1 /**********************************************************************
2 
3  vm_core.h -
4 
5  $Author: nagachika $
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 "ruby/ruby.h"
18 #include "ruby/st.h"
19 
20 #include "node.h"
21 #include "vm_debug.h"
22 #include "vm_opts.h"
23 #include "id.h"
24 #include "method.h"
25 #include "ruby_atomic.h"
26 
27 #if defined(_WIN32)
28 #include "thread_win32.h"
29 #elif defined(HAVE_PTHREAD_H)
30 #include "thread_pthread.h"
31 #else
32 #error "unsupported thread type"
33 #endif
34 
35 #ifndef ENABLE_VM_OBJSPACE
36 #ifdef _WIN32
37 /*
38  * TODO: object space independent st_table.
39  * socklist needs st_table in rb_w32_sysinit(), before object space
40  * initialization.
41  * It is too early now to change st_hash_type, since it breaks binary
42  * compatibility.
43  */
44 #define ENABLE_VM_OBJSPACE 0
45 #else
46 #define ENABLE_VM_OBJSPACE 1
47 #endif
48 #endif
49 
50 #include <setjmp.h>
51 #include <signal.h>
52 
53 #ifndef NSIG
54 # define NSIG (_SIGMAX + 1) /* For QNX */
55 #endif
56 
57 #define RUBY_NSIG NSIG
58 
59 #ifdef HAVE_STDARG_PROTOTYPES
60 #include <stdarg.h>
61 #define va_init_list(a,b) va_start((a),(b))
62 #else
63 #include <varargs.h>
64 #define va_init_list(a,b) va_start((a))
65 #endif
66 
67 #if defined(SIGSEGV) && defined(HAVE_SIGALTSTACK) && defined(SA_SIGINFO) && !defined(__NetBSD__)
68 #define USE_SIGALTSTACK
69 #endif
70 
71 /*****************/
72 /* configuration */
73 /*****************/
74 
75 /* gcc ver. check */
76 #if defined(__GNUC__) && __GNUC__ >= 2
77 
78 #if OPT_TOKEN_THREADED_CODE
79 #if OPT_DIRECT_THREADED_CODE
80 #undef OPT_DIRECT_THREADED_CODE
81 #endif
82 #endif
83 
84 #else /* defined(__GNUC__) && __GNUC__ >= 2 */
85 
86 /* disable threaded code options */
87 #if OPT_DIRECT_THREADED_CODE
88 #undef OPT_DIRECT_THREADED_CODE
89 #endif
90 #if OPT_TOKEN_THREADED_CODE
91 #undef OPT_TOKEN_THREADED_CODE
92 #endif
93 #endif
94 
95 #ifdef __native_client__
96 #undef OPT_DIRECT_THREADED_CODE
97 #endif
98 
99 /* call threaded code */
100 #if OPT_CALL_THREADED_CODE
101 #if OPT_DIRECT_THREADED_CODE
102 #undef OPT_DIRECT_THREADED_CODE
103 #endif /* OPT_DIRECT_THREADED_CODE */
104 #if OPT_STACK_CACHING
105 #undef OPT_STACK_CACHING
106 #endif /* OPT_STACK_CACHING */
107 #endif /* OPT_CALL_THREADED_CODE */
108 
109 /* likely */
110 #if __GNUC__ >= 3
111 #define LIKELY(x) (__builtin_expect((x), 1))
112 #define UNLIKELY(x) (__builtin_expect((x), 0))
113 #else /* __GNUC__ >= 3 */
114 #define LIKELY(x) (x)
115 #define UNLIKELY(x) (x)
116 #endif /* __GNUC__ >= 3 */
117 
118 #if __GNUC__ >= 3
119 #define UNINITIALIZED_VAR(x) x = x
120 #else
121 #define UNINITIALIZED_VAR(x) x
122 #endif
123 
124 typedef unsigned long rb_num_t;
125 
126 /* iseq data type */
127 
129 
131 
135  union {
137  long index;
138  } ic_value;
139 };
140 
141 /* to avoid warning */
142 struct rb_thread_struct;
144 
145 /* rb_call_info_t contains calling information including inline cache */
146 typedef struct rb_call_info_struct {
147  /* fixed at compile time */
152 
153  /* inline cache: keys */
156 
157  /* inline cache: values */
160 
161  /* temporary values for method calling */
162  int argc;
165  union {
166  int opt_pc; /* used by iseq */
167  long index; /* used by ivar */
168  int missing_reason; /* used by method_missing */
169  int inc_sp; /* used by cfunc */
170  } aux;
171 
172  VALUE (*call)(struct rb_thread_struct *th, struct rb_control_frame_struct *cfp, struct rb_call_info_struct *ci);
174 
175 #if 1
176 #define GetCoreDataFromValue(obj, type, ptr) do { \
177  (ptr) = (type*)DATA_PTR(obj); \
178 } while (0)
179 #else
180 #define GetCoreDataFromValue(obj, type, ptr) Data_Get_Struct((obj), type, (ptr))
181 #endif
182 
183 #define GetISeqPtr(obj, ptr) \
184  GetCoreDataFromValue((obj), rb_iseq_t, (ptr))
185 
186 typedef struct rb_iseq_location_struct {
191  size_t first_lineno;
193 
194 struct rb_iseq_struct;
195 
197  /***************/
198  /* static data */
199  /***************/
200 
201  enum iseq_type {
211  } type; /* instruction sequence type */
212 
214 
215  VALUE *iseq; /* iseq (insn number and operands) */
216  VALUE *iseq_encoded; /* encoded iseq */
217  unsigned long iseq_size;
218  VALUE mark_ary; /* Array: includes operands which should be GC marked */
219  VALUE coverage; /* coverage array */
220 
221  /* insn info, must be freed */
224 
225  ID *local_table; /* must free */
227 
228  /* sizeof(vars) + 1 */
230 
232  int ic_size;
233 
236 
264  int argc;
266  int arg_rest;
268  int arg_opts;
271  int arg_size;
274  int arg_keyword_check; /* if this is true, raise an ArgumentError when unknown keyword argument is passed */
277 
278  size_t stack_max; /* for stack overflow check */
279 
280  /* catch table */
283 
284  /* for child iseq */
287 
288  /****************/
289  /* dynamic data */
290  /****************/
291 
292  VALUE self;
293  VALUE orig; /* non-NULL if its data have origin */
294 
295  /* block inlining */
296  /*
297  * NODE *node;
298  * void *special_block_builder;
299  * void *cached_special_block_builder;
300  * VALUE cached_special_block;
301  */
302 
303  /* klass/module nest information stack (cref) */
306 
307  /* misc */
308  ID defined_method_id; /* for define_method */
310 
311  /* used at compile time */
313 };
314 
321 };
322 
323 #define GetVMPtr(obj, ptr) \
324  GetCoreDataFromValue((obj), rb_vm_t, (ptr))
325 
326 #if defined(ENABLE_VM_OBJSPACE) && ENABLE_VM_OBJSPACE
327 struct rb_objspace;
328 void rb_objspace_free(struct rb_objspace *);
329 #endif
330 
331 typedef struct rb_hook_list_struct {
336 
337 typedef struct rb_vm_struct {
338  VALUE self;
339 
342 
345 
348 
349  int running;
352  volatile int sleeper;
353 
354  /* object management */
356 
358 
359  /* load */
369 
370  /* signal */
371  struct {
373  int safe;
374  } trap_list[RUBY_NSIG];
375 
376  /* hook */
378 
380 
383 
385 
386 #if defined(ENABLE_VM_OBJSPACE) && ENABLE_VM_OBJSPACE
388 #endif
389 
390  /*
391  * @shyouhei notes that this is not for storing normal Ruby
392  * objects so do *NOT* mark this when you GC.
393  */
394  struct RArray at_exit;
395 
397 
398  /* params */
399  struct { /* size in byte */
404  } default_params;
405 } rb_vm_t;
406 
407 /* default values */
408 
409 #define RUBY_VM_SIZE_ALIGN 4096
410 
411 #define RUBY_VM_THREAD_VM_STACK_SIZE ( 128 * 1024 * sizeof(VALUE)) /* 512 KB or 1024 KB */
412 #define RUBY_VM_THREAD_VM_STACK_SIZE_MIN ( 2 * 1024 * sizeof(VALUE)) /* 8 KB or 16 KB */
413 #define RUBY_VM_THREAD_MACHINE_STACK_SIZE ( 128 * 1024 * sizeof(VALUE)) /* 512 KB or 1024 KB */
414 #define RUBY_VM_THREAD_MACHINE_STACK_SIZE_MIN ( 16 * 1024 * sizeof(VALUE)) /* 64 KB or 128 KB */
415 
416 #define RUBY_VM_FIBER_VM_STACK_SIZE ( 16 * 1024 * sizeof(VALUE)) /* 64 KB or 128 KB */
417 #define RUBY_VM_FIBER_VM_STACK_SIZE_MIN ( 2 * 1024 * sizeof(VALUE)) /* 8 KB or 16 KB */
418 #define RUBY_VM_FIBER_MACHINE_STACK_SIZE ( 64 * 1024 * sizeof(VALUE)) /* 256 KB or 512 KB */
419 #define RUBY_VM_FIBER_MACHINE_STACK_SIZE_MIN ( 16 * 1024 * sizeof(VALUE)) /* 64 KB or 128 KB */
420 
421 #ifndef VM_DEBUG_BP_CHECK
422 #define VM_DEBUG_BP_CHECK 0
423 #endif
424 
425 typedef struct rb_control_frame_struct {
426  VALUE *pc; /* cfp[0] */
427  VALUE *sp; /* cfp[1] */
428  rb_iseq_t *iseq; /* cfp[2] */
429  VALUE flag; /* cfp[3] */
430  VALUE self; /* cfp[4] / block[0] */
431  VALUE klass; /* cfp[5] / block[1] */
432  VALUE *ep; /* cfp[6] / block[2] */
433  rb_iseq_t *block_iseq; /* cfp[7] / block[3] */
434  VALUE proc; /* cfp[8] / block[4] */
435  const rb_method_entry_t *me;/* cfp[9] */
436 
437 #if VM_DEBUG_BP_CHECK
438  VALUE *bp_check; /* cfp[10] */
439 #endif
441 
442 typedef struct rb_block_struct {
443  VALUE self; /* share with method frame if it's only block */
444  VALUE klass; /* share with method frame if it's only block */
445  VALUE *ep; /* share with method frame if it's only block */
448 } rb_block_t;
449 
451 
452 #define GetThreadPtr(obj, ptr) \
453  TypedData_Get_Struct((obj), rb_thread_t, &ruby_threadptr_data_type, (ptr))
454 
460 };
461 
462 typedef RUBY_JMP_BUF rb_jmpbuf_t;
463 
464 /*
465  the members which are written in TH_PUSH_TAG() should be placed at
466  the beginning and the end, so that entire region is accessible.
467 */
468 struct rb_vm_tag {
472  struct rb_vm_tag *prev;
473 };
474 
477 };
478 
481  void *arg;
482 };
483 
484 struct rb_mutex_struct;
485 
486 struct rb_thread_struct;
487 typedef struct rb_thread_list_struct{
491 
492 
493 typedef struct rb_thread_struct {
494  VALUE self;
496 
497  /* execution information */
498  VALUE *stack; /* must free, must mark */
499  size_t stack_size; /* size in word (byte size / sizeof(VALUE)) */
503  VALUE last_status; /* $? */
504 
505  /* passing state */
506  int state;
507 
509 
510  /* for rb_iterate */
512 
513  /* for bmethod */
515 
516  /* for cfunc */
518 
519  /* for load(true) */
522 
523  /* eval env */
525 
528 
529  /* thread control */
532  int to_kill;
533  int priority;
534 
537 
540 
541  /* temporary place of errinfo */
543 
544  /* temporary place of retval on OPT_CALL_THREADED_CODE */
545 #if OPT_CALL_THREADED_CODE
546  VALUE retval;
547 #endif
548 
549  /* async errinfo queue */
553 
555  unsigned long interrupt_mask;
560 
561  struct rb_vm_tag *tag;
563 
571 
577 
578  /* storage */
580 
582 
586 
587  /* for GC */
591 #ifdef __ia64
592  VALUE *machine_register_stack_start;
593  VALUE *machine_register_stack_end;
594  size_t machine_register_stack_maxsize;
595 #endif
596  jmp_buf machine_regs;
598 
599  /* statistics data for profiler */
601 
602  /* tracer */
604  struct rb_trace_arg_struct *trace_arg; /* trace information */
605 
606  /* fiber */
610 
611  /* misc */
614 #ifdef USE_SIGALTSTACK
615  void *altstack;
616 #endif
617  unsigned long running_time_us;
618 } rb_thread_t;
619 
620 typedef enum {
624  /* 0x03..0x06 is reserved */
627 
628 #define VM_DEFINECLASS_TYPE(x) ((rb_vm_defineclass_type_t)(x) & VM_DEFINECLASS_TYPE_MASK)
629 #define VM_DEFINECLASS_FLAG_SCOPED 0x08
630 #define VM_DEFINECLASS_FLAG_HAS_SUPERCLASS 0x10
631 #define VM_DEFINECLASS_SCOPED_P(x) ((x) & VM_DEFINECLASS_FLAG_SCOPED)
632 #define VM_DEFINECLASS_HAS_SUPERCLASS_P(x) \
633  ((x) & VM_DEFINECLASS_FLAG_HAS_SUPERCLASS)
634 
635 /* iseq.c */
636 #if defined __GNUC__ && __GNUC__ >= 4
637 #pragma GCC visibility push(default)
638 #endif
639 
640 /* node -> iseq */
641 VALUE rb_iseq_new(NODE*, VALUE, VALUE, VALUE, VALUE, enum iseq_type);
642 VALUE rb_iseq_new_top(NODE *node, VALUE name, VALUE path, VALUE absolute_path, VALUE parent);
643 VALUE rb_iseq_new_main(NODE *node, VALUE path, VALUE absolute_path);
646 
647 /* src -> iseq */
648 VALUE rb_iseq_compile(VALUE src, VALUE file, VALUE line);
649 VALUE rb_iseq_compile_on_base(VALUE src, VALUE file, VALUE line, rb_block_t *base_block);
650 VALUE rb_iseq_compile_with_option(VALUE src, VALUE file, VALUE absolute_path, VALUE line, rb_block_t *base_block, VALUE opt);
651 
653 int rb_iseq_disasm_insn(VALUE str, VALUE *iseqval, size_t pos, rb_iseq_t *iseq, VALUE child);
654 const char *ruby_node_name(int node);
655 int rb_iseq_first_lineno(const rb_iseq_t *iseq);
656 
661 #if defined __GNUC__ && __GNUC__ >= 4
662 #pragma GCC visibility pop
663 #endif
664 
665 #define GetProcPtr(obj, ptr) \
666  GetCoreDataFromValue((obj), rb_proc_t, (ptr))
667 
668 typedef struct {
670 
671  VALUE envval; /* for GC mark */
676 } rb_proc_t;
677 
678 #define GetEnvPtr(obj, ptr) \
679  GetCoreDataFromValue((obj), rb_env_t, (ptr))
680 
681 typedef struct {
683  int env_size;
685  VALUE prev_envval; /* for GC mark */
687 } rb_env_t;
688 
689 #define GetBindingPtr(obj, ptr) \
690  GetCoreDataFromValue((obj), rb_binding_t, (ptr))
691 
692 typedef struct {
695  unsigned short first_lineno;
696 } rb_binding_t;
697 
698 /* used by compile time and send insn */
699 
704 };
705 
706 #define VM_CHECKMATCH_TYPE_MASK 0x03
707 #define VM_CHECKMATCH_ARRAY 0x04
708 
709 #define VM_CALL_ARGS_SPLAT (0x01 << 1) /* m(*args) */
710 #define VM_CALL_ARGS_BLOCKARG (0x01 << 2) /* m(&block) */
711 #define VM_CALL_FCALL (0x01 << 3) /* m(...) */
712 #define VM_CALL_VCALL (0x01 << 4) /* m */
713 #define VM_CALL_TAILCALL (0x01 << 5) /* located at tail position */
714 #define VM_CALL_SUPER (0x01 << 6) /* super */
715 #define VM_CALL_OPT_SEND (0x01 << 7) /* internal flag */
716 #define VM_CALL_ARGS_SKIP_SETUP (0x01 << 8) /* (flag & (SPLAT|BLOCKARG)) && blockiseq == 0 */
717 
722 };
723 
724 #define VM_FRAME_MAGIC_METHOD 0x11
725 #define VM_FRAME_MAGIC_BLOCK 0x21
726 #define VM_FRAME_MAGIC_CLASS 0x31
727 #define VM_FRAME_MAGIC_TOP 0x41
728 #define VM_FRAME_MAGIC_CFUNC 0x61
729 #define VM_FRAME_MAGIC_PROC 0x71
730 #define VM_FRAME_MAGIC_IFUNC 0x81
731 #define VM_FRAME_MAGIC_EVAL 0x91
732 #define VM_FRAME_MAGIC_LAMBDA 0xa1
733 #define VM_FRAME_MAGIC_MASK_BITS 8
734 #define VM_FRAME_MAGIC_MASK (~(~0<<VM_FRAME_MAGIC_MASK_BITS))
735 
736 #define VM_FRAME_TYPE(cfp) ((cfp)->flag & VM_FRAME_MAGIC_MASK)
737 
738 /* other frame flag */
739 #define VM_FRAME_FLAG_PASSED 0x0100
740 #define VM_FRAME_FLAG_FINISH 0x0200
741 #define VM_FRAME_TYPE_FINISH_P(cfp) (((cfp)->flag & VM_FRAME_FLAG_FINISH) != 0)
742 
743 #define RUBYVM_CFUNC_FRAME_P(cfp) \
744  (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_CFUNC)
745 
746 /* inline cache */
747 typedef struct iseq_inline_cache_entry *IC;
749 
750 void rb_vm_change_state(void);
751 
752 typedef VALUE CDHASH;
753 
754 #ifndef FUNC_FASTCALL
755 #define FUNC_FASTCALL(x) x
756 #endif
757 
758 typedef rb_control_frame_t *
760 
761 #define GC_GUARDED_PTR(p) ((VALUE)((VALUE)(p) | 0x01))
762 #define GC_GUARDED_PTR_REF(p) ((void *)(((VALUE)(p)) & ~0x03))
763 #define GC_GUARDED_PTR_P(p) (((VALUE)(p)) & 0x01)
764 
765 /*
766  * block frame:
767  * ep[ 0]: prev frame
768  * ep[-1]: CREF (for *_eval)
769  *
770  * method frame:
771  * ep[ 0]: block pointer (ptr | VM_ENVVAL_BLOCK_PTR_FLAG)
772  */
773 
774 #define VM_ENVVAL_BLOCK_PTR_FLAG 0x02
775 #define VM_ENVVAL_BLOCK_PTR(v) (GC_GUARDED_PTR(v) | VM_ENVVAL_BLOCK_PTR_FLAG)
776 #define VM_ENVVAL_BLOCK_PTR_P(v) ((v) & VM_ENVVAL_BLOCK_PTR_FLAG)
777 #define VM_ENVVAL_PREV_EP_PTR(v) ((VALUE)GC_GUARDED_PTR(v))
778 #define VM_ENVVAL_PREV_EP_PTR_P(v) (!(VM_ENVVAL_BLOCK_PTR_P(v)))
779 
780 #define VM_EP_PREV_EP(ep) ((VALUE *)GC_GUARDED_PTR_REF((ep)[0]))
781 #define VM_EP_BLOCK_PTR(ep) ((rb_block_t *)GC_GUARDED_PTR_REF((ep)[0]))
782 #define VM_EP_LEP_P(ep) VM_ENVVAL_BLOCK_PTR_P((ep)[0])
783 
786 
787 #define RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp) ((cfp)+1)
788 #define RUBY_VM_NEXT_CONTROL_FRAME(cfp) ((cfp)-1)
789 #define RUBY_VM_END_CONTROL_FRAME(th) \
790  ((rb_control_frame_t *)((th)->stack + (th)->stack_size))
791 #define RUBY_VM_VALID_CONTROL_FRAME_P(cfp, ecfp) \
792  ((void *)(ecfp) > (void *)(cfp))
793 #define RUBY_VM_CONTROL_FRAME_STACK_OVERFLOW_P(th, cfp) \
794  (!RUBY_VM_VALID_CONTROL_FRAME_P((cfp), RUBY_VM_END_CONTROL_FRAME(th)))
795 
796 #define RUBY_VM_IFUNC_P(ptr) (BUILTIN_TYPE(ptr) == T_NODE)
797 #define RUBY_VM_NORMAL_ISEQ_P(ptr) \
798  ((ptr) && !RUBY_VM_IFUNC_P(ptr))
799 
800 #define RUBY_VM_GET_BLOCK_PTR_IN_CFP(cfp) ((rb_block_t *)(&(cfp)->self))
801 #define RUBY_VM_GET_CFP_FROM_BLOCK_PTR(b) \
802  ((rb_control_frame_t *)((VALUE *)(b) - 4))
803 /* magic number `4' is depend on rb_control_frame_t layout. */
804 
805 /* VM related object allocate functions */
807 VALUE rb_proc_alloc(VALUE klass);
808 
809 /* for debug */
813 
814 #define SDR() rb_vmdebug_stack_dump_raw(GET_THREAD(), GET_THREAD()->cfp)
815 #define SDR2(cfp) rb_vmdebug_stack_dump_raw(GET_THREAD(), (cfp))
816 void rb_vm_bugreport(void);
817 
818 /* functions about thread/vm execution */
819 #if defined __GNUC__ && __GNUC__ >= 4
820 #pragma GCC visibility push(default)
821 #endif
822 VALUE rb_iseq_eval(VALUE iseqval);
823 VALUE rb_iseq_eval_main(VALUE iseqval);
824 #if defined __GNUC__ && __GNUC__ >= 4
825 #pragma GCC visibility pop
826 #endif
827 int rb_thread_method_id_and_class(rb_thread_t *th, ID *idp, VALUE *klassp);
828 
830  int argc, const VALUE *argv, const rb_block_t *blockptr);
831 VALUE rb_vm_make_proc(rb_thread_t *th, const rb_block_t *block, VALUE klass);
835 void rb_vm_gvl_destroy(rb_vm_t *vm);
836 VALUE rb_vm_call(rb_thread_t *th, VALUE recv, VALUE id, int argc,
837  const VALUE *argv, const rb_method_entry_t *me,
838  VALUE defined_class);
841 
846 
847 int ruby_thread_has_gvl_p(void);
848 typedef int rb_backtrace_iter_func(void *, VALUE, int, VALUE);
852 VALUE rb_name_err_mesg_new(VALUE obj, VALUE mesg, VALUE recv, VALUE method);
855 int rb_vm_control_frame_id_and_class(const rb_control_frame_t *cfp, ID *idp, VALUE *klassp);
856 
858 
860 
861 #define sysstack_error GET_VM()->special_exceptions[ruby_error_sysstack]
862 
863 #define CHECK_VM_STACK_OVERFLOW(cfp, margin) do \
864  if ((VALUE *)((char *)(((VALUE *)(cfp)->sp) + (margin)) + sizeof(rb_control_frame_t)) >= ((VALUE *)(cfp))) { \
865  vm_stackoverflow(); \
866  } \
867 while (0)
868 
869 /* for thread */
870 
871 #if RUBY_VM_THREAD_MODEL == 2
873 extern rb_vm_t *ruby_current_vm;
875 
876 #define GET_VM() ruby_current_vm
877 
878 #ifndef OPT_CALL_CFUNC_WITHOUT_FRAME
879 #define OPT_CALL_CFUNC_WITHOUT_FRAME 0
880 #endif
881 
882 static inline rb_thread_t *
884 {
886 #if OPT_CALL_CFUNC_WITHOUT_FRAME
887  if (UNLIKELY(th->passed_ci != 0)) {
888  void vm_call_cfunc_push_frame(rb_thread_t *th);
889  vm_call_cfunc_push_frame(th);
890  }
891 #endif
892  return th;
893 }
894 
895 #define rb_thread_set_current_raw(th) (void)(ruby_current_thread = (th))
896 #define rb_thread_set_current(th) do { \
897  if ((th)->vm->running_thread != (th)) { \
898  (th)->running_time_us = 0; \
899  } \
900  rb_thread_set_current_raw(th); \
901  (th)->vm->running_thread = (th); \
902 } while (0)
903 
904 #else
905 #error "unsupported thread model"
906 #endif
907 
908 enum {
913 };
914 
915 #define RUBY_VM_SET_TIMER_INTERRUPT(th) ATOMIC_OR((th)->interrupt_flag, TIMER_INTERRUPT_MASK)
916 #define RUBY_VM_SET_INTERRUPT(th) ATOMIC_OR((th)->interrupt_flag, PENDING_INTERRUPT_MASK)
917 #define RUBY_VM_SET_FINALIZER_INTERRUPT(th) ATOMIC_OR((th)->interrupt_flag, FINALIZER_INTERRUPT_MASK)
918 #define RUBY_VM_SET_TRAP_INTERRUPT(th) ATOMIC_OR((th)->interrupt_flag, TRAP_INTERRUPT_MASK)
919 #define RUBY_VM_INTERRUPTED(th) ((th)->interrupt_flag & ~(th)->interrupt_mask & (PENDING_INTERRUPT_MASK|TRAP_INTERRUPT_MASK))
920 #define RUBY_VM_INTERRUPTED_ANY(th) ((th)->interrupt_flag & ~(th)->interrupt_mask)
921 
922 int rb_signal_buff_size(void);
923 void rb_signal_exec(rb_thread_t *th, int sig);
925 void rb_threadptr_signal_raise(rb_thread_t *th, int sig);
933 
936 
937 #define RUBY_VM_CHECK_INTS_BLOCKING(th) do { \
938  if (UNLIKELY(!rb_threadptr_pending_interrupt_empty_p(th))) { \
939  th->pending_interrupt_queue_checked = 0; \
940  RUBY_VM_SET_INTERRUPT(th); \
941  rb_threadptr_execute_interrupts(th, 1); \
942  } \
943  else if (UNLIKELY(RUBY_VM_INTERRUPTED_ANY(th))) { \
944  rb_threadptr_execute_interrupts(th, 1); \
945  } \
946  } while (0)
947 
948 #define RUBY_VM_CHECK_INTS(th) do { \
949  if (UNLIKELY(RUBY_VM_INTERRUPTED_ANY(th))) { \
950  rb_threadptr_execute_interrupts(th, 0); \
951  } \
952 } while (0)
953 
954 /* tracer */
959  VALUE self;
963 
965 
966  /* calc from cfp */
967  int lineno;
969 };
970 
971 void rb_threadptr_exec_event_hooks(struct rb_trace_arg_struct *trace_arg);
973 
974 #define EXEC_EVENT_HOOK_ORIG(th_, flag_, self_, id_, klass_, data_, pop_p_) do { \
975  if (UNLIKELY(ruby_vm_event_flags & (flag_))) { \
976  if (((th)->event_hooks.events | (th)->vm->event_hooks.events) & (flag_)) { \
977  struct rb_trace_arg_struct trace_arg; \
978  trace_arg.event = (flag_); \
979  trace_arg.th = (th_); \
980  trace_arg.cfp = (trace_arg.th)->cfp; \
981  trace_arg.self = (self_); \
982  trace_arg.id = (id_); \
983  trace_arg.klass = (klass_); \
984  trace_arg.data = (data_); \
985  trace_arg.path = Qundef; \
986  trace_arg.klass_solved = 0; \
987  if (pop_p_) rb_threadptr_exec_event_hooks_and_pop_frame(&trace_arg); \
988  else rb_threadptr_exec_event_hooks(&trace_arg); \
989  } \
990  } \
991 } while (0)
992 
993 #define EXEC_EVENT_HOOK(th_, flag_, self_, id_, klass_, data_) \
994  EXEC_EVENT_HOOK_ORIG(th_, flag_, self_, id_, klass_, data_, 0)
995 
996 #define EXEC_EVENT_HOOK_AND_POP_FRAME(th_, flag_, self_, id_, klass_, data_) \
997  EXEC_EVENT_HOOK_ORIG(th_, flag_, self_, id_, klass_, data_, 1)
998 
999 #if defined __GNUC__ && __GNUC__ >= 4
1000 #pragma GCC visibility push(default)
1001 #endif
1002 
1004 
1005 extern VALUE rb_get_coverages(void);
1006 extern void rb_set_coverages(VALUE);
1007 extern void rb_reset_coverages(void);
1008 
1009 #if defined __GNUC__ && __GNUC__ >= 4
1010 #pragma GCC visibility pop
1011 #endif
1012 
1013 #endif /* RUBY_VM_CORE_H */
const rb_block_t * passed_block
Definition: vm_core.h:511
int is_from_method
Definition: vm_core.h:674
rb_control_frame_t * cfp
Definition: vm_core.h:500
void rb_objspace_free(struct rb_objspace *)
Definition: gc.c:389
rb_thread_list_t * join_list
Definition: vm_core.h:581
struct rb_block_struct * blockptr
Definition: vm_core.h:163
void rb_vm_bugreport(void)
Definition: vm_dump.c:609
VALUE * env
Definition: vm_core.h:682
int arg_simple
Definition: vm_core.h:265
unsigned long running_time_us
Definition: vm_core.h:617
rb_vm_t * vm
Definition: vm_core.h:495
VALUE rb_get_coverages(void)
Definition: thread.c:5162
VALUE expanded_load_path
Definition: vm_core.h:364
VALUE prev_envval
Definition: vm_core.h:685
VALUE ic_class
Definition: vm_core.h:134
void rb_threadptr_pending_interrupt_clear(rb_thread_t *th)
Definition: thread.c:1489
void rb_threadptr_signal_raise(rb_thread_t *th, int sig)
Definition: thread.c:2007
VALUE * root_lep
Definition: vm_core.h:526
rb_block_t * rb_vm_control_frame_block_ptr(rb_control_frame_t *cfp)
Definition: vm.c:61
VALUE rb_iseq_new_with_bopt(NODE *, VALUE, VALUE, VALUE, VALUE, VALUE, enum iseq_type, VALUE)
Definition: iseq.c:461
struct RArray at_exit
Definition: vm_core.h:394
struct rb_vm_protect_tag * protect_tag
Definition: vm_core.h:562
struct rb_thread_struct * running_thread
Definition: vm_core.h:344
Definition: st.h:77
VALUE cmd
Definition: vm_core.h:372
st_table * local_storage
Definition: vm_core.h:579
void rb_threadptr_unlock_all_locking_mutexes(rb_thread_t *th)
Definition: thread.c:390
int pending_interrupt_queue_checked
Definition: vm_core.h:551
ID * arg_keyword_table
Definition: vm_core.h:276
VALUE rb_proc_alloc(VALUE klass)
Definition: proc.c:84
const rb_method_entry_t * passed_me
Definition: vm_core.h:514
rb_thread_lock_t interrupt_lock
Definition: vm_core.h:556
VALUE top_self
Definition: vm_core.h:360
pthread_mutex_t rb_thread_lock_t
rb_thread_lock_t thread_destruct_lock
Definition: vm_core.h:341
rb_block_t block
Definition: vm_core.h:686
VALUE progname
Definition: vm_core.h:381
struct rb_thread_struct * th
Definition: vm_core.h:489
void rb_unblock_function_t(void *)
Definition: intern.h:835
void rb_thread_start_timer_thread(void)
Definition: thread.c:3782
rb_unblock_function_t * func
Definition: vm_core.h:480
struct iseq_compile_data * compile_data
Definition: vm_core.h:312
struct st_table * loaded_features_index
Definition: vm_core.h:367
vm_check_match_type
Definition: vm_core.h:700
rb_iseq_t * iseq
Definition: vm_core.h:446
struct rb_vm_struct::@131 default_params
VALUE pending_interrupt_mask_stack
Definition: vm_core.h:552
VALUE rb_iseq_new_top(NODE *node, VALUE name, VALUE path, VALUE absolute_path, VALUE parent)
Definition: iseq.c:418
VALUE coverage
Definition: vm_core.h:219
RUBY_EXTERN VALUE rb_cRubyVM
Definition: vm_core.h:658
VALUE * defined_strings
Definition: vm_core.h:396
VALUE rb_binding_new_with_cfp(rb_thread_t *th, const rb_control_frame_t *src_cfp)
Definition: proc.c:314
VALUE rb_thread_alloc(VALUE klass)
Definition: vm.c:2002
rb_call_info_t * callinfo_entries
Definition: vm_core.h:234
int env_size
Definition: vm_core.h:683
rb_thread_t * th
Definition: vm_core.h:957
VALUE mark_object_ary
Definition: vm_core.h:355
#define RUBY_NSIG
Definition: vm_core.h:57
void rb_unlink_method_entry(rb_method_entry_t *me)
Definition: vm_method.c:99
VALUE rb_vm_make_env_object(rb_thread_t *th, rb_control_frame_t *cfp)
Definition: vm.c:495
int rb_autoloading_value(VALUE mod, ID id, VALUE *value)
Definition: variable.c:1711
int rb_iseq_disasm_insn(VALUE str, VALUE *iseqval, size_t pos, rb_iseq_t *iseq, VALUE child)
Disassemble a instruction Iseq -> Iseq inspect object.
Definition: iseq.c:1262
st_table * living_threads
Definition: vm_core.h:346
size_t fiber_machine_stack_size
Definition: vm_core.h:403
rb_vm_t * ruby_current_vm
Definition: vm.c:97
VALUE verbose
Definition: vm_core.h:381
void ruby_thread_init_stack(rb_thread_t *th)
Definition: thread.c:474
int local_table_size
Definition: vm_core.h:226
struct rb_hook_list_struct rb_hook_list_t
struct rb_iseq_struct * local_iseq
Definition: vm_core.h:286
struct rb_vm_protect_tag * prev
Definition: vm_core.h:476
VALUE rb_iseq_eval(VALUE iseqval)
Definition: vm.c:1429
struct iseq_inline_cache_entry * ic_entries
Definition: vm_core.h:231
size_t stack_max
Definition: vm_core.h:278
int arg_keyword
Definition: vm_core.h:273
long index
Definition: vm_core.h:137
struct rb_control_frame_struct rb_control_frame_t
VALUE last_status
Definition: vm_core.h:503
ID defined_method_id
Definition: vm_core.h:308
void rb_thread_lock_destroy(rb_thread_lock_t *)
Definition: thread.c:287
RUBY_EXTERN VALUE rb_cEnv
Definition: vm_core.h:659
VALUE env
Definition: vm_core.h:693
struct rb_thread_list_struct rb_thread_list_t
rb_vm_defineclass_type_t
Definition: vm_core.h:620
rb_event_flag_t events
Definition: vm_core.h:333
int arg_post_len
Definition: vm_core.h:269
void rb_vmdebug_stack_dump_raw(rb_thread_t *, rb_control_frame_t *)
Definition: vm_dump.c:138
VALUE orig
Definition: vm_core.h:293
VALUE value
Definition: vm_core.h:136
int rb_threadptr_pending_interrupt_active_p(rb_thread_t *th)
Definition: thread.c:1604
void rb_vm_stack_to_heap(rb_thread_t *th)
Definition: vm.c:553
void rb_thread_stop_timer_thread(int)
Definition: thread.c:3768
int rb_thread_method_id_and_class(rb_thread_t *th, ID *idp, VALUE *klassp)
Definition: vm.c:1483
VALUE rb_vm_call(rb_thread_t *th, VALUE recv, VALUE id, int argc, const VALUE *argv, const rb_method_entry_t *me, VALUE defined_class)
Definition: vm_eval.c:243
VALUE envval
Definition: vm_core.h:671
VALUE thgroup_default
Definition: vm_core.h:347
Definition: node.h:239
pthread_t rb_thread_id_t
VALUE * iseq
Definition: vm_core.h:215
VALUE * stack
Definition: vm_core.h:498
enum rb_iseq_struct::iseq_type type
void rb_thread_reset_timer_thread(void)
Definition: thread.c:3776
unsigned short first_lineno
Definition: vm_core.h:695
union rb_call_info_struct::@129 aux
int rb_iseq_first_lineno(const rb_iseq_t *iseq)
Definition: iseq.c:1054
NODE * cref_stack
Definition: vm_core.h:304
void rb_thread_wakeup_timer_thread(void)
int src_encoding_index
Definition: vm_core.h:379
int trace_running
Definition: vm_core.h:351
VALUE locking_mutex
Definition: vm_core.h:558
void rb_gc_mark_machine_stack(rb_thread_t *th)
Definition: gc.c:2528
rb_iseq_t * block_iseq
Definition: vm_core.h:433
int rb_vm_control_frame_id_and_class(const rb_control_frame_t *cfp, ID *idp, VALUE *klassp)
Definition: vm.c:1455
void rb_signal_exec(rb_thread_t *th, int sig)
Definition: signal.c:712
size_t fiber_vm_stack_size
Definition: vm_core.h:402
struct rb_vm_struct rb_vm_t
void * blocking_region_buffer
Definition: vm_core.h:536
int rb_thread_check_trap_pending(void)
Definition: thread.c:1100
int argc
argument information
Definition: vm_core.h:264
VALUE load_path_check_cache
Definition: vm_core.h:363
Definition: ruby.h:881
rb_iseq_t * iseq
Definition: vm_core.h:428
int arg_post_start
Definition: vm_core.h:270
void rb_threadptr_exec_event_hooks_and_pop_frame(struct rb_trace_arg_struct *trace_arg)
Definition: vm_trace.c:332
int running
Definition: vm_core.h:349
#define UNLIKELY(x)
Definition: vm_core.h:115
rb_control_frame_t * cfp
Definition: vm_core.h:958
jmp_buf machine_regs
Definition: vm_core.h:596
VALUE * arg_opt_table
Definition: vm_core.h:272
VALUE tag
Definition: vm_core.h:469
int arg_keywords
Definition: vm_core.h:275
VALUE rb_iseq_new_main(NODE *node, VALUE path, VALUE absolute_path)
Definition: iseq.c:425
VALUE top_self
Definition: vm_core.h:520
VALUE * rb_vm_ep_local_ep(VALUE *ep)
Definition: vm.c:36
rb_num_t flip_cnt
Definition: vm_core.h:309
int thread_abort_on_exception
Definition: vm_core.h:350
int argc
Definition: ruby.c:130
struct unlinked_method_entry_list_entry * unlinked_method_entry_list
Definition: vm_core.h:384
vm_special_object_type
Definition: vm_core.h:718
struct st_table * loading_table
Definition: vm_core.h:368
rb_thread_status
Definition: vm_core.h:455
struct rb_iseq_location_struct rb_iseq_location_t
Definition: method.h:95
void rb_vmdebug_debug_print_pre(rb_thread_t *th, rb_control_frame_t *cfp)
Definition: vm_dump.c:352
rb_iseq_t * blockiseq
Definition: vm_core.h:151
rb_block_t * base_block
Definition: vm_core.h:524
void rb_threadptr_signal_exit(rb_thread_t *th)
Definition: thread.c:2017
volatile int sleeper
Definition: vm_core.h:352
VALUE * machine_stack_start
Definition: vm_core.h:588
ID * local_table
Definition: vm_core.h:225
struct rb_event_hook_struct * hooks
Definition: vm_core.h:332
unsigned long rb_num_t
Definition: vm_core.h:124
int rb_signal_buff_size(void)
Definition: signal.c:560
const char * ruby_node_name(int node)
Definition: iseq.c:1578
Definition: vm_core.h:132
rb_hook_list_t event_hooks
Definition: vm_core.h:603
void rb_thread_lock_unlock(rb_thread_lock_t *)
Definition: thread.c:281
VALUE ic_vmstat
Definition: vm_core.h:133
VALUE special_exceptions[ruby_special_error_count]
Definition: vm_core.h:357
VALUE rb_vm_make_proc(rb_thread_t *th, const rb_block_t *block, VALUE klass)
Definition: vm.c:574
struct rb_mutex_struct * keeping_mutexes
Definition: vm_core.h:559
VALUE mark_ary
Definition: vm_core.h:218
VALUE loaded_features
Definition: vm_core.h:365
rb_event_flag_t ruby_vm_event_flags
Definition: vm.c:98
struct rb_vm_struct::@130 trap_list[RUBY_NSIG]
void rb_threadptr_pending_interrupt_enque(rb_thread_t *th, VALUE v)
Definition: thread.c:1495
struct rb_iseq_struct * parent_iseq
Definition: vm_core.h:285
unsigned long ID
Definition: ruby.h:105
size_t thread_vm_stack_size
Definition: vm_core.h:400
rb_thread_t * ruby_current_thread
Definition: vm.c:96
int local_size
Definition: vm_core.h:684
rb_call_info_t * CALL_INFO
Definition: vm_core.h:748
VALUE rb_iseq_compile(VALUE src, VALUE file, VALUE line)
Definition: iseq.c:634
VALUE * iseq_encoded
Definition: vm_core.h:216
unsigned long VALUE
Definition: ruby.h:104
const rb_data_type_t ruby_threadptr_data_type
Definition: vm.c:1918
RUBY_JMP_BUF rb_jmpbuf_t
Definition: vm_core.h:462
int catch_table_size
Definition: vm_core.h:282
Definition: iseq.h:57
struct rb_thread_struct * main_thread
Definition: vm_core.h:343
VALUE first_proc
Definition: vm_core.h:583
VALUE rb_iseq_new(NODE *, VALUE, VALUE, VALUE, VALUE, enum iseq_type)
Definition: iseq.c:410
rb_iseq_location_t location
Definition: vm_core.h:213
rb_atomic_t interrupt_flag
Definition: vm_core.h:554
int rb_backtrace_iter_func(void *, VALUE, int, VALUE)
Definition: vm_core.h:848
union iseq_inline_cache_entry::@128 ic_value
int abort_on_exception
Definition: vm_core.h:613
VALUE blockprocval
Definition: vm_core.h:672
VALUE(* first_func)(ANYARGS)
Definition: vm_core.h:585
enum rb_thread_status status
Definition: vm_core.h:531
VALUE rb_vm_invoke_proc(rb_thread_t *th, rb_proc_t *proc, int argc, const VALUE *argv, const rb_block_t *blockptr)
Definition: vm.c:712
ruby_special_exceptions
Definition: vm_core.h:315
struct rb_block_struct rb_block_t
void rb_vm_change_state(void)
Definition: vm.c:103
int callinfo_size
Definition: vm_core.h:235
VALUE * machine_stack_end
Definition: vm_core.h:589
VALUE rb_iseq_compile_on_base(VALUE src, VALUE file, VALUE line, rb_block_t *base_block)
Definition: iseq.c:640
VALUE first_args
Definition: vm_core.h:584
void rb_vm_gvl_destroy(rb_vm_t *vm)
Definition: thread.c:273
struct rb_objspace * objspace
Definition: vm_core.h:387
int is_lambda
Definition: vm_core.h:675
VALUE top_wrapper
Definition: vm_core.h:521
int mark_stack_len
Definition: vm_core.h:597
int safe_level
Definition: vm_core.h:673
int arg_keyword_check
Definition: vm_core.h:274
VALUE root_svar
Definition: vm_core.h:527
rb_block_t block
Definition: vm_core.h:669
VALUE klass
Definition: vm_core.h:305
int mild_compile_error
Thread-local state of compiling context.
Definition: vm_core.h:576
unsigned long interrupt_mask
Definition: vm_core.h:555
void rb_threadptr_interrupt(rb_thread_t *th)
Definition: thread.c:347
size_t line_info_size
Definition: vm_core.h:223
#define ANYARGS
Definition: defines.h:57
const rb_method_entry_t * me
Definition: vm_core.h:435
struct rb_unblock_callback unblock
Definition: vm_core.h:557
unsigned long rb_event_flag_t
Definition: ruby.h:1603
rb_hook_list_t event_hooks
Definition: vm_core.h:377
#define FUNC_FASTCALL(x)
Definition: vm_core.h:755
struct iseq_catch_table_entry * catch_table
Definition: vm_core.h:281
rb_control_frame_t *FUNC_FASTCALL rb_insn_func_t(rb_thread_t *, rb_control_frame_t *)
Definition: vm_core.h:759
void rb_set_coverages(VALUE)
Definition: thread.c:5168
VALUE root_fiber
Definition: vm_core.h:608
int local_size
Definition: vm_core.h:229
VALUE CDHASH
Definition: vm_core.h:752
struct iseq_inline_cache_entry * IC
Definition: vm_core.h:747
void rb_gc_mark_unlinked_live_method_entries(void *pvm)
Definition: vm_method.c:108
v
Definition: win32ole.c:798
native_thread_data_t native_thread_data
Definition: vm_core.h:535
size_t thread_machine_stack_size
Definition: vm_core.h:401
VALUE rb_iseq_compile_with_option(VALUE src, VALUE file, VALUE absolute_path, VALUE line, rb_block_t *base_block, VALUE opt)
Definition: iseq.c:589
VALUE load_path_snapshot
Definition: vm_core.h:362
struct iseq_line_info_entry * line_info_table
Definition: vm_core.h:222
VALUE rb_iseq_disasm(VALUE self)
Definition: iseq.c:1354
unsigned long iseq_size
Definition: vm_core.h:217
void rb_reset_coverages(void)
Definition: thread.c:5175
int rb_vm_get_sourceline(const rb_control_frame_t *)
Definition: vm_backtrace.c:33
void rb_vm_inc_const_missing_count(void)
Definition: vm.c:128
VALUE loaded_features_snapshot
Definition: vm_core.h:366
VALUE rb_iseq_new_with_opt(NODE *, VALUE, VALUE, VALUE, VALUE, VALUE, enum iseq_type, const rb_compile_option_t *)
Definition: iseq.c:451
rb_jmpbuf_t root_jmpbuf
Definition: vm_core.h:609
VALUE debug
Definition: vm_core.h:381
int rb_atomic_t
Definition: ruby_atomic.h:93
#define RUBY_EXTERN
Definition: defines.h:188
rb_call_info_t * passed_ci
Definition: vm_core.h:517
rb_global_vm_lock_t gvl
Definition: vm_core.h:340
const char * name
Definition: nkf.c:208
rb_event_flag_t event
Definition: vm_core.h:956
void rb_vmdebug_debug_print_post(rb_thread_t *th, rb_control_frame_t *cfp)
Definition: vm_dump.c:378
rb_jmpbuf_t buf
Definition: vm_core.h:471
size_t stack_size
Definition: vm_core.h:499
struct rb_thread_list_struct * next
Definition: vm_core.h:488
struct rb_thread_struct rb_thread_t
struct rb_vm_tag * tag
Definition: vm_core.h:561
struct rb_vm_tag * prev
Definition: vm_core.h:472
VALUE retval
Definition: vm_core.h:470
struct rb_call_info_struct rb_call_info_t
VALUE(* call)(struct rb_thread_struct *th, struct rb_control_frame_struct *cfp, struct rb_call_info_struct *ci)
Definition: vm_core.h:172
VALUE load_path
Definition: vm_core.h:361
void rb_threadptr_check_signal(rb_thread_t *mth)
Definition: thread.c:3727
void rb_threadptr_exec_event_hooks(struct rb_trace_arg_struct *trace_arg)
Definition: vm_trace.c:338
VALUE pending_interrupt_queue
Definition: vm_core.h:550
RUBY_EXTERN VALUE rb_mRubyVMFrozenCore
Definition: vm_core.h:660
Definition: iseq.h:52
void rb_threadptr_execute_interrupts(rb_thread_t *, int)
Definition: thread.c:1891
#define mod(x, y)
Definition: date_strftime.c:28
rb_control_frame_t * rb_vm_get_binding_creatable_next_cfp(rb_thread_t *th, const rb_control_frame_t *cfp)
Definition: vm.c:189
size_t machine_stack_maxsize
Definition: vm_core.h:590
rb_control_frame_t * rb_vm_get_ruby_level_next_cfp(rb_thread_t *th, const rb_control_frame_t *cfp)
Definition: vm.c:201
VALUE path
Definition: vm_core.h:694
int method_missing_reason
Definition: vm_core.h:612
VALUE stat_insn_usage
Definition: vm_core.h:600
static rb_thread_t * GET_THREAD(void)
Definition: vm_core.h:883
VALUE rb_iseq_eval_main(VALUE iseqval)
Definition: vm.c:1442
VALUE rb_name_err_mesg_new(VALUE obj, VALUE mesg, VALUE recv, VALUE method)
Definition: error.c:1027
RUBY_EXTERN VALUE rb_cISeq
Definition: vm_core.h:657
struct rb_trace_arg_struct * trace_arg
Definition: vm_core.h:604
int ruby_thread_has_gvl_p(void)
Definition: thread.c:1443
VALUE coverages
Definition: vm_core.h:382
rb_thread_id_t thread_id
Definition: vm_core.h:530
Definition: method.h:103
const rb_method_entry_t * me
Definition: vm_core.h:158
char ** argv
Definition: ruby.c:131
VALUE * ep
Definition: vm_core.h:445
int parse_in_eval
Thread-local state of evaluation context.
Definition: vm_core.h:570