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 =for apidoc Amx|PADLIST *|CvPADLIST|CV *cv
32 CV's can have CvPADLIST(cv) set to point to a PADLIST. This is the CV's
33 scratchpad, which stores lexical variables and opcode temporary and
36 For these purposes "formats" are a kind-of CV; eval""s are too (except they're
37 not callable at will and are always thrown away after the eval"" is done
38 executing). Require'd files are simply evals without any outer lexical
41 XSUBs do not have a CvPADLIST. dXSTARG fetches values from PL_curpad,
42 but that is really the callers pad (a slot of which is allocated by
43 every entersub). Do not get or set CvPADLIST if a CV is an XSUB (as
44 determined by C<CvISXSUB()>), CvPADLIST slot is reused for a different
45 internal purpose in XSUBs.
47 The PADLIST has a C array where pads are stored.
49 The 0th entry of the PADLIST is a PADNAMELIST (which is actually just an
50 AV, but that may change) which represents the "names" or rather
51 the "static type information" for lexicals. The individual elements of a
52 PADNAMELIST are PADNAMEs (just SVs; but, again, that may change). Future
53 refactorings might stop the PADNAMELIST from being stored in the PADLIST's
54 array, so don't rely on it. See L</PadlistNAMES>.
56 The CvDEPTH'th entry of a PADLIST is a PAD (an AV) which is the stack frame
57 at that depth of recursion into the CV. The 0th slot of a frame AV is an
58 AV which is @_. Other entries are storage for variables and op targets.
60 Iterating over the PADNAMELIST iterates over all possible pad
61 items. Pad slots for targets (SVs_PADTMP)
62 and GVs end up having &PL_sv_undef
63 "names", while slots for constants have &PL_sv_no "names" (see
64 pad_alloc()). That &PL_sv_no is used is an implementation detail subject
65 to change. To test for it, use C<PadnamePV(name) && !PadnameLEN(name)>.
67 Only my/our variable (SvPADMY/PADNAME_isOUR) slots get valid names.
68 The rest are op targets/GVs/constants which are statically allocated
69 or resolved at compile time. These don't have names by which they
70 can be looked up from Perl code at run time through eval"" the way
71 my/our variables can be. Since they can't be looked up by "name"
72 but only by their index allocated at compile time (which is usually
73 in PL_op->op_targ), wasting a name SV for them doesn't make sense.
75 The SVs in the names AV have their PV being the name of the variable.
76 xlow+1..xhigh inclusive in the NV union is a range of cop_seq numbers for
77 which the name is valid (accessed through the macros COP_SEQ_RANGE_LOW and
78 _HIGH). During compilation, these fields may hold the special value
79 PERL_PADSEQ_INTRO to indicate various stages:
81 COP_SEQ_RANGE_LOW _HIGH
82 ----------------- -----
83 PERL_PADSEQ_INTRO 0 variable not yet introduced: { my ($x
84 valid-seq# PERL_PADSEQ_INTRO variable in scope: { my ($x)
85 valid-seq# valid-seq# compilation of scope complete: { my ($x) }
87 For typed lexicals name SV is SVt_PVMG and SvSTASH
88 points at the type. For C<our> lexicals, the type is also SVt_PVMG, with the
89 SvOURSTASH slot pointing at the stash of the associated global (so that
90 duplicate C<our> declarations in the same package can be detected). SvUVX is
91 sometimes hijacked to store the generation number during compilation.
93 If PADNAME_OUTER (SvFAKE) is set on the
94 name SV, then that slot in the frame AV is
95 a REFCNT'ed reference to a lexical from "outside". In this case,
96 the name SV does not use xlow and xhigh to store a cop_seq range, since it is
97 in scope throughout. Instead xhigh stores some flags containing info about
98 the real lexical (is it declared in an anon, and is it capable of being
99 instantiated multiple times?), and for fake ANONs, xlow contains the index
100 within the parent's pad where the lexical's value is stored, to make
103 If the 'name' is '&' the corresponding entry in the PAD
104 is a CV representing a possible closure.
105 (PADNAME_OUTER and name of '&' is not a
106 meaningful combination currently but could
107 become so if C<my sub foo {}> is implemented.)
109 Note that formats are treated as anon subs, and are cloned each time
110 write is called (if necessary).
112 The flag SVs_PADSTALE is cleared on lexicals each time the my() is executed,
113 and set on scope exit. This allows the
114 'Variable $x is not available' warning
115 to be generated in evals, such as
117 { my $x = 1; sub f { eval '$x'} } f();
119 For state vars, SVs_PADSTALE is overloaded to mean 'not yet initialised'.
121 =for apidoc AmxU|PADNAMELIST *|PL_comppad_name
123 During compilation, this points to the array containing the names part
124 of the pad for the currently-compiling code.
126 =for apidoc AmxU|PAD *|PL_comppad
128 During compilation, this points to the array containing the values
129 part of the pad for the currently-compiling code. (At runtime a CV may
130 have many such value arrays; at compile time just one is constructed.)
131 At runtime, this points to the array containing the currently-relevant
132 values for the pad for the currently-executing code.
134 =for apidoc AmxU|SV **|PL_curpad
136 Points directly to the body of the L</PL_comppad> array.
137 (I.e., this is C<PAD_ARRAY(PL_comppad)>.)
144 #define PERL_IN_PAD_C
146 #include "keywords.h"
148 #define COP_SEQ_RANGE_LOW_set(sv,val) \
149 STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xlow = (val); } STMT_END
150 #define COP_SEQ_RANGE_HIGH_set(sv,val) \
151 STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xhigh = (val); } STMT_END
153 #define PARENT_PAD_INDEX_set(sv,val) \
154 STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xlow = (val); } STMT_END
155 #define PARENT_FAKELEX_FLAGS_set(sv,val) \
156 STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xhigh = (val); } STMT_END
159 This is basically sv_eq_flags() in sv.c, but we avoid the magic
164 sv_eq_pvn_flags(pTHX_ const SV *sv, const char* pv, const STRLEN pvlen, const U32 flags) {
165 if ( (SvUTF8(sv) & SVf_UTF8 ) != (flags & SVf_UTF8) ) {
166 const char *pv1 = SvPVX_const(sv);
167 STRLEN cur1 = SvCUR(sv);
168 const char *pv2 = pv;
173 svrecode = newSVpvn(pv2, cur2);
174 sv_recode_to_utf8(svrecode, PL_encoding);
175 pv2 = SvPV_const(svrecode, cur2);
178 svrecode = newSVpvn(pv1, cur1);
179 sv_recode_to_utf8(svrecode, PL_encoding);
180 pv1 = SvPV_const(svrecode, cur1);
182 SvREFCNT_dec_NN(svrecode);
184 if (flags & SVf_UTF8)
185 return (bytes_cmp_utf8(
186 (const U8*)pv1, cur1,
187 (const U8*)pv2, cur2) == 0);
189 return (bytes_cmp_utf8(
190 (const U8*)pv2, cur2,
191 (const U8*)pv1, cur1) == 0);
194 return ((SvPVX_const(sv) == pv)
195 || memEQ(SvPVX_const(sv), pv, pvlen));
200 Perl_set_padlist(pTHX_ CV * cv, PADLIST *padlist){
201 PERL_ARGS_ASSERT_SET_PADLIST;
203 if((Size_t)padlist == UINT64_C(0xEFEFEFEFEFEFEFEF)){
207 if((Size_t)padlist == UINT64_C(0xEFEFEFEF)){
211 # error unknown pointer size
216 ((XPVCV*)MUTABLE_PTR(SvANY(cv)))->xcv_padlist_u.xcv_padlist = padlist;
221 =for apidoc Am|PADLIST *|pad_new|int flags
223 Create a new padlist, updating the global variables for the
224 currently-compiling padlist to point to the new padlist. The following
225 flags can be OR'ed together:
227 padnew_CLONE this pad is for a cloned CV
228 padnew_SAVE save old globals on the save stack
229 padnew_SAVESUB also save extra stuff for start of sub
235 Perl_pad_new(pTHX_ int flags)
241 ASSERT_CURPAD_LEGAL("pad_new");
243 /* XXX DAPM really need a new SAVEt_PAD which restores all or most
244 * vars (based on flags) rather than storing vals + addresses for
245 * each individually. Also see pad_block_start.
246 * XXX DAPM Try to see whether all these conditionals are required
249 /* save existing state, ... */
251 if (flags & padnew_SAVE) {
253 if (! (flags & padnew_CLONE)) {
254 SAVESPTR(PL_comppad_name);
256 SAVEI32(PL_constpadix);
257 SAVEI32(PL_comppad_name_fill);
258 SAVEI32(PL_min_intro_pending);
259 SAVEI32(PL_max_intro_pending);
260 SAVEBOOL(PL_cv_has_eval);
261 if (flags & padnew_SAVESUB) {
262 SAVEBOOL(PL_pad_reset_pending);
266 /* XXX DAPM interestingly, PL_comppad_name_floor never seems to be
267 * saved - check at some pt that this is okay */
269 /* ... create new pad ... */
271 Newxz(padlist, 1, PADLIST);
274 if (flags & padnew_CLONE) {
275 /* XXX DAPM I dont know why cv_clone needs it
276 * doing differently yet - perhaps this separate branch can be
277 * dispensed with eventually ???
280 AV * const a0 = newAV(); /* will be @_ */
281 av_store(pad, 0, MUTABLE_SV(a0));
284 padname = (PAD *)SvREFCNT_inc_simple_NN(PL_comppad_name);
287 av_store(pad, 0, NULL);
289 AvPAD_NAMELIST_on(padname);
290 av_store(padname, 0, &PL_sv_undef);
293 /* Most subroutines never recurse, hence only need 2 entries in the padlist
294 array - names, and depth=1. The default for av_store() is to allocate
295 0..3, and even an explicit call to av_extend() with <3 will be rounded
296 up, so we inline the allocation of the array here. */
298 PadlistMAX(padlist) = 1;
299 PadlistARRAY(padlist) = ary;
303 /* ... then update state variables */
306 PL_curpad = AvARRAY(pad);
308 if (! (flags & padnew_CLONE)) {
309 PL_comppad_name = padname;
310 PL_comppad_name_fill = 0;
311 PL_min_intro_pending = 0;
317 DEBUG_X(PerlIO_printf(Perl_debug_log,
318 "Pad 0x%"UVxf"[0x%"UVxf"] new: compcv=0x%"UVxf
319 " name=0x%"UVxf" flags=0x%"UVxf"\n",
320 PTR2UV(PL_comppad), PTR2UV(PL_curpad), PTR2UV(PL_compcv),
321 PTR2UV(padname), (UV)flags
325 return (PADLIST*)padlist;
330 =head1 Embedding Functions
334 Clear out all the active components of a CV. This can happen either
335 by an explicit C<undef &foo>, or by the reference count going to zero.
336 In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
337 children can still follow the full lexical scope chain.
343 Perl_cv_undef(pTHX_ CV *cv)
345 PERL_ARGS_ASSERT_CV_UNDEF;
346 cv_undef_flags(cv, 0);
350 Perl_cv_undef_flags(pTHX_ CV *cv, U32 flags)
352 CV cvbody;/*CV body will never be realloced inside this func,
353 so dont read it more than once, use fake CV so existing macros
354 will work, the indirection and CV head struct optimized away*/
355 SvANY(&cvbody) = SvANY(cv);
357 PERL_ARGS_ASSERT_CV_UNDEF_FLAGS;
359 DEBUG_X(PerlIO_printf(Perl_debug_log,
360 "CV undef: cv=0x%"UVxf" comppad=0x%"UVxf"\n",
361 PTR2UV(cv), PTR2UV(PL_comppad))
364 if (CvFILE(&cvbody)) {
365 char * file = CvFILE(&cvbody);
366 CvFILE(&cvbody) = NULL;
367 if(CvDYNFILE(&cvbody))
371 /* CvSLABBED_off(&cvbody); *//* turned off below */
372 /* release the sub's body */
373 if (!CvISXSUB(&cvbody)) {
374 if(CvROOT(&cvbody)) {
375 assert(SvTYPE(cv) == SVt_PVCV || SvTYPE(cv) == SVt_PVFM); /*unsafe is safe */
376 if (CvDEPTHunsafe(&cvbody)) {
377 assert(SvTYPE(cv) == SVt_PVCV);
378 Perl_croak_nocontext("Can't undef active subroutine");
382 PAD_SAVE_SETNULLPAD();
384 if (CvSLABBED(&cvbody)) OpslabREFCNT_dec_padok(OpSLAB(CvROOT(&cvbody)));
385 op_free(CvROOT(&cvbody));
386 CvROOT(&cvbody) = NULL;
387 CvSTART(&cvbody) = NULL;
390 else if (CvSLABBED(&cvbody)) {
391 if( CvSTART(&cvbody)) {
393 PAD_SAVE_SETNULLPAD();
395 /* discard any leaked ops */
397 parser_free_nexttoke_ops(PL_parser, (OPSLAB *)CvSTART(&cvbody));
398 opslab_force_free((OPSLAB *)CvSTART(&cvbody));
399 CvSTART(&cvbody) = NULL;
404 else Perl_warn(aTHX_ "Slab leaked from cv %p", (void*)cv);
408 else { /* dont bother checking if CvXSUB(cv) is true, less branching */
409 CvXSUB(&cvbody) = NULL;
411 SvPOK_off(MUTABLE_SV(cv)); /* forget prototype */
412 sv_unmagic((SV *)cv, PERL_MAGIC_checkcall);
413 if (!(flags & CV_UNDEF_KEEP_NAME)) {
414 if (CvNAMED(&cvbody)) {
415 CvNAME_HEK_set(&cvbody, NULL);
416 CvNAMED_off(&cvbody);
418 else CvGV_set(cv, NULL);
421 /* This statement and the subsequence if block was pad_undef(). */
422 pad_peg("pad_undef");
424 if (!CvISXSUB(&cvbody) && CvPADLIST(&cvbody)) {
426 const PADLIST *padlist = CvPADLIST(&cvbody);
428 /* Free the padlist associated with a CV.
429 If parts of it happen to be current, we null the relevant PL_*pad*
430 global vars so that we don't have any dangling references left.
431 We also repoint the CvOUTSIDE of any about-to-be-orphaned inner
432 subs to the outer of this cv. */
434 DEBUG_X(PerlIO_printf(Perl_debug_log,
435 "Pad undef: cv=0x%"UVxf" padlist=0x%"UVxf" comppad=0x%"UVxf"\n",
436 PTR2UV(cv), PTR2UV(padlist), PTR2UV(PL_comppad))
439 /* detach any '&' anon children in the pad; if afterwards they
440 * are still live, fix up their CvOUTSIDEs to point to our outside,
442 /* XXX DAPM for efficiency, we should only do this if we know we have
443 * children, or integrate this loop with general cleanup */
445 if (PL_phase != PERL_PHASE_DESTRUCT) { /* don't bother during global destruction */
446 CV * const outercv = CvOUTSIDE(&cvbody);
447 const U32 seq = CvOUTSIDE_SEQ(&cvbody);
448 PAD * const comppad_name = PadlistARRAY(padlist)[0];
449 SV ** const namepad = AvARRAY(comppad_name);
450 PAD * const comppad = PadlistARRAY(padlist)[1];
451 SV ** const curpad = AvARRAY(comppad);
452 for (ix = AvFILLp(comppad_name); ix > 0; ix--) {
453 SV * const namesv = namepad[ix];
454 if (namesv && namesv != &PL_sv_undef
455 && *SvPVX_const(namesv) == '&')
457 CV * const innercv = MUTABLE_CV(curpad[ix]);
458 U32 inner_rc = SvREFCNT(innercv);
460 assert(SvTYPE(innercv) != SVt_PVFM);
462 if (SvREFCNT(comppad) < 2) { /* allow for /(?{ sub{} })/ */
464 SvREFCNT_dec_NN(innercv);
468 /* in use, not just a prototype */
469 if (inner_rc && (CvOUTSIDE(innercv) == cv)) {
470 assert(CvWEAKOUTSIDE(innercv));
471 /* don't relink to grandfather if he's being freed */
472 if (outercv && SvREFCNT(outercv)) {
473 CvWEAKOUTSIDE_off(innercv);
474 CvOUTSIDE(innercv) = outercv;
475 CvOUTSIDE_SEQ(innercv) = seq;
476 SvREFCNT_inc_simple_void_NN(outercv);
479 CvOUTSIDE(innercv) = NULL;
486 ix = PadlistMAX(padlist);
488 PAD * const sv = PadlistARRAY(padlist)[ix--];
490 if (sv == PL_comppad) {
498 PAD * const sv = PadlistARRAY(padlist)[0];
499 if (sv == PL_comppad_name && SvREFCNT(sv) == 1)
500 PL_comppad_name = NULL;
503 if (PadlistARRAY(padlist)) Safefree(PadlistARRAY(padlist));
505 CvPADLIST_set(&cvbody, NULL);
507 else if (CvISXSUB(&cvbody))
508 CvHSCXT(&cvbody) = NULL;
509 /* else is (!CvISXSUB(&cvbody) && !CvPADLIST(&cvbody)) {do nothing;} */
512 /* remove CvOUTSIDE unless this is an undef rather than a free */
514 CV * outside = CvOUTSIDE(&cvbody);
516 CvOUTSIDE(&cvbody) = NULL;
517 if (!CvWEAKOUTSIDE(&cvbody))
518 SvREFCNT_dec_NN(outside);
521 if (CvCONST(&cvbody)) {
522 SvREFCNT_dec(MUTABLE_SV(CvXSUBANY(&cvbody).any_ptr));
523 /* CvCONST_off(cv); *//* turned off below */
525 /* delete all flags except WEAKOUTSIDE and CVGV_RC, which indicate the
526 * ref status of CvOUTSIDE and CvGV, and ANON, NAMED and
527 * LEXICAL, which are used to determine the sub's name. */
528 CvFLAGS(&cvbody) &= (CVf_WEAKOUTSIDE|CVf_CVGV_RC|CVf_ANON|CVf_LEXICAL
533 =for apidoc cv_forget_slab
535 When a CV has a reference count on its slab (CvSLABBED), it is responsible
536 for making sure it is freed. (Hence, no two CVs should ever have a
537 reference count on the same slab.) The CV only needs to reference the slab
538 during compilation. Once it is compiled and CvROOT attached, it has
539 finished its job, so it can forget the slab.
545 Perl_cv_forget_slab(pTHX_ CV *cv)
547 const bool slabbed = !!CvSLABBED(cv);
550 PERL_ARGS_ASSERT_CV_FORGET_SLAB;
552 if (!slabbed) return;
556 if (CvROOT(cv)) slab = OpSLAB(CvROOT(cv));
557 else if (CvSTART(cv)) slab = (OPSLAB *)CvSTART(cv);
559 else if (slabbed) Perl_warn(aTHX_ "Slab leaked from cv %p", (void*)cv);
563 #ifdef PERL_DEBUG_READONLY_OPS
564 const size_t refcnt = slab->opslab_refcnt;
566 OpslabREFCNT_dec(slab);
567 #ifdef PERL_DEBUG_READONLY_OPS
568 if (refcnt > 1) Slab_to_ro(slab);
574 =for apidoc m|PADOFFSET|pad_alloc_name|SV *namesv|U32 flags|HV *typestash|HV *ourstash
576 Allocates a place in the currently-compiling
577 pad (via L<perlapi/pad_alloc>) and
578 then stores a name for that entry. I<namesv> is adopted and becomes the
579 name entry; it must already contain the name string and be sufficiently
580 upgraded. I<typestash> and I<ourstash> and the C<padadd_STATE> flag get
581 added to I<namesv>. None of the other
582 processing of L<perlapi/pad_add_name_pvn>
583 is done. Returns the offset of the allocated pad slot.
589 S_pad_alloc_name(pTHX_ SV *namesv, U32 flags, HV *typestash, HV *ourstash)
591 const PADOFFSET offset = pad_alloc(OP_PADSV, SVs_PADMY);
593 PERL_ARGS_ASSERT_PAD_ALLOC_NAME;
595 ASSERT_CURPAD_ACTIVE("pad_alloc_name");
598 assert(SvTYPE(namesv) == SVt_PVMG);
599 SvPAD_TYPED_on(namesv);
600 SvSTASH_set(namesv, MUTABLE_HV(SvREFCNT_inc_simple_NN(MUTABLE_SV(typestash))));
603 SvPAD_OUR_on(namesv);
604 SvOURSTASH_set(namesv, ourstash);
605 SvREFCNT_inc_simple_void_NN(ourstash);
607 else if (flags & padadd_STATE) {
608 SvPAD_STATE_on(namesv);
611 av_store(PL_comppad_name, offset, namesv);
612 PadnamelistMAXNAMED(PL_comppad_name) = offset;
617 =for apidoc Am|PADOFFSET|pad_add_name_pvn|const char *namepv|STRLEN namelen|U32 flags|HV *typestash|HV *ourstash
619 Allocates a place in the currently-compiling pad for a named lexical
620 variable. Stores the name and other metadata in the name part of the
621 pad, and makes preparations to manage the variable's lexical scoping.
622 Returns the offset of the allocated pad slot.
624 I<namepv>/I<namelen> specify the variable's name, including leading sigil.
625 If I<typestash> is non-null, the name is for a typed lexical, and this
626 identifies the type. If I<ourstash> is non-null, it's a lexical reference
627 to a package variable, and this identifies the package. The following
628 flags can be OR'ed together:
630 padadd_OUR redundantly specifies if it's a package var
631 padadd_STATE variable will retain value persistently
632 padadd_NO_DUP_CHECK skip check for lexical shadowing
638 Perl_pad_add_name_pvn(pTHX_ const char *namepv, STRLEN namelen,
639 U32 flags, HV *typestash, HV *ourstash)
645 PERL_ARGS_ASSERT_PAD_ADD_NAME_PVN;
647 if (flags & ~(padadd_OUR|padadd_STATE|padadd_NO_DUP_CHECK|padadd_UTF8_NAME))
648 Perl_croak(aTHX_ "panic: pad_add_name_pvn illegal flag bits 0x%" UVxf,
651 namesv = newSV_type((ourstash || typestash) ? SVt_PVMG : SVt_PVNV);
653 if ((is_utf8 = ((flags & padadd_UTF8_NAME) != 0))) {
654 namepv = (const char*)bytes_from_utf8((U8*)namepv, &namelen, &is_utf8);
657 sv_setpvn(namesv, namepv, namelen);
660 flags |= padadd_UTF8_NAME;
664 flags &= ~padadd_UTF8_NAME;
666 if ((flags & padadd_NO_DUP_CHECK) == 0) {
668 SAVEFREESV(namesv); /* in case of fatal warnings */
669 /* check for duplicate declaration */
670 pad_check_dup(namesv, flags & padadd_OUR, ourstash);
671 SvREFCNT_inc_simple_void_NN(namesv);
675 offset = pad_alloc_name(namesv, flags & ~padadd_UTF8_NAME, typestash, ourstash);
677 /* not yet introduced */
678 COP_SEQ_RANGE_LOW_set(namesv, PERL_PADSEQ_INTRO);
679 COP_SEQ_RANGE_HIGH_set(namesv, 0);
681 if (!PL_min_intro_pending)
682 PL_min_intro_pending = offset;
683 PL_max_intro_pending = offset;
684 /* if it's not a simple scalar, replace with an AV or HV */
685 assert(SvTYPE(PL_curpad[offset]) == SVt_NULL);
686 assert(SvREFCNT(PL_curpad[offset]) == 1);
687 if (namelen != 0 && *namepv == '@')
688 sv_upgrade(PL_curpad[offset], SVt_PVAV);
689 else if (namelen != 0 && *namepv == '%')
690 sv_upgrade(PL_curpad[offset], SVt_PVHV);
691 else if (namelen != 0 && *namepv == '&')
692 sv_upgrade(PL_curpad[offset], SVt_PVCV);
693 assert(SvPADMY(PL_curpad[offset]));
694 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
695 "Pad addname: %ld \"%s\" new lex=0x%"UVxf"\n",
696 (long)offset, SvPVX(namesv),
697 PTR2UV(PL_curpad[offset])));
703 =for apidoc Am|PADOFFSET|pad_add_name_pv|const char *name|U32 flags|HV *typestash|HV *ourstash
705 Exactly like L</pad_add_name_pvn>, but takes a nul-terminated string
706 instead of a string/length pair.
712 Perl_pad_add_name_pv(pTHX_ const char *name,
713 const U32 flags, HV *typestash, HV *ourstash)
715 PERL_ARGS_ASSERT_PAD_ADD_NAME_PV;
716 return pad_add_name_pvn(name, strlen(name), flags, typestash, ourstash);
720 =for apidoc Am|PADOFFSET|pad_add_name_sv|SV *name|U32 flags|HV *typestash|HV *ourstash
722 Exactly like L</pad_add_name_pvn>, but takes the name string in the form
723 of an SV instead of a string/length pair.
729 Perl_pad_add_name_sv(pTHX_ SV *name, U32 flags, HV *typestash, HV *ourstash)
733 PERL_ARGS_ASSERT_PAD_ADD_NAME_SV;
734 namepv = SvPV(name, namelen);
736 flags |= padadd_UTF8_NAME;
737 return pad_add_name_pvn(namepv, namelen, flags, typestash, ourstash);
741 =for apidoc Amx|PADOFFSET|pad_alloc|I32 optype|U32 tmptype
743 Allocates a place in the currently-compiling pad,
744 returning the offset of the allocated pad slot.
745 No name is initially attached to the pad slot.
746 I<tmptype> is a set of flags indicating the kind of pad entry required,
747 which will be set in the value SV for the allocated pad entry:
749 SVs_PADMY named lexical variable ("my", "our", "state")
750 SVs_PADTMP unnamed temporary store
751 SVf_READONLY constant shared between recursion levels
753 C<SVf_READONLY> has been supported here only since perl 5.20. To work with
754 earlier versions as well, use C<SVf_READONLY|SVs_PADTMP>. C<SVf_READONLY>
755 does not cause the SV in the pad slot to be marked read-only, but simply
756 tells C<pad_alloc> that it I<will> be made read-only (by the caller), or at
757 least should be treated as such.
759 I<optype> should be an opcode indicating the type of operation that the
760 pad entry is to support. This doesn't affect operational semantics,
761 but is used for debugging.
766 /* XXX DAPM integrate alloc(), add_name() and add_anon(),
767 * or at least rationalise ??? */
770 Perl_pad_alloc(pTHX_ I32 optype, U32 tmptype)
775 PERL_UNUSED_ARG(optype);
776 ASSERT_CURPAD_ACTIVE("pad_alloc");
778 if (AvARRAY(PL_comppad) != PL_curpad)
779 Perl_croak(aTHX_ "panic: pad_alloc, %p!=%p",
780 AvARRAY(PL_comppad), PL_curpad);
781 if (PL_pad_reset_pending)
783 if (tmptype == SVs_PADMY) { /* Not & because this ‘flag’ is 0. */
784 /* For a my, simply push a null SV onto the end of PL_comppad. */
785 sv = *av_fetch(PL_comppad, AvFILLp(PL_comppad) + 1, TRUE);
786 retval = AvFILLp(PL_comppad);
789 /* For a tmp, scan the pad from PL_padix upwards
790 * for a slot which has no name and no active value.
791 * For a constant, likewise, but use PL_constpadix.
793 SV * const * const names = AvARRAY(PL_comppad_name);
794 const SSize_t names_fill = AvFILLp(PL_comppad_name);
795 const bool konst = cBOOL(tmptype & SVf_READONLY);
796 retval = konst ? PL_constpadix : PL_padix;
799 * Entries that close over unavailable variables
800 * in outer subs contain values not marked PADMY.
801 * Thus we must skip, not just pad values that are
802 * marked as current pad values, but also those with names.
803 * If pad_reset is enabled, ‘current’ means different
804 * things depending on whether we are allocating a con-
805 * stant or a target. For a target, things marked PADTMP
806 * can be reused; not so for constants.
808 if (++retval <= names_fill &&
809 (sv = names[retval]) && sv != &PL_sv_undef)
811 sv = *av_fetch(PL_comppad, retval, TRUE);
814 (konst ? SVs_PADTMP : 0))
822 av_store(PL_comppad_name, retval, &PL_sv_no);
823 tmptype &= ~SVf_READONLY;
824 tmptype |= SVs_PADTMP;
826 *(konst ? &PL_constpadix : &PL_padix) = retval;
828 SvFLAGS(sv) |= tmptype;
829 PL_curpad = AvARRAY(PL_comppad);
831 DEBUG_X(PerlIO_printf(Perl_debug_log,
832 "Pad 0x%"UVxf"[0x%"UVxf"] alloc: %ld for %s\n",
833 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long) retval,
834 PL_op_name[optype]));
835 #ifdef DEBUG_LEAKING_SCALARS
836 sv->sv_debug_optype = optype;
837 sv->sv_debug_inpad = 1;
839 return (PADOFFSET)retval;
843 =for apidoc Am|PADOFFSET|pad_add_anon|CV *func|I32 optype
845 Allocates a place in the currently-compiling pad (via L</pad_alloc>)
846 for an anonymous function that is lexically scoped inside the
847 currently-compiling function.
848 The function I<func> is linked into the pad, and its C<CvOUTSIDE> link
849 to the outer scope is weakened to avoid a reference loop.
851 One reference count is stolen, so you may need to do C<SvREFCNT_inc(func)>.
853 I<optype> should be an opcode indicating the type of operation that the
854 pad entry is to support. This doesn't affect operational semantics,
855 but is used for debugging.
861 Perl_pad_add_anon(pTHX_ CV* func, I32 optype)
864 SV* const name = newSV_type(SVt_PVNV);
866 PERL_ARGS_ASSERT_PAD_ADD_ANON;
869 sv_setpvs(name, "&");
870 /* These two aren't used; just make sure they're not equal to
871 * PERL_PADSEQ_INTRO */
872 COP_SEQ_RANGE_LOW_set(name, 0);
873 COP_SEQ_RANGE_HIGH_set(name, 0);
874 ix = pad_alloc(optype, SVs_PADMY);
875 av_store(PL_comppad_name, ix, name);
876 /* XXX DAPM use PL_curpad[] ? */
877 if (SvTYPE(func) == SVt_PVCV || !CvOUTSIDE(func))
878 av_store(PL_comppad, ix, (SV*)func);
880 SV *rv = newRV_noinc((SV *)func);
882 assert (SvTYPE(func) == SVt_PVFM);
883 av_store(PL_comppad, ix, rv);
886 /* to avoid ref loops, we never have parent + child referencing each
887 * other simultaneously */
888 if (CvOUTSIDE(func) && SvTYPE(func) == SVt_PVCV) {
889 assert(!CvWEAKOUTSIDE(func));
890 CvWEAKOUTSIDE_on(func);
891 SvREFCNT_dec_NN(CvOUTSIDE(func));
897 =for apidoc pad_check_dup
899 Check for duplicate declarations: report any of:
901 * a my in the current scope with the same name;
902 * an our (anywhere in the pad) with the same name and the
903 same stash as C<ourstash>
905 C<is_our> indicates that the name to check is an 'our' declaration.
911 S_pad_check_dup(pTHX_ SV *name, U32 flags, const HV *ourstash)
915 const U32 is_our = flags & padadd_OUR;
917 PERL_ARGS_ASSERT_PAD_CHECK_DUP;
919 ASSERT_CURPAD_ACTIVE("pad_check_dup");
921 assert((flags & ~padadd_OUR) == 0);
923 if (AvFILLp(PL_comppad_name) < 0 || !ckWARN(WARN_MISC))
924 return; /* nothing to check */
926 svp = AvARRAY(PL_comppad_name);
927 top = AvFILLp(PL_comppad_name);
928 /* check the current scope */
929 /* XXX DAPM - why the (I32) cast - shouldn't we ensure they're the same
931 for (off = top; (I32)off > PL_comppad_name_floor; off--) {
932 SV * const sv = svp[off];
936 && ( COP_SEQ_RANGE_LOW(sv) == PERL_PADSEQ_INTRO
937 || COP_SEQ_RANGE_HIGH(sv) == PERL_PADSEQ_INTRO)
940 if (is_our && (SvPAD_OUR(sv)))
941 break; /* "our" masking "our" */
942 /* diag_listed_as: "%s" variable %s masks earlier declaration in same %s */
943 Perl_warner(aTHX_ packWARN(WARN_MISC),
944 "\"%s\" %s %"SVf" masks earlier declaration in same %s",
945 (is_our ? "our" : PL_parser->in_my == KEY_my ? "my" : "state"),
946 *SvPVX(sv) == '&' ? "subroutine" : "variable",
948 (COP_SEQ_RANGE_HIGH(sv) == PERL_PADSEQ_INTRO
949 ? "scope" : "statement"));
954 /* check the rest of the pad */
957 SV * const sv = svp[off];
961 && ( COP_SEQ_RANGE_LOW(sv) == PERL_PADSEQ_INTRO
962 || COP_SEQ_RANGE_HIGH(sv) == PERL_PADSEQ_INTRO)
963 && SvOURSTASH(sv) == ourstash
966 Perl_warner(aTHX_ packWARN(WARN_MISC),
967 "\"our\" variable %"SVf" redeclared", SVfARG(sv));
968 if ((I32)off <= PL_comppad_name_floor)
969 Perl_warner(aTHX_ packWARN(WARN_MISC),
970 "\t(Did you mean \"local\" instead of \"our\"?)\n");
980 =for apidoc Am|PADOFFSET|pad_findmy_pvn|const char *namepv|STRLEN namelen|U32 flags
982 Given the name of a lexical variable, find its position in the
983 currently-compiling pad.
984 I<namepv>/I<namelen> specify the variable's name, including leading sigil.
985 I<flags> is reserved and must be zero.
986 If it is not in the current pad but appears in the pad of any lexically
987 enclosing scope, then a pseudo-entry for it is added in the current pad.
988 Returns the offset in the current pad,
989 or C<NOT_IN_PAD> if no such lexical is in scope.
995 Perl_pad_findmy_pvn(pTHX_ const char *namepv, STRLEN namelen, U32 flags)
1003 PERL_ARGS_ASSERT_PAD_FINDMY_PVN;
1005 pad_peg("pad_findmy_pvn");
1007 if (flags & ~padadd_UTF8_NAME)
1008 Perl_croak(aTHX_ "panic: pad_findmy_pvn illegal flag bits 0x%" UVxf,
1011 if (flags & padadd_UTF8_NAME) {
1012 bool is_utf8 = TRUE;
1013 namepv = (const char*)bytes_from_utf8((U8*)namepv, &namelen, &is_utf8);
1016 flags |= padadd_UTF8_NAME;
1018 flags &= ~padadd_UTF8_NAME;
1021 offset = pad_findlex(namepv, namelen, flags,
1022 PL_compcv, PL_cop_seqmax, 1, NULL, &out_sv, &out_flags);
1023 if ((PADOFFSET)offset != NOT_IN_PAD)
1026 /* Skip the ‘our’ hack for subroutines, as the warning does not apply.
1028 if (*namepv == '&') return NOT_IN_PAD;
1030 /* look for an our that's being introduced; this allows
1031 * our $foo = 0 unless defined $foo;
1032 * to not give a warning. (Yes, this is a hack) */
1034 nameav = PadlistARRAY(CvPADLIST(PL_compcv))[0];
1035 name_svp = AvARRAY(nameav);
1036 for (offset = PadnamelistMAXNAMED(nameav); offset > 0; offset--) {
1037 const SV * const namesv = name_svp[offset];
1038 if (namesv && PadnameLEN(namesv) == namelen
1040 && (SvPAD_OUR(namesv))
1041 && sv_eq_pvn_flags(aTHX_ namesv, namepv, namelen,
1042 flags & padadd_UTF8_NAME ? SVf_UTF8 : 0 )
1043 && COP_SEQ_RANGE_LOW(namesv) == PERL_PADSEQ_INTRO
1051 =for apidoc Am|PADOFFSET|pad_findmy_pv|const char *name|U32 flags
1053 Exactly like L</pad_findmy_pvn>, but takes a nul-terminated string
1054 instead of a string/length pair.
1060 Perl_pad_findmy_pv(pTHX_ const char *name, U32 flags)
1062 PERL_ARGS_ASSERT_PAD_FINDMY_PV;
1063 return pad_findmy_pvn(name, strlen(name), flags);
1067 =for apidoc Am|PADOFFSET|pad_findmy_sv|SV *name|U32 flags
1069 Exactly like L</pad_findmy_pvn>, but takes the name string in the form
1070 of an SV instead of a string/length pair.
1076 Perl_pad_findmy_sv(pTHX_ SV *name, U32 flags)
1080 PERL_ARGS_ASSERT_PAD_FINDMY_SV;
1081 namepv = SvPV(name, namelen);
1083 flags |= padadd_UTF8_NAME;
1084 return pad_findmy_pvn(namepv, namelen, flags);
1088 =for apidoc Amp|PADOFFSET|find_rundefsvoffset
1090 Find the position of the lexical C<$_> in the pad of the
1091 currently-executing function. Returns the offset in the current pad,
1092 or C<NOT_IN_PAD> if there is no lexical C<$_> in scope (in which case
1093 the global one should be used instead).
1094 L</find_rundefsv> is likely to be more convenient.
1100 Perl_find_rundefsvoffset(pTHX)
1104 return pad_findlex("$_", 2, 0, find_runcv(NULL), PL_curcop->cop_seq, 1,
1105 NULL, &out_sv, &out_flags);
1109 =for apidoc Am|SV *|find_rundefsv
1111 Find and return the variable that is named C<$_> in the lexical scope
1112 of the currently-executing function. This may be a lexical C<$_>,
1113 or will otherwise be the global one.
1119 Perl_find_rundefsv(pTHX)
1125 po = pad_findlex("$_", 2, 0, find_runcv(NULL), PL_curcop->cop_seq, 1,
1126 NULL, &namesv, &flags);
1128 if (po == NOT_IN_PAD || SvPAD_OUR(namesv))
1135 Perl_find_rundefsv2(pTHX_ CV *cv, U32 seq)
1141 PERL_ARGS_ASSERT_FIND_RUNDEFSV2;
1143 po = pad_findlex("$_", 2, 0, cv, seq, 1,
1144 NULL, &namesv, &flags);
1146 if (po == NOT_IN_PAD || SvPAD_OUR(namesv))
1149 return AvARRAY(PadlistARRAY(CvPADLIST(cv))[CvDEPTH(cv)])[po];
1153 =for apidoc m|PADOFFSET|pad_findlex|const char *namepv|STRLEN namelen|U32 flags|const CV* cv|U32 seq|int warn|SV** out_capture|SV** out_name_sv|int *out_flags
1155 Find a named lexical anywhere in a chain of nested pads. Add fake entries
1156 in the inner pads if it's found in an outer one.
1158 Returns the offset in the bottom pad of the lex or the fake lex.
1159 cv is the CV in which to start the search, and seq is the current cop_seq
1160 to match against. If warn is true, print appropriate warnings. The out_*
1161 vars return values, and so are pointers to where the returned values
1162 should be stored. out_capture, if non-null, requests that the innermost
1163 instance of the lexical is captured; out_name_sv is set to the innermost
1164 matched namesv or fake namesv; out_flags returns the flags normally
1165 associated with the IVX field of a fake namesv.
1167 Note that pad_findlex() is recursive; it recurses up the chain of CVs,
1168 then comes back down, adding fake entries
1169 as it goes. It has to be this way
1170 because fake namesvs in anon protoypes have to store in xlow the index into
1176 /* the CV has finished being compiled. This is not a sufficient test for
1177 * all CVs (eg XSUBs), but suffices for the CVs found in a lexical chain */
1178 #define CvCOMPILED(cv) CvROOT(cv)
1180 /* the CV does late binding of its lexicals */
1181 #define CvLATE(cv) (CvANON(cv) || CvCLONE(cv) || SvTYPE(cv) == SVt_PVFM)
1184 S_unavailable(pTHX_ SV *namesv)
1186 /* diag_listed_as: Variable "%s" is not available */
1187 Perl_ck_warner(aTHX_ packWARN(WARN_CLOSURE),
1188 "%se \"%"SVf"\" is not available",
1189 *SvPVX_const(namesv) == '&'
1196 S_pad_findlex(pTHX_ const char *namepv, STRLEN namelen, U32 flags, const CV* cv, U32 seq,
1197 int warn, SV** out_capture, SV** out_name_sv, int *out_flags)
1199 I32 offset, new_offset;
1202 const PADLIST * const padlist = CvPADLIST(cv);
1203 const bool staleok = !!(flags & padadd_STALEOK);
1205 PERL_ARGS_ASSERT_PAD_FINDLEX;
1207 if (flags & ~(padadd_UTF8_NAME|padadd_STALEOK))
1208 Perl_croak(aTHX_ "panic: pad_findlex illegal flag bits 0x%" UVxf,
1210 flags &= ~ padadd_STALEOK; /* one-shot flag */
1214 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1215 "Pad findlex cv=0x%"UVxf" searching \"%.*s\" seq=%d%s\n",
1216 PTR2UV(cv), (int)namelen, namepv, (int)seq,
1217 out_capture ? " capturing" : "" ));
1219 /* first, search this pad */
1221 if (padlist) { /* not an undef CV */
1222 I32 fake_offset = 0;
1223 const AV * const nameav = PadlistARRAY(padlist)[0];
1224 SV * const * const name_svp = AvARRAY(nameav);
1226 for (offset = PadnamelistMAXNAMED(nameav); offset > 0; offset--) {
1227 const SV * const namesv = name_svp[offset];
1228 if (namesv && PadnameLEN(namesv) == namelen
1229 && sv_eq_pvn_flags(aTHX_ namesv, namepv, namelen,
1230 flags & padadd_UTF8_NAME ? SVf_UTF8 : 0))
1232 if (SvFAKE(namesv)) {
1233 fake_offset = offset; /* in case we don't find a real one */
1236 /* is seq within the range _LOW to _HIGH ?
1237 * This is complicated by the fact that PL_cop_seqmax
1238 * may have wrapped around at some point */
1239 if (COP_SEQ_RANGE_LOW(namesv) == PERL_PADSEQ_INTRO)
1240 continue; /* not yet introduced */
1242 if (COP_SEQ_RANGE_HIGH(namesv) == PERL_PADSEQ_INTRO) {
1243 /* in compiling scope */
1245 (seq > COP_SEQ_RANGE_LOW(namesv))
1246 ? (seq - COP_SEQ_RANGE_LOW(namesv) < (U32_MAX >> 1))
1247 : (COP_SEQ_RANGE_LOW(namesv) - seq > (U32_MAX >> 1))
1252 (COP_SEQ_RANGE_LOW(namesv) > COP_SEQ_RANGE_HIGH(namesv))
1254 ( seq > COP_SEQ_RANGE_LOW(namesv)
1255 || seq <= COP_SEQ_RANGE_HIGH(namesv))
1257 : ( seq > COP_SEQ_RANGE_LOW(namesv)
1258 && seq <= COP_SEQ_RANGE_HIGH(namesv))
1264 if (offset > 0 || fake_offset > 0 ) { /* a match! */
1265 if (offset > 0) { /* not fake */
1267 *out_name_sv = name_svp[offset]; /* return the namesv */
1269 /* set PAD_FAKELEX_MULTI if this lex can have multiple
1270 * instances. For now, we just test !CvUNIQUE(cv), but
1271 * ideally, we should detect my's declared within loops
1272 * etc - this would allow a wider range of 'not stayed
1273 * shared' warnings. We also treated already-compiled
1274 * lexes as not multi as viewed from evals. */
1276 *out_flags = CvANON(cv) ?
1278 (!CvUNIQUE(cv) && ! CvCOMPILED(cv))
1279 ? PAD_FAKELEX_MULTI : 0;
1281 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1282 "Pad findlex cv=0x%"UVxf" matched: offset=%ld (%lu,%lu)\n",
1283 PTR2UV(cv), (long)offset,
1284 (unsigned long)COP_SEQ_RANGE_LOW(*out_name_sv),
1285 (unsigned long)COP_SEQ_RANGE_HIGH(*out_name_sv)));
1287 else { /* fake match */
1288 offset = fake_offset;
1289 *out_name_sv = name_svp[offset]; /* return the namesv */
1290 *out_flags = PARENT_FAKELEX_FLAGS(*out_name_sv);
1291 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1292 "Pad findlex cv=0x%"UVxf" matched: offset=%ld flags=0x%lx index=%lu\n",
1293 PTR2UV(cv), (long)offset, (unsigned long)*out_flags,
1294 (unsigned long) PARENT_PAD_INDEX(*out_name_sv)
1298 /* return the lex? */
1303 if (SvPAD_OUR(*out_name_sv)) {
1304 *out_capture = NULL;
1308 /* trying to capture from an anon prototype? */
1310 ? CvANON(cv) && CvCLONE(cv) && !CvCLONED(cv)
1311 : *out_flags & PAD_FAKELEX_ANON)
1315 newSVpvn_flags(namepv, namelen,
1317 (flags & padadd_UTF8_NAME ? SVf_UTF8 : 0)));
1319 *out_capture = NULL;
1325 if (!CvCOMPILED(cv) && (*out_flags & PAD_FAKELEX_MULTI)
1326 && !SvPAD_STATE(name_svp[offset])
1327 && warn && ckWARN(WARN_CLOSURE)) {
1329 Perl_warner(aTHX_ packWARN(WARN_CLOSURE),
1330 "Variable \"%"SVf"\" will not stay shared",
1331 SVfARG(newSVpvn_flags(namepv, namelen,
1333 (flags & padadd_UTF8_NAME ? SVf_UTF8 : 0))));
1336 if (fake_offset && CvANON(cv)
1337 && CvCLONE(cv) &&!CvCLONED(cv))
1340 /* not yet caught - look further up */
1341 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1342 "Pad findlex cv=0x%"UVxf" chasing lex in outer pad\n",
1345 (void) pad_findlex(namepv, namelen, flags, CvOUTSIDE(cv),
1347 newwarn, out_capture, out_name_sv, out_flags);
1352 *out_capture = AvARRAY(PadlistARRAY(padlist)[
1353 CvDEPTH(cv) ? CvDEPTH(cv) : 1])[offset];
1354 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1355 "Pad findlex cv=0x%"UVxf" found lex=0x%"UVxf"\n",
1356 PTR2UV(cv), PTR2UV(*out_capture)));
1358 if (SvPADSTALE(*out_capture)
1359 && (!CvDEPTH(cv) || !staleok)
1360 && !SvPAD_STATE(name_svp[offset]))
1363 newSVpvn_flags(namepv, namelen,
1365 (flags & padadd_UTF8_NAME ? SVf_UTF8 : 0)));
1366 *out_capture = NULL;
1369 if (!*out_capture) {
1370 if (namelen != 0 && *namepv == '@')
1371 *out_capture = sv_2mortal(MUTABLE_SV(newAV()));
1372 else if (namelen != 0 && *namepv == '%')
1373 *out_capture = sv_2mortal(MUTABLE_SV(newHV()));
1374 else if (namelen != 0 && *namepv == '&')
1375 *out_capture = sv_2mortal(newSV_type(SVt_PVCV));
1377 *out_capture = sv_newmortal();
1385 /* it's not in this pad - try above */
1390 /* out_capture non-null means caller wants us to capture lex; in
1391 * addition we capture ourselves unless it's an ANON/format */
1392 new_capturep = out_capture ? out_capture :
1393 CvLATE(cv) ? NULL : &new_capture;
1395 offset = pad_findlex(namepv, namelen,
1396 flags | padadd_STALEOK*(new_capturep == &new_capture),
1397 CvOUTSIDE(cv), CvOUTSIDE_SEQ(cv), 1,
1398 new_capturep, out_name_sv, out_flags);
1399 if ((PADOFFSET)offset == NOT_IN_PAD)
1402 /* found in an outer CV. Add appropriate fake entry to this pad */
1404 /* don't add new fake entries (via eval) to CVs that we have already
1405 * finished compiling, or to undef CVs */
1406 if (CvCOMPILED(cv) || !padlist)
1407 return 0; /* this dummy (and invalid) value isnt used by the caller */
1410 /* This relies on sv_setsv_flags() upgrading the destination to the same
1411 type as the source, independent of the flags set, and on it being
1412 "good" and only copying flag bits and pointers that it understands.
1414 SV *new_namesv = newSVsv(*out_name_sv);
1415 AV * const ocomppad_name = PL_comppad_name;
1416 PAD * const ocomppad = PL_comppad;
1417 PL_comppad_name = PadlistARRAY(padlist)[0];
1418 PL_comppad = PadlistARRAY(padlist)[1];
1419 PL_curpad = AvARRAY(PL_comppad);
1422 = pad_alloc_name(new_namesv,
1423 (SvPAD_STATE(*out_name_sv) ? padadd_STATE : 0),
1424 SvPAD_TYPED(*out_name_sv)
1425 ? SvSTASH(*out_name_sv) : NULL,
1426 SvOURSTASH(*out_name_sv)
1429 SvFAKE_on(new_namesv);
1430 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1431 "Pad addname: %ld \"%.*s\" FAKE\n",
1433 (int) SvCUR(new_namesv), SvPVX(new_namesv)));
1434 PARENT_FAKELEX_FLAGS_set(new_namesv, *out_flags);
1436 PARENT_PAD_INDEX_set(new_namesv, 0);
1437 if (SvPAD_OUR(new_namesv)) {
1438 NOOP; /* do nothing */
1440 else if (CvLATE(cv)) {
1441 /* delayed creation - just note the offset within parent pad */
1442 PARENT_PAD_INDEX_set(new_namesv, offset);
1446 /* immediate creation - capture outer value right now */
1447 av_store(PL_comppad, new_offset, SvREFCNT_inc(*new_capturep));
1448 /* But also note the offset, as newMYSUB needs it */
1449 PARENT_PAD_INDEX_set(new_namesv, offset);
1450 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1451 "Pad findlex cv=0x%"UVxf" saved captured sv 0x%"UVxf" at offset %ld\n",
1452 PTR2UV(cv), PTR2UV(*new_capturep), (long)new_offset));
1454 *out_name_sv = new_namesv;
1455 *out_flags = PARENT_FAKELEX_FLAGS(new_namesv);
1457 PL_comppad_name = ocomppad_name;
1458 PL_comppad = ocomppad;
1459 PL_curpad = ocomppad ? AvARRAY(ocomppad) : NULL;
1467 =for apidoc Am|SV *|pad_sv|PADOFFSET po
1469 Get the value at offset I<po> in the current (compiling or executing) pad.
1470 Use macro PAD_SV instead of calling this function directly.
1476 Perl_pad_sv(pTHX_ PADOFFSET po)
1478 ASSERT_CURPAD_ACTIVE("pad_sv");
1481 Perl_croak(aTHX_ "panic: pad_sv po");
1482 DEBUG_X(PerlIO_printf(Perl_debug_log,
1483 "Pad 0x%"UVxf"[0x%"UVxf"] sv: %ld sv=0x%"UVxf"\n",
1484 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po, PTR2UV(PL_curpad[po]))
1486 return PL_curpad[po];
1490 =for apidoc Am|void|pad_setsv|PADOFFSET po|SV *sv
1492 Set the value at offset I<po> in the current (compiling or executing) pad.
1493 Use the macro PAD_SETSV() rather than calling this function directly.
1499 Perl_pad_setsv(pTHX_ PADOFFSET po, SV* sv)
1501 PERL_ARGS_ASSERT_PAD_SETSV;
1503 ASSERT_CURPAD_ACTIVE("pad_setsv");
1505 DEBUG_X(PerlIO_printf(Perl_debug_log,
1506 "Pad 0x%"UVxf"[0x%"UVxf"] setsv: %ld sv=0x%"UVxf"\n",
1507 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po, PTR2UV(sv))
1512 #endif /* DEBUGGING */
1515 =for apidoc m|void|pad_block_start|int full
1517 Update the pad compilation state variables on entry to a new block.
1522 /* XXX DAPM perhaps:
1523 * - integrate this in general state-saving routine ???
1524 * - combine with the state-saving going on in pad_new ???
1525 * - introduce a new SAVE type that does all this in one go ?
1529 Perl_pad_block_start(pTHX_ int full)
1531 ASSERT_CURPAD_ACTIVE("pad_block_start");
1532 SAVEI32(PL_comppad_name_floor);
1533 PL_comppad_name_floor = AvFILLp(PL_comppad_name);
1535 PL_comppad_name_fill = PL_comppad_name_floor;
1536 if (PL_comppad_name_floor < 0)
1537 PL_comppad_name_floor = 0;
1538 SAVEI32(PL_min_intro_pending);
1539 SAVEI32(PL_max_intro_pending);
1540 PL_min_intro_pending = 0;
1541 SAVEI32(PL_comppad_name_fill);
1542 SAVEI32(PL_padix_floor);
1543 /* PL_padix_floor is what PL_padix is reset to at the start of each
1544 statement, by pad_reset(). We set it when entering a new scope
1545 to keep things like this working:
1546 print "$foo$bar", do { this(); that() . "foo" };
1547 We must not let "$foo$bar" and the later concatenation share the
1549 PL_padix_floor = PL_padix;
1550 PL_pad_reset_pending = FALSE;
1554 =for apidoc Am|U32|intro_my
1556 "Introduce" C<my> variables to visible status. This is called during parsing
1557 at the end of each statement to make lexical variables visible to subsequent
1570 ASSERT_CURPAD_ACTIVE("intro_my");
1571 if (PL_compiling.cop_seq) {
1572 seq = PL_compiling.cop_seq;
1573 PL_compiling.cop_seq = 0;
1576 seq = PL_cop_seqmax;
1577 if (! PL_min_intro_pending)
1580 svp = AvARRAY(PL_comppad_name);
1581 for (i = PL_min_intro_pending; i <= PL_max_intro_pending; i++) {
1582 SV * const sv = svp[i];
1584 if (sv && PadnameLEN(sv) && !SvFAKE(sv)
1585 && COP_SEQ_RANGE_LOW(sv) == PERL_PADSEQ_INTRO)
1587 COP_SEQ_RANGE_HIGH_set(sv, PERL_PADSEQ_INTRO); /* Don't know scope end yet. */
1588 COP_SEQ_RANGE_LOW_set(sv, PL_cop_seqmax);
1589 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1590 "Pad intromy: %ld \"%s\", (%lu,%lu)\n",
1591 (long)i, SvPVX_const(sv),
1592 (unsigned long)COP_SEQ_RANGE_LOW(sv),
1593 (unsigned long)COP_SEQ_RANGE_HIGH(sv))
1598 if (PL_cop_seqmax == PERL_PADSEQ_INTRO) /* not a legal value */
1600 PL_min_intro_pending = 0;
1601 PL_comppad_name_fill = PL_max_intro_pending; /* Needn't search higher */
1602 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1603 "Pad intromy: seq -> %ld\n", (long)(PL_cop_seqmax)));
1609 =for apidoc m|void|pad_leavemy
1611 Cleanup at end of scope during compilation: set the max seq number for
1612 lexicals in this scope and warn of any lexicals that never got introduced.
1618 Perl_pad_leavemy(pTHX)
1622 SV * const * const svp = AvARRAY(PL_comppad_name);
1624 PL_pad_reset_pending = FALSE;
1626 ASSERT_CURPAD_ACTIVE("pad_leavemy");
1627 if (PL_min_intro_pending && PL_comppad_name_fill < PL_min_intro_pending) {
1628 for (off = PL_max_intro_pending; off >= PL_min_intro_pending; off--) {
1629 const SV * const sv = svp[off];
1630 if (sv && PadnameLEN(sv) && !SvFAKE(sv))
1631 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1632 "%"SVf" never introduced",
1636 /* "Deintroduce" my variables that are leaving with this scope. */
1637 for (off = AvFILLp(PL_comppad_name); off > PL_comppad_name_fill; off--) {
1638 SV * const sv = svp[off];
1639 if (sv && PadnameLEN(sv) && !SvFAKE(sv)
1640 && COP_SEQ_RANGE_HIGH(sv) == PERL_PADSEQ_INTRO)
1642 COP_SEQ_RANGE_HIGH_set(sv, PL_cop_seqmax);
1643 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1644 "Pad leavemy: %ld \"%s\", (%lu,%lu)\n",
1645 (long)off, SvPVX_const(sv),
1646 (unsigned long)COP_SEQ_RANGE_LOW(sv),
1647 (unsigned long)COP_SEQ_RANGE_HIGH(sv))
1649 if (!PadnameIsSTATE(sv) && !PadnameIsOUR(sv)
1650 && *PadnamePV(sv) == '&' && PadnameLEN(sv) > 1) {
1651 OP *kid = newOP(OP_INTROCV, 0);
1653 o = op_prepend_elem(OP_LINESEQ, kid, o);
1658 if (PL_cop_seqmax == PERL_PADSEQ_INTRO) /* not a legal value */
1660 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1661 "Pad leavemy: seq = %ld\n", (long)PL_cop_seqmax));
1666 =for apidoc m|void|pad_swipe|PADOFFSET po|bool refadjust
1668 Abandon the tmp in the current pad at offset po and replace with a
1675 Perl_pad_swipe(pTHX_ PADOFFSET po, bool refadjust)
1677 ASSERT_CURPAD_LEGAL("pad_swipe");
1680 if (AvARRAY(PL_comppad) != PL_curpad)
1681 Perl_croak(aTHX_ "panic: pad_swipe curpad, %p!=%p",
1682 AvARRAY(PL_comppad), PL_curpad);
1683 if (!po || ((SSize_t)po) > AvFILLp(PL_comppad))
1684 Perl_croak(aTHX_ "panic: pad_swipe po=%ld, fill=%ld",
1685 (long)po, (long)AvFILLp(PL_comppad));
1687 DEBUG_X(PerlIO_printf(Perl_debug_log,
1688 "Pad 0x%"UVxf"[0x%"UVxf"] swipe: %ld\n",
1689 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po));
1692 SvREFCNT_dec(PL_curpad[po]);
1695 /* if pad tmps aren't shared between ops, then there's no need to
1696 * create a new tmp when an existing op is freed */
1697 #ifdef USE_PAD_RESET
1698 PL_curpad[po] = newSV(0);
1699 SvPADTMP_on(PL_curpad[po]);
1701 PL_curpad[po] = NULL;
1703 if (PadnamelistMAX(PL_comppad_name) != -1
1704 && (PADOFFSET)PadnamelistMAX(PL_comppad_name) >= po) {
1705 if (PadnamelistARRAY(PL_comppad_name)[po]) {
1706 assert(!PadnameLEN(PadnamelistARRAY(PL_comppad_name)[po]));
1708 PadnamelistARRAY(PL_comppad_name)[po] = &PL_sv_undef;
1710 /* Use PL_constpadix here, not PL_padix. The latter may have been
1711 reset by pad_reset. We don’t want pad_alloc to have to scan the
1712 whole pad when allocating a constant. */
1713 if ((I32)po < PL_constpadix)
1714 PL_constpadix = po - 1;
1718 =for apidoc m|void|pad_reset
1720 Mark all the current temporaries for reuse
1725 /* pad_reset() causes pad temp TARGs (operator targets) to be shared
1726 * between OPs from different statements. During compilation, at the start
1727 * of each statement pad_reset resets PL_padix back to its previous value.
1728 * When allocating a target, pad_alloc begins its scan through the pad at
1733 #ifdef USE_PAD_RESET
1734 if (AvARRAY(PL_comppad) != PL_curpad)
1735 Perl_croak(aTHX_ "panic: pad_reset curpad, %p!=%p",
1736 AvARRAY(PL_comppad), PL_curpad);
1738 DEBUG_X(PerlIO_printf(Perl_debug_log,
1739 "Pad 0x%"UVxf"[0x%"UVxf"] reset: padix %ld -> %ld",
1740 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
1741 (long)PL_padix, (long)PL_padix_floor
1745 if (!TAINTING_get) { /* Can't mix tainted and non-tainted temporaries. */
1746 PL_padix = PL_padix_floor;
1749 PL_pad_reset_pending = FALSE;
1753 =for apidoc Amx|void|pad_tidy|padtidy_type type
1755 Tidy up a pad at the end of compilation of the code to which it belongs.
1756 Jobs performed here are: remove most stuff from the pads of anonsub
1757 prototypes; give it a @_; mark temporaries as such. I<type> indicates
1758 the kind of subroutine:
1760 padtidy_SUB ordinary subroutine
1761 padtidy_SUBCLONE prototype for lexical closure
1762 padtidy_FORMAT format
1767 /* XXX DAPM surely most of this stuff should be done properly
1768 * at the right time beforehand, rather than going around afterwards
1769 * cleaning up our mistakes ???
1773 Perl_pad_tidy(pTHX_ padtidy_type type)
1777 ASSERT_CURPAD_ACTIVE("pad_tidy");
1779 /* If this CV has had any 'eval-capable' ops planted in it:
1780 * i.e. it contains any of:
1784 * * use re 'eval'; /$var/
1787 * Then any anon prototypes in the chain of CVs should be marked as
1788 * cloneable, so that for example the eval's CV in
1792 * gets the right CvOUTSIDE. If running with -d, *any* sub may
1793 * potentially have an eval executed within it.
1796 if (PL_cv_has_eval || PL_perldb) {
1798 for (cv = PL_compcv ;cv; cv = CvOUTSIDE(cv)) {
1799 if (cv != PL_compcv && CvCOMPILED(cv))
1800 break; /* no need to mark already-compiled code */
1802 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1803 "Pad clone on cv=0x%"UVxf"\n", PTR2UV(cv)));
1810 /* extend namepad to match curpad */
1811 if (AvFILLp(PL_comppad_name) < AvFILLp(PL_comppad))
1812 av_store(PL_comppad_name, AvFILLp(PL_comppad), NULL);
1814 if (type == padtidy_SUBCLONE) {
1815 SV ** const namep = AvARRAY(PL_comppad_name);
1818 for (ix = AvFILLp(PL_comppad); ix > 0; ix--) {
1820 if (!namep[ix]) namep[ix] = &PL_sv_undef;
1823 * The only things that a clonable function needs in its
1824 * pad are anonymous subs, constants and GVs.
1825 * The rest are created anew during cloning.
1827 if (!PL_curpad[ix] || SvIMMORTAL(PL_curpad[ix]))
1830 if (!(PadnamePV(namesv) &&
1831 (!PadnameLEN(namesv) || *SvPVX_const(namesv) == '&')))
1833 SvREFCNT_dec(PL_curpad[ix]);
1834 PL_curpad[ix] = NULL;
1838 else if (type == padtidy_SUB) {
1839 /* XXX DAPM this same bit of code keeps appearing !!! Rationalise? */
1840 AV * const av = newAV(); /* Will be @_ */
1841 av_store(PL_comppad, 0, MUTABLE_SV(av));
1845 if (type == padtidy_SUB || type == padtidy_FORMAT) {
1846 SV ** const namep = AvARRAY(PL_comppad_name);
1848 for (ix = AvFILLp(PL_comppad); ix > 0; ix--) {
1849 if (!namep[ix]) namep[ix] = &PL_sv_undef;
1850 if (!PL_curpad[ix] || SvIMMORTAL(PL_curpad[ix]))
1852 if (SvPADMY(PL_curpad[ix]) && !SvFAKE(namep[ix])) {
1853 /* This is a work around for how the current implementation of
1854 ?{ } blocks in regexps interacts with lexicals.
1856 One of our lexicals.
1857 Can't do this on all lexicals, otherwise sub baz() won't
1866 because completion of compiling &bar calling pad_tidy()
1867 would cause (top level) $foo to be marked as stale, and
1868 "no longer available". */
1869 SvPADSTALE_on(PL_curpad[ix]);
1873 PL_curpad = AvARRAY(PL_comppad);
1877 =for apidoc m|void|pad_free|PADOFFSET po
1879 Free the SV at offset po in the current pad.
1884 /* XXX DAPM integrate with pad_swipe ???? */
1886 Perl_pad_free(pTHX_ PADOFFSET po)
1888 #ifndef USE_PAD_RESET
1891 ASSERT_CURPAD_LEGAL("pad_free");
1894 if (AvARRAY(PL_comppad) != PL_curpad)
1895 Perl_croak(aTHX_ "panic: pad_free curpad, %p!=%p",
1896 AvARRAY(PL_comppad), PL_curpad);
1898 Perl_croak(aTHX_ "panic: pad_free po");
1900 DEBUG_X(PerlIO_printf(Perl_debug_log,
1901 "Pad 0x%"UVxf"[0x%"UVxf"] free: %ld\n",
1902 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (long)po)
1905 #ifndef USE_PAD_RESET
1907 if (sv && sv != &PL_sv_undef && !SvPADMY(sv))
1908 SvFLAGS(sv) &= ~SVs_PADTMP;
1910 if ((I32)po < PL_padix)
1916 =for apidoc m|void|do_dump_pad|I32 level|PerlIO *file|PADLIST *padlist|int full
1918 Dump the contents of a padlist
1924 Perl_do_dump_pad(pTHX_ I32 level, PerlIO *file, PADLIST *padlist, int full)
1932 PERL_ARGS_ASSERT_DO_DUMP_PAD;
1937 pad_name = *PadlistARRAY(padlist);
1938 pad = PadlistARRAY(padlist)[1];
1939 pname = AvARRAY(pad_name);
1940 ppad = AvARRAY(pad);
1941 Perl_dump_indent(aTHX_ level, file,
1942 "PADNAME = 0x%"UVxf"(0x%"UVxf") PAD = 0x%"UVxf"(0x%"UVxf")\n",
1943 PTR2UV(pad_name), PTR2UV(pname), PTR2UV(pad), PTR2UV(ppad)
1946 for (ix = 1; ix <= AvFILLp(pad_name); ix++) {
1947 const SV *namesv = pname[ix];
1948 if (namesv && !PadnameLEN(namesv)) {
1953 Perl_dump_indent(aTHX_ level+1, file,
1954 "%2d. 0x%"UVxf"<%lu> FAKE \"%s\" flags=0x%lx index=%lu\n",
1957 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0),
1958 SvPVX_const(namesv),
1959 (unsigned long)PARENT_FAKELEX_FLAGS(namesv),
1960 (unsigned long)PARENT_PAD_INDEX(namesv)
1964 Perl_dump_indent(aTHX_ level+1, file,
1965 "%2d. 0x%"UVxf"<%lu> (%lu,%lu) \"%s\"\n",
1968 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0),
1969 (unsigned long)COP_SEQ_RANGE_LOW(namesv),
1970 (unsigned long)COP_SEQ_RANGE_HIGH(namesv),
1975 Perl_dump_indent(aTHX_ level+1, file,
1976 "%2d. 0x%"UVxf"<%lu>\n",
1979 (unsigned long) (ppad[ix] ? SvREFCNT(ppad[ix]) : 0)
1988 =for apidoc m|void|cv_dump|CV *cv|const char *title
1990 dump the contents of a CV
1996 S_cv_dump(pTHX_ const CV *cv, const char *title)
1998 const CV * const outside = CvOUTSIDE(cv);
1999 PADLIST* const padlist = CvPADLIST(cv);
2001 PERL_ARGS_ASSERT_CV_DUMP;
2003 PerlIO_printf(Perl_debug_log,
2004 " %s: CV=0x%"UVxf" (%s), OUTSIDE=0x%"UVxf" (%s)\n",
2007 (CvANON(cv) ? "ANON"
2008 : (SvTYPE(cv) == SVt_PVFM) ? "FORMAT"
2009 : (cv == PL_main_cv) ? "MAIN"
2010 : CvUNIQUE(cv) ? "UNIQUE"
2011 : CvGV(cv) ? GvNAME(CvGV(cv)) : "UNDEFINED"),
2014 : CvANON(outside) ? "ANON"
2015 : (outside == PL_main_cv) ? "MAIN"
2016 : CvUNIQUE(outside) ? "UNIQUE"
2017 : CvGV(outside) ? GvNAME(CvGV(outside)) : "UNDEFINED"));
2019 PerlIO_printf(Perl_debug_log,
2020 " PADLIST = 0x%"UVxf"\n", PTR2UV(padlist));
2021 do_dump_pad(1, Perl_debug_log, padlist, 1);
2024 #endif /* DEBUGGING */
2027 =for apidoc Am|CV *|cv_clone|CV *proto
2029 Clone a CV, making a lexical closure. I<proto> supplies the prototype
2030 of the function: its code, pad structure, and other attributes.
2031 The prototype is combined with a capture of outer lexicals to which the
2032 code refers, which are taken from the currently-executing instance of
2033 the immediately surrounding code.
2038 static CV *S_cv_clone(pTHX_ CV *proto, CV *cv, CV *outside);
2041 S_cv_clone_pad(pTHX_ CV *proto, CV *cv, CV *outside, bool newcv)
2044 PADLIST* const protopadlist = CvPADLIST(proto);
2045 PAD *const protopad_name = *PadlistARRAY(protopadlist);
2046 const PAD *const protopad = PadlistARRAY(protopadlist)[1];
2047 SV** const pname = AvARRAY(protopad_name);
2048 SV** const ppad = AvARRAY(protopad);
2049 const I32 fname = AvFILLp(protopad_name);
2050 const I32 fpad = AvFILLp(protopad);
2053 bool subclones = FALSE;
2055 assert(!CvUNIQUE(proto));
2057 /* Anonymous subs have a weak CvOUTSIDE pointer, so its value is not
2058 * reliable. The currently-running sub is always the one we need to
2060 * For my subs, the currently-running sub may not be the one we want.
2061 * We have to check whether it is a clone of CvOUTSIDE.
2062 * Note that in general for formats, CvOUTSIDE != find_runcv.
2063 * Since formats may be nested inside closures, CvOUTSIDE may point
2064 * to a prototype; we instead want the cloned parent who called us.
2068 if (CvWEAKOUTSIDE(proto))
2069 outside = find_runcv(NULL);
2071 outside = CvOUTSIDE(proto);
2072 if ((CvCLONE(outside) && ! CvCLONED(outside))
2073 || !CvPADLIST(outside)
2074 || PadlistNAMES(CvPADLIST(outside))
2075 != protopadlist->xpadl_outid) {
2076 outside = find_runcv_where(
2077 FIND_RUNCV_padid_eq, PTR2IV(protopadlist->xpadl_outid), NULL
2079 /* outside could be null */
2083 depth = outside ? CvDEPTH(outside) : 0;
2088 SAVESPTR(PL_compcv);
2090 if (newcv) SAVEFREESV(cv); /* in case of fatal warnings */
2093 CvOUTSIDE(cv) = MUTABLE_CV(SvREFCNT_inc_simple(outside));
2095 SAVESPTR(PL_comppad_name);
2096 PL_comppad_name = protopad_name;
2097 CvPADLIST_set(cv, pad_new(padnew_CLONE|padnew_SAVE));
2099 av_fill(PL_comppad, fpad);
2101 PL_curpad = AvARRAY(PL_comppad);
2103 outpad = outside && CvPADLIST(outside)
2104 ? AvARRAY(PadlistARRAY(CvPADLIST(outside))[depth])
2107 CvPADLIST(cv)->xpadl_outid = PadlistNAMES(CvPADLIST(outside));
2109 for (ix = fpad; ix > 0; ix--) {
2110 SV* const namesv = (ix <= fname) ? pname[ix] : NULL;
2112 if (namesv && PadnameLEN(namesv)) { /* lexical */
2113 if (PadnameIsOUR(namesv)) { /* or maybe not so lexical */
2117 if (SvFAKE(namesv)) { /* lexical from outside? */
2118 /* formats may have an inactive, or even undefined, parent;
2119 but state vars are always available. */
2120 if (!outpad || !(sv = outpad[PARENT_PAD_INDEX(namesv)])
2121 || ( SvPADSTALE(sv) && !SvPAD_STATE(namesv)
2122 && (!outside || !CvDEPTH(outside))) ) {
2123 S_unavailable(aTHX_ namesv);
2127 SvREFCNT_inc_simple_void_NN(sv);
2130 const char sigil = SvPVX_const(namesv)[0];
2132 /* If there are state subs, we need to clone them, too.
2133 But they may need to close over variables we have
2134 not cloned yet. So we will have to do a second
2135 pass. Furthermore, there may be state subs clos-
2136 ing over other state subs’ entries, so we have
2137 to put a stub here and then clone into it on the
2139 if (SvPAD_STATE(namesv) && !CvCLONED(ppad[ix])) {
2140 assert(SvTYPE(ppad[ix]) == SVt_PVCV);
2142 sv = newSV_type(SVt_PVCV);
2145 else if (PadnameLEN(namesv)>1 && !PadnameIsOUR(namesv))
2148 /* Just provide a stub, but name it. It will be
2149 upgrade to the real thing on scope entry. */
2152 PERL_HASH(hash, SvPVX_const(namesv)+1,
2154 sv = newSV_type(SVt_PVCV);
2157 share_hek(SvPVX_const(namesv)+1,
2159 * (SvUTF8(namesv) ? -1 : 1),
2164 else sv = SvREFCNT_inc(ppad[ix]);
2165 else if (sigil == '@')
2166 sv = MUTABLE_SV(newAV());
2167 else if (sigil == '%')
2168 sv = MUTABLE_SV(newHV());
2171 /* reset the 'assign only once' flag on each state var */
2172 if (sigil != '&' && SvPAD_STATE(namesv))
2177 else if (namesv && PadnamePV(namesv)) {
2178 sv = SvREFCNT_inc_NN(ppad[ix]);
2188 for (ix = fpad; ix > 0; ix--) {
2189 SV* const namesv = (ix <= fname) ? pname[ix] : NULL;
2190 if (namesv && namesv != &PL_sv_undef && !SvFAKE(namesv)
2191 && SvPVX_const(namesv)[0] == '&' && SvPAD_STATE(namesv))
2192 S_cv_clone(aTHX_ (CV *)ppad[ix], (CV *)PL_curpad[ix], cv);
2195 if (newcv) SvREFCNT_inc_simple_void_NN(cv);
2199 /* Constant sub () { $x } closing over $x:
2200 * The prototype was marked as a candiate for const-ization,
2201 * so try to grab the current const value, and if successful,
2202 * turn into a const sub:
2204 SV* const const_sv = op_const_sv(CvSTART(cv), cv, outside, TRUE);
2207 const bool was_method = cBOOL(CvMETHOD(cv));
2208 SvREFCNT_dec_NN(cv);
2209 /* For this calling case, op_const_sv returns a *copy*, which
2210 we donate to newCONSTSUB. Yes, this is ugly, and should be
2211 killed. We need to fix how we decide whether this optimisa-
2212 tion is possible to eliminate this. */
2213 cv = newCONSTSUB(CvSTASH(proto), NULL, const_sv);
2226 S_cv_clone(pTHX_ CV *proto, CV *cv, CV *outside)
2231 const bool newcv = !cv;
2233 assert(!CvUNIQUE(proto));
2235 if (!cv) cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
2236 CvFLAGS(cv) = CvFLAGS(proto) & ~(CVf_CLONE|CVf_WEAKOUTSIDE|CVf_CVGV_RC
2240 CvFILE(cv) = CvDYNFILE(proto) ? savepv(CvFILE(proto))
2243 CvNAME_HEK_set(cv, share_hek_hek(CvNAME_HEK(proto)));
2244 else CvGV_set(cv,CvGV(proto));
2245 CvSTASH_set(cv, CvSTASH(proto));
2247 CvROOT(cv) = OpREFCNT_inc(CvROOT(proto));
2249 CvSTART(cv) = CvSTART(proto);
2250 CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
2253 sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
2255 SvUTF8_on(MUTABLE_SV(cv));
2258 mg_copy((SV *)proto, (SV *)cv, 0, 0);
2260 if (CvPADLIST(proto))
2261 cv = S_cv_clone_pad(aTHX_ proto, cv, outside, newcv);
2264 PerlIO_printf(Perl_debug_log, "\nPad CV clone\n");
2265 if (CvOUTSIDE(cv)) cv_dump(CvOUTSIDE(cv), "Outside");
2266 cv_dump(proto, "Proto");
2274 Perl_cv_clone(pTHX_ CV *proto)
2276 PERL_ARGS_ASSERT_CV_CLONE;
2278 if (!CvPADLIST(proto)) Perl_croak(aTHX_ "panic: no pad in cv_clone");
2279 return S_cv_clone(aTHX_ proto, NULL, NULL);
2282 /* Called only by pp_clonecv */
2284 Perl_cv_clone_into(pTHX_ CV *proto, CV *target)
2286 PERL_ARGS_ASSERT_CV_CLONE_INTO;
2288 return S_cv_clone(aTHX_ proto, target, NULL);
2294 Returns an SV containing the name of the CV, mainly for use in error
2295 reporting. The CV may actually be a GV instead, in which case the returned
2296 SV holds the GV's name. Anything other than a GV or CV is treated as a
2297 string already holding the sub name, but this could change in the future.
2299 An SV may be passed as a second argument. If so, the name will be assigned
2300 to it and it will be returned. Otherwise the returned SV will be a new
2303 If the I<flags> include CV_NAME_NOTQUAL, then the package name will not be
2304 included. If the first argument is neither a CV nor a GV, this flag is
2305 ignored (subject to change).
2311 Perl_cv_name(pTHX_ CV *cv, SV *sv, U32 flags)
2313 PERL_ARGS_ASSERT_CV_NAME;
2314 if (!isGV_with_GP(cv) && SvTYPE(cv) != SVt_PVCV) {
2315 if (sv) sv_setsv(sv,(SV *)cv);
2316 return sv ? (sv) : (SV *)cv;
2319 SV * const retsv = sv ? (sv) : sv_newmortal();
2320 if (SvTYPE(cv) == SVt_PVCV) {
2322 if (CvLEXICAL(cv) || flags & CV_NAME_NOTQUAL)
2323 sv_sethek(retsv, CvNAME_HEK(cv));
2325 sv_sethek(retsv, HvNAME_HEK(CvSTASH(cv)));
2326 sv_catpvs(retsv, "::");
2327 sv_cathek(retsv, CvNAME_HEK(cv));
2330 else if (CvLEXICAL(cv) || flags & CV_NAME_NOTQUAL)
2331 sv_sethek(retsv, GvNAME_HEK(GvEGV(CvGV(cv))));
2332 else gv_efullname3(retsv, CvGV(cv), NULL);
2334 else if (flags & CV_NAME_NOTQUAL) sv_sethek(retsv, GvNAME_HEK(cv));
2335 else gv_efullname3(retsv,(GV *)cv,NULL);
2341 =for apidoc m|void|pad_fixup_inner_anons|PADLIST *padlist|CV *old_cv|CV *new_cv
2343 For any anon CVs in the pad, change CvOUTSIDE of that CV from
2344 old_cv to new_cv if necessary. Needed when a newly-compiled CV has to be
2345 moved to a pre-existing CV struct.
2351 Perl_pad_fixup_inner_anons(pTHX_ PADLIST *padlist, CV *old_cv, CV *new_cv)
2354 AV * const comppad_name = PadlistARRAY(padlist)[0];
2355 AV * const comppad = PadlistARRAY(padlist)[1];
2356 SV ** const namepad = AvARRAY(comppad_name);
2357 SV ** const curpad = AvARRAY(comppad);
2359 PERL_ARGS_ASSERT_PAD_FIXUP_INNER_ANONS;
2360 PERL_UNUSED_ARG(old_cv);
2362 for (ix = AvFILLp(comppad_name); ix > 0; ix--) {
2363 const SV * const namesv = namepad[ix];
2364 if (namesv && namesv != &PL_sv_undef && !SvPAD_STATE(namesv)
2365 && *SvPVX_const(namesv) == '&')
2367 if (SvTYPE(curpad[ix]) == SVt_PVCV) {
2369 SvMAGICAL(curpad[ix])
2370 ? mg_find(curpad[ix], PERL_MAGIC_proto)
2372 CV * const innercv = MUTABLE_CV(mg ? mg->mg_obj : curpad[ix]);
2373 if (CvOUTSIDE(innercv) == old_cv) {
2374 if (!CvWEAKOUTSIDE(innercv)) {
2375 SvREFCNT_dec(old_cv);
2376 SvREFCNT_inc_simple_void_NN(new_cv);
2378 CvOUTSIDE(innercv) = new_cv;
2381 else { /* format reference */
2382 SV * const rv = curpad[ix];
2384 if (!SvOK(rv)) continue;
2386 assert(SvWEAKREF(rv));
2387 innercv = (CV *)SvRV(rv);
2388 assert(!CvWEAKOUTSIDE(innercv));
2389 SvREFCNT_dec(CvOUTSIDE(innercv));
2390 CvOUTSIDE(innercv) = (CV *)SvREFCNT_inc_simple_NN(new_cv);
2397 =for apidoc m|void|pad_push|PADLIST *padlist|int depth
2399 Push a new pad frame onto the padlist, unless there's already a pad at
2400 this depth, in which case don't bother creating a new one. Then give
2401 the new pad an @_ in slot zero.
2407 Perl_pad_push(pTHX_ PADLIST *padlist, int depth)
2409 PERL_ARGS_ASSERT_PAD_PUSH;
2411 if (depth > PadlistMAX(padlist) || !PadlistARRAY(padlist)[depth]) {
2412 PAD** const svp = PadlistARRAY(padlist);
2413 AV* const newpad = newAV();
2414 SV** const oldpad = AvARRAY(svp[depth-1]);
2415 I32 ix = AvFILLp((const AV *)svp[1]);
2416 const I32 names_fill = AvFILLp((const AV *)svp[0]);
2417 SV** const names = AvARRAY(svp[0]);
2420 for ( ;ix > 0; ix--) {
2421 if (names_fill >= ix && PadnameLEN(names[ix])) {
2422 const char sigil = SvPVX_const(names[ix])[0];
2423 if ((SvFLAGS(names[ix]) & SVf_FAKE)
2424 || (SvFLAGS(names[ix]) & SVpad_STATE)
2427 /* outer lexical or anon code */
2428 av_store(newpad, ix, SvREFCNT_inc(oldpad[ix]));
2430 else { /* our own lexical */
2433 sv = MUTABLE_SV(newAV());
2434 else if (sigil == '%')
2435 sv = MUTABLE_SV(newHV());
2438 av_store(newpad, ix, sv);
2441 else if (PadnamePV(names[ix])) {
2442 av_store(newpad, ix, SvREFCNT_inc_NN(oldpad[ix]));
2445 /* save temporaries on recursion? */
2446 SV * const sv = newSV(0);
2447 av_store(newpad, ix, sv);
2452 av_store(newpad, 0, MUTABLE_SV(av));
2455 padlist_store(padlist, depth, newpad);
2460 =for apidoc Am|HV *|pad_compname_type|PADOFFSET po
2462 Looks up the type of the lexical variable at position I<po> in the
2463 currently-compiling pad. If the variable is typed, the stash of the
2464 class to which it is typed is returned. If not, C<NULL> is returned.
2470 Perl_pad_compname_type(pTHX_ const PADOFFSET po)
2472 SV* const av = PAD_COMPNAME_SV(po);
2473 if ( SvPAD_TYPED(av) ) {
2479 #if defined(USE_ITHREADS)
2481 # define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
2484 =for apidoc padlist_dup
2492 Perl_padlist_dup(pTHX_ PADLIST *srcpad, CLONE_PARAMS *param)
2498 PERL_ARGS_ASSERT_PADLIST_DUP;
2500 cloneall = param->flags & CLONEf_COPY_STACKS
2501 || SvREFCNT(PadlistARRAY(srcpad)[1]) > 1;
2502 assert (SvREFCNT(PadlistARRAY(srcpad)[1]) == 1);
2504 max = cloneall ? PadlistMAX(srcpad) : 1;
2506 Newx(dstpad, 1, PADLIST);
2507 ptr_table_store(PL_ptr_table, srcpad, dstpad);
2508 PadlistMAX(dstpad) = max;
2509 Newx(PadlistARRAY(dstpad), max + 1, PAD *);
2513 for (depth = 0; depth <= max; ++depth)
2514 PadlistARRAY(dstpad)[depth] =
2515 av_dup_inc(PadlistARRAY(srcpad)[depth], param);
2517 /* CvDEPTH() on our subroutine will be set to 0, so there's no need
2518 to build anything other than the first level of pads. */
2519 I32 ix = AvFILLp(PadlistARRAY(srcpad)[1]);
2521 const I32 names_fill = AvFILLp(PadlistARRAY(srcpad)[0]);
2522 const PAD *const srcpad1 = PadlistARRAY(srcpad)[1];
2523 SV **oldpad = AvARRAY(srcpad1);
2528 PadlistARRAY(dstpad)[0] =
2529 av_dup_inc(PadlistARRAY(srcpad)[0], param);
2530 names = AvARRAY(PadlistARRAY(dstpad)[0]);
2534 av_extend(pad1, ix);
2535 PadlistARRAY(dstpad)[1] = pad1;
2536 pad1a = AvARRAY(pad1);
2541 for ( ;ix > 0; ix--) {
2544 } else if (names_fill >= ix && names[ix] &&
2545 PadnameLEN(names[ix])) {
2546 const char sigil = SvPVX_const(names[ix])[0];
2547 if ((SvFLAGS(names[ix]) & SVf_FAKE)
2548 || (SvFLAGS(names[ix]) & SVpad_STATE)
2551 /* outer lexical or anon code */
2552 pad1a[ix] = sv_dup_inc(oldpad[ix], param);
2554 else { /* our own lexical */
2555 if(SvPADSTALE(oldpad[ix]) && SvREFCNT(oldpad[ix]) > 1) {
2556 /* This is a work around for how the current
2557 implementation of ?{ } blocks in regexps
2558 interacts with lexicals. */
2559 pad1a[ix] = sv_dup_inc(oldpad[ix], param);
2564 sv = MUTABLE_SV(newAV());
2565 else if (sigil == '%')
2566 sv = MUTABLE_SV(newHV());
2573 else if (( names_fill >= ix && names[ix]
2574 && PadnamePV(names[ix]) )) {
2575 pad1a[ix] = sv_dup_inc(oldpad[ix], param);
2578 /* save temporaries on recursion? */
2579 SV * const sv = newSV(0);
2582 /* SvREFCNT(oldpad[ix]) != 1 for some code in threads.xs
2583 FIXTHAT before merging this branch.
2584 (And I know how to) */
2585 if (SvPADTMP(oldpad[ix]))
2591 args = newAV(); /* Will be @_ */
2593 pad1a[0] = (SV *)args;
2601 #endif /* USE_ITHREADS */
2604 Perl_padlist_store(pTHX_ PADLIST *padlist, I32 key, PAD *val)
2607 SSize_t const oldmax = PadlistMAX(padlist);
2609 PERL_ARGS_ASSERT_PADLIST_STORE;
2613 if (key > PadlistMAX(padlist)) {
2614 av_extend_guts(NULL,key,&PadlistMAX(padlist),
2615 (SV ***)&PadlistARRAY(padlist),
2616 (SV ***)&PadlistARRAY(padlist));
2617 Zero(PadlistARRAY(padlist)+oldmax+1, PadlistMAX(padlist)-oldmax,
2620 ary = PadlistARRAY(padlist);
2621 SvREFCNT_dec(ary[key]);
2628 * c-indentation-style: bsd
2630 * indent-tabs-mode: nil
2633 * ex: set ts=8 sts=4 sw=4 et: