[p5sagit/p5-mst-13.2.git] / scope.h

#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 SSCHECK(need) if (PL_savestack_ix + need > PL_savestack_max) savestack_grow()
#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 SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)

#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_l(WITH_THR(deb("ENTER scope %ld at %s:%d\n",	\
		    PL_scopestack_ix, __FILE__, __LINE__)));	\
    } STMT_END
#define LEAVE							\
    STMT_START {						\
	DEBUG_l(WITH_THR(deb("LEAVE scope %ld at %s:%d\n",	\
		    PL_scopestack_ix, __FILE__, __LINE__)));	\
	pop_scope();						\
    } STMT_END
#else
#define ENTER push_scope()
#define LEAVE pop_scope()
#endif
#define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)

/*
 * Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV
 * because these are used for several kinds of pointer values
 */
#define SAVEI16(i)	save_I16(SOFT_CAST(I16*)&(i))
#define SAVEI32(i)	save_I32(SOFT_CAST(I32*)&(i))
#define SAVEINT(i)	save_int(SOFT_CAST(int*)&(i))
#define SAVEIV(i)	save_iv(SOFT_CAST(IV*)&(i))
#define SAVELONG(l)	save_long(SOFT_CAST(long*)&(l))
#define SAVESPTR(s)	save_sptr((SV**)&(s))
#define SAVEPPTR(s)	save_pptr(SOFT_CAST(char**)&(s))
#define SAVEFREESV(s)	save_freesv((SV*)(s))
#define SAVEFREEOP(o)	save_freeop(SOFT_CAST(OP*)(o))
#define SAVEFREEPV(p)	save_freepv(SOFT_CAST(char*)(p))
#define SAVECLEARSV(sv)	save_clearsv(SOFT_CAST(SV**)&(sv))
#define SAVEGENERICSV(s)	save_generic_svref((SV**)&(s))
#define SAVEDELETE(h,k,l) \
	  save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
#ifdef PERL_OBJECT
#define CALLDESTRUCTOR this->*SSPOPDPTR
#define SAVEDESTRUCTOR(f,p) \
	  save_destructor((DESTRUCTORFUNC)(FUNC_NAME_TO_PTR(f)),	\
			  SOFT_CAST(void*)(p))
#else
#define CALLDESTRUCTOR *SSPOPDPTR
#define SAVEDESTRUCTOR(f,p) \
	  save_destructor(SOFT_CAST(void(*)_((void*)))(FUNC_NAME_TO_PTR(f)), \
			  SOFT_CAST(void*)(p))
#endif

#define SAVESTACK_POS() \
    STMT_START {				\
	SSCHECK(2);				\
	SSPUSHINT(PL_stack_sp - PL_stack_base);	\
	SSPUSHINT(SAVEt_STACK_POS);		\
    } STMT_END

#define SAVEOP()	save_op()

#define SAVEHINTS() \
    STMT_START {				\
	if (PL_hints & HINT_LOCALIZE_HH)	\
	    save_hints();			\
	else {					\
	    SSCHECK(2);				\
	    SSPUSHINT(PL_hints);		\
	    SSPUSHINT(SAVEt_HINTS);		\
	}					\
    } STMT_END

/* 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 therough 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)             save_alloc(size, 0)
#define SSNEWa(size,align)	save_alloc(size, \
    (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)

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

/* A jmpenv packages the state required to perform a proper non-local jump.
 * Note that there is a start_env initialized when perl starts, and top_env
 * points to this initially, so top_env should always be non-null.
 *
 * Existence of a non-null top_env->je_prev implies it is valid to call
 * longjmp() at that runlevel (we make sure start_env.je_prev is always
 * null to ensure this).
 *
 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
 * establish a local jmpenv to handle exception traps.  Care must be taken
 * to restore the previous value of je_mustcatch before exiting the
 * stack frame iff JMPENV_PUSH was not called in that stack frame.
 * GSAR 97-03-27
 */

struct jmpenv {
    struct jmpenv *	je_prev;
    Sigjmp_buf		je_buf;		
    int			je_ret;		/* return value of last setjmp() */
    bool		je_mustcatch;	/* longjmp()s must be caught locally */
};

typedef struct jmpenv JMPENV;

#ifdef OP_IN_REGISTER
#define OP_REG_TO_MEM	PL_opsave = op
#define OP_MEM_TO_REG	op = PL_opsave
#else
#define OP_REG_TO_MEM	NOOP
#define OP_MEM_TO_REG	NOOP
#endif

#define dJMPENV		JMPENV cur_env
#define JMPENV_PUSH(v) \
    STMT_START {					\
	cur_env.je_prev = PL_top_env;			\
	OP_REG_TO_MEM;					\
	cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, 1);	\
	OP_MEM_TO_REG;					\
	PL_top_env = &cur_env;				\
	cur_env.je_mustcatch = FALSE;			\
	(v) = cur_env.je_ret;				\
    } STMT_END
#define JMPENV_POP \
    STMT_START { PL_top_env = cur_env.je_prev; } STMT_END
#define JMPENV_JUMP(v) \
    STMT_START {						\
	OP_REG_TO_MEM;						\
	if (PL_top_env->je_prev)					\
	    PerlProc_longjmp(PL_top_env->je_buf, (v));			\
	if ((v) == 2)						\
	    PerlProc_exit(STATUS_NATIVE_EXPORT);				\
	PerlIO_printf(PerlIO_stderr(), "panic: top_env\n");	\
	PerlProc_exit(1);						\
    } STMT_END
   
#define CATCH_GET	(PL_top_env->je_mustcatch)
#define CATCH_SET(v)	(PL_top_env->je_mustcatch = (v))
Commit	Line	Data
b9d12d37	1	#define SAVEt_ITEM 0
	2	#define SAVEt_SV 1
	3	#define SAVEt_AV 2
	4	#define SAVEt_HV 3
	5	#define SAVEt_INT 4
	6	#define SAVEt_LONG 5
	7	#define SAVEt_I32 6
	8	#define SAVEt_IV 7
	9	#define SAVEt_SPTR 8
	10	#define SAVEt_APTR 9
	11	#define SAVEt_HPTR 10
	12	#define SAVEt_PPTR 11
	13	#define SAVEt_NSTAB 12
	14	#define SAVEt_SVREF 13
	15	#define SAVEt_GP 14
	16	#define SAVEt_FREESV 15
	17	#define SAVEt_FREEOP 16
	18	#define SAVEt_FREEPV 17
	19	#define SAVEt_CLEARSV 18
	20	#define SAVEt_DELETE 19
	21	#define SAVEt_DESTRUCTOR 20
	22	#define SAVEt_REGCONTEXT 21
	23	#define SAVEt_STACK_POS 22
	24	#define SAVEt_I16 23
	25	#define SAVEt_AELEM 24
	26	#define SAVEt_HELEM 25
	27	#define SAVEt_OP 26
	28	#define SAVEt_HINTS 27
	29	#define SAVEt_ALLOC 28
	30	#define SAVEt_GENERIC_SVREF 29
79072805	31
3280af22	32	#define SSCHECK(need) if (PL_savestack_ix + need > PL_savestack_max) savestack_grow()
	33	#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
	34	#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
	35	#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
	36	#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
	37	#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
	38	#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
	39	#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
	40	#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
	41	#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
	42	#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
8990e307	43
3280af22	44	#define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
3280af22	45	#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
a0d0e21e	46
f46d017c	47	#ifdef DEBUGGING
	48	#define ENTER \
	49	STMT_START { \
	50	push_scope(); \
f3dc24a5	51	DEBUG_l(WITH_THR(deb("ENTER scope %ld at %s:%d\n", \
3280af22	52	PL_scopestack_ix, __FILE__, __LINE__))); \
f46d017c	53	} STMT_END
	54	#define LEAVE \
	55	STMT_START { \
f3dc24a5	56	DEBUG_l(WITH_THR(deb("LEAVE scope %ld at %s:%d\n", \
3280af22	57	PL_scopestack_ix, __FILE__, __LINE__))); \
f46d017c	58	pop_scope(); \
	59	} STMT_END
	60	#else
a0d0e21e	61	#define ENTER push_scope()
a0d0e21e	62	#define LEAVE pop_scope()
f46d017c	63	#endif
3280af22	64	#define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
a0d0e21e	65
55497cff	66	/*
b9d12d37	67	* Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV
55497cff	68	* because these are used for several kinds of pointer values
55497cff	69	*/
4fdae800	70	#define SAVEI16(i) save_I16(SOFT_CAST(I16*)&(i))
	71	#define SAVEI32(i) save_I32(SOFT_CAST(I32*)&(i))
	72	#define SAVEINT(i) save_int(SOFT_CAST(int*)&(i))
	73	#define SAVEIV(i) save_iv(SOFT_CAST(IV*)&(i))
	74	#define SAVELONG(l) save_long(SOFT_CAST(long*)&(l))
55497cff	75	#define SAVESPTR(s) save_sptr((SV**)&(s))
	76	#define SAVEPPTR(s) save_pptr(SOFT_CAST(char**)&(s))
	77	#define SAVEFREESV(s) save_freesv((SV*)(s))
	78	#define SAVEFREEOP(o) save_freeop(SOFT_CAST(OP*)(o))
	79	#define SAVEFREEPV(p) save_freepv(SOFT_CAST(char*)(p))
	80	#define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv))
b9d12d37	81	#define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
55497cff	82	#define SAVEDELETE(h,k,l) \
55497cff	83	save_delete(SOFT_CAST(HV)(h), SOFT_CAST(char)(k), (I32)(l))
76e3520e	84	#ifdef PERL_OBJECT
565764a8	85	#define CALLDESTRUCTOR this->*SSPOPDPTR
76e3520e	86	#define SAVEDESTRUCTOR(f,p) \
ac4c12e7	87	save_destructor((DESTRUCTORFUNC)(FUNC_NAME_TO_PTR(f)), \
ac4c12e7	88	SOFT_CAST(void*)(p))
76e3520e	89	#else
565764a8	90	#define CALLDESTRUCTOR *SSPOPDPTR
55497cff	91	#define SAVEDESTRUCTOR(f,p) \
ac4c12e7	92	save_destructor(SOFT_CAST(void()_((void)))(FUNC_NAME_TO_PTR(f)), \
ac4c12e7	93	SOFT_CAST(void*)(p))
76e3520e	94	#endif
25eaa213	95
	96	#define SAVESTACK_POS() \
	97	STMT_START { \
	98	SSCHECK(2); \
3280af22	99	SSPUSHINT(PL_stack_sp - PL_stack_base); \
25eaa213	100	SSPUSHINT(SAVEt_STACK_POS); \
	101	} STMT_END
	102
462e5cf6	103	#define SAVEOP() save_op()
25eaa213	104
	105	#define SAVEHINTS() \
	106	STMT_START { \
3280af22	107	if (PL_hints & HINT_LOCALIZE_HH) \
25eaa213	108	save_hints(); \
	109	else { \
	110	SSCHECK(2); \
3280af22	111	SSPUSHINT(PL_hints); \
25eaa213	112	SSPUSHINT(SAVEt_HINTS); \
	113	} \
	114	} STMT_END
a9332b4a	115
455ece5e	116	/* SSNEW() temporarily allocates a specified number of bytes of data on the
	117	* savestack. It returns an integer index into the savestack, because a
	118	* pointer would get broken if the savestack is moved on reallocation.
	119	* SSNEWa() works like SSNEW(), but also aligns the data to the specified
	120	* number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
	121	* alignment will be preserved therough savestack reallocation only if
	122	* realloc returns data aligned to a size divisible by `align'!
	123	*
	124	* SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
	125	*/
	126
	127	#define SSNEW(size) save_alloc(size, 0)
	128	#define SSNEWa(size,align) save_alloc(size, \
	129	(align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
	130
	131	#define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
	132
54310121	133	/* A jmpenv packages the state required to perform a proper non-local jump.
	134	* Note that there is a start_env initialized when perl starts, and top_env
	135	* points to this initially, so top_env should always be non-null.
	136	*
	137	* Existence of a non-null top_env->je_prev implies it is valid to call
6224f72b	138	* longjmp() at that runlevel (we make sure start_env.je_prev is always
6224f72b	139	* null to ensure this).
54310121	140	*
	141	* je_mustcatch, when set at any runlevel to TRUE, means eval ops must
	142	* establish a local jmpenv to handle exception traps. Care must be taken
	143	* to restore the previous value of je_mustcatch before exiting the
	144	* stack frame iff JMPENV_PUSH was not called in that stack frame.
6224f72b	145	* GSAR 97-03-27
54310121	146	*/
	147
	148	struct jmpenv {
	149	struct jmpenv * je_prev;
6224f72b	150	Sigjmp_buf je_buf;
	151	int je_ret; /* return value of last setjmp() */
	152	bool je_mustcatch; /* longjmp()s must be caught locally */
1163b5c4	153	};
1163b5c4	154
6224f72b	155	typedef struct jmpenv JMPENV;
1163b5c4	156
462e5cf6	157	#ifdef OP_IN_REGISTER
6b88bc9c	158	#define OP_REG_TO_MEM PL_opsave = op
6b88bc9c	159	#define OP_MEM_TO_REG op = PL_opsave
462e5cf6	160	#else
	161	#define OP_REG_TO_MEM NOOP
	162	#define OP_MEM_TO_REG NOOP
	163	#endif
	164
6224f72b	165	#define dJMPENV JMPENV cur_env
	166	#define JMPENV_PUSH(v) \
	167	STMT_START { \
3280af22	168	cur_env.je_prev = PL_top_env; \
6224f72b	169	OP_REG_TO_MEM; \
	170	cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, 1); \
	171	OP_MEM_TO_REG; \
3280af22	172	PL_top_env = &cur_env; \
6224f72b	173	cur_env.je_mustcatch = FALSE; \
	174	(v) = cur_env.je_ret; \
	175	} STMT_END
	176	#define JMPENV_POP \
3280af22	177	STMT_START { PL_top_env = cur_env.je_prev; } STMT_END
22921e25	178	#define JMPENV_JUMP(v) \
22921e25	179	STMT_START { \
462e5cf6	180	OP_REG_TO_MEM; \
3280af22	181	if (PL_top_env->je_prev) \
3280af22	182	PerlProc_longjmp(PL_top_env->je_buf, (v)); \
6224f72b	183	if ((v) == 2) \
	184	PerlProc_exit(STATUS_NATIVE_EXPORT); \
	185	PerlIO_printf(PerlIO_stderr(), "panic: top_env\n"); \
	186	PerlProc_exit(1); \
22921e25	187	} STMT_END
54310121	188
3280af22	189	#define CATCH_GET (PL_top_env->je_mustcatch)
3280af22	190	#define CATCH_SET(v) (PL_top_env->je_mustcatch = (v))
6224f72b	191