This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix scrambled and incorrect proto mismatch error
[perl5.git] / pad.c
CommitLineData
dd2155a4
DM
1/* pad.c
2 *
1129b882
NC
3 * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008
4 * by Larry Wall and others
dd2155a4
DM
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.
4ac71550
TC
8 */
9
10/*
11 * 'Anyway: there was this Mr. Frodo left an orphan and stranded, as you
12 * might say, among those queer Bucklanders, being brought up anyhow in
13 * Brandy Hall. A regular warren, by all accounts. Old Master Gorbadoc
14 * never had fewer than a couple of hundred relations in the place.
15 * Mr. Bilbo never did a kinder deed than when he brought the lad back
16 * to live among decent folk.' --the Gaffer
dd2155a4 17 *
4ac71550 18 * [p.23 of _The Lord of the Rings_, I/i: "A Long-Expected Party"]
dd2155a4
DM
19 */
20
21/* XXX DAPM
22 * As of Sept 2002, this file is new and may be in a state of flux for
23 * a while. I've marked things I intent to come back and look at further
24 * with an 'XXX DAPM' comment.
25 */
26
27/*
28=head1 Pad Data Structures
29
cc76b5cc 30=for apidoc Amx|PADLIST *|CvPADLIST|CV *cv
166f8a29 31
cc76b5cc
Z
32CV's can have CvPADLIST(cv) set to point to an AV. This is the CV's
33scratchpad, which stores lexical variables and opcode temporary and
34per-thread values.
dd2155a4
DM
35
36For these purposes "forms" are a kind-of CV, eval""s are too (except they're
37not callable at will and are always thrown away after the eval"" is done
b5c19bd7
DM
38executing). Require'd files are simply evals without any outer lexical
39scope.
dd2155a4
DM
40
41XSUBs don't have CvPADLIST set - dXSTARG fetches values from PL_curpad,
42but that is really the callers pad (a slot of which is allocated by
43every entersub).
44
7d953ba8 45The CvPADLIST AV has the REFCNT of its component items managed "manually"
6e670818 46(mostly in pad.c) rather than by normal av.c rules. So we turn off AvREAL
7d953ba8 47just before freeing it, to let av.c know not to touch the entries.
dd2155a4
DM
48The items in the AV are not SVs as for a normal AV, but other AVs:
49
500'th Entry of the CvPADLIST is an AV which represents the "names" or rather
51the "static type information" for lexicals.
52
53The CvDEPTH'th entry of CvPADLIST AV is an AV which is the stack frame at that
54depth of recursion into the CV.
55The 0'th slot of a frame AV is an AV which is @_.
56other entries are storage for variables and op targets.
57
f3548bdc 58Iterating over the names AV iterates over all possible pad
dd2155a4
DM
59items. Pad slots that are SVs_PADTMP (targets/GVs/constants) end up having
60&PL_sv_undef "names" (see pad_alloc()).
61
62Only my/our variable (SVs_PADMY/SVs_PADOUR) slots get valid names.
63The rest are op targets/GVs/constants which are statically allocated
64or resolved at compile time. These don't have names by which they
65can be looked up from Perl code at run time through eval"" like
66my/our variables can be. Since they can't be looked up by "name"
67but only by their index allocated at compile time (which is usually
68in PL_op->op_targ), wasting a name SV for them doesn't make sense.
69
70The SVs in the names AV have their PV being the name of the variable.
3441fb63 71xlow+1..xhigh inclusive in the NV union is a range of cop_seq numbers for
61f4bfbf
DM
72which the name is valid (accessed through the macros COP_SEQ_RANGE_LOW and
73_HIGH). During compilation, these fields may hold the special value
74PERL_PADSEQ_INTRO to indicate various stages:
0d311cdb
DM
75
76 COP_SEQ_RANGE_LOW _HIGH
77 ----------------- -----
78 PERL_PADSEQ_INTRO 0 variable not yet introduced: { my ($x
79 valid-seq# PERL_PADSEQ_INTRO variable in scope: { my ($x)
80 valid-seq# valid-seq# compilation of scope complete: { my ($x) }
81
82For typed lexicals name SV is SVt_PVMG and SvSTASH
3441fb63 83points at the type. For C<our> lexicals, the type is also SVt_PVMG, with the
73d95100 84SvOURSTASH slot pointing at the stash of the associated global (so that
931b58fb 85duplicate C<our> declarations in the same package can be detected). SvUVX is
3441fb63 86sometimes hijacked to store the generation number during compilation.
dd2155a4 87
b5c19bd7
DM
88If SvFAKE is set on the name SV, then that slot in the frame AV is
89a REFCNT'ed reference to a lexical from "outside". In this case,
3441fb63
NC
90the name SV does not use xlow and xhigh to store a cop_seq range, since it is
91in scope throughout. Instead xhigh stores some flags containing info about
b5c19bd7 92the real lexical (is it declared in an anon, and is it capable of being
3441fb63 93instantiated multiple times?), and for fake ANONs, xlow contains the index
b5c19bd7
DM
94within the parent's pad where the lexical's value is stored, to make
95cloning quicker.
dd2155a4 96
a6d05634 97If the 'name' is '&' the corresponding entry in frame AV
dd2155a4
DM
98is a CV representing a possible closure.
99(SvFAKE and name of '&' is not a meaningful combination currently but could
100become so if C<my sub foo {}> is implemented.)
101
71f882da
DM
102Note that formats are treated as anon subs, and are cloned each time
103write is called (if necessary).
104
ab8e66c1 105The flag SVs_PADSTALE is cleared on lexicals each time the my() is executed,
e6e7068b
DM
106and set on scope exit. This allows the 'Variable $x is not available' warning
107to be generated in evals, such as
108
109 { my $x = 1; sub f { eval '$x'} } f();
110
ab8e66c1 111For state vars, SVs_PADSTALE is overloaded to mean 'not yet initialised'
d1186544 112
cc76b5cc
Z
113=for apidoc AmxU|AV *|PL_comppad_name
114
115During compilation, this points to the array containing the names part
116of the pad for the currently-compiling code.
117
118=for apidoc AmxU|AV *|PL_comppad
119
120During compilation, this points to the array containing the values
121part of the pad for the currently-compiling code. (At runtime a CV may
122have many such value arrays; at compile time just one is constructed.)
123At runtime, this points to the array containing the currently-relevant
124values for the pad for the currently-executing code.
125
126=for apidoc AmxU|SV **|PL_curpad
127
128Points directly to the body of the L</PL_comppad> array.
129(I.e., this is C<AvARRAY(PL_comppad)>.)
130
dd2155a4
DM
131=cut
132*/
133
134
135#include "EXTERN.h"
136#define PERL_IN_PAD_C
137#include "perl.h"
952306ac 138#include "keywords.h"
dd2155a4 139
3441fb63
NC
140#define COP_SEQ_RANGE_LOW_set(sv,val) \
141 STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xlow = (val); } STMT_END
142#define COP_SEQ_RANGE_HIGH_set(sv,val) \
143 STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xhigh = (val); } STMT_END
809abb02 144
3441fb63
NC
145#define PARENT_PAD_INDEX_set(sv,val) \
146 STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xlow = (val); } STMT_END
147#define PARENT_FAKELEX_FLAGS_set(sv,val) \
148 STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xhigh = (val); } STMT_END
dd2155a4 149
cc76b5cc
Z
150/*
151=for apidoc mx|void|pad_peg|const char *s
152
153When PERL_MAD is enabled, this is a small no-op function that gets called
154at the start of each pad-related function. It can be breakpointed to
155track all pad operations. The parameter is a string indicating the type
156of pad operation being performed.
157
158=cut
159*/
160
1dba731d
NC
161#ifdef PERL_MAD
162void pad_peg(const char* s) {
790427a5
DM
163 static int pegcnt; /* XXX not threadsafe */
164 PERL_UNUSED_ARG(s);
7918f24d
NC
165
166 PERL_ARGS_ASSERT_PAD_PEG;
167
1dba731d
NC
168 pegcnt++;
169}
170#endif
dd2155a4
DM
171
172/*
5b16296c
BF
173This is basically sv_eq_flags() in sv.c, but we avoid the magic
174and bytes checking.
175*/
176
76d60a53
NC
177static bool
178sv_eq_pvn_flags(pTHX_ const SV *sv, const char* pv, const STRLEN pvlen, const U32 flags) {
5b16296c
BF
179 if ( (SvUTF8(sv) & SVf_UTF8 ) != (flags & SVf_UTF8) ) {
180 const char *pv1 = SvPVX_const(sv);
181 STRLEN cur1 = SvCUR(sv);
182 const char *pv2 = pv;
183 STRLEN cur2 = pvlen;
184 if (PL_encoding) {
185 SV* svrecode = NULL;
186 if (SvUTF8(sv)) {
187 svrecode = newSVpvn(pv2, cur2);
188 sv_recode_to_utf8(svrecode, PL_encoding);
189 pv2 = SvPV_const(svrecode, cur2);
190 }
191 else {
192 svrecode = newSVpvn(pv1, cur1);
193 sv_recode_to_utf8(svrecode, PL_encoding);
194 pv1 = SvPV_const(svrecode, cur1);
195 }
196 SvREFCNT_dec(svrecode);
197 }
198 if (flags & SVf_UTF8)
199 return (bytes_cmp_utf8(
200 (const U8*)pv1, cur1,
201 (const U8*)pv2, cur2) == 0);
202 else
203 return (bytes_cmp_utf8(
204 (const U8*)pv2, cur2,
205 (const U8*)pv1, cur1) == 0);
206 }
207 else
208 return ((SvPVX_const(sv) == pv)
209 || memEQ(SvPVX_const(sv), pv, pvlen));
210}
211
212
213/*
cc76b5cc 214=for apidoc Am|PADLIST *|pad_new|int flags
dd2155a4 215
cc76b5cc
Z
216Create a new padlist, updating the global variables for the
217currently-compiling padlist to point to the new padlist. The following
218flags can be OR'ed together:
dd2155a4
DM
219
220 padnew_CLONE this pad is for a cloned CV
cc76b5cc 221 padnew_SAVE save old globals on the save stack
dd2155a4
DM
222 padnew_SAVESUB also save extra stuff for start of sub
223
224=cut
225*/
226
227PADLIST *
c7c737cb 228Perl_pad_new(pTHX_ int flags)
dd2155a4 229{
97aff369 230 dVAR;
e1ec3a88 231 AV *padlist, *padname, *pad;
7a6072a8 232 SV **ary;
dd2155a4 233
f3548bdc
DM
234 ASSERT_CURPAD_LEGAL("pad_new");
235
dd2155a4
DM
236 /* XXX DAPM really need a new SAVEt_PAD which restores all or most
237 * vars (based on flags) rather than storing vals + addresses for
238 * each individually. Also see pad_block_start.
239 * XXX DAPM Try to see whether all these conditionals are required
240 */
241
242 /* save existing state, ... */
243
244 if (flags & padnew_SAVE) {
3979c56f 245 SAVECOMPPAD();
dd2155a4
DM
246 SAVESPTR(PL_comppad_name);
247 if (! (flags & padnew_CLONE)) {
248 SAVEI32(PL_padix);
249 SAVEI32(PL_comppad_name_fill);
250 SAVEI32(PL_min_intro_pending);
251 SAVEI32(PL_max_intro_pending);
8bbe96d7 252 SAVEBOOL(PL_cv_has_eval);
dd2155a4 253 if (flags & padnew_SAVESUB) {
f0cb02e3 254 SAVEBOOL(PL_pad_reset_pending);
dd2155a4
DM
255 }
256 }
257 }
258 /* XXX DAPM interestingly, PL_comppad_name_floor never seems to be
259 * saved - check at some pt that this is okay */
260
261 /* ... create new pad ... */
262
263 padlist = newAV();
264 padname = newAV();
265 pad = newAV();
266
267 if (flags & padnew_CLONE) {
268 /* XXX DAPM I dont know why cv_clone needs it
269 * doing differently yet - perhaps this separate branch can be
270 * dispensed with eventually ???
271 */
272
e1ec3a88 273 AV * const a0 = newAV(); /* will be @_ */
ad64d0ec 274 av_store(pad, 0, MUTABLE_SV(a0));
11ca45c0 275 AvREIFY_only(a0);
dd2155a4
DM
276 }
277 else {
a0714e2c 278 av_store(pad, 0, NULL);
dd2155a4
DM
279 }
280
7a6072a8
NC
281 /* Most subroutines never recurse, hence only need 2 entries in the padlist
282 array - names, and depth=1. The default for av_store() is to allocate
283 0..3, and even an explicit call to av_extend() with <3 will be rounded
284 up, so we inline the allocation of the array here. */
285 Newx(ary, 2, SV*);
286 AvFILLp(padlist) = 1;
287 AvMAX(padlist) = 1;
288 AvALLOC(padlist) = ary;
289 AvARRAY(padlist) = ary;
290 ary[0] = MUTABLE_SV(padname);
291 ary[1] = MUTABLE_SV(pad);
dd2155a4
DM
292
293 /* ... then update state variables */
294
403799bf
NC
295 PL_comppad_name = padname;
296 PL_comppad = pad;
297 PL_curpad = AvARRAY(pad);
dd2155a4
DM
298
299 if (! (flags & padnew_CLONE)) {
300 PL_comppad_name_fill = 0;
301 PL_min_intro_pending = 0;
302 PL_padix = 0;
b5c19bd7 303 PL_cv_has_eval = 0;
dd2155a4
DM
304 }
305
306 DEBUG_X(PerlIO_printf(Perl_debug_log,
b5c19bd7 307 "Pad 0x%"UVxf"[0x%"UVxf"] new: compcv=0x%"UVxf
dd2155a4 308 " name=0x%"UVxf" flags=0x%"UVxf"\n",
b5c19bd7 309 PTR2UV(PL_comppad), PTR2UV(PL_curpad), PTR2UV(PL_compcv),
dd2155a4
DM
310 PTR2UV(padname), (UV)flags
311 )
312 );
313
314 return (PADLIST*)padlist;
315}
316
dd2155a4 317
c4528262
NC
318/*
319=head1 Embedding Functions
320
321=for apidoc cv_undef
322
323Clear out all the active components of a CV. This can happen either
324by an explicit C<undef &foo>, or by the reference count going to zero.
325In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
326children can still follow the full lexical scope chain.
327
328=cut
329*/
330
331void
332Perl_cv_undef(pTHX_ CV *cv)
333{
334 dVAR;
c2736fce 335 const PADLIST *padlist = CvPADLIST(cv);
8be227ab 336 bool const slabbed = !!CvSLABBED(cv);
c4528262
NC
337
338 PERL_ARGS_ASSERT_CV_UNDEF;
339
340 DEBUG_X(PerlIO_printf(Perl_debug_log,
341 "CV undef: cv=0x%"UVxf" comppad=0x%"UVxf"\n",
342 PTR2UV(cv), PTR2UV(PL_comppad))
343 );
344
bad4ae38 345 if (CvFILE(cv) && CvDYNFILE(cv)) {
c4528262
NC
346 Safefree(CvFILE(cv));
347 }
348 CvFILE(cv) = NULL;
dd2155a4 349
8be227ab 350 CvSLABBED_off(cv);
c4528262
NC
351 if (!CvISXSUB(cv) && CvROOT(cv)) {
352 if (SvTYPE(cv) == SVt_PVCV && CvDEPTH(cv))
353 Perl_croak(aTHX_ "Can't undef active subroutine");
354 ENTER;
355
356 PAD_SAVE_SETNULLPAD();
357
8be227ab 358 if (slabbed) OpslabREFCNT_dec_padok(OpSLAB(CvROOT(cv)));
c4528262
NC
359 op_free(CvROOT(cv));
360 CvROOT(cv) = NULL;
361 CvSTART(cv) = NULL;
362 LEAVE;
363 }
8be227ab
FC
364 else if (slabbed && CvSTART(cv)) {
365 ENTER;
366 PAD_SAVE_SETNULLPAD();
367
368 /* discard any leaked ops */
369 opslab_force_free((OPSLAB *)CvSTART(cv));
370 CvSTART(cv) = NULL;
371
372 LEAVE;
373 }
7aef8e5b 374#ifdef DEBUGGING
8be227ab 375 else if (slabbed) Perl_warn(aTHX_ "Slab leaked from cv %p", cv);
8be227ab 376#endif
c4528262
NC
377 SvPOK_off(MUTABLE_SV(cv)); /* forget prototype */
378 CvGV_set(cv, NULL);
379
c2736fce
NC
380 /* This statement and the subsequence if block was pad_undef(). */
381 pad_peg("pad_undef");
382
383 if (padlist && !SvIS_FREED(padlist) /* may be during global destruction */
384 ) {
385 I32 ix;
386
387 /* Free the padlist associated with a CV.
388 If parts of it happen to be current, we null the relevant PL_*pad*
389 global vars so that we don't have any dangling references left.
390 We also repoint the CvOUTSIDE of any about-to-be-orphaned inner
391 subs to the outer of this cv. */
392
393 DEBUG_X(PerlIO_printf(Perl_debug_log,
394 "Pad undef: cv=0x%"UVxf" padlist=0x%"UVxf" comppad=0x%"UVxf"\n",
395 PTR2UV(cv), PTR2UV(padlist), PTR2UV(PL_comppad))
396 );
397
398 /* detach any '&' anon children in the pad; if afterwards they
399 * are still live, fix up their CvOUTSIDEs to point to our outside,
400 * bypassing us. */
401 /* XXX DAPM for efficiency, we should only do this if we know we have
402 * children, or integrate this loop with general cleanup */
403
404 if (PL_phase != PERL_PHASE_DESTRUCT) { /* don't bother during global destruction */
405 CV * const outercv = CvOUTSIDE(cv);
406 const U32 seq = CvOUTSIDE_SEQ(cv);
407 AV * const comppad_name = MUTABLE_AV(AvARRAY(padlist)[0]);
408 SV ** const namepad = AvARRAY(comppad_name);
409 AV * const comppad = MUTABLE_AV(AvARRAY(padlist)[1]);
410 SV ** const curpad = AvARRAY(comppad);
411 for (ix = AvFILLp(comppad_name); ix > 0; ix--) {
412 SV * const namesv = namepad[ix];
413 if (namesv && namesv != &PL_sv_undef
414 && *SvPVX_const(namesv) == '&')
415 {
416 CV * const innercv = MUTABLE_CV(curpad[ix]);
417 U32 inner_rc = SvREFCNT(innercv);
418 assert(inner_rc);
e09ac076 419 assert(SvTYPE(innercv) != SVt_PVFM);
c2736fce
NC
420 namepad[ix] = NULL;
421 SvREFCNT_dec(namesv);
422
423 if (SvREFCNT(comppad) < 2) { /* allow for /(?{ sub{} })/ */
424 curpad[ix] = NULL;
425 SvREFCNT_dec(innercv);
426 inner_rc--;
427 }
428
429 /* in use, not just a prototype */
430 if (inner_rc && (CvOUTSIDE(innercv) == cv)) {
431 assert(CvWEAKOUTSIDE(innercv));
432 /* don't relink to grandfather if he's being freed */
433 if (outercv && SvREFCNT(outercv)) {
434 CvWEAKOUTSIDE_off(innercv);
435 CvOUTSIDE(innercv) = outercv;
436 CvOUTSIDE_SEQ(innercv) = seq;
437 SvREFCNT_inc_simple_void_NN(outercv);
438 }
439 else {
440 CvOUTSIDE(innercv) = NULL;
441 }
442 }
443 }
444 }
445 }
446
447 ix = AvFILLp(padlist);
aa2f79cf 448 while (ix > 0) {
c2736fce
NC
449 SV* const sv = AvARRAY(padlist)[ix--];
450 if (sv) {
aa2f79cf 451 if (sv == (const SV *)PL_comppad) {
c2736fce
NC
452 PL_comppad = NULL;
453 PL_curpad = NULL;
454 }
aa2f79cf 455 SvREFCNT_dec(sv);
c2736fce 456 }
aa2f79cf
NC
457 }
458 {
459 SV *const sv = AvARRAY(padlist)[0];
460 if (sv == (const SV *)PL_comppad_name)
461 PL_comppad_name = NULL;
c2736fce
NC
462 SvREFCNT_dec(sv);
463 }
7d953ba8 464 AvREAL_off(CvPADLIST(cv));
c2736fce
NC
465 SvREFCNT_dec(MUTABLE_SV(CvPADLIST(cv)));
466 CvPADLIST(cv) = NULL;
467 }
468
c4528262
NC
469
470 /* remove CvOUTSIDE unless this is an undef rather than a free */
471 if (!SvREFCNT(cv) && CvOUTSIDE(cv)) {
472 if (!CvWEAKOUTSIDE(cv))
473 SvREFCNT_dec(CvOUTSIDE(cv));
474 CvOUTSIDE(cv) = NULL;
475 }
476 if (CvCONST(cv)) {
477 SvREFCNT_dec(MUTABLE_SV(CvXSUBANY(cv).any_ptr));
478 CvCONST_off(cv);
479 }
480 if (CvISXSUB(cv) && CvXSUB(cv)) {
481 CvXSUB(cv) = NULL;
482 }
483 /* delete all flags except WEAKOUTSIDE and CVGV_RC, which indicate the
2c374370
FC
484 * ref status of CvOUTSIDE and CvGV, and ANON, which pp_entersub uses
485 * to choose an error message */
486 CvFLAGS(cv) &= (CVf_WEAKOUTSIDE|CVf_CVGV_RC|CVf_ANON);
c4528262 487}
dd2155a4 488
8be227ab
FC
489void
490Perl_cv_forget_slab(pTHX_ CV *cv)
491{
492 const bool slabbed = !!CvSLABBED(cv);
7aef8e5b 493#ifdef PERL_DEBUG_READONLY_OPS
3107b51f 494 OPSLAB *slab = NULL;
7aef8e5b 495#endif
8be227ab
FC
496
497 PERL_ARGS_ASSERT_CV_FORGET_SLAB;
498
499 if (!slabbed) return;
500
501 CvSLABBED_off(cv);
502
7aef8e5b 503#ifdef PERL_DEBUG_READONLY_OPS
3107b51f
FC
504 if (CvROOT(cv)) slab = OpSLAB(CvROOT(cv));
505 else if (CvSTART(cv)) slab = (OPSLAB *)CvSTART(cv);
7aef8e5b 506#else
8be227ab
FC
507 if (CvROOT(cv)) OpslabREFCNT_dec(OpSLAB(CvROOT(cv)));
508 else if (CvSTART(cv)) OpslabREFCNT_dec((OPSLAB *)CvSTART(cv));
7aef8e5b
FC
509#endif
510#ifdef DEBUGGING
8be227ab 511 else if (slabbed) Perl_warn(aTHX_ "Slab leaked from cv %p", cv);
7aef8e5b 512#endif
3107b51f 513
7aef8e5b 514#ifdef PERL_DEBUG_READONLY_OPS
3107b51f
FC
515 if (slab) {
516 size_t refcnt;
517 refcnt = slab->opslab_refcnt;
518 OpslabREFCNT_dec(slab);
519 if (refcnt > 1) Slab_to_ro(slab);
520 }
8be227ab 521#endif
7aef8e5b 522}
8be227ab 523
cc76b5cc
Z
524/*
525=for apidoc m|PADOFFSET|pad_alloc_name|SV *namesv|U32 flags|HV *typestash|HV *ourstash
526
1a115e49
FC
527Allocates a place in the currently-compiling
528pad (via L<perlapi/pad_alloc>) and
cc76b5cc
Z
529then stores a name for that entry. I<namesv> is adopted and becomes the
530name entry; it must already contain the name string and be sufficiently
531upgraded. I<typestash> and I<ourstash> and the C<padadd_STATE> flag get
1a115e49
FC
532added to I<namesv>. None of the other
533processing of L<perlapi/pad_add_name_pvn>
cc76b5cc
Z
534is done. Returns the offset of the allocated pad slot.
535
536=cut
537*/
538
3291825f 539static PADOFFSET
cc76b5cc 540S_pad_alloc_name(pTHX_ SV *namesv, U32 flags, HV *typestash, HV *ourstash)
3291825f
NC
541{
542 dVAR;
543 const PADOFFSET offset = pad_alloc(OP_PADSV, SVs_PADMY);
544
cc76b5cc 545 PERL_ARGS_ASSERT_PAD_ALLOC_NAME;
3291825f 546
cc76b5cc 547 ASSERT_CURPAD_ACTIVE("pad_alloc_name");
3291825f
NC
548
549 if (typestash) {
550 assert(SvTYPE(namesv) == SVt_PVMG);
551 SvPAD_TYPED_on(namesv);
552 SvSTASH_set(namesv, MUTABLE_HV(SvREFCNT_inc_simple_NN(MUTABLE_SV(typestash))));
553 }
554 if (ourstash) {
555 SvPAD_OUR_on(namesv);
556 SvOURSTASH_set(namesv, ourstash);
557 SvREFCNT_inc_simple_void_NN(ourstash);
558 }
59cfed7d 559 else if (flags & padadd_STATE) {
3291825f
NC
560 SvPAD_STATE_on(namesv);
561 }
562
563 av_store(PL_comppad_name, offset, namesv);
564 return offset;
565}
566
dd2155a4 567/*
cc76b5cc 568=for apidoc Am|PADOFFSET|pad_add_name_pvn|const char *namepv|STRLEN namelen|U32 flags|HV *typestash|HV *ourstash
dd2155a4 569
cc76b5cc
Z
570Allocates a place in the currently-compiling pad for a named lexical
571variable. Stores the name and other metadata in the name part of the
572pad, and makes preparations to manage the variable's lexical scoping.
573Returns the offset of the allocated pad slot.
dd2155a4 574
cc76b5cc
Z
575I<namepv>/I<namelen> specify the variable's name, including leading sigil.
576If I<typestash> is non-null, the name is for a typed lexical, and this
577identifies the type. If I<ourstash> is non-null, it's a lexical reference
578to a package variable, and this identifies the package. The following
579flags can be OR'ed together:
580
581 padadd_OUR redundantly specifies if it's a package var
582 padadd_STATE variable will retain value persistently
583 padadd_NO_DUP_CHECK skip check for lexical shadowing
dd2155a4
DM
584
585=cut
586*/
587
dd2155a4 588PADOFFSET
cc76b5cc
Z
589Perl_pad_add_name_pvn(pTHX_ const char *namepv, STRLEN namelen,
590 U32 flags, HV *typestash, HV *ourstash)
dd2155a4 591{
97aff369 592 dVAR;
3291825f 593 PADOFFSET offset;
cca43f78 594 SV *namesv;
e8b34487 595 bool is_utf8;
dd2155a4 596
cc76b5cc 597 PERL_ARGS_ASSERT_PAD_ADD_NAME_PVN;
7918f24d 598
2435e5d3 599 if (flags & ~(padadd_OUR|padadd_STATE|padadd_NO_DUP_CHECK|padadd_UTF8_NAME))
cc76b5cc 600 Perl_croak(aTHX_ "panic: pad_add_name_pvn illegal flag bits 0x%" UVxf,
cca43f78
NC
601 (UV)flags);
602
603 namesv = newSV_type((ourstash || typestash) ? SVt_PVMG : SVt_PVNV);
e8b34487
BF
604
605 if ((is_utf8 = ((flags & padadd_UTF8_NAME) != 0))) {
606 namepv = (const char*)bytes_from_utf8((U8*)namepv, &namelen, &is_utf8);
607 }
608
0727928e
BF
609 sv_setpvn(namesv, namepv, namelen);
610
e8b34487
BF
611 if (is_utf8) {
612 flags |= padadd_UTF8_NAME;
613 SvUTF8_on(namesv);
614 }
615 else
616 flags &= ~padadd_UTF8_NAME;
dd2155a4 617
59cfed7d 618 if ((flags & padadd_NO_DUP_CHECK) == 0) {
2d12d04f 619 /* check for duplicate declaration */
59cfed7d 620 pad_check_dup(namesv, flags & padadd_OUR, ourstash);
2d12d04f
NC
621 }
622
2435e5d3 623 offset = pad_alloc_name(namesv, flags & ~padadd_UTF8_NAME, typestash, ourstash);
3291825f
NC
624
625 /* not yet introduced */
2df5bdd7
DM
626 COP_SEQ_RANGE_LOW_set(namesv, PERL_PADSEQ_INTRO);
627 COP_SEQ_RANGE_HIGH_set(namesv, 0);
3291825f
NC
628
629 if (!PL_min_intro_pending)
630 PL_min_intro_pending = offset;
631 PL_max_intro_pending = offset;
632 /* if it's not a simple scalar, replace with an AV or HV */
c1bf42f3
NC
633 assert(SvTYPE(PL_curpad[offset]) == SVt_NULL);
634 assert(SvREFCNT(PL_curpad[offset]) == 1);
cc76b5cc 635 if (namelen != 0 && *namepv == '@')
c1bf42f3 636 sv_upgrade(PL_curpad[offset], SVt_PVAV);
cc76b5cc 637 else if (namelen != 0 && *namepv == '%')
c1bf42f3
NC
638 sv_upgrade(PL_curpad[offset], SVt_PVHV);
639 assert(SvPADMY(PL_curpad[offset]));
3291825f
NC
640 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
641 "Pad addname: %ld \"%s\" new lex=0x%"UVxf"\n",
cc76b5cc
Z
642 (long)offset, SvPVX(namesv),
643 PTR2UV(PL_curpad[offset])));
dd2155a4
DM
644
645 return offset;
646}
647
cc76b5cc
Z
648/*
649=for apidoc Am|PADOFFSET|pad_add_name_pv|const char *name|U32 flags|HV *typestash|HV *ourstash
dd2155a4 650
cc76b5cc
Z
651Exactly like L</pad_add_name_pvn>, but takes a nul-terminated string
652instead of a string/length pair.
dd2155a4 653
cc76b5cc
Z
654=cut
655*/
656
657PADOFFSET
658Perl_pad_add_name_pv(pTHX_ const char *name,
0e1b3a4b 659 const U32 flags, HV *typestash, HV *ourstash)
cc76b5cc
Z
660{
661 PERL_ARGS_ASSERT_PAD_ADD_NAME_PV;
662 return pad_add_name_pvn(name, strlen(name), flags, typestash, ourstash);
663}
dd2155a4
DM
664
665/*
cc76b5cc 666=for apidoc Am|PADOFFSET|pad_add_name_sv|SV *name|U32 flags|HV *typestash|HV *ourstash
dd2155a4 667
cc76b5cc
Z
668Exactly like L</pad_add_name_pvn>, but takes the name string in the form
669of an SV instead of a string/length pair.
670
671=cut
672*/
673
674PADOFFSET
675Perl_pad_add_name_sv(pTHX_ SV *name, U32 flags, HV *typestash, HV *ourstash)
676{
677 char *namepv;
678 STRLEN namelen;
679 PERL_ARGS_ASSERT_PAD_ADD_NAME_SV;
680 namepv = SvPV(name, namelen);
e8b34487
BF
681 if (SvUTF8(name))
682 flags |= padadd_UTF8_NAME;
cc76b5cc
Z
683 return pad_add_name_pvn(namepv, namelen, flags, typestash, ourstash);
684}
685
686/*
687=for apidoc Amx|PADOFFSET|pad_alloc|I32 optype|U32 tmptype
688
689Allocates a place in the currently-compiling pad,
690returning the offset of the allocated pad slot.
691No name is initially attached to the pad slot.
692I<tmptype> is a set of flags indicating the kind of pad entry required,
693which will be set in the value SV for the allocated pad entry:
694
695 SVs_PADMY named lexical variable ("my", "our", "state")
696 SVs_PADTMP unnamed temporary store
697
698I<optype> should be an opcode indicating the type of operation that the
699pad entry is to support. This doesn't affect operational semantics,
700but is used for debugging.
dd2155a4
DM
701
702=cut
703*/
704
705/* XXX DAPM integrate alloc(), add_name() and add_anon(),
706 * or at least rationalise ??? */
dd2155a4
DM
707
708PADOFFSET
709Perl_pad_alloc(pTHX_ I32 optype, U32 tmptype)
710{
97aff369 711 dVAR;
dd2155a4
DM
712 SV *sv;
713 I32 retval;
714
6136c704 715 PERL_UNUSED_ARG(optype);
f3548bdc
DM
716 ASSERT_CURPAD_ACTIVE("pad_alloc");
717
dd2155a4 718 if (AvARRAY(PL_comppad) != PL_curpad)
5637ef5b
NC
719 Perl_croak(aTHX_ "panic: pad_alloc, %p!=%p",
720 AvARRAY(PL_comppad), PL_curpad);
dd2155a4
DM
721 if (PL_pad_reset_pending)
722 pad_reset();
723 if (tmptype & SVs_PADMY) {
cc76b5cc 724 /* For a my, simply push a null SV onto the end of PL_comppad. */
235cc2e3 725 sv = *av_fetch(PL_comppad, AvFILLp(PL_comppad) + 1, TRUE);
dd2155a4
DM
726 retval = AvFILLp(PL_comppad);
727 }
728 else {
cc76b5cc
Z
729 /* For a tmp, scan the pad from PL_padix upwards
730 * for a slot which has no name and no active value.
731 */
551405c4 732 SV * const * const names = AvARRAY(PL_comppad_name);
e1ec3a88 733 const SSize_t names_fill = AvFILLp(PL_comppad_name);
dd2155a4
DM
734 for (;;) {
735 /*
736 * "foreach" index vars temporarily become aliases to non-"my"
737 * values. Thus we must skip, not just pad values that are
738 * marked as current pad values, but also those with names.
739 */
740 /* HVDS why copy to sv here? we don't seem to use it */
741 if (++PL_padix <= names_fill &&
742 (sv = names[PL_padix]) && sv != &PL_sv_undef)
743 continue;
744 sv = *av_fetch(PL_comppad, PL_padix, TRUE);
745 if (!(SvFLAGS(sv) & (SVs_PADTMP | SVs_PADMY)) &&
746 !IS_PADGV(sv) && !IS_PADCONST(sv))
747 break;
748 }
749 retval = PL_padix;
750 }
751 SvFLAGS(sv) |= tmptype;
752 PL_curpad = AvARRAY(PL_comppad);
753
754 DEBUG_X(PerlIO_printf(Perl_debug_log,
755 "Pad 0x%"UVxf"[0x%"UVxf"] alloc: %ld for %s\n",
756 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long) retval,
757 PL_op_name[optype]));
fd0854ff
DM
758#ifdef DEBUG_LEAKING_SCALARS
759 sv->sv_debug_optype = optype;
760 sv->sv_debug_inpad = 1;
fd0854ff 761#endif
a212c8b5 762 return (PADOFFSET)retval;
dd2155a4
DM
763}
764
765/*
cc76b5cc 766=for apidoc Am|PADOFFSET|pad_add_anon|CV *func|I32 optype
dd2155a4 767
cc76b5cc
Z
768Allocates a place in the currently-compiling pad (via L</pad_alloc>)
769for an anonymous function that is lexically scoped inside the
770currently-compiling function.
771The function I<func> is linked into the pad, and its C<CvOUTSIDE> link
772to the outer scope is weakened to avoid a reference loop.
773
774I<optype> should be an opcode indicating the type of operation that the
775pad entry is to support. This doesn't affect operational semantics,
776but is used for debugging.
dd2155a4
DM
777
778=cut
779*/
780
781PADOFFSET
cc76b5cc 782Perl_pad_add_anon(pTHX_ CV* func, I32 optype)
dd2155a4 783{
97aff369 784 dVAR;
dd2155a4 785 PADOFFSET ix;
b9f83d2f 786 SV* const name = newSV_type(SVt_PVNV);
7918f24d
NC
787
788 PERL_ARGS_ASSERT_PAD_ADD_ANON;
789
1dba731d 790 pad_peg("add_anon");
76f68e9b 791 sv_setpvs(name, "&");
0d311cdb
DM
792 /* These two aren't used; just make sure they're not equal to
793 * PERL_PADSEQ_INTRO */
794 COP_SEQ_RANGE_LOW_set(name, 0);
795 COP_SEQ_RANGE_HIGH_set(name, 0);
cc76b5cc 796 ix = pad_alloc(optype, SVs_PADMY);
dd2155a4 797 av_store(PL_comppad_name, ix, name);
f3548bdc 798 /* XXX DAPM use PL_curpad[] ? */
e09ac076
FC
799 if (SvTYPE(func) == SVt_PVCV || !CvOUTSIDE(func))
800 av_store(PL_comppad, ix, (SV*)func);
801 else {
802 SV *rv = newRV_inc((SV *)func);
803 sv_rvweaken(rv);
804 assert (SvTYPE(func) == SVt_PVFM);
805 av_store(PL_comppad, ix, rv);
806 }
cc76b5cc 807 SvPADMY_on((SV*)func);
7dafbf52
DM
808
809 /* to avoid ref loops, we never have parent + child referencing each
810 * other simultaneously */
e09ac076 811 if (CvOUTSIDE(func) && SvTYPE(func) == SVt_PVCV) {
cc76b5cc
Z
812 assert(!CvWEAKOUTSIDE(func));
813 CvWEAKOUTSIDE_on(func);
814 SvREFCNT_dec(CvOUTSIDE(func));
7dafbf52 815 }
dd2155a4
DM
816 return ix;
817}
818
dd2155a4 819/*
13087dd8 820=for apidoc pad_check_dup
dd2155a4
DM
821
822Check for duplicate declarations: report any of:
13087dd8 823
dd2155a4 824 * a my in the current scope with the same name;
13087dd8
FC
825 * an our (anywhere in the pad) with the same name and the
826 same stash as C<ourstash>
827
828C<is_our> indicates that the name to check is an 'our' declaration.
dd2155a4
DM
829
830=cut
831*/
832
20381b50 833STATIC void
cc76b5cc 834S_pad_check_dup(pTHX_ SV *name, U32 flags, const HV *ourstash)
dd2155a4 835{
97aff369 836 dVAR;
53c1dcc0 837 SV **svp;
dd2155a4 838 PADOFFSET top, off;
59cfed7d 839 const U32 is_our = flags & padadd_OUR;
dd2155a4 840
7918f24d
NC
841 PERL_ARGS_ASSERT_PAD_CHECK_DUP;
842
f3548bdc 843 ASSERT_CURPAD_ACTIVE("pad_check_dup");
35f82371 844
59cfed7d 845 assert((flags & ~padadd_OUR) == 0);
35f82371 846
041457d9 847 if (AvFILLp(PL_comppad_name) < 0 || !ckWARN(WARN_MISC))
dd2155a4
DM
848 return; /* nothing to check */
849
850 svp = AvARRAY(PL_comppad_name);
851 top = AvFILLp(PL_comppad_name);
852 /* check the current scope */
853 /* XXX DAPM - why the (I32) cast - shouldn't we ensure they're the same
854 * type ? */
855 for (off = top; (I32)off > PL_comppad_name_floor; off--) {
53c1dcc0
AL
856 SV * const sv = svp[off];
857 if (sv
dd2155a4 858 && sv != &PL_sv_undef
ee6cee0c 859 && !SvFAKE(sv)
0d311cdb
DM
860 && ( COP_SEQ_RANGE_LOW(sv) == PERL_PADSEQ_INTRO
861 || COP_SEQ_RANGE_HIGH(sv) == PERL_PADSEQ_INTRO)
2d12d04f 862 && sv_eq(name, sv))
dd2155a4 863 {
00b1698f 864 if (is_our && (SvPAD_OUR(sv)))
7f73a9f1 865 break; /* "our" masking "our" */
dd2155a4 866 Perl_warner(aTHX_ packWARN(WARN_MISC),
c541b9b4 867 "\"%s\" variable %"SVf" masks earlier declaration in same %s",
12bd6ede 868 (is_our ? "our" : PL_parser->in_my == KEY_my ? "my" : "state"),
c541b9b4 869 sv,
2df5bdd7
DM
870 (COP_SEQ_RANGE_HIGH(sv) == PERL_PADSEQ_INTRO
871 ? "scope" : "statement"));
dd2155a4
DM
872 --off;
873 break;
874 }
875 }
876 /* check the rest of the pad */
877 if (is_our) {
61c5492a 878 while (off > 0) {
53c1dcc0
AL
879 SV * const sv = svp[off];
880 if (sv
dd2155a4 881 && sv != &PL_sv_undef
ee6cee0c 882 && !SvFAKE(sv)
0d311cdb
DM
883 && ( COP_SEQ_RANGE_LOW(sv) == PERL_PADSEQ_INTRO
884 || COP_SEQ_RANGE_HIGH(sv) == PERL_PADSEQ_INTRO)
73d95100 885 && SvOURSTASH(sv) == ourstash
2d12d04f 886 && sv_eq(name, sv))
dd2155a4
DM
887 {
888 Perl_warner(aTHX_ packWARN(WARN_MISC),
c541b9b4 889 "\"our\" variable %"SVf" redeclared", sv);
624f69f5 890 if ((I32)off <= PL_comppad_name_floor)
7f73a9f1
RGS
891 Perl_warner(aTHX_ packWARN(WARN_MISC),
892 "\t(Did you mean \"local\" instead of \"our\"?)\n");
dd2155a4
DM
893 break;
894 }
61c5492a
NC
895 --off;
896 }
dd2155a4
DM
897 }
898}
899
900
dd2155a4 901/*
cc76b5cc 902=for apidoc Am|PADOFFSET|pad_findmy_pvn|const char *namepv|STRLEN namelen|U32 flags
dd2155a4 903
cc76b5cc
Z
904Given the name of a lexical variable, find its position in the
905currently-compiling pad.
906I<namepv>/I<namelen> specify the variable's name, including leading sigil.
907I<flags> is reserved and must be zero.
908If it is not in the current pad but appears in the pad of any lexically
909enclosing scope, then a pseudo-entry for it is added in the current pad.
910Returns the offset in the current pad,
911or C<NOT_IN_PAD> if no such lexical is in scope.
dd2155a4
DM
912
913=cut
914*/
915
916PADOFFSET
cc76b5cc 917Perl_pad_findmy_pvn(pTHX_ const char *namepv, STRLEN namelen, U32 flags)
dd2155a4 918{
97aff369 919 dVAR;
b5c19bd7
DM
920 SV *out_sv;
921 int out_flags;
929a0744 922 I32 offset;
e1ec3a88 923 const AV *nameav;
929a0744 924 SV **name_svp;
dd2155a4 925
cc76b5cc 926 PERL_ARGS_ASSERT_PAD_FINDMY_PVN;
7918f24d 927
cc76b5cc 928 pad_peg("pad_findmy_pvn");
f8f98e0a 929
2435e5d3 930 if (flags & ~padadd_UTF8_NAME)
cc76b5cc 931 Perl_croak(aTHX_ "panic: pad_findmy_pvn illegal flag bits 0x%" UVxf,
f8f98e0a
NC
932 (UV)flags);
933
e8b34487
BF
934 if (flags & padadd_UTF8_NAME) {
935 bool is_utf8 = TRUE;
936 namepv = (const char*)bytes_from_utf8((U8*)namepv, &namelen, &is_utf8);
937
938 if (is_utf8)
939 flags |= padadd_UTF8_NAME;
940 else
941 flags &= ~padadd_UTF8_NAME;
942 }
943
fbb889c8
BF
944 offset = pad_findlex(namepv, namelen, flags,
945 PL_compcv, PL_cop_seqmax, 1, NULL, &out_sv, &out_flags);
9f7d9405 946 if ((PADOFFSET)offset != NOT_IN_PAD)
929a0744
DM
947 return offset;
948
949 /* look for an our that's being introduced; this allows
950 * our $foo = 0 unless defined $foo;
951 * to not give a warning. (Yes, this is a hack) */
952
502c6561 953 nameav = MUTABLE_AV(AvARRAY(CvPADLIST(PL_compcv))[0]);
929a0744
DM
954 name_svp = AvARRAY(nameav);
955 for (offset = AvFILLp(nameav); offset > 0; offset--) {
551405c4 956 const SV * const namesv = name_svp[offset];
929a0744
DM
957 if (namesv && namesv != &PL_sv_undef
958 && !SvFAKE(namesv)
00b1698f 959 && (SvPAD_OUR(namesv))
cc76b5cc 960 && SvCUR(namesv) == namelen
e8b34487
BF
961 && sv_eq_pvn_flags(aTHX_ namesv, namepv, namelen,
962 flags & padadd_UTF8_NAME ? SVf_UTF8 : 0 )
2df5bdd7 963 && COP_SEQ_RANGE_LOW(namesv) == PERL_PADSEQ_INTRO
929a0744
DM
964 )
965 return offset;
966 }
967 return NOT_IN_PAD;
dd2155a4
DM
968}
969
e1f795dc 970/*
cc76b5cc
Z
971=for apidoc Am|PADOFFSET|pad_findmy_pv|const char *name|U32 flags
972
973Exactly like L</pad_findmy_pvn>, but takes a nul-terminated string
974instead of a string/length pair.
975
976=cut
977*/
978
979PADOFFSET
980Perl_pad_findmy_pv(pTHX_ const char *name, U32 flags)
981{
982 PERL_ARGS_ASSERT_PAD_FINDMY_PV;
983 return pad_findmy_pvn(name, strlen(name), flags);
984}
985
986/*
987=for apidoc Am|PADOFFSET|pad_findmy_sv|SV *name|U32 flags
988
989Exactly like L</pad_findmy_pvn>, but takes the name string in the form
990of an SV instead of a string/length pair.
991
992=cut
993*/
994
995PADOFFSET
996Perl_pad_findmy_sv(pTHX_ SV *name, U32 flags)
997{
998 char *namepv;
999 STRLEN namelen;
1000 PERL_ARGS_ASSERT_PAD_FINDMY_SV;
1001 namepv = SvPV(name, namelen);
2435e5d3
BF
1002 if (SvUTF8(name))
1003 flags |= padadd_UTF8_NAME;
cc76b5cc
Z
1004 return pad_findmy_pvn(namepv, namelen, flags);
1005}
1006
1007/*
1008=for apidoc Amp|PADOFFSET|find_rundefsvoffset
1009
1010Find the position of the lexical C<$_> in the pad of the
1011currently-executing function. Returns the offset in the current pad,
1012or C<NOT_IN_PAD> if there is no lexical C<$_> in scope (in which case
1013the global one should be used instead).
1014L</find_rundefsv> is likely to be more convenient.
1015
1016=cut
1017*/
e1f795dc
RGS
1018
1019PADOFFSET
29289021 1020Perl_find_rundefsvoffset(pTHX)
e1f795dc 1021{
97aff369 1022 dVAR;
e1f795dc
RGS
1023 SV *out_sv;
1024 int out_flags;
fbb889c8 1025 return pad_findlex("$_", 2, 0, find_runcv(NULL), PL_curcop->cop_seq, 1,
4608196e 1026 NULL, &out_sv, &out_flags);
e1f795dc 1027}
dd2155a4 1028
dd2155a4 1029/*
cc76b5cc
Z
1030=for apidoc Am|SV *|find_rundefsv
1031
1032Find and return the variable that is named C<$_> in the lexical scope
1033of the currently-executing function. This may be a lexical C<$_>,
1034or will otherwise be the global one.
1035
1036=cut
1037*/
789bd863
VP
1038
1039SV *
1040Perl_find_rundefsv(pTHX)
1041{
1042 SV *namesv;
1043 int flags;
1044 PADOFFSET po;
1045
fbb889c8 1046 po = pad_findlex("$_", 2, 0, find_runcv(NULL), PL_curcop->cop_seq, 1,
789bd863
VP
1047 NULL, &namesv, &flags);
1048
1979170b 1049 if (po == NOT_IN_PAD || SvPAD_OUR(namesv))
789bd863
VP
1050 return DEFSV;
1051
1052 return PAD_SVl(po);
1053}
1054
c086f97a
FC
1055SV *
1056Perl_find_rundefsv2(pTHX_ CV *cv, U32 seq)
1057{
1058 SV *namesv;
1059 int flags;
1060 PADOFFSET po;
1061
1062 PERL_ARGS_ASSERT_FIND_RUNDEFSV2;
1063
1064 po = pad_findlex("$_", 2, 0, cv, seq, 1,
1065 NULL, &namesv, &flags);
1066
1067 if (po == NOT_IN_PAD || SvPAD_OUR(namesv))
1068 return DEFSV;
1069
1070 return AvARRAY((PAD*) (AvARRAY(CvPADLIST(cv))[CvDEPTH(cv)]))[po];
1071}
1072
789bd863 1073/*
fbb889c8 1074=for apidoc m|PADOFFSET|pad_findlex|const char *namepv|STRLEN namelen|U32 flags|const CV* cv|U32 seq|int warn|SV** out_capture|SV** out_name_sv|int *out_flags
dd2155a4
DM
1075
1076Find a named lexical anywhere in a chain of nested pads. Add fake entries
b5c19bd7
DM
1077in the inner pads if it's found in an outer one.
1078
1079Returns the offset in the bottom pad of the lex or the fake lex.
1080cv is the CV in which to start the search, and seq is the current cop_seq
1081to match against. If warn is true, print appropriate warnings. The out_*
1082vars return values, and so are pointers to where the returned values
1083should be stored. out_capture, if non-null, requests that the innermost
1084instance of the lexical is captured; out_name_sv is set to the innermost
1085matched namesv or fake namesv; out_flags returns the flags normally
1086associated with the IVX field of a fake namesv.
1087
1088Note that pad_findlex() is recursive; it recurses up the chain of CVs,
1089then comes back down, adding fake entries as it goes. It has to be this way
3441fb63 1090because fake namesvs in anon protoypes have to store in xlow the index into
b5c19bd7 1091the parent pad.
dd2155a4
DM
1092
1093=cut
1094*/
1095
b5c19bd7
DM
1096/* the CV has finished being compiled. This is not a sufficient test for
1097 * all CVs (eg XSUBs), but suffices for the CVs found in a lexical chain */
1098#define CvCOMPILED(cv) CvROOT(cv)
1099
71f882da
DM
1100/* the CV does late binding of its lexicals */
1101#define CvLATE(cv) (CvANON(cv) || SvTYPE(cv) == SVt_PVFM)
1102
b5c19bd7 1103
dd2155a4 1104STATIC PADOFFSET
fbb889c8 1105S_pad_findlex(pTHX_ const char *namepv, STRLEN namelen, U32 flags, const CV* cv, U32 seq,
cc76b5cc 1106 int warn, SV** out_capture, SV** out_name_sv, int *out_flags)
dd2155a4 1107{
97aff369 1108 dVAR;
b5c19bd7
DM
1109 I32 offset, new_offset;
1110 SV *new_capture;
1111 SV **new_capturep;
b64e5050 1112 const AV * const padlist = CvPADLIST(cv);
dd2155a4 1113
7918f24d
NC
1114 PERL_ARGS_ASSERT_PAD_FINDLEX;
1115
2435e5d3
BF
1116 if (flags & ~padadd_UTF8_NAME)
1117 Perl_croak(aTHX_ "panic: pad_findlex illegal flag bits 0x%" UVxf,
1118 (UV)flags);
1119
b5c19bd7 1120 *out_flags = 0;
a3985cdc 1121
b5c19bd7 1122 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
cc76b5cc 1123 "Pad findlex cv=0x%"UVxf" searching \"%.*s\" seq=%d%s\n",
4c760560 1124 PTR2UV(cv), (int)namelen, namepv, (int)seq,
cc76b5cc 1125 out_capture ? " capturing" : "" ));
dd2155a4 1126
b5c19bd7 1127 /* first, search this pad */
dd2155a4 1128
b5c19bd7
DM
1129 if (padlist) { /* not an undef CV */
1130 I32 fake_offset = 0;
502c6561 1131 const AV * const nameav = MUTABLE_AV(AvARRAY(padlist)[0]);
551405c4 1132 SV * const * const name_svp = AvARRAY(nameav);
ee6cee0c 1133
b5c19bd7 1134 for (offset = AvFILLp(nameav); offset > 0; offset--) {
551405c4 1135 const SV * const namesv = name_svp[offset];
b5c19bd7 1136 if (namesv && namesv != &PL_sv_undef
cc76b5cc 1137 && SvCUR(namesv) == namelen
e8b34487
BF
1138 && sv_eq_pvn_flags(aTHX_ namesv, namepv, namelen,
1139 flags & padadd_UTF8_NAME ? SVf_UTF8 : 0))
b5c19bd7 1140 {
6012dc80 1141 if (SvFAKE(namesv)) {
b5c19bd7 1142 fake_offset = offset; /* in case we don't find a real one */
6012dc80
DM
1143 continue;
1144 }
1145 /* is seq within the range _LOW to _HIGH ?
1146 * This is complicated by the fact that PL_cop_seqmax
1147 * may have wrapped around at some point */
1148 if (COP_SEQ_RANGE_LOW(namesv) == PERL_PADSEQ_INTRO)
1149 continue; /* not yet introduced */
1150
1151 if (COP_SEQ_RANGE_HIGH(namesv) == PERL_PADSEQ_INTRO) {
1152 /* in compiling scope */
1153 if (
1154 (seq > COP_SEQ_RANGE_LOW(namesv))
1155 ? (seq - COP_SEQ_RANGE_LOW(namesv) < (U32_MAX >> 1))
1156 : (COP_SEQ_RANGE_LOW(namesv) - seq > (U32_MAX >> 1))
1157 )
1158 break;
1159 }
1160 else if (
1161 (COP_SEQ_RANGE_LOW(namesv) > COP_SEQ_RANGE_HIGH(namesv))
1162 ?
1163 ( seq > COP_SEQ_RANGE_LOW(namesv)
1164 || seq <= COP_SEQ_RANGE_HIGH(namesv))
1165
1166 : ( seq > COP_SEQ_RANGE_LOW(namesv)
1167 && seq <= COP_SEQ_RANGE_HIGH(namesv))
1168 )
1169 break;
ee6cee0c
DM
1170 }
1171 }
1172
b5c19bd7
DM
1173 if (offset > 0 || fake_offset > 0 ) { /* a match! */
1174 if (offset > 0) { /* not fake */
1175 fake_offset = 0;
1176 *out_name_sv = name_svp[offset]; /* return the namesv */
1177
1178 /* set PAD_FAKELEX_MULTI if this lex can have multiple
1179 * instances. For now, we just test !CvUNIQUE(cv), but
1180 * ideally, we should detect my's declared within loops
1181 * etc - this would allow a wider range of 'not stayed
486ec47a 1182 * shared' warnings. We also treated already-compiled
b5c19bd7
DM
1183 * lexes as not multi as viewed from evals. */
1184
1185 *out_flags = CvANON(cv) ?
1186 PAD_FAKELEX_ANON :
1187 (!CvUNIQUE(cv) && ! CvCOMPILED(cv))
1188 ? PAD_FAKELEX_MULTI : 0;
1189
1190 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
809abb02
NC
1191 "Pad findlex cv=0x%"UVxf" matched: offset=%ld (%lu,%lu)\n",
1192 PTR2UV(cv), (long)offset,
1193 (unsigned long)COP_SEQ_RANGE_LOW(*out_name_sv),
1194 (unsigned long)COP_SEQ_RANGE_HIGH(*out_name_sv)));
b5c19bd7
DM
1195 }
1196 else { /* fake match */
1197 offset = fake_offset;
1198 *out_name_sv = name_svp[offset]; /* return the namesv */
809abb02 1199 *out_flags = PARENT_FAKELEX_FLAGS(*out_name_sv);
b5c19bd7 1200 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
19a5c512 1201 "Pad findlex cv=0x%"UVxf" matched: offset=%ld flags=0x%lx index=%lu\n",
b5c19bd7 1202 PTR2UV(cv), (long)offset, (unsigned long)*out_flags,
809abb02 1203 (unsigned long) PARENT_PAD_INDEX(*out_name_sv)
b5c19bd7
DM
1204 ));
1205 }
dd2155a4 1206
b5c19bd7 1207 /* return the lex? */
dd2155a4 1208
b5c19bd7 1209 if (out_capture) {
dd2155a4 1210
b5c19bd7 1211 /* our ? */
00b1698f 1212 if (SvPAD_OUR(*out_name_sv)) {
a0714e2c 1213 *out_capture = NULL;
b5c19bd7
DM
1214 return offset;
1215 }
ee6cee0c 1216
b5c19bd7
DM
1217 /* trying to capture from an anon prototype? */
1218 if (CvCOMPILED(cv)
1219 ? CvANON(cv) && CvCLONE(cv) && !CvCLONED(cv)
1220 : *out_flags & PAD_FAKELEX_ANON)
1221 {
a2a5de95
NC
1222 if (warn)
1223 Perl_ck_warner(aTHX_ packWARN(WARN_CLOSURE),
0727928e
BF
1224 "Variable \"%"SVf"\" is not available",
1225 newSVpvn_flags(namepv, namelen,
1226 SVs_TEMP |
1227 (flags & padadd_UTF8_NAME ? SVf_UTF8 : 0)));
1228
a0714e2c 1229 *out_capture = NULL;
b5c19bd7 1230 }
ee6cee0c 1231
b5c19bd7
DM
1232 /* real value */
1233 else {
1234 int newwarn = warn;
1235 if (!CvCOMPILED(cv) && (*out_flags & PAD_FAKELEX_MULTI)
d1186544 1236 && !SvPAD_STATE(name_svp[offset])
b5c19bd7
DM
1237 && warn && ckWARN(WARN_CLOSURE)) {
1238 newwarn = 0;
1239 Perl_warner(aTHX_ packWARN(WARN_CLOSURE),
0727928e
BF
1240 "Variable \"%"SVf"\" will not stay shared",
1241 newSVpvn_flags(namepv, namelen,
1242 SVs_TEMP |
1243 (flags & padadd_UTF8_NAME ? SVf_UTF8 : 0)));
b5c19bd7 1244 }
dd2155a4 1245
b5c19bd7
DM
1246 if (fake_offset && CvANON(cv)
1247 && CvCLONE(cv) &&!CvCLONED(cv))
1248 {
1249 SV *n;
1250 /* not yet caught - look further up */
1251 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1252 "Pad findlex cv=0x%"UVxf" chasing lex in outer pad\n",
1253 PTR2UV(cv)));
1254 n = *out_name_sv;
fbb889c8 1255 (void) pad_findlex(namepv, namelen, flags, CvOUTSIDE(cv),
282e1742 1256 CvOUTSIDE_SEQ(cv),
b5c19bd7
DM
1257 newwarn, out_capture, out_name_sv, out_flags);
1258 *out_name_sv = n;
1259 return offset;
dd2155a4 1260 }
b5c19bd7 1261
502c6561
NC
1262 *out_capture = AvARRAY(MUTABLE_AV(AvARRAY(padlist)[
1263 CvDEPTH(cv) ? CvDEPTH(cv) : 1]))[offset];
b5c19bd7
DM
1264 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1265 "Pad findlex cv=0x%"UVxf" found lex=0x%"UVxf"\n",
19a5c512 1266 PTR2UV(cv), PTR2UV(*out_capture)));
b5c19bd7 1267
d1186544
DM
1268 if (SvPADSTALE(*out_capture)
1269 && !SvPAD_STATE(name_svp[offset]))
1270 {
a2a5de95 1271 Perl_ck_warner(aTHX_ packWARN(WARN_CLOSURE),
0727928e
BF
1272 "Variable \"%"SVf"\" is not available",
1273 newSVpvn_flags(namepv, namelen,
1274 SVs_TEMP |
1275 (flags & padadd_UTF8_NAME ? SVf_UTF8 : 0)));
a0714e2c 1276 *out_capture = NULL;
dd2155a4
DM
1277 }
1278 }
b5c19bd7 1279 if (!*out_capture) {
cc76b5cc 1280 if (namelen != 0 && *namepv == '@')
ad64d0ec 1281 *out_capture = sv_2mortal(MUTABLE_SV(newAV()));
cc76b5cc 1282 else if (namelen != 0 && *namepv == '%')
ad64d0ec 1283 *out_capture = sv_2mortal(MUTABLE_SV(newHV()));
b5c19bd7
DM
1284 else
1285 *out_capture = sv_newmortal();
1286 }
dd2155a4 1287 }
b5c19bd7
DM
1288
1289 return offset;
ee6cee0c 1290 }
b5c19bd7
DM
1291 }
1292
1293 /* it's not in this pad - try above */
1294
1295 if (!CvOUTSIDE(cv))
1296 return NOT_IN_PAD;
9f7d9405 1297
b5c19bd7 1298 /* out_capture non-null means caller wants us to capture lex; in
71f882da 1299 * addition we capture ourselves unless it's an ANON/format */
b5c19bd7 1300 new_capturep = out_capture ? out_capture :
4608196e 1301 CvLATE(cv) ? NULL : &new_capture;
b5c19bd7 1302
fbb889c8 1303 offset = pad_findlex(namepv, namelen, flags, CvOUTSIDE(cv), CvOUTSIDE_SEQ(cv), 1,
b5c19bd7 1304 new_capturep, out_name_sv, out_flags);
9f7d9405 1305 if ((PADOFFSET)offset == NOT_IN_PAD)
b5c19bd7 1306 return NOT_IN_PAD;
9f7d9405 1307
b5c19bd7
DM
1308 /* found in an outer CV. Add appropriate fake entry to this pad */
1309
1310 /* don't add new fake entries (via eval) to CVs that we have already
1311 * finished compiling, or to undef CVs */
1312 if (CvCOMPILED(cv) || !padlist)
1313 return 0; /* this dummy (and invalid) value isnt used by the caller */
1314
1315 {
3291825f 1316 /* This relies on sv_setsv_flags() upgrading the destination to the same
486ec47a 1317 type as the source, independent of the flags set, and on it being
3291825f
NC
1318 "good" and only copying flag bits and pointers that it understands.
1319 */
1320 SV *new_namesv = newSVsv(*out_name_sv);
53c1dcc0
AL
1321 AV * const ocomppad_name = PL_comppad_name;
1322 PAD * const ocomppad = PL_comppad;
502c6561
NC
1323 PL_comppad_name = MUTABLE_AV(AvARRAY(padlist)[0]);
1324 PL_comppad = MUTABLE_AV(AvARRAY(padlist)[1]);
b5c19bd7
DM
1325 PL_curpad = AvARRAY(PL_comppad);
1326
3291825f 1327 new_offset
cc76b5cc 1328 = pad_alloc_name(new_namesv,
59cfed7d 1329 (SvPAD_STATE(*out_name_sv) ? padadd_STATE : 0),
3291825f
NC
1330 SvPAD_TYPED(*out_name_sv)
1331 ? SvSTASH(*out_name_sv) : NULL,
1332 SvOURSTASH(*out_name_sv)
1333 );
1334
1335 SvFAKE_on(new_namesv);
1336 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1337 "Pad addname: %ld \"%.*s\" FAKE\n",
1338 (long)new_offset,
1339 (int) SvCUR(new_namesv), SvPVX(new_namesv)));
809abb02 1340 PARENT_FAKELEX_FLAGS_set(new_namesv, *out_flags);
b5c19bd7 1341
809abb02 1342 PARENT_PAD_INDEX_set(new_namesv, 0);
00b1698f 1343 if (SvPAD_OUR(new_namesv)) {
6f207bd3 1344 NOOP; /* do nothing */
b5c19bd7 1345 }
71f882da 1346 else if (CvLATE(cv)) {
b5c19bd7 1347 /* delayed creation - just note the offset within parent pad */
809abb02 1348 PARENT_PAD_INDEX_set(new_namesv, offset);
b5c19bd7
DM
1349 CvCLONE_on(cv);
1350 }
1351 else {
1352 /* immediate creation - capture outer value right now */
1353 av_store(PL_comppad, new_offset, SvREFCNT_inc(*new_capturep));
1354 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1355 "Pad findlex cv=0x%"UVxf" saved captured sv 0x%"UVxf" at offset %ld\n",
1356 PTR2UV(cv), PTR2UV(*new_capturep), (long)new_offset));
dd2155a4 1357 }
b5c19bd7 1358 *out_name_sv = new_namesv;
809abb02 1359 *out_flags = PARENT_FAKELEX_FLAGS(new_namesv);
b5c19bd7
DM
1360
1361 PL_comppad_name = ocomppad_name;
1362 PL_comppad = ocomppad;
4608196e 1363 PL_curpad = ocomppad ? AvARRAY(ocomppad) : NULL;
dd2155a4 1364 }
b5c19bd7 1365 return new_offset;
dd2155a4
DM
1366}
1367
fb8a9836 1368#ifdef DEBUGGING
cc76b5cc 1369
dd2155a4 1370/*
cc76b5cc 1371=for apidoc Am|SV *|pad_sv|PADOFFSET po
dd2155a4 1372
cc76b5cc 1373Get the value at offset I<po> in the current (compiling or executing) pad.
dd2155a4
DM
1374Use macro PAD_SV instead of calling this function directly.
1375
1376=cut
1377*/
1378
dd2155a4
DM
1379SV *
1380Perl_pad_sv(pTHX_ PADOFFSET po)
1381{
97aff369 1382 dVAR;
f3548bdc 1383 ASSERT_CURPAD_ACTIVE("pad_sv");
dd2155a4 1384
dd2155a4
DM
1385 if (!po)
1386 Perl_croak(aTHX_ "panic: pad_sv po");
dd2155a4
DM
1387 DEBUG_X(PerlIO_printf(Perl_debug_log,
1388 "Pad 0x%"UVxf"[0x%"UVxf"] sv: %ld sv=0x%"UVxf"\n",
f3548bdc 1389 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po, PTR2UV(PL_curpad[po]))
dd2155a4
DM
1390 );
1391 return PL_curpad[po];
1392}
1393
dd2155a4 1394/*
cc76b5cc 1395=for apidoc Am|void|pad_setsv|PADOFFSET po|SV *sv
dd2155a4 1396
cc76b5cc 1397Set the value at offset I<po> in the current (compiling or executing) pad.
dd2155a4
DM
1398Use the macro PAD_SETSV() rather than calling this function directly.
1399
1400=cut
1401*/
1402
dd2155a4
DM
1403void
1404Perl_pad_setsv(pTHX_ PADOFFSET po, SV* sv)
1405{
97aff369 1406 dVAR;
7918f24d
NC
1407
1408 PERL_ARGS_ASSERT_PAD_SETSV;
1409
f3548bdc 1410 ASSERT_CURPAD_ACTIVE("pad_setsv");
dd2155a4
DM
1411
1412 DEBUG_X(PerlIO_printf(Perl_debug_log,
1413 "Pad 0x%"UVxf"[0x%"UVxf"] setsv: %ld sv=0x%"UVxf"\n",
f3548bdc 1414 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po, PTR2UV(sv))
dd2155a4
DM
1415 );
1416 PL_curpad[po] = sv;
1417}
dd2155a4 1418
cc76b5cc 1419#endif /* DEBUGGING */
dd2155a4
DM
1420
1421/*
cc76b5cc 1422=for apidoc m|void|pad_block_start|int full
dd2155a4
DM
1423
1424Update the pad compilation state variables on entry to a new block
1425
1426=cut
1427*/
1428
1429/* XXX DAPM perhaps:
1430 * - integrate this in general state-saving routine ???
1431 * - combine with the state-saving going on in pad_new ???
1432 * - introduce a new SAVE type that does all this in one go ?
1433 */
1434
1435void
1436Perl_pad_block_start(pTHX_ int full)
1437{
97aff369 1438 dVAR;
f3548bdc 1439 ASSERT_CURPAD_ACTIVE("pad_block_start");
dd2155a4
DM
1440 SAVEI32(PL_comppad_name_floor);
1441 PL_comppad_name_floor = AvFILLp(PL_comppad_name);
1442 if (full)
1443 PL_comppad_name_fill = PL_comppad_name_floor;
1444 if (PL_comppad_name_floor < 0)
1445 PL_comppad_name_floor = 0;
1446 SAVEI32(PL_min_intro_pending);
1447 SAVEI32(PL_max_intro_pending);
1448 PL_min_intro_pending = 0;
1449 SAVEI32(PL_comppad_name_fill);
1450 SAVEI32(PL_padix_floor);
1451 PL_padix_floor = PL_padix;
1452 PL_pad_reset_pending = FALSE;
1453}
1454
dd2155a4 1455/*
cc76b5cc 1456=for apidoc m|U32|intro_my
dd2155a4 1457
bf954566
FC
1458"Introduce" my variables to visible status. This is called during parsing
1459at the end of each statement to make lexical variables visible to
1460subsequent statements.
dd2155a4
DM
1461
1462=cut
1463*/
1464
1465U32
1466Perl_intro_my(pTHX)
1467{
97aff369 1468 dVAR;
dd2155a4 1469 SV **svp;
dd2155a4 1470 I32 i;
6012dc80 1471 U32 seq;
dd2155a4 1472
f3548bdc 1473 ASSERT_CURPAD_ACTIVE("intro_my");
dd2155a4
DM
1474 if (! PL_min_intro_pending)
1475 return PL_cop_seqmax;
1476
1477 svp = AvARRAY(PL_comppad_name);
1478 for (i = PL_min_intro_pending; i <= PL_max_intro_pending; i++) {
53c1dcc0
AL
1479 SV * const sv = svp[i];
1480
0d311cdb
DM
1481 if (sv && sv != &PL_sv_undef && !SvFAKE(sv)
1482 && COP_SEQ_RANGE_LOW(sv) == PERL_PADSEQ_INTRO)
1483 {
2df5bdd7 1484 COP_SEQ_RANGE_HIGH_set(sv, PERL_PADSEQ_INTRO); /* Don't know scope end yet. */
809abb02 1485 COP_SEQ_RANGE_LOW_set(sv, PL_cop_seqmax);
dd2155a4 1486 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
809abb02 1487 "Pad intromy: %ld \"%s\", (%lu,%lu)\n",
b15aece3 1488 (long)i, SvPVX_const(sv),
809abb02
NC
1489 (unsigned long)COP_SEQ_RANGE_LOW(sv),
1490 (unsigned long)COP_SEQ_RANGE_HIGH(sv))
dd2155a4
DM
1491 );
1492 }
1493 }
6012dc80
DM
1494 seq = PL_cop_seqmax;
1495 PL_cop_seqmax++;
1496 if (PL_cop_seqmax == PERL_PADSEQ_INTRO) /* not a legal value */
1497 PL_cop_seqmax++;
dd2155a4
DM
1498 PL_min_intro_pending = 0;
1499 PL_comppad_name_fill = PL_max_intro_pending; /* Needn't search higher */
1500 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
6012dc80 1501 "Pad intromy: seq -> %ld\n", (long)(PL_cop_seqmax)));
dd2155a4 1502
6012dc80 1503 return seq;
dd2155a4
DM
1504}
1505
1506/*
cc76b5cc 1507=for apidoc m|void|pad_leavemy
dd2155a4
DM
1508
1509Cleanup at end of scope during compilation: set the max seq number for
1510lexicals in this scope and warn of any lexicals that never got introduced.
1511
1512=cut
1513*/
1514
1515void
1516Perl_pad_leavemy(pTHX)
1517{
97aff369 1518 dVAR;
dd2155a4 1519 I32 off;
551405c4 1520 SV * const * const svp = AvARRAY(PL_comppad_name);
dd2155a4
DM
1521
1522 PL_pad_reset_pending = FALSE;
1523
f3548bdc 1524 ASSERT_CURPAD_ACTIVE("pad_leavemy");
dd2155a4
DM
1525 if (PL_min_intro_pending && PL_comppad_name_fill < PL_min_intro_pending) {
1526 for (off = PL_max_intro_pending; off >= PL_min_intro_pending; off--) {
53c1dcc0 1527 const SV * const sv = svp[off];
9b387841
NC
1528 if (sv && sv != &PL_sv_undef && !SvFAKE(sv))
1529 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1530 "%"SVf" never introduced",
1531 SVfARG(sv));
dd2155a4
DM
1532 }
1533 }
1534 /* "Deintroduce" my variables that are leaving with this scope. */
1535 for (off = AvFILLp(PL_comppad_name); off > PL_comppad_name_fill; off--) {
53c1dcc0 1536 const SV * const sv = svp[off];
2df5bdd7
DM
1537 if (sv && sv != &PL_sv_undef && !SvFAKE(sv)
1538 && COP_SEQ_RANGE_HIGH(sv) == PERL_PADSEQ_INTRO)
1539 {
809abb02 1540 COP_SEQ_RANGE_HIGH_set(sv, PL_cop_seqmax);
dd2155a4 1541 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
809abb02 1542 "Pad leavemy: %ld \"%s\", (%lu,%lu)\n",
b15aece3 1543 (long)off, SvPVX_const(sv),
809abb02
NC
1544 (unsigned long)COP_SEQ_RANGE_LOW(sv),
1545 (unsigned long)COP_SEQ_RANGE_HIGH(sv))
dd2155a4
DM
1546 );
1547 }
1548 }
1549 PL_cop_seqmax++;
6012dc80
DM
1550 if (PL_cop_seqmax == PERL_PADSEQ_INTRO) /* not a legal value */
1551 PL_cop_seqmax++;
dd2155a4
DM
1552 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1553 "Pad leavemy: seq = %ld\n", (long)PL_cop_seqmax));
1554}
1555
dd2155a4 1556/*
cc76b5cc 1557=for apidoc m|void|pad_swipe|PADOFFSET po|bool refadjust
dd2155a4
DM
1558
1559Abandon the tmp in the current pad at offset po and replace with a
1560new one.
1561
1562=cut
1563*/
1564
1565void
1566Perl_pad_swipe(pTHX_ PADOFFSET po, bool refadjust)
1567{
97aff369 1568 dVAR;
f3548bdc 1569 ASSERT_CURPAD_LEGAL("pad_swipe");
dd2155a4
DM
1570 if (!PL_curpad)
1571 return;
1572 if (AvARRAY(PL_comppad) != PL_curpad)
5637ef5b
NC
1573 Perl_croak(aTHX_ "panic: pad_swipe curpad, %p!=%p",
1574 AvARRAY(PL_comppad), PL_curpad);
9100eeb1
Z
1575 if (!po || ((SSize_t)po) > AvFILLp(PL_comppad))
1576 Perl_croak(aTHX_ "panic: pad_swipe po=%ld, fill=%ld",
1577 (long)po, (long)AvFILLp(PL_comppad));
dd2155a4
DM
1578
1579 DEBUG_X(PerlIO_printf(Perl_debug_log,
1580 "Pad 0x%"UVxf"[0x%"UVxf"] swipe: %ld\n",
1581 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po));
1582
1583 if (PL_curpad[po])
1584 SvPADTMP_off(PL_curpad[po]);
1585 if (refadjust)
1586 SvREFCNT_dec(PL_curpad[po]);
1587
9ad9869c
DM
1588
1589 /* if pad tmps aren't shared between ops, then there's no need to
1590 * create a new tmp when an existing op is freed */
1591#ifdef USE_BROKEN_PAD_RESET
561b68a9 1592 PL_curpad[po] = newSV(0);
dd2155a4 1593 SvPADTMP_on(PL_curpad[po]);
9ad9869c
DM
1594#else
1595 PL_curpad[po] = &PL_sv_undef;
97bf4a8d 1596#endif
dd2155a4
DM
1597 if ((I32)po < PL_padix)
1598 PL_padix = po - 1;
1599}
1600
dd2155a4 1601/*
cc76b5cc 1602=for apidoc m|void|pad_reset
dd2155a4
DM
1603
1604Mark all the current temporaries for reuse
1605
1606=cut
1607*/
1608
1609/* XXX pad_reset() is currently disabled because it results in serious bugs.
1610 * It causes pad temp TARGs to be shared between OPs. Since TARGs are pushed
1611 * on the stack by OPs that use them, there are several ways to get an alias
1612 * to a shared TARG. Such an alias will change randomly and unpredictably.
1613 * We avoid doing this until we can think of a Better Way.
1614 * GSAR 97-10-29 */
1f676739 1615static void
82af08ae 1616S_pad_reset(pTHX)
dd2155a4 1617{
97aff369 1618 dVAR;
dd2155a4 1619#ifdef USE_BROKEN_PAD_RESET
dd2155a4 1620 if (AvARRAY(PL_comppad) != PL_curpad)
5637ef5b
NC
1621 Perl_croak(aTHX_ "panic: pad_reset curpad, %p!=%p",
1622 AvARRAY(PL_comppad), PL_curpad);
dd2155a4
DM
1623
1624 DEBUG_X(PerlIO_printf(Perl_debug_log,
1625 "Pad 0x%"UVxf"[0x%"UVxf"] reset: padix %ld -> %ld",
1626 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
1627 (long)PL_padix, (long)PL_padix_floor
1628 )
1629 );
1630
1631 if (!PL_tainting) { /* Can't mix tainted and non-tainted temporaries. */
e1ec3a88 1632 register I32 po;
dd2155a4
DM
1633 for (po = AvMAX(PL_comppad); po > PL_padix_floor; po--) {
1634 if (PL_curpad[po] && !SvIMMORTAL(PL_curpad[po]))
1635 SvPADTMP_off(PL_curpad[po]);
1636 }
1637 PL_padix = PL_padix_floor;
1638 }
1639#endif
1640 PL_pad_reset_pending = FALSE;
1641}
1642
dd2155a4 1643/*
cc76b5cc
Z
1644=for apidoc Amx|void|pad_tidy|padtidy_type type
1645
1646Tidy up a pad at the end of compilation of the code to which it belongs.
1647Jobs performed here are: remove most stuff from the pads of anonsub
1648prototypes; give it a @_; mark temporaries as such. I<type> indicates
1649the kind of subroutine:
dd2155a4 1650
cc76b5cc
Z
1651 padtidy_SUB ordinary subroutine
1652 padtidy_SUBCLONE prototype for lexical closure
1653 padtidy_FORMAT format
dd2155a4
DM
1654
1655=cut
1656*/
1657
1658/* XXX DAPM surely most of this stuff should be done properly
1659 * at the right time beforehand, rather than going around afterwards
1660 * cleaning up our mistakes ???
1661 */
1662
1663void
1664Perl_pad_tidy(pTHX_ padtidy_type type)
1665{
27da23d5 1666 dVAR;
dd2155a4 1667
f3548bdc 1668 ASSERT_CURPAD_ACTIVE("pad_tidy");
b5c19bd7
DM
1669
1670 /* If this CV has had any 'eval-capable' ops planted in it
1671 * (ie it contains eval '...', //ee, /$var/ or /(?{..})/), Then any
1672 * anon prototypes in the chain of CVs should be marked as cloneable,
1673 * so that for example the eval's CV in C<< sub { eval '$x' } >> gets
1674 * the right CvOUTSIDE.
1675 * If running with -d, *any* sub may potentially have an eval
486ec47a 1676 * executed within it.
b5c19bd7
DM
1677 */
1678
1679 if (PL_cv_has_eval || PL_perldb) {
e1ec3a88 1680 const CV *cv;
b5c19bd7
DM
1681 for (cv = PL_compcv ;cv; cv = CvOUTSIDE(cv)) {
1682 if (cv != PL_compcv && CvCOMPILED(cv))
1683 break; /* no need to mark already-compiled code */
1684 if (CvANON(cv)) {
1685 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1686 "Pad clone on cv=0x%"UVxf"\n", PTR2UV(cv)));
1687 CvCLONE_on(cv);
a0d2bbd5 1688 CvHASEVAL_on(cv);
b5c19bd7
DM
1689 }
1690 }
1691 }
1692
dd2155a4
DM
1693 /* extend curpad to match namepad */
1694 if (AvFILLp(PL_comppad_name) < AvFILLp(PL_comppad))
a0714e2c 1695 av_store(PL_comppad_name, AvFILLp(PL_comppad), NULL);
dd2155a4
DM
1696
1697 if (type == padtidy_SUBCLONE) {
551405c4 1698 SV * const * const namep = AvARRAY(PL_comppad_name);
504618e9 1699 PADOFFSET ix;
b5c19bd7 1700
dd2155a4
DM
1701 for (ix = AvFILLp(PL_comppad); ix > 0; ix--) {
1702 SV *namesv;
1703
1704 if (SvIMMORTAL(PL_curpad[ix]) || IS_PADGV(PL_curpad[ix]) || IS_PADCONST(PL_curpad[ix]))
1705 continue;
1706 /*
1707 * The only things that a clonable function needs in its
b5c19bd7 1708 * pad are anonymous subs.
dd2155a4
DM
1709 * The rest are created anew during cloning.
1710 */
a0714e2c 1711 if (!((namesv = namep[ix]) != NULL &&
dd2155a4 1712 namesv != &PL_sv_undef &&
b15aece3 1713 *SvPVX_const(namesv) == '&'))
dd2155a4
DM
1714 {
1715 SvREFCNT_dec(PL_curpad[ix]);
a0714e2c 1716 PL_curpad[ix] = NULL;
dd2155a4
DM
1717 }
1718 }
1719 }
1720 else if (type == padtidy_SUB) {
1721 /* XXX DAPM this same bit of code keeps appearing !!! Rationalise? */
53c1dcc0 1722 AV * const av = newAV(); /* Will be @_ */
ad64d0ec 1723 av_store(PL_comppad, 0, MUTABLE_SV(av));
11ca45c0 1724 AvREIFY_only(av);
dd2155a4
DM
1725 }
1726
4cee4ca8 1727 if (type == padtidy_SUB || type == padtidy_FORMAT) {
adf8f095 1728 SV * const * const namep = AvARRAY(PL_comppad_name);
504618e9 1729 PADOFFSET ix;
dd2155a4
DM
1730 for (ix = AvFILLp(PL_comppad); ix > 0; ix--) {
1731 if (SvIMMORTAL(PL_curpad[ix]) || IS_PADGV(PL_curpad[ix]) || IS_PADCONST(PL_curpad[ix]))
1732 continue;
adf8f095 1733 if (!SvPADMY(PL_curpad[ix])) {
dd2155a4 1734 SvPADTMP_on(PL_curpad[ix]);
adf8f095
NC
1735 } else if (!SvFAKE(namep[ix])) {
1736 /* This is a work around for how the current implementation of
1737 ?{ } blocks in regexps interacts with lexicals.
1738
1739 One of our lexicals.
1740 Can't do this on all lexicals, otherwise sub baz() won't
1741 compile in
1742
1743 my $foo;
1744
1745 sub bar { ++$foo; }
1746
1747 sub baz { ++$foo; }
1748
1749 because completion of compiling &bar calling pad_tidy()
1750 would cause (top level) $foo to be marked as stale, and
1751 "no longer available". */
1752 SvPADSTALE_on(PL_curpad[ix]);
1753 }
dd2155a4
DM
1754 }
1755 }
f3548bdc 1756 PL_curpad = AvARRAY(PL_comppad);
dd2155a4
DM
1757}
1758
dd2155a4 1759/*
cc76b5cc 1760=for apidoc m|void|pad_free|PADOFFSET po
dd2155a4 1761
8627550a 1762Free the SV at offset po in the current pad.
dd2155a4
DM
1763
1764=cut
1765*/
1766
1767/* XXX DAPM integrate with pad_swipe ???? */
1768void
1769Perl_pad_free(pTHX_ PADOFFSET po)
1770{
97aff369 1771 dVAR;
f3548bdc 1772 ASSERT_CURPAD_LEGAL("pad_free");
dd2155a4
DM
1773 if (!PL_curpad)
1774 return;
1775 if (AvARRAY(PL_comppad) != PL_curpad)
5637ef5b
NC
1776 Perl_croak(aTHX_ "panic: pad_free curpad, %p!=%p",
1777 AvARRAY(PL_comppad), PL_curpad);
dd2155a4
DM
1778 if (!po)
1779 Perl_croak(aTHX_ "panic: pad_free po");
1780
1781 DEBUG_X(PerlIO_printf(Perl_debug_log,
1782 "Pad 0x%"UVxf"[0x%"UVxf"] free: %ld\n",
1783 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po)
1784 );
1785
1786 if (PL_curpad[po] && PL_curpad[po] != &PL_sv_undef) {
9a214eec 1787 SvFLAGS(PL_curpad[po]) &= ~SVs_PADTMP; /* also clears SVs_PADSTALE */
dd2155a4
DM
1788 }
1789 if ((I32)po < PL_padix)
1790 PL_padix = po - 1;
1791}
1792
dd2155a4 1793/*
cc76b5cc 1794=for apidoc m|void|do_dump_pad|I32 level|PerlIO *file|PADLIST *padlist|int full
dd2155a4
DM
1795
1796Dump the contents of a padlist
1797
1798=cut
1799*/
1800
1801void
1802Perl_do_dump_pad(pTHX_ I32 level, PerlIO *file, PADLIST *padlist, int full)
1803{
97aff369 1804 dVAR;
e1ec3a88
AL
1805 const AV *pad_name;
1806 const AV *pad;
dd2155a4
DM
1807 SV **pname;
1808 SV **ppad;
dd2155a4
DM
1809 I32 ix;
1810
7918f24d
NC
1811 PERL_ARGS_ASSERT_DO_DUMP_PAD;
1812
dd2155a4
DM
1813 if (!padlist) {
1814 return;
1815 }
502c6561
NC
1816 pad_name = MUTABLE_AV(*av_fetch(MUTABLE_AV(padlist), 0, FALSE));
1817 pad = MUTABLE_AV(*av_fetch(MUTABLE_AV(padlist), 1, FALSE));
dd2155a4
DM
1818 pname = AvARRAY(pad_name);
1819 ppad = AvARRAY(pad);
1820 Perl_dump_indent(aTHX_ level, file,
1821 "PADNAME = 0x%"UVxf"(0x%"UVxf") PAD = 0x%"UVxf"(0x%"UVxf")\n",
1822 PTR2UV(pad_name), PTR2UV(pname), PTR2UV(pad), PTR2UV(ppad)
1823 );
1824
1825 for (ix = 1; ix <= AvFILLp(pad_name); ix++) {
e1ec3a88 1826 const SV *namesv = pname[ix];
dd2155a4 1827 if (namesv && namesv == &PL_sv_undef) {
a0714e2c 1828 namesv = NULL;
dd2155a4
DM
1829 }
1830 if (namesv) {
ee6cee0c
DM
1831 if (SvFAKE(namesv))
1832 Perl_dump_indent(aTHX_ level+1, file,
c0fd1b42 1833 "%2d. 0x%"UVxf"<%lu> FAKE \"%s\" flags=0x%lx index=%lu\n",
ee6cee0c
DM
1834 (int) ix,
1835 PTR2UV(ppad[ix]),
1836 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0),
b15aece3 1837 SvPVX_const(namesv),
809abb02
NC
1838 (unsigned long)PARENT_FAKELEX_FLAGS(namesv),
1839 (unsigned long)PARENT_PAD_INDEX(namesv)
b5c19bd7 1840
ee6cee0c
DM
1841 );
1842 else
1843 Perl_dump_indent(aTHX_ level+1, file,
809abb02 1844 "%2d. 0x%"UVxf"<%lu> (%lu,%lu) \"%s\"\n",
ee6cee0c
DM
1845 (int) ix,
1846 PTR2UV(ppad[ix]),
1847 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0),
809abb02
NC
1848 (unsigned long)COP_SEQ_RANGE_LOW(namesv),
1849 (unsigned long)COP_SEQ_RANGE_HIGH(namesv),
b15aece3 1850 SvPVX_const(namesv)
ee6cee0c 1851 );
dd2155a4
DM
1852 }
1853 else if (full) {
1854 Perl_dump_indent(aTHX_ level+1, file,
1855 "%2d. 0x%"UVxf"<%lu>\n",
1856 (int) ix,
1857 PTR2UV(ppad[ix]),
1858 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0)
1859 );
1860 }
1861 }
1862}
1863
cc76b5cc 1864#ifdef DEBUGGING
dd2155a4
DM
1865
1866/*
cc76b5cc 1867=for apidoc m|void|cv_dump|CV *cv|const char *title
dd2155a4
DM
1868
1869dump the contents of a CV
1870
1871=cut
1872*/
1873
dd2155a4 1874STATIC void
e1ec3a88 1875S_cv_dump(pTHX_ const CV *cv, const char *title)
dd2155a4 1876{
97aff369 1877 dVAR;
53c1dcc0
AL
1878 const CV * const outside = CvOUTSIDE(cv);
1879 AV* const padlist = CvPADLIST(cv);
dd2155a4 1880
7918f24d
NC
1881 PERL_ARGS_ASSERT_CV_DUMP;
1882
dd2155a4
DM
1883 PerlIO_printf(Perl_debug_log,
1884 " %s: CV=0x%"UVxf" (%s), OUTSIDE=0x%"UVxf" (%s)\n",
1885 title,
1886 PTR2UV(cv),
1887 (CvANON(cv) ? "ANON"
71f882da 1888 : (SvTYPE(cv) == SVt_PVFM) ? "FORMAT"
dd2155a4
DM
1889 : (cv == PL_main_cv) ? "MAIN"
1890 : CvUNIQUE(cv) ? "UNIQUE"
1891 : CvGV(cv) ? GvNAME(CvGV(cv)) : "UNDEFINED"),
1892 PTR2UV(outside),
1893 (!outside ? "null"
1894 : CvANON(outside) ? "ANON"
1895 : (outside == PL_main_cv) ? "MAIN"
1896 : CvUNIQUE(outside) ? "UNIQUE"
1897 : CvGV(outside) ? GvNAME(CvGV(outside)) : "UNDEFINED"));
1898
1899 PerlIO_printf(Perl_debug_log,
1900 " PADLIST = 0x%"UVxf"\n", PTR2UV(padlist));
1901 do_dump_pad(1, Perl_debug_log, padlist, 1);
1902}
dd2155a4 1903
cc76b5cc 1904#endif /* DEBUGGING */
dd2155a4
DM
1905
1906/*
cc76b5cc 1907=for apidoc Am|CV *|cv_clone|CV *proto
dd2155a4 1908
cc76b5cc
Z
1909Clone a CV, making a lexical closure. I<proto> supplies the prototype
1910of the function: its code, pad structure, and other attributes.
1911The prototype is combined with a capture of outer lexicals to which the
1912code refers, which are taken from the currently-executing instance of
1913the immediately surrounding code.
dd2155a4
DM
1914
1915=cut
1916*/
1917
1918CV *
1919Perl_cv_clone(pTHX_ CV *proto)
1920{
27da23d5 1921 dVAR;
dd2155a4 1922 I32 ix;
53c1dcc0 1923 AV* const protopadlist = CvPADLIST(proto);
502c6561
NC
1924 const AV *const protopad_name = (const AV *)*av_fetch(protopadlist, 0, FALSE);
1925 const AV *const protopad = (const AV *)*av_fetch(protopadlist, 1, FALSE);
53c1dcc0
AL
1926 SV** const pname = AvARRAY(protopad_name);
1927 SV** const ppad = AvARRAY(protopad);
e1ec3a88
AL
1928 const I32 fname = AvFILLp(protopad_name);
1929 const I32 fpad = AvFILLp(protopad);
dd2155a4 1930 CV* cv;
b5c19bd7
DM
1931 SV** outpad;
1932 CV* outside;
71f882da 1933 long depth;
dd2155a4 1934
7918f24d
NC
1935 PERL_ARGS_ASSERT_CV_CLONE;
1936
dd2155a4
DM
1937 assert(!CvUNIQUE(proto));
1938
1b5aaca6
FC
1939 /* Anonymous subs have a weak CvOUTSIDE pointer, so its value is not
1940 * reliable. The currently-running sub is always the one we need to
1941 * close over.
1942 * Note that in general for formats, CvOUTSIDE != find_runcv.
1943 * Since formats may be nested inside closures, CvOUTSIDE may point
71f882da 1944 * to a prototype; we instead want the cloned parent who called us.
af41786f 1945 */
71f882da 1946
5dff782d 1947 if (SvTYPE(proto) == SVt_PVCV)
71f882da 1948 outside = find_runcv(NULL);
5dff782d 1949 else {
af41786f 1950 outside = CvOUTSIDE(proto);
5dff782d 1951 if (CvCLONE(outside) && ! CvCLONED(outside)) {
70794f7b
FC
1952 CV * const runcv = find_runcv_where(
1953 FIND_RUNCV_root_eq, (void *)CvROOT(outside), NULL
1954 );
1955 if (runcv) outside = runcv;
5dff782d
FC
1956 }
1957 }
71f882da
DM
1958 depth = CvDEPTH(outside);
1959 assert(depth || SvTYPE(proto) == SVt_PVFM);
1960 if (!depth)
1961 depth = 1;
f2ead8b8 1962 assert(CvPADLIST(outside) || SvTYPE(proto) == SVt_PVFM);
b5c19bd7 1963
dd2155a4
DM
1964 ENTER;
1965 SAVESPTR(PL_compcv);
1966
ea726b52 1967 cv = PL_compcv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
8be227ab
FC
1968 CvFLAGS(cv) = CvFLAGS(proto) & ~(CVf_CLONE|CVf_WEAKOUTSIDE|CVf_CVGV_RC
1969 |CVf_SLABBED);
dd2155a4
DM
1970 CvCLONED_on(cv);
1971
bad4ae38
FC
1972 CvFILE(cv) = CvDYNFILE(proto) ? savepv(CvFILE(proto))
1973 : CvFILE(proto);
b3f91e91 1974 CvGV_set(cv,CvGV(proto));
c68d9564 1975 CvSTASH_set(cv, CvSTASH(proto));
b34c0dd4 1976 OP_REFCNT_LOCK;
dd2155a4 1977 CvROOT(cv) = OpREFCNT_inc(CvROOT(proto));
b34c0dd4 1978 OP_REFCNT_UNLOCK;
dd2155a4 1979 CvSTART(cv) = CvSTART(proto);
a0d2bbd5
FC
1980 if (CvHASEVAL(cv))
1981 CvOUTSIDE(cv) = MUTABLE_CV(SvREFCNT_inc_simple(outside));
b5c19bd7 1982 CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
dd2155a4
DM
1983
1984 if (SvPOK(proto))
ad64d0ec 1985 sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
09fb282d
FC
1986 if (SvMAGIC(proto))
1987 mg_copy((SV *)proto, (SV *)cv, 0, 0);
dd2155a4 1988
b7787f18 1989 CvPADLIST(cv) = pad_new(padnew_CLONE|padnew_SAVE);
dd2155a4 1990
b5c19bd7 1991 av_fill(PL_comppad, fpad);
7aaef02a 1992 for (ix = fname; ix > 0; ix--)
dd2155a4
DM
1993 av_store(PL_comppad_name, ix, SvREFCNT_inc(pname[ix]));
1994
dd2155a4
DM
1995 PL_curpad = AvARRAY(PL_comppad);
1996
f2ead8b8
FC
1997 outpad = CvPADLIST(outside)
1998 ? AvARRAY(AvARRAY(CvPADLIST(outside))[depth])
1999 : NULL;
b5c19bd7 2000
dd2155a4 2001 for (ix = fpad; ix > 0; ix--) {
a0714e2c
SS
2002 SV* const namesv = (ix <= fname) ? pname[ix] : NULL;
2003 SV *sv = NULL;
71f882da 2004 if (namesv && namesv != &PL_sv_undef) { /* lexical */
b5c19bd7 2005 if (SvFAKE(namesv)) { /* lexical from outside? */
f2ead8b8 2006 /* formats may have an inactive, or even undefined, parent,
33894c1a 2007 while my $x if $false can leave an active var marked as
d1186544 2008 stale. And state vars are always available */
f2ead8b8
FC
2009 if (!outpad || !(sv = outpad[PARENT_PAD_INDEX(namesv)])
2010 || (SvPADSTALE(sv) && !SvPAD_STATE(namesv))) {
a2a5de95 2011 Perl_ck_warner(aTHX_ packWARN(WARN_CLOSURE),
0727928e 2012 "Variable \"%"SVf"\" is not available", namesv);
a0714e2c 2013 sv = NULL;
71f882da 2014 }
33894c1a 2015 else
f84c484e 2016 SvREFCNT_inc_simple_void_NN(sv);
dd2155a4 2017 }
71f882da 2018 if (!sv) {
b15aece3 2019 const char sigil = SvPVX_const(namesv)[0];
e1ec3a88 2020 if (sigil == '&')
dd2155a4 2021 sv = SvREFCNT_inc(ppad[ix]);
e1ec3a88 2022 else if (sigil == '@')
ad64d0ec 2023 sv = MUTABLE_SV(newAV());
e1ec3a88 2024 else if (sigil == '%')
ad64d0ec 2025 sv = MUTABLE_SV(newHV());
dd2155a4 2026 else
561b68a9 2027 sv = newSV(0);
235cc2e3 2028 SvPADMY_on(sv);
0d3b281c
DM
2029 /* reset the 'assign only once' flag on each state var */
2030 if (SvPAD_STATE(namesv))
2031 SvPADSTALE_on(sv);
dd2155a4
DM
2032 }
2033 }
2034 else if (IS_PADGV(ppad[ix]) || IS_PADCONST(ppad[ix])) {
f84c484e 2035 sv = SvREFCNT_inc_NN(ppad[ix]);
dd2155a4
DM
2036 }
2037 else {
561b68a9 2038 sv = newSV(0);
dd2155a4 2039 SvPADTMP_on(sv);
dd2155a4 2040 }
71f882da 2041 PL_curpad[ix] = sv;
dd2155a4
DM
2042 }
2043
dd2155a4
DM
2044 DEBUG_Xv(
2045 PerlIO_printf(Perl_debug_log, "\nPad CV clone\n");
2046 cv_dump(outside, "Outside");
2047 cv_dump(proto, "Proto");
2048 cv_dump(cv, "To");
2049 );
2050
2051 LEAVE;
2052
2053 if (CvCONST(cv)) {
b5c19bd7
DM
2054 /* Constant sub () { $x } closing over $x - see lib/constant.pm:
2055 * The prototype was marked as a candiate for const-ization,
2056 * so try to grab the current const value, and if successful,
2057 * turn into a const sub:
2058 */
551405c4 2059 SV* const const_sv = op_const_sv(CvSTART(cv), cv);
b5c19bd7
DM
2060 if (const_sv) {
2061 SvREFCNT_dec(cv);
bd61b366 2062 cv = newCONSTSUB(CvSTASH(proto), NULL, const_sv);
b5c19bd7
DM
2063 }
2064 else {
2065 CvCONST_off(cv);
2066 }
dd2155a4
DM
2067 }
2068
2069 return cv;
2070}
2071
dd2155a4 2072/*
cc76b5cc 2073=for apidoc m|void|pad_fixup_inner_anons|PADLIST *padlist|CV *old_cv|CV *new_cv
dd2155a4
DM
2074
2075For any anon CVs in the pad, change CvOUTSIDE of that CV from
7dafbf52
DM
2076old_cv to new_cv if necessary. Needed when a newly-compiled CV has to be
2077moved to a pre-existing CV struct.
dd2155a4
DM
2078
2079=cut
2080*/
2081
2082void
2083Perl_pad_fixup_inner_anons(pTHX_ PADLIST *padlist, CV *old_cv, CV *new_cv)
2084{
97aff369 2085 dVAR;
dd2155a4 2086 I32 ix;
502c6561
NC
2087 AV * const comppad_name = MUTABLE_AV(AvARRAY(padlist)[0]);
2088 AV * const comppad = MUTABLE_AV(AvARRAY(padlist)[1]);
53c1dcc0
AL
2089 SV ** const namepad = AvARRAY(comppad_name);
2090 SV ** const curpad = AvARRAY(comppad);
7918f24d
NC
2091
2092 PERL_ARGS_ASSERT_PAD_FIXUP_INNER_ANONS;
294a48e9
AL
2093 PERL_UNUSED_ARG(old_cv);
2094
dd2155a4 2095 for (ix = AvFILLp(comppad_name); ix > 0; ix--) {
551405c4 2096 const SV * const namesv = namepad[ix];
dd2155a4 2097 if (namesv && namesv != &PL_sv_undef
b15aece3 2098 && *SvPVX_const(namesv) == '&')
dd2155a4 2099 {
e09ac076 2100 if (SvTYPE(curpad[ix]) == SVt_PVCV) {
ea726b52 2101 CV * const innercv = MUTABLE_CV(curpad[ix]);
7dafbf52
DM
2102 assert(CvWEAKOUTSIDE(innercv));
2103 assert(CvOUTSIDE(innercv) == old_cv);
2104 CvOUTSIDE(innercv) = new_cv;
e09ac076
FC
2105 }
2106 else { /* format reference */
2107 SV * const rv = curpad[ix];
2108 CV *innercv;
2109 if (!SvOK(rv)) continue;
2110 assert(SvROK(rv));
2111 assert(SvWEAKREF(rv));
2112 innercv = (CV *)SvRV(rv);
2113 assert(!CvWEAKOUTSIDE(innercv));
2114 SvREFCNT_dec(CvOUTSIDE(innercv));
2115 CvOUTSIDE(innercv) = (CV *)SvREFCNT_inc_simple_NN(new_cv);
2116 }
dd2155a4
DM
2117 }
2118 }
2119}
2120
2121/*
cc76b5cc 2122=for apidoc m|void|pad_push|PADLIST *padlist|int depth
dd2155a4
DM
2123
2124Push a new pad frame onto the padlist, unless there's already a pad at
26019298
AL
2125this depth, in which case don't bother creating a new one. Then give
2126the new pad an @_ in slot zero.
dd2155a4
DM
2127
2128=cut
2129*/
2130
2131void
26019298 2132Perl_pad_push(pTHX_ PADLIST *padlist, int depth)
dd2155a4 2133{
97aff369 2134 dVAR;
7918f24d
NC
2135
2136 PERL_ARGS_ASSERT_PAD_PUSH;
2137
b37c2d43 2138 if (depth > AvFILLp(padlist)) {
44f8325f
AL
2139 SV** const svp = AvARRAY(padlist);
2140 AV* const newpad = newAV();
2141 SV** const oldpad = AvARRAY(svp[depth-1]);
502c6561
NC
2142 I32 ix = AvFILLp((const AV *)svp[1]);
2143 const I32 names_fill = AvFILLp((const AV *)svp[0]);
44f8325f 2144 SV** const names = AvARRAY(svp[0]);
26019298
AL
2145 AV *av;
2146
dd2155a4
DM
2147 for ( ;ix > 0; ix--) {
2148 if (names_fill >= ix && names[ix] != &PL_sv_undef) {
b15aece3 2149 const char sigil = SvPVX_const(names[ix])[0];
fda94784
RGS
2150 if ((SvFLAGS(names[ix]) & SVf_FAKE)
2151 || (SvFLAGS(names[ix]) & SVpad_STATE)
2152 || sigil == '&')
2153 {
dd2155a4
DM
2154 /* outer lexical or anon code */
2155 av_store(newpad, ix, SvREFCNT_inc(oldpad[ix]));
2156 }
2157 else { /* our own lexical */
26019298
AL
2158 SV *sv;
2159 if (sigil == '@')
ad64d0ec 2160 sv = MUTABLE_SV(newAV());
26019298 2161 else if (sigil == '%')
ad64d0ec 2162 sv = MUTABLE_SV(newHV());
dd2155a4 2163 else
561b68a9 2164 sv = newSV(0);
26019298 2165 av_store(newpad, ix, sv);
dd2155a4
DM
2166 SvPADMY_on(sv);
2167 }
2168 }
2169 else if (IS_PADGV(oldpad[ix]) || IS_PADCONST(oldpad[ix])) {
f84c484e 2170 av_store(newpad, ix, SvREFCNT_inc_NN(oldpad[ix]));
dd2155a4
DM
2171 }
2172 else {
2173 /* save temporaries on recursion? */
561b68a9 2174 SV * const sv = newSV(0);
26019298 2175 av_store(newpad, ix, sv);
dd2155a4
DM
2176 SvPADTMP_on(sv);
2177 }
2178 }
26019298 2179 av = newAV();
ad64d0ec 2180 av_store(newpad, 0, MUTABLE_SV(av));
11ca45c0 2181 AvREIFY_only(av);
26019298 2182
ad64d0ec 2183 av_store(padlist, depth, MUTABLE_SV(newpad));
dd2155a4
DM
2184 AvFILLp(padlist) = depth;
2185 }
2186}
b21dc031 2187
cc76b5cc
Z
2188/*
2189=for apidoc Am|HV *|pad_compname_type|PADOFFSET po
2190
2191Looks up the type of the lexical variable at position I<po> in the
2192currently-compiling pad. If the variable is typed, the stash of the
2193class to which it is typed is returned. If not, C<NULL> is returned.
2194
2195=cut
2196*/
b21dc031
AL
2197
2198HV *
2199Perl_pad_compname_type(pTHX_ const PADOFFSET po)
2200{
97aff369 2201 dVAR;
551405c4 2202 SV* const * const av = av_fetch(PL_comppad_name, po, FALSE);
00b1698f 2203 if ( SvPAD_TYPED(*av) ) {
b21dc031
AL
2204 return SvSTASH(*av);
2205 }
5c284bb0 2206 return NULL;
b21dc031 2207}
66610fdd 2208
d5b1589c
NC
2209#if defined(USE_ITHREADS)
2210
2211# define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
2212
cc76b5cc
Z
2213/*
2214=for apidoc m|AV *|padlist_dup|AV *srcpad|CLONE_PARAMS *param
2215
2216Duplicates a pad.
2217
2218=cut
2219*/
2220
d5b1589c 2221AV *
cc76b5cc 2222Perl_padlist_dup(pTHX_ AV *srcpad, CLONE_PARAMS *param)
d5b1589c
NC
2223{
2224 AV *dstpad;
2225 PERL_ARGS_ASSERT_PADLIST_DUP;
2226
2227 if (!srcpad)
2228 return NULL;
2229
6de654a5
NC
2230 if (param->flags & CLONEf_COPY_STACKS
2231 || SvREFCNT(AvARRAY(srcpad)[1]) > 1) {
6de654a5 2232 dstpad = av_dup_inc(srcpad, param);
6de654a5
NC
2233 assert (SvREFCNT(AvARRAY(srcpad)[1]) == 1);
2234 } else {
2235 /* CvDEPTH() on our subroutine will be set to 0, so there's no need
2236 to build anything other than the first level of pads. */
2237
2238 I32 ix = AvFILLp((const AV *)AvARRAY(srcpad)[1]);
2239 AV *pad1;
05d04d9c 2240 const I32 names_fill = AvFILLp((const AV *)(AvARRAY(srcpad)[0]));
6de654a5
NC
2241 const AV *const srcpad1 = (const AV *) AvARRAY(srcpad)[1];
2242 SV **oldpad = AvARRAY(srcpad1);
2243 SV **names;
2244 SV **pad1a;
2245 AV *args;
7d953ba8
FC
2246 /* Look for it in the table first, as the padlist may have ended up
2247 as an element of @DB::args (or theoretically even @_), so it may
104a8185 2248 may have been cloned already. */
6de654a5
NC
2249 dstpad = (AV*)ptr_table_fetch(PL_ptr_table, srcpad);
2250
2251 if (dstpad)
7d953ba8 2252 return (AV *)SvREFCNT_inc_simple_NN(dstpad);
6de654a5
NC
2253
2254 dstpad = newAV();
2255 ptr_table_store(PL_ptr_table, srcpad, dstpad);
6de654a5
NC
2256 av_extend(dstpad, 1);
2257 AvARRAY(dstpad)[0] = MUTABLE_SV(av_dup_inc(AvARRAY(srcpad)[0], param));
2258 names = AvARRAY(AvARRAY(dstpad)[0]);
2259
2260 pad1 = newAV();
2261
2262 av_extend(pad1, ix);
2263 AvARRAY(dstpad)[1] = MUTABLE_SV(pad1);
2264 pad1a = AvARRAY(pad1);
2265 AvFILLp(dstpad) = 1;
2266
2267 if (ix > -1) {
2268 AvFILLp(pad1) = ix;
2269
2270 for ( ;ix > 0; ix--) {
05d04d9c
NC
2271 if (!oldpad[ix]) {
2272 pad1a[ix] = NULL;
2273 } else if (names_fill >= ix && names[ix] != &PL_sv_undef) {
2274 const char sigil = SvPVX_const(names[ix])[0];
2275 if ((SvFLAGS(names[ix]) & SVf_FAKE)
2276 || (SvFLAGS(names[ix]) & SVpad_STATE)
2277 || sigil == '&')
2278 {
2279 /* outer lexical or anon code */
2280 pad1a[ix] = sv_dup_inc(oldpad[ix], param);
2281 }
2282 else { /* our own lexical */
adf8f095
NC
2283 if(SvPADSTALE(oldpad[ix]) && SvREFCNT(oldpad[ix]) > 1) {
2284 /* This is a work around for how the current
2285 implementation of ?{ } blocks in regexps
2286 interacts with lexicals. */
05d04d9c
NC
2287 pad1a[ix] = sv_dup_inc(oldpad[ix], param);
2288 } else {
2289 SV *sv;
2290
2291 if (sigil == '@')
2292 sv = MUTABLE_SV(newAV());
2293 else if (sigil == '%')
2294 sv = MUTABLE_SV(newHV());
2295 else
2296 sv = newSV(0);
2297 pad1a[ix] = sv;
2298 SvPADMY_on(sv);
2299 }
2300 }
2301 }
2302 else if (IS_PADGV(oldpad[ix]) || IS_PADCONST(oldpad[ix])) {
2303 pad1a[ix] = sv_dup_inc(oldpad[ix], param);
2304 }
2305 else {
2306 /* save temporaries on recursion? */
2307 SV * const sv = newSV(0);
2308 pad1a[ix] = sv;
2309
2310 /* SvREFCNT(oldpad[ix]) != 1 for some code in threads.xs
2311 FIXTHAT before merging this branch.
2312 (And I know how to) */
2313 if (SvPADMY(oldpad[ix]))
2314 SvPADMY_on(sv);
2315 else
2316 SvPADTMP_on(sv);
2317 }
6de654a5
NC
2318 }
2319
2320 if (oldpad[0]) {
2321 args = newAV(); /* Will be @_ */
2322 AvREIFY_only(args);
2323 pad1a[0] = (SV *)args;
2324 }
2325 }
2326 }
d5b1589c
NC
2327
2328 return dstpad;
2329}
2330
cc76b5cc 2331#endif /* USE_ITHREADS */
d5b1589c 2332
66610fdd
RGS
2333/*
2334 * Local variables:
2335 * c-indentation-style: bsd
2336 * c-basic-offset: 4
14d04a33 2337 * indent-tabs-mode: nil
66610fdd
RGS
2338 * End:
2339 *
14d04a33 2340 * ex: set ts=8 sts=4 sw=4 et:
37442d52 2341 */