This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
For SAVEHINTS(), re-order the savestack to be (?:PTR, )? INT, PTR.
[perl5.git] / scope.h
1 /*    scope.h
2  *
3  *    Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999, 2000, 2001,
4  *    2002, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
5  *
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.
8  *
9  */
10
11 #define SAVEt_ITEM              0
12 #define SAVEt_SV                1
13 #define SAVEt_AV                2
14 #define SAVEt_HV                3
15 #define SAVEt_INT               4
16 #define SAVEt_LONG              5
17 #define SAVEt_I32               6
18 #define SAVEt_IV                7
19 #define SAVEt_SPTR              8
20 #define SAVEt_APTR              9
21 #define SAVEt_HPTR              10
22 #define SAVEt_PPTR              11
23 #define SAVEt_NSTAB             12
24 #define SAVEt_SVREF             13
25 #define SAVEt_GP                14
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
34 #define SAVEt_I16               23
35 #define SAVEt_AELEM             24
36 #define SAVEt_HELEM             25
37 #define SAVEt_OP                26
38 #define SAVEt_HINTS             27
39 #define SAVEt_ALLOC             28
40 #define SAVEt_GENERIC_SVREF     29
41 #define SAVEt_DESTRUCTOR_X      30
42 #define SAVEt_VPTR              31
43 #define SAVEt_I8                32
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
49 #define SAVEt_BOOL              38
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
58 #define SAVEf_SETMAGIC          1
59
60 #define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
61
62 #ifndef SCOPE_SAVES_SIGNAL_MASK
63 #define SCOPE_SAVES_SIGNAL_MASK 0
64 #endif
65
66 #define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
67 #define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
68 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
69 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
70 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
71 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
72 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
73 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
74 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
75 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
76 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
77 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
78 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
79 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
80 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
81 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
82
83 /*
84 =head1 Callback Functions
85
86 =for apidoc Ams||SAVETMPS
87 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
88 L<perlcall>.
89
90 =for apidoc Ams||FREETMPS
91 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
92 L<perlcall>.
93
94 =for apidoc Ams||ENTER
95 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
96
97 =for apidoc Ams||LEAVE
98 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
99
100 =cut
101 */
102
103 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
104 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
105
106 #ifdef DEBUGGING
107 #define ENTER                                                   \
108     STMT_START {                                                \
109         push_scope();                                           \
110         DEBUG_SCOPE("ENTER")                                    \
111     } STMT_END
112 #define LEAVE                                                   \
113     STMT_START {                                                \
114         DEBUG_SCOPE("LEAVE")                                    \
115         pop_scope();                                            \
116     } STMT_END
117 #else
118 #define ENTER push_scope()
119 #define LEAVE pop_scope()
120 #endif
121 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
122
123 #define SAVEI8(i)       save_I8((I8*)&(i))
124 #define SAVEI16(i)      save_I16((I16*)&(i))
125 #define SAVEI32(i)      save_I32((I32*)&(i))
126 #define SAVEINT(i)      save_int((int*)&(i))
127 #define SAVEIV(i)       save_iv((IV*)&(i))
128 #define SAVELONG(l)     save_long((long*)&(l))
129 #define SAVEBOOL(b)     save_bool((bool*)&(b))
130 #define SAVESPTR(s)     save_sptr((SV**)&(s))
131 #define SAVEPPTR(s)     save_pptr((char**)&(s))
132 #define SAVEVPTR(s)     save_vptr((void*)&(s))
133 #define SAVEPADSVANDMORTALIZE(s)        save_padsv_and_mortalize(s)
134 #define SAVEFREESV(s)   save_freesv(MUTABLE_SV(s))
135 #define SAVEMORTALIZESV(s)      save_mortalizesv(MUTABLE_SV(s))
136 #define SAVEFREEOP(o)   save_freeop((OP*)(o))
137 #define SAVEFREEPV(p)   save_freepv((char*)(p))
138 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
139 #define SAVEGENERICSV(s)        save_generic_svref((SV**)&(s))
140 #define SAVEGENERICPV(s)        save_generic_pvref((char**)&(s))
141 #define SAVESHAREDPV(s)         save_shared_pvref((char**)&(s))
142 #define SAVESETSVFLAGS(sv,mask,val)     save_set_svflags(sv,mask,val)
143 #define SAVEDELETE(h,k,l) \
144           save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
145 #define SAVEDESTRUCTOR(f,p) \
146           save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
147
148 #define SAVEDESTRUCTOR_X(f,p) \
149           save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
150
151 #define SAVESTACK_POS() \
152     STMT_START {                                \
153         SSCHECK(2);                             \
154         SSPUSHINT(PL_stack_sp - PL_stack_base); \
155         SSPUSHINT(SAVEt_STACK_POS);             \
156     } STMT_END
157
158 #define SAVEOP()        save_op()
159
160 #define SAVEHINTS() \
161     STMT_START {                                        \
162         if (PL_compiling.cop_hints_hash) {              \
163             HINTS_REFCNT_LOCK;                          \
164             PL_compiling.cop_hints_hash->refcounted_he_refcnt++;        \
165             HINTS_REFCNT_UNLOCK;                        \
166         }                                               \
167         SSCHECK(4);                                     \
168         if (PL_hints & HINT_LOCALIZE_HH) {              \
169             SSPUSHPTR(GvHV(PL_hintgv));                 \
170             GvHV(PL_hintgv) = Perl_hv_copy_hints_hv(aTHX_ GvHV(PL_hintgv)); \
171         }                                               \
172         SSPUSHINT(PL_hints);                            \
173         SSPUSHPTR(PL_compiling.cop_hints_hash);         \
174         SSPUSHINT(SAVEt_HINTS);                         \
175     } STMT_END
176
177 #define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
178
179 #define SAVESWITCHSTACK(f,t) \
180     STMT_START {                                        \
181         save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
182         SWITCHSTACK((f),(t));                           \
183         PL_curstackinfo->si_stack = (t);                \
184     } STMT_END
185
186 #define SAVECOPARYBASE(c) save_pushi32ptr(CopARYBASE_get(c), c, SAVEt_COP_ARYBASE);
187
188 /* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
189    because realloc() means that the value can actually change. Possibly
190    could have done savefreesharedpvREF, but this way actually seems cleaner,
191    as it simplifies the code that does the saves, and reduces the load on the
192    save stack.  */
193 #define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
194
195 #define SAVESTACK_CXPOS() \
196     STMT_START {                                  \
197         SSCHECK(3);                               \
198         SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
199         SSPUSHINT(cxstack_ix);                    \
200         SSPUSHINT(SAVEt_STACK_CXPOS);             \
201     } STMT_END
202
203 #define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
204
205 #ifdef USE_ITHREADS
206 #  define SAVECOPSTASH(c)       SAVEPPTR(CopSTASHPV(c))
207 #  define SAVECOPSTASH_FREE(c)  SAVESHAREDPV(CopSTASHPV(c))
208 #  define SAVECOPFILE(c)        SAVEPPTR(CopFILE(c))
209 #  define SAVECOPFILE_FREE(c)   SAVESHAREDPV(CopFILE(c))
210 #else
211 #  define SAVECOPSTASH(c)       SAVESPTR(CopSTASH(c))
212 #  define SAVECOPSTASH_FREE(c)  SAVECOPSTASH(c) /* XXX not refcounted */
213 #  define SAVECOPFILE(c)        SAVESPTR(CopFILEGV(c))
214 #  define SAVECOPFILE_FREE(c)   SAVEGENERICSV(CopFILEGV(c))
215 #endif
216
217 #define SAVECOPLINE(c)          SAVEI32(CopLINE(c))
218
219 /* SSNEW() temporarily allocates a specified number of bytes of data on the
220  * savestack.  It returns an integer index into the savestack, because a
221  * pointer would get broken if the savestack is moved on reallocation.
222  * SSNEWa() works like SSNEW(), but also aligns the data to the specified
223  * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
224  * alignment will be preserved therough savestack reallocation *only* if
225  * realloc returns data aligned to a size divisible by "align"!
226  *
227  * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
228  */
229
230 #define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
231 #define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
232 #define SSNEWa(size,align)      Perl_save_alloc(aTHX_ (size), \
233     (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
234 #define SSNEWat(n,t,align)      SSNEWa((n)*sizeof(t), align)
235
236 #define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
237 #define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))
238
239 #define save_freesv(op)         save_pushptr((void *)(op), SAVEt_FREESV)
240 #define save_mortalizesv(op)    save_pushptr((void *)(op), SAVEt_MORTALIZESV)
241 #define save_freeop(op)         save_pushptr((void *)(op), SAVEt_FREEOP)
242 #define save_freepv(pv)         save_pushptr((void *)(pv), SAVEt_FREEPV)
243 #define save_op()               save_pushptr((void *)(PL_op), SAVEt_OP)
244
245 /*
246  * Local variables:
247  * c-indentation-style: bsd
248  * c-basic-offset: 4
249  * indent-tabs-mode: t
250  * End:
251  *
252  * ex: set ts=8 sts=4 sw=4 noet:
253  */