3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 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)));
420 =for apidoc sv_clean_objs
422 Attempt to destroy all objects not yet freed
428 Perl_sv_clean_objs(pTHX)
430 PL_in_clean_objs = TRUE;
431 visit(do_clean_objs);
432 #ifndef DISABLE_DESTRUCTOR_KLUDGE
433 /* some barnacles may yet remain, clinging to typeglobs */
434 visit(do_clean_named_objs);
436 PL_in_clean_objs = FALSE;
439 /* called by sv_clean_all() for each live SV */
442 do_clean_all(pTHX_ SV *sv)
444 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
445 SvFLAGS(sv) |= SVf_BREAK;
450 =for apidoc sv_clean_all
452 Decrement the refcnt of each remaining SV, possibly triggering a
453 cleanup. This function may have to be called multiple times to free
454 SVs which are in complex self-referential hierarchies.
460 Perl_sv_clean_all(pTHX)
463 PL_in_clean_all = TRUE;
464 cleaned = visit(do_clean_all);
465 PL_in_clean_all = FALSE;
470 =for apidoc sv_free_arenas
472 Deallocate the memory used by all arenas. Note that all the individual SV
473 heads and bodies within the arenas must already have been freed.
479 Perl_sv_free_arenas(pTHX)
483 XPV *arena, *arenanext;
485 /* Free arenas here, but be careful about fake ones. (We assume
486 contiguity of the fake ones with the corresponding real ones.) */
488 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
489 svanext = (SV*) SvANY(sva);
490 while (svanext && SvFAKE(svanext))
491 svanext = (SV*) SvANY(svanext);
494 Safefree((void *)sva);
497 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
498 arenanext = (XPV*)arena->xpv_pv;
501 PL_xiv_arenaroot = 0;
504 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
505 arenanext = (XPV*)arena->xpv_pv;
508 PL_xnv_arenaroot = 0;
511 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
512 arenanext = (XPV*)arena->xpv_pv;
515 PL_xrv_arenaroot = 0;
518 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
519 arenanext = (XPV*)arena->xpv_pv;
522 PL_xpv_arenaroot = 0;
525 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
526 arenanext = (XPV*)arena->xpv_pv;
529 PL_xpviv_arenaroot = 0;
532 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
533 arenanext = (XPV*)arena->xpv_pv;
536 PL_xpvnv_arenaroot = 0;
539 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
540 arenanext = (XPV*)arena->xpv_pv;
543 PL_xpvcv_arenaroot = 0;
546 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
547 arenanext = (XPV*)arena->xpv_pv;
550 PL_xpvav_arenaroot = 0;
553 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
554 arenanext = (XPV*)arena->xpv_pv;
557 PL_xpvhv_arenaroot = 0;
560 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
561 arenanext = (XPV*)arena->xpv_pv;
564 PL_xpvmg_arenaroot = 0;
567 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
568 arenanext = (XPV*)arena->xpv_pv;
571 PL_xpvlv_arenaroot = 0;
574 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
575 arenanext = (XPV*)arena->xpv_pv;
578 PL_xpvbm_arenaroot = 0;
581 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
582 arenanext = (XPV*)arena->xpv_pv;
589 Safefree(PL_nice_chunk);
590 PL_nice_chunk = Nullch;
591 PL_nice_chunk_size = 0;
597 =for apidoc report_uninit
599 Print appropriate "Use of uninitialized variable" warning
605 Perl_report_uninit(pTHX)
608 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
609 " in ", OP_DESC(PL_op));
611 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit, "", "");
614 /* grab a new IV body from the free list, allocating more if necessary */
625 * See comment in more_xiv() -- RAM.
627 PL_xiv_root = *(IV**)xiv;
629 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
632 /* return an IV body to the free list */
635 S_del_xiv(pTHX_ XPVIV *p)
637 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
639 *(IV**)xiv = PL_xiv_root;
644 /* allocate another arena's worth of IV bodies */
652 New(705, ptr, 1008/sizeof(XPV), XPV);
653 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
654 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
657 xivend = &xiv[1008 / sizeof(IV) - 1];
658 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
660 while (xiv < xivend) {
661 *(IV**)xiv = (IV *)(xiv + 1);
667 /* grab a new NV body from the free list, allocating more if necessary */
677 PL_xnv_root = *(NV**)xnv;
679 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
682 /* return an NV body to the free list */
685 S_del_xnv(pTHX_ XPVNV *p)
687 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
689 *(NV**)xnv = PL_xnv_root;
694 /* allocate another arena's worth of NV bodies */
702 New(711, ptr, 1008/sizeof(XPV), XPV);
703 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
704 PL_xnv_arenaroot = ptr;
707 xnvend = &xnv[1008 / sizeof(NV) - 1];
708 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
710 while (xnv < xnvend) {
711 *(NV**)xnv = (NV*)(xnv + 1);
717 /* grab a new struct xrv from the free list, allocating more if necessary */
727 PL_xrv_root = (XRV*)xrv->xrv_rv;
732 /* return a struct xrv to the free list */
735 S_del_xrv(pTHX_ XRV *p)
738 p->xrv_rv = (SV*)PL_xrv_root;
743 /* allocate another arena's worth of struct xrv */
749 register XRV* xrvend;
751 New(712, ptr, 1008/sizeof(XPV), XPV);
752 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
753 PL_xrv_arenaroot = ptr;
756 xrvend = &xrv[1008 / sizeof(XRV) - 1];
757 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
759 while (xrv < xrvend) {
760 xrv->xrv_rv = (SV*)(xrv + 1);
766 /* grab a new struct xpv from the free list, allocating more if necessary */
776 PL_xpv_root = (XPV*)xpv->xpv_pv;
781 /* return a struct xpv to the free list */
784 S_del_xpv(pTHX_ XPV *p)
787 p->xpv_pv = (char*)PL_xpv_root;
792 /* allocate another arena's worth of struct xpv */
798 register XPV* xpvend;
799 New(713, xpv, 1008/sizeof(XPV), XPV);
800 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
801 PL_xpv_arenaroot = xpv;
803 xpvend = &xpv[1008 / sizeof(XPV) - 1];
805 while (xpv < xpvend) {
806 xpv->xpv_pv = (char*)(xpv + 1);
812 /* grab a new struct xpviv from the free list, allocating more if necessary */
821 xpviv = PL_xpviv_root;
822 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
827 /* return a struct xpviv to the free list */
830 S_del_xpviv(pTHX_ XPVIV *p)
833 p->xpv_pv = (char*)PL_xpviv_root;
838 /* allocate another arena's worth of struct xpviv */
843 register XPVIV* xpviv;
844 register XPVIV* xpvivend;
845 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
846 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
847 PL_xpviv_arenaroot = xpviv;
849 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
850 PL_xpviv_root = ++xpviv;
851 while (xpviv < xpvivend) {
852 xpviv->xpv_pv = (char*)(xpviv + 1);
858 /* grab a new struct xpvnv from the free list, allocating more if necessary */
867 xpvnv = PL_xpvnv_root;
868 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
873 /* return a struct xpvnv to the free list */
876 S_del_xpvnv(pTHX_ XPVNV *p)
879 p->xpv_pv = (char*)PL_xpvnv_root;
884 /* allocate another arena's worth of struct xpvnv */
889 register XPVNV* xpvnv;
890 register XPVNV* xpvnvend;
891 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
892 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
893 PL_xpvnv_arenaroot = xpvnv;
895 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
896 PL_xpvnv_root = ++xpvnv;
897 while (xpvnv < xpvnvend) {
898 xpvnv->xpv_pv = (char*)(xpvnv + 1);
904 /* grab a new struct xpvcv from the free list, allocating more if necessary */
913 xpvcv = PL_xpvcv_root;
914 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
919 /* return a struct xpvcv to the free list */
922 S_del_xpvcv(pTHX_ XPVCV *p)
925 p->xpv_pv = (char*)PL_xpvcv_root;
930 /* allocate another arena's worth of struct xpvcv */
935 register XPVCV* xpvcv;
936 register XPVCV* xpvcvend;
937 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
938 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
939 PL_xpvcv_arenaroot = xpvcv;
941 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
942 PL_xpvcv_root = ++xpvcv;
943 while (xpvcv < xpvcvend) {
944 xpvcv->xpv_pv = (char*)(xpvcv + 1);
950 /* grab a new struct xpvav from the free list, allocating more if necessary */
959 xpvav = PL_xpvav_root;
960 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
965 /* return a struct xpvav to the free list */
968 S_del_xpvav(pTHX_ XPVAV *p)
971 p->xav_array = (char*)PL_xpvav_root;
976 /* allocate another arena's worth of struct xpvav */
981 register XPVAV* xpvav;
982 register XPVAV* xpvavend;
983 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
984 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
985 PL_xpvav_arenaroot = xpvav;
987 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
988 PL_xpvav_root = ++xpvav;
989 while (xpvav < xpvavend) {
990 xpvav->xav_array = (char*)(xpvav + 1);
993 xpvav->xav_array = 0;
996 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1005 xpvhv = PL_xpvhv_root;
1006 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
1011 /* return a struct xpvhv to the free list */
1014 S_del_xpvhv(pTHX_ XPVHV *p)
1017 p->xhv_array = (char*)PL_xpvhv_root;
1022 /* allocate another arena's worth of struct xpvhv */
1027 register XPVHV* xpvhv;
1028 register XPVHV* xpvhvend;
1029 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
1030 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1031 PL_xpvhv_arenaroot = xpvhv;
1033 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
1034 PL_xpvhv_root = ++xpvhv;
1035 while (xpvhv < xpvhvend) {
1036 xpvhv->xhv_array = (char*)(xpvhv + 1);
1039 xpvhv->xhv_array = 0;
1042 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1051 xpvmg = PL_xpvmg_root;
1052 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1057 /* return a struct xpvmg to the free list */
1060 S_del_xpvmg(pTHX_ XPVMG *p)
1063 p->xpv_pv = (char*)PL_xpvmg_root;
1068 /* allocate another arena's worth of struct xpvmg */
1073 register XPVMG* xpvmg;
1074 register XPVMG* xpvmgend;
1075 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1076 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1077 PL_xpvmg_arenaroot = xpvmg;
1079 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1080 PL_xpvmg_root = ++xpvmg;
1081 while (xpvmg < xpvmgend) {
1082 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1088 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1097 xpvlv = PL_xpvlv_root;
1098 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1103 /* return a struct xpvlv to the free list */
1106 S_del_xpvlv(pTHX_ XPVLV *p)
1109 p->xpv_pv = (char*)PL_xpvlv_root;
1114 /* allocate another arena's worth of struct xpvlv */
1119 register XPVLV* xpvlv;
1120 register XPVLV* xpvlvend;
1121 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1122 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1123 PL_xpvlv_arenaroot = xpvlv;
1125 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1126 PL_xpvlv_root = ++xpvlv;
1127 while (xpvlv < xpvlvend) {
1128 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1134 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1143 xpvbm = PL_xpvbm_root;
1144 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1149 /* return a struct xpvbm to the free list */
1152 S_del_xpvbm(pTHX_ XPVBM *p)
1155 p->xpv_pv = (char*)PL_xpvbm_root;
1160 /* allocate another arena's worth of struct xpvbm */
1165 register XPVBM* xpvbm;
1166 register XPVBM* xpvbmend;
1167 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1168 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1169 PL_xpvbm_arenaroot = xpvbm;
1171 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1172 PL_xpvbm_root = ++xpvbm;
1173 while (xpvbm < xpvbmend) {
1174 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1180 #define my_safemalloc(s) (void*)safemalloc(s)
1181 #define my_safefree(p) safefree((char*)p)
1185 #define new_XIV() my_safemalloc(sizeof(XPVIV))
1186 #define del_XIV(p) my_safefree(p)
1188 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1189 #define del_XNV(p) my_safefree(p)
1191 #define new_XRV() my_safemalloc(sizeof(XRV))
1192 #define del_XRV(p) my_safefree(p)
1194 #define new_XPV() my_safemalloc(sizeof(XPV))
1195 #define del_XPV(p) my_safefree(p)
1197 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1198 #define del_XPVIV(p) my_safefree(p)
1200 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1201 #define del_XPVNV(p) my_safefree(p)
1203 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1204 #define del_XPVCV(p) my_safefree(p)
1206 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1207 #define del_XPVAV(p) my_safefree(p)
1209 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1210 #define del_XPVHV(p) my_safefree(p)
1212 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1213 #define del_XPVMG(p) my_safefree(p)
1215 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1216 #define del_XPVLV(p) my_safefree(p)
1218 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1219 #define del_XPVBM(p) my_safefree(p)
1223 #define new_XIV() (void*)new_xiv()
1224 #define del_XIV(p) del_xiv((XPVIV*) p)
1226 #define new_XNV() (void*)new_xnv()
1227 #define del_XNV(p) del_xnv((XPVNV*) p)
1229 #define new_XRV() (void*)new_xrv()
1230 #define del_XRV(p) del_xrv((XRV*) p)
1232 #define new_XPV() (void*)new_xpv()
1233 #define del_XPV(p) del_xpv((XPV *)p)
1235 #define new_XPVIV() (void*)new_xpviv()
1236 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1238 #define new_XPVNV() (void*)new_xpvnv()
1239 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1241 #define new_XPVCV() (void*)new_xpvcv()
1242 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1244 #define new_XPVAV() (void*)new_xpvav()
1245 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1247 #define new_XPVHV() (void*)new_xpvhv()
1248 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1250 #define new_XPVMG() (void*)new_xpvmg()
1251 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1253 #define new_XPVLV() (void*)new_xpvlv()
1254 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1256 #define new_XPVBM() (void*)new_xpvbm()
1257 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1261 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1262 #define del_XPVGV(p) my_safefree(p)
1264 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1265 #define del_XPVFM(p) my_safefree(p)
1267 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1268 #define del_XPVIO(p) my_safefree(p)
1271 =for apidoc sv_upgrade
1273 Upgrade an SV to a more complex form. Generally adds a new body type to the
1274 SV, then copies across as much information as possible from the old body.
1275 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1281 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1288 MAGIC* magic = NULL;
1291 if (mt != SVt_PV && SvIsCOW(sv)) {
1292 sv_force_normal_flags(sv, 0);
1295 if (SvTYPE(sv) == mt)
1299 (void)SvOOK_off(sv);
1301 switch (SvTYPE(sv)) {
1322 else if (mt < SVt_PVIV)
1339 pv = (char*)SvRV(sv);
1359 else if (mt == SVt_NV)
1370 del_XPVIV(SvANY(sv));
1380 del_XPVNV(SvANY(sv));
1388 magic = SvMAGIC(sv);
1389 stash = SvSTASH(sv);
1390 del_XPVMG(SvANY(sv));
1393 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1398 Perl_croak(aTHX_ "Can't upgrade to undef");
1400 SvANY(sv) = new_XIV();
1404 SvANY(sv) = new_XNV();
1408 SvANY(sv) = new_XRV();
1412 SvANY(sv) = new_XPV();
1418 SvANY(sv) = new_XPVIV();
1428 SvANY(sv) = new_XPVNV();
1436 SvANY(sv) = new_XPVMG();
1442 SvMAGIC(sv) = magic;
1443 SvSTASH(sv) = stash;
1446 SvANY(sv) = new_XPVLV();
1452 SvMAGIC(sv) = magic;
1453 SvSTASH(sv) = stash;
1460 SvANY(sv) = new_XPVAV();
1468 SvMAGIC(sv) = magic;
1469 SvSTASH(sv) = stash;
1475 SvANY(sv) = new_XPVHV();
1481 HvTOTALKEYS(sv) = 0;
1482 HvPLACEHOLDERS(sv) = 0;
1483 SvMAGIC(sv) = magic;
1484 SvSTASH(sv) = stash;
1491 SvANY(sv) = new_XPVCV();
1492 Zero(SvANY(sv), 1, XPVCV);
1498 SvMAGIC(sv) = magic;
1499 SvSTASH(sv) = stash;
1502 SvANY(sv) = new_XPVGV();
1508 SvMAGIC(sv) = magic;
1509 SvSTASH(sv) = stash;
1517 SvANY(sv) = new_XPVBM();
1523 SvMAGIC(sv) = magic;
1524 SvSTASH(sv) = stash;
1530 SvANY(sv) = new_XPVFM();
1531 Zero(SvANY(sv), 1, XPVFM);
1537 SvMAGIC(sv) = magic;
1538 SvSTASH(sv) = stash;
1541 SvANY(sv) = new_XPVIO();
1542 Zero(SvANY(sv), 1, XPVIO);
1548 SvMAGIC(sv) = magic;
1549 SvSTASH(sv) = stash;
1550 IoPAGE_LEN(sv) = 60;
1553 SvFLAGS(sv) &= ~SVTYPEMASK;
1559 =for apidoc sv_backoff
1561 Remove any string offset. You should normally use the C<SvOOK_off> macro
1568 Perl_sv_backoff(pTHX_ register SV *sv)
1572 char *s = SvPVX(sv);
1573 SvLEN(sv) += SvIVX(sv);
1574 SvPVX(sv) -= SvIVX(sv);
1576 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1578 SvFLAGS(sv) &= ~SVf_OOK;
1585 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1586 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1587 Use the C<SvGROW> wrapper instead.
1593 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1597 #ifdef HAS_64K_LIMIT
1598 if (newlen >= 0x10000) {
1599 PerlIO_printf(Perl_debug_log,
1600 "Allocation too large: %"UVxf"\n", (UV)newlen);
1603 #endif /* HAS_64K_LIMIT */
1606 if (SvTYPE(sv) < SVt_PV) {
1607 sv_upgrade(sv, SVt_PV);
1610 else if (SvOOK(sv)) { /* pv is offset? */
1613 if (newlen > SvLEN(sv))
1614 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1615 #ifdef HAS_64K_LIMIT
1616 if (newlen >= 0x10000)
1623 if (newlen > SvLEN(sv)) { /* need more room? */
1624 if (SvLEN(sv) && s) {
1626 STRLEN l = malloced_size((void*)SvPVX(sv));
1632 Renew(s,newlen,char);
1635 New(703, s, newlen, char);
1636 if (SvPVX(sv) && SvCUR(sv)) {
1637 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1641 SvLEN_set(sv, newlen);
1647 =for apidoc sv_setiv
1649 Copies an integer into the given SV, upgrading first if necessary.
1650 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1656 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1658 SV_CHECK_THINKFIRST_COW_DROP(sv);
1659 switch (SvTYPE(sv)) {
1661 sv_upgrade(sv, SVt_IV);
1664 sv_upgrade(sv, SVt_PVNV);
1668 sv_upgrade(sv, SVt_PVIV);
1677 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1680 (void)SvIOK_only(sv); /* validate number */
1686 =for apidoc sv_setiv_mg
1688 Like C<sv_setiv>, but also handles 'set' magic.
1694 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1701 =for apidoc sv_setuv
1703 Copies an unsigned integer into the given SV, upgrading first if necessary.
1704 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1710 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1712 /* With these two if statements:
1713 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1716 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1718 If you wish to remove them, please benchmark to see what the effect is
1720 if (u <= (UV)IV_MAX) {
1721 sv_setiv(sv, (IV)u);
1730 =for apidoc sv_setuv_mg
1732 Like C<sv_setuv>, but also handles 'set' magic.
1738 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1740 /* With these two if statements:
1741 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1744 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1746 If you wish to remove them, please benchmark to see what the effect is
1748 if (u <= (UV)IV_MAX) {
1749 sv_setiv(sv, (IV)u);
1759 =for apidoc sv_setnv
1761 Copies a double into the given SV, upgrading first if necessary.
1762 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1768 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1770 SV_CHECK_THINKFIRST_COW_DROP(sv);
1771 switch (SvTYPE(sv)) {
1774 sv_upgrade(sv, SVt_NV);
1779 sv_upgrade(sv, SVt_PVNV);
1788 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1792 (void)SvNOK_only(sv); /* validate number */
1797 =for apidoc sv_setnv_mg
1799 Like C<sv_setnv>, but also handles 'set' magic.
1805 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1811 /* Print an "isn't numeric" warning, using a cleaned-up,
1812 * printable version of the offending string
1816 S_not_a_number(pTHX_ SV *sv)
1823 dsv = sv_2mortal(newSVpv("", 0));
1824 pv = sv_uni_display(dsv, sv, 10, 0);
1827 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1828 /* each *s can expand to 4 chars + "...\0",
1829 i.e. need room for 8 chars */
1832 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
1834 if (ch & 128 && !isPRINT_LC(ch)) {
1843 else if (ch == '\r') {
1847 else if (ch == '\f') {
1851 else if (ch == '\\') {
1855 else if (ch == '\0') {
1859 else if (isPRINT_LC(ch))
1876 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1877 "Argument \"%s\" isn't numeric in %s", pv,
1880 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1881 "Argument \"%s\" isn't numeric", pv);
1885 =for apidoc looks_like_number
1887 Test if the content of an SV looks like a number (or is a number).
1888 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1889 non-numeric warning), even if your atof() doesn't grok them.
1895 Perl_looks_like_number(pTHX_ SV *sv)
1897 register char *sbegin;
1904 else if (SvPOKp(sv))
1905 sbegin = SvPV(sv, len);
1907 return 1; /* Historic. Wrong? */
1908 return grok_number(sbegin, len, NULL);
1911 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1912 until proven guilty, assume that things are not that bad... */
1917 As 64 bit platforms often have an NV that doesn't preserve all bits of
1918 an IV (an assumption perl has been based on to date) it becomes necessary
1919 to remove the assumption that the NV always carries enough precision to
1920 recreate the IV whenever needed, and that the NV is the canonical form.
1921 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1922 precision as a side effect of conversion (which would lead to insanity
1923 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1924 1) to distinguish between IV/UV/NV slots that have cached a valid
1925 conversion where precision was lost and IV/UV/NV slots that have a
1926 valid conversion which has lost no precision
1927 2) to ensure that if a numeric conversion to one form is requested that
1928 would lose precision, the precise conversion (or differently
1929 imprecise conversion) is also performed and cached, to prevent
1930 requests for different numeric formats on the same SV causing
1931 lossy conversion chains. (lossless conversion chains are perfectly
1936 SvIOKp is true if the IV slot contains a valid value
1937 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1938 SvNOKp is true if the NV slot contains a valid value
1939 SvNOK is true only if the NV value is accurate
1942 while converting from PV to NV, check to see if converting that NV to an
1943 IV(or UV) would lose accuracy over a direct conversion from PV to
1944 IV(or UV). If it would, cache both conversions, return NV, but mark
1945 SV as IOK NOKp (ie not NOK).
1947 While converting from PV to IV, check to see if converting that IV to an
1948 NV would lose accuracy over a direct conversion from PV to NV. If it
1949 would, cache both conversions, flag similarly.
1951 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1952 correctly because if IV & NV were set NV *always* overruled.
1953 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1954 changes - now IV and NV together means that the two are interchangeable:
1955 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1957 The benefit of this is that operations such as pp_add know that if
1958 SvIOK is true for both left and right operands, then integer addition
1959 can be used instead of floating point (for cases where the result won't
1960 overflow). Before, floating point was always used, which could lead to
1961 loss of precision compared with integer addition.
1963 * making IV and NV equal status should make maths accurate on 64 bit
1965 * may speed up maths somewhat if pp_add and friends start to use
1966 integers when possible instead of fp. (Hopefully the overhead in
1967 looking for SvIOK and checking for overflow will not outweigh the
1968 fp to integer speedup)
1969 * will slow down integer operations (callers of SvIV) on "inaccurate"
1970 values, as the change from SvIOK to SvIOKp will cause a call into
1971 sv_2iv each time rather than a macro access direct to the IV slot
1972 * should speed up number->string conversion on integers as IV is
1973 favoured when IV and NV are equally accurate
1975 ####################################################################
1976 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1977 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1978 On the other hand, SvUOK is true iff UV.
1979 ####################################################################
1981 Your mileage will vary depending your CPU's relative fp to integer
1985 #ifndef NV_PRESERVES_UV
1986 # define IS_NUMBER_UNDERFLOW_IV 1
1987 # define IS_NUMBER_UNDERFLOW_UV 2
1988 # define IS_NUMBER_IV_AND_UV 2
1989 # define IS_NUMBER_OVERFLOW_IV 4
1990 # define IS_NUMBER_OVERFLOW_UV 5
1992 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1994 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1996 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1998 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));
1999 if (SvNVX(sv) < (NV)IV_MIN) {
2000 (void)SvIOKp_on(sv);
2003 return IS_NUMBER_UNDERFLOW_IV;
2005 if (SvNVX(sv) > (NV)UV_MAX) {
2006 (void)SvIOKp_on(sv);
2010 return IS_NUMBER_OVERFLOW_UV;
2012 (void)SvIOKp_on(sv);
2014 /* Can't use strtol etc to convert this string. (See truth table in
2016 if (SvNVX(sv) <= (UV)IV_MAX) {
2017 SvIVX(sv) = I_V(SvNVX(sv));
2018 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2019 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2021 /* Integer is imprecise. NOK, IOKp */
2023 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2026 SvUVX(sv) = U_V(SvNVX(sv));
2027 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2028 if (SvUVX(sv) == UV_MAX) {
2029 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2030 possibly be preserved by NV. Hence, it must be overflow.
2032 return IS_NUMBER_OVERFLOW_UV;
2034 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2036 /* Integer is imprecise. NOK, IOKp */
2038 return IS_NUMBER_OVERFLOW_IV;
2040 #endif /* !NV_PRESERVES_UV*/
2045 Return the integer value of an SV, doing any necessary string conversion,
2046 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2052 Perl_sv_2iv(pTHX_ register SV *sv)
2056 if (SvGMAGICAL(sv)) {
2061 return I_V(SvNVX(sv));
2063 if (SvPOKp(sv) && SvLEN(sv))
2066 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2067 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2073 if (SvTHINKFIRST(sv)) {
2076 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2077 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2078 return SvIV(tmpstr);
2079 return PTR2IV(SvRV(sv));
2082 sv_force_normal_flags(sv, 0);
2084 if (SvREADONLY(sv) && !SvOK(sv)) {
2085 if (ckWARN(WARN_UNINITIALIZED))
2092 return (IV)(SvUVX(sv));
2099 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2100 * without also getting a cached IV/UV from it at the same time
2101 * (ie PV->NV conversion should detect loss of accuracy and cache
2102 * IV or UV at same time to avoid this. NWC */
2104 if (SvTYPE(sv) == SVt_NV)
2105 sv_upgrade(sv, SVt_PVNV);
2107 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2108 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2109 certainly cast into the IV range at IV_MAX, whereas the correct
2110 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2112 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2113 SvIVX(sv) = I_V(SvNVX(sv));
2114 if (SvNVX(sv) == (NV) SvIVX(sv)
2115 #ifndef NV_PRESERVES_UV
2116 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2117 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2118 /* Don't flag it as "accurately an integer" if the number
2119 came from a (by definition imprecise) NV operation, and
2120 we're outside the range of NV integer precision */
2123 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2124 DEBUG_c(PerlIO_printf(Perl_debug_log,
2125 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2131 /* IV not precise. No need to convert from PV, as NV
2132 conversion would already have cached IV if it detected
2133 that PV->IV would be better than PV->NV->IV
2134 flags already correct - don't set public IOK. */
2135 DEBUG_c(PerlIO_printf(Perl_debug_log,
2136 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2141 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2142 but the cast (NV)IV_MIN rounds to a the value less (more
2143 negative) than IV_MIN which happens to be equal to SvNVX ??
2144 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2145 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2146 (NV)UVX == NVX are both true, but the values differ. :-(
2147 Hopefully for 2s complement IV_MIN is something like
2148 0x8000000000000000 which will be exact. NWC */
2151 SvUVX(sv) = U_V(SvNVX(sv));
2153 (SvNVX(sv) == (NV) SvUVX(sv))
2154 #ifndef NV_PRESERVES_UV
2155 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2156 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2157 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2158 /* Don't flag it as "accurately an integer" if the number
2159 came from a (by definition imprecise) NV operation, and
2160 we're outside the range of NV integer precision */
2166 DEBUG_c(PerlIO_printf(Perl_debug_log,
2167 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2171 return (IV)SvUVX(sv);
2174 else if (SvPOKp(sv) && SvLEN(sv)) {
2176 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2177 /* We want to avoid a possible problem when we cache an IV which
2178 may be later translated to an NV, and the resulting NV is not
2179 the same as the direct translation of the initial string
2180 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2181 be careful to ensure that the value with the .456 is around if the
2182 NV value is requested in the future).
2184 This means that if we cache such an IV, we need to cache the
2185 NV as well. Moreover, we trade speed for space, and do not
2186 cache the NV if we are sure it's not needed.
2189 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2190 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2191 == IS_NUMBER_IN_UV) {
2192 /* It's definitely an integer, only upgrade to PVIV */
2193 if (SvTYPE(sv) < SVt_PVIV)
2194 sv_upgrade(sv, SVt_PVIV);
2196 } else if (SvTYPE(sv) < SVt_PVNV)
2197 sv_upgrade(sv, SVt_PVNV);
2199 /* If NV preserves UV then we only use the UV value if we know that
2200 we aren't going to call atof() below. If NVs don't preserve UVs
2201 then the value returned may have more precision than atof() will
2202 return, even though value isn't perfectly accurate. */
2203 if ((numtype & (IS_NUMBER_IN_UV
2204 #ifdef NV_PRESERVES_UV
2207 )) == IS_NUMBER_IN_UV) {
2208 /* This won't turn off the public IOK flag if it was set above */
2209 (void)SvIOKp_on(sv);
2211 if (!(numtype & IS_NUMBER_NEG)) {
2213 if (value <= (UV)IV_MAX) {
2214 SvIVX(sv) = (IV)value;
2220 /* 2s complement assumption */
2221 if (value <= (UV)IV_MIN) {
2222 SvIVX(sv) = -(IV)value;
2224 /* Too negative for an IV. This is a double upgrade, but
2225 I'm assuming it will be rare. */
2226 if (SvTYPE(sv) < SVt_PVNV)
2227 sv_upgrade(sv, SVt_PVNV);
2231 SvNVX(sv) = -(NV)value;
2236 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2237 will be in the previous block to set the IV slot, and the next
2238 block to set the NV slot. So no else here. */
2240 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2241 != IS_NUMBER_IN_UV) {
2242 /* It wasn't an (integer that doesn't overflow the UV). */
2243 SvNVX(sv) = Atof(SvPVX(sv));
2245 if (! numtype && ckWARN(WARN_NUMERIC))
2248 #if defined(USE_LONG_DOUBLE)
2249 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2250 PTR2UV(sv), SvNVX(sv)));
2252 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2253 PTR2UV(sv), SvNVX(sv)));
2257 #ifdef NV_PRESERVES_UV
2258 (void)SvIOKp_on(sv);
2260 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2261 SvIVX(sv) = I_V(SvNVX(sv));
2262 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2265 /* Integer is imprecise. NOK, IOKp */
2267 /* UV will not work better than IV */
2269 if (SvNVX(sv) > (NV)UV_MAX) {
2271 /* Integer is inaccurate. NOK, IOKp, is UV */
2275 SvUVX(sv) = U_V(SvNVX(sv));
2276 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2277 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2281 /* Integer is imprecise. NOK, IOKp, is UV */
2287 #else /* NV_PRESERVES_UV */
2288 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2289 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2290 /* The IV slot will have been set from value returned by
2291 grok_number above. The NV slot has just been set using
2294 assert (SvIOKp(sv));
2296 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2297 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2298 /* Small enough to preserve all bits. */
2299 (void)SvIOKp_on(sv);
2301 SvIVX(sv) = I_V(SvNVX(sv));
2302 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2304 /* Assumption: first non-preserved integer is < IV_MAX,
2305 this NV is in the preserved range, therefore: */
2306 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2308 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);
2312 0 0 already failed to read UV.
2313 0 1 already failed to read UV.
2314 1 0 you won't get here in this case. IV/UV
2315 slot set, public IOK, Atof() unneeded.
2316 1 1 already read UV.
2317 so there's no point in sv_2iuv_non_preserve() attempting
2318 to use atol, strtol, strtoul etc. */
2319 if (sv_2iuv_non_preserve (sv, numtype)
2320 >= IS_NUMBER_OVERFLOW_IV)
2324 #endif /* NV_PRESERVES_UV */
2327 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2329 if (SvTYPE(sv) < SVt_IV)
2330 /* Typically the caller expects that sv_any is not NULL now. */
2331 sv_upgrade(sv, SVt_IV);
2334 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2335 PTR2UV(sv),SvIVX(sv)));
2336 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2342 Return the unsigned integer value of an SV, doing any necessary string
2343 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
2350 Perl_sv_2uv(pTHX_ register SV *sv)
2354 if (SvGMAGICAL(sv)) {
2359 return U_V(SvNVX(sv));
2360 if (SvPOKp(sv) && SvLEN(sv))
2363 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2364 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2370 if (SvTHINKFIRST(sv)) {
2373 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2374 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2375 return SvUV(tmpstr);
2376 return PTR2UV(SvRV(sv));
2379 sv_force_normal_flags(sv, 0);
2381 if (SvREADONLY(sv) && !SvOK(sv)) {
2382 if (ckWARN(WARN_UNINITIALIZED))
2392 return (UV)SvIVX(sv);
2396 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2397 * without also getting a cached IV/UV from it at the same time
2398 * (ie PV->NV conversion should detect loss of accuracy and cache
2399 * IV or UV at same time to avoid this. */
2400 /* IV-over-UV optimisation - choose to cache IV if possible */
2402 if (SvTYPE(sv) == SVt_NV)
2403 sv_upgrade(sv, SVt_PVNV);
2405 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2406 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2407 SvIVX(sv) = I_V(SvNVX(sv));
2408 if (SvNVX(sv) == (NV) SvIVX(sv)
2409 #ifndef NV_PRESERVES_UV
2410 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2411 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2412 /* Don't flag it as "accurately an integer" if the number
2413 came from a (by definition imprecise) NV operation, and
2414 we're outside the range of NV integer precision */
2417 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2418 DEBUG_c(PerlIO_printf(Perl_debug_log,
2419 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2425 /* IV not precise. No need to convert from PV, as NV
2426 conversion would already have cached IV if it detected
2427 that PV->IV would be better than PV->NV->IV
2428 flags already correct - don't set public IOK. */
2429 DEBUG_c(PerlIO_printf(Perl_debug_log,
2430 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2435 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2436 but the cast (NV)IV_MIN rounds to a the value less (more
2437 negative) than IV_MIN which happens to be equal to SvNVX ??
2438 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2439 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2440 (NV)UVX == NVX are both true, but the values differ. :-(
2441 Hopefully for 2s complement IV_MIN is something like
2442 0x8000000000000000 which will be exact. NWC */
2445 SvUVX(sv) = U_V(SvNVX(sv));
2447 (SvNVX(sv) == (NV) SvUVX(sv))
2448 #ifndef NV_PRESERVES_UV
2449 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2450 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2451 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2452 /* Don't flag it as "accurately an integer" if the number
2453 came from a (by definition imprecise) NV operation, and
2454 we're outside the range of NV integer precision */
2459 DEBUG_c(PerlIO_printf(Perl_debug_log,
2460 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2466 else if (SvPOKp(sv) && SvLEN(sv)) {
2468 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2470 /* We want to avoid a possible problem when we cache a UV which
2471 may be later translated to an NV, and the resulting NV is not
2472 the translation of the initial data.
2474 This means that if we cache such a UV, we need to cache the
2475 NV as well. Moreover, we trade speed for space, and do not
2476 cache the NV if not needed.
2479 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2480 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2481 == IS_NUMBER_IN_UV) {
2482 /* It's definitely an integer, only upgrade to PVIV */
2483 if (SvTYPE(sv) < SVt_PVIV)
2484 sv_upgrade(sv, SVt_PVIV);
2486 } else if (SvTYPE(sv) < SVt_PVNV)
2487 sv_upgrade(sv, SVt_PVNV);
2489 /* If NV preserves UV then we only use the UV value if we know that
2490 we aren't going to call atof() below. If NVs don't preserve UVs
2491 then the value returned may have more precision than atof() will
2492 return, even though it isn't accurate. */
2493 if ((numtype & (IS_NUMBER_IN_UV
2494 #ifdef NV_PRESERVES_UV
2497 )) == IS_NUMBER_IN_UV) {
2498 /* This won't turn off the public IOK flag if it was set above */
2499 (void)SvIOKp_on(sv);
2501 if (!(numtype & IS_NUMBER_NEG)) {
2503 if (value <= (UV)IV_MAX) {
2504 SvIVX(sv) = (IV)value;
2506 /* it didn't overflow, and it was positive. */
2511 /* 2s complement assumption */
2512 if (value <= (UV)IV_MIN) {
2513 SvIVX(sv) = -(IV)value;
2515 /* Too negative for an IV. This is a double upgrade, but
2516 I'm assuming it will be rare. */
2517 if (SvTYPE(sv) < SVt_PVNV)
2518 sv_upgrade(sv, SVt_PVNV);
2522 SvNVX(sv) = -(NV)value;
2528 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2529 != IS_NUMBER_IN_UV) {
2530 /* It wasn't an integer, or it overflowed the UV. */
2531 SvNVX(sv) = Atof(SvPVX(sv));
2533 if (! numtype && ckWARN(WARN_NUMERIC))
2536 #if defined(USE_LONG_DOUBLE)
2537 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2538 PTR2UV(sv), SvNVX(sv)));
2540 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2541 PTR2UV(sv), SvNVX(sv)));
2544 #ifdef NV_PRESERVES_UV
2545 (void)SvIOKp_on(sv);
2547 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2548 SvIVX(sv) = I_V(SvNVX(sv));
2549 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2552 /* Integer is imprecise. NOK, IOKp */
2554 /* UV will not work better than IV */
2556 if (SvNVX(sv) > (NV)UV_MAX) {
2558 /* Integer is inaccurate. NOK, IOKp, is UV */
2562 SvUVX(sv) = U_V(SvNVX(sv));
2563 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2564 NV preservse UV so can do correct comparison. */
2565 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2569 /* Integer is imprecise. NOK, IOKp, is UV */
2574 #else /* NV_PRESERVES_UV */
2575 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2576 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2577 /* The UV slot will have been set from value returned by
2578 grok_number above. The NV slot has just been set using
2581 assert (SvIOKp(sv));
2583 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2584 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2585 /* Small enough to preserve all bits. */
2586 (void)SvIOKp_on(sv);
2588 SvIVX(sv) = I_V(SvNVX(sv));
2589 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2591 /* Assumption: first non-preserved integer is < IV_MAX,
2592 this NV is in the preserved range, therefore: */
2593 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2595 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);
2598 sv_2iuv_non_preserve (sv, numtype);
2600 #endif /* NV_PRESERVES_UV */
2604 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2605 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2608 if (SvTYPE(sv) < SVt_IV)
2609 /* Typically the caller expects that sv_any is not NULL now. */
2610 sv_upgrade(sv, SVt_IV);
2614 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2615 PTR2UV(sv),SvUVX(sv)));
2616 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2622 Return the num value of an SV, doing any necessary string or integer
2623 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2630 Perl_sv_2nv(pTHX_ register SV *sv)
2634 if (SvGMAGICAL(sv)) {
2638 if (SvPOKp(sv) && SvLEN(sv)) {
2639 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2640 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
2642 return Atof(SvPVX(sv));
2646 return (NV)SvUVX(sv);
2648 return (NV)SvIVX(sv);
2651 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2652 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2658 if (SvTHINKFIRST(sv)) {
2661 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2662 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2663 return SvNV(tmpstr);
2664 return PTR2NV(SvRV(sv));
2667 sv_force_normal_flags(sv, 0);
2669 if (SvREADONLY(sv) && !SvOK(sv)) {
2670 if (ckWARN(WARN_UNINITIALIZED))
2675 if (SvTYPE(sv) < SVt_NV) {
2676 if (SvTYPE(sv) == SVt_IV)
2677 sv_upgrade(sv, SVt_PVNV);
2679 sv_upgrade(sv, SVt_NV);
2680 #ifdef USE_LONG_DOUBLE
2682 STORE_NUMERIC_LOCAL_SET_STANDARD();
2683 PerlIO_printf(Perl_debug_log,
2684 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2685 PTR2UV(sv), SvNVX(sv));
2686 RESTORE_NUMERIC_LOCAL();
2690 STORE_NUMERIC_LOCAL_SET_STANDARD();
2691 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2692 PTR2UV(sv), SvNVX(sv));
2693 RESTORE_NUMERIC_LOCAL();
2697 else if (SvTYPE(sv) < SVt_PVNV)
2698 sv_upgrade(sv, SVt_PVNV);
2703 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
2704 #ifdef NV_PRESERVES_UV
2707 /* Only set the public NV OK flag if this NV preserves the IV */
2708 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2709 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2710 : (SvIVX(sv) == I_V(SvNVX(sv))))
2716 else if (SvPOKp(sv) && SvLEN(sv)) {
2718 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2719 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2721 #ifdef NV_PRESERVES_UV
2722 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2723 == IS_NUMBER_IN_UV) {
2724 /* It's definitely an integer */
2725 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
2727 SvNVX(sv) = Atof(SvPVX(sv));
2730 SvNVX(sv) = Atof(SvPVX(sv));
2731 /* Only set the public NV OK flag if this NV preserves the value in
2732 the PV at least as well as an IV/UV would.
2733 Not sure how to do this 100% reliably. */
2734 /* if that shift count is out of range then Configure's test is
2735 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2737 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2738 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2739 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2740 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2741 /* Can't use strtol etc to convert this string, so don't try.
2742 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2745 /* value has been set. It may not be precise. */
2746 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2747 /* 2s complement assumption for (UV)IV_MIN */
2748 SvNOK_on(sv); /* Integer is too negative. */
2753 if (numtype & IS_NUMBER_NEG) {
2754 SvIVX(sv) = -(IV)value;
2755 } else if (value <= (UV)IV_MAX) {
2756 SvIVX(sv) = (IV)value;
2762 if (numtype & IS_NUMBER_NOT_INT) {
2763 /* I believe that even if the original PV had decimals,
2764 they are lost beyond the limit of the FP precision.
2765 However, neither is canonical, so both only get p
2766 flags. NWC, 2000/11/25 */
2767 /* Both already have p flags, so do nothing */
2770 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2771 if (SvIVX(sv) == I_V(nv)) {
2776 /* It had no "." so it must be integer. */
2779 /* between IV_MAX and NV(UV_MAX).
2780 Could be slightly > UV_MAX */
2782 if (numtype & IS_NUMBER_NOT_INT) {
2783 /* UV and NV both imprecise. */
2785 UV nv_as_uv = U_V(nv);
2787 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2798 #endif /* NV_PRESERVES_UV */
2801 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2803 if (SvTYPE(sv) < SVt_NV)
2804 /* Typically the caller expects that sv_any is not NULL now. */
2805 /* XXX Ilya implies that this is a bug in callers that assume this
2806 and ideally should be fixed. */
2807 sv_upgrade(sv, SVt_NV);
2810 #if defined(USE_LONG_DOUBLE)
2812 STORE_NUMERIC_LOCAL_SET_STANDARD();
2813 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2814 PTR2UV(sv), SvNVX(sv));
2815 RESTORE_NUMERIC_LOCAL();
2819 STORE_NUMERIC_LOCAL_SET_STANDARD();
2820 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2821 PTR2UV(sv), SvNVX(sv));
2822 RESTORE_NUMERIC_LOCAL();
2828 /* asIV(): extract an integer from the string value of an SV.
2829 * Caller must validate PVX */
2832 S_asIV(pTHX_ SV *sv)
2835 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2837 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2838 == IS_NUMBER_IN_UV) {
2839 /* It's definitely an integer */
2840 if (numtype & IS_NUMBER_NEG) {
2841 if (value < (UV)IV_MIN)
2844 if (value < (UV)IV_MAX)
2849 if (ckWARN(WARN_NUMERIC))
2852 return I_V(Atof(SvPVX(sv)));
2855 /* asUV(): extract an unsigned integer from the string value of an SV
2856 * Caller must validate PVX */
2859 S_asUV(pTHX_ SV *sv)
2862 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2864 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2865 == IS_NUMBER_IN_UV) {
2866 /* It's definitely an integer */
2867 if (!(numtype & IS_NUMBER_NEG))
2871 if (ckWARN(WARN_NUMERIC))
2874 return U_V(Atof(SvPVX(sv)));
2878 =for apidoc sv_2pv_nolen
2880 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2881 use the macro wrapper C<SvPV_nolen(sv)> instead.
2886 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2889 return sv_2pv(sv, &n_a);
2892 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2893 * UV as a string towards the end of buf, and return pointers to start and
2896 * We assume that buf is at least TYPE_CHARS(UV) long.
2900 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2902 char *ptr = buf + TYPE_CHARS(UV);
2916 *--ptr = '0' + (char)(uv % 10);
2924 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2925 * this function provided for binary compatibility only
2929 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2931 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2935 =for apidoc sv_2pv_flags
2937 Returns a pointer to the string value of an SV, and sets *lp to its length.
2938 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2940 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2941 usually end up here too.
2947 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2952 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2953 char *tmpbuf = tbuf;
2959 if (SvGMAGICAL(sv)) {
2960 if (flags & SV_GMAGIC)
2968 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2970 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2975 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2980 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2981 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2988 if (SvTHINKFIRST(sv)) {
2991 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2992 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2993 char *pv = SvPV(tmpstr, *lp);
3007 switch (SvTYPE(sv)) {
3009 if ( ((SvFLAGS(sv) &
3010 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3011 == (SVs_OBJECT|SVs_SMG))
3012 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3013 regexp *re = (regexp *)mg->mg_obj;
3016 char *fptr = "msix";
3021 char need_newline = 0;
3022 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3024 while((ch = *fptr++)) {
3026 reflags[left++] = ch;
3029 reflags[right--] = ch;
3034 reflags[left] = '-';
3038 mg->mg_len = re->prelen + 4 + left;
3040 * If /x was used, we have to worry about a regex
3041 * ending with a comment later being embedded
3042 * within another regex. If so, we don't want this
3043 * regex's "commentization" to leak out to the
3044 * right part of the enclosing regex, we must cap
3045 * it with a newline.
3047 * So, if /x was used, we scan backwards from the
3048 * end of the regex. If we find a '#' before we
3049 * find a newline, we need to add a newline
3050 * ourself. If we find a '\n' first (or if we
3051 * don't find '#' or '\n'), we don't need to add
3052 * anything. -jfriedl
3054 if (PMf_EXTENDED & re->reganch)
3056 char *endptr = re->precomp + re->prelen;
3057 while (endptr >= re->precomp)
3059 char c = *(endptr--);
3061 break; /* don't need another */
3063 /* we end while in a comment, so we
3065 mg->mg_len++; /* save space for it */
3066 need_newline = 1; /* note to add it */
3072 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3073 Copy("(?", mg->mg_ptr, 2, char);
3074 Copy(reflags, mg->mg_ptr+2, left, char);
3075 Copy(":", mg->mg_ptr+left+2, 1, char);
3076 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3078 mg->mg_ptr[mg->mg_len - 2] = '\n';
3079 mg->mg_ptr[mg->mg_len - 1] = ')';
3080 mg->mg_ptr[mg->mg_len] = 0;
3082 PL_reginterp_cnt += re->program[0].next_off;
3084 if (re->reganch & ROPT_UTF8)
3099 case SVt_PVBM: if (SvROK(sv))
3102 s = "SCALAR"; break;
3103 case SVt_PVLV: s = SvROK(sv) ? "REF"
3104 /* tied lvalues should appear to be
3105 * scalars for backwards compatitbility */
3106 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3107 ? "SCALAR" : "LVALUE"; break;
3108 case SVt_PVAV: s = "ARRAY"; break;
3109 case SVt_PVHV: s = "HASH"; break;
3110 case SVt_PVCV: s = "CODE"; break;
3111 case SVt_PVGV: s = "GLOB"; break;
3112 case SVt_PVFM: s = "FORMAT"; break;
3113 case SVt_PVIO: s = "IO"; break;
3114 default: s = "UNKNOWN"; break;
3118 if (HvNAME(SvSTASH(sv)))
3119 Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
3121 Perl_sv_setpvf(aTHX_ tsv, "__ANON__=%s", s);
3124 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3130 if (SvREADONLY(sv) && !SvOK(sv)) {
3131 if (ckWARN(WARN_UNINITIALIZED))
3137 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3138 /* I'm assuming that if both IV and NV are equally valid then
3139 converting the IV is going to be more efficient */
3140 U32 isIOK = SvIOK(sv);
3141 U32 isUIOK = SvIsUV(sv);
3142 char buf[TYPE_CHARS(UV)];
3145 if (SvTYPE(sv) < SVt_PVIV)
3146 sv_upgrade(sv, SVt_PVIV);
3148 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3150 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3151 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3152 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3153 SvCUR_set(sv, ebuf - ptr);
3163 else if (SvNOKp(sv)) {
3164 if (SvTYPE(sv) < SVt_PVNV)
3165 sv_upgrade(sv, SVt_PVNV);
3166 /* The +20 is pure guesswork. Configure test needed. --jhi */
3167 SvGROW(sv, NV_DIG + 20);
3169 olderrno = errno; /* some Xenix systems wipe out errno here */
3171 if (SvNVX(sv) == 0.0)
3172 (void)strcpy(s,"0");
3176 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3179 #ifdef FIXNEGATIVEZERO
3180 if (*s == '-' && s[1] == '0' && !s[2])
3190 if (ckWARN(WARN_UNINITIALIZED)
3191 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3194 if (SvTYPE(sv) < SVt_PV)
3195 /* Typically the caller expects that sv_any is not NULL now. */
3196 sv_upgrade(sv, SVt_PV);
3199 *lp = s - SvPVX(sv);
3202 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3203 PTR2UV(sv),SvPVX(sv)));
3207 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3208 /* Sneaky stuff here */
3212 tsv = newSVpv(tmpbuf, 0);
3228 len = strlen(tmpbuf);
3230 #ifdef FIXNEGATIVEZERO
3231 if (len == 2 && t[0] == '-' && t[1] == '0') {
3236 (void)SvUPGRADE(sv, SVt_PV);
3238 s = SvGROW(sv, len + 1);
3247 =for apidoc sv_copypv
3249 Copies a stringified representation of the source SV into the
3250 destination SV. Automatically performs any necessary mg_get and
3251 coercion of numeric values into strings. Guaranteed to preserve
3252 UTF-8 flag even from overloaded objects. Similar in nature to
3253 sv_2pv[_flags] but operates directly on an SV instead of just the
3254 string. Mostly uses sv_2pv_flags to do its work, except when that
3255 would lose the UTF-8'ness of the PV.
3261 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3266 sv_setpvn(dsv,s,len);
3274 =for apidoc sv_2pvbyte_nolen
3276 Return a pointer to the byte-encoded representation of the SV.
3277 May cause the SV to be downgraded from UTF-8 as a side-effect.
3279 Usually accessed via the C<SvPVbyte_nolen> macro.
3285 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3288 return sv_2pvbyte(sv, &n_a);
3292 =for apidoc sv_2pvbyte
3294 Return a pointer to the byte-encoded representation of the SV, and set *lp
3295 to its length. May cause the SV to be downgraded from UTF-8 as a
3298 Usually accessed via the C<SvPVbyte> macro.
3304 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3306 sv_utf8_downgrade(sv,0);
3307 return SvPV(sv,*lp);
3311 =for apidoc sv_2pvutf8_nolen
3313 Return a pointer to the UTF-8-encoded representation of the SV.
3314 May cause the SV to be upgraded to UTF-8 as a side-effect.
3316 Usually accessed via the C<SvPVutf8_nolen> macro.
3322 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3325 return sv_2pvutf8(sv, &n_a);
3329 =for apidoc sv_2pvutf8
3331 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3332 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3334 Usually accessed via the C<SvPVutf8> macro.
3340 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3342 sv_utf8_upgrade(sv);
3343 return SvPV(sv,*lp);
3347 =for apidoc sv_2bool
3349 This function is only called on magical items, and is only used by
3350 sv_true() or its macro equivalent.
3356 Perl_sv_2bool(pTHX_ register SV *sv)
3365 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3366 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3367 return (bool)SvTRUE(tmpsv);
3368 return SvRV(sv) != 0;
3371 register XPV* Xpvtmp;
3372 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3373 (*Xpvtmp->xpv_pv > '0' ||
3374 Xpvtmp->xpv_cur > 1 ||
3375 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3382 return SvIVX(sv) != 0;
3385 return SvNVX(sv) != 0.0;
3392 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3393 * this function provided for binary compatibility only
3398 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3400 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3404 =for apidoc sv_utf8_upgrade
3406 Convert the PV of an SV to its UTF-8-encoded form.
3407 Forces the SV to string form if it is not already.
3408 Always sets the SvUTF8 flag to avoid future validity checks even
3409 if all the bytes have hibit clear.
3411 This is not as a general purpose byte encoding to Unicode interface:
3412 use the Encode extension for that.
3414 =for apidoc sv_utf8_upgrade_flags
3416 Convert the PV of an SV to its UTF-8-encoded form.
3417 Forces the SV to string form if it is not already.
3418 Always sets the SvUTF8 flag to avoid future validity checks even
3419 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3420 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3421 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3423 This is not as a general purpose byte encoding to Unicode interface:
3424 use the Encode extension for that.
3430 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3440 (void) sv_2pv_flags(sv,&len, flags);
3449 sv_force_normal_flags(sv, 0);
3452 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3453 sv_recode_to_utf8(sv, PL_encoding);
3454 else { /* Assume Latin-1/EBCDIC */
3455 /* This function could be much more efficient if we
3456 * had a FLAG in SVs to signal if there are any hibit
3457 * chars in the PV. Given that there isn't such a flag
3458 * make the loop as fast as possible. */
3459 s = (U8 *) SvPVX(sv);
3460 e = (U8 *) SvEND(sv);
3464 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3470 len = SvCUR(sv) + 1; /* Plus the \0 */
3471 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3472 SvCUR(sv) = len - 1;
3474 Safefree(s); /* No longer using what was there before. */
3475 SvLEN(sv) = len; /* No longer know the real size. */
3477 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3484 =for apidoc sv_utf8_downgrade
3486 Attempt to convert the PV of an SV from UTF-8-encoded to byte encoding.
3487 This may not be possible if the PV contains non-byte encoding characters;
3488 if this is the case, either returns false or, if C<fail_ok> is not
3491 This is not as a general purpose Unicode to byte encoding interface:
3492 use the Encode extension for that.
3498 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3500 if (SvPOK(sv) && SvUTF8(sv)) {
3506 sv_force_normal_flags(sv, 0);
3508 s = (U8 *) SvPV(sv, len);
3509 if (!utf8_to_bytes(s, &len)) {
3514 Perl_croak(aTHX_ "Wide character in %s",
3517 Perl_croak(aTHX_ "Wide character");
3528 =for apidoc sv_utf8_encode
3530 Convert the PV of an SV to UTF-8-encoded, but then turn off the C<SvUTF8>
3531 flag so that it looks like octets again. Used as a building block
3532 for encode_utf8 in Encode.xs
3538 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3540 (void) sv_utf8_upgrade(sv);
3545 =for apidoc sv_utf8_decode
3547 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3548 turn off SvUTF8 if needed so that we see characters. Used as a building block
3549 for decode_utf8 in Encode.xs
3555 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3561 /* The octets may have got themselves encoded - get them back as
3564 if (!sv_utf8_downgrade(sv, TRUE))
3567 /* it is actually just a matter of turning the utf8 flag on, but
3568 * we want to make sure everything inside is valid utf8 first.
3570 c = (U8 *) SvPVX(sv);
3571 if (!is_utf8_string(c, SvCUR(sv)+1))
3573 e = (U8 *) SvEND(sv);
3576 if (!UTF8_IS_INVARIANT(ch)) {
3585 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3586 * this function provided for binary compatibility only
3590 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3592 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3596 =for apidoc sv_setsv
3598 Copies the contents of the source SV C<ssv> into the destination SV
3599 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3600 function if the source SV needs to be reused. Does not handle 'set' magic.
3601 Loosely speaking, it performs a copy-by-value, obliterating any previous
3602 content of the destination.
3604 You probably want to use one of the assortment of wrappers, such as
3605 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3606 C<SvSetMagicSV_nosteal>.
3608 =for apidoc sv_setsv_flags
3610 Copies the contents of the source SV C<ssv> into the destination SV
3611 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3612 function if the source SV needs to be reused. Does not handle 'set' magic.
3613 Loosely speaking, it performs a copy-by-value, obliterating any previous
3614 content of the destination.
3615 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3616 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3617 implemented in terms of this function.
3619 You probably want to use one of the assortment of wrappers, such as
3620 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3621 C<SvSetMagicSV_nosteal>.
3623 This is the primary function for copying scalars, and most other
3624 copy-ish functions and macros use this underneath.
3630 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3632 register U32 sflags;
3638 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3640 sstr = &PL_sv_undef;
3641 stype = SvTYPE(sstr);
3642 dtype = SvTYPE(dstr);
3647 /* need to nuke the magic */
3649 SvRMAGICAL_off(dstr);
3652 /* There's a lot of redundancy below but we're going for speed here */
3657 if (dtype != SVt_PVGV) {
3658 (void)SvOK_off(dstr);
3666 sv_upgrade(dstr, SVt_IV);
3669 sv_upgrade(dstr, SVt_PVNV);
3673 sv_upgrade(dstr, SVt_PVIV);
3676 (void)SvIOK_only(dstr);
3677 SvIVX(dstr) = SvIVX(sstr);
3680 if (SvTAINTED(sstr))
3691 sv_upgrade(dstr, SVt_NV);
3696 sv_upgrade(dstr, SVt_PVNV);
3699 SvNVX(dstr) = SvNVX(sstr);
3700 (void)SvNOK_only(dstr);
3701 if (SvTAINTED(sstr))
3709 sv_upgrade(dstr, SVt_RV);
3710 else if (dtype == SVt_PVGV &&
3711 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3714 if (GvIMPORTED(dstr) != GVf_IMPORTED
3715 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3717 GvIMPORTED_on(dstr);
3726 #ifdef PERL_COPY_ON_WRITE
3727 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3728 if (dtype < SVt_PVIV)
3729 sv_upgrade(dstr, SVt_PVIV);
3736 sv_upgrade(dstr, SVt_PV);
3739 if (dtype < SVt_PVIV)
3740 sv_upgrade(dstr, SVt_PVIV);
3743 if (dtype < SVt_PVNV)
3744 sv_upgrade(dstr, SVt_PVNV);
3751 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
3754 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
3758 if (dtype <= SVt_PVGV) {
3760 if (dtype != SVt_PVGV) {
3761 char *name = GvNAME(sstr);
3762 STRLEN len = GvNAMELEN(sstr);
3763 sv_upgrade(dstr, SVt_PVGV);
3764 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3765 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3766 GvNAME(dstr) = savepvn(name, len);
3767 GvNAMELEN(dstr) = len;
3768 SvFAKE_on(dstr); /* can coerce to non-glob */
3770 /* ahem, death to those who redefine active sort subs */
3771 else if (PL_curstackinfo->si_type == PERLSI_SORT
3772 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3773 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3776 #ifdef GV_UNIQUE_CHECK
3777 if (GvUNIQUE((GV*)dstr)) {
3778 Perl_croak(aTHX_ PL_no_modify);
3782 (void)SvOK_off(dstr);
3783 GvINTRO_off(dstr); /* one-shot flag */
3785 GvGP(dstr) = gp_ref(GvGP(sstr));
3786 if (SvTAINTED(sstr))
3788 if (GvIMPORTED(dstr) != GVf_IMPORTED
3789 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3791 GvIMPORTED_on(dstr);
3799 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3801 if ((int)SvTYPE(sstr) != stype) {
3802 stype = SvTYPE(sstr);
3803 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3807 if (stype == SVt_PVLV)
3808 (void)SvUPGRADE(dstr, SVt_PVNV);
3810 (void)SvUPGRADE(dstr, (U32)stype);
3813 sflags = SvFLAGS(sstr);
3815 if (sflags & SVf_ROK) {
3816 if (dtype >= SVt_PV) {
3817 if (dtype == SVt_PVGV) {
3818 SV *sref = SvREFCNT_inc(SvRV(sstr));
3820 int intro = GvINTRO(dstr);
3822 #ifdef GV_UNIQUE_CHECK
3823 if (GvUNIQUE((GV*)dstr)) {
3824 Perl_croak(aTHX_ PL_no_modify);
3829 GvINTRO_off(dstr); /* one-shot flag */
3830 GvLINE(dstr) = CopLINE(PL_curcop);
3831 GvEGV(dstr) = (GV*)dstr;
3834 switch (SvTYPE(sref)) {
3837 SAVEGENERICSV(GvAV(dstr));
3839 dref = (SV*)GvAV(dstr);
3840 GvAV(dstr) = (AV*)sref;
3841 if (!GvIMPORTED_AV(dstr)
3842 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3844 GvIMPORTED_AV_on(dstr);
3849 SAVEGENERICSV(GvHV(dstr));
3851 dref = (SV*)GvHV(dstr);
3852 GvHV(dstr) = (HV*)sref;
3853 if (!GvIMPORTED_HV(dstr)
3854 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3856 GvIMPORTED_HV_on(dstr);
3861 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3862 SvREFCNT_dec(GvCV(dstr));
3863 GvCV(dstr) = Nullcv;
3864 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3865 PL_sub_generation++;
3867 SAVEGENERICSV(GvCV(dstr));
3870 dref = (SV*)GvCV(dstr);
3871 if (GvCV(dstr) != (CV*)sref) {
3872 CV* cv = GvCV(dstr);
3874 if (!GvCVGEN((GV*)dstr) &&
3875 (CvROOT(cv) || CvXSUB(cv)))
3877 /* ahem, death to those who redefine
3878 * active sort subs */
3879 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3880 PL_sortcop == CvSTART(cv))
3882 "Can't redefine active sort subroutine %s",
3883 GvENAME((GV*)dstr));
3884 /* Redefining a sub - warning is mandatory if
3885 it was a const and its value changed. */
3886 if (ckWARN(WARN_REDEFINE)
3888 && (!CvCONST((CV*)sref)
3889 || sv_cmp(cv_const_sv(cv),
3890 cv_const_sv((CV*)sref)))))
3892 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3894 ? "Constant subroutine %s::%s redefined"
3895 : "Subroutine %s::%s redefined",
3896 HvNAME(GvSTASH((GV*)dstr)),
3897 GvENAME((GV*)dstr));
3901 cv_ckproto(cv, (GV*)dstr,
3902 SvPOK(sref) ? SvPVX(sref) : Nullch);
3904 GvCV(dstr) = (CV*)sref;
3905 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3906 GvASSUMECV_on(dstr);
3907 PL_sub_generation++;
3909 if (!GvIMPORTED_CV(dstr)
3910 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3912 GvIMPORTED_CV_on(dstr);
3917 SAVEGENERICSV(GvIOp(dstr));
3919 dref = (SV*)GvIOp(dstr);
3920 GvIOp(dstr) = (IO*)sref;
3924 SAVEGENERICSV(GvFORM(dstr));
3926 dref = (SV*)GvFORM(dstr);
3927 GvFORM(dstr) = (CV*)sref;
3931 SAVEGENERICSV(GvSV(dstr));
3933 dref = (SV*)GvSV(dstr);
3935 if (!GvIMPORTED_SV(dstr)
3936 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3938 GvIMPORTED_SV_on(dstr);
3944 if (SvTAINTED(sstr))
3949 (void)SvOOK_off(dstr); /* backoff */
3951 Safefree(SvPVX(dstr));
3952 SvLEN(dstr)=SvCUR(dstr)=0;
3955 (void)SvOK_off(dstr);
3956 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
3958 if (sflags & SVp_NOK) {
3960 /* Only set the public OK flag if the source has public OK. */
3961 if (sflags & SVf_NOK)
3962 SvFLAGS(dstr) |= SVf_NOK;
3963 SvNVX(dstr) = SvNVX(sstr);
3965 if (sflags & SVp_IOK) {
3966 (void)SvIOKp_on(dstr);
3967 if (sflags & SVf_IOK)
3968 SvFLAGS(dstr) |= SVf_IOK;
3969 if (sflags & SVf_IVisUV)
3971 SvIVX(dstr) = SvIVX(sstr);
3973 if (SvAMAGIC(sstr)) {
3977 else if (sflags & SVp_POK) {
3981 * Check to see if we can just swipe the string. If so, it's a
3982 * possible small lose on short strings, but a big win on long ones.
3983 * It might even be a win on short strings if SvPVX(dstr)
3984 * has to be allocated and SvPVX(sstr) has to be freed.
3988 #ifdef PERL_COPY_ON_WRITE
3989 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3993 (sflags & SVs_TEMP) && /* slated for free anyway? */
3994 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3995 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3996 SvLEN(sstr) && /* and really is a string */
3997 /* and won't be needed again, potentially */
3998 !(PL_op && PL_op->op_type == OP_AASSIGN))
3999 #ifdef PERL_COPY_ON_WRITE
4000 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4001 && SvTYPE(sstr) >= SVt_PVIV)
4004 /* Failed the swipe test, and it's not a shared hash key either.
4005 Have to copy the string. */
4006 STRLEN len = SvCUR(sstr);
4007 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4008 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4009 SvCUR_set(dstr, len);
4010 *SvEND(dstr) = '\0';
4011 (void)SvPOK_only(dstr);
4013 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4015 #ifdef PERL_COPY_ON_WRITE
4016 /* Either it's a shared hash key, or it's suitable for
4017 copy-on-write or we can swipe the string. */
4019 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4024 /* I believe I should acquire a global SV mutex if
4025 it's a COW sv (not a shared hash key) to stop
4026 it going un copy-on-write.
4027 If the source SV has gone un copy on write between up there
4028 and down here, then (assert() that) it is of the correct
4029 form to make it copy on write again */
4030 if ((sflags & (SVf_FAKE | SVf_READONLY))
4031 != (SVf_FAKE | SVf_READONLY)) {
4032 SvREADONLY_on(sstr);
4034 /* Make the source SV into a loop of 1.
4035 (about to become 2) */
4036 SV_COW_NEXT_SV_SET(sstr, sstr);
4040 /* Initial code is common. */
4041 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4043 SvFLAGS(dstr) &= ~SVf_OOK;
4044 Safefree(SvPVX(dstr) - SvIVX(dstr));
4046 else if (SvLEN(dstr))
4047 Safefree(SvPVX(dstr));
4049 (void)SvPOK_only(dstr);
4051 #ifdef PERL_COPY_ON_WRITE
4053 /* making another shared SV. */
4054 STRLEN cur = SvCUR(sstr);
4055 STRLEN len = SvLEN(sstr);
4056 assert (SvTYPE(dstr) >= SVt_PVIV);
4058 /* SvIsCOW_normal */
4059 /* splice us in between source and next-after-source. */
4060 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4061 SV_COW_NEXT_SV_SET(sstr, dstr);
4062 SvPV_set(dstr, SvPVX(sstr));
4064 /* SvIsCOW_shared_hash */
4065 UV hash = SvUVX(sstr);
4066 DEBUG_C(PerlIO_printf(Perl_debug_log,
4067 "Copy on write: Sharing hash\n"));
4069 sharepvn(SvPVX(sstr),
4070 (sflags & SVf_UTF8?-cur:cur), hash));
4075 SvREADONLY_on(dstr);
4077 /* Relesase a global SV mutex. */
4081 { /* Passes the swipe test. */
4082 SvPV_set(dstr, SvPVX(sstr));
4083 SvLEN_set(dstr, SvLEN(sstr));
4084 SvCUR_set(dstr, SvCUR(sstr));
4087 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4088 SvPV_set(sstr, Nullch);
4094 if (sflags & SVf_UTF8)
4097 if (sflags & SVp_NOK) {
4099 if (sflags & SVf_NOK)
4100 SvFLAGS(dstr) |= SVf_NOK;
4101 SvNVX(dstr) = SvNVX(sstr);
4103 if (sflags & SVp_IOK) {
4104 (void)SvIOKp_on(dstr);
4105 if (sflags & SVf_IOK)
4106 SvFLAGS(dstr) |= SVf_IOK;
4107 if (sflags & SVf_IVisUV)
4109 SvIVX(dstr) = SvIVX(sstr);
4112 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4113 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4114 smg->mg_ptr, smg->mg_len);
4115 SvRMAGICAL_on(dstr);
4118 else if (sflags & SVp_IOK) {
4119 if (sflags & SVf_IOK)
4120 (void)SvIOK_only(dstr);
4122 (void)SvOK_off(dstr);
4123 (void)SvIOKp_on(dstr);
4125 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4126 if (sflags & SVf_IVisUV)
4128 SvIVX(dstr) = SvIVX(sstr);
4129 if (sflags & SVp_NOK) {
4130 if (sflags & SVf_NOK)
4131 (void)SvNOK_on(dstr);
4133 (void)SvNOKp_on(dstr);
4134 SvNVX(dstr) = SvNVX(sstr);
4137 else if (sflags & SVp_NOK) {
4138 if (sflags & SVf_NOK)
4139 (void)SvNOK_only(dstr);
4141 (void)SvOK_off(dstr);
4144 SvNVX(dstr) = SvNVX(sstr);
4147 if (dtype == SVt_PVGV) {
4148 if (ckWARN(WARN_MISC))
4149 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4152 (void)SvOK_off(dstr);
4154 if (SvTAINTED(sstr))
4159 =for apidoc sv_setsv_mg
4161 Like C<sv_setsv>, but also handles 'set' magic.
4167 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4169 sv_setsv(dstr,sstr);
4173 #ifdef PERL_COPY_ON_WRITE
4175 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4177 STRLEN cur = SvCUR(sstr);
4178 STRLEN len = SvLEN(sstr);
4179 register char *new_pv;
4182 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4190 if (SvTHINKFIRST(dstr))
4191 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4192 else if (SvPVX(dstr))
4193 Safefree(SvPVX(dstr));
4197 SvUPGRADE (dstr, SVt_PVIV);
4199 assert (SvPOK(sstr));
4200 assert (SvPOKp(sstr));
4201 assert (!SvIOK(sstr));
4202 assert (!SvIOKp(sstr));
4203 assert (!SvNOK(sstr));
4204 assert (!SvNOKp(sstr));
4206 if (SvIsCOW(sstr)) {
4208 if (SvLEN(sstr) == 0) {
4209 /* source is a COW shared hash key. */
4210 UV hash = SvUVX(sstr);
4211 DEBUG_C(PerlIO_printf(Perl_debug_log,
4212 "Fast copy on write: Sharing hash\n"));
4214 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4217 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4219 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4220 SvUPGRADE (sstr, SVt_PVIV);
4221 SvREADONLY_on(sstr);
4223 DEBUG_C(PerlIO_printf(Perl_debug_log,
4224 "Fast copy on write: Converting sstr to COW\n"));
4225 SV_COW_NEXT_SV_SET(dstr, sstr);
4227 SV_COW_NEXT_SV_SET(sstr, dstr);
4228 new_pv = SvPVX(sstr);
4231 SvPV_set(dstr, new_pv);
4232 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4245 =for apidoc sv_setpvn
4247 Copies a string into an SV. The C<len> parameter indicates the number of
4248 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4254 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4256 register char *dptr;
4258 SV_CHECK_THINKFIRST_COW_DROP(sv);
4264 /* len is STRLEN which is unsigned, need to copy to signed */
4267 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4269 (void)SvUPGRADE(sv, SVt_PV);
4271 SvGROW(sv, len + 1);
4273 Move(ptr,dptr,len,char);
4276 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4281 =for apidoc sv_setpvn_mg
4283 Like C<sv_setpvn>, but also handles 'set' magic.
4289 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4291 sv_setpvn(sv,ptr,len);
4296 =for apidoc sv_setpv
4298 Copies a string into an SV. The string must be null-terminated. Does not
4299 handle 'set' magic. See C<sv_setpv_mg>.
4305 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4307 register STRLEN len;
4309 SV_CHECK_THINKFIRST_COW_DROP(sv);
4315 (void)SvUPGRADE(sv, SVt_PV);
4317 SvGROW(sv, len + 1);
4318 Move(ptr,SvPVX(sv),len+1,char);
4320 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4325 =for apidoc sv_setpv_mg
4327 Like C<sv_setpv>, but also handles 'set' magic.
4333 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4340 =for apidoc sv_usepvn
4342 Tells an SV to use C<ptr> to find its string value. Normally the string is
4343 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4344 The C<ptr> should point to memory that was allocated by C<malloc>. The
4345 string length, C<len>, must be supplied. This function will realloc the
4346 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4347 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4348 See C<sv_usepvn_mg>.
4354 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4356 SV_CHECK_THINKFIRST_COW_DROP(sv);
4357 (void)SvUPGRADE(sv, SVt_PV);
4362 (void)SvOOK_off(sv);
4363 if (SvPVX(sv) && SvLEN(sv))
4364 Safefree(SvPVX(sv));
4365 Renew(ptr, len+1, char);
4368 SvLEN_set(sv, len+1);
4370 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4375 =for apidoc sv_usepvn_mg
4377 Like C<sv_usepvn>, but also handles 'set' magic.
4383 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4385 sv_usepvn(sv,ptr,len);
4389 #ifdef PERL_COPY_ON_WRITE
4390 /* Need to do this *after* making the SV normal, as we need the buffer
4391 pointer to remain valid until after we've copied it. If we let go too early,
4392 another thread could invalidate it by unsharing last of the same hash key
4393 (which it can do by means other than releasing copy-on-write Svs)
4394 or by changing the other copy-on-write SVs in the loop. */
4396 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4397 U32 hash, SV *after)
4399 if (len) { /* this SV was SvIsCOW_normal(sv) */
4400 /* we need to find the SV pointing to us. */
4401 SV *current = SV_COW_NEXT_SV(after);
4403 if (current == sv) {
4404 /* The SV we point to points back to us (there were only two of us
4406 Hence other SV is no longer copy on write either. */
4408 SvREADONLY_off(after);
4410 /* We need to follow the pointers around the loop. */
4412 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4415 /* don't loop forever if the structure is bust, and we have
4416 a pointer into a closed loop. */
4417 assert (current != after);
4418 assert (SvPVX(current) == pvx);
4420 /* Make the SV before us point to the SV after us. */
4421 SV_COW_NEXT_SV_SET(current, after);
4424 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4429 Perl_sv_release_IVX(pTHX_ register SV *sv)
4432 sv_force_normal_flags(sv, 0);
4433 return SvOOK_off(sv);
4437 =for apidoc sv_force_normal_flags
4439 Undo various types of fakery on an SV: if the PV is a shared string, make
4440 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4441 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4442 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4443 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4444 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4445 set to some other value.) In addition, the C<flags> parameter gets passed to
4446 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4447 with flags set to 0.
4453 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4455 #ifdef PERL_COPY_ON_WRITE
4456 if (SvREADONLY(sv)) {
4457 /* At this point I believe I should acquire a global SV mutex. */
4459 char *pvx = SvPVX(sv);
4460 STRLEN len = SvLEN(sv);
4461 STRLEN cur = SvCUR(sv);
4462 U32 hash = SvUVX(sv);
4463 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4465 PerlIO_printf(Perl_debug_log,
4466 "Copy on write: Force normal %ld\n",
4472 /* This SV doesn't own the buffer, so need to New() a new one: */
4475 if (flags & SV_COW_DROP_PV) {
4476 /* OK, so we don't need to copy our buffer. */
4479 SvGROW(sv, cur + 1);
4480 Move(pvx,SvPVX(sv),cur,char);
4484 sv_release_COW(sv, pvx, cur, len, hash, next);
4489 else if (IN_PERL_RUNTIME)
4490 Perl_croak(aTHX_ PL_no_modify);
4491 /* At this point I believe that I can drop the global SV mutex. */
4494 if (SvREADONLY(sv)) {
4496 char *pvx = SvPVX(sv);
4497 STRLEN len = SvCUR(sv);
4498 U32 hash = SvUVX(sv);
4501 SvGROW(sv, len + 1);
4502 Move(pvx,SvPVX(sv),len,char);
4504 unsharepvn(pvx, SvUTF8(sv) ? -(I32)len : len, hash);
4506 else if (IN_PERL_RUNTIME)
4507 Perl_croak(aTHX_ PL_no_modify);
4511 sv_unref_flags(sv, flags);
4512 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4517 =for apidoc sv_force_normal
4519 Undo various types of fakery on an SV: if the PV is a shared string, make
4520 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4521 an xpvmg. See also C<sv_force_normal_flags>.
4527 Perl_sv_force_normal(pTHX_ register SV *sv)
4529 sv_force_normal_flags(sv, 0);
4535 Efficient removal of characters from the beginning of the string buffer.
4536 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4537 the string buffer. The C<ptr> becomes the first character of the adjusted
4538 string. Uses the "OOK hack".
4539 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
4540 refer to the same chunk of data.
4546 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
4548 register STRLEN delta;
4549 if (!ptr || !SvPOKp(sv))
4551 delta = ptr - SvPVX(sv);
4552 SV_CHECK_THINKFIRST(sv);
4553 if (SvTYPE(sv) < SVt_PVIV)
4554 sv_upgrade(sv,SVt_PVIV);
4557 if (!SvLEN(sv)) { /* make copy of shared string */
4558 char *pvx = SvPVX(sv);
4559 STRLEN len = SvCUR(sv);
4560 SvGROW(sv, len + 1);
4561 Move(pvx,SvPVX(sv),len,char);
4565 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4566 and we do that anyway inside the SvNIOK_off
4568 SvFLAGS(sv) |= SVf_OOK;
4577 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4578 * this function provided for binary compatibility only
4582 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4584 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4588 =for apidoc sv_catpvn
4590 Concatenates the string onto the end of the string which is in the SV. The
4591 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4592 status set, then the bytes appended should be valid UTF-8.
4593 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4595 =for apidoc sv_catpvn_flags
4597 Concatenates the string onto the end of the string which is in the SV. The
4598 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4599 status set, then the bytes appended should be valid UTF-8.
4600 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4601 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4602 in terms of this function.
4608 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4613 dstr = SvPV_force_flags(dsv, dlen, flags);
4614 SvGROW(dsv, dlen + slen + 1);
4617 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4620 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4625 =for apidoc sv_catpvn_mg
4627 Like C<sv_catpvn>, but also handles 'set' magic.
4633 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4635 sv_catpvn(sv,ptr,len);
4639 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4640 * this function provided for binary compatibility only
4644 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4646 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4650 =for apidoc sv_catsv
4652 Concatenates the string from SV C<ssv> onto the end of the string in
4653 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4654 not 'set' magic. See C<sv_catsv_mg>.
4656 =for apidoc sv_catsv_flags
4658 Concatenates the string from SV C<ssv> onto the end of the string in
4659 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4660 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4661 and C<sv_catsv_nomg> are implemented in terms of this function.
4666 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4672 if ((spv = SvPV(ssv, slen))) {
4673 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4674 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4675 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4676 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4677 dsv->sv_flags doesn't have that bit set.
4678 Andy Dougherty 12 Oct 2001
4680 I32 sutf8 = DO_UTF8(ssv);
4683 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4685 dutf8 = DO_UTF8(dsv);
4687 if (dutf8 != sutf8) {
4689 /* Not modifying source SV, so taking a temporary copy. */
4690 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4692 sv_utf8_upgrade(csv);
4693 spv = SvPV(csv, slen);
4696 sv_utf8_upgrade_nomg(dsv);
4698 sv_catpvn_nomg(dsv, spv, slen);
4703 =for apidoc sv_catsv_mg
4705 Like C<sv_catsv>, but also handles 'set' magic.
4711 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4718 =for apidoc sv_catpv
4720 Concatenates the string onto the end of the string which is in the SV.
4721 If the SV has the UTF-8 status set, then the bytes appended should be
4722 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4727 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4729 register STRLEN len;
4735 junk = SvPV_force(sv, tlen);
4737 SvGROW(sv, tlen + len + 1);
4740 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4742 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4747 =for apidoc sv_catpv_mg
4749 Like C<sv_catpv>, but also handles 'set' magic.
4755 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4764 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4765 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4772 Perl_newSV(pTHX_ STRLEN len)
4778 sv_upgrade(sv, SVt_PV);
4779 SvGROW(sv, len + 1);
4784 =for apidoc sv_magicext
4786 Adds magic to an SV, upgrading it if necessary. Applies the
4787 supplied vtable and returns pointer to the magic added.
4789 Note that sv_magicext will allow things that sv_magic will not.
4790 In particular you can add magic to SvREADONLY SVs and and more than
4791 one instance of the same 'how'
4793 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4794 if C<namelen> is zero then C<name> is stored as-is and - as another special
4795 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4796 an C<SV*> and has its REFCNT incremented
4798 (This is now used as a subroutine by sv_magic.)
4803 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4804 const char* name, I32 namlen)
4808 if (SvTYPE(sv) < SVt_PVMG) {
4809 (void)SvUPGRADE(sv, SVt_PVMG);
4811 Newz(702,mg, 1, MAGIC);
4812 mg->mg_moremagic = SvMAGIC(sv);
4815 /* Some magic sontains a reference loop, where the sv and object refer to
4816 each other. To prevent a reference loop that would prevent such
4817 objects being freed, we look for such loops and if we find one we
4818 avoid incrementing the object refcount.
4820 Note we cannot do this to avoid self-tie loops as intervening RV must
4821 have its REFCNT incremented to keep it in existence.
4824 if (!obj || obj == sv ||
4825 how == PERL_MAGIC_arylen ||
4826 how == PERL_MAGIC_qr ||
4827 (SvTYPE(obj) == SVt_PVGV &&
4828 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4829 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4830 GvFORM(obj) == (CV*)sv)))
4835 mg->mg_obj = SvREFCNT_inc(obj);
4836 mg->mg_flags |= MGf_REFCOUNTED;
4839 /* Normal self-ties simply pass a null object, and instead of
4840 using mg_obj directly, use the SvTIED_obj macro to produce a
4841 new RV as needed. For glob "self-ties", we are tieing the PVIO
4842 with an RV obj pointing to the glob containing the PVIO. In
4843 this case, to avoid a reference loop, we need to weaken the
4847 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4848 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4854 mg->mg_len = namlen;
4857 mg->mg_ptr = savepvn(name, namlen);
4858 else if (namlen == HEf_SVKEY)
4859 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4861 mg->mg_ptr = (char *) name;
4863 mg->mg_virtual = vtable;
4867 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4872 =for apidoc sv_magic
4874 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4875 then adds a new magic item of type C<how> to the head of the magic list.
4881 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4886 #ifdef PERL_COPY_ON_WRITE
4888 sv_force_normal_flags(sv, 0);
4890 if (SvREADONLY(sv)) {
4892 && how != PERL_MAGIC_regex_global
4893 && how != PERL_MAGIC_bm
4894 && how != PERL_MAGIC_fm
4895 && how != PERL_MAGIC_sv
4898 Perl_croak(aTHX_ PL_no_modify);
4901 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4902 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4903 /* sv_magic() refuses to add a magic of the same 'how' as an
4906 if (how == PERL_MAGIC_taint)
4914 vtable = &PL_vtbl_sv;
4916 case PERL_MAGIC_overload:
4917 vtable = &PL_vtbl_amagic;
4919 case PERL_MAGIC_overload_elem:
4920 vtable = &PL_vtbl_amagicelem;
4922 case PERL_MAGIC_overload_table:
4923 vtable = &PL_vtbl_ovrld;
4926 vtable = &PL_vtbl_bm;
4928 case PERL_MAGIC_regdata:
4929 vtable = &PL_vtbl_regdata;
4931 case PERL_MAGIC_regdatum:
4932 vtable = &PL_vtbl_regdatum;
4934 case PERL_MAGIC_env:
4935 vtable = &PL_vtbl_env;
4938 vtable = &PL_vtbl_fm;
4940 case PERL_MAGIC_envelem:
4941 vtable = &PL_vtbl_envelem;
4943 case PERL_MAGIC_regex_global:
4944 vtable = &PL_vtbl_mglob;
4946 case PERL_MAGIC_isa:
4947 vtable = &PL_vtbl_isa;
4949 case PERL_MAGIC_isaelem:
4950 vtable = &PL_vtbl_isaelem;
4952 case PERL_MAGIC_nkeys:
4953 vtable = &PL_vtbl_nkeys;
4955 case PERL_MAGIC_dbfile:
4958 case PERL_MAGIC_dbline:
4959 vtable = &PL_vtbl_dbline;
4961 #ifdef USE_LOCALE_COLLATE
4962 case PERL_MAGIC_collxfrm:
4963 vtable = &PL_vtbl_collxfrm;
4965 #endif /* USE_LOCALE_COLLATE */
4966 case PERL_MAGIC_tied:
4967 vtable = &PL_vtbl_pack;
4969 case PERL_MAGIC_tiedelem:
4970 case PERL_MAGIC_tiedscalar:
4971 vtable = &PL_vtbl_packelem;
4974 vtable = &PL_vtbl_regexp;
4976 case PERL_MAGIC_sig:
4977 vtable = &PL_vtbl_sig;
4979 case PERL_MAGIC_sigelem:
4980 vtable = &PL_vtbl_sigelem;
4982 case PERL_MAGIC_taint:
4983 vtable = &PL_vtbl_taint;
4985 case PERL_MAGIC_uvar:
4986 vtable = &PL_vtbl_uvar;
4988 case PERL_MAGIC_vec:
4989 vtable = &PL_vtbl_vec;
4991 case PERL_MAGIC_vstring:
4994 case PERL_MAGIC_utf8:
4995 vtable = &PL_vtbl_utf8;
4997 case PERL_MAGIC_substr:
4998 vtable = &PL_vtbl_substr;
5000 case PERL_MAGIC_defelem:
5001 vtable = &PL_vtbl_defelem;
5003 case PERL_MAGIC_glob:
5004 vtable = &PL_vtbl_glob;
5006 case PERL_MAGIC_arylen:
5007 vtable = &PL_vtbl_arylen;
5009 case PERL_MAGIC_pos:
5010 vtable = &PL_vtbl_pos;
5012 case PERL_MAGIC_backref:
5013 vtable = &PL_vtbl_backref;
5015 case PERL_MAGIC_ext:
5016 /* Reserved for use by extensions not perl internals. */
5017 /* Useful for attaching extension internal data to perl vars. */
5018 /* Note that multiple extensions may clash if magical scalars */
5019 /* etc holding private data from one are passed to another. */
5022 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5025 /* Rest of work is done else where */
5026 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5029 case PERL_MAGIC_taint:
5032 case PERL_MAGIC_ext:
5033 case PERL_MAGIC_dbfile:
5040 =for apidoc sv_unmagic
5042 Removes all magic of type C<type> from an SV.
5048 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5052 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5055 for (mg = *mgp; mg; mg = *mgp) {
5056 if (mg->mg_type == type) {
5057 MGVTBL* vtbl = mg->mg_virtual;
5058 *mgp = mg->mg_moremagic;
5059 if (vtbl && vtbl->svt_free)
5060 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5061 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5063 Safefree(mg->mg_ptr);
5064 else if (mg->mg_len == HEf_SVKEY)
5065 SvREFCNT_dec((SV*)mg->mg_ptr);
5066 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5067 Safefree(mg->mg_ptr);
5069 if (mg->mg_flags & MGf_REFCOUNTED)
5070 SvREFCNT_dec(mg->mg_obj);
5074 mgp = &mg->mg_moremagic;
5078 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5085 =for apidoc sv_rvweaken
5087 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5088 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5089 push a back-reference to this RV onto the array of backreferences
5090 associated with that magic.
5096 Perl_sv_rvweaken(pTHX_ SV *sv)
5099 if (!SvOK(sv)) /* let undefs pass */
5102 Perl_croak(aTHX_ "Can't weaken a nonreference");
5103 else if (SvWEAKREF(sv)) {
5104 if (ckWARN(WARN_MISC))
5105 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5109 sv_add_backref(tsv, sv);
5115 /* Give tsv backref magic if it hasn't already got it, then push a
5116 * back-reference to sv onto the array associated with the backref magic.
5120 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5124 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5125 av = (AV*)mg->mg_obj;
5128 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5129 /* av now has a refcnt of 2, which avoids it getting freed
5130 * before us during global cleanup. The extra ref is removed
5131 * by magic_killbackrefs() when tsv is being freed */
5133 if (AvFILLp(av) >= AvMAX(av)) {
5134 SV **svp = AvARRAY(av);
5135 I32 i = AvFILLp(av);
5137 if (svp[i] == &PL_sv_undef) {
5138 svp[i] = sv; /* reuse the slot */
5143 av_extend(av, AvFILLp(av)+1);
5145 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5148 /* delete a back-reference to ourselves from the backref magic associated
5149 * with the SV we point to.
5153 S_sv_del_backref(pTHX_ SV *sv)
5160 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5161 Perl_croak(aTHX_ "panic: del_backref");
5162 av = (AV *)mg->mg_obj;
5167 svp[i] = &PL_sv_undef; /* XXX */
5174 =for apidoc sv_insert
5176 Inserts a string at the specified offset/length within the SV. Similar to
5177 the Perl substr() function.
5183 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5187 register char *midend;
5188 register char *bigend;
5194 Perl_croak(aTHX_ "Can't modify non-existent substring");
5195 SvPV_force(bigstr, curlen);
5196 (void)SvPOK_only_UTF8(bigstr);
5197 if (offset + len > curlen) {
5198 SvGROW(bigstr, offset+len+1);
5199 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5200 SvCUR_set(bigstr, offset+len);
5204 i = littlelen - len;
5205 if (i > 0) { /* string might grow */
5206 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5207 mid = big + offset + len;
5208 midend = bigend = big + SvCUR(bigstr);
5211 while (midend > mid) /* shove everything down */
5212 *--bigend = *--midend;
5213 Move(little,big+offset,littlelen,char);
5219 Move(little,SvPVX(bigstr)+offset,len,char);
5224 big = SvPVX(bigstr);
5227 bigend = big + SvCUR(bigstr);
5229 if (midend > bigend)
5230 Perl_croak(aTHX_ "panic: sv_insert");
5232 if (mid - big > bigend - midend) { /* faster to shorten from end */
5234 Move(little, mid, littlelen,char);
5237 i = bigend - midend;
5239 Move(midend, mid, i,char);
5243 SvCUR_set(bigstr, mid - big);
5246 else if ((i = mid - big)) { /* faster from front */
5247 midend -= littlelen;
5249 sv_chop(bigstr,midend-i);
5254 Move(little, mid, littlelen,char);
5256 else if (littlelen) {
5257 midend -= littlelen;
5258 sv_chop(bigstr,midend);
5259 Move(little,midend,littlelen,char);
5262 sv_chop(bigstr,midend);
5268 =for apidoc sv_replace
5270 Make the first argument a copy of the second, then delete the original.
5271 The target SV physically takes over ownership of the body of the source SV
5272 and inherits its flags; however, the target keeps any magic it owns,
5273 and any magic in the source is discarded.
5274 Note that this is a rather specialist SV copying operation; most of the
5275 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5281 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5283 U32 refcnt = SvREFCNT(sv);
5284 SV_CHECK_THINKFIRST_COW_DROP(sv);
5285 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5286 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5287 if (SvMAGICAL(sv)) {
5291 sv_upgrade(nsv, SVt_PVMG);
5292 SvMAGIC(nsv) = SvMAGIC(sv);
5293 SvFLAGS(nsv) |= SvMAGICAL(sv);
5299 assert(!SvREFCNT(sv));
5300 StructCopy(nsv,sv,SV);
5301 #ifdef PERL_COPY_ON_WRITE
5302 if (SvIsCOW_normal(nsv)) {
5303 /* We need to follow the pointers around the loop to make the
5304 previous SV point to sv, rather than nsv. */
5307 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5310 assert(SvPVX(current) == SvPVX(nsv));
5312 /* Make the SV before us point to the SV after us. */
5314 PerlIO_printf(Perl_debug_log, "previous is\n");
5316 PerlIO_printf(Perl_debug_log,
5317 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5318 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5320 SV_COW_NEXT_SV_SET(current, sv);
5323 SvREFCNT(sv) = refcnt;
5324 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5330 =for apidoc sv_clear
5332 Clear an SV: call any destructors, free up any memory used by the body,
5333 and free the body itself. The SV's head is I<not> freed, although
5334 its type is set to all 1's so that it won't inadvertently be assumed
5335 to be live during global destruction etc.
5336 This function should only be called when REFCNT is zero. Most of the time
5337 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5344 Perl_sv_clear(pTHX_ register SV *sv)
5348 assert(SvREFCNT(sv) == 0);
5351 if (PL_defstash) { /* Still have a symbol table? */
5358 stash = SvSTASH(sv);
5359 destructor = StashHANDLER(stash,DESTROY);
5361 SV* tmpref = newRV(sv);
5362 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5364 PUSHSTACKi(PERLSI_DESTROY);
5369 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5375 if(SvREFCNT(tmpref) < 2) {
5376 /* tmpref is not kept alive! */
5381 SvREFCNT_dec(tmpref);
5383 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5387 if (PL_in_clean_objs)
5388 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5390 /* DESTROY gave object new lease on life */
5396 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5397 SvOBJECT_off(sv); /* Curse the object. */
5398 if (SvTYPE(sv) != SVt_PVIO)
5399 --PL_sv_objcount; /* XXX Might want something more general */
5402 if (SvTYPE(sv) >= SVt_PVMG) {
5405 if (SvFLAGS(sv) & SVpad_TYPED)
5406 SvREFCNT_dec(SvSTASH(sv));
5409 switch (SvTYPE(sv)) {
5412 IoIFP(sv) != PerlIO_stdin() &&
5413 IoIFP(sv) != PerlIO_stdout() &&
5414 IoIFP(sv) != PerlIO_stderr())
5416 io_close((IO*)sv, FALSE);
5418 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5419 PerlDir_close(IoDIRP(sv));
5420 IoDIRP(sv) = (DIR*)NULL;
5421 Safefree(IoTOP_NAME(sv));
5422 Safefree(IoFMT_NAME(sv));
5423 Safefree(IoBOTTOM_NAME(sv));
5438 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5439 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5440 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5441 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5443 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5444 SvREFCNT_dec(LvTARG(sv));
5448 Safefree(GvNAME(sv));
5449 /* cannot decrease stash refcount yet, as we might recursively delete
5450 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5451 of stash until current sv is completely gone.
5452 -- JohnPC, 27 Mar 1998 */
5453 stash = GvSTASH(sv);
5459 (void)SvOOK_off(sv);
5467 SvREFCNT_dec(SvRV(sv));
5469 #ifdef PERL_COPY_ON_WRITE
5470 else if (SvPVX(sv)) {
5472 /* I believe I need to grab the global SV mutex here and
5473 then recheck the COW status. */
5475 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5478 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5479 SvUVX(sv), SV_COW_NEXT_SV(sv));
5480 /* And drop it here. */
5482 } else if (SvLEN(sv)) {
5483 Safefree(SvPVX(sv));
5487 else if (SvPVX(sv) && SvLEN(sv))
5488 Safefree(SvPVX(sv));
5489 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5490 unsharepvn(SvPVX(sv),
5491 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5505 switch (SvTYPE(sv)) {
5521 del_XPVIV(SvANY(sv));
5524 del_XPVNV(SvANY(sv));
5527 del_XPVMG(SvANY(sv));
5530 del_XPVLV(SvANY(sv));
5533 del_XPVAV(SvANY(sv));
5536 del_XPVHV(SvANY(sv));
5539 del_XPVCV(SvANY(sv));
5542 del_XPVGV(SvANY(sv));
5543 /* code duplication for increased performance. */
5544 SvFLAGS(sv) &= SVf_BREAK;
5545 SvFLAGS(sv) |= SVTYPEMASK;
5546 /* decrease refcount of the stash that owns this GV, if any */
5548 SvREFCNT_dec(stash);
5549 return; /* not break, SvFLAGS reset already happened */
5551 del_XPVBM(SvANY(sv));
5554 del_XPVFM(SvANY(sv));
5557 del_XPVIO(SvANY(sv));
5560 SvFLAGS(sv) &= SVf_BREAK;
5561 SvFLAGS(sv) |= SVTYPEMASK;
5565 =for apidoc sv_newref
5567 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5574 Perl_sv_newref(pTHX_ SV *sv)
5584 Decrement an SV's reference count, and if it drops to zero, call
5585 C<sv_clear> to invoke destructors and free up any memory used by
5586 the body; finally, deallocate the SV's head itself.
5587 Normally called via a wrapper macro C<SvREFCNT_dec>.
5593 Perl_sv_free(pTHX_ SV *sv)
5597 if (SvREFCNT(sv) == 0) {
5598 if (SvFLAGS(sv) & SVf_BREAK)
5599 /* this SV's refcnt has been artificially decremented to
5600 * trigger cleanup */
5602 if (PL_in_clean_all) /* All is fair */
5604 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5605 /* make sure SvREFCNT(sv)==0 happens very seldom */
5606 SvREFCNT(sv) = (~(U32)0)/2;
5609 if (ckWARN_d(WARN_INTERNAL))
5610 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5611 "Attempt to free unreferenced scalar: SV 0x%"UVxf,
5615 if (--(SvREFCNT(sv)) > 0)
5617 Perl_sv_free2(aTHX_ sv);
5621 Perl_sv_free2(pTHX_ SV *sv)
5625 if (ckWARN_d(WARN_DEBUGGING))
5626 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5627 "Attempt to free temp prematurely: SV 0x%"UVxf,
5632 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5633 /* make sure SvREFCNT(sv)==0 happens very seldom */
5634 SvREFCNT(sv) = (~(U32)0)/2;
5645 Returns the length of the string in the SV. Handles magic and type
5646 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5652 Perl_sv_len(pTHX_ register SV *sv)
5660 len = mg_length(sv);
5662 (void)SvPV(sv, len);
5667 =for apidoc sv_len_utf8
5669 Returns the number of characters in the string in an SV, counting wide
5670 UTF-8 bytes as a single character. Handles magic and type coercion.
5676 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5677 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5678 * (Note that the mg_len is not the length of the mg_ptr field.)
5683 Perl_sv_len_utf8(pTHX_ register SV *sv)
5689 return mg_length(sv);
5693 U8 *s = (U8*)SvPV(sv, len);
5694 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5696 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5698 #ifdef PERL_UTF8_CACHE_ASSERT
5699 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5703 ulen = Perl_utf8_length(aTHX_ s, s + len);
5704 if (!mg && !SvREADONLY(sv)) {
5705 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5706 mg = mg_find(sv, PERL_MAGIC_utf8);
5716 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5717 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5718 * between UTF-8 and byte offsets. There are two (substr offset and substr
5719 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5720 * and byte offset) cache positions.
5722 * The mg_len field is used by sv_len_utf8(), see its comments.
5723 * Note that the mg_len is not the length of the mg_ptr field.
5727 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
5731 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5733 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5734 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5739 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5741 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5742 (*mgp)->mg_ptr = (char *) *cachep;
5746 (*cachep)[i] = *offsetp;
5747 (*cachep)[i+1] = s - start;
5755 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5756 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5757 * between UTF-8 and byte offsets. See also the comments of
5758 * S_utf8_mg_pos_init().
5762 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
5766 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5768 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5769 if (*mgp && (*mgp)->mg_ptr) {
5770 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5771 ASSERT_UTF8_CACHE(*cachep);
5772 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5774 else { /* We will skip to the right spot. */
5779 /* The assumption is that going backward is half
5780 * the speed of going forward (that's where the
5781 * 2 * backw in the below comes from). (The real
5782 * figure of course depends on the UTF-8 data.) */
5784 if ((*cachep)[i] > (STRLEN)uoff) {
5786 backw = (*cachep)[i] - (STRLEN)uoff;
5788 if (forw < 2 * backw)
5791 p = start + (*cachep)[i+1];
5793 /* Try this only for the substr offset (i == 0),
5794 * not for the substr length (i == 2). */
5795 else if (i == 0) { /* (*cachep)[i] < uoff */
5796 STRLEN ulen = sv_len_utf8(sv);
5798 if ((STRLEN)uoff < ulen) {
5799 forw = (STRLEN)uoff - (*cachep)[i];
5800 backw = ulen - (STRLEN)uoff;
5802 if (forw < 2 * backw)
5803 p = start + (*cachep)[i+1];
5808 /* If the string is not long enough for uoff,
5809 * we could extend it, but not at this low a level. */
5813 if (forw < 2 * backw) {
5820 while (UTF8_IS_CONTINUATION(*p))
5825 /* Update the cache. */
5826 (*cachep)[i] = (STRLEN)uoff;
5827 (*cachep)[i+1] = p - start;
5832 if (found) { /* Setup the return values. */
5833 *offsetp = (*cachep)[i+1];
5834 *sp = start + *offsetp;
5837 *offsetp = send - start;
5839 else if (*sp < start) {
5845 #ifdef PERL_UTF8_CACHE_ASSERT
5850 while (n-- && s < send)
5854 assert(*offsetp == s - start);
5855 assert((*cachep)[0] == (STRLEN)uoff);
5856 assert((*cachep)[1] == *offsetp);
5858 ASSERT_UTF8_CACHE(*cachep);
5867 =for apidoc sv_pos_u2b
5869 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5870 the start of the string, to a count of the equivalent number of bytes; if
5871 lenp is non-zero, it does the same to lenp, but this time starting from
5872 the offset, rather than from the start of the string. Handles magic and
5879 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5880 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5881 * byte offsets. See also the comments of S_utf8_mg_pos().
5886 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5897 start = s = (U8*)SvPV(sv, len);
5899 I32 uoffset = *offsetp;
5904 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5906 if (!found && uoffset > 0) {
5907 while (s < send && uoffset--)
5911 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
5913 *offsetp = s - start;
5918 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
5922 if (!found && *lenp > 0) {
5925 while (s < send && ulen--)
5929 if (utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start))
5930 cache[2] += *offsetp;
5934 ASSERT_UTF8_CACHE(cache);
5946 =for apidoc sv_pos_b2u
5948 Converts the value pointed to by offsetp from a count of bytes from the
5949 start of the string, to a count of the equivalent number of UTF-8 chars.
5950 Handles magic and type coercion.
5956 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5957 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5958 * byte offsets. See also the comments of S_utf8_mg_pos().
5963 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5971 s = (U8*)SvPV(sv, len);
5972 if ((I32)len < *offsetp)
5973 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5975 U8* send = s + *offsetp;
5977 STRLEN *cache = NULL;
5981 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5982 mg = mg_find(sv, PERL_MAGIC_utf8);
5983 if (mg && mg->mg_ptr) {
5984 cache = (STRLEN *) mg->mg_ptr;
5985 if (cache[1] == (STRLEN)*offsetp) {
5986 /* An exact match. */
5987 *offsetp = cache[0];
5991 else if (cache[1] < (STRLEN)*offsetp) {
5992 /* We already know part of the way. */
5995 /* Let the below loop do the rest. */
5997 else { /* cache[1] > *offsetp */
5998 /* We already know all of the way, now we may
5999 * be able to walk back. The same assumption
6000 * is made as in S_utf8_mg_pos(), namely that
6001 * walking backward is twice slower than
6002 * walking forward. */
6003 STRLEN forw = *offsetp;
6004 STRLEN backw = cache[1] - *offsetp;
6006 if (!(forw < 2 * backw)) {
6007 U8 *p = s + cache[1];
6014 while (UTF8_IS_CONTINUATION(*p)) {
6022 *offsetp = cache[0];
6027 ASSERT_UTF8_CACHE(cache);
6033 /* Call utf8n_to_uvchr() to validate the sequence
6034 * (unless a simple non-UTF character) */
6035 if (!UTF8_IS_INVARIANT(*s))
6036 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6045 if (!SvREADONLY(sv)) {
6047 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6048 mg = mg_find(sv, PERL_MAGIC_utf8);
6053 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6054 mg->mg_ptr = (char *) cache;
6059 cache[1] = *offsetp;
6070 Returns a boolean indicating whether the strings in the two SVs are
6071 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6072 coerce its args to strings if necessary.
6078 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6086 SV* svrecode = Nullsv;
6093 pv1 = SvPV(sv1, cur1);
6100 pv2 = SvPV(sv2, cur2);
6102 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6103 /* Differing utf8ness.
6104 * Do not UTF8size the comparands as a side-effect. */
6107 svrecode = newSVpvn(pv2, cur2);
6108 sv_recode_to_utf8(svrecode, PL_encoding);
6109 pv2 = SvPV(svrecode, cur2);
6112 svrecode = newSVpvn(pv1, cur1);
6113 sv_recode_to_utf8(svrecode, PL_encoding);
6114 pv1 = SvPV(svrecode, cur1);
6116 /* Now both are in UTF-8. */
6121 bool is_utf8 = TRUE;
6124 /* sv1 is the UTF-8 one,
6125 * if is equal it must be downgrade-able */
6126 char *pv = (char*)bytes_from_utf8((U8*)pv1,
6132 /* sv2 is the UTF-8 one,
6133 * if is equal it must be downgrade-able */
6134 char *pv = (char *)bytes_from_utf8((U8*)pv2,
6140 /* Downgrade not possible - cannot be eq */
6147 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6150 SvREFCNT_dec(svrecode);
6161 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6162 string in C<sv1> is less than, equal to, or greater than the string in
6163 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6164 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6170 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6173 char *pv1, *pv2, *tpv = Nullch;
6175 SV *svrecode = Nullsv;
6182 pv1 = SvPV(sv1, cur1);
6189 pv2 = SvPV(sv2, cur2);
6191 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6192 /* Differing utf8ness.
6193 * Do not UTF8size the comparands as a side-effect. */
6196 svrecode = newSVpvn(pv2, cur2);
6197 sv_recode_to_utf8(svrecode, PL_encoding);
6198 pv2 = SvPV(svrecode, cur2);
6201 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
6206 svrecode = newSVpvn(pv1, cur1);
6207 sv_recode_to_utf8(svrecode, PL_encoding);
6208 pv1 = SvPV(svrecode, cur1);
6211 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
6217 cmp = cur2 ? -1 : 0;
6221 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6224 cmp = retval < 0 ? -1 : 1;
6225 } else if (cur1 == cur2) {
6228 cmp = cur1 < cur2 ? -1 : 1;
6233 SvREFCNT_dec(svrecode);
6242 =for apidoc sv_cmp_locale
6244 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6245 'use bytes' aware, handles get magic, and will coerce its args to strings
6246 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6252 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6254 #ifdef USE_LOCALE_COLLATE
6260 if (PL_collation_standard)
6264 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6266 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6268 if (!pv1 || !len1) {
6279 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6282 return retval < 0 ? -1 : 1;
6285 * When the result of collation is equality, that doesn't mean
6286 * that there are no differences -- some locales exclude some
6287 * characters from consideration. So to avoid false equalities,
6288 * we use the raw string as a tiebreaker.
6294 #endif /* USE_LOCALE_COLLATE */
6296 return sv_cmp(sv1, sv2);
6300 #ifdef USE_LOCALE_COLLATE
6303 =for apidoc sv_collxfrm
6305 Add Collate Transform magic to an SV if it doesn't already have it.
6307 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6308 scalar data of the variable, but transformed to such a format that a normal
6309 memory comparison can be used to compare the data according to the locale
6316 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6320 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6321 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6326 Safefree(mg->mg_ptr);
6328 if ((xf = mem_collxfrm(s, len, &xlen))) {
6329 if (SvREADONLY(sv)) {
6332 return xf + sizeof(PL_collation_ix);
6335 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6336 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6349 if (mg && mg->mg_ptr) {
6351 return mg->mg_ptr + sizeof(PL_collation_ix);
6359 #endif /* USE_LOCALE_COLLATE */
6364 Get a line from the filehandle and store it into the SV, optionally
6365 appending to the currently-stored string.
6371 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6375 register STDCHAR rslast;
6376 register STDCHAR *bp;
6382 if (SvTHINKFIRST(sv))
6383 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6384 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6386 However, perlbench says it's slower, because the existing swipe code
6387 is faster than copy on write.
6388 Swings and roundabouts. */
6389 (void)SvUPGRADE(sv, SVt_PV);
6394 if (PerlIO_isutf8(fp)) {
6396 sv_utf8_upgrade_nomg(sv);
6397 sv_pos_u2b(sv,&append,0);
6399 } else if (SvUTF8(sv)) {
6400 SV *tsv = NEWSV(0,0);
6401 sv_gets(tsv, fp, 0);
6402 sv_utf8_upgrade_nomg(tsv);
6403 SvCUR_set(sv,append);
6406 goto return_string_or_null;
6411 if (PerlIO_isutf8(fp))
6414 if (IN_PERL_COMPILETIME) {
6415 /* we always read code in line mode */
6419 else if (RsSNARF(PL_rs)) {
6420 /* If it is a regular disk file use size from stat() as estimate
6421 of amount we are going to read - may result in malloc-ing
6422 more memory than we realy need if layers bellow reduce
6423 size we read (e.g. CRLF or a gzip layer)
6426 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6427 Off_t offset = PerlIO_tell(fp);
6428 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6429 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6435 else if (RsRECORD(PL_rs)) {
6439 /* Grab the size of the record we're getting */
6440 recsize = SvIV(SvRV(PL_rs));
6441 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6444 /* VMS wants read instead of fread, because fread doesn't respect */
6445 /* RMS record boundaries. This is not necessarily a good thing to be */
6446 /* doing, but we've got no other real choice - except avoid stdio
6447 as implementation - perhaps write a :vms layer ?
6449 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6451 bytesread = PerlIO_read(fp, buffer, recsize);
6455 SvCUR_set(sv, bytesread += append);
6456 buffer[bytesread] = '\0';
6457 goto return_string_or_null;
6459 else if (RsPARA(PL_rs)) {
6465 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6466 if (PerlIO_isutf8(fp)) {
6467 rsptr = SvPVutf8(PL_rs, rslen);
6470 if (SvUTF8(PL_rs)) {
6471 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6472 Perl_croak(aTHX_ "Wide character in $/");
6475 rsptr = SvPV(PL_rs, rslen);
6479 rslast = rslen ? rsptr[rslen - 1] : '\0';
6481 if (rspara) { /* have to do this both before and after */
6482 do { /* to make sure file boundaries work right */
6485 i = PerlIO_getc(fp);
6489 PerlIO_ungetc(fp,i);
6495 /* See if we know enough about I/O mechanism to cheat it ! */
6497 /* This used to be #ifdef test - it is made run-time test for ease
6498 of abstracting out stdio interface. One call should be cheap
6499 enough here - and may even be a macro allowing compile
6503 if (PerlIO_fast_gets(fp)) {
6506 * We're going to steal some values from the stdio struct
6507 * and put EVERYTHING in the innermost loop into registers.
6509 register STDCHAR *ptr;
6513 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6514 /* An ungetc()d char is handled separately from the regular
6515 * buffer, so we getc() it back out and stuff it in the buffer.
6517 i = PerlIO_getc(fp);
6518 if (i == EOF) return 0;
6519 *(--((*fp)->_ptr)) = (unsigned char) i;
6523 /* Here is some breathtakingly efficient cheating */
6525 cnt = PerlIO_get_cnt(fp); /* get count into register */
6526 /* make sure we have the room */
6527 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6528 /* Not room for all of it
6529 if we are looking for a separator and room for some
6531 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6532 /* just process what we have room for */
6533 shortbuffered = cnt - SvLEN(sv) + append + 1;
6534 cnt -= shortbuffered;
6538 /* remember that cnt can be negative */
6539 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6544 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
6545 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6546 DEBUG_P(PerlIO_printf(Perl_debug_log,
6547 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6548 DEBUG_P(PerlIO_printf(Perl_debug_log,
6549 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6550 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6551 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6556 while (cnt > 0) { /* this | eat */
6558 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6559 goto thats_all_folks; /* screams | sed :-) */
6563 Copy(ptr, bp, cnt, char); /* this | eat */
6564 bp += cnt; /* screams | dust */
6565 ptr += cnt; /* louder | sed :-) */
6570 if (shortbuffered) { /* oh well, must extend */
6571 cnt = shortbuffered;
6573 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6575 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6576 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6580 DEBUG_P(PerlIO_printf(Perl_debug_log,
6581 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6582 PTR2UV(ptr),(long)cnt));
6583 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6585 DEBUG_P(PerlIO_printf(Perl_debug_log,
6586 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6587 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6588 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6590 /* This used to call 'filbuf' in stdio form, but as that behaves like
6591 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6592 another abstraction. */
6593 i = PerlIO_getc(fp); /* get more characters */
6595 DEBUG_P(PerlIO_printf(Perl_debug_log,
6596 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6597 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6598 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6600 cnt = PerlIO_get_cnt(fp);
6601 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6602 DEBUG_P(PerlIO_printf(Perl_debug_log,
6603 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6605 if (i == EOF) /* all done for ever? */
6606 goto thats_really_all_folks;
6608 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6610 SvGROW(sv, bpx + cnt + 2);
6611 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6613 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6615 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6616 goto thats_all_folks;
6620 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
6621 memNE((char*)bp - rslen, rsptr, rslen))
6622 goto screamer; /* go back to the fray */
6623 thats_really_all_folks:
6625 cnt += shortbuffered;
6626 DEBUG_P(PerlIO_printf(Perl_debug_log,
6627 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6628 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6629 DEBUG_P(PerlIO_printf(Perl_debug_log,
6630 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6631 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6632 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6634 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
6635 DEBUG_P(PerlIO_printf(Perl_debug_log,
6636 "Screamer: done, len=%ld, string=|%.*s|\n",
6637 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
6641 /*The big, slow, and stupid way. */
6643 /* Any stack-challenged places. */
6645 /* EPOC: need to work around SDK features. *
6646 * On WINS: MS VC5 generates calls to _chkstk, *
6647 * if a "large" stack frame is allocated. *
6648 * gcc on MARM does not generate calls like these. */
6649 # define USEHEAPINSTEADOFSTACK
6652 #ifdef USEHEAPINSTEADOFSTACK
6654 New(0, buf, 8192, STDCHAR);
6662 register STDCHAR *bpe = buf + sizeof(buf);
6664 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6665 ; /* keep reading */
6669 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6670 /* Accomodate broken VAXC compiler, which applies U8 cast to
6671 * both args of ?: operator, causing EOF to change into 255
6674 i = (U8)buf[cnt - 1];
6680 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6682 sv_catpvn(sv, (char *) buf, cnt);
6684 sv_setpvn(sv, (char *) buf, cnt);
6686 if (i != EOF && /* joy */
6688 SvCUR(sv) < rslen ||
6689 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6693 * If we're reading from a TTY and we get a short read,
6694 * indicating that the user hit his EOF character, we need
6695 * to notice it now, because if we try to read from the TTY
6696 * again, the EOF condition will disappear.
6698 * The comparison of cnt to sizeof(buf) is an optimization
6699 * that prevents unnecessary calls to feof().
6703 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6707 #ifdef USEHEAPINSTEADOFSTACK
6712 if (rspara) { /* have to do this both before and after */
6713 while (i != EOF) { /* to make sure file boundaries work right */
6714 i = PerlIO_getc(fp);
6716 PerlIO_ungetc(fp,i);
6722 return_string_or_null:
6723 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6729 Auto-increment of the value in the SV, doing string to numeric conversion
6730 if necessary. Handles 'get' magic.
6736 Perl_sv_inc(pTHX_ register SV *sv)
6745 if (SvTHINKFIRST(sv)) {
6747 sv_force_normal_flags(sv, 0);
6748 if (SvREADONLY(sv)) {
6749 if (IN_PERL_RUNTIME)
6750 Perl_croak(aTHX_ PL_no_modify);
6754 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6756 i = PTR2IV(SvRV(sv));
6761 flags = SvFLAGS(sv);
6762 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6763 /* It's (privately or publicly) a float, but not tested as an
6764 integer, so test it to see. */
6766 flags = SvFLAGS(sv);
6768 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6769 /* It's publicly an integer, or privately an integer-not-float */
6770 #ifdef PERL_PRESERVE_IVUV
6774 if (SvUVX(sv) == UV_MAX)
6775 sv_setnv(sv, UV_MAX_P1);
6777 (void)SvIOK_only_UV(sv);
6780 if (SvIVX(sv) == IV_MAX)
6781 sv_setuv(sv, (UV)IV_MAX + 1);
6783 (void)SvIOK_only(sv);
6789 if (flags & SVp_NOK) {
6790 (void)SvNOK_only(sv);
6795 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
6796 if ((flags & SVTYPEMASK) < SVt_PVIV)
6797 sv_upgrade(sv, SVt_IV);
6798 (void)SvIOK_only(sv);
6803 while (isALPHA(*d)) d++;
6804 while (isDIGIT(*d)) d++;
6806 #ifdef PERL_PRESERVE_IVUV
6807 /* Got to punt this as an integer if needs be, but we don't issue
6808 warnings. Probably ought to make the sv_iv_please() that does
6809 the conversion if possible, and silently. */
6810 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6811 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6812 /* Need to try really hard to see if it's an integer.
6813 9.22337203685478e+18 is an integer.
6814 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6815 so $a="9.22337203685478e+18"; $a+0; $a++
6816 needs to be the same as $a="9.22337203685478e+18"; $a++
6823 /* sv_2iv *should* have made this an NV */
6824 if (flags & SVp_NOK) {
6825 (void)SvNOK_only(sv);
6829 /* I don't think we can get here. Maybe I should assert this
6830 And if we do get here I suspect that sv_setnv will croak. NWC
6832 #if defined(USE_LONG_DOUBLE)
6833 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",
6834 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6836 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6837 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6840 #endif /* PERL_PRESERVE_IVUV */
6841 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
6845 while (d >= SvPVX(sv)) {
6853 /* MKS: The original code here died if letters weren't consecutive.
6854 * at least it didn't have to worry about non-C locales. The
6855 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6856 * arranged in order (although not consecutively) and that only
6857 * [A-Za-z] are accepted by isALPHA in the C locale.
6859 if (*d != 'z' && *d != 'Z') {
6860 do { ++*d; } while (!isALPHA(*d));
6863 *(d--) -= 'z' - 'a';
6868 *(d--) -= 'z' - 'a' + 1;
6872 /* oh,oh, the number grew */
6873 SvGROW(sv, SvCUR(sv) + 2);
6875 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6886 Auto-decrement of the value in the SV, doing string to numeric conversion
6887 if necessary. Handles 'get' magic.
6893 Perl_sv_dec(pTHX_ register SV *sv)
6901 if (SvTHINKFIRST(sv)) {
6903 sv_force_normal_flags(sv, 0);
6904 if (SvREADONLY(sv)) {
6905 if (IN_PERL_RUNTIME)
6906 Perl_croak(aTHX_ PL_no_modify);
6910 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6912 i = PTR2IV(SvRV(sv));
6917 /* Unlike sv_inc we don't have to worry about string-never-numbers
6918 and keeping them magic. But we mustn't warn on punting */
6919 flags = SvFLAGS(sv);
6920 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6921 /* It's publicly an integer, or privately an integer-not-float */
6922 #ifdef PERL_PRESERVE_IVUV
6926 if (SvUVX(sv) == 0) {
6927 (void)SvIOK_only(sv);
6931 (void)SvIOK_only_UV(sv);
6935 if (SvIVX(sv) == IV_MIN)
6936 sv_setnv(sv, (NV)IV_MIN - 1.0);
6938 (void)SvIOK_only(sv);
6944 if (flags & SVp_NOK) {
6946 (void)SvNOK_only(sv);
6949 if (!(flags & SVp_POK)) {
6950 if ((flags & SVTYPEMASK) < SVt_PVNV)
6951 sv_upgrade(sv, SVt_NV);
6953 (void)SvNOK_only(sv);
6956 #ifdef PERL_PRESERVE_IVUV
6958 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6959 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6960 /* Need to try really hard to see if it's an integer.
6961 9.22337203685478e+18 is an integer.
6962 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6963 so $a="9.22337203685478e+18"; $a+0; $a--
6964 needs to be the same as $a="9.22337203685478e+18"; $a--
6971 /* sv_2iv *should* have made this an NV */
6972 if (flags & SVp_NOK) {
6973 (void)SvNOK_only(sv);
6977 /* I don't think we can get here. Maybe I should assert this
6978 And if we do get here I suspect that sv_setnv will croak. NWC
6980 #if defined(USE_LONG_DOUBLE)
6981 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",
6982 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6984 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6985 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6989 #endif /* PERL_PRESERVE_IVUV */
6990 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6994 =for apidoc sv_mortalcopy
6996 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6997 The new SV is marked as mortal. It will be destroyed "soon", either by an
6998 explicit call to FREETMPS, or by an implicit call at places such as
6999 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7004 /* Make a string that will exist for the duration of the expression
7005 * evaluation. Actually, it may have to last longer than that, but
7006 * hopefully we won't free it until it has been assigned to a
7007 * permanent location. */
7010 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7015 sv_setsv(sv,oldstr);
7017 PL_tmps_stack[++PL_tmps_ix] = sv;
7023 =for apidoc sv_newmortal
7025 Creates a new null SV which is mortal. The reference count of the SV is
7026 set to 1. It will be destroyed "soon", either by an explicit call to
7027 FREETMPS, or by an implicit call at places such as statement boundaries.
7028 See also C<sv_mortalcopy> and C<sv_2mortal>.
7034 Perl_sv_newmortal(pTHX)
7039 SvFLAGS(sv) = SVs_TEMP;
7041 PL_tmps_stack[++PL_tmps_ix] = sv;
7046 =for apidoc sv_2mortal
7048 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7049 by an explicit call to FREETMPS, or by an implicit call at places such as
7050 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
7056 Perl_sv_2mortal(pTHX_ register SV *sv)
7060 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7063 PL_tmps_stack[++PL_tmps_ix] = sv;
7071 Creates a new SV and copies a string into it. The reference count for the
7072 SV is set to 1. If C<len> is zero, Perl will compute the length using
7073 strlen(). For efficiency, consider using C<newSVpvn> instead.
7079 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7086 sv_setpvn(sv,s,len);
7091 =for apidoc newSVpvn
7093 Creates a new SV and copies a string into it. The reference count for the
7094 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7095 string. You are responsible for ensuring that the source string is at least
7102 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7107 sv_setpvn(sv,s,len);
7112 =for apidoc newSVpvn_share
7114 Creates a new SV with its SvPVX pointing to a shared string in the string
7115 table. If the string does not already exist in the table, it is created
7116 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7117 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7118 otherwise the hash is computed. The idea here is that as the string table
7119 is used for shared hash keys these strings will have SvPVX == HeKEY and
7120 hash lookup will avoid string compare.
7126 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7129 bool is_utf8 = FALSE;
7131 STRLEN tmplen = -len;
7133 /* See the note in hv.c:hv_fetch() --jhi */
7134 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
7138 PERL_HASH(hash, src, len);
7140 sv_upgrade(sv, SVt_PVIV);
7141 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
7154 #if defined(PERL_IMPLICIT_CONTEXT)
7156 /* pTHX_ magic can't cope with varargs, so this is a no-context
7157 * version of the main function, (which may itself be aliased to us).
7158 * Don't access this version directly.
7162 Perl_newSVpvf_nocontext(const char* pat, ...)
7167 va_start(args, pat);
7168 sv = vnewSVpvf(pat, &args);
7175 =for apidoc newSVpvf
7177 Creates a new SV and initializes it with the string formatted like
7184 Perl_newSVpvf(pTHX_ const char* pat, ...)
7188 va_start(args, pat);
7189 sv = vnewSVpvf(pat, &args);
7194 /* backend for newSVpvf() and newSVpvf_nocontext() */
7197 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7201 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7208 Creates a new SV and copies a floating point value into it.
7209 The reference count for the SV is set to 1.
7215 Perl_newSVnv(pTHX_ NV n)
7227 Creates a new SV and copies an integer into it. The reference count for the
7234 Perl_newSViv(pTHX_ IV i)
7246 Creates a new SV and copies an unsigned integer into it.
7247 The reference count for the SV is set to 1.
7253 Perl_newSVuv(pTHX_ UV u)
7263 =for apidoc newRV_noinc
7265 Creates an RV wrapper for an SV. The reference count for the original
7266 SV is B<not> incremented.
7272 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7277 sv_upgrade(sv, SVt_RV);
7284 /* newRV_inc is the official function name to use now.
7285 * newRV_inc is in fact #defined to newRV in sv.h
7289 Perl_newRV(pTHX_ SV *tmpRef)
7291 return newRV_noinc(SvREFCNT_inc(tmpRef));
7297 Creates a new SV which is an exact duplicate of the original SV.
7304 Perl_newSVsv(pTHX_ register SV *old)
7310 if (SvTYPE(old) == SVTYPEMASK) {
7311 if (ckWARN_d(WARN_INTERNAL))
7312 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7327 =for apidoc sv_reset
7329 Underlying implementation for the C<reset> Perl function.
7330 Note that the perl-level function is vaguely deprecated.
7336 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7344 char todo[PERL_UCHAR_MAX+1];
7349 if (!*s) { /* reset ?? searches */
7350 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7351 pm->op_pmdynflags &= ~PMdf_USED;
7356 /* reset variables */
7358 if (!HvARRAY(stash))
7361 Zero(todo, 256, char);
7363 i = (unsigned char)*s;
7367 max = (unsigned char)*s++;
7368 for ( ; i <= max; i++) {
7371 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7372 for (entry = HvARRAY(stash)[i];
7374 entry = HeNEXT(entry))
7376 if (!todo[(U8)*HeKEY(entry)])
7378 gv = (GV*)HeVAL(entry);
7380 if (SvTHINKFIRST(sv)) {
7381 if (!SvREADONLY(sv) && SvROK(sv))
7386 if (SvTYPE(sv) >= SVt_PV) {
7388 if (SvPVX(sv) != Nullch)
7395 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7398 #ifdef USE_ENVIRON_ARRAY
7400 # ifdef USE_ITHREADS
7401 && PL_curinterp == aTHX
7405 environ[0] = Nullch;
7408 #endif /* !PERL_MICRO */
7418 Using various gambits, try to get an IO from an SV: the IO slot if its a
7419 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7420 named after the PV if we're a string.
7426 Perl_sv_2io(pTHX_ SV *sv)
7432 switch (SvTYPE(sv)) {
7440 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7444 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7446 return sv_2io(SvRV(sv));
7447 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7453 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7462 Using various gambits, try to get a CV from an SV; in addition, try if
7463 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7469 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7476 return *gvp = Nullgv, Nullcv;
7477 switch (SvTYPE(sv)) {
7496 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7497 tryAMAGICunDEREF(to_cv);
7500 if (SvTYPE(sv) == SVt_PVCV) {
7509 Perl_croak(aTHX_ "Not a subroutine reference");
7514 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
7520 if (lref && !GvCVu(gv)) {
7523 tmpsv = NEWSV(704,0);
7524 gv_efullname3(tmpsv, gv, Nullch);
7525 /* XXX this is probably not what they think they're getting.
7526 * It has the same effect as "sub name;", i.e. just a forward
7528 newSUB(start_subparse(FALSE, 0),
7529 newSVOP(OP_CONST, 0, tmpsv),
7534 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7544 Returns true if the SV has a true value by Perl's rules.
7545 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7546 instead use an in-line version.
7552 Perl_sv_true(pTHX_ register SV *sv)
7558 if ((tXpv = (XPV*)SvANY(sv)) &&
7559 (tXpv->xpv_cur > 1 ||
7560 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
7567 return SvIVX(sv) != 0;
7570 return SvNVX(sv) != 0.0;
7572 return sv_2bool(sv);
7580 A private implementation of the C<SvIVx> macro for compilers which can't
7581 cope with complex macro expressions. Always use the macro instead.
7587 Perl_sv_iv(pTHX_ register SV *sv)
7591 return (IV)SvUVX(sv);
7600 A private implementation of the C<SvUVx> macro for compilers which can't
7601 cope with complex macro expressions. Always use the macro instead.
7607 Perl_sv_uv(pTHX_ register SV *sv)
7612 return (UV)SvIVX(sv);
7620 A private implementation of the C<SvNVx> macro for compilers which can't
7621 cope with complex macro expressions. Always use the macro instead.
7627 Perl_sv_nv(pTHX_ register SV *sv)
7634 /* sv_pv() is now a macro using SvPV_nolen();
7635 * this function provided for binary compatibility only
7639 Perl_sv_pv(pTHX_ SV *sv)
7646 return sv_2pv(sv, &n_a);
7652 Use the C<SvPV_nolen> macro instead
7656 A private implementation of the C<SvPV> macro for compilers which can't
7657 cope with complex macro expressions. Always use the macro instead.
7663 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7669 return sv_2pv(sv, lp);
7674 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7680 return sv_2pv_flags(sv, lp, 0);
7683 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7684 * this function provided for binary compatibility only
7688 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7690 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7694 =for apidoc sv_pvn_force
7696 Get a sensible string out of the SV somehow.
7697 A private implementation of the C<SvPV_force> macro for compilers which
7698 can't cope with complex macro expressions. Always use the macro instead.
7700 =for apidoc sv_pvn_force_flags
7702 Get a sensible string out of the SV somehow.
7703 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7704 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7705 implemented in terms of this function.
7706 You normally want to use the various wrapper macros instead: see
7707 C<SvPV_force> and C<SvPV_force_nomg>
7713 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7717 if (SvTHINKFIRST(sv) && !SvROK(sv))
7718 sv_force_normal_flags(sv, 0);
7724 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7725 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7729 s = sv_2pv_flags(sv, lp, flags);
7730 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
7735 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7736 SvGROW(sv, len + 1);
7737 Move(s,SvPVX(sv),len,char);
7742 SvPOK_on(sv); /* validate pointer */
7744 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7745 PTR2UV(sv),SvPVX(sv)));
7751 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7752 * this function provided for binary compatibility only
7756 Perl_sv_pvbyte(pTHX_ SV *sv)
7758 sv_utf8_downgrade(sv,0);
7763 =for apidoc sv_pvbyte
7765 Use C<SvPVbyte_nolen> instead.
7767 =for apidoc sv_pvbyten
7769 A private implementation of the C<SvPVbyte> macro for compilers
7770 which can't cope with complex macro expressions. Always use the macro
7777 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7779 sv_utf8_downgrade(sv,0);
7780 return sv_pvn(sv,lp);
7784 =for apidoc sv_pvbyten_force
7786 A private implementation of the C<SvPVbytex_force> macro for compilers
7787 which can't cope with complex macro expressions. Always use the macro
7794 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7796 sv_utf8_downgrade(sv,0);
7797 return sv_pvn_force(sv,lp);
7800 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
7801 * this function provided for binary compatibility only
7805 Perl_sv_pvutf8(pTHX_ SV *sv)
7807 sv_utf8_upgrade(sv);
7812 =for apidoc sv_pvutf8
7814 Use the C<SvPVutf8_nolen> macro instead
7816 =for apidoc sv_pvutf8n
7818 A private implementation of the C<SvPVutf8> macro for compilers
7819 which can't cope with complex macro expressions. Always use the macro
7826 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7828 sv_utf8_upgrade(sv);
7829 return sv_pvn(sv,lp);
7833 =for apidoc sv_pvutf8n_force
7835 A private implementation of the C<SvPVutf8_force> macro for compilers
7836 which can't cope with complex macro expressions. Always use the macro
7843 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7845 sv_utf8_upgrade(sv);
7846 return sv_pvn_force(sv,lp);
7850 =for apidoc sv_reftype
7852 Returns a string describing what the SV is a reference to.
7858 Perl_sv_reftype(pTHX_ SV *sv, int ob)
7860 if (ob && SvOBJECT(sv)) {
7861 if (HvNAME(SvSTASH(sv)))
7862 return HvNAME(SvSTASH(sv));
7867 switch (SvTYPE(sv)) {
7884 case SVt_PVLV: return SvROK(sv) ? "REF"
7885 /* tied lvalues should appear to be
7886 * scalars for backwards compatitbility */
7887 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7888 ? "SCALAR" : "LVALUE";
7889 case SVt_PVAV: return "ARRAY";
7890 case SVt_PVHV: return "HASH";
7891 case SVt_PVCV: return "CODE";
7892 case SVt_PVGV: return "GLOB";
7893 case SVt_PVFM: return "FORMAT";
7894 case SVt_PVIO: return "IO";
7895 default: return "UNKNOWN";
7901 =for apidoc sv_isobject
7903 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7904 object. If the SV is not an RV, or if the object is not blessed, then this
7911 Perl_sv_isobject(pTHX_ SV *sv)
7928 Returns a boolean indicating whether the SV is blessed into the specified
7929 class. This does not check for subtypes; use C<sv_derived_from> to verify
7930 an inheritance relationship.
7936 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7947 if (!HvNAME(SvSTASH(sv)))
7950 return strEQ(HvNAME(SvSTASH(sv)), name);
7956 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7957 it will be upgraded to one. If C<classname> is non-null then the new SV will
7958 be blessed in the specified package. The new SV is returned and its
7959 reference count is 1.
7965 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7971 SV_CHECK_THINKFIRST_COW_DROP(rv);
7974 if (SvTYPE(rv) >= SVt_PVMG) {
7975 U32 refcnt = SvREFCNT(rv);
7979 SvREFCNT(rv) = refcnt;
7982 if (SvTYPE(rv) < SVt_RV)
7983 sv_upgrade(rv, SVt_RV);
7984 else if (SvTYPE(rv) > SVt_RV) {
7985 (void)SvOOK_off(rv);
7986 if (SvPVX(rv) && SvLEN(rv))
7987 Safefree(SvPVX(rv));
7997 HV* stash = gv_stashpv(classname, TRUE);
7998 (void)sv_bless(rv, stash);
8004 =for apidoc sv_setref_pv
8006 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8007 argument will be upgraded to an RV. That RV will be modified to point to
8008 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8009 into the SV. The C<classname> argument indicates the package for the
8010 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8011 will have a reference count of 1, and the RV will be returned.
8013 Do not use with other Perl types such as HV, AV, SV, CV, because those
8014 objects will become corrupted by the pointer copy process.
8016 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8022 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8025 sv_setsv(rv, &PL_sv_undef);
8029 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8034 =for apidoc sv_setref_iv
8036 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8037 argument will be upgraded to an RV. That RV will be modified to point to
8038 the new SV. The C<classname> argument indicates the package for the
8039 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8040 will have a reference count of 1, and the RV will be returned.
8046 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8048 sv_setiv(newSVrv(rv,classname), iv);
8053 =for apidoc sv_setref_uv
8055 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8056 argument will be upgraded to an RV. That RV will be modified to point to
8057 the new SV. The C<classname> argument indicates the package for the
8058 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8059 will have a reference count of 1, and the RV will be returned.
8065 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8067 sv_setuv(newSVrv(rv,classname), uv);
8072 =for apidoc sv_setref_nv
8074 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8075 argument will be upgraded to an RV. That RV will be modified to point to
8076 the new SV. The C<classname> argument indicates the package for the
8077 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8078 will have a reference count of 1, and the RV will be returned.
8084 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8086 sv_setnv(newSVrv(rv,classname), nv);
8091 =for apidoc sv_setref_pvn
8093 Copies a string into a new SV, optionally blessing the SV. The length of the
8094 string must be specified with C<n>. The C<rv> argument will be upgraded to
8095 an RV. That RV will be modified to point to the new SV. The C<classname>
8096 argument indicates the package for the blessing. Set C<classname> to
8097 C<Nullch> to avoid the blessing. The new SV will have a reference count
8098 of 1, and the RV will be returned.
8100 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8106 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8108 sv_setpvn(newSVrv(rv,classname), pv, n);
8113 =for apidoc sv_bless
8115 Blesses an SV into a specified package. The SV must be an RV. The package
8116 must be designated by its stash (see C<gv_stashpv()>). The reference count
8117 of the SV is unaffected.
8123 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8127 Perl_croak(aTHX_ "Can't bless non-reference value");
8129 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8130 if (SvREADONLY(tmpRef))
8131 Perl_croak(aTHX_ PL_no_modify);
8132 if (SvOBJECT(tmpRef)) {
8133 if (SvTYPE(tmpRef) != SVt_PVIO)
8135 SvREFCNT_dec(SvSTASH(tmpRef));
8138 SvOBJECT_on(tmpRef);
8139 if (SvTYPE(tmpRef) != SVt_PVIO)
8141 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8142 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
8149 if(SvSMAGICAL(tmpRef))
8150 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8158 /* Downgrades a PVGV to a PVMG.
8162 S_sv_unglob(pTHX_ SV *sv)
8166 assert(SvTYPE(sv) == SVt_PVGV);
8171 SvREFCNT_dec(GvSTASH(sv));
8172 GvSTASH(sv) = Nullhv;
8174 sv_unmagic(sv, PERL_MAGIC_glob);
8175 Safefree(GvNAME(sv));
8178 /* need to keep SvANY(sv) in the right arena */
8179 xpvmg = new_XPVMG();
8180 StructCopy(SvANY(sv), xpvmg, XPVMG);
8181 del_XPVGV(SvANY(sv));
8184 SvFLAGS(sv) &= ~SVTYPEMASK;
8185 SvFLAGS(sv) |= SVt_PVMG;
8189 =for apidoc sv_unref_flags
8191 Unsets the RV status of the SV, and decrements the reference count of
8192 whatever was being referenced by the RV. This can almost be thought of
8193 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8194 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8195 (otherwise the decrementing is conditional on the reference count being
8196 different from one or the reference being a readonly SV).
8203 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8207 if (SvWEAKREF(sv)) {
8215 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8216 assigned to as BEGIN {$a = \"Foo"} will fail. */
8217 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8219 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8220 sv_2mortal(rv); /* Schedule for freeing later */
8224 =for apidoc sv_unref
8226 Unsets the RV status of the SV, and decrements the reference count of
8227 whatever was being referenced by the RV. This can almost be thought of
8228 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8229 being zero. See C<SvROK_off>.
8235 Perl_sv_unref(pTHX_ SV *sv)
8237 sv_unref_flags(sv, 0);
8241 =for apidoc sv_taint
8243 Taint an SV. Use C<SvTAINTED_on> instead.
8248 Perl_sv_taint(pTHX_ SV *sv)
8250 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8254 =for apidoc sv_untaint
8256 Untaint an SV. Use C<SvTAINTED_off> instead.
8261 Perl_sv_untaint(pTHX_ SV *sv)
8263 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8264 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8271 =for apidoc sv_tainted
8273 Test an SV for taintedness. Use C<SvTAINTED> instead.
8278 Perl_sv_tainted(pTHX_ SV *sv)
8280 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8281 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8282 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8289 =for apidoc sv_setpviv
8291 Copies an integer into the given SV, also updating its string value.
8292 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8298 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8300 char buf[TYPE_CHARS(UV)];
8302 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8304 sv_setpvn(sv, ptr, ebuf - ptr);
8308 =for apidoc sv_setpviv_mg
8310 Like C<sv_setpviv>, but also handles 'set' magic.
8316 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8318 char buf[TYPE_CHARS(UV)];
8320 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8322 sv_setpvn(sv, ptr, ebuf - ptr);
8326 #if defined(PERL_IMPLICIT_CONTEXT)
8328 /* pTHX_ magic can't cope with varargs, so this is a no-context
8329 * version of the main function, (which may itself be aliased to us).
8330 * Don't access this version directly.
8334 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8338 va_start(args, pat);
8339 sv_vsetpvf(sv, pat, &args);
8343 /* pTHX_ magic can't cope with varargs, so this is a no-context
8344 * version of the main function, (which may itself be aliased to us).
8345 * Don't access this version directly.
8349 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8353 va_start(args, pat);
8354 sv_vsetpvf_mg(sv, pat, &args);
8360 =for apidoc sv_setpvf
8362 Processes its arguments like C<sprintf> and sets an SV to the formatted
8363 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8369 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8372 va_start(args, pat);
8373 sv_vsetpvf(sv, pat, &args);
8377 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8380 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8382 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8386 =for apidoc sv_setpvf_mg
8388 Like C<sv_setpvf>, but also handles 'set' magic.
8394 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8397 va_start(args, pat);
8398 sv_vsetpvf_mg(sv, pat, &args);
8402 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8405 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8407 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8411 #if defined(PERL_IMPLICIT_CONTEXT)
8413 /* pTHX_ magic can't cope with varargs, so this is a no-context
8414 * version of the main function, (which may itself be aliased to us).
8415 * Don't access this version directly.
8419 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8423 va_start(args, pat);
8424 sv_vcatpvf(sv, pat, &args);
8428 /* pTHX_ magic can't cope with varargs, so this is a no-context
8429 * version of the main function, (which may itself be aliased to us).
8430 * Don't access this version directly.
8434 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8438 va_start(args, pat);
8439 sv_vcatpvf_mg(sv, pat, &args);
8445 =for apidoc sv_catpvf
8447 Processes its arguments like C<sprintf> and appends the formatted
8448 output to an SV. If the appended data contains "wide" characters
8449 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8450 and characters >255 formatted with %c), the original SV might get
8451 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8452 C<SvSETMAGIC()> must typically be called after calling this function
8453 to handle 'set' magic.
8458 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8461 va_start(args, pat);
8462 sv_vcatpvf(sv, pat, &args);
8466 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8469 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8471 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8475 =for apidoc sv_catpvf_mg
8477 Like C<sv_catpvf>, but also handles 'set' magic.
8483 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8486 va_start(args, pat);
8487 sv_vcatpvf_mg(sv, pat, &args);
8491 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
8494 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8496 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8501 =for apidoc sv_vsetpvfn
8503 Works like C<vcatpvfn> but copies the text into the SV instead of
8506 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
8512 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8514 sv_setpvn(sv, "", 0);
8515 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8518 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8521 S_expect_number(pTHX_ char** pattern)
8524 switch (**pattern) {
8525 case '1': case '2': case '3':
8526 case '4': case '5': case '6':
8527 case '7': case '8': case '9':
8528 while (isDIGIT(**pattern))
8529 var = var * 10 + (*(*pattern)++ - '0');
8533 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8536 =for apidoc sv_vcatpvfn
8538 Processes its arguments like C<vsprintf> and appends the formatted output
8539 to an SV. Uses an array of SVs if the C style variable argument list is
8540 missing (NULL). When running with taint checks enabled, indicates via
8541 C<maybe_tainted> if results are untrustworthy (often due to the use of
8544 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
8550 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8557 static char nullstr[] = "(null)";
8559 bool has_utf8; /* has the result utf8? */
8560 bool pat_utf8; /* the pattern is in utf8? */
8563 has_utf8 = pat_utf8 = DO_UTF8(sv);
8565 /* no matter what, this is a string now */
8566 (void)SvPV_force(sv, origlen);
8568 /* special-case "", "%s", and "%_" */
8571 if (patlen == 2 && pat[0] == '%') {
8575 char *s = va_arg(*args, char*);
8576 sv_catpv(sv, s ? s : nullstr);
8578 else if (svix < svmax) {
8579 sv_catsv(sv, *svargs);
8580 if (DO_UTF8(*svargs))
8586 argsv = va_arg(*args, SV*);
8587 sv_catsv(sv, argsv);
8592 /* See comment on '_' below */
8597 if (!args && svix < svmax && DO_UTF8(*svargs))
8600 patend = (char*)pat + patlen;
8601 for (p = (char*)pat; p < patend; p = q) {
8604 bool vectorize = FALSE;
8605 bool vectorarg = FALSE;
8606 bool vec_utf8 = FALSE;
8612 bool has_precis = FALSE;
8615 bool is_utf8 = FALSE; /* is this item utf8? */
8616 #ifdef HAS_LDBL_SPRINTF_BUG
8617 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8618 with sfio - Allen <allens@cpan.org> */
8619 bool fix_ldbl_sprintf_bug = FALSE;
8623 U8 utf8buf[UTF8_MAXLEN+1];
8624 STRLEN esignlen = 0;
8626 char *eptr = Nullch;
8628 /* Times 4: a decimal digit takes more than 3 binary digits.
8629 * NV_DIG: mantissa takes than many decimal digits.
8630 * Plus 32: Playing safe. */
8631 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8632 /* large enough for "%#.#f" --chip */
8633 /* what about long double NVs? --jhi */
8636 U8 *vecstr = Null(U8*);
8643 /* we need a long double target in case HAS_LONG_DOUBLE but
8646 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8655 STRLEN dotstrlen = 1;
8656 I32 efix = 0; /* explicit format parameter index */
8657 I32 ewix = 0; /* explicit width index */
8658 I32 epix = 0; /* explicit precision index */
8659 I32 evix = 0; /* explicit vector index */
8660 bool asterisk = FALSE;
8662 /* echo everything up to the next format specification */
8663 for (q = p; q < patend && *q != '%'; ++q) ;
8665 if (has_utf8 && !pat_utf8)
8666 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8668 sv_catpvn(sv, p, q - p);
8675 We allow format specification elements in this order:
8676 \d+\$ explicit format parameter index
8678 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8679 0 flag (as above): repeated to allow "v02"
8680 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8681 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8683 [%bcdefginopsux_DFOUX] format (mandatory)
8685 if (EXPECT_NUMBER(q, width)) {
8726 if (EXPECT_NUMBER(q, ewix))
8735 if ((vectorarg = asterisk)) {
8747 EXPECT_NUMBER(q, width);
8752 vecsv = va_arg(*args, SV*);
8754 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8755 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8756 dotstr = SvPVx(vecsv, dotstrlen);
8761 vecsv = va_arg(*args, SV*);
8762 vecstr = (U8*)SvPVx(vecsv,veclen);
8763 vec_utf8 = DO_UTF8(vecsv);
8765 else if (efix ? efix <= svmax : svix < svmax) {
8766 vecsv = svargs[efix ? efix-1 : svix++];
8767 vecstr = (U8*)SvPVx(vecsv,veclen);
8768 vec_utf8 = DO_UTF8(vecsv);
8778 i = va_arg(*args, int);
8780 i = (ewix ? ewix <= svmax : svix < svmax) ?
8781 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8783 width = (i < 0) ? -i : i;
8793 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8795 /* XXX: todo, support specified precision parameter */
8799 i = va_arg(*args, int);
8801 i = (ewix ? ewix <= svmax : svix < svmax)
8802 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8803 precis = (i < 0) ? 0 : i;
8808 precis = precis * 10 + (*q++ - '0');
8817 case 'I': /* Ix, I32x, and I64x */
8819 if (q[1] == '6' && q[2] == '4') {
8825 if (q[1] == '3' && q[2] == '2') {
8835 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8846 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8847 if (*(q + 1) == 'l') { /* lld, llf */
8872 argsv = (efix ? efix <= svmax : svix < svmax) ?
8873 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8880 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8882 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8884 eptr = (char*)utf8buf;
8885 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8896 if (args && !vectorize) {
8897 eptr = va_arg(*args, char*);
8899 #ifdef MACOS_TRADITIONAL
8900 /* On MacOS, %#s format is used for Pascal strings */
8905 elen = strlen(eptr);
8908 elen = sizeof nullstr - 1;
8912 eptr = SvPVx(argsv, elen);
8913 if (DO_UTF8(argsv)) {
8914 if (has_precis && precis < elen) {
8916 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8919 if (width) { /* fudge width (can't fudge elen) */
8920 width += elen - sv_len_utf8(argsv);
8929 * The "%_" hack might have to be changed someday,
8930 * if ISO or ANSI decide to use '_' for something.
8931 * So we keep it hidden from users' code.
8933 if (!args || vectorize)
8935 argsv = va_arg(*args, SV*);
8936 eptr = SvPVx(argsv, elen);
8942 if (has_precis && elen > precis)
8949 if (alt || vectorize)
8951 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8969 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8978 esignbuf[esignlen++] = plus;
8982 case 'h': iv = (short)va_arg(*args, int); break;
8983 default: iv = va_arg(*args, int); break;
8984 case 'l': iv = va_arg(*args, long); break;
8985 case 'V': iv = va_arg(*args, IV); break;
8987 case 'q': iv = va_arg(*args, Quad_t); break;
8994 case 'h': iv = (short)iv; break;
8996 case 'l': iv = (long)iv; break;
8999 case 'q': iv = (Quad_t)iv; break;
9003 if ( !vectorize ) /* we already set uv above */
9008 esignbuf[esignlen++] = plus;
9012 esignbuf[esignlen++] = '-';
9055 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9066 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9067 default: uv = va_arg(*args, unsigned); break;
9068 case 'l': uv = va_arg(*args, unsigned long); break;
9069 case 'V': uv = va_arg(*args, UV); break;
9071 case 'q': uv = va_arg(*args, Quad_t); break;
9078 case 'h': uv = (unsigned short)uv; break;
9080 case 'l': uv = (unsigned long)uv; break;
9083 case 'q': uv = (Quad_t)uv; break;
9089 eptr = ebuf + sizeof ebuf;
9095 p = (char*)((c == 'X')
9096 ? "0123456789ABCDEF" : "0123456789abcdef");
9102 esignbuf[esignlen++] = '0';
9103 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9109 *--eptr = '0' + dig;
9111 if (alt && *eptr != '0')
9117 *--eptr = '0' + dig;
9120 esignbuf[esignlen++] = '0';
9121 esignbuf[esignlen++] = 'b';
9124 default: /* it had better be ten or less */
9125 #if defined(PERL_Y2KWARN)
9126 if (ckWARN(WARN_Y2K)) {
9128 char *s = SvPV(sv,n);
9129 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9130 && (n == 2 || !isDIGIT(s[n-3])))
9132 Perl_warner(aTHX_ packWARN(WARN_Y2K),
9133 "Possible Y2K bug: %%%c %s",
9134 c, "format string following '19'");
9140 *--eptr = '0' + dig;
9141 } while (uv /= base);
9144 elen = (ebuf + sizeof ebuf) - eptr;
9147 zeros = precis - elen;
9148 else if (precis == 0 && elen == 1 && *eptr == '0')
9153 /* FLOATING POINT */
9156 c = 'f'; /* maybe %F isn't supported here */
9162 /* This is evil, but floating point is even more evil */
9164 /* for SV-style calling, we can only get NV
9165 for C-style calling, we assume %f is double;
9166 for simplicity we allow any of %Lf, %llf, %qf for long double
9170 #if defined(USE_LONG_DOUBLE)
9174 /* [perl #20339] - we should accept and ignore %lf rather than die */
9178 #if defined(USE_LONG_DOUBLE)
9179 intsize = args ? 0 : 'q';
9183 #if defined(HAS_LONG_DOUBLE)
9192 /* now we need (long double) if intsize == 'q', else (double) */
9193 nv = (args && !vectorize) ?
9194 #if LONG_DOUBLESIZE > DOUBLESIZE
9196 va_arg(*args, long double) :
9197 va_arg(*args, double)
9199 va_arg(*args, double)
9205 if (c != 'e' && c != 'E') {
9207 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9208 will cast our (long double) to (double) */
9209 (void)Perl_frexp(nv, &i);
9210 if (i == PERL_INT_MIN)
9211 Perl_die(aTHX_ "panic: frexp");
9213 need = BIT_DIGITS(i);
9215 need += has_precis ? precis : 6; /* known default */
9220 #ifdef HAS_LDBL_SPRINTF_BUG
9221 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9222 with sfio - Allen <allens@cpan.org> */
9225 # define MY_DBL_MAX DBL_MAX
9226 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9227 # if DOUBLESIZE >= 8
9228 # define MY_DBL_MAX 1.7976931348623157E+308L
9230 # define MY_DBL_MAX 3.40282347E+38L
9234 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9235 # define MY_DBL_MAX_BUG 1L
9237 # define MY_DBL_MAX_BUG MY_DBL_MAX
9241 # define MY_DBL_MIN DBL_MIN
9242 # else /* XXX guessing! -Allen */
9243 # if DOUBLESIZE >= 8
9244 # define MY_DBL_MIN 2.2250738585072014E-308L
9246 # define MY_DBL_MIN 1.17549435E-38L
9250 if ((intsize == 'q') && (c == 'f') &&
9251 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9253 /* it's going to be short enough that
9254 * long double precision is not needed */
9256 if ((nv <= 0L) && (nv >= -0L))
9257 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9259 /* would use Perl_fp_class as a double-check but not
9260 * functional on IRIX - see perl.h comments */
9262 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9263 /* It's within the range that a double can represent */
9264 #if defined(DBL_MAX) && !defined(DBL_MIN)
9265 if ((nv >= ((long double)1/DBL_MAX)) ||
9266 (nv <= (-(long double)1/DBL_MAX)))
9268 fix_ldbl_sprintf_bug = TRUE;
9271 if (fix_ldbl_sprintf_bug == TRUE) {
9281 # undef MY_DBL_MAX_BUG
9284 #endif /* HAS_LDBL_SPRINTF_BUG */
9286 need += 20; /* fudge factor */
9287 if (PL_efloatsize < need) {
9288 Safefree(PL_efloatbuf);
9289 PL_efloatsize = need + 20; /* more fudge */
9290 New(906, PL_efloatbuf, PL_efloatsize, char);
9291 PL_efloatbuf[0] = '\0';
9294 eptr = ebuf + sizeof ebuf;
9297 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9298 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9299 if (intsize == 'q') {
9300 /* Copy the one or more characters in a long double
9301 * format before the 'base' ([efgEFG]) character to
9302 * the format string. */
9303 static char const prifldbl[] = PERL_PRIfldbl;
9304 char const *p = prifldbl + sizeof(prifldbl) - 3;
9305 while (p >= prifldbl) { *--eptr = *p--; }
9310 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9315 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9327 /* No taint. Otherwise we are in the strange situation
9328 * where printf() taints but print($float) doesn't.
9330 #if defined(HAS_LONG_DOUBLE)
9332 (void)sprintf(PL_efloatbuf, eptr, nv);
9334 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9336 (void)sprintf(PL_efloatbuf, eptr, nv);
9338 eptr = PL_efloatbuf;
9339 elen = strlen(PL_efloatbuf);
9345 i = SvCUR(sv) - origlen;
9346 if (args && !vectorize) {
9348 case 'h': *(va_arg(*args, short*)) = i; break;
9349 default: *(va_arg(*args, int*)) = i; break;
9350 case 'l': *(va_arg(*args, long*)) = i; break;
9351 case 'V': *(va_arg(*args, IV*)) = i; break;
9353 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9358 sv_setuv_mg(argsv, (UV)i);
9360 continue; /* not "break" */
9366 if (!args && ckWARN(WARN_PRINTF) &&
9367 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9368 SV *msg = sv_newmortal();
9369 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9370 (PL_op->op_type == OP_PRTF) ? "" : "s");
9373 Perl_sv_catpvf(aTHX_ msg,
9374 "\"%%%c\"", c & 0xFF);
9376 Perl_sv_catpvf(aTHX_ msg,
9377 "\"%%\\%03"UVof"\"",
9380 sv_catpv(msg, "end of string");
9381 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9384 /* output mangled stuff ... */
9390 /* ... right here, because formatting flags should not apply */
9391 SvGROW(sv, SvCUR(sv) + elen + 1);
9393 Copy(eptr, p, elen, char);
9396 SvCUR(sv) = p - SvPVX(sv);
9398 continue; /* not "break" */
9401 if (is_utf8 != has_utf8) {
9404 sv_utf8_upgrade(sv);
9407 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9408 sv_utf8_upgrade(nsv);
9412 SvGROW(sv, SvCUR(sv) + elen + 1);
9416 /* Use memchr() instead of strchr(), as eptr is not guaranteed */
9417 /* to point to a null-terminated string. */
9418 if (left && ckWARN(WARN_PRINTF) && memchr(eptr, '\n', elen) &&
9419 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF))
9420 Perl_warner(aTHX_ packWARN(WARN_PRINTF),
9421 "Newline in left-justified string for %sprintf",
9422 (PL_op->op_type == OP_PRTF) ? "" : "s");
9424 have = esignlen + zeros + elen;
9425 need = (have > width ? have : width);
9428 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9430 if (esignlen && fill == '0') {
9431 for (i = 0; i < (int)esignlen; i++)
9435 memset(p, fill, gap);
9438 if (esignlen && fill != '0') {
9439 for (i = 0; i < (int)esignlen; i++)
9443 for (i = zeros; i; i--)
9447 Copy(eptr, p, elen, char);
9451 memset(p, ' ', gap);
9456 Copy(dotstr, p, dotstrlen, char);
9460 vectorize = FALSE; /* done iterating over vecstr */
9467 SvCUR(sv) = p - SvPVX(sv);
9475 /* =========================================================================
9477 =head1 Cloning an interpreter
9479 All the macros and functions in this section are for the private use of
9480 the main function, perl_clone().
9482 The foo_dup() functions make an exact copy of an existing foo thinngy.
9483 During the course of a cloning, a hash table is used to map old addresses
9484 to new addresses. The table is created and manipulated with the
9485 ptr_table_* functions.
9489 ============================================================================*/
9492 #if defined(USE_ITHREADS)
9494 #ifndef GpREFCNT_inc
9495 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9499 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9500 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9501 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9502 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9503 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9504 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9505 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9506 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9507 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9508 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9509 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9510 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9511 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9514 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9515 regcomp.c. AMS 20010712 */
9518 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
9522 struct reg_substr_datum *s;
9525 return (REGEXP *)NULL;
9527 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9530 len = r->offsets[0];
9531 npar = r->nparens+1;
9533 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9534 Copy(r->program, ret->program, len+1, regnode);
9536 New(0, ret->startp, npar, I32);
9537 Copy(r->startp, ret->startp, npar, I32);
9538 New(0, ret->endp, npar, I32);
9539 Copy(r->startp, ret->startp, npar, I32);
9541 New(0, ret->substrs, 1, struct reg_substr_data);
9542 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9543 s->min_offset = r->substrs->data[i].min_offset;
9544 s->max_offset = r->substrs->data[i].max_offset;
9545 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9546 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9549 ret->regstclass = NULL;
9552 int count = r->data->count;
9554 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9555 char, struct reg_data);
9556 New(0, d->what, count, U8);
9559 for (i = 0; i < count; i++) {
9560 d->what[i] = r->data->what[i];
9561 switch (d->what[i]) {
9563 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9566 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9569 /* This is cheating. */
9570 New(0, d->data[i], 1, struct regnode_charclass_class);
9571 StructCopy(r->data->data[i], d->data[i],
9572 struct regnode_charclass_class);
9573 ret->regstclass = (regnode*)d->data[i];
9576 /* Compiled op trees are readonly, and can thus be
9577 shared without duplication. */
9578 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9581 d->data[i] = r->data->data[i];
9591 New(0, ret->offsets, 2*len+1, U32);
9592 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9594 ret->precomp = SAVEPV(r->precomp);
9595 ret->refcnt = r->refcnt;
9596 ret->minlen = r->minlen;
9597 ret->prelen = r->prelen;
9598 ret->nparens = r->nparens;
9599 ret->lastparen = r->lastparen;
9600 ret->lastcloseparen = r->lastcloseparen;
9601 ret->reganch = r->reganch;
9603 ret->sublen = r->sublen;
9605 if (RX_MATCH_COPIED(ret))
9606 ret->subbeg = SAVEPV(r->subbeg);
9608 ret->subbeg = Nullch;
9609 #ifdef PERL_COPY_ON_WRITE
9610 ret->saved_copy = Nullsv;
9613 ptr_table_store(PL_ptr_table, r, ret);
9617 /* duplicate a file handle */
9620 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9624 return (PerlIO*)NULL;
9626 /* look for it in the table first */
9627 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9631 /* create anew and remember what it is */
9632 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9633 ptr_table_store(PL_ptr_table, fp, ret);
9637 /* duplicate a directory handle */
9640 Perl_dirp_dup(pTHX_ DIR *dp)
9648 /* duplicate a typeglob */
9651 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9656 /* look for it in the table first */
9657 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9661 /* create anew and remember what it is */
9662 Newz(0, ret, 1, GP);
9663 ptr_table_store(PL_ptr_table, gp, ret);
9666 ret->gp_refcnt = 0; /* must be before any other dups! */
9667 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9668 ret->gp_io = io_dup_inc(gp->gp_io, param);
9669 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9670 ret->gp_av = av_dup_inc(gp->gp_av, param);
9671 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9672 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9673 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9674 ret->gp_cvgen = gp->gp_cvgen;
9675 ret->gp_flags = gp->gp_flags;
9676 ret->gp_line = gp->gp_line;
9677 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9681 /* duplicate a chain of magic */
9684 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9686 MAGIC *mgprev = (MAGIC*)NULL;
9689 return (MAGIC*)NULL;
9690 /* look for it in the table first */
9691 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9695 for (; mg; mg = mg->mg_moremagic) {
9697 Newz(0, nmg, 1, MAGIC);
9699 mgprev->mg_moremagic = nmg;
9702 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9703 nmg->mg_private = mg->mg_private;
9704 nmg->mg_type = mg->mg_type;
9705 nmg->mg_flags = mg->mg_flags;
9706 if (mg->mg_type == PERL_MAGIC_qr) {
9707 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9709 else if(mg->mg_type == PERL_MAGIC_backref) {
9710 AV *av = (AV*) mg->mg_obj;
9713 nmg->mg_obj = (SV*)newAV();
9717 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9722 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9723 ? sv_dup_inc(mg->mg_obj, param)
9724 : sv_dup(mg->mg_obj, param);
9726 nmg->mg_len = mg->mg_len;
9727 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9728 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9729 if (mg->mg_len > 0) {
9730 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9731 if (mg->mg_type == PERL_MAGIC_overload_table &&
9732 AMT_AMAGIC((AMT*)mg->mg_ptr))
9734 AMT *amtp = (AMT*)mg->mg_ptr;
9735 AMT *namtp = (AMT*)nmg->mg_ptr;
9737 for (i = 1; i < NofAMmeth; i++) {
9738 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9742 else if (mg->mg_len == HEf_SVKEY)
9743 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9745 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9746 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9753 /* create a new pointer-mapping table */
9756 Perl_ptr_table_new(pTHX)
9759 Newz(0, tbl, 1, PTR_TBL_t);
9762 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9766 /* map an existing pointer using a table */
9769 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
9771 PTR_TBL_ENT_t *tblent;
9772 UV hash = PTR2UV(sv);
9774 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9775 for (; tblent; tblent = tblent->next) {
9776 if (tblent->oldval == sv)
9777 return tblent->newval;
9782 /* add a new entry to a pointer-mapping table */
9785 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
9787 PTR_TBL_ENT_t *tblent, **otblent;
9788 /* XXX this may be pessimal on platforms where pointers aren't good
9789 * hash values e.g. if they grow faster in the most significant
9791 UV hash = PTR2UV(oldv);
9795 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9796 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
9797 if (tblent->oldval == oldv) {
9798 tblent->newval = newv;
9802 Newz(0, tblent, 1, PTR_TBL_ENT_t);
9803 tblent->oldval = oldv;
9804 tblent->newval = newv;
9805 tblent->next = *otblent;
9808 if (i && tbl->tbl_items > tbl->tbl_max)
9809 ptr_table_split(tbl);
9812 /* double the hash bucket size of an existing ptr table */
9815 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9817 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9818 UV oldsize = tbl->tbl_max + 1;
9819 UV newsize = oldsize * 2;
9822 Renew(ary, newsize, PTR_TBL_ENT_t*);
9823 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9824 tbl->tbl_max = --newsize;
9826 for (i=0; i < oldsize; i++, ary++) {
9827 PTR_TBL_ENT_t **curentp, **entp, *ent;
9830 curentp = ary + oldsize;
9831 for (entp = ary, ent = *ary; ent; ent = *entp) {
9832 if ((newsize & PTR2UV(ent->oldval)) != i) {
9834 ent->next = *curentp;
9844 /* remove all the entries from a ptr table */
9847 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9849 register PTR_TBL_ENT_t **array;
9850 register PTR_TBL_ENT_t *entry;
9851 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
9855 if (!tbl || !tbl->tbl_items) {
9859 array = tbl->tbl_ary;
9866 entry = entry->next;
9870 if (++riter > max) {
9873 entry = array[riter];
9880 /* clear and free a ptr table */
9883 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9888 ptr_table_clear(tbl);
9889 Safefree(tbl->tbl_ary);
9897 /* attempt to make everything in the typeglob readonly */
9900 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
9903 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
9905 if (GvIO(gv) || GvFORM(gv)) {
9906 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
9908 else if (!GvCV(gv)) {
9912 /* CvPADLISTs cannot be shared */
9913 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
9918 if (!GvUNIQUE(gv)) {
9920 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
9921 HvNAME(GvSTASH(gv)), GvNAME(gv));
9927 * write attempts will die with
9928 * "Modification of a read-only value attempted"
9934 SvREADONLY_on(GvSV(gv));
9941 SvREADONLY_on(GvAV(gv));
9948 SvREADONLY_on(GvAV(gv));
9951 return sstr; /* he_dup() will SvREFCNT_inc() */
9954 /* duplicate an SV of any type (including AV, HV etc) */
9957 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9960 SvRV(dstr) = SvWEAKREF(sstr)
9961 ? sv_dup(SvRV(sstr), param)
9962 : sv_dup_inc(SvRV(sstr), param);
9964 else if (SvPVX(sstr)) {
9965 /* Has something there */
9967 /* Normal PV - clone whole allocated space */
9968 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9969 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9970 /* Not that normal - actually sstr is copy on write.
9971 But we are a true, independant SV, so: */
9972 SvREADONLY_off(dstr);
9977 /* Special case - not normally malloced for some reason */
9978 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9979 /* A "shared" PV - clone it as unshared string */
9980 if(SvPADTMP(sstr)) {
9981 /* However, some of them live in the pad
9982 and they should not have these flags
9985 SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
9987 SvUVX(dstr) = SvUVX(sstr);
9990 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
9992 SvREADONLY_off(dstr);
9996 /* Some other special case - random pointer */
9997 SvPVX(dstr) = SvPVX(sstr);
10002 /* Copy the Null */
10003 SvPVX(dstr) = SvPVX(sstr);
10008 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10012 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10014 /* look for it in the table first */
10015 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10019 if(param->flags & CLONEf_JOIN_IN) {
10020 /** We are joining here so we don't want do clone
10021 something that is bad **/
10023 if(SvTYPE(sstr) == SVt_PVHV &&
10025 /** don't clone stashes if they already exist **/
10026 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10027 return (SV*) old_stash;
10031 /* create anew and remember what it is */
10033 ptr_table_store(PL_ptr_table, sstr, dstr);
10036 SvFLAGS(dstr) = SvFLAGS(sstr);
10037 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10038 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10041 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10042 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10043 PL_watch_pvx, SvPVX(sstr));
10046 switch (SvTYPE(sstr)) {
10048 SvANY(dstr) = NULL;
10051 SvANY(dstr) = new_XIV();
10052 SvIVX(dstr) = SvIVX(sstr);
10055 SvANY(dstr) = new_XNV();
10056 SvNVX(dstr) = SvNVX(sstr);
10059 SvANY(dstr) = new_XRV();
10060 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10063 SvANY(dstr) = new_XPV();
10064 SvCUR(dstr) = SvCUR(sstr);
10065 SvLEN(dstr) = SvLEN(sstr);
10066 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10069 SvANY(dstr) = new_XPVIV();
10070 SvCUR(dstr) = SvCUR(sstr);
10071 SvLEN(dstr) = SvLEN(sstr);
10072 SvIVX(dstr) = SvIVX(sstr);
10073 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10076 SvANY(dstr) = new_XPVNV();
10077 SvCUR(dstr) = SvCUR(sstr);
10078 SvLEN(dstr) = SvLEN(sstr);
10079 SvIVX(dstr) = SvIVX(sstr);
10080 SvNVX(dstr) = SvNVX(sstr);
10081 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10084 SvANY(dstr) = new_XPVMG();
10085 SvCUR(dstr) = SvCUR(sstr);
10086 SvLEN(dstr) = SvLEN(sstr);
10087 SvIVX(dstr) = SvIVX(sstr);
10088 SvNVX(dstr) = SvNVX(sstr);
10089 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10090 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10091 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10094 SvANY(dstr) = new_XPVBM();
10095 SvCUR(dstr) = SvCUR(sstr);
10096 SvLEN(dstr) = SvLEN(sstr);
10097 SvIVX(dstr) = SvIVX(sstr);
10098 SvNVX(dstr) = SvNVX(sstr);
10099 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10100 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10101 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10102 BmRARE(dstr) = BmRARE(sstr);
10103 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10104 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10107 SvANY(dstr) = new_XPVLV();
10108 SvCUR(dstr) = SvCUR(sstr);
10109 SvLEN(dstr) = SvLEN(sstr);
10110 SvIVX(dstr) = SvIVX(sstr);
10111 SvNVX(dstr) = SvNVX(sstr);
10112 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10113 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10114 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10115 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10116 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10117 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10118 LvTARG(dstr) = dstr;
10119 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10120 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10122 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10123 LvTYPE(dstr) = LvTYPE(sstr);
10126 if (GvUNIQUE((GV*)sstr)) {
10128 if ((share = gv_share(sstr, param))) {
10131 ptr_table_store(PL_ptr_table, sstr, dstr);
10133 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10134 HvNAME(GvSTASH(share)), GvNAME(share));
10139 SvANY(dstr) = new_XPVGV();
10140 SvCUR(dstr) = SvCUR(sstr);
10141 SvLEN(dstr) = SvLEN(sstr);
10142 SvIVX(dstr) = SvIVX(sstr);
10143 SvNVX(dstr) = SvNVX(sstr);
10144 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10145 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10146 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10147 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10148 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10149 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10150 GvFLAGS(dstr) = GvFLAGS(sstr);
10151 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10152 (void)GpREFCNT_inc(GvGP(dstr));
10155 SvANY(dstr) = new_XPVIO();
10156 SvCUR(dstr) = SvCUR(sstr);
10157 SvLEN(dstr) = SvLEN(sstr);
10158 SvIVX(dstr) = SvIVX(sstr);
10159 SvNVX(dstr) = SvNVX(sstr);
10160 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10161 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10162 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10163 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10164 if (IoOFP(sstr) == IoIFP(sstr))
10165 IoOFP(dstr) = IoIFP(dstr);
10167 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10168 /* PL_rsfp_filters entries have fake IoDIRP() */
10169 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10170 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10172 IoDIRP(dstr) = IoDIRP(sstr);
10173 IoLINES(dstr) = IoLINES(sstr);
10174 IoPAGE(dstr) = IoPAGE(sstr);
10175 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10176 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10177 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10178 /* I have no idea why fake dirp (rsfps)
10179 should be treaded differently but otherwise
10180 we end up with leaks -- sky*/
10181 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10182 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10183 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10185 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10186 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10187 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10189 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10190 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10191 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10192 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10193 IoTYPE(dstr) = IoTYPE(sstr);
10194 IoFLAGS(dstr) = IoFLAGS(sstr);
10197 SvANY(dstr) = new_XPVAV();
10198 SvCUR(dstr) = SvCUR(sstr);
10199 SvLEN(dstr) = SvLEN(sstr);
10200 SvIVX(dstr) = SvIVX(sstr);
10201 SvNVX(dstr) = SvNVX(sstr);
10202 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10203 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10204 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10205 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10206 if (AvARRAY((AV*)sstr)) {
10207 SV **dst_ary, **src_ary;
10208 SSize_t items = AvFILLp((AV*)sstr) + 1;
10210 src_ary = AvARRAY((AV*)sstr);
10211 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10212 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10213 SvPVX(dstr) = (char*)dst_ary;
10214 AvALLOC((AV*)dstr) = dst_ary;
10215 if (AvREAL((AV*)sstr)) {
10216 while (items-- > 0)
10217 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10220 while (items-- > 0)
10221 *dst_ary++ = sv_dup(*src_ary++, param);
10223 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10224 while (items-- > 0) {
10225 *dst_ary++ = &PL_sv_undef;
10229 SvPVX(dstr) = Nullch;
10230 AvALLOC((AV*)dstr) = (SV**)NULL;
10234 SvANY(dstr) = new_XPVHV();
10235 SvCUR(dstr) = SvCUR(sstr);
10236 SvLEN(dstr) = SvLEN(sstr);
10237 SvIVX(dstr) = SvIVX(sstr);
10238 SvNVX(dstr) = SvNVX(sstr);
10239 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10240 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10241 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
10242 if (HvARRAY((HV*)sstr)) {
10244 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10245 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10246 Newz(0, dxhv->xhv_array,
10247 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10248 while (i <= sxhv->xhv_max) {
10249 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10250 (bool)!!HvSHAREKEYS(sstr),
10254 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10255 (bool)!!HvSHAREKEYS(sstr), param);
10258 SvPVX(dstr) = Nullch;
10259 HvEITER((HV*)dstr) = (HE*)NULL;
10261 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
10262 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
10263 /* Record stashes for possible cloning in Perl_clone(). */
10264 if(HvNAME((HV*)dstr))
10265 av_push(param->stashes, dstr);
10268 SvANY(dstr) = new_XPVFM();
10269 FmLINES(dstr) = FmLINES(sstr);
10273 SvANY(dstr) = new_XPVCV();
10275 SvCUR(dstr) = SvCUR(sstr);
10276 SvLEN(dstr) = SvLEN(sstr);
10277 SvIVX(dstr) = SvIVX(sstr);
10278 SvNVX(dstr) = SvNVX(sstr);
10279 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10280 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10281 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10282 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10283 CvSTART(dstr) = CvSTART(sstr);
10284 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10285 CvXSUB(dstr) = CvXSUB(sstr);
10286 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10287 if (CvCONST(sstr)) {
10288 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10289 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10290 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10292 CvGV(dstr) = gv_dup(CvGV(sstr), param);
10293 if (param->flags & CLONEf_COPY_STACKS) {
10294 CvDEPTH(dstr) = CvDEPTH(sstr);
10298 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10299 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10301 CvWEAKOUTSIDE(sstr)
10302 ? cv_dup( CvOUTSIDE(sstr), param)
10303 : cv_dup_inc(CvOUTSIDE(sstr), param);
10304 CvFLAGS(dstr) = CvFLAGS(sstr);
10305 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10308 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10312 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10318 /* duplicate a context */
10321 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10323 PERL_CONTEXT *ncxs;
10326 return (PERL_CONTEXT*)NULL;
10328 /* look for it in the table first */
10329 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10333 /* create anew and remember what it is */
10334 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10335 ptr_table_store(PL_ptr_table, cxs, ncxs);
10338 PERL_CONTEXT *cx = &cxs[ix];
10339 PERL_CONTEXT *ncx = &ncxs[ix];
10340 ncx->cx_type = cx->cx_type;
10341 if (CxTYPE(cx) == CXt_SUBST) {
10342 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10345 ncx->blk_oldsp = cx->blk_oldsp;
10346 ncx->blk_oldcop = cx->blk_oldcop;
10347 ncx->blk_oldretsp = cx->blk_oldretsp;
10348 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10349 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10350 ncx->blk_oldpm = cx->blk_oldpm;
10351 ncx->blk_gimme = cx->blk_gimme;
10352 switch (CxTYPE(cx)) {
10354 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10355 ? cv_dup_inc(cx->blk_sub.cv, param)
10356 : cv_dup(cx->blk_sub.cv,param));
10357 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10358 ? av_dup_inc(cx->blk_sub.argarray, param)
10360 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10361 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10362 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10363 ncx->blk_sub.lval = cx->blk_sub.lval;
10366 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10367 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10368 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10369 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10370 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10373 ncx->blk_loop.label = cx->blk_loop.label;
10374 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10375 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10376 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10377 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10378 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10379 ? cx->blk_loop.iterdata
10380 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10381 ncx->blk_loop.oldcomppad
10382 = (PAD*)ptr_table_fetch(PL_ptr_table,
10383 cx->blk_loop.oldcomppad);
10384 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10385 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10386 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10387 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10388 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10391 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10392 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10393 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10394 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10406 /* duplicate a stack info structure */
10409 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10414 return (PERL_SI*)NULL;
10416 /* look for it in the table first */
10417 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10421 /* create anew and remember what it is */
10422 Newz(56, nsi, 1, PERL_SI);
10423 ptr_table_store(PL_ptr_table, si, nsi);
10425 nsi->si_stack = av_dup_inc(si->si_stack, param);
10426 nsi->si_cxix = si->si_cxix;
10427 nsi->si_cxmax = si->si_cxmax;
10428 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10429 nsi->si_type = si->si_type;
10430 nsi->si_prev = si_dup(si->si_prev, param);
10431 nsi->si_next = si_dup(si->si_next, param);
10432 nsi->si_markoff = si->si_markoff;
10437 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10438 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10439 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10440 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10441 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10442 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10443 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10444 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10445 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10446 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10447 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10448 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10449 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10450 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10453 #define pv_dup_inc(p) SAVEPV(p)
10454 #define pv_dup(p) SAVEPV(p)
10455 #define svp_dup_inc(p,pp) any_dup(p,pp)
10457 /* map any object to the new equivent - either something in the
10458 * ptr table, or something in the interpreter structure
10462 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10467 return (void*)NULL;
10469 /* look for it in the table first */
10470 ret = ptr_table_fetch(PL_ptr_table, v);
10474 /* see if it is part of the interpreter structure */
10475 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10476 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10484 /* duplicate the save stack */
10487 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10489 ANY *ss = proto_perl->Tsavestack;
10490 I32 ix = proto_perl->Tsavestack_ix;
10491 I32 max = proto_perl->Tsavestack_max;
10504 void (*dptr) (void*);
10505 void (*dxptr) (pTHX_ void*);
10508 Newz(54, nss, max, ANY);
10512 TOPINT(nss,ix) = i;
10514 case SAVEt_ITEM: /* normal string */
10515 sv = (SV*)POPPTR(ss,ix);
10516 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10517 sv = (SV*)POPPTR(ss,ix);
10518 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10520 case SAVEt_SV: /* scalar reference */
10521 sv = (SV*)POPPTR(ss,ix);
10522 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10523 gv = (GV*)POPPTR(ss,ix);
10524 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10526 case SAVEt_GENERIC_PVREF: /* generic char* */
10527 c = (char*)POPPTR(ss,ix);
10528 TOPPTR(nss,ix) = pv_dup(c);
10529 ptr = POPPTR(ss,ix);
10530 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10532 case SAVEt_SHARED_PVREF: /* char* in shared space */
10533 c = (char*)POPPTR(ss,ix);
10534 TOPPTR(nss,ix) = savesharedpv(c);
10535 ptr = POPPTR(ss,ix);
10536 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10538 case SAVEt_GENERIC_SVREF: /* generic sv */
10539 case SAVEt_SVREF: /* scalar reference */
10540 sv = (SV*)POPPTR(ss,ix);
10541 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10542 ptr = POPPTR(ss,ix);
10543 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10545 case SAVEt_AV: /* array reference */
10546 av = (AV*)POPPTR(ss,ix);
10547 TOPPTR(nss,ix) = av_dup_inc(av, param);
10548 gv = (GV*)POPPTR(ss,ix);
10549 TOPPTR(nss,ix) = gv_dup(gv, param);
10551 case SAVEt_HV: /* hash reference */
10552 hv = (HV*)POPPTR(ss,ix);
10553 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10554 gv = (GV*)POPPTR(ss,ix);
10555 TOPPTR(nss,ix) = gv_dup(gv, param);
10557 case SAVEt_INT: /* int reference */
10558 ptr = POPPTR(ss,ix);
10559 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10560 intval = (int)POPINT(ss,ix);
10561 TOPINT(nss,ix) = intval;
10563 case SAVEt_LONG: /* long reference */
10564 ptr = POPPTR(ss,ix);
10565 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10566 longval = (long)POPLONG(ss,ix);
10567 TOPLONG(nss,ix) = longval;
10569 case SAVEt_I32: /* I32 reference */
10570 case SAVEt_I16: /* I16 reference */
10571 case SAVEt_I8: /* I8 reference */
10572 ptr = POPPTR(ss,ix);
10573 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10575 TOPINT(nss,ix) = i;
10577 case SAVEt_IV: /* IV reference */
10578 ptr = POPPTR(ss,ix);
10579 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10581 TOPIV(nss,ix) = iv;
10583 case SAVEt_SPTR: /* SV* reference */
10584 ptr = POPPTR(ss,ix);
10585 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10586 sv = (SV*)POPPTR(ss,ix);
10587 TOPPTR(nss,ix) = sv_dup(sv, param);
10589 case SAVEt_VPTR: /* random* reference */
10590 ptr = POPPTR(ss,ix);
10591 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10592 ptr = POPPTR(ss,ix);
10593 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10595 case SAVEt_PPTR: /* char* reference */
10596 ptr = POPPTR(ss,ix);
10597 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10598 c = (char*)POPPTR(ss,ix);
10599 TOPPTR(nss,ix) = pv_dup(c);
10601 case SAVEt_HPTR: /* HV* reference */
10602 ptr = POPPTR(ss,ix);
10603 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10604 hv = (HV*)POPPTR(ss,ix);
10605 TOPPTR(nss,ix) = hv_dup(hv, param);
10607 case SAVEt_APTR: /* AV* reference */
10608 ptr = POPPTR(ss,ix);
10609 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10610 av = (AV*)POPPTR(ss,ix);
10611 TOPPTR(nss,ix) = av_dup(av, param);
10614 gv = (GV*)POPPTR(ss,ix);
10615 TOPPTR(nss,ix) = gv_dup(gv, param);
10617 case SAVEt_GP: /* scalar reference */
10618 gp = (GP*)POPPTR(ss,ix);
10619 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10620 (void)GpREFCNT_inc(gp);
10621 gv = (GV*)POPPTR(ss,ix);
10622 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10623 c = (char*)POPPTR(ss,ix);
10624 TOPPTR(nss,ix) = pv_dup(c);
10626 TOPIV(nss,ix) = iv;
10628 TOPIV(nss,ix) = iv;
10631 case SAVEt_MORTALIZESV:
10632 sv = (SV*)POPPTR(ss,ix);
10633 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10636 ptr = POPPTR(ss,ix);
10637 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10638 /* these are assumed to be refcounted properly */
10639 switch (((OP*)ptr)->op_type) {
10641 case OP_LEAVESUBLV:
10645 case OP_LEAVEWRITE:
10646 TOPPTR(nss,ix) = ptr;
10651 TOPPTR(nss,ix) = Nullop;
10656 TOPPTR(nss,ix) = Nullop;
10659 c = (char*)POPPTR(ss,ix);
10660 TOPPTR(nss,ix) = pv_dup_inc(c);
10662 case SAVEt_CLEARSV:
10663 longval = POPLONG(ss,ix);
10664 TOPLONG(nss,ix) = longval;
10667 hv = (HV*)POPPTR(ss,ix);
10668 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10669 c = (char*)POPPTR(ss,ix);
10670 TOPPTR(nss,ix) = pv_dup_inc(c);
10672 TOPINT(nss,ix) = i;
10674 case SAVEt_DESTRUCTOR:
10675 ptr = POPPTR(ss,ix);
10676 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10677 dptr = POPDPTR(ss,ix);
10678 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
10680 case SAVEt_DESTRUCTOR_X:
10681 ptr = POPPTR(ss,ix);
10682 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10683 dxptr = POPDXPTR(ss,ix);
10684 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
10686 case SAVEt_REGCONTEXT:
10689 TOPINT(nss,ix) = i;
10692 case SAVEt_STACK_POS: /* Position on Perl stack */
10694 TOPINT(nss,ix) = i;
10696 case SAVEt_AELEM: /* array element */
10697 sv = (SV*)POPPTR(ss,ix);
10698 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10700 TOPINT(nss,ix) = i;
10701 av = (AV*)POPPTR(ss,ix);
10702 TOPPTR(nss,ix) = av_dup_inc(av, param);
10704 case SAVEt_HELEM: /* hash element */
10705 sv = (SV*)POPPTR(ss,ix);
10706 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10707 sv = (SV*)POPPTR(ss,ix);
10708 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10709 hv = (HV*)POPPTR(ss,ix);
10710 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10713 ptr = POPPTR(ss,ix);
10714 TOPPTR(nss,ix) = ptr;
10718 TOPINT(nss,ix) = i;
10720 case SAVEt_COMPPAD:
10721 av = (AV*)POPPTR(ss,ix);
10722 TOPPTR(nss,ix) = av_dup(av, param);
10725 longval = (long)POPLONG(ss,ix);
10726 TOPLONG(nss,ix) = longval;
10727 ptr = POPPTR(ss,ix);
10728 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10729 sv = (SV*)POPPTR(ss,ix);
10730 TOPPTR(nss,ix) = sv_dup(sv, param);
10733 ptr = POPPTR(ss,ix);
10734 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10735 longval = (long)POPBOOL(ss,ix);
10736 TOPBOOL(nss,ix) = (bool)longval;
10738 case SAVEt_SET_SVFLAGS:
10740 TOPINT(nss,ix) = i;
10742 TOPINT(nss,ix) = i;
10743 sv = (SV*)POPPTR(ss,ix);
10744 TOPPTR(nss,ix) = sv_dup(sv, param);
10747 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10755 =for apidoc perl_clone
10757 Create and return a new interpreter by cloning the current one.
10759 perl_clone takes these flags as parameters:
10761 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10762 without it we only clone the data and zero the stacks,
10763 with it we copy the stacks and the new perl interpreter is
10764 ready to run at the exact same point as the previous one.
10765 The pseudo-fork code uses COPY_STACKS while the
10766 threads->new doesn't.
10768 CLONEf_KEEP_PTR_TABLE
10769 perl_clone keeps a ptr_table with the pointer of the old
10770 variable as a key and the new variable as a value,
10771 this allows it to check if something has been cloned and not
10772 clone it again but rather just use the value and increase the
10773 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10774 the ptr_table using the function
10775 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10776 reason to keep it around is if you want to dup some of your own
10777 variable who are outside the graph perl scans, example of this
10778 code is in threads.xs create
10781 This is a win32 thing, it is ignored on unix, it tells perls
10782 win32host code (which is c++) to clone itself, this is needed on
10783 win32 if you want to run two threads at the same time,
10784 if you just want to do some stuff in a separate perl interpreter
10785 and then throw it away and return to the original one,
10786 you don't need to do anything.
10791 /* XXX the above needs expanding by someone who actually understands it ! */
10792 EXTERN_C PerlInterpreter *
10793 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10796 perl_clone(PerlInterpreter *proto_perl, UV flags)
10798 #ifdef PERL_IMPLICIT_SYS
10800 /* perlhost.h so we need to call into it
10801 to clone the host, CPerlHost should have a c interface, sky */
10803 if (flags & CLONEf_CLONE_HOST) {
10804 return perl_clone_host(proto_perl,flags);
10806 return perl_clone_using(proto_perl, flags,
10808 proto_perl->IMemShared,
10809 proto_perl->IMemParse,
10811 proto_perl->IStdIO,
10815 proto_perl->IProc);
10819 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10820 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10821 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10822 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10823 struct IPerlDir* ipD, struct IPerlSock* ipS,
10824 struct IPerlProc* ipP)
10826 /* XXX many of the string copies here can be optimized if they're
10827 * constants; they need to be allocated as common memory and just
10828 * their pointers copied. */
10831 CLONE_PARAMS clone_params;
10832 CLONE_PARAMS* param = &clone_params;
10834 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10835 PERL_SET_THX(my_perl);
10838 Poison(my_perl, 1, PerlInterpreter);
10842 PL_savestack_ix = 0;
10843 PL_savestack_max = -1;
10845 PL_sig_pending = 0;
10846 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10847 # else /* !DEBUGGING */
10848 Zero(my_perl, 1, PerlInterpreter);
10849 # endif /* DEBUGGING */
10851 /* host pointers */
10853 PL_MemShared = ipMS;
10854 PL_MemParse = ipMP;
10861 #else /* !PERL_IMPLICIT_SYS */
10863 CLONE_PARAMS clone_params;
10864 CLONE_PARAMS* param = &clone_params;
10865 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10866 PERL_SET_THX(my_perl);
10871 Poison(my_perl, 1, PerlInterpreter);
10875 PL_savestack_ix = 0;
10876 PL_savestack_max = -1;
10878 PL_sig_pending = 0;
10879 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10880 # else /* !DEBUGGING */
10881 Zero(my_perl, 1, PerlInterpreter);
10882 # endif /* DEBUGGING */
10883 #endif /* PERL_IMPLICIT_SYS */
10884 param->flags = flags;
10885 param->proto_perl = proto_perl;
10888 PL_xiv_arenaroot = NULL;
10889 PL_xiv_root = NULL;
10890 PL_xnv_arenaroot = NULL;
10891 PL_xnv_root = NULL;
10892 PL_xrv_arenaroot = NULL;
10893 PL_xrv_root = NULL;
10894 PL_xpv_arenaroot = NULL;
10895 PL_xpv_root = NULL;
10896 PL_xpviv_arenaroot = NULL;
10897 PL_xpviv_root = NULL;
10898 PL_xpvnv_arenaroot = NULL;
10899 PL_xpvnv_root = NULL;
10900 PL_xpvcv_arenaroot = NULL;
10901 PL_xpvcv_root = NULL;
10902 PL_xpvav_arenaroot = NULL;
10903 PL_xpvav_root = NULL;
10904 PL_xpvhv_arenaroot = NULL;
10905 PL_xpvhv_root = NULL;
10906 PL_xpvmg_arenaroot = NULL;
10907 PL_xpvmg_root = NULL;
10908 PL_xpvlv_arenaroot = NULL;
10909 PL_xpvlv_root = NULL;
10910 PL_xpvbm_arenaroot = NULL;
10911 PL_xpvbm_root = NULL;
10912 PL_he_arenaroot = NULL;
10914 PL_nice_chunk = NULL;
10915 PL_nice_chunk_size = 0;
10917 PL_sv_objcount = 0;
10918 PL_sv_root = Nullsv;
10919 PL_sv_arenaroot = Nullsv;
10921 PL_debug = proto_perl->Idebug;
10923 #ifdef USE_REENTRANT_API
10924 Perl_reentrant_init(aTHX);
10927 /* create SV map for pointer relocation */
10928 PL_ptr_table = ptr_table_new();
10930 /* initialize these special pointers as early as possible */
10931 SvANY(&PL_sv_undef) = NULL;
10932 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10933 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10934 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10936 SvANY(&PL_sv_no) = new_XPVNV();
10937 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10938 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10939 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
10940 SvCUR(&PL_sv_no) = 0;
10941 SvLEN(&PL_sv_no) = 1;
10942 SvNVX(&PL_sv_no) = 0;
10943 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10945 SvANY(&PL_sv_yes) = new_XPVNV();
10946 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10947 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10948 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
10949 SvCUR(&PL_sv_yes) = 1;
10950 SvLEN(&PL_sv_yes) = 2;
10951 SvNVX(&PL_sv_yes) = 1;
10952 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10954 /* create (a non-shared!) shared string table */
10955 PL_strtab = newHV();
10956 HvSHAREKEYS_off(PL_strtab);
10957 hv_ksplit(PL_strtab, 512);
10958 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10960 PL_compiling = proto_perl->Icompiling;
10962 /* These two PVs will be free'd special way so must set them same way op.c does */
10963 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10964 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10966 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10967 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10969 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10970 if (!specialWARN(PL_compiling.cop_warnings))
10971 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10972 if (!specialCopIO(PL_compiling.cop_io))
10973 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10974 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10976 /* pseudo environmental stuff */
10977 PL_origargc = proto_perl->Iorigargc;
10978 PL_origargv = proto_perl->Iorigargv;
10980 param->stashes = newAV(); /* Setup array of objects to call clone on */
10982 #ifdef PERLIO_LAYERS
10983 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10984 PerlIO_clone(aTHX_ proto_perl, param);
10987 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10988 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10989 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10990 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10991 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10992 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10995 PL_minus_c = proto_perl->Iminus_c;
10996 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10997 PL_localpatches = proto_perl->Ilocalpatches;
10998 PL_splitstr = proto_perl->Isplitstr;
10999 PL_preprocess = proto_perl->Ipreprocess;
11000 PL_minus_n = proto_perl->Iminus_n;
11001 PL_minus_p = proto_perl->Iminus_p;
11002 PL_minus_l = proto_perl->Iminus_l;
11003 PL_minus_a = proto_perl->Iminus_a;
11004 PL_minus_F = proto_perl->Iminus_F;
11005 PL_doswitches = proto_perl->Idoswitches;
11006 PL_dowarn = proto_perl->Idowarn;
11007 PL_doextract = proto_perl->Idoextract;
11008 PL_sawampersand = proto_perl->Isawampersand;
11009 PL_unsafe = proto_perl->Iunsafe;
11010 PL_inplace = SAVEPV(proto_perl->Iinplace);
11011 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11012 PL_perldb = proto_perl->Iperldb;
11013 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11014 PL_exit_flags = proto_perl->Iexit_flags;
11016 /* magical thingies */
11017 /* XXX time(&PL_basetime) when asked for? */
11018 PL_basetime = proto_perl->Ibasetime;
11019 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11021 PL_maxsysfd = proto_perl->Imaxsysfd;
11022 PL_multiline = proto_perl->Imultiline;
11023 PL_statusvalue = proto_perl->Istatusvalue;
11025 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11027 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11029 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11030 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11031 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11033 /* Clone the regex array */
11034 PL_regex_padav = newAV();
11036 I32 len = av_len((AV*)proto_perl->Iregex_padav);
11037 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11038 av_push(PL_regex_padav,
11039 sv_dup_inc(regexen[0],param));
11040 for(i = 1; i <= len; i++) {
11041 if(SvREPADTMP(regexen[i])) {
11042 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11044 av_push(PL_regex_padav,
11046 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11047 SvIVX(regexen[i])), param)))
11052 PL_regex_pad = AvARRAY(PL_regex_padav);
11054 /* shortcuts to various I/O objects */
11055 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11056 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11057 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11058 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11059 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11060 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11062 /* shortcuts to regexp stuff */
11063 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11065 /* shortcuts to misc objects */
11066 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11068 /* shortcuts to debugging objects */
11069 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11070 PL_DBline = gv_dup(proto_perl->IDBline, param);
11071 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11072 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11073 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11074 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11075 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11076 PL_lineary = av_dup(proto_perl->Ilineary, param);
11077 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11079 /* symbol tables */
11080 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11081 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11082 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11083 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11084 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11086 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11087 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11088 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11089 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11090 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11091 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11093 PL_sub_generation = proto_perl->Isub_generation;
11095 /* funky return mechanisms */
11096 PL_forkprocess = proto_perl->Iforkprocess;
11098 /* subprocess state */
11099 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11101 /* internal state */
11102 PL_tainting = proto_perl->Itainting;
11103 PL_taint_warn = proto_perl->Itaint_warn;
11104 PL_maxo = proto_perl->Imaxo;
11105 if (proto_perl->Iop_mask)
11106 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11108 PL_op_mask = Nullch;
11109 /* PL_asserting = proto_perl->Iasserting; */
11111 /* current interpreter roots */
11112 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11113 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11114 PL_main_start = proto_perl->Imain_start;
11115 PL_eval_root = proto_perl->Ieval_root;
11116 PL_eval_start = proto_perl->Ieval_start;
11118 /* runtime control stuff */
11119 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11120 PL_copline = proto_perl->Icopline;
11122 PL_filemode = proto_perl->Ifilemode;
11123 PL_lastfd = proto_perl->Ilastfd;
11124 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11127 PL_gensym = proto_perl->Igensym;
11128 PL_preambled = proto_perl->Ipreambled;
11129 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11130 PL_laststatval = proto_perl->Ilaststatval;
11131 PL_laststype = proto_perl->Ilaststype;
11132 PL_mess_sv = Nullsv;
11134 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11135 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11137 /* interpreter atexit processing */
11138 PL_exitlistlen = proto_perl->Iexitlistlen;
11139 if (PL_exitlistlen) {
11140 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11141 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11144 PL_exitlist = (PerlExitListEntry*)NULL;
11145 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11146 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11147 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11149 PL_profiledata = NULL;
11150 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11151 /* PL_rsfp_filters entries have fake IoDIRP() */
11152 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11154 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11156 PAD_CLONE_VARS(proto_perl, param);
11158 #ifdef HAVE_INTERP_INTERN
11159 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11162 /* more statics moved here */
11163 PL_generation = proto_perl->Igeneration;
11164 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11166 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11167 PL_in_clean_all = proto_perl->Iin_clean_all;
11169 PL_uid = proto_perl->Iuid;
11170 PL_euid = proto_perl->Ieuid;
11171 PL_gid = proto_perl->Igid;
11172 PL_egid = proto_perl->Iegid;
11173 PL_nomemok = proto_perl->Inomemok;
11174 PL_an = proto_perl->Ian;
11175 PL_op_seqmax = proto_perl->Iop_seqmax;
11176 PL_evalseq = proto_perl->Ievalseq;
11177 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11178 PL_origalen = proto_perl->Iorigalen;
11179 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11180 PL_osname = SAVEPV(proto_perl->Iosname);
11181 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11182 PL_sighandlerp = proto_perl->Isighandlerp;
11185 PL_runops = proto_perl->Irunops;
11187 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11190 PL_cshlen = proto_perl->Icshlen;
11191 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11194 PL_lex_state = proto_perl->Ilex_state;
11195 PL_lex_defer = proto_perl->Ilex_defer;
11196 PL_lex_expect = proto_perl->Ilex_expect;
11197 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11198 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11199 PL_lex_starts = proto_perl->Ilex_starts;
11200 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11201 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11202 PL_lex_op = proto_perl->Ilex_op;
11203 PL_lex_inpat = proto_perl->Ilex_inpat;
11204 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11205 PL_lex_brackets = proto_perl->Ilex_brackets;
11206 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11207 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11208 PL_lex_casemods = proto_perl->Ilex_casemods;
11209 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11210 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11212 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11213 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11214 PL_nexttoke = proto_perl->Inexttoke;
11216 /* XXX This is probably masking the deeper issue of why
11217 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11218 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11219 * (A little debugging with a watchpoint on it may help.)
11221 if (SvANY(proto_perl->Ilinestr)) {
11222 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11223 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11224 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11225 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11226 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11227 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11228 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11229 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11230 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11233 PL_linestr = NEWSV(65,79);
11234 sv_upgrade(PL_linestr,SVt_PVIV);
11235 sv_setpvn(PL_linestr,"",0);
11236 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11238 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11239 PL_pending_ident = proto_perl->Ipending_ident;
11240 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11242 PL_expect = proto_perl->Iexpect;
11244 PL_multi_start = proto_perl->Imulti_start;
11245 PL_multi_end = proto_perl->Imulti_end;
11246 PL_multi_open = proto_perl->Imulti_open;
11247 PL_multi_close = proto_perl->Imulti_close;
11249 PL_error_count = proto_perl->Ierror_count;
11250 PL_subline = proto_perl->Isubline;
11251 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11253 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11254 if (SvANY(proto_perl->Ilinestr)) {
11255 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11256 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11257 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11258 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11259 PL_last_lop_op = proto_perl->Ilast_lop_op;
11262 PL_last_uni = SvPVX(PL_linestr);
11263 PL_last_lop = SvPVX(PL_linestr);
11264 PL_last_lop_op = 0;
11266 PL_in_my = proto_perl->Iin_my;
11267 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11269 PL_cryptseen = proto_perl->Icryptseen;
11272 PL_hints = proto_perl->Ihints;
11274 PL_amagic_generation = proto_perl->Iamagic_generation;
11276 #ifdef USE_LOCALE_COLLATE
11277 PL_collation_ix = proto_perl->Icollation_ix;
11278 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11279 PL_collation_standard = proto_perl->Icollation_standard;
11280 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11281 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11282 #endif /* USE_LOCALE_COLLATE */
11284 #ifdef USE_LOCALE_NUMERIC
11285 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11286 PL_numeric_standard = proto_perl->Inumeric_standard;
11287 PL_numeric_local = proto_perl->Inumeric_local;
11288 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11289 #endif /* !USE_LOCALE_NUMERIC */
11291 /* utf8 character classes */
11292 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11293 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11294 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11295 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11296 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11297 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11298 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11299 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11300 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11301 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11302 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11303 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11304 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11305 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11306 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11307 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11308 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11309 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11310 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11311 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11313 /* Did the locale setup indicate UTF-8? */
11314 PL_utf8locale = proto_perl->Iutf8locale;
11315 /* Unicode features (see perlrun/-C) */
11316 PL_unicode = proto_perl->Iunicode;
11318 /* Pre-5.8 signals control */
11319 PL_signals = proto_perl->Isignals;
11321 /* times() ticks per second */
11322 PL_clocktick = proto_perl->Iclocktick;
11324 /* Recursion stopper for PerlIO_find_layer */
11325 PL_in_load_module = proto_perl->Iin_load_module;
11327 /* sort() routine */
11328 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11330 /* Not really needed/useful since the reenrant_retint is "volatile",
11331 * but do it for consistency's sake. */
11332 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11334 /* Hooks to shared SVs and locks. */
11335 PL_sharehook = proto_perl->Isharehook;
11336 PL_lockhook = proto_perl->Ilockhook;
11337 PL_unlockhook = proto_perl->Iunlockhook;
11338 PL_threadhook = proto_perl->Ithreadhook;
11340 PL_runops_std = proto_perl->Irunops_std;
11341 PL_runops_dbg = proto_perl->Irunops_dbg;
11343 #ifdef THREADS_HAVE_PIDS
11344 PL_ppid = proto_perl->Ippid;
11348 PL_last_swash_hv = Nullhv; /* reinits on demand */
11349 PL_last_swash_klen = 0;
11350 PL_last_swash_key[0]= '\0';
11351 PL_last_swash_tmps = (U8*)NULL;
11352 PL_last_swash_slen = 0;
11354 /* perly.c globals */
11355 PL_yydebug = proto_perl->Iyydebug;
11356 PL_yynerrs = proto_perl->Iyynerrs;
11357 PL_yyerrflag = proto_perl->Iyyerrflag;
11358 PL_yychar = proto_perl->Iyychar;
11359 PL_yyval = proto_perl->Iyyval;
11360 PL_yylval = proto_perl->Iyylval;
11362 PL_glob_index = proto_perl->Iglob_index;
11363 PL_srand_called = proto_perl->Isrand_called;
11364 PL_hash_seed = proto_perl->Ihash_seed;
11365 PL_new_hash_seed = proto_perl->Inew_hash_seed;
11366 PL_uudmap['M'] = 0; /* reinits on demand */
11367 PL_bitcount = Nullch; /* reinits on demand */
11369 if (proto_perl->Ipsig_pend) {
11370 Newz(0, PL_psig_pend, SIG_SIZE, int);
11373 PL_psig_pend = (int*)NULL;
11376 if (proto_perl->Ipsig_ptr) {
11377 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
11378 Newz(0, PL_psig_name, SIG_SIZE, SV*);
11379 for (i = 1; i < SIG_SIZE; i++) {
11380 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11381 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11385 PL_psig_ptr = (SV**)NULL;
11386 PL_psig_name = (SV**)NULL;
11389 /* thrdvar.h stuff */
11391 if (flags & CLONEf_COPY_STACKS) {
11392 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11393 PL_tmps_ix = proto_perl->Ttmps_ix;
11394 PL_tmps_max = proto_perl->Ttmps_max;
11395 PL_tmps_floor = proto_perl->Ttmps_floor;
11396 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
11398 while (i <= PL_tmps_ix) {
11399 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11403 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11404 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11405 Newz(54, PL_markstack, i, I32);
11406 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11407 - proto_perl->Tmarkstack);
11408 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11409 - proto_perl->Tmarkstack);
11410 Copy(proto_perl->Tmarkstack, PL_markstack,
11411 PL_markstack_ptr - PL_markstack + 1, I32);
11413 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11414 * NOTE: unlike the others! */
11415 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11416 PL_scopestack_max = proto_perl->Tscopestack_max;
11417 Newz(54, PL_scopestack, PL_scopestack_max, I32);
11418 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11420 /* next push_return() sets PL_retstack[PL_retstack_ix]
11421 * NOTE: unlike the others! */
11422 PL_retstack_ix = proto_perl->Tretstack_ix;
11423 PL_retstack_max = proto_perl->Tretstack_max;
11424 Newz(54, PL_retstack, PL_retstack_max, OP*);
11425 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
11427 /* NOTE: si_dup() looks at PL_markstack */
11428 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11430 /* PL_curstack = PL_curstackinfo->si_stack; */
11431 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11432 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11434 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11435 PL_stack_base = AvARRAY(PL_curstack);
11436 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11437 - proto_perl->Tstack_base);
11438 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11440 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11441 * NOTE: unlike the others! */
11442 PL_savestack_ix = proto_perl->Tsavestack_ix;
11443 PL_savestack_max = proto_perl->Tsavestack_max;
11444 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11445 PL_savestack = ss_dup(proto_perl, param);
11449 ENTER; /* perl_destruct() wants to LEAVE; */
11452 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11453 PL_top_env = &PL_start_env;
11455 PL_op = proto_perl->Top;
11458 PL_Xpv = (XPV*)NULL;
11459 PL_na = proto_perl->Tna;
11461 PL_statbuf = proto_perl->Tstatbuf;
11462 PL_statcache = proto_perl->Tstatcache;
11463 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11464 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11466 PL_timesbuf = proto_perl->Ttimesbuf;
11469 PL_tainted = proto_perl->Ttainted;
11470 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11471 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11472 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11473 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11474 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11475 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11476 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11477 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11478 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11480 PL_restartop = proto_perl->Trestartop;
11481 PL_in_eval = proto_perl->Tin_eval;
11482 PL_delaymagic = proto_perl->Tdelaymagic;
11483 PL_dirty = proto_perl->Tdirty;
11484 PL_localizing = proto_perl->Tlocalizing;
11486 #ifdef PERL_FLEXIBLE_EXCEPTIONS
11487 PL_protect = proto_perl->Tprotect;
11489 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11490 PL_hv_fetch_ent_mh = Nullhe;
11491 PL_modcount = proto_perl->Tmodcount;
11492 PL_lastgotoprobe = Nullop;
11493 PL_dumpindent = proto_perl->Tdumpindent;
11495 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11496 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11497 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11498 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11499 PL_sortcxix = proto_perl->Tsortcxix;
11500 PL_efloatbuf = Nullch; /* reinits on demand */
11501 PL_efloatsize = 0; /* reinits on demand */
11505 PL_screamfirst = NULL;
11506 PL_screamnext = NULL;
11507 PL_maxscream = -1; /* reinits on demand */
11508 PL_lastscream = Nullsv;
11510 PL_watchaddr = NULL;
11511 PL_watchok = Nullch;
11513 PL_regdummy = proto_perl->Tregdummy;
11514 PL_regprecomp = Nullch;
11517 PL_colorset = 0; /* reinits PL_colors[] */
11518 /*PL_colors[6] = {0,0,0,0,0,0};*/
11519 PL_reginput = Nullch;
11520 PL_regbol = Nullch;
11521 PL_regeol = Nullch;
11522 PL_regstartp = (I32*)NULL;
11523 PL_regendp = (I32*)NULL;
11524 PL_reglastparen = (U32*)NULL;
11525 PL_reglastcloseparen = (U32*)NULL;
11526 PL_regtill = Nullch;
11527 PL_reg_start_tmp = (char**)NULL;
11528 PL_reg_start_tmpl = 0;
11529 PL_regdata = (struct reg_data*)NULL;
11532 PL_reg_eval_set = 0;
11534 PL_regprogram = (regnode*)NULL;
11536 PL_regcc = (CURCUR*)NULL;
11537 PL_reg_call_cc = (struct re_cc_state*)NULL;
11538 PL_reg_re = (regexp*)NULL;
11539 PL_reg_ganch = Nullch;
11540 PL_reg_sv = Nullsv;
11541 PL_reg_match_utf8 = FALSE;
11542 PL_reg_magic = (MAGIC*)NULL;
11544 PL_reg_oldcurpm = (PMOP*)NULL;
11545 PL_reg_curpm = (PMOP*)NULL;
11546 PL_reg_oldsaved = Nullch;
11547 PL_reg_oldsavedlen = 0;
11548 #ifdef PERL_COPY_ON_WRITE
11551 PL_reg_maxiter = 0;
11552 PL_reg_leftiter = 0;
11553 PL_reg_poscache = Nullch;
11554 PL_reg_poscache_size= 0;
11556 /* RE engine - function pointers */
11557 PL_regcompp = proto_perl->Tregcompp;
11558 PL_regexecp = proto_perl->Tregexecp;
11559 PL_regint_start = proto_perl->Tregint_start;
11560 PL_regint_string = proto_perl->Tregint_string;
11561 PL_regfree = proto_perl->Tregfree;
11563 PL_reginterp_cnt = 0;
11564 PL_reg_starttry = 0;
11566 /* Pluggable optimizer */
11567 PL_peepp = proto_perl->Tpeepp;
11569 PL_stashcache = newHV();
11571 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11572 ptr_table_free(PL_ptr_table);
11573 PL_ptr_table = NULL;
11576 /* Call the ->CLONE method, if it exists, for each of the stashes
11577 identified by sv_dup() above.
11579 while(av_len(param->stashes) != -1) {
11580 HV* stash = (HV*) av_shift(param->stashes);
11581 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11582 if (cloner && GvCV(cloner)) {
11587 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
11589 call_sv((SV*)GvCV(cloner), G_DISCARD);
11595 SvREFCNT_dec(param->stashes);
11600 #endif /* USE_ITHREADS */
11603 =head1 Unicode Support
11605 =for apidoc sv_recode_to_utf8
11607 The encoding is assumed to be an Encode object, on entry the PV
11608 of the sv is assumed to be octets in that encoding, and the sv
11609 will be converted into Unicode (and UTF-8).
11611 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11612 is not a reference, nothing is done to the sv. If the encoding is not
11613 an C<Encode::XS> Encoding object, bad things will happen.
11614 (See F<lib/encoding.pm> and L<Encode>).
11616 The PV of the sv is returned.
11621 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11623 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11637 Passing sv_yes is wrong - it needs to be or'ed set of constants
11638 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11639 remove converted chars from source.
11641 Both will default the value - let them.
11643 XPUSHs(&PL_sv_yes);
11646 call_method("decode", G_SCALAR);
11650 s = SvPV(uni, len);
11651 if (s != SvPVX(sv)) {
11652 SvGROW(sv, len + 1);
11653 Move(s, SvPVX(sv), len, char);
11654 SvCUR_set(sv, len);
11655 SvPVX(sv)[len] = 0;
11665 =for apidoc sv_cat_decode
11667 The encoding is assumed to be an Encode object, the PV of the ssv is
11668 assumed to be octets in that encoding and decoding the input starts
11669 from the position which (PV + *offset) pointed to. The dsv will be
11670 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11671 when the string tstr appears in decoding output or the input ends on
11672 the PV of the ssv. The value which the offset points will be modified
11673 to the last input position on the ssv.
11675 Returns TRUE if the terminator was found, else returns FALSE.
11680 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11681 SV *ssv, int *offset, char *tstr, int tlen)
11684 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11695 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11696 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11698 call_method("cat_decode", G_SCALAR);
11700 ret = SvTRUE(TOPs);
11701 *offset = SvIV(offsv);
11707 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");