This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add another NULL check thanks to Coverity.
[perl5.git] / scope.h
CommitLineData
d6376244
JH
1/* scope.h
2 *
4bb101f2 3 * Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999,
1d325971 4 * 2000, 2001, 2002, 2004, 2005 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
c3564e5c 46#define SAVEt_PADSV 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
fc15ae8f 52#define SAVEt_COP_ARYBASE 41
1ade1aa1 53#define SAVEt_RE_STATE 42
72dc9ed5
NC
54#define SAVEt_FREESHAREDPV 43
55#define SAVEt_COP_WARNINGS 44
79072805 56
b03c0a3a 57#ifndef SCOPE_SAVES_SIGNAL_MASK
1b266415 58#define SCOPE_SAVES_SIGNAL_MASK 0
b03c0a3a
NIS
59#endif
60
4b3c1a47
AE
61#define SSCHECK(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow()
62#define SSGROW(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow_cnt(need)
3280af22
NIS
63#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
64#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
9febdf04 65#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
3280af22
NIS
66#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
67#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
68#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
c76ac1ee 69#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
3280af22
NIS
70#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
71#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
9febdf04 72#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
3280af22
NIS
73#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
74#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
75#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
c76ac1ee 76#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
8990e307 77
954c1994 78/*
ccfc67b7
JH
79=head1 Callback Functions
80
954c1994
GS
81=for apidoc Ams||SAVETMPS
82Opening bracket for temporaries on a callback. See C<FREETMPS> and
83L<perlcall>.
84
85=for apidoc Ams||FREETMPS
86Closing bracket for temporaries on a callback. See C<SAVETMPS> and
87L<perlcall>.
88
89=for apidoc Ams||ENTER
90Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
91
92=for apidoc Ams||LEAVE
93Closing bracket on a callback. See C<ENTER> and L<perlcall>.
94
95=cut
96*/
97
3280af22
NIS
98#define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
99#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
a0d0e21e 100
f46d017c
GS
101#ifdef DEBUGGING
102#define ENTER \
103 STMT_START { \
104 push_scope(); \
b4ab917c 105 DEBUG_SCOPE("ENTER") \
f46d017c
GS
106 } STMT_END
107#define LEAVE \
108 STMT_START { \
b4ab917c 109 DEBUG_SCOPE("LEAVE") \
f46d017c
GS
110 pop_scope(); \
111 } STMT_END
112#else
a0d0e21e
LW
113#define ENTER push_scope()
114#define LEAVE pop_scope()
f46d017c 115#endif
3280af22 116#define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
a0d0e21e 117
3f26ef39
NC
118#define SAVEI8(i) save_I8((I8*)&(i))
119#define SAVEI16(i) save_I16((I16*)&(i))
120#define SAVEI32(i) save_I32((I32*)&(i))
121#define SAVEINT(i) save_int((int*)&(i))
122#define SAVEIV(i) save_iv((IV*)&(i))
123#define SAVELONG(l) save_long((long*)&(l))
124#define SAVEBOOL(b) save_bool((bool*)&(b))
55497cff 125#define SAVESPTR(s) save_sptr((SV**)&(s))
3f26ef39 126#define SAVEPPTR(s) save_pptr((char**)&(s))
57b2e452 127#define SAVEVPTR(s) save_vptr((void*)&(s))
c3564e5c 128#define SAVEPADSV(s) save_padsv(s)
55497cff 129#define SAVEFREESV(s) save_freesv((SV*)(s))
26d9b02f 130#define SAVEMORTALIZESV(s) save_mortalizesv((SV*)(s))
3f26ef39
NC
131#define SAVEFREEOP(o) save_freeop((OP*)(o))
132#define SAVEFREEPV(p) save_freepv((char*)(p))
133#define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
b9d12d37 134#define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
f4dd75d9 135#define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
05ec9bb3 136#define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
14f338dc 137#define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
55497cff 138#define SAVEDELETE(h,k,l) \
3f26ef39 139 save_delete((HV*)(h), (char*)(k), (I32)(l))
55497cff 140#define SAVEDESTRUCTOR(f,p) \
3f26ef39 141 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
c76ac1ee
GS
142
143#define SAVEDESTRUCTOR_X(f,p) \
3f26ef39 144 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
25eaa213
GS
145
146#define SAVESTACK_POS() \
147 STMT_START { \
148 SSCHECK(2); \
3280af22 149 SSPUSHINT(PL_stack_sp - PL_stack_base); \
25eaa213
GS
150 SSPUSHINT(SAVEt_STACK_POS); \
151 } STMT_END
152
462e5cf6 153#define SAVEOP() save_op()
25eaa213
GS
154
155#define SAVEHINTS() \
dfa41748 156 STMT_START { \
b3ca2e83 157 SSCHECK(4); \
dfa41748
DM
158 if (PL_hints & HINT_LOCALIZE_HH) { \
159 SSPUSHPTR(GvHV(PL_hintgv)); \
5b9c0671 160 GvHV(PL_hintgv) = Perl_hv_copy_hints_hv(aTHX_ GvHV(PL_hintgv)); \
dfa41748 161 } \
b3ca2e83 162 if (PL_compiling.cop_hints) { \
cbb1fbea 163 HINTS_REFCNT_LOCK; \
b3ca2e83 164 PL_compiling.cop_hints->refcounted_he_refcnt++; \
cbb1fbea 165 HINTS_REFCNT_UNLOCK; \
b3ca2e83
NC
166 } \
167 SSPUSHPTR(PL_compiling.cop_hints); \
dfa41748
DM
168 SSPUSHINT(PL_hints); \
169 SSPUSHINT(SAVEt_HINTS); \
25eaa213 170 } STMT_END
354992b1
GS
171
172#define SAVECOMPPAD() \
173 STMT_START { \
f3548bdc
DM
174 SSCHECK(2); \
175 SSPUSHPTR((SV*)PL_comppad); \
176 SSPUSHINT(SAVEt_COMPPAD); \
354992b1 177 } STMT_END
a9332b4a 178
8b7059b1
DM
179#define SAVESWITCHSTACK(f,t) \
180 STMT_START { \
181 SSCHECK(3); \
182 SSPUSHPTR((SV*)(f)); \
183 SSPUSHPTR((SV*)(t)); \
184 SSPUSHINT(SAVEt_SAVESWITCHSTACK); \
185 SWITCHSTACK((f),(t)); \
186 PL_curstackinfo->si_stack = (t); \
187 } STMT_END
188
fc15ae8f
NC
189#define SAVECOPARYBASE(c) \
190 STMT_START { \
191 SSCHECK(3); \
192 SSPUSHINT(CopARYBASE_get(c)); \
193 SSPUSHPTR(c); \
194 SSPUSHINT(SAVEt_COP_ARYBASE); \
195 } STMT_END
196
72dc9ed5
NC
197#define SAVEFREESHAREDPV(pv) \
198 STMT_START { \
199 SSCHECK(2); \
200 SSPUSHPTR(pv); \
201 SSPUSHINT(SAVEt_FREESHAREDPV); \
202 } STMT_END
203
204/* Need to do the cop warnings like this, rather than SAVEFREESHAREDPV,
205 because realloc() means that the value can actually change. Possibly
206 could have done savefreesharedpvREF, but this way actually seems cleaner,
207 as it simplifies the code that does the saves, and reduces the load on the
208 save stack. */
209#define SAVECOPWARNINGS(c) \
210 STMT_START { \
211 SSCHECK(3); \
212 SSPUSHPTR((c)->cop_warnings); \
213 SSPUSHPTR(c); \
214 SSPUSHINT(SAVEt_COP_WARNINGS); \
215 } STMT_END
fc15ae8f 216
57843af0 217#ifdef USE_ITHREADS
f4dd75d9 218# define SAVECOPSTASH(c) SAVEPPTR(CopSTASHPV(c))
05ec9bb3 219# define SAVECOPSTASH_FREE(c) SAVESHAREDPV(CopSTASHPV(c))
f4dd75d9 220# define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
05ec9bb3 221# define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
57843af0 222#else
f4dd75d9
GS
223# define SAVECOPSTASH(c) SAVESPTR(CopSTASH(c))
224# define SAVECOPSTASH_FREE(c) SAVECOPSTASH(c) /* XXX not refcounted */
225# define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
226# define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
57843af0
GS
227#endif
228
dea28490 229#define SAVECOPLINE(c) SAVEI32(CopLINE(c))
57843af0 230
455ece5e
AD
231/* SSNEW() temporarily allocates a specified number of bytes of data on the
232 * savestack. It returns an integer index into the savestack, because a
233 * pointer would get broken if the savestack is moved on reallocation.
234 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
235 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
236 * alignment will be preserved therough savestack reallocation *only* if
a0288114 237 * realloc returns data aligned to a size divisible by "align"!
455ece5e
AD
238 *
239 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
240 */
241
f2b2c1a7 242#define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
02db2b7b 243#define SSNEWt(n,t) SSNEW((n)*sizeof(t))
f2b2c1a7 244#define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
455ece5e 245 (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
02db2b7b 246#define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
455ece5e 247
02db2b7b
IZ
248#define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
249#define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off))
455ece5e 250