3 * Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2004, 2005 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 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
55 #ifndef SCOPE_SAVES_SIGNAL_MASK
56 #define SCOPE_SAVES_SIGNAL_MASK 0
59 #define SSCHECK(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow()
60 #define SSGROW(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow_cnt(need)
61 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
62 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
63 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
64 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
65 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
66 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
67 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
68 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
69 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
70 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
71 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
72 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
73 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
74 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
77 =head1 Callback Functions
79 =for apidoc Ams||SAVETMPS
80 Opening bracket for temporaries on a callback. See C<FREETMPS> and
83 =for apidoc Ams||FREETMPS
84 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
87 =for apidoc Ams||ENTER
88 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
90 =for apidoc Ams||LEAVE
91 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
96 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
97 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
103 DEBUG_SCOPE("ENTER") \
107 DEBUG_SCOPE("LEAVE") \
111 #define ENTER push_scope()
112 #define LEAVE pop_scope()
114 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
116 #define SAVEI8(i) save_I8((I8*)&(i))
117 #define SAVEI16(i) save_I16((I16*)&(i))
118 #define SAVEI32(i) save_I32((I32*)&(i))
119 #define SAVEINT(i) save_int((int*)&(i))
120 #define SAVEIV(i) save_iv((IV*)&(i))
121 #define SAVELONG(l) save_long((long*)&(l))
122 #define SAVEBOOL(b) save_bool((bool*)&(b))
123 #define SAVESPTR(s) save_sptr((SV**)&(s))
124 #define SAVEPPTR(s) save_pptr((char**)&(s))
125 #define SAVEVPTR(s) save_vptr((void*)&(s))
126 #define SAVEPADSV(s) save_padsv(s)
127 #define SAVEFREESV(s) save_freesv((SV*)(s))
128 #define SAVEMORTALIZESV(s) save_mortalizesv((SV*)(s))
129 #define SAVEFREEOP(o) save_freeop((OP*)(o))
130 #define SAVEFREEPV(p) save_freepv((char*)(p))
131 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
132 #define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
133 #define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
134 #define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
135 #define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
136 #define SAVEDELETE(h,k,l) \
137 save_delete((HV*)(h), (char*)(k), (I32)(l))
138 #define SAVEDESTRUCTOR(f,p) \
139 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
141 #define SAVEDESTRUCTOR_X(f,p) \
142 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
144 #define SAVESTACK_POS() \
147 SSPUSHINT(PL_stack_sp - PL_stack_base); \
148 SSPUSHINT(SAVEt_STACK_POS); \
151 #define SAVEOP() save_op()
153 #define SAVEHINTS() \
156 if (PL_hints & HINT_LOCALIZE_HH) { \
157 SSPUSHPTR(GvHV(PL_hintgv)); \
158 GvHV(PL_hintgv) = Perl_hv_copy_hints_hv(aTHX_ GvHV(PL_hintgv)); \
160 if (PL_compiling.cop_hints) { \
162 PL_compiling.cop_hints->refcounted_he_refcnt++; \
163 HINTS_REFCNT_UNLOCK; \
165 SSPUSHPTR(PL_compiling.cop_hints); \
166 SSPUSHINT(PL_hints); \
167 SSPUSHINT(SAVEt_HINTS); \
170 #define SAVECOMPPAD() \
173 SSPUSHPTR((SV*)PL_comppad); \
174 SSPUSHINT(SAVEt_COMPPAD); \
177 #define SAVESWITCHSTACK(f,t) \
180 SSPUSHPTR((SV*)(f)); \
181 SSPUSHPTR((SV*)(t)); \
182 SSPUSHINT(SAVEt_SAVESWITCHSTACK); \
183 SWITCHSTACK((f),(t)); \
184 PL_curstackinfo->si_stack = (t); \
187 #define SAVECOPARYBASE(c) \
190 SSPUSHINT(CopARYBASE_get(c)); \
192 SSPUSHINT(SAVEt_COP_ARYBASE); \
197 # define SAVECOPSTASH(c) SAVEPPTR(CopSTASHPV(c))
198 # define SAVECOPSTASH_FREE(c) SAVESHAREDPV(CopSTASHPV(c))
199 # define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
200 # define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
202 # define SAVECOPSTASH(c) SAVESPTR(CopSTASH(c))
203 # define SAVECOPSTASH_FREE(c) SAVECOPSTASH(c) /* XXX not refcounted */
204 # define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
205 # define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
208 #define SAVECOPLINE(c) SAVEI32(CopLINE(c))
210 /* SSNEW() temporarily allocates a specified number of bytes of data on the
211 * savestack. It returns an integer index into the savestack, because a
212 * pointer would get broken if the savestack is moved on reallocation.
213 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
214 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
215 * alignment will be preserved therough savestack reallocation *only* if
216 * realloc returns data aligned to a size divisible by "align"!
218 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
221 #define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
222 #define SSNEWt(n,t) SSNEW((n)*sizeof(t))
223 #define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
224 (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
225 #define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
227 #define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
228 #define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off))