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] == (STRLEN)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] > (STRLEN)uoff) {
5585 backw = (*cachep)[i] - (STRLEN)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);
5597 if ((STRLEN)uoff < ulen) {
5598 forw = (STRLEN)uoff - (*cachep)[i];
5599 backw = ulen - (STRLEN)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] = (STRLEN)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];
5794 while (UTF8_IS_CONTINUATION(*p))
5810 /* Call utf8n_to_uvchr() to validate the sequence
5811 * (unless a simple non-UTF character) */
5812 if (!UTF8_IS_INVARIANT(*s))
5813 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5822 if (!SvREADONLY(sv)) {
5824 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5825 mg = mg_find(sv, PERL_MAGIC_utf8);
5830 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5831 mg->mg_ptr = (char *) cache;
5836 cache[1] = *offsetp;
5847 Returns a boolean indicating whether the strings in the two SVs are
5848 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5849 coerce its args to strings if necessary.
5855 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5863 SV* svrecode = Nullsv;
5870 pv1 = SvPV(sv1, cur1);
5877 pv2 = SvPV(sv2, cur2);
5879 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5880 /* Differing utf8ness.
5881 * Do not UTF8size the comparands as a side-effect. */
5884 svrecode = newSVpvn(pv2, cur2);
5885 sv_recode_to_utf8(svrecode, PL_encoding);
5886 pv2 = SvPV(svrecode, cur2);
5889 svrecode = newSVpvn(pv1, cur1);
5890 sv_recode_to_utf8(svrecode, PL_encoding);
5891 pv1 = SvPV(svrecode, cur1);
5893 /* Now both are in UTF-8. */
5898 bool is_utf8 = TRUE;
5901 /* sv1 is the UTF-8 one,
5902 * if is equal it must be downgrade-able */
5903 char *pv = (char*)bytes_from_utf8((U8*)pv1,
5909 /* sv2 is the UTF-8 one,
5910 * if is equal it must be downgrade-able */
5911 char *pv = (char *)bytes_from_utf8((U8*)pv2,
5917 /* Downgrade not possible - cannot be eq */
5924 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5927 SvREFCNT_dec(svrecode);
5938 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5939 string in C<sv1> is less than, equal to, or greater than the string in
5940 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5941 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5947 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5950 char *pv1, *pv2, *tpv = Nullch;
5952 SV *svrecode = Nullsv;
5959 pv1 = SvPV(sv1, cur1);
5966 pv2 = SvPV(sv2, cur2);
5968 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5969 /* Differing utf8ness.
5970 * Do not UTF8size the comparands as a side-effect. */
5973 svrecode = newSVpvn(pv2, cur2);
5974 sv_recode_to_utf8(svrecode, PL_encoding);
5975 pv2 = SvPV(svrecode, cur2);
5978 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
5983 svrecode = newSVpvn(pv1, cur1);
5984 sv_recode_to_utf8(svrecode, PL_encoding);
5985 pv1 = SvPV(svrecode, cur1);
5988 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
5994 cmp = cur2 ? -1 : 0;
5998 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6001 cmp = retval < 0 ? -1 : 1;
6002 } else if (cur1 == cur2) {
6005 cmp = cur1 < cur2 ? -1 : 1;
6010 SvREFCNT_dec(svrecode);
6019 =for apidoc sv_cmp_locale
6021 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6022 'use bytes' aware, handles get magic, and will coerce its args to strings
6023 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6029 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6031 #ifdef USE_LOCALE_COLLATE
6037 if (PL_collation_standard)
6041 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6043 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6045 if (!pv1 || !len1) {
6056 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6059 return retval < 0 ? -1 : 1;
6062 * When the result of collation is equality, that doesn't mean
6063 * that there are no differences -- some locales exclude some
6064 * characters from consideration. So to avoid false equalities,
6065 * we use the raw string as a tiebreaker.
6071 #endif /* USE_LOCALE_COLLATE */
6073 return sv_cmp(sv1, sv2);
6077 #ifdef USE_LOCALE_COLLATE
6080 =for apidoc sv_collxfrm
6082 Add Collate Transform magic to an SV if it doesn't already have it.
6084 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6085 scalar data of the variable, but transformed to such a format that a normal
6086 memory comparison can be used to compare the data according to the locale
6093 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6097 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6098 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6103 Safefree(mg->mg_ptr);
6105 if ((xf = mem_collxfrm(s, len, &xlen))) {
6106 if (SvREADONLY(sv)) {
6109 return xf + sizeof(PL_collation_ix);
6112 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6113 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6126 if (mg && mg->mg_ptr) {
6128 return mg->mg_ptr + sizeof(PL_collation_ix);
6136 #endif /* USE_LOCALE_COLLATE */
6141 Get a line from the filehandle and store it into the SV, optionally
6142 appending to the currently-stored string.
6148 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6152 register STDCHAR rslast;
6153 register STDCHAR *bp;
6159 SV_CHECK_THINKFIRST_COW_DROP(sv);
6160 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6162 However, perlbench says it's slower, because the existing swipe code
6163 is faster than copy on write.
6164 Swings and roundabouts. */
6165 (void)SvUPGRADE(sv, SVt_PV);
6168 SvPOK_only(sv); /* Validate pointer */
6170 if (PL_curcop == &PL_compiling) {
6171 /* we always read code in line mode */
6175 else if (RsSNARF(PL_rs)) {
6177 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && st.st_size
6178 && (recsize = st.st_size - PerlIO_tell(fp)))
6183 else if (RsRECORD(PL_rs)) {
6187 /* Grab the size of the record we're getting */
6188 recsize = SvIV(SvRV(PL_rs));
6191 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6194 /* VMS wants read instead of fread, because fread doesn't respect */
6195 /* RMS record boundaries. This is not necessarily a good thing to be */
6196 /* doing, but we've got no other real choice */
6197 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6199 bytesread = PerlIO_read(fp, buffer, recsize);
6201 SvCUR_set(sv, bytesread += append);
6202 buffer[bytesread] = '\0';
6203 goto check_utf8_and_return;
6205 else if (RsPARA(PL_rs)) {
6211 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6212 if (PerlIO_isutf8(fp)) {
6213 rsptr = SvPVutf8(PL_rs, rslen);
6216 if (SvUTF8(PL_rs)) {
6217 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6218 Perl_croak(aTHX_ "Wide character in $/");
6221 rsptr = SvPV(PL_rs, rslen);
6225 rslast = rslen ? rsptr[rslen - 1] : '\0';
6227 if (rspara) { /* have to do this both before and after */
6228 do { /* to make sure file boundaries work right */
6231 i = PerlIO_getc(fp);
6235 PerlIO_ungetc(fp,i);
6241 /* See if we know enough about I/O mechanism to cheat it ! */
6243 /* This used to be #ifdef test - it is made run-time test for ease
6244 of abstracting out stdio interface. One call should be cheap
6245 enough here - and may even be a macro allowing compile
6249 if (PerlIO_fast_gets(fp)) {
6252 * We're going to steal some values from the stdio struct
6253 * and put EVERYTHING in the innermost loop into registers.
6255 register STDCHAR *ptr;
6259 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6260 /* An ungetc()d char is handled separately from the regular
6261 * buffer, so we getc() it back out and stuff it in the buffer.
6263 i = PerlIO_getc(fp);
6264 if (i == EOF) return 0;
6265 *(--((*fp)->_ptr)) = (unsigned char) i;
6269 /* Here is some breathtakingly efficient cheating */
6271 cnt = PerlIO_get_cnt(fp); /* get count into register */
6272 if ((I32)(SvLEN(sv) - append) <= cnt + 1) { /* make sure we have the room */
6273 if (cnt > 80 && (I32)SvLEN(sv) > append) {
6274 shortbuffered = cnt - SvLEN(sv) + append + 1;
6275 cnt -= shortbuffered;
6279 /* remember that cnt can be negative */
6280 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6285 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
6286 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6287 DEBUG_P(PerlIO_printf(Perl_debug_log,
6288 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6289 DEBUG_P(PerlIO_printf(Perl_debug_log,
6290 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6291 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6292 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6297 while (cnt > 0) { /* this | eat */
6299 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6300 goto thats_all_folks; /* screams | sed :-) */
6304 Copy(ptr, bp, cnt, char); /* this | eat */
6305 bp += cnt; /* screams | dust */
6306 ptr += cnt; /* louder | sed :-) */
6311 if (shortbuffered) { /* oh well, must extend */
6312 cnt = shortbuffered;
6314 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6316 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6317 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6321 DEBUG_P(PerlIO_printf(Perl_debug_log,
6322 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6323 PTR2UV(ptr),(long)cnt));
6324 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6326 DEBUG_P(PerlIO_printf(Perl_debug_log,
6327 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6328 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6329 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6331 /* This used to call 'filbuf' in stdio form, but as that behaves like
6332 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6333 another abstraction. */
6334 i = PerlIO_getc(fp); /* get more characters */
6336 DEBUG_P(PerlIO_printf(Perl_debug_log,
6337 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6338 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6339 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6341 cnt = PerlIO_get_cnt(fp);
6342 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6343 DEBUG_P(PerlIO_printf(Perl_debug_log,
6344 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6346 if (i == EOF) /* all done for ever? */
6347 goto thats_really_all_folks;
6349 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6351 SvGROW(sv, bpx + cnt + 2);
6352 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6354 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6356 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6357 goto thats_all_folks;
6361 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
6362 memNE((char*)bp - rslen, rsptr, rslen))
6363 goto screamer; /* go back to the fray */
6364 thats_really_all_folks:
6366 cnt += shortbuffered;
6367 DEBUG_P(PerlIO_printf(Perl_debug_log,
6368 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6369 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6370 DEBUG_P(PerlIO_printf(Perl_debug_log,
6371 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6372 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6373 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6375 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
6376 DEBUG_P(PerlIO_printf(Perl_debug_log,
6377 "Screamer: done, len=%ld, string=|%.*s|\n",
6378 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
6383 /*The big, slow, and stupid way */
6386 /* Need to work around EPOC SDK features */
6387 /* On WINS: MS VC5 generates calls to _chkstk, */
6388 /* if a `large' stack frame is allocated */
6389 /* gcc on MARM does not generate calls like these */
6395 register STDCHAR *bpe = buf + sizeof(buf);
6397 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6398 ; /* keep reading */
6402 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6403 /* Accomodate broken VAXC compiler, which applies U8 cast to
6404 * both args of ?: operator, causing EOF to change into 255
6407 i = (U8)buf[cnt - 1];
6413 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6415 sv_catpvn(sv, (char *) buf, cnt);
6417 sv_setpvn(sv, (char *) buf, cnt);
6419 if (i != EOF && /* joy */
6421 SvCUR(sv) < rslen ||
6422 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6426 * If we're reading from a TTY and we get a short read,
6427 * indicating that the user hit his EOF character, we need
6428 * to notice it now, because if we try to read from the TTY
6429 * again, the EOF condition will disappear.
6431 * The comparison of cnt to sizeof(buf) is an optimization
6432 * that prevents unnecessary calls to feof().
6436 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6441 if (rspara) { /* have to do this both before and after */
6442 while (i != EOF) { /* to make sure file boundaries work right */
6443 i = PerlIO_getc(fp);
6445 PerlIO_ungetc(fp,i);
6451 check_utf8_and_return:
6452 if (PerlIO_isutf8(fp))
6457 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6463 Auto-increment of the value in the SV, doing string to numeric conversion
6464 if necessary. Handles 'get' magic.
6470 Perl_sv_inc(pTHX_ register SV *sv)
6479 if (SvTHINKFIRST(sv)) {
6481 sv_force_normal_flags(sv, 0);
6482 if (SvREADONLY(sv)) {
6483 if (PL_curcop != &PL_compiling)
6484 Perl_croak(aTHX_ PL_no_modify);
6488 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6490 i = PTR2IV(SvRV(sv));
6495 flags = SvFLAGS(sv);
6496 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6497 /* It's (privately or publicly) a float, but not tested as an
6498 integer, so test it to see. */
6500 flags = SvFLAGS(sv);
6502 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6503 /* It's publicly an integer, or privately an integer-not-float */
6504 #ifdef PERL_PRESERVE_IVUV
6508 if (SvUVX(sv) == UV_MAX)
6509 sv_setnv(sv, UV_MAX_P1);
6511 (void)SvIOK_only_UV(sv);
6514 if (SvIVX(sv) == IV_MAX)
6515 sv_setuv(sv, (UV)IV_MAX + 1);
6517 (void)SvIOK_only(sv);
6523 if (flags & SVp_NOK) {
6524 (void)SvNOK_only(sv);
6529 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
6530 if ((flags & SVTYPEMASK) < SVt_PVIV)
6531 sv_upgrade(sv, SVt_IV);
6532 (void)SvIOK_only(sv);
6537 while (isALPHA(*d)) d++;
6538 while (isDIGIT(*d)) d++;
6540 #ifdef PERL_PRESERVE_IVUV
6541 /* Got to punt this as an integer if needs be, but we don't issue
6542 warnings. Probably ought to make the sv_iv_please() that does
6543 the conversion if possible, and silently. */
6544 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6545 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6546 /* Need to try really hard to see if it's an integer.
6547 9.22337203685478e+18 is an integer.
6548 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6549 so $a="9.22337203685478e+18"; $a+0; $a++
6550 needs to be the same as $a="9.22337203685478e+18"; $a++
6557 /* sv_2iv *should* have made this an NV */
6558 if (flags & SVp_NOK) {
6559 (void)SvNOK_only(sv);
6563 /* I don't think we can get here. Maybe I should assert this
6564 And if we do get here I suspect that sv_setnv will croak. NWC
6566 #if defined(USE_LONG_DOUBLE)
6567 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",
6568 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6570 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6571 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6574 #endif /* PERL_PRESERVE_IVUV */
6575 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
6579 while (d >= SvPVX(sv)) {
6587 /* MKS: The original code here died if letters weren't consecutive.
6588 * at least it didn't have to worry about non-C locales. The
6589 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6590 * arranged in order (although not consecutively) and that only
6591 * [A-Za-z] are accepted by isALPHA in the C locale.
6593 if (*d != 'z' && *d != 'Z') {
6594 do { ++*d; } while (!isALPHA(*d));
6597 *(d--) -= 'z' - 'a';
6602 *(d--) -= 'z' - 'a' + 1;
6606 /* oh,oh, the number grew */
6607 SvGROW(sv, SvCUR(sv) + 2);
6609 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6620 Auto-decrement of the value in the SV, doing string to numeric conversion
6621 if necessary. Handles 'get' magic.
6627 Perl_sv_dec(pTHX_ register SV *sv)
6635 if (SvTHINKFIRST(sv)) {
6637 sv_force_normal_flags(sv, 0);
6638 if (SvREADONLY(sv)) {
6639 if (PL_curcop != &PL_compiling)
6640 Perl_croak(aTHX_ PL_no_modify);
6644 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6646 i = PTR2IV(SvRV(sv));
6651 /* Unlike sv_inc we don't have to worry about string-never-numbers
6652 and keeping them magic. But we mustn't warn on punting */
6653 flags = SvFLAGS(sv);
6654 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6655 /* It's publicly an integer, or privately an integer-not-float */
6656 #ifdef PERL_PRESERVE_IVUV
6660 if (SvUVX(sv) == 0) {
6661 (void)SvIOK_only(sv);
6665 (void)SvIOK_only_UV(sv);
6669 if (SvIVX(sv) == IV_MIN)
6670 sv_setnv(sv, (NV)IV_MIN - 1.0);
6672 (void)SvIOK_only(sv);
6678 if (flags & SVp_NOK) {
6680 (void)SvNOK_only(sv);
6683 if (!(flags & SVp_POK)) {
6684 if ((flags & SVTYPEMASK) < SVt_PVNV)
6685 sv_upgrade(sv, SVt_NV);
6687 (void)SvNOK_only(sv);
6690 #ifdef PERL_PRESERVE_IVUV
6692 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6693 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6694 /* Need to try really hard to see if it's an integer.
6695 9.22337203685478e+18 is an integer.
6696 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6697 so $a="9.22337203685478e+18"; $a+0; $a--
6698 needs to be the same as $a="9.22337203685478e+18"; $a--
6705 /* sv_2iv *should* have made this an NV */
6706 if (flags & SVp_NOK) {
6707 (void)SvNOK_only(sv);
6711 /* I don't think we can get here. Maybe I should assert this
6712 And if we do get here I suspect that sv_setnv will croak. NWC
6714 #if defined(USE_LONG_DOUBLE)
6715 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",
6716 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6718 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6719 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6723 #endif /* PERL_PRESERVE_IVUV */
6724 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6728 =for apidoc sv_mortalcopy
6730 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6731 The new SV is marked as mortal. It will be destroyed "soon", either by an
6732 explicit call to FREETMPS, or by an implicit call at places such as
6733 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6738 /* Make a string that will exist for the duration of the expression
6739 * evaluation. Actually, it may have to last longer than that, but
6740 * hopefully we won't free it until it has been assigned to a
6741 * permanent location. */
6744 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6749 sv_setsv(sv,oldstr);
6751 PL_tmps_stack[++PL_tmps_ix] = sv;
6757 =for apidoc sv_newmortal
6759 Creates a new null SV which is mortal. The reference count of the SV is
6760 set to 1. It will be destroyed "soon", either by an explicit call to
6761 FREETMPS, or by an implicit call at places such as statement boundaries.
6762 See also C<sv_mortalcopy> and C<sv_2mortal>.
6768 Perl_sv_newmortal(pTHX)
6773 SvFLAGS(sv) = SVs_TEMP;
6775 PL_tmps_stack[++PL_tmps_ix] = sv;
6780 =for apidoc sv_2mortal
6782 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6783 by an explicit call to FREETMPS, or by an implicit call at places such as
6784 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
6790 Perl_sv_2mortal(pTHX_ register SV *sv)
6794 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6797 PL_tmps_stack[++PL_tmps_ix] = sv;
6805 Creates a new SV and copies a string into it. The reference count for the
6806 SV is set to 1. If C<len> is zero, Perl will compute the length using
6807 strlen(). For efficiency, consider using C<newSVpvn> instead.
6813 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6820 sv_setpvn(sv,s,len);
6825 =for apidoc newSVpvn
6827 Creates a new SV and copies a string into it. The reference count for the
6828 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6829 string. You are responsible for ensuring that the source string is at least
6836 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6841 sv_setpvn(sv,s,len);
6846 =for apidoc newSVpvn_share
6848 Creates a new SV with its SvPVX pointing to a shared string in the string
6849 table. If the string does not already exist in the table, it is created
6850 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6851 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6852 otherwise the hash is computed. The idea here is that as the string table
6853 is used for shared hash keys these strings will have SvPVX == HeKEY and
6854 hash lookup will avoid string compare.
6860 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6863 bool is_utf8 = FALSE;
6865 STRLEN tmplen = -len;
6867 /* See the note in hv.c:hv_fetch() --jhi */
6868 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
6872 PERL_HASH(hash, src, len);
6874 sv_upgrade(sv, SVt_PVIV);
6875 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
6888 #if defined(PERL_IMPLICIT_CONTEXT)
6890 /* pTHX_ magic can't cope with varargs, so this is a no-context
6891 * version of the main function, (which may itself be aliased to us).
6892 * Don't access this version directly.
6896 Perl_newSVpvf_nocontext(const char* pat, ...)
6901 va_start(args, pat);
6902 sv = vnewSVpvf(pat, &args);
6909 =for apidoc newSVpvf
6911 Creates a new SV and initializes it with the string formatted like
6918 Perl_newSVpvf(pTHX_ const char* pat, ...)
6922 va_start(args, pat);
6923 sv = vnewSVpvf(pat, &args);
6928 /* backend for newSVpvf() and newSVpvf_nocontext() */
6931 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6935 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6942 Creates a new SV and copies a floating point value into it.
6943 The reference count for the SV is set to 1.
6949 Perl_newSVnv(pTHX_ NV n)
6961 Creates a new SV and copies an integer into it. The reference count for the
6968 Perl_newSViv(pTHX_ IV i)
6980 Creates a new SV and copies an unsigned integer into it.
6981 The reference count for the SV is set to 1.
6987 Perl_newSVuv(pTHX_ UV u)
6997 =for apidoc newRV_noinc
6999 Creates an RV wrapper for an SV. The reference count for the original
7000 SV is B<not> incremented.
7006 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7011 sv_upgrade(sv, SVt_RV);
7018 /* newRV_inc is the official function name to use now.
7019 * newRV_inc is in fact #defined to newRV in sv.h
7023 Perl_newRV(pTHX_ SV *tmpRef)
7025 return newRV_noinc(SvREFCNT_inc(tmpRef));
7031 Creates a new SV which is an exact duplicate of the original SV.
7038 Perl_newSVsv(pTHX_ register SV *old)
7044 if (SvTYPE(old) == SVTYPEMASK) {
7045 if (ckWARN_d(WARN_INTERNAL))
7046 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7061 =for apidoc sv_reset
7063 Underlying implementation for the C<reset> Perl function.
7064 Note that the perl-level function is vaguely deprecated.
7070 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7078 char todo[PERL_UCHAR_MAX+1];
7083 if (!*s) { /* reset ?? searches */
7084 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7085 pm->op_pmdynflags &= ~PMdf_USED;
7090 /* reset variables */
7092 if (!HvARRAY(stash))
7095 Zero(todo, 256, char);
7097 i = (unsigned char)*s;
7101 max = (unsigned char)*s++;
7102 for ( ; i <= max; i++) {
7105 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7106 for (entry = HvARRAY(stash)[i];
7108 entry = HeNEXT(entry))
7110 if (!todo[(U8)*HeKEY(entry)])
7112 gv = (GV*)HeVAL(entry);
7114 if (SvTHINKFIRST(sv)) {
7115 if (!SvREADONLY(sv) && SvROK(sv))
7120 if (SvTYPE(sv) >= SVt_PV) {
7122 if (SvPVX(sv) != Nullch)
7129 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7131 #ifdef USE_ENVIRON_ARRAY
7133 # ifdef USE_ITHREADS
7134 && PL_curinterp == aTHX
7138 environ[0] = Nullch;
7150 Using various gambits, try to get an IO from an SV: the IO slot if its a
7151 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7152 named after the PV if we're a string.
7158 Perl_sv_2io(pTHX_ SV *sv)
7164 switch (SvTYPE(sv)) {
7172 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7176 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7178 return sv_2io(SvRV(sv));
7179 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7185 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7194 Using various gambits, try to get a CV from an SV; in addition, try if
7195 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7201 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7208 return *gvp = Nullgv, Nullcv;
7209 switch (SvTYPE(sv)) {
7228 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7229 tryAMAGICunDEREF(to_cv);
7232 if (SvTYPE(sv) == SVt_PVCV) {
7241 Perl_croak(aTHX_ "Not a subroutine reference");
7246 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
7252 if (lref && !GvCVu(gv)) {
7255 tmpsv = NEWSV(704,0);
7256 gv_efullname3(tmpsv, gv, Nullch);
7257 /* XXX this is probably not what they think they're getting.
7258 * It has the same effect as "sub name;", i.e. just a forward
7260 newSUB(start_subparse(FALSE, 0),
7261 newSVOP(OP_CONST, 0, tmpsv),
7266 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7276 Returns true if the SV has a true value by Perl's rules.
7277 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7278 instead use an in-line version.
7284 Perl_sv_true(pTHX_ register SV *sv)
7290 if ((tXpv = (XPV*)SvANY(sv)) &&
7291 (tXpv->xpv_cur > 1 ||
7292 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
7299 return SvIVX(sv) != 0;
7302 return SvNVX(sv) != 0.0;
7304 return sv_2bool(sv);
7312 A private implementation of the C<SvIVx> macro for compilers which can't
7313 cope with complex macro expressions. Always use the macro instead.
7319 Perl_sv_iv(pTHX_ register SV *sv)
7323 return (IV)SvUVX(sv);
7332 A private implementation of the C<SvUVx> macro for compilers which can't
7333 cope with complex macro expressions. Always use the macro instead.
7339 Perl_sv_uv(pTHX_ register SV *sv)
7344 return (UV)SvIVX(sv);
7352 A private implementation of the C<SvNVx> macro for compilers which can't
7353 cope with complex macro expressions. Always use the macro instead.
7359 Perl_sv_nv(pTHX_ register SV *sv)
7369 Use the C<SvPV_nolen> macro instead
7373 A private implementation of the C<SvPV> macro for compilers which can't
7374 cope with complex macro expressions. Always use the macro instead.
7380 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7386 return sv_2pv(sv, lp);
7391 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7397 return sv_2pv_flags(sv, lp, 0);
7401 =for apidoc sv_pvn_force
7403 Get a sensible string out of the SV somehow.
7404 A private implementation of the C<SvPV_force> macro for compilers which
7405 can't cope with complex macro expressions. Always use the macro instead.
7407 =for apidoc sv_pvn_force_flags
7409 Get a sensible string out of the SV somehow.
7410 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7411 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7412 implemented in terms of this function.
7413 You normally want to use the various wrapper macros instead: see
7414 C<SvPV_force> and C<SvPV_force_nomg>
7420 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7424 if (SvTHINKFIRST(sv) && !SvROK(sv))
7425 sv_force_normal_flags(sv, 0);
7431 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7432 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7436 s = sv_2pv_flags(sv, lp, flags);
7437 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
7442 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7443 SvGROW(sv, len + 1);
7444 Move(s,SvPVX(sv),len,char);
7449 SvPOK_on(sv); /* validate pointer */
7451 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7452 PTR2UV(sv),SvPVX(sv)));
7459 =for apidoc sv_pvbyte
7461 Use C<SvPVbyte_nolen> instead.
7463 =for apidoc sv_pvbyten
7465 A private implementation of the C<SvPVbyte> macro for compilers
7466 which can't cope with complex macro expressions. Always use the macro
7473 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7475 sv_utf8_downgrade(sv,0);
7476 return sv_pvn(sv,lp);
7480 =for apidoc sv_pvbyten_force
7482 A private implementation of the C<SvPVbytex_force> macro for compilers
7483 which can't cope with complex macro expressions. Always use the macro
7490 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7492 sv_utf8_downgrade(sv,0);
7493 return sv_pvn_force(sv,lp);
7497 =for apidoc sv_pvutf8
7499 Use the C<SvPVutf8_nolen> macro instead
7501 =for apidoc sv_pvutf8n
7503 A private implementation of the C<SvPVutf8> macro for compilers
7504 which can't cope with complex macro expressions. Always use the macro
7511 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7513 sv_utf8_upgrade(sv);
7514 return sv_pvn(sv,lp);
7518 =for apidoc sv_pvutf8n_force
7520 A private implementation of the C<SvPVutf8_force> macro for compilers
7521 which can't cope with complex macro expressions. Always use the macro
7528 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7530 sv_utf8_upgrade(sv);
7531 return sv_pvn_force(sv,lp);
7535 =for apidoc sv_reftype
7537 Returns a string describing what the SV is a reference to.
7543 Perl_sv_reftype(pTHX_ SV *sv, int ob)
7545 if (ob && SvOBJECT(sv)) {
7546 return HvNAME(SvSTASH(sv));
7549 switch (SvTYPE(sv)) {
7565 case SVt_PVLV: return "LVALUE";
7566 case SVt_PVAV: return "ARRAY";
7567 case SVt_PVHV: return "HASH";
7568 case SVt_PVCV: return "CODE";
7569 case SVt_PVGV: return "GLOB";
7570 case SVt_PVFM: return "FORMAT";
7571 case SVt_PVIO: return "IO";
7572 default: return "UNKNOWN";
7578 =for apidoc sv_isobject
7580 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7581 object. If the SV is not an RV, or if the object is not blessed, then this
7588 Perl_sv_isobject(pTHX_ SV *sv)
7605 Returns a boolean indicating whether the SV is blessed into the specified
7606 class. This does not check for subtypes; use C<sv_derived_from> to verify
7607 an inheritance relationship.
7613 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7625 return strEQ(HvNAME(SvSTASH(sv)), name);
7631 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7632 it will be upgraded to one. If C<classname> is non-null then the new SV will
7633 be blessed in the specified package. The new SV is returned and its
7634 reference count is 1.
7640 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7646 SV_CHECK_THINKFIRST_COW_DROP(rv);
7649 if (SvTYPE(rv) >= SVt_PVMG) {
7650 U32 refcnt = SvREFCNT(rv);
7654 SvREFCNT(rv) = refcnt;
7657 if (SvTYPE(rv) < SVt_RV)
7658 sv_upgrade(rv, SVt_RV);
7659 else if (SvTYPE(rv) > SVt_RV) {
7660 (void)SvOOK_off(rv);
7661 if (SvPVX(rv) && SvLEN(rv))
7662 Safefree(SvPVX(rv));
7672 HV* stash = gv_stashpv(classname, TRUE);
7673 (void)sv_bless(rv, stash);
7679 =for apidoc sv_setref_pv
7681 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7682 argument will be upgraded to an RV. That RV will be modified to point to
7683 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7684 into the SV. The C<classname> argument indicates the package for the
7685 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7686 will be returned and will have a reference count of 1.
7688 Do not use with other Perl types such as HV, AV, SV, CV, because those
7689 objects will become corrupted by the pointer copy process.
7691 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7697 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7700 sv_setsv(rv, &PL_sv_undef);
7704 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7709 =for apidoc sv_setref_iv
7711 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7712 argument will be upgraded to an RV. That RV will be modified to point to
7713 the new SV. The C<classname> argument indicates the package for the
7714 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7715 will be returned and will have a reference count of 1.
7721 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7723 sv_setiv(newSVrv(rv,classname), iv);
7728 =for apidoc sv_setref_uv
7730 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7731 argument will be upgraded to an RV. That RV will be modified to point to
7732 the new SV. The C<classname> argument indicates the package for the
7733 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7734 will be returned and will have a reference count of 1.
7740 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7742 sv_setuv(newSVrv(rv,classname), uv);
7747 =for apidoc sv_setref_nv
7749 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7750 argument will be upgraded to an RV. That RV will be modified to point to
7751 the new SV. The C<classname> argument indicates the package for the
7752 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7753 will be returned and will have a reference count of 1.
7759 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7761 sv_setnv(newSVrv(rv,classname), nv);
7766 =for apidoc sv_setref_pvn
7768 Copies a string into a new SV, optionally blessing the SV. The length of the
7769 string must be specified with C<n>. The C<rv> argument will be upgraded to
7770 an RV. That RV will be modified to point to the new SV. The C<classname>
7771 argument indicates the package for the blessing. Set C<classname> to
7772 C<Nullch> to avoid the blessing. The new SV will be returned and will have
7773 a reference count of 1.
7775 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7781 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
7783 sv_setpvn(newSVrv(rv,classname), pv, n);
7788 =for apidoc sv_bless
7790 Blesses an SV into a specified package. The SV must be an RV. The package
7791 must be designated by its stash (see C<gv_stashpv()>). The reference count
7792 of the SV is unaffected.
7798 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7802 Perl_croak(aTHX_ "Can't bless non-reference value");
7804 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7805 if (SvREADONLY(tmpRef))
7806 Perl_croak(aTHX_ PL_no_modify);
7807 if (SvOBJECT(tmpRef)) {
7808 if (SvTYPE(tmpRef) != SVt_PVIO)
7810 SvREFCNT_dec(SvSTASH(tmpRef));
7813 SvOBJECT_on(tmpRef);
7814 if (SvTYPE(tmpRef) != SVt_PVIO)
7816 (void)SvUPGRADE(tmpRef, SVt_PVMG);
7817 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
7824 if(SvSMAGICAL(tmpRef))
7825 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7833 /* Downgrades a PVGV to a PVMG.
7837 S_sv_unglob(pTHX_ SV *sv)
7841 assert(SvTYPE(sv) == SVt_PVGV);
7846 SvREFCNT_dec(GvSTASH(sv));
7847 GvSTASH(sv) = Nullhv;
7849 sv_unmagic(sv, PERL_MAGIC_glob);
7850 Safefree(GvNAME(sv));
7853 /* need to keep SvANY(sv) in the right arena */
7854 xpvmg = new_XPVMG();
7855 StructCopy(SvANY(sv), xpvmg, XPVMG);
7856 del_XPVGV(SvANY(sv));
7859 SvFLAGS(sv) &= ~SVTYPEMASK;
7860 SvFLAGS(sv) |= SVt_PVMG;
7864 =for apidoc sv_unref_flags
7866 Unsets the RV status of the SV, and decrements the reference count of
7867 whatever was being referenced by the RV. This can almost be thought of
7868 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7869 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7870 (otherwise the decrementing is conditional on the reference count being
7871 different from one or the reference being a readonly SV).
7878 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
7882 if (SvWEAKREF(sv)) {
7890 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
7891 assigned to as BEGIN {$a = \"Foo"} will fail. */
7892 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
7894 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7895 sv_2mortal(rv); /* Schedule for freeing later */
7899 =for apidoc sv_unref
7901 Unsets the RV status of the SV, and decrements the reference count of
7902 whatever was being referenced by the RV. This can almost be thought of
7903 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
7904 being zero. See C<SvROK_off>.
7910 Perl_sv_unref(pTHX_ SV *sv)
7912 sv_unref_flags(sv, 0);
7916 =for apidoc sv_taint
7918 Taint an SV. Use C<SvTAINTED_on> instead.
7923 Perl_sv_taint(pTHX_ SV *sv)
7925 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
7929 =for apidoc sv_untaint
7931 Untaint an SV. Use C<SvTAINTED_off> instead.
7936 Perl_sv_untaint(pTHX_ SV *sv)
7938 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7939 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7946 =for apidoc sv_tainted
7948 Test an SV for taintedness. Use C<SvTAINTED> instead.
7953 Perl_sv_tainted(pTHX_ SV *sv)
7955 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7956 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7957 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
7963 #if defined(PERL_IMPLICIT_CONTEXT)
7965 /* pTHX_ magic can't cope with varargs, so this is a no-context
7966 * version of the main function, (which may itself be aliased to us).
7967 * Don't access this version directly.
7971 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7975 va_start(args, pat);
7976 sv_vsetpvf(sv, pat, &args);
7980 /* pTHX_ magic can't cope with varargs, so this is a no-context
7981 * version of the main function, (which may itself be aliased to us).
7982 * Don't access this version directly.
7986 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7990 va_start(args, pat);
7991 sv_vsetpvf_mg(sv, pat, &args);
7997 =for apidoc sv_setpvf
7999 Processes its arguments like C<sprintf> and sets an SV to the formatted
8000 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8006 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8009 va_start(args, pat);
8010 sv_vsetpvf(sv, pat, &args);
8014 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8017 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8019 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8023 =for apidoc sv_setpvf_mg
8025 Like C<sv_setpvf>, but also handles 'set' magic.
8031 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8034 va_start(args, pat);
8035 sv_vsetpvf_mg(sv, pat, &args);
8039 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8042 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8044 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8048 #if defined(PERL_IMPLICIT_CONTEXT)
8050 /* pTHX_ magic can't cope with varargs, so this is a no-context
8051 * version of the main function, (which may itself be aliased to us).
8052 * Don't access this version directly.
8056 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8060 va_start(args, pat);
8061 sv_vcatpvf(sv, pat, &args);
8065 /* pTHX_ magic can't cope with varargs, so this is a no-context
8066 * version of the main function, (which may itself be aliased to us).
8067 * Don't access this version directly.
8071 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8075 va_start(args, pat);
8076 sv_vcatpvf_mg(sv, pat, &args);
8082 =for apidoc sv_catpvf
8084 Processes its arguments like C<sprintf> and appends the formatted
8085 output to an SV. If the appended data contains "wide" characters
8086 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8087 and characters >255 formatted with %c), the original SV might get
8088 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8089 C<SvSETMAGIC()> must typically be called after calling this function
8090 to handle 'set' magic.
8095 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8098 va_start(args, pat);
8099 sv_vcatpvf(sv, pat, &args);
8103 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8106 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8108 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8112 =for apidoc sv_catpvf_mg
8114 Like C<sv_catpvf>, but also handles 'set' magic.
8120 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8123 va_start(args, pat);
8124 sv_vcatpvf_mg(sv, pat, &args);
8128 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
8131 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8133 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8138 =for apidoc sv_vsetpvfn
8140 Works like C<vcatpvfn> but copies the text into the SV instead of
8143 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
8149 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8151 sv_setpvn(sv, "", 0);
8152 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8155 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8158 S_expect_number(pTHX_ char** pattern)
8161 switch (**pattern) {
8162 case '1': case '2': case '3':
8163 case '4': case '5': case '6':
8164 case '7': case '8': case '9':
8165 while (isDIGIT(**pattern))
8166 var = var * 10 + (*(*pattern)++ - '0');
8170 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8173 =for apidoc sv_vcatpvfn
8175 Processes its arguments like C<vsprintf> and appends the formatted output
8176 to an SV. Uses an array of SVs if the C style variable argument list is
8177 missing (NULL). When running with taint checks enabled, indicates via
8178 C<maybe_tainted> if results are untrustworthy (often due to the use of
8181 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
8187 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8194 static char nullstr[] = "(null)";
8196 bool has_utf8 = FALSE; /* has the result utf8? */
8198 /* no matter what, this is a string now */
8199 (void)SvPV_force(sv, origlen);
8201 /* special-case "", "%s", and "%_" */
8204 if (patlen == 2 && pat[0] == '%') {
8208 char *s = va_arg(*args, char*);
8209 sv_catpv(sv, s ? s : nullstr);
8211 else if (svix < svmax) {
8212 sv_catsv(sv, *svargs);
8213 if (DO_UTF8(*svargs))
8219 argsv = va_arg(*args, SV*);
8220 sv_catsv(sv, argsv);
8225 /* See comment on '_' below */
8230 if (!args && svix < svmax && DO_UTF8(*svargs))
8233 patend = (char*)pat + patlen;
8234 for (p = (char*)pat; p < patend; p = q) {
8237 bool vectorize = FALSE;
8238 bool vectorarg = FALSE;
8239 bool vec_utf8 = FALSE;
8245 bool has_precis = FALSE;
8247 bool is_utf8 = FALSE; /* is this item utf8? */
8248 #ifdef HAS_LDBL_SPRINTF_BUG
8249 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8250 with sfio - Allen <allens@cpan.org> */
8251 bool fix_ldbl_sprintf_bug = FALSE;
8255 U8 utf8buf[UTF8_MAXLEN+1];
8256 STRLEN esignlen = 0;
8258 char *eptr = Nullch;
8260 /* Times 4: a decimal digit takes more than 3 binary digits.
8261 * NV_DIG: mantissa takes than many decimal digits.
8262 * Plus 32: Playing safe. */
8263 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8264 /* large enough for "%#.#f" --chip */
8265 /* what about long double NVs? --jhi */
8268 U8 *vecstr = Null(U8*);
8275 /* we need a long double target in case HAS_LONG_DOUBLE but
8278 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8287 STRLEN dotstrlen = 1;
8288 I32 efix = 0; /* explicit format parameter index */
8289 I32 ewix = 0; /* explicit width index */
8290 I32 epix = 0; /* explicit precision index */
8291 I32 evix = 0; /* explicit vector index */
8292 bool asterisk = FALSE;
8294 /* echo everything up to the next format specification */
8295 for (q = p; q < patend && *q != '%'; ++q) ;
8297 sv_catpvn(sv, p, q - p);
8304 We allow format specification elements in this order:
8305 \d+\$ explicit format parameter index
8307 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8308 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8309 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8311 [%bcdefginopsux_DFOUX] format (mandatory)
8313 if (EXPECT_NUMBER(q, width)) {
8354 if (EXPECT_NUMBER(q, ewix))
8363 if ((vectorarg = asterisk)) {
8373 EXPECT_NUMBER(q, width);
8378 vecsv = va_arg(*args, SV*);
8380 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8381 svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
8382 dotstr = SvPVx(vecsv, dotstrlen);
8387 vecsv = va_arg(*args, SV*);
8388 vecstr = (U8*)SvPVx(vecsv,veclen);
8389 vec_utf8 = DO_UTF8(vecsv);
8391 else if (efix ? efix <= svmax : svix < svmax) {
8392 vecsv = svargs[efix ? efix-1 : svix++];
8393 vecstr = (U8*)SvPVx(vecsv,veclen);
8394 vec_utf8 = DO_UTF8(vecsv);
8404 i = va_arg(*args, int);
8406 i = (ewix ? ewix <= svmax : svix < svmax) ?
8407 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8409 width = (i < 0) ? -i : i;
8419 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8421 /* XXX: todo, support specified precision parameter */
8425 i = va_arg(*args, int);
8427 i = (ewix ? ewix <= svmax : svix < svmax)
8428 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8429 precis = (i < 0) ? 0 : i;
8434 precis = precis * 10 + (*q++ - '0');
8443 case 'I': /* Ix, I32x, and I64x */
8445 if (q[1] == '6' && q[2] == '4') {
8451 if (q[1] == '3' && q[2] == '2') {
8461 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8472 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8473 if (*(q + 1) == 'l') { /* lld, llf */
8498 argsv = (efix ? efix <= svmax : svix < svmax) ?
8499 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8506 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8508 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8510 eptr = (char*)utf8buf;
8511 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8522 if (args && !vectorize) {
8523 eptr = va_arg(*args, char*);
8525 #ifdef MACOS_TRADITIONAL
8526 /* On MacOS, %#s format is used for Pascal strings */
8531 elen = strlen(eptr);
8534 elen = sizeof nullstr - 1;
8538 eptr = SvPVx(argsv, elen);
8539 if (DO_UTF8(argsv)) {
8540 if (has_precis && precis < elen) {
8542 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8545 if (width) { /* fudge width (can't fudge elen) */
8546 width += elen - sv_len_utf8(argsv);
8555 * The "%_" hack might have to be changed someday,
8556 * if ISO or ANSI decide to use '_' for something.
8557 * So we keep it hidden from users' code.
8559 if (!args || vectorize)
8561 argsv = va_arg(*args, SV*);
8562 eptr = SvPVx(argsv, elen);
8568 if (has_precis && elen > precis)
8575 if (alt || vectorize)
8577 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8595 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8604 esignbuf[esignlen++] = plus;
8608 case 'h': iv = (short)va_arg(*args, int); break;
8609 default: iv = va_arg(*args, int); break;
8610 case 'l': iv = va_arg(*args, long); break;
8611 case 'V': iv = va_arg(*args, IV); break;
8613 case 'q': iv = va_arg(*args, Quad_t); break;
8620 case 'h': iv = (short)iv; break;
8622 case 'l': iv = (long)iv; break;
8625 case 'q': iv = (Quad_t)iv; break;
8629 if ( !vectorize ) /* we already set uv above */
8634 esignbuf[esignlen++] = plus;
8638 esignbuf[esignlen++] = '-';
8681 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8692 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8693 default: uv = va_arg(*args, unsigned); break;
8694 case 'l': uv = va_arg(*args, unsigned long); break;
8695 case 'V': uv = va_arg(*args, UV); break;
8697 case 'q': uv = va_arg(*args, Quad_t); break;
8704 case 'h': uv = (unsigned short)uv; break;
8706 case 'l': uv = (unsigned long)uv; break;
8709 case 'q': uv = (Quad_t)uv; break;
8715 eptr = ebuf + sizeof ebuf;
8721 p = (char*)((c == 'X')
8722 ? "0123456789ABCDEF" : "0123456789abcdef");
8728 esignbuf[esignlen++] = '0';
8729 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8735 *--eptr = '0' + dig;
8737 if (alt && *eptr != '0')
8743 *--eptr = '0' + dig;
8746 esignbuf[esignlen++] = '0';
8747 esignbuf[esignlen++] = 'b';
8750 default: /* it had better be ten or less */
8751 #if defined(PERL_Y2KWARN)
8752 if (ckWARN(WARN_Y2K)) {
8754 char *s = SvPV(sv,n);
8755 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
8756 && (n == 2 || !isDIGIT(s[n-3])))
8758 Perl_warner(aTHX_ packWARN(WARN_Y2K),
8759 "Possible Y2K bug: %%%c %s",
8760 c, "format string following '19'");
8766 *--eptr = '0' + dig;
8767 } while (uv /= base);
8770 elen = (ebuf + sizeof ebuf) - eptr;
8773 zeros = precis - elen;
8774 else if (precis == 0 && elen == 1 && *eptr == '0')
8779 /* FLOATING POINT */
8782 c = 'f'; /* maybe %F isn't supported here */
8788 /* This is evil, but floating point is even more evil */
8790 /* for SV-style calling, we can only get NV
8791 for C-style calling, we assume %f is double;
8792 for simplicity we allow any of %Lf, %llf, %qf for long double
8796 #if defined(USE_LONG_DOUBLE)
8801 #if defined(USE_LONG_DOUBLE)
8802 intsize = args ? 0 : 'q';
8806 #if defined(HAS_LONG_DOUBLE)
8817 /* now we need (long double) if intsize == 'q', else (double) */
8818 nv = (args && !vectorize) ?
8819 #if LONG_DOUBLESIZE > DOUBLESIZE
8821 va_arg(*args, long double) :
8822 va_arg(*args, double)
8824 va_arg(*args, double)
8830 if (c != 'e' && c != 'E') {
8832 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8833 will cast our (long double) to (double) */
8834 (void)Perl_frexp(nv, &i);
8835 if (i == PERL_INT_MIN)
8836 Perl_die(aTHX_ "panic: frexp");
8838 need = BIT_DIGITS(i);
8840 need += has_precis ? precis : 6; /* known default */
8845 #ifdef HAS_LDBL_SPRINTF_BUG
8846 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8847 with sfio - Allen <allens@cpan.org> */
8850 # define MY_DBL_MAX DBL_MAX
8851 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8852 # if DOUBLESIZE >= 8
8853 # define MY_DBL_MAX 1.7976931348623157E+308L
8855 # define MY_DBL_MAX 3.40282347E+38L
8859 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8860 # define MY_DBL_MAX_BUG 1L
8862 # define MY_DBL_MAX_BUG MY_DBL_MAX
8866 # define MY_DBL_MIN DBL_MIN
8867 # else /* XXX guessing! -Allen */
8868 # if DOUBLESIZE >= 8
8869 # define MY_DBL_MIN 2.2250738585072014E-308L
8871 # define MY_DBL_MIN 1.17549435E-38L
8875 if ((intsize == 'q') && (c == 'f') &&
8876 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8878 /* it's going to be short enough that
8879 * long double precision is not needed */
8881 if ((nv <= 0L) && (nv >= -0L))
8882 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8884 /* would use Perl_fp_class as a double-check but not
8885 * functional on IRIX - see perl.h comments */
8887 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8888 /* It's within the range that a double can represent */
8889 #if defined(DBL_MAX) && !defined(DBL_MIN)
8890 if ((nv >= ((long double)1/DBL_MAX)) ||
8891 (nv <= (-(long double)1/DBL_MAX)))
8893 fix_ldbl_sprintf_bug = TRUE;
8896 if (fix_ldbl_sprintf_bug == TRUE) {
8906 # undef MY_DBL_MAX_BUG
8909 #endif /* HAS_LDBL_SPRINTF_BUG */
8911 need += 20; /* fudge factor */
8912 if (PL_efloatsize < need) {
8913 Safefree(PL_efloatbuf);
8914 PL_efloatsize = need + 20; /* more fudge */
8915 New(906, PL_efloatbuf, PL_efloatsize, char);
8916 PL_efloatbuf[0] = '\0';
8919 eptr = ebuf + sizeof ebuf;
8922 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8923 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8924 if (intsize == 'q') {
8925 /* Copy the one or more characters in a long double
8926 * format before the 'base' ([efgEFG]) character to
8927 * the format string. */
8928 static char const prifldbl[] = PERL_PRIfldbl;
8929 char const *p = prifldbl + sizeof(prifldbl) - 3;
8930 while (p >= prifldbl) { *--eptr = *p--; }
8935 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8940 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8952 /* No taint. Otherwise we are in the strange situation
8953 * where printf() taints but print($float) doesn't.
8955 #if defined(HAS_LONG_DOUBLE)
8957 (void)sprintf(PL_efloatbuf, eptr, nv);
8959 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
8961 (void)sprintf(PL_efloatbuf, eptr, nv);
8963 eptr = PL_efloatbuf;
8964 elen = strlen(PL_efloatbuf);
8970 i = SvCUR(sv) - origlen;
8971 if (args && !vectorize) {
8973 case 'h': *(va_arg(*args, short*)) = i; break;
8974 default: *(va_arg(*args, int*)) = i; break;
8975 case 'l': *(va_arg(*args, long*)) = i; break;
8976 case 'V': *(va_arg(*args, IV*)) = i; break;
8978 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8983 sv_setuv_mg(argsv, (UV)i);
8985 continue; /* not "break" */
8992 if (!args && ckWARN(WARN_PRINTF) &&
8993 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
8994 SV *msg = sv_newmortal();
8995 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8996 (PL_op->op_type == OP_PRTF) ? "" : "s");
8999 Perl_sv_catpvf(aTHX_ msg,
9000 "\"%%%c\"", c & 0xFF);
9002 Perl_sv_catpvf(aTHX_ msg,
9003 "\"%%\\%03"UVof"\"",
9006 sv_catpv(msg, "end of string");
9007 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9010 /* output mangled stuff ... */
9016 /* ... right here, because formatting flags should not apply */
9017 SvGROW(sv, SvCUR(sv) + elen + 1);
9019 Copy(eptr, p, elen, char);
9022 SvCUR(sv) = p - SvPVX(sv);
9023 continue; /* not "break" */
9026 if (is_utf8 != has_utf8) {
9029 sv_utf8_upgrade(sv);
9032 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9033 sv_utf8_upgrade(nsv);
9037 SvGROW(sv, SvCUR(sv) + elen + 1);
9042 have = esignlen + zeros + elen;
9043 need = (have > width ? have : width);
9046 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9048 if (esignlen && fill == '0') {
9049 for (i = 0; i < (int)esignlen; i++)
9053 memset(p, fill, gap);
9056 if (esignlen && fill != '0') {
9057 for (i = 0; i < (int)esignlen; i++)
9061 for (i = zeros; i; i--)
9065 Copy(eptr, p, elen, char);
9069 memset(p, ' ', gap);
9074 Copy(dotstr, p, dotstrlen, char);
9078 vectorize = FALSE; /* done iterating over vecstr */
9085 SvCUR(sv) = p - SvPVX(sv);
9093 /* =========================================================================
9095 =head1 Cloning an interpreter
9097 All the macros and functions in this section are for the private use of
9098 the main function, perl_clone().
9100 The foo_dup() functions make an exact copy of an existing foo thinngy.
9101 During the course of a cloning, a hash table is used to map old addresses
9102 to new addresses. The table is created and manipulated with the
9103 ptr_table_* functions.
9107 ============================================================================*/
9110 #if defined(USE_ITHREADS)
9112 #ifndef GpREFCNT_inc
9113 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9117 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9118 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9119 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9120 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9121 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9122 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9123 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9124 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9125 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9126 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9127 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9128 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9129 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9132 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9133 regcomp.c. AMS 20010712 */
9136 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
9140 struct reg_substr_datum *s;
9143 return (REGEXP *)NULL;
9145 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9148 len = r->offsets[0];
9149 npar = r->nparens+1;
9151 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9152 Copy(r->program, ret->program, len+1, regnode);
9154 New(0, ret->startp, npar, I32);
9155 Copy(r->startp, ret->startp, npar, I32);
9156 New(0, ret->endp, npar, I32);
9157 Copy(r->startp, ret->startp, npar, I32);
9159 New(0, ret->substrs, 1, struct reg_substr_data);
9160 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9161 s->min_offset = r->substrs->data[i].min_offset;
9162 s->max_offset = r->substrs->data[i].max_offset;
9163 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9164 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9167 ret->regstclass = NULL;
9170 int count = r->data->count;
9172 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9173 char, struct reg_data);
9174 New(0, d->what, count, U8);
9177 for (i = 0; i < count; i++) {
9178 d->what[i] = r->data->what[i];
9179 switch (d->what[i]) {
9181 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9184 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9187 /* This is cheating. */
9188 New(0, d->data[i], 1, struct regnode_charclass_class);
9189 StructCopy(r->data->data[i], d->data[i],
9190 struct regnode_charclass_class);
9191 ret->regstclass = (regnode*)d->data[i];
9194 /* Compiled op trees are readonly, and can thus be
9195 shared without duplication. */
9196 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9199 d->data[i] = r->data->data[i];
9209 New(0, ret->offsets, 2*len+1, U32);
9210 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9212 ret->precomp = SAVEPV(r->precomp);
9213 ret->refcnt = r->refcnt;
9214 ret->minlen = r->minlen;
9215 ret->prelen = r->prelen;
9216 ret->nparens = r->nparens;
9217 ret->lastparen = r->lastparen;
9218 ret->lastcloseparen = r->lastcloseparen;
9219 ret->reganch = r->reganch;
9221 ret->sublen = r->sublen;
9223 if (RX_MATCH_COPIED(ret))
9224 ret->subbeg = SAVEPV(r->subbeg);
9226 ret->subbeg = Nullch;
9228 ptr_table_store(PL_ptr_table, r, ret);
9232 /* duplicate a file handle */
9235 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9239 return (PerlIO*)NULL;
9241 /* look for it in the table first */
9242 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9246 /* create anew and remember what it is */
9247 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9248 ptr_table_store(PL_ptr_table, fp, ret);
9252 /* duplicate a directory handle */
9255 Perl_dirp_dup(pTHX_ DIR *dp)
9263 /* duplicate a typeglob */
9266 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9271 /* look for it in the table first */
9272 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9276 /* create anew and remember what it is */
9277 Newz(0, ret, 1, GP);
9278 ptr_table_store(PL_ptr_table, gp, ret);
9281 ret->gp_refcnt = 0; /* must be before any other dups! */
9282 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9283 ret->gp_io = io_dup_inc(gp->gp_io, param);
9284 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9285 ret->gp_av = av_dup_inc(gp->gp_av, param);
9286 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9287 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9288 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9289 ret->gp_cvgen = gp->gp_cvgen;
9290 ret->gp_flags = gp->gp_flags;
9291 ret->gp_line = gp->gp_line;
9292 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9296 /* duplicate a chain of magic */
9299 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9301 MAGIC *mgprev = (MAGIC*)NULL;
9304 return (MAGIC*)NULL;
9305 /* look for it in the table first */
9306 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9310 for (; mg; mg = mg->mg_moremagic) {
9312 Newz(0, nmg, 1, MAGIC);
9314 mgprev->mg_moremagic = nmg;
9317 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9318 nmg->mg_private = mg->mg_private;
9319 nmg->mg_type = mg->mg_type;
9320 nmg->mg_flags = mg->mg_flags;
9321 if (mg->mg_type == PERL_MAGIC_qr) {
9322 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9324 else if(mg->mg_type == PERL_MAGIC_backref) {
9325 AV *av = (AV*) mg->mg_obj;
9328 nmg->mg_obj = (SV*)newAV();
9332 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9337 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9338 ? sv_dup_inc(mg->mg_obj, param)
9339 : sv_dup(mg->mg_obj, param);
9341 nmg->mg_len = mg->mg_len;
9342 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9343 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9344 if (mg->mg_len > 0) {
9345 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9346 if (mg->mg_type == PERL_MAGIC_overload_table &&
9347 AMT_AMAGIC((AMT*)mg->mg_ptr))
9349 AMT *amtp = (AMT*)mg->mg_ptr;
9350 AMT *namtp = (AMT*)nmg->mg_ptr;
9352 for (i = 1; i < NofAMmeth; i++) {
9353 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9357 else if (mg->mg_len == HEf_SVKEY)
9358 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9360 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9361 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9368 /* create a new pointer-mapping table */
9371 Perl_ptr_table_new(pTHX)
9374 Newz(0, tbl, 1, PTR_TBL_t);
9377 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9381 /* map an existing pointer using a table */
9384 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
9386 PTR_TBL_ENT_t *tblent;
9387 UV hash = PTR2UV(sv);
9389 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9390 for (; tblent; tblent = tblent->next) {
9391 if (tblent->oldval == sv)
9392 return tblent->newval;
9397 /* add a new entry to a pointer-mapping table */
9400 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
9402 PTR_TBL_ENT_t *tblent, **otblent;
9403 /* XXX this may be pessimal on platforms where pointers aren't good
9404 * hash values e.g. if they grow faster in the most significant
9406 UV hash = PTR2UV(oldv);
9410 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9411 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
9412 if (tblent->oldval == oldv) {
9413 tblent->newval = newv;
9417 Newz(0, tblent, 1, PTR_TBL_ENT_t);
9418 tblent->oldval = oldv;
9419 tblent->newval = newv;
9420 tblent->next = *otblent;
9423 if (i && tbl->tbl_items > tbl->tbl_max)
9424 ptr_table_split(tbl);
9427 /* double the hash bucket size of an existing ptr table */
9430 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9432 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9433 UV oldsize = tbl->tbl_max + 1;
9434 UV newsize = oldsize * 2;
9437 Renew(ary, newsize, PTR_TBL_ENT_t*);
9438 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9439 tbl->tbl_max = --newsize;
9441 for (i=0; i < oldsize; i++, ary++) {
9442 PTR_TBL_ENT_t **curentp, **entp, *ent;
9445 curentp = ary + oldsize;
9446 for (entp = ary, ent = *ary; ent; ent = *entp) {
9447 if ((newsize & PTR2UV(ent->oldval)) != i) {
9449 ent->next = *curentp;
9459 /* remove all the entries from a ptr table */
9462 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9464 register PTR_TBL_ENT_t **array;
9465 register PTR_TBL_ENT_t *entry;
9466 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
9470 if (!tbl || !tbl->tbl_items) {
9474 array = tbl->tbl_ary;
9481 entry = entry->next;
9485 if (++riter > max) {
9488 entry = array[riter];
9495 /* clear and free a ptr table */
9498 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9503 ptr_table_clear(tbl);
9504 Safefree(tbl->tbl_ary);
9512 /* attempt to make everything in the typeglob readonly */
9515 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
9518 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
9520 if (GvIO(gv) || GvFORM(gv)) {
9521 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
9523 else if (!GvCV(gv)) {
9527 /* CvPADLISTs cannot be shared */
9528 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
9533 if (!GvUNIQUE(gv)) {
9535 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
9536 HvNAME(GvSTASH(gv)), GvNAME(gv));
9542 * write attempts will die with
9543 * "Modification of a read-only value attempted"
9549 SvREADONLY_on(GvSV(gv));
9556 SvREADONLY_on(GvAV(gv));
9563 SvREADONLY_on(GvAV(gv));
9566 return sstr; /* he_dup() will SvREFCNT_inc() */
9569 /* duplicate an SV of any type (including AV, HV etc) */
9572 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9575 SvRV(dstr) = SvWEAKREF(sstr)
9576 ? sv_dup(SvRV(sstr), param)
9577 : sv_dup_inc(SvRV(sstr), param);
9579 else if (SvPVX(sstr)) {
9580 /* Has something there */
9582 /* Normal PV - clone whole allocated space */
9583 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9584 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9585 /* Not that normal - actually sstr is copy on write.
9586 But we are a true, independant SV, so: */
9587 SvREADONLY_off(dstr);
9592 /* Special case - not normally malloced for some reason */
9593 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9594 /* A "shared" PV - clone it as unshared string */
9596 SvREADONLY_off(dstr);
9597 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
9600 /* Some other special case - random pointer */
9601 SvPVX(dstr) = SvPVX(sstr);
9607 SvPVX(dstr) = SvPVX(sstr);
9612 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9616 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9618 /* look for it in the table first */
9619 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9623 if(param->flags & CLONEf_JOIN_IN) {
9624 /** We are joining here so we don't want do clone
9625 something that is bad **/
9627 if(SvTYPE(sstr) == SVt_PVHV &&
9629 /** don't clone stashes if they already exist **/
9630 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
9631 return (SV*) old_stash;
9635 /* create anew and remember what it is */
9637 ptr_table_store(PL_ptr_table, sstr, dstr);
9640 SvFLAGS(dstr) = SvFLAGS(sstr);
9641 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9642 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9645 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
9646 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9647 PL_watch_pvx, SvPVX(sstr));
9650 switch (SvTYPE(sstr)) {
9655 SvANY(dstr) = new_XIV();
9656 SvIVX(dstr) = SvIVX(sstr);
9659 SvANY(dstr) = new_XNV();
9660 SvNVX(dstr) = SvNVX(sstr);
9663 SvANY(dstr) = new_XRV();
9664 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9667 SvANY(dstr) = new_XPV();
9668 SvCUR(dstr) = SvCUR(sstr);
9669 SvLEN(dstr) = SvLEN(sstr);
9670 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9673 SvANY(dstr) = new_XPVIV();
9674 SvCUR(dstr) = SvCUR(sstr);
9675 SvLEN(dstr) = SvLEN(sstr);
9676 SvIVX(dstr) = SvIVX(sstr);
9677 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9680 SvANY(dstr) = new_XPVNV();
9681 SvCUR(dstr) = SvCUR(sstr);
9682 SvLEN(dstr) = SvLEN(sstr);
9683 SvIVX(dstr) = SvIVX(sstr);
9684 SvNVX(dstr) = SvNVX(sstr);
9685 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9688 SvANY(dstr) = new_XPVMG();
9689 SvCUR(dstr) = SvCUR(sstr);
9690 SvLEN(dstr) = SvLEN(sstr);
9691 SvIVX(dstr) = SvIVX(sstr);
9692 SvNVX(dstr) = SvNVX(sstr);
9693 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9694 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9695 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9698 SvANY(dstr) = new_XPVBM();
9699 SvCUR(dstr) = SvCUR(sstr);
9700 SvLEN(dstr) = SvLEN(sstr);
9701 SvIVX(dstr) = SvIVX(sstr);
9702 SvNVX(dstr) = SvNVX(sstr);
9703 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9704 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9705 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9706 BmRARE(dstr) = BmRARE(sstr);
9707 BmUSEFUL(dstr) = BmUSEFUL(sstr);
9708 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
9711 SvANY(dstr) = new_XPVLV();
9712 SvCUR(dstr) = SvCUR(sstr);
9713 SvLEN(dstr) = SvLEN(sstr);
9714 SvIVX(dstr) = SvIVX(sstr);
9715 SvNVX(dstr) = SvNVX(sstr);
9716 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9717 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9718 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9719 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
9720 LvTARGLEN(dstr) = LvTARGLEN(sstr);
9721 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
9722 LvTYPE(dstr) = LvTYPE(sstr);
9725 if (GvUNIQUE((GV*)sstr)) {
9727 if ((share = gv_share(sstr, param))) {
9730 ptr_table_store(PL_ptr_table, sstr, dstr);
9732 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
9733 HvNAME(GvSTASH(share)), GvNAME(share));
9738 SvANY(dstr) = new_XPVGV();
9739 SvCUR(dstr) = SvCUR(sstr);
9740 SvLEN(dstr) = SvLEN(sstr);
9741 SvIVX(dstr) = SvIVX(sstr);
9742 SvNVX(dstr) = SvNVX(sstr);
9743 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9744 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9745 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9746 GvNAMELEN(dstr) = GvNAMELEN(sstr);
9747 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
9748 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
9749 GvFLAGS(dstr) = GvFLAGS(sstr);
9750 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9751 (void)GpREFCNT_inc(GvGP(dstr));
9754 SvANY(dstr) = new_XPVIO();
9755 SvCUR(dstr) = SvCUR(sstr);
9756 SvLEN(dstr) = SvLEN(sstr);
9757 SvIVX(dstr) = SvIVX(sstr);
9758 SvNVX(dstr) = SvNVX(sstr);
9759 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9760 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9761 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9762 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
9763 if (IoOFP(sstr) == IoIFP(sstr))
9764 IoOFP(dstr) = IoIFP(dstr);
9766 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
9767 /* PL_rsfp_filters entries have fake IoDIRP() */
9768 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
9769 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
9771 IoDIRP(dstr) = IoDIRP(sstr);
9772 IoLINES(dstr) = IoLINES(sstr);
9773 IoPAGE(dstr) = IoPAGE(sstr);
9774 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
9775 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
9776 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
9777 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
9778 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
9779 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
9780 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
9781 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
9782 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
9783 IoTYPE(dstr) = IoTYPE(sstr);
9784 IoFLAGS(dstr) = IoFLAGS(sstr);
9787 SvANY(dstr) = new_XPVAV();
9788 SvCUR(dstr) = SvCUR(sstr);
9789 SvLEN(dstr) = SvLEN(sstr);
9790 SvIVX(dstr) = SvIVX(sstr);
9791 SvNVX(dstr) = SvNVX(sstr);
9792 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9793 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9794 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
9795 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
9796 if (AvARRAY((AV*)sstr)) {
9797 SV **dst_ary, **src_ary;
9798 SSize_t items = AvFILLp((AV*)sstr) + 1;
9800 src_ary = AvARRAY((AV*)sstr);
9801 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
9802 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9803 SvPVX(dstr) = (char*)dst_ary;
9804 AvALLOC((AV*)dstr) = dst_ary;
9805 if (AvREAL((AV*)sstr)) {
9807 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9811 *dst_ary++ = sv_dup(*src_ary++, param);
9813 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9814 while (items-- > 0) {
9815 *dst_ary++ = &PL_sv_undef;
9819 SvPVX(dstr) = Nullch;
9820 AvALLOC((AV*)dstr) = (SV**)NULL;
9824 SvANY(dstr) = new_XPVHV();
9825 SvCUR(dstr) = SvCUR(sstr);
9826 SvLEN(dstr) = SvLEN(sstr);
9827 SvIVX(dstr) = SvIVX(sstr);
9828 SvNVX(dstr) = SvNVX(sstr);
9829 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9830 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9831 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
9832 if (HvARRAY((HV*)sstr)) {
9834 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
9835 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
9836 Newz(0, dxhv->xhv_array,
9837 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
9838 while (i <= sxhv->xhv_max) {
9839 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
9840 (bool)!!HvSHAREKEYS(sstr),
9844 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
9845 (bool)!!HvSHAREKEYS(sstr), param);
9848 SvPVX(dstr) = Nullch;
9849 HvEITER((HV*)dstr) = (HE*)NULL;
9851 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
9852 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
9853 /* Record stashes for possible cloning in Perl_clone(). */
9854 if(HvNAME((HV*)dstr))
9855 av_push(param->stashes, dstr);
9858 SvANY(dstr) = new_XPVFM();
9859 FmLINES(dstr) = FmLINES(sstr);
9863 SvANY(dstr) = new_XPVCV();
9865 SvCUR(dstr) = SvCUR(sstr);
9866 SvLEN(dstr) = SvLEN(sstr);
9867 SvIVX(dstr) = SvIVX(sstr);
9868 SvNVX(dstr) = SvNVX(sstr);
9869 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9870 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9871 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9872 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
9873 CvSTART(dstr) = CvSTART(sstr);
9874 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
9875 CvXSUB(dstr) = CvXSUB(sstr);
9876 CvXSUBANY(dstr) = CvXSUBANY(sstr);
9877 if (CvCONST(sstr)) {
9878 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
9879 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
9880 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
9882 CvGV(dstr) = gv_dup(CvGV(sstr), param);
9883 if (param->flags & CLONEf_COPY_STACKS) {
9884 CvDEPTH(dstr) = CvDEPTH(sstr);
9888 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9889 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
9892 ? cv_dup( CvOUTSIDE(sstr), param)
9893 : cv_dup_inc(CvOUTSIDE(sstr), param);
9894 CvFLAGS(dstr) = CvFLAGS(sstr);
9895 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
9898 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9902 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9908 /* duplicate a context */
9911 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9916 return (PERL_CONTEXT*)NULL;
9918 /* look for it in the table first */
9919 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9923 /* create anew and remember what it is */
9924 Newz(56, ncxs, max + 1, PERL_CONTEXT);
9925 ptr_table_store(PL_ptr_table, cxs, ncxs);
9928 PERL_CONTEXT *cx = &cxs[ix];
9929 PERL_CONTEXT *ncx = &ncxs[ix];
9930 ncx->cx_type = cx->cx_type;
9931 if (CxTYPE(cx) == CXt_SUBST) {
9932 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9935 ncx->blk_oldsp = cx->blk_oldsp;
9936 ncx->blk_oldcop = cx->blk_oldcop;
9937 ncx->blk_oldretsp = cx->blk_oldretsp;
9938 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9939 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9940 ncx->blk_oldpm = cx->blk_oldpm;
9941 ncx->blk_gimme = cx->blk_gimme;
9942 switch (CxTYPE(cx)) {
9944 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9945 ? cv_dup_inc(cx->blk_sub.cv, param)
9946 : cv_dup(cx->blk_sub.cv,param));
9947 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9948 ? av_dup_inc(cx->blk_sub.argarray, param)
9950 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9951 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9952 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9953 ncx->blk_sub.lval = cx->blk_sub.lval;
9956 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9957 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9958 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9959 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9960 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9963 ncx->blk_loop.label = cx->blk_loop.label;
9964 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9965 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9966 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9967 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9968 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9969 ? cx->blk_loop.iterdata
9970 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9971 ncx->blk_loop.oldcomppad
9972 = (PAD*)ptr_table_fetch(PL_ptr_table,
9973 cx->blk_loop.oldcomppad);
9974 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9975 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9976 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9977 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9978 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9981 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9982 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9983 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9984 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9996 /* duplicate a stack info structure */
9999 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10004 return (PERL_SI*)NULL;
10006 /* look for it in the table first */
10007 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10011 /* create anew and remember what it is */
10012 Newz(56, nsi, 1, PERL_SI);
10013 ptr_table_store(PL_ptr_table, si, nsi);
10015 nsi->si_stack = av_dup_inc(si->si_stack, param);
10016 nsi->si_cxix = si->si_cxix;
10017 nsi->si_cxmax = si->si_cxmax;
10018 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10019 nsi->si_type = si->si_type;
10020 nsi->si_prev = si_dup(si->si_prev, param);
10021 nsi->si_next = si_dup(si->si_next, param);
10022 nsi->si_markoff = si->si_markoff;
10027 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10028 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10029 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10030 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10031 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10032 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10033 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10034 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10035 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10036 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10037 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10038 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10039 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10040 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10043 #define pv_dup_inc(p) SAVEPV(p)
10044 #define pv_dup(p) SAVEPV(p)
10045 #define svp_dup_inc(p,pp) any_dup(p,pp)
10047 /* map any object to the new equivent - either something in the
10048 * ptr table, or something in the interpreter structure
10052 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10057 return (void*)NULL;
10059 /* look for it in the table first */
10060 ret = ptr_table_fetch(PL_ptr_table, v);
10064 /* see if it is part of the interpreter structure */
10065 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10066 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10074 /* duplicate the save stack */
10077 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10079 ANY *ss = proto_perl->Tsavestack;
10080 I32 ix = proto_perl->Tsavestack_ix;
10081 I32 max = proto_perl->Tsavestack_max;
10094 void (*dptr) (void*);
10095 void (*dxptr) (pTHX_ void*);
10098 Newz(54, nss, max, ANY);
10102 TOPINT(nss,ix) = i;
10104 case SAVEt_ITEM: /* normal string */
10105 sv = (SV*)POPPTR(ss,ix);
10106 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10107 sv = (SV*)POPPTR(ss,ix);
10108 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10110 case SAVEt_SV: /* scalar reference */
10111 sv = (SV*)POPPTR(ss,ix);
10112 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10113 gv = (GV*)POPPTR(ss,ix);
10114 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10116 case SAVEt_GENERIC_PVREF: /* generic char* */
10117 c = (char*)POPPTR(ss,ix);
10118 TOPPTR(nss,ix) = pv_dup(c);
10119 ptr = POPPTR(ss,ix);
10120 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10122 case SAVEt_SHARED_PVREF: /* char* in shared space */
10123 c = (char*)POPPTR(ss,ix);
10124 TOPPTR(nss,ix) = savesharedpv(c);
10125 ptr = POPPTR(ss,ix);
10126 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10128 case SAVEt_GENERIC_SVREF: /* generic sv */
10129 case SAVEt_SVREF: /* scalar reference */
10130 sv = (SV*)POPPTR(ss,ix);
10131 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10132 ptr = POPPTR(ss,ix);
10133 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10135 case SAVEt_AV: /* array reference */
10136 av = (AV*)POPPTR(ss,ix);
10137 TOPPTR(nss,ix) = av_dup_inc(av, param);
10138 gv = (GV*)POPPTR(ss,ix);
10139 TOPPTR(nss,ix) = gv_dup(gv, param);
10141 case SAVEt_HV: /* hash reference */
10142 hv = (HV*)POPPTR(ss,ix);
10143 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10144 gv = (GV*)POPPTR(ss,ix);
10145 TOPPTR(nss,ix) = gv_dup(gv, param);
10147 case SAVEt_INT: /* int reference */
10148 ptr = POPPTR(ss,ix);
10149 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10150 intval = (int)POPINT(ss,ix);
10151 TOPINT(nss,ix) = intval;
10153 case SAVEt_LONG: /* long reference */
10154 ptr = POPPTR(ss,ix);
10155 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10156 longval = (long)POPLONG(ss,ix);
10157 TOPLONG(nss,ix) = longval;
10159 case SAVEt_I32: /* I32 reference */
10160 case SAVEt_I16: /* I16 reference */
10161 case SAVEt_I8: /* I8 reference */
10162 ptr = POPPTR(ss,ix);
10163 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10165 TOPINT(nss,ix) = i;
10167 case SAVEt_IV: /* IV reference */
10168 ptr = POPPTR(ss,ix);
10169 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10171 TOPIV(nss,ix) = iv;
10173 case SAVEt_SPTR: /* SV* reference */
10174 ptr = POPPTR(ss,ix);
10175 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10176 sv = (SV*)POPPTR(ss,ix);
10177 TOPPTR(nss,ix) = sv_dup(sv, param);
10179 case SAVEt_VPTR: /* random* reference */
10180 ptr = POPPTR(ss,ix);
10181 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10182 ptr = POPPTR(ss,ix);
10183 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10185 case SAVEt_PPTR: /* char* reference */
10186 ptr = POPPTR(ss,ix);
10187 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10188 c = (char*)POPPTR(ss,ix);
10189 TOPPTR(nss,ix) = pv_dup(c);
10191 case SAVEt_HPTR: /* HV* reference */
10192 ptr = POPPTR(ss,ix);
10193 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10194 hv = (HV*)POPPTR(ss,ix);
10195 TOPPTR(nss,ix) = hv_dup(hv, param);
10197 case SAVEt_APTR: /* AV* reference */
10198 ptr = POPPTR(ss,ix);
10199 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10200 av = (AV*)POPPTR(ss,ix);
10201 TOPPTR(nss,ix) = av_dup(av, param);
10204 gv = (GV*)POPPTR(ss,ix);
10205 TOPPTR(nss,ix) = gv_dup(gv, param);
10207 case SAVEt_GP: /* scalar reference */
10208 gp = (GP*)POPPTR(ss,ix);
10209 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10210 (void)GpREFCNT_inc(gp);
10211 gv = (GV*)POPPTR(ss,ix);
10212 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10213 c = (char*)POPPTR(ss,ix);
10214 TOPPTR(nss,ix) = pv_dup(c);
10216 TOPIV(nss,ix) = iv;
10218 TOPIV(nss,ix) = iv;
10221 case SAVEt_MORTALIZESV:
10222 sv = (SV*)POPPTR(ss,ix);
10223 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10226 ptr = POPPTR(ss,ix);
10227 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10228 /* these are assumed to be refcounted properly */
10229 switch (((OP*)ptr)->op_type) {
10231 case OP_LEAVESUBLV:
10235 case OP_LEAVEWRITE:
10236 TOPPTR(nss,ix) = ptr;
10241 TOPPTR(nss,ix) = Nullop;
10246 TOPPTR(nss,ix) = Nullop;
10249 c = (char*)POPPTR(ss,ix);
10250 TOPPTR(nss,ix) = pv_dup_inc(c);
10252 case SAVEt_CLEARSV:
10253 longval = POPLONG(ss,ix);
10254 TOPLONG(nss,ix) = longval;
10257 hv = (HV*)POPPTR(ss,ix);
10258 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10259 c = (char*)POPPTR(ss,ix);
10260 TOPPTR(nss,ix) = pv_dup_inc(c);
10262 TOPINT(nss,ix) = i;
10264 case SAVEt_DESTRUCTOR:
10265 ptr = POPPTR(ss,ix);
10266 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10267 dptr = POPDPTR(ss,ix);
10268 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
10270 case SAVEt_DESTRUCTOR_X:
10271 ptr = POPPTR(ss,ix);
10272 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10273 dxptr = POPDXPTR(ss,ix);
10274 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
10276 case SAVEt_REGCONTEXT:
10279 TOPINT(nss,ix) = i;
10282 case SAVEt_STACK_POS: /* Position on Perl stack */
10284 TOPINT(nss,ix) = i;
10286 case SAVEt_AELEM: /* array element */
10287 sv = (SV*)POPPTR(ss,ix);
10288 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10290 TOPINT(nss,ix) = i;
10291 av = (AV*)POPPTR(ss,ix);
10292 TOPPTR(nss,ix) = av_dup_inc(av, param);
10294 case SAVEt_HELEM: /* hash element */
10295 sv = (SV*)POPPTR(ss,ix);
10296 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10297 sv = (SV*)POPPTR(ss,ix);
10298 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10299 hv = (HV*)POPPTR(ss,ix);
10300 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10303 ptr = POPPTR(ss,ix);
10304 TOPPTR(nss,ix) = ptr;
10308 TOPINT(nss,ix) = i;
10310 case SAVEt_COMPPAD:
10311 av = (AV*)POPPTR(ss,ix);
10312 TOPPTR(nss,ix) = av_dup(av, param);
10315 longval = (long)POPLONG(ss,ix);
10316 TOPLONG(nss,ix) = longval;
10317 ptr = POPPTR(ss,ix);
10318 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10319 sv = (SV*)POPPTR(ss,ix);
10320 TOPPTR(nss,ix) = sv_dup(sv, param);
10323 ptr = POPPTR(ss,ix);
10324 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10325 longval = (long)POPBOOL(ss,ix);
10326 TOPBOOL(nss,ix) = (bool)longval;
10329 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10337 =for apidoc perl_clone
10339 Create and return a new interpreter by cloning the current one.
10341 perl_clone takes these flags as paramters:
10343 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10344 without it we only clone the data and zero the stacks,
10345 with it we copy the stacks and the new perl interpreter is
10346 ready to run at the exact same point as the previous one.
10347 The pseudo-fork code uses COPY_STACKS while the
10348 threads->new doesn't.
10350 CLONEf_KEEP_PTR_TABLE
10351 perl_clone keeps a ptr_table with the pointer of the old
10352 variable as a key and the new variable as a value,
10353 this allows it to check if something has been cloned and not
10354 clone it again but rather just use the value and increase the
10355 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10356 the ptr_table using the function
10357 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10358 reason to keep it around is if you want to dup some of your own
10359 variable who are outside the graph perl scans, example of this
10360 code is in threads.xs create
10363 This is a win32 thing, it is ignored on unix, it tells perls
10364 win32host code (which is c++) to clone itself, this is needed on
10365 win32 if you want to run two threads at the same time,
10366 if you just want to do some stuff in a separate perl interpreter
10367 and then throw it away and return to the original one,
10368 you don't need to do anything.
10373 /* XXX the above needs expanding by someone who actually understands it ! */
10374 EXTERN_C PerlInterpreter *
10375 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10378 perl_clone(PerlInterpreter *proto_perl, UV flags)
10380 #ifdef PERL_IMPLICIT_SYS
10382 /* perlhost.h so we need to call into it
10383 to clone the host, CPerlHost should have a c interface, sky */
10385 if (flags & CLONEf_CLONE_HOST) {
10386 return perl_clone_host(proto_perl,flags);
10388 return perl_clone_using(proto_perl, flags,
10390 proto_perl->IMemShared,
10391 proto_perl->IMemParse,
10393 proto_perl->IStdIO,
10397 proto_perl->IProc);
10401 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10402 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10403 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10404 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10405 struct IPerlDir* ipD, struct IPerlSock* ipS,
10406 struct IPerlProc* ipP)
10408 /* XXX many of the string copies here can be optimized if they're
10409 * constants; they need to be allocated as common memory and just
10410 * their pointers copied. */
10413 CLONE_PARAMS clone_params;
10414 CLONE_PARAMS* param = &clone_params;
10416 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10417 PERL_SET_THX(my_perl);
10420 Poison(my_perl, 1, PerlInterpreter);
10425 PL_sig_pending = 0;
10426 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10427 # else /* !DEBUGGING */
10428 Zero(my_perl, 1, PerlInterpreter);
10429 # endif /* DEBUGGING */
10431 /* host pointers */
10433 PL_MemShared = ipMS;
10434 PL_MemParse = ipMP;
10441 #else /* !PERL_IMPLICIT_SYS */
10443 CLONE_PARAMS clone_params;
10444 CLONE_PARAMS* param = &clone_params;
10445 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10446 PERL_SET_THX(my_perl);
10451 Poison(my_perl, 1, PerlInterpreter);
10456 PL_sig_pending = 0;
10457 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10458 # else /* !DEBUGGING */
10459 Zero(my_perl, 1, PerlInterpreter);
10460 # endif /* DEBUGGING */
10461 #endif /* PERL_IMPLICIT_SYS */
10462 param->flags = flags;
10463 param->proto_perl = proto_perl;
10466 PL_xiv_arenaroot = NULL;
10467 PL_xiv_root = NULL;
10468 PL_xnv_arenaroot = NULL;
10469 PL_xnv_root = NULL;
10470 PL_xrv_arenaroot = NULL;
10471 PL_xrv_root = NULL;
10472 PL_xpv_arenaroot = NULL;
10473 PL_xpv_root = NULL;
10474 PL_xpviv_arenaroot = NULL;
10475 PL_xpviv_root = NULL;
10476 PL_xpvnv_arenaroot = NULL;
10477 PL_xpvnv_root = NULL;
10478 PL_xpvcv_arenaroot = NULL;
10479 PL_xpvcv_root = NULL;
10480 PL_xpvav_arenaroot = NULL;
10481 PL_xpvav_root = NULL;
10482 PL_xpvhv_arenaroot = NULL;
10483 PL_xpvhv_root = NULL;
10484 PL_xpvmg_arenaroot = NULL;
10485 PL_xpvmg_root = NULL;
10486 PL_xpvlv_arenaroot = NULL;
10487 PL_xpvlv_root = NULL;
10488 PL_xpvbm_arenaroot = NULL;
10489 PL_xpvbm_root = NULL;
10490 PL_he_arenaroot = NULL;
10492 PL_nice_chunk = NULL;
10493 PL_nice_chunk_size = 0;
10495 PL_sv_objcount = 0;
10496 PL_sv_root = Nullsv;
10497 PL_sv_arenaroot = Nullsv;
10499 PL_debug = proto_perl->Idebug;
10501 #ifdef USE_REENTRANT_API
10502 Perl_reentrant_init(aTHX);
10505 /* create SV map for pointer relocation */
10506 PL_ptr_table = ptr_table_new();
10508 /* initialize these special pointers as early as possible */
10509 SvANY(&PL_sv_undef) = NULL;
10510 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10511 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10512 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10514 SvANY(&PL_sv_no) = new_XPVNV();
10515 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10516 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10517 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
10518 SvCUR(&PL_sv_no) = 0;
10519 SvLEN(&PL_sv_no) = 1;
10520 SvNVX(&PL_sv_no) = 0;
10521 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10523 SvANY(&PL_sv_yes) = new_XPVNV();
10524 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10525 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10526 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
10527 SvCUR(&PL_sv_yes) = 1;
10528 SvLEN(&PL_sv_yes) = 2;
10529 SvNVX(&PL_sv_yes) = 1;
10530 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10532 /* create (a non-shared!) shared string table */
10533 PL_strtab = newHV();
10534 HvSHAREKEYS_off(PL_strtab);
10535 hv_ksplit(PL_strtab, 512);
10536 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10538 PL_compiling = proto_perl->Icompiling;
10540 /* These two PVs will be free'd special way so must set them same way op.c does */
10541 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10542 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10544 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10545 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10547 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10548 if (!specialWARN(PL_compiling.cop_warnings))
10549 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10550 if (!specialCopIO(PL_compiling.cop_io))
10551 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10552 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10554 /* pseudo environmental stuff */
10555 PL_origargc = proto_perl->Iorigargc;
10556 PL_origargv = proto_perl->Iorigargv;
10558 param->stashes = newAV(); /* Setup array of objects to call clone on */
10560 #ifdef PERLIO_LAYERS
10561 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10562 PerlIO_clone(aTHX_ proto_perl, param);
10565 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10566 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10567 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10568 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10569 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10570 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10573 PL_minus_c = proto_perl->Iminus_c;
10574 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10575 PL_localpatches = proto_perl->Ilocalpatches;
10576 PL_splitstr = proto_perl->Isplitstr;
10577 PL_preprocess = proto_perl->Ipreprocess;
10578 PL_minus_n = proto_perl->Iminus_n;
10579 PL_minus_p = proto_perl->Iminus_p;
10580 PL_minus_l = proto_perl->Iminus_l;
10581 PL_minus_a = proto_perl->Iminus_a;
10582 PL_minus_F = proto_perl->Iminus_F;
10583 PL_doswitches = proto_perl->Idoswitches;
10584 PL_dowarn = proto_perl->Idowarn;
10585 PL_doextract = proto_perl->Idoextract;
10586 PL_sawampersand = proto_perl->Isawampersand;
10587 PL_unsafe = proto_perl->Iunsafe;
10588 PL_inplace = SAVEPV(proto_perl->Iinplace);
10589 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10590 PL_perldb = proto_perl->Iperldb;
10591 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10592 PL_exit_flags = proto_perl->Iexit_flags;
10594 /* magical thingies */
10595 /* XXX time(&PL_basetime) when asked for? */
10596 PL_basetime = proto_perl->Ibasetime;
10597 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10599 PL_maxsysfd = proto_perl->Imaxsysfd;
10600 PL_multiline = proto_perl->Imultiline;
10601 PL_statusvalue = proto_perl->Istatusvalue;
10603 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10605 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10607 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10608 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10609 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10611 /* Clone the regex array */
10612 PL_regex_padav = newAV();
10614 I32 len = av_len((AV*)proto_perl->Iregex_padav);
10615 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10616 av_push(PL_regex_padav,
10617 sv_dup_inc(regexen[0],param));
10618 for(i = 1; i <= len; i++) {
10619 if(SvREPADTMP(regexen[i])) {
10620 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10622 av_push(PL_regex_padav,
10624 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10625 SvIVX(regexen[i])), param)))
10630 PL_regex_pad = AvARRAY(PL_regex_padav);
10632 /* shortcuts to various I/O objects */
10633 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10634 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10635 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10636 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10637 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10638 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10640 /* shortcuts to regexp stuff */
10641 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10643 /* shortcuts to misc objects */
10644 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10646 /* shortcuts to debugging objects */
10647 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10648 PL_DBline = gv_dup(proto_perl->IDBline, param);
10649 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10650 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10651 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10652 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10653 PL_lineary = av_dup(proto_perl->Ilineary, param);
10654 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10656 /* symbol tables */
10657 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10658 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10659 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10660 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10661 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10663 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10664 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10665 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10666 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10667 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10668 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10670 PL_sub_generation = proto_perl->Isub_generation;
10672 /* funky return mechanisms */
10673 PL_forkprocess = proto_perl->Iforkprocess;
10675 /* subprocess state */
10676 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10678 /* internal state */
10679 PL_tainting = proto_perl->Itainting;
10680 PL_maxo = proto_perl->Imaxo;
10681 if (proto_perl->Iop_mask)
10682 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10684 PL_op_mask = Nullch;
10686 /* current interpreter roots */
10687 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10688 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10689 PL_main_start = proto_perl->Imain_start;
10690 PL_eval_root = proto_perl->Ieval_root;
10691 PL_eval_start = proto_perl->Ieval_start;
10693 /* runtime control stuff */
10694 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10695 PL_copline = proto_perl->Icopline;
10697 PL_filemode = proto_perl->Ifilemode;
10698 PL_lastfd = proto_perl->Ilastfd;
10699 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10702 PL_gensym = proto_perl->Igensym;
10703 PL_preambled = proto_perl->Ipreambled;
10704 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10705 PL_laststatval = proto_perl->Ilaststatval;
10706 PL_laststype = proto_perl->Ilaststype;
10707 PL_mess_sv = Nullsv;
10709 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10710 PL_ofmt = SAVEPV(proto_perl->Iofmt);
10712 /* interpreter atexit processing */
10713 PL_exitlistlen = proto_perl->Iexitlistlen;
10714 if (PL_exitlistlen) {
10715 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10716 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10719 PL_exitlist = (PerlExitListEntry*)NULL;
10720 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10721 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10722 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10724 PL_profiledata = NULL;
10725 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10726 /* PL_rsfp_filters entries have fake IoDIRP() */
10727 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10729 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10731 PAD_CLONE_VARS(proto_perl, param);
10733 #ifdef HAVE_INTERP_INTERN
10734 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10737 /* more statics moved here */
10738 PL_generation = proto_perl->Igeneration;
10739 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10741 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10742 PL_in_clean_all = proto_perl->Iin_clean_all;
10744 PL_uid = proto_perl->Iuid;
10745 PL_euid = proto_perl->Ieuid;
10746 PL_gid = proto_perl->Igid;
10747 PL_egid = proto_perl->Iegid;
10748 PL_nomemok = proto_perl->Inomemok;
10749 PL_an = proto_perl->Ian;
10750 PL_op_seqmax = proto_perl->Iop_seqmax;
10751 PL_evalseq = proto_perl->Ievalseq;
10752 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10753 PL_origalen = proto_perl->Iorigalen;
10754 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10755 PL_osname = SAVEPV(proto_perl->Iosname);
10756 PL_sh_path = proto_perl->Ish_path; /* XXX never deallocated */
10757 PL_sighandlerp = proto_perl->Isighandlerp;
10760 PL_runops = proto_perl->Irunops;
10762 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10765 PL_cshlen = proto_perl->Icshlen;
10766 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10769 PL_lex_state = proto_perl->Ilex_state;
10770 PL_lex_defer = proto_perl->Ilex_defer;
10771 PL_lex_expect = proto_perl->Ilex_expect;
10772 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10773 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10774 PL_lex_starts = proto_perl->Ilex_starts;
10775 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10776 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10777 PL_lex_op = proto_perl->Ilex_op;
10778 PL_lex_inpat = proto_perl->Ilex_inpat;
10779 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10780 PL_lex_brackets = proto_perl->Ilex_brackets;
10781 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10782 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10783 PL_lex_casemods = proto_perl->Ilex_casemods;
10784 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10785 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10787 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10788 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10789 PL_nexttoke = proto_perl->Inexttoke;
10791 /* XXX This is probably masking the deeper issue of why
10792 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10793 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10794 * (A little debugging with a watchpoint on it may help.)
10796 if (SvANY(proto_perl->Ilinestr)) {
10797 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10798 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
10799 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10800 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
10801 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10802 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
10803 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10804 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
10805 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10808 PL_linestr = NEWSV(65,79);
10809 sv_upgrade(PL_linestr,SVt_PVIV);
10810 sv_setpvn(PL_linestr,"",0);
10811 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10813 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10814 PL_pending_ident = proto_perl->Ipending_ident;
10815 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10817 PL_expect = proto_perl->Iexpect;
10819 PL_multi_start = proto_perl->Imulti_start;
10820 PL_multi_end = proto_perl->Imulti_end;
10821 PL_multi_open = proto_perl->Imulti_open;
10822 PL_multi_close = proto_perl->Imulti_close;
10824 PL_error_count = proto_perl->Ierror_count;
10825 PL_subline = proto_perl->Isubline;
10826 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10828 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10829 if (SvANY(proto_perl->Ilinestr)) {
10830 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
10831 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10832 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
10833 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10834 PL_last_lop_op = proto_perl->Ilast_lop_op;
10837 PL_last_uni = SvPVX(PL_linestr);
10838 PL_last_lop = SvPVX(PL_linestr);
10839 PL_last_lop_op = 0;
10841 PL_in_my = proto_perl->Iin_my;
10842 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10844 PL_cryptseen = proto_perl->Icryptseen;
10847 PL_hints = proto_perl->Ihints;
10849 PL_amagic_generation = proto_perl->Iamagic_generation;
10851 #ifdef USE_LOCALE_COLLATE
10852 PL_collation_ix = proto_perl->Icollation_ix;
10853 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10854 PL_collation_standard = proto_perl->Icollation_standard;
10855 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10856 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10857 #endif /* USE_LOCALE_COLLATE */
10859 #ifdef USE_LOCALE_NUMERIC
10860 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10861 PL_numeric_standard = proto_perl->Inumeric_standard;
10862 PL_numeric_local = proto_perl->Inumeric_local;
10863 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10864 #endif /* !USE_LOCALE_NUMERIC */
10866 /* utf8 character classes */
10867 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10868 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10869 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10870 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10871 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10872 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10873 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10874 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10875 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10876 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10877 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10878 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10879 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10880 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10881 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10882 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10883 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10884 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10885 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10886 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10889 PL_last_swash_hv = Nullhv; /* reinits on demand */
10890 PL_last_swash_klen = 0;
10891 PL_last_swash_key[0]= '\0';
10892 PL_last_swash_tmps = (U8*)NULL;
10893 PL_last_swash_slen = 0;
10895 /* perly.c globals */
10896 PL_yydebug = proto_perl->Iyydebug;
10897 PL_yynerrs = proto_perl->Iyynerrs;
10898 PL_yyerrflag = proto_perl->Iyyerrflag;
10899 PL_yychar = proto_perl->Iyychar;
10900 PL_yyval = proto_perl->Iyyval;
10901 PL_yylval = proto_perl->Iyylval;
10903 PL_glob_index = proto_perl->Iglob_index;
10904 PL_srand_called = proto_perl->Isrand_called;
10905 PL_uudmap['M'] = 0; /* reinits on demand */
10906 PL_bitcount = Nullch; /* reinits on demand */
10908 if (proto_perl->Ipsig_pend) {
10909 Newz(0, PL_psig_pend, SIG_SIZE, int);
10912 PL_psig_pend = (int*)NULL;
10915 if (proto_perl->Ipsig_ptr) {
10916 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
10917 Newz(0, PL_psig_name, SIG_SIZE, SV*);
10918 for (i = 1; i < SIG_SIZE; i++) {
10919 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10920 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10924 PL_psig_ptr = (SV**)NULL;
10925 PL_psig_name = (SV**)NULL;
10928 /* thrdvar.h stuff */
10930 if (flags & CLONEf_COPY_STACKS) {
10931 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10932 PL_tmps_ix = proto_perl->Ttmps_ix;
10933 PL_tmps_max = proto_perl->Ttmps_max;
10934 PL_tmps_floor = proto_perl->Ttmps_floor;
10935 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
10937 while (i <= PL_tmps_ix) {
10938 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10942 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10943 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10944 Newz(54, PL_markstack, i, I32);
10945 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10946 - proto_perl->Tmarkstack);
10947 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10948 - proto_perl->Tmarkstack);
10949 Copy(proto_perl->Tmarkstack, PL_markstack,
10950 PL_markstack_ptr - PL_markstack + 1, I32);
10952 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10953 * NOTE: unlike the others! */
10954 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10955 PL_scopestack_max = proto_perl->Tscopestack_max;
10956 Newz(54, PL_scopestack, PL_scopestack_max, I32);
10957 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10959 /* next push_return() sets PL_retstack[PL_retstack_ix]
10960 * NOTE: unlike the others! */
10961 PL_retstack_ix = proto_perl->Tretstack_ix;
10962 PL_retstack_max = proto_perl->Tretstack_max;
10963 Newz(54, PL_retstack, PL_retstack_max, OP*);
10964 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
10966 /* NOTE: si_dup() looks at PL_markstack */
10967 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10969 /* PL_curstack = PL_curstackinfo->si_stack; */
10970 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10971 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10973 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10974 PL_stack_base = AvARRAY(PL_curstack);
10975 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10976 - proto_perl->Tstack_base);
10977 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10979 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10980 * NOTE: unlike the others! */
10981 PL_savestack_ix = proto_perl->Tsavestack_ix;
10982 PL_savestack_max = proto_perl->Tsavestack_max;
10983 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
10984 PL_savestack = ss_dup(proto_perl, param);
10988 ENTER; /* perl_destruct() wants to LEAVE; */
10991 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10992 PL_top_env = &PL_start_env;
10994 PL_op = proto_perl->Top;
10997 PL_Xpv = (XPV*)NULL;
10998 PL_na = proto_perl->Tna;
11000 PL_statbuf = proto_perl->Tstatbuf;
11001 PL_statcache = proto_perl->Tstatcache;
11002 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11003 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11005 PL_timesbuf = proto_perl->Ttimesbuf;
11008 PL_tainted = proto_perl->Ttainted;
11009 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11010 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11011 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11012 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11013 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11014 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11015 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11016 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11017 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11019 PL_restartop = proto_perl->Trestartop;
11020 PL_in_eval = proto_perl->Tin_eval;
11021 PL_delaymagic = proto_perl->Tdelaymagic;
11022 PL_dirty = proto_perl->Tdirty;
11023 PL_localizing = proto_perl->Tlocalizing;
11025 #ifdef PERL_FLEXIBLE_EXCEPTIONS
11026 PL_protect = proto_perl->Tprotect;
11028 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11029 PL_av_fetch_sv = Nullsv;
11030 PL_hv_fetch_sv = Nullsv;
11031 Zero(&PL_hv_fetch_ent_mh, 1, HE); /* XXX */
11032 PL_modcount = proto_perl->Tmodcount;
11033 PL_lastgotoprobe = Nullop;
11034 PL_dumpindent = proto_perl->Tdumpindent;
11036 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11037 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11038 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11039 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11040 PL_sortcxix = proto_perl->Tsortcxix;
11041 PL_efloatbuf = Nullch; /* reinits on demand */
11042 PL_efloatsize = 0; /* reinits on demand */
11046 PL_screamfirst = NULL;
11047 PL_screamnext = NULL;
11048 PL_maxscream = -1; /* reinits on demand */
11049 PL_lastscream = Nullsv;
11051 PL_watchaddr = NULL;
11052 PL_watchok = Nullch;
11054 PL_regdummy = proto_perl->Tregdummy;
11055 PL_regprecomp = Nullch;
11058 PL_colorset = 0; /* reinits PL_colors[] */
11059 /*PL_colors[6] = {0,0,0,0,0,0};*/
11060 PL_reginput = Nullch;
11061 PL_regbol = Nullch;
11062 PL_regeol = Nullch;
11063 PL_regstartp = (I32*)NULL;
11064 PL_regendp = (I32*)NULL;
11065 PL_reglastparen = (U32*)NULL;
11066 PL_regtill = Nullch;
11067 PL_reg_start_tmp = (char**)NULL;
11068 PL_reg_start_tmpl = 0;
11069 PL_regdata = (struct reg_data*)NULL;
11072 PL_reg_eval_set = 0;
11074 PL_regprogram = (regnode*)NULL;
11076 PL_regcc = (CURCUR*)NULL;
11077 PL_reg_call_cc = (struct re_cc_state*)NULL;
11078 PL_reg_re = (regexp*)NULL;
11079 PL_reg_ganch = Nullch;
11080 PL_reg_sv = Nullsv;
11081 PL_reg_match_utf8 = FALSE;
11082 PL_reg_magic = (MAGIC*)NULL;
11084 PL_reg_oldcurpm = (PMOP*)NULL;
11085 PL_reg_curpm = (PMOP*)NULL;
11086 PL_reg_oldsaved = Nullch;
11087 PL_reg_oldsavedlen = 0;
11088 PL_reg_maxiter = 0;
11089 PL_reg_leftiter = 0;
11090 PL_reg_poscache = Nullch;
11091 PL_reg_poscache_size= 0;
11093 /* RE engine - function pointers */
11094 PL_regcompp = proto_perl->Tregcompp;
11095 PL_regexecp = proto_perl->Tregexecp;
11096 PL_regint_start = proto_perl->Tregint_start;
11097 PL_regint_string = proto_perl->Tregint_string;
11098 PL_regfree = proto_perl->Tregfree;
11100 PL_reginterp_cnt = 0;
11101 PL_reg_starttry = 0;
11103 /* Pluggable optimizer */
11104 PL_peepp = proto_perl->Tpeepp;
11106 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11107 ptr_table_free(PL_ptr_table);
11108 PL_ptr_table = NULL;
11111 /* Call the ->CLONE method, if it exists, for each of the stashes
11112 identified by sv_dup() above.
11114 while(av_len(param->stashes) != -1) {
11115 HV* stash = (HV*) av_shift(param->stashes);
11116 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11117 if (cloner && GvCV(cloner)) {
11122 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
11124 call_sv((SV*)GvCV(cloner), G_DISCARD);
11130 SvREFCNT_dec(param->stashes);
11135 #endif /* USE_ITHREADS */
11138 =head1 Unicode Support
11140 =for apidoc sv_recode_to_utf8
11142 The encoding is assumed to be an Encode object, on entry the PV
11143 of the sv is assumed to be octets in that encoding, and the sv
11144 will be converted into Unicode (and UTF-8).
11146 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11147 is not a reference, nothing is done to the sv. If the encoding is not
11148 an C<Encode::XS> Encoding object, bad things will happen.
11149 (See F<lib/encoding.pm> and L<Encode>).
11151 The PV of the sv is returned.
11156 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11158 if (SvPOK(sv) && !DO_UTF8(sv) && SvROK(encoding)) {
11172 Passing sv_yes is wrong - it needs to be or'ed set of constants
11173 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11174 remove converted chars from source.
11176 Both will default the value - let them.
11178 XPUSHs(&PL_sv_yes);
11181 call_method("decode", G_SCALAR);
11185 s = SvPV(uni, len);
11187 U8 *t = (U8 *)s, *e = (U8 *)s + len;
11189 if ((vary = !UTF8_IS_INVARIANT(*t++)))
11193 if (s != SvPVX(sv)) {
11194 SvGROW(sv, len + 1);
11195 Move(s, SvPVX(sv), len, char);
11196 SvCUR_set(sv, len);
11197 SvPVX(sv)[len] = 0;