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