projects / p5sagit/p5-mst-13.2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | history | HEAD
Re: Making IO::Socket pass test on Win32
[p5sagit/p5-mst-13.2.git] / cop.h
CommitLineData
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
31struct 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
38typedef 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 136struct 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 */
599cee73 149 SV * cop_warnings; /* lexical warnings bitmask */
ac27b0f5 150 SV * cop_io; /* lexical IO defaults */
b3ca2e83 151 /* compile time state of %^H. See the comment in op.c for how this is
152 used to recreate a hash to return from caller. */
153 struct refcounted_he * cop_hints;
79072805 154};
155
57843af0 156#ifdef USE_ITHREADS
157# define CopFILE(c) ((c)->cop_file)
158# define CopFILEGV(c) (CopFILE(c) \
a0714e2c 159 ? gv_fetchfile(CopFILE(c)) : NULL)
083fcd59 160
7e4e8c89 161# ifdef NETWARE
162# define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
163# else
164# define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
165# endif
083fcd59 166
57843af0 167# define CopFILESV(c) (CopFILE(c) \
a0714e2c 168 ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
57843af0 169# define CopFILEAV(c) (CopFILE(c) \
7d49f689 170 ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
8688788e 171# ifdef DEBUGGING
172# define CopFILEAVx(c) (assert(CopFILE(c)), \
36c7798d 173 GvAV(gv_fetchfile(CopFILE(c))))
8688788e 174# else
175# define CopFILEAVx(c) (GvAV(gv_fetchfile(CopFILE(c))))
176# endif
57843af0 177# define CopSTASHPV(c) ((c)->cop_stashpv)
083fcd59 178
7e4e8c89 179# ifdef NETWARE
bd61b366 180# define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = ((pv) ? savepv(pv) : NULL))
7e4e8c89 181# else
182# define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = savesharedpv(pv))
183# endif
083fcd59 184
11faa288 185# define CopSTASH(c) (CopSTASHPV(c) \
5c284bb0 186 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : NULL)
bd61b366 187# define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME_get(hv) : NULL)
ed221c57 188# define CopSTASH_eq(c,hv) ((hv) && stashpv_hvname_match(c,hv))
7e4e8c89 189# ifdef NETWARE
190# define CopSTASH_free(c) SAVECOPSTASH_FREE(c)
7e4e8c89 191# define CopFILE_free(c) SAVECOPFILE_FREE(c)
192# else
ed221c57 193# define CopSTASH_free(c) PerlMemShared_free(CopSTASHPV(c))
bd61b366 194# define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
7e4e8c89 195# endif
57843af0 196#else
197# define CopFILEGV(c) ((c)->cop_filegv)
f4dd75d9 198# define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
199# define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
a0714e2c 200# define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
7d49f689 201# define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
8688788e 202# ifdef DEBUGGING
203# define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
204# else
205# define CopFILEAVx(c) (GvAV(CopFILEGV(c)))
206# endif
bd61b366 207# define CopFILE(c) (CopFILESV(c) ? SvPVX(CopFILESV(c)) : NULL)
57843af0 208# define CopSTASH(c) ((c)->cop_stash)
f4dd75d9 209# define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
bd61b366 210# define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
f4dd75d9 211 /* cop_stash is not refcounted */
212# define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
213# define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
05ec9bb3 214# define CopSTASH_free(c)
a0714e2c 215# define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
05ec9bb3 216
57843af0 217#endif /* USE_ITHREADS */
218
ed094faf 219#define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
cc49e20b 220#define CopLINE(c) ((c)->cop_line)
57843af0 221#define CopLINE_inc(c) (++CopLINE(c))
222#define CopLINE_dec(c) (--CopLINE(c))
223#define CopLINE_set(c,l) (CopLINE(c) = (l))
cc49e20b 224
248c2a4d 225/* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
226#ifdef MACOS_TRADITIONAL
227# define OutCopFILE(c) MacPerl_MPWFileName(CopFILE(c))
228#else
229# define OutCopFILE(c) CopFILE(c)
230#endif
231
fc15ae8f 232/* CopARYBASE is likely to be removed soon. */
233#define CopARYBASE(c) ((c)->cop_arybase)
234#define CopARYBASE_get(c) ((c)->cop_arybase + 0)
235#define CopARYBASE_set(c, b) STMT_START { (c)->cop_arybase = (b); } STMT_END
236
623e6609 237/* FIXME NATIVE_HINTS if this is changed from op_private (see perl.h) */
238#define CopHINTS_get(c) ((c)->op_private + 0)
239#define CopHINTS_set(c, h) STMT_START { \
240 (c)->op_private \
241 = (U8)((h) & HINT_PRIVATE_MASK); \
242 } STMT_END
243
79072805 244/*
245 * Here we have some enormously heavy (or at least ponderous) wizardry.
246 */
247
248/* subroutine context */
249struct block_sub {
250 CV * cv;
251 GV * gv;
463ee0b2 252 GV * dfoutgv;
79072805 253 AV * savearray;
254 AV * argarray;
bb172083 255 I32 olddepth;
79072805 256 U8 hasargs;
cd06dffe 257 U8 lval; /* XXX merge lval and hasargs? */
f3548bdc 258 PAD *oldcomppad;
f39bc417 259 OP * retop; /* op to execute on exit from sub */
79072805 260};
261
b36bdeca 262/* base for the next two macros. Don't use directly.
263 * Note that the refcnt of the cv is incremented twice; The CX one is
264 * decremented by LEAVESUB, the other by LEAVE. */
265
ee98a1d6 266#define PUSHSUB_BASE(cx) \
79072805 267 cx->blk_sub.cv = cv; \
b8f55b69 268 cx->blk_sub.olddepth = CvDEPTH(cv); \
b36bdeca 269 cx->blk_sub.hasargs = hasargs; \
5f66b61c 270 cx->blk_sub.retop = NULL; \
b36bdeca 271 if (!CvDEPTH(cv)) { \
b37c2d43 272 SvREFCNT_inc_void(cv); \
273 SvREFCNT_inc_void(cv); \
b36bdeca 274 SAVEFREESV(cv); \
275 }
276
ee98a1d6 277
278#define PUSHSUB(cx) \
279 PUSHSUB_BASE(cx) \
cd06dffe 280 cx->blk_sub.lval = PL_op->op_private & \
281 (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
79072805 282
ee98a1d6 283/* variant for use by OP_DBSTATE, where op_private holds hint bits */
284#define PUSHSUB_DB(cx) \
285 PUSHSUB_BASE(cx) \
286 cx->blk_sub.lval = 0;
287
288
79072805 289#define PUSHFORMAT(cx) \
290 cx->blk_sub.cv = cv; \
291 cx->blk_sub.gv = gv; \
5f66b61c 292 cx->blk_sub.retop = NULL; \
4633a7c4 293 cx->blk_sub.hasargs = 0; \
3280af22 294 cx->blk_sub.dfoutgv = PL_defoutgv; \
b37c2d43 295 SvREFCNT_inc_void(cx->blk_sub.dfoutgv)
79072805 296
3db8f154 297#define POP_SAVEARRAY() \
6d4ff0d2 298 STMT_START { \
3280af22 299 SvREFCNT_dec(GvAV(PL_defgv)); \
a8bba7fa 300 GvAV(PL_defgv) = cx->blk_sub.savearray; \
6d4ff0d2 301 } STMT_END
6d4ff0d2 302
ecf8e9dd 303/* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
8e09340b 304 * leave any (a fast av_clear(ary), basically) */
305#define CLEAR_ARGARRAY(ary) \
306 STMT_START { \
307 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
f880fe2f 308 SvPV_set(ary, (char*)AvALLOC(ary)); \
8e09340b 309 AvFILLp(ary) = -1; \
310 } STMT_END
7766f137 311
b0d9ce38 312#define POPSUB(cx,sv) \
313 STMT_START { \
a8bba7fa 314 if (cx->blk_sub.hasargs) { \
7766f137 315 POP_SAVEARRAY(); \
d8b46c1b 316 /* abandon @_ if it got reified */ \
a8bba7fa 317 if (AvREAL(cx->blk_sub.argarray)) { \
318 SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
319 SvREFCNT_dec(cx->blk_sub.argarray); \
320 cx->blk_sub.argarray = newAV(); \
321 av_extend(cx->blk_sub.argarray, fill); \
11ca45c0 322 AvREIFY_only(cx->blk_sub.argarray); \
dd2155a4 323 CX_CURPAD_SV(cx->blk_sub, 0) = (SV*)cx->blk_sub.argarray; \
d8b46c1b 324 } \
7766f137 325 else { \
8e09340b 326 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
7766f137 327 } \
79072805 328 } \
b0d9ce38 329 sv = (SV*)cx->blk_sub.cv; \
330 if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \
a0714e2c 331 sv = NULL; \
b0d9ce38 332 } STMT_END
333
334#define LEAVESUB(sv) \
335 STMT_START { \
336 if (sv) \
337 SvREFCNT_dec(sv); \
338 } STMT_END
79072805 339
340#define POPFORMAT(cx) \
4633a7c4 341 setdefout(cx->blk_sub.dfoutgv); \
342 SvREFCNT_dec(cx->blk_sub.dfoutgv);
79072805 343
344/* eval context */
345struct block_eval {
346 I32 old_in_eval;
347 I32 old_op_type;
0f79a09d 348 SV * old_namesv;
79072805 349 OP * old_eval_root;
748a9306 350 SV * cur_text;
2090ab20 351 CV * cv;
f39bc417 352 OP * retop; /* op to execute on exit from eval */
abd70938 353 JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */
79072805 354};
355
8990e307 356#define PUSHEVAL(cx,n,fgv) \
0f79a09d 357 STMT_START { \
3280af22 358 cx->blk_eval.old_in_eval = PL_in_eval; \
a8bba7fa 359 cx->blk_eval.old_op_type = PL_op->op_type; \
a0714e2c 360 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL); \
a8bba7fa 361 cx->blk_eval.old_eval_root = PL_eval_root; \
0f79a09d 362 cx->blk_eval.cur_text = PL_linestr; \
601f1833 363 cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */ \
5f66b61c 364 cx->blk_eval.retop = NULL; \
abd70938 365 cx->blk_eval.cur_top_env = PL_top_env; \
0f79a09d 366 } STMT_END
79072805 367
368#define POPEVAL(cx) \
0f79a09d 369 STMT_START { \
3280af22 370 PL_in_eval = cx->blk_eval.old_in_eval; \
79072805 371 optype = cx->blk_eval.old_op_type; \
7766f137 372 PL_eval_root = cx->blk_eval.old_eval_root; \
0f79a09d 373 if (cx->blk_eval.old_namesv) \
374 sv_2mortal(cx->blk_eval.old_namesv); \
375 } STMT_END
79072805 376
377/* loop context */
378struct block_loop {
379 char * label;
380 I32 resetsp;
381 OP * redo_op;
382 OP * next_op;
383 OP * last_op;
7766f137 384#ifdef USE_ITHREADS
385 void * iterdata;
f3548bdc 386 PAD *oldcomppad;
7766f137 387#else
79072805 388 SV ** itervar;
7766f137 389#endif
79072805 390 SV * itersave;
5f05dabc 391 SV * iterlval;
79072805 392 AV * iterary;
89ea2908 393 IV iterix;
394 IV itermax;
79072805 395};
396
7766f137 397#ifdef USE_ITHREADS
398# define CxITERVAR(c) \
399 ((c)->blk_loop.iterdata \
400 ? (CxPADLOOP(cx) \
dd2155a4 401 ? &CX_CURPAD_SV( (c)->blk_loop, \
402 INT2PTR(PADOFFSET, (c)->blk_loop.iterdata)) \
7766f137 403 : &GvSV((GV*)(c)->blk_loop.iterdata)) \
404 : (SV**)NULL)
405# define CX_ITERDATA_SET(cx,idata) \
dd2155a4 406 CX_CURPAD_SAVE(cx->blk_loop); \
155aba94 407 if ((cx->blk_loop.iterdata = (idata))) \
d10edb75 408 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \
409 else \
a0714e2c 410 cx->blk_loop.itersave = NULL;
7766f137 411#else
412# define CxITERVAR(c) ((c)->blk_loop.itervar)
413# define CX_ITERDATA_SET(cx,ivar) \
155aba94 414 if ((cx->blk_loop.itervar = (SV**)(ivar))) \
d10edb75 415 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \
416 else \
a0714e2c 417 cx->blk_loop.itersave = NULL;
7766f137 418#endif
419
420#define PUSHLOOP(cx, dat, s) \
38a230cb 421 cx->blk_loop.label = PL_curcop->cop_label; \
422 cx->blk_loop.resetsp = s - PL_stack_base; \
79072805 423 cx->blk_loop.redo_op = cLOOP->op_redoop; \
424 cx->blk_loop.next_op = cLOOP->op_nextop; \
425 cx->blk_loop.last_op = cLOOP->op_lastop; \
a0714e2c 426 cx->blk_loop.iterlval = NULL; \
7d49f689 427 cx->blk_loop.iterary = NULL; \
7766f137 428 cx->blk_loop.iterix = -1; \
429 CX_ITERDATA_SET(cx,dat);
79072805 430
431#define POPLOOP(cx) \
a8bba7fa 432 SvREFCNT_dec(cx->blk_loop.iterlval); \
7766f137 433 if (CxITERVAR(cx)) { \
21401c75 434 if (SvPADMY(cx->blk_loop.itersave)) { \
d4c19fe8 435 SV ** const s_v_p = CxITERVAR(cx); \
21401c75 436 sv_2mortal(*s_v_p); \
437 *s_v_p = cx->blk_loop.itersave; \
438 } \
439 else { \
440 SvREFCNT_dec(cx->blk_loop.itersave); \
441 } \
44a8e56a 442 } \
a8bba7fa 443 if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
444 SvREFCNT_dec(cx->blk_loop.iterary);
79072805 445
0d863452 446/* given/when context */
447struct block_givwhen {
448 OP *leave_op;
449};
450
451#define PUSHGIVEN(cx) \
452 cx->blk_givwhen.leave_op = cLOGOP->op_other;
453
454#define PUSHWHEN PUSHGIVEN
455
79072805 456/* context common to subroutines, evals and loops */
457struct block {
458 I32 blku_oldsp; /* stack pointer to copy stuff down to */
459 COP * blku_oldcop; /* old curcop pointer */
79072805 460 I32 blku_oldmarksp; /* mark stack index */
461 I32 blku_oldscopesp; /* scope stack index */
462 PMOP * blku_oldpm; /* values of pattern match vars */
463 U8 blku_gimme; /* is this block running in list context? */
464
465 union {
466 struct block_sub blku_sub;
467 struct block_eval blku_eval;
468 struct block_loop blku_loop;
0d863452 469 struct block_givwhen blku_givwhen;
79072805 470 } blk_u;
471};
472#define blk_oldsp cx_u.cx_blk.blku_oldsp
473#define blk_oldcop cx_u.cx_blk.blku_oldcop
79072805 474#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
475#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
476#define blk_oldpm cx_u.cx_blk.blku_oldpm
477#define blk_gimme cx_u.cx_blk.blku_gimme
478#define blk_sub cx_u.cx_blk.blk_u.blku_sub
479#define blk_eval cx_u.cx_blk.blk_u.blku_eval
480#define blk_loop cx_u.cx_blk.blk_u.blku_loop
0d863452 481#define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen
79072805 482
483/* Enter a block. */
8990e307 484#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805 485 cx->cx_type = t, \
3280af22 486 cx->blk_oldsp = sp - PL_stack_base, \
487 cx->blk_oldcop = PL_curcop, \
1aff0e91 488 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22 489 cx->blk_oldscopesp = PL_scopestack_ix, \
3280af22 490 cx->blk_oldpm = PL_curpm, \
eb160463 491 cx->blk_gimme = (U8)gimme; \
bf49b057 492 DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
1aff0e91 493 (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
79072805 494
495/* Exit a block (RETURN and LAST). */
a0d0e21e 496#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
1aff0e91 497 newsp = PL_stack_base + cx->blk_oldsp, \
3280af22 498 PL_curcop = cx->blk_oldcop, \
499 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
500 PL_scopestack_ix = cx->blk_oldscopesp, \
3280af22 501 pm = cx->blk_oldpm, \
502 gimme = cx->blk_gimme; \
b4ab917c 503 DEBUG_SCOPE("POPBLOCK"); \
bf49b057 504 DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
22c35a8c 505 (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
79072805 506
507/* Continue a block elsewhere (NEXT and REDO). */
3280af22 508#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
1aff0e91 509 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
3280af22 510 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
511 PL_scopestack_ix = cx->blk_oldscopesp, \
b4ab917c 512 PL_curpm = cx->blk_oldpm; \
513 DEBUG_SCOPE("TOPBLOCK");
79072805 514
515/* substitution context */
516struct subst {
517 I32 sbu_iters;
518 I32 sbu_maxiters;
22e551b9 519 I32 sbu_rflags;
4633a7c4 520 I32 sbu_oldsave;
71be2cbc 521 bool sbu_once;
522 bool sbu_rxtainted;
79072805 523 char * sbu_orig;
524 SV * sbu_dstr;
525 SV * sbu_targ;
526 char * sbu_s;
527 char * sbu_m;
528 char * sbu_strend;
c90c0ff4 529 void * sbu_rxres;
c07a80fd 530 REGEXP * sbu_rx;
79072805 531};
532#define sb_iters cx_u.cx_subst.sbu_iters
533#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9 534#define sb_rflags cx_u.cx_subst.sbu_rflags
4633a7c4 535#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc 536#define sb_once cx_u.cx_subst.sbu_once
537#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805 538#define sb_orig cx_u.cx_subst.sbu_orig
539#define sb_dstr cx_u.cx_subst.sbu_dstr
540#define sb_targ cx_u.cx_subst.sbu_targ
541#define sb_s cx_u.cx_subst.sbu_s
542#define sb_m cx_u.cx_subst.sbu_m
543#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4 544#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd 545#define sb_rx cx_u.cx_subst.sbu_rx
79072805 546
547#define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
548 cx->sb_iters = iters, \
549 cx->sb_maxiters = maxiters, \
22e551b9 550 cx->sb_rflags = r_flags, \
4633a7c4 551 cx->sb_oldsave = oldsave, \
71be2cbc 552 cx->sb_once = once, \
553 cx->sb_rxtainted = rxtainted, \
79072805 554 cx->sb_orig = orig, \
555 cx->sb_dstr = dstr, \
556 cx->sb_targ = targ, \
557 cx->sb_s = s, \
558 cx->sb_m = m, \
559 cx->sb_strend = strend, \
4608196e 560 cx->sb_rxres = NULL, \
c07a80fd 561 cx->sb_rx = rx, \
c90c0ff4 562 cx->cx_type = CXt_SUBST; \
563 rxres_save(&cx->sb_rxres, rx)
79072805 564
c90c0ff4 565#define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
566 rxres_free(&cx->sb_rxres)
79072805 567
568struct context {
6b35e009 569 U32 cx_type; /* what kind of context this is */
79072805 570 union {
571 struct block cx_blk;
572 struct subst cx_subst;
573 } cx_u;
574};
6b35e009 575
576#define CXTYPEMASK 0xff
79072805 577#define CXt_NULL 0
578#define CXt_SUB 1
579#define CXt_EVAL 2
580#define CXt_LOOP 3
581#define CXt_SUBST 4
582#define CXt_BLOCK 5
7766f137 583#define CXt_FORMAT 6
0d863452 584#define CXt_GIVEN 7
585#define CXt_WHEN 8
79072805 586
9850bf21 587/* private flags for CXt_SUB and CXt_NULL */
588#define CXp_MULTICALL 0x00000400 /* part of a multicall (so don't
589 tear down context on exit). */
590
6b35e009 591/* private flags for CXt_EVAL */
592#define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
1d76a5c3 593#define CXp_TRYBLOCK 0x00000200 /* eval{}, not eval'' or similar */
6b35e009 594
7766f137 595/* private flags for CXt_LOOP */
0d863452 596#define CXp_FOREACH 0x00000200 /* a foreach loop */
597#define CXp_FOR_DEF 0x00000400 /* foreach using $_ */
598#ifdef USE_ITHREADS
7766f137 599# define CXp_PADVAR 0x00000100 /* itervar lives on pad, iterdata
600 has pad offset; if not set,
601 iterdata holds GV* */
602# define CxPADLOOP(c) (((c)->cx_type & (CXt_LOOP|CXp_PADVAR)) \
603 == (CXt_LOOP|CXp_PADVAR))
604#endif
605
6b35e009 606#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
9850bf21 607#define CxMULTICALL(c) (((c)->cx_type & CXp_MULTICALL) \
608 == CXp_MULTICALL)
7766f137 609#define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL|CXp_REAL)) \
610 == (CXt_EVAL|CXp_REAL))
1d76a5c3 611#define CxTRYBLOCK(c) (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK)) \
612 == (CXt_EVAL|CXp_TRYBLOCK))
0d863452 613#define CxFOREACH(c) (((c)->cx_type & (CXt_LOOP|CXp_FOREACH)) \
614 == (CXt_LOOP|CXp_FOREACH))
615#define CxFOREACHDEF(c) (((c)->cx_type & (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))\
616 == (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))
6b35e009 617
79072805 618#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
619
ccfc67b7 620/*
621=head1 "Gimme" Values
622*/
954c1994 623
624/*
625=for apidoc AmU||G_SCALAR
626Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
627L<perlcall>.
628
629=for apidoc AmU||G_ARRAY
91e74348 630Used to indicate list context. See C<GIMME_V>, C<GIMME> and
954c1994 631L<perlcall>.
632
633=for apidoc AmU||G_VOID
634Used to indicate void context. See C<GIMME_V> and L<perlcall>.
635
636=for apidoc AmU||G_DISCARD
637Indicates that arguments returned from a callback should be discarded. See
638L<perlcall>.
639
640=for apidoc AmU||G_EVAL
641
642Used to force a Perl C<eval> wrapper around a callback. See
643L<perlcall>.
644
645=for apidoc AmU||G_NOARGS
646
647Indicates that no arguments are being sent to a callback. See
648L<perlcall>.
649
650=cut
651*/
652
a0d0e21e 653#define G_SCALAR 0
654#define G_ARRAY 1
54310121 655#define G_VOID 128 /* skip this bit when adding flags below */
79072805 656
864dbfa3 657/* extra flags for Perl_call_* routines */
a0d0e21e 658#define G_DISCARD 2 /* Call FREETMPS. */
659#define G_EVAL 4 /* Assume eval {} around subroutine call. */
660#define G_NOARGS 8 /* Don't construct a @_ array. */
54310121 661#define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
491527d0 662#define G_NODEBUG 32 /* Disable debugging at toplevel. */
968b3946 663#define G_METHOD 64 /* Calling method. */
edb2152a 664#define G_FAKINGEVAL 256 /* Faking en eval context for call_sv or
665 fold_constants. */
e336de0d 666
faef0170 667/* flag bits for PL_in_eval */
668#define EVAL_NULL 0 /* not in an eval */
669#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
670#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3 671#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
6dc8a9e4 672#define EVAL_INREQUIRE 8 /* The code is being required. */
faef0170 673
e336de0d 674/* Support for switching (stack and block) contexts.
675 * This ensures magic doesn't invalidate local stack and cx pointers.
676 */
677
e788e7d3 678#define PERLSI_UNKNOWN -1
679#define PERLSI_UNDEF 0
680#define PERLSI_MAIN 1
681#define PERLSI_MAGIC 2
682#define PERLSI_SORT 3
683#define PERLSI_SIGNAL 4
684#define PERLSI_OVERLOAD 5
685#define PERLSI_DESTROY 6
686#define PERLSI_WARNHOOK 7
687#define PERLSI_DIEHOOK 8
688#define PERLSI_REQUIRE 9
e336de0d 689
690struct stackinfo {
691 AV * si_stack; /* stack for current runlevel */
692 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
693 I32 si_cxix; /* current context index */
694 I32 si_cxmax; /* maximum allocated index */
695 I32 si_type; /* type of runlevel */
696 struct stackinfo * si_prev;
697 struct stackinfo * si_next;
ce2f7c3b 698 I32 si_markoff; /* offset where markstack begins for us.
e336de0d 699 * currently used only with DEBUGGING,
700 * but not #ifdef-ed for bincompat */
701};
702
703typedef struct stackinfo PERL_SI;
704
3280af22 705#define cxstack (PL_curstackinfo->si_cxstack)
706#define cxstack_ix (PL_curstackinfo->si_cxix)
707#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d 708
709#ifdef DEBUGGING
ce2f7c3b 710# define SET_MARK_OFFSET \
711 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
e336de0d 712#else
ce2f7c3b 713# define SET_MARK_OFFSET NOOP
e336de0d 714#endif
715
d3acc0f7 716#define PUSHSTACKi(type) \
e336de0d 717 STMT_START { \
3280af22 718 PERL_SI *next = PL_curstackinfo->si_next; \
e336de0d 719 if (!next) { \
720 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22 721 next->si_prev = PL_curstackinfo; \
722 PL_curstackinfo->si_next = next; \
e336de0d 723 } \
724 next->si_type = type; \
725 next->si_cxix = -1; \
726 AvFILLp(next->si_stack) = 0; \
3280af22 727 SWITCHSTACK(PL_curstack,next->si_stack); \
728 PL_curstackinfo = next; \
ce2f7c3b 729 SET_MARK_OFFSET; \
e336de0d 730 } STMT_END
731
e788e7d3 732#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7 733
3095d977 734/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
735 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7 736#define POPSTACK \
e336de0d 737 STMT_START { \
39644a26 738 dSP; \
c4420975 739 PERL_SI * const prev = PL_curstackinfo->si_prev; \
e336de0d 740 if (!prev) { \
bf49b057 741 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
e336de0d 742 my_exit(1); \
743 } \
3280af22 744 SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d 745 /* don't free prev here, free them all at the END{} */ \
3280af22 746 PL_curstackinfo = prev; \
e336de0d 747 } STMT_END
748
749#define POPSTACK_TO(s) \
750 STMT_START { \
3280af22 751 while (PL_curstack != s) { \
bac4b2ad 752 dounwind(-1); \
d3acc0f7 753 POPSTACK; \
bac4b2ad 754 } \
e336de0d 755 } STMT_END
923e4eb5 756
757#define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
758#define IN_PERL_RUNTIME (PL_curcop != &PL_compiling)
759
9850bf21 760/*
761=head1 Multicall Functions
762
763=for apidoc Ams||dMULTICALL
764Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
765
766=for apidoc Ams||PUSH_MULTICALL
767Opening bracket for a lightweight callback.
768See L<perlcall/Lightweight Callbacks>.
769
770=for apidoc Ams||MULTICALL
771Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
772
773=for apidoc Ams||POP_MULTICALL
774Closing bracket for a lightweight callback.
775See L<perlcall/Lightweight Callbacks>.
776
777=cut
778*/
779
780#define dMULTICALL \
781 SV **newsp; /* set by POPBLOCK */ \
782 PERL_CONTEXT *cx; \
82f35e8b 783 CV *multicall_cv; \
9850bf21 784 OP *multicall_cop; \
785 bool multicall_oldcatch; \
786 U8 hasargs = 0 /* used by PUSHSUB */
787
82f35e8b 788#define PUSH_MULTICALL(the_cv) \
9850bf21 789 STMT_START { \
0bcc34c2 790 CV * const _nOnclAshIngNamE_ = the_cv; \
791 CV * const cv = _nOnclAshIngNamE_; \
792 AV * const padlist = CvPADLIST(cv); \
9850bf21 793 ENTER; \
794 multicall_oldcatch = CATCH_GET; \
795 SAVETMPS; SAVEVPTR(PL_op); \
796 CATCH_SET(TRUE); \
797 PUSHBLOCK(cx, CXt_SUB|CXp_MULTICALL, PL_stack_sp); \
798 PUSHSUB(cx); \
799 if (++CvDEPTH(cv) >= 2) { \
800 PERL_STACK_OVERFLOW_CHECK(); \
801 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
802 } \
803 SAVECOMPPAD(); \
804 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
82f35e8b 805 multicall_cv = cv; \
9850bf21 806 multicall_cop = CvSTART(cv); \
807 } STMT_END
808
809#define MULTICALL \
810 STMT_START { \
811 PL_op = multicall_cop; \
812 CALLRUNOPS(aTHX); \
813 } STMT_END
814
815#define POP_MULTICALL \
816 STMT_START { \
82f35e8b 817 LEAVESUB(multicall_cv); \
818 CvDEPTH(multicall_cv)--; \
9850bf21 819 POPBLOCK(cx,PL_curpm); \
820 CATCH_SET(multicall_oldcatch); \
821 LEAVE; \
822 } STMT_END
b3ca2e83 823
824/*
825 * Local variables:
826 * c-indentation-style: bsd
827 * c-basic-offset: 4
828 * indent-tabs-mode: t
829 * End:
830 *
831 * ex: set ts=8 sts=4 sw=4 noet:
832 */
Unnamed repository; edit this file to name it for gitweb.