This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Benchmark.t: better diagnostics
[perl5.git] / pp.h
CommitLineData
a0d0e21e 1/* pp.h
79072805 2 *
1129b882
NC
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
79072805 5 *
a0d0e21e
LW
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.
79072805 8 *
a0d0e21e 9 */
79072805 10
cea2e8a9 11#define PP(s) OP * Perl_##s(pTHX)
79072805 12
954c1994 13/*
ccfc67b7
JH
14=head1 Stack Manipulation Macros
15
954c1994 16=for apidoc AmU||SP
fbe13c60 17Stack pointer. This is usually handled by C<xsubpp>. See C<L</dSP>> and
954c1994
GS
18C<SPAGAIN>.
19
20=for apidoc AmU||MARK
fbe13c60 21Stack marker variable for the XSUB. See C<L</dMARK>>.
954c1994 22
c578083c 23=for apidoc Am|void|PUSHMARK|SP
fbe13c60 24Opening bracket for arguments on a callback. See C<L</PUTBACK>> and
954c1994
GS
25L<perlcall>.
26
27=for apidoc Ams||dSP
28Declares a local copy of perl's stack pointer for the XSUB, available via
fbe13c60 29the C<SP> macro. See C<L</SP>>.
954c1994 30
fac3506f
MS
31=for apidoc ms||djSP
32
154e47c8 33Declare Just C<SP>. This is actually identical to C<dSP>, and declares
fac3506f 34a local copy of perl's stack pointer, available via the C<SP> macro.
fbe13c60
KW
35See C<L<perlapi/SP>>. (Available for backward source code compatibility with
36the old (Perl 5.005) thread model.)
fac3506f 37
954c1994 38=for apidoc Ams||dMARK
fbe13c60
KW
39Declare a stack marker variable, C<mark>, for the XSUB. See C<L</MARK>> and
40C<L</dORIGMARK>>.
954c1994
GS
41
42=for apidoc Ams||dORIGMARK
fbe13c60 43Saves the original stack mark for the XSUB. See C<L</ORIGMARK>>.
954c1994
GS
44
45=for apidoc AmU||ORIGMARK
fbe13c60 46The original stack mark for the XSUB. See C<L</dORIGMARK>>.
954c1994
GS
47
48=for apidoc Ams||SPAGAIN
49Refetch the stack pointer. Used after a callback. See L<perlcall>.
50
fac3506f 51=cut */
954c1994 52
ac634a9a 53#undef SP /* Solaris 2.7 i386 has this in /usr/include/sys/reg.h */
79072805
LW
54#define SP sp
55#define MARK mark
56#define TARG targ
57
6cae08a8 58#if defined(DEBUGGING) && defined(PERL_USE_GCC_BRACE_GROUPS)
101d6365 59# define PUSHMARK(p) \
6cae08a8
RU
60 STMT_START { \
61 I32 * mark_stack_entry; \
62 if (UNLIKELY((mark_stack_entry = ++PL_markstack_ptr) == PL_markstack_max)) \
63 mark_stack_entry = markstack_grow(); \
64 *mark_stack_entry = (I32)((p) - PL_stack_base); \
65 DEBUG_s(PerlIO_printf(Perl_debug_log, "MARK push %p %d\n", \
66 PL_markstack_ptr, *mark_stack_entry)); \
67 } STMT_END
101d6365 68# define TOPMARK \
6cae08a8
RU
69 ({ \
70 DEBUG_s(PerlIO_printf(Perl_debug_log, "MARK top %p %d\n", \
71 PL_markstack_ptr, *PL_markstack_ptr)); \
72 *PL_markstack_ptr; \
73 })
101d6365 74# define POPMARK \
6cae08a8
RU
75 ({ \
76 DEBUG_s(PerlIO_printf(Perl_debug_log, "MARK pop %p %d\n", \
77 (PL_markstack_ptr-1), *(PL_markstack_ptr-1))); \
78 assert((PL_markstack_ptr > PL_markstack) || !"MARK underflow");\
79 *PL_markstack_ptr--; \
80 })
101d6365 81# define INCMARK \
6cae08a8
RU
82 ({ \
83 DEBUG_s(PerlIO_printf(Perl_debug_log, "MARK inc %p %d\n", \
84 (PL_markstack_ptr+1), *(PL_markstack_ptr+1))); \
85 *PL_markstack_ptr++; \
86 })
87#else
101d6365 88# define PUSHMARK(p) \
6cae08a8
RU
89 STMT_START { \
90 I32 * mark_stack_entry; \
91 if (UNLIKELY((mark_stack_entry = ++PL_markstack_ptr) == PL_markstack_max)) \
92 mark_stack_entry = markstack_grow(); \
93 *mark_stack_entry = (I32)((p) - PL_stack_base); \
94 } STMT_END
101d6365
DM
95# define TOPMARK (*PL_markstack_ptr)
96# define POPMARK (*PL_markstack_ptr--)
97# define INCMARK (*PL_markstack_ptr++)
6cae08a8 98#endif
a0d0e21e 99
bc0d193f 100#define dSP SV **sp = PL_stack_sp
39644a26 101#define djSP dSP
5aaab254 102#define dMARK SV **mark = PL_stack_base + POPMARK
514696af 103#define dORIGMARK const I32 origmark = (I32)(mark - PL_stack_base)
3280af22 104#define ORIGMARK (PL_stack_base + origmark)
79072805 105
3280af22 106#define SPAGAIN sp = PL_stack_sp
16e7e110 107#define MSPAGAIN STMT_START { sp = PL_stack_sp; mark = ORIGMARK; } STMT_END
79072805 108
533c011a 109#define GETTARGETSTACKED targ = (PL_op->op_flags & OPf_STACKED ? POPs : PAD_SV(PL_op->op_targ))
79072805
LW
110#define dTARGETSTACKED SV * GETTARGETSTACKED
111
533c011a 112#define GETTARGET targ = PAD_SV(PL_op->op_targ)
79072805
LW
113#define dTARGET SV * GETTARGET
114
533c011a 115#define GETATARGET targ = (PL_op->op_flags & OPf_STACKED ? sp[-1] : PAD_SV(PL_op->op_targ))
79072805
LW
116#define dATARGET SV * GETATARGET
117
118#define dTARG SV *targ
119
533c011a 120#define NORMAL PL_op->op_next
9fed9930 121#define DIE return Perl_die
79072805 122
954c1994
GS
123/*
124=for apidoc Ams||PUTBACK
125Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
fbe13c60 126See C<L</PUSHMARK>> and L<perlcall> for other uses.
954c1994
GS
127
128=for apidoc Amn|SV*|POPs
129Pops an SV off the stack.
130
131=for apidoc Amn|char*|POPp
4b7c0884 132Pops a string off the stack.
595ae481
NIS
133
134=for apidoc Amn|char*|POPpx
4b7c0884
FC
135Pops a string off the stack. Identical to POPp. There are two names for
136historical reasons.
595ae481
NIS
137
138=for apidoc Amn|char*|POPpbytex
139Pops a string off the stack which must consist of bytes i.e. characters < 256.
954c1994
GS
140
141=for apidoc Amn|NV|POPn
142Pops a double off the stack.
143
144=for apidoc Amn|IV|POPi
145Pops an integer off the stack.
146
d0554719
TC
147=for apidoc Amn|UV|POPu
148Pops an unsigned integer off the stack.
149
954c1994
GS
150=for apidoc Amn|long|POPl
151Pops a long off the stack.
152
d0554719
TC
153=for apidoc Amn|long|POPul
154Pops an unsigned long off the stack.
155
954c1994
GS
156=cut
157*/
158
3280af22 159#define PUTBACK PL_stack_sp = sp
8a67133a
NC
160#define RETURN return (PUTBACK, NORMAL)
161#define RETURNOP(o) return (PUTBACK, o)
162#define RETURNX(x) return (x, PUTBACK, NORMAL)
79072805
LW
163
164#define POPs (*sp--)
4b7c0884 165#define POPp POPpx
8c074e2a
NC
166#define POPpx (SvPVx_nolen(POPs))
167#define POPpconstx (SvPVx_nolen_const(POPs))
168#define POPpbytex (SvPVbytex_nolen(POPs))
463ee0b2 169#define POPn (SvNVx(POPs))
a0d0e21e 170#define POPi ((IV)SvIVx(POPs))
ff68c719 171#define POPu ((UV)SvUVx(POPs))
463ee0b2 172#define POPl ((long)SvIVx(POPs))
d9b3e12d 173#define POPul ((unsigned long)SvIVx(POPs))
79072805
LW
174
175#define TOPs (*sp)
56370e9f 176#define TOPm1s (*(sp-1))
7dca457a 177#define TOPp1s (*(sp+1))
4b7c0884 178#define TOPp TOPpx
95fad918 179#define TOPpx (SvPV_nolen(TOPs))
463ee0b2 180#define TOPn (SvNV(TOPs))
a0d0e21e 181#define TOPi ((IV)SvIV(TOPs))
ff68c719 182#define TOPu ((UV)SvUV(TOPs))
463ee0b2 183#define TOPl ((long)SvIV(TOPs))
c5a0f51a 184#define TOPul ((unsigned long)SvUV(TOPs))
79072805
LW
185
186/* Go to some pains in the rare event that we must extend the stack. */
954c1994
GS
187
188/*
fc16c392 189=for apidoc Am|void|EXTEND|SP|SSize_t nitems
72d33970 190Used to extend the argument stack for an XSUB's return values. Once
4375e838 191used, guarantees that there is room for at least C<nitems> to be pushed
954c1994
GS
192onto the stack.
193
194=for apidoc Am|void|PUSHs|SV* sv
aacdac46 195Push an SV onto the stack. The stack must have room for this element.
fbe13c60
KW
196Does not handle 'set' magic. Does not use C<TARG>. See also
197C<L</PUSHmortal>>, C<L</XPUSHs>>, and C<L</XPUSHmortal>>.
954c1994
GS
198
199=for apidoc Am|void|PUSHp|char* str|STRLEN len
200Push a string onto the stack. The stack must have room for this element.
d82b684c
SH
201The C<len> indicates the length of the string. Handles 'set' magic. Uses
202C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
203call multiple C<TARG>-oriented macros to return lists from XSUB's - see
fbe13c60 204C<L</mPUSHp>> instead. See also C<L</XPUSHp>> and C<L</mXPUSHp>>.
954c1994
GS
205
206=for apidoc Am|void|PUSHn|NV nv
207Push a double onto the stack. The stack must have room for this element.
d82b684c
SH
208Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
209called to declare it. Do not call multiple C<TARG>-oriented macros to
fbe13c60
KW
210return lists from XSUB's - see C<L</mPUSHn>> instead. See also C<L</XPUSHn>>
211and C<L</mXPUSHn>>.
954c1994
GS
212
213=for apidoc Am|void|PUSHi|IV iv
214Push an integer onto the stack. The stack must have room for this element.
d82b684c
SH
215Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
216called to declare it. Do not call multiple C<TARG>-oriented macros to
fbe13c60
KW
217return lists from XSUB's - see C<L</mPUSHi>> instead. See also C<L</XPUSHi>>
218and C<L</mXPUSHi>>.
954c1994
GS
219
220=for apidoc Am|void|PUSHu|UV uv
221Push an unsigned integer onto the stack. The stack must have room for this
d82b684c
SH
222element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
223should be called to declare it. Do not call multiple C<TARG>-oriented
fbe13c60
KW
224macros to return lists from XSUB's - see C<L</mPUSHu>> instead. See also
225C<L</XPUSHu>> and C<L</mXPUSHu>>.
954c1994
GS
226
227=for apidoc Am|void|XPUSHs|SV* sv
228Push an SV onto the stack, extending the stack if necessary. Does not
fbe13c60 229handle 'set' magic. Does not use C<TARG>. See also C<L</XPUSHmortal>>,
d82b684c 230C<PUSHs> and C<PUSHmortal>.
954c1994
GS
231
232=for apidoc Am|void|XPUSHp|char* str|STRLEN len
233Push a string onto the stack, extending the stack if necessary. The C<len>
d82b684c
SH
234indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
235C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
236multiple C<TARG>-oriented macros to return lists from XSUB's - see
fbe13c60 237C<L</mXPUSHp>> instead. See also C<L</PUSHp>> and C<L</mPUSHp>>.
954c1994
GS
238
239=for apidoc Am|void|XPUSHn|NV nv
240Push a double onto the stack, extending the stack if necessary. Handles
d82b684c
SH
241'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
242declare it. Do not call multiple C<TARG>-oriented macros to return lists
fbe13c60
KW
243from XSUB's - see C<L</mXPUSHn>> instead. See also C<L</PUSHn>> and
244C<L</mPUSHn>>.
954c1994
GS
245
246=for apidoc Am|void|XPUSHi|IV iv
247Push an integer onto the stack, extending the stack if necessary. Handles
d82b684c
SH
248'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
249declare it. Do not call multiple C<TARG>-oriented macros to return lists
fbe13c60
KW
250from XSUB's - see C<L</mXPUSHi>> instead. See also C<L</PUSHi>> and
251C<L</mPUSHi>>.
954c1994
GS
252
253=for apidoc Am|void|XPUSHu|UV uv
aacdac46 254Push an unsigned integer onto the stack, extending the stack if necessary.
d82b684c
SH
255Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
256called to declare it. Do not call multiple C<TARG>-oriented macros to
fbe13c60
KW
257return lists from XSUB's - see C<L</mXPUSHu>> instead. See also C<L</PUSHu>> and
258C<L</mPUSHu>>.
d82b684c 259
6e449a3a
MHM
260=for apidoc Am|void|mPUSHs|SV* sv
261Push an SV onto the stack and mortalizes the SV. The stack must have room
fbe13c60
KW
262for this element. Does not use C<TARG>. See also C<L</PUSHs>> and
263C<L</mXPUSHs>>.
6e449a3a 264
d82b684c
SH
265=for apidoc Am|void|PUSHmortal
266Push a new mortal SV onto the stack. The stack must have room for this
fbe13c60
KW
267element. Does not use C<TARG>. See also C<L</PUSHs>>, C<L</XPUSHmortal>> and
268C<L</XPUSHs>>.
d82b684c
SH
269
270=for apidoc Am|void|mPUSHp|char* str|STRLEN len
271Push a string onto the stack. The stack must have room for this element.
121b7712 272The C<len> indicates the length of the string. Does not use C<TARG>.
fbe13c60 273See also C<L</PUSHp>>, C<L</mXPUSHp>> and C<L</XPUSHp>>.
d82b684c
SH
274
275=for apidoc Am|void|mPUSHn|NV nv
276Push a double onto the stack. The stack must have room for this element.
fbe13c60 277Does not use C<TARG>. See also C<L</PUSHn>>, C<L</mXPUSHn>> and C<L</XPUSHn>>.
d82b684c
SH
278
279=for apidoc Am|void|mPUSHi|IV iv
280Push an integer onto the stack. The stack must have room for this element.
fbe13c60 281Does not use C<TARG>. See also C<L</PUSHi>>, C<L</mXPUSHi>> and C<L</XPUSHi>>.
d82b684c
SH
282
283=for apidoc Am|void|mPUSHu|UV uv
284Push an unsigned integer onto the stack. The stack must have room for this
fbe13c60
KW
285element. Does not use C<TARG>. See also C<L</PUSHu>>, C<L</mXPUSHu>> and
286C<L</XPUSHu>>.
d82b684c 287
6e449a3a
MHM
288=for apidoc Am|void|mXPUSHs|SV* sv
289Push an SV onto the stack, extending the stack if necessary and mortalizes
fbe13c60 290the SV. Does not use C<TARG>. See also C<L</XPUSHs>> and C<L</mPUSHs>>.
6e449a3a 291
d82b684c 292=for apidoc Am|void|XPUSHmortal
121b7712 293Push a new mortal SV onto the stack, extending the stack if necessary.
fbe13c60
KW
294Does not use C<TARG>. See also C<L</XPUSHs>>, C<L</PUSHmortal>> and
295C<L</PUSHs>>.
d82b684c
SH
296
297=for apidoc Am|void|mXPUSHp|char* str|STRLEN len
298Push a string onto the stack, extending the stack if necessary. The C<len>
fbe13c60
KW
299indicates the length of the string. Does not use C<TARG>. See also
300C<L</XPUSHp>>, C<mPUSHp> and C<PUSHp>.
d82b684c
SH
301
302=for apidoc Am|void|mXPUSHn|NV nv
121b7712 303Push a double onto the stack, extending the stack if necessary.
fbe13c60 304Does not use C<TARG>. See also C<L</XPUSHn>>, C<L</mPUSHn>> and C<L</PUSHn>>.
d82b684c
SH
305
306=for apidoc Am|void|mXPUSHi|IV iv
121b7712 307Push an integer onto the stack, extending the stack if necessary.
fbe13c60 308Does not use C<TARG>. See also C<L</XPUSHi>>, C<L</mPUSHi>> and C<L</PUSHi>>.
d82b684c
SH
309
310=for apidoc Am|void|mXPUSHu|UV uv
311Push an unsigned integer onto the stack, extending the stack if necessary.
fbe13c60 312Does not use C<TARG>. See also C<L</XPUSHu>>, C<L</mPUSHu>> and C<L</PUSHu>>.
954c1994
GS
313
314=cut
315*/
316
6768377c
DM
317/* _EXTEND_SAFE_N(n): private helper macro for EXTEND().
318 * Tests whether the value of n would be truncated when implicitly cast to
319 * SSize_t as an arg to stack_grow(). If so, sets it to -1 instead to
320 * trigger a panic. It will be constant folded on platforms where this
321 * can't happen.
322 */
323
324#define _EXTEND_SAFE_N(n) \
325 (sizeof(n) > sizeof(SSize_t) && ((SSize_t)(n) != (n)) ? -1 : (n))
326
865e3ae0 327#ifdef STRESS_REALLOC
aad79b33 328# define EXTEND(p,n) STMT_START { \
6768377c 329 sp = stack_grow(sp,p,_EXTEND_SAFE_N(n)); \
aad79b33 330 PERL_UNUSED_VAR(sp); \
8094bfa4 331 } STMT_END
865e3ae0 332/* Same thing, but update mark register too. */
aad79b33 333# define MEXTEND(p,n) STMT_START { \
ff36bb50 334 const SSize_t markoff = mark - PL_stack_base; \
6768377c 335 sp = stack_grow(sp,p,_EXTEND_SAFE_N(n)); \
aad79b33
JH
336 mark = PL_stack_base + markoff; \
337 PERL_UNUSED_VAR(sp); \
338 } STMT_END
865e3ae0 339#else
6768377c
DM
340
341/* _EXTEND_NEEDS_GROW(p,n): private helper macro for EXTEND().
342 * Tests to see whether n is too big and we need to grow the stack. Be
343 * very careful if modifying this. There are many ways to get things wrong
344 * (wrapping, truncating etc) that could cause a false negative and cause
345 * the call to stack_grow() to be skipped. On the other hand, false
346 * positives are safe.
347 * Bear in mind that sizeof(p) may be less than, equal to, or greater
348 * than sizeof(n), and while n is documented to be signed, someone might
349 * pass an unsigned value or expression. In general don't use casts to
350 * avoid warnings; instead expect the caller to fix their code.
351 * It is legal for p to be greater than PL_stack_max.
352 * If the allocated stack is already very large but current usage is
353 * small, then PL_stack_max - p might wrap round to a negative value, but
354 * this just gives a safe false positive
355 */
356
357# define _EXTEND_NEEDS_GROW(p,n) ( (n) < 0 || PL_stack_max - p < (n))
358
359# define EXTEND(p,n) STMT_START { \
360 if (UNLIKELY(_EXTEND_NEEDS_GROW(p,n))) { \
361 sp = stack_grow(sp,p,_EXTEND_SAFE_N(n)); \
aad79b33
JH
362 PERL_UNUSED_VAR(sp); \
363 } } STMT_END
79072805 364/* Same thing, but update mark register too. */
6768377c
DM
365# define MEXTEND(p,n) STMT_START { \
366 if (UNLIKELY(_EXTEND_NEEDS_GROW(p,n))) { \
367 const SSize_t markoff = mark - PL_stack_base;\
368 sp = stack_grow(sp,p,_EXTEND_SAFE_N(n)); \
aad79b33
JH
369 mark = PL_stack_base + markoff; \
370 PERL_UNUSED_VAR(sp); \
371 } } STMT_END
865e3ae0 372#endif
79072805 373
edba15b0
DM
374/* set TARG to the IV value i. If do_taint is false,
375 * assume that PL_tainted can never be true */
376#define TARGi(i, do_taint) \
377 STMT_START { \
378 IV TARGi_iv = i; \
379 if (LIKELY( \
2efdfb1e 380 ((SvFLAGS(TARG) & (SVTYPEMASK|SVf_THINKFIRST|SVf_IVisUV)) == SVt_IV) \
edba15b0
DM
381 & (do_taint ? !TAINT_get : 1))) \
382 { \
383 /* Cheap SvIOK_only(). \
384 * Assert that flags which SvIOK_only() would test or \
385 * clear can't be set, because we're SVt_IV */ \
386 assert(!(SvFLAGS(TARG) & \
387 (SVf_OOK|SVf_UTF8|(SVf_OK & ~(SVf_IOK|SVp_IOK))))); \
388 SvFLAGS(TARG) |= (SVf_IOK|SVp_IOK); \
389 /* SvIV_set() where sv_any points to head */ \
390 TARG->sv_u.svu_iv = TARGi_iv; \
391 } \
392 else \
393 sv_setiv_mg(targ, TARGi_iv); \
394 } STMT_END
395
396/* set TARG to the UV value u. If do_taint is false,
397 * assume that PL_tainted can never be true */
398#define TARGu(u, do_taint) \
399 STMT_START { \
400 UV TARGu_uv = u; \
401 if (LIKELY( \
2efdfb1e 402 ((SvFLAGS(TARG) & (SVTYPEMASK|SVf_THINKFIRST|SVf_IVisUV)) == SVt_IV) \
edba15b0
DM
403 & (do_taint ? !TAINT_get : 1) \
404 & (TARGu_uv <= (UV)IV_MAX))) \
405 { \
406 /* Cheap SvIOK_only(). \
407 * Assert that flags which SvIOK_only() would test or \
408 * clear can't be set, because we're SVt_IV */ \
409 assert(!(SvFLAGS(TARG) & \
410 (SVf_OOK|SVf_UTF8|(SVf_OK & ~(SVf_IOK|SVp_IOK))))); \
411 SvFLAGS(TARG) |= (SVf_IOK|SVp_IOK); \
412 /* SvIV_set() where sv_any points to head */ \
413 TARG->sv_u.svu_iv = TARGu_uv; \
414 } \
415 else \
416 sv_setuv_mg(targ, TARGu_uv); \
417 } STMT_END
418
419/* set TARG to the NV value n. If do_taint is false,
420 * assume that PL_tainted can never be true */
421#define TARGn(n, do_taint) \
422 STMT_START { \
423 NV TARGn_nv = n; \
424 if (LIKELY( \
425 ((SvFLAGS(TARG) & (SVTYPEMASK|SVf_THINKFIRST)) == SVt_NV) \
426 & (do_taint ? !TAINT_get : 1))) \
427 { \
428 /* Cheap SvNOK_only(). \
429 * Assert that flags which SvNOK_only() would test or \
430 * clear can't be set, because we're SVt_NV */ \
431 assert(!(SvFLAGS(TARG) & \
432 (SVf_OOK|SVf_UTF8|(SVf_OK & ~(SVf_NOK|SVp_NOK))))); \
433 SvFLAGS(TARG) |= (SVf_NOK|SVp_NOK); \
434 SvNV_set(TARG, TARGn_nv); \
435 } \
436 else \
437 sv_setnv_mg(targ, TARGn_nv); \
438 } STMT_END
439
79072805 440#define PUSHs(s) (*++sp = (s))
86547924
PP
441#define PUSHTARG STMT_START { SvSETMAGIC(TARG); PUSHs(TARG); } STMT_END
442#define PUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); PUSHTARG; } STMT_END
edba15b0
DM
443#define PUSHn(n) STMT_START { TARGn(n,1); PUSHs(TARG); } STMT_END
444#define PUSHi(i) STMT_START { TARGi(i,1); PUSHs(TARG); } STMT_END
445#define PUSHu(u) STMT_START { TARGu(u,1); PUSHs(TARG); } STMT_END
79072805 446
0acfb02f 447#define XPUSHs(s) STMT_START { EXTEND(sp,1); *++sp = (s); } STMT_END
86547924
PP
448#define XPUSHTARG STMT_START { SvSETMAGIC(TARG); XPUSHs(TARG); } STMT_END
449#define XPUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); XPUSHTARG; } STMT_END
edba15b0
DM
450#define XPUSHn(n) STMT_START { TARGn(n,1); XPUSHs(TARG); } STMT_END
451#define XPUSHi(i) STMT_START { TARGi(i,1); XPUSHs(TARG); } STMT_END
452#define XPUSHu(u) STMT_START { TARGu(u,1); XPUSHs(TARG); } STMT_END
b162f9ea 453#define XPUSHundef STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END
79072805 454
6e449a3a 455#define mPUSHs(s) PUSHs(sv_2mortal(s))
2cc7004b 456#define PUSHmortal PUSHs(sv_newmortal())
8f14ea01 457#define mPUSHp(p,l) PUSHs(newSVpvn_flags((p), (l), SVs_TEMP))
121b7712
MHM
458#define mPUSHn(n) sv_setnv(PUSHmortal, (NV)(n))
459#define mPUSHi(i) sv_setiv(PUSHmortal, (IV)(i))
460#define mPUSHu(u) sv_setuv(PUSHmortal, (UV)(u))
2cc7004b 461
6e449a3a 462#define mXPUSHs(s) XPUSHs(sv_2mortal(s))
2cc7004b 463#define XPUSHmortal XPUSHs(sv_newmortal())
8f14ea01 464#define mXPUSHp(p,l) STMT_START { EXTEND(sp,1); mPUSHp((p), (l)); } STMT_END
121b7712
MHM
465#define mXPUSHn(n) STMT_START { EXTEND(sp,1); sv_setnv(PUSHmortal, (NV)(n)); } STMT_END
466#define mXPUSHi(i) STMT_START { EXTEND(sp,1); sv_setiv(PUSHmortal, (IV)(i)); } STMT_END
467#define mXPUSHu(u) STMT_START { EXTEND(sp,1); sv_setuv(PUSHmortal, (UV)(u)); } STMT_END
d82b684c 468
79072805 469#define SETs(s) (*sp = s)
86547924
PP
470#define SETTARG STMT_START { SvSETMAGIC(TARG); SETs(TARG); } STMT_END
471#define SETp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); SETTARG; } STMT_END
edba15b0
DM
472#define SETn(n) STMT_START { TARGn(n,1); SETs(TARG); } STMT_END
473#define SETi(i) STMT_START { TARGi(i,1); SETs(TARG); } STMT_END
474#define SETu(u) STMT_START { TARGu(u,1); SETs(TARG); } STMT_END
a0d0e21e 475
79072805
LW
476#define dTOPss SV *sv = TOPs
477#define dPOPss SV *sv = POPs
65202027
DS
478#define dTOPnv NV value = TOPn
479#define dPOPnv NV value = POPn
6f1401dc 480#define dPOPnv_nomg NV value = (sp--, SvNV_nomg(TOPp1s))
a0d0e21e
LW
481#define dTOPiv IV value = TOPi
482#define dPOPiv IV value = POPi
55497cff
PP
483#define dTOPuv UV value = TOPu
484#define dPOPuv UV value = POPu
79072805 485
7a4c00b4 486#define dPOPXssrl(X) SV *right = POPs; SV *left = CAT2(X,s)
65202027 487#define dPOPXnnrl(X) NV right = POPn; NV left = CAT2(X,n)
7a4c00b4
PP
488#define dPOPXiirl(X) IV right = POPi; IV left = CAT2(X,i)
489
490#define USE_LEFT(sv) \
6b349a5c 491 (SvOK(sv) || !(PL_op->op_flags & OPf_STACKED))
6f1401dc 492#define dPOPXiirl_ul_nomg(X) \
096c060c 493 IV right = (sp--, SvIV_nomg(TOPp1s)); \
6f1401dc 494 SV *leftsv = CAT2(X,s); \
096c060c 495 IV left = USE_LEFT(leftsv) ? SvIV_nomg(leftsv) : 0
7a4c00b4
PP
496
497#define dPOPPOPssrl dPOPXssrl(POP)
498#define dPOPPOPnnrl dPOPXnnrl(POP)
7a4c00b4 499#define dPOPPOPiirl dPOPXiirl(POP)
7a4c00b4
PP
500
501#define dPOPTOPssrl dPOPXssrl(TOP)
502#define dPOPTOPnnrl dPOPXnnrl(TOP)
6f1401dc
DM
503#define dPOPTOPnnrl_nomg \
504 NV right = SvNV_nomg(TOPs); NV left = (sp--, SvNV_nomg(TOPs))
7a4c00b4 505#define dPOPTOPiirl dPOPXiirl(TOP)
6f1401dc
DM
506#define dPOPTOPiirl_ul_nomg dPOPXiirl_ul_nomg(TOP)
507#define dPOPTOPiirl_nomg \
096c060c 508 IV right = SvIV_nomg(TOPs); IV left = (sp--, SvIV_nomg(TOPs))
79072805 509
3280af22
NIS
510#define RETPUSHYES RETURNX(PUSHs(&PL_sv_yes))
511#define RETPUSHNO RETURNX(PUSHs(&PL_sv_no))
512#define RETPUSHUNDEF RETURNX(PUSHs(&PL_sv_undef))
79072805 513
3280af22
NIS
514#define RETSETYES RETURNX(SETs(&PL_sv_yes))
515#define RETSETNO RETURNX(SETs(&PL_sv_no))
516#define RETSETUNDEF RETURNX(SETs(&PL_sv_undef))
5d01050a 517#define RETSETTARG STMT_START { SETTARG; RETURN; } STMT_END
79072805 518
533c011a 519#define ARGTARG PL_op->op_targ
b162f9ea 520
f3574cc6 521#define MAXARG (PL_op->op_private & OPpARG4_MASK)
79072805 522
e336de0d
GS
523#define SWITCHSTACK(f,t) \
524 STMT_START { \
677b06e3 525 AvFILLp(f) = sp - PL_stack_base; \
3280af22 526 PL_stack_base = AvARRAY(t); \
677b06e3 527 PL_stack_max = PL_stack_base + AvMAX(t); \
3280af22 528 sp = PL_stack_sp = PL_stack_base + AvFILLp(t); \
677b06e3 529 PL_curstack = t; \
e336de0d 530 } STMT_END
79072805 531
bbce6d69 532#define EXTEND_MORTAL(n) \
a953aca5
DD
533 STMT_START { \
534 SSize_t eMiX = PL_tmps_ix + (n); \
535 if (UNLIKELY(eMiX >= PL_tmps_max)) \
dc9a870f 536 (void)Perl_tmps_grow_p(aTHX_ eMiX); \
677b06e3 537 } STMT_END
bbce6d69 538
a0d0e21e
LW
539#define AMGf_noright 1
540#define AMGf_noleft 2
541#define AMGf_assign 4
542#define AMGf_unary 8
6f1401dc
DM
543#define AMGf_numeric 0x10 /* for Perl_try_amagic_bin */
544#define AMGf_set 0x20 /* for Perl_try_amagic_bin */
67288365 545#define AMGf_want_list 0x40
636ac8fc 546#define AMGf_numarg 0x80
6f1401dc
DM
547
548
549/* do SvGETMAGIC on the stack args before checking for overload */
550
551#define tryAMAGICun_MG(method, flags) STMT_START { \
5d9574c1 552 if ( UNLIKELY((SvFLAGS(TOPs) & (SVf_ROK|SVs_GMG))) \
6f1401dc
DM
553 && Perl_try_amagic_un(aTHX_ method, flags)) \
554 return NORMAL; \
555 } STMT_END
556#define tryAMAGICbin_MG(method, flags) STMT_START { \
5d9574c1 557 if ( UNLIKELY(((SvFLAGS(TOPm1s)|SvFLAGS(TOPs)) & (SVf_ROK|SVs_GMG))) \
6f1401dc
DM
558 && Perl_try_amagic_bin(aTHX_ method, flags)) \
559 return NORMAL; \
560 } STMT_END
561
31d632c3
DM
562#define AMG_CALLunary(sv,meth) \
563 amagic_call(sv,&PL_sv_undef, meth, AMGf_noright | AMGf_unary)
564
565/* No longer used in core. Use AMG_CALLunary instead */
566#define AMG_CALLun(sv,meth) AMG_CALLunary(sv, CAT2(meth,_amg))
a0d0e21e 567
fc99edcf 568#define tryAMAGICunTARGETlist(meth, jump) \
9f39b4f1 569 STMT_START { \
b5c08826
DM
570 dSP; \
571 SV *tmpsv; \
fc99edcf 572 SV *arg= *sp; \
67288365 573 int gimme = GIMME_V; \
5d9574c1 574 if (UNLIKELY(SvAMAGIC(arg) && \
b5c08826 575 (tmpsv = amagic_call(arg, &PL_sv_undef, meth, \
05fbd38d 576 AMGf_want_list | AMGf_noright \
5d9574c1
DM
577 |AMGf_unary)))) \
578 { \
b5c08826 579 SPAGAIN; \
67288365 580 if (gimme == G_VOID) { \
898c5644 581 NOOP; \
67288365 582 } \
05fbd38d 583 else if (gimme == G_ARRAY) { \
c70927a6
FC
584 SSize_t i; \
585 SSize_t len; \
67288365 586 assert(SvTYPE(tmpsv) == SVt_PVAV); \
b9f2b683 587 len = av_tindex((AV *)tmpsv) + 1; \
67288365
JL
588 (void)POPs; /* get rid of the arg */ \
589 EXTEND(sp, len); \
590 for (i = 0; i < len; ++i) \
591 PUSHs(av_shift((AV *)tmpsv)); \
592 } \
593 else { /* AMGf_want_scalar */ \
594 dATARGET; /* just use the arg's location */ \
595 sv_setsv(TARG, tmpsv); \
596 if (opASSIGN) \
597 sp--; \
598 SETTARG; \
599 } \
b5c08826
DM
600 PUTBACK; \
601 if (jump) { \
86e5639b
GG
602 OP *jump_o = NORMAL->op_next; \
603 while (jump_o->op_type == OP_NULL) \
604 jump_o = jump_o->op_next; \
605 assert(jump_o->op_type == OP_ENTERSUB); \
101d6365 606 (void)POPMARK; \
86e5639b 607 return jump_o->op_next; \
9f39b4f1 608 } \
b5c08826
DM
609 return NORMAL; \
610 } \
9f39b4f1
NC
611 } STMT_END
612
8897dcaa
NC
613/* This is no longer used anywhere in the core. You might wish to consider
614 calling amagic_deref_call() directly, as it has a cleaner interface. */
615#define tryAMAGICunDEREF(meth) \
9f39b4f1 616 STMT_START { \
e89bfaa6 617 sv = amagic_deref_call(*sp, CAT2(meth,_amg)); \
25a9ffce 618 SPAGAIN; \
16e7e110 619 } STMT_END
e8c20960 620
180b7b9b 621
533c011a 622#define opASSIGN (PL_op->op_flags & OPf_STACKED)
a0d0e21e 623
78f9721b
SM
624/*
625=for apidoc mU||LVRET
626True if this op will be the return value of an lvalue subroutine
627
628=cut */
9d96b2e7 629#define LVRET ((PL_op->op_private & OPpMAYBE_LVSUB) && is_lvalue_sub())
1b6737cc 630
d30e492c
VP
631#define SvCANEXISTDELETE(sv) \
632 (!SvRMAGICAL(sv) \
2c5f48c2
FC
633 || !(mg = mg_find((const SV *) sv, PERL_MAGIC_tied)) \
634 || ( (stash = SvSTASH(SvRV(SvTIED_obj(MUTABLE_SV(sv), mg)))) \
d30e492c
VP
635 && gv_fetchmethod_autoload(stash, "EXISTS", TRUE) \
636 && gv_fetchmethod_autoload(stash, "DELETE", TRUE) \
637 ) \
638 )
639
d682515d 640#ifdef PERL_CORE
557fbd17 641
d682515d
NC
642/* These are just for Perl_tied_method(), which is not part of the public API.
643 Use 0x04 rather than the next available bit, to help the compiler if the
644 architecture can generate more efficient instructions. */
645# define TIED_METHOD_MORTALIZE_NOT_NEEDED 0x04
646# define TIED_METHOD_ARGUMENTS_ON_STACK 0x08
94bc412f 647# define TIED_METHOD_SAY 0x10
557fbd17
FC
648
649/* Used in various places that need to dereference a glob or globref */
094a3eec 650# define MAYBE_DEREF_GV_flags(sv,phlags) \
557fbd17 651 ( \
094a3eec 652 (void)(phlags & SV_GMAGIC && (SvGETMAGIC(sv),0)), \
557fbd17 653 isGV_with_GP(sv) \
4e794a06 654 ? (GV *)(sv) \
f8afbfa6
FC
655 : SvROK(sv) && SvTYPE(SvRV(sv)) <= SVt_PVLV && \
656 (SvGETMAGIC(SvRV(sv)), isGV_with_GP(SvRV(sv))) \
557fbd17
FC
657 ? (GV *)SvRV(sv) \
658 : NULL \
659 )
094a3eec
FC
660# define MAYBE_DEREF_GV(sv) MAYBE_DEREF_GV_flags(sv,SV_GMAGIC)
661# define MAYBE_DEREF_GV_nomg(sv) MAYBE_DEREF_GV_flags(sv,0)
557fbd17 662
db4cf31d 663# define FIND_RUNCV_padid_eq 1
b4b0692a 664# define FIND_RUNCV_level_eq 2
70794f7b 665
d682515d
NC
666#endif
667
1b6737cc 668/*
14d04a33 669 * ex: set ts=8 sts=4 sw=4 et:
1b6737cc 670 */