Commit | Line | Data |
---|---|---|
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 | 71 | * because these are used for several kinds of pointer values |
72 | */ | |
4fdae800 | 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 | 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 | 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 | 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 | 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 | 143 | */ |
144 | ||
145 | struct 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 */ | |
1163b5c4 | 151 | }; |
1163b5c4 | 152 | |
6224f72b | 153 | typedef struct jmpenv JMPENV; |
1163b5c4 | 154 | |
312caa8e CS |
155 | /* |
156 | * Function that catches/throws, and its callback for the | |
157 | * body of protected processing. | |
158 | */ | |
cea2e8a9 GS |
159 | typedef void *(CPERLscope(*protect_body_t)) (pTHX_ va_list); |
160 | typedef void *(CPERLscope(*protect_proc_t)) (pTHX_ int *, protect_body_t, ...); | |
312caa8e CS |
161 | |
162 | /* | |
163 | * How to build the first jmpenv. | |
164 | * | |
165 | * top_env needs to be non-zero. It points to an area | |
166 | * in which longjmp() stuff is stored, as C callstack | |
167 | * info there at least is thread specific this has to | |
168 | * be per-thread. Otherwise a 'die' in a thread gives | |
169 | * that thread the C stack of last thread to do an eval {}! | |
170 | */ | |
171 | ||
172 | #define JMPENV_BOOTSTRAP \ | |
173 | STMT_START { \ | |
174 | PL_start_env.je_prev = NULL; \ | |
175 | PL_start_env.je_throw = NULL; \ | |
176 | PL_start_env.je_ret = -1; \ | |
177 | PL_start_env.je_mustcatch = TRUE; \ | |
178 | PL_top_env = &PL_start_env; \ | |
179 | } STMT_END | |
180 | ||
462e5cf6 | 181 | #ifdef OP_IN_REGISTER |
6b88bc9c GS |
182 | #define OP_REG_TO_MEM PL_opsave = op |
183 | #define OP_MEM_TO_REG op = PL_opsave | |
462e5cf6 MB |
184 | #else |
185 | #define OP_REG_TO_MEM NOOP | |
186 | #define OP_MEM_TO_REG NOOP | |
187 | #endif | |
188 | ||
312caa8e CS |
189 | /* |
190 | * These exception-handling macros are split up to | |
191 | * ease integration with C++ exceptions. | |
192 | * | |
193 | * To use C++ try+catch to catch Perl exceptions, an extension author | |
194 | * needs to first write an extern "C" function to throw an appropriate | |
195 | * exception object; typically it will be or contain an integer, | |
196 | * because Perl's internals use integers to track exception types: | |
197 | * extern "C" { static void thrower(int i) { throw i; } } | |
198 | * | |
199 | * Then (as shown below) the author needs to use, not the simple | |
200 | * JMPENV_PUSH, but several of its constitutent macros, to arrange for | |
201 | * the Perl internals to call thrower() rather than longjmp() to | |
202 | * report exceptions: | |
203 | * | |
204 | * dJMPENV; | |
205 | * JMPENV_PUSH_INIT(thrower); | |
206 | * try { | |
207 | * ... stuff that may throw exceptions ... | |
208 | * } | |
209 | * catch (int why) { // or whatever matches thrower() | |
210 | * JMPENV_POST_CATCH; | |
211 | * EXCEPT_SET(why); | |
212 | * switch (why) { | |
213 | * ... // handle various Perl exception codes | |
214 | * } | |
215 | * } | |
216 | * JMPENV_POP; // don't forget this! | |
217 | */ | |
218 | ||
6224f72b | 219 | #define dJMPENV JMPENV cur_env |
312caa8e | 220 | |
1d651c14 | 221 | #define JMPENV_PUSH_INIT_ENV(cur_env,THROWFUNC) \ |
6224f72b | 222 | STMT_START { \ |
312caa8e CS |
223 | cur_env.je_throw = (THROWFUNC); \ |
224 | cur_env.je_ret = -1; \ | |
225 | cur_env.je_mustcatch = FALSE; \ | |
3280af22 | 226 | cur_env.je_prev = PL_top_env; \ |
312caa8e | 227 | PL_top_env = &cur_env; \ |
6224f72b | 228 | OP_REG_TO_MEM; \ |
312caa8e | 229 | } STMT_END |
1d651c14 VB |
230 | |
231 | #define JMPENV_PUSH_INIT(THROWFUNC) JMPENV_PUSH_INIT_ENV(cur_env,THROWFUNC) | |
232 | ||
233 | #define JMPENV_POST_CATCH_ENV(cur_env) \ | |
312caa8e | 234 | STMT_START { \ |
6224f72b | 235 | OP_MEM_TO_REG; \ |
3280af22 | 236 | PL_top_env = &cur_env; \ |
6224f72b | 237 | } STMT_END |
312caa8e | 238 | |
1d651c14 VB |
239 | #define JMPENV_POST_CATCH JMPENV_POST_CATCH_ENV(cur_env) |
240 | ||
241 | ||
242 | #define JMPENV_PUSH_ENV(cur_env,v) \ | |
312caa8e | 243 | STMT_START { \ |
1d651c14 VB |
244 | JMPENV_PUSH_INIT_ENV(cur_env,NULL); \ |
245 | EXCEPT_SET_ENV(cur_env,PerlProc_setjmp(cur_env.je_buf, 1)); \ | |
246 | JMPENV_POST_CATCH_ENV(cur_env); \ | |
247 | (v) = EXCEPT_GET_ENV(cur_env); \ | |
312caa8e CS |
248 | } STMT_END |
249 | ||
1d651c14 VB |
250 | #define JMPENV_PUSH(v) JMPENV_PUSH_ENV(cur_env,v) |
251 | ||
252 | #define JMPENV_POP_ENV(cur_env) \ | |
3280af22 | 253 | STMT_START { PL_top_env = cur_env.je_prev; } STMT_END |
312caa8e | 254 | |
1d651c14 VB |
255 | #define JMPENV_POP JMPENV_POP_ENV(cur_env) |
256 | ||
22921e25 CS |
257 | #define JMPENV_JUMP(v) \ |
258 | STMT_START { \ | |
462e5cf6 | 259 | OP_REG_TO_MEM; \ |
312caa8e CS |
260 | if (PL_top_env->je_prev) { \ |
261 | if (PL_top_env->je_throw) \ | |
262 | PL_top_env->je_throw(v); \ | |
263 | else \ | |
264 | PerlProc_longjmp(PL_top_env->je_buf, (v)); \ | |
265 | } \ | |
6224f72b | 266 | if ((v) == 2) \ |
312caa8e | 267 | PerlProc_exit(STATUS_NATIVE_EXPORT); \ |
bf49b057 | 268 | PerlIO_printf(Perl_error_log, "panic: top_env\n"); \ |
312caa8e | 269 | PerlProc_exit(1); \ |
22921e25 | 270 | } STMT_END |
312caa8e | 271 | |
1d651c14 VB |
272 | #define EXCEPT_GET_ENV(cur_env) (cur_env.je_ret) |
273 | #define EXCEPT_GET EXCEPT_GET_ENV(cur_env) | |
274 | #define EXCEPT_SET_ENV(cur_env,v) (cur_env.je_ret = (v)) | |
275 | #define EXCEPT_SET(v) EXCEPT_SET_ENV(cur_env,v) | |
312caa8e | 276 | |
3280af22 NIS |
277 | #define CATCH_GET (PL_top_env->je_mustcatch) |
278 | #define CATCH_SET(v) (PL_top_env->je_mustcatch = (v)) | |
6224f72b | 279 |