regcomp.c: Remove redundant code
[perl.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 /* *** these are ordered by number of of auto-popped args */
12
13 /* zero args */
14
15 #define SAVEt_ALLOC             0
16 #define SAVEt_CLEARPADRANGE     1
17 #define SAVEt_CLEARSV           2
18 #define SAVEt_REGCONTEXT        3
19 /*** SPARE                      4 ***/
20
21 #define SAVEt_ARG0_MAX          4
22
23 /* one arg */
24
25 #define SAVEt_BOOL              5
26 #define SAVEt_COMPILE_WARNINGS  6
27 #define SAVEt_COMPPAD           7
28 #define SAVEt_FREECOPHH         8
29 #define SAVEt_FREEOP            9
30 #define SAVEt_FREEPV            10
31 #define SAVEt_FREESV            11
32 #define SAVEt_I16               12
33 #define SAVEt_I32_SMALL         13
34 #define SAVEt_I8                14
35 #define SAVEt_INT_SMALL         15
36 #define SAVEt_MORTALIZESV       16
37 #define SAVEt_NSTAB             17
38 #define SAVEt_OP                18
39 #define SAVEt_PARSER            19
40 #define SAVEt_STACK_POS         20
41 #define SAVEt_READONLY_OFF      21
42
43 #define SAVEt_ARG1_MAX          21
44
45 /* two args */
46
47 #define SAVEt_APTR              22
48 #define SAVEt_AV                23
49 #define SAVEt_DESTRUCTOR        24
50 #define SAVEt_DESTRUCTOR_X      25
51 #define SAVEt_GENERIC_PVREF     26
52 #define SAVEt_GENERIC_SVREF     27
53 #define SAVEt_GP                28
54 #define SAVEt_GVSV              29
55 #define SAVEt_HINTS             30
56 #define SAVEt_HPTR              31
57 #define SAVEt_HV                32
58 #define SAVEt_I32               33
59 #define SAVEt_INT               34
60 #define SAVEt_ITEM              35
61 #define SAVEt_IV                36
62 #define SAVEt_LONG              37
63 #define SAVEt_PPTR              38
64 #define SAVEt_SAVESWITCHSTACK   39
65 #define SAVEt_SHARED_PVREF      40
66 #define SAVEt_SPTR              41
67 #define SAVEt_STACK_CXPOS       42
68 #define SAVEt_SV                43
69 #define SAVEt_SVREF             44
70 #define SAVEt_VPTR              45
71 #define SAVEt_ADELETE           46
72
73 #define SAVEt_ARG2_MAX          46
74
75 /* three args */
76
77 #define SAVEt_DELETE            47
78 #define SAVEt_HELEM             48
79 #define SAVEt_PADSV_AND_MORTALIZE 49
80 #define SAVEt_SET_SVFLAGS       50
81 #define SAVEt_GVSLOT            51
82 #define SAVEt_AELEM             52
83
84 #define SAVEf_SETMAGIC          1
85 #define SAVEf_KEEPOLDELEM       2
86
87 #define SAVE_TIGHT_SHIFT        6
88 #define SAVE_MASK               0x3F
89
90 #define save_aelem(av,idx,sptr) save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
91 #define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
92
93 #ifndef SCOPE_SAVES_SIGNAL_MASK
94 #define SCOPE_SAVES_SIGNAL_MASK 0
95 #endif
96
97 /* the maximum number of entries that might be pushed using the SS_ADD*
98  * macros */
99 #define SS_MAXPUSH 4
100
101 #define SSCHECK(need) if (PL_savestack_ix + (I32)(need) + SS_MAXPUSH > PL_savestack_max) savestack_grow()
102 #define SSGROW(need) if (PL_savestack_ix + (I32)(need) + SS_MAXPUSH > PL_savestack_max) savestack_grow_cnt(need + SS_MAXPUSH)
103 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
104 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
105 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
106 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
107 #define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
108 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
109 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
110 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
111
112 /* SS_ADD*: newer, faster versions of the above. Don't mix the two sets of
113  * macros. These are fast because they save reduce accesses to the PL_
114  * vars and move the size check to the end. Doing the check last means
115  * that values in registers will have been pushed and no longer needed, so
116  * don't need saving around the call to grow. Also, tail-call elimination
117  * of the grow() can be done. These changes reduce the code of something
118  * like save_pushptrptr() to half its former size.
119  * Of course, doing the size check *after* pushing means we must always
120  * ensure there are SS_MAXPUSH free slots on the savestack
121  *
122  * These are for internal core use only and are subject to change */
123
124 #define dSS_ADD \
125     I32 ix = PL_savestack_ix;     \
126     ANY *ssp = &PL_savestack[ix];
127
128 #define SS_ADD_END(need) \
129     assert((need) <= SS_MAXPUSH);                               \
130     ix += (need);                                               \
131     PL_savestack_ix = ix;                                       \
132     assert(ix <= PL_savestack_max);                             \
133     if ((ix + SS_MAXPUSH) > PL_savestack_max) savestack_grow(); \
134     assert(PL_savestack_ix + SS_MAXPUSH <= PL_savestack_max);
135
136 #define SS_ADD_INT(i)   ((ssp++)->any_i32 = (I32)(i))
137 #define SS_ADD_LONG(i)  ((ssp++)->any_long = (long)(i))
138 #define SS_ADD_BOOL(p)  ((ssp++)->any_bool = (p))
139 #define SS_ADD_IV(i)    ((ssp++)->any_iv = (IV)(i))
140 #define SS_ADD_UV(u)    ((ssp++)->any_uv = (UV)(u))
141 #define SS_ADD_PTR(p)   ((ssp++)->any_ptr = (void*)(p))
142 #define SS_ADD_DPTR(p)  ((ssp++)->any_dptr = (p))
143 #define SS_ADD_DXPTR(p) ((ssp++)->any_dxptr = (p))
144
145 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
146 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
147 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
148 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
149 #define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
150 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
151 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
152 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
153
154
155 /*
156 =head1 Callback Functions
157
158 =for apidoc Ams||SAVETMPS
159 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
160 L<perlcall>.
161
162 =for apidoc Ams||FREETMPS
163 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
164 L<perlcall>.
165
166 =for apidoc Ams||ENTER
167 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
168
169 =for apidoc Ams||LEAVE
170 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
171
172 =over
173
174 =item ENTER_with_name(name)
175
176 Same as C<ENTER>, but when debugging is enabled it also associates the
177 given literal string with the new scope.
178
179 =item LEAVE_with_name(name)
180
181 Same as C<LEAVE>, but when debugging is enabled it first checks that the
182 scope has the given name. Name must be a literal string.
183
184 =back
185
186 =cut
187 */
188
189 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
190 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
191
192 #ifdef DEBUGGING
193 #define ENTER                                                   \
194     STMT_START {                                                \
195         push_scope();                                           \
196         DEBUG_SCOPE("ENTER")                                    \
197     } STMT_END
198 #define LEAVE                                                   \
199     STMT_START {                                                \
200         DEBUG_SCOPE("LEAVE")                                    \
201         pop_scope();                                            \
202     } STMT_END
203 #define ENTER_with_name(name)                                           \
204     STMT_START {                                                        \
205         push_scope();                                                   \
206         if (PL_scopestack_name)                                         \
207             PL_scopestack_name[PL_scopestack_ix-1] = name;              \
208         DEBUG_SCOPE("ENTER \"" name "\"")                               \
209     } STMT_END
210 #define LEAVE_with_name(name)                                           \
211     STMT_START {                                                        \
212         DEBUG_SCOPE("LEAVE \"" name "\"")                               \
213         if (PL_scopestack_name) {                                       \
214             assert(((char*)PL_scopestack_name[PL_scopestack_ix-1]       \
215                         == (char*)name)                                 \
216                     || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name));        \
217         }                                                               \
218         pop_scope();                                                    \
219     } STMT_END
220 #else
221 #define ENTER push_scope()
222 #define LEAVE pop_scope()
223 #define ENTER_with_name(name) ENTER
224 #define LEAVE_with_name(name) LEAVE
225 #endif
226 #define LEAVE_SCOPE(old) STMT_START { \
227         if (PL_savestack_ix > old) leave_scope(old); \
228     } STMT_END
229
230 #define SAVEI8(i)       save_I8((I8*)&(i))
231 #define SAVEI16(i)      save_I16((I16*)&(i))
232 #define SAVEI32(i)      save_I32((I32*)&(i))
233 #define SAVEINT(i)      save_int((int*)&(i))
234 #define SAVEIV(i)       save_iv((IV*)&(i))
235 #define SAVELONG(l)     save_long((long*)&(l))
236 #define SAVEBOOL(b)     save_bool(&(b))
237 #define SAVESPTR(s)     save_sptr((SV**)&(s))
238 #define SAVEPPTR(s)     save_pptr((char**)&(s))
239 #define SAVEVPTR(s)     save_vptr((void*)&(s))
240 #define SAVEPADSVANDMORTALIZE(s)        save_padsv_and_mortalize(s)
241 #define SAVEFREESV(s)   save_freesv(MUTABLE_SV(s))
242 #define SAVEMORTALIZESV(s)      save_mortalizesv(MUTABLE_SV(s))
243 #define SAVEFREEOP(o)   save_freeop((OP*)(o))
244 #define SAVEFREEPV(p)   save_freepv((char*)(p))
245 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
246 #define SAVEGENERICSV(s)        save_generic_svref((SV**)&(s))
247 #define SAVEGENERICPV(s)        save_generic_pvref((char**)&(s))
248 #define SAVESHAREDPV(s)         save_shared_pvref((char**)&(s))
249 #define SAVESETSVFLAGS(sv,mask,val)     save_set_svflags(sv,mask,val)
250 #define SAVEFREECOPHH(h)        save_pushptr((void *)(h), SAVEt_FREECOPHH)
251 #define SAVEDELETE(h,k,l) \
252           save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
253 #define SAVEHDELETE(h,s) \
254           save_hdelete(MUTABLE_HV(h), (s))
255 #define SAVEADELETE(a,k) \
256           save_adelete(MUTABLE_AV(a), (I32)(k))
257 #define SAVEDESTRUCTOR(f,p) \
258           save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
259
260 #define SAVEDESTRUCTOR_X(f,p) \
261           save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
262
263 #define SAVESTACK_POS() \
264     STMT_START {                                   \
265         dSS_ADD;                                   \
266         SS_ADD_INT(PL_stack_sp - PL_stack_base);   \
267         SS_ADD_UV(SAVEt_STACK_POS);                \
268         SS_ADD_END(2);                             \
269     } STMT_END
270
271 #define SAVEOP()        save_op()
272
273 #define SAVEHINTS()     save_hints()
274
275 #define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
276
277 #define SAVESWITCHSTACK(f,t) \
278     STMT_START {                                        \
279         save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
280         SWITCHSTACK((f),(t));                           \
281         PL_curstackinfo->si_stack = (t);                \
282     } STMT_END
283
284 /* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
285    because realloc() means that the value can actually change. Possibly
286    could have done savefreesharedpvREF, but this way actually seems cleaner,
287    as it simplifies the code that does the saves, and reduces the load on the
288    save stack.  */
289 #define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
290
291 #define SAVESTACK_CXPOS() \
292     STMT_START {                                   \
293         dSS_ADD;                                   \
294         SS_ADD_INT(cxstack[cxstack_ix].blk_oldsp); \
295         SS_ADD_INT(cxstack_ix);                    \
296         SS_ADD_UV(SAVEt_STACK_CXPOS);              \
297         SS_ADD_END(3);                             \
298     } STMT_END
299
300 #define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
301
302 #ifdef USE_ITHREADS
303 #  define SAVECOPSTASH_FREE(c)  SAVEIV((c)->cop_stashoff)
304 #  define SAVECOPFILE(c)        SAVEPPTR(CopFILE(c))
305 #  define SAVECOPFILE_FREE(c)   SAVESHAREDPV(CopFILE(c))
306 #else
307 #  /* XXX not refcounted */
308 #  define SAVECOPSTASH_FREE(c)  SAVESPTR(CopSTASH(c))
309 #  define SAVECOPFILE(c)        SAVESPTR(CopFILEGV(c))
310 #  define SAVECOPFILE_FREE(c)   SAVEGENERICSV(CopFILEGV(c))
311 #endif
312
313 #define SAVECOPLINE(c)          SAVEI32(CopLINE(c))
314
315 /* SSNEW() temporarily allocates a specified number of bytes of data on the
316  * savestack.  It returns an integer index into the savestack, because a
317  * pointer would get broken if the savestack is moved on reallocation.
318  * SSNEWa() works like SSNEW(), but also aligns the data to the specified
319  * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
320  * alignment will be preserved through savestack reallocation *only* if
321  * realloc returns data aligned to a size divisible by "align"!
322  *
323  * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
324  */
325
326 #define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
327 #define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
328 #define SSNEWa(size,align)      Perl_save_alloc(aTHX_ (size), \
329     (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
330 #define SSNEWat(n,t,align)      SSNEWa((n)*sizeof(t), align)
331
332 #define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
333 #define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))
334
335 #define save_freesv(op)         save_pushptr((void *)(op), SAVEt_FREESV)
336 #define save_mortalizesv(op)    save_pushptr((void *)(op), SAVEt_MORTALIZESV)
337
338 # define save_freeop(op)                    \
339 STMT_START {                                 \
340       OP * const _o = (OP *)(op);             \
341       assert(!_o->op_savefree);               \
342       _o->op_savefree = 1;                     \
343       save_pushptr((void *)(_o), SAVEt_FREEOP); \
344     } STMT_END
345 #define save_freepv(pv)         save_pushptr((void *)(pv), SAVEt_FREEPV)
346 #define save_op()               save_pushptr((void *)(PL_op), SAVEt_OP)
347
348 /*
349  * Local variables:
350  * c-indentation-style: bsd
351  * c-basic-offset: 4
352  * indent-tabs-mode: nil
353  * End:
354  *
355  * ex: set ts=8 sts=4 sw=4 et:
356  */