[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.
 *
 */

#define SAVEt_ITEM		0
#define SAVEt_SV		1
#define SAVEt_AV		2
#define SAVEt_HV		3
#define SAVEt_INT		4
#define SAVEt_LONG		5
#define SAVEt_I32		6
#define SAVEt_IV		7
#define SAVEt_SPTR		8
#define SAVEt_APTR		9
#define SAVEt_HPTR		10
#define SAVEt_PPTR		11
#define SAVEt_NSTAB		12
#define SAVEt_SVREF		13
#define SAVEt_GP		14
#define SAVEt_FREESV		15
#define SAVEt_FREEOP		16
#define SAVEt_FREEPV		17
#define SAVEt_CLEARSV		18
#define SAVEt_DELETE		19
#define SAVEt_DESTRUCTOR	20
#define SAVEt_REGCONTEXT	21
#define SAVEt_STACK_POS		22
#define SAVEt_I16		23
#define SAVEt_AELEM		24
#define SAVEt_HELEM		25
#define SAVEt_OP		26
#define SAVEt_HINTS		27
#define SAVEt_ALLOC		28
#define SAVEt_GENERIC_SVREF	29
#define SAVEt_DESTRUCTOR_X	30
#define SAVEt_VPTR		31
#define SAVEt_I8		32
#define SAVEt_COMPPAD		33
#define SAVEt_GENERIC_PVREF	34
#define SAVEt_PADSV_AND_MORTALIZE	35
#define SAVEt_MORTALIZESV	36
#define SAVEt_SHARED_PVREF	37
#define SAVEt_BOOL		38
#define SAVEt_SET_SVFLAGS	39
#define SAVEt_SAVESWITCHSTACK	40
#define SAVEt_RE_STATE		42
#define SAVEt_COMPILE_WARNINGS	43
#define SAVEt_STACK_CXPOS	44
#define SAVEt_PARSER		45
#define SAVEt_ADELETE		46
#define SAVEt_I32_SMALL		47
#define SAVEt_INT_SMALL		48
#define SAVEt_GVSV		49
#define SAVEt_FREECOPHH		50
#define SAVEt_CLEARPADRANGE	51
#define SAVEt_GVSLOT		52

#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 (PL_savestack_ix + (I32)(need) + SS_MAXPUSH > PL_savestack_max) savestack_grow()
#define SSGROW(need) if (PL_savestack_ix + (I32)(need) + SS_MAXPUSH > PL_savestack_max) savestack_grow_cnt(need + SS_MAXPUSH)
#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
 *
 * 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);                             \
    if ((ix + SS_MAXPUSH) > PL_savestack_max) savestack_grow(); \
    assert(PL_savestack_ix + SS_MAXPUSH <= 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)


/*
=head1 Callback Functions

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

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

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

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

=over

=item ENTER_with_name(name)

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

=item LEAVE_with_name(name)

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

=back

=cut
*/

#define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
#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)	{					\
	    assert(((char*)PL_scopestack_name[PL_scopestack_ix-1]	\
			== (char*)name)					\
		    || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name));        \
	}								\
	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 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), (I32)(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 SAVESTACK_CXPOS() \
    STMT_START {                                   \
        dSS_ADD;                                   \
        SS_ADD_INT(cxstack[cxstack_ix].blk_oldsp); \
        SS_ADD_INT(cxstack_ix);                    \
        SS_ADD_UV(SAVEt_STACK_CXPOS);              \
        SS_ADD_END(3);                             \
    } STMT_END

#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 integer 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)

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