3 * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008
4 * by Larry Wall and others
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.
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
18 * [p.23 of _The Lord of the Rings_, I/i: "A Long-Expected Party"]
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.
28 =head1 Pad Data Structures
30 This file contains the functions that create and manipulate scratchpads,
31 which are array-of-array data structures attached to a CV (ie a sub)
32 and which store lexical variables and opcode temporary and per-thread
35 =for apidoc m|AV *|CvPADLIST|CV *cv
36 CV's can have CvPADLIST(cv) set to point to an AV.
38 For these purposes "forms" are a kind-of CV, eval""s are too (except they're
39 not callable at will and are always thrown away after the eval"" is done
40 executing). Require'd files are simply evals without any outer lexical
43 XSUBs don't have CvPADLIST set - dXSTARG fetches values from PL_curpad,
44 but that is really the callers pad (a slot of which is allocated by
47 The CvPADLIST AV has does not have AvREAL set, so REFCNT of component items
48 is managed "manual" (mostly in pad.c) rather than normal av.c rules.
49 The items in the AV are not SVs as for a normal AV, but other AVs:
51 0'th Entry of the CvPADLIST is an AV which represents the "names" or rather
52 the "static type information" for lexicals.
54 The CvDEPTH'th entry of CvPADLIST AV is an AV which is the stack frame at that
55 depth of recursion into the CV.
56 The 0'th slot of a frame AV is an AV which is @_.
57 other entries are storage for variables and op targets.
60 C<PL_comppad_name> is set to the names AV.
61 C<PL_comppad> is set to the frame AV for the frame CvDEPTH == 1.
62 C<PL_curpad> is set to the body of the frame AV (i.e. AvARRAY(PL_comppad)).
64 During execution, C<PL_comppad> and C<PL_curpad> refer to the live
65 frame of the currently executing sub.
67 Iterating over the names AV iterates over all possible pad
68 items. Pad slots that are SVs_PADTMP (targets/GVs/constants) end up having
69 &PL_sv_undef "names" (see pad_alloc()).
71 Only my/our variable (SVs_PADMY/SVs_PADOUR) slots get valid names.
72 The rest are op targets/GVs/constants which are statically allocated
73 or resolved at compile time. These don't have names by which they
74 can be looked up from Perl code at run time through eval"" like
75 my/our variables can be. Since they can't be looked up by "name"
76 but only by their index allocated at compile time (which is usually
77 in PL_op->op_targ), wasting a name SV for them doesn't make sense.
79 The SVs in the names AV have their PV being the name of the variable.
80 xlow+1..xhigh inclusive in the NV union is a range of cop_seq numbers for
81 which the name is valid. For typed lexicals name SV is SVt_PVMG and SvSTASH
82 points at the type. For C<our> lexicals, the type is also SVt_PVMG, with the
83 SvOURSTASH slot pointing at the stash of the associated global (so that
84 duplicate C<our> declarations in the same package can be detected). SvUVX is
85 sometimes hijacked to store the generation number during compilation.
87 If SvFAKE is set on the name SV, then that slot in the frame AV is
88 a REFCNT'ed reference to a lexical from "outside". In this case,
89 the name SV does not use xlow and xhigh to store a cop_seq range, since it is
90 in scope throughout. Instead xhigh stores some flags containing info about
91 the real lexical (is it declared in an anon, and is it capable of being
92 instantiated multiple times?), and for fake ANONs, xlow contains the index
93 within the parent's pad where the lexical's value is stored, to make
96 If the 'name' is '&' the corresponding entry in frame AV
97 is a CV representing a possible closure.
98 (SvFAKE and name of '&' is not a meaningful combination currently but could
99 become so if C<my sub foo {}> is implemented.)
101 Note that formats are treated as anon subs, and are cloned each time
102 write is called (if necessary).
104 The flag SVs_PADSTALE is cleared on lexicals each time the my() is executed,
105 and set on scope exit. This allows the 'Variable $x is not available' warning
106 to be generated in evals, such as
108 { my $x = 1; sub f { eval '$x'} } f();
110 For state vars, SVs_PADSTALE is overloaded to mean 'not yet initialised'
117 #define PERL_IN_PAD_C
119 #include "keywords.h"
121 #define COP_SEQ_RANGE_LOW_set(sv,val) \
122 STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xlow = (val); } STMT_END
123 #define COP_SEQ_RANGE_HIGH_set(sv,val) \
124 STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xhigh = (val); } STMT_END
126 #define PARENT_PAD_INDEX_set(sv,val) \
127 STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xlow = (val); } STMT_END
128 #define PARENT_FAKELEX_FLAGS_set(sv,val) \
129 STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xhigh = (val); } STMT_END
131 #define PAD_MAX I32_MAX
134 void pad_peg(const char* s) {
135 static int pegcnt; /* XXX not threadsafe */
138 PERL_ARGS_ASSERT_PAD_PEG;
147 Create a new compiling padlist, saving and updating the various global
148 vars at the same time as creating the pad itself. The following flags
149 can be OR'ed together:
151 padnew_CLONE this pad is for a cloned CV
152 padnew_SAVE save old globals
153 padnew_SAVESUB also save extra stuff for start of sub
159 Perl_pad_new(pTHX_ int flags)
162 AV *padlist, *padname, *pad;
164 ASSERT_CURPAD_LEGAL("pad_new");
166 /* XXX DAPM really need a new SAVEt_PAD which restores all or most
167 * vars (based on flags) rather than storing vals + addresses for
168 * each individually. Also see pad_block_start.
169 * XXX DAPM Try to see whether all these conditionals are required
172 /* save existing state, ... */
174 if (flags & padnew_SAVE) {
176 SAVESPTR(PL_comppad_name);
177 if (! (flags & padnew_CLONE)) {
179 SAVEI32(PL_comppad_name_fill);
180 SAVEI32(PL_min_intro_pending);
181 SAVEI32(PL_max_intro_pending);
182 SAVEBOOL(PL_cv_has_eval);
183 if (flags & padnew_SAVESUB) {
184 SAVEBOOL(PL_pad_reset_pending);
188 /* XXX DAPM interestingly, PL_comppad_name_floor never seems to be
189 * saved - check at some pt that this is okay */
191 /* ... create new pad ... */
197 if (flags & padnew_CLONE) {
198 /* XXX DAPM I dont know why cv_clone needs it
199 * doing differently yet - perhaps this separate branch can be
200 * dispensed with eventually ???
203 AV * const a0 = newAV(); /* will be @_ */
204 av_store(pad, 0, MUTABLE_SV(a0));
208 av_store(pad, 0, NULL);
212 av_store(padlist, 0, MUTABLE_SV(padname));
213 av_store(padlist, 1, MUTABLE_SV(pad));
215 /* ... then update state variables */
217 PL_comppad_name = MUTABLE_AV((*av_fetch(padlist, 0, FALSE)));
218 PL_comppad = MUTABLE_AV((*av_fetch(padlist, 1, FALSE)));
219 PL_curpad = AvARRAY(PL_comppad);
221 if (! (flags & padnew_CLONE)) {
222 PL_comppad_name_fill = 0;
223 PL_min_intro_pending = 0;
228 DEBUG_X(PerlIO_printf(Perl_debug_log,
229 "Pad 0x%"UVxf"[0x%"UVxf"] new: compcv=0x%"UVxf
230 " name=0x%"UVxf" flags=0x%"UVxf"\n",
231 PTR2UV(PL_comppad), PTR2UV(PL_curpad), PTR2UV(PL_compcv),
232 PTR2UV(padname), (UV)flags
236 return (PADLIST*)padlist;
240 =for apidoc pad_undef
242 Free the padlist associated with a CV.
243 If parts of it happen to be current, we null the relevant
244 PL_*pad* global vars so that we don't have any dangling references left.
245 We also repoint the CvOUTSIDE of any about-to-be-orphaned
246 inner subs to the outer of this cv.
248 (This function should really be called pad_free, but the name was already
255 Perl_pad_undef(pTHX_ CV* cv)
259 const PADLIST * const padlist = CvPADLIST(cv);
261 PERL_ARGS_ASSERT_PAD_UNDEF;
263 pad_peg("pad_undef");
266 if (SvIS_FREED(padlist)) /* may be during global destruction */
269 DEBUG_X(PerlIO_printf(Perl_debug_log,
270 "Pad undef: cv=0x%"UVxf" padlist=0x%"UVxf" comppad=0x%"UVxf"\n",
271 PTR2UV(cv), PTR2UV(padlist), PTR2UV(PL_comppad))
274 /* detach any '&' anon children in the pad; if afterwards they
275 * are still live, fix up their CvOUTSIDEs to point to our outside,
277 /* XXX DAPM for efficiency, we should only do this if we know we have
278 * children, or integrate this loop with general cleanup */
280 if (!PL_dirty) { /* don't bother during global destruction */
281 CV * const outercv = CvOUTSIDE(cv);
282 const U32 seq = CvOUTSIDE_SEQ(cv);
283 AV * const comppad_name = MUTABLE_AV(AvARRAY(padlist)[0]);
284 SV ** const namepad = AvARRAY(comppad_name);
285 AV * const comppad = MUTABLE_AV(AvARRAY(padlist)[1]);
286 SV ** const curpad = AvARRAY(comppad);
287 for (ix = AvFILLp(comppad_name); ix > 0; ix--) {
288 SV * const namesv = namepad[ix];
289 if (namesv && namesv != &PL_sv_undef
290 && *SvPVX_const(namesv) == '&')
292 CV * const innercv = MUTABLE_CV(curpad[ix]);
293 U32 inner_rc = SvREFCNT(innercv);
296 SvREFCNT_dec(namesv);
298 if (SvREFCNT(comppad) < 2) { /* allow for /(?{ sub{} })/ */
300 SvREFCNT_dec(innercv);
304 /* in use, not just a prototype */
305 if (inner_rc && (CvOUTSIDE(innercv) == cv)) {
306 assert(CvWEAKOUTSIDE(innercv));
307 /* don't relink to grandfather if he's being freed */
308 if (outercv && SvREFCNT(outercv)) {
309 CvWEAKOUTSIDE_off(innercv);
310 CvOUTSIDE(innercv) = outercv;
311 CvOUTSIDE_SEQ(innercv) = seq;
312 SvREFCNT_inc_simple_void_NN(outercv);
315 CvOUTSIDE(innercv) = NULL;
322 ix = AvFILLp(padlist);
324 SV* const sv = AvARRAY(padlist)[ix--];
326 if (sv == (const SV *)PL_comppad_name)
327 PL_comppad_name = NULL;
328 else if (sv == (const SV *)PL_comppad) {
335 SvREFCNT_dec(MUTABLE_SV(CvPADLIST(cv)));
336 CvPADLIST(cv) = NULL;
343 S_pad_add_name_sv(pTHX_ SV *namesv, const U32 flags, HV *typestash,
347 const PADOFFSET offset = pad_alloc(OP_PADSV, SVs_PADMY);
349 PERL_ARGS_ASSERT_PAD_ADD_NAME_SV;
351 ASSERT_CURPAD_ACTIVE("pad_add_name");
354 assert(SvTYPE(namesv) == SVt_PVMG);
355 SvPAD_TYPED_on(namesv);
356 SvSTASH_set(namesv, MUTABLE_HV(SvREFCNT_inc_simple_NN(MUTABLE_SV(typestash))));
359 SvPAD_OUR_on(namesv);
360 SvOURSTASH_set(namesv, ourstash);
361 SvREFCNT_inc_simple_void_NN(ourstash);
363 else if (flags & padadd_STATE) {
364 SvPAD_STATE_on(namesv);
367 av_store(PL_comppad_name, offset, namesv);
372 =for apidoc pad_add_name
374 Create a new name and associated PADMY SV in the current pad; return the
376 If C<typestash> is valid, the name is for a typed lexical; set the
377 name's stash to that value.
378 If C<ourstash> is valid, it's an our lexical, set the name's
379 SvOURSTASH to that value
381 If fake, it means we're cloning an existing entry
387 Perl_pad_add_name(pTHX_ const char *name, const STRLEN len, const U32 flags,
388 HV *typestash, HV *ourstash)
394 PERL_ARGS_ASSERT_PAD_ADD_NAME;
396 if (flags & ~(padadd_OUR|padadd_STATE|padadd_NO_DUP_CHECK))
397 Perl_croak(aTHX_ "panic: pad_add_name illegal flag bits 0x%" UVxf,
400 namesv = newSV_type((ourstash || typestash) ? SVt_PVMG : SVt_PVNV);
402 /* Until we're using the length for real, cross check that we're being told
404 PERL_UNUSED_ARG(len);
405 assert(strlen(name) == len);
407 sv_setpv(namesv, name);
409 if ((flags & padadd_NO_DUP_CHECK) == 0) {
410 /* check for duplicate declaration */
411 pad_check_dup(namesv, flags & padadd_OUR, ourstash);
414 offset = pad_add_name_sv(namesv, flags, typestash, ourstash);
416 /* not yet introduced */
417 COP_SEQ_RANGE_LOW_set(namesv, PAD_MAX); /* min */
418 COP_SEQ_RANGE_HIGH_set(namesv, 0); /* max */
420 if (!PL_min_intro_pending)
421 PL_min_intro_pending = offset;
422 PL_max_intro_pending = offset;
423 /* if it's not a simple scalar, replace with an AV or HV */
424 assert(SvTYPE(PL_curpad[offset]) == SVt_NULL);
425 assert(SvREFCNT(PL_curpad[offset]) == 1);
427 sv_upgrade(PL_curpad[offset], SVt_PVAV);
428 else if (*name == '%')
429 sv_upgrade(PL_curpad[offset], SVt_PVHV);
430 assert(SvPADMY(PL_curpad[offset]));
431 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
432 "Pad addname: %ld \"%s\" new lex=0x%"UVxf"\n",
433 (long)offset, name, PTR2UV(PL_curpad[offset])));
442 =for apidoc pad_alloc
444 Allocate a new my or tmp pad entry. For a my, simply push a null SV onto
445 the end of PL_comppad, but for a tmp, scan the pad from PL_padix upwards
446 for a slot which has no name and no active value.
451 /* XXX DAPM integrate alloc(), add_name() and add_anon(),
452 * or at least rationalise ??? */
453 /* And flag whether the incoming name is UTF8 or 8 bit?
454 Could do this either with the +ve/-ve hack of the HV code, or expanding
455 the flag bits. Either way, this makes proper Unicode safe pad support.
460 Perl_pad_alloc(pTHX_ I32 optype, U32 tmptype)
466 PERL_UNUSED_ARG(optype);
467 ASSERT_CURPAD_ACTIVE("pad_alloc");
469 if (AvARRAY(PL_comppad) != PL_curpad)
470 Perl_croak(aTHX_ "panic: pad_alloc");
471 if (PL_pad_reset_pending)
473 if (tmptype & SVs_PADMY) {
474 sv = *av_fetch(PL_comppad, AvFILLp(PL_comppad) + 1, TRUE);
475 retval = AvFILLp(PL_comppad);
478 SV * const * const names = AvARRAY(PL_comppad_name);
479 const SSize_t names_fill = AvFILLp(PL_comppad_name);
482 * "foreach" index vars temporarily become aliases to non-"my"
483 * values. Thus we must skip, not just pad values that are
484 * marked as current pad values, but also those with names.
486 /* HVDS why copy to sv here? we don't seem to use it */
487 if (++PL_padix <= names_fill &&
488 (sv = names[PL_padix]) && sv != &PL_sv_undef)
490 sv = *av_fetch(PL_comppad, PL_padix, TRUE);
491 if (!(SvFLAGS(sv) & (SVs_PADTMP | SVs_PADMY)) &&
492 !IS_PADGV(sv) && !IS_PADCONST(sv))
497 SvFLAGS(sv) |= tmptype;
498 PL_curpad = AvARRAY(PL_comppad);
500 DEBUG_X(PerlIO_printf(Perl_debug_log,
501 "Pad 0x%"UVxf"[0x%"UVxf"] alloc: %ld for %s\n",
502 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long) retval,
503 PL_op_name[optype]));
504 #ifdef DEBUG_LEAKING_SCALARS
505 sv->sv_debug_optype = optype;
506 sv->sv_debug_inpad = 1;
508 return (PADOFFSET)retval;
512 =for apidoc pad_add_anon
514 Add an anon code entry to the current compiling pad
520 Perl_pad_add_anon(pTHX_ SV* sv, OPCODE op_type)
524 SV* const name = newSV_type(SVt_PVNV);
526 PERL_ARGS_ASSERT_PAD_ADD_ANON;
529 sv_setpvs(name, "&");
530 /* Are these two actually ever read? */
531 COP_SEQ_RANGE_HIGH_set(name, ~0);
532 COP_SEQ_RANGE_LOW_set(name, 1);
533 ix = pad_alloc(op_type, SVs_PADMY);
534 av_store(PL_comppad_name, ix, name);
535 /* XXX DAPM use PL_curpad[] ? */
536 av_store(PL_comppad, ix, sv);
539 /* to avoid ref loops, we never have parent + child referencing each
540 * other simultaneously */
541 if (CvOUTSIDE((const CV *)sv)) {
542 assert(!CvWEAKOUTSIDE((const CV *)sv));
543 CvWEAKOUTSIDE_on(MUTABLE_CV(sv));
544 SvREFCNT_dec(CvOUTSIDE(MUTABLE_CV(sv)));
552 =for apidoc pad_check_dup
554 Check for duplicate declarations: report any of:
555 * a my in the current scope with the same name;
556 * an our (anywhere in the pad) with the same name and the same stash
558 C<is_our> indicates that the name to check is an 'our' declaration
564 S_pad_check_dup(pTHX_ SV *name, const U32 flags, const HV *ourstash)
569 const U32 is_our = flags & padadd_OUR;
571 PERL_ARGS_ASSERT_PAD_CHECK_DUP;
573 ASSERT_CURPAD_ACTIVE("pad_check_dup");
575 assert((flags & ~padadd_OUR) == 0);
577 if (AvFILLp(PL_comppad_name) < 0 || !ckWARN(WARN_MISC))
578 return; /* nothing to check */
580 svp = AvARRAY(PL_comppad_name);
581 top = AvFILLp(PL_comppad_name);
582 /* check the current scope */
583 /* XXX DAPM - why the (I32) cast - shouldn't we ensure they're the same
585 for (off = top; (I32)off > PL_comppad_name_floor; off--) {
586 SV * const sv = svp[off];
588 && sv != &PL_sv_undef
590 && (COP_SEQ_RANGE_HIGH(sv) == PAD_MAX || COP_SEQ_RANGE_HIGH(sv) == 0)
593 if (is_our && (SvPAD_OUR(sv)))
594 break; /* "our" masking "our" */
595 Perl_warner(aTHX_ packWARN(WARN_MISC),
596 "\"%s\" variable %"SVf" masks earlier declaration in same %s",
597 (is_our ? "our" : PL_parser->in_my == KEY_my ? "my" : "state"),
599 (COP_SEQ_RANGE_HIGH(sv) == PAD_MAX ? "scope" : "statement"));
604 /* check the rest of the pad */
607 SV * const sv = svp[off];
609 && sv != &PL_sv_undef
611 && (COP_SEQ_RANGE_HIGH(sv) == PAD_MAX || COP_SEQ_RANGE_HIGH(sv) == 0)
612 && SvOURSTASH(sv) == ourstash
615 Perl_warner(aTHX_ packWARN(WARN_MISC),
616 "\"our\" variable %"SVf" redeclared", sv);
617 if ((I32)off <= PL_comppad_name_floor)
618 Perl_warner(aTHX_ packWARN(WARN_MISC),
619 "\t(Did you mean \"local\" instead of \"our\"?)\n");
622 } while ( off-- > 0 );
628 =for apidoc pad_findmy
630 Given a lexical name, try to find its offset, first in the current pad,
631 or failing that, in the pads of any lexically enclosing subs (including
632 the complications introduced by eval). If the name is found in an outer pad,
633 then a fake entry is added to the current pad.
634 Returns the offset in the current pad, or NOT_IN_PAD on failure.
640 Perl_pad_findmy(pTHX_ const char *name, STRLEN len, U32 flags)
649 PERL_ARGS_ASSERT_PAD_FINDMY;
651 pad_peg("pad_findmy");
654 Perl_croak(aTHX_ "panic: pad_findmy illegal flag bits 0x%" UVxf,
657 /* Yes, it is a bug (read work in progress) that we're not really using this
658 length parameter, and instead relying on strlen() later on. But I'm not
659 comfortable about changing the pad API piecemeal to use and rely on
660 lengths. This only exists to avoid an "unused parameter" warning. */
664 /* But until we're using the length for real, cross check that we're being
666 assert(strlen(name) == len);
668 offset = pad_findlex(name, PL_compcv, PL_cop_seqmax, 1,
669 NULL, &out_sv, &out_flags);
670 if ((PADOFFSET)offset != NOT_IN_PAD)
673 /* look for an our that's being introduced; this allows
674 * our $foo = 0 unless defined $foo;
675 * to not give a warning. (Yes, this is a hack) */
677 nameav = MUTABLE_AV(AvARRAY(CvPADLIST(PL_compcv))[0]);
678 name_svp = AvARRAY(nameav);
679 for (offset = AvFILLp(nameav); offset > 0; offset--) {
680 const SV * const namesv = name_svp[offset];
681 if (namesv && namesv != &PL_sv_undef
683 && (SvPAD_OUR(namesv))
684 && strEQ(SvPVX_const(namesv), name)
685 && COP_SEQ_RANGE_LOW(namesv) == PAD_MAX /* min */
693 * Returns the offset of a lexical $_, if there is one, at run time.
694 * Used by the UNDERBAR XS macro.
698 Perl_find_rundefsvoffset(pTHX)
703 return pad_findlex("$_", find_runcv(NULL), PL_curcop->cop_seq, 1,
704 NULL, &out_sv, &out_flags);
708 * Returns a lexical $_, if there is one, at run time ; or the global one
713 Perl_find_rundefsv(pTHX)
719 po = pad_findlex("$_", find_runcv(NULL), PL_curcop->cop_seq, 1,
720 NULL, &namesv, &flags);
723 || (SvFLAGS(namesv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
730 =for apidoc pad_findlex
732 Find a named lexical anywhere in a chain of nested pads. Add fake entries
733 in the inner pads if it's found in an outer one.
735 Returns the offset in the bottom pad of the lex or the fake lex.
736 cv is the CV in which to start the search, and seq is the current cop_seq
737 to match against. If warn is true, print appropriate warnings. The out_*
738 vars return values, and so are pointers to where the returned values
739 should be stored. out_capture, if non-null, requests that the innermost
740 instance of the lexical is captured; out_name_sv is set to the innermost
741 matched namesv or fake namesv; out_flags returns the flags normally
742 associated with the IVX field of a fake namesv.
744 Note that pad_findlex() is recursive; it recurses up the chain of CVs,
745 then comes back down, adding fake entries as it goes. It has to be this way
746 because fake namesvs in anon protoypes have to store in xlow the index into
752 /* the CV has finished being compiled. This is not a sufficient test for
753 * all CVs (eg XSUBs), but suffices for the CVs found in a lexical chain */
754 #define CvCOMPILED(cv) CvROOT(cv)
756 /* the CV does late binding of its lexicals */
757 #define CvLATE(cv) (CvANON(cv) || SvTYPE(cv) == SVt_PVFM)
761 S_pad_findlex(pTHX_ const char *name, const CV* cv, U32 seq, int warn,
762 SV** out_capture, SV** out_name_sv, int *out_flags)
765 I32 offset, new_offset;
768 const AV * const padlist = CvPADLIST(cv);
770 PERL_ARGS_ASSERT_PAD_FINDLEX;
774 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
775 "Pad findlex cv=0x%"UVxf" searching \"%s\" seq=%d%s\n",
776 PTR2UV(cv), name, (int)seq, out_capture ? " capturing" : "" ));
778 /* first, search this pad */
780 if (padlist) { /* not an undef CV */
782 const AV * const nameav = MUTABLE_AV(AvARRAY(padlist)[0]);
783 SV * const * const name_svp = AvARRAY(nameav);
785 for (offset = AvFILLp(nameav); offset > 0; offset--) {
786 const SV * const namesv = name_svp[offset];
787 if (namesv && namesv != &PL_sv_undef
788 && strEQ(SvPVX_const(namesv), name))
791 fake_offset = offset; /* in case we don't find a real one */
792 else if ( seq > COP_SEQ_RANGE_LOW(namesv) /* min */
793 && seq <= COP_SEQ_RANGE_HIGH(namesv)) /* max */
798 if (offset > 0 || fake_offset > 0 ) { /* a match! */
799 if (offset > 0) { /* not fake */
801 *out_name_sv = name_svp[offset]; /* return the namesv */
803 /* set PAD_FAKELEX_MULTI if this lex can have multiple
804 * instances. For now, we just test !CvUNIQUE(cv), but
805 * ideally, we should detect my's declared within loops
806 * etc - this would allow a wider range of 'not stayed
807 * shared' warnings. We also treated alreadly-compiled
808 * lexes as not multi as viewed from evals. */
810 *out_flags = CvANON(cv) ?
812 (!CvUNIQUE(cv) && ! CvCOMPILED(cv))
813 ? PAD_FAKELEX_MULTI : 0;
815 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
816 "Pad findlex cv=0x%"UVxf" matched: offset=%ld (%lu,%lu)\n",
817 PTR2UV(cv), (long)offset,
818 (unsigned long)COP_SEQ_RANGE_LOW(*out_name_sv),
819 (unsigned long)COP_SEQ_RANGE_HIGH(*out_name_sv)));
821 else { /* fake match */
822 offset = fake_offset;
823 *out_name_sv = name_svp[offset]; /* return the namesv */
824 *out_flags = PARENT_FAKELEX_FLAGS(*out_name_sv);
825 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
826 "Pad findlex cv=0x%"UVxf" matched: offset=%ld flags=0x%lx index=%lu\n",
827 PTR2UV(cv), (long)offset, (unsigned long)*out_flags,
828 (unsigned long) PARENT_PAD_INDEX(*out_name_sv)
832 /* return the lex? */
837 if (SvPAD_OUR(*out_name_sv)) {
842 /* trying to capture from an anon prototype? */
844 ? CvANON(cv) && CvCLONE(cv) && !CvCLONED(cv)
845 : *out_flags & PAD_FAKELEX_ANON)
848 Perl_ck_warner(aTHX_ packWARN(WARN_CLOSURE),
849 "Variable \"%s\" is not available", name);
856 if (!CvCOMPILED(cv) && (*out_flags & PAD_FAKELEX_MULTI)
857 && !SvPAD_STATE(name_svp[offset])
858 && warn && ckWARN(WARN_CLOSURE)) {
860 Perl_warner(aTHX_ packWARN(WARN_CLOSURE),
861 "Variable \"%s\" will not stay shared", name);
864 if (fake_offset && CvANON(cv)
865 && CvCLONE(cv) &&!CvCLONED(cv))
868 /* not yet caught - look further up */
869 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
870 "Pad findlex cv=0x%"UVxf" chasing lex in outer pad\n",
873 (void) pad_findlex(name, CvOUTSIDE(cv),
875 newwarn, out_capture, out_name_sv, out_flags);
880 *out_capture = AvARRAY(MUTABLE_AV(AvARRAY(padlist)[
881 CvDEPTH(cv) ? CvDEPTH(cv) : 1]))[offset];
882 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
883 "Pad findlex cv=0x%"UVxf" found lex=0x%"UVxf"\n",
884 PTR2UV(cv), PTR2UV(*out_capture)));
886 if (SvPADSTALE(*out_capture)
887 && !SvPAD_STATE(name_svp[offset]))
889 Perl_ck_warner(aTHX_ packWARN(WARN_CLOSURE),
890 "Variable \"%s\" is not available", name);
896 *out_capture = sv_2mortal(MUTABLE_SV(newAV()));
897 else if (*name == '%')
898 *out_capture = sv_2mortal(MUTABLE_SV(newHV()));
900 *out_capture = sv_newmortal();
908 /* it's not in this pad - try above */
913 /* out_capture non-null means caller wants us to capture lex; in
914 * addition we capture ourselves unless it's an ANON/format */
915 new_capturep = out_capture ? out_capture :
916 CvLATE(cv) ? NULL : &new_capture;
918 offset = pad_findlex(name, CvOUTSIDE(cv), CvOUTSIDE_SEQ(cv), 1,
919 new_capturep, out_name_sv, out_flags);
920 if ((PADOFFSET)offset == NOT_IN_PAD)
923 /* found in an outer CV. Add appropriate fake entry to this pad */
925 /* don't add new fake entries (via eval) to CVs that we have already
926 * finished compiling, or to undef CVs */
927 if (CvCOMPILED(cv) || !padlist)
928 return 0; /* this dummy (and invalid) value isnt used by the caller */
931 /* This relies on sv_setsv_flags() upgrading the destination to the same
932 type as the source, independant of the flags set, and on it being
933 "good" and only copying flag bits and pointers that it understands.
935 SV *new_namesv = newSVsv(*out_name_sv);
936 AV * const ocomppad_name = PL_comppad_name;
937 PAD * const ocomppad = PL_comppad;
938 PL_comppad_name = MUTABLE_AV(AvARRAY(padlist)[0]);
939 PL_comppad = MUTABLE_AV(AvARRAY(padlist)[1]);
940 PL_curpad = AvARRAY(PL_comppad);
943 = pad_add_name_sv(new_namesv,
944 (SvPAD_STATE(*out_name_sv) ? padadd_STATE : 0),
945 SvPAD_TYPED(*out_name_sv)
946 ? SvSTASH(*out_name_sv) : NULL,
947 SvOURSTASH(*out_name_sv)
950 SvFAKE_on(new_namesv);
951 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
952 "Pad addname: %ld \"%.*s\" FAKE\n",
954 (int) SvCUR(new_namesv), SvPVX(new_namesv)));
955 PARENT_FAKELEX_FLAGS_set(new_namesv, *out_flags);
957 PARENT_PAD_INDEX_set(new_namesv, 0);
958 if (SvPAD_OUR(new_namesv)) {
959 NOOP; /* do nothing */
961 else if (CvLATE(cv)) {
962 /* delayed creation - just note the offset within parent pad */
963 PARENT_PAD_INDEX_set(new_namesv, offset);
967 /* immediate creation - capture outer value right now */
968 av_store(PL_comppad, new_offset, SvREFCNT_inc(*new_capturep));
969 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
970 "Pad findlex cv=0x%"UVxf" saved captured sv 0x%"UVxf" at offset %ld\n",
971 PTR2UV(cv), PTR2UV(*new_capturep), (long)new_offset));
973 *out_name_sv = new_namesv;
974 *out_flags = PARENT_FAKELEX_FLAGS(new_namesv);
976 PL_comppad_name = ocomppad_name;
977 PL_comppad = ocomppad;
978 PL_curpad = ocomppad ? AvARRAY(ocomppad) : NULL;
988 Get the value at offset po in the current pad.
989 Use macro PAD_SV instead of calling this function directly.
996 Perl_pad_sv(pTHX_ PADOFFSET po)
999 ASSERT_CURPAD_ACTIVE("pad_sv");
1002 Perl_croak(aTHX_ "panic: pad_sv po");
1003 DEBUG_X(PerlIO_printf(Perl_debug_log,
1004 "Pad 0x%"UVxf"[0x%"UVxf"] sv: %ld sv=0x%"UVxf"\n",
1005 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po, PTR2UV(PL_curpad[po]))
1007 return PL_curpad[po];
1012 =for apidoc pad_setsv
1014 Set the entry at offset po in the current pad to sv.
1015 Use the macro PAD_SETSV() rather than calling this function directly.
1021 Perl_pad_setsv(pTHX_ PADOFFSET po, SV* sv)
1025 PERL_ARGS_ASSERT_PAD_SETSV;
1027 ASSERT_CURPAD_ACTIVE("pad_setsv");
1029 DEBUG_X(PerlIO_printf(Perl_debug_log,
1030 "Pad 0x%"UVxf"[0x%"UVxf"] setsv: %ld sv=0x%"UVxf"\n",
1031 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po, PTR2UV(sv))
1040 =for apidoc pad_block_start
1042 Update the pad compilation state variables on entry to a new block
1047 /* XXX DAPM perhaps:
1048 * - integrate this in general state-saving routine ???
1049 * - combine with the state-saving going on in pad_new ???
1050 * - introduce a new SAVE type that does all this in one go ?
1054 Perl_pad_block_start(pTHX_ int full)
1057 ASSERT_CURPAD_ACTIVE("pad_block_start");
1058 SAVEI32(PL_comppad_name_floor);
1059 PL_comppad_name_floor = AvFILLp(PL_comppad_name);
1061 PL_comppad_name_fill = PL_comppad_name_floor;
1062 if (PL_comppad_name_floor < 0)
1063 PL_comppad_name_floor = 0;
1064 SAVEI32(PL_min_intro_pending);
1065 SAVEI32(PL_max_intro_pending);
1066 PL_min_intro_pending = 0;
1067 SAVEI32(PL_comppad_name_fill);
1068 SAVEI32(PL_padix_floor);
1069 PL_padix_floor = PL_padix;
1070 PL_pad_reset_pending = FALSE;
1075 =for apidoc intro_my
1077 "Introduce" my variables to visible status.
1089 ASSERT_CURPAD_ACTIVE("intro_my");
1090 if (! PL_min_intro_pending)
1091 return PL_cop_seqmax;
1093 svp = AvARRAY(PL_comppad_name);
1094 for (i = PL_min_intro_pending; i <= PL_max_intro_pending; i++) {
1095 SV * const sv = svp[i];
1097 if (sv && sv != &PL_sv_undef && !SvFAKE(sv) && !COP_SEQ_RANGE_HIGH(sv)) {
1098 COP_SEQ_RANGE_HIGH_set(sv, PAD_MAX); /* Don't know scope end yet. */
1099 COP_SEQ_RANGE_LOW_set(sv, PL_cop_seqmax);
1100 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1101 "Pad intromy: %ld \"%s\", (%lu,%lu)\n",
1102 (long)i, SvPVX_const(sv),
1103 (unsigned long)COP_SEQ_RANGE_LOW(sv),
1104 (unsigned long)COP_SEQ_RANGE_HIGH(sv))
1108 PL_min_intro_pending = 0;
1109 PL_comppad_name_fill = PL_max_intro_pending; /* Needn't search higher */
1110 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1111 "Pad intromy: seq -> %ld\n", (long)(PL_cop_seqmax+1)));
1113 return PL_cop_seqmax++;
1117 =for apidoc pad_leavemy
1119 Cleanup at end of scope during compilation: set the max seq number for
1120 lexicals in this scope and warn of any lexicals that never got introduced.
1126 Perl_pad_leavemy(pTHX)
1130 SV * const * const svp = AvARRAY(PL_comppad_name);
1132 PL_pad_reset_pending = FALSE;
1134 ASSERT_CURPAD_ACTIVE("pad_leavemy");
1135 if (PL_min_intro_pending && PL_comppad_name_fill < PL_min_intro_pending) {
1136 for (off = PL_max_intro_pending; off >= PL_min_intro_pending; off--) {
1137 const SV * const sv = svp[off];
1138 if (sv && sv != &PL_sv_undef && !SvFAKE(sv))
1139 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1140 "%"SVf" never introduced",
1144 /* "Deintroduce" my variables that are leaving with this scope. */
1145 for (off = AvFILLp(PL_comppad_name); off > PL_comppad_name_fill; off--) {
1146 const SV * const sv = svp[off];
1147 if (sv && sv != &PL_sv_undef && !SvFAKE(sv) && COP_SEQ_RANGE_HIGH(sv) == PAD_MAX) {
1148 COP_SEQ_RANGE_HIGH_set(sv, PL_cop_seqmax);
1149 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1150 "Pad leavemy: %ld \"%s\", (%lu,%lu)\n",
1151 (long)off, SvPVX_const(sv),
1152 (unsigned long)COP_SEQ_RANGE_LOW(sv),
1153 (unsigned long)COP_SEQ_RANGE_HIGH(sv))
1158 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1159 "Pad leavemy: seq = %ld\n", (long)PL_cop_seqmax));
1164 =for apidoc pad_swipe
1166 Abandon the tmp in the current pad at offset po and replace with a
1173 Perl_pad_swipe(pTHX_ PADOFFSET po, bool refadjust)
1176 ASSERT_CURPAD_LEGAL("pad_swipe");
1179 if (AvARRAY(PL_comppad) != PL_curpad)
1180 Perl_croak(aTHX_ "panic: pad_swipe curpad");
1182 Perl_croak(aTHX_ "panic: pad_swipe po");
1184 DEBUG_X(PerlIO_printf(Perl_debug_log,
1185 "Pad 0x%"UVxf"[0x%"UVxf"] swipe: %ld\n",
1186 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po));
1189 SvPADTMP_off(PL_curpad[po]);
1191 SvREFCNT_dec(PL_curpad[po]);
1194 /* if pad tmps aren't shared between ops, then there's no need to
1195 * create a new tmp when an existing op is freed */
1196 #ifdef USE_BROKEN_PAD_RESET
1197 PL_curpad[po] = newSV(0);
1198 SvPADTMP_on(PL_curpad[po]);
1200 PL_curpad[po] = &PL_sv_undef;
1202 if ((I32)po < PL_padix)
1208 =for apidoc pad_reset
1210 Mark all the current temporaries for reuse
1215 /* XXX pad_reset() is currently disabled because it results in serious bugs.
1216 * It causes pad temp TARGs to be shared between OPs. Since TARGs are pushed
1217 * on the stack by OPs that use them, there are several ways to get an alias
1218 * to a shared TARG. Such an alias will change randomly and unpredictably.
1219 * We avoid doing this until we can think of a Better Way.
1225 #ifdef USE_BROKEN_PAD_RESET
1226 if (AvARRAY(PL_comppad) != PL_curpad)
1227 Perl_croak(aTHX_ "panic: pad_reset curpad");
1229 DEBUG_X(PerlIO_printf(Perl_debug_log,
1230 "Pad 0x%"UVxf"[0x%"UVxf"] reset: padix %ld -> %ld",
1231 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
1232 (long)PL_padix, (long)PL_padix_floor
1236 if (!PL_tainting) { /* Can't mix tainted and non-tainted temporaries. */
1238 for (po = AvMAX(PL_comppad); po > PL_padix_floor; po--) {
1239 if (PL_curpad[po] && !SvIMMORTAL(PL_curpad[po]))
1240 SvPADTMP_off(PL_curpad[po]);
1242 PL_padix = PL_padix_floor;
1245 PL_pad_reset_pending = FALSE;
1250 =for apidoc pad_tidy
1252 Tidy up a pad after we've finished compiling it:
1253 * remove most stuff from the pads of anonsub prototypes;
1255 * mark tmps as such.
1260 /* XXX DAPM surely most of this stuff should be done properly
1261 * at the right time beforehand, rather than going around afterwards
1262 * cleaning up our mistakes ???
1266 Perl_pad_tidy(pTHX_ padtidy_type type)
1270 ASSERT_CURPAD_ACTIVE("pad_tidy");
1272 /* If this CV has had any 'eval-capable' ops planted in it
1273 * (ie it contains eval '...', //ee, /$var/ or /(?{..})/), Then any
1274 * anon prototypes in the chain of CVs should be marked as cloneable,
1275 * so that for example the eval's CV in C<< sub { eval '$x' } >> gets
1276 * the right CvOUTSIDE.
1277 * If running with -d, *any* sub may potentially have an eval
1278 * excuted within it.
1281 if (PL_cv_has_eval || PL_perldb) {
1283 for (cv = PL_compcv ;cv; cv = CvOUTSIDE(cv)) {
1284 if (cv != PL_compcv && CvCOMPILED(cv))
1285 break; /* no need to mark already-compiled code */
1287 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1288 "Pad clone on cv=0x%"UVxf"\n", PTR2UV(cv)));
1294 /* extend curpad to match namepad */
1295 if (AvFILLp(PL_comppad_name) < AvFILLp(PL_comppad))
1296 av_store(PL_comppad_name, AvFILLp(PL_comppad), NULL);
1298 if (type == padtidy_SUBCLONE) {
1299 SV * const * const namep = AvARRAY(PL_comppad_name);
1302 for (ix = AvFILLp(PL_comppad); ix > 0; ix--) {
1305 if (SvIMMORTAL(PL_curpad[ix]) || IS_PADGV(PL_curpad[ix]) || IS_PADCONST(PL_curpad[ix]))
1308 * The only things that a clonable function needs in its
1309 * pad are anonymous subs.
1310 * The rest are created anew during cloning.
1312 if (!((namesv = namep[ix]) != NULL &&
1313 namesv != &PL_sv_undef &&
1314 *SvPVX_const(namesv) == '&'))
1316 SvREFCNT_dec(PL_curpad[ix]);
1317 PL_curpad[ix] = NULL;
1321 else if (type == padtidy_SUB) {
1322 /* XXX DAPM this same bit of code keeps appearing !!! Rationalise? */
1323 AV * const av = newAV(); /* Will be @_ */
1324 av_store(PL_comppad, 0, MUTABLE_SV(av));
1328 if (type == padtidy_SUB || type == padtidy_FORMAT) {
1329 SV * const * const namep = AvARRAY(PL_comppad_name);
1331 for (ix = AvFILLp(PL_comppad); ix > 0; ix--) {
1332 if (SvIMMORTAL(PL_curpad[ix]) || IS_PADGV(PL_curpad[ix]) || IS_PADCONST(PL_curpad[ix]))
1334 if (!SvPADMY(PL_curpad[ix])) {
1335 SvPADTMP_on(PL_curpad[ix]);
1336 } else if (!SvFAKE(namep[ix])) {
1337 /* This is a work around for how the current implementation of
1338 ?{ } blocks in regexps interacts with lexicals.
1340 One of our lexicals.
1341 Can't do this on all lexicals, otherwise sub baz() won't
1350 because completion of compiling &bar calling pad_tidy()
1351 would cause (top level) $foo to be marked as stale, and
1352 "no longer available". */
1353 SvPADSTALE_on(PL_curpad[ix]);
1357 PL_curpad = AvARRAY(PL_comppad);
1362 =for apidoc pad_free
1364 Free the SV at offset po in the current pad.
1369 /* XXX DAPM integrate with pad_swipe ???? */
1371 Perl_pad_free(pTHX_ PADOFFSET po)
1374 ASSERT_CURPAD_LEGAL("pad_free");
1377 if (AvARRAY(PL_comppad) != PL_curpad)
1378 Perl_croak(aTHX_ "panic: pad_free curpad");
1380 Perl_croak(aTHX_ "panic: pad_free po");
1382 DEBUG_X(PerlIO_printf(Perl_debug_log,
1383 "Pad 0x%"UVxf"[0x%"UVxf"] free: %ld\n",
1384 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po)
1387 if (PL_curpad[po] && PL_curpad[po] != &PL_sv_undef) {
1388 SvPADTMP_off(PL_curpad[po]);
1390 /* SV could be a shared hash key (eg bugid #19022) */
1391 if (!SvIsCOW(PL_curpad[po]))
1392 SvREADONLY_off(PL_curpad[po]); /* could be a freed constant */
1395 if ((I32)po < PL_padix)
1402 =for apidoc do_dump_pad
1404 Dump the contents of a padlist
1410 Perl_do_dump_pad(pTHX_ I32 level, PerlIO *file, PADLIST *padlist, int full)
1419 PERL_ARGS_ASSERT_DO_DUMP_PAD;
1424 pad_name = MUTABLE_AV(*av_fetch(MUTABLE_AV(padlist), 0, FALSE));
1425 pad = MUTABLE_AV(*av_fetch(MUTABLE_AV(padlist), 1, FALSE));
1426 pname = AvARRAY(pad_name);
1427 ppad = AvARRAY(pad);
1428 Perl_dump_indent(aTHX_ level, file,
1429 "PADNAME = 0x%"UVxf"(0x%"UVxf") PAD = 0x%"UVxf"(0x%"UVxf")\n",
1430 PTR2UV(pad_name), PTR2UV(pname), PTR2UV(pad), PTR2UV(ppad)
1433 for (ix = 1; ix <= AvFILLp(pad_name); ix++) {
1434 const SV *namesv = pname[ix];
1435 if (namesv && namesv == &PL_sv_undef) {
1440 Perl_dump_indent(aTHX_ level+1, file,
1441 "%2d. 0x%"UVxf"<%lu> FAKE \"%s\" flags=0x%lx index=%lu\n",
1444 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0),
1445 SvPVX_const(namesv),
1446 (unsigned long)PARENT_FAKELEX_FLAGS(namesv),
1447 (unsigned long)PARENT_PAD_INDEX(namesv)
1451 Perl_dump_indent(aTHX_ level+1, file,
1452 "%2d. 0x%"UVxf"<%lu> (%lu,%lu) \"%s\"\n",
1455 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0),
1456 (unsigned long)COP_SEQ_RANGE_LOW(namesv),
1457 (unsigned long)COP_SEQ_RANGE_HIGH(namesv),
1462 Perl_dump_indent(aTHX_ level+1, file,
1463 "%2d. 0x%"UVxf"<%lu>\n",
1466 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0)
1477 dump the contents of a CV
1484 S_cv_dump(pTHX_ const CV *cv, const char *title)
1487 const CV * const outside = CvOUTSIDE(cv);
1488 AV* const padlist = CvPADLIST(cv);
1490 PERL_ARGS_ASSERT_CV_DUMP;
1492 PerlIO_printf(Perl_debug_log,
1493 " %s: CV=0x%"UVxf" (%s), OUTSIDE=0x%"UVxf" (%s)\n",
1496 (CvANON(cv) ? "ANON"
1497 : (SvTYPE(cv) == SVt_PVFM) ? "FORMAT"
1498 : (cv == PL_main_cv) ? "MAIN"
1499 : CvUNIQUE(cv) ? "UNIQUE"
1500 : CvGV(cv) ? GvNAME(CvGV(cv)) : "UNDEFINED"),
1503 : CvANON(outside) ? "ANON"
1504 : (outside == PL_main_cv) ? "MAIN"
1505 : CvUNIQUE(outside) ? "UNIQUE"
1506 : CvGV(outside) ? GvNAME(CvGV(outside)) : "UNDEFINED"));
1508 PerlIO_printf(Perl_debug_log,
1509 " PADLIST = 0x%"UVxf"\n", PTR2UV(padlist));
1510 do_dump_pad(1, Perl_debug_log, padlist, 1);
1512 #endif /* DEBUGGING */
1519 =for apidoc cv_clone
1521 Clone a CV: make a new CV which points to the same code etc, but which
1522 has a newly-created pad built by copying the prototype pad and capturing
1529 Perl_cv_clone(pTHX_ CV *proto)
1533 AV* const protopadlist = CvPADLIST(proto);
1534 const AV *const protopad_name = (const AV *)*av_fetch(protopadlist, 0, FALSE);
1535 const AV *const protopad = (const AV *)*av_fetch(protopadlist, 1, FALSE);
1536 SV** const pname = AvARRAY(protopad_name);
1537 SV** const ppad = AvARRAY(protopad);
1538 const I32 fname = AvFILLp(protopad_name);
1539 const I32 fpad = AvFILLp(protopad);
1545 PERL_ARGS_ASSERT_CV_CLONE;
1547 assert(!CvUNIQUE(proto));
1549 /* Since cloneable anon subs can be nested, CvOUTSIDE may point
1550 * to a prototype; we instead want the cloned parent who called us.
1551 * Note that in general for formats, CvOUTSIDE != find_runcv */
1553 outside = CvOUTSIDE(proto);
1554 if (outside && CvCLONE(outside) && ! CvCLONED(outside))
1555 outside = find_runcv(NULL);
1556 depth = CvDEPTH(outside);
1557 assert(depth || SvTYPE(proto) == SVt_PVFM);
1560 assert(CvPADLIST(outside));
1563 SAVESPTR(PL_compcv);
1565 cv = PL_compcv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1566 CvFLAGS(cv) = CvFLAGS(proto) & ~(CVf_CLONE|CVf_WEAKOUTSIDE|CVf_CVGV_RC);
1570 CvFILE(cv) = CvISXSUB(proto) ? CvFILE(proto)
1571 : savepv(CvFILE(proto));
1573 CvFILE(cv) = CvFILE(proto);
1575 CvGV_set(cv,CvGV(proto));
1576 CvSTASH_set(cv, CvSTASH(proto));
1578 CvROOT(cv) = OpREFCNT_inc(CvROOT(proto));
1580 CvSTART(cv) = CvSTART(proto);
1581 CvOUTSIDE(cv) = MUTABLE_CV(SvREFCNT_inc_simple(outside));
1582 CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1585 sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1587 CvPADLIST(cv) = pad_new(padnew_CLONE|padnew_SAVE);
1589 av_fill(PL_comppad, fpad);
1590 for (ix = fname; ix >= 0; ix--)
1591 av_store(PL_comppad_name, ix, SvREFCNT_inc(pname[ix]));
1593 PL_curpad = AvARRAY(PL_comppad);
1595 outpad = AvARRAY(AvARRAY(CvPADLIST(outside))[depth]);
1597 for (ix = fpad; ix > 0; ix--) {
1598 SV* const namesv = (ix <= fname) ? pname[ix] : NULL;
1600 if (namesv && namesv != &PL_sv_undef) { /* lexical */
1601 if (SvFAKE(namesv)) { /* lexical from outside? */
1602 sv = outpad[PARENT_PAD_INDEX(namesv)];
1604 /* formats may have an inactive parent,
1605 while my $x if $false can leave an active var marked as
1606 stale. And state vars are always available */
1607 if (SvPADSTALE(sv) && !SvPAD_STATE(namesv)) {
1608 Perl_ck_warner(aTHX_ packWARN(WARN_CLOSURE),
1609 "Variable \"%s\" is not available", SvPVX_const(namesv));
1613 SvREFCNT_inc_simple_void_NN(sv);
1616 const char sigil = SvPVX_const(namesv)[0];
1618 sv = SvREFCNT_inc(ppad[ix]);
1619 else if (sigil == '@')
1620 sv = MUTABLE_SV(newAV());
1621 else if (sigil == '%')
1622 sv = MUTABLE_SV(newHV());
1626 /* reset the 'assign only once' flag on each state var */
1627 if (SvPAD_STATE(namesv))
1631 else if (IS_PADGV(ppad[ix]) || IS_PADCONST(ppad[ix])) {
1632 sv = SvREFCNT_inc_NN(ppad[ix]);
1642 PerlIO_printf(Perl_debug_log, "\nPad CV clone\n");
1643 cv_dump(outside, "Outside");
1644 cv_dump(proto, "Proto");
1651 /* Constant sub () { $x } closing over $x - see lib/constant.pm:
1652 * The prototype was marked as a candiate for const-ization,
1653 * so try to grab the current const value, and if successful,
1654 * turn into a const sub:
1656 SV* const const_sv = op_const_sv(CvSTART(cv), cv);
1659 cv = newCONSTSUB(CvSTASH(proto), NULL, const_sv);
1671 =for apidoc pad_fixup_inner_anons
1673 For any anon CVs in the pad, change CvOUTSIDE of that CV from
1674 old_cv to new_cv if necessary. Needed when a newly-compiled CV has to be
1675 moved to a pre-existing CV struct.
1681 Perl_pad_fixup_inner_anons(pTHX_ PADLIST *padlist, CV *old_cv, CV *new_cv)
1685 AV * const comppad_name = MUTABLE_AV(AvARRAY(padlist)[0]);
1686 AV * const comppad = MUTABLE_AV(AvARRAY(padlist)[1]);
1687 SV ** const namepad = AvARRAY(comppad_name);
1688 SV ** const curpad = AvARRAY(comppad);
1690 PERL_ARGS_ASSERT_PAD_FIXUP_INNER_ANONS;
1691 PERL_UNUSED_ARG(old_cv);
1693 for (ix = AvFILLp(comppad_name); ix > 0; ix--) {
1694 const SV * const namesv = namepad[ix];
1695 if (namesv && namesv != &PL_sv_undef
1696 && *SvPVX_const(namesv) == '&')
1698 CV * const innercv = MUTABLE_CV(curpad[ix]);
1699 assert(CvWEAKOUTSIDE(innercv));
1700 assert(CvOUTSIDE(innercv) == old_cv);
1701 CvOUTSIDE(innercv) = new_cv;
1708 =for apidoc pad_push
1710 Push a new pad frame onto the padlist, unless there's already a pad at
1711 this depth, in which case don't bother creating a new one. Then give
1712 the new pad an @_ in slot zero.
1718 Perl_pad_push(pTHX_ PADLIST *padlist, int depth)
1722 PERL_ARGS_ASSERT_PAD_PUSH;
1724 if (depth > AvFILLp(padlist)) {
1725 SV** const svp = AvARRAY(padlist);
1726 AV* const newpad = newAV();
1727 SV** const oldpad = AvARRAY(svp[depth-1]);
1728 I32 ix = AvFILLp((const AV *)svp[1]);
1729 const I32 names_fill = AvFILLp((const AV *)svp[0]);
1730 SV** const names = AvARRAY(svp[0]);
1733 for ( ;ix > 0; ix--) {
1734 if (names_fill >= ix && names[ix] != &PL_sv_undef) {
1735 const char sigil = SvPVX_const(names[ix])[0];
1736 if ((SvFLAGS(names[ix]) & SVf_FAKE)
1737 || (SvFLAGS(names[ix]) & SVpad_STATE)
1740 /* outer lexical or anon code */
1741 av_store(newpad, ix, SvREFCNT_inc(oldpad[ix]));
1743 else { /* our own lexical */
1746 sv = MUTABLE_SV(newAV());
1747 else if (sigil == '%')
1748 sv = MUTABLE_SV(newHV());
1751 av_store(newpad, ix, sv);
1755 else if (IS_PADGV(oldpad[ix]) || IS_PADCONST(oldpad[ix])) {
1756 av_store(newpad, ix, SvREFCNT_inc_NN(oldpad[ix]));
1759 /* save temporaries on recursion? */
1760 SV * const sv = newSV(0);
1761 av_store(newpad, ix, sv);
1766 av_store(newpad, 0, MUTABLE_SV(av));
1769 av_store(padlist, depth, MUTABLE_SV(newpad));
1770 AvFILLp(padlist) = depth;
1776 Perl_pad_compname_type(pTHX_ const PADOFFSET po)
1779 SV* const * const av = av_fetch(PL_comppad_name, po, FALSE);
1780 if ( SvPAD_TYPED(*av) ) {
1781 return SvSTASH(*av);
1786 #if defined(USE_ITHREADS)
1788 # define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
1791 Perl_padlist_dup(pTHX_ AV *const srcpad, CLONE_PARAMS *const param)
1794 PERL_ARGS_ASSERT_PADLIST_DUP;
1799 assert(!AvREAL(srcpad));
1801 if (param->flags & CLONEf_COPY_STACKS
1802 || SvREFCNT(AvARRAY(srcpad)[1]) > 1) {
1803 /* XXX padlists are real, but pretend to be not */
1805 dstpad = av_dup_inc(srcpad, param);
1808 assert (SvREFCNT(AvARRAY(srcpad)[1]) == 1);
1810 /* CvDEPTH() on our subroutine will be set to 0, so there's no need
1811 to build anything other than the first level of pads. */
1813 I32 ix = AvFILLp((const AV *)AvARRAY(srcpad)[1]);
1815 const I32 names_fill = AvFILLp((const AV *)(AvARRAY(srcpad)[0]));
1816 const AV *const srcpad1 = (const AV *) AvARRAY(srcpad)[1];
1817 SV **oldpad = AvARRAY(srcpad1);
1821 /* look for it in the table first.
1822 I *think* that it shouldn't be possible to find it there.
1823 Well, except for how Perl_sv_compile_2op() "works" :-( */
1824 dstpad = (AV*)ptr_table_fetch(PL_ptr_table, srcpad);
1830 ptr_table_store(PL_ptr_table, srcpad, dstpad);
1832 av_extend(dstpad, 1);
1833 AvARRAY(dstpad)[0] = MUTABLE_SV(av_dup_inc(AvARRAY(srcpad)[0], param));
1834 names = AvARRAY(AvARRAY(dstpad)[0]);
1838 av_extend(pad1, ix);
1839 AvARRAY(dstpad)[1] = MUTABLE_SV(pad1);
1840 pad1a = AvARRAY(pad1);
1841 AvFILLp(dstpad) = 1;
1846 for ( ;ix > 0; ix--) {
1849 } else if (names_fill >= ix && names[ix] != &PL_sv_undef) {
1850 const char sigil = SvPVX_const(names[ix])[0];
1851 if ((SvFLAGS(names[ix]) & SVf_FAKE)
1852 || (SvFLAGS(names[ix]) & SVpad_STATE)
1855 /* outer lexical or anon code */
1856 pad1a[ix] = sv_dup_inc(oldpad[ix], param);
1858 else { /* our own lexical */
1859 if(SvPADSTALE(oldpad[ix]) && SvREFCNT(oldpad[ix]) > 1) {
1860 /* This is a work around for how the current
1861 implementation of ?{ } blocks in regexps
1862 interacts with lexicals. */
1863 pad1a[ix] = sv_dup_inc(oldpad[ix], param);
1868 sv = MUTABLE_SV(newAV());
1869 else if (sigil == '%')
1870 sv = MUTABLE_SV(newHV());
1878 else if (IS_PADGV(oldpad[ix]) || IS_PADCONST(oldpad[ix])) {
1879 pad1a[ix] = sv_dup_inc(oldpad[ix], param);
1882 /* save temporaries on recursion? */
1883 SV * const sv = newSV(0);
1886 /* SvREFCNT(oldpad[ix]) != 1 for some code in threads.xs
1887 FIXTHAT before merging this branch.
1888 (And I know how to) */
1889 if (SvPADMY(oldpad[ix]))
1897 args = newAV(); /* Will be @_ */
1899 pad1a[0] = (SV *)args;
1911 * c-indentation-style: bsd
1913 * indent-tabs-mode: t
1916 * ex: set ts=8 sts=4 sw=4 noet: