3 * Copyright (c) 2002, Larry Wall
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
8 * "Anyway: there was this Mr Frodo left an orphan and stranded, as you
9 * might say, among those queer Bucklanders, being brought up anyhow in
10 * Brandy Hall. A regular warren, by all accounts. Old Master Gorbadoc
11 * never had fewer than a couple of hundred relations in the place. Mr
12 * Bilbo never did a kinder deed than when he brought the lad back to
13 * live among decent folk." --the Gaffer
17 * As of Sept 2002, this file is new and may be in a state of flux for
18 * a while. I've marked things I intent to come back and look at further
19 * with an 'XXX DAPM' comment.
23 =head1 Pad Data Structures
25 =for apidoc m|AV *|CvPADLIST|CV *cv
26 CV's can have CvPADLIST(cv) set to point to an AV.
28 For these purposes "forms" are a kind-of CV, eval""s are too (except they're
29 not callable at will and are always thrown away after the eval"" is done
32 XSUBs don't have CvPADLIST set - dXSTARG fetches values from PL_curpad,
33 but that is really the callers pad (a slot of which is allocated by
36 The CvPADLIST AV has does not have AvREAL set, so REFCNT of component items
37 is managed "manual" (mostly in pad.c) rather than normal av.c rules.
38 The items in the AV are not SVs as for a normal AV, but other AVs:
40 0'th Entry of the CvPADLIST is an AV which represents the "names" or rather
41 the "static type information" for lexicals.
43 The CvDEPTH'th entry of CvPADLIST AV is an AV which is the stack frame at that
44 depth of recursion into the CV.
45 The 0'th slot of a frame AV is an AV which is @_.
46 other entries are storage for variables and op targets.
49 C<PL_comppad_name> is set the the the names AV.
50 C<PL_comppad> is set the the frame AV for the frame CvDEPTH == 1.
51 C<PL_curpad> is set the body of the frame AV (i.e. AvARRAY(PL_comppad)).
53 During execution, C<PL_comppad> and C<PL_curpad> refer to the live
54 frame of the currently executing sub.
56 Iterating over the names AV iterates over all possible pad
57 items. Pad slots that are SVs_PADTMP (targets/GVs/constants) end up having
58 &PL_sv_undef "names" (see pad_alloc()).
60 Only my/our variable (SVs_PADMY/SVs_PADOUR) slots get valid names.
61 The rest are op targets/GVs/constants which are statically allocated
62 or resolved at compile time. These don't have names by which they
63 can be looked up from Perl code at run time through eval"" like
64 my/our variables can be. Since they can't be looked up by "name"
65 but only by their index allocated at compile time (which is usually
66 in PL_op->op_targ), wasting a name SV for them doesn't make sense.
68 The SVs in the names AV have their PV being the name of the variable.
69 NV+1..IV inclusive is a range of cop_seq numbers for which the name is
70 valid. For typed lexicals name SV is SVt_PVMG and SvSTASH points at the
71 type. For C<our> lexicals, the type is SVt_PVGV, and GvSTASH points at the
72 stash of the associated global (so that duplicate C<our> delarations in the
73 same package can be detected). SvCUR is sometimes hijacked to
74 store the generation number during compilation.
76 If SvFAKE is set on the name SV then slot in the frame AVs are
77 a REFCNT'ed references to a lexical from "outside". In this case,
78 the name SV does not have a cop_seq range, since it is in scope
81 If the 'name' is '&' the the corresponding entry in frame AV
82 is a CV representing a possible closure.
83 (SvFAKE and name of '&' is not a meaningful combination currently but could
84 become so if C<my sub foo {}> is implemented.)
95 #define PAD_MAX 999999999
102 Create a new compiling padlist, saving and updating the various global
103 vars at the same time as creating the pad itself. The following flags
104 can be OR'ed together:
106 padnew_CLONE this pad is for a cloned CV
107 padnew_SAVE save old globals
108 padnew_SAVESUB also save extra stuff for start of sub
114 Perl_pad_new(pTHX_ int flags)
116 AV *padlist, *padname, *pad, *a0;
118 ASSERT_CURPAD_LEGAL("pad_new");
120 /* XXX DAPM really need a new SAVEt_PAD which restores all or most
121 * vars (based on flags) rather than storing vals + addresses for
122 * each individually. Also see pad_block_start.
123 * XXX DAPM Try to see whether all these conditionals are required
126 /* save existing state, ... */
128 if (flags & padnew_SAVE) {
130 SAVESPTR(PL_comppad_name);
131 if (! (flags & padnew_CLONE)) {
133 SAVEI32(PL_comppad_name_fill);
134 SAVEI32(PL_min_intro_pending);
135 SAVEI32(PL_max_intro_pending);
136 if (flags & padnew_SAVESUB) {
137 SAVEI32(PL_pad_reset_pending);
141 /* XXX DAPM interestingly, PL_comppad_name_floor never seems to be
142 * saved - check at some pt that this is okay */
144 /* ... create new pad ... */
150 if (flags & padnew_CLONE) {
151 /* XXX DAPM I dont know why cv_clone needs it
152 * doing differently yet - perhaps this separate branch can be
153 * dispensed with eventually ???
156 a0 = newAV(); /* will be @_ */
158 av_store(pad, 0, (SV*)a0);
159 AvFLAGS(a0) = AVf_REIFY;
162 av_store(pad, 0, Nullsv);
166 av_store(padlist, 0, (SV*)padname);
167 av_store(padlist, 1, (SV*)pad);
169 /* ... then update state variables */
171 PL_comppad_name = (AV*)(*av_fetch(padlist, 0, FALSE));
172 PL_comppad = (AV*)(*av_fetch(padlist, 1, FALSE));
173 PL_curpad = AvARRAY(PL_comppad);
175 if (! (flags & padnew_CLONE)) {
176 PL_comppad_name_fill = 0;
177 PL_min_intro_pending = 0;
181 DEBUG_X(PerlIO_printf(Perl_debug_log,
182 "Pad 0x%"UVxf"[0x%"UVxf"] new: padlist=0x%"UVxf
183 " name=0x%"UVxf" flags=0x%"UVxf"\n",
184 PTR2UV(PL_comppad), PTR2UV(PL_curpad), PTR2UV(padlist),
185 PTR2UV(padname), (UV)flags
189 return (PADLIST*)padlist;
193 =for apidoc pad_undef
195 Free the padlist associated with a CV.
196 If parts of it happen to be current, we null the relevant
197 PL_*pad* global vars so that we don't have any dangling references left.
198 We also repoint the CvOUTSIDE of any about-to-be-orphaned
199 inner subs to the outer of this cv.
201 (This function should really be called pad_free, but the name was already
208 Perl_pad_undef(pTHX_ CV* cv)
211 PADLIST *padlist = CvPADLIST(cv);
215 if (!SvREFCNT(CvPADLIST(cv))) /* may be during global destruction */
218 DEBUG_X(PerlIO_printf(Perl_debug_log,
219 "Pad undef: padlist=0x%"UVxf"\n" , PTR2UV(padlist))
222 /* detach any '&' anon children in the pad; if afterwards they
223 * are still live, fix up their CvOUTSIDEs to point to our outside,
225 /* XXX DAPM for efficiency, we should only do this if we know we have
226 * children, or integrate this loop with general cleanup */
228 if (!PL_dirty) { /* don't bother during global destruction */
229 CV *outercv = CvOUTSIDE(cv);
230 U32 seq = CvOUTSIDE_SEQ(cv);
231 AV *comppad_name = (AV*)AvARRAY(padlist)[0];
232 SV **namepad = AvARRAY(comppad_name);
233 AV *comppad = (AV*)AvARRAY(padlist)[1];
234 SV **curpad = AvARRAY(comppad);
235 for (ix = AvFILLp(comppad_name); ix > 0; ix--) {
236 SV *namesv = namepad[ix];
237 if (namesv && namesv != &PL_sv_undef
238 && *SvPVX(namesv) == '&')
240 CV *innercv = (CV*)curpad[ix];
241 namepad[ix] = Nullsv;
242 SvREFCNT_dec(namesv);
244 SvREFCNT_dec(innercv);
245 if (SvREFCNT(innercv) /* in use, not just a prototype */
246 && CvOUTSIDE(innercv) == cv)
248 assert(CvWEAKOUTSIDE(innercv));
249 CvWEAKOUTSIDE_off(innercv);
250 CvOUTSIDE(innercv) = outercv;
251 CvOUTSIDE_SEQ(innercv) = seq;
252 SvREFCNT_inc(outercv);
258 ix = AvFILLp(padlist);
260 SV* sv = AvARRAY(padlist)[ix--];
263 if (sv == (SV*)PL_comppad_name)
264 PL_comppad_name = Nullav;
265 else if (sv == (SV*)PL_comppad) {
266 PL_comppad = Null(PAD*);
267 PL_curpad = Null(SV**);
271 SvREFCNT_dec((SV*)CvPADLIST(cv));
272 CvPADLIST(cv) = Null(PADLIST*);
279 =for apidoc pad_add_name
281 Create a new name in the current pad at the specified offset.
282 If C<typestash> is valid, the name is for a typed lexical; set the
283 name's stash to that value.
284 If C<ourstash> is valid, it's an our lexical, set the name's
285 GvSTASH to that value
287 Also, if the name is @.. or %.., create a new array or hash for that slot
289 If fake, it means we're cloning an existing entry
295 * XXX DAPM this doesn't seem the right place to create a new array/hash.
296 * Whatever we do, we should be consistent - create scalars too, and
297 * create even if fake. Really need to integrate better the whole entry
298 * creation business - when + where does the name and value get created?
302 Perl_pad_add_name(pTHX_ char *name, HV* typestash, HV* ourstash, bool fake)
304 PADOFFSET offset = pad_alloc(OP_PADSV, SVs_PADMY);
305 SV* namesv = NEWSV(1102, 0);
307 ASSERT_CURPAD_ACTIVE("pad_add_name");
310 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
311 "Pad addname: %ld \"%s\"%s\n",
312 (long)offset, name, (fake ? " FAKE" : "")
316 sv_upgrade(namesv, ourstash ? SVt_PVGV : typestash ? SVt_PVMG : SVt_PVNV);
317 sv_setpv(namesv, name);
320 SvFLAGS(namesv) |= SVpad_TYPED;
321 SvSTASH(namesv) = (HV*)SvREFCNT_inc((SV*) typestash);
324 SvFLAGS(namesv) |= SVpad_OUR;
325 GvSTASH(namesv) = (HV*)SvREFCNT_inc((SV*) ourstash);
328 av_store(PL_comppad_name, offset, namesv);
332 /* not yet introduced */
333 SvNVX(namesv) = (NV)PAD_MAX; /* min */
334 SvIVX(namesv) = 0; /* max */
336 if (!PL_min_intro_pending)
337 PL_min_intro_pending = offset;
338 PL_max_intro_pending = offset;
339 /* XXX DAPM since slot has been allocated, replace
340 * av_store with PL_curpad[offset] ? */
342 av_store(PL_comppad, offset, (SV*)newAV());
343 else if (*name == '%')
344 av_store(PL_comppad, offset, (SV*)newHV());
345 SvPADMY_on(PL_curpad[offset]);
355 =for apidoc pad_alloc
357 Allocate a new my or tmp pad entry. For a my, simply push a null SV onto
358 the end of PL_comppad, but for a tmp, scan the pad from PL_padix upwards
359 for a slot which has no name and and no active value.
364 /* XXX DAPM integrate alloc(), add_name() and add_anon(),
365 * or at least rationalise ??? */
369 Perl_pad_alloc(pTHX_ I32 optype, U32 tmptype)
374 ASSERT_CURPAD_ACTIVE("pad_alloc");
376 if (AvARRAY(PL_comppad) != PL_curpad)
377 Perl_croak(aTHX_ "panic: pad_alloc");
378 if (PL_pad_reset_pending)
380 if (tmptype & SVs_PADMY) {
381 sv = *av_fetch(PL_comppad, AvFILLp(PL_comppad) + 1, TRUE);
382 retval = AvFILLp(PL_comppad);
385 SV **names = AvARRAY(PL_comppad_name);
386 SSize_t names_fill = AvFILLp(PL_comppad_name);
389 * "foreach" index vars temporarily become aliases to non-"my"
390 * values. Thus we must skip, not just pad values that are
391 * marked as current pad values, but also those with names.
393 /* HVDS why copy to sv here? we don't seem to use it */
394 if (++PL_padix <= names_fill &&
395 (sv = names[PL_padix]) && sv != &PL_sv_undef)
397 sv = *av_fetch(PL_comppad, PL_padix, TRUE);
398 if (!(SvFLAGS(sv) & (SVs_PADTMP | SVs_PADMY)) &&
399 !IS_PADGV(sv) && !IS_PADCONST(sv))
404 SvFLAGS(sv) |= tmptype;
405 PL_curpad = AvARRAY(PL_comppad);
407 DEBUG_X(PerlIO_printf(Perl_debug_log,
408 "Pad 0x%"UVxf"[0x%"UVxf"] alloc: %ld for %s\n",
409 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long) retval,
410 PL_op_name[optype]));
411 return (PADOFFSET)retval;
415 =for apidoc pad_add_anon
417 Add an anon code entry to the current compiling pad
423 Perl_pad_add_anon(pTHX_ SV* sv, OPCODE op_type)
428 name = NEWSV(1106, 0);
429 sv_upgrade(name, SVt_PVNV);
430 sv_setpvn(name, "&", 1);
433 ix = pad_alloc(op_type, SVs_PADMY);
434 av_store(PL_comppad_name, ix, name);
435 /* XXX DAPM use PL_curpad[] ? */
436 av_store(PL_comppad, ix, sv);
439 /* to avoid ref loops, we never have parent + child referencing each
440 * other simultaneously */
441 if (CvOUTSIDE((CV*)sv)) {
442 assert(!CvWEAKOUTSIDE((CV*)sv));
443 CvWEAKOUTSIDE_on((CV*)sv);
444 SvREFCNT_dec(CvOUTSIDE((CV*)sv));
452 =for apidoc pad_check_dup
454 Check for duplicate declarations: report any of:
455 * a my in the current scope with the same name;
456 * an our (anywhere in the pad) with the same name and the same stash
458 C<is_our> indicates that the name to check is an 'our' declaration
463 /* XXX DAPM integrate this into pad_add_name ??? */
466 Perl_pad_check_dup(pTHX_ char *name, bool is_our, HV *ourstash)
471 ASSERT_CURPAD_ACTIVE("pad_check_dup");
472 if (!ckWARN(WARN_MISC) || AvFILLp(PL_comppad_name) < 0)
473 return; /* nothing to check */
475 svp = AvARRAY(PL_comppad_name);
476 top = AvFILLp(PL_comppad_name);
477 /* check the current scope */
478 /* XXX DAPM - why the (I32) cast - shouldn't we ensure they're the same
480 for (off = top; (I32)off > PL_comppad_name_floor; off--) {
482 && sv != &PL_sv_undef
484 && (SvIVX(sv) == PAD_MAX || SvIVX(sv) == 0)
486 || ((SvFLAGS(sv) & SVpad_OUR) && GvSTASH(sv) == ourstash))
487 && strEQ(name, SvPVX(sv)))
489 Perl_warner(aTHX_ packWARN(WARN_MISC),
490 "\"%s\" variable %s masks earlier declaration in same %s",
491 (is_our ? "our" : "my"),
493 (SvIVX(sv) == PAD_MAX ? "scope" : "statement"));
498 /* check the rest of the pad */
502 && sv != &PL_sv_undef
504 && (SvIVX(sv) == PAD_MAX || SvIVX(sv) == 0)
505 && ((SvFLAGS(sv) & SVpad_OUR) && GvSTASH(sv) == ourstash)
506 && strEQ(name, SvPVX(sv)))
508 Perl_warner(aTHX_ packWARN(WARN_MISC),
509 "\"our\" variable %s redeclared", name);
510 Perl_warner(aTHX_ packWARN(WARN_MISC),
511 "\t(Did you mean \"local\" instead of \"our\"?)\n");
514 } while ( off-- > 0 );
521 =for apidoc pad_findmy
523 Given a lexical name, try to find its offset, first in the current pad,
524 or failing that, in the pads of any lexically enclosing subs (including
525 the complications introduced by eval). If the name is found in an outer pad,
526 then a fake entry is added to the current pad.
527 Returns the offset in the current pad, or NOT_IN_PAD on failure.
533 Perl_pad_findmy(pTHX_ char *name)
538 SV **svp = AvARRAY(PL_comppad_name);
539 U32 seq = PL_cop_seqmax;
541 ASSERT_CURPAD_ACTIVE("pad_findmy");
542 DEBUG_Xv(PerlIO_printf(Perl_debug_log, "Pad findmy: \"%s\"\n", name));
544 /* The one we're looking for is probably just before comppad_name_fill. */
545 for (off = AvFILLp(PL_comppad_name); off > 0; off--) {
547 if (!sv || sv == &PL_sv_undef || !strEQ(SvPVX(sv), name))
550 /* we'll use this later if we don't find a real entry */
555 if ( seq > (U32)I_32(SvNVX(sv)) /* min */
556 && seq <= (U32)SvIVX(sv)) /* max */
563 /* See if it's in a nested scope */
564 off = pad_findlex(name, 0, PL_compcv);
565 if (!off) /* pad_findlex returns 0 for failure...*/
566 return NOT_IN_PAD; /* ...but we return NOT_IN_PAD for failure */
574 =for apidoc pad_findlex
576 Find a named lexical anywhere in a chain of nested pads. Add fake entries
577 in the inner pads if it's found in an outer one. innercv is the CV *inside*
578 the chain of outer CVs to be searched. If newoff is non-null, this is a
579 run-time cloning: don't add fake entries, just find the lexical and add a
580 ref to it at newoff in the current pad.
586 S_pad_findlex(pTHX_ char *name, PADOFFSET newoff, CV* innercv)
598 ASSERT_CURPAD_ACTIVE("pad_findlex");
599 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
600 "Pad findlex: \"%s\" off=%ld startcv=0x%"UVxf"\n",
601 name, (long)newoff, PTR2UV(innercv))
604 seq = CvOUTSIDE_SEQ(innercv);
605 startcv = CvOUTSIDE(innercv);
607 for (cv = startcv; cv; seq = CvOUTSIDE_SEQ(cv), cv = CvOUTSIDE(cv)) {
612 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
613 " searching: cv=0x%"UVxf" seq=%d\n",
614 PTR2UV(cv), (int) seq )
617 curlist = CvPADLIST(cv);
619 continue; /* an undef CV */
620 svp = av_fetch(curlist, 0, FALSE);
621 if (!svp || *svp == &PL_sv_undef)
624 svp = AvARRAY(curname);
627 for (off = AvFILLp(curname); off > 0; off--) {
629 if (!sv || sv == &PL_sv_undef || !strEQ(SvPVX(sv), name))
632 /* we'll use this later if we don't find a real entry */
637 if ( seq > (U32)I_32(SvNVX(sv)) /* min */
638 && seq <= (U32)SvIVX(sv) /* max */
639 && !(newoff && !depth) /* ignore inactive when cloning */
645 /* no real entry - but did we find a fake one? */
647 if (newoff && !depth)
648 return 0; /* don't clone from inactive stack frame */
661 oldpad = (AV*)AvARRAY(curlist)[depth];
662 oldsv = *av_fetch(oldpad, off, TRUE);
666 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
667 " matched: offset %ld"
668 " FAKE, sv=0x%"UVxf"\n",
674 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
675 " matched: offset %ld"
676 " (%lu,%lu), sv=0x%"UVxf"\n",
678 (unsigned long)I_32(SvNVX(sv)),
679 (unsigned long)SvIVX(sv),
685 if (!newoff) { /* Not a mere clone operation. */
686 newoff = pad_add_name(
688 (SvFLAGS(sv) & SVpad_TYPED) ? SvSTASH(sv) : Nullhv,
689 (SvFLAGS(sv) & SVpad_OUR) ? GvSTASH(sv) : Nullhv,
693 if (CvANON(PL_compcv) || SvTYPE(PL_compcv) == SVt_PVFM) {
694 /* "It's closures all the way down." */
695 CvCLONE_on(PL_compcv);
697 if (CvANON(PL_compcv))
698 oldsv = Nullsv; /* no need to keep ref */
703 bcv && bcv != cv && !CvCLONE(bcv);
704 bcv = CvOUTSIDE(bcv))
707 /* install the missing pad entry in intervening
708 * nested subs and mark them cloneable. */
709 AV *ocomppad_name = PL_comppad_name;
710 PAD *ocomppad = PL_comppad;
711 AV *padlist = CvPADLIST(bcv);
712 PL_comppad_name = (AV*)AvARRAY(padlist)[0];
713 PL_comppad = (AV*)AvARRAY(padlist)[1];
714 PL_curpad = AvARRAY(PL_comppad);
717 (SvFLAGS(sv) & SVpad_TYPED)
718 ? SvSTASH(sv) : Nullhv,
719 (SvFLAGS(sv) & SVpad_OUR)
720 ? GvSTASH(sv) : Nullhv,
724 PL_comppad_name = ocomppad_name;
725 PL_comppad = ocomppad;
726 PL_curpad = ocomppad ?
727 AvARRAY(ocomppad) : Null(SV **);
731 if (ckWARN(WARN_CLOSURE)
732 && !CvUNIQUE(bcv) && !CvUNIQUE(cv))
734 Perl_warner(aTHX_ packWARN(WARN_CLOSURE),
735 "Variable \"%s\" may be unavailable",
743 else if (!CvUNIQUE(PL_compcv)) {
744 if (ckWARN(WARN_CLOSURE) && !SvFAKE(sv) && !CvUNIQUE(cv)
745 && !(SvFLAGS(sv) & SVpad_OUR))
747 Perl_warner(aTHX_ packWARN(WARN_CLOSURE),
748 "Variable \"%s\" will not stay shared", name);
752 av_store(PL_comppad, newoff, SvREFCNT_inc(oldsv));
753 ASSERT_CURPAD_ACTIVE("pad_findlex 2");
754 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
755 "Pad findlex: set offset %ld to sv 0x%"UVxf"\n",
756 (long)newoff, PTR2UV(oldsv)
766 Get the value at offset po in the current pad.
767 Use macro PAD_SV instead of calling this function directly.
774 Perl_pad_sv(pTHX_ PADOFFSET po)
776 ASSERT_CURPAD_ACTIVE("pad_sv");
779 Perl_croak(aTHX_ "panic: pad_sv po");
780 DEBUG_X(PerlIO_printf(Perl_debug_log,
781 "Pad 0x%"UVxf"[0x%"UVxf"] sv: %ld sv=0x%"UVxf"\n",
782 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po, PTR2UV(PL_curpad[po]))
784 return PL_curpad[po];
789 =for apidoc pad_setsv
791 Set the entry at offset po in the current pad to sv.
792 Use the macro PAD_SETSV() rather than calling this function directly.
799 Perl_pad_setsv(pTHX_ PADOFFSET po, SV* sv)
801 ASSERT_CURPAD_ACTIVE("pad_setsv");
803 DEBUG_X(PerlIO_printf(Perl_debug_log,
804 "Pad 0x%"UVxf"[0x%"UVxf"] setsv: %ld sv=0x%"UVxf"\n",
805 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po, PTR2UV(sv))
814 =for apidoc pad_block_start
816 Update the pad compilation state variables on entry to a new block
822 * - integrate this in general state-saving routine ???
823 * - combine with the state-saving going on in pad_new ???
824 * - introduce a new SAVE type that does all this in one go ?
828 Perl_pad_block_start(pTHX_ int full)
830 ASSERT_CURPAD_ACTIVE("pad_block_start");
831 SAVEI32(PL_comppad_name_floor);
832 PL_comppad_name_floor = AvFILLp(PL_comppad_name);
834 PL_comppad_name_fill = PL_comppad_name_floor;
835 if (PL_comppad_name_floor < 0)
836 PL_comppad_name_floor = 0;
837 SAVEI32(PL_min_intro_pending);
838 SAVEI32(PL_max_intro_pending);
839 PL_min_intro_pending = 0;
840 SAVEI32(PL_comppad_name_fill);
841 SAVEI32(PL_padix_floor);
842 PL_padix_floor = PL_padix;
843 PL_pad_reset_pending = FALSE;
850 "Introduce" my variables to visible status.
862 ASSERT_CURPAD_ACTIVE("intro_my");
863 if (! PL_min_intro_pending)
864 return PL_cop_seqmax;
866 svp = AvARRAY(PL_comppad_name);
867 for (i = PL_min_intro_pending; i <= PL_max_intro_pending; i++) {
868 if ((sv = svp[i]) && sv != &PL_sv_undef
869 && !SvFAKE(sv) && !SvIVX(sv))
871 SvIVX(sv) = PAD_MAX; /* Don't know scope end yet. */
872 SvNVX(sv) = (NV)PL_cop_seqmax;
873 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
874 "Pad intromy: %ld \"%s\", (%lu,%lu)\n",
876 (unsigned long)I_32(SvNVX(sv)), (unsigned long)SvIVX(sv))
880 PL_min_intro_pending = 0;
881 PL_comppad_name_fill = PL_max_intro_pending; /* Needn't search higher */
882 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
883 "Pad intromy: seq -> %ld\n", (long)(PL_cop_seqmax+1)));
885 return PL_cop_seqmax++;
889 =for apidoc pad_leavemy
891 Cleanup at end of scope during compilation: set the max seq number for
892 lexicals in this scope and warn of any lexicals that never got introduced.
898 Perl_pad_leavemy(pTHX)
901 SV **svp = AvARRAY(PL_comppad_name);
904 PL_pad_reset_pending = FALSE;
906 ASSERT_CURPAD_ACTIVE("pad_leavemy");
907 if (PL_min_intro_pending && PL_comppad_name_fill < PL_min_intro_pending) {
908 for (off = PL_max_intro_pending; off >= PL_min_intro_pending; off--) {
909 if ((sv = svp[off]) && sv != &PL_sv_undef
910 && !SvFAKE(sv) && ckWARN_d(WARN_INTERNAL))
911 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
912 "%"SVf" never introduced", sv);
915 /* "Deintroduce" my variables that are leaving with this scope. */
916 for (off = AvFILLp(PL_comppad_name); off > PL_comppad_name_fill; off--) {
917 if ((sv = svp[off]) && sv != &PL_sv_undef
918 && !SvFAKE(sv) && SvIVX(sv) == PAD_MAX)
920 SvIVX(sv) = PL_cop_seqmax;
921 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
922 "Pad leavemy: %ld \"%s\", (%lu,%lu)\n",
923 (long)off, SvPVX(sv),
924 (unsigned long)I_32(SvNVX(sv)), (unsigned long)SvIVX(sv))
929 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
930 "Pad leavemy: seq = %ld\n", (long)PL_cop_seqmax));
935 =for apidoc pad_swipe
937 Abandon the tmp in the current pad at offset po and replace with a
944 Perl_pad_swipe(pTHX_ PADOFFSET po, bool refadjust)
946 ASSERT_CURPAD_LEGAL("pad_swipe");
949 if (AvARRAY(PL_comppad) != PL_curpad)
950 Perl_croak(aTHX_ "panic: pad_swipe curpad");
952 Perl_croak(aTHX_ "panic: pad_swipe po");
954 DEBUG_X(PerlIO_printf(Perl_debug_log,
955 "Pad 0x%"UVxf"[0x%"UVxf"] swipe: %ld\n",
956 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po));
959 SvPADTMP_off(PL_curpad[po]);
961 SvREFCNT_dec(PL_curpad[po]);
963 PL_curpad[po] = NEWSV(1107,0);
964 SvPADTMP_on(PL_curpad[po]);
965 if ((I32)po < PL_padix)
971 =for apidoc pad_reset
973 Mark all the current temporaries for reuse
978 /* XXX pad_reset() is currently disabled because it results in serious bugs.
979 * It causes pad temp TARGs to be shared between OPs. Since TARGs are pushed
980 * on the stack by OPs that use them, there are several ways to get an alias
981 * to a shared TARG. Such an alias will change randomly and unpredictably.
982 * We avoid doing this until we can think of a Better Way.
987 #ifdef USE_BROKEN_PAD_RESET
990 if (AvARRAY(PL_comppad) != PL_curpad)
991 Perl_croak(aTHX_ "panic: pad_reset curpad");
993 DEBUG_X(PerlIO_printf(Perl_debug_log,
994 "Pad 0x%"UVxf"[0x%"UVxf"] reset: padix %ld -> %ld",
995 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
996 (long)PL_padix, (long)PL_padix_floor
1000 if (!PL_tainting) { /* Can't mix tainted and non-tainted temporaries. */
1001 for (po = AvMAX(PL_comppad); po > PL_padix_floor; po--) {
1002 if (PL_curpad[po] && !SvIMMORTAL(PL_curpad[po]))
1003 SvPADTMP_off(PL_curpad[po]);
1005 PL_padix = PL_padix_floor;
1008 PL_pad_reset_pending = FALSE;
1013 =for apidoc pad_tidy
1015 Tidy up a pad after we've finished compiling it:
1016 * remove most stuff from the pads of anonsub prototypes;
1018 * mark tmps as such.
1023 /* XXX DAPM surely most of this stuff should be done properly
1024 * at the right time beforehand, rather than going around afterwards
1025 * cleaning up our mistakes ???
1029 Perl_pad_tidy(pTHX_ padtidy_type type)
1033 ASSERT_CURPAD_ACTIVE("pad_tidy");
1034 /* extend curpad to match namepad */
1035 if (AvFILLp(PL_comppad_name) < AvFILLp(PL_comppad))
1036 av_store(PL_comppad_name, AvFILLp(PL_comppad), Nullsv);
1038 if (type == padtidy_SUBCLONE) {
1039 SV **namep = AvARRAY(PL_comppad_name);
1040 for (ix = AvFILLp(PL_comppad); ix > 0; ix--) {
1043 if (SvIMMORTAL(PL_curpad[ix]) || IS_PADGV(PL_curpad[ix]) || IS_PADCONST(PL_curpad[ix]))
1046 * The only things that a clonable function needs in its
1047 * pad are references to outer lexicals and anonymous subs.
1048 * The rest are created anew during cloning.
1050 if (!((namesv = namep[ix]) != Nullsv &&
1051 namesv != &PL_sv_undef &&
1053 *SvPVX(namesv) == '&')))
1055 SvREFCNT_dec(PL_curpad[ix]);
1056 PL_curpad[ix] = Nullsv;
1060 else if (type == padtidy_SUB) {
1061 /* XXX DAPM this same bit of code keeps appearing !!! Rationalise? */
1062 AV *av = newAV(); /* Will be @_ */
1064 av_store(PL_comppad, 0, (SV*)av);
1065 AvFLAGS(av) = AVf_REIFY;
1068 /* XXX DAPM rationalise these two similar branches */
1070 if (type == padtidy_SUB) {
1071 for (ix = AvFILLp(PL_comppad); ix > 0; ix--) {
1072 if (SvIMMORTAL(PL_curpad[ix]) || IS_PADGV(PL_curpad[ix]) || IS_PADCONST(PL_curpad[ix]))
1074 if (!SvPADMY(PL_curpad[ix]))
1075 SvPADTMP_on(PL_curpad[ix]);
1078 else if (type == padtidy_FORMAT) {
1079 for (ix = AvFILLp(PL_comppad); ix > 0; ix--) {
1080 if (!SvPADMY(PL_curpad[ix]) && !SvIMMORTAL(PL_curpad[ix]))
1081 SvPADTMP_on(PL_curpad[ix]);
1084 PL_curpad = AvARRAY(PL_comppad);
1089 =for apidoc pad_free
1091 Free the SV at offet po in the current pad.
1096 /* XXX DAPM integrate with pad_swipe ???? */
1098 Perl_pad_free(pTHX_ PADOFFSET po)
1100 ASSERT_CURPAD_LEGAL("pad_free");
1103 if (AvARRAY(PL_comppad) != PL_curpad)
1104 Perl_croak(aTHX_ "panic: pad_free curpad");
1106 Perl_croak(aTHX_ "panic: pad_free po");
1108 DEBUG_X(PerlIO_printf(Perl_debug_log,
1109 "Pad 0x%"UVxf"[0x%"UVxf"] free: %ld\n",
1110 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po)
1113 if (PL_curpad[po] && PL_curpad[po] != &PL_sv_undef) {
1114 SvPADTMP_off(PL_curpad[po]);
1116 /* SV could be a shared hash key (eg bugid #19022) */
1118 #ifdef PERL_COPY_ON_WRITE
1119 !SvIsCOW(PL_curpad[po])
1121 !SvFAKE(PL_curpad[po])
1124 SvREADONLY_off(PL_curpad[po]); /* could be a freed constant */
1127 if ((I32)po < PL_padix)
1134 =for apidoc do_dump_pad
1136 Dump the contents of a padlist
1142 Perl_do_dump_pad(pTHX_ I32 level, PerlIO *file, PADLIST *padlist, int full)
1154 pad_name = (AV*)*av_fetch((AV*)padlist, 0, FALSE);
1155 pad = (AV*)*av_fetch((AV*)padlist, 1, FALSE);
1156 pname = AvARRAY(pad_name);
1157 ppad = AvARRAY(pad);
1158 Perl_dump_indent(aTHX_ level, file,
1159 "PADNAME = 0x%"UVxf"(0x%"UVxf") PAD = 0x%"UVxf"(0x%"UVxf")\n",
1160 PTR2UV(pad_name), PTR2UV(pname), PTR2UV(pad), PTR2UV(ppad)
1163 for (ix = 1; ix <= AvFILLp(pad_name); ix++) {
1165 if (namesv && namesv == &PL_sv_undef) {
1170 Perl_dump_indent(aTHX_ level+1, file,
1171 "%2d. 0x%"UVxf"<%lu> FAKE \"%s\"\n",
1174 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0),
1178 Perl_dump_indent(aTHX_ level+1, file,
1179 "%2d. 0x%"UVxf"<%lu> (%lu,%lu) \"%s\"\n",
1182 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0),
1183 (unsigned long)I_32(SvNVX(namesv)),
1184 (unsigned long)SvIVX(namesv),
1189 Perl_dump_indent(aTHX_ level+1, file,
1190 "%2d. 0x%"UVxf"<%lu>\n",
1193 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0)
1204 dump the contents of a CV
1211 S_cv_dump(pTHX_ CV *cv, char *title)
1213 CV *outside = CvOUTSIDE(cv);
1214 AV* padlist = CvPADLIST(cv);
1216 PerlIO_printf(Perl_debug_log,
1217 " %s: CV=0x%"UVxf" (%s), OUTSIDE=0x%"UVxf" (%s)\n",
1220 (CvANON(cv) ? "ANON"
1221 : (cv == PL_main_cv) ? "MAIN"
1222 : CvUNIQUE(cv) ? "UNIQUE"
1223 : CvGV(cv) ? GvNAME(CvGV(cv)) : "UNDEFINED"),
1226 : CvANON(outside) ? "ANON"
1227 : (outside == PL_main_cv) ? "MAIN"
1228 : CvUNIQUE(outside) ? "UNIQUE"
1229 : CvGV(outside) ? GvNAME(CvGV(outside)) : "UNDEFINED"));
1231 PerlIO_printf(Perl_debug_log,
1232 " PADLIST = 0x%"UVxf"\n", PTR2UV(padlist));
1233 do_dump_pad(1, Perl_debug_log, padlist, 1);
1235 #endif /* DEBUGGING */
1242 =for apidoc cv_clone
1244 Clone a CV: make a new CV which points to the same code etc, but which
1245 has a newly-created pad built by copying the prototype pad and capturing
1252 Perl_cv_clone(pTHX_ CV *proto)
1256 LOCK_CRED_MUTEX; /* XXX create separate mutex */
1257 cv = cv_clone2(proto, CvOUTSIDE(proto));
1258 UNLOCK_CRED_MUTEX; /* XXX create separate mutex */
1263 /* XXX DAPM separate out cv and paddish bits ???
1264 * ideally the CV-related stuff shouldn't be in pad.c - how about
1268 S_cv_clone2(pTHX_ CV *proto, CV *outside)
1271 AV* protopadlist = CvPADLIST(proto);
1272 AV* protopad_name = (AV*)*av_fetch(protopadlist, 0, FALSE);
1273 AV* protopad = (AV*)*av_fetch(protopadlist, 1, FALSE);
1274 SV** pname = AvARRAY(protopad_name);
1275 SV** ppad = AvARRAY(protopad);
1276 I32 fname = AvFILLp(protopad_name);
1277 I32 fpad = AvFILLp(protopad);
1281 assert(!CvUNIQUE(proto));
1284 SAVESPTR(PL_compcv);
1286 cv = PL_compcv = (CV*)NEWSV(1104, 0);
1287 sv_upgrade((SV *)cv, SvTYPE(proto));
1288 CvFLAGS(cv) = CvFLAGS(proto) & ~(CVf_CLONE|CVf_WEAKOUTSIDE);
1292 CvFILE(cv) = CvXSUB(proto) ? CvFILE(proto)
1293 : savepv(CvFILE(proto));
1295 CvFILE(cv) = CvFILE(proto);
1297 CvGV(cv) = CvGV(proto);
1298 CvSTASH(cv) = CvSTASH(proto);
1299 CvROOT(cv) = OpREFCNT_inc(CvROOT(proto));
1300 CvSTART(cv) = CvSTART(proto);
1302 CvOUTSIDE(cv) = (CV*)SvREFCNT_inc(outside);
1303 CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1307 sv_setpvn((SV*)cv, SvPVX(proto), SvCUR(proto));
1309 CvPADLIST(cv) = comppadlist = pad_new(padnew_CLONE|padnew_SAVE);
1311 for (ix = fname; ix >= 0; ix--)
1312 av_store(PL_comppad_name, ix, SvREFCNT_inc(pname[ix]));
1314 av_fill(PL_comppad, fpad);
1315 PL_curpad = AvARRAY(PL_comppad);
1317 for (ix = fpad; ix > 0; ix--) {
1318 SV* namesv = (ix <= fname) ? pname[ix] : Nullsv;
1319 if (namesv && namesv != &PL_sv_undef) {
1320 char *name = SvPVX(namesv); /* XXX */
1321 if (SvFLAGS(namesv) & SVf_FAKE) { /* lexical from outside? */
1322 I32 off = pad_findlex(name, ix, cv);
1324 PL_curpad[ix] = SvREFCNT_inc(ppad[ix]);
1326 Perl_croak(aTHX_ "panic: cv_clone: %s", name);
1328 else { /* our own lexical */
1331 /* anon code -- we'll come back for it */
1332 sv = SvREFCNT_inc(ppad[ix]);
1334 else if (*name == '@')
1336 else if (*name == '%')
1344 else if (IS_PADGV(ppad[ix]) || IS_PADCONST(ppad[ix])) {
1345 PL_curpad[ix] = SvREFCNT_inc(ppad[ix]);
1348 SV* sv = NEWSV(0, 0);
1354 /* Now that vars are all in place, clone nested closures. */
1356 for (ix = fpad; ix > 0; ix--) {
1357 SV* namesv = (ix <= fname) ? pname[ix] : Nullsv;
1359 && namesv != &PL_sv_undef
1360 && !(SvFLAGS(namesv) & SVf_FAKE)
1361 && *SvPVX(namesv) == '&'
1362 && CvCLONE(ppad[ix]))
1364 CV *kid = cv_clone2((CV*)ppad[ix], cv);
1365 SvREFCNT_dec(ppad[ix]);
1368 PL_curpad[ix] = (SV*)kid;
1369 /* '&' entry points to child, so child mustn't refcnt parent */
1370 CvWEAKOUTSIDE_on(kid);
1376 PerlIO_printf(Perl_debug_log, "\nPad CV clone\n");
1377 cv_dump(outside, "Outside");
1378 cv_dump(proto, "Proto");
1385 SV* const_sv = op_const_sv(CvSTART(cv), cv);
1387 /* constant sub () { $x } closing over $x - see lib/constant.pm */
1389 cv = newCONSTSUB(CvSTASH(proto), 0, const_sv);
1397 =for apidoc pad_fixup_inner_anons
1399 For any anon CVs in the pad, change CvOUTSIDE of that CV from
1400 old_cv to new_cv if necessary. Needed when a newly-compiled CV has to be
1401 moved to a pre-existing CV struct.
1407 Perl_pad_fixup_inner_anons(pTHX_ PADLIST *padlist, CV *old_cv, CV *new_cv)
1410 AV *comppad_name = (AV*)AvARRAY(padlist)[0];
1411 AV *comppad = (AV*)AvARRAY(padlist)[1];
1412 SV **namepad = AvARRAY(comppad_name);
1413 SV **curpad = AvARRAY(comppad);
1414 for (ix = AvFILLp(comppad_name); ix > 0; ix--) {
1415 SV *namesv = namepad[ix];
1416 if (namesv && namesv != &PL_sv_undef
1417 && *SvPVX(namesv) == '&')
1419 CV *innercv = (CV*)curpad[ix];
1420 assert(CvWEAKOUTSIDE(innercv));
1421 assert(CvOUTSIDE(innercv) == old_cv);
1422 CvOUTSIDE(innercv) = new_cv;
1429 =for apidoc pad_push
1431 Push a new pad frame onto the padlist, unless there's already a pad at
1432 this depth, in which case don't bother creating a new one.
1433 If has_args is true, give the new pad an @_ in slot zero.
1439 Perl_pad_push(pTHX_ PADLIST *padlist, int depth, int has_args)
1441 if (depth <= AvFILLp(padlist))
1445 SV** svp = AvARRAY(padlist);
1446 AV *newpad = newAV();
1447 SV **oldpad = AvARRAY(svp[depth-1]);
1448 I32 ix = AvFILLp((AV*)svp[1]);
1449 I32 names_fill = AvFILLp((AV*)svp[0]);
1450 SV** names = AvARRAY(svp[0]);
1452 for ( ;ix > 0; ix--) {
1453 if (names_fill >= ix && names[ix] != &PL_sv_undef) {
1454 char *name = SvPVX(names[ix]);
1455 if ((SvFLAGS(names[ix]) & SVf_FAKE) || *name == '&') {
1456 /* outer lexical or anon code */
1457 av_store(newpad, ix, SvREFCNT_inc(oldpad[ix]));
1459 else { /* our own lexical */
1461 av_store(newpad, ix, sv = (SV*)newAV());
1462 else if (*name == '%')
1463 av_store(newpad, ix, sv = (SV*)newHV());
1465 av_store(newpad, ix, sv = NEWSV(0, 0));
1469 else if (IS_PADGV(oldpad[ix]) || IS_PADCONST(oldpad[ix])) {
1470 av_store(newpad, ix, sv = SvREFCNT_inc(oldpad[ix]));
1473 /* save temporaries on recursion? */
1474 av_store(newpad, ix, sv = NEWSV(0, 0));
1481 av_store(newpad, 0, (SV*)av);
1482 AvFLAGS(av) = AVf_REIFY;
1484 av_store(padlist, depth, (SV*)newpad);
1485 AvFILLp(padlist) = depth;