Ruby 4.1.0dev (2026-04-17 revision 11e3c78b61da705c783dd12fb7f158c0d256ede0)
eval_intern.h (11e3c78b61da705c783dd12fb7f158c0d256ede0)
1#ifndef RUBY_EVAL_INTERN_H
2#define RUBY_EVAL_INTERN_H
3
4#include "ruby/ruby.h"
5#include "vm_core.h"
6
7static inline void
8vm_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
14static inline void
15pass_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#if defined(__wasm__) && !defined(__EMSCRIPTEN__)
37# include "wasm/setjmp.h"
38#else
39# include <setjmp.h>
40#endif
41
42#ifdef __APPLE__
43# ifdef HAVE_CRT_EXTERNS_H
44# include <crt_externs.h>
45# else
46# include "missing/crt_externs.h"
47# endif
48#endif
49
50#ifndef HAVE_STRING_H
51char *strrchr(const char *, const char);
52#endif
53
54#ifdef HAVE_UNISTD_H
55#include <unistd.h>
56#endif
57
58#ifdef HAVE_NET_SOCKET_H
59#include <net/socket.h>
60#endif
61
62#define ruby_setjmp(env) RUBY_SETJMP(env)
63#define ruby_longjmp(env,val) RUBY_LONGJMP((env),(val))
64#ifdef __CYGWIN__
65# ifndef _setjmp
66int _setjmp(jmp_buf);
67# endif
68# ifndef _longjmp
69NORETURN(void _longjmp(jmp_buf, int));
70# endif
71#endif
72
73#include <sys/types.h>
74#include <signal.h>
75#include <errno.h>
76
77#ifdef HAVE_SYS_SELECT_H
78#include <sys/select.h>
79#endif
80
81/*
82 Solaris sys/select.h switches select to select_large_fdset to support larger
83 file descriptors if FD_SETSIZE is larger than 1024 on 32bit environment.
84 But Ruby doesn't change FD_SETSIZE because fd_set is allocated dynamically.
85 So following definition is required to use select_large_fdset.
86*/
87#ifdef HAVE_SELECT_LARGE_FDSET
88#define select(n, r, w, e, t) select_large_fdset((n), (r), (w), (e), (t))
89extern int select_large_fdset(int, fd_set *, fd_set *, fd_set *, struct timeval *);
90#endif
91
92#ifdef HAVE_SYS_PARAM_H
93#include <sys/param.h>
94#endif
95
96#include <sys/stat.h>
97
98#define EC_PUSH_TAG(ec) do { \
99 rb_execution_context_t * const _ec = (ec); \
100 struct rb_vm_tag _tag; \
101 _tag.state = TAG_NONE; \
102 _tag.tag = Qundef; \
103 _tag.prev = _ec->tag; \
104 _tag.lock_rec = rb_ec_vm_lock_rec(_ec); \
105 rb_vm_tag_jmpbuf_init(&_tag.buf); \
106
107#define EC_POP_TAG() \
108 _ec->tag = _tag.prev; \
109 rb_vm_tag_jmpbuf_deinit(&_tag.buf); \
110} while (0)
111
112#define EC_TMPPOP_TAG() \
113 _ec->tag = _tag.prev
114
115#define EC_REPUSH_TAG() (void)(_ec->tag = &_tag)
116
117#if defined __GNUC__ && __GNUC__ == 4 && (__GNUC_MINOR__ >= 6 && __GNUC_MINOR__ <= 8) || defined __clang__
118/* This macro prevents GCC 4.6--4.8 from emitting maybe-uninitialized warnings.
119 * This macro also prevents Clang from dumping core in EC_EXEC_TAG().
120 * (I confirmed Clang 4.0.1 and 5.0.0.)
121 */
122# define VAR_FROM_MEMORY(var) __extension__(*(__typeof__(var) volatile *)&(var))
123# define VAR_INITIALIZED(var) ((var) = VAR_FROM_MEMORY(var))
124# define VAR_NOCLOBBERED(var) volatile var
125#else
126# define VAR_FROM_MEMORY(var) (var)
127# define VAR_INITIALIZED(var) ((void)&(var))
128# define VAR_NOCLOBBERED(var) var
129#endif
130
131static inline void
132rb_ec_vm_lock_rec_check(const rb_execution_context_t *ec, unsigned int recorded_lock_rec)
133{
134 unsigned int current_lock_rec = rb_ec_vm_lock_rec(ec);
135 if (current_lock_rec != recorded_lock_rec) {
136 rb_ec_vm_lock_rec_release(ec, recorded_lock_rec, current_lock_rec);
137 }
138}
139
140/* clear ec->tag->state, and return the value */
141static inline int
142rb_ec_tag_state(const rb_execution_context_t *ec)
143{
144 struct rb_vm_tag *tag = ec->tag;
145 enum ruby_tag_type state = tag->state;
146 tag->state = TAG_NONE;
147 rb_ec_vm_lock_rec_check(ec, tag->lock_rec);
148 RBIMPL_ASSUME(state > TAG_NONE);
149 RBIMPL_ASSUME(state <= TAG_FATAL);
150 return state;
151}
152
153NORETURN(static inline void rb_ec_tag_jump(const rb_execution_context_t *ec, enum ruby_tag_type st));
154static inline void
155rb_ec_tag_jump(const rb_execution_context_t *ec, enum ruby_tag_type st)
156{
157 RUBY_ASSERT(st > TAG_NONE && st <= TAG_FATAL, ": Invalid tag jump: %d", (int)st);
158 ec->tag->state = st;
159 ruby_longjmp(RB_VM_TAG_JMPBUF_GET(ec->tag->buf), 1);
160}
161
162/*
163 setjmp() in assignment expression rhs is undefined behavior
164 [ISO/IEC 9899:1999] 7.13.1.1
165*/
166#define EC_EXEC_TAG() \
167 (UNLIKELY(ruby_setjmp(RB_VM_TAG_JMPBUF_GET(_tag.buf))) ? rb_ec_tag_state(VAR_FROM_MEMORY(_ec)) : (EC_REPUSH_TAG(), 0))
168
169#define EC_JUMP_TAG(ec, st) rb_ec_tag_jump(ec, st)
170
171#define INTERNAL_EXCEPTION_P(exc) FIXNUM_P(exc)
172
173/* CREF operators */
174
175#define CREF_FL_PUSHED_BY_EVAL IMEMO_FL_USER1
176#define CREF_FL_OMOD_SHARED IMEMO_FL_USER2
177#define CREF_FL_SINGLETON IMEMO_FL_USER3
178#define CREF_FL_DYNAMIC_CREF IMEMO_FL_USER4
179
180static inline int CREF_SINGLETON(const rb_cref_t *cref);
181
182static inline VALUE
183CREF_CLASS(const rb_cref_t *cref)
184{
185 if (CREF_SINGLETON(cref)) {
186 return CLASS_OF(cref->klass_or_self);
187 }
188 else {
189 return cref->klass_or_self;
190 }
191}
192
193static inline VALUE
194CREF_CLASS_FOR_DEFINITION(const rb_cref_t *cref)
195{
196 if (CREF_SINGLETON(cref)) {
197 return rb_singleton_class(cref->klass_or_self);
198 }
199 else {
200 return cref->klass_or_self;
201 }
202}
203
204static inline rb_cref_t *
205CREF_NEXT(const rb_cref_t *cref)
206{
207 return cref->next;
208}
209
210static inline const rb_scope_visibility_t *
211CREF_SCOPE_VISI(const rb_cref_t *cref)
212{
213 return &cref->scope_visi;
214}
215
216static inline VALUE
217CREF_REFINEMENTS(const rb_cref_t *cref)
218{
219 return cref->refinements;
220}
221
222static inline void
223CREF_REFINEMENTS_SET(rb_cref_t *cref, VALUE refs)
224{
225 RB_OBJ_WRITE(cref, &cref->refinements, refs);
226}
227
228static inline int
229CREF_PUSHED_BY_EVAL(const rb_cref_t *cref)
230{
231 return cref->flags & CREF_FL_PUSHED_BY_EVAL;
232}
233
234static inline void
235CREF_PUSHED_BY_EVAL_SET(rb_cref_t *cref)
236{
237 cref->flags |= CREF_FL_PUSHED_BY_EVAL;
238}
239
240static inline int
241CREF_SINGLETON(const rb_cref_t *cref)
242{
243 return cref->flags & CREF_FL_SINGLETON;
244}
245
246static inline void
247CREF_SINGLETON_SET(rb_cref_t *cref)
248{
249 cref->flags |= CREF_FL_SINGLETON;
250}
251
252static inline int
253CREF_OMOD_SHARED(const rb_cref_t *cref)
254{
255 return cref->flags & CREF_FL_OMOD_SHARED;
256}
257
258static inline void
259CREF_OMOD_SHARED_SET(rb_cref_t *cref)
260{
261 cref->flags |= CREF_FL_OMOD_SHARED;
262}
263
264static inline int
265CREF_DYNAMIC(const rb_cref_t *cref)
266{
267 return cref->flags & CREF_FL_DYNAMIC_CREF;
268}
269
270static inline void
271CREF_DYNAMIC_SET(rb_cref_t *cref)
272{
273 cref->flags |= CREF_FL_DYNAMIC_CREF;
274}
275
276static inline void
277CREF_OMOD_SHARED_UNSET(rb_cref_t *cref)
278{
279 cref->flags &= ~CREF_FL_OMOD_SHARED;
280}
281
282enum {
283 RAISED_EXCEPTION = 1,
284 RAISED_STACKOVERFLOW = 2,
285 RAISED_NOMEMORY = 4
286};
287#define rb_ec_raised_set(ec, f) ((ec)->raised_flag |= (f))
288#define rb_ec_raised_reset(ec, f) ((ec)->raised_flag &= ~(f))
289#define rb_ec_raised_p(ec, f) (((ec)->raised_flag & (f)) != 0)
290#define rb_ec_raised_clear(ec) ((ec)->raised_flag = 0)
291int rb_ec_set_raised(rb_execution_context_t *ec);
292int rb_ec_reset_raised(rb_execution_context_t *ec);
293int rb_ec_stack_check(rb_execution_context_t *ec);
294
295VALUE rb_f_eval(int argc, const VALUE *argv, VALUE self);
296VALUE rb_make_exception(int argc, const VALUE *argv);
297
298NORETURN(void rb_method_name_error(VALUE, VALUE));
299
300NORETURN(void rb_fiber_start(rb_fiber_t*));
301
302NORETURN(void rb_print_undef(VALUE, ID, rb_method_visibility_t));
303NORETURN(void rb_print_undef_str(VALUE, VALUE));
304NORETURN(void rb_print_inaccessible(VALUE, ID, rb_method_visibility_t));
305NORETURN(void rb_vm_localjump_error(const char *,VALUE, int));
306NORETURN(void rb_vm_jump_tag_but_local_jump(enum ruby_tag_type));
307
308VALUE rb_vm_make_jump_tag_but_local_jump(enum ruby_tag_type state, VALUE val);
309rb_cref_t *rb_vm_cref(void);
310rb_cref_t *rb_vm_cref_replace_with_duplicated_cref(void);
311VALUE rb_vm_call_cfunc(VALUE recv, VALUE (*func)(VALUE), VALUE arg, VALUE block_handler, VALUE filename);
312VALUE rb_vm_call_cfunc_in_box(VALUE recv, VALUE (*func)(VALUE, VALUE), VALUE arg1, VALUE arg2, VALUE filename, const rb_box_t *box);
313void rb_vm_frame_flag_set_box_require(const rb_execution_context_t *ec);
314const rb_box_t *rb_vm_current_box(const rb_execution_context_t *ec);
315const rb_box_t *rb_vm_caller_box(const rb_execution_context_t *ec);
316const rb_box_t *rb_vm_loading_box(const rb_execution_context_t *ec);
317void rb_vm_set_progname(VALUE filename);
318VALUE rb_vm_cbase(void);
319
320/* vm_backtrace.c */
321#define RUBY_BACKTRACE_START 0
322#define RUBY_ALL_BACKTRACE_LINES -1
323VALUE rb_ec_backtrace_object(const rb_execution_context_t *ec);
324VALUE rb_ec_backtrace_str_ary(const rb_execution_context_t *ec, long lev, long n);
325VALUE rb_ec_backtrace_location_ary(const rb_execution_context_t *ec, long lev, long n, bool skip_internal);
326
327#ifndef CharNext /* defined as CharNext[AW] on Windows. */
328# ifdef HAVE_MBLEN
329# define CharNext(p) rb_char_next(p)
330static inline char *
331rb_char_next(const char *p)
332{
333 if (p) {
334 int len = mblen(p, RUBY_MBCHAR_MAXSIZE);
335 p += len > 0 ? len : 1;
336 }
337 return (char *)p;
338}
339# else
340# define CharNext(p) ((p) + 1)
341# endif
342#endif
343
344#endif /* RUBY_EVAL_INTERN_H */
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
Definition assert.h:219
VALUE rb_singleton_class(VALUE obj)
Finds or creates the singleton class of the passed object.
Definition class.c:2850
#define CLASS_OF
Old name of rb_class_of.
Definition globals.h:205
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
Definition gc.h:603
int len
Length of the buffer.
Definition io.h:8
#define RBIMPL_ASSUME(_)
Wraps (or simulates) __builtin_unreachable.
Definition assume.h:76
Internal header for Ruby Box.
Definition box.h:14
CREF (Class REFerence)
Definition method.h:45
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40