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