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 SAVECOPSTASH(cop) SAVEPPTR(CopSTASHPV(cop))
115 # define SAVECOPFILE(cop) SAVEPPTR(CopFILE(cop))
117 # define SAVECOPSTASH(cop) SAVESPTR(CopSTASH(cop))
118 # define SAVECOPFILE(cop) SAVESPTR(CopFILEGV(cop))
121 #define SAVECOPLINE(cop) SAVEI16(CopLINE(cop))
123 /* SSNEW() temporarily allocates a specified number of bytes of data on the
124 * savestack. It returns an integer index into the savestack, because a
125 * pointer would get broken if the savestack is moved on reallocation.
126 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
127 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
128 * alignment will be preserved therough savestack reallocation *only* if
129 * realloc returns data aligned to a size divisible by `align'!
131 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
134 #define SSNEW(size) save_alloc(size, 0)
135 #define SSNEWa(size,align) save_alloc(size, \
136 (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
138 #define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
140 /* A jmpenv packages the state required to perform a proper non-local jump.
141 * Note that there is a start_env initialized when perl starts, and top_env
142 * points to this initially, so top_env should always be non-null.
144 * Existence of a non-null top_env->je_prev implies it is valid to call
145 * longjmp() at that runlevel (we make sure start_env.je_prev is always
146 * null to ensure this).
148 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
149 * establish a local jmpenv to handle exception traps. Care must be taken
150 * to restore the previous value of je_mustcatch before exiting the
151 * stack frame iff JMPENV_PUSH was not called in that stack frame.
156 struct jmpenv * je_prev;
157 Sigjmp_buf je_buf; /* only for use if !je_throw */
158 int je_ret; /* last exception thrown */
159 bool je_mustcatch; /* need to call longjmp()? */
160 void (*je_throw)(int v); /* last for bincompat */
161 bool je_noset; /* no need for setjmp() */
164 typedef struct jmpenv JMPENV;
167 * Function that catches/throws, and its callback for the
168 * body of protected processing.
170 typedef void *(CPERLscope(*protect_body_t)) (pTHX_ va_list);
171 typedef void *(CPERLscope(*protect_proc_t)) (pTHX_ volatile JMPENV *pcur_env,
172 int *, protect_body_t, ...);
175 * How to build the first jmpenv.
177 * top_env needs to be non-zero. It points to an area
178 * in which longjmp() stuff is stored, as C callstack
179 * info there at least is thread specific this has to
180 * be per-thread. Otherwise a 'die' in a thread gives
181 * that thread the C stack of last thread to do an eval {}!
184 #define JMPENV_BOOTSTRAP \
186 PL_start_env.je_prev = NULL; \
187 PL_start_env.je_throw = NULL; \
188 PL_start_env.je_ret = -1; \
189 PL_start_env.je_mustcatch = TRUE; \
190 PL_start_env.je_noset = 0; \
191 PL_top_env = &PL_start_env; \
194 #ifdef OP_IN_REGISTER
195 #define OP_REG_TO_MEM PL_opsave = op
196 #define OP_MEM_TO_REG op = PL_opsave
198 #define OP_REG_TO_MEM NOOP
199 #define OP_MEM_TO_REG NOOP
203 * These exception-handling macros are split up to
204 * ease integration with C++ exceptions.
206 * To use C++ try+catch to catch Perl exceptions, an extension author
207 * needs to first write an extern "C" function to throw an appropriate
208 * exception object; typically it will be or contain an integer,
209 * because Perl's internals use integers to track exception types:
210 * extern "C" { static void thrower(int i) { throw i; } }
212 * Then (as shown below) the author needs to use, not the simple
213 * JMPENV_PUSH, but several of its constitutent macros, to arrange for
214 * the Perl internals to call thrower() rather than longjmp() to
218 * JMPENV_PUSH_INIT(thrower);
220 * ... stuff that may throw exceptions ...
222 * catch (int why) { // or whatever matches thrower()
226 * ... // handle various Perl exception codes
229 * JMPENV_POP; // don't forget this!
232 #define dJMPENV JMPENV cur_env; \
233 volatile JMPENV *pcur_env = ((cur_env.je_noset = 0),&cur_env)
235 #define JMPENV_PUSH_INIT_ENV(ce,THROWFUNC) \
237 (ce).je_throw = (THROWFUNC); \
239 (ce).je_mustcatch = FALSE; \
240 (ce).je_prev = PL_top_env; \
241 PL_top_env = &(ce); \
245 #define JMPENV_PUSH_INIT(THROWFUNC) JMPENV_PUSH_INIT_ENV(*(JMPENV*)pcur_env,THROWFUNC)
247 #define JMPENV_POST_CATCH_ENV(ce) \
250 PL_top_env = &(ce); \
253 #define JMPENV_POST_CATCH JMPENV_POST_CATCH_ENV(*(JMPENV*)pcur_env)
256 #define JMPENV_PUSH_ENV(ce,v) \
258 if (!(ce).je_noset) { \
259 JMPENV_PUSH_INIT_ENV(ce,NULL); \
260 EXCEPT_SET_ENV(ce,PerlProc_setjmp((ce).je_buf, 1));\
264 EXCEPT_SET_ENV(ce,0); \
265 JMPENV_POST_CATCH_ENV(ce); \
266 (v) = EXCEPT_GET_ENV(ce); \
269 #define JMPENV_PUSH(v) JMPENV_PUSH_ENV(*(JMPENV*)pcur_env,v)
271 #define JMPENV_POP_ENV(ce) \
272 STMT_START { PL_top_env = (ce).je_prev; } STMT_END
274 #define JMPENV_POP JMPENV_POP_ENV(*(JMPENV*)pcur_env)
276 #define JMPENV_JUMP(v) \
279 if (PL_top_env->je_prev) { \
280 if (PL_top_env->je_throw) \
281 PL_top_env->je_throw(v); \
283 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
286 PerlProc_exit(STATUS_NATIVE_EXPORT); \
287 PerlIO_printf(Perl_error_log, "panic: top_env\n"); \
291 #define EXCEPT_GET_ENV(ce) ((ce).je_ret)
292 #define EXCEPT_GET EXCEPT_GET_ENV(*(JMPENV*)pcur_env)
293 #define EXCEPT_SET_ENV(ce,v) ((ce).je_ret = (v))
294 #define EXCEPT_SET(v) EXCEPT_SET_ENV(*(JMPENV*)pcur_env,v)
296 #define CATCH_GET (PL_top_env->je_mustcatch)
297 #define CATCH_SET(v) (PL_top_env->je_mustcatch = (v))