3 perlintern - autogenerated documentation of purely B<internal>
8 This file is the autogenerated documentation of functions in the
9 Perl interpreter that are documented using Perl's internal documentation
10 format but are not marked as part of the Perl API. In other words,
11 B<they are not for use in extensions>!
14 =head1 CV reference counts and CvOUTSIDE
20 Each CV has a pointer, C<CvOUTSIDE()>, to its lexically enclosing
21 CV (if any). Because pointers to anonymous sub prototypes are
22 stored in C<&> pad slots, it is a possible to get a circular reference,
23 with the parent pointing to the child and vice-versa. To avoid the
24 ensuing memory leak, we do not increment the reference count of the CV
25 pointed to by C<CvOUTSIDE> in the I<one specific instance> that the parent
26 has a C<&> pad slot pointing back to us. In this case, we set the
27 C<CvWEAKOUTSIDE> flag in the child. This allows us to determine under what
28 circumstances we should decrement the refcount of the parent when freeing
31 There is a further complication with non-closure anonymous subs (ie those
32 that do not refer to any lexicals outside that sub). In this case, the
33 anonymous prototype is shared rather than being cloned. This has the
34 consequence that the parent may be freed while there are still active
37 BEGIN { $a = sub { eval '$x' } }
39 In this case, the BEGIN is freed immediately after execution since there
40 are no active references to it: the anon sub prototype has
41 C<CvWEAKOUTSIDE> set since it's not a closure, and $a points to the same
42 CV, so it doesn't contribute to BEGIN's refcount either. When $a is
43 executed, the C<eval '$x'> causes the chain of C<CvOUTSIDE>s to be followed,
44 and the freed BEGIN is accessed.
46 To avoid this, whenever a CV and its associated pad is freed, any
47 C<&> entries in the pad are explicitly removed from the pad, and if the
48 refcount of the pointed-to anon sub is still positive, then that
49 child's C<CvOUTSIDE> is set to point to its grandparent. This will only
50 occur in the single specific case of a non-closure anon prototype
51 having one or more active references (such as C<$a> above).
53 One other thing to consider is that a CV may be merely undefined
54 rather than freed, eg C<undef &foo>. In this case, its refcount may
55 not have reached zero, but we still delete its pad and its C<CvROOT> etc.
56 Since various children may still have their C<CvOUTSIDE> pointing at this
57 undefined CV, we keep its own C<CvOUTSIDE> for the time being, so that
58 the chain of lexical scopes is unbroken. For example, the following
62 sub tmp { sub { eval '$x' } }
67 bool CvWEAKOUTSIDE(CV *cv)
75 =head1 Functions in file pad.h
82 Save the current pad in the given context block structure.
84 void CX_CURPAD_SAVE(struct context)
91 Access the SV at offset po in the saved current pad in the given
92 context block structure (can be used as an lvalue).
94 SV * CX_CURPAD_SV(struct context, PADOFFSET po)
101 Get the value from slot C<po> in the base (DEPTH=1) pad of a padlist
103 SV * PAD_BASE_SV (PADLIST padlist, PADOFFSET po)
111 Clone the state variables associated with running and compiling pads.
113 void PAD_CLONE_VARS(PerlInterpreter *proto_perl \)
118 =item PAD_COMPNAME_FLAGS
120 Return the flags for the current compiling pad name
121 at offset C<po>. Assumes a valid slot entry.
123 U32 PAD_COMPNAME_FLAGS(PADOFFSET po)
128 =item PAD_COMPNAME_GEN
130 The generation number of the name at offset C<po> in the current
131 compiling pad (lvalue). Note that C<SvCUR> is hijacked for this purpose.
133 STRLEN PAD_COMPNAME_GEN(PADOFFSET po)
138 =item PAD_COMPNAME_OURSTASH
140 Return the stash associated with an C<our> variable.
141 Assumes the slot entry is a valid C<our> lexical.
143 HV * PAD_COMPNAME_OURSTASH(PADOFFSET po)
148 =item PAD_COMPNAME_PV
150 Return the name of the current compiling pad name
151 at offset C<po>. Assumes a valid slot entry.
153 char * PAD_COMPNAME_PV(PADOFFSET po)
158 =item PAD_COMPNAME_TYPE
160 Return the type (stash) of the current compiling pad name at offset
161 C<po>. Must be a valid name. Returns null if not typed.
163 HV * PAD_COMPNAME_TYPE(PADOFFSET po)
172 void PAD_DUP(PADLIST dstpad, PADLIST srcpad, CLONE_PARAMS* param)
177 =item PAD_RESTORE_LOCAL
179 Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()
181 void PAD_RESTORE_LOCAL(PAD *opad)
188 Save the current pad to the local variable opad, then make the
189 current pad equal to npad
191 void PAD_SAVE_LOCAL(PAD *opad, PAD *npad)
196 =item PAD_SAVE_SETNULLPAD
198 Save the current pad then set it to null.
200 void PAD_SAVE_SETNULLPAD()
207 Set the slot at offset C<po> in the current pad to C<sv>
209 SV * PAD_SETSV (PADOFFSET po, SV* sv)
216 Set the current pad to be pad C<n> in the padlist, saving
217 the previous current pad.
219 void PAD_SET_CUR (PADLIST padlist, I32 n)
226 Get the value at offset C<po> in the current pad
228 void PAD_SV (PADOFFSET po)
235 Lightweight and lvalue version of C<PAD_SV>.
236 Get or set the value at offset C<po> in the current pad.
237 Unlike C<PAD_SV>, does not print diagnostics with -DX.
238 For internal use only.
240 SV * PAD_SVl (PADOFFSET po)
247 Clear the pointed to pad value on scope exit. (ie the runtime action of 'my')
249 void SAVECLEARSV (SV **svp)
256 save PL_comppad and PL_curpad
269 Save a pad slot (used to restore after an iteration)
271 XXX DAPM it would make more sense to make the arg a PADOFFSET
272 void SAVEPADSV (PADOFFSET po)
280 =head1 Functions in file pp_ctl.c
287 Locate the CV corresponding to the currently executing sub or eval.
288 If db_seqp is non_null, skip CVs that are in the DB package and populate
289 *db_seqp with the cop sequence number at the point that the DB:: code was
290 entered. (allows debuggers to eval in the scope of the breakpoint rather
291 than in in the scope of the debuger itself).
293 CV* find_runcv(U32 *db_seqp)
296 Found in file pp_ctl.c
301 =head1 Global Variables
307 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
308 boolean which indicates whether subs are being single-stepped.
309 Single-stepping is automatically turned on after every step. This is the C
310 variable which corresponds to Perl's $DB::single variable. See
316 Found in file intrpvar.h
320 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
321 the SV which holds the name of the sub being debugged. This is the C
322 variable which corresponds to Perl's $DB::sub variable. See
328 Found in file intrpvar.h
332 Trace variable used when Perl is run in debugging mode, with the B<-d>
333 switch. This is the C variable which corresponds to Perl's $DB::trace
334 variable. See C<PL_DBsingle>.
339 Found in file intrpvar.h
343 The C variable which corresponds to Perl's $^W warning variable.
348 Found in file intrpvar.h
352 The GV which was last used for a filehandle input operation. (C<< <FH> >>)
357 Found in file thrdvar.h
361 The output field separator - C<$,> in Perl space.
366 Found in file thrdvar.h
370 The input record separator - C<$/> in Perl space.
375 Found in file thrdvar.h
386 Returns C<TRUE> if given the name of a magical GV.
388 Currently only useful internally when determining if a GV should be
389 created even in rvalue contexts.
391 C<flags> is not used at present but available for future extension to
392 allow selecting particular classes of magical variable.
394 bool is_gv_magical(char *name, STRLEN len, U32 flags)
408 Function called by C<do_readline> to spawn a glob (or do the glob inside
409 perl on VMS). This code used to be inline, but now perl uses C<File::Glob>
410 this glob starter is only used by miniperl during the build process.
411 Moving it away shrinks pp_hot.c; shrinking pp_hot.c helps speed perl up.
413 PerlIO* start_glob(SV* pattern, IO *io)
421 =head1 Pad Data Structures
427 CV's can have CvPADLIST(cv) set to point to an AV.
429 For these purposes "forms" are a kind-of CV, eval""s are too (except they're
430 not callable at will and are always thrown away after the eval"" is done
433 XSUBs don't have CvPADLIST set - dXSTARG fetches values from PL_curpad,
434 but that is really the callers pad (a slot of which is allocated by
437 The CvPADLIST AV has does not have AvREAL set, so REFCNT of component items
438 is managed "manual" (mostly in pad.c) rather than normal av.c rules.
439 The items in the AV are not SVs as for a normal AV, but other AVs:
441 0'th Entry of the CvPADLIST is an AV which represents the "names" or rather
442 the "static type information" for lexicals.
444 The CvDEPTH'th entry of CvPADLIST AV is an AV which is the stack frame at that
445 depth of recursion into the CV.
446 The 0'th slot of a frame AV is an AV which is @_.
447 other entries are storage for variables and op targets.
450 C<PL_comppad_name> is set the the the names AV.
451 C<PL_comppad> is set the the frame AV for the frame CvDEPTH == 1.
452 C<PL_curpad> is set the body of the frame AV (i.e. AvARRAY(PL_comppad)).
454 During execution, C<PL_comppad> and C<PL_curpad> refer to the live
455 frame of the currently executing sub.
457 Iterating over the names AV iterates over all possible pad
458 items. Pad slots that are SVs_PADTMP (targets/GVs/constants) end up having
459 &PL_sv_undef "names" (see pad_alloc()).
461 Only my/our variable (SVs_PADMY/SVs_PADOUR) slots get valid names.
462 The rest are op targets/GVs/constants which are statically allocated
463 or resolved at compile time. These don't have names by which they
464 can be looked up from Perl code at run time through eval"" like
465 my/our variables can be. Since they can't be looked up by "name"
466 but only by their index allocated at compile time (which is usually
467 in PL_op->op_targ), wasting a name SV for them doesn't make sense.
469 The SVs in the names AV have their PV being the name of the variable.
470 NV+1..IV inclusive is a range of cop_seq numbers for which the name is
471 valid. For typed lexicals name SV is SVt_PVMG and SvSTASH points at the
472 type. For C<our> lexicals, the type is SVt_PVGV, and GvSTASH points at the
473 stash of the associated global (so that duplicate C<our> delarations in the
474 same package can be detected). SvCUR is sometimes hijacked to
475 store the generation number during compilation.
477 If SvFAKE is set on the name SV then slot in the frame AVs are
478 a REFCNT'ed references to a lexical from "outside". In this case,
479 the name SV does not have a cop_seq range, since it is in scope
482 If the 'name' is '&' the the corresponding entry in frame AV
483 is a CV representing a possible closure.
484 (SvFAKE and name of '&' is not a meaningful combination currently but could
485 become so if C<my sub foo {}> is implemented.)
487 AV * CvPADLIST(CV *cv)
494 Clone a CV: make a new CV which points to the same code etc, but which
495 has a newly-created pad built by copying the prototype pad and capturing
498 CV* cv_clone(CV* proto)
505 dump the contents of a CV
507 void cv_dump(CV *cv, char *title)
514 Dump the contents of a padlist
516 void do_dump_pad(I32 level, PerlIO *file, PADLIST *padlist, int full)
523 "Introduce" my variables to visible status.
532 Add an anon code entry to the current compiling pad
534 PADOFFSET pad_add_anon(SV* sv, OPCODE op_type)
541 Create a new name in the current pad at the specified offset.
542 If C<typestash> is valid, the name is for a typed lexical; set the
543 name's stash to that value.
544 If C<ourstash> is valid, it's an our lexical, set the name's
545 GvSTASH to that value
547 Also, if the name is @.. or %.., create a new array or hash for that slot
549 If fake, it means we're cloning an existing entry
551 PADOFFSET pad_add_name(char *name, HV* typestash, HV* ourstash, bool clone)
558 Allocate a new my or tmp pad entry. For a my, simply push a null SV onto
559 the end of PL_comppad, but for a tmp, scan the pad from PL_padix upwards
560 for a slot which has no name and and no active value.
562 PADOFFSET pad_alloc(I32 optype, U32 tmptype)
567 =item pad_block_start
569 Update the pad compilation state variables on entry to a new block
571 void pad_block_start(int full)
578 Check for duplicate declarations: report any of:
579 * a my in the current scope with the same name;
580 * an our (anywhere in the pad) with the same name and the same stash
582 C<is_our> indicates that the name to check is an 'our' declaration
584 void pad_check_dup(char* name, bool is_our, HV* ourstash)
591 Find a named lexical anywhere in a chain of nested pads. Add fake entries
592 in the inner pads if it's found in an outer one. innercv is the CV *inside*
593 the chain of outer CVs to be searched. If newoff is non-null, this is a
594 run-time cloning: don't add fake entries, just find the lexical and add a
595 ref to it at newoff in the current pad.
597 PADOFFSET pad_findlex(char* name, PADOFFSET newoff, CV* innercv)
604 Given a lexical name, try to find its offset, first in the current pad,
605 or failing that, in the pads of any lexically enclosing subs (including
606 the complications introduced by eval). If the name is found in an outer pad,
607 then a fake entry is added to the current pad.
608 Returns the offset in the current pad, or NOT_IN_PAD on failure.
610 PADOFFSET pad_findmy(char* name)
615 =item pad_fixup_inner_anons
617 For any anon CVs in the pad, change CvOUTSIDE of that CV from
618 old_cv to new_cv if necessary. Needed when a newly-compiled CV has to be
619 moved to a pre-existing CV struct.
621 void pad_fixup_inner_anons(PADLIST *padlist, CV *old_cv, CV *new_cv)
628 Free the SV at offet po in the current pad.
630 void pad_free(PADOFFSET po)
637 Cleanup at end of scope during compilation: set the max seq number for
638 lexicals in this scope and warn of any lexicals that never got introduced.
647 Create a new compiling padlist, saving and updating the various global
648 vars at the same time as creating the pad itself. The following flags
649 can be OR'ed together:
651 padnew_CLONE this pad is for a cloned CV
652 padnew_SAVE save old globals
653 padnew_SAVESUB also save extra stuff for start of sub
655 PADLIST* pad_new(int flags)
662 Push a new pad frame onto the padlist, unless there's already a pad at
663 this depth, in which case don't bother creating a new one.
664 If has_args is true, give the new pad an @_ in slot zero.
666 void pad_push(PADLIST *padlist, int depth, int has_args)
673 Mark all the current temporaries for reuse
682 Set the entry at offset po in the current pad to sv.
683 Use the macro PAD_SETSV() rather than calling this function directly.
685 void pad_setsv(PADOFFSET po, SV* sv)
692 Abandon the tmp in the current pad at offset po and replace with a
695 void pad_swipe(PADOFFSET po, bool refadjust)
702 Tidy up a pad after we've finished compiling it:
703 * remove most stuff from the pads of anonsub prototypes;
707 void pad_tidy(padtidy_type type)
714 Free the padlist associated with a CV.
715 If parts of it happen to be current, we null the relevant
716 PL_*pad* global vars so that we don't have any dangling references left.
717 We also repoint the CvOUTSIDE of any about-to-be-orphaned
718 inner subs to the outer of this cv.
720 (This function should really be called pad_free, but the name was already
723 void pad_undef(CV* cv)
731 =head1 Stack Manipulation Macros
737 Declare Just C<SP>. This is actually identical to C<dSP>, and declares
738 a local copy of perl's stack pointer, available via the C<SP> macro.
739 See C<SP>. (Available for backward source code compatibility with the
740 old (Perl 5.005) thread model.)
749 True if this op will be the return value of an lvalue subroutine
757 =head1 SV Manipulation Functions
763 Print appropriate "Use of uninitialized variable" warning
772 Given a chunk of memory, link it to the head of the list of arenas,
773 and split it into a list of free SVs.
775 void sv_add_arena(char* ptr, U32 size, U32 flags)
782 Decrement the refcnt of each remaining SV, possibly triggering a
783 cleanup. This function may have to be called multiple times to free
784 SVs which are in complex self-referential hierarchies.
793 Attempt to destroy all objects not yet freed
802 Deallocate the memory used by all arenas. Note that all the individual SV
803 heads and bodies within the arenas must already have been freed.
805 void sv_free_arenas()
815 The autodocumentation system was originally added to the Perl core by
816 Benjamin Stuhl. Documentation is by whoever was kind enough to
817 document their functions.
821 perlguts(1), perlapi(1)