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_RE_STATE 42
53 #define SAVEt_COMPILE_WARNINGS 43
54 #define SAVEt_STACK_CXPOS 44
55 #define SAVEt_PARSER 45
56 #define SAVEt_ADELETE 46
57 #define SAVEt_I32_SMALL 47
58 #define SAVEt_INT_SMALL 48
60 #define SAVEt_FREECOPHH 50
61 #define SAVEt_CLEARPADRANGE 51
63 #define SAVEf_SETMAGIC 1
64 #define SAVEf_KEEPOLDELEM 2
66 #define SAVE_TIGHT_SHIFT 6
67 #define SAVE_MASK 0x3F
69 #define save_aelem(av,idx,sptr) save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
70 #define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
72 #ifndef SCOPE_SAVES_SIGNAL_MASK
73 #define SCOPE_SAVES_SIGNAL_MASK 0
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)
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))
80 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
81 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
82 #define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
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))
85 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
86 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
87 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
88 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
89 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
90 #define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
91 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
92 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
93 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
96 =head1 Callback Functions
98 =for apidoc Ams||SAVETMPS
99 Opening bracket for temporaries on a callback. See C<FREETMPS> and
102 =for apidoc Ams||FREETMPS
103 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
106 =for apidoc Ams||ENTER
107 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
109 =for apidoc Ams||LEAVE
110 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
114 =item ENTER_with_name(name)
116 Same as C<ENTER>, but when debugging is enabled it also associates the
117 given literal string with the new scope.
119 =item LEAVE_with_name(name)
121 Same as C<LEAVE>, but when debugging is enabled it first checks that the
122 scope has the given name. Name must be a literal string.
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()
136 DEBUG_SCOPE("ENTER") \
140 DEBUG_SCOPE("LEAVE") \
143 #define ENTER_with_name(name) \
146 if (PL_scopestack_name) \
147 PL_scopestack_name[PL_scopestack_ix-1] = name; \
148 DEBUG_SCOPE("ENTER \"" name "\"") \
150 #define LEAVE_with_name(name) \
152 DEBUG_SCOPE("LEAVE \"" name "\"") \
153 if (PL_scopestack_name) { \
154 assert(((char*)PL_scopestack_name[PL_scopestack_ix-1] \
156 || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name)); \
161 #define ENTER push_scope()
162 #define LEAVE pop_scope()
163 #define ENTER_with_name(name) ENTER
164 #define LEAVE_with_name(name) LEAVE
166 #define LEAVE_SCOPE(old) STMT_START { \
167 if (PL_savestack_ix > old) leave_scope(old); \
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))
176 #define SAVEBOOL(b) save_bool(&(b))
177 #define SAVESPTR(s) save_sptr((SV**)&(s))
178 #define SAVEPPTR(s) save_pptr((char**)&(s))
179 #define SAVEVPTR(s) save_vptr((void*)&(s))
180 #define SAVEPADSVANDMORTALIZE(s) save_padsv_and_mortalize(s)
181 #define SAVEFREESV(s) save_freesv(MUTABLE_SV(s))
182 #define SAVEMORTALIZESV(s) save_mortalizesv(MUTABLE_SV(s))
183 #define SAVEFREEOP(o) save_freeop((OP*)(o))
184 #define SAVEFREEPV(p) save_freepv((char*)(p))
185 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
186 #define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
187 #define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
188 #define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
189 #define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
190 #define SAVEFREECOPHH(h) save_pushptr((void *)(h), SAVEt_FREECOPHH)
191 #define SAVEDELETE(h,k,l) \
192 save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
193 #define SAVEHDELETE(h,s) \
194 save_hdelete(MUTABLE_HV(h), (s))
195 #define SAVEADELETE(a,k) \
196 save_adelete(MUTABLE_AV(a), (I32)(k))
197 #define SAVEDESTRUCTOR(f,p) \
198 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
200 #define SAVEDESTRUCTOR_X(f,p) \
201 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
203 #define SAVESTACK_POS() \
206 SSPUSHINT(PL_stack_sp - PL_stack_base); \
207 SSPUSHUV(SAVEt_STACK_POS); \
210 #define SAVEOP() save_op()
212 #define SAVEHINTS() save_hints()
214 #define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
216 #define SAVESWITCHSTACK(f,t) \
218 save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
219 SWITCHSTACK((f),(t)); \
220 PL_curstackinfo->si_stack = (t); \
223 /* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
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
228 #define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
230 #define SAVESTACK_CXPOS() \
233 SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
234 SSPUSHINT(cxstack_ix); \
235 SSPUSHUV(SAVEt_STACK_CXPOS); \
238 #define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
241 # define SAVECOPSTASH_FREE(c) SAVEIV((c)->cop_stashoff)
242 # define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
243 # define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
245 # /* XXX not refcounted */
246 # define SAVECOPSTASH_FREE(c) SAVESPTR(CopSTASH(c))
247 # define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
248 # define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
251 #define SAVECOPLINE(c) SAVEI32(CopLINE(c))
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
258 * alignment will be preserved through savestack reallocation *only* if
259 * realloc returns data aligned to a size divisible by "align"!
261 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
264 #define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
265 #define SSNEWt(n,t) SSNEW((n)*sizeof(t))
266 #define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
267 (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
268 #define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
270 #define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
271 #define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off))
273 #define save_freesv(op) save_pushptr((void *)(op), SAVEt_FREESV)
274 #define save_mortalizesv(op) save_pushptr((void *)(op), SAVEt_MORTALIZESV)
276 # define save_freeop(op) \
278 OP * const _o = (OP *)(op); \
279 assert(!_o->op_savefree); \
280 _o->op_savefree = 1; \
281 save_pushptr((void *)(_o), SAVEt_FREEOP); \
283 #define save_freepv(pv) save_pushptr((void *)(pv), SAVEt_FREEPV)
284 #define save_op() save_pushptr((void *)(PL_op), SAVEt_OP)
288 * c-indentation-style: bsd
290 * indent-tabs-mode: nil
293 * ex: set ts=8 sts=4 sw=4 et: