Commit | Line | Data |
---|---|---|
a0d0e21e | 1 | /* cop.h |
79072805 | 2 | * |
1129b882 | 3 | * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, |
8622e0e2 | 4 | * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others |
79072805 LW |
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 | * | |
8622e0e2 | 9 | * Control ops (cops) are one of the two ops OP_NEXTSTATE and OP_DBSTATE, |
775e5718 | 10 | * that (loosely speaking) are statement separators. |
3ffa1527 JH |
11 | * They hold information important for lexical state and error reporting. |
12 | * At run time, PL_curcop is set to point to the most recently executed cop, | |
a3985cdc | 13 | * and thus can be used to determine our current state. |
79072805 LW |
14 | */ |
15 | ||
0d2925a6 | 16 | /* A jmpenv packages the state required to perform a proper non-local jump. |
1c98cc53 DM |
17 | * Note that there is a PL_start_env initialized when perl starts, and |
18 | * PL_top_env points to this initially, so PL_top_env should always be | |
19 | * non-null. | |
0d2925a6 | 20 | * |
1c98cc53 DM |
21 | * Existence of a non-null PL_top_env->je_prev implies it is valid to call |
22 | * longjmp() at that runlevel (we make sure PL_start_env.je_prev is always | |
0d2925a6 DM |
23 | * null to ensure this). |
24 | * | |
25 | * je_mustcatch, when set at any runlevel to TRUE, means eval ops must | |
26 | * establish a local jmpenv to handle exception traps. Care must be taken | |
27 | * to restore the previous value of je_mustcatch before exiting the | |
28 | * stack frame iff JMPENV_PUSH was not called in that stack frame. | |
29 | * GSAR 97-03-27 | |
30 | */ | |
31 | ||
32 | struct jmpenv { | |
33 | struct jmpenv * je_prev; | |
caa674f3 | 34 | Sigjmp_buf je_buf; /* uninit if je_prev is NULL */ |
0d2925a6 DM |
35 | int je_ret; /* last exception thrown */ |
36 | bool je_mustcatch; /* need to call longjmp()? */ | |
a68090fe | 37 | U16 je_old_delaymagic; /* saved PL_delaymagic */ |
0d2925a6 DM |
38 | }; |
39 | ||
40 | typedef struct jmpenv JMPENV; | |
41 | ||
0d2925a6 DM |
42 | /* |
43 | * How to build the first jmpenv. | |
44 | * | |
45 | * top_env needs to be non-zero. It points to an area | |
46 | * in which longjmp() stuff is stored, as C callstack | |
47 | * info there at least is thread specific this has to | |
48 | * be per-thread. Otherwise a 'die' in a thread gives | |
49 | * that thread the C stack of last thread to do an eval {}! | |
50 | */ | |
51 | ||
52 | #define JMPENV_BOOTSTRAP \ | |
53 | STMT_START { \ | |
caa674f3 DD |
54 | PERL_POISON_EXPR(PoisonNew(&PL_start_env, 1, JMPENV));\ |
55 | PL_top_env = &PL_start_env; \ | |
56 | PL_start_env.je_prev = NULL; \ | |
0d2925a6 DM |
57 | PL_start_env.je_ret = -1; \ |
58 | PL_start_env.je_mustcatch = TRUE; \ | |
a68090fe | 59 | PL_start_env.je_old_delaymagic = 0; \ |
0d2925a6 DM |
60 | } STMT_END |
61 | ||
62 | /* | |
63 | * PERL_FLEXIBLE_EXCEPTIONS | |
64 | * | |
65 | * All the flexible exceptions code has been removed. | |
66 | * See the following threads for details: | |
67 | * | |
68 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2004-07/msg00378.html | |
69 | * | |
70 | * Joshua's original patches (which weren't applied) and discussion: | |
71 | * | |
72 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01396.html | |
73 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01489.html | |
74 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01491.html | |
75 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01608.html | |
76 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02144.html | |
77 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02998.html | |
78 | * | |
79 | * Chip's reworked patch and discussion: | |
80 | * | |
81 | * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html | |
82 | * | |
83 | * The flaw in these patches (which went unnoticed at the time) was | |
84 | * that they moved some code that could potentially die() out of the | |
85 | * region protected by the setjmp()s. This caused exceptions within | |
86 | * END blocks and such to not be handled by the correct setjmp(). | |
87 | * | |
88 | * The original patches that introduces flexible exceptions were: | |
89 | * | |
ff7e9008 MS |
90 | * http://perl5.git.perl.org/perl.git/commit/312caa8e97f1c7ee342a9895c2f0e749625b4929 |
91 | * http://perl5.git.perl.org/perl.git/commit/14dd3ad8c9bf82cf09798a22cc89a9862dfd6d1a | |
92 | * | |
0d2925a6 DM |
93 | */ |
94 | ||
95 | #define dJMPENV JMPENV cur_env | |
96 | ||
97 | #define JMPENV_PUSH(v) \ | |
98 | STMT_START { \ | |
1c98cc53 DM |
99 | DEBUG_l({ \ |
100 | int i = 0; JMPENV *p = PL_top_env; \ | |
101 | while (p) { i++; p = p->je_prev; } \ | |
91e35ba1 DM |
102 | Perl_deb(aTHX_ "JUMPENV_PUSH level=%d at %s:%d\n", \ |
103 | i, __FILE__, __LINE__);}) \ | |
0d2925a6 | 104 | cur_env.je_prev = PL_top_env; \ |
0d2925a6 | 105 | cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK); \ |
0d2925a6 DM |
106 | PL_top_env = &cur_env; \ |
107 | cur_env.je_mustcatch = FALSE; \ | |
a68090fe | 108 | cur_env.je_old_delaymagic = PL_delaymagic; \ |
0d2925a6 DM |
109 | (v) = cur_env.je_ret; \ |
110 | } STMT_END | |
111 | ||
112 | #define JMPENV_POP \ | |
113 | STMT_START { \ | |
1c98cc53 DM |
114 | DEBUG_l({ \ |
115 | int i = -1; JMPENV *p = PL_top_env; \ | |
116 | while (p) { i++; p = p->je_prev; } \ | |
91e35ba1 DM |
117 | Perl_deb(aTHX_ "JUMPENV_POP level=%d at %s:%d\n", \ |
118 | i, __FILE__, __LINE__);}) \ | |
d3ab86be | 119 | assert(PL_top_env == &cur_env); \ |
a68090fe | 120 | PL_delaymagic = cur_env.je_old_delaymagic; \ |
0d2925a6 DM |
121 | PL_top_env = cur_env.je_prev; \ |
122 | } STMT_END | |
123 | ||
124 | #define JMPENV_JUMP(v) \ | |
125 | STMT_START { \ | |
1c98cc53 DM |
126 | DEBUG_l({ \ |
127 | int i = -1; JMPENV *p = PL_top_env; \ | |
128 | while (p) { i++; p = p->je_prev; } \ | |
91e35ba1 DM |
129 | Perl_deb(aTHX_ "JUMPENV_JUMP(%d) level=%d at %s:%d\n", \ |
130 | (int)v, i, __FILE__, __LINE__);}) \ | |
0d2925a6 DM |
131 | if (PL_top_env->je_prev) \ |
132 | PerlProc_longjmp(PL_top_env->je_buf, (v)); \ | |
133 | if ((v) == 2) \ | |
37038d91 | 134 | PerlProc_exit(STATUS_EXIT); \ |
5637ef5b | 135 | PerlIO_printf(PerlIO_stderr(), "panic: top_env, v=%d\n", (int)v); \ |
0d2925a6 DM |
136 | PerlProc_exit(1); \ |
137 | } STMT_END | |
138 | ||
139 | #define CATCH_GET (PL_top_env->je_mustcatch) | |
1c98cc53 DM |
140 | #define CATCH_SET(v) \ |
141 | STMT_START { \ | |
142 | DEBUG_l( \ | |
143 | Perl_deb(aTHX_ \ | |
144 | "JUMPLEVEL set catch %d => %d (for %p) at %s:%d\n", \ | |
145 | PL_top_env->je_mustcatch, v, (void*)PL_top_env, \ | |
146 | __FILE__, __LINE__);) \ | |
147 | PL_top_env->je_mustcatch = (v); \ | |
148 | } STMT_END | |
0d2925a6 | 149 | |
20439bc7 Z |
150 | /* |
151 | =head1 COP Hint Hashes | |
152 | */ | |
153 | ||
154 | typedef struct refcounted_he COPHH; | |
155 | ||
156 | #define COPHH_KEY_UTF8 REFCOUNTED_HE_KEY_UTF8 | |
157 | ||
158 | /* | |
ffd08bbf | 159 | =for apidoc Amx|SV *|cophh_fetch_pvn|const COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|U32 flags |
20439bc7 | 160 | |
2d7f6611 KW |
161 | Look up the entry in the cop hints hash C<cophh> with the key specified by |
162 | C<keypv> and C<keylen>. If C<flags> has the C<COPHH_KEY_UTF8> bit set, | |
20439bc7 | 163 | the key octets are interpreted as UTF-8, otherwise they are interpreted |
2d7f6611 | 164 | as Latin-1. C<hash> is a precomputed hash of the key string, or zero if |
20439bc7 Z |
165 | it has not been precomputed. Returns a mortal scalar copy of the value |
166 | associated with the key, or C<&PL_sv_placeholder> if there is no value | |
167 | associated with the key. | |
168 | ||
169 | =cut | |
170 | */ | |
171 | ||
172 | #define cophh_fetch_pvn(cophh, keypv, keylen, hash, flags) \ | |
173 | Perl_refcounted_he_fetch_pvn(aTHX_ cophh, keypv, keylen, hash, flags) | |
174 | ||
175 | /* | |
ffd08bbf | 176 | =for apidoc Amx|SV *|cophh_fetch_pvs|const COPHH *cophh|const char *key|U32 flags |
20439bc7 | 177 | |
0c395ea5 KW |
178 | Like L</cophh_fetch_pvn>, but takes a C<NUL>-terminated literal string instead |
179 | of a string/length pair, and no precomputed hash. | |
20439bc7 Z |
180 | |
181 | =cut | |
182 | */ | |
183 | ||
184 | #define cophh_fetch_pvs(cophh, key, flags) \ | |
185 | Perl_refcounted_he_fetch_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, flags) | |
186 | ||
187 | /* | |
ffd08bbf | 188 | =for apidoc Amx|SV *|cophh_fetch_pv|const COPHH *cophh|const char *key|U32 hash|U32 flags |
20439bc7 Z |
189 | |
190 | Like L</cophh_fetch_pvn>, but takes a nul-terminated string instead of | |
191 | a string/length pair. | |
192 | ||
193 | =cut | |
194 | */ | |
195 | ||
196 | #define cophh_fetch_pv(cophh, key, hash, flags) \ | |
197 | Perl_refcounted_he_fetch_pv(aTHX_ cophh, key, hash, flags) | |
198 | ||
199 | /* | |
ffd08bbf | 200 | =for apidoc Amx|SV *|cophh_fetch_sv|const COPHH *cophh|SV *key|U32 hash|U32 flags |
20439bc7 Z |
201 | |
202 | Like L</cophh_fetch_pvn>, but takes a Perl scalar instead of a | |
203 | string/length pair. | |
204 | ||
205 | =cut | |
206 | */ | |
207 | ||
208 | #define cophh_fetch_sv(cophh, key, hash, flags) \ | |
209 | Perl_refcounted_he_fetch_sv(aTHX_ cophh, key, hash, flags) | |
210 | ||
211 | /* | |
ffd08bbf | 212 | =for apidoc Amx|HV *|cophh_2hv|const COPHH *cophh|U32 flags |
20439bc7 Z |
213 | |
214 | Generates and returns a standard Perl hash representing the full set of | |
2d7f6611 | 215 | key/value pairs in the cop hints hash C<cophh>. C<flags> is currently |
20439bc7 Z |
216 | unused and must be zero. |
217 | ||
218 | =cut | |
219 | */ | |
220 | ||
221 | #define cophh_2hv(cophh, flags) \ | |
222 | Perl_refcounted_he_chain_2hv(aTHX_ cophh, flags) | |
223 | ||
224 | /* | |
ffd08bbf | 225 | =for apidoc Amx|COPHH *|cophh_copy|COPHH *cophh |
20439bc7 | 226 | |
2d7f6611 | 227 | Make and return a complete copy of the cop hints hash C<cophh>. |
20439bc7 Z |
228 | |
229 | =cut | |
230 | */ | |
231 | ||
232 | #define cophh_copy(cophh) Perl_refcounted_he_inc(aTHX_ cophh) | |
233 | ||
234 | /* | |
ffd08bbf | 235 | =for apidoc Amx|void|cophh_free|COPHH *cophh |
20439bc7 | 236 | |
2d7f6611 | 237 | Discard the cop hints hash C<cophh>, freeing all resources associated |
20439bc7 Z |
238 | with it. |
239 | ||
240 | =cut | |
241 | */ | |
242 | ||
243 | #define cophh_free(cophh) Perl_refcounted_he_free(aTHX_ cophh) | |
244 | ||
245 | /* | |
ffd08bbf | 246 | =for apidoc Amx|COPHH *|cophh_new_empty |
20439bc7 Z |
247 | |
248 | Generate and return a fresh cop hints hash containing no entries. | |
249 | ||
250 | =cut | |
251 | */ | |
252 | ||
253 | #define cophh_new_empty() ((COPHH *)NULL) | |
254 | ||
255 | /* | |
ffd08bbf | 256 | =for apidoc Amx|COPHH *|cophh_store_pvn|COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|SV *value|U32 flags |
20439bc7 | 257 | |
2d7f6611 | 258 | Stores a value, associated with a key, in the cop hints hash C<cophh>, |
20439bc7 Z |
259 | and returns the modified hash. The returned hash pointer is in general |
260 | not the same as the hash pointer that was passed in. The input hash is | |
261 | consumed by the function, and the pointer to it must not be subsequently | |
262 | used. Use L</cophh_copy> if you need both hashes. | |
263 | ||
2d7f6611 | 264 | The key is specified by C<keypv> and C<keylen>. If C<flags> has the |
20439bc7 | 265 | C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8, |
2d7f6611 | 266 | otherwise they are interpreted as Latin-1. C<hash> is a precomputed |
20439bc7 Z |
267 | hash of the key string, or zero if it has not been precomputed. |
268 | ||
2d7f6611 | 269 | C<value> is the scalar value to store for this key. C<value> is copied |
20439bc7 Z |
270 | by this function, which thus does not take ownership of any reference |
271 | to it, and later changes to the scalar will not be reflected in the | |
272 | value visible in the cop hints hash. Complex types of scalar will not | |
273 | be stored with referential integrity, but will be coerced to strings. | |
274 | ||
275 | =cut | |
276 | */ | |
277 | ||
278 | #define cophh_store_pvn(cophh, keypv, keylen, hash, value, flags) \ | |
279 | Perl_refcounted_he_new_pvn(aTHX_ cophh, keypv, keylen, hash, value, flags) | |
280 | ||
281 | /* | |
ffd08bbf | 282 | =for apidoc Amx|COPHH *|cophh_store_pvs|const COPHH *cophh|const char *key|SV *value|U32 flags |
20439bc7 | 283 | |
0c395ea5 KW |
284 | Like L</cophh_store_pvn>, but takes a C<NUL>-terminated literal string instead |
285 | of a string/length pair, and no precomputed hash. | |
20439bc7 Z |
286 | |
287 | =cut | |
288 | */ | |
289 | ||
290 | #define cophh_store_pvs(cophh, key, value, flags) \ | |
291 | Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, value, flags) | |
292 | ||
293 | /* | |
ffd08bbf | 294 | =for apidoc Amx|COPHH *|cophh_store_pv|const COPHH *cophh|const char *key|U32 hash|SV *value|U32 flags |
20439bc7 Z |
295 | |
296 | Like L</cophh_store_pvn>, but takes a nul-terminated string instead of | |
297 | a string/length pair. | |
298 | ||
299 | =cut | |
300 | */ | |
301 | ||
302 | #define cophh_store_pv(cophh, key, hash, value, flags) \ | |
303 | Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, value, flags) | |
304 | ||
305 | /* | |
ffd08bbf | 306 | =for apidoc Amx|COPHH *|cophh_store_sv|const COPHH *cophh|SV *key|U32 hash|SV *value|U32 flags |
20439bc7 Z |
307 | |
308 | Like L</cophh_store_pvn>, but takes a Perl scalar instead of a | |
309 | string/length pair. | |
310 | ||
311 | =cut | |
312 | */ | |
313 | ||
314 | #define cophh_store_sv(cophh, key, hash, value, flags) \ | |
315 | Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, value, flags) | |
316 | ||
317 | /* | |
ffd08bbf | 318 | =for apidoc Amx|COPHH *|cophh_delete_pvn|COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|U32 flags |
20439bc7 | 319 | |
2d7f6611 | 320 | Delete a key and its associated value from the cop hints hash C<cophh>, |
20439bc7 Z |
321 | and returns the modified hash. The returned hash pointer is in general |
322 | not the same as the hash pointer that was passed in. The input hash is | |
323 | consumed by the function, and the pointer to it must not be subsequently | |
324 | used. Use L</cophh_copy> if you need both hashes. | |
325 | ||
2d7f6611 | 326 | The key is specified by C<keypv> and C<keylen>. If C<flags> has the |
20439bc7 | 327 | C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8, |
2d7f6611 | 328 | otherwise they are interpreted as Latin-1. C<hash> is a precomputed |
20439bc7 Z |
329 | hash of the key string, or zero if it has not been precomputed. |
330 | ||
331 | =cut | |
332 | */ | |
333 | ||
334 | #define cophh_delete_pvn(cophh, keypv, keylen, hash, flags) \ | |
335 | Perl_refcounted_he_new_pvn(aTHX_ cophh, keypv, keylen, hash, \ | |
336 | (SV *)NULL, flags) | |
337 | ||
338 | /* | |
ffd08bbf | 339 | =for apidoc Amx|COPHH *|cophh_delete_pvs|const COPHH *cophh|const char *key|U32 flags |
20439bc7 | 340 | |
0c395ea5 KW |
341 | Like L</cophh_delete_pvn>, but takes a C<NUL>-terminated literal string instead |
342 | of a string/length pair, and no precomputed hash. | |
20439bc7 Z |
343 | |
344 | =cut | |
345 | */ | |
346 | ||
347 | #define cophh_delete_pvs(cophh, key, flags) \ | |
348 | Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, \ | |
349 | (SV *)NULL, flags) | |
350 | ||
351 | /* | |
ffd08bbf | 352 | =for apidoc Amx|COPHH *|cophh_delete_pv|const COPHH *cophh|const char *key|U32 hash|U32 flags |
20439bc7 Z |
353 | |
354 | Like L</cophh_delete_pvn>, but takes a nul-terminated string instead of | |
355 | a string/length pair. | |
356 | ||
357 | =cut | |
358 | */ | |
359 | ||
360 | #define cophh_delete_pv(cophh, key, hash, flags) \ | |
361 | Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, (SV *)NULL, flags) | |
362 | ||
363 | /* | |
ffd08bbf | 364 | =for apidoc Amx|COPHH *|cophh_delete_sv|const COPHH *cophh|SV *key|U32 hash|U32 flags |
20439bc7 Z |
365 | |
366 | Like L</cophh_delete_pvn>, but takes a Perl scalar instead of a | |
367 | string/length pair. | |
368 | ||
369 | =cut | |
370 | */ | |
371 | ||
372 | #define cophh_delete_sv(cophh, key, hash, flags) \ | |
373 | Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, (SV *)NULL, flags) | |
0d2925a6 | 374 | |
5ac1e9b2 | 375 | #include "mydtrace.h" |
0d2925a6 | 376 | |
88df5f01 FC |
377 | struct cop { |
378 | BASEOP | |
379 | /* On LP64 putting this here takes advantage of the fact that BASEOP isn't | |
380 | an exact multiple of 8 bytes to save structure padding. */ | |
381 | line_t cop_line; /* line # of this command */ | |
382 | /* label for this construct is now stored in cop_hints_hash */ | |
57843af0 | 383 | #ifdef USE_ITHREADS |
88df5f01 FC |
384 | PADOFFSET cop_stashoff; /* offset into PL_stashpad, for the |
385 | package the line was compiled in */ | |
1dc74fdb | 386 | char * cop_file; /* file name the following line # is from */ |
57843af0 | 387 | #else |
88df5f01 | 388 | HV * cop_stash; /* package line was compiled in */ |
79072805 | 389 | GV * cop_filegv; /* file the following line # is from */ |
57843af0 | 390 | #endif |
88df5f01 FC |
391 | U32 cop_hints; /* hints bits from pragmata */ |
392 | U32 cop_seq; /* parse sequence number */ | |
393 | /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *: */ | |
394 | STRLEN * cop_warnings; /* lexical warnings bitmask */ | |
395 | /* compile time state of %^H. See the comment in op.c for how this is | |
396 | used to recreate a hash to return from caller. */ | |
20439bc7 | 397 | COPHH * cop_hints_hash; |
79072805 LW |
398 | }; |
399 | ||
57843af0 | 400 | #ifdef USE_ITHREADS |
1dc74fdb FC |
401 | # define CopFILE(c) ((c)->cop_file) |
402 | # define CopFILEGV(c) (CopFILE(c) \ | |
403 | ? gv_fetchfile(CopFILE(c)) : NULL) | |
404 | ||
405 | # ifdef NETWARE | |
406 | # define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv)) | |
d166b3ad | 407 | # define CopFILE_setn(c,pv,l) ((c)->cop_file = savepvn((pv),(l))) |
1dc74fdb FC |
408 | # else |
409 | # define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv)) | |
410 | # define CopFILE_setn(c,pv,l) ((c)->cop_file = savesharedpvn((pv),(l))) | |
411 | # endif | |
412 | ||
413 | # define CopFILESV(c) (CopFILE(c) \ | |
414 | ? GvSV(gv_fetchfile(CopFILE(c))) : NULL) | |
415 | # define CopFILEAV(c) (CopFILE(c) \ | |
416 | ? GvAV(gv_fetchfile(CopFILE(c))) : NULL) | |
417 | # define CopFILEAVx(c) (assert_(CopFILE(c)) \ | |
418 | GvAV(gv_fetchfile(CopFILE(c)))) | |
083fcd59 | 419 | |
d4d03940 FC |
420 | # define CopSTASH(c) PL_stashpad[(c)->cop_stashoff] |
421 | # define CopSTASH_set(c,hv) ((c)->cop_stashoff = (hv) \ | |
422 | ? alloccopstash(hv) \ | |
423 | : 0) | |
1dc74fdb FC |
424 | # ifdef NETWARE |
425 | # define CopFILE_free(c) SAVECOPFILE_FREE(c) | |
426 | # else | |
427 | # define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL)) | |
428 | # endif | |
57843af0 GS |
429 | #else |
430 | # define CopFILEGV(c) ((c)->cop_filegv) | |
f4dd75d9 | 431 | # define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv)) |
1dc74fdb FC |
432 | # define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv)) |
433 | # define CopFILE_setn(c,pv,l) CopFILEGV_set((c), gv_fetchfile_flags((pv),(l),0)) | |
434 | # define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL) | |
435 | # define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL) | |
436 | # ifdef DEBUGGING | |
437 | # define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c))) | |
438 | # else | |
439 | # define CopFILEAVx(c) (GvAV(CopFILEGV(c))) | |
440 | # endif | |
441 | # define CopFILE(c) (CopFILEGV(c) \ | |
442 | ? GvNAME(CopFILEGV(c))+2 : NULL) | |
57843af0 | 443 | # define CopSTASH(c) ((c)->cop_stash) |
f4dd75d9 | 444 | # define CopSTASH_set(c,hv) ((c)->cop_stash = (hv)) |
a0714e2c | 445 | # define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL)) |
05ec9bb3 | 446 | |
57843af0 | 447 | #endif /* USE_ITHREADS */ |
20439bc7 | 448 | |
d4d03940 FC |
449 | #define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL) |
450 | /* cop_stash is not refcounted */ | |
451 | #define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD)) | |
452 | #define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv)) | |
d4d03940 | 453 | |
20439bc7 Z |
454 | #define CopHINTHASH_get(c) ((COPHH*)((c)->cop_hints_hash)) |
455 | #define CopHINTHASH_set(c,h) ((c)->cop_hints_hash = (h)) | |
456 | ||
457 | /* | |
458 | =head1 COP Hint Reading | |
459 | */ | |
460 | ||
461 | /* | |
462 | =for apidoc Am|SV *|cop_hints_fetch_pvn|const COP *cop|const char *keypv|STRLEN keylen|U32 hash|U32 flags | |
463 | ||
2d7f6611 KW |
464 | Look up the hint entry in the cop C<cop> with the key specified by |
465 | C<keypv> and C<keylen>. If C<flags> has the C<COPHH_KEY_UTF8> bit set, | |
20439bc7 | 466 | the key octets are interpreted as UTF-8, otherwise they are interpreted |
2d7f6611 | 467 | as Latin-1. C<hash> is a precomputed hash of the key string, or zero if |
20439bc7 Z |
468 | it has not been precomputed. Returns a mortal scalar copy of the value |
469 | associated with the key, or C<&PL_sv_placeholder> if there is no value | |
470 | associated with the key. | |
471 | ||
472 | =cut | |
473 | */ | |
474 | ||
475 | #define cop_hints_fetch_pvn(cop, keypv, keylen, hash, flags) \ | |
476 | cophh_fetch_pvn(CopHINTHASH_get(cop), keypv, keylen, hash, flags) | |
477 | ||
478 | /* | |
479 | =for apidoc Am|SV *|cop_hints_fetch_pvs|const COP *cop|const char *key|U32 flags | |
480 | ||
0c395ea5 KW |
481 | Like L</cop_hints_fetch_pvn>, but takes a C<NUL>-terminated literal string |
482 | instead of a string/length pair, and no precomputed hash. | |
20439bc7 Z |
483 | |
484 | =cut | |
485 | */ | |
486 | ||
487 | #define cop_hints_fetch_pvs(cop, key, flags) \ | |
488 | cophh_fetch_pvs(CopHINTHASH_get(cop), key, flags) | |
489 | ||
490 | /* | |
491 | =for apidoc Am|SV *|cop_hints_fetch_pv|const COP *cop|const char *key|U32 hash|U32 flags | |
492 | ||
493 | Like L</cop_hints_fetch_pvn>, but takes a nul-terminated string instead | |
494 | of a string/length pair. | |
495 | ||
496 | =cut | |
497 | */ | |
498 | ||
499 | #define cop_hints_fetch_pv(cop, key, hash, flags) \ | |
500 | cophh_fetch_pv(CopHINTHASH_get(cop), key, hash, flags) | |
501 | ||
502 | /* | |
503 | =for apidoc Am|SV *|cop_hints_fetch_sv|const COP *cop|SV *key|U32 hash|U32 flags | |
504 | ||
505 | Like L</cop_hints_fetch_pvn>, but takes a Perl scalar instead of a | |
506 | string/length pair. | |
507 | ||
508 | =cut | |
509 | */ | |
510 | ||
511 | #define cop_hints_fetch_sv(cop, key, hash, flags) \ | |
512 | cophh_fetch_sv(CopHINTHASH_get(cop), key, hash, flags) | |
513 | ||
514 | /* | |
515 | =for apidoc Am|HV *|cop_hints_2hv|const COP *cop|U32 flags | |
516 | ||
517 | Generates and returns a standard Perl hash representing the full set of | |
2d7f6611 | 518 | hint entries in the cop C<cop>. C<flags> is currently unused and must |
20439bc7 Z |
519 | be zero. |
520 | ||
521 | =cut | |
522 | */ | |
523 | ||
524 | #define cop_hints_2hv(cop, flags) \ | |
525 | cophh_2hv(CopHINTHASH_get(cop), flags) | |
526 | ||
aebc0cbe | 527 | #define CopLABEL(c) Perl_cop_fetch_label(aTHX_ (c), NULL, NULL) |
5db1eb8d BF |
528 | #define CopLABEL_len(c,len) Perl_cop_fetch_label(aTHX_ (c), len, NULL) |
529 | #define CopLABEL_len_flags(c,len,flags) Perl_cop_fetch_label(aTHX_ (c), len, flags) | |
dca6062a | 530 | #define CopLABEL_alloc(pv) ((pv)?savepv(pv):NULL) |
57843af0 | 531 | |
ed094faf | 532 | #define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv)) |
cc49e20b | 533 | #define CopLINE(c) ((c)->cop_line) |
57843af0 GS |
534 | #define CopLINE_inc(c) (++CopLINE(c)) |
535 | #define CopLINE_dec(c) (--CopLINE(c)) | |
536 | #define CopLINE_set(c,l) (CopLINE(c) = (l)) | |
cc49e20b | 537 | |
248c2a4d | 538 | /* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */ |
e37778c2 | 539 | #define OutCopFILE(c) CopFILE(c) |
248c2a4d | 540 | |
d5ec2987 | 541 | #define CopHINTS_get(c) ((c)->cop_hints + 0) |
623e6609 | 542 | #define CopHINTS_set(c, h) STMT_START { \ |
d5ec2987 | 543 | (c)->cop_hints = (h); \ |
623e6609 NC |
544 | } STMT_END |
545 | ||
79072805 LW |
546 | /* |
547 | * Here we have some enormously heavy (or at least ponderous) wizardry. | |
548 | */ | |
549 | ||
550 | /* subroutine context */ | |
551 | struct block_sub { | |
f9c764c5 | 552 | OP * retop; /* op to execute on exit from sub */ |
adcbf118 | 553 | /* Above here is the same for sub, format and eval. */ |
9aa350eb | 554 | PAD *prevcomppad; /* the caller's PL_comppad */ |
8e663997 | 555 | CV * cv; |
f9c764c5 | 556 | /* Above here is the same for sub and format. */ |
bb172083 | 557 | I32 olddepth; |
3073d04f | 558 | AV *savearray; |
f9c764c5 NC |
559 | }; |
560 | ||
561 | ||
562 | /* format context */ | |
563 | struct block_format { | |
f39bc417 | 564 | OP * retop; /* op to execute on exit from sub */ |
adcbf118 | 565 | /* Above here is the same for sub, format and eval. */ |
9aa350eb | 566 | PAD *prevcomppad; /* the caller's PL_comppad */ |
8e663997 | 567 | CV * cv; |
f9c764c5 NC |
568 | /* Above here is the same for sub and format. */ |
569 | GV * gv; | |
570 | GV * dfoutgv; | |
79072805 LW |
571 | }; |
572 | ||
4ebe6e95 DM |
573 | /* return a pointer to the current context */ |
574 | ||
575 | #define CX_CUR() (&cxstack[cxstack_ix]) | |
576 | ||
dfe0f39b DM |
577 | /* free all savestack items back to the watermark of the specified context */ |
578 | ||
e992140c | 579 | #define CX_LEAVE_SCOPE(cx) LEAVE_SCOPE(cx->blk_oldsaveix) |
dfe0f39b | 580 | |
5da525e9 DM |
581 | #ifdef DEBUGGING |
582 | /* on debugging builds, poison cx afterwards so we know no code | |
583 | * uses it - because after doing cxstack_ix--, any ties, exceptions etc | |
584 | * may overwrite the current stack frame */ | |
585 | # define CX_POP(cx) \ | |
4ebe6e95 | 586 | assert(CX_CUR() == cx); \ |
5da525e9 DM |
587 | cxstack_ix--; \ |
588 | cx = NULL; | |
589 | #else | |
590 | # define CX_POP(cx) cxstack_ix--; | |
591 | #endif | |
592 | ||
593 | ||
b36bdeca | 594 | /* base for the next two macros. Don't use directly. |
d6911e1b DM |
595 | * The context frame holds a reference to the CV so that it can't be |
596 | * freed while we're executing it */ | |
b36bdeca | 597 | |
b36bdeca | 598 | |
490576d1 | 599 | #define CX_PUSHSUB_GET_LVALUE_MASK(func) \ |
777d9014 FC |
600 | /* If the context is indeterminate, then only the lvalue */ \ |
601 | /* flags that the caller also has are applicable. */ \ | |
4587c532 | 602 | ( \ |
777d9014 FC |
603 | (PL_op->op_flags & OPf_WANT) \ |
604 | ? OPpENTERSUB_LVAL_MASK \ | |
605 | : !(PL_op->op_private & OPpENTERSUB_LVAL_MASK) \ | |
4587c532 FC |
606 | ? 0 : (U8)func(aTHX) \ |
607 | ) | |
608 | ||
fad386cb | 609 | /* Restore old @_ */ |
b405d38b | 610 | #define CX_POP_SAVEARRAY(cx) \ |
6d4ff0d2 | 611 | STMT_START { \ |
f2b9631d | 612 | AV *cx_pop_savearray_av = GvAV(PL_defgv); \ |
a8bba7fa | 613 | GvAV(PL_defgv) = cx->blk_sub.savearray; \ |
656457d0 | 614 | cx->blk_sub.savearray = NULL; \ |
f2b9631d | 615 | SvREFCNT_dec(cx_pop_savearray_av); \ |
6d4ff0d2 | 616 | } STMT_END |
6d4ff0d2 | 617 | |
ecf8e9dd | 618 | /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't |
8e09340b GS |
619 | * leave any (a fast av_clear(ary), basically) */ |
620 | #define CLEAR_ARGARRAY(ary) \ | |
621 | STMT_START { \ | |
622 | AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \ | |
9c6bc640 | 623 | AvARRAY(ary) = AvALLOC(ary); \ |
8e09340b GS |
624 | AvFILLp(ary) = -1; \ |
625 | } STMT_END | |
7766f137 | 626 | |
7e27c4a5 | 627 | |
79072805 LW |
628 | /* eval context */ |
629 | struct block_eval { | |
8e663997 NC |
630 | OP * retop; /* op to execute on exit from eval */ |
631 | /* Above here is the same for sub, format and eval. */ | |
0f79a09d | 632 | SV * old_namesv; |
79072805 | 633 | OP * old_eval_root; |
748a9306 | 634 | SV * cur_text; |
2090ab20 | 635 | CV * cv; |
abd70938 | 636 | JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */ |
79072805 LW |
637 | }; |
638 | ||
17347a51 NC |
639 | /* If we ever need more than 512 op types, change the shift from 7. |
640 | blku_gimme is actually also only 2 bits, so could be merged with something. | |
641 | */ | |
642 | ||
4c57ced5 DM |
643 | /* blk_u16 bit usage for eval contexts: */ |
644 | ||
645 | #define CxOLD_IN_EVAL(cx) (((cx)->blk_u16) & 0x3F) /* saved PL in_eval */ | |
646 | #define CxEVAL_TXT_REFCNTED(cx) (((cx)->blk_u16) & 0x40) /* cur_text rc++ */ | |
647 | #define CxOLD_OP_TYPE(cx) (((cx)->blk_u16) >> 7) /* type of eval op */ | |
85a64632 | 648 | |
79072805 LW |
649 | /* loop context */ |
650 | struct block_loop { | |
022eaa24 | 651 | LOOP * my_op; /* My op, that contains redo, next and last ops. */ |
df530c37 | 652 | union { /* different ways of locating the iteration variable */ |
b52de964 DM |
653 | SV **svp; /* for lexicals: address of pad slot */ |
654 | GV *gv; /* for package vars */ | |
df530c37 | 655 | } itervar_u; |
f0bb9bf7 | 656 | SV *itersave; /* the original iteration var */ |
493b0a3c | 657 | union { |
93661e56 DM |
658 | struct { /* CXt_LOOP_ARY, C<for (@ary)> */ |
659 | AV *ary; /* array being iterated over */ | |
660 | IV ix; /* index relative to base of array */ | |
d01136d6 | 661 | } ary; |
93661e56 DM |
662 | struct { /* CXt_LOOP_LIST, C<for (list)> */ |
663 | I32 basesp; /* first element of list on stack */ | |
664 | IV ix; /* index relative to basesp */ | |
665 | } stack; | |
666 | struct { /* CXt_LOOP_LAZYIV, C<for (1..9)> */ | |
d01136d6 BS |
667 | IV cur; |
668 | IV end; | |
669 | } lazyiv; | |
93661e56 | 670 | struct { /* CXt_LOOP_LAZYSV C<for ('a'..'z')> */ |
d01136d6 BS |
671 | SV * cur; |
672 | SV * end; /* maxiumum value (or minimum in reverse) */ | |
673 | } lazysv; | |
674 | } state_u; | |
7766f137 | 675 | #ifdef USE_ITHREADS |
b52de964 | 676 | PAD *oldcomppad; /* needed to map itervar_u.svp during thread clone */ |
f83b46a0 | 677 | #endif |
b52de964 | 678 | }; |
f83b46a0 | 679 | |
9af0df0b DM |
680 | #define CxITERVAR(c) \ |
681 | (CxPADLOOP(c) \ | |
682 | ? (c)->blk_loop.itervar_u.svp \ | |
683 | : ((c)->cx_type & CXp_FOR_GV) \ | |
684 | ? &GvSV((c)->blk_loop.itervar_u.gv) \ | |
685 | : (SV **)&(c)->blk_loop.itervar_u.gv) | |
f83b46a0 | 686 | |
b1cf8b36 | 687 | #define CxLABEL(c) (0 + CopLABEL((c)->blk_oldcop)) |
5db1eb8d BF |
688 | #define CxLABEL_len(c,len) (0 + CopLABEL_len((c)->blk_oldcop, len)) |
689 | #define CxLABEL_len_flags(c,len,flags) (0 + CopLABEL_len_flags((c)->blk_oldcop, len, flags)) | |
ae423868 | 690 | #define CxHASARGS(c) (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS) |
d9203e03 DM |
691 | |
692 | /* CxLVAL(): the lval flags of the call site: the relevant flag bits from | |
693 | * the op_private field of the calling pp_entersub (or its caller's caller | |
694 | * if the caller's lvalue context isn't known): | |
695 | * OPpLVAL_INTRO: sub used in lvalue context, e.g. f() = 1; | |
696 | * OPpENTERSUB_INARGS (in conjunction with OPpLVAL_INTRO): the | |
697 | * function is being used as a sub arg or as a referent, e.g. | |
698 | * g(...,f(),...) or $r = \f() | |
699 | * OPpDEREF: 2-bit mask indicating e.g. f()->[0]. | |
700 | * Note the contrast with CvLVALUE(), which is a property of the sub | |
701 | * rather than the call site. | |
702 | */ | |
1956db7e | 703 | #define CxLVAL(c) (0 + ((c)->blk_u16 & 0xff)) |
1956db7e | 704 | |
7766f137 | 705 | |
79072805 | 706 | |
0d863452 RH |
707 | /* given/when context */ |
708 | struct block_givwhen { | |
709 | OP *leave_op; | |
b95eccd3 | 710 | SV *defsv_save; /* the original $_ */ |
0d863452 RH |
711 | }; |
712 | ||
0d863452 | 713 | |
c5369ccc | 714 | |
79072805 LW |
715 | /* context common to subroutines, evals and loops */ |
716 | struct block { | |
446d0787 | 717 | U8 blku_type; /* what kind of context this is */ |
2e0df0e8 | 718 | U8 blku_gimme; /* is this block running in list context? */ |
17347a51 | 719 | U16 blku_u16; /* used by block_sub and block_eval (so far) */ |
e992140c DM |
720 | I32 blku_oldsaveix; /* saved PL_savestack_ix */ |
721 | /* all the fields above must be aligned with same-sized fields as sbu */ | |
1bef65a2 | 722 | I32 blku_oldsp; /* current sp floor: where nextstate pops to */ |
79072805 | 723 | I32 blku_oldmarksp; /* mark stack index */ |
f284fecd | 724 | COP * blku_oldcop; /* old curcop pointer */ |
79072805 | 725 | PMOP * blku_oldpm; /* values of pattern match vars */ |
bb3300d1 | 726 | SSize_t blku_old_tmpsfloor; /* saved PL_tmps_floor */ |
f284fecd | 727 | I32 blku_oldscopesp; /* scope stack index */ |
79072805 LW |
728 | |
729 | union { | |
730 | struct block_sub blku_sub; | |
f9c764c5 | 731 | struct block_format blku_format; |
79072805 LW |
732 | struct block_eval blku_eval; |
733 | struct block_loop blku_loop; | |
0d863452 | 734 | struct block_givwhen blku_givwhen; |
79072805 LW |
735 | } blk_u; |
736 | }; | |
737 | #define blk_oldsp cx_u.cx_blk.blku_oldsp | |
738 | #define blk_oldcop cx_u.cx_blk.blku_oldcop | |
79072805 LW |
739 | #define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp |
740 | #define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp | |
741 | #define blk_oldpm cx_u.cx_blk.blku_oldpm | |
742 | #define blk_gimme cx_u.cx_blk.blku_gimme | |
446d0787 | 743 | #define blk_u16 cx_u.cx_blk.blku_u16 |
e992140c | 744 | #define blk_oldsaveix cx_u.cx_blk.blku_oldsaveix |
ce8bb8d8 | 745 | #define blk_old_tmpsfloor cx_u.cx_blk.blku_old_tmpsfloor |
79072805 | 746 | #define blk_sub cx_u.cx_blk.blk_u.blku_sub |
f9c764c5 | 747 | #define blk_format cx_u.cx_blk.blk_u.blku_format |
79072805 LW |
748 | #define blk_eval cx_u.cx_blk.blk_u.blku_eval |
749 | #define blk_loop cx_u.cx_blk.blk_u.blku_loop | |
0d863452 | 750 | #define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen |
79072805 | 751 | |
5e691bc6 | 752 | #define CX_DEBUG(cx, action) \ |
d9f81b50 | 753 | DEBUG_l( \ |
bb3300d1 | 754 | Perl_deb(aTHX_ "CX %ld %s %s (scope %ld,%ld) (save %ld,%ld) at %s:%d\n",\ |
1c98cc53 DM |
755 | (long)cxstack_ix, \ |
756 | action, \ | |
5e691bc6 | 757 | PL_block_type[CxTYPE(cx)], \ |
1c98cc53 | 758 | (long)PL_scopestack_ix, \ |
5e691bc6 | 759 | (long)(cx->blk_oldscopesp), \ |
bb3300d1 | 760 | (long)PL_savestack_ix, \ |
5e691bc6 | 761 | (long)(cx->blk_oldsaveix), \ |
d9f81b50 | 762 | __FILE__, __LINE__)); |
1c98cc53 | 763 | |
ed8ff0f3 | 764 | |
79072805 LW |
765 | |
766 | /* substitution context */ | |
767 | struct subst { | |
e992140c | 768 | U8 sbu_type; /* same as blku_type */ |
1ed74d04 | 769 | U8 sbu_rflags; |
e992140c DM |
770 | U16 sbu_rxtainted; |
771 | I32 sbu_oldsaveix; /* same as blku_oldsaveix */ | |
a7f94955 | 772 | /* all the fields above must be aligned with same-sized fields as blk_u */ |
3c6ef0a5 FC |
773 | SSize_t sbu_iters; |
774 | SSize_t sbu_maxiters; | |
79072805 LW |
775 | char * sbu_orig; |
776 | SV * sbu_dstr; | |
777 | SV * sbu_targ; | |
778 | char * sbu_s; | |
779 | char * sbu_m; | |
780 | char * sbu_strend; | |
c90c0ff4 | 781 | void * sbu_rxres; |
c07a80fd | 782 | REGEXP * sbu_rx; |
79072805 LW |
783 | }; |
784 | #define sb_iters cx_u.cx_subst.sbu_iters | |
785 | #define sb_maxiters cx_u.cx_subst.sbu_maxiters | |
22e551b9 | 786 | #define sb_rflags cx_u.cx_subst.sbu_rflags |
71be2cbc | 787 | #define sb_rxtainted cx_u.cx_subst.sbu_rxtainted |
79072805 LW |
788 | #define sb_orig cx_u.cx_subst.sbu_orig |
789 | #define sb_dstr cx_u.cx_subst.sbu_dstr | |
790 | #define sb_targ cx_u.cx_subst.sbu_targ | |
791 | #define sb_s cx_u.cx_subst.sbu_s | |
792 | #define sb_m cx_u.cx_subst.sbu_m | |
793 | #define sb_strend cx_u.cx_subst.sbu_strend | |
c90c0ff4 | 794 | #define sb_rxres cx_u.cx_subst.sbu_rxres |
c07a80fd | 795 | #define sb_rx cx_u.cx_subst.sbu_rx |
79072805 | 796 | |
9c105995 | 797 | #ifdef PERL_CORE |
490576d1 | 798 | # define CX_PUSHSUBST(cx) CXINC, cx = CX_CUR(), \ |
e992140c | 799 | cx->blk_oldsaveix = oldsave, \ |
79072805 LW |
800 | cx->sb_iters = iters, \ |
801 | cx->sb_maxiters = maxiters, \ | |
22e551b9 | 802 | cx->sb_rflags = r_flags, \ |
71be2cbc | 803 | cx->sb_rxtainted = rxtainted, \ |
79072805 LW |
804 | cx->sb_orig = orig, \ |
805 | cx->sb_dstr = dstr, \ | |
806 | cx->sb_targ = targ, \ | |
807 | cx->sb_s = s, \ | |
808 | cx->sb_m = m, \ | |
809 | cx->sb_strend = strend, \ | |
4608196e | 810 | cx->sb_rxres = NULL, \ |
c07a80fd | 811 | cx->sb_rx = rx, \ |
1ed74d04 | 812 | cx->cx_type = CXt_SUBST | (once ? CXp_ONCE : 0); \ |
e22ae1e2 | 813 | rxres_save(&cx->sb_rxres, rx); \ |
cf69025f TC |
814 | (void)ReREFCNT_inc(rx); \ |
815 | SvREFCNT_inc_void_NN(targ) | |
79072805 | 816 | |
b405d38b | 817 | # define CX_POPSUBST(cx) \ |
77189b8c DM |
818 | STMT_START { \ |
819 | REGEXP *re; \ | |
e4592eb4 | 820 | assert(CxTYPE(cx) == CXt_SUBST); \ |
e22ae1e2 | 821 | rxres_free(&cx->sb_rxres); \ |
77189b8c DM |
822 | re = cx->sb_rx; \ |
823 | cx->sb_rx = NULL; \ | |
824 | ReREFCNT_dec(re); \ | |
825 | SvREFCNT_dec_NN(cx->sb_targ); \ | |
826 | } STMT_END | |
9c105995 NC |
827 | #endif |
828 | ||
829 | #define CxONCE(cx) ((cx)->cx_type & CXp_ONCE) | |
79072805 LW |
830 | |
831 | struct context { | |
79072805 LW |
832 | union { |
833 | struct block cx_blk; | |
834 | struct subst cx_subst; | |
835 | } cx_u; | |
836 | }; | |
2e0df0e8 | 837 | #define cx_type cx_u.cx_subst.sbu_type |
6b35e009 | 838 | |
76753e7f NC |
839 | /* If you re-order these, there is also an array of uppercase names in perl.h |
840 | and a static array of context names in pp_ctl.c */ | |
3701055e | 841 | #define CXTYPEMASK 0xf |
79646418 | 842 | #define CXt_NULL 0 /* currently only used for sort BLOCK */ |
76753e7f NC |
843 | #define CXt_WHEN 1 |
844 | #define CXt_BLOCK 2 | |
845 | /* When micro-optimising :-) keep GIVEN next to the LOOPs, as these 5 share a | |
846 | jump table in pp_ctl.c | |
847 | The first 4 don't have a 'case' in at least one switch statement in pp_ctl.c | |
848 | */ | |
849 | #define CXt_GIVEN 3 | |
93661e56 DM |
850 | |
851 | /* be careful of the ordering of these five. Macros like CxTYPE_is_LOOP, | |
852 | * CxFOREACH compare ranges */ | |
c349b9a0 DM |
853 | #define CXt_LOOP_ARY 4 /* for (@ary) { ...; } */ |
854 | #define CXt_LOOP_LAZYSV 5 /* for ('a'..'z') { ...; } */ | |
855 | #define CXt_LOOP_LAZYIV 6 /* for (1..9) { ...; } */ | |
856 | #define CXt_LOOP_LIST 7 /* for (1,2,3) { ...; } */ | |
857 | #define CXt_LOOP_PLAIN 8 /* while (...) { ...; } | |
858 | or plain block { ...; } */ | |
93661e56 DM |
859 | #define CXt_SUB 9 |
860 | #define CXt_FORMAT 10 | |
861 | #define CXt_EVAL 11 | |
862 | #define CXt_SUBST 12 | |
76753e7f | 863 | /* SUBST doesn't feature in all switch statements. */ |
79072805 | 864 | |
ae423868 | 865 | /* private flags for CXt_SUB and CXt_FORMAT */ |
79646418 DM |
866 | #define CXp_MULTICALL 0x10 /* part of a multicall (so don't tear down |
867 | context on exit). (not CXt_FORMAT) */ | |
1f27d788 | 868 | #define CXp_HASARGS 0x20 |
b0065247 DM |
869 | #define CXp_SUB_RE 0x40 /* code called within regex, i.e. (?{}) */ |
870 | #define CXp_SUB_RE_FAKE 0x80 /* fake sub CX for (?{}) in current scope */ | |
ae423868 | 871 | |
6b35e009 | 872 | /* private flags for CXt_EVAL */ |
1f27d788 NC |
873 | #define CXp_REAL 0x20 /* truly eval'', not a lookalike */ |
874 | #define CXp_TRYBLOCK 0x40 /* eval{}, not eval'' or similar */ | |
6b35e009 | 875 | |
7766f137 | 876 | /* private flags for CXt_LOOP */ |
28e0cf42 DM |
877 | |
878 | /* this is only set in conjunction with CXp_FOR_GV */ | |
1f27d788 | 879 | #define CXp_FOR_DEF 0x10 /* foreach using $_ */ |
28e0cf42 | 880 | /* these 3 are mutually exclusive */ |
d39c26a6 | 881 | #define CXp_FOR_LVREF 0x20 /* foreach using \$var */ |
9af0df0b DM |
882 | #define CXp_FOR_GV 0x40 /* foreach using package var */ |
883 | #define CXp_FOR_PAD 0x80 /* foreach using lexical var */ | |
28e0cf42 | 884 | |
9af0df0b | 885 | #define CxPADLOOP(c) ((c)->cx_type & CXp_FOR_PAD) |
e846cb92 | 886 | |
1ed74d04 NC |
887 | /* private flags for CXt_SUBST */ |
888 | #define CXp_ONCE 0x10 /* What was sbu_once in struct subst */ | |
7766f137 | 889 | |
6b35e009 | 890 | #define CxTYPE(c) ((c)->cx_type & CXTYPEMASK) |
113ebcf5 DM |
891 | #define CxTYPE_is_LOOP(c) ( CxTYPE(cx) >= CXt_LOOP_ARY \ |
892 | && CxTYPE(cx) <= CXt_LOOP_PLAIN) | |
79646418 | 893 | #define CxMULTICALL(c) ((c)->cx_type & CXp_MULTICALL) |
0588a150 | 894 | #define CxREALEVAL(c) (((c)->cx_type & (CXTYPEMASK|CXp_REAL)) \ |
7766f137 | 895 | == (CXt_EVAL|CXp_REAL)) |
0588a150 | 896 | #define CxTRYBLOCK(c) (((c)->cx_type & (CXTYPEMASK|CXp_TRYBLOCK)) \ |
1d76a5c3 | 897 | == (CXt_EVAL|CXp_TRYBLOCK)) |
113ebcf5 DM |
898 | #define CxFOREACH(c) ( CxTYPE(cx) >= CXt_LOOP_ARY \ |
899 | && CxTYPE(cx) <= CXt_LOOP_LIST) | |
6b35e009 | 900 | |
109bf713 | 901 | #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc())) |
79072805 | 902 | |
ccfc67b7 JH |
903 | /* |
904 | =head1 "Gimme" Values | |
905 | */ | |
954c1994 GS |
906 | |
907 | /* | |
908 | =for apidoc AmU||G_SCALAR | |
fbe13c60 | 909 | Used to indicate scalar context. See C<L</GIMME_V>>, C<L</GIMME>>, and |
954c1994 GS |
910 | L<perlcall>. |
911 | ||
912 | =for apidoc AmU||G_ARRAY | |
fbe13c60 | 913 | Used to indicate list context. See C<L</GIMME_V>>, C<L</GIMME>> and |
954c1994 GS |
914 | L<perlcall>. |
915 | ||
916 | =for apidoc AmU||G_VOID | |
fbe13c60 | 917 | Used to indicate void context. See C<L</GIMME_V>> and L<perlcall>. |
954c1994 GS |
918 | |
919 | =for apidoc AmU||G_DISCARD | |
920 | Indicates that arguments returned from a callback should be discarded. See | |
921 | L<perlcall>. | |
922 | ||
923 | =for apidoc AmU||G_EVAL | |
924 | ||
925 | Used to force a Perl C<eval> wrapper around a callback. See | |
926 | L<perlcall>. | |
927 | ||
928 | =for apidoc AmU||G_NOARGS | |
929 | ||
930 | Indicates that no arguments are being sent to a callback. See | |
931 | L<perlcall>. | |
932 | ||
933 | =cut | |
934 | */ | |
935 | ||
2f8edad0 NC |
936 | #define G_SCALAR 2 |
937 | #define G_ARRAY 3 | |
938 | #define G_VOID 1 | |
939 | #define G_WANT 3 | |
79072805 | 940 | |
864dbfa3 | 941 | /* extra flags for Perl_call_* routines */ |
2f8edad0 | 942 | #define G_DISCARD 4 /* Call FREETMPS. |
b54b4831 NC |
943 | Don't change this without consulting the |
944 | hash actions codes defined in hv.h */ | |
2f8edad0 NC |
945 | #define G_EVAL 8 /* Assume eval {} around subroutine call. */ |
946 | #define G_NOARGS 16 /* Don't construct a @_ array. */ | |
7ce09284 | 947 | #define G_KEEPERR 32 /* Warn for errors, don't overwrite $@ */ |
2f8edad0 NC |
948 | #define G_NODEBUG 64 /* Disable debugging at toplevel. */ |
949 | #define G_METHOD 128 /* Calling method. */ | |
c40f1585 | 950 | #define G_FAKINGEVAL 256 /* Faking an eval context for call_sv or |
edb2152a | 951 | fold_constants. */ |
67549bd2 NC |
952 | #define G_UNDEF_FILL 512 /* Fill the stack with &PL_sv_undef |
953 | A special case for UNSHIFT in | |
954 | Perl_magic_methcall(). */ | |
d1d7a15d NC |
955 | #define G_WRITING_TO_STDERR 1024 /* Perl_write_to_stderr() is calling |
956 | Perl_magic_methcall(). */ | |
a1941760 | 957 | #define G_RE_REPARSING 0x800 /* compiling a run-time /(?{..})/ */ |
c106c2be | 958 | #define G_METHOD_NAMED 4096 /* calling named method, eg without :: or ' */ |
e336de0d | 959 | |
faef0170 HS |
960 | /* flag bits for PL_in_eval */ |
961 | #define EVAL_NULL 0 /* not in an eval */ | |
962 | #define EVAL_INEVAL 1 /* some enclosing scope is an eval */ | |
963 | #define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */ | |
864dbfa3 | 964 | #define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */ |
6dc8a9e4 | 965 | #define EVAL_INREQUIRE 8 /* The code is being required. */ |
a1941760 | 966 | #define EVAL_RE_REPARSING 0x10 /* eval_sv() called with G_RE_REPARSING */ |
4c57ced5 | 967 | /* if adding extra bits, make sure they can fit in CxOLD_OP_TYPE() */ |
faef0170 | 968 | |
e336de0d GS |
969 | /* Support for switching (stack and block) contexts. |
970 | * This ensures magic doesn't invalidate local stack and cx pointers. | |
971 | */ | |
972 | ||
e788e7d3 GS |
973 | #define PERLSI_UNKNOWN -1 |
974 | #define PERLSI_UNDEF 0 | |
975 | #define PERLSI_MAIN 1 | |
976 | #define PERLSI_MAGIC 2 | |
977 | #define PERLSI_SORT 3 | |
978 | #define PERLSI_SIGNAL 4 | |
979 | #define PERLSI_OVERLOAD 5 | |
980 | #define PERLSI_DESTROY 6 | |
981 | #define PERLSI_WARNHOOK 7 | |
982 | #define PERLSI_DIEHOOK 8 | |
983 | #define PERLSI_REQUIRE 9 | |
e1a10f35 | 984 | #define PERLSI_MULTICALL 10 |
e336de0d GS |
985 | |
986 | struct stackinfo { | |
987 | AV * si_stack; /* stack for current runlevel */ | |
988 | PERL_CONTEXT * si_cxstack; /* context stack for runlevel */ | |
9bd87817 NC |
989 | struct stackinfo * si_prev; |
990 | struct stackinfo * si_next; | |
e336de0d GS |
991 | I32 si_cxix; /* current context index */ |
992 | I32 si_cxmax; /* maximum allocated index */ | |
993 | I32 si_type; /* type of runlevel */ | |
ce2f7c3b | 994 | I32 si_markoff; /* offset where markstack begins for us. |
e336de0d GS |
995 | * currently used only with DEBUGGING, |
996 | * but not #ifdef-ed for bincompat */ | |
1fced1a2 | 997 | #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY |
87058c31 DM |
998 | /* high water mark: for checking if the stack was correctly extended / |
999 | * tested for extension by each pp function */ | |
1000 | SSize_t si_stack_hwm; | |
1001 | #endif | |
1002 | ||
e336de0d GS |
1003 | }; |
1004 | ||
1005 | typedef struct stackinfo PERL_SI; | |
1006 | ||
3280af22 NIS |
1007 | #define cxstack (PL_curstackinfo->si_cxstack) |
1008 | #define cxstack_ix (PL_curstackinfo->si_cxix) | |
1009 | #define cxstack_max (PL_curstackinfo->si_cxmax) | |
e336de0d GS |
1010 | |
1011 | #ifdef DEBUGGING | |
ce2f7c3b GS |
1012 | # define SET_MARK_OFFSET \ |
1013 | PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack | |
e336de0d | 1014 | #else |
ce2f7c3b | 1015 | # define SET_MARK_OFFSET NOOP |
e336de0d GS |
1016 | #endif |
1017 | ||
87058c31 | 1018 | #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY |
45d6bfc0 | 1019 | # define PUSHSTACK_INIT_HWM(si) ((si)->si_stack_hwm = 0) |
87058c31 DM |
1020 | #else |
1021 | # define PUSHSTACK_INIT_HWM(si) NOOP | |
1022 | #endif | |
1023 | ||
d3acc0f7 | 1024 | #define PUSHSTACKi(type) \ |
e336de0d | 1025 | STMT_START { \ |
3280af22 | 1026 | PERL_SI *next = PL_curstackinfo->si_next; \ |
1c98cc53 DM |
1027 | DEBUG_l({ \ |
1028 | int i = 0; PERL_SI *p = PL_curstackinfo; \ | |
1029 | while (p) { i++; p = p->si_prev; } \ | |
1030 | Perl_deb(aTHX_ "push STACKINFO %d at %s:%d\n", \ | |
1031 | i, __FILE__, __LINE__);}) \ | |
e336de0d GS |
1032 | if (!next) { \ |
1033 | next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \ | |
3280af22 NIS |
1034 | next->si_prev = PL_curstackinfo; \ |
1035 | PL_curstackinfo->si_next = next; \ | |
e336de0d GS |
1036 | } \ |
1037 | next->si_type = type; \ | |
1038 | next->si_cxix = -1; \ | |
87058c31 | 1039 | PUSHSTACK_INIT_HWM(next); \ |
e336de0d | 1040 | AvFILLp(next->si_stack) = 0; \ |
3280af22 NIS |
1041 | SWITCHSTACK(PL_curstack,next->si_stack); \ |
1042 | PL_curstackinfo = next; \ | |
ce2f7c3b | 1043 | SET_MARK_OFFSET; \ |
e336de0d GS |
1044 | } STMT_END |
1045 | ||
e788e7d3 | 1046 | #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN) |
d3acc0f7 | 1047 | |
3095d977 GS |
1048 | /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by |
1049 | * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */ | |
d3acc0f7 | 1050 | #define POPSTACK \ |
e336de0d | 1051 | STMT_START { \ |
39644a26 | 1052 | dSP; \ |
c4420975 | 1053 | PERL_SI * const prev = PL_curstackinfo->si_prev; \ |
1c98cc53 DM |
1054 | DEBUG_l({ \ |
1055 | int i = -1; PERL_SI *p = PL_curstackinfo; \ | |
1056 | while (p) { i++; p = p->si_prev; } \ | |
1057 | Perl_deb(aTHX_ "pop STACKINFO %d at %s:%d\n", \ | |
1058 | i, __FILE__, __LINE__);}) \ | |
e336de0d | 1059 | if (!prev) { \ |
3d04513d | 1060 | Perl_croak_popstack(); \ |
e336de0d | 1061 | } \ |
3280af22 | 1062 | SWITCHSTACK(PL_curstack,prev->si_stack); \ |
e336de0d | 1063 | /* don't free prev here, free them all at the END{} */ \ |
3280af22 | 1064 | PL_curstackinfo = prev; \ |
e336de0d GS |
1065 | } STMT_END |
1066 | ||
1067 | #define POPSTACK_TO(s) \ | |
1068 | STMT_START { \ | |
3280af22 | 1069 | while (PL_curstack != s) { \ |
bac4b2ad | 1070 | dounwind(-1); \ |
d3acc0f7 | 1071 | POPSTACK; \ |
bac4b2ad | 1072 | } \ |
e336de0d | 1073 | } STMT_END |
923e4eb5 | 1074 | |
9d990559 DM |
1075 | #define IN_PERL_COMPILETIME cBOOL(PL_curcop == &PL_compiling) |
1076 | #define IN_PERL_RUNTIME cBOOL(PL_curcop != &PL_compiling) | |
923e4eb5 | 1077 | |
ed8ff0f3 DM |
1078 | |
1079 | ||
1080 | ||
9850bf21 RH |
1081 | /* |
1082 | =head1 Multicall Functions | |
1083 | ||
1084 | =for apidoc Ams||dMULTICALL | |
72d33970 | 1085 | Declare local variables for a multicall. See L<perlcall/LIGHTWEIGHT CALLBACKS>. |
9850bf21 RH |
1086 | |
1087 | =for apidoc Ams||PUSH_MULTICALL | |
1088 | Opening bracket for a lightweight callback. | |
0eda4409 | 1089 | See L<perlcall/LIGHTWEIGHT CALLBACKS>. |
9850bf21 RH |
1090 | |
1091 | =for apidoc Ams||MULTICALL | |
72d33970 | 1092 | Make a lightweight callback. See L<perlcall/LIGHTWEIGHT CALLBACKS>. |
9850bf21 RH |
1093 | |
1094 | =for apidoc Ams||POP_MULTICALL | |
1095 | Closing bracket for a lightweight callback. | |
0eda4409 | 1096 | See L<perlcall/LIGHTWEIGHT CALLBACKS>. |
9850bf21 RH |
1097 | |
1098 | =cut | |
1099 | */ | |
1100 | ||
1101 | #define dMULTICALL \ | |
79503099 | 1102 | OP *multicall_cop; \ |
35095fd0 | 1103 | bool multicall_oldcatch |
9850bf21 | 1104 | |
82f35e8b | 1105 | #define PUSH_MULTICALL(the_cv) \ |
b0065247 | 1106 | PUSH_MULTICALL_FLAGS(the_cv, 0) |
81ed78b2 | 1107 | |
b0065247 DM |
1108 | /* Like PUSH_MULTICALL, but allows you to specify extra flags |
1109 | * for the CX stack entry (this isn't part of the public API) */ | |
81ed78b2 | 1110 | |
b0065247 | 1111 | #define PUSH_MULTICALL_FLAGS(the_cv, flags) \ |
9850bf21 | 1112 | STMT_START { \ |
79503099 | 1113 | PERL_CONTEXT *cx; \ |
0bcc34c2 AL |
1114 | CV * const _nOnclAshIngNamE_ = the_cv; \ |
1115 | CV * const cv = _nOnclAshIngNamE_; \ | |
b70d5558 | 1116 | PADLIST * const padlist = CvPADLIST(cv); \ |
9850bf21 | 1117 | multicall_oldcatch = CATCH_GET; \ |
9850bf21 | 1118 | CATCH_SET(TRUE); \ |
e1a10f35 | 1119 | PUSHSTACKi(PERLSI_MULTICALL); \ |
1c23e2bd | 1120 | cx = cx_pushblock((CXt_SUB|CXp_MULTICALL|flags), (U8)gimme, \ |
fd9b7244 | 1121 | PL_stack_sp, PL_savestack_ix); \ |
79503099 | 1122 | cx_pushsub(cx, cv, NULL, 0); \ |
49f582ca | 1123 | SAVEOP(); \ |
b0065247 DM |
1124 | if (!(flags & CXp_SUB_RE_FAKE)) \ |
1125 | CvDEPTH(cv)++; \ | |
d2af2719 | 1126 | if (CvDEPTH(cv) >= 2) \ |
9850bf21 | 1127 | Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \ |
9850bf21 RH |
1128 | PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \ |
1129 | multicall_cop = CvSTART(cv); \ | |
1130 | } STMT_END | |
1131 | ||
1132 | #define MULTICALL \ | |
1133 | STMT_START { \ | |
1134 | PL_op = multicall_cop; \ | |
1135 | CALLRUNOPS(aTHX); \ | |
1136 | } STMT_END | |
1137 | ||
1138 | #define POP_MULTICALL \ | |
1139 | STMT_START { \ | |
79503099 | 1140 | PERL_CONTEXT *cx; \ |
4ebe6e95 | 1141 | cx = CX_CUR(); \ |
dfe0f39b | 1142 | CX_LEAVE_SCOPE(cx); \ |
a73d8813 | 1143 | cx_popsub_common(cx); \ |
4df352a8 | 1144 | gimme = cx->blk_gimme; \ |
7e27c4a5 | 1145 | PERL_UNUSED_VAR(gimme); /* for API */ \ |
ed8ff0f3 | 1146 | cx_popblock(cx); \ |
5da525e9 | 1147 | CX_POP(cx); \ |
1bbbfc50 | 1148 | POPSTACK; \ |
9850bf21 | 1149 | CATCH_SET(multicall_oldcatch); \ |
1bbbfc50 | 1150 | SPAGAIN; \ |
9850bf21 | 1151 | } STMT_END |
b3ca2e83 | 1152 | |
81ed78b2 DM |
1153 | /* Change the CV of an already-pushed MULTICALL CxSUB block. |
1154 | * (this isn't part of the public API) */ | |
1155 | ||
b0065247 | 1156 | #define CHANGE_MULTICALL_FLAGS(the_cv, flags) \ |
81ed78b2 DM |
1157 | STMT_START { \ |
1158 | CV * const _nOnclAshIngNamE_ = the_cv; \ | |
1159 | CV * const cv = _nOnclAshIngNamE_; \ | |
b70d5558 | 1160 | PADLIST * const padlist = CvPADLIST(cv); \ |
79503099 | 1161 | PERL_CONTEXT *cx = CX_CUR(); \ |
79646418 | 1162 | assert(CxMULTICALL(cx)); \ |
a73d8813 | 1163 | cx_popsub_common(cx); \ |
b0065247 | 1164 | cx->cx_type = (CXt_SUB|CXp_MULTICALL|flags); \ |
79503099 | 1165 | cx_pushsub(cx, cv, NULL, 0); \ |
b0065247 DM |
1166 | if (!(flags & CXp_SUB_RE_FAKE)) \ |
1167 | CvDEPTH(cv)++; \ | |
d2af2719 | 1168 | if (CvDEPTH(cv) >= 2) \ |
81ed78b2 | 1169 | Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \ |
81ed78b2 | 1170 | PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \ |
81ed78b2 DM |
1171 | multicall_cop = CvSTART(cv); \ |
1172 | } STMT_END | |
b3ca2e83 | 1173 | /* |
14d04a33 | 1174 | * ex: set ts=8 sts=4 sw=4 et: |
b3ca2e83 | 1175 | */ |