Skip to content

perlapi: Document sv_dup(_inc)? #22291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: blead
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions embed.fnc
Original file line number Diff line number Diff line change
Expand Up @@ -6360,9 +6360,9 @@ CRdp |PERL_SI *|si_dup |NULLOK PERL_SI *si \
|NN CLONE_PARAMS *param
CRdp |ANY * |ss_dup |NN PerlInterpreter *proto_perl \
|NN CLONE_PARAMS *param
ARp |SV * |sv_dup |NULLOK const SV * const ssv \
CRdp |SV * |sv_dup |NULLOK const SV * const ssv \
|NN CLONE_PARAMS * const param
ARp |SV * |sv_dup_inc |NULLOK const SV * const ssv \
CRdp |SV * |sv_dup_inc |NULLOK const SV * const ssv \
|NN CLONE_PARAMS * const param
# if defined(PERL_IN_OP_C) || defined(PERL_IN_PEEP_C)
p |void |op_relocate_sv |NN SV **svp \
Expand Down
29 changes: 29 additions & 0 deletions sv.c
Original file line number Diff line number Diff line change
Expand Up @@ -15054,6 +15054,35 @@ S_sv_dup_common(pTHX_ const SV *const ssv, CLONE_PARAMS *const param)
return dsv;
}

/*
=for apidoc sv_dup
=for apidoc_item sv_dup_inc

In spite of their generic names, these are very specialized functions mainly
for use when cloning an interpreter instance. You are probably looking for
L<perlapi/newSVsv>.

They duplicate an SV of any type (not just a plain SV, but including AV, HV
I<etc>.), returning a pointer to the cloned object. The difference is that the
new SV under C<sv_dup> has a reference count of 0, but 1 under C<sv_dup_inc>.
Only specialized cases will want a zero reference count, almost certainly only
when you aren't already holding a reference. Thus, you almost always want to
use the C<sv_dup_inc> form.

The cloning process uses use a cache, so that if a particular SV address has
already been duped, that duped SV is returned again rather than creating a
second duplicate.

C<param> has type S<C<CLONE_PARAMS *>>. This is mostly for internal core use
when duplicating something more complicated than an SV (code in common is
used). Your code may inherit this parameter, which you merely pass on, but you
can initialize it by using C<clone_params_new>. Don't forget to
free it when done, via C<clone_params_del>>. Its only member that is
public is C<flags>, all which are documented in L<perlapi/perl_clone>.

=cut
*/

SV *
Perl_sv_dup_inc(pTHX_ const SV *const ssv, CLONE_PARAMS *const param)
{
Expand Down
Loading