3 * Copyright (C) 2002,2003 by Larry Wall and others
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
30 executing). Require'd files are simply evals without any outer lexical
33 XSUBs don't have CvPADLIST set - dXSTARG fetches values from PL_curpad,
34 but that is really the callers pad (a slot of which is allocated by
37 The CvPADLIST AV has does not have AvREAL set, so REFCNT of component items
38 is managed "manual" (mostly in pad.c) rather than normal av.c rules.
39 The items in the AV are not SVs as for a normal AV, but other AVs:
41 0'th Entry of the CvPADLIST is an AV which represents the "names" or rather
42 the "static type information" for lexicals.
44 The CvDEPTH'th entry of CvPADLIST AV is an AV which is the stack frame at that
45 depth of recursion into the CV.
46 The 0'th slot of a frame AV is an AV which is @_.
47 other entries are storage for variables and op targets.
50 C<PL_comppad_name> is set to the names AV.
51 C<PL_comppad> is set to the frame AV for the frame CvDEPTH == 1.
52 C<PL_curpad> is set to the body of the frame AV (i.e. AvARRAY(PL_comppad)).
54 During execution, C<PL_comppad> and C<PL_curpad> refer to the live
55 frame of the currently executing sub.
57 Iterating over the names AV iterates over all possible pad
58 items. Pad slots that are SVs_PADTMP (targets/GVs/constants) end up having
59 &PL_sv_undef "names" (see pad_alloc()).
61 Only my/our variable (SVs_PADMY/SVs_PADOUR) slots get valid names.
62 The rest are op targets/GVs/constants which are statically allocated
63 or resolved at compile time. These don't have names by which they
64 can be looked up from Perl code at run time through eval"" like
65 my/our variables can be. Since they can't be looked up by "name"
66 but only by their index allocated at compile time (which is usually
67 in PL_op->op_targ), wasting a name SV for them doesn't make sense.
69 The SVs in the names AV have their PV being the name of the variable.
70 NV+1..IV inclusive is a range of cop_seq numbers for which the name is
71 valid. For typed lexicals name SV is SVt_PVMG and SvSTASH points at the
72 type. For C<our> lexicals, the type is SVt_PVGV, and GvSTASH points at the
73 stash of the associated global (so that duplicate C<our> delarations in the
74 same package can be detected). SvCUR is sometimes hijacked to
75 store the generation number during compilation.
77 If SvFAKE is set on the name SV, then that slot in the frame AV is
78 a REFCNT'ed reference to a lexical from "outside". In this case,
79 the name SV does not use NVX and IVX to store a cop_seq range, since it is
80 in scope throughout. Instead IVX stores some flags containing info about
81 the real lexical (is it declared in an anon, and is it capable of being
82 instantiated multiple times?), and for fake ANONs, NVX contains the index
83 within the parent's pad where the lexical's value is stored, to make
86 If the 'name' is '&' the corresponding entry in frame AV
87 is a CV representing a possible closure.
88 (SvFAKE and name of '&' is not a meaningful combination currently but could
89 become so if C<my sub foo {}> is implemented.)
91 Note that formats are treated as anon subs, and are cloned each time
92 write is called (if necessary).
103 #define PAD_MAX 999999999
110 Create a new compiling padlist, saving and updating the various global
111 vars at the same time as creating the pad itself. The following flags
112 can be OR'ed together:
114 padnew_CLONE this pad is for a cloned CV
115 padnew_SAVE save old globals
116 padnew_SAVESUB also save extra stuff for start of sub
122 Perl_pad_new(pTHX_ int flags)
124 AV *padlist, *padname, *pad, *a0;
126 ASSERT_CURPAD_LEGAL("pad_new");
128 /* XXX DAPM really need a new SAVEt_PAD which restores all or most
129 * vars (based on flags) rather than storing vals + addresses for
130 * each individually. Also see pad_block_start.
131 * XXX DAPM Try to see whether all these conditionals are required
134 /* save existing state, ... */
136 if (flags & padnew_SAVE) {
138 SAVESPTR(PL_comppad_name);
139 if (! (flags & padnew_CLONE)) {
141 SAVEI32(PL_comppad_name_fill);
142 SAVEI32(PL_min_intro_pending);
143 SAVEI32(PL_max_intro_pending);
144 SAVEI32(PL_cv_has_eval);
145 if (flags & padnew_SAVESUB) {
146 SAVEI32(PL_pad_reset_pending);
150 /* XXX DAPM interestingly, PL_comppad_name_floor never seems to be
151 * saved - check at some pt that this is okay */
153 /* ... create new pad ... */
159 if (flags & padnew_CLONE) {
160 /* XXX DAPM I dont know why cv_clone needs it
161 * doing differently yet - perhaps this separate branch can be
162 * dispensed with eventually ???
165 a0 = newAV(); /* will be @_ */
167 av_store(pad, 0, (SV*)a0);
168 AvFLAGS(a0) = AVf_REIFY;
171 av_store(pad, 0, Nullsv);
175 av_store(padlist, 0, (SV*)padname);
176 av_store(padlist, 1, (SV*)pad);
178 /* ... then update state variables */
180 PL_comppad_name = (AV*)(*av_fetch(padlist, 0, FALSE));
181 PL_comppad = (AV*)(*av_fetch(padlist, 1, FALSE));
182 PL_curpad = AvARRAY(PL_comppad);
184 if (! (flags & padnew_CLONE)) {
185 PL_comppad_name_fill = 0;
186 PL_min_intro_pending = 0;
191 DEBUG_X(PerlIO_printf(Perl_debug_log,
192 "Pad 0x%"UVxf"[0x%"UVxf"] new: compcv=0x%"UVxf
193 " name=0x%"UVxf" flags=0x%"UVxf"\n",
194 PTR2UV(PL_comppad), PTR2UV(PL_curpad), PTR2UV(PL_compcv),
195 PTR2UV(padname), (UV)flags
199 return (PADLIST*)padlist;
203 =for apidoc pad_undef
205 Free the padlist associated with a CV.
206 If parts of it happen to be current, we null the relevant
207 PL_*pad* global vars so that we don't have any dangling references left.
208 We also repoint the CvOUTSIDE of any about-to-be-orphaned
209 inner subs to the outer of this cv.
211 (This function should really be called pad_free, but the name was already
218 Perl_pad_undef(pTHX_ CV* cv)
221 PADLIST *padlist = CvPADLIST(cv);
225 if (!SvREFCNT(CvPADLIST(cv))) /* may be during global destruction */
228 DEBUG_X(PerlIO_printf(Perl_debug_log,
229 "Pad undef: cv=0x%"UVxf" padlist=0x%"UVxf"\n",
230 PTR2UV(cv), PTR2UV(padlist))
233 /* detach any '&' anon children in the pad; if afterwards they
234 * are still live, fix up their CvOUTSIDEs to point to our outside,
236 /* XXX DAPM for efficiency, we should only do this if we know we have
237 * children, or integrate this loop with general cleanup */
239 if (!PL_dirty) { /* don't bother during global destruction */
240 CV *outercv = CvOUTSIDE(cv);
241 U32 seq = CvOUTSIDE_SEQ(cv);
242 AV *comppad_name = (AV*)AvARRAY(padlist)[0];
243 SV **namepad = AvARRAY(comppad_name);
244 AV *comppad = (AV*)AvARRAY(padlist)[1];
245 SV **curpad = AvARRAY(comppad);
246 for (ix = AvFILLp(comppad_name); ix > 0; ix--) {
247 SV *namesv = namepad[ix];
248 if (namesv && namesv != &PL_sv_undef
249 && *SvPVX(namesv) == '&')
251 CV *innercv = (CV*)curpad[ix];
252 namepad[ix] = Nullsv;
253 SvREFCNT_dec(namesv);
255 SvREFCNT_dec(innercv);
256 if (SvREFCNT(innercv) /* in use, not just a prototype */
257 && CvOUTSIDE(innercv) == cv)
259 assert(CvWEAKOUTSIDE(innercv));
260 CvWEAKOUTSIDE_off(innercv);
261 CvOUTSIDE(innercv) = outercv;
262 CvOUTSIDE_SEQ(innercv) = seq;
263 SvREFCNT_inc(outercv);
269 ix = AvFILLp(padlist);
271 SV* sv = AvARRAY(padlist)[ix--];
274 if (sv == (SV*)PL_comppad_name)
275 PL_comppad_name = Nullav;
276 else if (sv == (SV*)PL_comppad) {
277 PL_comppad = Null(PAD*);
278 PL_curpad = Null(SV**);
282 SvREFCNT_dec((SV*)CvPADLIST(cv));
283 CvPADLIST(cv) = Null(PADLIST*);
290 =for apidoc pad_add_name
292 Create a new name and associated PADMY SV in the current pad; return the
294 If C<typestash> is valid, the name is for a typed lexical; set the
295 name's stash to that value.
296 If C<ourstash> is valid, it's an our lexical, set the name's
297 GvSTASH to that value
299 If fake, it means we're cloning an existing entry
305 Perl_pad_add_name(pTHX_ char *name, HV* typestash, HV* ourstash, bool fake)
307 PADOFFSET offset = pad_alloc(OP_PADSV, SVs_PADMY);
308 SV* namesv = NEWSV(1102, 0);
310 ASSERT_CURPAD_ACTIVE("pad_add_name");
313 sv_upgrade(namesv, ourstash ? SVt_PVGV : typestash ? SVt_PVMG : SVt_PVNV);
314 sv_setpv(namesv, name);
317 SvFLAGS(namesv) |= SVpad_TYPED;
318 SvSTASH(namesv) = (HV*)SvREFCNT_inc((SV*) typestash);
321 SvFLAGS(namesv) |= SVpad_OUR;
322 GvSTASH(namesv) = (HV*)SvREFCNT_inc((SV*) ourstash);
325 av_store(PL_comppad_name, offset, namesv);
328 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
329 "Pad addname: %ld \"%s\" FAKE\n", (long)offset, name));
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 /* if it's not a simple scalar, replace with an AV or HV */
340 /* XXX DAPM since slot has been allocated, replace
341 * av_store with PL_curpad[offset] ? */
343 av_store(PL_comppad, offset, (SV*)newAV());
344 else if (*name == '%')
345 av_store(PL_comppad, offset, (SV*)newHV());
346 SvPADMY_on(PL_curpad[offset]);
347 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
348 "Pad addname: %ld \"%s\" new lex=0x%"UVxf"\n",
349 (long)offset, name, PTR2UV(PL_curpad[offset])));
359 =for apidoc pad_alloc
361 Allocate a new my or tmp pad entry. For a my, simply push a null SV onto
362 the end of PL_comppad, but for a tmp, scan the pad from PL_padix upwards
363 for a slot which has no name and and no active value.
368 /* XXX DAPM integrate alloc(), add_name() and add_anon(),
369 * or at least rationalise ??? */
373 Perl_pad_alloc(pTHX_ I32 optype, U32 tmptype)
378 ASSERT_CURPAD_ACTIVE("pad_alloc");
380 if (AvARRAY(PL_comppad) != PL_curpad)
381 Perl_croak(aTHX_ "panic: pad_alloc");
382 if (PL_pad_reset_pending)
384 if (tmptype & SVs_PADMY) {
385 sv = *av_fetch(PL_comppad, AvFILLp(PL_comppad) + 1, TRUE);
386 retval = AvFILLp(PL_comppad);
389 SV **names = AvARRAY(PL_comppad_name);
390 SSize_t names_fill = AvFILLp(PL_comppad_name);
393 * "foreach" index vars temporarily become aliases to non-"my"
394 * values. Thus we must skip, not just pad values that are
395 * marked as current pad values, but also those with names.
397 /* HVDS why copy to sv here? we don't seem to use it */
398 if (++PL_padix <= names_fill &&
399 (sv = names[PL_padix]) && sv != &PL_sv_undef)
401 sv = *av_fetch(PL_comppad, PL_padix, TRUE);
402 if (!(SvFLAGS(sv) & (SVs_PADTMP | SVs_PADMY)) &&
403 !IS_PADGV(sv) && !IS_PADCONST(sv))
408 SvFLAGS(sv) |= tmptype;
409 PL_curpad = AvARRAY(PL_comppad);
411 DEBUG_X(PerlIO_printf(Perl_debug_log,
412 "Pad 0x%"UVxf"[0x%"UVxf"] alloc: %ld for %s\n",
413 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long) retval,
414 PL_op_name[optype]));
415 return (PADOFFSET)retval;
419 =for apidoc pad_add_anon
421 Add an anon code entry to the current compiling pad
427 Perl_pad_add_anon(pTHX_ SV* sv, OPCODE op_type)
432 name = NEWSV(1106, 0);
433 sv_upgrade(name, SVt_PVNV);
434 sv_setpvn(name, "&", 1);
437 ix = pad_alloc(op_type, SVs_PADMY);
438 av_store(PL_comppad_name, ix, name);
439 /* XXX DAPM use PL_curpad[] ? */
440 av_store(PL_comppad, ix, sv);
443 /* to avoid ref loops, we never have parent + child referencing each
444 * other simultaneously */
445 if (CvOUTSIDE((CV*)sv)) {
446 assert(!CvWEAKOUTSIDE((CV*)sv));
447 CvWEAKOUTSIDE_on((CV*)sv);
448 SvREFCNT_dec(CvOUTSIDE((CV*)sv));
456 =for apidoc pad_check_dup
458 Check for duplicate declarations: report any of:
459 * a my in the current scope with the same name;
460 * an our (anywhere in the pad) with the same name and the same stash
462 C<is_our> indicates that the name to check is an 'our' declaration
467 /* XXX DAPM integrate this into pad_add_name ??? */
470 Perl_pad_check_dup(pTHX_ char *name, bool is_our, HV *ourstash)
475 ASSERT_CURPAD_ACTIVE("pad_check_dup");
476 if (!ckWARN(WARN_MISC) || AvFILLp(PL_comppad_name) < 0)
477 return; /* nothing to check */
479 svp = AvARRAY(PL_comppad_name);
480 top = AvFILLp(PL_comppad_name);
481 /* check the current scope */
482 /* XXX DAPM - why the (I32) cast - shouldn't we ensure they're the same
484 for (off = top; (I32)off > PL_comppad_name_floor; off--) {
486 && sv != &PL_sv_undef
488 && (SvIVX(sv) == PAD_MAX || SvIVX(sv) == 0)
490 || ((SvFLAGS(sv) & SVpad_OUR) && GvSTASH(sv) == ourstash))
491 && strEQ(name, SvPVX(sv)))
493 Perl_warner(aTHX_ packWARN(WARN_MISC),
494 "\"%s\" variable %s masks earlier declaration in same %s",
495 (is_our ? "our" : "my"),
497 (SvIVX(sv) == PAD_MAX ? "scope" : "statement"));
502 /* check the rest of the pad */
506 && sv != &PL_sv_undef
508 && (SvIVX(sv) == PAD_MAX || SvIVX(sv) == 0)
509 && ((SvFLAGS(sv) & SVpad_OUR) && GvSTASH(sv) == ourstash)
510 && strEQ(name, SvPVX(sv)))
512 Perl_warner(aTHX_ packWARN(WARN_MISC),
513 "\"our\" variable %s redeclared", name);
514 Perl_warner(aTHX_ packWARN(WARN_MISC),
515 "\t(Did you mean \"local\" instead of \"our\"?)\n");
518 } while ( off-- > 0 );
524 =for apidoc pad_findmy
526 Given a lexical name, try to find its offset, first in the current pad,
527 or failing that, in the pads of any lexically enclosing subs (including
528 the complications introduced by eval). If the name is found in an outer pad,
529 then a fake entry is added to the current pad.
530 Returns the offset in the current pad, or NOT_IN_PAD on failure.
536 Perl_pad_findmy(pTHX_ char *name)
541 return pad_findlex(name, PL_compcv, PL_cop_seqmax, 1,
542 Null(SV**), &out_sv, &out_flags);
547 =for apidoc pad_findlex
549 Find a named lexical anywhere in a chain of nested pads. Add fake entries
550 in the inner pads if it's found in an outer one.
552 Returns the offset in the bottom pad of the lex or the fake lex.
553 cv is the CV in which to start the search, and seq is the current cop_seq
554 to match against. If warn is true, print appropriate warnings. The out_*
555 vars return values, and so are pointers to where the returned values
556 should be stored. out_capture, if non-null, requests that the innermost
557 instance of the lexical is captured; out_name_sv is set to the innermost
558 matched namesv or fake namesv; out_flags returns the flags normally
559 associated with the IVX field of a fake namesv.
561 Note that pad_findlex() is recursive; it recurses up the chain of CVs,
562 then comes back down, adding fake entries as it goes. It has to be this way
563 because fake namesvs in anon protoypes have to store in NVX the index into
569 /* Flags set in the SvIVX field of FAKE namesvs */
571 #define PAD_FAKELEX_ANON 1 /* the lex is declared in an ANON, or ... */
572 #define PAD_FAKELEX_MULTI 2 /* the lex can be instantiated multiple times */
574 /* the CV has finished being compiled. This is not a sufficient test for
575 * all CVs (eg XSUBs), but suffices for the CVs found in a lexical chain */
576 #define CvCOMPILED(cv) CvROOT(cv)
578 /* the CV does late binding of its lexicals */
579 #define CvLATE(cv) (CvANON(cv) || SvTYPE(cv) == SVt_PVFM)
583 S_pad_findlex(pTHX_ char *name, CV* cv, U32 seq, int warn,
584 SV** out_capture, SV** out_name_sv, int *out_flags)
586 I32 offset, new_offset;
589 AV *padlist = CvPADLIST(cv);
593 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
594 "Pad findlex cv=0x%"UVxf" searching \"%s\" seq=%d%s\n",
595 PTR2UV(cv), name, (int)seq, out_capture ? " capturing" : "" ));
597 /* first, search this pad */
599 if (padlist) { /* not an undef CV */
601 AV *nameav = (AV*)AvARRAY(padlist)[0];
602 SV **name_svp = AvARRAY(nameav);
604 for (offset = AvFILLp(nameav); offset > 0; offset--) {
605 SV *namesv = name_svp[offset];
606 if (namesv && namesv != &PL_sv_undef
607 && strEQ(SvPVX(namesv), name))
610 fake_offset = offset; /* in case we don't find a real one */
611 else if ( seq > (U32)I_32(SvNVX(namesv)) /* min */
612 && seq <= (U32)SvIVX(namesv)) /* max */
617 if (offset > 0 || fake_offset > 0 ) { /* a match! */
618 if (offset > 0) { /* not fake */
620 *out_name_sv = name_svp[offset]; /* return the namesv */
622 /* set PAD_FAKELEX_MULTI if this lex can have multiple
623 * instances. For now, we just test !CvUNIQUE(cv), but
624 * ideally, we should detect my's declared within loops
625 * etc - this would allow a wider range of 'not stayed
626 * shared' warnings. We also treated alreadly-compiled
627 * lexes as not multi as viewed from evals. */
629 *out_flags = CvANON(cv) ?
631 (!CvUNIQUE(cv) && ! CvCOMPILED(cv))
632 ? PAD_FAKELEX_MULTI : 0;
634 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
635 "Pad findlex cv=0x%"UVxf" matched: offset=%ld (%ld,%ld)\n",
636 PTR2UV(cv), (long)offset, (long)I_32(SvNVX(*out_name_sv)),
637 (long)SvIVX(*out_name_sv)));
639 else { /* fake match */
640 offset = fake_offset;
641 *out_name_sv = name_svp[offset]; /* return the namesv */
642 *out_flags = SvIVX(*out_name_sv);
643 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
644 "Pad findlex cv=0x%"UVxf" matched: offset=%ld flags=0x%x index=%lu\n",
645 PTR2UV(cv), (long)offset, (unsigned long)*out_flags,
646 (unsigned long)SvNVX(*out_name_sv)
650 /* return the lex? */
655 if ((SvFLAGS(*out_name_sv) & SVpad_OUR)) {
656 *out_capture = Nullsv;
660 /* trying to capture from an anon prototype? */
662 ? CvANON(cv) && CvCLONE(cv) && !CvCLONED(cv)
663 : *out_flags & PAD_FAKELEX_ANON)
665 if (warn && ckWARN(WARN_CLOSURE))
666 Perl_warner(aTHX_ packWARN(WARN_CLOSURE),
667 "Variable \"%s\" is not available", name);
668 *out_capture = Nullsv;
674 if (!CvCOMPILED(cv) && (*out_flags & PAD_FAKELEX_MULTI)
675 && warn && ckWARN(WARN_CLOSURE)) {
677 Perl_warner(aTHX_ packWARN(WARN_CLOSURE),
678 "Variable \"%s\" will not stay shared", name);
681 if (fake_offset && CvANON(cv)
682 && CvCLONE(cv) &&!CvCLONED(cv))
685 /* not yet caught - look further up */
686 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
687 "Pad findlex cv=0x%"UVxf" chasing lex in outer pad\n",
690 pad_findlex(name, CvOUTSIDE(cv), CvOUTSIDE_SEQ(cv),
691 newwarn, out_capture, out_name_sv, out_flags);
696 *out_capture = AvARRAY((AV*)AvARRAY(padlist)[
697 CvDEPTH(cv) ? CvDEPTH(cv) : 1])[offset];
698 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
699 "Pad findlex cv=0x%"UVxf" found lex=0x%"UVxf"\n",
700 PTR2UV(cv), *out_capture));
702 if (SvPADSTALE(*out_capture)) {
703 if (ckWARN(WARN_CLOSURE))
704 Perl_warner(aTHX_ packWARN(WARN_CLOSURE),
705 "Variable \"%s\" is not available", name);
706 *out_capture = Nullsv;
711 *out_capture = sv_2mortal((SV*)newAV());
712 else if (*name == '%')
713 *out_capture = sv_2mortal((SV*)newHV());
715 *out_capture = sv_newmortal();
723 /* it's not in this pad - try above */
728 /* out_capture non-null means caller wants us to capture lex; in
729 * addition we capture ourselves unless it's an ANON/format */
730 new_capturep = out_capture ? out_capture :
731 CvLATE(cv) ? Null(SV**) : &new_capture;
733 offset = pad_findlex(name, CvOUTSIDE(cv), CvOUTSIDE_SEQ(cv), 1,
734 new_capturep, out_name_sv, out_flags);
735 if (offset == NOT_IN_PAD)
738 /* found in an outer CV. Add appropriate fake entry to this pad */
740 /* don't add new fake entries (via eval) to CVs that we have already
741 * finished compiling, or to undef CVs */
742 if (CvCOMPILED(cv) || !padlist)
743 return 0; /* this dummy (and invalid) value isnt used by the caller */
747 AV *ocomppad_name = PL_comppad_name;
748 PAD *ocomppad = PL_comppad;
749 PL_comppad_name = (AV*)AvARRAY(padlist)[0];
750 PL_comppad = (AV*)AvARRAY(padlist)[1];
751 PL_curpad = AvARRAY(PL_comppad);
753 new_offset = pad_add_name(
755 (SvFLAGS(*out_name_sv) & SVpad_TYPED)
756 ? SvSTASH(*out_name_sv) : Nullhv,
757 (SvFLAGS(*out_name_sv) & SVpad_OUR)
758 ? GvSTASH(*out_name_sv) : Nullhv,
762 new_namesv = AvARRAY(PL_comppad_name)[new_offset];
763 SvIVX(new_namesv) = *out_flags;
765 SvNVX(new_namesv) = (NV)0;
766 if (SvFLAGS(new_namesv) & SVpad_OUR) {
769 else if (CvLATE(cv)) {
770 /* delayed creation - just note the offset within parent pad */
771 SvNVX(new_namesv) = (NV)offset;
775 /* immediate creation - capture outer value right now */
776 av_store(PL_comppad, new_offset, SvREFCNT_inc(*new_capturep));
777 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
778 "Pad findlex cv=0x%"UVxf" saved captured sv 0x%"UVxf" at offset %ld\n",
779 PTR2UV(cv), PTR2UV(*new_capturep), (long)new_offset));
781 *out_name_sv = new_namesv;
782 *out_flags = SvIVX(new_namesv);
784 PL_comppad_name = ocomppad_name;
785 PL_comppad = ocomppad;
786 PL_curpad = ocomppad ? AvARRAY(ocomppad) : Null(SV **);
795 Get the value at offset po in the current pad.
796 Use macro PAD_SV instead of calling this function directly.
803 Perl_pad_sv(pTHX_ PADOFFSET po)
805 ASSERT_CURPAD_ACTIVE("pad_sv");
808 Perl_croak(aTHX_ "panic: pad_sv po");
809 DEBUG_X(PerlIO_printf(Perl_debug_log,
810 "Pad 0x%"UVxf"[0x%"UVxf"] sv: %ld sv=0x%"UVxf"\n",
811 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po, PTR2UV(PL_curpad[po]))
813 return PL_curpad[po];
818 =for apidoc pad_setsv
820 Set the entry at offset po in the current pad to sv.
821 Use the macro PAD_SETSV() rather than calling this function directly.
828 Perl_pad_setsv(pTHX_ PADOFFSET po, SV* sv)
830 ASSERT_CURPAD_ACTIVE("pad_setsv");
832 DEBUG_X(PerlIO_printf(Perl_debug_log,
833 "Pad 0x%"UVxf"[0x%"UVxf"] setsv: %ld sv=0x%"UVxf"\n",
834 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po, PTR2UV(sv))
843 =for apidoc pad_block_start
845 Update the pad compilation state variables on entry to a new block
851 * - integrate this in general state-saving routine ???
852 * - combine with the state-saving going on in pad_new ???
853 * - introduce a new SAVE type that does all this in one go ?
857 Perl_pad_block_start(pTHX_ int full)
859 ASSERT_CURPAD_ACTIVE("pad_block_start");
860 SAVEI32(PL_comppad_name_floor);
861 PL_comppad_name_floor = AvFILLp(PL_comppad_name);
863 PL_comppad_name_fill = PL_comppad_name_floor;
864 if (PL_comppad_name_floor < 0)
865 PL_comppad_name_floor = 0;
866 SAVEI32(PL_min_intro_pending);
867 SAVEI32(PL_max_intro_pending);
868 PL_min_intro_pending = 0;
869 SAVEI32(PL_comppad_name_fill);
870 SAVEI32(PL_padix_floor);
871 PL_padix_floor = PL_padix;
872 PL_pad_reset_pending = FALSE;
879 "Introduce" my variables to visible status.
891 ASSERT_CURPAD_ACTIVE("intro_my");
892 if (! PL_min_intro_pending)
893 return PL_cop_seqmax;
895 svp = AvARRAY(PL_comppad_name);
896 for (i = PL_min_intro_pending; i <= PL_max_intro_pending; i++) {
897 if ((sv = svp[i]) && sv != &PL_sv_undef
898 && !SvFAKE(sv) && !SvIVX(sv))
900 SvIVX(sv) = PAD_MAX; /* Don't know scope end yet. */
901 SvNVX(sv) = (NV)PL_cop_seqmax;
902 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
903 "Pad intromy: %ld \"%s\", (%ld,%ld)\n",
905 (long)I_32(SvNVX(sv)), (long)SvIVX(sv))
909 PL_min_intro_pending = 0;
910 PL_comppad_name_fill = PL_max_intro_pending; /* Needn't search higher */
911 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
912 "Pad intromy: seq -> %ld\n", (long)(PL_cop_seqmax+1)));
914 return PL_cop_seqmax++;
918 =for apidoc pad_leavemy
920 Cleanup at end of scope during compilation: set the max seq number for
921 lexicals in this scope and warn of any lexicals that never got introduced.
927 Perl_pad_leavemy(pTHX)
930 SV **svp = AvARRAY(PL_comppad_name);
933 PL_pad_reset_pending = FALSE;
935 ASSERT_CURPAD_ACTIVE("pad_leavemy");
936 if (PL_min_intro_pending && PL_comppad_name_fill < PL_min_intro_pending) {
937 for (off = PL_max_intro_pending; off >= PL_min_intro_pending; off--) {
938 if ((sv = svp[off]) && sv != &PL_sv_undef
939 && !SvFAKE(sv) && ckWARN_d(WARN_INTERNAL))
940 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
941 "%"SVf" never introduced", sv);
944 /* "Deintroduce" my variables that are leaving with this scope. */
945 for (off = AvFILLp(PL_comppad_name); off > PL_comppad_name_fill; off--) {
946 if ((sv = svp[off]) && sv != &PL_sv_undef
947 && !SvFAKE(sv) && SvIVX(sv) == PAD_MAX)
949 SvIVX(sv) = PL_cop_seqmax;
950 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
951 "Pad leavemy: %ld \"%s\", (%ld,%ld)\n",
952 (long)off, SvPVX(sv),
953 (long)I_32(SvNVX(sv)), (long)SvIVX(sv))
958 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
959 "Pad leavemy: seq = %ld\n", (long)PL_cop_seqmax));
964 =for apidoc pad_swipe
966 Abandon the tmp in the current pad at offset po and replace with a
973 Perl_pad_swipe(pTHX_ PADOFFSET po, bool refadjust)
975 ASSERT_CURPAD_LEGAL("pad_swipe");
978 if (AvARRAY(PL_comppad) != PL_curpad)
979 Perl_croak(aTHX_ "panic: pad_swipe curpad");
981 Perl_croak(aTHX_ "panic: pad_swipe po");
983 DEBUG_X(PerlIO_printf(Perl_debug_log,
984 "Pad 0x%"UVxf"[0x%"UVxf"] swipe: %ld\n",
985 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po));
988 SvPADTMP_off(PL_curpad[po]);
990 SvREFCNT_dec(PL_curpad[po]);
992 PL_curpad[po] = NEWSV(1107,0);
993 SvPADTMP_on(PL_curpad[po]);
994 if ((I32)po < PL_padix)
1000 =for apidoc pad_reset
1002 Mark all the current temporaries for reuse
1007 /* XXX pad_reset() is currently disabled because it results in serious bugs.
1008 * It causes pad temp TARGs to be shared between OPs. Since TARGs are pushed
1009 * on the stack by OPs that use them, there are several ways to get an alias
1010 * to a shared TARG. Such an alias will change randomly and unpredictably.
1011 * We avoid doing this until we can think of a Better Way.
1014 Perl_pad_reset(pTHX)
1016 #ifdef USE_BROKEN_PAD_RESET
1019 if (AvARRAY(PL_comppad) != PL_curpad)
1020 Perl_croak(aTHX_ "panic: pad_reset curpad");
1022 DEBUG_X(PerlIO_printf(Perl_debug_log,
1023 "Pad 0x%"UVxf"[0x%"UVxf"] reset: padix %ld -> %ld",
1024 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
1025 (long)PL_padix, (long)PL_padix_floor
1029 if (!PL_tainting) { /* Can't mix tainted and non-tainted temporaries. */
1030 for (po = AvMAX(PL_comppad); po > PL_padix_floor; po--) {
1031 if (PL_curpad[po] && !SvIMMORTAL(PL_curpad[po]))
1032 SvPADTMP_off(PL_curpad[po]);
1034 PL_padix = PL_padix_floor;
1037 PL_pad_reset_pending = FALSE;
1042 =for apidoc pad_tidy
1044 Tidy up a pad after we've finished compiling it:
1045 * remove most stuff from the pads of anonsub prototypes;
1047 * mark tmps as such.
1052 /* XXX DAPM surely most of this stuff should be done properly
1053 * at the right time beforehand, rather than going around afterwards
1054 * cleaning up our mistakes ???
1058 Perl_pad_tidy(pTHX_ padtidy_type type)
1063 ASSERT_CURPAD_ACTIVE("pad_tidy");
1065 /* If this CV has had any 'eval-capable' ops planted in it
1066 * (ie it contains eval '...', //ee, /$var/ or /(?{..})/), Then any
1067 * anon prototypes in the chain of CVs should be marked as cloneable,
1068 * so that for example the eval's CV in C<< sub { eval '$x' } >> gets
1069 * the right CvOUTSIDE.
1070 * If running with -d, *any* sub may potentially have an eval
1071 * excuted within it.
1074 if (PL_cv_has_eval || PL_perldb) {
1075 for (cv = PL_compcv ;cv; cv = CvOUTSIDE(cv)) {
1076 if (cv != PL_compcv && CvCOMPILED(cv))
1077 break; /* no need to mark already-compiled code */
1079 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1080 "Pad clone on cv=0x%"UVxf"\n", PTR2UV(cv)));
1086 /* extend curpad to match namepad */
1087 if (AvFILLp(PL_comppad_name) < AvFILLp(PL_comppad))
1088 av_store(PL_comppad_name, AvFILLp(PL_comppad), Nullsv);
1090 if (type == padtidy_SUBCLONE) {
1091 SV **namep = AvARRAY(PL_comppad_name);
1093 for (ix = AvFILLp(PL_comppad); ix > 0; ix--) {
1096 if (SvIMMORTAL(PL_curpad[ix]) || IS_PADGV(PL_curpad[ix]) || IS_PADCONST(PL_curpad[ix]))
1099 * The only things that a clonable function needs in its
1100 * pad are anonymous subs.
1101 * The rest are created anew during cloning.
1103 if (!((namesv = namep[ix]) != Nullsv &&
1104 namesv != &PL_sv_undef &&
1105 *SvPVX(namesv) == '&'))
1107 SvREFCNT_dec(PL_curpad[ix]);
1108 PL_curpad[ix] = Nullsv;
1112 else if (type == padtidy_SUB) {
1113 /* XXX DAPM this same bit of code keeps appearing !!! Rationalise? */
1114 AV *av = newAV(); /* Will be @_ */
1116 av_store(PL_comppad, 0, (SV*)av);
1117 AvFLAGS(av) = AVf_REIFY;
1120 /* XXX DAPM rationalise these two similar branches */
1122 if (type == padtidy_SUB) {
1123 for (ix = AvFILLp(PL_comppad); ix > 0; ix--) {
1124 if (SvIMMORTAL(PL_curpad[ix]) || IS_PADGV(PL_curpad[ix]) || IS_PADCONST(PL_curpad[ix]))
1126 if (!SvPADMY(PL_curpad[ix]))
1127 SvPADTMP_on(PL_curpad[ix]);
1130 else if (type == padtidy_FORMAT) {
1131 for (ix = AvFILLp(PL_comppad); ix > 0; ix--) {
1132 if (!SvPADMY(PL_curpad[ix]) && !SvIMMORTAL(PL_curpad[ix]))
1133 SvPADTMP_on(PL_curpad[ix]);
1136 PL_curpad = AvARRAY(PL_comppad);
1141 =for apidoc pad_free
1143 Free the SV at offet po in the current pad.
1148 /* XXX DAPM integrate with pad_swipe ???? */
1150 Perl_pad_free(pTHX_ PADOFFSET po)
1152 ASSERT_CURPAD_LEGAL("pad_free");
1155 if (AvARRAY(PL_comppad) != PL_curpad)
1156 Perl_croak(aTHX_ "panic: pad_free curpad");
1158 Perl_croak(aTHX_ "panic: pad_free po");
1160 DEBUG_X(PerlIO_printf(Perl_debug_log,
1161 "Pad 0x%"UVxf"[0x%"UVxf"] free: %ld\n",
1162 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po)
1165 if (PL_curpad[po] && PL_curpad[po] != &PL_sv_undef) {
1166 SvPADTMP_off(PL_curpad[po]);
1168 /* SV could be a shared hash key (eg bugid #19022) */
1170 #ifdef PERL_COPY_ON_WRITE
1171 !SvIsCOW(PL_curpad[po])
1173 !SvFAKE(PL_curpad[po])
1176 SvREADONLY_off(PL_curpad[po]); /* could be a freed constant */
1179 if ((I32)po < PL_padix)
1186 =for apidoc do_dump_pad
1188 Dump the contents of a padlist
1194 Perl_do_dump_pad(pTHX_ I32 level, PerlIO *file, PADLIST *padlist, int full)
1206 pad_name = (AV*)*av_fetch((AV*)padlist, 0, FALSE);
1207 pad = (AV*)*av_fetch((AV*)padlist, 1, FALSE);
1208 pname = AvARRAY(pad_name);
1209 ppad = AvARRAY(pad);
1210 Perl_dump_indent(aTHX_ level, file,
1211 "PADNAME = 0x%"UVxf"(0x%"UVxf") PAD = 0x%"UVxf"(0x%"UVxf")\n",
1212 PTR2UV(pad_name), PTR2UV(pname), PTR2UV(pad), PTR2UV(ppad)
1215 for (ix = 1; ix <= AvFILLp(pad_name); ix++) {
1217 if (namesv && namesv == &PL_sv_undef) {
1222 Perl_dump_indent(aTHX_ level+1, file,
1223 "%2d. 0x%"UVxf"<%lu> FAKE \"%s\" flags=0x%x index=%lu\n",
1226 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0),
1228 (unsigned long)SvIVX(namesv),
1229 (unsigned long)SvNVX(namesv)
1233 Perl_dump_indent(aTHX_ level+1, file,
1234 "%2d. 0x%"UVxf"<%lu> (%ld,%ld) \"%s\"\n",
1237 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0),
1238 (long)I_32(SvNVX(namesv)),
1239 (long)SvIVX(namesv),
1244 Perl_dump_indent(aTHX_ level+1, file,
1245 "%2d. 0x%"UVxf"<%lu>\n",
1248 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0)
1259 dump the contents of a CV
1266 S_cv_dump(pTHX_ CV *cv, char *title)
1268 CV *outside = CvOUTSIDE(cv);
1269 AV* padlist = CvPADLIST(cv);
1271 PerlIO_printf(Perl_debug_log,
1272 " %s: CV=0x%"UVxf" (%s), OUTSIDE=0x%"UVxf" (%s)\n",
1275 (CvANON(cv) ? "ANON"
1276 : (SvTYPE(cv) == SVt_PVFM) ? "FORMAT"
1277 : (cv == PL_main_cv) ? "MAIN"
1278 : CvUNIQUE(cv) ? "UNIQUE"
1279 : CvGV(cv) ? GvNAME(CvGV(cv)) : "UNDEFINED"),
1282 : CvANON(outside) ? "ANON"
1283 : (outside == PL_main_cv) ? "MAIN"
1284 : CvUNIQUE(outside) ? "UNIQUE"
1285 : CvGV(outside) ? GvNAME(CvGV(outside)) : "UNDEFINED"));
1287 PerlIO_printf(Perl_debug_log,
1288 " PADLIST = 0x%"UVxf"\n", PTR2UV(padlist));
1289 do_dump_pad(1, Perl_debug_log, padlist, 1);
1291 #endif /* DEBUGGING */
1298 =for apidoc cv_clone
1300 Clone a CV: make a new CV which points to the same code etc, but which
1301 has a newly-created pad built by copying the prototype pad and capturing
1308 Perl_cv_clone(pTHX_ CV *proto)
1311 AV* protopadlist = CvPADLIST(proto);
1312 AV* protopad_name = (AV*)*av_fetch(protopadlist, 0, FALSE);
1313 AV* protopad = (AV*)*av_fetch(protopadlist, 1, FALSE);
1314 SV** pname = AvARRAY(protopad_name);
1315 SV** ppad = AvARRAY(protopad);
1316 I32 fname = AvFILLp(protopad_name);
1317 I32 fpad = AvFILLp(protopad);
1324 assert(!CvUNIQUE(proto));
1326 /* Since cloneable anon subs can be nested, CvOUTSIDE may point
1327 * to a prototype; we instead want the cloned parent who called us.
1328 * Note that in general for formats, CvOUTSIDE != find_runcv */
1330 outside = CvOUTSIDE(proto);
1331 if (outside && CvCLONE(outside) && ! CvCLONED(outside))
1332 outside = find_runcv(NULL);
1333 depth = CvDEPTH(outside);
1334 assert(depth || SvTYPE(proto) == SVt_PVFM);
1337 assert(CvPADLIST(outside));
1340 SAVESPTR(PL_compcv);
1342 cv = PL_compcv = (CV*)NEWSV(1104, 0);
1343 sv_upgrade((SV *)cv, SvTYPE(proto));
1344 CvFLAGS(cv) = CvFLAGS(proto) & ~(CVf_CLONE|CVf_WEAKOUTSIDE);
1348 CvFILE(cv) = CvXSUB(proto) ? CvFILE(proto)
1349 : savepv(CvFILE(proto));
1351 CvFILE(cv) = CvFILE(proto);
1353 CvGV(cv) = CvGV(proto);
1354 CvSTASH(cv) = CvSTASH(proto);
1355 CvROOT(cv) = OpREFCNT_inc(CvROOT(proto));
1356 CvSTART(cv) = CvSTART(proto);
1357 CvOUTSIDE(cv) = (CV*)SvREFCNT_inc(outside);
1358 CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1361 sv_setpvn((SV*)cv, SvPVX(proto), SvCUR(proto));
1363 CvPADLIST(cv) = comppadlist = pad_new(padnew_CLONE|padnew_SAVE);
1365 av_fill(PL_comppad, fpad);
1366 for (ix = fname; ix >= 0; ix--)
1367 av_store(PL_comppad_name, ix, SvREFCNT_inc(pname[ix]));
1369 PL_curpad = AvARRAY(PL_comppad);
1371 outpad = AvARRAY(AvARRAY(CvPADLIST(outside))[depth]);
1373 for (ix = fpad; ix > 0; ix--) {
1374 SV* namesv = (ix <= fname) ? pname[ix] : Nullsv;
1376 if (namesv && namesv != &PL_sv_undef) { /* lexical */
1377 if (SvFAKE(namesv)) { /* lexical from outside? */
1378 sv = outpad[(I32)SvNVX(namesv)];
1380 /* formats may have an inactive parent */
1381 if (SvTYPE(proto) == SVt_PVFM && SvPADSTALE(sv)) {
1382 if (ckWARN(WARN_CLOSURE))
1383 Perl_warner(aTHX_ packWARN(WARN_CLOSURE),
1384 "Variable \"%s\" is not available", SvPVX(namesv));
1388 assert(!SvPADSTALE(sv));
1389 sv = SvREFCNT_inc(sv);
1393 char *name = SvPVX(namesv);
1395 sv = SvREFCNT_inc(ppad[ix]);
1396 else if (*name == '@')
1398 else if (*name == '%')
1405 else if (IS_PADGV(ppad[ix]) || IS_PADCONST(ppad[ix])) {
1406 sv = SvREFCNT_inc(ppad[ix]);
1416 PerlIO_printf(Perl_debug_log, "\nPad CV clone\n");
1417 cv_dump(outside, "Outside");
1418 cv_dump(proto, "Proto");
1425 /* Constant sub () { $x } closing over $x - see lib/constant.pm:
1426 * The prototype was marked as a candiate for const-ization,
1427 * so try to grab the current const value, and if successful,
1428 * turn into a const sub:
1430 SV* const_sv = op_const_sv(CvSTART(cv), cv);
1433 cv = newCONSTSUB(CvSTASH(proto), 0, const_sv);
1445 =for apidoc pad_fixup_inner_anons
1447 For any anon CVs in the pad, change CvOUTSIDE of that CV from
1448 old_cv to new_cv if necessary. Needed when a newly-compiled CV has to be
1449 moved to a pre-existing CV struct.
1455 Perl_pad_fixup_inner_anons(pTHX_ PADLIST *padlist, CV *old_cv, CV *new_cv)
1458 AV *comppad_name = (AV*)AvARRAY(padlist)[0];
1459 AV *comppad = (AV*)AvARRAY(padlist)[1];
1460 SV **namepad = AvARRAY(comppad_name);
1461 SV **curpad = AvARRAY(comppad);
1462 for (ix = AvFILLp(comppad_name); ix > 0; ix--) {
1463 SV *namesv = namepad[ix];
1464 if (namesv && namesv != &PL_sv_undef
1465 && *SvPVX(namesv) == '&')
1467 CV *innercv = (CV*)curpad[ix];
1468 assert(CvWEAKOUTSIDE(innercv));
1469 assert(CvOUTSIDE(innercv) == old_cv);
1470 CvOUTSIDE(innercv) = new_cv;
1477 =for apidoc pad_push
1479 Push a new pad frame onto the padlist, unless there's already a pad at
1480 this depth, in which case don't bother creating a new one.
1481 If has_args is true, give the new pad an @_ in slot zero.
1487 Perl_pad_push(pTHX_ PADLIST *padlist, int depth, int has_args)
1489 if (depth <= AvFILLp(padlist))
1493 SV** svp = AvARRAY(padlist);
1494 AV *newpad = newAV();
1495 SV **oldpad = AvARRAY(svp[depth-1]);
1496 I32 ix = AvFILLp((AV*)svp[1]);
1497 I32 names_fill = AvFILLp((AV*)svp[0]);
1498 SV** names = AvARRAY(svp[0]);
1500 for ( ;ix > 0; ix--) {
1501 if (names_fill >= ix && names[ix] != &PL_sv_undef) {
1502 char *name = SvPVX(names[ix]);
1503 if ((SvFLAGS(names[ix]) & SVf_FAKE) || *name == '&') {
1504 /* outer lexical or anon code */
1505 av_store(newpad, ix, SvREFCNT_inc(oldpad[ix]));
1507 else { /* our own lexical */
1509 av_store(newpad, ix, sv = (SV*)newAV());
1510 else if (*name == '%')
1511 av_store(newpad, ix, sv = (SV*)newHV());
1513 av_store(newpad, ix, sv = NEWSV(0, 0));
1517 else if (IS_PADGV(oldpad[ix]) || IS_PADCONST(oldpad[ix])) {
1518 av_store(newpad, ix, sv = SvREFCNT_inc(oldpad[ix]));
1521 /* save temporaries on recursion? */
1522 av_store(newpad, ix, sv = NEWSV(0, 0));
1529 av_store(newpad, 0, (SV*)av);
1530 AvFLAGS(av) = AVf_REIFY;
1532 av_store(padlist, depth, (SV*)newpad);
1533 AvFILLp(padlist) = depth;