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