Commit | Line | Data |
b9d12d37 |
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 |
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 |
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 |
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 |
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 |
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 |
61 | pop_scope(); \ |
62 | } STMT_END |
63 | #else |
a0d0e21e |
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 |
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 |
92 | |
93 | #define SAVESTACK_POS() \ |
94 | STMT_START { \ |
95 | SSCHECK(2); \ |
3280af22 |
96 | SSPUSHINT(PL_stack_sp - PL_stack_base); \ |
25eaa213 |
97 | SSPUSHINT(SAVEt_STACK_POS); \ |
98 | } STMT_END |
99 | |
462e5cf6 |
100 | #define SAVEOP() save_op() |
25eaa213 |
101 | |
102 | #define SAVEHINTS() \ |
103 | STMT_START { \ |
3280af22 |
104 | if (PL_hints & HINT_LOCALIZE_HH) \ |
25eaa213 |
105 | save_hints(); \ |
106 | else { \ |
107 | SSCHECK(2); \ |
3280af22 |
108 | SSPUSHINT(PL_hints); \ |
25eaa213 |
109 | SSPUSHINT(SAVEt_HINTS); \ |
110 | } \ |
111 | } STMT_END |
a9332b4a |
112 | |
57843af0 |
113 | #ifdef USE_ITHREADS |
11faa288 |
114 | # define SAVECOPSTASH(cop) SAVEPPTR(CopSTASHPV(cop)) |
57843af0 |
115 | # define SAVECOPFILE(cop) SAVEPPTR(CopFILE(cop)) |
116 | #else |
11faa288 |
117 | # define SAVECOPSTASH(cop) SAVESPTR(CopSTASH(cop)) |
57843af0 |
118 | # define SAVECOPFILE(cop) SAVESPTR(CopFILEGV(cop)) |
119 | #endif |
120 | |
121 | #define SAVECOPLINE(cop) SAVEI16(CopLINE(cop)) |
122 | |
455ece5e |
123 | /* SSNEW() temporarily allocates a specified number of bytes of data on the |
124 | * savestack. It returns an integer index into the savestack, because a |
125 | * pointer would get broken if the savestack is moved on reallocation. |
126 | * SSNEWa() works like SSNEW(), but also aligns the data to the specified |
127 | * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The |
128 | * alignment will be preserved therough savestack reallocation *only* if |
129 | * realloc returns data aligned to a size divisible by `align'! |
130 | * |
131 | * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer. |
132 | */ |
133 | |
134 | #define SSNEW(size) save_alloc(size, 0) |
135 | #define SSNEWa(size,align) save_alloc(size, \ |
136 | (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align) |
137 | |
138 | #define SSPTR(off,type) ((type) ((char*)PL_savestack + off)) |
139 | |
54310121 |
140 | /* A jmpenv packages the state required to perform a proper non-local jump. |
141 | * Note that there is a start_env initialized when perl starts, and top_env |
142 | * points to this initially, so top_env should always be non-null. |
143 | * |
144 | * Existence of a non-null top_env->je_prev implies it is valid to call |
6224f72b |
145 | * longjmp() at that runlevel (we make sure start_env.je_prev is always |
146 | * null to ensure this). |
54310121 |
147 | * |
148 | * je_mustcatch, when set at any runlevel to TRUE, means eval ops must |
149 | * establish a local jmpenv to handle exception traps. Care must be taken |
150 | * to restore the previous value of je_mustcatch before exiting the |
151 | * stack frame iff JMPENV_PUSH was not called in that stack frame. |
6224f72b |
152 | * GSAR 97-03-27 |
54310121 |
153 | */ |
154 | |
155 | struct jmpenv { |
156 | struct jmpenv * je_prev; |
312caa8e |
157 | Sigjmp_buf je_buf; /* only for use if !je_throw */ |
158 | int je_ret; /* last exception thrown */ |
159 | bool je_mustcatch; /* need to call longjmp()? */ |
160 | void (*je_throw)(int v); /* last for bincompat */ |
db36c5a1 |
161 | bool je_noset; /* no need for setjmp() */ |
1163b5c4 |
162 | }; |
1163b5c4 |
163 | |
6224f72b |
164 | typedef struct jmpenv JMPENV; |
1163b5c4 |
165 | |
312caa8e |
166 | /* |
167 | * Function that catches/throws, and its callback for the |
168 | * body of protected processing. |
169 | */ |
cea2e8a9 |
170 | typedef void *(CPERLscope(*protect_body_t)) (pTHX_ va_list); |
db36c5a1 |
171 | typedef void *(CPERLscope(*protect_proc_t)) (pTHX_ volatile JMPENV *pcur_env, |
172 | int *, protect_body_t, ...); |
312caa8e |
173 | |
174 | /* |
175 | * How to build the first jmpenv. |
176 | * |
177 | * top_env needs to be non-zero. It points to an area |
178 | * in which longjmp() stuff is stored, as C callstack |
179 | * info there at least is thread specific this has to |
180 | * be per-thread. Otherwise a 'die' in a thread gives |
181 | * that thread the C stack of last thread to do an eval {}! |
182 | */ |
183 | |
184 | #define JMPENV_BOOTSTRAP \ |
185 | STMT_START { \ |
186 | PL_start_env.je_prev = NULL; \ |
187 | PL_start_env.je_throw = NULL; \ |
188 | PL_start_env.je_ret = -1; \ |
189 | PL_start_env.je_mustcatch = TRUE; \ |
db36c5a1 |
190 | PL_start_env.je_noset = 0; \ |
312caa8e |
191 | PL_top_env = &PL_start_env; \ |
192 | } STMT_END |
193 | |
462e5cf6 |
194 | #ifdef OP_IN_REGISTER |
6b88bc9c |
195 | #define OP_REG_TO_MEM PL_opsave = op |
196 | #define OP_MEM_TO_REG op = PL_opsave |
462e5cf6 |
197 | #else |
198 | #define OP_REG_TO_MEM NOOP |
199 | #define OP_MEM_TO_REG NOOP |
200 | #endif |
201 | |
312caa8e |
202 | /* |
203 | * These exception-handling macros are split up to |
204 | * ease integration with C++ exceptions. |
205 | * |
206 | * To use C++ try+catch to catch Perl exceptions, an extension author |
207 | * needs to first write an extern "C" function to throw an appropriate |
208 | * exception object; typically it will be or contain an integer, |
209 | * because Perl's internals use integers to track exception types: |
210 | * extern "C" { static void thrower(int i) { throw i; } } |
211 | * |
212 | * Then (as shown below) the author needs to use, not the simple |
213 | * JMPENV_PUSH, but several of its constitutent macros, to arrange for |
214 | * the Perl internals to call thrower() rather than longjmp() to |
215 | * report exceptions: |
216 | * |
217 | * dJMPENV; |
218 | * JMPENV_PUSH_INIT(thrower); |
219 | * try { |
220 | * ... stuff that may throw exceptions ... |
221 | * } |
222 | * catch (int why) { // or whatever matches thrower() |
223 | * JMPENV_POST_CATCH; |
224 | * EXCEPT_SET(why); |
225 | * switch (why) { |
226 | * ... // handle various Perl exception codes |
227 | * } |
228 | * } |
229 | * JMPENV_POP; // don't forget this! |
230 | */ |
231 | |
db36c5a1 |
232 | #define dJMPENV JMPENV cur_env; \ |
233 | volatile JMPENV *pcur_env = ((cur_env.je_noset = 0),&cur_env) |
312caa8e |
234 | |
db36c5a1 |
235 | #define JMPENV_PUSH_INIT_ENV(ce,THROWFUNC) \ |
6224f72b |
236 | STMT_START { \ |
db36c5a1 |
237 | (ce).je_throw = (THROWFUNC); \ |
238 | (ce).je_ret = -1; \ |
239 | (ce).je_mustcatch = FALSE; \ |
240 | (ce).je_prev = PL_top_env; \ |
241 | PL_top_env = &(ce); \ |
6224f72b |
242 | OP_REG_TO_MEM; \ |
312caa8e |
243 | } STMT_END |
1d651c14 |
244 | |
db36c5a1 |
245 | #define JMPENV_PUSH_INIT(THROWFUNC) JMPENV_PUSH_INIT_ENV(*(JMPENV*)pcur_env,THROWFUNC) |
1d651c14 |
246 | |
db36c5a1 |
247 | #define JMPENV_POST_CATCH_ENV(ce) \ |
312caa8e |
248 | STMT_START { \ |
6224f72b |
249 | OP_MEM_TO_REG; \ |
db36c5a1 |
250 | PL_top_env = &(ce); \ |
6224f72b |
251 | } STMT_END |
312caa8e |
252 | |
db36c5a1 |
253 | #define JMPENV_POST_CATCH JMPENV_POST_CATCH_ENV(*(JMPENV*)pcur_env) |
1d651c14 |
254 | |
255 | |
db36c5a1 |
256 | #define JMPENV_PUSH_ENV(ce,v) \ |
257 | STMT_START { \ |
258 | if (!(ce).je_noset) { \ |
259 | JMPENV_PUSH_INIT_ENV(ce,NULL); \ |
260 | EXCEPT_SET_ENV(ce,PerlProc_setjmp((ce).je_buf, 1));\ |
261 | (ce).je_noset = 1; \ |
262 | } \ |
263 | else \ |
264 | EXCEPT_SET_ENV(ce,0); \ |
265 | JMPENV_POST_CATCH_ENV(ce); \ |
266 | (v) = EXCEPT_GET_ENV(ce); \ |
312caa8e |
267 | } STMT_END |
268 | |
db36c5a1 |
269 | #define JMPENV_PUSH(v) JMPENV_PUSH_ENV(*(JMPENV*)pcur_env,v) |
1d651c14 |
270 | |
db36c5a1 |
271 | #define JMPENV_POP_ENV(ce) \ |
272 | STMT_START { PL_top_env = (ce).je_prev; } STMT_END |
312caa8e |
273 | |
db36c5a1 |
274 | #define JMPENV_POP JMPENV_POP_ENV(*(JMPENV*)pcur_env) |
1d651c14 |
275 | |
22921e25 |
276 | #define JMPENV_JUMP(v) \ |
277 | STMT_START { \ |
462e5cf6 |
278 | OP_REG_TO_MEM; \ |
312caa8e |
279 | if (PL_top_env->je_prev) { \ |
280 | if (PL_top_env->je_throw) \ |
281 | PL_top_env->je_throw(v); \ |
282 | else \ |
283 | PerlProc_longjmp(PL_top_env->je_buf, (v)); \ |
284 | } \ |
6224f72b |
285 | if ((v) == 2) \ |
312caa8e |
286 | PerlProc_exit(STATUS_NATIVE_EXPORT); \ |
bf49b057 |
287 | PerlIO_printf(Perl_error_log, "panic: top_env\n"); \ |
312caa8e |
288 | PerlProc_exit(1); \ |
22921e25 |
289 | } STMT_END |
312caa8e |
290 | |
db36c5a1 |
291 | #define EXCEPT_GET_ENV(ce) ((ce).je_ret) |
292 | #define EXCEPT_GET EXCEPT_GET_ENV(*(JMPENV*)pcur_env) |
293 | #define EXCEPT_SET_ENV(ce,v) ((ce).je_ret = (v)) |
294 | #define EXCEPT_SET(v) EXCEPT_SET_ENV(*(JMPENV*)pcur_env,v) |
312caa8e |
295 | |
db36c5a1 |
296 | #define CATCH_GET (PL_top_env->je_mustcatch) |
297 | #define CATCH_SET(v) (PL_top_env->je_mustcatch = (v)) |