Ruby 2.7.0p0(2019-12-25revision647ee6f091eafcce70ffb75ddf7e121e192ab217)

eval_intern.h
Go to the documentation of this file.
1 #ifndef RUBY_EVAL_INTERN_H
2 #define RUBY_EVAL_INTERN_H
3
4 #include "ruby/ruby.h"
5 #include "vm_core.h"
6
7 static inline void
8 vm_passed_block_handler_set(rb_execution_context_t *ec, VALUE block_handler)
9 {
10 vm_block_handler_verify(block_handler);
11 ec->passed_block_handler = block_handler;
12 }
13
14 static inline void
15 pass_passed_block_handler(rb_execution_context_t *ec)
16 {
17 VALUE block_handler = rb_vm_frame_block_handler(ec->cfp);
18 vm_passed_block_handler_set(ec, block_handler);
19 VM_ENV_FLAGS_SET(ec->cfp->ep, VM_FRAME_FLAG_PASSED);
20 }
21
22 #define PASS_PASSED_BLOCK_HANDLER_EC(ec) pass_passed_block_handler(ec)
23 #define PASS_PASSED_BLOCK_HANDLER() pass_passed_block_handler(GET_EC())
24
25 #ifdef HAVE_STDLIB_H
26 #include <stdlib.h>
27 #endif
28 #ifndef EXIT_SUCCESS
29 #define EXIT_SUCCESS 0
30 #endif
31 #ifndef EXIT_FAILURE
32 #define EXIT_FAILURE 1
33 #endif
34
35 #include <stdio.h>
36 #include <setjmp.h>
37
38 #ifdef __APPLE__
39 # ifdef HAVE_CRT_EXTERNS_H
40 # include <crt_externs.h>
41 # else
42 # include "missing/crt_externs.h"
43 # endif
44 #endif
45
46 #ifndef HAVE_STRING_H
47 char *strrchr(const char *, const char);
48 #endif
49
50 #ifdef HAVE_UNISTD_H
51 #include <unistd.h>
52 #endif
53
54 #ifdef HAVE_NET_SOCKET_H
55 #include <net/socket.h>
56 #endif
57
58 #define ruby_setjmp(env) RUBY_SETJMP(env)
59 #define ruby_longjmp(env,val) RUBY_LONGJMP((env),(val))
60 #ifdef __CYGWIN__
61 # ifndef _setjmp
62 int _setjmp(jmp_buf);
63 # endif
64 # ifndef _longjmp
65 NORETURN(void _longjmp(jmp_buf, int));
66 # endif
67 #endif
68
69 #include <sys/types.h>
70 #include <signal.h>
71 #include <errno.h>
72
73 #ifdef HAVE_SYS_SELECT_H
74 #include <sys/select.h>
75 #endif
76
77 /*
78 Solaris sys/select.h switches select to select_large_fdset to support larger
79 file descriptors if FD_SETSIZE is larger than 1024 on 32bit environment.
80 But Ruby doesn't change FD_SETSIZE because fd_set is allocated dynamically.
81 So following definition is required to use select_large_fdset.
82 */
83 #ifdef HAVE_SELECT_LARGE_FDSET
84 #define select(n, r, w, e, t) select_large_fdset((n), (r), (w), (e), (t))
85 extern int select_large_fdset(int, fd_set *, fd_set *, fd_set *, struct timeval *);
86 #endif
87
88 #ifdef HAVE_SYS_PARAM_H
89 #include <sys/param.h>
90 #endif
91
92 #include <sys/stat.h>
93
94 #ifdef _MSC_VER
95 #define SAVE_ROOT_JMPBUF_BEFORE_STMT \
96 __try {
97 #define SAVE_ROOT_JMPBUF_AFTER_STMT \
98 } \
99 __except (GetExceptionCode() == EXCEPTION_STACK_OVERFLOW ? \
100 (rb_ec_raised_set(GET_EC(), RAISED_STACKOVERFLOW), \
101 raise(SIGSEGV), \
102 EXCEPTION_EXECUTE_HANDLER) : \
103 EXCEPTION_CONTINUE_SEARCH) { \
104 /* never reaches here */ \
105 }
106 #elif defined(__MINGW32__)
107 LONG WINAPI rb_w32_stack_overflow_handler(struct _EXCEPTION_POINTERS *);
108 #define SAVE_ROOT_JMPBUF_BEFORE_STMT \
109 do { \
110 PVOID _handler = AddVectoredExceptionHandler(1, rb_w32_stack_overflow_handler);
111
112 #define SAVE_ROOT_JMPBUF_AFTER_STMT \
113 RemoveVectoredExceptionHandler(_handler); \
114 } while (0);
115 #else
116 #define SAVE_ROOT_JMPBUF_BEFORE_STMT
117 #define SAVE_ROOT_JMPBUF_AFTER_STMT
118 #endif
119
120 #define SAVE_ROOT_JMPBUF(th, stmt) do \
121 if (ruby_setjmp((th)->root_jmpbuf) == 0) { \
122 SAVE_ROOT_JMPBUF_BEFORE_STMT \
123 stmt; \
124 SAVE_ROOT_JMPBUF_AFTER_STMT \
125 } \
126 else { \
127 rb_fiber_start(); \
128 } while (0)
129
130 #define EC_PUSH_TAG(ec) do { \
131 rb_execution_context_t * const _ec = (ec); \
132 struct rb_vm_tag _tag; \
133 _tag.state = TAG_NONE; \
134 _tag.tag = Qundef; \
135 _tag.prev = _ec->tag;
136
137 #define EC_POP_TAG() \
138 _ec->tag = _tag.prev; \
139 } while (0)
140
141 #define EC_TMPPOP_TAG() \
142 _ec->tag = _tag.prev
143
144 #define EC_REPUSH_TAG() (void)(_ec->tag = &_tag)
145
146 #if defined __GNUC__ && __GNUC__ == 4 && (__GNUC_MINOR__ >= 6 && __GNUC_MINOR__ <= 8) || __clang__
147 /* This macro prevents GCC 4.6--4.8 from emitting maybe-uninitialized warnings.
148 * This macro also prevents Clang from dumping core in EC_EXEC_TAG().
149 * (I confirmed Clang 4.0.1 and 5.0.0.)
150 */
151 # define VAR_FROM_MEMORY(var) __extension__(*(__typeof__(var) volatile *)&(var))
152 # define VAR_INITIALIZED(var) ((var) = VAR_FROM_MEMORY(var))
153 # define VAR_NOCLOBBERED(var) volatile var
154 #else
155 # define VAR_FROM_MEMORY(var) (var)
156 # define VAR_INITIALIZED(var) ((void)&(var))
157 # define VAR_NOCLOBBERED(var) var
158 #endif
159
160 /* clear ec->tag->state, and return the value */
161 static inline int
162 rb_ec_tag_state(const rb_execution_context_t *ec)
163 {
164 enum ruby_tag_type state = ec->tag->state;
165 ec->tag->state = TAG_NONE;
166 return state;
167 }
168
169 NORETURN(static inline void rb_ec_tag_jump(const rb_execution_context_t *ec, enum ruby_tag_type st));
170 static inline void
171 rb_ec_tag_jump(const rb_execution_context_t *ec, enum ruby_tag_type st)
172 {
173 ec->tag->state = st;
174 ruby_longjmp(ec->tag->buf, 1);
175 }
176
177 /*
178 setjmp() in assignment expression rhs is undefined behavior
179 [ISO/IEC 9899:1999] 7.13.1.1
180 */
181 #define EC_EXEC_TAG() \
182 (ruby_setjmp(_tag.buf) ? rb_ec_tag_state(VAR_FROM_MEMORY(_ec)) : (EC_REPUSH_TAG(), 0))
183
184 #define EC_JUMP_TAG(ec, st) rb_ec_tag_jump(ec, st)
185
186 #define INTERNAL_EXCEPTION_P(exc) FIXNUM_P(exc)
187
188 /* CREF operators */
189
190 #define CREF_FL_PUSHED_BY_EVAL IMEMO_FL_USER1
191 #define CREF_FL_OMOD_SHARED IMEMO_FL_USER2
192
193 static inline VALUE
194 CREF_CLASS(const rb_cref_t *cref)
195 {
196 return cref->klass;
197 }
198
199 static inline rb_cref_t *
200 CREF_NEXT(const rb_cref_t *cref)
201 {
202 return cref->next;
203 }
204
205 static inline const rb_scope_visibility_t *
206 CREF_SCOPE_VISI(const rb_cref_t *cref)
207 {
208 return &cref->scope_visi;
209 }
210
211 static inline VALUE
212 CREF_REFINEMENTS(const rb_cref_t *cref)
213 {
214 return cref->refinements;
215 }
216
217 static inline void
218 CREF_REFINEMENTS_SET(rb_cref_t *cref, VALUE refs)
219 {
220 RB_OBJ_WRITE(cref, &cref->refinements, refs);
221 }
222
223 static inline int
224 CREF_PUSHED_BY_EVAL(const rb_cref_t *cref)
225 {
226 return cref->flags & CREF_FL_PUSHED_BY_EVAL;
227 }
228
229 static inline void
230 CREF_PUSHED_BY_EVAL_SET(rb_cref_t *cref)
231 {
232 cref->flags |= CREF_FL_PUSHED_BY_EVAL;
233 }
234
235 static inline int
236 CREF_OMOD_SHARED(const rb_cref_t *cref)
237 {
238 return cref->flags & CREF_FL_OMOD_SHARED;
239 }
240
241 static inline void
242 CREF_OMOD_SHARED_SET(rb_cref_t *cref)
243 {
244 cref->flags |= CREF_FL_OMOD_SHARED;
245 }
246
247 static inline void
248 CREF_OMOD_SHARED_UNSET(rb_cref_t *cref)
249 {
250 cref->flags &= ~CREF_FL_OMOD_SHARED;
251 }
252
253 enum {
254 RAISED_EXCEPTION = 1,
255 RAISED_STACKOVERFLOW = 2,
256 RAISED_NOMEMORY = 4
257 };
258 #define rb_ec_raised_set(ec, f) ((ec)->raised_flag |= (f))
259 #define rb_ec_raised_reset(ec, f) ((ec)->raised_flag &= ~(f))
260 #define rb_ec_raised_p(ec, f) (((ec)->raised_flag & (f)) != 0)
261 #define rb_ec_raised_clear(ec) ((ec)->raised_flag = 0)
262 int rb_ec_set_raised(rb_execution_context_t *ec);
263 int rb_ec_reset_raised(rb_execution_context_t *ec);
264 int rb_ec_stack_check(rb_execution_context_t *ec);
265
266 VALUE rb_f_eval(int argc, const VALUE *argv, VALUE self);
267 VALUE rb_make_exception(int argc, const VALUE *argv);
268
269 NORETURN(void rb_method_name_error(VALUE, VALUE));
270
271 NORETURN(void rb_fiber_start(void));
272
273 NORETURN(void rb_print_undef(VALUE, ID, rb_method_visibility_t));
274 NORETURN(void rb_print_undef_str(VALUE, VALUE));
275 NORETURN(void rb_print_inaccessible(VALUE, ID, rb_method_visibility_t));
276 NORETURN(void rb_vm_localjump_error(const char *,VALUE, int));
277 NORETURN(void rb_vm_jump_tag_but_local_jump(int));
278
279 VALUE rb_vm_make_jump_tag_but_local_jump(int state, VALUE val);
280 rb_cref_t *rb_vm_cref(void);
281 rb_cref_t *rb_vm_cref_replace_with_duplicated_cref(void);
282 VALUE rb_vm_call_cfunc(VALUE recv, VALUE (*func)(VALUE), VALUE arg, VALUE block_handler, VALUE filename);
283 void rb_vm_set_progname(VALUE filename);
284 void rb_thread_terminate_all(void);
285 VALUE rb_vm_cbase(void);
286
287 /* vm_backtrace.c */
288 VALUE rb_ec_backtrace_object(const rb_execution_context_t *ec);
289 VALUE rb_ec_backtrace_str_ary(const rb_execution_context_t *ec, long lev, long n);
290 VALUE rb_ec_backtrace_location_ary(const rb_execution_context_t *ec, long lev, long n);
291
292 #ifndef CharNext /* defined as CharNext[AW] on Windows. */
293 # ifdef HAVE_MBLEN
294 # define CharNext(p) ((p) + mblen((p), RUBY_MBCHAR_MAXSIZE))
295 # else
296 # define CharNext(p) ((p) + 1)
297 # endif
298 #endif
299
300 #if defined DOSISH || defined __CYGWIN__
301 static inline void
302 translit_char(char *p, int from, int to)
303 {
304 while (*p) {
305 if ((unsigned char)*p == from)
306 *p = to;
307 p = CharNext(p);
308 }
309 }
310 #endif
311
312 #endif /* RUBY_EVAL_INTERN_H */
rb_f_eval
VALUE rb_f_eval(int argc, const VALUE *argv, VALUE self)
Definition: vm_eval.c:1668
ID
unsigned long ID
Definition: ruby.h:103
fd_set
#define fd_set
Definition: rb_mjit_min_header-2.7.0.h:1271
rb_vm_jump_tag_but_local_jump
void rb_vm_jump_tag_but_local_jump(int state)
Definition: vm.c:1510
rb_print_undef
void rb_print_undef(VALUE klass, ID id, rb_method_visibility_t visi)
Definition: eval_error.c:379
rb_method_name_error
void rb_method_name_error(VALUE klass, VALUE str)
Definition: proc.c:1778
VALUE
unsigned long VALUE
Definition: ruby.h:102
NORETURN
NORETURN(static inline void rb_ec_tag_jump(const rb_execution_context_t *ec, enum ruby_tag_type st))
rb_vm_cref_replace_with_duplicated_cref
rb_cref_t * rb_vm_cref_replace_with_duplicated_cref(void)
Definition: vm.c:1391
rb_execution_context_struct::tag
struct rb_vm_tag * tag
Definition: vm_core.h:849
rb_method_visibility_t
rb_method_visibility_t
Definition: method.h:26
rb_make_exception
VALUE rb_make_exception(int argc, const VALUE *argv)
Make an Exception object from the list of arguments in a manner similar to Kernel#raise.
Definition: eval.c:850
rb_ec_stack_check
int rb_ec_stack_check(rb_execution_context_t *ec)
Definition: gc.c:4665
rb_vm_cbase
VALUE rb_vm_cbase(void)
Definition: vm.c:1425
rb_vm_cref
rb_cref_t * rb_vm_cref(void)
Definition: vm.c:1384
ruby_longjmp
#define ruby_longjmp(env, val)
Definition: eval_intern.h:59
ruby.h
rb_fiber_start
void rb_fiber_start(void)
Definition: cont.c:1790
RAISED_NOMEMORY
@ RAISED_NOMEMORY
Definition: eval_intern.h:256
block_handler
rb_control_frame_t struct rb_calling_info const struct rb_call_info VALUE block_handler
Definition: rb_mjit_min_header-2.7.0.h:15146
rb_vm_tag::buf
rb_jmpbuf_t buf
Definition: vm_core.h:802
rb_execution_context_struct::cfp
rb_control_frame_t * cfp
Definition: vm_core.h:847
rb_vm_frame_block_handler
VALUE rb_vm_frame_block_handler(const rb_control_frame_t *cfp)
Definition: vm.c:115
rb_cref_struct::scope_visi
const rb_scope_visibility_t scope_visi
Definition: method.h:46
VM_FRAME_FLAG_PASSED
@ VM_FRAME_FLAG_PASSED
Definition: vm_core.h:1176
_longjmp
void _longjmp(jmp_buf, int) __attribute__((__noreturn__))
rb_vm_set_progname
void rb_vm_set_progname(VALUE filename)
Definition: vm.c:3289
rb_execution_context_struct::passed_block_handler
VALUE passed_block_handler
Definition: vm_core.h:876
rb_cref_struct
CREF (Class REFerence)
Definition: method.h:41
vm_core.h
rb_print_inaccessible
void rb_print_inaccessible(VALUE klass, ID id, rb_method_visibility_t visi)
Definition: eval_error.c:407
rb_ec_set_raised
int rb_ec_set_raised(rb_execution_context_t *ec)
Definition: thread.c:2344
RAISED_STACKOVERFLOW
@ RAISED_STACKOVERFLOW
Definition: eval_intern.h:255
rb_vm_tag::state
enum ruby_tag_type state
Definition: vm_core.h:804
RB_OBJ_WRITE
#define RB_OBJ_WRITE(a, slot, b)
Definition: ruby.h:1508
_setjmp
int _setjmp(jmp_buf)
crt_externs.h
rb_cref_struct::klass
VALUE klass
Definition: method.h:44
rb_vm_make_jump_tag_but_local_jump
VALUE rb_vm_make_jump_tag_but_local_jump(int state, VALUE val)
Definition: vm.c:1478
n
const char size_t n
Definition: rb_mjit_min_header-2.7.0.h:5456
arg
VALUE arg
Definition: rb_mjit_min_header-2.7.0.h:5601
argv
char ** argv
Definition: ruby.c:223
jmp_buf
long jmp_buf[32]
Definition: rb_mjit_min_header-2.7.0.h:9390
rb_vm_localjump_error
MJIT_FUNC_EXPORTED void rb_vm_localjump_error(const char *mesg, VALUE value, int reason)
Definition: vm.c:1471
CREF_FL_PUSHED_BY_EVAL
#define CREF_FL_PUSHED_BY_EVAL
Definition: eval_intern.h:190
strrchr
char * strrchr(const char *, const char)
timeval
Definition: missing.h:53
rb_print_undef_str
void rb_print_undef_str(VALUE klass, VALUE name)
Definition: eval_error.c:394
rb_ec_backtrace_str_ary
VALUE rb_ec_backtrace_str_ary(const rb_execution_context_t *ec, long lev, long n)
Definition: vm_backtrace.c:714
rb_cref_struct::refinements
VALUE refinements
Definition: method.h:43
TAG_NONE
#define TAG_NONE
Definition: vm_core.h:197
argc
int argc
Definition: ruby.c:222
st
enum ruby_tag_type st
Definition: rb_mjit_min_header-2.7.0.h:11111
rb_cref_struct::flags
VALUE flags
Definition: method.h:42
rb_vm_call_cfunc
VALUE rb_vm_call_cfunc(VALUE recv, VALUE(*func)(VALUE), VALUE arg, VALUE block_handler, VALUE filename)
Definition: vm.c:2212
rb_ec_backtrace_object
VALUE rb_ec_backtrace_object(const rb_execution_context_t *ec)
Definition: vm_backtrace.c:557
CharNext
#define CharNext(p)
Definition: eval_intern.h:296
CREF_FL_OMOD_SHARED
#define CREF_FL_OMOD_SHARED
Definition: eval_intern.h:191
rb_ec_backtrace_location_ary
VALUE rb_ec_backtrace_location_ary(const rb_execution_context_t *ec, long lev, long n)
Definition: vm_backtrace.c:720
rb_ec_reset_raised
int rb_ec_reset_raised(rb_execution_context_t *ec)
Definition: thread.c:2354
rb_scope_visi_struct
Definition: method.h:35
rb_control_frame_struct::ep
const VALUE * ep
Definition: vm_core.h:765
rb_thread_terminate_all
void rb_thread_terminate_all(void)
Definition: thread.c:559
ruby_tag_type
ruby_tag_type
Definition: vm_core.h:184
RAISED_EXCEPTION
@ RAISED_EXCEPTION
Definition: eval_intern.h:254
rb_cref_struct::next
struct rb_cref_struct * next
Definition: method.h:45
rb_execution_context_struct
Definition: vm_core.h:843