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
31 #define SAVEt_DESTRUCTOR_X 30
35 #define SSCHECK(need) if (PL_savestack_ix + need > PL_savestack_max) savestack_grow()
36 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
37 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
38 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
39 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
40 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
41 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
42 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
43 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
44 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
45 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
46 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
47 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
50 =for apidoc Ams||SAVETMPS
51 Opening bracket for temporaries on a callback. See C<FREETMPS> and
54 =for apidoc Ams||FREETMPS
55 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
58 =for apidoc Ams||ENTER
59 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
61 =for apidoc Ams||LEAVE
62 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
67 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
68 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
74 DEBUG_l(WITH_THR(Perl_deb(aTHX_ "ENTER scope %ld at %s:%d\n", \
75 PL_scopestack_ix, __FILE__, __LINE__))); \
79 DEBUG_l(WITH_THR(Perl_deb(aTHX_ "LEAVE scope %ld at %s:%d\n", \
80 PL_scopestack_ix, __FILE__, __LINE__))); \
84 #define ENTER push_scope()
85 #define LEAVE pop_scope()
87 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
90 * Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV
91 * because these are used for several kinds of pointer values
93 #define SAVEI8(i) save_I8(SOFT_CAST(I8*)&(i))
94 #define SAVEI16(i) save_I16(SOFT_CAST(I16*)&(i))
95 #define SAVEI32(i) save_I32(SOFT_CAST(I32*)&(i))
96 #define SAVEINT(i) save_int(SOFT_CAST(int*)&(i))
97 #define SAVEIV(i) save_iv(SOFT_CAST(IV*)&(i))
98 #define SAVELONG(l) save_long(SOFT_CAST(long*)&(l))
99 #define SAVESPTR(s) save_sptr((SV**)&(s))
100 #define SAVEPPTR(s) save_pptr(SOFT_CAST(char**)&(s))
101 #define SAVEVPTR(s) save_vptr((void*)&(s))
102 #define SAVEFREESV(s) save_freesv((SV*)(s))
103 #define SAVEFREEOP(o) save_freeop(SOFT_CAST(OP*)(o))
104 #define SAVEFREEPV(p) save_freepv(SOFT_CAST(char*)(p))
105 #define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv))
106 #define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
107 #define SAVEDELETE(h,k,l) \
108 save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
109 #define SAVEDESTRUCTOR(f,p) \
110 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), SOFT_CAST(void*)(p))
112 #define SAVEDESTRUCTOR_X(f,p) \
113 save_destructor_x((DESTRUCTORFUNC_t)(f), SOFT_CAST(void*)(p))
115 #define SAVESTACK_POS() \
118 SSPUSHINT(PL_stack_sp - PL_stack_base); \
119 SSPUSHINT(SAVEt_STACK_POS); \
122 #define SAVEOP() save_op()
124 #define SAVEHINTS() \
126 if (PL_hints & HINT_LOCALIZE_HH) \
130 SSPUSHINT(PL_hints); \
131 SSPUSHINT(SAVEt_HINTS); \
136 # define SAVECOPSTASH(cop) SAVEPPTR(CopSTASHPV(cop))
137 # define SAVECOPFILE(cop) SAVEPPTR(CopFILE(cop))
139 # define SAVECOPSTASH(cop) SAVESPTR(CopSTASH(cop))
140 # define SAVECOPFILE(cop) SAVESPTR(CopFILEGV(cop))
143 #define SAVECOPLINE(cop) SAVEI16(CopLINE(cop))
145 /* SSNEW() temporarily allocates a specified number of bytes of data on the
146 * savestack. It returns an integer index into the savestack, because a
147 * pointer would get broken if the savestack is moved on reallocation.
148 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
149 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
150 * alignment will be preserved therough savestack reallocation *only* if
151 * realloc returns data aligned to a size divisible by `align'!
153 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
156 #define SSNEW(size) save_alloc(size, 0)
157 #define SSNEWa(size,align) save_alloc(size, \
158 (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
160 #define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
162 /* A jmpenv packages the state required to perform a proper non-local jump.
163 * Note that there is a start_env initialized when perl starts, and top_env
164 * points to this initially, so top_env should always be non-null.
166 * Existence of a non-null top_env->je_prev implies it is valid to call
167 * longjmp() at that runlevel (we make sure start_env.je_prev is always
168 * null to ensure this).
170 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
171 * establish a local jmpenv to handle exception traps. Care must be taken
172 * to restore the previous value of je_mustcatch before exiting the
173 * stack frame iff JMPENV_PUSH was not called in that stack frame.
178 struct jmpenv * je_prev;
179 Sigjmp_buf je_buf; /* only for use if !je_throw */
180 int je_ret; /* last exception thrown */
181 bool je_mustcatch; /* need to call longjmp()? */
182 void (*je_throw)(int v); /* last for bincompat */
183 bool je_noset; /* no need for setjmp() */
186 typedef struct jmpenv JMPENV;
189 * Function that catches/throws, and its callback for the
190 * body of protected processing.
192 typedef void *(CPERLscope(*protect_body_t)) (pTHX_ va_list);
193 typedef void *(CPERLscope(*protect_proc_t)) (pTHX_ volatile JMPENV *pcur_env,
194 int *, protect_body_t, ...);
197 * How to build the first jmpenv.
199 * top_env needs to be non-zero. It points to an area
200 * in which longjmp() stuff is stored, as C callstack
201 * info there at least is thread specific this has to
202 * be per-thread. Otherwise a 'die' in a thread gives
203 * that thread the C stack of last thread to do an eval {}!
206 #define JMPENV_BOOTSTRAP \
208 PL_start_env.je_prev = NULL; \
209 PL_start_env.je_throw = NULL; \
210 PL_start_env.je_ret = -1; \
211 PL_start_env.je_mustcatch = TRUE; \
212 PL_start_env.je_noset = 0; \
213 PL_top_env = &PL_start_env; \
216 #ifdef OP_IN_REGISTER
217 #define OP_REG_TO_MEM PL_opsave = op
218 #define OP_MEM_TO_REG op = PL_opsave
220 #define OP_REG_TO_MEM NOOP
221 #define OP_MEM_TO_REG NOOP
225 * These exception-handling macros are split up to
226 * ease integration with C++ exceptions.
228 * To use C++ try+catch to catch Perl exceptions, an extension author
229 * needs to first write an extern "C" function to throw an appropriate
230 * exception object; typically it will be or contain an integer,
231 * because Perl's internals use integers to track exception types:
232 * extern "C" { static void thrower(int i) { throw i; } }
234 * Then (as shown below) the author needs to use, not the simple
235 * JMPENV_PUSH, but several of its constitutent macros, to arrange for
236 * the Perl internals to call thrower() rather than longjmp() to
240 * JMPENV_PUSH_INIT(thrower);
242 * ... stuff that may throw exceptions ...
244 * catch (int why) { // or whatever matches thrower()
248 * ... // handle various Perl exception codes
251 * JMPENV_POP; // don't forget this!
254 #define dJMPENV JMPENV cur_env; \
255 volatile JMPENV *pcur_env = ((cur_env.je_noset = 0),&cur_env)
257 #define JMPENV_PUSH_INIT_ENV(ce,THROWFUNC) \
259 (ce).je_throw = (THROWFUNC); \
261 (ce).je_mustcatch = FALSE; \
262 (ce).je_prev = PL_top_env; \
263 PL_top_env = &(ce); \
267 #define JMPENV_PUSH_INIT(THROWFUNC) JMPENV_PUSH_INIT_ENV(*(JMPENV*)pcur_env,THROWFUNC)
269 #define JMPENV_POST_CATCH_ENV(ce) \
272 PL_top_env = &(ce); \
275 #define JMPENV_POST_CATCH JMPENV_POST_CATCH_ENV(*(JMPENV*)pcur_env)
278 #define JMPENV_PUSH_ENV(ce,v) \
280 if (!(ce).je_noset) { \
281 JMPENV_PUSH_INIT_ENV(ce,NULL); \
282 EXCEPT_SET_ENV(ce,PerlProc_setjmp((ce).je_buf, 1));\
286 EXCEPT_SET_ENV(ce,0); \
287 JMPENV_POST_CATCH_ENV(ce); \
288 (v) = EXCEPT_GET_ENV(ce); \
291 #define JMPENV_PUSH(v) JMPENV_PUSH_ENV(*(JMPENV*)pcur_env,v)
293 #define JMPENV_POP_ENV(ce) \
294 STMT_START { PL_top_env = (ce).je_prev; } STMT_END
296 #define JMPENV_POP JMPENV_POP_ENV(*(JMPENV*)pcur_env)
298 #define JMPENV_JUMP(v) \
301 if (PL_top_env->je_prev) { \
302 if (PL_top_env->je_throw) \
303 PL_top_env->je_throw(v); \
305 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
308 PerlProc_exit(STATUS_NATIVE_EXPORT); \
309 PerlIO_printf(Perl_error_log, "panic: top_env\n"); \
313 #define EXCEPT_GET_ENV(ce) ((ce).je_ret)
314 #define EXCEPT_GET EXCEPT_GET_ENV(*(JMPENV*)pcur_env)
315 #define EXCEPT_SET_ENV(ce,v) ((ce).je_ret = (v))
316 #define EXCEPT_SET(v) EXCEPT_SET_ENV(*(JMPENV*)pcur_env,v)
318 #define CATCH_GET (PL_top_env->je_mustcatch)
319 #define CATCH_SET(v) (PL_top_env->je_mustcatch = (v))