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