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
vm_passed_block_handler_set(rb_execution_context_t * ec,VALUE block_handler)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
pass_passed_block_handler(rb_execution_context_t * ec)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 #if defined(USE_UNALIGNED_MEMBER_ACCESS) && USE_UNALIGNED_MEMBER_ACCESS && \
161 defined(__clang__)
162 # define UNALIGNED_MEMBER_ACCESS(expr) __extension__({ \
163 COMPILER_WARNING_PUSH; \
164 COMPILER_WARNING_IGNORED(-Waddress-of-packed-member); \
165 typeof(expr) unaligned_member_access_result = (expr); \
166 COMPILER_WARNING_POP; \
167 unaligned_member_access_result; \
168 })
169 #else
170 # define UNALIGNED_MEMBER_ACCESS(expr) expr
171 #endif
172 #define UNALIGNED_MEMBER_PTR(ptr, mem) UNALIGNED_MEMBER_ACCESS(&(ptr)->mem)
173
174 #undef RB_OBJ_WRITE
175 #define RB_OBJ_WRITE(a, slot, b) UNALIGNED_MEMBER_ACCESS(rb_obj_write((VALUE)(a), (VALUE *)(slot), (VALUE)(b), __FILE__, __LINE__))
176
177 /* clear ec->tag->state, and return the value */
178 static inline int
rb_ec_tag_state(const rb_execution_context_t * ec)179 rb_ec_tag_state(const rb_execution_context_t *ec)
180 {
181 enum ruby_tag_type state = ec->tag->state;
182 ec->tag->state = TAG_NONE;
183 return state;
184 }
185
186 NORETURN(static inline void rb_ec_tag_jump(const rb_execution_context_t *ec, enum ruby_tag_type st));
187 static inline void
rb_ec_tag_jump(const rb_execution_context_t * ec,enum ruby_tag_type st)188 rb_ec_tag_jump(const rb_execution_context_t *ec, enum ruby_tag_type st)
189 {
190 ec->tag->state = st;
191 ruby_longjmp(ec->tag->buf, 1);
192 }
193
194 /*
195 setjmp() in assignment expression rhs is undefined behavior
196 [ISO/IEC 9899:1999] 7.13.1.1
197 */
198 #define EC_EXEC_TAG() \
199 (ruby_setjmp(_tag.buf) ? rb_ec_tag_state(VAR_FROM_MEMORY(_ec)) : (EC_REPUSH_TAG(), 0))
200
201 #define EC_JUMP_TAG(ec, st) rb_ec_tag_jump(ec, st)
202
203 #define INTERNAL_EXCEPTION_P(exc) FIXNUM_P(exc)
204
205 /* CREF operators */
206
207 #define CREF_FL_PUSHED_BY_EVAL IMEMO_FL_USER1
208 #define CREF_FL_OMOD_SHARED IMEMO_FL_USER2
209
210 static inline VALUE
CREF_CLASS(const rb_cref_t * cref)211 CREF_CLASS(const rb_cref_t *cref)
212 {
213 return cref->klass;
214 }
215
216 static inline rb_cref_t *
CREF_NEXT(const rb_cref_t * cref)217 CREF_NEXT(const rb_cref_t *cref)
218 {
219 return cref->next;
220 }
221
222 static inline const rb_scope_visibility_t *
CREF_SCOPE_VISI(const rb_cref_t * cref)223 CREF_SCOPE_VISI(const rb_cref_t *cref)
224 {
225 return &cref->scope_visi;
226 }
227
228 static inline VALUE
CREF_REFINEMENTS(const rb_cref_t * cref)229 CREF_REFINEMENTS(const rb_cref_t *cref)
230 {
231 return cref->refinements;
232 }
233
234 static inline void
CREF_REFINEMENTS_SET(rb_cref_t * cref,VALUE refs)235 CREF_REFINEMENTS_SET(rb_cref_t *cref, VALUE refs)
236 {
237 RB_OBJ_WRITE(cref, &cref->refinements, refs);
238 }
239
240 static inline int
CREF_PUSHED_BY_EVAL(const rb_cref_t * cref)241 CREF_PUSHED_BY_EVAL(const rb_cref_t *cref)
242 {
243 return cref->flags & CREF_FL_PUSHED_BY_EVAL;
244 }
245
246 static inline void
CREF_PUSHED_BY_EVAL_SET(rb_cref_t * cref)247 CREF_PUSHED_BY_EVAL_SET(rb_cref_t *cref)
248 {
249 cref->flags |= CREF_FL_PUSHED_BY_EVAL;
250 }
251
252 static inline int
CREF_OMOD_SHARED(const rb_cref_t * cref)253 CREF_OMOD_SHARED(const rb_cref_t *cref)
254 {
255 return cref->flags & CREF_FL_OMOD_SHARED;
256 }
257
258 static inline void
CREF_OMOD_SHARED_SET(rb_cref_t * cref)259 CREF_OMOD_SHARED_SET(rb_cref_t *cref)
260 {
261 cref->flags |= CREF_FL_OMOD_SHARED;
262 }
263
264 static inline void
CREF_OMOD_SHARED_UNSET(rb_cref_t * cref)265 CREF_OMOD_SHARED_UNSET(rb_cref_t *cref)
266 {
267 cref->flags &= ~CREF_FL_OMOD_SHARED;
268 }
269
270 void rb_thread_cleanup(void);
271 void rb_thread_wait_other_threads(void);
272
273 enum {
274 RAISED_EXCEPTION = 1,
275 RAISED_STACKOVERFLOW = 2,
276 RAISED_NOMEMORY = 4
277 };
278 #define rb_ec_raised_set(ec, f) ((ec)->raised_flag |= (f))
279 #define rb_ec_raised_reset(ec, f) ((ec)->raised_flag &= ~(f))
280 #define rb_ec_raised_p(ec, f) (((ec)->raised_flag & (f)) != 0)
281 #define rb_ec_raised_clear(ec) ((ec)->raised_flag = 0)
282 int rb_ec_set_raised(rb_execution_context_t *ec);
283 int rb_ec_reset_raised(rb_execution_context_t *ec);
284 int rb_ec_stack_check(rb_execution_context_t *ec);
285
286 VALUE rb_f_eval(int argc, const VALUE *argv, VALUE self);
287 VALUE rb_make_exception(int argc, const VALUE *argv);
288
289 NORETURN(void rb_method_name_error(VALUE, VALUE));
290
291 NORETURN(void rb_fiber_start(void));
292
293 NORETURN(void rb_print_undef(VALUE, ID, rb_method_visibility_t));
294 NORETURN(void rb_print_undef_str(VALUE, VALUE));
295 NORETURN(void rb_print_inaccessible(VALUE, ID, rb_method_visibility_t));
296 NORETURN(void rb_vm_localjump_error(const char *,VALUE, int));
297 #if 0
298 NORETURN(void rb_vm_jump_tag_but_local_jump(int));
299 #endif
300
301 VALUE rb_vm_make_jump_tag_but_local_jump(int state, VALUE val);
302 rb_cref_t *rb_vm_cref(void);
303 rb_cref_t *rb_vm_cref_replace_with_duplicated_cref(void);
304 VALUE rb_vm_call_cfunc(VALUE recv, VALUE (*func)(VALUE), VALUE arg, VALUE block_handler, VALUE filename);
305 void rb_vm_set_progname(VALUE filename);
306 void rb_thread_terminate_all(void);
307 VALUE rb_vm_cbase(void);
308
309 /* vm_backtrace.c */
310 VALUE rb_ec_backtrace_object(const rb_execution_context_t *ec);
311 VALUE rb_ec_backtrace_str_ary(const rb_execution_context_t *ec, long lev, long n);
312
313 #ifndef CharNext /* defined as CharNext[AW] on Windows. */
314 # ifdef HAVE_MBLEN
315 # define CharNext(p) ((p) + mblen((p), RUBY_MBCHAR_MAXSIZE))
316 # else
317 # define CharNext(p) ((p) + 1)
318 # endif
319 #endif
320
321 #if defined DOSISH || defined __CYGWIN__
322 static inline void
translit_char(char * p,int from,int to)323 translit_char(char *p, int from, int to)
324 {
325 while (*p) {
326 if ((unsigned char)*p == from)
327 *p = to;
328 p = CharNext(p);
329 }
330 }
331 #endif
332
333 #endif /* RUBY_EVAL_INTERN_H */
334