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_COPY_ON_WRITE
28 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
29 #define SV_COW_NEXT_SV_SET(current,next) SvUVX(current) = PTR2UV(next)
30 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
34 /* ============================================================================
36 =head1 Allocation and deallocation of SVs.
38 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
39 av, hv...) contains type and reference count information, as well as a
40 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
41 specific to each type.
43 Normally, this allocation is done using arenas, which are approximately
44 1K chunks of memory parcelled up into N heads or bodies. The first slot
45 in each arena is reserved, and is used to hold a link to the next arena.
46 In the case of heads, the unused first slot also contains some flags and
47 a note of the number of slots. Snaked through each arena chain is a
48 linked list of free items; when this becomes empty, an extra arena is
49 allocated and divided up into N items which are threaded into the free
52 The following global variables are associated with arenas:
54 PL_sv_arenaroot pointer to list of SV arenas
55 PL_sv_root pointer to list of free SV structures
57 PL_foo_arenaroot pointer to list of foo arenas,
58 PL_foo_root pointer to list of free foo bodies
59 ... for foo in xiv, xnv, xrv, xpv etc.
61 Note that some of the larger and more rarely used body types (eg xpvio)
62 are not allocated using arenas, but are instead just malloc()/free()ed as
63 required. Also, if PURIFY is defined, arenas are abandoned altogether,
64 with all items individually malloc()ed. In addition, a few SV heads are
65 not allocated from an arena, but are instead directly created as static
66 or auto variables, eg PL_sv_undef.
68 The SV arena serves the secondary purpose of allowing still-live SVs
69 to be located and destroyed during final cleanup.
71 At the lowest level, the macros new_SV() and del_SV() grab and free
72 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
73 to return the SV to the free list with error checking.) new_SV() calls
74 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
75 SVs in the free list have their SvTYPE field set to all ones.
77 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
78 that allocate and return individual body types. Normally these are mapped
79 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
80 instead mapped directly to malloc()/free() if PURIFY is defined. The
81 new/del functions remove from, or add to, the appropriate PL_foo_root
82 list, and call more_xiv() etc to add a new arena if the list is empty.
84 At the time of very final cleanup, sv_free_arenas() is called from
85 perl_destruct() to physically free all the arenas allocated since the
86 start of the interpreter. Note that this also clears PL_he_arenaroot,
87 which is otherwise dealt with in hv.c.
89 Manipulation of any of the PL_*root pointers is protected by enclosing
90 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
91 if threads are enabled.
93 The function visit() scans the SV arenas list, and calls a specified
94 function for each SV it finds which is still live - ie which has an SvTYPE
95 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
96 following functions (specified as [function that calls visit()] / [function
97 called by visit() for each SV]):
99 sv_report_used() / do_report_used()
100 dump all remaining SVs (debugging aid)
102 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
103 Attempt to free all objects pointed to by RVs,
104 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
105 try to do the same for all objects indirectly
106 referenced by typeglobs too. Called once from
107 perl_destruct(), prior to calling sv_clean_all()
110 sv_clean_all() / do_clean_all()
111 SvREFCNT_dec(sv) each remaining SV, possibly
112 triggering an sv_free(). It also sets the
113 SVf_BREAK flag on the SV to indicate that the
114 refcnt has been artificially lowered, and thus
115 stopping sv_free() from giving spurious warnings
116 about SVs which unexpectedly have a refcnt
117 of zero. called repeatedly from perl_destruct()
118 until there are no SVs left.
122 Private API to rest of sv.c
126 new_XIV(), del_XIV(),
127 new_XNV(), del_XNV(),
132 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
137 ============================================================================ */
142 * "A time to plant, and a time to uproot what was planted..."
145 #define plant_SV(p) \
147 SvANY(p) = (void *)PL_sv_root; \
148 SvFLAGS(p) = SVTYPEMASK; \
153 /* sv_mutex must be held while calling uproot_SV() */
154 #define uproot_SV(p) \
157 PL_sv_root = (SV*)SvANY(p); \
162 /* new_SV(): return a new, empty SV head */
164 #ifdef DEBUG_LEAKING_SCALARS
165 /* provide a real function for a debugger to play with */
182 # define new_SV(p) (p)=S_new_SV(aTHX)
200 /* del_SV(): return an empty SV head to the free list */
215 S_del_sv(pTHX_ SV *p)
222 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
224 svend = &sva[SvREFCNT(sva)];
225 if (p >= sv && p < svend)
229 if (ckWARN_d(WARN_INTERNAL))
230 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
231 "Attempt to free non-arena SV: 0x%"UVxf,
239 #else /* ! DEBUGGING */
241 #define del_SV(p) plant_SV(p)
243 #endif /* DEBUGGING */
247 =head1 SV Manipulation Functions
249 =for apidoc sv_add_arena
251 Given a chunk of memory, link it to the head of the list of arenas,
252 and split it into a list of free SVs.
258 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
263 Zero(ptr, size, char);
265 /* The first SV in an arena isn't an SV. */
266 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
267 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
268 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
270 PL_sv_arenaroot = sva;
271 PL_sv_root = sva + 1;
273 svend = &sva[SvREFCNT(sva) - 1];
276 SvANY(sv) = (void *)(SV*)(sv + 1);
277 SvFLAGS(sv) = SVTYPEMASK;
281 SvFLAGS(sv) = SVTYPEMASK;
284 /* make some more SVs by adding another arena */
286 /* sv_mutex must be held while calling more_sv() */
293 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
294 PL_nice_chunk = Nullch;
295 PL_nice_chunk_size = 0;
298 char *chunk; /* must use New here to match call to */
299 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
300 sv_add_arena(chunk, 1008, 0);
306 /* visit(): call the named function for each non-free SV in the arenas. */
309 S_visit(pTHX_ SVFUNC_t f)
316 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
317 svend = &sva[SvREFCNT(sva)];
318 for (sv = sva + 1; sv < svend; ++sv) {
319 if (SvTYPE(sv) != SVTYPEMASK && SvREFCNT(sv)) {
330 /* called by sv_report_used() for each live SV */
333 do_report_used(pTHX_ SV *sv)
335 if (SvTYPE(sv) != SVTYPEMASK) {
336 PerlIO_printf(Perl_debug_log, "****\n");
343 =for apidoc sv_report_used
345 Dump the contents of all SVs not yet freed. (Debugging aid).
351 Perl_sv_report_used(pTHX)
354 visit(do_report_used);
358 /* called by sv_clean_objs() for each live SV */
361 do_clean_objs(pTHX_ SV *sv)
365 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
366 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
378 /* XXX Might want to check arrays, etc. */
381 /* called by sv_clean_objs() for each live SV */
383 #ifndef DISABLE_DESTRUCTOR_KLUDGE
385 do_clean_named_objs(pTHX_ SV *sv)
387 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
388 if ( SvOBJECT(GvSV(sv)) ||
389 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
390 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
391 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
392 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
394 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
402 =for apidoc sv_clean_objs
404 Attempt to destroy all objects not yet freed
410 Perl_sv_clean_objs(pTHX)
412 PL_in_clean_objs = TRUE;
413 visit(do_clean_objs);
414 #ifndef DISABLE_DESTRUCTOR_KLUDGE
415 /* some barnacles may yet remain, clinging to typeglobs */
416 visit(do_clean_named_objs);
418 PL_in_clean_objs = FALSE;
421 /* called by sv_clean_all() for each live SV */
424 do_clean_all(pTHX_ SV *sv)
426 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
427 SvFLAGS(sv) |= SVf_BREAK;
432 =for apidoc sv_clean_all
434 Decrement the refcnt of each remaining SV, possibly triggering a
435 cleanup. This function may have to be called multiple times to free
436 SVs which are in complex self-referential hierarchies.
442 Perl_sv_clean_all(pTHX)
445 PL_in_clean_all = TRUE;
446 cleaned = visit(do_clean_all);
447 PL_in_clean_all = FALSE;
452 =for apidoc sv_free_arenas
454 Deallocate the memory used by all arenas. Note that all the individual SV
455 heads and bodies within the arenas must already have been freed.
461 Perl_sv_free_arenas(pTHX)
465 XPV *arena, *arenanext;
467 /* Free arenas here, but be careful about fake ones. (We assume
468 contiguity of the fake ones with the corresponding real ones.) */
470 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
471 svanext = (SV*) SvANY(sva);
472 while (svanext && SvFAKE(svanext))
473 svanext = (SV*) SvANY(svanext);
476 Safefree((void *)sva);
479 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
480 arenanext = (XPV*)arena->xpv_pv;
483 PL_xiv_arenaroot = 0;
485 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
486 arenanext = (XPV*)arena->xpv_pv;
489 PL_xnv_arenaroot = 0;
491 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
492 arenanext = (XPV*)arena->xpv_pv;
495 PL_xrv_arenaroot = 0;
497 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
498 arenanext = (XPV*)arena->xpv_pv;
501 PL_xpv_arenaroot = 0;
503 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
504 arenanext = (XPV*)arena->xpv_pv;
507 PL_xpviv_arenaroot = 0;
509 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
510 arenanext = (XPV*)arena->xpv_pv;
513 PL_xpvnv_arenaroot = 0;
515 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
516 arenanext = (XPV*)arena->xpv_pv;
519 PL_xpvcv_arenaroot = 0;
521 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
522 arenanext = (XPV*)arena->xpv_pv;
525 PL_xpvav_arenaroot = 0;
527 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
528 arenanext = (XPV*)arena->xpv_pv;
531 PL_xpvhv_arenaroot = 0;
533 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
534 arenanext = (XPV*)arena->xpv_pv;
537 PL_xpvmg_arenaroot = 0;
539 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
540 arenanext = (XPV*)arena->xpv_pv;
543 PL_xpvlv_arenaroot = 0;
545 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
546 arenanext = (XPV*)arena->xpv_pv;
549 PL_xpvbm_arenaroot = 0;
551 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
552 arenanext = (XPV*)arena->xpv_pv;
558 Safefree(PL_nice_chunk);
559 PL_nice_chunk = Nullch;
560 PL_nice_chunk_size = 0;
566 =for apidoc report_uninit
568 Print appropriate "Use of uninitialized variable" warning
574 Perl_report_uninit(pTHX)
577 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
578 " in ", OP_DESC(PL_op));
580 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit, "", "");
583 /* grab a new IV body from the free list, allocating more if necessary */
594 * See comment in more_xiv() -- RAM.
596 PL_xiv_root = *(IV**)xiv;
598 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
601 /* return an IV body to the free list */
604 S_del_xiv(pTHX_ XPVIV *p)
606 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
608 *(IV**)xiv = PL_xiv_root;
613 /* allocate another arena's worth of IV bodies */
621 New(705, ptr, 1008/sizeof(XPV), XPV);
622 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
623 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
626 xivend = &xiv[1008 / sizeof(IV) - 1];
627 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
629 while (xiv < xivend) {
630 *(IV**)xiv = (IV *)(xiv + 1);
636 /* grab a new NV body from the free list, allocating more if necessary */
646 PL_xnv_root = *(NV**)xnv;
648 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
651 /* return an NV body to the free list */
654 S_del_xnv(pTHX_ XPVNV *p)
656 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
658 *(NV**)xnv = PL_xnv_root;
663 /* allocate another arena's worth of NV bodies */
671 New(711, ptr, 1008/sizeof(XPV), XPV);
672 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
673 PL_xnv_arenaroot = ptr;
676 xnvend = &xnv[1008 / sizeof(NV) - 1];
677 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
679 while (xnv < xnvend) {
680 *(NV**)xnv = (NV*)(xnv + 1);
686 /* grab a new struct xrv from the free list, allocating more if necessary */
696 PL_xrv_root = (XRV*)xrv->xrv_rv;
701 /* return a struct xrv to the free list */
704 S_del_xrv(pTHX_ XRV *p)
707 p->xrv_rv = (SV*)PL_xrv_root;
712 /* allocate another arena's worth of struct xrv */
718 register XRV* xrvend;
720 New(712, ptr, 1008/sizeof(XPV), XPV);
721 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
722 PL_xrv_arenaroot = ptr;
725 xrvend = &xrv[1008 / sizeof(XRV) - 1];
726 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
728 while (xrv < xrvend) {
729 xrv->xrv_rv = (SV*)(xrv + 1);
735 /* grab a new struct xpv from the free list, allocating more if necessary */
745 PL_xpv_root = (XPV*)xpv->xpv_pv;
750 /* return a struct xpv to the free list */
753 S_del_xpv(pTHX_ XPV *p)
756 p->xpv_pv = (char*)PL_xpv_root;
761 /* allocate another arena's worth of struct xpv */
767 register XPV* xpvend;
768 New(713, xpv, 1008/sizeof(XPV), XPV);
769 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
770 PL_xpv_arenaroot = xpv;
772 xpvend = &xpv[1008 / sizeof(XPV) - 1];
774 while (xpv < xpvend) {
775 xpv->xpv_pv = (char*)(xpv + 1);
781 /* grab a new struct xpviv from the free list, allocating more if necessary */
790 xpviv = PL_xpviv_root;
791 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
796 /* return a struct xpviv to the free list */
799 S_del_xpviv(pTHX_ XPVIV *p)
802 p->xpv_pv = (char*)PL_xpviv_root;
807 /* allocate another arena's worth of struct xpviv */
812 register XPVIV* xpviv;
813 register XPVIV* xpvivend;
814 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
815 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
816 PL_xpviv_arenaroot = xpviv;
818 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
819 PL_xpviv_root = ++xpviv;
820 while (xpviv < xpvivend) {
821 xpviv->xpv_pv = (char*)(xpviv + 1);
827 /* grab a new struct xpvnv from the free list, allocating more if necessary */
836 xpvnv = PL_xpvnv_root;
837 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
842 /* return a struct xpvnv to the free list */
845 S_del_xpvnv(pTHX_ XPVNV *p)
848 p->xpv_pv = (char*)PL_xpvnv_root;
853 /* allocate another arena's worth of struct xpvnv */
858 register XPVNV* xpvnv;
859 register XPVNV* xpvnvend;
860 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
861 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
862 PL_xpvnv_arenaroot = xpvnv;
864 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
865 PL_xpvnv_root = ++xpvnv;
866 while (xpvnv < xpvnvend) {
867 xpvnv->xpv_pv = (char*)(xpvnv + 1);
873 /* grab a new struct xpvcv from the free list, allocating more if necessary */
882 xpvcv = PL_xpvcv_root;
883 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
888 /* return a struct xpvcv to the free list */
891 S_del_xpvcv(pTHX_ XPVCV *p)
894 p->xpv_pv = (char*)PL_xpvcv_root;
899 /* allocate another arena's worth of struct xpvcv */
904 register XPVCV* xpvcv;
905 register XPVCV* xpvcvend;
906 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
907 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
908 PL_xpvcv_arenaroot = xpvcv;
910 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
911 PL_xpvcv_root = ++xpvcv;
912 while (xpvcv < xpvcvend) {
913 xpvcv->xpv_pv = (char*)(xpvcv + 1);
919 /* grab a new struct xpvav from the free list, allocating more if necessary */
928 xpvav = PL_xpvav_root;
929 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
934 /* return a struct xpvav to the free list */
937 S_del_xpvav(pTHX_ XPVAV *p)
940 p->xav_array = (char*)PL_xpvav_root;
945 /* allocate another arena's worth of struct xpvav */
950 register XPVAV* xpvav;
951 register XPVAV* xpvavend;
952 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
953 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
954 PL_xpvav_arenaroot = xpvav;
956 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
957 PL_xpvav_root = ++xpvav;
958 while (xpvav < xpvavend) {
959 xpvav->xav_array = (char*)(xpvav + 1);
962 xpvav->xav_array = 0;
965 /* grab a new struct xpvhv from the free list, allocating more if necessary */
974 xpvhv = PL_xpvhv_root;
975 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
980 /* return a struct xpvhv to the free list */
983 S_del_xpvhv(pTHX_ XPVHV *p)
986 p->xhv_array = (char*)PL_xpvhv_root;
991 /* allocate another arena's worth of struct xpvhv */
996 register XPVHV* xpvhv;
997 register XPVHV* xpvhvend;
998 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
999 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1000 PL_xpvhv_arenaroot = xpvhv;
1002 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
1003 PL_xpvhv_root = ++xpvhv;
1004 while (xpvhv < xpvhvend) {
1005 xpvhv->xhv_array = (char*)(xpvhv + 1);
1008 xpvhv->xhv_array = 0;
1011 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1020 xpvmg = PL_xpvmg_root;
1021 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1026 /* return a struct xpvmg to the free list */
1029 S_del_xpvmg(pTHX_ XPVMG *p)
1032 p->xpv_pv = (char*)PL_xpvmg_root;
1037 /* allocate another arena's worth of struct xpvmg */
1042 register XPVMG* xpvmg;
1043 register XPVMG* xpvmgend;
1044 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1045 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1046 PL_xpvmg_arenaroot = xpvmg;
1048 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1049 PL_xpvmg_root = ++xpvmg;
1050 while (xpvmg < xpvmgend) {
1051 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1057 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1066 xpvlv = PL_xpvlv_root;
1067 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1072 /* return a struct xpvlv to the free list */
1075 S_del_xpvlv(pTHX_ XPVLV *p)
1078 p->xpv_pv = (char*)PL_xpvlv_root;
1083 /* allocate another arena's worth of struct xpvlv */
1088 register XPVLV* xpvlv;
1089 register XPVLV* xpvlvend;
1090 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1091 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1092 PL_xpvlv_arenaroot = xpvlv;
1094 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1095 PL_xpvlv_root = ++xpvlv;
1096 while (xpvlv < xpvlvend) {
1097 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1103 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1112 xpvbm = PL_xpvbm_root;
1113 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1118 /* return a struct xpvbm to the free list */
1121 S_del_xpvbm(pTHX_ XPVBM *p)
1124 p->xpv_pv = (char*)PL_xpvbm_root;
1129 /* allocate another arena's worth of struct xpvbm */
1134 register XPVBM* xpvbm;
1135 register XPVBM* xpvbmend;
1136 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1137 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1138 PL_xpvbm_arenaroot = xpvbm;
1140 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1141 PL_xpvbm_root = ++xpvbm;
1142 while (xpvbm < xpvbmend) {
1143 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1149 #define my_safemalloc(s) (void*)safemalloc(s)
1150 #define my_safefree(p) safefree((char*)p)
1154 #define new_XIV() my_safemalloc(sizeof(XPVIV))
1155 #define del_XIV(p) my_safefree(p)
1157 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1158 #define del_XNV(p) my_safefree(p)
1160 #define new_XRV() my_safemalloc(sizeof(XRV))
1161 #define del_XRV(p) my_safefree(p)
1163 #define new_XPV() my_safemalloc(sizeof(XPV))
1164 #define del_XPV(p) my_safefree(p)
1166 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1167 #define del_XPVIV(p) my_safefree(p)
1169 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1170 #define del_XPVNV(p) my_safefree(p)
1172 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1173 #define del_XPVCV(p) my_safefree(p)
1175 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1176 #define del_XPVAV(p) my_safefree(p)
1178 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1179 #define del_XPVHV(p) my_safefree(p)
1181 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1182 #define del_XPVMG(p) my_safefree(p)
1184 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1185 #define del_XPVLV(p) my_safefree(p)
1187 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1188 #define del_XPVBM(p) my_safefree(p)
1192 #define new_XIV() (void*)new_xiv()
1193 #define del_XIV(p) del_xiv((XPVIV*) p)
1195 #define new_XNV() (void*)new_xnv()
1196 #define del_XNV(p) del_xnv((XPVNV*) p)
1198 #define new_XRV() (void*)new_xrv()
1199 #define del_XRV(p) del_xrv((XRV*) p)
1201 #define new_XPV() (void*)new_xpv()
1202 #define del_XPV(p) del_xpv((XPV *)p)
1204 #define new_XPVIV() (void*)new_xpviv()
1205 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1207 #define new_XPVNV() (void*)new_xpvnv()
1208 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1210 #define new_XPVCV() (void*)new_xpvcv()
1211 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1213 #define new_XPVAV() (void*)new_xpvav()
1214 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1216 #define new_XPVHV() (void*)new_xpvhv()
1217 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1219 #define new_XPVMG() (void*)new_xpvmg()
1220 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1222 #define new_XPVLV() (void*)new_xpvlv()
1223 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1225 #define new_XPVBM() (void*)new_xpvbm()
1226 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1230 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1231 #define del_XPVGV(p) my_safefree(p)
1233 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1234 #define del_XPVFM(p) my_safefree(p)
1236 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1237 #define del_XPVIO(p) my_safefree(p)
1240 =for apidoc sv_upgrade
1242 Upgrade an SV to a more complex form. Generally adds a new body type to the
1243 SV, then copies across as much information as possible from the old body.
1244 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1250 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1257 MAGIC* magic = NULL;
1260 if (mt != SVt_PV && SvIsCOW(sv)) {
1261 sv_force_normal_flags(sv, 0);
1264 if (SvTYPE(sv) == mt)
1268 (void)SvOOK_off(sv);
1270 switch (SvTYPE(sv)) {
1291 else if (mt < SVt_PVIV)
1308 pv = (char*)SvRV(sv);
1328 else if (mt == SVt_NV)
1339 del_XPVIV(SvANY(sv));
1349 del_XPVNV(SvANY(sv));
1357 magic = SvMAGIC(sv);
1358 stash = SvSTASH(sv);
1359 del_XPVMG(SvANY(sv));
1362 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1367 Perl_croak(aTHX_ "Can't upgrade to undef");
1369 SvANY(sv) = new_XIV();
1373 SvANY(sv) = new_XNV();
1377 SvANY(sv) = new_XRV();
1381 SvANY(sv) = new_XPV();
1387 SvANY(sv) = new_XPVIV();
1397 SvANY(sv) = new_XPVNV();
1405 SvANY(sv) = new_XPVMG();
1411 SvMAGIC(sv) = magic;
1412 SvSTASH(sv) = stash;
1415 SvANY(sv) = new_XPVLV();
1421 SvMAGIC(sv) = magic;
1422 SvSTASH(sv) = stash;
1429 SvANY(sv) = new_XPVAV();
1437 SvMAGIC(sv) = magic;
1438 SvSTASH(sv) = stash;
1444 SvANY(sv) = new_XPVHV();
1450 HvTOTALKEYS(sv) = 0;
1451 HvPLACEHOLDERS(sv) = 0;
1452 SvMAGIC(sv) = magic;
1453 SvSTASH(sv) = stash;
1460 SvANY(sv) = new_XPVCV();
1461 Zero(SvANY(sv), 1, XPVCV);
1467 SvMAGIC(sv) = magic;
1468 SvSTASH(sv) = stash;
1471 SvANY(sv) = new_XPVGV();
1477 SvMAGIC(sv) = magic;
1478 SvSTASH(sv) = stash;
1486 SvANY(sv) = new_XPVBM();
1492 SvMAGIC(sv) = magic;
1493 SvSTASH(sv) = stash;
1499 SvANY(sv) = new_XPVFM();
1500 Zero(SvANY(sv), 1, XPVFM);
1506 SvMAGIC(sv) = magic;
1507 SvSTASH(sv) = stash;
1510 SvANY(sv) = new_XPVIO();
1511 Zero(SvANY(sv), 1, XPVIO);
1517 SvMAGIC(sv) = magic;
1518 SvSTASH(sv) = stash;
1519 IoPAGE_LEN(sv) = 60;
1522 SvFLAGS(sv) &= ~SVTYPEMASK;
1528 =for apidoc sv_backoff
1530 Remove any string offset. You should normally use the C<SvOOK_off> macro
1537 Perl_sv_backoff(pTHX_ register SV *sv)
1541 char *s = SvPVX(sv);
1542 SvLEN(sv) += SvIVX(sv);
1543 SvPVX(sv) -= SvIVX(sv);
1545 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1547 SvFLAGS(sv) &= ~SVf_OOK;
1554 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1555 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1556 Use the C<SvGROW> wrapper instead.
1562 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1566 #ifdef HAS_64K_LIMIT
1567 if (newlen >= 0x10000) {
1568 PerlIO_printf(Perl_debug_log,
1569 "Allocation too large: %"UVxf"\n", (UV)newlen);
1572 #endif /* HAS_64K_LIMIT */
1575 if (SvTYPE(sv) < SVt_PV) {
1576 sv_upgrade(sv, SVt_PV);
1579 else if (SvOOK(sv)) { /* pv is offset? */
1582 if (newlen > SvLEN(sv))
1583 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1584 #ifdef HAS_64K_LIMIT
1585 if (newlen >= 0x10000)
1592 if (newlen > SvLEN(sv)) { /* need more room? */
1593 if (SvLEN(sv) && s) {
1595 STRLEN l = malloced_size((void*)SvPVX(sv));
1601 Renew(s,newlen,char);
1604 New(703, s, newlen, char);
1605 if (SvPVX(sv) && SvCUR(sv)) {
1606 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1610 SvLEN_set(sv, newlen);
1616 =for apidoc sv_setiv
1618 Copies an integer into the given SV, upgrading first if necessary.
1619 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1625 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1627 SV_CHECK_THINKFIRST_COW_DROP(sv);
1628 switch (SvTYPE(sv)) {
1630 sv_upgrade(sv, SVt_IV);
1633 sv_upgrade(sv, SVt_PVNV);
1637 sv_upgrade(sv, SVt_PVIV);
1646 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1649 (void)SvIOK_only(sv); /* validate number */
1655 =for apidoc sv_setiv_mg
1657 Like C<sv_setiv>, but also handles 'set' magic.
1663 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1670 =for apidoc sv_setuv
1672 Copies an unsigned integer into the given SV, upgrading first if necessary.
1673 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1679 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1681 /* With these two if statements:
1682 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1685 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1687 If you wish to remove them, please benchmark to see what the effect is
1689 if (u <= (UV)IV_MAX) {
1690 sv_setiv(sv, (IV)u);
1699 =for apidoc sv_setuv_mg
1701 Like C<sv_setuv>, but also handles 'set' magic.
1707 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1709 /* With these two if statements:
1710 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1713 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1715 If you wish to remove them, please benchmark to see what the effect is
1717 if (u <= (UV)IV_MAX) {
1718 sv_setiv(sv, (IV)u);
1728 =for apidoc sv_setnv
1730 Copies a double into the given SV, upgrading first if necessary.
1731 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1737 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1739 SV_CHECK_THINKFIRST_COW_DROP(sv);
1740 switch (SvTYPE(sv)) {
1743 sv_upgrade(sv, SVt_NV);
1748 sv_upgrade(sv, SVt_PVNV);
1757 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1761 (void)SvNOK_only(sv); /* validate number */
1766 =for apidoc sv_setnv_mg
1768 Like C<sv_setnv>, but also handles 'set' magic.
1774 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1780 /* Print an "isn't numeric" warning, using a cleaned-up,
1781 * printable version of the offending string
1785 S_not_a_number(pTHX_ SV *sv)
1792 dsv = sv_2mortal(newSVpv("", 0));
1793 pv = sv_uni_display(dsv, sv, 10, 0);
1796 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1797 /* each *s can expand to 4 chars + "...\0",
1798 i.e. need room for 8 chars */
1801 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
1803 if (ch & 128 && !isPRINT_LC(ch)) {
1812 else if (ch == '\r') {
1816 else if (ch == '\f') {
1820 else if (ch == '\\') {
1824 else if (ch == '\0') {
1828 else if (isPRINT_LC(ch))
1845 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1846 "Argument \"%s\" isn't numeric in %s", pv,
1849 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1850 "Argument \"%s\" isn't numeric", pv);
1854 =for apidoc looks_like_number
1856 Test if the content of an SV looks like a number (or is a number).
1857 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1858 non-numeric warning), even if your atof() doesn't grok them.
1864 Perl_looks_like_number(pTHX_ SV *sv)
1866 register char *sbegin;
1873 else if (SvPOKp(sv))
1874 sbegin = SvPV(sv, len);
1876 return 1; /* Historic. Wrong? */
1877 return grok_number(sbegin, len, NULL);
1880 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1881 until proven guilty, assume that things are not that bad... */
1886 As 64 bit platforms often have an NV that doesn't preserve all bits of
1887 an IV (an assumption perl has been based on to date) it becomes necessary
1888 to remove the assumption that the NV always carries enough precision to
1889 recreate the IV whenever needed, and that the NV is the canonical form.
1890 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1891 precision as a side effect of conversion (which would lead to insanity
1892 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1893 1) to distinguish between IV/UV/NV slots that have cached a valid
1894 conversion where precision was lost and IV/UV/NV slots that have a
1895 valid conversion which has lost no precision
1896 2) to ensure that if a numeric conversion to one form is requested that
1897 would lose precision, the precise conversion (or differently
1898 imprecise conversion) is also performed and cached, to prevent
1899 requests for different numeric formats on the same SV causing
1900 lossy conversion chains. (lossless conversion chains are perfectly
1905 SvIOKp is true if the IV slot contains a valid value
1906 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1907 SvNOKp is true if the NV slot contains a valid value
1908 SvNOK is true only if the NV value is accurate
1911 while converting from PV to NV, check to see if converting that NV to an
1912 IV(or UV) would lose accuracy over a direct conversion from PV to
1913 IV(or UV). If it would, cache both conversions, return NV, but mark
1914 SV as IOK NOKp (ie not NOK).
1916 While converting from PV to IV, check to see if converting that IV to an
1917 NV would lose accuracy over a direct conversion from PV to NV. If it
1918 would, cache both conversions, flag similarly.
1920 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1921 correctly because if IV & NV were set NV *always* overruled.
1922 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1923 changes - now IV and NV together means that the two are interchangeable:
1924 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1926 The benefit of this is that operations such as pp_add know that if
1927 SvIOK is true for both left and right operands, then integer addition
1928 can be used instead of floating point (for cases where the result won't
1929 overflow). Before, floating point was always used, which could lead to
1930 loss of precision compared with integer addition.
1932 * making IV and NV equal status should make maths accurate on 64 bit
1934 * may speed up maths somewhat if pp_add and friends start to use
1935 integers when possible instead of fp. (Hopefully the overhead in
1936 looking for SvIOK and checking for overflow will not outweigh the
1937 fp to integer speedup)
1938 * will slow down integer operations (callers of SvIV) on "inaccurate"
1939 values, as the change from SvIOK to SvIOKp will cause a call into
1940 sv_2iv each time rather than a macro access direct to the IV slot
1941 * should speed up number->string conversion on integers as IV is
1942 favoured when IV and NV are equally accurate
1944 ####################################################################
1945 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1946 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1947 On the other hand, SvUOK is true iff UV.
1948 ####################################################################
1950 Your mileage will vary depending your CPU's relative fp to integer
1954 #ifndef NV_PRESERVES_UV
1955 # define IS_NUMBER_UNDERFLOW_IV 1
1956 # define IS_NUMBER_UNDERFLOW_UV 2
1957 # define IS_NUMBER_IV_AND_UV 2
1958 # define IS_NUMBER_OVERFLOW_IV 4
1959 # define IS_NUMBER_OVERFLOW_UV 5
1961 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1963 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1965 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1967 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));
1968 if (SvNVX(sv) < (NV)IV_MIN) {
1969 (void)SvIOKp_on(sv);
1972 return IS_NUMBER_UNDERFLOW_IV;
1974 if (SvNVX(sv) > (NV)UV_MAX) {
1975 (void)SvIOKp_on(sv);
1979 return IS_NUMBER_OVERFLOW_UV;
1981 (void)SvIOKp_on(sv);
1983 /* Can't use strtol etc to convert this string. (See truth table in
1985 if (SvNVX(sv) <= (UV)IV_MAX) {
1986 SvIVX(sv) = I_V(SvNVX(sv));
1987 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1988 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1990 /* Integer is imprecise. NOK, IOKp */
1992 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1995 SvUVX(sv) = U_V(SvNVX(sv));
1996 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1997 if (SvUVX(sv) == UV_MAX) {
1998 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1999 possibly be preserved by NV. Hence, it must be overflow.
2001 return IS_NUMBER_OVERFLOW_UV;
2003 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2005 /* Integer is imprecise. NOK, IOKp */
2007 return IS_NUMBER_OVERFLOW_IV;
2009 #endif /* !NV_PRESERVES_UV*/
2014 Return the integer value of an SV, doing any necessary string conversion,
2015 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2021 Perl_sv_2iv(pTHX_ register SV *sv)
2025 if (SvGMAGICAL(sv)) {
2030 return I_V(SvNVX(sv));
2032 if (SvPOKp(sv) && SvLEN(sv))
2035 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2036 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2042 if (SvTHINKFIRST(sv)) {
2045 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2046 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2047 return SvIV(tmpstr);
2048 return PTR2IV(SvRV(sv));
2051 sv_force_normal_flags(sv, 0);
2053 if (SvREADONLY(sv) && !SvOK(sv)) {
2054 if (ckWARN(WARN_UNINITIALIZED))
2061 return (IV)(SvUVX(sv));
2068 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2069 * without also getting a cached IV/UV from it at the same time
2070 * (ie PV->NV conversion should detect loss of accuracy and cache
2071 * IV or UV at same time to avoid this. NWC */
2073 if (SvTYPE(sv) == SVt_NV)
2074 sv_upgrade(sv, SVt_PVNV);
2076 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2077 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2078 certainly cast into the IV range at IV_MAX, whereas the correct
2079 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2081 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2082 SvIVX(sv) = I_V(SvNVX(sv));
2083 if (SvNVX(sv) == (NV) SvIVX(sv)
2084 #ifndef NV_PRESERVES_UV
2085 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2086 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2087 /* Don't flag it as "accurately an integer" if the number
2088 came from a (by definition imprecise) NV operation, and
2089 we're outside the range of NV integer precision */
2092 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2093 DEBUG_c(PerlIO_printf(Perl_debug_log,
2094 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2100 /* IV not precise. No need to convert from PV, as NV
2101 conversion would already have cached IV if it detected
2102 that PV->IV would be better than PV->NV->IV
2103 flags already correct - don't set public IOK. */
2104 DEBUG_c(PerlIO_printf(Perl_debug_log,
2105 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2110 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2111 but the cast (NV)IV_MIN rounds to a the value less (more
2112 negative) than IV_MIN which happens to be equal to SvNVX ??
2113 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2114 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2115 (NV)UVX == NVX are both true, but the values differ. :-(
2116 Hopefully for 2s complement IV_MIN is something like
2117 0x8000000000000000 which will be exact. NWC */
2120 SvUVX(sv) = U_V(SvNVX(sv));
2122 (SvNVX(sv) == (NV) SvUVX(sv))
2123 #ifndef NV_PRESERVES_UV
2124 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2125 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2126 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2127 /* Don't flag it as "accurately an integer" if the number
2128 came from a (by definition imprecise) NV operation, and
2129 we're outside the range of NV integer precision */
2135 DEBUG_c(PerlIO_printf(Perl_debug_log,
2136 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2140 return (IV)SvUVX(sv);
2143 else if (SvPOKp(sv) && SvLEN(sv)) {
2145 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2146 /* We want to avoid a possible problem when we cache an IV which
2147 may be later translated to an NV, and the resulting NV is not
2148 the same as the direct translation of the initial string
2149 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2150 be careful to ensure that the value with the .456 is around if the
2151 NV value is requested in the future).
2153 This means that if we cache such an IV, we need to cache the
2154 NV as well. Moreover, we trade speed for space, and do not
2155 cache the NV if we are sure it's not needed.
2158 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2159 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2160 == IS_NUMBER_IN_UV) {
2161 /* It's definitely an integer, only upgrade to PVIV */
2162 if (SvTYPE(sv) < SVt_PVIV)
2163 sv_upgrade(sv, SVt_PVIV);
2165 } else if (SvTYPE(sv) < SVt_PVNV)
2166 sv_upgrade(sv, SVt_PVNV);
2168 /* If NV preserves UV then we only use the UV value if we know that
2169 we aren't going to call atof() below. If NVs don't preserve UVs
2170 then the value returned may have more precision than atof() will
2171 return, even though value isn't perfectly accurate. */
2172 if ((numtype & (IS_NUMBER_IN_UV
2173 #ifdef NV_PRESERVES_UV
2176 )) == IS_NUMBER_IN_UV) {
2177 /* This won't turn off the public IOK flag if it was set above */
2178 (void)SvIOKp_on(sv);
2180 if (!(numtype & IS_NUMBER_NEG)) {
2182 if (value <= (UV)IV_MAX) {
2183 SvIVX(sv) = (IV)value;
2189 /* 2s complement assumption */
2190 if (value <= (UV)IV_MIN) {
2191 SvIVX(sv) = -(IV)value;
2193 /* Too negative for an IV. This is a double upgrade, but
2194 I'm assuming it will be rare. */
2195 if (SvTYPE(sv) < SVt_PVNV)
2196 sv_upgrade(sv, SVt_PVNV);
2200 SvNVX(sv) = -(NV)value;
2205 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2206 will be in the previous block to set the IV slot, and the next
2207 block to set the NV slot. So no else here. */
2209 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2210 != IS_NUMBER_IN_UV) {
2211 /* It wasn't an (integer that doesn't overflow the UV). */
2212 SvNVX(sv) = Atof(SvPVX(sv));
2214 if (! numtype && ckWARN(WARN_NUMERIC))
2217 #if defined(USE_LONG_DOUBLE)
2218 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2219 PTR2UV(sv), SvNVX(sv)));
2221 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2222 PTR2UV(sv), SvNVX(sv)));
2226 #ifdef NV_PRESERVES_UV
2227 (void)SvIOKp_on(sv);
2229 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2230 SvIVX(sv) = I_V(SvNVX(sv));
2231 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2234 /* Integer is imprecise. NOK, IOKp */
2236 /* UV will not work better than IV */
2238 if (SvNVX(sv) > (NV)UV_MAX) {
2240 /* Integer is inaccurate. NOK, IOKp, is UV */
2244 SvUVX(sv) = U_V(SvNVX(sv));
2245 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2246 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2250 /* Integer is imprecise. NOK, IOKp, is UV */
2256 #else /* NV_PRESERVES_UV */
2257 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2258 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2259 /* The IV slot will have been set from value returned by
2260 grok_number above. The NV slot has just been set using
2263 assert (SvIOKp(sv));
2265 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2266 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2267 /* Small enough to preserve all bits. */
2268 (void)SvIOKp_on(sv);
2270 SvIVX(sv) = I_V(SvNVX(sv));
2271 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2273 /* Assumption: first non-preserved integer is < IV_MAX,
2274 this NV is in the preserved range, therefore: */
2275 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2277 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);
2281 0 0 already failed to read UV.
2282 0 1 already failed to read UV.
2283 1 0 you won't get here in this case. IV/UV
2284 slot set, public IOK, Atof() unneeded.
2285 1 1 already read UV.
2286 so there's no point in sv_2iuv_non_preserve() attempting
2287 to use atol, strtol, strtoul etc. */
2288 if (sv_2iuv_non_preserve (sv, numtype)
2289 >= IS_NUMBER_OVERFLOW_IV)
2293 #endif /* NV_PRESERVES_UV */
2296 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2298 if (SvTYPE(sv) < SVt_IV)
2299 /* Typically the caller expects that sv_any is not NULL now. */
2300 sv_upgrade(sv, SVt_IV);
2303 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2304 PTR2UV(sv),SvIVX(sv)));
2305 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2311 Return the unsigned integer value of an SV, doing any necessary string
2312 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
2319 Perl_sv_2uv(pTHX_ register SV *sv)
2323 if (SvGMAGICAL(sv)) {
2328 return U_V(SvNVX(sv));
2329 if (SvPOKp(sv) && SvLEN(sv))
2332 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2333 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2339 if (SvTHINKFIRST(sv)) {
2342 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2343 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2344 return SvUV(tmpstr);
2345 return PTR2UV(SvRV(sv));
2348 sv_force_normal_flags(sv, 0);
2350 if (SvREADONLY(sv) && !SvOK(sv)) {
2351 if (ckWARN(WARN_UNINITIALIZED))
2361 return (UV)SvIVX(sv);
2365 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2366 * without also getting a cached IV/UV from it at the same time
2367 * (ie PV->NV conversion should detect loss of accuracy and cache
2368 * IV or UV at same time to avoid this. */
2369 /* IV-over-UV optimisation - choose to cache IV if possible */
2371 if (SvTYPE(sv) == SVt_NV)
2372 sv_upgrade(sv, SVt_PVNV);
2374 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2375 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2376 SvIVX(sv) = I_V(SvNVX(sv));
2377 if (SvNVX(sv) == (NV) SvIVX(sv)
2378 #ifndef NV_PRESERVES_UV
2379 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2380 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2381 /* Don't flag it as "accurately an integer" if the number
2382 came from a (by definition imprecise) NV operation, and
2383 we're outside the range of NV integer precision */
2386 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2387 DEBUG_c(PerlIO_printf(Perl_debug_log,
2388 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2394 /* IV not precise. No need to convert from PV, as NV
2395 conversion would already have cached IV if it detected
2396 that PV->IV would be better than PV->NV->IV
2397 flags already correct - don't set public IOK. */
2398 DEBUG_c(PerlIO_printf(Perl_debug_log,
2399 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2404 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2405 but the cast (NV)IV_MIN rounds to a the value less (more
2406 negative) than IV_MIN which happens to be equal to SvNVX ??
2407 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2408 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2409 (NV)UVX == NVX are both true, but the values differ. :-(
2410 Hopefully for 2s complement IV_MIN is something like
2411 0x8000000000000000 which will be exact. NWC */
2414 SvUVX(sv) = U_V(SvNVX(sv));
2416 (SvNVX(sv) == (NV) SvUVX(sv))
2417 #ifndef NV_PRESERVES_UV
2418 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2419 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2420 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2421 /* Don't flag it as "accurately an integer" if the number
2422 came from a (by definition imprecise) NV operation, and
2423 we're outside the range of NV integer precision */
2428 DEBUG_c(PerlIO_printf(Perl_debug_log,
2429 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2435 else if (SvPOKp(sv) && SvLEN(sv)) {
2437 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2439 /* We want to avoid a possible problem when we cache a UV which
2440 may be later translated to an NV, and the resulting NV is not
2441 the translation of the initial data.
2443 This means that if we cache such a UV, we need to cache the
2444 NV as well. Moreover, we trade speed for space, and do not
2445 cache the NV if not needed.
2448 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2449 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2450 == IS_NUMBER_IN_UV) {
2451 /* It's definitely an integer, only upgrade to PVIV */
2452 if (SvTYPE(sv) < SVt_PVIV)
2453 sv_upgrade(sv, SVt_PVIV);
2455 } else if (SvTYPE(sv) < SVt_PVNV)
2456 sv_upgrade(sv, SVt_PVNV);
2458 /* If NV preserves UV then we only use the UV value if we know that
2459 we aren't going to call atof() below. If NVs don't preserve UVs
2460 then the value returned may have more precision than atof() will
2461 return, even though it isn't accurate. */
2462 if ((numtype & (IS_NUMBER_IN_UV
2463 #ifdef NV_PRESERVES_UV
2466 )) == IS_NUMBER_IN_UV) {
2467 /* This won't turn off the public IOK flag if it was set above */
2468 (void)SvIOKp_on(sv);
2470 if (!(numtype & IS_NUMBER_NEG)) {
2472 if (value <= (UV)IV_MAX) {
2473 SvIVX(sv) = (IV)value;
2475 /* it didn't overflow, and it was positive. */
2480 /* 2s complement assumption */
2481 if (value <= (UV)IV_MIN) {
2482 SvIVX(sv) = -(IV)value;
2484 /* Too negative for an IV. This is a double upgrade, but
2485 I'm assuming it will be rare. */
2486 if (SvTYPE(sv) < SVt_PVNV)
2487 sv_upgrade(sv, SVt_PVNV);
2491 SvNVX(sv) = -(NV)value;
2497 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2498 != IS_NUMBER_IN_UV) {
2499 /* It wasn't an integer, or it overflowed the UV. */
2500 SvNVX(sv) = Atof(SvPVX(sv));
2502 if (! numtype && ckWARN(WARN_NUMERIC))
2505 #if defined(USE_LONG_DOUBLE)
2506 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2507 PTR2UV(sv), SvNVX(sv)));
2509 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2510 PTR2UV(sv), SvNVX(sv)));
2513 #ifdef NV_PRESERVES_UV
2514 (void)SvIOKp_on(sv);
2516 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2517 SvIVX(sv) = I_V(SvNVX(sv));
2518 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2521 /* Integer is imprecise. NOK, IOKp */
2523 /* UV will not work better than IV */
2525 if (SvNVX(sv) > (NV)UV_MAX) {
2527 /* Integer is inaccurate. NOK, IOKp, is UV */
2531 SvUVX(sv) = U_V(SvNVX(sv));
2532 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2533 NV preservse UV so can do correct comparison. */
2534 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2538 /* Integer is imprecise. NOK, IOKp, is UV */
2543 #else /* NV_PRESERVES_UV */
2544 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2545 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2546 /* The UV slot will have been set from value returned by
2547 grok_number above. The NV slot has just been set using
2550 assert (SvIOKp(sv));
2552 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2553 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2554 /* Small enough to preserve all bits. */
2555 (void)SvIOKp_on(sv);
2557 SvIVX(sv) = I_V(SvNVX(sv));
2558 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2560 /* Assumption: first non-preserved integer is < IV_MAX,
2561 this NV is in the preserved range, therefore: */
2562 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2564 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);
2567 sv_2iuv_non_preserve (sv, numtype);
2569 #endif /* NV_PRESERVES_UV */
2573 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2574 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2577 if (SvTYPE(sv) < SVt_IV)
2578 /* Typically the caller expects that sv_any is not NULL now. */
2579 sv_upgrade(sv, SVt_IV);
2583 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2584 PTR2UV(sv),SvUVX(sv)));
2585 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2591 Return the num value of an SV, doing any necessary string or integer
2592 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2599 Perl_sv_2nv(pTHX_ register SV *sv)
2603 if (SvGMAGICAL(sv)) {
2607 if (SvPOKp(sv) && SvLEN(sv)) {
2608 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2609 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
2611 return Atof(SvPVX(sv));
2615 return (NV)SvUVX(sv);
2617 return (NV)SvIVX(sv);
2620 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2621 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2627 if (SvTHINKFIRST(sv)) {
2630 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2631 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2632 return SvNV(tmpstr);
2633 return PTR2NV(SvRV(sv));
2636 sv_force_normal_flags(sv, 0);
2638 if (SvREADONLY(sv) && !SvOK(sv)) {
2639 if (ckWARN(WARN_UNINITIALIZED))
2644 if (SvTYPE(sv) < SVt_NV) {
2645 if (SvTYPE(sv) == SVt_IV)
2646 sv_upgrade(sv, SVt_PVNV);
2648 sv_upgrade(sv, SVt_NV);
2649 #ifdef USE_LONG_DOUBLE
2651 STORE_NUMERIC_LOCAL_SET_STANDARD();
2652 PerlIO_printf(Perl_debug_log,
2653 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2654 PTR2UV(sv), SvNVX(sv));
2655 RESTORE_NUMERIC_LOCAL();
2659 STORE_NUMERIC_LOCAL_SET_STANDARD();
2660 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2661 PTR2UV(sv), SvNVX(sv));
2662 RESTORE_NUMERIC_LOCAL();
2666 else if (SvTYPE(sv) < SVt_PVNV)
2667 sv_upgrade(sv, SVt_PVNV);
2672 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
2673 #ifdef NV_PRESERVES_UV
2676 /* Only set the public NV OK flag if this NV preserves the IV */
2677 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2678 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2679 : (SvIVX(sv) == I_V(SvNVX(sv))))
2685 else if (SvPOKp(sv) && SvLEN(sv)) {
2687 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2688 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
2690 #ifdef NV_PRESERVES_UV
2691 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2692 == IS_NUMBER_IN_UV) {
2693 /* It's definitely an integer */
2694 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
2696 SvNVX(sv) = Atof(SvPVX(sv));
2699 SvNVX(sv) = Atof(SvPVX(sv));
2700 /* Only set the public NV OK flag if this NV preserves the value in
2701 the PV at least as well as an IV/UV would.
2702 Not sure how to do this 100% reliably. */
2703 /* if that shift count is out of range then Configure's test is
2704 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2706 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2707 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2708 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2709 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2710 /* Can't use strtol etc to convert this string, so don't try.
2711 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2714 /* value has been set. It may not be precise. */
2715 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2716 /* 2s complement assumption for (UV)IV_MIN */
2717 SvNOK_on(sv); /* Integer is too negative. */
2722 if (numtype & IS_NUMBER_NEG) {
2723 SvIVX(sv) = -(IV)value;
2724 } else if (value <= (UV)IV_MAX) {
2725 SvIVX(sv) = (IV)value;
2731 if (numtype & IS_NUMBER_NOT_INT) {
2732 /* I believe that even if the original PV had decimals,
2733 they are lost beyond the limit of the FP precision.
2734 However, neither is canonical, so both only get p
2735 flags. NWC, 2000/11/25 */
2736 /* Both already have p flags, so do nothing */
2739 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2740 if (SvIVX(sv) == I_V(nv)) {
2745 /* It had no "." so it must be integer. */
2748 /* between IV_MAX and NV(UV_MAX).
2749 Could be slightly > UV_MAX */
2751 if (numtype & IS_NUMBER_NOT_INT) {
2752 /* UV and NV both imprecise. */
2754 UV nv_as_uv = U_V(nv);
2756 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2767 #endif /* NV_PRESERVES_UV */
2770 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2772 if (SvTYPE(sv) < SVt_NV)
2773 /* Typically the caller expects that sv_any is not NULL now. */
2774 /* XXX Ilya implies that this is a bug in callers that assume this
2775 and ideally should be fixed. */
2776 sv_upgrade(sv, SVt_NV);
2779 #if defined(USE_LONG_DOUBLE)
2781 STORE_NUMERIC_LOCAL_SET_STANDARD();
2782 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2783 PTR2UV(sv), SvNVX(sv));
2784 RESTORE_NUMERIC_LOCAL();
2788 STORE_NUMERIC_LOCAL_SET_STANDARD();
2789 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2790 PTR2UV(sv), SvNVX(sv));
2791 RESTORE_NUMERIC_LOCAL();
2797 /* asIV(): extract an integer from the string value of an SV.
2798 * Caller must validate PVX */
2801 S_asIV(pTHX_ SV *sv)
2804 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2806 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2807 == IS_NUMBER_IN_UV) {
2808 /* It's definitely an integer */
2809 if (numtype & IS_NUMBER_NEG) {
2810 if (value < (UV)IV_MIN)
2813 if (value < (UV)IV_MAX)
2818 if (ckWARN(WARN_NUMERIC))
2821 return I_V(Atof(SvPVX(sv)));
2824 /* asUV(): extract an unsigned integer from the string value of an SV
2825 * Caller must validate PVX */
2828 S_asUV(pTHX_ SV *sv)
2831 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2833 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2834 == IS_NUMBER_IN_UV) {
2835 /* It's definitely an integer */
2836 if (!(numtype & IS_NUMBER_NEG))
2840 if (ckWARN(WARN_NUMERIC))
2843 return U_V(Atof(SvPVX(sv)));
2847 =for apidoc sv_2pv_nolen
2849 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2850 use the macro wrapper C<SvPV_nolen(sv)> instead.
2855 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2858 return sv_2pv(sv, &n_a);
2861 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2862 * UV as a string towards the end of buf, and return pointers to start and
2865 * We assume that buf is at least TYPE_CHARS(UV) long.
2869 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2871 char *ptr = buf + TYPE_CHARS(UV);
2885 *--ptr = '0' + (char)(uv % 10);
2893 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
2894 * this function provided for binary compatibility only
2898 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2900 return sv_2pv_flags(sv, lp, SV_GMAGIC);
2904 =for apidoc sv_2pv_flags
2906 Returns a pointer to the string value of an SV, and sets *lp to its length.
2907 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2909 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2910 usually end up here too.
2916 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2921 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2922 char *tmpbuf = tbuf;
2928 if (SvGMAGICAL(sv)) {
2929 if (flags & SV_GMAGIC)
2937 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2939 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2944 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2949 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2950 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2957 if (SvTHINKFIRST(sv)) {
2960 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2961 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2962 char *pv = SvPV(tmpstr, *lp);
2976 switch (SvTYPE(sv)) {
2978 if ( ((SvFLAGS(sv) &
2979 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2980 == (SVs_OBJECT|SVs_SMG))
2981 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2982 regexp *re = (regexp *)mg->mg_obj;
2985 char *fptr = "msix";
2990 char need_newline = 0;
2991 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2993 while((ch = *fptr++)) {
2995 reflags[left++] = ch;
2998 reflags[right--] = ch;
3003 reflags[left] = '-';
3007 mg->mg_len = re->prelen + 4 + left;
3009 * If /x was used, we have to worry about a regex
3010 * ending with a comment later being embedded
3011 * within another regex. If so, we don't want this
3012 * regex's "commentization" to leak out to the
3013 * right part of the enclosing regex, we must cap
3014 * it with a newline.
3016 * So, if /x was used, we scan backwards from the
3017 * end of the regex. If we find a '#' before we
3018 * find a newline, we need to add a newline
3019 * ourself. If we find a '\n' first (or if we
3020 * don't find '#' or '\n'), we don't need to add
3021 * anything. -jfriedl
3023 if (PMf_EXTENDED & re->reganch)
3025 char *endptr = re->precomp + re->prelen;
3026 while (endptr >= re->precomp)
3028 char c = *(endptr--);
3030 break; /* don't need another */
3032 /* we end while in a comment, so we
3034 mg->mg_len++; /* save space for it */
3035 need_newline = 1; /* note to add it */
3041 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3042 Copy("(?", mg->mg_ptr, 2, char);
3043 Copy(reflags, mg->mg_ptr+2, left, char);
3044 Copy(":", mg->mg_ptr+left+2, 1, char);
3045 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3047 mg->mg_ptr[mg->mg_len - 2] = '\n';
3048 mg->mg_ptr[mg->mg_len - 1] = ')';
3049 mg->mg_ptr[mg->mg_len] = 0;
3051 PL_reginterp_cnt += re->program[0].next_off;
3053 if (re->reganch & ROPT_UTF8)
3068 case SVt_PVBM: if (SvROK(sv))
3071 s = "SCALAR"; break;
3072 case SVt_PVLV: s = SvROK(sv) ? "REF":"LVALUE"; break;
3073 case SVt_PVAV: s = "ARRAY"; break;
3074 case SVt_PVHV: s = "HASH"; break;
3075 case SVt_PVCV: s = "CODE"; break;
3076 case SVt_PVGV: s = "GLOB"; break;
3077 case SVt_PVFM: s = "FORMAT"; break;
3078 case SVt_PVIO: s = "IO"; break;
3079 default: s = "UNKNOWN"; break;
3083 Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
3086 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3092 if (SvREADONLY(sv) && !SvOK(sv)) {
3093 if (ckWARN(WARN_UNINITIALIZED))
3099 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3100 /* I'm assuming that if both IV and NV are equally valid then
3101 converting the IV is going to be more efficient */
3102 U32 isIOK = SvIOK(sv);
3103 U32 isUIOK = SvIsUV(sv);
3104 char buf[TYPE_CHARS(UV)];
3107 if (SvTYPE(sv) < SVt_PVIV)
3108 sv_upgrade(sv, SVt_PVIV);
3110 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3112 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3113 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3114 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3115 SvCUR_set(sv, ebuf - ptr);
3125 else if (SvNOKp(sv)) {
3126 if (SvTYPE(sv) < SVt_PVNV)
3127 sv_upgrade(sv, SVt_PVNV);
3128 /* The +20 is pure guesswork. Configure test needed. --jhi */
3129 SvGROW(sv, NV_DIG + 20);
3131 olderrno = errno; /* some Xenix systems wipe out errno here */
3133 if (SvNVX(sv) == 0.0)
3134 (void)strcpy(s,"0");
3138 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3141 #ifdef FIXNEGATIVEZERO
3142 if (*s == '-' && s[1] == '0' && !s[2])
3152 if (ckWARN(WARN_UNINITIALIZED)
3153 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3156 if (SvTYPE(sv) < SVt_PV)
3157 /* Typically the caller expects that sv_any is not NULL now. */
3158 sv_upgrade(sv, SVt_PV);
3161 *lp = s - SvPVX(sv);
3164 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3165 PTR2UV(sv),SvPVX(sv)));
3169 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3170 /* Sneaky stuff here */
3174 tsv = newSVpv(tmpbuf, 0);
3190 len = strlen(tmpbuf);
3192 #ifdef FIXNEGATIVEZERO
3193 if (len == 2 && t[0] == '-' && t[1] == '0') {
3198 (void)SvUPGRADE(sv, SVt_PV);
3200 s = SvGROW(sv, len + 1);
3209 =for apidoc sv_copypv
3211 Copies a stringified representation of the source SV into the
3212 destination SV. Automatically performs any necessary mg_get and
3213 coercion of numeric values into strings. Guaranteed to preserve
3214 UTF-8 flag even from overloaded objects. Similar in nature to
3215 sv_2pv[_flags] but operates directly on an SV instead of just the
3216 string. Mostly uses sv_2pv_flags to do its work, except when that
3217 would lose the UTF-8'ness of the PV.
3223 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3228 sv_setpvn(dsv,s,len);
3236 =for apidoc sv_2pvbyte_nolen
3238 Return a pointer to the byte-encoded representation of the SV.
3239 May cause the SV to be downgraded from UTF8 as a side-effect.
3241 Usually accessed via the C<SvPVbyte_nolen> macro.
3247 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3250 return sv_2pvbyte(sv, &n_a);
3254 =for apidoc sv_2pvbyte
3256 Return a pointer to the byte-encoded representation of the SV, and set *lp
3257 to its length. May cause the SV to be downgraded from UTF8 as a
3260 Usually accessed via the C<SvPVbyte> macro.
3266 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3268 sv_utf8_downgrade(sv,0);
3269 return SvPV(sv,*lp);
3273 =for apidoc sv_2pvutf8_nolen
3275 Return a pointer to the UTF8-encoded representation of the SV.
3276 May cause the SV to be upgraded to UTF8 as a side-effect.
3278 Usually accessed via the C<SvPVutf8_nolen> macro.
3284 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3287 return sv_2pvutf8(sv, &n_a);
3291 =for apidoc sv_2pvutf8
3293 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3294 to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3296 Usually accessed via the C<SvPVutf8> macro.
3302 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3304 sv_utf8_upgrade(sv);
3305 return SvPV(sv,*lp);
3309 =for apidoc sv_2bool
3311 This function is only called on magical items, and is only used by
3312 sv_true() or its macro equivalent.
3318 Perl_sv_2bool(pTHX_ register SV *sv)
3327 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3328 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3329 return (bool)SvTRUE(tmpsv);
3330 return SvRV(sv) != 0;
3333 register XPV* Xpvtmp;
3334 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3335 (*Xpvtmp->xpv_pv > '0' ||
3336 Xpvtmp->xpv_cur > 1 ||
3337 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3344 return SvIVX(sv) != 0;
3347 return SvNVX(sv) != 0.0;
3354 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3355 * this function provided for binary compatibility only
3360 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3362 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3366 =for apidoc sv_utf8_upgrade
3368 Convert the PV of an SV to its UTF8-encoded form.
3369 Forces the SV to string form if it is not already.
3370 Always sets the SvUTF8 flag to avoid future validity checks even
3371 if all the bytes have hibit clear.
3373 This is not as a general purpose byte encoding to Unicode interface:
3374 use the Encode extension for that.
3376 =for apidoc sv_utf8_upgrade_flags
3378 Convert the PV of an SV to its UTF8-encoded form.
3379 Forces the SV to string form if it is not already.
3380 Always sets the SvUTF8 flag to avoid future validity checks even
3381 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3382 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3383 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3385 This is not as a general purpose byte encoding to Unicode interface:
3386 use the Encode extension for that.
3392 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3402 (void) sv_2pv_flags(sv,&len, flags);
3411 sv_force_normal_flags(sv, 0);
3414 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3415 sv_recode_to_utf8(sv, PL_encoding);
3416 else { /* Assume Latin-1/EBCDIC */
3417 /* This function could be much more efficient if we
3418 * had a FLAG in SVs to signal if there are any hibit
3419 * chars in the PV. Given that there isn't such a flag
3420 * make the loop as fast as possible. */
3421 s = (U8 *) SvPVX(sv);
3422 e = (U8 *) SvEND(sv);
3426 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3432 len = SvCUR(sv) + 1; /* Plus the \0 */
3433 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3434 SvCUR(sv) = len - 1;
3436 Safefree(s); /* No longer using what was there before. */
3437 SvLEN(sv) = len; /* No longer know the real size. */
3439 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3446 =for apidoc sv_utf8_downgrade
3448 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3449 This may not be possible if the PV contains non-byte encoding characters;
3450 if this is the case, either returns false or, if C<fail_ok> is not
3453 This is not as a general purpose Unicode to byte encoding interface:
3454 use the Encode extension for that.
3460 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3462 if (SvPOK(sv) && SvUTF8(sv)) {
3468 sv_force_normal_flags(sv, 0);
3470 s = (U8 *) SvPV(sv, len);
3471 if (!utf8_to_bytes(s, &len)) {
3476 Perl_croak(aTHX_ "Wide character in %s",
3479 Perl_croak(aTHX_ "Wide character");
3490 =for apidoc sv_utf8_encode
3492 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3493 flag so that it looks like octets again. Used as a building block
3494 for encode_utf8 in Encode.xs
3500 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3502 (void) sv_utf8_upgrade(sv);
3507 =for apidoc sv_utf8_decode
3509 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3510 turn off SvUTF8 if needed so that we see characters. Used as a building block
3511 for decode_utf8 in Encode.xs
3517 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3523 /* The octets may have got themselves encoded - get them back as
3526 if (!sv_utf8_downgrade(sv, TRUE))
3529 /* it is actually just a matter of turning the utf8 flag on, but
3530 * we want to make sure everything inside is valid utf8 first.
3532 c = (U8 *) SvPVX(sv);
3533 if (!is_utf8_string(c, SvCUR(sv)+1))
3535 e = (U8 *) SvEND(sv);
3538 if (!UTF8_IS_INVARIANT(ch)) {
3547 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3548 * this function provided for binary compatibility only
3552 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3554 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3558 =for apidoc sv_setsv
3560 Copies the contents of the source SV C<ssv> into the destination SV
3561 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3562 function if the source SV needs to be reused. Does not handle 'set' magic.
3563 Loosely speaking, it performs a copy-by-value, obliterating any previous
3564 content of the destination.
3566 You probably want to use one of the assortment of wrappers, such as
3567 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3568 C<SvSetMagicSV_nosteal>.
3570 =for apidoc sv_setsv_flags
3572 Copies the contents of the source SV C<ssv> into the destination SV
3573 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3574 function if the source SV needs to be reused. Does not handle 'set' magic.
3575 Loosely speaking, it performs a copy-by-value, obliterating any previous
3576 content of the destination.
3577 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3578 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3579 implemented in terms of this function.
3581 You probably want to use one of the assortment of wrappers, such as
3582 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3583 C<SvSetMagicSV_nosteal>.
3585 This is the primary function for copying scalars, and most other
3586 copy-ish functions and macros use this underneath.
3592 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3594 register U32 sflags;
3600 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3602 sstr = &PL_sv_undef;
3603 stype = SvTYPE(sstr);
3604 dtype = SvTYPE(dstr);
3609 /* need to nuke the magic */
3611 SvRMAGICAL_off(dstr);
3614 /* There's a lot of redundancy below but we're going for speed here */
3619 if (dtype != SVt_PVGV) {
3620 (void)SvOK_off(dstr);
3628 sv_upgrade(dstr, SVt_IV);
3631 sv_upgrade(dstr, SVt_PVNV);
3635 sv_upgrade(dstr, SVt_PVIV);
3638 (void)SvIOK_only(dstr);
3639 SvIVX(dstr) = SvIVX(sstr);
3642 if (SvTAINTED(sstr))
3653 sv_upgrade(dstr, SVt_NV);
3658 sv_upgrade(dstr, SVt_PVNV);
3661 SvNVX(dstr) = SvNVX(sstr);
3662 (void)SvNOK_only(dstr);
3663 if (SvTAINTED(sstr))
3671 sv_upgrade(dstr, SVt_RV);
3672 else if (dtype == SVt_PVGV &&
3673 SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3676 if (GvIMPORTED(dstr) != GVf_IMPORTED
3677 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3679 GvIMPORTED_on(dstr);
3688 #ifdef PERL_COPY_ON_WRITE
3689 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3690 if (dtype < SVt_PVIV)
3691 sv_upgrade(dstr, SVt_PVIV);
3698 sv_upgrade(dstr, SVt_PV);
3701 if (dtype < SVt_PVIV)
3702 sv_upgrade(dstr, SVt_PVIV);
3705 if (dtype < SVt_PVNV)
3706 sv_upgrade(dstr, SVt_PVNV);
3713 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
3716 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
3720 if (dtype <= SVt_PVGV) {
3722 if (dtype != SVt_PVGV) {
3723 char *name = GvNAME(sstr);
3724 STRLEN len = GvNAMELEN(sstr);
3725 sv_upgrade(dstr, SVt_PVGV);
3726 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3727 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3728 GvNAME(dstr) = savepvn(name, len);
3729 GvNAMELEN(dstr) = len;
3730 SvFAKE_on(dstr); /* can coerce to non-glob */
3732 /* ahem, death to those who redefine active sort subs */
3733 else if (PL_curstackinfo->si_type == PERLSI_SORT
3734 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3735 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3738 #ifdef GV_UNIQUE_CHECK
3739 if (GvUNIQUE((GV*)dstr)) {
3740 Perl_croak(aTHX_ PL_no_modify);
3744 (void)SvOK_off(dstr);
3745 GvINTRO_off(dstr); /* one-shot flag */
3747 GvGP(dstr) = gp_ref(GvGP(sstr));
3748 if (SvTAINTED(sstr))
3750 if (GvIMPORTED(dstr) != GVf_IMPORTED
3751 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3753 GvIMPORTED_on(dstr);
3761 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3763 if ((int)SvTYPE(sstr) != stype) {
3764 stype = SvTYPE(sstr);
3765 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3769 if (stype == SVt_PVLV)
3770 (void)SvUPGRADE(dstr, SVt_PVNV);
3772 (void)SvUPGRADE(dstr, (U32)stype);
3775 sflags = SvFLAGS(sstr);
3777 if (sflags & SVf_ROK) {
3778 if (dtype >= SVt_PV) {
3779 if (dtype == SVt_PVGV) {
3780 SV *sref = SvREFCNT_inc(SvRV(sstr));
3782 int intro = GvINTRO(dstr);
3784 #ifdef GV_UNIQUE_CHECK
3785 if (GvUNIQUE((GV*)dstr)) {
3786 Perl_croak(aTHX_ PL_no_modify);
3791 GvINTRO_off(dstr); /* one-shot flag */
3792 GvLINE(dstr) = CopLINE(PL_curcop);
3793 GvEGV(dstr) = (GV*)dstr;
3796 switch (SvTYPE(sref)) {
3799 SAVEGENERICSV(GvAV(dstr));
3801 dref = (SV*)GvAV(dstr);
3802 GvAV(dstr) = (AV*)sref;
3803 if (!GvIMPORTED_AV(dstr)
3804 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3806 GvIMPORTED_AV_on(dstr);
3811 SAVEGENERICSV(GvHV(dstr));
3813 dref = (SV*)GvHV(dstr);
3814 GvHV(dstr) = (HV*)sref;
3815 if (!GvIMPORTED_HV(dstr)
3816 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3818 GvIMPORTED_HV_on(dstr);
3823 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3824 SvREFCNT_dec(GvCV(dstr));
3825 GvCV(dstr) = Nullcv;
3826 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3827 PL_sub_generation++;
3829 SAVEGENERICSV(GvCV(dstr));
3832 dref = (SV*)GvCV(dstr);
3833 if (GvCV(dstr) != (CV*)sref) {
3834 CV* cv = GvCV(dstr);
3836 if (!GvCVGEN((GV*)dstr) &&
3837 (CvROOT(cv) || CvXSUB(cv)))
3839 /* ahem, death to those who redefine
3840 * active sort subs */
3841 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3842 PL_sortcop == CvSTART(cv))
3844 "Can't redefine active sort subroutine %s",
3845 GvENAME((GV*)dstr));
3846 /* Redefining a sub - warning is mandatory if
3847 it was a const and its value changed. */
3848 if (ckWARN(WARN_REDEFINE)
3850 && (!CvCONST((CV*)sref)
3851 || sv_cmp(cv_const_sv(cv),
3852 cv_const_sv((CV*)sref)))))
3854 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3856 ? "Constant subroutine %s::%s redefined"
3857 : "Subroutine %s::%s redefined",
3858 HvNAME(GvSTASH((GV*)dstr)),
3859 GvENAME((GV*)dstr));
3863 cv_ckproto(cv, (GV*)dstr,
3864 SvPOK(sref) ? SvPVX(sref) : Nullch);
3866 GvCV(dstr) = (CV*)sref;
3867 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3868 GvASSUMECV_on(dstr);
3869 PL_sub_generation++;
3871 if (!GvIMPORTED_CV(dstr)
3872 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3874 GvIMPORTED_CV_on(dstr);
3879 SAVEGENERICSV(GvIOp(dstr));
3881 dref = (SV*)GvIOp(dstr);
3882 GvIOp(dstr) = (IO*)sref;
3886 SAVEGENERICSV(GvFORM(dstr));
3888 dref = (SV*)GvFORM(dstr);
3889 GvFORM(dstr) = (CV*)sref;
3893 SAVEGENERICSV(GvSV(dstr));
3895 dref = (SV*)GvSV(dstr);
3897 if (!GvIMPORTED_SV(dstr)
3898 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3900 GvIMPORTED_SV_on(dstr);
3906 if (SvTAINTED(sstr))
3911 (void)SvOOK_off(dstr); /* backoff */
3913 Safefree(SvPVX(dstr));
3914 SvLEN(dstr)=SvCUR(dstr)=0;
3917 (void)SvOK_off(dstr);
3918 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
3920 if (sflags & SVp_NOK) {
3922 /* Only set the public OK flag if the source has public OK. */
3923 if (sflags & SVf_NOK)
3924 SvFLAGS(dstr) |= SVf_NOK;
3925 SvNVX(dstr) = SvNVX(sstr);
3927 if (sflags & SVp_IOK) {
3928 (void)SvIOKp_on(dstr);
3929 if (sflags & SVf_IOK)
3930 SvFLAGS(dstr) |= SVf_IOK;
3931 if (sflags & SVf_IVisUV)
3933 SvIVX(dstr) = SvIVX(sstr);
3935 if (SvAMAGIC(sstr)) {
3939 else if (sflags & SVp_POK) {
3943 * Check to see if we can just swipe the string. If so, it's a
3944 * possible small lose on short strings, but a big win on long ones.
3945 * It might even be a win on short strings if SvPVX(dstr)
3946 * has to be allocated and SvPVX(sstr) has to be freed.
3950 #ifdef PERL_COPY_ON_WRITE
3951 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3955 (sflags & SVs_TEMP) && /* slated for free anyway? */
3956 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3957 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3958 SvLEN(sstr) && /* and really is a string */
3959 /* and won't be needed again, potentially */
3960 !(PL_op && PL_op->op_type == OP_AASSIGN))
3961 #ifdef PERL_COPY_ON_WRITE
3962 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3963 && SvTYPE(sstr) >= SVt_PVIV)
3966 /* Failed the swipe test, and it's not a shared hash key either.
3967 Have to copy the string. */
3968 STRLEN len = SvCUR(sstr);
3969 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3970 Move(SvPVX(sstr),SvPVX(dstr),len,char);
3971 SvCUR_set(dstr, len);
3972 *SvEND(dstr) = '\0';
3973 (void)SvPOK_only(dstr);
3975 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
3977 #ifdef PERL_COPY_ON_WRITE
3978 /* Either it's a shared hash key, or it's suitable for
3979 copy-on-write or we can swipe the string. */
3981 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3986 /* I believe I should acquire a global SV mutex if
3987 it's a COW sv (not a shared hash key) to stop
3988 it going un copy-on-write.
3989 If the source SV has gone un copy on write between up there
3990 and down here, then (assert() that) it is of the correct
3991 form to make it copy on write again */
3992 if ((sflags & (SVf_FAKE | SVf_READONLY))
3993 != (SVf_FAKE | SVf_READONLY)) {
3994 SvREADONLY_on(sstr);
3996 /* Make the source SV into a loop of 1.
3997 (about to become 2) */
3998 SV_COW_NEXT_SV_SET(sstr, sstr);
4002 /* Initial code is common. */
4003 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4005 SvFLAGS(dstr) &= ~SVf_OOK;
4006 Safefree(SvPVX(dstr) - SvIVX(dstr));
4008 else if (SvLEN(dstr))
4009 Safefree(SvPVX(dstr));
4011 (void)SvPOK_only(dstr);
4013 #ifdef PERL_COPY_ON_WRITE
4015 /* making another shared SV. */
4016 STRLEN cur = SvCUR(sstr);
4017 STRLEN len = SvLEN(sstr);
4018 assert (SvTYPE(dstr) >= SVt_PVIV);
4020 /* SvIsCOW_normal */
4021 /* splice us in between source and next-after-source. */
4022 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4023 SV_COW_NEXT_SV_SET(sstr, dstr);
4024 SvPV_set(dstr, SvPVX(sstr));
4026 /* SvIsCOW_shared_hash */
4027 UV hash = SvUVX(sstr);
4028 DEBUG_C(PerlIO_printf(Perl_debug_log,
4029 "Copy on write: Sharing hash\n"));
4031 sharepvn(SvPVX(sstr),
4032 (sflags & SVf_UTF8?-cur:cur), hash));
4037 SvREADONLY_on(dstr);
4039 /* Relesase a global SV mutex. */
4043 { /* Passes the swipe test. */
4044 SvPV_set(dstr, SvPVX(sstr));
4045 SvLEN_set(dstr, SvLEN(sstr));
4046 SvCUR_set(dstr, SvCUR(sstr));
4049 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4050 SvPV_set(sstr, Nullch);
4056 if (sflags & SVf_UTF8)
4059 if (sflags & SVp_NOK) {
4061 if (sflags & SVf_NOK)
4062 SvFLAGS(dstr) |= SVf_NOK;
4063 SvNVX(dstr) = SvNVX(sstr);
4065 if (sflags & SVp_IOK) {
4066 (void)SvIOKp_on(dstr);
4067 if (sflags & SVf_IOK)
4068 SvFLAGS(dstr) |= SVf_IOK;
4069 if (sflags & SVf_IVisUV)
4071 SvIVX(dstr) = SvIVX(sstr);
4074 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4075 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4076 smg->mg_ptr, smg->mg_len);
4077 SvRMAGICAL_on(dstr);
4080 else if (sflags & SVp_IOK) {
4081 if (sflags & SVf_IOK)
4082 (void)SvIOK_only(dstr);
4084 (void)SvOK_off(dstr);
4085 (void)SvIOKp_on(dstr);
4087 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4088 if (sflags & SVf_IVisUV)
4090 SvIVX(dstr) = SvIVX(sstr);
4091 if (sflags & SVp_NOK) {
4092 if (sflags & SVf_NOK)
4093 (void)SvNOK_on(dstr);
4095 (void)SvNOKp_on(dstr);
4096 SvNVX(dstr) = SvNVX(sstr);
4099 else if (sflags & SVp_NOK) {
4100 if (sflags & SVf_NOK)
4101 (void)SvNOK_only(dstr);
4103 (void)SvOK_off(dstr);
4106 SvNVX(dstr) = SvNVX(sstr);
4109 if (dtype == SVt_PVGV) {
4110 if (ckWARN(WARN_MISC))
4111 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4114 (void)SvOK_off(dstr);
4116 if (SvTAINTED(sstr))
4121 =for apidoc sv_setsv_mg
4123 Like C<sv_setsv>, but also handles 'set' magic.
4129 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4131 sv_setsv(dstr,sstr);
4135 #ifdef PERL_COPY_ON_WRITE
4137 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4139 STRLEN cur = SvCUR(sstr);
4140 STRLEN len = SvLEN(sstr);
4141 register char *new_pv;
4144 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4152 if (SvTHINKFIRST(dstr))
4153 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4154 else if (SvPVX(dstr))
4155 Safefree(SvPVX(dstr));
4159 SvUPGRADE (dstr, SVt_PVIV);
4161 assert (SvPOK(sstr));
4162 assert (SvPOKp(sstr));
4163 assert (!SvIOK(sstr));
4164 assert (!SvIOKp(sstr));
4165 assert (!SvNOK(sstr));
4166 assert (!SvNOKp(sstr));
4168 if (SvIsCOW(sstr)) {
4170 if (SvLEN(sstr) == 0) {
4171 /* source is a COW shared hash key. */
4172 UV hash = SvUVX(sstr);
4173 DEBUG_C(PerlIO_printf(Perl_debug_log,
4174 "Fast copy on write: Sharing hash\n"));
4176 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4179 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4181 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4182 SvUPGRADE (sstr, SVt_PVIV);
4183 SvREADONLY_on(sstr);
4185 DEBUG_C(PerlIO_printf(Perl_debug_log,
4186 "Fast copy on write: Converting sstr to COW\n"));
4187 SV_COW_NEXT_SV_SET(dstr, sstr);
4189 SV_COW_NEXT_SV_SET(sstr, dstr);
4190 new_pv = SvPVX(sstr);
4193 SvPV_set(dstr, new_pv);
4194 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4207 =for apidoc sv_setpvn
4209 Copies a string into an SV. The C<len> parameter indicates the number of
4210 bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4216 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4218 register char *dptr;
4220 SV_CHECK_THINKFIRST_COW_DROP(sv);
4226 /* len is STRLEN which is unsigned, need to copy to signed */
4229 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4231 (void)SvUPGRADE(sv, SVt_PV);
4233 SvGROW(sv, len + 1);
4235 Move(ptr,dptr,len,char);
4238 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4243 =for apidoc sv_setpvn_mg
4245 Like C<sv_setpvn>, but also handles 'set' magic.
4251 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4253 sv_setpvn(sv,ptr,len);
4258 =for apidoc sv_setpv
4260 Copies a string into an SV. The string must be null-terminated. Does not
4261 handle 'set' magic. See C<sv_setpv_mg>.
4267 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4269 register STRLEN len;
4271 SV_CHECK_THINKFIRST_COW_DROP(sv);
4277 (void)SvUPGRADE(sv, SVt_PV);
4279 SvGROW(sv, len + 1);
4280 Move(ptr,SvPVX(sv),len+1,char);
4282 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4287 =for apidoc sv_setpv_mg
4289 Like C<sv_setpv>, but also handles 'set' magic.
4295 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4302 =for apidoc sv_usepvn
4304 Tells an SV to use C<ptr> to find its string value. Normally the string is
4305 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4306 The C<ptr> should point to memory that was allocated by C<malloc>. The
4307 string length, C<len>, must be supplied. This function will realloc the
4308 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4309 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4310 See C<sv_usepvn_mg>.
4316 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4318 SV_CHECK_THINKFIRST_COW_DROP(sv);
4319 (void)SvUPGRADE(sv, SVt_PV);
4324 (void)SvOOK_off(sv);
4325 if (SvPVX(sv) && SvLEN(sv))
4326 Safefree(SvPVX(sv));
4327 Renew(ptr, len+1, char);
4330 SvLEN_set(sv, len+1);
4332 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4337 =for apidoc sv_usepvn_mg
4339 Like C<sv_usepvn>, but also handles 'set' magic.
4345 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4347 sv_usepvn(sv,ptr,len);
4351 #ifdef PERL_COPY_ON_WRITE
4352 /* Need to do this *after* making the SV normal, as we need the buffer
4353 pointer to remain valid until after we've copied it. If we let go too early,
4354 another thread could invalidate it by unsharing last of the same hash key
4355 (which it can do by means other than releasing copy-on-write Svs)
4356 or by changing the other copy-on-write SVs in the loop. */
4358 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4359 U32 hash, SV *after)
4361 if (len) { /* this SV was SvIsCOW_normal(sv) */
4362 /* we need to find the SV pointing to us. */
4363 SV *current = SV_COW_NEXT_SV(after);
4365 if (current == sv) {
4366 /* The SV we point to points back to us (there were only two of us
4368 Hence other SV is no longer copy on write either. */
4370 SvREADONLY_off(after);
4372 /* We need to follow the pointers around the loop. */
4374 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4377 /* don't loop forever if the structure is bust, and we have
4378 a pointer into a closed loop. */
4379 assert (current != after);
4380 assert (SvPVX(current) == pvx);
4382 /* Make the SV before us point to the SV after us. */
4383 SV_COW_NEXT_SV_SET(current, after);
4386 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4391 Perl_sv_release_IVX(pTHX_ register SV *sv)
4394 sv_force_normal_flags(sv, 0);
4395 return SvOOK_off(sv);
4399 =for apidoc sv_force_normal_flags
4401 Undo various types of fakery on an SV: if the PV is a shared string, make
4402 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4403 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4404 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4405 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4406 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4407 set to some other value.) In addition, the C<flags> parameter gets passed to
4408 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4409 with flags set to 0.
4415 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4417 #ifdef PERL_COPY_ON_WRITE
4418 if (SvREADONLY(sv)) {
4419 /* At this point I believe I should acquire a global SV mutex. */
4421 char *pvx = SvPVX(sv);
4422 STRLEN len = SvLEN(sv);
4423 STRLEN cur = SvCUR(sv);
4424 U32 hash = SvUVX(sv);
4425 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4427 PerlIO_printf(Perl_debug_log,
4428 "Copy on write: Force normal %ld\n",
4434 /* This SV doesn't own the buffer, so need to New() a new one: */
4437 if (flags & SV_COW_DROP_PV) {
4438 /* OK, so we don't need to copy our buffer. */
4441 SvGROW(sv, cur + 1);
4442 Move(pvx,SvPVX(sv),cur,char);
4446 sv_release_COW(sv, pvx, cur, len, hash, next);
4451 else if (PL_curcop != &PL_compiling)
4452 Perl_croak(aTHX_ PL_no_modify);
4453 /* At this point I believe that I can drop the global SV mutex. */
4456 if (SvREADONLY(sv)) {
4458 char *pvx = SvPVX(sv);
4459 STRLEN len = SvCUR(sv);
4460 U32 hash = SvUVX(sv);
4463 SvGROW(sv, len + 1);
4464 Move(pvx,SvPVX(sv),len,char);
4466 unsharepvn(pvx, SvUTF8(sv) ? -(I32)len : len, hash);
4468 else if (PL_curcop != &PL_compiling)
4469 Perl_croak(aTHX_ PL_no_modify);
4473 sv_unref_flags(sv, flags);
4474 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4479 =for apidoc sv_force_normal
4481 Undo various types of fakery on an SV: if the PV is a shared string, make
4482 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4483 an xpvmg. See also C<sv_force_normal_flags>.
4489 Perl_sv_force_normal(pTHX_ register SV *sv)
4491 sv_force_normal_flags(sv, 0);
4497 Efficient removal of characters from the beginning of the string buffer.
4498 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4499 the string buffer. The C<ptr> becomes the first character of the adjusted
4500 string. Uses the "OOK hack".
4506 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
4508 register STRLEN delta;
4510 if (!ptr || !SvPOKp(sv))
4512 SV_CHECK_THINKFIRST(sv);
4513 if (SvTYPE(sv) < SVt_PVIV)
4514 sv_upgrade(sv,SVt_PVIV);
4517 if (!SvLEN(sv)) { /* make copy of shared string */
4518 char *pvx = SvPVX(sv);
4519 STRLEN len = SvCUR(sv);
4520 SvGROW(sv, len + 1);
4521 Move(pvx,SvPVX(sv),len,char);
4525 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4526 and we do that anyway inside the SvNIOK_off
4528 SvFLAGS(sv) |= SVf_OOK;
4531 delta = ptr - SvPVX(sv);
4538 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4539 * this function provided for binary compatibility only
4543 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4545 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4549 =for apidoc sv_catpvn
4551 Concatenates the string onto the end of the string which is in the SV. The
4552 C<len> indicates number of bytes to copy. If the SV has the UTF8
4553 status set, then the bytes appended should be valid UTF8.
4554 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4556 =for apidoc sv_catpvn_flags
4558 Concatenates the string onto the end of the string which is in the SV. The
4559 C<len> indicates number of bytes to copy. If the SV has the UTF8
4560 status set, then the bytes appended should be valid UTF8.
4561 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4562 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4563 in terms of this function.
4569 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4574 dstr = SvPV_force_flags(dsv, dlen, flags);
4575 SvGROW(dsv, dlen + slen + 1);
4578 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4581 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4586 =for apidoc sv_catpvn_mg
4588 Like C<sv_catpvn>, but also handles 'set' magic.
4594 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4596 sv_catpvn(sv,ptr,len);
4600 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4601 * this function provided for binary compatibility only
4605 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4607 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4611 =for apidoc sv_catsv
4613 Concatenates the string from SV C<ssv> onto the end of the string in
4614 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4615 not 'set' magic. See C<sv_catsv_mg>.
4617 =for apidoc sv_catsv_flags
4619 Concatenates the string from SV C<ssv> onto the end of the string in
4620 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4621 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4622 and C<sv_catsv_nomg> are implemented in terms of this function.
4627 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4633 if ((spv = SvPV(ssv, slen))) {
4634 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4635 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4636 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4637 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4638 dsv->sv_flags doesn't have that bit set.
4639 Andy Dougherty 12 Oct 2001
4641 I32 sutf8 = DO_UTF8(ssv);
4644 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4646 dutf8 = DO_UTF8(dsv);
4648 if (dutf8 != sutf8) {
4650 /* Not modifying source SV, so taking a temporary copy. */
4651 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4653 sv_utf8_upgrade(csv);
4654 spv = SvPV(csv, slen);
4657 sv_utf8_upgrade_nomg(dsv);
4659 sv_catpvn_nomg(dsv, spv, slen);
4664 =for apidoc sv_catsv_mg
4666 Like C<sv_catsv>, but also handles 'set' magic.
4672 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4679 =for apidoc sv_catpv
4681 Concatenates the string onto the end of the string which is in the SV.
4682 If the SV has the UTF8 status set, then the bytes appended should be
4683 valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4688 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4690 register STRLEN len;
4696 junk = SvPV_force(sv, tlen);
4698 SvGROW(sv, tlen + len + 1);
4701 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4703 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4708 =for apidoc sv_catpv_mg
4710 Like C<sv_catpv>, but also handles 'set' magic.
4716 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4725 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4726 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4733 Perl_newSV(pTHX_ STRLEN len)
4739 sv_upgrade(sv, SVt_PV);
4740 SvGROW(sv, len + 1);
4745 =for apidoc sv_magicext
4747 Adds magic to an SV, upgrading it if necessary. Applies the
4748 supplied vtable and returns pointer to the magic added.
4750 Note that sv_magicext will allow things that sv_magic will not.
4751 In particular you can add magic to SvREADONLY SVs and and more than
4752 one instance of the same 'how'
4754 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4755 if C<namelen> is zero then C<name> is stored as-is and - as another special
4756 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4757 an C<SV*> and has its REFCNT incremented
4759 (This is now used as a subroutine by sv_magic.)
4764 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4765 const char* name, I32 namlen)
4769 if (SvTYPE(sv) < SVt_PVMG) {
4770 (void)SvUPGRADE(sv, SVt_PVMG);
4772 Newz(702,mg, 1, MAGIC);
4773 mg->mg_moremagic = SvMAGIC(sv);
4776 /* Some magic sontains a reference loop, where the sv and object refer to
4777 each other. To prevent a reference loop that would prevent such
4778 objects being freed, we look for such loops and if we find one we
4779 avoid incrementing the object refcount.
4781 Note we cannot do this to avoid self-tie loops as intervening RV must
4782 have its REFCNT incremented to keep it in existence.
4785 if (!obj || obj == sv ||
4786 how == PERL_MAGIC_arylen ||
4787 how == PERL_MAGIC_qr ||
4788 (SvTYPE(obj) == SVt_PVGV &&
4789 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4790 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4791 GvFORM(obj) == (CV*)sv)))
4796 mg->mg_obj = SvREFCNT_inc(obj);
4797 mg->mg_flags |= MGf_REFCOUNTED;
4800 /* Normal self-ties simply pass a null object, and instead of
4801 using mg_obj directly, use the SvTIED_obj macro to produce a
4802 new RV as needed. For glob "self-ties", we are tieing the PVIO
4803 with an RV obj pointing to the glob containing the PVIO. In
4804 this case, to avoid a reference loop, we need to weaken the
4808 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4809 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4815 mg->mg_len = namlen;
4818 mg->mg_ptr = savepvn(name, namlen);
4819 else if (namlen == HEf_SVKEY)
4820 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4822 mg->mg_ptr = (char *) name;
4824 mg->mg_virtual = vtable;
4828 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4833 =for apidoc sv_magic
4835 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4836 then adds a new magic item of type C<how> to the head of the magic list.
4842 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4847 #ifdef PERL_COPY_ON_WRITE
4849 sv_force_normal_flags(sv, 0);
4851 if (SvREADONLY(sv)) {
4852 if (PL_curcop != &PL_compiling
4853 && how != PERL_MAGIC_regex_global
4854 && how != PERL_MAGIC_bm
4855 && how != PERL_MAGIC_fm
4856 && how != PERL_MAGIC_sv
4859 Perl_croak(aTHX_ PL_no_modify);
4862 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4863 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4864 /* sv_magic() refuses to add a magic of the same 'how' as an
4867 if (how == PERL_MAGIC_taint)
4875 vtable = &PL_vtbl_sv;
4877 case PERL_MAGIC_overload:
4878 vtable = &PL_vtbl_amagic;
4880 case PERL_MAGIC_overload_elem:
4881 vtable = &PL_vtbl_amagicelem;
4883 case PERL_MAGIC_overload_table:
4884 vtable = &PL_vtbl_ovrld;
4887 vtable = &PL_vtbl_bm;
4889 case PERL_MAGIC_regdata:
4890 vtable = &PL_vtbl_regdata;
4892 case PERL_MAGIC_regdatum:
4893 vtable = &PL_vtbl_regdatum;
4895 case PERL_MAGIC_env:
4896 vtable = &PL_vtbl_env;
4899 vtable = &PL_vtbl_fm;
4901 case PERL_MAGIC_envelem:
4902 vtable = &PL_vtbl_envelem;
4904 case PERL_MAGIC_regex_global:
4905 vtable = &PL_vtbl_mglob;
4907 case PERL_MAGIC_isa:
4908 vtable = &PL_vtbl_isa;
4910 case PERL_MAGIC_isaelem:
4911 vtable = &PL_vtbl_isaelem;
4913 case PERL_MAGIC_nkeys:
4914 vtable = &PL_vtbl_nkeys;
4916 case PERL_MAGIC_dbfile:
4919 case PERL_MAGIC_dbline:
4920 vtable = &PL_vtbl_dbline;
4922 #ifdef USE_LOCALE_COLLATE
4923 case PERL_MAGIC_collxfrm:
4924 vtable = &PL_vtbl_collxfrm;
4926 #endif /* USE_LOCALE_COLLATE */
4927 case PERL_MAGIC_tied:
4928 vtable = &PL_vtbl_pack;
4930 case PERL_MAGIC_tiedelem:
4931 case PERL_MAGIC_tiedscalar:
4932 vtable = &PL_vtbl_packelem;
4935 vtable = &PL_vtbl_regexp;
4937 case PERL_MAGIC_sig:
4938 vtable = &PL_vtbl_sig;
4940 case PERL_MAGIC_sigelem:
4941 vtable = &PL_vtbl_sigelem;
4943 case PERL_MAGIC_taint:
4944 vtable = &PL_vtbl_taint;
4946 case PERL_MAGIC_uvar:
4947 vtable = &PL_vtbl_uvar;
4949 case PERL_MAGIC_vec:
4950 vtable = &PL_vtbl_vec;
4952 case PERL_MAGIC_vstring:
4955 case PERL_MAGIC_utf8:
4956 vtable = &PL_vtbl_utf8;
4958 case PERL_MAGIC_substr:
4959 vtable = &PL_vtbl_substr;
4961 case PERL_MAGIC_defelem:
4962 vtable = &PL_vtbl_defelem;
4964 case PERL_MAGIC_glob:
4965 vtable = &PL_vtbl_glob;
4967 case PERL_MAGIC_arylen:
4968 vtable = &PL_vtbl_arylen;
4970 case PERL_MAGIC_pos:
4971 vtable = &PL_vtbl_pos;
4973 case PERL_MAGIC_backref:
4974 vtable = &PL_vtbl_backref;
4976 case PERL_MAGIC_ext:
4977 /* Reserved for use by extensions not perl internals. */
4978 /* Useful for attaching extension internal data to perl vars. */
4979 /* Note that multiple extensions may clash if magical scalars */
4980 /* etc holding private data from one are passed to another. */
4983 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4986 /* Rest of work is done else where */
4987 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4990 case PERL_MAGIC_taint:
4993 case PERL_MAGIC_ext:
4994 case PERL_MAGIC_dbfile:
5001 =for apidoc sv_unmagic
5003 Removes all magic of type C<type> from an SV.
5009 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5013 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5016 for (mg = *mgp; mg; mg = *mgp) {
5017 if (mg->mg_type == type) {
5018 MGVTBL* vtbl = mg->mg_virtual;
5019 *mgp = mg->mg_moremagic;
5020 if (vtbl && vtbl->svt_free)
5021 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5022 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5024 Safefree(mg->mg_ptr);
5025 else if (mg->mg_len == HEf_SVKEY)
5026 SvREFCNT_dec((SV*)mg->mg_ptr);
5027 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5028 Safefree(mg->mg_ptr);
5030 if (mg->mg_flags & MGf_REFCOUNTED)
5031 SvREFCNT_dec(mg->mg_obj);
5035 mgp = &mg->mg_moremagic;
5039 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5046 =for apidoc sv_rvweaken
5048 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5049 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5050 push a back-reference to this RV onto the array of backreferences
5051 associated with that magic.
5057 Perl_sv_rvweaken(pTHX_ SV *sv)
5060 if (!SvOK(sv)) /* let undefs pass */
5063 Perl_croak(aTHX_ "Can't weaken a nonreference");
5064 else if (SvWEAKREF(sv)) {
5065 if (ckWARN(WARN_MISC))
5066 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5070 sv_add_backref(tsv, sv);
5076 /* Give tsv backref magic if it hasn't already got it, then push a
5077 * back-reference to sv onto the array associated with the backref magic.
5081 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5085 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5086 av = (AV*)mg->mg_obj;
5089 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5090 SvREFCNT_dec(av); /* for sv_magic */
5092 if (AvFILLp(av) >= AvMAX(av)) {
5093 SV **svp = AvARRAY(av);
5094 I32 i = AvFILLp(av);
5096 if (svp[i] == &PL_sv_undef) {
5097 svp[i] = sv; /* reuse the slot */
5102 av_extend(av, AvFILLp(av)+1);
5104 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5107 /* delete a back-reference to ourselves from the backref magic associated
5108 * with the SV we point to.
5112 S_sv_del_backref(pTHX_ SV *sv)
5119 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5120 Perl_croak(aTHX_ "panic: del_backref");
5121 av = (AV *)mg->mg_obj;
5126 svp[i] = &PL_sv_undef; /* XXX */
5133 =for apidoc sv_insert
5135 Inserts a string at the specified offset/length within the SV. Similar to
5136 the Perl substr() function.
5142 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5146 register char *midend;
5147 register char *bigend;
5153 Perl_croak(aTHX_ "Can't modify non-existent substring");
5154 SvPV_force(bigstr, curlen);
5155 (void)SvPOK_only_UTF8(bigstr);
5156 if (offset + len > curlen) {
5157 SvGROW(bigstr, offset+len+1);
5158 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5159 SvCUR_set(bigstr, offset+len);
5163 i = littlelen - len;
5164 if (i > 0) { /* string might grow */
5165 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5166 mid = big + offset + len;
5167 midend = bigend = big + SvCUR(bigstr);
5170 while (midend > mid) /* shove everything down */
5171 *--bigend = *--midend;
5172 Move(little,big+offset,littlelen,char);
5178 Move(little,SvPVX(bigstr)+offset,len,char);
5183 big = SvPVX(bigstr);
5186 bigend = big + SvCUR(bigstr);
5188 if (midend > bigend)
5189 Perl_croak(aTHX_ "panic: sv_insert");
5191 if (mid - big > bigend - midend) { /* faster to shorten from end */
5193 Move(little, mid, littlelen,char);
5196 i = bigend - midend;
5198 Move(midend, mid, i,char);
5202 SvCUR_set(bigstr, mid - big);
5205 else if ((i = mid - big)) { /* faster from front */
5206 midend -= littlelen;
5208 sv_chop(bigstr,midend-i);
5213 Move(little, mid, littlelen,char);
5215 else if (littlelen) {
5216 midend -= littlelen;
5217 sv_chop(bigstr,midend);
5218 Move(little,midend,littlelen,char);
5221 sv_chop(bigstr,midend);
5227 =for apidoc sv_replace
5229 Make the first argument a copy of the second, then delete the original.
5230 The target SV physically takes over ownership of the body of the source SV
5231 and inherits its flags; however, the target keeps any magic it owns,
5232 and any magic in the source is discarded.
5233 Note that this is a rather specialist SV copying operation; most of the
5234 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5240 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5242 U32 refcnt = SvREFCNT(sv);
5243 SV_CHECK_THINKFIRST_COW_DROP(sv);
5244 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5245 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5246 if (SvMAGICAL(sv)) {
5250 sv_upgrade(nsv, SVt_PVMG);
5251 SvMAGIC(nsv) = SvMAGIC(sv);
5252 SvFLAGS(nsv) |= SvMAGICAL(sv);
5258 assert(!SvREFCNT(sv));
5259 StructCopy(nsv,sv,SV);
5260 #ifdef PERL_COPY_ON_WRITE
5261 if (SvIsCOW_normal(nsv)) {
5262 /* We need to follow the pointers around the loop to make the
5263 previous SV point to sv, rather than nsv. */
5266 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5269 assert(SvPVX(current) == SvPVX(nsv));
5271 /* Make the SV before us point to the SV after us. */
5273 PerlIO_printf(Perl_debug_log, "previous is\n");
5275 PerlIO_printf(Perl_debug_log,
5276 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5277 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5279 SV_COW_NEXT_SV_SET(current, sv);
5282 SvREFCNT(sv) = refcnt;
5283 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5288 =for apidoc sv_clear
5290 Clear an SV: call any destructors, free up any memory used by the body,
5291 and free the body itself. The SV's head is I<not> freed, although
5292 its type is set to all 1's so that it won't inadvertently be assumed
5293 to be live during global destruction etc.
5294 This function should only be called when REFCNT is zero. Most of the time
5295 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5302 Perl_sv_clear(pTHX_ register SV *sv)
5306 assert(SvREFCNT(sv) == 0);
5309 if (PL_defstash) { /* Still have a symbol table? */
5316 stash = SvSTASH(sv);
5317 destructor = StashHANDLER(stash,DESTROY);
5319 SV* tmpref = newRV(sv);
5320 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5322 PUSHSTACKi(PERLSI_DESTROY);
5327 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5333 if(SvREFCNT(tmpref) < 2) {
5334 /* tmpref is not kept alive! */
5339 SvREFCNT_dec(tmpref);
5341 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5345 if (PL_in_clean_objs)
5346 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5348 /* DESTROY gave object new lease on life */
5354 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5355 SvOBJECT_off(sv); /* Curse the object. */
5356 if (SvTYPE(sv) != SVt_PVIO)
5357 --PL_sv_objcount; /* XXX Might want something more general */
5360 if (SvTYPE(sv) >= SVt_PVMG) {
5363 if (SvFLAGS(sv) & SVpad_TYPED)
5364 SvREFCNT_dec(SvSTASH(sv));
5367 switch (SvTYPE(sv)) {
5370 IoIFP(sv) != PerlIO_stdin() &&
5371 IoIFP(sv) != PerlIO_stdout() &&
5372 IoIFP(sv) != PerlIO_stderr())
5374 io_close((IO*)sv, FALSE);
5376 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5377 PerlDir_close(IoDIRP(sv));
5378 IoDIRP(sv) = (DIR*)NULL;
5379 Safefree(IoTOP_NAME(sv));
5380 Safefree(IoFMT_NAME(sv));
5381 Safefree(IoBOTTOM_NAME(sv));
5396 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5397 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5398 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5399 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5401 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5402 SvREFCNT_dec(LvTARG(sv));
5406 Safefree(GvNAME(sv));
5407 /* cannot decrease stash refcount yet, as we might recursively delete
5408 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5409 of stash until current sv is completely gone.
5410 -- JohnPC, 27 Mar 1998 */
5411 stash = GvSTASH(sv);
5417 (void)SvOOK_off(sv);
5425 SvREFCNT_dec(SvRV(sv));
5427 #ifdef PERL_COPY_ON_WRITE
5428 else if (SvPVX(sv)) {
5430 /* I believe I need to grab the global SV mutex here and
5431 then recheck the COW status. */
5433 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5436 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5437 SvUVX(sv), SV_COW_NEXT_SV(sv));
5438 /* And drop it here. */
5440 } else if (SvLEN(sv)) {
5441 Safefree(SvPVX(sv));
5445 else if (SvPVX(sv) && SvLEN(sv))
5446 Safefree(SvPVX(sv));
5447 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5448 unsharepvn(SvPVX(sv),
5449 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5463 switch (SvTYPE(sv)) {
5479 del_XPVIV(SvANY(sv));
5482 del_XPVNV(SvANY(sv));
5485 del_XPVMG(SvANY(sv));
5488 del_XPVLV(SvANY(sv));
5491 del_XPVAV(SvANY(sv));
5494 del_XPVHV(SvANY(sv));
5497 del_XPVCV(SvANY(sv));
5500 del_XPVGV(SvANY(sv));
5501 /* code duplication for increased performance. */
5502 SvFLAGS(sv) &= SVf_BREAK;
5503 SvFLAGS(sv) |= SVTYPEMASK;
5504 /* decrease refcount of the stash that owns this GV, if any */
5506 SvREFCNT_dec(stash);
5507 return; /* not break, SvFLAGS reset already happened */
5509 del_XPVBM(SvANY(sv));
5512 del_XPVFM(SvANY(sv));
5515 del_XPVIO(SvANY(sv));
5518 SvFLAGS(sv) &= SVf_BREAK;
5519 SvFLAGS(sv) |= SVTYPEMASK;
5523 =for apidoc sv_newref
5525 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5532 Perl_sv_newref(pTHX_ SV *sv)
5542 Decrement an SV's reference count, and if it drops to zero, call
5543 C<sv_clear> to invoke destructors and free up any memory used by
5544 the body; finally, deallocate the SV's head itself.
5545 Normally called via a wrapper macro C<SvREFCNT_dec>.
5551 Perl_sv_free(pTHX_ SV *sv)
5555 if (SvREFCNT(sv) == 0) {
5556 if (SvFLAGS(sv) & SVf_BREAK)
5557 /* this SV's refcnt has been artificially decremented to
5558 * trigger cleanup */
5560 if (PL_in_clean_all) /* All is fair */
5562 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5563 /* make sure SvREFCNT(sv)==0 happens very seldom */
5564 SvREFCNT(sv) = (~(U32)0)/2;
5567 if (ckWARN_d(WARN_INTERNAL))
5568 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Attempt to free unreferenced scalar");
5571 if (--(SvREFCNT(sv)) > 0)
5573 Perl_sv_free2(aTHX_ sv);
5577 Perl_sv_free2(pTHX_ SV *sv)
5581 if (ckWARN_d(WARN_DEBUGGING))
5582 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5583 "Attempt to free temp prematurely: SV 0x%"UVxf,
5588 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5589 /* make sure SvREFCNT(sv)==0 happens very seldom */
5590 SvREFCNT(sv) = (~(U32)0)/2;
5601 Returns the length of the string in the SV. Handles magic and type
5602 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5608 Perl_sv_len(pTHX_ register SV *sv)
5616 len = mg_length(sv);
5618 (void)SvPV(sv, len);
5623 =for apidoc sv_len_utf8
5625 Returns the number of characters in the string in an SV, counting wide
5626 UTF8 bytes as a single character. Handles magic and type coercion.
5632 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5633 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5634 * (Note that the mg_len is not the length of the mg_ptr field.)
5639 Perl_sv_len_utf8(pTHX_ register SV *sv)
5645 return mg_length(sv);
5649 U8 *s = (U8*)SvPV(sv, len);
5650 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5652 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0))
5655 ulen = Perl_utf8_length(aTHX_ s, s + len);
5656 if (!mg && !SvREADONLY(sv)) {
5657 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5658 mg = mg_find(sv, PERL_MAGIC_utf8);
5668 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5669 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5670 * between UTF-8 and byte offsets. There are two (substr offset and substr
5671 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5672 * and byte offset) cache positions.
5674 * The mg_len field is used by sv_len_utf8(), see its comments.
5675 * Note that the mg_len is not the length of the mg_ptr field.
5679 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
5683 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5685 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5686 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5691 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5693 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5694 (*mgp)->mg_ptr = (char *) *cachep;
5698 (*cachep)[i] = *offsetp;
5699 (*cachep)[i+1] = s - start;
5707 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5708 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5709 * between UTF-8 and byte offsets. See also the comments of
5710 * S_utf8_mg_pos_init().
5714 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
5718 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5720 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5721 if (*mgp && (*mgp)->mg_ptr) {
5722 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5723 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5725 else { /* We will skip to the right spot. */
5730 /* The assumption is that going backward is half
5731 * the speed of going forward (that's where the
5732 * 2 * backw in the below comes from). (The real
5733 * figure of course depends on the UTF-8 data.) */
5735 if ((*cachep)[i] > (STRLEN)uoff) {
5737 backw = (*cachep)[i] - (STRLEN)uoff;
5739 if (forw < 2 * backw)
5742 p = start + (*cachep)[i+1];
5744 /* Try this only for the substr offset (i == 0),
5745 * not for the substr length (i == 2). */
5746 else if (i == 0) { /* (*cachep)[i] < uoff */
5747 STRLEN ulen = sv_len_utf8(sv);
5749 if ((STRLEN)uoff < ulen) {
5750 forw = (STRLEN)uoff - (*cachep)[i];
5751 backw = ulen - (STRLEN)uoff;
5753 if (forw < 2 * backw)
5754 p = start + (*cachep)[i+1];
5759 /* If the string is not long enough for uoff,
5760 * we could extend it, but not at this low a level. */
5764 if (forw < 2 * backw) {
5771 while (UTF8_IS_CONTINUATION(*p))
5776 /* Update the cache. */
5777 (*cachep)[i] = (STRLEN)uoff;
5778 (*cachep)[i+1] = p - start;
5783 if (found) { /* Setup the return values. */
5784 *offsetp = (*cachep)[i+1];
5785 *sp = start + *offsetp;
5788 *offsetp = send - start;
5790 else if (*sp < start) {
5801 =for apidoc sv_pos_u2b
5803 Converts the value pointed to by offsetp from a count of UTF8 chars from
5804 the start of the string, to a count of the equivalent number of bytes; if
5805 lenp is non-zero, it does the same to lenp, but this time starting from
5806 the offset, rather than from the start of the string. Handles magic and
5813 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5814 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5815 * byte offsets. See also the comments of S_utf8_mg_pos().
5820 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5831 start = s = (U8*)SvPV(sv, len);
5833 I32 uoffset = *offsetp;
5838 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5840 if (!found && uoffset > 0) {
5841 while (s < send && uoffset--)
5845 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
5847 *offsetp = s - start;
5852 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
5856 if (!found && *lenp > 0) {
5859 while (s < send && ulen--)
5863 if (utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start))
5864 cache[2] += *offsetp;
5878 =for apidoc sv_pos_b2u
5880 Converts the value pointed to by offsetp from a count of bytes from the
5881 start of the string, to a count of the equivalent number of UTF8 chars.
5882 Handles magic and type coercion.
5888 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5889 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5890 * byte offsets. See also the comments of S_utf8_mg_pos().
5895 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5903 s = (U8*)SvPV(sv, len);
5904 if ((I32)len < *offsetp)
5905 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5907 U8* send = s + *offsetp;
5909 STRLEN *cache = NULL;
5913 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5914 mg = mg_find(sv, PERL_MAGIC_utf8);
5915 if (mg && mg->mg_ptr) {
5916 cache = (STRLEN *) mg->mg_ptr;
5917 if (cache[1] == *offsetp) {
5918 /* An exact match. */
5919 *offsetp = cache[0];
5923 else if (cache[1] < *offsetp) {
5924 /* We already know part of the way. */
5927 /* Let the below loop do the rest. */
5929 else { /* cache[1] > *offsetp */
5930 /* We already know all of the way, now we may
5931 * be able to walk back. The same assumption
5932 * is made as in S_utf8_mg_pos(), namely that
5933 * walking backward is twice slower than
5934 * walking forward. */
5935 STRLEN forw = *offsetp;
5936 STRLEN backw = cache[1] - *offsetp;
5938 if (!(forw < 2 * backw)) {
5939 U8 *p = s + cache[1];
5946 while (UTF8_IS_CONTINUATION(*p))
5962 /* Call utf8n_to_uvchr() to validate the sequence
5963 * (unless a simple non-UTF character) */
5964 if (!UTF8_IS_INVARIANT(*s))
5965 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5974 if (!SvREADONLY(sv)) {
5976 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5977 mg = mg_find(sv, PERL_MAGIC_utf8);
5982 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5983 mg->mg_ptr = (char *) cache;
5988 cache[1] = *offsetp;
5999 Returns a boolean indicating whether the strings in the two SVs are
6000 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6001 coerce its args to strings if necessary.
6007 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6015 SV* svrecode = Nullsv;
6022 pv1 = SvPV(sv1, cur1);
6029 pv2 = SvPV(sv2, cur2);
6031 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6032 /* Differing utf8ness.
6033 * Do not UTF8size the comparands as a side-effect. */
6036 svrecode = newSVpvn(pv2, cur2);
6037 sv_recode_to_utf8(svrecode, PL_encoding);
6038 pv2 = SvPV(svrecode, cur2);
6041 svrecode = newSVpvn(pv1, cur1);
6042 sv_recode_to_utf8(svrecode, PL_encoding);
6043 pv1 = SvPV(svrecode, cur1);
6045 /* Now both are in UTF-8. */
6050 bool is_utf8 = TRUE;
6053 /* sv1 is the UTF-8 one,
6054 * if is equal it must be downgrade-able */
6055 char *pv = (char*)bytes_from_utf8((U8*)pv1,
6061 /* sv2 is the UTF-8 one,
6062 * if is equal it must be downgrade-able */
6063 char *pv = (char *)bytes_from_utf8((U8*)pv2,
6069 /* Downgrade not possible - cannot be eq */
6076 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6079 SvREFCNT_dec(svrecode);
6090 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6091 string in C<sv1> is less than, equal to, or greater than the string in
6092 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6093 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6099 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6102 char *pv1, *pv2, *tpv = Nullch;
6104 SV *svrecode = Nullsv;
6111 pv1 = SvPV(sv1, cur1);
6118 pv2 = SvPV(sv2, cur2);
6120 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6121 /* Differing utf8ness.
6122 * Do not UTF8size the comparands as a side-effect. */
6125 svrecode = newSVpvn(pv2, cur2);
6126 sv_recode_to_utf8(svrecode, PL_encoding);
6127 pv2 = SvPV(svrecode, cur2);
6130 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
6135 svrecode = newSVpvn(pv1, cur1);
6136 sv_recode_to_utf8(svrecode, PL_encoding);
6137 pv1 = SvPV(svrecode, cur1);
6140 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
6146 cmp = cur2 ? -1 : 0;
6150 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6153 cmp = retval < 0 ? -1 : 1;
6154 } else if (cur1 == cur2) {
6157 cmp = cur1 < cur2 ? -1 : 1;
6162 SvREFCNT_dec(svrecode);
6171 =for apidoc sv_cmp_locale
6173 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6174 'use bytes' aware, handles get magic, and will coerce its args to strings
6175 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6181 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6183 #ifdef USE_LOCALE_COLLATE
6189 if (PL_collation_standard)
6193 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6195 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6197 if (!pv1 || !len1) {
6208 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6211 return retval < 0 ? -1 : 1;
6214 * When the result of collation is equality, that doesn't mean
6215 * that there are no differences -- some locales exclude some
6216 * characters from consideration. So to avoid false equalities,
6217 * we use the raw string as a tiebreaker.
6223 #endif /* USE_LOCALE_COLLATE */
6225 return sv_cmp(sv1, sv2);
6229 #ifdef USE_LOCALE_COLLATE
6232 =for apidoc sv_collxfrm
6234 Add Collate Transform magic to an SV if it doesn't already have it.
6236 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6237 scalar data of the variable, but transformed to such a format that a normal
6238 memory comparison can be used to compare the data according to the locale
6245 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6249 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6250 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6255 Safefree(mg->mg_ptr);
6257 if ((xf = mem_collxfrm(s, len, &xlen))) {
6258 if (SvREADONLY(sv)) {
6261 return xf + sizeof(PL_collation_ix);
6264 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6265 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6278 if (mg && mg->mg_ptr) {
6280 return mg->mg_ptr + sizeof(PL_collation_ix);
6288 #endif /* USE_LOCALE_COLLATE */
6293 Get a line from the filehandle and store it into the SV, optionally
6294 appending to the currently-stored string.
6300 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6304 register STDCHAR rslast;
6305 register STDCHAR *bp;
6311 if (SvTHINKFIRST(sv))
6312 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6313 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6315 However, perlbench says it's slower, because the existing swipe code
6316 is faster than copy on write.
6317 Swings and roundabouts. */
6318 (void)SvUPGRADE(sv, SVt_PV);
6323 if (PerlIO_isutf8(fp)) {
6325 sv_utf8_upgrade_nomg(sv);
6326 sv_pos_u2b(sv,&append,0);
6328 } else if (SvUTF8(sv)) {
6329 SV *tsv = NEWSV(0,0);
6330 sv_gets(tsv, fp, 0);
6331 sv_utf8_upgrade_nomg(tsv);
6332 SvCUR_set(sv,append);
6335 goto return_string_or_null;
6340 if (PerlIO_isutf8(fp))
6343 if (PL_curcop == &PL_compiling) {
6344 /* we always read code in line mode */
6348 else if (RsSNARF(PL_rs)) {
6349 /* If it is a regular disk file use size from stat() as estimate
6350 of amount we are going to read - may result in malloc-ing
6351 more memory than we realy need if layers bellow reduce
6352 size we read (e.g. CRLF or a gzip layer)
6355 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6356 Off_t offset = PerlIO_tell(fp);
6357 if (offset != (Off_t) -1) {
6358 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6364 else if (RsRECORD(PL_rs)) {
6368 /* Grab the size of the record we're getting */
6369 recsize = SvIV(SvRV(PL_rs));
6370 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6373 /* VMS wants read instead of fread, because fread doesn't respect */
6374 /* RMS record boundaries. This is not necessarily a good thing to be */
6375 /* doing, but we've got no other real choice - except avoid stdio
6376 as implementation - perhaps write a :vms layer ?
6378 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6380 bytesread = PerlIO_read(fp, buffer, recsize);
6382 SvCUR_set(sv, bytesread += append);
6383 buffer[bytesread] = '\0';
6384 goto return_string_or_null;
6386 else if (RsPARA(PL_rs)) {
6392 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6393 if (PerlIO_isutf8(fp)) {
6394 rsptr = SvPVutf8(PL_rs, rslen);
6397 if (SvUTF8(PL_rs)) {
6398 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6399 Perl_croak(aTHX_ "Wide character in $/");
6402 rsptr = SvPV(PL_rs, rslen);
6406 rslast = rslen ? rsptr[rslen - 1] : '\0';
6408 if (rspara) { /* have to do this both before and after */
6409 do { /* to make sure file boundaries work right */
6412 i = PerlIO_getc(fp);
6416 PerlIO_ungetc(fp,i);
6422 /* See if we know enough about I/O mechanism to cheat it ! */
6424 /* This used to be #ifdef test - it is made run-time test for ease
6425 of abstracting out stdio interface. One call should be cheap
6426 enough here - and may even be a macro allowing compile
6430 if (PerlIO_fast_gets(fp)) {
6433 * We're going to steal some values from the stdio struct
6434 * and put EVERYTHING in the innermost loop into registers.
6436 register STDCHAR *ptr;
6440 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6441 /* An ungetc()d char is handled separately from the regular
6442 * buffer, so we getc() it back out and stuff it in the buffer.
6444 i = PerlIO_getc(fp);
6445 if (i == EOF) return 0;
6446 *(--((*fp)->_ptr)) = (unsigned char) i;
6450 /* Here is some breathtakingly efficient cheating */
6452 cnt = PerlIO_get_cnt(fp); /* get count into register */
6453 /* make sure we have the room */
6454 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6455 /* Not room for all of it
6456 if we are looking for a separator and room for some
6458 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6459 /* just process what we have room for */
6460 shortbuffered = cnt - SvLEN(sv) + append + 1;
6461 cnt -= shortbuffered;
6465 /* remember that cnt can be negative */
6466 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6471 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
6472 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6473 DEBUG_P(PerlIO_printf(Perl_debug_log,
6474 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6475 DEBUG_P(PerlIO_printf(Perl_debug_log,
6476 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6477 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6478 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6483 while (cnt > 0) { /* this | eat */
6485 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6486 goto thats_all_folks; /* screams | sed :-) */
6490 Copy(ptr, bp, cnt, char); /* this | eat */
6491 bp += cnt; /* screams | dust */
6492 ptr += cnt; /* louder | sed :-) */
6497 if (shortbuffered) { /* oh well, must extend */
6498 cnt = shortbuffered;
6500 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6502 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6503 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6507 DEBUG_P(PerlIO_printf(Perl_debug_log,
6508 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6509 PTR2UV(ptr),(long)cnt));
6510 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6512 DEBUG_P(PerlIO_printf(Perl_debug_log,
6513 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6514 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6515 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6517 /* This used to call 'filbuf' in stdio form, but as that behaves like
6518 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6519 another abstraction. */
6520 i = PerlIO_getc(fp); /* get more characters */
6522 DEBUG_P(PerlIO_printf(Perl_debug_log,
6523 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6524 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6525 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6527 cnt = PerlIO_get_cnt(fp);
6528 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6529 DEBUG_P(PerlIO_printf(Perl_debug_log,
6530 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6532 if (i == EOF) /* all done for ever? */
6533 goto thats_really_all_folks;
6535 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6537 SvGROW(sv, bpx + cnt + 2);
6538 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6540 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6542 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6543 goto thats_all_folks;
6547 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
6548 memNE((char*)bp - rslen, rsptr, rslen))
6549 goto screamer; /* go back to the fray */
6550 thats_really_all_folks:
6552 cnt += shortbuffered;
6553 DEBUG_P(PerlIO_printf(Perl_debug_log,
6554 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6555 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6556 DEBUG_P(PerlIO_printf(Perl_debug_log,
6557 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6558 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6559 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6561 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
6562 DEBUG_P(PerlIO_printf(Perl_debug_log,
6563 "Screamer: done, len=%ld, string=|%.*s|\n",
6564 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
6569 /*The big, slow, and stupid way */
6572 /* Need to work around EPOC SDK features */
6573 /* On WINS: MS VC5 generates calls to _chkstk, */
6574 /* if a `large' stack frame is allocated */
6575 /* gcc on MARM does not generate calls like these */
6581 register STDCHAR *bpe = buf + sizeof(buf);
6583 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6584 ; /* keep reading */
6588 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6589 /* Accomodate broken VAXC compiler, which applies U8 cast to
6590 * both args of ?: operator, causing EOF to change into 255
6593 i = (U8)buf[cnt - 1];
6599 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6601 sv_catpvn(sv, (char *) buf, cnt);
6603 sv_setpvn(sv, (char *) buf, cnt);
6605 if (i != EOF && /* joy */
6607 SvCUR(sv) < rslen ||
6608 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6612 * If we're reading from a TTY and we get a short read,
6613 * indicating that the user hit his EOF character, we need
6614 * to notice it now, because if we try to read from the TTY
6615 * again, the EOF condition will disappear.
6617 * The comparison of cnt to sizeof(buf) is an optimization
6618 * that prevents unnecessary calls to feof().
6622 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6627 if (rspara) { /* have to do this both before and after */
6628 while (i != EOF) { /* to make sure file boundaries work right */
6629 i = PerlIO_getc(fp);
6631 PerlIO_ungetc(fp,i);
6637 return_string_or_null:
6638 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6644 Auto-increment of the value in the SV, doing string to numeric conversion
6645 if necessary. Handles 'get' magic.
6651 Perl_sv_inc(pTHX_ register SV *sv)
6660 if (SvTHINKFIRST(sv)) {
6662 sv_force_normal_flags(sv, 0);
6663 if (SvREADONLY(sv)) {
6664 if (PL_curcop != &PL_compiling)
6665 Perl_croak(aTHX_ PL_no_modify);
6669 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6671 i = PTR2IV(SvRV(sv));
6676 flags = SvFLAGS(sv);
6677 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6678 /* It's (privately or publicly) a float, but not tested as an
6679 integer, so test it to see. */
6681 flags = SvFLAGS(sv);
6683 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6684 /* It's publicly an integer, or privately an integer-not-float */
6685 #ifdef PERL_PRESERVE_IVUV
6689 if (SvUVX(sv) == UV_MAX)
6690 sv_setnv(sv, UV_MAX_P1);
6692 (void)SvIOK_only_UV(sv);
6695 if (SvIVX(sv) == IV_MAX)
6696 sv_setuv(sv, (UV)IV_MAX + 1);
6698 (void)SvIOK_only(sv);
6704 if (flags & SVp_NOK) {
6705 (void)SvNOK_only(sv);
6710 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
6711 if ((flags & SVTYPEMASK) < SVt_PVIV)
6712 sv_upgrade(sv, SVt_IV);
6713 (void)SvIOK_only(sv);
6718 while (isALPHA(*d)) d++;
6719 while (isDIGIT(*d)) d++;
6721 #ifdef PERL_PRESERVE_IVUV
6722 /* Got to punt this as an integer if needs be, but we don't issue
6723 warnings. Probably ought to make the sv_iv_please() that does
6724 the conversion if possible, and silently. */
6725 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6726 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6727 /* Need to try really hard to see if it's an integer.
6728 9.22337203685478e+18 is an integer.
6729 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6730 so $a="9.22337203685478e+18"; $a+0; $a++
6731 needs to be the same as $a="9.22337203685478e+18"; $a++
6738 /* sv_2iv *should* have made this an NV */
6739 if (flags & SVp_NOK) {
6740 (void)SvNOK_only(sv);
6744 /* I don't think we can get here. Maybe I should assert this
6745 And if we do get here I suspect that sv_setnv will croak. NWC
6747 #if defined(USE_LONG_DOUBLE)
6748 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",
6749 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6751 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6752 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6755 #endif /* PERL_PRESERVE_IVUV */
6756 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
6760 while (d >= SvPVX(sv)) {
6768 /* MKS: The original code here died if letters weren't consecutive.
6769 * at least it didn't have to worry about non-C locales. The
6770 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6771 * arranged in order (although not consecutively) and that only
6772 * [A-Za-z] are accepted by isALPHA in the C locale.
6774 if (*d != 'z' && *d != 'Z') {
6775 do { ++*d; } while (!isALPHA(*d));
6778 *(d--) -= 'z' - 'a';
6783 *(d--) -= 'z' - 'a' + 1;
6787 /* oh,oh, the number grew */
6788 SvGROW(sv, SvCUR(sv) + 2);
6790 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6801 Auto-decrement of the value in the SV, doing string to numeric conversion
6802 if necessary. Handles 'get' magic.
6808 Perl_sv_dec(pTHX_ register SV *sv)
6816 if (SvTHINKFIRST(sv)) {
6818 sv_force_normal_flags(sv, 0);
6819 if (SvREADONLY(sv)) {
6820 if (PL_curcop != &PL_compiling)
6821 Perl_croak(aTHX_ PL_no_modify);
6825 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6827 i = PTR2IV(SvRV(sv));
6832 /* Unlike sv_inc we don't have to worry about string-never-numbers
6833 and keeping them magic. But we mustn't warn on punting */
6834 flags = SvFLAGS(sv);
6835 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6836 /* It's publicly an integer, or privately an integer-not-float */
6837 #ifdef PERL_PRESERVE_IVUV
6841 if (SvUVX(sv) == 0) {
6842 (void)SvIOK_only(sv);
6846 (void)SvIOK_only_UV(sv);
6850 if (SvIVX(sv) == IV_MIN)
6851 sv_setnv(sv, (NV)IV_MIN - 1.0);
6853 (void)SvIOK_only(sv);
6859 if (flags & SVp_NOK) {
6861 (void)SvNOK_only(sv);
6864 if (!(flags & SVp_POK)) {
6865 if ((flags & SVTYPEMASK) < SVt_PVNV)
6866 sv_upgrade(sv, SVt_NV);
6868 (void)SvNOK_only(sv);
6871 #ifdef PERL_PRESERVE_IVUV
6873 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6874 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6875 /* Need to try really hard to see if it's an integer.
6876 9.22337203685478e+18 is an integer.
6877 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6878 so $a="9.22337203685478e+18"; $a+0; $a--
6879 needs to be the same as $a="9.22337203685478e+18"; $a--
6886 /* sv_2iv *should* have made this an NV */
6887 if (flags & SVp_NOK) {
6888 (void)SvNOK_only(sv);
6892 /* I don't think we can get here. Maybe I should assert this
6893 And if we do get here I suspect that sv_setnv will croak. NWC
6895 #if defined(USE_LONG_DOUBLE)
6896 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",
6897 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6899 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6900 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6904 #endif /* PERL_PRESERVE_IVUV */
6905 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6909 =for apidoc sv_mortalcopy
6911 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6912 The new SV is marked as mortal. It will be destroyed "soon", either by an
6913 explicit call to FREETMPS, or by an implicit call at places such as
6914 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6919 /* Make a string that will exist for the duration of the expression
6920 * evaluation. Actually, it may have to last longer than that, but
6921 * hopefully we won't free it until it has been assigned to a
6922 * permanent location. */
6925 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6930 sv_setsv(sv,oldstr);
6932 PL_tmps_stack[++PL_tmps_ix] = sv;
6938 =for apidoc sv_newmortal
6940 Creates a new null SV which is mortal. The reference count of the SV is
6941 set to 1. It will be destroyed "soon", either by an explicit call to
6942 FREETMPS, or by an implicit call at places such as statement boundaries.
6943 See also C<sv_mortalcopy> and C<sv_2mortal>.
6949 Perl_sv_newmortal(pTHX)
6954 SvFLAGS(sv) = SVs_TEMP;
6956 PL_tmps_stack[++PL_tmps_ix] = sv;
6961 =for apidoc sv_2mortal
6963 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6964 by an explicit call to FREETMPS, or by an implicit call at places such as
6965 statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
6971 Perl_sv_2mortal(pTHX_ register SV *sv)
6975 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6978 PL_tmps_stack[++PL_tmps_ix] = sv;
6986 Creates a new SV and copies a string into it. The reference count for the
6987 SV is set to 1. If C<len> is zero, Perl will compute the length using
6988 strlen(). For efficiency, consider using C<newSVpvn> instead.
6994 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7001 sv_setpvn(sv,s,len);
7006 =for apidoc newSVpvn
7008 Creates a new SV and copies a string into it. The reference count for the
7009 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7010 string. You are responsible for ensuring that the source string is at least
7017 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7022 sv_setpvn(sv,s,len);
7027 =for apidoc newSVpvn_share
7029 Creates a new SV with its SvPVX pointing to a shared string in the string
7030 table. If the string does not already exist in the table, it is created
7031 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7032 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7033 otherwise the hash is computed. The idea here is that as the string table
7034 is used for shared hash keys these strings will have SvPVX == HeKEY and
7035 hash lookup will avoid string compare.
7041 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7044 bool is_utf8 = FALSE;
7046 STRLEN tmplen = -len;
7048 /* See the note in hv.c:hv_fetch() --jhi */
7049 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
7053 PERL_HASH(hash, src, len);
7055 sv_upgrade(sv, SVt_PVIV);
7056 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
7069 #if defined(PERL_IMPLICIT_CONTEXT)
7071 /* pTHX_ magic can't cope with varargs, so this is a no-context
7072 * version of the main function, (which may itself be aliased to us).
7073 * Don't access this version directly.
7077 Perl_newSVpvf_nocontext(const char* pat, ...)
7082 va_start(args, pat);
7083 sv = vnewSVpvf(pat, &args);
7090 =for apidoc newSVpvf
7092 Creates a new SV and initializes it with the string formatted like
7099 Perl_newSVpvf(pTHX_ const char* pat, ...)
7103 va_start(args, pat);
7104 sv = vnewSVpvf(pat, &args);
7109 /* backend for newSVpvf() and newSVpvf_nocontext() */
7112 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7116 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7123 Creates a new SV and copies a floating point value into it.
7124 The reference count for the SV is set to 1.
7130 Perl_newSVnv(pTHX_ NV n)
7142 Creates a new SV and copies an integer into it. The reference count for the
7149 Perl_newSViv(pTHX_ IV i)
7161 Creates a new SV and copies an unsigned integer into it.
7162 The reference count for the SV is set to 1.
7168 Perl_newSVuv(pTHX_ UV u)
7178 =for apidoc newRV_noinc
7180 Creates an RV wrapper for an SV. The reference count for the original
7181 SV is B<not> incremented.
7187 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7192 sv_upgrade(sv, SVt_RV);
7199 /* newRV_inc is the official function name to use now.
7200 * newRV_inc is in fact #defined to newRV in sv.h
7204 Perl_newRV(pTHX_ SV *tmpRef)
7206 return newRV_noinc(SvREFCNT_inc(tmpRef));
7212 Creates a new SV which is an exact duplicate of the original SV.
7219 Perl_newSVsv(pTHX_ register SV *old)
7225 if (SvTYPE(old) == SVTYPEMASK) {
7226 if (ckWARN_d(WARN_INTERNAL))
7227 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7242 =for apidoc sv_reset
7244 Underlying implementation for the C<reset> Perl function.
7245 Note that the perl-level function is vaguely deprecated.
7251 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7259 char todo[PERL_UCHAR_MAX+1];
7264 if (!*s) { /* reset ?? searches */
7265 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7266 pm->op_pmdynflags &= ~PMdf_USED;
7271 /* reset variables */
7273 if (!HvARRAY(stash))
7276 Zero(todo, 256, char);
7278 i = (unsigned char)*s;
7282 max = (unsigned char)*s++;
7283 for ( ; i <= max; i++) {
7286 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7287 for (entry = HvARRAY(stash)[i];
7289 entry = HeNEXT(entry))
7291 if (!todo[(U8)*HeKEY(entry)])
7293 gv = (GV*)HeVAL(entry);
7295 if (SvTHINKFIRST(sv)) {
7296 if (!SvREADONLY(sv) && SvROK(sv))
7301 if (SvTYPE(sv) >= SVt_PV) {
7303 if (SvPVX(sv) != Nullch)
7310 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7312 #ifdef USE_ENVIRON_ARRAY
7314 # ifdef USE_ITHREADS
7315 && PL_curinterp == aTHX
7319 environ[0] = Nullch;
7331 Using various gambits, try to get an IO from an SV: the IO slot if its a
7332 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7333 named after the PV if we're a string.
7339 Perl_sv_2io(pTHX_ SV *sv)
7345 switch (SvTYPE(sv)) {
7353 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7357 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7359 return sv_2io(SvRV(sv));
7360 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7366 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7375 Using various gambits, try to get a CV from an SV; in addition, try if
7376 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7382 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7389 return *gvp = Nullgv, Nullcv;
7390 switch (SvTYPE(sv)) {
7409 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7410 tryAMAGICunDEREF(to_cv);
7413 if (SvTYPE(sv) == SVt_PVCV) {
7422 Perl_croak(aTHX_ "Not a subroutine reference");
7427 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
7433 if (lref && !GvCVu(gv)) {
7436 tmpsv = NEWSV(704,0);
7437 gv_efullname3(tmpsv, gv, Nullch);
7438 /* XXX this is probably not what they think they're getting.
7439 * It has the same effect as "sub name;", i.e. just a forward
7441 newSUB(start_subparse(FALSE, 0),
7442 newSVOP(OP_CONST, 0, tmpsv),
7447 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7457 Returns true if the SV has a true value by Perl's rules.
7458 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7459 instead use an in-line version.
7465 Perl_sv_true(pTHX_ register SV *sv)
7471 if ((tXpv = (XPV*)SvANY(sv)) &&
7472 (tXpv->xpv_cur > 1 ||
7473 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
7480 return SvIVX(sv) != 0;
7483 return SvNVX(sv) != 0.0;
7485 return sv_2bool(sv);
7493 A private implementation of the C<SvIVx> macro for compilers which can't
7494 cope with complex macro expressions. Always use the macro instead.
7500 Perl_sv_iv(pTHX_ register SV *sv)
7504 return (IV)SvUVX(sv);
7513 A private implementation of the C<SvUVx> macro for compilers which can't
7514 cope with complex macro expressions. Always use the macro instead.
7520 Perl_sv_uv(pTHX_ register SV *sv)
7525 return (UV)SvIVX(sv);
7533 A private implementation of the C<SvNVx> macro for compilers which can't
7534 cope with complex macro expressions. Always use the macro instead.
7540 Perl_sv_nv(pTHX_ register SV *sv)
7547 /* sv_pv() is now a macro using SvPV_nolen();
7548 * this function provided for binary compatibility only
7552 Perl_sv_pv(pTHX_ SV *sv)
7559 return sv_2pv(sv, &n_a);
7565 Use the C<SvPV_nolen> macro instead
7569 A private implementation of the C<SvPV> macro for compilers which can't
7570 cope with complex macro expressions. Always use the macro instead.
7576 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7582 return sv_2pv(sv, lp);
7587 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7593 return sv_2pv_flags(sv, lp, 0);
7596 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7597 * this function provided for binary compatibility only
7601 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7603 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7607 =for apidoc sv_pvn_force
7609 Get a sensible string out of the SV somehow.
7610 A private implementation of the C<SvPV_force> macro for compilers which
7611 can't cope with complex macro expressions. Always use the macro instead.
7613 =for apidoc sv_pvn_force_flags
7615 Get a sensible string out of the SV somehow.
7616 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7617 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7618 implemented in terms of this function.
7619 You normally want to use the various wrapper macros instead: see
7620 C<SvPV_force> and C<SvPV_force_nomg>
7626 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7630 if (SvTHINKFIRST(sv) && !SvROK(sv))
7631 sv_force_normal_flags(sv, 0);
7637 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7638 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7642 s = sv_2pv_flags(sv, lp, flags);
7643 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
7648 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7649 SvGROW(sv, len + 1);
7650 Move(s,SvPVX(sv),len,char);
7655 SvPOK_on(sv); /* validate pointer */
7657 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7658 PTR2UV(sv),SvPVX(sv)));
7664 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7665 * this function provided for binary compatibility only
7669 Perl_sv_pvbyte(pTHX_ SV *sv)
7671 sv_utf8_downgrade(sv,0);
7676 =for apidoc sv_pvbyte
7678 Use C<SvPVbyte_nolen> instead.
7680 =for apidoc sv_pvbyten
7682 A private implementation of the C<SvPVbyte> macro for compilers
7683 which can't cope with complex macro expressions. Always use the macro
7690 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7692 sv_utf8_downgrade(sv,0);
7693 return sv_pvn(sv,lp);
7697 =for apidoc sv_pvbyten_force
7699 A private implementation of the C<SvPVbytex_force> macro for compilers
7700 which can't cope with complex macro expressions. Always use the macro
7707 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7709 sv_utf8_downgrade(sv,0);
7710 return sv_pvn_force(sv,lp);
7713 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
7714 * this function provided for binary compatibility only
7718 Perl_sv_pvutf8(pTHX_ SV *sv)
7720 sv_utf8_upgrade(sv);
7725 =for apidoc sv_pvutf8
7727 Use the C<SvPVutf8_nolen> macro instead
7729 =for apidoc sv_pvutf8n
7731 A private implementation of the C<SvPVutf8> macro for compilers
7732 which can't cope with complex macro expressions. Always use the macro
7739 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7741 sv_utf8_upgrade(sv);
7742 return sv_pvn(sv,lp);
7746 =for apidoc sv_pvutf8n_force
7748 A private implementation of the C<SvPVutf8_force> macro for compilers
7749 which can't cope with complex macro expressions. Always use the macro
7756 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7758 sv_utf8_upgrade(sv);
7759 return sv_pvn_force(sv,lp);
7763 =for apidoc sv_reftype
7765 Returns a string describing what the SV is a reference to.
7771 Perl_sv_reftype(pTHX_ SV *sv, int ob)
7773 if (ob && SvOBJECT(sv)) {
7774 return HvNAME(SvSTASH(sv));
7777 switch (SvTYPE(sv)) {
7793 case SVt_PVLV: return SvROK(sv) ? "REF" : "LVALUE";
7794 case SVt_PVAV: return "ARRAY";
7795 case SVt_PVHV: return "HASH";
7796 case SVt_PVCV: return "CODE";
7797 case SVt_PVGV: return "GLOB";
7798 case SVt_PVFM: return "FORMAT";
7799 case SVt_PVIO: return "IO";
7800 default: return "UNKNOWN";
7806 =for apidoc sv_isobject
7808 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7809 object. If the SV is not an RV, or if the object is not blessed, then this
7816 Perl_sv_isobject(pTHX_ SV *sv)
7833 Returns a boolean indicating whether the SV is blessed into the specified
7834 class. This does not check for subtypes; use C<sv_derived_from> to verify
7835 an inheritance relationship.
7841 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7853 return strEQ(HvNAME(SvSTASH(sv)), name);
7859 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7860 it will be upgraded to one. If C<classname> is non-null then the new SV will
7861 be blessed in the specified package. The new SV is returned and its
7862 reference count is 1.
7868 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7874 SV_CHECK_THINKFIRST_COW_DROP(rv);
7877 if (SvTYPE(rv) >= SVt_PVMG) {
7878 U32 refcnt = SvREFCNT(rv);
7882 SvREFCNT(rv) = refcnt;
7885 if (SvTYPE(rv) < SVt_RV)
7886 sv_upgrade(rv, SVt_RV);
7887 else if (SvTYPE(rv) > SVt_RV) {
7888 (void)SvOOK_off(rv);
7889 if (SvPVX(rv) && SvLEN(rv))
7890 Safefree(SvPVX(rv));
7900 HV* stash = gv_stashpv(classname, TRUE);
7901 (void)sv_bless(rv, stash);
7907 =for apidoc sv_setref_pv
7909 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7910 argument will be upgraded to an RV. That RV will be modified to point to
7911 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7912 into the SV. The C<classname> argument indicates the package for the
7913 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7914 will be returned and will have a reference count of 1.
7916 Do not use with other Perl types such as HV, AV, SV, CV, because those
7917 objects will become corrupted by the pointer copy process.
7919 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7925 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7928 sv_setsv(rv, &PL_sv_undef);
7932 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7937 =for apidoc sv_setref_iv
7939 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7940 argument will be upgraded to an RV. That RV will be modified to point to
7941 the new SV. The C<classname> argument indicates the package for the
7942 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7943 will be returned and will have a reference count of 1.
7949 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7951 sv_setiv(newSVrv(rv,classname), iv);
7956 =for apidoc sv_setref_uv
7958 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7959 argument will be upgraded to an RV. That RV will be modified to point to
7960 the new SV. The C<classname> argument indicates the package for the
7961 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7962 will be returned and will have a reference count of 1.
7968 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7970 sv_setuv(newSVrv(rv,classname), uv);
7975 =for apidoc sv_setref_nv
7977 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7978 argument will be upgraded to an RV. That RV will be modified to point to
7979 the new SV. The C<classname> argument indicates the package for the
7980 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7981 will be returned and will have a reference count of 1.
7987 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7989 sv_setnv(newSVrv(rv,classname), nv);
7994 =for apidoc sv_setref_pvn
7996 Copies a string into a new SV, optionally blessing the SV. The length of the
7997 string must be specified with C<n>. The C<rv> argument will be upgraded to
7998 an RV. That RV will be modified to point to the new SV. The C<classname>
7999 argument indicates the package for the blessing. Set C<classname> to
8000 C<Nullch> to avoid the blessing. The new SV will be returned and will have
8001 a reference count of 1.
8003 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8009 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8011 sv_setpvn(newSVrv(rv,classname), pv, n);
8016 =for apidoc sv_bless
8018 Blesses an SV into a specified package. The SV must be an RV. The package
8019 must be designated by its stash (see C<gv_stashpv()>). The reference count
8020 of the SV is unaffected.
8026 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8030 Perl_croak(aTHX_ "Can't bless non-reference value");
8032 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8033 if (SvREADONLY(tmpRef))
8034 Perl_croak(aTHX_ PL_no_modify);
8035 if (SvOBJECT(tmpRef)) {
8036 if (SvTYPE(tmpRef) != SVt_PVIO)
8038 SvREFCNT_dec(SvSTASH(tmpRef));
8041 SvOBJECT_on(tmpRef);
8042 if (SvTYPE(tmpRef) != SVt_PVIO)
8044 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8045 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
8052 if(SvSMAGICAL(tmpRef))
8053 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8061 /* Downgrades a PVGV to a PVMG.
8065 S_sv_unglob(pTHX_ SV *sv)
8069 assert(SvTYPE(sv) == SVt_PVGV);
8074 SvREFCNT_dec(GvSTASH(sv));
8075 GvSTASH(sv) = Nullhv;
8077 sv_unmagic(sv, PERL_MAGIC_glob);
8078 Safefree(GvNAME(sv));
8081 /* need to keep SvANY(sv) in the right arena */
8082 xpvmg = new_XPVMG();
8083 StructCopy(SvANY(sv), xpvmg, XPVMG);
8084 del_XPVGV(SvANY(sv));
8087 SvFLAGS(sv) &= ~SVTYPEMASK;
8088 SvFLAGS(sv) |= SVt_PVMG;
8092 =for apidoc sv_unref_flags
8094 Unsets the RV status of the SV, and decrements the reference count of
8095 whatever was being referenced by the RV. This can almost be thought of
8096 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8097 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8098 (otherwise the decrementing is conditional on the reference count being
8099 different from one or the reference being a readonly SV).
8106 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8110 if (SvWEAKREF(sv)) {
8118 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8119 assigned to as BEGIN {$a = \"Foo"} will fail. */
8120 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8122 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8123 sv_2mortal(rv); /* Schedule for freeing later */
8127 =for apidoc sv_unref
8129 Unsets the RV status of the SV, and decrements the reference count of
8130 whatever was being referenced by the RV. This can almost be thought of
8131 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8132 being zero. See C<SvROK_off>.
8138 Perl_sv_unref(pTHX_ SV *sv)
8140 sv_unref_flags(sv, 0);
8144 =for apidoc sv_taint
8146 Taint an SV. Use C<SvTAINTED_on> instead.
8151 Perl_sv_taint(pTHX_ SV *sv)
8153 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8157 =for apidoc sv_untaint
8159 Untaint an SV. Use C<SvTAINTED_off> instead.
8164 Perl_sv_untaint(pTHX_ SV *sv)
8166 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8167 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8174 =for apidoc sv_tainted
8176 Test an SV for taintedness. Use C<SvTAINTED> instead.
8181 Perl_sv_tainted(pTHX_ SV *sv)
8183 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8184 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8185 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8192 =for apidoc sv_setpviv
8194 Copies an integer into the given SV, also updating its string value.
8195 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8201 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8203 char buf[TYPE_CHARS(UV)];
8205 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8207 sv_setpvn(sv, ptr, ebuf - ptr);
8211 =for apidoc sv_setpviv_mg
8213 Like C<sv_setpviv>, but also handles 'set' magic.
8219 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8221 char buf[TYPE_CHARS(UV)];
8223 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8225 sv_setpvn(sv, ptr, ebuf - ptr);
8229 #if defined(PERL_IMPLICIT_CONTEXT)
8231 /* pTHX_ magic can't cope with varargs, so this is a no-context
8232 * version of the main function, (which may itself be aliased to us).
8233 * Don't access this version directly.
8237 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8241 va_start(args, pat);
8242 sv_vsetpvf(sv, pat, &args);
8246 /* pTHX_ magic can't cope with varargs, so this is a no-context
8247 * version of the main function, (which may itself be aliased to us).
8248 * Don't access this version directly.
8252 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8256 va_start(args, pat);
8257 sv_vsetpvf_mg(sv, pat, &args);
8263 =for apidoc sv_setpvf
8265 Processes its arguments like C<sprintf> and sets an SV to the formatted
8266 output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8272 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8275 va_start(args, pat);
8276 sv_vsetpvf(sv, pat, &args);
8280 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8283 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8285 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8289 =for apidoc sv_setpvf_mg
8291 Like C<sv_setpvf>, but also handles 'set' magic.
8297 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8300 va_start(args, pat);
8301 sv_vsetpvf_mg(sv, pat, &args);
8305 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8308 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8310 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8314 #if defined(PERL_IMPLICIT_CONTEXT)
8316 /* pTHX_ magic can't cope with varargs, so this is a no-context
8317 * version of the main function, (which may itself be aliased to us).
8318 * Don't access this version directly.
8322 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8326 va_start(args, pat);
8327 sv_vcatpvf(sv, pat, &args);
8331 /* pTHX_ magic can't cope with varargs, so this is a no-context
8332 * version of the main function, (which may itself be aliased to us).
8333 * Don't access this version directly.
8337 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8341 va_start(args, pat);
8342 sv_vcatpvf_mg(sv, pat, &args);
8348 =for apidoc sv_catpvf
8350 Processes its arguments like C<sprintf> and appends the formatted
8351 output to an SV. If the appended data contains "wide" characters
8352 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8353 and characters >255 formatted with %c), the original SV might get
8354 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8355 C<SvSETMAGIC()> must typically be called after calling this function
8356 to handle 'set' magic.
8361 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8364 va_start(args, pat);
8365 sv_vcatpvf(sv, pat, &args);
8369 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8372 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8374 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8378 =for apidoc sv_catpvf_mg
8380 Like C<sv_catpvf>, but also handles 'set' magic.
8386 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8389 va_start(args, pat);
8390 sv_vcatpvf_mg(sv, pat, &args);
8394 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
8397 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8399 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8404 =for apidoc sv_vsetpvfn
8406 Works like C<vcatpvfn> but copies the text into the SV instead of
8409 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
8415 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8417 sv_setpvn(sv, "", 0);
8418 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8421 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8424 S_expect_number(pTHX_ char** pattern)
8427 switch (**pattern) {
8428 case '1': case '2': case '3':
8429 case '4': case '5': case '6':
8430 case '7': case '8': case '9':
8431 while (isDIGIT(**pattern))
8432 var = var * 10 + (*(*pattern)++ - '0');
8436 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8439 =for apidoc sv_vcatpvfn
8441 Processes its arguments like C<vsprintf> and appends the formatted output
8442 to an SV. Uses an array of SVs if the C style variable argument list is
8443 missing (NULL). When running with taint checks enabled, indicates via
8444 C<maybe_tainted> if results are untrustworthy (often due to the use of
8447 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
8453 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8460 static char nullstr[] = "(null)";
8462 bool has_utf8; /* has the result utf8? */
8463 bool pat_utf8; /* the pattern is in utf8? */
8466 has_utf8 = pat_utf8 = DO_UTF8(sv);
8468 /* no matter what, this is a string now */
8469 (void)SvPV_force(sv, origlen);
8471 /* special-case "", "%s", and "%_" */
8474 if (patlen == 2 && pat[0] == '%') {
8478 char *s = va_arg(*args, char*);
8479 sv_catpv(sv, s ? s : nullstr);
8481 else if (svix < svmax) {
8482 sv_catsv(sv, *svargs);
8483 if (DO_UTF8(*svargs))
8489 argsv = va_arg(*args, SV*);
8490 sv_catsv(sv, argsv);
8495 /* See comment on '_' below */
8500 if (!args && svix < svmax && DO_UTF8(*svargs))
8503 patend = (char*)pat + patlen;
8504 for (p = (char*)pat; p < patend; p = q) {
8507 bool vectorize = FALSE;
8508 bool vectorarg = FALSE;
8509 bool vec_utf8 = FALSE;
8515 bool has_precis = FALSE;
8518 bool is_utf8 = FALSE; /* is this item utf8? */
8519 #ifdef HAS_LDBL_SPRINTF_BUG
8520 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8521 with sfio - Allen <allens@cpan.org> */
8522 bool fix_ldbl_sprintf_bug = FALSE;
8526 U8 utf8buf[UTF8_MAXLEN+1];
8527 STRLEN esignlen = 0;
8529 char *eptr = Nullch;
8531 /* Times 4: a decimal digit takes more than 3 binary digits.
8532 * NV_DIG: mantissa takes than many decimal digits.
8533 * Plus 32: Playing safe. */
8534 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8535 /* large enough for "%#.#f" --chip */
8536 /* what about long double NVs? --jhi */
8539 U8 *vecstr = Null(U8*);
8546 /* we need a long double target in case HAS_LONG_DOUBLE but
8549 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8558 STRLEN dotstrlen = 1;
8559 I32 efix = 0; /* explicit format parameter index */
8560 I32 ewix = 0; /* explicit width index */
8561 I32 epix = 0; /* explicit precision index */
8562 I32 evix = 0; /* explicit vector index */
8563 bool asterisk = FALSE;
8565 /* echo everything up to the next format specification */
8566 for (q = p; q < patend && *q != '%'; ++q) ;
8568 if (has_utf8 && !pat_utf8)
8569 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8571 sv_catpvn(sv, p, q - p);
8578 We allow format specification elements in this order:
8579 \d+\$ explicit format parameter index
8581 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8582 0 flag (as above): repeated to allow "v02"
8583 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8584 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8586 [%bcdefginopsux_DFOUX] format (mandatory)
8588 if (EXPECT_NUMBER(q, width)) {
8629 if (EXPECT_NUMBER(q, ewix))
8638 if ((vectorarg = asterisk)) {
8650 EXPECT_NUMBER(q, width);
8655 vecsv = va_arg(*args, SV*);
8657 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8658 svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
8659 dotstr = SvPVx(vecsv, dotstrlen);
8664 vecsv = va_arg(*args, SV*);
8665 vecstr = (U8*)SvPVx(vecsv,veclen);
8666 vec_utf8 = DO_UTF8(vecsv);
8668 else if (efix ? efix <= svmax : svix < svmax) {
8669 vecsv = svargs[efix ? efix-1 : svix++];
8670 vecstr = (U8*)SvPVx(vecsv,veclen);
8671 vec_utf8 = DO_UTF8(vecsv);
8681 i = va_arg(*args, int);
8683 i = (ewix ? ewix <= svmax : svix < svmax) ?
8684 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8686 width = (i < 0) ? -i : i;
8696 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8698 /* XXX: todo, support specified precision parameter */
8702 i = va_arg(*args, int);
8704 i = (ewix ? ewix <= svmax : svix < svmax)
8705 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8706 precis = (i < 0) ? 0 : i;
8711 precis = precis * 10 + (*q++ - '0');
8720 case 'I': /* Ix, I32x, and I64x */
8722 if (q[1] == '6' && q[2] == '4') {
8728 if (q[1] == '3' && q[2] == '2') {
8738 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8749 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8750 if (*(q + 1) == 'l') { /* lld, llf */
8775 argsv = (efix ? efix <= svmax : svix < svmax) ?
8776 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8783 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8785 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8787 eptr = (char*)utf8buf;
8788 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8799 if (args && !vectorize) {
8800 eptr = va_arg(*args, char*);
8802 #ifdef MACOS_TRADITIONAL
8803 /* On MacOS, %#s format is used for Pascal strings */
8808 elen = strlen(eptr);
8811 elen = sizeof nullstr - 1;
8815 eptr = SvPVx(argsv, elen);
8816 if (DO_UTF8(argsv)) {
8817 if (has_precis && precis < elen) {
8819 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8822 if (width) { /* fudge width (can't fudge elen) */
8823 width += elen - sv_len_utf8(argsv);
8832 * The "%_" hack might have to be changed someday,
8833 * if ISO or ANSI decide to use '_' for something.
8834 * So we keep it hidden from users' code.
8836 if (!args || vectorize)
8838 argsv = va_arg(*args, SV*);
8839 eptr = SvPVx(argsv, elen);
8845 if (has_precis && elen > precis)
8852 if (alt || vectorize)
8854 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8872 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8881 esignbuf[esignlen++] = plus;
8885 case 'h': iv = (short)va_arg(*args, int); break;
8886 default: iv = va_arg(*args, int); break;
8887 case 'l': iv = va_arg(*args, long); break;
8888 case 'V': iv = va_arg(*args, IV); break;
8890 case 'q': iv = va_arg(*args, Quad_t); break;
8897 case 'h': iv = (short)iv; break;
8899 case 'l': iv = (long)iv; break;
8902 case 'q': iv = (Quad_t)iv; break;
8906 if ( !vectorize ) /* we already set uv above */
8911 esignbuf[esignlen++] = plus;
8915 esignbuf[esignlen++] = '-';
8958 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8969 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8970 default: uv = va_arg(*args, unsigned); break;
8971 case 'l': uv = va_arg(*args, unsigned long); break;
8972 case 'V': uv = va_arg(*args, UV); break;
8974 case 'q': uv = va_arg(*args, Quad_t); break;
8981 case 'h': uv = (unsigned short)uv; break;
8983 case 'l': uv = (unsigned long)uv; break;
8986 case 'q': uv = (Quad_t)uv; break;
8992 eptr = ebuf + sizeof ebuf;
8998 p = (char*)((c == 'X')
8999 ? "0123456789ABCDEF" : "0123456789abcdef");
9005 esignbuf[esignlen++] = '0';
9006 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9012 *--eptr = '0' + dig;
9014 if (alt && *eptr != '0')
9020 *--eptr = '0' + dig;
9023 esignbuf[esignlen++] = '0';
9024 esignbuf[esignlen++] = 'b';
9027 default: /* it had better be ten or less */
9028 #if defined(PERL_Y2KWARN)
9029 if (ckWARN(WARN_Y2K)) {
9031 char *s = SvPV(sv,n);
9032 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9033 && (n == 2 || !isDIGIT(s[n-3])))
9035 Perl_warner(aTHX_ packWARN(WARN_Y2K),
9036 "Possible Y2K bug: %%%c %s",
9037 c, "format string following '19'");
9043 *--eptr = '0' + dig;
9044 } while (uv /= base);
9047 elen = (ebuf + sizeof ebuf) - eptr;
9050 zeros = precis - elen;
9051 else if (precis == 0 && elen == 1 && *eptr == '0')
9056 /* FLOATING POINT */
9059 c = 'f'; /* maybe %F isn't supported here */
9065 /* This is evil, but floating point is even more evil */
9067 /* for SV-style calling, we can only get NV
9068 for C-style calling, we assume %f is double;
9069 for simplicity we allow any of %Lf, %llf, %qf for long double
9073 #if defined(USE_LONG_DOUBLE)
9077 /* [perl #20339] - we should accept and ignore %lf rather than die */
9081 #if defined(USE_LONG_DOUBLE)
9082 intsize = args ? 0 : 'q';
9086 #if defined(HAS_LONG_DOUBLE)
9095 /* now we need (long double) if intsize == 'q', else (double) */
9096 nv = (args && !vectorize) ?
9097 #if LONG_DOUBLESIZE > DOUBLESIZE
9099 va_arg(*args, long double) :
9100 va_arg(*args, double)
9102 va_arg(*args, double)
9108 if (c != 'e' && c != 'E') {
9110 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9111 will cast our (long double) to (double) */
9112 (void)Perl_frexp(nv, &i);
9113 if (i == PERL_INT_MIN)
9114 Perl_die(aTHX_ "panic: frexp");
9116 need = BIT_DIGITS(i);
9118 need += has_precis ? precis : 6; /* known default */
9123 #ifdef HAS_LDBL_SPRINTF_BUG
9124 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9125 with sfio - Allen <allens@cpan.org> */
9128 # define MY_DBL_MAX DBL_MAX
9129 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9130 # if DOUBLESIZE >= 8
9131 # define MY_DBL_MAX 1.7976931348623157E+308L
9133 # define MY_DBL_MAX 3.40282347E+38L
9137 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9138 # define MY_DBL_MAX_BUG 1L
9140 # define MY_DBL_MAX_BUG MY_DBL_MAX
9144 # define MY_DBL_MIN DBL_MIN
9145 # else /* XXX guessing! -Allen */
9146 # if DOUBLESIZE >= 8
9147 # define MY_DBL_MIN 2.2250738585072014E-308L
9149 # define MY_DBL_MIN 1.17549435E-38L
9153 if ((intsize == 'q') && (c == 'f') &&
9154 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9156 /* it's going to be short enough that
9157 * long double precision is not needed */
9159 if ((nv <= 0L) && (nv >= -0L))
9160 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9162 /* would use Perl_fp_class as a double-check but not
9163 * functional on IRIX - see perl.h comments */
9165 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9166 /* It's within the range that a double can represent */
9167 #if defined(DBL_MAX) && !defined(DBL_MIN)
9168 if ((nv >= ((long double)1/DBL_MAX)) ||
9169 (nv <= (-(long double)1/DBL_MAX)))
9171 fix_ldbl_sprintf_bug = TRUE;
9174 if (fix_ldbl_sprintf_bug == TRUE) {
9184 # undef MY_DBL_MAX_BUG
9187 #endif /* HAS_LDBL_SPRINTF_BUG */
9189 need += 20; /* fudge factor */
9190 if (PL_efloatsize < need) {
9191 Safefree(PL_efloatbuf);
9192 PL_efloatsize = need + 20; /* more fudge */
9193 New(906, PL_efloatbuf, PL_efloatsize, char);
9194 PL_efloatbuf[0] = '\0';
9197 eptr = ebuf + sizeof ebuf;
9200 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9201 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9202 if (intsize == 'q') {
9203 /* Copy the one or more characters in a long double
9204 * format before the 'base' ([efgEFG]) character to
9205 * the format string. */
9206 static char const prifldbl[] = PERL_PRIfldbl;
9207 char const *p = prifldbl + sizeof(prifldbl) - 3;
9208 while (p >= prifldbl) { *--eptr = *p--; }
9213 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9218 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9230 /* No taint. Otherwise we are in the strange situation
9231 * where printf() taints but print($float) doesn't.
9233 #if defined(HAS_LONG_DOUBLE)
9235 (void)sprintf(PL_efloatbuf, eptr, nv);
9237 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9239 (void)sprintf(PL_efloatbuf, eptr, nv);
9241 eptr = PL_efloatbuf;
9242 elen = strlen(PL_efloatbuf);
9248 i = SvCUR(sv) - origlen;
9249 if (args && !vectorize) {
9251 case 'h': *(va_arg(*args, short*)) = i; break;
9252 default: *(va_arg(*args, int*)) = i; break;
9253 case 'l': *(va_arg(*args, long*)) = i; break;
9254 case 'V': *(va_arg(*args, IV*)) = i; break;
9256 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9261 sv_setuv_mg(argsv, (UV)i);
9263 continue; /* not "break" */
9269 if (!args && ckWARN(WARN_PRINTF) &&
9270 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9271 SV *msg = sv_newmortal();
9272 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9273 (PL_op->op_type == OP_PRTF) ? "" : "s");
9276 Perl_sv_catpvf(aTHX_ msg,
9277 "\"%%%c\"", c & 0xFF);
9279 Perl_sv_catpvf(aTHX_ msg,
9280 "\"%%\\%03"UVof"\"",
9283 sv_catpv(msg, "end of string");
9284 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9287 /* output mangled stuff ... */
9293 /* ... right here, because formatting flags should not apply */
9294 SvGROW(sv, SvCUR(sv) + elen + 1);
9296 Copy(eptr, p, elen, char);
9299 SvCUR(sv) = p - SvPVX(sv);
9301 continue; /* not "break" */
9304 if (is_utf8 != has_utf8) {
9307 sv_utf8_upgrade(sv);
9310 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9311 sv_utf8_upgrade(nsv);
9315 SvGROW(sv, SvCUR(sv) + elen + 1);
9320 have = esignlen + zeros + elen;
9321 need = (have > width ? have : width);
9324 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9326 if (esignlen && fill == '0') {
9327 for (i = 0; i < (int)esignlen; i++)
9331 memset(p, fill, gap);
9334 if (esignlen && fill != '0') {
9335 for (i = 0; i < (int)esignlen; i++)
9339 for (i = zeros; i; i--)
9343 Copy(eptr, p, elen, char);
9347 memset(p, ' ', gap);
9352 Copy(dotstr, p, dotstrlen, char);
9356 vectorize = FALSE; /* done iterating over vecstr */
9363 SvCUR(sv) = p - SvPVX(sv);
9371 /* =========================================================================
9373 =head1 Cloning an interpreter
9375 All the macros and functions in this section are for the private use of
9376 the main function, perl_clone().
9378 The foo_dup() functions make an exact copy of an existing foo thinngy.
9379 During the course of a cloning, a hash table is used to map old addresses
9380 to new addresses. The table is created and manipulated with the
9381 ptr_table_* functions.
9385 ============================================================================*/
9388 #if defined(USE_ITHREADS)
9390 #ifndef GpREFCNT_inc
9391 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9395 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9396 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9397 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9398 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9399 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9400 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9401 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9402 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9403 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9404 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9405 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9406 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9407 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9410 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9411 regcomp.c. AMS 20010712 */
9414 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
9418 struct reg_substr_datum *s;
9421 return (REGEXP *)NULL;
9423 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9426 len = r->offsets[0];
9427 npar = r->nparens+1;
9429 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9430 Copy(r->program, ret->program, len+1, regnode);
9432 New(0, ret->startp, npar, I32);
9433 Copy(r->startp, ret->startp, npar, I32);
9434 New(0, ret->endp, npar, I32);
9435 Copy(r->startp, ret->startp, npar, I32);
9437 New(0, ret->substrs, 1, struct reg_substr_data);
9438 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9439 s->min_offset = r->substrs->data[i].min_offset;
9440 s->max_offset = r->substrs->data[i].max_offset;
9441 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9442 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9445 ret->regstclass = NULL;
9448 int count = r->data->count;
9450 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9451 char, struct reg_data);
9452 New(0, d->what, count, U8);
9455 for (i = 0; i < count; i++) {
9456 d->what[i] = r->data->what[i];
9457 switch (d->what[i]) {
9459 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9462 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9465 /* This is cheating. */
9466 New(0, d->data[i], 1, struct regnode_charclass_class);
9467 StructCopy(r->data->data[i], d->data[i],
9468 struct regnode_charclass_class);
9469 ret->regstclass = (regnode*)d->data[i];
9472 /* Compiled op trees are readonly, and can thus be
9473 shared without duplication. */
9474 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9477 d->data[i] = r->data->data[i];
9487 New(0, ret->offsets, 2*len+1, U32);
9488 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9490 ret->precomp = SAVEPV(r->precomp);
9491 ret->refcnt = r->refcnt;
9492 ret->minlen = r->minlen;
9493 ret->prelen = r->prelen;
9494 ret->nparens = r->nparens;
9495 ret->lastparen = r->lastparen;
9496 ret->lastcloseparen = r->lastcloseparen;
9497 ret->reganch = r->reganch;
9499 ret->sublen = r->sublen;
9501 if (RX_MATCH_COPIED(ret))
9502 ret->subbeg = SAVEPV(r->subbeg);
9504 ret->subbeg = Nullch;
9505 #ifdef PERL_COPY_ON_WRITE
9506 ret->saved_copy = Nullsv;
9509 ptr_table_store(PL_ptr_table, r, ret);
9513 /* duplicate a file handle */
9516 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9520 return (PerlIO*)NULL;
9522 /* look for it in the table first */
9523 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9527 /* create anew and remember what it is */
9528 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9529 ptr_table_store(PL_ptr_table, fp, ret);
9533 /* duplicate a directory handle */
9536 Perl_dirp_dup(pTHX_ DIR *dp)
9544 /* duplicate a typeglob */
9547 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9552 /* look for it in the table first */
9553 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9557 /* create anew and remember what it is */
9558 Newz(0, ret, 1, GP);
9559 ptr_table_store(PL_ptr_table, gp, ret);
9562 ret->gp_refcnt = 0; /* must be before any other dups! */
9563 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9564 ret->gp_io = io_dup_inc(gp->gp_io, param);
9565 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9566 ret->gp_av = av_dup_inc(gp->gp_av, param);
9567 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9568 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9569 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9570 ret->gp_cvgen = gp->gp_cvgen;
9571 ret->gp_flags = gp->gp_flags;
9572 ret->gp_line = gp->gp_line;
9573 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9577 /* duplicate a chain of magic */
9580 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9582 MAGIC *mgprev = (MAGIC*)NULL;
9585 return (MAGIC*)NULL;
9586 /* look for it in the table first */
9587 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9591 for (; mg; mg = mg->mg_moremagic) {
9593 Newz(0, nmg, 1, MAGIC);
9595 mgprev->mg_moremagic = nmg;
9598 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9599 nmg->mg_private = mg->mg_private;
9600 nmg->mg_type = mg->mg_type;
9601 nmg->mg_flags = mg->mg_flags;
9602 if (mg->mg_type == PERL_MAGIC_qr) {
9603 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9605 else if(mg->mg_type == PERL_MAGIC_backref) {
9606 AV *av = (AV*) mg->mg_obj;
9609 nmg->mg_obj = (SV*)newAV();
9613 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9618 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9619 ? sv_dup_inc(mg->mg_obj, param)
9620 : sv_dup(mg->mg_obj, param);
9622 nmg->mg_len = mg->mg_len;
9623 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9624 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9625 if (mg->mg_len > 0) {
9626 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9627 if (mg->mg_type == PERL_MAGIC_overload_table &&
9628 AMT_AMAGIC((AMT*)mg->mg_ptr))
9630 AMT *amtp = (AMT*)mg->mg_ptr;
9631 AMT *namtp = (AMT*)nmg->mg_ptr;
9633 for (i = 1; i < NofAMmeth; i++) {
9634 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9638 else if (mg->mg_len == HEf_SVKEY)
9639 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9641 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9642 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9649 /* create a new pointer-mapping table */
9652 Perl_ptr_table_new(pTHX)
9655 Newz(0, tbl, 1, PTR_TBL_t);
9658 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9662 /* map an existing pointer using a table */
9665 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
9667 PTR_TBL_ENT_t *tblent;
9668 UV hash = PTR2UV(sv);
9670 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9671 for (; tblent; tblent = tblent->next) {
9672 if (tblent->oldval == sv)
9673 return tblent->newval;
9678 /* add a new entry to a pointer-mapping table */
9681 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
9683 PTR_TBL_ENT_t *tblent, **otblent;
9684 /* XXX this may be pessimal on platforms where pointers aren't good
9685 * hash values e.g. if they grow faster in the most significant
9687 UV hash = PTR2UV(oldv);
9691 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9692 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
9693 if (tblent->oldval == oldv) {
9694 tblent->newval = newv;
9698 Newz(0, tblent, 1, PTR_TBL_ENT_t);
9699 tblent->oldval = oldv;
9700 tblent->newval = newv;
9701 tblent->next = *otblent;
9704 if (i && tbl->tbl_items > tbl->tbl_max)
9705 ptr_table_split(tbl);
9708 /* double the hash bucket size of an existing ptr table */
9711 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9713 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9714 UV oldsize = tbl->tbl_max + 1;
9715 UV newsize = oldsize * 2;
9718 Renew(ary, newsize, PTR_TBL_ENT_t*);
9719 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9720 tbl->tbl_max = --newsize;
9722 for (i=0; i < oldsize; i++, ary++) {
9723 PTR_TBL_ENT_t **curentp, **entp, *ent;
9726 curentp = ary + oldsize;
9727 for (entp = ary, ent = *ary; ent; ent = *entp) {
9728 if ((newsize & PTR2UV(ent->oldval)) != i) {
9730 ent->next = *curentp;
9740 /* remove all the entries from a ptr table */
9743 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9745 register PTR_TBL_ENT_t **array;
9746 register PTR_TBL_ENT_t *entry;
9747 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
9751 if (!tbl || !tbl->tbl_items) {
9755 array = tbl->tbl_ary;
9762 entry = entry->next;
9766 if (++riter > max) {
9769 entry = array[riter];
9776 /* clear and free a ptr table */
9779 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9784 ptr_table_clear(tbl);
9785 Safefree(tbl->tbl_ary);
9793 /* attempt to make everything in the typeglob readonly */
9796 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
9799 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
9801 if (GvIO(gv) || GvFORM(gv)) {
9802 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
9804 else if (!GvCV(gv)) {
9808 /* CvPADLISTs cannot be shared */
9809 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
9814 if (!GvUNIQUE(gv)) {
9816 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
9817 HvNAME(GvSTASH(gv)), GvNAME(gv));
9823 * write attempts will die with
9824 * "Modification of a read-only value attempted"
9830 SvREADONLY_on(GvSV(gv));
9837 SvREADONLY_on(GvAV(gv));
9844 SvREADONLY_on(GvAV(gv));
9847 return sstr; /* he_dup() will SvREFCNT_inc() */
9850 /* duplicate an SV of any type (including AV, HV etc) */
9853 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9856 SvRV(dstr) = SvWEAKREF(sstr)
9857 ? sv_dup(SvRV(sstr), param)
9858 : sv_dup_inc(SvRV(sstr), param);
9860 else if (SvPVX(sstr)) {
9861 /* Has something there */
9863 /* Normal PV - clone whole allocated space */
9864 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9865 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9866 /* Not that normal - actually sstr is copy on write.
9867 But we are a true, independant SV, so: */
9868 SvREADONLY_off(dstr);
9873 /* Special case - not normally malloced for some reason */
9874 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9875 /* A "shared" PV - clone it as unshared string */
9876 if(SvPADTMP(sstr)) {
9877 /* However, some of them live in the pad
9878 and they should not have these flags
9881 SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
9883 SvUVX(dstr) = SvUVX(sstr);
9886 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
9888 SvREADONLY_off(dstr);
9892 /* Some other special case - random pointer */
9893 SvPVX(dstr) = SvPVX(sstr);
9899 SvPVX(dstr) = SvPVX(sstr);
9904 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9908 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9910 /* look for it in the table first */
9911 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9915 if(param->flags & CLONEf_JOIN_IN) {
9916 /** We are joining here so we don't want do clone
9917 something that is bad **/
9919 if(SvTYPE(sstr) == SVt_PVHV &&
9921 /** don't clone stashes if they already exist **/
9922 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
9923 return (SV*) old_stash;
9927 /* create anew and remember what it is */
9929 ptr_table_store(PL_ptr_table, sstr, dstr);
9932 SvFLAGS(dstr) = SvFLAGS(sstr);
9933 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9934 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9937 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
9938 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9939 PL_watch_pvx, SvPVX(sstr));
9942 switch (SvTYPE(sstr)) {
9947 SvANY(dstr) = new_XIV();
9948 SvIVX(dstr) = SvIVX(sstr);
9951 SvANY(dstr) = new_XNV();
9952 SvNVX(dstr) = SvNVX(sstr);
9955 SvANY(dstr) = new_XRV();
9956 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9959 SvANY(dstr) = new_XPV();
9960 SvCUR(dstr) = SvCUR(sstr);
9961 SvLEN(dstr) = SvLEN(sstr);
9962 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9965 SvANY(dstr) = new_XPVIV();
9966 SvCUR(dstr) = SvCUR(sstr);
9967 SvLEN(dstr) = SvLEN(sstr);
9968 SvIVX(dstr) = SvIVX(sstr);
9969 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9972 SvANY(dstr) = new_XPVNV();
9973 SvCUR(dstr) = SvCUR(sstr);
9974 SvLEN(dstr) = SvLEN(sstr);
9975 SvIVX(dstr) = SvIVX(sstr);
9976 SvNVX(dstr) = SvNVX(sstr);
9977 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9980 SvANY(dstr) = new_XPVMG();
9981 SvCUR(dstr) = SvCUR(sstr);
9982 SvLEN(dstr) = SvLEN(sstr);
9983 SvIVX(dstr) = SvIVX(sstr);
9984 SvNVX(dstr) = SvNVX(sstr);
9985 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9986 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9987 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9990 SvANY(dstr) = new_XPVBM();
9991 SvCUR(dstr) = SvCUR(sstr);
9992 SvLEN(dstr) = SvLEN(sstr);
9993 SvIVX(dstr) = SvIVX(sstr);
9994 SvNVX(dstr) = SvNVX(sstr);
9995 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9996 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9997 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9998 BmRARE(dstr) = BmRARE(sstr);
9999 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10000 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10003 SvANY(dstr) = new_XPVLV();
10004 SvCUR(dstr) = SvCUR(sstr);
10005 SvLEN(dstr) = SvLEN(sstr);
10006 SvIVX(dstr) = SvIVX(sstr);
10007 SvNVX(dstr) = SvNVX(sstr);
10008 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10009 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10010 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10011 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10012 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10013 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10014 LvTARG(dstr) = dstr;
10015 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10016 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10018 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10019 LvTYPE(dstr) = LvTYPE(sstr);
10022 if (GvUNIQUE((GV*)sstr)) {
10024 if ((share = gv_share(sstr, param))) {
10027 ptr_table_store(PL_ptr_table, sstr, dstr);
10029 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10030 HvNAME(GvSTASH(share)), GvNAME(share));
10035 SvANY(dstr) = new_XPVGV();
10036 SvCUR(dstr) = SvCUR(sstr);
10037 SvLEN(dstr) = SvLEN(sstr);
10038 SvIVX(dstr) = SvIVX(sstr);
10039 SvNVX(dstr) = SvNVX(sstr);
10040 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10041 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10042 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10043 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10044 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10045 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10046 GvFLAGS(dstr) = GvFLAGS(sstr);
10047 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10048 (void)GpREFCNT_inc(GvGP(dstr));
10051 SvANY(dstr) = new_XPVIO();
10052 SvCUR(dstr) = SvCUR(sstr);
10053 SvLEN(dstr) = SvLEN(sstr);
10054 SvIVX(dstr) = SvIVX(sstr);
10055 SvNVX(dstr) = SvNVX(sstr);
10056 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10057 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10058 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10059 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10060 if (IoOFP(sstr) == IoIFP(sstr))
10061 IoOFP(dstr) = IoIFP(dstr);
10063 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10064 /* PL_rsfp_filters entries have fake IoDIRP() */
10065 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10066 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10068 IoDIRP(dstr) = IoDIRP(sstr);
10069 IoLINES(dstr) = IoLINES(sstr);
10070 IoPAGE(dstr) = IoPAGE(sstr);
10071 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10072 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10073 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10074 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10075 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10076 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10077 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10078 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10079 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10080 IoTYPE(dstr) = IoTYPE(sstr);
10081 IoFLAGS(dstr) = IoFLAGS(sstr);
10084 SvANY(dstr) = new_XPVAV();
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 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10092 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10093 if (AvARRAY((AV*)sstr)) {
10094 SV **dst_ary, **src_ary;
10095 SSize_t items = AvFILLp((AV*)sstr) + 1;
10097 src_ary = AvARRAY((AV*)sstr);
10098 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10099 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10100 SvPVX(dstr) = (char*)dst_ary;
10101 AvALLOC((AV*)dstr) = dst_ary;
10102 if (AvREAL((AV*)sstr)) {
10103 while (items-- > 0)
10104 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10107 while (items-- > 0)
10108 *dst_ary++ = sv_dup(*src_ary++, param);
10110 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10111 while (items-- > 0) {
10112 *dst_ary++ = &PL_sv_undef;
10116 SvPVX(dstr) = Nullch;
10117 AvALLOC((AV*)dstr) = (SV**)NULL;
10121 SvANY(dstr) = new_XPVHV();
10122 SvCUR(dstr) = SvCUR(sstr);
10123 SvLEN(dstr) = SvLEN(sstr);
10124 SvIVX(dstr) = SvIVX(sstr);
10125 SvNVX(dstr) = SvNVX(sstr);
10126 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10127 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10128 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
10129 if (HvARRAY((HV*)sstr)) {
10131 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10132 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10133 Newz(0, dxhv->xhv_array,
10134 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10135 while (i <= sxhv->xhv_max) {
10136 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10137 (bool)!!HvSHAREKEYS(sstr),
10141 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10142 (bool)!!HvSHAREKEYS(sstr), param);
10145 SvPVX(dstr) = Nullch;
10146 HvEITER((HV*)dstr) = (HE*)NULL;
10148 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
10149 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
10150 /* Record stashes for possible cloning in Perl_clone(). */
10151 if(HvNAME((HV*)dstr))
10152 av_push(param->stashes, dstr);
10155 SvANY(dstr) = new_XPVFM();
10156 FmLINES(dstr) = FmLINES(sstr);
10160 SvANY(dstr) = new_XPVCV();
10162 SvCUR(dstr) = SvCUR(sstr);
10163 SvLEN(dstr) = SvLEN(sstr);
10164 SvIVX(dstr) = SvIVX(sstr);
10165 SvNVX(dstr) = SvNVX(sstr);
10166 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10167 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10168 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10169 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10170 CvSTART(dstr) = CvSTART(sstr);
10171 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10172 CvXSUB(dstr) = CvXSUB(sstr);
10173 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10174 if (CvCONST(sstr)) {
10175 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10176 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10177 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10179 CvGV(dstr) = gv_dup(CvGV(sstr), param);
10180 if (param->flags & CLONEf_COPY_STACKS) {
10181 CvDEPTH(dstr) = CvDEPTH(sstr);
10185 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10186 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10188 CvWEAKOUTSIDE(sstr)
10189 ? cv_dup( CvOUTSIDE(sstr), param)
10190 : cv_dup_inc(CvOUTSIDE(sstr), param);
10191 CvFLAGS(dstr) = CvFLAGS(sstr);
10192 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10195 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10199 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10205 /* duplicate a context */
10208 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10210 PERL_CONTEXT *ncxs;
10213 return (PERL_CONTEXT*)NULL;
10215 /* look for it in the table first */
10216 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10220 /* create anew and remember what it is */
10221 Newz(56, ncxs, max + 1, PERL_CONTEXT);
10222 ptr_table_store(PL_ptr_table, cxs, ncxs);
10225 PERL_CONTEXT *cx = &cxs[ix];
10226 PERL_CONTEXT *ncx = &ncxs[ix];
10227 ncx->cx_type = cx->cx_type;
10228 if (CxTYPE(cx) == CXt_SUBST) {
10229 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10232 ncx->blk_oldsp = cx->blk_oldsp;
10233 ncx->blk_oldcop = cx->blk_oldcop;
10234 ncx->blk_oldretsp = cx->blk_oldretsp;
10235 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10236 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10237 ncx->blk_oldpm = cx->blk_oldpm;
10238 ncx->blk_gimme = cx->blk_gimme;
10239 switch (CxTYPE(cx)) {
10241 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10242 ? cv_dup_inc(cx->blk_sub.cv, param)
10243 : cv_dup(cx->blk_sub.cv,param));
10244 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10245 ? av_dup_inc(cx->blk_sub.argarray, param)
10247 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10248 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10249 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10250 ncx->blk_sub.lval = cx->blk_sub.lval;
10253 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10254 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10255 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10256 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10257 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10260 ncx->blk_loop.label = cx->blk_loop.label;
10261 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10262 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10263 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10264 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10265 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10266 ? cx->blk_loop.iterdata
10267 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10268 ncx->blk_loop.oldcomppad
10269 = (PAD*)ptr_table_fetch(PL_ptr_table,
10270 cx->blk_loop.oldcomppad);
10271 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10272 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10273 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10274 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10275 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10278 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10279 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10280 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10281 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10293 /* duplicate a stack info structure */
10296 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10301 return (PERL_SI*)NULL;
10303 /* look for it in the table first */
10304 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10308 /* create anew and remember what it is */
10309 Newz(56, nsi, 1, PERL_SI);
10310 ptr_table_store(PL_ptr_table, si, nsi);
10312 nsi->si_stack = av_dup_inc(si->si_stack, param);
10313 nsi->si_cxix = si->si_cxix;
10314 nsi->si_cxmax = si->si_cxmax;
10315 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10316 nsi->si_type = si->si_type;
10317 nsi->si_prev = si_dup(si->si_prev, param);
10318 nsi->si_next = si_dup(si->si_next, param);
10319 nsi->si_markoff = si->si_markoff;
10324 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10325 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10326 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10327 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10328 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10329 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10330 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10331 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10332 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10333 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10334 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10335 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10336 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10337 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10340 #define pv_dup_inc(p) SAVEPV(p)
10341 #define pv_dup(p) SAVEPV(p)
10342 #define svp_dup_inc(p,pp) any_dup(p,pp)
10344 /* map any object to the new equivent - either something in the
10345 * ptr table, or something in the interpreter structure
10349 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10354 return (void*)NULL;
10356 /* look for it in the table first */
10357 ret = ptr_table_fetch(PL_ptr_table, v);
10361 /* see if it is part of the interpreter structure */
10362 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10363 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10371 /* duplicate the save stack */
10374 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10376 ANY *ss = proto_perl->Tsavestack;
10377 I32 ix = proto_perl->Tsavestack_ix;
10378 I32 max = proto_perl->Tsavestack_max;
10391 void (*dptr) (void*);
10392 void (*dxptr) (pTHX_ void*);
10395 Newz(54, nss, max, ANY);
10399 TOPINT(nss,ix) = i;
10401 case SAVEt_ITEM: /* normal string */
10402 sv = (SV*)POPPTR(ss,ix);
10403 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10404 sv = (SV*)POPPTR(ss,ix);
10405 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10407 case SAVEt_SV: /* scalar reference */
10408 sv = (SV*)POPPTR(ss,ix);
10409 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10410 gv = (GV*)POPPTR(ss,ix);
10411 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10413 case SAVEt_GENERIC_PVREF: /* generic char* */
10414 c = (char*)POPPTR(ss,ix);
10415 TOPPTR(nss,ix) = pv_dup(c);
10416 ptr = POPPTR(ss,ix);
10417 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10419 case SAVEt_SHARED_PVREF: /* char* in shared space */
10420 c = (char*)POPPTR(ss,ix);
10421 TOPPTR(nss,ix) = savesharedpv(c);
10422 ptr = POPPTR(ss,ix);
10423 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10425 case SAVEt_GENERIC_SVREF: /* generic sv */
10426 case SAVEt_SVREF: /* scalar reference */
10427 sv = (SV*)POPPTR(ss,ix);
10428 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10429 ptr = POPPTR(ss,ix);
10430 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10432 case SAVEt_AV: /* array reference */
10433 av = (AV*)POPPTR(ss,ix);
10434 TOPPTR(nss,ix) = av_dup_inc(av, param);
10435 gv = (GV*)POPPTR(ss,ix);
10436 TOPPTR(nss,ix) = gv_dup(gv, param);
10438 case SAVEt_HV: /* hash reference */
10439 hv = (HV*)POPPTR(ss,ix);
10440 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10441 gv = (GV*)POPPTR(ss,ix);
10442 TOPPTR(nss,ix) = gv_dup(gv, param);
10444 case SAVEt_INT: /* int reference */
10445 ptr = POPPTR(ss,ix);
10446 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10447 intval = (int)POPINT(ss,ix);
10448 TOPINT(nss,ix) = intval;
10450 case SAVEt_LONG: /* long reference */
10451 ptr = POPPTR(ss,ix);
10452 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10453 longval = (long)POPLONG(ss,ix);
10454 TOPLONG(nss,ix) = longval;
10456 case SAVEt_I32: /* I32 reference */
10457 case SAVEt_I16: /* I16 reference */
10458 case SAVEt_I8: /* I8 reference */
10459 ptr = POPPTR(ss,ix);
10460 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10462 TOPINT(nss,ix) = i;
10464 case SAVEt_IV: /* IV reference */
10465 ptr = POPPTR(ss,ix);
10466 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10468 TOPIV(nss,ix) = iv;
10470 case SAVEt_SPTR: /* SV* reference */
10471 ptr = POPPTR(ss,ix);
10472 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10473 sv = (SV*)POPPTR(ss,ix);
10474 TOPPTR(nss,ix) = sv_dup(sv, param);
10476 case SAVEt_VPTR: /* random* reference */
10477 ptr = POPPTR(ss,ix);
10478 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10479 ptr = POPPTR(ss,ix);
10480 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10482 case SAVEt_PPTR: /* char* reference */
10483 ptr = POPPTR(ss,ix);
10484 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10485 c = (char*)POPPTR(ss,ix);
10486 TOPPTR(nss,ix) = pv_dup(c);
10488 case SAVEt_HPTR: /* HV* reference */
10489 ptr = POPPTR(ss,ix);
10490 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10491 hv = (HV*)POPPTR(ss,ix);
10492 TOPPTR(nss,ix) = hv_dup(hv, param);
10494 case SAVEt_APTR: /* AV* reference */
10495 ptr = POPPTR(ss,ix);
10496 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10497 av = (AV*)POPPTR(ss,ix);
10498 TOPPTR(nss,ix) = av_dup(av, param);
10501 gv = (GV*)POPPTR(ss,ix);
10502 TOPPTR(nss,ix) = gv_dup(gv, param);
10504 case SAVEt_GP: /* scalar reference */
10505 gp = (GP*)POPPTR(ss,ix);
10506 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10507 (void)GpREFCNT_inc(gp);
10508 gv = (GV*)POPPTR(ss,ix);
10509 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10510 c = (char*)POPPTR(ss,ix);
10511 TOPPTR(nss,ix) = pv_dup(c);
10513 TOPIV(nss,ix) = iv;
10515 TOPIV(nss,ix) = iv;
10518 case SAVEt_MORTALIZESV:
10519 sv = (SV*)POPPTR(ss,ix);
10520 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10523 ptr = POPPTR(ss,ix);
10524 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10525 /* these are assumed to be refcounted properly */
10526 switch (((OP*)ptr)->op_type) {
10528 case OP_LEAVESUBLV:
10532 case OP_LEAVEWRITE:
10533 TOPPTR(nss,ix) = ptr;
10538 TOPPTR(nss,ix) = Nullop;
10543 TOPPTR(nss,ix) = Nullop;
10546 c = (char*)POPPTR(ss,ix);
10547 TOPPTR(nss,ix) = pv_dup_inc(c);
10549 case SAVEt_CLEARSV:
10550 longval = POPLONG(ss,ix);
10551 TOPLONG(nss,ix) = longval;
10554 hv = (HV*)POPPTR(ss,ix);
10555 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10556 c = (char*)POPPTR(ss,ix);
10557 TOPPTR(nss,ix) = pv_dup_inc(c);
10559 TOPINT(nss,ix) = i;
10561 case SAVEt_DESTRUCTOR:
10562 ptr = POPPTR(ss,ix);
10563 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10564 dptr = POPDPTR(ss,ix);
10565 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
10567 case SAVEt_DESTRUCTOR_X:
10568 ptr = POPPTR(ss,ix);
10569 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10570 dxptr = POPDXPTR(ss,ix);
10571 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
10573 case SAVEt_REGCONTEXT:
10576 TOPINT(nss,ix) = i;
10579 case SAVEt_STACK_POS: /* Position on Perl stack */
10581 TOPINT(nss,ix) = i;
10583 case SAVEt_AELEM: /* array element */
10584 sv = (SV*)POPPTR(ss,ix);
10585 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10587 TOPINT(nss,ix) = i;
10588 av = (AV*)POPPTR(ss,ix);
10589 TOPPTR(nss,ix) = av_dup_inc(av, param);
10591 case SAVEt_HELEM: /* hash element */
10592 sv = (SV*)POPPTR(ss,ix);
10593 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10594 sv = (SV*)POPPTR(ss,ix);
10595 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10596 hv = (HV*)POPPTR(ss,ix);
10597 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10600 ptr = POPPTR(ss,ix);
10601 TOPPTR(nss,ix) = ptr;
10605 TOPINT(nss,ix) = i;
10607 case SAVEt_COMPPAD:
10608 av = (AV*)POPPTR(ss,ix);
10609 TOPPTR(nss,ix) = av_dup(av, param);
10612 longval = (long)POPLONG(ss,ix);
10613 TOPLONG(nss,ix) = longval;
10614 ptr = POPPTR(ss,ix);
10615 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10616 sv = (SV*)POPPTR(ss,ix);
10617 TOPPTR(nss,ix) = sv_dup(sv, param);
10620 ptr = POPPTR(ss,ix);
10621 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10622 longval = (long)POPBOOL(ss,ix);
10623 TOPBOOL(nss,ix) = (bool)longval;
10626 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10634 =for apidoc perl_clone
10636 Create and return a new interpreter by cloning the current one.
10638 perl_clone takes these flags as paramters:
10640 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10641 without it we only clone the data and zero the stacks,
10642 with it we copy the stacks and the new perl interpreter is
10643 ready to run at the exact same point as the previous one.
10644 The pseudo-fork code uses COPY_STACKS while the
10645 threads->new doesn't.
10647 CLONEf_KEEP_PTR_TABLE
10648 perl_clone keeps a ptr_table with the pointer of the old
10649 variable as a key and the new variable as a value,
10650 this allows it to check if something has been cloned and not
10651 clone it again but rather just use the value and increase the
10652 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10653 the ptr_table using the function
10654 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10655 reason to keep it around is if you want to dup some of your own
10656 variable who are outside the graph perl scans, example of this
10657 code is in threads.xs create
10660 This is a win32 thing, it is ignored on unix, it tells perls
10661 win32host code (which is c++) to clone itself, this is needed on
10662 win32 if you want to run two threads at the same time,
10663 if you just want to do some stuff in a separate perl interpreter
10664 and then throw it away and return to the original one,
10665 you don't need to do anything.
10670 /* XXX the above needs expanding by someone who actually understands it ! */
10671 EXTERN_C PerlInterpreter *
10672 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10675 perl_clone(PerlInterpreter *proto_perl, UV flags)
10677 #ifdef PERL_IMPLICIT_SYS
10679 /* perlhost.h so we need to call into it
10680 to clone the host, CPerlHost should have a c interface, sky */
10682 if (flags & CLONEf_CLONE_HOST) {
10683 return perl_clone_host(proto_perl,flags);
10685 return perl_clone_using(proto_perl, flags,
10687 proto_perl->IMemShared,
10688 proto_perl->IMemParse,
10690 proto_perl->IStdIO,
10694 proto_perl->IProc);
10698 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10699 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10700 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10701 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10702 struct IPerlDir* ipD, struct IPerlSock* ipS,
10703 struct IPerlProc* ipP)
10705 /* XXX many of the string copies here can be optimized if they're
10706 * constants; they need to be allocated as common memory and just
10707 * their pointers copied. */
10710 CLONE_PARAMS clone_params;
10711 CLONE_PARAMS* param = &clone_params;
10713 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10714 PERL_SET_THX(my_perl);
10717 Poison(my_perl, 1, PerlInterpreter);
10722 PL_sig_pending = 0;
10723 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10724 # else /* !DEBUGGING */
10725 Zero(my_perl, 1, PerlInterpreter);
10726 # endif /* DEBUGGING */
10728 /* host pointers */
10730 PL_MemShared = ipMS;
10731 PL_MemParse = ipMP;
10738 #else /* !PERL_IMPLICIT_SYS */
10740 CLONE_PARAMS clone_params;
10741 CLONE_PARAMS* param = &clone_params;
10742 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10743 PERL_SET_THX(my_perl);
10748 Poison(my_perl, 1, PerlInterpreter);
10753 PL_sig_pending = 0;
10754 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10755 # else /* !DEBUGGING */
10756 Zero(my_perl, 1, PerlInterpreter);
10757 # endif /* DEBUGGING */
10758 #endif /* PERL_IMPLICIT_SYS */
10759 param->flags = flags;
10760 param->proto_perl = proto_perl;
10763 PL_xiv_arenaroot = NULL;
10764 PL_xiv_root = NULL;
10765 PL_xnv_arenaroot = NULL;
10766 PL_xnv_root = NULL;
10767 PL_xrv_arenaroot = NULL;
10768 PL_xrv_root = NULL;
10769 PL_xpv_arenaroot = NULL;
10770 PL_xpv_root = NULL;
10771 PL_xpviv_arenaroot = NULL;
10772 PL_xpviv_root = NULL;
10773 PL_xpvnv_arenaroot = NULL;
10774 PL_xpvnv_root = NULL;
10775 PL_xpvcv_arenaroot = NULL;
10776 PL_xpvcv_root = NULL;
10777 PL_xpvav_arenaroot = NULL;
10778 PL_xpvav_root = NULL;
10779 PL_xpvhv_arenaroot = NULL;
10780 PL_xpvhv_root = NULL;
10781 PL_xpvmg_arenaroot = NULL;
10782 PL_xpvmg_root = NULL;
10783 PL_xpvlv_arenaroot = NULL;
10784 PL_xpvlv_root = NULL;
10785 PL_xpvbm_arenaroot = NULL;
10786 PL_xpvbm_root = NULL;
10787 PL_he_arenaroot = NULL;
10789 PL_nice_chunk = NULL;
10790 PL_nice_chunk_size = 0;
10792 PL_sv_objcount = 0;
10793 PL_sv_root = Nullsv;
10794 PL_sv_arenaroot = Nullsv;
10796 PL_debug = proto_perl->Idebug;
10798 #ifdef USE_REENTRANT_API
10799 Perl_reentrant_init(aTHX);
10802 /* create SV map for pointer relocation */
10803 PL_ptr_table = ptr_table_new();
10805 /* initialize these special pointers as early as possible */
10806 SvANY(&PL_sv_undef) = NULL;
10807 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10808 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10809 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10811 SvANY(&PL_sv_no) = new_XPVNV();
10812 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10813 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10814 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
10815 SvCUR(&PL_sv_no) = 0;
10816 SvLEN(&PL_sv_no) = 1;
10817 SvNVX(&PL_sv_no) = 0;
10818 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10820 SvANY(&PL_sv_yes) = new_XPVNV();
10821 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10822 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10823 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
10824 SvCUR(&PL_sv_yes) = 1;
10825 SvLEN(&PL_sv_yes) = 2;
10826 SvNVX(&PL_sv_yes) = 1;
10827 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10829 /* create (a non-shared!) shared string table */
10830 PL_strtab = newHV();
10831 HvSHAREKEYS_off(PL_strtab);
10832 hv_ksplit(PL_strtab, 512);
10833 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10835 PL_compiling = proto_perl->Icompiling;
10837 /* These two PVs will be free'd special way so must set them same way op.c does */
10838 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10839 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10841 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10842 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10844 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10845 if (!specialWARN(PL_compiling.cop_warnings))
10846 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10847 if (!specialCopIO(PL_compiling.cop_io))
10848 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10849 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10851 /* pseudo environmental stuff */
10852 PL_origargc = proto_perl->Iorigargc;
10853 PL_origargv = proto_perl->Iorigargv;
10855 param->stashes = newAV(); /* Setup array of objects to call clone on */
10857 #ifdef PERLIO_LAYERS
10858 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10859 PerlIO_clone(aTHX_ proto_perl, param);
10862 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10863 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10864 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10865 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10866 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10867 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10870 PL_minus_c = proto_perl->Iminus_c;
10871 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10872 PL_localpatches = proto_perl->Ilocalpatches;
10873 PL_splitstr = proto_perl->Isplitstr;
10874 PL_preprocess = proto_perl->Ipreprocess;
10875 PL_minus_n = proto_perl->Iminus_n;
10876 PL_minus_p = proto_perl->Iminus_p;
10877 PL_minus_l = proto_perl->Iminus_l;
10878 PL_minus_a = proto_perl->Iminus_a;
10879 PL_minus_F = proto_perl->Iminus_F;
10880 PL_doswitches = proto_perl->Idoswitches;
10881 PL_dowarn = proto_perl->Idowarn;
10882 PL_doextract = proto_perl->Idoextract;
10883 PL_sawampersand = proto_perl->Isawampersand;
10884 PL_unsafe = proto_perl->Iunsafe;
10885 PL_inplace = SAVEPV(proto_perl->Iinplace);
10886 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10887 PL_perldb = proto_perl->Iperldb;
10888 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10889 PL_exit_flags = proto_perl->Iexit_flags;
10891 /* magical thingies */
10892 /* XXX time(&PL_basetime) when asked for? */
10893 PL_basetime = proto_perl->Ibasetime;
10894 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10896 PL_maxsysfd = proto_perl->Imaxsysfd;
10897 PL_multiline = proto_perl->Imultiline;
10898 PL_statusvalue = proto_perl->Istatusvalue;
10900 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10902 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10904 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10905 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10906 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10908 /* Clone the regex array */
10909 PL_regex_padav = newAV();
10911 I32 len = av_len((AV*)proto_perl->Iregex_padav);
10912 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10913 av_push(PL_regex_padav,
10914 sv_dup_inc(regexen[0],param));
10915 for(i = 1; i <= len; i++) {
10916 if(SvREPADTMP(regexen[i])) {
10917 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10919 av_push(PL_regex_padav,
10921 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10922 SvIVX(regexen[i])), param)))
10927 PL_regex_pad = AvARRAY(PL_regex_padav);
10929 /* shortcuts to various I/O objects */
10930 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10931 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10932 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10933 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10934 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10935 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10937 /* shortcuts to regexp stuff */
10938 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10940 /* shortcuts to misc objects */
10941 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10943 /* shortcuts to debugging objects */
10944 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10945 PL_DBline = gv_dup(proto_perl->IDBline, param);
10946 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10947 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10948 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10949 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10950 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10951 PL_lineary = av_dup(proto_perl->Ilineary, param);
10952 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10954 /* symbol tables */
10955 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10956 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10957 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10958 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10959 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10961 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10962 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10963 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10964 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10965 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10966 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10968 PL_sub_generation = proto_perl->Isub_generation;
10970 /* funky return mechanisms */
10971 PL_forkprocess = proto_perl->Iforkprocess;
10973 /* subprocess state */
10974 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10976 /* internal state */
10977 PL_tainting = proto_perl->Itainting;
10978 PL_taint_warn = proto_perl->Itaint_warn;
10979 PL_maxo = proto_perl->Imaxo;
10980 if (proto_perl->Iop_mask)
10981 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10983 PL_op_mask = Nullch;
10984 /* PL_asserting = proto_perl->Iasserting; */
10986 /* current interpreter roots */
10987 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10988 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10989 PL_main_start = proto_perl->Imain_start;
10990 PL_eval_root = proto_perl->Ieval_root;
10991 PL_eval_start = proto_perl->Ieval_start;
10993 /* runtime control stuff */
10994 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10995 PL_copline = proto_perl->Icopline;
10997 PL_filemode = proto_perl->Ifilemode;
10998 PL_lastfd = proto_perl->Ilastfd;
10999 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11002 PL_gensym = proto_perl->Igensym;
11003 PL_preambled = proto_perl->Ipreambled;
11004 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11005 PL_laststatval = proto_perl->Ilaststatval;
11006 PL_laststype = proto_perl->Ilaststype;
11007 PL_mess_sv = Nullsv;
11009 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11010 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11012 /* interpreter atexit processing */
11013 PL_exitlistlen = proto_perl->Iexitlistlen;
11014 if (PL_exitlistlen) {
11015 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11016 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11019 PL_exitlist = (PerlExitListEntry*)NULL;
11020 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11021 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11022 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11024 PL_profiledata = NULL;
11025 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11026 /* PL_rsfp_filters entries have fake IoDIRP() */
11027 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11029 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11031 PAD_CLONE_VARS(proto_perl, param);
11033 #ifdef HAVE_INTERP_INTERN
11034 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11037 /* more statics moved here */
11038 PL_generation = proto_perl->Igeneration;
11039 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11041 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11042 PL_in_clean_all = proto_perl->Iin_clean_all;
11044 PL_uid = proto_perl->Iuid;
11045 PL_euid = proto_perl->Ieuid;
11046 PL_gid = proto_perl->Igid;
11047 PL_egid = proto_perl->Iegid;
11048 PL_nomemok = proto_perl->Inomemok;
11049 PL_an = proto_perl->Ian;
11050 PL_op_seqmax = proto_perl->Iop_seqmax;
11051 PL_evalseq = proto_perl->Ievalseq;
11052 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11053 PL_origalen = proto_perl->Iorigalen;
11054 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11055 PL_osname = SAVEPV(proto_perl->Iosname);
11056 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11057 PL_sighandlerp = proto_perl->Isighandlerp;
11060 PL_runops = proto_perl->Irunops;
11062 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11065 PL_cshlen = proto_perl->Icshlen;
11066 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11069 PL_lex_state = proto_perl->Ilex_state;
11070 PL_lex_defer = proto_perl->Ilex_defer;
11071 PL_lex_expect = proto_perl->Ilex_expect;
11072 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11073 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11074 PL_lex_starts = proto_perl->Ilex_starts;
11075 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11076 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11077 PL_lex_op = proto_perl->Ilex_op;
11078 PL_lex_inpat = proto_perl->Ilex_inpat;
11079 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11080 PL_lex_brackets = proto_perl->Ilex_brackets;
11081 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11082 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11083 PL_lex_casemods = proto_perl->Ilex_casemods;
11084 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11085 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11087 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11088 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11089 PL_nexttoke = proto_perl->Inexttoke;
11091 /* XXX This is probably masking the deeper issue of why
11092 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11093 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11094 * (A little debugging with a watchpoint on it may help.)
11096 if (SvANY(proto_perl->Ilinestr)) {
11097 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11098 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11099 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11100 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11101 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11102 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11103 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11104 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11105 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11108 PL_linestr = NEWSV(65,79);
11109 sv_upgrade(PL_linestr,SVt_PVIV);
11110 sv_setpvn(PL_linestr,"",0);
11111 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11113 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11114 PL_pending_ident = proto_perl->Ipending_ident;
11115 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11117 PL_expect = proto_perl->Iexpect;
11119 PL_multi_start = proto_perl->Imulti_start;
11120 PL_multi_end = proto_perl->Imulti_end;
11121 PL_multi_open = proto_perl->Imulti_open;
11122 PL_multi_close = proto_perl->Imulti_close;
11124 PL_error_count = proto_perl->Ierror_count;
11125 PL_subline = proto_perl->Isubline;
11126 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11128 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11129 if (SvANY(proto_perl->Ilinestr)) {
11130 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11131 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11132 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11133 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11134 PL_last_lop_op = proto_perl->Ilast_lop_op;
11137 PL_last_uni = SvPVX(PL_linestr);
11138 PL_last_lop = SvPVX(PL_linestr);
11139 PL_last_lop_op = 0;
11141 PL_in_my = proto_perl->Iin_my;
11142 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11144 PL_cryptseen = proto_perl->Icryptseen;
11147 PL_hints = proto_perl->Ihints;
11149 PL_amagic_generation = proto_perl->Iamagic_generation;
11151 #ifdef USE_LOCALE_COLLATE
11152 PL_collation_ix = proto_perl->Icollation_ix;
11153 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11154 PL_collation_standard = proto_perl->Icollation_standard;
11155 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11156 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11157 #endif /* USE_LOCALE_COLLATE */
11159 #ifdef USE_LOCALE_NUMERIC
11160 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11161 PL_numeric_standard = proto_perl->Inumeric_standard;
11162 PL_numeric_local = proto_perl->Inumeric_local;
11163 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11164 #endif /* !USE_LOCALE_NUMERIC */
11166 /* utf8 character classes */
11167 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11168 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11169 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11170 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11171 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11172 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11173 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11174 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11175 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11176 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11177 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11178 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11179 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11180 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11181 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11182 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11183 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11184 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11185 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11186 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11188 /* Did the locale setup indicate UTF-8? */
11189 PL_utf8locale = proto_perl->Iutf8locale;
11190 /* Unicode features (see perlrun/-C) */
11191 PL_unicode = proto_perl->Iunicode;
11193 /* Pre-5.8 signals control */
11194 PL_signals = proto_perl->Isignals;
11196 /* times() ticks per second */
11197 PL_clocktick = proto_perl->Iclocktick;
11199 /* Recursion stopper for PerlIO_find_layer */
11200 PL_in_load_module = proto_perl->Iin_load_module;
11202 /* sort() routine */
11203 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11206 PL_last_swash_hv = Nullhv; /* reinits on demand */
11207 PL_last_swash_klen = 0;
11208 PL_last_swash_key[0]= '\0';
11209 PL_last_swash_tmps = (U8*)NULL;
11210 PL_last_swash_slen = 0;
11212 /* perly.c globals */
11213 PL_yydebug = proto_perl->Iyydebug;
11214 PL_yynerrs = proto_perl->Iyynerrs;
11215 PL_yyerrflag = proto_perl->Iyyerrflag;
11216 PL_yychar = proto_perl->Iyychar;
11217 PL_yyval = proto_perl->Iyyval;
11218 PL_yylval = proto_perl->Iyylval;
11220 PL_glob_index = proto_perl->Iglob_index;
11221 PL_srand_called = proto_perl->Isrand_called;
11222 PL_uudmap['M'] = 0; /* reinits on demand */
11223 PL_bitcount = Nullch; /* reinits on demand */
11225 if (proto_perl->Ipsig_pend) {
11226 Newz(0, PL_psig_pend, SIG_SIZE, int);
11229 PL_psig_pend = (int*)NULL;
11232 if (proto_perl->Ipsig_ptr) {
11233 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
11234 Newz(0, PL_psig_name, SIG_SIZE, SV*);
11235 for (i = 1; i < SIG_SIZE; i++) {
11236 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11237 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11241 PL_psig_ptr = (SV**)NULL;
11242 PL_psig_name = (SV**)NULL;
11245 /* thrdvar.h stuff */
11247 if (flags & CLONEf_COPY_STACKS) {
11248 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11249 PL_tmps_ix = proto_perl->Ttmps_ix;
11250 PL_tmps_max = proto_perl->Ttmps_max;
11251 PL_tmps_floor = proto_perl->Ttmps_floor;
11252 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
11254 while (i <= PL_tmps_ix) {
11255 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11259 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11260 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11261 Newz(54, PL_markstack, i, I32);
11262 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11263 - proto_perl->Tmarkstack);
11264 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11265 - proto_perl->Tmarkstack);
11266 Copy(proto_perl->Tmarkstack, PL_markstack,
11267 PL_markstack_ptr - PL_markstack + 1, I32);
11269 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11270 * NOTE: unlike the others! */
11271 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11272 PL_scopestack_max = proto_perl->Tscopestack_max;
11273 Newz(54, PL_scopestack, PL_scopestack_max, I32);
11274 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11276 /* next push_return() sets PL_retstack[PL_retstack_ix]
11277 * NOTE: unlike the others! */
11278 PL_retstack_ix = proto_perl->Tretstack_ix;
11279 PL_retstack_max = proto_perl->Tretstack_max;
11280 Newz(54, PL_retstack, PL_retstack_max, OP*);
11281 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
11283 /* NOTE: si_dup() looks at PL_markstack */
11284 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11286 /* PL_curstack = PL_curstackinfo->si_stack; */
11287 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11288 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11290 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11291 PL_stack_base = AvARRAY(PL_curstack);
11292 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11293 - proto_perl->Tstack_base);
11294 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11296 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11297 * NOTE: unlike the others! */
11298 PL_savestack_ix = proto_perl->Tsavestack_ix;
11299 PL_savestack_max = proto_perl->Tsavestack_max;
11300 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11301 PL_savestack = ss_dup(proto_perl, param);
11305 ENTER; /* perl_destruct() wants to LEAVE; */
11308 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11309 PL_top_env = &PL_start_env;
11311 PL_op = proto_perl->Top;
11314 PL_Xpv = (XPV*)NULL;
11315 PL_na = proto_perl->Tna;
11317 PL_statbuf = proto_perl->Tstatbuf;
11318 PL_statcache = proto_perl->Tstatcache;
11319 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11320 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11322 PL_timesbuf = proto_perl->Ttimesbuf;
11325 PL_tainted = proto_perl->Ttainted;
11326 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11327 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11328 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11329 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11330 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11331 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11332 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11333 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11334 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11336 PL_restartop = proto_perl->Trestartop;
11337 PL_in_eval = proto_perl->Tin_eval;
11338 PL_delaymagic = proto_perl->Tdelaymagic;
11339 PL_dirty = proto_perl->Tdirty;
11340 PL_localizing = proto_perl->Tlocalizing;
11342 #ifdef PERL_FLEXIBLE_EXCEPTIONS
11343 PL_protect = proto_perl->Tprotect;
11345 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11346 PL_hv_fetch_ent_mh = Nullhe;
11347 PL_modcount = proto_perl->Tmodcount;
11348 PL_lastgotoprobe = Nullop;
11349 PL_dumpindent = proto_perl->Tdumpindent;
11351 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11352 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11353 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11354 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11355 PL_sortcxix = proto_perl->Tsortcxix;
11356 PL_efloatbuf = Nullch; /* reinits on demand */
11357 PL_efloatsize = 0; /* reinits on demand */
11361 PL_screamfirst = NULL;
11362 PL_screamnext = NULL;
11363 PL_maxscream = -1; /* reinits on demand */
11364 PL_lastscream = Nullsv;
11366 PL_watchaddr = NULL;
11367 PL_watchok = Nullch;
11369 PL_regdummy = proto_perl->Tregdummy;
11370 PL_regprecomp = Nullch;
11373 PL_colorset = 0; /* reinits PL_colors[] */
11374 /*PL_colors[6] = {0,0,0,0,0,0};*/
11375 PL_reginput = Nullch;
11376 PL_regbol = Nullch;
11377 PL_regeol = Nullch;
11378 PL_regstartp = (I32*)NULL;
11379 PL_regendp = (I32*)NULL;
11380 PL_reglastparen = (U32*)NULL;
11381 PL_regtill = Nullch;
11382 PL_reg_start_tmp = (char**)NULL;
11383 PL_reg_start_tmpl = 0;
11384 PL_regdata = (struct reg_data*)NULL;
11387 PL_reg_eval_set = 0;
11389 PL_regprogram = (regnode*)NULL;
11391 PL_regcc = (CURCUR*)NULL;
11392 PL_reg_call_cc = (struct re_cc_state*)NULL;
11393 PL_reg_re = (regexp*)NULL;
11394 PL_reg_ganch = Nullch;
11395 PL_reg_sv = Nullsv;
11396 PL_reg_match_utf8 = FALSE;
11397 PL_reg_magic = (MAGIC*)NULL;
11399 PL_reg_oldcurpm = (PMOP*)NULL;
11400 PL_reg_curpm = (PMOP*)NULL;
11401 PL_reg_oldsaved = Nullch;
11402 PL_reg_oldsavedlen = 0;
11403 #ifdef PERL_COPY_ON_WRITE
11406 PL_reg_maxiter = 0;
11407 PL_reg_leftiter = 0;
11408 PL_reg_poscache = Nullch;
11409 PL_reg_poscache_size= 0;
11411 /* RE engine - function pointers */
11412 PL_regcompp = proto_perl->Tregcompp;
11413 PL_regexecp = proto_perl->Tregexecp;
11414 PL_regint_start = proto_perl->Tregint_start;
11415 PL_regint_string = proto_perl->Tregint_string;
11416 PL_regfree = proto_perl->Tregfree;
11418 PL_reginterp_cnt = 0;
11419 PL_reg_starttry = 0;
11421 /* Pluggable optimizer */
11422 PL_peepp = proto_perl->Tpeepp;
11424 PL_stashcache = newHV();
11426 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11427 ptr_table_free(PL_ptr_table);
11428 PL_ptr_table = NULL;
11431 /* Call the ->CLONE method, if it exists, for each of the stashes
11432 identified by sv_dup() above.
11434 while(av_len(param->stashes) != -1) {
11435 HV* stash = (HV*) av_shift(param->stashes);
11436 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11437 if (cloner && GvCV(cloner)) {
11442 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
11444 call_sv((SV*)GvCV(cloner), G_DISCARD);
11450 SvREFCNT_dec(param->stashes);
11455 #endif /* USE_ITHREADS */
11458 =head1 Unicode Support
11460 =for apidoc sv_recode_to_utf8
11462 The encoding is assumed to be an Encode object, on entry the PV
11463 of the sv is assumed to be octets in that encoding, and the sv
11464 will be converted into Unicode (and UTF-8).
11466 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11467 is not a reference, nothing is done to the sv. If the encoding is not
11468 an C<Encode::XS> Encoding object, bad things will happen.
11469 (See F<lib/encoding.pm> and L<Encode>).
11471 The PV of the sv is returned.
11476 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11478 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11492 Passing sv_yes is wrong - it needs to be or'ed set of constants
11493 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11494 remove converted chars from source.
11496 Both will default the value - let them.
11498 XPUSHs(&PL_sv_yes);
11501 call_method("decode", G_SCALAR);
11505 s = SvPV(uni, len);
11506 if (s != SvPVX(sv)) {
11507 SvGROW(sv, len + 1);
11508 Move(s, SvPVX(sv), len, char);
11509 SvCUR_set(sv, len);
11510 SvPVX(sv)[len] = 0;
11520 =for apidoc sv_cat_decode
11522 The encoding is assumed to be an Encode object, the PV of the ssv is
11523 assumed to be octets in that encoding and decoding the input starts
11524 from the position which (PV + *offset) pointed to. The dsv will be
11525 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11526 when the string tstr appears in decoding output or the input ends on
11527 the PV of the ssv. The value which the offset points will be modified
11528 to the last input position on the ssv.
11530 Returns TRUE if the terminator was found, else returns FALSE.
11535 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11536 SV *ssv, int *offset, char *tstr, int tlen)
11539 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11550 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11551 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11553 call_method("cat_decode", G_SCALAR);
11555 ret = SvTRUE(TOPs);
11556 *offset = SvIV(offsv);
11562 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");