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 =head1 SV Manipulation Functions
221 =for apidoc sv_add_arena
223 Given a chunk of memory, link it to the head of the list of arenas,
224 and split it into a list of free SVs.
230 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
235 Zero(ptr, size, char);
237 /* The first SV in an arena isn't an SV. */
238 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
239 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
240 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
242 PL_sv_arenaroot = sva;
243 PL_sv_root = sva + 1;
245 svend = &sva[SvREFCNT(sva) - 1];
248 SvANY(sv) = (void *)(SV*)(sv + 1);
249 SvFLAGS(sv) = SVTYPEMASK;
253 SvFLAGS(sv) = SVTYPEMASK;
256 /* make some more SVs by adding another arena */
258 /* sv_mutex must be held while calling more_sv() */
265 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
266 PL_nice_chunk = Nullch;
267 PL_nice_chunk_size = 0;
270 char *chunk; /* must use New here to match call to */
271 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
272 sv_add_arena(chunk, 1008, 0);
278 /* visit(): call the named function for each non-free SV in the arenas. */
281 S_visit(pTHX_ SVFUNC_t f)
288 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
289 svend = &sva[SvREFCNT(sva)];
290 for (sv = sva + 1; sv < svend; ++sv) {
291 if (SvTYPE(sv) != SVTYPEMASK && SvREFCNT(sv)) {
302 /* called by sv_report_used() for each live SV */
305 do_report_used(pTHX_ SV *sv)
307 if (SvTYPE(sv) != SVTYPEMASK) {
308 PerlIO_printf(Perl_debug_log, "****\n");
315 =for apidoc sv_report_used
317 Dump the contents of all SVs not yet freed. (Debugging aid).
323 Perl_sv_report_used(pTHX)
326 visit(do_report_used);
330 /* called by sv_clean_objs() for each live SV */
333 do_clean_objs(pTHX_ SV *sv)
337 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
338 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
350 /* XXX Might want to check arrays, etc. */
353 /* called by sv_clean_objs() for each live SV */
355 #ifndef DISABLE_DESTRUCTOR_KLUDGE
357 do_clean_named_objs(pTHX_ SV *sv)
359 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
360 if ( SvOBJECT(GvSV(sv)) ||
361 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
362 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
363 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
364 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
366 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
374 =for apidoc sv_clean_objs
376 Attempt to destroy all objects not yet freed
382 Perl_sv_clean_objs(pTHX)
384 PL_in_clean_objs = TRUE;
385 visit(do_clean_objs);
386 #ifndef DISABLE_DESTRUCTOR_KLUDGE
387 /* some barnacles may yet remain, clinging to typeglobs */
388 visit(do_clean_named_objs);
390 PL_in_clean_objs = FALSE;
393 /* called by sv_clean_all() for each live SV */
396 do_clean_all(pTHX_ SV *sv)
398 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
399 SvFLAGS(sv) |= SVf_BREAK;
404 =for apidoc sv_clean_all
406 Decrement the refcnt of each remaining SV, possibly triggering a
407 cleanup. This function may have to be called multiple times to free
408 SVs which are in complex self-referential hierarchies.
414 Perl_sv_clean_all(pTHX)
417 PL_in_clean_all = TRUE;
418 cleaned = visit(do_clean_all);
419 PL_in_clean_all = FALSE;
424 =for apidoc sv_free_arenas
426 Deallocate the memory used by all arenas. Note that all the individual SV
427 heads and bodies within the arenas must already have been freed.
433 Perl_sv_free_arenas(pTHX)
437 XPV *arena, *arenanext;
439 /* Free arenas here, but be careful about fake ones. (We assume
440 contiguity of the fake ones with the corresponding real ones.) */
442 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
443 svanext = (SV*) SvANY(sva);
444 while (svanext && SvFAKE(svanext))
445 svanext = (SV*) SvANY(svanext);
448 Safefree((void *)sva);
451 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
452 arenanext = (XPV*)arena->xpv_pv;
455 PL_xiv_arenaroot = 0;
457 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
458 arenanext = (XPV*)arena->xpv_pv;
461 PL_xnv_arenaroot = 0;
463 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
464 arenanext = (XPV*)arena->xpv_pv;
467 PL_xrv_arenaroot = 0;
469 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
470 arenanext = (XPV*)arena->xpv_pv;
473 PL_xpv_arenaroot = 0;
475 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
476 arenanext = (XPV*)arena->xpv_pv;
479 PL_xpviv_arenaroot = 0;
481 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
482 arenanext = (XPV*)arena->xpv_pv;
485 PL_xpvnv_arenaroot = 0;
487 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
488 arenanext = (XPV*)arena->xpv_pv;
491 PL_xpvcv_arenaroot = 0;
493 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
494 arenanext = (XPV*)arena->xpv_pv;
497 PL_xpvav_arenaroot = 0;
499 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
500 arenanext = (XPV*)arena->xpv_pv;
503 PL_xpvhv_arenaroot = 0;
505 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
506 arenanext = (XPV*)arena->xpv_pv;
509 PL_xpvmg_arenaroot = 0;
511 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
512 arenanext = (XPV*)arena->xpv_pv;
515 PL_xpvlv_arenaroot = 0;
517 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
518 arenanext = (XPV*)arena->xpv_pv;
521 PL_xpvbm_arenaroot = 0;
523 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
524 arenanext = (XPV*)arena->xpv_pv;
530 Safefree(PL_nice_chunk);
531 PL_nice_chunk = Nullch;
532 PL_nice_chunk_size = 0;
538 =for apidoc report_uninit
540 Print appropriate "Use of uninitialized variable" warning
546 Perl_report_uninit(pTHX)
549 Perl_warner(aTHX_ WARN_UNINITIALIZED, PL_warn_uninit,
550 " in ", OP_DESC(PL_op));
552 Perl_warner(aTHX_ WARN_UNINITIALIZED, PL_warn_uninit, "", "");
555 /* grab a new IV body from the free list, allocating more if necessary */
566 * See comment in more_xiv() -- RAM.
568 PL_xiv_root = *(IV**)xiv;
570 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
573 /* return an IV body to the free list */
576 S_del_xiv(pTHX_ XPVIV *p)
578 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
580 *(IV**)xiv = PL_xiv_root;
585 /* allocate another arena's worth of IV bodies */
593 New(705, ptr, 1008/sizeof(XPV), XPV);
594 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
595 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
598 xivend = &xiv[1008 / sizeof(IV) - 1];
599 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
601 while (xiv < xivend) {
602 *(IV**)xiv = (IV *)(xiv + 1);
608 /* grab a new NV body from the free list, allocating more if necessary */
618 PL_xnv_root = *(NV**)xnv;
620 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
623 /* return an NV body to the free list */
626 S_del_xnv(pTHX_ XPVNV *p)
628 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
630 *(NV**)xnv = PL_xnv_root;
635 /* allocate another arena's worth of NV bodies */
643 New(711, ptr, 1008/sizeof(XPV), XPV);
644 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
645 PL_xnv_arenaroot = ptr;
648 xnvend = &xnv[1008 / sizeof(NV) - 1];
649 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
651 while (xnv < xnvend) {
652 *(NV**)xnv = (NV*)(xnv + 1);
658 /* grab a new struct xrv from the free list, allocating more if necessary */
668 PL_xrv_root = (XRV*)xrv->xrv_rv;
673 /* return a struct xrv to the free list */
676 S_del_xrv(pTHX_ XRV *p)
679 p->xrv_rv = (SV*)PL_xrv_root;
684 /* allocate another arena's worth of struct xrv */
690 register XRV* xrvend;
692 New(712, ptr, 1008/sizeof(XPV), XPV);
693 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
694 PL_xrv_arenaroot = ptr;
697 xrvend = &xrv[1008 / sizeof(XRV) - 1];
698 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
700 while (xrv < xrvend) {
701 xrv->xrv_rv = (SV*)(xrv + 1);
707 /* grab a new struct xpv from the free list, allocating more if necessary */
717 PL_xpv_root = (XPV*)xpv->xpv_pv;
722 /* return a struct xpv to the free list */
725 S_del_xpv(pTHX_ XPV *p)
728 p->xpv_pv = (char*)PL_xpv_root;
733 /* allocate another arena's worth of struct xpv */
739 register XPV* xpvend;
740 New(713, xpv, 1008/sizeof(XPV), XPV);
741 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
742 PL_xpv_arenaroot = xpv;
744 xpvend = &xpv[1008 / sizeof(XPV) - 1];
746 while (xpv < xpvend) {
747 xpv->xpv_pv = (char*)(xpv + 1);
753 /* grab a new struct xpviv from the free list, allocating more if necessary */
762 xpviv = PL_xpviv_root;
763 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
768 /* return a struct xpviv to the free list */
771 S_del_xpviv(pTHX_ XPVIV *p)
774 p->xpv_pv = (char*)PL_xpviv_root;
779 /* allocate another arena's worth of struct xpviv */
784 register XPVIV* xpviv;
785 register XPVIV* xpvivend;
786 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
787 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
788 PL_xpviv_arenaroot = xpviv;
790 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
791 PL_xpviv_root = ++xpviv;
792 while (xpviv < xpvivend) {
793 xpviv->xpv_pv = (char*)(xpviv + 1);
799 /* grab a new struct xpvnv from the free list, allocating more if necessary */
808 xpvnv = PL_xpvnv_root;
809 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
814 /* return a struct xpvnv to the free list */
817 S_del_xpvnv(pTHX_ XPVNV *p)
820 p->xpv_pv = (char*)PL_xpvnv_root;
825 /* allocate another arena's worth of struct xpvnv */
830 register XPVNV* xpvnv;
831 register XPVNV* xpvnvend;
832 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
833 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
834 PL_xpvnv_arenaroot = xpvnv;
836 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
837 PL_xpvnv_root = ++xpvnv;
838 while (xpvnv < xpvnvend) {
839 xpvnv->xpv_pv = (char*)(xpvnv + 1);
845 /* grab a new struct xpvcv from the free list, allocating more if necessary */
854 xpvcv = PL_xpvcv_root;
855 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
860 /* return a struct xpvcv to the free list */
863 S_del_xpvcv(pTHX_ XPVCV *p)
866 p->xpv_pv = (char*)PL_xpvcv_root;
871 /* allocate another arena's worth of struct xpvcv */
876 register XPVCV* xpvcv;
877 register XPVCV* xpvcvend;
878 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
879 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
880 PL_xpvcv_arenaroot = xpvcv;
882 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
883 PL_xpvcv_root = ++xpvcv;
884 while (xpvcv < xpvcvend) {
885 xpvcv->xpv_pv = (char*)(xpvcv + 1);
891 /* grab a new struct xpvav from the free list, allocating more if necessary */
900 xpvav = PL_xpvav_root;
901 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
906 /* return a struct xpvav to the free list */
909 S_del_xpvav(pTHX_ XPVAV *p)
912 p->xav_array = (char*)PL_xpvav_root;
917 /* allocate another arena's worth of struct xpvav */
922 register XPVAV* xpvav;
923 register XPVAV* xpvavend;
924 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
925 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
926 PL_xpvav_arenaroot = xpvav;
928 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
929 PL_xpvav_root = ++xpvav;
930 while (xpvav < xpvavend) {
931 xpvav->xav_array = (char*)(xpvav + 1);
934 xpvav->xav_array = 0;
937 /* grab a new struct xpvhv from the free list, allocating more if necessary */
946 xpvhv = PL_xpvhv_root;
947 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
952 /* return a struct xpvhv to the free list */
955 S_del_xpvhv(pTHX_ XPVHV *p)
958 p->xhv_array = (char*)PL_xpvhv_root;
963 /* allocate another arena's worth of struct xpvhv */
968 register XPVHV* xpvhv;
969 register XPVHV* xpvhvend;
970 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
971 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
972 PL_xpvhv_arenaroot = xpvhv;
974 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
975 PL_xpvhv_root = ++xpvhv;
976 while (xpvhv < xpvhvend) {
977 xpvhv->xhv_array = (char*)(xpvhv + 1);
980 xpvhv->xhv_array = 0;
983 /* grab a new struct xpvmg from the free list, allocating more if necessary */
992 xpvmg = PL_xpvmg_root;
993 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
998 /* return a struct xpvmg to the free list */
1001 S_del_xpvmg(pTHX_ XPVMG *p)
1004 p->xpv_pv = (char*)PL_xpvmg_root;
1009 /* allocate another arena's worth of struct xpvmg */
1014 register XPVMG* xpvmg;
1015 register XPVMG* xpvmgend;
1016 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1017 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1018 PL_xpvmg_arenaroot = xpvmg;
1020 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1021 PL_xpvmg_root = ++xpvmg;
1022 while (xpvmg < xpvmgend) {
1023 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1029 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1038 xpvlv = PL_xpvlv_root;
1039 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1044 /* return a struct xpvlv to the free list */
1047 S_del_xpvlv(pTHX_ XPVLV *p)
1050 p->xpv_pv = (char*)PL_xpvlv_root;
1055 /* allocate another arena's worth of struct xpvlv */
1060 register XPVLV* xpvlv;
1061 register XPVLV* xpvlvend;
1062 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1063 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1064 PL_xpvlv_arenaroot = xpvlv;
1066 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1067 PL_xpvlv_root = ++xpvlv;
1068 while (xpvlv < xpvlvend) {
1069 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1075 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1084 xpvbm = PL_xpvbm_root;
1085 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1090 /* return a struct xpvbm to the free list */
1093 S_del_xpvbm(pTHX_ XPVBM *p)
1096 p->xpv_pv = (char*)PL_xpvbm_root;
1101 /* allocate another arena's worth of struct xpvbm */
1106 register XPVBM* xpvbm;
1107 register XPVBM* xpvbmend;
1108 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1109 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1110 PL_xpvbm_arenaroot = xpvbm;
1112 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1113 PL_xpvbm_root = ++xpvbm;
1114 while (xpvbm < xpvbmend) {
1115 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1122 # define my_safemalloc(s) (void*)safexmalloc(717,s)
1123 # define my_safefree(p) safexfree((char*)p)
1125 # define my_safemalloc(s) (void*)safemalloc(s)
1126 # define my_safefree(p) safefree((char*)p)
1131 #define new_XIV() my_safemalloc(sizeof(XPVIV))
1132 #define del_XIV(p) my_safefree(p)
1134 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1135 #define del_XNV(p) my_safefree(p)
1137 #define new_XRV() my_safemalloc(sizeof(XRV))
1138 #define del_XRV(p) my_safefree(p)
1140 #define new_XPV() my_safemalloc(sizeof(XPV))
1141 #define del_XPV(p) my_safefree(p)
1143 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1144 #define del_XPVIV(p) my_safefree(p)
1146 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1147 #define del_XPVNV(p) my_safefree(p)
1149 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1150 #define del_XPVCV(p) my_safefree(p)
1152 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1153 #define del_XPVAV(p) my_safefree(p)
1155 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1156 #define del_XPVHV(p) my_safefree(p)
1158 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1159 #define del_XPVMG(p) my_safefree(p)
1161 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1162 #define del_XPVLV(p) my_safefree(p)
1164 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1165 #define del_XPVBM(p) my_safefree(p)
1169 #define new_XIV() (void*)new_xiv()
1170 #define del_XIV(p) del_xiv((XPVIV*) p)
1172 #define new_XNV() (void*)new_xnv()
1173 #define del_XNV(p) del_xnv((XPVNV*) p)
1175 #define new_XRV() (void*)new_xrv()
1176 #define del_XRV(p) del_xrv((XRV*) p)
1178 #define new_XPV() (void*)new_xpv()
1179 #define del_XPV(p) del_xpv((XPV *)p)
1181 #define new_XPVIV() (void*)new_xpviv()
1182 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1184 #define new_XPVNV() (void*)new_xpvnv()
1185 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1187 #define new_XPVCV() (void*)new_xpvcv()
1188 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1190 #define new_XPVAV() (void*)new_xpvav()
1191 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1193 #define new_XPVHV() (void*)new_xpvhv()
1194 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1196 #define new_XPVMG() (void*)new_xpvmg()
1197 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1199 #define new_XPVLV() (void*)new_xpvlv()
1200 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1202 #define new_XPVBM() (void*)new_xpvbm()
1203 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1207 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1208 #define del_XPVGV(p) my_safefree(p)
1210 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1211 #define del_XPVFM(p) my_safefree(p)
1213 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1214 #define del_XPVIO(p) my_safefree(p)
1217 =for apidoc sv_upgrade
1219 Upgrade an SV to a more complex form. Generally adds a new body type to the
1220 SV, then copies across as much information as possible from the old body.
1221 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1227 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1237 if (mt != SVt_PV && SvREADONLY(sv) && SvFAKE(sv)) {
1238 sv_force_normal(sv);
1241 if (SvTYPE(sv) == mt)
1245 (void)SvOOK_off(sv);
1247 switch (SvTYPE(sv)) {
1268 else if (mt < SVt_PVIV)
1285 pv = (char*)SvRV(sv);
1305 else if (mt == SVt_NV)
1316 del_XPVIV(SvANY(sv));
1326 del_XPVNV(SvANY(sv));
1334 magic = SvMAGIC(sv);
1335 stash = SvSTASH(sv);
1336 del_XPVMG(SvANY(sv));
1339 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1344 Perl_croak(aTHX_ "Can't upgrade to undef");
1346 SvANY(sv) = new_XIV();
1350 SvANY(sv) = new_XNV();
1354 SvANY(sv) = new_XRV();
1358 SvANY(sv) = new_XPV();
1364 SvANY(sv) = new_XPVIV();
1374 SvANY(sv) = new_XPVNV();
1382 SvANY(sv) = new_XPVMG();
1388 SvMAGIC(sv) = magic;
1389 SvSTASH(sv) = stash;
1392 SvANY(sv) = new_XPVLV();
1398 SvMAGIC(sv) = magic;
1399 SvSTASH(sv) = stash;
1406 SvANY(sv) = new_XPVAV();
1414 SvMAGIC(sv) = magic;
1415 SvSTASH(sv) = stash;
1421 SvANY(sv) = new_XPVHV();
1427 HvTOTALKEYS(sv) = 0;
1428 HvPLACEHOLDERS(sv) = 0;
1429 SvMAGIC(sv) = magic;
1430 SvSTASH(sv) = stash;
1437 SvANY(sv) = new_XPVCV();
1438 Zero(SvANY(sv), 1, XPVCV);
1444 SvMAGIC(sv) = magic;
1445 SvSTASH(sv) = stash;
1448 SvANY(sv) = new_XPVGV();
1454 SvMAGIC(sv) = magic;
1455 SvSTASH(sv) = stash;
1463 SvANY(sv) = new_XPVBM();
1469 SvMAGIC(sv) = magic;
1470 SvSTASH(sv) = stash;
1476 SvANY(sv) = new_XPVFM();
1477 Zero(SvANY(sv), 1, XPVFM);
1483 SvMAGIC(sv) = magic;
1484 SvSTASH(sv) = stash;
1487 SvANY(sv) = new_XPVIO();
1488 Zero(SvANY(sv), 1, XPVIO);
1494 SvMAGIC(sv) = magic;
1495 SvSTASH(sv) = stash;
1496 IoPAGE_LEN(sv) = 60;
1499 SvFLAGS(sv) &= ~SVTYPEMASK;
1505 =for apidoc sv_backoff
1507 Remove any string offset. You should normally use the C<SvOOK_off> macro
1514 Perl_sv_backoff(pTHX_ register SV *sv)
1518 char *s = SvPVX(sv);
1519 SvLEN(sv) += SvIVX(sv);
1520 SvPVX(sv) -= SvIVX(sv);
1522 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1524 SvFLAGS(sv) &= ~SVf_OOK;
1531 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1532 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1533 Use the C<SvGROW> wrapper instead.
1539 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1543 #ifdef HAS_64K_LIMIT
1544 if (newlen >= 0x10000) {
1545 PerlIO_printf(Perl_debug_log,
1546 "Allocation too large: %"UVxf"\n", (UV)newlen);
1549 #endif /* HAS_64K_LIMIT */
1552 if (SvTYPE(sv) < SVt_PV) {
1553 sv_upgrade(sv, SVt_PV);
1556 else if (SvOOK(sv)) { /* pv is offset? */
1559 if (newlen > SvLEN(sv))
1560 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1561 #ifdef HAS_64K_LIMIT
1562 if (newlen >= 0x10000)
1568 if (newlen > SvLEN(sv)) { /* need more room? */
1569 if (SvLEN(sv) && s) {
1570 #if defined(MYMALLOC) && !defined(LEAKTEST)
1571 STRLEN l = malloced_size((void*)SvPVX(sv));
1577 Renew(s,newlen,char);
1580 /* sv_force_normal_flags() must not try to unshare the new
1581 PVX we allocate below. AMS 20010713 */
1582 if (SvREADONLY(sv) && SvFAKE(sv)) {
1586 New(703, s, newlen, char);
1589 SvLEN_set(sv, newlen);
1595 =for apidoc sv_setiv
1597 Copies an integer into the given SV, upgrading first if necessary.
1598 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1604 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1606 SV_CHECK_THINKFIRST(sv);
1607 switch (SvTYPE(sv)) {
1609 sv_upgrade(sv, SVt_IV);
1612 sv_upgrade(sv, SVt_PVNV);
1616 sv_upgrade(sv, SVt_PVIV);
1625 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1628 (void)SvIOK_only(sv); /* validate number */
1634 =for apidoc sv_setiv_mg
1636 Like C<sv_setiv>, but also handles 'set' magic.
1642 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1649 =for apidoc sv_setuv
1651 Copies an unsigned integer into the given SV, upgrading first if necessary.
1652 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1658 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1660 /* With these two if statements:
1661 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1664 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1666 If you wish to remove them, please benchmark to see what the effect is
1668 if (u <= (UV)IV_MAX) {
1669 sv_setiv(sv, (IV)u);
1678 =for apidoc sv_setuv_mg
1680 Like C<sv_setuv>, but also handles 'set' magic.
1686 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1688 /* With these two if statements:
1689 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1692 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1694 If you wish to remove them, please benchmark to see what the effect is
1696 if (u <= (UV)IV_MAX) {
1697 sv_setiv(sv, (IV)u);
1707 =for apidoc sv_setnv
1709 Copies a double into the given SV, upgrading first if necessary.
1710 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1716 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1718 SV_CHECK_THINKFIRST(sv);
1719 switch (SvTYPE(sv)) {
1722 sv_upgrade(sv, SVt_NV);
1727 sv_upgrade(sv, SVt_PVNV);
1736 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1740 (void)SvNOK_only(sv); /* validate number */
1745 =for apidoc sv_setnv_mg
1747 Like C<sv_setnv>, but also handles 'set' magic.
1753 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1759 /* Print an "isn't numeric" warning, using a cleaned-up,
1760 * printable version of the offending string
1764 S_not_a_number(pTHX_ SV *sv)
1771 dsv = sv_2mortal(newSVpv("", 0));
1772 pv = sv_uni_display(dsv, sv, 10, 0);
1775 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1776 /* each *s can expand to 4 chars + "...\0",
1777 i.e. need room for 8 chars */
1780 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
1782 if (ch & 128 && !isPRINT_LC(ch)) {
1791 else if (ch == '\r') {
1795 else if (ch == '\f') {
1799 else if (ch == '\\') {
1803 else if (ch == '\0') {
1807 else if (isPRINT_LC(ch))
1824 Perl_warner(aTHX_ WARN_NUMERIC,
1825 "Argument \"%s\" isn't numeric in %s", pv,
1828 Perl_warner(aTHX_ WARN_NUMERIC,
1829 "Argument \"%s\" isn't numeric", pv);
1833 =for apidoc looks_like_number
1835 Test if the content of an SV looks like a number (or is a number).
1836 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1837 non-numeric warning), even if your atof() doesn't grok them.
1843 Perl_looks_like_number(pTHX_ SV *sv)
1845 register char *sbegin;
1852 else if (SvPOKp(sv))
1853 sbegin = SvPV(sv, len);
1855 return 1; /* Historic. Wrong? */
1856 return grok_number(sbegin, len, NULL);
1859 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1860 until proven guilty, assume that things are not that bad... */
1865 As 64 bit platforms often have an NV that doesn't preserve all bits of
1866 an IV (an assumption perl has been based on to date) it becomes necessary
1867 to remove the assumption that the NV always carries enough precision to
1868 recreate the IV whenever needed, and that the NV is the canonical form.
1869 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1870 precision as a side effect of conversion (which would lead to insanity
1871 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1872 1) to distinguish between IV/UV/NV slots that have cached a valid
1873 conversion where precision was lost and IV/UV/NV slots that have a
1874 valid conversion which has lost no precision
1875 2) to ensure that if a numeric conversion to one form is requested that
1876 would lose precision, the precise conversion (or differently
1877 imprecise conversion) is also performed and cached, to prevent
1878 requests for different numeric formats on the same SV causing
1879 lossy conversion chains. (lossless conversion chains are perfectly
1884 SvIOKp is true if the IV slot contains a valid value
1885 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1886 SvNOKp is true if the NV slot contains a valid value
1887 SvNOK is true only if the NV value is accurate
1890 while converting from PV to NV, check to see if converting that NV to an
1891 IV(or UV) would lose accuracy over a direct conversion from PV to
1892 IV(or UV). If it would, cache both conversions, return NV, but mark
1893 SV as IOK NOKp (ie not NOK).
1895 While converting from PV to IV, check to see if converting that IV to an
1896 NV would lose accuracy over a direct conversion from PV to NV. If it
1897 would, cache both conversions, flag similarly.
1899 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1900 correctly because if IV & NV were set NV *always* overruled.
1901 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1902 changes - now IV and NV together means that the two are interchangeable:
1903 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1905 The benefit of this is that operations such as pp_add know that if
1906 SvIOK is true for both left and right operands, then integer addition
1907 can be used instead of floating point (for cases where the result won't
1908 overflow). Before, floating point was always used, which could lead to
1909 loss of precision compared with integer addition.
1911 * making IV and NV equal status should make maths accurate on 64 bit
1913 * may speed up maths somewhat if pp_add and friends start to use
1914 integers when possible instead of fp. (Hopefully the overhead in
1915 looking for SvIOK and checking for overflow will not outweigh the
1916 fp to integer speedup)
1917 * will slow down integer operations (callers of SvIV) on "inaccurate"
1918 values, as the change from SvIOK to SvIOKp will cause a call into
1919 sv_2iv each time rather than a macro access direct to the IV slot
1920 * should speed up number->string conversion on integers as IV is
1921 favoured when IV and NV are equally accurate
1923 ####################################################################
1924 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1925 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1926 On the other hand, SvUOK is true iff UV.
1927 ####################################################################
1929 Your mileage will vary depending your CPU's relative fp to integer
1933 #ifndef NV_PRESERVES_UV
1934 # define IS_NUMBER_UNDERFLOW_IV 1
1935 # define IS_NUMBER_UNDERFLOW_UV 2
1936 # define IS_NUMBER_IV_AND_UV 2
1937 # define IS_NUMBER_OVERFLOW_IV 4
1938 # define IS_NUMBER_OVERFLOW_UV 5
1940 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1942 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1944 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1946 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1947 if (SvNVX(sv) < (NV)IV_MIN) {
1948 (void)SvIOKp_on(sv);
1951 return IS_NUMBER_UNDERFLOW_IV;
1953 if (SvNVX(sv) > (NV)UV_MAX) {
1954 (void)SvIOKp_on(sv);
1958 return IS_NUMBER_OVERFLOW_UV;
1960 (void)SvIOKp_on(sv);
1962 /* Can't use strtol etc to convert this string. (See truth table in
1964 if (SvNVX(sv) <= (UV)IV_MAX) {
1965 SvIVX(sv) = I_V(SvNVX(sv));
1966 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1967 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1969 /* Integer is imprecise. NOK, IOKp */
1971 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1974 SvUVX(sv) = U_V(SvNVX(sv));
1975 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1976 if (SvUVX(sv) == UV_MAX) {
1977 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1978 possibly be preserved by NV. Hence, it must be overflow.
1980 return IS_NUMBER_OVERFLOW_UV;
1982 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1984 /* Integer is imprecise. NOK, IOKp */
1986 return IS_NUMBER_OVERFLOW_IV;
1988 #endif /* !NV_PRESERVES_UV*/
1993 Return the integer value of an SV, doing any necessary string conversion,
1994 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2000 Perl_sv_2iv(pTHX_ register SV *sv)
2004 if (SvGMAGICAL(sv)) {
2009 return I_V(SvNVX(sv));
2011 if (SvPOKp(sv) && SvLEN(sv))
2014 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2015 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2021 if (SvTHINKFIRST(sv)) {
2024 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2025 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2026 return SvIV(tmpstr);
2027 return PTR2IV(SvRV(sv));
2029 if (SvREADONLY(sv) && SvFAKE(sv)) {
2030 sv_force_normal(sv);
2032 if (SvREADONLY(sv) && !SvOK(sv)) {
2033 if (ckWARN(WARN_UNINITIALIZED))
2040 return (IV)(SvUVX(sv));
2047 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2048 * without also getting a cached IV/UV from it at the same time
2049 * (ie PV->NV conversion should detect loss of accuracy and cache
2050 * IV or UV at same time to avoid this. NWC */
2052 if (SvTYPE(sv) == SVt_NV)
2053 sv_upgrade(sv, SVt_PVNV);
2055 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2056 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2057 certainly cast into the IV range at IV_MAX, whereas the correct
2058 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2060 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2061 SvIVX(sv) = I_V(SvNVX(sv));
2062 if (SvNVX(sv) == (NV) SvIVX(sv)
2063 #ifndef NV_PRESERVES_UV
2064 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2065 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2066 /* Don't flag it as "accurately an integer" if the number
2067 came from a (by definition imprecise) NV operation, and
2068 we're outside the range of NV integer precision */
2071 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2072 DEBUG_c(PerlIO_printf(Perl_debug_log,
2073 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2079 /* IV not precise. No need to convert from PV, as NV
2080 conversion would already have cached IV if it detected
2081 that PV->IV would be better than PV->NV->IV
2082 flags already correct - don't set public IOK. */
2083 DEBUG_c(PerlIO_printf(Perl_debug_log,
2084 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2089 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2090 but the cast (NV)IV_MIN rounds to a the value less (more
2091 negative) than IV_MIN which happens to be equal to SvNVX ??
2092 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2093 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2094 (NV)UVX == NVX are both true, but the values differ. :-(
2095 Hopefully for 2s complement IV_MIN is something like
2096 0x8000000000000000 which will be exact. NWC */
2099 SvUVX(sv) = U_V(SvNVX(sv));
2101 (SvNVX(sv) == (NV) SvUVX(sv))
2102 #ifndef NV_PRESERVES_UV
2103 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2104 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2105 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2106 /* Don't flag it as "accurately an integer" if the number
2107 came from a (by definition imprecise) NV operation, and
2108 we're outside the range of NV integer precision */
2114 DEBUG_c(PerlIO_printf(Perl_debug_log,
2115 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2119 return (IV)SvUVX(sv);
2122 else if (SvPOKp(sv) && SvLEN(sv)) {
2124 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2125 /* We want to avoid a possible problem when we cache an IV which
2126 may be later translated to an NV, and the resulting NV is not
2127 the same as the direct translation of the initial string
2128 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2129 be careful to ensure that the value with the .456 is around if the
2130 NV value is requested in the future).
2132 This means that if we cache such an IV, we need to cache the
2133 NV as well. Moreover, we trade speed for space, and do not
2134 cache the NV if we are sure it's not needed.
2137 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2138 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2139 == IS_NUMBER_IN_UV) {
2140 /* It's definitely an integer, only upgrade to PVIV */
2141 if (SvTYPE(sv) < SVt_PVIV)
2142 sv_upgrade(sv, SVt_PVIV);
2144 } else if (SvTYPE(sv) < SVt_PVNV)
2145 sv_upgrade(sv, SVt_PVNV);
2147 /* If NV preserves UV then we only use the UV value if we know that
2148 we aren't going to call atof() below. If NVs don't preserve UVs
2149 then the value returned may have more precision than atof() will
2150 return, even though value isn't perfectly accurate. */
2151 if ((numtype & (IS_NUMBER_IN_UV
2152 #ifdef NV_PRESERVES_UV
2155 )) == IS_NUMBER_IN_UV) {
2156 /* This won't turn off the public IOK flag if it was set above */
2157 (void)SvIOKp_on(sv);
2159 if (!(numtype & IS_NUMBER_NEG)) {
2161 if (value <= (UV)IV_MAX) {
2162 SvIVX(sv) = (IV)value;
2168 /* 2s complement assumption */
2169 if (value <= (UV)IV_MIN) {
2170 SvIVX(sv) = -(IV)value;
2172 /* Too negative for an IV. This is a double upgrade, but
2173 I'm assuming it will be rare. */
2174 if (SvTYPE(sv) < SVt_PVNV)
2175 sv_upgrade(sv, SVt_PVNV);
2179 SvNVX(sv) = -(NV)value;
2184 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2185 will be in the previous block to set the IV slot, and the next
2186 block to set the NV slot. So no else here. */
2188 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2189 != IS_NUMBER_IN_UV) {
2190 /* It wasn't an (integer that doesn't overflow the UV). */
2191 SvNVX(sv) = Atof(SvPVX(sv));
2193 if (! numtype && ckWARN(WARN_NUMERIC))
2196 #if defined(USE_LONG_DOUBLE)
2197 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2198 PTR2UV(sv), SvNVX(sv)));
2200 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2201 PTR2UV(sv), SvNVX(sv)));
2205 #ifdef NV_PRESERVES_UV
2206 (void)SvIOKp_on(sv);
2208 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2209 SvIVX(sv) = I_V(SvNVX(sv));
2210 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2213 /* Integer is imprecise. NOK, IOKp */
2215 /* UV will not work better than IV */
2217 if (SvNVX(sv) > (NV)UV_MAX) {
2219 /* Integer is inaccurate. NOK, IOKp, is UV */
2223 SvUVX(sv) = U_V(SvNVX(sv));
2224 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2225 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2229 /* Integer is imprecise. NOK, IOKp, is UV */
2235 #else /* NV_PRESERVES_UV */
2236 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2237 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2238 /* The IV slot will have been set from value returned by
2239 grok_number above. The NV slot has just been set using
2242 assert (SvIOKp(sv));
2244 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2245 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2246 /* Small enough to preserve all bits. */
2247 (void)SvIOKp_on(sv);
2249 SvIVX(sv) = I_V(SvNVX(sv));
2250 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2252 /* Assumption: first non-preserved integer is < IV_MAX,
2253 this NV is in the preserved range, therefore: */
2254 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2256 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs(SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2260 0 0 already failed to read UV.
2261 0 1 already failed to read UV.
2262 1 0 you won't get here in this case. IV/UV
2263 slot set, public IOK, Atof() unneeded.
2264 1 1 already read UV.
2265 so there's no point in sv_2iuv_non_preserve() attempting
2266 to use atol, strtol, strtoul etc. */
2267 if (sv_2iuv_non_preserve (sv, numtype)
2268 >= IS_NUMBER_OVERFLOW_IV)
2272 #endif /* NV_PRESERVES_UV */
2275 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2277 if (SvTYPE(sv) < SVt_IV)
2278 /* Typically the caller expects that sv_any is not NULL now. */
2279 sv_upgrade(sv, SVt_IV);
2282 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2283 PTR2UV(sv),SvIVX(sv)));
2284 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2290 Return the unsigned integer value of an SV, doing any necessary string
2291 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
2298 Perl_sv_2uv(pTHX_ register SV *sv)
2302 if (SvGMAGICAL(sv)) {
2307 return U_V(SvNVX(sv));
2308 if (SvPOKp(sv) && SvLEN(sv))
2311 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2312 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2318 if (SvTHINKFIRST(sv)) {
2321 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2322 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2323 return SvUV(tmpstr);
2324 return PTR2UV(SvRV(sv));
2326 if (SvREADONLY(sv) && SvFAKE(sv)) {
2327 sv_force_normal(sv);
2329 if (SvREADONLY(sv) && !SvOK(sv)) {
2330 if (ckWARN(WARN_UNINITIALIZED))
2340 return (UV)SvIVX(sv);
2344 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2345 * without also getting a cached IV/UV from it at the same time
2346 * (ie PV->NV conversion should detect loss of accuracy and cache
2347 * IV or UV at same time to avoid this. */
2348 /* IV-over-UV optimisation - choose to cache IV if possible */
2350 if (SvTYPE(sv) == SVt_NV)
2351 sv_upgrade(sv, SVt_PVNV);
2353 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2354 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2355 SvIVX(sv) = I_V(SvNVX(sv));
2356 if (SvNVX(sv) == (NV) SvIVX(sv)
2357 #ifndef NV_PRESERVES_UV
2358 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2359 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2360 /* Don't flag it as "accurately an integer" if the number
2361 came from a (by definition imprecise) NV operation, and
2362 we're outside the range of NV integer precision */
2365 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2366 DEBUG_c(PerlIO_printf(Perl_debug_log,
2367 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2373 /* IV not precise. No need to convert from PV, as NV
2374 conversion would already have cached IV if it detected
2375 that PV->IV would be better than PV->NV->IV
2376 flags already correct - don't set public IOK. */
2377 DEBUG_c(PerlIO_printf(Perl_debug_log,
2378 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2383 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2384 but the cast (NV)IV_MIN rounds to a the value less (more
2385 negative) than IV_MIN which happens to be equal to SvNVX ??
2386 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2387 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2388 (NV)UVX == NVX are both true, but the values differ. :-(
2389 Hopefully for 2s complement IV_MIN is something like
2390 0x8000000000000000 which will be exact. NWC */
2393 SvUVX(sv) = U_V(SvNVX(sv));
2395 (SvNVX(sv) == (NV) SvUVX(sv))
2396 #ifndef NV_PRESERVES_UV
2397 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2398 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2399 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2400 /* Don't flag it as "accurately an integer" if the number
2401 came from a (by definition imprecise) NV operation, and
2402 we're outside the range of NV integer precision */
2407 DEBUG_c(PerlIO_printf(Perl_debug_log,
2408 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2414 else if (SvPOKp(sv) && SvLEN(sv)) {
2416 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2418 /* We want to avoid a possible problem when we cache a UV which
2419 may be later translated to an NV, and the resulting NV is not
2420 the translation of the initial data.
2422 This means that if we cache such a UV, we need to cache the
2423 NV as well. Moreover, we trade speed for space, and do not
2424 cache the NV if not needed.
2427 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2428 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2429 == IS_NUMBER_IN_UV) {
2430 /* It's definitely an integer, only upgrade to PVIV */
2431 if (SvTYPE(sv) < SVt_PVIV)
2432 sv_upgrade(sv, SVt_PVIV);
2434 } else if (SvTYPE(sv) < SVt_PVNV)
2435 sv_upgrade(sv, SVt_PVNV);
2437 /* If NV preserves UV then we only use the UV value if we know that
2438 we aren't going to call atof() below. If NVs don't preserve UVs
2439 then the value returned may have more precision than atof() will
2440 return, even though it isn't accurate. */
2441 if ((numtype & (IS_NUMBER_IN_UV
2442 #ifdef NV_PRESERVES_UV
2445 )) == IS_NUMBER_IN_UV) {
2446 /* This won't turn off the public IOK flag if it was set above */
2447 (void)SvIOKp_on(sv);
2449 if (!(numtype & IS_NUMBER_NEG)) {
2451 if (value <= (UV)IV_MAX) {
2452 SvIVX(sv) = (IV)value;
2454 /* it didn't overflow, and it was positive. */
2459 /* 2s complement assumption */
2460 if (value <= (UV)IV_MIN) {
2461 SvIVX(sv) = -(IV)value;
2463 /* Too negative for an IV. This is a double upgrade, but
2464 I'm assuming it will be rare. */
2465 if (SvTYPE(sv) < SVt_PVNV)
2466 sv_upgrade(sv, SVt_PVNV);
2470 SvNVX(sv) = -(NV)value;
2476 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2477 != IS_NUMBER_IN_UV) {
2478 /* It wasn't an integer, or it overflowed the UV. */
2479 SvNVX(sv) = Atof(SvPVX(sv));
2481 if (! numtype && ckWARN(WARN_NUMERIC))
2484 #if defined(USE_LONG_DOUBLE)
2485 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2486 PTR2UV(sv), SvNVX(sv)));
2488 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2489 PTR2UV(sv), SvNVX(sv)));
2492 #ifdef NV_PRESERVES_UV
2493 (void)SvIOKp_on(sv);
2495 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2496 SvIVX(sv) = I_V(SvNVX(sv));
2497 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2500 /* Integer is imprecise. NOK, IOKp */
2502 /* UV will not work better than IV */
2504 if (SvNVX(sv) > (NV)UV_MAX) {
2506 /* Integer is inaccurate. NOK, IOKp, is UV */
2510 SvUVX(sv) = U_V(SvNVX(sv));
2511 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2512 NV preservse UV so can do correct comparison. */
2513 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2517 /* Integer is imprecise. NOK, IOKp, is UV */
2522 #else /* NV_PRESERVES_UV */
2523 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2524 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2525 /* The UV slot will have been set from value returned by
2526 grok_number above. The NV slot has just been set using
2529 assert (SvIOKp(sv));
2531 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2532 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2533 /* Small enough to preserve all bits. */
2534 (void)SvIOKp_on(sv);
2536 SvIVX(sv) = I_V(SvNVX(sv));
2537 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2539 /* Assumption: first non-preserved integer is < IV_MAX,
2540 this NV is in the preserved range, therefore: */
2541 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2543 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs(SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2546 sv_2iuv_non_preserve (sv, numtype);
2548 #endif /* NV_PRESERVES_UV */
2552 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2553 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2556 if (SvTYPE(sv) < SVt_IV)
2557 /* Typically the caller expects that sv_any is not NULL now. */
2558 sv_upgrade(sv, SVt_IV);
2562 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2563 PTR2UV(sv),SvUVX(sv)));
2564 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2570 Return the num value of an SV, doing any necessary string or integer
2571 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2578 Perl_sv_2nv(pTHX_ register SV *sv)
2582 if (SvGMAGICAL(sv)) {
2586 if (SvPOKp(sv) && SvLEN(sv)) {
2587 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2588 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
2590 return Atof(SvPVX(sv));
2594 return (NV)SvUVX(sv);
2596 return (NV)SvIVX(sv);
2599 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2600 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2606 if (SvTHINKFIRST(sv)) {
2609 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2610 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2611 return SvNV(tmpstr);
2612 return PTR2NV(SvRV(sv));
2614 if (SvREADONLY(sv) && SvFAKE(sv)) {
2615 sv_force_normal(sv);
2617 if (SvREADONLY(sv) && !SvOK(sv)) {
2618 if (ckWARN(WARN_UNINITIALIZED))
2623 if (SvTYPE(sv) < SVt_NV) {
2624 if (SvTYPE(sv) == SVt_IV)
2625 sv_upgrade(sv, SVt_PVNV);
2627 sv_upgrade(sv, SVt_NV);
2628 #ifdef USE_LONG_DOUBLE
2630 STORE_NUMERIC_LOCAL_SET_STANDARD();
2631 PerlIO_printf(Perl_debug_log,
2632 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2633 PTR2UV(sv), SvNVX(sv));
2634 RESTORE_NUMERIC_LOCAL();
2638 STORE_NUMERIC_LOCAL_SET_STANDARD();
2639 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2640 PTR2UV(sv), SvNVX(sv));
2641 RESTORE_NUMERIC_LOCAL();
2645 else if (SvTYPE(sv) < SVt_PVNV)
2646 sv_upgrade(sv, SVt_PVNV);
2651 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
2652 #ifdef NV_PRESERVES_UV
2655 /* Only set the public NV OK flag if this NV preserves the IV */
2656 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2657 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2658 : (SvIVX(sv) == I_V(SvNVX(sv))))
2664 else if (SvPOKp(sv) && SvLEN(sv)) {
2666 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2667 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2669 #ifdef NV_PRESERVES_UV
2670 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2671 == IS_NUMBER_IN_UV) {
2672 /* It's definitely an integer */
2673 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
2675 SvNVX(sv) = Atof(SvPVX(sv));
2678 SvNVX(sv) = Atof(SvPVX(sv));
2679 /* Only set the public NV OK flag if this NV preserves the value in
2680 the PV at least as well as an IV/UV would.
2681 Not sure how to do this 100% reliably. */
2682 /* if that shift count is out of range then Configure's test is
2683 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2685 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2686 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2687 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2688 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2689 /* Can't use strtol etc to convert this string, so don't try.
2690 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2693 /* value has been set. It may not be precise. */
2694 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2695 /* 2s complement assumption for (UV)IV_MIN */
2696 SvNOK_on(sv); /* Integer is too negative. */
2701 if (numtype & IS_NUMBER_NEG) {
2702 SvIVX(sv) = -(IV)value;
2703 } else if (value <= (UV)IV_MAX) {
2704 SvIVX(sv) = (IV)value;
2710 if (numtype & IS_NUMBER_NOT_INT) {
2711 /* I believe that even if the original PV had decimals,
2712 they are lost beyond the limit of the FP precision.
2713 However, neither is canonical, so both only get p
2714 flags. NWC, 2000/11/25 */
2715 /* Both already have p flags, so do nothing */
2718 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2719 if (SvIVX(sv) == I_V(nv)) {
2724 /* It had no "." so it must be integer. */
2727 /* between IV_MAX and NV(UV_MAX).
2728 Could be slightly > UV_MAX */
2730 if (numtype & IS_NUMBER_NOT_INT) {
2731 /* UV and NV both imprecise. */
2733 UV nv_as_uv = U_V(nv);
2735 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2746 #endif /* NV_PRESERVES_UV */
2749 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2751 if (SvTYPE(sv) < SVt_NV)
2752 /* Typically the caller expects that sv_any is not NULL now. */
2753 /* XXX Ilya implies that this is a bug in callers that assume this
2754 and ideally should be fixed. */
2755 sv_upgrade(sv, SVt_NV);
2758 #if defined(USE_LONG_DOUBLE)
2760 STORE_NUMERIC_LOCAL_SET_STANDARD();
2761 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2762 PTR2UV(sv), SvNVX(sv));
2763 RESTORE_NUMERIC_LOCAL();
2767 STORE_NUMERIC_LOCAL_SET_STANDARD();
2768 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2769 PTR2UV(sv), SvNVX(sv));
2770 RESTORE_NUMERIC_LOCAL();
2776 /* asIV(): extract an integer from the string value of an SV.
2777 * Caller must validate PVX */
2780 S_asIV(pTHX_ SV *sv)
2783 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2785 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2786 == IS_NUMBER_IN_UV) {
2787 /* It's definitely an integer */
2788 if (numtype & IS_NUMBER_NEG) {
2789 if (value < (UV)IV_MIN)
2792 if (value < (UV)IV_MAX)
2797 if (ckWARN(WARN_NUMERIC))
2800 return I_V(Atof(SvPVX(sv)));
2803 /* asUV(): extract an unsigned integer from the string value of an SV
2804 * Caller must validate PVX */
2807 S_asUV(pTHX_ SV *sv)
2810 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2812 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2813 == IS_NUMBER_IN_UV) {
2814 /* It's definitely an integer */
2815 if (!(numtype & IS_NUMBER_NEG))
2819 if (ckWARN(WARN_NUMERIC))
2822 return U_V(Atof(SvPVX(sv)));
2826 =for apidoc sv_2pv_nolen
2828 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2829 use the macro wrapper C<SvPV_nolen(sv)> instead.
2834 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2837 return sv_2pv(sv, &n_a);
2840 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2841 * UV as a string towards the end of buf, and return pointers to start and
2844 * We assume that buf is at least TYPE_CHARS(UV) long.
2848 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2850 char *ptr = buf + TYPE_CHARS(UV);
2864 *--ptr = '0' + (uv % 10);
2872 /* For backwards-compatibility only. sv_2pv() is normally #def'ed to
2873 * C<sv_2pv_macro()>. See also C<sv_2pv_flags()>.
2877 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2879 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2883 =for apidoc sv_2pv_flags
2885 Returns a pointer to the string value of an SV, and sets *lp to its length.
2886 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2888 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2889 usually end up here too.
2895 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2900 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2901 char *tmpbuf = tbuf;
2907 if (SvGMAGICAL(sv)) {
2908 if (flags & SV_GMAGIC)
2916 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2918 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2923 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2928 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2929 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2936 if (SvTHINKFIRST(sv)) {
2939 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2940 (SvTYPE(tmpstr) != SVt_RV || (SvRV(tmpstr) != SvRV(sv))))
2941 return SvPV(tmpstr,*lp);
2948 switch (SvTYPE(sv)) {
2950 if ( ((SvFLAGS(sv) &
2951 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2952 == (SVs_OBJECT|SVs_RMG))
2953 && strEQ(s=HvNAME(SvSTASH(sv)), "Regexp")
2954 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2955 regexp *re = (regexp *)mg->mg_obj;
2958 char *fptr = "msix";
2963 U16 reganch = (re->reganch & PMf_COMPILETIME) >> 12;
2965 while((ch = *fptr++)) {
2967 reflags[left++] = ch;
2970 reflags[right--] = ch;
2975 reflags[left] = '-';
2979 mg->mg_len = re->prelen + 4 + left;
2980 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
2981 Copy("(?", mg->mg_ptr, 2, char);
2982 Copy(reflags, mg->mg_ptr+2, left, char);
2983 Copy(":", mg->mg_ptr+left+2, 1, char);
2984 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2985 mg->mg_ptr[mg->mg_len - 1] = ')';
2986 mg->mg_ptr[mg->mg_len] = 0;
2988 PL_reginterp_cnt += re->program[0].next_off;
3000 case SVt_PVBM: if (SvROK(sv))
3003 s = "SCALAR"; break;
3004 case SVt_PVLV: s = "LVALUE"; break;
3005 case SVt_PVAV: s = "ARRAY"; break;
3006 case SVt_PVHV: s = "HASH"; break;
3007 case SVt_PVCV: s = "CODE"; break;
3008 case SVt_PVGV: s = "GLOB"; break;
3009 case SVt_PVFM: s = "FORMAT"; break;
3010 case SVt_PVIO: s = "IO"; break;
3011 default: s = "UNKNOWN"; break;
3015 HV *svs = SvSTASH(sv);
3018 /* [20011101.072] This bandaid for C<package;>
3019 should eventually be removed. AMS 20011103 */
3020 (svs ? HvNAME(svs) : "<none>"), s
3025 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3031 if (SvREADONLY(sv) && !SvOK(sv)) {
3032 if (ckWARN(WARN_UNINITIALIZED))
3038 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3039 /* I'm assuming that if both IV and NV are equally valid then
3040 converting the IV is going to be more efficient */
3041 U32 isIOK = SvIOK(sv);
3042 U32 isUIOK = SvIsUV(sv);
3043 char buf[TYPE_CHARS(UV)];
3046 if (SvTYPE(sv) < SVt_PVIV)
3047 sv_upgrade(sv, SVt_PVIV);
3049 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3051 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3052 SvGROW(sv, ebuf - ptr + 1); /* inlined from sv_setpvn */
3053 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3054 SvCUR_set(sv, ebuf - ptr);
3064 else if (SvNOKp(sv)) {
3065 if (SvTYPE(sv) < SVt_PVNV)
3066 sv_upgrade(sv, SVt_PVNV);
3067 /* The +20 is pure guesswork. Configure test needed. --jhi */
3068 SvGROW(sv, NV_DIG + 20);
3070 olderrno = errno; /* some Xenix systems wipe out errno here */
3072 if (SvNVX(sv) == 0.0)
3073 (void)strcpy(s,"0");
3077 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3080 #ifdef FIXNEGATIVEZERO
3081 if (*s == '-' && s[1] == '0' && !s[2])
3091 if (ckWARN(WARN_UNINITIALIZED)
3092 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3095 if (SvTYPE(sv) < SVt_PV)
3096 /* Typically the caller expects that sv_any is not NULL now. */
3097 sv_upgrade(sv, SVt_PV);
3100 *lp = s - SvPVX(sv);
3103 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3104 PTR2UV(sv),SvPVX(sv)));
3108 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3109 /* Sneaky stuff here */
3113 tsv = newSVpv(tmpbuf, 0);
3129 len = strlen(tmpbuf);
3131 #ifdef FIXNEGATIVEZERO
3132 if (len == 2 && t[0] == '-' && t[1] == '0') {
3137 (void)SvUPGRADE(sv, SVt_PV);
3139 s = SvGROW(sv, len + 1);
3148 =for apidoc sv_2pvbyte_nolen
3150 Return a pointer to the byte-encoded representation of the SV.
3151 May cause the SV to be downgraded from UTF8 as a side-effect.
3153 Usually accessed via the C<SvPVbyte_nolen> macro.
3159 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3162 return sv_2pvbyte(sv, &n_a);
3166 =for apidoc sv_2pvbyte
3168 Return a pointer to the byte-encoded representation of the SV, and set *lp
3169 to its length. May cause the SV to be downgraded from UTF8 as a
3172 Usually accessed via the C<SvPVbyte> macro.
3178 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3180 sv_utf8_downgrade(sv,0);
3181 return SvPV(sv,*lp);
3185 =for apidoc sv_2pvutf8_nolen
3187 Return a pointer to the UTF8-encoded representation of the SV.
3188 May cause the SV to be upgraded to UTF8 as a side-effect.
3190 Usually accessed via the C<SvPVutf8_nolen> macro.
3196 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3199 return sv_2pvutf8(sv, &n_a);
3203 =for apidoc sv_2pvutf8
3205 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3206 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3208 Usually accessed via the C<SvPVutf8> macro.
3214 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3216 sv_utf8_upgrade(sv);
3217 return SvPV(sv,*lp);
3221 =for apidoc sv_2bool
3223 This function is only called on magical items, and is only used by
3224 sv_true() or its macro equivalent.
3230 Perl_sv_2bool(pTHX_ register SV *sv)
3239 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3240 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3241 return SvTRUE(tmpsv);
3242 return SvRV(sv) != 0;
3245 register XPV* Xpvtmp;
3246 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3247 (*Xpvtmp->xpv_pv > '0' ||
3248 Xpvtmp->xpv_cur > 1 ||
3249 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3256 return SvIVX(sv) != 0;
3259 return SvNVX(sv) != 0.0;
3267 =for apidoc sv_utf8_upgrade
3269 Convert the PV of an SV to its UTF8-encoded form.
3270 Forces the SV to string form if it is not already.
3271 Always sets the SvUTF8 flag to avoid future validity checks even
3272 if all the bytes have hibit clear.
3278 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3280 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3284 =for apidoc sv_utf8_upgrade_flags
3286 Convert the PV of an SV to its UTF8-encoded form.
3287 Forces the SV to string form if it is not already.
3288 Always sets the SvUTF8 flag to avoid future validity checks even
3289 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3290 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3291 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3297 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3307 (void) sv_2pv_flags(sv,&len, flags);
3315 if (SvREADONLY(sv) && SvFAKE(sv)) {
3316 sv_force_normal(sv);
3320 Perl_sv_recode_to_utf8(aTHX_ sv, PL_encoding);
3321 else { /* Assume Latin-1/EBCDIC */
3322 /* This function could be much more efficient if we
3323 * had a FLAG in SVs to signal if there are any hibit
3324 * chars in the PV. Given that there isn't such a flag
3325 * make the loop as fast as possible. */
3326 s = (U8 *) SvPVX(sv);
3327 e = (U8 *) SvEND(sv);
3331 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3337 len = SvCUR(sv) + 1; /* Plus the \0 */
3338 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3339 SvCUR(sv) = len - 1;
3341 Safefree(s); /* No longer using what was there before. */
3342 SvLEN(sv) = len; /* No longer know the real size. */
3344 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3351 =for apidoc sv_utf8_downgrade
3353 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3354 This may not be possible if the PV contains non-byte encoding characters;
3355 if this is the case, either returns false or, if C<fail_ok> is not
3362 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3364 if (SvPOK(sv) && SvUTF8(sv)) {
3369 if (SvREADONLY(sv) && SvFAKE(sv))
3370 sv_force_normal(sv);
3371 s = (U8 *) SvPV(sv, len);
3372 if (!utf8_to_bytes(s, &len)) {
3375 #ifdef USE_BYTES_DOWNGRADES
3376 else if (IN_BYTES) {
3378 U8 *e = (U8 *) SvEND(sv);
3381 UV ch = utf8n_to_uvchr(s,(e-s),&len,0);
3382 if (first && ch > 255) {
3384 Perl_warner(aTHX_ WARN_UTF8, "Wide character in byte %s",
3387 Perl_warner(aTHX_ WARN_UTF8, "Wide character in byte");
3394 len = (d - (U8 *) SvPVX(sv));
3399 Perl_croak(aTHX_ "Wide character in %s",
3402 Perl_croak(aTHX_ "Wide character");
3413 =for apidoc sv_utf8_encode
3415 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3416 flag so that it looks like octets again. Used as a building block
3417 for encode_utf8 in Encode.xs
3423 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3425 (void) sv_utf8_upgrade(sv);
3430 =for apidoc sv_utf8_decode
3432 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3433 turn off SvUTF8 if needed so that we see characters. Used as a building block
3434 for decode_utf8 in Encode.xs
3440 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3446 /* The octets may have got themselves encoded - get them back as
3449 if (!sv_utf8_downgrade(sv, TRUE))
3452 /* it is actually just a matter of turning the utf8 flag on, but
3453 * we want to make sure everything inside is valid utf8 first.
3455 c = (U8 *) SvPVX(sv);
3456 if (!is_utf8_string(c, SvCUR(sv)+1))
3458 e = (U8 *) SvEND(sv);
3461 if (!UTF8_IS_INVARIANT(ch)) {
3471 =for apidoc sv_setsv
3473 Copies the contents of the source SV C<ssv> into the destination SV
3474 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3475 function if the source SV needs to be reused. Does not handle 'set' magic.
3476 Loosely speaking, it performs a copy-by-value, obliterating any previous
3477 content of the destination.
3479 You probably want to use one of the assortment of wrappers, such as
3480 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3481 C<SvSetMagicSV_nosteal>.
3487 /* sv_setsv() is aliased to Perl_sv_setsv_macro; this function provided
3488 for binary compatibility only
3491 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3493 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3497 =for apidoc sv_setsv_flags
3499 Copies the contents of the source SV C<ssv> into the destination SV
3500 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3501 function if the source SV needs to be reused. Does not handle 'set' magic.
3502 Loosely speaking, it performs a copy-by-value, obliterating any previous
3503 content of the destination.
3504 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3505 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3506 implemented in terms of this function.
3508 You probably want to use one of the assortment of wrappers, such as
3509 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3510 C<SvSetMagicSV_nosteal>.
3512 This is the primary function for copying scalars, and most other
3513 copy-ish functions and macros use this underneath.
3519 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3521 register U32 sflags;
3527 SV_CHECK_THINKFIRST(dstr);
3529 sstr = &PL_sv_undef;
3530 stype = SvTYPE(sstr);
3531 dtype = SvTYPE(dstr);
3535 /* There's a lot of redundancy below but we're going for speed here */
3540 if (dtype != SVt_PVGV) {
3541 (void)SvOK_off(dstr);
3549 sv_upgrade(dstr, SVt_IV);
3552 sv_upgrade(dstr, SVt_PVNV);
3556 sv_upgrade(dstr, SVt_PVIV);
3559 (void)SvIOK_only(dstr);
3560 SvIVX(dstr) = SvIVX(sstr);
3563 if (SvTAINTED(sstr))
3574 sv_upgrade(dstr, SVt_NV);
3579 sv_upgrade(dstr, SVt_PVNV);
3582 SvNVX(dstr) = SvNVX(sstr);
3583 (void)SvNOK_only(dstr);
3584 if (SvTAINTED(sstr))
3592 sv_upgrade(dstr, SVt_RV);
3593 else if (dtype == SVt_PVGV &&
3594 SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3597 if (GvIMPORTED(dstr) != GVf_IMPORTED
3598 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3600 GvIMPORTED_on(dstr);
3611 sv_upgrade(dstr, SVt_PV);
3614 if (dtype < SVt_PVIV)
3615 sv_upgrade(dstr, SVt_PVIV);
3618 if (dtype < SVt_PVNV)
3619 sv_upgrade(dstr, SVt_PVNV);
3626 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
3629 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
3633 if (dtype <= SVt_PVGV) {
3635 if (dtype != SVt_PVGV) {
3636 char *name = GvNAME(sstr);
3637 STRLEN len = GvNAMELEN(sstr);
3638 sv_upgrade(dstr, SVt_PVGV);
3639 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3640 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3641 GvNAME(dstr) = savepvn(name, len);
3642 GvNAMELEN(dstr) = len;
3643 SvFAKE_on(dstr); /* can coerce to non-glob */
3645 /* ahem, death to those who redefine active sort subs */
3646 else if (PL_curstackinfo->si_type == PERLSI_SORT
3647 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3648 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3651 #ifdef GV_UNIQUE_CHECK
3652 if (GvUNIQUE((GV*)dstr)) {
3653 Perl_croak(aTHX_ PL_no_modify);
3657 (void)SvOK_off(dstr);
3658 GvINTRO_off(dstr); /* one-shot flag */
3660 GvGP(dstr) = gp_ref(GvGP(sstr));
3661 if (SvTAINTED(sstr))
3663 if (GvIMPORTED(dstr) != GVf_IMPORTED
3664 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3666 GvIMPORTED_on(dstr);
3674 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3676 if (SvTYPE(sstr) != stype) {
3677 stype = SvTYPE(sstr);
3678 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3682 if (stype == SVt_PVLV)
3683 (void)SvUPGRADE(dstr, SVt_PVNV);
3685 (void)SvUPGRADE(dstr, stype);
3688 sflags = SvFLAGS(sstr);
3690 if (sflags & SVf_ROK) {
3691 if (dtype >= SVt_PV) {
3692 if (dtype == SVt_PVGV) {
3693 SV *sref = SvREFCNT_inc(SvRV(sstr));
3695 int intro = GvINTRO(dstr);
3697 #ifdef GV_UNIQUE_CHECK
3698 if (GvUNIQUE((GV*)dstr)) {
3699 Perl_croak(aTHX_ PL_no_modify);
3704 GvINTRO_off(dstr); /* one-shot flag */
3705 GvLINE(dstr) = CopLINE(PL_curcop);
3706 GvEGV(dstr) = (GV*)dstr;
3709 switch (SvTYPE(sref)) {
3712 SAVESPTR(GvAV(dstr));
3714 dref = (SV*)GvAV(dstr);
3715 GvAV(dstr) = (AV*)sref;
3716 if (!GvIMPORTED_AV(dstr)
3717 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3719 GvIMPORTED_AV_on(dstr);
3724 SAVESPTR(GvHV(dstr));
3726 dref = (SV*)GvHV(dstr);
3727 GvHV(dstr) = (HV*)sref;
3728 if (!GvIMPORTED_HV(dstr)
3729 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3731 GvIMPORTED_HV_on(dstr);
3736 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3737 SvREFCNT_dec(GvCV(dstr));
3738 GvCV(dstr) = Nullcv;
3739 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3740 PL_sub_generation++;
3742 SAVESPTR(GvCV(dstr));
3745 dref = (SV*)GvCV(dstr);
3746 if (GvCV(dstr) != (CV*)sref) {
3747 CV* cv = GvCV(dstr);
3749 if (!GvCVGEN((GV*)dstr) &&
3750 (CvROOT(cv) || CvXSUB(cv)))
3752 /* ahem, death to those who redefine
3753 * active sort subs */
3754 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3755 PL_sortcop == CvSTART(cv))
3757 "Can't redefine active sort subroutine %s",
3758 GvENAME((GV*)dstr));
3759 /* Redefining a sub - warning is mandatory if
3760 it was a const and its value changed. */
3761 if (ckWARN(WARN_REDEFINE)
3763 && (!CvCONST((CV*)sref)
3764 || sv_cmp(cv_const_sv(cv),
3765 cv_const_sv((CV*)sref)))))
3767 Perl_warner(aTHX_ WARN_REDEFINE,
3769 ? "Constant subroutine %s redefined"
3770 : "Subroutine %s redefined",
3771 GvENAME((GV*)dstr));
3774 cv_ckproto(cv, (GV*)dstr,
3775 SvPOK(sref) ? SvPVX(sref) : Nullch);
3777 GvCV(dstr) = (CV*)sref;
3778 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3779 GvASSUMECV_on(dstr);
3780 PL_sub_generation++;
3782 if (!GvIMPORTED_CV(dstr)
3783 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3785 GvIMPORTED_CV_on(dstr);
3790 SAVESPTR(GvIOp(dstr));
3792 dref = (SV*)GvIOp(dstr);
3793 GvIOp(dstr) = (IO*)sref;
3797 SAVESPTR(GvFORM(dstr));
3799 dref = (SV*)GvFORM(dstr);
3800 GvFORM(dstr) = (CV*)sref;
3804 SAVESPTR(GvSV(dstr));
3806 dref = (SV*)GvSV(dstr);
3808 if (!GvIMPORTED_SV(dstr)
3809 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3811 GvIMPORTED_SV_on(dstr);
3819 if (SvTAINTED(sstr))
3824 (void)SvOOK_off(dstr); /* backoff */
3826 Safefree(SvPVX(dstr));
3827 SvLEN(dstr)=SvCUR(dstr)=0;
3830 (void)SvOK_off(dstr);
3831 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
3833 if (sflags & SVp_NOK) {
3835 /* Only set the public OK flag if the source has public OK. */
3836 if (sflags & SVf_NOK)
3837 SvFLAGS(dstr) |= SVf_NOK;
3838 SvNVX(dstr) = SvNVX(sstr);
3840 if (sflags & SVp_IOK) {
3841 (void)SvIOKp_on(dstr);
3842 if (sflags & SVf_IOK)
3843 SvFLAGS(dstr) |= SVf_IOK;
3844 if (sflags & SVf_IVisUV)
3846 SvIVX(dstr) = SvIVX(sstr);
3848 if (SvAMAGIC(sstr)) {
3852 else if (sflags & SVp_POK) {
3855 * Check to see if we can just swipe the string. If so, it's a
3856 * possible small lose on short strings, but a big win on long ones.
3857 * It might even be a win on short strings if SvPVX(dstr)
3858 * has to be allocated and SvPVX(sstr) has to be freed.
3861 if (SvTEMP(sstr) && /* slated for free anyway? */
3862 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3863 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3864 SvLEN(sstr) && /* and really is a string */
3865 /* and won't be needed again, potentially */
3866 !(PL_op && PL_op->op_type == OP_AASSIGN))
3868 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
3870 SvFLAGS(dstr) &= ~SVf_OOK;
3871 Safefree(SvPVX(dstr) - SvIVX(dstr));
3873 else if (SvLEN(dstr))
3874 Safefree(SvPVX(dstr));
3876 (void)SvPOK_only(dstr);
3877 SvPV_set(dstr, SvPVX(sstr));
3878 SvLEN_set(dstr, SvLEN(sstr));
3879 SvCUR_set(dstr, SvCUR(sstr));
3882 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3883 SvPV_set(sstr, Nullch);
3888 else { /* have to copy actual string */
3889 STRLEN len = SvCUR(sstr);
3891 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3892 Move(SvPVX(sstr),SvPVX(dstr),len,char);
3893 SvCUR_set(dstr, len);
3894 *SvEND(dstr) = '\0';
3895 (void)SvPOK_only(dstr);
3897 if (sflags & SVf_UTF8)
3900 if (sflags & SVp_NOK) {
3902 if (sflags & SVf_NOK)
3903 SvFLAGS(dstr) |= SVf_NOK;
3904 SvNVX(dstr) = SvNVX(sstr);
3906 if (sflags & SVp_IOK) {
3907 (void)SvIOKp_on(dstr);
3908 if (sflags & SVf_IOK)
3909 SvFLAGS(dstr) |= SVf_IOK;
3910 if (sflags & SVf_IVisUV)
3912 SvIVX(dstr) = SvIVX(sstr);
3915 else if (sflags & SVp_IOK) {
3916 if (sflags & SVf_IOK)
3917 (void)SvIOK_only(dstr);
3919 (void)SvOK_off(dstr);
3920 (void)SvIOKp_on(dstr);
3922 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3923 if (sflags & SVf_IVisUV)
3925 SvIVX(dstr) = SvIVX(sstr);
3926 if (sflags & SVp_NOK) {
3927 if (sflags & SVf_NOK)
3928 (void)SvNOK_on(dstr);
3930 (void)SvNOKp_on(dstr);
3931 SvNVX(dstr) = SvNVX(sstr);
3934 else if (sflags & SVp_NOK) {
3935 if (sflags & SVf_NOK)
3936 (void)SvNOK_only(dstr);
3938 (void)SvOK_off(dstr);
3941 SvNVX(dstr) = SvNVX(sstr);
3944 if (dtype == SVt_PVGV) {
3945 if (ckWARN(WARN_MISC))
3946 Perl_warner(aTHX_ WARN_MISC, "Undefined value assigned to typeglob");
3949 (void)SvOK_off(dstr);
3951 if (SvTAINTED(sstr))
3956 =for apidoc sv_setsv_mg
3958 Like C<sv_setsv>, but also handles 'set' magic.
3964 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3966 sv_setsv(dstr,sstr);
3971 =for apidoc sv_setpvn
3973 Copies a string into an SV. The C<len> parameter indicates the number of
3974 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3980 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3982 register char *dptr;
3984 SV_CHECK_THINKFIRST(sv);
3990 /* len is STRLEN which is unsigned, need to copy to signed */
3993 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3995 (void)SvUPGRADE(sv, SVt_PV);
3997 SvGROW(sv, len + 1);
3999 Move(ptr,dptr,len,char);
4002 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4007 =for apidoc sv_setpvn_mg
4009 Like C<sv_setpvn>, but also handles 'set' magic.
4015 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4017 sv_setpvn(sv,ptr,len);
4022 =for apidoc sv_setpv
4024 Copies a string into an SV. The string must be null-terminated. Does not
4025 handle 'set' magic. See C<sv_setpv_mg>.
4031 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4033 register STRLEN len;
4035 SV_CHECK_THINKFIRST(sv);
4041 (void)SvUPGRADE(sv, SVt_PV);
4043 SvGROW(sv, len + 1);
4044 Move(ptr,SvPVX(sv),len+1,char);
4046 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4051 =for apidoc sv_setpv_mg
4053 Like C<sv_setpv>, but also handles 'set' magic.
4059 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4066 =for apidoc sv_usepvn
4068 Tells an SV to use C<ptr> to find its string value. Normally the string is
4069 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4070 The C<ptr> should point to memory that was allocated by C<malloc>. The
4071 string length, C<len>, must be supplied. This function will realloc the
4072 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4073 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4074 See C<sv_usepvn_mg>.
4080 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4082 SV_CHECK_THINKFIRST(sv);
4083 (void)SvUPGRADE(sv, SVt_PV);
4088 (void)SvOOK_off(sv);
4089 if (SvPVX(sv) && SvLEN(sv))
4090 Safefree(SvPVX(sv));
4091 Renew(ptr, len+1, char);
4094 SvLEN_set(sv, len+1);
4096 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4101 =for apidoc sv_usepvn_mg
4103 Like C<sv_usepvn>, but also handles 'set' magic.
4109 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4111 sv_usepvn(sv,ptr,len);
4116 =for apidoc sv_force_normal_flags
4118 Undo various types of fakery on an SV: if the PV is a shared string, make
4119 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4120 an xpvmg. The C<flags> parameter gets passed to C<sv_unref_flags()>
4121 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
4127 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4129 if (SvREADONLY(sv)) {
4131 char *pvx = SvPVX(sv);
4132 STRLEN len = SvCUR(sv);
4133 U32 hash = SvUVX(sv);
4134 SvGROW(sv, len + 1);
4135 Move(pvx,SvPVX(sv),len,char);
4139 unsharepvn(pvx, SvUTF8(sv) ? -(I32)len : len, hash);
4141 else if (PL_curcop != &PL_compiling)
4142 Perl_croak(aTHX_ PL_no_modify);
4145 sv_unref_flags(sv, flags);
4146 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4151 =for apidoc sv_force_normal
4153 Undo various types of fakery on an SV: if the PV is a shared string, make
4154 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4155 an xpvmg. See also C<sv_force_normal_flags>.
4161 Perl_sv_force_normal(pTHX_ register SV *sv)
4163 sv_force_normal_flags(sv, 0);
4169 Efficient removal of characters from the beginning of the string buffer.
4170 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4171 the string buffer. The C<ptr> becomes the first character of the adjusted
4172 string. Uses the "OOK hack".
4178 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
4180 register STRLEN delta;
4182 if (!ptr || !SvPOKp(sv))
4184 SV_CHECK_THINKFIRST(sv);
4185 if (SvTYPE(sv) < SVt_PVIV)
4186 sv_upgrade(sv,SVt_PVIV);
4189 if (!SvLEN(sv)) { /* make copy of shared string */
4190 char *pvx = SvPVX(sv);
4191 STRLEN len = SvCUR(sv);
4192 SvGROW(sv, len + 1);
4193 Move(pvx,SvPVX(sv),len,char);
4197 SvFLAGS(sv) |= SVf_OOK;
4199 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVp_IOK|SVp_NOK|SVf_IVisUV);
4200 delta = ptr - SvPVX(sv);
4208 =for apidoc sv_catpvn
4210 Concatenates the string onto the end of the string which is in the SV. The
4211 C<len> indicates number of bytes to copy. If the SV has the UTF8
4212 status set, then the bytes appended should be valid UTF8.
4213 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4218 /* sv_catpvn() is aliased to Perl_sv_catpvn_macro; this function provided
4219 for binary compatibility only
4222 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4224 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4228 =for apidoc sv_catpvn_flags
4230 Concatenates the string onto the end of the string which is in the SV. The
4231 C<len> indicates number of bytes to copy. If the SV has the UTF8
4232 status set, then the bytes appended should be valid UTF8.
4233 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4234 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4235 in terms of this function.
4241 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4246 dstr = SvPV_force_flags(dsv, dlen, flags);
4247 SvGROW(dsv, dlen + slen + 1);
4250 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4253 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4258 =for apidoc sv_catpvn_mg
4260 Like C<sv_catpvn>, but also handles 'set' magic.
4266 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4268 sv_catpvn(sv,ptr,len);
4273 =for apidoc sv_catsv
4275 Concatenates the string from SV C<ssv> onto the end of the string in
4276 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4277 not 'set' magic. See C<sv_catsv_mg>.
4281 /* sv_catsv() is aliased to Perl_sv_catsv_macro; this function provided
4282 for binary compatibility only
4285 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4287 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4291 =for apidoc sv_catsv_flags
4293 Concatenates the string from SV C<ssv> onto the end of the string in
4294 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4295 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4296 and C<sv_catsv_nomg> are implemented in terms of this function.
4301 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4307 if ((spv = SvPV(ssv, slen))) {
4308 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4309 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4310 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4311 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4312 dsv->sv_flags doesn't have that bit set.
4313 Andy Dougherty 12 Oct 2001
4315 I32 sutf8 = DO_UTF8(ssv);
4318 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4320 dutf8 = DO_UTF8(dsv);
4322 if (dutf8 != sutf8) {
4324 /* Not modifying source SV, so taking a temporary copy. */
4325 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4327 sv_utf8_upgrade(csv);
4328 spv = SvPV(csv, slen);
4331 sv_utf8_upgrade_nomg(dsv);
4333 sv_catpvn_nomg(dsv, spv, slen);
4338 =for apidoc sv_catsv_mg
4340 Like C<sv_catsv>, but also handles 'set' magic.
4346 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4353 =for apidoc sv_catpv
4355 Concatenates the string onto the end of the string which is in the SV.
4356 If the SV has the UTF8 status set, then the bytes appended should be
4357 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4362 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4364 register STRLEN len;
4370 junk = SvPV_force(sv, tlen);
4372 SvGROW(sv, tlen + len + 1);
4375 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4377 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4382 =for apidoc sv_catpv_mg
4384 Like C<sv_catpv>, but also handles 'set' magic.
4390 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4399 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4400 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4407 Perl_newSV(pTHX_ STRLEN len)
4413 sv_upgrade(sv, SVt_PV);
4414 SvGROW(sv, len + 1);
4419 =for apidoc sv_magicext
4421 Adds magic to an SV, upgrading it if necessary. Applies the
4422 supplied vtable and returns pointer to the magic added.
4424 Note that sv_magicext will allow things that sv_magic will not.
4425 In particular you can add magic to SvREADONLY SVs and and more than
4426 one instance of the same 'how'
4428 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4429 if C<namelen> is zero then C<name> is stored as-is and - as another special
4430 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4431 an C<SV*> and has its REFCNT incremented
4433 (This is now used as a subroutine by sv_magic.)
4438 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4439 const char* name, I32 namlen)
4443 if (SvTYPE(sv) < SVt_PVMG) {
4444 (void)SvUPGRADE(sv, SVt_PVMG);
4446 Newz(702,mg, 1, MAGIC);
4447 mg->mg_moremagic = SvMAGIC(sv);
4450 /* Some magic sontains a reference loop, where the sv and object refer to
4451 each other. To prevent a reference loop that would prevent such
4452 objects being freed, we look for such loops and if we find one we
4453 avoid incrementing the object refcount. */
4454 if (!obj || obj == sv ||
4455 how == PERL_MAGIC_arylen ||
4456 how == PERL_MAGIC_qr ||
4457 (SvTYPE(obj) == SVt_PVGV &&
4458 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4459 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4460 GvFORM(obj) == (CV*)sv)))
4465 mg->mg_obj = SvREFCNT_inc(obj);
4466 mg->mg_flags |= MGf_REFCOUNTED;
4469 mg->mg_len = namlen;
4472 mg->mg_ptr = savepvn(name, namlen);
4473 else if (namlen == HEf_SVKEY)
4474 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4476 mg->mg_ptr = (char *) name;
4478 mg->mg_virtual = vtable;
4482 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4487 =for apidoc sv_magic
4489 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4490 then adds a new magic item of type C<how> to the head of the magic list.
4496 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4501 if (SvREADONLY(sv)) {
4502 if (PL_curcop != &PL_compiling
4503 && how != PERL_MAGIC_regex_global
4504 && how != PERL_MAGIC_bm
4505 && how != PERL_MAGIC_fm
4506 && how != PERL_MAGIC_sv
4509 Perl_croak(aTHX_ PL_no_modify);
4512 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4513 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4514 /* sv_magic() refuses to add a magic of the same 'how' as an
4517 if (how == PERL_MAGIC_taint)
4525 vtable = &PL_vtbl_sv;
4527 case PERL_MAGIC_overload:
4528 vtable = &PL_vtbl_amagic;
4530 case PERL_MAGIC_overload_elem:
4531 vtable = &PL_vtbl_amagicelem;
4533 case PERL_MAGIC_overload_table:
4534 vtable = &PL_vtbl_ovrld;
4537 vtable = &PL_vtbl_bm;
4539 case PERL_MAGIC_regdata:
4540 vtable = &PL_vtbl_regdata;
4542 case PERL_MAGIC_regdatum:
4543 vtable = &PL_vtbl_regdatum;
4545 case PERL_MAGIC_env:
4546 vtable = &PL_vtbl_env;
4549 vtable = &PL_vtbl_fm;
4551 case PERL_MAGIC_envelem:
4552 vtable = &PL_vtbl_envelem;
4554 case PERL_MAGIC_regex_global:
4555 vtable = &PL_vtbl_mglob;
4557 case PERL_MAGIC_isa:
4558 vtable = &PL_vtbl_isa;
4560 case PERL_MAGIC_isaelem:
4561 vtable = &PL_vtbl_isaelem;
4563 case PERL_MAGIC_nkeys:
4564 vtable = &PL_vtbl_nkeys;
4566 case PERL_MAGIC_dbfile:
4569 case PERL_MAGIC_dbline:
4570 vtable = &PL_vtbl_dbline;
4572 #ifdef USE_5005THREADS
4573 case PERL_MAGIC_mutex:
4574 vtable = &PL_vtbl_mutex;
4576 #endif /* USE_5005THREADS */
4577 #ifdef USE_LOCALE_COLLATE
4578 case PERL_MAGIC_collxfrm:
4579 vtable = &PL_vtbl_collxfrm;
4581 #endif /* USE_LOCALE_COLLATE */
4582 case PERL_MAGIC_tied:
4583 vtable = &PL_vtbl_pack;
4585 case PERL_MAGIC_tiedelem:
4586 case PERL_MAGIC_tiedscalar:
4587 vtable = &PL_vtbl_packelem;
4590 vtable = &PL_vtbl_regexp;
4592 case PERL_MAGIC_sig:
4593 vtable = &PL_vtbl_sig;
4595 case PERL_MAGIC_sigelem:
4596 vtable = &PL_vtbl_sigelem;
4598 case PERL_MAGIC_taint:
4599 vtable = &PL_vtbl_taint;
4601 case PERL_MAGIC_uvar:
4602 vtable = &PL_vtbl_uvar;
4604 case PERL_MAGIC_vec:
4605 vtable = &PL_vtbl_vec;
4607 case PERL_MAGIC_substr:
4608 vtable = &PL_vtbl_substr;
4610 case PERL_MAGIC_defelem:
4611 vtable = &PL_vtbl_defelem;
4613 case PERL_MAGIC_glob:
4614 vtable = &PL_vtbl_glob;
4616 case PERL_MAGIC_arylen:
4617 vtable = &PL_vtbl_arylen;
4619 case PERL_MAGIC_pos:
4620 vtable = &PL_vtbl_pos;
4622 case PERL_MAGIC_backref:
4623 vtable = &PL_vtbl_backref;
4625 case PERL_MAGIC_ext:
4626 /* Reserved for use by extensions not perl internals. */
4627 /* Useful for attaching extension internal data to perl vars. */
4628 /* Note that multiple extensions may clash if magical scalars */
4629 /* etc holding private data from one are passed to another. */
4632 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4635 /* Rest of work is done else where */
4636 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4639 case PERL_MAGIC_taint:
4642 case PERL_MAGIC_ext:
4643 case PERL_MAGIC_dbfile:
4650 =for apidoc sv_unmagic
4652 Removes all magic of type C<type> from an SV.
4658 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4662 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4665 for (mg = *mgp; mg; mg = *mgp) {
4666 if (mg->mg_type == type) {
4667 MGVTBL* vtbl = mg->mg_virtual;
4668 *mgp = mg->mg_moremagic;
4669 if (vtbl && vtbl->svt_free)
4670 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4671 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4673 Safefree(mg->mg_ptr);
4674 else if (mg->mg_len == HEf_SVKEY)
4675 SvREFCNT_dec((SV*)mg->mg_ptr);
4677 if (mg->mg_flags & MGf_REFCOUNTED)
4678 SvREFCNT_dec(mg->mg_obj);
4682 mgp = &mg->mg_moremagic;
4686 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4693 =for apidoc sv_rvweaken
4695 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4696 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4697 push a back-reference to this RV onto the array of backreferences
4698 associated with that magic.
4704 Perl_sv_rvweaken(pTHX_ SV *sv)
4707 if (!SvOK(sv)) /* let undefs pass */
4710 Perl_croak(aTHX_ "Can't weaken a nonreference");
4711 else if (SvWEAKREF(sv)) {
4712 if (ckWARN(WARN_MISC))
4713 Perl_warner(aTHX_ WARN_MISC, "Reference is already weak");
4717 sv_add_backref(tsv, sv);
4723 /* Give tsv backref magic if it hasn't already got it, then push a
4724 * back-reference to sv onto the array associated with the backref magic.
4728 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4732 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4733 av = (AV*)mg->mg_obj;
4736 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4737 SvREFCNT_dec(av); /* for sv_magic */
4742 /* delete a back-reference to ourselves from the backref magic associated
4743 * with the SV we point to.
4747 S_sv_del_backref(pTHX_ SV *sv)
4754 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4755 Perl_croak(aTHX_ "panic: del_backref");
4756 av = (AV *)mg->mg_obj;
4761 svp[i] = &PL_sv_undef; /* XXX */
4768 =for apidoc sv_insert
4770 Inserts a string at the specified offset/length within the SV. Similar to
4771 the Perl substr() function.
4777 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
4781 register char *midend;
4782 register char *bigend;
4788 Perl_croak(aTHX_ "Can't modify non-existent substring");
4789 SvPV_force(bigstr, curlen);
4790 (void)SvPOK_only_UTF8(bigstr);
4791 if (offset + len > curlen) {
4792 SvGROW(bigstr, offset+len+1);
4793 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4794 SvCUR_set(bigstr, offset+len);
4798 i = littlelen - len;
4799 if (i > 0) { /* string might grow */
4800 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4801 mid = big + offset + len;
4802 midend = bigend = big + SvCUR(bigstr);
4805 while (midend > mid) /* shove everything down */
4806 *--bigend = *--midend;
4807 Move(little,big+offset,littlelen,char);
4813 Move(little,SvPVX(bigstr)+offset,len,char);
4818 big = SvPVX(bigstr);
4821 bigend = big + SvCUR(bigstr);
4823 if (midend > bigend)
4824 Perl_croak(aTHX_ "panic: sv_insert");
4826 if (mid - big > bigend - midend) { /* faster to shorten from end */
4828 Move(little, mid, littlelen,char);
4831 i = bigend - midend;
4833 Move(midend, mid, i,char);
4837 SvCUR_set(bigstr, mid - big);
4840 else if ((i = mid - big)) { /* faster from front */
4841 midend -= littlelen;
4843 sv_chop(bigstr,midend-i);
4848 Move(little, mid, littlelen,char);
4850 else if (littlelen) {
4851 midend -= littlelen;
4852 sv_chop(bigstr,midend);
4853 Move(little,midend,littlelen,char);
4856 sv_chop(bigstr,midend);
4862 =for apidoc sv_replace
4864 Make the first argument a copy of the second, then delete the original.
4865 The target SV physically takes over ownership of the body of the source SV
4866 and inherits its flags; however, the target keeps any magic it owns,
4867 and any magic in the source is discarded.
4868 Note that this is a rather specialist SV copying operation; most of the
4869 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4875 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4877 U32 refcnt = SvREFCNT(sv);
4878 SV_CHECK_THINKFIRST(sv);
4879 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
4880 Perl_warner(aTHX_ WARN_INTERNAL, "Reference miscount in sv_replace()");
4881 if (SvMAGICAL(sv)) {
4885 sv_upgrade(nsv, SVt_PVMG);
4886 SvMAGIC(nsv) = SvMAGIC(sv);
4887 SvFLAGS(nsv) |= SvMAGICAL(sv);
4893 assert(!SvREFCNT(sv));
4894 StructCopy(nsv,sv,SV);
4895 SvREFCNT(sv) = refcnt;
4896 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4901 =for apidoc sv_clear
4903 Clear an SV: call any destructors, free up any memory used by the body,
4904 and free the body itself. The SV's head is I<not> freed, although
4905 its type is set to all 1's so that it won't inadvertently be assumed
4906 to be live during global destruction etc.
4907 This function should only be called when REFCNT is zero. Most of the time
4908 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4915 Perl_sv_clear(pTHX_ register SV *sv)
4919 assert(SvREFCNT(sv) == 0);
4922 if (PL_defstash) { /* Still have a symbol table? */
4927 Zero(&tmpref, 1, SV);
4928 sv_upgrade(&tmpref, SVt_RV);
4930 SvREADONLY_on(&tmpref); /* DESTROY() could be naughty */
4931 SvREFCNT(&tmpref) = 1;
4934 stash = SvSTASH(sv);
4935 destructor = StashHANDLER(stash,DESTROY);
4938 PUSHSTACKi(PERLSI_DESTROY);
4939 SvRV(&tmpref) = SvREFCNT_inc(sv);
4944 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR);
4950 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4952 del_XRV(SvANY(&tmpref));
4955 if (PL_in_clean_objs)
4956 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4958 /* DESTROY gave object new lease on life */
4964 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4965 SvOBJECT_off(sv); /* Curse the object. */
4966 if (SvTYPE(sv) != SVt_PVIO)
4967 --PL_sv_objcount; /* XXX Might want something more general */
4970 if (SvTYPE(sv) >= SVt_PVMG) {
4973 if (SvFLAGS(sv) & SVpad_TYPED)
4974 SvREFCNT_dec(SvSTASH(sv));
4977 switch (SvTYPE(sv)) {
4980 IoIFP(sv) != PerlIO_stdin() &&
4981 IoIFP(sv) != PerlIO_stdout() &&
4982 IoIFP(sv) != PerlIO_stderr())
4984 io_close((IO*)sv, FALSE);
4986 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4987 PerlDir_close(IoDIRP(sv));
4988 IoDIRP(sv) = (DIR*)NULL;
4989 Safefree(IoTOP_NAME(sv));
4990 Safefree(IoFMT_NAME(sv));
4991 Safefree(IoBOTTOM_NAME(sv));
5006 SvREFCNT_dec(LvTARG(sv));
5010 Safefree(GvNAME(sv));
5011 /* cannot decrease stash refcount yet, as we might recursively delete
5012 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5013 of stash until current sv is completely gone.
5014 -- JohnPC, 27 Mar 1998 */
5015 stash = GvSTASH(sv);
5021 (void)SvOOK_off(sv);
5029 SvREFCNT_dec(SvRV(sv));
5031 else if (SvPVX(sv) && SvLEN(sv))
5032 Safefree(SvPVX(sv));
5033 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5034 unsharepvn(SvPVX(sv),
5035 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5048 switch (SvTYPE(sv)) {
5064 del_XPVIV(SvANY(sv));
5067 del_XPVNV(SvANY(sv));
5070 del_XPVMG(SvANY(sv));
5073 del_XPVLV(SvANY(sv));
5076 del_XPVAV(SvANY(sv));
5079 del_XPVHV(SvANY(sv));
5082 del_XPVCV(SvANY(sv));
5085 del_XPVGV(SvANY(sv));
5086 /* code duplication for increased performance. */
5087 SvFLAGS(sv) &= SVf_BREAK;
5088 SvFLAGS(sv) |= SVTYPEMASK;
5089 /* decrease refcount of the stash that owns this GV, if any */
5091 SvREFCNT_dec(stash);
5092 return; /* not break, SvFLAGS reset already happened */
5094 del_XPVBM(SvANY(sv));
5097 del_XPVFM(SvANY(sv));
5100 del_XPVIO(SvANY(sv));
5103 SvFLAGS(sv) &= SVf_BREAK;
5104 SvFLAGS(sv) |= SVTYPEMASK;
5108 =for apidoc sv_newref
5110 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5117 Perl_sv_newref(pTHX_ SV *sv)
5120 ATOMIC_INC(SvREFCNT(sv));
5127 Decrement an SV's reference count, and if it drops to zero, call
5128 C<sv_clear> to invoke destructors and free up any memory used by
5129 the body; finally, deallocate the SV's head itself.
5130 Normally called via a wrapper macro C<SvREFCNT_dec>.
5136 Perl_sv_free(pTHX_ SV *sv)
5138 int refcount_is_zero;
5142 if (SvREFCNT(sv) == 0) {
5143 if (SvFLAGS(sv) & SVf_BREAK)
5144 /* this SV's refcnt has been artificially decremented to
5145 * trigger cleanup */
5147 if (PL_in_clean_all) /* All is fair */
5149 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5150 /* make sure SvREFCNT(sv)==0 happens very seldom */
5151 SvREFCNT(sv) = (~(U32)0)/2;
5154 if (ckWARN_d(WARN_INTERNAL))
5155 Perl_warner(aTHX_ WARN_INTERNAL, "Attempt to free unreferenced scalar");
5158 ATOMIC_DEC_AND_TEST(refcount_is_zero, SvREFCNT(sv));
5159 if (!refcount_is_zero)
5163 if (ckWARN_d(WARN_DEBUGGING))
5164 Perl_warner(aTHX_ WARN_DEBUGGING,
5165 "Attempt to free temp prematurely: SV 0x%"UVxf,
5170 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5171 /* make sure SvREFCNT(sv)==0 happens very seldom */
5172 SvREFCNT(sv) = (~(U32)0)/2;
5183 Returns the length of the string in the SV. Handles magic and type
5184 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5190 Perl_sv_len(pTHX_ register SV *sv)
5198 len = mg_length(sv);
5200 (void)SvPV(sv, len);
5205 =for apidoc sv_len_utf8
5207 Returns the number of characters in the string in an SV, counting wide
5208 UTF8 bytes as a single character. Handles magic and type coercion.
5214 Perl_sv_len_utf8(pTHX_ register SV *sv)
5220 return mg_length(sv);
5224 U8 *s = (U8*)SvPV(sv, len);
5226 return Perl_utf8_length(aTHX_ s, s + len);
5231 =for apidoc sv_pos_u2b
5233 Converts the value pointed to by offsetp from a count of UTF8 chars from
5234 the start of the string, to a count of the equivalent number of bytes; if
5235 lenp is non-zero, it does the same to lenp, but this time starting from
5236 the offset, rather than from the start of the string. Handles magic and
5243 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5248 I32 uoffset = *offsetp;
5254 start = s = (U8*)SvPV(sv, len);
5256 while (s < send && uoffset--)
5260 *offsetp = s - start;
5264 while (s < send && ulen--)
5274 =for apidoc sv_pos_b2u
5276 Converts the value pointed to by offsetp from a count of bytes from the
5277 start of the string, to a count of the equivalent number of UTF8 chars.
5278 Handles magic and type coercion.
5284 Perl_sv_pos_b2u(pTHX_ register SV *sv, I32* offsetp)
5293 s = (U8*)SvPV(sv, len);
5295 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5296 send = s + *offsetp;
5300 /* Call utf8n_to_uvchr() to validate the sequence */
5301 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5316 Returns a boolean indicating whether the strings in the two SVs are
5317 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5318 coerce its args to strings if necessary.
5324 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5338 pv1 = SvPV(sv1, cur1);
5345 pv2 = SvPV(sv2, cur2);
5347 /* do not utf8ize the comparands as a side-effect */
5348 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5349 bool is_utf8 = TRUE;
5350 /* UTF-8ness differs */
5353 /* sv1 is the UTF-8 one , If is equal it must be downgrade-able */
5354 char *pv = (char*)bytes_from_utf8((U8*)pv1, &cur1, &is_utf8);
5359 /* sv2 is the UTF-8 one , If is equal it must be downgrade-able */
5360 char *pv = (char *)bytes_from_utf8((U8*)pv2, &cur2, &is_utf8);
5365 /* Downgrade not possible - cannot be eq */
5371 eq = memEQ(pv1, pv2, cur1);
5382 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5383 string in C<sv1> is less than, equal to, or greater than the string in
5384 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5385 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5391 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5396 bool pv1tmp = FALSE;
5397 bool pv2tmp = FALSE;
5404 pv1 = SvPV(sv1, cur1);
5411 pv2 = SvPV(sv2, cur2);
5413 /* do not utf8ize the comparands as a side-effect */
5414 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5416 pv2 = (char*)bytes_to_utf8((U8*)pv2, &cur2);
5420 pv1 = (char*)bytes_to_utf8((U8*)pv1, &cur1);
5426 cmp = cur2 ? -1 : 0;
5430 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
5433 cmp = retval < 0 ? -1 : 1;
5434 } else if (cur1 == cur2) {
5437 cmp = cur1 < cur2 ? -1 : 1;
5450 =for apidoc sv_cmp_locale
5452 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5453 'use bytes' aware, handles get magic, and will coerce its args to strings
5454 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5460 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5462 #ifdef USE_LOCALE_COLLATE
5468 if (PL_collation_standard)
5472 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5474 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5476 if (!pv1 || !len1) {
5487 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5490 return retval < 0 ? -1 : 1;
5493 * When the result of collation is equality, that doesn't mean
5494 * that there are no differences -- some locales exclude some
5495 * characters from consideration. So to avoid false equalities,
5496 * we use the raw string as a tiebreaker.
5502 #endif /* USE_LOCALE_COLLATE */
5504 return sv_cmp(sv1, sv2);
5508 #ifdef USE_LOCALE_COLLATE
5511 =for apidoc sv_collxfrm
5513 Add Collate Transform magic to an SV if it doesn't already have it.
5515 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5516 scalar data of the variable, but transformed to such a format that a normal
5517 memory comparison can be used to compare the data according to the locale
5524 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5528 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5529 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5534 Safefree(mg->mg_ptr);
5536 if ((xf = mem_collxfrm(s, len, &xlen))) {
5537 if (SvREADONLY(sv)) {
5540 return xf + sizeof(PL_collation_ix);
5543 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5544 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5557 if (mg && mg->mg_ptr) {
5559 return mg->mg_ptr + sizeof(PL_collation_ix);
5567 #endif /* USE_LOCALE_COLLATE */
5572 Get a line from the filehandle and store it into the SV, optionally
5573 appending to the currently-stored string.
5579 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5583 register STDCHAR rslast;
5584 register STDCHAR *bp;
5589 SV_CHECK_THINKFIRST(sv);
5590 (void)SvUPGRADE(sv, SVt_PV);
5594 if (PL_curcop == &PL_compiling) {
5595 /* we always read code in line mode */
5599 else if (RsSNARF(PL_rs)) {
5603 else if (RsRECORD(PL_rs)) {
5604 I32 recsize, bytesread;
5607 /* Grab the size of the record we're getting */
5608 recsize = SvIV(SvRV(PL_rs));
5609 (void)SvPOK_only(sv); /* Validate pointer */
5610 buffer = SvGROW(sv, recsize + 1);
5613 /* VMS wants read instead of fread, because fread doesn't respect */
5614 /* RMS record boundaries. This is not necessarily a good thing to be */
5615 /* doing, but we've got no other real choice */
5616 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5618 bytesread = PerlIO_read(fp, buffer, recsize);
5620 SvCUR_set(sv, bytesread);
5621 buffer[bytesread] = '\0';
5622 if (PerlIO_isutf8(fp))
5626 return(SvCUR(sv) ? SvPVX(sv) : Nullch);
5628 else if (RsPARA(PL_rs)) {
5634 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5635 if (PerlIO_isutf8(fp)) {
5636 rsptr = SvPVutf8(PL_rs, rslen);
5639 if (SvUTF8(PL_rs)) {
5640 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5641 Perl_croak(aTHX_ "Wide character in $/");
5644 rsptr = SvPV(PL_rs, rslen);
5648 rslast = rslen ? rsptr[rslen - 1] : '\0';
5650 if (rspara) { /* have to do this both before and after */
5651 do { /* to make sure file boundaries work right */
5654 i = PerlIO_getc(fp);
5658 PerlIO_ungetc(fp,i);
5664 /* See if we know enough about I/O mechanism to cheat it ! */
5666 /* This used to be #ifdef test - it is made run-time test for ease
5667 of abstracting out stdio interface. One call should be cheap
5668 enough here - and may even be a macro allowing compile
5672 if (PerlIO_fast_gets(fp)) {
5675 * We're going to steal some values from the stdio struct
5676 * and put EVERYTHING in the innermost loop into registers.
5678 register STDCHAR *ptr;
5682 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5683 /* An ungetc()d char is handled separately from the regular
5684 * buffer, so we getc() it back out and stuff it in the buffer.
5686 i = PerlIO_getc(fp);
5687 if (i == EOF) return 0;
5688 *(--((*fp)->_ptr)) = (unsigned char) i;
5692 /* Here is some breathtakingly efficient cheating */
5694 cnt = PerlIO_get_cnt(fp); /* get count into register */
5695 (void)SvPOK_only(sv); /* validate pointer */
5696 if (SvLEN(sv) - append <= cnt + 1) { /* make sure we have the room */
5697 if (cnt > 80 && SvLEN(sv) > append) {
5698 shortbuffered = cnt - SvLEN(sv) + append + 1;
5699 cnt -= shortbuffered;
5703 /* remember that cnt can be negative */
5704 SvGROW(sv, append + (cnt <= 0 ? 2 : (cnt + 1)));
5709 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
5710 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5711 DEBUG_P(PerlIO_printf(Perl_debug_log,
5712 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5713 DEBUG_P(PerlIO_printf(Perl_debug_log,
5714 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5715 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5716 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5721 while (cnt > 0) { /* this | eat */
5723 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5724 goto thats_all_folks; /* screams | sed :-) */
5728 Copy(ptr, bp, cnt, char); /* this | eat */
5729 bp += cnt; /* screams | dust */
5730 ptr += cnt; /* louder | sed :-) */
5735 if (shortbuffered) { /* oh well, must extend */
5736 cnt = shortbuffered;
5738 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
5740 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5741 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
5745 DEBUG_P(PerlIO_printf(Perl_debug_log,
5746 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5747 PTR2UV(ptr),(long)cnt));
5748 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5750 DEBUG_P(PerlIO_printf(Perl_debug_log,
5751 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5752 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5753 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5755 /* This used to call 'filbuf' in stdio form, but as that behaves like
5756 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5757 another abstraction. */
5758 i = PerlIO_getc(fp); /* get more characters */
5760 DEBUG_P(PerlIO_printf(Perl_debug_log,
5761 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5762 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5763 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5765 cnt = PerlIO_get_cnt(fp);
5766 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5767 DEBUG_P(PerlIO_printf(Perl_debug_log,
5768 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5770 if (i == EOF) /* all done for ever? */
5771 goto thats_really_all_folks;
5773 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
5775 SvGROW(sv, bpx + cnt + 2);
5776 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
5778 *bp++ = i; /* store character from PerlIO_getc */
5780 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5781 goto thats_all_folks;
5785 if ((rslen > 1 && (bp - (STDCHAR*)SvPVX(sv) < rslen)) ||
5786 memNE((char*)bp - rslen, rsptr, rslen))
5787 goto screamer; /* go back to the fray */
5788 thats_really_all_folks:
5790 cnt += shortbuffered;
5791 DEBUG_P(PerlIO_printf(Perl_debug_log,
5792 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5793 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5794 DEBUG_P(PerlIO_printf(Perl_debug_log,
5795 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5796 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5797 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5799 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
5800 DEBUG_P(PerlIO_printf(Perl_debug_log,
5801 "Screamer: done, len=%ld, string=|%.*s|\n",
5802 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
5807 /*The big, slow, and stupid way */
5810 /* Need to work around EPOC SDK features */
5811 /* On WINS: MS VC5 generates calls to _chkstk, */
5812 /* if a `large' stack frame is allocated */
5813 /* gcc on MARM does not generate calls like these */
5819 register STDCHAR *bpe = buf + sizeof(buf);
5821 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = i) != rslast && bp < bpe)
5822 ; /* keep reading */
5826 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5827 /* Accomodate broken VAXC compiler, which applies U8 cast to
5828 * both args of ?: operator, causing EOF to change into 255
5830 if (cnt) { i = (U8)buf[cnt - 1]; } else { i = EOF; }
5834 sv_catpvn(sv, (char *) buf, cnt);
5836 sv_setpvn(sv, (char *) buf, cnt);
5838 if (i != EOF && /* joy */
5840 SvCUR(sv) < rslen ||
5841 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5845 * If we're reading from a TTY and we get a short read,
5846 * indicating that the user hit his EOF character, we need
5847 * to notice it now, because if we try to read from the TTY
5848 * again, the EOF condition will disappear.
5850 * The comparison of cnt to sizeof(buf) is an optimization
5851 * that prevents unnecessary calls to feof().
5855 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5860 if (rspara) { /* have to do this both before and after */
5861 while (i != EOF) { /* to make sure file boundaries work right */
5862 i = PerlIO_getc(fp);
5864 PerlIO_ungetc(fp,i);
5870 if (PerlIO_isutf8(fp))
5875 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5881 Auto-increment of the value in the SV, doing string to numeric conversion
5882 if necessary. Handles 'get' magic.
5888 Perl_sv_inc(pTHX_ register SV *sv)
5897 if (SvTHINKFIRST(sv)) {
5898 if (SvREADONLY(sv) && SvFAKE(sv))
5899 sv_force_normal(sv);
5900 if (SvREADONLY(sv)) {
5901 if (PL_curcop != &PL_compiling)
5902 Perl_croak(aTHX_ PL_no_modify);
5906 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5908 i = PTR2IV(SvRV(sv));
5913 flags = SvFLAGS(sv);
5914 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5915 /* It's (privately or publicly) a float, but not tested as an
5916 integer, so test it to see. */
5918 flags = SvFLAGS(sv);
5920 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5921 /* It's publicly an integer, or privately an integer-not-float */
5922 #ifdef PERL_PRESERVE_IVUV
5926 if (SvUVX(sv) == UV_MAX)
5927 sv_setnv(sv, UV_MAX_P1);
5929 (void)SvIOK_only_UV(sv);
5932 if (SvIVX(sv) == IV_MAX)
5933 sv_setuv(sv, (UV)IV_MAX + 1);
5935 (void)SvIOK_only(sv);
5941 if (flags & SVp_NOK) {
5942 (void)SvNOK_only(sv);
5947 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
5948 if ((flags & SVTYPEMASK) < SVt_PVIV)
5949 sv_upgrade(sv, SVt_IV);
5950 (void)SvIOK_only(sv);
5955 while (isALPHA(*d)) d++;
5956 while (isDIGIT(*d)) d++;
5958 #ifdef PERL_PRESERVE_IVUV
5959 /* Got to punt this as an integer if needs be, but we don't issue
5960 warnings. Probably ought to make the sv_iv_please() that does
5961 the conversion if possible, and silently. */
5962 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
5963 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
5964 /* Need to try really hard to see if it's an integer.
5965 9.22337203685478e+18 is an integer.
5966 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
5967 so $a="9.22337203685478e+18"; $a+0; $a++
5968 needs to be the same as $a="9.22337203685478e+18"; $a++
5975 /* sv_2iv *should* have made this an NV */
5976 if (flags & SVp_NOK) {
5977 (void)SvNOK_only(sv);
5981 /* I don't think we can get here. Maybe I should assert this
5982 And if we do get here I suspect that sv_setnv will croak. NWC
5984 #if defined(USE_LONG_DOUBLE)
5985 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",
5986 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
5988 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
5989 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
5992 #endif /* PERL_PRESERVE_IVUV */
5993 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
5997 while (d >= SvPVX(sv)) {
6005 /* MKS: The original code here died if letters weren't consecutive.
6006 * at least it didn't have to worry about non-C locales. The
6007 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6008 * arranged in order (although not consecutively) and that only
6009 * [A-Za-z] are accepted by isALPHA in the C locale.
6011 if (*d != 'z' && *d != 'Z') {
6012 do { ++*d; } while (!isALPHA(*d));
6015 *(d--) -= 'z' - 'a';
6020 *(d--) -= 'z' - 'a' + 1;
6024 /* oh,oh, the number grew */
6025 SvGROW(sv, SvCUR(sv) + 2);
6027 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6038 Auto-decrement of the value in the SV, doing string to numeric conversion
6039 if necessary. Handles 'get' magic.
6045 Perl_sv_dec(pTHX_ register SV *sv)
6053 if (SvTHINKFIRST(sv)) {
6054 if (SvREADONLY(sv) && SvFAKE(sv))
6055 sv_force_normal(sv);
6056 if (SvREADONLY(sv)) {
6057 if (PL_curcop != &PL_compiling)
6058 Perl_croak(aTHX_ PL_no_modify);
6062 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6064 i = PTR2IV(SvRV(sv));
6069 /* Unlike sv_inc we don't have to worry about string-never-numbers
6070 and keeping them magic. But we mustn't warn on punting */
6071 flags = SvFLAGS(sv);
6072 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6073 /* It's publicly an integer, or privately an integer-not-float */
6074 #ifdef PERL_PRESERVE_IVUV
6078 if (SvUVX(sv) == 0) {
6079 (void)SvIOK_only(sv);
6083 (void)SvIOK_only_UV(sv);
6087 if (SvIVX(sv) == IV_MIN)
6088 sv_setnv(sv, (NV)IV_MIN - 1.0);
6090 (void)SvIOK_only(sv);
6096 if (flags & SVp_NOK) {
6098 (void)SvNOK_only(sv);
6101 if (!(flags & SVp_POK)) {
6102 if ((flags & SVTYPEMASK) < SVt_PVNV)
6103 sv_upgrade(sv, SVt_NV);
6105 (void)SvNOK_only(sv);
6108 #ifdef PERL_PRESERVE_IVUV
6110 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6111 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6112 /* Need to try really hard to see if it's an integer.
6113 9.22337203685478e+18 is an integer.
6114 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6115 so $a="9.22337203685478e+18"; $a+0; $a--
6116 needs to be the same as $a="9.22337203685478e+18"; $a--
6123 /* sv_2iv *should* have made this an NV */
6124 if (flags & SVp_NOK) {
6125 (void)SvNOK_only(sv);
6129 /* I don't think we can get here. Maybe I should assert this
6130 And if we do get here I suspect that sv_setnv will croak. NWC
6132 #if defined(USE_LONG_DOUBLE)
6133 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",
6134 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6136 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6137 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6141 #endif /* PERL_PRESERVE_IVUV */
6142 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6146 =for apidoc sv_mortalcopy
6148 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6149 The new SV is marked as mortal. It will be destroyed "soon", either by an
6150 explicit call to FREETMPS, or by an implicit call at places such as
6151 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6156 /* Make a string that will exist for the duration of the expression
6157 * evaluation. Actually, it may have to last longer than that, but
6158 * hopefully we won't free it until it has been assigned to a
6159 * permanent location. */
6162 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6167 sv_setsv(sv,oldstr);
6169 PL_tmps_stack[++PL_tmps_ix] = sv;
6175 =for apidoc sv_newmortal
6177 Creates a new null SV which is mortal. The reference count of the SV is
6178 set to 1. It will be destroyed "soon", either by an explicit call to
6179 FREETMPS, or by an implicit call at places such as statement boundaries.
6180 See also C<sv_mortalcopy> and C<sv_2mortal>.
6186 Perl_sv_newmortal(pTHX)
6191 SvFLAGS(sv) = SVs_TEMP;
6193 PL_tmps_stack[++PL_tmps_ix] = sv;
6198 =for apidoc sv_2mortal
6200 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6201 by an explicit call to FREETMPS, or by an implicit call at places such as
6202 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
6208 Perl_sv_2mortal(pTHX_ register SV *sv)
6212 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6215 PL_tmps_stack[++PL_tmps_ix] = sv;
6223 Creates a new SV and copies a string into it. The reference count for the
6224 SV is set to 1. If C<len> is zero, Perl will compute the length using
6225 strlen(). For efficiency, consider using C<newSVpvn> instead.
6231 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6238 sv_setpvn(sv,s,len);
6243 =for apidoc newSVpvn
6245 Creates a new SV and copies a string into it. The reference count for the
6246 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6247 string. You are responsible for ensuring that the source string is at least
6254 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6259 sv_setpvn(sv,s,len);
6264 =for apidoc newSVpvn_share
6266 Creates a new SV with its SvPVX pointing to a shared string in the string
6267 table. If the string does not already exist in the table, it is created
6268 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6269 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6270 otherwise the hash is computed. The idea here is that as the string table
6271 is used for shared hash keys these strings will have SvPVX == HeKEY and
6272 hash lookup will avoid string compare.
6278 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6281 bool is_utf8 = FALSE;
6283 STRLEN tmplen = -len;
6285 /* See the note in hv.c:hv_fetch() --jhi */
6286 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
6290 PERL_HASH(hash, src, len);
6292 sv_upgrade(sv, SVt_PVIV);
6293 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
6306 #if defined(PERL_IMPLICIT_CONTEXT)
6308 /* pTHX_ magic can't cope with varargs, so this is a no-context
6309 * version of the main function, (which may itself be aliased to us).
6310 * Don't access this version directly.
6314 Perl_newSVpvf_nocontext(const char* pat, ...)
6319 va_start(args, pat);
6320 sv = vnewSVpvf(pat, &args);
6327 =for apidoc newSVpvf
6329 Creates a new SV and initializes it with the string formatted like
6336 Perl_newSVpvf(pTHX_ const char* pat, ...)
6340 va_start(args, pat);
6341 sv = vnewSVpvf(pat, &args);
6346 /* backend for newSVpvf() and newSVpvf_nocontext() */
6349 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6353 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6360 Creates a new SV and copies a floating point value into it.
6361 The reference count for the SV is set to 1.
6367 Perl_newSVnv(pTHX_ NV n)
6379 Creates a new SV and copies an integer into it. The reference count for the
6386 Perl_newSViv(pTHX_ IV i)
6398 Creates a new SV and copies an unsigned integer into it.
6399 The reference count for the SV is set to 1.
6405 Perl_newSVuv(pTHX_ UV u)
6415 =for apidoc newRV_noinc
6417 Creates an RV wrapper for an SV. The reference count for the original
6418 SV is B<not> incremented.
6424 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6429 sv_upgrade(sv, SVt_RV);
6436 /* newRV_inc is the official function name to use now.
6437 * newRV_inc is in fact #defined to newRV in sv.h
6441 Perl_newRV(pTHX_ SV *tmpRef)
6443 return newRV_noinc(SvREFCNT_inc(tmpRef));
6449 Creates a new SV which is an exact duplicate of the original SV.
6456 Perl_newSVsv(pTHX_ register SV *old)
6462 if (SvTYPE(old) == SVTYPEMASK) {
6463 if (ckWARN_d(WARN_INTERNAL))
6464 Perl_warner(aTHX_ WARN_INTERNAL, "semi-panic: attempt to dup freed string");
6479 =for apidoc sv_reset
6481 Underlying implementation for the C<reset> Perl function.
6482 Note that the perl-level function is vaguely deprecated.
6488 Perl_sv_reset(pTHX_ register char *s, HV *stash)
6496 char todo[PERL_UCHAR_MAX+1];
6501 if (!*s) { /* reset ?? searches */
6502 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
6503 pm->op_pmdynflags &= ~PMdf_USED;
6508 /* reset variables */
6510 if (!HvARRAY(stash))
6513 Zero(todo, 256, char);
6515 i = (unsigned char)*s;
6519 max = (unsigned char)*s++;
6520 for ( ; i <= max; i++) {
6523 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6524 for (entry = HvARRAY(stash)[i];
6526 entry = HeNEXT(entry))
6528 if (!todo[(U8)*HeKEY(entry)])
6530 gv = (GV*)HeVAL(entry);
6532 if (SvTHINKFIRST(sv)) {
6533 if (!SvREADONLY(sv) && SvROK(sv))
6538 if (SvTYPE(sv) >= SVt_PV) {
6540 if (SvPVX(sv) != Nullch)
6547 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
6549 #ifdef USE_ENVIRON_ARRAY
6551 environ[0] = Nullch;
6562 Using various gambits, try to get an IO from an SV: the IO slot if its a
6563 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6564 named after the PV if we're a string.
6570 Perl_sv_2io(pTHX_ SV *sv)
6576 switch (SvTYPE(sv)) {
6584 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6588 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6590 return sv_2io(SvRV(sv));
6591 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
6597 Perl_croak(aTHX_ "Bad filehandle: %s", SvPV(sv,n_a));
6606 Using various gambits, try to get a CV from an SV; in addition, try if
6607 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6613 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6620 return *gvp = Nullgv, Nullcv;
6621 switch (SvTYPE(sv)) {
6640 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6641 tryAMAGICunDEREF(to_cv);
6644 if (SvTYPE(sv) == SVt_PVCV) {
6653 Perl_croak(aTHX_ "Not a subroutine reference");
6658 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
6664 if (lref && !GvCVu(gv)) {
6667 tmpsv = NEWSV(704,0);
6668 gv_efullname3(tmpsv, gv, Nullch);
6669 /* XXX this is probably not what they think they're getting.
6670 * It has the same effect as "sub name;", i.e. just a forward
6672 newSUB(start_subparse(FALSE, 0),
6673 newSVOP(OP_CONST, 0, tmpsv),
6678 Perl_croak(aTHX_ "Unable to create sub named \"%s\"", SvPV(sv,n_a));
6687 Returns true if the SV has a true value by Perl's rules.
6688 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6689 instead use an in-line version.
6695 Perl_sv_true(pTHX_ register SV *sv)
6701 if ((tXpv = (XPV*)SvANY(sv)) &&
6702 (tXpv->xpv_cur > 1 ||
6703 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
6710 return SvIVX(sv) != 0;
6713 return SvNVX(sv) != 0.0;
6715 return sv_2bool(sv);
6723 A private implementation of the C<SvIVx> macro for compilers which can't
6724 cope with complex macro expressions. Always use the macro instead.
6730 Perl_sv_iv(pTHX_ register SV *sv)
6734 return (IV)SvUVX(sv);
6743 A private implementation of the C<SvUVx> macro for compilers which can't
6744 cope with complex macro expressions. Always use the macro instead.
6750 Perl_sv_uv(pTHX_ register SV *sv)
6755 return (UV)SvIVX(sv);
6763 A private implementation of the C<SvNVx> macro for compilers which can't
6764 cope with complex macro expressions. Always use the macro instead.
6770 Perl_sv_nv(pTHX_ register SV *sv)
6780 A private implementation of the C<SvPV_nolen> macro for compilers which can't
6781 cope with complex macro expressions. Always use the macro instead.
6787 Perl_sv_pv(pTHX_ SV *sv)
6794 return sv_2pv(sv, &n_a);
6800 A private implementation of the C<SvPV> macro for compilers which can't
6801 cope with complex macro expressions. Always use the macro instead.
6807 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
6813 return sv_2pv(sv, lp);
6816 /* For -DCRIPPLED_CC only. See also C<sv_2pv_flags()>.
6820 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
6826 return sv_2pv_flags(sv, lp, 0);
6830 =for apidoc sv_pvn_force
6832 Get a sensible string out of the SV somehow.
6833 A private implementation of the C<SvPV_force> macro for compilers which
6834 can't cope with complex macro expressions. Always use the macro instead.
6840 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
6842 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
6846 =for apidoc sv_pvn_force_flags
6848 Get a sensible string out of the SV somehow.
6849 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6850 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6851 implemented in terms of this function.
6852 You normally want to use the various wrapper macros instead: see
6853 C<SvPV_force> and C<SvPV_force_nomg>
6859 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6863 if (SvTHINKFIRST(sv) && !SvROK(sv))
6864 sv_force_normal(sv);
6870 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
6871 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6875 s = sv_2pv_flags(sv, lp, flags);
6876 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
6881 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6882 SvGROW(sv, len + 1);
6883 Move(s,SvPVX(sv),len,char);
6888 SvPOK_on(sv); /* validate pointer */
6890 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6891 PTR2UV(sv),SvPVX(sv)));
6898 =for apidoc sv_pvbyte
6900 A private implementation of the C<SvPVbyte_nolen> macro for compilers
6901 which can't cope with complex macro expressions. Always use the macro
6908 Perl_sv_pvbyte(pTHX_ SV *sv)
6910 sv_utf8_downgrade(sv,0);
6915 =for apidoc sv_pvbyten
6917 A private implementation of the C<SvPVbyte> macro for compilers
6918 which can't cope with complex macro expressions. Always use the macro
6925 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
6927 sv_utf8_downgrade(sv,0);
6928 return sv_pvn(sv,lp);
6932 =for apidoc sv_pvbyten_force
6934 A private implementation of the C<SvPVbytex_force> macro for compilers
6935 which can't cope with complex macro expressions. Always use the macro
6942 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6944 sv_utf8_downgrade(sv,0);
6945 return sv_pvn_force(sv,lp);
6949 =for apidoc sv_pvutf8
6951 A private implementation of the C<SvPVutf8_nolen> macro for compilers
6952 which can't cope with complex macro expressions. Always use the macro
6959 Perl_sv_pvutf8(pTHX_ SV *sv)
6961 sv_utf8_upgrade(sv);
6966 =for apidoc sv_pvutf8n
6968 A private implementation of the C<SvPVutf8> macro for compilers
6969 which can't cope with complex macro expressions. Always use the macro
6976 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
6978 sv_utf8_upgrade(sv);
6979 return sv_pvn(sv,lp);
6983 =for apidoc sv_pvutf8n_force
6985 A private implementation of the C<SvPVutf8_force> macro for compilers
6986 which can't cope with complex macro expressions. Always use the macro
6993 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6995 sv_utf8_upgrade(sv);
6996 return sv_pvn_force(sv,lp);
7000 =for apidoc sv_reftype
7002 Returns a string describing what the SV is a reference to.
7008 Perl_sv_reftype(pTHX_ SV *sv, int ob)
7010 if (ob && SvOBJECT(sv)) {
7011 HV *svs = SvSTASH(sv);
7012 /* [20011101.072] This bandaid for C<package;> should eventually
7013 be removed. AMS 20011103 */
7014 return (svs ? HvNAME(svs) : "<none>");
7017 switch (SvTYPE(sv)) {
7031 case SVt_PVLV: return "LVALUE";
7032 case SVt_PVAV: return "ARRAY";
7033 case SVt_PVHV: return "HASH";
7034 case SVt_PVCV: return "CODE";
7035 case SVt_PVGV: return "GLOB";
7036 case SVt_PVFM: return "FORMAT";
7037 case SVt_PVIO: return "IO";
7038 default: return "UNKNOWN";
7044 =for apidoc sv_isobject
7046 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7047 object. If the SV is not an RV, or if the object is not blessed, then this
7054 Perl_sv_isobject(pTHX_ SV *sv)
7071 Returns a boolean indicating whether the SV is blessed into the specified
7072 class. This does not check for subtypes; use C<sv_derived_from> to verify
7073 an inheritance relationship.
7079 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7091 return strEQ(HvNAME(SvSTASH(sv)), name);
7097 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7098 it will be upgraded to one. If C<classname> is non-null then the new SV will
7099 be blessed in the specified package. The new SV is returned and its
7100 reference count is 1.
7106 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7112 SV_CHECK_THINKFIRST(rv);
7115 if (SvTYPE(rv) >= SVt_PVMG) {
7116 U32 refcnt = SvREFCNT(rv);
7120 SvREFCNT(rv) = refcnt;
7123 if (SvTYPE(rv) < SVt_RV)
7124 sv_upgrade(rv, SVt_RV);
7125 else if (SvTYPE(rv) > SVt_RV) {
7126 (void)SvOOK_off(rv);
7127 if (SvPVX(rv) && SvLEN(rv))
7128 Safefree(SvPVX(rv));
7138 HV* stash = gv_stashpv(classname, TRUE);
7139 (void)sv_bless(rv, stash);
7145 =for apidoc sv_setref_pv
7147 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7148 argument will be upgraded to an RV. That RV will be modified to point to
7149 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7150 into the SV. The C<classname> argument indicates the package for the
7151 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7152 will be returned and will have a reference count of 1.
7154 Do not use with other Perl types such as HV, AV, SV, CV, because those
7155 objects will become corrupted by the pointer copy process.
7157 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7163 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7166 sv_setsv(rv, &PL_sv_undef);
7170 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7175 =for apidoc sv_setref_iv
7177 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7178 argument will be upgraded to an RV. That RV will be modified to point to
7179 the new SV. The C<classname> argument indicates the package for the
7180 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7181 will be returned and will have a reference count of 1.
7187 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7189 sv_setiv(newSVrv(rv,classname), iv);
7194 =for apidoc sv_setref_uv
7196 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7197 argument will be upgraded to an RV. That RV will be modified to point to
7198 the new SV. The C<classname> argument indicates the package for the
7199 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7200 will be returned and will have a reference count of 1.
7206 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7208 sv_setuv(newSVrv(rv,classname), uv);
7213 =for apidoc sv_setref_nv
7215 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7216 argument will be upgraded to an RV. That RV will be modified to point to
7217 the new SV. The C<classname> argument indicates the package for the
7218 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7219 will be returned and will have a reference count of 1.
7225 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7227 sv_setnv(newSVrv(rv,classname), nv);
7232 =for apidoc sv_setref_pvn
7234 Copies a string into a new SV, optionally blessing the SV. The length of the
7235 string must be specified with C<n>. The C<rv> argument will be upgraded to
7236 an RV. That RV will be modified to point to the new SV. The C<classname>
7237 argument indicates the package for the blessing. Set C<classname> to
7238 C<Nullch> to avoid the blessing. The new SV will be returned and will have
7239 a reference count of 1.
7241 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7247 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
7249 sv_setpvn(newSVrv(rv,classname), pv, n);
7254 =for apidoc sv_bless
7256 Blesses an SV into a specified package. The SV must be an RV. The package
7257 must be designated by its stash (see C<gv_stashpv()>). The reference count
7258 of the SV is unaffected.
7264 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7268 Perl_croak(aTHX_ "Can't bless non-reference value");
7270 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7271 if (SvREADONLY(tmpRef))
7272 Perl_croak(aTHX_ PL_no_modify);
7273 if (SvOBJECT(tmpRef)) {
7274 if (SvTYPE(tmpRef) != SVt_PVIO)
7276 SvREFCNT_dec(SvSTASH(tmpRef));
7279 SvOBJECT_on(tmpRef);
7280 if (SvTYPE(tmpRef) != SVt_PVIO)
7282 (void)SvUPGRADE(tmpRef, SVt_PVMG);
7283 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
7290 if(SvSMAGICAL(tmpRef))
7291 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7299 /* Downgrades a PVGV to a PVMG.
7301 * XXX This function doesn't actually appear to be used anywhere
7306 S_sv_unglob(pTHX_ SV *sv)
7310 assert(SvTYPE(sv) == SVt_PVGV);
7315 SvREFCNT_dec(GvSTASH(sv));
7316 GvSTASH(sv) = Nullhv;
7318 sv_unmagic(sv, PERL_MAGIC_glob);
7319 Safefree(GvNAME(sv));
7322 /* need to keep SvANY(sv) in the right arena */
7323 xpvmg = new_XPVMG();
7324 StructCopy(SvANY(sv), xpvmg, XPVMG);
7325 del_XPVGV(SvANY(sv));
7328 SvFLAGS(sv) &= ~SVTYPEMASK;
7329 SvFLAGS(sv) |= SVt_PVMG;
7333 =for apidoc sv_unref_flags
7335 Unsets the RV status of the SV, and decrements the reference count of
7336 whatever was being referenced by the RV. This can almost be thought of
7337 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7338 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7339 (otherwise the decrementing is conditional on the reference count being
7340 different from one or the reference being a readonly SV).
7347 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
7351 if (SvWEAKREF(sv)) {
7359 if (SvREFCNT(rv) != 1 || SvREADONLY(rv) || flags) /* SV_IMMEDIATE_UNREF */
7361 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7362 sv_2mortal(rv); /* Schedule for freeing later */
7366 =for apidoc sv_unref
7368 Unsets the RV status of the SV, and decrements the reference count of
7369 whatever was being referenced by the RV. This can almost be thought of
7370 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
7371 being zero. See C<SvROK_off>.
7377 Perl_sv_unref(pTHX_ SV *sv)
7379 sv_unref_flags(sv, 0);
7383 =for apidoc sv_taint
7385 Taint an SV. Use C<SvTAINTED_on> instead.
7390 Perl_sv_taint(pTHX_ SV *sv)
7392 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
7396 =for apidoc sv_untaint
7398 Untaint an SV. Use C<SvTAINTED_off> instead.
7403 Perl_sv_untaint(pTHX_ SV *sv)
7405 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7406 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7413 =for apidoc sv_tainted
7415 Test an SV for taintedness. Use C<SvTAINTED> instead.
7420 Perl_sv_tainted(pTHX_ SV *sv)
7422 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7423 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7424 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
7431 =for apidoc sv_setpviv
7433 Copies an integer into the given SV, also updating its string value.
7434 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7440 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7442 char buf[TYPE_CHARS(UV)];
7444 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7446 sv_setpvn(sv, ptr, ebuf - ptr);
7450 =for apidoc sv_setpviv_mg
7452 Like C<sv_setpviv>, but also handles 'set' magic.
7458 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7460 char buf[TYPE_CHARS(UV)];
7462 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7464 sv_setpvn(sv, ptr, ebuf - ptr);
7468 #if defined(PERL_IMPLICIT_CONTEXT)
7470 /* pTHX_ magic can't cope with varargs, so this is a no-context
7471 * version of the main function, (which may itself be aliased to us).
7472 * Don't access this version directly.
7476 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7480 va_start(args, pat);
7481 sv_vsetpvf(sv, pat, &args);
7485 /* pTHX_ magic can't cope with varargs, so this is a no-context
7486 * version of the main function, (which may itself be aliased to us).
7487 * Don't access this version directly.
7491 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7495 va_start(args, pat);
7496 sv_vsetpvf_mg(sv, pat, &args);
7502 =for apidoc sv_setpvf
7504 Processes its arguments like C<sprintf> and sets an SV to the formatted
7505 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7511 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7514 va_start(args, pat);
7515 sv_vsetpvf(sv, pat, &args);
7519 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
7522 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7524 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7528 =for apidoc sv_setpvf_mg
7530 Like C<sv_setpvf>, but also handles 'set' magic.
7536 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7539 va_start(args, pat);
7540 sv_vsetpvf_mg(sv, pat, &args);
7544 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
7547 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7549 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7553 #if defined(PERL_IMPLICIT_CONTEXT)
7555 /* pTHX_ magic can't cope with varargs, so this is a no-context
7556 * version of the main function, (which may itself be aliased to us).
7557 * Don't access this version directly.
7561 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7565 va_start(args, pat);
7566 sv_vcatpvf(sv, pat, &args);
7570 /* pTHX_ magic can't cope with varargs, so this is a no-context
7571 * version of the main function, (which may itself be aliased to us).
7572 * Don't access this version directly.
7576 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7580 va_start(args, pat);
7581 sv_vcatpvf_mg(sv, pat, &args);
7587 =for apidoc sv_catpvf
7589 Processes its arguments like C<sprintf> and appends the formatted
7590 output to an SV. If the appended data contains "wide" characters
7591 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7592 and characters >255 formatted with %c), the original SV might get
7593 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
7594 C<SvSETMAGIC()> must typically be called after calling this function
7595 to handle 'set' magic.
7600 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7603 va_start(args, pat);
7604 sv_vcatpvf(sv, pat, &args);
7608 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
7611 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7613 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7617 =for apidoc sv_catpvf_mg
7619 Like C<sv_catpvf>, but also handles 'set' magic.
7625 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7628 va_start(args, pat);
7629 sv_vcatpvf_mg(sv, pat, &args);
7633 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
7636 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7638 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7643 =for apidoc sv_vsetpvfn
7645 Works like C<vcatpvfn> but copies the text into the SV instead of
7648 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
7654 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7656 sv_setpvn(sv, "", 0);
7657 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7660 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7663 S_expect_number(pTHX_ char** pattern)
7666 switch (**pattern) {
7667 case '1': case '2': case '3':
7668 case '4': case '5': case '6':
7669 case '7': case '8': case '9':
7670 while (isDIGIT(**pattern))
7671 var = var * 10 + (*(*pattern)++ - '0');
7675 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7678 =for apidoc sv_vcatpvfn
7680 Processes its arguments like C<vsprintf> and appends the formatted output
7681 to an SV. Uses an array of SVs if the C style variable argument list is
7682 missing (NULL). When running with taint checks enabled, indicates via
7683 C<maybe_tainted> if results are untrustworthy (often due to the use of
7686 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
7692 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7699 static char nullstr[] = "(null)";
7701 bool has_utf8 = FALSE; /* has the result utf8? */
7703 /* no matter what, this is a string now */
7704 (void)SvPV_force(sv, origlen);
7706 /* special-case "", "%s", and "%_" */
7709 if (patlen == 2 && pat[0] == '%') {
7713 char *s = va_arg(*args, char*);
7714 sv_catpv(sv, s ? s : nullstr);
7716 else if (svix < svmax) {
7717 sv_catsv(sv, *svargs);
7718 if (DO_UTF8(*svargs))
7724 argsv = va_arg(*args, SV*);
7725 sv_catsv(sv, argsv);
7730 /* See comment on '_' below */
7735 if (!args && svix < svmax && DO_UTF8(*svargs))
7738 patend = (char*)pat + patlen;
7739 for (p = (char*)pat; p < patend; p = q) {
7742 bool vectorize = FALSE;
7743 bool vectorarg = FALSE;
7744 bool vec_utf8 = FALSE;
7750 bool has_precis = FALSE;
7752 bool is_utf8 = FALSE; /* is this item utf8? */
7755 U8 utf8buf[UTF8_MAXLEN+1];
7756 STRLEN esignlen = 0;
7758 char *eptr = Nullch;
7760 /* Times 4: a decimal digit takes more than 3 binary digits.
7761 * NV_DIG: mantissa takes than many decimal digits.
7762 * Plus 32: Playing safe. */
7763 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7764 /* large enough for "%#.#f" --chip */
7765 /* what about long double NVs? --jhi */
7768 U8 *vecstr = Null(U8*);
7780 STRLEN dotstrlen = 1;
7781 I32 efix = 0; /* explicit format parameter index */
7782 I32 ewix = 0; /* explicit width index */
7783 I32 epix = 0; /* explicit precision index */
7784 I32 evix = 0; /* explicit vector index */
7785 bool asterisk = FALSE;
7787 /* echo everything up to the next format specification */
7788 for (q = p; q < patend && *q != '%'; ++q) ;
7790 sv_catpvn(sv, p, q - p);
7797 We allow format specification elements in this order:
7798 \d+\$ explicit format parameter index
7800 \*?(\d+\$)?v vector with optional (optionally specified) arg
7801 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7802 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7804 [%bcdefginopsux_DFOUX] format (mandatory)
7806 if (EXPECT_NUMBER(q, width)) {
7847 if (EXPECT_NUMBER(q, ewix))
7856 if ((vectorarg = asterisk)) {
7866 EXPECT_NUMBER(q, width);
7871 vecsv = va_arg(*args, SV*);
7873 vecsv = (evix ? evix <= svmax : svix < svmax) ?
7874 svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
7875 dotstr = SvPVx(vecsv, dotstrlen);
7880 vecsv = va_arg(*args, SV*);
7881 vecstr = (U8*)SvPVx(vecsv,veclen);
7882 vec_utf8 = DO_UTF8(vecsv);
7884 else if (efix ? efix <= svmax : svix < svmax) {
7885 vecsv = svargs[efix ? efix-1 : svix++];
7886 vecstr = (U8*)SvPVx(vecsv,veclen);
7887 vec_utf8 = DO_UTF8(vecsv);
7897 i = va_arg(*args, int);
7899 i = (ewix ? ewix <= svmax : svix < svmax) ?
7900 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
7902 width = (i < 0) ? -i : i;
7912 if (EXPECT_NUMBER(q, epix) && *q++ != '$') /* epix currently unused */
7915 i = va_arg(*args, int);
7917 i = (ewix ? ewix <= svmax : svix < svmax)
7918 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
7919 precis = (i < 0) ? 0 : i;
7924 precis = precis * 10 + (*q++ - '0');
7932 #if defined(HAS_QUAD) || (defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE))
7943 #if defined(HAS_QUAD) || (defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE))
7944 if (*(q + 1) == 'l') { /* lld, llf */
7967 argsv = (efix ? efix <= svmax : svix < svmax) ?
7968 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
7975 uv = args ? va_arg(*args, int) : SvIVx(argsv);
7977 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
7979 eptr = (char*)utf8buf;
7980 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
7992 eptr = va_arg(*args, char*);
7994 #ifdef MACOS_TRADITIONAL
7995 /* On MacOS, %#s format is used for Pascal strings */
8000 elen = strlen(eptr);
8003 elen = sizeof nullstr - 1;
8007 eptr = SvPVx(argsv, elen);
8008 if (DO_UTF8(argsv)) {
8009 if (has_precis && precis < elen) {
8011 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8014 if (width) { /* fudge width (can't fudge elen) */
8015 width += elen - sv_len_utf8(argsv);
8024 * The "%_" hack might have to be changed someday,
8025 * if ISO or ANSI decide to use '_' for something.
8026 * So we keep it hidden from users' code.
8030 argsv = va_arg(*args, SV*);
8031 eptr = SvPVx(argsv, elen);
8037 if (has_precis && elen > precis)
8046 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8064 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8073 esignbuf[esignlen++] = plus;
8077 case 'h': iv = (short)va_arg(*args, int); break;
8078 default: iv = va_arg(*args, int); break;
8079 case 'l': iv = va_arg(*args, long); break;
8080 case 'V': iv = va_arg(*args, IV); break;
8082 case 'q': iv = va_arg(*args, Quad_t); break;
8089 case 'h': iv = (short)iv; break;
8091 case 'l': iv = (long)iv; break;
8094 case 'q': iv = (Quad_t)iv; break;
8098 if ( !vectorize ) /* we already set uv above */
8103 esignbuf[esignlen++] = plus;
8107 esignbuf[esignlen++] = '-';
8150 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8161 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8162 default: uv = va_arg(*args, unsigned); break;
8163 case 'l': uv = va_arg(*args, unsigned long); break;
8164 case 'V': uv = va_arg(*args, UV); break;
8166 case 'q': uv = va_arg(*args, Quad_t); break;
8173 case 'h': uv = (unsigned short)uv; break;
8175 case 'l': uv = (unsigned long)uv; break;
8178 case 'q': uv = (Quad_t)uv; break;
8184 eptr = ebuf + sizeof ebuf;
8190 p = (char*)((c == 'X')
8191 ? "0123456789ABCDEF" : "0123456789abcdef");
8197 esignbuf[esignlen++] = '0';
8198 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8204 *--eptr = '0' + dig;
8206 if (alt && *eptr != '0')
8212 *--eptr = '0' + dig;
8215 esignbuf[esignlen++] = '0';
8216 esignbuf[esignlen++] = 'b';
8219 default: /* it had better be ten or less */
8220 #if defined(PERL_Y2KWARN)
8221 if (ckWARN(WARN_Y2K)) {
8223 char *s = SvPV(sv,n);
8224 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
8225 && (n == 2 || !isDIGIT(s[n-3])))
8227 Perl_warner(aTHX_ WARN_Y2K,
8228 "Possible Y2K bug: %%%c %s",
8229 c, "format string following '19'");
8235 *--eptr = '0' + dig;
8236 } while (uv /= base);
8239 elen = (ebuf + sizeof ebuf) - eptr;
8242 zeros = precis - elen;
8243 else if (precis == 0 && elen == 1 && *eptr == '0')
8248 /* FLOATING POINT */
8251 c = 'f'; /* maybe %F isn't supported here */
8257 /* This is evil, but floating point is even more evil */
8260 nv = args ? va_arg(*args, NV) : SvNVx(argsv);
8263 if (c != 'e' && c != 'E') {
8265 (void)Perl_frexp(nv, &i);
8266 if (i == PERL_INT_MIN)
8267 Perl_die(aTHX_ "panic: frexp");
8269 need = BIT_DIGITS(i);
8271 need += has_precis ? precis : 6; /* known default */
8275 need += 20; /* fudge factor */
8276 if (PL_efloatsize < need) {
8277 Safefree(PL_efloatbuf);
8278 PL_efloatsize = need + 20; /* more fudge */
8279 New(906, PL_efloatbuf, PL_efloatsize, char);
8280 PL_efloatbuf[0] = '\0';
8283 eptr = ebuf + sizeof ebuf;
8286 #if defined(USE_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8288 /* Copy the one or more characters in a long double
8289 * format before the 'base' ([efgEFG]) character to
8290 * the format string. */
8291 static char const prifldbl[] = PERL_PRIfldbl;
8292 char const *p = prifldbl + sizeof(prifldbl) - 3;
8293 while (p >= prifldbl) { *--eptr = *p--; }
8298 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8303 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8315 /* No taint. Otherwise we are in the strange situation
8316 * where printf() taints but print($float) doesn't.
8318 (void)sprintf(PL_efloatbuf, eptr, nv);
8320 eptr = PL_efloatbuf;
8321 elen = strlen(PL_efloatbuf);
8328 i = SvCUR(sv) - origlen;
8331 case 'h': *(va_arg(*args, short*)) = i; break;
8332 default: *(va_arg(*args, int*)) = i; break;
8333 case 'l': *(va_arg(*args, long*)) = i; break;
8334 case 'V': *(va_arg(*args, IV*)) = i; break;
8336 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8341 sv_setuv_mg(argsv, (UV)i);
8342 continue; /* not "break" */
8349 if (!args && ckWARN(WARN_PRINTF) &&
8350 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
8351 SV *msg = sv_newmortal();
8352 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %s: ",
8353 (PL_op->op_type == OP_PRTF) ? "printf" : "sprintf");
8356 Perl_sv_catpvf(aTHX_ msg,
8357 "\"%%%c\"", c & 0xFF);
8359 Perl_sv_catpvf(aTHX_ msg,
8360 "\"%%\\%03"UVof"\"",
8363 sv_catpv(msg, "end of string");
8364 Perl_warner(aTHX_ WARN_PRINTF, "%"SVf, msg); /* yes, this is reentrant */
8367 /* output mangled stuff ... */
8373 /* ... right here, because formatting flags should not apply */
8374 SvGROW(sv, SvCUR(sv) + elen + 1);
8376 Copy(eptr, p, elen, char);
8379 SvCUR(sv) = p - SvPVX(sv);
8380 continue; /* not "break" */
8383 if (is_utf8 != has_utf8) {
8386 sv_utf8_upgrade(sv);
8389 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
8390 sv_utf8_upgrade(nsv);
8394 SvGROW(sv, SvCUR(sv) + elen + 1);
8399 have = esignlen + zeros + elen;
8400 need = (have > width ? have : width);
8403 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8405 if (esignlen && fill == '0') {
8406 for (i = 0; i < esignlen; i++)
8410 memset(p, fill, gap);
8413 if (esignlen && fill != '0') {
8414 for (i = 0; i < esignlen; i++)
8418 for (i = zeros; i; i--)
8422 Copy(eptr, p, elen, char);
8426 memset(p, ' ', gap);
8431 Copy(dotstr, p, dotstrlen, char);
8435 vectorize = FALSE; /* done iterating over vecstr */
8442 SvCUR(sv) = p - SvPVX(sv);
8450 /* =========================================================================
8452 =head1 Cloning an interpreter
8454 All the macros and functions in this section are for the private use of
8455 the main function, perl_clone().
8457 The foo_dup() functions make an exact copy of an existing foo thinngy.
8458 During the course of a cloning, a hash table is used to map old addresses
8459 to new addresses. The table is created and manipulated with the
8460 ptr_table_* functions.
8464 ============================================================================*/
8467 #if defined(USE_ITHREADS)
8469 #if defined(USE_5005THREADS)
8470 # include "error: USE_5005THREADS and USE_ITHREADS are incompatible"
8473 #ifndef GpREFCNT_inc
8474 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8478 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8479 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8480 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8481 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8482 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8483 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8484 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8485 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8486 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8487 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8488 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8489 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8490 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8493 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8494 regcomp.c. AMS 20010712 */
8497 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
8501 struct reg_substr_datum *s;
8504 return (REGEXP *)NULL;
8506 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8509 len = r->offsets[0];
8510 npar = r->nparens+1;
8512 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8513 Copy(r->program, ret->program, len+1, regnode);
8515 New(0, ret->startp, npar, I32);
8516 Copy(r->startp, ret->startp, npar, I32);
8517 New(0, ret->endp, npar, I32);
8518 Copy(r->startp, ret->startp, npar, I32);
8520 New(0, ret->substrs, 1, struct reg_substr_data);
8521 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8522 s->min_offset = r->substrs->data[i].min_offset;
8523 s->max_offset = r->substrs->data[i].max_offset;
8524 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8527 ret->regstclass = NULL;
8530 int count = r->data->count;
8532 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
8533 char, struct reg_data);
8534 New(0, d->what, count, U8);
8537 for (i = 0; i < count; i++) {
8538 d->what[i] = r->data->what[i];
8539 switch (d->what[i]) {
8541 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8544 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8547 /* This is cheating. */
8548 New(0, d->data[i], 1, struct regnode_charclass_class);
8549 StructCopy(r->data->data[i], d->data[i],
8550 struct regnode_charclass_class);
8551 ret->regstclass = (regnode*)d->data[i];
8554 /* Compiled op trees are readonly, and can thus be
8555 shared without duplication. */
8556 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8559 d->data[i] = r->data->data[i];
8569 New(0, ret->offsets, 2*len+1, U32);
8570 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8572 ret->precomp = SAVEPV(r->precomp);
8573 ret->refcnt = r->refcnt;
8574 ret->minlen = r->minlen;
8575 ret->prelen = r->prelen;
8576 ret->nparens = r->nparens;
8577 ret->lastparen = r->lastparen;
8578 ret->lastcloseparen = r->lastcloseparen;
8579 ret->reganch = r->reganch;
8581 ret->sublen = r->sublen;
8583 if (RX_MATCH_COPIED(ret))
8584 ret->subbeg = SAVEPV(r->subbeg);
8586 ret->subbeg = Nullch;
8588 ptr_table_store(PL_ptr_table, r, ret);
8592 /* duplicate a file handle */
8595 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8599 return (PerlIO*)NULL;
8601 /* look for it in the table first */
8602 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8606 /* create anew and remember what it is */
8607 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8608 ptr_table_store(PL_ptr_table, fp, ret);
8612 /* duplicate a directory handle */
8615 Perl_dirp_dup(pTHX_ DIR *dp)
8623 /* duplicate a typeglob */
8626 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8631 /* look for it in the table first */
8632 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8636 /* create anew and remember what it is */
8637 Newz(0, ret, 1, GP);
8638 ptr_table_store(PL_ptr_table, gp, ret);
8641 ret->gp_refcnt = 0; /* must be before any other dups! */
8642 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
8643 ret->gp_io = io_dup_inc(gp->gp_io, param);
8644 ret->gp_form = cv_dup_inc(gp->gp_form, param);
8645 ret->gp_av = av_dup_inc(gp->gp_av, param);
8646 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
8647 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8648 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
8649 ret->gp_cvgen = gp->gp_cvgen;
8650 ret->gp_flags = gp->gp_flags;
8651 ret->gp_line = gp->gp_line;
8652 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
8656 /* duplicate a chain of magic */
8659 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8661 MAGIC *mgprev = (MAGIC*)NULL;
8664 return (MAGIC*)NULL;
8665 /* look for it in the table first */
8666 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8670 for (; mg; mg = mg->mg_moremagic) {
8672 Newz(0, nmg, 1, MAGIC);
8674 mgprev->mg_moremagic = nmg;
8677 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
8678 nmg->mg_private = mg->mg_private;
8679 nmg->mg_type = mg->mg_type;
8680 nmg->mg_flags = mg->mg_flags;
8681 if (mg->mg_type == PERL_MAGIC_qr) {
8682 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8684 else if(mg->mg_type == PERL_MAGIC_backref) {
8685 AV *av = (AV*) mg->mg_obj;
8688 nmg->mg_obj = (SV*)newAV();
8692 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8697 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
8698 ? sv_dup_inc(mg->mg_obj, param)
8699 : sv_dup(mg->mg_obj, param);
8701 nmg->mg_len = mg->mg_len;
8702 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
8703 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
8704 if (mg->mg_len > 0) {
8705 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
8706 if (mg->mg_type == PERL_MAGIC_overload_table &&
8707 AMT_AMAGIC((AMT*)mg->mg_ptr))
8709 AMT *amtp = (AMT*)mg->mg_ptr;
8710 AMT *namtp = (AMT*)nmg->mg_ptr;
8712 for (i = 1; i < NofAMmeth; i++) {
8713 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
8717 else if (mg->mg_len == HEf_SVKEY)
8718 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
8720 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
8721 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
8728 /* create a new pointer-mapping table */
8731 Perl_ptr_table_new(pTHX)
8734 Newz(0, tbl, 1, PTR_TBL_t);
8737 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
8741 /* map an existing pointer using a table */
8744 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
8746 PTR_TBL_ENT_t *tblent;
8747 UV hash = PTR2UV(sv);
8749 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
8750 for (; tblent; tblent = tblent->next) {
8751 if (tblent->oldval == sv)
8752 return tblent->newval;
8757 /* add a new entry to a pointer-mapping table */
8760 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
8762 PTR_TBL_ENT_t *tblent, **otblent;
8763 /* XXX this may be pessimal on platforms where pointers aren't good
8764 * hash values e.g. if they grow faster in the most significant
8766 UV hash = PTR2UV(oldv);
8770 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
8771 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
8772 if (tblent->oldval == oldv) {
8773 tblent->newval = newv;
8778 Newz(0, tblent, 1, PTR_TBL_ENT_t);
8779 tblent->oldval = oldv;
8780 tblent->newval = newv;
8781 tblent->next = *otblent;
8784 if (i && tbl->tbl_items > tbl->tbl_max)
8785 ptr_table_split(tbl);
8788 /* double the hash bucket size of an existing ptr table */
8791 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
8793 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
8794 UV oldsize = tbl->tbl_max + 1;
8795 UV newsize = oldsize * 2;
8798 Renew(ary, newsize, PTR_TBL_ENT_t*);
8799 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
8800 tbl->tbl_max = --newsize;
8802 for (i=0; i < oldsize; i++, ary++) {
8803 PTR_TBL_ENT_t **curentp, **entp, *ent;
8806 curentp = ary + oldsize;
8807 for (entp = ary, ent = *ary; ent; ent = *entp) {
8808 if ((newsize & PTR2UV(ent->oldval)) != i) {
8810 ent->next = *curentp;
8820 /* remove all the entries from a ptr table */
8823 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
8825 register PTR_TBL_ENT_t **array;
8826 register PTR_TBL_ENT_t *entry;
8827 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
8831 if (!tbl || !tbl->tbl_items) {
8835 array = tbl->tbl_ary;
8842 entry = entry->next;
8846 if (++riter > max) {
8849 entry = array[riter];
8856 /* clear and free a ptr table */
8859 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
8864 ptr_table_clear(tbl);
8865 Safefree(tbl->tbl_ary);
8873 /* attempt to make everything in the typeglob readonly */
8876 S_gv_share(pTHX_ SV *sstr)
8879 SV *sv = &PL_sv_no; /* just need SvREADONLY-ness */
8881 if (GvIO(gv) || GvFORM(gv)) {
8882 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
8884 else if (!GvCV(gv)) {
8888 /* CvPADLISTs cannot be shared */
8889 if (!CvXSUB(GvCV(gv))) {
8894 if (!GvUNIQUE(gv)) {
8896 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
8897 HvNAME(GvSTASH(gv)), GvNAME(gv));
8903 * write attempts will die with
8904 * "Modification of a read-only value attempted"
8910 SvREADONLY_on(GvSV(gv));
8917 SvREADONLY_on(GvAV(gv));
8924 SvREADONLY_on(GvAV(gv));
8927 return sstr; /* he_dup() will SvREFCNT_inc() */
8930 /* duplicate an SV of any type (including AV, HV etc) */
8933 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
8936 SvRV(dstr) = SvWEAKREF(sstr)
8937 ? sv_dup(SvRV(sstr), param)
8938 : sv_dup_inc(SvRV(sstr), param);
8940 else if (SvPVX(sstr)) {
8941 /* Has something there */
8943 /* Normal PV - clone whole allocated space */
8944 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8947 /* Special case - not normally malloced for some reason */
8948 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
8949 /* A "shared" PV - clone it as unshared string */
8951 SvREADONLY_off(dstr);
8952 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
8955 /* Some other special case - random pointer */
8956 SvPVX(dstr) = SvPVX(sstr);
8962 SvPVX(dstr) = SvPVX(sstr);
8967 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
8971 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
8973 /* look for it in the table first */
8974 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
8978 /* create anew and remember what it is */
8980 ptr_table_store(PL_ptr_table, sstr, dstr);
8983 SvFLAGS(dstr) = SvFLAGS(sstr);
8984 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
8985 SvREFCNT(dstr) = 0; /* must be before any other dups! */
8988 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
8989 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
8990 PL_watch_pvx, SvPVX(sstr));
8993 switch (SvTYPE(sstr)) {
8998 SvANY(dstr) = new_XIV();
8999 SvIVX(dstr) = SvIVX(sstr);
9002 SvANY(dstr) = new_XNV();
9003 SvNVX(dstr) = SvNVX(sstr);
9006 SvANY(dstr) = new_XRV();
9007 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9010 SvANY(dstr) = new_XPV();
9011 SvCUR(dstr) = SvCUR(sstr);
9012 SvLEN(dstr) = SvLEN(sstr);
9013 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9016 SvANY(dstr) = new_XPVIV();
9017 SvCUR(dstr) = SvCUR(sstr);
9018 SvLEN(dstr) = SvLEN(sstr);
9019 SvIVX(dstr) = SvIVX(sstr);
9020 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9023 SvANY(dstr) = new_XPVNV();
9024 SvCUR(dstr) = SvCUR(sstr);
9025 SvLEN(dstr) = SvLEN(sstr);
9026 SvIVX(dstr) = SvIVX(sstr);
9027 SvNVX(dstr) = SvNVX(sstr);
9028 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9031 SvANY(dstr) = new_XPVMG();
9032 SvCUR(dstr) = SvCUR(sstr);
9033 SvLEN(dstr) = SvLEN(sstr);
9034 SvIVX(dstr) = SvIVX(sstr);
9035 SvNVX(dstr) = SvNVX(sstr);
9036 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9037 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9038 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9041 SvANY(dstr) = new_XPVBM();
9042 SvCUR(dstr) = SvCUR(sstr);
9043 SvLEN(dstr) = SvLEN(sstr);
9044 SvIVX(dstr) = SvIVX(sstr);
9045 SvNVX(dstr) = SvNVX(sstr);
9046 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9047 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9048 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9049 BmRARE(dstr) = BmRARE(sstr);
9050 BmUSEFUL(dstr) = BmUSEFUL(sstr);
9051 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
9054 SvANY(dstr) = new_XPVLV();
9055 SvCUR(dstr) = SvCUR(sstr);
9056 SvLEN(dstr) = SvLEN(sstr);
9057 SvIVX(dstr) = SvIVX(sstr);
9058 SvNVX(dstr) = SvNVX(sstr);
9059 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9060 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9061 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9062 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
9063 LvTARGLEN(dstr) = LvTARGLEN(sstr);
9064 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
9065 LvTYPE(dstr) = LvTYPE(sstr);
9068 if (GvUNIQUE((GV*)sstr)) {
9070 if ((share = gv_share(sstr))) {
9074 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
9075 HvNAME(GvSTASH(share)), GvNAME(share));
9080 SvANY(dstr) = new_XPVGV();
9081 SvCUR(dstr) = SvCUR(sstr);
9082 SvLEN(dstr) = SvLEN(sstr);
9083 SvIVX(dstr) = SvIVX(sstr);
9084 SvNVX(dstr) = SvNVX(sstr);
9085 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9086 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9087 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9088 GvNAMELEN(dstr) = GvNAMELEN(sstr);
9089 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
9090 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
9091 GvFLAGS(dstr) = GvFLAGS(sstr);
9092 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9093 (void)GpREFCNT_inc(GvGP(dstr));
9096 SvANY(dstr) = new_XPVIO();
9097 SvCUR(dstr) = SvCUR(sstr);
9098 SvLEN(dstr) = SvLEN(sstr);
9099 SvIVX(dstr) = SvIVX(sstr);
9100 SvNVX(dstr) = SvNVX(sstr);
9101 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9102 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9103 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9104 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
9105 if (IoOFP(sstr) == IoIFP(sstr))
9106 IoOFP(dstr) = IoIFP(dstr);
9108 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
9109 /* PL_rsfp_filters entries have fake IoDIRP() */
9110 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
9111 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
9113 IoDIRP(dstr) = IoDIRP(sstr);
9114 IoLINES(dstr) = IoLINES(sstr);
9115 IoPAGE(dstr) = IoPAGE(sstr);
9116 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
9117 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
9118 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
9119 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
9120 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
9121 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
9122 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
9123 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
9124 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
9125 IoTYPE(dstr) = IoTYPE(sstr);
9126 IoFLAGS(dstr) = IoFLAGS(sstr);
9129 SvANY(dstr) = new_XPVAV();
9130 SvCUR(dstr) = SvCUR(sstr);
9131 SvLEN(dstr) = SvLEN(sstr);
9132 SvIVX(dstr) = SvIVX(sstr);
9133 SvNVX(dstr) = SvNVX(sstr);
9134 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9135 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9136 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
9137 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
9138 if (AvARRAY((AV*)sstr)) {
9139 SV **dst_ary, **src_ary;
9140 SSize_t items = AvFILLp((AV*)sstr) + 1;
9142 src_ary = AvARRAY((AV*)sstr);
9143 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
9144 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9145 SvPVX(dstr) = (char*)dst_ary;
9146 AvALLOC((AV*)dstr) = dst_ary;
9147 if (AvREAL((AV*)sstr)) {
9149 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9153 *dst_ary++ = sv_dup(*src_ary++, param);
9155 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9156 while (items-- > 0) {
9157 *dst_ary++ = &PL_sv_undef;
9161 SvPVX(dstr) = Nullch;
9162 AvALLOC((AV*)dstr) = (SV**)NULL;
9166 SvANY(dstr) = new_XPVHV();
9167 SvCUR(dstr) = SvCUR(sstr);
9168 SvLEN(dstr) = SvLEN(sstr);
9169 SvIVX(dstr) = SvIVX(sstr);
9170 SvNVX(dstr) = SvNVX(sstr);
9171 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9172 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9173 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
9174 if (HvARRAY((HV*)sstr)) {
9176 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
9177 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
9178 Newz(0, dxhv->xhv_array,
9179 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
9180 while (i <= sxhv->xhv_max) {
9181 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
9182 !!HvSHAREKEYS(sstr), param);
9185 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter, !!HvSHAREKEYS(sstr), param);
9188 SvPVX(dstr) = Nullch;
9189 HvEITER((HV*)dstr) = (HE*)NULL;
9191 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
9192 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
9193 /* Record stashes for possible cloning in Perl_clone(). */
9194 if(HvNAME((HV*)dstr))
9195 av_push(param->stashes, dstr);
9198 SvANY(dstr) = new_XPVFM();
9199 FmLINES(dstr) = FmLINES(sstr);
9203 SvANY(dstr) = new_XPVCV();
9205 SvCUR(dstr) = SvCUR(sstr);
9206 SvLEN(dstr) = SvLEN(sstr);
9207 SvIVX(dstr) = SvIVX(sstr);
9208 SvNVX(dstr) = SvNVX(sstr);
9209 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9210 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9211 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9212 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
9213 CvSTART(dstr) = CvSTART(sstr);
9214 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
9215 CvXSUB(dstr) = CvXSUB(sstr);
9216 CvXSUBANY(dstr) = CvXSUBANY(sstr);
9217 if (CvCONST(sstr)) {
9218 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
9219 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
9220 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
9222 CvGV(dstr) = gv_dup(CvGV(sstr), param);
9223 if (param->flags & CLONEf_COPY_STACKS) {
9224 CvDEPTH(dstr) = CvDEPTH(sstr);
9228 if (CvPADLIST(sstr) && !AvREAL(CvPADLIST(sstr))) {
9229 /* XXX padlists are real, but pretend to be not */
9230 AvREAL_on(CvPADLIST(sstr));
9231 CvPADLIST(dstr) = av_dup_inc(CvPADLIST(sstr), param);
9232 AvREAL_off(CvPADLIST(sstr));
9233 AvREAL_off(CvPADLIST(dstr));
9236 CvPADLIST(dstr) = av_dup_inc(CvPADLIST(sstr), param);
9237 if (!CvANON(sstr) || CvCLONED(sstr))
9238 CvOUTSIDE(dstr) = cv_dup_inc(CvOUTSIDE(sstr), param);
9240 CvOUTSIDE(dstr) = cv_dup(CvOUTSIDE(sstr), param);
9241 CvFLAGS(dstr) = CvFLAGS(sstr);
9242 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
9245 Perl_croak(aTHX_ "Bizarre SvTYPE [%d]", SvTYPE(sstr));
9249 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9255 /* duplicate a context */
9258 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9263 return (PERL_CONTEXT*)NULL;
9265 /* look for it in the table first */
9266 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9270 /* create anew and remember what it is */
9271 Newz(56, ncxs, max + 1, PERL_CONTEXT);
9272 ptr_table_store(PL_ptr_table, cxs, ncxs);
9275 PERL_CONTEXT *cx = &cxs[ix];
9276 PERL_CONTEXT *ncx = &ncxs[ix];
9277 ncx->cx_type = cx->cx_type;
9278 if (CxTYPE(cx) == CXt_SUBST) {
9279 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9282 ncx->blk_oldsp = cx->blk_oldsp;
9283 ncx->blk_oldcop = cx->blk_oldcop;
9284 ncx->blk_oldretsp = cx->blk_oldretsp;
9285 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9286 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9287 ncx->blk_oldpm = cx->blk_oldpm;
9288 ncx->blk_gimme = cx->blk_gimme;
9289 switch (CxTYPE(cx)) {
9291 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9292 ? cv_dup_inc(cx->blk_sub.cv, param)
9293 : cv_dup(cx->blk_sub.cv,param));
9294 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9295 ? av_dup_inc(cx->blk_sub.argarray, param)
9297 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9298 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9299 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9300 ncx->blk_sub.lval = cx->blk_sub.lval;
9303 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9304 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9305 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);;
9306 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9307 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9310 ncx->blk_loop.label = cx->blk_loop.label;
9311 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9312 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9313 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9314 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9315 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9316 ? cx->blk_loop.iterdata
9317 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9318 ncx->blk_loop.oldcurpad
9319 = (SV**)ptr_table_fetch(PL_ptr_table,
9320 cx->blk_loop.oldcurpad);
9321 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9322 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9323 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9324 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9325 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9328 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9329 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9330 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9331 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9343 /* duplicate a stack info structure */
9346 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9351 return (PERL_SI*)NULL;
9353 /* look for it in the table first */
9354 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9358 /* create anew and remember what it is */
9359 Newz(56, nsi, 1, PERL_SI);
9360 ptr_table_store(PL_ptr_table, si, nsi);
9362 nsi->si_stack = av_dup_inc(si->si_stack, param);
9363 nsi->si_cxix = si->si_cxix;
9364 nsi->si_cxmax = si->si_cxmax;
9365 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9366 nsi->si_type = si->si_type;
9367 nsi->si_prev = si_dup(si->si_prev, param);
9368 nsi->si_next = si_dup(si->si_next, param);
9369 nsi->si_markoff = si->si_markoff;
9374 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9375 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9376 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9377 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9378 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9379 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9380 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9381 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9382 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9383 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9384 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9385 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9388 #define pv_dup_inc(p) SAVEPV(p)
9389 #define pv_dup(p) SAVEPV(p)
9390 #define svp_dup_inc(p,pp) any_dup(p,pp)
9392 /* map any object to the new equivent - either something in the
9393 * ptr table, or something in the interpreter structure
9397 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
9404 /* look for it in the table first */
9405 ret = ptr_table_fetch(PL_ptr_table, v);
9409 /* see if it is part of the interpreter structure */
9410 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9411 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9419 /* duplicate the save stack */
9422 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9424 ANY *ss = proto_perl->Tsavestack;
9425 I32 ix = proto_perl->Tsavestack_ix;
9426 I32 max = proto_perl->Tsavestack_max;
9439 void (*dptr) (void*);
9440 void (*dxptr) (pTHX_ void*);
9443 Newz(54, nss, max, ANY);
9449 case SAVEt_ITEM: /* normal string */
9450 sv = (SV*)POPPTR(ss,ix);
9451 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9452 sv = (SV*)POPPTR(ss,ix);
9453 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9455 case SAVEt_SV: /* scalar reference */
9456 sv = (SV*)POPPTR(ss,ix);
9457 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9458 gv = (GV*)POPPTR(ss,ix);
9459 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9461 case SAVEt_GENERIC_PVREF: /* generic char* */
9462 c = (char*)POPPTR(ss,ix);
9463 TOPPTR(nss,ix) = pv_dup(c);
9464 ptr = POPPTR(ss,ix);
9465 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9467 case SAVEt_SHARED_PVREF: /* char* in shared space */
9468 c = (char*)POPPTR(ss,ix);
9469 TOPPTR(nss,ix) = savesharedpv(c);
9470 ptr = POPPTR(ss,ix);
9471 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9473 case SAVEt_GENERIC_SVREF: /* generic sv */
9474 case SAVEt_SVREF: /* scalar reference */
9475 sv = (SV*)POPPTR(ss,ix);
9476 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9477 ptr = POPPTR(ss,ix);
9478 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9480 case SAVEt_AV: /* array reference */
9481 av = (AV*)POPPTR(ss,ix);
9482 TOPPTR(nss,ix) = av_dup_inc(av, param);
9483 gv = (GV*)POPPTR(ss,ix);
9484 TOPPTR(nss,ix) = gv_dup(gv, param);
9486 case SAVEt_HV: /* hash reference */
9487 hv = (HV*)POPPTR(ss,ix);
9488 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9489 gv = (GV*)POPPTR(ss,ix);
9490 TOPPTR(nss,ix) = gv_dup(gv, param);
9492 case SAVEt_INT: /* int reference */
9493 ptr = POPPTR(ss,ix);
9494 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9495 intval = (int)POPINT(ss,ix);
9496 TOPINT(nss,ix) = intval;
9498 case SAVEt_LONG: /* long reference */
9499 ptr = POPPTR(ss,ix);
9500 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9501 longval = (long)POPLONG(ss,ix);
9502 TOPLONG(nss,ix) = longval;
9504 case SAVEt_I32: /* I32 reference */
9505 case SAVEt_I16: /* I16 reference */
9506 case SAVEt_I8: /* I8 reference */
9507 ptr = POPPTR(ss,ix);
9508 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9512 case SAVEt_IV: /* IV reference */
9513 ptr = POPPTR(ss,ix);
9514 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9518 case SAVEt_SPTR: /* SV* reference */
9519 ptr = POPPTR(ss,ix);
9520 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9521 sv = (SV*)POPPTR(ss,ix);
9522 TOPPTR(nss,ix) = sv_dup(sv, param);
9524 case SAVEt_VPTR: /* random* reference */
9525 ptr = POPPTR(ss,ix);
9526 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9527 ptr = POPPTR(ss,ix);
9528 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9530 case SAVEt_PPTR: /* char* reference */
9531 ptr = POPPTR(ss,ix);
9532 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9533 c = (char*)POPPTR(ss,ix);
9534 TOPPTR(nss,ix) = pv_dup(c);
9536 case SAVEt_HPTR: /* HV* reference */
9537 ptr = POPPTR(ss,ix);
9538 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9539 hv = (HV*)POPPTR(ss,ix);
9540 TOPPTR(nss,ix) = hv_dup(hv, param);
9542 case SAVEt_APTR: /* AV* reference */
9543 ptr = POPPTR(ss,ix);
9544 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9545 av = (AV*)POPPTR(ss,ix);
9546 TOPPTR(nss,ix) = av_dup(av, param);
9549 gv = (GV*)POPPTR(ss,ix);
9550 TOPPTR(nss,ix) = gv_dup(gv, param);
9552 case SAVEt_GP: /* scalar reference */
9553 gp = (GP*)POPPTR(ss,ix);
9554 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9555 (void)GpREFCNT_inc(gp);
9556 gv = (GV*)POPPTR(ss,ix);
9557 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9558 c = (char*)POPPTR(ss,ix);
9559 TOPPTR(nss,ix) = pv_dup(c);
9566 case SAVEt_MORTALIZESV:
9567 sv = (SV*)POPPTR(ss,ix);
9568 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9571 ptr = POPPTR(ss,ix);
9572 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9573 /* these are assumed to be refcounted properly */
9574 switch (((OP*)ptr)->op_type) {
9581 TOPPTR(nss,ix) = ptr;
9586 TOPPTR(nss,ix) = Nullop;
9591 TOPPTR(nss,ix) = Nullop;
9594 c = (char*)POPPTR(ss,ix);
9595 TOPPTR(nss,ix) = pv_dup_inc(c);
9598 longval = POPLONG(ss,ix);
9599 TOPLONG(nss,ix) = longval;
9602 hv = (HV*)POPPTR(ss,ix);
9603 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9604 c = (char*)POPPTR(ss,ix);
9605 TOPPTR(nss,ix) = pv_dup_inc(c);
9609 case SAVEt_DESTRUCTOR:
9610 ptr = POPPTR(ss,ix);
9611 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9612 dptr = POPDPTR(ss,ix);
9613 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
9615 case SAVEt_DESTRUCTOR_X:
9616 ptr = POPPTR(ss,ix);
9617 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9618 dxptr = POPDXPTR(ss,ix);
9619 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
9621 case SAVEt_REGCONTEXT:
9627 case SAVEt_STACK_POS: /* Position on Perl stack */
9631 case SAVEt_AELEM: /* array element */
9632 sv = (SV*)POPPTR(ss,ix);
9633 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9636 av = (AV*)POPPTR(ss,ix);
9637 TOPPTR(nss,ix) = av_dup_inc(av, param);
9639 case SAVEt_HELEM: /* hash element */
9640 sv = (SV*)POPPTR(ss,ix);
9641 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9642 sv = (SV*)POPPTR(ss,ix);
9643 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9644 hv = (HV*)POPPTR(ss,ix);
9645 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9648 ptr = POPPTR(ss,ix);
9649 TOPPTR(nss,ix) = ptr;
9656 av = (AV*)POPPTR(ss,ix);
9657 TOPPTR(nss,ix) = av_dup(av, param);
9660 longval = (long)POPLONG(ss,ix);
9661 TOPLONG(nss,ix) = longval;
9662 ptr = POPPTR(ss,ix);
9663 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9664 sv = (SV*)POPPTR(ss,ix);
9665 TOPPTR(nss,ix) = sv_dup(sv, param);
9668 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9676 =for apidoc perl_clone
9678 Create and return a new interpreter by cloning the current one.
9683 /* XXX the above needs expanding by someone who actually understands it ! */
9684 EXTERN_C PerlInterpreter *
9685 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
9688 perl_clone(PerlInterpreter *proto_perl, UV flags)
9690 #ifdef PERL_IMPLICIT_SYS
9692 /* perlhost.h so we need to call into it
9693 to clone the host, CPerlHost should have a c interface, sky */
9695 if (flags & CLONEf_CLONE_HOST) {
9696 return perl_clone_host(proto_perl,flags);
9698 return perl_clone_using(proto_perl, flags,
9700 proto_perl->IMemShared,
9701 proto_perl->IMemParse,
9711 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
9712 struct IPerlMem* ipM, struct IPerlMem* ipMS,
9713 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
9714 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
9715 struct IPerlDir* ipD, struct IPerlSock* ipS,
9716 struct IPerlProc* ipP)
9718 /* XXX many of the string copies here can be optimized if they're
9719 * constants; they need to be allocated as common memory and just
9720 * their pointers copied. */
9723 CLONE_PARAMS clone_params;
9724 CLONE_PARAMS* param = &clone_params;
9726 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
9727 PERL_SET_THX(my_perl);
9730 memset(my_perl, 0xab, sizeof(PerlInterpreter));
9736 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
9737 # else /* !DEBUGGING */
9738 Zero(my_perl, 1, PerlInterpreter);
9739 # endif /* DEBUGGING */
9743 PL_MemShared = ipMS;
9751 #else /* !PERL_IMPLICIT_SYS */
9753 CLONE_PARAMS clone_params;
9754 CLONE_PARAMS* param = &clone_params;
9755 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
9756 PERL_SET_THX(my_perl);
9761 memset(my_perl, 0xab, sizeof(PerlInterpreter));
9767 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
9768 # else /* !DEBUGGING */
9769 Zero(my_perl, 1, PerlInterpreter);
9770 # endif /* DEBUGGING */
9771 #endif /* PERL_IMPLICIT_SYS */
9772 param->flags = flags;
9775 PL_xiv_arenaroot = NULL;
9777 PL_xnv_arenaroot = NULL;
9779 PL_xrv_arenaroot = NULL;
9781 PL_xpv_arenaroot = NULL;
9783 PL_xpviv_arenaroot = NULL;
9784 PL_xpviv_root = NULL;
9785 PL_xpvnv_arenaroot = NULL;
9786 PL_xpvnv_root = NULL;
9787 PL_xpvcv_arenaroot = NULL;
9788 PL_xpvcv_root = NULL;
9789 PL_xpvav_arenaroot = NULL;
9790 PL_xpvav_root = NULL;
9791 PL_xpvhv_arenaroot = NULL;
9792 PL_xpvhv_root = NULL;
9793 PL_xpvmg_arenaroot = NULL;
9794 PL_xpvmg_root = NULL;
9795 PL_xpvlv_arenaroot = NULL;
9796 PL_xpvlv_root = NULL;
9797 PL_xpvbm_arenaroot = NULL;
9798 PL_xpvbm_root = NULL;
9799 PL_he_arenaroot = NULL;
9801 PL_nice_chunk = NULL;
9802 PL_nice_chunk_size = 0;
9805 PL_sv_root = Nullsv;
9806 PL_sv_arenaroot = Nullsv;
9808 PL_debug = proto_perl->Idebug;
9810 #ifdef USE_REENTRANT_API
9811 New(31337, PL_reentrant_buffer,1, REBUF);
9812 New(31337, PL_reentrant_buffer->tmbuff,1, struct tm);
9815 /* create SV map for pointer relocation */
9816 PL_ptr_table = ptr_table_new();
9818 /* initialize these special pointers as early as possible */
9819 SvANY(&PL_sv_undef) = NULL;
9820 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
9821 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
9822 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
9824 SvANY(&PL_sv_no) = new_XPVNV();
9825 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
9826 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
9827 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
9828 SvCUR(&PL_sv_no) = 0;
9829 SvLEN(&PL_sv_no) = 1;
9830 SvNVX(&PL_sv_no) = 0;
9831 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
9833 SvANY(&PL_sv_yes) = new_XPVNV();
9834 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
9835 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
9836 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
9837 SvCUR(&PL_sv_yes) = 1;
9838 SvLEN(&PL_sv_yes) = 2;
9839 SvNVX(&PL_sv_yes) = 1;
9840 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
9842 /* create (a non-shared!) shared string table */
9843 PL_strtab = newHV();
9844 HvSHAREKEYS_off(PL_strtab);
9845 hv_ksplit(PL_strtab, 512);
9846 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
9848 PL_compiling = proto_perl->Icompiling;
9850 /* These two PVs will be free'd special way so must set them same way op.c does */
9851 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
9852 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
9854 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
9855 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
9857 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
9858 if (!specialWARN(PL_compiling.cop_warnings))
9859 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
9860 if (!specialCopIO(PL_compiling.cop_io))
9861 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
9862 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
9864 /* pseudo environmental stuff */
9865 PL_origargc = proto_perl->Iorigargc;
9867 New(0, PL_origargv, i+1, char*);
9868 PL_origargv[i] = '\0';
9870 PL_origargv[i] = SAVEPV(proto_perl->Iorigargv[i]);
9873 param->stashes = newAV(); /* Setup array of objects to call clone on */
9875 #ifdef PERLIO_LAYERS
9876 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
9877 PerlIO_clone(aTHX_ proto_perl, param);
9880 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
9881 PL_incgv = gv_dup(proto_perl->Iincgv, param);
9882 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
9883 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
9884 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
9885 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
9888 PL_minus_c = proto_perl->Iminus_c;
9889 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
9890 PL_localpatches = proto_perl->Ilocalpatches;
9891 PL_splitstr = proto_perl->Isplitstr;
9892 PL_preprocess = proto_perl->Ipreprocess;
9893 PL_minus_n = proto_perl->Iminus_n;
9894 PL_minus_p = proto_perl->Iminus_p;
9895 PL_minus_l = proto_perl->Iminus_l;
9896 PL_minus_a = proto_perl->Iminus_a;
9897 PL_minus_F = proto_perl->Iminus_F;
9898 PL_doswitches = proto_perl->Idoswitches;
9899 PL_dowarn = proto_perl->Idowarn;
9900 PL_doextract = proto_perl->Idoextract;
9901 PL_sawampersand = proto_perl->Isawampersand;
9902 PL_unsafe = proto_perl->Iunsafe;
9903 PL_inplace = SAVEPV(proto_perl->Iinplace);
9904 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
9905 PL_perldb = proto_perl->Iperldb;
9906 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
9907 PL_exit_flags = proto_perl->Iexit_flags;
9909 /* magical thingies */
9910 /* XXX time(&PL_basetime) when asked for? */
9911 PL_basetime = proto_perl->Ibasetime;
9912 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
9914 PL_maxsysfd = proto_perl->Imaxsysfd;
9915 PL_multiline = proto_perl->Imultiline;
9916 PL_statusvalue = proto_perl->Istatusvalue;
9918 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
9920 PL_encoding = sv_dup(proto_perl->Iencoding, param);
9922 /* Clone the regex array */
9923 PL_regex_padav = newAV();
9925 I32 len = av_len((AV*)proto_perl->Iregex_padav);
9926 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
9927 av_push(PL_regex_padav,
9928 sv_dup_inc(regexen[0],param));
9929 for(i = 1; i <= len; i++) {
9930 if(SvREPADTMP(regexen[i])) {
9931 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
9933 av_push(PL_regex_padav,
9935 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
9936 SvIVX(regexen[i])), param)))
9941 PL_regex_pad = AvARRAY(PL_regex_padav);
9943 /* shortcuts to various I/O objects */
9944 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
9945 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
9946 PL_defgv = gv_dup(proto_perl->Idefgv, param);
9947 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
9948 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
9949 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
9951 /* shortcuts to regexp stuff */
9952 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
9954 /* shortcuts to misc objects */
9955 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
9957 /* shortcuts to debugging objects */
9958 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
9959 PL_DBline = gv_dup(proto_perl->IDBline, param);
9960 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
9961 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
9962 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
9963 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
9964 PL_lineary = av_dup(proto_perl->Ilineary, param);
9965 PL_dbargs = av_dup(proto_perl->Idbargs, param);
9968 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
9969 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
9970 PL_nullstash = hv_dup(proto_perl->Inullstash, param);
9971 PL_debstash = hv_dup(proto_perl->Idebstash, param);
9972 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
9973 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
9975 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
9976 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
9977 PL_endav = av_dup_inc(proto_perl->Iendav, param);
9978 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
9979 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
9981 PL_sub_generation = proto_perl->Isub_generation;
9983 /* funky return mechanisms */
9984 PL_forkprocess = proto_perl->Iforkprocess;
9986 /* subprocess state */
9987 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
9989 /* internal state */
9990 PL_tainting = proto_perl->Itainting;
9991 PL_maxo = proto_perl->Imaxo;
9992 if (proto_perl->Iop_mask)
9993 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
9995 PL_op_mask = Nullch;
9997 /* current interpreter roots */
9998 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
9999 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10000 PL_main_start = proto_perl->Imain_start;
10001 PL_eval_root = proto_perl->Ieval_root;
10002 PL_eval_start = proto_perl->Ieval_start;
10004 /* runtime control stuff */
10005 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10006 PL_copline = proto_perl->Icopline;
10008 PL_filemode = proto_perl->Ifilemode;
10009 PL_lastfd = proto_perl->Ilastfd;
10010 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10013 PL_gensym = proto_perl->Igensym;
10014 PL_preambled = proto_perl->Ipreambled;
10015 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10016 PL_laststatval = proto_perl->Ilaststatval;
10017 PL_laststype = proto_perl->Ilaststype;
10018 PL_mess_sv = Nullsv;
10020 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10021 PL_ofmt = SAVEPV(proto_perl->Iofmt);
10023 /* interpreter atexit processing */
10024 PL_exitlistlen = proto_perl->Iexitlistlen;
10025 if (PL_exitlistlen) {
10026 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10027 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10030 PL_exitlist = (PerlExitListEntry*)NULL;
10031 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10032 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10033 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10035 PL_profiledata = NULL;
10036 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10037 /* PL_rsfp_filters entries have fake IoDIRP() */
10038 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10040 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10041 PL_comppad = av_dup(proto_perl->Icomppad, param);
10042 PL_comppad_name = av_dup(proto_perl->Icomppad_name, param);
10043 PL_comppad_name_fill = proto_perl->Icomppad_name_fill;
10044 PL_comppad_name_floor = proto_perl->Icomppad_name_floor;
10045 PL_curpad = (SV**)ptr_table_fetch(PL_ptr_table,
10046 proto_perl->Tcurpad);
10048 #ifdef HAVE_INTERP_INTERN
10049 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10052 /* more statics moved here */
10053 PL_generation = proto_perl->Igeneration;
10054 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10056 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10057 PL_in_clean_all = proto_perl->Iin_clean_all;
10059 PL_uid = proto_perl->Iuid;
10060 PL_euid = proto_perl->Ieuid;
10061 PL_gid = proto_perl->Igid;
10062 PL_egid = proto_perl->Iegid;
10063 PL_nomemok = proto_perl->Inomemok;
10064 PL_an = proto_perl->Ian;
10065 PL_cop_seqmax = proto_perl->Icop_seqmax;
10066 PL_op_seqmax = proto_perl->Iop_seqmax;
10067 PL_evalseq = proto_perl->Ievalseq;
10068 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10069 PL_origalen = proto_perl->Iorigalen;
10070 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10071 PL_osname = SAVEPV(proto_perl->Iosname);
10072 PL_sh_path = proto_perl->Ish_path; /* XXX never deallocated */
10073 PL_sighandlerp = proto_perl->Isighandlerp;
10076 PL_runops = proto_perl->Irunops;
10078 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10081 PL_cshlen = proto_perl->Icshlen;
10082 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10085 PL_lex_state = proto_perl->Ilex_state;
10086 PL_lex_defer = proto_perl->Ilex_defer;
10087 PL_lex_expect = proto_perl->Ilex_expect;
10088 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10089 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10090 PL_lex_starts = proto_perl->Ilex_starts;
10091 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10092 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10093 PL_lex_op = proto_perl->Ilex_op;
10094 PL_lex_inpat = proto_perl->Ilex_inpat;
10095 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10096 PL_lex_brackets = proto_perl->Ilex_brackets;
10097 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10098 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10099 PL_lex_casemods = proto_perl->Ilex_casemods;
10100 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10101 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10103 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10104 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10105 PL_nexttoke = proto_perl->Inexttoke;
10107 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10108 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
10109 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10110 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
10111 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10112 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
10113 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10114 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10115 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
10116 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10117 PL_pending_ident = proto_perl->Ipending_ident;
10118 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10120 PL_expect = proto_perl->Iexpect;
10122 PL_multi_start = proto_perl->Imulti_start;
10123 PL_multi_end = proto_perl->Imulti_end;
10124 PL_multi_open = proto_perl->Imulti_open;
10125 PL_multi_close = proto_perl->Imulti_close;
10127 PL_error_count = proto_perl->Ierror_count;
10128 PL_subline = proto_perl->Isubline;
10129 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10131 PL_min_intro_pending = proto_perl->Imin_intro_pending;
10132 PL_max_intro_pending = proto_perl->Imax_intro_pending;
10133 PL_padix = proto_perl->Ipadix;
10134 PL_padix_floor = proto_perl->Ipadix_floor;
10135 PL_pad_reset_pending = proto_perl->Ipad_reset_pending;
10137 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
10138 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10139 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
10140 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10141 PL_last_lop_op = proto_perl->Ilast_lop_op;
10142 PL_in_my = proto_perl->Iin_my;
10143 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10145 PL_cryptseen = proto_perl->Icryptseen;
10148 PL_hints = proto_perl->Ihints;
10150 PL_amagic_generation = proto_perl->Iamagic_generation;
10152 #ifdef USE_LOCALE_COLLATE
10153 PL_collation_ix = proto_perl->Icollation_ix;
10154 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10155 PL_collation_standard = proto_perl->Icollation_standard;
10156 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10157 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10158 #endif /* USE_LOCALE_COLLATE */
10160 #ifdef USE_LOCALE_NUMERIC
10161 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10162 PL_numeric_standard = proto_perl->Inumeric_standard;
10163 PL_numeric_local = proto_perl->Inumeric_local;
10164 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10165 #endif /* !USE_LOCALE_NUMERIC */
10167 /* utf8 character classes */
10168 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10169 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10170 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10171 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10172 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10173 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10174 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10175 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10176 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10177 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10178 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10179 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10180 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10181 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10182 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10183 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10184 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10185 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10188 PL_last_swash_hv = Nullhv; /* reinits on demand */
10189 PL_last_swash_klen = 0;
10190 PL_last_swash_key[0]= '\0';
10191 PL_last_swash_tmps = (U8*)NULL;
10192 PL_last_swash_slen = 0;
10194 /* perly.c globals */
10195 PL_yydebug = proto_perl->Iyydebug;
10196 PL_yynerrs = proto_perl->Iyynerrs;
10197 PL_yyerrflag = proto_perl->Iyyerrflag;
10198 PL_yychar = proto_perl->Iyychar;
10199 PL_yyval = proto_perl->Iyyval;
10200 PL_yylval = proto_perl->Iyylval;
10202 PL_glob_index = proto_perl->Iglob_index;
10203 PL_srand_called = proto_perl->Isrand_called;
10204 PL_uudmap['M'] = 0; /* reinits on demand */
10205 PL_bitcount = Nullch; /* reinits on demand */
10207 if (proto_perl->Ipsig_pend) {
10208 Newz(0, PL_psig_pend, SIG_SIZE, int);
10211 PL_psig_pend = (int*)NULL;
10214 if (proto_perl->Ipsig_ptr) {
10215 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
10216 Newz(0, PL_psig_name, SIG_SIZE, SV*);
10217 for (i = 1; i < SIG_SIZE; i++) {
10218 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10219 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10223 PL_psig_ptr = (SV**)NULL;
10224 PL_psig_name = (SV**)NULL;
10227 /* thrdvar.h stuff */
10229 if (flags & CLONEf_COPY_STACKS) {
10230 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10231 PL_tmps_ix = proto_perl->Ttmps_ix;
10232 PL_tmps_max = proto_perl->Ttmps_max;
10233 PL_tmps_floor = proto_perl->Ttmps_floor;
10234 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
10236 while (i <= PL_tmps_ix) {
10237 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10241 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10242 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10243 Newz(54, PL_markstack, i, I32);
10244 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10245 - proto_perl->Tmarkstack);
10246 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10247 - proto_perl->Tmarkstack);
10248 Copy(proto_perl->Tmarkstack, PL_markstack,
10249 PL_markstack_ptr - PL_markstack + 1, I32);
10251 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10252 * NOTE: unlike the others! */
10253 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10254 PL_scopestack_max = proto_perl->Tscopestack_max;
10255 Newz(54, PL_scopestack, PL_scopestack_max, I32);
10256 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10258 /* next push_return() sets PL_retstack[PL_retstack_ix]
10259 * NOTE: unlike the others! */
10260 PL_retstack_ix = proto_perl->Tretstack_ix;
10261 PL_retstack_max = proto_perl->Tretstack_max;
10262 Newz(54, PL_retstack, PL_retstack_max, OP*);
10263 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, I32);
10265 /* NOTE: si_dup() looks at PL_markstack */
10266 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10268 /* PL_curstack = PL_curstackinfo->si_stack; */
10269 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10270 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10272 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10273 PL_stack_base = AvARRAY(PL_curstack);
10274 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10275 - proto_perl->Tstack_base);
10276 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10278 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10279 * NOTE: unlike the others! */
10280 PL_savestack_ix = proto_perl->Tsavestack_ix;
10281 PL_savestack_max = proto_perl->Tsavestack_max;
10282 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
10283 PL_savestack = ss_dup(proto_perl, param);
10287 ENTER; /* perl_destruct() wants to LEAVE; */
10290 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10291 PL_top_env = &PL_start_env;
10293 PL_op = proto_perl->Top;
10296 PL_Xpv = (XPV*)NULL;
10297 PL_na = proto_perl->Tna;
10299 PL_statbuf = proto_perl->Tstatbuf;
10300 PL_statcache = proto_perl->Tstatcache;
10301 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10302 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10304 PL_timesbuf = proto_perl->Ttimesbuf;
10307 PL_tainted = proto_perl->Ttainted;
10308 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10309 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10310 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10311 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10312 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10313 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10314 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10315 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10316 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10318 PL_restartop = proto_perl->Trestartop;
10319 PL_in_eval = proto_perl->Tin_eval;
10320 PL_delaymagic = proto_perl->Tdelaymagic;
10321 PL_dirty = proto_perl->Tdirty;
10322 PL_localizing = proto_perl->Tlocalizing;
10324 #ifdef PERL_FLEXIBLE_EXCEPTIONS
10325 PL_protect = proto_perl->Tprotect;
10327 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10328 PL_av_fetch_sv = Nullsv;
10329 PL_hv_fetch_sv = Nullsv;
10330 Zero(&PL_hv_fetch_ent_mh, 1, HE); /* XXX */
10331 PL_modcount = proto_perl->Tmodcount;
10332 PL_lastgotoprobe = Nullop;
10333 PL_dumpindent = proto_perl->Tdumpindent;
10335 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10336 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10337 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10338 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10339 PL_sortcxix = proto_perl->Tsortcxix;
10340 PL_efloatbuf = Nullch; /* reinits on demand */
10341 PL_efloatsize = 0; /* reinits on demand */
10345 PL_screamfirst = NULL;
10346 PL_screamnext = NULL;
10347 PL_maxscream = -1; /* reinits on demand */
10348 PL_lastscream = Nullsv;
10350 PL_watchaddr = NULL;
10351 PL_watchok = Nullch;
10353 PL_regdummy = proto_perl->Tregdummy;
10354 PL_regcomp_parse = Nullch;
10355 PL_regxend = Nullch;
10356 PL_regcode = (regnode*)NULL;
10359 PL_regprecomp = Nullch;
10364 PL_seen_zerolen = 0;
10366 PL_regcomp_rx = (regexp*)NULL;
10368 PL_colorset = 0; /* reinits PL_colors[] */
10369 /*PL_colors[6] = {0,0,0,0,0,0};*/
10370 PL_reg_whilem_seen = 0;
10371 PL_reginput = Nullch;
10372 PL_regbol = Nullch;
10373 PL_regeol = Nullch;
10374 PL_regstartp = (I32*)NULL;
10375 PL_regendp = (I32*)NULL;
10376 PL_reglastparen = (U32*)NULL;
10377 PL_regtill = Nullch;
10378 PL_reg_start_tmp = (char**)NULL;
10379 PL_reg_start_tmpl = 0;
10380 PL_regdata = (struct reg_data*)NULL;
10383 PL_reg_eval_set = 0;
10385 PL_regprogram = (regnode*)NULL;
10387 PL_regcc = (CURCUR*)NULL;
10388 PL_reg_call_cc = (struct re_cc_state*)NULL;
10389 PL_reg_re = (regexp*)NULL;
10390 PL_reg_ganch = Nullch;
10391 PL_reg_sv = Nullsv;
10392 PL_reg_match_utf8 = FALSE;
10393 PL_reg_magic = (MAGIC*)NULL;
10395 PL_reg_oldcurpm = (PMOP*)NULL;
10396 PL_reg_curpm = (PMOP*)NULL;
10397 PL_reg_oldsaved = Nullch;
10398 PL_reg_oldsavedlen = 0;
10399 PL_reg_maxiter = 0;
10400 PL_reg_leftiter = 0;
10401 PL_reg_poscache = Nullch;
10402 PL_reg_poscache_size= 0;
10404 /* RE engine - function pointers */
10405 PL_regcompp = proto_perl->Tregcompp;
10406 PL_regexecp = proto_perl->Tregexecp;
10407 PL_regint_start = proto_perl->Tregint_start;
10408 PL_regint_string = proto_perl->Tregint_string;
10409 PL_regfree = proto_perl->Tregfree;
10411 PL_reginterp_cnt = 0;
10412 PL_reg_starttry = 0;
10414 /* Pluggable optimizer */
10415 PL_peepp = proto_perl->Tpeepp;
10417 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10418 ptr_table_free(PL_ptr_table);
10419 PL_ptr_table = NULL;
10422 /* Call the ->CLONE method, if it exists, for each of the stashes
10423 identified by sv_dup() above.
10425 while(av_len(param->stashes) != -1) {
10426 HV* stash = (HV*) av_shift(param->stashes);
10427 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10428 if (cloner && GvCV(cloner)) {
10433 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
10435 call_sv((SV*)GvCV(cloner), G_DISCARD);
10441 SvREFCNT_dec(param->stashes);
10446 #endif /* USE_ITHREADS */
10449 =head1 Unicode Support
10451 =for apidoc sv_recode_to_utf8
10453 The encoding is assumed to be an Encode object, on entry the PV
10454 of the sv is assumed to be octets in that encoding, and the sv
10455 will be converted into Unicode (and UTF-8).
10457 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10458 is not a reference, nothing is done to the sv. If the encoding is not
10459 an C<Encode::XS> Encoding object, bad things will happen.
10460 (See F<lib/encoding.pm> and L<Encode>).
10462 The PV of the sv is returned.
10467 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10469 if (SvPOK(sv) && !DO_UTF8(sv) && SvROK(encoding)) {
10480 XPUSHs(&PL_sv_yes);
10482 call_method("decode", G_SCALAR);
10486 s = SvPV(uni, len);
10487 if (s != SvPVX(sv)) {
10489 Move(s, SvPVX(sv), len, char);
10490 SvCUR_set(sv, len);