This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
more cleanups for change#4539
[perl5.git] / scope.h
CommitLineData
b9d12d37
GS
1#define SAVEt_ITEM 0
2#define SAVEt_SV 1
3#define SAVEt_AV 2
4#define SAVEt_HV 3
5#define SAVEt_INT 4
6#define SAVEt_LONG 5
7#define SAVEt_I32 6
8#define SAVEt_IV 7
9#define SAVEt_SPTR 8
10#define SAVEt_APTR 9
11#define SAVEt_HPTR 10
12#define SAVEt_PPTR 11
13#define SAVEt_NSTAB 12
14#define SAVEt_SVREF 13
15#define SAVEt_GP 14
16#define SAVEt_FREESV 15
17#define SAVEt_FREEOP 16
18#define SAVEt_FREEPV 17
19#define SAVEt_CLEARSV 18
20#define SAVEt_DELETE 19
21#define SAVEt_DESTRUCTOR 20
22#define SAVEt_REGCONTEXT 21
23#define SAVEt_STACK_POS 22
24#define SAVEt_I16 23
25#define SAVEt_AELEM 24
26#define SAVEt_HELEM 25
27#define SAVEt_OP 26
28#define SAVEt_HINTS 27
29#define SAVEt_ALLOC 28
30#define SAVEt_GENERIC_SVREF 29
c76ac1ee 31#define SAVEt_DESTRUCTOR_X 30
79072805 32
3280af22
NIS
33#define SSCHECK(need) if (PL_savestack_ix + need > PL_savestack_max) savestack_grow()
34#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
35#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
36#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
37#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
38#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
c76ac1ee 39#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
3280af22
NIS
40#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
41#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
42#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
43#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
44#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
c76ac1ee 45#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
8990e307 46
3280af22
NIS
47#define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
48#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
a0d0e21e 49
f46d017c
GS
50#ifdef DEBUGGING
51#define ENTER \
52 STMT_START { \
53 push_scope(); \
cea2e8a9 54 DEBUG_l(WITH_THR(Perl_deb(aTHX_ "ENTER scope %ld at %s:%d\n", \
3280af22 55 PL_scopestack_ix, __FILE__, __LINE__))); \
f46d017c
GS
56 } STMT_END
57#define LEAVE \
58 STMT_START { \
cea2e8a9 59 DEBUG_l(WITH_THR(Perl_deb(aTHX_ "LEAVE scope %ld at %s:%d\n", \
3280af22 60 PL_scopestack_ix, __FILE__, __LINE__))); \
f46d017c
GS
61 pop_scope(); \
62 } STMT_END
63#else
a0d0e21e
LW
64#define ENTER push_scope()
65#define LEAVE pop_scope()
f46d017c 66#endif
3280af22 67#define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
a0d0e21e 68
55497cff 69/*
b9d12d37 70 * Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV
55497cff
PP
71 * because these are used for several kinds of pointer values
72 */
4fdae800
PP
73#define SAVEI16(i) save_I16(SOFT_CAST(I16*)&(i))
74#define SAVEI32(i) save_I32(SOFT_CAST(I32*)&(i))
75#define SAVEINT(i) save_int(SOFT_CAST(int*)&(i))
76#define SAVEIV(i) save_iv(SOFT_CAST(IV*)&(i))
77#define SAVELONG(l) save_long(SOFT_CAST(long*)&(l))
55497cff
PP
78#define SAVESPTR(s) save_sptr((SV**)&(s))
79#define SAVEPPTR(s) save_pptr(SOFT_CAST(char**)&(s))
80#define SAVEFREESV(s) save_freesv((SV*)(s))
81#define SAVEFREEOP(o) save_freeop(SOFT_CAST(OP*)(o))
82#define SAVEFREEPV(p) save_freepv(SOFT_CAST(char*)(p))
83#define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv))
b9d12d37 84#define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
55497cff
PP
85#define SAVEDELETE(h,k,l) \
86 save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
87#define SAVEDESTRUCTOR(f,p) \
c76ac1ee
GS
88 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), SOFT_CAST(void*)(p))
89
90#define SAVEDESTRUCTOR_X(f,p) \
91 save_destructor_x((DESTRUCTORFUNC_t)(f), SOFT_CAST(void*)(p))
25eaa213
GS
92
93#define SAVESTACK_POS() \
94 STMT_START { \
95 SSCHECK(2); \
3280af22 96 SSPUSHINT(PL_stack_sp - PL_stack_base); \
25eaa213
GS
97 SSPUSHINT(SAVEt_STACK_POS); \
98 } STMT_END
99
462e5cf6 100#define SAVEOP() save_op()
25eaa213
GS
101
102#define SAVEHINTS() \
103 STMT_START { \
3280af22 104 if (PL_hints & HINT_LOCALIZE_HH) \
25eaa213
GS
105 save_hints(); \
106 else { \
107 SSCHECK(2); \
3280af22 108 SSPUSHINT(PL_hints); \
25eaa213
GS
109 SSPUSHINT(SAVEt_HINTS); \
110 } \
111 } STMT_END
a9332b4a 112
455ece5e
AD
113/* SSNEW() temporarily allocates a specified number of bytes of data on the
114 * savestack. It returns an integer index into the savestack, because a
115 * pointer would get broken if the savestack is moved on reallocation.
116 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
117 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
118 * alignment will be preserved therough savestack reallocation *only* if
119 * realloc returns data aligned to a size divisible by `align'!
120 *
121 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
122 */
123
124#define SSNEW(size) save_alloc(size, 0)
125#define SSNEWa(size,align) save_alloc(size, \
126 (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
127
128#define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
129
54310121
PP
130/* A jmpenv packages the state required to perform a proper non-local jump.
131 * Note that there is a start_env initialized when perl starts, and top_env
132 * points to this initially, so top_env should always be non-null.
133 *
134 * Existence of a non-null top_env->je_prev implies it is valid to call
6224f72b
GS
135 * longjmp() at that runlevel (we make sure start_env.je_prev is always
136 * null to ensure this).
54310121
PP
137 *
138 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
139 * establish a local jmpenv to handle exception traps. Care must be taken
140 * to restore the previous value of je_mustcatch before exiting the
141 * stack frame iff JMPENV_PUSH was not called in that stack frame.
6224f72b 142 * GSAR 97-03-27
54310121
PP
143 */
144
145struct jmpenv {
146 struct jmpenv * je_prev;
312caa8e
CS
147 Sigjmp_buf je_buf; /* only for use if !je_throw */
148 int je_ret; /* last exception thrown */
149 bool je_mustcatch; /* need to call longjmp()? */
150 void (*je_throw)(int v); /* last for bincompat */
db36c5a1 151 bool je_noset; /* no need for setjmp() */
1163b5c4 152};
1163b5c4 153
6224f72b 154typedef struct jmpenv JMPENV;
1163b5c4 155
312caa8e
CS
156/*
157 * Function that catches/throws, and its callback for the
158 * body of protected processing.
159 */
cea2e8a9 160typedef void *(CPERLscope(*protect_body_t)) (pTHX_ va_list);
db36c5a1
GS
161typedef void *(CPERLscope(*protect_proc_t)) (pTHX_ volatile JMPENV *pcur_env,
162 int *, protect_body_t, ...);
312caa8e
CS
163
164/*
165 * How to build the first jmpenv.
166 *
167 * top_env needs to be non-zero. It points to an area
168 * in which longjmp() stuff is stored, as C callstack
169 * info there at least is thread specific this has to
170 * be per-thread. Otherwise a 'die' in a thread gives
171 * that thread the C stack of last thread to do an eval {}!
172 */
173
174#define JMPENV_BOOTSTRAP \
175 STMT_START { \
176 PL_start_env.je_prev = NULL; \
177 PL_start_env.je_throw = NULL; \
178 PL_start_env.je_ret = -1; \
179 PL_start_env.je_mustcatch = TRUE; \
db36c5a1 180 PL_start_env.je_noset = 0; \
312caa8e
CS
181 PL_top_env = &PL_start_env; \
182 } STMT_END
183
462e5cf6 184#ifdef OP_IN_REGISTER
6b88bc9c
GS
185#define OP_REG_TO_MEM PL_opsave = op
186#define OP_MEM_TO_REG op = PL_opsave
462e5cf6
MB
187#else
188#define OP_REG_TO_MEM NOOP
189#define OP_MEM_TO_REG NOOP
190#endif
191
312caa8e
CS
192/*
193 * These exception-handling macros are split up to
194 * ease integration with C++ exceptions.
195 *
196 * To use C++ try+catch to catch Perl exceptions, an extension author
197 * needs to first write an extern "C" function to throw an appropriate
198 * exception object; typically it will be or contain an integer,
199 * because Perl's internals use integers to track exception types:
200 * extern "C" { static void thrower(int i) { throw i; } }
201 *
202 * Then (as shown below) the author needs to use, not the simple
203 * JMPENV_PUSH, but several of its constitutent macros, to arrange for
204 * the Perl internals to call thrower() rather than longjmp() to
205 * report exceptions:
206 *
207 * dJMPENV;
208 * JMPENV_PUSH_INIT(thrower);
209 * try {
210 * ... stuff that may throw exceptions ...
211 * }
212 * catch (int why) { // or whatever matches thrower()
213 * JMPENV_POST_CATCH;
214 * EXCEPT_SET(why);
215 * switch (why) {
216 * ... // handle various Perl exception codes
217 * }
218 * }
219 * JMPENV_POP; // don't forget this!
220 */
221
db36c5a1
GS
222#define dJMPENV JMPENV cur_env; \
223 volatile JMPENV *pcur_env = ((cur_env.je_noset = 0),&cur_env)
312caa8e 224
db36c5a1 225#define JMPENV_PUSH_INIT_ENV(ce,THROWFUNC) \
6224f72b 226 STMT_START { \
db36c5a1
GS
227 (ce).je_throw = (THROWFUNC); \
228 (ce).je_ret = -1; \
229 (ce).je_mustcatch = FALSE; \
230 (ce).je_prev = PL_top_env; \
231 PL_top_env = &(ce); \
6224f72b 232 OP_REG_TO_MEM; \
312caa8e 233 } STMT_END
1d651c14 234
db36c5a1 235#define JMPENV_PUSH_INIT(THROWFUNC) JMPENV_PUSH_INIT_ENV(*(JMPENV*)pcur_env,THROWFUNC)
1d651c14 236
db36c5a1 237#define JMPENV_POST_CATCH_ENV(ce) \
312caa8e 238 STMT_START { \
6224f72b 239 OP_MEM_TO_REG; \
db36c5a1 240 PL_top_env = &(ce); \
6224f72b 241 } STMT_END
312caa8e 242
db36c5a1 243#define JMPENV_POST_CATCH JMPENV_POST_CATCH_ENV(*(JMPENV*)pcur_env)
1d651c14
VB
244
245
db36c5a1
GS
246#define JMPENV_PUSH_ENV(ce,v) \
247 STMT_START { \
248 if (!(ce).je_noset) { \
249 JMPENV_PUSH_INIT_ENV(ce,NULL); \
250 EXCEPT_SET_ENV(ce,PerlProc_setjmp((ce).je_buf, 1));\
251 (ce).je_noset = 1; \
252 } \
253 else \
254 EXCEPT_SET_ENV(ce,0); \
255 JMPENV_POST_CATCH_ENV(ce); \
256 (v) = EXCEPT_GET_ENV(ce); \
312caa8e
CS
257 } STMT_END
258
db36c5a1 259#define JMPENV_PUSH(v) JMPENV_PUSH_ENV(*(JMPENV*)pcur_env,v)
1d651c14 260
db36c5a1
GS
261#define JMPENV_POP_ENV(ce) \
262 STMT_START { PL_top_env = (ce).je_prev; } STMT_END
312caa8e 263
db36c5a1 264#define JMPENV_POP JMPENV_POP_ENV(*(JMPENV*)pcur_env)
1d651c14 265
22921e25
CS
266#define JMPENV_JUMP(v) \
267 STMT_START { \
462e5cf6 268 OP_REG_TO_MEM; \
312caa8e
CS
269 if (PL_top_env->je_prev) { \
270 if (PL_top_env->je_throw) \
271 PL_top_env->je_throw(v); \
272 else \
273 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
274 } \
6224f72b 275 if ((v) == 2) \
312caa8e 276 PerlProc_exit(STATUS_NATIVE_EXPORT); \
bf49b057 277 PerlIO_printf(Perl_error_log, "panic: top_env\n"); \
312caa8e 278 PerlProc_exit(1); \
22921e25 279 } STMT_END
312caa8e 280
db36c5a1
GS
281#define EXCEPT_GET_ENV(ce) ((ce).je_ret)
282#define EXCEPT_GET EXCEPT_GET_ENV(*(JMPENV*)pcur_env)
283#define EXCEPT_SET_ENV(ce,v) ((ce).je_ret = (v))
284#define EXCEPT_SET(v) EXCEPT_SET_ENV(*(JMPENV*)pcur_env,v)
312caa8e 285
db36c5a1
GS
286#define CATCH_GET (PL_top_env->je_mustcatch)
287#define CATCH_SET(v) (PL_top_env->je_mustcatch = (v))