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