This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
rename PUSHBLOCK,PUSHSUB etc to CX_PUSHBLOCK etc
[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
03dba561
DM
11/* *** these are ordered by number of of auto-popped args */
12
13/* zero args */
14
15#define SAVEt_ALLOC 0
16#define SAVEt_CLEARPADRANGE 1
17#define SAVEt_CLEARSV 2
18#define SAVEt_REGCONTEXT 3
03dba561 19
ff2a62e0 20#define SAVEt_ARG0_MAX 3
03dba561
DM
21
22/* one arg */
23
71afaece 24/*** SPARE 4 ***/
03dba561
DM
25#define SAVEt_BOOL 5
26#define SAVEt_COMPILE_WARNINGS 6
27#define SAVEt_COMPPAD 7
28#define SAVEt_FREECOPHH 8
29#define SAVEt_FREEOP 9
30#define SAVEt_FREEPV 10
31#define SAVEt_FREESV 11
32#define SAVEt_I16 12
33#define SAVEt_I32_SMALL 13
34#define SAVEt_I8 14
35#define SAVEt_INT_SMALL 15
36#define SAVEt_MORTALIZESV 16
37#define SAVEt_NSTAB 17
38#define SAVEt_OP 18
39#define SAVEt_PARSER 19
40#define SAVEt_STACK_POS 20
20d5dc23 41#define SAVEt_READONLY_OFF 21
0f94cb1f 42#define SAVEt_FREEPADNAME 22
03dba561 43
0f94cb1f 44#define SAVEt_ARG1_MAX 22
03dba561
DM
45
46/* two args */
47
03dba561
DM
48#define SAVEt_AV 23
49#define SAVEt_DESTRUCTOR 24
50#define SAVEt_DESTRUCTOR_X 25
51#define SAVEt_GENERIC_PVREF 26
52#define SAVEt_GENERIC_SVREF 27
53#define SAVEt_GP 28
54#define SAVEt_GVSV 29
55#define SAVEt_HINTS 30
56#define SAVEt_HPTR 31
57#define SAVEt_HV 32
58#define SAVEt_I32 33
59#define SAVEt_INT 34
60#define SAVEt_ITEM 35
61#define SAVEt_IV 36
62#define SAVEt_LONG 37
63#define SAVEt_PPTR 38
64#define SAVEt_SAVESWITCHSTACK 39
65#define SAVEt_SHARED_PVREF 40
66#define SAVEt_SPTR 41
e8eb279c 67#define SAVEt_STRLEN 42
03dba561
DM
68#define SAVEt_SV 43
69#define SAVEt_SVREF 44
70#define SAVEt_VPTR 45
20d5dc23 71#define SAVEt_ADELETE 46
0f94cb1f 72#define SAVEt_APTR 47
03dba561 73
0f94cb1f 74#define SAVEt_ARG2_MAX 47
03dba561
DM
75
76/* three args */
77
03dba561
DM
78#define SAVEt_HELEM 48
79#define SAVEt_PADSV_AND_MORTALIZE 49
80#define SAVEt_SET_SVFLAGS 50
81#define SAVEt_GVSLOT 51
20d5dc23 82#define SAVEt_AELEM 52
0f94cb1f
FC
83#define SAVEt_DELETE 53
84
79072805 85
af7df257 86#define SAVEf_SETMAGIC 1
75d34a09 87#define SAVEf_KEEPOLDELEM 2
af7df257 88
c6bf6a65
NC
89#define SAVE_TIGHT_SHIFT 6
90#define SAVE_MASK 0x3F
91
91d1c79f 92#define save_aelem(av,idx,sptr) save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
af7df257
CS
93#define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
94
b03c0a3a 95#ifndef SCOPE_SAVES_SIGNAL_MASK
1b266415 96#define SCOPE_SAVES_SIGNAL_MASK 0
b03c0a3a
NIS
97#endif
98
a3444cc5
DM
99/* the maximum number of entries that might be pushed using the SS_ADD*
100 * macros */
101#define SS_MAXPUSH 4
102
5d9574c1
DM
103#define SSCHECK(need) if (UNLIKELY(PL_savestack_ix + (I32)(need) + SS_MAXPUSH > PL_savestack_max)) savestack_grow()
104#define SSGROW(need) if (UNLIKELY(PL_savestack_ix + (I32)(need) + SS_MAXPUSH > PL_savestack_max)) savestack_grow_cnt(need + SS_MAXPUSH)
3280af22
NIS
105#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
106#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
9febdf04 107#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
3280af22 108#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
c6bf6a65 109#define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
3280af22
NIS
110#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
111#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
c76ac1ee 112#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
a3444cc5
DM
113
114/* SS_ADD*: newer, faster versions of the above. Don't mix the two sets of
115 * macros. These are fast because they save reduce accesses to the PL_
116 * vars and move the size check to the end. Doing the check last means
117 * that values in registers will have been pushed and no longer needed, so
118 * don't need saving around the call to grow. Also, tail-call elimination
119 * of the grow() can be done. These changes reduce the code of something
120 * like save_pushptrptr() to half its former size.
121 * Of course, doing the size check *after* pushing means we must always
122 * ensure there are SS_MAXPUSH free slots on the savestack
123 *
124 * These are for internal core use only and are subject to change */
125
126#define dSS_ADD \
127 I32 ix = PL_savestack_ix; \
c70927a6 128 ANY *ssp = &PL_savestack[ix]
a3444cc5
DM
129
130#define SS_ADD_END(need) \
131 assert((need) <= SS_MAXPUSH); \
132 ix += (need); \
133 PL_savestack_ix = ix; \
134 assert(ix <= PL_savestack_max); \
5d9574c1 135 if (UNLIKELY((ix + SS_MAXPUSH) > PL_savestack_max)) savestack_grow(); \
a3444cc5
DM
136 assert(PL_savestack_ix + SS_MAXPUSH <= PL_savestack_max);
137
138#define SS_ADD_INT(i) ((ssp++)->any_i32 = (I32)(i))
139#define SS_ADD_LONG(i) ((ssp++)->any_long = (long)(i))
140#define SS_ADD_BOOL(p) ((ssp++)->any_bool = (p))
141#define SS_ADD_IV(i) ((ssp++)->any_iv = (IV)(i))
142#define SS_ADD_UV(u) ((ssp++)->any_uv = (UV)(u))
143#define SS_ADD_PTR(p) ((ssp++)->any_ptr = (void*)(p))
144#define SS_ADD_DPTR(p) ((ssp++)->any_dptr = (p))
145#define SS_ADD_DXPTR(p) ((ssp++)->any_dxptr = (p))
146
3280af22
NIS
147#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
148#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
9febdf04 149#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
3280af22 150#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
c6bf6a65 151#define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
3280af22
NIS
152#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
153#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
c76ac1ee 154#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
8990e307 155
a3444cc5 156
954c1994 157/*
ccfc67b7
JH
158=head1 Callback Functions
159
954c1994 160=for apidoc Ams||SAVETMPS
fbe13c60 161Opening bracket for temporaries on a callback. See C<L</FREETMPS>> and
954c1994
GS
162L<perlcall>.
163
164=for apidoc Ams||FREETMPS
fbe13c60 165Closing bracket for temporaries on a callback. See C<L</SAVETMPS>> and
954c1994
GS
166L<perlcall>.
167
168=for apidoc Ams||ENTER
fbe13c60 169Opening bracket on a callback. See C<L</LEAVE>> and L<perlcall>.
954c1994
GS
170
171=for apidoc Ams||LEAVE
fbe13c60 172Closing bracket on a callback. See C<L</ENTER>> and L<perlcall>.
954c1994 173
d343c3ef
GG
174=over
175
176=item ENTER_with_name(name)
177
178Same as C<ENTER>, but when debugging is enabled it also associates the
179given literal string with the new scope.
180
181=item LEAVE_with_name(name)
182
183Same as C<LEAVE>, but when debugging is enabled it first checks that the
184scope has the given name. Name must be a literal string.
185
186=back
187
954c1994
GS
188=cut
189*/
190
e8eb279c
FC
191#define SAVETMPS Perl_save_strlen(aTHX_ (STRLEN *)&PL_tmps_floor), \
192 PL_tmps_floor = PL_tmps_ix
3280af22 193#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
a0d0e21e 194
f46d017c
GS
195#ifdef DEBUGGING
196#define ENTER \
197 STMT_START { \
198 push_scope(); \
b4ab917c 199 DEBUG_SCOPE("ENTER") \
f46d017c
GS
200 } STMT_END
201#define LEAVE \
202 STMT_START { \
b4ab917c 203 DEBUG_SCOPE("LEAVE") \
f46d017c
GS
204 pop_scope(); \
205 } STMT_END
d343c3ef
GG
206#define ENTER_with_name(name) \
207 STMT_START { \
208 push_scope(); \
a09dc31d
NC
209 if (PL_scopestack_name) \
210 PL_scopestack_name[PL_scopestack_ix-1] = name; \
d343c3ef
GG
211 DEBUG_SCOPE("ENTER \"" name "\"") \
212 } STMT_END
213#define LEAVE_with_name(name) \
214 STMT_START { \
215 DEBUG_SCOPE("LEAVE \"" name "\"") \
a09dc31d
NC
216 if (PL_scopestack_name) { \
217 assert(((char*)PL_scopestack_name[PL_scopestack_ix-1] \
218 == (char*)name) \
219 || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name)); \
220 } \
d343c3ef
GG
221 pop_scope(); \
222 } STMT_END
f46d017c 223#else
a0d0e21e
LW
224#define ENTER push_scope()
225#define LEAVE pop_scope()
d343c3ef
GG
226#define ENTER_with_name(name) ENTER
227#define LEAVE_with_name(name) LEAVE
f46d017c 228#endif
d699ecb7
FC
229#define LEAVE_SCOPE(old) STMT_START { \
230 if (PL_savestack_ix > old) leave_scope(old); \
231 } STMT_END
a0d0e21e 232
3f26ef39
NC
233#define SAVEI8(i) save_I8((I8*)&(i))
234#define SAVEI16(i) save_I16((I16*)&(i))
235#define SAVEI32(i) save_I32((I32*)&(i))
236#define SAVEINT(i) save_int((int*)&(i))
237#define SAVEIV(i) save_iv((IV*)&(i))
238#define SAVELONG(l) save_long((long*)&(l))
02644217 239#define SAVEBOOL(b) save_bool(&(b))
55497cff 240#define SAVESPTR(s) save_sptr((SV**)&(s))
3f26ef39 241#define SAVEPPTR(s) save_pptr((char**)&(s))
57b2e452 242#define SAVEVPTR(s) save_vptr((void*)&(s))
09edbca0 243#define SAVEPADSVANDMORTALIZE(s) save_padsv_and_mortalize(s)
b1bc3f34 244#define SAVEFREESV(s) save_freesv(MUTABLE_SV(s))
0f94cb1f 245#define SAVEFREEPADNAME(s) save_pushptr((void *)(s), SAVEt_FREEPADNAME)
b1bc3f34 246#define SAVEMORTALIZESV(s) save_mortalizesv(MUTABLE_SV(s))
3f26ef39
NC
247#define SAVEFREEOP(o) save_freeop((OP*)(o))
248#define SAVEFREEPV(p) save_freepv((char*)(p))
249#define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
b9d12d37 250#define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
f4dd75d9 251#define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
05ec9bb3 252#define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
14f338dc 253#define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
3987a177 254#define SAVEFREECOPHH(h) save_pushptr((void *)(h), SAVEt_FREECOPHH)
55497cff 255#define SAVEDELETE(h,k,l) \
dbebbdb4 256 save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
af097752
VP
257#define SAVEHDELETE(h,s) \
258 save_hdelete(MUTABLE_HV(h), (s))
c68ec7a9 259#define SAVEADELETE(a,k) \
c70927a6 260 save_adelete(MUTABLE_AV(a), (SSize_t)(k))
55497cff 261#define SAVEDESTRUCTOR(f,p) \
3f26ef39 262 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
c76ac1ee
GS
263
264#define SAVEDESTRUCTOR_X(f,p) \
3f26ef39 265 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
25eaa213
GS
266
267#define SAVESTACK_POS() \
a3444cc5
DM
268 STMT_START { \
269 dSS_ADD; \
270 SS_ADD_INT(PL_stack_sp - PL_stack_base); \
271 SS_ADD_UV(SAVEt_STACK_POS); \
272 SS_ADD_END(2); \
25eaa213
GS
273 } STMT_END
274
462e5cf6 275#define SAVEOP() save_op()
25eaa213 276
da8315f8 277#define SAVEHINTS() save_hints()
354992b1 278
9c47725a 279#define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
a9332b4a 280
8b7059b1
DM
281#define SAVESWITCHSTACK(f,t) \
282 STMT_START { \
dfcd3de5 283 save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
8b7059b1
DM
284 SWITCHSTACK((f),(t)); \
285 PL_curstackinfo->si_stack = (t); \
286 } STMT_END
287
c88c823b 288/* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
72dc9ed5
NC
289 because realloc() means that the value can actually change. Possibly
290 could have done savefreesharedpvREF, but this way actually seems cleaner,
291 as it simplifies the code that does the saves, and reduces the load on the
292 save stack. */
747e2fae 293#define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
fc15ae8f 294
747e2fae 295#define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
7c197c94 296
57843af0 297#ifdef USE_ITHREADS
d4d03940 298# define SAVECOPSTASH_FREE(c) SAVEIV((c)->cop_stashoff)
1dc74fdb
FC
299# define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
300# define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
57843af0 301#else
61b3e50d
FC
302# /* XXX not refcounted */
303# define SAVECOPSTASH_FREE(c) SAVESPTR(CopSTASH(c))
f4dd75d9
GS
304# define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
305# define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
57843af0
GS
306#endif
307
dea28490 308#define SAVECOPLINE(c) SAVEI32(CopLINE(c))
57843af0 309
455ece5e
AD
310/* SSNEW() temporarily allocates a specified number of bytes of data on the
311 * savestack. It returns an integer index into the savestack, because a
312 * pointer would get broken if the savestack is moved on reallocation.
313 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
314 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
486ec47a 315 * alignment will be preserved through savestack reallocation *only* if
a0288114 316 * realloc returns data aligned to a size divisible by "align"!
455ece5e
AD
317 *
318 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
319 */
320
f2b2c1a7 321#define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
02db2b7b 322#define SSNEWt(n,t) SSNEW((n)*sizeof(t))
f2b2c1a7 323#define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
6b99f28a 324 (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
02db2b7b 325#define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
455ece5e 326
02db2b7b
IZ
327#define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
328#define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off))
455ece5e 329
2fd8beea
NC
330#define save_freesv(op) save_pushptr((void *)(op), SAVEt_FREESV)
331#define save_mortalizesv(op) save_pushptr((void *)(op), SAVEt_MORTALIZESV)
6702ba93 332
bb38a9e0 333# define save_freeop(op) \
6702ba93 334STMT_START { \
bb38a9e0 335 OP * const _o = (OP *)(op); \
6c7ae946 336 assert(!_o->op_savefree); \
bb38a9e0
FC
337 _o->op_savefree = 1; \
338 save_pushptr((void *)(_o), SAVEt_FREEOP); \
6702ba93 339 } STMT_END
2fd8beea
NC
340#define save_freepv(pv) save_pushptr((void *)(pv), SAVEt_FREEPV)
341#define save_op() save_pushptr((void *)(PL_op), SAVEt_OP)
342
e9a8c099 343/*
14d04a33 344 * ex: set ts=8 sts=4 sw=4 et:
e9a8c099 345 */