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 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4421 and we do that anyway inside the SvNIOK_off
4423 SvFLAGS(sv) |= SVf_OOK;
4426 delta = ptr - SvPVX(sv);
4434 =for apidoc sv_catpvn
4436 Concatenates the string onto the end of the string which is in the SV. The
4437 C<len> indicates number of bytes to copy. If the SV has the UTF8
4438 status set, then the bytes appended should be valid UTF8.
4439 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4441 =for apidoc sv_catpvn_flags
4443 Concatenates the string onto the end of the string which is in the SV. The
4444 C<len> indicates number of bytes to copy. If the SV has the UTF8
4445 status set, then the bytes appended should be valid UTF8.
4446 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4447 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4448 in terms of this function.
4454 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4459 dstr = SvPV_force_flags(dsv, dlen, flags);
4460 SvGROW(dsv, dlen + slen + 1);
4463 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4466 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4471 =for apidoc sv_catpvn_mg
4473 Like C<sv_catpvn>, but also handles 'set' magic.
4479 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4481 sv_catpvn(sv,ptr,len);
4486 =for apidoc sv_catsv
4488 Concatenates the string from SV C<ssv> onto the end of the string in
4489 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4490 not 'set' magic. See C<sv_catsv_mg>.
4492 =for apidoc sv_catsv_flags
4494 Concatenates the string from SV C<ssv> onto the end of the string in
4495 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4496 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4497 and C<sv_catsv_nomg> are implemented in terms of this function.
4502 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4508 if ((spv = SvPV(ssv, slen))) {
4509 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4510 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4511 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4512 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4513 dsv->sv_flags doesn't have that bit set.
4514 Andy Dougherty 12 Oct 2001
4516 I32 sutf8 = DO_UTF8(ssv);
4519 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4521 dutf8 = DO_UTF8(dsv);
4523 if (dutf8 != sutf8) {
4525 /* Not modifying source SV, so taking a temporary copy. */
4526 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4528 sv_utf8_upgrade(csv);
4529 spv = SvPV(csv, slen);
4532 sv_utf8_upgrade_nomg(dsv);
4534 sv_catpvn_nomg(dsv, spv, slen);
4539 =for apidoc sv_catsv_mg
4541 Like C<sv_catsv>, but also handles 'set' magic.
4547 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4554 =for apidoc sv_catpv
4556 Concatenates the string onto the end of the string which is in the SV.
4557 If the SV has the UTF8 status set, then the bytes appended should be
4558 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4563 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4565 register STRLEN len;
4571 junk = SvPV_force(sv, tlen);
4573 SvGROW(sv, tlen + len + 1);
4576 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4578 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4583 =for apidoc sv_catpv_mg
4585 Like C<sv_catpv>, but also handles 'set' magic.
4591 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4600 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4601 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4608 Perl_newSV(pTHX_ STRLEN len)
4614 sv_upgrade(sv, SVt_PV);
4615 SvGROW(sv, len + 1);
4620 =for apidoc sv_magicext
4622 Adds magic to an SV, upgrading it if necessary. Applies the
4623 supplied vtable and returns pointer to the magic added.
4625 Note that sv_magicext will allow things that sv_magic will not.
4626 In particular you can add magic to SvREADONLY SVs and and more than
4627 one instance of the same 'how'
4629 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4630 if C<namelen> is zero then C<name> is stored as-is and - as another special
4631 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4632 an C<SV*> and has its REFCNT incremented
4634 (This is now used as a subroutine by sv_magic.)
4639 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4640 const char* name, I32 namlen)
4644 if (SvTYPE(sv) < SVt_PVMG) {
4645 (void)SvUPGRADE(sv, SVt_PVMG);
4647 Newz(702,mg, 1, MAGIC);
4648 mg->mg_moremagic = SvMAGIC(sv);
4651 /* Some magic sontains a reference loop, where the sv and object refer to
4652 each other. To prevent a reference loop that would prevent such
4653 objects being freed, we look for such loops and if we find one we
4654 avoid incrementing the object refcount.
4656 Note we cannot do this to avoid self-tie loops as intervening RV must
4657 have its REFCNT incremented to keep it in existence.
4660 if (!obj || obj == sv ||
4661 how == PERL_MAGIC_arylen ||
4662 how == PERL_MAGIC_qr ||
4663 (SvTYPE(obj) == SVt_PVGV &&
4664 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4665 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4666 GvFORM(obj) == (CV*)sv)))
4671 mg->mg_obj = SvREFCNT_inc(obj);
4672 mg->mg_flags |= MGf_REFCOUNTED;
4675 /* Normal self-ties simply pass a null object, and instead of
4676 using mg_obj directly, use the SvTIED_obj macro to produce a
4677 new RV as needed. For glob "self-ties", we are tieing the PVIO
4678 with an RV obj pointing to the glob containing the PVIO. In
4679 this case, to avoid a reference loop, we need to weaken the
4683 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4684 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4690 mg->mg_len = namlen;
4693 mg->mg_ptr = savepvn(name, namlen);
4694 else if (namlen == HEf_SVKEY)
4695 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4697 mg->mg_ptr = (char *) name;
4699 mg->mg_virtual = vtable;
4703 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4708 =for apidoc sv_magic
4710 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4711 then adds a new magic item of type C<how> to the head of the magic list.
4717 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4722 #ifdef PERL_COPY_ON_WRITE
4724 sv_force_normal_flags(sv, 0);
4726 if (SvREADONLY(sv)) {
4727 if (PL_curcop != &PL_compiling
4728 && how != PERL_MAGIC_regex_global
4729 && how != PERL_MAGIC_bm
4730 && how != PERL_MAGIC_fm
4731 && how != PERL_MAGIC_sv
4734 Perl_croak(aTHX_ PL_no_modify);
4737 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4738 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4739 /* sv_magic() refuses to add a magic of the same 'how' as an
4742 if (how == PERL_MAGIC_taint)
4750 vtable = &PL_vtbl_sv;
4752 case PERL_MAGIC_overload:
4753 vtable = &PL_vtbl_amagic;
4755 case PERL_MAGIC_overload_elem:
4756 vtable = &PL_vtbl_amagicelem;
4758 case PERL_MAGIC_overload_table:
4759 vtable = &PL_vtbl_ovrld;
4762 vtable = &PL_vtbl_bm;
4764 case PERL_MAGIC_regdata:
4765 vtable = &PL_vtbl_regdata;
4767 case PERL_MAGIC_regdatum:
4768 vtable = &PL_vtbl_regdatum;
4770 case PERL_MAGIC_env:
4771 vtable = &PL_vtbl_env;
4774 vtable = &PL_vtbl_fm;
4776 case PERL_MAGIC_envelem:
4777 vtable = &PL_vtbl_envelem;
4779 case PERL_MAGIC_regex_global:
4780 vtable = &PL_vtbl_mglob;
4782 case PERL_MAGIC_isa:
4783 vtable = &PL_vtbl_isa;
4785 case PERL_MAGIC_isaelem:
4786 vtable = &PL_vtbl_isaelem;
4788 case PERL_MAGIC_nkeys:
4789 vtable = &PL_vtbl_nkeys;
4791 case PERL_MAGIC_dbfile:
4794 case PERL_MAGIC_dbline:
4795 vtable = &PL_vtbl_dbline;
4797 #ifdef USE_LOCALE_COLLATE
4798 case PERL_MAGIC_collxfrm:
4799 vtable = &PL_vtbl_collxfrm;
4801 #endif /* USE_LOCALE_COLLATE */
4802 case PERL_MAGIC_tied:
4803 vtable = &PL_vtbl_pack;
4805 case PERL_MAGIC_tiedelem:
4806 case PERL_MAGIC_tiedscalar:
4807 vtable = &PL_vtbl_packelem;
4810 vtable = &PL_vtbl_regexp;
4812 case PERL_MAGIC_sig:
4813 vtable = &PL_vtbl_sig;
4815 case PERL_MAGIC_sigelem:
4816 vtable = &PL_vtbl_sigelem;
4818 case PERL_MAGIC_taint:
4819 vtable = &PL_vtbl_taint;
4821 case PERL_MAGIC_uvar:
4822 vtable = &PL_vtbl_uvar;
4824 case PERL_MAGIC_vec:
4825 vtable = &PL_vtbl_vec;
4827 case PERL_MAGIC_vstring:
4830 case PERL_MAGIC_utf8:
4831 vtable = &PL_vtbl_utf8;
4833 case PERL_MAGIC_substr:
4834 vtable = &PL_vtbl_substr;
4836 case PERL_MAGIC_defelem:
4837 vtable = &PL_vtbl_defelem;
4839 case PERL_MAGIC_glob:
4840 vtable = &PL_vtbl_glob;
4842 case PERL_MAGIC_arylen:
4843 vtable = &PL_vtbl_arylen;
4845 case PERL_MAGIC_pos:
4846 vtable = &PL_vtbl_pos;
4848 case PERL_MAGIC_backref:
4849 vtable = &PL_vtbl_backref;
4851 case PERL_MAGIC_ext:
4852 /* Reserved for use by extensions not perl internals. */
4853 /* Useful for attaching extension internal data to perl vars. */
4854 /* Note that multiple extensions may clash if magical scalars */
4855 /* etc holding private data from one are passed to another. */
4858 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4861 /* Rest of work is done else where */
4862 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4865 case PERL_MAGIC_taint:
4868 case PERL_MAGIC_ext:
4869 case PERL_MAGIC_dbfile:
4876 =for apidoc sv_unmagic
4878 Removes all magic of type C<type> from an SV.
4884 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4888 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4891 for (mg = *mgp; mg; mg = *mgp) {
4892 if (mg->mg_type == type) {
4893 MGVTBL* vtbl = mg->mg_virtual;
4894 *mgp = mg->mg_moremagic;
4895 if (vtbl && vtbl->svt_free)
4896 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4897 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4899 Safefree(mg->mg_ptr);
4900 else if (mg->mg_len == HEf_SVKEY)
4901 SvREFCNT_dec((SV*)mg->mg_ptr);
4902 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4903 Safefree(mg->mg_ptr);
4905 if (mg->mg_flags & MGf_REFCOUNTED)
4906 SvREFCNT_dec(mg->mg_obj);
4910 mgp = &mg->mg_moremagic;
4914 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4921 =for apidoc sv_rvweaken
4923 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4924 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4925 push a back-reference to this RV onto the array of backreferences
4926 associated with that magic.
4932 Perl_sv_rvweaken(pTHX_ SV *sv)
4935 if (!SvOK(sv)) /* let undefs pass */
4938 Perl_croak(aTHX_ "Can't weaken a nonreference");
4939 else if (SvWEAKREF(sv)) {
4940 if (ckWARN(WARN_MISC))
4941 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4945 sv_add_backref(tsv, sv);
4951 /* Give tsv backref magic if it hasn't already got it, then push a
4952 * back-reference to sv onto the array associated with the backref magic.
4956 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4960 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4961 av = (AV*)mg->mg_obj;
4964 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4965 SvREFCNT_dec(av); /* for sv_magic */
4970 /* delete a back-reference to ourselves from the backref magic associated
4971 * with the SV we point to.
4975 S_sv_del_backref(pTHX_ SV *sv)
4982 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4983 Perl_croak(aTHX_ "panic: del_backref");
4984 av = (AV *)mg->mg_obj;
4989 svp[i] = &PL_sv_undef; /* XXX */
4996 =for apidoc sv_insert
4998 Inserts a string at the specified offset/length within the SV. Similar to
4999 the Perl substr() function.
5005 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5009 register char *midend;
5010 register char *bigend;
5016 Perl_croak(aTHX_ "Can't modify non-existent substring");
5017 SvPV_force(bigstr, curlen);
5018 (void)SvPOK_only_UTF8(bigstr);
5019 if (offset + len > curlen) {
5020 SvGROW(bigstr, offset+len+1);
5021 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5022 SvCUR_set(bigstr, offset+len);
5026 i = littlelen - len;
5027 if (i > 0) { /* string might grow */
5028 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5029 mid = big + offset + len;
5030 midend = bigend = big + SvCUR(bigstr);
5033 while (midend > mid) /* shove everything down */
5034 *--bigend = *--midend;
5035 Move(little,big+offset,littlelen,char);
5041 Move(little,SvPVX(bigstr)+offset,len,char);
5046 big = SvPVX(bigstr);
5049 bigend = big + SvCUR(bigstr);
5051 if (midend > bigend)
5052 Perl_croak(aTHX_ "panic: sv_insert");
5054 if (mid - big > bigend - midend) { /* faster to shorten from end */
5056 Move(little, mid, littlelen,char);
5059 i = bigend - midend;
5061 Move(midend, mid, i,char);
5065 SvCUR_set(bigstr, mid - big);
5068 else if ((i = mid - big)) { /* faster from front */
5069 midend -= littlelen;
5071 sv_chop(bigstr,midend-i);
5076 Move(little, mid, littlelen,char);
5078 else if (littlelen) {
5079 midend -= littlelen;
5080 sv_chop(bigstr,midend);
5081 Move(little,midend,littlelen,char);
5084 sv_chop(bigstr,midend);
5090 =for apidoc sv_replace
5092 Make the first argument a copy of the second, then delete the original.
5093 The target SV physically takes over ownership of the body of the source SV
5094 and inherits its flags; however, the target keeps any magic it owns,
5095 and any magic in the source is discarded.
5096 Note that this is a rather specialist SV copying operation; most of the
5097 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5103 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5105 U32 refcnt = SvREFCNT(sv);
5106 SV_CHECK_THINKFIRST_COW_DROP(sv);
5107 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5108 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5109 if (SvMAGICAL(sv)) {
5113 sv_upgrade(nsv, SVt_PVMG);
5114 SvMAGIC(nsv) = SvMAGIC(sv);
5115 SvFLAGS(nsv) |= SvMAGICAL(sv);
5121 assert(!SvREFCNT(sv));
5122 StructCopy(nsv,sv,SV);
5123 #ifdef PERL_COPY_ON_WRITE
5124 if (SvIsCOW_normal(nsv)) {
5125 /* We need to follow the pointers around the loop to make the
5126 previous SV point to sv, rather than nsv. */
5129 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5132 assert(SvPVX(current) == SvPVX(nsv));
5134 /* Make the SV before us point to the SV after us. */
5136 PerlIO_printf(Perl_debug_log, "previous is\n");
5138 PerlIO_printf(Perl_debug_log,
5139 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5140 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5142 SV_COW_NEXT_SV_SET(current, sv);
5145 SvREFCNT(sv) = refcnt;
5146 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5151 =for apidoc sv_clear
5153 Clear an SV: call any destructors, free up any memory used by the body,
5154 and free the body itself. The SV's head is I<not> freed, although
5155 its type is set to all 1's so that it won't inadvertently be assumed
5156 to be live during global destruction etc.
5157 This function should only be called when REFCNT is zero. Most of the time
5158 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5165 Perl_sv_clear(pTHX_ register SV *sv)
5169 assert(SvREFCNT(sv) == 0);
5172 if (PL_defstash) { /* Still have a symbol table? */
5177 Zero(&tmpref, 1, SV);
5178 sv_upgrade(&tmpref, SVt_RV);
5180 SvREADONLY_on(&tmpref); /* DESTROY() could be naughty */
5181 SvREFCNT(&tmpref) = 1;
5184 stash = SvSTASH(sv);
5185 destructor = StashHANDLER(stash,DESTROY);
5188 PUSHSTACKi(PERLSI_DESTROY);
5189 SvRV(&tmpref) = SvREFCNT_inc(sv);
5194 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5200 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5202 del_XRV(SvANY(&tmpref));
5205 if (PL_in_clean_objs)
5206 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5208 /* DESTROY gave object new lease on life */
5214 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5215 SvOBJECT_off(sv); /* Curse the object. */
5216 if (SvTYPE(sv) != SVt_PVIO)
5217 --PL_sv_objcount; /* XXX Might want something more general */
5220 if (SvTYPE(sv) >= SVt_PVMG) {
5223 if (SvFLAGS(sv) & SVpad_TYPED)
5224 SvREFCNT_dec(SvSTASH(sv));
5227 switch (SvTYPE(sv)) {
5230 IoIFP(sv) != PerlIO_stdin() &&
5231 IoIFP(sv) != PerlIO_stdout() &&
5232 IoIFP(sv) != PerlIO_stderr())
5234 io_close((IO*)sv, FALSE);
5236 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5237 PerlDir_close(IoDIRP(sv));
5238 IoDIRP(sv) = (DIR*)NULL;
5239 Safefree(IoTOP_NAME(sv));
5240 Safefree(IoFMT_NAME(sv));
5241 Safefree(IoBOTTOM_NAME(sv));
5256 SvREFCNT_dec(LvTARG(sv));
5260 Safefree(GvNAME(sv));
5261 /* cannot decrease stash refcount yet, as we might recursively delete
5262 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5263 of stash until current sv is completely gone.
5264 -- JohnPC, 27 Mar 1998 */
5265 stash = GvSTASH(sv);
5271 (void)SvOOK_off(sv);
5279 SvREFCNT_dec(SvRV(sv));
5281 #ifdef PERL_COPY_ON_WRITE
5282 else if (SvPVX(sv)) {
5284 /* I believe I need to grab the global SV mutex here and
5285 then recheck the COW status. */
5287 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5290 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5291 SvUVX(sv), SV_COW_NEXT_SV(sv));
5292 /* And drop it here. */
5294 } else if (SvLEN(sv)) {
5295 Safefree(SvPVX(sv));
5299 else if (SvPVX(sv) && SvLEN(sv))
5300 Safefree(SvPVX(sv));
5301 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5302 unsharepvn(SvPVX(sv),
5303 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5317 switch (SvTYPE(sv)) {
5333 del_XPVIV(SvANY(sv));
5336 del_XPVNV(SvANY(sv));
5339 del_XPVMG(SvANY(sv));
5342 del_XPVLV(SvANY(sv));
5345 del_XPVAV(SvANY(sv));
5348 del_XPVHV(SvANY(sv));
5351 del_XPVCV(SvANY(sv));
5354 del_XPVGV(SvANY(sv));
5355 /* code duplication for increased performance. */
5356 SvFLAGS(sv) &= SVf_BREAK;
5357 SvFLAGS(sv) |= SVTYPEMASK;
5358 /* decrease refcount of the stash that owns this GV, if any */
5360 SvREFCNT_dec(stash);
5361 return; /* not break, SvFLAGS reset already happened */
5363 del_XPVBM(SvANY(sv));
5366 del_XPVFM(SvANY(sv));
5369 del_XPVIO(SvANY(sv));
5372 SvFLAGS(sv) &= SVf_BREAK;
5373 SvFLAGS(sv) |= SVTYPEMASK;
5377 =for apidoc sv_newref
5379 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5386 Perl_sv_newref(pTHX_ SV *sv)
5389 ATOMIC_INC(SvREFCNT(sv));
5396 Decrement an SV's reference count, and if it drops to zero, call
5397 C<sv_clear> to invoke destructors and free up any memory used by
5398 the body; finally, deallocate the SV's head itself.
5399 Normally called via a wrapper macro C<SvREFCNT_dec>.
5405 Perl_sv_free(pTHX_ SV *sv)
5407 int refcount_is_zero;
5411 if (SvREFCNT(sv) == 0) {
5412 if (SvFLAGS(sv) & SVf_BREAK)
5413 /* this SV's refcnt has been artificially decremented to
5414 * trigger cleanup */
5416 if (PL_in_clean_all) /* All is fair */
5418 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5419 /* make sure SvREFCNT(sv)==0 happens very seldom */
5420 SvREFCNT(sv) = (~(U32)0)/2;
5423 if (ckWARN_d(WARN_INTERNAL))
5424 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Attempt to free unreferenced scalar");
5427 ATOMIC_DEC_AND_TEST(refcount_is_zero, SvREFCNT(sv));
5428 if (!refcount_is_zero)
5432 if (ckWARN_d(WARN_DEBUGGING))
5433 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5434 "Attempt to free temp prematurely: SV 0x%"UVxf,
5439 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5440 /* make sure SvREFCNT(sv)==0 happens very seldom */
5441 SvREFCNT(sv) = (~(U32)0)/2;
5452 Returns the length of the string in the SV. Handles magic and type
5453 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5459 Perl_sv_len(pTHX_ register SV *sv)
5467 len = mg_length(sv);
5469 (void)SvPV(sv, len);
5474 =for apidoc sv_len_utf8
5476 Returns the number of characters in the string in an SV, counting wide
5477 UTF8 bytes as a single character. Handles magic and type coercion.
5483 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5484 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5485 * (Note that the mg_len is not the length of the mg_ptr field.)
5490 Perl_sv_len_utf8(pTHX_ register SV *sv)
5496 return mg_length(sv);
5500 U8 *s = (U8*)SvPV(sv, len);
5501 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5503 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0))
5506 ulen = Perl_utf8_length(aTHX_ s, s + len);
5507 if (!mg && !SvREADONLY(sv)) {
5508 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5509 mg = mg_find(sv, PERL_MAGIC_utf8);
5519 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5520 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5521 * between UTF-8 and byte offsets. There are two (substr offset and substr
5522 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5523 * and byte offset) cache positions.
5525 * The mg_len field is used by sv_len_utf8(), see its comments.
5526 * Note that the mg_len is not the length of the mg_ptr field.
5530 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
5534 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5536 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5537 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5542 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5544 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5545 (*mgp)->mg_ptr = (char *) *cachep;
5549 (*cachep)[i] = *offsetp;
5550 (*cachep)[i+1] = s - start;
5558 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5559 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5560 * between UTF-8 and byte offsets. See also the comments of
5561 * S_utf8_mg_pos_init().
5565 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
5569 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5571 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5572 if (*mgp && (*mgp)->mg_ptr) {
5573 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5574 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5576 else { /* We will skip to the right spot. */
5581 /* The assumption is that going backward is half
5582 * the speed of going forward (that's where the
5583 * 2 * backw in the below comes from). (The real
5584 * figure of course depends on the UTF-8 data.) */
5586 if ((*cachep)[i] > (STRLEN)uoff) {
5588 backw = (*cachep)[i] - (STRLEN)uoff;
5590 if (forw < 2 * backw)
5593 p = start + (*cachep)[i+1];
5595 /* Try this only for the substr offset (i == 0),
5596 * not for the substr length (i == 2). */
5597 else if (i == 0) { /* (*cachep)[i] < uoff */
5598 STRLEN ulen = sv_len_utf8(sv);
5600 if ((STRLEN)uoff < ulen) {
5601 forw = (STRLEN)uoff - (*cachep)[i];
5602 backw = ulen - (STRLEN)uoff;
5604 if (forw < 2 * backw)
5605 p = start + (*cachep)[i+1];
5610 /* If the string is not long enough for uoff,
5611 * we could extend it, but not at this low a level. */
5615 if (forw < 2 * backw) {
5622 while (UTF8_IS_CONTINUATION(*p))
5627 /* Update the cache. */
5628 (*cachep)[i] = (STRLEN)uoff;
5629 (*cachep)[i+1] = p - start;
5634 if (found) { /* Setup the return values. */
5635 *offsetp = (*cachep)[i+1];
5636 *sp = start + *offsetp;
5639 *offsetp = send - start;
5641 else if (*sp < start) {
5652 =for apidoc sv_pos_u2b
5654 Converts the value pointed to by offsetp from a count of UTF8 chars from
5655 the start of the string, to a count of the equivalent number of bytes; if
5656 lenp is non-zero, it does the same to lenp, but this time starting from
5657 the offset, rather than from the start of the string. Handles magic and
5664 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5665 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5666 * byte offsets. See also the comments of S_utf8_mg_pos().
5671 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5682 start = s = (U8*)SvPV(sv, len);
5684 I32 uoffset = *offsetp;
5689 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5691 if (!found && uoffset > 0) {
5692 while (s < send && uoffset--)
5696 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
5698 *offsetp = s - start;
5703 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
5707 if (!found && *lenp > 0) {
5710 while (s < send && ulen--)
5714 if (utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start))
5715 cache[2] += *offsetp;
5729 =for apidoc sv_pos_b2u
5731 Converts the value pointed to by offsetp from a count of bytes from the
5732 start of the string, to a count of the equivalent number of UTF8 chars.
5733 Handles magic and type coercion.
5739 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5740 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5741 * byte offsets. See also the comments of S_utf8_mg_pos().
5746 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5754 s = (U8*)SvPV(sv, len);
5755 if ((I32)len < *offsetp)
5756 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5758 U8* send = s + *offsetp;
5760 STRLEN *cache = NULL;
5764 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5765 mg = mg_find(sv, PERL_MAGIC_utf8);
5766 if (mg && mg->mg_ptr) {
5767 cache = (STRLEN *) mg->mg_ptr;
5768 if (cache[1] == *offsetp) {
5769 /* An exact match. */
5770 *offsetp = cache[0];
5774 else if (cache[1] < *offsetp) {
5775 /* We already know part of the way. */
5778 /* Let the below loop do the rest. */
5780 else { /* cache[1] > *offsetp */
5781 /* We already know all of the way, now we may
5782 * be able to walk back. The same assumption
5783 * is made as in S_utf8_mg_pos(), namely that
5784 * walking backward is twice slower than
5785 * walking forward. */
5786 STRLEN forw = *offsetp;
5787 STRLEN backw = cache[1] - *offsetp;
5789 if (!(forw < 2 * backw)) {
5790 U8 *p = s + cache[1];
5797 while (UTF8_IS_CONTINUATION(*p))
5813 /* Call utf8n_to_uvchr() to validate the sequence
5814 * (unless a simple non-UTF character) */
5815 if (!UTF8_IS_INVARIANT(*s))
5816 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5825 if (!SvREADONLY(sv)) {
5827 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5828 mg = mg_find(sv, PERL_MAGIC_utf8);
5833 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5834 mg->mg_ptr = (char *) cache;
5839 cache[1] = *offsetp;
5850 Returns a boolean indicating whether the strings in the two SVs are
5851 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5852 coerce its args to strings if necessary.
5858 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5866 SV* svrecode = Nullsv;
5873 pv1 = SvPV(sv1, cur1);
5880 pv2 = SvPV(sv2, cur2);
5882 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5883 /* Differing utf8ness.
5884 * Do not UTF8size the comparands as a side-effect. */
5887 svrecode = newSVpvn(pv2, cur2);
5888 sv_recode_to_utf8(svrecode, PL_encoding);
5889 pv2 = SvPV(svrecode, cur2);
5892 svrecode = newSVpvn(pv1, cur1);
5893 sv_recode_to_utf8(svrecode, PL_encoding);
5894 pv1 = SvPV(svrecode, cur1);
5896 /* Now both are in UTF-8. */
5901 bool is_utf8 = TRUE;
5904 /* sv1 is the UTF-8 one,
5905 * if is equal it must be downgrade-able */
5906 char *pv = (char*)bytes_from_utf8((U8*)pv1,
5912 /* sv2 is the UTF-8 one,
5913 * if is equal it must be downgrade-able */
5914 char *pv = (char *)bytes_from_utf8((U8*)pv2,
5920 /* Downgrade not possible - cannot be eq */
5927 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5930 SvREFCNT_dec(svrecode);
5941 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5942 string in C<sv1> is less than, equal to, or greater than the string in
5943 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5944 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5950 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5953 char *pv1, *pv2, *tpv = Nullch;
5955 SV *svrecode = Nullsv;
5962 pv1 = SvPV(sv1, cur1);
5969 pv2 = SvPV(sv2, cur2);
5971 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5972 /* Differing utf8ness.
5973 * Do not UTF8size the comparands as a side-effect. */
5976 svrecode = newSVpvn(pv2, cur2);
5977 sv_recode_to_utf8(svrecode, PL_encoding);
5978 pv2 = SvPV(svrecode, cur2);
5981 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
5986 svrecode = newSVpvn(pv1, cur1);
5987 sv_recode_to_utf8(svrecode, PL_encoding);
5988 pv1 = SvPV(svrecode, cur1);
5991 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
5997 cmp = cur2 ? -1 : 0;
6001 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6004 cmp = retval < 0 ? -1 : 1;
6005 } else if (cur1 == cur2) {
6008 cmp = cur1 < cur2 ? -1 : 1;
6013 SvREFCNT_dec(svrecode);
6022 =for apidoc sv_cmp_locale
6024 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6025 'use bytes' aware, handles get magic, and will coerce its args to strings
6026 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6032 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6034 #ifdef USE_LOCALE_COLLATE
6040 if (PL_collation_standard)
6044 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6046 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6048 if (!pv1 || !len1) {
6059 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6062 return retval < 0 ? -1 : 1;
6065 * When the result of collation is equality, that doesn't mean
6066 * that there are no differences -- some locales exclude some
6067 * characters from consideration. So to avoid false equalities,
6068 * we use the raw string as a tiebreaker.
6074 #endif /* USE_LOCALE_COLLATE */
6076 return sv_cmp(sv1, sv2);
6080 #ifdef USE_LOCALE_COLLATE
6083 =for apidoc sv_collxfrm
6085 Add Collate Transform magic to an SV if it doesn't already have it.
6087 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6088 scalar data of the variable, but transformed to such a format that a normal
6089 memory comparison can be used to compare the data according to the locale
6096 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6100 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6101 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6106 Safefree(mg->mg_ptr);
6108 if ((xf = mem_collxfrm(s, len, &xlen))) {
6109 if (SvREADONLY(sv)) {
6112 return xf + sizeof(PL_collation_ix);
6115 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6116 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6129 if (mg && mg->mg_ptr) {
6131 return mg->mg_ptr + sizeof(PL_collation_ix);
6139 #endif /* USE_LOCALE_COLLATE */
6144 Get a line from the filehandle and store it into the SV, optionally
6145 appending to the currently-stored string.
6151 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6155 register STDCHAR rslast;
6156 register STDCHAR *bp;
6162 SV_CHECK_THINKFIRST_COW_DROP(sv);
6163 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6165 However, perlbench says it's slower, because the existing swipe code
6166 is faster than copy on write.
6167 Swings and roundabouts. */
6168 (void)SvUPGRADE(sv, SVt_PV);
6171 SvPOK_only(sv); /* Validate pointer */
6173 if (PL_curcop == &PL_compiling) {
6174 /* we always read code in line mode */
6178 else if (RsSNARF(PL_rs)) {
6179 /* If it is a regular disk file use size from stat() as estimate
6180 of amount we are going to read - may result in malloc-ing
6181 more memory than we realy need if layers bellow reduce
6182 size we read (e.g. CRLF or a gzip layer)
6185 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6186 Off_t offset = PerlIO_tell(fp);
6187 if (offset != (Off_t) -1) {
6188 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6194 else if (RsRECORD(PL_rs)) {
6198 /* Grab the size of the record we're getting */
6199 recsize = SvIV(SvRV(PL_rs));
6200 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6203 /* VMS wants read instead of fread, because fread doesn't respect */
6204 /* RMS record boundaries. This is not necessarily a good thing to be */
6205 /* doing, but we've got no other real choice - except avoid stdio
6206 as implementation - perhaps write a :vms layer ?
6208 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6210 bytesread = PerlIO_read(fp, buffer, recsize);
6212 SvCUR_set(sv, bytesread += append);
6213 buffer[bytesread] = '\0';
6214 goto check_utf8_and_return;
6216 else if (RsPARA(PL_rs)) {
6222 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6223 if (PerlIO_isutf8(fp)) {
6224 rsptr = SvPVutf8(PL_rs, rslen);
6227 if (SvUTF8(PL_rs)) {
6228 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6229 Perl_croak(aTHX_ "Wide character in $/");
6232 rsptr = SvPV(PL_rs, rslen);
6236 rslast = rslen ? rsptr[rslen - 1] : '\0';
6238 if (rspara) { /* have to do this both before and after */
6239 do { /* to make sure file boundaries work right */
6242 i = PerlIO_getc(fp);
6246 PerlIO_ungetc(fp,i);
6252 /* See if we know enough about I/O mechanism to cheat it ! */
6254 /* This used to be #ifdef test - it is made run-time test for ease
6255 of abstracting out stdio interface. One call should be cheap
6256 enough here - and may even be a macro allowing compile
6260 if (PerlIO_fast_gets(fp)) {
6263 * We're going to steal some values from the stdio struct
6264 * and put EVERYTHING in the innermost loop into registers.
6266 register STDCHAR *ptr;
6270 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6271 /* An ungetc()d char is handled separately from the regular
6272 * buffer, so we getc() it back out and stuff it in the buffer.
6274 i = PerlIO_getc(fp);
6275 if (i == EOF) return 0;
6276 *(--((*fp)->_ptr)) = (unsigned char) i;
6280 /* Here is some breathtakingly efficient cheating */
6282 cnt = PerlIO_get_cnt(fp); /* get count into register */
6283 /* make sure we have the room */
6284 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6285 /* Not room for all of it
6286 if we are looking for a separator and room for some
6288 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6289 /* just process what we have room for */
6290 shortbuffered = cnt - SvLEN(sv) + append + 1;
6291 cnt -= shortbuffered;
6295 /* remember that cnt can be negative */
6296 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6301 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
6302 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6303 DEBUG_P(PerlIO_printf(Perl_debug_log,
6304 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6305 DEBUG_P(PerlIO_printf(Perl_debug_log,
6306 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6307 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6308 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6313 while (cnt > 0) { /* this | eat */
6315 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6316 goto thats_all_folks; /* screams | sed :-) */
6320 Copy(ptr, bp, cnt, char); /* this | eat */
6321 bp += cnt; /* screams | dust */
6322 ptr += cnt; /* louder | sed :-) */
6327 if (shortbuffered) { /* oh well, must extend */
6328 cnt = shortbuffered;
6330 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6332 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6333 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6337 DEBUG_P(PerlIO_printf(Perl_debug_log,
6338 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6339 PTR2UV(ptr),(long)cnt));
6340 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6342 DEBUG_P(PerlIO_printf(Perl_debug_log,
6343 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6344 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6345 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6347 /* This used to call 'filbuf' in stdio form, but as that behaves like
6348 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6349 another abstraction. */
6350 i = PerlIO_getc(fp); /* get more characters */
6352 DEBUG_P(PerlIO_printf(Perl_debug_log,
6353 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6354 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6355 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6357 cnt = PerlIO_get_cnt(fp);
6358 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6359 DEBUG_P(PerlIO_printf(Perl_debug_log,
6360 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6362 if (i == EOF) /* all done for ever? */
6363 goto thats_really_all_folks;
6365 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6367 SvGROW(sv, bpx + cnt + 2);
6368 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6370 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6372 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6373 goto thats_all_folks;
6377 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
6378 memNE((char*)bp - rslen, rsptr, rslen))
6379 goto screamer; /* go back to the fray */
6380 thats_really_all_folks:
6382 cnt += shortbuffered;
6383 DEBUG_P(PerlIO_printf(Perl_debug_log,
6384 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6385 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6386 DEBUG_P(PerlIO_printf(Perl_debug_log,
6387 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6388 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6389 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6391 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
6392 DEBUG_P(PerlIO_printf(Perl_debug_log,
6393 "Screamer: done, len=%ld, string=|%.*s|\n",
6394 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
6399 /*The big, slow, and stupid way */
6402 /* Need to work around EPOC SDK features */
6403 /* On WINS: MS VC5 generates calls to _chkstk, */
6404 /* if a `large' stack frame is allocated */
6405 /* gcc on MARM does not generate calls like these */
6411 register STDCHAR *bpe = buf + sizeof(buf);
6413 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6414 ; /* keep reading */
6418 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6419 /* Accomodate broken VAXC compiler, which applies U8 cast to
6420 * both args of ?: operator, causing EOF to change into 255
6423 i = (U8)buf[cnt - 1];
6429 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6431 sv_catpvn(sv, (char *) buf, cnt);
6433 sv_setpvn(sv, (char *) buf, cnt);
6435 if (i != EOF && /* joy */
6437 SvCUR(sv) < rslen ||
6438 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6442 * If we're reading from a TTY and we get a short read,
6443 * indicating that the user hit his EOF character, we need
6444 * to notice it now, because if we try to read from the TTY
6445 * again, the EOF condition will disappear.
6447 * The comparison of cnt to sizeof(buf) is an optimization
6448 * that prevents unnecessary calls to feof().
6452 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6457 if (rspara) { /* have to do this both before and after */
6458 while (i != EOF) { /* to make sure file boundaries work right */
6459 i = PerlIO_getc(fp);
6461 PerlIO_ungetc(fp,i);
6467 check_utf8_and_return:
6468 if (PerlIO_isutf8(fp))
6473 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6479 Auto-increment of the value in the SV, doing string to numeric conversion
6480 if necessary. Handles 'get' magic.
6486 Perl_sv_inc(pTHX_ register SV *sv)
6495 if (SvTHINKFIRST(sv)) {
6497 sv_force_normal_flags(sv, 0);
6498 if (SvREADONLY(sv)) {
6499 if (PL_curcop != &PL_compiling)
6500 Perl_croak(aTHX_ PL_no_modify);
6504 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6506 i = PTR2IV(SvRV(sv));
6511 flags = SvFLAGS(sv);
6512 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6513 /* It's (privately or publicly) a float, but not tested as an
6514 integer, so test it to see. */
6516 flags = SvFLAGS(sv);
6518 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6519 /* It's publicly an integer, or privately an integer-not-float */
6520 #ifdef PERL_PRESERVE_IVUV
6524 if (SvUVX(sv) == UV_MAX)
6525 sv_setnv(sv, UV_MAX_P1);
6527 (void)SvIOK_only_UV(sv);
6530 if (SvIVX(sv) == IV_MAX)
6531 sv_setuv(sv, (UV)IV_MAX + 1);
6533 (void)SvIOK_only(sv);
6539 if (flags & SVp_NOK) {
6540 (void)SvNOK_only(sv);
6545 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
6546 if ((flags & SVTYPEMASK) < SVt_PVIV)
6547 sv_upgrade(sv, SVt_IV);
6548 (void)SvIOK_only(sv);
6553 while (isALPHA(*d)) d++;
6554 while (isDIGIT(*d)) d++;
6556 #ifdef PERL_PRESERVE_IVUV
6557 /* Got to punt this as an integer if needs be, but we don't issue
6558 warnings. Probably ought to make the sv_iv_please() that does
6559 the conversion if possible, and silently. */
6560 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6561 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6562 /* Need to try really hard to see if it's an integer.
6563 9.22337203685478e+18 is an integer.
6564 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6565 so $a="9.22337203685478e+18"; $a+0; $a++
6566 needs to be the same as $a="9.22337203685478e+18"; $a++
6573 /* sv_2iv *should* have made this an NV */
6574 if (flags & SVp_NOK) {
6575 (void)SvNOK_only(sv);
6579 /* I don't think we can get here. Maybe I should assert this
6580 And if we do get here I suspect that sv_setnv will croak. NWC
6582 #if defined(USE_LONG_DOUBLE)
6583 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",
6584 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6586 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6587 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6590 #endif /* PERL_PRESERVE_IVUV */
6591 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
6595 while (d >= SvPVX(sv)) {
6603 /* MKS: The original code here died if letters weren't consecutive.
6604 * at least it didn't have to worry about non-C locales. The
6605 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6606 * arranged in order (although not consecutively) and that only
6607 * [A-Za-z] are accepted by isALPHA in the C locale.
6609 if (*d != 'z' && *d != 'Z') {
6610 do { ++*d; } while (!isALPHA(*d));
6613 *(d--) -= 'z' - 'a';
6618 *(d--) -= 'z' - 'a' + 1;
6622 /* oh,oh, the number grew */
6623 SvGROW(sv, SvCUR(sv) + 2);
6625 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6636 Auto-decrement of the value in the SV, doing string to numeric conversion
6637 if necessary. Handles 'get' magic.
6643 Perl_sv_dec(pTHX_ register SV *sv)
6651 if (SvTHINKFIRST(sv)) {
6653 sv_force_normal_flags(sv, 0);
6654 if (SvREADONLY(sv)) {
6655 if (PL_curcop != &PL_compiling)
6656 Perl_croak(aTHX_ PL_no_modify);
6660 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6662 i = PTR2IV(SvRV(sv));
6667 /* Unlike sv_inc we don't have to worry about string-never-numbers
6668 and keeping them magic. But we mustn't warn on punting */
6669 flags = SvFLAGS(sv);
6670 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6671 /* It's publicly an integer, or privately an integer-not-float */
6672 #ifdef PERL_PRESERVE_IVUV
6676 if (SvUVX(sv) == 0) {
6677 (void)SvIOK_only(sv);
6681 (void)SvIOK_only_UV(sv);
6685 if (SvIVX(sv) == IV_MIN)
6686 sv_setnv(sv, (NV)IV_MIN - 1.0);
6688 (void)SvIOK_only(sv);
6694 if (flags & SVp_NOK) {
6696 (void)SvNOK_only(sv);
6699 if (!(flags & SVp_POK)) {
6700 if ((flags & SVTYPEMASK) < SVt_PVNV)
6701 sv_upgrade(sv, SVt_NV);
6703 (void)SvNOK_only(sv);
6706 #ifdef PERL_PRESERVE_IVUV
6708 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6709 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6710 /* Need to try really hard to see if it's an integer.
6711 9.22337203685478e+18 is an integer.
6712 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6713 so $a="9.22337203685478e+18"; $a+0; $a--
6714 needs to be the same as $a="9.22337203685478e+18"; $a--
6721 /* sv_2iv *should* have made this an NV */
6722 if (flags & SVp_NOK) {
6723 (void)SvNOK_only(sv);
6727 /* I don't think we can get here. Maybe I should assert this
6728 And if we do get here I suspect that sv_setnv will croak. NWC
6730 #if defined(USE_LONG_DOUBLE)
6731 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",
6732 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6734 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6735 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6739 #endif /* PERL_PRESERVE_IVUV */
6740 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6744 =for apidoc sv_mortalcopy
6746 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6747 The new SV is marked as mortal. It will be destroyed "soon", either by an
6748 explicit call to FREETMPS, or by an implicit call at places such as
6749 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6754 /* Make a string that will exist for the duration of the expression
6755 * evaluation. Actually, it may have to last longer than that, but
6756 * hopefully we won't free it until it has been assigned to a
6757 * permanent location. */
6760 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6765 sv_setsv(sv,oldstr);
6767 PL_tmps_stack[++PL_tmps_ix] = sv;
6773 =for apidoc sv_newmortal
6775 Creates a new null SV which is mortal. The reference count of the SV is
6776 set to 1. It will be destroyed "soon", either by an explicit call to
6777 FREETMPS, or by an implicit call at places such as statement boundaries.
6778 See also C<sv_mortalcopy> and C<sv_2mortal>.
6784 Perl_sv_newmortal(pTHX)
6789 SvFLAGS(sv) = SVs_TEMP;
6791 PL_tmps_stack[++PL_tmps_ix] = sv;
6796 =for apidoc sv_2mortal
6798 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6799 by an explicit call to FREETMPS, or by an implicit call at places such as
6800 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
6806 Perl_sv_2mortal(pTHX_ register SV *sv)
6810 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6813 PL_tmps_stack[++PL_tmps_ix] = sv;
6821 Creates a new SV and copies a string into it. The reference count for the
6822 SV is set to 1. If C<len> is zero, Perl will compute the length using
6823 strlen(). For efficiency, consider using C<newSVpvn> instead.
6829 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6836 sv_setpvn(sv,s,len);
6841 =for apidoc newSVpvn
6843 Creates a new SV and copies a string into it. The reference count for the
6844 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6845 string. You are responsible for ensuring that the source string is at least
6852 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6857 sv_setpvn(sv,s,len);
6862 =for apidoc newSVpvn_share
6864 Creates a new SV with its SvPVX pointing to a shared string in the string
6865 table. If the string does not already exist in the table, it is created
6866 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6867 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6868 otherwise the hash is computed. The idea here is that as the string table
6869 is used for shared hash keys these strings will have SvPVX == HeKEY and
6870 hash lookup will avoid string compare.
6876 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6879 bool is_utf8 = FALSE;
6881 STRLEN tmplen = -len;
6883 /* See the note in hv.c:hv_fetch() --jhi */
6884 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
6888 PERL_HASH(hash, src, len);
6890 sv_upgrade(sv, SVt_PVIV);
6891 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
6904 #if defined(PERL_IMPLICIT_CONTEXT)
6906 /* pTHX_ magic can't cope with varargs, so this is a no-context
6907 * version of the main function, (which may itself be aliased to us).
6908 * Don't access this version directly.
6912 Perl_newSVpvf_nocontext(const char* pat, ...)
6917 va_start(args, pat);
6918 sv = vnewSVpvf(pat, &args);
6925 =for apidoc newSVpvf
6927 Creates a new SV and initializes it with the string formatted like
6934 Perl_newSVpvf(pTHX_ const char* pat, ...)
6938 va_start(args, pat);
6939 sv = vnewSVpvf(pat, &args);
6944 /* backend for newSVpvf() and newSVpvf_nocontext() */
6947 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6951 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6958 Creates a new SV and copies a floating point value into it.
6959 The reference count for the SV is set to 1.
6965 Perl_newSVnv(pTHX_ NV n)
6977 Creates a new SV and copies an integer into it. The reference count for the
6984 Perl_newSViv(pTHX_ IV i)
6996 Creates a new SV and copies an unsigned integer into it.
6997 The reference count for the SV is set to 1.
7003 Perl_newSVuv(pTHX_ UV u)
7013 =for apidoc newRV_noinc
7015 Creates an RV wrapper for an SV. The reference count for the original
7016 SV is B<not> incremented.
7022 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7027 sv_upgrade(sv, SVt_RV);
7034 /* newRV_inc is the official function name to use now.
7035 * newRV_inc is in fact #defined to newRV in sv.h
7039 Perl_newRV(pTHX_ SV *tmpRef)
7041 return newRV_noinc(SvREFCNT_inc(tmpRef));
7047 Creates a new SV which is an exact duplicate of the original SV.
7054 Perl_newSVsv(pTHX_ register SV *old)
7060 if (SvTYPE(old) == SVTYPEMASK) {
7061 if (ckWARN_d(WARN_INTERNAL))
7062 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7077 =for apidoc sv_reset
7079 Underlying implementation for the C<reset> Perl function.
7080 Note that the perl-level function is vaguely deprecated.
7086 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7094 char todo[PERL_UCHAR_MAX+1];
7099 if (!*s) { /* reset ?? searches */
7100 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7101 pm->op_pmdynflags &= ~PMdf_USED;
7106 /* reset variables */
7108 if (!HvARRAY(stash))
7111 Zero(todo, 256, char);
7113 i = (unsigned char)*s;
7117 max = (unsigned char)*s++;
7118 for ( ; i <= max; i++) {
7121 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7122 for (entry = HvARRAY(stash)[i];
7124 entry = HeNEXT(entry))
7126 if (!todo[(U8)*HeKEY(entry)])
7128 gv = (GV*)HeVAL(entry);
7130 if (SvTHINKFIRST(sv)) {
7131 if (!SvREADONLY(sv) && SvROK(sv))
7136 if (SvTYPE(sv) >= SVt_PV) {
7138 if (SvPVX(sv) != Nullch)
7145 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7147 #ifdef USE_ENVIRON_ARRAY
7149 # ifdef USE_ITHREADS
7150 && PL_curinterp == aTHX
7154 environ[0] = Nullch;
7166 Using various gambits, try to get an IO from an SV: the IO slot if its a
7167 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7168 named after the PV if we're a string.
7174 Perl_sv_2io(pTHX_ SV *sv)
7180 switch (SvTYPE(sv)) {
7188 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7192 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7194 return sv_2io(SvRV(sv));
7195 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7201 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7210 Using various gambits, try to get a CV from an SV; in addition, try if
7211 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7217 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7224 return *gvp = Nullgv, Nullcv;
7225 switch (SvTYPE(sv)) {
7244 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7245 tryAMAGICunDEREF(to_cv);
7248 if (SvTYPE(sv) == SVt_PVCV) {
7257 Perl_croak(aTHX_ "Not a subroutine reference");
7262 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
7268 if (lref && !GvCVu(gv)) {
7271 tmpsv = NEWSV(704,0);
7272 gv_efullname3(tmpsv, gv, Nullch);
7273 /* XXX this is probably not what they think they're getting.
7274 * It has the same effect as "sub name;", i.e. just a forward
7276 newSUB(start_subparse(FALSE, 0),
7277 newSVOP(OP_CONST, 0, tmpsv),
7282 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7292 Returns true if the SV has a true value by Perl's rules.
7293 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7294 instead use an in-line version.
7300 Perl_sv_true(pTHX_ register SV *sv)
7306 if ((tXpv = (XPV*)SvANY(sv)) &&
7307 (tXpv->xpv_cur > 1 ||
7308 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
7315 return SvIVX(sv) != 0;
7318 return SvNVX(sv) != 0.0;
7320 return sv_2bool(sv);
7328 A private implementation of the C<SvIVx> macro for compilers which can't
7329 cope with complex macro expressions. Always use the macro instead.
7335 Perl_sv_iv(pTHX_ register SV *sv)
7339 return (IV)SvUVX(sv);
7348 A private implementation of the C<SvUVx> macro for compilers which can't
7349 cope with complex macro expressions. Always use the macro instead.
7355 Perl_sv_uv(pTHX_ register SV *sv)
7360 return (UV)SvIVX(sv);
7368 A private implementation of the C<SvNVx> macro for compilers which can't
7369 cope with complex macro expressions. Always use the macro instead.
7375 Perl_sv_nv(pTHX_ register SV *sv)
7385 Use the C<SvPV_nolen> macro instead
7389 A private implementation of the C<SvPV> macro for compilers which can't
7390 cope with complex macro expressions. Always use the macro instead.
7396 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7402 return sv_2pv(sv, lp);
7407 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7413 return sv_2pv_flags(sv, lp, 0);
7417 =for apidoc sv_pvn_force
7419 Get a sensible string out of the SV somehow.
7420 A private implementation of the C<SvPV_force> macro for compilers which
7421 can't cope with complex macro expressions. Always use the macro instead.
7423 =for apidoc sv_pvn_force_flags
7425 Get a sensible string out of the SV somehow.
7426 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7427 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7428 implemented in terms of this function.
7429 You normally want to use the various wrapper macros instead: see
7430 C<SvPV_force> and C<SvPV_force_nomg>
7436 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7440 if (SvTHINKFIRST(sv) && !SvROK(sv))
7441 sv_force_normal_flags(sv, 0);
7447 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7448 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7452 s = sv_2pv_flags(sv, lp, flags);
7453 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
7458 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7459 SvGROW(sv, len + 1);
7460 Move(s,SvPVX(sv),len,char);
7465 SvPOK_on(sv); /* validate pointer */
7467 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7468 PTR2UV(sv),SvPVX(sv)));
7475 =for apidoc sv_pvbyte
7477 Use C<SvPVbyte_nolen> instead.
7479 =for apidoc sv_pvbyten
7481 A private implementation of the C<SvPVbyte> macro for compilers
7482 which can't cope with complex macro expressions. Always use the macro
7489 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7491 sv_utf8_downgrade(sv,0);
7492 return sv_pvn(sv,lp);
7496 =for apidoc sv_pvbyten_force
7498 A private implementation of the C<SvPVbytex_force> macro for compilers
7499 which can't cope with complex macro expressions. Always use the macro
7506 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7508 sv_utf8_downgrade(sv,0);
7509 return sv_pvn_force(sv,lp);
7513 =for apidoc sv_pvutf8
7515 Use the C<SvPVutf8_nolen> macro instead
7517 =for apidoc sv_pvutf8n
7519 A private implementation of the C<SvPVutf8> macro for compilers
7520 which can't cope with complex macro expressions. Always use the macro
7527 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7529 sv_utf8_upgrade(sv);
7530 return sv_pvn(sv,lp);
7534 =for apidoc sv_pvutf8n_force
7536 A private implementation of the C<SvPVutf8_force> macro for compilers
7537 which can't cope with complex macro expressions. Always use the macro
7544 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7546 sv_utf8_upgrade(sv);
7547 return sv_pvn_force(sv,lp);
7551 =for apidoc sv_reftype
7553 Returns a string describing what the SV is a reference to.
7559 Perl_sv_reftype(pTHX_ SV *sv, int ob)
7561 if (ob && SvOBJECT(sv)) {
7562 return HvNAME(SvSTASH(sv));
7565 switch (SvTYPE(sv)) {
7581 case SVt_PVLV: return "LVALUE";
7582 case SVt_PVAV: return "ARRAY";
7583 case SVt_PVHV: return "HASH";
7584 case SVt_PVCV: return "CODE";
7585 case SVt_PVGV: return "GLOB";
7586 case SVt_PVFM: return "FORMAT";
7587 case SVt_PVIO: return "IO";
7588 default: return "UNKNOWN";
7594 =for apidoc sv_isobject
7596 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7597 object. If the SV is not an RV, or if the object is not blessed, then this
7604 Perl_sv_isobject(pTHX_ SV *sv)
7621 Returns a boolean indicating whether the SV is blessed into the specified
7622 class. This does not check for subtypes; use C<sv_derived_from> to verify
7623 an inheritance relationship.
7629 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7641 return strEQ(HvNAME(SvSTASH(sv)), name);
7647 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7648 it will be upgraded to one. If C<classname> is non-null then the new SV will
7649 be blessed in the specified package. The new SV is returned and its
7650 reference count is 1.
7656 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7662 SV_CHECK_THINKFIRST_COW_DROP(rv);
7665 if (SvTYPE(rv) >= SVt_PVMG) {
7666 U32 refcnt = SvREFCNT(rv);
7670 SvREFCNT(rv) = refcnt;
7673 if (SvTYPE(rv) < SVt_RV)
7674 sv_upgrade(rv, SVt_RV);
7675 else if (SvTYPE(rv) > SVt_RV) {
7676 (void)SvOOK_off(rv);
7677 if (SvPVX(rv) && SvLEN(rv))
7678 Safefree(SvPVX(rv));
7688 HV* stash = gv_stashpv(classname, TRUE);
7689 (void)sv_bless(rv, stash);
7695 =for apidoc sv_setref_pv
7697 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7698 argument will be upgraded to an RV. That RV will be modified to point to
7699 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7700 into the SV. The C<classname> argument indicates the package for the
7701 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7702 will be returned and will have a reference count of 1.
7704 Do not use with other Perl types such as HV, AV, SV, CV, because those
7705 objects will become corrupted by the pointer copy process.
7707 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7713 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7716 sv_setsv(rv, &PL_sv_undef);
7720 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7725 =for apidoc sv_setref_iv
7727 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7728 argument will be upgraded to an RV. That RV will be modified to point to
7729 the new SV. The C<classname> argument indicates the package for the
7730 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7731 will be returned and will have a reference count of 1.
7737 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7739 sv_setiv(newSVrv(rv,classname), iv);
7744 =for apidoc sv_setref_uv
7746 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7747 argument will be upgraded to an RV. That RV will be modified to point to
7748 the new SV. The C<classname> argument indicates the package for the
7749 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7750 will be returned and will have a reference count of 1.
7756 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7758 sv_setuv(newSVrv(rv,classname), uv);
7763 =for apidoc sv_setref_nv
7765 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7766 argument will be upgraded to an RV. That RV will be modified to point to
7767 the new SV. The C<classname> argument indicates the package for the
7768 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7769 will be returned and will have a reference count of 1.
7775 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7777 sv_setnv(newSVrv(rv,classname), nv);
7782 =for apidoc sv_setref_pvn
7784 Copies a string into a new SV, optionally blessing the SV. The length of the
7785 string must be specified with C<n>. The C<rv> argument will be upgraded to
7786 an RV. That RV will be modified to point to the new SV. The C<classname>
7787 argument indicates the package for the blessing. Set C<classname> to
7788 C<Nullch> to avoid the blessing. The new SV will be returned and will have
7789 a reference count of 1.
7791 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7797 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
7799 sv_setpvn(newSVrv(rv,classname), pv, n);
7804 =for apidoc sv_bless
7806 Blesses an SV into a specified package. The SV must be an RV. The package
7807 must be designated by its stash (see C<gv_stashpv()>). The reference count
7808 of the SV is unaffected.
7814 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7818 Perl_croak(aTHX_ "Can't bless non-reference value");
7820 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7821 if (SvREADONLY(tmpRef))
7822 Perl_croak(aTHX_ PL_no_modify);
7823 if (SvOBJECT(tmpRef)) {
7824 if (SvTYPE(tmpRef) != SVt_PVIO)
7826 SvREFCNT_dec(SvSTASH(tmpRef));
7829 SvOBJECT_on(tmpRef);
7830 if (SvTYPE(tmpRef) != SVt_PVIO)
7832 (void)SvUPGRADE(tmpRef, SVt_PVMG);
7833 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
7840 if(SvSMAGICAL(tmpRef))
7841 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7849 /* Downgrades a PVGV to a PVMG.
7853 S_sv_unglob(pTHX_ SV *sv)
7857 assert(SvTYPE(sv) == SVt_PVGV);
7862 SvREFCNT_dec(GvSTASH(sv));
7863 GvSTASH(sv) = Nullhv;
7865 sv_unmagic(sv, PERL_MAGIC_glob);
7866 Safefree(GvNAME(sv));
7869 /* need to keep SvANY(sv) in the right arena */
7870 xpvmg = new_XPVMG();
7871 StructCopy(SvANY(sv), xpvmg, XPVMG);
7872 del_XPVGV(SvANY(sv));
7875 SvFLAGS(sv) &= ~SVTYPEMASK;
7876 SvFLAGS(sv) |= SVt_PVMG;
7880 =for apidoc sv_unref_flags
7882 Unsets the RV status of the SV, and decrements the reference count of
7883 whatever was being referenced by the RV. This can almost be thought of
7884 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7885 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7886 (otherwise the decrementing is conditional on the reference count being
7887 different from one or the reference being a readonly SV).
7894 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
7898 if (SvWEAKREF(sv)) {
7906 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
7907 assigned to as BEGIN {$a = \"Foo"} will fail. */
7908 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
7910 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7911 sv_2mortal(rv); /* Schedule for freeing later */
7915 =for apidoc sv_unref
7917 Unsets the RV status of the SV, and decrements the reference count of
7918 whatever was being referenced by the RV. This can almost be thought of
7919 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
7920 being zero. See C<SvROK_off>.
7926 Perl_sv_unref(pTHX_ SV *sv)
7928 sv_unref_flags(sv, 0);
7932 =for apidoc sv_taint
7934 Taint an SV. Use C<SvTAINTED_on> instead.
7939 Perl_sv_taint(pTHX_ SV *sv)
7941 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
7945 =for apidoc sv_untaint
7947 Untaint an SV. Use C<SvTAINTED_off> instead.
7952 Perl_sv_untaint(pTHX_ SV *sv)
7954 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7955 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7962 =for apidoc sv_tainted
7964 Test an SV for taintedness. Use C<SvTAINTED> instead.
7969 Perl_sv_tainted(pTHX_ SV *sv)
7971 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7972 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7973 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
7979 #if defined(PERL_IMPLICIT_CONTEXT)
7981 /* pTHX_ magic can't cope with varargs, so this is a no-context
7982 * version of the main function, (which may itself be aliased to us).
7983 * Don't access this version directly.
7987 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7991 va_start(args, pat);
7992 sv_vsetpvf(sv, pat, &args);
7996 /* pTHX_ magic can't cope with varargs, so this is a no-context
7997 * version of the main function, (which may itself be aliased to us).
7998 * Don't access this version directly.
8002 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8006 va_start(args, pat);
8007 sv_vsetpvf_mg(sv, pat, &args);
8013 =for apidoc sv_setpvf
8015 Processes its arguments like C<sprintf> and sets an SV to the formatted
8016 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8022 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8025 va_start(args, pat);
8026 sv_vsetpvf(sv, pat, &args);
8030 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8033 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8035 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8039 =for apidoc sv_setpvf_mg
8041 Like C<sv_setpvf>, but also handles 'set' magic.
8047 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8050 va_start(args, pat);
8051 sv_vsetpvf_mg(sv, pat, &args);
8055 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8058 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8060 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8064 #if defined(PERL_IMPLICIT_CONTEXT)
8066 /* pTHX_ magic can't cope with varargs, so this is a no-context
8067 * version of the main function, (which may itself be aliased to us).
8068 * Don't access this version directly.
8072 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8076 va_start(args, pat);
8077 sv_vcatpvf(sv, pat, &args);
8081 /* pTHX_ magic can't cope with varargs, so this is a no-context
8082 * version of the main function, (which may itself be aliased to us).
8083 * Don't access this version directly.
8087 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8091 va_start(args, pat);
8092 sv_vcatpvf_mg(sv, pat, &args);
8098 =for apidoc sv_catpvf
8100 Processes its arguments like C<sprintf> and appends the formatted
8101 output to an SV. If the appended data contains "wide" characters
8102 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8103 and characters >255 formatted with %c), the original SV might get
8104 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8105 C<SvSETMAGIC()> must typically be called after calling this function
8106 to handle 'set' magic.
8111 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8114 va_start(args, pat);
8115 sv_vcatpvf(sv, pat, &args);
8119 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8122 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8124 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8128 =for apidoc sv_catpvf_mg
8130 Like C<sv_catpvf>, but also handles 'set' magic.
8136 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8139 va_start(args, pat);
8140 sv_vcatpvf_mg(sv, pat, &args);
8144 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
8147 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8149 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8154 =for apidoc sv_vsetpvfn
8156 Works like C<vcatpvfn> but copies the text into the SV instead of
8159 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
8165 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8167 sv_setpvn(sv, "", 0);
8168 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8171 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8174 S_expect_number(pTHX_ char** pattern)
8177 switch (**pattern) {
8178 case '1': case '2': case '3':
8179 case '4': case '5': case '6':
8180 case '7': case '8': case '9':
8181 while (isDIGIT(**pattern))
8182 var = var * 10 + (*(*pattern)++ - '0');
8186 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8189 =for apidoc sv_vcatpvfn
8191 Processes its arguments like C<vsprintf> and appends the formatted output
8192 to an SV. Uses an array of SVs if the C style variable argument list is
8193 missing (NULL). When running with taint checks enabled, indicates via
8194 C<maybe_tainted> if results are untrustworthy (often due to the use of
8197 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
8203 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8210 static char nullstr[] = "(null)";
8212 bool has_utf8 = FALSE; /* has the result utf8? */
8214 /* no matter what, this is a string now */
8215 (void)SvPV_force(sv, origlen);
8217 /* special-case "", "%s", and "%_" */
8220 if (patlen == 2 && pat[0] == '%') {
8224 char *s = va_arg(*args, char*);
8225 sv_catpv(sv, s ? s : nullstr);
8227 else if (svix < svmax) {
8228 sv_catsv(sv, *svargs);
8229 if (DO_UTF8(*svargs))
8235 argsv = va_arg(*args, SV*);
8236 sv_catsv(sv, argsv);
8241 /* See comment on '_' below */
8246 if (!args && svix < svmax && DO_UTF8(*svargs))
8249 patend = (char*)pat + patlen;
8250 for (p = (char*)pat; p < patend; p = q) {
8253 bool vectorize = FALSE;
8254 bool vectorarg = FALSE;
8255 bool vec_utf8 = FALSE;
8261 bool has_precis = FALSE;
8263 bool is_utf8 = FALSE; /* is this item utf8? */
8264 #ifdef HAS_LDBL_SPRINTF_BUG
8265 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8266 with sfio - Allen <allens@cpan.org> */
8267 bool fix_ldbl_sprintf_bug = FALSE;
8271 U8 utf8buf[UTF8_MAXLEN+1];
8272 STRLEN esignlen = 0;
8274 char *eptr = Nullch;
8276 /* Times 4: a decimal digit takes more than 3 binary digits.
8277 * NV_DIG: mantissa takes than many decimal digits.
8278 * Plus 32: Playing safe. */
8279 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8280 /* large enough for "%#.#f" --chip */
8281 /* what about long double NVs? --jhi */
8284 U8 *vecstr = Null(U8*);
8291 /* we need a long double target in case HAS_LONG_DOUBLE but
8294 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8303 STRLEN dotstrlen = 1;
8304 I32 efix = 0; /* explicit format parameter index */
8305 I32 ewix = 0; /* explicit width index */
8306 I32 epix = 0; /* explicit precision index */
8307 I32 evix = 0; /* explicit vector index */
8308 bool asterisk = FALSE;
8310 /* echo everything up to the next format specification */
8311 for (q = p; q < patend && *q != '%'; ++q) ;
8313 sv_catpvn(sv, p, q - p);
8320 We allow format specification elements in this order:
8321 \d+\$ explicit format parameter index
8323 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8324 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8325 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8327 [%bcdefginopsux_DFOUX] format (mandatory)
8329 if (EXPECT_NUMBER(q, width)) {
8370 if (EXPECT_NUMBER(q, ewix))
8379 if ((vectorarg = asterisk)) {
8389 EXPECT_NUMBER(q, width);
8394 vecsv = va_arg(*args, SV*);
8396 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8397 svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
8398 dotstr = SvPVx(vecsv, dotstrlen);
8403 vecsv = va_arg(*args, SV*);
8404 vecstr = (U8*)SvPVx(vecsv,veclen);
8405 vec_utf8 = DO_UTF8(vecsv);
8407 else if (efix ? efix <= svmax : svix < svmax) {
8408 vecsv = svargs[efix ? efix-1 : svix++];
8409 vecstr = (U8*)SvPVx(vecsv,veclen);
8410 vec_utf8 = DO_UTF8(vecsv);
8420 i = va_arg(*args, int);
8422 i = (ewix ? ewix <= svmax : svix < svmax) ?
8423 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8425 width = (i < 0) ? -i : i;
8435 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8437 /* XXX: todo, support specified precision parameter */
8441 i = va_arg(*args, int);
8443 i = (ewix ? ewix <= svmax : svix < svmax)
8444 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8445 precis = (i < 0) ? 0 : i;
8450 precis = precis * 10 + (*q++ - '0');
8459 case 'I': /* Ix, I32x, and I64x */
8461 if (q[1] == '6' && q[2] == '4') {
8467 if (q[1] == '3' && q[2] == '2') {
8477 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8488 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8489 if (*(q + 1) == 'l') { /* lld, llf */
8514 argsv = (efix ? efix <= svmax : svix < svmax) ?
8515 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8522 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8524 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8526 eptr = (char*)utf8buf;
8527 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8538 if (args && !vectorize) {
8539 eptr = va_arg(*args, char*);
8541 #ifdef MACOS_TRADITIONAL
8542 /* On MacOS, %#s format is used for Pascal strings */
8547 elen = strlen(eptr);
8550 elen = sizeof nullstr - 1;
8554 eptr = SvPVx(argsv, elen);
8555 if (DO_UTF8(argsv)) {
8556 if (has_precis && precis < elen) {
8558 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8561 if (width) { /* fudge width (can't fudge elen) */
8562 width += elen - sv_len_utf8(argsv);
8571 * The "%_" hack might have to be changed someday,
8572 * if ISO or ANSI decide to use '_' for something.
8573 * So we keep it hidden from users' code.
8575 if (!args || vectorize)
8577 argsv = va_arg(*args, SV*);
8578 eptr = SvPVx(argsv, elen);
8584 if (has_precis && elen > precis)
8591 if (alt || vectorize)
8593 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8611 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8620 esignbuf[esignlen++] = plus;
8624 case 'h': iv = (short)va_arg(*args, int); break;
8625 default: iv = va_arg(*args, int); break;
8626 case 'l': iv = va_arg(*args, long); break;
8627 case 'V': iv = va_arg(*args, IV); break;
8629 case 'q': iv = va_arg(*args, Quad_t); break;
8636 case 'h': iv = (short)iv; break;
8638 case 'l': iv = (long)iv; break;
8641 case 'q': iv = (Quad_t)iv; break;
8645 if ( !vectorize ) /* we already set uv above */
8650 esignbuf[esignlen++] = plus;
8654 esignbuf[esignlen++] = '-';
8697 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8708 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8709 default: uv = va_arg(*args, unsigned); break;
8710 case 'l': uv = va_arg(*args, unsigned long); break;
8711 case 'V': uv = va_arg(*args, UV); break;
8713 case 'q': uv = va_arg(*args, Quad_t); break;
8720 case 'h': uv = (unsigned short)uv; break;
8722 case 'l': uv = (unsigned long)uv; break;
8725 case 'q': uv = (Quad_t)uv; break;
8731 eptr = ebuf + sizeof ebuf;
8737 p = (char*)((c == 'X')
8738 ? "0123456789ABCDEF" : "0123456789abcdef");
8744 esignbuf[esignlen++] = '0';
8745 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8751 *--eptr = '0' + dig;
8753 if (alt && *eptr != '0')
8759 *--eptr = '0' + dig;
8762 esignbuf[esignlen++] = '0';
8763 esignbuf[esignlen++] = 'b';
8766 default: /* it had better be ten or less */
8767 #if defined(PERL_Y2KWARN)
8768 if (ckWARN(WARN_Y2K)) {
8770 char *s = SvPV(sv,n);
8771 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
8772 && (n == 2 || !isDIGIT(s[n-3])))
8774 Perl_warner(aTHX_ packWARN(WARN_Y2K),
8775 "Possible Y2K bug: %%%c %s",
8776 c, "format string following '19'");
8782 *--eptr = '0' + dig;
8783 } while (uv /= base);
8786 elen = (ebuf + sizeof ebuf) - eptr;
8789 zeros = precis - elen;
8790 else if (precis == 0 && elen == 1 && *eptr == '0')
8795 /* FLOATING POINT */
8798 c = 'f'; /* maybe %F isn't supported here */
8804 /* This is evil, but floating point is even more evil */
8806 /* for SV-style calling, we can only get NV
8807 for C-style calling, we assume %f is double;
8808 for simplicity we allow any of %Lf, %llf, %qf for long double
8812 #if defined(USE_LONG_DOUBLE)
8816 /* [perl #20339] - we should accept and ignore %hf, %lf rather than die */
8820 #if defined(USE_LONG_DOUBLE)
8821 intsize = args ? 0 : 'q';
8825 #if defined(HAS_LONG_DOUBLE)
8834 /* now we need (long double) if intsize == 'q', else (double) */
8835 nv = (args && !vectorize) ?
8836 #if LONG_DOUBLESIZE > DOUBLESIZE
8838 va_arg(*args, long double) :
8839 va_arg(*args, double)
8841 va_arg(*args, double)
8847 if (c != 'e' && c != 'E') {
8849 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8850 will cast our (long double) to (double) */
8851 (void)Perl_frexp(nv, &i);
8852 if (i == PERL_INT_MIN)
8853 Perl_die(aTHX_ "panic: frexp");
8855 need = BIT_DIGITS(i);
8857 need += has_precis ? precis : 6; /* known default */
8862 #ifdef HAS_LDBL_SPRINTF_BUG
8863 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8864 with sfio - Allen <allens@cpan.org> */
8867 # define MY_DBL_MAX DBL_MAX
8868 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8869 # if DOUBLESIZE >= 8
8870 # define MY_DBL_MAX 1.7976931348623157E+308L
8872 # define MY_DBL_MAX 3.40282347E+38L
8876 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8877 # define MY_DBL_MAX_BUG 1L
8879 # define MY_DBL_MAX_BUG MY_DBL_MAX
8883 # define MY_DBL_MIN DBL_MIN
8884 # else /* XXX guessing! -Allen */
8885 # if DOUBLESIZE >= 8
8886 # define MY_DBL_MIN 2.2250738585072014E-308L
8888 # define MY_DBL_MIN 1.17549435E-38L
8892 if ((intsize == 'q') && (c == 'f') &&
8893 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8895 /* it's going to be short enough that
8896 * long double precision is not needed */
8898 if ((nv <= 0L) && (nv >= -0L))
8899 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8901 /* would use Perl_fp_class as a double-check but not
8902 * functional on IRIX - see perl.h comments */
8904 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8905 /* It's within the range that a double can represent */
8906 #if defined(DBL_MAX) && !defined(DBL_MIN)
8907 if ((nv >= ((long double)1/DBL_MAX)) ||
8908 (nv <= (-(long double)1/DBL_MAX)))
8910 fix_ldbl_sprintf_bug = TRUE;
8913 if (fix_ldbl_sprintf_bug == TRUE) {
8923 # undef MY_DBL_MAX_BUG
8926 #endif /* HAS_LDBL_SPRINTF_BUG */
8928 need += 20; /* fudge factor */
8929 if (PL_efloatsize < need) {
8930 Safefree(PL_efloatbuf);
8931 PL_efloatsize = need + 20; /* more fudge */
8932 New(906, PL_efloatbuf, PL_efloatsize, char);
8933 PL_efloatbuf[0] = '\0';
8936 eptr = ebuf + sizeof ebuf;
8939 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8940 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8941 if (intsize == 'q') {
8942 /* Copy the one or more characters in a long double
8943 * format before the 'base' ([efgEFG]) character to
8944 * the format string. */
8945 static char const prifldbl[] = PERL_PRIfldbl;
8946 char const *p = prifldbl + sizeof(prifldbl) - 3;
8947 while (p >= prifldbl) { *--eptr = *p--; }
8952 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8957 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8969 /* No taint. Otherwise we are in the strange situation
8970 * where printf() taints but print($float) doesn't.
8972 #if defined(HAS_LONG_DOUBLE)
8974 (void)sprintf(PL_efloatbuf, eptr, nv);
8976 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
8978 (void)sprintf(PL_efloatbuf, eptr, nv);
8980 eptr = PL_efloatbuf;
8981 elen = strlen(PL_efloatbuf);
8987 i = SvCUR(sv) - origlen;
8988 if (args && !vectorize) {
8990 case 'h': *(va_arg(*args, short*)) = i; break;
8991 default: *(va_arg(*args, int*)) = i; break;
8992 case 'l': *(va_arg(*args, long*)) = i; break;
8993 case 'V': *(va_arg(*args, IV*)) = i; break;
8995 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9000 sv_setuv_mg(argsv, (UV)i);
9002 continue; /* not "break" */
9009 if (!args && ckWARN(WARN_PRINTF) &&
9010 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9011 SV *msg = sv_newmortal();
9012 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9013 (PL_op->op_type == OP_PRTF) ? "" : "s");
9016 Perl_sv_catpvf(aTHX_ msg,
9017 "\"%%%c\"", c & 0xFF);
9019 Perl_sv_catpvf(aTHX_ msg,
9020 "\"%%\\%03"UVof"\"",
9023 sv_catpv(msg, "end of string");
9024 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9027 /* output mangled stuff ... */
9033 /* ... right here, because formatting flags should not apply */
9034 SvGROW(sv, SvCUR(sv) + elen + 1);
9036 Copy(eptr, p, elen, char);
9039 SvCUR(sv) = p - SvPVX(sv);
9040 continue; /* not "break" */
9043 if (is_utf8 != has_utf8) {
9046 sv_utf8_upgrade(sv);
9049 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9050 sv_utf8_upgrade(nsv);
9054 SvGROW(sv, SvCUR(sv) + elen + 1);
9059 have = esignlen + zeros + elen;
9060 need = (have > width ? have : width);
9063 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9065 if (esignlen && fill == '0') {
9066 for (i = 0; i < (int)esignlen; i++)
9070 memset(p, fill, gap);
9073 if (esignlen && fill != '0') {
9074 for (i = 0; i < (int)esignlen; i++)
9078 for (i = zeros; i; i--)
9082 Copy(eptr, p, elen, char);
9086 memset(p, ' ', gap);
9091 Copy(dotstr, p, dotstrlen, char);
9095 vectorize = FALSE; /* done iterating over vecstr */
9102 SvCUR(sv) = p - SvPVX(sv);
9110 /* =========================================================================
9112 =head1 Cloning an interpreter
9114 All the macros and functions in this section are for the private use of
9115 the main function, perl_clone().
9117 The foo_dup() functions make an exact copy of an existing foo thinngy.
9118 During the course of a cloning, a hash table is used to map old addresses
9119 to new addresses. The table is created and manipulated with the
9120 ptr_table_* functions.
9124 ============================================================================*/
9127 #if defined(USE_ITHREADS)
9129 #ifndef GpREFCNT_inc
9130 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9134 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9135 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9136 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9137 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9138 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9139 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9140 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9141 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9142 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9143 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9144 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9145 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9146 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9149 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9150 regcomp.c. AMS 20010712 */
9153 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
9157 struct reg_substr_datum *s;
9160 return (REGEXP *)NULL;
9162 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9165 len = r->offsets[0];
9166 npar = r->nparens+1;
9168 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9169 Copy(r->program, ret->program, len+1, regnode);
9171 New(0, ret->startp, npar, I32);
9172 Copy(r->startp, ret->startp, npar, I32);
9173 New(0, ret->endp, npar, I32);
9174 Copy(r->startp, ret->startp, npar, I32);
9176 New(0, ret->substrs, 1, struct reg_substr_data);
9177 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9178 s->min_offset = r->substrs->data[i].min_offset;
9179 s->max_offset = r->substrs->data[i].max_offset;
9180 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9181 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9184 ret->regstclass = NULL;
9187 int count = r->data->count;
9189 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9190 char, struct reg_data);
9191 New(0, d->what, count, U8);
9194 for (i = 0; i < count; i++) {
9195 d->what[i] = r->data->what[i];
9196 switch (d->what[i]) {
9198 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9201 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9204 /* This is cheating. */
9205 New(0, d->data[i], 1, struct regnode_charclass_class);
9206 StructCopy(r->data->data[i], d->data[i],
9207 struct regnode_charclass_class);
9208 ret->regstclass = (regnode*)d->data[i];
9211 /* Compiled op trees are readonly, and can thus be
9212 shared without duplication. */
9213 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9216 d->data[i] = r->data->data[i];
9226 New(0, ret->offsets, 2*len+1, U32);
9227 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9229 ret->precomp = SAVEPV(r->precomp);
9230 ret->refcnt = r->refcnt;
9231 ret->minlen = r->minlen;
9232 ret->prelen = r->prelen;
9233 ret->nparens = r->nparens;
9234 ret->lastparen = r->lastparen;
9235 ret->lastcloseparen = r->lastcloseparen;
9236 ret->reganch = r->reganch;
9238 ret->sublen = r->sublen;
9240 if (RX_MATCH_COPIED(ret))
9241 ret->subbeg = SAVEPV(r->subbeg);
9243 ret->subbeg = Nullch;
9245 ptr_table_store(PL_ptr_table, r, ret);
9249 /* duplicate a file handle */
9252 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9256 return (PerlIO*)NULL;
9258 /* look for it in the table first */
9259 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9263 /* create anew and remember what it is */
9264 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9265 ptr_table_store(PL_ptr_table, fp, ret);
9269 /* duplicate a directory handle */
9272 Perl_dirp_dup(pTHX_ DIR *dp)
9280 /* duplicate a typeglob */
9283 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9288 /* look for it in the table first */
9289 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9293 /* create anew and remember what it is */
9294 Newz(0, ret, 1, GP);
9295 ptr_table_store(PL_ptr_table, gp, ret);
9298 ret->gp_refcnt = 0; /* must be before any other dups! */
9299 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9300 ret->gp_io = io_dup_inc(gp->gp_io, param);
9301 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9302 ret->gp_av = av_dup_inc(gp->gp_av, param);
9303 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9304 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9305 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9306 ret->gp_cvgen = gp->gp_cvgen;
9307 ret->gp_flags = gp->gp_flags;
9308 ret->gp_line = gp->gp_line;
9309 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9313 /* duplicate a chain of magic */
9316 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9318 MAGIC *mgprev = (MAGIC*)NULL;
9321 return (MAGIC*)NULL;
9322 /* look for it in the table first */
9323 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9327 for (; mg; mg = mg->mg_moremagic) {
9329 Newz(0, nmg, 1, MAGIC);
9331 mgprev->mg_moremagic = nmg;
9334 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9335 nmg->mg_private = mg->mg_private;
9336 nmg->mg_type = mg->mg_type;
9337 nmg->mg_flags = mg->mg_flags;
9338 if (mg->mg_type == PERL_MAGIC_qr) {
9339 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9341 else if(mg->mg_type == PERL_MAGIC_backref) {
9342 AV *av = (AV*) mg->mg_obj;
9345 nmg->mg_obj = (SV*)newAV();
9349 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9354 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9355 ? sv_dup_inc(mg->mg_obj, param)
9356 : sv_dup(mg->mg_obj, param);
9358 nmg->mg_len = mg->mg_len;
9359 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9360 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9361 if (mg->mg_len > 0) {
9362 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9363 if (mg->mg_type == PERL_MAGIC_overload_table &&
9364 AMT_AMAGIC((AMT*)mg->mg_ptr))
9366 AMT *amtp = (AMT*)mg->mg_ptr;
9367 AMT *namtp = (AMT*)nmg->mg_ptr;
9369 for (i = 1; i < NofAMmeth; i++) {
9370 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9374 else if (mg->mg_len == HEf_SVKEY)
9375 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9377 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9378 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9385 /* create a new pointer-mapping table */
9388 Perl_ptr_table_new(pTHX)
9391 Newz(0, tbl, 1, PTR_TBL_t);
9394 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9398 /* map an existing pointer using a table */
9401 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
9403 PTR_TBL_ENT_t *tblent;
9404 UV hash = PTR2UV(sv);
9406 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9407 for (; tblent; tblent = tblent->next) {
9408 if (tblent->oldval == sv)
9409 return tblent->newval;
9414 /* add a new entry to a pointer-mapping table */
9417 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
9419 PTR_TBL_ENT_t *tblent, **otblent;
9420 /* XXX this may be pessimal on platforms where pointers aren't good
9421 * hash values e.g. if they grow faster in the most significant
9423 UV hash = PTR2UV(oldv);
9427 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9428 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
9429 if (tblent->oldval == oldv) {
9430 tblent->newval = newv;
9434 Newz(0, tblent, 1, PTR_TBL_ENT_t);
9435 tblent->oldval = oldv;
9436 tblent->newval = newv;
9437 tblent->next = *otblent;
9440 if (i && tbl->tbl_items > tbl->tbl_max)
9441 ptr_table_split(tbl);
9444 /* double the hash bucket size of an existing ptr table */
9447 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9449 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9450 UV oldsize = tbl->tbl_max + 1;
9451 UV newsize = oldsize * 2;
9454 Renew(ary, newsize, PTR_TBL_ENT_t*);
9455 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9456 tbl->tbl_max = --newsize;
9458 for (i=0; i < oldsize; i++, ary++) {
9459 PTR_TBL_ENT_t **curentp, **entp, *ent;
9462 curentp = ary + oldsize;
9463 for (entp = ary, ent = *ary; ent; ent = *entp) {
9464 if ((newsize & PTR2UV(ent->oldval)) != i) {
9466 ent->next = *curentp;
9476 /* remove all the entries from a ptr table */
9479 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9481 register PTR_TBL_ENT_t **array;
9482 register PTR_TBL_ENT_t *entry;
9483 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
9487 if (!tbl || !tbl->tbl_items) {
9491 array = tbl->tbl_ary;
9498 entry = entry->next;
9502 if (++riter > max) {
9505 entry = array[riter];
9512 /* clear and free a ptr table */
9515 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9520 ptr_table_clear(tbl);
9521 Safefree(tbl->tbl_ary);
9529 /* attempt to make everything in the typeglob readonly */
9532 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
9535 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
9537 if (GvIO(gv) || GvFORM(gv)) {
9538 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
9540 else if (!GvCV(gv)) {
9544 /* CvPADLISTs cannot be shared */
9545 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
9550 if (!GvUNIQUE(gv)) {
9552 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
9553 HvNAME(GvSTASH(gv)), GvNAME(gv));
9559 * write attempts will die with
9560 * "Modification of a read-only value attempted"
9566 SvREADONLY_on(GvSV(gv));
9573 SvREADONLY_on(GvAV(gv));
9580 SvREADONLY_on(GvAV(gv));
9583 return sstr; /* he_dup() will SvREFCNT_inc() */
9586 /* duplicate an SV of any type (including AV, HV etc) */
9589 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9592 SvRV(dstr) = SvWEAKREF(sstr)
9593 ? sv_dup(SvRV(sstr), param)
9594 : sv_dup_inc(SvRV(sstr), param);
9596 else if (SvPVX(sstr)) {
9597 /* Has something there */
9599 /* Normal PV - clone whole allocated space */
9600 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9601 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9602 /* Not that normal - actually sstr is copy on write.
9603 But we are a true, independant SV, so: */
9604 SvREADONLY_off(dstr);
9609 /* Special case - not normally malloced for some reason */
9610 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9611 /* A "shared" PV - clone it as unshared string */
9613 SvREADONLY_off(dstr);
9614 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
9617 /* Some other special case - random pointer */
9618 SvPVX(dstr) = SvPVX(sstr);
9624 SvPVX(dstr) = SvPVX(sstr);
9629 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9633 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9635 /* look for it in the table first */
9636 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9640 if(param->flags & CLONEf_JOIN_IN) {
9641 /** We are joining here so we don't want do clone
9642 something that is bad **/
9644 if(SvTYPE(sstr) == SVt_PVHV &&
9646 /** don't clone stashes if they already exist **/
9647 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
9648 return (SV*) old_stash;
9652 /* create anew and remember what it is */
9654 ptr_table_store(PL_ptr_table, sstr, dstr);
9657 SvFLAGS(dstr) = SvFLAGS(sstr);
9658 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9659 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9662 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
9663 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9664 PL_watch_pvx, SvPVX(sstr));
9667 switch (SvTYPE(sstr)) {
9672 SvANY(dstr) = new_XIV();
9673 SvIVX(dstr) = SvIVX(sstr);
9676 SvANY(dstr) = new_XNV();
9677 SvNVX(dstr) = SvNVX(sstr);
9680 SvANY(dstr) = new_XRV();
9681 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9684 SvANY(dstr) = new_XPV();
9685 SvCUR(dstr) = SvCUR(sstr);
9686 SvLEN(dstr) = SvLEN(sstr);
9687 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9690 SvANY(dstr) = new_XPVIV();
9691 SvCUR(dstr) = SvCUR(sstr);
9692 SvLEN(dstr) = SvLEN(sstr);
9693 SvIVX(dstr) = SvIVX(sstr);
9694 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9697 SvANY(dstr) = new_XPVNV();
9698 SvCUR(dstr) = SvCUR(sstr);
9699 SvLEN(dstr) = SvLEN(sstr);
9700 SvIVX(dstr) = SvIVX(sstr);
9701 SvNVX(dstr) = SvNVX(sstr);
9702 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9705 SvANY(dstr) = new_XPVMG();
9706 SvCUR(dstr) = SvCUR(sstr);
9707 SvLEN(dstr) = SvLEN(sstr);
9708 SvIVX(dstr) = SvIVX(sstr);
9709 SvNVX(dstr) = SvNVX(sstr);
9710 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9711 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9712 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9715 SvANY(dstr) = new_XPVBM();
9716 SvCUR(dstr) = SvCUR(sstr);
9717 SvLEN(dstr) = SvLEN(sstr);
9718 SvIVX(dstr) = SvIVX(sstr);
9719 SvNVX(dstr) = SvNVX(sstr);
9720 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9721 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9722 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9723 BmRARE(dstr) = BmRARE(sstr);
9724 BmUSEFUL(dstr) = BmUSEFUL(sstr);
9725 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
9728 SvANY(dstr) = new_XPVLV();
9729 SvCUR(dstr) = SvCUR(sstr);
9730 SvLEN(dstr) = SvLEN(sstr);
9731 SvIVX(dstr) = SvIVX(sstr);
9732 SvNVX(dstr) = SvNVX(sstr);
9733 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9734 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9735 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9736 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
9737 LvTARGLEN(dstr) = LvTARGLEN(sstr);
9738 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
9739 LvTYPE(dstr) = LvTYPE(sstr);
9742 if (GvUNIQUE((GV*)sstr)) {
9744 if ((share = gv_share(sstr, param))) {
9747 ptr_table_store(PL_ptr_table, sstr, dstr);
9749 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
9750 HvNAME(GvSTASH(share)), GvNAME(share));
9755 SvANY(dstr) = new_XPVGV();
9756 SvCUR(dstr) = SvCUR(sstr);
9757 SvLEN(dstr) = SvLEN(sstr);
9758 SvIVX(dstr) = SvIVX(sstr);
9759 SvNVX(dstr) = SvNVX(sstr);
9760 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9761 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9762 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9763 GvNAMELEN(dstr) = GvNAMELEN(sstr);
9764 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
9765 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
9766 GvFLAGS(dstr) = GvFLAGS(sstr);
9767 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9768 (void)GpREFCNT_inc(GvGP(dstr));
9771 SvANY(dstr) = new_XPVIO();
9772 SvCUR(dstr) = SvCUR(sstr);
9773 SvLEN(dstr) = SvLEN(sstr);
9774 SvIVX(dstr) = SvIVX(sstr);
9775 SvNVX(dstr) = SvNVX(sstr);
9776 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9777 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9778 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9779 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
9780 if (IoOFP(sstr) == IoIFP(sstr))
9781 IoOFP(dstr) = IoIFP(dstr);
9783 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
9784 /* PL_rsfp_filters entries have fake IoDIRP() */
9785 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
9786 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
9788 IoDIRP(dstr) = IoDIRP(sstr);
9789 IoLINES(dstr) = IoLINES(sstr);
9790 IoPAGE(dstr) = IoPAGE(sstr);
9791 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
9792 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
9793 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
9794 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
9795 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
9796 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
9797 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
9798 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
9799 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
9800 IoTYPE(dstr) = IoTYPE(sstr);
9801 IoFLAGS(dstr) = IoFLAGS(sstr);
9804 SvANY(dstr) = new_XPVAV();
9805 SvCUR(dstr) = SvCUR(sstr);
9806 SvLEN(dstr) = SvLEN(sstr);
9807 SvIVX(dstr) = SvIVX(sstr);
9808 SvNVX(dstr) = SvNVX(sstr);
9809 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9810 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9811 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
9812 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
9813 if (AvARRAY((AV*)sstr)) {
9814 SV **dst_ary, **src_ary;
9815 SSize_t items = AvFILLp((AV*)sstr) + 1;
9817 src_ary = AvARRAY((AV*)sstr);
9818 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
9819 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9820 SvPVX(dstr) = (char*)dst_ary;
9821 AvALLOC((AV*)dstr) = dst_ary;
9822 if (AvREAL((AV*)sstr)) {
9824 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9828 *dst_ary++ = sv_dup(*src_ary++, param);
9830 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9831 while (items-- > 0) {
9832 *dst_ary++ = &PL_sv_undef;
9836 SvPVX(dstr) = Nullch;
9837 AvALLOC((AV*)dstr) = (SV**)NULL;
9841 SvANY(dstr) = new_XPVHV();
9842 SvCUR(dstr) = SvCUR(sstr);
9843 SvLEN(dstr) = SvLEN(sstr);
9844 SvIVX(dstr) = SvIVX(sstr);
9845 SvNVX(dstr) = SvNVX(sstr);
9846 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9847 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9848 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
9849 if (HvARRAY((HV*)sstr)) {
9851 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
9852 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
9853 Newz(0, dxhv->xhv_array,
9854 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
9855 while (i <= sxhv->xhv_max) {
9856 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
9857 (bool)!!HvSHAREKEYS(sstr),
9861 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
9862 (bool)!!HvSHAREKEYS(sstr), param);
9865 SvPVX(dstr) = Nullch;
9866 HvEITER((HV*)dstr) = (HE*)NULL;
9868 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
9869 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
9870 /* Record stashes for possible cloning in Perl_clone(). */
9871 if(HvNAME((HV*)dstr))
9872 av_push(param->stashes, dstr);
9875 SvANY(dstr) = new_XPVFM();
9876 FmLINES(dstr) = FmLINES(sstr);
9880 SvANY(dstr) = new_XPVCV();
9882 SvCUR(dstr) = SvCUR(sstr);
9883 SvLEN(dstr) = SvLEN(sstr);
9884 SvIVX(dstr) = SvIVX(sstr);
9885 SvNVX(dstr) = SvNVX(sstr);
9886 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9887 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9888 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9889 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
9890 CvSTART(dstr) = CvSTART(sstr);
9891 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
9892 CvXSUB(dstr) = CvXSUB(sstr);
9893 CvXSUBANY(dstr) = CvXSUBANY(sstr);
9894 if (CvCONST(sstr)) {
9895 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
9896 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
9897 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
9899 CvGV(dstr) = gv_dup(CvGV(sstr), param);
9900 if (param->flags & CLONEf_COPY_STACKS) {
9901 CvDEPTH(dstr) = CvDEPTH(sstr);
9905 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9906 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
9909 ? cv_dup( CvOUTSIDE(sstr), param)
9910 : cv_dup_inc(CvOUTSIDE(sstr), param);
9911 CvFLAGS(dstr) = CvFLAGS(sstr);
9912 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
9915 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9919 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9925 /* duplicate a context */
9928 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9933 return (PERL_CONTEXT*)NULL;
9935 /* look for it in the table first */
9936 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9940 /* create anew and remember what it is */
9941 Newz(56, ncxs, max + 1, PERL_CONTEXT);
9942 ptr_table_store(PL_ptr_table, cxs, ncxs);
9945 PERL_CONTEXT *cx = &cxs[ix];
9946 PERL_CONTEXT *ncx = &ncxs[ix];
9947 ncx->cx_type = cx->cx_type;
9948 if (CxTYPE(cx) == CXt_SUBST) {
9949 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9952 ncx->blk_oldsp = cx->blk_oldsp;
9953 ncx->blk_oldcop = cx->blk_oldcop;
9954 ncx->blk_oldretsp = cx->blk_oldretsp;
9955 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9956 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9957 ncx->blk_oldpm = cx->blk_oldpm;
9958 ncx->blk_gimme = cx->blk_gimme;
9959 switch (CxTYPE(cx)) {
9961 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9962 ? cv_dup_inc(cx->blk_sub.cv, param)
9963 : cv_dup(cx->blk_sub.cv,param));
9964 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9965 ? av_dup_inc(cx->blk_sub.argarray, param)
9967 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9968 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9969 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9970 ncx->blk_sub.lval = cx->blk_sub.lval;
9973 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9974 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9975 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9976 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9977 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9980 ncx->blk_loop.label = cx->blk_loop.label;
9981 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9982 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9983 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9984 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9985 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9986 ? cx->blk_loop.iterdata
9987 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9988 ncx->blk_loop.oldcomppad
9989 = (PAD*)ptr_table_fetch(PL_ptr_table,
9990 cx->blk_loop.oldcomppad);
9991 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9992 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9993 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9994 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9995 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9998 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9999 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10000 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10001 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10013 /* duplicate a stack info structure */
10016 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10021 return (PERL_SI*)NULL;
10023 /* look for it in the table first */
10024 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10028 /* create anew and remember what it is */
10029 Newz(56, nsi, 1, PERL_SI);
10030 ptr_table_store(PL_ptr_table, si, nsi);
10032 nsi->si_stack = av_dup_inc(si->si_stack, param);
10033 nsi->si_cxix = si->si_cxix;
10034 nsi->si_cxmax = si->si_cxmax;
10035 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10036 nsi->si_type = si->si_type;
10037 nsi->si_prev = si_dup(si->si_prev, param);
10038 nsi->si_next = si_dup(si->si_next, param);
10039 nsi->si_markoff = si->si_markoff;
10044 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10045 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10046 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10047 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10048 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10049 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10050 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10051 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10052 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10053 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10054 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10055 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10056 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10057 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10060 #define pv_dup_inc(p) SAVEPV(p)
10061 #define pv_dup(p) SAVEPV(p)
10062 #define svp_dup_inc(p,pp) any_dup(p,pp)
10064 /* map any object to the new equivent - either something in the
10065 * ptr table, or something in the interpreter structure
10069 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10074 return (void*)NULL;
10076 /* look for it in the table first */
10077 ret = ptr_table_fetch(PL_ptr_table, v);
10081 /* see if it is part of the interpreter structure */
10082 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10083 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10091 /* duplicate the save stack */
10094 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10096 ANY *ss = proto_perl->Tsavestack;
10097 I32 ix = proto_perl->Tsavestack_ix;
10098 I32 max = proto_perl->Tsavestack_max;
10111 void (*dptr) (void*);
10112 void (*dxptr) (pTHX_ void*);
10115 Newz(54, nss, max, ANY);
10119 TOPINT(nss,ix) = i;
10121 case SAVEt_ITEM: /* normal string */
10122 sv = (SV*)POPPTR(ss,ix);
10123 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10124 sv = (SV*)POPPTR(ss,ix);
10125 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10127 case SAVEt_SV: /* scalar reference */
10128 sv = (SV*)POPPTR(ss,ix);
10129 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10130 gv = (GV*)POPPTR(ss,ix);
10131 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10133 case SAVEt_GENERIC_PVREF: /* generic char* */
10134 c = (char*)POPPTR(ss,ix);
10135 TOPPTR(nss,ix) = pv_dup(c);
10136 ptr = POPPTR(ss,ix);
10137 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10139 case SAVEt_SHARED_PVREF: /* char* in shared space */
10140 c = (char*)POPPTR(ss,ix);
10141 TOPPTR(nss,ix) = savesharedpv(c);
10142 ptr = POPPTR(ss,ix);
10143 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10145 case SAVEt_GENERIC_SVREF: /* generic sv */
10146 case SAVEt_SVREF: /* scalar reference */
10147 sv = (SV*)POPPTR(ss,ix);
10148 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10149 ptr = POPPTR(ss,ix);
10150 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10152 case SAVEt_AV: /* array reference */
10153 av = (AV*)POPPTR(ss,ix);
10154 TOPPTR(nss,ix) = av_dup_inc(av, param);
10155 gv = (GV*)POPPTR(ss,ix);
10156 TOPPTR(nss,ix) = gv_dup(gv, param);
10158 case SAVEt_HV: /* hash reference */
10159 hv = (HV*)POPPTR(ss,ix);
10160 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10161 gv = (GV*)POPPTR(ss,ix);
10162 TOPPTR(nss,ix) = gv_dup(gv, param);
10164 case SAVEt_INT: /* int reference */
10165 ptr = POPPTR(ss,ix);
10166 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10167 intval = (int)POPINT(ss,ix);
10168 TOPINT(nss,ix) = intval;
10170 case SAVEt_LONG: /* long reference */
10171 ptr = POPPTR(ss,ix);
10172 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10173 longval = (long)POPLONG(ss,ix);
10174 TOPLONG(nss,ix) = longval;
10176 case SAVEt_I32: /* I32 reference */
10177 case SAVEt_I16: /* I16 reference */
10178 case SAVEt_I8: /* I8 reference */
10179 ptr = POPPTR(ss,ix);
10180 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10182 TOPINT(nss,ix) = i;
10184 case SAVEt_IV: /* IV reference */
10185 ptr = POPPTR(ss,ix);
10186 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10188 TOPIV(nss,ix) = iv;
10190 case SAVEt_SPTR: /* SV* reference */
10191 ptr = POPPTR(ss,ix);
10192 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10193 sv = (SV*)POPPTR(ss,ix);
10194 TOPPTR(nss,ix) = sv_dup(sv, param);
10196 case SAVEt_VPTR: /* random* reference */
10197 ptr = POPPTR(ss,ix);
10198 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10199 ptr = POPPTR(ss,ix);
10200 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10202 case SAVEt_PPTR: /* char* reference */
10203 ptr = POPPTR(ss,ix);
10204 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10205 c = (char*)POPPTR(ss,ix);
10206 TOPPTR(nss,ix) = pv_dup(c);
10208 case SAVEt_HPTR: /* HV* reference */
10209 ptr = POPPTR(ss,ix);
10210 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10211 hv = (HV*)POPPTR(ss,ix);
10212 TOPPTR(nss,ix) = hv_dup(hv, param);
10214 case SAVEt_APTR: /* AV* reference */
10215 ptr = POPPTR(ss,ix);
10216 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10217 av = (AV*)POPPTR(ss,ix);
10218 TOPPTR(nss,ix) = av_dup(av, param);
10221 gv = (GV*)POPPTR(ss,ix);
10222 TOPPTR(nss,ix) = gv_dup(gv, param);
10224 case SAVEt_GP: /* scalar reference */
10225 gp = (GP*)POPPTR(ss,ix);
10226 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10227 (void)GpREFCNT_inc(gp);
10228 gv = (GV*)POPPTR(ss,ix);
10229 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10230 c = (char*)POPPTR(ss,ix);
10231 TOPPTR(nss,ix) = pv_dup(c);
10233 TOPIV(nss,ix) = iv;
10235 TOPIV(nss,ix) = iv;
10238 case SAVEt_MORTALIZESV:
10239 sv = (SV*)POPPTR(ss,ix);
10240 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10243 ptr = POPPTR(ss,ix);
10244 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10245 /* these are assumed to be refcounted properly */
10246 switch (((OP*)ptr)->op_type) {
10248 case OP_LEAVESUBLV:
10252 case OP_LEAVEWRITE:
10253 TOPPTR(nss,ix) = ptr;
10258 TOPPTR(nss,ix) = Nullop;
10263 TOPPTR(nss,ix) = Nullop;
10266 c = (char*)POPPTR(ss,ix);
10267 TOPPTR(nss,ix) = pv_dup_inc(c);
10269 case SAVEt_CLEARSV:
10270 longval = POPLONG(ss,ix);
10271 TOPLONG(nss,ix) = longval;
10274 hv = (HV*)POPPTR(ss,ix);
10275 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10276 c = (char*)POPPTR(ss,ix);
10277 TOPPTR(nss,ix) = pv_dup_inc(c);
10279 TOPINT(nss,ix) = i;
10281 case SAVEt_DESTRUCTOR:
10282 ptr = POPPTR(ss,ix);
10283 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10284 dptr = POPDPTR(ss,ix);
10285 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
10287 case SAVEt_DESTRUCTOR_X:
10288 ptr = POPPTR(ss,ix);
10289 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10290 dxptr = POPDXPTR(ss,ix);
10291 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
10293 case SAVEt_REGCONTEXT:
10296 TOPINT(nss,ix) = i;
10299 case SAVEt_STACK_POS: /* Position on Perl stack */
10301 TOPINT(nss,ix) = i;
10303 case SAVEt_AELEM: /* array element */
10304 sv = (SV*)POPPTR(ss,ix);
10305 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10307 TOPINT(nss,ix) = i;
10308 av = (AV*)POPPTR(ss,ix);
10309 TOPPTR(nss,ix) = av_dup_inc(av, param);
10311 case SAVEt_HELEM: /* hash element */
10312 sv = (SV*)POPPTR(ss,ix);
10313 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10314 sv = (SV*)POPPTR(ss,ix);
10315 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10316 hv = (HV*)POPPTR(ss,ix);
10317 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10320 ptr = POPPTR(ss,ix);
10321 TOPPTR(nss,ix) = ptr;
10325 TOPINT(nss,ix) = i;
10327 case SAVEt_COMPPAD:
10328 av = (AV*)POPPTR(ss,ix);
10329 TOPPTR(nss,ix) = av_dup(av, param);
10332 longval = (long)POPLONG(ss,ix);
10333 TOPLONG(nss,ix) = longval;
10334 ptr = POPPTR(ss,ix);
10335 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10336 sv = (SV*)POPPTR(ss,ix);
10337 TOPPTR(nss,ix) = sv_dup(sv, param);
10340 ptr = POPPTR(ss,ix);
10341 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10342 longval = (long)POPBOOL(ss,ix);
10343 TOPBOOL(nss,ix) = (bool)longval;
10346 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10354 =for apidoc perl_clone
10356 Create and return a new interpreter by cloning the current one.
10358 perl_clone takes these flags as paramters:
10360 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10361 without it we only clone the data and zero the stacks,
10362 with it we copy the stacks and the new perl interpreter is
10363 ready to run at the exact same point as the previous one.
10364 The pseudo-fork code uses COPY_STACKS while the
10365 threads->new doesn't.
10367 CLONEf_KEEP_PTR_TABLE
10368 perl_clone keeps a ptr_table with the pointer of the old
10369 variable as a key and the new variable as a value,
10370 this allows it to check if something has been cloned and not
10371 clone it again but rather just use the value and increase the
10372 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10373 the ptr_table using the function
10374 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10375 reason to keep it around is if you want to dup some of your own
10376 variable who are outside the graph perl scans, example of this
10377 code is in threads.xs create
10380 This is a win32 thing, it is ignored on unix, it tells perls
10381 win32host code (which is c++) to clone itself, this is needed on
10382 win32 if you want to run two threads at the same time,
10383 if you just want to do some stuff in a separate perl interpreter
10384 and then throw it away and return to the original one,
10385 you don't need to do anything.
10390 /* XXX the above needs expanding by someone who actually understands it ! */
10391 EXTERN_C PerlInterpreter *
10392 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10395 perl_clone(PerlInterpreter *proto_perl, UV flags)
10397 #ifdef PERL_IMPLICIT_SYS
10399 /* perlhost.h so we need to call into it
10400 to clone the host, CPerlHost should have a c interface, sky */
10402 if (flags & CLONEf_CLONE_HOST) {
10403 return perl_clone_host(proto_perl,flags);
10405 return perl_clone_using(proto_perl, flags,
10407 proto_perl->IMemShared,
10408 proto_perl->IMemParse,
10410 proto_perl->IStdIO,
10414 proto_perl->IProc);
10418 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10419 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10420 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10421 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10422 struct IPerlDir* ipD, struct IPerlSock* ipS,
10423 struct IPerlProc* ipP)
10425 /* XXX many of the string copies here can be optimized if they're
10426 * constants; they need to be allocated as common memory and just
10427 * their pointers copied. */
10430 CLONE_PARAMS clone_params;
10431 CLONE_PARAMS* param = &clone_params;
10433 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10434 PERL_SET_THX(my_perl);
10437 Poison(my_perl, 1, PerlInterpreter);
10442 PL_sig_pending = 0;
10443 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10444 # else /* !DEBUGGING */
10445 Zero(my_perl, 1, PerlInterpreter);
10446 # endif /* DEBUGGING */
10448 /* host pointers */
10450 PL_MemShared = ipMS;
10451 PL_MemParse = ipMP;
10458 #else /* !PERL_IMPLICIT_SYS */
10460 CLONE_PARAMS clone_params;
10461 CLONE_PARAMS* param = &clone_params;
10462 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10463 PERL_SET_THX(my_perl);
10468 Poison(my_perl, 1, PerlInterpreter);
10473 PL_sig_pending = 0;
10474 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10475 # else /* !DEBUGGING */
10476 Zero(my_perl, 1, PerlInterpreter);
10477 # endif /* DEBUGGING */
10478 #endif /* PERL_IMPLICIT_SYS */
10479 param->flags = flags;
10480 param->proto_perl = proto_perl;
10483 PL_xiv_arenaroot = NULL;
10484 PL_xiv_root = NULL;
10485 PL_xnv_arenaroot = NULL;
10486 PL_xnv_root = NULL;
10487 PL_xrv_arenaroot = NULL;
10488 PL_xrv_root = NULL;
10489 PL_xpv_arenaroot = NULL;
10490 PL_xpv_root = NULL;
10491 PL_xpviv_arenaroot = NULL;
10492 PL_xpviv_root = NULL;
10493 PL_xpvnv_arenaroot = NULL;
10494 PL_xpvnv_root = NULL;
10495 PL_xpvcv_arenaroot = NULL;
10496 PL_xpvcv_root = NULL;
10497 PL_xpvav_arenaroot = NULL;
10498 PL_xpvav_root = NULL;
10499 PL_xpvhv_arenaroot = NULL;
10500 PL_xpvhv_root = NULL;
10501 PL_xpvmg_arenaroot = NULL;
10502 PL_xpvmg_root = NULL;
10503 PL_xpvlv_arenaroot = NULL;
10504 PL_xpvlv_root = NULL;
10505 PL_xpvbm_arenaroot = NULL;
10506 PL_xpvbm_root = NULL;
10507 PL_he_arenaroot = NULL;
10509 PL_nice_chunk = NULL;
10510 PL_nice_chunk_size = 0;
10512 PL_sv_objcount = 0;
10513 PL_sv_root = Nullsv;
10514 PL_sv_arenaroot = Nullsv;
10516 PL_debug = proto_perl->Idebug;
10518 #ifdef USE_REENTRANT_API
10519 Perl_reentrant_init(aTHX);
10522 /* create SV map for pointer relocation */
10523 PL_ptr_table = ptr_table_new();
10525 /* initialize these special pointers as early as possible */
10526 SvANY(&PL_sv_undef) = NULL;
10527 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10528 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10529 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10531 SvANY(&PL_sv_no) = new_XPVNV();
10532 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10533 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10534 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
10535 SvCUR(&PL_sv_no) = 0;
10536 SvLEN(&PL_sv_no) = 1;
10537 SvNVX(&PL_sv_no) = 0;
10538 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10540 SvANY(&PL_sv_yes) = new_XPVNV();
10541 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10542 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10543 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
10544 SvCUR(&PL_sv_yes) = 1;
10545 SvLEN(&PL_sv_yes) = 2;
10546 SvNVX(&PL_sv_yes) = 1;
10547 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10549 /* create (a non-shared!) shared string table */
10550 PL_strtab = newHV();
10551 HvSHAREKEYS_off(PL_strtab);
10552 hv_ksplit(PL_strtab, 512);
10553 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10555 PL_compiling = proto_perl->Icompiling;
10557 /* These two PVs will be free'd special way so must set them same way op.c does */
10558 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10559 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10561 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10562 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10564 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10565 if (!specialWARN(PL_compiling.cop_warnings))
10566 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10567 if (!specialCopIO(PL_compiling.cop_io))
10568 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10569 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10571 /* pseudo environmental stuff */
10572 PL_origargc = proto_perl->Iorigargc;
10573 PL_origargv = proto_perl->Iorigargv;
10575 param->stashes = newAV(); /* Setup array of objects to call clone on */
10577 #ifdef PERLIO_LAYERS
10578 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10579 PerlIO_clone(aTHX_ proto_perl, param);
10582 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10583 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10584 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10585 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10586 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10587 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10590 PL_minus_c = proto_perl->Iminus_c;
10591 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10592 PL_localpatches = proto_perl->Ilocalpatches;
10593 PL_splitstr = proto_perl->Isplitstr;
10594 PL_preprocess = proto_perl->Ipreprocess;
10595 PL_minus_n = proto_perl->Iminus_n;
10596 PL_minus_p = proto_perl->Iminus_p;
10597 PL_minus_l = proto_perl->Iminus_l;
10598 PL_minus_a = proto_perl->Iminus_a;
10599 PL_minus_F = proto_perl->Iminus_F;
10600 PL_doswitches = proto_perl->Idoswitches;
10601 PL_dowarn = proto_perl->Idowarn;
10602 PL_doextract = proto_perl->Idoextract;
10603 PL_sawampersand = proto_perl->Isawampersand;
10604 PL_unsafe = proto_perl->Iunsafe;
10605 PL_inplace = SAVEPV(proto_perl->Iinplace);
10606 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10607 PL_perldb = proto_perl->Iperldb;
10608 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10609 PL_exit_flags = proto_perl->Iexit_flags;
10611 /* magical thingies */
10612 /* XXX time(&PL_basetime) when asked for? */
10613 PL_basetime = proto_perl->Ibasetime;
10614 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10616 PL_maxsysfd = proto_perl->Imaxsysfd;
10617 PL_multiline = proto_perl->Imultiline;
10618 PL_statusvalue = proto_perl->Istatusvalue;
10620 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10622 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10624 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10625 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10626 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10628 /* Clone the regex array */
10629 PL_regex_padav = newAV();
10631 I32 len = av_len((AV*)proto_perl->Iregex_padav);
10632 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10633 av_push(PL_regex_padav,
10634 sv_dup_inc(regexen[0],param));
10635 for(i = 1; i <= len; i++) {
10636 if(SvREPADTMP(regexen[i])) {
10637 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10639 av_push(PL_regex_padav,
10641 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10642 SvIVX(regexen[i])), param)))
10647 PL_regex_pad = AvARRAY(PL_regex_padav);
10649 /* shortcuts to various I/O objects */
10650 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10651 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10652 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10653 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10654 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10655 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10657 /* shortcuts to regexp stuff */
10658 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10660 /* shortcuts to misc objects */
10661 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10663 /* shortcuts to debugging objects */
10664 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10665 PL_DBline = gv_dup(proto_perl->IDBline, param);
10666 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10667 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10668 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10669 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10670 PL_lineary = av_dup(proto_perl->Ilineary, param);
10671 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10673 /* symbol tables */
10674 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10675 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10676 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10677 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10678 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10680 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10681 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10682 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10683 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10684 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10685 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10687 PL_sub_generation = proto_perl->Isub_generation;
10689 /* funky return mechanisms */
10690 PL_forkprocess = proto_perl->Iforkprocess;
10692 /* subprocess state */
10693 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10695 /* internal state */
10696 PL_tainting = proto_perl->Itainting;
10697 PL_maxo = proto_perl->Imaxo;
10698 if (proto_perl->Iop_mask)
10699 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10701 PL_op_mask = Nullch;
10703 /* current interpreter roots */
10704 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10705 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10706 PL_main_start = proto_perl->Imain_start;
10707 PL_eval_root = proto_perl->Ieval_root;
10708 PL_eval_start = proto_perl->Ieval_start;
10710 /* runtime control stuff */
10711 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10712 PL_copline = proto_perl->Icopline;
10714 PL_filemode = proto_perl->Ifilemode;
10715 PL_lastfd = proto_perl->Ilastfd;
10716 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10719 PL_gensym = proto_perl->Igensym;
10720 PL_preambled = proto_perl->Ipreambled;
10721 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10722 PL_laststatval = proto_perl->Ilaststatval;
10723 PL_laststype = proto_perl->Ilaststype;
10724 PL_mess_sv = Nullsv;
10726 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10727 PL_ofmt = SAVEPV(proto_perl->Iofmt);
10729 /* interpreter atexit processing */
10730 PL_exitlistlen = proto_perl->Iexitlistlen;
10731 if (PL_exitlistlen) {
10732 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10733 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10736 PL_exitlist = (PerlExitListEntry*)NULL;
10737 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10738 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10739 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10741 PL_profiledata = NULL;
10742 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10743 /* PL_rsfp_filters entries have fake IoDIRP() */
10744 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10746 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10748 PAD_CLONE_VARS(proto_perl, param);
10750 #ifdef HAVE_INTERP_INTERN
10751 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10754 /* more statics moved here */
10755 PL_generation = proto_perl->Igeneration;
10756 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10758 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10759 PL_in_clean_all = proto_perl->Iin_clean_all;
10761 PL_uid = proto_perl->Iuid;
10762 PL_euid = proto_perl->Ieuid;
10763 PL_gid = proto_perl->Igid;
10764 PL_egid = proto_perl->Iegid;
10765 PL_nomemok = proto_perl->Inomemok;
10766 PL_an = proto_perl->Ian;
10767 PL_op_seqmax = proto_perl->Iop_seqmax;
10768 PL_evalseq = proto_perl->Ievalseq;
10769 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10770 PL_origalen = proto_perl->Iorigalen;
10771 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10772 PL_osname = SAVEPV(proto_perl->Iosname);
10773 PL_sh_path = proto_perl->Ish_path; /* XXX never deallocated */
10774 PL_sighandlerp = proto_perl->Isighandlerp;
10777 PL_runops = proto_perl->Irunops;
10779 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10782 PL_cshlen = proto_perl->Icshlen;
10783 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10786 PL_lex_state = proto_perl->Ilex_state;
10787 PL_lex_defer = proto_perl->Ilex_defer;
10788 PL_lex_expect = proto_perl->Ilex_expect;
10789 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10790 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10791 PL_lex_starts = proto_perl->Ilex_starts;
10792 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10793 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10794 PL_lex_op = proto_perl->Ilex_op;
10795 PL_lex_inpat = proto_perl->Ilex_inpat;
10796 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10797 PL_lex_brackets = proto_perl->Ilex_brackets;
10798 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10799 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10800 PL_lex_casemods = proto_perl->Ilex_casemods;
10801 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10802 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10804 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10805 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10806 PL_nexttoke = proto_perl->Inexttoke;
10808 /* XXX This is probably masking the deeper issue of why
10809 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10810 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10811 * (A little debugging with a watchpoint on it may help.)
10813 if (SvANY(proto_perl->Ilinestr)) {
10814 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10815 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
10816 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10817 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
10818 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10819 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
10820 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10821 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
10822 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10825 PL_linestr = NEWSV(65,79);
10826 sv_upgrade(PL_linestr,SVt_PVIV);
10827 sv_setpvn(PL_linestr,"",0);
10828 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10830 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10831 PL_pending_ident = proto_perl->Ipending_ident;
10832 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10834 PL_expect = proto_perl->Iexpect;
10836 PL_multi_start = proto_perl->Imulti_start;
10837 PL_multi_end = proto_perl->Imulti_end;
10838 PL_multi_open = proto_perl->Imulti_open;
10839 PL_multi_close = proto_perl->Imulti_close;
10841 PL_error_count = proto_perl->Ierror_count;
10842 PL_subline = proto_perl->Isubline;
10843 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10845 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10846 if (SvANY(proto_perl->Ilinestr)) {
10847 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
10848 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10849 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
10850 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10851 PL_last_lop_op = proto_perl->Ilast_lop_op;
10854 PL_last_uni = SvPVX(PL_linestr);
10855 PL_last_lop = SvPVX(PL_linestr);
10856 PL_last_lop_op = 0;
10858 PL_in_my = proto_perl->Iin_my;
10859 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10861 PL_cryptseen = proto_perl->Icryptseen;
10864 PL_hints = proto_perl->Ihints;
10866 PL_amagic_generation = proto_perl->Iamagic_generation;
10868 #ifdef USE_LOCALE_COLLATE
10869 PL_collation_ix = proto_perl->Icollation_ix;
10870 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10871 PL_collation_standard = proto_perl->Icollation_standard;
10872 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10873 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10874 #endif /* USE_LOCALE_COLLATE */
10876 #ifdef USE_LOCALE_NUMERIC
10877 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10878 PL_numeric_standard = proto_perl->Inumeric_standard;
10879 PL_numeric_local = proto_perl->Inumeric_local;
10880 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10881 #endif /* !USE_LOCALE_NUMERIC */
10883 /* utf8 character classes */
10884 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10885 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10886 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10887 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10888 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10889 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10890 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10891 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10892 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10893 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10894 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10895 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10896 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10897 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10898 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10899 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10900 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10901 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10902 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10903 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10906 PL_last_swash_hv = Nullhv; /* reinits on demand */
10907 PL_last_swash_klen = 0;
10908 PL_last_swash_key[0]= '\0';
10909 PL_last_swash_tmps = (U8*)NULL;
10910 PL_last_swash_slen = 0;
10912 /* perly.c globals */
10913 PL_yydebug = proto_perl->Iyydebug;
10914 PL_yynerrs = proto_perl->Iyynerrs;
10915 PL_yyerrflag = proto_perl->Iyyerrflag;
10916 PL_yychar = proto_perl->Iyychar;
10917 PL_yyval = proto_perl->Iyyval;
10918 PL_yylval = proto_perl->Iyylval;
10920 PL_glob_index = proto_perl->Iglob_index;
10921 PL_srand_called = proto_perl->Isrand_called;
10922 PL_uudmap['M'] = 0; /* reinits on demand */
10923 PL_bitcount = Nullch; /* reinits on demand */
10925 if (proto_perl->Ipsig_pend) {
10926 Newz(0, PL_psig_pend, SIG_SIZE, int);
10929 PL_psig_pend = (int*)NULL;
10932 if (proto_perl->Ipsig_ptr) {
10933 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
10934 Newz(0, PL_psig_name, SIG_SIZE, SV*);
10935 for (i = 1; i < SIG_SIZE; i++) {
10936 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10937 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10941 PL_psig_ptr = (SV**)NULL;
10942 PL_psig_name = (SV**)NULL;
10945 /* thrdvar.h stuff */
10947 if (flags & CLONEf_COPY_STACKS) {
10948 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10949 PL_tmps_ix = proto_perl->Ttmps_ix;
10950 PL_tmps_max = proto_perl->Ttmps_max;
10951 PL_tmps_floor = proto_perl->Ttmps_floor;
10952 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
10954 while (i <= PL_tmps_ix) {
10955 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10959 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10960 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10961 Newz(54, PL_markstack, i, I32);
10962 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10963 - proto_perl->Tmarkstack);
10964 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10965 - proto_perl->Tmarkstack);
10966 Copy(proto_perl->Tmarkstack, PL_markstack,
10967 PL_markstack_ptr - PL_markstack + 1, I32);
10969 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10970 * NOTE: unlike the others! */
10971 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10972 PL_scopestack_max = proto_perl->Tscopestack_max;
10973 Newz(54, PL_scopestack, PL_scopestack_max, I32);
10974 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10976 /* next push_return() sets PL_retstack[PL_retstack_ix]
10977 * NOTE: unlike the others! */
10978 PL_retstack_ix = proto_perl->Tretstack_ix;
10979 PL_retstack_max = proto_perl->Tretstack_max;
10980 Newz(54, PL_retstack, PL_retstack_max, OP*);
10981 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
10983 /* NOTE: si_dup() looks at PL_markstack */
10984 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10986 /* PL_curstack = PL_curstackinfo->si_stack; */
10987 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10988 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10990 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10991 PL_stack_base = AvARRAY(PL_curstack);
10992 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10993 - proto_perl->Tstack_base);
10994 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10996 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10997 * NOTE: unlike the others! */
10998 PL_savestack_ix = proto_perl->Tsavestack_ix;
10999 PL_savestack_max = proto_perl->Tsavestack_max;
11000 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11001 PL_savestack = ss_dup(proto_perl, param);
11005 ENTER; /* perl_destruct() wants to LEAVE; */
11008 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11009 PL_top_env = &PL_start_env;
11011 PL_op = proto_perl->Top;
11014 PL_Xpv = (XPV*)NULL;
11015 PL_na = proto_perl->Tna;
11017 PL_statbuf = proto_perl->Tstatbuf;
11018 PL_statcache = proto_perl->Tstatcache;
11019 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11020 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11022 PL_timesbuf = proto_perl->Ttimesbuf;
11025 PL_tainted = proto_perl->Ttainted;
11026 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11027 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11028 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11029 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11030 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11031 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11032 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11033 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11034 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11036 PL_restartop = proto_perl->Trestartop;
11037 PL_in_eval = proto_perl->Tin_eval;
11038 PL_delaymagic = proto_perl->Tdelaymagic;
11039 PL_dirty = proto_perl->Tdirty;
11040 PL_localizing = proto_perl->Tlocalizing;
11042 #ifdef PERL_FLEXIBLE_EXCEPTIONS
11043 PL_protect = proto_perl->Tprotect;
11045 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11046 PL_av_fetch_sv = Nullsv;
11047 PL_hv_fetch_sv = Nullsv;
11048 Zero(&PL_hv_fetch_ent_mh, 1, HE); /* XXX */
11049 PL_modcount = proto_perl->Tmodcount;
11050 PL_lastgotoprobe = Nullop;
11051 PL_dumpindent = proto_perl->Tdumpindent;
11053 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11054 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11055 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11056 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11057 PL_sortcxix = proto_perl->Tsortcxix;
11058 PL_efloatbuf = Nullch; /* reinits on demand */
11059 PL_efloatsize = 0; /* reinits on demand */
11063 PL_screamfirst = NULL;
11064 PL_screamnext = NULL;
11065 PL_maxscream = -1; /* reinits on demand */
11066 PL_lastscream = Nullsv;
11068 PL_watchaddr = NULL;
11069 PL_watchok = Nullch;
11071 PL_regdummy = proto_perl->Tregdummy;
11072 PL_regprecomp = Nullch;
11075 PL_colorset = 0; /* reinits PL_colors[] */
11076 /*PL_colors[6] = {0,0,0,0,0,0};*/
11077 PL_reginput = Nullch;
11078 PL_regbol = Nullch;
11079 PL_regeol = Nullch;
11080 PL_regstartp = (I32*)NULL;
11081 PL_regendp = (I32*)NULL;
11082 PL_reglastparen = (U32*)NULL;
11083 PL_regtill = Nullch;
11084 PL_reg_start_tmp = (char**)NULL;
11085 PL_reg_start_tmpl = 0;
11086 PL_regdata = (struct reg_data*)NULL;
11089 PL_reg_eval_set = 0;
11091 PL_regprogram = (regnode*)NULL;
11093 PL_regcc = (CURCUR*)NULL;
11094 PL_reg_call_cc = (struct re_cc_state*)NULL;
11095 PL_reg_re = (regexp*)NULL;
11096 PL_reg_ganch = Nullch;
11097 PL_reg_sv = Nullsv;
11098 PL_reg_match_utf8 = FALSE;
11099 PL_reg_magic = (MAGIC*)NULL;
11101 PL_reg_oldcurpm = (PMOP*)NULL;
11102 PL_reg_curpm = (PMOP*)NULL;
11103 PL_reg_oldsaved = Nullch;
11104 PL_reg_oldsavedlen = 0;
11105 PL_reg_maxiter = 0;
11106 PL_reg_leftiter = 0;
11107 PL_reg_poscache = Nullch;
11108 PL_reg_poscache_size= 0;
11110 /* RE engine - function pointers */
11111 PL_regcompp = proto_perl->Tregcompp;
11112 PL_regexecp = proto_perl->Tregexecp;
11113 PL_regint_start = proto_perl->Tregint_start;
11114 PL_regint_string = proto_perl->Tregint_string;
11115 PL_regfree = proto_perl->Tregfree;
11117 PL_reginterp_cnt = 0;
11118 PL_reg_starttry = 0;
11120 /* Pluggable optimizer */
11121 PL_peepp = proto_perl->Tpeepp;
11123 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11124 ptr_table_free(PL_ptr_table);
11125 PL_ptr_table = NULL;
11128 /* Call the ->CLONE method, if it exists, for each of the stashes
11129 identified by sv_dup() above.
11131 while(av_len(param->stashes) != -1) {
11132 HV* stash = (HV*) av_shift(param->stashes);
11133 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11134 if (cloner && GvCV(cloner)) {
11139 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
11141 call_sv((SV*)GvCV(cloner), G_DISCARD);
11147 SvREFCNT_dec(param->stashes);
11152 #endif /* USE_ITHREADS */
11155 =head1 Unicode Support
11157 =for apidoc sv_recode_to_utf8
11159 The encoding is assumed to be an Encode object, on entry the PV
11160 of the sv is assumed to be octets in that encoding, and the sv
11161 will be converted into Unicode (and UTF-8).
11163 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11164 is not a reference, nothing is done to the sv. If the encoding is not
11165 an C<Encode::XS> Encoding object, bad things will happen.
11166 (See F<lib/encoding.pm> and L<Encode>).
11168 The PV of the sv is returned.
11173 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11175 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11189 Passing sv_yes is wrong - it needs to be or'ed set of constants
11190 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11191 remove converted chars from source.
11193 Both will default the value - let them.
11195 XPUSHs(&PL_sv_yes);
11198 call_method("decode", G_SCALAR);
11202 s = SvPV(uni, len);
11203 if (s != SvPVX(sv)) {
11204 SvGROW(sv, len + 1);
11205 Move(s, SvPVX(sv), len, char);
11206 SvCUR_set(sv, len);
11207 SvPVX(sv)[len] = 0;
11217 =for apidoc sv_cat_decode
11219 The encoding is assumed to be an Encode object, the PV of the ssv is
11220 assumed to be octets in that encoding and decoding the input starts
11221 from the position which (PV + *offset) pointed to. The dsv will be
11222 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11223 when the string tstr appears in decoding output or the input ends on
11224 the PV of the ssv. The value which the offset points will be modified
11225 to the last input position on the ssv.
11227 Returns TRUE if the terminator was found, else returns FALSE.
11232 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11233 SV *ssv, int *offset, char *tstr, int tlen)
11235 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11247 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11248 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11250 call_method("cat_decode", G_SCALAR);
11252 ret = SvTRUE(TOPs);
11253 *offset = SvIV(offsv);
11259 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode.");