3 * Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
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.
11 /* *** Update arg_counts[] in scope.c if you modify these */
16 #define SAVEt_CLEARPADRANGE 1
17 #define SAVEt_CLEARSV 2
18 #define SAVEt_REGCONTEXT 3
22 #define SAVEt_TMPSFLOOR 4
24 #define SAVEt_COMPILE_WARNINGS 6
25 #define SAVEt_COMPPAD 7
26 #define SAVEt_FREECOPHH 8
27 #define SAVEt_FREEOP 9
28 #define SAVEt_FREEPV 10
29 #define SAVEt_FREESV 11
31 #define SAVEt_I32_SMALL 13
33 #define SAVEt_INT_SMALL 15
34 #define SAVEt_MORTALIZESV 16
35 #define SAVEt_NSTAB 17
37 #define SAVEt_PARSER 19
38 #define SAVEt_STACK_POS 20
39 #define SAVEt_READONLY_OFF 21
40 #define SAVEt_FREEPADNAME 22
45 #define SAVEt_DESTRUCTOR 24
46 #define SAVEt_DESTRUCTOR_X 25
47 #define SAVEt_GENERIC_PVREF 26
48 #define SAVEt_GENERIC_SVREF 27
51 #define SAVEt_HINTS 30
60 #define SAVEt_SAVESWITCHSTACK 39
61 #define SAVEt_SHARED_PVREF 40
63 #define SAVEt_STRLEN 42
65 #define SAVEt_SVREF 44
67 #define SAVEt_ADELETE 46
72 #define SAVEt_HELEM 48
73 #define SAVEt_PADSV_AND_MORTALIZE 49
74 #define SAVEt_SET_SVFLAGS 50
75 #define SAVEt_GVSLOT 51
76 #define SAVEt_AELEM 52
77 #define SAVEt_DELETE 53
80 #define SAVEf_SETMAGIC 1
81 #define SAVEf_KEEPOLDELEM 2
83 #define SAVE_TIGHT_SHIFT 6
84 #define SAVE_MASK 0x3F
86 #define save_aelem(av,idx,sptr) save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
87 #define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
89 #ifndef SCOPE_SAVES_SIGNAL_MASK
90 #define SCOPE_SAVES_SIGNAL_MASK 0
93 /* the maximum number of entries that might be pushed using the SS_ADD*
97 #define SSCHECK(need) if (UNLIKELY(PL_savestack_ix + (I32)(need) > PL_savestack_max)) savestack_grow()
98 #define SSGROW(need) if (UNLIKELY(PL_savestack_ix + (I32)(need) > PL_savestack_max)) savestack_grow_cnt(need)
99 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
100 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
101 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
102 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
103 #define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
104 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
105 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
106 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
108 /* SS_ADD*: newer, faster versions of the above. Don't mix the two sets of
109 * macros. These are fast because they save reduce accesses to the PL_
110 * vars and move the size check to the end. Doing the check last means
111 * that values in registers will have been pushed and no longer needed, so
112 * don't need saving around the call to grow. Also, tail-call elimination
113 * of the grow() can be done. These changes reduce the code of something
114 * like save_pushptrptr() to half its former size.
115 * Of course, doing the size check *after* pushing means we must always
116 * ensure there are SS_MAXPUSH free slots on the savestack. This ensured
117 * bt savestack_grow() and savestack_grow_cnt always allocating SS_MAXPUSH
118 * slots more than asked for, or that it sets PL_savestack_max to
120 * These are for internal core use only and are subject to change */
123 I32 ix = PL_savestack_ix; \
124 ANY *ssp = &PL_savestack[ix]
126 #define SS_ADD_END(need) \
127 assert((need) <= SS_MAXPUSH); \
129 PL_savestack_ix = ix; \
130 assert(ix <= PL_savestack_max + SS_MAXPUSH); \
131 if (UNLIKELY(ix > PL_savestack_max)) savestack_grow(); \
132 assert(PL_savestack_ix <= PL_savestack_max);
134 #define SS_ADD_INT(i) ((ssp++)->any_i32 = (I32)(i))
135 #define SS_ADD_LONG(i) ((ssp++)->any_long = (long)(i))
136 #define SS_ADD_BOOL(p) ((ssp++)->any_bool = (p))
137 #define SS_ADD_IV(i) ((ssp++)->any_iv = (IV)(i))
138 #define SS_ADD_UV(u) ((ssp++)->any_uv = (UV)(u))
139 #define SS_ADD_PTR(p) ((ssp++)->any_ptr = (void*)(p))
140 #define SS_ADD_DPTR(p) ((ssp++)->any_dptr = (p))
141 #define SS_ADD_DXPTR(p) ((ssp++)->any_dxptr = (p))
143 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
144 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
145 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
146 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
147 #define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
148 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
149 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
150 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
154 =head1 Callback Functions
156 =for apidoc Amns||SAVETMPS
157 Opening bracket for temporaries on a callback. See C<L</FREETMPS>> and
160 =for apidoc Amns||FREETMPS
161 Closing bracket for temporaries on a callback. See C<L</SAVETMPS>> and
164 =for apidoc Amns||ENTER
165 Opening bracket on a callback. See C<L</LEAVE>> and L<perlcall>.
167 =for apidoc Amns||LEAVE
168 Closing bracket on a callback. See C<L</ENTER>> and L<perlcall>.
170 =for apidoc Ams||ENTER_with_name|"name"
172 Same as C<L</ENTER>>, but when debugging is enabled it also associates the
173 given literal string with the new scope.
175 =for apidoc Ams||LEAVE_with_name|"name"
177 Same as C<L</LEAVE>>, but when debugging is enabled it first checks that the
178 scope has the given name. C<name> must be a literal string.
183 #define SAVETMPS Perl_savetmps(aTHX)
185 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
191 DEBUG_SCOPE("ENTER") \
195 DEBUG_SCOPE("LEAVE") \
198 #define ENTER_with_name(name) \
201 if (PL_scopestack_name) \
202 PL_scopestack_name[PL_scopestack_ix-1] = name; \
203 DEBUG_SCOPE("ENTER \"" name "\"") \
205 #define LEAVE_with_name(name) \
207 DEBUG_SCOPE("LEAVE \"" name "\"") \
208 if (PL_scopestack_name) { \
209 assert(((char*)PL_scopestack_name[PL_scopestack_ix-1] \
211 || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name)); \
216 #define ENTER push_scope()
217 #define LEAVE pop_scope()
218 #define ENTER_with_name(name) ENTER
219 #define LEAVE_with_name(name) LEAVE
221 #define LEAVE_SCOPE(old) STMT_START { \
222 if (PL_savestack_ix > old) leave_scope(old); \
225 #define SAVEI8(i) save_I8((I8*)&(i))
226 #define SAVEI16(i) save_I16((I16*)&(i))
227 #define SAVEI32(i) save_I32((I32*)&(i))
228 #define SAVEINT(i) save_int((int*)&(i))
229 #define SAVEIV(i) save_iv((IV*)&(i))
230 #define SAVELONG(l) save_long((long*)&(l))
231 #define SAVEBOOL(b) save_bool(&(b))
232 #define SAVESPTR(s) save_sptr((SV**)&(s))
233 #define SAVEPPTR(s) save_pptr((char**)&(s))
234 #define SAVEVPTR(s) save_vptr((void*)&(s))
235 #define SAVEPADSVANDMORTALIZE(s) save_padsv_and_mortalize(s)
236 #define SAVEFREESV(s) save_freesv(MUTABLE_SV(s))
237 #define SAVEFREEPADNAME(s) save_pushptr((void *)(s), SAVEt_FREEPADNAME)
238 #define SAVEMORTALIZESV(s) save_mortalizesv(MUTABLE_SV(s))
239 #define SAVEFREEOP(o) save_freeop((OP*)(o))
240 #define SAVEFREEPV(p) save_freepv((char*)(p))
241 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
242 #define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
243 #define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
244 #define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
245 #define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
246 #define SAVEFREECOPHH(h) save_pushptr((void *)(h), SAVEt_FREECOPHH)
247 #define SAVEDELETE(h,k,l) \
248 save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
249 #define SAVEHDELETE(h,s) \
250 save_hdelete(MUTABLE_HV(h), (s))
251 #define SAVEADELETE(a,k) \
252 save_adelete(MUTABLE_AV(a), (SSize_t)(k))
253 #define SAVEDESTRUCTOR(f,p) \
254 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
256 #define SAVEDESTRUCTOR_X(f,p) \
257 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
259 #define SAVESTACK_POS() \
262 SS_ADD_INT(PL_stack_sp - PL_stack_base); \
263 SS_ADD_UV(SAVEt_STACK_POS); \
267 #define SAVEOP() save_op()
269 #define SAVEHINTS() save_hints()
271 #define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
273 #define SAVESWITCHSTACK(f,t) \
275 save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
276 SWITCHSTACK((f),(t)); \
277 PL_curstackinfo->si_stack = (t); \
280 /* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
281 because realloc() means that the value can actually change. Possibly
282 could have done savefreesharedpvREF, but this way actually seems cleaner,
283 as it simplifies the code that does the saves, and reduces the load on the
285 #define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
287 #define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
290 # define SAVECOPSTASH_FREE(c) SAVEIV((c)->cop_stashoff)
291 # define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
292 # define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
294 # /* XXX not refcounted */
295 # define SAVECOPSTASH_FREE(c) SAVESPTR(CopSTASH(c))
296 # define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
297 # define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
300 #define SAVECOPLINE(c) SAVEI32(CopLINE(c))
302 /* SSNEW() temporarily allocates a specified number of bytes of data on the
303 * savestack. It returns an I32 index into the savestack, because a
304 * pointer would get broken if the savestack is moved on reallocation.
305 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
306 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
307 * alignment will be preserved through savestack reallocation *only* if
308 * realloc returns data aligned to a size divisible by "align"!
310 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
313 #define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
314 #define SSNEWt(n,t) SSNEW((n)*sizeof(t))
315 #define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
316 (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
317 #define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
319 #define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
320 #define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off))
322 #define save_freesv(op) save_pushptr((void *)(op), SAVEt_FREESV)
323 #define save_mortalizesv(op) save_pushptr((void *)(op), SAVEt_MORTALIZESV)
325 # define save_freeop(op) \
327 OP * const _o = (OP *)(op); \
328 assert(!_o->op_savefree); \
329 _o->op_savefree = 1; \
330 save_pushptr((void *)(_o), SAVEt_FREEOP); \
332 #define save_freepv(pv) save_pushptr((void *)(pv), SAVEt_FREEPV)
333 #define save_op() save_pushptr((void *)(PL_op), SAVEt_OP)
336 * ex: set ts=8 sts=4 sw=4 et: