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