This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Abstract all the accesses to cop_arybase (apart from ByteLoader)
[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
54 #ifndef SCOPE_SAVES_SIGNAL_MASK
55 #define SCOPE_SAVES_SIGNAL_MASK 0
56 #endif
57
58 #define SSCHECK(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow()
59 #define SSGROW(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow_cnt(need)
60 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
61 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
62 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
63 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
64 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
65 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
66 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
67 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
68 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
69 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
70 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
71 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
72 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
73 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
74
75 /*
76 =head1 Callback Functions
77
78 =for apidoc Ams||SAVETMPS
79 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
80 L<perlcall>.
81
82 =for apidoc Ams||FREETMPS
83 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
84 L<perlcall>.
85
86 =for apidoc Ams||ENTER
87 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
88
89 =for apidoc Ams||LEAVE
90 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
91
92 =cut
93 */
94
95 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
96 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
97
98 #ifdef DEBUGGING
99 #define ENTER                                                   \
100     STMT_START {                                                \
101         push_scope();                                           \
102         DEBUG_SCOPE("ENTER")                                    \
103     } STMT_END
104 #define LEAVE                                                   \
105     STMT_START {                                                \
106         DEBUG_SCOPE("LEAVE")                                    \
107         pop_scope();                                            \
108     } STMT_END
109 #else
110 #define ENTER push_scope()
111 #define LEAVE pop_scope()
112 #endif
113 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
114
115 #define SAVEI8(i)       save_I8((I8*)&(i))
116 #define SAVEI16(i)      save_I16((I16*)&(i))
117 #define SAVEI32(i)      save_I32((I32*)&(i))
118 #define SAVEINT(i)      save_int((int*)&(i))
119 #define SAVEIV(i)       save_iv((IV*)&(i))
120 #define SAVELONG(l)     save_long((long*)&(l))
121 #define SAVEBOOL(b)     save_bool((bool*)&(b))
122 #define SAVESPTR(s)     save_sptr((SV**)&(s))
123 #define SAVEPPTR(s)     save_pptr((char**)&(s))
124 #define SAVEVPTR(s)     save_vptr((void*)&(s))
125 #define SAVEPADSV(s)    save_padsv(s)
126 #define SAVEFREESV(s)   save_freesv((SV*)(s))
127 #define SAVEMORTALIZESV(s)      save_mortalizesv((SV*)(s))
128 #define SAVEFREEOP(o)   save_freeop((OP*)(o))
129 #define SAVEFREEPV(p)   save_freepv((char*)(p))
130 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
131 #define SAVEGENERICSV(s)        save_generic_svref((SV**)&(s))
132 #define SAVEGENERICPV(s)        save_generic_pvref((char**)&(s))
133 #define SAVESHAREDPV(s)         save_shared_pvref((char**)&(s))
134 #define SAVESETSVFLAGS(sv,mask,val)     save_set_svflags(sv,mask,val)
135 #define SAVEDELETE(h,k,l) \
136           save_delete((HV*)(h), (char*)(k), (I32)(l))
137 #define SAVEDESTRUCTOR(f,p) \
138           save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
139
140 #define SAVEDESTRUCTOR_X(f,p) \
141           save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
142
143 #define SAVESTACK_POS() \
144     STMT_START {                                \
145         SSCHECK(2);                             \
146         SSPUSHINT(PL_stack_sp - PL_stack_base); \
147         SSPUSHINT(SAVEt_STACK_POS);             \
148     } STMT_END
149
150 #define SAVEOP()        save_op()
151
152 #define SAVEHINTS() \
153     STMT_START {                                        \
154         SSCHECK(4);                                     \
155         if (PL_hints & HINT_LOCALIZE_HH) {              \
156             SSPUSHPTR(GvHV(PL_hintgv));                 \
157             GvHV(PL_hintgv) = Perl_hv_copy_hints_hv(aTHX_ GvHV(PL_hintgv)); \
158         }                                               \
159         if (PL_compiling.cop_hints) {                   \
160             PL_compiling.cop_hints->refcounted_he_refcnt++;     \
161         }                                               \
162         SSPUSHPTR(PL_compiling.cop_hints);              \
163         SSPUSHINT(PL_hints);                            \
164         SSPUSHINT(SAVEt_HINTS);                         \
165     } STMT_END
166
167 #define SAVECOMPPAD() \
168     STMT_START {                                                \
169         SSCHECK(2);                                             \
170         SSPUSHPTR((SV*)PL_comppad);                             \
171         SSPUSHINT(SAVEt_COMPPAD);                               \
172     } STMT_END
173
174 #define SAVESWITCHSTACK(f,t) \
175     STMT_START {                                        \
176         SSCHECK(3);                                     \
177         SSPUSHPTR((SV*)(f));                            \
178         SSPUSHPTR((SV*)(t));                            \
179         SSPUSHINT(SAVEt_SAVESWITCHSTACK);               \
180         SWITCHSTACK((f),(t));                           \
181         PL_curstackinfo->si_stack = (t);                \
182     } STMT_END
183
184 #define SAVECOPARYBASE(c) \
185     STMT_START {                                        \
186         SSCHECK(3);                                     \
187         SSPUSHINT(CopARYBASE_get(c));                   \
188         SSPUSHPTR(c);                                   \
189         SSPUSHINT(SAVEt_COP_ARYBASE);                   \
190     } STMT_END
191
192
193 #ifdef USE_ITHREADS
194 #  define SAVECOPSTASH(c)       SAVEPPTR(CopSTASHPV(c))
195 #  define SAVECOPSTASH_FREE(c)  SAVESHAREDPV(CopSTASHPV(c))
196 #  define SAVECOPFILE(c)        SAVEPPTR(CopFILE(c))
197 #  define SAVECOPFILE_FREE(c)   SAVESHAREDPV(CopFILE(c))
198 #else
199 #  define SAVECOPSTASH(c)       SAVESPTR(CopSTASH(c))
200 #  define SAVECOPSTASH_FREE(c)  SAVECOPSTASH(c) /* XXX not refcounted */
201 #  define SAVECOPFILE(c)        SAVESPTR(CopFILEGV(c))
202 #  define SAVECOPFILE_FREE(c)   SAVEGENERICSV(CopFILEGV(c))
203 #endif
204
205 #define SAVECOPLINE(c)          SAVEI32(CopLINE(c))
206
207 /* SSNEW() temporarily allocates a specified number of bytes of data on the
208  * savestack.  It returns an integer index into the savestack, because a
209  * pointer would get broken if the savestack is moved on reallocation.
210  * SSNEWa() works like SSNEW(), but also aligns the data to the specified
211  * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
212  * alignment will be preserved therough savestack reallocation *only* if
213  * realloc returns data aligned to a size divisible by "align"!
214  *
215  * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
216  */
217
218 #define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
219 #define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
220 #define SSNEWa(size,align)      Perl_save_alloc(aTHX_ (size), \
221     (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
222 #define SSNEWat(n,t,align)      SSNEWa((n)*sizeof(t), align)
223
224 #define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
225 #define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))
226