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
59 #define SAVEf_SETMAGIC 1
60 #define SAVEf_KEEPOLDELEM 2
62 #define save_aelem(av,idx,sptr) save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
63 #define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
65 #ifndef SCOPE_SAVES_SIGNAL_MASK
66 #define SCOPE_SAVES_SIGNAL_MASK 0
69 #define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
70 #define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
71 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
72 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
73 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
74 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
75 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
76 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
77 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
78 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
79 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
80 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
81 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
82 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
83 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
84 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
87 =head1 Callback Functions
89 =for apidoc Ams||SAVETMPS
90 Opening bracket for temporaries on a callback. See C<FREETMPS> and
93 =for apidoc Ams||FREETMPS
94 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
97 =for apidoc Ams||ENTER
98 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
100 =for apidoc Ams||LEAVE
101 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
105 =item ENTER_with_name(name)
107 Same as C<ENTER>, but when debugging is enabled it also associates the
108 given literal string with the new scope.
110 =item LEAVE_with_name(name)
112 Same as C<LEAVE>, but when debugging is enabled it first checks that the
113 scope has the given name. Name must be a literal string.
120 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
121 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
127 DEBUG_SCOPE("ENTER") \
131 DEBUG_SCOPE("LEAVE") \
134 #define ENTER_with_name(name) \
137 PL_scopestack_name[PL_scopestack_ix-1] = name; \
138 DEBUG_SCOPE("ENTER \"" name "\"") \
140 #define LEAVE_with_name(name) \
142 DEBUG_SCOPE("LEAVE \"" name "\"") \
143 assert(((char*)PL_scopestack_name[PL_scopestack_ix-1] \
145 || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name)); \
149 #define ENTER push_scope()
150 #define LEAVE pop_scope()
151 #define ENTER_with_name(name) ENTER
152 #define LEAVE_with_name(name) LEAVE
154 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
156 #define SAVEI8(i) save_I8((I8*)&(i))
157 #define SAVEI16(i) save_I16((I16*)&(i))
158 #define SAVEI32(i) save_I32((I32*)&(i))
159 #define SAVEINT(i) save_int((int*)&(i))
160 #define SAVEIV(i) save_iv((IV*)&(i))
161 #define SAVELONG(l) save_long((long*)&(l))
162 #define SAVEBOOL(b) save_bool((bool*)&(b))
163 #define SAVESPTR(s) save_sptr((SV**)&(s))
164 #define SAVEPPTR(s) save_pptr((char**)&(s))
165 #define SAVEVPTR(s) save_vptr((void*)&(s))
166 #define SAVEPADSVANDMORTALIZE(s) save_padsv_and_mortalize(s)
167 #define SAVEFREESV(s) save_freesv(MUTABLE_SV(s))
168 #define SAVEMORTALIZESV(s) save_mortalizesv(MUTABLE_SV(s))
169 #define SAVEFREEOP(o) save_freeop((OP*)(o))
170 #define SAVEFREEPV(p) save_freepv((char*)(p))
171 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
172 #define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
173 #define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
174 #define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
175 #define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
176 #define SAVEDELETE(h,k,l) \
177 save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
178 #define SAVEHDELETE(h,s) \
179 save_hdelete(MUTABLE_HV(h), (s))
180 #define SAVEADELETE(a,k) \
181 save_adelete(MUTABLE_AV(a), (I32)(k))
182 #define SAVEDESTRUCTOR(f,p) \
183 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
185 #define SAVEDESTRUCTOR_X(f,p) \
186 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
188 #define SAVESTACK_POS() \
191 SSPUSHINT(PL_stack_sp - PL_stack_base); \
192 SSPUSHINT(SAVEt_STACK_POS); \
195 #define SAVEOP() save_op()
197 #define SAVEHINTS() save_hints()
199 #define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
201 #define SAVESWITCHSTACK(f,t) \
203 save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
204 SWITCHSTACK((f),(t)); \
205 PL_curstackinfo->si_stack = (t); \
208 #define SAVECOPARYBASE(c) save_pushi32ptr(CopARYBASE_get(c), c, SAVEt_COP_ARYBASE);
210 /* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
211 because realloc() means that the value can actually change. Possibly
212 could have done savefreesharedpvREF, but this way actually seems cleaner,
213 as it simplifies the code that does the saves, and reduces the load on the
215 #define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
217 #define SAVESTACK_CXPOS() \
220 SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
221 SSPUSHINT(cxstack_ix); \
222 SSPUSHINT(SAVEt_STACK_CXPOS); \
225 #define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
228 # define SAVECOPSTASH(c) SAVEPPTR(CopSTASHPV(c))
229 # define SAVECOPSTASH_FREE(c) SAVESHAREDPV(CopSTASHPV(c))
230 # define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
231 # define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
233 # define SAVECOPSTASH(c) SAVESPTR(CopSTASH(c))
234 # define SAVECOPSTASH_FREE(c) SAVECOPSTASH(c) /* XXX not refcounted */
235 # define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
236 # define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
239 #define SAVECOPLINE(c) SAVEI32(CopLINE(c))
241 /* SSNEW() temporarily allocates a specified number of bytes of data on the
242 * savestack. It returns an integer index into the savestack, because a
243 * pointer would get broken if the savestack is moved on reallocation.
244 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
245 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
246 * alignment will be preserved therough savestack reallocation *only* if
247 * realloc returns data aligned to a size divisible by "align"!
249 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
252 #define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
253 #define SSNEWt(n,t) SSNEW((n)*sizeof(t))
254 #define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
255 (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
256 #define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
258 #define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
259 #define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off))
261 #define save_freesv(op) save_pushptr((void *)(op), SAVEt_FREESV)
262 #define save_mortalizesv(op) save_pushptr((void *)(op), SAVEt_MORTALIZESV)
263 #define save_freeop(op) save_pushptr((void *)(op), SAVEt_FREEOP)
264 #define save_freepv(pv) save_pushptr((void *)(pv), SAVEt_FREEPV)
265 #define save_op() save_pushptr((void *)(PL_op), SAVEt_OP)
269 * c-indentation-style: bsd
271 * indent-tabs-mode: t
274 * ex: set ts=8 sts=4 sw=4 noet: