[perl5.git] / scope.h

/*    scope.h
 *
 *    Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999, 2000, 2001,
 *    2002, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
 *
 *    You may distribute under the terms of either the GNU General Public
 *    License or the Artistic License, as specified in the README file.
 *
 */

/* *** Update arg_counts[] in scope.c if you modify these */

/* zero args */

#define SAVEt_ALLOC		0
#define SAVEt_CLEARPADRANGE	1
#define SAVEt_CLEARSV		2
#define SAVEt_REGCONTEXT	3

/* one arg */

#define SAVEt_TMPSFLOOR		4
#define SAVEt_BOOL		5
#define SAVEt_COMPILE_WARNINGS	6
#define SAVEt_COMPPAD		7
#define SAVEt_FREECOPHH		8
#define SAVEt_FREEOP		9
#define SAVEt_FREEPV		10
#define SAVEt_FREESV		11
#define SAVEt_I16		12
#define SAVEt_I32_SMALL		13
#define SAVEt_I8		14
#define SAVEt_INT_SMALL		15
#define SAVEt_MORTALIZESV	16
#define SAVEt_NSTAB		17
#define SAVEt_OP		18
#define SAVEt_PARSER		19
#define SAVEt_STACK_POS		20
#define SAVEt_READONLY_OFF	21
#define SAVEt_FREEPADNAME	22
#define SAVEt_STRLEN_SMALL      23

/* two args */

#define SAVEt_AV		24
#define SAVEt_DESTRUCTOR	25
#define SAVEt_DESTRUCTOR_X	26
#define SAVEt_GENERIC_PVREF	27
#define SAVEt_GENERIC_SVREF	28
#define SAVEt_GP		29
#define SAVEt_GVSV		30
#define SAVEt_HINTS		31
#define SAVEt_HPTR		32
#define SAVEt_HV		33
#define SAVEt_I32		34
#define SAVEt_INT		35
#define SAVEt_ITEM		36
#define SAVEt_IV		37
#define SAVEt_LONG		38
#define SAVEt_PPTR		39
#define SAVEt_SAVESWITCHSTACK	40
#define SAVEt_SHARED_PVREF	41
#define SAVEt_SPTR		42
#define SAVEt_STRLEN		43
#define SAVEt_SV		44
#define SAVEt_SVREF		45
#define SAVEt_VPTR		46
#define SAVEt_ADELETE		47
#define SAVEt_APTR		48

/* three args */

#define SAVEt_HELEM		49
#define SAVEt_PADSV_AND_MORTALIZE 50
#define SAVEt_SET_SVFLAGS	51
#define SAVEt_GVSLOT		52
#define SAVEt_AELEM		53
#define SAVEt_DELETE		54
#define SAVEt_HINTS_HH		55


#define SAVEf_SETMAGIC		1
#define SAVEf_KEEPOLDELEM	2

#define SAVE_TIGHT_SHIFT	6
#define SAVE_MASK		0x3F

#define save_aelem(av,idx,sptr)	save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
#define save_helem(hv,key,sptr)	save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)

#ifndef SCOPE_SAVES_SIGNAL_MASK
#define SCOPE_SAVES_SIGNAL_MASK 0
#endif

/* the maximum number of entries that might be pushed using the SS_ADD*
 * macros */
#define SS_MAXPUSH 4

#define SSCHECK(need) if (UNLIKELY(PL_savestack_ix + (I32)(need) > PL_savestack_max)) savestack_grow()
#define SSGROW(need) if (UNLIKELY(PL_savestack_ix + (I32)(need) > PL_savestack_max)) savestack_grow_cnt(need)
#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
#define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))

/* SS_ADD*: newer, faster versions of the above. Don't mix the two sets of
 * macros. These are fast because they save reduce accesses to the PL_
 * vars and move the size check to the end. Doing the check last means
 * that values in registers will have been pushed and no longer needed, so
 * don't need saving around the call to grow. Also, tail-call elimination
 * of the grow() can be done. These changes reduce the code of something
 * like save_pushptrptr() to half its former size.
 * Of course, doing the size check *after* pushing means we must always
 * ensure there are SS_MAXPUSH free slots on the savestack. This ensured
 * bt savestack_grow() and savestack_grow_cnt always allocating SS_MAXPUSH
 * slots more than asked for, or that it sets PL_savestack_max to
 *
 * These are for internal core use only and are subject to change */

#define dSS_ADD \
    I32 ix = PL_savestack_ix;     \
    ANY *ssp = &PL_savestack[ix]

#define SS_ADD_END(need) \
    assert((need) <= SS_MAXPUSH);                               \
    ix += (need);                                               \
    PL_savestack_ix = ix;                                       \
    assert(ix <= PL_savestack_max + SS_MAXPUSH);                \
    if (UNLIKELY(ix > PL_savestack_max)) savestack_grow();      \
    assert(PL_savestack_ix <= PL_savestack_max);

#define SS_ADD_INT(i)   ((ssp++)->any_i32 = (I32)(i))
#define SS_ADD_LONG(i)  ((ssp++)->any_long = (long)(i))
#define SS_ADD_BOOL(p)  ((ssp++)->any_bool = (p))
#define SS_ADD_IV(i)    ((ssp++)->any_iv = (IV)(i))
#define SS_ADD_UV(u)    ((ssp++)->any_uv = (UV)(u))
#define SS_ADD_PTR(p)   ((ssp++)->any_ptr = (void*)(p))
#define SS_ADD_DPTR(p)  ((ssp++)->any_dptr = (p))
#define SS_ADD_DXPTR(p) ((ssp++)->any_dxptr = (p))

#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
#define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)


/*
=for apidoc_section $callback

=for apidoc Amns||SAVETMPS
Opening bracket for temporaries on a callback.  See C<L</FREETMPS>> and
L<perlcall>.

=for apidoc Amns||FREETMPS
Closing bracket for temporaries on a callback.  See C<L</SAVETMPS>> and
L<perlcall>.

=for apidoc Amns||ENTER
Opening bracket on a callback.  See C<L</LEAVE>> and L<perlcall>.

=for apidoc Amns||LEAVE
Closing bracket on a callback.  See C<L</ENTER>> and L<perlcall>.

=for apidoc Ams||ENTER_with_name|"name"

Same as C<L</ENTER>>, but when debugging is enabled it also associates the
given literal string with the new scope.

=for apidoc Ams||LEAVE_with_name|"name"

Same as C<L</LEAVE>>, but when debugging is enabled it first checks that the
scope has the given name. C<name> must be a literal string.

=cut
*/

#define SAVETMPS Perl_savetmps(aTHX)

#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()

#ifdef DEBUGGING
#define ENTER							\
    STMT_START {						\
        push_scope();						\
        DEBUG_SCOPE("ENTER")					\
    } STMT_END
#define LEAVE							\
    STMT_START {						\
        DEBUG_SCOPE("LEAVE")					\
        pop_scope();						\
    } STMT_END
#define ENTER_with_name(name)						\
    STMT_START {							\
        push_scope();							\
        if (PL_scopestack_name)						\
            PL_scopestack_name[PL_scopestack_ix-1] = name;		\
        DEBUG_SCOPE("ENTER \"" name "\"")				\
    } STMT_END
#define LEAVE_with_name(name)						\
    STMT_START {							\
        DEBUG_SCOPE("LEAVE \"" name "\"")				\
        if (PL_scopestack_name)	{					\
            CLANG_DIAG_IGNORE_STMT(-Wstring-compare);			\
            assert(((char*)PL_scopestack_name[PL_scopestack_ix-1]	\
                        == (char*)name)					\
                    || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name));        \
            CLANG_DIAG_RESTORE_STMT;					\
        }								\
        pop_scope();							\
    } STMT_END
#else
#define ENTER push_scope()
#define LEAVE pop_scope()
#define ENTER_with_name(name) ENTER
#define LEAVE_with_name(name) LEAVE
#endif
#define LEAVE_SCOPE(old) STMT_START { \
        if (PL_savestack_ix > old) leave_scope(old); \
    } STMT_END

#define SAVEI8(i)	save_I8((I8*)&(i))
#define SAVEI16(i)	save_I16((I16*)&(i))
#define SAVEI32(i)	save_I32((I32*)&(i))
#define SAVEINT(i)	save_int((int*)&(i))
#define SAVEIV(i)	save_iv((IV*)&(i))
#define SAVELONG(l)	save_long((long*)&(l))
#define SAVEBOOL(b)	save_bool(&(b))
#define SAVESPTR(s)	save_sptr((SV**)&(s))
#define SAVEPPTR(s)	save_pptr((char**)&(s))
#define SAVEVPTR(s)	save_vptr((void*)&(s))
#define SAVEPADSVANDMORTALIZE(s)	save_padsv_and_mortalize(s)
#define SAVEFREESV(s)	save_freesv(MUTABLE_SV(s))
#define SAVEFREEPADNAME(s) save_pushptr((void *)(s), SAVEt_FREEPADNAME)
#define SAVEMORTALIZESV(s)	save_mortalizesv(MUTABLE_SV(s))
#define SAVEFREEOP(o)	save_freeop((OP*)(o))
#define SAVEFREEPV(p)	save_freepv((char*)(p))
#define SAVECLEARSV(sv)	save_clearsv((SV**)&(sv))
#define SAVEGENERICSV(s)	save_generic_svref((SV**)&(s))
#define SAVEGENERICPV(s)	save_generic_pvref((char**)&(s))
#define SAVESHAREDPV(s)		save_shared_pvref((char**)&(s))
#define SAVESETSVFLAGS(sv,mask,val)	save_set_svflags(sv,mask,val)
#define SAVEFREECOPHH(h)	save_pushptr((void *)(h), SAVEt_FREECOPHH)
#define SAVEDELETE(h,k,l) \
          save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
#define SAVEHDELETE(h,s) \
          save_hdelete(MUTABLE_HV(h), (s))
#define SAVEADELETE(a,k) \
          save_adelete(MUTABLE_AV(a), (SSize_t)(k))
#define SAVEDESTRUCTOR(f,p) \
          save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))

#define SAVEDESTRUCTOR_X(f,p) \
          save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))

#define SAVESTACK_POS() \
    STMT_START {				   \
        dSS_ADD;                                   \
        SS_ADD_INT(PL_stack_sp - PL_stack_base);   \
        SS_ADD_UV(SAVEt_STACK_POS);                \
        SS_ADD_END(2);                             \
    } STMT_END

#define SAVEOP()	save_op()

#define SAVEHINTS()	save_hints()

#define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)

#define SAVESWITCHSTACK(f,t) \
    STMT_START {					\
        save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
        SWITCHSTACK((f),(t));				\
        PL_curstackinfo->si_stack = (t);		\
    } STMT_END

/* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
   because realloc() means that the value can actually change. Possibly
   could have done savefreesharedpvREF, but this way actually seems cleaner,
   as it simplifies the code that does the saves, and reduces the load on the
   save stack.  */
#define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)

#define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)

#ifdef USE_ITHREADS
#  define SAVECOPSTASH_FREE(c)	SAVEIV((c)->cop_stashoff)
#  define SAVECOPFILE(c)	SAVEPPTR(CopFILE(c))
#  define SAVECOPFILE_FREE(c)	SAVESHAREDPV(CopFILE(c))
#else
#  /* XXX not refcounted */
#  define SAVECOPSTASH_FREE(c)	SAVESPTR(CopSTASH(c))
#  define SAVECOPFILE(c)	SAVESPTR(CopFILEGV(c))
#  define SAVECOPFILE_FREE(c)	SAVEGENERICSV(CopFILEGV(c))
#endif

#define SAVECOPLINE(c)		SAVEI32(CopLINE(c))

/* SSNEW() temporarily allocates a specified number of bytes of data on the
 * savestack.  It returns an I32 index into the savestack, because a
 * pointer would get broken if the savestack is moved on reallocation.
 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
 * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
 * alignment will be preserved through savestack reallocation *only* if
 * realloc returns data aligned to a size divisible by "align"!
 *
 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
 */

#define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
#define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
#define SSNEWa(size,align)	Perl_save_alloc(aTHX_ (size), \
    (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
#define SSNEWat(n,t,align)	SSNEWa((n)*sizeof(t), align)

#define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
#define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))

#define save_freesv(op)		save_pushptr((void *)(op), SAVEt_FREESV)
#define save_mortalizesv(op)	save_pushptr((void *)(op), SAVEt_MORTALIZESV)

# define save_freeop(op)                    \
STMT_START {                                 \
      OP * const _o = (OP *)(op);             \
      assert(!_o->op_savefree);               \
      _o->op_savefree = 1;                     \
      save_pushptr((void *)(_o), SAVEt_FREEOP); \
    } STMT_END
#define save_freepv(pv)		save_pushptr((void *)(pv), SAVEt_FREEPV)
#define save_op()		save_pushptr((void *)(PL_op), SAVEt_OP)

/*
 * ex: set ts=8 sts=4 sw=4 et:
 */
Commit	Line	Data
d6376244 JH	1	/* scope.h
d6376244 JH	2	*
1129b882 NC	3	* Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999, 2000, 2001,
1129b882 NC	4	* 2002, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
d6376244 JH	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	*
	9	*/
	10
9a2fefd6	11	/* *** Update arg_counts[] in scope.c if you modify these */
03dba561 DM	12
	13	/* zero args */
	14
	15	#define SAVEt_ALLOC 0
	16	#define SAVEt_CLEARPADRANGE 1
	17	#define SAVEt_CLEARSV 2
	18	#define SAVEt_REGCONTEXT 3
03dba561	19
03dba561 DM	20	/* one arg */
03dba561 DM	21
2ef9a108	22	#define SAVEt_TMPSFLOOR 4
03dba561 DM	23	#define SAVEt_BOOL 5
	24	#define SAVEt_COMPILE_WARNINGS 6
	25	#define SAVEt_COMPPAD 7
	26	#define SAVEt_FREECOPHH 8
	27	#define SAVEt_FREEOP 9
	28	#define SAVEt_FREEPV 10
	29	#define SAVEt_FREESV 11
	30	#define SAVEt_I16 12
	31	#define SAVEt_I32_SMALL 13
	32	#define SAVEt_I8 14
	33	#define SAVEt_INT_SMALL 15
	34	#define SAVEt_MORTALIZESV 16
	35	#define SAVEt_NSTAB 17
	36	#define SAVEt_OP 18
	37	#define SAVEt_PARSER 19
	38	#define SAVEt_STACK_POS 20
20d5dc23	39	#define SAVEt_READONLY_OFF 21
0f94cb1f	40	#define SAVEt_FREEPADNAME 22
8462890b	41	#define SAVEt_STRLEN_SMALL 23
03dba561	42
03dba561 DM	43	/* two args */
03dba561 DM	44
8462890b PE	45	#define SAVEt_AV 24
	46	#define SAVEt_DESTRUCTOR 25
	47	#define SAVEt_DESTRUCTOR_X 26
	48	#define SAVEt_GENERIC_PVREF 27
	49	#define SAVEt_GENERIC_SVREF 28
	50	#define SAVEt_GP 29
	51	#define SAVEt_GVSV 30
	52	#define SAVEt_HINTS 31
	53	#define SAVEt_HPTR 32
	54	#define SAVEt_HV 33
	55	#define SAVEt_I32 34
	56	#define SAVEt_INT 35
	57	#define SAVEt_ITEM 36
	58	#define SAVEt_IV 37
	59	#define SAVEt_LONG 38
	60	#define SAVEt_PPTR 39
	61	#define SAVEt_SAVESWITCHSTACK 40
	62	#define SAVEt_SHARED_PVREF 41
	63	#define SAVEt_SPTR 42
	64	#define SAVEt_STRLEN 43
	65	#define SAVEt_SV 44
	66	#define SAVEt_SVREF 45
	67	#define SAVEt_VPTR 46
	68	#define SAVEt_ADELETE 47
	69	#define SAVEt_APTR 48
03dba561	70
03dba561 DM	71	/* three args */
03dba561 DM	72
8462890b PE	73	#define SAVEt_HELEM 49
	74	#define SAVEt_PADSV_AND_MORTALIZE 50
	75	#define SAVEt_SET_SVFLAGS 51
	76	#define SAVEt_GVSLOT 52
	77	#define SAVEt_AELEM 53
	78	#define SAVEt_DELETE 54
	79	#define SAVEt_HINTS_HH 55
0f94cb1f	80
79072805	81
af7df257	82	#define SAVEf_SETMAGIC 1
75d34a09	83	#define SAVEf_KEEPOLDELEM 2
af7df257	84
c6bf6a65 NC	85	#define SAVE_TIGHT_SHIFT 6
	86	#define SAVE_MASK 0x3F
	87
91d1c79f	88	#define save_aelem(av,idx,sptr) save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
af7df257 CS	89	#define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
af7df257 CS	90
b03c0a3a	91	#ifndef SCOPE_SAVES_SIGNAL_MASK
1b266415	92	#define SCOPE_SAVES_SIGNAL_MASK 0
b03c0a3a NIS	93	#endif
b03c0a3a NIS	94
a3444cc5 DM	95	/* the maximum number of entries that might be pushed using the SS_ADD*
	96	* macros */
	97	#define SS_MAXPUSH 4
	98
3caf0269 DM	99	#define SSCHECK(need) if (UNLIKELY(PL_savestack_ix + (I32)(need) > PL_savestack_max)) savestack_grow()
3caf0269 DM	100	#define SSGROW(need) if (UNLIKELY(PL_savestack_ix + (I32)(need) > PL_savestack_max)) savestack_grow_cnt(need)
3280af22 NIS	101	#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
3280af22 NIS	102	#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
9febdf04	103	#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
3280af22	104	#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
c6bf6a65	105	#define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
3280af22 NIS	106	#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
3280af22 NIS	107	#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
c76ac1ee	108	#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
a3444cc5 DM	109
	110	/* SS_ADD*: newer, faster versions of the above. Don't mix the two sets of
	111	* macros. These are fast because they save reduce accesses to the PL_
	112	* vars and move the size check to the end. Doing the check last means
	113	* that values in registers will have been pushed and no longer needed, so
	114	* don't need saving around the call to grow. Also, tail-call elimination
	115	* of the grow() can be done. These changes reduce the code of something
	116	* like save_pushptrptr() to half its former size.
	117	* Of course, doing the size check after pushing means we must always
3caf0269 DM	118	* ensure there are SS_MAXPUSH free slots on the savestack. This ensured
	119	* bt savestack_grow() and savestack_grow_cnt always allocating SS_MAXPUSH
	120	* slots more than asked for, or that it sets PL_savestack_max to
a3444cc5 DM	121	*
	122	* These are for internal core use only and are subject to change */
	123
	124	#define dSS_ADD \
	125	I32 ix = PL_savestack_ix; \
c70927a6	126	ANY *ssp = &PL_savestack[ix]
a3444cc5 DM	127
	128	#define SS_ADD_END(need) \
	129	assert((need) <= SS_MAXPUSH); \
	130	ix += (need); \
	131	PL_savestack_ix = ix; \
3caf0269 DM	132	assert(ix <= PL_savestack_max + SS_MAXPUSH); \
	133	if (UNLIKELY(ix > PL_savestack_max)) savestack_grow(); \
	134	assert(PL_savestack_ix <= PL_savestack_max);
a3444cc5 DM	135
	136	#define SS_ADD_INT(i) ((ssp++)->any_i32 = (I32)(i))
	137	#define SS_ADD_LONG(i) ((ssp++)->any_long = (long)(i))
	138	#define SS_ADD_BOOL(p) ((ssp++)->any_bool = (p))
	139	#define SS_ADD_IV(i) ((ssp++)->any_iv = (IV)(i))
	140	#define SS_ADD_UV(u) ((ssp++)->any_uv = (UV)(u))
	141	#define SS_ADD_PTR(p) ((ssp++)->any_ptr = (void*)(p))
	142	#define SS_ADD_DPTR(p) ((ssp++)->any_dptr = (p))
	143	#define SS_ADD_DXPTR(p) ((ssp++)->any_dxptr = (p))
	144
3280af22 NIS	145	#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
3280af22 NIS	146	#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
9febdf04	147	#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
3280af22	148	#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
c6bf6a65	149	#define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
3280af22 NIS	150	#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
3280af22 NIS	151	#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
c76ac1ee	152	#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
8990e307	153
a3444cc5	154
954c1994	155	/*
3f620621	156	=for apidoc_section $callback
ccfc67b7	157
4e5171e9	158	=for apidoc Amns\|\|SAVETMPS
fbe13c60	159	Opening bracket for temporaries on a callback. See C<L</FREETMPS>> and
954c1994 GS	160	L<perlcall>.
954c1994 GS	161
4e5171e9	162	=for apidoc Amns\|\|FREETMPS
fbe13c60	163	Closing bracket for temporaries on a callback. See C<L</SAVETMPS>> and
954c1994 GS	164	L<perlcall>.
954c1994 GS	165
4e5171e9	166	=for apidoc Amns\|\|ENTER
fbe13c60	167	Opening bracket on a callback. See C<L</LEAVE>> and L<perlcall>.
954c1994	168
4e5171e9	169	=for apidoc Amns\|\|LEAVE
fbe13c60	170	Closing bracket on a callback. See C<L</ENTER>> and L<perlcall>.
954c1994	171
3bb9fd01	172	=for apidoc Ams\|\|ENTER_with_name\|"name"
d343c3ef	173
ef7ea7ad	174	Same as C<L</ENTER>>, but when debugging is enabled it also associates the
d343c3ef GG	175	given literal string with the new scope.
d343c3ef GG	176
3bb9fd01	177	=for apidoc Ams\|\|LEAVE_with_name\|"name"
d343c3ef	178
ef7ea7ad	179	Same as C<L</LEAVE>>, but when debugging is enabled it first checks that the
1568d13a	180	scope has the given name. C<name> must be a literal string.
d343c3ef	181
954c1994 GS	182	=cut
	183	*/
	184
2ef9a108 DM	185	#define SAVETMPS Perl_savetmps(aTHX)
2ef9a108 DM	186
3280af22	187	#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
a0d0e21e	188
f46d017c GS	189	#ifdef DEBUGGING
	190	#define ENTER \
	191	STMT_START { \
1604cfb0 MS	192	push_scope(); \
1604cfb0 MS	193	DEBUG_SCOPE("ENTER") \
f46d017c GS	194	} STMT_END
	195	#define LEAVE \
	196	STMT_START { \
1604cfb0 MS	197	DEBUG_SCOPE("LEAVE") \
1604cfb0 MS	198	pop_scope(); \
f46d017c	199	} STMT_END
d343c3ef GG	200	#define ENTER_with_name(name) \
d343c3ef GG	201	STMT_START { \
1604cfb0 MS	202	push_scope(); \
	203	if (PL_scopestack_name) \
	204	PL_scopestack_name[PL_scopestack_ix-1] = name; \
	205	DEBUG_SCOPE("ENTER \"" name "\"") \
d343c3ef GG	206	} STMT_END
	207	#define LEAVE_with_name(name) \
	208	STMT_START { \
1604cfb0 MS	209	DEBUG_SCOPE("LEAVE \"" name "\"") \
1604cfb0 MS	210	if (PL_scopestack_name) { \
5f356391	211	CLANG_DIAG_IGNORE_STMT(-Wstring-compare); \
1604cfb0 MS	212	assert(((char*)PL_scopestack_name[PL_scopestack_ix-1] \
	213	== (char*)name) \
	214	\|\| strEQ(PL_scopestack_name[PL_scopestack_ix-1], name)); \
5f356391	215	CLANG_DIAG_RESTORE_STMT; \
1604cfb0 MS	216	} \
1604cfb0 MS	217	pop_scope(); \
d343c3ef	218	} STMT_END
f46d017c	219	#else
a0d0e21e LW	220	#define ENTER push_scope()
a0d0e21e LW	221	#define LEAVE pop_scope()
d343c3ef GG	222	#define ENTER_with_name(name) ENTER
d343c3ef GG	223	#define LEAVE_with_name(name) LEAVE
f46d017c	224	#endif
d699ecb7	225	#define LEAVE_SCOPE(old) STMT_START { \
1604cfb0	226	if (PL_savestack_ix > old) leave_scope(old); \
d699ecb7	227	} STMT_END
a0d0e21e	228
3f26ef39 NC	229	#define SAVEI8(i) save_I8((I8*)&(i))
	230	#define SAVEI16(i) save_I16((I16*)&(i))
	231	#define SAVEI32(i) save_I32((I32*)&(i))
	232	#define SAVEINT(i) save_int((int*)&(i))
	233	#define SAVEIV(i) save_iv((IV*)&(i))
	234	#define SAVELONG(l) save_long((long*)&(l))
02644217	235	#define SAVEBOOL(b) save_bool(&(b))
55497cff	236	#define SAVESPTR(s) save_sptr((SV**)&(s))
3f26ef39	237	#define SAVEPPTR(s) save_pptr((char**)&(s))
57b2e452	238	#define SAVEVPTR(s) save_vptr((void*)&(s))
09edbca0	239	#define SAVEPADSVANDMORTALIZE(s) save_padsv_and_mortalize(s)
b1bc3f34	240	#define SAVEFREESV(s) save_freesv(MUTABLE_SV(s))
0f94cb1f	241	#define SAVEFREEPADNAME(s) save_pushptr((void *)(s), SAVEt_FREEPADNAME)
b1bc3f34	242	#define SAVEMORTALIZESV(s) save_mortalizesv(MUTABLE_SV(s))
3f26ef39 NC	243	#define SAVEFREEOP(o) save_freeop((OP*)(o))
	244	#define SAVEFREEPV(p) save_freepv((char*)(p))
	245	#define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
b9d12d37	246	#define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
f4dd75d9	247	#define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
05ec9bb3	248	#define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
14f338dc	249	#define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
3987a177	250	#define SAVEFREECOPHH(h) save_pushptr((void *)(h), SAVEt_FREECOPHH)
55497cff	251	#define SAVEDELETE(h,k,l) \
1604cfb0	252	save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
af097752	253	#define SAVEHDELETE(h,s) \
1604cfb0	254	save_hdelete(MUTABLE_HV(h), (s))
c68ec7a9	255	#define SAVEADELETE(a,k) \
1604cfb0	256	save_adelete(MUTABLE_AV(a), (SSize_t)(k))
55497cff	257	#define SAVEDESTRUCTOR(f,p) \
1604cfb0	258	save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
c76ac1ee GS	259
c76ac1ee GS	260	#define SAVEDESTRUCTOR_X(f,p) \
1604cfb0	261	save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
25eaa213 GS	262
25eaa213 GS	263	#define SAVESTACK_POS() \
a3444cc5 DM	264	STMT_START { \
	265	dSS_ADD; \
	266	SS_ADD_INT(PL_stack_sp - PL_stack_base); \
	267	SS_ADD_UV(SAVEt_STACK_POS); \
	268	SS_ADD_END(2); \
25eaa213 GS	269	} STMT_END
25eaa213 GS	270
462e5cf6	271	#define SAVEOP() save_op()
25eaa213	272
da8315f8	273	#define SAVEHINTS() save_hints()
354992b1	274
9c47725a	275	#define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
a9332b4a	276
8b7059b1 DM	277	#define SAVESWITCHSTACK(f,t) \
8b7059b1 DM	278	STMT_START { \
1604cfb0 MS	279	save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
	280	SWITCHSTACK((f),(t)); \
	281	PL_curstackinfo->si_stack = (t); \
8b7059b1 DM	282	} STMT_END
8b7059b1 DM	283
c88c823b	284	/* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
72dc9ed5 NC	285	because realloc() means that the value can actually change. Possibly
	286	could have done savefreesharedpvREF, but this way actually seems cleaner,
	287	as it simplifies the code that does the saves, and reduces the load on the
	288	save stack. */
747e2fae	289	#define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
fc15ae8f	290
747e2fae	291	#define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
7c197c94	292
57843af0	293	#ifdef USE_ITHREADS
d4d03940	294	# define SAVECOPSTASH_FREE(c) SAVEIV((c)->cop_stashoff)
1dc74fdb FC	295	# define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
1dc74fdb FC	296	# define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
57843af0	297	#else
61b3e50d FC	298	# /* XXX not refcounted */
61b3e50d FC	299	# define SAVECOPSTASH_FREE(c) SAVESPTR(CopSTASH(c))
f4dd75d9 GS	300	# define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
f4dd75d9 GS	301	# define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
57843af0 GS	302	#endif
57843af0 GS	303
dea28490	304	#define SAVECOPLINE(c) SAVEI32(CopLINE(c))
57843af0	305
455ece5e	306	/* SSNEW() temporarily allocates a specified number of bytes of data on the
e42a763c	307	* savestack. It returns an I32 index into the savestack, because a
455ece5e AD	308	* pointer would get broken if the savestack is moved on reallocation.
	309	* SSNEWa() works like SSNEW(), but also aligns the data to the specified
	310	* number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
486ec47a	311	* alignment will be preserved through savestack reallocation only if
a0288114	312	* realloc returns data aligned to a size divisible by "align"!
455ece5e AD	313	*
	314	* SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
	315	*/
	316
f2b2c1a7	317	#define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
02db2b7b	318	#define SSNEWt(n,t) SSNEW((n)*sizeof(t))
f2b2c1a7	319	#define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
6b99f28a	320	(I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
02db2b7b	321	#define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
455ece5e	322
02db2b7b IZ	323	#define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
02db2b7b IZ	324	#define SSPTRt(off,type) ((type) ((char)PL_savestack + off))
455ece5e	325
2fd8beea NC	326	#define save_freesv(op) save_pushptr((void *)(op), SAVEt_FREESV)
2fd8beea NC	327	#define save_mortalizesv(op) save_pushptr((void *)(op), SAVEt_MORTALIZESV)
6702ba93	328
bb38a9e0	329	# define save_freeop(op) \
6702ba93	330	STMT_START { \
bb38a9e0	331	OP * const _o = (OP *)(op); \
6c7ae946	332	assert(!_o->op_savefree); \
bb38a9e0 FC	333	_o->op_savefree = 1; \
bb38a9e0 FC	334	save_pushptr((void *)(_o), SAVEt_FREEOP); \
6702ba93	335	} STMT_END
2fd8beea NC	336	#define save_freepv(pv) save_pushptr((void *)(pv), SAVEt_FREEPV)
	337	#define save_op() save_pushptr((void *)(PL_op), SAVEt_OP)
	338
e9a8c099	339	/*
14d04a33	340	* ex: set ts=8 sts=4 sw=4 et:
e9a8c099	341	*/