3 * Copyright (c) 1991-2001, 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
25 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) sv_force_normal(sv)
28 /* ============================================================================
30 =head1 Allocation and deallocation of SVs.
32 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
33 av, hv...) contains type and reference count information, as well as a
34 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
35 specific to each type.
37 Normally, this allocation is done using arenas, which are approximately
38 1K chunks of memory parcelled up into N heads or bodies. The first slot
39 in each arena is reserved, and is used to hold a link to the next arena.
40 In the case of heads, the unused first slot also contains some flags and
41 a note of the number of slots. Snaked through each arena chain is a
42 linked list of free items; when this becomes empty, an extra arena is
43 allocated and divided up into N items which are threaded into the free
46 The following global variables are associated with arenas:
48 PL_sv_arenaroot pointer to list of SV arenas
49 PL_sv_root pointer to list of free SV structures
51 PL_foo_arenaroot pointer to list of foo arenas,
52 PL_foo_root pointer to list of free foo bodies
53 ... for foo in xiv, xnv, xrv, xpv etc.
55 Note that some of the larger and more rarely used body types (eg xpvio)
56 are not allocated using arenas, but are instead just malloc()/free()ed as
57 required. Also, if PURIFY is defined, arenas are abandoned altogether,
58 with all items individually malloc()ed. In addition, a few SV heads are
59 not allocated from an arena, but are instead directly created as static
60 or auto variables, eg PL_sv_undef.
62 The SV arena serves the secondary purpose of allowing still-live SVs
63 to be located and destroyed during final cleanup.
65 At the lowest level, the macros new_SV() and del_SV() grab and free
66 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
67 to return the SV to the free list with error checking.) new_SV() calls
68 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
69 SVs in the free list have their SvTYPE field set to all ones.
71 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
72 that allocate and return individual body types. Normally these are mapped
73 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
74 instead mapped directly to malloc()/free() if PURIFY is defined. The
75 new/del functions remove from, or add to, the appropriate PL_foo_root
76 list, and call more_xiv() etc to add a new arena if the list is empty.
78 At the time of very final cleanup, sv_free_arenas() is called from
79 perl_destruct() to physically free all the arenas allocated since the
80 start of the interpreter. Note that this also clears PL_he_arenaroot,
81 which is otherwise dealt with in hv.c.
83 Manipulation of any of the PL_*root pointers is protected by enclosing
84 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
85 if threads are enabled.
87 The function visit() scans the SV arenas list, and calls a specified
88 function for each SV it finds which is still live - ie which has an SvTYPE
89 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
90 following functions (specified as [function that calls visit()] / [function
91 called by visit() for each SV]):
93 sv_report_used() / do_report_used()
94 dump all remaining SVs (debugging aid)
96 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
97 Attempt to free all objects pointed to by RVs,
98 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
99 try to do the same for all objects indirectly
100 referenced by typeglobs too. Called once from
101 perl_destruct(), prior to calling sv_clean_all()
104 sv_clean_all() / do_clean_all()
105 SvREFCNT_dec(sv) each remaining SV, possibly
106 triggering an sv_free(). It also sets the
107 SVf_BREAK flag on the SV to indicate that the
108 refcnt has been artificially lowered, and thus
109 stopping sv_free() from giving spurious warnings
110 about SVs which unexpectedly have a refcnt
111 of zero. called repeatedly from perl_destruct()
112 until there are no SVs left.
116 Private API to rest of sv.c
120 new_XIV(), del_XIV(),
121 new_XNV(), del_XNV(),
126 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
131 ============================================================================ */
136 * "A time to plant, and a time to uproot what was planted..."
139 #define plant_SV(p) \
141 SvANY(p) = (void *)PL_sv_root; \
142 SvFLAGS(p) = SVTYPEMASK; \
147 /* sv_mutex must be held while calling uproot_SV() */
148 #define uproot_SV(p) \
151 PL_sv_root = (SV*)SvANY(p); \
156 /* new_SV(): return a new, empty SV head */
172 /* del_SV(): return an empty SV head to the free list */
187 S_del_sv(pTHX_ SV *p)
194 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
196 svend = &sva[SvREFCNT(sva)];
197 if (p >= sv && p < svend)
201 if (ckWARN_d(WARN_INTERNAL))
202 Perl_warner(aTHX_ WARN_INTERNAL,
203 "Attempt to free non-arena SV: 0x%"UVxf,
211 #else /* ! DEBUGGING */
213 #define del_SV(p) plant_SV(p)
215 #endif /* DEBUGGING */
219 =for apidoc sv_add_arena
221 Given a chunk of memory, link it to the head of the list of arenas,
222 and split it into a list of free SVs.
228 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
233 Zero(ptr, size, char);
235 /* The first SV in an arena isn't an SV. */
236 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
237 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
238 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
240 PL_sv_arenaroot = sva;
241 PL_sv_root = sva + 1;
243 svend = &sva[SvREFCNT(sva) - 1];
246 SvANY(sv) = (void *)(SV*)(sv + 1);
247 SvFLAGS(sv) = SVTYPEMASK;
251 SvFLAGS(sv) = SVTYPEMASK;
254 /* make some more SVs by adding another arena */
256 /* sv_mutex must be held while calling more_sv() */
263 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
264 PL_nice_chunk = Nullch;
265 PL_nice_chunk_size = 0;
268 char *chunk; /* must use New here to match call to */
269 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
270 sv_add_arena(chunk, 1008, 0);
276 /* visit(): call the named function for each non-free SV in the arenas. */
279 S_visit(pTHX_ SVFUNC_t f)
286 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
287 svend = &sva[SvREFCNT(sva)];
288 for (sv = sva + 1; sv < svend; ++sv) {
289 if (SvTYPE(sv) != SVTYPEMASK && SvREFCNT(sv)) {
298 /* called by sv_report_used() for each live SV */
301 do_report_used(pTHX_ SV *sv)
304 if (SvTYPE(sv) != SVTYPEMASK) {
305 PerlIO_printf(Perl_debug_log, "****\n");
312 =for apidoc sv_report_used
314 Dump the contents of all SVs not yet freed. (Debugging aid).
320 Perl_sv_report_used(pTHX)
323 visit(do_report_used);
327 /* called by sv_clean_objs() for each live SV */
330 do_clean_objs(pTHX_ SV *sv)
334 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
335 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
347 /* XXX Might want to check arrays, etc. */
350 /* called by sv_clean_objs() for each live SV */
352 #ifndef DISABLE_DESTRUCTOR_KLUDGE
354 do_clean_named_objs(pTHX_ SV *sv)
356 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
357 if ( SvOBJECT(GvSV(sv)) ||
358 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
359 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
360 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
361 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
363 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
371 =for apidoc sv_clean_objs
373 Attempt to destroy all objects not yet freed
379 Perl_sv_clean_objs(pTHX)
381 PL_in_clean_objs = TRUE;
382 visit(do_clean_objs);
383 #ifndef DISABLE_DESTRUCTOR_KLUDGE
384 /* some barnacles may yet remain, clinging to typeglobs */
385 visit(do_clean_named_objs);
387 PL_in_clean_objs = FALSE;
390 /* called by sv_clean_all() for each live SV */
393 do_clean_all(pTHX_ SV *sv)
395 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
396 SvFLAGS(sv) |= SVf_BREAK;
401 =for apidoc sv_clean_all
403 Decrement the refcnt of each remaining SV, possibly triggering a
404 cleanup. This function may have to be called multiple times to free
405 SVs which are in complex self-referential hierarchies.
411 Perl_sv_clean_all(pTHX)
414 PL_in_clean_all = TRUE;
415 cleaned = visit(do_clean_all);
416 PL_in_clean_all = FALSE;
421 =for apidoc sv_free_arenas
423 Deallocate the memory used by all arenas. Note that all the individual SV
424 heads and bodies within the arenas must already have been freed.
430 Perl_sv_free_arenas(pTHX)
434 XPV *arena, *arenanext;
436 /* Free arenas here, but be careful about fake ones. (We assume
437 contiguity of the fake ones with the corresponding real ones.) */
439 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
440 svanext = (SV*) SvANY(sva);
441 while (svanext && SvFAKE(svanext))
442 svanext = (SV*) SvANY(svanext);
445 Safefree((void *)sva);
448 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
449 arenanext = (XPV*)arena->xpv_pv;
452 PL_xiv_arenaroot = 0;
454 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
455 arenanext = (XPV*)arena->xpv_pv;
458 PL_xnv_arenaroot = 0;
460 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
461 arenanext = (XPV*)arena->xpv_pv;
464 PL_xrv_arenaroot = 0;
466 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
467 arenanext = (XPV*)arena->xpv_pv;
470 PL_xpv_arenaroot = 0;
472 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
473 arenanext = (XPV*)arena->xpv_pv;
476 PL_xpviv_arenaroot = 0;
478 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
479 arenanext = (XPV*)arena->xpv_pv;
482 PL_xpvnv_arenaroot = 0;
484 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
485 arenanext = (XPV*)arena->xpv_pv;
488 PL_xpvcv_arenaroot = 0;
490 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
491 arenanext = (XPV*)arena->xpv_pv;
494 PL_xpvav_arenaroot = 0;
496 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
497 arenanext = (XPV*)arena->xpv_pv;
500 PL_xpvhv_arenaroot = 0;
502 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
503 arenanext = (XPV*)arena->xpv_pv;
506 PL_xpvmg_arenaroot = 0;
508 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
509 arenanext = (XPV*)arena->xpv_pv;
512 PL_xpvlv_arenaroot = 0;
514 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
515 arenanext = (XPV*)arena->xpv_pv;
518 PL_xpvbm_arenaroot = 0;
520 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
521 arenanext = (XPV*)arena->xpv_pv;
527 Safefree(PL_nice_chunk);
528 PL_nice_chunk = Nullch;
529 PL_nice_chunk_size = 0;
535 =for apidoc report_uninit
537 Print appropriate "Use of uninitialized variable" warning
543 Perl_report_uninit(pTHX)
546 Perl_warner(aTHX_ WARN_UNINITIALIZED, PL_warn_uninit,
547 " in ", OP_DESC(PL_op));
549 Perl_warner(aTHX_ WARN_UNINITIALIZED, PL_warn_uninit, "", "");
552 /* grab a new IV body from the free list, allocating more if necessary */
563 * See comment in more_xiv() -- RAM.
565 PL_xiv_root = *(IV**)xiv;
567 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
570 /* return an IV body to the free list */
573 S_del_xiv(pTHX_ XPVIV *p)
575 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
577 *(IV**)xiv = PL_xiv_root;
582 /* allocate another arena's worth of IV bodies */
590 New(705, ptr, 1008/sizeof(XPV), XPV);
591 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
592 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
595 xivend = &xiv[1008 / sizeof(IV) - 1];
596 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
598 while (xiv < xivend) {
599 *(IV**)xiv = (IV *)(xiv + 1);
605 /* grab a new NV body from the free list, allocating more if necessary */
615 PL_xnv_root = *(NV**)xnv;
617 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
620 /* return an NV body to the free list */
623 S_del_xnv(pTHX_ XPVNV *p)
625 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
627 *(NV**)xnv = PL_xnv_root;
632 /* allocate another arena's worth of NV bodies */
640 New(711, ptr, 1008/sizeof(XPV), XPV);
641 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
642 PL_xnv_arenaroot = ptr;
645 xnvend = &xnv[1008 / sizeof(NV) - 1];
646 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
648 while (xnv < xnvend) {
649 *(NV**)xnv = (NV*)(xnv + 1);
655 /* grab a new struct xrv from the free list, allocating more if necessary */
665 PL_xrv_root = (XRV*)xrv->xrv_rv;
670 /* return a struct xrv to the free list */
673 S_del_xrv(pTHX_ XRV *p)
676 p->xrv_rv = (SV*)PL_xrv_root;
681 /* allocate another arena's worth of struct xrv */
687 register XRV* xrvend;
689 New(712, ptr, 1008/sizeof(XPV), XPV);
690 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
691 PL_xrv_arenaroot = ptr;
694 xrvend = &xrv[1008 / sizeof(XRV) - 1];
695 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
697 while (xrv < xrvend) {
698 xrv->xrv_rv = (SV*)(xrv + 1);
704 /* grab a new struct xpv from the free list, allocating more if necessary */
714 PL_xpv_root = (XPV*)xpv->xpv_pv;
719 /* return a struct xpv to the free list */
722 S_del_xpv(pTHX_ XPV *p)
725 p->xpv_pv = (char*)PL_xpv_root;
730 /* allocate another arena's worth of struct xpv */
736 register XPV* xpvend;
737 New(713, xpv, 1008/sizeof(XPV), XPV);
738 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
739 PL_xpv_arenaroot = xpv;
741 xpvend = &xpv[1008 / sizeof(XPV) - 1];
743 while (xpv < xpvend) {
744 xpv->xpv_pv = (char*)(xpv + 1);
750 /* grab a new struct xpviv from the free list, allocating more if necessary */
759 xpviv = PL_xpviv_root;
760 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
765 /* return a struct xpviv to the free list */
768 S_del_xpviv(pTHX_ XPVIV *p)
771 p->xpv_pv = (char*)PL_xpviv_root;
776 /* allocate another arena's worth of struct xpviv */
781 register XPVIV* xpviv;
782 register XPVIV* xpvivend;
783 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
784 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
785 PL_xpviv_arenaroot = xpviv;
787 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
788 PL_xpviv_root = ++xpviv;
789 while (xpviv < xpvivend) {
790 xpviv->xpv_pv = (char*)(xpviv + 1);
796 /* grab a new struct xpvnv from the free list, allocating more if necessary */
805 xpvnv = PL_xpvnv_root;
806 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
811 /* return a struct xpvnv to the free list */
814 S_del_xpvnv(pTHX_ XPVNV *p)
817 p->xpv_pv = (char*)PL_xpvnv_root;
822 /* allocate another arena's worth of struct xpvnv */
827 register XPVNV* xpvnv;
828 register XPVNV* xpvnvend;
829 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
830 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
831 PL_xpvnv_arenaroot = xpvnv;
833 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
834 PL_xpvnv_root = ++xpvnv;
835 while (xpvnv < xpvnvend) {
836 xpvnv->xpv_pv = (char*)(xpvnv + 1);
842 /* grab a new struct xpvcv from the free list, allocating more if necessary */
851 xpvcv = PL_xpvcv_root;
852 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
857 /* return a struct xpvcv to the free list */
860 S_del_xpvcv(pTHX_ XPVCV *p)
863 p->xpv_pv = (char*)PL_xpvcv_root;
868 /* allocate another arena's worth of struct xpvcv */
873 register XPVCV* xpvcv;
874 register XPVCV* xpvcvend;
875 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
876 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
877 PL_xpvcv_arenaroot = xpvcv;
879 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
880 PL_xpvcv_root = ++xpvcv;
881 while (xpvcv < xpvcvend) {
882 xpvcv->xpv_pv = (char*)(xpvcv + 1);
888 /* grab a new struct xpvav from the free list, allocating more if necessary */
897 xpvav = PL_xpvav_root;
898 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
903 /* return a struct xpvav to the free list */
906 S_del_xpvav(pTHX_ XPVAV *p)
909 p->xav_array = (char*)PL_xpvav_root;
914 /* allocate another arena's worth of struct xpvav */
919 register XPVAV* xpvav;
920 register XPVAV* xpvavend;
921 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
922 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
923 PL_xpvav_arenaroot = xpvav;
925 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
926 PL_xpvav_root = ++xpvav;
927 while (xpvav < xpvavend) {
928 xpvav->xav_array = (char*)(xpvav + 1);
931 xpvav->xav_array = 0;
934 /* grab a new struct xpvhv from the free list, allocating more if necessary */
943 xpvhv = PL_xpvhv_root;
944 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
949 /* return a struct xpvhv to the free list */
952 S_del_xpvhv(pTHX_ XPVHV *p)
955 p->xhv_array = (char*)PL_xpvhv_root;
960 /* allocate another arena's worth of struct xpvhv */
965 register XPVHV* xpvhv;
966 register XPVHV* xpvhvend;
967 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
968 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
969 PL_xpvhv_arenaroot = xpvhv;
971 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
972 PL_xpvhv_root = ++xpvhv;
973 while (xpvhv < xpvhvend) {
974 xpvhv->xhv_array = (char*)(xpvhv + 1);
977 xpvhv->xhv_array = 0;
980 /* grab a new struct xpvmg from the free list, allocating more if necessary */
989 xpvmg = PL_xpvmg_root;
990 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
995 /* return a struct xpvmg to the free list */
998 S_del_xpvmg(pTHX_ XPVMG *p)
1001 p->xpv_pv = (char*)PL_xpvmg_root;
1006 /* allocate another arena's worth of struct xpvmg */
1011 register XPVMG* xpvmg;
1012 register XPVMG* xpvmgend;
1013 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1014 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1015 PL_xpvmg_arenaroot = xpvmg;
1017 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1018 PL_xpvmg_root = ++xpvmg;
1019 while (xpvmg < xpvmgend) {
1020 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1026 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1035 xpvlv = PL_xpvlv_root;
1036 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1041 /* return a struct xpvlv to the free list */
1044 S_del_xpvlv(pTHX_ XPVLV *p)
1047 p->xpv_pv = (char*)PL_xpvlv_root;
1052 /* allocate another arena's worth of struct xpvlv */
1057 register XPVLV* xpvlv;
1058 register XPVLV* xpvlvend;
1059 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1060 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1061 PL_xpvlv_arenaroot = xpvlv;
1063 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1064 PL_xpvlv_root = ++xpvlv;
1065 while (xpvlv < xpvlvend) {
1066 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1072 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1081 xpvbm = PL_xpvbm_root;
1082 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1087 /* return a struct xpvbm to the free list */
1090 S_del_xpvbm(pTHX_ XPVBM *p)
1093 p->xpv_pv = (char*)PL_xpvbm_root;
1098 /* allocate another arena's worth of struct xpvbm */
1103 register XPVBM* xpvbm;
1104 register XPVBM* xpvbmend;
1105 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1106 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1107 PL_xpvbm_arenaroot = xpvbm;
1109 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1110 PL_xpvbm_root = ++xpvbm;
1111 while (xpvbm < xpvbmend) {
1112 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1119 # define my_safemalloc(s) (void*)safexmalloc(717,s)
1120 # define my_safefree(p) safexfree((char*)p)
1122 # define my_safemalloc(s) (void*)safemalloc(s)
1123 # define my_safefree(p) safefree((char*)p)
1128 #define new_XIV() my_safemalloc(sizeof(XPVIV))
1129 #define del_XIV(p) my_safefree(p)
1131 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1132 #define del_XNV(p) my_safefree(p)
1134 #define new_XRV() my_safemalloc(sizeof(XRV))
1135 #define del_XRV(p) my_safefree(p)
1137 #define new_XPV() my_safemalloc(sizeof(XPV))
1138 #define del_XPV(p) my_safefree(p)
1140 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1141 #define del_XPVIV(p) my_safefree(p)
1143 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1144 #define del_XPVNV(p) my_safefree(p)
1146 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1147 #define del_XPVCV(p) my_safefree(p)
1149 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1150 #define del_XPVAV(p) my_safefree(p)
1152 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1153 #define del_XPVHV(p) my_safefree(p)
1155 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1156 #define del_XPVMG(p) my_safefree(p)
1158 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1159 #define del_XPVLV(p) my_safefree(p)
1161 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1162 #define del_XPVBM(p) my_safefree(p)
1166 #define new_XIV() (void*)new_xiv()
1167 #define del_XIV(p) del_xiv((XPVIV*) p)
1169 #define new_XNV() (void*)new_xnv()
1170 #define del_XNV(p) del_xnv((XPVNV*) p)
1172 #define new_XRV() (void*)new_xrv()
1173 #define del_XRV(p) del_xrv((XRV*) p)
1175 #define new_XPV() (void*)new_xpv()
1176 #define del_XPV(p) del_xpv((XPV *)p)
1178 #define new_XPVIV() (void*)new_xpviv()
1179 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1181 #define new_XPVNV() (void*)new_xpvnv()
1182 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1184 #define new_XPVCV() (void*)new_xpvcv()
1185 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1187 #define new_XPVAV() (void*)new_xpvav()
1188 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1190 #define new_XPVHV() (void*)new_xpvhv()
1191 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1193 #define new_XPVMG() (void*)new_xpvmg()
1194 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1196 #define new_XPVLV() (void*)new_xpvlv()
1197 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1199 #define new_XPVBM() (void*)new_xpvbm()
1200 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1204 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1205 #define del_XPVGV(p) my_safefree(p)
1207 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1208 #define del_XPVFM(p) my_safefree(p)
1210 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1211 #define del_XPVIO(p) my_safefree(p)
1214 =for apidoc sv_upgrade
1216 Upgrade an SV to a more complex form. Generally adds a new body type to the
1217 SV, then copies across as much information as possible from the old body.
1218 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1224 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1234 if (mt != SVt_PV && SvREADONLY(sv) && SvFAKE(sv)) {
1235 sv_force_normal(sv);
1238 if (SvTYPE(sv) == mt)
1242 (void)SvOOK_off(sv);
1244 switch (SvTYPE(sv)) {
1265 else if (mt < SVt_PVIV)
1282 pv = (char*)SvRV(sv);
1302 else if (mt == SVt_NV)
1313 del_XPVIV(SvANY(sv));
1323 del_XPVNV(SvANY(sv));
1331 magic = SvMAGIC(sv);
1332 stash = SvSTASH(sv);
1333 del_XPVMG(SvANY(sv));
1336 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1341 Perl_croak(aTHX_ "Can't upgrade to undef");
1343 SvANY(sv) = new_XIV();
1347 SvANY(sv) = new_XNV();
1351 SvANY(sv) = new_XRV();
1355 SvANY(sv) = new_XPV();
1361 SvANY(sv) = new_XPVIV();
1371 SvANY(sv) = new_XPVNV();
1379 SvANY(sv) = new_XPVMG();
1385 SvMAGIC(sv) = magic;
1386 SvSTASH(sv) = stash;
1389 SvANY(sv) = new_XPVLV();
1395 SvMAGIC(sv) = magic;
1396 SvSTASH(sv) = stash;
1403 SvANY(sv) = new_XPVAV();
1411 SvMAGIC(sv) = magic;
1412 SvSTASH(sv) = stash;
1418 SvANY(sv) = new_XPVHV();
1426 SvMAGIC(sv) = magic;
1427 SvSTASH(sv) = stash;
1434 SvANY(sv) = new_XPVCV();
1435 Zero(SvANY(sv), 1, XPVCV);
1441 SvMAGIC(sv) = magic;
1442 SvSTASH(sv) = stash;
1445 SvANY(sv) = new_XPVGV();
1451 SvMAGIC(sv) = magic;
1452 SvSTASH(sv) = stash;
1460 SvANY(sv) = new_XPVBM();
1466 SvMAGIC(sv) = magic;
1467 SvSTASH(sv) = stash;
1473 SvANY(sv) = new_XPVFM();
1474 Zero(SvANY(sv), 1, XPVFM);
1480 SvMAGIC(sv) = magic;
1481 SvSTASH(sv) = stash;
1484 SvANY(sv) = new_XPVIO();
1485 Zero(SvANY(sv), 1, XPVIO);
1491 SvMAGIC(sv) = magic;
1492 SvSTASH(sv) = stash;
1493 IoPAGE_LEN(sv) = 60;
1496 SvFLAGS(sv) &= ~SVTYPEMASK;
1502 =for apidoc sv_backoff
1504 Remove any string offset. You should normally use the C<SvOOK_off> macro
1511 Perl_sv_backoff(pTHX_ register SV *sv)
1515 char *s = SvPVX(sv);
1516 SvLEN(sv) += SvIVX(sv);
1517 SvPVX(sv) -= SvIVX(sv);
1519 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1521 SvFLAGS(sv) &= ~SVf_OOK;
1528 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1529 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1530 Use the C<SvGROW> wrapper instead.
1536 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1540 #ifdef HAS_64K_LIMIT
1541 if (newlen >= 0x10000) {
1542 PerlIO_printf(Perl_debug_log,
1543 "Allocation too large: %"UVxf"\n", (UV)newlen);
1546 #endif /* HAS_64K_LIMIT */
1549 if (SvTYPE(sv) < SVt_PV) {
1550 sv_upgrade(sv, SVt_PV);
1553 else if (SvOOK(sv)) { /* pv is offset? */
1556 if (newlen > SvLEN(sv))
1557 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1558 #ifdef HAS_64K_LIMIT
1559 if (newlen >= 0x10000)
1565 if (newlen > SvLEN(sv)) { /* need more room? */
1566 if (SvLEN(sv) && s) {
1567 #if defined(MYMALLOC) && !defined(LEAKTEST)
1568 STRLEN l = malloced_size((void*)SvPVX(sv));
1574 Renew(s,newlen,char);
1577 /* sv_force_normal_flags() must not try to unshare the new
1578 PVX we allocate below. AMS 20010713 */
1579 if (SvREADONLY(sv) && SvFAKE(sv)) {
1583 New(703, s, newlen, char);
1586 SvLEN_set(sv, newlen);
1592 =for apidoc sv_setiv
1594 Copies an integer into the given SV, upgrading first if necessary.
1595 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1601 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1603 SV_CHECK_THINKFIRST(sv);
1604 switch (SvTYPE(sv)) {
1606 sv_upgrade(sv, SVt_IV);
1609 sv_upgrade(sv, SVt_PVNV);
1613 sv_upgrade(sv, SVt_PVIV);
1622 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1625 (void)SvIOK_only(sv); /* validate number */
1631 =for apidoc sv_setiv_mg
1633 Like C<sv_setiv>, but also handles 'set' magic.
1639 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1646 =for apidoc sv_setuv
1648 Copies an unsigned integer into the given SV, upgrading first if necessary.
1649 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1655 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1657 /* With these two if statements:
1658 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1661 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1663 If you wish to remove them, please benchmark to see what the effect is
1665 if (u <= (UV)IV_MAX) {
1666 sv_setiv(sv, (IV)u);
1675 =for apidoc sv_setuv_mg
1677 Like C<sv_setuv>, but also handles 'set' magic.
1683 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1685 /* With these two if statements:
1686 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1689 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1691 If you wish to remove them, please benchmark to see what the effect is
1693 if (u <= (UV)IV_MAX) {
1694 sv_setiv(sv, (IV)u);
1704 =for apidoc sv_setnv
1706 Copies a double into the given SV, upgrading first if necessary.
1707 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1713 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1715 SV_CHECK_THINKFIRST(sv);
1716 switch (SvTYPE(sv)) {
1719 sv_upgrade(sv, SVt_NV);
1724 sv_upgrade(sv, SVt_PVNV);
1733 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1737 (void)SvNOK_only(sv); /* validate number */
1742 =for apidoc sv_setnv_mg
1744 Like C<sv_setnv>, but also handles 'set' magic.
1750 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1756 /* Print an "isn't numeric" warning, using a cleaned-up,
1757 * printable version of the offending string
1761 S_not_a_number(pTHX_ SV *sv)
1768 dsv = sv_2mortal(newSVpv("", 0));
1769 pv = sv_uni_display(dsv, sv, 10, 0);
1772 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1773 /* each *s can expand to 4 chars + "...\0",
1774 i.e. need room for 8 chars */
1777 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
1779 if (ch & 128 && !isPRINT_LC(ch)) {
1788 else if (ch == '\r') {
1792 else if (ch == '\f') {
1796 else if (ch == '\\') {
1800 else if (ch == '\0') {
1804 else if (isPRINT_LC(ch))
1821 Perl_warner(aTHX_ WARN_NUMERIC,
1822 "Argument \"%s\" isn't numeric in %s", pv,
1825 Perl_warner(aTHX_ WARN_NUMERIC,
1826 "Argument \"%s\" isn't numeric", pv);
1830 =for apidoc looks_like_number
1832 Test if the content of an SV looks like a number (or is a number).
1833 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1834 non-numeric warning), even if your atof() doesn't grok them.
1840 Perl_looks_like_number(pTHX_ SV *sv)
1842 register char *sbegin;
1849 else if (SvPOKp(sv))
1850 sbegin = SvPV(sv, len);
1852 return 1; /* Historic. Wrong? */
1853 return grok_number(sbegin, len, NULL);
1856 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1857 until proven guilty, assume that things are not that bad... */
1862 As 64 bit platforms often have an NV that doesn't preserve all bits of
1863 an IV (an assumption perl has been based on to date) it becomes necessary
1864 to remove the assumption that the NV always carries enough precision to
1865 recreate the IV whenever needed, and that the NV is the canonical form.
1866 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1867 precision as a side effect of conversion (which would lead to insanity
1868 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1869 1) to distinguish between IV/UV/NV slots that have cached a valid
1870 conversion where precision was lost and IV/UV/NV slots that have a
1871 valid conversion which has lost no precision
1872 2) to ensure that if a numeric conversion to one form is requested that
1873 would lose precision, the precise conversion (or differently
1874 imprecise conversion) is also performed and cached, to prevent
1875 requests for different numeric formats on the same SV causing
1876 lossy conversion chains. (lossless conversion chains are perfectly
1881 SvIOKp is true if the IV slot contains a valid value
1882 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1883 SvNOKp is true if the NV slot contains a valid value
1884 SvNOK is true only if the NV value is accurate
1887 while converting from PV to NV, check to see if converting that NV to an
1888 IV(or UV) would lose accuracy over a direct conversion from PV to
1889 IV(or UV). If it would, cache both conversions, return NV, but mark
1890 SV as IOK NOKp (ie not NOK).
1892 While converting from PV to IV, check to see if converting that IV to an
1893 NV would lose accuracy over a direct conversion from PV to NV. If it
1894 would, cache both conversions, flag similarly.
1896 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1897 correctly because if IV & NV were set NV *always* overruled.
1898 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1899 changes - now IV and NV together means that the two are interchangeable:
1900 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1902 The benefit of this is that operations such as pp_add know that if
1903 SvIOK is true for both left and right operands, then integer addition
1904 can be used instead of floating point (for cases where the result won't
1905 overflow). Before, floating point was always used, which could lead to
1906 loss of precision compared with integer addition.
1908 * making IV and NV equal status should make maths accurate on 64 bit
1910 * may speed up maths somewhat if pp_add and friends start to use
1911 integers when possible instead of fp. (Hopefully the overhead in
1912 looking for SvIOK and checking for overflow will not outweigh the
1913 fp to integer speedup)
1914 * will slow down integer operations (callers of SvIV) on "inaccurate"
1915 values, as the change from SvIOK to SvIOKp will cause a call into
1916 sv_2iv each time rather than a macro access direct to the IV slot
1917 * should speed up number->string conversion on integers as IV is
1918 favoured when IV and NV are equally accurate
1920 ####################################################################
1921 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1922 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1923 On the other hand, SvUOK is true iff UV.
1924 ####################################################################
1926 Your mileage will vary depending your CPU's relative fp to integer
1930 #ifndef NV_PRESERVES_UV
1931 # define IS_NUMBER_UNDERFLOW_IV 1
1932 # define IS_NUMBER_UNDERFLOW_UV 2
1933 # define IS_NUMBER_IV_AND_UV 2
1934 # define IS_NUMBER_OVERFLOW_IV 4
1935 # define IS_NUMBER_OVERFLOW_UV 5
1937 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1939 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1941 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1943 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%g inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1944 if (SvNVX(sv) < (NV)IV_MIN) {
1945 (void)SvIOKp_on(sv);
1948 return IS_NUMBER_UNDERFLOW_IV;
1950 if (SvNVX(sv) > (NV)UV_MAX) {
1951 (void)SvIOKp_on(sv);
1955 return IS_NUMBER_OVERFLOW_UV;
1957 (void)SvIOKp_on(sv);
1959 /* Can't use strtol etc to convert this string. (See truth table in
1961 if (SvNVX(sv) <= (UV)IV_MAX) {
1962 SvIVX(sv) = I_V(SvNVX(sv));
1963 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1964 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1966 /* Integer is imprecise. NOK, IOKp */
1968 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1971 SvUVX(sv) = U_V(SvNVX(sv));
1972 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1973 if (SvUVX(sv) == UV_MAX) {
1974 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1975 possibly be preserved by NV. Hence, it must be overflow.
1977 return IS_NUMBER_OVERFLOW_UV;
1979 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1981 /* Integer is imprecise. NOK, IOKp */
1983 return IS_NUMBER_OVERFLOW_IV;
1985 #endif /* !NV_PRESERVES_UV*/
1990 Return the integer value of an SV, doing any necessary string conversion,
1991 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1997 Perl_sv_2iv(pTHX_ register SV *sv)
2001 if (SvGMAGICAL(sv)) {
2006 return I_V(SvNVX(sv));
2008 if (SvPOKp(sv) && SvLEN(sv))
2011 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2012 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2018 if (SvTHINKFIRST(sv)) {
2021 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2022 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2023 return SvIV(tmpstr);
2024 return PTR2IV(SvRV(sv));
2026 if (SvREADONLY(sv) && SvFAKE(sv)) {
2027 sv_force_normal(sv);
2029 if (SvREADONLY(sv) && !SvOK(sv)) {
2030 if (ckWARN(WARN_UNINITIALIZED))
2037 return (IV)(SvUVX(sv));
2044 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2045 * without also getting a cached IV/UV from it at the same time
2046 * (ie PV->NV conversion should detect loss of accuracy and cache
2047 * IV or UV at same time to avoid this. NWC */
2049 if (SvTYPE(sv) == SVt_NV)
2050 sv_upgrade(sv, SVt_PVNV);
2052 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2053 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2054 certainly cast into the IV range at IV_MAX, whereas the correct
2055 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2057 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2058 SvIVX(sv) = I_V(SvNVX(sv));
2059 if (SvNVX(sv) == (NV) SvIVX(sv)
2060 #ifndef NV_PRESERVES_UV
2061 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2062 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2063 /* Don't flag it as "accurately an integer" if the number
2064 came from a (by definition imprecise) NV operation, and
2065 we're outside the range of NV integer precision */
2068 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2069 DEBUG_c(PerlIO_printf(Perl_debug_log,
2070 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2076 /* IV not precise. No need to convert from PV, as NV
2077 conversion would already have cached IV if it detected
2078 that PV->IV would be better than PV->NV->IV
2079 flags already correct - don't set public IOK. */
2080 DEBUG_c(PerlIO_printf(Perl_debug_log,
2081 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2086 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2087 but the cast (NV)IV_MIN rounds to a the value less (more
2088 negative) than IV_MIN which happens to be equal to SvNVX ??
2089 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2090 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2091 (NV)UVX == NVX are both true, but the values differ. :-(
2092 Hopefully for 2s complement IV_MIN is something like
2093 0x8000000000000000 which will be exact. NWC */
2096 SvUVX(sv) = U_V(SvNVX(sv));
2098 (SvNVX(sv) == (NV) SvUVX(sv))
2099 #ifndef NV_PRESERVES_UV
2100 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2101 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2102 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2103 /* Don't flag it as "accurately an integer" if the number
2104 came from a (by definition imprecise) NV operation, and
2105 we're outside the range of NV integer precision */
2111 DEBUG_c(PerlIO_printf(Perl_debug_log,
2112 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2116 return (IV)SvUVX(sv);
2119 else if (SvPOKp(sv) && SvLEN(sv)) {
2121 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2122 /* We want to avoid a possible problem when we cache an IV which
2123 may be later translated to an NV, and the resulting NV is not
2124 the same as the direct translation of the initial string
2125 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2126 be careful to ensure that the value with the .456 is around if the
2127 NV value is requested in the future).
2129 This means that if we cache such an IV, we need to cache the
2130 NV as well. Moreover, we trade speed for space, and do not
2131 cache the NV if we are sure it's not needed.
2134 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2135 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2136 == IS_NUMBER_IN_UV) {
2137 /* It's definitely an integer, only upgrade to PVIV */
2138 if (SvTYPE(sv) < SVt_PVIV)
2139 sv_upgrade(sv, SVt_PVIV);
2141 } else if (SvTYPE(sv) < SVt_PVNV)
2142 sv_upgrade(sv, SVt_PVNV);
2144 /* If NV preserves UV then we only use the UV value if we know that
2145 we aren't going to call atof() below. If NVs don't preserve UVs
2146 then the value returned may have more precision than atof() will
2147 return, even though value isn't perfectly accurate. */
2148 if ((numtype & (IS_NUMBER_IN_UV
2149 #ifdef NV_PRESERVES_UV
2152 )) == IS_NUMBER_IN_UV) {
2153 /* This won't turn off the public IOK flag if it was set above */
2154 (void)SvIOKp_on(sv);
2156 if (!(numtype & IS_NUMBER_NEG)) {
2158 if (value <= (UV)IV_MAX) {
2159 SvIVX(sv) = (IV)value;
2165 /* 2s complement assumption */
2166 if (value <= (UV)IV_MIN) {
2167 SvIVX(sv) = -(IV)value;
2169 /* Too negative for an IV. This is a double upgrade, but
2170 I'm assuming it will be rare. */
2171 if (SvTYPE(sv) < SVt_PVNV)
2172 sv_upgrade(sv, SVt_PVNV);
2176 SvNVX(sv) = -(NV)value;
2181 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2182 will be in the previous block to set the IV slot, and the next
2183 block to set the NV slot. So no else here. */
2185 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2186 != IS_NUMBER_IN_UV) {
2187 /* It wasn't an (integer that doesn't overflow the UV). */
2188 SvNVX(sv) = Atof(SvPVX(sv));
2190 if (! numtype && ckWARN(WARN_NUMERIC))
2193 #if defined(USE_LONG_DOUBLE)
2194 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2195 PTR2UV(sv), SvNVX(sv)));
2197 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%g)\n",
2198 PTR2UV(sv), SvNVX(sv)));
2202 #ifdef NV_PRESERVES_UV
2203 (void)SvIOKp_on(sv);
2205 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2206 SvIVX(sv) = I_V(SvNVX(sv));
2207 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2210 /* Integer is imprecise. NOK, IOKp */
2212 /* UV will not work better than IV */
2214 if (SvNVX(sv) > (NV)UV_MAX) {
2216 /* Integer is inaccurate. NOK, IOKp, is UV */
2220 SvUVX(sv) = U_V(SvNVX(sv));
2221 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2222 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2226 /* Integer is imprecise. NOK, IOKp, is UV */
2232 #else /* NV_PRESERVES_UV */
2233 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2234 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2235 /* The IV slot will have been set from value returned by
2236 grok_number above. The NV slot has just been set using
2239 assert (SvIOKp(sv));
2241 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2242 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2243 /* Small enough to preserve all bits. */
2244 (void)SvIOKp_on(sv);
2246 SvIVX(sv) = I_V(SvNVX(sv));
2247 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2249 /* Assumption: first non-preserved integer is < IV_MAX,
2250 this NV is in the preserved range, therefore: */
2251 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2253 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs(SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%g U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2257 0 0 already failed to read UV.
2258 0 1 already failed to read UV.
2259 1 0 you won't get here in this case. IV/UV
2260 slot set, public IOK, Atof() unneeded.
2261 1 1 already read UV.
2262 so there's no point in sv_2iuv_non_preserve() attempting
2263 to use atol, strtol, strtoul etc. */
2264 if (sv_2iuv_non_preserve (sv, numtype)
2265 >= IS_NUMBER_OVERFLOW_IV)
2269 #endif /* NV_PRESERVES_UV */
2272 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2274 if (SvTYPE(sv) < SVt_IV)
2275 /* Typically the caller expects that sv_any is not NULL now. */
2276 sv_upgrade(sv, SVt_IV);
2279 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2280 PTR2UV(sv),SvIVX(sv)));
2281 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2287 Return the unsigned integer value of an SV, doing any necessary string
2288 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
2295 Perl_sv_2uv(pTHX_ register SV *sv)
2299 if (SvGMAGICAL(sv)) {
2304 return U_V(SvNVX(sv));
2305 if (SvPOKp(sv) && SvLEN(sv))
2308 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2309 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2315 if (SvTHINKFIRST(sv)) {
2318 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2319 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2320 return SvUV(tmpstr);
2321 return PTR2UV(SvRV(sv));
2323 if (SvREADONLY(sv) && SvFAKE(sv)) {
2324 sv_force_normal(sv);
2326 if (SvREADONLY(sv) && !SvOK(sv)) {
2327 if (ckWARN(WARN_UNINITIALIZED))
2337 return (UV)SvIVX(sv);
2341 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2342 * without also getting a cached IV/UV from it at the same time
2343 * (ie PV->NV conversion should detect loss of accuracy and cache
2344 * IV or UV at same time to avoid this. */
2345 /* IV-over-UV optimisation - choose to cache IV if possible */
2347 if (SvTYPE(sv) == SVt_NV)
2348 sv_upgrade(sv, SVt_PVNV);
2350 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2351 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2352 SvIVX(sv) = I_V(SvNVX(sv));
2353 if (SvNVX(sv) == (NV) SvIVX(sv)
2354 #ifndef NV_PRESERVES_UV
2355 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2356 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2357 /* Don't flag it as "accurately an integer" if the number
2358 came from a (by definition imprecise) NV operation, and
2359 we're outside the range of NV integer precision */
2362 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2363 DEBUG_c(PerlIO_printf(Perl_debug_log,
2364 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2370 /* IV not precise. No need to convert from PV, as NV
2371 conversion would already have cached IV if it detected
2372 that PV->IV would be better than PV->NV->IV
2373 flags already correct - don't set public IOK. */
2374 DEBUG_c(PerlIO_printf(Perl_debug_log,
2375 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2380 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2381 but the cast (NV)IV_MIN rounds to a the value less (more
2382 negative) than IV_MIN which happens to be equal to SvNVX ??
2383 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2384 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2385 (NV)UVX == NVX are both true, but the values differ. :-(
2386 Hopefully for 2s complement IV_MIN is something like
2387 0x8000000000000000 which will be exact. NWC */
2390 SvUVX(sv) = U_V(SvNVX(sv));
2392 (SvNVX(sv) == (NV) SvUVX(sv))
2393 #ifndef NV_PRESERVES_UV
2394 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2395 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2396 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2397 /* Don't flag it as "accurately an integer" if the number
2398 came from a (by definition imprecise) NV operation, and
2399 we're outside the range of NV integer precision */
2404 DEBUG_c(PerlIO_printf(Perl_debug_log,
2405 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2411 else if (SvPOKp(sv) && SvLEN(sv)) {
2413 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2415 /* We want to avoid a possible problem when we cache a UV which
2416 may be later translated to an NV, and the resulting NV is not
2417 the translation of the initial data.
2419 This means that if we cache such a UV, we need to cache the
2420 NV as well. Moreover, we trade speed for space, and do not
2421 cache the NV if not needed.
2424 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2425 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2426 == IS_NUMBER_IN_UV) {
2427 /* It's definitely an integer, only upgrade to PVIV */
2428 if (SvTYPE(sv) < SVt_PVIV)
2429 sv_upgrade(sv, SVt_PVIV);
2431 } else if (SvTYPE(sv) < SVt_PVNV)
2432 sv_upgrade(sv, SVt_PVNV);
2434 /* If NV preserves UV then we only use the UV value if we know that
2435 we aren't going to call atof() below. If NVs don't preserve UVs
2436 then the value returned may have more precision than atof() will
2437 return, even though it isn't accurate. */
2438 if ((numtype & (IS_NUMBER_IN_UV
2439 #ifdef NV_PRESERVES_UV
2442 )) == IS_NUMBER_IN_UV) {
2443 /* This won't turn off the public IOK flag if it was set above */
2444 (void)SvIOKp_on(sv);
2446 if (!(numtype & IS_NUMBER_NEG)) {
2448 if (value <= (UV)IV_MAX) {
2449 SvIVX(sv) = (IV)value;
2451 /* it didn't overflow, and it was positive. */
2456 /* 2s complement assumption */
2457 if (value <= (UV)IV_MIN) {
2458 SvIVX(sv) = -(IV)value;
2460 /* Too negative for an IV. This is a double upgrade, but
2461 I'm assuming it will be rare. */
2462 if (SvTYPE(sv) < SVt_PVNV)
2463 sv_upgrade(sv, SVt_PVNV);
2467 SvNVX(sv) = -(NV)value;
2473 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2474 != IS_NUMBER_IN_UV) {
2475 /* It wasn't an integer, or it overflowed the UV. */
2476 SvNVX(sv) = Atof(SvPVX(sv));
2478 if (! numtype && ckWARN(WARN_NUMERIC))
2481 #if defined(USE_LONG_DOUBLE)
2482 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2483 PTR2UV(sv), SvNVX(sv)));
2485 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%g)\n",
2486 PTR2UV(sv), SvNVX(sv)));
2489 #ifdef NV_PRESERVES_UV
2490 (void)SvIOKp_on(sv);
2492 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2493 SvIVX(sv) = I_V(SvNVX(sv));
2494 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2497 /* Integer is imprecise. NOK, IOKp */
2499 /* UV will not work better than IV */
2501 if (SvNVX(sv) > (NV)UV_MAX) {
2503 /* Integer is inaccurate. NOK, IOKp, is UV */
2507 SvUVX(sv) = U_V(SvNVX(sv));
2508 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2509 NV preservse UV so can do correct comparison. */
2510 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2514 /* Integer is imprecise. NOK, IOKp, is UV */
2519 #else /* NV_PRESERVES_UV */
2520 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2521 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2522 /* The UV slot will have been set from value returned by
2523 grok_number above. The NV slot has just been set using
2526 assert (SvIOKp(sv));
2528 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2529 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2530 /* Small enough to preserve all bits. */
2531 (void)SvIOKp_on(sv);
2533 SvIVX(sv) = I_V(SvNVX(sv));
2534 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2536 /* Assumption: first non-preserved integer is < IV_MAX,
2537 this NV is in the preserved range, therefore: */
2538 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2540 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs(SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%g U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2543 sv_2iuv_non_preserve (sv, numtype);
2545 #endif /* NV_PRESERVES_UV */
2549 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2550 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2553 if (SvTYPE(sv) < SVt_IV)
2554 /* Typically the caller expects that sv_any is not NULL now. */
2555 sv_upgrade(sv, SVt_IV);
2559 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2560 PTR2UV(sv),SvUVX(sv)));
2561 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2567 Return the num value of an SV, doing any necessary string or integer
2568 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2575 Perl_sv_2nv(pTHX_ register SV *sv)
2579 if (SvGMAGICAL(sv)) {
2583 if (SvPOKp(sv) && SvLEN(sv)) {
2584 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2585 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
2587 return Atof(SvPVX(sv));
2591 return (NV)SvUVX(sv);
2593 return (NV)SvIVX(sv);
2596 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2597 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2603 if (SvTHINKFIRST(sv)) {
2606 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2607 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2608 return SvNV(tmpstr);
2609 return PTR2NV(SvRV(sv));
2611 if (SvREADONLY(sv) && SvFAKE(sv)) {
2612 sv_force_normal(sv);
2614 if (SvREADONLY(sv) && !SvOK(sv)) {
2615 if (ckWARN(WARN_UNINITIALIZED))
2620 if (SvTYPE(sv) < SVt_NV) {
2621 if (SvTYPE(sv) == SVt_IV)
2622 sv_upgrade(sv, SVt_PVNV);
2624 sv_upgrade(sv, SVt_NV);
2625 #ifdef USE_LONG_DOUBLE
2627 STORE_NUMERIC_LOCAL_SET_STANDARD();
2628 PerlIO_printf(Perl_debug_log,
2629 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2630 PTR2UV(sv), SvNVX(sv));
2631 RESTORE_NUMERIC_LOCAL();
2635 STORE_NUMERIC_LOCAL_SET_STANDARD();
2636 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%g)\n",
2637 PTR2UV(sv), SvNVX(sv));
2638 RESTORE_NUMERIC_LOCAL();
2642 else if (SvTYPE(sv) < SVt_PVNV)
2643 sv_upgrade(sv, SVt_PVNV);
2648 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
2649 #ifdef NV_PRESERVES_UV
2652 /* Only set the public NV OK flag if this NV preserves the IV */
2653 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2654 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2655 : (SvIVX(sv) == I_V(SvNVX(sv))))
2661 else if (SvPOKp(sv) && SvLEN(sv)) {
2663 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2664 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2666 #ifdef NV_PRESERVES_UV
2667 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2668 == IS_NUMBER_IN_UV) {
2669 /* It's definitely an integer */
2670 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
2672 SvNVX(sv) = Atof(SvPVX(sv));
2675 SvNVX(sv) = Atof(SvPVX(sv));
2676 /* Only set the public NV OK flag if this NV preserves the value in
2677 the PV at least as well as an IV/UV would.
2678 Not sure how to do this 100% reliably. */
2679 /* if that shift count is out of range then Configure's test is
2680 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2682 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2683 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2684 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2685 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2686 /* Can't use strtol etc to convert this string, so don't try.
2687 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2690 /* value has been set. It may not be precise. */
2691 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2692 /* 2s complement assumption for (UV)IV_MIN */
2693 SvNOK_on(sv); /* Integer is too negative. */
2698 if (numtype & IS_NUMBER_NEG) {
2699 SvIVX(sv) = -(IV)value;
2700 } else if (value <= (UV)IV_MAX) {
2701 SvIVX(sv) = (IV)value;
2707 if (numtype & IS_NUMBER_NOT_INT) {
2708 /* I believe that even if the original PV had decimals,
2709 they are lost beyond the limit of the FP precision.
2710 However, neither is canonical, so both only get p
2711 flags. NWC, 2000/11/25 */
2712 /* Both already have p flags, so do nothing */
2715 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2716 if (SvIVX(sv) == I_V(nv)) {
2721 /* It had no "." so it must be integer. */
2724 /* between IV_MAX and NV(UV_MAX).
2725 Could be slightly > UV_MAX */
2727 if (numtype & IS_NUMBER_NOT_INT) {
2728 /* UV and NV both imprecise. */
2730 UV nv_as_uv = U_V(nv);
2732 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2743 #endif /* NV_PRESERVES_UV */
2746 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2748 if (SvTYPE(sv) < SVt_NV)
2749 /* Typically the caller expects that sv_any is not NULL now. */
2750 /* XXX Ilya implies that this is a bug in callers that assume this
2751 and ideally should be fixed. */
2752 sv_upgrade(sv, SVt_NV);
2755 #if defined(USE_LONG_DOUBLE)
2757 STORE_NUMERIC_LOCAL_SET_STANDARD();
2758 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2759 PTR2UV(sv), SvNVX(sv));
2760 RESTORE_NUMERIC_LOCAL();
2764 STORE_NUMERIC_LOCAL_SET_STANDARD();
2765 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%g)\n",
2766 PTR2UV(sv), SvNVX(sv));
2767 RESTORE_NUMERIC_LOCAL();
2773 /* asIV(): extract an integer from the string value of an SV.
2774 * Caller must validate PVX */
2777 S_asIV(pTHX_ SV *sv)
2780 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2782 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2783 == IS_NUMBER_IN_UV) {
2784 /* It's definitely an integer */
2785 if (numtype & IS_NUMBER_NEG) {
2786 if (value < (UV)IV_MIN)
2789 if (value < (UV)IV_MAX)
2794 if (ckWARN(WARN_NUMERIC))
2797 return I_V(Atof(SvPVX(sv)));
2800 /* asUV(): extract an unsigned integer from the string value of an SV
2801 * Caller must validate PVX */
2804 S_asUV(pTHX_ SV *sv)
2807 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2809 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2810 == IS_NUMBER_IN_UV) {
2811 /* It's definitely an integer */
2812 if (!(numtype & IS_NUMBER_NEG))
2816 if (ckWARN(WARN_NUMERIC))
2819 return U_V(Atof(SvPVX(sv)));
2823 =for apidoc sv_2pv_nolen
2825 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2826 use the macro wrapper C<SvPV_nolen(sv)> instead.
2831 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2834 return sv_2pv(sv, &n_a);
2837 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2838 * UV as a string towards the end of buf, and return pointers to start and
2841 * We assume that buf is at least TYPE_CHARS(UV) long.
2845 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2847 char *ptr = buf + TYPE_CHARS(UV);
2861 *--ptr = '0' + (uv % 10);
2869 /* For backwards-compatibility only. sv_2pv() is normally #def'ed to
2870 * C<sv_2pv_macro()>. See also C<sv_2pv_flags()>.
2874 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2876 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2880 =for apidoc sv_2pv_flags
2882 Returns a pointer to the string value of an SV, and sets *lp to its length.
2883 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2885 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2886 usually end up here too.
2892 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2897 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2898 char *tmpbuf = tbuf;
2904 if (SvGMAGICAL(sv)) {
2905 if (flags & SV_GMAGIC)
2913 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2915 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2920 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2925 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2926 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2933 if (SvTHINKFIRST(sv)) {
2936 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2937 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2938 return SvPV(tmpstr,*lp);
2945 switch (SvTYPE(sv)) {
2947 if ( ((SvFLAGS(sv) &
2948 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2949 == (SVs_OBJECT|SVs_RMG))
2950 && strEQ(s=HvNAME(SvSTASH(sv)), "Regexp")
2951 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2952 regexp *re = (regexp *)mg->mg_obj;
2955 char *fptr = "msix";
2960 U16 reganch = (re->reganch & PMf_COMPILETIME) >> 12;
2962 while((ch = *fptr++)) {
2964 reflags[left++] = ch;
2967 reflags[right--] = ch;
2972 reflags[left] = '-';
2976 mg->mg_len = re->prelen + 4 + left;
2977 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
2978 Copy("(?", mg->mg_ptr, 2, char);
2979 Copy(reflags, mg->mg_ptr+2, left, char);
2980 Copy(":", mg->mg_ptr+left+2, 1, char);
2981 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2982 mg->mg_ptr[mg->mg_len - 1] = ')';
2983 mg->mg_ptr[mg->mg_len] = 0;
2985 PL_reginterp_cnt += re->program[0].next_off;
2997 case SVt_PVBM: if (SvROK(sv))
3000 s = "SCALAR"; break;
3001 case SVt_PVLV: s = "LVALUE"; break;
3002 case SVt_PVAV: s = "ARRAY"; break;
3003 case SVt_PVHV: s = "HASH"; break;
3004 case SVt_PVCV: s = "CODE"; break;
3005 case SVt_PVGV: s = "GLOB"; break;
3006 case SVt_PVFM: s = "FORMAT"; break;
3007 case SVt_PVIO: s = "IO"; break;
3008 default: s = "UNKNOWN"; break;
3012 HV *svs = SvSTASH(sv);
3015 /* [20011101.072] This bandaid for C<package;>
3016 should eventually be removed. AMS 20011103 */
3017 (svs ? HvNAME(svs) : "<none>"), s
3022 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3028 if (SvREADONLY(sv) && !SvOK(sv)) {
3029 if (ckWARN(WARN_UNINITIALIZED))
3035 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3036 /* I'm assuming that if both IV and NV are equally valid then
3037 converting the IV is going to be more efficient */
3038 U32 isIOK = SvIOK(sv);
3039 U32 isUIOK = SvIsUV(sv);
3040 char buf[TYPE_CHARS(UV)];
3043 if (SvTYPE(sv) < SVt_PVIV)
3044 sv_upgrade(sv, SVt_PVIV);
3046 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3048 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3049 SvGROW(sv, ebuf - ptr + 1); /* inlined from sv_setpvn */
3050 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3051 SvCUR_set(sv, ebuf - ptr);
3061 else if (SvNOKp(sv)) {
3062 if (SvTYPE(sv) < SVt_PVNV)
3063 sv_upgrade(sv, SVt_PVNV);
3064 /* The +20 is pure guesswork. Configure test needed. --jhi */
3065 SvGROW(sv, NV_DIG + 20);
3067 olderrno = errno; /* some Xenix systems wipe out errno here */
3069 if (SvNVX(sv) == 0.0)
3070 (void)strcpy(s,"0");
3074 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3077 #ifdef FIXNEGATIVEZERO
3078 if (*s == '-' && s[1] == '0' && !s[2])
3088 if (ckWARN(WARN_UNINITIALIZED)
3089 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3092 if (SvTYPE(sv) < SVt_PV)
3093 /* Typically the caller expects that sv_any is not NULL now. */
3094 sv_upgrade(sv, SVt_PV);
3097 *lp = s - SvPVX(sv);
3100 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3101 PTR2UV(sv),SvPVX(sv)));
3105 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3106 /* Sneaky stuff here */
3110 tsv = newSVpv(tmpbuf, 0);
3126 len = strlen(tmpbuf);
3128 #ifdef FIXNEGATIVEZERO
3129 if (len == 2 && t[0] == '-' && t[1] == '0') {
3134 (void)SvUPGRADE(sv, SVt_PV);
3136 s = SvGROW(sv, len + 1);
3145 =for apidoc sv_2pvbyte_nolen
3147 Return a pointer to the byte-encoded representation of the SV.
3148 May cause the SV to be downgraded from UTF8 as a side-effect.
3150 Usually accessed via the C<SvPVbyte_nolen> macro.
3156 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3159 return sv_2pvbyte(sv, &n_a);
3163 =for apidoc sv_2pvbyte
3165 Return a pointer to the byte-encoded representation of the SV, and set *lp
3166 to its length. May cause the SV to be downgraded from UTF8 as a
3169 Usually accessed via the C<SvPVbyte> macro.
3175 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3177 sv_utf8_downgrade(sv,0);
3178 return SvPV(sv,*lp);
3182 =for apidoc sv_2pvutf8_nolen
3184 Return a pointer to the UTF8-encoded representation of the SV.
3185 May cause the SV to be upgraded to UTF8 as a side-effect.
3187 Usually accessed via the C<SvPVutf8_nolen> macro.
3193 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3196 return sv_2pvutf8(sv, &n_a);
3200 =for apidoc sv_2pvutf8
3202 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3203 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3205 Usually accessed via the C<SvPVutf8> macro.
3211 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3213 sv_utf8_upgrade(sv);
3214 return SvPV(sv,*lp);
3218 =for apidoc sv_2bool
3220 This function is only called on magical items, and is only used by
3221 sv_true() or its macro equivalent.
3227 Perl_sv_2bool(pTHX_ register SV *sv)
3236 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3237 (SvTYPE(tmpsv) != SVt_RV || (SvRV(tmpsv) != SvRV(sv))))
3238 return SvTRUE(tmpsv);
3239 return SvRV(sv) != 0;
3242 register XPV* Xpvtmp;
3243 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3244 (*Xpvtmp->xpv_pv > '0' ||
3245 Xpvtmp->xpv_cur > 1 ||
3246 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3253 return SvIVX(sv) != 0;
3256 return SvNVX(sv) != 0.0;
3264 =for apidoc sv_utf8_upgrade
3266 Convert the PV of an SV to its UTF8-encoded form.
3267 Forces the SV to string form if it is not already.
3268 Always sets the SvUTF8 flag to avoid future validity checks even
3269 if all the bytes have hibit clear.
3275 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3277 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3281 =for apidoc sv_utf8_upgrade_flags
3283 Convert the PV of an SV to its UTF8-encoded form.
3284 Forces the SV to string form if it is not already.
3285 Always sets the SvUTF8 flag to avoid future validity checks even
3286 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3287 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3288 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3294 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3304 (void) sv_2pv_flags(sv,&len, flags);
3312 if (SvREADONLY(sv) && SvFAKE(sv)) {
3313 sv_force_normal(sv);
3317 Perl_sv_recode_to_utf8(aTHX_ sv, PL_encoding);
3318 else { /* Assume Latin-1/EBCDIC */
3319 /* This function could be much more efficient if we
3320 * had a FLAG in SVs to signal if there are any hibit
3321 * chars in the PV. Given that there isn't such a flag
3322 * make the loop as fast as possible. */
3323 s = (U8 *) SvPVX(sv);
3324 e = (U8 *) SvEND(sv);
3328 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3334 len = SvCUR(sv) + 1; /* Plus the \0 */
3335 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3336 SvCUR(sv) = len - 1;
3338 Safefree(s); /* No longer using what was there before. */
3339 SvLEN(sv) = len; /* No longer know the real size. */
3341 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3348 =for apidoc sv_utf8_downgrade
3350 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3351 This may not be possible if the PV contains non-byte encoding characters;
3352 if this is the case, either returns false or, if C<fail_ok> is not
3359 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3361 if (SvPOK(sv) && SvUTF8(sv)) {
3366 if (SvREADONLY(sv) && SvFAKE(sv))
3367 sv_force_normal(sv);
3368 s = (U8 *) SvPV(sv, len);
3369 if (!utf8_to_bytes(s, &len)) {
3372 #ifdef USE_BYTES_DOWNGRADES
3373 else if (IN_BYTES) {
3375 U8 *e = (U8 *) SvEND(sv);
3378 UV ch = utf8n_to_uvchr(s,(e-s),&len,0);
3379 if (first && ch > 255) {
3381 Perl_warner(aTHX_ WARN_UTF8, "Wide character in byte %s",
3384 Perl_warner(aTHX_ WARN_UTF8, "Wide character in byte");
3391 len = (d - (U8 *) SvPVX(sv));
3396 Perl_croak(aTHX_ "Wide character in %s",
3399 Perl_croak(aTHX_ "Wide character");
3410 =for apidoc sv_utf8_encode
3412 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3413 flag so that it looks like octets again. Used as a building block
3414 for encode_utf8 in Encode.xs
3420 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3422 (void) sv_utf8_upgrade(sv);
3427 =for apidoc sv_utf8_decode
3429 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3430 turn off SvUTF8 if needed so that we see characters. Used as a building block
3431 for decode_utf8 in Encode.xs
3437 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3443 /* The octets may have got themselves encoded - get them back as
3446 if (!sv_utf8_downgrade(sv, TRUE))
3449 /* it is actually just a matter of turning the utf8 flag on, but
3450 * we want to make sure everything inside is valid utf8 first.
3452 c = (U8 *) SvPVX(sv);
3453 if (!is_utf8_string(c, SvCUR(sv)+1))
3455 e = (U8 *) SvEND(sv);
3458 if (!UTF8_IS_INVARIANT(ch)) {
3468 =for apidoc sv_setsv
3470 Copies the contents of the source SV C<ssv> into the destination SV
3471 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3472 function if the source SV needs to be reused. Does not handle 'set' magic.
3473 Loosely speaking, it performs a copy-by-value, obliterating any previous
3474 content of the destination.
3476 You probably want to use one of the assortment of wrappers, such as
3477 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3478 C<SvSetMagicSV_nosteal>.
3484 /* sv_setsv() is aliased to Perl_sv_setsv_macro; this function provided
3485 for binary compatibility only
3488 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3490 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3494 =for apidoc sv_setsv_flags
3496 Copies the contents of the source SV C<ssv> into the destination SV
3497 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3498 function if the source SV needs to be reused. Does not handle 'set' magic.
3499 Loosely speaking, it performs a copy-by-value, obliterating any previous
3500 content of the destination.
3501 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3502 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3503 implemented in terms of this function.
3505 You probably want to use one of the assortment of wrappers, such as
3506 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3507 C<SvSetMagicSV_nosteal>.
3509 This is the primary function for copying scalars, and most other
3510 copy-ish functions and macros use this underneath.
3516 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3518 register U32 sflags;
3524 SV_CHECK_THINKFIRST(dstr);
3526 sstr = &PL_sv_undef;
3527 stype = SvTYPE(sstr);
3528 dtype = SvTYPE(dstr);
3532 /* There's a lot of redundancy below but we're going for speed here */
3537 if (dtype != SVt_PVGV) {
3538 (void)SvOK_off(dstr);
3546 sv_upgrade(dstr, SVt_IV);
3549 sv_upgrade(dstr, SVt_PVNV);
3553 sv_upgrade(dstr, SVt_PVIV);
3556 (void)SvIOK_only(dstr);
3557 SvIVX(dstr) = SvIVX(sstr);
3560 if (SvTAINTED(sstr))
3571 sv_upgrade(dstr, SVt_NV);
3576 sv_upgrade(dstr, SVt_PVNV);
3579 SvNVX(dstr) = SvNVX(sstr);
3580 (void)SvNOK_only(dstr);
3581 if (SvTAINTED(sstr))
3589 sv_upgrade(dstr, SVt_RV);
3590 else if (dtype == SVt_PVGV &&
3591 SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3594 if (GvIMPORTED(dstr) != GVf_IMPORTED
3595 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3597 GvIMPORTED_on(dstr);
3608 sv_upgrade(dstr, SVt_PV);
3611 if (dtype < SVt_PVIV)
3612 sv_upgrade(dstr, SVt_PVIV);
3615 if (dtype < SVt_PVNV)
3616 sv_upgrade(dstr, SVt_PVNV);
3623 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
3626 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
3630 if (dtype <= SVt_PVGV) {
3632 if (dtype != SVt_PVGV) {
3633 char *name = GvNAME(sstr);
3634 STRLEN len = GvNAMELEN(sstr);
3635 sv_upgrade(dstr, SVt_PVGV);
3636 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3637 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3638 GvNAME(dstr) = savepvn(name, len);
3639 GvNAMELEN(dstr) = len;
3640 SvFAKE_on(dstr); /* can coerce to non-glob */
3642 /* ahem, death to those who redefine active sort subs */
3643 else if (PL_curstackinfo->si_type == PERLSI_SORT
3644 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3645 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3648 #ifdef GV_UNIQUE_CHECK
3649 if (GvUNIQUE((GV*)dstr)) {
3650 Perl_croak(aTHX_ PL_no_modify);
3654 (void)SvOK_off(dstr);
3655 GvINTRO_off(dstr); /* one-shot flag */
3657 GvGP(dstr) = gp_ref(GvGP(sstr));
3658 if (SvTAINTED(sstr))
3660 if (GvIMPORTED(dstr) != GVf_IMPORTED
3661 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3663 GvIMPORTED_on(dstr);
3671 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3673 if (SvTYPE(sstr) != stype) {
3674 stype = SvTYPE(sstr);
3675 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3679 if (stype == SVt_PVLV)
3680 (void)SvUPGRADE(dstr, SVt_PVNV);
3682 (void)SvUPGRADE(dstr, stype);
3685 sflags = SvFLAGS(sstr);
3687 if (sflags & SVf_ROK) {
3688 if (dtype >= SVt_PV) {
3689 if (dtype == SVt_PVGV) {
3690 SV *sref = SvREFCNT_inc(SvRV(sstr));
3692 int intro = GvINTRO(dstr);
3694 #ifdef GV_UNIQUE_CHECK
3695 if (GvUNIQUE((GV*)dstr)) {
3696 Perl_croak(aTHX_ PL_no_modify);
3701 GvINTRO_off(dstr); /* one-shot flag */
3702 GvLINE(dstr) = CopLINE(PL_curcop);
3703 GvEGV(dstr) = (GV*)dstr;
3706 switch (SvTYPE(sref)) {
3709 SAVESPTR(GvAV(dstr));
3711 dref = (SV*)GvAV(dstr);
3712 GvAV(dstr) = (AV*)sref;
3713 if (!GvIMPORTED_AV(dstr)
3714 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3716 GvIMPORTED_AV_on(dstr);
3721 SAVESPTR(GvHV(dstr));
3723 dref = (SV*)GvHV(dstr);
3724 GvHV(dstr) = (HV*)sref;
3725 if (!GvIMPORTED_HV(dstr)
3726 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3728 GvIMPORTED_HV_on(dstr);
3733 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3734 SvREFCNT_dec(GvCV(dstr));
3735 GvCV(dstr) = Nullcv;
3736 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3737 PL_sub_generation++;
3739 SAVESPTR(GvCV(dstr));
3742 dref = (SV*)GvCV(dstr);
3743 if (GvCV(dstr) != (CV*)sref) {
3744 CV* cv = GvCV(dstr);
3746 if (!GvCVGEN((GV*)dstr) &&
3747 (CvROOT(cv) || CvXSUB(cv)))
3749 /* ahem, death to those who redefine
3750 * active sort subs */
3751 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3752 PL_sortcop == CvSTART(cv))
3754 "Can't redefine active sort subroutine %s",
3755 GvENAME((GV*)dstr));
3756 /* Redefining a sub - warning is mandatory if
3757 it was a const and its value changed. */
3758 if (ckWARN(WARN_REDEFINE)
3760 && (!CvCONST((CV*)sref)
3761 || sv_cmp(cv_const_sv(cv),
3762 cv_const_sv((CV*)sref)))))
3764 Perl_warner(aTHX_ WARN_REDEFINE,
3766 ? "Constant subroutine %s redefined"
3767 : "Subroutine %s redefined",
3768 GvENAME((GV*)dstr));
3771 cv_ckproto(cv, (GV*)dstr,
3772 SvPOK(sref) ? SvPVX(sref) : Nullch);
3774 GvCV(dstr) = (CV*)sref;
3775 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3776 GvASSUMECV_on(dstr);
3777 PL_sub_generation++;
3779 if (!GvIMPORTED_CV(dstr)
3780 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3782 GvIMPORTED_CV_on(dstr);
3787 SAVESPTR(GvIOp(dstr));
3789 dref = (SV*)GvIOp(dstr);
3790 GvIOp(dstr) = (IO*)sref;
3794 SAVESPTR(GvFORM(dstr));
3796 dref = (SV*)GvFORM(dstr);
3797 GvFORM(dstr) = (CV*)sref;
3801 SAVESPTR(GvSV(dstr));
3803 dref = (SV*)GvSV(dstr);
3805 if (!GvIMPORTED_SV(dstr)
3806 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3808 GvIMPORTED_SV_on(dstr);
3816 if (SvTAINTED(sstr))
3821 (void)SvOOK_off(dstr); /* backoff */
3823 Safefree(SvPVX(dstr));
3824 SvLEN(dstr)=SvCUR(dstr)=0;
3827 (void)SvOK_off(dstr);
3828 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
3830 if (sflags & SVp_NOK) {
3832 /* Only set the public OK flag if the source has public OK. */
3833 if (sflags & SVf_NOK)
3834 SvFLAGS(dstr) |= SVf_NOK;
3835 SvNVX(dstr) = SvNVX(sstr);
3837 if (sflags & SVp_IOK) {
3838 (void)SvIOKp_on(dstr);
3839 if (sflags & SVf_IOK)
3840 SvFLAGS(dstr) |= SVf_IOK;
3841 if (sflags & SVf_IVisUV)
3843 SvIVX(dstr) = SvIVX(sstr);
3845 if (SvAMAGIC(sstr)) {
3849 else if (sflags & SVp_POK) {
3852 * Check to see if we can just swipe the string. If so, it's a
3853 * possible small lose on short strings, but a big win on long ones.
3854 * It might even be a win on short strings if SvPVX(dstr)
3855 * has to be allocated and SvPVX(sstr) has to be freed.
3858 if (SvTEMP(sstr) && /* slated for free anyway? */
3859 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3860 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3861 SvLEN(sstr) && /* and really is a string */
3862 /* and won't be needed again, potentially */
3863 !(PL_op && PL_op->op_type == OP_AASSIGN))
3865 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
3867 SvFLAGS(dstr) &= ~SVf_OOK;
3868 Safefree(SvPVX(dstr) - SvIVX(dstr));
3870 else if (SvLEN(dstr))
3871 Safefree(SvPVX(dstr));
3873 (void)SvPOK_only(dstr);
3874 SvPV_set(dstr, SvPVX(sstr));
3875 SvLEN_set(dstr, SvLEN(sstr));
3876 SvCUR_set(dstr, SvCUR(sstr));
3879 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3880 SvPV_set(sstr, Nullch);
3885 else { /* have to copy actual string */
3886 STRLEN len = SvCUR(sstr);
3888 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3889 Move(SvPVX(sstr),SvPVX(dstr),len,char);
3890 SvCUR_set(dstr, len);
3891 *SvEND(dstr) = '\0';
3892 (void)SvPOK_only(dstr);
3894 if (sflags & SVf_UTF8)
3897 if (sflags & SVp_NOK) {
3899 if (sflags & SVf_NOK)
3900 SvFLAGS(dstr) |= SVf_NOK;
3901 SvNVX(dstr) = SvNVX(sstr);
3903 if (sflags & SVp_IOK) {
3904 (void)SvIOKp_on(dstr);
3905 if (sflags & SVf_IOK)
3906 SvFLAGS(dstr) |= SVf_IOK;
3907 if (sflags & SVf_IVisUV)
3909 SvIVX(dstr) = SvIVX(sstr);
3912 else if (sflags & SVp_IOK) {
3913 if (sflags & SVf_IOK)
3914 (void)SvIOK_only(dstr);
3916 (void)SvOK_off(dstr);
3917 (void)SvIOKp_on(dstr);
3919 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3920 if (sflags & SVf_IVisUV)
3922 SvIVX(dstr) = SvIVX(sstr);
3923 if (sflags & SVp_NOK) {
3924 if (sflags & SVf_NOK)
3925 (void)SvNOK_on(dstr);
3927 (void)SvNOKp_on(dstr);
3928 SvNVX(dstr) = SvNVX(sstr);
3931 else if (sflags & SVp_NOK) {
3932 if (sflags & SVf_NOK)
3933 (void)SvNOK_only(dstr);
3935 (void)SvOK_off(dstr);
3938 SvNVX(dstr) = SvNVX(sstr);
3941 if (dtype == SVt_PVGV) {
3942 if (ckWARN(WARN_MISC))
3943 Perl_warner(aTHX_ WARN_MISC, "Undefined value assigned to typeglob");
3946 (void)SvOK_off(dstr);
3948 if (SvTAINTED(sstr))
3953 =for apidoc sv_setsv_mg
3955 Like C<sv_setsv>, but also handles 'set' magic.
3961 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3963 sv_setsv(dstr,sstr);
3968 =for apidoc sv_setpvn
3970 Copies a string into an SV. The C<len> parameter indicates the number of
3971 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3977 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3979 register char *dptr;
3981 SV_CHECK_THINKFIRST(sv);
3987 /* len is STRLEN which is unsigned, need to copy to signed */
3990 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3992 (void)SvUPGRADE(sv, SVt_PV);
3994 SvGROW(sv, len + 1);
3996 Move(ptr,dptr,len,char);
3999 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4004 =for apidoc sv_setpvn_mg
4006 Like C<sv_setpvn>, but also handles 'set' magic.
4012 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4014 sv_setpvn(sv,ptr,len);
4019 =for apidoc sv_setpv
4021 Copies a string into an SV. The string must be null-terminated. Does not
4022 handle 'set' magic. See C<sv_setpv_mg>.
4028 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4030 register STRLEN len;
4032 SV_CHECK_THINKFIRST(sv);
4038 (void)SvUPGRADE(sv, SVt_PV);
4040 SvGROW(sv, len + 1);
4041 Move(ptr,SvPVX(sv),len+1,char);
4043 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4048 =for apidoc sv_setpv_mg
4050 Like C<sv_setpv>, but also handles 'set' magic.
4056 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4063 =for apidoc sv_usepvn
4065 Tells an SV to use C<ptr> to find its string value. Normally the string is
4066 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4067 The C<ptr> should point to memory that was allocated by C<malloc>. The
4068 string length, C<len>, must be supplied. This function will realloc the
4069 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4070 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4071 See C<sv_usepvn_mg>.
4077 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4079 SV_CHECK_THINKFIRST(sv);
4080 (void)SvUPGRADE(sv, SVt_PV);
4085 (void)SvOOK_off(sv);
4086 if (SvPVX(sv) && SvLEN(sv))
4087 Safefree(SvPVX(sv));
4088 Renew(ptr, len+1, char);
4091 SvLEN_set(sv, len+1);
4093 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4098 =for apidoc sv_usepvn_mg
4100 Like C<sv_usepvn>, but also handles 'set' magic.
4106 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4108 sv_usepvn(sv,ptr,len);
4113 =for apidoc sv_force_normal_flags
4115 Undo various types of fakery on an SV: if the PV is a shared string, make
4116 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4117 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
4118 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
4124 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4126 if (SvREADONLY(sv)) {
4128 char *pvx = SvPVX(sv);
4129 STRLEN len = SvCUR(sv);
4130 U32 hash = SvUVX(sv);
4131 SvGROW(sv, len + 1);
4132 Move(pvx,SvPVX(sv),len,char);
4136 unsharepvn(pvx, SvUTF8(sv) ? -(I32)len : len, hash);
4138 else if (PL_curcop != &PL_compiling)
4139 Perl_croak(aTHX_ PL_no_modify);
4142 sv_unref_flags(sv, flags);
4143 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4148 =for apidoc sv_force_normal
4150 Undo various types of fakery on an SV: if the PV is a shared string, make
4151 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4152 an xpvmg. See also C<sv_force_normal_flags>.
4158 Perl_sv_force_normal(pTHX_ register SV *sv)
4160 sv_force_normal_flags(sv, 0);
4166 Efficient removal of characters from the beginning of the string buffer.
4167 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4168 the string buffer. The C<ptr> becomes the first character of the adjusted
4169 string. Uses the "OOK hack".
4175 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
4177 register STRLEN delta;
4179 if (!ptr || !SvPOKp(sv))
4181 SV_CHECK_THINKFIRST(sv);
4182 if (SvTYPE(sv) < SVt_PVIV)
4183 sv_upgrade(sv,SVt_PVIV);
4186 if (!SvLEN(sv)) { /* make copy of shared string */
4187 char *pvx = SvPVX(sv);
4188 STRLEN len = SvCUR(sv);
4189 SvGROW(sv, len + 1);
4190 Move(pvx,SvPVX(sv),len,char);
4194 SvFLAGS(sv) |= SVf_OOK;
4196 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVp_IOK|SVp_NOK|SVf_IVisUV);
4197 delta = ptr - SvPVX(sv);
4205 =for apidoc sv_catpvn
4207 Concatenates the string onto the end of the string which is in the SV. The
4208 C<len> indicates number of bytes to copy. If the SV has the UTF8
4209 status set, then the bytes appended should be valid UTF8.
4210 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4215 /* sv_catpvn() is aliased to Perl_sv_catpvn_macro; this function provided
4216 for binary compatibility only
4219 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4221 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4225 =for apidoc sv_catpvn_flags
4227 Concatenates the string onto the end of the string which is in the SV. The
4228 C<len> indicates number of bytes to copy. If the SV has the UTF8
4229 status set, then the bytes appended should be valid UTF8.
4230 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4231 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4232 in terms of this function.
4238 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4243 dstr = SvPV_force_flags(dsv, dlen, flags);
4244 SvGROW(dsv, dlen + slen + 1);
4247 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4250 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4255 =for apidoc sv_catpvn_mg
4257 Like C<sv_catpvn>, but also handles 'set' magic.
4263 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4265 sv_catpvn(sv,ptr,len);
4270 =for apidoc sv_catsv
4272 Concatenates the string from SV C<ssv> onto the end of the string in
4273 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4274 not 'set' magic. See C<sv_catsv_mg>.
4278 /* sv_catsv() is aliased to Perl_sv_catsv_macro; this function provided
4279 for binary compatibility only
4282 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4284 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4288 =for apidoc sv_catsv_flags
4290 Concatenates the string from SV C<ssv> onto the end of the string in
4291 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4292 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4293 and C<sv_catsv_nomg> are implemented in terms of this function.
4298 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4304 if ((spv = SvPV(ssv, slen))) {
4305 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4306 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4307 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4308 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4309 dsv->sv_flags doesn't have that bit set.
4310 Andy Dougherty 12 Oct 2001
4312 I32 sutf8 = DO_UTF8(ssv);
4315 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4317 dutf8 = DO_UTF8(dsv);
4319 if (dutf8 != sutf8) {
4321 /* Not modifying source SV, so taking a temporary copy. */
4322 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4324 sv_utf8_upgrade(csv);
4325 spv = SvPV(csv, slen);
4328 sv_utf8_upgrade_nomg(dsv);
4330 sv_catpvn_nomg(dsv, spv, slen);
4335 =for apidoc sv_catsv_mg
4337 Like C<sv_catsv>, but also handles 'set' magic.
4343 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4350 =for apidoc sv_catpv
4352 Concatenates the string onto the end of the string which is in the SV.
4353 If the SV has the UTF8 status set, then the bytes appended should be
4354 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4359 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4361 register STRLEN len;
4367 junk = SvPV_force(sv, tlen);
4369 SvGROW(sv, tlen + len + 1);
4372 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4374 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4379 =for apidoc sv_catpv_mg
4381 Like C<sv_catpv>, but also handles 'set' magic.
4387 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4396 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4397 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4404 Perl_newSV(pTHX_ STRLEN len)
4410 sv_upgrade(sv, SVt_PV);
4411 SvGROW(sv, len + 1);
4417 =for apidoc sv_magic
4419 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4420 then adds a new magic item of type C<how> to the head of the magic list.
4422 C<name> is assumed to contain an C<SV*> if C<(name && namelen == HEf_SVKEY)>
4428 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4432 if (SvREADONLY(sv)) {
4433 if (PL_curcop != &PL_compiling
4434 && how != PERL_MAGIC_regex_global
4435 && how != PERL_MAGIC_bm
4436 && how != PERL_MAGIC_fm
4437 && how != PERL_MAGIC_sv
4440 Perl_croak(aTHX_ PL_no_modify);
4443 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4444 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4445 if (how == PERL_MAGIC_taint)
4451 (void)SvUPGRADE(sv, SVt_PVMG);
4453 Newz(702,mg, 1, MAGIC);
4454 mg->mg_moremagic = SvMAGIC(sv);
4457 /* Some magic contains a reference loop, where the sv and object refer to
4458 each other. To avoid a reference loop that would prevent such objects
4459 being freed, we look for such loops and if we find one we avoid
4460 incrementing the object refcount. */
4461 if (!obj || obj == sv ||
4462 how == PERL_MAGIC_arylen ||
4463 how == PERL_MAGIC_qr ||
4464 (SvTYPE(obj) == SVt_PVGV &&
4465 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4466 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4467 GvFORM(obj) == (CV*)sv)))
4472 mg->mg_obj = SvREFCNT_inc(obj);
4473 mg->mg_flags |= MGf_REFCOUNTED;
4476 mg->mg_len = namlen;
4479 mg->mg_ptr = savepvn(name, namlen);
4480 else if (namlen == HEf_SVKEY)
4481 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4486 mg->mg_virtual = &PL_vtbl_sv;
4488 case PERL_MAGIC_overload:
4489 mg->mg_virtual = &PL_vtbl_amagic;
4491 case PERL_MAGIC_overload_elem:
4492 mg->mg_virtual = &PL_vtbl_amagicelem;
4494 case PERL_MAGIC_overload_table:
4495 mg->mg_virtual = &PL_vtbl_ovrld;
4498 mg->mg_virtual = &PL_vtbl_bm;
4500 case PERL_MAGIC_regdata:
4501 mg->mg_virtual = &PL_vtbl_regdata;
4503 case PERL_MAGIC_regdatum:
4504 mg->mg_virtual = &PL_vtbl_regdatum;
4506 case PERL_MAGIC_env:
4507 mg->mg_virtual = &PL_vtbl_env;
4510 mg->mg_virtual = &PL_vtbl_fm;
4512 case PERL_MAGIC_envelem:
4513 mg->mg_virtual = &PL_vtbl_envelem;
4515 case PERL_MAGIC_regex_global:
4516 mg->mg_virtual = &PL_vtbl_mglob;
4518 case PERL_MAGIC_isa:
4519 mg->mg_virtual = &PL_vtbl_isa;
4521 case PERL_MAGIC_isaelem:
4522 mg->mg_virtual = &PL_vtbl_isaelem;
4524 case PERL_MAGIC_nkeys:
4525 mg->mg_virtual = &PL_vtbl_nkeys;
4527 case PERL_MAGIC_dbfile:
4531 case PERL_MAGIC_dbline:
4532 mg->mg_virtual = &PL_vtbl_dbline;
4534 #ifdef USE_5005THREADS
4535 case PERL_MAGIC_mutex:
4536 mg->mg_virtual = &PL_vtbl_mutex;
4538 #endif /* USE_5005THREADS */
4539 #ifdef USE_LOCALE_COLLATE
4540 case PERL_MAGIC_collxfrm:
4541 mg->mg_virtual = &PL_vtbl_collxfrm;
4543 #endif /* USE_LOCALE_COLLATE */
4544 case PERL_MAGIC_tied:
4545 mg->mg_virtual = &PL_vtbl_pack;
4547 case PERL_MAGIC_tiedelem:
4548 case PERL_MAGIC_tiedscalar:
4549 mg->mg_virtual = &PL_vtbl_packelem;
4552 mg->mg_virtual = &PL_vtbl_regexp;
4554 case PERL_MAGIC_sig:
4555 mg->mg_virtual = &PL_vtbl_sig;
4557 case PERL_MAGIC_sigelem:
4558 mg->mg_virtual = &PL_vtbl_sigelem;
4560 case PERL_MAGIC_taint:
4561 mg->mg_virtual = &PL_vtbl_taint;
4564 case PERL_MAGIC_uvar:
4565 mg->mg_virtual = &PL_vtbl_uvar;
4567 case PERL_MAGIC_vec:
4568 mg->mg_virtual = &PL_vtbl_vec;
4570 case PERL_MAGIC_substr:
4571 mg->mg_virtual = &PL_vtbl_substr;
4573 case PERL_MAGIC_defelem:
4574 mg->mg_virtual = &PL_vtbl_defelem;
4576 case PERL_MAGIC_glob:
4577 mg->mg_virtual = &PL_vtbl_glob;
4579 case PERL_MAGIC_arylen:
4580 mg->mg_virtual = &PL_vtbl_arylen;
4582 case PERL_MAGIC_pos:
4583 mg->mg_virtual = &PL_vtbl_pos;
4585 case PERL_MAGIC_backref:
4586 mg->mg_virtual = &PL_vtbl_backref;
4588 case PERL_MAGIC_ext:
4589 /* Reserved for use by extensions not perl internals. */
4590 /* Useful for attaching extension internal data to perl vars. */
4591 /* Note that multiple extensions may clash if magical scalars */
4592 /* etc holding private data from one are passed to another. */
4596 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4600 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4604 =for apidoc sv_unmagic
4606 Removes all magic of type C<type> from an SV.
4612 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4616 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4619 for (mg = *mgp; mg; mg = *mgp) {
4620 if (mg->mg_type == type) {
4621 MGVTBL* vtbl = mg->mg_virtual;
4622 *mgp = mg->mg_moremagic;
4623 if (vtbl && vtbl->svt_free)
4624 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4625 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4626 if (mg->mg_len >= 0)
4627 Safefree(mg->mg_ptr);
4628 else if (mg->mg_len == HEf_SVKEY)
4629 SvREFCNT_dec((SV*)mg->mg_ptr);
4631 if (mg->mg_flags & MGf_REFCOUNTED)
4632 SvREFCNT_dec(mg->mg_obj);
4636 mgp = &mg->mg_moremagic;
4640 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4647 =for apidoc sv_rvweaken
4649 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4650 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4651 push a back-reference to this RV onto the array of backreferences
4652 associated with that magic.
4658 Perl_sv_rvweaken(pTHX_ SV *sv)
4661 if (!SvOK(sv)) /* let undefs pass */
4664 Perl_croak(aTHX_ "Can't weaken a nonreference");
4665 else if (SvWEAKREF(sv)) {
4666 if (ckWARN(WARN_MISC))
4667 Perl_warner(aTHX_ WARN_MISC, "Reference is already weak");
4671 sv_add_backref(tsv, sv);
4677 /* Give tsv backref magic if it hasn't already got it, then push a
4678 * back-reference to sv onto the array associated with the backref magic.
4682 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4686 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4687 av = (AV*)mg->mg_obj;
4690 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4691 SvREFCNT_dec(av); /* for sv_magic */
4696 /* delete a back-reference to ourselves from the backref magic associated
4697 * with the SV we point to.
4701 S_sv_del_backref(pTHX_ SV *sv)
4708 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4709 Perl_croak(aTHX_ "panic: del_backref");
4710 av = (AV *)mg->mg_obj;
4715 svp[i] = &PL_sv_undef; /* XXX */
4722 =for apidoc sv_insert
4724 Inserts a string at the specified offset/length within the SV. Similar to
4725 the Perl substr() function.
4731 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
4735 register char *midend;
4736 register char *bigend;
4742 Perl_croak(aTHX_ "Can't modify non-existent substring");
4743 SvPV_force(bigstr, curlen);
4744 (void)SvPOK_only_UTF8(bigstr);
4745 if (offset + len > curlen) {
4746 SvGROW(bigstr, offset+len+1);
4747 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4748 SvCUR_set(bigstr, offset+len);
4752 i = littlelen - len;
4753 if (i > 0) { /* string might grow */
4754 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4755 mid = big + offset + len;
4756 midend = bigend = big + SvCUR(bigstr);
4759 while (midend > mid) /* shove everything down */
4760 *--bigend = *--midend;
4761 Move(little,big+offset,littlelen,char);
4767 Move(little,SvPVX(bigstr)+offset,len,char);
4772 big = SvPVX(bigstr);
4775 bigend = big + SvCUR(bigstr);
4777 if (midend > bigend)
4778 Perl_croak(aTHX_ "panic: sv_insert");
4780 if (mid - big > bigend - midend) { /* faster to shorten from end */
4782 Move(little, mid, littlelen,char);
4785 i = bigend - midend;
4787 Move(midend, mid, i,char);
4791 SvCUR_set(bigstr, mid - big);
4794 else if ((i = mid - big)) { /* faster from front */
4795 midend -= littlelen;
4797 sv_chop(bigstr,midend-i);
4802 Move(little, mid, littlelen,char);
4804 else if (littlelen) {
4805 midend -= littlelen;
4806 sv_chop(bigstr,midend);
4807 Move(little,midend,littlelen,char);
4810 sv_chop(bigstr,midend);
4816 =for apidoc sv_replace
4818 Make the first argument a copy of the second, then delete the original.
4819 The target SV physically takes over ownership of the body of the source SV
4820 and inherits its flags; however, the target keeps any magic it owns,
4821 and any magic in the source is discarded.
4822 Note that this is a rather specialist SV copying operation; most of the
4823 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4829 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4831 U32 refcnt = SvREFCNT(sv);
4832 SV_CHECK_THINKFIRST(sv);
4833 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
4834 Perl_warner(aTHX_ WARN_INTERNAL, "Reference miscount in sv_replace()");
4835 if (SvMAGICAL(sv)) {
4839 sv_upgrade(nsv, SVt_PVMG);
4840 SvMAGIC(nsv) = SvMAGIC(sv);
4841 SvFLAGS(nsv) |= SvMAGICAL(sv);
4847 assert(!SvREFCNT(sv));
4848 StructCopy(nsv,sv,SV);
4849 SvREFCNT(sv) = refcnt;
4850 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4855 =for apidoc sv_clear
4857 Clear an SV: call any destructors, free up any memory used by the body,
4858 and free the body itself. The SV's head is I<not> freed, although
4859 its type is set to all 1's so that it won't inadvertently be assumed
4860 to be live during global destruction etc.
4861 This function should only be called when REFCNT is zero. Most of the time
4862 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4869 Perl_sv_clear(pTHX_ register SV *sv)
4873 assert(SvREFCNT(sv) == 0);
4876 if (PL_defstash) { /* Still have a symbol table? */
4881 Zero(&tmpref, 1, SV);
4882 sv_upgrade(&tmpref, SVt_RV);
4884 SvREADONLY_on(&tmpref); /* DESTROY() could be naughty */
4885 SvREFCNT(&tmpref) = 1;
4888 stash = SvSTASH(sv);
4889 destructor = StashHANDLER(stash,DESTROY);
4892 PUSHSTACKi(PERLSI_DESTROY);
4893 SvRV(&tmpref) = SvREFCNT_inc(sv);
4898 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR);
4904 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4906 del_XRV(SvANY(&tmpref));
4909 if (PL_in_clean_objs)
4910 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4912 /* DESTROY gave object new lease on life */
4918 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4919 SvOBJECT_off(sv); /* Curse the object. */
4920 if (SvTYPE(sv) != SVt_PVIO)
4921 --PL_sv_objcount; /* XXX Might want something more general */
4924 if (SvTYPE(sv) >= SVt_PVMG) {
4927 if (SvFLAGS(sv) & SVpad_TYPED)
4928 SvREFCNT_dec(SvSTASH(sv));
4931 switch (SvTYPE(sv)) {
4934 IoIFP(sv) != PerlIO_stdin() &&
4935 IoIFP(sv) != PerlIO_stdout() &&
4936 IoIFP(sv) != PerlIO_stderr())
4938 io_close((IO*)sv, FALSE);
4940 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4941 PerlDir_close(IoDIRP(sv));
4942 IoDIRP(sv) = (DIR*)NULL;
4943 Safefree(IoTOP_NAME(sv));
4944 Safefree(IoFMT_NAME(sv));
4945 Safefree(IoBOTTOM_NAME(sv));
4960 SvREFCNT_dec(LvTARG(sv));
4964 Safefree(GvNAME(sv));
4965 /* cannot decrease stash refcount yet, as we might recursively delete
4966 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
4967 of stash until current sv is completely gone.
4968 -- JohnPC, 27 Mar 1998 */
4969 stash = GvSTASH(sv);
4975 (void)SvOOK_off(sv);
4983 SvREFCNT_dec(SvRV(sv));
4985 else if (SvPVX(sv) && SvLEN(sv))
4986 Safefree(SvPVX(sv));
4987 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4988 unsharepvn(SvPVX(sv),
4989 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5002 switch (SvTYPE(sv)) {
5018 del_XPVIV(SvANY(sv));
5021 del_XPVNV(SvANY(sv));
5024 del_XPVMG(SvANY(sv));
5027 del_XPVLV(SvANY(sv));
5030 del_XPVAV(SvANY(sv));
5033 del_XPVHV(SvANY(sv));
5036 del_XPVCV(SvANY(sv));
5039 del_XPVGV(SvANY(sv));
5040 /* code duplication for increased performance. */
5041 SvFLAGS(sv) &= SVf_BREAK;
5042 SvFLAGS(sv) |= SVTYPEMASK;
5043 /* decrease refcount of the stash that owns this GV, if any */
5045 SvREFCNT_dec(stash);
5046 return; /* not break, SvFLAGS reset already happened */
5048 del_XPVBM(SvANY(sv));
5051 del_XPVFM(SvANY(sv));
5054 del_XPVIO(SvANY(sv));
5057 SvFLAGS(sv) &= SVf_BREAK;
5058 SvFLAGS(sv) |= SVTYPEMASK;
5062 =for apidoc sv_newref
5064 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5071 Perl_sv_newref(pTHX_ SV *sv)
5074 ATOMIC_INC(SvREFCNT(sv));
5081 Decrement an SV's reference count, and if it drops to zero, call
5082 C<sv_clear> to invoke destructors and free up any memory used by
5083 the body; finally, deallocate the SV's head itself.
5084 Normally called via a wrapper macro C<SvREFCNT_dec>.
5090 Perl_sv_free(pTHX_ SV *sv)
5092 int refcount_is_zero;
5096 if (SvREFCNT(sv) == 0) {
5097 if (SvFLAGS(sv) & SVf_BREAK)
5098 /* this SV's refcnt has been artificially decremented to
5099 * trigger cleanup */
5101 if (PL_in_clean_all) /* All is fair */
5103 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5104 /* make sure SvREFCNT(sv)==0 happens very seldom */
5105 SvREFCNT(sv) = (~(U32)0)/2;
5108 if (ckWARN_d(WARN_INTERNAL))
5109 Perl_warner(aTHX_ WARN_INTERNAL, "Attempt to free unreferenced scalar");
5112 ATOMIC_DEC_AND_TEST(refcount_is_zero, SvREFCNT(sv));
5113 if (!refcount_is_zero)
5117 if (ckWARN_d(WARN_DEBUGGING))
5118 Perl_warner(aTHX_ WARN_DEBUGGING,
5119 "Attempt to free temp prematurely: SV 0x%"UVxf,
5124 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5125 /* make sure SvREFCNT(sv)==0 happens very seldom */
5126 SvREFCNT(sv) = (~(U32)0)/2;
5137 Returns the length of the string in the SV. Handles magic and type
5138 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5144 Perl_sv_len(pTHX_ register SV *sv)
5152 len = mg_length(sv);
5154 (void)SvPV(sv, len);
5159 =for apidoc sv_len_utf8
5161 Returns the number of characters in the string in an SV, counting wide
5162 UTF8 bytes as a single character. Handles magic and type coercion.
5168 Perl_sv_len_utf8(pTHX_ register SV *sv)
5174 return mg_length(sv);
5178 U8 *s = (U8*)SvPV(sv, len);
5180 return Perl_utf8_length(aTHX_ s, s + len);
5185 =for apidoc sv_pos_u2b
5187 Converts the value pointed to by offsetp from a count of UTF8 chars from
5188 the start of the string, to a count of the equivalent number of bytes; if
5189 lenp is non-zero, it does the same to lenp, but this time starting from
5190 the offset, rather than from the start of the string. Handles magic and
5197 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5202 I32 uoffset = *offsetp;
5208 start = s = (U8*)SvPV(sv, len);
5210 while (s < send && uoffset--)
5214 *offsetp = s - start;
5218 while (s < send && ulen--)
5228 =for apidoc sv_pos_b2u
5230 Converts the value pointed to by offsetp from a count of bytes from the
5231 start of the string, to a count of the equivalent number of UTF8 chars.
5232 Handles magic and type coercion.
5238 Perl_sv_pos_b2u(pTHX_ register SV *sv, I32* offsetp)
5247 s = (U8*)SvPV(sv, len);
5249 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5250 send = s + *offsetp;
5254 /* Call utf8n_to_uvchr() to validate the sequence */
5255 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5270 Returns a boolean indicating whether the strings in the two SVs are
5271 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5272 coerce its args to strings if necessary.
5278 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5292 pv1 = SvPV(sv1, cur1);
5299 pv2 = SvPV(sv2, cur2);
5301 /* do not utf8ize the comparands as a side-effect */
5302 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5303 bool is_utf8 = TRUE;
5304 /* UTF-8ness differs */
5307 /* sv1 is the UTF-8 one , If is equal it must be downgrade-able */
5308 char *pv = (char*)bytes_from_utf8((U8*)pv1, &cur1, &is_utf8);
5313 /* sv2 is the UTF-8 one , If is equal it must be downgrade-able */
5314 char *pv = (char *)bytes_from_utf8((U8*)pv2, &cur2, &is_utf8);
5319 /* Downgrade not possible - cannot be eq */
5325 eq = memEQ(pv1, pv2, cur1);
5336 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5337 string in C<sv1> is less than, equal to, or greater than the string in
5338 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5339 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5345 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5350 bool pv1tmp = FALSE;
5351 bool pv2tmp = FALSE;
5358 pv1 = SvPV(sv1, cur1);
5365 pv2 = SvPV(sv2, cur2);
5367 /* do not utf8ize the comparands as a side-effect */
5368 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5370 pv2 = (char*)bytes_to_utf8((U8*)pv2, &cur2);
5374 pv1 = (char*)bytes_to_utf8((U8*)pv1, &cur1);
5380 cmp = cur2 ? -1 : 0;
5384 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
5387 cmp = retval < 0 ? -1 : 1;
5388 } else if (cur1 == cur2) {
5391 cmp = cur1 < cur2 ? -1 : 1;
5404 =for apidoc sv_cmp_locale
5406 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5407 'use bytes' aware, handles get magic, and will coerce its args to strings
5408 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5414 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5416 #ifdef USE_LOCALE_COLLATE
5422 if (PL_collation_standard)
5426 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5428 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5430 if (!pv1 || !len1) {
5441 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5444 return retval < 0 ? -1 : 1;
5447 * When the result of collation is equality, that doesn't mean
5448 * that there are no differences -- some locales exclude some
5449 * characters from consideration. So to avoid false equalities,
5450 * we use the raw string as a tiebreaker.
5456 #endif /* USE_LOCALE_COLLATE */
5458 return sv_cmp(sv1, sv2);
5462 #ifdef USE_LOCALE_COLLATE
5465 =for apidoc sv_collxfrm
5467 Add Collate Transform magic to an SV if it doesn't already have it.
5469 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5470 scalar data of the variable, but transformed to such a format that a normal
5471 memory comparison can be used to compare the data according to the locale
5478 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5482 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5483 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5488 Safefree(mg->mg_ptr);
5490 if ((xf = mem_collxfrm(s, len, &xlen))) {
5491 if (SvREADONLY(sv)) {
5494 return xf + sizeof(PL_collation_ix);
5497 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5498 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5511 if (mg && mg->mg_ptr) {
5513 return mg->mg_ptr + sizeof(PL_collation_ix);
5521 #endif /* USE_LOCALE_COLLATE */
5526 Get a line from the filehandle and store it into the SV, optionally
5527 appending to the currently-stored string.
5533 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5537 register STDCHAR rslast;
5538 register STDCHAR *bp;
5543 SV_CHECK_THINKFIRST(sv);
5544 (void)SvUPGRADE(sv, SVt_PV);
5548 if (PL_curcop == &PL_compiling) {
5549 /* we always read code in line mode */
5553 else if (RsSNARF(PL_rs)) {
5557 else if (RsRECORD(PL_rs)) {
5558 I32 recsize, bytesread;
5561 /* Grab the size of the record we're getting */
5562 recsize = SvIV(SvRV(PL_rs));
5563 (void)SvPOK_only(sv); /* Validate pointer */
5564 buffer = SvGROW(sv, recsize + 1);
5567 /* VMS wants read instead of fread, because fread doesn't respect */
5568 /* RMS record boundaries. This is not necessarily a good thing to be */
5569 /* doing, but we've got no other real choice */
5570 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5572 bytesread = PerlIO_read(fp, buffer, recsize);
5574 SvCUR_set(sv, bytesread);
5575 buffer[bytesread] = '\0';
5576 if (PerlIO_isutf8(fp))
5580 return(SvCUR(sv) ? SvPVX(sv) : Nullch);
5582 else if (RsPARA(PL_rs)) {
5588 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5589 if (PerlIO_isutf8(fp)) {
5590 rsptr = SvPVutf8(PL_rs, rslen);
5593 if (SvUTF8(PL_rs)) {
5594 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5595 Perl_croak(aTHX_ "Wide character in $/");
5598 rsptr = SvPV(PL_rs, rslen);
5602 rslast = rslen ? rsptr[rslen - 1] : '\0';
5604 if (rspara) { /* have to do this both before and after */
5605 do { /* to make sure file boundaries work right */
5608 i = PerlIO_getc(fp);
5612 PerlIO_ungetc(fp,i);
5618 /* See if we know enough about I/O mechanism to cheat it ! */
5620 /* This used to be #ifdef test - it is made run-time test for ease
5621 of abstracting out stdio interface. One call should be cheap
5622 enough here - and may even be a macro allowing compile
5626 if (PerlIO_fast_gets(fp)) {
5629 * We're going to steal some values from the stdio struct
5630 * and put EVERYTHING in the innermost loop into registers.
5632 register STDCHAR *ptr;
5636 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5637 /* An ungetc()d char is handled separately from the regular
5638 * buffer, so we getc() it back out and stuff it in the buffer.
5640 i = PerlIO_getc(fp);
5641 if (i == EOF) return 0;
5642 *(--((*fp)->_ptr)) = (unsigned char) i;
5646 /* Here is some breathtakingly efficient cheating */
5648 cnt = PerlIO_get_cnt(fp); /* get count into register */
5649 (void)SvPOK_only(sv); /* validate pointer */
5650 if (SvLEN(sv) - append <= cnt + 1) { /* make sure we have the room */
5651 if (cnt > 80 && SvLEN(sv) > append) {
5652 shortbuffered = cnt - SvLEN(sv) + append + 1;
5653 cnt -= shortbuffered;
5657 /* remember that cnt can be negative */
5658 SvGROW(sv, append + (cnt <= 0 ? 2 : (cnt + 1)));
5663 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
5664 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5665 DEBUG_P(PerlIO_printf(Perl_debug_log,
5666 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5667 DEBUG_P(PerlIO_printf(Perl_debug_log,
5668 "Screamer: entering: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5669 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5670 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5675 while (cnt > 0) { /* this | eat */
5677 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5678 goto thats_all_folks; /* screams | sed :-) */
5682 Copy(ptr, bp, cnt, char); /* this | eat */
5683 bp += cnt; /* screams | dust */
5684 ptr += cnt; /* louder | sed :-) */
5689 if (shortbuffered) { /* oh well, must extend */
5690 cnt = shortbuffered;
5692 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
5694 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5695 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
5699 DEBUG_P(PerlIO_printf(Perl_debug_log,
5700 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5701 PTR2UV(ptr),(long)cnt));
5702 PerlIO_set_ptrcnt(fp, ptr, cnt); /* deregisterize cnt and ptr */
5703 DEBUG_P(PerlIO_printf(Perl_debug_log,
5704 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5705 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5706 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5707 /* This used to call 'filbuf' in stdio form, but as that behaves like
5708 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5709 another abstraction. */
5710 i = PerlIO_getc(fp); /* get more characters */
5711 DEBUG_P(PerlIO_printf(Perl_debug_log,
5712 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5713 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5714 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5715 cnt = PerlIO_get_cnt(fp);
5716 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5717 DEBUG_P(PerlIO_printf(Perl_debug_log,
5718 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5720 if (i == EOF) /* all done for ever? */
5721 goto thats_really_all_folks;
5723 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
5725 SvGROW(sv, bpx + cnt + 2);
5726 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
5728 *bp++ = i; /* store character from PerlIO_getc */
5730 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5731 goto thats_all_folks;
5735 if ((rslen > 1 && (bp - (STDCHAR*)SvPVX(sv) < rslen)) ||
5736 memNE((char*)bp - rslen, rsptr, rslen))
5737 goto screamer; /* go back to the fray */
5738 thats_really_all_folks:
5740 cnt += shortbuffered;
5741 DEBUG_P(PerlIO_printf(Perl_debug_log,
5742 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5743 PerlIO_set_ptrcnt(fp, ptr, cnt); /* put these back or we're in trouble */
5744 DEBUG_P(PerlIO_printf(Perl_debug_log,
5745 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5746 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5747 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5749 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
5750 DEBUG_P(PerlIO_printf(Perl_debug_log,
5751 "Screamer: done, len=%ld, string=|%.*s|\n",
5752 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
5757 /*The big, slow, and stupid way */
5760 /* Need to work around EPOC SDK features */
5761 /* On WINS: MS VC5 generates calls to _chkstk, */
5762 /* if a `large' stack frame is allocated */
5763 /* gcc on MARM does not generate calls like these */
5769 register STDCHAR *bpe = buf + sizeof(buf);
5771 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = i) != rslast && bp < bpe)
5772 ; /* keep reading */
5776 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5777 /* Accomodate broken VAXC compiler, which applies U8 cast to
5778 * both args of ?: operator, causing EOF to change into 255
5780 if (cnt) { i = (U8)buf[cnt - 1]; } else { i = EOF; }
5784 sv_catpvn(sv, (char *) buf, cnt);
5786 sv_setpvn(sv, (char *) buf, cnt);
5788 if (i != EOF && /* joy */
5790 SvCUR(sv) < rslen ||
5791 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5795 * If we're reading from a TTY and we get a short read,
5796 * indicating that the user hit his EOF character, we need
5797 * to notice it now, because if we try to read from the TTY
5798 * again, the EOF condition will disappear.
5800 * The comparison of cnt to sizeof(buf) is an optimization
5801 * that prevents unnecessary calls to feof().
5805 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5810 if (rspara) { /* have to do this both before and after */
5811 while (i != EOF) { /* to make sure file boundaries work right */
5812 i = PerlIO_getc(fp);
5814 PerlIO_ungetc(fp,i);
5820 if (PerlIO_isutf8(fp))
5825 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5831 Auto-increment of the value in the SV, doing string to numeric conversion
5832 if necessary. Handles 'get' magic.
5838 Perl_sv_inc(pTHX_ register SV *sv)
5847 if (SvTHINKFIRST(sv)) {
5848 if (SvREADONLY(sv)) {
5849 if (PL_curcop != &PL_compiling)
5850 Perl_croak(aTHX_ PL_no_modify);
5854 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5856 i = PTR2IV(SvRV(sv));
5861 flags = SvFLAGS(sv);
5862 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5863 /* It's (privately or publicly) a float, but not tested as an
5864 integer, so test it to see. */
5866 flags = SvFLAGS(sv);
5868 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5869 /* It's publicly an integer, or privately an integer-not-float */
5870 #ifdef PERL_PRESERVE_IVUV
5874 if (SvUVX(sv) == UV_MAX)
5875 sv_setnv(sv, UV_MAX_P1);
5877 (void)SvIOK_only_UV(sv);
5880 if (SvIVX(sv) == IV_MAX)
5881 sv_setuv(sv, (UV)IV_MAX + 1);
5883 (void)SvIOK_only(sv);
5889 if (flags & SVp_NOK) {
5890 (void)SvNOK_only(sv);
5895 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
5896 if ((flags & SVTYPEMASK) < SVt_PVIV)
5897 sv_upgrade(sv, SVt_IV);
5898 (void)SvIOK_only(sv);
5903 while (isALPHA(*d)) d++;
5904 while (isDIGIT(*d)) d++;
5906 #ifdef PERL_PRESERVE_IVUV
5907 /* Got to punt this as an integer if needs be, but we don't issue
5908 warnings. Probably ought to make the sv_iv_please() that does
5909 the conversion if possible, and silently. */
5910 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
5911 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
5912 /* Need to try really hard to see if it's an integer.
5913 9.22337203685478e+18 is an integer.
5914 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
5915 so $a="9.22337203685478e+18"; $a+0; $a++
5916 needs to be the same as $a="9.22337203685478e+18"; $a++
5923 /* sv_2iv *should* have made this an NV */
5924 if (flags & SVp_NOK) {
5925 (void)SvNOK_only(sv);
5929 /* I don't think we can get here. Maybe I should assert this
5930 And if we do get here I suspect that sv_setnv will croak. NWC
5932 #if defined(USE_LONG_DOUBLE)
5933 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",
5934 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
5936 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%g\n",
5937 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
5940 #endif /* PERL_PRESERVE_IVUV */
5941 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
5945 while (d >= SvPVX(sv)) {
5953 /* MKS: The original code here died if letters weren't consecutive.
5954 * at least it didn't have to worry about non-C locales. The
5955 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
5956 * arranged in order (although not consecutively) and that only
5957 * [A-Za-z] are accepted by isALPHA in the C locale.
5959 if (*d != 'z' && *d != 'Z') {
5960 do { ++*d; } while (!isALPHA(*d));
5963 *(d--) -= 'z' - 'a';
5968 *(d--) -= 'z' - 'a' + 1;
5972 /* oh,oh, the number grew */
5973 SvGROW(sv, SvCUR(sv) + 2);
5975 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
5986 Auto-decrement of the value in the SV, doing string to numeric conversion
5987 if necessary. Handles 'get' magic.
5993 Perl_sv_dec(pTHX_ register SV *sv)
6001 if (SvTHINKFIRST(sv)) {
6002 if (SvREADONLY(sv)) {
6003 if (PL_curcop != &PL_compiling)
6004 Perl_croak(aTHX_ PL_no_modify);
6008 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6010 i = PTR2IV(SvRV(sv));
6015 /* Unlike sv_inc we don't have to worry about string-never-numbers
6016 and keeping them magic. But we mustn't warn on punting */
6017 flags = SvFLAGS(sv);
6018 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6019 /* It's publicly an integer, or privately an integer-not-float */
6020 #ifdef PERL_PRESERVE_IVUV
6024 if (SvUVX(sv) == 0) {
6025 (void)SvIOK_only(sv);
6029 (void)SvIOK_only_UV(sv);
6033 if (SvIVX(sv) == IV_MIN)
6034 sv_setnv(sv, (NV)IV_MIN - 1.0);
6036 (void)SvIOK_only(sv);
6042 if (flags & SVp_NOK) {
6044 (void)SvNOK_only(sv);
6047 if (!(flags & SVp_POK)) {
6048 if ((flags & SVTYPEMASK) < SVt_PVNV)
6049 sv_upgrade(sv, SVt_NV);
6051 (void)SvNOK_only(sv);
6054 #ifdef PERL_PRESERVE_IVUV
6056 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6057 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6058 /* Need to try really hard to see if it's an integer.
6059 9.22337203685478e+18 is an integer.
6060 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6061 so $a="9.22337203685478e+18"; $a+0; $a--
6062 needs to be the same as $a="9.22337203685478e+18"; $a--
6069 /* sv_2iv *should* have made this an NV */
6070 if (flags & SVp_NOK) {
6071 (void)SvNOK_only(sv);
6075 /* I don't think we can get here. Maybe I should assert this
6076 And if we do get here I suspect that sv_setnv will croak. NWC
6078 #if defined(USE_LONG_DOUBLE)
6079 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",
6080 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6082 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%g\n",
6083 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6087 #endif /* PERL_PRESERVE_IVUV */
6088 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6092 =for apidoc sv_mortalcopy
6094 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6095 The new SV is marked as mortal. It will be destroyed "soon", either by an
6096 explicit call to FREETMPS, or by an implicit call at places such as
6097 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6102 /* Make a string that will exist for the duration of the expression
6103 * evaluation. Actually, it may have to last longer than that, but
6104 * hopefully we won't free it until it has been assigned to a
6105 * permanent location. */
6108 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6113 sv_setsv(sv,oldstr);
6115 PL_tmps_stack[++PL_tmps_ix] = sv;
6121 =for apidoc sv_newmortal
6123 Creates a new null SV which is mortal. The reference count of the SV is
6124 set to 1. It will be destroyed "soon", either by an explicit call to
6125 FREETMPS, or by an implicit call at places such as statement boundaries.
6126 See also C<sv_mortalcopy> and C<sv_2mortal>.
6132 Perl_sv_newmortal(pTHX)
6137 SvFLAGS(sv) = SVs_TEMP;
6139 PL_tmps_stack[++PL_tmps_ix] = sv;
6144 =for apidoc sv_2mortal
6146 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6147 by an explicit call to FREETMPS, or by an implicit call at places such as
6148 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
6154 Perl_sv_2mortal(pTHX_ register SV *sv)
6158 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6161 PL_tmps_stack[++PL_tmps_ix] = sv;
6169 Creates a new SV and copies a string into it. The reference count for the
6170 SV is set to 1. If C<len> is zero, Perl will compute the length using
6171 strlen(). For efficiency, consider using C<newSVpvn> instead.
6177 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6184 sv_setpvn(sv,s,len);
6189 =for apidoc newSVpvn
6191 Creates a new SV and copies a string into it. The reference count for the
6192 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6193 string. You are responsible for ensuring that the source string is at least
6200 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6205 sv_setpvn(sv,s,len);
6210 =for apidoc newSVpvn_share
6212 Creates a new SV with its SvPVX pointing to a shared string in the string
6213 table. If the string does not already exist in the table, it is created
6214 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6215 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6216 otherwise the hash is computed. The idea here is that as the string table
6217 is used for shared hash keys these strings will have SvPVX == HeKEY and
6218 hash lookup will avoid string compare.
6224 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6227 bool is_utf8 = FALSE;
6229 STRLEN tmplen = -len;
6231 /* See the note in hv.c:hv_fetch() --jhi */
6232 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
6236 PERL_HASH(hash, src, len);
6238 sv_upgrade(sv, SVt_PVIV);
6239 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
6252 #if defined(PERL_IMPLICIT_CONTEXT)
6254 /* pTHX_ magic can't cope with varargs, so this is a no-context
6255 * version of the main function, (which may itself be aliased to us).
6256 * Don't access this version directly.
6260 Perl_newSVpvf_nocontext(const char* pat, ...)
6265 va_start(args, pat);
6266 sv = vnewSVpvf(pat, &args);
6273 =for apidoc newSVpvf
6275 Creates a new SV and initializes it with the string formatted like
6282 Perl_newSVpvf(pTHX_ const char* pat, ...)
6286 va_start(args, pat);
6287 sv = vnewSVpvf(pat, &args);
6292 /* backend for newSVpvf() and newSVpvf_nocontext() */
6295 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6299 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6306 Creates a new SV and copies a floating point value into it.
6307 The reference count for the SV is set to 1.
6313 Perl_newSVnv(pTHX_ NV n)
6325 Creates a new SV and copies an integer into it. The reference count for the
6332 Perl_newSViv(pTHX_ IV i)
6344 Creates a new SV and copies an unsigned integer into it.
6345 The reference count for the SV is set to 1.
6351 Perl_newSVuv(pTHX_ UV u)
6361 =for apidoc newRV_noinc
6363 Creates an RV wrapper for an SV. The reference count for the original
6364 SV is B<not> incremented.
6370 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6375 sv_upgrade(sv, SVt_RV);
6382 /* newRV_inc is the official function name to use now.
6383 * newRV_inc is in fact #defined to newRV in sv.h
6387 Perl_newRV(pTHX_ SV *tmpRef)
6389 return newRV_noinc(SvREFCNT_inc(tmpRef));
6395 Creates a new SV which is an exact duplicate of the original SV.
6402 Perl_newSVsv(pTHX_ register SV *old)
6408 if (SvTYPE(old) == SVTYPEMASK) {
6409 if (ckWARN_d(WARN_INTERNAL))
6410 Perl_warner(aTHX_ WARN_INTERNAL, "semi-panic: attempt to dup freed string");
6425 =for apidoc sv_reset
6427 Underlying implementation for the C<reset> Perl function.
6428 Note that the perl-level function is vaguely deprecated.
6434 Perl_sv_reset(pTHX_ register char *s, HV *stash)
6442 char todo[PERL_UCHAR_MAX+1];
6447 if (!*s) { /* reset ?? searches */
6448 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
6449 pm->op_pmdynflags &= ~PMdf_USED;
6454 /* reset variables */
6456 if (!HvARRAY(stash))
6459 Zero(todo, 256, char);
6461 i = (unsigned char)*s;
6465 max = (unsigned char)*s++;
6466 for ( ; i <= max; i++) {
6469 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6470 for (entry = HvARRAY(stash)[i];
6472 entry = HeNEXT(entry))
6474 if (!todo[(U8)*HeKEY(entry)])
6476 gv = (GV*)HeVAL(entry);
6478 if (SvTHINKFIRST(sv)) {
6479 if (!SvREADONLY(sv) && SvROK(sv))
6484 if (SvTYPE(sv) >= SVt_PV) {
6486 if (SvPVX(sv) != Nullch)
6493 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
6495 #ifdef USE_ENVIRON_ARRAY
6497 environ[0] = Nullch;
6508 Using various gambits, try to get an IO from an SV: the IO slot if its a
6509 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6510 named after the PV if we're a string.
6516 Perl_sv_2io(pTHX_ SV *sv)
6522 switch (SvTYPE(sv)) {
6530 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6534 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6536 return sv_2io(SvRV(sv));
6537 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
6543 Perl_croak(aTHX_ "Bad filehandle: %s", SvPV(sv,n_a));
6552 Using various gambits, try to get a CV from an SV; in addition, try if
6553 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6559 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6566 return *gvp = Nullgv, Nullcv;
6567 switch (SvTYPE(sv)) {
6586 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6587 tryAMAGICunDEREF(to_cv);
6590 if (SvTYPE(sv) == SVt_PVCV) {
6599 Perl_croak(aTHX_ "Not a subroutine reference");
6604 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
6610 if (lref && !GvCVu(gv)) {
6613 tmpsv = NEWSV(704,0);
6614 gv_efullname3(tmpsv, gv, Nullch);
6615 /* XXX this is probably not what they think they're getting.
6616 * It has the same effect as "sub name;", i.e. just a forward
6618 newSUB(start_subparse(FALSE, 0),
6619 newSVOP(OP_CONST, 0, tmpsv),
6624 Perl_croak(aTHX_ "Unable to create sub named \"%s\"", SvPV(sv,n_a));
6633 Returns true if the SV has a true value by Perl's rules.
6634 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6635 instead use an in-line version.
6641 Perl_sv_true(pTHX_ register SV *sv)
6647 if ((tXpv = (XPV*)SvANY(sv)) &&
6648 (tXpv->xpv_cur > 1 ||
6649 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
6656 return SvIVX(sv) != 0;
6659 return SvNVX(sv) != 0.0;
6661 return sv_2bool(sv);
6669 A private implementation of the C<SvIVx> macro for compilers which can't
6670 cope with complex macro expressions. Always use the macro instead.
6676 Perl_sv_iv(pTHX_ register SV *sv)
6680 return (IV)SvUVX(sv);
6689 A private implementation of the C<SvUVx> macro for compilers which can't
6690 cope with complex macro expressions. Always use the macro instead.
6696 Perl_sv_uv(pTHX_ register SV *sv)
6701 return (UV)SvIVX(sv);
6709 A private implementation of the C<SvNVx> macro for compilers which can't
6710 cope with complex macro expressions. Always use the macro instead.
6716 Perl_sv_nv(pTHX_ register SV *sv)
6726 A private implementation of the C<SvPV_nolen> macro for compilers which can't
6727 cope with complex macro expressions. Always use the macro instead.
6733 Perl_sv_pv(pTHX_ SV *sv)
6740 return sv_2pv(sv, &n_a);
6746 A private implementation of the C<SvPV> macro for compilers which can't
6747 cope with complex macro expressions. Always use the macro instead.
6753 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
6759 return sv_2pv(sv, lp);
6762 /* For -DCRIPPLED_CC only. See also C<sv_2pv_flags()>.
6766 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
6772 return sv_2pv_flags(sv, lp, 0);
6776 =for apidoc sv_pvn_force
6778 Get a sensible string out of the SV somehow.
6779 A private implementation of the C<SvPV_force> macro for compilers which
6780 can't cope with complex macro expressions. Always use the macro instead.
6786 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
6788 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
6792 =for apidoc sv_pvn_force_flags
6794 Get a sensible string out of the SV somehow.
6795 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6796 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6797 implemented in terms of this function.
6798 You normally want to use the various wrapper macros instead: see
6799 C<SvPV_force> and C<SvPV_force_nomg>
6805 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6809 if (SvTHINKFIRST(sv) && !SvROK(sv))
6810 sv_force_normal(sv);
6816 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
6817 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6821 s = sv_2pv_flags(sv, lp, flags);
6822 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
6827 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6828 SvGROW(sv, len + 1);
6829 Move(s,SvPVX(sv),len,char);
6834 SvPOK_on(sv); /* validate pointer */
6836 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6837 PTR2UV(sv),SvPVX(sv)));
6844 =for apidoc sv_pvbyte
6846 A private implementation of the C<SvPVbyte_nolen> macro for compilers
6847 which can't cope with complex macro expressions. Always use the macro
6854 Perl_sv_pvbyte(pTHX_ SV *sv)
6856 sv_utf8_downgrade(sv,0);
6861 =for apidoc sv_pvbyten
6863 A private implementation of the C<SvPVbyte> macro for compilers
6864 which can't cope with complex macro expressions. Always use the macro
6871 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
6873 sv_utf8_downgrade(sv,0);
6874 return sv_pvn(sv,lp);
6878 =for apidoc sv_pvbyten_force
6880 A private implementation of the C<SvPVbytex_force> macro for compilers
6881 which can't cope with complex macro expressions. Always use the macro
6888 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6890 sv_utf8_downgrade(sv,0);
6891 return sv_pvn_force(sv,lp);
6895 =for apidoc sv_pvutf8
6897 A private implementation of the C<SvPVutf8_nolen> macro for compilers
6898 which can't cope with complex macro expressions. Always use the macro
6905 Perl_sv_pvutf8(pTHX_ SV *sv)
6907 sv_utf8_upgrade(sv);
6912 =for apidoc sv_pvutf8n
6914 A private implementation of the C<SvPVutf8> macro for compilers
6915 which can't cope with complex macro expressions. Always use the macro
6922 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
6924 sv_utf8_upgrade(sv);
6925 return sv_pvn(sv,lp);
6929 =for apidoc sv_pvutf8n_force
6931 A private implementation of the C<SvPVutf8_force> macro for compilers
6932 which can't cope with complex macro expressions. Always use the macro
6939 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6941 sv_utf8_upgrade(sv);
6942 return sv_pvn_force(sv,lp);
6946 =for apidoc sv_reftype
6948 Returns a string describing what the SV is a reference to.
6954 Perl_sv_reftype(pTHX_ SV *sv, int ob)
6956 if (ob && SvOBJECT(sv)) {
6957 HV *svs = SvSTASH(sv);
6958 /* [20011101.072] This bandaid for C<package;> should eventually
6959 be removed. AMS 20011103 */
6960 return (svs ? HvNAME(svs) : "<none>");
6963 switch (SvTYPE(sv)) {
6977 case SVt_PVLV: return "LVALUE";
6978 case SVt_PVAV: return "ARRAY";
6979 case SVt_PVHV: return "HASH";
6980 case SVt_PVCV: return "CODE";
6981 case SVt_PVGV: return "GLOB";
6982 case SVt_PVFM: return "FORMAT";
6983 case SVt_PVIO: return "IO";
6984 default: return "UNKNOWN";
6990 =for apidoc sv_isobject
6992 Returns a boolean indicating whether the SV is an RV pointing to a blessed
6993 object. If the SV is not an RV, or if the object is not blessed, then this
7000 Perl_sv_isobject(pTHX_ SV *sv)
7017 Returns a boolean indicating whether the SV is blessed into the specified
7018 class. This does not check for subtypes; use C<sv_derived_from> to verify
7019 an inheritance relationship.
7025 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7037 return strEQ(HvNAME(SvSTASH(sv)), name);
7043 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7044 it will be upgraded to one. If C<classname> is non-null then the new SV will
7045 be blessed in the specified package. The new SV is returned and its
7046 reference count is 1.
7052 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7058 SV_CHECK_THINKFIRST(rv);
7061 if (SvTYPE(rv) >= SVt_PVMG) {
7062 U32 refcnt = SvREFCNT(rv);
7066 SvREFCNT(rv) = refcnt;
7069 if (SvTYPE(rv) < SVt_RV)
7070 sv_upgrade(rv, SVt_RV);
7071 else if (SvTYPE(rv) > SVt_RV) {
7072 (void)SvOOK_off(rv);
7073 if (SvPVX(rv) && SvLEN(rv))
7074 Safefree(SvPVX(rv));
7084 HV* stash = gv_stashpv(classname, TRUE);
7085 (void)sv_bless(rv, stash);
7091 =for apidoc sv_setref_pv
7093 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7094 argument will be upgraded to an RV. That RV will be modified to point to
7095 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7096 into the SV. The C<classname> argument indicates the package for the
7097 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7098 will be returned and will have a reference count of 1.
7100 Do not use with other Perl types such as HV, AV, SV, CV, because those
7101 objects will become corrupted by the pointer copy process.
7103 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7109 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7112 sv_setsv(rv, &PL_sv_undef);
7116 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7121 =for apidoc sv_setref_iv
7123 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7124 argument will be upgraded to an RV. That RV will be modified to point to
7125 the new SV. The C<classname> argument indicates the package for the
7126 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7127 will be returned and will have a reference count of 1.
7133 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7135 sv_setiv(newSVrv(rv,classname), iv);
7140 =for apidoc sv_setref_uv
7142 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7143 argument will be upgraded to an RV. That RV will be modified to point to
7144 the new SV. The C<classname> argument indicates the package for the
7145 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7146 will be returned and will have a reference count of 1.
7152 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7154 sv_setuv(newSVrv(rv,classname), uv);
7159 =for apidoc sv_setref_nv
7161 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7162 argument will be upgraded to an RV. That RV will be modified to point to
7163 the new SV. The C<classname> argument indicates the package for the
7164 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7165 will be returned and will have a reference count of 1.
7171 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7173 sv_setnv(newSVrv(rv,classname), nv);
7178 =for apidoc sv_setref_pvn
7180 Copies a string into a new SV, optionally blessing the SV. The length of the
7181 string must be specified with C<n>. The C<rv> argument will be upgraded to
7182 an RV. That RV will be modified to point to the new SV. The C<classname>
7183 argument indicates the package for the blessing. Set C<classname> to
7184 C<Nullch> to avoid the blessing. The new SV will be returned and will have
7185 a reference count of 1.
7187 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7193 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
7195 sv_setpvn(newSVrv(rv,classname), pv, n);
7200 =for apidoc sv_bless
7202 Blesses an SV into a specified package. The SV must be an RV. The package
7203 must be designated by its stash (see C<gv_stashpv()>). The reference count
7204 of the SV is unaffected.
7210 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7214 Perl_croak(aTHX_ "Can't bless non-reference value");
7216 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7217 if (SvREADONLY(tmpRef))
7218 Perl_croak(aTHX_ PL_no_modify);
7219 if (SvOBJECT(tmpRef)) {
7220 if (SvTYPE(tmpRef) != SVt_PVIO)
7222 SvREFCNT_dec(SvSTASH(tmpRef));
7225 SvOBJECT_on(tmpRef);
7226 if (SvTYPE(tmpRef) != SVt_PVIO)
7228 (void)SvUPGRADE(tmpRef, SVt_PVMG);
7229 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
7236 if(SvSMAGICAL(tmpRef))
7237 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7245 /* Downgrades a PVGV to a PVMG.
7247 * XXX This function doesn't actually appear to be used anywhere
7252 S_sv_unglob(pTHX_ SV *sv)
7256 assert(SvTYPE(sv) == SVt_PVGV);
7261 SvREFCNT_dec(GvSTASH(sv));
7262 GvSTASH(sv) = Nullhv;
7264 sv_unmagic(sv, PERL_MAGIC_glob);
7265 Safefree(GvNAME(sv));
7268 /* need to keep SvANY(sv) in the right arena */
7269 xpvmg = new_XPVMG();
7270 StructCopy(SvANY(sv), xpvmg, XPVMG);
7271 del_XPVGV(SvANY(sv));
7274 SvFLAGS(sv) &= ~SVTYPEMASK;
7275 SvFLAGS(sv) |= SVt_PVMG;
7279 =for apidoc sv_unref_flags
7281 Unsets the RV status of the SV, and decrements the reference count of
7282 whatever was being referenced by the RV. This can almost be thought of
7283 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7284 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7285 (otherwise the decrementing is conditional on the reference count being
7286 different from one or the reference being a readonly SV).
7293 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
7297 if (SvWEAKREF(sv)) {
7305 if (SvREFCNT(rv) != 1 || SvREADONLY(rv) || flags) /* SV_IMMEDIATE_UNREF */
7307 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7308 sv_2mortal(rv); /* Schedule for freeing later */
7312 =for apidoc sv_unref
7314 Unsets the RV status of the SV, and decrements the reference count of
7315 whatever was being referenced by the RV. This can almost be thought of
7316 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
7317 being zero. See C<SvROK_off>.
7323 Perl_sv_unref(pTHX_ SV *sv)
7325 sv_unref_flags(sv, 0);
7329 =for apidoc sv_taint
7331 Taint an SV. Use C<SvTAINTED_on> instead.
7336 Perl_sv_taint(pTHX_ SV *sv)
7338 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
7342 =for apidoc sv_untaint
7344 Untaint an SV. Use C<SvTAINTED_off> instead.
7349 Perl_sv_untaint(pTHX_ SV *sv)
7351 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7352 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7359 =for apidoc sv_tainted
7361 Test an SV for taintedness. Use C<SvTAINTED> instead.
7366 Perl_sv_tainted(pTHX_ SV *sv)
7368 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7369 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7370 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
7377 =for apidoc sv_setpviv
7379 Copies an integer into the given SV, also updating its string value.
7380 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7386 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7388 char buf[TYPE_CHARS(UV)];
7390 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7392 sv_setpvn(sv, ptr, ebuf - ptr);
7396 =for apidoc sv_setpviv_mg
7398 Like C<sv_setpviv>, but also handles 'set' magic.
7404 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7406 char buf[TYPE_CHARS(UV)];
7408 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7410 sv_setpvn(sv, ptr, ebuf - ptr);
7414 #if defined(PERL_IMPLICIT_CONTEXT)
7416 /* pTHX_ magic can't cope with varargs, so this is a no-context
7417 * version of the main function, (which may itself be aliased to us).
7418 * Don't access this version directly.
7422 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7426 va_start(args, pat);
7427 sv_vsetpvf(sv, pat, &args);
7431 /* pTHX_ magic can't cope with varargs, so this is a no-context
7432 * version of the main function, (which may itself be aliased to us).
7433 * Don't access this version directly.
7437 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7441 va_start(args, pat);
7442 sv_vsetpvf_mg(sv, pat, &args);
7448 =for apidoc sv_setpvf
7450 Processes its arguments like C<sprintf> and sets an SV to the formatted
7451 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7457 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7460 va_start(args, pat);
7461 sv_vsetpvf(sv, pat, &args);
7465 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
7468 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7470 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7474 =for apidoc sv_setpvf_mg
7476 Like C<sv_setpvf>, but also handles 'set' magic.
7482 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7485 va_start(args, pat);
7486 sv_vsetpvf_mg(sv, pat, &args);
7490 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
7493 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7495 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7499 #if defined(PERL_IMPLICIT_CONTEXT)
7501 /* pTHX_ magic can't cope with varargs, so this is a no-context
7502 * version of the main function, (which may itself be aliased to us).
7503 * Don't access this version directly.
7507 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7511 va_start(args, pat);
7512 sv_vcatpvf(sv, pat, &args);
7516 /* pTHX_ magic can't cope with varargs, so this is a no-context
7517 * version of the main function, (which may itself be aliased to us).
7518 * Don't access this version directly.
7522 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7526 va_start(args, pat);
7527 sv_vcatpvf_mg(sv, pat, &args);
7533 =for apidoc sv_catpvf
7535 Processes its arguments like C<sprintf> and appends the formatted
7536 output to an SV. If the appended data contains "wide" characters
7537 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7538 and characters >255 formatted with %c), the original SV might get
7539 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
7540 C<SvSETMAGIC()> must typically be called after calling this function
7541 to handle 'set' magic.
7546 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7549 va_start(args, pat);
7550 sv_vcatpvf(sv, pat, &args);
7554 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
7557 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7559 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7563 =for apidoc sv_catpvf_mg
7565 Like C<sv_catpvf>, but also handles 'set' magic.
7571 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7574 va_start(args, pat);
7575 sv_vcatpvf_mg(sv, pat, &args);
7579 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
7582 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7584 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7589 =for apidoc sv_vsetpvfn
7591 Works like C<vcatpvfn> but copies the text into the SV instead of
7594 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
7600 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7602 sv_setpvn(sv, "", 0);
7603 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7606 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7609 S_expect_number(pTHX_ char** pattern)
7612 switch (**pattern) {
7613 case '1': case '2': case '3':
7614 case '4': case '5': case '6':
7615 case '7': case '8': case '9':
7616 while (isDIGIT(**pattern))
7617 var = var * 10 + (*(*pattern)++ - '0');
7621 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7624 =for apidoc sv_vcatpvfn
7626 Processes its arguments like C<vsprintf> and appends the formatted output
7627 to an SV. Uses an array of SVs if the C style variable argument list is
7628 missing (NULL). When running with taint checks enabled, indicates via
7629 C<maybe_tainted> if results are untrustworthy (often due to the use of
7632 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
7638 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7645 static char nullstr[] = "(null)";
7648 /* no matter what, this is a string now */
7649 (void)SvPV_force(sv, origlen);
7651 /* special-case "", "%s", and "%_" */
7654 if (patlen == 2 && pat[0] == '%') {
7658 char *s = va_arg(*args, char*);
7659 sv_catpv(sv, s ? s : nullstr);
7661 else if (svix < svmax) {
7662 sv_catsv(sv, *svargs);
7663 if (DO_UTF8(*svargs))
7669 argsv = va_arg(*args, SV*);
7670 sv_catsv(sv, argsv);
7675 /* See comment on '_' below */
7680 patend = (char*)pat + patlen;
7681 for (p = (char*)pat; p < patend; p = q) {
7684 bool vectorize = FALSE;
7685 bool vectorarg = FALSE;
7686 bool vec_utf = FALSE;
7692 bool has_precis = FALSE;
7694 bool is_utf = FALSE;
7697 U8 utf8buf[UTF8_MAXLEN+1];
7698 STRLEN esignlen = 0;
7700 char *eptr = Nullch;
7702 /* Times 4: a decimal digit takes more than 3 binary digits.
7703 * NV_DIG: mantissa takes than many decimal digits.
7704 * Plus 32: Playing safe. */
7705 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7706 /* large enough for "%#.#f" --chip */
7707 /* what about long double NVs? --jhi */
7710 U8 *vecstr = Null(U8*);
7722 STRLEN dotstrlen = 1;
7723 I32 efix = 0; /* explicit format parameter index */
7724 I32 ewix = 0; /* explicit width index */
7725 I32 epix = 0; /* explicit precision index */
7726 I32 evix = 0; /* explicit vector index */
7727 bool asterisk = FALSE;
7729 /* echo everything up to the next format specification */
7730 for (q = p; q < patend && *q != '%'; ++q) ;
7732 sv_catpvn(sv, p, q - p);
7739 We allow format specification elements in this order:
7740 \d+\$ explicit format parameter index
7742 \*?(\d+\$)?v vector with optional (optionally specified) arg
7743 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7744 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7746 [%bcdefginopsux_DFOUX] format (mandatory)
7748 if (EXPECT_NUMBER(q, width)) {
7789 if (EXPECT_NUMBER(q, ewix))
7798 if ((vectorarg = asterisk)) {
7808 EXPECT_NUMBER(q, width);
7813 vecsv = va_arg(*args, SV*);
7815 vecsv = (evix ? evix <= svmax : svix < svmax) ?
7816 svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
7817 dotstr = SvPVx(vecsv, dotstrlen);
7822 vecsv = va_arg(*args, SV*);
7823 vecstr = (U8*)SvPVx(vecsv,veclen);
7824 vec_utf = DO_UTF8(vecsv);
7826 else if (efix ? efix <= svmax : svix < svmax) {
7827 vecsv = svargs[efix ? efix-1 : svix++];
7828 vecstr = (U8*)SvPVx(vecsv,veclen);
7829 vec_utf = DO_UTF8(vecsv);
7839 i = va_arg(*args, int);
7841 i = (ewix ? ewix <= svmax : svix < svmax) ?
7842 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
7844 width = (i < 0) ? -i : i;
7854 if (EXPECT_NUMBER(q, epix) && *q++ != '$') /* epix currently unused */
7857 i = va_arg(*args, int);
7859 i = (ewix ? ewix <= svmax : svix < svmax)
7860 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
7861 precis = (i < 0) ? 0 : i;
7866 precis = precis * 10 + (*q++ - '0');
7874 #if defined(HAS_QUAD) || (defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE))
7885 #if defined(HAS_QUAD) || (defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE))
7886 if (*(q + 1) == 'l') { /* lld, llf */
7909 argsv = (efix ? efix <= svmax : svix < svmax) ?
7910 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
7917 uv = args ? va_arg(*args, int) : SvIVx(argsv);
7919 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
7921 eptr = (char*)utf8buf;
7922 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
7934 eptr = va_arg(*args, char*);
7936 #ifdef MACOS_TRADITIONAL
7937 /* On MacOS, %#s format is used for Pascal strings */
7942 elen = strlen(eptr);
7945 elen = sizeof nullstr - 1;
7949 eptr = SvPVx(argsv, elen);
7950 if (DO_UTF8(argsv)) {
7951 if (has_precis && precis < elen) {
7953 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
7956 if (width) { /* fudge width (can't fudge elen) */
7957 width += elen - sv_len_utf8(argsv);
7966 * The "%_" hack might have to be changed someday,
7967 * if ISO or ANSI decide to use '_' for something.
7968 * So we keep it hidden from users' code.
7972 argsv = va_arg(*args, SV*);
7973 eptr = SvPVx(argsv, elen);
7979 if (has_precis && elen > precis)
7988 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8006 uv = utf8n_to_uvchr(vecstr, veclen, &ulen, UTF8_ALLOW_ANYUV);
8014 esignbuf[esignlen++] = plus;
8018 case 'h': iv = (short)va_arg(*args, int); break;
8019 default: iv = va_arg(*args, int); break;
8020 case 'l': iv = va_arg(*args, long); break;
8021 case 'V': iv = va_arg(*args, IV); break;
8023 case 'q': iv = va_arg(*args, Quad_t); break;
8030 case 'h': iv = (short)iv; break;
8032 case 'l': iv = (long)iv; break;
8035 case 'q': iv = (Quad_t)iv; break;
8039 if ( !vectorize ) /* we already set uv above */
8044 esignbuf[esignlen++] = plus;
8048 esignbuf[esignlen++] = '-';
8091 uv = utf8n_to_uvchr(vecstr, veclen, &ulen, UTF8_ALLOW_ANYUV);
8101 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8102 default: uv = va_arg(*args, unsigned); break;
8103 case 'l': uv = va_arg(*args, unsigned long); break;
8104 case 'V': uv = va_arg(*args, UV); break;
8106 case 'q': uv = va_arg(*args, Quad_t); break;
8113 case 'h': uv = (unsigned short)uv; break;
8115 case 'l': uv = (unsigned long)uv; break;
8118 case 'q': uv = (Quad_t)uv; break;
8124 eptr = ebuf + sizeof ebuf;
8130 p = (char*)((c == 'X')
8131 ? "0123456789ABCDEF" : "0123456789abcdef");
8137 esignbuf[esignlen++] = '0';
8138 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8144 *--eptr = '0' + dig;
8146 if (alt && *eptr != '0')
8152 *--eptr = '0' + dig;
8155 esignbuf[esignlen++] = '0';
8156 esignbuf[esignlen++] = 'b';
8159 default: /* it had better be ten or less */
8160 #if defined(PERL_Y2KWARN)
8161 if (ckWARN(WARN_Y2K)) {
8163 char *s = SvPV(sv,n);
8164 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
8165 && (n == 2 || !isDIGIT(s[n-3])))
8167 Perl_warner(aTHX_ WARN_Y2K,
8168 "Possible Y2K bug: %%%c %s",
8169 c, "format string following '19'");
8175 *--eptr = '0' + dig;
8176 } while (uv /= base);
8179 elen = (ebuf + sizeof ebuf) - eptr;
8182 zeros = precis - elen;
8183 else if (precis == 0 && elen == 1 && *eptr == '0')
8188 /* FLOATING POINT */
8191 c = 'f'; /* maybe %F isn't supported here */
8197 /* This is evil, but floating point is even more evil */
8200 nv = args ? va_arg(*args, NV) : SvNVx(argsv);
8203 if (c != 'e' && c != 'E') {
8205 (void)Perl_frexp(nv, &i);
8206 if (i == PERL_INT_MIN)
8207 Perl_die(aTHX_ "panic: frexp");
8209 need = BIT_DIGITS(i);
8211 need += has_precis ? precis : 6; /* known default */
8215 need += 20; /* fudge factor */
8216 if (PL_efloatsize < need) {
8217 Safefree(PL_efloatbuf);
8218 PL_efloatsize = need + 20; /* more fudge */
8219 New(906, PL_efloatbuf, PL_efloatsize, char);
8220 PL_efloatbuf[0] = '\0';
8223 eptr = ebuf + sizeof ebuf;
8226 #if defined(USE_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8228 /* Copy the one or more characters in a long double
8229 * format before the 'base' ([efgEFG]) character to
8230 * the format string. */
8231 static char const prifldbl[] = PERL_PRIfldbl;
8232 char const *p = prifldbl + sizeof(prifldbl) - 3;
8233 while (p >= prifldbl) { *--eptr = *p--; }
8238 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8243 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8255 /* No taint. Otherwise we are in the strange situation
8256 * where printf() taints but print($float) doesn't.
8258 (void)sprintf(PL_efloatbuf, eptr, nv);
8260 eptr = PL_efloatbuf;
8261 elen = strlen(PL_efloatbuf);
8268 i = SvCUR(sv) - origlen;
8271 case 'h': *(va_arg(*args, short*)) = i; break;
8272 default: *(va_arg(*args, int*)) = i; break;
8273 case 'l': *(va_arg(*args, long*)) = i; break;
8274 case 'V': *(va_arg(*args, IV*)) = i; break;
8276 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8281 sv_setuv_mg(argsv, (UV)i);
8282 continue; /* not "break" */
8289 if (!args && ckWARN(WARN_PRINTF) &&
8290 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
8291 SV *msg = sv_newmortal();
8292 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %s: ",
8293 (PL_op->op_type == OP_PRTF) ? "printf" : "sprintf");
8296 Perl_sv_catpvf(aTHX_ msg,
8297 "\"%%%c\"", c & 0xFF);
8299 Perl_sv_catpvf(aTHX_ msg,
8300 "\"%%\\%03"UVof"\"",
8303 sv_catpv(msg, "end of string");
8304 Perl_warner(aTHX_ WARN_PRINTF, "%"SVf, msg); /* yes, this is reentrant */
8307 /* output mangled stuff ... */
8313 /* ... right here, because formatting flags should not apply */
8314 SvGROW(sv, SvCUR(sv) + elen + 1);
8316 Copy(eptr, p, elen, char);
8319 SvCUR(sv) = p - SvPVX(sv);
8320 continue; /* not "break" */
8323 have = esignlen + zeros + elen;
8324 need = (have > width ? have : width);
8327 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8329 if (esignlen && fill == '0') {
8330 for (i = 0; i < esignlen; i++)
8334 memset(p, fill, gap);
8337 if (esignlen && fill != '0') {
8338 for (i = 0; i < esignlen; i++)
8342 for (i = zeros; i; i--)
8346 Copy(eptr, p, elen, char);
8350 memset(p, ' ', gap);
8355 Copy(dotstr, p, dotstrlen, char);
8359 vectorize = FALSE; /* done iterating over vecstr */
8364 SvCUR(sv) = p - SvPVX(sv);
8372 /* =========================================================================
8374 =head1 Cloning an interpreter
8376 All the macros and functions in this section are for the private use of
8377 the main function, perl_clone().
8379 The foo_dup() functions make an exact copy of an existing foo thinngy.
8380 During the course of a cloning, a hash table is used to map old addresses
8381 to new addresses. The table is created and manipulated with the
8382 ptr_table_* functions.
8386 ============================================================================*/
8389 #if defined(USE_ITHREADS)
8391 #if defined(USE_5005THREADS)
8392 # include "error: USE_5005THREADS and USE_ITHREADS are incompatible"
8395 #ifndef GpREFCNT_inc
8396 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8400 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8401 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8402 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8403 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8404 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8405 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8406 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8407 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8408 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8409 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8410 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8411 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8412 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8415 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8416 regcomp.c. AMS 20010712 */
8419 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
8423 struct reg_substr_datum *s;
8426 return (REGEXP *)NULL;
8428 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8431 len = r->offsets[0];
8432 npar = r->nparens+1;
8434 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8435 Copy(r->program, ret->program, len+1, regnode);
8437 New(0, ret->startp, npar, I32);
8438 Copy(r->startp, ret->startp, npar, I32);
8439 New(0, ret->endp, npar, I32);
8440 Copy(r->startp, ret->startp, npar, I32);
8442 New(0, ret->substrs, 1, struct reg_substr_data);
8443 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8444 s->min_offset = r->substrs->data[i].min_offset;
8445 s->max_offset = r->substrs->data[i].max_offset;
8446 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8449 ret->regstclass = NULL;
8452 int count = r->data->count;
8454 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
8455 char, struct reg_data);
8456 New(0, d->what, count, U8);
8459 for (i = 0; i < count; i++) {
8460 d->what[i] = r->data->what[i];
8461 switch (d->what[i]) {
8463 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8466 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8469 /* This is cheating. */
8470 New(0, d->data[i], 1, struct regnode_charclass_class);
8471 StructCopy(r->data->data[i], d->data[i],
8472 struct regnode_charclass_class);
8473 ret->regstclass = (regnode*)d->data[i];
8476 /* Compiled op trees are readonly, and can thus be
8477 shared without duplication. */
8478 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8481 d->data[i] = r->data->data[i];
8491 New(0, ret->offsets, 2*len+1, U32);
8492 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8494 ret->precomp = SAVEPV(r->precomp);
8495 ret->refcnt = r->refcnt;
8496 ret->minlen = r->minlen;
8497 ret->prelen = r->prelen;
8498 ret->nparens = r->nparens;
8499 ret->lastparen = r->lastparen;
8500 ret->lastcloseparen = r->lastcloseparen;
8501 ret->reganch = r->reganch;
8503 ret->sublen = r->sublen;
8505 if (RX_MATCH_COPIED(ret))
8506 ret->subbeg = SAVEPV(r->subbeg);
8508 ret->subbeg = Nullch;
8510 ptr_table_store(PL_ptr_table, r, ret);
8514 /* duplicate a file handle */
8517 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8521 return (PerlIO*)NULL;
8523 /* look for it in the table first */
8524 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8528 /* create anew and remember what it is */
8529 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8530 ptr_table_store(PL_ptr_table, fp, ret);
8534 /* duplicate a directory handle */
8537 Perl_dirp_dup(pTHX_ DIR *dp)
8545 /* duplicate a typeglob */
8548 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8553 /* look for it in the table first */
8554 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8558 /* create anew and remember what it is */
8559 Newz(0, ret, 1, GP);
8560 ptr_table_store(PL_ptr_table, gp, ret);
8563 ret->gp_refcnt = 0; /* must be before any other dups! */
8564 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
8565 ret->gp_io = io_dup_inc(gp->gp_io, param);
8566 ret->gp_form = cv_dup_inc(gp->gp_form, param);
8567 ret->gp_av = av_dup_inc(gp->gp_av, param);
8568 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
8569 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8570 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
8571 ret->gp_cvgen = gp->gp_cvgen;
8572 ret->gp_flags = gp->gp_flags;
8573 ret->gp_line = gp->gp_line;
8574 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
8578 /* duplicate a chain of magic */
8581 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8583 MAGIC *mgprev = (MAGIC*)NULL;
8586 return (MAGIC*)NULL;
8587 /* look for it in the table first */
8588 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8592 for (; mg; mg = mg->mg_moremagic) {
8594 Newz(0, nmg, 1, MAGIC);
8596 mgprev->mg_moremagic = nmg;
8599 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
8600 nmg->mg_private = mg->mg_private;
8601 nmg->mg_type = mg->mg_type;
8602 nmg->mg_flags = mg->mg_flags;
8603 if (mg->mg_type == PERL_MAGIC_qr) {
8604 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8606 else if(mg->mg_type == PERL_MAGIC_backref) {
8607 AV *av = (AV*) mg->mg_obj;
8610 nmg->mg_obj = (SV*)newAV();
8614 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8619 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
8620 ? sv_dup_inc(mg->mg_obj, param)
8621 : sv_dup(mg->mg_obj, param);
8623 nmg->mg_len = mg->mg_len;
8624 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
8625 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
8626 if (mg->mg_len >= 0) {
8627 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
8628 if (mg->mg_type == PERL_MAGIC_overload_table &&
8629 AMT_AMAGIC((AMT*)mg->mg_ptr))
8631 AMT *amtp = (AMT*)mg->mg_ptr;
8632 AMT *namtp = (AMT*)nmg->mg_ptr;
8634 for (i = 1; i < NofAMmeth; i++) {
8635 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
8639 else if (mg->mg_len == HEf_SVKEY)
8640 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
8647 /* create a new pointer-mapping table */
8650 Perl_ptr_table_new(pTHX)
8653 Newz(0, tbl, 1, PTR_TBL_t);
8656 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
8660 /* map an existing pointer using a table */
8663 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
8665 PTR_TBL_ENT_t *tblent;
8666 UV hash = PTR2UV(sv);
8668 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
8669 for (; tblent; tblent = tblent->next) {
8670 if (tblent->oldval == sv)
8671 return tblent->newval;
8676 /* add a new entry to a pointer-mapping table */
8679 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
8681 PTR_TBL_ENT_t *tblent, **otblent;
8682 /* XXX this may be pessimal on platforms where pointers aren't good
8683 * hash values e.g. if they grow faster in the most significant
8685 UV hash = PTR2UV(oldv);
8689 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
8690 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
8691 if (tblent->oldval == oldv) {
8692 tblent->newval = newv;
8697 Newz(0, tblent, 1, PTR_TBL_ENT_t);
8698 tblent->oldval = oldv;
8699 tblent->newval = newv;
8700 tblent->next = *otblent;
8703 if (i && tbl->tbl_items > tbl->tbl_max)
8704 ptr_table_split(tbl);
8707 /* double the hash bucket size of an existing ptr table */
8710 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
8712 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
8713 UV oldsize = tbl->tbl_max + 1;
8714 UV newsize = oldsize * 2;
8717 Renew(ary, newsize, PTR_TBL_ENT_t*);
8718 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
8719 tbl->tbl_max = --newsize;
8721 for (i=0; i < oldsize; i++, ary++) {
8722 PTR_TBL_ENT_t **curentp, **entp, *ent;
8725 curentp = ary + oldsize;
8726 for (entp = ary, ent = *ary; ent; ent = *entp) {
8727 if ((newsize & PTR2UV(ent->oldval)) != i) {
8729 ent->next = *curentp;
8739 /* remove all the entries from a ptr table */
8742 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
8744 register PTR_TBL_ENT_t **array;
8745 register PTR_TBL_ENT_t *entry;
8746 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
8750 if (!tbl || !tbl->tbl_items) {
8754 array = tbl->tbl_ary;
8761 entry = entry->next;
8765 if (++riter > max) {
8768 entry = array[riter];
8775 /* clear and free a ptr table */
8778 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
8783 ptr_table_clear(tbl);
8784 Safefree(tbl->tbl_ary);
8792 /* attempt to make everything in the typeglob readonly */
8795 S_gv_share(pTHX_ SV *sstr)
8798 SV *sv = &PL_sv_no; /* just need SvREADONLY-ness */
8800 if (GvIO(gv) || GvFORM(gv)) {
8801 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
8803 else if (!GvCV(gv)) {
8807 /* CvPADLISTs cannot be shared */
8808 if (!CvXSUB(GvCV(gv))) {
8813 if (!GvUNIQUE(gv)) {
8815 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
8816 HvNAME(GvSTASH(gv)), GvNAME(gv));
8822 * write attempts will die with
8823 * "Modification of a read-only value attempted"
8829 SvREADONLY_on(GvSV(gv));
8836 SvREADONLY_on(GvAV(gv));
8843 SvREADONLY_on(GvAV(gv));
8846 return sstr; /* he_dup() will SvREFCNT_inc() */
8849 /* duplicate an SV of any type (including AV, HV etc) */
8852 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
8856 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
8858 /* look for it in the table first */
8859 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
8863 /* create anew and remember what it is */
8865 ptr_table_store(PL_ptr_table, sstr, dstr);
8868 SvFLAGS(dstr) = SvFLAGS(sstr);
8869 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
8870 SvREFCNT(dstr) = 0; /* must be before any other dups! */
8873 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
8874 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
8875 PL_watch_pvx, SvPVX(sstr));
8878 switch (SvTYPE(sstr)) {
8883 SvANY(dstr) = new_XIV();
8884 SvIVX(dstr) = SvIVX(sstr);
8887 SvANY(dstr) = new_XNV();
8888 SvNVX(dstr) = SvNVX(sstr);
8891 SvANY(dstr) = new_XRV();
8892 SvRV(dstr) = SvRV(sstr) && SvWEAKREF(sstr)
8893 ? sv_dup(SvRV(sstr), param)
8894 : sv_dup_inc(SvRV(sstr), param);
8897 SvANY(dstr) = new_XPV();
8898 SvCUR(dstr) = SvCUR(sstr);
8899 SvLEN(dstr) = SvLEN(sstr);
8901 SvRV(dstr) = SvWEAKREF(sstr)
8902 ? sv_dup(SvRV(sstr), param)
8903 : sv_dup_inc(SvRV(sstr), param);
8904 else if (SvPVX(sstr) && SvLEN(sstr))
8905 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8907 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
8910 SvANY(dstr) = new_XPVIV();
8911 SvCUR(dstr) = SvCUR(sstr);
8912 SvLEN(dstr) = SvLEN(sstr);
8913 SvIVX(dstr) = SvIVX(sstr);
8915 SvRV(dstr) = SvWEAKREF(sstr)
8916 ? sv_dup(SvRV(sstr), param)
8917 : sv_dup_inc(SvRV(sstr), param);
8918 else if (SvPVX(sstr) && SvLEN(sstr))
8919 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8921 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
8924 SvANY(dstr) = new_XPVNV();
8925 SvCUR(dstr) = SvCUR(sstr);
8926 SvLEN(dstr) = SvLEN(sstr);
8927 SvIVX(dstr) = SvIVX(sstr);
8928 SvNVX(dstr) = SvNVX(sstr);
8930 SvRV(dstr) = SvWEAKREF(sstr)
8931 ? sv_dup(SvRV(sstr), param)
8932 : sv_dup_inc(SvRV(sstr), param);
8933 else if (SvPVX(sstr) && SvLEN(sstr))
8934 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8936 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
8939 SvANY(dstr) = new_XPVMG();
8940 SvCUR(dstr) = SvCUR(sstr);
8941 SvLEN(dstr) = SvLEN(sstr);
8942 SvIVX(dstr) = SvIVX(sstr);
8943 SvNVX(dstr) = SvNVX(sstr);
8944 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
8945 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
8947 SvRV(dstr) = SvWEAKREF(sstr)
8948 ? sv_dup(SvRV(sstr), param)
8949 : sv_dup_inc(SvRV(sstr), param);
8950 else if (SvPVX(sstr) && SvLEN(sstr))
8951 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8953 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
8956 SvANY(dstr) = new_XPVBM();
8957 SvCUR(dstr) = SvCUR(sstr);
8958 SvLEN(dstr) = SvLEN(sstr);
8959 SvIVX(dstr) = SvIVX(sstr);
8960 SvNVX(dstr) = SvNVX(sstr);
8961 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
8962 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
8964 SvRV(dstr) = SvWEAKREF(sstr)
8965 ? sv_dup(SvRV(sstr), param)
8966 : sv_dup_inc(SvRV(sstr), param);
8967 else if (SvPVX(sstr) && SvLEN(sstr))
8968 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8970 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
8971 BmRARE(dstr) = BmRARE(sstr);
8972 BmUSEFUL(dstr) = BmUSEFUL(sstr);
8973 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
8976 SvANY(dstr) = new_XPVLV();
8977 SvCUR(dstr) = SvCUR(sstr);
8978 SvLEN(dstr) = SvLEN(sstr);
8979 SvIVX(dstr) = SvIVX(sstr);
8980 SvNVX(dstr) = SvNVX(sstr);
8981 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
8982 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
8984 SvRV(dstr) = SvWEAKREF(sstr)
8985 ? sv_dup(SvRV(sstr), param)
8986 : sv_dup_inc(SvRV(sstr), param);
8987 else if (SvPVX(sstr) && SvLEN(sstr))
8988 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8990 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
8991 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
8992 LvTARGLEN(dstr) = LvTARGLEN(sstr);
8993 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
8994 LvTYPE(dstr) = LvTYPE(sstr);
8997 if (GvUNIQUE((GV*)sstr)) {
8999 if ((share = gv_share(sstr))) {
9003 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
9004 HvNAME(GvSTASH(share)), GvNAME(share));
9009 SvANY(dstr) = new_XPVGV();
9010 SvCUR(dstr) = SvCUR(sstr);
9011 SvLEN(dstr) = SvLEN(sstr);
9012 SvIVX(dstr) = SvIVX(sstr);
9013 SvNVX(dstr) = SvNVX(sstr);
9014 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9015 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9017 SvRV(dstr) = SvWEAKREF(sstr)
9018 ? sv_dup(SvRV(sstr), param)
9019 : sv_dup_inc(SvRV(sstr), param);
9020 else if (SvPVX(sstr) && SvLEN(sstr))
9021 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9023 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
9024 GvNAMELEN(dstr) = GvNAMELEN(sstr);
9025 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
9026 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
9027 GvFLAGS(dstr) = GvFLAGS(sstr);
9028 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9029 (void)GpREFCNT_inc(GvGP(dstr));
9032 SvANY(dstr) = new_XPVIO();
9033 SvCUR(dstr) = SvCUR(sstr);
9034 SvLEN(dstr) = SvLEN(sstr);
9035 SvIVX(dstr) = SvIVX(sstr);
9036 SvNVX(dstr) = SvNVX(sstr);
9037 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9038 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9040 SvRV(dstr) = SvWEAKREF(sstr)
9041 ? sv_dup(SvRV(sstr), param)
9042 : sv_dup_inc(SvRV(sstr), param);
9043 else if (SvPVX(sstr) && SvLEN(sstr))
9044 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9046 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
9047 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
9048 if (IoOFP(sstr) == IoIFP(sstr))
9049 IoOFP(dstr) = IoIFP(dstr);
9051 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
9052 /* PL_rsfp_filters entries have fake IoDIRP() */
9053 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
9054 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
9056 IoDIRP(dstr) = IoDIRP(sstr);
9057 IoLINES(dstr) = IoLINES(sstr);
9058 IoPAGE(dstr) = IoPAGE(sstr);
9059 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
9060 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
9061 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
9062 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
9063 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
9064 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
9065 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
9066 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
9067 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
9068 IoTYPE(dstr) = IoTYPE(sstr);
9069 IoFLAGS(dstr) = IoFLAGS(sstr);
9072 SvANY(dstr) = new_XPVAV();
9073 SvCUR(dstr) = SvCUR(sstr);
9074 SvLEN(dstr) = SvLEN(sstr);
9075 SvIVX(dstr) = SvIVX(sstr);
9076 SvNVX(dstr) = SvNVX(sstr);
9077 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9078 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9079 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
9080 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
9081 if (AvARRAY((AV*)sstr)) {
9082 SV **dst_ary, **src_ary;
9083 SSize_t items = AvFILLp((AV*)sstr) + 1;
9085 src_ary = AvARRAY((AV*)sstr);
9086 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
9087 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9088 SvPVX(dstr) = (char*)dst_ary;
9089 AvALLOC((AV*)dstr) = dst_ary;
9090 if (AvREAL((AV*)sstr)) {
9092 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9096 *dst_ary++ = sv_dup(*src_ary++, param);
9098 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9099 while (items-- > 0) {
9100 *dst_ary++ = &PL_sv_undef;
9104 SvPVX(dstr) = Nullch;
9105 AvALLOC((AV*)dstr) = (SV**)NULL;
9109 SvANY(dstr) = new_XPVHV();
9110 SvCUR(dstr) = SvCUR(sstr);
9111 SvLEN(dstr) = SvLEN(sstr);
9112 SvIVX(dstr) = SvIVX(sstr);
9113 SvNVX(dstr) = SvNVX(sstr);
9114 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9115 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9116 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
9117 if (HvARRAY((HV*)sstr)) {
9119 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
9120 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
9121 Newz(0, dxhv->xhv_array,
9122 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
9123 while (i <= sxhv->xhv_max) {
9124 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
9125 !!HvSHAREKEYS(sstr), param);
9128 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter, !!HvSHAREKEYS(sstr), param);
9131 SvPVX(dstr) = Nullch;
9132 HvEITER((HV*)dstr) = (HE*)NULL;
9134 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
9135 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
9136 /* Record stashes for possible cloning in Perl_clone(). */
9137 if(HvNAME((HV*)dstr))
9138 av_push(param->stashes, dstr);
9141 SvANY(dstr) = new_XPVFM();
9142 FmLINES(dstr) = FmLINES(sstr);
9146 SvANY(dstr) = new_XPVCV();
9148 SvCUR(dstr) = SvCUR(sstr);
9149 SvLEN(dstr) = SvLEN(sstr);
9150 SvIVX(dstr) = SvIVX(sstr);
9151 SvNVX(dstr) = SvNVX(sstr);
9152 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9153 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9154 if (SvPVX(sstr) && SvLEN(sstr))
9155 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9157 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
9158 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
9159 CvSTART(dstr) = CvSTART(sstr);
9160 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
9161 CvXSUB(dstr) = CvXSUB(sstr);
9162 CvXSUBANY(dstr) = CvXSUBANY(sstr);
9163 if (CvCONST(sstr)) {
9164 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
9165 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
9166 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
9168 CvGV(dstr) = gv_dup(CvGV(sstr), param);
9169 if (param->flags & CLONEf_COPY_STACKS) {
9170 CvDEPTH(dstr) = CvDEPTH(sstr);
9174 if (CvPADLIST(sstr) && !AvREAL(CvPADLIST(sstr))) {
9175 /* XXX padlists are real, but pretend to be not */
9176 AvREAL_on(CvPADLIST(sstr));
9177 CvPADLIST(dstr) = av_dup_inc(CvPADLIST(sstr), param);
9178 AvREAL_off(CvPADLIST(sstr));
9179 AvREAL_off(CvPADLIST(dstr));
9182 CvPADLIST(dstr) = av_dup_inc(CvPADLIST(sstr), param);
9183 if (!CvANON(sstr) || CvCLONED(sstr))
9184 CvOUTSIDE(dstr) = cv_dup_inc(CvOUTSIDE(sstr), param);
9186 CvOUTSIDE(dstr) = cv_dup(CvOUTSIDE(sstr), param);
9187 CvFLAGS(dstr) = CvFLAGS(sstr);
9188 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
9191 Perl_croak(aTHX_ "Bizarre SvTYPE [%d]", SvTYPE(sstr));
9195 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9201 /* duplicate a context */
9204 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9209 return (PERL_CONTEXT*)NULL;
9211 /* look for it in the table first */
9212 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9216 /* create anew and remember what it is */
9217 Newz(56, ncxs, max + 1, PERL_CONTEXT);
9218 ptr_table_store(PL_ptr_table, cxs, ncxs);
9221 PERL_CONTEXT *cx = &cxs[ix];
9222 PERL_CONTEXT *ncx = &ncxs[ix];
9223 ncx->cx_type = cx->cx_type;
9224 if (CxTYPE(cx) == CXt_SUBST) {
9225 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9228 ncx->blk_oldsp = cx->blk_oldsp;
9229 ncx->blk_oldcop = cx->blk_oldcop;
9230 ncx->blk_oldretsp = cx->blk_oldretsp;
9231 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9232 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9233 ncx->blk_oldpm = cx->blk_oldpm;
9234 ncx->blk_gimme = cx->blk_gimme;
9235 switch (CxTYPE(cx)) {
9237 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9238 ? cv_dup_inc(cx->blk_sub.cv, param)
9239 : cv_dup(cx->blk_sub.cv,param));
9240 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9241 ? av_dup_inc(cx->blk_sub.argarray, param)
9243 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9244 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9245 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9246 ncx->blk_sub.lval = cx->blk_sub.lval;
9249 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9250 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9251 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);;
9252 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9253 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9256 ncx->blk_loop.label = cx->blk_loop.label;
9257 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9258 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9259 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9260 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9261 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9262 ? cx->blk_loop.iterdata
9263 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9264 ncx->blk_loop.oldcurpad
9265 = (SV**)ptr_table_fetch(PL_ptr_table,
9266 cx->blk_loop.oldcurpad);
9267 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9268 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9269 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9270 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9271 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9274 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9275 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9276 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9277 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9289 /* duplicate a stack info structure */
9292 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9297 return (PERL_SI*)NULL;
9299 /* look for it in the table first */
9300 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9304 /* create anew and remember what it is */
9305 Newz(56, nsi, 1, PERL_SI);
9306 ptr_table_store(PL_ptr_table, si, nsi);
9308 nsi->si_stack = av_dup_inc(si->si_stack, param);
9309 nsi->si_cxix = si->si_cxix;
9310 nsi->si_cxmax = si->si_cxmax;
9311 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9312 nsi->si_type = si->si_type;
9313 nsi->si_prev = si_dup(si->si_prev, param);
9314 nsi->si_next = si_dup(si->si_next, param);
9315 nsi->si_markoff = si->si_markoff;
9320 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9321 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9322 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9323 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9324 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9325 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9326 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9327 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9328 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9329 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9330 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9331 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9334 #define pv_dup_inc(p) SAVEPV(p)
9335 #define pv_dup(p) SAVEPV(p)
9336 #define svp_dup_inc(p,pp) any_dup(p,pp)
9338 /* map any object to the new equivent - either something in the
9339 * ptr table, or something in the interpreter structure
9343 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
9350 /* look for it in the table first */
9351 ret = ptr_table_fetch(PL_ptr_table, v);
9355 /* see if it is part of the interpreter structure */
9356 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9357 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9364 /* duplicate the save stack */
9367 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9369 ANY *ss = proto_perl->Tsavestack;
9370 I32 ix = proto_perl->Tsavestack_ix;
9371 I32 max = proto_perl->Tsavestack_max;
9384 void (*dptr) (void*);
9385 void (*dxptr) (pTHX_ void*);
9388 Newz(54, nss, max, ANY);
9394 case SAVEt_ITEM: /* normal string */
9395 sv = (SV*)POPPTR(ss,ix);
9396 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9397 sv = (SV*)POPPTR(ss,ix);
9398 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9400 case SAVEt_SV: /* scalar reference */
9401 sv = (SV*)POPPTR(ss,ix);
9402 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9403 gv = (GV*)POPPTR(ss,ix);
9404 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9406 case SAVEt_GENERIC_PVREF: /* generic char* */
9407 c = (char*)POPPTR(ss,ix);
9408 TOPPTR(nss,ix) = pv_dup(c);
9409 ptr = POPPTR(ss,ix);
9410 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9412 case SAVEt_GENERIC_SVREF: /* generic sv */
9413 case SAVEt_SVREF: /* scalar reference */
9414 sv = (SV*)POPPTR(ss,ix);
9415 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9416 ptr = POPPTR(ss,ix);
9417 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9419 case SAVEt_AV: /* array reference */
9420 av = (AV*)POPPTR(ss,ix);
9421 TOPPTR(nss,ix) = av_dup_inc(av, param);
9422 gv = (GV*)POPPTR(ss,ix);
9423 TOPPTR(nss,ix) = gv_dup(gv, param);
9425 case SAVEt_HV: /* hash reference */
9426 hv = (HV*)POPPTR(ss,ix);
9427 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9428 gv = (GV*)POPPTR(ss,ix);
9429 TOPPTR(nss,ix) = gv_dup(gv, param);
9431 case SAVEt_INT: /* int reference */
9432 ptr = POPPTR(ss,ix);
9433 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9434 intval = (int)POPINT(ss,ix);
9435 TOPINT(nss,ix) = intval;
9437 case SAVEt_LONG: /* long reference */
9438 ptr = POPPTR(ss,ix);
9439 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9440 longval = (long)POPLONG(ss,ix);
9441 TOPLONG(nss,ix) = longval;
9443 case SAVEt_I32: /* I32 reference */
9444 case SAVEt_I16: /* I16 reference */
9445 case SAVEt_I8: /* I8 reference */
9446 ptr = POPPTR(ss,ix);
9447 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9451 case SAVEt_IV: /* IV reference */
9452 ptr = POPPTR(ss,ix);
9453 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9457 case SAVEt_SPTR: /* SV* reference */
9458 ptr = POPPTR(ss,ix);
9459 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9460 sv = (SV*)POPPTR(ss,ix);
9461 TOPPTR(nss,ix) = sv_dup(sv, param);
9463 case SAVEt_VPTR: /* random* reference */
9464 ptr = POPPTR(ss,ix);
9465 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9466 ptr = POPPTR(ss,ix);
9467 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9469 case SAVEt_PPTR: /* char* reference */
9470 ptr = POPPTR(ss,ix);
9471 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9472 c = (char*)POPPTR(ss,ix);
9473 TOPPTR(nss,ix) = pv_dup(c);
9475 case SAVEt_HPTR: /* HV* reference */
9476 ptr = POPPTR(ss,ix);
9477 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9478 hv = (HV*)POPPTR(ss,ix);
9479 TOPPTR(nss,ix) = hv_dup(hv, param);
9481 case SAVEt_APTR: /* AV* reference */
9482 ptr = POPPTR(ss,ix);
9483 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9484 av = (AV*)POPPTR(ss,ix);
9485 TOPPTR(nss,ix) = av_dup(av, param);
9488 gv = (GV*)POPPTR(ss,ix);
9489 TOPPTR(nss,ix) = gv_dup(gv, param);
9491 case SAVEt_GP: /* scalar reference */
9492 gp = (GP*)POPPTR(ss,ix);
9493 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9494 (void)GpREFCNT_inc(gp);
9495 gv = (GV*)POPPTR(ss,ix);
9496 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9497 c = (char*)POPPTR(ss,ix);
9498 TOPPTR(nss,ix) = pv_dup(c);
9505 case SAVEt_MORTALIZESV:
9506 sv = (SV*)POPPTR(ss,ix);
9507 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9510 ptr = POPPTR(ss,ix);
9511 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9512 /* these are assumed to be refcounted properly */
9513 switch (((OP*)ptr)->op_type) {
9520 TOPPTR(nss,ix) = ptr;
9525 TOPPTR(nss,ix) = Nullop;
9530 TOPPTR(nss,ix) = Nullop;
9533 c = (char*)POPPTR(ss,ix);
9534 TOPPTR(nss,ix) = pv_dup_inc(c);
9537 longval = POPLONG(ss,ix);
9538 TOPLONG(nss,ix) = longval;
9541 hv = (HV*)POPPTR(ss,ix);
9542 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9543 c = (char*)POPPTR(ss,ix);
9544 TOPPTR(nss,ix) = pv_dup_inc(c);
9548 case SAVEt_DESTRUCTOR:
9549 ptr = POPPTR(ss,ix);
9550 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9551 dptr = POPDPTR(ss,ix);
9552 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
9554 case SAVEt_DESTRUCTOR_X:
9555 ptr = POPPTR(ss,ix);
9556 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9557 dxptr = POPDXPTR(ss,ix);
9558 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
9560 case SAVEt_REGCONTEXT:
9566 case SAVEt_STACK_POS: /* Position on Perl stack */
9570 case SAVEt_AELEM: /* array element */
9571 sv = (SV*)POPPTR(ss,ix);
9572 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9575 av = (AV*)POPPTR(ss,ix);
9576 TOPPTR(nss,ix) = av_dup_inc(av, param);
9578 case SAVEt_HELEM: /* hash element */
9579 sv = (SV*)POPPTR(ss,ix);
9580 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9581 sv = (SV*)POPPTR(ss,ix);
9582 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9583 hv = (HV*)POPPTR(ss,ix);
9584 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9587 ptr = POPPTR(ss,ix);
9588 TOPPTR(nss,ix) = ptr;
9595 av = (AV*)POPPTR(ss,ix);
9596 TOPPTR(nss,ix) = av_dup(av, param);
9599 longval = (long)POPLONG(ss,ix);
9600 TOPLONG(nss,ix) = longval;
9601 ptr = POPPTR(ss,ix);
9602 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9603 sv = (SV*)POPPTR(ss,ix);
9604 TOPPTR(nss,ix) = sv_dup(sv, param);
9607 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9615 =for apidoc perl_clone
9617 Create and return a new interpreter by cloning the current one.
9622 /* XXX the above needs expanding by someone who actually understands it ! */
9623 EXTERN_C PerlInterpreter *
9624 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
9627 perl_clone(PerlInterpreter *proto_perl, UV flags)
9629 #ifdef PERL_IMPLICIT_SYS
9631 /* perlhost.h so we need to call into it
9632 to clone the host, CPerlHost should have a c interface, sky */
9634 if (flags & CLONEf_CLONE_HOST) {
9635 return perl_clone_host(proto_perl,flags);
9637 return perl_clone_using(proto_perl, flags,
9639 proto_perl->IMemShared,
9640 proto_perl->IMemParse,
9650 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
9651 struct IPerlMem* ipM, struct IPerlMem* ipMS,
9652 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
9653 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
9654 struct IPerlDir* ipD, struct IPerlSock* ipS,
9655 struct IPerlProc* ipP)
9657 /* XXX many of the string copies here can be optimized if they're
9658 * constants; they need to be allocated as common memory and just
9659 * their pointers copied. */
9662 CLONE_PARAMS* param = (CLONE_PARAMS*) malloc(sizeof(CLONE_PARAMS));
9664 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
9665 PERL_SET_THX(my_perl);
9668 memset(my_perl, 0xab, sizeof(PerlInterpreter));
9674 # else /* !DEBUGGING */
9675 Zero(my_perl, 1, PerlInterpreter);
9676 # endif /* DEBUGGING */
9680 PL_MemShared = ipMS;
9688 #else /* !PERL_IMPLICIT_SYS */
9690 CLONE_PARAMS* param = (CLONE_PARAMS*) malloc(sizeof(CLONE_PARAMS));
9691 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
9692 PERL_SET_THX(my_perl);
9697 memset(my_perl, 0xab, sizeof(PerlInterpreter));
9703 # else /* !DEBUGGING */
9704 Zero(my_perl, 1, PerlInterpreter);
9705 # endif /* DEBUGGING */
9706 #endif /* PERL_IMPLICIT_SYS */
9707 param->flags = flags;
9710 PL_xiv_arenaroot = NULL;
9712 PL_xnv_arenaroot = NULL;
9714 PL_xrv_arenaroot = NULL;
9716 PL_xpv_arenaroot = NULL;
9718 PL_xpviv_arenaroot = NULL;
9719 PL_xpviv_root = NULL;
9720 PL_xpvnv_arenaroot = NULL;
9721 PL_xpvnv_root = NULL;
9722 PL_xpvcv_arenaroot = NULL;
9723 PL_xpvcv_root = NULL;
9724 PL_xpvav_arenaroot = NULL;
9725 PL_xpvav_root = NULL;
9726 PL_xpvhv_arenaroot = NULL;
9727 PL_xpvhv_root = NULL;
9728 PL_xpvmg_arenaroot = NULL;
9729 PL_xpvmg_root = NULL;
9730 PL_xpvlv_arenaroot = NULL;
9731 PL_xpvlv_root = NULL;
9732 PL_xpvbm_arenaroot = NULL;
9733 PL_xpvbm_root = NULL;
9734 PL_he_arenaroot = NULL;
9736 PL_nice_chunk = NULL;
9737 PL_nice_chunk_size = 0;
9740 PL_sv_root = Nullsv;
9741 PL_sv_arenaroot = Nullsv;
9743 PL_debug = proto_perl->Idebug;
9745 #ifdef USE_REENTRANT_API
9746 New(31337, PL_reentrant_buffer,1, REBUF);
9747 New(31337, PL_reentrant_buffer->tmbuff,1, struct tm);
9750 /* create SV map for pointer relocation */
9751 PL_ptr_table = ptr_table_new();
9753 /* initialize these special pointers as early as possible */
9754 SvANY(&PL_sv_undef) = NULL;
9755 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
9756 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
9757 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
9759 SvANY(&PL_sv_no) = new_XPVNV();
9760 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
9761 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
9762 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
9763 SvCUR(&PL_sv_no) = 0;
9764 SvLEN(&PL_sv_no) = 1;
9765 SvNVX(&PL_sv_no) = 0;
9766 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
9768 SvANY(&PL_sv_yes) = new_XPVNV();
9769 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
9770 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
9771 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
9772 SvCUR(&PL_sv_yes) = 1;
9773 SvLEN(&PL_sv_yes) = 2;
9774 SvNVX(&PL_sv_yes) = 1;
9775 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
9777 /* create shared string table */
9778 PL_strtab = newHV();
9779 HvSHAREKEYS_off(PL_strtab);
9780 hv_ksplit(PL_strtab, 512);
9781 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
9783 PL_compiling = proto_perl->Icompiling;
9784 PL_compiling.cop_stashpv = SAVEPV(PL_compiling.cop_stashpv);
9785 PL_compiling.cop_file = SAVEPV(PL_compiling.cop_file);
9786 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
9787 if (!specialWARN(PL_compiling.cop_warnings))
9788 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
9789 if (!specialCopIO(PL_compiling.cop_io))
9790 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
9791 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
9793 /* pseudo environmental stuff */
9794 PL_origargc = proto_perl->Iorigargc;
9796 New(0, PL_origargv, i+1, char*);
9797 PL_origargv[i] = '\0';
9799 PL_origargv[i] = SAVEPV(proto_perl->Iorigargv[i]);
9802 param->stashes = newAV(); /* Setup array of objects to call clone on */
9804 #ifdef PERLIO_LAYERS
9805 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
9806 PerlIO_clone(aTHX_ proto_perl, param);
9809 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
9810 PL_incgv = gv_dup(proto_perl->Iincgv, param);
9811 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
9812 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
9813 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
9814 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
9817 PL_minus_c = proto_perl->Iminus_c;
9818 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
9819 PL_localpatches = proto_perl->Ilocalpatches;
9820 PL_splitstr = proto_perl->Isplitstr;
9821 PL_preprocess = proto_perl->Ipreprocess;
9822 PL_minus_n = proto_perl->Iminus_n;
9823 PL_minus_p = proto_perl->Iminus_p;
9824 PL_minus_l = proto_perl->Iminus_l;
9825 PL_minus_a = proto_perl->Iminus_a;
9826 PL_minus_F = proto_perl->Iminus_F;
9827 PL_doswitches = proto_perl->Idoswitches;
9828 PL_dowarn = proto_perl->Idowarn;
9829 PL_doextract = proto_perl->Idoextract;
9830 PL_sawampersand = proto_perl->Isawampersand;
9831 PL_unsafe = proto_perl->Iunsafe;
9832 PL_inplace = SAVEPV(proto_perl->Iinplace);
9833 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
9834 PL_perldb = proto_perl->Iperldb;
9835 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
9836 PL_exit_flags = proto_perl->Iexit_flags;
9838 /* magical thingies */
9839 /* XXX time(&PL_basetime) when asked for? */
9840 PL_basetime = proto_perl->Ibasetime;
9841 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
9843 PL_maxsysfd = proto_perl->Imaxsysfd;
9844 PL_multiline = proto_perl->Imultiline;
9845 PL_statusvalue = proto_perl->Istatusvalue;
9847 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
9849 PL_encoding = sv_dup(proto_perl->Iencoding, param);
9851 /* Clone the regex array */
9852 PL_regex_padav = newAV();
9854 I32 len = av_len((AV*)proto_perl->Iregex_padav);
9855 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
9856 av_push(PL_regex_padav,
9857 sv_dup_inc(regexen[0],param));
9858 for(i = 1; i <= len; i++) {
9859 if(SvREPADTMP(regexen[i])) {
9860 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
9862 av_push(PL_regex_padav,
9864 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
9865 SvIVX(regexen[i])), param)))
9870 PL_regex_pad = AvARRAY(PL_regex_padav);
9872 /* shortcuts to various I/O objects */
9873 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
9874 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
9875 PL_defgv = gv_dup(proto_perl->Idefgv, param);
9876 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
9877 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
9878 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
9880 /* shortcuts to regexp stuff */
9881 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
9883 /* shortcuts to misc objects */
9884 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
9886 /* shortcuts to debugging objects */
9887 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
9888 PL_DBline = gv_dup(proto_perl->IDBline, param);
9889 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
9890 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
9891 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
9892 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
9893 PL_lineary = av_dup(proto_perl->Ilineary, param);
9894 PL_dbargs = av_dup(proto_perl->Idbargs, param);
9897 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
9898 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
9899 PL_nullstash = hv_dup(proto_perl->Inullstash, param);
9900 PL_debstash = hv_dup(proto_perl->Idebstash, param);
9901 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
9902 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
9904 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
9905 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
9906 PL_endav = av_dup_inc(proto_perl->Iendav, param);
9907 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
9908 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
9910 PL_sub_generation = proto_perl->Isub_generation;
9912 /* funky return mechanisms */
9913 PL_forkprocess = proto_perl->Iforkprocess;
9915 /* subprocess state */
9916 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
9918 /* internal state */
9919 PL_tainting = proto_perl->Itainting;
9920 PL_maxo = proto_perl->Imaxo;
9921 if (proto_perl->Iop_mask)
9922 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
9924 PL_op_mask = Nullch;
9926 /* current interpreter roots */
9927 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
9928 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
9929 PL_main_start = proto_perl->Imain_start;
9930 PL_eval_root = proto_perl->Ieval_root;
9931 PL_eval_start = proto_perl->Ieval_start;
9933 /* runtime control stuff */
9934 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
9935 PL_copline = proto_perl->Icopline;
9937 PL_filemode = proto_perl->Ifilemode;
9938 PL_lastfd = proto_perl->Ilastfd;
9939 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
9942 PL_gensym = proto_perl->Igensym;
9943 PL_preambled = proto_perl->Ipreambled;
9944 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
9945 PL_laststatval = proto_perl->Ilaststatval;
9946 PL_laststype = proto_perl->Ilaststype;
9947 PL_mess_sv = Nullsv;
9949 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
9950 PL_ofmt = SAVEPV(proto_perl->Iofmt);
9952 /* interpreter atexit processing */
9953 PL_exitlistlen = proto_perl->Iexitlistlen;
9954 if (PL_exitlistlen) {
9955 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
9956 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
9959 PL_exitlist = (PerlExitListEntry*)NULL;
9960 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
9961 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
9962 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
9964 PL_profiledata = NULL;
9965 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
9966 /* PL_rsfp_filters entries have fake IoDIRP() */
9967 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
9969 PL_compcv = cv_dup(proto_perl->Icompcv, param);
9970 PL_comppad = av_dup(proto_perl->Icomppad, param);
9971 PL_comppad_name = av_dup(proto_perl->Icomppad_name, param);
9972 PL_comppad_name_fill = proto_perl->Icomppad_name_fill;
9973 PL_comppad_name_floor = proto_perl->Icomppad_name_floor;
9974 PL_curpad = (SV**)ptr_table_fetch(PL_ptr_table,
9975 proto_perl->Tcurpad);
9977 #ifdef HAVE_INTERP_INTERN
9978 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
9981 /* more statics moved here */
9982 PL_generation = proto_perl->Igeneration;
9983 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
9985 PL_in_clean_objs = proto_perl->Iin_clean_objs;
9986 PL_in_clean_all = proto_perl->Iin_clean_all;
9988 PL_uid = proto_perl->Iuid;
9989 PL_euid = proto_perl->Ieuid;
9990 PL_gid = proto_perl->Igid;
9991 PL_egid = proto_perl->Iegid;
9992 PL_nomemok = proto_perl->Inomemok;
9993 PL_an = proto_perl->Ian;
9994 PL_cop_seqmax = proto_perl->Icop_seqmax;
9995 PL_op_seqmax = proto_perl->Iop_seqmax;
9996 PL_evalseq = proto_perl->Ievalseq;
9997 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
9998 PL_origalen = proto_perl->Iorigalen;
9999 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10000 PL_osname = SAVEPV(proto_perl->Iosname);
10001 PL_sh_path = proto_perl->Ish_path; /* XXX never deallocated */
10002 PL_sighandlerp = proto_perl->Isighandlerp;
10005 PL_runops = proto_perl->Irunops;
10007 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10010 PL_cshlen = proto_perl->Icshlen;
10011 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10014 PL_lex_state = proto_perl->Ilex_state;
10015 PL_lex_defer = proto_perl->Ilex_defer;
10016 PL_lex_expect = proto_perl->Ilex_expect;
10017 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10018 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10019 PL_lex_starts = proto_perl->Ilex_starts;
10020 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10021 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10022 PL_lex_op = proto_perl->Ilex_op;
10023 PL_lex_inpat = proto_perl->Ilex_inpat;
10024 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10025 PL_lex_brackets = proto_perl->Ilex_brackets;
10026 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10027 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10028 PL_lex_casemods = proto_perl->Ilex_casemods;
10029 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10030 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10032 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10033 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10034 PL_nexttoke = proto_perl->Inexttoke;
10036 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10037 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
10038 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10039 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
10040 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10041 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
10042 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10043 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10044 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
10045 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10046 PL_pending_ident = proto_perl->Ipending_ident;
10047 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10049 PL_expect = proto_perl->Iexpect;
10051 PL_multi_start = proto_perl->Imulti_start;
10052 PL_multi_end = proto_perl->Imulti_end;
10053 PL_multi_open = proto_perl->Imulti_open;
10054 PL_multi_close = proto_perl->Imulti_close;
10056 PL_error_count = proto_perl->Ierror_count;
10057 PL_subline = proto_perl->Isubline;
10058 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10060 PL_min_intro_pending = proto_perl->Imin_intro_pending;
10061 PL_max_intro_pending = proto_perl->Imax_intro_pending;
10062 PL_padix = proto_perl->Ipadix;
10063 PL_padix_floor = proto_perl->Ipadix_floor;
10064 PL_pad_reset_pending = proto_perl->Ipad_reset_pending;
10066 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
10067 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10068 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
10069 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10070 PL_last_lop_op = proto_perl->Ilast_lop_op;
10071 PL_in_my = proto_perl->Iin_my;
10072 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10074 PL_cryptseen = proto_perl->Icryptseen;
10077 PL_hints = proto_perl->Ihints;
10079 PL_amagic_generation = proto_perl->Iamagic_generation;
10081 #ifdef USE_LOCALE_COLLATE
10082 PL_collation_ix = proto_perl->Icollation_ix;
10083 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10084 PL_collation_standard = proto_perl->Icollation_standard;
10085 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10086 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10087 #endif /* USE_LOCALE_COLLATE */
10089 #ifdef USE_LOCALE_NUMERIC
10090 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10091 PL_numeric_standard = proto_perl->Inumeric_standard;
10092 PL_numeric_local = proto_perl->Inumeric_local;
10093 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10094 #endif /* !USE_LOCALE_NUMERIC */
10096 /* utf8 character classes */
10097 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10098 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10099 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10100 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10101 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10102 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10103 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10104 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10105 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10106 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10107 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10108 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10109 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10110 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10111 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10112 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10113 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10114 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10117 PL_last_swash_hv = Nullhv; /* reinits on demand */
10118 PL_last_swash_klen = 0;
10119 PL_last_swash_key[0]= '\0';
10120 PL_last_swash_tmps = (U8*)NULL;
10121 PL_last_swash_slen = 0;
10123 /* perly.c globals */
10124 PL_yydebug = proto_perl->Iyydebug;
10125 PL_yynerrs = proto_perl->Iyynerrs;
10126 PL_yyerrflag = proto_perl->Iyyerrflag;
10127 PL_yychar = proto_perl->Iyychar;
10128 PL_yyval = proto_perl->Iyyval;
10129 PL_yylval = proto_perl->Iyylval;
10131 PL_glob_index = proto_perl->Iglob_index;
10132 PL_srand_called = proto_perl->Isrand_called;
10133 PL_uudmap['M'] = 0; /* reinits on demand */
10134 PL_bitcount = Nullch; /* reinits on demand */
10136 if (proto_perl->Ipsig_pend) {
10137 Newz(0, PL_psig_pend, SIG_SIZE, int);
10140 PL_psig_pend = (int*)NULL;
10143 if (proto_perl->Ipsig_ptr) {
10144 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
10145 Newz(0, PL_psig_name, SIG_SIZE, SV*);
10146 for (i = 1; i < SIG_SIZE; i++) {
10147 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10148 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10152 PL_psig_ptr = (SV**)NULL;
10153 PL_psig_name = (SV**)NULL;
10156 /* thrdvar.h stuff */
10158 if (flags & CLONEf_COPY_STACKS) {
10159 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10160 PL_tmps_ix = proto_perl->Ttmps_ix;
10161 PL_tmps_max = proto_perl->Ttmps_max;
10162 PL_tmps_floor = proto_perl->Ttmps_floor;
10163 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
10165 while (i <= PL_tmps_ix) {
10166 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10170 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10171 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10172 Newz(54, PL_markstack, i, I32);
10173 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10174 - proto_perl->Tmarkstack);
10175 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10176 - proto_perl->Tmarkstack);
10177 Copy(proto_perl->Tmarkstack, PL_markstack,
10178 PL_markstack_ptr - PL_markstack + 1, I32);
10180 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10181 * NOTE: unlike the others! */
10182 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10183 PL_scopestack_max = proto_perl->Tscopestack_max;
10184 Newz(54, PL_scopestack, PL_scopestack_max, I32);
10185 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10187 /* next push_return() sets PL_retstack[PL_retstack_ix]
10188 * NOTE: unlike the others! */
10189 PL_retstack_ix = proto_perl->Tretstack_ix;
10190 PL_retstack_max = proto_perl->Tretstack_max;
10191 Newz(54, PL_retstack, PL_retstack_max, OP*);
10192 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, I32);
10194 /* NOTE: si_dup() looks at PL_markstack */
10195 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10197 /* PL_curstack = PL_curstackinfo->si_stack; */
10198 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10199 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10201 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10202 PL_stack_base = AvARRAY(PL_curstack);
10203 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10204 - proto_perl->Tstack_base);
10205 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10207 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10208 * NOTE: unlike the others! */
10209 PL_savestack_ix = proto_perl->Tsavestack_ix;
10210 PL_savestack_max = proto_perl->Tsavestack_max;
10211 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
10212 PL_savestack = ss_dup(proto_perl, param);
10216 ENTER; /* perl_destruct() wants to LEAVE; */
10219 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10220 PL_top_env = &PL_start_env;
10222 PL_op = proto_perl->Top;
10225 PL_Xpv = (XPV*)NULL;
10226 PL_na = proto_perl->Tna;
10228 PL_statbuf = proto_perl->Tstatbuf;
10229 PL_statcache = proto_perl->Tstatcache;
10230 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10231 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10233 PL_timesbuf = proto_perl->Ttimesbuf;
10236 PL_tainted = proto_perl->Ttainted;
10237 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10238 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10239 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10240 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10241 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10242 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10243 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10244 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10245 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10247 PL_restartop = proto_perl->Trestartop;
10248 PL_in_eval = proto_perl->Tin_eval;
10249 PL_delaymagic = proto_perl->Tdelaymagic;
10250 PL_dirty = proto_perl->Tdirty;
10251 PL_localizing = proto_perl->Tlocalizing;
10253 #ifdef PERL_FLEXIBLE_EXCEPTIONS
10254 PL_protect = proto_perl->Tprotect;
10256 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10257 PL_av_fetch_sv = Nullsv;
10258 PL_hv_fetch_sv = Nullsv;
10259 Zero(&PL_hv_fetch_ent_mh, 1, HE); /* XXX */
10260 PL_modcount = proto_perl->Tmodcount;
10261 PL_lastgotoprobe = Nullop;
10262 PL_dumpindent = proto_perl->Tdumpindent;
10264 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10265 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10266 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10267 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10268 PL_sortcxix = proto_perl->Tsortcxix;
10269 PL_efloatbuf = Nullch; /* reinits on demand */
10270 PL_efloatsize = 0; /* reinits on demand */
10274 PL_screamfirst = NULL;
10275 PL_screamnext = NULL;
10276 PL_maxscream = -1; /* reinits on demand */
10277 PL_lastscream = Nullsv;
10279 PL_watchaddr = NULL;
10280 PL_watchok = Nullch;
10282 PL_regdummy = proto_perl->Tregdummy;
10283 PL_regcomp_parse = Nullch;
10284 PL_regxend = Nullch;
10285 PL_regcode = (regnode*)NULL;
10288 PL_regprecomp = Nullch;
10293 PL_seen_zerolen = 0;
10295 PL_regcomp_rx = (regexp*)NULL;
10297 PL_colorset = 0; /* reinits PL_colors[] */
10298 /*PL_colors[6] = {0,0,0,0,0,0};*/
10299 PL_reg_whilem_seen = 0;
10300 PL_reginput = Nullch;
10301 PL_regbol = Nullch;
10302 PL_regeol = Nullch;
10303 PL_regstartp = (I32*)NULL;
10304 PL_regendp = (I32*)NULL;
10305 PL_reglastparen = (U32*)NULL;
10306 PL_regtill = Nullch;
10307 PL_reg_start_tmp = (char**)NULL;
10308 PL_reg_start_tmpl = 0;
10309 PL_regdata = (struct reg_data*)NULL;
10312 PL_reg_eval_set = 0;
10314 PL_regprogram = (regnode*)NULL;
10316 PL_regcc = (CURCUR*)NULL;
10317 PL_reg_call_cc = (struct re_cc_state*)NULL;
10318 PL_reg_re = (regexp*)NULL;
10319 PL_reg_ganch = Nullch;
10320 PL_reg_sv = Nullsv;
10321 PL_reg_match_utf8 = FALSE;
10322 PL_reg_magic = (MAGIC*)NULL;
10324 PL_reg_oldcurpm = (PMOP*)NULL;
10325 PL_reg_curpm = (PMOP*)NULL;
10326 PL_reg_oldsaved = Nullch;
10327 PL_reg_oldsavedlen = 0;
10328 PL_reg_maxiter = 0;
10329 PL_reg_leftiter = 0;
10330 PL_reg_poscache = Nullch;
10331 PL_reg_poscache_size= 0;
10333 /* RE engine - function pointers */
10334 PL_regcompp = proto_perl->Tregcompp;
10335 PL_regexecp = proto_perl->Tregexecp;
10336 PL_regint_start = proto_perl->Tregint_start;
10337 PL_regint_string = proto_perl->Tregint_string;
10338 PL_regfree = proto_perl->Tregfree;
10340 PL_reginterp_cnt = 0;
10341 PL_reg_starttry = 0;
10343 /* Pluggable optimizer */
10344 PL_peepp = proto_perl->Tpeepp;
10346 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10347 ptr_table_free(PL_ptr_table);
10348 PL_ptr_table = NULL;
10351 /* Call the ->CLONE method, if it exists, for each of the stashes
10352 identified by sv_dup() above.
10354 while(av_len(param->stashes) != -1) {
10355 HV* stash = (HV*) av_shift(param->stashes);
10356 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10357 if (cloner && GvCV(cloner)) {
10362 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
10364 call_sv((SV*)GvCV(cloner), G_DISCARD);
10370 SvREFCNT_dec(param->stashes);
10376 #endif /* USE_ITHREADS */
10379 =for apidoc sv_recode_to_utf8
10381 The encoding is assumed to be an Encode object, on entry the PV
10382 of the sv is assumed to be octets in that encoding, and the sv
10383 will be converted into Unicode (and UTF-8).
10385 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10386 is not a reference, nothing is done to the sv. If the encoding is not
10387 an C<Encode::XS> Encoding object, bad things will happen.
10388 (See F<lib/encoding.pm> and L<Encode>).
10390 The PV of the sv is returned.
10395 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10397 if (SvPOK(sv) && !DO_UTF8(sv) && SvROK(encoding)) {
10408 XPUSHs(&PL_sv_yes);
10410 call_method("decode", G_SCALAR);
10414 s = SvPV(uni, len);
10415 if (s != SvPVX(sv)) {
10417 Move(s, SvPVX(sv), len, char);
10418 SvCUR_set(sv, len);