This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Save the regexp engine state as 1 block on the save stack.
[perl5.git] / scope.h
1 /*    scope.h
2  *
3  *    Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2004, 2005 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             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
55 #ifndef SCOPE_SAVES_SIGNAL_MASK
56 #define SCOPE_SAVES_SIGNAL_MASK 0
57 #endif
58
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)
75
76 /*
77 =head1 Callback Functions
78
79 =for apidoc Ams||SAVETMPS
80 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
81 L<perlcall>.
82
83 =for apidoc Ams||FREETMPS
84 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
85 L<perlcall>.
86
87 =for apidoc Ams||ENTER
88 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
89
90 =for apidoc Ams||LEAVE
91 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
92
93 =cut
94 */
95
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()
98
99 #ifdef DEBUGGING
100 #define ENTER                                                   \
101     STMT_START {                                                \
102         push_scope();                                           \
103         DEBUG_SCOPE("ENTER")                                    \
104     } STMT_END
105 #define LEAVE                                                   \
106     STMT_START {                                                \
107         DEBUG_SCOPE("LEAVE")                                    \
108         pop_scope();                                            \
109     } STMT_END
110 #else
111 #define ENTER push_scope()
112 #define LEAVE pop_scope()
113 #endif
114 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
115
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))
140
141 #define SAVEDESTRUCTOR_X(f,p) \
142           save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
143
144 #define SAVESTACK_POS() \
145     STMT_START {                                \
146         SSCHECK(2);                             \
147         SSPUSHINT(PL_stack_sp - PL_stack_base); \
148         SSPUSHINT(SAVEt_STACK_POS);             \
149     } STMT_END
150
151 #define SAVEOP()        save_op()
152
153 #define SAVEHINTS() \
154     STMT_START {                                        \
155         SSCHECK(4);                                     \
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)); \
159         }                                               \
160         if (PL_compiling.cop_hints) {                   \
161             PL_compiling.cop_hints->refcounted_he_refcnt++;     \
162         }                                               \
163         SSPUSHPTR(PL_compiling.cop_hints);              \
164         SSPUSHINT(PL_hints);                            \
165         SSPUSHINT(SAVEt_HINTS);                         \
166     } STMT_END
167
168 #define SAVECOMPPAD() \
169     STMT_START {                                                \
170         SSCHECK(2);                                             \
171         SSPUSHPTR((SV*)PL_comppad);                             \
172         SSPUSHINT(SAVEt_COMPPAD);                               \
173     } STMT_END
174
175 #define SAVESWITCHSTACK(f,t) \
176     STMT_START {                                        \
177         SSCHECK(3);                                     \
178         SSPUSHPTR((SV*)(f));                            \
179         SSPUSHPTR((SV*)(t));                            \
180         SSPUSHINT(SAVEt_SAVESWITCHSTACK);               \
181         SWITCHSTACK((f),(t));                           \
182         PL_curstackinfo->si_stack = (t);                \
183     } STMT_END
184
185 #define SAVECOPARYBASE(c) \
186     STMT_START {                                        \
187         SSCHECK(3);                                     \
188         SSPUSHINT(CopARYBASE_get(c));                   \
189         SSPUSHPTR(c);                                   \
190         SSPUSHINT(SAVEt_COP_ARYBASE);                   \
191     } STMT_END
192
193
194 #ifdef USE_ITHREADS
195 #  define SAVECOPSTASH(c)       SAVEPPTR(CopSTASHPV(c))
196 #  define SAVECOPSTASH_FREE(c)  SAVESHAREDPV(CopSTASHPV(c))
197 #  define SAVECOPFILE(c)        SAVEPPTR(CopFILE(c))
198 #  define SAVECOPFILE_FREE(c)   SAVESHAREDPV(CopFILE(c))
199 #else
200 #  define SAVECOPSTASH(c)       SAVESPTR(CopSTASH(c))
201 #  define SAVECOPSTASH_FREE(c)  SAVECOPSTASH(c) /* XXX not refcounted */
202 #  define SAVECOPFILE(c)        SAVESPTR(CopFILEGV(c))
203 #  define SAVECOPFILE_FREE(c)   SAVEGENERICSV(CopFILEGV(c))
204 #endif
205
206 #define SAVECOPLINE(c)          SAVEI32(CopLINE(c))
207
208 /* SSNEW() temporarily allocates a specified number of bytes of data on the
209  * savestack.  It returns an integer index into the savestack, because a
210  * pointer would get broken if the savestack is moved on reallocation.
211  * SSNEWa() works like SSNEW(), but also aligns the data to the specified
212  * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
213  * alignment will be preserved therough savestack reallocation *only* if
214  * realloc returns data aligned to a size divisible by "align"!
215  *
216  * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
217  */
218
219 #define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
220 #define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
221 #define SSNEWa(size,align)      Perl_save_alloc(aTHX_ (size), \
222     (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
223 #define SSNEWat(n,t,align)      SSNEWa((n)*sizeof(t), align)
224
225 #define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
226 #define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))
227