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);
4420 =for apidoc sv_magic
4422 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4423 then adds a new magic item of type C<how> to the head of the magic list.
4425 C<name> is assumed to contain an C<SV*> if C<(name && namelen == HEf_SVKEY)>
4431 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4435 if (SvREADONLY(sv)) {
4436 if (PL_curcop != &PL_compiling
4437 && how != PERL_MAGIC_regex_global
4438 && how != PERL_MAGIC_bm
4439 && how != PERL_MAGIC_fm
4440 && how != PERL_MAGIC_sv
4443 Perl_croak(aTHX_ PL_no_modify);
4446 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4447 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4448 if (how == PERL_MAGIC_taint)
4454 (void)SvUPGRADE(sv, SVt_PVMG);
4456 Newz(702,mg, 1, MAGIC);
4457 mg->mg_moremagic = SvMAGIC(sv);
4460 /* Some magic sontains a reference loop, where the sv and object refer to
4461 each other. To prevent a reference loop that would prevent such
4462 objects being freed, we look for such loops and if we find one we
4463 avoid incrementing the object refcount. */
4464 if (!obj || obj == sv ||
4465 how == PERL_MAGIC_arylen ||
4466 how == PERL_MAGIC_qr ||
4467 (SvTYPE(obj) == SVt_PVGV &&
4468 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4469 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4470 GvFORM(obj) == (CV*)sv)))
4475 mg->mg_obj = SvREFCNT_inc(obj);
4476 mg->mg_flags |= MGf_REFCOUNTED;
4479 mg->mg_len = namlen;
4482 mg->mg_ptr = savepvn(name, namlen);
4483 else if (namlen == HEf_SVKEY)
4484 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4489 mg->mg_virtual = &PL_vtbl_sv;
4491 case PERL_MAGIC_overload:
4492 mg->mg_virtual = &PL_vtbl_amagic;
4494 case PERL_MAGIC_overload_elem:
4495 mg->mg_virtual = &PL_vtbl_amagicelem;
4497 case PERL_MAGIC_overload_table:
4498 mg->mg_virtual = &PL_vtbl_ovrld;
4501 mg->mg_virtual = &PL_vtbl_bm;
4503 case PERL_MAGIC_regdata:
4504 mg->mg_virtual = &PL_vtbl_regdata;
4506 case PERL_MAGIC_regdatum:
4507 mg->mg_virtual = &PL_vtbl_regdatum;
4509 case PERL_MAGIC_env:
4510 mg->mg_virtual = &PL_vtbl_env;
4513 mg->mg_virtual = &PL_vtbl_fm;
4515 case PERL_MAGIC_envelem:
4516 mg->mg_virtual = &PL_vtbl_envelem;
4518 case PERL_MAGIC_regex_global:
4519 mg->mg_virtual = &PL_vtbl_mglob;
4521 case PERL_MAGIC_isa:
4522 mg->mg_virtual = &PL_vtbl_isa;
4524 case PERL_MAGIC_isaelem:
4525 mg->mg_virtual = &PL_vtbl_isaelem;
4527 case PERL_MAGIC_nkeys:
4528 mg->mg_virtual = &PL_vtbl_nkeys;
4530 case PERL_MAGIC_dbfile:
4534 case PERL_MAGIC_dbline:
4535 mg->mg_virtual = &PL_vtbl_dbline;
4537 #ifdef USE_5005THREADS
4538 case PERL_MAGIC_mutex:
4539 mg->mg_virtual = &PL_vtbl_mutex;
4541 #endif /* USE_5005THREADS */
4542 #ifdef USE_LOCALE_COLLATE
4543 case PERL_MAGIC_collxfrm:
4544 mg->mg_virtual = &PL_vtbl_collxfrm;
4546 #endif /* USE_LOCALE_COLLATE */
4547 case PERL_MAGIC_tied:
4548 mg->mg_virtual = &PL_vtbl_pack;
4550 case PERL_MAGIC_tiedelem:
4551 case PERL_MAGIC_tiedscalar:
4552 mg->mg_virtual = &PL_vtbl_packelem;
4555 mg->mg_virtual = &PL_vtbl_regexp;
4557 case PERL_MAGIC_sig:
4558 mg->mg_virtual = &PL_vtbl_sig;
4560 case PERL_MAGIC_sigelem:
4561 mg->mg_virtual = &PL_vtbl_sigelem;
4563 case PERL_MAGIC_taint:
4564 mg->mg_virtual = &PL_vtbl_taint;
4567 case PERL_MAGIC_uvar:
4568 mg->mg_virtual = &PL_vtbl_uvar;
4570 case PERL_MAGIC_vec:
4571 mg->mg_virtual = &PL_vtbl_vec;
4573 case PERL_MAGIC_substr:
4574 mg->mg_virtual = &PL_vtbl_substr;
4576 case PERL_MAGIC_defelem:
4577 mg->mg_virtual = &PL_vtbl_defelem;
4579 case PERL_MAGIC_glob:
4580 mg->mg_virtual = &PL_vtbl_glob;
4582 case PERL_MAGIC_arylen:
4583 mg->mg_virtual = &PL_vtbl_arylen;
4585 case PERL_MAGIC_pos:
4586 mg->mg_virtual = &PL_vtbl_pos;
4588 case PERL_MAGIC_backref:
4589 mg->mg_virtual = &PL_vtbl_backref;
4591 case PERL_MAGIC_ext:
4592 /* Reserved for use by extensions not perl internals. */
4593 /* Useful for attaching extension internal data to perl vars. */
4594 /* Note that multiple extensions may clash if magical scalars */
4595 /* etc holding private data from one are passed to another. */
4599 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4603 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4607 =for apidoc sv_unmagic
4609 Removes all magic of type C<type> from an SV.
4615 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4619 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4622 for (mg = *mgp; mg; mg = *mgp) {
4623 if (mg->mg_type == type) {
4624 MGVTBL* vtbl = mg->mg_virtual;
4625 *mgp = mg->mg_moremagic;
4626 if (vtbl && vtbl->svt_free)
4627 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4628 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4629 if (mg->mg_len >= 0)
4630 Safefree(mg->mg_ptr);
4631 else if (mg->mg_len == HEf_SVKEY)
4632 SvREFCNT_dec((SV*)mg->mg_ptr);
4634 if (mg->mg_flags & MGf_REFCOUNTED)
4635 SvREFCNT_dec(mg->mg_obj);
4639 mgp = &mg->mg_moremagic;
4643 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4650 =for apidoc sv_rvweaken
4652 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4653 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4654 push a back-reference to this RV onto the array of backreferences
4655 associated with that magic.
4661 Perl_sv_rvweaken(pTHX_ SV *sv)
4664 if (!SvOK(sv)) /* let undefs pass */
4667 Perl_croak(aTHX_ "Can't weaken a nonreference");
4668 else if (SvWEAKREF(sv)) {
4669 if (ckWARN(WARN_MISC))
4670 Perl_warner(aTHX_ WARN_MISC, "Reference is already weak");
4674 sv_add_backref(tsv, sv);
4680 /* Give tsv backref magic if it hasn't already got it, then push a
4681 * back-reference to sv onto the array associated with the backref magic.
4685 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4689 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4690 av = (AV*)mg->mg_obj;
4693 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4694 SvREFCNT_dec(av); /* for sv_magic */
4699 /* delete a back-reference to ourselves from the backref magic associated
4700 * with the SV we point to.
4704 S_sv_del_backref(pTHX_ SV *sv)
4711 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4712 Perl_croak(aTHX_ "panic: del_backref");
4713 av = (AV *)mg->mg_obj;
4718 svp[i] = &PL_sv_undef; /* XXX */
4725 =for apidoc sv_insert
4727 Inserts a string at the specified offset/length within the SV. Similar to
4728 the Perl substr() function.
4734 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
4738 register char *midend;
4739 register char *bigend;
4745 Perl_croak(aTHX_ "Can't modify non-existent substring");
4746 SvPV_force(bigstr, curlen);
4747 (void)SvPOK_only_UTF8(bigstr);
4748 if (offset + len > curlen) {
4749 SvGROW(bigstr, offset+len+1);
4750 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4751 SvCUR_set(bigstr, offset+len);
4755 i = littlelen - len;
4756 if (i > 0) { /* string might grow */
4757 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4758 mid = big + offset + len;
4759 midend = bigend = big + SvCUR(bigstr);
4762 while (midend > mid) /* shove everything down */
4763 *--bigend = *--midend;
4764 Move(little,big+offset,littlelen,char);
4770 Move(little,SvPVX(bigstr)+offset,len,char);
4775 big = SvPVX(bigstr);
4778 bigend = big + SvCUR(bigstr);
4780 if (midend > bigend)
4781 Perl_croak(aTHX_ "panic: sv_insert");
4783 if (mid - big > bigend - midend) { /* faster to shorten from end */
4785 Move(little, mid, littlelen,char);
4788 i = bigend - midend;
4790 Move(midend, mid, i,char);
4794 SvCUR_set(bigstr, mid - big);
4797 else if ((i = mid - big)) { /* faster from front */
4798 midend -= littlelen;
4800 sv_chop(bigstr,midend-i);
4805 Move(little, mid, littlelen,char);
4807 else if (littlelen) {
4808 midend -= littlelen;
4809 sv_chop(bigstr,midend);
4810 Move(little,midend,littlelen,char);
4813 sv_chop(bigstr,midend);
4819 =for apidoc sv_replace
4821 Make the first argument a copy of the second, then delete the original.
4822 The target SV physically takes over ownership of the body of the source SV
4823 and inherits its flags; however, the target keeps any magic it owns,
4824 and any magic in the source is discarded.
4825 Note that this is a rather specialist SV copying operation; most of the
4826 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4832 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4834 U32 refcnt = SvREFCNT(sv);
4835 SV_CHECK_THINKFIRST(sv);
4836 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
4837 Perl_warner(aTHX_ WARN_INTERNAL, "Reference miscount in sv_replace()");
4838 if (SvMAGICAL(sv)) {
4842 sv_upgrade(nsv, SVt_PVMG);
4843 SvMAGIC(nsv) = SvMAGIC(sv);
4844 SvFLAGS(nsv) |= SvMAGICAL(sv);
4850 assert(!SvREFCNT(sv));
4851 StructCopy(nsv,sv,SV);
4852 SvREFCNT(sv) = refcnt;
4853 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4858 =for apidoc sv_clear
4860 Clear an SV: call any destructors, free up any memory used by the body,
4861 and free the body itself. The SV's head is I<not> freed, although
4862 its type is set to all 1's so that it won't inadvertently be assumed
4863 to be live during global destruction etc.
4864 This function should only be called when REFCNT is zero. Most of the time
4865 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4872 Perl_sv_clear(pTHX_ register SV *sv)
4876 assert(SvREFCNT(sv) == 0);
4879 if (PL_defstash) { /* Still have a symbol table? */
4884 Zero(&tmpref, 1, SV);
4885 sv_upgrade(&tmpref, SVt_RV);
4887 SvREADONLY_on(&tmpref); /* DESTROY() could be naughty */
4888 SvREFCNT(&tmpref) = 1;
4891 stash = SvSTASH(sv);
4892 destructor = StashHANDLER(stash,DESTROY);
4895 PUSHSTACKi(PERLSI_DESTROY);
4896 SvRV(&tmpref) = SvREFCNT_inc(sv);
4901 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR);
4907 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4909 del_XRV(SvANY(&tmpref));
4912 if (PL_in_clean_objs)
4913 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4915 /* DESTROY gave object new lease on life */
4921 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4922 SvOBJECT_off(sv); /* Curse the object. */
4923 if (SvTYPE(sv) != SVt_PVIO)
4924 --PL_sv_objcount; /* XXX Might want something more general */
4927 if (SvTYPE(sv) >= SVt_PVMG) {
4930 if (SvFLAGS(sv) & SVpad_TYPED)
4931 SvREFCNT_dec(SvSTASH(sv));
4934 switch (SvTYPE(sv)) {
4937 IoIFP(sv) != PerlIO_stdin() &&
4938 IoIFP(sv) != PerlIO_stdout() &&
4939 IoIFP(sv) != PerlIO_stderr())
4941 io_close((IO*)sv, FALSE);
4943 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4944 PerlDir_close(IoDIRP(sv));
4945 IoDIRP(sv) = (DIR*)NULL;
4946 Safefree(IoTOP_NAME(sv));
4947 Safefree(IoFMT_NAME(sv));
4948 Safefree(IoBOTTOM_NAME(sv));
4963 SvREFCNT_dec(LvTARG(sv));
4967 Safefree(GvNAME(sv));
4968 /* cannot decrease stash refcount yet, as we might recursively delete
4969 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
4970 of stash until current sv is completely gone.
4971 -- JohnPC, 27 Mar 1998 */
4972 stash = GvSTASH(sv);
4978 (void)SvOOK_off(sv);
4986 SvREFCNT_dec(SvRV(sv));
4988 else if (SvPVX(sv) && SvLEN(sv))
4989 Safefree(SvPVX(sv));
4990 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4991 unsharepvn(SvPVX(sv),
4992 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5005 switch (SvTYPE(sv)) {
5021 del_XPVIV(SvANY(sv));
5024 del_XPVNV(SvANY(sv));
5027 del_XPVMG(SvANY(sv));
5030 del_XPVLV(SvANY(sv));
5033 del_XPVAV(SvANY(sv));
5036 del_XPVHV(SvANY(sv));
5039 del_XPVCV(SvANY(sv));
5042 del_XPVGV(SvANY(sv));
5043 /* code duplication for increased performance. */
5044 SvFLAGS(sv) &= SVf_BREAK;
5045 SvFLAGS(sv) |= SVTYPEMASK;
5046 /* decrease refcount of the stash that owns this GV, if any */
5048 SvREFCNT_dec(stash);
5049 return; /* not break, SvFLAGS reset already happened */
5051 del_XPVBM(SvANY(sv));
5054 del_XPVFM(SvANY(sv));
5057 del_XPVIO(SvANY(sv));
5060 SvFLAGS(sv) &= SVf_BREAK;
5061 SvFLAGS(sv) |= SVTYPEMASK;
5065 =for apidoc sv_newref
5067 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5074 Perl_sv_newref(pTHX_ SV *sv)
5077 ATOMIC_INC(SvREFCNT(sv));
5084 Decrement an SV's reference count, and if it drops to zero, call
5085 C<sv_clear> to invoke destructors and free up any memory used by
5086 the body; finally, deallocate the SV's head itself.
5087 Normally called via a wrapper macro C<SvREFCNT_dec>.
5093 Perl_sv_free(pTHX_ SV *sv)
5095 int refcount_is_zero;
5099 if (SvREFCNT(sv) == 0) {
5100 if (SvFLAGS(sv) & SVf_BREAK)
5101 /* this SV's refcnt has been artificially decremented to
5102 * trigger cleanup */
5104 if (PL_in_clean_all) /* All is fair */
5106 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5107 /* make sure SvREFCNT(sv)==0 happens very seldom */
5108 SvREFCNT(sv) = (~(U32)0)/2;
5111 if (ckWARN_d(WARN_INTERNAL))
5112 Perl_warner(aTHX_ WARN_INTERNAL, "Attempt to free unreferenced scalar");
5115 ATOMIC_DEC_AND_TEST(refcount_is_zero, SvREFCNT(sv));
5116 if (!refcount_is_zero)
5120 if (ckWARN_d(WARN_DEBUGGING))
5121 Perl_warner(aTHX_ WARN_DEBUGGING,
5122 "Attempt to free temp prematurely: SV 0x%"UVxf,
5127 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5128 /* make sure SvREFCNT(sv)==0 happens very seldom */
5129 SvREFCNT(sv) = (~(U32)0)/2;
5140 Returns the length of the string in the SV. Handles magic and type
5141 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5147 Perl_sv_len(pTHX_ register SV *sv)
5155 len = mg_length(sv);
5157 (void)SvPV(sv, len);
5162 =for apidoc sv_len_utf8
5164 Returns the number of characters in the string in an SV, counting wide
5165 UTF8 bytes as a single character. Handles magic and type coercion.
5171 Perl_sv_len_utf8(pTHX_ register SV *sv)
5177 return mg_length(sv);
5181 U8 *s = (U8*)SvPV(sv, len);
5183 return Perl_utf8_length(aTHX_ s, s + len);
5188 =for apidoc sv_pos_u2b
5190 Converts the value pointed to by offsetp from a count of UTF8 chars from
5191 the start of the string, to a count of the equivalent number of bytes; if
5192 lenp is non-zero, it does the same to lenp, but this time starting from
5193 the offset, rather than from the start of the string. Handles magic and
5200 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5205 I32 uoffset = *offsetp;
5211 start = s = (U8*)SvPV(sv, len);
5213 while (s < send && uoffset--)
5217 *offsetp = s - start;
5221 while (s < send && ulen--)
5231 =for apidoc sv_pos_b2u
5233 Converts the value pointed to by offsetp from a count of bytes from the
5234 start of the string, to a count of the equivalent number of UTF8 chars.
5235 Handles magic and type coercion.
5241 Perl_sv_pos_b2u(pTHX_ register SV *sv, I32* offsetp)
5250 s = (U8*)SvPV(sv, len);
5252 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5253 send = s + *offsetp;
5257 /* Call utf8n_to_uvchr() to validate the sequence */
5258 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5273 Returns a boolean indicating whether the strings in the two SVs are
5274 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5275 coerce its args to strings if necessary.
5281 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5295 pv1 = SvPV(sv1, cur1);
5302 pv2 = SvPV(sv2, cur2);
5304 /* do not utf8ize the comparands as a side-effect */
5305 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5306 bool is_utf8 = TRUE;
5307 /* UTF-8ness differs */
5310 /* sv1 is the UTF-8 one , If is equal it must be downgrade-able */
5311 char *pv = (char*)bytes_from_utf8((U8*)pv1, &cur1, &is_utf8);
5316 /* sv2 is the UTF-8 one , If is equal it must be downgrade-able */
5317 char *pv = (char *)bytes_from_utf8((U8*)pv2, &cur2, &is_utf8);
5322 /* Downgrade not possible - cannot be eq */
5328 eq = memEQ(pv1, pv2, cur1);
5339 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5340 string in C<sv1> is less than, equal to, or greater than the string in
5341 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5342 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5348 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5353 bool pv1tmp = FALSE;
5354 bool pv2tmp = FALSE;
5361 pv1 = SvPV(sv1, cur1);
5368 pv2 = SvPV(sv2, cur2);
5370 /* do not utf8ize the comparands as a side-effect */
5371 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5373 pv2 = (char*)bytes_to_utf8((U8*)pv2, &cur2);
5377 pv1 = (char*)bytes_to_utf8((U8*)pv1, &cur1);
5383 cmp = cur2 ? -1 : 0;
5387 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
5390 cmp = retval < 0 ? -1 : 1;
5391 } else if (cur1 == cur2) {
5394 cmp = cur1 < cur2 ? -1 : 1;
5407 =for apidoc sv_cmp_locale
5409 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5410 'use bytes' aware, handles get magic, and will coerce its args to strings
5411 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5417 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5419 #ifdef USE_LOCALE_COLLATE
5425 if (PL_collation_standard)
5429 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5431 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5433 if (!pv1 || !len1) {
5444 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5447 return retval < 0 ? -1 : 1;
5450 * When the result of collation is equality, that doesn't mean
5451 * that there are no differences -- some locales exclude some
5452 * characters from consideration. So to avoid false equalities,
5453 * we use the raw string as a tiebreaker.
5459 #endif /* USE_LOCALE_COLLATE */
5461 return sv_cmp(sv1, sv2);
5465 #ifdef USE_LOCALE_COLLATE
5468 =for apidoc sv_collxfrm
5470 Add Collate Transform magic to an SV if it doesn't already have it.
5472 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5473 scalar data of the variable, but transformed to such a format that a normal
5474 memory comparison can be used to compare the data according to the locale
5481 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5485 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5486 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5491 Safefree(mg->mg_ptr);
5493 if ((xf = mem_collxfrm(s, len, &xlen))) {
5494 if (SvREADONLY(sv)) {
5497 return xf + sizeof(PL_collation_ix);
5500 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5501 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5514 if (mg && mg->mg_ptr) {
5516 return mg->mg_ptr + sizeof(PL_collation_ix);
5524 #endif /* USE_LOCALE_COLLATE */
5529 Get a line from the filehandle and store it into the SV, optionally
5530 appending to the currently-stored string.
5536 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5540 register STDCHAR rslast;
5541 register STDCHAR *bp;
5546 SV_CHECK_THINKFIRST(sv);
5547 (void)SvUPGRADE(sv, SVt_PV);
5551 if (PL_curcop == &PL_compiling) {
5552 /* we always read code in line mode */
5556 else if (RsSNARF(PL_rs)) {
5560 else if (RsRECORD(PL_rs)) {
5561 I32 recsize, bytesread;
5564 /* Grab the size of the record we're getting */
5565 recsize = SvIV(SvRV(PL_rs));
5566 (void)SvPOK_only(sv); /* Validate pointer */
5567 buffer = SvGROW(sv, recsize + 1);
5570 /* VMS wants read instead of fread, because fread doesn't respect */
5571 /* RMS record boundaries. This is not necessarily a good thing to be */
5572 /* doing, but we've got no other real choice */
5573 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5575 bytesread = PerlIO_read(fp, buffer, recsize);
5577 SvCUR_set(sv, bytesread);
5578 buffer[bytesread] = '\0';
5579 if (PerlIO_isutf8(fp))
5583 return(SvCUR(sv) ? SvPVX(sv) : Nullch);
5585 else if (RsPARA(PL_rs)) {
5591 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5592 if (PerlIO_isutf8(fp)) {
5593 rsptr = SvPVutf8(PL_rs, rslen);
5596 if (SvUTF8(PL_rs)) {
5597 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5598 Perl_croak(aTHX_ "Wide character in $/");
5601 rsptr = SvPV(PL_rs, rslen);
5605 rslast = rslen ? rsptr[rslen - 1] : '\0';
5607 if (rspara) { /* have to do this both before and after */
5608 do { /* to make sure file boundaries work right */
5611 i = PerlIO_getc(fp);
5615 PerlIO_ungetc(fp,i);
5621 /* See if we know enough about I/O mechanism to cheat it ! */
5623 /* This used to be #ifdef test - it is made run-time test for ease
5624 of abstracting out stdio interface. One call should be cheap
5625 enough here - and may even be a macro allowing compile
5629 if (PerlIO_fast_gets(fp)) {
5632 * We're going to steal some values from the stdio struct
5633 * and put EVERYTHING in the innermost loop into registers.
5635 register STDCHAR *ptr;
5639 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5640 /* An ungetc()d char is handled separately from the regular
5641 * buffer, so we getc() it back out and stuff it in the buffer.
5643 i = PerlIO_getc(fp);
5644 if (i == EOF) return 0;
5645 *(--((*fp)->_ptr)) = (unsigned char) i;
5649 /* Here is some breathtakingly efficient cheating */
5651 cnt = PerlIO_get_cnt(fp); /* get count into register */
5652 (void)SvPOK_only(sv); /* validate pointer */
5653 if (SvLEN(sv) - append <= cnt + 1) { /* make sure we have the room */
5654 if (cnt > 80 && SvLEN(sv) > append) {
5655 shortbuffered = cnt - SvLEN(sv) + append + 1;
5656 cnt -= shortbuffered;
5660 /* remember that cnt can be negative */
5661 SvGROW(sv, append + (cnt <= 0 ? 2 : (cnt + 1)));
5666 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
5667 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5668 DEBUG_P(PerlIO_printf(Perl_debug_log,
5669 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5670 DEBUG_P(PerlIO_printf(Perl_debug_log,
5671 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5672 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5673 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5678 while (cnt > 0) { /* this | eat */
5680 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5681 goto thats_all_folks; /* screams | sed :-) */
5685 Copy(ptr, bp, cnt, char); /* this | eat */
5686 bp += cnt; /* screams | dust */
5687 ptr += cnt; /* louder | sed :-) */
5692 if (shortbuffered) { /* oh well, must extend */
5693 cnt = shortbuffered;
5695 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
5697 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5698 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
5702 DEBUG_P(PerlIO_printf(Perl_debug_log,
5703 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5704 PTR2UV(ptr),(long)cnt));
5705 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5707 DEBUG_P(PerlIO_printf(Perl_debug_log,
5708 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5709 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5710 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5712 /* This used to call 'filbuf' in stdio form, but as that behaves like
5713 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5714 another abstraction. */
5715 i = PerlIO_getc(fp); /* get more characters */
5717 DEBUG_P(PerlIO_printf(Perl_debug_log,
5718 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5719 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5720 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5722 cnt = PerlIO_get_cnt(fp);
5723 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5724 DEBUG_P(PerlIO_printf(Perl_debug_log,
5725 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5727 if (i == EOF) /* all done for ever? */
5728 goto thats_really_all_folks;
5730 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
5732 SvGROW(sv, bpx + cnt + 2);
5733 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
5735 *bp++ = i; /* store character from PerlIO_getc */
5737 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5738 goto thats_all_folks;
5742 if ((rslen > 1 && (bp - (STDCHAR*)SvPVX(sv) < rslen)) ||
5743 memNE((char*)bp - rslen, rsptr, rslen))
5744 goto screamer; /* go back to the fray */
5745 thats_really_all_folks:
5747 cnt += shortbuffered;
5748 DEBUG_P(PerlIO_printf(Perl_debug_log,
5749 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5750 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5751 DEBUG_P(PerlIO_printf(Perl_debug_log,
5752 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5753 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5754 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5756 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
5757 DEBUG_P(PerlIO_printf(Perl_debug_log,
5758 "Screamer: done, len=%ld, string=|%.*s|\n",
5759 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
5764 /*The big, slow, and stupid way */
5767 /* Need to work around EPOC SDK features */
5768 /* On WINS: MS VC5 generates calls to _chkstk, */
5769 /* if a `large' stack frame is allocated */
5770 /* gcc on MARM does not generate calls like these */
5776 register STDCHAR *bpe = buf + sizeof(buf);
5778 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = i) != rslast && bp < bpe)
5779 ; /* keep reading */
5783 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5784 /* Accomodate broken VAXC compiler, which applies U8 cast to
5785 * both args of ?: operator, causing EOF to change into 255
5787 if (cnt) { i = (U8)buf[cnt - 1]; } else { i = EOF; }
5791 sv_catpvn(sv, (char *) buf, cnt);
5793 sv_setpvn(sv, (char *) buf, cnt);
5795 if (i != EOF && /* joy */
5797 SvCUR(sv) < rslen ||
5798 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5802 * If we're reading from a TTY and we get a short read,
5803 * indicating that the user hit his EOF character, we need
5804 * to notice it now, because if we try to read from the TTY
5805 * again, the EOF condition will disappear.
5807 * The comparison of cnt to sizeof(buf) is an optimization
5808 * that prevents unnecessary calls to feof().
5812 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5817 if (rspara) { /* have to do this both before and after */
5818 while (i != EOF) { /* to make sure file boundaries work right */
5819 i = PerlIO_getc(fp);
5821 PerlIO_ungetc(fp,i);
5827 if (PerlIO_isutf8(fp))
5832 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5838 Auto-increment of the value in the SV, doing string to numeric conversion
5839 if necessary. Handles 'get' magic.
5845 Perl_sv_inc(pTHX_ register SV *sv)
5854 if (SvTHINKFIRST(sv)) {
5855 if (SvREADONLY(sv) && SvFAKE(sv))
5856 sv_force_normal(sv);
5857 if (SvREADONLY(sv)) {
5858 if (PL_curcop != &PL_compiling)
5859 Perl_croak(aTHX_ PL_no_modify);
5863 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5865 i = PTR2IV(SvRV(sv));
5870 flags = SvFLAGS(sv);
5871 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5872 /* It's (privately or publicly) a float, but not tested as an
5873 integer, so test it to see. */
5875 flags = SvFLAGS(sv);
5877 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5878 /* It's publicly an integer, or privately an integer-not-float */
5879 #ifdef PERL_PRESERVE_IVUV
5883 if (SvUVX(sv) == UV_MAX)
5884 sv_setnv(sv, UV_MAX_P1);
5886 (void)SvIOK_only_UV(sv);
5889 if (SvIVX(sv) == IV_MAX)
5890 sv_setuv(sv, (UV)IV_MAX + 1);
5892 (void)SvIOK_only(sv);
5898 if (flags & SVp_NOK) {
5899 (void)SvNOK_only(sv);
5904 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
5905 if ((flags & SVTYPEMASK) < SVt_PVIV)
5906 sv_upgrade(sv, SVt_IV);
5907 (void)SvIOK_only(sv);
5912 while (isALPHA(*d)) d++;
5913 while (isDIGIT(*d)) d++;
5915 #ifdef PERL_PRESERVE_IVUV
5916 /* Got to punt this as an integer if needs be, but we don't issue
5917 warnings. Probably ought to make the sv_iv_please() that does
5918 the conversion if possible, and silently. */
5919 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
5920 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
5921 /* Need to try really hard to see if it's an integer.
5922 9.22337203685478e+18 is an integer.
5923 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
5924 so $a="9.22337203685478e+18"; $a+0; $a++
5925 needs to be the same as $a="9.22337203685478e+18"; $a++
5932 /* sv_2iv *should* have made this an NV */
5933 if (flags & SVp_NOK) {
5934 (void)SvNOK_only(sv);
5938 /* I don't think we can get here. Maybe I should assert this
5939 And if we do get here I suspect that sv_setnv will croak. NWC
5941 #if defined(USE_LONG_DOUBLE)
5942 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",
5943 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
5945 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
5946 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
5949 #endif /* PERL_PRESERVE_IVUV */
5950 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
5954 while (d >= SvPVX(sv)) {
5962 /* MKS: The original code here died if letters weren't consecutive.
5963 * at least it didn't have to worry about non-C locales. The
5964 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
5965 * arranged in order (although not consecutively) and that only
5966 * [A-Za-z] are accepted by isALPHA in the C locale.
5968 if (*d != 'z' && *d != 'Z') {
5969 do { ++*d; } while (!isALPHA(*d));
5972 *(d--) -= 'z' - 'a';
5977 *(d--) -= 'z' - 'a' + 1;
5981 /* oh,oh, the number grew */
5982 SvGROW(sv, SvCUR(sv) + 2);
5984 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
5995 Auto-decrement of the value in the SV, doing string to numeric conversion
5996 if necessary. Handles 'get' magic.
6002 Perl_sv_dec(pTHX_ register SV *sv)
6010 if (SvTHINKFIRST(sv)) {
6011 if (SvREADONLY(sv) && SvFAKE(sv))
6012 sv_force_normal(sv);
6013 if (SvREADONLY(sv)) {
6014 if (PL_curcop != &PL_compiling)
6015 Perl_croak(aTHX_ PL_no_modify);
6019 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6021 i = PTR2IV(SvRV(sv));
6026 /* Unlike sv_inc we don't have to worry about string-never-numbers
6027 and keeping them magic. But we mustn't warn on punting */
6028 flags = SvFLAGS(sv);
6029 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6030 /* It's publicly an integer, or privately an integer-not-float */
6031 #ifdef PERL_PRESERVE_IVUV
6035 if (SvUVX(sv) == 0) {
6036 (void)SvIOK_only(sv);
6040 (void)SvIOK_only_UV(sv);
6044 if (SvIVX(sv) == IV_MIN)
6045 sv_setnv(sv, (NV)IV_MIN - 1.0);
6047 (void)SvIOK_only(sv);
6053 if (flags & SVp_NOK) {
6055 (void)SvNOK_only(sv);
6058 if (!(flags & SVp_POK)) {
6059 if ((flags & SVTYPEMASK) < SVt_PVNV)
6060 sv_upgrade(sv, SVt_NV);
6062 (void)SvNOK_only(sv);
6065 #ifdef PERL_PRESERVE_IVUV
6067 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6068 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6069 /* Need to try really hard to see if it's an integer.
6070 9.22337203685478e+18 is an integer.
6071 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6072 so $a="9.22337203685478e+18"; $a+0; $a--
6073 needs to be the same as $a="9.22337203685478e+18"; $a--
6080 /* sv_2iv *should* have made this an NV */
6081 if (flags & SVp_NOK) {
6082 (void)SvNOK_only(sv);
6086 /* I don't think we can get here. Maybe I should assert this
6087 And if we do get here I suspect that sv_setnv will croak. NWC
6089 #if defined(USE_LONG_DOUBLE)
6090 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",
6091 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6093 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6094 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6098 #endif /* PERL_PRESERVE_IVUV */
6099 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6103 =for apidoc sv_mortalcopy
6105 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6106 The new SV is marked as mortal. It will be destroyed "soon", either by an
6107 explicit call to FREETMPS, or by an implicit call at places such as
6108 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6113 /* Make a string that will exist for the duration of the expression
6114 * evaluation. Actually, it may have to last longer than that, but
6115 * hopefully we won't free it until it has been assigned to a
6116 * permanent location. */
6119 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6124 sv_setsv(sv,oldstr);
6126 PL_tmps_stack[++PL_tmps_ix] = sv;
6132 =for apidoc sv_newmortal
6134 Creates a new null SV which is mortal. The reference count of the SV is
6135 set to 1. It will be destroyed "soon", either by an explicit call to
6136 FREETMPS, or by an implicit call at places such as statement boundaries.
6137 See also C<sv_mortalcopy> and C<sv_2mortal>.
6143 Perl_sv_newmortal(pTHX)
6148 SvFLAGS(sv) = SVs_TEMP;
6150 PL_tmps_stack[++PL_tmps_ix] = sv;
6155 =for apidoc sv_2mortal
6157 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6158 by an explicit call to FREETMPS, or by an implicit call at places such as
6159 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
6165 Perl_sv_2mortal(pTHX_ register SV *sv)
6169 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6172 PL_tmps_stack[++PL_tmps_ix] = sv;
6180 Creates a new SV and copies a string into it. The reference count for the
6181 SV is set to 1. If C<len> is zero, Perl will compute the length using
6182 strlen(). For efficiency, consider using C<newSVpvn> instead.
6188 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6195 sv_setpvn(sv,s,len);
6200 =for apidoc newSVpvn
6202 Creates a new SV and copies a string into it. The reference count for the
6203 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6204 string. You are responsible for ensuring that the source string is at least
6211 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6216 sv_setpvn(sv,s,len);
6221 =for apidoc newSVpvn_share
6223 Creates a new SV with its SvPVX pointing to a shared string in the string
6224 table. If the string does not already exist in the table, it is created
6225 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6226 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6227 otherwise the hash is computed. The idea here is that as the string table
6228 is used for shared hash keys these strings will have SvPVX == HeKEY and
6229 hash lookup will avoid string compare.
6235 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6238 bool is_utf8 = FALSE;
6240 STRLEN tmplen = -len;
6242 /* See the note in hv.c:hv_fetch() --jhi */
6243 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
6247 PERL_HASH(hash, src, len);
6249 sv_upgrade(sv, SVt_PVIV);
6250 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
6263 #if defined(PERL_IMPLICIT_CONTEXT)
6265 /* pTHX_ magic can't cope with varargs, so this is a no-context
6266 * version of the main function, (which may itself be aliased to us).
6267 * Don't access this version directly.
6271 Perl_newSVpvf_nocontext(const char* pat, ...)
6276 va_start(args, pat);
6277 sv = vnewSVpvf(pat, &args);
6284 =for apidoc newSVpvf
6286 Creates a new SV and initializes it with the string formatted like
6293 Perl_newSVpvf(pTHX_ const char* pat, ...)
6297 va_start(args, pat);
6298 sv = vnewSVpvf(pat, &args);
6303 /* backend for newSVpvf() and newSVpvf_nocontext() */
6306 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6310 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6317 Creates a new SV and copies a floating point value into it.
6318 The reference count for the SV is set to 1.
6324 Perl_newSVnv(pTHX_ NV n)
6336 Creates a new SV and copies an integer into it. The reference count for the
6343 Perl_newSViv(pTHX_ IV i)
6355 Creates a new SV and copies an unsigned integer into it.
6356 The reference count for the SV is set to 1.
6362 Perl_newSVuv(pTHX_ UV u)
6372 =for apidoc newRV_noinc
6374 Creates an RV wrapper for an SV. The reference count for the original
6375 SV is B<not> incremented.
6381 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6386 sv_upgrade(sv, SVt_RV);
6393 /* newRV_inc is the official function name to use now.
6394 * newRV_inc is in fact #defined to newRV in sv.h
6398 Perl_newRV(pTHX_ SV *tmpRef)
6400 return newRV_noinc(SvREFCNT_inc(tmpRef));
6406 Creates a new SV which is an exact duplicate of the original SV.
6413 Perl_newSVsv(pTHX_ register SV *old)
6419 if (SvTYPE(old) == SVTYPEMASK) {
6420 if (ckWARN_d(WARN_INTERNAL))
6421 Perl_warner(aTHX_ WARN_INTERNAL, "semi-panic: attempt to dup freed string");
6436 =for apidoc sv_reset
6438 Underlying implementation for the C<reset> Perl function.
6439 Note that the perl-level function is vaguely deprecated.
6445 Perl_sv_reset(pTHX_ register char *s, HV *stash)
6453 char todo[PERL_UCHAR_MAX+1];
6458 if (!*s) { /* reset ?? searches */
6459 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
6460 pm->op_pmdynflags &= ~PMdf_USED;
6465 /* reset variables */
6467 if (!HvARRAY(stash))
6470 Zero(todo, 256, char);
6472 i = (unsigned char)*s;
6476 max = (unsigned char)*s++;
6477 for ( ; i <= max; i++) {
6480 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6481 for (entry = HvARRAY(stash)[i];
6483 entry = HeNEXT(entry))
6485 if (!todo[(U8)*HeKEY(entry)])
6487 gv = (GV*)HeVAL(entry);
6489 if (SvTHINKFIRST(sv)) {
6490 if (!SvREADONLY(sv) && SvROK(sv))
6495 if (SvTYPE(sv) >= SVt_PV) {
6497 if (SvPVX(sv) != Nullch)
6504 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
6506 #ifdef USE_ENVIRON_ARRAY
6508 environ[0] = Nullch;
6519 Using various gambits, try to get an IO from an SV: the IO slot if its a
6520 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6521 named after the PV if we're a string.
6527 Perl_sv_2io(pTHX_ SV *sv)
6533 switch (SvTYPE(sv)) {
6541 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6545 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6547 return sv_2io(SvRV(sv));
6548 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
6554 Perl_croak(aTHX_ "Bad filehandle: %s", SvPV(sv,n_a));
6563 Using various gambits, try to get a CV from an SV; in addition, try if
6564 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6570 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6577 return *gvp = Nullgv, Nullcv;
6578 switch (SvTYPE(sv)) {
6597 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6598 tryAMAGICunDEREF(to_cv);
6601 if (SvTYPE(sv) == SVt_PVCV) {
6610 Perl_croak(aTHX_ "Not a subroutine reference");
6615 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
6621 if (lref && !GvCVu(gv)) {
6624 tmpsv = NEWSV(704,0);
6625 gv_efullname3(tmpsv, gv, Nullch);
6626 /* XXX this is probably not what they think they're getting.
6627 * It has the same effect as "sub name;", i.e. just a forward
6629 newSUB(start_subparse(FALSE, 0),
6630 newSVOP(OP_CONST, 0, tmpsv),
6635 Perl_croak(aTHX_ "Unable to create sub named \"%s\"", SvPV(sv,n_a));
6644 Returns true if the SV has a true value by Perl's rules.
6645 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6646 instead use an in-line version.
6652 Perl_sv_true(pTHX_ register SV *sv)
6658 if ((tXpv = (XPV*)SvANY(sv)) &&
6659 (tXpv->xpv_cur > 1 ||
6660 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
6667 return SvIVX(sv) != 0;
6670 return SvNVX(sv) != 0.0;
6672 return sv_2bool(sv);
6680 A private implementation of the C<SvIVx> macro for compilers which can't
6681 cope with complex macro expressions. Always use the macro instead.
6687 Perl_sv_iv(pTHX_ register SV *sv)
6691 return (IV)SvUVX(sv);
6700 A private implementation of the C<SvUVx> macro for compilers which can't
6701 cope with complex macro expressions. Always use the macro instead.
6707 Perl_sv_uv(pTHX_ register SV *sv)
6712 return (UV)SvIVX(sv);
6720 A private implementation of the C<SvNVx> macro for compilers which can't
6721 cope with complex macro expressions. Always use the macro instead.
6727 Perl_sv_nv(pTHX_ register SV *sv)
6737 A private implementation of the C<SvPV_nolen> macro for compilers which can't
6738 cope with complex macro expressions. Always use the macro instead.
6744 Perl_sv_pv(pTHX_ SV *sv)
6751 return sv_2pv(sv, &n_a);
6757 A private implementation of the C<SvPV> macro for compilers which can't
6758 cope with complex macro expressions. Always use the macro instead.
6764 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
6770 return sv_2pv(sv, lp);
6773 /* For -DCRIPPLED_CC only. See also C<sv_2pv_flags()>.
6777 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
6783 return sv_2pv_flags(sv, lp, 0);
6787 =for apidoc sv_pvn_force
6789 Get a sensible string out of the SV somehow.
6790 A private implementation of the C<SvPV_force> macro for compilers which
6791 can't cope with complex macro expressions. Always use the macro instead.
6797 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
6799 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
6803 =for apidoc sv_pvn_force_flags
6805 Get a sensible string out of the SV somehow.
6806 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6807 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6808 implemented in terms of this function.
6809 You normally want to use the various wrapper macros instead: see
6810 C<SvPV_force> and C<SvPV_force_nomg>
6816 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6820 if (SvTHINKFIRST(sv) && !SvROK(sv))
6821 sv_force_normal(sv);
6827 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
6828 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6832 s = sv_2pv_flags(sv, lp, flags);
6833 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
6838 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6839 SvGROW(sv, len + 1);
6840 Move(s,SvPVX(sv),len,char);
6845 SvPOK_on(sv); /* validate pointer */
6847 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6848 PTR2UV(sv),SvPVX(sv)));
6855 =for apidoc sv_pvbyte
6857 A private implementation of the C<SvPVbyte_nolen> macro for compilers
6858 which can't cope with complex macro expressions. Always use the macro
6865 Perl_sv_pvbyte(pTHX_ SV *sv)
6867 sv_utf8_downgrade(sv,0);
6872 =for apidoc sv_pvbyten
6874 A private implementation of the C<SvPVbyte> macro for compilers
6875 which can't cope with complex macro expressions. Always use the macro
6882 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
6884 sv_utf8_downgrade(sv,0);
6885 return sv_pvn(sv,lp);
6889 =for apidoc sv_pvbyten_force
6891 A private implementation of the C<SvPVbytex_force> macro for compilers
6892 which can't cope with complex macro expressions. Always use the macro
6899 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6901 sv_utf8_downgrade(sv,0);
6902 return sv_pvn_force(sv,lp);
6906 =for apidoc sv_pvutf8
6908 A private implementation of the C<SvPVutf8_nolen> macro for compilers
6909 which can't cope with complex macro expressions. Always use the macro
6916 Perl_sv_pvutf8(pTHX_ SV *sv)
6918 sv_utf8_upgrade(sv);
6923 =for apidoc sv_pvutf8n
6925 A private implementation of the C<SvPVutf8> macro for compilers
6926 which can't cope with complex macro expressions. Always use the macro
6933 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
6935 sv_utf8_upgrade(sv);
6936 return sv_pvn(sv,lp);
6940 =for apidoc sv_pvutf8n_force
6942 A private implementation of the C<SvPVutf8_force> macro for compilers
6943 which can't cope with complex macro expressions. Always use the macro
6950 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6952 sv_utf8_upgrade(sv);
6953 return sv_pvn_force(sv,lp);
6957 =for apidoc sv_reftype
6959 Returns a string describing what the SV is a reference to.
6965 Perl_sv_reftype(pTHX_ SV *sv, int ob)
6967 if (ob && SvOBJECT(sv)) {
6968 HV *svs = SvSTASH(sv);
6969 /* [20011101.072] This bandaid for C<package;> should eventually
6970 be removed. AMS 20011103 */
6971 return (svs ? HvNAME(svs) : "<none>");
6974 switch (SvTYPE(sv)) {
6988 case SVt_PVLV: return "LVALUE";
6989 case SVt_PVAV: return "ARRAY";
6990 case SVt_PVHV: return "HASH";
6991 case SVt_PVCV: return "CODE";
6992 case SVt_PVGV: return "GLOB";
6993 case SVt_PVFM: return "FORMAT";
6994 case SVt_PVIO: return "IO";
6995 default: return "UNKNOWN";
7001 =for apidoc sv_isobject
7003 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7004 object. If the SV is not an RV, or if the object is not blessed, then this
7011 Perl_sv_isobject(pTHX_ SV *sv)
7028 Returns a boolean indicating whether the SV is blessed into the specified
7029 class. This does not check for subtypes; use C<sv_derived_from> to verify
7030 an inheritance relationship.
7036 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7048 return strEQ(HvNAME(SvSTASH(sv)), name);
7054 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7055 it will be upgraded to one. If C<classname> is non-null then the new SV will
7056 be blessed in the specified package. The new SV is returned and its
7057 reference count is 1.
7063 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7069 SV_CHECK_THINKFIRST(rv);
7072 if (SvTYPE(rv) >= SVt_PVMG) {
7073 U32 refcnt = SvREFCNT(rv);
7077 SvREFCNT(rv) = refcnt;
7080 if (SvTYPE(rv) < SVt_RV)
7081 sv_upgrade(rv, SVt_RV);
7082 else if (SvTYPE(rv) > SVt_RV) {
7083 (void)SvOOK_off(rv);
7084 if (SvPVX(rv) && SvLEN(rv))
7085 Safefree(SvPVX(rv));
7095 HV* stash = gv_stashpv(classname, TRUE);
7096 (void)sv_bless(rv, stash);
7102 =for apidoc sv_setref_pv
7104 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7105 argument will be upgraded to an RV. That RV will be modified to point to
7106 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7107 into the SV. The C<classname> argument indicates the package for the
7108 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7109 will be returned and will have a reference count of 1.
7111 Do not use with other Perl types such as HV, AV, SV, CV, because those
7112 objects will become corrupted by the pointer copy process.
7114 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7120 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7123 sv_setsv(rv, &PL_sv_undef);
7127 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7132 =for apidoc sv_setref_iv
7134 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7135 argument will be upgraded to an RV. That RV will be modified to point to
7136 the new SV. The C<classname> argument indicates the package for the
7137 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7138 will be returned and will have a reference count of 1.
7144 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7146 sv_setiv(newSVrv(rv,classname), iv);
7151 =for apidoc sv_setref_uv
7153 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7154 argument will be upgraded to an RV. That RV will be modified to point to
7155 the new SV. The C<classname> argument indicates the package for the
7156 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7157 will be returned and will have a reference count of 1.
7163 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7165 sv_setuv(newSVrv(rv,classname), uv);
7170 =for apidoc sv_setref_nv
7172 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7173 argument will be upgraded to an RV. That RV will be modified to point to
7174 the new SV. The C<classname> argument indicates the package for the
7175 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7176 will be returned and will have a reference count of 1.
7182 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7184 sv_setnv(newSVrv(rv,classname), nv);
7189 =for apidoc sv_setref_pvn
7191 Copies a string into a new SV, optionally blessing the SV. The length of the
7192 string must be specified with C<n>. The C<rv> argument will be upgraded to
7193 an RV. That RV will be modified to point to the new SV. The C<classname>
7194 argument indicates the package for the blessing. Set C<classname> to
7195 C<Nullch> to avoid the blessing. The new SV will be returned and will have
7196 a reference count of 1.
7198 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7204 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
7206 sv_setpvn(newSVrv(rv,classname), pv, n);
7211 =for apidoc sv_bless
7213 Blesses an SV into a specified package. The SV must be an RV. The package
7214 must be designated by its stash (see C<gv_stashpv()>). The reference count
7215 of the SV is unaffected.
7221 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7225 Perl_croak(aTHX_ "Can't bless non-reference value");
7227 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7228 if (SvREADONLY(tmpRef))
7229 Perl_croak(aTHX_ PL_no_modify);
7230 if (SvOBJECT(tmpRef)) {
7231 if (SvTYPE(tmpRef) != SVt_PVIO)
7233 SvREFCNT_dec(SvSTASH(tmpRef));
7236 SvOBJECT_on(tmpRef);
7237 if (SvTYPE(tmpRef) != SVt_PVIO)
7239 (void)SvUPGRADE(tmpRef, SVt_PVMG);
7240 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
7247 if(SvSMAGICAL(tmpRef))
7248 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7256 /* Downgrades a PVGV to a PVMG.
7258 * XXX This function doesn't actually appear to be used anywhere
7263 S_sv_unglob(pTHX_ SV *sv)
7267 assert(SvTYPE(sv) == SVt_PVGV);
7272 SvREFCNT_dec(GvSTASH(sv));
7273 GvSTASH(sv) = Nullhv;
7275 sv_unmagic(sv, PERL_MAGIC_glob);
7276 Safefree(GvNAME(sv));
7279 /* need to keep SvANY(sv) in the right arena */
7280 xpvmg = new_XPVMG();
7281 StructCopy(SvANY(sv), xpvmg, XPVMG);
7282 del_XPVGV(SvANY(sv));
7285 SvFLAGS(sv) &= ~SVTYPEMASK;
7286 SvFLAGS(sv) |= SVt_PVMG;
7290 =for apidoc sv_unref_flags
7292 Unsets the RV status of the SV, and decrements the reference count of
7293 whatever was being referenced by the RV. This can almost be thought of
7294 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7295 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7296 (otherwise the decrementing is conditional on the reference count being
7297 different from one or the reference being a readonly SV).
7304 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
7308 if (SvWEAKREF(sv)) {
7316 if (SvREFCNT(rv) != 1 || SvREADONLY(rv) || flags) /* SV_IMMEDIATE_UNREF */
7318 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7319 sv_2mortal(rv); /* Schedule for freeing later */
7323 =for apidoc sv_unref
7325 Unsets the RV status of the SV, and decrements the reference count of
7326 whatever was being referenced by the RV. This can almost be thought of
7327 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
7328 being zero. See C<SvROK_off>.
7334 Perl_sv_unref(pTHX_ SV *sv)
7336 sv_unref_flags(sv, 0);
7340 =for apidoc sv_taint
7342 Taint an SV. Use C<SvTAINTED_on> instead.
7347 Perl_sv_taint(pTHX_ SV *sv)
7349 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
7353 =for apidoc sv_untaint
7355 Untaint an SV. Use C<SvTAINTED_off> instead.
7360 Perl_sv_untaint(pTHX_ SV *sv)
7362 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7363 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7370 =for apidoc sv_tainted
7372 Test an SV for taintedness. Use C<SvTAINTED> instead.
7377 Perl_sv_tainted(pTHX_ SV *sv)
7379 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7380 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7381 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
7388 =for apidoc sv_setpviv
7390 Copies an integer into the given SV, also updating its string value.
7391 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7397 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7399 char buf[TYPE_CHARS(UV)];
7401 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7403 sv_setpvn(sv, ptr, ebuf - ptr);
7407 =for apidoc sv_setpviv_mg
7409 Like C<sv_setpviv>, but also handles 'set' magic.
7415 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7417 char buf[TYPE_CHARS(UV)];
7419 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7421 sv_setpvn(sv, ptr, ebuf - ptr);
7425 #if defined(PERL_IMPLICIT_CONTEXT)
7427 /* pTHX_ magic can't cope with varargs, so this is a no-context
7428 * version of the main function, (which may itself be aliased to us).
7429 * Don't access this version directly.
7433 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7437 va_start(args, pat);
7438 sv_vsetpvf(sv, pat, &args);
7442 /* pTHX_ magic can't cope with varargs, so this is a no-context
7443 * version of the main function, (which may itself be aliased to us).
7444 * Don't access this version directly.
7448 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7452 va_start(args, pat);
7453 sv_vsetpvf_mg(sv, pat, &args);
7459 =for apidoc sv_setpvf
7461 Processes its arguments like C<sprintf> and sets an SV to the formatted
7462 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7468 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7471 va_start(args, pat);
7472 sv_vsetpvf(sv, pat, &args);
7476 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
7479 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7481 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7485 =for apidoc sv_setpvf_mg
7487 Like C<sv_setpvf>, but also handles 'set' magic.
7493 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7496 va_start(args, pat);
7497 sv_vsetpvf_mg(sv, pat, &args);
7501 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
7504 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7506 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7510 #if defined(PERL_IMPLICIT_CONTEXT)
7512 /* pTHX_ magic can't cope with varargs, so this is a no-context
7513 * version of the main function, (which may itself be aliased to us).
7514 * Don't access this version directly.
7518 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7522 va_start(args, pat);
7523 sv_vcatpvf(sv, pat, &args);
7527 /* pTHX_ magic can't cope with varargs, so this is a no-context
7528 * version of the main function, (which may itself be aliased to us).
7529 * Don't access this version directly.
7533 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7537 va_start(args, pat);
7538 sv_vcatpvf_mg(sv, pat, &args);
7544 =for apidoc sv_catpvf
7546 Processes its arguments like C<sprintf> and appends the formatted
7547 output to an SV. If the appended data contains "wide" characters
7548 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7549 and characters >255 formatted with %c), the original SV might get
7550 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
7551 C<SvSETMAGIC()> must typically be called after calling this function
7552 to handle 'set' magic.
7557 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7560 va_start(args, pat);
7561 sv_vcatpvf(sv, pat, &args);
7565 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
7568 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7570 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7574 =for apidoc sv_catpvf_mg
7576 Like C<sv_catpvf>, but also handles 'set' magic.
7582 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7585 va_start(args, pat);
7586 sv_vcatpvf_mg(sv, pat, &args);
7590 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
7593 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7595 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7600 =for apidoc sv_vsetpvfn
7602 Works like C<vcatpvfn> but copies the text into the SV instead of
7605 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
7611 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7613 sv_setpvn(sv, "", 0);
7614 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7617 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7620 S_expect_number(pTHX_ char** pattern)
7623 switch (**pattern) {
7624 case '1': case '2': case '3':
7625 case '4': case '5': case '6':
7626 case '7': case '8': case '9':
7627 while (isDIGIT(**pattern))
7628 var = var * 10 + (*(*pattern)++ - '0');
7632 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7635 =for apidoc sv_vcatpvfn
7637 Processes its arguments like C<vsprintf> and appends the formatted output
7638 to an SV. Uses an array of SVs if the C style variable argument list is
7639 missing (NULL). When running with taint checks enabled, indicates via
7640 C<maybe_tainted> if results are untrustworthy (often due to the use of
7643 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
7649 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7656 static char nullstr[] = "(null)";
7659 /* no matter what, this is a string now */
7660 (void)SvPV_force(sv, origlen);
7662 /* special-case "", "%s", and "%_" */
7665 if (patlen == 2 && pat[0] == '%') {
7669 char *s = va_arg(*args, char*);
7670 sv_catpv(sv, s ? s : nullstr);
7672 else if (svix < svmax) {
7673 sv_catsv(sv, *svargs);
7674 if (DO_UTF8(*svargs))
7680 argsv = va_arg(*args, SV*);
7681 sv_catsv(sv, argsv);
7686 /* See comment on '_' below */
7691 patend = (char*)pat + patlen;
7692 for (p = (char*)pat; p < patend; p = q) {
7695 bool vectorize = FALSE;
7696 bool vectorarg = FALSE;
7697 bool vec_utf = FALSE;
7703 bool has_precis = FALSE;
7705 bool is_utf = FALSE;
7708 U8 utf8buf[UTF8_MAXLEN+1];
7709 STRLEN esignlen = 0;
7711 char *eptr = Nullch;
7713 /* Times 4: a decimal digit takes more than 3 binary digits.
7714 * NV_DIG: mantissa takes than many decimal digits.
7715 * Plus 32: Playing safe. */
7716 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7717 /* large enough for "%#.#f" --chip */
7718 /* what about long double NVs? --jhi */
7721 U8 *vecstr = Null(U8*);
7733 STRLEN dotstrlen = 1;
7734 I32 efix = 0; /* explicit format parameter index */
7735 I32 ewix = 0; /* explicit width index */
7736 I32 epix = 0; /* explicit precision index */
7737 I32 evix = 0; /* explicit vector index */
7738 bool asterisk = FALSE;
7740 /* echo everything up to the next format specification */
7741 for (q = p; q < patend && *q != '%'; ++q) ;
7743 sv_catpvn(sv, p, q - p);
7750 We allow format specification elements in this order:
7751 \d+\$ explicit format parameter index
7753 \*?(\d+\$)?v vector with optional (optionally specified) arg
7754 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7755 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7757 [%bcdefginopsux_DFOUX] format (mandatory)
7759 if (EXPECT_NUMBER(q, width)) {
7800 if (EXPECT_NUMBER(q, ewix))
7809 if ((vectorarg = asterisk)) {
7819 EXPECT_NUMBER(q, width);
7824 vecsv = va_arg(*args, SV*);
7826 vecsv = (evix ? evix <= svmax : svix < svmax) ?
7827 svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
7828 dotstr = SvPVx(vecsv, dotstrlen);
7833 vecsv = va_arg(*args, SV*);
7834 vecstr = (U8*)SvPVx(vecsv,veclen);
7835 vec_utf = DO_UTF8(vecsv);
7837 else if (efix ? efix <= svmax : svix < svmax) {
7838 vecsv = svargs[efix ? efix-1 : svix++];
7839 vecstr = (U8*)SvPVx(vecsv,veclen);
7840 vec_utf = DO_UTF8(vecsv);
7850 i = va_arg(*args, int);
7852 i = (ewix ? ewix <= svmax : svix < svmax) ?
7853 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
7855 width = (i < 0) ? -i : i;
7865 if (EXPECT_NUMBER(q, epix) && *q++ != '$') /* epix currently unused */
7868 i = va_arg(*args, int);
7870 i = (ewix ? ewix <= svmax : svix < svmax)
7871 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
7872 precis = (i < 0) ? 0 : i;
7877 precis = precis * 10 + (*q++ - '0');
7885 #if defined(HAS_QUAD) || (defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE))
7896 #if defined(HAS_QUAD) || (defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE))
7897 if (*(q + 1) == 'l') { /* lld, llf */
7920 argsv = (efix ? efix <= svmax : svix < svmax) ?
7921 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
7928 uv = args ? va_arg(*args, int) : SvIVx(argsv);
7930 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
7932 eptr = (char*)utf8buf;
7933 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
7945 eptr = va_arg(*args, char*);
7947 #ifdef MACOS_TRADITIONAL
7948 /* On MacOS, %#s format is used for Pascal strings */
7953 elen = strlen(eptr);
7956 elen = sizeof nullstr - 1;
7960 eptr = SvPVx(argsv, elen);
7961 if (DO_UTF8(argsv)) {
7962 if (has_precis && precis < elen) {
7964 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
7967 if (width) { /* fudge width (can't fudge elen) */
7968 width += elen - sv_len_utf8(argsv);
7977 * The "%_" hack might have to be changed someday,
7978 * if ISO or ANSI decide to use '_' for something.
7979 * So we keep it hidden from users' code.
7983 argsv = va_arg(*args, SV*);
7984 eptr = SvPVx(argsv, elen);
7990 if (has_precis && elen > precis)
7999 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8017 uv = utf8n_to_uvchr(vecstr, veclen, &ulen, UTF8_ALLOW_ANYUV);
8025 esignbuf[esignlen++] = plus;
8029 case 'h': iv = (short)va_arg(*args, int); break;
8030 default: iv = va_arg(*args, int); break;
8031 case 'l': iv = va_arg(*args, long); break;
8032 case 'V': iv = va_arg(*args, IV); break;
8034 case 'q': iv = va_arg(*args, Quad_t); break;
8041 case 'h': iv = (short)iv; break;
8043 case 'l': iv = (long)iv; break;
8046 case 'q': iv = (Quad_t)iv; break;
8050 if ( !vectorize ) /* we already set uv above */
8055 esignbuf[esignlen++] = plus;
8059 esignbuf[esignlen++] = '-';
8102 uv = utf8n_to_uvchr(vecstr, veclen, &ulen, UTF8_ALLOW_ANYUV);
8112 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8113 default: uv = va_arg(*args, unsigned); break;
8114 case 'l': uv = va_arg(*args, unsigned long); break;
8115 case 'V': uv = va_arg(*args, UV); break;
8117 case 'q': uv = va_arg(*args, Quad_t); break;
8124 case 'h': uv = (unsigned short)uv; break;
8126 case 'l': uv = (unsigned long)uv; break;
8129 case 'q': uv = (Quad_t)uv; break;
8135 eptr = ebuf + sizeof ebuf;
8141 p = (char*)((c == 'X')
8142 ? "0123456789ABCDEF" : "0123456789abcdef");
8148 esignbuf[esignlen++] = '0';
8149 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8155 *--eptr = '0' + dig;
8157 if (alt && *eptr != '0')
8163 *--eptr = '0' + dig;
8166 esignbuf[esignlen++] = '0';
8167 esignbuf[esignlen++] = 'b';
8170 default: /* it had better be ten or less */
8171 #if defined(PERL_Y2KWARN)
8172 if (ckWARN(WARN_Y2K)) {
8174 char *s = SvPV(sv,n);
8175 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
8176 && (n == 2 || !isDIGIT(s[n-3])))
8178 Perl_warner(aTHX_ WARN_Y2K,
8179 "Possible Y2K bug: %%%c %s",
8180 c, "format string following '19'");
8186 *--eptr = '0' + dig;
8187 } while (uv /= base);
8190 elen = (ebuf + sizeof ebuf) - eptr;
8193 zeros = precis - elen;
8194 else if (precis == 0 && elen == 1 && *eptr == '0')
8199 /* FLOATING POINT */
8202 c = 'f'; /* maybe %F isn't supported here */
8208 /* This is evil, but floating point is even more evil */
8211 nv = args ? va_arg(*args, NV) : SvNVx(argsv);
8214 if (c != 'e' && c != 'E') {
8216 (void)Perl_frexp(nv, &i);
8217 if (i == PERL_INT_MIN)
8218 Perl_die(aTHX_ "panic: frexp");
8220 need = BIT_DIGITS(i);
8222 need += has_precis ? precis : 6; /* known default */
8226 need += 20; /* fudge factor */
8227 if (PL_efloatsize < need) {
8228 Safefree(PL_efloatbuf);
8229 PL_efloatsize = need + 20; /* more fudge */
8230 New(906, PL_efloatbuf, PL_efloatsize, char);
8231 PL_efloatbuf[0] = '\0';
8234 eptr = ebuf + sizeof ebuf;
8237 #if defined(USE_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8239 /* Copy the one or more characters in a long double
8240 * format before the 'base' ([efgEFG]) character to
8241 * the format string. */
8242 static char const prifldbl[] = PERL_PRIfldbl;
8243 char const *p = prifldbl + sizeof(prifldbl) - 3;
8244 while (p >= prifldbl) { *--eptr = *p--; }
8249 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8254 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8266 /* No taint. Otherwise we are in the strange situation
8267 * where printf() taints but print($float) doesn't.
8269 (void)sprintf(PL_efloatbuf, eptr, nv);
8271 eptr = PL_efloatbuf;
8272 elen = strlen(PL_efloatbuf);
8279 i = SvCUR(sv) - origlen;
8282 case 'h': *(va_arg(*args, short*)) = i; break;
8283 default: *(va_arg(*args, int*)) = i; break;
8284 case 'l': *(va_arg(*args, long*)) = i; break;
8285 case 'V': *(va_arg(*args, IV*)) = i; break;
8287 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8292 sv_setuv_mg(argsv, (UV)i);
8293 continue; /* not "break" */
8300 if (!args && ckWARN(WARN_PRINTF) &&
8301 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
8302 SV *msg = sv_newmortal();
8303 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %s: ",
8304 (PL_op->op_type == OP_PRTF) ? "printf" : "sprintf");
8307 Perl_sv_catpvf(aTHX_ msg,
8308 "\"%%%c\"", c & 0xFF);
8310 Perl_sv_catpvf(aTHX_ msg,
8311 "\"%%\\%03"UVof"\"",
8314 sv_catpv(msg, "end of string");
8315 Perl_warner(aTHX_ WARN_PRINTF, "%"SVf, msg); /* yes, this is reentrant */
8318 /* output mangled stuff ... */
8324 /* ... right here, because formatting flags should not apply */
8325 SvGROW(sv, SvCUR(sv) + elen + 1);
8327 Copy(eptr, p, elen, char);
8330 SvCUR(sv) = p - SvPVX(sv);
8331 continue; /* not "break" */
8334 have = esignlen + zeros + elen;
8335 need = (have > width ? have : width);
8338 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8340 if (esignlen && fill == '0') {
8341 for (i = 0; i < esignlen; i++)
8345 memset(p, fill, gap);
8348 if (esignlen && fill != '0') {
8349 for (i = 0; i < esignlen; i++)
8353 for (i = zeros; i; i--)
8357 Copy(eptr, p, elen, char);
8361 memset(p, ' ', gap);
8366 Copy(dotstr, p, dotstrlen, char);
8370 vectorize = FALSE; /* done iterating over vecstr */
8375 SvCUR(sv) = p - SvPVX(sv);
8383 /* =========================================================================
8385 =head1 Cloning an interpreter
8387 All the macros and functions in this section are for the private use of
8388 the main function, perl_clone().
8390 The foo_dup() functions make an exact copy of an existing foo thinngy.
8391 During the course of a cloning, a hash table is used to map old addresses
8392 to new addresses. The table is created and manipulated with the
8393 ptr_table_* functions.
8397 ============================================================================*/
8400 #if defined(USE_ITHREADS)
8402 #if defined(USE_5005THREADS)
8403 # include "error: USE_5005THREADS and USE_ITHREADS are incompatible"
8406 #ifndef GpREFCNT_inc
8407 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8411 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8412 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8413 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8414 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8415 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8416 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8417 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8418 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8419 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8420 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8421 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8422 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8423 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8426 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8427 regcomp.c. AMS 20010712 */
8430 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
8434 struct reg_substr_datum *s;
8437 return (REGEXP *)NULL;
8439 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8442 len = r->offsets[0];
8443 npar = r->nparens+1;
8445 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8446 Copy(r->program, ret->program, len+1, regnode);
8448 New(0, ret->startp, npar, I32);
8449 Copy(r->startp, ret->startp, npar, I32);
8450 New(0, ret->endp, npar, I32);
8451 Copy(r->startp, ret->startp, npar, I32);
8453 New(0, ret->substrs, 1, struct reg_substr_data);
8454 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8455 s->min_offset = r->substrs->data[i].min_offset;
8456 s->max_offset = r->substrs->data[i].max_offset;
8457 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8460 ret->regstclass = NULL;
8463 int count = r->data->count;
8465 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
8466 char, struct reg_data);
8467 New(0, d->what, count, U8);
8470 for (i = 0; i < count; i++) {
8471 d->what[i] = r->data->what[i];
8472 switch (d->what[i]) {
8474 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8477 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8480 /* This is cheating. */
8481 New(0, d->data[i], 1, struct regnode_charclass_class);
8482 StructCopy(r->data->data[i], d->data[i],
8483 struct regnode_charclass_class);
8484 ret->regstclass = (regnode*)d->data[i];
8487 /* Compiled op trees are readonly, and can thus be
8488 shared without duplication. */
8489 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8492 d->data[i] = r->data->data[i];
8502 New(0, ret->offsets, 2*len+1, U32);
8503 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8505 ret->precomp = SAVEPV(r->precomp);
8506 ret->refcnt = r->refcnt;
8507 ret->minlen = r->minlen;
8508 ret->prelen = r->prelen;
8509 ret->nparens = r->nparens;
8510 ret->lastparen = r->lastparen;
8511 ret->lastcloseparen = r->lastcloseparen;
8512 ret->reganch = r->reganch;
8514 ret->sublen = r->sublen;
8516 if (RX_MATCH_COPIED(ret))
8517 ret->subbeg = SAVEPV(r->subbeg);
8519 ret->subbeg = Nullch;
8521 ptr_table_store(PL_ptr_table, r, ret);
8525 /* duplicate a file handle */
8528 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8532 return (PerlIO*)NULL;
8534 /* look for it in the table first */
8535 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8539 /* create anew and remember what it is */
8540 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8541 ptr_table_store(PL_ptr_table, fp, ret);
8545 /* duplicate a directory handle */
8548 Perl_dirp_dup(pTHX_ DIR *dp)
8556 /* duplicate a typeglob */
8559 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8564 /* look for it in the table first */
8565 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8569 /* create anew and remember what it is */
8570 Newz(0, ret, 1, GP);
8571 ptr_table_store(PL_ptr_table, gp, ret);
8574 ret->gp_refcnt = 0; /* must be before any other dups! */
8575 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
8576 ret->gp_io = io_dup_inc(gp->gp_io, param);
8577 ret->gp_form = cv_dup_inc(gp->gp_form, param);
8578 ret->gp_av = av_dup_inc(gp->gp_av, param);
8579 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
8580 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8581 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
8582 ret->gp_cvgen = gp->gp_cvgen;
8583 ret->gp_flags = gp->gp_flags;
8584 ret->gp_line = gp->gp_line;
8585 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
8589 /* duplicate a chain of magic */
8592 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8594 MAGIC *mgprev = (MAGIC*)NULL;
8597 return (MAGIC*)NULL;
8598 /* look for it in the table first */
8599 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8603 for (; mg; mg = mg->mg_moremagic) {
8605 Newz(0, nmg, 1, MAGIC);
8607 mgprev->mg_moremagic = nmg;
8610 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
8611 nmg->mg_private = mg->mg_private;
8612 nmg->mg_type = mg->mg_type;
8613 nmg->mg_flags = mg->mg_flags;
8614 if (mg->mg_type == PERL_MAGIC_qr) {
8615 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8617 else if(mg->mg_type == PERL_MAGIC_backref) {
8618 AV *av = (AV*) mg->mg_obj;
8621 nmg->mg_obj = (SV*)newAV();
8625 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8630 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
8631 ? sv_dup_inc(mg->mg_obj, param)
8632 : sv_dup(mg->mg_obj, param);
8634 nmg->mg_len = mg->mg_len;
8635 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
8636 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
8637 if (mg->mg_len >= 0) {
8638 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
8639 if (mg->mg_type == PERL_MAGIC_overload_table &&
8640 AMT_AMAGIC((AMT*)mg->mg_ptr))
8642 AMT *amtp = (AMT*)mg->mg_ptr;
8643 AMT *namtp = (AMT*)nmg->mg_ptr;
8645 for (i = 1; i < NofAMmeth; i++) {
8646 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
8650 else if (mg->mg_len == HEf_SVKEY)
8651 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
8658 /* create a new pointer-mapping table */
8661 Perl_ptr_table_new(pTHX)
8664 Newz(0, tbl, 1, PTR_TBL_t);
8667 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
8671 /* map an existing pointer using a table */
8674 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
8676 PTR_TBL_ENT_t *tblent;
8677 UV hash = PTR2UV(sv);
8679 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
8680 for (; tblent; tblent = tblent->next) {
8681 if (tblent->oldval == sv)
8682 return tblent->newval;
8687 /* add a new entry to a pointer-mapping table */
8690 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
8692 PTR_TBL_ENT_t *tblent, **otblent;
8693 /* XXX this may be pessimal on platforms where pointers aren't good
8694 * hash values e.g. if they grow faster in the most significant
8696 UV hash = PTR2UV(oldv);
8700 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
8701 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
8702 if (tblent->oldval == oldv) {
8703 tblent->newval = newv;
8708 Newz(0, tblent, 1, PTR_TBL_ENT_t);
8709 tblent->oldval = oldv;
8710 tblent->newval = newv;
8711 tblent->next = *otblent;
8714 if (i && tbl->tbl_items > tbl->tbl_max)
8715 ptr_table_split(tbl);
8718 /* double the hash bucket size of an existing ptr table */
8721 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
8723 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
8724 UV oldsize = tbl->tbl_max + 1;
8725 UV newsize = oldsize * 2;
8728 Renew(ary, newsize, PTR_TBL_ENT_t*);
8729 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
8730 tbl->tbl_max = --newsize;
8732 for (i=0; i < oldsize; i++, ary++) {
8733 PTR_TBL_ENT_t **curentp, **entp, *ent;
8736 curentp = ary + oldsize;
8737 for (entp = ary, ent = *ary; ent; ent = *entp) {
8738 if ((newsize & PTR2UV(ent->oldval)) != i) {
8740 ent->next = *curentp;
8750 /* remove all the entries from a ptr table */
8753 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
8755 register PTR_TBL_ENT_t **array;
8756 register PTR_TBL_ENT_t *entry;
8757 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
8761 if (!tbl || !tbl->tbl_items) {
8765 array = tbl->tbl_ary;
8772 entry = entry->next;
8776 if (++riter > max) {
8779 entry = array[riter];
8786 /* clear and free a ptr table */
8789 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
8794 ptr_table_clear(tbl);
8795 Safefree(tbl->tbl_ary);
8803 /* attempt to make everything in the typeglob readonly */
8806 S_gv_share(pTHX_ SV *sstr)
8809 SV *sv = &PL_sv_no; /* just need SvREADONLY-ness */
8811 if (GvIO(gv) || GvFORM(gv)) {
8812 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
8814 else if (!GvCV(gv)) {
8818 /* CvPADLISTs cannot be shared */
8819 if (!CvXSUB(GvCV(gv))) {
8824 if (!GvUNIQUE(gv)) {
8826 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
8827 HvNAME(GvSTASH(gv)), GvNAME(gv));
8833 * write attempts will die with
8834 * "Modification of a read-only value attempted"
8840 SvREADONLY_on(GvSV(gv));
8847 SvREADONLY_on(GvAV(gv));
8854 SvREADONLY_on(GvAV(gv));
8857 return sstr; /* he_dup() will SvREFCNT_inc() */
8860 /* duplicate an SV of any type (including AV, HV etc) */
8863 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
8867 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
8869 /* look for it in the table first */
8870 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
8874 /* create anew and remember what it is */
8876 ptr_table_store(PL_ptr_table, sstr, dstr);
8879 SvFLAGS(dstr) = SvFLAGS(sstr);
8880 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
8881 SvREFCNT(dstr) = 0; /* must be before any other dups! */
8884 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
8885 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
8886 PL_watch_pvx, SvPVX(sstr));
8889 switch (SvTYPE(sstr)) {
8894 SvANY(dstr) = new_XIV();
8895 SvIVX(dstr) = SvIVX(sstr);
8898 SvANY(dstr) = new_XNV();
8899 SvNVX(dstr) = SvNVX(sstr);
8902 SvANY(dstr) = new_XRV();
8903 SvRV(dstr) = SvRV(sstr) && SvWEAKREF(sstr)
8904 ? sv_dup(SvRV(sstr), param)
8905 : sv_dup_inc(SvRV(sstr), param);
8908 SvANY(dstr) = new_XPV();
8909 SvCUR(dstr) = SvCUR(sstr);
8910 SvLEN(dstr) = SvLEN(sstr);
8912 SvRV(dstr) = SvWEAKREF(sstr)
8913 ? sv_dup(SvRV(sstr), param)
8914 : sv_dup_inc(SvRV(sstr), param);
8915 else if (SvPVX(sstr) && SvLEN(sstr))
8916 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8918 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
8921 SvANY(dstr) = new_XPVIV();
8922 SvCUR(dstr) = SvCUR(sstr);
8923 SvLEN(dstr) = SvLEN(sstr);
8924 SvIVX(dstr) = SvIVX(sstr);
8926 SvRV(dstr) = SvWEAKREF(sstr)
8927 ? sv_dup(SvRV(sstr), param)
8928 : sv_dup_inc(SvRV(sstr), param);
8929 else if (SvPVX(sstr) && SvLEN(sstr))
8930 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8932 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
8935 SvANY(dstr) = new_XPVNV();
8936 SvCUR(dstr) = SvCUR(sstr);
8937 SvLEN(dstr) = SvLEN(sstr);
8938 SvIVX(dstr) = SvIVX(sstr);
8939 SvNVX(dstr) = SvNVX(sstr);
8941 SvRV(dstr) = SvWEAKREF(sstr)
8942 ? sv_dup(SvRV(sstr), param)
8943 : sv_dup_inc(SvRV(sstr), param);
8944 else if (SvPVX(sstr) && SvLEN(sstr))
8945 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8947 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
8950 SvANY(dstr) = new_XPVMG();
8951 SvCUR(dstr) = SvCUR(sstr);
8952 SvLEN(dstr) = SvLEN(sstr);
8953 SvIVX(dstr) = SvIVX(sstr);
8954 SvNVX(dstr) = SvNVX(sstr);
8955 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
8956 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
8958 SvRV(dstr) = SvWEAKREF(sstr)
8959 ? sv_dup(SvRV(sstr), param)
8960 : sv_dup_inc(SvRV(sstr), param);
8961 else if (SvPVX(sstr) && SvLEN(sstr))
8962 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8964 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
8967 SvANY(dstr) = new_XPVBM();
8968 SvCUR(dstr) = SvCUR(sstr);
8969 SvLEN(dstr) = SvLEN(sstr);
8970 SvIVX(dstr) = SvIVX(sstr);
8971 SvNVX(dstr) = SvNVX(sstr);
8972 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
8973 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
8975 SvRV(dstr) = SvWEAKREF(sstr)
8976 ? sv_dup(SvRV(sstr), param)
8977 : sv_dup_inc(SvRV(sstr), param);
8978 else if (SvPVX(sstr) && SvLEN(sstr))
8979 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8981 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
8982 BmRARE(dstr) = BmRARE(sstr);
8983 BmUSEFUL(dstr) = BmUSEFUL(sstr);
8984 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
8987 SvANY(dstr) = new_XPVLV();
8988 SvCUR(dstr) = SvCUR(sstr);
8989 SvLEN(dstr) = SvLEN(sstr);
8990 SvIVX(dstr) = SvIVX(sstr);
8991 SvNVX(dstr) = SvNVX(sstr);
8992 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
8993 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
8995 SvRV(dstr) = SvWEAKREF(sstr)
8996 ? sv_dup(SvRV(sstr), param)
8997 : sv_dup_inc(SvRV(sstr), param);
8998 else if (SvPVX(sstr) && SvLEN(sstr))
8999 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9001 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
9002 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
9003 LvTARGLEN(dstr) = LvTARGLEN(sstr);
9004 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
9005 LvTYPE(dstr) = LvTYPE(sstr);
9008 if (GvUNIQUE((GV*)sstr)) {
9010 if ((share = gv_share(sstr))) {
9014 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
9015 HvNAME(GvSTASH(share)), GvNAME(share));
9020 SvANY(dstr) = new_XPVGV();
9021 SvCUR(dstr) = SvCUR(sstr);
9022 SvLEN(dstr) = SvLEN(sstr);
9023 SvIVX(dstr) = SvIVX(sstr);
9024 SvNVX(dstr) = SvNVX(sstr);
9025 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9026 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9028 SvRV(dstr) = SvWEAKREF(sstr)
9029 ? sv_dup(SvRV(sstr), param)
9030 : sv_dup_inc(SvRV(sstr), param);
9031 else if (SvPVX(sstr) && SvLEN(sstr))
9032 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9034 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
9035 GvNAMELEN(dstr) = GvNAMELEN(sstr);
9036 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
9037 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
9038 GvFLAGS(dstr) = GvFLAGS(sstr);
9039 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9040 (void)GpREFCNT_inc(GvGP(dstr));
9043 SvANY(dstr) = new_XPVIO();
9044 SvCUR(dstr) = SvCUR(sstr);
9045 SvLEN(dstr) = SvLEN(sstr);
9046 SvIVX(dstr) = SvIVX(sstr);
9047 SvNVX(dstr) = SvNVX(sstr);
9048 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9049 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9051 SvRV(dstr) = SvWEAKREF(sstr)
9052 ? sv_dup(SvRV(sstr), param)
9053 : sv_dup_inc(SvRV(sstr), param);
9054 else if (SvPVX(sstr) && SvLEN(sstr))
9055 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9057 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
9058 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
9059 if (IoOFP(sstr) == IoIFP(sstr))
9060 IoOFP(dstr) = IoIFP(dstr);
9062 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
9063 /* PL_rsfp_filters entries have fake IoDIRP() */
9064 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
9065 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
9067 IoDIRP(dstr) = IoDIRP(sstr);
9068 IoLINES(dstr) = IoLINES(sstr);
9069 IoPAGE(dstr) = IoPAGE(sstr);
9070 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
9071 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
9072 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
9073 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
9074 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
9075 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
9076 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
9077 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
9078 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
9079 IoTYPE(dstr) = IoTYPE(sstr);
9080 IoFLAGS(dstr) = IoFLAGS(sstr);
9083 SvANY(dstr) = new_XPVAV();
9084 SvCUR(dstr) = SvCUR(sstr);
9085 SvLEN(dstr) = SvLEN(sstr);
9086 SvIVX(dstr) = SvIVX(sstr);
9087 SvNVX(dstr) = SvNVX(sstr);
9088 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9089 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9090 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
9091 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
9092 if (AvARRAY((AV*)sstr)) {
9093 SV **dst_ary, **src_ary;
9094 SSize_t items = AvFILLp((AV*)sstr) + 1;
9096 src_ary = AvARRAY((AV*)sstr);
9097 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
9098 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9099 SvPVX(dstr) = (char*)dst_ary;
9100 AvALLOC((AV*)dstr) = dst_ary;
9101 if (AvREAL((AV*)sstr)) {
9103 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9107 *dst_ary++ = sv_dup(*src_ary++, param);
9109 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9110 while (items-- > 0) {
9111 *dst_ary++ = &PL_sv_undef;
9115 SvPVX(dstr) = Nullch;
9116 AvALLOC((AV*)dstr) = (SV**)NULL;
9120 SvANY(dstr) = new_XPVHV();
9121 SvCUR(dstr) = SvCUR(sstr);
9122 SvLEN(dstr) = SvLEN(sstr);
9123 SvIVX(dstr) = SvIVX(sstr);
9124 SvNVX(dstr) = SvNVX(sstr);
9125 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9126 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9127 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
9128 if (HvARRAY((HV*)sstr)) {
9130 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
9131 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
9132 Newz(0, dxhv->xhv_array,
9133 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
9134 while (i <= sxhv->xhv_max) {
9135 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
9136 !!HvSHAREKEYS(sstr), param);
9139 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter, !!HvSHAREKEYS(sstr), param);
9142 SvPVX(dstr) = Nullch;
9143 HvEITER((HV*)dstr) = (HE*)NULL;
9145 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
9146 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
9147 /* Record stashes for possible cloning in Perl_clone(). */
9148 if(HvNAME((HV*)dstr))
9149 av_push(param->stashes, dstr);
9152 SvANY(dstr) = new_XPVFM();
9153 FmLINES(dstr) = FmLINES(sstr);
9157 SvANY(dstr) = new_XPVCV();
9159 SvCUR(dstr) = SvCUR(sstr);
9160 SvLEN(dstr) = SvLEN(sstr);
9161 SvIVX(dstr) = SvIVX(sstr);
9162 SvNVX(dstr) = SvNVX(sstr);
9163 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9164 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9165 if (SvPVX(sstr) && SvLEN(sstr))
9166 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9168 SvPVX(dstr) = SvPVX(sstr); /* XXX shared string/random ptr? */
9169 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
9170 CvSTART(dstr) = CvSTART(sstr);
9171 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
9172 CvXSUB(dstr) = CvXSUB(sstr);
9173 CvXSUBANY(dstr) = CvXSUBANY(sstr);
9174 if (CvCONST(sstr)) {
9175 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
9176 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
9177 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
9179 CvGV(dstr) = gv_dup(CvGV(sstr), param);
9180 if (param->flags & CLONEf_COPY_STACKS) {
9181 CvDEPTH(dstr) = CvDEPTH(sstr);
9185 if (CvPADLIST(sstr) && !AvREAL(CvPADLIST(sstr))) {
9186 /* XXX padlists are real, but pretend to be not */
9187 AvREAL_on(CvPADLIST(sstr));
9188 CvPADLIST(dstr) = av_dup_inc(CvPADLIST(sstr), param);
9189 AvREAL_off(CvPADLIST(sstr));
9190 AvREAL_off(CvPADLIST(dstr));
9193 CvPADLIST(dstr) = av_dup_inc(CvPADLIST(sstr), param);
9194 if (!CvANON(sstr) || CvCLONED(sstr))
9195 CvOUTSIDE(dstr) = cv_dup_inc(CvOUTSIDE(sstr), param);
9197 CvOUTSIDE(dstr) = cv_dup(CvOUTSIDE(sstr), param);
9198 CvFLAGS(dstr) = CvFLAGS(sstr);
9199 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
9202 Perl_croak(aTHX_ "Bizarre SvTYPE [%d]", SvTYPE(sstr));
9206 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9212 /* duplicate a context */
9215 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9220 return (PERL_CONTEXT*)NULL;
9222 /* look for it in the table first */
9223 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9227 /* create anew and remember what it is */
9228 Newz(56, ncxs, max + 1, PERL_CONTEXT);
9229 ptr_table_store(PL_ptr_table, cxs, ncxs);
9232 PERL_CONTEXT *cx = &cxs[ix];
9233 PERL_CONTEXT *ncx = &ncxs[ix];
9234 ncx->cx_type = cx->cx_type;
9235 if (CxTYPE(cx) == CXt_SUBST) {
9236 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9239 ncx->blk_oldsp = cx->blk_oldsp;
9240 ncx->blk_oldcop = cx->blk_oldcop;
9241 ncx->blk_oldretsp = cx->blk_oldretsp;
9242 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9243 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9244 ncx->blk_oldpm = cx->blk_oldpm;
9245 ncx->blk_gimme = cx->blk_gimme;
9246 switch (CxTYPE(cx)) {
9248 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9249 ? cv_dup_inc(cx->blk_sub.cv, param)
9250 : cv_dup(cx->blk_sub.cv,param));
9251 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9252 ? av_dup_inc(cx->blk_sub.argarray, param)
9254 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9255 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9256 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9257 ncx->blk_sub.lval = cx->blk_sub.lval;
9260 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9261 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9262 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);;
9263 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9264 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9267 ncx->blk_loop.label = cx->blk_loop.label;
9268 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9269 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9270 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9271 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9272 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9273 ? cx->blk_loop.iterdata
9274 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9275 ncx->blk_loop.oldcurpad
9276 = (SV**)ptr_table_fetch(PL_ptr_table,
9277 cx->blk_loop.oldcurpad);
9278 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9279 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9280 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9281 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9282 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9285 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9286 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9287 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9288 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9300 /* duplicate a stack info structure */
9303 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9308 return (PERL_SI*)NULL;
9310 /* look for it in the table first */
9311 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9315 /* create anew and remember what it is */
9316 Newz(56, nsi, 1, PERL_SI);
9317 ptr_table_store(PL_ptr_table, si, nsi);
9319 nsi->si_stack = av_dup_inc(si->si_stack, param);
9320 nsi->si_cxix = si->si_cxix;
9321 nsi->si_cxmax = si->si_cxmax;
9322 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9323 nsi->si_type = si->si_type;
9324 nsi->si_prev = si_dup(si->si_prev, param);
9325 nsi->si_next = si_dup(si->si_next, param);
9326 nsi->si_markoff = si->si_markoff;
9331 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9332 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9333 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9334 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9335 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9336 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9337 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9338 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9339 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9340 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9341 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9342 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9345 #define pv_dup_inc(p) SAVEPV(p)
9346 #define pv_dup(p) SAVEPV(p)
9347 #define svp_dup_inc(p,pp) any_dup(p,pp)
9349 /* map any object to the new equivent - either something in the
9350 * ptr table, or something in the interpreter structure
9354 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
9361 /* look for it in the table first */
9362 ret = ptr_table_fetch(PL_ptr_table, v);
9366 /* see if it is part of the interpreter structure */
9367 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9368 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9375 /* duplicate the save stack */
9378 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9380 ANY *ss = proto_perl->Tsavestack;
9381 I32 ix = proto_perl->Tsavestack_ix;
9382 I32 max = proto_perl->Tsavestack_max;
9395 void (*dptr) (void*);
9396 void (*dxptr) (pTHX_ void*);
9399 Newz(54, nss, max, ANY);
9405 case SAVEt_ITEM: /* normal string */
9406 sv = (SV*)POPPTR(ss,ix);
9407 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9408 sv = (SV*)POPPTR(ss,ix);
9409 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9411 case SAVEt_SV: /* scalar reference */
9412 sv = (SV*)POPPTR(ss,ix);
9413 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9414 gv = (GV*)POPPTR(ss,ix);
9415 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9417 case SAVEt_GENERIC_PVREF: /* generic char* */
9418 c = (char*)POPPTR(ss,ix);
9419 TOPPTR(nss,ix) = pv_dup(c);
9420 ptr = POPPTR(ss,ix);
9421 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9423 case SAVEt_GENERIC_SVREF: /* generic sv */
9424 case SAVEt_SVREF: /* scalar reference */
9425 sv = (SV*)POPPTR(ss,ix);
9426 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9427 ptr = POPPTR(ss,ix);
9428 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9430 case SAVEt_AV: /* array reference */
9431 av = (AV*)POPPTR(ss,ix);
9432 TOPPTR(nss,ix) = av_dup_inc(av, param);
9433 gv = (GV*)POPPTR(ss,ix);
9434 TOPPTR(nss,ix) = gv_dup(gv, param);
9436 case SAVEt_HV: /* hash reference */
9437 hv = (HV*)POPPTR(ss,ix);
9438 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9439 gv = (GV*)POPPTR(ss,ix);
9440 TOPPTR(nss,ix) = gv_dup(gv, param);
9442 case SAVEt_INT: /* int reference */
9443 ptr = POPPTR(ss,ix);
9444 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9445 intval = (int)POPINT(ss,ix);
9446 TOPINT(nss,ix) = intval;
9448 case SAVEt_LONG: /* long reference */
9449 ptr = POPPTR(ss,ix);
9450 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9451 longval = (long)POPLONG(ss,ix);
9452 TOPLONG(nss,ix) = longval;
9454 case SAVEt_I32: /* I32 reference */
9455 case SAVEt_I16: /* I16 reference */
9456 case SAVEt_I8: /* I8 reference */
9457 ptr = POPPTR(ss,ix);
9458 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9462 case SAVEt_IV: /* IV reference */
9463 ptr = POPPTR(ss,ix);
9464 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9468 case SAVEt_SPTR: /* SV* reference */
9469 ptr = POPPTR(ss,ix);
9470 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9471 sv = (SV*)POPPTR(ss,ix);
9472 TOPPTR(nss,ix) = sv_dup(sv, param);
9474 case SAVEt_VPTR: /* random* reference */
9475 ptr = POPPTR(ss,ix);
9476 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9477 ptr = POPPTR(ss,ix);
9478 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9480 case SAVEt_PPTR: /* char* reference */
9481 ptr = POPPTR(ss,ix);
9482 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9483 c = (char*)POPPTR(ss,ix);
9484 TOPPTR(nss,ix) = pv_dup(c);
9486 case SAVEt_HPTR: /* HV* reference */
9487 ptr = POPPTR(ss,ix);
9488 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9489 hv = (HV*)POPPTR(ss,ix);
9490 TOPPTR(nss,ix) = hv_dup(hv, param);
9492 case SAVEt_APTR: /* AV* reference */
9493 ptr = POPPTR(ss,ix);
9494 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9495 av = (AV*)POPPTR(ss,ix);
9496 TOPPTR(nss,ix) = av_dup(av, param);
9499 gv = (GV*)POPPTR(ss,ix);
9500 TOPPTR(nss,ix) = gv_dup(gv, param);
9502 case SAVEt_GP: /* scalar reference */
9503 gp = (GP*)POPPTR(ss,ix);
9504 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9505 (void)GpREFCNT_inc(gp);
9506 gv = (GV*)POPPTR(ss,ix);
9507 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9508 c = (char*)POPPTR(ss,ix);
9509 TOPPTR(nss,ix) = pv_dup(c);
9516 case SAVEt_MORTALIZESV:
9517 sv = (SV*)POPPTR(ss,ix);
9518 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9521 ptr = POPPTR(ss,ix);
9522 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9523 /* these are assumed to be refcounted properly */
9524 switch (((OP*)ptr)->op_type) {
9531 TOPPTR(nss,ix) = ptr;
9536 TOPPTR(nss,ix) = Nullop;
9541 TOPPTR(nss,ix) = Nullop;
9544 c = (char*)POPPTR(ss,ix);
9545 TOPPTR(nss,ix) = pv_dup_inc(c);
9548 longval = POPLONG(ss,ix);
9549 TOPLONG(nss,ix) = longval;
9552 hv = (HV*)POPPTR(ss,ix);
9553 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9554 c = (char*)POPPTR(ss,ix);
9555 TOPPTR(nss,ix) = pv_dup_inc(c);
9559 case SAVEt_DESTRUCTOR:
9560 ptr = POPPTR(ss,ix);
9561 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9562 dptr = POPDPTR(ss,ix);
9563 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
9565 case SAVEt_DESTRUCTOR_X:
9566 ptr = POPPTR(ss,ix);
9567 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9568 dxptr = POPDXPTR(ss,ix);
9569 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
9571 case SAVEt_REGCONTEXT:
9577 case SAVEt_STACK_POS: /* Position on Perl stack */
9581 case SAVEt_AELEM: /* array element */
9582 sv = (SV*)POPPTR(ss,ix);
9583 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9586 av = (AV*)POPPTR(ss,ix);
9587 TOPPTR(nss,ix) = av_dup_inc(av, param);
9589 case SAVEt_HELEM: /* hash element */
9590 sv = (SV*)POPPTR(ss,ix);
9591 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9592 sv = (SV*)POPPTR(ss,ix);
9593 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9594 hv = (HV*)POPPTR(ss,ix);
9595 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9598 ptr = POPPTR(ss,ix);
9599 TOPPTR(nss,ix) = ptr;
9606 av = (AV*)POPPTR(ss,ix);
9607 TOPPTR(nss,ix) = av_dup(av, param);
9610 longval = (long)POPLONG(ss,ix);
9611 TOPLONG(nss,ix) = longval;
9612 ptr = POPPTR(ss,ix);
9613 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9614 sv = (SV*)POPPTR(ss,ix);
9615 TOPPTR(nss,ix) = sv_dup(sv, param);
9618 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9626 =for apidoc perl_clone
9628 Create and return a new interpreter by cloning the current one.
9633 /* XXX the above needs expanding by someone who actually understands it ! */
9634 EXTERN_C PerlInterpreter *
9635 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
9638 perl_clone(PerlInterpreter *proto_perl, UV flags)
9640 #ifdef PERL_IMPLICIT_SYS
9642 /* perlhost.h so we need to call into it
9643 to clone the host, CPerlHost should have a c interface, sky */
9645 if (flags & CLONEf_CLONE_HOST) {
9646 return perl_clone_host(proto_perl,flags);
9648 return perl_clone_using(proto_perl, flags,
9650 proto_perl->IMemShared,
9651 proto_perl->IMemParse,
9661 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
9662 struct IPerlMem* ipM, struct IPerlMem* ipMS,
9663 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
9664 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
9665 struct IPerlDir* ipD, struct IPerlSock* ipS,
9666 struct IPerlProc* ipP)
9668 /* XXX many of the string copies here can be optimized if they're
9669 * constants; they need to be allocated as common memory and just
9670 * their pointers copied. */
9673 CLONE_PARAMS* param = (CLONE_PARAMS*) malloc(sizeof(CLONE_PARAMS));
9675 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
9676 PERL_SET_THX(my_perl);
9679 memset(my_perl, 0xab, sizeof(PerlInterpreter));
9685 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
9686 # else /* !DEBUGGING */
9687 Zero(my_perl, 1, PerlInterpreter);
9688 # endif /* DEBUGGING */
9692 PL_MemShared = ipMS;
9700 #else /* !PERL_IMPLICIT_SYS */
9702 CLONE_PARAMS* param = (CLONE_PARAMS*) malloc(sizeof(CLONE_PARAMS));
9703 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
9704 PERL_SET_THX(my_perl);
9709 memset(my_perl, 0xab, sizeof(PerlInterpreter));
9715 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
9716 # else /* !DEBUGGING */
9717 Zero(my_perl, 1, PerlInterpreter);
9718 # endif /* DEBUGGING */
9719 #endif /* PERL_IMPLICIT_SYS */
9720 param->flags = flags;
9723 PL_xiv_arenaroot = NULL;
9725 PL_xnv_arenaroot = NULL;
9727 PL_xrv_arenaroot = NULL;
9729 PL_xpv_arenaroot = NULL;
9731 PL_xpviv_arenaroot = NULL;
9732 PL_xpviv_root = NULL;
9733 PL_xpvnv_arenaroot = NULL;
9734 PL_xpvnv_root = NULL;
9735 PL_xpvcv_arenaroot = NULL;
9736 PL_xpvcv_root = NULL;
9737 PL_xpvav_arenaroot = NULL;
9738 PL_xpvav_root = NULL;
9739 PL_xpvhv_arenaroot = NULL;
9740 PL_xpvhv_root = NULL;
9741 PL_xpvmg_arenaroot = NULL;
9742 PL_xpvmg_root = NULL;
9743 PL_xpvlv_arenaroot = NULL;
9744 PL_xpvlv_root = NULL;
9745 PL_xpvbm_arenaroot = NULL;
9746 PL_xpvbm_root = NULL;
9747 PL_he_arenaroot = NULL;
9749 PL_nice_chunk = NULL;
9750 PL_nice_chunk_size = 0;
9753 PL_sv_root = Nullsv;
9754 PL_sv_arenaroot = Nullsv;
9756 PL_debug = proto_perl->Idebug;
9758 #ifdef USE_REENTRANT_API
9759 New(31337, PL_reentrant_buffer,1, REBUF);
9760 New(31337, PL_reentrant_buffer->tmbuff,1, struct tm);
9763 /* create SV map for pointer relocation */
9764 PL_ptr_table = ptr_table_new();
9766 /* initialize these special pointers as early as possible */
9767 SvANY(&PL_sv_undef) = NULL;
9768 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
9769 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
9770 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
9772 SvANY(&PL_sv_no) = new_XPVNV();
9773 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
9774 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
9775 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
9776 SvCUR(&PL_sv_no) = 0;
9777 SvLEN(&PL_sv_no) = 1;
9778 SvNVX(&PL_sv_no) = 0;
9779 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
9781 SvANY(&PL_sv_yes) = new_XPVNV();
9782 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
9783 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
9784 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
9785 SvCUR(&PL_sv_yes) = 1;
9786 SvLEN(&PL_sv_yes) = 2;
9787 SvNVX(&PL_sv_yes) = 1;
9788 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
9790 /* create shared string table */
9791 PL_strtab = newHV();
9792 HvSHAREKEYS_off(PL_strtab);
9793 hv_ksplit(PL_strtab, 512);
9794 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
9796 PL_compiling = proto_perl->Icompiling;
9797 PL_compiling.cop_stashpv = SAVEPV(PL_compiling.cop_stashpv);
9798 PL_compiling.cop_file = SAVEPV(PL_compiling.cop_file);
9799 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
9800 if (!specialWARN(PL_compiling.cop_warnings))
9801 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
9802 if (!specialCopIO(PL_compiling.cop_io))
9803 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
9804 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
9806 /* pseudo environmental stuff */
9807 PL_origargc = proto_perl->Iorigargc;
9809 New(0, PL_origargv, i+1, char*);
9810 PL_origargv[i] = '\0';
9812 PL_origargv[i] = SAVEPV(proto_perl->Iorigargv[i]);
9815 param->stashes = newAV(); /* Setup array of objects to call clone on */
9817 #ifdef PERLIO_LAYERS
9818 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
9819 PerlIO_clone(aTHX_ proto_perl, param);
9822 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
9823 PL_incgv = gv_dup(proto_perl->Iincgv, param);
9824 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
9825 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
9826 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
9827 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
9830 PL_minus_c = proto_perl->Iminus_c;
9831 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
9832 PL_localpatches = proto_perl->Ilocalpatches;
9833 PL_splitstr = proto_perl->Isplitstr;
9834 PL_preprocess = proto_perl->Ipreprocess;
9835 PL_minus_n = proto_perl->Iminus_n;
9836 PL_minus_p = proto_perl->Iminus_p;
9837 PL_minus_l = proto_perl->Iminus_l;
9838 PL_minus_a = proto_perl->Iminus_a;
9839 PL_minus_F = proto_perl->Iminus_F;
9840 PL_doswitches = proto_perl->Idoswitches;
9841 PL_dowarn = proto_perl->Idowarn;
9842 PL_doextract = proto_perl->Idoextract;
9843 PL_sawampersand = proto_perl->Isawampersand;
9844 PL_unsafe = proto_perl->Iunsafe;
9845 PL_inplace = SAVEPV(proto_perl->Iinplace);
9846 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
9847 PL_perldb = proto_perl->Iperldb;
9848 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
9849 PL_exit_flags = proto_perl->Iexit_flags;
9851 /* magical thingies */
9852 /* XXX time(&PL_basetime) when asked for? */
9853 PL_basetime = proto_perl->Ibasetime;
9854 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
9856 PL_maxsysfd = proto_perl->Imaxsysfd;
9857 PL_multiline = proto_perl->Imultiline;
9858 PL_statusvalue = proto_perl->Istatusvalue;
9860 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
9862 PL_encoding = sv_dup(proto_perl->Iencoding, param);
9864 /* Clone the regex array */
9865 PL_regex_padav = newAV();
9867 I32 len = av_len((AV*)proto_perl->Iregex_padav);
9868 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
9869 av_push(PL_regex_padav,
9870 sv_dup_inc(regexen[0],param));
9871 for(i = 1; i <= len; i++) {
9872 if(SvREPADTMP(regexen[i])) {
9873 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
9875 av_push(PL_regex_padav,
9877 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
9878 SvIVX(regexen[i])), param)))
9883 PL_regex_pad = AvARRAY(PL_regex_padav);
9885 /* shortcuts to various I/O objects */
9886 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
9887 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
9888 PL_defgv = gv_dup(proto_perl->Idefgv, param);
9889 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
9890 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
9891 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
9893 /* shortcuts to regexp stuff */
9894 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
9896 /* shortcuts to misc objects */
9897 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
9899 /* shortcuts to debugging objects */
9900 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
9901 PL_DBline = gv_dup(proto_perl->IDBline, param);
9902 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
9903 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
9904 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
9905 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
9906 PL_lineary = av_dup(proto_perl->Ilineary, param);
9907 PL_dbargs = av_dup(proto_perl->Idbargs, param);
9910 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
9911 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
9912 PL_nullstash = hv_dup(proto_perl->Inullstash, param);
9913 PL_debstash = hv_dup(proto_perl->Idebstash, param);
9914 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
9915 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
9917 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
9918 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
9919 PL_endav = av_dup_inc(proto_perl->Iendav, param);
9920 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
9921 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
9923 PL_sub_generation = proto_perl->Isub_generation;
9925 /* funky return mechanisms */
9926 PL_forkprocess = proto_perl->Iforkprocess;
9928 /* subprocess state */
9929 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
9931 /* internal state */
9932 PL_tainting = proto_perl->Itainting;
9933 PL_maxo = proto_perl->Imaxo;
9934 if (proto_perl->Iop_mask)
9935 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
9937 PL_op_mask = Nullch;
9939 /* current interpreter roots */
9940 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
9941 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
9942 PL_main_start = proto_perl->Imain_start;
9943 PL_eval_root = proto_perl->Ieval_root;
9944 PL_eval_start = proto_perl->Ieval_start;
9946 /* runtime control stuff */
9947 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
9948 PL_copline = proto_perl->Icopline;
9950 PL_filemode = proto_perl->Ifilemode;
9951 PL_lastfd = proto_perl->Ilastfd;
9952 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
9955 PL_gensym = proto_perl->Igensym;
9956 PL_preambled = proto_perl->Ipreambled;
9957 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
9958 PL_laststatval = proto_perl->Ilaststatval;
9959 PL_laststype = proto_perl->Ilaststype;
9960 PL_mess_sv = Nullsv;
9962 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
9963 PL_ofmt = SAVEPV(proto_perl->Iofmt);
9965 /* interpreter atexit processing */
9966 PL_exitlistlen = proto_perl->Iexitlistlen;
9967 if (PL_exitlistlen) {
9968 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
9969 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
9972 PL_exitlist = (PerlExitListEntry*)NULL;
9973 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
9974 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
9975 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
9977 PL_profiledata = NULL;
9978 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
9979 /* PL_rsfp_filters entries have fake IoDIRP() */
9980 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
9982 PL_compcv = cv_dup(proto_perl->Icompcv, param);
9983 PL_comppad = av_dup(proto_perl->Icomppad, param);
9984 PL_comppad_name = av_dup(proto_perl->Icomppad_name, param);
9985 PL_comppad_name_fill = proto_perl->Icomppad_name_fill;
9986 PL_comppad_name_floor = proto_perl->Icomppad_name_floor;
9987 PL_curpad = (SV**)ptr_table_fetch(PL_ptr_table,
9988 proto_perl->Tcurpad);
9990 #ifdef HAVE_INTERP_INTERN
9991 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
9994 /* more statics moved here */
9995 PL_generation = proto_perl->Igeneration;
9996 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
9998 PL_in_clean_objs = proto_perl->Iin_clean_objs;
9999 PL_in_clean_all = proto_perl->Iin_clean_all;
10001 PL_uid = proto_perl->Iuid;
10002 PL_euid = proto_perl->Ieuid;
10003 PL_gid = proto_perl->Igid;
10004 PL_egid = proto_perl->Iegid;
10005 PL_nomemok = proto_perl->Inomemok;
10006 PL_an = proto_perl->Ian;
10007 PL_cop_seqmax = proto_perl->Icop_seqmax;
10008 PL_op_seqmax = proto_perl->Iop_seqmax;
10009 PL_evalseq = proto_perl->Ievalseq;
10010 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10011 PL_origalen = proto_perl->Iorigalen;
10012 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10013 PL_osname = SAVEPV(proto_perl->Iosname);
10014 PL_sh_path = proto_perl->Ish_path; /* XXX never deallocated */
10015 PL_sighandlerp = proto_perl->Isighandlerp;
10018 PL_runops = proto_perl->Irunops;
10020 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10023 PL_cshlen = proto_perl->Icshlen;
10024 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10027 PL_lex_state = proto_perl->Ilex_state;
10028 PL_lex_defer = proto_perl->Ilex_defer;
10029 PL_lex_expect = proto_perl->Ilex_expect;
10030 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10031 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10032 PL_lex_starts = proto_perl->Ilex_starts;
10033 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10034 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10035 PL_lex_op = proto_perl->Ilex_op;
10036 PL_lex_inpat = proto_perl->Ilex_inpat;
10037 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10038 PL_lex_brackets = proto_perl->Ilex_brackets;
10039 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10040 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10041 PL_lex_casemods = proto_perl->Ilex_casemods;
10042 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10043 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10045 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10046 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10047 PL_nexttoke = proto_perl->Inexttoke;
10049 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10050 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
10051 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10052 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
10053 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10054 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
10055 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10056 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10057 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
10058 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10059 PL_pending_ident = proto_perl->Ipending_ident;
10060 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10062 PL_expect = proto_perl->Iexpect;
10064 PL_multi_start = proto_perl->Imulti_start;
10065 PL_multi_end = proto_perl->Imulti_end;
10066 PL_multi_open = proto_perl->Imulti_open;
10067 PL_multi_close = proto_perl->Imulti_close;
10069 PL_error_count = proto_perl->Ierror_count;
10070 PL_subline = proto_perl->Isubline;
10071 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10073 PL_min_intro_pending = proto_perl->Imin_intro_pending;
10074 PL_max_intro_pending = proto_perl->Imax_intro_pending;
10075 PL_padix = proto_perl->Ipadix;
10076 PL_padix_floor = proto_perl->Ipadix_floor;
10077 PL_pad_reset_pending = proto_perl->Ipad_reset_pending;
10079 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
10080 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10081 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
10082 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10083 PL_last_lop_op = proto_perl->Ilast_lop_op;
10084 PL_in_my = proto_perl->Iin_my;
10085 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10087 PL_cryptseen = proto_perl->Icryptseen;
10090 PL_hints = proto_perl->Ihints;
10092 PL_amagic_generation = proto_perl->Iamagic_generation;
10094 #ifdef USE_LOCALE_COLLATE
10095 PL_collation_ix = proto_perl->Icollation_ix;
10096 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10097 PL_collation_standard = proto_perl->Icollation_standard;
10098 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10099 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10100 #endif /* USE_LOCALE_COLLATE */
10102 #ifdef USE_LOCALE_NUMERIC
10103 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10104 PL_numeric_standard = proto_perl->Inumeric_standard;
10105 PL_numeric_local = proto_perl->Inumeric_local;
10106 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10107 #endif /* !USE_LOCALE_NUMERIC */
10109 /* utf8 character classes */
10110 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10111 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10112 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10113 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10114 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10115 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10116 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10117 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10118 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10119 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10120 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10121 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10122 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10123 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10124 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10125 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10126 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10127 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10130 PL_last_swash_hv = Nullhv; /* reinits on demand */
10131 PL_last_swash_klen = 0;
10132 PL_last_swash_key[0]= '\0';
10133 PL_last_swash_tmps = (U8*)NULL;
10134 PL_last_swash_slen = 0;
10136 /* perly.c globals */
10137 PL_yydebug = proto_perl->Iyydebug;
10138 PL_yynerrs = proto_perl->Iyynerrs;
10139 PL_yyerrflag = proto_perl->Iyyerrflag;
10140 PL_yychar = proto_perl->Iyychar;
10141 PL_yyval = proto_perl->Iyyval;
10142 PL_yylval = proto_perl->Iyylval;
10144 PL_glob_index = proto_perl->Iglob_index;
10145 PL_srand_called = proto_perl->Isrand_called;
10146 PL_uudmap['M'] = 0; /* reinits on demand */
10147 PL_bitcount = Nullch; /* reinits on demand */
10149 if (proto_perl->Ipsig_pend) {
10150 Newz(0, PL_psig_pend, SIG_SIZE, int);
10153 PL_psig_pend = (int*)NULL;
10156 if (proto_perl->Ipsig_ptr) {
10157 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
10158 Newz(0, PL_psig_name, SIG_SIZE, SV*);
10159 for (i = 1; i < SIG_SIZE; i++) {
10160 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10161 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10165 PL_psig_ptr = (SV**)NULL;
10166 PL_psig_name = (SV**)NULL;
10169 /* thrdvar.h stuff */
10171 if (flags & CLONEf_COPY_STACKS) {
10172 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10173 PL_tmps_ix = proto_perl->Ttmps_ix;
10174 PL_tmps_max = proto_perl->Ttmps_max;
10175 PL_tmps_floor = proto_perl->Ttmps_floor;
10176 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
10178 while (i <= PL_tmps_ix) {
10179 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10183 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10184 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10185 Newz(54, PL_markstack, i, I32);
10186 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10187 - proto_perl->Tmarkstack);
10188 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10189 - proto_perl->Tmarkstack);
10190 Copy(proto_perl->Tmarkstack, PL_markstack,
10191 PL_markstack_ptr - PL_markstack + 1, I32);
10193 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10194 * NOTE: unlike the others! */
10195 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10196 PL_scopestack_max = proto_perl->Tscopestack_max;
10197 Newz(54, PL_scopestack, PL_scopestack_max, I32);
10198 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10200 /* next push_return() sets PL_retstack[PL_retstack_ix]
10201 * NOTE: unlike the others! */
10202 PL_retstack_ix = proto_perl->Tretstack_ix;
10203 PL_retstack_max = proto_perl->Tretstack_max;
10204 Newz(54, PL_retstack, PL_retstack_max, OP*);
10205 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, I32);
10207 /* NOTE: si_dup() looks at PL_markstack */
10208 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10210 /* PL_curstack = PL_curstackinfo->si_stack; */
10211 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10212 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10214 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10215 PL_stack_base = AvARRAY(PL_curstack);
10216 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10217 - proto_perl->Tstack_base);
10218 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10220 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10221 * NOTE: unlike the others! */
10222 PL_savestack_ix = proto_perl->Tsavestack_ix;
10223 PL_savestack_max = proto_perl->Tsavestack_max;
10224 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
10225 PL_savestack = ss_dup(proto_perl, param);
10229 ENTER; /* perl_destruct() wants to LEAVE; */
10232 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10233 PL_top_env = &PL_start_env;
10235 PL_op = proto_perl->Top;
10238 PL_Xpv = (XPV*)NULL;
10239 PL_na = proto_perl->Tna;
10241 PL_statbuf = proto_perl->Tstatbuf;
10242 PL_statcache = proto_perl->Tstatcache;
10243 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10244 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10246 PL_timesbuf = proto_perl->Ttimesbuf;
10249 PL_tainted = proto_perl->Ttainted;
10250 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10251 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10252 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10253 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10254 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10255 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10256 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10257 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10258 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10260 PL_restartop = proto_perl->Trestartop;
10261 PL_in_eval = proto_perl->Tin_eval;
10262 PL_delaymagic = proto_perl->Tdelaymagic;
10263 PL_dirty = proto_perl->Tdirty;
10264 PL_localizing = proto_perl->Tlocalizing;
10266 #ifdef PERL_FLEXIBLE_EXCEPTIONS
10267 PL_protect = proto_perl->Tprotect;
10269 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10270 PL_av_fetch_sv = Nullsv;
10271 PL_hv_fetch_sv = Nullsv;
10272 Zero(&PL_hv_fetch_ent_mh, 1, HE); /* XXX */
10273 PL_modcount = proto_perl->Tmodcount;
10274 PL_lastgotoprobe = Nullop;
10275 PL_dumpindent = proto_perl->Tdumpindent;
10277 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10278 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10279 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10280 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10281 PL_sortcxix = proto_perl->Tsortcxix;
10282 PL_efloatbuf = Nullch; /* reinits on demand */
10283 PL_efloatsize = 0; /* reinits on demand */
10287 PL_screamfirst = NULL;
10288 PL_screamnext = NULL;
10289 PL_maxscream = -1; /* reinits on demand */
10290 PL_lastscream = Nullsv;
10292 PL_watchaddr = NULL;
10293 PL_watchok = Nullch;
10295 PL_regdummy = proto_perl->Tregdummy;
10296 PL_regcomp_parse = Nullch;
10297 PL_regxend = Nullch;
10298 PL_regcode = (regnode*)NULL;
10301 PL_regprecomp = Nullch;
10306 PL_seen_zerolen = 0;
10308 PL_regcomp_rx = (regexp*)NULL;
10310 PL_colorset = 0; /* reinits PL_colors[] */
10311 /*PL_colors[6] = {0,0,0,0,0,0};*/
10312 PL_reg_whilem_seen = 0;
10313 PL_reginput = Nullch;
10314 PL_regbol = Nullch;
10315 PL_regeol = Nullch;
10316 PL_regstartp = (I32*)NULL;
10317 PL_regendp = (I32*)NULL;
10318 PL_reglastparen = (U32*)NULL;
10319 PL_regtill = Nullch;
10320 PL_reg_start_tmp = (char**)NULL;
10321 PL_reg_start_tmpl = 0;
10322 PL_regdata = (struct reg_data*)NULL;
10325 PL_reg_eval_set = 0;
10327 PL_regprogram = (regnode*)NULL;
10329 PL_regcc = (CURCUR*)NULL;
10330 PL_reg_call_cc = (struct re_cc_state*)NULL;
10331 PL_reg_re = (regexp*)NULL;
10332 PL_reg_ganch = Nullch;
10333 PL_reg_sv = Nullsv;
10334 PL_reg_match_utf8 = FALSE;
10335 PL_reg_magic = (MAGIC*)NULL;
10337 PL_reg_oldcurpm = (PMOP*)NULL;
10338 PL_reg_curpm = (PMOP*)NULL;
10339 PL_reg_oldsaved = Nullch;
10340 PL_reg_oldsavedlen = 0;
10341 PL_reg_maxiter = 0;
10342 PL_reg_leftiter = 0;
10343 PL_reg_poscache = Nullch;
10344 PL_reg_poscache_size= 0;
10346 /* RE engine - function pointers */
10347 PL_regcompp = proto_perl->Tregcompp;
10348 PL_regexecp = proto_perl->Tregexecp;
10349 PL_regint_start = proto_perl->Tregint_start;
10350 PL_regint_string = proto_perl->Tregint_string;
10351 PL_regfree = proto_perl->Tregfree;
10353 PL_reginterp_cnt = 0;
10354 PL_reg_starttry = 0;
10356 /* Pluggable optimizer */
10357 PL_peepp = proto_perl->Tpeepp;
10359 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10360 ptr_table_free(PL_ptr_table);
10361 PL_ptr_table = NULL;
10364 /* Call the ->CLONE method, if it exists, for each of the stashes
10365 identified by sv_dup() above.
10367 while(av_len(param->stashes) != -1) {
10368 HV* stash = (HV*) av_shift(param->stashes);
10369 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10370 if (cloner && GvCV(cloner)) {
10375 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
10377 call_sv((SV*)GvCV(cloner), G_DISCARD);
10383 SvREFCNT_dec(param->stashes);
10389 #endif /* USE_ITHREADS */
10392 =head1 Unicode Support
10394 =for apidoc sv_recode_to_utf8
10396 The encoding is assumed to be an Encode object, on entry the PV
10397 of the sv is assumed to be octets in that encoding, and the sv
10398 will be converted into Unicode (and UTF-8).
10400 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10401 is not a reference, nothing is done to the sv. If the encoding is not
10402 an C<Encode::XS> Encoding object, bad things will happen.
10403 (See F<lib/encoding.pm> and L<Encode>).
10405 The PV of the sv is returned.
10410 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10412 if (SvPOK(sv) && !DO_UTF8(sv) && SvROK(encoding)) {
10423 XPUSHs(&PL_sv_yes);
10425 call_method("decode", G_SCALAR);
10429 s = SvPV(uni, len);
10430 if (s != SvPVX(sv)) {
10432 Move(s, SvPVX(sv), len, char);
10433 SvCUR_set(sv, len);