document how to set APPLLIB_EXP
[perl.git] / cop.h
1 /*    cop.h
2  *
3  *    Copyright (c) 1991-2002, Larry Wall
4  *
5  *    You may distribute under the terms of either the GNU General Public
6  *    License or the Artistic License, as specified in the README file.
7  *
8  */
9
10 struct cop {
11     BASEOP
12     char *      cop_label;      /* label for this construct */
13 #ifdef USE_ITHREADS
14     char *      cop_stashpv;    /* package line was compiled in */
15     char *      cop_file;       /* file name the following line # is from */
16 #else
17     HV *        cop_stash;      /* package line was compiled in */
18     GV *        cop_filegv;     /* file the following line # is from */
19 #endif
20     U32         cop_seq;        /* parse sequence number */
21     I32         cop_arybase;    /* array base this line was compiled with */
22     line_t      cop_line;       /* line # of this command */
23     SV *        cop_warnings;   /* lexical warnings bitmask */
24     SV *        cop_io;         /* lexical IO defaults */
25 };
26
27 #define Nullcop Null(COP*)
28
29 #ifdef USE_ITHREADS
30 #  define CopFILE(c)            ((c)->cop_file)
31 #  define CopFILEGV(c)          (CopFILE(c) \
32                                  ? gv_fetchfile(CopFILE(c)) : Nullgv)
33                                  
34  #ifdef NETWARE
35   #define CopFILE_set(c,pv)     ((c)->cop_file = savepv(pv))
36  #else
37   #define CopFILE_set(c,pv)     ((c)->cop_file = savesharedpv(pv))
38  #endif
39
40 #  define CopFILESV(c)          (CopFILE(c) \
41                                  ? GvSV(gv_fetchfile(CopFILE(c))) : Nullsv)
42 #  define CopFILEAV(c)          (CopFILE(c) \
43                                  ? GvAV(gv_fetchfile(CopFILE(c))) : Nullav)
44 #  define CopSTASHPV(c)         ((c)->cop_stashpv)
45
46   #ifdef NETWARE
47     #define CopSTASHPV_set(c,pv)        ((c)->cop_stashpv = ((pv) ? savepv(pv) : Nullch))
48   #else
49     #define CopSTASHPV_set(c,pv)        ((c)->cop_stashpv = savesharedpv(pv))
50   #endif
51
52 #  define CopSTASH(c)           (CopSTASHPV(c) \
53                                  ? gv_stashpv(CopSTASHPV(c),GV_ADD) : Nullhv)
54 #  define CopSTASH_set(c,hv)    CopSTASHPV_set(c, (hv) ? HvNAME(hv) : Nullch)
55 #  define CopSTASH_eq(c,hv)     ((hv)                                   \
56                                  && (CopSTASHPV(c) == HvNAME(hv)        \
57                                      || (CopSTASHPV(c) && HvNAME(hv)    \
58                                          && strEQ(CopSTASHPV(c), HvNAME(hv)))))
59   #ifdef NETWARE
60     #define CopSTASH_free(c) SAVECOPSTASH_FREE(c)
61   #else
62     #define CopSTASH_free(c)    PerlMemShared_free(CopSTASHPV(c))      
63   #endif
64
65   #ifdef NETWARE
66     #define CopFILE_free(c) SAVECOPFILE_FREE(c)
67   #else
68     #define CopFILE_free(c)     (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = Nullch))      
69   #endif
70 #else
71 #  define CopFILEGV(c)          ((c)->cop_filegv)
72 #  define CopFILEGV_set(c,gv)   ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
73 #  define CopFILE_set(c,pv)     CopFILEGV_set((c), gv_fetchfile(pv))
74 #  define CopFILESV(c)          (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : Nullsv)
75 #  define CopFILEAV(c)          (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : Nullav)
76 #  define CopFILE(c)            (CopFILESV(c) ? SvPVX(CopFILESV(c)) : Nullch)
77 #  define CopSTASH(c)           ((c)->cop_stash)
78 #  define CopSTASH_set(c,hv)    ((c)->cop_stash = (hv))
79 #  define CopSTASHPV(c)         (CopSTASH(c) ? HvNAME(CopSTASH(c)) : Nullch)
80    /* cop_stash is not refcounted */
81 #  define CopSTASHPV_set(c,pv)  CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
82 #  define CopSTASH_eq(c,hv)     (CopSTASH(c) == (hv))
83 #  define CopSTASH_free(c)      
84 #  define CopFILE_free(c)       (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = Nullgv))
85
86 #endif /* USE_ITHREADS */
87
88 #define CopSTASH_ne(c,hv)       (!CopSTASH_eq(c,hv))
89 #define CopLINE(c)              ((c)->cop_line)
90 #define CopLINE_inc(c)          (++CopLINE(c))
91 #define CopLINE_dec(c)          (--CopLINE(c))
92 #define CopLINE_set(c,l)        (CopLINE(c) = (l))
93
94 /* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
95 #ifdef MACOS_TRADITIONAL
96 #  define OutCopFILE(c) MacPerl_MPWFileName(CopFILE(c))
97 #else
98 #  define OutCopFILE(c) CopFILE(c)
99 #endif
100
101 /*
102  * Here we have some enormously heavy (or at least ponderous) wizardry.
103  */
104
105 /* subroutine context */
106 struct block_sub {
107     CV *        cv;
108     GV *        gv;
109     GV *        dfoutgv;
110 #ifndef USE_5005THREADS
111     AV *        savearray;
112 #endif /* USE_5005THREADS */
113     AV *        argarray;
114     long        olddepth;
115     U8          hasargs;
116     U8          lval;           /* XXX merge lval and hasargs? */
117     PAD         oldcurpad;
118 };
119
120 #define PUSHSUB(cx)                                                     \
121         cx->blk_sub.cv = cv;                                            \
122         cx->blk_sub.olddepth = CvDEPTH(cv);                             \
123         cx->blk_sub.hasargs = hasargs;                                  \
124         cx->blk_sub.lval = PL_op->op_private &                          \
125                               (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
126
127 #define PUSHFORMAT(cx)                                                  \
128         cx->blk_sub.cv = cv;                                            \
129         cx->blk_sub.gv = gv;                                            \
130         cx->blk_sub.hasargs = 0;                                        \
131         cx->blk_sub.dfoutgv = PL_defoutgv;                              \
132         (void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
133
134 #ifdef USE_5005THREADS
135 #  define POP_SAVEARRAY() NOOP
136 #else
137 #  define POP_SAVEARRAY()                                               \
138     STMT_START {                                                        \
139         SvREFCNT_dec(GvAV(PL_defgv));                                   \
140         GvAV(PL_defgv) = cx->blk_sub.savearray;                         \
141     } STMT_END
142 #endif /* USE_5005THREADS */
143
144 /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
145  * leave any (a fast av_clear(ary), basically) */
146 #define CLEAR_ARGARRAY(ary) \
147     STMT_START {                                                        \
148         AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary);                      \
149         SvPVX(ary) = (char*)AvALLOC(ary);                               \
150         AvFILLp(ary) = -1;                                              \
151     } STMT_END
152
153 #define POPSUB(cx,sv)                                                   \
154     STMT_START {                                                        \
155         if (cx->blk_sub.hasargs) {                                      \
156             POP_SAVEARRAY();                                            \
157             /* abandon @_ if it got reified */                          \
158             if (AvREAL(cx->blk_sub.argarray)) {                         \
159                 SSize_t fill = AvFILLp(cx->blk_sub.argarray);           \
160                 SvREFCNT_dec(cx->blk_sub.argarray);                     \
161                 cx->blk_sub.argarray = newAV();                         \
162                 av_extend(cx->blk_sub.argarray, fill);                  \
163                 AvFLAGS(cx->blk_sub.argarray) = AVf_REIFY;              \
164                 CX_CURPAD_SV(cx->blk_sub, 0) = (SV*)cx->blk_sub.argarray;       \
165             }                                                           \
166             else {                                                      \
167                 CLEAR_ARGARRAY(cx->blk_sub.argarray);                   \
168             }                                                           \
169         }                                                               \
170         sv = (SV*)cx->blk_sub.cv;                                       \
171         if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth))            \
172             sv = Nullsv;                                                \
173     } STMT_END
174
175 #define LEAVESUB(sv)                                                    \
176     STMT_START {                                                        \
177         if (sv)                                                         \
178             SvREFCNT_dec(sv);                                           \
179     } STMT_END
180
181 #define POPFORMAT(cx)                                                   \
182         setdefout(cx->blk_sub.dfoutgv);                                 \
183         SvREFCNT_dec(cx->blk_sub.dfoutgv);
184
185 /* eval context */
186 struct block_eval {
187     I32         old_in_eval;
188     I32         old_op_type;
189     SV *        old_namesv;
190     OP *        old_eval_root;
191     SV *        cur_text;
192     CV *        cv;
193 };
194
195 #define PUSHEVAL(cx,n,fgv)                                              \
196     STMT_START {                                                        \
197         cx->blk_eval.old_in_eval = PL_in_eval;                          \
198         cx->blk_eval.old_op_type = PL_op->op_type;                      \
199         cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : Nullsv);          \
200         cx->blk_eval.old_eval_root = PL_eval_root;                      \
201         cx->blk_eval.cur_text = PL_linestr;                             \
202         cx->blk_eval.cv = Nullcv; /* set by doeval(), as applicable */  \
203     } STMT_END
204
205 #define POPEVAL(cx)                                                     \
206     STMT_START {                                                        \
207         PL_in_eval = cx->blk_eval.old_in_eval;                          \
208         optype = cx->blk_eval.old_op_type;                              \
209         PL_eval_root = cx->blk_eval.old_eval_root;                      \
210         if (cx->blk_eval.old_namesv)                                    \
211             sv_2mortal(cx->blk_eval.old_namesv);                        \
212     } STMT_END
213
214 /* loop context */
215 struct block_loop {
216     char *      label;
217     I32         resetsp;
218     OP *        redo_op;
219     OP *        next_op;
220     OP *        last_op;
221 #ifdef USE_ITHREADS
222     void *      iterdata;
223     PAD         oldcurpad;
224 #else
225     SV **       itervar;
226 #endif
227     SV *        itersave;
228     SV *        iterlval;
229     AV *        iterary;
230     IV          iterix;
231     IV          itermax;
232 };
233
234 #ifdef USE_ITHREADS
235 #  define CxITERVAR(c)                                                  \
236         ((c)->blk_loop.iterdata                                         \
237          ? (CxPADLOOP(cx)                                               \
238             ? &CX_CURPAD_SV( (c)->blk_loop,                             \
239                     INT2PTR(PADOFFSET, (c)->blk_loop.iterdata))         \
240             : &GvSV((GV*)(c)->blk_loop.iterdata))                       \
241          : (SV**)NULL)
242 #  define CX_ITERDATA_SET(cx,idata)                                     \
243         CX_CURPAD_SAVE(cx->blk_loop);                                   \
244         if ((cx->blk_loop.iterdata = (idata)))                          \
245             cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));       \
246         else                                                            \
247             cx->blk_loop.itersave = Nullsv;
248 #else
249 #  define CxITERVAR(c)          ((c)->blk_loop.itervar)
250 #  define CX_ITERDATA_SET(cx,ivar)                                      \
251         if ((cx->blk_loop.itervar = (SV**)(ivar)))                      \
252             cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));       \
253         else                                                            \
254             cx->blk_loop.itersave = Nullsv;
255 #endif
256
257 #define PUSHLOOP(cx, dat, s)                                            \
258         cx->blk_loop.label = PL_curcop->cop_label;                      \
259         cx->blk_loop.resetsp = s - PL_stack_base;                       \
260         cx->blk_loop.redo_op = cLOOP->op_redoop;                        \
261         cx->blk_loop.next_op = cLOOP->op_nextop;                        \
262         cx->blk_loop.last_op = cLOOP->op_lastop;                        \
263         cx->blk_loop.iterlval = Nullsv;                                 \
264         cx->blk_loop.iterary = Nullav;                                  \
265         cx->blk_loop.iterix = -1;                                       \
266         CX_ITERDATA_SET(cx,dat);
267
268 #define POPLOOP(cx)                                                     \
269         SvREFCNT_dec(cx->blk_loop.iterlval);                            \
270         if (CxITERVAR(cx)) {                                            \
271             SV **s_v_p = CxITERVAR(cx);                                 \
272             sv_2mortal(*s_v_p);                                         \
273             *s_v_p = cx->blk_loop.itersave;                             \
274         }                                                               \
275         if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
276             SvREFCNT_dec(cx->blk_loop.iterary);
277
278 /* context common to subroutines, evals and loops */
279 struct block {
280     I32         blku_oldsp;     /* stack pointer to copy stuff down to */
281     COP *       blku_oldcop;    /* old curcop pointer */
282     I32         blku_oldretsp;  /* return stack index */
283     I32         blku_oldmarksp; /* mark stack index */
284     I32         blku_oldscopesp;        /* scope stack index */
285     PMOP *      blku_oldpm;     /* values of pattern match vars */
286     U8          blku_gimme;     /* is this block running in list context? */
287
288     union {
289         struct block_sub        blku_sub;
290         struct block_eval       blku_eval;
291         struct block_loop       blku_loop;
292     } blk_u;
293 };
294 #define blk_oldsp       cx_u.cx_blk.blku_oldsp
295 #define blk_oldcop      cx_u.cx_blk.blku_oldcop
296 #define blk_oldretsp    cx_u.cx_blk.blku_oldretsp
297 #define blk_oldmarksp   cx_u.cx_blk.blku_oldmarksp
298 #define blk_oldscopesp  cx_u.cx_blk.blku_oldscopesp
299 #define blk_oldpm       cx_u.cx_blk.blku_oldpm
300 #define blk_gimme       cx_u.cx_blk.blku_gimme
301 #define blk_sub         cx_u.cx_blk.blk_u.blku_sub
302 #define blk_eval        cx_u.cx_blk.blk_u.blku_eval
303 #define blk_loop        cx_u.cx_blk.blk_u.blku_loop
304
305 /* Enter a block. */
306 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix],            \
307         cx->cx_type             = t,                                    \
308         cx->blk_oldsp           = sp - PL_stack_base,                   \
309         cx->blk_oldcop          = PL_curcop,                            \
310         cx->blk_oldmarksp       = PL_markstack_ptr - PL_markstack,      \
311         cx->blk_oldscopesp      = PL_scopestack_ix,                     \
312         cx->blk_oldretsp        = PL_retstack_ix,                       \
313         cx->blk_oldpm           = PL_curpm,                             \
314         cx->blk_gimme           = (U8)gimme;                            \
315         DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
316                     (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
317
318 /* Exit a block (RETURN and LAST). */
319 #define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--],                    \
320         newsp            = PL_stack_base + cx->blk_oldsp,               \
321         PL_curcop        = cx->blk_oldcop,                              \
322         PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
323         PL_scopestack_ix = cx->blk_oldscopesp,                          \
324         PL_retstack_ix   = cx->blk_oldretsp,                            \
325         pm               = cx->blk_oldpm,                               \
326         gimme            = cx->blk_gimme;                               \
327         DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n",          \
328                     (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
329
330 /* Continue a block elsewhere (NEXT and REDO). */
331 #define TOPBLOCK(cx) cx  = &cxstack[cxstack_ix],                        \
332         PL_stack_sp      = PL_stack_base + cx->blk_oldsp,               \
333         PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
334         PL_scopestack_ix = cx->blk_oldscopesp,                          \
335         PL_retstack_ix   = cx->blk_oldretsp,                            \
336         PL_curpm         = cx->blk_oldpm
337
338 /* substitution context */
339 struct subst {
340     I32         sbu_iters;
341     I32         sbu_maxiters;
342     I32         sbu_rflags;
343     I32         sbu_oldsave;
344     bool        sbu_once;
345     bool        sbu_rxtainted;
346     char *      sbu_orig;
347     SV *        sbu_dstr;
348     SV *        sbu_targ;
349     char *      sbu_s;
350     char *      sbu_m;
351     char *      sbu_strend;
352     void *      sbu_rxres;
353     REGEXP *    sbu_rx;
354 };
355 #define sb_iters        cx_u.cx_subst.sbu_iters
356 #define sb_maxiters     cx_u.cx_subst.sbu_maxiters
357 #define sb_rflags       cx_u.cx_subst.sbu_rflags
358 #define sb_oldsave      cx_u.cx_subst.sbu_oldsave
359 #define sb_once         cx_u.cx_subst.sbu_once
360 #define sb_rxtainted    cx_u.cx_subst.sbu_rxtainted
361 #define sb_orig         cx_u.cx_subst.sbu_orig
362 #define sb_dstr         cx_u.cx_subst.sbu_dstr
363 #define sb_targ         cx_u.cx_subst.sbu_targ
364 #define sb_s            cx_u.cx_subst.sbu_s
365 #define sb_m            cx_u.cx_subst.sbu_m
366 #define sb_strend       cx_u.cx_subst.sbu_strend
367 #define sb_rxres        cx_u.cx_subst.sbu_rxres
368 #define sb_rx           cx_u.cx_subst.sbu_rx
369
370 #define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix],                 \
371         cx->sb_iters            = iters,                                \
372         cx->sb_maxiters         = maxiters,                             \
373         cx->sb_rflags           = r_flags,                              \
374         cx->sb_oldsave          = oldsave,                              \
375         cx->sb_once             = once,                                 \
376         cx->sb_rxtainted        = rxtainted,                            \
377         cx->sb_orig             = orig,                                 \
378         cx->sb_dstr             = dstr,                                 \
379         cx->sb_targ             = targ,                                 \
380         cx->sb_s                = s,                                    \
381         cx->sb_m                = m,                                    \
382         cx->sb_strend           = strend,                               \
383         cx->sb_rxres            = Null(void*),                          \
384         cx->sb_rx               = rx,                                   \
385         cx->cx_type             = CXt_SUBST;                            \
386         rxres_save(&cx->sb_rxres, rx)
387
388 #define POPSUBST(cx) cx = &cxstack[cxstack_ix--];                       \
389         rxres_free(&cx->sb_rxres)
390
391 struct context {
392     U32         cx_type;        /* what kind of context this is */
393     union {
394         struct block    cx_blk;
395         struct subst    cx_subst;
396     } cx_u;
397 };
398
399 #define CXTYPEMASK      0xff
400 #define CXt_NULL        0
401 #define CXt_SUB         1
402 #define CXt_EVAL        2
403 #define CXt_LOOP        3
404 #define CXt_SUBST       4
405 #define CXt_BLOCK       5
406 #define CXt_FORMAT      6
407
408 /* private flags for CXt_EVAL */
409 #define CXp_REAL        0x00000100      /* truly eval'', not a lookalike */
410 #define CXp_TRYBLOCK    0x00000200      /* eval{}, not eval'' or similar */
411
412 #ifdef USE_ITHREADS
413 /* private flags for CXt_LOOP */
414 #  define CXp_PADVAR    0x00000100      /* itervar lives on pad, iterdata
415                                            has pad offset; if not set,
416                                            iterdata holds GV* */
417 #  define CxPADLOOP(c)  (((c)->cx_type & (CXt_LOOP|CXp_PADVAR))         \
418                          == (CXt_LOOP|CXp_PADVAR))
419 #endif
420
421 #define CxTYPE(c)       ((c)->cx_type & CXTYPEMASK)
422 #define CxREALEVAL(c)   (((c)->cx_type & (CXt_EVAL|CXp_REAL))           \
423                          == (CXt_EVAL|CXp_REAL))
424 #define CxTRYBLOCK(c)   (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK))       \
425                          == (CXt_EVAL|CXp_TRYBLOCK))
426
427 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
428
429 /* 
430 =head1 "Gimme" Values
431 */
432
433 /*
434 =for apidoc AmU||G_SCALAR
435 Used to indicate scalar context.  See C<GIMME_V>, C<GIMME>, and
436 L<perlcall>.
437
438 =for apidoc AmU||G_ARRAY
439 Used to indicate list context.  See C<GIMME_V>, C<GIMME> and
440 L<perlcall>.
441
442 =for apidoc AmU||G_VOID
443 Used to indicate void context.  See C<GIMME_V> and L<perlcall>.
444
445 =for apidoc AmU||G_DISCARD
446 Indicates that arguments returned from a callback should be discarded.  See
447 L<perlcall>.
448
449 =for apidoc AmU||G_EVAL
450
451 Used to force a Perl C<eval> wrapper around a callback.  See
452 L<perlcall>.
453
454 =for apidoc AmU||G_NOARGS
455
456 Indicates that no arguments are being sent to a callback.  See
457 L<perlcall>.
458
459 =cut
460 */
461
462 #define G_SCALAR        0
463 #define G_ARRAY         1
464 #define G_VOID          128     /* skip this bit when adding flags below */
465
466 /* extra flags for Perl_call_* routines */
467 #define G_DISCARD       2       /* Call FREETMPS. */
468 #define G_EVAL          4       /* Assume eval {} around subroutine call. */
469 #define G_NOARGS        8       /* Don't construct a @_ array. */
470 #define G_KEEPERR      16       /* Append errors to $@, don't overwrite it */
471 #define G_NODEBUG      32       /* Disable debugging at toplevel.  */
472 #define G_METHOD       64       /* Calling method. */
473
474 /* flag bits for PL_in_eval */
475 #define EVAL_NULL       0       /* not in an eval */
476 #define EVAL_INEVAL     1       /* some enclosing scope is an eval */
477 #define EVAL_WARNONLY   2       /* used by yywarn() when calling yyerror() */
478 #define EVAL_KEEPERR    4       /* set by Perl_call_sv if G_KEEPERR */
479 #define EVAL_INREQUIRE  8       /* The code is being required. */
480
481 /* Support for switching (stack and block) contexts.
482  * This ensures magic doesn't invalidate local stack and cx pointers.
483  */
484
485 #define PERLSI_UNKNOWN          -1
486 #define PERLSI_UNDEF            0
487 #define PERLSI_MAIN             1
488 #define PERLSI_MAGIC            2
489 #define PERLSI_SORT             3
490 #define PERLSI_SIGNAL           4
491 #define PERLSI_OVERLOAD         5
492 #define PERLSI_DESTROY          6
493 #define PERLSI_WARNHOOK         7
494 #define PERLSI_DIEHOOK          8
495 #define PERLSI_REQUIRE          9
496
497 struct stackinfo {
498     AV *                si_stack;       /* stack for current runlevel */
499     PERL_CONTEXT *      si_cxstack;     /* context stack for runlevel */
500     I32                 si_cxix;        /* current context index */
501     I32                 si_cxmax;       /* maximum allocated index */
502     I32                 si_type;        /* type of runlevel */
503     struct stackinfo *  si_prev;
504     struct stackinfo *  si_next;
505     I32                 si_markoff;     /* offset where markstack begins for us.
506                                          * currently used only with DEBUGGING,
507                                          * but not #ifdef-ed for bincompat */
508 };
509
510 typedef struct stackinfo PERL_SI;
511
512 #define cxstack         (PL_curstackinfo->si_cxstack)
513 #define cxstack_ix      (PL_curstackinfo->si_cxix)
514 #define cxstack_max     (PL_curstackinfo->si_cxmax)
515
516 #ifdef DEBUGGING
517 #  define       SET_MARK_OFFSET \
518     PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
519 #else
520 #  define       SET_MARK_OFFSET NOOP
521 #endif
522
523 #define PUSHSTACKi(type) \
524     STMT_START {                                                        \
525         PERL_SI *next = PL_curstackinfo->si_next;                       \
526         if (!next) {                                                    \
527             next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1);    \
528             next->si_prev = PL_curstackinfo;                            \
529             PL_curstackinfo->si_next = next;                            \
530         }                                                               \
531         next->si_type = type;                                           \
532         next->si_cxix = -1;                                             \
533         AvFILLp(next->si_stack) = 0;                                    \
534         SWITCHSTACK(PL_curstack,next->si_stack);                        \
535         PL_curstackinfo = next;                                         \
536         SET_MARK_OFFSET;                                                \
537     } STMT_END
538
539 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
540
541 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
542  * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
543 #define POPSTACK \
544     STMT_START {                                                        \
545         dSP;                                                            \
546         PERL_SI *prev = PL_curstackinfo->si_prev;                       \
547         if (!prev) {                                                    \
548             PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");         \
549             my_exit(1);                                                 \
550         }                                                               \
551         SWITCHSTACK(PL_curstack,prev->si_stack);                        \
552         /* don't free prev here, free them all at the END{} */          \
553         PL_curstackinfo = prev;                                         \
554     } STMT_END
555
556 #define POPSTACK_TO(s) \
557     STMT_START {                                                        \
558         while (PL_curstack != s) {                                      \
559             dounwind(-1);                                               \
560             POPSTACK;                                                   \
561         }                                                               \
562     } STMT_END