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