3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
27 #ifdef PERL_UTF8_CACHE_ASSERT
28 /* The cache element 0 is the Unicode offset;
29 * the cache element 1 is the byte offset of the element 0;
30 * the cache element 2 is the Unicode length of the substring;
31 * the cache element 3 is the byte length of the substring;
32 * The checking of the substring side would be good
33 * but substr() has enough code paths to make my head spin;
34 * if adding more checks watch out for the following tests:
35 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
36 * lib/utf8.t lib/Unicode/Collate/t/index.t
39 #define ASSERT_UTF8_CACHE(cache) \
40 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
42 #define ASSERT_UTF8_CACHE(cache) NOOP
45 #ifdef PERL_COPY_ON_WRITE
46 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
47 #define SV_COW_NEXT_SV_SET(current,next) SvUVX(current) = PTR2UV(next)
48 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
52 /* ============================================================================
54 =head1 Allocation and deallocation of SVs.
56 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
57 av, hv...) contains type and reference count information, as well as a
58 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
59 specific to each type.
61 Normally, this allocation is done using arenas, which are approximately
62 1K chunks of memory parcelled up into N heads or bodies. The first slot
63 in each arena is reserved, and is used to hold a link to the next arena.
64 In the case of heads, the unused first slot also contains some flags and
65 a note of the number of slots. Snaked through each arena chain is a
66 linked list of free items; when this becomes empty, an extra arena is
67 allocated and divided up into N items which are threaded into the free
70 The following global variables are associated with arenas:
72 PL_sv_arenaroot pointer to list of SV arenas
73 PL_sv_root pointer to list of free SV structures
75 PL_foo_arenaroot pointer to list of foo arenas,
76 PL_foo_root pointer to list of free foo bodies
77 ... for foo in xiv, xnv, xrv, xpv etc.
79 Note that some of the larger and more rarely used body types (eg xpvio)
80 are not allocated using arenas, but are instead just malloc()/free()ed as
81 required. Also, if PURIFY is defined, arenas are abandoned altogether,
82 with all items individually malloc()ed. In addition, a few SV heads are
83 not allocated from an arena, but are instead directly created as static
84 or auto variables, eg PL_sv_undef.
86 The SV arena serves the secondary purpose of allowing still-live SVs
87 to be located and destroyed during final cleanup.
89 At the lowest level, the macros new_SV() and del_SV() grab and free
90 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
91 to return the SV to the free list with error checking.) new_SV() calls
92 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
93 SVs in the free list have their SvTYPE field set to all ones.
95 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
96 that allocate and return individual body types. Normally these are mapped
97 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
98 instead mapped directly to malloc()/free() if PURIFY is defined. The
99 new/del functions remove from, or add to, the appropriate PL_foo_root
100 list, and call more_xiv() etc to add a new arena if the list is empty.
102 At the time of very final cleanup, sv_free_arenas() is called from
103 perl_destruct() to physically free all the arenas allocated since the
104 start of the interpreter. Note that this also clears PL_he_arenaroot,
105 which is otherwise dealt with in hv.c.
107 Manipulation of any of the PL_*root pointers is protected by enclosing
108 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
109 if threads are enabled.
111 The function visit() scans the SV arenas list, and calls a specified
112 function for each SV it finds which is still live - ie which has an SvTYPE
113 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
114 following functions (specified as [function that calls visit()] / [function
115 called by visit() for each SV]):
117 sv_report_used() / do_report_used()
118 dump all remaining SVs (debugging aid)
120 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
121 Attempt to free all objects pointed to by RVs,
122 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
123 try to do the same for all objects indirectly
124 referenced by typeglobs too. Called once from
125 perl_destruct(), prior to calling sv_clean_all()
128 sv_clean_all() / do_clean_all()
129 SvREFCNT_dec(sv) each remaining SV, possibly
130 triggering an sv_free(). It also sets the
131 SVf_BREAK flag on the SV to indicate that the
132 refcnt has been artificially lowered, and thus
133 stopping sv_free() from giving spurious warnings
134 about SVs which unexpectedly have a refcnt
135 of zero. called repeatedly from perl_destruct()
136 until there are no SVs left.
140 Private API to rest of sv.c
144 new_XIV(), del_XIV(),
145 new_XNV(), del_XNV(),
150 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
155 ============================================================================ */
160 * "A time to plant, and a time to uproot what was planted..."
163 #define plant_SV(p) \
165 SvANY(p) = (void *)PL_sv_root; \
166 SvFLAGS(p) = SVTYPEMASK; \
171 /* sv_mutex must be held while calling uproot_SV() */
172 #define uproot_SV(p) \
175 PL_sv_root = (SV*)SvANY(p); \
180 /* new_SV(): return a new, empty SV head */
182 #ifdef DEBUG_LEAKING_SCALARS
183 /* provide a real function for a debugger to play with */
200 # define new_SV(p) (p)=S_new_SV(aTHX)
218 /* del_SV(): return an empty SV head to the free list */
233 S_del_sv(pTHX_ SV *p)
240 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
242 svend = &sva[SvREFCNT(sva)];
243 if (p >= sv && p < svend)
247 if (ckWARN_d(WARN_INTERNAL))
248 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
249 "Attempt to free non-arena SV: 0x%"UVxf,
257 #else /* ! DEBUGGING */
259 #define del_SV(p) plant_SV(p)
261 #endif /* DEBUGGING */
265 =head1 SV Manipulation Functions
267 =for apidoc sv_add_arena
269 Given a chunk of memory, link it to the head of the list of arenas,
270 and split it into a list of free SVs.
276 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
281 Zero(ptr, size, char);
283 /* The first SV in an arena isn't an SV. */
284 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
285 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
286 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
288 PL_sv_arenaroot = sva;
289 PL_sv_root = sva + 1;
291 svend = &sva[SvREFCNT(sva) - 1];
294 SvANY(sv) = (void *)(SV*)(sv + 1);
295 SvFLAGS(sv) = SVTYPEMASK;
299 SvFLAGS(sv) = SVTYPEMASK;
302 /* make some more SVs by adding another arena */
304 /* sv_mutex must be held while calling more_sv() */
311 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
312 PL_nice_chunk = Nullch;
313 PL_nice_chunk_size = 0;
316 char *chunk; /* must use New here to match call to */
317 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
318 sv_add_arena(chunk, 1008, 0);
324 /* visit(): call the named function for each non-free SV in the arenas. */
327 S_visit(pTHX_ SVFUNC_t f)
334 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
335 svend = &sva[SvREFCNT(sva)];
336 for (sv = sva + 1; sv < svend; ++sv) {
337 if (SvTYPE(sv) != SVTYPEMASK && SvREFCNT(sv)) {
348 /* called by sv_report_used() for each live SV */
351 do_report_used(pTHX_ SV *sv)
353 if (SvTYPE(sv) != SVTYPEMASK) {
354 PerlIO_printf(Perl_debug_log, "****\n");
361 =for apidoc sv_report_used
363 Dump the contents of all SVs not yet freed. (Debugging aid).
369 Perl_sv_report_used(pTHX)
372 visit(do_report_used);
376 /* called by sv_clean_objs() for each live SV */
379 do_clean_objs(pTHX_ SV *sv)
383 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
384 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
396 /* XXX Might want to check arrays, etc. */
399 /* called by sv_clean_objs() for each live SV */
401 #ifndef DISABLE_DESTRUCTOR_KLUDGE
403 do_clean_named_objs(pTHX_ SV *sv)
405 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
406 if ( SvOBJECT(GvSV(sv)) ||
407 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
408 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
409 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
410 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
412 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
413 SvFLAGS(sv) |= SVf_BREAK;
421 =for apidoc sv_clean_objs
423 Attempt to destroy all objects not yet freed
429 Perl_sv_clean_objs(pTHX)
431 PL_in_clean_objs = TRUE;
432 visit(do_clean_objs);
433 #ifndef DISABLE_DESTRUCTOR_KLUDGE
434 /* some barnacles may yet remain, clinging to typeglobs */
435 visit(do_clean_named_objs);
437 PL_in_clean_objs = FALSE;
440 /* called by sv_clean_all() for each live SV */
443 do_clean_all(pTHX_ SV *sv)
445 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
446 SvFLAGS(sv) |= SVf_BREAK;
451 =for apidoc sv_clean_all
453 Decrement the refcnt of each remaining SV, possibly triggering a
454 cleanup. This function may have to be called multiple times to free
455 SVs which are in complex self-referential hierarchies.
461 Perl_sv_clean_all(pTHX)
464 PL_in_clean_all = TRUE;
465 cleaned = visit(do_clean_all);
466 PL_in_clean_all = FALSE;
471 =for apidoc sv_free_arenas
473 Deallocate the memory used by all arenas. Note that all the individual SV
474 heads and bodies within the arenas must already have been freed.
480 Perl_sv_free_arenas(pTHX)
484 XPV *arena, *arenanext;
486 /* Free arenas here, but be careful about fake ones. (We assume
487 contiguity of the fake ones with the corresponding real ones.) */
489 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
490 svanext = (SV*) SvANY(sva);
491 while (svanext && SvFAKE(svanext))
492 svanext = (SV*) SvANY(svanext);
495 Safefree((void *)sva);
498 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
499 arenanext = (XPV*)arena->xpv_pv;
502 PL_xiv_arenaroot = 0;
505 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
506 arenanext = (XPV*)arena->xpv_pv;
509 PL_xnv_arenaroot = 0;
512 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
513 arenanext = (XPV*)arena->xpv_pv;
516 PL_xrv_arenaroot = 0;
519 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
520 arenanext = (XPV*)arena->xpv_pv;
523 PL_xpv_arenaroot = 0;
526 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
527 arenanext = (XPV*)arena->xpv_pv;
530 PL_xpviv_arenaroot = 0;
533 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
534 arenanext = (XPV*)arena->xpv_pv;
537 PL_xpvnv_arenaroot = 0;
540 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
541 arenanext = (XPV*)arena->xpv_pv;
544 PL_xpvcv_arenaroot = 0;
547 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
548 arenanext = (XPV*)arena->xpv_pv;
551 PL_xpvav_arenaroot = 0;
554 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
555 arenanext = (XPV*)arena->xpv_pv;
558 PL_xpvhv_arenaroot = 0;
561 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
562 arenanext = (XPV*)arena->xpv_pv;
565 PL_xpvmg_arenaroot = 0;
568 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
569 arenanext = (XPV*)arena->xpv_pv;
572 PL_xpvlv_arenaroot = 0;
575 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
576 arenanext = (XPV*)arena->xpv_pv;
579 PL_xpvbm_arenaroot = 0;
582 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
583 arenanext = (XPV*)arena->xpv_pv;
590 Safefree(PL_nice_chunk);
591 PL_nice_chunk = Nullch;
592 PL_nice_chunk_size = 0;
598 =for apidoc report_uninit
600 Print appropriate "Use of uninitialized variable" warning
606 Perl_report_uninit(pTHX)
609 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
610 " in ", OP_DESC(PL_op));
612 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit, "", "");
615 /* grab a new IV body from the free list, allocating more if necessary */
626 * See comment in more_xiv() -- RAM.
628 PL_xiv_root = *(IV**)xiv;
630 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
633 /* return an IV body to the free list */
636 S_del_xiv(pTHX_ XPVIV *p)
638 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
640 *(IV**)xiv = PL_xiv_root;
645 /* allocate another arena's worth of IV bodies */
653 New(705, ptr, 1008/sizeof(XPV), XPV);
654 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
655 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
658 xivend = &xiv[1008 / sizeof(IV) - 1];
659 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
661 while (xiv < xivend) {
662 *(IV**)xiv = (IV *)(xiv + 1);
668 /* grab a new NV body from the free list, allocating more if necessary */
678 PL_xnv_root = *(NV**)xnv;
680 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
683 /* return an NV body to the free list */
686 S_del_xnv(pTHX_ XPVNV *p)
688 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
690 *(NV**)xnv = PL_xnv_root;
695 /* allocate another arena's worth of NV bodies */
703 New(711, ptr, 1008/sizeof(XPV), XPV);
704 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
705 PL_xnv_arenaroot = ptr;
708 xnvend = &xnv[1008 / sizeof(NV) - 1];
709 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
711 while (xnv < xnvend) {
712 *(NV**)xnv = (NV*)(xnv + 1);
718 /* grab a new struct xrv from the free list, allocating more if necessary */
728 PL_xrv_root = (XRV*)xrv->xrv_rv;
733 /* return a struct xrv to the free list */
736 S_del_xrv(pTHX_ XRV *p)
739 p->xrv_rv = (SV*)PL_xrv_root;
744 /* allocate another arena's worth of struct xrv */
750 register XRV* xrvend;
752 New(712, ptr, 1008/sizeof(XPV), XPV);
753 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
754 PL_xrv_arenaroot = ptr;
757 xrvend = &xrv[1008 / sizeof(XRV) - 1];
758 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
760 while (xrv < xrvend) {
761 xrv->xrv_rv = (SV*)(xrv + 1);
767 /* grab a new struct xpv from the free list, allocating more if necessary */
777 PL_xpv_root = (XPV*)xpv->xpv_pv;
782 /* return a struct xpv to the free list */
785 S_del_xpv(pTHX_ XPV *p)
788 p->xpv_pv = (char*)PL_xpv_root;
793 /* allocate another arena's worth of struct xpv */
799 register XPV* xpvend;
800 New(713, xpv, 1008/sizeof(XPV), XPV);
801 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
802 PL_xpv_arenaroot = xpv;
804 xpvend = &xpv[1008 / sizeof(XPV) - 1];
806 while (xpv < xpvend) {
807 xpv->xpv_pv = (char*)(xpv + 1);
813 /* grab a new struct xpviv from the free list, allocating more if necessary */
822 xpviv = PL_xpviv_root;
823 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
828 /* return a struct xpviv to the free list */
831 S_del_xpviv(pTHX_ XPVIV *p)
834 p->xpv_pv = (char*)PL_xpviv_root;
839 /* allocate another arena's worth of struct xpviv */
844 register XPVIV* xpviv;
845 register XPVIV* xpvivend;
846 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
847 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
848 PL_xpviv_arenaroot = xpviv;
850 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
851 PL_xpviv_root = ++xpviv;
852 while (xpviv < xpvivend) {
853 xpviv->xpv_pv = (char*)(xpviv + 1);
859 /* grab a new struct xpvnv from the free list, allocating more if necessary */
868 xpvnv = PL_xpvnv_root;
869 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
874 /* return a struct xpvnv to the free list */
877 S_del_xpvnv(pTHX_ XPVNV *p)
880 p->xpv_pv = (char*)PL_xpvnv_root;
885 /* allocate another arena's worth of struct xpvnv */
890 register XPVNV* xpvnv;
891 register XPVNV* xpvnvend;
892 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
893 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
894 PL_xpvnv_arenaroot = xpvnv;
896 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
897 PL_xpvnv_root = ++xpvnv;
898 while (xpvnv < xpvnvend) {
899 xpvnv->xpv_pv = (char*)(xpvnv + 1);
905 /* grab a new struct xpvcv from the free list, allocating more if necessary */
914 xpvcv = PL_xpvcv_root;
915 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
920 /* return a struct xpvcv to the free list */
923 S_del_xpvcv(pTHX_ XPVCV *p)
926 p->xpv_pv = (char*)PL_xpvcv_root;
931 /* allocate another arena's worth of struct xpvcv */
936 register XPVCV* xpvcv;
937 register XPVCV* xpvcvend;
938 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
939 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
940 PL_xpvcv_arenaroot = xpvcv;
942 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
943 PL_xpvcv_root = ++xpvcv;
944 while (xpvcv < xpvcvend) {
945 xpvcv->xpv_pv = (char*)(xpvcv + 1);
951 /* grab a new struct xpvav from the free list, allocating more if necessary */
960 xpvav = PL_xpvav_root;
961 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
966 /* return a struct xpvav to the free list */
969 S_del_xpvav(pTHX_ XPVAV *p)
972 p->xav_array = (char*)PL_xpvav_root;
977 /* allocate another arena's worth of struct xpvav */
982 register XPVAV* xpvav;
983 register XPVAV* xpvavend;
984 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
985 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
986 PL_xpvav_arenaroot = xpvav;
988 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
989 PL_xpvav_root = ++xpvav;
990 while (xpvav < xpvavend) {
991 xpvav->xav_array = (char*)(xpvav + 1);
994 xpvav->xav_array = 0;
997 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1006 xpvhv = PL_xpvhv_root;
1007 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
1012 /* return a struct xpvhv to the free list */
1015 S_del_xpvhv(pTHX_ XPVHV *p)
1018 p->xhv_array = (char*)PL_xpvhv_root;
1023 /* allocate another arena's worth of struct xpvhv */
1028 register XPVHV* xpvhv;
1029 register XPVHV* xpvhvend;
1030 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
1031 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1032 PL_xpvhv_arenaroot = xpvhv;
1034 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
1035 PL_xpvhv_root = ++xpvhv;
1036 while (xpvhv < xpvhvend) {
1037 xpvhv->xhv_array = (char*)(xpvhv + 1);
1040 xpvhv->xhv_array = 0;
1043 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1052 xpvmg = PL_xpvmg_root;
1053 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1058 /* return a struct xpvmg to the free list */
1061 S_del_xpvmg(pTHX_ XPVMG *p)
1064 p->xpv_pv = (char*)PL_xpvmg_root;
1069 /* allocate another arena's worth of struct xpvmg */
1074 register XPVMG* xpvmg;
1075 register XPVMG* xpvmgend;
1076 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1077 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1078 PL_xpvmg_arenaroot = xpvmg;
1080 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1081 PL_xpvmg_root = ++xpvmg;
1082 while (xpvmg < xpvmgend) {
1083 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1089 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1098 xpvlv = PL_xpvlv_root;
1099 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1104 /* return a struct xpvlv to the free list */
1107 S_del_xpvlv(pTHX_ XPVLV *p)
1110 p->xpv_pv = (char*)PL_xpvlv_root;
1115 /* allocate another arena's worth of struct xpvlv */
1120 register XPVLV* xpvlv;
1121 register XPVLV* xpvlvend;
1122 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1123 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1124 PL_xpvlv_arenaroot = xpvlv;
1126 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1127 PL_xpvlv_root = ++xpvlv;
1128 while (xpvlv < xpvlvend) {
1129 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1135 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1144 xpvbm = PL_xpvbm_root;
1145 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1150 /* return a struct xpvbm to the free list */
1153 S_del_xpvbm(pTHX_ XPVBM *p)
1156 p->xpv_pv = (char*)PL_xpvbm_root;
1161 /* allocate another arena's worth of struct xpvbm */
1166 register XPVBM* xpvbm;
1167 register XPVBM* xpvbmend;
1168 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1169 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1170 PL_xpvbm_arenaroot = xpvbm;
1172 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1173 PL_xpvbm_root = ++xpvbm;
1174 while (xpvbm < xpvbmend) {
1175 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1181 #define my_safemalloc(s) (void*)safemalloc(s)
1182 #define my_safefree(p) safefree((char*)p)
1186 #define new_XIV() my_safemalloc(sizeof(XPVIV))
1187 #define del_XIV(p) my_safefree(p)
1189 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1190 #define del_XNV(p) my_safefree(p)
1192 #define new_XRV() my_safemalloc(sizeof(XRV))
1193 #define del_XRV(p) my_safefree(p)
1195 #define new_XPV() my_safemalloc(sizeof(XPV))
1196 #define del_XPV(p) my_safefree(p)
1198 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1199 #define del_XPVIV(p) my_safefree(p)
1201 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1202 #define del_XPVNV(p) my_safefree(p)
1204 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1205 #define del_XPVCV(p) my_safefree(p)
1207 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1208 #define del_XPVAV(p) my_safefree(p)
1210 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1211 #define del_XPVHV(p) my_safefree(p)
1213 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1214 #define del_XPVMG(p) my_safefree(p)
1216 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1217 #define del_XPVLV(p) my_safefree(p)
1219 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1220 #define del_XPVBM(p) my_safefree(p)
1224 #define new_XIV() (void*)new_xiv()
1225 #define del_XIV(p) del_xiv((XPVIV*) p)
1227 #define new_XNV() (void*)new_xnv()
1228 #define del_XNV(p) del_xnv((XPVNV*) p)
1230 #define new_XRV() (void*)new_xrv()
1231 #define del_XRV(p) del_xrv((XRV*) p)
1233 #define new_XPV() (void*)new_xpv()
1234 #define del_XPV(p) del_xpv((XPV *)p)
1236 #define new_XPVIV() (void*)new_xpviv()
1237 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1239 #define new_XPVNV() (void*)new_xpvnv()
1240 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1242 #define new_XPVCV() (void*)new_xpvcv()
1243 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1245 #define new_XPVAV() (void*)new_xpvav()
1246 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1248 #define new_XPVHV() (void*)new_xpvhv()
1249 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1251 #define new_XPVMG() (void*)new_xpvmg()
1252 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1254 #define new_XPVLV() (void*)new_xpvlv()
1255 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1257 #define new_XPVBM() (void*)new_xpvbm()
1258 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1262 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1263 #define del_XPVGV(p) my_safefree(p)
1265 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1266 #define del_XPVFM(p) my_safefree(p)
1268 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1269 #define del_XPVIO(p) my_safefree(p)
1272 =for apidoc sv_upgrade
1274 Upgrade an SV to a more complex form. Generally adds a new body type to the
1275 SV, then copies across as much information as possible from the old body.
1276 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1282 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1289 MAGIC* magic = NULL;
1292 if (mt != SVt_PV && SvIsCOW(sv)) {
1293 sv_force_normal_flags(sv, 0);
1296 if (SvTYPE(sv) == mt)
1300 (void)SvOOK_off(sv);
1302 switch (SvTYPE(sv)) {
1323 else if (mt < SVt_PVIV)
1340 pv = (char*)SvRV(sv);
1360 else if (mt == SVt_NV)
1371 del_XPVIV(SvANY(sv));
1381 del_XPVNV(SvANY(sv));
1389 magic = SvMAGIC(sv);
1390 stash = SvSTASH(sv);
1391 del_XPVMG(SvANY(sv));
1394 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1399 Perl_croak(aTHX_ "Can't upgrade to undef");
1401 SvANY(sv) = new_XIV();
1405 SvANY(sv) = new_XNV();
1409 SvANY(sv) = new_XRV();
1413 SvANY(sv) = new_XPV();
1419 SvANY(sv) = new_XPVIV();
1429 SvANY(sv) = new_XPVNV();
1437 SvANY(sv) = new_XPVMG();
1443 SvMAGIC(sv) = magic;
1444 SvSTASH(sv) = stash;
1447 SvANY(sv) = new_XPVLV();
1453 SvMAGIC(sv) = magic;
1454 SvSTASH(sv) = stash;
1466 SvANY(sv) = new_XPVAV();
1474 SvMAGIC(sv) = magic;
1475 SvSTASH(sv) = stash;
1481 SvANY(sv) = new_XPVHV();
1487 HvTOTALKEYS(sv) = 0;
1488 HvPLACEHOLDERS(sv) = 0;
1489 SvMAGIC(sv) = magic;
1490 SvSTASH(sv) = stash;
1497 SvANY(sv) = new_XPVCV();
1498 Zero(SvANY(sv), 1, XPVCV);
1504 SvMAGIC(sv) = magic;
1505 SvSTASH(sv) = stash;
1508 SvANY(sv) = new_XPVGV();
1514 SvMAGIC(sv) = magic;
1515 SvSTASH(sv) = stash;
1523 SvANY(sv) = new_XPVBM();
1529 SvMAGIC(sv) = magic;
1530 SvSTASH(sv) = stash;
1536 SvANY(sv) = new_XPVFM();
1537 Zero(SvANY(sv), 1, XPVFM);
1543 SvMAGIC(sv) = magic;
1544 SvSTASH(sv) = stash;
1547 SvANY(sv) = new_XPVIO();
1548 Zero(SvANY(sv), 1, XPVIO);
1554 SvMAGIC(sv) = magic;
1555 SvSTASH(sv) = stash;
1556 IoPAGE_LEN(sv) = 60;
1559 SvFLAGS(sv) &= ~SVTYPEMASK;
1565 =for apidoc sv_backoff
1567 Remove any string offset. You should normally use the C<SvOOK_off> macro
1574 Perl_sv_backoff(pTHX_ register SV *sv)
1578 char *s = SvPVX(sv);
1579 SvLEN(sv) += SvIVX(sv);
1580 SvPVX(sv) -= SvIVX(sv);
1582 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1584 SvFLAGS(sv) &= ~SVf_OOK;
1591 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1592 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1593 Use the C<SvGROW> wrapper instead.
1599 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1603 #ifdef HAS_64K_LIMIT
1604 if (newlen >= 0x10000) {
1605 PerlIO_printf(Perl_debug_log,
1606 "Allocation too large: %"UVxf"\n", (UV)newlen);
1609 #endif /* HAS_64K_LIMIT */
1612 if (SvTYPE(sv) < SVt_PV) {
1613 sv_upgrade(sv, SVt_PV);
1616 else if (SvOOK(sv)) { /* pv is offset? */
1619 if (newlen > SvLEN(sv))
1620 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1621 #ifdef HAS_64K_LIMIT
1622 if (newlen >= 0x10000)
1629 if (newlen > SvLEN(sv)) { /* need more room? */
1630 if (SvLEN(sv) && s) {
1632 STRLEN l = malloced_size((void*)SvPVX(sv));
1638 Renew(s,newlen,char);
1641 New(703, s, newlen, char);
1642 if (SvPVX(sv) && SvCUR(sv)) {
1643 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1647 SvLEN_set(sv, newlen);
1653 =for apidoc sv_setiv
1655 Copies an integer into the given SV, upgrading first if necessary.
1656 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1662 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1664 SV_CHECK_THINKFIRST_COW_DROP(sv);
1665 switch (SvTYPE(sv)) {
1667 sv_upgrade(sv, SVt_IV);
1670 sv_upgrade(sv, SVt_PVNV);
1674 sv_upgrade(sv, SVt_PVIV);
1683 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1686 (void)SvIOK_only(sv); /* validate number */
1692 =for apidoc sv_setiv_mg
1694 Like C<sv_setiv>, but also handles 'set' magic.
1700 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1707 =for apidoc sv_setuv
1709 Copies an unsigned integer into the given SV, upgrading first if necessary.
1710 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1716 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1718 /* With these two if statements:
1719 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1722 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1724 If you wish to remove them, please benchmark to see what the effect is
1726 if (u <= (UV)IV_MAX) {
1727 sv_setiv(sv, (IV)u);
1736 =for apidoc sv_setuv_mg
1738 Like C<sv_setuv>, but also handles 'set' magic.
1744 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1746 /* With these two if statements:
1747 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1750 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1752 If you wish to remove them, please benchmark to see what the effect is
1754 if (u <= (UV)IV_MAX) {
1755 sv_setiv(sv, (IV)u);
1765 =for apidoc sv_setnv
1767 Copies a double into the given SV, upgrading first if necessary.
1768 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1774 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1776 SV_CHECK_THINKFIRST_COW_DROP(sv);
1777 switch (SvTYPE(sv)) {
1780 sv_upgrade(sv, SVt_NV);
1785 sv_upgrade(sv, SVt_PVNV);
1794 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1798 (void)SvNOK_only(sv); /* validate number */
1803 =for apidoc sv_setnv_mg
1805 Like C<sv_setnv>, but also handles 'set' magic.
1811 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1817 /* Print an "isn't numeric" warning, using a cleaned-up,
1818 * printable version of the offending string
1822 S_not_a_number(pTHX_ SV *sv)
1829 dsv = sv_2mortal(newSVpv("", 0));
1830 pv = sv_uni_display(dsv, sv, 10, 0);
1833 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1834 /* each *s can expand to 4 chars + "...\0",
1835 i.e. need room for 8 chars */
1838 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
1840 if (ch & 128 && !isPRINT_LC(ch)) {
1849 else if (ch == '\r') {
1853 else if (ch == '\f') {
1857 else if (ch == '\\') {
1861 else if (ch == '\0') {
1865 else if (isPRINT_LC(ch))
1882 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1883 "Argument \"%s\" isn't numeric in %s", pv,
1886 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1887 "Argument \"%s\" isn't numeric", pv);
1891 =for apidoc looks_like_number
1893 Test if the content of an SV looks like a number (or is a number).
1894 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1895 non-numeric warning), even if your atof() doesn't grok them.
1901 Perl_looks_like_number(pTHX_ SV *sv)
1903 register char *sbegin;
1910 else if (SvPOKp(sv))
1911 sbegin = SvPV(sv, len);
1913 return 1; /* Historic. Wrong? */
1914 return grok_number(sbegin, len, NULL);
1917 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1918 until proven guilty, assume that things are not that bad... */
1923 As 64 bit platforms often have an NV that doesn't preserve all bits of
1924 an IV (an assumption perl has been based on to date) it becomes necessary
1925 to remove the assumption that the NV always carries enough precision to
1926 recreate the IV whenever needed, and that the NV is the canonical form.
1927 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1928 precision as a side effect of conversion (which would lead to insanity
1929 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1930 1) to distinguish between IV/UV/NV slots that have cached a valid
1931 conversion where precision was lost and IV/UV/NV slots that have a
1932 valid conversion which has lost no precision
1933 2) to ensure that if a numeric conversion to one form is requested that
1934 would lose precision, the precise conversion (or differently
1935 imprecise conversion) is also performed and cached, to prevent
1936 requests for different numeric formats on the same SV causing
1937 lossy conversion chains. (lossless conversion chains are perfectly
1942 SvIOKp is true if the IV slot contains a valid value
1943 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1944 SvNOKp is true if the NV slot contains a valid value
1945 SvNOK is true only if the NV value is accurate
1948 while converting from PV to NV, check to see if converting that NV to an
1949 IV(or UV) would lose accuracy over a direct conversion from PV to
1950 IV(or UV). If it would, cache both conversions, return NV, but mark
1951 SV as IOK NOKp (ie not NOK).
1953 While converting from PV to IV, check to see if converting that IV to an
1954 NV would lose accuracy over a direct conversion from PV to NV. If it
1955 would, cache both conversions, flag similarly.
1957 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1958 correctly because if IV & NV were set NV *always* overruled.
1959 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1960 changes - now IV and NV together means that the two are interchangeable:
1961 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1963 The benefit of this is that operations such as pp_add know that if
1964 SvIOK is true for both left and right operands, then integer addition
1965 can be used instead of floating point (for cases where the result won't
1966 overflow). Before, floating point was always used, which could lead to
1967 loss of precision compared with integer addition.
1969 * making IV and NV equal status should make maths accurate on 64 bit
1971 * may speed up maths somewhat if pp_add and friends start to use
1972 integers when possible instead of fp. (Hopefully the overhead in
1973 looking for SvIOK and checking for overflow will not outweigh the
1974 fp to integer speedup)
1975 * will slow down integer operations (callers of SvIV) on "inaccurate"
1976 values, as the change from SvIOK to SvIOKp will cause a call into
1977 sv_2iv each time rather than a macro access direct to the IV slot
1978 * should speed up number->string conversion on integers as IV is
1979 favoured when IV and NV are equally accurate
1981 ####################################################################
1982 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1983 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1984 On the other hand, SvUOK is true iff UV.
1985 ####################################################################
1987 Your mileage will vary depending your CPU's relative fp to integer
1991 #ifndef NV_PRESERVES_UV
1992 # define IS_NUMBER_UNDERFLOW_IV 1
1993 # define IS_NUMBER_UNDERFLOW_UV 2
1994 # define IS_NUMBER_IV_AND_UV 2
1995 # define IS_NUMBER_OVERFLOW_IV 4
1996 # define IS_NUMBER_OVERFLOW_UV 5
1998 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2000 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2002 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2004 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));
2005 if (SvNVX(sv) < (NV)IV_MIN) {
2006 (void)SvIOKp_on(sv);
2009 return IS_NUMBER_UNDERFLOW_IV;
2011 if (SvNVX(sv) > (NV)UV_MAX) {
2012 (void)SvIOKp_on(sv);
2016 return IS_NUMBER_OVERFLOW_UV;
2018 (void)SvIOKp_on(sv);
2020 /* Can't use strtol etc to convert this string. (See truth table in
2022 if (SvNVX(sv) <= (UV)IV_MAX) {
2023 SvIVX(sv) = I_V(SvNVX(sv));
2024 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2025 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2027 /* Integer is imprecise. NOK, IOKp */
2029 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2032 SvUVX(sv) = U_V(SvNVX(sv));
2033 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2034 if (SvUVX(sv) == UV_MAX) {
2035 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2036 possibly be preserved by NV. Hence, it must be overflow.
2038 return IS_NUMBER_OVERFLOW_UV;
2040 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2042 /* Integer is imprecise. NOK, IOKp */
2044 return IS_NUMBER_OVERFLOW_IV;
2046 #endif /* !NV_PRESERVES_UV*/
2048 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2049 * this function provided for binary compatibility only
2053 Perl_sv_2iv(pTHX_ register SV *sv)
2055 return sv_2iv_flags(sv, SV_GMAGIC);
2059 =for apidoc sv_2iv_flags
2061 Return the integer value of an SV, doing any necessary string
2062 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2063 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2069 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2073 if (SvGMAGICAL(sv)) {
2074 if (flags & SV_GMAGIC)
2079 return I_V(SvNVX(sv));
2081 if (SvPOKp(sv) && SvLEN(sv))
2084 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2085 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2091 if (SvTHINKFIRST(sv)) {
2094 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2095 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2096 return SvIV(tmpstr);
2097 return PTR2IV(SvRV(sv));
2100 sv_force_normal_flags(sv, 0);
2102 if (SvREADONLY(sv) && !SvOK(sv)) {
2103 if (ckWARN(WARN_UNINITIALIZED))
2110 return (IV)(SvUVX(sv));
2117 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2118 * without also getting a cached IV/UV from it at the same time
2119 * (ie PV->NV conversion should detect loss of accuracy and cache
2120 * IV or UV at same time to avoid this. NWC */
2122 if (SvTYPE(sv) == SVt_NV)
2123 sv_upgrade(sv, SVt_PVNV);
2125 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2126 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2127 certainly cast into the IV range at IV_MAX, whereas the correct
2128 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2130 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2131 SvIVX(sv) = I_V(SvNVX(sv));
2132 if (SvNVX(sv) == (NV) SvIVX(sv)
2133 #ifndef NV_PRESERVES_UV
2134 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2135 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2136 /* Don't flag it as "accurately an integer" if the number
2137 came from a (by definition imprecise) NV operation, and
2138 we're outside the range of NV integer precision */
2141 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2142 DEBUG_c(PerlIO_printf(Perl_debug_log,
2143 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2149 /* IV not precise. No need to convert from PV, as NV
2150 conversion would already have cached IV if it detected
2151 that PV->IV would be better than PV->NV->IV
2152 flags already correct - don't set public IOK. */
2153 DEBUG_c(PerlIO_printf(Perl_debug_log,
2154 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2159 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2160 but the cast (NV)IV_MIN rounds to a the value less (more
2161 negative) than IV_MIN which happens to be equal to SvNVX ??
2162 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2163 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2164 (NV)UVX == NVX are both true, but the values differ. :-(
2165 Hopefully for 2s complement IV_MIN is something like
2166 0x8000000000000000 which will be exact. NWC */
2169 SvUVX(sv) = U_V(SvNVX(sv));
2171 (SvNVX(sv) == (NV) SvUVX(sv))
2172 #ifndef NV_PRESERVES_UV
2173 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2174 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2175 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2176 /* Don't flag it as "accurately an integer" if the number
2177 came from a (by definition imprecise) NV operation, and
2178 we're outside the range of NV integer precision */
2184 DEBUG_c(PerlIO_printf(Perl_debug_log,
2185 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2189 return (IV)SvUVX(sv);
2192 else if (SvPOKp(sv) && SvLEN(sv)) {
2194 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2195 /* We want to avoid a possible problem when we cache an IV which
2196 may be later translated to an NV, and the resulting NV is not
2197 the same as the direct translation of the initial string
2198 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2199 be careful to ensure that the value with the .456 is around if the
2200 NV value is requested in the future).
2202 This means that if we cache such an IV, we need to cache the
2203 NV as well. Moreover, we trade speed for space, and do not
2204 cache the NV if we are sure it's not needed.
2207 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2208 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2209 == IS_NUMBER_IN_UV) {
2210 /* It's definitely an integer, only upgrade to PVIV */
2211 if (SvTYPE(sv) < SVt_PVIV)
2212 sv_upgrade(sv, SVt_PVIV);
2214 } else if (SvTYPE(sv) < SVt_PVNV)
2215 sv_upgrade(sv, SVt_PVNV);
2217 /* If NV preserves UV then we only use the UV value if we know that
2218 we aren't going to call atof() below. If NVs don't preserve UVs
2219 then the value returned may have more precision than atof() will
2220 return, even though value isn't perfectly accurate. */
2221 if ((numtype & (IS_NUMBER_IN_UV
2222 #ifdef NV_PRESERVES_UV
2225 )) == IS_NUMBER_IN_UV) {
2226 /* This won't turn off the public IOK flag if it was set above */
2227 (void)SvIOKp_on(sv);
2229 if (!(numtype & IS_NUMBER_NEG)) {
2231 if (value <= (UV)IV_MAX) {
2232 SvIVX(sv) = (IV)value;
2238 /* 2s complement assumption */
2239 if (value <= (UV)IV_MIN) {
2240 SvIVX(sv) = -(IV)value;
2242 /* Too negative for an IV. This is a double upgrade, but
2243 I'm assuming it will be rare. */
2244 if (SvTYPE(sv) < SVt_PVNV)
2245 sv_upgrade(sv, SVt_PVNV);
2249 SvNVX(sv) = -(NV)value;
2254 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2255 will be in the previous block to set the IV slot, and the next
2256 block to set the NV slot. So no else here. */
2258 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2259 != IS_NUMBER_IN_UV) {
2260 /* It wasn't an (integer that doesn't overflow the UV). */
2261 SvNVX(sv) = Atof(SvPVX(sv));
2263 if (! numtype && ckWARN(WARN_NUMERIC))
2266 #if defined(USE_LONG_DOUBLE)
2267 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2268 PTR2UV(sv), SvNVX(sv)));
2270 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2271 PTR2UV(sv), SvNVX(sv)));
2275 #ifdef NV_PRESERVES_UV
2276 (void)SvIOKp_on(sv);
2278 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2279 SvIVX(sv) = I_V(SvNVX(sv));
2280 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2283 /* Integer is imprecise. NOK, IOKp */
2285 /* UV will not work better than IV */
2287 if (SvNVX(sv) > (NV)UV_MAX) {
2289 /* Integer is inaccurate. NOK, IOKp, is UV */
2293 SvUVX(sv) = U_V(SvNVX(sv));
2294 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2295 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2299 /* Integer is imprecise. NOK, IOKp, is UV */
2305 #else /* NV_PRESERVES_UV */
2306 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2307 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2308 /* The IV slot will have been set from value returned by
2309 grok_number above. The NV slot has just been set using
2312 assert (SvIOKp(sv));
2314 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2315 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2316 /* Small enough to preserve all bits. */
2317 (void)SvIOKp_on(sv);
2319 SvIVX(sv) = I_V(SvNVX(sv));
2320 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2322 /* Assumption: first non-preserved integer is < IV_MAX,
2323 this NV is in the preserved range, therefore: */
2324 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2326 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)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);
2330 0 0 already failed to read UV.
2331 0 1 already failed to read UV.
2332 1 0 you won't get here in this case. IV/UV
2333 slot set, public IOK, Atof() unneeded.
2334 1 1 already read UV.
2335 so there's no point in sv_2iuv_non_preserve() attempting
2336 to use atol, strtol, strtoul etc. */
2337 if (sv_2iuv_non_preserve (sv, numtype)
2338 >= IS_NUMBER_OVERFLOW_IV)
2342 #endif /* NV_PRESERVES_UV */
2345 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2347 if (SvTYPE(sv) < SVt_IV)
2348 /* Typically the caller expects that sv_any is not NULL now. */
2349 sv_upgrade(sv, SVt_IV);
2352 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2353 PTR2UV(sv),SvIVX(sv)));
2354 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2357 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2358 * this function provided for binary compatibility only
2362 Perl_sv_2uv(pTHX_ register SV *sv)
2364 return sv_2uv_flags(sv, SV_GMAGIC);
2368 =for apidoc sv_2uv_flags
2370 Return the unsigned integer value of an SV, doing any necessary string
2371 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2372 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2378 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2382 if (SvGMAGICAL(sv)) {
2383 if (flags & SV_GMAGIC)
2388 return U_V(SvNVX(sv));
2389 if (SvPOKp(sv) && SvLEN(sv))
2392 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2393 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2399 if (SvTHINKFIRST(sv)) {
2402 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2403 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2404 return SvUV(tmpstr);
2405 return PTR2UV(SvRV(sv));
2408 sv_force_normal_flags(sv, 0);
2410 if (SvREADONLY(sv) && !SvOK(sv)) {
2411 if (ckWARN(WARN_UNINITIALIZED))
2421 return (UV)SvIVX(sv);
2425 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2426 * without also getting a cached IV/UV from it at the same time
2427 * (ie PV->NV conversion should detect loss of accuracy and cache
2428 * IV or UV at same time to avoid this. */
2429 /* IV-over-UV optimisation - choose to cache IV if possible */
2431 if (SvTYPE(sv) == SVt_NV)
2432 sv_upgrade(sv, SVt_PVNV);
2434 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2435 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2436 SvIVX(sv) = I_V(SvNVX(sv));
2437 if (SvNVX(sv) == (NV) SvIVX(sv)
2438 #ifndef NV_PRESERVES_UV
2439 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2440 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2441 /* Don't flag it as "accurately an integer" if the number
2442 came from a (by definition imprecise) NV operation, and
2443 we're outside the range of NV integer precision */
2446 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2447 DEBUG_c(PerlIO_printf(Perl_debug_log,
2448 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2454 /* IV not precise. No need to convert from PV, as NV
2455 conversion would already have cached IV if it detected
2456 that PV->IV would be better than PV->NV->IV
2457 flags already correct - don't set public IOK. */
2458 DEBUG_c(PerlIO_printf(Perl_debug_log,
2459 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2464 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2465 but the cast (NV)IV_MIN rounds to a the value less (more
2466 negative) than IV_MIN which happens to be equal to SvNVX ??
2467 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2468 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2469 (NV)UVX == NVX are both true, but the values differ. :-(
2470 Hopefully for 2s complement IV_MIN is something like
2471 0x8000000000000000 which will be exact. NWC */
2474 SvUVX(sv) = U_V(SvNVX(sv));
2476 (SvNVX(sv) == (NV) SvUVX(sv))
2477 #ifndef NV_PRESERVES_UV
2478 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2479 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2480 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2481 /* Don't flag it as "accurately an integer" if the number
2482 came from a (by definition imprecise) NV operation, and
2483 we're outside the range of NV integer precision */
2488 DEBUG_c(PerlIO_printf(Perl_debug_log,
2489 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2495 else if (SvPOKp(sv) && SvLEN(sv)) {
2497 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2499 /* We want to avoid a possible problem when we cache a UV which
2500 may be later translated to an NV, and the resulting NV is not
2501 the translation of the initial data.
2503 This means that if we cache such a UV, we need to cache the
2504 NV as well. Moreover, we trade speed for space, and do not
2505 cache the NV if not needed.
2508 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2509 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2510 == IS_NUMBER_IN_UV) {
2511 /* It's definitely an integer, only upgrade to PVIV */
2512 if (SvTYPE(sv) < SVt_PVIV)
2513 sv_upgrade(sv, SVt_PVIV);
2515 } else if (SvTYPE(sv) < SVt_PVNV)
2516 sv_upgrade(sv, SVt_PVNV);
2518 /* If NV preserves UV then we only use the UV value if we know that
2519 we aren't going to call atof() below. If NVs don't preserve UVs
2520 then the value returned may have more precision than atof() will
2521 return, even though it isn't accurate. */
2522 if ((numtype & (IS_NUMBER_IN_UV
2523 #ifdef NV_PRESERVES_UV
2526 )) == IS_NUMBER_IN_UV) {
2527 /* This won't turn off the public IOK flag if it was set above */
2528 (void)SvIOKp_on(sv);
2530 if (!(numtype & IS_NUMBER_NEG)) {
2532 if (value <= (UV)IV_MAX) {
2533 SvIVX(sv) = (IV)value;
2535 /* it didn't overflow, and it was positive. */
2540 /* 2s complement assumption */
2541 if (value <= (UV)IV_MIN) {
2542 SvIVX(sv) = -(IV)value;
2544 /* Too negative for an IV. This is a double upgrade, but
2545 I'm assuming it will be rare. */
2546 if (SvTYPE(sv) < SVt_PVNV)
2547 sv_upgrade(sv, SVt_PVNV);
2551 SvNVX(sv) = -(NV)value;
2557 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2558 != IS_NUMBER_IN_UV) {
2559 /* It wasn't an integer, or it overflowed the UV. */
2560 SvNVX(sv) = Atof(SvPVX(sv));
2562 if (! numtype && ckWARN(WARN_NUMERIC))
2565 #if defined(USE_LONG_DOUBLE)
2566 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2567 PTR2UV(sv), SvNVX(sv)));
2569 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2570 PTR2UV(sv), SvNVX(sv)));
2573 #ifdef NV_PRESERVES_UV
2574 (void)SvIOKp_on(sv);
2576 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2577 SvIVX(sv) = I_V(SvNVX(sv));
2578 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2581 /* Integer is imprecise. NOK, IOKp */
2583 /* UV will not work better than IV */
2585 if (SvNVX(sv) > (NV)UV_MAX) {
2587 /* Integer is inaccurate. NOK, IOKp, is UV */
2591 SvUVX(sv) = U_V(SvNVX(sv));
2592 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2593 NV preservse UV so can do correct comparison. */
2594 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2598 /* Integer is imprecise. NOK, IOKp, is UV */
2603 #else /* NV_PRESERVES_UV */
2604 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2605 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2606 /* The UV slot will have been set from value returned by
2607 grok_number above. The NV slot has just been set using
2610 assert (SvIOKp(sv));
2612 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2613 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2614 /* Small enough to preserve all bits. */
2615 (void)SvIOKp_on(sv);
2617 SvIVX(sv) = I_V(SvNVX(sv));
2618 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2620 /* Assumption: first non-preserved integer is < IV_MAX,
2621 this NV is in the preserved range, therefore: */
2622 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2624 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs((double)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);
2627 sv_2iuv_non_preserve (sv, numtype);
2629 #endif /* NV_PRESERVES_UV */
2633 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2634 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2637 if (SvTYPE(sv) < SVt_IV)
2638 /* Typically the caller expects that sv_any is not NULL now. */
2639 sv_upgrade(sv, SVt_IV);
2643 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2644 PTR2UV(sv),SvUVX(sv)));
2645 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2651 Return the num value of an SV, doing any necessary string or integer
2652 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2659 Perl_sv_2nv(pTHX_ register SV *sv)
2663 if (SvGMAGICAL(sv)) {
2667 if (SvPOKp(sv) && SvLEN(sv)) {
2668 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2669 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
2671 return Atof(SvPVX(sv));
2675 return (NV)SvUVX(sv);
2677 return (NV)SvIVX(sv);
2680 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2681 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2687 if (SvTHINKFIRST(sv)) {
2690 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2691 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2692 return SvNV(tmpstr);
2693 return PTR2NV(SvRV(sv));
2696 sv_force_normal_flags(sv, 0);
2698 if (SvREADONLY(sv) && !SvOK(sv)) {
2699 if (ckWARN(WARN_UNINITIALIZED))
2704 if (SvTYPE(sv) < SVt_NV) {
2705 if (SvTYPE(sv) == SVt_IV)
2706 sv_upgrade(sv, SVt_PVNV);
2708 sv_upgrade(sv, SVt_NV);
2709 #ifdef USE_LONG_DOUBLE
2711 STORE_NUMERIC_LOCAL_SET_STANDARD();
2712 PerlIO_printf(Perl_debug_log,
2713 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2714 PTR2UV(sv), SvNVX(sv));
2715 RESTORE_NUMERIC_LOCAL();
2719 STORE_NUMERIC_LOCAL_SET_STANDARD();
2720 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2721 PTR2UV(sv), SvNVX(sv));
2722 RESTORE_NUMERIC_LOCAL();
2726 else if (SvTYPE(sv) < SVt_PVNV)
2727 sv_upgrade(sv, SVt_PVNV);
2732 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
2733 #ifdef NV_PRESERVES_UV
2736 /* Only set the public NV OK flag if this NV preserves the IV */
2737 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2738 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2739 : (SvIVX(sv) == I_V(SvNVX(sv))))
2745 else if (SvPOKp(sv) && SvLEN(sv)) {
2747 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2748 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2750 #ifdef NV_PRESERVES_UV
2751 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2752 == IS_NUMBER_IN_UV) {
2753 /* It's definitely an integer */
2754 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
2756 SvNVX(sv) = Atof(SvPVX(sv));
2759 SvNVX(sv) = Atof(SvPVX(sv));
2760 /* Only set the public NV OK flag if this NV preserves the value in
2761 the PV at least as well as an IV/UV would.
2762 Not sure how to do this 100% reliably. */
2763 /* if that shift count is out of range then Configure's test is
2764 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2766 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2767 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2768 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2769 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2770 /* Can't use strtol etc to convert this string, so don't try.
2771 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2774 /* value has been set. It may not be precise. */
2775 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2776 /* 2s complement assumption for (UV)IV_MIN */
2777 SvNOK_on(sv); /* Integer is too negative. */
2782 if (numtype & IS_NUMBER_NEG) {
2783 SvIVX(sv) = -(IV)value;
2784 } else if (value <= (UV)IV_MAX) {
2785 SvIVX(sv) = (IV)value;
2791 if (numtype & IS_NUMBER_NOT_INT) {
2792 /* I believe that even if the original PV had decimals,
2793 they are lost beyond the limit of the FP precision.
2794 However, neither is canonical, so both only get p
2795 flags. NWC, 2000/11/25 */
2796 /* Both already have p flags, so do nothing */
2799 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2800 if (SvIVX(sv) == I_V(nv)) {
2805 /* It had no "." so it must be integer. */
2808 /* between IV_MAX and NV(UV_MAX).
2809 Could be slightly > UV_MAX */
2811 if (numtype & IS_NUMBER_NOT_INT) {
2812 /* UV and NV both imprecise. */
2814 UV nv_as_uv = U_V(nv);
2816 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2827 #endif /* NV_PRESERVES_UV */
2830 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2832 if (SvTYPE(sv) < SVt_NV)
2833 /* Typically the caller expects that sv_any is not NULL now. */
2834 /* XXX Ilya implies that this is a bug in callers that assume this
2835 and ideally should be fixed. */
2836 sv_upgrade(sv, SVt_NV);
2839 #if defined(USE_LONG_DOUBLE)
2841 STORE_NUMERIC_LOCAL_SET_STANDARD();
2842 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2843 PTR2UV(sv), SvNVX(sv));
2844 RESTORE_NUMERIC_LOCAL();
2848 STORE_NUMERIC_LOCAL_SET_STANDARD();
2849 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2850 PTR2UV(sv), SvNVX(sv));
2851 RESTORE_NUMERIC_LOCAL();
2857 /* asIV(): extract an integer from the string value of an SV.
2858 * Caller must validate PVX */
2861 S_asIV(pTHX_ SV *sv)
2864 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2866 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2867 == IS_NUMBER_IN_UV) {
2868 /* It's definitely an integer */
2869 if (numtype & IS_NUMBER_NEG) {
2870 if (value < (UV)IV_MIN)
2873 if (value < (UV)IV_MAX)
2878 if (ckWARN(WARN_NUMERIC))
2881 return I_V(Atof(SvPVX(sv)));
2884 /* asUV(): extract an unsigned integer from the string value of an SV
2885 * Caller must validate PVX */
2888 S_asUV(pTHX_ SV *sv)
2891 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2893 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2894 == IS_NUMBER_IN_UV) {
2895 /* It's definitely an integer */
2896 if (!(numtype & IS_NUMBER_NEG))
2900 if (ckWARN(WARN_NUMERIC))
2903 return U_V(Atof(SvPVX(sv)));
2907 =for apidoc sv_2pv_nolen
2909 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2910 use the macro wrapper C<SvPV_nolen(sv)> instead.
2915 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2918 return sv_2pv(sv, &n_a);
2921 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2922 * UV as a string towards the end of buf, and return pointers to start and
2925 * We assume that buf is at least TYPE_CHARS(UV) long.
2929 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2931 char *ptr = buf + TYPE_CHARS(UV);
2945 *--ptr = '0' + (char)(uv % 10);
2953 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2954 * this function provided for binary compatibility only
2958 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2960 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2964 =for apidoc sv_2pv_flags
2966 Returns a pointer to the string value of an SV, and sets *lp to its length.
2967 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2969 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2970 usually end up here too.
2976 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2981 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2982 char *tmpbuf = tbuf;
2988 if (SvGMAGICAL(sv)) {
2989 if (flags & SV_GMAGIC)
2997 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2999 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3004 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3009 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3010 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3017 if (SvTHINKFIRST(sv)) {
3020 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3021 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3022 char *pv = SvPV(tmpstr, *lp);
3036 switch (SvTYPE(sv)) {
3038 if ( ((SvFLAGS(sv) &
3039 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3040 == (SVs_OBJECT|SVs_SMG))
3041 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3042 regexp *re = (regexp *)mg->mg_obj;
3045 char *fptr = "msix";
3050 char need_newline = 0;
3051 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3053 while((ch = *fptr++)) {
3055 reflags[left++] = ch;
3058 reflags[right--] = ch;
3063 reflags[left] = '-';
3067 mg->mg_len = re->prelen + 4 + left;
3069 * If /x was used, we have to worry about a regex
3070 * ending with a comment later being embedded
3071 * within another regex. If so, we don't want this
3072 * regex's "commentization" to leak out to the
3073 * right part of the enclosing regex, we must cap
3074 * it with a newline.
3076 * So, if /x was used, we scan backwards from the
3077 * end of the regex. If we find a '#' before we
3078 * find a newline, we need to add a newline
3079 * ourself. If we find a '\n' first (or if we
3080 * don't find '#' or '\n'), we don't need to add
3081 * anything. -jfriedl
3083 if (PMf_EXTENDED & re->reganch)
3085 char *endptr = re->precomp + re->prelen;
3086 while (endptr >= re->precomp)
3088 char c = *(endptr--);
3090 break; /* don't need another */
3092 /* we end while in a comment, so we
3094 mg->mg_len++; /* save space for it */
3095 need_newline = 1; /* note to add it */
3101 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3102 Copy("(?", mg->mg_ptr, 2, char);
3103 Copy(reflags, mg->mg_ptr+2, left, char);
3104 Copy(":", mg->mg_ptr+left+2, 1, char);
3105 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3107 mg->mg_ptr[mg->mg_len - 2] = '\n';
3108 mg->mg_ptr[mg->mg_len - 1] = ')';
3109 mg->mg_ptr[mg->mg_len] = 0;
3111 PL_reginterp_cnt += re->program[0].next_off;
3113 if (re->reganch & ROPT_UTF8)
3128 case SVt_PVBM: if (SvROK(sv))
3131 s = "SCALAR"; break;
3132 case SVt_PVLV: s = SvROK(sv) ? "REF"
3133 /* tied lvalues should appear to be
3134 * scalars for backwards compatitbility */
3135 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3136 ? "SCALAR" : "LVALUE"; break;
3137 case SVt_PVAV: s = "ARRAY"; break;
3138 case SVt_PVHV: s = "HASH"; break;
3139 case SVt_PVCV: s = "CODE"; break;
3140 case SVt_PVGV: s = "GLOB"; break;
3141 case SVt_PVFM: s = "FORMAT"; break;
3142 case SVt_PVIO: s = "IO"; break;
3143 default: s = "UNKNOWN"; break;
3147 if (HvNAME(SvSTASH(sv)))
3148 Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
3150 Perl_sv_setpvf(aTHX_ tsv, "__ANON__=%s", s);
3153 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3159 if (SvREADONLY(sv) && !SvOK(sv)) {
3160 if (ckWARN(WARN_UNINITIALIZED))
3166 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3167 /* I'm assuming that if both IV and NV are equally valid then
3168 converting the IV is going to be more efficient */
3169 U32 isIOK = SvIOK(sv);
3170 U32 isUIOK = SvIsUV(sv);
3171 char buf[TYPE_CHARS(UV)];
3174 if (SvTYPE(sv) < SVt_PVIV)
3175 sv_upgrade(sv, SVt_PVIV);
3177 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3179 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3180 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3181 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3182 SvCUR_set(sv, ebuf - ptr);
3192 else if (SvNOKp(sv)) {
3193 if (SvTYPE(sv) < SVt_PVNV)
3194 sv_upgrade(sv, SVt_PVNV);
3195 /* The +20 is pure guesswork. Configure test needed. --jhi */
3196 SvGROW(sv, NV_DIG + 20);
3198 olderrno = errno; /* some Xenix systems wipe out errno here */
3200 if (SvNVX(sv) == 0.0)
3201 (void)strcpy(s,"0");
3205 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3208 #ifdef FIXNEGATIVEZERO
3209 if (*s == '-' && s[1] == '0' && !s[2])
3219 if (ckWARN(WARN_UNINITIALIZED)
3220 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3223 if (SvTYPE(sv) < SVt_PV)
3224 /* Typically the caller expects that sv_any is not NULL now. */
3225 sv_upgrade(sv, SVt_PV);
3228 *lp = s - SvPVX(sv);
3231 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3232 PTR2UV(sv),SvPVX(sv)));
3236 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3237 /* Sneaky stuff here */
3241 tsv = newSVpv(tmpbuf, 0);
3257 len = strlen(tmpbuf);
3259 #ifdef FIXNEGATIVEZERO
3260 if (len == 2 && t[0] == '-' && t[1] == '0') {
3265 (void)SvUPGRADE(sv, SVt_PV);
3267 s = SvGROW(sv, len + 1);
3276 =for apidoc sv_copypv
3278 Copies a stringified representation of the source SV into the
3279 destination SV. Automatically performs any necessary mg_get and
3280 coercion of numeric values into strings. Guaranteed to preserve
3281 UTF-8 flag even from overloaded objects. Similar in nature to
3282 sv_2pv[_flags] but operates directly on an SV instead of just the
3283 string. Mostly uses sv_2pv_flags to do its work, except when that
3284 would lose the UTF-8'ness of the PV.
3290 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3295 sv_setpvn(dsv,s,len);
3303 =for apidoc sv_2pvbyte_nolen
3305 Return a pointer to the byte-encoded representation of the SV.
3306 May cause the SV to be downgraded from UTF-8 as a side-effect.
3308 Usually accessed via the C<SvPVbyte_nolen> macro.
3314 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3317 return sv_2pvbyte(sv, &n_a);
3321 =for apidoc sv_2pvbyte
3323 Return a pointer to the byte-encoded representation of the SV, and set *lp
3324 to its length. May cause the SV to be downgraded from UTF-8 as a
3327 Usually accessed via the C<SvPVbyte> macro.
3333 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3335 sv_utf8_downgrade(sv,0);
3336 return SvPV(sv,*lp);
3340 =for apidoc sv_2pvutf8_nolen
3342 Return a pointer to the UTF-8-encoded representation of the SV.
3343 May cause the SV to be upgraded to UTF-8 as a side-effect.
3345 Usually accessed via the C<SvPVutf8_nolen> macro.
3351 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3354 return sv_2pvutf8(sv, &n_a);
3358 =for apidoc sv_2pvutf8
3360 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3361 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3363 Usually accessed via the C<SvPVutf8> macro.
3369 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3371 sv_utf8_upgrade(sv);
3372 return SvPV(sv,*lp);
3376 =for apidoc sv_2bool
3378 This function is only called on magical items, and is only used by
3379 sv_true() or its macro equivalent.
3385 Perl_sv_2bool(pTHX_ register SV *sv)
3394 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3395 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3396 return (bool)SvTRUE(tmpsv);
3397 return SvRV(sv) != 0;
3400 register XPV* Xpvtmp;
3401 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3402 (*Xpvtmp->xpv_pv > '0' ||
3403 Xpvtmp->xpv_cur > 1 ||
3404 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3411 return SvIVX(sv) != 0;
3414 return SvNVX(sv) != 0.0;
3421 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3422 * this function provided for binary compatibility only
3427 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3429 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3433 =for apidoc sv_utf8_upgrade
3435 Convert the PV of an SV to its UTF-8-encoded form.
3436 Forces the SV to string form if it is not already.
3437 Always sets the SvUTF8 flag to avoid future validity checks even
3438 if all the bytes have hibit clear.
3440 This is not as a general purpose byte encoding to Unicode interface:
3441 use the Encode extension for that.
3443 =for apidoc sv_utf8_upgrade_flags
3445 Convert the PV of an SV to its UTF-8-encoded form.
3446 Forces the SV to string form if it is not already.
3447 Always sets the SvUTF8 flag to avoid future validity checks even
3448 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3449 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3450 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3452 This is not as a general purpose byte encoding to Unicode interface:
3453 use the Encode extension for that.
3459 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3469 (void) sv_2pv_flags(sv,&len, flags);
3478 sv_force_normal_flags(sv, 0);
3481 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3482 sv_recode_to_utf8(sv, PL_encoding);
3483 else { /* Assume Latin-1/EBCDIC */
3484 /* This function could be much more efficient if we
3485 * had a FLAG in SVs to signal if there are any hibit
3486 * chars in the PV. Given that there isn't such a flag
3487 * make the loop as fast as possible. */
3488 s = (U8 *) SvPVX(sv);
3489 e = (U8 *) SvEND(sv);
3493 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3498 (void)SvOOK_off(sv);
3500 len = SvCUR(sv) + 1; /* Plus the \0 */
3501 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3502 SvCUR(sv) = len - 1;
3504 Safefree(s); /* No longer using what was there before. */
3505 SvLEN(sv) = len; /* No longer know the real size. */
3507 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3514 =for apidoc sv_utf8_downgrade
3516 Attempt to convert the PV of an SV from UTF-8-encoded to byte encoding.
3517 This may not be possible if the PV contains non-byte encoding characters;
3518 if this is the case, either returns false or, if C<fail_ok> is not
3521 This is not as a general purpose Unicode to byte encoding interface:
3522 use the Encode extension for that.
3528 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3530 if (SvPOK(sv) && SvUTF8(sv)) {
3536 sv_force_normal_flags(sv, 0);
3538 s = (U8 *) SvPV(sv, len);
3539 if (!utf8_to_bytes(s, &len)) {
3544 Perl_croak(aTHX_ "Wide character in %s",
3547 Perl_croak(aTHX_ "Wide character");
3558 =for apidoc sv_utf8_encode
3560 Convert the PV of an SV to UTF-8-encoded, but then turn off the C<SvUTF8>
3561 flag so that it looks like octets again. Used as a building block
3562 for encode_utf8 in Encode.xs
3568 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3570 (void) sv_utf8_upgrade(sv);
3572 sv_force_normal_flags(sv, 0);
3574 if (SvREADONLY(sv)) {
3575 Perl_croak(aTHX_ PL_no_modify);
3581 =for apidoc sv_utf8_decode
3583 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3584 turn off SvUTF8 if needed so that we see characters. Used as a building block
3585 for decode_utf8 in Encode.xs
3591 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3597 /* The octets may have got themselves encoded - get them back as
3600 if (!sv_utf8_downgrade(sv, TRUE))
3603 /* it is actually just a matter of turning the utf8 flag on, but
3604 * we want to make sure everything inside is valid utf8 first.
3606 c = (U8 *) SvPVX(sv);
3607 if (!is_utf8_string(c, SvCUR(sv)+1))
3609 e = (U8 *) SvEND(sv);
3612 if (!UTF8_IS_INVARIANT(ch)) {
3621 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3622 * this function provided for binary compatibility only
3626 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3628 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3632 =for apidoc sv_setsv
3634 Copies the contents of the source SV C<ssv> into the destination SV
3635 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3636 function if the source SV needs to be reused. Does not handle 'set' magic.
3637 Loosely speaking, it performs a copy-by-value, obliterating any previous
3638 content of the destination.
3640 You probably want to use one of the assortment of wrappers, such as
3641 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3642 C<SvSetMagicSV_nosteal>.
3644 =for apidoc sv_setsv_flags
3646 Copies the contents of the source SV C<ssv> into the destination SV
3647 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3648 function if the source SV needs to be reused. Does not handle 'set' magic.
3649 Loosely speaking, it performs a copy-by-value, obliterating any previous
3650 content of the destination.
3651 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3652 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3653 implemented in terms of this function.
3655 You probably want to use one of the assortment of wrappers, such as
3656 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3657 C<SvSetMagicSV_nosteal>.
3659 This is the primary function for copying scalars, and most other
3660 copy-ish functions and macros use this underneath.
3666 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3668 register U32 sflags;
3674 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3676 sstr = &PL_sv_undef;
3677 stype = SvTYPE(sstr);
3678 dtype = SvTYPE(dstr);
3683 /* need to nuke the magic */
3685 SvRMAGICAL_off(dstr);
3688 /* There's a lot of redundancy below but we're going for speed here */
3693 if (dtype != SVt_PVGV) {
3694 (void)SvOK_off(dstr);
3702 sv_upgrade(dstr, SVt_IV);
3705 sv_upgrade(dstr, SVt_PVNV);
3709 sv_upgrade(dstr, SVt_PVIV);
3712 (void)SvIOK_only(dstr);
3713 SvIVX(dstr) = SvIVX(sstr);
3716 if (SvTAINTED(sstr))
3727 sv_upgrade(dstr, SVt_NV);
3732 sv_upgrade(dstr, SVt_PVNV);
3735 SvNVX(dstr) = SvNVX(sstr);
3736 (void)SvNOK_only(dstr);
3737 if (SvTAINTED(sstr))
3745 sv_upgrade(dstr, SVt_RV);
3746 else if (dtype == SVt_PVGV &&
3747 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3750 if (GvIMPORTED(dstr) != GVf_IMPORTED
3751 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3753 GvIMPORTED_on(dstr);
3762 #ifdef PERL_COPY_ON_WRITE
3763 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3764 if (dtype < SVt_PVIV)
3765 sv_upgrade(dstr, SVt_PVIV);
3772 sv_upgrade(dstr, SVt_PV);
3775 if (dtype < SVt_PVIV)
3776 sv_upgrade(dstr, SVt_PVIV);
3779 if (dtype < SVt_PVNV)
3780 sv_upgrade(dstr, SVt_PVNV);
3787 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
3790 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
3794 if (dtype <= SVt_PVGV) {
3796 if (dtype != SVt_PVGV) {
3797 char *name = GvNAME(sstr);
3798 STRLEN len = GvNAMELEN(sstr);
3799 /* don't upgrade SVt_PVLV: it can hold a glob */
3800 if (dtype != SVt_PVLV)
3801 sv_upgrade(dstr, SVt_PVGV);
3802 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3803 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3804 GvNAME(dstr) = savepvn(name, len);
3805 GvNAMELEN(dstr) = len;
3806 SvFAKE_on(dstr); /* can coerce to non-glob */
3808 /* ahem, death to those who redefine active sort subs */
3809 else if (PL_curstackinfo->si_type == PERLSI_SORT
3810 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3811 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3814 #ifdef GV_UNIQUE_CHECK
3815 if (GvUNIQUE((GV*)dstr)) {
3816 Perl_croak(aTHX_ PL_no_modify);
3820 (void)SvOK_off(dstr);
3821 GvINTRO_off(dstr); /* one-shot flag */
3823 GvGP(dstr) = gp_ref(GvGP(sstr));
3824 if (SvTAINTED(sstr))
3826 if (GvIMPORTED(dstr) != GVf_IMPORTED
3827 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3829 GvIMPORTED_on(dstr);
3837 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3839 if ((int)SvTYPE(sstr) != stype) {
3840 stype = SvTYPE(sstr);
3841 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3845 if (stype == SVt_PVLV)
3846 (void)SvUPGRADE(dstr, SVt_PVNV);
3848 (void)SvUPGRADE(dstr, (U32)stype);
3851 sflags = SvFLAGS(sstr);
3853 if (sflags & SVf_ROK) {
3854 if (dtype >= SVt_PV) {
3855 if (dtype == SVt_PVGV) {
3856 SV *sref = SvREFCNT_inc(SvRV(sstr));
3858 int intro = GvINTRO(dstr);
3860 #ifdef GV_UNIQUE_CHECK
3861 if (GvUNIQUE((GV*)dstr)) {
3862 Perl_croak(aTHX_ PL_no_modify);
3867 GvINTRO_off(dstr); /* one-shot flag */
3868 GvLINE(dstr) = CopLINE(PL_curcop);
3869 GvEGV(dstr) = (GV*)dstr;
3872 switch (SvTYPE(sref)) {
3875 SAVEGENERICSV(GvAV(dstr));
3877 dref = (SV*)GvAV(dstr);
3878 GvAV(dstr) = (AV*)sref;
3879 if (!GvIMPORTED_AV(dstr)
3880 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3882 GvIMPORTED_AV_on(dstr);
3887 SAVEGENERICSV(GvHV(dstr));
3889 dref = (SV*)GvHV(dstr);
3890 GvHV(dstr) = (HV*)sref;
3891 if (!GvIMPORTED_HV(dstr)
3892 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3894 GvIMPORTED_HV_on(dstr);
3899 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3900 SvREFCNT_dec(GvCV(dstr));
3901 GvCV(dstr) = Nullcv;
3902 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3903 PL_sub_generation++;
3905 SAVEGENERICSV(GvCV(dstr));
3908 dref = (SV*)GvCV(dstr);
3909 if (GvCV(dstr) != (CV*)sref) {
3910 CV* cv = GvCV(dstr);
3912 if (!GvCVGEN((GV*)dstr) &&
3913 (CvROOT(cv) || CvXSUB(cv)))
3915 /* ahem, death to those who redefine
3916 * active sort subs */
3917 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3918 PL_sortcop == CvSTART(cv))
3920 "Can't redefine active sort subroutine %s",
3921 GvENAME((GV*)dstr));
3922 /* Redefining a sub - warning is mandatory if
3923 it was a const and its value changed. */
3924 if (ckWARN(WARN_REDEFINE)
3926 && (!CvCONST((CV*)sref)
3927 || sv_cmp(cv_const_sv(cv),
3928 cv_const_sv((CV*)sref)))))
3930 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3932 ? "Constant subroutine %s::%s redefined"
3933 : "Subroutine %s::%s redefined",
3934 HvNAME(GvSTASH((GV*)dstr)),
3935 GvENAME((GV*)dstr));
3939 cv_ckproto(cv, (GV*)dstr,
3940 SvPOK(sref) ? SvPVX(sref) : Nullch);
3942 GvCV(dstr) = (CV*)sref;
3943 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3944 GvASSUMECV_on(dstr);
3945 PL_sub_generation++;
3947 if (!GvIMPORTED_CV(dstr)
3948 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3950 GvIMPORTED_CV_on(dstr);
3955 SAVEGENERICSV(GvIOp(dstr));
3957 dref = (SV*)GvIOp(dstr);
3958 GvIOp(dstr) = (IO*)sref;
3962 SAVEGENERICSV(GvFORM(dstr));
3964 dref = (SV*)GvFORM(dstr);
3965 GvFORM(dstr) = (CV*)sref;
3969 SAVEGENERICSV(GvSV(dstr));
3971 dref = (SV*)GvSV(dstr);
3973 if (!GvIMPORTED_SV(dstr)
3974 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3976 GvIMPORTED_SV_on(dstr);
3982 if (SvTAINTED(sstr))
3987 (void)SvOOK_off(dstr); /* backoff */
3989 Safefree(SvPVX(dstr));
3990 SvLEN(dstr)=SvCUR(dstr)=0;
3993 (void)SvOK_off(dstr);
3994 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
3996 if (sflags & SVp_NOK) {
3998 /* Only set the public OK flag if the source has public OK. */
3999 if (sflags & SVf_NOK)
4000 SvFLAGS(dstr) |= SVf_NOK;
4001 SvNVX(dstr) = SvNVX(sstr);
4003 if (sflags & SVp_IOK) {
4004 (void)SvIOKp_on(dstr);
4005 if (sflags & SVf_IOK)
4006 SvFLAGS(dstr) |= SVf_IOK;
4007 if (sflags & SVf_IVisUV)
4009 SvIVX(dstr) = SvIVX(sstr);
4011 if (SvAMAGIC(sstr)) {
4015 else if (sflags & SVp_POK) {
4019 * Check to see if we can just swipe the string. If so, it's a
4020 * possible small lose on short strings, but a big win on long ones.
4021 * It might even be a win on short strings if SvPVX(dstr)
4022 * has to be allocated and SvPVX(sstr) has to be freed.
4025 /* Whichever path we take through the next code, we want this true,
4026 and doing it now facilitates the COW check. */
4027 (void)SvPOK_only(dstr);
4030 #ifdef PERL_COPY_ON_WRITE
4031 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4035 (sflags & SVs_TEMP) && /* slated for free anyway? */
4036 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4037 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4038 SvLEN(sstr) && /* and really is a string */
4039 /* and won't be needed again, potentially */
4040 !(PL_op && PL_op->op_type == OP_AASSIGN))
4041 #ifdef PERL_COPY_ON_WRITE
4042 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4043 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4044 && SvTYPE(sstr) >= SVt_PVIV)
4047 /* Failed the swipe test, and it's not a shared hash key either.
4048 Have to copy the string. */
4049 STRLEN len = SvCUR(sstr);
4050 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4051 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4052 SvCUR_set(dstr, len);
4053 *SvEND(dstr) = '\0';
4055 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4057 #ifdef PERL_COPY_ON_WRITE
4058 /* Either it's a shared hash key, or it's suitable for
4059 copy-on-write or we can swipe the string. */
4061 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4066 /* I believe I should acquire a global SV mutex if
4067 it's a COW sv (not a shared hash key) to stop
4068 it going un copy-on-write.
4069 If the source SV has gone un copy on write between up there
4070 and down here, then (assert() that) it is of the correct
4071 form to make it copy on write again */
4072 if ((sflags & (SVf_FAKE | SVf_READONLY))
4073 != (SVf_FAKE | SVf_READONLY)) {
4074 SvREADONLY_on(sstr);
4076 /* Make the source SV into a loop of 1.
4077 (about to become 2) */
4078 SV_COW_NEXT_SV_SET(sstr, sstr);
4082 /* Initial code is common. */
4083 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4085 SvFLAGS(dstr) &= ~SVf_OOK;
4086 Safefree(SvPVX(dstr) - SvIVX(dstr));
4088 else if (SvLEN(dstr))
4089 Safefree(SvPVX(dstr));
4092 #ifdef PERL_COPY_ON_WRITE
4094 /* making another shared SV. */
4095 STRLEN cur = SvCUR(sstr);
4096 STRLEN len = SvLEN(sstr);
4097 assert (SvTYPE(dstr) >= SVt_PVIV);
4099 /* SvIsCOW_normal */
4100 /* splice us in between source and next-after-source. */
4101 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4102 SV_COW_NEXT_SV_SET(sstr, dstr);
4103 SvPV_set(dstr, SvPVX(sstr));
4105 /* SvIsCOW_shared_hash */
4106 UV hash = SvUVX(sstr);
4107 DEBUG_C(PerlIO_printf(Perl_debug_log,
4108 "Copy on write: Sharing hash\n"));
4110 sharepvn(SvPVX(sstr),
4111 (sflags & SVf_UTF8?-cur:cur), hash));
4116 SvREADONLY_on(dstr);
4118 /* Relesase a global SV mutex. */
4122 { /* Passes the swipe test. */
4123 SvPV_set(dstr, SvPVX(sstr));
4124 SvLEN_set(dstr, SvLEN(sstr));
4125 SvCUR_set(dstr, SvCUR(sstr));
4128 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4129 SvPV_set(sstr, Nullch);
4135 if (sflags & SVf_UTF8)
4138 if (sflags & SVp_NOK) {
4140 if (sflags & SVf_NOK)
4141 SvFLAGS(dstr) |= SVf_NOK;
4142 SvNVX(dstr) = SvNVX(sstr);
4144 if (sflags & SVp_IOK) {
4145 (void)SvIOKp_on(dstr);
4146 if (sflags & SVf_IOK)
4147 SvFLAGS(dstr) |= SVf_IOK;
4148 if (sflags & SVf_IVisUV)
4150 SvIVX(dstr) = SvIVX(sstr);
4153 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4154 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4155 smg->mg_ptr, smg->mg_len);
4156 SvRMAGICAL_on(dstr);
4159 else if (sflags & SVp_IOK) {
4160 if (sflags & SVf_IOK)
4161 (void)SvIOK_only(dstr);
4163 (void)SvOK_off(dstr);
4164 (void)SvIOKp_on(dstr);
4166 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4167 if (sflags & SVf_IVisUV)
4169 SvIVX(dstr) = SvIVX(sstr);
4170 if (sflags & SVp_NOK) {
4171 if (sflags & SVf_NOK)
4172 (void)SvNOK_on(dstr);
4174 (void)SvNOKp_on(dstr);
4175 SvNVX(dstr) = SvNVX(sstr);
4178 else if (sflags & SVp_NOK) {
4179 if (sflags & SVf_NOK)
4180 (void)SvNOK_only(dstr);
4182 (void)SvOK_off(dstr);
4185 SvNVX(dstr) = SvNVX(sstr);
4188 if (dtype == SVt_PVGV) {
4189 if (ckWARN(WARN_MISC))
4190 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4193 (void)SvOK_off(dstr);
4195 if (SvTAINTED(sstr))
4200 =for apidoc sv_setsv_mg
4202 Like C<sv_setsv>, but also handles 'set' magic.
4208 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4210 sv_setsv(dstr,sstr);
4214 #ifdef PERL_COPY_ON_WRITE
4216 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4218 STRLEN cur = SvCUR(sstr);
4219 STRLEN len = SvLEN(sstr);
4220 register char *new_pv;
4223 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4231 if (SvTHINKFIRST(dstr))
4232 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4233 else if (SvPVX(dstr))
4234 Safefree(SvPVX(dstr));
4238 (void)SvUPGRADE (dstr, SVt_PVIV);
4240 assert (SvPOK(sstr));
4241 assert (SvPOKp(sstr));
4242 assert (!SvIOK(sstr));
4243 assert (!SvIOKp(sstr));
4244 assert (!SvNOK(sstr));
4245 assert (!SvNOKp(sstr));
4247 if (SvIsCOW(sstr)) {
4249 if (SvLEN(sstr) == 0) {
4250 /* source is a COW shared hash key. */
4251 UV hash = SvUVX(sstr);
4252 DEBUG_C(PerlIO_printf(Perl_debug_log,
4253 "Fast copy on write: Sharing hash\n"));
4255 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4258 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4260 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4261 (void)SvUPGRADE (sstr, SVt_PVIV);
4262 SvREADONLY_on(sstr);
4264 DEBUG_C(PerlIO_printf(Perl_debug_log,
4265 "Fast copy on write: Converting sstr to COW\n"));
4266 SV_COW_NEXT_SV_SET(dstr, sstr);
4268 SV_COW_NEXT_SV_SET(sstr, dstr);
4269 new_pv = SvPVX(sstr);
4272 SvPV_set(dstr, new_pv);
4273 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4286 =for apidoc sv_setpvn
4288 Copies a string into an SV. The C<len> parameter indicates the number of
4289 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4295 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4297 register char *dptr;
4299 SV_CHECK_THINKFIRST_COW_DROP(sv);
4305 /* len is STRLEN which is unsigned, need to copy to signed */
4308 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4310 (void)SvUPGRADE(sv, SVt_PV);
4312 SvGROW(sv, len + 1);
4314 Move(ptr,dptr,len,char);
4317 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4322 =for apidoc sv_setpvn_mg
4324 Like C<sv_setpvn>, but also handles 'set' magic.
4330 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4332 sv_setpvn(sv,ptr,len);
4337 =for apidoc sv_setpv
4339 Copies a string into an SV. The string must be null-terminated. Does not
4340 handle 'set' magic. See C<sv_setpv_mg>.
4346 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4348 register STRLEN len;
4350 SV_CHECK_THINKFIRST_COW_DROP(sv);
4356 (void)SvUPGRADE(sv, SVt_PV);
4358 SvGROW(sv, len + 1);
4359 Move(ptr,SvPVX(sv),len+1,char);
4361 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4366 =for apidoc sv_setpv_mg
4368 Like C<sv_setpv>, but also handles 'set' magic.
4374 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4381 =for apidoc sv_usepvn
4383 Tells an SV to use C<ptr> to find its string value. Normally the string is
4384 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4385 The C<ptr> should point to memory that was allocated by C<malloc>. The
4386 string length, C<len>, must be supplied. This function will realloc the
4387 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4388 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4389 See C<sv_usepvn_mg>.
4395 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4397 SV_CHECK_THINKFIRST_COW_DROP(sv);
4398 (void)SvUPGRADE(sv, SVt_PV);
4403 (void)SvOOK_off(sv);
4404 if (SvPVX(sv) && SvLEN(sv))
4405 Safefree(SvPVX(sv));
4406 Renew(ptr, len+1, char);
4409 SvLEN_set(sv, len+1);
4411 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4416 =for apidoc sv_usepvn_mg
4418 Like C<sv_usepvn>, but also handles 'set' magic.
4424 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4426 sv_usepvn(sv,ptr,len);
4430 #ifdef PERL_COPY_ON_WRITE
4431 /* Need to do this *after* making the SV normal, as we need the buffer
4432 pointer to remain valid until after we've copied it. If we let go too early,
4433 another thread could invalidate it by unsharing last of the same hash key
4434 (which it can do by means other than releasing copy-on-write Svs)
4435 or by changing the other copy-on-write SVs in the loop. */
4437 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4438 U32 hash, SV *after)
4440 if (len) { /* this SV was SvIsCOW_normal(sv) */
4441 /* we need to find the SV pointing to us. */
4442 SV *current = SV_COW_NEXT_SV(after);
4444 if (current == sv) {
4445 /* The SV we point to points back to us (there were only two of us
4447 Hence other SV is no longer copy on write either. */
4449 SvREADONLY_off(after);
4451 /* We need to follow the pointers around the loop. */
4453 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4456 /* don't loop forever if the structure is bust, and we have
4457 a pointer into a closed loop. */
4458 assert (current != after);
4459 assert (SvPVX(current) == pvx);
4461 /* Make the SV before us point to the SV after us. */
4462 SV_COW_NEXT_SV_SET(current, after);
4465 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4470 Perl_sv_release_IVX(pTHX_ register SV *sv)
4473 sv_force_normal_flags(sv, 0);
4474 return SvOOK_off(sv);
4478 =for apidoc sv_force_normal_flags
4480 Undo various types of fakery on an SV: if the PV is a shared string, make
4481 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4482 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4483 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4484 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4485 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4486 set to some other value.) In addition, the C<flags> parameter gets passed to
4487 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4488 with flags set to 0.
4494 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4496 #ifdef PERL_COPY_ON_WRITE
4497 if (SvREADONLY(sv)) {
4498 /* At this point I believe I should acquire a global SV mutex. */
4500 char *pvx = SvPVX(sv);
4501 STRLEN len = SvLEN(sv);
4502 STRLEN cur = SvCUR(sv);
4503 U32 hash = SvUVX(sv);
4504 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4506 PerlIO_printf(Perl_debug_log,
4507 "Copy on write: Force normal %ld\n",
4513 /* This SV doesn't own the buffer, so need to New() a new one: */
4516 if (flags & SV_COW_DROP_PV) {
4517 /* OK, so we don't need to copy our buffer. */
4520 SvGROW(sv, cur + 1);
4521 Move(pvx,SvPVX(sv),cur,char);
4525 sv_release_COW(sv, pvx, cur, len, hash, next);
4530 else if (IN_PERL_RUNTIME)
4531 Perl_croak(aTHX_ PL_no_modify);
4532 /* At this point I believe that I can drop the global SV mutex. */
4535 if (SvREADONLY(sv)) {
4537 char *pvx = SvPVX(sv);
4538 int is_utf8 = SvUTF8(sv);
4539 STRLEN len = SvCUR(sv);
4540 U32 hash = SvUVX(sv);
4545 SvGROW(sv, len + 1);
4546 Move(pvx,SvPVX(sv),len,char);
4548 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
4550 else if (IN_PERL_RUNTIME)
4551 Perl_croak(aTHX_ PL_no_modify);
4555 sv_unref_flags(sv, flags);
4556 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4561 =for apidoc sv_force_normal
4563 Undo various types of fakery on an SV: if the PV is a shared string, make
4564 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4565 an xpvmg. See also C<sv_force_normal_flags>.
4571 Perl_sv_force_normal(pTHX_ register SV *sv)
4573 sv_force_normal_flags(sv, 0);
4579 Efficient removal of characters from the beginning of the string buffer.
4580 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4581 the string buffer. The C<ptr> becomes the first character of the adjusted
4582 string. Uses the "OOK hack".
4583 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
4584 refer to the same chunk of data.
4590 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
4592 register STRLEN delta;
4593 if (!ptr || !SvPOKp(sv))
4595 delta = ptr - SvPVX(sv);
4596 SV_CHECK_THINKFIRST(sv);
4597 if (SvTYPE(sv) < SVt_PVIV)
4598 sv_upgrade(sv,SVt_PVIV);
4601 if (!SvLEN(sv)) { /* make copy of shared string */
4602 char *pvx = SvPVX(sv);
4603 STRLEN len = SvCUR(sv);
4604 SvGROW(sv, len + 1);
4605 Move(pvx,SvPVX(sv),len,char);
4609 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4610 and we do that anyway inside the SvNIOK_off
4612 SvFLAGS(sv) |= SVf_OOK;
4621 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4622 * this function provided for binary compatibility only
4626 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4628 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4632 =for apidoc sv_catpvn
4634 Concatenates the string onto the end of the string which is in the SV. The
4635 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4636 status set, then the bytes appended should be valid UTF-8.
4637 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4639 =for apidoc sv_catpvn_flags
4641 Concatenates the string onto the end of the string which is in the SV. The
4642 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4643 status set, then the bytes appended should be valid UTF-8.
4644 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4645 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4646 in terms of this function.
4652 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4657 dstr = SvPV_force_flags(dsv, dlen, flags);
4658 SvGROW(dsv, dlen + slen + 1);
4661 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4664 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4669 =for apidoc sv_catpvn_mg
4671 Like C<sv_catpvn>, but also handles 'set' magic.
4677 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4679 sv_catpvn(sv,ptr,len);
4683 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4684 * this function provided for binary compatibility only
4688 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4690 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4694 =for apidoc sv_catsv
4696 Concatenates the string from SV C<ssv> onto the end of the string in
4697 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4698 not 'set' magic. See C<sv_catsv_mg>.
4700 =for apidoc sv_catsv_flags
4702 Concatenates the string from SV C<ssv> onto the end of the string in
4703 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4704 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4705 and C<sv_catsv_nomg> are implemented in terms of this function.
4710 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4716 if ((spv = SvPV(ssv, slen))) {
4717 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4718 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4719 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4720 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4721 dsv->sv_flags doesn't have that bit set.
4722 Andy Dougherty 12 Oct 2001
4724 I32 sutf8 = DO_UTF8(ssv);
4727 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4729 dutf8 = DO_UTF8(dsv);
4731 if (dutf8 != sutf8) {
4733 /* Not modifying source SV, so taking a temporary copy. */
4734 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4736 sv_utf8_upgrade(csv);
4737 spv = SvPV(csv, slen);
4740 sv_utf8_upgrade_nomg(dsv);
4742 sv_catpvn_nomg(dsv, spv, slen);
4747 =for apidoc sv_catsv_mg
4749 Like C<sv_catsv>, but also handles 'set' magic.
4755 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4762 =for apidoc sv_catpv
4764 Concatenates the string onto the end of the string which is in the SV.
4765 If the SV has the UTF-8 status set, then the bytes appended should be
4766 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4771 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4773 register STRLEN len;
4779 junk = SvPV_force(sv, tlen);
4781 SvGROW(sv, tlen + len + 1);
4784 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4786 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4791 =for apidoc sv_catpv_mg
4793 Like C<sv_catpv>, but also handles 'set' magic.
4799 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4808 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4809 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4816 Perl_newSV(pTHX_ STRLEN len)
4822 sv_upgrade(sv, SVt_PV);
4823 SvGROW(sv, len + 1);
4828 =for apidoc sv_magicext
4830 Adds magic to an SV, upgrading it if necessary. Applies the
4831 supplied vtable and returns pointer to the magic added.
4833 Note that sv_magicext will allow things that sv_magic will not.
4834 In particular you can add magic to SvREADONLY SVs and and more than
4835 one instance of the same 'how'
4837 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4838 if C<namelen> is zero then C<name> is stored as-is and - as another special
4839 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4840 an C<SV*> and has its REFCNT incremented
4842 (This is now used as a subroutine by sv_magic.)
4847 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4848 const char* name, I32 namlen)
4852 if (SvTYPE(sv) < SVt_PVMG) {
4853 (void)SvUPGRADE(sv, SVt_PVMG);
4855 Newz(702,mg, 1, MAGIC);
4856 mg->mg_moremagic = SvMAGIC(sv);
4859 /* Some magic sontains a reference loop, where the sv and object refer to
4860 each other. To prevent a reference loop that would prevent such
4861 objects being freed, we look for such loops and if we find one we
4862 avoid incrementing the object refcount.
4864 Note we cannot do this to avoid self-tie loops as intervening RV must
4865 have its REFCNT incremented to keep it in existence.
4868 if (!obj || obj == sv ||
4869 how == PERL_MAGIC_arylen ||
4870 how == PERL_MAGIC_qr ||
4871 (SvTYPE(obj) == SVt_PVGV &&
4872 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4873 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4874 GvFORM(obj) == (CV*)sv)))
4879 mg->mg_obj = SvREFCNT_inc(obj);
4880 mg->mg_flags |= MGf_REFCOUNTED;
4883 /* Normal self-ties simply pass a null object, and instead of
4884 using mg_obj directly, use the SvTIED_obj macro to produce a
4885 new RV as needed. For glob "self-ties", we are tieing the PVIO
4886 with an RV obj pointing to the glob containing the PVIO. In
4887 this case, to avoid a reference loop, we need to weaken the
4891 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4892 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4898 mg->mg_len = namlen;
4901 mg->mg_ptr = savepvn(name, namlen);
4902 else if (namlen == HEf_SVKEY)
4903 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4905 mg->mg_ptr = (char *) name;
4907 mg->mg_virtual = vtable;
4911 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4916 =for apidoc sv_magic
4918 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4919 then adds a new magic item of type C<how> to the head of the magic list.
4925 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4930 #ifdef PERL_COPY_ON_WRITE
4932 sv_force_normal_flags(sv, 0);
4934 if (SvREADONLY(sv)) {
4936 && how != PERL_MAGIC_regex_global
4937 && how != PERL_MAGIC_bm
4938 && how != PERL_MAGIC_fm
4939 && how != PERL_MAGIC_sv
4940 && how != PERL_MAGIC_backref
4943 Perl_croak(aTHX_ PL_no_modify);
4946 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4947 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4948 /* sv_magic() refuses to add a magic of the same 'how' as an
4951 if (how == PERL_MAGIC_taint)
4959 vtable = &PL_vtbl_sv;
4961 case PERL_MAGIC_overload:
4962 vtable = &PL_vtbl_amagic;
4964 case PERL_MAGIC_overload_elem:
4965 vtable = &PL_vtbl_amagicelem;
4967 case PERL_MAGIC_overload_table:
4968 vtable = &PL_vtbl_ovrld;
4971 vtable = &PL_vtbl_bm;
4973 case PERL_MAGIC_regdata:
4974 vtable = &PL_vtbl_regdata;
4976 case PERL_MAGIC_regdatum:
4977 vtable = &PL_vtbl_regdatum;
4979 case PERL_MAGIC_env:
4980 vtable = &PL_vtbl_env;
4983 vtable = &PL_vtbl_fm;
4985 case PERL_MAGIC_envelem:
4986 vtable = &PL_vtbl_envelem;
4988 case PERL_MAGIC_regex_global:
4989 vtable = &PL_vtbl_mglob;
4991 case PERL_MAGIC_isa:
4992 vtable = &PL_vtbl_isa;
4994 case PERL_MAGIC_isaelem:
4995 vtable = &PL_vtbl_isaelem;
4997 case PERL_MAGIC_nkeys:
4998 vtable = &PL_vtbl_nkeys;
5000 case PERL_MAGIC_dbfile:
5003 case PERL_MAGIC_dbline:
5004 vtable = &PL_vtbl_dbline;
5006 #ifdef USE_LOCALE_COLLATE
5007 case PERL_MAGIC_collxfrm:
5008 vtable = &PL_vtbl_collxfrm;
5010 #endif /* USE_LOCALE_COLLATE */
5011 case PERL_MAGIC_tied:
5012 vtable = &PL_vtbl_pack;
5014 case PERL_MAGIC_tiedelem:
5015 case PERL_MAGIC_tiedscalar:
5016 vtable = &PL_vtbl_packelem;
5019 vtable = &PL_vtbl_regexp;
5021 case PERL_MAGIC_sig:
5022 vtable = &PL_vtbl_sig;
5024 case PERL_MAGIC_sigelem:
5025 vtable = &PL_vtbl_sigelem;
5027 case PERL_MAGIC_taint:
5028 vtable = &PL_vtbl_taint;
5030 case PERL_MAGIC_uvar:
5031 vtable = &PL_vtbl_uvar;
5033 case PERL_MAGIC_vec:
5034 vtable = &PL_vtbl_vec;
5036 case PERL_MAGIC_vstring:
5039 case PERL_MAGIC_utf8:
5040 vtable = &PL_vtbl_utf8;
5042 case PERL_MAGIC_substr:
5043 vtable = &PL_vtbl_substr;
5045 case PERL_MAGIC_defelem:
5046 vtable = &PL_vtbl_defelem;
5048 case PERL_MAGIC_glob:
5049 vtable = &PL_vtbl_glob;
5051 case PERL_MAGIC_arylen:
5052 vtable = &PL_vtbl_arylen;
5054 case PERL_MAGIC_pos:
5055 vtable = &PL_vtbl_pos;
5057 case PERL_MAGIC_backref:
5058 vtable = &PL_vtbl_backref;
5060 case PERL_MAGIC_ext:
5061 /* Reserved for use by extensions not perl internals. */
5062 /* Useful for attaching extension internal data to perl vars. */
5063 /* Note that multiple extensions may clash if magical scalars */
5064 /* etc holding private data from one are passed to another. */
5067 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5070 /* Rest of work is done else where */
5071 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5074 case PERL_MAGIC_taint:
5077 case PERL_MAGIC_ext:
5078 case PERL_MAGIC_dbfile:
5085 =for apidoc sv_unmagic
5087 Removes all magic of type C<type> from an SV.
5093 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5097 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5100 for (mg = *mgp; mg; mg = *mgp) {
5101 if (mg->mg_type == type) {
5102 MGVTBL* vtbl = mg->mg_virtual;
5103 *mgp = mg->mg_moremagic;
5104 if (vtbl && vtbl->svt_free)
5105 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5106 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5108 Safefree(mg->mg_ptr);
5109 else if (mg->mg_len == HEf_SVKEY)
5110 SvREFCNT_dec((SV*)mg->mg_ptr);
5111 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5112 Safefree(mg->mg_ptr);
5114 if (mg->mg_flags & MGf_REFCOUNTED)
5115 SvREFCNT_dec(mg->mg_obj);
5119 mgp = &mg->mg_moremagic;
5123 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5130 =for apidoc sv_rvweaken
5132 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5133 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5134 push a back-reference to this RV onto the array of backreferences
5135 associated with that magic.
5141 Perl_sv_rvweaken(pTHX_ SV *sv)
5144 if (!SvOK(sv)) /* let undefs pass */
5147 Perl_croak(aTHX_ "Can't weaken a nonreference");
5148 else if (SvWEAKREF(sv)) {
5149 if (ckWARN(WARN_MISC))
5150 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5154 sv_add_backref(tsv, sv);
5160 /* Give tsv backref magic if it hasn't already got it, then push a
5161 * back-reference to sv onto the array associated with the backref magic.
5165 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5169 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5170 av = (AV*)mg->mg_obj;
5173 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5174 /* av now has a refcnt of 2, which avoids it getting freed
5175 * before us during global cleanup. The extra ref is removed
5176 * by magic_killbackrefs() when tsv is being freed */
5178 if (AvFILLp(av) >= AvMAX(av)) {
5180 SV **svp = AvARRAY(av);
5181 for (i = AvFILLp(av); i >= 0; i--)
5183 svp[i] = sv; /* reuse the slot */
5186 av_extend(av, AvFILLp(av)+1);
5188 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5191 /* delete a back-reference to ourselves from the backref magic associated
5192 * with the SV we point to.
5196 S_sv_del_backref(pTHX_ SV *sv)
5203 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5204 Perl_croak(aTHX_ "panic: del_backref");
5205 av = (AV *)mg->mg_obj;
5207 for (i = AvFILLp(av); i >= 0; i--)
5208 if (svp[i] == sv) svp[i] = Nullsv;
5212 =for apidoc sv_insert
5214 Inserts a string at the specified offset/length within the SV. Similar to
5215 the Perl substr() function.
5221 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5225 register char *midend;
5226 register char *bigend;
5232 Perl_croak(aTHX_ "Can't modify non-existent substring");
5233 SvPV_force(bigstr, curlen);
5234 (void)SvPOK_only_UTF8(bigstr);
5235 if (offset + len > curlen) {
5236 SvGROW(bigstr, offset+len+1);
5237 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5238 SvCUR_set(bigstr, offset+len);
5242 i = littlelen - len;
5243 if (i > 0) { /* string might grow */
5244 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5245 mid = big + offset + len;
5246 midend = bigend = big + SvCUR(bigstr);
5249 while (midend > mid) /* shove everything down */
5250 *--bigend = *--midend;
5251 Move(little,big+offset,littlelen,char);
5257 Move(little,SvPVX(bigstr)+offset,len,char);
5262 big = SvPVX(bigstr);
5265 bigend = big + SvCUR(bigstr);
5267 if (midend > bigend)
5268 Perl_croak(aTHX_ "panic: sv_insert");
5270 if (mid - big > bigend - midend) { /* faster to shorten from end */
5272 Move(little, mid, littlelen,char);
5275 i = bigend - midend;
5277 Move(midend, mid, i,char);
5281 SvCUR_set(bigstr, mid - big);
5284 else if ((i = mid - big)) { /* faster from front */
5285 midend -= littlelen;
5287 sv_chop(bigstr,midend-i);
5292 Move(little, mid, littlelen,char);
5294 else if (littlelen) {
5295 midend -= littlelen;
5296 sv_chop(bigstr,midend);
5297 Move(little,midend,littlelen,char);
5300 sv_chop(bigstr,midend);
5306 =for apidoc sv_replace
5308 Make the first argument a copy of the second, then delete the original.
5309 The target SV physically takes over ownership of the body of the source SV
5310 and inherits its flags; however, the target keeps any magic it owns,
5311 and any magic in the source is discarded.
5312 Note that this is a rather specialist SV copying operation; most of the
5313 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5319 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5321 U32 refcnt = SvREFCNT(sv);
5322 SV_CHECK_THINKFIRST_COW_DROP(sv);
5323 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5324 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5325 if (SvMAGICAL(sv)) {
5329 sv_upgrade(nsv, SVt_PVMG);
5330 SvMAGIC(nsv) = SvMAGIC(sv);
5331 SvFLAGS(nsv) |= SvMAGICAL(sv);
5337 assert(!SvREFCNT(sv));
5338 StructCopy(nsv,sv,SV);
5339 #ifdef PERL_COPY_ON_WRITE
5340 if (SvIsCOW_normal(nsv)) {
5341 /* We need to follow the pointers around the loop to make the
5342 previous SV point to sv, rather than nsv. */
5345 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5348 assert(SvPVX(current) == SvPVX(nsv));
5350 /* Make the SV before us point to the SV after us. */
5352 PerlIO_printf(Perl_debug_log, "previous is\n");
5354 PerlIO_printf(Perl_debug_log,
5355 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5356 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5358 SV_COW_NEXT_SV_SET(current, sv);
5361 SvREFCNT(sv) = refcnt;
5362 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5368 =for apidoc sv_clear
5370 Clear an SV: call any destructors, free up any memory used by the body,
5371 and free the body itself. The SV's head is I<not> freed, although
5372 its type is set to all 1's so that it won't inadvertently be assumed
5373 to be live during global destruction etc.
5374 This function should only be called when REFCNT is zero. Most of the time
5375 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5382 Perl_sv_clear(pTHX_ register SV *sv)
5386 assert(SvREFCNT(sv) == 0);
5389 if (PL_defstash) { /* Still have a symbol table? */
5396 stash = SvSTASH(sv);
5397 destructor = StashHANDLER(stash,DESTROY);
5399 SV* tmpref = newRV(sv);
5400 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5402 PUSHSTACKi(PERLSI_DESTROY);
5407 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5413 if(SvREFCNT(tmpref) < 2) {
5414 /* tmpref is not kept alive! */
5419 SvREFCNT_dec(tmpref);
5421 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5425 if (PL_in_clean_objs)
5426 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5428 /* DESTROY gave object new lease on life */
5434 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5435 SvOBJECT_off(sv); /* Curse the object. */
5436 if (SvTYPE(sv) != SVt_PVIO)
5437 --PL_sv_objcount; /* XXX Might want something more general */
5440 if (SvTYPE(sv) >= SVt_PVMG) {
5443 if (SvFLAGS(sv) & SVpad_TYPED)
5444 SvREFCNT_dec(SvSTASH(sv));
5447 switch (SvTYPE(sv)) {
5450 IoIFP(sv) != PerlIO_stdin() &&
5451 IoIFP(sv) != PerlIO_stdout() &&
5452 IoIFP(sv) != PerlIO_stderr())
5454 io_close((IO*)sv, FALSE);
5456 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5457 PerlDir_close(IoDIRP(sv));
5458 IoDIRP(sv) = (DIR*)NULL;
5459 Safefree(IoTOP_NAME(sv));
5460 Safefree(IoFMT_NAME(sv));
5461 Safefree(IoBOTTOM_NAME(sv));
5476 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5477 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5478 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5479 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5481 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5482 SvREFCNT_dec(LvTARG(sv));
5486 Safefree(GvNAME(sv));
5487 /* cannot decrease stash refcount yet, as we might recursively delete
5488 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5489 of stash until current sv is completely gone.
5490 -- JohnPC, 27 Mar 1998 */
5491 stash = GvSTASH(sv);
5497 (void)SvOOK_off(sv);
5505 SvREFCNT_dec(SvRV(sv));
5507 #ifdef PERL_COPY_ON_WRITE
5508 else if (SvPVX(sv)) {
5510 /* I believe I need to grab the global SV mutex here and
5511 then recheck the COW status. */
5513 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5516 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5517 SvUVX(sv), SV_COW_NEXT_SV(sv));
5518 /* And drop it here. */
5520 } else if (SvLEN(sv)) {
5521 Safefree(SvPVX(sv));
5525 else if (SvPVX(sv) && SvLEN(sv))
5526 Safefree(SvPVX(sv));
5527 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5528 unsharepvn(SvPVX(sv),
5529 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5543 switch (SvTYPE(sv)) {
5559 del_XPVIV(SvANY(sv));
5562 del_XPVNV(SvANY(sv));
5565 del_XPVMG(SvANY(sv));
5568 del_XPVLV(SvANY(sv));
5571 del_XPVAV(SvANY(sv));
5574 del_XPVHV(SvANY(sv));
5577 del_XPVCV(SvANY(sv));
5580 del_XPVGV(SvANY(sv));
5581 /* code duplication for increased performance. */
5582 SvFLAGS(sv) &= SVf_BREAK;
5583 SvFLAGS(sv) |= SVTYPEMASK;
5584 /* decrease refcount of the stash that owns this GV, if any */
5586 SvREFCNT_dec(stash);
5587 return; /* not break, SvFLAGS reset already happened */
5589 del_XPVBM(SvANY(sv));
5592 del_XPVFM(SvANY(sv));
5595 del_XPVIO(SvANY(sv));
5598 SvFLAGS(sv) &= SVf_BREAK;
5599 SvFLAGS(sv) |= SVTYPEMASK;
5603 =for apidoc sv_newref
5605 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5612 Perl_sv_newref(pTHX_ SV *sv)
5622 Decrement an SV's reference count, and if it drops to zero, call
5623 C<sv_clear> to invoke destructors and free up any memory used by
5624 the body; finally, deallocate the SV's head itself.
5625 Normally called via a wrapper macro C<SvREFCNT_dec>.
5631 Perl_sv_free(pTHX_ SV *sv)
5635 if (SvREFCNT(sv) == 0) {
5636 if (SvFLAGS(sv) & SVf_BREAK)
5637 /* this SV's refcnt has been artificially decremented to
5638 * trigger cleanup */
5640 if (PL_in_clean_all) /* All is fair */
5642 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5643 /* make sure SvREFCNT(sv)==0 happens very seldom */
5644 SvREFCNT(sv) = (~(U32)0)/2;
5647 if (ckWARN_d(WARN_INTERNAL))
5648 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5649 "Attempt to free unreferenced scalar: SV 0x%"UVxf,
5653 if (--(SvREFCNT(sv)) > 0)
5655 Perl_sv_free2(aTHX_ sv);
5659 Perl_sv_free2(pTHX_ SV *sv)
5663 if (ckWARN_d(WARN_DEBUGGING))
5664 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5665 "Attempt to free temp prematurely: SV 0x%"UVxf,
5670 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5671 /* make sure SvREFCNT(sv)==0 happens very seldom */
5672 SvREFCNT(sv) = (~(U32)0)/2;
5683 Returns the length of the string in the SV. Handles magic and type
5684 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5690 Perl_sv_len(pTHX_ register SV *sv)
5698 len = mg_length(sv);
5700 (void)SvPV(sv, len);
5705 =for apidoc sv_len_utf8
5707 Returns the number of characters in the string in an SV, counting wide
5708 UTF-8 bytes as a single character. Handles magic and type coercion.
5714 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5715 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5716 * (Note that the mg_len is not the length of the mg_ptr field.)
5721 Perl_sv_len_utf8(pTHX_ register SV *sv)
5727 return mg_length(sv);
5731 U8 *s = (U8*)SvPV(sv, len);
5732 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5734 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5736 #ifdef PERL_UTF8_CACHE_ASSERT
5737 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5741 ulen = Perl_utf8_length(aTHX_ s, s + len);
5742 if (!mg && !SvREADONLY(sv)) {
5743 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5744 mg = mg_find(sv, PERL_MAGIC_utf8);
5754 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5755 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5756 * between UTF-8 and byte offsets. There are two (substr offset and substr
5757 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5758 * and byte offset) cache positions.
5760 * The mg_len field is used by sv_len_utf8(), see its comments.
5761 * Note that the mg_len is not the length of the mg_ptr field.
5765 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
5769 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5771 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
5775 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5777 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5778 (*mgp)->mg_ptr = (char *) *cachep;
5782 (*cachep)[i] = *offsetp;
5783 (*cachep)[i+1] = s - start;
5791 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5792 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5793 * between UTF-8 and byte offsets. See also the comments of
5794 * S_utf8_mg_pos_init().
5798 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
5802 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5804 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5805 if (*mgp && (*mgp)->mg_ptr) {
5806 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5807 ASSERT_UTF8_CACHE(*cachep);
5808 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5810 else { /* We will skip to the right spot. */
5815 /* The assumption is that going backward is half
5816 * the speed of going forward (that's where the
5817 * 2 * backw in the below comes from). (The real
5818 * figure of course depends on the UTF-8 data.) */
5820 if ((*cachep)[i] > (STRLEN)uoff) {
5822 backw = (*cachep)[i] - (STRLEN)uoff;
5824 if (forw < 2 * backw)
5827 p = start + (*cachep)[i+1];
5829 /* Try this only for the substr offset (i == 0),
5830 * not for the substr length (i == 2). */
5831 else if (i == 0) { /* (*cachep)[i] < uoff */
5832 STRLEN ulen = sv_len_utf8(sv);
5834 if ((STRLEN)uoff < ulen) {
5835 forw = (STRLEN)uoff - (*cachep)[i];
5836 backw = ulen - (STRLEN)uoff;
5838 if (forw < 2 * backw)
5839 p = start + (*cachep)[i+1];
5844 /* If the string is not long enough for uoff,
5845 * we could extend it, but not at this low a level. */
5849 if (forw < 2 * backw) {
5856 while (UTF8_IS_CONTINUATION(*p))
5861 /* Update the cache. */
5862 (*cachep)[i] = (STRLEN)uoff;
5863 (*cachep)[i+1] = p - start;
5865 /* Drop the stale "length" cache */
5874 if (found) { /* Setup the return values. */
5875 *offsetp = (*cachep)[i+1];
5876 *sp = start + *offsetp;
5879 *offsetp = send - start;
5881 else if (*sp < start) {
5887 #ifdef PERL_UTF8_CACHE_ASSERT
5892 while (n-- && s < send)
5896 assert(*offsetp == s - start);
5897 assert((*cachep)[0] == (STRLEN)uoff);
5898 assert((*cachep)[1] == *offsetp);
5900 ASSERT_UTF8_CACHE(*cachep);
5909 =for apidoc sv_pos_u2b
5911 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5912 the start of the string, to a count of the equivalent number of bytes; if
5913 lenp is non-zero, it does the same to lenp, but this time starting from
5914 the offset, rather than from the start of the string. Handles magic and
5921 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5922 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5923 * byte offsets. See also the comments of S_utf8_mg_pos().
5928 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5939 start = s = (U8*)SvPV(sv, len);
5941 I32 uoffset = *offsetp;
5946 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5948 if (!found && uoffset > 0) {
5949 while (s < send && uoffset--)
5953 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
5955 *offsetp = s - start;
5960 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
5964 if (!found && *lenp > 0) {
5967 while (s < send && ulen--)
5971 if (utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start))
5972 cache[2] += *offsetp;
5976 ASSERT_UTF8_CACHE(cache);
5988 =for apidoc sv_pos_b2u
5990 Converts the value pointed to by offsetp from a count of bytes from the
5991 start of the string, to a count of the equivalent number of UTF-8 chars.
5992 Handles magic and type coercion.
5998 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5999 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6000 * byte offsets. See also the comments of S_utf8_mg_pos().
6005 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6013 s = (U8*)SvPV(sv, len);
6014 if ((I32)len < *offsetp)
6015 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6017 U8* send = s + *offsetp;
6019 STRLEN *cache = NULL;
6023 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6024 mg = mg_find(sv, PERL_MAGIC_utf8);
6025 if (mg && mg->mg_ptr) {
6026 cache = (STRLEN *) mg->mg_ptr;
6027 if (cache[1] == (STRLEN)*offsetp) {
6028 /* An exact match. */
6029 *offsetp = cache[0];
6033 else if (cache[1] < (STRLEN)*offsetp) {
6034 /* We already know part of the way. */
6037 /* Let the below loop do the rest. */
6039 else { /* cache[1] > *offsetp */
6040 /* We already know all of the way, now we may
6041 * be able to walk back. The same assumption
6042 * is made as in S_utf8_mg_pos(), namely that
6043 * walking backward is twice slower than
6044 * walking forward. */
6045 STRLEN forw = *offsetp;
6046 STRLEN backw = cache[1] - *offsetp;
6048 if (!(forw < 2 * backw)) {
6049 U8 *p = s + cache[1];
6056 while (UTF8_IS_CONTINUATION(*p)) {
6064 *offsetp = cache[0];
6069 ASSERT_UTF8_CACHE(cache);
6075 /* Call utf8n_to_uvchr() to validate the sequence
6076 * (unless a simple non-UTF character) */
6077 if (!UTF8_IS_INVARIANT(*s))
6078 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6087 if (!SvREADONLY(sv)) {
6089 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6090 mg = mg_find(sv, PERL_MAGIC_utf8);
6095 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6096 mg->mg_ptr = (char *) cache;
6101 cache[1] = *offsetp;
6112 Returns a boolean indicating whether the strings in the two SVs are
6113 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6114 coerce its args to strings if necessary.
6120 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6128 SV* svrecode = Nullsv;
6135 pv1 = SvPV(sv1, cur1);
6142 pv2 = SvPV(sv2, cur2);
6144 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6145 /* Differing utf8ness.
6146 * Do not UTF8size the comparands as a side-effect. */
6149 svrecode = newSVpvn(pv2, cur2);
6150 sv_recode_to_utf8(svrecode, PL_encoding);
6151 pv2 = SvPV(svrecode, cur2);
6154 svrecode = newSVpvn(pv1, cur1);
6155 sv_recode_to_utf8(svrecode, PL_encoding);
6156 pv1 = SvPV(svrecode, cur1);
6158 /* Now both are in UTF-8. */
6163 bool is_utf8 = TRUE;
6166 /* sv1 is the UTF-8 one,
6167 * if is equal it must be downgrade-able */
6168 char *pv = (char*)bytes_from_utf8((U8*)pv1,
6174 /* sv2 is the UTF-8 one,
6175 * if is equal it must be downgrade-able */
6176 char *pv = (char *)bytes_from_utf8((U8*)pv2,
6182 /* Downgrade not possible - cannot be eq */
6189 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6192 SvREFCNT_dec(svrecode);
6203 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6204 string in C<sv1> is less than, equal to, or greater than the string in
6205 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6206 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6212 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6215 char *pv1, *pv2, *tpv = Nullch;
6217 SV *svrecode = Nullsv;
6224 pv1 = SvPV(sv1, cur1);
6231 pv2 = SvPV(sv2, cur2);
6233 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6234 /* Differing utf8ness.
6235 * Do not UTF8size the comparands as a side-effect. */
6238 svrecode = newSVpvn(pv2, cur2);
6239 sv_recode_to_utf8(svrecode, PL_encoding);
6240 pv2 = SvPV(svrecode, cur2);
6243 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
6248 svrecode = newSVpvn(pv1, cur1);
6249 sv_recode_to_utf8(svrecode, PL_encoding);
6250 pv1 = SvPV(svrecode, cur1);
6253 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
6259 cmp = cur2 ? -1 : 0;
6263 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6266 cmp = retval < 0 ? -1 : 1;
6267 } else if (cur1 == cur2) {
6270 cmp = cur1 < cur2 ? -1 : 1;
6275 SvREFCNT_dec(svrecode);
6284 =for apidoc sv_cmp_locale
6286 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6287 'use bytes' aware, handles get magic, and will coerce its args to strings
6288 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6294 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6296 #ifdef USE_LOCALE_COLLATE
6302 if (PL_collation_standard)
6306 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6308 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6310 if (!pv1 || !len1) {
6321 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6324 return retval < 0 ? -1 : 1;
6327 * When the result of collation is equality, that doesn't mean
6328 * that there are no differences -- some locales exclude some
6329 * characters from consideration. So to avoid false equalities,
6330 * we use the raw string as a tiebreaker.
6336 #endif /* USE_LOCALE_COLLATE */
6338 return sv_cmp(sv1, sv2);
6342 #ifdef USE_LOCALE_COLLATE
6345 =for apidoc sv_collxfrm
6347 Add Collate Transform magic to an SV if it doesn't already have it.
6349 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6350 scalar data of the variable, but transformed to such a format that a normal
6351 memory comparison can be used to compare the data according to the locale
6358 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6362 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6363 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6368 Safefree(mg->mg_ptr);
6370 if ((xf = mem_collxfrm(s, len, &xlen))) {
6371 if (SvREADONLY(sv)) {
6374 return xf + sizeof(PL_collation_ix);
6377 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6378 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6391 if (mg && mg->mg_ptr) {
6393 return mg->mg_ptr + sizeof(PL_collation_ix);
6401 #endif /* USE_LOCALE_COLLATE */
6406 Get a line from the filehandle and store it into the SV, optionally
6407 appending to the currently-stored string.
6413 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6417 register STDCHAR rslast;
6418 register STDCHAR *bp;
6424 if (SvTHINKFIRST(sv))
6425 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6426 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6428 However, perlbench says it's slower, because the existing swipe code
6429 is faster than copy on write.
6430 Swings and roundabouts. */
6431 (void)SvUPGRADE(sv, SVt_PV);
6436 if (PerlIO_isutf8(fp)) {
6438 sv_utf8_upgrade_nomg(sv);
6439 sv_pos_u2b(sv,&append,0);
6441 } else if (SvUTF8(sv)) {
6442 SV *tsv = NEWSV(0,0);
6443 sv_gets(tsv, fp, 0);
6444 sv_utf8_upgrade_nomg(tsv);
6445 SvCUR_set(sv,append);
6448 goto return_string_or_null;
6453 if (PerlIO_isutf8(fp))
6456 if (IN_PERL_COMPILETIME) {
6457 /* we always read code in line mode */
6461 else if (RsSNARF(PL_rs)) {
6462 /* If it is a regular disk file use size from stat() as estimate
6463 of amount we are going to read - may result in malloc-ing
6464 more memory than we realy need if layers bellow reduce
6465 size we read (e.g. CRLF or a gzip layer)
6468 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6469 Off_t offset = PerlIO_tell(fp);
6470 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6471 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6477 else if (RsRECORD(PL_rs)) {
6481 /* Grab the size of the record we're getting */
6482 recsize = SvIV(SvRV(PL_rs));
6483 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6486 /* VMS wants read instead of fread, because fread doesn't respect */
6487 /* RMS record boundaries. This is not necessarily a good thing to be */
6488 /* doing, but we've got no other real choice - except avoid stdio
6489 as implementation - perhaps write a :vms layer ?
6491 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6493 bytesread = PerlIO_read(fp, buffer, recsize);
6497 SvCUR_set(sv, bytesread += append);
6498 buffer[bytesread] = '\0';
6499 goto return_string_or_null;
6501 else if (RsPARA(PL_rs)) {
6507 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6508 if (PerlIO_isutf8(fp)) {
6509 rsptr = SvPVutf8(PL_rs, rslen);
6512 if (SvUTF8(PL_rs)) {
6513 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6514 Perl_croak(aTHX_ "Wide character in $/");
6517 rsptr = SvPV(PL_rs, rslen);
6521 rslast = rslen ? rsptr[rslen - 1] : '\0';
6523 if (rspara) { /* have to do this both before and after */
6524 do { /* to make sure file boundaries work right */
6527 i = PerlIO_getc(fp);
6531 PerlIO_ungetc(fp,i);
6537 /* See if we know enough about I/O mechanism to cheat it ! */
6539 /* This used to be #ifdef test - it is made run-time test for ease
6540 of abstracting out stdio interface. One call should be cheap
6541 enough here - and may even be a macro allowing compile
6545 if (PerlIO_fast_gets(fp)) {
6548 * We're going to steal some values from the stdio struct
6549 * and put EVERYTHING in the innermost loop into registers.
6551 register STDCHAR *ptr;
6555 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6556 /* An ungetc()d char is handled separately from the regular
6557 * buffer, so we getc() it back out and stuff it in the buffer.
6559 i = PerlIO_getc(fp);
6560 if (i == EOF) return 0;
6561 *(--((*fp)->_ptr)) = (unsigned char) i;
6565 /* Here is some breathtakingly efficient cheating */
6567 cnt = PerlIO_get_cnt(fp); /* get count into register */
6568 /* make sure we have the room */
6569 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6570 /* Not room for all of it
6571 if we are looking for a separator and room for some
6573 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6574 /* just process what we have room for */
6575 shortbuffered = cnt - SvLEN(sv) + append + 1;
6576 cnt -= shortbuffered;
6580 /* remember that cnt can be negative */
6581 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6586 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
6587 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6588 DEBUG_P(PerlIO_printf(Perl_debug_log,
6589 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6590 DEBUG_P(PerlIO_printf(Perl_debug_log,
6591 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6592 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6593 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6598 while (cnt > 0) { /* this | eat */
6600 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6601 goto thats_all_folks; /* screams | sed :-) */
6605 Copy(ptr, bp, cnt, char); /* this | eat */
6606 bp += cnt; /* screams | dust */
6607 ptr += cnt; /* louder | sed :-) */
6612 if (shortbuffered) { /* oh well, must extend */
6613 cnt = shortbuffered;
6615 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6617 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6618 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6622 DEBUG_P(PerlIO_printf(Perl_debug_log,
6623 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6624 PTR2UV(ptr),(long)cnt));
6625 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6627 DEBUG_P(PerlIO_printf(Perl_debug_log,
6628 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6629 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6630 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6632 /* This used to call 'filbuf' in stdio form, but as that behaves like
6633 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6634 another abstraction. */
6635 i = PerlIO_getc(fp); /* get more characters */
6637 DEBUG_P(PerlIO_printf(Perl_debug_log,
6638 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6639 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6640 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6642 cnt = PerlIO_get_cnt(fp);
6643 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6644 DEBUG_P(PerlIO_printf(Perl_debug_log,
6645 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6647 if (i == EOF) /* all done for ever? */
6648 goto thats_really_all_folks;
6650 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6652 SvGROW(sv, bpx + cnt + 2);
6653 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6655 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6657 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6658 goto thats_all_folks;
6662 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
6663 memNE((char*)bp - rslen, rsptr, rslen))
6664 goto screamer; /* go back to the fray */
6665 thats_really_all_folks:
6667 cnt += shortbuffered;
6668 DEBUG_P(PerlIO_printf(Perl_debug_log,
6669 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6670 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6671 DEBUG_P(PerlIO_printf(Perl_debug_log,
6672 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6673 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6674 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6676 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
6677 DEBUG_P(PerlIO_printf(Perl_debug_log,
6678 "Screamer: done, len=%ld, string=|%.*s|\n",
6679 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
6683 /*The big, slow, and stupid way. */
6685 /* Any stack-challenged places. */
6687 /* EPOC: need to work around SDK features. *
6688 * On WINS: MS VC5 generates calls to _chkstk, *
6689 * if a "large" stack frame is allocated. *
6690 * gcc on MARM does not generate calls like these. */
6691 # define USEHEAPINSTEADOFSTACK
6694 #ifdef USEHEAPINSTEADOFSTACK
6696 New(0, buf, 8192, STDCHAR);
6704 register STDCHAR *bpe = buf + sizeof(buf);
6706 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6707 ; /* keep reading */
6711 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6712 /* Accomodate broken VAXC compiler, which applies U8 cast to
6713 * both args of ?: operator, causing EOF to change into 255
6716 i = (U8)buf[cnt - 1];
6722 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6724 sv_catpvn(sv, (char *) buf, cnt);
6726 sv_setpvn(sv, (char *) buf, cnt);
6728 if (i != EOF && /* joy */
6730 SvCUR(sv) < rslen ||
6731 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6735 * If we're reading from a TTY and we get a short read,
6736 * indicating that the user hit his EOF character, we need
6737 * to notice it now, because if we try to read from the TTY
6738 * again, the EOF condition will disappear.
6740 * The comparison of cnt to sizeof(buf) is an optimization
6741 * that prevents unnecessary calls to feof().
6745 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6749 #ifdef USEHEAPINSTEADOFSTACK
6754 if (rspara) { /* have to do this both before and after */
6755 while (i != EOF) { /* to make sure file boundaries work right */
6756 i = PerlIO_getc(fp);
6758 PerlIO_ungetc(fp,i);
6764 return_string_or_null:
6765 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6771 Auto-increment of the value in the SV, doing string to numeric conversion
6772 if necessary. Handles 'get' magic.
6778 Perl_sv_inc(pTHX_ register SV *sv)
6787 if (SvTHINKFIRST(sv)) {
6789 sv_force_normal_flags(sv, 0);
6790 if (SvREADONLY(sv)) {
6791 if (IN_PERL_RUNTIME)
6792 Perl_croak(aTHX_ PL_no_modify);
6796 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6798 i = PTR2IV(SvRV(sv));
6803 flags = SvFLAGS(sv);
6804 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6805 /* It's (privately or publicly) a float, but not tested as an
6806 integer, so test it to see. */
6808 flags = SvFLAGS(sv);
6810 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6811 /* It's publicly an integer, or privately an integer-not-float */
6812 #ifdef PERL_PRESERVE_IVUV
6816 if (SvUVX(sv) == UV_MAX)
6817 sv_setnv(sv, UV_MAX_P1);
6819 (void)SvIOK_only_UV(sv);
6822 if (SvIVX(sv) == IV_MAX)
6823 sv_setuv(sv, (UV)IV_MAX + 1);
6825 (void)SvIOK_only(sv);
6831 if (flags & SVp_NOK) {
6832 (void)SvNOK_only(sv);
6837 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
6838 if ((flags & SVTYPEMASK) < SVt_PVIV)
6839 sv_upgrade(sv, SVt_IV);
6840 (void)SvIOK_only(sv);
6845 while (isALPHA(*d)) d++;
6846 while (isDIGIT(*d)) d++;
6848 #ifdef PERL_PRESERVE_IVUV
6849 /* Got to punt this as an integer if needs be, but we don't issue
6850 warnings. Probably ought to make the sv_iv_please() that does
6851 the conversion if possible, and silently. */
6852 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6853 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6854 /* Need to try really hard to see if it's an integer.
6855 9.22337203685478e+18 is an integer.
6856 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6857 so $a="9.22337203685478e+18"; $a+0; $a++
6858 needs to be the same as $a="9.22337203685478e+18"; $a++
6865 /* sv_2iv *should* have made this an NV */
6866 if (flags & SVp_NOK) {
6867 (void)SvNOK_only(sv);
6871 /* I don't think we can get here. Maybe I should assert this
6872 And if we do get here I suspect that sv_setnv will croak. NWC
6874 #if defined(USE_LONG_DOUBLE)
6875 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",
6876 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6878 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6879 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6882 #endif /* PERL_PRESERVE_IVUV */
6883 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
6887 while (d >= SvPVX(sv)) {
6895 /* MKS: The original code here died if letters weren't consecutive.
6896 * at least it didn't have to worry about non-C locales. The
6897 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6898 * arranged in order (although not consecutively) and that only
6899 * [A-Za-z] are accepted by isALPHA in the C locale.
6901 if (*d != 'z' && *d != 'Z') {
6902 do { ++*d; } while (!isALPHA(*d));
6905 *(d--) -= 'z' - 'a';
6910 *(d--) -= 'z' - 'a' + 1;
6914 /* oh,oh, the number grew */
6915 SvGROW(sv, SvCUR(sv) + 2);
6917 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6928 Auto-decrement of the value in the SV, doing string to numeric conversion
6929 if necessary. Handles 'get' magic.
6935 Perl_sv_dec(pTHX_ register SV *sv)
6943 if (SvTHINKFIRST(sv)) {
6945 sv_force_normal_flags(sv, 0);
6946 if (SvREADONLY(sv)) {
6947 if (IN_PERL_RUNTIME)
6948 Perl_croak(aTHX_ PL_no_modify);
6952 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6954 i = PTR2IV(SvRV(sv));
6959 /* Unlike sv_inc we don't have to worry about string-never-numbers
6960 and keeping them magic. But we mustn't warn on punting */
6961 flags = SvFLAGS(sv);
6962 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6963 /* It's publicly an integer, or privately an integer-not-float */
6964 #ifdef PERL_PRESERVE_IVUV
6968 if (SvUVX(sv) == 0) {
6969 (void)SvIOK_only(sv);
6973 (void)SvIOK_only_UV(sv);
6977 if (SvIVX(sv) == IV_MIN)
6978 sv_setnv(sv, (NV)IV_MIN - 1.0);
6980 (void)SvIOK_only(sv);
6986 if (flags & SVp_NOK) {
6988 (void)SvNOK_only(sv);
6991 if (!(flags & SVp_POK)) {
6992 if ((flags & SVTYPEMASK) < SVt_PVNV)
6993 sv_upgrade(sv, SVt_NV);
6995 (void)SvNOK_only(sv);
6998 #ifdef PERL_PRESERVE_IVUV
7000 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7001 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7002 /* Need to try really hard to see if it's an integer.
7003 9.22337203685478e+18 is an integer.
7004 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7005 so $a="9.22337203685478e+18"; $a+0; $a--
7006 needs to be the same as $a="9.22337203685478e+18"; $a--
7013 /* sv_2iv *should* have made this an NV */
7014 if (flags & SVp_NOK) {
7015 (void)SvNOK_only(sv);
7019 /* I don't think we can get here. Maybe I should assert this
7020 And if we do get here I suspect that sv_setnv will croak. NWC
7022 #if defined(USE_LONG_DOUBLE)
7023 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",
7024 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7026 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7027 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7031 #endif /* PERL_PRESERVE_IVUV */
7032 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
7036 =for apidoc sv_mortalcopy
7038 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7039 The new SV is marked as mortal. It will be destroyed "soon", either by an
7040 explicit call to FREETMPS, or by an implicit call at places such as
7041 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7046 /* Make a string that will exist for the duration of the expression
7047 * evaluation. Actually, it may have to last longer than that, but
7048 * hopefully we won't free it until it has been assigned to a
7049 * permanent location. */
7052 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7057 sv_setsv(sv,oldstr);
7059 PL_tmps_stack[++PL_tmps_ix] = sv;
7065 =for apidoc sv_newmortal
7067 Creates a new null SV which is mortal. The reference count of the SV is
7068 set to 1. It will be destroyed "soon", either by an explicit call to
7069 FREETMPS, or by an implicit call at places such as statement boundaries.
7070 See also C<sv_mortalcopy> and C<sv_2mortal>.
7076 Perl_sv_newmortal(pTHX)
7081 SvFLAGS(sv) = SVs_TEMP;
7083 PL_tmps_stack[++PL_tmps_ix] = sv;
7088 =for apidoc sv_2mortal
7090 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7091 by an explicit call to FREETMPS, or by an implicit call at places such as
7092 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
7098 Perl_sv_2mortal(pTHX_ register SV *sv)
7102 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7105 PL_tmps_stack[++PL_tmps_ix] = sv;
7113 Creates a new SV and copies a string into it. The reference count for the
7114 SV is set to 1. If C<len> is zero, Perl will compute the length using
7115 strlen(). For efficiency, consider using C<newSVpvn> instead.
7121 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7128 sv_setpvn(sv,s,len);
7133 =for apidoc newSVpvn
7135 Creates a new SV and copies a string into it. The reference count for the
7136 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7137 string. You are responsible for ensuring that the source string is at least
7144 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7149 sv_setpvn(sv,s,len);
7154 =for apidoc newSVpvn_share
7156 Creates a new SV with its SvPVX pointing to a shared string in the string
7157 table. If the string does not already exist in the table, it is created
7158 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7159 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7160 otherwise the hash is computed. The idea here is that as the string table
7161 is used for shared hash keys these strings will have SvPVX == HeKEY and
7162 hash lookup will avoid string compare.
7168 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7171 bool is_utf8 = FALSE;
7173 STRLEN tmplen = -len;
7175 /* See the note in hv.c:hv_fetch() --jhi */
7176 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
7180 PERL_HASH(hash, src, len);
7182 sv_upgrade(sv, SVt_PVIV);
7183 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
7196 #if defined(PERL_IMPLICIT_CONTEXT)
7198 /* pTHX_ magic can't cope with varargs, so this is a no-context
7199 * version of the main function, (which may itself be aliased to us).
7200 * Don't access this version directly.
7204 Perl_newSVpvf_nocontext(const char* pat, ...)
7209 va_start(args, pat);
7210 sv = vnewSVpvf(pat, &args);
7217 =for apidoc newSVpvf
7219 Creates a new SV and initializes it with the string formatted like
7226 Perl_newSVpvf(pTHX_ const char* pat, ...)
7230 va_start(args, pat);
7231 sv = vnewSVpvf(pat, &args);
7236 /* backend for newSVpvf() and newSVpvf_nocontext() */
7239 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7243 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7250 Creates a new SV and copies a floating point value into it.
7251 The reference count for the SV is set to 1.
7257 Perl_newSVnv(pTHX_ NV n)
7269 Creates a new SV and copies an integer into it. The reference count for the
7276 Perl_newSViv(pTHX_ IV i)
7288 Creates a new SV and copies an unsigned integer into it.
7289 The reference count for the SV is set to 1.
7295 Perl_newSVuv(pTHX_ UV u)
7305 =for apidoc newRV_noinc
7307 Creates an RV wrapper for an SV. The reference count for the original
7308 SV is B<not> incremented.
7314 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7319 sv_upgrade(sv, SVt_RV);
7326 /* newRV_inc is the official function name to use now.
7327 * newRV_inc is in fact #defined to newRV in sv.h
7331 Perl_newRV(pTHX_ SV *tmpRef)
7333 return newRV_noinc(SvREFCNT_inc(tmpRef));
7339 Creates a new SV which is an exact duplicate of the original SV.
7346 Perl_newSVsv(pTHX_ register SV *old)
7352 if (SvTYPE(old) == SVTYPEMASK) {
7353 if (ckWARN_d(WARN_INTERNAL))
7354 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7369 =for apidoc sv_reset
7371 Underlying implementation for the C<reset> Perl function.
7372 Note that the perl-level function is vaguely deprecated.
7378 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7386 char todo[PERL_UCHAR_MAX+1];
7391 if (!*s) { /* reset ?? searches */
7392 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7393 pm->op_pmdynflags &= ~PMdf_USED;
7398 /* reset variables */
7400 if (!HvARRAY(stash))
7403 Zero(todo, 256, char);
7405 i = (unsigned char)*s;
7409 max = (unsigned char)*s++;
7410 for ( ; i <= max; i++) {
7413 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7414 for (entry = HvARRAY(stash)[i];
7416 entry = HeNEXT(entry))
7418 if (!todo[(U8)*HeKEY(entry)])
7420 gv = (GV*)HeVAL(entry);
7422 if (SvTHINKFIRST(sv)) {
7423 if (!SvREADONLY(sv) && SvROK(sv))
7428 if (SvTYPE(sv) >= SVt_PV) {
7430 if (SvPVX(sv) != Nullch)
7437 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7440 #ifdef USE_ENVIRON_ARRAY
7442 # ifdef USE_ITHREADS
7443 && PL_curinterp == aTHX
7447 environ[0] = Nullch;
7450 #endif /* !PERL_MICRO */
7460 Using various gambits, try to get an IO from an SV: the IO slot if its a
7461 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7462 named after the PV if we're a string.
7468 Perl_sv_2io(pTHX_ SV *sv)
7474 switch (SvTYPE(sv)) {
7482 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7486 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7488 return sv_2io(SvRV(sv));
7489 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7495 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7504 Using various gambits, try to get a CV from an SV; in addition, try if
7505 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7511 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7518 return *gvp = Nullgv, Nullcv;
7519 switch (SvTYPE(sv)) {
7538 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7539 tryAMAGICunDEREF(to_cv);
7542 if (SvTYPE(sv) == SVt_PVCV) {
7551 Perl_croak(aTHX_ "Not a subroutine reference");
7556 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
7562 if (lref && !GvCVu(gv)) {
7565 tmpsv = NEWSV(704,0);
7566 gv_efullname3(tmpsv, gv, Nullch);
7567 /* XXX this is probably not what they think they're getting.
7568 * It has the same effect as "sub name;", i.e. just a forward
7570 newSUB(start_subparse(FALSE, 0),
7571 newSVOP(OP_CONST, 0, tmpsv),
7576 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7586 Returns true if the SV has a true value by Perl's rules.
7587 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7588 instead use an in-line version.
7594 Perl_sv_true(pTHX_ register SV *sv)
7600 if ((tXpv = (XPV*)SvANY(sv)) &&
7601 (tXpv->xpv_cur > 1 ||
7602 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
7609 return SvIVX(sv) != 0;
7612 return SvNVX(sv) != 0.0;
7614 return sv_2bool(sv);
7622 A private implementation of the C<SvIVx> macro for compilers which can't
7623 cope with complex macro expressions. Always use the macro instead.
7629 Perl_sv_iv(pTHX_ register SV *sv)
7633 return (IV)SvUVX(sv);
7642 A private implementation of the C<SvUVx> macro for compilers which can't
7643 cope with complex macro expressions. Always use the macro instead.
7649 Perl_sv_uv(pTHX_ register SV *sv)
7654 return (UV)SvIVX(sv);
7662 A private implementation of the C<SvNVx> macro for compilers which can't
7663 cope with complex macro expressions. Always use the macro instead.
7669 Perl_sv_nv(pTHX_ register SV *sv)
7676 /* sv_pv() is now a macro using SvPV_nolen();
7677 * this function provided for binary compatibility only
7681 Perl_sv_pv(pTHX_ SV *sv)
7688 return sv_2pv(sv, &n_a);
7694 Use the C<SvPV_nolen> macro instead
7698 A private implementation of the C<SvPV> macro for compilers which can't
7699 cope with complex macro expressions. Always use the macro instead.
7705 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7711 return sv_2pv(sv, lp);
7716 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7722 return sv_2pv_flags(sv, lp, 0);
7725 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7726 * this function provided for binary compatibility only
7730 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7732 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7736 =for apidoc sv_pvn_force
7738 Get a sensible string out of the SV somehow.
7739 A private implementation of the C<SvPV_force> macro for compilers which
7740 can't cope with complex macro expressions. Always use the macro instead.
7742 =for apidoc sv_pvn_force_flags
7744 Get a sensible string out of the SV somehow.
7745 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7746 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7747 implemented in terms of this function.
7748 You normally want to use the various wrapper macros instead: see
7749 C<SvPV_force> and C<SvPV_force_nomg>
7755 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7759 if (SvTHINKFIRST(sv) && !SvROK(sv))
7760 sv_force_normal_flags(sv, 0);
7766 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7767 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7771 s = sv_2pv_flags(sv, lp, flags);
7772 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
7777 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7778 SvGROW(sv, len + 1);
7779 Move(s,SvPVX(sv),len,char);
7784 SvPOK_on(sv); /* validate pointer */
7786 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7787 PTR2UV(sv),SvPVX(sv)));
7793 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7794 * this function provided for binary compatibility only
7798 Perl_sv_pvbyte(pTHX_ SV *sv)
7800 sv_utf8_downgrade(sv,0);
7805 =for apidoc sv_pvbyte
7807 Use C<SvPVbyte_nolen> instead.
7809 =for apidoc sv_pvbyten
7811 A private implementation of the C<SvPVbyte> macro for compilers
7812 which can't cope with complex macro expressions. Always use the macro
7819 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7821 sv_utf8_downgrade(sv,0);
7822 return sv_pvn(sv,lp);
7826 =for apidoc sv_pvbyten_force
7828 A private implementation of the C<SvPVbytex_force> macro for compilers
7829 which can't cope with complex macro expressions. Always use the macro
7836 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7838 sv_utf8_downgrade(sv,0);
7839 return sv_pvn_force(sv,lp);
7842 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
7843 * this function provided for binary compatibility only
7847 Perl_sv_pvutf8(pTHX_ SV *sv)
7849 sv_utf8_upgrade(sv);
7854 =for apidoc sv_pvutf8
7856 Use the C<SvPVutf8_nolen> macro instead
7858 =for apidoc sv_pvutf8n
7860 A private implementation of the C<SvPVutf8> macro for compilers
7861 which can't cope with complex macro expressions. Always use the macro
7868 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7870 sv_utf8_upgrade(sv);
7871 return sv_pvn(sv,lp);
7875 =for apidoc sv_pvutf8n_force
7877 A private implementation of the C<SvPVutf8_force> macro for compilers
7878 which can't cope with complex macro expressions. Always use the macro
7885 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7887 sv_utf8_upgrade(sv);
7888 return sv_pvn_force(sv,lp);
7892 =for apidoc sv_reftype
7894 Returns a string describing what the SV is a reference to.
7900 Perl_sv_reftype(pTHX_ SV *sv, int ob)
7902 if (ob && SvOBJECT(sv)) {
7903 if (HvNAME(SvSTASH(sv)))
7904 return HvNAME(SvSTASH(sv));
7909 switch (SvTYPE(sv)) {
7926 case SVt_PVLV: return SvROK(sv) ? "REF"
7927 /* tied lvalues should appear to be
7928 * scalars for backwards compatitbility */
7929 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7930 ? "SCALAR" : "LVALUE";
7931 case SVt_PVAV: return "ARRAY";
7932 case SVt_PVHV: return "HASH";
7933 case SVt_PVCV: return "CODE";
7934 case SVt_PVGV: return "GLOB";
7935 case SVt_PVFM: return "FORMAT";
7936 case SVt_PVIO: return "IO";
7937 default: return "UNKNOWN";
7943 =for apidoc sv_isobject
7945 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7946 object. If the SV is not an RV, or if the object is not blessed, then this
7953 Perl_sv_isobject(pTHX_ SV *sv)
7970 Returns a boolean indicating whether the SV is blessed into the specified
7971 class. This does not check for subtypes; use C<sv_derived_from> to verify
7972 an inheritance relationship.
7978 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7989 if (!HvNAME(SvSTASH(sv)))
7992 return strEQ(HvNAME(SvSTASH(sv)), name);
7998 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7999 it will be upgraded to one. If C<classname> is non-null then the new SV will
8000 be blessed in the specified package. The new SV is returned and its
8001 reference count is 1.
8007 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8013 SV_CHECK_THINKFIRST_COW_DROP(rv);
8016 if (SvTYPE(rv) >= SVt_PVMG) {
8017 U32 refcnt = SvREFCNT(rv);
8021 SvREFCNT(rv) = refcnt;
8024 if (SvTYPE(rv) < SVt_RV)
8025 sv_upgrade(rv, SVt_RV);
8026 else if (SvTYPE(rv) > SVt_RV) {
8027 (void)SvOOK_off(rv);
8028 if (SvPVX(rv) && SvLEN(rv))
8029 Safefree(SvPVX(rv));
8039 HV* stash = gv_stashpv(classname, TRUE);
8040 (void)sv_bless(rv, stash);
8046 =for apidoc sv_setref_pv
8048 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8049 argument will be upgraded to an RV. That RV will be modified to point to
8050 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8051 into the SV. The C<classname> argument indicates the package for the
8052 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8053 will have a reference count of 1, and the RV will be returned.
8055 Do not use with other Perl types such as HV, AV, SV, CV, because those
8056 objects will become corrupted by the pointer copy process.
8058 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8064 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8067 sv_setsv(rv, &PL_sv_undef);
8071 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8076 =for apidoc sv_setref_iv
8078 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8079 argument will be upgraded to an RV. That RV will be modified to point to
8080 the new SV. The C<classname> argument indicates the package for the
8081 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8082 will have a reference count of 1, and the RV will be returned.
8088 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8090 sv_setiv(newSVrv(rv,classname), iv);
8095 =for apidoc sv_setref_uv
8097 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8098 argument will be upgraded to an RV. That RV will be modified to point to
8099 the new SV. The C<classname> argument indicates the package for the
8100 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8101 will have a reference count of 1, and the RV will be returned.
8107 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8109 sv_setuv(newSVrv(rv,classname), uv);
8114 =for apidoc sv_setref_nv
8116 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8117 argument will be upgraded to an RV. That RV will be modified to point to
8118 the new SV. The C<classname> argument indicates the package for the
8119 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8120 will have a reference count of 1, and the RV will be returned.
8126 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8128 sv_setnv(newSVrv(rv,classname), nv);
8133 =for apidoc sv_setref_pvn
8135 Copies a string into a new SV, optionally blessing the SV. The length of the
8136 string must be specified with C<n>. The C<rv> argument will be upgraded to
8137 an RV. That RV will be modified to point to the new SV. The C<classname>
8138 argument indicates the package for the blessing. Set C<classname> to
8139 C<Nullch> to avoid the blessing. The new SV will have a reference count
8140 of 1, and the RV will be returned.
8142 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8148 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8150 sv_setpvn(newSVrv(rv,classname), pv, n);
8155 =for apidoc sv_bless
8157 Blesses an SV into a specified package. The SV must be an RV. The package
8158 must be designated by its stash (see C<gv_stashpv()>). The reference count
8159 of the SV is unaffected.
8165 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8169 Perl_croak(aTHX_ "Can't bless non-reference value");
8171 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8172 if (SvREADONLY(tmpRef))
8173 Perl_croak(aTHX_ PL_no_modify);
8174 if (SvOBJECT(tmpRef)) {
8175 if (SvTYPE(tmpRef) != SVt_PVIO)
8177 SvREFCNT_dec(SvSTASH(tmpRef));
8180 SvOBJECT_on(tmpRef);
8181 if (SvTYPE(tmpRef) != SVt_PVIO)
8183 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8184 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
8191 if(SvSMAGICAL(tmpRef))
8192 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8200 /* Downgrades a PVGV to a PVMG.
8204 S_sv_unglob(pTHX_ SV *sv)
8208 assert(SvTYPE(sv) == SVt_PVGV);
8213 SvREFCNT_dec(GvSTASH(sv));
8214 GvSTASH(sv) = Nullhv;
8216 sv_unmagic(sv, PERL_MAGIC_glob);
8217 Safefree(GvNAME(sv));
8220 /* need to keep SvANY(sv) in the right arena */
8221 xpvmg = new_XPVMG();
8222 StructCopy(SvANY(sv), xpvmg, XPVMG);
8223 del_XPVGV(SvANY(sv));
8226 SvFLAGS(sv) &= ~SVTYPEMASK;
8227 SvFLAGS(sv) |= SVt_PVMG;
8231 =for apidoc sv_unref_flags
8233 Unsets the RV status of the SV, and decrements the reference count of
8234 whatever was being referenced by the RV. This can almost be thought of
8235 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8236 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8237 (otherwise the decrementing is conditional on the reference count being
8238 different from one or the reference being a readonly SV).
8245 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8249 if (SvWEAKREF(sv)) {
8257 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8258 assigned to as BEGIN {$a = \"Foo"} will fail. */
8259 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8261 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8262 sv_2mortal(rv); /* Schedule for freeing later */
8266 =for apidoc sv_unref
8268 Unsets the RV status of the SV, and decrements the reference count of
8269 whatever was being referenced by the RV. This can almost be thought of
8270 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8271 being zero. See C<SvROK_off>.
8277 Perl_sv_unref(pTHX_ SV *sv)
8279 sv_unref_flags(sv, 0);
8283 =for apidoc sv_taint
8285 Taint an SV. Use C<SvTAINTED_on> instead.
8290 Perl_sv_taint(pTHX_ SV *sv)
8292 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8296 =for apidoc sv_untaint
8298 Untaint an SV. Use C<SvTAINTED_off> instead.
8303 Perl_sv_untaint(pTHX_ SV *sv)
8305 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8306 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8313 =for apidoc sv_tainted
8315 Test an SV for taintedness. Use C<SvTAINTED> instead.
8320 Perl_sv_tainted(pTHX_ SV *sv)
8322 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8323 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8324 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8331 =for apidoc sv_setpviv
8333 Copies an integer into the given SV, also updating its string value.
8334 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8340 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8342 char buf[TYPE_CHARS(UV)];
8344 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8346 sv_setpvn(sv, ptr, ebuf - ptr);
8350 =for apidoc sv_setpviv_mg
8352 Like C<sv_setpviv>, but also handles 'set' magic.
8358 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8360 char buf[TYPE_CHARS(UV)];
8362 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8364 sv_setpvn(sv, ptr, ebuf - ptr);
8368 #if defined(PERL_IMPLICIT_CONTEXT)
8370 /* pTHX_ magic can't cope with varargs, so this is a no-context
8371 * version of the main function, (which may itself be aliased to us).
8372 * Don't access this version directly.
8376 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8380 va_start(args, pat);
8381 sv_vsetpvf(sv, pat, &args);
8385 /* pTHX_ magic can't cope with varargs, so this is a no-context
8386 * version of the main function, (which may itself be aliased to us).
8387 * Don't access this version directly.
8391 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8395 va_start(args, pat);
8396 sv_vsetpvf_mg(sv, pat, &args);
8402 =for apidoc sv_setpvf
8404 Processes its arguments like C<sprintf> and sets an SV to the formatted
8405 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8411 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8414 va_start(args, pat);
8415 sv_vsetpvf(sv, pat, &args);
8419 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8422 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8424 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8428 =for apidoc sv_setpvf_mg
8430 Like C<sv_setpvf>, but also handles 'set' magic.
8436 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8439 va_start(args, pat);
8440 sv_vsetpvf_mg(sv, pat, &args);
8444 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8447 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8449 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8453 #if defined(PERL_IMPLICIT_CONTEXT)
8455 /* pTHX_ magic can't cope with varargs, so this is a no-context
8456 * version of the main function, (which may itself be aliased to us).
8457 * Don't access this version directly.
8461 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8465 va_start(args, pat);
8466 sv_vcatpvf(sv, pat, &args);
8470 /* pTHX_ magic can't cope with varargs, so this is a no-context
8471 * version of the main function, (which may itself be aliased to us).
8472 * Don't access this version directly.
8476 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8480 va_start(args, pat);
8481 sv_vcatpvf_mg(sv, pat, &args);
8487 =for apidoc sv_catpvf
8489 Processes its arguments like C<sprintf> and appends the formatted
8490 output to an SV. If the appended data contains "wide" characters
8491 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8492 and characters >255 formatted with %c), the original SV might get
8493 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8494 C<SvSETMAGIC()> must typically be called after calling this function
8495 to handle 'set' magic.
8500 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8503 va_start(args, pat);
8504 sv_vcatpvf(sv, pat, &args);
8508 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8511 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8513 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8517 =for apidoc sv_catpvf_mg
8519 Like C<sv_catpvf>, but also handles 'set' magic.
8525 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8528 va_start(args, pat);
8529 sv_vcatpvf_mg(sv, pat, &args);
8533 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
8536 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8538 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8543 =for apidoc sv_vsetpvfn
8545 Works like C<vcatpvfn> but copies the text into the SV instead of
8548 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
8554 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8556 sv_setpvn(sv, "", 0);
8557 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8560 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8563 S_expect_number(pTHX_ char** pattern)
8566 switch (**pattern) {
8567 case '1': case '2': case '3':
8568 case '4': case '5': case '6':
8569 case '7': case '8': case '9':
8570 while (isDIGIT(**pattern))
8571 var = var * 10 + (*(*pattern)++ - '0');
8575 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8578 F0convert(NV nv, char *endbuf, STRLEN *len)
8589 if (uv & 1 && uv == nv)
8590 uv--; /* Round to even */
8592 unsigned dig = uv % 10;
8605 =for apidoc sv_vcatpvfn
8607 Processes its arguments like C<vsprintf> and appends the formatted output
8608 to an SV. Uses an array of SVs if the C style variable argument list is
8609 missing (NULL). When running with taint checks enabled, indicates via
8610 C<maybe_tainted> if results are untrustworthy (often due to the use of
8613 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
8619 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8626 static char nullstr[] = "(null)";
8628 bool has_utf8; /* has the result utf8? */
8629 bool pat_utf8; /* the pattern is in utf8? */
8631 /* Times 4: a decimal digit takes more than 3 binary digits.
8632 * NV_DIG: mantissa takes than many decimal digits.
8633 * Plus 32: Playing safe. */
8634 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8635 /* large enough for "%#.#f" --chip */
8636 /* what about long double NVs? --jhi */
8638 has_utf8 = pat_utf8 = DO_UTF8(sv);
8640 /* no matter what, this is a string now */
8641 (void)SvPV_force(sv, origlen);
8643 /* special-case "", "%s", and "%_" */
8646 if (patlen == 2 && pat[0] == '%') {
8650 char *s = va_arg(*args, char*);
8651 sv_catpv(sv, s ? s : nullstr);
8653 else if (svix < svmax) {
8654 sv_catsv(sv, *svargs);
8655 if (DO_UTF8(*svargs))
8661 argsv = va_arg(*args, SV*);
8662 sv_catsv(sv, argsv);
8667 /* See comment on '_' below */
8672 #ifndef USE_LONG_DOUBLE
8673 /* special-case "%.<number>[gf]" */
8674 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8675 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8676 unsigned digits = 0;
8680 while (*pp >= '0' && *pp <= '9')
8681 digits = 10 * digits + (*pp++ - '0');
8682 if (pp - pat == (int)patlen - 1) {
8686 nv = (NV)va_arg(*args, double);
8687 else if (svix < svmax)
8692 /* Add check for digits != 0 because it seems that some
8693 gconverts are buggy in this case, and we don't yet have
8694 a Configure test for this. */
8695 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8696 /* 0, point, slack */
8697 Gconvert(nv, (int)digits, 0, ebuf);
8699 if (*ebuf) /* May return an empty string for digits==0 */
8702 } else if (!digits) {
8705 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8706 sv_catpvn(sv, p, l);
8712 #endif /* !USE_LONG_DOUBLE */
8714 if (!args && svix < svmax && DO_UTF8(*svargs))
8717 patend = (char*)pat + patlen;
8718 for (p = (char*)pat; p < patend; p = q) {
8721 bool vectorize = FALSE;
8722 bool vectorarg = FALSE;
8723 bool vec_utf8 = FALSE;
8729 bool has_precis = FALSE;
8732 bool is_utf8 = FALSE; /* is this item utf8? */
8733 #ifdef HAS_LDBL_SPRINTF_BUG
8734 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8735 with sfio - Allen <allens@cpan.org> */
8736 bool fix_ldbl_sprintf_bug = FALSE;
8740 U8 utf8buf[UTF8_MAXLEN+1];
8741 STRLEN esignlen = 0;
8743 char *eptr = Nullch;
8746 U8 *vecstr = Null(U8*);
8753 /* we need a long double target in case HAS_LONG_DOUBLE but
8756 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8765 STRLEN dotstrlen = 1;
8766 I32 efix = 0; /* explicit format parameter index */
8767 I32 ewix = 0; /* explicit width index */
8768 I32 epix = 0; /* explicit precision index */
8769 I32 evix = 0; /* explicit vector index */
8770 bool asterisk = FALSE;
8772 /* echo everything up to the next format specification */
8773 for (q = p; q < patend && *q != '%'; ++q) ;
8775 if (has_utf8 && !pat_utf8)
8776 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8778 sv_catpvn(sv, p, q - p);
8785 We allow format specification elements in this order:
8786 \d+\$ explicit format parameter index
8788 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8789 0 flag (as above): repeated to allow "v02"
8790 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8791 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8793 [%bcdefginopsux_DFOUX] format (mandatory)
8795 if (EXPECT_NUMBER(q, width)) {
8836 if (EXPECT_NUMBER(q, ewix))
8845 if ((vectorarg = asterisk)) {
8857 EXPECT_NUMBER(q, width);
8862 vecsv = va_arg(*args, SV*);
8864 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8865 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8866 dotstr = SvPVx(vecsv, dotstrlen);
8871 vecsv = va_arg(*args, SV*);
8872 vecstr = (U8*)SvPVx(vecsv,veclen);
8873 vec_utf8 = DO_UTF8(vecsv);
8875 else if (efix ? efix <= svmax : svix < svmax) {
8876 vecsv = svargs[efix ? efix-1 : svix++];
8877 vecstr = (U8*)SvPVx(vecsv,veclen);
8878 vec_utf8 = DO_UTF8(vecsv);
8888 i = va_arg(*args, int);
8890 i = (ewix ? ewix <= svmax : svix < svmax) ?
8891 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8893 width = (i < 0) ? -i : i;
8903 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8905 /* XXX: todo, support specified precision parameter */
8909 i = va_arg(*args, int);
8911 i = (ewix ? ewix <= svmax : svix < svmax)
8912 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8913 precis = (i < 0) ? 0 : i;
8918 precis = precis * 10 + (*q++ - '0');
8927 case 'I': /* Ix, I32x, and I64x */
8929 if (q[1] == '6' && q[2] == '4') {
8935 if (q[1] == '3' && q[2] == '2') {
8945 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8956 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8957 if (*(q + 1) == 'l') { /* lld, llf */
8982 argsv = (efix ? efix <= svmax : svix < svmax) ?
8983 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8990 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8992 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8994 eptr = (char*)utf8buf;
8995 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9006 if (args && !vectorize) {
9007 eptr = va_arg(*args, char*);
9009 #ifdef MACOS_TRADITIONAL
9010 /* On MacOS, %#s format is used for Pascal strings */
9015 elen = strlen(eptr);
9018 elen = sizeof nullstr - 1;
9022 eptr = SvPVx(argsv, elen);
9023 if (DO_UTF8(argsv)) {
9024 if (has_precis && precis < elen) {
9026 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9029 if (width) { /* fudge width (can't fudge elen) */
9030 width += elen - sv_len_utf8(argsv);
9039 * The "%_" hack might have to be changed someday,
9040 * if ISO or ANSI decide to use '_' for something.
9041 * So we keep it hidden from users' code.
9043 if (!args || vectorize)
9045 argsv = va_arg(*args, SV*);
9046 eptr = SvPVx(argsv, elen);
9052 if (has_precis && elen > precis)
9059 if (alt || vectorize)
9061 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9079 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9088 esignbuf[esignlen++] = plus;
9092 case 'h': iv = (short)va_arg(*args, int); break;
9093 case 'l': iv = va_arg(*args, long); break;
9094 case 'V': iv = va_arg(*args, IV); break;
9095 default: iv = va_arg(*args, int); break;
9097 case 'q': iv = va_arg(*args, Quad_t); break;
9102 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9104 case 'h': iv = (short)tiv; break;
9105 case 'l': iv = (long)tiv; break;
9107 default: iv = tiv; break;
9109 case 'q': iv = (Quad_t)tiv; break;
9113 if ( !vectorize ) /* we already set uv above */
9118 esignbuf[esignlen++] = plus;
9122 esignbuf[esignlen++] = '-';
9165 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9176 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9177 case 'l': uv = va_arg(*args, unsigned long); break;
9178 case 'V': uv = va_arg(*args, UV); break;
9179 default: uv = va_arg(*args, unsigned); break;
9181 case 'q': uv = va_arg(*args, Uquad_t); break;
9186 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9188 case 'h': uv = (unsigned short)tuv; break;
9189 case 'l': uv = (unsigned long)tuv; break;
9191 default: uv = tuv; break;
9193 case 'q': uv = (Uquad_t)tuv; break;
9199 eptr = ebuf + sizeof ebuf;
9205 p = (char*)((c == 'X')
9206 ? "0123456789ABCDEF" : "0123456789abcdef");
9212 esignbuf[esignlen++] = '0';
9213 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9219 *--eptr = '0' + dig;
9221 if (alt && *eptr != '0')
9227 *--eptr = '0' + dig;
9230 esignbuf[esignlen++] = '0';
9231 esignbuf[esignlen++] = 'b';
9234 default: /* it had better be ten or less */
9235 #if defined(PERL_Y2KWARN)
9236 if (ckWARN(WARN_Y2K)) {
9238 char *s = SvPV(sv,n);
9239 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9240 && (n == 2 || !isDIGIT(s[n-3])))
9242 Perl_warner(aTHX_ packWARN(WARN_Y2K),
9243 "Possible Y2K bug: %%%c %s",
9244 c, "format string following '19'");
9250 *--eptr = '0' + dig;
9251 } while (uv /= base);
9254 elen = (ebuf + sizeof ebuf) - eptr;
9257 zeros = precis - elen;
9258 else if (precis == 0 && elen == 1 && *eptr == '0')
9263 /* FLOATING POINT */
9266 c = 'f'; /* maybe %F isn't supported here */
9272 /* This is evil, but floating point is even more evil */
9274 /* for SV-style calling, we can only get NV
9275 for C-style calling, we assume %f is double;
9276 for simplicity we allow any of %Lf, %llf, %qf for long double
9280 #if defined(USE_LONG_DOUBLE)
9284 /* [perl #20339] - we should accept and ignore %lf rather than die */
9288 #if defined(USE_LONG_DOUBLE)
9289 intsize = args ? 0 : 'q';
9293 #if defined(HAS_LONG_DOUBLE)
9302 /* now we need (long double) if intsize == 'q', else (double) */
9303 nv = (args && !vectorize) ?
9304 #if LONG_DOUBLESIZE > DOUBLESIZE
9306 va_arg(*args, long double) :
9307 va_arg(*args, double)
9309 va_arg(*args, double)
9315 if (c != 'e' && c != 'E') {
9317 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9318 will cast our (long double) to (double) */
9319 (void)Perl_frexp(nv, &i);
9320 if (i == PERL_INT_MIN)
9321 Perl_die(aTHX_ "panic: frexp");
9323 need = BIT_DIGITS(i);
9325 need += has_precis ? precis : 6; /* known default */
9330 #ifdef HAS_LDBL_SPRINTF_BUG
9331 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9332 with sfio - Allen <allens@cpan.org> */
9335 # define MY_DBL_MAX DBL_MAX
9336 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9337 # if DOUBLESIZE >= 8
9338 # define MY_DBL_MAX 1.7976931348623157E+308L
9340 # define MY_DBL_MAX 3.40282347E+38L
9344 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9345 # define MY_DBL_MAX_BUG 1L
9347 # define MY_DBL_MAX_BUG MY_DBL_MAX
9351 # define MY_DBL_MIN DBL_MIN
9352 # else /* XXX guessing! -Allen */
9353 # if DOUBLESIZE >= 8
9354 # define MY_DBL_MIN 2.2250738585072014E-308L
9356 # define MY_DBL_MIN 1.17549435E-38L
9360 if ((intsize == 'q') && (c == 'f') &&
9361 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9363 /* it's going to be short enough that
9364 * long double precision is not needed */
9366 if ((nv <= 0L) && (nv >= -0L))
9367 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9369 /* would use Perl_fp_class as a double-check but not
9370 * functional on IRIX - see perl.h comments */
9372 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9373 /* It's within the range that a double can represent */
9374 #if defined(DBL_MAX) && !defined(DBL_MIN)
9375 if ((nv >= ((long double)1/DBL_MAX)) ||
9376 (nv <= (-(long double)1/DBL_MAX)))
9378 fix_ldbl_sprintf_bug = TRUE;
9381 if (fix_ldbl_sprintf_bug == TRUE) {
9391 # undef MY_DBL_MAX_BUG
9394 #endif /* HAS_LDBL_SPRINTF_BUG */
9396 need += 20; /* fudge factor */
9397 if (PL_efloatsize < need) {
9398 Safefree(PL_efloatbuf);
9399 PL_efloatsize = need + 20; /* more fudge */
9400 New(906, PL_efloatbuf, PL_efloatsize, char);
9401 PL_efloatbuf[0] = '\0';
9404 if ( !(width || left || plus || alt) && fill != '0'
9405 && has_precis && intsize != 'q' ) { /* Shortcuts */
9406 /* See earlier comment about buggy Gconvert when digits,
9408 if ( c == 'g' && precis) {
9409 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9410 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9411 goto float_converted;
9412 } else if ( c == 'f' && !precis) {
9413 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9417 eptr = ebuf + sizeof ebuf;
9420 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9421 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9422 if (intsize == 'q') {
9423 /* Copy the one or more characters in a long double
9424 * format before the 'base' ([efgEFG]) character to
9425 * the format string. */
9426 static char const prifldbl[] = PERL_PRIfldbl;
9427 char const *p = prifldbl + sizeof(prifldbl) - 3;
9428 while (p >= prifldbl) { *--eptr = *p--; }
9433 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9438 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9450 /* No taint. Otherwise we are in the strange situation
9451 * where printf() taints but print($float) doesn't.
9453 #if defined(HAS_LONG_DOUBLE)
9455 (void)sprintf(PL_efloatbuf, eptr, nv);
9457 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9459 (void)sprintf(PL_efloatbuf, eptr, nv);
9462 eptr = PL_efloatbuf;
9463 elen = strlen(PL_efloatbuf);
9469 i = SvCUR(sv) - origlen;
9470 if (args && !vectorize) {
9472 case 'h': *(va_arg(*args, short*)) = i; break;
9473 default: *(va_arg(*args, int*)) = i; break;
9474 case 'l': *(va_arg(*args, long*)) = i; break;
9475 case 'V': *(va_arg(*args, IV*)) = i; break;
9477 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9482 sv_setuv_mg(argsv, (UV)i);
9484 continue; /* not "break" */
9490 if (!args && ckWARN(WARN_PRINTF) &&
9491 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9492 SV *msg = sv_newmortal();
9493 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9494 (PL_op->op_type == OP_PRTF) ? "" : "s");
9497 Perl_sv_catpvf(aTHX_ msg,
9498 "\"%%%c\"", c & 0xFF);
9500 Perl_sv_catpvf(aTHX_ msg,
9501 "\"%%\\%03"UVof"\"",
9504 sv_catpv(msg, "end of string");
9505 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9508 /* output mangled stuff ... */
9514 /* ... right here, because formatting flags should not apply */
9515 SvGROW(sv, SvCUR(sv) + elen + 1);
9517 Copy(eptr, p, elen, char);
9520 SvCUR(sv) = p - SvPVX(sv);
9522 continue; /* not "break" */
9525 /* calculate width before utf8_upgrade changes it */
9526 have = esignlen + zeros + elen;
9528 if (is_utf8 != has_utf8) {
9531 sv_utf8_upgrade(sv);
9534 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9535 sv_utf8_upgrade(nsv);
9539 SvGROW(sv, SvCUR(sv) + elen + 1);
9543 /* Use memchr() instead of strchr(), as eptr is not guaranteed */
9544 /* to point to a null-terminated string. */
9545 if (left && ckWARN(WARN_PRINTF) && memchr(eptr, '\n', elen) &&
9546 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF))
9547 Perl_warner(aTHX_ packWARN(WARN_PRINTF),
9548 "Newline in left-justified string for %sprintf",
9549 (PL_op->op_type == OP_PRTF) ? "" : "s");
9551 need = (have > width ? have : width);
9554 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9556 if (esignlen && fill == '0') {
9557 for (i = 0; i < (int)esignlen; i++)
9561 memset(p, fill, gap);
9564 if (esignlen && fill != '0') {
9565 for (i = 0; i < (int)esignlen; i++)
9569 for (i = zeros; i; i--)
9573 Copy(eptr, p, elen, char);
9577 memset(p, ' ', gap);
9582 Copy(dotstr, p, dotstrlen, char);
9586 vectorize = FALSE; /* done iterating over vecstr */
9593 SvCUR(sv) = p - SvPVX(sv);
9601 /* =========================================================================
9603 =head1 Cloning an interpreter
9605 All the macros and functions in this section are for the private use of
9606 the main function, perl_clone().
9608 The foo_dup() functions make an exact copy of an existing foo thinngy.
9609 During the course of a cloning, a hash table is used to map old addresses
9610 to new addresses. The table is created and manipulated with the
9611 ptr_table_* functions.
9615 ============================================================================*/
9618 #if defined(USE_ITHREADS)
9620 #ifndef GpREFCNT_inc
9621 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9625 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9626 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9627 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9628 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9629 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9630 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9631 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9632 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9633 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9634 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9635 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9636 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9637 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9640 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9641 regcomp.c. AMS 20010712 */
9644 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
9648 struct reg_substr_datum *s;
9651 return (REGEXP *)NULL;
9653 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9656 len = r->offsets[0];
9657 npar = r->nparens+1;
9659 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9660 Copy(r->program, ret->program, len+1, regnode);
9662 New(0, ret->startp, npar, I32);
9663 Copy(r->startp, ret->startp, npar, I32);
9664 New(0, ret->endp, npar, I32);
9665 Copy(r->startp, ret->startp, npar, I32);
9667 New(0, ret->substrs, 1, struct reg_substr_data);
9668 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9669 s->min_offset = r->substrs->data[i].min_offset;
9670 s->max_offset = r->substrs->data[i].max_offset;
9671 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9672 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9675 ret->regstclass = NULL;
9678 int count = r->data->count;
9680 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9681 char, struct reg_data);
9682 New(0, d->what, count, U8);
9685 for (i = 0; i < count; i++) {
9686 d->what[i] = r->data->what[i];
9687 switch (d->what[i]) {
9689 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9692 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9695 /* This is cheating. */
9696 New(0, d->data[i], 1, struct regnode_charclass_class);
9697 StructCopy(r->data->data[i], d->data[i],
9698 struct regnode_charclass_class);
9699 ret->regstclass = (regnode*)d->data[i];
9702 /* Compiled op trees are readonly, and can thus be
9703 shared without duplication. */
9704 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9707 d->data[i] = r->data->data[i];
9717 New(0, ret->offsets, 2*len+1, U32);
9718 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9720 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9721 ret->refcnt = r->refcnt;
9722 ret->minlen = r->minlen;
9723 ret->prelen = r->prelen;
9724 ret->nparens = r->nparens;
9725 ret->lastparen = r->lastparen;
9726 ret->lastcloseparen = r->lastcloseparen;
9727 ret->reganch = r->reganch;
9729 ret->sublen = r->sublen;
9731 if (RX_MATCH_COPIED(ret))
9732 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9734 ret->subbeg = Nullch;
9735 #ifdef PERL_COPY_ON_WRITE
9736 ret->saved_copy = Nullsv;
9739 ptr_table_store(PL_ptr_table, r, ret);
9743 /* duplicate a file handle */
9746 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9750 return (PerlIO*)NULL;
9752 /* look for it in the table first */
9753 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9757 /* create anew and remember what it is */
9758 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9759 ptr_table_store(PL_ptr_table, fp, ret);
9763 /* duplicate a directory handle */
9766 Perl_dirp_dup(pTHX_ DIR *dp)
9774 /* duplicate a typeglob */
9777 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9782 /* look for it in the table first */
9783 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9787 /* create anew and remember what it is */
9788 Newz(0, ret, 1, GP);
9789 ptr_table_store(PL_ptr_table, gp, ret);
9792 ret->gp_refcnt = 0; /* must be before any other dups! */
9793 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9794 ret->gp_io = io_dup_inc(gp->gp_io, param);
9795 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9796 ret->gp_av = av_dup_inc(gp->gp_av, param);
9797 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9798 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9799 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9800 ret->gp_cvgen = gp->gp_cvgen;
9801 ret->gp_flags = gp->gp_flags;
9802 ret->gp_line = gp->gp_line;
9803 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9807 /* duplicate a chain of magic */
9810 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9812 MAGIC *mgprev = (MAGIC*)NULL;
9815 return (MAGIC*)NULL;
9816 /* look for it in the table first */
9817 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9821 for (; mg; mg = mg->mg_moremagic) {
9823 Newz(0, nmg, 1, MAGIC);
9825 mgprev->mg_moremagic = nmg;
9828 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9829 nmg->mg_private = mg->mg_private;
9830 nmg->mg_type = mg->mg_type;
9831 nmg->mg_flags = mg->mg_flags;
9832 if (mg->mg_type == PERL_MAGIC_qr) {
9833 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9835 else if(mg->mg_type == PERL_MAGIC_backref) {
9836 AV *av = (AV*) mg->mg_obj;
9839 SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9841 for (i = AvFILLp(av); i >= 0; i--) {
9842 if (!svp[i]) continue;
9843 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9847 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9848 ? sv_dup_inc(mg->mg_obj, param)
9849 : sv_dup(mg->mg_obj, param);
9851 nmg->mg_len = mg->mg_len;
9852 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9853 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9854 if (mg->mg_len > 0) {
9855 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9856 if (mg->mg_type == PERL_MAGIC_overload_table &&
9857 AMT_AMAGIC((AMT*)mg->mg_ptr))
9859 AMT *amtp = (AMT*)mg->mg_ptr;
9860 AMT *namtp = (AMT*)nmg->mg_ptr;
9862 for (i = 1; i < NofAMmeth; i++) {
9863 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9867 else if (mg->mg_len == HEf_SVKEY)
9868 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9870 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9871 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9878 /* create a new pointer-mapping table */
9881 Perl_ptr_table_new(pTHX)
9884 Newz(0, tbl, 1, PTR_TBL_t);
9887 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9891 /* map an existing pointer using a table */
9894 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
9896 PTR_TBL_ENT_t *tblent;
9897 UV hash = PTR2UV(sv);
9899 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9900 for (; tblent; tblent = tblent->next) {
9901 if (tblent->oldval == sv)
9902 return tblent->newval;
9907 /* add a new entry to a pointer-mapping table */
9910 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
9912 PTR_TBL_ENT_t *tblent, **otblent;
9913 /* XXX this may be pessimal on platforms where pointers aren't good
9914 * hash values e.g. if they grow faster in the most significant
9916 UV hash = PTR2UV(oldv);
9920 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9921 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
9922 if (tblent->oldval == oldv) {
9923 tblent->newval = newv;
9927 Newz(0, tblent, 1, PTR_TBL_ENT_t);
9928 tblent->oldval = oldv;
9929 tblent->newval = newv;
9930 tblent->next = *otblent;
9933 if (i && tbl->tbl_items > tbl->tbl_max)
9934 ptr_table_split(tbl);
9937 /* double the hash bucket size of an existing ptr table */
9940 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9942 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9943 UV oldsize = tbl->tbl_max + 1;
9944 UV newsize = oldsize * 2;
9947 Renew(ary, newsize, PTR_TBL_ENT_t*);
9948 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9949 tbl->tbl_max = --newsize;
9951 for (i=0; i < oldsize; i++, ary++) {
9952 PTR_TBL_ENT_t **curentp, **entp, *ent;
9955 curentp = ary + oldsize;
9956 for (entp = ary, ent = *ary; ent; ent = *entp) {
9957 if ((newsize & PTR2UV(ent->oldval)) != i) {
9959 ent->next = *curentp;
9969 /* remove all the entries from a ptr table */
9972 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9974 register PTR_TBL_ENT_t **array;
9975 register PTR_TBL_ENT_t *entry;
9976 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
9980 if (!tbl || !tbl->tbl_items) {
9984 array = tbl->tbl_ary;
9991 entry = entry->next;
9995 if (++riter > max) {
9998 entry = array[riter];
10002 tbl->tbl_items = 0;
10005 /* clear and free a ptr table */
10008 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10013 ptr_table_clear(tbl);
10014 Safefree(tbl->tbl_ary);
10019 char *PL_watch_pvx;
10022 /* attempt to make everything in the typeglob readonly */
10025 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10027 GV *gv = (GV*)sstr;
10028 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10030 if (GvIO(gv) || GvFORM(gv)) {
10031 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10033 else if (!GvCV(gv)) {
10034 GvCV(gv) = (CV*)sv;
10037 /* CvPADLISTs cannot be shared */
10038 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10043 if (!GvUNIQUE(gv)) {
10045 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10046 HvNAME(GvSTASH(gv)), GvNAME(gv));
10052 * write attempts will die with
10053 * "Modification of a read-only value attempted"
10059 SvREADONLY_on(GvSV(gv));
10063 GvAV(gv) = (AV*)sv;
10066 SvREADONLY_on(GvAV(gv));
10070 GvHV(gv) = (HV*)sv;
10073 SvREADONLY_on(GvHV(gv));
10076 return sstr; /* he_dup() will SvREFCNT_inc() */
10079 /* duplicate an SV of any type (including AV, HV etc) */
10082 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10085 SvRV(dstr) = SvWEAKREF(sstr)
10086 ? sv_dup(SvRV(sstr), param)
10087 : sv_dup_inc(SvRV(sstr), param);
10089 else if (SvPVX(sstr)) {
10090 /* Has something there */
10092 /* Normal PV - clone whole allocated space */
10093 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
10094 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10095 /* Not that normal - actually sstr is copy on write.
10096 But we are a true, independant SV, so: */
10097 SvREADONLY_off(dstr);
10102 /* Special case - not normally malloced for some reason */
10103 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10104 /* A "shared" PV - clone it as unshared string */
10105 if(SvPADTMP(sstr)) {
10106 /* However, some of them live in the pad
10107 and they should not have these flags
10110 SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
10112 SvUVX(dstr) = SvUVX(sstr);
10115 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
10117 SvREADONLY_off(dstr);
10121 /* Some other special case - random pointer */
10122 SvPVX(dstr) = SvPVX(sstr);
10127 /* Copy the Null */
10128 SvPVX(dstr) = SvPVX(sstr);
10133 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10137 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10139 /* look for it in the table first */
10140 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10144 if(param->flags & CLONEf_JOIN_IN) {
10145 /** We are joining here so we don't want do clone
10146 something that is bad **/
10148 if(SvTYPE(sstr) == SVt_PVHV &&
10150 /** don't clone stashes if they already exist **/
10151 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10152 return (SV*) old_stash;
10156 /* create anew and remember what it is */
10158 ptr_table_store(PL_ptr_table, sstr, dstr);
10161 SvFLAGS(dstr) = SvFLAGS(sstr);
10162 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10163 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10166 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10167 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10168 PL_watch_pvx, SvPVX(sstr));
10171 switch (SvTYPE(sstr)) {
10173 SvANY(dstr) = NULL;
10176 SvANY(dstr) = new_XIV();
10177 SvIVX(dstr) = SvIVX(sstr);
10180 SvANY(dstr) = new_XNV();
10181 SvNVX(dstr) = SvNVX(sstr);
10184 SvANY(dstr) = new_XRV();
10185 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10188 SvANY(dstr) = new_XPV();
10189 SvCUR(dstr) = SvCUR(sstr);
10190 SvLEN(dstr) = SvLEN(sstr);
10191 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10194 SvANY(dstr) = new_XPVIV();
10195 SvCUR(dstr) = SvCUR(sstr);
10196 SvLEN(dstr) = SvLEN(sstr);
10197 SvIVX(dstr) = SvIVX(sstr);
10198 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10201 SvANY(dstr) = new_XPVNV();
10202 SvCUR(dstr) = SvCUR(sstr);
10203 SvLEN(dstr) = SvLEN(sstr);
10204 SvIVX(dstr) = SvIVX(sstr);
10205 SvNVX(dstr) = SvNVX(sstr);
10206 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10209 SvANY(dstr) = new_XPVMG();
10210 SvCUR(dstr) = SvCUR(sstr);
10211 SvLEN(dstr) = SvLEN(sstr);
10212 SvIVX(dstr) = SvIVX(sstr);
10213 SvNVX(dstr) = SvNVX(sstr);
10214 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10215 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10216 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10219 SvANY(dstr) = new_XPVBM();
10220 SvCUR(dstr) = SvCUR(sstr);
10221 SvLEN(dstr) = SvLEN(sstr);
10222 SvIVX(dstr) = SvIVX(sstr);
10223 SvNVX(dstr) = SvNVX(sstr);
10224 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10225 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10226 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10227 BmRARE(dstr) = BmRARE(sstr);
10228 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10229 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10232 SvANY(dstr) = new_XPVLV();
10233 SvCUR(dstr) = SvCUR(sstr);
10234 SvLEN(dstr) = SvLEN(sstr);
10235 SvIVX(dstr) = SvIVX(sstr);
10236 SvNVX(dstr) = SvNVX(sstr);
10237 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10238 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10239 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10240 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10241 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10242 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10243 LvTARG(dstr) = dstr;
10244 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10245 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10247 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10248 LvTYPE(dstr) = LvTYPE(sstr);
10251 if (GvUNIQUE((GV*)sstr)) {
10253 if ((share = gv_share(sstr, param))) {
10256 ptr_table_store(PL_ptr_table, sstr, dstr);
10258 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10259 HvNAME(GvSTASH(share)), GvNAME(share));
10264 SvANY(dstr) = new_XPVGV();
10265 SvCUR(dstr) = SvCUR(sstr);
10266 SvLEN(dstr) = SvLEN(sstr);
10267 SvIVX(dstr) = SvIVX(sstr);
10268 SvNVX(dstr) = SvNVX(sstr);
10269 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10270 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10271 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10272 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10273 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10274 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10275 GvFLAGS(dstr) = GvFLAGS(sstr);
10276 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10277 (void)GpREFCNT_inc(GvGP(dstr));
10280 SvANY(dstr) = new_XPVIO();
10281 SvCUR(dstr) = SvCUR(sstr);
10282 SvLEN(dstr) = SvLEN(sstr);
10283 SvIVX(dstr) = SvIVX(sstr);
10284 SvNVX(dstr) = SvNVX(sstr);
10285 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10286 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10287 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10288 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10289 if (IoOFP(sstr) == IoIFP(sstr))
10290 IoOFP(dstr) = IoIFP(dstr);
10292 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10293 /* PL_rsfp_filters entries have fake IoDIRP() */
10294 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10295 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10297 IoDIRP(dstr) = IoDIRP(sstr);
10298 IoLINES(dstr) = IoLINES(sstr);
10299 IoPAGE(dstr) = IoPAGE(sstr);
10300 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10301 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10302 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10303 /* I have no idea why fake dirp (rsfps)
10304 should be treaded differently but otherwise
10305 we end up with leaks -- sky*/
10306 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10307 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10308 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10310 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10311 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10312 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10314 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10315 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10316 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10317 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10318 IoTYPE(dstr) = IoTYPE(sstr);
10319 IoFLAGS(dstr) = IoFLAGS(sstr);
10322 SvANY(dstr) = new_XPVAV();
10323 SvCUR(dstr) = SvCUR(sstr);
10324 SvLEN(dstr) = SvLEN(sstr);
10325 SvIVX(dstr) = SvIVX(sstr);
10326 SvNVX(dstr) = SvNVX(sstr);
10327 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10328 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10329 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10330 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10331 if (AvARRAY((AV*)sstr)) {
10332 SV **dst_ary, **src_ary;
10333 SSize_t items = AvFILLp((AV*)sstr) + 1;
10335 src_ary = AvARRAY((AV*)sstr);
10336 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10337 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10338 SvPVX(dstr) = (char*)dst_ary;
10339 AvALLOC((AV*)dstr) = dst_ary;
10340 if (AvREAL((AV*)sstr)) {
10341 while (items-- > 0)
10342 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10345 while (items-- > 0)
10346 *dst_ary++ = sv_dup(*src_ary++, param);
10348 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10349 while (items-- > 0) {
10350 *dst_ary++ = &PL_sv_undef;
10354 SvPVX(dstr) = Nullch;
10355 AvALLOC((AV*)dstr) = (SV**)NULL;
10359 SvANY(dstr) = new_XPVHV();
10360 SvCUR(dstr) = SvCUR(sstr);
10361 SvLEN(dstr) = SvLEN(sstr);
10362 SvIVX(dstr) = SvIVX(sstr);
10363 SvNVX(dstr) = SvNVX(sstr);
10364 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10365 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10366 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
10367 if (HvARRAY((HV*)sstr)) {
10369 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10370 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10371 Newz(0, dxhv->xhv_array,
10372 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10373 while (i <= sxhv->xhv_max) {
10374 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10375 (bool)!!HvSHAREKEYS(sstr),
10379 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10380 (bool)!!HvSHAREKEYS(sstr), param);
10383 SvPVX(dstr) = Nullch;
10384 HvEITER((HV*)dstr) = (HE*)NULL;
10386 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
10387 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
10388 /* Record stashes for possible cloning in Perl_clone(). */
10389 if(HvNAME((HV*)dstr))
10390 av_push(param->stashes, dstr);
10393 SvANY(dstr) = new_XPVFM();
10394 FmLINES(dstr) = FmLINES(sstr);
10398 SvANY(dstr) = new_XPVCV();
10400 SvCUR(dstr) = SvCUR(sstr);
10401 SvLEN(dstr) = SvLEN(sstr);
10402 SvIVX(dstr) = SvIVX(sstr);
10403 SvNVX(dstr) = SvNVX(sstr);
10404 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10405 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10406 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10407 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10408 CvSTART(dstr) = CvSTART(sstr);
10409 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10410 CvXSUB(dstr) = CvXSUB(sstr);
10411 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10412 if (CvCONST(sstr)) {
10413 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10414 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10415 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10417 /* don't dup if copying back - CvGV isn't refcounted, so the
10418 * duped GV may never be freed. A bit of a hack! DAPM */
10419 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10420 Nullgv : gv_dup(CvGV(sstr), param) ;
10421 if (param->flags & CLONEf_COPY_STACKS) {
10422 CvDEPTH(dstr) = CvDEPTH(sstr);
10426 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10427 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10429 CvWEAKOUTSIDE(sstr)
10430 ? cv_dup( CvOUTSIDE(sstr), param)
10431 : cv_dup_inc(CvOUTSIDE(sstr), param);
10432 CvFLAGS(dstr) = CvFLAGS(sstr);
10433 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10436 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10440 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10446 /* duplicate a context */
10449 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10451 PERL_CONTEXT *ncxs;
10454 return (PERL_CONTEXT*)NULL;
10456 /* look for it in the table first */
10457 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10461 /* create anew and remember what it is */
10462 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10463 ptr_table_store(PL_ptr_table, cxs, ncxs);
10466 PERL_CONTEXT *cx = &cxs[ix];
10467 PERL_CONTEXT *ncx = &ncxs[ix];
10468 ncx->cx_type = cx->cx_type;
10469 if (CxTYPE(cx) == CXt_SUBST) {
10470 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10473 ncx->blk_oldsp = cx->blk_oldsp;
10474 ncx->blk_oldcop = cx->blk_oldcop;
10475 ncx->blk_oldretsp = cx->blk_oldretsp;
10476 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10477 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10478 ncx->blk_oldpm = cx->blk_oldpm;
10479 ncx->blk_gimme = cx->blk_gimme;
10480 switch (CxTYPE(cx)) {
10482 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10483 ? cv_dup_inc(cx->blk_sub.cv, param)
10484 : cv_dup(cx->blk_sub.cv,param));
10485 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10486 ? av_dup_inc(cx->blk_sub.argarray, param)
10488 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10489 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10490 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10491 ncx->blk_sub.lval = cx->blk_sub.lval;
10494 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10495 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10496 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10497 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10498 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10501 ncx->blk_loop.label = cx->blk_loop.label;
10502 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10503 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10504 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10505 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10506 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10507 ? cx->blk_loop.iterdata
10508 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10509 ncx->blk_loop.oldcomppad
10510 = (PAD*)ptr_table_fetch(PL_ptr_table,
10511 cx->blk_loop.oldcomppad);
10512 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10513 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10514 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10515 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10516 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10519 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10520 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10521 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10522 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10534 /* duplicate a stack info structure */
10537 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10542 return (PERL_SI*)NULL;
10544 /* look for it in the table first */
10545 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10549 /* create anew and remember what it is */
10550 Newz(56, nsi, 1, PERL_SI);
10551 ptr_table_store(PL_ptr_table, si, nsi);
10553 nsi->si_stack = av_dup_inc(si->si_stack, param);
10554 nsi->si_cxix = si->si_cxix;
10555 nsi->si_cxmax = si->si_cxmax;
10556 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10557 nsi->si_type = si->si_type;
10558 nsi->si_prev = si_dup(si->si_prev, param);
10559 nsi->si_next = si_dup(si->si_next, param);
10560 nsi->si_markoff = si->si_markoff;
10565 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10566 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10567 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10568 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10569 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10570 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10571 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10572 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10573 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10574 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10575 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10576 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10577 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10578 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10581 #define pv_dup_inc(p) SAVEPV(p)
10582 #define pv_dup(p) SAVEPV(p)
10583 #define svp_dup_inc(p,pp) any_dup(p,pp)
10585 /* map any object to the new equivent - either something in the
10586 * ptr table, or something in the interpreter structure
10590 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10595 return (void*)NULL;
10597 /* look for it in the table first */
10598 ret = ptr_table_fetch(PL_ptr_table, v);
10602 /* see if it is part of the interpreter structure */
10603 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10604 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10612 /* duplicate the save stack */
10615 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10617 ANY *ss = proto_perl->Tsavestack;
10618 I32 ix = proto_perl->Tsavestack_ix;
10619 I32 max = proto_perl->Tsavestack_max;
10632 void (*dptr) (void*);
10633 void (*dxptr) (pTHX_ void*);
10636 Newz(54, nss, max, ANY);
10640 TOPINT(nss,ix) = i;
10642 case SAVEt_ITEM: /* normal string */
10643 sv = (SV*)POPPTR(ss,ix);
10644 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10645 sv = (SV*)POPPTR(ss,ix);
10646 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10648 case SAVEt_SV: /* scalar reference */
10649 sv = (SV*)POPPTR(ss,ix);
10650 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10651 gv = (GV*)POPPTR(ss,ix);
10652 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10654 case SAVEt_GENERIC_PVREF: /* generic char* */
10655 c = (char*)POPPTR(ss,ix);
10656 TOPPTR(nss,ix) = pv_dup(c);
10657 ptr = POPPTR(ss,ix);
10658 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10660 case SAVEt_SHARED_PVREF: /* char* in shared space */
10661 c = (char*)POPPTR(ss,ix);
10662 TOPPTR(nss,ix) = savesharedpv(c);
10663 ptr = POPPTR(ss,ix);
10664 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10666 case SAVEt_GENERIC_SVREF: /* generic sv */
10667 case SAVEt_SVREF: /* scalar reference */
10668 sv = (SV*)POPPTR(ss,ix);
10669 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10670 ptr = POPPTR(ss,ix);
10671 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10673 case SAVEt_AV: /* array reference */
10674 av = (AV*)POPPTR(ss,ix);
10675 TOPPTR(nss,ix) = av_dup_inc(av, param);
10676 gv = (GV*)POPPTR(ss,ix);
10677 TOPPTR(nss,ix) = gv_dup(gv, param);
10679 case SAVEt_HV: /* hash reference */
10680 hv = (HV*)POPPTR(ss,ix);
10681 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10682 gv = (GV*)POPPTR(ss,ix);
10683 TOPPTR(nss,ix) = gv_dup(gv, param);
10685 case SAVEt_INT: /* int reference */
10686 ptr = POPPTR(ss,ix);
10687 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10688 intval = (int)POPINT(ss,ix);
10689 TOPINT(nss,ix) = intval;
10691 case SAVEt_LONG: /* long reference */
10692 ptr = POPPTR(ss,ix);
10693 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10694 longval = (long)POPLONG(ss,ix);
10695 TOPLONG(nss,ix) = longval;
10697 case SAVEt_I32: /* I32 reference */
10698 case SAVEt_I16: /* I16 reference */
10699 case SAVEt_I8: /* I8 reference */
10700 ptr = POPPTR(ss,ix);
10701 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10703 TOPINT(nss,ix) = i;
10705 case SAVEt_IV: /* IV reference */
10706 ptr = POPPTR(ss,ix);
10707 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10709 TOPIV(nss,ix) = iv;
10711 case SAVEt_SPTR: /* SV* reference */
10712 ptr = POPPTR(ss,ix);
10713 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10714 sv = (SV*)POPPTR(ss,ix);
10715 TOPPTR(nss,ix) = sv_dup(sv, param);
10717 case SAVEt_VPTR: /* random* reference */
10718 ptr = POPPTR(ss,ix);
10719 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10720 ptr = POPPTR(ss,ix);
10721 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10723 case SAVEt_PPTR: /* char* reference */
10724 ptr = POPPTR(ss,ix);
10725 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10726 c = (char*)POPPTR(ss,ix);
10727 TOPPTR(nss,ix) = pv_dup(c);
10729 case SAVEt_HPTR: /* HV* reference */
10730 ptr = POPPTR(ss,ix);
10731 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10732 hv = (HV*)POPPTR(ss,ix);
10733 TOPPTR(nss,ix) = hv_dup(hv, param);
10735 case SAVEt_APTR: /* AV* reference */
10736 ptr = POPPTR(ss,ix);
10737 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10738 av = (AV*)POPPTR(ss,ix);
10739 TOPPTR(nss,ix) = av_dup(av, param);
10742 gv = (GV*)POPPTR(ss,ix);
10743 TOPPTR(nss,ix) = gv_dup(gv, param);
10745 case SAVEt_GP: /* scalar reference */
10746 gp = (GP*)POPPTR(ss,ix);
10747 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10748 (void)GpREFCNT_inc(gp);
10749 gv = (GV*)POPPTR(ss,ix);
10750 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10751 c = (char*)POPPTR(ss,ix);
10752 TOPPTR(nss,ix) = pv_dup(c);
10754 TOPIV(nss,ix) = iv;
10756 TOPIV(nss,ix) = iv;
10759 case SAVEt_MORTALIZESV:
10760 sv = (SV*)POPPTR(ss,ix);
10761 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10764 ptr = POPPTR(ss,ix);
10765 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10766 /* these are assumed to be refcounted properly */
10767 switch (((OP*)ptr)->op_type) {
10769 case OP_LEAVESUBLV:
10773 case OP_LEAVEWRITE:
10774 TOPPTR(nss,ix) = ptr;
10779 TOPPTR(nss,ix) = Nullop;
10784 TOPPTR(nss,ix) = Nullop;
10787 c = (char*)POPPTR(ss,ix);
10788 TOPPTR(nss,ix) = pv_dup_inc(c);
10790 case SAVEt_CLEARSV:
10791 longval = POPLONG(ss,ix);
10792 TOPLONG(nss,ix) = longval;
10795 hv = (HV*)POPPTR(ss,ix);
10796 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10797 c = (char*)POPPTR(ss,ix);
10798 TOPPTR(nss,ix) = pv_dup_inc(c);
10800 TOPINT(nss,ix) = i;
10802 case SAVEt_DESTRUCTOR:
10803 ptr = POPPTR(ss,ix);
10804 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10805 dptr = POPDPTR(ss,ix);
10806 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
10808 case SAVEt_DESTRUCTOR_X:
10809 ptr = POPPTR(ss,ix);
10810 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10811 dxptr = POPDXPTR(ss,ix);
10812 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
10814 case SAVEt_REGCONTEXT:
10817 TOPINT(nss,ix) = i;
10820 case SAVEt_STACK_POS: /* Position on Perl stack */
10822 TOPINT(nss,ix) = i;
10824 case SAVEt_AELEM: /* array element */
10825 sv = (SV*)POPPTR(ss,ix);
10826 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10828 TOPINT(nss,ix) = i;
10829 av = (AV*)POPPTR(ss,ix);
10830 TOPPTR(nss,ix) = av_dup_inc(av, param);
10832 case SAVEt_HELEM: /* hash element */
10833 sv = (SV*)POPPTR(ss,ix);
10834 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10835 sv = (SV*)POPPTR(ss,ix);
10836 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10837 hv = (HV*)POPPTR(ss,ix);
10838 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10841 ptr = POPPTR(ss,ix);
10842 TOPPTR(nss,ix) = ptr;
10846 TOPINT(nss,ix) = i;
10848 case SAVEt_COMPPAD:
10849 av = (AV*)POPPTR(ss,ix);
10850 TOPPTR(nss,ix) = av_dup(av, param);
10853 longval = (long)POPLONG(ss,ix);
10854 TOPLONG(nss,ix) = longval;
10855 ptr = POPPTR(ss,ix);
10856 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10857 sv = (SV*)POPPTR(ss,ix);
10858 TOPPTR(nss,ix) = sv_dup(sv, param);
10861 ptr = POPPTR(ss,ix);
10862 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10863 longval = (long)POPBOOL(ss,ix);
10864 TOPBOOL(nss,ix) = (bool)longval;
10866 case SAVEt_SET_SVFLAGS:
10868 TOPINT(nss,ix) = i;
10870 TOPINT(nss,ix) = i;
10871 sv = (SV*)POPPTR(ss,ix);
10872 TOPPTR(nss,ix) = sv_dup(sv, param);
10875 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10883 =for apidoc perl_clone
10885 Create and return a new interpreter by cloning the current one.
10887 perl_clone takes these flags as parameters:
10889 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10890 without it we only clone the data and zero the stacks,
10891 with it we copy the stacks and the new perl interpreter is
10892 ready to run at the exact same point as the previous one.
10893 The pseudo-fork code uses COPY_STACKS while the
10894 threads->new doesn't.
10896 CLONEf_KEEP_PTR_TABLE
10897 perl_clone keeps a ptr_table with the pointer of the old
10898 variable as a key and the new variable as a value,
10899 this allows it to check if something has been cloned and not
10900 clone it again but rather just use the value and increase the
10901 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10902 the ptr_table using the function
10903 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10904 reason to keep it around is if you want to dup some of your own
10905 variable who are outside the graph perl scans, example of this
10906 code is in threads.xs create
10909 This is a win32 thing, it is ignored on unix, it tells perls
10910 win32host code (which is c++) to clone itself, this is needed on
10911 win32 if you want to run two threads at the same time,
10912 if you just want to do some stuff in a separate perl interpreter
10913 and then throw it away and return to the original one,
10914 you don't need to do anything.
10919 /* XXX the above needs expanding by someone who actually understands it ! */
10920 EXTERN_C PerlInterpreter *
10921 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10924 perl_clone(PerlInterpreter *proto_perl, UV flags)
10926 #ifdef PERL_IMPLICIT_SYS
10928 /* perlhost.h so we need to call into it
10929 to clone the host, CPerlHost should have a c interface, sky */
10931 if (flags & CLONEf_CLONE_HOST) {
10932 return perl_clone_host(proto_perl,flags);
10934 return perl_clone_using(proto_perl, flags,
10936 proto_perl->IMemShared,
10937 proto_perl->IMemParse,
10939 proto_perl->IStdIO,
10943 proto_perl->IProc);
10947 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10948 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10949 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10950 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10951 struct IPerlDir* ipD, struct IPerlSock* ipS,
10952 struct IPerlProc* ipP)
10954 /* XXX many of the string copies here can be optimized if they're
10955 * constants; they need to be allocated as common memory and just
10956 * their pointers copied. */
10959 CLONE_PARAMS clone_params;
10960 CLONE_PARAMS* param = &clone_params;
10962 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10963 PERL_SET_THX(my_perl);
10966 Poison(my_perl, 1, PerlInterpreter);
10970 PL_savestack_ix = 0;
10971 PL_savestack_max = -1;
10973 PL_sig_pending = 0;
10974 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10975 # else /* !DEBUGGING */
10976 Zero(my_perl, 1, PerlInterpreter);
10977 # endif /* DEBUGGING */
10979 /* host pointers */
10981 PL_MemShared = ipMS;
10982 PL_MemParse = ipMP;
10989 #else /* !PERL_IMPLICIT_SYS */
10991 CLONE_PARAMS clone_params;
10992 CLONE_PARAMS* param = &clone_params;
10993 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10994 PERL_SET_THX(my_perl);
10999 Poison(my_perl, 1, PerlInterpreter);
11003 PL_savestack_ix = 0;
11004 PL_savestack_max = -1;
11006 PL_sig_pending = 0;
11007 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11008 # else /* !DEBUGGING */
11009 Zero(my_perl, 1, PerlInterpreter);
11010 # endif /* DEBUGGING */
11011 #endif /* PERL_IMPLICIT_SYS */
11012 param->flags = flags;
11013 param->proto_perl = proto_perl;
11016 PL_xiv_arenaroot = NULL;
11017 PL_xiv_root = NULL;
11018 PL_xnv_arenaroot = NULL;
11019 PL_xnv_root = NULL;
11020 PL_xrv_arenaroot = NULL;
11021 PL_xrv_root = NULL;
11022 PL_xpv_arenaroot = NULL;
11023 PL_xpv_root = NULL;
11024 PL_xpviv_arenaroot = NULL;
11025 PL_xpviv_root = NULL;
11026 PL_xpvnv_arenaroot = NULL;
11027 PL_xpvnv_root = NULL;
11028 PL_xpvcv_arenaroot = NULL;
11029 PL_xpvcv_root = NULL;
11030 PL_xpvav_arenaroot = NULL;
11031 PL_xpvav_root = NULL;
11032 PL_xpvhv_arenaroot = NULL;
11033 PL_xpvhv_root = NULL;
11034 PL_xpvmg_arenaroot = NULL;
11035 PL_xpvmg_root = NULL;
11036 PL_xpvlv_arenaroot = NULL;
11037 PL_xpvlv_root = NULL;
11038 PL_xpvbm_arenaroot = NULL;
11039 PL_xpvbm_root = NULL;
11040 PL_he_arenaroot = NULL;
11042 PL_nice_chunk = NULL;
11043 PL_nice_chunk_size = 0;
11045 PL_sv_objcount = 0;
11046 PL_sv_root = Nullsv;
11047 PL_sv_arenaroot = Nullsv;
11049 PL_debug = proto_perl->Idebug;
11051 #ifdef USE_REENTRANT_API
11052 /* XXX: things like -Dm will segfault here in perlio, but doing
11053 * PERL_SET_CONTEXT(proto_perl);
11054 * breaks too many other things
11056 Perl_reentrant_init(aTHX);
11059 /* create SV map for pointer relocation */
11060 PL_ptr_table = ptr_table_new();
11062 /* initialize these special pointers as early as possible */
11063 SvANY(&PL_sv_undef) = NULL;
11064 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11065 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11066 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11068 SvANY(&PL_sv_no) = new_XPVNV();
11069 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11070 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11071 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
11072 SvCUR(&PL_sv_no) = 0;
11073 SvLEN(&PL_sv_no) = 1;
11074 SvNVX(&PL_sv_no) = 0;
11075 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11077 SvANY(&PL_sv_yes) = new_XPVNV();
11078 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11079 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11080 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
11081 SvCUR(&PL_sv_yes) = 1;
11082 SvLEN(&PL_sv_yes) = 2;
11083 SvNVX(&PL_sv_yes) = 1;
11084 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11086 /* create (a non-shared!) shared string table */
11087 PL_strtab = newHV();
11088 HvSHAREKEYS_off(PL_strtab);
11089 hv_ksplit(PL_strtab, 512);
11090 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11092 PL_compiling = proto_perl->Icompiling;
11094 /* These two PVs will be free'd special way so must set them same way op.c does */
11095 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11096 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11098 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11099 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11101 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11102 if (!specialWARN(PL_compiling.cop_warnings))
11103 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11104 if (!specialCopIO(PL_compiling.cop_io))
11105 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11106 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11108 /* pseudo environmental stuff */
11109 PL_origargc = proto_perl->Iorigargc;
11110 PL_origargv = proto_perl->Iorigargv;
11112 param->stashes = newAV(); /* Setup array of objects to call clone on */
11114 #ifdef PERLIO_LAYERS
11115 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11116 PerlIO_clone(aTHX_ proto_perl, param);
11119 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11120 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11121 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11122 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11123 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11124 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11127 PL_minus_c = proto_perl->Iminus_c;
11128 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11129 PL_localpatches = proto_perl->Ilocalpatches;
11130 PL_splitstr = proto_perl->Isplitstr;
11131 PL_preprocess = proto_perl->Ipreprocess;
11132 PL_minus_n = proto_perl->Iminus_n;
11133 PL_minus_p = proto_perl->Iminus_p;
11134 PL_minus_l = proto_perl->Iminus_l;
11135 PL_minus_a = proto_perl->Iminus_a;
11136 PL_minus_F = proto_perl->Iminus_F;
11137 PL_doswitches = proto_perl->Idoswitches;
11138 PL_dowarn = proto_perl->Idowarn;
11139 PL_doextract = proto_perl->Idoextract;
11140 PL_sawampersand = proto_perl->Isawampersand;
11141 PL_unsafe = proto_perl->Iunsafe;
11142 PL_inplace = SAVEPV(proto_perl->Iinplace);
11143 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11144 PL_perldb = proto_perl->Iperldb;
11145 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11146 PL_exit_flags = proto_perl->Iexit_flags;
11148 /* magical thingies */
11149 /* XXX time(&PL_basetime) when asked for? */
11150 PL_basetime = proto_perl->Ibasetime;
11151 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11153 PL_maxsysfd = proto_perl->Imaxsysfd;
11154 PL_multiline = proto_perl->Imultiline;
11155 PL_statusvalue = proto_perl->Istatusvalue;
11157 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11159 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11161 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11162 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11163 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11165 /* Clone the regex array */
11166 PL_regex_padav = newAV();
11168 I32 len = av_len((AV*)proto_perl->Iregex_padav);
11169 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11170 av_push(PL_regex_padav,
11171 sv_dup_inc(regexen[0],param));
11172 for(i = 1; i <= len; i++) {
11173 if(SvREPADTMP(regexen[i])) {
11174 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11176 av_push(PL_regex_padav,
11178 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11179 SvIVX(regexen[i])), param)))
11184 PL_regex_pad = AvARRAY(PL_regex_padav);
11186 /* shortcuts to various I/O objects */
11187 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11188 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11189 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11190 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11191 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11192 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11194 /* shortcuts to regexp stuff */
11195 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11197 /* shortcuts to misc objects */
11198 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11200 /* shortcuts to debugging objects */
11201 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11202 PL_DBline = gv_dup(proto_perl->IDBline, param);
11203 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11204 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11205 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11206 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11207 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11208 PL_lineary = av_dup(proto_perl->Ilineary, param);
11209 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11211 /* symbol tables */
11212 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11213 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11214 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11215 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11216 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11218 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11219 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11220 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11221 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11222 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11223 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11225 PL_sub_generation = proto_perl->Isub_generation;
11227 /* funky return mechanisms */
11228 PL_forkprocess = proto_perl->Iforkprocess;
11230 /* subprocess state */
11231 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11233 /* internal state */
11234 PL_tainting = proto_perl->Itainting;
11235 PL_taint_warn = proto_perl->Itaint_warn;
11236 PL_maxo = proto_perl->Imaxo;
11237 if (proto_perl->Iop_mask)
11238 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11240 PL_op_mask = Nullch;
11241 /* PL_asserting = proto_perl->Iasserting; */
11243 /* current interpreter roots */
11244 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11245 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11246 PL_main_start = proto_perl->Imain_start;
11247 PL_eval_root = proto_perl->Ieval_root;
11248 PL_eval_start = proto_perl->Ieval_start;
11250 /* runtime control stuff */
11251 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11252 PL_copline = proto_perl->Icopline;
11254 PL_filemode = proto_perl->Ifilemode;
11255 PL_lastfd = proto_perl->Ilastfd;
11256 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11259 PL_gensym = proto_perl->Igensym;
11260 PL_preambled = proto_perl->Ipreambled;
11261 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11262 PL_laststatval = proto_perl->Ilaststatval;
11263 PL_laststype = proto_perl->Ilaststype;
11264 PL_mess_sv = Nullsv;
11266 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11267 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11269 /* interpreter atexit processing */
11270 PL_exitlistlen = proto_perl->Iexitlistlen;
11271 if (PL_exitlistlen) {
11272 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11273 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11276 PL_exitlist = (PerlExitListEntry*)NULL;
11277 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11278 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11279 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11281 PL_profiledata = NULL;
11282 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11283 /* PL_rsfp_filters entries have fake IoDIRP() */
11284 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11286 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11288 PAD_CLONE_VARS(proto_perl, param);
11290 #ifdef HAVE_INTERP_INTERN
11291 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11294 /* more statics moved here */
11295 PL_generation = proto_perl->Igeneration;
11296 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11298 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11299 PL_in_clean_all = proto_perl->Iin_clean_all;
11301 PL_uid = proto_perl->Iuid;
11302 PL_euid = proto_perl->Ieuid;
11303 PL_gid = proto_perl->Igid;
11304 PL_egid = proto_perl->Iegid;
11305 PL_nomemok = proto_perl->Inomemok;
11306 PL_an = proto_perl->Ian;
11307 PL_evalseq = proto_perl->Ievalseq;
11308 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11309 PL_origalen = proto_perl->Iorigalen;
11310 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11311 PL_osname = SAVEPV(proto_perl->Iosname);
11312 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11313 PL_sighandlerp = proto_perl->Isighandlerp;
11316 PL_runops = proto_perl->Irunops;
11318 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11321 PL_cshlen = proto_perl->Icshlen;
11322 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11325 PL_lex_state = proto_perl->Ilex_state;
11326 PL_lex_defer = proto_perl->Ilex_defer;
11327 PL_lex_expect = proto_perl->Ilex_expect;
11328 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11329 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11330 PL_lex_starts = proto_perl->Ilex_starts;
11331 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11332 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11333 PL_lex_op = proto_perl->Ilex_op;
11334 PL_lex_inpat = proto_perl->Ilex_inpat;
11335 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11336 PL_lex_brackets = proto_perl->Ilex_brackets;
11337 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11338 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11339 PL_lex_casemods = proto_perl->Ilex_casemods;
11340 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11341 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11343 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11344 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11345 PL_nexttoke = proto_perl->Inexttoke;
11347 /* XXX This is probably masking the deeper issue of why
11348 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11349 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11350 * (A little debugging with a watchpoint on it may help.)
11352 if (SvANY(proto_perl->Ilinestr)) {
11353 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11354 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11355 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11356 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11357 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11358 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11359 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11360 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11361 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11364 PL_linestr = NEWSV(65,79);
11365 sv_upgrade(PL_linestr,SVt_PVIV);
11366 sv_setpvn(PL_linestr,"",0);
11367 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11369 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11370 PL_pending_ident = proto_perl->Ipending_ident;
11371 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11373 PL_expect = proto_perl->Iexpect;
11375 PL_multi_start = proto_perl->Imulti_start;
11376 PL_multi_end = proto_perl->Imulti_end;
11377 PL_multi_open = proto_perl->Imulti_open;
11378 PL_multi_close = proto_perl->Imulti_close;
11380 PL_error_count = proto_perl->Ierror_count;
11381 PL_subline = proto_perl->Isubline;
11382 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11384 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11385 if (SvANY(proto_perl->Ilinestr)) {
11386 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11387 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11388 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11389 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11390 PL_last_lop_op = proto_perl->Ilast_lop_op;
11393 PL_last_uni = SvPVX(PL_linestr);
11394 PL_last_lop = SvPVX(PL_linestr);
11395 PL_last_lop_op = 0;
11397 PL_in_my = proto_perl->Iin_my;
11398 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11400 PL_cryptseen = proto_perl->Icryptseen;
11403 PL_hints = proto_perl->Ihints;
11405 PL_amagic_generation = proto_perl->Iamagic_generation;
11407 #ifdef USE_LOCALE_COLLATE
11408 PL_collation_ix = proto_perl->Icollation_ix;
11409 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11410 PL_collation_standard = proto_perl->Icollation_standard;
11411 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11412 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11413 #endif /* USE_LOCALE_COLLATE */
11415 #ifdef USE_LOCALE_NUMERIC
11416 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11417 PL_numeric_standard = proto_perl->Inumeric_standard;
11418 PL_numeric_local = proto_perl->Inumeric_local;
11419 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11420 #endif /* !USE_LOCALE_NUMERIC */
11422 /* utf8 character classes */
11423 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11424 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11425 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11426 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11427 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11428 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11429 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11430 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11431 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11432 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11433 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11434 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11435 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11436 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11437 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11438 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11439 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11440 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11441 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11442 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11444 /* Did the locale setup indicate UTF-8? */
11445 PL_utf8locale = proto_perl->Iutf8locale;
11446 /* Unicode features (see perlrun/-C) */
11447 PL_unicode = proto_perl->Iunicode;
11449 /* Pre-5.8 signals control */
11450 PL_signals = proto_perl->Isignals;
11452 /* times() ticks per second */
11453 PL_clocktick = proto_perl->Iclocktick;
11455 /* Recursion stopper for PerlIO_find_layer */
11456 PL_in_load_module = proto_perl->Iin_load_module;
11458 /* sort() routine */
11459 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11461 /* Not really needed/useful since the reenrant_retint is "volatile",
11462 * but do it for consistency's sake. */
11463 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11465 /* Hooks to shared SVs and locks. */
11466 PL_sharehook = proto_perl->Isharehook;
11467 PL_lockhook = proto_perl->Ilockhook;
11468 PL_unlockhook = proto_perl->Iunlockhook;
11469 PL_threadhook = proto_perl->Ithreadhook;
11471 PL_runops_std = proto_perl->Irunops_std;
11472 PL_runops_dbg = proto_perl->Irunops_dbg;
11474 #ifdef THREADS_HAVE_PIDS
11475 PL_ppid = proto_perl->Ippid;
11479 PL_last_swash_hv = Nullhv; /* reinits on demand */
11480 PL_last_swash_klen = 0;
11481 PL_last_swash_key[0]= '\0';
11482 PL_last_swash_tmps = (U8*)NULL;
11483 PL_last_swash_slen = 0;
11485 PL_glob_index = proto_perl->Iglob_index;
11486 PL_srand_called = proto_perl->Isrand_called;
11487 PL_hash_seed = proto_perl->Ihash_seed;
11488 PL_rehash_seed = proto_perl->Irehash_seed;
11489 PL_uudmap['M'] = 0; /* reinits on demand */
11490 PL_bitcount = Nullch; /* reinits on demand */
11492 if (proto_perl->Ipsig_pend) {
11493 Newz(0, PL_psig_pend, SIG_SIZE, int);
11496 PL_psig_pend = (int*)NULL;
11499 if (proto_perl->Ipsig_ptr) {
11500 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
11501 Newz(0, PL_psig_name, SIG_SIZE, SV*);
11502 for (i = 1; i < SIG_SIZE; i++) {
11503 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11504 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11508 PL_psig_ptr = (SV**)NULL;
11509 PL_psig_name = (SV**)NULL;
11512 /* thrdvar.h stuff */
11514 if (flags & CLONEf_COPY_STACKS) {
11515 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11516 PL_tmps_ix = proto_perl->Ttmps_ix;
11517 PL_tmps_max = proto_perl->Ttmps_max;
11518 PL_tmps_floor = proto_perl->Ttmps_floor;
11519 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
11521 while (i <= PL_tmps_ix) {
11522 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11526 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11527 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11528 Newz(54, PL_markstack, i, I32);
11529 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11530 - proto_perl->Tmarkstack);
11531 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11532 - proto_perl->Tmarkstack);
11533 Copy(proto_perl->Tmarkstack, PL_markstack,
11534 PL_markstack_ptr - PL_markstack + 1, I32);
11536 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11537 * NOTE: unlike the others! */
11538 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11539 PL_scopestack_max = proto_perl->Tscopestack_max;
11540 Newz(54, PL_scopestack, PL_scopestack_max, I32);
11541 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11543 /* next push_return() sets PL_retstack[PL_retstack_ix]
11544 * NOTE: unlike the others! */
11545 PL_retstack_ix = proto_perl->Tretstack_ix;
11546 PL_retstack_max = proto_perl->Tretstack_max;
11547 Newz(54, PL_retstack, PL_retstack_max, OP*);
11548 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
11550 /* NOTE: si_dup() looks at PL_markstack */
11551 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11553 /* PL_curstack = PL_curstackinfo->si_stack; */
11554 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11555 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11557 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11558 PL_stack_base = AvARRAY(PL_curstack);
11559 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11560 - proto_perl->Tstack_base);
11561 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11563 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11564 * NOTE: unlike the others! */
11565 PL_savestack_ix = proto_perl->Tsavestack_ix;
11566 PL_savestack_max = proto_perl->Tsavestack_max;
11567 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11568 PL_savestack = ss_dup(proto_perl, param);
11572 ENTER; /* perl_destruct() wants to LEAVE; */
11575 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11576 PL_top_env = &PL_start_env;
11578 PL_op = proto_perl->Top;
11581 PL_Xpv = (XPV*)NULL;
11582 PL_na = proto_perl->Tna;
11584 PL_statbuf = proto_perl->Tstatbuf;
11585 PL_statcache = proto_perl->Tstatcache;
11586 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11587 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11589 PL_timesbuf = proto_perl->Ttimesbuf;
11592 PL_tainted = proto_perl->Ttainted;
11593 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11594 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11595 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11596 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11597 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11598 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11599 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11600 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11601 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11603 PL_restartop = proto_perl->Trestartop;
11604 PL_in_eval = proto_perl->Tin_eval;
11605 PL_delaymagic = proto_perl->Tdelaymagic;
11606 PL_dirty = proto_perl->Tdirty;
11607 PL_localizing = proto_perl->Tlocalizing;
11609 #ifdef PERL_FLEXIBLE_EXCEPTIONS
11610 PL_protect = proto_perl->Tprotect;
11612 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11613 PL_hv_fetch_ent_mh = Nullhe;
11614 PL_modcount = proto_perl->Tmodcount;
11615 PL_lastgotoprobe = Nullop;
11616 PL_dumpindent = proto_perl->Tdumpindent;
11618 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11619 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11620 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11621 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11622 PL_sortcxix = proto_perl->Tsortcxix;
11623 PL_efloatbuf = Nullch; /* reinits on demand */
11624 PL_efloatsize = 0; /* reinits on demand */
11628 PL_screamfirst = NULL;
11629 PL_screamnext = NULL;
11630 PL_maxscream = -1; /* reinits on demand */
11631 PL_lastscream = Nullsv;
11633 PL_watchaddr = NULL;
11634 PL_watchok = Nullch;
11636 PL_regdummy = proto_perl->Tregdummy;
11637 PL_regprecomp = Nullch;
11640 PL_colorset = 0; /* reinits PL_colors[] */
11641 /*PL_colors[6] = {0,0,0,0,0,0};*/
11642 PL_reginput = Nullch;
11643 PL_regbol = Nullch;
11644 PL_regeol = Nullch;
11645 PL_regstartp = (I32*)NULL;
11646 PL_regendp = (I32*)NULL;
11647 PL_reglastparen = (U32*)NULL;
11648 PL_reglastcloseparen = (U32*)NULL;
11649 PL_regtill = Nullch;
11650 PL_reg_start_tmp = (char**)NULL;
11651 PL_reg_start_tmpl = 0;
11652 PL_regdata = (struct reg_data*)NULL;
11655 PL_reg_eval_set = 0;
11657 PL_regprogram = (regnode*)NULL;
11659 PL_regcc = (CURCUR*)NULL;
11660 PL_reg_call_cc = (struct re_cc_state*)NULL;
11661 PL_reg_re = (regexp*)NULL;
11662 PL_reg_ganch = Nullch;
11663 PL_reg_sv = Nullsv;
11664 PL_reg_match_utf8 = FALSE;
11665 PL_reg_magic = (MAGIC*)NULL;
11667 PL_reg_oldcurpm = (PMOP*)NULL;
11668 PL_reg_curpm = (PMOP*)NULL;
11669 PL_reg_oldsaved = Nullch;
11670 PL_reg_oldsavedlen = 0;
11671 #ifdef PERL_COPY_ON_WRITE
11674 PL_reg_maxiter = 0;
11675 PL_reg_leftiter = 0;
11676 PL_reg_poscache = Nullch;
11677 PL_reg_poscache_size= 0;
11679 /* RE engine - function pointers */
11680 PL_regcompp = proto_perl->Tregcompp;
11681 PL_regexecp = proto_perl->Tregexecp;
11682 PL_regint_start = proto_perl->Tregint_start;
11683 PL_regint_string = proto_perl->Tregint_string;
11684 PL_regfree = proto_perl->Tregfree;
11686 PL_reginterp_cnt = 0;
11687 PL_reg_starttry = 0;
11689 /* Pluggable optimizer */
11690 PL_peepp = proto_perl->Tpeepp;
11692 PL_stashcache = newHV();
11694 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11695 ptr_table_free(PL_ptr_table);
11696 PL_ptr_table = NULL;
11699 /* Call the ->CLONE method, if it exists, for each of the stashes
11700 identified by sv_dup() above.
11702 while(av_len(param->stashes) != -1) {
11703 HV* stash = (HV*) av_shift(param->stashes);
11704 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11705 if (cloner && GvCV(cloner)) {
11710 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
11712 call_sv((SV*)GvCV(cloner), G_DISCARD);
11718 SvREFCNT_dec(param->stashes);
11723 #endif /* USE_ITHREADS */
11726 =head1 Unicode Support
11728 =for apidoc sv_recode_to_utf8
11730 The encoding is assumed to be an Encode object, on entry the PV
11731 of the sv is assumed to be octets in that encoding, and the sv
11732 will be converted into Unicode (and UTF-8).
11734 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11735 is not a reference, nothing is done to the sv. If the encoding is not
11736 an C<Encode::XS> Encoding object, bad things will happen.
11737 (See F<lib/encoding.pm> and L<Encode>).
11739 The PV of the sv is returned.
11744 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11746 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11760 Passing sv_yes is wrong - it needs to be or'ed set of constants
11761 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11762 remove converted chars from source.
11764 Both will default the value - let them.
11766 XPUSHs(&PL_sv_yes);
11769 call_method("decode", G_SCALAR);
11773 s = SvPV(uni, len);
11774 if (s != SvPVX(sv)) {
11775 SvGROW(sv, len + 1);
11776 Move(s, SvPVX(sv), len, char);
11777 SvCUR_set(sv, len);
11778 SvPVX(sv)[len] = 0;
11788 =for apidoc sv_cat_decode
11790 The encoding is assumed to be an Encode object, the PV of the ssv is
11791 assumed to be octets in that encoding and decoding the input starts
11792 from the position which (PV + *offset) pointed to. The dsv will be
11793 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11794 when the string tstr appears in decoding output or the input ends on
11795 the PV of the ssv. The value which the offset points will be modified
11796 to the last input position on the ssv.
11798 Returns TRUE if the terminator was found, else returns FALSE.
11803 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11804 SV *ssv, int *offset, char *tstr, int tlen)
11807 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11818 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11819 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11821 call_method("cat_decode", G_SCALAR);
11823 ret = SvTRUE(TOPs);
11824 *offset = SvIV(offsv);
11830 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");