Commit | Line | Data |
a0d0e21e |
1 | /* cop.h |
79072805 |
2 | * |
4bb101f2 |
3 | * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, |
acde74e1 |
4 | * 2000, 2001, 2002, 2003, 2004, 2005, 2006 by Larry Wall and others |
79072805 |
5 | * |
6 | * You may distribute under the terms of either the GNU General Public |
7 | * License or the Artistic License, as specified in the README file. |
8 | * |
a3985cdc |
9 | * Control ops (cops) are one of the three ops OP_NEXTSTATE, OP_DBSTATE, |
3ffa1527 |
10 | * and OP_SETSTATE that (loosely speaking) are separate statements. |
11 | * They hold information important for lexical state and error reporting. |
12 | * At run time, PL_curcop is set to point to the most recently executed cop, |
a3985cdc |
13 | * and thus can be used to determine our current state. |
79072805 |
14 | */ |
15 | |
0d2925a6 |
16 | /* A jmpenv packages the state required to perform a proper non-local jump. |
17 | * Note that there is a start_env initialized when perl starts, and top_env |
18 | * points to this initially, so top_env should always be non-null. |
19 | * |
20 | * Existence of a non-null top_env->je_prev implies it is valid to call |
21 | * longjmp() at that runlevel (we make sure start_env.je_prev is always |
22 | * null to ensure this). |
23 | * |
24 | * je_mustcatch, when set at any runlevel to TRUE, means eval ops must |
25 | * establish a local jmpenv to handle exception traps. Care must be taken |
26 | * to restore the previous value of je_mustcatch before exiting the |
27 | * stack frame iff JMPENV_PUSH was not called in that stack frame. |
28 | * GSAR 97-03-27 |
29 | */ |
30 | |
31 | struct jmpenv { |
32 | struct jmpenv * je_prev; |
33 | Sigjmp_buf je_buf; /* only for use if !je_throw */ |
34 | int je_ret; /* last exception thrown */ |
35 | bool je_mustcatch; /* need to call longjmp()? */ |
36 | }; |
37 | |
38 | typedef struct jmpenv JMPENV; |
39 | |
40 | #ifdef OP_IN_REGISTER |
41 | #define OP_REG_TO_MEM PL_opsave = op |
42 | #define OP_MEM_TO_REG op = PL_opsave |
43 | #else |
44 | #define OP_REG_TO_MEM NOOP |
45 | #define OP_MEM_TO_REG NOOP |
46 | #endif |
47 | |
48 | /* |
49 | * How to build the first jmpenv. |
50 | * |
51 | * top_env needs to be non-zero. It points to an area |
52 | * in which longjmp() stuff is stored, as C callstack |
53 | * info there at least is thread specific this has to |
54 | * be per-thread. Otherwise a 'die' in a thread gives |
55 | * that thread the C stack of last thread to do an eval {}! |
56 | */ |
57 | |
58 | #define JMPENV_BOOTSTRAP \ |
59 | STMT_START { \ |
60 | Zero(&PL_start_env, 1, JMPENV); \ |
61 | PL_start_env.je_ret = -1; \ |
62 | PL_start_env.je_mustcatch = TRUE; \ |
63 | PL_top_env = &PL_start_env; \ |
64 | } STMT_END |
65 | |
66 | /* |
67 | * PERL_FLEXIBLE_EXCEPTIONS |
68 | * |
69 | * All the flexible exceptions code has been removed. |
70 | * See the following threads for details: |
71 | * |
72 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2004-07/msg00378.html |
73 | * |
74 | * Joshua's original patches (which weren't applied) and discussion: |
75 | * |
76 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01396.html |
77 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01489.html |
78 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01491.html |
79 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01608.html |
80 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02144.html |
81 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02998.html |
82 | * |
83 | * Chip's reworked patch and discussion: |
84 | * |
85 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html |
86 | * |
87 | * The flaw in these patches (which went unnoticed at the time) was |
88 | * that they moved some code that could potentially die() out of the |
89 | * region protected by the setjmp()s. This caused exceptions within |
90 | * END blocks and such to not be handled by the correct setjmp(). |
91 | * |
92 | * The original patches that introduces flexible exceptions were: |
93 | * |
94 | * http://public.activestate.com/cgi-bin/perlbrowse?patch=3386 |
95 | * http://public.activestate.com/cgi-bin/perlbrowse?patch=5162 |
96 | */ |
97 | |
98 | #define dJMPENV JMPENV cur_env |
99 | |
100 | #define JMPENV_PUSH(v) \ |
101 | STMT_START { \ |
102 | DEBUG_l(Perl_deb(aTHX_ "Setting up jumplevel %p, was %p\n", \ |
103 | &cur_env, PL_top_env)); \ |
104 | cur_env.je_prev = PL_top_env; \ |
105 | OP_REG_TO_MEM; \ |
106 | cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK); \ |
107 | OP_MEM_TO_REG; \ |
108 | PL_top_env = &cur_env; \ |
109 | cur_env.je_mustcatch = FALSE; \ |
110 | (v) = cur_env.je_ret; \ |
111 | } STMT_END |
112 | |
113 | #define JMPENV_POP \ |
114 | STMT_START { \ |
115 | DEBUG_l(Perl_deb(aTHX_ "popping jumplevel was %p, now %p\n", \ |
116 | PL_top_env, cur_env.je_prev)); \ |
117 | PL_top_env = cur_env.je_prev; \ |
118 | } STMT_END |
119 | |
120 | #define JMPENV_JUMP(v) \ |
121 | STMT_START { \ |
122 | OP_REG_TO_MEM; \ |
123 | if (PL_top_env->je_prev) \ |
124 | PerlProc_longjmp(PL_top_env->je_buf, (v)); \ |
125 | if ((v) == 2) \ |
37038d91 |
126 | PerlProc_exit(STATUS_EXIT); \ |
0d2925a6 |
127 | PerlIO_printf(PerlIO_stderr(), "panic: top_env\n"); \ |
128 | PerlProc_exit(1); \ |
129 | } STMT_END |
130 | |
131 | #define CATCH_GET (PL_top_env->je_mustcatch) |
132 | #define CATCH_SET(v) (PL_top_env->je_mustcatch = (v)) |
133 | |
134 | |
135 | |
79072805 |
136 | struct cop { |
137 | BASEOP |
a0d0e21e |
138 | char * cop_label; /* label for this construct */ |
57843af0 |
139 | #ifdef USE_ITHREADS |
11faa288 |
140 | char * cop_stashpv; /* package line was compiled in */ |
57843af0 |
141 | char * cop_file; /* file name the following line # is from */ |
142 | #else |
11faa288 |
143 | HV * cop_stash; /* package line was compiled in */ |
79072805 |
144 | GV * cop_filegv; /* file the following line # is from */ |
57843af0 |
145 | #endif |
a0d0e21e |
146 | U32 cop_seq; /* parse sequence number */ |
147 | I32 cop_arybase; /* array base this line was compiled with */ |
79072805 |
148 | line_t cop_line; /* line # of this command */ |
72dc9ed5 |
149 | /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *: */ |
150 | STRLEN * cop_warnings; /* lexical warnings bitmask */ |
ac27b0f5 |
151 | SV * cop_io; /* lexical IO defaults */ |
b3ca2e83 |
152 | /* compile time state of %^H. See the comment in op.c for how this is |
153 | used to recreate a hash to return from caller. */ |
154 | struct refcounted_he * cop_hints; |
79072805 |
155 | }; |
156 | |
57843af0 |
157 | #ifdef USE_ITHREADS |
158 | # define CopFILE(c) ((c)->cop_file) |
159 | # define CopFILEGV(c) (CopFILE(c) \ |
a0714e2c |
160 | ? gv_fetchfile(CopFILE(c)) : NULL) |
083fcd59 |
161 | |
7e4e8c89 |
162 | # ifdef NETWARE |
163 | # define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv)) |
164 | # else |
165 | # define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv)) |
166 | # endif |
083fcd59 |
167 | |
57843af0 |
168 | # define CopFILESV(c) (CopFILE(c) \ |
a0714e2c |
169 | ? GvSV(gv_fetchfile(CopFILE(c))) : NULL) |
57843af0 |
170 | # define CopFILEAV(c) (CopFILE(c) \ |
7d49f689 |
171 | ? GvAV(gv_fetchfile(CopFILE(c))) : NULL) |
8688788e |
172 | # ifdef DEBUGGING |
173 | # define CopFILEAVx(c) (assert(CopFILE(c)), \ |
36c7798d |
174 | GvAV(gv_fetchfile(CopFILE(c)))) |
8688788e |
175 | # else |
176 | # define CopFILEAVx(c) (GvAV(gv_fetchfile(CopFILE(c)))) |
177 | # endif |
57843af0 |
178 | # define CopSTASHPV(c) ((c)->cop_stashpv) |
083fcd59 |
179 | |
7e4e8c89 |
180 | # ifdef NETWARE |
bd61b366 |
181 | # define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = ((pv) ? savepv(pv) : NULL)) |
7e4e8c89 |
182 | # else |
183 | # define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = savesharedpv(pv)) |
184 | # endif |
083fcd59 |
185 | |
11faa288 |
186 | # define CopSTASH(c) (CopSTASHPV(c) \ |
5c284bb0 |
187 | ? gv_stashpv(CopSTASHPV(c),GV_ADD) : NULL) |
bd61b366 |
188 | # define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME_get(hv) : NULL) |
ed221c57 |
189 | # define CopSTASH_eq(c,hv) ((hv) && stashpv_hvname_match(c,hv)) |
7e4e8c89 |
190 | # ifdef NETWARE |
191 | # define CopSTASH_free(c) SAVECOPSTASH_FREE(c) |
7e4e8c89 |
192 | # define CopFILE_free(c) SAVECOPFILE_FREE(c) |
193 | # else |
ed221c57 |
194 | # define CopSTASH_free(c) PerlMemShared_free(CopSTASHPV(c)) |
bd61b366 |
195 | # define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL)) |
7e4e8c89 |
196 | # endif |
57843af0 |
197 | #else |
198 | # define CopFILEGV(c) ((c)->cop_filegv) |
f4dd75d9 |
199 | # define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv)) |
200 | # define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv)) |
a0714e2c |
201 | # define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL) |
7d49f689 |
202 | # define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL) |
8688788e |
203 | # ifdef DEBUGGING |
204 | # define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c))) |
205 | # else |
206 | # define CopFILEAVx(c) (GvAV(CopFILEGV(c))) |
207 | # endif |
bd61b366 |
208 | # define CopFILE(c) (CopFILESV(c) ? SvPVX(CopFILESV(c)) : NULL) |
57843af0 |
209 | # define CopSTASH(c) ((c)->cop_stash) |
f4dd75d9 |
210 | # define CopSTASH_set(c,hv) ((c)->cop_stash = (hv)) |
bd61b366 |
211 | # define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL) |
f4dd75d9 |
212 | /* cop_stash is not refcounted */ |
213 | # define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD)) |
214 | # define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv)) |
05ec9bb3 |
215 | # define CopSTASH_free(c) |
a0714e2c |
216 | # define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL)) |
05ec9bb3 |
217 | |
57843af0 |
218 | #endif /* USE_ITHREADS */ |
219 | |
ed094faf |
220 | #define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv)) |
cc49e20b |
221 | #define CopLINE(c) ((c)->cop_line) |
57843af0 |
222 | #define CopLINE_inc(c) (++CopLINE(c)) |
223 | #define CopLINE_dec(c) (--CopLINE(c)) |
224 | #define CopLINE_set(c,l) (CopLINE(c) = (l)) |
cc49e20b |
225 | |
248c2a4d |
226 | /* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */ |
227 | #ifdef MACOS_TRADITIONAL |
228 | # define OutCopFILE(c) MacPerl_MPWFileName(CopFILE(c)) |
229 | #else |
230 | # define OutCopFILE(c) CopFILE(c) |
231 | #endif |
232 | |
fc15ae8f |
233 | /* CopARYBASE is likely to be removed soon. */ |
234 | #define CopARYBASE(c) ((c)->cop_arybase) |
235 | #define CopARYBASE_get(c) ((c)->cop_arybase + 0) |
236 | #define CopARYBASE_set(c, b) STMT_START { (c)->cop_arybase = (b); } STMT_END |
237 | |
623e6609 |
238 | /* FIXME NATIVE_HINTS if this is changed from op_private (see perl.h) */ |
239 | #define CopHINTS_get(c) ((c)->op_private + 0) |
240 | #define CopHINTS_set(c, h) STMT_START { \ |
241 | (c)->op_private \ |
242 | = (U8)((h) & HINT_PRIVATE_MASK); \ |
243 | } STMT_END |
244 | |
79072805 |
245 | /* |
246 | * Here we have some enormously heavy (or at least ponderous) wizardry. |
247 | */ |
248 | |
249 | /* subroutine context */ |
250 | struct block_sub { |
251 | CV * cv; |
252 | GV * gv; |
463ee0b2 |
253 | GV * dfoutgv; |
79072805 |
254 | AV * savearray; |
255 | AV * argarray; |
bb172083 |
256 | I32 olddepth; |
79072805 |
257 | U8 hasargs; |
cd06dffe |
258 | U8 lval; /* XXX merge lval and hasargs? */ |
f3548bdc |
259 | PAD *oldcomppad; |
f39bc417 |
260 | OP * retop; /* op to execute on exit from sub */ |
79072805 |
261 | }; |
262 | |
b36bdeca |
263 | /* base for the next two macros. Don't use directly. |
264 | * Note that the refcnt of the cv is incremented twice; The CX one is |
265 | * decremented by LEAVESUB, the other by LEAVE. */ |
266 | |
ee98a1d6 |
267 | #define PUSHSUB_BASE(cx) \ |
79072805 |
268 | cx->blk_sub.cv = cv; \ |
b8f55b69 |
269 | cx->blk_sub.olddepth = CvDEPTH(cv); \ |
b36bdeca |
270 | cx->blk_sub.hasargs = hasargs; \ |
5f66b61c |
271 | cx->blk_sub.retop = NULL; \ |
b36bdeca |
272 | if (!CvDEPTH(cv)) { \ |
b37c2d43 |
273 | SvREFCNT_inc_void(cv); \ |
274 | SvREFCNT_inc_void(cv); \ |
b36bdeca |
275 | SAVEFREESV(cv); \ |
276 | } |
277 | |
ee98a1d6 |
278 | |
279 | #define PUSHSUB(cx) \ |
280 | PUSHSUB_BASE(cx) \ |
cd06dffe |
281 | cx->blk_sub.lval = PL_op->op_private & \ |
282 | (OPpLVAL_INTRO|OPpENTERSUB_INARGS); |
79072805 |
283 | |
ee98a1d6 |
284 | /* variant for use by OP_DBSTATE, where op_private holds hint bits */ |
285 | #define PUSHSUB_DB(cx) \ |
286 | PUSHSUB_BASE(cx) \ |
287 | cx->blk_sub.lval = 0; |
288 | |
289 | |
79072805 |
290 | #define PUSHFORMAT(cx) \ |
291 | cx->blk_sub.cv = cv; \ |
292 | cx->blk_sub.gv = gv; \ |
5f66b61c |
293 | cx->blk_sub.retop = NULL; \ |
4633a7c4 |
294 | cx->blk_sub.hasargs = 0; \ |
3280af22 |
295 | cx->blk_sub.dfoutgv = PL_defoutgv; \ |
b37c2d43 |
296 | SvREFCNT_inc_void(cx->blk_sub.dfoutgv) |
79072805 |
297 | |
3db8f154 |
298 | #define POP_SAVEARRAY() \ |
6d4ff0d2 |
299 | STMT_START { \ |
3280af22 |
300 | SvREFCNT_dec(GvAV(PL_defgv)); \ |
a8bba7fa |
301 | GvAV(PL_defgv) = cx->blk_sub.savearray; \ |
6d4ff0d2 |
302 | } STMT_END |
6d4ff0d2 |
303 | |
ecf8e9dd |
304 | /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't |
8e09340b |
305 | * leave any (a fast av_clear(ary), basically) */ |
306 | #define CLEAR_ARGARRAY(ary) \ |
307 | STMT_START { \ |
308 | AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \ |
f880fe2f |
309 | SvPV_set(ary, (char*)AvALLOC(ary)); \ |
8e09340b |
310 | AvFILLp(ary) = -1; \ |
311 | } STMT_END |
7766f137 |
312 | |
b0d9ce38 |
313 | #define POPSUB(cx,sv) \ |
314 | STMT_START { \ |
a8bba7fa |
315 | if (cx->blk_sub.hasargs) { \ |
7766f137 |
316 | POP_SAVEARRAY(); \ |
d8b46c1b |
317 | /* abandon @_ if it got reified */ \ |
a8bba7fa |
318 | if (AvREAL(cx->blk_sub.argarray)) { \ |
319 | SSize_t fill = AvFILLp(cx->blk_sub.argarray); \ |
320 | SvREFCNT_dec(cx->blk_sub.argarray); \ |
321 | cx->blk_sub.argarray = newAV(); \ |
322 | av_extend(cx->blk_sub.argarray, fill); \ |
11ca45c0 |
323 | AvREIFY_only(cx->blk_sub.argarray); \ |
dd2155a4 |
324 | CX_CURPAD_SV(cx->blk_sub, 0) = (SV*)cx->blk_sub.argarray; \ |
d8b46c1b |
325 | } \ |
7766f137 |
326 | else { \ |
8e09340b |
327 | CLEAR_ARGARRAY(cx->blk_sub.argarray); \ |
7766f137 |
328 | } \ |
79072805 |
329 | } \ |
b0d9ce38 |
330 | sv = (SV*)cx->blk_sub.cv; \ |
331 | if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \ |
a0714e2c |
332 | sv = NULL; \ |
b0d9ce38 |
333 | } STMT_END |
334 | |
335 | #define LEAVESUB(sv) \ |
336 | STMT_START { \ |
337 | if (sv) \ |
338 | SvREFCNT_dec(sv); \ |
339 | } STMT_END |
79072805 |
340 | |
341 | #define POPFORMAT(cx) \ |
4633a7c4 |
342 | setdefout(cx->blk_sub.dfoutgv); \ |
343 | SvREFCNT_dec(cx->blk_sub.dfoutgv); |
79072805 |
344 | |
345 | /* eval context */ |
346 | struct block_eval { |
347 | I32 old_in_eval; |
348 | I32 old_op_type; |
0f79a09d |
349 | SV * old_namesv; |
79072805 |
350 | OP * old_eval_root; |
748a9306 |
351 | SV * cur_text; |
2090ab20 |
352 | CV * cv; |
f39bc417 |
353 | OP * retop; /* op to execute on exit from eval */ |
abd70938 |
354 | JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */ |
79072805 |
355 | }; |
356 | |
8990e307 |
357 | #define PUSHEVAL(cx,n,fgv) \ |
0f79a09d |
358 | STMT_START { \ |
3280af22 |
359 | cx->blk_eval.old_in_eval = PL_in_eval; \ |
a8bba7fa |
360 | cx->blk_eval.old_op_type = PL_op->op_type; \ |
a0714e2c |
361 | cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL); \ |
a8bba7fa |
362 | cx->blk_eval.old_eval_root = PL_eval_root; \ |
0f79a09d |
363 | cx->blk_eval.cur_text = PL_linestr; \ |
601f1833 |
364 | cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */ \ |
5f66b61c |
365 | cx->blk_eval.retop = NULL; \ |
abd70938 |
366 | cx->blk_eval.cur_top_env = PL_top_env; \ |
0f79a09d |
367 | } STMT_END |
79072805 |
368 | |
369 | #define POPEVAL(cx) \ |
0f79a09d |
370 | STMT_START { \ |
3280af22 |
371 | PL_in_eval = cx->blk_eval.old_in_eval; \ |
79072805 |
372 | optype = cx->blk_eval.old_op_type; \ |
7766f137 |
373 | PL_eval_root = cx->blk_eval.old_eval_root; \ |
0f79a09d |
374 | if (cx->blk_eval.old_namesv) \ |
375 | sv_2mortal(cx->blk_eval.old_namesv); \ |
376 | } STMT_END |
79072805 |
377 | |
378 | /* loop context */ |
379 | struct block_loop { |
380 | char * label; |
381 | I32 resetsp; |
382 | OP * redo_op; |
383 | OP * next_op; |
384 | OP * last_op; |
7766f137 |
385 | #ifdef USE_ITHREADS |
386 | void * iterdata; |
f3548bdc |
387 | PAD *oldcomppad; |
7766f137 |
388 | #else |
79072805 |
389 | SV ** itervar; |
7766f137 |
390 | #endif |
79072805 |
391 | SV * itersave; |
5f05dabc |
392 | SV * iterlval; |
79072805 |
393 | AV * iterary; |
89ea2908 |
394 | IV iterix; |
395 | IV itermax; |
79072805 |
396 | }; |
397 | |
7766f137 |
398 | #ifdef USE_ITHREADS |
399 | # define CxITERVAR(c) \ |
400 | ((c)->blk_loop.iterdata \ |
401 | ? (CxPADLOOP(cx) \ |
dd2155a4 |
402 | ? &CX_CURPAD_SV( (c)->blk_loop, \ |
403 | INT2PTR(PADOFFSET, (c)->blk_loop.iterdata)) \ |
7766f137 |
404 | : &GvSV((GV*)(c)->blk_loop.iterdata)) \ |
405 | : (SV**)NULL) |
406 | # define CX_ITERDATA_SET(cx,idata) \ |
dd2155a4 |
407 | CX_CURPAD_SAVE(cx->blk_loop); \ |
155aba94 |
408 | if ((cx->blk_loop.iterdata = (idata))) \ |
d10edb75 |
409 | cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \ |
410 | else \ |
a0714e2c |
411 | cx->blk_loop.itersave = NULL; |
7766f137 |
412 | #else |
413 | # define CxITERVAR(c) ((c)->blk_loop.itervar) |
414 | # define CX_ITERDATA_SET(cx,ivar) \ |
155aba94 |
415 | if ((cx->blk_loop.itervar = (SV**)(ivar))) \ |
d10edb75 |
416 | cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \ |
417 | else \ |
a0714e2c |
418 | cx->blk_loop.itersave = NULL; |
7766f137 |
419 | #endif |
420 | |
421 | #define PUSHLOOP(cx, dat, s) \ |
38a230cb |
422 | cx->blk_loop.label = PL_curcop->cop_label; \ |
423 | cx->blk_loop.resetsp = s - PL_stack_base; \ |
79072805 |
424 | cx->blk_loop.redo_op = cLOOP->op_redoop; \ |
425 | cx->blk_loop.next_op = cLOOP->op_nextop; \ |
426 | cx->blk_loop.last_op = cLOOP->op_lastop; \ |
a0714e2c |
427 | cx->blk_loop.iterlval = NULL; \ |
7d49f689 |
428 | cx->blk_loop.iterary = NULL; \ |
7766f137 |
429 | cx->blk_loop.iterix = -1; \ |
430 | CX_ITERDATA_SET(cx,dat); |
79072805 |
431 | |
432 | #define POPLOOP(cx) \ |
a8bba7fa |
433 | SvREFCNT_dec(cx->blk_loop.iterlval); \ |
7766f137 |
434 | if (CxITERVAR(cx)) { \ |
21401c75 |
435 | if (SvPADMY(cx->blk_loop.itersave)) { \ |
d4c19fe8 |
436 | SV ** const s_v_p = CxITERVAR(cx); \ |
21401c75 |
437 | sv_2mortal(*s_v_p); \ |
438 | *s_v_p = cx->blk_loop.itersave; \ |
439 | } \ |
440 | else { \ |
441 | SvREFCNT_dec(cx->blk_loop.itersave); \ |
442 | } \ |
44a8e56a |
443 | } \ |
a8bba7fa |
444 | if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\ |
445 | SvREFCNT_dec(cx->blk_loop.iterary); |
79072805 |
446 | |
0d863452 |
447 | /* given/when context */ |
448 | struct block_givwhen { |
449 | OP *leave_op; |
450 | }; |
451 | |
452 | #define PUSHGIVEN(cx) \ |
453 | cx->blk_givwhen.leave_op = cLOGOP->op_other; |
454 | |
455 | #define PUSHWHEN PUSHGIVEN |
456 | |
79072805 |
457 | /* context common to subroutines, evals and loops */ |
458 | struct block { |
459 | I32 blku_oldsp; /* stack pointer to copy stuff down to */ |
460 | COP * blku_oldcop; /* old curcop pointer */ |
79072805 |
461 | I32 blku_oldmarksp; /* mark stack index */ |
462 | I32 blku_oldscopesp; /* scope stack index */ |
463 | PMOP * blku_oldpm; /* values of pattern match vars */ |
464 | U8 blku_gimme; /* is this block running in list context? */ |
465 | |
466 | union { |
467 | struct block_sub blku_sub; |
468 | struct block_eval blku_eval; |
469 | struct block_loop blku_loop; |
0d863452 |
470 | struct block_givwhen blku_givwhen; |
79072805 |
471 | } blk_u; |
472 | }; |
473 | #define blk_oldsp cx_u.cx_blk.blku_oldsp |
474 | #define blk_oldcop cx_u.cx_blk.blku_oldcop |
79072805 |
475 | #define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp |
476 | #define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp |
477 | #define blk_oldpm cx_u.cx_blk.blku_oldpm |
478 | #define blk_gimme cx_u.cx_blk.blku_gimme |
479 | #define blk_sub cx_u.cx_blk.blk_u.blku_sub |
480 | #define blk_eval cx_u.cx_blk.blk_u.blku_eval |
481 | #define blk_loop cx_u.cx_blk.blk_u.blku_loop |
0d863452 |
482 | #define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen |
79072805 |
483 | |
484 | /* Enter a block. */ |
8990e307 |
485 | #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \ |
79072805 |
486 | cx->cx_type = t, \ |
3280af22 |
487 | cx->blk_oldsp = sp - PL_stack_base, \ |
488 | cx->blk_oldcop = PL_curcop, \ |
1aff0e91 |
489 | cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \ |
3280af22 |
490 | cx->blk_oldscopesp = PL_scopestack_ix, \ |
3280af22 |
491 | cx->blk_oldpm = PL_curpm, \ |
eb160463 |
492 | cx->blk_gimme = (U8)gimme; \ |
bf49b057 |
493 | DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \ |
1aff0e91 |
494 | (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); ) |
79072805 |
495 | |
496 | /* Exit a block (RETURN and LAST). */ |
a0d0e21e |
497 | #define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \ |
1aff0e91 |
498 | newsp = PL_stack_base + cx->blk_oldsp, \ |
3280af22 |
499 | PL_curcop = cx->blk_oldcop, \ |
500 | PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \ |
501 | PL_scopestack_ix = cx->blk_oldscopesp, \ |
3280af22 |
502 | pm = cx->blk_oldpm, \ |
503 | gimme = cx->blk_gimme; \ |
b4ab917c |
504 | DEBUG_SCOPE("POPBLOCK"); \ |
bf49b057 |
505 | DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \ |
22c35a8c |
506 | (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); ) |
79072805 |
507 | |
508 | /* Continue a block elsewhere (NEXT and REDO). */ |
3280af22 |
509 | #define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \ |
1aff0e91 |
510 | PL_stack_sp = PL_stack_base + cx->blk_oldsp, \ |
3280af22 |
511 | PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \ |
512 | PL_scopestack_ix = cx->blk_oldscopesp, \ |
b4ab917c |
513 | PL_curpm = cx->blk_oldpm; \ |
514 | DEBUG_SCOPE("TOPBLOCK"); |
79072805 |
515 | |
516 | /* substitution context */ |
517 | struct subst { |
518 | I32 sbu_iters; |
519 | I32 sbu_maxiters; |
22e551b9 |
520 | I32 sbu_rflags; |
4633a7c4 |
521 | I32 sbu_oldsave; |
71be2cbc |
522 | bool sbu_once; |
523 | bool sbu_rxtainted; |
79072805 |
524 | char * sbu_orig; |
525 | SV * sbu_dstr; |
526 | SV * sbu_targ; |
527 | char * sbu_s; |
528 | char * sbu_m; |
529 | char * sbu_strend; |
c90c0ff4 |
530 | void * sbu_rxres; |
c07a80fd |
531 | REGEXP * sbu_rx; |
79072805 |
532 | }; |
533 | #define sb_iters cx_u.cx_subst.sbu_iters |
534 | #define sb_maxiters cx_u.cx_subst.sbu_maxiters |
22e551b9 |
535 | #define sb_rflags cx_u.cx_subst.sbu_rflags |
4633a7c4 |
536 | #define sb_oldsave cx_u.cx_subst.sbu_oldsave |
71be2cbc |
537 | #define sb_once cx_u.cx_subst.sbu_once |
538 | #define sb_rxtainted cx_u.cx_subst.sbu_rxtainted |
79072805 |
539 | #define sb_orig cx_u.cx_subst.sbu_orig |
540 | #define sb_dstr cx_u.cx_subst.sbu_dstr |
541 | #define sb_targ cx_u.cx_subst.sbu_targ |
542 | #define sb_s cx_u.cx_subst.sbu_s |
543 | #define sb_m cx_u.cx_subst.sbu_m |
544 | #define sb_strend cx_u.cx_subst.sbu_strend |
c90c0ff4 |
545 | #define sb_rxres cx_u.cx_subst.sbu_rxres |
c07a80fd |
546 | #define sb_rx cx_u.cx_subst.sbu_rx |
79072805 |
547 | |
548 | #define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \ |
549 | cx->sb_iters = iters, \ |
550 | cx->sb_maxiters = maxiters, \ |
22e551b9 |
551 | cx->sb_rflags = r_flags, \ |
4633a7c4 |
552 | cx->sb_oldsave = oldsave, \ |
71be2cbc |
553 | cx->sb_once = once, \ |
554 | cx->sb_rxtainted = rxtainted, \ |
79072805 |
555 | cx->sb_orig = orig, \ |
556 | cx->sb_dstr = dstr, \ |
557 | cx->sb_targ = targ, \ |
558 | cx->sb_s = s, \ |
559 | cx->sb_m = m, \ |
560 | cx->sb_strend = strend, \ |
4608196e |
561 | cx->sb_rxres = NULL, \ |
c07a80fd |
562 | cx->sb_rx = rx, \ |
c90c0ff4 |
563 | cx->cx_type = CXt_SUBST; \ |
564 | rxres_save(&cx->sb_rxres, rx) |
79072805 |
565 | |
c90c0ff4 |
566 | #define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \ |
567 | rxres_free(&cx->sb_rxres) |
79072805 |
568 | |
569 | struct context { |
6b35e009 |
570 | U32 cx_type; /* what kind of context this is */ |
79072805 |
571 | union { |
572 | struct block cx_blk; |
573 | struct subst cx_subst; |
574 | } cx_u; |
575 | }; |
6b35e009 |
576 | |
577 | #define CXTYPEMASK 0xff |
79072805 |
578 | #define CXt_NULL 0 |
579 | #define CXt_SUB 1 |
580 | #define CXt_EVAL 2 |
581 | #define CXt_LOOP 3 |
582 | #define CXt_SUBST 4 |
583 | #define CXt_BLOCK 5 |
7766f137 |
584 | #define CXt_FORMAT 6 |
0d863452 |
585 | #define CXt_GIVEN 7 |
586 | #define CXt_WHEN 8 |
79072805 |
587 | |
9850bf21 |
588 | /* private flags for CXt_SUB and CXt_NULL */ |
589 | #define CXp_MULTICALL 0x00000400 /* part of a multicall (so don't |
590 | tear down context on exit). */ |
591 | |
6b35e009 |
592 | /* private flags for CXt_EVAL */ |
593 | #define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */ |
1d76a5c3 |
594 | #define CXp_TRYBLOCK 0x00000200 /* eval{}, not eval'' or similar */ |
6b35e009 |
595 | |
7766f137 |
596 | /* private flags for CXt_LOOP */ |
0d863452 |
597 | #define CXp_FOREACH 0x00000200 /* a foreach loop */ |
598 | #define CXp_FOR_DEF 0x00000400 /* foreach using $_ */ |
599 | #ifdef USE_ITHREADS |
7766f137 |
600 | # define CXp_PADVAR 0x00000100 /* itervar lives on pad, iterdata |
601 | has pad offset; if not set, |
602 | iterdata holds GV* */ |
603 | # define CxPADLOOP(c) (((c)->cx_type & (CXt_LOOP|CXp_PADVAR)) \ |
604 | == (CXt_LOOP|CXp_PADVAR)) |
605 | #endif |
606 | |
6b35e009 |
607 | #define CxTYPE(c) ((c)->cx_type & CXTYPEMASK) |
9850bf21 |
608 | #define CxMULTICALL(c) (((c)->cx_type & CXp_MULTICALL) \ |
609 | == CXp_MULTICALL) |
7766f137 |
610 | #define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL|CXp_REAL)) \ |
611 | == (CXt_EVAL|CXp_REAL)) |
1d76a5c3 |
612 | #define CxTRYBLOCK(c) (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK)) \ |
613 | == (CXt_EVAL|CXp_TRYBLOCK)) |
0d863452 |
614 | #define CxFOREACH(c) (((c)->cx_type & (CXt_LOOP|CXp_FOREACH)) \ |
615 | == (CXt_LOOP|CXp_FOREACH)) |
616 | #define CxFOREACHDEF(c) (((c)->cx_type & (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))\ |
617 | == (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF)) |
6b35e009 |
618 | |
79072805 |
619 | #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc())) |
620 | |
ccfc67b7 |
621 | /* |
622 | =head1 "Gimme" Values |
623 | */ |
954c1994 |
624 | |
625 | /* |
626 | =for apidoc AmU||G_SCALAR |
627 | Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and |
628 | L<perlcall>. |
629 | |
630 | =for apidoc AmU||G_ARRAY |
91e74348 |
631 | Used to indicate list context. See C<GIMME_V>, C<GIMME> and |
954c1994 |
632 | L<perlcall>. |
633 | |
634 | =for apidoc AmU||G_VOID |
635 | Used to indicate void context. See C<GIMME_V> and L<perlcall>. |
636 | |
637 | =for apidoc AmU||G_DISCARD |
638 | Indicates that arguments returned from a callback should be discarded. See |
639 | L<perlcall>. |
640 | |
641 | =for apidoc AmU||G_EVAL |
642 | |
643 | Used to force a Perl C<eval> wrapper around a callback. See |
644 | L<perlcall>. |
645 | |
646 | =for apidoc AmU||G_NOARGS |
647 | |
648 | Indicates that no arguments are being sent to a callback. See |
649 | L<perlcall>. |
650 | |
651 | =cut |
652 | */ |
653 | |
a0d0e21e |
654 | #define G_SCALAR 0 |
655 | #define G_ARRAY 1 |
54310121 |
656 | #define G_VOID 128 /* skip this bit when adding flags below */ |
79072805 |
657 | |
864dbfa3 |
658 | /* extra flags for Perl_call_* routines */ |
a0d0e21e |
659 | #define G_DISCARD 2 /* Call FREETMPS. */ |
660 | #define G_EVAL 4 /* Assume eval {} around subroutine call. */ |
661 | #define G_NOARGS 8 /* Don't construct a @_ array. */ |
54310121 |
662 | #define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */ |
491527d0 |
663 | #define G_NODEBUG 32 /* Disable debugging at toplevel. */ |
968b3946 |
664 | #define G_METHOD 64 /* Calling method. */ |
edb2152a |
665 | #define G_FAKINGEVAL 256 /* Faking en eval context for call_sv or |
666 | fold_constants. */ |
e336de0d |
667 | |
faef0170 |
668 | /* flag bits for PL_in_eval */ |
669 | #define EVAL_NULL 0 /* not in an eval */ |
670 | #define EVAL_INEVAL 1 /* some enclosing scope is an eval */ |
671 | #define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */ |
864dbfa3 |
672 | #define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */ |
6dc8a9e4 |
673 | #define EVAL_INREQUIRE 8 /* The code is being required. */ |
faef0170 |
674 | |
e336de0d |
675 | /* Support for switching (stack and block) contexts. |
676 | * This ensures magic doesn't invalidate local stack and cx pointers. |
677 | */ |
678 | |
e788e7d3 |
679 | #define PERLSI_UNKNOWN -1 |
680 | #define PERLSI_UNDEF 0 |
681 | #define PERLSI_MAIN 1 |
682 | #define PERLSI_MAGIC 2 |
683 | #define PERLSI_SORT 3 |
684 | #define PERLSI_SIGNAL 4 |
685 | #define PERLSI_OVERLOAD 5 |
686 | #define PERLSI_DESTROY 6 |
687 | #define PERLSI_WARNHOOK 7 |
688 | #define PERLSI_DIEHOOK 8 |
689 | #define PERLSI_REQUIRE 9 |
e336de0d |
690 | |
691 | struct stackinfo { |
692 | AV * si_stack; /* stack for current runlevel */ |
693 | PERL_CONTEXT * si_cxstack; /* context stack for runlevel */ |
694 | I32 si_cxix; /* current context index */ |
695 | I32 si_cxmax; /* maximum allocated index */ |
696 | I32 si_type; /* type of runlevel */ |
697 | struct stackinfo * si_prev; |
698 | struct stackinfo * si_next; |
ce2f7c3b |
699 | I32 si_markoff; /* offset where markstack begins for us. |
e336de0d |
700 | * currently used only with DEBUGGING, |
701 | * but not #ifdef-ed for bincompat */ |
702 | }; |
703 | |
704 | typedef struct stackinfo PERL_SI; |
705 | |
3280af22 |
706 | #define cxstack (PL_curstackinfo->si_cxstack) |
707 | #define cxstack_ix (PL_curstackinfo->si_cxix) |
708 | #define cxstack_max (PL_curstackinfo->si_cxmax) |
e336de0d |
709 | |
710 | #ifdef DEBUGGING |
ce2f7c3b |
711 | # define SET_MARK_OFFSET \ |
712 | PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack |
e336de0d |
713 | #else |
ce2f7c3b |
714 | # define SET_MARK_OFFSET NOOP |
e336de0d |
715 | #endif |
716 | |
d3acc0f7 |
717 | #define PUSHSTACKi(type) \ |
e336de0d |
718 | STMT_START { \ |
3280af22 |
719 | PERL_SI *next = PL_curstackinfo->si_next; \ |
e336de0d |
720 | if (!next) { \ |
721 | next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \ |
3280af22 |
722 | next->si_prev = PL_curstackinfo; \ |
723 | PL_curstackinfo->si_next = next; \ |
e336de0d |
724 | } \ |
725 | next->si_type = type; \ |
726 | next->si_cxix = -1; \ |
727 | AvFILLp(next->si_stack) = 0; \ |
3280af22 |
728 | SWITCHSTACK(PL_curstack,next->si_stack); \ |
729 | PL_curstackinfo = next; \ |
ce2f7c3b |
730 | SET_MARK_OFFSET; \ |
e336de0d |
731 | } STMT_END |
732 | |
e788e7d3 |
733 | #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN) |
d3acc0f7 |
734 | |
3095d977 |
735 | /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by |
736 | * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */ |
d3acc0f7 |
737 | #define POPSTACK \ |
e336de0d |
738 | STMT_START { \ |
39644a26 |
739 | dSP; \ |
c4420975 |
740 | PERL_SI * const prev = PL_curstackinfo->si_prev; \ |
e336de0d |
741 | if (!prev) { \ |
bf49b057 |
742 | PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \ |
e336de0d |
743 | my_exit(1); \ |
744 | } \ |
3280af22 |
745 | SWITCHSTACK(PL_curstack,prev->si_stack); \ |
e336de0d |
746 | /* don't free prev here, free them all at the END{} */ \ |
3280af22 |
747 | PL_curstackinfo = prev; \ |
e336de0d |
748 | } STMT_END |
749 | |
750 | #define POPSTACK_TO(s) \ |
751 | STMT_START { \ |
3280af22 |
752 | while (PL_curstack != s) { \ |
bac4b2ad |
753 | dounwind(-1); \ |
d3acc0f7 |
754 | POPSTACK; \ |
bac4b2ad |
755 | } \ |
e336de0d |
756 | } STMT_END |
923e4eb5 |
757 | |
758 | #define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling) |
759 | #define IN_PERL_RUNTIME (PL_curcop != &PL_compiling) |
760 | |
9850bf21 |
761 | /* |
762 | =head1 Multicall Functions |
763 | |
764 | =for apidoc Ams||dMULTICALL |
765 | Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>. |
766 | |
767 | =for apidoc Ams||PUSH_MULTICALL |
768 | Opening bracket for a lightweight callback. |
769 | See L<perlcall/Lightweight Callbacks>. |
770 | |
771 | =for apidoc Ams||MULTICALL |
772 | Make a lightweight callback. See L<perlcall/Lightweight Callbacks>. |
773 | |
774 | =for apidoc Ams||POP_MULTICALL |
775 | Closing bracket for a lightweight callback. |
776 | See L<perlcall/Lightweight Callbacks>. |
777 | |
778 | =cut |
779 | */ |
780 | |
781 | #define dMULTICALL \ |
782 | SV **newsp; /* set by POPBLOCK */ \ |
783 | PERL_CONTEXT *cx; \ |
82f35e8b |
784 | CV *multicall_cv; \ |
9850bf21 |
785 | OP *multicall_cop; \ |
786 | bool multicall_oldcatch; \ |
787 | U8 hasargs = 0 /* used by PUSHSUB */ |
788 | |
82f35e8b |
789 | #define PUSH_MULTICALL(the_cv) \ |
9850bf21 |
790 | STMT_START { \ |
0bcc34c2 |
791 | CV * const _nOnclAshIngNamE_ = the_cv; \ |
792 | CV * const cv = _nOnclAshIngNamE_; \ |
793 | AV * const padlist = CvPADLIST(cv); \ |
9850bf21 |
794 | ENTER; \ |
795 | multicall_oldcatch = CATCH_GET; \ |
796 | SAVETMPS; SAVEVPTR(PL_op); \ |
797 | CATCH_SET(TRUE); \ |
798 | PUSHBLOCK(cx, CXt_SUB|CXp_MULTICALL, PL_stack_sp); \ |
799 | PUSHSUB(cx); \ |
800 | if (++CvDEPTH(cv) >= 2) { \ |
801 | PERL_STACK_OVERFLOW_CHECK(); \ |
802 | Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \ |
803 | } \ |
804 | SAVECOMPPAD(); \ |
805 | PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \ |
82f35e8b |
806 | multicall_cv = cv; \ |
9850bf21 |
807 | multicall_cop = CvSTART(cv); \ |
808 | } STMT_END |
809 | |
810 | #define MULTICALL \ |
811 | STMT_START { \ |
812 | PL_op = multicall_cop; \ |
813 | CALLRUNOPS(aTHX); \ |
814 | } STMT_END |
815 | |
816 | #define POP_MULTICALL \ |
817 | STMT_START { \ |
82f35e8b |
818 | LEAVESUB(multicall_cv); \ |
819 | CvDEPTH(multicall_cv)--; \ |
9850bf21 |
820 | POPBLOCK(cx,PL_curpm); \ |
821 | CATCH_SET(multicall_oldcatch); \ |
822 | LEAVE; \ |
823 | } STMT_END |
b3ca2e83 |
824 | |
825 | /* |
826 | * Local variables: |
827 | * c-indentation-style: bsd |
828 | * c-basic-offset: 4 |
829 | * indent-tabs-mode: t |
830 | * End: |
831 | * |
832 | * ex: set ts=8 sts=4 sw=4 noet: |
833 | */ |