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 | |
79072805 | 31 | |
3280af22 NIS |
32 | #define SSCHECK(need) if (PL_savestack_ix + need > PL_savestack_max) savestack_grow() |
33 | #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i)) | |
34 | #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i)) | |
35 | #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i)) | |
36 | #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p)) | |
37 | #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p)) | |
38 | #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32) | |
39 | #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long) | |
40 | #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv) | |
41 | #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr) | |
42 | #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr) | |
8990e307 | 43 | |
3280af22 NIS |
44 | #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix |
45 | #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps() | |
a0d0e21e | 46 | |
f46d017c GS |
47 | #ifdef DEBUGGING |
48 | #define ENTER \ | |
49 | STMT_START { \ | |
50 | push_scope(); \ | |
f3dc24a5 | 51 | DEBUG_l(WITH_THR(deb("ENTER scope %ld at %s:%d\n", \ |
3280af22 | 52 | PL_scopestack_ix, __FILE__, __LINE__))); \ |
f46d017c GS |
53 | } STMT_END |
54 | #define LEAVE \ | |
55 | STMT_START { \ | |
f3dc24a5 | 56 | DEBUG_l(WITH_THR(deb("LEAVE scope %ld at %s:%d\n", \ |
3280af22 | 57 | PL_scopestack_ix, __FILE__, __LINE__))); \ |
f46d017c GS |
58 | pop_scope(); \ |
59 | } STMT_END | |
60 | #else | |
a0d0e21e LW |
61 | #define ENTER push_scope() |
62 | #define LEAVE pop_scope() | |
f46d017c | 63 | #endif |
3280af22 | 64 | #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old) |
a0d0e21e | 65 | |
55497cff | 66 | /* |
b9d12d37 | 67 | * Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV |
55497cff PP |
68 | * because these are used for several kinds of pointer values |
69 | */ | |
4fdae800 PP |
70 | #define SAVEI16(i) save_I16(SOFT_CAST(I16*)&(i)) |
71 | #define SAVEI32(i) save_I32(SOFT_CAST(I32*)&(i)) | |
72 | #define SAVEINT(i) save_int(SOFT_CAST(int*)&(i)) | |
73 | #define SAVEIV(i) save_iv(SOFT_CAST(IV*)&(i)) | |
74 | #define SAVELONG(l) save_long(SOFT_CAST(long*)&(l)) | |
55497cff PP |
75 | #define SAVESPTR(s) save_sptr((SV**)&(s)) |
76 | #define SAVEPPTR(s) save_pptr(SOFT_CAST(char**)&(s)) | |
77 | #define SAVEFREESV(s) save_freesv((SV*)(s)) | |
78 | #define SAVEFREEOP(o) save_freeop(SOFT_CAST(OP*)(o)) | |
79 | #define SAVEFREEPV(p) save_freepv(SOFT_CAST(char*)(p)) | |
80 | #define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv)) | |
b9d12d37 | 81 | #define SAVEGENERICSV(s) save_generic_svref((SV**)&(s)) |
55497cff PP |
82 | #define SAVEDELETE(h,k,l) \ |
83 | save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l)) | |
76e3520e | 84 | #ifdef PERL_OBJECT |
565764a8 | 85 | #define CALLDESTRUCTOR this->*SSPOPDPTR |
76e3520e | 86 | #define SAVEDESTRUCTOR(f,p) \ |
ac4c12e7 GS |
87 | save_destructor((DESTRUCTORFUNC)(FUNC_NAME_TO_PTR(f)), \ |
88 | SOFT_CAST(void*)(p)) | |
76e3520e | 89 | #else |
565764a8 | 90 | #define CALLDESTRUCTOR *SSPOPDPTR |
55497cff | 91 | #define SAVEDESTRUCTOR(f,p) \ |
ac4c12e7 GS |
92 | save_destructor(SOFT_CAST(void(*)_((void*)))(FUNC_NAME_TO_PTR(f)), \ |
93 | SOFT_CAST(void*)(p)) | |
76e3520e | 94 | #endif |
25eaa213 GS |
95 | |
96 | #define SAVESTACK_POS() \ | |
97 | STMT_START { \ | |
98 | SSCHECK(2); \ | |
3280af22 | 99 | SSPUSHINT(PL_stack_sp - PL_stack_base); \ |
25eaa213 GS |
100 | SSPUSHINT(SAVEt_STACK_POS); \ |
101 | } STMT_END | |
102 | ||
462e5cf6 | 103 | #define SAVEOP() save_op() |
25eaa213 GS |
104 | |
105 | #define SAVEHINTS() \ | |
106 | STMT_START { \ | |
3280af22 | 107 | if (PL_hints & HINT_LOCALIZE_HH) \ |
25eaa213 GS |
108 | save_hints(); \ |
109 | else { \ | |
110 | SSCHECK(2); \ | |
3280af22 | 111 | SSPUSHINT(PL_hints); \ |
25eaa213 GS |
112 | SSPUSHINT(SAVEt_HINTS); \ |
113 | } \ | |
114 | } STMT_END | |
a9332b4a | 115 | |
455ece5e AD |
116 | /* SSNEW() temporarily allocates a specified number of bytes of data on the |
117 | * savestack. It returns an integer index into the savestack, because a | |
118 | * pointer would get broken if the savestack is moved on reallocation. | |
119 | * SSNEWa() works like SSNEW(), but also aligns the data to the specified | |
120 | * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The | |
121 | * alignment will be preserved therough savestack reallocation *only* if | |
122 | * realloc returns data aligned to a size divisible by `align'! | |
123 | * | |
124 | * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer. | |
125 | */ | |
126 | ||
127 | #define SSNEW(size) save_alloc(size, 0) | |
128 | #define SSNEWa(size,align) save_alloc(size, \ | |
129 | (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align) | |
130 | ||
131 | #define SSPTR(off,type) ((type) ((char*)PL_savestack + off)) | |
132 | ||
54310121 PP |
133 | /* A jmpenv packages the state required to perform a proper non-local jump. |
134 | * Note that there is a start_env initialized when perl starts, and top_env | |
135 | * points to this initially, so top_env should always be non-null. | |
136 | * | |
137 | * Existence of a non-null top_env->je_prev implies it is valid to call | |
6224f72b GS |
138 | * longjmp() at that runlevel (we make sure start_env.je_prev is always |
139 | * null to ensure this). | |
54310121 PP |
140 | * |
141 | * je_mustcatch, when set at any runlevel to TRUE, means eval ops must | |
142 | * establish a local jmpenv to handle exception traps. Care must be taken | |
143 | * to restore the previous value of je_mustcatch before exiting the | |
144 | * stack frame iff JMPENV_PUSH was not called in that stack frame. | |
6224f72b | 145 | * GSAR 97-03-27 |
54310121 PP |
146 | */ |
147 | ||
148 | struct jmpenv { | |
149 | struct jmpenv * je_prev; | |
312caa8e CS |
150 | Sigjmp_buf je_buf; /* only for use if !je_throw */ |
151 | int je_ret; /* last exception thrown */ | |
152 | bool je_mustcatch; /* need to call longjmp()? */ | |
153 | void (*je_throw)(int v); /* last for bincompat */ | |
1163b5c4 | 154 | }; |
1163b5c4 | 155 | |
6224f72b | 156 | typedef struct jmpenv JMPENV; |
1163b5c4 | 157 | |
312caa8e CS |
158 | /* |
159 | * Function that catches/throws, and its callback for the | |
160 | * body of protected processing. | |
161 | */ | |
a6c40364 GS |
162 | typedef void *(CPERLscope(*protect_body_t)) _((va_list)); |
163 | typedef void *(CPERLscope(*protect_proc_t)) _((int *, protect_body_t, ...)); | |
312caa8e CS |
164 | |
165 | /* | |
166 | * How to build the first jmpenv. | |
167 | * | |
168 | * top_env needs to be non-zero. It points to an area | |
169 | * in which longjmp() stuff is stored, as C callstack | |
170 | * info there at least is thread specific this has to | |
171 | * be per-thread. Otherwise a 'die' in a thread gives | |
172 | * that thread the C stack of last thread to do an eval {}! | |
173 | */ | |
174 | ||
175 | #define JMPENV_BOOTSTRAP \ | |
176 | STMT_START { \ | |
177 | PL_start_env.je_prev = NULL; \ | |
178 | PL_start_env.je_throw = NULL; \ | |
179 | PL_start_env.je_ret = -1; \ | |
180 | PL_start_env.je_mustcatch = TRUE; \ | |
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 | ||
6224f72b | 222 | #define dJMPENV JMPENV cur_env |
312caa8e CS |
223 | |
224 | #define JMPENV_PUSH_INIT(THROWFUNC) \ | |
6224f72b | 225 | STMT_START { \ |
312caa8e CS |
226 | cur_env.je_throw = (THROWFUNC); \ |
227 | cur_env.je_ret = -1; \ | |
228 | cur_env.je_mustcatch = FALSE; \ | |
3280af22 | 229 | cur_env.je_prev = PL_top_env; \ |
312caa8e | 230 | PL_top_env = &cur_env; \ |
6224f72b | 231 | OP_REG_TO_MEM; \ |
312caa8e CS |
232 | } STMT_END |
233 | #define JMPENV_POST_CATCH \ | |
234 | STMT_START { \ | |
6224f72b | 235 | OP_MEM_TO_REG; \ |
3280af22 | 236 | PL_top_env = &cur_env; \ |
6224f72b | 237 | } STMT_END |
312caa8e CS |
238 | |
239 | #define JMPENV_PUSH(v) \ | |
240 | STMT_START { \ | |
241 | JMPENV_PUSH_INIT(NULL); \ | |
242 | EXCEPT_SET(PerlProc_setjmp(cur_env.je_buf, 1)); \ | |
243 | JMPENV_POST_CATCH; \ | |
244 | (v) = EXCEPT_GET; \ | |
245 | } STMT_END | |
246 | ||
6224f72b | 247 | #define JMPENV_POP \ |
3280af22 | 248 | STMT_START { PL_top_env = cur_env.je_prev; } STMT_END |
312caa8e | 249 | |
22921e25 CS |
250 | #define JMPENV_JUMP(v) \ |
251 | STMT_START { \ | |
462e5cf6 | 252 | OP_REG_TO_MEM; \ |
312caa8e CS |
253 | if (PL_top_env->je_prev) { \ |
254 | if (PL_top_env->je_throw) \ | |
255 | PL_top_env->je_throw(v); \ | |
256 | else \ | |
257 | PerlProc_longjmp(PL_top_env->je_buf, (v)); \ | |
258 | } \ | |
6224f72b | 259 | if ((v) == 2) \ |
312caa8e | 260 | PerlProc_exit(STATUS_NATIVE_EXPORT); \ |
6224f72b | 261 | PerlIO_printf(PerlIO_stderr(), "panic: top_env\n"); \ |
312caa8e | 262 | PerlProc_exit(1); \ |
22921e25 | 263 | } STMT_END |
312caa8e CS |
264 | |
265 | #define EXCEPT_GET (cur_env.je_ret) | |
266 | #define EXCEPT_SET(v) (cur_env.je_ret = (v)) | |
267 | ||
3280af22 NIS |
268 | #define CATCH_GET (PL_top_env->je_mustcatch) |
269 | #define CATCH_SET(v) (PL_top_env->je_mustcatch = (v)) | |
6224f72b | 270 |