3 * Copyright (c) 1991-2002, Larry Wall
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
8 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
11 * This file contains the code that creates, manipulates and destroys
12 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
13 * structure of an SV, so their creation and destruction is handled
14 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
15 * level functions (eg. substr, split, join) for each of the types are
26 #ifdef PERL_COPY_ON_WRITE
27 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
28 #define SV_COW_NEXT_SV_SET(current,next) SvUVX(current) = PTR2UV(next)
29 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
33 /* ============================================================================
35 =head1 Allocation and deallocation of SVs.
37 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
38 av, hv...) contains type and reference count information, as well as a
39 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
40 specific to each type.
42 Normally, this allocation is done using arenas, which are approximately
43 1K chunks of memory parcelled up into N heads or bodies. The first slot
44 in each arena is reserved, and is used to hold a link to the next arena.
45 In the case of heads, the unused first slot also contains some flags and
46 a note of the number of slots. Snaked through each arena chain is a
47 linked list of free items; when this becomes empty, an extra arena is
48 allocated and divided up into N items which are threaded into the free
51 The following global variables are associated with arenas:
53 PL_sv_arenaroot pointer to list of SV arenas
54 PL_sv_root pointer to list of free SV structures
56 PL_foo_arenaroot pointer to list of foo arenas,
57 PL_foo_root pointer to list of free foo bodies
58 ... for foo in xiv, xnv, xrv, xpv etc.
60 Note that some of the larger and more rarely used body types (eg xpvio)
61 are not allocated using arenas, but are instead just malloc()/free()ed as
62 required. Also, if PURIFY is defined, arenas are abandoned altogether,
63 with all items individually malloc()ed. In addition, a few SV heads are
64 not allocated from an arena, but are instead directly created as static
65 or auto variables, eg PL_sv_undef.
67 The SV arena serves the secondary purpose of allowing still-live SVs
68 to be located and destroyed during final cleanup.
70 At the lowest level, the macros new_SV() and del_SV() grab and free
71 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
72 to return the SV to the free list with error checking.) new_SV() calls
73 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
74 SVs in the free list have their SvTYPE field set to all ones.
76 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
77 that allocate and return individual body types. Normally these are mapped
78 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
79 instead mapped directly to malloc()/free() if PURIFY is defined. The
80 new/del functions remove from, or add to, the appropriate PL_foo_root
81 list, and call more_xiv() etc to add a new arena if the list is empty.
83 At the time of very final cleanup, sv_free_arenas() is called from
84 perl_destruct() to physically free all the arenas allocated since the
85 start of the interpreter. Note that this also clears PL_he_arenaroot,
86 which is otherwise dealt with in hv.c.
88 Manipulation of any of the PL_*root pointers is protected by enclosing
89 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
90 if threads are enabled.
92 The function visit() scans the SV arenas list, and calls a specified
93 function for each SV it finds which is still live - ie which has an SvTYPE
94 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
95 following functions (specified as [function that calls visit()] / [function
96 called by visit() for each SV]):
98 sv_report_used() / do_report_used()
99 dump all remaining SVs (debugging aid)
101 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
102 Attempt to free all objects pointed to by RVs,
103 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
104 try to do the same for all objects indirectly
105 referenced by typeglobs too. Called once from
106 perl_destruct(), prior to calling sv_clean_all()
109 sv_clean_all() / do_clean_all()
110 SvREFCNT_dec(sv) each remaining SV, possibly
111 triggering an sv_free(). It also sets the
112 SVf_BREAK flag on the SV to indicate that the
113 refcnt has been artificially lowered, and thus
114 stopping sv_free() from giving spurious warnings
115 about SVs which unexpectedly have a refcnt
116 of zero. called repeatedly from perl_destruct()
117 until there are no SVs left.
121 Private API to rest of sv.c
125 new_XIV(), del_XIV(),
126 new_XNV(), del_XNV(),
131 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
136 ============================================================================ */
141 * "A time to plant, and a time to uproot what was planted..."
144 #define plant_SV(p) \
146 SvANY(p) = (void *)PL_sv_root; \
147 SvFLAGS(p) = SVTYPEMASK; \
152 /* sv_mutex must be held while calling uproot_SV() */
153 #define uproot_SV(p) \
156 PL_sv_root = (SV*)SvANY(p); \
161 /* new_SV(): return a new, empty SV head */
163 #ifdef DEBUG_LEAKING_SCALARS
164 /* provide a real function for a debugger to play with */
181 # define new_SV(p) (p)=S_new_SV(aTHX)
199 /* del_SV(): return an empty SV head to the free list */
214 S_del_sv(pTHX_ SV *p)
221 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
223 svend = &sva[SvREFCNT(sva)];
224 if (p >= sv && p < svend)
228 if (ckWARN_d(WARN_INTERNAL))
229 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
230 "Attempt to free non-arena SV: 0x%"UVxf,
238 #else /* ! DEBUGGING */
240 #define del_SV(p) plant_SV(p)
242 #endif /* DEBUGGING */
246 =head1 SV Manipulation Functions
248 =for apidoc sv_add_arena
250 Given a chunk of memory, link it to the head of the list of arenas,
251 and split it into a list of free SVs.
257 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
262 Zero(ptr, size, char);
264 /* The first SV in an arena isn't an SV. */
265 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
266 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
267 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
269 PL_sv_arenaroot = sva;
270 PL_sv_root = sva + 1;
272 svend = &sva[SvREFCNT(sva) - 1];
275 SvANY(sv) = (void *)(SV*)(sv + 1);
276 SvFLAGS(sv) = SVTYPEMASK;
280 SvFLAGS(sv) = SVTYPEMASK;
283 /* make some more SVs by adding another arena */
285 /* sv_mutex must be held while calling more_sv() */
292 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
293 PL_nice_chunk = Nullch;
294 PL_nice_chunk_size = 0;
297 char *chunk; /* must use New here to match call to */
298 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
299 sv_add_arena(chunk, 1008, 0);
305 /* visit(): call the named function for each non-free SV in the arenas. */
308 S_visit(pTHX_ SVFUNC_t f)
315 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
316 svend = &sva[SvREFCNT(sva)];
317 for (sv = sva + 1; sv < svend; ++sv) {
318 if (SvTYPE(sv) != SVTYPEMASK && SvREFCNT(sv)) {
329 /* called by sv_report_used() for each live SV */
332 do_report_used(pTHX_ SV *sv)
334 if (SvTYPE(sv) != SVTYPEMASK) {
335 PerlIO_printf(Perl_debug_log, "****\n");
342 =for apidoc sv_report_used
344 Dump the contents of all SVs not yet freed. (Debugging aid).
350 Perl_sv_report_used(pTHX)
353 visit(do_report_used);
357 /* called by sv_clean_objs() for each live SV */
360 do_clean_objs(pTHX_ SV *sv)
364 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
365 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
377 /* XXX Might want to check arrays, etc. */
380 /* called by sv_clean_objs() for each live SV */
382 #ifndef DISABLE_DESTRUCTOR_KLUDGE
384 do_clean_named_objs(pTHX_ SV *sv)
386 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
387 if ( SvOBJECT(GvSV(sv)) ||
388 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
389 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
390 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
391 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
393 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
401 =for apidoc sv_clean_objs
403 Attempt to destroy all objects not yet freed
409 Perl_sv_clean_objs(pTHX)
411 PL_in_clean_objs = TRUE;
412 visit(do_clean_objs);
413 #ifndef DISABLE_DESTRUCTOR_KLUDGE
414 /* some barnacles may yet remain, clinging to typeglobs */
415 visit(do_clean_named_objs);
417 PL_in_clean_objs = FALSE;
420 /* called by sv_clean_all() for each live SV */
423 do_clean_all(pTHX_ SV *sv)
425 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
426 SvFLAGS(sv) |= SVf_BREAK;
431 =for apidoc sv_clean_all
433 Decrement the refcnt of each remaining SV, possibly triggering a
434 cleanup. This function may have to be called multiple times to free
435 SVs which are in complex self-referential hierarchies.
441 Perl_sv_clean_all(pTHX)
444 PL_in_clean_all = TRUE;
445 cleaned = visit(do_clean_all);
446 PL_in_clean_all = FALSE;
451 =for apidoc sv_free_arenas
453 Deallocate the memory used by all arenas. Note that all the individual SV
454 heads and bodies within the arenas must already have been freed.
460 Perl_sv_free_arenas(pTHX)
464 XPV *arena, *arenanext;
466 /* Free arenas here, but be careful about fake ones. (We assume
467 contiguity of the fake ones with the corresponding real ones.) */
469 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
470 svanext = (SV*) SvANY(sva);
471 while (svanext && SvFAKE(svanext))
472 svanext = (SV*) SvANY(svanext);
475 Safefree((void *)sva);
478 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
479 arenanext = (XPV*)arena->xpv_pv;
482 PL_xiv_arenaroot = 0;
484 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
485 arenanext = (XPV*)arena->xpv_pv;
488 PL_xnv_arenaroot = 0;
490 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
491 arenanext = (XPV*)arena->xpv_pv;
494 PL_xrv_arenaroot = 0;
496 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
497 arenanext = (XPV*)arena->xpv_pv;
500 PL_xpv_arenaroot = 0;
502 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
503 arenanext = (XPV*)arena->xpv_pv;
506 PL_xpviv_arenaroot = 0;
508 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
509 arenanext = (XPV*)arena->xpv_pv;
512 PL_xpvnv_arenaroot = 0;
514 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
515 arenanext = (XPV*)arena->xpv_pv;
518 PL_xpvcv_arenaroot = 0;
520 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
521 arenanext = (XPV*)arena->xpv_pv;
524 PL_xpvav_arenaroot = 0;
526 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
527 arenanext = (XPV*)arena->xpv_pv;
530 PL_xpvhv_arenaroot = 0;
532 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
533 arenanext = (XPV*)arena->xpv_pv;
536 PL_xpvmg_arenaroot = 0;
538 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
539 arenanext = (XPV*)arena->xpv_pv;
542 PL_xpvlv_arenaroot = 0;
544 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
545 arenanext = (XPV*)arena->xpv_pv;
548 PL_xpvbm_arenaroot = 0;
550 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
551 arenanext = (XPV*)arena->xpv_pv;
557 Safefree(PL_nice_chunk);
558 PL_nice_chunk = Nullch;
559 PL_nice_chunk_size = 0;
565 =for apidoc report_uninit
567 Print appropriate "Use of uninitialized variable" warning
573 Perl_report_uninit(pTHX)
576 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
577 " in ", OP_DESC(PL_op));
579 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit, "", "");
582 /* grab a new IV body from the free list, allocating more if necessary */
593 * See comment in more_xiv() -- RAM.
595 PL_xiv_root = *(IV**)xiv;
597 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
600 /* return an IV body to the free list */
603 S_del_xiv(pTHX_ XPVIV *p)
605 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
607 *(IV**)xiv = PL_xiv_root;
612 /* allocate another arena's worth of IV bodies */
620 New(705, ptr, 1008/sizeof(XPV), XPV);
621 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
622 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
625 xivend = &xiv[1008 / sizeof(IV) - 1];
626 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
628 while (xiv < xivend) {
629 *(IV**)xiv = (IV *)(xiv + 1);
635 /* grab a new NV body from the free list, allocating more if necessary */
645 PL_xnv_root = *(NV**)xnv;
647 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
650 /* return an NV body to the free list */
653 S_del_xnv(pTHX_ XPVNV *p)
655 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
657 *(NV**)xnv = PL_xnv_root;
662 /* allocate another arena's worth of NV bodies */
670 New(711, ptr, 1008/sizeof(XPV), XPV);
671 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
672 PL_xnv_arenaroot = ptr;
675 xnvend = &xnv[1008 / sizeof(NV) - 1];
676 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
678 while (xnv < xnvend) {
679 *(NV**)xnv = (NV*)(xnv + 1);
685 /* grab a new struct xrv from the free list, allocating more if necessary */
695 PL_xrv_root = (XRV*)xrv->xrv_rv;
700 /* return a struct xrv to the free list */
703 S_del_xrv(pTHX_ XRV *p)
706 p->xrv_rv = (SV*)PL_xrv_root;
711 /* allocate another arena's worth of struct xrv */
717 register XRV* xrvend;
719 New(712, ptr, 1008/sizeof(XPV), XPV);
720 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
721 PL_xrv_arenaroot = ptr;
724 xrvend = &xrv[1008 / sizeof(XRV) - 1];
725 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
727 while (xrv < xrvend) {
728 xrv->xrv_rv = (SV*)(xrv + 1);
734 /* grab a new struct xpv from the free list, allocating more if necessary */
744 PL_xpv_root = (XPV*)xpv->xpv_pv;
749 /* return a struct xpv to the free list */
752 S_del_xpv(pTHX_ XPV *p)
755 p->xpv_pv = (char*)PL_xpv_root;
760 /* allocate another arena's worth of struct xpv */
766 register XPV* xpvend;
767 New(713, xpv, 1008/sizeof(XPV), XPV);
768 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
769 PL_xpv_arenaroot = xpv;
771 xpvend = &xpv[1008 / sizeof(XPV) - 1];
773 while (xpv < xpvend) {
774 xpv->xpv_pv = (char*)(xpv + 1);
780 /* grab a new struct xpviv from the free list, allocating more if necessary */
789 xpviv = PL_xpviv_root;
790 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
795 /* return a struct xpviv to the free list */
798 S_del_xpviv(pTHX_ XPVIV *p)
801 p->xpv_pv = (char*)PL_xpviv_root;
806 /* allocate another arena's worth of struct xpviv */
811 register XPVIV* xpviv;
812 register XPVIV* xpvivend;
813 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
814 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
815 PL_xpviv_arenaroot = xpviv;
817 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
818 PL_xpviv_root = ++xpviv;
819 while (xpviv < xpvivend) {
820 xpviv->xpv_pv = (char*)(xpviv + 1);
826 /* grab a new struct xpvnv from the free list, allocating more if necessary */
835 xpvnv = PL_xpvnv_root;
836 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
841 /* return a struct xpvnv to the free list */
844 S_del_xpvnv(pTHX_ XPVNV *p)
847 p->xpv_pv = (char*)PL_xpvnv_root;
852 /* allocate another arena's worth of struct xpvnv */
857 register XPVNV* xpvnv;
858 register XPVNV* xpvnvend;
859 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
860 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
861 PL_xpvnv_arenaroot = xpvnv;
863 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
864 PL_xpvnv_root = ++xpvnv;
865 while (xpvnv < xpvnvend) {
866 xpvnv->xpv_pv = (char*)(xpvnv + 1);
872 /* grab a new struct xpvcv from the free list, allocating more if necessary */
881 xpvcv = PL_xpvcv_root;
882 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
887 /* return a struct xpvcv to the free list */
890 S_del_xpvcv(pTHX_ XPVCV *p)
893 p->xpv_pv = (char*)PL_xpvcv_root;
898 /* allocate another arena's worth of struct xpvcv */
903 register XPVCV* xpvcv;
904 register XPVCV* xpvcvend;
905 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
906 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
907 PL_xpvcv_arenaroot = xpvcv;
909 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
910 PL_xpvcv_root = ++xpvcv;
911 while (xpvcv < xpvcvend) {
912 xpvcv->xpv_pv = (char*)(xpvcv + 1);
918 /* grab a new struct xpvav from the free list, allocating more if necessary */
927 xpvav = PL_xpvav_root;
928 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
933 /* return a struct xpvav to the free list */
936 S_del_xpvav(pTHX_ XPVAV *p)
939 p->xav_array = (char*)PL_xpvav_root;
944 /* allocate another arena's worth of struct xpvav */
949 register XPVAV* xpvav;
950 register XPVAV* xpvavend;
951 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
952 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
953 PL_xpvav_arenaroot = xpvav;
955 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
956 PL_xpvav_root = ++xpvav;
957 while (xpvav < xpvavend) {
958 xpvav->xav_array = (char*)(xpvav + 1);
961 xpvav->xav_array = 0;
964 /* grab a new struct xpvhv from the free list, allocating more if necessary */
973 xpvhv = PL_xpvhv_root;
974 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
979 /* return a struct xpvhv to the free list */
982 S_del_xpvhv(pTHX_ XPVHV *p)
985 p->xhv_array = (char*)PL_xpvhv_root;
990 /* allocate another arena's worth of struct xpvhv */
995 register XPVHV* xpvhv;
996 register XPVHV* xpvhvend;
997 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
998 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
999 PL_xpvhv_arenaroot = xpvhv;
1001 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
1002 PL_xpvhv_root = ++xpvhv;
1003 while (xpvhv < xpvhvend) {
1004 xpvhv->xhv_array = (char*)(xpvhv + 1);
1007 xpvhv->xhv_array = 0;
1010 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1019 xpvmg = PL_xpvmg_root;
1020 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1025 /* return a struct xpvmg to the free list */
1028 S_del_xpvmg(pTHX_ XPVMG *p)
1031 p->xpv_pv = (char*)PL_xpvmg_root;
1036 /* allocate another arena's worth of struct xpvmg */
1041 register XPVMG* xpvmg;
1042 register XPVMG* xpvmgend;
1043 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1044 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1045 PL_xpvmg_arenaroot = xpvmg;
1047 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1048 PL_xpvmg_root = ++xpvmg;
1049 while (xpvmg < xpvmgend) {
1050 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1056 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1065 xpvlv = PL_xpvlv_root;
1066 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1071 /* return a struct xpvlv to the free list */
1074 S_del_xpvlv(pTHX_ XPVLV *p)
1077 p->xpv_pv = (char*)PL_xpvlv_root;
1082 /* allocate another arena's worth of struct xpvlv */
1087 register XPVLV* xpvlv;
1088 register XPVLV* xpvlvend;
1089 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1090 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1091 PL_xpvlv_arenaroot = xpvlv;
1093 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1094 PL_xpvlv_root = ++xpvlv;
1095 while (xpvlv < xpvlvend) {
1096 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1102 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1111 xpvbm = PL_xpvbm_root;
1112 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1117 /* return a struct xpvbm to the free list */
1120 S_del_xpvbm(pTHX_ XPVBM *p)
1123 p->xpv_pv = (char*)PL_xpvbm_root;
1128 /* allocate another arena's worth of struct xpvbm */
1133 register XPVBM* xpvbm;
1134 register XPVBM* xpvbmend;
1135 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1136 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1137 PL_xpvbm_arenaroot = xpvbm;
1139 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1140 PL_xpvbm_root = ++xpvbm;
1141 while (xpvbm < xpvbmend) {
1142 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1148 #define my_safemalloc(s) (void*)safemalloc(s)
1149 #define my_safefree(p) safefree((char*)p)
1153 #define new_XIV() my_safemalloc(sizeof(XPVIV))
1154 #define del_XIV(p) my_safefree(p)
1156 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1157 #define del_XNV(p) my_safefree(p)
1159 #define new_XRV() my_safemalloc(sizeof(XRV))
1160 #define del_XRV(p) my_safefree(p)
1162 #define new_XPV() my_safemalloc(sizeof(XPV))
1163 #define del_XPV(p) my_safefree(p)
1165 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1166 #define del_XPVIV(p) my_safefree(p)
1168 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1169 #define del_XPVNV(p) my_safefree(p)
1171 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1172 #define del_XPVCV(p) my_safefree(p)
1174 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1175 #define del_XPVAV(p) my_safefree(p)
1177 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1178 #define del_XPVHV(p) my_safefree(p)
1180 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1181 #define del_XPVMG(p) my_safefree(p)
1183 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1184 #define del_XPVLV(p) my_safefree(p)
1186 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1187 #define del_XPVBM(p) my_safefree(p)
1191 #define new_XIV() (void*)new_xiv()
1192 #define del_XIV(p) del_xiv((XPVIV*) p)
1194 #define new_XNV() (void*)new_xnv()
1195 #define del_XNV(p) del_xnv((XPVNV*) p)
1197 #define new_XRV() (void*)new_xrv()
1198 #define del_XRV(p) del_xrv((XRV*) p)
1200 #define new_XPV() (void*)new_xpv()
1201 #define del_XPV(p) del_xpv((XPV *)p)
1203 #define new_XPVIV() (void*)new_xpviv()
1204 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1206 #define new_XPVNV() (void*)new_xpvnv()
1207 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1209 #define new_XPVCV() (void*)new_xpvcv()
1210 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1212 #define new_XPVAV() (void*)new_xpvav()
1213 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1215 #define new_XPVHV() (void*)new_xpvhv()
1216 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1218 #define new_XPVMG() (void*)new_xpvmg()
1219 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1221 #define new_XPVLV() (void*)new_xpvlv()
1222 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1224 #define new_XPVBM() (void*)new_xpvbm()
1225 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1229 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1230 #define del_XPVGV(p) my_safefree(p)
1232 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1233 #define del_XPVFM(p) my_safefree(p)
1235 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1236 #define del_XPVIO(p) my_safefree(p)
1239 =for apidoc sv_upgrade
1241 Upgrade an SV to a more complex form. Generally adds a new body type to the
1242 SV, then copies across as much information as possible from the old body.
1243 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1249 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1256 MAGIC* magic = NULL;
1259 if (mt != SVt_PV && SvIsCOW(sv)) {
1260 sv_force_normal_flags(sv, 0);
1263 if (SvTYPE(sv) == mt)
1267 (void)SvOOK_off(sv);
1269 switch (SvTYPE(sv)) {
1290 else if (mt < SVt_PVIV)
1307 pv = (char*)SvRV(sv);
1327 else if (mt == SVt_NV)
1338 del_XPVIV(SvANY(sv));
1348 del_XPVNV(SvANY(sv));
1356 magic = SvMAGIC(sv);
1357 stash = SvSTASH(sv);
1358 del_XPVMG(SvANY(sv));
1361 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1366 Perl_croak(aTHX_ "Can't upgrade to undef");
1368 SvANY(sv) = new_XIV();
1372 SvANY(sv) = new_XNV();
1376 SvANY(sv) = new_XRV();
1380 SvANY(sv) = new_XPV();
1386 SvANY(sv) = new_XPVIV();
1396 SvANY(sv) = new_XPVNV();
1404 SvANY(sv) = new_XPVMG();
1410 SvMAGIC(sv) = magic;
1411 SvSTASH(sv) = stash;
1414 SvANY(sv) = new_XPVLV();
1420 SvMAGIC(sv) = magic;
1421 SvSTASH(sv) = stash;
1428 SvANY(sv) = new_XPVAV();
1436 SvMAGIC(sv) = magic;
1437 SvSTASH(sv) = stash;
1443 SvANY(sv) = new_XPVHV();
1449 HvTOTALKEYS(sv) = 0;
1450 HvPLACEHOLDERS(sv) = 0;
1451 SvMAGIC(sv) = magic;
1452 SvSTASH(sv) = stash;
1459 SvANY(sv) = new_XPVCV();
1460 Zero(SvANY(sv), 1, XPVCV);
1466 SvMAGIC(sv) = magic;
1467 SvSTASH(sv) = stash;
1470 SvANY(sv) = new_XPVGV();
1476 SvMAGIC(sv) = magic;
1477 SvSTASH(sv) = stash;
1485 SvANY(sv) = new_XPVBM();
1491 SvMAGIC(sv) = magic;
1492 SvSTASH(sv) = stash;
1498 SvANY(sv) = new_XPVFM();
1499 Zero(SvANY(sv), 1, XPVFM);
1505 SvMAGIC(sv) = magic;
1506 SvSTASH(sv) = stash;
1509 SvANY(sv) = new_XPVIO();
1510 Zero(SvANY(sv), 1, XPVIO);
1516 SvMAGIC(sv) = magic;
1517 SvSTASH(sv) = stash;
1518 IoPAGE_LEN(sv) = 60;
1521 SvFLAGS(sv) &= ~SVTYPEMASK;
1527 =for apidoc sv_backoff
1529 Remove any string offset. You should normally use the C<SvOOK_off> macro
1536 Perl_sv_backoff(pTHX_ register SV *sv)
1540 char *s = SvPVX(sv);
1541 SvLEN(sv) += SvIVX(sv);
1542 SvPVX(sv) -= SvIVX(sv);
1544 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1546 SvFLAGS(sv) &= ~SVf_OOK;
1553 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1554 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1555 Use the C<SvGROW> wrapper instead.
1561 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1565 #ifdef HAS_64K_LIMIT
1566 if (newlen >= 0x10000) {
1567 PerlIO_printf(Perl_debug_log,
1568 "Allocation too large: %"UVxf"\n", (UV)newlen);
1571 #endif /* HAS_64K_LIMIT */
1574 if (SvTYPE(sv) < SVt_PV) {
1575 sv_upgrade(sv, SVt_PV);
1578 else if (SvOOK(sv)) { /* pv is offset? */
1581 if (newlen > SvLEN(sv))
1582 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1583 #ifdef HAS_64K_LIMIT
1584 if (newlen >= 0x10000)
1591 if (newlen > SvLEN(sv)) { /* need more room? */
1592 if (SvLEN(sv) && s) {
1594 STRLEN l = malloced_size((void*)SvPVX(sv));
1600 Renew(s,newlen,char);
1603 New(703, s, newlen, char);
1604 if (SvPVX(sv) && SvCUR(sv)) {
1605 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1609 SvLEN_set(sv, newlen);
1615 =for apidoc sv_setiv
1617 Copies an integer into the given SV, upgrading first if necessary.
1618 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1624 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1626 SV_CHECK_THINKFIRST_COW_DROP(sv);
1627 switch (SvTYPE(sv)) {
1629 sv_upgrade(sv, SVt_IV);
1632 sv_upgrade(sv, SVt_PVNV);
1636 sv_upgrade(sv, SVt_PVIV);
1645 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1648 (void)SvIOK_only(sv); /* validate number */
1654 =for apidoc sv_setiv_mg
1656 Like C<sv_setiv>, but also handles 'set' magic.
1662 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1669 =for apidoc sv_setuv
1671 Copies an unsigned integer into the given SV, upgrading first if necessary.
1672 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1678 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1680 /* With these two if statements:
1681 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1684 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1686 If you wish to remove them, please benchmark to see what the effect is
1688 if (u <= (UV)IV_MAX) {
1689 sv_setiv(sv, (IV)u);
1698 =for apidoc sv_setuv_mg
1700 Like C<sv_setuv>, but also handles 'set' magic.
1706 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1708 /* With these two if statements:
1709 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1712 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1714 If you wish to remove them, please benchmark to see what the effect is
1716 if (u <= (UV)IV_MAX) {
1717 sv_setiv(sv, (IV)u);
1727 =for apidoc sv_setnv
1729 Copies a double into the given SV, upgrading first if necessary.
1730 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1736 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1738 SV_CHECK_THINKFIRST_COW_DROP(sv);
1739 switch (SvTYPE(sv)) {
1742 sv_upgrade(sv, SVt_NV);
1747 sv_upgrade(sv, SVt_PVNV);
1756 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1760 (void)SvNOK_only(sv); /* validate number */
1765 =for apidoc sv_setnv_mg
1767 Like C<sv_setnv>, but also handles 'set' magic.
1773 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1779 /* Print an "isn't numeric" warning, using a cleaned-up,
1780 * printable version of the offending string
1784 S_not_a_number(pTHX_ SV *sv)
1791 dsv = sv_2mortal(newSVpv("", 0));
1792 pv = sv_uni_display(dsv, sv, 10, 0);
1795 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1796 /* each *s can expand to 4 chars + "...\0",
1797 i.e. need room for 8 chars */
1800 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
1802 if (ch & 128 && !isPRINT_LC(ch)) {
1811 else if (ch == '\r') {
1815 else if (ch == '\f') {
1819 else if (ch == '\\') {
1823 else if (ch == '\0') {
1827 else if (isPRINT_LC(ch))
1844 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1845 "Argument \"%s\" isn't numeric in %s", pv,
1848 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1849 "Argument \"%s\" isn't numeric", pv);
1853 =for apidoc looks_like_number
1855 Test if the content of an SV looks like a number (or is a number).
1856 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1857 non-numeric warning), even if your atof() doesn't grok them.
1863 Perl_looks_like_number(pTHX_ SV *sv)
1865 register char *sbegin;
1872 else if (SvPOKp(sv))
1873 sbegin = SvPV(sv, len);
1875 return 1; /* Historic. Wrong? */
1876 return grok_number(sbegin, len, NULL);
1879 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1880 until proven guilty, assume that things are not that bad... */
1885 As 64 bit platforms often have an NV that doesn't preserve all bits of
1886 an IV (an assumption perl has been based on to date) it becomes necessary
1887 to remove the assumption that the NV always carries enough precision to
1888 recreate the IV whenever needed, and that the NV is the canonical form.
1889 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1890 precision as a side effect of conversion (which would lead to insanity
1891 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1892 1) to distinguish between IV/UV/NV slots that have cached a valid
1893 conversion where precision was lost and IV/UV/NV slots that have a
1894 valid conversion which has lost no precision
1895 2) to ensure that if a numeric conversion to one form is requested that
1896 would lose precision, the precise conversion (or differently
1897 imprecise conversion) is also performed and cached, to prevent
1898 requests for different numeric formats on the same SV causing
1899 lossy conversion chains. (lossless conversion chains are perfectly
1904 SvIOKp is true if the IV slot contains a valid value
1905 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1906 SvNOKp is true if the NV slot contains a valid value
1907 SvNOK is true only if the NV value is accurate
1910 while converting from PV to NV, check to see if converting that NV to an
1911 IV(or UV) would lose accuracy over a direct conversion from PV to
1912 IV(or UV). If it would, cache both conversions, return NV, but mark
1913 SV as IOK NOKp (ie not NOK).
1915 While converting from PV to IV, check to see if converting that IV to an
1916 NV would lose accuracy over a direct conversion from PV to NV. If it
1917 would, cache both conversions, flag similarly.
1919 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1920 correctly because if IV & NV were set NV *always* overruled.
1921 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1922 changes - now IV and NV together means that the two are interchangeable:
1923 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1925 The benefit of this is that operations such as pp_add know that if
1926 SvIOK is true for both left and right operands, then integer addition
1927 can be used instead of floating point (for cases where the result won't
1928 overflow). Before, floating point was always used, which could lead to
1929 loss of precision compared with integer addition.
1931 * making IV and NV equal status should make maths accurate on 64 bit
1933 * may speed up maths somewhat if pp_add and friends start to use
1934 integers when possible instead of fp. (Hopefully the overhead in
1935 looking for SvIOK and checking for overflow will not outweigh the
1936 fp to integer speedup)
1937 * will slow down integer operations (callers of SvIV) on "inaccurate"
1938 values, as the change from SvIOK to SvIOKp will cause a call into
1939 sv_2iv each time rather than a macro access direct to the IV slot
1940 * should speed up number->string conversion on integers as IV is
1941 favoured when IV and NV are equally accurate
1943 ####################################################################
1944 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1945 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1946 On the other hand, SvUOK is true iff UV.
1947 ####################################################################
1949 Your mileage will vary depending your CPU's relative fp to integer
1953 #ifndef NV_PRESERVES_UV
1954 # define IS_NUMBER_UNDERFLOW_IV 1
1955 # define IS_NUMBER_UNDERFLOW_UV 2
1956 # define IS_NUMBER_IV_AND_UV 2
1957 # define IS_NUMBER_OVERFLOW_IV 4
1958 # define IS_NUMBER_OVERFLOW_UV 5
1960 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1962 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1964 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1966 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));
1967 if (SvNVX(sv) < (NV)IV_MIN) {
1968 (void)SvIOKp_on(sv);
1971 return IS_NUMBER_UNDERFLOW_IV;
1973 if (SvNVX(sv) > (NV)UV_MAX) {
1974 (void)SvIOKp_on(sv);
1978 return IS_NUMBER_OVERFLOW_UV;
1980 (void)SvIOKp_on(sv);
1982 /* Can't use strtol etc to convert this string. (See truth table in
1984 if (SvNVX(sv) <= (UV)IV_MAX) {
1985 SvIVX(sv) = I_V(SvNVX(sv));
1986 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1987 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1989 /* Integer is imprecise. NOK, IOKp */
1991 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1994 SvUVX(sv) = U_V(SvNVX(sv));
1995 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1996 if (SvUVX(sv) == UV_MAX) {
1997 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1998 possibly be preserved by NV. Hence, it must be overflow.
2000 return IS_NUMBER_OVERFLOW_UV;
2002 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2004 /* Integer is imprecise. NOK, IOKp */
2006 return IS_NUMBER_OVERFLOW_IV;
2008 #endif /* !NV_PRESERVES_UV*/
2013 Return the integer value of an SV, doing any necessary string conversion,
2014 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2020 Perl_sv_2iv(pTHX_ register SV *sv)
2024 if (SvGMAGICAL(sv)) {
2029 return I_V(SvNVX(sv));
2031 if (SvPOKp(sv) && SvLEN(sv))
2034 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2035 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2041 if (SvTHINKFIRST(sv)) {
2044 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2045 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2046 return SvIV(tmpstr);
2047 return PTR2IV(SvRV(sv));
2050 sv_force_normal_flags(sv, 0);
2052 if (SvREADONLY(sv) && !SvOK(sv)) {
2053 if (ckWARN(WARN_UNINITIALIZED))
2060 return (IV)(SvUVX(sv));
2067 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2068 * without also getting a cached IV/UV from it at the same time
2069 * (ie PV->NV conversion should detect loss of accuracy and cache
2070 * IV or UV at same time to avoid this. NWC */
2072 if (SvTYPE(sv) == SVt_NV)
2073 sv_upgrade(sv, SVt_PVNV);
2075 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2076 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2077 certainly cast into the IV range at IV_MAX, whereas the correct
2078 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2080 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2081 SvIVX(sv) = I_V(SvNVX(sv));
2082 if (SvNVX(sv) == (NV) SvIVX(sv)
2083 #ifndef NV_PRESERVES_UV
2084 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2085 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2086 /* Don't flag it as "accurately an integer" if the number
2087 came from a (by definition imprecise) NV operation, and
2088 we're outside the range of NV integer precision */
2091 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2092 DEBUG_c(PerlIO_printf(Perl_debug_log,
2093 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2099 /* IV not precise. No need to convert from PV, as NV
2100 conversion would already have cached IV if it detected
2101 that PV->IV would be better than PV->NV->IV
2102 flags already correct - don't set public IOK. */
2103 DEBUG_c(PerlIO_printf(Perl_debug_log,
2104 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2109 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2110 but the cast (NV)IV_MIN rounds to a the value less (more
2111 negative) than IV_MIN which happens to be equal to SvNVX ??
2112 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2113 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2114 (NV)UVX == NVX are both true, but the values differ. :-(
2115 Hopefully for 2s complement IV_MIN is something like
2116 0x8000000000000000 which will be exact. NWC */
2119 SvUVX(sv) = U_V(SvNVX(sv));
2121 (SvNVX(sv) == (NV) SvUVX(sv))
2122 #ifndef NV_PRESERVES_UV
2123 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2124 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2125 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2126 /* Don't flag it as "accurately an integer" if the number
2127 came from a (by definition imprecise) NV operation, and
2128 we're outside the range of NV integer precision */
2134 DEBUG_c(PerlIO_printf(Perl_debug_log,
2135 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2139 return (IV)SvUVX(sv);
2142 else if (SvPOKp(sv) && SvLEN(sv)) {
2144 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2145 /* We want to avoid a possible problem when we cache an IV which
2146 may be later translated to an NV, and the resulting NV is not
2147 the same as the direct translation of the initial string
2148 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2149 be careful to ensure that the value with the .456 is around if the
2150 NV value is requested in the future).
2152 This means that if we cache such an IV, we need to cache the
2153 NV as well. Moreover, we trade speed for space, and do not
2154 cache the NV if we are sure it's not needed.
2157 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2158 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2159 == IS_NUMBER_IN_UV) {
2160 /* It's definitely an integer, only upgrade to PVIV */
2161 if (SvTYPE(sv) < SVt_PVIV)
2162 sv_upgrade(sv, SVt_PVIV);
2164 } else if (SvTYPE(sv) < SVt_PVNV)
2165 sv_upgrade(sv, SVt_PVNV);
2167 /* If NV preserves UV then we only use the UV value if we know that
2168 we aren't going to call atof() below. If NVs don't preserve UVs
2169 then the value returned may have more precision than atof() will
2170 return, even though value isn't perfectly accurate. */
2171 if ((numtype & (IS_NUMBER_IN_UV
2172 #ifdef NV_PRESERVES_UV
2175 )) == IS_NUMBER_IN_UV) {
2176 /* This won't turn off the public IOK flag if it was set above */
2177 (void)SvIOKp_on(sv);
2179 if (!(numtype & IS_NUMBER_NEG)) {
2181 if (value <= (UV)IV_MAX) {
2182 SvIVX(sv) = (IV)value;
2188 /* 2s complement assumption */
2189 if (value <= (UV)IV_MIN) {
2190 SvIVX(sv) = -(IV)value;
2192 /* Too negative for an IV. This is a double upgrade, but
2193 I'm assuming it will be rare. */
2194 if (SvTYPE(sv) < SVt_PVNV)
2195 sv_upgrade(sv, SVt_PVNV);
2199 SvNVX(sv) = -(NV)value;
2204 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2205 will be in the previous block to set the IV slot, and the next
2206 block to set the NV slot. So no else here. */
2208 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2209 != IS_NUMBER_IN_UV) {
2210 /* It wasn't an (integer that doesn't overflow the UV). */
2211 SvNVX(sv) = Atof(SvPVX(sv));
2213 if (! numtype && ckWARN(WARN_NUMERIC))
2216 #if defined(USE_LONG_DOUBLE)
2217 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2218 PTR2UV(sv), SvNVX(sv)));
2220 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2221 PTR2UV(sv), SvNVX(sv)));
2225 #ifdef NV_PRESERVES_UV
2226 (void)SvIOKp_on(sv);
2228 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2229 SvIVX(sv) = I_V(SvNVX(sv));
2230 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2233 /* Integer is imprecise. NOK, IOKp */
2235 /* UV will not work better than IV */
2237 if (SvNVX(sv) > (NV)UV_MAX) {
2239 /* Integer is inaccurate. NOK, IOKp, is UV */
2243 SvUVX(sv) = U_V(SvNVX(sv));
2244 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2245 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2249 /* Integer is imprecise. NOK, IOKp, is UV */
2255 #else /* NV_PRESERVES_UV */
2256 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2257 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2258 /* The IV slot will have been set from value returned by
2259 grok_number above. The NV slot has just been set using
2262 assert (SvIOKp(sv));
2264 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2265 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2266 /* Small enough to preserve all bits. */
2267 (void)SvIOKp_on(sv);
2269 SvIVX(sv) = I_V(SvNVX(sv));
2270 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2272 /* Assumption: first non-preserved integer is < IV_MAX,
2273 this NV is in the preserved range, therefore: */
2274 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2276 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);
2280 0 0 already failed to read UV.
2281 0 1 already failed to read UV.
2282 1 0 you won't get here in this case. IV/UV
2283 slot set, public IOK, Atof() unneeded.
2284 1 1 already read UV.
2285 so there's no point in sv_2iuv_non_preserve() attempting
2286 to use atol, strtol, strtoul etc. */
2287 if (sv_2iuv_non_preserve (sv, numtype)
2288 >= IS_NUMBER_OVERFLOW_IV)
2292 #endif /* NV_PRESERVES_UV */
2295 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2297 if (SvTYPE(sv) < SVt_IV)
2298 /* Typically the caller expects that sv_any is not NULL now. */
2299 sv_upgrade(sv, SVt_IV);
2302 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2303 PTR2UV(sv),SvIVX(sv)));
2304 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2310 Return the unsigned integer value of an SV, doing any necessary string
2311 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
2318 Perl_sv_2uv(pTHX_ register SV *sv)
2322 if (SvGMAGICAL(sv)) {
2327 return U_V(SvNVX(sv));
2328 if (SvPOKp(sv) && SvLEN(sv))
2331 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2332 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2338 if (SvTHINKFIRST(sv)) {
2341 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2342 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2343 return SvUV(tmpstr);
2344 return PTR2UV(SvRV(sv));
2347 sv_force_normal_flags(sv, 0);
2349 if (SvREADONLY(sv) && !SvOK(sv)) {
2350 if (ckWARN(WARN_UNINITIALIZED))
2360 return (UV)SvIVX(sv);
2364 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2365 * without also getting a cached IV/UV from it at the same time
2366 * (ie PV->NV conversion should detect loss of accuracy and cache
2367 * IV or UV at same time to avoid this. */
2368 /* IV-over-UV optimisation - choose to cache IV if possible */
2370 if (SvTYPE(sv) == SVt_NV)
2371 sv_upgrade(sv, SVt_PVNV);
2373 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2374 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2375 SvIVX(sv) = I_V(SvNVX(sv));
2376 if (SvNVX(sv) == (NV) SvIVX(sv)
2377 #ifndef NV_PRESERVES_UV
2378 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2379 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2380 /* Don't flag it as "accurately an integer" if the number
2381 came from a (by definition imprecise) NV operation, and
2382 we're outside the range of NV integer precision */
2385 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2386 DEBUG_c(PerlIO_printf(Perl_debug_log,
2387 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2393 /* IV not precise. No need to convert from PV, as NV
2394 conversion would already have cached IV if it detected
2395 that PV->IV would be better than PV->NV->IV
2396 flags already correct - don't set public IOK. */
2397 DEBUG_c(PerlIO_printf(Perl_debug_log,
2398 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2403 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2404 but the cast (NV)IV_MIN rounds to a the value less (more
2405 negative) than IV_MIN which happens to be equal to SvNVX ??
2406 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2407 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2408 (NV)UVX == NVX are both true, but the values differ. :-(
2409 Hopefully for 2s complement IV_MIN is something like
2410 0x8000000000000000 which will be exact. NWC */
2413 SvUVX(sv) = U_V(SvNVX(sv));
2415 (SvNVX(sv) == (NV) SvUVX(sv))
2416 #ifndef NV_PRESERVES_UV
2417 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2418 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2419 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2420 /* Don't flag it as "accurately an integer" if the number
2421 came from a (by definition imprecise) NV operation, and
2422 we're outside the range of NV integer precision */
2427 DEBUG_c(PerlIO_printf(Perl_debug_log,
2428 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2434 else if (SvPOKp(sv) && SvLEN(sv)) {
2436 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2438 /* We want to avoid a possible problem when we cache a UV which
2439 may be later translated to an NV, and the resulting NV is not
2440 the translation of the initial data.
2442 This means that if we cache such a UV, we need to cache the
2443 NV as well. Moreover, we trade speed for space, and do not
2444 cache the NV if not needed.
2447 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2448 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2449 == IS_NUMBER_IN_UV) {
2450 /* It's definitely an integer, only upgrade to PVIV */
2451 if (SvTYPE(sv) < SVt_PVIV)
2452 sv_upgrade(sv, SVt_PVIV);
2454 } else if (SvTYPE(sv) < SVt_PVNV)
2455 sv_upgrade(sv, SVt_PVNV);
2457 /* If NV preserves UV then we only use the UV value if we know that
2458 we aren't going to call atof() below. If NVs don't preserve UVs
2459 then the value returned may have more precision than atof() will
2460 return, even though it isn't accurate. */
2461 if ((numtype & (IS_NUMBER_IN_UV
2462 #ifdef NV_PRESERVES_UV
2465 )) == IS_NUMBER_IN_UV) {
2466 /* This won't turn off the public IOK flag if it was set above */
2467 (void)SvIOKp_on(sv);
2469 if (!(numtype & IS_NUMBER_NEG)) {
2471 if (value <= (UV)IV_MAX) {
2472 SvIVX(sv) = (IV)value;
2474 /* it didn't overflow, and it was positive. */
2479 /* 2s complement assumption */
2480 if (value <= (UV)IV_MIN) {
2481 SvIVX(sv) = -(IV)value;
2483 /* Too negative for an IV. This is a double upgrade, but
2484 I'm assuming it will be rare. */
2485 if (SvTYPE(sv) < SVt_PVNV)
2486 sv_upgrade(sv, SVt_PVNV);
2490 SvNVX(sv) = -(NV)value;
2496 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2497 != IS_NUMBER_IN_UV) {
2498 /* It wasn't an integer, or it overflowed the UV. */
2499 SvNVX(sv) = Atof(SvPVX(sv));
2501 if (! numtype && ckWARN(WARN_NUMERIC))
2504 #if defined(USE_LONG_DOUBLE)
2505 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2506 PTR2UV(sv), SvNVX(sv)));
2508 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2509 PTR2UV(sv), SvNVX(sv)));
2512 #ifdef NV_PRESERVES_UV
2513 (void)SvIOKp_on(sv);
2515 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2516 SvIVX(sv) = I_V(SvNVX(sv));
2517 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2520 /* Integer is imprecise. NOK, IOKp */
2522 /* UV will not work better than IV */
2524 if (SvNVX(sv) > (NV)UV_MAX) {
2526 /* Integer is inaccurate. NOK, IOKp, is UV */
2530 SvUVX(sv) = U_V(SvNVX(sv));
2531 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2532 NV preservse UV so can do correct comparison. */
2533 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2537 /* Integer is imprecise. NOK, IOKp, is UV */
2542 #else /* NV_PRESERVES_UV */
2543 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2544 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2545 /* The UV slot will have been set from value returned by
2546 grok_number above. The NV slot has just been set using
2549 assert (SvIOKp(sv));
2551 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2552 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2553 /* Small enough to preserve all bits. */
2554 (void)SvIOKp_on(sv);
2556 SvIVX(sv) = I_V(SvNVX(sv));
2557 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2559 /* Assumption: first non-preserved integer is < IV_MAX,
2560 this NV is in the preserved range, therefore: */
2561 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2563 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);
2566 sv_2iuv_non_preserve (sv, numtype);
2568 #endif /* NV_PRESERVES_UV */
2572 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2573 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2576 if (SvTYPE(sv) < SVt_IV)
2577 /* Typically the caller expects that sv_any is not NULL now. */
2578 sv_upgrade(sv, SVt_IV);
2582 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2583 PTR2UV(sv),SvUVX(sv)));
2584 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2590 Return the num value of an SV, doing any necessary string or integer
2591 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2598 Perl_sv_2nv(pTHX_ register SV *sv)
2602 if (SvGMAGICAL(sv)) {
2606 if (SvPOKp(sv) && SvLEN(sv)) {
2607 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2608 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
2610 return Atof(SvPVX(sv));
2614 return (NV)SvUVX(sv);
2616 return (NV)SvIVX(sv);
2619 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2620 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2626 if (SvTHINKFIRST(sv)) {
2629 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2630 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2631 return SvNV(tmpstr);
2632 return PTR2NV(SvRV(sv));
2635 sv_force_normal_flags(sv, 0);
2637 if (SvREADONLY(sv) && !SvOK(sv)) {
2638 if (ckWARN(WARN_UNINITIALIZED))
2643 if (SvTYPE(sv) < SVt_NV) {
2644 if (SvTYPE(sv) == SVt_IV)
2645 sv_upgrade(sv, SVt_PVNV);
2647 sv_upgrade(sv, SVt_NV);
2648 #ifdef USE_LONG_DOUBLE
2650 STORE_NUMERIC_LOCAL_SET_STANDARD();
2651 PerlIO_printf(Perl_debug_log,
2652 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2653 PTR2UV(sv), SvNVX(sv));
2654 RESTORE_NUMERIC_LOCAL();
2658 STORE_NUMERIC_LOCAL_SET_STANDARD();
2659 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2660 PTR2UV(sv), SvNVX(sv));
2661 RESTORE_NUMERIC_LOCAL();
2665 else if (SvTYPE(sv) < SVt_PVNV)
2666 sv_upgrade(sv, SVt_PVNV);
2671 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
2672 #ifdef NV_PRESERVES_UV
2675 /* Only set the public NV OK flag if this NV preserves the IV */
2676 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2677 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2678 : (SvIVX(sv) == I_V(SvNVX(sv))))
2684 else if (SvPOKp(sv) && SvLEN(sv)) {
2686 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2687 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2689 #ifdef NV_PRESERVES_UV
2690 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2691 == IS_NUMBER_IN_UV) {
2692 /* It's definitely an integer */
2693 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
2695 SvNVX(sv) = Atof(SvPVX(sv));
2698 SvNVX(sv) = Atof(SvPVX(sv));
2699 /* Only set the public NV OK flag if this NV preserves the value in
2700 the PV at least as well as an IV/UV would.
2701 Not sure how to do this 100% reliably. */
2702 /* if that shift count is out of range then Configure's test is
2703 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2705 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2706 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2707 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2708 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2709 /* Can't use strtol etc to convert this string, so don't try.
2710 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2713 /* value has been set. It may not be precise. */
2714 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2715 /* 2s complement assumption for (UV)IV_MIN */
2716 SvNOK_on(sv); /* Integer is too negative. */
2721 if (numtype & IS_NUMBER_NEG) {
2722 SvIVX(sv) = -(IV)value;
2723 } else if (value <= (UV)IV_MAX) {
2724 SvIVX(sv) = (IV)value;
2730 if (numtype & IS_NUMBER_NOT_INT) {
2731 /* I believe that even if the original PV had decimals,
2732 they are lost beyond the limit of the FP precision.
2733 However, neither is canonical, so both only get p
2734 flags. NWC, 2000/11/25 */
2735 /* Both already have p flags, so do nothing */
2738 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2739 if (SvIVX(sv) == I_V(nv)) {
2744 /* It had no "." so it must be integer. */
2747 /* between IV_MAX and NV(UV_MAX).
2748 Could be slightly > UV_MAX */
2750 if (numtype & IS_NUMBER_NOT_INT) {
2751 /* UV and NV both imprecise. */
2753 UV nv_as_uv = U_V(nv);
2755 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2766 #endif /* NV_PRESERVES_UV */
2769 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2771 if (SvTYPE(sv) < SVt_NV)
2772 /* Typically the caller expects that sv_any is not NULL now. */
2773 /* XXX Ilya implies that this is a bug in callers that assume this
2774 and ideally should be fixed. */
2775 sv_upgrade(sv, SVt_NV);
2778 #if defined(USE_LONG_DOUBLE)
2780 STORE_NUMERIC_LOCAL_SET_STANDARD();
2781 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2782 PTR2UV(sv), SvNVX(sv));
2783 RESTORE_NUMERIC_LOCAL();
2787 STORE_NUMERIC_LOCAL_SET_STANDARD();
2788 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2789 PTR2UV(sv), SvNVX(sv));
2790 RESTORE_NUMERIC_LOCAL();
2796 /* asIV(): extract an integer from the string value of an SV.
2797 * Caller must validate PVX */
2800 S_asIV(pTHX_ SV *sv)
2803 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2805 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2806 == IS_NUMBER_IN_UV) {
2807 /* It's definitely an integer */
2808 if (numtype & IS_NUMBER_NEG) {
2809 if (value < (UV)IV_MIN)
2812 if (value < (UV)IV_MAX)
2817 if (ckWARN(WARN_NUMERIC))
2820 return I_V(Atof(SvPVX(sv)));
2823 /* asUV(): extract an unsigned integer from the string value of an SV
2824 * Caller must validate PVX */
2827 S_asUV(pTHX_ SV *sv)
2830 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2832 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2833 == IS_NUMBER_IN_UV) {
2834 /* It's definitely an integer */
2835 if (!(numtype & IS_NUMBER_NEG))
2839 if (ckWARN(WARN_NUMERIC))
2842 return U_V(Atof(SvPVX(sv)));
2846 =for apidoc sv_2pv_nolen
2848 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2849 use the macro wrapper C<SvPV_nolen(sv)> instead.
2854 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2857 return sv_2pv(sv, &n_a);
2860 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2861 * UV as a string towards the end of buf, and return pointers to start and
2864 * We assume that buf is at least TYPE_CHARS(UV) long.
2868 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2870 char *ptr = buf + TYPE_CHARS(UV);
2884 *--ptr = '0' + (char)(uv % 10);
2893 =for apidoc sv_2pv_flags
2895 Returns a pointer to the string value of an SV, and sets *lp to its length.
2896 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2898 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2899 usually end up here too.
2905 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2910 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2911 char *tmpbuf = tbuf;
2917 if (SvGMAGICAL(sv)) {
2918 if (flags & SV_GMAGIC)
2926 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2928 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2933 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2938 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2939 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2946 if (SvTHINKFIRST(sv)) {
2949 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2950 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2951 char *pv = SvPV(tmpstr, *lp);
2965 switch (SvTYPE(sv)) {
2967 if ( ((SvFLAGS(sv) &
2968 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2969 == (SVs_OBJECT|SVs_RMG))
2970 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2971 regexp *re = (regexp *)mg->mg_obj;
2974 char *fptr = "msix";
2979 char need_newline = 0;
2980 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2982 while((ch = *fptr++)) {
2984 reflags[left++] = ch;
2987 reflags[right--] = ch;
2992 reflags[left] = '-';
2996 mg->mg_len = re->prelen + 4 + left;
2998 * If /x was used, we have to worry about a regex
2999 * ending with a comment later being embedded
3000 * within another regex. If so, we don't want this
3001 * regex's "commentization" to leak out to the
3002 * right part of the enclosing regex, we must cap
3003 * it with a newline.
3005 * So, if /x was used, we scan backwards from the
3006 * end of the regex. If we find a '#' before we
3007 * find a newline, we need to add a newline
3008 * ourself. If we find a '\n' first (or if we
3009 * don't find '#' or '\n'), we don't need to add
3010 * anything. -jfriedl
3012 if (PMf_EXTENDED & re->reganch)
3014 char *endptr = re->precomp + re->prelen;
3015 while (endptr >= re->precomp)
3017 char c = *(endptr--);
3019 break; /* don't need another */
3021 /* we end while in a comment, so we
3023 mg->mg_len++; /* save space for it */
3024 need_newline = 1; /* note to add it */
3030 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3031 Copy("(?", mg->mg_ptr, 2, char);
3032 Copy(reflags, mg->mg_ptr+2, left, char);
3033 Copy(":", mg->mg_ptr+left+2, 1, char);
3034 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3036 mg->mg_ptr[mg->mg_len - 2] = '\n';
3037 mg->mg_ptr[mg->mg_len - 1] = ')';
3038 mg->mg_ptr[mg->mg_len] = 0;
3040 PL_reginterp_cnt += re->program[0].next_off;
3042 if (re->reganch & ROPT_UTF8)
3057 case SVt_PVBM: if (SvROK(sv))
3060 s = "SCALAR"; break;
3061 case SVt_PVLV: s = "LVALUE"; break;
3062 case SVt_PVAV: s = "ARRAY"; break;
3063 case SVt_PVHV: s = "HASH"; break;
3064 case SVt_PVCV: s = "CODE"; break;
3065 case SVt_PVGV: s = "GLOB"; break;
3066 case SVt_PVFM: s = "FORMAT"; break;
3067 case SVt_PVIO: s = "IO"; break;
3068 default: s = "UNKNOWN"; break;
3072 Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
3075 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3081 if (SvREADONLY(sv) && !SvOK(sv)) {
3082 if (ckWARN(WARN_UNINITIALIZED))
3088 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3089 /* I'm assuming that if both IV and NV are equally valid then
3090 converting the IV is going to be more efficient */
3091 U32 isIOK = SvIOK(sv);
3092 U32 isUIOK = SvIsUV(sv);
3093 char buf[TYPE_CHARS(UV)];
3096 if (SvTYPE(sv) < SVt_PVIV)
3097 sv_upgrade(sv, SVt_PVIV);
3099 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3101 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3102 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3103 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3104 SvCUR_set(sv, ebuf - ptr);
3114 else if (SvNOKp(sv)) {
3115 if (SvTYPE(sv) < SVt_PVNV)
3116 sv_upgrade(sv, SVt_PVNV);
3117 /* The +20 is pure guesswork. Configure test needed. --jhi */
3118 SvGROW(sv, NV_DIG + 20);
3120 olderrno = errno; /* some Xenix systems wipe out errno here */
3122 if (SvNVX(sv) == 0.0)
3123 (void)strcpy(s,"0");
3127 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3130 #ifdef FIXNEGATIVEZERO
3131 if (*s == '-' && s[1] == '0' && !s[2])
3141 if (ckWARN(WARN_UNINITIALIZED)
3142 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3145 if (SvTYPE(sv) < SVt_PV)
3146 /* Typically the caller expects that sv_any is not NULL now. */
3147 sv_upgrade(sv, SVt_PV);
3150 *lp = s - SvPVX(sv);
3153 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3154 PTR2UV(sv),SvPVX(sv)));
3158 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3159 /* Sneaky stuff here */
3163 tsv = newSVpv(tmpbuf, 0);
3179 len = strlen(tmpbuf);
3181 #ifdef FIXNEGATIVEZERO
3182 if (len == 2 && t[0] == '-' && t[1] == '0') {
3187 (void)SvUPGRADE(sv, SVt_PV);
3189 s = SvGROW(sv, len + 1);
3198 =for apidoc sv_copypv
3200 Copies a stringified representation of the source SV into the
3201 destination SV. Automatically performs any necessary mg_get and
3202 coercion of numeric values into strings. Guaranteed to preserve
3203 UTF-8 flag even from overloaded objects. Similar in nature to
3204 sv_2pv[_flags] but operates directly on an SV instead of just the
3205 string. Mostly uses sv_2pv_flags to do its work, except when that
3206 would lose the UTF-8'ness of the PV.
3212 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3217 sv_setpvn(dsv,s,len);
3225 =for apidoc sv_2pvbyte_nolen
3227 Return a pointer to the byte-encoded representation of the SV.
3228 May cause the SV to be downgraded from UTF8 as a side-effect.
3230 Usually accessed via the C<SvPVbyte_nolen> macro.
3236 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3239 return sv_2pvbyte(sv, &n_a);
3243 =for apidoc sv_2pvbyte
3245 Return a pointer to the byte-encoded representation of the SV, and set *lp
3246 to its length. May cause the SV to be downgraded from UTF8 as a
3249 Usually accessed via the C<SvPVbyte> macro.
3255 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3257 sv_utf8_downgrade(sv,0);
3258 return SvPV(sv,*lp);
3262 =for apidoc sv_2pvutf8_nolen
3264 Return a pointer to the UTF8-encoded representation of the SV.
3265 May cause the SV to be upgraded to UTF8 as a side-effect.
3267 Usually accessed via the C<SvPVutf8_nolen> macro.
3273 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3276 return sv_2pvutf8(sv, &n_a);
3280 =for apidoc sv_2pvutf8
3282 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3283 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3285 Usually accessed via the C<SvPVutf8> macro.
3291 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3293 sv_utf8_upgrade(sv);
3294 return SvPV(sv,*lp);
3298 =for apidoc sv_2bool
3300 This function is only called on magical items, and is only used by
3301 sv_true() or its macro equivalent.
3307 Perl_sv_2bool(pTHX_ register SV *sv)
3316 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3317 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3318 return (bool)SvTRUE(tmpsv);
3319 return SvRV(sv) != 0;
3322 register XPV* Xpvtmp;
3323 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3324 (*Xpvtmp->xpv_pv > '0' ||
3325 Xpvtmp->xpv_cur > 1 ||
3326 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3333 return SvIVX(sv) != 0;
3336 return SvNVX(sv) != 0.0;
3344 =for apidoc sv_utf8_upgrade
3346 Convert the PV of an SV to its UTF8-encoded form.
3347 Forces the SV to string form if it is not already.
3348 Always sets the SvUTF8 flag to avoid future validity checks even
3349 if all the bytes have hibit clear.
3351 This is not as a general purpose byte encoding to Unicode interface:
3352 use the Encode extension for that.
3354 =for apidoc sv_utf8_upgrade_flags
3356 Convert the PV of an SV to its UTF8-encoded form.
3357 Forces the SV to string form if it is not already.
3358 Always sets the SvUTF8 flag to avoid future validity checks even
3359 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3360 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3361 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3363 This is not as a general purpose byte encoding to Unicode interface:
3364 use the Encode extension for that.
3370 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3380 (void) sv_2pv_flags(sv,&len, flags);
3389 sv_force_normal_flags(sv, 0);
3392 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3393 sv_recode_to_utf8(sv, PL_encoding);
3394 else { /* Assume Latin-1/EBCDIC */
3395 /* This function could be much more efficient if we
3396 * had a FLAG in SVs to signal if there are any hibit
3397 * chars in the PV. Given that there isn't such a flag
3398 * make the loop as fast as possible. */
3399 s = (U8 *) SvPVX(sv);
3400 e = (U8 *) SvEND(sv);
3404 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3410 len = SvCUR(sv) + 1; /* Plus the \0 */
3411 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3412 SvCUR(sv) = len - 1;
3414 Safefree(s); /* No longer using what was there before. */
3415 SvLEN(sv) = len; /* No longer know the real size. */
3417 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3424 =for apidoc sv_utf8_downgrade
3426 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3427 This may not be possible if the PV contains non-byte encoding characters;
3428 if this is the case, either returns false or, if C<fail_ok> is not
3431 This is not as a general purpose Unicode to byte encoding interface:
3432 use the Encode extension for that.
3438 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3440 if (SvPOK(sv) && SvUTF8(sv)) {
3446 sv_force_normal_flags(sv, 0);
3448 s = (U8 *) SvPV(sv, len);
3449 if (!utf8_to_bytes(s, &len)) {
3454 Perl_croak(aTHX_ "Wide character in %s",
3457 Perl_croak(aTHX_ "Wide character");
3468 =for apidoc sv_utf8_encode
3470 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3471 flag so that it looks like octets again. Used as a building block
3472 for encode_utf8 in Encode.xs
3478 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3480 (void) sv_utf8_upgrade(sv);
3485 =for apidoc sv_utf8_decode
3487 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3488 turn off SvUTF8 if needed so that we see characters. Used as a building block
3489 for decode_utf8 in Encode.xs
3495 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3501 /* The octets may have got themselves encoded - get them back as
3504 if (!sv_utf8_downgrade(sv, TRUE))
3507 /* it is actually just a matter of turning the utf8 flag on, but
3508 * we want to make sure everything inside is valid utf8 first.
3510 c = (U8 *) SvPVX(sv);
3511 if (!is_utf8_string(c, SvCUR(sv)+1))
3513 e = (U8 *) SvEND(sv);
3516 if (!UTF8_IS_INVARIANT(ch)) {
3526 =for apidoc sv_setsv
3528 Copies the contents of the source SV C<ssv> into the destination SV
3529 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3530 function if the source SV needs to be reused. Does not handle 'set' magic.
3531 Loosely speaking, it performs a copy-by-value, obliterating any previous
3532 content of the destination.
3534 You probably want to use one of the assortment of wrappers, such as
3535 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3536 C<SvSetMagicSV_nosteal>.
3538 =for apidoc sv_setsv_flags
3540 Copies the contents of the source SV C<ssv> into the destination SV
3541 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3542 function if the source SV needs to be reused. Does not handle 'set' magic.
3543 Loosely speaking, it performs a copy-by-value, obliterating any previous
3544 content of the destination.
3545 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3546 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3547 implemented in terms of this function.
3549 You probably want to use one of the assortment of wrappers, such as
3550 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3551 C<SvSetMagicSV_nosteal>.
3553 This is the primary function for copying scalars, and most other
3554 copy-ish functions and macros use this underneath.
3560 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3562 register U32 sflags;
3568 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3570 sstr = &PL_sv_undef;
3571 stype = SvTYPE(sstr);
3572 dtype = SvTYPE(dstr);
3577 /* need to nuke the magic */
3579 SvRMAGICAL_off(dstr);
3582 /* There's a lot of redundancy below but we're going for speed here */
3587 if (dtype != SVt_PVGV) {
3588 (void)SvOK_off(dstr);
3596 sv_upgrade(dstr, SVt_IV);
3599 sv_upgrade(dstr, SVt_PVNV);
3603 sv_upgrade(dstr, SVt_PVIV);
3606 (void)SvIOK_only(dstr);
3607 SvIVX(dstr) = SvIVX(sstr);
3610 if (SvTAINTED(sstr))
3621 sv_upgrade(dstr, SVt_NV);
3626 sv_upgrade(dstr, SVt_PVNV);
3629 SvNVX(dstr) = SvNVX(sstr);
3630 (void)SvNOK_only(dstr);
3631 if (SvTAINTED(sstr))
3639 sv_upgrade(dstr, SVt_RV);
3640 else if (dtype == SVt_PVGV &&
3641 SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3644 if (GvIMPORTED(dstr) != GVf_IMPORTED
3645 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3647 GvIMPORTED_on(dstr);
3658 sv_upgrade(dstr, SVt_PV);
3661 if (dtype < SVt_PVIV)
3662 sv_upgrade(dstr, SVt_PVIV);
3665 if (dtype < SVt_PVNV)
3666 sv_upgrade(dstr, SVt_PVNV);
3673 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
3676 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
3680 if (dtype <= SVt_PVGV) {
3682 if (dtype != SVt_PVGV) {
3683 char *name = GvNAME(sstr);
3684 STRLEN len = GvNAMELEN(sstr);
3685 sv_upgrade(dstr, SVt_PVGV);
3686 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3687 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3688 GvNAME(dstr) = savepvn(name, len);
3689 GvNAMELEN(dstr) = len;
3690 SvFAKE_on(dstr); /* can coerce to non-glob */
3692 /* ahem, death to those who redefine active sort subs */
3693 else if (PL_curstackinfo->si_type == PERLSI_SORT
3694 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3695 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3698 #ifdef GV_UNIQUE_CHECK
3699 if (GvUNIQUE((GV*)dstr)) {
3700 Perl_croak(aTHX_ PL_no_modify);
3704 (void)SvOK_off(dstr);
3705 GvINTRO_off(dstr); /* one-shot flag */
3707 GvGP(dstr) = gp_ref(GvGP(sstr));
3708 if (SvTAINTED(sstr))
3710 if (GvIMPORTED(dstr) != GVf_IMPORTED
3711 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3713 GvIMPORTED_on(dstr);
3721 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3723 if ((int)SvTYPE(sstr) != stype) {
3724 stype = SvTYPE(sstr);
3725 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3729 if (stype == SVt_PVLV)
3730 (void)SvUPGRADE(dstr, SVt_PVNV);
3732 (void)SvUPGRADE(dstr, (U32)stype);
3735 sflags = SvFLAGS(sstr);
3737 if (sflags & SVf_ROK) {
3738 if (dtype >= SVt_PV) {
3739 if (dtype == SVt_PVGV) {
3740 SV *sref = SvREFCNT_inc(SvRV(sstr));
3742 int intro = GvINTRO(dstr);
3744 #ifdef GV_UNIQUE_CHECK
3745 if (GvUNIQUE((GV*)dstr)) {
3746 Perl_croak(aTHX_ PL_no_modify);
3751 GvINTRO_off(dstr); /* one-shot flag */
3752 GvLINE(dstr) = CopLINE(PL_curcop);
3753 GvEGV(dstr) = (GV*)dstr;
3756 switch (SvTYPE(sref)) {
3759 SAVEGENERICSV(GvAV(dstr));
3761 dref = (SV*)GvAV(dstr);
3762 GvAV(dstr) = (AV*)sref;
3763 if (!GvIMPORTED_AV(dstr)
3764 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3766 GvIMPORTED_AV_on(dstr);
3771 SAVEGENERICSV(GvHV(dstr));
3773 dref = (SV*)GvHV(dstr);
3774 GvHV(dstr) = (HV*)sref;
3775 if (!GvIMPORTED_HV(dstr)
3776 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3778 GvIMPORTED_HV_on(dstr);
3783 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3784 SvREFCNT_dec(GvCV(dstr));
3785 GvCV(dstr) = Nullcv;
3786 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3787 PL_sub_generation++;
3789 SAVEGENERICSV(GvCV(dstr));
3792 dref = (SV*)GvCV(dstr);
3793 if (GvCV(dstr) != (CV*)sref) {
3794 CV* cv = GvCV(dstr);
3796 if (!GvCVGEN((GV*)dstr) &&
3797 (CvROOT(cv) || CvXSUB(cv)))
3799 /* ahem, death to those who redefine
3800 * active sort subs */
3801 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3802 PL_sortcop == CvSTART(cv))
3804 "Can't redefine active sort subroutine %s",
3805 GvENAME((GV*)dstr));
3806 /* Redefining a sub - warning is mandatory if
3807 it was a const and its value changed. */
3808 if (ckWARN(WARN_REDEFINE)
3810 && (!CvCONST((CV*)sref)
3811 || sv_cmp(cv_const_sv(cv),
3812 cv_const_sv((CV*)sref)))))
3814 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3816 ? "Constant subroutine %s::%s redefined"
3817 : "Subroutine %s::%s redefined",
3818 HvNAME(GvSTASH((GV*)dstr)),
3819 GvENAME((GV*)dstr));
3823 cv_ckproto(cv, (GV*)dstr,
3824 SvPOK(sref) ? SvPVX(sref) : Nullch);
3826 GvCV(dstr) = (CV*)sref;
3827 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3828 GvASSUMECV_on(dstr);
3829 PL_sub_generation++;
3831 if (!GvIMPORTED_CV(dstr)
3832 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3834 GvIMPORTED_CV_on(dstr);
3839 SAVEGENERICSV(GvIOp(dstr));
3841 dref = (SV*)GvIOp(dstr);
3842 GvIOp(dstr) = (IO*)sref;
3846 SAVEGENERICSV(GvFORM(dstr));
3848 dref = (SV*)GvFORM(dstr);
3849 GvFORM(dstr) = (CV*)sref;
3853 SAVEGENERICSV(GvSV(dstr));
3855 dref = (SV*)GvSV(dstr);
3857 if (!GvIMPORTED_SV(dstr)
3858 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3860 GvIMPORTED_SV_on(dstr);
3866 if (SvTAINTED(sstr))
3871 (void)SvOOK_off(dstr); /* backoff */
3873 Safefree(SvPVX(dstr));
3874 SvLEN(dstr)=SvCUR(dstr)=0;
3877 (void)SvOK_off(dstr);
3878 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
3880 if (sflags & SVp_NOK) {
3882 /* Only set the public OK flag if the source has public OK. */
3883 if (sflags & SVf_NOK)
3884 SvFLAGS(dstr) |= SVf_NOK;
3885 SvNVX(dstr) = SvNVX(sstr);
3887 if (sflags & SVp_IOK) {
3888 (void)SvIOKp_on(dstr);
3889 if (sflags & SVf_IOK)
3890 SvFLAGS(dstr) |= SVf_IOK;
3891 if (sflags & SVf_IVisUV)
3893 SvIVX(dstr) = SvIVX(sstr);
3895 if (SvAMAGIC(sstr)) {
3899 else if (sflags & SVp_POK) {
3903 * Check to see if we can just swipe the string. If so, it's a
3904 * possible small lose on short strings, but a big win on long ones.
3905 * It might even be a win on short strings if SvPVX(dstr)
3906 * has to be allocated and SvPVX(sstr) has to be freed.
3910 #ifdef PERL_COPY_ON_WRITE
3911 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3915 (sflags & SVs_TEMP) && /* slated for free anyway? */
3916 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3917 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3918 SvLEN(sstr) && /* and really is a string */
3919 /* and won't be needed again, potentially */
3920 !(PL_op && PL_op->op_type == OP_AASSIGN))
3921 #ifdef PERL_COPY_ON_WRITE
3922 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3923 && SvTYPE(sstr) >= SVt_PVIV)
3926 /* Failed the swipe test, and it's not a shared hash key either.
3927 Have to copy the string. */
3928 STRLEN len = SvCUR(sstr);
3929 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3930 Move(SvPVX(sstr),SvPVX(dstr),len,char);
3931 SvCUR_set(dstr, len);
3932 *SvEND(dstr) = '\0';
3933 (void)SvPOK_only(dstr);
3935 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
3937 #ifdef PERL_COPY_ON_WRITE
3938 /* Either it's a shared hash key, or it's suitable for
3939 copy-on-write or we can swipe the string. */
3941 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3946 /* I believe I should acquire a global SV mutex if
3947 it's a COW sv (not a shared hash key) to stop
3948 it going un copy-on-write.
3949 If the source SV has gone un copy on write between up there
3950 and down here, then (assert() that) it is of the correct
3951 form to make it copy on write again */
3952 if ((sflags & (SVf_FAKE | SVf_READONLY))
3953 != (SVf_FAKE | SVf_READONLY)) {
3954 SvREADONLY_on(sstr);
3956 /* Make the source SV into a loop of 1.
3957 (about to become 2) */
3958 SV_COW_NEXT_SV_SET(sstr, sstr);
3962 /* Initial code is common. */
3963 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
3965 SvFLAGS(dstr) &= ~SVf_OOK;
3966 Safefree(SvPVX(dstr) - SvIVX(dstr));
3968 else if (SvLEN(dstr))
3969 Safefree(SvPVX(dstr));
3971 (void)SvPOK_only(dstr);
3973 #ifdef PERL_COPY_ON_WRITE
3975 /* making another shared SV. */
3976 STRLEN cur = SvCUR(sstr);
3977 STRLEN len = SvLEN(sstr);
3979 /* SvIsCOW_normal */
3980 /* splice us in between source and next-after-source. */
3981 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3982 SV_COW_NEXT_SV_SET(sstr, dstr);
3983 SvPV_set(dstr, SvPVX(sstr));
3985 /* SvIsCOW_shared_hash */
3986 UV hash = SvUVX(sstr);
3987 DEBUG_C(PerlIO_printf(Perl_debug_log,
3988 "Copy on write: Sharing hash\n"));
3990 sharepvn(SvPVX(sstr),
3991 (sflags & SVf_UTF8?-cur:cur), hash));
3996 SvREADONLY_on(dstr);
3998 /* Relesase a global SV mutex. */
4002 { /* Passes the swipe test. */
4003 SvPV_set(dstr, SvPVX(sstr));
4004 SvLEN_set(dstr, SvLEN(sstr));
4005 SvCUR_set(dstr, SvCUR(sstr));
4008 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4009 SvPV_set(sstr, Nullch);
4015 if (sflags & SVf_UTF8)
4018 if (sflags & SVp_NOK) {
4020 if (sflags & SVf_NOK)
4021 SvFLAGS(dstr) |= SVf_NOK;
4022 SvNVX(dstr) = SvNVX(sstr);
4024 if (sflags & SVp_IOK) {
4025 (void)SvIOKp_on(dstr);
4026 if (sflags & SVf_IOK)
4027 SvFLAGS(dstr) |= SVf_IOK;
4028 if (sflags & SVf_IVisUV)
4030 SvIVX(dstr) = SvIVX(sstr);
4033 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4034 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4035 smg->mg_ptr, smg->mg_len);
4036 SvRMAGICAL_on(dstr);
4039 else if (sflags & SVp_IOK) {
4040 if (sflags & SVf_IOK)
4041 (void)SvIOK_only(dstr);
4043 (void)SvOK_off(dstr);
4044 (void)SvIOKp_on(dstr);
4046 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4047 if (sflags & SVf_IVisUV)
4049 SvIVX(dstr) = SvIVX(sstr);
4050 if (sflags & SVp_NOK) {
4051 if (sflags & SVf_NOK)
4052 (void)SvNOK_on(dstr);
4054 (void)SvNOKp_on(dstr);
4055 SvNVX(dstr) = SvNVX(sstr);
4058 else if (sflags & SVp_NOK) {
4059 if (sflags & SVf_NOK)
4060 (void)SvNOK_only(dstr);
4062 (void)SvOK_off(dstr);
4065 SvNVX(dstr) = SvNVX(sstr);
4068 if (dtype == SVt_PVGV) {
4069 if (ckWARN(WARN_MISC))
4070 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4073 (void)SvOK_off(dstr);
4075 if (SvTAINTED(sstr))
4080 =for apidoc sv_setsv_mg
4082 Like C<sv_setsv>, but also handles 'set' magic.
4088 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4090 sv_setsv(dstr,sstr);
4094 #ifdef PERL_COPY_ON_WRITE
4096 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4098 STRLEN cur = SvCUR(sstr);
4099 STRLEN len = SvLEN(sstr);
4100 register char *new_pv;
4103 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4111 if (SvTHINKFIRST(dstr))
4112 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4113 else if (SvPVX(dstr))
4114 Safefree(SvPVX(dstr));
4118 SvUPGRADE (dstr, SVt_PVIV);
4120 assert (SvPOK(sstr));
4121 assert (SvPOKp(sstr));
4122 assert (!SvIOK(sstr));
4123 assert (!SvIOKp(sstr));
4124 assert (!SvNOK(sstr));
4125 assert (!SvNOKp(sstr));
4127 if (SvIsCOW(sstr)) {
4129 if (SvLEN(sstr) == 0) {
4130 /* source is a COW shared hash key. */
4131 UV hash = SvUVX(sstr);
4132 DEBUG_C(PerlIO_printf(Perl_debug_log,
4133 "Fast copy on write: Sharing hash\n"));
4135 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4138 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4140 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4141 SvUPGRADE (sstr, SVt_PVIV);
4142 SvREADONLY_on(sstr);
4144 DEBUG_C(PerlIO_printf(Perl_debug_log,
4145 "Fast copy on write: Converting sstr to COW\n"));
4146 SV_COW_NEXT_SV_SET(dstr, sstr);
4148 SV_COW_NEXT_SV_SET(sstr, dstr);
4149 new_pv = SvPVX(sstr);
4152 SvPV_set(dstr, new_pv);
4153 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4166 =for apidoc sv_setpvn
4168 Copies a string into an SV. The C<len> parameter indicates the number of
4169 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4175 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4177 register char *dptr;
4179 SV_CHECK_THINKFIRST_COW_DROP(sv);
4185 /* len is STRLEN which is unsigned, need to copy to signed */
4188 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4190 (void)SvUPGRADE(sv, SVt_PV);
4192 SvGROW(sv, len + 1);
4194 Move(ptr,dptr,len,char);
4197 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4202 =for apidoc sv_setpvn_mg
4204 Like C<sv_setpvn>, but also handles 'set' magic.
4210 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4212 sv_setpvn(sv,ptr,len);
4217 =for apidoc sv_setpv
4219 Copies a string into an SV. The string must be null-terminated. Does not
4220 handle 'set' magic. See C<sv_setpv_mg>.
4226 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4228 register STRLEN len;
4230 SV_CHECK_THINKFIRST_COW_DROP(sv);
4236 (void)SvUPGRADE(sv, SVt_PV);
4238 SvGROW(sv, len + 1);
4239 Move(ptr,SvPVX(sv),len+1,char);
4241 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4246 =for apidoc sv_setpv_mg
4248 Like C<sv_setpv>, but also handles 'set' magic.
4254 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4261 =for apidoc sv_usepvn
4263 Tells an SV to use C<ptr> to find its string value. Normally the string is
4264 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4265 The C<ptr> should point to memory that was allocated by C<malloc>. The
4266 string length, C<len>, must be supplied. This function will realloc the
4267 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4268 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4269 See C<sv_usepvn_mg>.
4275 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4277 SV_CHECK_THINKFIRST_COW_DROP(sv);
4278 (void)SvUPGRADE(sv, SVt_PV);
4283 (void)SvOOK_off(sv);
4284 if (SvPVX(sv) && SvLEN(sv))
4285 Safefree(SvPVX(sv));
4286 Renew(ptr, len+1, char);
4289 SvLEN_set(sv, len+1);
4291 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4296 =for apidoc sv_usepvn_mg
4298 Like C<sv_usepvn>, but also handles 'set' magic.
4304 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4306 sv_usepvn(sv,ptr,len);
4310 #ifdef PERL_COPY_ON_WRITE
4311 /* Need to do this *after* making the SV normal, as we need the buffer
4312 pointer to remain valid until after we've copied it. If we let go too early,
4313 another thread could invalidate it by unsharing last of the same hash key
4314 (which it can do by means other than releasing copy-on-write Svs)
4315 or by changing the other copy-on-write SVs in the loop. */
4317 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4318 U32 hash, SV *after)
4320 if (len) { /* this SV was SvIsCOW_normal(sv) */
4321 /* we need to find the SV pointing to us. */
4322 SV *current = SV_COW_NEXT_SV(after);
4324 if (current == sv) {
4325 /* The SV we point to points back to us (there were only two of us
4327 Hence other SV is no longer copy on write either. */
4329 SvREADONLY_off(after);
4331 /* We need to follow the pointers around the loop. */
4333 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4336 /* don't loop forever if the structure is bust, and we have
4337 a pointer into a closed loop. */
4338 assert (current != after);
4339 assert (SvPVX(current) == pvx);
4341 /* Make the SV before us point to the SV after us. */
4342 SV_COW_NEXT_SV_SET(current, after);
4345 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4350 Perl_sv_release_IVX(pTHX_ register SV *sv)
4353 sv_force_normal_flags(sv, 0);
4354 return SvOOK_off(sv);
4358 =for apidoc sv_force_normal_flags
4360 Undo various types of fakery on an SV: if the PV is a shared string, make
4361 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4362 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4363 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4364 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4365 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4366 set to some other value.) In addition, the C<flags> parameter gets passed to
4367 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4368 with flags set to 0.
4374 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4376 #ifdef PERL_COPY_ON_WRITE
4377 if (SvREADONLY(sv)) {
4378 /* At this point I believe I should acquire a global SV mutex. */
4380 char *pvx = SvPVX(sv);
4381 STRLEN len = SvLEN(sv);
4382 STRLEN cur = SvCUR(sv);
4383 U32 hash = SvUVX(sv);
4384 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4386 PerlIO_printf(Perl_debug_log,
4387 "Copy on write: Force normal %ld\n",
4393 /* This SV doesn't own the buffer, so need to New() a new one: */
4396 if (flags & SV_COW_DROP_PV) {
4397 /* OK, so we don't need to copy our buffer. */
4400 SvGROW(sv, cur + 1);
4401 Move(pvx,SvPVX(sv),cur,char);
4405 sv_release_COW(sv, pvx, cur, len, hash, next);
4410 else if (PL_curcop != &PL_compiling)
4411 Perl_croak(aTHX_ PL_no_modify);
4412 /* At this point I believe that I can drop the global SV mutex. */
4415 if (SvREADONLY(sv)) {
4417 char *pvx = SvPVX(sv);
4418 STRLEN len = SvCUR(sv);
4419 U32 hash = SvUVX(sv);
4420 SvGROW(sv, len + 1);
4421 Move(pvx,SvPVX(sv),len,char);
4425 unsharepvn(pvx, SvUTF8(sv) ? -(I32)len : len, hash);
4427 else if (PL_curcop != &PL_compiling)
4428 Perl_croak(aTHX_ PL_no_modify);
4432 sv_unref_flags(sv, flags);
4433 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4438 =for apidoc sv_force_normal
4440 Undo various types of fakery on an SV: if the PV is a shared string, make
4441 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4442 an xpvmg. See also C<sv_force_normal_flags>.
4448 Perl_sv_force_normal(pTHX_ register SV *sv)
4450 sv_force_normal_flags(sv, 0);
4456 Efficient removal of characters from the beginning of the string buffer.
4457 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4458 the string buffer. The C<ptr> becomes the first character of the adjusted
4459 string. Uses the "OOK hack".
4465 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
4467 register STRLEN delta;
4469 if (!ptr || !SvPOKp(sv))
4471 SV_CHECK_THINKFIRST(sv);
4472 if (SvTYPE(sv) < SVt_PVIV)
4473 sv_upgrade(sv,SVt_PVIV);
4476 if (!SvLEN(sv)) { /* make copy of shared string */
4477 char *pvx = SvPVX(sv);
4478 STRLEN len = SvCUR(sv);
4479 SvGROW(sv, len + 1);
4480 Move(pvx,SvPVX(sv),len,char);
4484 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4485 and we do that anyway inside the SvNIOK_off
4487 SvFLAGS(sv) |= SVf_OOK;
4490 delta = ptr - SvPVX(sv);
4498 =for apidoc sv_catpvn
4500 Concatenates the string onto the end of the string which is in the SV. The
4501 C<len> indicates number of bytes to copy. If the SV has the UTF8
4502 status set, then the bytes appended should be valid UTF8.
4503 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4505 =for apidoc sv_catpvn_flags
4507 Concatenates the string onto the end of the string which is in the SV. The
4508 C<len> indicates number of bytes to copy. If the SV has the UTF8
4509 status set, then the bytes appended should be valid UTF8.
4510 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4511 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4512 in terms of this function.
4518 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4523 dstr = SvPV_force_flags(dsv, dlen, flags);
4524 SvGROW(dsv, dlen + slen + 1);
4527 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4530 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4535 =for apidoc sv_catpvn_mg
4537 Like C<sv_catpvn>, but also handles 'set' magic.
4543 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4545 sv_catpvn(sv,ptr,len);
4550 =for apidoc sv_catsv
4552 Concatenates the string from SV C<ssv> onto the end of the string in
4553 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4554 not 'set' magic. See C<sv_catsv_mg>.
4556 =for apidoc sv_catsv_flags
4558 Concatenates the string from SV C<ssv> onto the end of the string in
4559 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4560 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4561 and C<sv_catsv_nomg> are implemented in terms of this function.
4566 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4572 if ((spv = SvPV(ssv, slen))) {
4573 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4574 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4575 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4576 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4577 dsv->sv_flags doesn't have that bit set.
4578 Andy Dougherty 12 Oct 2001
4580 I32 sutf8 = DO_UTF8(ssv);
4583 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4585 dutf8 = DO_UTF8(dsv);
4587 if (dutf8 != sutf8) {
4589 /* Not modifying source SV, so taking a temporary copy. */
4590 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4592 sv_utf8_upgrade(csv);
4593 spv = SvPV(csv, slen);
4596 sv_utf8_upgrade_nomg(dsv);
4598 sv_catpvn_nomg(dsv, spv, slen);
4603 =for apidoc sv_catsv_mg
4605 Like C<sv_catsv>, but also handles 'set' magic.
4611 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4618 =for apidoc sv_catpv
4620 Concatenates the string onto the end of the string which is in the SV.
4621 If the SV has the UTF8 status set, then the bytes appended should be
4622 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4627 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4629 register STRLEN len;
4635 junk = SvPV_force(sv, tlen);
4637 SvGROW(sv, tlen + len + 1);
4640 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4642 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4647 =for apidoc sv_catpv_mg
4649 Like C<sv_catpv>, but also handles 'set' magic.
4655 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4664 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4665 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4672 Perl_newSV(pTHX_ STRLEN len)
4678 sv_upgrade(sv, SVt_PV);
4679 SvGROW(sv, len + 1);
4684 =for apidoc sv_magicext
4686 Adds magic to an SV, upgrading it if necessary. Applies the
4687 supplied vtable and returns pointer to the magic added.
4689 Note that sv_magicext will allow things that sv_magic will not.
4690 In particular you can add magic to SvREADONLY SVs and and more than
4691 one instance of the same 'how'
4693 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4694 if C<namelen> is zero then C<name> is stored as-is and - as another special
4695 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4696 an C<SV*> and has its REFCNT incremented
4698 (This is now used as a subroutine by sv_magic.)
4703 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4704 const char* name, I32 namlen)
4708 if (SvTYPE(sv) < SVt_PVMG) {
4709 (void)SvUPGRADE(sv, SVt_PVMG);
4711 Newz(702,mg, 1, MAGIC);
4712 mg->mg_moremagic = SvMAGIC(sv);
4715 /* Some magic sontains a reference loop, where the sv and object refer to
4716 each other. To prevent a reference loop that would prevent such
4717 objects being freed, we look for such loops and if we find one we
4718 avoid incrementing the object refcount.
4720 Note we cannot do this to avoid self-tie loops as intervening RV must
4721 have its REFCNT incremented to keep it in existence.
4724 if (!obj || obj == sv ||
4725 how == PERL_MAGIC_arylen ||
4726 how == PERL_MAGIC_qr ||
4727 (SvTYPE(obj) == SVt_PVGV &&
4728 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4729 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4730 GvFORM(obj) == (CV*)sv)))
4735 mg->mg_obj = SvREFCNT_inc(obj);
4736 mg->mg_flags |= MGf_REFCOUNTED;
4739 /* Normal self-ties simply pass a null object, and instead of
4740 using mg_obj directly, use the SvTIED_obj macro to produce a
4741 new RV as needed. For glob "self-ties", we are tieing the PVIO
4742 with an RV obj pointing to the glob containing the PVIO. In
4743 this case, to avoid a reference loop, we need to weaken the
4747 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4748 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4754 mg->mg_len = namlen;
4757 mg->mg_ptr = savepvn(name, namlen);
4758 else if (namlen == HEf_SVKEY)
4759 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4761 mg->mg_ptr = (char *) name;
4763 mg->mg_virtual = vtable;
4767 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4772 =for apidoc sv_magic
4774 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4775 then adds a new magic item of type C<how> to the head of the magic list.
4781 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4786 #ifdef PERL_COPY_ON_WRITE
4788 sv_force_normal_flags(sv, 0);
4790 if (SvREADONLY(sv)) {
4791 if (PL_curcop != &PL_compiling
4792 && how != PERL_MAGIC_regex_global
4793 && how != PERL_MAGIC_bm
4794 && how != PERL_MAGIC_fm
4795 && how != PERL_MAGIC_sv
4798 Perl_croak(aTHX_ PL_no_modify);
4801 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4802 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4803 /* sv_magic() refuses to add a magic of the same 'how' as an
4806 if (how == PERL_MAGIC_taint)
4814 vtable = &PL_vtbl_sv;
4816 case PERL_MAGIC_overload:
4817 vtable = &PL_vtbl_amagic;
4819 case PERL_MAGIC_overload_elem:
4820 vtable = &PL_vtbl_amagicelem;
4822 case PERL_MAGIC_overload_table:
4823 vtable = &PL_vtbl_ovrld;
4826 vtable = &PL_vtbl_bm;
4828 case PERL_MAGIC_regdata:
4829 vtable = &PL_vtbl_regdata;
4831 case PERL_MAGIC_regdatum:
4832 vtable = &PL_vtbl_regdatum;
4834 case PERL_MAGIC_env:
4835 vtable = &PL_vtbl_env;
4838 vtable = &PL_vtbl_fm;
4840 case PERL_MAGIC_envelem:
4841 vtable = &PL_vtbl_envelem;
4843 case PERL_MAGIC_regex_global:
4844 vtable = &PL_vtbl_mglob;
4846 case PERL_MAGIC_isa:
4847 vtable = &PL_vtbl_isa;
4849 case PERL_MAGIC_isaelem:
4850 vtable = &PL_vtbl_isaelem;
4852 case PERL_MAGIC_nkeys:
4853 vtable = &PL_vtbl_nkeys;
4855 case PERL_MAGIC_dbfile:
4858 case PERL_MAGIC_dbline:
4859 vtable = &PL_vtbl_dbline;
4861 #ifdef USE_LOCALE_COLLATE
4862 case PERL_MAGIC_collxfrm:
4863 vtable = &PL_vtbl_collxfrm;
4865 #endif /* USE_LOCALE_COLLATE */
4866 case PERL_MAGIC_tied:
4867 vtable = &PL_vtbl_pack;
4869 case PERL_MAGIC_tiedelem:
4870 case PERL_MAGIC_tiedscalar:
4871 vtable = &PL_vtbl_packelem;
4874 vtable = &PL_vtbl_regexp;
4876 case PERL_MAGIC_sig:
4877 vtable = &PL_vtbl_sig;
4879 case PERL_MAGIC_sigelem:
4880 vtable = &PL_vtbl_sigelem;
4882 case PERL_MAGIC_taint:
4883 vtable = &PL_vtbl_taint;
4885 case PERL_MAGIC_uvar:
4886 vtable = &PL_vtbl_uvar;
4888 case PERL_MAGIC_vec:
4889 vtable = &PL_vtbl_vec;
4891 case PERL_MAGIC_vstring:
4894 case PERL_MAGIC_utf8:
4895 vtable = &PL_vtbl_utf8;
4897 case PERL_MAGIC_substr:
4898 vtable = &PL_vtbl_substr;
4900 case PERL_MAGIC_defelem:
4901 vtable = &PL_vtbl_defelem;
4903 case PERL_MAGIC_glob:
4904 vtable = &PL_vtbl_glob;
4906 case PERL_MAGIC_arylen:
4907 vtable = &PL_vtbl_arylen;
4909 case PERL_MAGIC_pos:
4910 vtable = &PL_vtbl_pos;
4912 case PERL_MAGIC_backref:
4913 vtable = &PL_vtbl_backref;
4915 case PERL_MAGIC_ext:
4916 /* Reserved for use by extensions not perl internals. */
4917 /* Useful for attaching extension internal data to perl vars. */
4918 /* Note that multiple extensions may clash if magical scalars */
4919 /* etc holding private data from one are passed to another. */
4922 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4925 /* Rest of work is done else where */
4926 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4929 case PERL_MAGIC_taint:
4932 case PERL_MAGIC_ext:
4933 case PERL_MAGIC_dbfile:
4940 =for apidoc sv_unmagic
4942 Removes all magic of type C<type> from an SV.
4948 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4952 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4955 for (mg = *mgp; mg; mg = *mgp) {
4956 if (mg->mg_type == type) {
4957 MGVTBL* vtbl = mg->mg_virtual;
4958 *mgp = mg->mg_moremagic;
4959 if (vtbl && vtbl->svt_free)
4960 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4961 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4963 Safefree(mg->mg_ptr);
4964 else if (mg->mg_len == HEf_SVKEY)
4965 SvREFCNT_dec((SV*)mg->mg_ptr);
4966 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4967 Safefree(mg->mg_ptr);
4969 if (mg->mg_flags & MGf_REFCOUNTED)
4970 SvREFCNT_dec(mg->mg_obj);
4974 mgp = &mg->mg_moremagic;
4978 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4985 =for apidoc sv_rvweaken
4987 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4988 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4989 push a back-reference to this RV onto the array of backreferences
4990 associated with that magic.
4996 Perl_sv_rvweaken(pTHX_ SV *sv)
4999 if (!SvOK(sv)) /* let undefs pass */
5002 Perl_croak(aTHX_ "Can't weaken a nonreference");
5003 else if (SvWEAKREF(sv)) {
5004 if (ckWARN(WARN_MISC))
5005 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5009 sv_add_backref(tsv, sv);
5015 /* Give tsv backref magic if it hasn't already got it, then push a
5016 * back-reference to sv onto the array associated with the backref magic.
5020 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5024 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5025 av = (AV*)mg->mg_obj;
5028 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5029 SvREFCNT_dec(av); /* for sv_magic */
5031 if (AvFILLp(av) >= AvMAX(av)) {
5032 SV **svp = AvARRAY(av);
5033 I32 i = AvFILLp(av);
5035 if (svp[i] == &PL_sv_undef) {
5036 svp[i] = sv; /* reuse the slot */
5041 av_extend(av, AvFILLp(av)+1);
5043 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5046 /* delete a back-reference to ourselves from the backref magic associated
5047 * with the SV we point to.
5051 S_sv_del_backref(pTHX_ SV *sv)
5058 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5059 Perl_croak(aTHX_ "panic: del_backref");
5060 av = (AV *)mg->mg_obj;
5065 svp[i] = &PL_sv_undef; /* XXX */
5072 =for apidoc sv_insert
5074 Inserts a string at the specified offset/length within the SV. Similar to
5075 the Perl substr() function.
5081 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5085 register char *midend;
5086 register char *bigend;
5092 Perl_croak(aTHX_ "Can't modify non-existent substring");
5093 SvPV_force(bigstr, curlen);
5094 (void)SvPOK_only_UTF8(bigstr);
5095 if (offset + len > curlen) {
5096 SvGROW(bigstr, offset+len+1);
5097 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5098 SvCUR_set(bigstr, offset+len);
5102 i = littlelen - len;
5103 if (i > 0) { /* string might grow */
5104 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5105 mid = big + offset + len;
5106 midend = bigend = big + SvCUR(bigstr);
5109 while (midend > mid) /* shove everything down */
5110 *--bigend = *--midend;
5111 Move(little,big+offset,littlelen,char);
5117 Move(little,SvPVX(bigstr)+offset,len,char);
5122 big = SvPVX(bigstr);
5125 bigend = big + SvCUR(bigstr);
5127 if (midend > bigend)
5128 Perl_croak(aTHX_ "panic: sv_insert");
5130 if (mid - big > bigend - midend) { /* faster to shorten from end */
5132 Move(little, mid, littlelen,char);
5135 i = bigend - midend;
5137 Move(midend, mid, i,char);
5141 SvCUR_set(bigstr, mid - big);
5144 else if ((i = mid - big)) { /* faster from front */
5145 midend -= littlelen;
5147 sv_chop(bigstr,midend-i);
5152 Move(little, mid, littlelen,char);
5154 else if (littlelen) {
5155 midend -= littlelen;
5156 sv_chop(bigstr,midend);
5157 Move(little,midend,littlelen,char);
5160 sv_chop(bigstr,midend);
5166 =for apidoc sv_replace
5168 Make the first argument a copy of the second, then delete the original.
5169 The target SV physically takes over ownership of the body of the source SV
5170 and inherits its flags; however, the target keeps any magic it owns,
5171 and any magic in the source is discarded.
5172 Note that this is a rather specialist SV copying operation; most of the
5173 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5179 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5181 U32 refcnt = SvREFCNT(sv);
5182 SV_CHECK_THINKFIRST_COW_DROP(sv);
5183 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5184 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5185 if (SvMAGICAL(sv)) {
5189 sv_upgrade(nsv, SVt_PVMG);
5190 SvMAGIC(nsv) = SvMAGIC(sv);
5191 SvFLAGS(nsv) |= SvMAGICAL(sv);
5197 assert(!SvREFCNT(sv));
5198 StructCopy(nsv,sv,SV);
5199 #ifdef PERL_COPY_ON_WRITE
5200 if (SvIsCOW_normal(nsv)) {
5201 /* We need to follow the pointers around the loop to make the
5202 previous SV point to sv, rather than nsv. */
5205 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5208 assert(SvPVX(current) == SvPVX(nsv));
5210 /* Make the SV before us point to the SV after us. */
5212 PerlIO_printf(Perl_debug_log, "previous is\n");
5214 PerlIO_printf(Perl_debug_log,
5215 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5216 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5218 SV_COW_NEXT_SV_SET(current, sv);
5221 SvREFCNT(sv) = refcnt;
5222 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5227 =for apidoc sv_clear
5229 Clear an SV: call any destructors, free up any memory used by the body,
5230 and free the body itself. The SV's head is I<not> freed, although
5231 its type is set to all 1's so that it won't inadvertently be assumed
5232 to be live during global destruction etc.
5233 This function should only be called when REFCNT is zero. Most of the time
5234 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5241 Perl_sv_clear(pTHX_ register SV *sv)
5245 assert(SvREFCNT(sv) == 0);
5248 if (PL_defstash) { /* Still have a symbol table? */
5253 Zero(&tmpref, 1, SV);
5254 sv_upgrade(&tmpref, SVt_RV);
5256 SvREADONLY_on(&tmpref); /* DESTROY() could be naughty */
5257 SvREFCNT(&tmpref) = 1;
5260 stash = SvSTASH(sv);
5261 destructor = StashHANDLER(stash,DESTROY);
5264 PUSHSTACKi(PERLSI_DESTROY);
5265 SvRV(&tmpref) = SvREFCNT_inc(sv);
5270 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5276 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5278 del_XRV(SvANY(&tmpref));
5281 if (PL_in_clean_objs)
5282 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5284 /* DESTROY gave object new lease on life */
5290 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5291 SvOBJECT_off(sv); /* Curse the object. */
5292 if (SvTYPE(sv) != SVt_PVIO)
5293 --PL_sv_objcount; /* XXX Might want something more general */
5296 if (SvTYPE(sv) >= SVt_PVMG) {
5299 if (SvFLAGS(sv) & SVpad_TYPED)
5300 SvREFCNT_dec(SvSTASH(sv));
5303 switch (SvTYPE(sv)) {
5306 IoIFP(sv) != PerlIO_stdin() &&
5307 IoIFP(sv) != PerlIO_stdout() &&
5308 IoIFP(sv) != PerlIO_stderr())
5310 io_close((IO*)sv, FALSE);
5312 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5313 PerlDir_close(IoDIRP(sv));
5314 IoDIRP(sv) = (DIR*)NULL;
5315 Safefree(IoTOP_NAME(sv));
5316 Safefree(IoFMT_NAME(sv));
5317 Safefree(IoBOTTOM_NAME(sv));
5332 SvREFCNT_dec(LvTARG(sv));
5336 Safefree(GvNAME(sv));
5337 /* cannot decrease stash refcount yet, as we might recursively delete
5338 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5339 of stash until current sv is completely gone.
5340 -- JohnPC, 27 Mar 1998 */
5341 stash = GvSTASH(sv);
5347 (void)SvOOK_off(sv);
5355 SvREFCNT_dec(SvRV(sv));
5357 #ifdef PERL_COPY_ON_WRITE
5358 else if (SvPVX(sv)) {
5360 /* I believe I need to grab the global SV mutex here and
5361 then recheck the COW status. */
5363 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5366 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5367 SvUVX(sv), SV_COW_NEXT_SV(sv));
5368 /* And drop it here. */
5370 } else if (SvLEN(sv)) {
5371 Safefree(SvPVX(sv));
5375 else if (SvPVX(sv) && SvLEN(sv))
5376 Safefree(SvPVX(sv));
5377 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5378 unsharepvn(SvPVX(sv),
5379 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5393 switch (SvTYPE(sv)) {
5409 del_XPVIV(SvANY(sv));
5412 del_XPVNV(SvANY(sv));
5415 del_XPVMG(SvANY(sv));
5418 del_XPVLV(SvANY(sv));
5421 del_XPVAV(SvANY(sv));
5424 del_XPVHV(SvANY(sv));
5427 del_XPVCV(SvANY(sv));
5430 del_XPVGV(SvANY(sv));
5431 /* code duplication for increased performance. */
5432 SvFLAGS(sv) &= SVf_BREAK;
5433 SvFLAGS(sv) |= SVTYPEMASK;
5434 /* decrease refcount of the stash that owns this GV, if any */
5436 SvREFCNT_dec(stash);
5437 return; /* not break, SvFLAGS reset already happened */
5439 del_XPVBM(SvANY(sv));
5442 del_XPVFM(SvANY(sv));
5445 del_XPVIO(SvANY(sv));
5448 SvFLAGS(sv) &= SVf_BREAK;
5449 SvFLAGS(sv) |= SVTYPEMASK;
5453 =for apidoc sv_newref
5455 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5462 Perl_sv_newref(pTHX_ SV *sv)
5472 Decrement an SV's reference count, and if it drops to zero, call
5473 C<sv_clear> to invoke destructors and free up any memory used by
5474 the body; finally, deallocate the SV's head itself.
5475 Normally called via a wrapper macro C<SvREFCNT_dec>.
5481 Perl_sv_free(pTHX_ SV *sv)
5485 if (SvREFCNT(sv) == 0) {
5486 if (SvFLAGS(sv) & SVf_BREAK)
5487 /* this SV's refcnt has been artificially decremented to
5488 * trigger cleanup */
5490 if (PL_in_clean_all) /* All is fair */
5492 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5493 /* make sure SvREFCNT(sv)==0 happens very seldom */
5494 SvREFCNT(sv) = (~(U32)0)/2;
5497 if (ckWARN_d(WARN_INTERNAL))
5498 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Attempt to free unreferenced scalar");
5501 if (--(SvREFCNT(sv)) > 0)
5503 Perl_sv_free2(aTHX_ sv);
5507 Perl_sv_free2(pTHX_ SV *sv)
5511 if (ckWARN_d(WARN_DEBUGGING))
5512 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5513 "Attempt to free temp prematurely: SV 0x%"UVxf,
5518 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5519 /* make sure SvREFCNT(sv)==0 happens very seldom */
5520 SvREFCNT(sv) = (~(U32)0)/2;
5531 Returns the length of the string in the SV. Handles magic and type
5532 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5538 Perl_sv_len(pTHX_ register SV *sv)
5546 len = mg_length(sv);
5548 (void)SvPV(sv, len);
5553 =for apidoc sv_len_utf8
5555 Returns the number of characters in the string in an SV, counting wide
5556 UTF8 bytes as a single character. Handles magic and type coercion.
5562 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5563 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5564 * (Note that the mg_len is not the length of the mg_ptr field.)
5569 Perl_sv_len_utf8(pTHX_ register SV *sv)
5575 return mg_length(sv);
5579 U8 *s = (U8*)SvPV(sv, len);
5580 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5582 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0))
5585 ulen = Perl_utf8_length(aTHX_ s, s + len);
5586 if (!mg && !SvREADONLY(sv)) {
5587 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5588 mg = mg_find(sv, PERL_MAGIC_utf8);
5598 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5599 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5600 * between UTF-8 and byte offsets. There are two (substr offset and substr
5601 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5602 * and byte offset) cache positions.
5604 * The mg_len field is used by sv_len_utf8(), see its comments.
5605 * Note that the mg_len is not the length of the mg_ptr field.
5609 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
5613 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5615 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5616 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5621 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5623 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5624 (*mgp)->mg_ptr = (char *) *cachep;
5628 (*cachep)[i] = *offsetp;
5629 (*cachep)[i+1] = s - start;
5637 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5638 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5639 * between UTF-8 and byte offsets. See also the comments of
5640 * S_utf8_mg_pos_init().
5644 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
5648 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5650 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5651 if (*mgp && (*mgp)->mg_ptr) {
5652 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5653 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5655 else { /* We will skip to the right spot. */
5660 /* The assumption is that going backward is half
5661 * the speed of going forward (that's where the
5662 * 2 * backw in the below comes from). (The real
5663 * figure of course depends on the UTF-8 data.) */
5665 if ((*cachep)[i] > (STRLEN)uoff) {
5667 backw = (*cachep)[i] - (STRLEN)uoff;
5669 if (forw < 2 * backw)
5672 p = start + (*cachep)[i+1];
5674 /* Try this only for the substr offset (i == 0),
5675 * not for the substr length (i == 2). */
5676 else if (i == 0) { /* (*cachep)[i] < uoff */
5677 STRLEN ulen = sv_len_utf8(sv);
5679 if ((STRLEN)uoff < ulen) {
5680 forw = (STRLEN)uoff - (*cachep)[i];
5681 backw = ulen - (STRLEN)uoff;
5683 if (forw < 2 * backw)
5684 p = start + (*cachep)[i+1];
5689 /* If the string is not long enough for uoff,
5690 * we could extend it, but not at this low a level. */
5694 if (forw < 2 * backw) {
5701 while (UTF8_IS_CONTINUATION(*p))
5706 /* Update the cache. */
5707 (*cachep)[i] = (STRLEN)uoff;
5708 (*cachep)[i+1] = p - start;
5713 if (found) { /* Setup the return values. */
5714 *offsetp = (*cachep)[i+1];
5715 *sp = start + *offsetp;
5718 *offsetp = send - start;
5720 else if (*sp < start) {
5731 =for apidoc sv_pos_u2b
5733 Converts the value pointed to by offsetp from a count of UTF8 chars from
5734 the start of the string, to a count of the equivalent number of bytes; if
5735 lenp is non-zero, it does the same to lenp, but this time starting from
5736 the offset, rather than from the start of the string. Handles magic and
5743 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5744 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5745 * byte offsets. See also the comments of S_utf8_mg_pos().
5750 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5761 start = s = (U8*)SvPV(sv, len);
5763 I32 uoffset = *offsetp;
5768 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5770 if (!found && uoffset > 0) {
5771 while (s < send && uoffset--)
5775 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
5777 *offsetp = s - start;
5782 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
5786 if (!found && *lenp > 0) {
5789 while (s < send && ulen--)
5793 if (utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start))
5794 cache[2] += *offsetp;
5808 =for apidoc sv_pos_b2u
5810 Converts the value pointed to by offsetp from a count of bytes from the
5811 start of the string, to a count of the equivalent number of UTF8 chars.
5812 Handles magic and type coercion.
5818 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5819 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5820 * byte offsets. See also the comments of S_utf8_mg_pos().
5825 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5833 s = (U8*)SvPV(sv, len);
5834 if ((I32)len < *offsetp)
5835 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5837 U8* send = s + *offsetp;
5839 STRLEN *cache = NULL;
5843 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5844 mg = mg_find(sv, PERL_MAGIC_utf8);
5845 if (mg && mg->mg_ptr) {
5846 cache = (STRLEN *) mg->mg_ptr;
5847 if (cache[1] == *offsetp) {
5848 /* An exact match. */
5849 *offsetp = cache[0];
5853 else if (cache[1] < *offsetp) {
5854 /* We already know part of the way. */
5857 /* Let the below loop do the rest. */
5859 else { /* cache[1] > *offsetp */
5860 /* We already know all of the way, now we may
5861 * be able to walk back. The same assumption
5862 * is made as in S_utf8_mg_pos(), namely that
5863 * walking backward is twice slower than
5864 * walking forward. */
5865 STRLEN forw = *offsetp;
5866 STRLEN backw = cache[1] - *offsetp;
5868 if (!(forw < 2 * backw)) {
5869 U8 *p = s + cache[1];
5876 while (UTF8_IS_CONTINUATION(*p))
5892 /* Call utf8n_to_uvchr() to validate the sequence
5893 * (unless a simple non-UTF character) */
5894 if (!UTF8_IS_INVARIANT(*s))
5895 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5904 if (!SvREADONLY(sv)) {
5906 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5907 mg = mg_find(sv, PERL_MAGIC_utf8);
5912 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5913 mg->mg_ptr = (char *) cache;
5918 cache[1] = *offsetp;
5929 Returns a boolean indicating whether the strings in the two SVs are
5930 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5931 coerce its args to strings if necessary.
5937 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5945 SV* svrecode = Nullsv;
5952 pv1 = SvPV(sv1, cur1);
5959 pv2 = SvPV(sv2, cur2);
5961 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5962 /* Differing utf8ness.
5963 * Do not UTF8size the comparands as a side-effect. */
5966 svrecode = newSVpvn(pv2, cur2);
5967 sv_recode_to_utf8(svrecode, PL_encoding);
5968 pv2 = SvPV(svrecode, cur2);
5971 svrecode = newSVpvn(pv1, cur1);
5972 sv_recode_to_utf8(svrecode, PL_encoding);
5973 pv1 = SvPV(svrecode, cur1);
5975 /* Now both are in UTF-8. */
5980 bool is_utf8 = TRUE;
5983 /* sv1 is the UTF-8 one,
5984 * if is equal it must be downgrade-able */
5985 char *pv = (char*)bytes_from_utf8((U8*)pv1,
5991 /* sv2 is the UTF-8 one,
5992 * if is equal it must be downgrade-able */
5993 char *pv = (char *)bytes_from_utf8((U8*)pv2,
5999 /* Downgrade not possible - cannot be eq */
6006 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6009 SvREFCNT_dec(svrecode);
6020 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6021 string in C<sv1> is less than, equal to, or greater than the string in
6022 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6023 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6029 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6032 char *pv1, *pv2, *tpv = Nullch;
6034 SV *svrecode = Nullsv;
6041 pv1 = SvPV(sv1, cur1);
6048 pv2 = SvPV(sv2, cur2);
6050 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6051 /* Differing utf8ness.
6052 * Do not UTF8size the comparands as a side-effect. */
6055 svrecode = newSVpvn(pv2, cur2);
6056 sv_recode_to_utf8(svrecode, PL_encoding);
6057 pv2 = SvPV(svrecode, cur2);
6060 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
6065 svrecode = newSVpvn(pv1, cur1);
6066 sv_recode_to_utf8(svrecode, PL_encoding);
6067 pv1 = SvPV(svrecode, cur1);
6070 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
6076 cmp = cur2 ? -1 : 0;
6080 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6083 cmp = retval < 0 ? -1 : 1;
6084 } else if (cur1 == cur2) {
6087 cmp = cur1 < cur2 ? -1 : 1;
6092 SvREFCNT_dec(svrecode);
6101 =for apidoc sv_cmp_locale
6103 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6104 'use bytes' aware, handles get magic, and will coerce its args to strings
6105 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6111 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6113 #ifdef USE_LOCALE_COLLATE
6119 if (PL_collation_standard)
6123 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6125 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6127 if (!pv1 || !len1) {
6138 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6141 return retval < 0 ? -1 : 1;
6144 * When the result of collation is equality, that doesn't mean
6145 * that there are no differences -- some locales exclude some
6146 * characters from consideration. So to avoid false equalities,
6147 * we use the raw string as a tiebreaker.
6153 #endif /* USE_LOCALE_COLLATE */
6155 return sv_cmp(sv1, sv2);
6159 #ifdef USE_LOCALE_COLLATE
6162 =for apidoc sv_collxfrm
6164 Add Collate Transform magic to an SV if it doesn't already have it.
6166 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6167 scalar data of the variable, but transformed to such a format that a normal
6168 memory comparison can be used to compare the data according to the locale
6175 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6179 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6180 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6185 Safefree(mg->mg_ptr);
6187 if ((xf = mem_collxfrm(s, len, &xlen))) {
6188 if (SvREADONLY(sv)) {
6191 return xf + sizeof(PL_collation_ix);
6194 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6195 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6208 if (mg && mg->mg_ptr) {
6210 return mg->mg_ptr + sizeof(PL_collation_ix);
6218 #endif /* USE_LOCALE_COLLATE */
6223 Get a line from the filehandle and store it into the SV, optionally
6224 appending to the currently-stored string.
6230 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6234 register STDCHAR rslast;
6235 register STDCHAR *bp;
6241 SV_CHECK_THINKFIRST_COW_DROP(sv);
6242 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6244 However, perlbench says it's slower, because the existing swipe code
6245 is faster than copy on write.
6246 Swings and roundabouts. */
6247 (void)SvUPGRADE(sv, SVt_PV);
6250 SvPOK_only(sv); /* Validate pointer */
6252 if (PL_curcop == &PL_compiling) {
6253 /* we always read code in line mode */
6257 else if (RsSNARF(PL_rs)) {
6258 /* If it is a regular disk file use size from stat() as estimate
6259 of amount we are going to read - may result in malloc-ing
6260 more memory than we realy need if layers bellow reduce
6261 size we read (e.g. CRLF or a gzip layer)
6264 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6265 Off_t offset = PerlIO_tell(fp);
6266 if (offset != (Off_t) -1) {
6267 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6273 else if (RsRECORD(PL_rs)) {
6277 /* Grab the size of the record we're getting */
6278 recsize = SvIV(SvRV(PL_rs));
6279 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6282 /* VMS wants read instead of fread, because fread doesn't respect */
6283 /* RMS record boundaries. This is not necessarily a good thing to be */
6284 /* doing, but we've got no other real choice - except avoid stdio
6285 as implementation - perhaps write a :vms layer ?
6287 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6289 bytesread = PerlIO_read(fp, buffer, recsize);
6291 SvCUR_set(sv, bytesread += append);
6292 buffer[bytesread] = '\0';
6293 goto check_utf8_and_return;
6295 else if (RsPARA(PL_rs)) {
6301 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6302 if (PerlIO_isutf8(fp)) {
6303 rsptr = SvPVutf8(PL_rs, rslen);
6306 if (SvUTF8(PL_rs)) {
6307 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6308 Perl_croak(aTHX_ "Wide character in $/");
6311 rsptr = SvPV(PL_rs, rslen);
6315 rslast = rslen ? rsptr[rslen - 1] : '\0';
6317 if (rspara) { /* have to do this both before and after */
6318 do { /* to make sure file boundaries work right */
6321 i = PerlIO_getc(fp);
6325 PerlIO_ungetc(fp,i);
6331 /* See if we know enough about I/O mechanism to cheat it ! */
6333 /* This used to be #ifdef test - it is made run-time test for ease
6334 of abstracting out stdio interface. One call should be cheap
6335 enough here - and may even be a macro allowing compile
6339 if (PerlIO_fast_gets(fp)) {
6342 * We're going to steal some values from the stdio struct
6343 * and put EVERYTHING in the innermost loop into registers.
6345 register STDCHAR *ptr;
6349 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6350 /* An ungetc()d char is handled separately from the regular
6351 * buffer, so we getc() it back out and stuff it in the buffer.
6353 i = PerlIO_getc(fp);
6354 if (i == EOF) return 0;
6355 *(--((*fp)->_ptr)) = (unsigned char) i;
6359 /* Here is some breathtakingly efficient cheating */
6361 cnt = PerlIO_get_cnt(fp); /* get count into register */
6362 /* make sure we have the room */
6363 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6364 /* Not room for all of it
6365 if we are looking for a separator and room for some
6367 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6368 /* just process what we have room for */
6369 shortbuffered = cnt - SvLEN(sv) + append + 1;
6370 cnt -= shortbuffered;
6374 /* remember that cnt can be negative */
6375 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6380 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
6381 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6382 DEBUG_P(PerlIO_printf(Perl_debug_log,
6383 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6384 DEBUG_P(PerlIO_printf(Perl_debug_log,
6385 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6386 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6387 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6392 while (cnt > 0) { /* this | eat */
6394 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6395 goto thats_all_folks; /* screams | sed :-) */
6399 Copy(ptr, bp, cnt, char); /* this | eat */
6400 bp += cnt; /* screams | dust */
6401 ptr += cnt; /* louder | sed :-) */
6406 if (shortbuffered) { /* oh well, must extend */
6407 cnt = shortbuffered;
6409 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6411 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6412 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6416 DEBUG_P(PerlIO_printf(Perl_debug_log,
6417 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6418 PTR2UV(ptr),(long)cnt));
6419 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6421 DEBUG_P(PerlIO_printf(Perl_debug_log,
6422 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6423 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6424 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6426 /* This used to call 'filbuf' in stdio form, but as that behaves like
6427 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6428 another abstraction. */
6429 i = PerlIO_getc(fp); /* get more characters */
6431 DEBUG_P(PerlIO_printf(Perl_debug_log,
6432 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6433 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6434 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6436 cnt = PerlIO_get_cnt(fp);
6437 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6438 DEBUG_P(PerlIO_printf(Perl_debug_log,
6439 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6441 if (i == EOF) /* all done for ever? */
6442 goto thats_really_all_folks;
6444 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6446 SvGROW(sv, bpx + cnt + 2);
6447 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6449 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6451 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6452 goto thats_all_folks;
6456 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
6457 memNE((char*)bp - rslen, rsptr, rslen))
6458 goto screamer; /* go back to the fray */
6459 thats_really_all_folks:
6461 cnt += shortbuffered;
6462 DEBUG_P(PerlIO_printf(Perl_debug_log,
6463 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6464 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6465 DEBUG_P(PerlIO_printf(Perl_debug_log,
6466 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6467 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6468 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6470 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
6471 DEBUG_P(PerlIO_printf(Perl_debug_log,
6472 "Screamer: done, len=%ld, string=|%.*s|\n",
6473 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
6478 /*The big, slow, and stupid way */
6481 /* Need to work around EPOC SDK features */
6482 /* On WINS: MS VC5 generates calls to _chkstk, */
6483 /* if a `large' stack frame is allocated */
6484 /* gcc on MARM does not generate calls like these */
6490 register STDCHAR *bpe = buf + sizeof(buf);
6492 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6493 ; /* keep reading */
6497 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6498 /* Accomodate broken VAXC compiler, which applies U8 cast to
6499 * both args of ?: operator, causing EOF to change into 255
6502 i = (U8)buf[cnt - 1];
6508 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6510 sv_catpvn(sv, (char *) buf, cnt);
6512 sv_setpvn(sv, (char *) buf, cnt);
6514 if (i != EOF && /* joy */
6516 SvCUR(sv) < rslen ||
6517 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6521 * If we're reading from a TTY and we get a short read,
6522 * indicating that the user hit his EOF character, we need
6523 * to notice it now, because if we try to read from the TTY
6524 * again, the EOF condition will disappear.
6526 * The comparison of cnt to sizeof(buf) is an optimization
6527 * that prevents unnecessary calls to feof().
6531 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6536 if (rspara) { /* have to do this both before and after */
6537 while (i != EOF) { /* to make sure file boundaries work right */
6538 i = PerlIO_getc(fp);
6540 PerlIO_ungetc(fp,i);
6546 check_utf8_and_return:
6547 if (PerlIO_isutf8(fp))
6552 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6558 Auto-increment of the value in the SV, doing string to numeric conversion
6559 if necessary. Handles 'get' magic.
6565 Perl_sv_inc(pTHX_ register SV *sv)
6574 if (SvTHINKFIRST(sv)) {
6576 sv_force_normal_flags(sv, 0);
6577 if (SvREADONLY(sv)) {
6578 if (PL_curcop != &PL_compiling)
6579 Perl_croak(aTHX_ PL_no_modify);
6583 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6585 i = PTR2IV(SvRV(sv));
6590 flags = SvFLAGS(sv);
6591 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6592 /* It's (privately or publicly) a float, but not tested as an
6593 integer, so test it to see. */
6595 flags = SvFLAGS(sv);
6597 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6598 /* It's publicly an integer, or privately an integer-not-float */
6599 #ifdef PERL_PRESERVE_IVUV
6603 if (SvUVX(sv) == UV_MAX)
6604 sv_setnv(sv, UV_MAX_P1);
6606 (void)SvIOK_only_UV(sv);
6609 if (SvIVX(sv) == IV_MAX)
6610 sv_setuv(sv, (UV)IV_MAX + 1);
6612 (void)SvIOK_only(sv);
6618 if (flags & SVp_NOK) {
6619 (void)SvNOK_only(sv);
6624 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
6625 if ((flags & SVTYPEMASK) < SVt_PVIV)
6626 sv_upgrade(sv, SVt_IV);
6627 (void)SvIOK_only(sv);
6632 while (isALPHA(*d)) d++;
6633 while (isDIGIT(*d)) d++;
6635 #ifdef PERL_PRESERVE_IVUV
6636 /* Got to punt this as an integer if needs be, but we don't issue
6637 warnings. Probably ought to make the sv_iv_please() that does
6638 the conversion if possible, and silently. */
6639 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6640 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6641 /* Need to try really hard to see if it's an integer.
6642 9.22337203685478e+18 is an integer.
6643 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6644 so $a="9.22337203685478e+18"; $a+0; $a++
6645 needs to be the same as $a="9.22337203685478e+18"; $a++
6652 /* sv_2iv *should* have made this an NV */
6653 if (flags & SVp_NOK) {
6654 (void)SvNOK_only(sv);
6658 /* I don't think we can get here. Maybe I should assert this
6659 And if we do get here I suspect that sv_setnv will croak. NWC
6661 #if defined(USE_LONG_DOUBLE)
6662 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",
6663 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6665 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6666 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6669 #endif /* PERL_PRESERVE_IVUV */
6670 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
6674 while (d >= SvPVX(sv)) {
6682 /* MKS: The original code here died if letters weren't consecutive.
6683 * at least it didn't have to worry about non-C locales. The
6684 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6685 * arranged in order (although not consecutively) and that only
6686 * [A-Za-z] are accepted by isALPHA in the C locale.
6688 if (*d != 'z' && *d != 'Z') {
6689 do { ++*d; } while (!isALPHA(*d));
6692 *(d--) -= 'z' - 'a';
6697 *(d--) -= 'z' - 'a' + 1;
6701 /* oh,oh, the number grew */
6702 SvGROW(sv, SvCUR(sv) + 2);
6704 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6715 Auto-decrement of the value in the SV, doing string to numeric conversion
6716 if necessary. Handles 'get' magic.
6722 Perl_sv_dec(pTHX_ register SV *sv)
6730 if (SvTHINKFIRST(sv)) {
6732 sv_force_normal_flags(sv, 0);
6733 if (SvREADONLY(sv)) {
6734 if (PL_curcop != &PL_compiling)
6735 Perl_croak(aTHX_ PL_no_modify);
6739 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6741 i = PTR2IV(SvRV(sv));
6746 /* Unlike sv_inc we don't have to worry about string-never-numbers
6747 and keeping them magic. But we mustn't warn on punting */
6748 flags = SvFLAGS(sv);
6749 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6750 /* It's publicly an integer, or privately an integer-not-float */
6751 #ifdef PERL_PRESERVE_IVUV
6755 if (SvUVX(sv) == 0) {
6756 (void)SvIOK_only(sv);
6760 (void)SvIOK_only_UV(sv);
6764 if (SvIVX(sv) == IV_MIN)
6765 sv_setnv(sv, (NV)IV_MIN - 1.0);
6767 (void)SvIOK_only(sv);
6773 if (flags & SVp_NOK) {
6775 (void)SvNOK_only(sv);
6778 if (!(flags & SVp_POK)) {
6779 if ((flags & SVTYPEMASK) < SVt_PVNV)
6780 sv_upgrade(sv, SVt_NV);
6782 (void)SvNOK_only(sv);
6785 #ifdef PERL_PRESERVE_IVUV
6787 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6788 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6789 /* Need to try really hard to see if it's an integer.
6790 9.22337203685478e+18 is an integer.
6791 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6792 so $a="9.22337203685478e+18"; $a+0; $a--
6793 needs to be the same as $a="9.22337203685478e+18"; $a--
6800 /* sv_2iv *should* have made this an NV */
6801 if (flags & SVp_NOK) {
6802 (void)SvNOK_only(sv);
6806 /* I don't think we can get here. Maybe I should assert this
6807 And if we do get here I suspect that sv_setnv will croak. NWC
6809 #if defined(USE_LONG_DOUBLE)
6810 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",
6811 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6813 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6814 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6818 #endif /* PERL_PRESERVE_IVUV */
6819 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6823 =for apidoc sv_mortalcopy
6825 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6826 The new SV is marked as mortal. It will be destroyed "soon", either by an
6827 explicit call to FREETMPS, or by an implicit call at places such as
6828 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6833 /* Make a string that will exist for the duration of the expression
6834 * evaluation. Actually, it may have to last longer than that, but
6835 * hopefully we won't free it until it has been assigned to a
6836 * permanent location. */
6839 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6844 sv_setsv(sv,oldstr);
6846 PL_tmps_stack[++PL_tmps_ix] = sv;
6852 =for apidoc sv_newmortal
6854 Creates a new null SV which is mortal. The reference count of the SV is
6855 set to 1. It will be destroyed "soon", either by an explicit call to
6856 FREETMPS, or by an implicit call at places such as statement boundaries.
6857 See also C<sv_mortalcopy> and C<sv_2mortal>.
6863 Perl_sv_newmortal(pTHX)
6868 SvFLAGS(sv) = SVs_TEMP;
6870 PL_tmps_stack[++PL_tmps_ix] = sv;
6875 =for apidoc sv_2mortal
6877 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6878 by an explicit call to FREETMPS, or by an implicit call at places such as
6879 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
6885 Perl_sv_2mortal(pTHX_ register SV *sv)
6889 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6892 PL_tmps_stack[++PL_tmps_ix] = sv;
6900 Creates a new SV and copies a string into it. The reference count for the
6901 SV is set to 1. If C<len> is zero, Perl will compute the length using
6902 strlen(). For efficiency, consider using C<newSVpvn> instead.
6908 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6915 sv_setpvn(sv,s,len);
6920 =for apidoc newSVpvn
6922 Creates a new SV and copies a string into it. The reference count for the
6923 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6924 string. You are responsible for ensuring that the source string is at least
6931 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6936 sv_setpvn(sv,s,len);
6941 =for apidoc newSVpvn_share
6943 Creates a new SV with its SvPVX pointing to a shared string in the string
6944 table. If the string does not already exist in the table, it is created
6945 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6946 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6947 otherwise the hash is computed. The idea here is that as the string table
6948 is used for shared hash keys these strings will have SvPVX == HeKEY and
6949 hash lookup will avoid string compare.
6955 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6958 bool is_utf8 = FALSE;
6960 STRLEN tmplen = -len;
6962 /* See the note in hv.c:hv_fetch() --jhi */
6963 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
6967 PERL_HASH(hash, src, len);
6969 sv_upgrade(sv, SVt_PVIV);
6970 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
6983 #if defined(PERL_IMPLICIT_CONTEXT)
6985 /* pTHX_ magic can't cope with varargs, so this is a no-context
6986 * version of the main function, (which may itself be aliased to us).
6987 * Don't access this version directly.
6991 Perl_newSVpvf_nocontext(const char* pat, ...)
6996 va_start(args, pat);
6997 sv = vnewSVpvf(pat, &args);
7004 =for apidoc newSVpvf
7006 Creates a new SV and initializes it with the string formatted like
7013 Perl_newSVpvf(pTHX_ const char* pat, ...)
7017 va_start(args, pat);
7018 sv = vnewSVpvf(pat, &args);
7023 /* backend for newSVpvf() and newSVpvf_nocontext() */
7026 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7030 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7037 Creates a new SV and copies a floating point value into it.
7038 The reference count for the SV is set to 1.
7044 Perl_newSVnv(pTHX_ NV n)
7056 Creates a new SV and copies an integer into it. The reference count for the
7063 Perl_newSViv(pTHX_ IV i)
7075 Creates a new SV and copies an unsigned integer into it.
7076 The reference count for the SV is set to 1.
7082 Perl_newSVuv(pTHX_ UV u)
7092 =for apidoc newRV_noinc
7094 Creates an RV wrapper for an SV. The reference count for the original
7095 SV is B<not> incremented.
7101 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7106 sv_upgrade(sv, SVt_RV);
7113 /* newRV_inc is the official function name to use now.
7114 * newRV_inc is in fact #defined to newRV in sv.h
7118 Perl_newRV(pTHX_ SV *tmpRef)
7120 return newRV_noinc(SvREFCNT_inc(tmpRef));
7126 Creates a new SV which is an exact duplicate of the original SV.
7133 Perl_newSVsv(pTHX_ register SV *old)
7139 if (SvTYPE(old) == SVTYPEMASK) {
7140 if (ckWARN_d(WARN_INTERNAL))
7141 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7156 =for apidoc sv_reset
7158 Underlying implementation for the C<reset> Perl function.
7159 Note that the perl-level function is vaguely deprecated.
7165 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7173 char todo[PERL_UCHAR_MAX+1];
7178 if (!*s) { /* reset ?? searches */
7179 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7180 pm->op_pmdynflags &= ~PMdf_USED;
7185 /* reset variables */
7187 if (!HvARRAY(stash))
7190 Zero(todo, 256, char);
7192 i = (unsigned char)*s;
7196 max = (unsigned char)*s++;
7197 for ( ; i <= max; i++) {
7200 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7201 for (entry = HvARRAY(stash)[i];
7203 entry = HeNEXT(entry))
7205 if (!todo[(U8)*HeKEY(entry)])
7207 gv = (GV*)HeVAL(entry);
7209 if (SvTHINKFIRST(sv)) {
7210 if (!SvREADONLY(sv) && SvROK(sv))
7215 if (SvTYPE(sv) >= SVt_PV) {
7217 if (SvPVX(sv) != Nullch)
7224 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7226 #ifdef USE_ENVIRON_ARRAY
7228 # ifdef USE_ITHREADS
7229 && PL_curinterp == aTHX
7233 environ[0] = Nullch;
7245 Using various gambits, try to get an IO from an SV: the IO slot if its a
7246 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7247 named after the PV if we're a string.
7253 Perl_sv_2io(pTHX_ SV *sv)
7259 switch (SvTYPE(sv)) {
7267 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7271 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7273 return sv_2io(SvRV(sv));
7274 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7280 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7289 Using various gambits, try to get a CV from an SV; in addition, try if
7290 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7296 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7303 return *gvp = Nullgv, Nullcv;
7304 switch (SvTYPE(sv)) {
7323 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7324 tryAMAGICunDEREF(to_cv);
7327 if (SvTYPE(sv) == SVt_PVCV) {
7336 Perl_croak(aTHX_ "Not a subroutine reference");
7341 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
7347 if (lref && !GvCVu(gv)) {
7350 tmpsv = NEWSV(704,0);
7351 gv_efullname3(tmpsv, gv, Nullch);
7352 /* XXX this is probably not what they think they're getting.
7353 * It has the same effect as "sub name;", i.e. just a forward
7355 newSUB(start_subparse(FALSE, 0),
7356 newSVOP(OP_CONST, 0, tmpsv),
7361 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7371 Returns true if the SV has a true value by Perl's rules.
7372 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7373 instead use an in-line version.
7379 Perl_sv_true(pTHX_ register SV *sv)
7385 if ((tXpv = (XPV*)SvANY(sv)) &&
7386 (tXpv->xpv_cur > 1 ||
7387 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
7394 return SvIVX(sv) != 0;
7397 return SvNVX(sv) != 0.0;
7399 return sv_2bool(sv);
7407 A private implementation of the C<SvIVx> macro for compilers which can't
7408 cope with complex macro expressions. Always use the macro instead.
7414 Perl_sv_iv(pTHX_ register SV *sv)
7418 return (IV)SvUVX(sv);
7427 A private implementation of the C<SvUVx> macro for compilers which can't
7428 cope with complex macro expressions. Always use the macro instead.
7434 Perl_sv_uv(pTHX_ register SV *sv)
7439 return (UV)SvIVX(sv);
7447 A private implementation of the C<SvNVx> macro for compilers which can't
7448 cope with complex macro expressions. Always use the macro instead.
7454 Perl_sv_nv(pTHX_ register SV *sv)
7464 Use the C<SvPV_nolen> macro instead
7468 A private implementation of the C<SvPV> macro for compilers which can't
7469 cope with complex macro expressions. Always use the macro instead.
7475 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7481 return sv_2pv(sv, lp);
7486 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7492 return sv_2pv_flags(sv, lp, 0);
7496 =for apidoc sv_pvn_force
7498 Get a sensible string out of the SV somehow.
7499 A private implementation of the C<SvPV_force> macro for compilers which
7500 can't cope with complex macro expressions. Always use the macro instead.
7502 =for apidoc sv_pvn_force_flags
7504 Get a sensible string out of the SV somehow.
7505 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7506 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7507 implemented in terms of this function.
7508 You normally want to use the various wrapper macros instead: see
7509 C<SvPV_force> and C<SvPV_force_nomg>
7515 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7519 if (SvTHINKFIRST(sv) && !SvROK(sv))
7520 sv_force_normal_flags(sv, 0);
7526 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7527 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7531 s = sv_2pv_flags(sv, lp, flags);
7532 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
7537 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7538 SvGROW(sv, len + 1);
7539 Move(s,SvPVX(sv),len,char);
7544 SvPOK_on(sv); /* validate pointer */
7546 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7547 PTR2UV(sv),SvPVX(sv)));
7554 =for apidoc sv_pvbyte
7556 Use C<SvPVbyte_nolen> instead.
7558 =for apidoc sv_pvbyten
7560 A private implementation of the C<SvPVbyte> macro for compilers
7561 which can't cope with complex macro expressions. Always use the macro
7568 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7570 sv_utf8_downgrade(sv,0);
7571 return sv_pvn(sv,lp);
7575 =for apidoc sv_pvbyten_force
7577 A private implementation of the C<SvPVbytex_force> macro for compilers
7578 which can't cope with complex macro expressions. Always use the macro
7585 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7587 sv_utf8_downgrade(sv,0);
7588 return sv_pvn_force(sv,lp);
7592 =for apidoc sv_pvutf8
7594 Use the C<SvPVutf8_nolen> macro instead
7596 =for apidoc sv_pvutf8n
7598 A private implementation of the C<SvPVutf8> macro for compilers
7599 which can't cope with complex macro expressions. Always use the macro
7606 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7608 sv_utf8_upgrade(sv);
7609 return sv_pvn(sv,lp);
7613 =for apidoc sv_pvutf8n_force
7615 A private implementation of the C<SvPVutf8_force> macro for compilers
7616 which can't cope with complex macro expressions. Always use the macro
7623 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7625 sv_utf8_upgrade(sv);
7626 return sv_pvn_force(sv,lp);
7630 =for apidoc sv_reftype
7632 Returns a string describing what the SV is a reference to.
7638 Perl_sv_reftype(pTHX_ SV *sv, int ob)
7640 if (ob && SvOBJECT(sv)) {
7641 return HvNAME(SvSTASH(sv));
7644 switch (SvTYPE(sv)) {
7660 case SVt_PVLV: return "LVALUE";
7661 case SVt_PVAV: return "ARRAY";
7662 case SVt_PVHV: return "HASH";
7663 case SVt_PVCV: return "CODE";
7664 case SVt_PVGV: return "GLOB";
7665 case SVt_PVFM: return "FORMAT";
7666 case SVt_PVIO: return "IO";
7667 default: return "UNKNOWN";
7673 =for apidoc sv_isobject
7675 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7676 object. If the SV is not an RV, or if the object is not blessed, then this
7683 Perl_sv_isobject(pTHX_ SV *sv)
7700 Returns a boolean indicating whether the SV is blessed into the specified
7701 class. This does not check for subtypes; use C<sv_derived_from> to verify
7702 an inheritance relationship.
7708 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7720 return strEQ(HvNAME(SvSTASH(sv)), name);
7726 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7727 it will be upgraded to one. If C<classname> is non-null then the new SV will
7728 be blessed in the specified package. The new SV is returned and its
7729 reference count is 1.
7735 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7741 SV_CHECK_THINKFIRST_COW_DROP(rv);
7744 if (SvTYPE(rv) >= SVt_PVMG) {
7745 U32 refcnt = SvREFCNT(rv);
7749 SvREFCNT(rv) = refcnt;
7752 if (SvTYPE(rv) < SVt_RV)
7753 sv_upgrade(rv, SVt_RV);
7754 else if (SvTYPE(rv) > SVt_RV) {
7755 (void)SvOOK_off(rv);
7756 if (SvPVX(rv) && SvLEN(rv))
7757 Safefree(SvPVX(rv));
7767 HV* stash = gv_stashpv(classname, TRUE);
7768 (void)sv_bless(rv, stash);
7774 =for apidoc sv_setref_pv
7776 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7777 argument will be upgraded to an RV. That RV will be modified to point to
7778 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7779 into the SV. The C<classname> argument indicates the package for the
7780 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7781 will be returned and will have a reference count of 1.
7783 Do not use with other Perl types such as HV, AV, SV, CV, because those
7784 objects will become corrupted by the pointer copy process.
7786 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7792 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7795 sv_setsv(rv, &PL_sv_undef);
7799 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7804 =for apidoc sv_setref_iv
7806 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7807 argument will be upgraded to an RV. That RV will be modified to point to
7808 the new SV. The C<classname> argument indicates the package for the
7809 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7810 will be returned and will have a reference count of 1.
7816 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7818 sv_setiv(newSVrv(rv,classname), iv);
7823 =for apidoc sv_setref_uv
7825 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7826 argument will be upgraded to an RV. That RV will be modified to point to
7827 the new SV. The C<classname> argument indicates the package for the
7828 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7829 will be returned and will have a reference count of 1.
7835 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7837 sv_setuv(newSVrv(rv,classname), uv);
7842 =for apidoc sv_setref_nv
7844 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7845 argument will be upgraded to an RV. That RV will be modified to point to
7846 the new SV. The C<classname> argument indicates the package for the
7847 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7848 will be returned and will have a reference count of 1.
7854 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7856 sv_setnv(newSVrv(rv,classname), nv);
7861 =for apidoc sv_setref_pvn
7863 Copies a string into a new SV, optionally blessing the SV. The length of the
7864 string must be specified with C<n>. The C<rv> argument will be upgraded to
7865 an RV. That RV will be modified to point to the new SV. The C<classname>
7866 argument indicates the package for the blessing. Set C<classname> to
7867 C<Nullch> to avoid the blessing. The new SV will be returned and will have
7868 a reference count of 1.
7870 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7876 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
7878 sv_setpvn(newSVrv(rv,classname), pv, n);
7883 =for apidoc sv_bless
7885 Blesses an SV into a specified package. The SV must be an RV. The package
7886 must be designated by its stash (see C<gv_stashpv()>). The reference count
7887 of the SV is unaffected.
7893 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7897 Perl_croak(aTHX_ "Can't bless non-reference value");
7899 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7900 if (SvREADONLY(tmpRef))
7901 Perl_croak(aTHX_ PL_no_modify);
7902 if (SvOBJECT(tmpRef)) {
7903 if (SvTYPE(tmpRef) != SVt_PVIO)
7905 SvREFCNT_dec(SvSTASH(tmpRef));
7908 SvOBJECT_on(tmpRef);
7909 if (SvTYPE(tmpRef) != SVt_PVIO)
7911 (void)SvUPGRADE(tmpRef, SVt_PVMG);
7912 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
7919 if(SvSMAGICAL(tmpRef))
7920 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7928 /* Downgrades a PVGV to a PVMG.
7932 S_sv_unglob(pTHX_ SV *sv)
7936 assert(SvTYPE(sv) == SVt_PVGV);
7941 SvREFCNT_dec(GvSTASH(sv));
7942 GvSTASH(sv) = Nullhv;
7944 sv_unmagic(sv, PERL_MAGIC_glob);
7945 Safefree(GvNAME(sv));
7948 /* need to keep SvANY(sv) in the right arena */
7949 xpvmg = new_XPVMG();
7950 StructCopy(SvANY(sv), xpvmg, XPVMG);
7951 del_XPVGV(SvANY(sv));
7954 SvFLAGS(sv) &= ~SVTYPEMASK;
7955 SvFLAGS(sv) |= SVt_PVMG;
7959 =for apidoc sv_unref_flags
7961 Unsets the RV status of the SV, and decrements the reference count of
7962 whatever was being referenced by the RV. This can almost be thought of
7963 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7964 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7965 (otherwise the decrementing is conditional on the reference count being
7966 different from one or the reference being a readonly SV).
7973 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
7977 if (SvWEAKREF(sv)) {
7985 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
7986 assigned to as BEGIN {$a = \"Foo"} will fail. */
7987 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
7989 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7990 sv_2mortal(rv); /* Schedule for freeing later */
7994 =for apidoc sv_unref
7996 Unsets the RV status of the SV, and decrements the reference count of
7997 whatever was being referenced by the RV. This can almost be thought of
7998 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
7999 being zero. See C<SvROK_off>.
8005 Perl_sv_unref(pTHX_ SV *sv)
8007 sv_unref_flags(sv, 0);
8011 =for apidoc sv_taint
8013 Taint an SV. Use C<SvTAINTED_on> instead.
8018 Perl_sv_taint(pTHX_ SV *sv)
8020 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8024 =for apidoc sv_untaint
8026 Untaint an SV. Use C<SvTAINTED_off> instead.
8031 Perl_sv_untaint(pTHX_ SV *sv)
8033 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8034 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8041 =for apidoc sv_tainted
8043 Test an SV for taintedness. Use C<SvTAINTED> instead.
8048 Perl_sv_tainted(pTHX_ SV *sv)
8050 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8051 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8052 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8058 #if defined(PERL_IMPLICIT_CONTEXT)
8060 /* pTHX_ magic can't cope with varargs, so this is a no-context
8061 * version of the main function, (which may itself be aliased to us).
8062 * Don't access this version directly.
8066 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8070 va_start(args, pat);
8071 sv_vsetpvf(sv, pat, &args);
8075 /* pTHX_ magic can't cope with varargs, so this is a no-context
8076 * version of the main function, (which may itself be aliased to us).
8077 * Don't access this version directly.
8081 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8085 va_start(args, pat);
8086 sv_vsetpvf_mg(sv, pat, &args);
8092 =for apidoc sv_setpvf
8094 Processes its arguments like C<sprintf> and sets an SV to the formatted
8095 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8101 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8104 va_start(args, pat);
8105 sv_vsetpvf(sv, pat, &args);
8109 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8112 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8114 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8118 =for apidoc sv_setpvf_mg
8120 Like C<sv_setpvf>, but also handles 'set' magic.
8126 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8129 va_start(args, pat);
8130 sv_vsetpvf_mg(sv, pat, &args);
8134 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8137 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8139 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8143 #if defined(PERL_IMPLICIT_CONTEXT)
8145 /* pTHX_ magic can't cope with varargs, so this is a no-context
8146 * version of the main function, (which may itself be aliased to us).
8147 * Don't access this version directly.
8151 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8155 va_start(args, pat);
8156 sv_vcatpvf(sv, pat, &args);
8160 /* pTHX_ magic can't cope with varargs, so this is a no-context
8161 * version of the main function, (which may itself be aliased to us).
8162 * Don't access this version directly.
8166 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8170 va_start(args, pat);
8171 sv_vcatpvf_mg(sv, pat, &args);
8177 =for apidoc sv_catpvf
8179 Processes its arguments like C<sprintf> and appends the formatted
8180 output to an SV. If the appended data contains "wide" characters
8181 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8182 and characters >255 formatted with %c), the original SV might get
8183 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8184 C<SvSETMAGIC()> must typically be called after calling this function
8185 to handle 'set' magic.
8190 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8193 va_start(args, pat);
8194 sv_vcatpvf(sv, pat, &args);
8198 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8201 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8203 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8207 =for apidoc sv_catpvf_mg
8209 Like C<sv_catpvf>, but also handles 'set' magic.
8215 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8218 va_start(args, pat);
8219 sv_vcatpvf_mg(sv, pat, &args);
8223 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
8226 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8228 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8233 =for apidoc sv_vsetpvfn
8235 Works like C<vcatpvfn> but copies the text into the SV instead of
8238 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
8244 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8246 sv_setpvn(sv, "", 0);
8247 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8250 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8253 S_expect_number(pTHX_ char** pattern)
8256 switch (**pattern) {
8257 case '1': case '2': case '3':
8258 case '4': case '5': case '6':
8259 case '7': case '8': case '9':
8260 while (isDIGIT(**pattern))
8261 var = var * 10 + (*(*pattern)++ - '0');
8265 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8268 =for apidoc sv_vcatpvfn
8270 Processes its arguments like C<vsprintf> and appends the formatted output
8271 to an SV. Uses an array of SVs if the C style variable argument list is
8272 missing (NULL). When running with taint checks enabled, indicates via
8273 C<maybe_tainted> if results are untrustworthy (often due to the use of
8276 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
8282 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8289 static char nullstr[] = "(null)";
8291 bool has_utf8; /* has the result utf8? */
8292 bool pat_utf8; /* the pattern is in utf8? */
8295 has_utf8 = pat_utf8 = DO_UTF8(sv);
8297 /* no matter what, this is a string now */
8298 (void)SvPV_force(sv, origlen);
8300 /* special-case "", "%s", and "%_" */
8303 if (patlen == 2 && pat[0] == '%') {
8307 char *s = va_arg(*args, char*);
8308 sv_catpv(sv, s ? s : nullstr);
8310 else if (svix < svmax) {
8311 sv_catsv(sv, *svargs);
8312 if (DO_UTF8(*svargs))
8318 argsv = va_arg(*args, SV*);
8319 sv_catsv(sv, argsv);
8324 /* See comment on '_' below */
8329 if (!args && svix < svmax && DO_UTF8(*svargs))
8332 patend = (char*)pat + patlen;
8333 for (p = (char*)pat; p < patend; p = q) {
8336 bool vectorize = FALSE;
8337 bool vectorarg = FALSE;
8338 bool vec_utf8 = FALSE;
8344 bool has_precis = FALSE;
8346 bool is_utf8 = FALSE; /* is this item utf8? */
8347 #ifdef HAS_LDBL_SPRINTF_BUG
8348 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8349 with sfio - Allen <allens@cpan.org> */
8350 bool fix_ldbl_sprintf_bug = FALSE;
8354 U8 utf8buf[UTF8_MAXLEN+1];
8355 STRLEN esignlen = 0;
8357 char *eptr = Nullch;
8359 /* Times 4: a decimal digit takes more than 3 binary digits.
8360 * NV_DIG: mantissa takes than many decimal digits.
8361 * Plus 32: Playing safe. */
8362 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8363 /* large enough for "%#.#f" --chip */
8364 /* what about long double NVs? --jhi */
8367 U8 *vecstr = Null(U8*);
8374 /* we need a long double target in case HAS_LONG_DOUBLE but
8377 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8386 STRLEN dotstrlen = 1;
8387 I32 efix = 0; /* explicit format parameter index */
8388 I32 ewix = 0; /* explicit width index */
8389 I32 epix = 0; /* explicit precision index */
8390 I32 evix = 0; /* explicit vector index */
8391 bool asterisk = FALSE;
8393 /* echo everything up to the next format specification */
8394 for (q = p; q < patend && *q != '%'; ++q) ;
8396 if (has_utf8 && !pat_utf8)
8397 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8399 sv_catpvn(sv, p, q - p);
8406 We allow format specification elements in this order:
8407 \d+\$ explicit format parameter index
8409 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8410 0 flag (as above): repeated to allow "v02"
8411 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8412 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8414 [%bcdefginopsux_DFOUX] format (mandatory)
8416 if (EXPECT_NUMBER(q, width)) {
8457 if (EXPECT_NUMBER(q, ewix))
8466 if ((vectorarg = asterisk)) {
8478 EXPECT_NUMBER(q, width);
8483 vecsv = va_arg(*args, SV*);
8485 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8486 svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
8487 dotstr = SvPVx(vecsv, dotstrlen);
8492 vecsv = va_arg(*args, SV*);
8493 vecstr = (U8*)SvPVx(vecsv,veclen);
8494 vec_utf8 = DO_UTF8(vecsv);
8496 else if (efix ? efix <= svmax : svix < svmax) {
8497 vecsv = svargs[efix ? efix-1 : svix++];
8498 vecstr = (U8*)SvPVx(vecsv,veclen);
8499 vec_utf8 = DO_UTF8(vecsv);
8509 i = va_arg(*args, int);
8511 i = (ewix ? ewix <= svmax : svix < svmax) ?
8512 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8514 width = (i < 0) ? -i : i;
8524 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8526 /* XXX: todo, support specified precision parameter */
8530 i = va_arg(*args, int);
8532 i = (ewix ? ewix <= svmax : svix < svmax)
8533 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8534 precis = (i < 0) ? 0 : i;
8539 precis = precis * 10 + (*q++ - '0');
8548 case 'I': /* Ix, I32x, and I64x */
8550 if (q[1] == '6' && q[2] == '4') {
8556 if (q[1] == '3' && q[2] == '2') {
8566 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8577 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8578 if (*(q + 1) == 'l') { /* lld, llf */
8603 argsv = (efix ? efix <= svmax : svix < svmax) ?
8604 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8611 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8613 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8615 eptr = (char*)utf8buf;
8616 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8627 if (args && !vectorize) {
8628 eptr = va_arg(*args, char*);
8630 #ifdef MACOS_TRADITIONAL
8631 /* On MacOS, %#s format is used for Pascal strings */
8636 elen = strlen(eptr);
8639 elen = sizeof nullstr - 1;
8643 eptr = SvPVx(argsv, elen);
8644 if (DO_UTF8(argsv)) {
8645 if (has_precis && precis < elen) {
8647 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8650 if (width) { /* fudge width (can't fudge elen) */
8651 width += elen - sv_len_utf8(argsv);
8660 * The "%_" hack might have to be changed someday,
8661 * if ISO or ANSI decide to use '_' for something.
8662 * So we keep it hidden from users' code.
8664 if (!args || vectorize)
8666 argsv = va_arg(*args, SV*);
8667 eptr = SvPVx(argsv, elen);
8673 if (has_precis && elen > precis)
8680 if (alt || vectorize)
8682 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8700 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8709 esignbuf[esignlen++] = plus;
8713 case 'h': iv = (short)va_arg(*args, int); break;
8714 default: iv = va_arg(*args, int); break;
8715 case 'l': iv = va_arg(*args, long); break;
8716 case 'V': iv = va_arg(*args, IV); break;
8718 case 'q': iv = va_arg(*args, Quad_t); break;
8725 case 'h': iv = (short)iv; break;
8727 case 'l': iv = (long)iv; break;
8730 case 'q': iv = (Quad_t)iv; break;
8734 if ( !vectorize ) /* we already set uv above */
8739 esignbuf[esignlen++] = plus;
8743 esignbuf[esignlen++] = '-';
8786 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8797 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8798 default: uv = va_arg(*args, unsigned); break;
8799 case 'l': uv = va_arg(*args, unsigned long); break;
8800 case 'V': uv = va_arg(*args, UV); break;
8802 case 'q': uv = va_arg(*args, Quad_t); break;
8809 case 'h': uv = (unsigned short)uv; break;
8811 case 'l': uv = (unsigned long)uv; break;
8814 case 'q': uv = (Quad_t)uv; break;
8820 eptr = ebuf + sizeof ebuf;
8826 p = (char*)((c == 'X')
8827 ? "0123456789ABCDEF" : "0123456789abcdef");
8833 esignbuf[esignlen++] = '0';
8834 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8840 *--eptr = '0' + dig;
8842 if (alt && *eptr != '0')
8848 *--eptr = '0' + dig;
8851 esignbuf[esignlen++] = '0';
8852 esignbuf[esignlen++] = 'b';
8855 default: /* it had better be ten or less */
8856 #if defined(PERL_Y2KWARN)
8857 if (ckWARN(WARN_Y2K)) {
8859 char *s = SvPV(sv,n);
8860 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
8861 && (n == 2 || !isDIGIT(s[n-3])))
8863 Perl_warner(aTHX_ packWARN(WARN_Y2K),
8864 "Possible Y2K bug: %%%c %s",
8865 c, "format string following '19'");
8871 *--eptr = '0' + dig;
8872 } while (uv /= base);
8875 elen = (ebuf + sizeof ebuf) - eptr;
8878 zeros = precis - elen;
8879 else if (precis == 0 && elen == 1 && *eptr == '0')
8884 /* FLOATING POINT */
8887 c = 'f'; /* maybe %F isn't supported here */
8893 /* This is evil, but floating point is even more evil */
8895 /* for SV-style calling, we can only get NV
8896 for C-style calling, we assume %f is double;
8897 for simplicity we allow any of %Lf, %llf, %qf for long double
8901 #if defined(USE_LONG_DOUBLE)
8905 /* [perl #20339] - we should accept and ignore %lf rather than die */
8909 #if defined(USE_LONG_DOUBLE)
8910 intsize = args ? 0 : 'q';
8914 #if defined(HAS_LONG_DOUBLE)
8923 /* now we need (long double) if intsize == 'q', else (double) */
8924 nv = (args && !vectorize) ?
8925 #if LONG_DOUBLESIZE > DOUBLESIZE
8927 va_arg(*args, long double) :
8928 va_arg(*args, double)
8930 va_arg(*args, double)
8936 if (c != 'e' && c != 'E') {
8938 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8939 will cast our (long double) to (double) */
8940 (void)Perl_frexp(nv, &i);
8941 if (i == PERL_INT_MIN)
8942 Perl_die(aTHX_ "panic: frexp");
8944 need = BIT_DIGITS(i);
8946 need += has_precis ? precis : 6; /* known default */
8951 #ifdef HAS_LDBL_SPRINTF_BUG
8952 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8953 with sfio - Allen <allens@cpan.org> */
8956 # define MY_DBL_MAX DBL_MAX
8957 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8958 # if DOUBLESIZE >= 8
8959 # define MY_DBL_MAX 1.7976931348623157E+308L
8961 # define MY_DBL_MAX 3.40282347E+38L
8965 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8966 # define MY_DBL_MAX_BUG 1L
8968 # define MY_DBL_MAX_BUG MY_DBL_MAX
8972 # define MY_DBL_MIN DBL_MIN
8973 # else /* XXX guessing! -Allen */
8974 # if DOUBLESIZE >= 8
8975 # define MY_DBL_MIN 2.2250738585072014E-308L
8977 # define MY_DBL_MIN 1.17549435E-38L
8981 if ((intsize == 'q') && (c == 'f') &&
8982 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8984 /* it's going to be short enough that
8985 * long double precision is not needed */
8987 if ((nv <= 0L) && (nv >= -0L))
8988 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8990 /* would use Perl_fp_class as a double-check but not
8991 * functional on IRIX - see perl.h comments */
8993 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8994 /* It's within the range that a double can represent */
8995 #if defined(DBL_MAX) && !defined(DBL_MIN)
8996 if ((nv >= ((long double)1/DBL_MAX)) ||
8997 (nv <= (-(long double)1/DBL_MAX)))
8999 fix_ldbl_sprintf_bug = TRUE;
9002 if (fix_ldbl_sprintf_bug == TRUE) {
9012 # undef MY_DBL_MAX_BUG
9015 #endif /* HAS_LDBL_SPRINTF_BUG */
9017 need += 20; /* fudge factor */
9018 if (PL_efloatsize < need) {
9019 Safefree(PL_efloatbuf);
9020 PL_efloatsize = need + 20; /* more fudge */
9021 New(906, PL_efloatbuf, PL_efloatsize, char);
9022 PL_efloatbuf[0] = '\0';
9025 eptr = ebuf + sizeof ebuf;
9028 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9029 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9030 if (intsize == 'q') {
9031 /* Copy the one or more characters in a long double
9032 * format before the 'base' ([efgEFG]) character to
9033 * the format string. */
9034 static char const prifldbl[] = PERL_PRIfldbl;
9035 char const *p = prifldbl + sizeof(prifldbl) - 3;
9036 while (p >= prifldbl) { *--eptr = *p--; }
9041 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9046 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9058 /* No taint. Otherwise we are in the strange situation
9059 * where printf() taints but print($float) doesn't.
9061 #if defined(HAS_LONG_DOUBLE)
9063 (void)sprintf(PL_efloatbuf, eptr, nv);
9065 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9067 (void)sprintf(PL_efloatbuf, eptr, nv);
9069 eptr = PL_efloatbuf;
9070 elen = strlen(PL_efloatbuf);
9076 i = SvCUR(sv) - origlen;
9077 if (args && !vectorize) {
9079 case 'h': *(va_arg(*args, short*)) = i; break;
9080 default: *(va_arg(*args, int*)) = i; break;
9081 case 'l': *(va_arg(*args, long*)) = i; break;
9082 case 'V': *(va_arg(*args, IV*)) = i; break;
9084 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9089 sv_setuv_mg(argsv, (UV)i);
9091 continue; /* not "break" */
9098 if (!args && ckWARN(WARN_PRINTF) &&
9099 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9100 SV *msg = sv_newmortal();
9101 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9102 (PL_op->op_type == OP_PRTF) ? "" : "s");
9105 Perl_sv_catpvf(aTHX_ msg,
9106 "\"%%%c\"", c & 0xFF);
9108 Perl_sv_catpvf(aTHX_ msg,
9109 "\"%%\\%03"UVof"\"",
9112 sv_catpv(msg, "end of string");
9113 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9116 /* output mangled stuff ... */
9122 /* ... right here, because formatting flags should not apply */
9123 SvGROW(sv, SvCUR(sv) + elen + 1);
9125 Copy(eptr, p, elen, char);
9128 SvCUR(sv) = p - SvPVX(sv);
9129 continue; /* not "break" */
9132 if (is_utf8 != has_utf8) {
9135 sv_utf8_upgrade(sv);
9138 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9139 sv_utf8_upgrade(nsv);
9143 SvGROW(sv, SvCUR(sv) + elen + 1);
9148 have = esignlen + zeros + elen;
9149 need = (have > width ? have : width);
9152 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9154 if (esignlen && fill == '0') {
9155 for (i = 0; i < (int)esignlen; i++)
9159 memset(p, fill, gap);
9162 if (esignlen && fill != '0') {
9163 for (i = 0; i < (int)esignlen; i++)
9167 for (i = zeros; i; i--)
9171 Copy(eptr, p, elen, char);
9175 memset(p, ' ', gap);
9180 Copy(dotstr, p, dotstrlen, char);
9184 vectorize = FALSE; /* done iterating over vecstr */
9191 SvCUR(sv) = p - SvPVX(sv);
9199 /* =========================================================================
9201 =head1 Cloning an interpreter
9203 All the macros and functions in this section are for the private use of
9204 the main function, perl_clone().
9206 The foo_dup() functions make an exact copy of an existing foo thinngy.
9207 During the course of a cloning, a hash table is used to map old addresses
9208 to new addresses. The table is created and manipulated with the
9209 ptr_table_* functions.
9213 ============================================================================*/
9216 #if defined(USE_ITHREADS)
9218 #ifndef GpREFCNT_inc
9219 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9223 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9224 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9225 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9226 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9227 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9228 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9229 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9230 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9231 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9232 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9233 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9234 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9235 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9238 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9239 regcomp.c. AMS 20010712 */
9242 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
9246 struct reg_substr_datum *s;
9249 return (REGEXP *)NULL;
9251 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9254 len = r->offsets[0];
9255 npar = r->nparens+1;
9257 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9258 Copy(r->program, ret->program, len+1, regnode);
9260 New(0, ret->startp, npar, I32);
9261 Copy(r->startp, ret->startp, npar, I32);
9262 New(0, ret->endp, npar, I32);
9263 Copy(r->startp, ret->startp, npar, I32);
9265 New(0, ret->substrs, 1, struct reg_substr_data);
9266 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9267 s->min_offset = r->substrs->data[i].min_offset;
9268 s->max_offset = r->substrs->data[i].max_offset;
9269 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9270 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9273 ret->regstclass = NULL;
9276 int count = r->data->count;
9278 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9279 char, struct reg_data);
9280 New(0, d->what, count, U8);
9283 for (i = 0; i < count; i++) {
9284 d->what[i] = r->data->what[i];
9285 switch (d->what[i]) {
9287 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9290 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9293 /* This is cheating. */
9294 New(0, d->data[i], 1, struct regnode_charclass_class);
9295 StructCopy(r->data->data[i], d->data[i],
9296 struct regnode_charclass_class);
9297 ret->regstclass = (regnode*)d->data[i];
9300 /* Compiled op trees are readonly, and can thus be
9301 shared without duplication. */
9302 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9305 d->data[i] = r->data->data[i];
9315 New(0, ret->offsets, 2*len+1, U32);
9316 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9318 ret->precomp = SAVEPV(r->precomp);
9319 ret->refcnt = r->refcnt;
9320 ret->minlen = r->minlen;
9321 ret->prelen = r->prelen;
9322 ret->nparens = r->nparens;
9323 ret->lastparen = r->lastparen;
9324 ret->lastcloseparen = r->lastcloseparen;
9325 ret->reganch = r->reganch;
9327 ret->sublen = r->sublen;
9329 if (RX_MATCH_COPIED(ret))
9330 ret->subbeg = SAVEPV(r->subbeg);
9332 ret->subbeg = Nullch;
9333 #ifdef PERL_COPY_ON_WRITE
9334 ret->saved_copy = Nullsv;
9337 ptr_table_store(PL_ptr_table, r, ret);
9341 /* duplicate a file handle */
9344 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9348 return (PerlIO*)NULL;
9350 /* look for it in the table first */
9351 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9355 /* create anew and remember what it is */
9356 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9357 ptr_table_store(PL_ptr_table, fp, ret);
9361 /* duplicate a directory handle */
9364 Perl_dirp_dup(pTHX_ DIR *dp)
9372 /* duplicate a typeglob */
9375 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9380 /* look for it in the table first */
9381 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9385 /* create anew and remember what it is */
9386 Newz(0, ret, 1, GP);
9387 ptr_table_store(PL_ptr_table, gp, ret);
9390 ret->gp_refcnt = 0; /* must be before any other dups! */
9391 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9392 ret->gp_io = io_dup_inc(gp->gp_io, param);
9393 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9394 ret->gp_av = av_dup_inc(gp->gp_av, param);
9395 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9396 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9397 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9398 ret->gp_cvgen = gp->gp_cvgen;
9399 ret->gp_flags = gp->gp_flags;
9400 ret->gp_line = gp->gp_line;
9401 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9405 /* duplicate a chain of magic */
9408 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9410 MAGIC *mgprev = (MAGIC*)NULL;
9413 return (MAGIC*)NULL;
9414 /* look for it in the table first */
9415 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9419 for (; mg; mg = mg->mg_moremagic) {
9421 Newz(0, nmg, 1, MAGIC);
9423 mgprev->mg_moremagic = nmg;
9426 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9427 nmg->mg_private = mg->mg_private;
9428 nmg->mg_type = mg->mg_type;
9429 nmg->mg_flags = mg->mg_flags;
9430 if (mg->mg_type == PERL_MAGIC_qr) {
9431 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9433 else if(mg->mg_type == PERL_MAGIC_backref) {
9434 AV *av = (AV*) mg->mg_obj;
9437 nmg->mg_obj = (SV*)newAV();
9441 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9446 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9447 ? sv_dup_inc(mg->mg_obj, param)
9448 : sv_dup(mg->mg_obj, param);
9450 nmg->mg_len = mg->mg_len;
9451 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9452 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9453 if (mg->mg_len > 0) {
9454 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9455 if (mg->mg_type == PERL_MAGIC_overload_table &&
9456 AMT_AMAGIC((AMT*)mg->mg_ptr))
9458 AMT *amtp = (AMT*)mg->mg_ptr;
9459 AMT *namtp = (AMT*)nmg->mg_ptr;
9461 for (i = 1; i < NofAMmeth; i++) {
9462 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9466 else if (mg->mg_len == HEf_SVKEY)
9467 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9469 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9470 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9477 /* create a new pointer-mapping table */
9480 Perl_ptr_table_new(pTHX)
9483 Newz(0, tbl, 1, PTR_TBL_t);
9486 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9490 /* map an existing pointer using a table */
9493 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
9495 PTR_TBL_ENT_t *tblent;
9496 UV hash = PTR2UV(sv);
9498 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9499 for (; tblent; tblent = tblent->next) {
9500 if (tblent->oldval == sv)
9501 return tblent->newval;
9506 /* add a new entry to a pointer-mapping table */
9509 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
9511 PTR_TBL_ENT_t *tblent, **otblent;
9512 /* XXX this may be pessimal on platforms where pointers aren't good
9513 * hash values e.g. if they grow faster in the most significant
9515 UV hash = PTR2UV(oldv);
9519 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9520 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
9521 if (tblent->oldval == oldv) {
9522 tblent->newval = newv;
9526 Newz(0, tblent, 1, PTR_TBL_ENT_t);
9527 tblent->oldval = oldv;
9528 tblent->newval = newv;
9529 tblent->next = *otblent;
9532 if (i && tbl->tbl_items > tbl->tbl_max)
9533 ptr_table_split(tbl);
9536 /* double the hash bucket size of an existing ptr table */
9539 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9541 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9542 UV oldsize = tbl->tbl_max + 1;
9543 UV newsize = oldsize * 2;
9546 Renew(ary, newsize, PTR_TBL_ENT_t*);
9547 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9548 tbl->tbl_max = --newsize;
9550 for (i=0; i < oldsize; i++, ary++) {
9551 PTR_TBL_ENT_t **curentp, **entp, *ent;
9554 curentp = ary + oldsize;
9555 for (entp = ary, ent = *ary; ent; ent = *entp) {
9556 if ((newsize & PTR2UV(ent->oldval)) != i) {
9558 ent->next = *curentp;
9568 /* remove all the entries from a ptr table */
9571 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9573 register PTR_TBL_ENT_t **array;
9574 register PTR_TBL_ENT_t *entry;
9575 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
9579 if (!tbl || !tbl->tbl_items) {
9583 array = tbl->tbl_ary;
9590 entry = entry->next;
9594 if (++riter > max) {
9597 entry = array[riter];
9604 /* clear and free a ptr table */
9607 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9612 ptr_table_clear(tbl);
9613 Safefree(tbl->tbl_ary);
9621 /* attempt to make everything in the typeglob readonly */
9624 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
9627 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
9629 if (GvIO(gv) || GvFORM(gv)) {
9630 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
9632 else if (!GvCV(gv)) {
9636 /* CvPADLISTs cannot be shared */
9637 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
9642 if (!GvUNIQUE(gv)) {
9644 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
9645 HvNAME(GvSTASH(gv)), GvNAME(gv));
9651 * write attempts will die with
9652 * "Modification of a read-only value attempted"
9658 SvREADONLY_on(GvSV(gv));
9665 SvREADONLY_on(GvAV(gv));
9672 SvREADONLY_on(GvAV(gv));
9675 return sstr; /* he_dup() will SvREFCNT_inc() */
9678 /* duplicate an SV of any type (including AV, HV etc) */
9681 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9684 SvRV(dstr) = SvWEAKREF(sstr)
9685 ? sv_dup(SvRV(sstr), param)
9686 : sv_dup_inc(SvRV(sstr), param);
9688 else if (SvPVX(sstr)) {
9689 /* Has something there */
9691 /* Normal PV - clone whole allocated space */
9692 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9693 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9694 /* Not that normal - actually sstr is copy on write.
9695 But we are a true, independant SV, so: */
9696 SvREADONLY_off(dstr);
9701 /* Special case - not normally malloced for some reason */
9702 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9703 /* A "shared" PV - clone it as unshared string */
9705 SvREADONLY_off(dstr);
9706 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
9709 /* Some other special case - random pointer */
9710 SvPVX(dstr) = SvPVX(sstr);
9716 SvPVX(dstr) = SvPVX(sstr);
9721 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9725 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9727 /* look for it in the table first */
9728 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9732 if(param->flags & CLONEf_JOIN_IN) {
9733 /** We are joining here so we don't want do clone
9734 something that is bad **/
9736 if(SvTYPE(sstr) == SVt_PVHV &&
9738 /** don't clone stashes if they already exist **/
9739 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
9740 return (SV*) old_stash;
9744 /* create anew and remember what it is */
9746 ptr_table_store(PL_ptr_table, sstr, dstr);
9749 SvFLAGS(dstr) = SvFLAGS(sstr);
9750 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9751 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9754 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
9755 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9756 PL_watch_pvx, SvPVX(sstr));
9759 switch (SvTYPE(sstr)) {
9764 SvANY(dstr) = new_XIV();
9765 SvIVX(dstr) = SvIVX(sstr);
9768 SvANY(dstr) = new_XNV();
9769 SvNVX(dstr) = SvNVX(sstr);
9772 SvANY(dstr) = new_XRV();
9773 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9776 SvANY(dstr) = new_XPV();
9777 SvCUR(dstr) = SvCUR(sstr);
9778 SvLEN(dstr) = SvLEN(sstr);
9779 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9782 SvANY(dstr) = new_XPVIV();
9783 SvCUR(dstr) = SvCUR(sstr);
9784 SvLEN(dstr) = SvLEN(sstr);
9785 SvIVX(dstr) = SvIVX(sstr);
9786 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9789 SvANY(dstr) = new_XPVNV();
9790 SvCUR(dstr) = SvCUR(sstr);
9791 SvLEN(dstr) = SvLEN(sstr);
9792 SvIVX(dstr) = SvIVX(sstr);
9793 SvNVX(dstr) = SvNVX(sstr);
9794 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9797 SvANY(dstr) = new_XPVMG();
9798 SvCUR(dstr) = SvCUR(sstr);
9799 SvLEN(dstr) = SvLEN(sstr);
9800 SvIVX(dstr) = SvIVX(sstr);
9801 SvNVX(dstr) = SvNVX(sstr);
9802 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9803 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9804 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9807 SvANY(dstr) = new_XPVBM();
9808 SvCUR(dstr) = SvCUR(sstr);
9809 SvLEN(dstr) = SvLEN(sstr);
9810 SvIVX(dstr) = SvIVX(sstr);
9811 SvNVX(dstr) = SvNVX(sstr);
9812 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9813 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9814 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9815 BmRARE(dstr) = BmRARE(sstr);
9816 BmUSEFUL(dstr) = BmUSEFUL(sstr);
9817 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
9820 SvANY(dstr) = new_XPVLV();
9821 SvCUR(dstr) = SvCUR(sstr);
9822 SvLEN(dstr) = SvLEN(sstr);
9823 SvIVX(dstr) = SvIVX(sstr);
9824 SvNVX(dstr) = SvNVX(sstr);
9825 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9826 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9827 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9828 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
9829 LvTARGLEN(dstr) = LvTARGLEN(sstr);
9830 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
9831 LvTYPE(dstr) = LvTYPE(sstr);
9834 if (GvUNIQUE((GV*)sstr)) {
9836 if ((share = gv_share(sstr, param))) {
9839 ptr_table_store(PL_ptr_table, sstr, dstr);
9841 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
9842 HvNAME(GvSTASH(share)), GvNAME(share));
9847 SvANY(dstr) = new_XPVGV();
9848 SvCUR(dstr) = SvCUR(sstr);
9849 SvLEN(dstr) = SvLEN(sstr);
9850 SvIVX(dstr) = SvIVX(sstr);
9851 SvNVX(dstr) = SvNVX(sstr);
9852 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9853 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9854 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9855 GvNAMELEN(dstr) = GvNAMELEN(sstr);
9856 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
9857 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
9858 GvFLAGS(dstr) = GvFLAGS(sstr);
9859 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9860 (void)GpREFCNT_inc(GvGP(dstr));
9863 SvANY(dstr) = new_XPVIO();
9864 SvCUR(dstr) = SvCUR(sstr);
9865 SvLEN(dstr) = SvLEN(sstr);
9866 SvIVX(dstr) = SvIVX(sstr);
9867 SvNVX(dstr) = SvNVX(sstr);
9868 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9869 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9870 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9871 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
9872 if (IoOFP(sstr) == IoIFP(sstr))
9873 IoOFP(dstr) = IoIFP(dstr);
9875 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
9876 /* PL_rsfp_filters entries have fake IoDIRP() */
9877 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
9878 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
9880 IoDIRP(dstr) = IoDIRP(sstr);
9881 IoLINES(dstr) = IoLINES(sstr);
9882 IoPAGE(dstr) = IoPAGE(sstr);
9883 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
9884 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
9885 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
9886 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
9887 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
9888 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
9889 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
9890 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
9891 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
9892 IoTYPE(dstr) = IoTYPE(sstr);
9893 IoFLAGS(dstr) = IoFLAGS(sstr);
9896 SvANY(dstr) = new_XPVAV();
9897 SvCUR(dstr) = SvCUR(sstr);
9898 SvLEN(dstr) = SvLEN(sstr);
9899 SvIVX(dstr) = SvIVX(sstr);
9900 SvNVX(dstr) = SvNVX(sstr);
9901 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9902 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9903 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
9904 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
9905 if (AvARRAY((AV*)sstr)) {
9906 SV **dst_ary, **src_ary;
9907 SSize_t items = AvFILLp((AV*)sstr) + 1;
9909 src_ary = AvARRAY((AV*)sstr);
9910 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
9911 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9912 SvPVX(dstr) = (char*)dst_ary;
9913 AvALLOC((AV*)dstr) = dst_ary;
9914 if (AvREAL((AV*)sstr)) {
9916 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9920 *dst_ary++ = sv_dup(*src_ary++, param);
9922 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9923 while (items-- > 0) {
9924 *dst_ary++ = &PL_sv_undef;
9928 SvPVX(dstr) = Nullch;
9929 AvALLOC((AV*)dstr) = (SV**)NULL;
9933 SvANY(dstr) = new_XPVHV();
9934 SvCUR(dstr) = SvCUR(sstr);
9935 SvLEN(dstr) = SvLEN(sstr);
9936 SvIVX(dstr) = SvIVX(sstr);
9937 SvNVX(dstr) = SvNVX(sstr);
9938 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9939 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9940 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
9941 if (HvARRAY((HV*)sstr)) {
9943 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
9944 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
9945 Newz(0, dxhv->xhv_array,
9946 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
9947 while (i <= sxhv->xhv_max) {
9948 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
9949 (bool)!!HvSHAREKEYS(sstr),
9953 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
9954 (bool)!!HvSHAREKEYS(sstr), param);
9957 SvPVX(dstr) = Nullch;
9958 HvEITER((HV*)dstr) = (HE*)NULL;
9960 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
9961 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
9962 /* Record stashes for possible cloning in Perl_clone(). */
9963 if(HvNAME((HV*)dstr))
9964 av_push(param->stashes, dstr);
9967 SvANY(dstr) = new_XPVFM();
9968 FmLINES(dstr) = FmLINES(sstr);
9972 SvANY(dstr) = new_XPVCV();
9974 SvCUR(dstr) = SvCUR(sstr);
9975 SvLEN(dstr) = SvLEN(sstr);
9976 SvIVX(dstr) = SvIVX(sstr);
9977 SvNVX(dstr) = SvNVX(sstr);
9978 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9979 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9980 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9981 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
9982 CvSTART(dstr) = CvSTART(sstr);
9983 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
9984 CvXSUB(dstr) = CvXSUB(sstr);
9985 CvXSUBANY(dstr) = CvXSUBANY(sstr);
9986 if (CvCONST(sstr)) {
9987 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
9988 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
9989 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
9991 CvGV(dstr) = gv_dup(CvGV(sstr), param);
9992 if (param->flags & CLONEf_COPY_STACKS) {
9993 CvDEPTH(dstr) = CvDEPTH(sstr);
9997 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9998 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10000 CvWEAKOUTSIDE(sstr)
10001 ? cv_dup( CvOUTSIDE(sstr), param)
10002 : cv_dup_inc(CvOUTSIDE(sstr), param);
10003 CvFLAGS(dstr) = CvFLAGS(sstr);
10004 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10007 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10011 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10017 /* duplicate a context */
10020 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10022 PERL_CONTEXT *ncxs;
10025 return (PERL_CONTEXT*)NULL;
10027 /* look for it in the table first */
10028 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10032 /* create anew and remember what it is */
10033 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10034 ptr_table_store(PL_ptr_table, cxs, ncxs);
10037 PERL_CONTEXT *cx = &cxs[ix];
10038 PERL_CONTEXT *ncx = &ncxs[ix];
10039 ncx->cx_type = cx->cx_type;
10040 if (CxTYPE(cx) == CXt_SUBST) {
10041 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10044 ncx->blk_oldsp = cx->blk_oldsp;
10045 ncx->blk_oldcop = cx->blk_oldcop;
10046 ncx->blk_oldretsp = cx->blk_oldretsp;
10047 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10048 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10049 ncx->blk_oldpm = cx->blk_oldpm;
10050 ncx->blk_gimme = cx->blk_gimme;
10051 switch (CxTYPE(cx)) {
10053 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10054 ? cv_dup_inc(cx->blk_sub.cv, param)
10055 : cv_dup(cx->blk_sub.cv,param));
10056 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10057 ? av_dup_inc(cx->blk_sub.argarray, param)
10059 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10060 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10061 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10062 ncx->blk_sub.lval = cx->blk_sub.lval;
10065 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10066 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10067 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10068 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10069 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10072 ncx->blk_loop.label = cx->blk_loop.label;
10073 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10074 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10075 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10076 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10077 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10078 ? cx->blk_loop.iterdata
10079 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10080 ncx->blk_loop.oldcomppad
10081 = (PAD*)ptr_table_fetch(PL_ptr_table,
10082 cx->blk_loop.oldcomppad);
10083 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10084 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10085 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10086 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10087 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10090 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10091 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10092 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10093 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10105 /* duplicate a stack info structure */
10108 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10113 return (PERL_SI*)NULL;
10115 /* look for it in the table first */
10116 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10120 /* create anew and remember what it is */
10121 Newz(56, nsi, 1, PERL_SI);
10122 ptr_table_store(PL_ptr_table, si, nsi);
10124 nsi->si_stack = av_dup_inc(si->si_stack, param);
10125 nsi->si_cxix = si->si_cxix;
10126 nsi->si_cxmax = si->si_cxmax;
10127 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10128 nsi->si_type = si->si_type;
10129 nsi->si_prev = si_dup(si->si_prev, param);
10130 nsi->si_next = si_dup(si->si_next, param);
10131 nsi->si_markoff = si->si_markoff;
10136 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10137 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10138 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10139 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10140 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10141 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10142 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10143 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10144 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10145 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10146 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10147 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10148 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10149 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10152 #define pv_dup_inc(p) SAVEPV(p)
10153 #define pv_dup(p) SAVEPV(p)
10154 #define svp_dup_inc(p,pp) any_dup(p,pp)
10156 /* map any object to the new equivent - either something in the
10157 * ptr table, or something in the interpreter structure
10161 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10166 return (void*)NULL;
10168 /* look for it in the table first */
10169 ret = ptr_table_fetch(PL_ptr_table, v);
10173 /* see if it is part of the interpreter structure */
10174 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10175 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10183 /* duplicate the save stack */
10186 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10188 ANY *ss = proto_perl->Tsavestack;
10189 I32 ix = proto_perl->Tsavestack_ix;
10190 I32 max = proto_perl->Tsavestack_max;
10203 void (*dptr) (void*);
10204 void (*dxptr) (pTHX_ void*);
10207 Newz(54, nss, max, ANY);
10211 TOPINT(nss,ix) = i;
10213 case SAVEt_ITEM: /* normal string */
10214 sv = (SV*)POPPTR(ss,ix);
10215 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10216 sv = (SV*)POPPTR(ss,ix);
10217 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10219 case SAVEt_SV: /* scalar reference */
10220 sv = (SV*)POPPTR(ss,ix);
10221 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10222 gv = (GV*)POPPTR(ss,ix);
10223 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10225 case SAVEt_GENERIC_PVREF: /* generic char* */
10226 c = (char*)POPPTR(ss,ix);
10227 TOPPTR(nss,ix) = pv_dup(c);
10228 ptr = POPPTR(ss,ix);
10229 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10231 case SAVEt_SHARED_PVREF: /* char* in shared space */
10232 c = (char*)POPPTR(ss,ix);
10233 TOPPTR(nss,ix) = savesharedpv(c);
10234 ptr = POPPTR(ss,ix);
10235 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10237 case SAVEt_GENERIC_SVREF: /* generic sv */
10238 case SAVEt_SVREF: /* scalar reference */
10239 sv = (SV*)POPPTR(ss,ix);
10240 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10241 ptr = POPPTR(ss,ix);
10242 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10244 case SAVEt_AV: /* array reference */
10245 av = (AV*)POPPTR(ss,ix);
10246 TOPPTR(nss,ix) = av_dup_inc(av, param);
10247 gv = (GV*)POPPTR(ss,ix);
10248 TOPPTR(nss,ix) = gv_dup(gv, param);
10250 case SAVEt_HV: /* hash reference */
10251 hv = (HV*)POPPTR(ss,ix);
10252 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10253 gv = (GV*)POPPTR(ss,ix);
10254 TOPPTR(nss,ix) = gv_dup(gv, param);
10256 case SAVEt_INT: /* int reference */
10257 ptr = POPPTR(ss,ix);
10258 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10259 intval = (int)POPINT(ss,ix);
10260 TOPINT(nss,ix) = intval;
10262 case SAVEt_LONG: /* long reference */
10263 ptr = POPPTR(ss,ix);
10264 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10265 longval = (long)POPLONG(ss,ix);
10266 TOPLONG(nss,ix) = longval;
10268 case SAVEt_I32: /* I32 reference */
10269 case SAVEt_I16: /* I16 reference */
10270 case SAVEt_I8: /* I8 reference */
10271 ptr = POPPTR(ss,ix);
10272 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10274 TOPINT(nss,ix) = i;
10276 case SAVEt_IV: /* IV reference */
10277 ptr = POPPTR(ss,ix);
10278 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10280 TOPIV(nss,ix) = iv;
10282 case SAVEt_SPTR: /* SV* reference */
10283 ptr = POPPTR(ss,ix);
10284 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10285 sv = (SV*)POPPTR(ss,ix);
10286 TOPPTR(nss,ix) = sv_dup(sv, param);
10288 case SAVEt_VPTR: /* random* reference */
10289 ptr = POPPTR(ss,ix);
10290 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10291 ptr = POPPTR(ss,ix);
10292 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10294 case SAVEt_PPTR: /* char* reference */
10295 ptr = POPPTR(ss,ix);
10296 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10297 c = (char*)POPPTR(ss,ix);
10298 TOPPTR(nss,ix) = pv_dup(c);
10300 case SAVEt_HPTR: /* HV* reference */
10301 ptr = POPPTR(ss,ix);
10302 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10303 hv = (HV*)POPPTR(ss,ix);
10304 TOPPTR(nss,ix) = hv_dup(hv, param);
10306 case SAVEt_APTR: /* AV* reference */
10307 ptr = POPPTR(ss,ix);
10308 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10309 av = (AV*)POPPTR(ss,ix);
10310 TOPPTR(nss,ix) = av_dup(av, param);
10313 gv = (GV*)POPPTR(ss,ix);
10314 TOPPTR(nss,ix) = gv_dup(gv, param);
10316 case SAVEt_GP: /* scalar reference */
10317 gp = (GP*)POPPTR(ss,ix);
10318 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10319 (void)GpREFCNT_inc(gp);
10320 gv = (GV*)POPPTR(ss,ix);
10321 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10322 c = (char*)POPPTR(ss,ix);
10323 TOPPTR(nss,ix) = pv_dup(c);
10325 TOPIV(nss,ix) = iv;
10327 TOPIV(nss,ix) = iv;
10330 case SAVEt_MORTALIZESV:
10331 sv = (SV*)POPPTR(ss,ix);
10332 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10335 ptr = POPPTR(ss,ix);
10336 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10337 /* these are assumed to be refcounted properly */
10338 switch (((OP*)ptr)->op_type) {
10340 case OP_LEAVESUBLV:
10344 case OP_LEAVEWRITE:
10345 TOPPTR(nss,ix) = ptr;
10350 TOPPTR(nss,ix) = Nullop;
10355 TOPPTR(nss,ix) = Nullop;
10358 c = (char*)POPPTR(ss,ix);
10359 TOPPTR(nss,ix) = pv_dup_inc(c);
10361 case SAVEt_CLEARSV:
10362 longval = POPLONG(ss,ix);
10363 TOPLONG(nss,ix) = longval;
10366 hv = (HV*)POPPTR(ss,ix);
10367 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10368 c = (char*)POPPTR(ss,ix);
10369 TOPPTR(nss,ix) = pv_dup_inc(c);
10371 TOPINT(nss,ix) = i;
10373 case SAVEt_DESTRUCTOR:
10374 ptr = POPPTR(ss,ix);
10375 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10376 dptr = POPDPTR(ss,ix);
10377 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
10379 case SAVEt_DESTRUCTOR_X:
10380 ptr = POPPTR(ss,ix);
10381 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10382 dxptr = POPDXPTR(ss,ix);
10383 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
10385 case SAVEt_REGCONTEXT:
10388 TOPINT(nss,ix) = i;
10391 case SAVEt_STACK_POS: /* Position on Perl stack */
10393 TOPINT(nss,ix) = i;
10395 case SAVEt_AELEM: /* array element */
10396 sv = (SV*)POPPTR(ss,ix);
10397 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10399 TOPINT(nss,ix) = i;
10400 av = (AV*)POPPTR(ss,ix);
10401 TOPPTR(nss,ix) = av_dup_inc(av, param);
10403 case SAVEt_HELEM: /* hash element */
10404 sv = (SV*)POPPTR(ss,ix);
10405 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10406 sv = (SV*)POPPTR(ss,ix);
10407 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10408 hv = (HV*)POPPTR(ss,ix);
10409 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10412 ptr = POPPTR(ss,ix);
10413 TOPPTR(nss,ix) = ptr;
10417 TOPINT(nss,ix) = i;
10419 case SAVEt_COMPPAD:
10420 av = (AV*)POPPTR(ss,ix);
10421 TOPPTR(nss,ix) = av_dup(av, param);
10424 longval = (long)POPLONG(ss,ix);
10425 TOPLONG(nss,ix) = longval;
10426 ptr = POPPTR(ss,ix);
10427 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10428 sv = (SV*)POPPTR(ss,ix);
10429 TOPPTR(nss,ix) = sv_dup(sv, param);
10432 ptr = POPPTR(ss,ix);
10433 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10434 longval = (long)POPBOOL(ss,ix);
10435 TOPBOOL(nss,ix) = (bool)longval;
10438 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10446 =for apidoc perl_clone
10448 Create and return a new interpreter by cloning the current one.
10450 perl_clone takes these flags as paramters:
10452 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10453 without it we only clone the data and zero the stacks,
10454 with it we copy the stacks and the new perl interpreter is
10455 ready to run at the exact same point as the previous one.
10456 The pseudo-fork code uses COPY_STACKS while the
10457 threads->new doesn't.
10459 CLONEf_KEEP_PTR_TABLE
10460 perl_clone keeps a ptr_table with the pointer of the old
10461 variable as a key and the new variable as a value,
10462 this allows it to check if something has been cloned and not
10463 clone it again but rather just use the value and increase the
10464 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10465 the ptr_table using the function
10466 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10467 reason to keep it around is if you want to dup some of your own
10468 variable who are outside the graph perl scans, example of this
10469 code is in threads.xs create
10472 This is a win32 thing, it is ignored on unix, it tells perls
10473 win32host code (which is c++) to clone itself, this is needed on
10474 win32 if you want to run two threads at the same time,
10475 if you just want to do some stuff in a separate perl interpreter
10476 and then throw it away and return to the original one,
10477 you don't need to do anything.
10482 /* XXX the above needs expanding by someone who actually understands it ! */
10483 EXTERN_C PerlInterpreter *
10484 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10487 perl_clone(PerlInterpreter *proto_perl, UV flags)
10489 #ifdef PERL_IMPLICIT_SYS
10491 /* perlhost.h so we need to call into it
10492 to clone the host, CPerlHost should have a c interface, sky */
10494 if (flags & CLONEf_CLONE_HOST) {
10495 return perl_clone_host(proto_perl,flags);
10497 return perl_clone_using(proto_perl, flags,
10499 proto_perl->IMemShared,
10500 proto_perl->IMemParse,
10502 proto_perl->IStdIO,
10506 proto_perl->IProc);
10510 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10511 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10512 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10513 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10514 struct IPerlDir* ipD, struct IPerlSock* ipS,
10515 struct IPerlProc* ipP)
10517 /* XXX many of the string copies here can be optimized if they're
10518 * constants; they need to be allocated as common memory and just
10519 * their pointers copied. */
10522 CLONE_PARAMS clone_params;
10523 CLONE_PARAMS* param = &clone_params;
10525 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10526 PERL_SET_THX(my_perl);
10529 Poison(my_perl, 1, PerlInterpreter);
10534 PL_sig_pending = 0;
10535 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10536 # else /* !DEBUGGING */
10537 Zero(my_perl, 1, PerlInterpreter);
10538 # endif /* DEBUGGING */
10540 /* host pointers */
10542 PL_MemShared = ipMS;
10543 PL_MemParse = ipMP;
10550 #else /* !PERL_IMPLICIT_SYS */
10552 CLONE_PARAMS clone_params;
10553 CLONE_PARAMS* param = &clone_params;
10554 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10555 PERL_SET_THX(my_perl);
10560 Poison(my_perl, 1, PerlInterpreter);
10565 PL_sig_pending = 0;
10566 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10567 # else /* !DEBUGGING */
10568 Zero(my_perl, 1, PerlInterpreter);
10569 # endif /* DEBUGGING */
10570 #endif /* PERL_IMPLICIT_SYS */
10571 param->flags = flags;
10572 param->proto_perl = proto_perl;
10575 PL_xiv_arenaroot = NULL;
10576 PL_xiv_root = NULL;
10577 PL_xnv_arenaroot = NULL;
10578 PL_xnv_root = NULL;
10579 PL_xrv_arenaroot = NULL;
10580 PL_xrv_root = NULL;
10581 PL_xpv_arenaroot = NULL;
10582 PL_xpv_root = NULL;
10583 PL_xpviv_arenaroot = NULL;
10584 PL_xpviv_root = NULL;
10585 PL_xpvnv_arenaroot = NULL;
10586 PL_xpvnv_root = NULL;
10587 PL_xpvcv_arenaroot = NULL;
10588 PL_xpvcv_root = NULL;
10589 PL_xpvav_arenaroot = NULL;
10590 PL_xpvav_root = NULL;
10591 PL_xpvhv_arenaroot = NULL;
10592 PL_xpvhv_root = NULL;
10593 PL_xpvmg_arenaroot = NULL;
10594 PL_xpvmg_root = NULL;
10595 PL_xpvlv_arenaroot = NULL;
10596 PL_xpvlv_root = NULL;
10597 PL_xpvbm_arenaroot = NULL;
10598 PL_xpvbm_root = NULL;
10599 PL_he_arenaroot = NULL;
10601 PL_nice_chunk = NULL;
10602 PL_nice_chunk_size = 0;
10604 PL_sv_objcount = 0;
10605 PL_sv_root = Nullsv;
10606 PL_sv_arenaroot = Nullsv;
10608 PL_debug = proto_perl->Idebug;
10610 #ifdef USE_REENTRANT_API
10611 Perl_reentrant_init(aTHX);
10614 /* create SV map for pointer relocation */
10615 PL_ptr_table = ptr_table_new();
10617 /* initialize these special pointers as early as possible */
10618 SvANY(&PL_sv_undef) = NULL;
10619 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10620 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10621 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10623 SvANY(&PL_sv_no) = new_XPVNV();
10624 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10625 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10626 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
10627 SvCUR(&PL_sv_no) = 0;
10628 SvLEN(&PL_sv_no) = 1;
10629 SvNVX(&PL_sv_no) = 0;
10630 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10632 SvANY(&PL_sv_yes) = new_XPVNV();
10633 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10634 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10635 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
10636 SvCUR(&PL_sv_yes) = 1;
10637 SvLEN(&PL_sv_yes) = 2;
10638 SvNVX(&PL_sv_yes) = 1;
10639 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10641 /* create (a non-shared!) shared string table */
10642 PL_strtab = newHV();
10643 HvSHAREKEYS_off(PL_strtab);
10644 hv_ksplit(PL_strtab, 512);
10645 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10647 PL_compiling = proto_perl->Icompiling;
10649 /* These two PVs will be free'd special way so must set them same way op.c does */
10650 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10651 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10653 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10654 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10656 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10657 if (!specialWARN(PL_compiling.cop_warnings))
10658 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10659 if (!specialCopIO(PL_compiling.cop_io))
10660 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10661 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10663 /* pseudo environmental stuff */
10664 PL_origargc = proto_perl->Iorigargc;
10665 PL_origargv = proto_perl->Iorigargv;
10667 param->stashes = newAV(); /* Setup array of objects to call clone on */
10669 #ifdef PERLIO_LAYERS
10670 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10671 PerlIO_clone(aTHX_ proto_perl, param);
10674 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10675 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10676 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10677 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10678 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10679 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10682 PL_minus_c = proto_perl->Iminus_c;
10683 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10684 PL_localpatches = proto_perl->Ilocalpatches;
10685 PL_splitstr = proto_perl->Isplitstr;
10686 PL_preprocess = proto_perl->Ipreprocess;
10687 PL_minus_n = proto_perl->Iminus_n;
10688 PL_minus_p = proto_perl->Iminus_p;
10689 PL_minus_l = proto_perl->Iminus_l;
10690 PL_minus_a = proto_perl->Iminus_a;
10691 PL_minus_F = proto_perl->Iminus_F;
10692 PL_doswitches = proto_perl->Idoswitches;
10693 PL_dowarn = proto_perl->Idowarn;
10694 PL_doextract = proto_perl->Idoextract;
10695 PL_sawampersand = proto_perl->Isawampersand;
10696 PL_unsafe = proto_perl->Iunsafe;
10697 PL_inplace = SAVEPV(proto_perl->Iinplace);
10698 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10699 PL_perldb = proto_perl->Iperldb;
10700 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10701 PL_exit_flags = proto_perl->Iexit_flags;
10703 /* magical thingies */
10704 /* XXX time(&PL_basetime) when asked for? */
10705 PL_basetime = proto_perl->Ibasetime;
10706 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10708 PL_maxsysfd = proto_perl->Imaxsysfd;
10709 PL_multiline = proto_perl->Imultiline;
10710 PL_statusvalue = proto_perl->Istatusvalue;
10712 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10714 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10716 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10717 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10718 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10720 /* Clone the regex array */
10721 PL_regex_padav = newAV();
10723 I32 len = av_len((AV*)proto_perl->Iregex_padav);
10724 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10725 av_push(PL_regex_padav,
10726 sv_dup_inc(regexen[0],param));
10727 for(i = 1; i <= len; i++) {
10728 if(SvREPADTMP(regexen[i])) {
10729 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10731 av_push(PL_regex_padav,
10733 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10734 SvIVX(regexen[i])), param)))
10739 PL_regex_pad = AvARRAY(PL_regex_padav);
10741 /* shortcuts to various I/O objects */
10742 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10743 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10744 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10745 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10746 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10747 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10749 /* shortcuts to regexp stuff */
10750 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10752 /* shortcuts to misc objects */
10753 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10755 /* shortcuts to debugging objects */
10756 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10757 PL_DBline = gv_dup(proto_perl->IDBline, param);
10758 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10759 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10760 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10761 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10762 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10763 PL_lineary = av_dup(proto_perl->Ilineary, param);
10764 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10766 /* symbol tables */
10767 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10768 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10769 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10770 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10771 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10773 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10774 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10775 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10776 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10777 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10778 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10780 PL_sub_generation = proto_perl->Isub_generation;
10782 /* funky return mechanisms */
10783 PL_forkprocess = proto_perl->Iforkprocess;
10785 /* subprocess state */
10786 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10788 /* internal state */
10789 PL_tainting = proto_perl->Itainting;
10790 PL_maxo = proto_perl->Imaxo;
10791 if (proto_perl->Iop_mask)
10792 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10794 PL_op_mask = Nullch;
10795 /* PL_asserting = proto_perl->Iasserting; */
10797 /* current interpreter roots */
10798 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10799 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10800 PL_main_start = proto_perl->Imain_start;
10801 PL_eval_root = proto_perl->Ieval_root;
10802 PL_eval_start = proto_perl->Ieval_start;
10804 /* runtime control stuff */
10805 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10806 PL_copline = proto_perl->Icopline;
10808 PL_filemode = proto_perl->Ifilemode;
10809 PL_lastfd = proto_perl->Ilastfd;
10810 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10813 PL_gensym = proto_perl->Igensym;
10814 PL_preambled = proto_perl->Ipreambled;
10815 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10816 PL_laststatval = proto_perl->Ilaststatval;
10817 PL_laststype = proto_perl->Ilaststype;
10818 PL_mess_sv = Nullsv;
10820 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10821 PL_ofmt = SAVEPV(proto_perl->Iofmt);
10823 /* interpreter atexit processing */
10824 PL_exitlistlen = proto_perl->Iexitlistlen;
10825 if (PL_exitlistlen) {
10826 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10827 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10830 PL_exitlist = (PerlExitListEntry*)NULL;
10831 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10832 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10833 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10835 PL_profiledata = NULL;
10836 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10837 /* PL_rsfp_filters entries have fake IoDIRP() */
10838 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10840 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10842 PAD_CLONE_VARS(proto_perl, param);
10844 #ifdef HAVE_INTERP_INTERN
10845 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10848 /* more statics moved here */
10849 PL_generation = proto_perl->Igeneration;
10850 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10852 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10853 PL_in_clean_all = proto_perl->Iin_clean_all;
10855 PL_uid = proto_perl->Iuid;
10856 PL_euid = proto_perl->Ieuid;
10857 PL_gid = proto_perl->Igid;
10858 PL_egid = proto_perl->Iegid;
10859 PL_nomemok = proto_perl->Inomemok;
10860 PL_an = proto_perl->Ian;
10861 PL_op_seqmax = proto_perl->Iop_seqmax;
10862 PL_evalseq = proto_perl->Ievalseq;
10863 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10864 PL_origalen = proto_perl->Iorigalen;
10865 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10866 PL_osname = SAVEPV(proto_perl->Iosname);
10867 PL_sh_path = proto_perl->Ish_path; /* XXX never deallocated */
10868 PL_sighandlerp = proto_perl->Isighandlerp;
10871 PL_runops = proto_perl->Irunops;
10873 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10876 PL_cshlen = proto_perl->Icshlen;
10877 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10880 PL_lex_state = proto_perl->Ilex_state;
10881 PL_lex_defer = proto_perl->Ilex_defer;
10882 PL_lex_expect = proto_perl->Ilex_expect;
10883 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10884 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10885 PL_lex_starts = proto_perl->Ilex_starts;
10886 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10887 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10888 PL_lex_op = proto_perl->Ilex_op;
10889 PL_lex_inpat = proto_perl->Ilex_inpat;
10890 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10891 PL_lex_brackets = proto_perl->Ilex_brackets;
10892 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10893 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10894 PL_lex_casemods = proto_perl->Ilex_casemods;
10895 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10896 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10898 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10899 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10900 PL_nexttoke = proto_perl->Inexttoke;
10902 /* XXX This is probably masking the deeper issue of why
10903 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10904 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10905 * (A little debugging with a watchpoint on it may help.)
10907 if (SvANY(proto_perl->Ilinestr)) {
10908 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10909 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
10910 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10911 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
10912 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10913 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
10914 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10915 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
10916 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10919 PL_linestr = NEWSV(65,79);
10920 sv_upgrade(PL_linestr,SVt_PVIV);
10921 sv_setpvn(PL_linestr,"",0);
10922 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10924 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10925 PL_pending_ident = proto_perl->Ipending_ident;
10926 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10928 PL_expect = proto_perl->Iexpect;
10930 PL_multi_start = proto_perl->Imulti_start;
10931 PL_multi_end = proto_perl->Imulti_end;
10932 PL_multi_open = proto_perl->Imulti_open;
10933 PL_multi_close = proto_perl->Imulti_close;
10935 PL_error_count = proto_perl->Ierror_count;
10936 PL_subline = proto_perl->Isubline;
10937 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10939 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10940 if (SvANY(proto_perl->Ilinestr)) {
10941 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
10942 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10943 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
10944 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10945 PL_last_lop_op = proto_perl->Ilast_lop_op;
10948 PL_last_uni = SvPVX(PL_linestr);
10949 PL_last_lop = SvPVX(PL_linestr);
10950 PL_last_lop_op = 0;
10952 PL_in_my = proto_perl->Iin_my;
10953 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10955 PL_cryptseen = proto_perl->Icryptseen;
10958 PL_hints = proto_perl->Ihints;
10960 PL_amagic_generation = proto_perl->Iamagic_generation;
10962 #ifdef USE_LOCALE_COLLATE
10963 PL_collation_ix = proto_perl->Icollation_ix;
10964 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10965 PL_collation_standard = proto_perl->Icollation_standard;
10966 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10967 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10968 #endif /* USE_LOCALE_COLLATE */
10970 #ifdef USE_LOCALE_NUMERIC
10971 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10972 PL_numeric_standard = proto_perl->Inumeric_standard;
10973 PL_numeric_local = proto_perl->Inumeric_local;
10974 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10975 #endif /* !USE_LOCALE_NUMERIC */
10977 /* utf8 character classes */
10978 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10979 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10980 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10981 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10982 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10983 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10984 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10985 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10986 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10987 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10988 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10989 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10990 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10991 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10992 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10993 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10994 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10995 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10996 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10997 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11000 PL_last_swash_hv = Nullhv; /* reinits on demand */
11001 PL_last_swash_klen = 0;
11002 PL_last_swash_key[0]= '\0';
11003 PL_last_swash_tmps = (U8*)NULL;
11004 PL_last_swash_slen = 0;
11006 /* perly.c globals */
11007 PL_yydebug = proto_perl->Iyydebug;
11008 PL_yynerrs = proto_perl->Iyynerrs;
11009 PL_yyerrflag = proto_perl->Iyyerrflag;
11010 PL_yychar = proto_perl->Iyychar;
11011 PL_yyval = proto_perl->Iyyval;
11012 PL_yylval = proto_perl->Iyylval;
11014 PL_glob_index = proto_perl->Iglob_index;
11015 PL_srand_called = proto_perl->Isrand_called;
11016 PL_uudmap['M'] = 0; /* reinits on demand */
11017 PL_bitcount = Nullch; /* reinits on demand */
11019 if (proto_perl->Ipsig_pend) {
11020 Newz(0, PL_psig_pend, SIG_SIZE, int);
11023 PL_psig_pend = (int*)NULL;
11026 if (proto_perl->Ipsig_ptr) {
11027 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
11028 Newz(0, PL_psig_name, SIG_SIZE, SV*);
11029 for (i = 1; i < SIG_SIZE; i++) {
11030 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11031 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11035 PL_psig_ptr = (SV**)NULL;
11036 PL_psig_name = (SV**)NULL;
11039 /* thrdvar.h stuff */
11041 if (flags & CLONEf_COPY_STACKS) {
11042 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11043 PL_tmps_ix = proto_perl->Ttmps_ix;
11044 PL_tmps_max = proto_perl->Ttmps_max;
11045 PL_tmps_floor = proto_perl->Ttmps_floor;
11046 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
11048 while (i <= PL_tmps_ix) {
11049 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11053 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11054 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11055 Newz(54, PL_markstack, i, I32);
11056 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11057 - proto_perl->Tmarkstack);
11058 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11059 - proto_perl->Tmarkstack);
11060 Copy(proto_perl->Tmarkstack, PL_markstack,
11061 PL_markstack_ptr - PL_markstack + 1, I32);
11063 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11064 * NOTE: unlike the others! */
11065 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11066 PL_scopestack_max = proto_perl->Tscopestack_max;
11067 Newz(54, PL_scopestack, PL_scopestack_max, I32);
11068 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11070 /* next push_return() sets PL_retstack[PL_retstack_ix]
11071 * NOTE: unlike the others! */
11072 PL_retstack_ix = proto_perl->Tretstack_ix;
11073 PL_retstack_max = proto_perl->Tretstack_max;
11074 Newz(54, PL_retstack, PL_retstack_max, OP*);
11075 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
11077 /* NOTE: si_dup() looks at PL_markstack */
11078 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11080 /* PL_curstack = PL_curstackinfo->si_stack; */
11081 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11082 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11084 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11085 PL_stack_base = AvARRAY(PL_curstack);
11086 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11087 - proto_perl->Tstack_base);
11088 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11090 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11091 * NOTE: unlike the others! */
11092 PL_savestack_ix = proto_perl->Tsavestack_ix;
11093 PL_savestack_max = proto_perl->Tsavestack_max;
11094 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11095 PL_savestack = ss_dup(proto_perl, param);
11099 ENTER; /* perl_destruct() wants to LEAVE; */
11102 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11103 PL_top_env = &PL_start_env;
11105 PL_op = proto_perl->Top;
11108 PL_Xpv = (XPV*)NULL;
11109 PL_na = proto_perl->Tna;
11111 PL_statbuf = proto_perl->Tstatbuf;
11112 PL_statcache = proto_perl->Tstatcache;
11113 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11114 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11116 PL_timesbuf = proto_perl->Ttimesbuf;
11119 PL_tainted = proto_perl->Ttainted;
11120 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11121 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11122 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11123 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11124 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11125 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11126 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11127 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11128 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11130 PL_restartop = proto_perl->Trestartop;
11131 PL_in_eval = proto_perl->Tin_eval;
11132 PL_delaymagic = proto_perl->Tdelaymagic;
11133 PL_dirty = proto_perl->Tdirty;
11134 PL_localizing = proto_perl->Tlocalizing;
11136 #ifdef PERL_FLEXIBLE_EXCEPTIONS
11137 PL_protect = proto_perl->Tprotect;
11139 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11140 PL_av_fetch_sv = Nullsv;
11141 PL_hv_fetch_sv = Nullsv;
11142 Zero(&PL_hv_fetch_ent_mh, 1, HE); /* XXX */
11143 PL_modcount = proto_perl->Tmodcount;
11144 PL_lastgotoprobe = Nullop;
11145 PL_dumpindent = proto_perl->Tdumpindent;
11147 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11148 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11149 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11150 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11151 PL_sortcxix = proto_perl->Tsortcxix;
11152 PL_efloatbuf = Nullch; /* reinits on demand */
11153 PL_efloatsize = 0; /* reinits on demand */
11157 PL_screamfirst = NULL;
11158 PL_screamnext = NULL;
11159 PL_maxscream = -1; /* reinits on demand */
11160 PL_lastscream = Nullsv;
11162 PL_watchaddr = NULL;
11163 PL_watchok = Nullch;
11165 PL_regdummy = proto_perl->Tregdummy;
11166 PL_regprecomp = Nullch;
11169 PL_colorset = 0; /* reinits PL_colors[] */
11170 /*PL_colors[6] = {0,0,0,0,0,0};*/
11171 PL_reginput = Nullch;
11172 PL_regbol = Nullch;
11173 PL_regeol = Nullch;
11174 PL_regstartp = (I32*)NULL;
11175 PL_regendp = (I32*)NULL;
11176 PL_reglastparen = (U32*)NULL;
11177 PL_regtill = Nullch;
11178 PL_reg_start_tmp = (char**)NULL;
11179 PL_reg_start_tmpl = 0;
11180 PL_regdata = (struct reg_data*)NULL;
11183 PL_reg_eval_set = 0;
11185 PL_regprogram = (regnode*)NULL;
11187 PL_regcc = (CURCUR*)NULL;
11188 PL_reg_call_cc = (struct re_cc_state*)NULL;
11189 PL_reg_re = (regexp*)NULL;
11190 PL_reg_ganch = Nullch;
11191 PL_reg_sv = Nullsv;
11192 PL_reg_match_utf8 = FALSE;
11193 PL_reg_magic = (MAGIC*)NULL;
11195 PL_reg_oldcurpm = (PMOP*)NULL;
11196 PL_reg_curpm = (PMOP*)NULL;
11197 PL_reg_oldsaved = Nullch;
11198 PL_reg_oldsavedlen = 0;
11199 #ifdef PERL_COPY_ON_WRITE
11202 PL_reg_maxiter = 0;
11203 PL_reg_leftiter = 0;
11204 PL_reg_poscache = Nullch;
11205 PL_reg_poscache_size= 0;
11207 /* RE engine - function pointers */
11208 PL_regcompp = proto_perl->Tregcompp;
11209 PL_regexecp = proto_perl->Tregexecp;
11210 PL_regint_start = proto_perl->Tregint_start;
11211 PL_regint_string = proto_perl->Tregint_string;
11212 PL_regfree = proto_perl->Tregfree;
11214 PL_reginterp_cnt = 0;
11215 PL_reg_starttry = 0;
11217 /* Pluggable optimizer */
11218 PL_peepp = proto_perl->Tpeepp;
11220 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11221 ptr_table_free(PL_ptr_table);
11222 PL_ptr_table = NULL;
11225 /* Call the ->CLONE method, if it exists, for each of the stashes
11226 identified by sv_dup() above.
11228 while(av_len(param->stashes) != -1) {
11229 HV* stash = (HV*) av_shift(param->stashes);
11230 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11231 if (cloner && GvCV(cloner)) {
11236 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
11238 call_sv((SV*)GvCV(cloner), G_DISCARD);
11244 SvREFCNT_dec(param->stashes);
11249 #endif /* USE_ITHREADS */
11252 =head1 Unicode Support
11254 =for apidoc sv_recode_to_utf8
11256 The encoding is assumed to be an Encode object, on entry the PV
11257 of the sv is assumed to be octets in that encoding, and the sv
11258 will be converted into Unicode (and UTF-8).
11260 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11261 is not a reference, nothing is done to the sv. If the encoding is not
11262 an C<Encode::XS> Encoding object, bad things will happen.
11263 (See F<lib/encoding.pm> and L<Encode>).
11265 The PV of the sv is returned.
11270 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11272 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11286 Passing sv_yes is wrong - it needs to be or'ed set of constants
11287 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11288 remove converted chars from source.
11290 Both will default the value - let them.
11292 XPUSHs(&PL_sv_yes);
11295 call_method("decode", G_SCALAR);
11299 s = SvPV(uni, len);
11300 if (s != SvPVX(sv)) {
11301 SvGROW(sv, len + 1);
11302 Move(s, SvPVX(sv), len, char);
11303 SvCUR_set(sv, len);
11304 SvPVX(sv)[len] = 0;
11314 =for apidoc sv_cat_decode
11316 The encoding is assumed to be an Encode object, the PV of the ssv is
11317 assumed to be octets in that encoding and decoding the input starts
11318 from the position which (PV + *offset) pointed to. The dsv will be
11319 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11320 when the string tstr appears in decoding output or the input ends on
11321 the PV of the ssv. The value which the offset points will be modified
11322 to the last input position on the ssv.
11324 Returns TRUE if the terminator was found, else returns FALSE.
11329 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11330 SV *ssv, int *offset, char *tstr, int tlen)
11332 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11344 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11345 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11347 call_method("cat_decode", G_SCALAR);
11349 ret = SvTRUE(TOPs);
11350 *offset = SvIV(offsv);
11356 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode.");