Commit | Line | Data |
---|---|---|
b9d12d37 GS |
1 | #define SAVEt_ITEM 0 |
2 | #define SAVEt_SV 1 | |
3 | #define SAVEt_AV 2 | |
4 | #define SAVEt_HV 3 | |
5 | #define SAVEt_INT 4 | |
6 | #define SAVEt_LONG 5 | |
7 | #define SAVEt_I32 6 | |
8 | #define SAVEt_IV 7 | |
9 | #define SAVEt_SPTR 8 | |
10 | #define SAVEt_APTR 9 | |
11 | #define SAVEt_HPTR 10 | |
12 | #define SAVEt_PPTR 11 | |
13 | #define SAVEt_NSTAB 12 | |
14 | #define SAVEt_SVREF 13 | |
15 | #define SAVEt_GP 14 | |
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 | |
24 | #define SAVEt_I16 23 | |
25 | #define SAVEt_AELEM 24 | |
26 | #define SAVEt_HELEM 25 | |
27 | #define SAVEt_OP 26 | |
28 | #define SAVEt_HINTS 27 | |
29 | #define SAVEt_ALLOC 28 | |
30 | #define SAVEt_GENERIC_SVREF 29 | |
c76ac1ee | 31 | #define SAVEt_DESTRUCTOR_X 30 |
7766f137 | 32 | #define SAVEt_VPTR 31 |
e8347627 | 33 | #define SAVEt_I8 32 |
354992b1 | 34 | #define SAVEt_COMPPAD 33 |
f4dd75d9 | 35 | #define SAVEt_GENERIC_PVREF 34 |
c3564e5c | 36 | #define SAVEt_PADSV 35 |
26d9b02f | 37 | #define SAVEt_MORTALIZESV 36 |
79072805 | 38 | |
b03c0a3a | 39 | #ifndef SCOPE_SAVES_SIGNAL_MASK |
1b266415 | 40 | #define SCOPE_SAVES_SIGNAL_MASK 0 |
b03c0a3a NIS |
41 | #endif |
42 | ||
3280af22 NIS |
43 | #define SSCHECK(need) if (PL_savestack_ix + need > PL_savestack_max) savestack_grow() |
44 | #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i)) | |
45 | #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i)) | |
46 | #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i)) | |
47 | #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p)) | |
48 | #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p)) | |
c76ac1ee | 49 | #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p)) |
3280af22 NIS |
50 | #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32) |
51 | #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long) | |
52 | #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv) | |
53 | #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr) | |
54 | #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr) | |
c76ac1ee | 55 | #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr) |
8990e307 | 56 | |
954c1994 GS |
57 | /* |
58 | =for apidoc Ams||SAVETMPS | |
59 | Opening bracket for temporaries on a callback. See C<FREETMPS> and | |
60 | L<perlcall>. | |
61 | ||
62 | =for apidoc Ams||FREETMPS | |
63 | Closing bracket for temporaries on a callback. See C<SAVETMPS> and | |
64 | L<perlcall>. | |
65 | ||
66 | =for apidoc Ams||ENTER | |
67 | Opening bracket on a callback. See C<LEAVE> and L<perlcall>. | |
68 | ||
69 | =for apidoc Ams||LEAVE | |
70 | Closing bracket on a callback. See C<ENTER> and L<perlcall>. | |
71 | ||
72 | =cut | |
73 | */ | |
74 | ||
3280af22 NIS |
75 | #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix |
76 | #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps() | |
a0d0e21e | 77 | |
f46d017c GS |
78 | #ifdef DEBUGGING |
79 | #define ENTER \ | |
80 | STMT_START { \ | |
81 | push_scope(); \ | |
cea2e8a9 | 82 | DEBUG_l(WITH_THR(Perl_deb(aTHX_ "ENTER scope %ld at %s:%d\n", \ |
3280af22 | 83 | PL_scopestack_ix, __FILE__, __LINE__))); \ |
f46d017c GS |
84 | } STMT_END |
85 | #define LEAVE \ | |
86 | STMT_START { \ | |
cea2e8a9 | 87 | DEBUG_l(WITH_THR(Perl_deb(aTHX_ "LEAVE scope %ld at %s:%d\n", \ |
3280af22 | 88 | PL_scopestack_ix, __FILE__, __LINE__))); \ |
f46d017c GS |
89 | pop_scope(); \ |
90 | } STMT_END | |
91 | #else | |
a0d0e21e LW |
92 | #define ENTER push_scope() |
93 | #define LEAVE pop_scope() | |
f46d017c | 94 | #endif |
3280af22 | 95 | #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old) |
a0d0e21e | 96 | |
55497cff | 97 | /* |
b9d12d37 | 98 | * Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV |
55497cff | 99 | * because these are used for several kinds of pointer values |
100 | */ | |
e8347627 | 101 | #define SAVEI8(i) save_I8(SOFT_CAST(I8*)&(i)) |
4fdae800 | 102 | #define SAVEI16(i) save_I16(SOFT_CAST(I16*)&(i)) |
103 | #define SAVEI32(i) save_I32(SOFT_CAST(I32*)&(i)) | |
104 | #define SAVEINT(i) save_int(SOFT_CAST(int*)&(i)) | |
105 | #define SAVEIV(i) save_iv(SOFT_CAST(IV*)&(i)) | |
106 | #define SAVELONG(l) save_long(SOFT_CAST(long*)&(l)) | |
55497cff | 107 | #define SAVESPTR(s) save_sptr((SV**)&(s)) |
108 | #define SAVEPPTR(s) save_pptr(SOFT_CAST(char**)&(s)) | |
57b2e452 | 109 | #define SAVEVPTR(s) save_vptr((void*)&(s)) |
c3564e5c | 110 | #define SAVEPADSV(s) save_padsv(s) |
55497cff | 111 | #define SAVEFREESV(s) save_freesv((SV*)(s)) |
26d9b02f | 112 | #define SAVEMORTALIZESV(s) save_mortalizesv((SV*)(s)) |
55497cff | 113 | #define SAVEFREEOP(o) save_freeop(SOFT_CAST(OP*)(o)) |
114 | #define SAVEFREEPV(p) save_freepv(SOFT_CAST(char*)(p)) | |
115 | #define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv)) | |
b9d12d37 | 116 | #define SAVEGENERICSV(s) save_generic_svref((SV**)&(s)) |
f4dd75d9 | 117 | #define SAVEGENERICPV(s) save_generic_pvref((char**)&(s)) |
55497cff | 118 | #define SAVEDELETE(h,k,l) \ |
119 | save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l)) | |
120 | #define SAVEDESTRUCTOR(f,p) \ | |
c76ac1ee GS |
121 | save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), SOFT_CAST(void*)(p)) |
122 | ||
123 | #define SAVEDESTRUCTOR_X(f,p) \ | |
124 | save_destructor_x((DESTRUCTORFUNC_t)(f), SOFT_CAST(void*)(p)) | |
25eaa213 GS |
125 | |
126 | #define SAVESTACK_POS() \ | |
127 | STMT_START { \ | |
128 | SSCHECK(2); \ | |
3280af22 | 129 | SSPUSHINT(PL_stack_sp - PL_stack_base); \ |
25eaa213 GS |
130 | SSPUSHINT(SAVEt_STACK_POS); \ |
131 | } STMT_END | |
132 | ||
462e5cf6 | 133 | #define SAVEOP() save_op() |
25eaa213 GS |
134 | |
135 | #define SAVEHINTS() \ | |
136 | STMT_START { \ | |
3280af22 | 137 | if (PL_hints & HINT_LOCALIZE_HH) \ |
25eaa213 GS |
138 | save_hints(); \ |
139 | else { \ | |
140 | SSCHECK(2); \ | |
3280af22 | 141 | SSPUSHINT(PL_hints); \ |
25eaa213 GS |
142 | SSPUSHINT(SAVEt_HINTS); \ |
143 | } \ | |
144 | } STMT_END | |
354992b1 GS |
145 | |
146 | #define SAVECOMPPAD() \ | |
147 | STMT_START { \ | |
148 | if (PL_comppad && PL_curpad == AvARRAY(PL_comppad)) { \ | |
149 | SSCHECK(2); \ | |
150 | SSPUSHPTR((SV*)PL_comppad); \ | |
151 | SSPUSHINT(SAVEt_COMPPAD); \ | |
152 | } \ | |
153 | else { \ | |
154 | SAVEVPTR(PL_curpad); \ | |
155 | SAVESPTR(PL_comppad); \ | |
156 | } \ | |
157 | } STMT_END | |
a9332b4a | 158 | |
57843af0 | 159 | #ifdef USE_ITHREADS |
f4dd75d9 GS |
160 | # define SAVECOPSTASH(c) SAVEPPTR(CopSTASHPV(c)) |
161 | # define SAVECOPSTASH_FREE(c) SAVEGENERICPV(CopSTASHPV(c)) | |
162 | # define SAVECOPFILE(c) SAVEPPTR(CopFILE(c)) | |
163 | # define SAVECOPFILE_FREE(c) SAVEGENERICPV(CopFILE(c)) | |
57843af0 | 164 | #else |
f4dd75d9 GS |
165 | # define SAVECOPSTASH(c) SAVESPTR(CopSTASH(c)) |
166 | # define SAVECOPSTASH_FREE(c) SAVECOPSTASH(c) /* XXX not refcounted */ | |
167 | # define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c)) | |
168 | # define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c)) | |
57843af0 GS |
169 | #endif |
170 | ||
f4dd75d9 | 171 | #define SAVECOPLINE(c) SAVEI16(CopLINE(c)) |
57843af0 | 172 | |
455ece5e AD |
173 | /* SSNEW() temporarily allocates a specified number of bytes of data on the |
174 | * savestack. It returns an integer index into the savestack, because a | |
175 | * pointer would get broken if the savestack is moved on reallocation. | |
176 | * SSNEWa() works like SSNEW(), but also aligns the data to the specified | |
177 | * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The | |
178 | * alignment will be preserved therough savestack reallocation *only* if | |
179 | * realloc returns data aligned to a size divisible by `align'! | |
180 | * | |
181 | * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer. | |
182 | */ | |
183 | ||
f2b2c1a7 | 184 | #define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0) |
02db2b7b | 185 | #define SSNEWt(n,t) SSNEW((n)*sizeof(t)) |
f2b2c1a7 | 186 | #define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \ |
455ece5e | 187 | (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align) |
02db2b7b | 188 | #define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align) |
455ece5e | 189 | |
02db2b7b IZ |
190 | #define SSPTR(off,type) ((type) ((char*)PL_savestack + off)) |
191 | #define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off)) | |
455ece5e | 192 | |
54310121 | 193 | /* A jmpenv packages the state required to perform a proper non-local jump. |
194 | * Note that there is a start_env initialized when perl starts, and top_env | |
195 | * points to this initially, so top_env should always be non-null. | |
196 | * | |
197 | * Existence of a non-null top_env->je_prev implies it is valid to call | |
6224f72b GS |
198 | * longjmp() at that runlevel (we make sure start_env.je_prev is always |
199 | * null to ensure this). | |
54310121 | 200 | * |
201 | * je_mustcatch, when set at any runlevel to TRUE, means eval ops must | |
202 | * establish a local jmpenv to handle exception traps. Care must be taken | |
203 | * to restore the previous value of je_mustcatch before exiting the | |
204 | * stack frame iff JMPENV_PUSH was not called in that stack frame. | |
6224f72b | 205 | * GSAR 97-03-27 |
54310121 | 206 | */ |
207 | ||
208 | struct jmpenv { | |
209 | struct jmpenv * je_prev; | |
312caa8e CS |
210 | Sigjmp_buf je_buf; /* only for use if !je_throw */ |
211 | int je_ret; /* last exception thrown */ | |
212 | bool je_mustcatch; /* need to call longjmp()? */ | |
14dd3ad8 | 213 | #ifdef PERL_FLEXIBLE_EXCEPTIONS |
312caa8e | 214 | void (*je_throw)(int v); /* last for bincompat */ |
db36c5a1 | 215 | bool je_noset; /* no need for setjmp() */ |
14dd3ad8 | 216 | #endif |
1163b5c4 | 217 | }; |
1163b5c4 | 218 | |
6224f72b | 219 | typedef struct jmpenv JMPENV; |
1163b5c4 | 220 | |
14dd3ad8 GS |
221 | #ifdef OP_IN_REGISTER |
222 | #define OP_REG_TO_MEM PL_opsave = op | |
223 | #define OP_MEM_TO_REG op = PL_opsave | |
224 | #else | |
225 | #define OP_REG_TO_MEM NOOP | |
226 | #define OP_MEM_TO_REG NOOP | |
227 | #endif | |
312caa8e CS |
228 | |
229 | /* | |
230 | * How to build the first jmpenv. | |
231 | * | |
232 | * top_env needs to be non-zero. It points to an area | |
233 | * in which longjmp() stuff is stored, as C callstack | |
234 | * info there at least is thread specific this has to | |
235 | * be per-thread. Otherwise a 'die' in a thread gives | |
236 | * that thread the C stack of last thread to do an eval {}! | |
237 | */ | |
238 | ||
239 | #define JMPENV_BOOTSTRAP \ | |
240 | STMT_START { \ | |
14dd3ad8 | 241 | Zero(&PL_start_env, 1, JMPENV); \ |
312caa8e CS |
242 | PL_start_env.je_ret = -1; \ |
243 | PL_start_env.je_mustcatch = TRUE; \ | |
244 | PL_top_env = &PL_start_env; \ | |
245 | } STMT_END | |
246 | ||
14dd3ad8 | 247 | #ifdef PERL_FLEXIBLE_EXCEPTIONS |
462e5cf6 | 248 | |
312caa8e CS |
249 | /* |
250 | * These exception-handling macros are split up to | |
251 | * ease integration with C++ exceptions. | |
252 | * | |
253 | * To use C++ try+catch to catch Perl exceptions, an extension author | |
254 | * needs to first write an extern "C" function to throw an appropriate | |
255 | * exception object; typically it will be or contain an integer, | |
256 | * because Perl's internals use integers to track exception types: | |
257 | * extern "C" { static void thrower(int i) { throw i; } } | |
258 | * | |
259 | * Then (as shown below) the author needs to use, not the simple | |
260 | * JMPENV_PUSH, but several of its constitutent macros, to arrange for | |
261 | * the Perl internals to call thrower() rather than longjmp() to | |
262 | * report exceptions: | |
263 | * | |
264 | * dJMPENV; | |
265 | * JMPENV_PUSH_INIT(thrower); | |
266 | * try { | |
267 | * ... stuff that may throw exceptions ... | |
268 | * } | |
269 | * catch (int why) { // or whatever matches thrower() | |
270 | * JMPENV_POST_CATCH; | |
271 | * EXCEPT_SET(why); | |
272 | * switch (why) { | |
273 | * ... // handle various Perl exception codes | |
274 | * } | |
275 | * } | |
276 | * JMPENV_POP; // don't forget this! | |
277 | */ | |
278 | ||
14dd3ad8 GS |
279 | /* |
280 | * Function that catches/throws, and its callback for the | |
281 | * body of protected processing. | |
282 | */ | |
283 | typedef void *(CPERLscope(*protect_body_t)) (pTHX_ va_list); | |
284 | typedef void *(CPERLscope(*protect_proc_t)) (pTHX_ volatile JMPENV *pcur_env, | |
285 | int *, protect_body_t, ...); | |
286 | ||
db36c5a1 GS |
287 | #define dJMPENV JMPENV cur_env; \ |
288 | volatile JMPENV *pcur_env = ((cur_env.je_noset = 0),&cur_env) | |
312caa8e | 289 | |
db36c5a1 | 290 | #define JMPENV_PUSH_INIT_ENV(ce,THROWFUNC) \ |
6224f72b | 291 | STMT_START { \ |
db36c5a1 GS |
292 | (ce).je_throw = (THROWFUNC); \ |
293 | (ce).je_ret = -1; \ | |
294 | (ce).je_mustcatch = FALSE; \ | |
295 | (ce).je_prev = PL_top_env; \ | |
296 | PL_top_env = &(ce); \ | |
6224f72b | 297 | OP_REG_TO_MEM; \ |
312caa8e | 298 | } STMT_END |
1d651c14 | 299 | |
f2b2c1a7 | 300 | #define JMPENV_PUSH_INIT(THROWFUNC) JMPENV_PUSH_INIT_ENV(*(JMPENV*)pcur_env,THROWFUNC) |
1d651c14 | 301 | |
db36c5a1 | 302 | #define JMPENV_POST_CATCH_ENV(ce) \ |
312caa8e | 303 | STMT_START { \ |
6224f72b | 304 | OP_MEM_TO_REG; \ |
db36c5a1 | 305 | PL_top_env = &(ce); \ |
6224f72b | 306 | } STMT_END |
312caa8e | 307 | |
db36c5a1 | 308 | #define JMPENV_POST_CATCH JMPENV_POST_CATCH_ENV(*(JMPENV*)pcur_env) |
1d651c14 | 309 | |
db36c5a1 GS |
310 | #define JMPENV_PUSH_ENV(ce,v) \ |
311 | STMT_START { \ | |
312 | if (!(ce).je_noset) { \ | |
14dd3ad8 GS |
313 | DEBUG_l(Perl_deb(aTHX_ "Setting up jumplevel %p, was %p\n", \ |
314 | ce, PL_top_env)); \ | |
db36c5a1 | 315 | JMPENV_PUSH_INIT_ENV(ce,NULL); \ |
b03c0a3a | 316 | EXCEPT_SET_ENV(ce,PerlProc_setjmp((ce).je_buf, SCOPE_SAVES_SIGNAL_MASK));\ |
db36c5a1 GS |
317 | (ce).je_noset = 1; \ |
318 | } \ | |
319 | else \ | |
320 | EXCEPT_SET_ENV(ce,0); \ | |
321 | JMPENV_POST_CATCH_ENV(ce); \ | |
322 | (v) = EXCEPT_GET_ENV(ce); \ | |
312caa8e CS |
323 | } STMT_END |
324 | ||
f2b2c1a7 | 325 | #define JMPENV_PUSH(v) JMPENV_PUSH_ENV(*(JMPENV*)pcur_env,v) |
1d651c14 | 326 | |
db36c5a1 | 327 | #define JMPENV_POP_ENV(ce) \ |
14dd3ad8 GS |
328 | STMT_START { \ |
329 | if (PL_top_env == &(ce)) \ | |
330 | PL_top_env = (ce).je_prev; \ | |
331 | } STMT_END | |
312caa8e | 332 | |
f2b2c1a7 | 333 | #define JMPENV_POP JMPENV_POP_ENV(*(JMPENV*)pcur_env) |
1d651c14 | 334 | |
22921e25 CS |
335 | #define JMPENV_JUMP(v) \ |
336 | STMT_START { \ | |
462e5cf6 | 337 | OP_REG_TO_MEM; \ |
312caa8e CS |
338 | if (PL_top_env->je_prev) { \ |
339 | if (PL_top_env->je_throw) \ | |
340 | PL_top_env->je_throw(v); \ | |
341 | else \ | |
342 | PerlProc_longjmp(PL_top_env->je_buf, (v)); \ | |
343 | } \ | |
6224f72b | 344 | if ((v) == 2) \ |
312caa8e | 345 | PerlProc_exit(STATUS_NATIVE_EXPORT); \ |
bf49b057 | 346 | PerlIO_printf(Perl_error_log, "panic: top_env\n"); \ |
312caa8e | 347 | PerlProc_exit(1); \ |
22921e25 | 348 | } STMT_END |
312caa8e | 349 | |
db36c5a1 GS |
350 | #define EXCEPT_GET_ENV(ce) ((ce).je_ret) |
351 | #define EXCEPT_GET EXCEPT_GET_ENV(*(JMPENV*)pcur_env) | |
352 | #define EXCEPT_SET_ENV(ce,v) ((ce).je_ret = (v)) | |
353 | #define EXCEPT_SET(v) EXCEPT_SET_ENV(*(JMPENV*)pcur_env,v) | |
312caa8e | 354 | |
14dd3ad8 GS |
355 | #else /* !PERL_FLEXIBLE_EXCEPTIONS */ |
356 | ||
357 | #define dJMPENV JMPENV cur_env | |
358 | ||
359 | #define JMPENV_PUSH(v) \ | |
360 | STMT_START { \ | |
361 | DEBUG_l(Perl_deb(aTHX_ "Setting up jumplevel %p, was %p\n", \ | |
362 | &cur_env, PL_top_env)); \ | |
363 | cur_env.je_prev = PL_top_env; \ | |
364 | OP_REG_TO_MEM; \ | |
b03c0a3a | 365 | cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK); \ |
14dd3ad8 GS |
366 | OP_MEM_TO_REG; \ |
367 | PL_top_env = &cur_env; \ | |
368 | cur_env.je_mustcatch = FALSE; \ | |
369 | (v) = cur_env.je_ret; \ | |
370 | } STMT_END | |
371 | ||
372 | #define JMPENV_POP \ | |
373 | STMT_START { PL_top_env = cur_env.je_prev; } STMT_END | |
374 | ||
375 | #define JMPENV_JUMP(v) \ | |
376 | STMT_START { \ | |
377 | OP_REG_TO_MEM; \ | |
378 | if (PL_top_env->je_prev) \ | |
379 | PerlProc_longjmp(PL_top_env->je_buf, (v)); \ | |
380 | if ((v) == 2) \ | |
381 | PerlProc_exit(STATUS_NATIVE_EXPORT); \ | |
382 | PerlIO_printf(PerlIO_stderr(), "panic: top_env\n"); \ | |
383 | PerlProc_exit(1); \ | |
384 | } STMT_END | |
385 | ||
386 | #endif /* PERL_FLEXIBLE_EXCEPTIONS */ | |
387 | ||
db36c5a1 GS |
388 | #define CATCH_GET (PL_top_env->je_mustcatch) |
389 | #define CATCH_SET(v) (PL_top_env->je_mustcatch = (v)) |