This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Prevent double frees/crashes with format syntax errs
[perl5.git] / scope.h
CommitLineData
d6376244
JH
1/* scope.h
2 *
1129b882
NC
3 * Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2004, 2005, 2006, 2007, 2008 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
09edbca0 46#define SAVEt_PADSV_AND_MORTALIZE 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
8b7059b1 51#define SAVEt_SAVESWITCHSTACK 40
1ade1aa1 52#define SAVEt_RE_STATE 42
68da3b2f 53#define SAVEt_COMPILE_WARNINGS 43
ea8d6ae1 54#define SAVEt_STACK_CXPOS 44
7c197c94 55#define SAVEt_PARSER 45
c68ec7a9 56#define SAVEt_ADELETE 46
89abef21 57#define SAVEt_I32_SMALL 47
994d373a 58#define SAVEt_INT_SMALL 48
f83b46a0 59#define SAVEt_GVSV 49
3987a177 60#define SAVEt_FREECOPHH 50
79072805 61
af7df257 62#define SAVEf_SETMAGIC 1
75d34a09 63#define SAVEf_KEEPOLDELEM 2
af7df257 64
c6bf6a65
NC
65#define SAVE_TIGHT_SHIFT 6
66#define SAVE_MASK 0x3F
67
91d1c79f 68#define save_aelem(av,idx,sptr) save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
af7df257
CS
69#define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
70
b03c0a3a 71#ifndef SCOPE_SAVES_SIGNAL_MASK
1b266415 72#define SCOPE_SAVES_SIGNAL_MASK 0
b03c0a3a
NIS
73#endif
74
bb7a0f54
MHM
75#define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
76#define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
3280af22
NIS
77#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
78#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
9febdf04 79#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
3280af22 80#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
c6bf6a65 81#define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
3280af22
NIS
82#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
83#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
c76ac1ee 84#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
3280af22
NIS
85#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
86#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
9febdf04 87#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
3280af22 88#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
c6bf6a65 89#define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
3280af22
NIS
90#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
91#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
c76ac1ee 92#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
8990e307 93
954c1994 94/*
ccfc67b7
JH
95=head1 Callback Functions
96
954c1994
GS
97=for apidoc Ams||SAVETMPS
98Opening bracket for temporaries on a callback. See C<FREETMPS> and
99L<perlcall>.
100
101=for apidoc Ams||FREETMPS
102Closing bracket for temporaries on a callback. See C<SAVETMPS> and
103L<perlcall>.
104
105=for apidoc Ams||ENTER
106Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
107
108=for apidoc Ams||LEAVE
109Closing bracket on a callback. See C<ENTER> and L<perlcall>.
110
d343c3ef
GG
111=over
112
113=item ENTER_with_name(name)
114
115Same as C<ENTER>, but when debugging is enabled it also associates the
116given literal string with the new scope.
117
118=item LEAVE_with_name(name)
119
120Same as C<LEAVE>, but when debugging is enabled it first checks that the
121scope has the given name. Name must be a literal string.
122
123=back
124
954c1994
GS
125=cut
126*/
127
3280af22
NIS
128#define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
129#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
a0d0e21e 130
f46d017c
GS
131#ifdef DEBUGGING
132#define ENTER \
133 STMT_START { \
134 push_scope(); \
b4ab917c 135 DEBUG_SCOPE("ENTER") \
f46d017c
GS
136 } STMT_END
137#define LEAVE \
138 STMT_START { \
b4ab917c 139 DEBUG_SCOPE("LEAVE") \
f46d017c
GS
140 pop_scope(); \
141 } STMT_END
d343c3ef
GG
142#define ENTER_with_name(name) \
143 STMT_START { \
144 push_scope(); \
a09dc31d
NC
145 if (PL_scopestack_name) \
146 PL_scopestack_name[PL_scopestack_ix-1] = name; \
d343c3ef
GG
147 DEBUG_SCOPE("ENTER \"" name "\"") \
148 } STMT_END
149#define LEAVE_with_name(name) \
150 STMT_START { \
151 DEBUG_SCOPE("LEAVE \"" name "\"") \
a09dc31d
NC
152 if (PL_scopestack_name) { \
153 assert(((char*)PL_scopestack_name[PL_scopestack_ix-1] \
154 == (char*)name) \
155 || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name)); \
156 } \
d343c3ef
GG
157 pop_scope(); \
158 } STMT_END
f46d017c 159#else
a0d0e21e
LW
160#define ENTER push_scope()
161#define LEAVE pop_scope()
d343c3ef
GG
162#define ENTER_with_name(name) ENTER
163#define LEAVE_with_name(name) LEAVE
f46d017c 164#endif
3280af22 165#define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
a0d0e21e 166
3f26ef39
NC
167#define SAVEI8(i) save_I8((I8*)&(i))
168#define SAVEI16(i) save_I16((I16*)&(i))
169#define SAVEI32(i) save_I32((I32*)&(i))
170#define SAVEINT(i) save_int((int*)&(i))
171#define SAVEIV(i) save_iv((IV*)&(i))
172#define SAVELONG(l) save_long((long*)&(l))
02644217 173#define SAVEBOOL(b) save_bool(&(b))
55497cff 174#define SAVESPTR(s) save_sptr((SV**)&(s))
3f26ef39 175#define SAVEPPTR(s) save_pptr((char**)&(s))
57b2e452 176#define SAVEVPTR(s) save_vptr((void*)&(s))
09edbca0 177#define SAVEPADSVANDMORTALIZE(s) save_padsv_and_mortalize(s)
b1bc3f34
NC
178#define SAVEFREESV(s) save_freesv(MUTABLE_SV(s))
179#define SAVEMORTALIZESV(s) save_mortalizesv(MUTABLE_SV(s))
3f26ef39
NC
180#define SAVEFREEOP(o) save_freeop((OP*)(o))
181#define SAVEFREEPV(p) save_freepv((char*)(p))
182#define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
b9d12d37 183#define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
f4dd75d9 184#define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
05ec9bb3 185#define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
14f338dc 186#define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
3987a177 187#define SAVEFREECOPHH(h) save_pushptr((void *)(h), SAVEt_FREECOPHH)
55497cff 188#define SAVEDELETE(h,k,l) \
dbebbdb4 189 save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
af097752
VP
190#define SAVEHDELETE(h,s) \
191 save_hdelete(MUTABLE_HV(h), (s))
c68ec7a9
VP
192#define SAVEADELETE(a,k) \
193 save_adelete(MUTABLE_AV(a), (I32)(k))
55497cff 194#define SAVEDESTRUCTOR(f,p) \
3f26ef39 195 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
c76ac1ee
GS
196
197#define SAVEDESTRUCTOR_X(f,p) \
3f26ef39 198 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
25eaa213
GS
199
200#define SAVESTACK_POS() \
201 STMT_START { \
202 SSCHECK(2); \
3280af22 203 SSPUSHINT(PL_stack_sp - PL_stack_base); \
c6bf6a65 204 SSPUSHUV(SAVEt_STACK_POS); \
25eaa213
GS
205 } STMT_END
206
462e5cf6 207#define SAVEOP() save_op()
25eaa213 208
da8315f8 209#define SAVEHINTS() save_hints()
354992b1 210
747e2fae 211#define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
a9332b4a 212
8b7059b1
DM
213#define SAVESWITCHSTACK(f,t) \
214 STMT_START { \
dfcd3de5 215 save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
8b7059b1
DM
216 SWITCHSTACK((f),(t)); \
217 PL_curstackinfo->si_stack = (t); \
218 } STMT_END
219
c88c823b 220/* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
72dc9ed5
NC
221 because realloc() means that the value can actually change. Possibly
222 could have done savefreesharedpvREF, but this way actually seems cleaner,
223 as it simplifies the code that does the saves, and reduces the load on the
224 save stack. */
747e2fae 225#define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
fc15ae8f 226
ea8d6ae1
DB
227#define SAVESTACK_CXPOS() \
228 STMT_START { \
229 SSCHECK(3); \
230 SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
231 SSPUSHINT(cxstack_ix); \
c6bf6a65 232 SSPUSHUV(SAVEt_STACK_CXPOS); \
ea8d6ae1
DB
233 } STMT_END
234
747e2fae 235#define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
7c197c94 236
57843af0 237#ifdef USE_ITHREADS
d4d03940 238# define SAVECOPSTASH_FREE(c) SAVEIV((c)->cop_stashoff)
f4dd75d9 239# define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
05ec9bb3 240# define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
57843af0 241#else
61b3e50d
FC
242# /* XXX not refcounted */
243# define SAVECOPSTASH_FREE(c) SAVESPTR(CopSTASH(c))
f4dd75d9
GS
244# define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
245# define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
57843af0
GS
246#endif
247
dea28490 248#define SAVECOPLINE(c) SAVEI32(CopLINE(c))
57843af0 249
455ece5e
AD
250/* SSNEW() temporarily allocates a specified number of bytes of data on the
251 * savestack. It returns an integer index into the savestack, because a
252 * pointer would get broken if the savestack is moved on reallocation.
253 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
254 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
486ec47a 255 * alignment will be preserved through savestack reallocation *only* if
a0288114 256 * realloc returns data aligned to a size divisible by "align"!
455ece5e
AD
257 *
258 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
259 */
260
f2b2c1a7 261#define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
02db2b7b 262#define SSNEWt(n,t) SSNEW((n)*sizeof(t))
f2b2c1a7 263#define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
6b99f28a 264 (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
02db2b7b 265#define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
455ece5e 266
02db2b7b
IZ
267#define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
268#define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off))
455ece5e 269
2fd8beea
NC
270#define save_freesv(op) save_pushptr((void *)(op), SAVEt_FREESV)
271#define save_mortalizesv(op) save_pushptr((void *)(op), SAVEt_MORTALIZESV)
bb38a9e0
FC
272#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
273# define save_freeop(op) \
274 ({ \
275 OP * const _o = (OP *)(op); \
6c7ae946 276 assert(!_o->op_savefree); \
bb38a9e0
FC
277 _o->op_savefree = 1; \
278 save_pushptr((void *)(_o), SAVEt_FREEOP); \
279 })
280#else
281# define save_freeop(op) \
282 ( \
283 PL_Xpv = (XPV *)(op), \
6c7ae946 284 assert_(!((OP *)PL_Xpv)->op_savefree) \
bb38a9e0
FC
285 ((OP *)PL_Xpv)->op_savefree = 1, \
286 save_pushptr((void *)(PL_Xpv), SAVEt_FREEOP) \
287 )
288#endif
2fd8beea
NC
289#define save_freepv(pv) save_pushptr((void *)(pv), SAVEt_FREEPV)
290#define save_op() save_pushptr((void *)(PL_op), SAVEt_OP)
291
e9a8c099
MHM
292/*
293 * Local variables:
294 * c-indentation-style: bsd
295 * c-basic-offset: 4
14d04a33 296 * indent-tabs-mode: nil
e9a8c099
MHM
297 * End:
298 *
14d04a33 299 * ex: set ts=8 sts=4 sw=4 et:
e9a8c099 300 */