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.
23 #define SAVEt_NSTAB 12
24 #define SAVEt_SVREF 13
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
35 #define SAVEt_AELEM 24
36 #define SAVEt_HELEM 25
38 #define SAVEt_HINTS 27
39 #define SAVEt_ALLOC 28
40 #define SAVEt_GENERIC_SVREF 29
41 #define SAVEt_DESTRUCTOR_X 30
44 #define SAVEt_COMPPAD 33
45 #define SAVEt_GENERIC_PVREF 34
46 #define SAVEt_PADSV_AND_MORTALIZE 35
47 #define SAVEt_MORTALIZESV 36
48 #define SAVEt_SHARED_PVREF 37
50 #define SAVEt_SET_SVFLAGS 39
51 #define SAVEt_SAVESWITCHSTACK 40
52 #define SAVEt_COP_ARYBASE 41
53 #define SAVEt_RE_STATE 42
54 #define SAVEt_COMPILE_WARNINGS 43
55 #define SAVEt_STACK_CXPOS 44
56 #define SAVEt_PARSER 45
57 #define SAVEt_ADELETE 46
58 #define SAVEt_I32_SMALL 47
60 #define SAVEf_SETMAGIC 1
61 #define SAVEf_KEEPOLDELEM 2
63 #define SAVE_TIGHT_SHIFT 6
64 #define SAVE_MASK 0x3F
66 #define save_aelem(av,idx,sptr) save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
67 #define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
69 #ifndef SCOPE_SAVES_SIGNAL_MASK
70 #define SCOPE_SAVES_SIGNAL_MASK 0
73 #define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
74 #define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
75 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
76 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
77 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
78 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
79 #define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
80 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
81 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
82 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
83 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
84 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
85 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
86 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
87 #define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
88 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
89 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
90 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
93 =head1 Callback Functions
95 =for apidoc Ams||SAVETMPS
96 Opening bracket for temporaries on a callback. See C<FREETMPS> and
99 =for apidoc Ams||FREETMPS
100 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
103 =for apidoc Ams||ENTER
104 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
106 =for apidoc Ams||LEAVE
107 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
111 =item ENTER_with_name(name)
113 Same as C<ENTER>, but when debugging is enabled it also associates the
114 given literal string with the new scope.
116 =item LEAVE_with_name(name)
118 Same as C<LEAVE>, but when debugging is enabled it first checks that the
119 scope has the given name. Name must be a literal string.
126 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
127 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
133 DEBUG_SCOPE("ENTER") \
137 DEBUG_SCOPE("LEAVE") \
140 #define ENTER_with_name(name) \
143 if (PL_scopestack_name) \
144 PL_scopestack_name[PL_scopestack_ix-1] = name; \
145 DEBUG_SCOPE("ENTER \"" name "\"") \
147 #define LEAVE_with_name(name) \
149 DEBUG_SCOPE("LEAVE \"" name "\"") \
150 if (PL_scopestack_name) { \
151 assert(((char*)PL_scopestack_name[PL_scopestack_ix-1] \
153 || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name)); \
158 #define ENTER push_scope()
159 #define LEAVE pop_scope()
160 #define ENTER_with_name(name) ENTER
161 #define LEAVE_with_name(name) LEAVE
163 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
165 #define SAVEI8(i) save_I8((I8*)&(i))
166 #define SAVEI16(i) save_I16((I16*)&(i))
167 #define SAVEI32(i) save_I32((I32*)&(i))
168 #define SAVEINT(i) save_int((int*)&(i))
169 #define SAVEIV(i) save_iv((IV*)&(i))
170 #define SAVELONG(l) save_long((long*)&(l))
171 #define SAVEBOOL(b) save_bool(&(b))
172 #define SAVESPTR(s) save_sptr((SV**)&(s))
173 #define SAVEPPTR(s) save_pptr((char**)&(s))
174 #define SAVEVPTR(s) save_vptr((void*)&(s))
175 #define SAVEPADSVANDMORTALIZE(s) save_padsv_and_mortalize(s)
176 #define SAVEFREESV(s) save_freesv(MUTABLE_SV(s))
177 #define SAVEMORTALIZESV(s) save_mortalizesv(MUTABLE_SV(s))
178 #define SAVEFREEOP(o) save_freeop((OP*)(o))
179 #define SAVEFREEPV(p) save_freepv((char*)(p))
180 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
181 #define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
182 #define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
183 #define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
184 #define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
185 #define SAVEDELETE(h,k,l) \
186 save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
187 #define SAVEHDELETE(h,s) \
188 save_hdelete(MUTABLE_HV(h), (s))
189 #define SAVEADELETE(a,k) \
190 save_adelete(MUTABLE_AV(a), (I32)(k))
191 #define SAVEDESTRUCTOR(f,p) \
192 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
194 #define SAVEDESTRUCTOR_X(f,p) \
195 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
197 #define SAVESTACK_POS() \
200 SSPUSHINT(PL_stack_sp - PL_stack_base); \
201 SSPUSHUV(SAVEt_STACK_POS); \
204 #define SAVEOP() save_op()
206 #define SAVEHINTS() save_hints()
208 #define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
210 #define SAVESWITCHSTACK(f,t) \
212 save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
213 SWITCHSTACK((f),(t)); \
214 PL_curstackinfo->si_stack = (t); \
217 #define SAVECOPARYBASE(c) save_pushi32ptr(CopARYBASE_get(c), c, SAVEt_COP_ARYBASE);
219 /* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
220 because realloc() means that the value can actually change. Possibly
221 could have done savefreesharedpvREF, but this way actually seems cleaner,
222 as it simplifies the code that does the saves, and reduces the load on the
224 #define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
226 #define SAVESTACK_CXPOS() \
229 SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
230 SSPUSHINT(cxstack_ix); \
231 SSPUSHUV(SAVEt_STACK_CXPOS); \
234 #define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
237 # define SAVECOPSTASH(c) SAVEPPTR(CopSTASHPV(c))
238 # define SAVECOPSTASH_FREE(c) SAVESHAREDPV(CopSTASHPV(c))
239 # define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
240 # define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
242 # define SAVECOPSTASH(c) SAVESPTR(CopSTASH(c))
243 # define SAVECOPSTASH_FREE(c) SAVECOPSTASH(c) /* XXX not refcounted */
244 # define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
245 # define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
248 #define SAVECOPLINE(c) SAVEI32(CopLINE(c))
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
255 * alignment will be preserved therough savestack reallocation *only* if
256 * realloc returns data aligned to a size divisible by "align"!
258 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
261 #define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
262 #define SSNEWt(n,t) SSNEW((n)*sizeof(t))
263 #define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
264 (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
265 #define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
267 #define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
268 #define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off))
270 #define save_freesv(op) save_pushptr((void *)(op), SAVEt_FREESV)
271 #define save_mortalizesv(op) save_pushptr((void *)(op), SAVEt_MORTALIZESV)
272 #define save_freeop(op) save_pushptr((void *)(op), SAVEt_FREEOP)
273 #define save_freepv(pv) save_pushptr((void *)(pv), SAVEt_FREEPV)
274 #define save_op() save_pushptr((void *)(PL_op), SAVEt_OP)
278 * c-indentation-style: bsd
280 * indent-tabs-mode: t
283 * ex: set ts=8 sts=4 sw=4 noet: