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
53 #ifndef SCOPE_SAVES_SIGNAL_MASK
54 #define SCOPE_SAVES_SIGNAL_MASK 0
57 #define SSCHECK(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow()
58 #define SSGROW(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow_cnt(need)
59 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
60 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
61 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
62 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
63 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
64 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
65 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
66 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
67 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
68 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
69 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
70 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
71 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
72 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
75 =head1 Callback Functions
77 =for apidoc Ams||SAVETMPS
78 Opening bracket for temporaries on a callback. See C<FREETMPS> and
81 =for apidoc Ams||FREETMPS
82 Closing bracket for temporaries on a callback. See C<SAVETMPS> and
85 =for apidoc Ams||ENTER
86 Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
88 =for apidoc Ams||LEAVE
89 Closing bracket on a callback. See C<ENTER> and L<perlcall>.
94 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
95 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
101 DEBUG_SCOPE("ENTER") \
105 DEBUG_SCOPE("LEAVE") \
109 #define ENTER push_scope()
110 #define LEAVE pop_scope()
112 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
114 #define SAVEI8(i) save_I8((I8*)&(i))
115 #define SAVEI16(i) save_I16((I16*)&(i))
116 #define SAVEI32(i) save_I32((I32*)&(i))
117 #define SAVEINT(i) save_int((int*)&(i))
118 #define SAVEIV(i) save_iv((IV*)&(i))
119 #define SAVELONG(l) save_long((long*)&(l))
120 #define SAVEBOOL(b) save_bool((bool*)&(b))
121 #define SAVESPTR(s) save_sptr((SV**)&(s))
122 #define SAVEPPTR(s) save_pptr((char**)&(s))
123 #define SAVEVPTR(s) save_vptr((void*)&(s))
124 #define SAVEPADSV(s) save_padsv(s)
125 #define SAVEFREESV(s) save_freesv((SV*)(s))
126 #define SAVEMORTALIZESV(s) save_mortalizesv((SV*)(s))
127 #define SAVEFREEOP(o) save_freeop((OP*)(o))
128 #define SAVEFREEPV(p) save_freepv((char*)(p))
129 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
130 #define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
131 #define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
132 #define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
133 #define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
134 #define SAVEDELETE(h,k,l) \
135 save_delete((HV*)(h), (char*)(k), (I32)(l))
136 #define SAVEDESTRUCTOR(f,p) \
137 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
139 #define SAVEDESTRUCTOR_X(f,p) \
140 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
142 #define SAVESTACK_POS() \
145 SSPUSHINT(PL_stack_sp - PL_stack_base); \
146 SSPUSHINT(SAVEt_STACK_POS); \
149 #define SAVEOP() save_op()
151 #define SAVEHINTS() \
154 if (PL_hints & HINT_LOCALIZE_HH) { \
155 SSPUSHPTR(GvHV(PL_hintgv)); \
156 GvHV(PL_hintgv) = newHVhv(GvHV(PL_hintgv)); \
158 if (PL_compiling.cop_hints) { \
159 PL_compiling.cop_hints->refcounted_he_refcnt++; \
161 SSPUSHPTR(PL_compiling.cop_hints); \
162 SSPUSHINT(PL_hints); \
163 SSPUSHINT(SAVEt_HINTS); \
166 #define SAVECOMPPAD() \
169 SSPUSHPTR((SV*)PL_comppad); \
170 SSPUSHINT(SAVEt_COMPPAD); \
173 #define SAVESWITCHSTACK(f,t) \
176 SSPUSHPTR((SV*)(f)); \
177 SSPUSHPTR((SV*)(t)); \
178 SSPUSHINT(SAVEt_SAVESWITCHSTACK); \
179 SWITCHSTACK((f),(t)); \
180 PL_curstackinfo->si_stack = (t); \
184 # define SAVECOPSTASH(c) SAVEPPTR(CopSTASHPV(c))
185 # define SAVECOPSTASH_FREE(c) SAVESHAREDPV(CopSTASHPV(c))
186 # define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
187 # define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
189 # define SAVECOPSTASH(c) SAVESPTR(CopSTASH(c))
190 # define SAVECOPSTASH_FREE(c) SAVECOPSTASH(c) /* XXX not refcounted */
191 # define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
192 # define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
195 #define SAVECOPLINE(c) SAVEI32(CopLINE(c))
197 /* SSNEW() temporarily allocates a specified number of bytes of data on the
198 * savestack. It returns an integer index into the savestack, because a
199 * pointer would get broken if the savestack is moved on reallocation.
200 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
201 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
202 * alignment will be preserved therough savestack reallocation *only* if
203 * realloc returns data aligned to a size divisible by "align"!
205 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
208 #define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
209 #define SSNEWt(n,t) SSNEW((n)*sizeof(t))
210 #define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
211 (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
212 #define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
214 #define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
215 #define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off))