13 #define SAVEt_NSTAB 12
14 #define SAVEt_SVREF 13
16 #define SAVEt_FREESV 15
17 #define SAVEt_FREEOP 16
18 #define SAVEt_FREEPV 17
19 #define SAVEt_CLEARSV 18
20 #define SAVEt_DELETE 19
21 #define SAVEt_DESTRUCTOR 20
22 #define SAVEt_REGCONTEXT 21
23 #define SAVEt_STACK_POS 22
25 #define SAVEt_AELEM 24
26 #define SAVEt_HELEM 25
28 #define SAVEt_HINTS 27
29 #define SAVEt_ALLOC 28
30 #define SAVEt_GENERIC_SVREF 29
32 #define SSCHECK(need) if (PL_savestack_ix + need > PL_savestack_max) savestack_grow()
33 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
34 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
35 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
36 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
37 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
38 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
39 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
40 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
41 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
42 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
44 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
45 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
51 DEBUG_l(WITH_THR(deb("ENTER scope %ld at %s:%d\n", \
52 PL_scopestack_ix, __FILE__, __LINE__))); \
56 DEBUG_l(WITH_THR(deb("LEAVE scope %ld at %s:%d\n", \
57 PL_scopestack_ix, __FILE__, __LINE__))); \
61 #define ENTER push_scope()
62 #define LEAVE pop_scope()
64 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
67 * Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV
68 * because these are used for several kinds of pointer values
70 #define SAVEI16(i) save_I16(SOFT_CAST(I16*)&(i))
71 #define SAVEI32(i) save_I32(SOFT_CAST(I32*)&(i))
72 #define SAVEINT(i) save_int(SOFT_CAST(int*)&(i))
73 #define SAVEIV(i) save_iv(SOFT_CAST(IV*)&(i))
74 #define SAVELONG(l) save_long(SOFT_CAST(long*)&(l))
75 #define SAVESPTR(s) save_sptr((SV**)&(s))
76 #define SAVEPPTR(s) save_pptr(SOFT_CAST(char**)&(s))
77 #define SAVEFREESV(s) save_freesv((SV*)(s))
78 #define SAVEFREEOP(o) save_freeop(SOFT_CAST(OP*)(o))
79 #define SAVEFREEPV(p) save_freepv(SOFT_CAST(char*)(p))
80 #define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv))
81 #define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
82 #define SAVEDELETE(h,k,l) \
83 save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
85 #define CALLDESTRUCTOR this->*SSPOPDPTR
86 #define SAVEDESTRUCTOR(f,p) \
87 save_destructor((DESTRUCTORFUNC)(FUNC_NAME_TO_PTR(f)), \
90 #define CALLDESTRUCTOR *SSPOPDPTR
91 #define SAVEDESTRUCTOR(f,p) \
92 save_destructor(SOFT_CAST(void(*)_((void*)))(FUNC_NAME_TO_PTR(f)), \
96 #define SAVESTACK_POS() \
99 SSPUSHINT(PL_stack_sp - PL_stack_base); \
100 SSPUSHINT(SAVEt_STACK_POS); \
103 #define SAVEOP() save_op()
105 #define SAVEHINTS() \
107 if (PL_hints & HINT_LOCALIZE_HH) \
111 SSPUSHINT(PL_hints); \
112 SSPUSHINT(SAVEt_HINTS); \
116 /* SSNEW() temporarily allocates a specified number of bytes of data on the
117 * savestack. It returns an integer index into the savestack, because a
118 * pointer would get broken if the savestack is moved on reallocation.
119 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
120 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
121 * alignment will be preserved therough savestack reallocation *only* if
122 * realloc returns data aligned to a size divisible by `align'!
124 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
127 #define SSNEW(size) save_alloc(size, 0)
128 #define SSNEWa(size,align) save_alloc(size, \
129 (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
131 #define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
133 /* A jmpenv packages the state required to perform a proper non-local jump.
134 * Note that there is a start_env initialized when perl starts, and top_env
135 * points to this initially, so top_env should always be non-null.
137 * Existence of a non-null top_env->je_prev implies it is valid to call
138 * longjmp() at that runlevel (we make sure start_env.je_prev is always
139 * null to ensure this).
141 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
142 * establish a local jmpenv to handle exception traps. Care must be taken
143 * to restore the previous value of je_mustcatch before exiting the
144 * stack frame iff JMPENV_PUSH was not called in that stack frame.
149 struct jmpenv * je_prev;
150 Sigjmp_buf je_buf; /* only for use if !je_throw */
151 int je_ret; /* last exception thrown */
152 bool je_mustcatch; /* need to call longjmp()? */
153 void (*je_throw)(int v); /* last for bincompat */
156 typedef struct jmpenv JMPENV;
159 * Function that catches/throws, and its callback for the
160 * body of protected processing.
162 typedef void *(CPERLscope(*protect_body_t)) _((va_list));
163 typedef void *(CPERLscope(*protect_proc_t)) _((int *, protect_body_t, ...));
166 * How to build the first jmpenv.
168 * top_env needs to be non-zero. It points to an area
169 * in which longjmp() stuff is stored, as C callstack
170 * info there at least is thread specific this has to
171 * be per-thread. Otherwise a 'die' in a thread gives
172 * that thread the C stack of last thread to do an eval {}!
175 #define JMPENV_BOOTSTRAP \
177 PL_start_env.je_prev = NULL; \
178 PL_start_env.je_throw = NULL; \
179 PL_start_env.je_ret = -1; \
180 PL_start_env.je_mustcatch = TRUE; \
181 PL_top_env = &PL_start_env; \
184 #ifdef OP_IN_REGISTER
185 #define OP_REG_TO_MEM PL_opsave = op
186 #define OP_MEM_TO_REG op = PL_opsave
188 #define OP_REG_TO_MEM NOOP
189 #define OP_MEM_TO_REG NOOP
193 * These exception-handling macros are split up to
194 * ease integration with C++ exceptions.
196 * To use C++ try+catch to catch Perl exceptions, an extension author
197 * needs to first write an extern "C" function to throw an appropriate
198 * exception object; typically it will be or contain an integer,
199 * because Perl's internals use integers to track exception types:
200 * extern "C" { static void thrower(int i) { throw i; } }
202 * Then (as shown below) the author needs to use, not the simple
203 * JMPENV_PUSH, but several of its constitutent macros, to arrange for
204 * the Perl internals to call thrower() rather than longjmp() to
208 * JMPENV_PUSH_INIT(thrower);
210 * ... stuff that may throw exceptions ...
212 * catch (int why) { // or whatever matches thrower()
216 * ... // handle various Perl exception codes
219 * JMPENV_POP; // don't forget this!
222 #define dJMPENV JMPENV cur_env
224 #define JMPENV_PUSH_INIT_ENV(cur_env,THROWFUNC) \
226 cur_env.je_throw = (THROWFUNC); \
227 cur_env.je_ret = -1; \
228 cur_env.je_mustcatch = FALSE; \
229 cur_env.je_prev = PL_top_env; \
230 PL_top_env = &cur_env; \
234 #define JMPENV_PUSH_INIT(THROWFUNC) JMPENV_PUSH_INIT_ENV(cur_env,THROWFUNC)
236 #define JMPENV_POST_CATCH_ENV(cur_env) \
239 PL_top_env = &cur_env; \
242 #define JMPENV_POST_CATCH JMPENV_POST_CATCH_ENV(cur_env)
245 #define JMPENV_PUSH_ENV(cur_env,v) \
247 JMPENV_PUSH_INIT_ENV(cur_env,NULL); \
248 EXCEPT_SET_ENV(cur_env,PerlProc_setjmp(cur_env.je_buf, 1)); \
249 JMPENV_POST_CATCH_ENV(cur_env); \
250 (v) = EXCEPT_GET_ENV(cur_env); \
253 #define JMPENV_PUSH(v) JMPENV_PUSH_ENV(cur_env,v)
255 #define JMPENV_POP_ENV(cur_env) \
256 STMT_START { PL_top_env = cur_env.je_prev; } STMT_END
258 #define JMPENV_POP JMPENV_POP_ENV(cur_env)
260 #define JMPENV_JUMP(v) \
263 if (PL_top_env->je_prev) { \
264 if (PL_top_env->je_throw) \
265 PL_top_env->je_throw(v); \
267 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
270 PerlProc_exit(STATUS_NATIVE_EXPORT); \
271 PerlIO_printf(PerlIO_stderr(), "panic: top_env\n"); \
275 #define EXCEPT_GET_ENV(cur_env) (cur_env.je_ret)
276 #define EXCEPT_GET EXCEPT_GET_ENV(cur_env)
277 #define EXCEPT_SET_ENV(cur_env,v) (cur_env.je_ret = (v))
278 #define EXCEPT_SET(v) EXCEPT_SET_ENV(cur_env,v)
280 #define CATCH_GET (PL_top_env->je_mustcatch)
281 #define CATCH_SET(v) (PL_top_env->je_mustcatch = (v))