3 * Copyright (c) 1991-2002, Larry Wall
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
8 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
11 * This file contains the code that creates, manipulates and destroys
12 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
13 * structure of an SV, so their creation and destruction is handled
14 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
15 * level functions (eg. substr, split, join) for each of the types are
26 #ifdef PERL_COPY_ON_WRITE
27 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
28 #define SV_COW_NEXT_SV_SET(current,next) SvUVX(current) = PTR2UV(next)
29 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
31 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
32 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
33 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
34 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
37 /* ============================================================================
39 =head1 Allocation and deallocation of SVs.
41 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
42 av, hv...) contains type and reference count information, as well as a
43 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
44 specific to each type.
46 Normally, this allocation is done using arenas, which are approximately
47 1K chunks of memory parcelled up into N heads or bodies. The first slot
48 in each arena is reserved, and is used to hold a link to the next arena.
49 In the case of heads, the unused first slot also contains some flags and
50 a note of the number of slots. Snaked through each arena chain is a
51 linked list of free items; when this becomes empty, an extra arena is
52 allocated and divided up into N items which are threaded into the free
55 The following global variables are associated with arenas:
57 PL_sv_arenaroot pointer to list of SV arenas
58 PL_sv_root pointer to list of free SV structures
60 PL_foo_arenaroot pointer to list of foo arenas,
61 PL_foo_root pointer to list of free foo bodies
62 ... for foo in xiv, xnv, xrv, xpv etc.
64 Note that some of the larger and more rarely used body types (eg xpvio)
65 are not allocated using arenas, but are instead just malloc()/free()ed as
66 required. Also, if PURIFY is defined, arenas are abandoned altogether,
67 with all items individually malloc()ed. In addition, a few SV heads are
68 not allocated from an arena, but are instead directly created as static
69 or auto variables, eg PL_sv_undef.
71 The SV arena serves the secondary purpose of allowing still-live SVs
72 to be located and destroyed during final cleanup.
74 At the lowest level, the macros new_SV() and del_SV() grab and free
75 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
76 to return the SV to the free list with error checking.) new_SV() calls
77 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
78 SVs in the free list have their SvTYPE field set to all ones.
80 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
81 that allocate and return individual body types. Normally these are mapped
82 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
83 instead mapped directly to malloc()/free() if PURIFY is defined. The
84 new/del functions remove from, or add to, the appropriate PL_foo_root
85 list, and call more_xiv() etc to add a new arena if the list is empty.
87 At the time of very final cleanup, sv_free_arenas() is called from
88 perl_destruct() to physically free all the arenas allocated since the
89 start of the interpreter. Note that this also clears PL_he_arenaroot,
90 which is otherwise dealt with in hv.c.
92 Manipulation of any of the PL_*root pointers is protected by enclosing
93 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
94 if threads are enabled.
96 The function visit() scans the SV arenas list, and calls a specified
97 function for each SV it finds which is still live - ie which has an SvTYPE
98 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
99 following functions (specified as [function that calls visit()] / [function
100 called by visit() for each SV]):
102 sv_report_used() / do_report_used()
103 dump all remaining SVs (debugging aid)
105 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
106 Attempt to free all objects pointed to by RVs,
107 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
108 try to do the same for all objects indirectly
109 referenced by typeglobs too. Called once from
110 perl_destruct(), prior to calling sv_clean_all()
113 sv_clean_all() / do_clean_all()
114 SvREFCNT_dec(sv) each remaining SV, possibly
115 triggering an sv_free(). It also sets the
116 SVf_BREAK flag on the SV to indicate that the
117 refcnt has been artificially lowered, and thus
118 stopping sv_free() from giving spurious warnings
119 about SVs which unexpectedly have a refcnt
120 of zero. called repeatedly from perl_destruct()
121 until there are no SVs left.
125 Private API to rest of sv.c
129 new_XIV(), del_XIV(),
130 new_XNV(), del_XNV(),
135 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
140 ============================================================================ */
145 * "A time to plant, and a time to uproot what was planted..."
148 #define plant_SV(p) \
150 SvANY(p) = (void *)PL_sv_root; \
151 SvFLAGS(p) = SVTYPEMASK; \
156 /* sv_mutex must be held while calling uproot_SV() */
157 #define uproot_SV(p) \
160 PL_sv_root = (SV*)SvANY(p); \
165 /* new_SV(): return a new, empty SV head */
167 #ifdef DEBUG_LEAKING_SCALARS
168 /* provide a real function for a debugger to play with */
185 # define new_SV(p) (p)=S_new_SV(aTHX)
203 /* del_SV(): return an empty SV head to the free list */
218 S_del_sv(pTHX_ SV *p)
225 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
227 svend = &sva[SvREFCNT(sva)];
228 if (p >= sv && p < svend)
232 if (ckWARN_d(WARN_INTERNAL))
233 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
234 "Attempt to free non-arena SV: 0x%"UVxf,
242 #else /* ! DEBUGGING */
244 #define del_SV(p) plant_SV(p)
246 #endif /* DEBUGGING */
250 =head1 SV Manipulation Functions
252 =for apidoc sv_add_arena
254 Given a chunk of memory, link it to the head of the list of arenas,
255 and split it into a list of free SVs.
261 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
266 Zero(ptr, size, char);
268 /* The first SV in an arena isn't an SV. */
269 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
270 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
271 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
273 PL_sv_arenaroot = sva;
274 PL_sv_root = sva + 1;
276 svend = &sva[SvREFCNT(sva) - 1];
279 SvANY(sv) = (void *)(SV*)(sv + 1);
280 SvFLAGS(sv) = SVTYPEMASK;
284 SvFLAGS(sv) = SVTYPEMASK;
287 /* make some more SVs by adding another arena */
289 /* sv_mutex must be held while calling more_sv() */
296 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
297 PL_nice_chunk = Nullch;
298 PL_nice_chunk_size = 0;
301 char *chunk; /* must use New here to match call to */
302 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
303 sv_add_arena(chunk, 1008, 0);
309 /* visit(): call the named function for each non-free SV in the arenas. */
312 S_visit(pTHX_ SVFUNC_t f)
319 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
320 svend = &sva[SvREFCNT(sva)];
321 for (sv = sva + 1; sv < svend; ++sv) {
322 if (SvTYPE(sv) != SVTYPEMASK && SvREFCNT(sv)) {
333 /* called by sv_report_used() for each live SV */
336 do_report_used(pTHX_ SV *sv)
338 if (SvTYPE(sv) != SVTYPEMASK) {
339 PerlIO_printf(Perl_debug_log, "****\n");
346 =for apidoc sv_report_used
348 Dump the contents of all SVs not yet freed. (Debugging aid).
354 Perl_sv_report_used(pTHX)
357 visit(do_report_used);
361 /* called by sv_clean_objs() for each live SV */
364 do_clean_objs(pTHX_ SV *sv)
368 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
369 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
381 /* XXX Might want to check arrays, etc. */
384 /* called by sv_clean_objs() for each live SV */
386 #ifndef DISABLE_DESTRUCTOR_KLUDGE
388 do_clean_named_objs(pTHX_ SV *sv)
390 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
391 if ( SvOBJECT(GvSV(sv)) ||
392 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
393 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
394 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
395 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
397 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
405 =for apidoc sv_clean_objs
407 Attempt to destroy all objects not yet freed
413 Perl_sv_clean_objs(pTHX)
415 PL_in_clean_objs = TRUE;
416 visit(do_clean_objs);
417 #ifndef DISABLE_DESTRUCTOR_KLUDGE
418 /* some barnacles may yet remain, clinging to typeglobs */
419 visit(do_clean_named_objs);
421 PL_in_clean_objs = FALSE;
424 /* called by sv_clean_all() for each live SV */
427 do_clean_all(pTHX_ SV *sv)
429 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
430 SvFLAGS(sv) |= SVf_BREAK;
435 =for apidoc sv_clean_all
437 Decrement the refcnt of each remaining SV, possibly triggering a
438 cleanup. This function may have to be called multiple times to free
439 SVs which are in complex self-referential hierarchies.
445 Perl_sv_clean_all(pTHX)
448 PL_in_clean_all = TRUE;
449 cleaned = visit(do_clean_all);
450 PL_in_clean_all = FALSE;
455 =for apidoc sv_free_arenas
457 Deallocate the memory used by all arenas. Note that all the individual SV
458 heads and bodies within the arenas must already have been freed.
464 Perl_sv_free_arenas(pTHX)
468 XPV *arena, *arenanext;
470 /* Free arenas here, but be careful about fake ones. (We assume
471 contiguity of the fake ones with the corresponding real ones.) */
473 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
474 svanext = (SV*) SvANY(sva);
475 while (svanext && SvFAKE(svanext))
476 svanext = (SV*) SvANY(svanext);
479 Safefree((void *)sva);
482 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
483 arenanext = (XPV*)arena->xpv_pv;
486 PL_xiv_arenaroot = 0;
488 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
489 arenanext = (XPV*)arena->xpv_pv;
492 PL_xnv_arenaroot = 0;
494 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
495 arenanext = (XPV*)arena->xpv_pv;
498 PL_xrv_arenaroot = 0;
500 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
501 arenanext = (XPV*)arena->xpv_pv;
504 PL_xpv_arenaroot = 0;
506 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
507 arenanext = (XPV*)arena->xpv_pv;
510 PL_xpviv_arenaroot = 0;
512 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
513 arenanext = (XPV*)arena->xpv_pv;
516 PL_xpvnv_arenaroot = 0;
518 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
519 arenanext = (XPV*)arena->xpv_pv;
522 PL_xpvcv_arenaroot = 0;
524 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
525 arenanext = (XPV*)arena->xpv_pv;
528 PL_xpvav_arenaroot = 0;
530 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
531 arenanext = (XPV*)arena->xpv_pv;
534 PL_xpvhv_arenaroot = 0;
536 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
537 arenanext = (XPV*)arena->xpv_pv;
540 PL_xpvmg_arenaroot = 0;
542 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
543 arenanext = (XPV*)arena->xpv_pv;
546 PL_xpvlv_arenaroot = 0;
548 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
549 arenanext = (XPV*)arena->xpv_pv;
552 PL_xpvbm_arenaroot = 0;
554 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
555 arenanext = (XPV*)arena->xpv_pv;
561 Safefree(PL_nice_chunk);
562 PL_nice_chunk = Nullch;
563 PL_nice_chunk_size = 0;
569 =for apidoc report_uninit
571 Print appropriate "Use of uninitialized variable" warning
577 Perl_report_uninit(pTHX)
580 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
581 " in ", OP_DESC(PL_op));
583 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit, "", "");
586 /* grab a new IV body from the free list, allocating more if necessary */
597 * See comment in more_xiv() -- RAM.
599 PL_xiv_root = *(IV**)xiv;
601 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
604 /* return an IV body to the free list */
607 S_del_xiv(pTHX_ XPVIV *p)
609 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
611 *(IV**)xiv = PL_xiv_root;
616 /* allocate another arena's worth of IV bodies */
624 New(705, ptr, 1008/sizeof(XPV), XPV);
625 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
626 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
629 xivend = &xiv[1008 / sizeof(IV) - 1];
630 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
632 while (xiv < xivend) {
633 *(IV**)xiv = (IV *)(xiv + 1);
639 /* grab a new NV body from the free list, allocating more if necessary */
649 PL_xnv_root = *(NV**)xnv;
651 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
654 /* return an NV body to the free list */
657 S_del_xnv(pTHX_ XPVNV *p)
659 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
661 *(NV**)xnv = PL_xnv_root;
666 /* allocate another arena's worth of NV bodies */
674 New(711, ptr, 1008/sizeof(XPV), XPV);
675 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
676 PL_xnv_arenaroot = ptr;
679 xnvend = &xnv[1008 / sizeof(NV) - 1];
680 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
682 while (xnv < xnvend) {
683 *(NV**)xnv = (NV*)(xnv + 1);
689 /* grab a new struct xrv from the free list, allocating more if necessary */
699 PL_xrv_root = (XRV*)xrv->xrv_rv;
704 /* return a struct xrv to the free list */
707 S_del_xrv(pTHX_ XRV *p)
710 p->xrv_rv = (SV*)PL_xrv_root;
715 /* allocate another arena's worth of struct xrv */
721 register XRV* xrvend;
723 New(712, ptr, 1008/sizeof(XPV), XPV);
724 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
725 PL_xrv_arenaroot = ptr;
728 xrvend = &xrv[1008 / sizeof(XRV) - 1];
729 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
731 while (xrv < xrvend) {
732 xrv->xrv_rv = (SV*)(xrv + 1);
738 /* grab a new struct xpv from the free list, allocating more if necessary */
748 PL_xpv_root = (XPV*)xpv->xpv_pv;
753 /* return a struct xpv to the free list */
756 S_del_xpv(pTHX_ XPV *p)
759 p->xpv_pv = (char*)PL_xpv_root;
764 /* allocate another arena's worth of struct xpv */
770 register XPV* xpvend;
771 New(713, xpv, 1008/sizeof(XPV), XPV);
772 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
773 PL_xpv_arenaroot = xpv;
775 xpvend = &xpv[1008 / sizeof(XPV) - 1];
777 while (xpv < xpvend) {
778 xpv->xpv_pv = (char*)(xpv + 1);
784 /* grab a new struct xpviv from the free list, allocating more if necessary */
793 xpviv = PL_xpviv_root;
794 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
799 /* return a struct xpviv to the free list */
802 S_del_xpviv(pTHX_ XPVIV *p)
805 p->xpv_pv = (char*)PL_xpviv_root;
810 /* allocate another arena's worth of struct xpviv */
815 register XPVIV* xpviv;
816 register XPVIV* xpvivend;
817 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
818 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
819 PL_xpviv_arenaroot = xpviv;
821 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
822 PL_xpviv_root = ++xpviv;
823 while (xpviv < xpvivend) {
824 xpviv->xpv_pv = (char*)(xpviv + 1);
830 /* grab a new struct xpvnv from the free list, allocating more if necessary */
839 xpvnv = PL_xpvnv_root;
840 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
845 /* return a struct xpvnv to the free list */
848 S_del_xpvnv(pTHX_ XPVNV *p)
851 p->xpv_pv = (char*)PL_xpvnv_root;
856 /* allocate another arena's worth of struct xpvnv */
861 register XPVNV* xpvnv;
862 register XPVNV* xpvnvend;
863 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
864 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
865 PL_xpvnv_arenaroot = xpvnv;
867 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
868 PL_xpvnv_root = ++xpvnv;
869 while (xpvnv < xpvnvend) {
870 xpvnv->xpv_pv = (char*)(xpvnv + 1);
876 /* grab a new struct xpvcv from the free list, allocating more if necessary */
885 xpvcv = PL_xpvcv_root;
886 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
891 /* return a struct xpvcv to the free list */
894 S_del_xpvcv(pTHX_ XPVCV *p)
897 p->xpv_pv = (char*)PL_xpvcv_root;
902 /* allocate another arena's worth of struct xpvcv */
907 register XPVCV* xpvcv;
908 register XPVCV* xpvcvend;
909 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
910 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
911 PL_xpvcv_arenaroot = xpvcv;
913 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
914 PL_xpvcv_root = ++xpvcv;
915 while (xpvcv < xpvcvend) {
916 xpvcv->xpv_pv = (char*)(xpvcv + 1);
922 /* grab a new struct xpvav from the free list, allocating more if necessary */
931 xpvav = PL_xpvav_root;
932 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
937 /* return a struct xpvav to the free list */
940 S_del_xpvav(pTHX_ XPVAV *p)
943 p->xav_array = (char*)PL_xpvav_root;
948 /* allocate another arena's worth of struct xpvav */
953 register XPVAV* xpvav;
954 register XPVAV* xpvavend;
955 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
956 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
957 PL_xpvav_arenaroot = xpvav;
959 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
960 PL_xpvav_root = ++xpvav;
961 while (xpvav < xpvavend) {
962 xpvav->xav_array = (char*)(xpvav + 1);
965 xpvav->xav_array = 0;
968 /* grab a new struct xpvhv from the free list, allocating more if necessary */
977 xpvhv = PL_xpvhv_root;
978 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
983 /* return a struct xpvhv to the free list */
986 S_del_xpvhv(pTHX_ XPVHV *p)
989 p->xhv_array = (char*)PL_xpvhv_root;
994 /* allocate another arena's worth of struct xpvhv */
999 register XPVHV* xpvhv;
1000 register XPVHV* xpvhvend;
1001 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
1002 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1003 PL_xpvhv_arenaroot = xpvhv;
1005 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
1006 PL_xpvhv_root = ++xpvhv;
1007 while (xpvhv < xpvhvend) {
1008 xpvhv->xhv_array = (char*)(xpvhv + 1);
1011 xpvhv->xhv_array = 0;
1014 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1023 xpvmg = PL_xpvmg_root;
1024 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1029 /* return a struct xpvmg to the free list */
1032 S_del_xpvmg(pTHX_ XPVMG *p)
1035 p->xpv_pv = (char*)PL_xpvmg_root;
1040 /* allocate another arena's worth of struct xpvmg */
1045 register XPVMG* xpvmg;
1046 register XPVMG* xpvmgend;
1047 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1048 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1049 PL_xpvmg_arenaroot = xpvmg;
1051 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1052 PL_xpvmg_root = ++xpvmg;
1053 while (xpvmg < xpvmgend) {
1054 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1060 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1069 xpvlv = PL_xpvlv_root;
1070 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1075 /* return a struct xpvlv to the free list */
1078 S_del_xpvlv(pTHX_ XPVLV *p)
1081 p->xpv_pv = (char*)PL_xpvlv_root;
1086 /* allocate another arena's worth of struct xpvlv */
1091 register XPVLV* xpvlv;
1092 register XPVLV* xpvlvend;
1093 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1094 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1095 PL_xpvlv_arenaroot = xpvlv;
1097 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1098 PL_xpvlv_root = ++xpvlv;
1099 while (xpvlv < xpvlvend) {
1100 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1106 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1115 xpvbm = PL_xpvbm_root;
1116 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1121 /* return a struct xpvbm to the free list */
1124 S_del_xpvbm(pTHX_ XPVBM *p)
1127 p->xpv_pv = (char*)PL_xpvbm_root;
1132 /* allocate another arena's worth of struct xpvbm */
1137 register XPVBM* xpvbm;
1138 register XPVBM* xpvbmend;
1139 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1140 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1141 PL_xpvbm_arenaroot = xpvbm;
1143 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1144 PL_xpvbm_root = ++xpvbm;
1145 while (xpvbm < xpvbmend) {
1146 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1152 #define my_safemalloc(s) (void*)safemalloc(s)
1153 #define my_safefree(p) safefree((char*)p)
1157 #define new_XIV() my_safemalloc(sizeof(XPVIV))
1158 #define del_XIV(p) my_safefree(p)
1160 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1161 #define del_XNV(p) my_safefree(p)
1163 #define new_XRV() my_safemalloc(sizeof(XRV))
1164 #define del_XRV(p) my_safefree(p)
1166 #define new_XPV() my_safemalloc(sizeof(XPV))
1167 #define del_XPV(p) my_safefree(p)
1169 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1170 #define del_XPVIV(p) my_safefree(p)
1172 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1173 #define del_XPVNV(p) my_safefree(p)
1175 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1176 #define del_XPVCV(p) my_safefree(p)
1178 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1179 #define del_XPVAV(p) my_safefree(p)
1181 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1182 #define del_XPVHV(p) my_safefree(p)
1184 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1185 #define del_XPVMG(p) my_safefree(p)
1187 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1188 #define del_XPVLV(p) my_safefree(p)
1190 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1191 #define del_XPVBM(p) my_safefree(p)
1195 #define new_XIV() (void*)new_xiv()
1196 #define del_XIV(p) del_xiv((XPVIV*) p)
1198 #define new_XNV() (void*)new_xnv()
1199 #define del_XNV(p) del_xnv((XPVNV*) p)
1201 #define new_XRV() (void*)new_xrv()
1202 #define del_XRV(p) del_xrv((XRV*) p)
1204 #define new_XPV() (void*)new_xpv()
1205 #define del_XPV(p) del_xpv((XPV *)p)
1207 #define new_XPVIV() (void*)new_xpviv()
1208 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1210 #define new_XPVNV() (void*)new_xpvnv()
1211 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1213 #define new_XPVCV() (void*)new_xpvcv()
1214 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1216 #define new_XPVAV() (void*)new_xpvav()
1217 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1219 #define new_XPVHV() (void*)new_xpvhv()
1220 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1222 #define new_XPVMG() (void*)new_xpvmg()
1223 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1225 #define new_XPVLV() (void*)new_xpvlv()
1226 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1228 #define new_XPVBM() (void*)new_xpvbm()
1229 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1233 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1234 #define del_XPVGV(p) my_safefree(p)
1236 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1237 #define del_XPVFM(p) my_safefree(p)
1239 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1240 #define del_XPVIO(p) my_safefree(p)
1243 =for apidoc sv_upgrade
1245 Upgrade an SV to a more complex form. Generally adds a new body type to the
1246 SV, then copies across as much information as possible from the old body.
1247 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1253 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1260 MAGIC* magic = NULL;
1263 if (mt != SVt_PV && SvIsCOW(sv)) {
1264 sv_force_normal_flags(sv, 0);
1267 if (SvTYPE(sv) == mt)
1271 (void)SvOOK_off(sv);
1273 switch (SvTYPE(sv)) {
1294 else if (mt < SVt_PVIV)
1311 pv = (char*)SvRV(sv);
1331 else if (mt == SVt_NV)
1342 del_XPVIV(SvANY(sv));
1352 del_XPVNV(SvANY(sv));
1360 magic = SvMAGIC(sv);
1361 stash = SvSTASH(sv);
1362 del_XPVMG(SvANY(sv));
1365 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1370 Perl_croak(aTHX_ "Can't upgrade to undef");
1372 SvANY(sv) = new_XIV();
1376 SvANY(sv) = new_XNV();
1380 SvANY(sv) = new_XRV();
1384 SvANY(sv) = new_XPV();
1390 SvANY(sv) = new_XPVIV();
1400 SvANY(sv) = new_XPVNV();
1408 SvANY(sv) = new_XPVMG();
1414 SvMAGIC(sv) = magic;
1415 SvSTASH(sv) = stash;
1418 SvANY(sv) = new_XPVLV();
1424 SvMAGIC(sv) = magic;
1425 SvSTASH(sv) = stash;
1432 SvANY(sv) = new_XPVAV();
1440 SvMAGIC(sv) = magic;
1441 SvSTASH(sv) = stash;
1447 SvANY(sv) = new_XPVHV();
1453 HvTOTALKEYS(sv) = 0;
1454 HvPLACEHOLDERS(sv) = 0;
1455 SvMAGIC(sv) = magic;
1456 SvSTASH(sv) = stash;
1463 SvANY(sv) = new_XPVCV();
1464 Zero(SvANY(sv), 1, XPVCV);
1470 SvMAGIC(sv) = magic;
1471 SvSTASH(sv) = stash;
1474 SvANY(sv) = new_XPVGV();
1480 SvMAGIC(sv) = magic;
1481 SvSTASH(sv) = stash;
1489 SvANY(sv) = new_XPVBM();
1495 SvMAGIC(sv) = magic;
1496 SvSTASH(sv) = stash;
1502 SvANY(sv) = new_XPVFM();
1503 Zero(SvANY(sv), 1, XPVFM);
1509 SvMAGIC(sv) = magic;
1510 SvSTASH(sv) = stash;
1513 SvANY(sv) = new_XPVIO();
1514 Zero(SvANY(sv), 1, XPVIO);
1520 SvMAGIC(sv) = magic;
1521 SvSTASH(sv) = stash;
1522 IoPAGE_LEN(sv) = 60;
1525 SvFLAGS(sv) &= ~SVTYPEMASK;
1531 =for apidoc sv_backoff
1533 Remove any string offset. You should normally use the C<SvOOK_off> macro
1540 Perl_sv_backoff(pTHX_ register SV *sv)
1544 char *s = SvPVX(sv);
1545 SvLEN(sv) += SvIVX(sv);
1546 SvPVX(sv) -= SvIVX(sv);
1548 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1550 SvFLAGS(sv) &= ~SVf_OOK;
1557 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1558 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1559 Use the C<SvGROW> wrapper instead.
1565 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1571 #ifdef HAS_64K_LIMIT
1572 if (newlen >= 0x10000) {
1573 PerlIO_printf(Perl_debug_log,
1574 "Allocation too large: %"UVxf"\n", (UV)newlen);
1577 #endif /* HAS_64K_LIMIT */
1580 if (SvTYPE(sv) < SVt_PV) {
1581 sv_upgrade(sv, SVt_PV);
1584 else if (SvOOK(sv)) { /* pv is offset? */
1587 if (newlen > SvLEN(sv))
1588 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1589 #ifdef HAS_64K_LIMIT
1590 if (newlen >= 0x10000)
1597 if (newlen > SvLEN(sv)) { /* need more room? */
1598 if (SvLEN(sv) && s) {
1600 STRLEN l = malloced_size((void*)SvPVX(sv));
1606 Renew(s,newlen,char);
1609 New(703, s, newlen, char);
1610 if (SvPVX(sv) && SvCUR(sv)) {
1611 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1615 SvLEN_set(sv, newlen);
1621 =for apidoc sv_setiv
1623 Copies an integer into the given SV, upgrading first if necessary.
1624 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1630 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1632 SV_CHECK_THINKFIRST_COW_DROP(sv);
1633 switch (SvTYPE(sv)) {
1635 sv_upgrade(sv, SVt_IV);
1638 sv_upgrade(sv, SVt_PVNV);
1642 sv_upgrade(sv, SVt_PVIV);
1651 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1654 (void)SvIOK_only(sv); /* validate number */
1660 =for apidoc sv_setiv_mg
1662 Like C<sv_setiv>, but also handles 'set' magic.
1668 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1675 =for apidoc sv_setuv
1677 Copies an unsigned integer into the given SV, upgrading first if necessary.
1678 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1684 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1686 /* With these two if statements:
1687 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1690 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1692 If you wish to remove them, please benchmark to see what the effect is
1694 if (u <= (UV)IV_MAX) {
1695 sv_setiv(sv, (IV)u);
1704 =for apidoc sv_setuv_mg
1706 Like C<sv_setuv>, but also handles 'set' magic.
1712 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1714 /* With these two if statements:
1715 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1718 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1720 If you wish to remove them, please benchmark to see what the effect is
1722 if (u <= (UV)IV_MAX) {
1723 sv_setiv(sv, (IV)u);
1733 =for apidoc sv_setnv
1735 Copies a double into the given SV, upgrading first if necessary.
1736 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1742 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1744 SV_CHECK_THINKFIRST_COW_DROP(sv);
1745 switch (SvTYPE(sv)) {
1748 sv_upgrade(sv, SVt_NV);
1753 sv_upgrade(sv, SVt_PVNV);
1762 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1766 (void)SvNOK_only(sv); /* validate number */
1771 =for apidoc sv_setnv_mg
1773 Like C<sv_setnv>, but also handles 'set' magic.
1779 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1785 /* Print an "isn't numeric" warning, using a cleaned-up,
1786 * printable version of the offending string
1790 S_not_a_number(pTHX_ SV *sv)
1797 dsv = sv_2mortal(newSVpv("", 0));
1798 pv = sv_uni_display(dsv, sv, 10, 0);
1801 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1802 /* each *s can expand to 4 chars + "...\0",
1803 i.e. need room for 8 chars */
1806 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
1808 if (ch & 128 && !isPRINT_LC(ch)) {
1817 else if (ch == '\r') {
1821 else if (ch == '\f') {
1825 else if (ch == '\\') {
1829 else if (ch == '\0') {
1833 else if (isPRINT_LC(ch))
1850 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1851 "Argument \"%s\" isn't numeric in %s", pv,
1854 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1855 "Argument \"%s\" isn't numeric", pv);
1859 =for apidoc looks_like_number
1861 Test if the content of an SV looks like a number (or is a number).
1862 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1863 non-numeric warning), even if your atof() doesn't grok them.
1869 Perl_looks_like_number(pTHX_ SV *sv)
1871 register char *sbegin;
1878 else if (SvPOKp(sv))
1879 sbegin = SvPV(sv, len);
1881 return 1; /* Historic. Wrong? */
1882 return grok_number(sbegin, len, NULL);
1885 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1886 until proven guilty, assume that things are not that bad... */
1891 As 64 bit platforms often have an NV that doesn't preserve all bits of
1892 an IV (an assumption perl has been based on to date) it becomes necessary
1893 to remove the assumption that the NV always carries enough precision to
1894 recreate the IV whenever needed, and that the NV is the canonical form.
1895 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1896 precision as a side effect of conversion (which would lead to insanity
1897 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1898 1) to distinguish between IV/UV/NV slots that have cached a valid
1899 conversion where precision was lost and IV/UV/NV slots that have a
1900 valid conversion which has lost no precision
1901 2) to ensure that if a numeric conversion to one form is requested that
1902 would lose precision, the precise conversion (or differently
1903 imprecise conversion) is also performed and cached, to prevent
1904 requests for different numeric formats on the same SV causing
1905 lossy conversion chains. (lossless conversion chains are perfectly
1910 SvIOKp is true if the IV slot contains a valid value
1911 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1912 SvNOKp is true if the NV slot contains a valid value
1913 SvNOK is true only if the NV value is accurate
1916 while converting from PV to NV, check to see if converting that NV to an
1917 IV(or UV) would lose accuracy over a direct conversion from PV to
1918 IV(or UV). If it would, cache both conversions, return NV, but mark
1919 SV as IOK NOKp (ie not NOK).
1921 While converting from PV to IV, check to see if converting that IV to an
1922 NV would lose accuracy over a direct conversion from PV to NV. If it
1923 would, cache both conversions, flag similarly.
1925 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1926 correctly because if IV & NV were set NV *always* overruled.
1927 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1928 changes - now IV and NV together means that the two are interchangeable:
1929 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1931 The benefit of this is that operations such as pp_add know that if
1932 SvIOK is true for both left and right operands, then integer addition
1933 can be used instead of floating point (for cases where the result won't
1934 overflow). Before, floating point was always used, which could lead to
1935 loss of precision compared with integer addition.
1937 * making IV and NV equal status should make maths accurate on 64 bit
1939 * may speed up maths somewhat if pp_add and friends start to use
1940 integers when possible instead of fp. (Hopefully the overhead in
1941 looking for SvIOK and checking for overflow will not outweigh the
1942 fp to integer speedup)
1943 * will slow down integer operations (callers of SvIV) on "inaccurate"
1944 values, as the change from SvIOK to SvIOKp will cause a call into
1945 sv_2iv each time rather than a macro access direct to the IV slot
1946 * should speed up number->string conversion on integers as IV is
1947 favoured when IV and NV are equally accurate
1949 ####################################################################
1950 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1951 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1952 On the other hand, SvUOK is true iff UV.
1953 ####################################################################
1955 Your mileage will vary depending your CPU's relative fp to integer
1959 #ifndef NV_PRESERVES_UV
1960 # define IS_NUMBER_UNDERFLOW_IV 1
1961 # define IS_NUMBER_UNDERFLOW_UV 2
1962 # define IS_NUMBER_IV_AND_UV 2
1963 # define IS_NUMBER_OVERFLOW_IV 4
1964 # define IS_NUMBER_OVERFLOW_UV 5
1966 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1968 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1970 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1972 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1973 if (SvNVX(sv) < (NV)IV_MIN) {
1974 (void)SvIOKp_on(sv);
1977 return IS_NUMBER_UNDERFLOW_IV;
1979 if (SvNVX(sv) > (NV)UV_MAX) {
1980 (void)SvIOKp_on(sv);
1984 return IS_NUMBER_OVERFLOW_UV;
1986 (void)SvIOKp_on(sv);
1988 /* Can't use strtol etc to convert this string. (See truth table in
1990 if (SvNVX(sv) <= (UV)IV_MAX) {
1991 SvIVX(sv) = I_V(SvNVX(sv));
1992 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1993 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1995 /* Integer is imprecise. NOK, IOKp */
1997 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2000 SvUVX(sv) = U_V(SvNVX(sv));
2001 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2002 if (SvUVX(sv) == UV_MAX) {
2003 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2004 possibly be preserved by NV. Hence, it must be overflow.
2006 return IS_NUMBER_OVERFLOW_UV;
2008 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2010 /* Integer is imprecise. NOK, IOKp */
2012 return IS_NUMBER_OVERFLOW_IV;
2014 #endif /* !NV_PRESERVES_UV*/
2019 Return the integer value of an SV, doing any necessary string conversion,
2020 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2026 Perl_sv_2iv(pTHX_ register SV *sv)
2030 if (SvGMAGICAL(sv)) {
2035 return I_V(SvNVX(sv));
2037 if (SvPOKp(sv) && SvLEN(sv))
2040 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2041 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2047 if (SvTHINKFIRST(sv)) {
2050 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2051 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2052 return SvIV(tmpstr);
2053 return PTR2IV(SvRV(sv));
2056 sv_force_normal_flags(sv, 0);
2058 if (SvREADONLY(sv) && !SvOK(sv)) {
2059 if (ckWARN(WARN_UNINITIALIZED))
2066 return (IV)(SvUVX(sv));
2073 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2074 * without also getting a cached IV/UV from it at the same time
2075 * (ie PV->NV conversion should detect loss of accuracy and cache
2076 * IV or UV at same time to avoid this. NWC */
2078 if (SvTYPE(sv) == SVt_NV)
2079 sv_upgrade(sv, SVt_PVNV);
2081 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2082 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2083 certainly cast into the IV range at IV_MAX, whereas the correct
2084 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2086 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2087 SvIVX(sv) = I_V(SvNVX(sv));
2088 if (SvNVX(sv) == (NV) SvIVX(sv)
2089 #ifndef NV_PRESERVES_UV
2090 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2091 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2092 /* Don't flag it as "accurately an integer" if the number
2093 came from a (by definition imprecise) NV operation, and
2094 we're outside the range of NV integer precision */
2097 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2098 DEBUG_c(PerlIO_printf(Perl_debug_log,
2099 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2105 /* IV not precise. No need to convert from PV, as NV
2106 conversion would already have cached IV if it detected
2107 that PV->IV would be better than PV->NV->IV
2108 flags already correct - don't set public IOK. */
2109 DEBUG_c(PerlIO_printf(Perl_debug_log,
2110 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2115 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2116 but the cast (NV)IV_MIN rounds to a the value less (more
2117 negative) than IV_MIN which happens to be equal to SvNVX ??
2118 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2119 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2120 (NV)UVX == NVX are both true, but the values differ. :-(
2121 Hopefully for 2s complement IV_MIN is something like
2122 0x8000000000000000 which will be exact. NWC */
2125 SvUVX(sv) = U_V(SvNVX(sv));
2127 (SvNVX(sv) == (NV) SvUVX(sv))
2128 #ifndef NV_PRESERVES_UV
2129 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2130 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2131 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2132 /* Don't flag it as "accurately an integer" if the number
2133 came from a (by definition imprecise) NV operation, and
2134 we're outside the range of NV integer precision */
2140 DEBUG_c(PerlIO_printf(Perl_debug_log,
2141 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2145 return (IV)SvUVX(sv);
2148 else if (SvPOKp(sv) && SvLEN(sv)) {
2150 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2151 /* We want to avoid a possible problem when we cache an IV which
2152 may be later translated to an NV, and the resulting NV is not
2153 the same as the direct translation of the initial string
2154 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2155 be careful to ensure that the value with the .456 is around if the
2156 NV value is requested in the future).
2158 This means that if we cache such an IV, we need to cache the
2159 NV as well. Moreover, we trade speed for space, and do not
2160 cache the NV if we are sure it's not needed.
2163 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2164 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2165 == IS_NUMBER_IN_UV) {
2166 /* It's definitely an integer, only upgrade to PVIV */
2167 if (SvTYPE(sv) < SVt_PVIV)
2168 sv_upgrade(sv, SVt_PVIV);
2170 } else if (SvTYPE(sv) < SVt_PVNV)
2171 sv_upgrade(sv, SVt_PVNV);
2173 /* If NV preserves UV then we only use the UV value if we know that
2174 we aren't going to call atof() below. If NVs don't preserve UVs
2175 then the value returned may have more precision than atof() will
2176 return, even though value isn't perfectly accurate. */
2177 if ((numtype & (IS_NUMBER_IN_UV
2178 #ifdef NV_PRESERVES_UV
2181 )) == IS_NUMBER_IN_UV) {
2182 /* This won't turn off the public IOK flag if it was set above */
2183 (void)SvIOKp_on(sv);
2185 if (!(numtype & IS_NUMBER_NEG)) {
2187 if (value <= (UV)IV_MAX) {
2188 SvIVX(sv) = (IV)value;
2194 /* 2s complement assumption */
2195 if (value <= (UV)IV_MIN) {
2196 SvIVX(sv) = -(IV)value;
2198 /* Too negative for an IV. This is a double upgrade, but
2199 I'm assuming it will be rare. */
2200 if (SvTYPE(sv) < SVt_PVNV)
2201 sv_upgrade(sv, SVt_PVNV);
2205 SvNVX(sv) = -(NV)value;
2210 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2211 will be in the previous block to set the IV slot, and the next
2212 block to set the NV slot. So no else here. */
2214 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2215 != IS_NUMBER_IN_UV) {
2216 /* It wasn't an (integer that doesn't overflow the UV). */
2217 SvNVX(sv) = Atof(SvPVX(sv));
2219 if (! numtype && ckWARN(WARN_NUMERIC))
2222 #if defined(USE_LONG_DOUBLE)
2223 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2224 PTR2UV(sv), SvNVX(sv)));
2226 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2227 PTR2UV(sv), SvNVX(sv)));
2231 #ifdef NV_PRESERVES_UV
2232 (void)SvIOKp_on(sv);
2234 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2235 SvIVX(sv) = I_V(SvNVX(sv));
2236 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2239 /* Integer is imprecise. NOK, IOKp */
2241 /* UV will not work better than IV */
2243 if (SvNVX(sv) > (NV)UV_MAX) {
2245 /* Integer is inaccurate. NOK, IOKp, is UV */
2249 SvUVX(sv) = U_V(SvNVX(sv));
2250 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2251 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2255 /* Integer is imprecise. NOK, IOKp, is UV */
2261 #else /* NV_PRESERVES_UV */
2262 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2263 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2264 /* The IV slot will have been set from value returned by
2265 grok_number above. The NV slot has just been set using
2268 assert (SvIOKp(sv));
2270 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2271 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2272 /* Small enough to preserve all bits. */
2273 (void)SvIOKp_on(sv);
2275 SvIVX(sv) = I_V(SvNVX(sv));
2276 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2278 /* Assumption: first non-preserved integer is < IV_MAX,
2279 this NV is in the preserved range, therefore: */
2280 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2282 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs(SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2286 0 0 already failed to read UV.
2287 0 1 already failed to read UV.
2288 1 0 you won't get here in this case. IV/UV
2289 slot set, public IOK, Atof() unneeded.
2290 1 1 already read UV.
2291 so there's no point in sv_2iuv_non_preserve() attempting
2292 to use atol, strtol, strtoul etc. */
2293 if (sv_2iuv_non_preserve (sv, numtype)
2294 >= IS_NUMBER_OVERFLOW_IV)
2298 #endif /* NV_PRESERVES_UV */
2301 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2303 if (SvTYPE(sv) < SVt_IV)
2304 /* Typically the caller expects that sv_any is not NULL now. */
2305 sv_upgrade(sv, SVt_IV);
2308 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2309 PTR2UV(sv),SvIVX(sv)));
2310 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2316 Return the unsigned integer value of an SV, doing any necessary string
2317 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
2324 Perl_sv_2uv(pTHX_ register SV *sv)
2328 if (SvGMAGICAL(sv)) {
2333 return U_V(SvNVX(sv));
2334 if (SvPOKp(sv) && SvLEN(sv))
2337 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2338 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2344 if (SvTHINKFIRST(sv)) {
2347 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2348 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2349 return SvUV(tmpstr);
2350 return PTR2UV(SvRV(sv));
2353 sv_force_normal_flags(sv, 0);
2355 if (SvREADONLY(sv) && !SvOK(sv)) {
2356 if (ckWARN(WARN_UNINITIALIZED))
2366 return (UV)SvIVX(sv);
2370 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2371 * without also getting a cached IV/UV from it at the same time
2372 * (ie PV->NV conversion should detect loss of accuracy and cache
2373 * IV or UV at same time to avoid this. */
2374 /* IV-over-UV optimisation - choose to cache IV if possible */
2376 if (SvTYPE(sv) == SVt_NV)
2377 sv_upgrade(sv, SVt_PVNV);
2379 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2380 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2381 SvIVX(sv) = I_V(SvNVX(sv));
2382 if (SvNVX(sv) == (NV) SvIVX(sv)
2383 #ifndef NV_PRESERVES_UV
2384 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2385 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2386 /* Don't flag it as "accurately an integer" if the number
2387 came from a (by definition imprecise) NV operation, and
2388 we're outside the range of NV integer precision */
2391 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2392 DEBUG_c(PerlIO_printf(Perl_debug_log,
2393 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2399 /* IV not precise. No need to convert from PV, as NV
2400 conversion would already have cached IV if it detected
2401 that PV->IV would be better than PV->NV->IV
2402 flags already correct - don't set public IOK. */
2403 DEBUG_c(PerlIO_printf(Perl_debug_log,
2404 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2409 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2410 but the cast (NV)IV_MIN rounds to a the value less (more
2411 negative) than IV_MIN which happens to be equal to SvNVX ??
2412 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2413 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2414 (NV)UVX == NVX are both true, but the values differ. :-(
2415 Hopefully for 2s complement IV_MIN is something like
2416 0x8000000000000000 which will be exact. NWC */
2419 SvUVX(sv) = U_V(SvNVX(sv));
2421 (SvNVX(sv) == (NV) SvUVX(sv))
2422 #ifndef NV_PRESERVES_UV
2423 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2424 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2425 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2426 /* Don't flag it as "accurately an integer" if the number
2427 came from a (by definition imprecise) NV operation, and
2428 we're outside the range of NV integer precision */
2433 DEBUG_c(PerlIO_printf(Perl_debug_log,
2434 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2440 else if (SvPOKp(sv) && SvLEN(sv)) {
2442 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2444 /* We want to avoid a possible problem when we cache a UV which
2445 may be later translated to an NV, and the resulting NV is not
2446 the translation of the initial data.
2448 This means that if we cache such a UV, we need to cache the
2449 NV as well. Moreover, we trade speed for space, and do not
2450 cache the NV if not needed.
2453 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2454 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2455 == IS_NUMBER_IN_UV) {
2456 /* It's definitely an integer, only upgrade to PVIV */
2457 if (SvTYPE(sv) < SVt_PVIV)
2458 sv_upgrade(sv, SVt_PVIV);
2460 } else if (SvTYPE(sv) < SVt_PVNV)
2461 sv_upgrade(sv, SVt_PVNV);
2463 /* If NV preserves UV then we only use the UV value if we know that
2464 we aren't going to call atof() below. If NVs don't preserve UVs
2465 then the value returned may have more precision than atof() will
2466 return, even though it isn't accurate. */
2467 if ((numtype & (IS_NUMBER_IN_UV
2468 #ifdef NV_PRESERVES_UV
2471 )) == IS_NUMBER_IN_UV) {
2472 /* This won't turn off the public IOK flag if it was set above */
2473 (void)SvIOKp_on(sv);
2475 if (!(numtype & IS_NUMBER_NEG)) {
2477 if (value <= (UV)IV_MAX) {
2478 SvIVX(sv) = (IV)value;
2480 /* it didn't overflow, and it was positive. */
2485 /* 2s complement assumption */
2486 if (value <= (UV)IV_MIN) {
2487 SvIVX(sv) = -(IV)value;
2489 /* Too negative for an IV. This is a double upgrade, but
2490 I'm assuming it will be rare. */
2491 if (SvTYPE(sv) < SVt_PVNV)
2492 sv_upgrade(sv, SVt_PVNV);
2496 SvNVX(sv) = -(NV)value;
2502 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2503 != IS_NUMBER_IN_UV) {
2504 /* It wasn't an integer, or it overflowed the UV. */
2505 SvNVX(sv) = Atof(SvPVX(sv));
2507 if (! numtype && ckWARN(WARN_NUMERIC))
2510 #if defined(USE_LONG_DOUBLE)
2511 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2512 PTR2UV(sv), SvNVX(sv)));
2514 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2515 PTR2UV(sv), SvNVX(sv)));
2518 #ifdef NV_PRESERVES_UV
2519 (void)SvIOKp_on(sv);
2521 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2522 SvIVX(sv) = I_V(SvNVX(sv));
2523 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2526 /* Integer is imprecise. NOK, IOKp */
2528 /* UV will not work better than IV */
2530 if (SvNVX(sv) > (NV)UV_MAX) {
2532 /* Integer is inaccurate. NOK, IOKp, is UV */
2536 SvUVX(sv) = U_V(SvNVX(sv));
2537 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2538 NV preservse UV so can do correct comparison. */
2539 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2543 /* Integer is imprecise. NOK, IOKp, is UV */
2548 #else /* NV_PRESERVES_UV */
2549 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2550 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2551 /* The UV slot will have been set from value returned by
2552 grok_number above. The NV slot has just been set using
2555 assert (SvIOKp(sv));
2557 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2558 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2559 /* Small enough to preserve all bits. */
2560 (void)SvIOKp_on(sv);
2562 SvIVX(sv) = I_V(SvNVX(sv));
2563 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2565 /* Assumption: first non-preserved integer is < IV_MAX,
2566 this NV is in the preserved range, therefore: */
2567 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2569 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs(SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2572 sv_2iuv_non_preserve (sv, numtype);
2574 #endif /* NV_PRESERVES_UV */
2578 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2579 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2582 if (SvTYPE(sv) < SVt_IV)
2583 /* Typically the caller expects that sv_any is not NULL now. */
2584 sv_upgrade(sv, SVt_IV);
2588 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2589 PTR2UV(sv),SvUVX(sv)));
2590 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2596 Return the num value of an SV, doing any necessary string or integer
2597 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2604 Perl_sv_2nv(pTHX_ register SV *sv)
2608 if (SvGMAGICAL(sv)) {
2612 if (SvPOKp(sv) && SvLEN(sv)) {
2613 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2614 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
2616 return Atof(SvPVX(sv));
2620 return (NV)SvUVX(sv);
2622 return (NV)SvIVX(sv);
2625 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2626 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2632 if (SvTHINKFIRST(sv)) {
2635 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2636 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2637 return SvNV(tmpstr);
2638 return PTR2NV(SvRV(sv));
2641 sv_force_normal_flags(sv, 0);
2643 if (SvREADONLY(sv) && !SvOK(sv)) {
2644 if (ckWARN(WARN_UNINITIALIZED))
2649 if (SvTYPE(sv) < SVt_NV) {
2650 if (SvTYPE(sv) == SVt_IV)
2651 sv_upgrade(sv, SVt_PVNV);
2653 sv_upgrade(sv, SVt_NV);
2654 #ifdef USE_LONG_DOUBLE
2656 STORE_NUMERIC_LOCAL_SET_STANDARD();
2657 PerlIO_printf(Perl_debug_log,
2658 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2659 PTR2UV(sv), SvNVX(sv));
2660 RESTORE_NUMERIC_LOCAL();
2664 STORE_NUMERIC_LOCAL_SET_STANDARD();
2665 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2666 PTR2UV(sv), SvNVX(sv));
2667 RESTORE_NUMERIC_LOCAL();
2671 else if (SvTYPE(sv) < SVt_PVNV)
2672 sv_upgrade(sv, SVt_PVNV);
2677 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
2678 #ifdef NV_PRESERVES_UV
2681 /* Only set the public NV OK flag if this NV preserves the IV */
2682 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2683 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2684 : (SvIVX(sv) == I_V(SvNVX(sv))))
2690 else if (SvPOKp(sv) && SvLEN(sv)) {
2692 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2693 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2695 #ifdef NV_PRESERVES_UV
2696 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2697 == IS_NUMBER_IN_UV) {
2698 /* It's definitely an integer */
2699 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
2701 SvNVX(sv) = Atof(SvPVX(sv));
2704 SvNVX(sv) = Atof(SvPVX(sv));
2705 /* Only set the public NV OK flag if this NV preserves the value in
2706 the PV at least as well as an IV/UV would.
2707 Not sure how to do this 100% reliably. */
2708 /* if that shift count is out of range then Configure's test is
2709 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2711 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2712 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2713 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2714 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2715 /* Can't use strtol etc to convert this string, so don't try.
2716 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2719 /* value has been set. It may not be precise. */
2720 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2721 /* 2s complement assumption for (UV)IV_MIN */
2722 SvNOK_on(sv); /* Integer is too negative. */
2727 if (numtype & IS_NUMBER_NEG) {
2728 SvIVX(sv) = -(IV)value;
2729 } else if (value <= (UV)IV_MAX) {
2730 SvIVX(sv) = (IV)value;
2736 if (numtype & IS_NUMBER_NOT_INT) {
2737 /* I believe that even if the original PV had decimals,
2738 they are lost beyond the limit of the FP precision.
2739 However, neither is canonical, so both only get p
2740 flags. NWC, 2000/11/25 */
2741 /* Both already have p flags, so do nothing */
2744 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2745 if (SvIVX(sv) == I_V(nv)) {
2750 /* It had no "." so it must be integer. */
2753 /* between IV_MAX and NV(UV_MAX).
2754 Could be slightly > UV_MAX */
2756 if (numtype & IS_NUMBER_NOT_INT) {
2757 /* UV and NV both imprecise. */
2759 UV nv_as_uv = U_V(nv);
2761 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2772 #endif /* NV_PRESERVES_UV */
2775 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2777 if (SvTYPE(sv) < SVt_NV)
2778 /* Typically the caller expects that sv_any is not NULL now. */
2779 /* XXX Ilya implies that this is a bug in callers that assume this
2780 and ideally should be fixed. */
2781 sv_upgrade(sv, SVt_NV);
2784 #if defined(USE_LONG_DOUBLE)
2786 STORE_NUMERIC_LOCAL_SET_STANDARD();
2787 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2788 PTR2UV(sv), SvNVX(sv));
2789 RESTORE_NUMERIC_LOCAL();
2793 STORE_NUMERIC_LOCAL_SET_STANDARD();
2794 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2795 PTR2UV(sv), SvNVX(sv));
2796 RESTORE_NUMERIC_LOCAL();
2802 /* asIV(): extract an integer from the string value of an SV.
2803 * Caller must validate PVX */
2806 S_asIV(pTHX_ SV *sv)
2809 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2811 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2812 == IS_NUMBER_IN_UV) {
2813 /* It's definitely an integer */
2814 if (numtype & IS_NUMBER_NEG) {
2815 if (value < (UV)IV_MIN)
2818 if (value < (UV)IV_MAX)
2823 if (ckWARN(WARN_NUMERIC))
2826 return I_V(Atof(SvPVX(sv)));
2829 /* asUV(): extract an unsigned integer from the string value of an SV
2830 * Caller must validate PVX */
2833 S_asUV(pTHX_ SV *sv)
2836 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2838 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2839 == IS_NUMBER_IN_UV) {
2840 /* It's definitely an integer */
2841 if (!(numtype & IS_NUMBER_NEG))
2845 if (ckWARN(WARN_NUMERIC))
2848 return U_V(Atof(SvPVX(sv)));
2852 =for apidoc sv_2pv_nolen
2854 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2855 use the macro wrapper C<SvPV_nolen(sv)> instead.
2860 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2863 return sv_2pv(sv, &n_a);
2866 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2867 * UV as a string towards the end of buf, and return pointers to start and
2870 * We assume that buf is at least TYPE_CHARS(UV) long.
2874 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2876 char *ptr = buf + TYPE_CHARS(UV);
2890 *--ptr = '0' + (char)(uv % 10);
2899 =for apidoc sv_2pv_flags
2901 Returns a pointer to the string value of an SV, and sets *lp to its length.
2902 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2904 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2905 usually end up here too.
2911 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2916 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2917 char *tmpbuf = tbuf;
2923 if (SvGMAGICAL(sv)) {
2924 if (flags & SV_GMAGIC)
2932 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2934 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2939 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2944 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2945 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2952 if (SvTHINKFIRST(sv)) {
2955 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2956 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2957 char *pv = SvPV(tmpstr, *lp);
2971 switch (SvTYPE(sv)) {
2973 if ( ((SvFLAGS(sv) &
2974 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2975 == (SVs_OBJECT|SVs_RMG))
2976 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2977 regexp *re = (regexp *)mg->mg_obj;
2980 char *fptr = "msix";
2985 char need_newline = 0;
2986 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2988 while((ch = *fptr++)) {
2990 reflags[left++] = ch;
2993 reflags[right--] = ch;
2998 reflags[left] = '-';
3002 mg->mg_len = re->prelen + 4 + left;
3004 * If /x was used, we have to worry about a regex
3005 * ending with a comment later being embedded
3006 * within another regex. If so, we don't want this
3007 * regex's "commentization" to leak out to the
3008 * right part of the enclosing regex, we must cap
3009 * it with a newline.
3011 * So, if /x was used, we scan backwards from the
3012 * end of the regex. If we find a '#' before we
3013 * find a newline, we need to add a newline
3014 * ourself. If we find a '\n' first (or if we
3015 * don't find '#' or '\n'), we don't need to add
3016 * anything. -jfriedl
3018 if (PMf_EXTENDED & re->reganch)
3020 char *endptr = re->precomp + re->prelen;
3021 while (endptr >= re->precomp)
3023 char c = *(endptr--);
3025 break; /* don't need another */
3027 /* we end while in a comment, so we
3029 mg->mg_len++; /* save space for it */
3030 need_newline = 1; /* note to add it */
3036 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3037 Copy("(?", mg->mg_ptr, 2, char);
3038 Copy(reflags, mg->mg_ptr+2, left, char);
3039 Copy(":", mg->mg_ptr+left+2, 1, char);
3040 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3042 mg->mg_ptr[mg->mg_len - 2] = '\n';
3043 mg->mg_ptr[mg->mg_len - 1] = ')';
3044 mg->mg_ptr[mg->mg_len] = 0;
3046 PL_reginterp_cnt += re->program[0].next_off;
3048 if (re->reganch & ROPT_UTF8)
3063 case SVt_PVBM: if (SvROK(sv))
3066 s = "SCALAR"; break;
3067 case SVt_PVLV: s = "LVALUE"; break;
3068 case SVt_PVAV: s = "ARRAY"; break;
3069 case SVt_PVHV: s = "HASH"; break;
3070 case SVt_PVCV: s = "CODE"; break;
3071 case SVt_PVGV: s = "GLOB"; break;
3072 case SVt_PVFM: s = "FORMAT"; break;
3073 case SVt_PVIO: s = "IO"; break;
3074 default: s = "UNKNOWN"; break;
3078 Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
3081 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3087 if (SvREADONLY(sv) && !SvOK(sv)) {
3088 if (ckWARN(WARN_UNINITIALIZED))
3094 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3095 /* I'm assuming that if both IV and NV are equally valid then
3096 converting the IV is going to be more efficient */
3097 U32 isIOK = SvIOK(sv);
3098 U32 isUIOK = SvIsUV(sv);
3099 char buf[TYPE_CHARS(UV)];
3102 if (SvTYPE(sv) < SVt_PVIV)
3103 sv_upgrade(sv, SVt_PVIV);
3105 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3107 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3108 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3109 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3110 SvCUR_set(sv, ebuf - ptr);
3120 else if (SvNOKp(sv)) {
3121 if (SvTYPE(sv) < SVt_PVNV)
3122 sv_upgrade(sv, SVt_PVNV);
3123 /* The +20 is pure guesswork. Configure test needed. --jhi */
3124 SvGROW(sv, NV_DIG + 20);
3126 olderrno = errno; /* some Xenix systems wipe out errno here */
3128 if (SvNVX(sv) == 0.0)
3129 (void)strcpy(s,"0");
3133 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3136 #ifdef FIXNEGATIVEZERO
3137 if (*s == '-' && s[1] == '0' && !s[2])
3147 if (ckWARN(WARN_UNINITIALIZED)
3148 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3151 if (SvTYPE(sv) < SVt_PV)
3152 /* Typically the caller expects that sv_any is not NULL now. */
3153 sv_upgrade(sv, SVt_PV);
3156 *lp = s - SvPVX(sv);
3159 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3160 PTR2UV(sv),SvPVX(sv)));
3164 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3165 /* Sneaky stuff here */
3169 tsv = newSVpv(tmpbuf, 0);
3185 len = strlen(tmpbuf);
3187 #ifdef FIXNEGATIVEZERO
3188 if (len == 2 && t[0] == '-' && t[1] == '0') {
3193 (void)SvUPGRADE(sv, SVt_PV);
3195 s = SvGROW(sv, len + 1);
3204 =for apidoc sv_copypv
3206 Copies a stringified representation of the source SV into the
3207 destination SV. Automatically performs any necessary mg_get and
3208 coercion of numeric values into strings. Guaranteed to preserve
3209 UTF-8 flag even from overloaded objects. Similar in nature to
3210 sv_2pv[_flags] but operates directly on an SV instead of just the
3211 string. Mostly uses sv_2pv_flags to do its work, except when that
3212 would lose the UTF-8'ness of the PV.
3218 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3223 sv_setpvn(dsv,s,len);
3231 =for apidoc sv_2pvbyte_nolen
3233 Return a pointer to the byte-encoded representation of the SV.
3234 May cause the SV to be downgraded from UTF8 as a side-effect.
3236 Usually accessed via the C<SvPVbyte_nolen> macro.
3242 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3245 return sv_2pvbyte(sv, &n_a);
3249 =for apidoc sv_2pvbyte
3251 Return a pointer to the byte-encoded representation of the SV, and set *lp
3252 to its length. May cause the SV to be downgraded from UTF8 as a
3255 Usually accessed via the C<SvPVbyte> macro.
3261 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3263 sv_utf8_downgrade(sv,0);
3264 return SvPV(sv,*lp);
3268 =for apidoc sv_2pvutf8_nolen
3270 Return a pointer to the UTF8-encoded representation of the SV.
3271 May cause the SV to be upgraded to UTF8 as a side-effect.
3273 Usually accessed via the C<SvPVutf8_nolen> macro.
3279 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3282 return sv_2pvutf8(sv, &n_a);
3286 =for apidoc sv_2pvutf8
3288 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3289 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3291 Usually accessed via the C<SvPVutf8> macro.
3297 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3299 sv_utf8_upgrade(sv);
3300 return SvPV(sv,*lp);
3304 =for apidoc sv_2bool
3306 This function is only called on magical items, and is only used by
3307 sv_true() or its macro equivalent.
3313 Perl_sv_2bool(pTHX_ register SV *sv)
3322 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3323 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3324 return (bool)SvTRUE(tmpsv);
3325 return SvRV(sv) != 0;
3328 register XPV* Xpvtmp;
3329 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3330 (*Xpvtmp->xpv_pv > '0' ||
3331 Xpvtmp->xpv_cur > 1 ||
3332 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3339 return SvIVX(sv) != 0;
3342 return SvNVX(sv) != 0.0;
3350 =for apidoc sv_utf8_upgrade
3352 Convert the PV of an SV to its UTF8-encoded form.
3353 Forces the SV to string form if it is not already.
3354 Always sets the SvUTF8 flag to avoid future validity checks even
3355 if all the bytes have hibit clear.
3357 This is not as a general purpose byte encoding to Unicode interface:
3358 use the Encode extension for that.
3360 =for apidoc sv_utf8_upgrade_flags
3362 Convert the PV of an SV to its UTF8-encoded form.
3363 Forces the SV to string form if it is not already.
3364 Always sets the SvUTF8 flag to avoid future validity checks even
3365 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3366 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3367 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3369 This is not as a general purpose byte encoding to Unicode interface:
3370 use the Encode extension for that.
3376 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3386 (void) sv_2pv_flags(sv,&len, flags);
3395 sv_force_normal_flags(sv, 0);
3398 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3399 sv_recode_to_utf8(sv, PL_encoding);
3400 else { /* Assume Latin-1/EBCDIC */
3401 /* This function could be much more efficient if we
3402 * had a FLAG in SVs to signal if there are any hibit
3403 * chars in the PV. Given that there isn't such a flag
3404 * make the loop as fast as possible. */
3405 s = (U8 *) SvPVX(sv);
3406 e = (U8 *) SvEND(sv);
3410 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3416 len = SvCUR(sv) + 1; /* Plus the \0 */
3417 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3418 SvCUR(sv) = len - 1;
3420 Safefree(s); /* No longer using what was there before. */
3421 SvLEN(sv) = len; /* No longer know the real size. */
3423 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3430 =for apidoc sv_utf8_downgrade
3432 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3433 This may not be possible if the PV contains non-byte encoding characters;
3434 if this is the case, either returns false or, if C<fail_ok> is not
3437 This is not as a general purpose Unicode to byte encoding interface:
3438 use the Encode extension for that.
3444 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3446 if (SvPOK(sv) && SvUTF8(sv)) {
3452 sv_force_normal_flags(sv, 0);
3454 s = (U8 *) SvPV(sv, len);
3455 if (!utf8_to_bytes(s, &len)) {
3460 Perl_croak(aTHX_ "Wide character in %s",
3463 Perl_croak(aTHX_ "Wide character");
3474 =for apidoc sv_utf8_encode
3476 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3477 flag so that it looks like octets again. Used as a building block
3478 for encode_utf8 in Encode.xs
3484 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3486 (void) sv_utf8_upgrade(sv);
3491 =for apidoc sv_utf8_decode
3493 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3494 turn off SvUTF8 if needed so that we see characters. Used as a building block
3495 for decode_utf8 in Encode.xs
3501 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3507 /* The octets may have got themselves encoded - get them back as
3510 if (!sv_utf8_downgrade(sv, TRUE))
3513 /* it is actually just a matter of turning the utf8 flag on, but
3514 * we want to make sure everything inside is valid utf8 first.
3516 c = (U8 *) SvPVX(sv);
3517 if (!is_utf8_string(c, SvCUR(sv)+1))
3519 e = (U8 *) SvEND(sv);
3522 if (!UTF8_IS_INVARIANT(ch)) {
3532 =for apidoc sv_setsv
3534 Copies the contents of the source SV C<ssv> into the destination SV
3535 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3536 function if the source SV needs to be reused. Does not handle 'set' magic.
3537 Loosely speaking, it performs a copy-by-value, obliterating any previous
3538 content of the destination.
3540 You probably want to use one of the assortment of wrappers, such as
3541 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3542 C<SvSetMagicSV_nosteal>.
3544 =for apidoc sv_setsv_flags
3546 Copies the contents of the source SV C<ssv> into the destination SV
3547 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3548 function if the source SV needs to be reused. Does not handle 'set' magic.
3549 Loosely speaking, it performs a copy-by-value, obliterating any previous
3550 content of the destination.
3551 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3552 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3553 implemented in terms of this function.
3555 You probably want to use one of the assortment of wrappers, such as
3556 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3557 C<SvSetMagicSV_nosteal>.
3559 This is the primary function for copying scalars, and most other
3560 copy-ish functions and macros use this underneath.
3566 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3568 register U32 sflags;
3574 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3576 sstr = &PL_sv_undef;
3577 stype = SvTYPE(sstr);
3578 dtype = SvTYPE(dstr);
3583 /* need to nuke the magic */
3585 SvRMAGICAL_off(dstr);
3588 /* There's a lot of redundancy below but we're going for speed here */
3593 if (dtype != SVt_PVGV) {
3594 (void)SvOK_off(dstr);
3602 sv_upgrade(dstr, SVt_IV);
3605 sv_upgrade(dstr, SVt_PVNV);
3609 sv_upgrade(dstr, SVt_PVIV);
3612 (void)SvIOK_only(dstr);
3613 SvIVX(dstr) = SvIVX(sstr);
3616 if (SvTAINTED(sstr))
3627 sv_upgrade(dstr, SVt_NV);
3632 sv_upgrade(dstr, SVt_PVNV);
3635 SvNVX(dstr) = SvNVX(sstr);
3636 (void)SvNOK_only(dstr);
3637 if (SvTAINTED(sstr))
3645 sv_upgrade(dstr, SVt_RV);
3646 else if (dtype == SVt_PVGV &&
3647 SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3650 if (GvIMPORTED(dstr) != GVf_IMPORTED
3651 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3653 GvIMPORTED_on(dstr);
3664 sv_upgrade(dstr, SVt_PV);
3667 if (dtype < SVt_PVIV)
3668 sv_upgrade(dstr, SVt_PVIV);
3671 if (dtype < SVt_PVNV)
3672 sv_upgrade(dstr, SVt_PVNV);
3679 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
3682 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
3686 if (dtype <= SVt_PVGV) {
3688 if (dtype != SVt_PVGV) {
3689 char *name = GvNAME(sstr);
3690 STRLEN len = GvNAMELEN(sstr);
3691 sv_upgrade(dstr, SVt_PVGV);
3692 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3693 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3694 GvNAME(dstr) = savepvn(name, len);
3695 GvNAMELEN(dstr) = len;
3696 SvFAKE_on(dstr); /* can coerce to non-glob */
3698 /* ahem, death to those who redefine active sort subs */
3699 else if (PL_curstackinfo->si_type == PERLSI_SORT
3700 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3701 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3704 #ifdef GV_UNIQUE_CHECK
3705 if (GvUNIQUE((GV*)dstr)) {
3706 Perl_croak(aTHX_ PL_no_modify);
3710 (void)SvOK_off(dstr);
3711 GvINTRO_off(dstr); /* one-shot flag */
3713 GvGP(dstr) = gp_ref(GvGP(sstr));
3714 if (SvTAINTED(sstr))
3716 if (GvIMPORTED(dstr) != GVf_IMPORTED
3717 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3719 GvIMPORTED_on(dstr);
3727 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3729 if ((int)SvTYPE(sstr) != stype) {
3730 stype = SvTYPE(sstr);
3731 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3735 if (stype == SVt_PVLV)
3736 (void)SvUPGRADE(dstr, SVt_PVNV);
3738 (void)SvUPGRADE(dstr, (U32)stype);
3741 sflags = SvFLAGS(sstr);
3743 if (sflags & SVf_ROK) {
3744 if (dtype >= SVt_PV) {
3745 if (dtype == SVt_PVGV) {
3746 SV *sref = SvREFCNT_inc(SvRV(sstr));
3748 int intro = GvINTRO(dstr);
3750 #ifdef GV_UNIQUE_CHECK
3751 if (GvUNIQUE((GV*)dstr)) {
3752 Perl_croak(aTHX_ PL_no_modify);
3757 GvINTRO_off(dstr); /* one-shot flag */
3758 GvLINE(dstr) = CopLINE(PL_curcop);
3759 GvEGV(dstr) = (GV*)dstr;
3762 switch (SvTYPE(sref)) {
3765 SAVEGENERICSV(GvAV(dstr));
3767 dref = (SV*)GvAV(dstr);
3768 GvAV(dstr) = (AV*)sref;
3769 if (!GvIMPORTED_AV(dstr)
3770 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3772 GvIMPORTED_AV_on(dstr);
3777 SAVEGENERICSV(GvHV(dstr));
3779 dref = (SV*)GvHV(dstr);
3780 GvHV(dstr) = (HV*)sref;
3781 if (!GvIMPORTED_HV(dstr)
3782 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3784 GvIMPORTED_HV_on(dstr);
3789 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3790 SvREFCNT_dec(GvCV(dstr));
3791 GvCV(dstr) = Nullcv;
3792 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3793 PL_sub_generation++;
3795 SAVEGENERICSV(GvCV(dstr));
3798 dref = (SV*)GvCV(dstr);
3799 if (GvCV(dstr) != (CV*)sref) {
3800 CV* cv = GvCV(dstr);
3802 if (!GvCVGEN((GV*)dstr) &&
3803 (CvROOT(cv) || CvXSUB(cv)))
3805 /* ahem, death to those who redefine
3806 * active sort subs */
3807 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3808 PL_sortcop == CvSTART(cv))
3810 "Can't redefine active sort subroutine %s",
3811 GvENAME((GV*)dstr));
3812 /* Redefining a sub - warning is mandatory if
3813 it was a const and its value changed. */
3814 if (ckWARN(WARN_REDEFINE)
3816 && (!CvCONST((CV*)sref)
3817 || sv_cmp(cv_const_sv(cv),
3818 cv_const_sv((CV*)sref)))))
3820 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3822 ? "Constant subroutine %s::%s redefined"
3823 : "Subroutine %s::%s redefined",
3824 HvNAME(GvSTASH((GV*)dstr)),
3825 GvENAME((GV*)dstr));
3829 cv_ckproto(cv, (GV*)dstr,
3830 SvPOK(sref) ? SvPVX(sref) : Nullch);
3832 GvCV(dstr) = (CV*)sref;
3833 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3834 GvASSUMECV_on(dstr);
3835 PL_sub_generation++;
3837 if (!GvIMPORTED_CV(dstr)
3838 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3840 GvIMPORTED_CV_on(dstr);
3845 SAVEGENERICSV(GvIOp(dstr));
3847 dref = (SV*)GvIOp(dstr);
3848 GvIOp(dstr) = (IO*)sref;
3852 SAVEGENERICSV(GvFORM(dstr));
3854 dref = (SV*)GvFORM(dstr);
3855 GvFORM(dstr) = (CV*)sref;
3859 SAVEGENERICSV(GvSV(dstr));
3861 dref = (SV*)GvSV(dstr);
3863 if (!GvIMPORTED_SV(dstr)
3864 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3866 GvIMPORTED_SV_on(dstr);
3872 if (SvTAINTED(sstr))
3877 (void)SvOOK_off(dstr); /* backoff */
3879 Safefree(SvPVX(dstr));
3880 SvLEN(dstr)=SvCUR(dstr)=0;
3883 (void)SvOK_off(dstr);
3884 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
3886 if (sflags & SVp_NOK) {
3888 /* Only set the public OK flag if the source has public OK. */
3889 if (sflags & SVf_NOK)
3890 SvFLAGS(dstr) |= SVf_NOK;
3891 SvNVX(dstr) = SvNVX(sstr);
3893 if (sflags & SVp_IOK) {
3894 (void)SvIOKp_on(dstr);
3895 if (sflags & SVf_IOK)
3896 SvFLAGS(dstr) |= SVf_IOK;
3897 if (sflags & SVf_IVisUV)
3899 SvIVX(dstr) = SvIVX(sstr);
3901 if (SvAMAGIC(sstr)) {
3905 else if (sflags & SVp_POK) {
3909 * Check to see if we can just swipe the string. If so, it's a
3910 * possible small lose on short strings, but a big win on long ones.
3911 * It might even be a win on short strings if SvPVX(dstr)
3912 * has to be allocated and SvPVX(sstr) has to be freed.
3916 #ifdef PERL_COPY_ON_WRITE
3917 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3921 (sflags & SVs_TEMP) && /* slated for free anyway? */
3922 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3923 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3924 SvLEN(sstr) && /* and really is a string */
3925 /* and won't be needed again, potentially */
3926 !(PL_op && PL_op->op_type == OP_AASSIGN))
3927 #ifdef PERL_COPY_ON_WRITE
3928 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3929 && SvTYPE(sstr) >= SVt_PVIV)
3932 /* Failed the swipe test, and it's not a shared hash key either.
3933 Have to copy the string. */
3934 STRLEN len = SvCUR(sstr);
3935 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3936 Move(SvPVX(sstr),SvPVX(dstr),len,char);
3937 SvCUR_set(dstr, len);
3938 *SvEND(dstr) = '\0';
3939 (void)SvPOK_only(dstr);
3941 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
3943 #ifdef PERL_COPY_ON_WRITE
3944 /* Either it's a shared hash key, or it's suitable for
3945 copy-on-write or we can swipe the string. */
3947 PerlIO_printf(Perl_debug_log,
3948 "Copy on write: sstr --> dstr\n");
3953 /* I believe I should acquire a global SV mutex if
3954 it's a COW sv (not a shared hash key) to stop
3955 it going un copy-on-write.
3956 If the source SV has gone un copy on write between up there
3957 and down here, then (assert() that) it is of the correct
3958 form to make it copy on write again */
3959 if ((sflags & (SVf_FAKE | SVf_READONLY))
3960 != (SVf_FAKE | SVf_READONLY)) {
3961 SvREADONLY_on(sstr);
3963 /* Make the source SV into a loop of 1.
3964 (about to become 2) */
3965 SV_COW_NEXT_SV_SET(sstr, sstr);
3969 /* Initial code is common. */
3970 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
3972 SvFLAGS(dstr) &= ~SVf_OOK;
3973 Safefree(SvPVX(dstr) - SvIVX(dstr));
3975 else if (SvLEN(dstr))
3976 Safefree(SvPVX(dstr));
3978 (void)SvPOK_only(dstr);
3980 #ifdef PERL_COPY_ON_WRITE
3982 /* making another shared SV. */
3983 STRLEN cur = SvCUR(sstr);
3984 STRLEN len = SvLEN(sstr);
3986 /* SvIsCOW_normal */
3987 /* splice us in between source and next-after-source. */
3988 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3989 SV_COW_NEXT_SV_SET(sstr, dstr);
3990 SvPV_set(dstr, SvPVX(sstr));
3992 /* SvIsCOW_shared_hash */
3993 UV hash = SvUVX(sstr);
3994 DEBUG_C(PerlIO_printf(Perl_debug_log,
3995 "Copy on write: Sharing hash\n"));
3997 sharepvn(SvPVX(sstr),
3998 (sflags & SVf_UTF8?-cur:cur), hash));
4003 SvREADONLY_on(dstr);
4005 /* Relesase a global SV mutex. */
4009 { /* Passes the swipe test. */
4010 SvPV_set(dstr, SvPVX(sstr));
4011 SvLEN_set(dstr, SvLEN(sstr));
4012 SvCUR_set(dstr, SvCUR(sstr));
4015 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4016 SvPV_set(sstr, Nullch);
4022 if (sflags & SVf_UTF8)
4025 if (sflags & SVp_NOK) {
4027 if (sflags & SVf_NOK)
4028 SvFLAGS(dstr) |= SVf_NOK;
4029 SvNVX(dstr) = SvNVX(sstr);
4031 if (sflags & SVp_IOK) {
4032 (void)SvIOKp_on(dstr);
4033 if (sflags & SVf_IOK)
4034 SvFLAGS(dstr) |= SVf_IOK;
4035 if (sflags & SVf_IVisUV)
4037 SvIVX(dstr) = SvIVX(sstr);
4040 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4041 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4042 smg->mg_ptr, smg->mg_len);
4043 SvRMAGICAL_on(dstr);
4046 else if (sflags & SVp_IOK) {
4047 if (sflags & SVf_IOK)
4048 (void)SvIOK_only(dstr);
4050 (void)SvOK_off(dstr);
4051 (void)SvIOKp_on(dstr);
4053 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4054 if (sflags & SVf_IVisUV)
4056 SvIVX(dstr) = SvIVX(sstr);
4057 if (sflags & SVp_NOK) {
4058 if (sflags & SVf_NOK)
4059 (void)SvNOK_on(dstr);
4061 (void)SvNOKp_on(dstr);
4062 SvNVX(dstr) = SvNVX(sstr);
4065 else if (sflags & SVp_NOK) {
4066 if (sflags & SVf_NOK)
4067 (void)SvNOK_only(dstr);
4069 (void)SvOK_off(dstr);
4072 SvNVX(dstr) = SvNVX(sstr);
4075 if (dtype == SVt_PVGV) {
4076 if (ckWARN(WARN_MISC))
4077 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4080 (void)SvOK_off(dstr);
4082 if (SvTAINTED(sstr))
4087 =for apidoc sv_setsv_mg
4089 Like C<sv_setsv>, but also handles 'set' magic.
4095 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4097 sv_setsv(dstr,sstr);
4102 =for apidoc sv_setpvn
4104 Copies a string into an SV. The C<len> parameter indicates the number of
4105 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4111 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4113 register char *dptr;
4115 SV_CHECK_THINKFIRST_COW_DROP(sv);
4121 /* len is STRLEN which is unsigned, need to copy to signed */
4124 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4126 (void)SvUPGRADE(sv, SVt_PV);
4128 SvGROW(sv, len + 1);
4130 Move(ptr,dptr,len,char);
4133 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4138 =for apidoc sv_setpvn_mg
4140 Like C<sv_setpvn>, but also handles 'set' magic.
4146 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4148 sv_setpvn(sv,ptr,len);
4153 =for apidoc sv_setpv
4155 Copies a string into an SV. The string must be null-terminated. Does not
4156 handle 'set' magic. See C<sv_setpv_mg>.
4162 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4164 register STRLEN len;
4166 SV_CHECK_THINKFIRST_COW_DROP(sv);
4172 (void)SvUPGRADE(sv, SVt_PV);
4174 SvGROW(sv, len + 1);
4175 Move(ptr,SvPVX(sv),len+1,char);
4177 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4182 =for apidoc sv_setpv_mg
4184 Like C<sv_setpv>, but also handles 'set' magic.
4190 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4197 =for apidoc sv_usepvn
4199 Tells an SV to use C<ptr> to find its string value. Normally the string is
4200 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4201 The C<ptr> should point to memory that was allocated by C<malloc>. The
4202 string length, C<len>, must be supplied. This function will realloc the
4203 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4204 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4205 See C<sv_usepvn_mg>.
4211 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4213 SV_CHECK_THINKFIRST_COW_DROP(sv);
4214 (void)SvUPGRADE(sv, SVt_PV);
4219 (void)SvOOK_off(sv);
4220 if (SvPVX(sv) && SvLEN(sv))
4221 Safefree(SvPVX(sv));
4222 Renew(ptr, len+1, char);
4225 SvLEN_set(sv, len+1);
4227 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4232 =for apidoc sv_usepvn_mg
4234 Like C<sv_usepvn>, but also handles 'set' magic.
4240 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4242 sv_usepvn(sv,ptr,len);
4246 #ifdef PERL_COPY_ON_WRITE
4247 /* Need to do this *after* making the SV normal, as we need the buffer
4248 pointer to remain valid until after we've copied it. If we let go too early,
4249 another thread could invalidate it by unsharing last of the same hash key
4250 (which it can do by means other than releasing copy-on-write Svs)
4251 or by changing the other copy-on-write SVs in the loop. */
4253 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4254 U32 hash, SV *after)
4256 if (len) { /* this SV was SvIsCOW_normal(sv) */
4257 /* we need to find the SV pointing to us. */
4258 SV *current = SV_COW_NEXT_SV(after);
4260 if (current == sv) {
4261 /* The SV we point to points back to us (there were only two of us
4263 Hence other SV is no longer copy on write either. */
4265 SvREADONLY_off(after);
4267 /* We need to follow the pointers around the loop. */
4269 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4272 /* don't loop forever if the structure is bust, and we have
4273 a pointer into a closed loop. */
4274 assert (current != after);
4275 assert (SvPVX(current) == pvx);
4277 /* Make the SV before us point to the SV after us. */
4278 SV_COW_NEXT_SV_SET(current, after);
4281 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4286 Perl_sv_release_IVX(pTHX_ register SV *sv)
4289 sv_force_normal_flags(sv, 0);
4290 return SvOOK_off(sv);
4294 =for apidoc sv_force_normal_flags
4296 Undo various types of fakery on an SV: if the PV is a shared string, make
4297 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4298 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4299 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4300 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4301 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4302 set to some other value. In addtion, the C<flags> parameter gets passed to
4303 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4304 with flags set to 0.
4310 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4312 #ifdef PERL_COPY_ON_WRITE
4313 if (SvREADONLY(sv)) {
4314 /* At this point I believe I should acquire a global SV mutex. */
4316 char *pvx = SvPVX(sv);
4317 STRLEN len = SvLEN(sv);
4318 STRLEN cur = SvCUR(sv);
4319 U32 hash = SvUVX(sv);
4320 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4322 PerlIO_printf(Perl_debug_log,
4323 "Copy on write: Force normal %ld\n",
4329 /* This SV doesn't own the buffer, so need to New() a new one: */
4332 if (flags & SV_COW_DROP_PV) {
4333 /* OK, so we don't need to copy our buffer. */
4336 SvGROW(sv, cur + 1);
4337 Move(pvx,SvPVX(sv),cur,char);
4341 sv_release_COW(sv, pvx, cur, len, hash, next);
4346 else if (PL_curcop != &PL_compiling)
4347 Perl_croak(aTHX_ PL_no_modify);
4348 /* At this point I believe that I can drop the global SV mutex. */
4351 if (SvREADONLY(sv)) {
4353 char *pvx = SvPVX(sv);
4354 STRLEN len = SvCUR(sv);
4355 U32 hash = SvUVX(sv);
4356 SvGROW(sv, len + 1);
4357 Move(pvx,SvPVX(sv),len,char);
4361 unsharepvn(pvx, SvUTF8(sv) ? -(I32)len : len, hash);
4363 else if (PL_curcop != &PL_compiling)
4364 Perl_croak(aTHX_ PL_no_modify);
4368 sv_unref_flags(sv, flags);
4369 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4374 =for apidoc sv_force_normal
4376 Undo various types of fakery on an SV: if the PV is a shared string, make
4377 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4378 an xpvmg. See also C<sv_force_normal_flags>.
4384 Perl_sv_force_normal(pTHX_ register SV *sv)
4386 sv_force_normal_flags(sv, 0);
4392 Efficient removal of characters from the beginning of the string buffer.
4393 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4394 the string buffer. The C<ptr> becomes the first character of the adjusted
4395 string. Uses the "OOK hack".
4401 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
4403 register STRLEN delta;
4405 if (!ptr || !SvPOKp(sv))
4407 SV_CHECK_THINKFIRST(sv);
4408 if (SvTYPE(sv) < SVt_PVIV)
4409 sv_upgrade(sv,SVt_PVIV);
4412 if (!SvLEN(sv)) { /* make copy of shared string */
4413 char *pvx = SvPVX(sv);
4414 STRLEN len = SvCUR(sv);
4415 SvGROW(sv, len + 1);
4416 Move(pvx,SvPVX(sv),len,char);
4420 SvFLAGS(sv) |= SVf_OOK;
4422 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVp_IOK|SVp_NOK|SVf_IVisUV);
4423 delta = ptr - SvPVX(sv);
4431 =for apidoc sv_catpvn
4433 Concatenates the string onto the end of the string which is in the SV. The
4434 C<len> indicates number of bytes to copy. If the SV has the UTF8
4435 status set, then the bytes appended should be valid UTF8.
4436 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4438 =for apidoc sv_catpvn_flags
4440 Concatenates the string onto the end of the string which is in the SV. The
4441 C<len> indicates number of bytes to copy. If the SV has the UTF8
4442 status set, then the bytes appended should be valid UTF8.
4443 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4444 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4445 in terms of this function.
4451 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4456 dstr = SvPV_force_flags(dsv, dlen, flags);
4457 SvGROW(dsv, dlen + slen + 1);
4460 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4463 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4468 =for apidoc sv_catpvn_mg
4470 Like C<sv_catpvn>, but also handles 'set' magic.
4476 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4478 sv_catpvn(sv,ptr,len);
4483 =for apidoc sv_catsv
4485 Concatenates the string from SV C<ssv> onto the end of the string in
4486 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4487 not 'set' magic. See C<sv_catsv_mg>.
4489 =for apidoc sv_catsv_flags
4491 Concatenates the string from SV C<ssv> onto the end of the string in
4492 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4493 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4494 and C<sv_catsv_nomg> are implemented in terms of this function.
4499 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4505 if ((spv = SvPV(ssv, slen))) {
4506 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4507 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4508 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4509 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4510 dsv->sv_flags doesn't have that bit set.
4511 Andy Dougherty 12 Oct 2001
4513 I32 sutf8 = DO_UTF8(ssv);
4516 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4518 dutf8 = DO_UTF8(dsv);
4520 if (dutf8 != sutf8) {
4522 /* Not modifying source SV, so taking a temporary copy. */
4523 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4525 sv_utf8_upgrade(csv);
4526 spv = SvPV(csv, slen);
4529 sv_utf8_upgrade_nomg(dsv);
4531 sv_catpvn_nomg(dsv, spv, slen);
4536 =for apidoc sv_catsv_mg
4538 Like C<sv_catsv>, but also handles 'set' magic.
4544 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4551 =for apidoc sv_catpv
4553 Concatenates the string onto the end of the string which is in the SV.
4554 If the SV has the UTF8 status set, then the bytes appended should be
4555 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4560 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4562 register STRLEN len;
4568 junk = SvPV_force(sv, tlen);
4570 SvGROW(sv, tlen + len + 1);
4573 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4575 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4580 =for apidoc sv_catpv_mg
4582 Like C<sv_catpv>, but also handles 'set' magic.
4588 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4597 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4598 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4605 Perl_newSV(pTHX_ STRLEN len)
4611 sv_upgrade(sv, SVt_PV);
4612 SvGROW(sv, len + 1);
4617 =for apidoc sv_magicext
4619 Adds magic to an SV, upgrading it if necessary. Applies the
4620 supplied vtable and returns pointer to the magic added.
4622 Note that sv_magicext will allow things that sv_magic will not.
4623 In particular you can add magic to SvREADONLY SVs and and more than
4624 one instance of the same 'how'
4626 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4627 if C<namelen> is zero then C<name> is stored as-is and - as another special
4628 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4629 an C<SV*> and has its REFCNT incremented
4631 (This is now used as a subroutine by sv_magic.)
4636 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4637 const char* name, I32 namlen)
4641 if (SvTYPE(sv) < SVt_PVMG) {
4642 (void)SvUPGRADE(sv, SVt_PVMG);
4644 Newz(702,mg, 1, MAGIC);
4645 mg->mg_moremagic = SvMAGIC(sv);
4648 /* Some magic sontains a reference loop, where the sv and object refer to
4649 each other. To prevent a reference loop that would prevent such
4650 objects being freed, we look for such loops and if we find one we
4651 avoid incrementing the object refcount.
4653 Note we cannot do this to avoid self-tie loops as intervening RV must
4654 have its REFCNT incremented to keep it in existence.
4657 if (!obj || obj == sv ||
4658 how == PERL_MAGIC_arylen ||
4659 how == PERL_MAGIC_qr ||
4660 (SvTYPE(obj) == SVt_PVGV &&
4661 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4662 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4663 GvFORM(obj) == (CV*)sv)))
4668 mg->mg_obj = SvREFCNT_inc(obj);
4669 mg->mg_flags |= MGf_REFCOUNTED;
4672 /* Normal self-ties simply pass a null object, and instead of
4673 using mg_obj directly, use the SvTIED_obj macro to produce a
4674 new RV as needed. For glob "self-ties", we are tieing the PVIO
4675 with an RV obj pointing to the glob containing the PVIO. In
4676 this case, to avoid a reference loop, we need to weaken the
4680 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4681 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4687 mg->mg_len = namlen;
4690 mg->mg_ptr = savepvn(name, namlen);
4691 else if (namlen == HEf_SVKEY)
4692 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4694 mg->mg_ptr = (char *) name;
4696 mg->mg_virtual = vtable;
4700 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4705 =for apidoc sv_magic
4707 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4708 then adds a new magic item of type C<how> to the head of the magic list.
4714 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4719 #ifdef PERL_COPY_ON_WRITE
4721 sv_force_normal_flags(sv, 0);
4723 if (SvREADONLY(sv)) {
4724 if (PL_curcop != &PL_compiling
4725 && how != PERL_MAGIC_regex_global
4726 && how != PERL_MAGIC_bm
4727 && how != PERL_MAGIC_fm
4728 && how != PERL_MAGIC_sv
4731 Perl_croak(aTHX_ PL_no_modify);
4734 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4735 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4736 /* sv_magic() refuses to add a magic of the same 'how' as an
4739 if (how == PERL_MAGIC_taint)
4747 vtable = &PL_vtbl_sv;
4749 case PERL_MAGIC_overload:
4750 vtable = &PL_vtbl_amagic;
4752 case PERL_MAGIC_overload_elem:
4753 vtable = &PL_vtbl_amagicelem;
4755 case PERL_MAGIC_overload_table:
4756 vtable = &PL_vtbl_ovrld;
4759 vtable = &PL_vtbl_bm;
4761 case PERL_MAGIC_regdata:
4762 vtable = &PL_vtbl_regdata;
4764 case PERL_MAGIC_regdatum:
4765 vtable = &PL_vtbl_regdatum;
4767 case PERL_MAGIC_env:
4768 vtable = &PL_vtbl_env;
4771 vtable = &PL_vtbl_fm;
4773 case PERL_MAGIC_envelem:
4774 vtable = &PL_vtbl_envelem;
4776 case PERL_MAGIC_regex_global:
4777 vtable = &PL_vtbl_mglob;
4779 case PERL_MAGIC_isa:
4780 vtable = &PL_vtbl_isa;
4782 case PERL_MAGIC_isaelem:
4783 vtable = &PL_vtbl_isaelem;
4785 case PERL_MAGIC_nkeys:
4786 vtable = &PL_vtbl_nkeys;
4788 case PERL_MAGIC_dbfile:
4791 case PERL_MAGIC_dbline:
4792 vtable = &PL_vtbl_dbline;
4794 #ifdef USE_LOCALE_COLLATE
4795 case PERL_MAGIC_collxfrm:
4796 vtable = &PL_vtbl_collxfrm;
4798 #endif /* USE_LOCALE_COLLATE */
4799 case PERL_MAGIC_tied:
4800 vtable = &PL_vtbl_pack;
4802 case PERL_MAGIC_tiedelem:
4803 case PERL_MAGIC_tiedscalar:
4804 vtable = &PL_vtbl_packelem;
4807 vtable = &PL_vtbl_regexp;
4809 case PERL_MAGIC_sig:
4810 vtable = &PL_vtbl_sig;
4812 case PERL_MAGIC_sigelem:
4813 vtable = &PL_vtbl_sigelem;
4815 case PERL_MAGIC_taint:
4816 vtable = &PL_vtbl_taint;
4818 case PERL_MAGIC_uvar:
4819 vtable = &PL_vtbl_uvar;
4821 case PERL_MAGIC_vec:
4822 vtable = &PL_vtbl_vec;
4824 case PERL_MAGIC_vstring:
4827 case PERL_MAGIC_utf8:
4828 vtable = &PL_vtbl_utf8;
4830 case PERL_MAGIC_substr:
4831 vtable = &PL_vtbl_substr;
4833 case PERL_MAGIC_defelem:
4834 vtable = &PL_vtbl_defelem;
4836 case PERL_MAGIC_glob:
4837 vtable = &PL_vtbl_glob;
4839 case PERL_MAGIC_arylen:
4840 vtable = &PL_vtbl_arylen;
4842 case PERL_MAGIC_pos:
4843 vtable = &PL_vtbl_pos;
4845 case PERL_MAGIC_backref:
4846 vtable = &PL_vtbl_backref;
4848 case PERL_MAGIC_ext:
4849 /* Reserved for use by extensions not perl internals. */
4850 /* Useful for attaching extension internal data to perl vars. */
4851 /* Note that multiple extensions may clash if magical scalars */
4852 /* etc holding private data from one are passed to another. */
4855 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4858 /* Rest of work is done else where */
4859 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4862 case PERL_MAGIC_taint:
4865 case PERL_MAGIC_ext:
4866 case PERL_MAGIC_dbfile:
4873 =for apidoc sv_unmagic
4875 Removes all magic of type C<type> from an SV.
4881 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4885 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4888 for (mg = *mgp; mg; mg = *mgp) {
4889 if (mg->mg_type == type) {
4890 MGVTBL* vtbl = mg->mg_virtual;
4891 *mgp = mg->mg_moremagic;
4892 if (vtbl && vtbl->svt_free)
4893 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4894 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4896 Safefree(mg->mg_ptr);
4897 else if (mg->mg_len == HEf_SVKEY)
4898 SvREFCNT_dec((SV*)mg->mg_ptr);
4899 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4900 Safefree(mg->mg_ptr);
4902 if (mg->mg_flags & MGf_REFCOUNTED)
4903 SvREFCNT_dec(mg->mg_obj);
4907 mgp = &mg->mg_moremagic;
4911 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4918 =for apidoc sv_rvweaken
4920 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4921 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4922 push a back-reference to this RV onto the array of backreferences
4923 associated with that magic.
4929 Perl_sv_rvweaken(pTHX_ SV *sv)
4932 if (!SvOK(sv)) /* let undefs pass */
4935 Perl_croak(aTHX_ "Can't weaken a nonreference");
4936 else if (SvWEAKREF(sv)) {
4937 if (ckWARN(WARN_MISC))
4938 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4942 sv_add_backref(tsv, sv);
4948 /* Give tsv backref magic if it hasn't already got it, then push a
4949 * back-reference to sv onto the array associated with the backref magic.
4953 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4957 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4958 av = (AV*)mg->mg_obj;
4961 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4962 SvREFCNT_dec(av); /* for sv_magic */
4967 /* delete a back-reference to ourselves from the backref magic associated
4968 * with the SV we point to.
4972 S_sv_del_backref(pTHX_ SV *sv)
4979 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4980 Perl_croak(aTHX_ "panic: del_backref");
4981 av = (AV *)mg->mg_obj;
4986 svp[i] = &PL_sv_undef; /* XXX */
4993 =for apidoc sv_insert
4995 Inserts a string at the specified offset/length within the SV. Similar to
4996 the Perl substr() function.
5002 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5006 register char *midend;
5007 register char *bigend;
5013 Perl_croak(aTHX_ "Can't modify non-existent substring");
5014 SvPV_force(bigstr, curlen);
5015 (void)SvPOK_only_UTF8(bigstr);
5016 if (offset + len > curlen) {
5017 SvGROW(bigstr, offset+len+1);
5018 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5019 SvCUR_set(bigstr, offset+len);
5023 i = littlelen - len;
5024 if (i > 0) { /* string might grow */
5025 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5026 mid = big + offset + len;
5027 midend = bigend = big + SvCUR(bigstr);
5030 while (midend > mid) /* shove everything down */
5031 *--bigend = *--midend;
5032 Move(little,big+offset,littlelen,char);
5038 Move(little,SvPVX(bigstr)+offset,len,char);
5043 big = SvPVX(bigstr);
5046 bigend = big + SvCUR(bigstr);
5048 if (midend > bigend)
5049 Perl_croak(aTHX_ "panic: sv_insert");
5051 if (mid - big > bigend - midend) { /* faster to shorten from end */
5053 Move(little, mid, littlelen,char);
5056 i = bigend - midend;
5058 Move(midend, mid, i,char);
5062 SvCUR_set(bigstr, mid - big);
5065 else if ((i = mid - big)) { /* faster from front */
5066 midend -= littlelen;
5068 sv_chop(bigstr,midend-i);
5073 Move(little, mid, littlelen,char);
5075 else if (littlelen) {
5076 midend -= littlelen;
5077 sv_chop(bigstr,midend);
5078 Move(little,midend,littlelen,char);
5081 sv_chop(bigstr,midend);
5087 =for apidoc sv_replace
5089 Make the first argument a copy of the second, then delete the original.
5090 The target SV physically takes over ownership of the body of the source SV
5091 and inherits its flags; however, the target keeps any magic it owns,
5092 and any magic in the source is discarded.
5093 Note that this is a rather specialist SV copying operation; most of the
5094 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5100 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5102 U32 refcnt = SvREFCNT(sv);
5103 SV_CHECK_THINKFIRST_COW_DROP(sv);
5104 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5105 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5106 if (SvMAGICAL(sv)) {
5110 sv_upgrade(nsv, SVt_PVMG);
5111 SvMAGIC(nsv) = SvMAGIC(sv);
5112 SvFLAGS(nsv) |= SvMAGICAL(sv);
5118 assert(!SvREFCNT(sv));
5119 StructCopy(nsv,sv,SV);
5120 #ifdef PERL_COPY_ON_WRITE
5121 if (SvIsCOW_normal(nsv)) {
5122 /* We need to follow the pointers around the loop to make the
5123 previous SV point to sv, rather than nsv. */
5126 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5129 assert(SvPVX(current) == SvPVX(nsv));
5131 /* Make the SV before us point to the SV after us. */
5133 PerlIO_printf(Perl_debug_log, "previous is\n");
5135 PerlIO_printf(Perl_debug_log,
5136 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5137 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5139 SV_COW_NEXT_SV_SET(current, sv);
5142 SvREFCNT(sv) = refcnt;
5143 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5148 =for apidoc sv_clear
5150 Clear an SV: call any destructors, free up any memory used by the body,
5151 and free the body itself. The SV's head is I<not> freed, although
5152 its type is set to all 1's so that it won't inadvertently be assumed
5153 to be live during global destruction etc.
5154 This function should only be called when REFCNT is zero. Most of the time
5155 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5162 Perl_sv_clear(pTHX_ register SV *sv)
5166 assert(SvREFCNT(sv) == 0);
5169 if (PL_defstash) { /* Still have a symbol table? */
5174 Zero(&tmpref, 1, SV);
5175 sv_upgrade(&tmpref, SVt_RV);
5177 SvREADONLY_on(&tmpref); /* DESTROY() could be naughty */
5178 SvREFCNT(&tmpref) = 1;
5181 stash = SvSTASH(sv);
5182 destructor = StashHANDLER(stash,DESTROY);
5185 PUSHSTACKi(PERLSI_DESTROY);
5186 SvRV(&tmpref) = SvREFCNT_inc(sv);
5191 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5197 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5199 del_XRV(SvANY(&tmpref));
5202 if (PL_in_clean_objs)
5203 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5205 /* DESTROY gave object new lease on life */
5211 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5212 SvOBJECT_off(sv); /* Curse the object. */
5213 if (SvTYPE(sv) != SVt_PVIO)
5214 --PL_sv_objcount; /* XXX Might want something more general */
5217 if (SvTYPE(sv) >= SVt_PVMG) {
5220 if (SvFLAGS(sv) & SVpad_TYPED)
5221 SvREFCNT_dec(SvSTASH(sv));
5224 switch (SvTYPE(sv)) {
5227 IoIFP(sv) != PerlIO_stdin() &&
5228 IoIFP(sv) != PerlIO_stdout() &&
5229 IoIFP(sv) != PerlIO_stderr())
5231 io_close((IO*)sv, FALSE);
5233 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5234 PerlDir_close(IoDIRP(sv));
5235 IoDIRP(sv) = (DIR*)NULL;
5236 Safefree(IoTOP_NAME(sv));
5237 Safefree(IoFMT_NAME(sv));
5238 Safefree(IoBOTTOM_NAME(sv));
5253 SvREFCNT_dec(LvTARG(sv));
5257 Safefree(GvNAME(sv));
5258 /* cannot decrease stash refcount yet, as we might recursively delete
5259 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5260 of stash until current sv is completely gone.
5261 -- JohnPC, 27 Mar 1998 */
5262 stash = GvSTASH(sv);
5268 (void)SvOOK_off(sv);
5276 SvREFCNT_dec(SvRV(sv));
5278 #ifdef PERL_COPY_ON_WRITE
5279 else if (SvPVX(sv)) {
5281 /* I believe I need to grab the global SV mutex here and
5282 then recheck the COW status. */
5284 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5287 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5288 SvUVX(sv), SV_COW_NEXT_SV(sv));
5289 /* And drop it here. */
5291 } else if (SvLEN(sv)) {
5292 Safefree(SvPVX(sv));
5296 else if (SvPVX(sv) && SvLEN(sv))
5297 Safefree(SvPVX(sv));
5298 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5299 unsharepvn(SvPVX(sv),
5300 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5314 switch (SvTYPE(sv)) {
5330 del_XPVIV(SvANY(sv));
5333 del_XPVNV(SvANY(sv));
5336 del_XPVMG(SvANY(sv));
5339 del_XPVLV(SvANY(sv));
5342 del_XPVAV(SvANY(sv));
5345 del_XPVHV(SvANY(sv));
5348 del_XPVCV(SvANY(sv));
5351 del_XPVGV(SvANY(sv));
5352 /* code duplication for increased performance. */
5353 SvFLAGS(sv) &= SVf_BREAK;
5354 SvFLAGS(sv) |= SVTYPEMASK;
5355 /* decrease refcount of the stash that owns this GV, if any */
5357 SvREFCNT_dec(stash);
5358 return; /* not break, SvFLAGS reset already happened */
5360 del_XPVBM(SvANY(sv));
5363 del_XPVFM(SvANY(sv));
5366 del_XPVIO(SvANY(sv));
5369 SvFLAGS(sv) &= SVf_BREAK;
5370 SvFLAGS(sv) |= SVTYPEMASK;
5374 =for apidoc sv_newref
5376 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5383 Perl_sv_newref(pTHX_ SV *sv)
5386 ATOMIC_INC(SvREFCNT(sv));
5393 Decrement an SV's reference count, and if it drops to zero, call
5394 C<sv_clear> to invoke destructors and free up any memory used by
5395 the body; finally, deallocate the SV's head itself.
5396 Normally called via a wrapper macro C<SvREFCNT_dec>.
5402 Perl_sv_free(pTHX_ SV *sv)
5404 int refcount_is_zero;
5408 if (SvREFCNT(sv) == 0) {
5409 if (SvFLAGS(sv) & SVf_BREAK)
5410 /* this SV's refcnt has been artificially decremented to
5411 * trigger cleanup */
5413 if (PL_in_clean_all) /* All is fair */
5415 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5416 /* make sure SvREFCNT(sv)==0 happens very seldom */
5417 SvREFCNT(sv) = (~(U32)0)/2;
5420 if (ckWARN_d(WARN_INTERNAL))
5421 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Attempt to free unreferenced scalar");
5424 ATOMIC_DEC_AND_TEST(refcount_is_zero, SvREFCNT(sv));
5425 if (!refcount_is_zero)
5429 if (ckWARN_d(WARN_DEBUGGING))
5430 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5431 "Attempt to free temp prematurely: SV 0x%"UVxf,
5436 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5437 /* make sure SvREFCNT(sv)==0 happens very seldom */
5438 SvREFCNT(sv) = (~(U32)0)/2;
5449 Returns the length of the string in the SV. Handles magic and type
5450 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5456 Perl_sv_len(pTHX_ register SV *sv)
5464 len = mg_length(sv);
5466 (void)SvPV(sv, len);
5471 =for apidoc sv_len_utf8
5473 Returns the number of characters in the string in an SV, counting wide
5474 UTF8 bytes as a single character. Handles magic and type coercion.
5480 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5481 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5482 * (Note that the mg_len is not the length of the mg_ptr field.)
5487 Perl_sv_len_utf8(pTHX_ register SV *sv)
5493 return mg_length(sv);
5497 U8 *s = (U8*)SvPV(sv, len);
5498 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5500 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0))
5503 ulen = Perl_utf8_length(aTHX_ s, s + len);
5504 if (!mg && !SvREADONLY(sv)) {
5505 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5506 mg = mg_find(sv, PERL_MAGIC_utf8);
5516 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5517 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5518 * between UTF-8 and byte offsets. There are two (substr offset and substr
5519 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5520 * and byte offset) cache positions.
5522 * The mg_len field is used by sv_len_utf8(), see its comments.
5523 * Note that the mg_len is not the length of the mg_ptr field.
5527 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
5531 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5533 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5534 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5539 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5541 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5542 (*mgp)->mg_ptr = (char *) *cachep;
5546 (*cachep)[i] = *offsetp;
5547 (*cachep)[i+1] = s - start;
5555 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5556 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5557 * between UTF-8 and byte offsets. See also the comments of
5558 * S_utf8_mg_pos_init().
5562 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
5566 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5568 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5569 if (*mgp && (*mgp)->mg_ptr) {
5570 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5571 if ((*cachep)[i] == uoff) /* An exact match. */
5573 else { /* We will skip to the right spot. */
5578 /* The assumption is that going backward is half
5579 * the speed of going forward (that's where the
5580 * 2 * backw in the below comes from). (The real
5581 * figure of course depends on the UTF-8 data.) */
5583 if ((*cachep)[i] > uoff) {
5585 backw = (*cachep)[i] - uoff;
5587 if (forw < 2 * backw)
5590 p = start + (*cachep)[i+1];
5592 /* Try this only for the substr offset (i == 0),
5593 * not for the substr length (i == 2). */
5594 else if (i == 0) { /* (*cachep)[i] < uoff */
5595 STRLEN ulen = sv_len_utf8(sv);
5598 forw = uoff - (*cachep)[i];
5599 backw = ulen - uoff;
5601 if (forw < 2 * backw)
5602 p = start + (*cachep)[i+1];
5607 /* If the string is not long enough for uoff,
5608 * we could extend it, but not at this low a level. */
5612 if (forw < 2 * backw) {
5619 while (UTF8_IS_CONTINUATION(*p))
5624 /* Update the cache. */
5625 (*cachep)[i] = uoff;
5626 (*cachep)[i+1] = p - start;
5631 if (found) { /* Setup the return values. */
5632 *offsetp = (*cachep)[i+1];
5633 *sp = start + *offsetp;
5636 *offsetp = send - start;
5638 else if (*sp < start) {
5649 =for apidoc sv_pos_u2b
5651 Converts the value pointed to by offsetp from a count of UTF8 chars from
5652 the start of the string, to a count of the equivalent number of bytes; if
5653 lenp is non-zero, it does the same to lenp, but this time starting from
5654 the offset, rather than from the start of the string. Handles magic and
5661 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5662 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5663 * byte offsets. See also the comments of S_utf8_mg_pos().
5668 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5679 start = s = (U8*)SvPV(sv, len);
5681 I32 uoffset = *offsetp;
5686 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5688 if (!found && uoffset > 0) {
5689 while (s < send && uoffset--)
5693 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
5695 *offsetp = s - start;
5700 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
5704 if (!found && *lenp > 0) {
5707 while (s < send && ulen--)
5711 if (utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start))
5712 cache[2] += *offsetp;
5726 =for apidoc sv_pos_b2u
5728 Converts the value pointed to by offsetp from a count of bytes from the
5729 start of the string, to a count of the equivalent number of UTF8 chars.
5730 Handles magic and type coercion.
5736 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5737 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5738 * byte offsets. See also the comments of S_utf8_mg_pos().
5743 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5751 s = (U8*)SvPV(sv, len);
5752 if ((I32)len < *offsetp)
5753 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5755 U8* send = s + *offsetp;
5757 STRLEN *cache = NULL;
5761 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5762 mg = mg_find(sv, PERL_MAGIC_utf8);
5763 if (mg && mg->mg_ptr) {
5764 cache = (STRLEN *) mg->mg_ptr;
5765 if (cache[1] == *offsetp) {
5766 /* An exact match. */
5767 *offsetp = cache[0];
5771 else if (cache[1] < *offsetp) {
5772 /* We already know part of the way. */
5775 /* Let the below loop do the rest. */
5777 else { /* cache[1] > *offsetp */
5778 /* We already know all of the way, now we may
5779 * be able to walk back. The same assumption
5780 * is made as in S_utf8_mg_pos(), namely that
5781 * walking backward is twice slower than
5782 * walking forward. */
5783 STRLEN forw = *offsetp;
5784 STRLEN backw = cache[1] - *offsetp;
5786 if (!(forw < 2 * backw)) {
5787 U8 *p = s + cache[1];
5792 while (UTF8_IS_CONTINUATION(*p))
5809 /* Call utf8n_to_uvchr() to validate the sequence
5810 * (unless a simple non-UTF character) */
5811 if (!UTF8_IS_INVARIANT(*s))
5812 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5821 if (!SvREADONLY(sv)) {
5823 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5824 mg = mg_find(sv, PERL_MAGIC_utf8);
5829 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5830 mg->mg_ptr = (char *) cache;
5835 cache[1] = *offsetp;
5846 Returns a boolean indicating whether the strings in the two SVs are
5847 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5848 coerce its args to strings if necessary.
5854 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5862 SV* svrecode = Nullsv;
5869 pv1 = SvPV(sv1, cur1);
5876 pv2 = SvPV(sv2, cur2);
5878 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5879 /* Differing utf8ness.
5880 * Do not UTF8size the comparands as a side-effect. */
5883 svrecode = newSVpvn(pv2, cur2);
5884 sv_recode_to_utf8(svrecode, PL_encoding);
5885 pv2 = SvPV(svrecode, cur2);
5888 svrecode = newSVpvn(pv1, cur1);
5889 sv_recode_to_utf8(svrecode, PL_encoding);
5890 pv1 = SvPV(svrecode, cur1);
5892 /* Now both are in UTF-8. */
5897 bool is_utf8 = TRUE;
5900 /* sv1 is the UTF-8 one,
5901 * if is equal it must be downgrade-able */
5902 char *pv = (char*)bytes_from_utf8((U8*)pv1,
5908 /* sv2 is the UTF-8 one,
5909 * if is equal it must be downgrade-able */
5910 char *pv = (char *)bytes_from_utf8((U8*)pv2,
5916 /* Downgrade not possible - cannot be eq */
5923 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5926 SvREFCNT_dec(svrecode);
5937 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5938 string in C<sv1> is less than, equal to, or greater than the string in
5939 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5940 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5946 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5949 char *pv1, *pv2, *tpv = Nullch;
5951 SV *svrecode = Nullsv;
5958 pv1 = SvPV(sv1, cur1);
5965 pv2 = SvPV(sv2, cur2);
5967 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5968 /* Differing utf8ness.
5969 * Do not UTF8size the comparands as a side-effect. */
5972 svrecode = newSVpvn(pv2, cur2);
5973 sv_recode_to_utf8(svrecode, PL_encoding);
5974 pv2 = SvPV(svrecode, cur2);
5977 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
5982 svrecode = newSVpvn(pv1, cur1);
5983 sv_recode_to_utf8(svrecode, PL_encoding);
5984 pv1 = SvPV(svrecode, cur1);
5987 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
5993 cmp = cur2 ? -1 : 0;
5997 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6000 cmp = retval < 0 ? -1 : 1;
6001 } else if (cur1 == cur2) {
6004 cmp = cur1 < cur2 ? -1 : 1;
6009 SvREFCNT_dec(svrecode);
6018 =for apidoc sv_cmp_locale
6020 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6021 'use bytes' aware, handles get magic, and will coerce its args to strings
6022 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6028 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6030 #ifdef USE_LOCALE_COLLATE
6036 if (PL_collation_standard)
6040 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6042 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6044 if (!pv1 || !len1) {
6055 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6058 return retval < 0 ? -1 : 1;
6061 * When the result of collation is equality, that doesn't mean
6062 * that there are no differences -- some locales exclude some
6063 * characters from consideration. So to avoid false equalities,
6064 * we use the raw string as a tiebreaker.
6070 #endif /* USE_LOCALE_COLLATE */
6072 return sv_cmp(sv1, sv2);
6076 #ifdef USE_LOCALE_COLLATE
6079 =for apidoc sv_collxfrm
6081 Add Collate Transform magic to an SV if it doesn't already have it.
6083 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6084 scalar data of the variable, but transformed to such a format that a normal
6085 memory comparison can be used to compare the data according to the locale
6092 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6096 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6097 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6102 Safefree(mg->mg_ptr);
6104 if ((xf = mem_collxfrm(s, len, &xlen))) {
6105 if (SvREADONLY(sv)) {
6108 return xf + sizeof(PL_collation_ix);
6111 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6112 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6125 if (mg && mg->mg_ptr) {
6127 return mg->mg_ptr + sizeof(PL_collation_ix);
6135 #endif /* USE_LOCALE_COLLATE */
6140 Get a line from the filehandle and store it into the SV, optionally
6141 appending to the currently-stored string.
6147 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6151 register STDCHAR rslast;
6152 register STDCHAR *bp;
6157 SV_CHECK_THINKFIRST_COW_DROP(sv);
6158 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6160 However, perlbench says it's slower, because the existing swipe code
6161 is faster than copy on write.
6162 Swings and roundabouts. */
6163 (void)SvUPGRADE(sv, SVt_PV);
6167 if (PL_curcop == &PL_compiling) {
6168 /* we always read code in line mode */
6172 else if (RsSNARF(PL_rs)) {
6176 else if (RsRECORD(PL_rs)) {
6177 I32 recsize, bytesread;
6180 /* Grab the size of the record we're getting */
6181 recsize = SvIV(SvRV(PL_rs));
6182 (void)SvPOK_only(sv); /* Validate pointer */
6183 buffer = SvGROW(sv, (STRLEN)(recsize + 1));
6186 /* VMS wants read instead of fread, because fread doesn't respect */
6187 /* RMS record boundaries. This is not necessarily a good thing to be */
6188 /* doing, but we've got no other real choice */
6189 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6191 bytesread = PerlIO_read(fp, buffer, recsize);
6193 SvCUR_set(sv, bytesread);
6194 buffer[bytesread] = '\0';
6195 if (PerlIO_isutf8(fp))
6199 return(SvCUR(sv) ? SvPVX(sv) : Nullch);
6201 else if (RsPARA(PL_rs)) {
6207 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6208 if (PerlIO_isutf8(fp)) {
6209 rsptr = SvPVutf8(PL_rs, rslen);
6212 if (SvUTF8(PL_rs)) {
6213 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6214 Perl_croak(aTHX_ "Wide character in $/");
6217 rsptr = SvPV(PL_rs, rslen);
6221 rslast = rslen ? rsptr[rslen - 1] : '\0';
6223 if (rspara) { /* have to do this both before and after */
6224 do { /* to make sure file boundaries work right */
6227 i = PerlIO_getc(fp);
6231 PerlIO_ungetc(fp,i);
6237 /* See if we know enough about I/O mechanism to cheat it ! */
6239 /* This used to be #ifdef test - it is made run-time test for ease
6240 of abstracting out stdio interface. One call should be cheap
6241 enough here - and may even be a macro allowing compile
6245 if (PerlIO_fast_gets(fp)) {
6248 * We're going to steal some values from the stdio struct
6249 * and put EVERYTHING in the innermost loop into registers.
6251 register STDCHAR *ptr;
6255 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6256 /* An ungetc()d char is handled separately from the regular
6257 * buffer, so we getc() it back out and stuff it in the buffer.
6259 i = PerlIO_getc(fp);
6260 if (i == EOF) return 0;
6261 *(--((*fp)->_ptr)) = (unsigned char) i;
6265 /* Here is some breathtakingly efficient cheating */
6267 cnt = PerlIO_get_cnt(fp); /* get count into register */
6268 (void)SvPOK_only(sv); /* validate pointer */
6269 if ((I32)(SvLEN(sv) - append) <= cnt + 1) { /* make sure we have the room */
6270 if (cnt > 80 && (I32)SvLEN(sv) > append) {
6271 shortbuffered = cnt - SvLEN(sv) + append + 1;
6272 cnt -= shortbuffered;
6276 /* remember that cnt can be negative */
6277 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6282 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
6283 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6284 DEBUG_P(PerlIO_printf(Perl_debug_log,
6285 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6286 DEBUG_P(PerlIO_printf(Perl_debug_log,
6287 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6288 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6289 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6294 while (cnt > 0) { /* this | eat */
6296 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6297 goto thats_all_folks; /* screams | sed :-) */
6301 Copy(ptr, bp, cnt, char); /* this | eat */
6302 bp += cnt; /* screams | dust */
6303 ptr += cnt; /* louder | sed :-) */
6308 if (shortbuffered) { /* oh well, must extend */
6309 cnt = shortbuffered;
6311 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6313 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6314 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6318 DEBUG_P(PerlIO_printf(Perl_debug_log,
6319 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6320 PTR2UV(ptr),(long)cnt));
6321 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6323 DEBUG_P(PerlIO_printf(Perl_debug_log,
6324 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6325 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6326 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6328 /* This used to call 'filbuf' in stdio form, but as that behaves like
6329 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6330 another abstraction. */
6331 i = PerlIO_getc(fp); /* get more characters */
6333 DEBUG_P(PerlIO_printf(Perl_debug_log,
6334 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6335 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6336 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6338 cnt = PerlIO_get_cnt(fp);
6339 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6340 DEBUG_P(PerlIO_printf(Perl_debug_log,
6341 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6343 if (i == EOF) /* all done for ever? */
6344 goto thats_really_all_folks;
6346 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6348 SvGROW(sv, bpx + cnt + 2);
6349 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6351 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6353 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6354 goto thats_all_folks;
6358 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
6359 memNE((char*)bp - rslen, rsptr, rslen))
6360 goto screamer; /* go back to the fray */
6361 thats_really_all_folks:
6363 cnt += shortbuffered;
6364 DEBUG_P(PerlIO_printf(Perl_debug_log,
6365 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6366 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6367 DEBUG_P(PerlIO_printf(Perl_debug_log,
6368 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6369 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6370 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6372 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
6373 DEBUG_P(PerlIO_printf(Perl_debug_log,
6374 "Screamer: done, len=%ld, string=|%.*s|\n",
6375 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
6380 /*The big, slow, and stupid way */
6383 /* Need to work around EPOC SDK features */
6384 /* On WINS: MS VC5 generates calls to _chkstk, */
6385 /* if a `large' stack frame is allocated */
6386 /* gcc on MARM does not generate calls like these */
6392 register STDCHAR *bpe = buf + sizeof(buf);
6394 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6395 ; /* keep reading */
6399 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6400 /* Accomodate broken VAXC compiler, which applies U8 cast to
6401 * both args of ?: operator, causing EOF to change into 255
6404 i = (U8)buf[cnt - 1];
6410 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6412 sv_catpvn(sv, (char *) buf, cnt);
6414 sv_setpvn(sv, (char *) buf, cnt);
6416 if (i != EOF && /* joy */
6418 SvCUR(sv) < rslen ||
6419 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6423 * If we're reading from a TTY and we get a short read,
6424 * indicating that the user hit his EOF character, we need
6425 * to notice it now, because if we try to read from the TTY
6426 * again, the EOF condition will disappear.
6428 * The comparison of cnt to sizeof(buf) is an optimization
6429 * that prevents unnecessary calls to feof().
6433 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6438 if (rspara) { /* have to do this both before and after */
6439 while (i != EOF) { /* to make sure file boundaries work right */
6440 i = PerlIO_getc(fp);
6442 PerlIO_ungetc(fp,i);
6448 if (PerlIO_isutf8(fp))
6453 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6459 Auto-increment of the value in the SV, doing string to numeric conversion
6460 if necessary. Handles 'get' magic.
6466 Perl_sv_inc(pTHX_ register SV *sv)
6475 if (SvTHINKFIRST(sv)) {
6477 sv_force_normal_flags(sv, 0);
6478 if (SvREADONLY(sv)) {
6479 if (PL_curcop != &PL_compiling)
6480 Perl_croak(aTHX_ PL_no_modify);
6484 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6486 i = PTR2IV(SvRV(sv));
6491 flags = SvFLAGS(sv);
6492 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6493 /* It's (privately or publicly) a float, but not tested as an
6494 integer, so test it to see. */
6496 flags = SvFLAGS(sv);
6498 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6499 /* It's publicly an integer, or privately an integer-not-float */
6500 #ifdef PERL_PRESERVE_IVUV
6504 if (SvUVX(sv) == UV_MAX)
6505 sv_setnv(sv, UV_MAX_P1);
6507 (void)SvIOK_only_UV(sv);
6510 if (SvIVX(sv) == IV_MAX)
6511 sv_setuv(sv, (UV)IV_MAX + 1);
6513 (void)SvIOK_only(sv);
6519 if (flags & SVp_NOK) {
6520 (void)SvNOK_only(sv);
6525 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
6526 if ((flags & SVTYPEMASK) < SVt_PVIV)
6527 sv_upgrade(sv, SVt_IV);
6528 (void)SvIOK_only(sv);
6533 while (isALPHA(*d)) d++;
6534 while (isDIGIT(*d)) d++;
6536 #ifdef PERL_PRESERVE_IVUV
6537 /* Got to punt this as an integer if needs be, but we don't issue
6538 warnings. Probably ought to make the sv_iv_please() that does
6539 the conversion if possible, and silently. */
6540 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6541 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6542 /* Need to try really hard to see if it's an integer.
6543 9.22337203685478e+18 is an integer.
6544 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6545 so $a="9.22337203685478e+18"; $a+0; $a++
6546 needs to be the same as $a="9.22337203685478e+18"; $a++
6553 /* sv_2iv *should* have made this an NV */
6554 if (flags & SVp_NOK) {
6555 (void)SvNOK_only(sv);
6559 /* I don't think we can get here. Maybe I should assert this
6560 And if we do get here I suspect that sv_setnv will croak. NWC
6562 #if defined(USE_LONG_DOUBLE)
6563 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6564 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6566 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6567 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6570 #endif /* PERL_PRESERVE_IVUV */
6571 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
6575 while (d >= SvPVX(sv)) {
6583 /* MKS: The original code here died if letters weren't consecutive.
6584 * at least it didn't have to worry about non-C locales. The
6585 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6586 * arranged in order (although not consecutively) and that only
6587 * [A-Za-z] are accepted by isALPHA in the C locale.
6589 if (*d != 'z' && *d != 'Z') {
6590 do { ++*d; } while (!isALPHA(*d));
6593 *(d--) -= 'z' - 'a';
6598 *(d--) -= 'z' - 'a' + 1;
6602 /* oh,oh, the number grew */
6603 SvGROW(sv, SvCUR(sv) + 2);
6605 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6616 Auto-decrement of the value in the SV, doing string to numeric conversion
6617 if necessary. Handles 'get' magic.
6623 Perl_sv_dec(pTHX_ register SV *sv)
6631 if (SvTHINKFIRST(sv)) {
6633 sv_force_normal_flags(sv, 0);
6634 if (SvREADONLY(sv)) {
6635 if (PL_curcop != &PL_compiling)
6636 Perl_croak(aTHX_ PL_no_modify);
6640 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6642 i = PTR2IV(SvRV(sv));
6647 /* Unlike sv_inc we don't have to worry about string-never-numbers
6648 and keeping them magic. But we mustn't warn on punting */
6649 flags = SvFLAGS(sv);
6650 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6651 /* It's publicly an integer, or privately an integer-not-float */
6652 #ifdef PERL_PRESERVE_IVUV
6656 if (SvUVX(sv) == 0) {
6657 (void)SvIOK_only(sv);
6661 (void)SvIOK_only_UV(sv);
6665 if (SvIVX(sv) == IV_MIN)
6666 sv_setnv(sv, (NV)IV_MIN - 1.0);
6668 (void)SvIOK_only(sv);
6674 if (flags & SVp_NOK) {
6676 (void)SvNOK_only(sv);
6679 if (!(flags & SVp_POK)) {
6680 if ((flags & SVTYPEMASK) < SVt_PVNV)
6681 sv_upgrade(sv, SVt_NV);
6683 (void)SvNOK_only(sv);
6686 #ifdef PERL_PRESERVE_IVUV
6688 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6689 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6690 /* Need to try really hard to see if it's an integer.
6691 9.22337203685478e+18 is an integer.
6692 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6693 so $a="9.22337203685478e+18"; $a+0; $a--
6694 needs to be the same as $a="9.22337203685478e+18"; $a--
6701 /* sv_2iv *should* have made this an NV */
6702 if (flags & SVp_NOK) {
6703 (void)SvNOK_only(sv);
6707 /* I don't think we can get here. Maybe I should assert this
6708 And if we do get here I suspect that sv_setnv will croak. NWC
6710 #if defined(USE_LONG_DOUBLE)
6711 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6712 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6714 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6715 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6719 #endif /* PERL_PRESERVE_IVUV */
6720 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6724 =for apidoc sv_mortalcopy
6726 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6727 The new SV is marked as mortal. It will be destroyed "soon", either by an
6728 explicit call to FREETMPS, or by an implicit call at places such as
6729 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6734 /* Make a string that will exist for the duration of the expression
6735 * evaluation. Actually, it may have to last longer than that, but
6736 * hopefully we won't free it until it has been assigned to a
6737 * permanent location. */
6740 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6745 sv_setsv(sv,oldstr);
6747 PL_tmps_stack[++PL_tmps_ix] = sv;
6753 =for apidoc sv_newmortal
6755 Creates a new null SV which is mortal. The reference count of the SV is
6756 set to 1. It will be destroyed "soon", either by an explicit call to
6757 FREETMPS, or by an implicit call at places such as statement boundaries.
6758 See also C<sv_mortalcopy> and C<sv_2mortal>.
6764 Perl_sv_newmortal(pTHX)
6769 SvFLAGS(sv) = SVs_TEMP;
6771 PL_tmps_stack[++PL_tmps_ix] = sv;
6776 =for apidoc sv_2mortal
6778 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6779 by an explicit call to FREETMPS, or by an implicit call at places such as
6780 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
6786 Perl_sv_2mortal(pTHX_ register SV *sv)
6790 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6793 PL_tmps_stack[++PL_tmps_ix] = sv;
6801 Creates a new SV and copies a string into it. The reference count for the
6802 SV is set to 1. If C<len> is zero, Perl will compute the length using
6803 strlen(). For efficiency, consider using C<newSVpvn> instead.
6809 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6816 sv_setpvn(sv,s,len);
6821 =for apidoc newSVpvn
6823 Creates a new SV and copies a string into it. The reference count for the
6824 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6825 string. You are responsible for ensuring that the source string is at least
6832 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6837 sv_setpvn(sv,s,len);
6842 =for apidoc newSVpvn_share
6844 Creates a new SV with its SvPVX pointing to a shared string in the string
6845 table. If the string does not already exist in the table, it is created
6846 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6847 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6848 otherwise the hash is computed. The idea here is that as the string table
6849 is used for shared hash keys these strings will have SvPVX == HeKEY and
6850 hash lookup will avoid string compare.
6856 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6859 bool is_utf8 = FALSE;
6861 STRLEN tmplen = -len;
6863 /* See the note in hv.c:hv_fetch() --jhi */
6864 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
6868 PERL_HASH(hash, src, len);
6870 sv_upgrade(sv, SVt_PVIV);
6871 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
6884 #if defined(PERL_IMPLICIT_CONTEXT)
6886 /* pTHX_ magic can't cope with varargs, so this is a no-context
6887 * version of the main function, (which may itself be aliased to us).
6888 * Don't access this version directly.
6892 Perl_newSVpvf_nocontext(const char* pat, ...)
6897 va_start(args, pat);
6898 sv = vnewSVpvf(pat, &args);
6905 =for apidoc newSVpvf
6907 Creates a new SV and initializes it with the string formatted like
6914 Perl_newSVpvf(pTHX_ const char* pat, ...)
6918 va_start(args, pat);
6919 sv = vnewSVpvf(pat, &args);
6924 /* backend for newSVpvf() and newSVpvf_nocontext() */
6927 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6931 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6938 Creates a new SV and copies a floating point value into it.
6939 The reference count for the SV is set to 1.
6945 Perl_newSVnv(pTHX_ NV n)
6957 Creates a new SV and copies an integer into it. The reference count for the
6964 Perl_newSViv(pTHX_ IV i)
6976 Creates a new SV and copies an unsigned integer into it.
6977 The reference count for the SV is set to 1.
6983 Perl_newSVuv(pTHX_ UV u)
6993 =for apidoc newRV_noinc
6995 Creates an RV wrapper for an SV. The reference count for the original
6996 SV is B<not> incremented.
7002 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7007 sv_upgrade(sv, SVt_RV);
7014 /* newRV_inc is the official function name to use now.
7015 * newRV_inc is in fact #defined to newRV in sv.h
7019 Perl_newRV(pTHX_ SV *tmpRef)
7021 return newRV_noinc(SvREFCNT_inc(tmpRef));
7027 Creates a new SV which is an exact duplicate of the original SV.
7034 Perl_newSVsv(pTHX_ register SV *old)
7040 if (SvTYPE(old) == SVTYPEMASK) {
7041 if (ckWARN_d(WARN_INTERNAL))
7042 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7057 =for apidoc sv_reset
7059 Underlying implementation for the C<reset> Perl function.
7060 Note that the perl-level function is vaguely deprecated.
7066 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7074 char todo[PERL_UCHAR_MAX+1];
7079 if (!*s) { /* reset ?? searches */
7080 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7081 pm->op_pmdynflags &= ~PMdf_USED;
7086 /* reset variables */
7088 if (!HvARRAY(stash))
7091 Zero(todo, 256, char);
7093 i = (unsigned char)*s;
7097 max = (unsigned char)*s++;
7098 for ( ; i <= max; i++) {
7101 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7102 for (entry = HvARRAY(stash)[i];
7104 entry = HeNEXT(entry))
7106 if (!todo[(U8)*HeKEY(entry)])
7108 gv = (GV*)HeVAL(entry);
7110 if (SvTHINKFIRST(sv)) {
7111 if (!SvREADONLY(sv) && SvROK(sv))
7116 if (SvTYPE(sv) >= SVt_PV) {
7118 if (SvPVX(sv) != Nullch)
7125 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7127 #ifdef USE_ENVIRON_ARRAY
7129 # ifdef USE_ITHREADS
7130 && PL_curinterp == aTHX
7134 environ[0] = Nullch;
7146 Using various gambits, try to get an IO from an SV: the IO slot if its a
7147 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7148 named after the PV if we're a string.
7154 Perl_sv_2io(pTHX_ SV *sv)
7160 switch (SvTYPE(sv)) {
7168 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7172 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7174 return sv_2io(SvRV(sv));
7175 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7181 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7190 Using various gambits, try to get a CV from an SV; in addition, try if
7191 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7197 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7204 return *gvp = Nullgv, Nullcv;
7205 switch (SvTYPE(sv)) {
7224 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7225 tryAMAGICunDEREF(to_cv);
7228 if (SvTYPE(sv) == SVt_PVCV) {
7237 Perl_croak(aTHX_ "Not a subroutine reference");
7242 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
7248 if (lref && !GvCVu(gv)) {
7251 tmpsv = NEWSV(704,0);
7252 gv_efullname3(tmpsv, gv, Nullch);
7253 /* XXX this is probably not what they think they're getting.
7254 * It has the same effect as "sub name;", i.e. just a forward
7256 newSUB(start_subparse(FALSE, 0),
7257 newSVOP(OP_CONST, 0, tmpsv),
7262 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7272 Returns true if the SV has a true value by Perl's rules.
7273 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7274 instead use an in-line version.
7280 Perl_sv_true(pTHX_ register SV *sv)
7286 if ((tXpv = (XPV*)SvANY(sv)) &&
7287 (tXpv->xpv_cur > 1 ||
7288 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
7295 return SvIVX(sv) != 0;
7298 return SvNVX(sv) != 0.0;
7300 return sv_2bool(sv);
7308 A private implementation of the C<SvIVx> macro for compilers which can't
7309 cope with complex macro expressions. Always use the macro instead.
7315 Perl_sv_iv(pTHX_ register SV *sv)
7319 return (IV)SvUVX(sv);
7328 A private implementation of the C<SvUVx> macro for compilers which can't
7329 cope with complex macro expressions. Always use the macro instead.
7335 Perl_sv_uv(pTHX_ register SV *sv)
7340 return (UV)SvIVX(sv);
7348 A private implementation of the C<SvNVx> macro for compilers which can't
7349 cope with complex macro expressions. Always use the macro instead.
7355 Perl_sv_nv(pTHX_ register SV *sv)
7365 Use the C<SvPV_nolen> macro instead
7369 A private implementation of the C<SvPV> macro for compilers which can't
7370 cope with complex macro expressions. Always use the macro instead.
7376 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7382 return sv_2pv(sv, lp);
7387 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7393 return sv_2pv_flags(sv, lp, 0);
7397 =for apidoc sv_pvn_force
7399 Get a sensible string out of the SV somehow.
7400 A private implementation of the C<SvPV_force> macro for compilers which
7401 can't cope with complex macro expressions. Always use the macro instead.
7403 =for apidoc sv_pvn_force_flags
7405 Get a sensible string out of the SV somehow.
7406 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7407 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7408 implemented in terms of this function.
7409 You normally want to use the various wrapper macros instead: see
7410 C<SvPV_force> and C<SvPV_force_nomg>
7416 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7420 if (SvTHINKFIRST(sv) && !SvROK(sv))
7421 sv_force_normal_flags(sv, 0);
7427 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7428 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7432 s = sv_2pv_flags(sv, lp, flags);
7433 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
7438 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7439 SvGROW(sv, len + 1);
7440 Move(s,SvPVX(sv),len,char);
7445 SvPOK_on(sv); /* validate pointer */
7447 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7448 PTR2UV(sv),SvPVX(sv)));
7455 =for apidoc sv_pvbyte
7457 Use C<SvPVbyte_nolen> instead.
7459 =for apidoc sv_pvbyten
7461 A private implementation of the C<SvPVbyte> macro for compilers
7462 which can't cope with complex macro expressions. Always use the macro
7469 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7471 sv_utf8_downgrade(sv,0);
7472 return sv_pvn(sv,lp);
7476 =for apidoc sv_pvbyten_force
7478 A private implementation of the C<SvPVbytex_force> macro for compilers
7479 which can't cope with complex macro expressions. Always use the macro
7486 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7488 sv_utf8_downgrade(sv,0);
7489 return sv_pvn_force(sv,lp);
7493 =for apidoc sv_pvutf8
7495 Use the C<SvPVutf8_nolen> macro instead
7497 =for apidoc sv_pvutf8n
7499 A private implementation of the C<SvPVutf8> macro for compilers
7500 which can't cope with complex macro expressions. Always use the macro
7507 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7509 sv_utf8_upgrade(sv);
7510 return sv_pvn(sv,lp);
7514 =for apidoc sv_pvutf8n_force
7516 A private implementation of the C<SvPVutf8_force> macro for compilers
7517 which can't cope with complex macro expressions. Always use the macro
7524 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7526 sv_utf8_upgrade(sv);
7527 return sv_pvn_force(sv,lp);
7531 =for apidoc sv_reftype
7533 Returns a string describing what the SV is a reference to.
7539 Perl_sv_reftype(pTHX_ SV *sv, int ob)
7541 if (ob && SvOBJECT(sv)) {
7542 return HvNAME(SvSTASH(sv));
7545 switch (SvTYPE(sv)) {
7561 case SVt_PVLV: return "LVALUE";
7562 case SVt_PVAV: return "ARRAY";
7563 case SVt_PVHV: return "HASH";
7564 case SVt_PVCV: return "CODE";
7565 case SVt_PVGV: return "GLOB";
7566 case SVt_PVFM: return "FORMAT";
7567 case SVt_PVIO: return "IO";
7568 default: return "UNKNOWN";
7574 =for apidoc sv_isobject
7576 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7577 object. If the SV is not an RV, or if the object is not blessed, then this
7584 Perl_sv_isobject(pTHX_ SV *sv)
7601 Returns a boolean indicating whether the SV is blessed into the specified
7602 class. This does not check for subtypes; use C<sv_derived_from> to verify
7603 an inheritance relationship.
7609 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7621 return strEQ(HvNAME(SvSTASH(sv)), name);
7627 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7628 it will be upgraded to one. If C<classname> is non-null then the new SV will
7629 be blessed in the specified package. The new SV is returned and its
7630 reference count is 1.
7636 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7642 SV_CHECK_THINKFIRST_COW_DROP(rv);
7645 if (SvTYPE(rv) >= SVt_PVMG) {
7646 U32 refcnt = SvREFCNT(rv);
7650 SvREFCNT(rv) = refcnt;
7653 if (SvTYPE(rv) < SVt_RV)
7654 sv_upgrade(rv, SVt_RV);
7655 else if (SvTYPE(rv) > SVt_RV) {
7656 (void)SvOOK_off(rv);
7657 if (SvPVX(rv) && SvLEN(rv))
7658 Safefree(SvPVX(rv));
7668 HV* stash = gv_stashpv(classname, TRUE);
7669 (void)sv_bless(rv, stash);
7675 =for apidoc sv_setref_pv
7677 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7678 argument will be upgraded to an RV. That RV will be modified to point to
7679 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7680 into the SV. The C<classname> argument indicates the package for the
7681 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7682 will be returned and will have a reference count of 1.
7684 Do not use with other Perl types such as HV, AV, SV, CV, because those
7685 objects will become corrupted by the pointer copy process.
7687 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7693 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7696 sv_setsv(rv, &PL_sv_undef);
7700 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7705 =for apidoc sv_setref_iv
7707 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7708 argument will be upgraded to an RV. That RV will be modified to point to
7709 the new SV. The C<classname> argument indicates the package for the
7710 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7711 will be returned and will have a reference count of 1.
7717 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7719 sv_setiv(newSVrv(rv,classname), iv);
7724 =for apidoc sv_setref_uv
7726 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7727 argument will be upgraded to an RV. That RV will be modified to point to
7728 the new SV. The C<classname> argument indicates the package for the
7729 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7730 will be returned and will have a reference count of 1.
7736 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7738 sv_setuv(newSVrv(rv,classname), uv);
7743 =for apidoc sv_setref_nv
7745 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7746 argument will be upgraded to an RV. That RV will be modified to point to
7747 the new SV. The C<classname> argument indicates the package for the
7748 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7749 will be returned and will have a reference count of 1.
7755 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7757 sv_setnv(newSVrv(rv,classname), nv);
7762 =for apidoc sv_setref_pvn
7764 Copies a string into a new SV, optionally blessing the SV. The length of the
7765 string must be specified with C<n>. The C<rv> argument will be upgraded to
7766 an RV. That RV will be modified to point to the new SV. The C<classname>
7767 argument indicates the package for the blessing. Set C<classname> to
7768 C<Nullch> to avoid the blessing. The new SV will be returned and will have
7769 a reference count of 1.
7771 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7777 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
7779 sv_setpvn(newSVrv(rv,classname), pv, n);
7784 =for apidoc sv_bless
7786 Blesses an SV into a specified package. The SV must be an RV. The package
7787 must be designated by its stash (see C<gv_stashpv()>). The reference count
7788 of the SV is unaffected.
7794 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7798 Perl_croak(aTHX_ "Can't bless non-reference value");
7800 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7801 if (SvREADONLY(tmpRef))
7802 Perl_croak(aTHX_ PL_no_modify);
7803 if (SvOBJECT(tmpRef)) {
7804 if (SvTYPE(tmpRef) != SVt_PVIO)
7806 SvREFCNT_dec(SvSTASH(tmpRef));
7809 SvOBJECT_on(tmpRef);
7810 if (SvTYPE(tmpRef) != SVt_PVIO)
7812 (void)SvUPGRADE(tmpRef, SVt_PVMG);
7813 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
7820 if(SvSMAGICAL(tmpRef))
7821 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7829 /* Downgrades a PVGV to a PVMG.
7833 S_sv_unglob(pTHX_ SV *sv)
7837 assert(SvTYPE(sv) == SVt_PVGV);
7842 SvREFCNT_dec(GvSTASH(sv));
7843 GvSTASH(sv) = Nullhv;
7845 sv_unmagic(sv, PERL_MAGIC_glob);
7846 Safefree(GvNAME(sv));
7849 /* need to keep SvANY(sv) in the right arena */
7850 xpvmg = new_XPVMG();
7851 StructCopy(SvANY(sv), xpvmg, XPVMG);
7852 del_XPVGV(SvANY(sv));
7855 SvFLAGS(sv) &= ~SVTYPEMASK;
7856 SvFLAGS(sv) |= SVt_PVMG;
7860 =for apidoc sv_unref_flags
7862 Unsets the RV status of the SV, and decrements the reference count of
7863 whatever was being referenced by the RV. This can almost be thought of
7864 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7865 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7866 (otherwise the decrementing is conditional on the reference count being
7867 different from one or the reference being a readonly SV).
7874 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
7878 if (SvWEAKREF(sv)) {
7886 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
7887 assigned to as BEGIN {$a = \"Foo"} will fail. */
7888 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
7890 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7891 sv_2mortal(rv); /* Schedule for freeing later */
7895 =for apidoc sv_unref
7897 Unsets the RV status of the SV, and decrements the reference count of
7898 whatever was being referenced by the RV. This can almost be thought of
7899 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
7900 being zero. See C<SvROK_off>.
7906 Perl_sv_unref(pTHX_ SV *sv)
7908 sv_unref_flags(sv, 0);
7912 =for apidoc sv_taint
7914 Taint an SV. Use C<SvTAINTED_on> instead.
7919 Perl_sv_taint(pTHX_ SV *sv)
7921 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
7925 =for apidoc sv_untaint
7927 Untaint an SV. Use C<SvTAINTED_off> instead.
7932 Perl_sv_untaint(pTHX_ SV *sv)
7934 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7935 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7942 =for apidoc sv_tainted
7944 Test an SV for taintedness. Use C<SvTAINTED> instead.
7949 Perl_sv_tainted(pTHX_ SV *sv)
7951 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7952 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7953 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
7959 #if defined(PERL_IMPLICIT_CONTEXT)
7961 /* pTHX_ magic can't cope with varargs, so this is a no-context
7962 * version of the main function, (which may itself be aliased to us).
7963 * Don't access this version directly.
7967 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7971 va_start(args, pat);
7972 sv_vsetpvf(sv, pat, &args);
7976 /* pTHX_ magic can't cope with varargs, so this is a no-context
7977 * version of the main function, (which may itself be aliased to us).
7978 * Don't access this version directly.
7982 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7986 va_start(args, pat);
7987 sv_vsetpvf_mg(sv, pat, &args);
7993 =for apidoc sv_setpvf
7995 Processes its arguments like C<sprintf> and sets an SV to the formatted
7996 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8002 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8005 va_start(args, pat);
8006 sv_vsetpvf(sv, pat, &args);
8010 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8013 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8015 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8019 =for apidoc sv_setpvf_mg
8021 Like C<sv_setpvf>, but also handles 'set' magic.
8027 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8030 va_start(args, pat);
8031 sv_vsetpvf_mg(sv, pat, &args);
8035 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8038 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8040 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8044 #if defined(PERL_IMPLICIT_CONTEXT)
8046 /* pTHX_ magic can't cope with varargs, so this is a no-context
8047 * version of the main function, (which may itself be aliased to us).
8048 * Don't access this version directly.
8052 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8056 va_start(args, pat);
8057 sv_vcatpvf(sv, pat, &args);
8061 /* pTHX_ magic can't cope with varargs, so this is a no-context
8062 * version of the main function, (which may itself be aliased to us).
8063 * Don't access this version directly.
8067 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8071 va_start(args, pat);
8072 sv_vcatpvf_mg(sv, pat, &args);
8078 =for apidoc sv_catpvf
8080 Processes its arguments like C<sprintf> and appends the formatted
8081 output to an SV. If the appended data contains "wide" characters
8082 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8083 and characters >255 formatted with %c), the original SV might get
8084 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8085 C<SvSETMAGIC()> must typically be called after calling this function
8086 to handle 'set' magic.
8091 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8094 va_start(args, pat);
8095 sv_vcatpvf(sv, pat, &args);
8099 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8102 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8104 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8108 =for apidoc sv_catpvf_mg
8110 Like C<sv_catpvf>, but also handles 'set' magic.
8116 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8119 va_start(args, pat);
8120 sv_vcatpvf_mg(sv, pat, &args);
8124 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
8127 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8129 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8134 =for apidoc sv_vsetpvfn
8136 Works like C<vcatpvfn> but copies the text into the SV instead of
8139 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
8145 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8147 sv_setpvn(sv, "", 0);
8148 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8151 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8154 S_expect_number(pTHX_ char** pattern)
8157 switch (**pattern) {
8158 case '1': case '2': case '3':
8159 case '4': case '5': case '6':
8160 case '7': case '8': case '9':
8161 while (isDIGIT(**pattern))
8162 var = var * 10 + (*(*pattern)++ - '0');
8166 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8169 =for apidoc sv_vcatpvfn
8171 Processes its arguments like C<vsprintf> and appends the formatted output
8172 to an SV. Uses an array of SVs if the C style variable argument list is
8173 missing (NULL). When running with taint checks enabled, indicates via
8174 C<maybe_tainted> if results are untrustworthy (often due to the use of
8177 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
8183 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8190 static char nullstr[] = "(null)";
8192 bool has_utf8 = FALSE; /* has the result utf8? */
8194 /* no matter what, this is a string now */
8195 (void)SvPV_force(sv, origlen);
8197 /* special-case "", "%s", and "%_" */
8200 if (patlen == 2 && pat[0] == '%') {
8204 char *s = va_arg(*args, char*);
8205 sv_catpv(sv, s ? s : nullstr);
8207 else if (svix < svmax) {
8208 sv_catsv(sv, *svargs);
8209 if (DO_UTF8(*svargs))
8215 argsv = va_arg(*args, SV*);
8216 sv_catsv(sv, argsv);
8221 /* See comment on '_' below */
8226 if (!args && svix < svmax && DO_UTF8(*svargs))
8229 patend = (char*)pat + patlen;
8230 for (p = (char*)pat; p < patend; p = q) {
8233 bool vectorize = FALSE;
8234 bool vectorarg = FALSE;
8235 bool vec_utf8 = FALSE;
8241 bool has_precis = FALSE;
8243 bool is_utf8 = FALSE; /* is this item utf8? */
8244 #ifdef HAS_LDBL_SPRINTF_BUG
8245 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8246 with sfio - Allen <allens@cpan.org> */
8247 bool fix_ldbl_sprintf_bug = FALSE;
8251 U8 utf8buf[UTF8_MAXLEN+1];
8252 STRLEN esignlen = 0;
8254 char *eptr = Nullch;
8256 /* Times 4: a decimal digit takes more than 3 binary digits.
8257 * NV_DIG: mantissa takes than many decimal digits.
8258 * Plus 32: Playing safe. */
8259 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8260 /* large enough for "%#.#f" --chip */
8261 /* what about long double NVs? --jhi */
8264 U8 *vecstr = Null(U8*);
8271 /* we need a long double target in case HAS_LONG_DOUBLE but
8274 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8283 STRLEN dotstrlen = 1;
8284 I32 efix = 0; /* explicit format parameter index */
8285 I32 ewix = 0; /* explicit width index */
8286 I32 epix = 0; /* explicit precision index */
8287 I32 evix = 0; /* explicit vector index */
8288 bool asterisk = FALSE;
8290 /* echo everything up to the next format specification */
8291 for (q = p; q < patend && *q != '%'; ++q) ;
8293 sv_catpvn(sv, p, q - p);
8300 We allow format specification elements in this order:
8301 \d+\$ explicit format parameter index
8303 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8304 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8305 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8307 [%bcdefginopsux_DFOUX] format (mandatory)
8309 if (EXPECT_NUMBER(q, width)) {
8350 if (EXPECT_NUMBER(q, ewix))
8359 if ((vectorarg = asterisk)) {
8369 EXPECT_NUMBER(q, width);
8374 vecsv = va_arg(*args, SV*);
8376 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8377 svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
8378 dotstr = SvPVx(vecsv, dotstrlen);
8383 vecsv = va_arg(*args, SV*);
8384 vecstr = (U8*)SvPVx(vecsv,veclen);
8385 vec_utf8 = DO_UTF8(vecsv);
8387 else if (efix ? efix <= svmax : svix < svmax) {
8388 vecsv = svargs[efix ? efix-1 : svix++];
8389 vecstr = (U8*)SvPVx(vecsv,veclen);
8390 vec_utf8 = DO_UTF8(vecsv);
8400 i = va_arg(*args, int);
8402 i = (ewix ? ewix <= svmax : svix < svmax) ?
8403 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8405 width = (i < 0) ? -i : i;
8415 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8417 /* XXX: todo, support specified precision parameter */
8421 i = va_arg(*args, int);
8423 i = (ewix ? ewix <= svmax : svix < svmax)
8424 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8425 precis = (i < 0) ? 0 : i;
8430 precis = precis * 10 + (*q++ - '0');
8439 case 'I': /* Ix, I32x, and I64x */
8441 if (q[1] == '6' && q[2] == '4') {
8447 if (q[1] == '3' && q[2] == '2') {
8457 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8468 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8469 if (*(q + 1) == 'l') { /* lld, llf */
8494 argsv = (efix ? efix <= svmax : svix < svmax) ?
8495 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8502 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8504 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8506 eptr = (char*)utf8buf;
8507 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8518 if (args && !vectorize) {
8519 eptr = va_arg(*args, char*);
8521 #ifdef MACOS_TRADITIONAL
8522 /* On MacOS, %#s format is used for Pascal strings */
8527 elen = strlen(eptr);
8530 elen = sizeof nullstr - 1;
8534 eptr = SvPVx(argsv, elen);
8535 if (DO_UTF8(argsv)) {
8536 if (has_precis && precis < elen) {
8538 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8541 if (width) { /* fudge width (can't fudge elen) */
8542 width += elen - sv_len_utf8(argsv);
8551 * The "%_" hack might have to be changed someday,
8552 * if ISO or ANSI decide to use '_' for something.
8553 * So we keep it hidden from users' code.
8555 if (!args || vectorize)
8557 argsv = va_arg(*args, SV*);
8558 eptr = SvPVx(argsv, elen);
8564 if (has_precis && elen > precis)
8571 if (alt || vectorize)
8573 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8591 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8600 esignbuf[esignlen++] = plus;
8604 case 'h': iv = (short)va_arg(*args, int); break;
8605 default: iv = va_arg(*args, int); break;
8606 case 'l': iv = va_arg(*args, long); break;
8607 case 'V': iv = va_arg(*args, IV); break;
8609 case 'q': iv = va_arg(*args, Quad_t); break;
8616 case 'h': iv = (short)iv; break;
8618 case 'l': iv = (long)iv; break;
8621 case 'q': iv = (Quad_t)iv; break;
8625 if ( !vectorize ) /* we already set uv above */
8630 esignbuf[esignlen++] = plus;
8634 esignbuf[esignlen++] = '-';
8677 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8688 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8689 default: uv = va_arg(*args, unsigned); break;
8690 case 'l': uv = va_arg(*args, unsigned long); break;
8691 case 'V': uv = va_arg(*args, UV); break;
8693 case 'q': uv = va_arg(*args, Quad_t); break;
8700 case 'h': uv = (unsigned short)uv; break;
8702 case 'l': uv = (unsigned long)uv; break;
8705 case 'q': uv = (Quad_t)uv; break;
8711 eptr = ebuf + sizeof ebuf;
8717 p = (char*)((c == 'X')
8718 ? "0123456789ABCDEF" : "0123456789abcdef");
8724 esignbuf[esignlen++] = '0';
8725 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8731 *--eptr = '0' + dig;
8733 if (alt && *eptr != '0')
8739 *--eptr = '0' + dig;
8742 esignbuf[esignlen++] = '0';
8743 esignbuf[esignlen++] = 'b';
8746 default: /* it had better be ten or less */
8747 #if defined(PERL_Y2KWARN)
8748 if (ckWARN(WARN_Y2K)) {
8750 char *s = SvPV(sv,n);
8751 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
8752 && (n == 2 || !isDIGIT(s[n-3])))
8754 Perl_warner(aTHX_ packWARN(WARN_Y2K),
8755 "Possible Y2K bug: %%%c %s",
8756 c, "format string following '19'");
8762 *--eptr = '0' + dig;
8763 } while (uv /= base);
8766 elen = (ebuf + sizeof ebuf) - eptr;
8769 zeros = precis - elen;
8770 else if (precis == 0 && elen == 1 && *eptr == '0')
8775 /* FLOATING POINT */
8778 c = 'f'; /* maybe %F isn't supported here */
8784 /* This is evil, but floating point is even more evil */
8786 /* for SV-style calling, we can only get NV
8787 for C-style calling, we assume %f is double;
8788 for simplicity we allow any of %Lf, %llf, %qf for long double
8792 #if defined(USE_LONG_DOUBLE)
8797 #if defined(USE_LONG_DOUBLE)
8798 intsize = args ? 0 : 'q';
8802 #if defined(HAS_LONG_DOUBLE)
8813 /* now we need (long double) if intsize == 'q', else (double) */
8814 nv = (args && !vectorize) ?
8815 #if LONG_DOUBLESIZE > DOUBLESIZE
8817 va_arg(*args, long double) :
8818 va_arg(*args, double)
8820 va_arg(*args, double)
8826 if (c != 'e' && c != 'E') {
8828 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8829 will cast our (long double) to (double) */
8830 (void)Perl_frexp(nv, &i);
8831 if (i == PERL_INT_MIN)
8832 Perl_die(aTHX_ "panic: frexp");
8834 need = BIT_DIGITS(i);
8836 need += has_precis ? precis : 6; /* known default */
8841 #ifdef HAS_LDBL_SPRINTF_BUG
8842 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8843 with sfio - Allen <allens@cpan.org> */
8846 # define MY_DBL_MAX DBL_MAX
8847 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8848 # if DOUBLESIZE >= 8
8849 # define MY_DBL_MAX 1.7976931348623157E+308L
8851 # define MY_DBL_MAX 3.40282347E+38L
8855 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8856 # define MY_DBL_MAX_BUG 1L
8858 # define MY_DBL_MAX_BUG MY_DBL_MAX
8862 # define MY_DBL_MIN DBL_MIN
8863 # else /* XXX guessing! -Allen */
8864 # if DOUBLESIZE >= 8
8865 # define MY_DBL_MIN 2.2250738585072014E-308L
8867 # define MY_DBL_MIN 1.17549435E-38L
8871 if ((intsize == 'q') && (c == 'f') &&
8872 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8874 /* it's going to be short enough that
8875 * long double precision is not needed */
8877 if ((nv <= 0L) && (nv >= -0L))
8878 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8880 /* would use Perl_fp_class as a double-check but not
8881 * functional on IRIX - see perl.h comments */
8883 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8884 /* It's within the range that a double can represent */
8885 #if defined(DBL_MAX) && !defined(DBL_MIN)
8886 if ((nv >= ((long double)1/DBL_MAX)) ||
8887 (nv <= (-(long double)1/DBL_MAX)))
8889 fix_ldbl_sprintf_bug = TRUE;
8892 if (fix_ldbl_sprintf_bug == TRUE) {
8902 # undef MY_DBL_MAX_BUG
8905 #endif /* HAS_LDBL_SPRINTF_BUG */
8907 need += 20; /* fudge factor */
8908 if (PL_efloatsize < need) {
8909 Safefree(PL_efloatbuf);
8910 PL_efloatsize = need + 20; /* more fudge */
8911 New(906, PL_efloatbuf, PL_efloatsize, char);
8912 PL_efloatbuf[0] = '\0';
8915 eptr = ebuf + sizeof ebuf;
8918 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8919 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8920 if (intsize == 'q') {
8921 /* Copy the one or more characters in a long double
8922 * format before the 'base' ([efgEFG]) character to
8923 * the format string. */
8924 static char const prifldbl[] = PERL_PRIfldbl;
8925 char const *p = prifldbl + sizeof(prifldbl) - 3;
8926 while (p >= prifldbl) { *--eptr = *p--; }
8931 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8936 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8948 /* No taint. Otherwise we are in the strange situation
8949 * where printf() taints but print($float) doesn't.
8951 #if defined(HAS_LONG_DOUBLE)
8953 (void)sprintf(PL_efloatbuf, eptr, nv);
8955 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
8957 (void)sprintf(PL_efloatbuf, eptr, nv);
8959 eptr = PL_efloatbuf;
8960 elen = strlen(PL_efloatbuf);
8966 i = SvCUR(sv) - origlen;
8967 if (args && !vectorize) {
8969 case 'h': *(va_arg(*args, short*)) = i; break;
8970 default: *(va_arg(*args, int*)) = i; break;
8971 case 'l': *(va_arg(*args, long*)) = i; break;
8972 case 'V': *(va_arg(*args, IV*)) = i; break;
8974 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8979 sv_setuv_mg(argsv, (UV)i);
8981 continue; /* not "break" */
8988 if (!args && ckWARN(WARN_PRINTF) &&
8989 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
8990 SV *msg = sv_newmortal();
8991 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8992 (PL_op->op_type == OP_PRTF) ? "" : "s");
8995 Perl_sv_catpvf(aTHX_ msg,
8996 "\"%%%c\"", c & 0xFF);
8998 Perl_sv_catpvf(aTHX_ msg,
8999 "\"%%\\%03"UVof"\"",
9002 sv_catpv(msg, "end of string");
9003 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9006 /* output mangled stuff ... */
9012 /* ... right here, because formatting flags should not apply */
9013 SvGROW(sv, SvCUR(sv) + elen + 1);
9015 Copy(eptr, p, elen, char);
9018 SvCUR(sv) = p - SvPVX(sv);
9019 continue; /* not "break" */
9022 if (is_utf8 != has_utf8) {
9025 sv_utf8_upgrade(sv);
9028 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9029 sv_utf8_upgrade(nsv);
9033 SvGROW(sv, SvCUR(sv) + elen + 1);
9038 have = esignlen + zeros + elen;
9039 need = (have > width ? have : width);
9042 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9044 if (esignlen && fill == '0') {
9045 for (i = 0; i < (int)esignlen; i++)
9049 memset(p, fill, gap);
9052 if (esignlen && fill != '0') {
9053 for (i = 0; i < (int)esignlen; i++)
9057 for (i = zeros; i; i--)
9061 Copy(eptr, p, elen, char);
9065 memset(p, ' ', gap);
9070 Copy(dotstr, p, dotstrlen, char);
9074 vectorize = FALSE; /* done iterating over vecstr */
9081 SvCUR(sv) = p - SvPVX(sv);
9089 /* =========================================================================
9091 =head1 Cloning an interpreter
9093 All the macros and functions in this section are for the private use of
9094 the main function, perl_clone().
9096 The foo_dup() functions make an exact copy of an existing foo thinngy.
9097 During the course of a cloning, a hash table is used to map old addresses
9098 to new addresses. The table is created and manipulated with the
9099 ptr_table_* functions.
9103 ============================================================================*/
9106 #if defined(USE_ITHREADS)
9108 #ifndef GpREFCNT_inc
9109 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9113 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9114 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9115 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9116 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9117 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9118 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9119 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9120 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9121 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9122 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9123 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9124 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9125 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9128 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9129 regcomp.c. AMS 20010712 */
9132 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
9136 struct reg_substr_datum *s;
9139 return (REGEXP *)NULL;
9141 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9144 len = r->offsets[0];
9145 npar = r->nparens+1;
9147 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9148 Copy(r->program, ret->program, len+1, regnode);
9150 New(0, ret->startp, npar, I32);
9151 Copy(r->startp, ret->startp, npar, I32);
9152 New(0, ret->endp, npar, I32);
9153 Copy(r->startp, ret->startp, npar, I32);
9155 New(0, ret->substrs, 1, struct reg_substr_data);
9156 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9157 s->min_offset = r->substrs->data[i].min_offset;
9158 s->max_offset = r->substrs->data[i].max_offset;
9159 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9160 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9163 ret->regstclass = NULL;
9166 int count = r->data->count;
9168 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9169 char, struct reg_data);
9170 New(0, d->what, count, U8);
9173 for (i = 0; i < count; i++) {
9174 d->what[i] = r->data->what[i];
9175 switch (d->what[i]) {
9177 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9180 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9183 /* This is cheating. */
9184 New(0, d->data[i], 1, struct regnode_charclass_class);
9185 StructCopy(r->data->data[i], d->data[i],
9186 struct regnode_charclass_class);
9187 ret->regstclass = (regnode*)d->data[i];
9190 /* Compiled op trees are readonly, and can thus be
9191 shared without duplication. */
9192 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9195 d->data[i] = r->data->data[i];
9205 New(0, ret->offsets, 2*len+1, U32);
9206 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9208 ret->precomp = SAVEPV(r->precomp);
9209 ret->refcnt = r->refcnt;
9210 ret->minlen = r->minlen;
9211 ret->prelen = r->prelen;
9212 ret->nparens = r->nparens;
9213 ret->lastparen = r->lastparen;
9214 ret->lastcloseparen = r->lastcloseparen;
9215 ret->reganch = r->reganch;
9217 ret->sublen = r->sublen;
9219 if (RX_MATCH_COPIED(ret))
9220 ret->subbeg = SAVEPV(r->subbeg);
9222 ret->subbeg = Nullch;
9224 ptr_table_store(PL_ptr_table, r, ret);
9228 /* duplicate a file handle */
9231 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9235 return (PerlIO*)NULL;
9237 /* look for it in the table first */
9238 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9242 /* create anew and remember what it is */
9243 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9244 ptr_table_store(PL_ptr_table, fp, ret);
9248 /* duplicate a directory handle */
9251 Perl_dirp_dup(pTHX_ DIR *dp)
9259 /* duplicate a typeglob */
9262 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9267 /* look for it in the table first */
9268 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9272 /* create anew and remember what it is */
9273 Newz(0, ret, 1, GP);
9274 ptr_table_store(PL_ptr_table, gp, ret);
9277 ret->gp_refcnt = 0; /* must be before any other dups! */
9278 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9279 ret->gp_io = io_dup_inc(gp->gp_io, param);
9280 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9281 ret->gp_av = av_dup_inc(gp->gp_av, param);
9282 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9283 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9284 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9285 ret->gp_cvgen = gp->gp_cvgen;
9286 ret->gp_flags = gp->gp_flags;
9287 ret->gp_line = gp->gp_line;
9288 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9292 /* duplicate a chain of magic */
9295 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9297 MAGIC *mgprev = (MAGIC*)NULL;
9300 return (MAGIC*)NULL;
9301 /* look for it in the table first */
9302 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9306 for (; mg; mg = mg->mg_moremagic) {
9308 Newz(0, nmg, 1, MAGIC);
9310 mgprev->mg_moremagic = nmg;
9313 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9314 nmg->mg_private = mg->mg_private;
9315 nmg->mg_type = mg->mg_type;
9316 nmg->mg_flags = mg->mg_flags;
9317 if (mg->mg_type == PERL_MAGIC_qr) {
9318 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9320 else if(mg->mg_type == PERL_MAGIC_backref) {
9321 AV *av = (AV*) mg->mg_obj;
9324 nmg->mg_obj = (SV*)newAV();
9328 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9333 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9334 ? sv_dup_inc(mg->mg_obj, param)
9335 : sv_dup(mg->mg_obj, param);
9337 nmg->mg_len = mg->mg_len;
9338 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9339 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9340 if (mg->mg_len > 0) {
9341 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9342 if (mg->mg_type == PERL_MAGIC_overload_table &&
9343 AMT_AMAGIC((AMT*)mg->mg_ptr))
9345 AMT *amtp = (AMT*)mg->mg_ptr;
9346 AMT *namtp = (AMT*)nmg->mg_ptr;
9348 for (i = 1; i < NofAMmeth; i++) {
9349 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9353 else if (mg->mg_len == HEf_SVKEY)
9354 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9356 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9357 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9364 /* create a new pointer-mapping table */
9367 Perl_ptr_table_new(pTHX)
9370 Newz(0, tbl, 1, PTR_TBL_t);
9373 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9377 /* map an existing pointer using a table */
9380 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
9382 PTR_TBL_ENT_t *tblent;
9383 UV hash = PTR2UV(sv);
9385 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9386 for (; tblent; tblent = tblent->next) {
9387 if (tblent->oldval == sv)
9388 return tblent->newval;
9393 /* add a new entry to a pointer-mapping table */
9396 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
9398 PTR_TBL_ENT_t *tblent, **otblent;
9399 /* XXX this may be pessimal on platforms where pointers aren't good
9400 * hash values e.g. if they grow faster in the most significant
9402 UV hash = PTR2UV(oldv);
9406 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9407 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
9408 if (tblent->oldval == oldv) {
9409 tblent->newval = newv;
9413 Newz(0, tblent, 1, PTR_TBL_ENT_t);
9414 tblent->oldval = oldv;
9415 tblent->newval = newv;
9416 tblent->next = *otblent;
9419 if (i && tbl->tbl_items > tbl->tbl_max)
9420 ptr_table_split(tbl);
9423 /* double the hash bucket size of an existing ptr table */
9426 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9428 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9429 UV oldsize = tbl->tbl_max + 1;
9430 UV newsize = oldsize * 2;
9433 Renew(ary, newsize, PTR_TBL_ENT_t*);
9434 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9435 tbl->tbl_max = --newsize;
9437 for (i=0; i < oldsize; i++, ary++) {
9438 PTR_TBL_ENT_t **curentp, **entp, *ent;
9441 curentp = ary + oldsize;
9442 for (entp = ary, ent = *ary; ent; ent = *entp) {
9443 if ((newsize & PTR2UV(ent->oldval)) != i) {
9445 ent->next = *curentp;
9455 /* remove all the entries from a ptr table */
9458 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9460 register PTR_TBL_ENT_t **array;
9461 register PTR_TBL_ENT_t *entry;
9462 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
9466 if (!tbl || !tbl->tbl_items) {
9470 array = tbl->tbl_ary;
9477 entry = entry->next;
9481 if (++riter > max) {
9484 entry = array[riter];
9491 /* clear and free a ptr table */
9494 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9499 ptr_table_clear(tbl);
9500 Safefree(tbl->tbl_ary);
9508 /* attempt to make everything in the typeglob readonly */
9511 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
9514 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
9516 if (GvIO(gv) || GvFORM(gv)) {
9517 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
9519 else if (!GvCV(gv)) {
9523 /* CvPADLISTs cannot be shared */
9524 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
9529 if (!GvUNIQUE(gv)) {
9531 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
9532 HvNAME(GvSTASH(gv)), GvNAME(gv));
9538 * write attempts will die with
9539 * "Modification of a read-only value attempted"
9545 SvREADONLY_on(GvSV(gv));
9552 SvREADONLY_on(GvAV(gv));
9559 SvREADONLY_on(GvAV(gv));
9562 return sstr; /* he_dup() will SvREFCNT_inc() */
9565 /* duplicate an SV of any type (including AV, HV etc) */
9568 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9571 SvRV(dstr) = SvWEAKREF(sstr)
9572 ? sv_dup(SvRV(sstr), param)
9573 : sv_dup_inc(SvRV(sstr), param);
9575 else if (SvPVX(sstr)) {
9576 /* Has something there */
9578 /* Normal PV - clone whole allocated space */
9579 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9580 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9581 /* Not that normal - actually sstr is copy on write.
9582 But we are a true, independant SV, so: */
9583 SvREADONLY_off(dstr);
9588 /* Special case - not normally malloced for some reason */
9589 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9590 /* A "shared" PV - clone it as unshared string */
9592 SvREADONLY_off(dstr);
9593 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
9596 /* Some other special case - random pointer */
9597 SvPVX(dstr) = SvPVX(sstr);
9603 SvPVX(dstr) = SvPVX(sstr);
9608 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9612 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9614 /* look for it in the table first */
9615 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9619 if(param->flags & CLONEf_JOIN_IN) {
9620 /** We are joining here so we don't want do clone
9621 something that is bad **/
9623 if(SvTYPE(sstr) == SVt_PVHV &&
9625 /** don't clone stashes if they already exist **/
9626 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
9627 return (SV*) old_stash;
9631 /* create anew and remember what it is */
9633 ptr_table_store(PL_ptr_table, sstr, dstr);
9636 SvFLAGS(dstr) = SvFLAGS(sstr);
9637 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9638 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9641 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
9642 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9643 PL_watch_pvx, SvPVX(sstr));
9646 switch (SvTYPE(sstr)) {
9651 SvANY(dstr) = new_XIV();
9652 SvIVX(dstr) = SvIVX(sstr);
9655 SvANY(dstr) = new_XNV();
9656 SvNVX(dstr) = SvNVX(sstr);
9659 SvANY(dstr) = new_XRV();
9660 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9663 SvANY(dstr) = new_XPV();
9664 SvCUR(dstr) = SvCUR(sstr);
9665 SvLEN(dstr) = SvLEN(sstr);
9666 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9669 SvANY(dstr) = new_XPVIV();
9670 SvCUR(dstr) = SvCUR(sstr);
9671 SvLEN(dstr) = SvLEN(sstr);
9672 SvIVX(dstr) = SvIVX(sstr);
9673 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9676 SvANY(dstr) = new_XPVNV();
9677 SvCUR(dstr) = SvCUR(sstr);
9678 SvLEN(dstr) = SvLEN(sstr);
9679 SvIVX(dstr) = SvIVX(sstr);
9680 SvNVX(dstr) = SvNVX(sstr);
9681 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9684 SvANY(dstr) = new_XPVMG();
9685 SvCUR(dstr) = SvCUR(sstr);
9686 SvLEN(dstr) = SvLEN(sstr);
9687 SvIVX(dstr) = SvIVX(sstr);
9688 SvNVX(dstr) = SvNVX(sstr);
9689 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9690 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9691 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9694 SvANY(dstr) = new_XPVBM();
9695 SvCUR(dstr) = SvCUR(sstr);
9696 SvLEN(dstr) = SvLEN(sstr);
9697 SvIVX(dstr) = SvIVX(sstr);
9698 SvNVX(dstr) = SvNVX(sstr);
9699 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9700 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9701 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9702 BmRARE(dstr) = BmRARE(sstr);
9703 BmUSEFUL(dstr) = BmUSEFUL(sstr);
9704 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
9707 SvANY(dstr) = new_XPVLV();
9708 SvCUR(dstr) = SvCUR(sstr);
9709 SvLEN(dstr) = SvLEN(sstr);
9710 SvIVX(dstr) = SvIVX(sstr);
9711 SvNVX(dstr) = SvNVX(sstr);
9712 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9713 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9714 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9715 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
9716 LvTARGLEN(dstr) = LvTARGLEN(sstr);
9717 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
9718 LvTYPE(dstr) = LvTYPE(sstr);
9721 if (GvUNIQUE((GV*)sstr)) {
9723 if ((share = gv_share(sstr, param))) {
9726 ptr_table_store(PL_ptr_table, sstr, dstr);
9728 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
9729 HvNAME(GvSTASH(share)), GvNAME(share));
9734 SvANY(dstr) = new_XPVGV();
9735 SvCUR(dstr) = SvCUR(sstr);
9736 SvLEN(dstr) = SvLEN(sstr);
9737 SvIVX(dstr) = SvIVX(sstr);
9738 SvNVX(dstr) = SvNVX(sstr);
9739 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9740 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9741 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9742 GvNAMELEN(dstr) = GvNAMELEN(sstr);
9743 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
9744 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
9745 GvFLAGS(dstr) = GvFLAGS(sstr);
9746 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9747 (void)GpREFCNT_inc(GvGP(dstr));
9750 SvANY(dstr) = new_XPVIO();
9751 SvCUR(dstr) = SvCUR(sstr);
9752 SvLEN(dstr) = SvLEN(sstr);
9753 SvIVX(dstr) = SvIVX(sstr);
9754 SvNVX(dstr) = SvNVX(sstr);
9755 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9756 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9757 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9758 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
9759 if (IoOFP(sstr) == IoIFP(sstr))
9760 IoOFP(dstr) = IoIFP(dstr);
9762 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
9763 /* PL_rsfp_filters entries have fake IoDIRP() */
9764 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
9765 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
9767 IoDIRP(dstr) = IoDIRP(sstr);
9768 IoLINES(dstr) = IoLINES(sstr);
9769 IoPAGE(dstr) = IoPAGE(sstr);
9770 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
9771 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
9772 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
9773 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
9774 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
9775 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
9776 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
9777 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
9778 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
9779 IoTYPE(dstr) = IoTYPE(sstr);
9780 IoFLAGS(dstr) = IoFLAGS(sstr);
9783 SvANY(dstr) = new_XPVAV();
9784 SvCUR(dstr) = SvCUR(sstr);
9785 SvLEN(dstr) = SvLEN(sstr);
9786 SvIVX(dstr) = SvIVX(sstr);
9787 SvNVX(dstr) = SvNVX(sstr);
9788 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9789 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9790 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
9791 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
9792 if (AvARRAY((AV*)sstr)) {
9793 SV **dst_ary, **src_ary;
9794 SSize_t items = AvFILLp((AV*)sstr) + 1;
9796 src_ary = AvARRAY((AV*)sstr);
9797 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
9798 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9799 SvPVX(dstr) = (char*)dst_ary;
9800 AvALLOC((AV*)dstr) = dst_ary;
9801 if (AvREAL((AV*)sstr)) {
9803 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9807 *dst_ary++ = sv_dup(*src_ary++, param);
9809 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9810 while (items-- > 0) {
9811 *dst_ary++ = &PL_sv_undef;
9815 SvPVX(dstr) = Nullch;
9816 AvALLOC((AV*)dstr) = (SV**)NULL;
9820 SvANY(dstr) = new_XPVHV();
9821 SvCUR(dstr) = SvCUR(sstr);
9822 SvLEN(dstr) = SvLEN(sstr);
9823 SvIVX(dstr) = SvIVX(sstr);
9824 SvNVX(dstr) = SvNVX(sstr);
9825 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9826 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9827 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
9828 if (HvARRAY((HV*)sstr)) {
9830 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
9831 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
9832 Newz(0, dxhv->xhv_array,
9833 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
9834 while (i <= sxhv->xhv_max) {
9835 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
9836 (bool)!!HvSHAREKEYS(sstr),
9840 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
9841 (bool)!!HvSHAREKEYS(sstr), param);
9844 SvPVX(dstr) = Nullch;
9845 HvEITER((HV*)dstr) = (HE*)NULL;
9847 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
9848 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
9849 /* Record stashes for possible cloning in Perl_clone(). */
9850 if(HvNAME((HV*)dstr))
9851 av_push(param->stashes, dstr);
9854 SvANY(dstr) = new_XPVFM();
9855 FmLINES(dstr) = FmLINES(sstr);
9859 SvANY(dstr) = new_XPVCV();
9861 SvCUR(dstr) = SvCUR(sstr);
9862 SvLEN(dstr) = SvLEN(sstr);
9863 SvIVX(dstr) = SvIVX(sstr);
9864 SvNVX(dstr) = SvNVX(sstr);
9865 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9866 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9867 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9868 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
9869 CvSTART(dstr) = CvSTART(sstr);
9870 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
9871 CvXSUB(dstr) = CvXSUB(sstr);
9872 CvXSUBANY(dstr) = CvXSUBANY(sstr);
9873 if (CvCONST(sstr)) {
9874 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
9875 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
9876 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
9878 CvGV(dstr) = gv_dup(CvGV(sstr), param);
9879 if (param->flags & CLONEf_COPY_STACKS) {
9880 CvDEPTH(dstr) = CvDEPTH(sstr);
9884 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9885 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
9888 ? cv_dup( CvOUTSIDE(sstr), param)
9889 : cv_dup_inc(CvOUTSIDE(sstr), param);
9890 CvFLAGS(dstr) = CvFLAGS(sstr);
9891 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
9894 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9898 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9904 /* duplicate a context */
9907 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9912 return (PERL_CONTEXT*)NULL;
9914 /* look for it in the table first */
9915 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9919 /* create anew and remember what it is */
9920 Newz(56, ncxs, max + 1, PERL_CONTEXT);
9921 ptr_table_store(PL_ptr_table, cxs, ncxs);
9924 PERL_CONTEXT *cx = &cxs[ix];
9925 PERL_CONTEXT *ncx = &ncxs[ix];
9926 ncx->cx_type = cx->cx_type;
9927 if (CxTYPE(cx) == CXt_SUBST) {
9928 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9931 ncx->blk_oldsp = cx->blk_oldsp;
9932 ncx->blk_oldcop = cx->blk_oldcop;
9933 ncx->blk_oldretsp = cx->blk_oldretsp;
9934 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9935 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9936 ncx->blk_oldpm = cx->blk_oldpm;
9937 ncx->blk_gimme = cx->blk_gimme;
9938 switch (CxTYPE(cx)) {
9940 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9941 ? cv_dup_inc(cx->blk_sub.cv, param)
9942 : cv_dup(cx->blk_sub.cv,param));
9943 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9944 ? av_dup_inc(cx->blk_sub.argarray, param)
9946 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9947 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9948 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9949 ncx->blk_sub.lval = cx->blk_sub.lval;
9952 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9953 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9954 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9955 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9956 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9959 ncx->blk_loop.label = cx->blk_loop.label;
9960 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9961 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9962 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9963 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9964 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9965 ? cx->blk_loop.iterdata
9966 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9967 ncx->blk_loop.oldcomppad
9968 = (PAD*)ptr_table_fetch(PL_ptr_table,
9969 cx->blk_loop.oldcomppad);
9970 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9971 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9972 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9973 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9974 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9977 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9978 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9979 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9980 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9992 /* duplicate a stack info structure */
9995 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10000 return (PERL_SI*)NULL;
10002 /* look for it in the table first */
10003 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10007 /* create anew and remember what it is */
10008 Newz(56, nsi, 1, PERL_SI);
10009 ptr_table_store(PL_ptr_table, si, nsi);
10011 nsi->si_stack = av_dup_inc(si->si_stack, param);
10012 nsi->si_cxix = si->si_cxix;
10013 nsi->si_cxmax = si->si_cxmax;
10014 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10015 nsi->si_type = si->si_type;
10016 nsi->si_prev = si_dup(si->si_prev, param);
10017 nsi->si_next = si_dup(si->si_next, param);
10018 nsi->si_markoff = si->si_markoff;
10023 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10024 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10025 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10026 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10027 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10028 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10029 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10030 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10031 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10032 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10033 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10034 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10035 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10036 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10039 #define pv_dup_inc(p) SAVEPV(p)
10040 #define pv_dup(p) SAVEPV(p)
10041 #define svp_dup_inc(p,pp) any_dup(p,pp)
10043 /* map any object to the new equivent - either something in the
10044 * ptr table, or something in the interpreter structure
10048 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10053 return (void*)NULL;
10055 /* look for it in the table first */
10056 ret = ptr_table_fetch(PL_ptr_table, v);
10060 /* see if it is part of the interpreter structure */
10061 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10062 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10070 /* duplicate the save stack */
10073 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10075 ANY *ss = proto_perl->Tsavestack;
10076 I32 ix = proto_perl->Tsavestack_ix;
10077 I32 max = proto_perl->Tsavestack_max;
10090 void (*dptr) (void*);
10091 void (*dxptr) (pTHX_ void*);
10094 Newz(54, nss, max, ANY);
10098 TOPINT(nss,ix) = i;
10100 case SAVEt_ITEM: /* normal string */
10101 sv = (SV*)POPPTR(ss,ix);
10102 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10103 sv = (SV*)POPPTR(ss,ix);
10104 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10106 case SAVEt_SV: /* scalar reference */
10107 sv = (SV*)POPPTR(ss,ix);
10108 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10109 gv = (GV*)POPPTR(ss,ix);
10110 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10112 case SAVEt_GENERIC_PVREF: /* generic char* */
10113 c = (char*)POPPTR(ss,ix);
10114 TOPPTR(nss,ix) = pv_dup(c);
10115 ptr = POPPTR(ss,ix);
10116 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10118 case SAVEt_SHARED_PVREF: /* char* in shared space */
10119 c = (char*)POPPTR(ss,ix);
10120 TOPPTR(nss,ix) = savesharedpv(c);
10121 ptr = POPPTR(ss,ix);
10122 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10124 case SAVEt_GENERIC_SVREF: /* generic sv */
10125 case SAVEt_SVREF: /* scalar reference */
10126 sv = (SV*)POPPTR(ss,ix);
10127 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10128 ptr = POPPTR(ss,ix);
10129 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10131 case SAVEt_AV: /* array reference */
10132 av = (AV*)POPPTR(ss,ix);
10133 TOPPTR(nss,ix) = av_dup_inc(av, param);
10134 gv = (GV*)POPPTR(ss,ix);
10135 TOPPTR(nss,ix) = gv_dup(gv, param);
10137 case SAVEt_HV: /* hash reference */
10138 hv = (HV*)POPPTR(ss,ix);
10139 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10140 gv = (GV*)POPPTR(ss,ix);
10141 TOPPTR(nss,ix) = gv_dup(gv, param);
10143 case SAVEt_INT: /* int reference */
10144 ptr = POPPTR(ss,ix);
10145 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10146 intval = (int)POPINT(ss,ix);
10147 TOPINT(nss,ix) = intval;
10149 case SAVEt_LONG: /* long reference */
10150 ptr = POPPTR(ss,ix);
10151 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10152 longval = (long)POPLONG(ss,ix);
10153 TOPLONG(nss,ix) = longval;
10155 case SAVEt_I32: /* I32 reference */
10156 case SAVEt_I16: /* I16 reference */
10157 case SAVEt_I8: /* I8 reference */
10158 ptr = POPPTR(ss,ix);
10159 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10161 TOPINT(nss,ix) = i;
10163 case SAVEt_IV: /* IV reference */
10164 ptr = POPPTR(ss,ix);
10165 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10167 TOPIV(nss,ix) = iv;
10169 case SAVEt_SPTR: /* SV* reference */
10170 ptr = POPPTR(ss,ix);
10171 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10172 sv = (SV*)POPPTR(ss,ix);
10173 TOPPTR(nss,ix) = sv_dup(sv, param);
10175 case SAVEt_VPTR: /* random* reference */
10176 ptr = POPPTR(ss,ix);
10177 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10178 ptr = POPPTR(ss,ix);
10179 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10181 case SAVEt_PPTR: /* char* reference */
10182 ptr = POPPTR(ss,ix);
10183 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10184 c = (char*)POPPTR(ss,ix);
10185 TOPPTR(nss,ix) = pv_dup(c);
10187 case SAVEt_HPTR: /* HV* reference */
10188 ptr = POPPTR(ss,ix);
10189 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10190 hv = (HV*)POPPTR(ss,ix);
10191 TOPPTR(nss,ix) = hv_dup(hv, param);
10193 case SAVEt_APTR: /* AV* reference */
10194 ptr = POPPTR(ss,ix);
10195 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10196 av = (AV*)POPPTR(ss,ix);
10197 TOPPTR(nss,ix) = av_dup(av, param);
10200 gv = (GV*)POPPTR(ss,ix);
10201 TOPPTR(nss,ix) = gv_dup(gv, param);
10203 case SAVEt_GP: /* scalar reference */
10204 gp = (GP*)POPPTR(ss,ix);
10205 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10206 (void)GpREFCNT_inc(gp);
10207 gv = (GV*)POPPTR(ss,ix);
10208 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10209 c = (char*)POPPTR(ss,ix);
10210 TOPPTR(nss,ix) = pv_dup(c);
10212 TOPIV(nss,ix) = iv;
10214 TOPIV(nss,ix) = iv;
10217 case SAVEt_MORTALIZESV:
10218 sv = (SV*)POPPTR(ss,ix);
10219 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10222 ptr = POPPTR(ss,ix);
10223 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10224 /* these are assumed to be refcounted properly */
10225 switch (((OP*)ptr)->op_type) {
10227 case OP_LEAVESUBLV:
10231 case OP_LEAVEWRITE:
10232 TOPPTR(nss,ix) = ptr;
10237 TOPPTR(nss,ix) = Nullop;
10242 TOPPTR(nss,ix) = Nullop;
10245 c = (char*)POPPTR(ss,ix);
10246 TOPPTR(nss,ix) = pv_dup_inc(c);
10248 case SAVEt_CLEARSV:
10249 longval = POPLONG(ss,ix);
10250 TOPLONG(nss,ix) = longval;
10253 hv = (HV*)POPPTR(ss,ix);
10254 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10255 c = (char*)POPPTR(ss,ix);
10256 TOPPTR(nss,ix) = pv_dup_inc(c);
10258 TOPINT(nss,ix) = i;
10260 case SAVEt_DESTRUCTOR:
10261 ptr = POPPTR(ss,ix);
10262 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10263 dptr = POPDPTR(ss,ix);
10264 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
10266 case SAVEt_DESTRUCTOR_X:
10267 ptr = POPPTR(ss,ix);
10268 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10269 dxptr = POPDXPTR(ss,ix);
10270 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
10272 case SAVEt_REGCONTEXT:
10275 TOPINT(nss,ix) = i;
10278 case SAVEt_STACK_POS: /* Position on Perl stack */
10280 TOPINT(nss,ix) = i;
10282 case SAVEt_AELEM: /* array element */
10283 sv = (SV*)POPPTR(ss,ix);
10284 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10286 TOPINT(nss,ix) = i;
10287 av = (AV*)POPPTR(ss,ix);
10288 TOPPTR(nss,ix) = av_dup_inc(av, param);
10290 case SAVEt_HELEM: /* hash element */
10291 sv = (SV*)POPPTR(ss,ix);
10292 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10293 sv = (SV*)POPPTR(ss,ix);
10294 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10295 hv = (HV*)POPPTR(ss,ix);
10296 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10299 ptr = POPPTR(ss,ix);
10300 TOPPTR(nss,ix) = ptr;
10304 TOPINT(nss,ix) = i;
10306 case SAVEt_COMPPAD:
10307 av = (AV*)POPPTR(ss,ix);
10308 TOPPTR(nss,ix) = av_dup(av, param);
10311 longval = (long)POPLONG(ss,ix);
10312 TOPLONG(nss,ix) = longval;
10313 ptr = POPPTR(ss,ix);
10314 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10315 sv = (SV*)POPPTR(ss,ix);
10316 TOPPTR(nss,ix) = sv_dup(sv, param);
10319 ptr = POPPTR(ss,ix);
10320 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10321 longval = (long)POPBOOL(ss,ix);
10322 TOPBOOL(nss,ix) = (bool)longval;
10325 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10333 =for apidoc perl_clone
10335 Create and return a new interpreter by cloning the current one.
10337 perl_clone takes these flags as paramters:
10339 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10340 without it we only clone the data and zero the stacks,
10341 with it we copy the stacks and the new perl interpreter is
10342 ready to run at the exact same point as the previous one.
10343 The pseudo-fork code uses COPY_STACKS while the
10344 threads->new doesn't.
10346 CLONEf_KEEP_PTR_TABLE
10347 perl_clone keeps a ptr_table with the pointer of the old
10348 variable as a key and the new variable as a value,
10349 this allows it to check if something has been cloned and not
10350 clone it again but rather just use the value and increase the
10351 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10352 the ptr_table using the function
10353 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10354 reason to keep it around is if you want to dup some of your own
10355 variable who are outside the graph perl scans, example of this
10356 code is in threads.xs create
10359 This is a win32 thing, it is ignored on unix, it tells perls
10360 win32host code (which is c++) to clone itself, this is needed on
10361 win32 if you want to run two threads at the same time,
10362 if you just want to do some stuff in a separate perl interpreter
10363 and then throw it away and return to the original one,
10364 you don't need to do anything.
10369 /* XXX the above needs expanding by someone who actually understands it ! */
10370 EXTERN_C PerlInterpreter *
10371 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10374 perl_clone(PerlInterpreter *proto_perl, UV flags)
10376 #ifdef PERL_IMPLICIT_SYS
10378 /* perlhost.h so we need to call into it
10379 to clone the host, CPerlHost should have a c interface, sky */
10381 if (flags & CLONEf_CLONE_HOST) {
10382 return perl_clone_host(proto_perl,flags);
10384 return perl_clone_using(proto_perl, flags,
10386 proto_perl->IMemShared,
10387 proto_perl->IMemParse,
10389 proto_perl->IStdIO,
10393 proto_perl->IProc);
10397 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10398 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10399 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10400 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10401 struct IPerlDir* ipD, struct IPerlSock* ipS,
10402 struct IPerlProc* ipP)
10404 /* XXX many of the string copies here can be optimized if they're
10405 * constants; they need to be allocated as common memory and just
10406 * their pointers copied. */
10409 CLONE_PARAMS clone_params;
10410 CLONE_PARAMS* param = &clone_params;
10412 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10413 PERL_SET_THX(my_perl);
10416 Poison(my_perl, 1, PerlInterpreter);
10421 PL_sig_pending = 0;
10422 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10423 # else /* !DEBUGGING */
10424 Zero(my_perl, 1, PerlInterpreter);
10425 # endif /* DEBUGGING */
10427 /* host pointers */
10429 PL_MemShared = ipMS;
10430 PL_MemParse = ipMP;
10437 #else /* !PERL_IMPLICIT_SYS */
10439 CLONE_PARAMS clone_params;
10440 CLONE_PARAMS* param = &clone_params;
10441 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10442 PERL_SET_THX(my_perl);
10447 Poison(my_perl, 1, PerlInterpreter);
10452 PL_sig_pending = 0;
10453 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10454 # else /* !DEBUGGING */
10455 Zero(my_perl, 1, PerlInterpreter);
10456 # endif /* DEBUGGING */
10457 #endif /* PERL_IMPLICIT_SYS */
10458 param->flags = flags;
10459 param->proto_perl = proto_perl;
10462 PL_xiv_arenaroot = NULL;
10463 PL_xiv_root = NULL;
10464 PL_xnv_arenaroot = NULL;
10465 PL_xnv_root = NULL;
10466 PL_xrv_arenaroot = NULL;
10467 PL_xrv_root = NULL;
10468 PL_xpv_arenaroot = NULL;
10469 PL_xpv_root = NULL;
10470 PL_xpviv_arenaroot = NULL;
10471 PL_xpviv_root = NULL;
10472 PL_xpvnv_arenaroot = NULL;
10473 PL_xpvnv_root = NULL;
10474 PL_xpvcv_arenaroot = NULL;
10475 PL_xpvcv_root = NULL;
10476 PL_xpvav_arenaroot = NULL;
10477 PL_xpvav_root = NULL;
10478 PL_xpvhv_arenaroot = NULL;
10479 PL_xpvhv_root = NULL;
10480 PL_xpvmg_arenaroot = NULL;
10481 PL_xpvmg_root = NULL;
10482 PL_xpvlv_arenaroot = NULL;
10483 PL_xpvlv_root = NULL;
10484 PL_xpvbm_arenaroot = NULL;
10485 PL_xpvbm_root = NULL;
10486 PL_he_arenaroot = NULL;
10488 PL_nice_chunk = NULL;
10489 PL_nice_chunk_size = 0;
10491 PL_sv_objcount = 0;
10492 PL_sv_root = Nullsv;
10493 PL_sv_arenaroot = Nullsv;
10495 PL_debug = proto_perl->Idebug;
10497 #ifdef USE_REENTRANT_API
10498 Perl_reentrant_init(aTHX);
10501 /* create SV map for pointer relocation */
10502 PL_ptr_table = ptr_table_new();
10504 /* initialize these special pointers as early as possible */
10505 SvANY(&PL_sv_undef) = NULL;
10506 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10507 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10508 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10510 SvANY(&PL_sv_no) = new_XPVNV();
10511 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10512 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10513 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
10514 SvCUR(&PL_sv_no) = 0;
10515 SvLEN(&PL_sv_no) = 1;
10516 SvNVX(&PL_sv_no) = 0;
10517 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10519 SvANY(&PL_sv_yes) = new_XPVNV();
10520 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10521 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10522 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
10523 SvCUR(&PL_sv_yes) = 1;
10524 SvLEN(&PL_sv_yes) = 2;
10525 SvNVX(&PL_sv_yes) = 1;
10526 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10528 /* create (a non-shared!) shared string table */
10529 PL_strtab = newHV();
10530 HvSHAREKEYS_off(PL_strtab);
10531 hv_ksplit(PL_strtab, 512);
10532 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10534 PL_compiling = proto_perl->Icompiling;
10536 /* These two PVs will be free'd special way so must set them same way op.c does */
10537 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10538 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10540 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10541 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10543 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10544 if (!specialWARN(PL_compiling.cop_warnings))
10545 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10546 if (!specialCopIO(PL_compiling.cop_io))
10547 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10548 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10550 /* pseudo environmental stuff */
10551 PL_origargc = proto_perl->Iorigargc;
10552 PL_origargv = proto_perl->Iorigargv;
10554 param->stashes = newAV(); /* Setup array of objects to call clone on */
10556 #ifdef PERLIO_LAYERS
10557 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10558 PerlIO_clone(aTHX_ proto_perl, param);
10561 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10562 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10563 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10564 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10565 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10566 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10569 PL_minus_c = proto_perl->Iminus_c;
10570 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10571 PL_localpatches = proto_perl->Ilocalpatches;
10572 PL_splitstr = proto_perl->Isplitstr;
10573 PL_preprocess = proto_perl->Ipreprocess;
10574 PL_minus_n = proto_perl->Iminus_n;
10575 PL_minus_p = proto_perl->Iminus_p;
10576 PL_minus_l = proto_perl->Iminus_l;
10577 PL_minus_a = proto_perl->Iminus_a;
10578 PL_minus_F = proto_perl->Iminus_F;
10579 PL_doswitches = proto_perl->Idoswitches;
10580 PL_dowarn = proto_perl->Idowarn;
10581 PL_doextract = proto_perl->Idoextract;
10582 PL_sawampersand = proto_perl->Isawampersand;
10583 PL_unsafe = proto_perl->Iunsafe;
10584 PL_inplace = SAVEPV(proto_perl->Iinplace);
10585 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10586 PL_perldb = proto_perl->Iperldb;
10587 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10588 PL_exit_flags = proto_perl->Iexit_flags;
10590 /* magical thingies */
10591 /* XXX time(&PL_basetime) when asked for? */
10592 PL_basetime = proto_perl->Ibasetime;
10593 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10595 PL_maxsysfd = proto_perl->Imaxsysfd;
10596 PL_multiline = proto_perl->Imultiline;
10597 PL_statusvalue = proto_perl->Istatusvalue;
10599 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10601 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10603 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10604 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10605 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10607 /* Clone the regex array */
10608 PL_regex_padav = newAV();
10610 I32 len = av_len((AV*)proto_perl->Iregex_padav);
10611 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10612 av_push(PL_regex_padav,
10613 sv_dup_inc(regexen[0],param));
10614 for(i = 1; i <= len; i++) {
10615 if(SvREPADTMP(regexen[i])) {
10616 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10618 av_push(PL_regex_padav,
10620 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10621 SvIVX(regexen[i])), param)))
10626 PL_regex_pad = AvARRAY(PL_regex_padav);
10628 /* shortcuts to various I/O objects */
10629 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10630 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10631 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10632 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10633 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10634 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10636 /* shortcuts to regexp stuff */
10637 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10639 /* shortcuts to misc objects */
10640 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10642 /* shortcuts to debugging objects */
10643 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10644 PL_DBline = gv_dup(proto_perl->IDBline, param);
10645 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10646 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10647 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10648 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10649 PL_lineary = av_dup(proto_perl->Ilineary, param);
10650 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10652 /* symbol tables */
10653 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10654 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10655 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10656 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10657 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10659 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10660 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10661 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10662 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10663 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10664 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10666 PL_sub_generation = proto_perl->Isub_generation;
10668 /* funky return mechanisms */
10669 PL_forkprocess = proto_perl->Iforkprocess;
10671 /* subprocess state */
10672 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10674 /* internal state */
10675 PL_tainting = proto_perl->Itainting;
10676 PL_maxo = proto_perl->Imaxo;
10677 if (proto_perl->Iop_mask)
10678 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10680 PL_op_mask = Nullch;
10682 /* current interpreter roots */
10683 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10684 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10685 PL_main_start = proto_perl->Imain_start;
10686 PL_eval_root = proto_perl->Ieval_root;
10687 PL_eval_start = proto_perl->Ieval_start;
10689 /* runtime control stuff */
10690 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10691 PL_copline = proto_perl->Icopline;
10693 PL_filemode = proto_perl->Ifilemode;
10694 PL_lastfd = proto_perl->Ilastfd;
10695 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10698 PL_gensym = proto_perl->Igensym;
10699 PL_preambled = proto_perl->Ipreambled;
10700 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10701 PL_laststatval = proto_perl->Ilaststatval;
10702 PL_laststype = proto_perl->Ilaststype;
10703 PL_mess_sv = Nullsv;
10705 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10706 PL_ofmt = SAVEPV(proto_perl->Iofmt);
10708 /* interpreter atexit processing */
10709 PL_exitlistlen = proto_perl->Iexitlistlen;
10710 if (PL_exitlistlen) {
10711 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10712 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10715 PL_exitlist = (PerlExitListEntry*)NULL;
10716 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10717 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10718 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10720 PL_profiledata = NULL;
10721 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10722 /* PL_rsfp_filters entries have fake IoDIRP() */
10723 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10725 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10727 PAD_CLONE_VARS(proto_perl, param);
10729 #ifdef HAVE_INTERP_INTERN
10730 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10733 /* more statics moved here */
10734 PL_generation = proto_perl->Igeneration;
10735 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10737 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10738 PL_in_clean_all = proto_perl->Iin_clean_all;
10740 PL_uid = proto_perl->Iuid;
10741 PL_euid = proto_perl->Ieuid;
10742 PL_gid = proto_perl->Igid;
10743 PL_egid = proto_perl->Iegid;
10744 PL_nomemok = proto_perl->Inomemok;
10745 PL_an = proto_perl->Ian;
10746 PL_op_seqmax = proto_perl->Iop_seqmax;
10747 PL_evalseq = proto_perl->Ievalseq;
10748 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10749 PL_origalen = proto_perl->Iorigalen;
10750 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10751 PL_osname = SAVEPV(proto_perl->Iosname);
10752 PL_sh_path = proto_perl->Ish_path; /* XXX never deallocated */
10753 PL_sighandlerp = proto_perl->Isighandlerp;
10756 PL_runops = proto_perl->Irunops;
10758 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10761 PL_cshlen = proto_perl->Icshlen;
10762 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10765 PL_lex_state = proto_perl->Ilex_state;
10766 PL_lex_defer = proto_perl->Ilex_defer;
10767 PL_lex_expect = proto_perl->Ilex_expect;
10768 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10769 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10770 PL_lex_starts = proto_perl->Ilex_starts;
10771 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10772 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10773 PL_lex_op = proto_perl->Ilex_op;
10774 PL_lex_inpat = proto_perl->Ilex_inpat;
10775 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10776 PL_lex_brackets = proto_perl->Ilex_brackets;
10777 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10778 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10779 PL_lex_casemods = proto_perl->Ilex_casemods;
10780 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10781 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10783 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10784 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10785 PL_nexttoke = proto_perl->Inexttoke;
10787 /* XXX This is probably masking the deeper issue of why
10788 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10789 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10790 * (A little debugging with a watchpoint on it may help.)
10792 if (SvANY(proto_perl->Ilinestr)) {
10793 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10794 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
10795 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10796 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
10797 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10798 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
10799 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10800 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
10801 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10804 PL_linestr = NEWSV(65,79);
10805 sv_upgrade(PL_linestr,SVt_PVIV);
10806 sv_setpvn(PL_linestr,"",0);
10807 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10809 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10810 PL_pending_ident = proto_perl->Ipending_ident;
10811 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10813 PL_expect = proto_perl->Iexpect;
10815 PL_multi_start = proto_perl->Imulti_start;
10816 PL_multi_end = proto_perl->Imulti_end;
10817 PL_multi_open = proto_perl->Imulti_open;
10818 PL_multi_close = proto_perl->Imulti_close;
10820 PL_error_count = proto_perl->Ierror_count;
10821 PL_subline = proto_perl->Isubline;
10822 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10824 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10825 if (SvANY(proto_perl->Ilinestr)) {
10826 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
10827 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10828 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
10829 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10830 PL_last_lop_op = proto_perl->Ilast_lop_op;
10833 PL_last_uni = SvPVX(PL_linestr);
10834 PL_last_lop = SvPVX(PL_linestr);
10835 PL_last_lop_op = 0;
10837 PL_in_my = proto_perl->Iin_my;
10838 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10840 PL_cryptseen = proto_perl->Icryptseen;
10843 PL_hints = proto_perl->Ihints;
10845 PL_amagic_generation = proto_perl->Iamagic_generation;
10847 #ifdef USE_LOCALE_COLLATE
10848 PL_collation_ix = proto_perl->Icollation_ix;
10849 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10850 PL_collation_standard = proto_perl->Icollation_standard;
10851 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10852 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10853 #endif /* USE_LOCALE_COLLATE */
10855 #ifdef USE_LOCALE_NUMERIC
10856 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10857 PL_numeric_standard = proto_perl->Inumeric_standard;
10858 PL_numeric_local = proto_perl->Inumeric_local;
10859 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10860 #endif /* !USE_LOCALE_NUMERIC */
10862 /* utf8 character classes */
10863 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10864 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10865 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10866 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10867 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10868 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10869 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10870 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10871 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10872 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10873 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10874 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10875 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10876 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10877 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10878 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10879 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10880 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10881 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10882 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10885 PL_last_swash_hv = Nullhv; /* reinits on demand */
10886 PL_last_swash_klen = 0;
10887 PL_last_swash_key[0]= '\0';
10888 PL_last_swash_tmps = (U8*)NULL;
10889 PL_last_swash_slen = 0;
10891 /* perly.c globals */
10892 PL_yydebug = proto_perl->Iyydebug;
10893 PL_yynerrs = proto_perl->Iyynerrs;
10894 PL_yyerrflag = proto_perl->Iyyerrflag;
10895 PL_yychar = proto_perl->Iyychar;
10896 PL_yyval = proto_perl->Iyyval;
10897 PL_yylval = proto_perl->Iyylval;
10899 PL_glob_index = proto_perl->Iglob_index;
10900 PL_srand_called = proto_perl->Isrand_called;
10901 PL_uudmap['M'] = 0; /* reinits on demand */
10902 PL_bitcount = Nullch; /* reinits on demand */
10904 if (proto_perl->Ipsig_pend) {
10905 Newz(0, PL_psig_pend, SIG_SIZE, int);
10908 PL_psig_pend = (int*)NULL;
10911 if (proto_perl->Ipsig_ptr) {
10912 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
10913 Newz(0, PL_psig_name, SIG_SIZE, SV*);
10914 for (i = 1; i < SIG_SIZE; i++) {
10915 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10916 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10920 PL_psig_ptr = (SV**)NULL;
10921 PL_psig_name = (SV**)NULL;
10924 /* thrdvar.h stuff */
10926 if (flags & CLONEf_COPY_STACKS) {
10927 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10928 PL_tmps_ix = proto_perl->Ttmps_ix;
10929 PL_tmps_max = proto_perl->Ttmps_max;
10930 PL_tmps_floor = proto_perl->Ttmps_floor;
10931 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
10933 while (i <= PL_tmps_ix) {
10934 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10938 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10939 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10940 Newz(54, PL_markstack, i, I32);
10941 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10942 - proto_perl->Tmarkstack);
10943 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10944 - proto_perl->Tmarkstack);
10945 Copy(proto_perl->Tmarkstack, PL_markstack,
10946 PL_markstack_ptr - PL_markstack + 1, I32);
10948 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10949 * NOTE: unlike the others! */
10950 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10951 PL_scopestack_max = proto_perl->Tscopestack_max;
10952 Newz(54, PL_scopestack, PL_scopestack_max, I32);
10953 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10955 /* next push_return() sets PL_retstack[PL_retstack_ix]
10956 * NOTE: unlike the others! */
10957 PL_retstack_ix = proto_perl->Tretstack_ix;
10958 PL_retstack_max = proto_perl->Tretstack_max;
10959 Newz(54, PL_retstack, PL_retstack_max, OP*);
10960 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
10962 /* NOTE: si_dup() looks at PL_markstack */
10963 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10965 /* PL_curstack = PL_curstackinfo->si_stack; */
10966 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10967 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10969 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10970 PL_stack_base = AvARRAY(PL_curstack);
10971 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10972 - proto_perl->Tstack_base);
10973 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10975 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10976 * NOTE: unlike the others! */
10977 PL_savestack_ix = proto_perl->Tsavestack_ix;
10978 PL_savestack_max = proto_perl->Tsavestack_max;
10979 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
10980 PL_savestack = ss_dup(proto_perl, param);
10984 ENTER; /* perl_destruct() wants to LEAVE; */
10987 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10988 PL_top_env = &PL_start_env;
10990 PL_op = proto_perl->Top;
10993 PL_Xpv = (XPV*)NULL;
10994 PL_na = proto_perl->Tna;
10996 PL_statbuf = proto_perl->Tstatbuf;
10997 PL_statcache = proto_perl->Tstatcache;
10998 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10999 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11001 PL_timesbuf = proto_perl->Ttimesbuf;
11004 PL_tainted = proto_perl->Ttainted;
11005 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11006 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11007 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11008 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11009 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11010 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11011 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11012 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11013 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11015 PL_restartop = proto_perl->Trestartop;
11016 PL_in_eval = proto_perl->Tin_eval;
11017 PL_delaymagic = proto_perl->Tdelaymagic;
11018 PL_dirty = proto_perl->Tdirty;
11019 PL_localizing = proto_perl->Tlocalizing;
11021 #ifdef PERL_FLEXIBLE_EXCEPTIONS
11022 PL_protect = proto_perl->Tprotect;
11024 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11025 PL_av_fetch_sv = Nullsv;
11026 PL_hv_fetch_sv = Nullsv;
11027 Zero(&PL_hv_fetch_ent_mh, 1, HE); /* XXX */
11028 PL_modcount = proto_perl->Tmodcount;
11029 PL_lastgotoprobe = Nullop;
11030 PL_dumpindent = proto_perl->Tdumpindent;
11032 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11033 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11034 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11035 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11036 PL_sortcxix = proto_perl->Tsortcxix;
11037 PL_efloatbuf = Nullch; /* reinits on demand */
11038 PL_efloatsize = 0; /* reinits on demand */
11042 PL_screamfirst = NULL;
11043 PL_screamnext = NULL;
11044 PL_maxscream = -1; /* reinits on demand */
11045 PL_lastscream = Nullsv;
11047 PL_watchaddr = NULL;
11048 PL_watchok = Nullch;
11050 PL_regdummy = proto_perl->Tregdummy;
11051 PL_regprecomp = Nullch;
11054 PL_colorset = 0; /* reinits PL_colors[] */
11055 /*PL_colors[6] = {0,0,0,0,0,0};*/
11056 PL_reginput = Nullch;
11057 PL_regbol = Nullch;
11058 PL_regeol = Nullch;
11059 PL_regstartp = (I32*)NULL;
11060 PL_regendp = (I32*)NULL;
11061 PL_reglastparen = (U32*)NULL;
11062 PL_regtill = Nullch;
11063 PL_reg_start_tmp = (char**)NULL;
11064 PL_reg_start_tmpl = 0;
11065 PL_regdata = (struct reg_data*)NULL;
11068 PL_reg_eval_set = 0;
11070 PL_regprogram = (regnode*)NULL;
11072 PL_regcc = (CURCUR*)NULL;
11073 PL_reg_call_cc = (struct re_cc_state*)NULL;
11074 PL_reg_re = (regexp*)NULL;
11075 PL_reg_ganch = Nullch;
11076 PL_reg_sv = Nullsv;
11077 PL_reg_match_utf8 = FALSE;
11078 PL_reg_magic = (MAGIC*)NULL;
11080 PL_reg_oldcurpm = (PMOP*)NULL;
11081 PL_reg_curpm = (PMOP*)NULL;
11082 PL_reg_oldsaved = Nullch;
11083 PL_reg_oldsavedlen = 0;
11084 PL_reg_maxiter = 0;
11085 PL_reg_leftiter = 0;
11086 PL_reg_poscache = Nullch;
11087 PL_reg_poscache_size= 0;
11089 /* RE engine - function pointers */
11090 PL_regcompp = proto_perl->Tregcompp;
11091 PL_regexecp = proto_perl->Tregexecp;
11092 PL_regint_start = proto_perl->Tregint_start;
11093 PL_regint_string = proto_perl->Tregint_string;
11094 PL_regfree = proto_perl->Tregfree;
11096 PL_reginterp_cnt = 0;
11097 PL_reg_starttry = 0;
11099 /* Pluggable optimizer */
11100 PL_peepp = proto_perl->Tpeepp;
11102 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11103 ptr_table_free(PL_ptr_table);
11104 PL_ptr_table = NULL;
11107 /* Call the ->CLONE method, if it exists, for each of the stashes
11108 identified by sv_dup() above.
11110 while(av_len(param->stashes) != -1) {
11111 HV* stash = (HV*) av_shift(param->stashes);
11112 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11113 if (cloner && GvCV(cloner)) {
11118 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
11120 call_sv((SV*)GvCV(cloner), G_DISCARD);
11126 SvREFCNT_dec(param->stashes);
11131 #endif /* USE_ITHREADS */
11134 =head1 Unicode Support
11136 =for apidoc sv_recode_to_utf8
11138 The encoding is assumed to be an Encode object, on entry the PV
11139 of the sv is assumed to be octets in that encoding, and the sv
11140 will be converted into Unicode (and UTF-8).
11142 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11143 is not a reference, nothing is done to the sv. If the encoding is not
11144 an C<Encode::XS> Encoding object, bad things will happen.
11145 (See F<lib/encoding.pm> and L<Encode>).
11147 The PV of the sv is returned.
11152 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11154 if (SvPOK(sv) && !DO_UTF8(sv) && SvROK(encoding)) {
11168 Passing sv_yes is wrong - it needs to be or'ed set of constants
11169 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11170 remove converted chars from source.
11172 Both will default the value - let them.
11174 XPUSHs(&PL_sv_yes);
11177 call_method("decode", G_SCALAR);
11181 s = SvPV(uni, len);
11183 U8 *t = (U8 *)s, *e = (U8 *)s + len;
11185 if ((vary = !UTF8_IS_INVARIANT(*t++)))
11189 if (s != SvPVX(sv)) {
11190 SvGROW(sv, len + 1);
11191 Move(s, SvPVX(sv), len, char);
11192 SvCUR_set(sv, len);
11193 SvPVX(sv)[len] = 0;