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
33 #define SSCHECK(need) if (PL_savestack_ix + need > PL_savestack_max) savestack_grow()
34 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
35 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
36 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
37 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
38 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
39 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
40 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
41 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
42 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
43 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
44 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
45 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
47 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
48 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
54 DEBUG_l(WITH_THR(Perl_deb(aTHX_ "ENTER scope %ld at %s:%d\n", \
55 PL_scopestack_ix, __FILE__, __LINE__))); \
59 DEBUG_l(WITH_THR(Perl_deb(aTHX_ "LEAVE scope %ld at %s:%d\n", \
60 PL_scopestack_ix, __FILE__, __LINE__))); \
64 #define ENTER push_scope()
65 #define LEAVE pop_scope()
67 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
70 * Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV
71 * because these are used for several kinds of pointer values
73 #define SAVEI16(i) save_I16(SOFT_CAST(I16*)&(i))
74 #define SAVEI32(i) save_I32(SOFT_CAST(I32*)&(i))
75 #define SAVEINT(i) save_int(SOFT_CAST(int*)&(i))
76 #define SAVEIV(i) save_iv(SOFT_CAST(IV*)&(i))
77 #define SAVELONG(l) save_long(SOFT_CAST(long*)&(l))
78 #define SAVESPTR(s) save_sptr((SV**)&(s))
79 #define SAVEPPTR(s) save_pptr(SOFT_CAST(char**)&(s))
80 #define SAVEFREESV(s) save_freesv((SV*)(s))
81 #define SAVEFREEOP(o) save_freeop(SOFT_CAST(OP*)(o))
82 #define SAVEFREEPV(p) save_freepv(SOFT_CAST(char*)(p))
83 #define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv))
84 #define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
85 #define SAVEDELETE(h,k,l) \
86 save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
87 #define SAVEDESTRUCTOR(f,p) \
88 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), SOFT_CAST(void*)(p))
90 #define SAVEDESTRUCTOR_X(f,p) \
91 save_destructor_x((DESTRUCTORFUNC_t)(f), SOFT_CAST(void*)(p))
93 #define SAVESTACK_POS() \
96 SSPUSHINT(PL_stack_sp - PL_stack_base); \
97 SSPUSHINT(SAVEt_STACK_POS); \
100 #define SAVEOP() save_op()
102 #define SAVEHINTS() \
104 if (PL_hints & HINT_LOCALIZE_HH) \
108 SSPUSHINT(PL_hints); \
109 SSPUSHINT(SAVEt_HINTS); \
114 # define SAVECOPFILE(cop) SAVEPPTR(CopFILE(cop))
116 # define SAVECOPFILE(cop) SAVESPTR(CopFILEGV(cop))
119 #define SAVECOPLINE(cop) SAVEI16(CopLINE(cop))
121 /* SSNEW() temporarily allocates a specified number of bytes of data on the
122 * savestack. It returns an integer index into the savestack, because a
123 * pointer would get broken if the savestack is moved on reallocation.
124 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
125 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
126 * alignment will be preserved therough savestack reallocation *only* if
127 * realloc returns data aligned to a size divisible by `align'!
129 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
132 #define SSNEW(size) save_alloc(size, 0)
133 #define SSNEWa(size,align) save_alloc(size, \
134 (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
136 #define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
138 /* A jmpenv packages the state required to perform a proper non-local jump.
139 * Note that there is a start_env initialized when perl starts, and top_env
140 * points to this initially, so top_env should always be non-null.
142 * Existence of a non-null top_env->je_prev implies it is valid to call
143 * longjmp() at that runlevel (we make sure start_env.je_prev is always
144 * null to ensure this).
146 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
147 * establish a local jmpenv to handle exception traps. Care must be taken
148 * to restore the previous value of je_mustcatch before exiting the
149 * stack frame iff JMPENV_PUSH was not called in that stack frame.
154 struct jmpenv * je_prev;
155 Sigjmp_buf je_buf; /* only for use if !je_throw */
156 int je_ret; /* last exception thrown */
157 bool je_mustcatch; /* need to call longjmp()? */
158 void (*je_throw)(int v); /* last for bincompat */
159 bool je_noset; /* no need for setjmp() */
162 typedef struct jmpenv JMPENV;
165 * Function that catches/throws, and its callback for the
166 * body of protected processing.
168 typedef void *(CPERLscope(*protect_body_t)) (pTHX_ va_list);
169 typedef void *(CPERLscope(*protect_proc_t)) (pTHX_ volatile JMPENV *pcur_env,
170 int *, protect_body_t, ...);
173 * How to build the first jmpenv.
175 * top_env needs to be non-zero. It points to an area
176 * in which longjmp() stuff is stored, as C callstack
177 * info there at least is thread specific this has to
178 * be per-thread. Otherwise a 'die' in a thread gives
179 * that thread the C stack of last thread to do an eval {}!
182 #define JMPENV_BOOTSTRAP \
184 PL_start_env.je_prev = NULL; \
185 PL_start_env.je_throw = NULL; \
186 PL_start_env.je_ret = -1; \
187 PL_start_env.je_mustcatch = TRUE; \
188 PL_start_env.je_noset = 0; \
189 PL_top_env = &PL_start_env; \
192 #ifdef OP_IN_REGISTER
193 #define OP_REG_TO_MEM PL_opsave = op
194 #define OP_MEM_TO_REG op = PL_opsave
196 #define OP_REG_TO_MEM NOOP
197 #define OP_MEM_TO_REG NOOP
201 * These exception-handling macros are split up to
202 * ease integration with C++ exceptions.
204 * To use C++ try+catch to catch Perl exceptions, an extension author
205 * needs to first write an extern "C" function to throw an appropriate
206 * exception object; typically it will be or contain an integer,
207 * because Perl's internals use integers to track exception types:
208 * extern "C" { static void thrower(int i) { throw i; } }
210 * Then (as shown below) the author needs to use, not the simple
211 * JMPENV_PUSH, but several of its constitutent macros, to arrange for
212 * the Perl internals to call thrower() rather than longjmp() to
216 * JMPENV_PUSH_INIT(thrower);
218 * ... stuff that may throw exceptions ...
220 * catch (int why) { // or whatever matches thrower()
224 * ... // handle various Perl exception codes
227 * JMPENV_POP; // don't forget this!
230 #define dJMPENV JMPENV cur_env; \
231 volatile JMPENV *pcur_env = ((cur_env.je_noset = 0),&cur_env)
233 #define JMPENV_PUSH_INIT_ENV(ce,THROWFUNC) \
235 (ce).je_throw = (THROWFUNC); \
237 (ce).je_mustcatch = FALSE; \
238 (ce).je_prev = PL_top_env; \
239 PL_top_env = &(ce); \
243 #define JMPENV_PUSH_INIT(THROWFUNC) JMPENV_PUSH_INIT_ENV(*(JMPENV*)pcur_env,THROWFUNC)
245 #define JMPENV_POST_CATCH_ENV(ce) \
248 PL_top_env = &(ce); \
251 #define JMPENV_POST_CATCH JMPENV_POST_CATCH_ENV(*(JMPENV*)pcur_env)
254 #define JMPENV_PUSH_ENV(ce,v) \
256 if (!(ce).je_noset) { \
257 JMPENV_PUSH_INIT_ENV(ce,NULL); \
258 EXCEPT_SET_ENV(ce,PerlProc_setjmp((ce).je_buf, 1));\
262 EXCEPT_SET_ENV(ce,0); \
263 JMPENV_POST_CATCH_ENV(ce); \
264 (v) = EXCEPT_GET_ENV(ce); \
267 #define JMPENV_PUSH(v) JMPENV_PUSH_ENV(*(JMPENV*)pcur_env,v)
269 #define JMPENV_POP_ENV(ce) \
270 STMT_START { PL_top_env = (ce).je_prev; } STMT_END
272 #define JMPENV_POP JMPENV_POP_ENV(*(JMPENV*)pcur_env)
274 #define JMPENV_JUMP(v) \
277 if (PL_top_env->je_prev) { \
278 if (PL_top_env->je_throw) \
279 PL_top_env->je_throw(v); \
281 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
284 PerlProc_exit(STATUS_NATIVE_EXPORT); \
285 PerlIO_printf(Perl_error_log, "panic: top_env\n"); \
289 #define EXCEPT_GET_ENV(ce) ((ce).je_ret)
290 #define EXCEPT_GET EXCEPT_GET_ENV(*(JMPENV*)pcur_env)
291 #define EXCEPT_SET_ENV(ce,v) ((ce).je_ret = (v))
292 #define EXCEPT_SET(v) EXCEPT_SET_ENV(*(JMPENV*)pcur_env,v)
294 #define CATCH_GET (PL_top_env->je_mustcatch)
295 #define CATCH_SET(v) (PL_top_env->je_mustcatch = (v))