3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
62 sv, av, hv...) contains type and reference count information, and for
63 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
64 contains fields specific to each type. Some types store all they need
65 in the head, so don't have a body.
67 In all but the most memory-paranoid configuations (ex: PURIFY), heads
68 and bodies are allocated out of arenas, which by default are
69 approximately 4K chunks of memory parcelled up into N heads or bodies.
70 Sv-bodies are allocated by their sv-type, guaranteeing size
71 consistency needed to allocate safely from arrays.
73 For SV-heads, the first slot in each arena is reserved, and holds a
74 link to the next arena, some flags, and a note of the number of slots.
75 Snaked through each arena chain is a linked list of free items; when
76 this becomes empty, an extra arena is allocated and divided up into N
77 items which are threaded into the free list.
79 SV-bodies are similar, but they use arena-sets by default, which
80 separate the link and info from the arena itself, and reclaim the 1st
81 slot in the arena. SV-bodies are further described later.
83 The following global variables are associated with arenas:
85 PL_sv_arenaroot pointer to list of SV arenas
86 PL_sv_root pointer to list of free SV structures
88 PL_body_arenas head of linked-list of body arenas
89 PL_body_roots[] array of pointers to list of free bodies of svtype
90 arrays are indexed by the svtype needed
92 A few special SV heads are not allocated from an arena, but are
93 instead directly created in the interpreter structure, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 At the time of very final cleanup, sv_free_arenas() is called from
107 perl_destruct() to physically free all the arenas allocated since the
108 start of the interpreter.
110 Manipulation of any of the PL_*root pointers is protected by enclosing
111 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
112 if threads are enabled.
114 The function visit() scans the SV arenas list, and calls a specified
115 function for each SV it finds which is still live - ie which has an SvTYPE
116 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
117 following functions (specified as [function that calls visit()] / [function
118 called by visit() for each SV]):
120 sv_report_used() / do_report_used()
121 dump all remaining SVs (debugging aid)
123 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
124 Attempt to free all objects pointed to by RVs,
125 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
126 try to do the same for all objects indirectly
127 referenced by typeglobs too. Called once from
128 perl_destruct(), prior to calling sv_clean_all()
131 sv_clean_all() / do_clean_all()
132 SvREFCNT_dec(sv) each remaining SV, possibly
133 triggering an sv_free(). It also sets the
134 SVf_BREAK flag on the SV to indicate that the
135 refcnt has been artificially lowered, and thus
136 stopping sv_free() from giving spurious warnings
137 about SVs which unexpectedly have a refcnt
138 of zero. called repeatedly from perl_destruct()
139 until there are no SVs left.
141 =head2 Arena allocator API Summary
143 Private API to rest of sv.c
147 new_XIV(), del_XIV(),
148 new_XNV(), del_XNV(),
153 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
157 ============================================================================ */
160 * "A time to plant, and a time to uproot what was planted..."
164 * nice_chunk and nice_chunk size need to be set
165 * and queried under the protection of sv_mutex
168 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
174 new_chunk = (void *)(chunk);
175 new_chunk_size = (chunk_size);
176 if (new_chunk_size > PL_nice_chunk_size) {
177 Safefree(PL_nice_chunk);
178 PL_nice_chunk = (char *) new_chunk;
179 PL_nice_chunk_size = new_chunk_size;
186 #ifdef DEBUG_LEAKING_SCALARS
187 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
189 # define FREE_SV_DEBUG_FILE(sv)
193 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
194 /* Whilst I'd love to do this, it seems that things like to check on
196 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
198 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
199 Poison(&SvREFCNT(sv), 1, U32)
201 # define SvARENA_CHAIN(sv) SvANY(sv)
202 # define POSION_SV_HEAD(sv)
205 #define plant_SV(p) \
207 FREE_SV_DEBUG_FILE(p); \
209 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
210 SvFLAGS(p) = SVTYPEMASK; \
215 /* sv_mutex must be held while calling uproot_SV() */
216 #define uproot_SV(p) \
219 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
224 /* make some more SVs by adding another arena */
226 /* sv_mutex must be held while calling more_sv() */
234 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
235 PL_nice_chunk = NULL;
236 PL_nice_chunk_size = 0;
239 char *chunk; /* must use New here to match call to */
240 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
241 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
247 /* new_SV(): return a new, empty SV head */
249 #ifdef DEBUG_LEAKING_SCALARS
250 /* provide a real function for a debugger to play with */
260 sv = S_more_sv(aTHX);
265 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
266 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
267 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
268 sv->sv_debug_inpad = 0;
269 sv->sv_debug_cloned = 0;
270 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
274 # define new_SV(p) (p)=S_new_SV(aTHX)
283 (p) = S_more_sv(aTHX); \
292 /* del_SV(): return an empty SV head to the free list */
307 S_del_sv(pTHX_ SV *p)
313 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
314 const SV * const sv = sva + 1;
315 const SV * const svend = &sva[SvREFCNT(sva)];
316 if (p >= sv && p < svend) {
322 if (ckWARN_d(WARN_INTERNAL))
323 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
324 "Attempt to free non-arena SV: 0x%"UVxf
325 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
332 #else /* ! DEBUGGING */
334 #define del_SV(p) plant_SV(p)
336 #endif /* DEBUGGING */
340 =head1 SV Manipulation Functions
342 =for apidoc sv_add_arena
344 Given a chunk of memory, link it to the head of the list of arenas,
345 and split it into a list of free SVs.
351 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
354 SV* const sva = (SV*)ptr;
358 /* The first SV in an arena isn't an SV. */
359 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
360 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
361 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
363 PL_sv_arenaroot = sva;
364 PL_sv_root = sva + 1;
366 svend = &sva[SvREFCNT(sva) - 1];
369 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
373 /* Must always set typemask because it's awlays checked in on cleanup
374 when the arenas are walked looking for objects. */
375 SvFLAGS(sv) = SVTYPEMASK;
378 SvARENA_CHAIN(sv) = 0;
382 SvFLAGS(sv) = SVTYPEMASK;
385 /* visit(): call the named function for each non-free SV in the arenas
386 * whose flags field matches the flags/mask args. */
389 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
395 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
396 register const SV * const svend = &sva[SvREFCNT(sva)];
398 for (sv = sva + 1; sv < svend; ++sv) {
399 if (SvTYPE(sv) != SVTYPEMASK
400 && (sv->sv_flags & mask) == flags
413 /* called by sv_report_used() for each live SV */
416 do_report_used(pTHX_ SV *sv)
418 if (SvTYPE(sv) != SVTYPEMASK) {
419 PerlIO_printf(Perl_debug_log, "****\n");
426 =for apidoc sv_report_used
428 Dump the contents of all SVs not yet freed. (Debugging aid).
434 Perl_sv_report_used(pTHX)
437 visit(do_report_used, 0, 0);
441 /* called by sv_clean_objs() for each live SV */
444 do_clean_objs(pTHX_ SV *ref)
448 SV * const target = SvRV(ref);
449 if (SvOBJECT(target)) {
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
451 if (SvWEAKREF(ref)) {
452 sv_del_backref(target, ref);
458 SvREFCNT_dec(target);
463 /* XXX Might want to check arrays, etc. */
466 /* called by sv_clean_objs() for each live SV */
468 #ifndef DISABLE_DESTRUCTOR_KLUDGE
470 do_clean_named_objs(pTHX_ SV *sv)
473 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
475 #ifdef PERL_DONT_CREATE_GVSV
478 SvOBJECT(GvSV(sv))) ||
479 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
480 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
481 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
482 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
484 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
485 SvFLAGS(sv) |= SVf_BREAK;
493 =for apidoc sv_clean_objs
495 Attempt to destroy all objects not yet freed
501 Perl_sv_clean_objs(pTHX)
504 PL_in_clean_objs = TRUE;
505 visit(do_clean_objs, SVf_ROK, SVf_ROK);
506 #ifndef DISABLE_DESTRUCTOR_KLUDGE
507 /* some barnacles may yet remain, clinging to typeglobs */
508 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
510 PL_in_clean_objs = FALSE;
513 /* called by sv_clean_all() for each live SV */
516 do_clean_all(pTHX_ SV *sv)
519 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
520 SvFLAGS(sv) |= SVf_BREAK;
521 if (PL_comppad == (AV*)sv) {
529 =for apidoc sv_clean_all
531 Decrement the refcnt of each remaining SV, possibly triggering a
532 cleanup. This function may have to be called multiple times to free
533 SVs which are in complex self-referential hierarchies.
539 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 ARENASETS: a meta-arena implementation which separates arena-info
551 into struct arena_set, which contains an array of struct
552 arena_descs, each holding info for a single arena. By separating
553 the meta-info from the arena, we recover the 1st slot, formerly
554 borrowed for list management. The arena_set is about the size of an
555 arena, avoiding the needless malloc overhead of a naive linked-list
557 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
558 memory in the last arena-set (1/2 on average). In trade, we get
559 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
560 smaller types). The recovery of the wasted space allows use of
561 small arenas for large, rare body types,
564 char *arena; /* the raw storage, allocated aligned */
565 size_t size; /* its size ~4k typ */
566 int unit_type; /* useful for arena audits */
567 /* info for sv-heads (eventually)
574 /* Get the maximum number of elements in set[] such that struct arena_set
575 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
576 therefore likely to be 1 aligned memory page. */
578 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
579 - 2 * sizeof(int)) / sizeof (struct arena_desc))
582 struct arena_set* next;
583 int set_size; /* ie ARENAS_PER_SET */
584 int curr; /* index of next available arena-desc */
585 struct arena_desc set[ARENAS_PER_SET];
591 S_free_arena(pTHX_ void **root) {
593 void ** const next = *(void **)root;
601 =for apidoc sv_free_arenas
603 Deallocate the memory used by all arenas. Note that all the individual SV
604 heads and bodies within the arenas must already have been freed.
609 Perl_sv_free_arenas(pTHX)
616 /* Free arenas here, but be careful about fake ones. (We assume
617 contiguity of the fake ones with the corresponding real ones.) */
619 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
620 svanext = (SV*) SvANY(sva);
621 while (svanext && SvFAKE(svanext))
622 svanext = (SV*) SvANY(svanext);
630 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
632 for (; aroot; aroot = next) {
633 int max = aroot->curr;
634 for (i=0; i<max; i++) {
635 assert(aroot->set[i].arena);
636 Safefree(aroot->set[i].arena);
643 S_free_arena(aTHX_ (void**) PL_body_arenas);
646 for (i=0; i<SVt_LAST; i++)
647 PL_body_roots[i] = 0;
649 Safefree(PL_nice_chunk);
650 PL_nice_chunk = NULL;
651 PL_nice_chunk_size = 0;
657 Here are mid-level routines that manage the allocation of bodies out
658 of the various arenas. There are 5 kinds of arenas:
660 1. SV-head arenas, which are discussed and handled above
661 2. regular body arenas
662 3. arenas for reduced-size bodies
664 5. pte arenas (thread related)
666 Arena types 2 & 3 are chained by body-type off an array of
667 arena-root pointers, which is indexed by svtype. Some of the
668 larger/less used body types are malloced singly, since a large
669 unused block of them is wasteful. Also, several svtypes dont have
670 bodies; the data fits into the sv-head itself. The arena-root
671 pointer thus has a few unused root-pointers (which may be hijacked
672 later for arena types 4,5)
674 3 differs from 2 as an optimization; some body types have several
675 unused fields in the front of the structure (which are kept in-place
676 for consistency). These bodies can be allocated in smaller chunks,
677 because the leading fields arent accessed. Pointers to such bodies
678 are decremented to point at the unused 'ghost' memory, knowing that
679 the pointers are used with offsets to the real memory.
681 HE, HEK arenas are managed separately, with separate code, but may
682 be merge-able later..
684 PTE arenas are not sv-bodies, but they share these mid-level
685 mechanics, so are considered here. The new mid-level mechanics rely
686 on the sv_type of the body being allocated, so we just reserve one
687 of the unused body-slots for PTEs, then use it in those (2) PTE
688 contexts below (line ~10k)
691 /* get_arena(size): when ARENASETS is enabled, this creates
692 custom-sized arenas, otherwize it uses PERL_ARENA_SIZE, as
694 TBD: export properly for hv.c: S_more_he().
697 Perl_get_arena(pTHX_ int arena_size)
702 /* allocate and attach arena */
703 Newx(arp, arena_size, char);
704 arp->next = PL_body_arenas;
705 PL_body_arenas = arp;
709 struct arena_desc* adesc;
710 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
713 /* shouldnt need this
714 if (!arena_size) arena_size = PERL_ARENA_SIZE;
717 /* may need new arena-set to hold new arena */
718 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
719 Newxz(newroot, 1, struct arena_set);
720 newroot->set_size = ARENAS_PER_SET;
721 newroot->next = *aroot;
723 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", *aroot));
726 /* ok, now have arena-set with at least 1 empty/available arena-desc */
727 curr = (*aroot)->curr++;
728 adesc = &((*aroot)->set[curr]);
729 assert(!adesc->arena);
731 Newxz(adesc->arena, arena_size, char);
732 adesc->size = arena_size;
733 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
734 curr, adesc->arena, arena_size));
741 /* return a thing to the free list */
743 #define del_body(thing, root) \
745 void ** const thing_copy = (void **)thing;\
747 *thing_copy = *root; \
748 *root = (void*)thing_copy; \
754 =head1 SV-Body Allocation
756 Allocation of SV-bodies is similar to SV-heads, differing as follows;
757 the allocation mechanism is used for many body types, so is somewhat
758 more complicated, it uses arena-sets, and has no need for still-live
761 At the outermost level, (new|del)_X*V macros return bodies of the
762 appropriate type. These macros call either (new|del)_body_type or
763 (new|del)_body_allocated macro pairs, depending on specifics of the
764 type. Most body types use the former pair, the latter pair is used to
765 allocate body types with "ghost fields".
767 "ghost fields" are fields that are unused in certain types, and
768 consequently dont need to actually exist. They are declared because
769 they're part of a "base type", which allows use of functions as
770 methods. The simplest examples are AVs and HVs, 2 aggregate types
771 which don't use the fields which support SCALAR semantics.
773 For these types, the arenas are carved up into *_allocated size
774 chunks, we thus avoid wasted memory for those unaccessed members.
775 When bodies are allocated, we adjust the pointer back in memory by the
776 size of the bit not allocated, so it's as if we allocated the full
777 structure. (But things will all go boom if you write to the part that
778 is "not there", because you'll be overwriting the last members of the
779 preceding structure in memory.)
781 We calculate the correction using the STRUCT_OFFSET macro. For
782 example, if xpv_allocated is the same structure as XPV then the two
783 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
784 structure is smaller (no initial NV actually allocated) then the net
785 effect is to subtract the size of the NV from the pointer, to return a
786 new pointer as if an initial NV were actually allocated.
788 This is the same trick as was used for NV and IV bodies. Ironically it
789 doesn't need to be used for NV bodies any more, because NV is now at
790 the start of the structure. IV bodies don't need it either, because
791 they are no longer allocated.
793 In turn, the new_body_* allocators call S_new_body(), which invokes
794 new_body_inline macro, which takes a lock, and takes a body off the
795 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
796 necessary to refresh an empty list. Then the lock is released, and
797 the body is returned.
799 S_more_bodies calls get_arena(), and carves it up into an array of N
800 bodies, which it strings into a linked list. It looks up arena-size
801 and body-size from the body_details table described below, thus
802 supporting the multiple body-types.
804 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
805 the (new|del)_X*V macros are mapped directly to malloc/free.
811 For each sv-type, struct body_details bodies_by_type[] carries
812 parameters which control these aspects of SV handling:
814 Arena_size determines whether arenas are used for this body type, and if
815 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
816 zero, forcing individual mallocs and frees.
818 Body_size determines how big a body is, and therefore how many fit into
819 each arena. Offset carries the body-pointer adjustment needed for
820 *_allocated body types, and is used in *_allocated macros.
822 But its main purpose is to parameterize info needed in
823 Perl_sv_upgrade(). The info here dramatically simplifies the function
824 vs the implementation in 5.8.7, making it table-driven. All fields
825 are used for this, except for arena_size.
827 For the sv-types that have no bodies, arenas are not used, so those
828 PL_body_roots[sv_type] are unused, and can be overloaded. In
829 something of a special case, SVt_NULL is borrowed for HE arenas;
830 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
831 bodies_by_type[SVt_NULL] slot is not used, as the table is not
834 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
835 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
836 they can just use the same allocation semantics. At first, PTEs were
837 also overloaded to a non-body sv-type, but this yielded hard-to-find
838 malloc bugs, so was simplified by claiming a new slot. This choice
839 has no consequence at this time.
843 struct body_details {
844 size_t body_size; /* Size to allocate */
845 size_t copy; /* Size of structure to copy (may be shorter) */
847 bool cant_upgrade; /* Cannot upgrade this type */
848 bool zero_nv; /* zero the NV when upgrading from this */
849 bool arena; /* Allocated from an arena */
850 size_t arena_size; /* Size of arena to allocate */
858 /* With -DPURFIY we allocate everything directly, and don't use arenas.
859 This seems a rather elegant way to simplify some of the code below. */
860 #define HASARENA FALSE
862 #define HASARENA TRUE
864 #define NOARENA FALSE
866 /* Size the arenas to exactly fit a given number of bodies. A count
867 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
868 simplifying the default. If count > 0, the arena is sized to fit
869 only that many bodies, allowing arenas to be used for large, rare
870 bodies (XPVFM, XPVIO) without undue waste. The arena size is
871 limited by PERL_ARENA_SIZE, so we can safely oversize the
874 #define FIT_ARENA(count, body_size) \
875 (!count || count * body_size > PERL_ARENA_SIZE) \
876 ? (int)(PERL_ARENA_SIZE / body_size) * body_size : count * body_size
878 /* A macro to work out the offset needed to subtract from a pointer to (say)
885 to make its members accessible via a pointer to (say)
895 #define relative_STRUCT_OFFSET(longer, shorter, member) \
896 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
898 /* Calculate the length to copy. Specifically work out the length less any
899 final padding the compiler needed to add. See the comment in sv_upgrade
900 for why copying the padding proved to be a bug. */
902 #define copy_length(type, last_member) \
903 STRUCT_OFFSET(type, last_member) \
904 + sizeof (((type*)SvANY((SV*)0))->last_member)
906 static const struct body_details bodies_by_type[] = {
907 { sizeof(HE), 0, 0, FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
909 /* IVs are in the head, so the allocation size is 0.
910 However, the slot is overloaded for PTEs. */
911 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
912 sizeof(IV), /* This is used to copy out the IV body. */
913 STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV,
914 NOARENA /* IVS don't need an arena */,
915 /* But PTEs need to know the size of their arena */
916 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
919 /* 8 bytes on most ILP32 with IEEE doubles */
920 { sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA,
921 FIT_ARENA(0, sizeof(NV)) },
923 /* RVs are in the head now. */
924 { 0, 0, 0, FALSE, NONV, NOARENA, 0 },
926 /* 8 bytes on most ILP32 with IEEE doubles */
927 { sizeof(xpv_allocated),
928 copy_length(XPV, xpv_len)
929 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
930 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
931 FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
934 { sizeof(xpviv_allocated),
935 copy_length(XPVIV, xiv_u)
936 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
937 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
938 FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
941 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV,
942 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
945 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV,
946 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
949 { sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV,
950 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
953 { sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV,
954 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
957 { sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV,
958 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
960 { sizeof(xpvav_allocated),
961 copy_length(XPVAV, xmg_stash)
962 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
963 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
964 TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
966 { sizeof(xpvhv_allocated),
967 copy_length(XPVHV, xmg_stash)
968 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
969 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
970 TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
973 { sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV,
974 HASARENA, FIT_ARENA(0, sizeof(XPVCV)) },
976 { sizeof(xpvfm_allocated),
977 sizeof(xpvfm_allocated)
978 - relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
979 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
980 TRUE, HADNV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
982 /* XPVIO is 84 bytes, fits 48x */
983 { sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV,
984 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
987 #define new_body_type(sv_type) \
988 (void *)((char *)S_new_body(aTHX_ sv_type))
990 #define del_body_type(p, sv_type) \
991 del_body(p, &PL_body_roots[sv_type])
994 #define new_body_allocated(sv_type) \
995 (void *)((char *)S_new_body(aTHX_ sv_type) \
996 - bodies_by_type[sv_type].offset)
998 #define del_body_allocated(p, sv_type) \
999 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
1002 #define my_safemalloc(s) (void*)safemalloc(s)
1003 #define my_safecalloc(s) (void*)safecalloc(s, 1)
1004 #define my_safefree(p) safefree((char*)p)
1008 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1009 #define del_XNV(p) my_safefree(p)
1011 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1012 #define del_XPVNV(p) my_safefree(p)
1014 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1015 #define del_XPVAV(p) my_safefree(p)
1017 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1018 #define del_XPVHV(p) my_safefree(p)
1020 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1021 #define del_XPVMG(p) my_safefree(p)
1023 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1024 #define del_XPVGV(p) my_safefree(p)
1028 #define new_XNV() new_body_type(SVt_NV)
1029 #define del_XNV(p) del_body_type(p, SVt_NV)
1031 #define new_XPVNV() new_body_type(SVt_PVNV)
1032 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1034 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1035 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1037 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1038 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1040 #define new_XPVMG() new_body_type(SVt_PVMG)
1041 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1043 #define new_XPVGV() new_body_type(SVt_PVGV)
1044 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1048 /* no arena for you! */
1050 #define new_NOARENA(details) \
1051 my_safemalloc((details)->body_size + (details)->offset)
1052 #define new_NOARENAZ(details) \
1053 my_safecalloc((details)->body_size + (details)->offset)
1056 S_more_bodies (pTHX_ svtype sv_type)
1059 void ** const root = &PL_body_roots[sv_type];
1060 const struct body_details *bdp = &bodies_by_type[sv_type];
1061 const size_t body_size = bdp->body_size;
1065 assert(bdp->arena_size);
1066 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1068 end = start + bdp->arena_size - body_size;
1071 /* The initial slot is used to link the arenas together, so it isn't to be
1072 linked into the list of ready-to-use bodies. */
1075 /* computed count doesnt reflect the 1st slot reservation */
1076 DEBUG_m(PerlIO_printf(Perl_debug_log,
1077 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1078 start, end, bdp->arena_size, sv_type, body_size,
1079 bdp->arena_size / body_size));
1082 *root = (void *)start;
1084 while (start < end) {
1085 char * const next = start + body_size;
1086 *(void**) start = (void *)next;
1089 *(void **)start = 0;
1094 /* grab a new thing from the free list, allocating more if necessary.
1095 The inline version is used for speed in hot routines, and the
1096 function using it serves the rest (unless PURIFY).
1098 #define new_body_inline(xpv, sv_type) \
1100 void ** const r3wt = &PL_body_roots[sv_type]; \
1102 xpv = *((void **)(r3wt)) \
1103 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ sv_type); \
1104 *(r3wt) = *(void**)(xpv); \
1111 S_new_body(pTHX_ svtype sv_type)
1115 new_body_inline(xpv, sv_type);
1122 =for apidoc sv_upgrade
1124 Upgrade an SV to a more complex form. Generally adds a new body type to the
1125 SV, then copies across as much information as possible from the old body.
1126 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1132 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1137 const U32 old_type = SvTYPE(sv);
1138 const struct body_details *new_type_details;
1139 const struct body_details *const old_type_details
1140 = bodies_by_type + old_type;
1142 if (new_type != SVt_PV && SvIsCOW(sv)) {
1143 sv_force_normal_flags(sv, 0);
1146 if (old_type == new_type)
1149 if (old_type > new_type)
1150 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1151 (int)old_type, (int)new_type);
1154 old_body = SvANY(sv);
1156 /* Copying structures onto other structures that have been neatly zeroed
1157 has a subtle gotcha. Consider XPVMG
1159 +------+------+------+------+------+-------+-------+
1160 | NV | CUR | LEN | IV | MAGIC | STASH |
1161 +------+------+------+------+------+-------+-------+
1162 0 4 8 12 16 20 24 28
1164 where NVs are aligned to 8 bytes, so that sizeof that structure is
1165 actually 32 bytes long, with 4 bytes of padding at the end:
1167 +------+------+------+------+------+-------+-------+------+
1168 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1169 +------+------+------+------+------+-------+-------+------+
1170 0 4 8 12 16 20 24 28 32
1172 so what happens if you allocate memory for this structure:
1174 +------+------+------+------+------+-------+-------+------+------+...
1175 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1176 +------+------+------+------+------+-------+-------+------+------+...
1177 0 4 8 12 16 20 24 28 32 36
1179 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1180 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1181 started out as zero once, but it's quite possible that it isn't. So now,
1182 rather than a nicely zeroed GP, you have it pointing somewhere random.
1185 (In fact, GP ends up pointing at a previous GP structure, because the
1186 principle cause of the padding in XPVMG getting garbage is a copy of
1187 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1189 So we are careful and work out the size of used parts of all the
1196 if (new_type < SVt_PVIV) {
1197 new_type = (new_type == SVt_NV)
1198 ? SVt_PVNV : SVt_PVIV;
1202 if (new_type < SVt_PVNV) {
1203 new_type = SVt_PVNV;
1209 assert(new_type > SVt_PV);
1210 assert(SVt_IV < SVt_PV);
1211 assert(SVt_NV < SVt_PV);
1218 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1219 there's no way that it can be safely upgraded, because perl.c
1220 expects to Safefree(SvANY(PL_mess_sv)) */
1221 assert(sv != PL_mess_sv);
1222 /* This flag bit is used to mean other things in other scalar types.
1223 Given that it only has meaning inside the pad, it shouldn't be set
1224 on anything that can get upgraded. */
1225 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1228 if (old_type_details->cant_upgrade)
1229 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1230 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1232 new_type_details = bodies_by_type + new_type;
1234 SvFLAGS(sv) &= ~SVTYPEMASK;
1235 SvFLAGS(sv) |= new_type;
1237 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1238 the return statements above will have triggered. */
1239 assert (new_type != SVt_NULL);
1242 assert(old_type == SVt_NULL);
1243 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1247 assert(old_type == SVt_NULL);
1248 SvANY(sv) = new_XNV();
1252 assert(old_type == SVt_NULL);
1253 SvANY(sv) = &sv->sv_u.svu_rv;
1258 assert(new_type_details->body_size);
1261 assert(new_type_details->arena);
1262 assert(new_type_details->arena_size);
1263 /* This points to the start of the allocated area. */
1264 new_body_inline(new_body, new_type);
1265 Zero(new_body, new_type_details->body_size, char);
1266 new_body = ((char *)new_body) - new_type_details->offset;
1268 /* We always allocated the full length item with PURIFY. To do this
1269 we fake things so that arena is false for all 16 types.. */
1270 new_body = new_NOARENAZ(new_type_details);
1272 SvANY(sv) = new_body;
1273 if (new_type == SVt_PVAV) {
1279 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1280 The target created by newSVrv also is, and it can have magic.
1281 However, it never has SvPVX set.
1283 if (old_type >= SVt_RV) {
1284 assert(SvPVX_const(sv) == 0);
1287 /* Could put this in the else clause below, as PVMG must have SvPVX
1288 0 already (the assertion above) */
1291 if (old_type >= SVt_PVMG) {
1292 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1293 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1299 /* XXX Is this still needed? Was it ever needed? Surely as there is
1300 no route from NV to PVIV, NOK can never be true */
1301 assert(!SvNOKp(sv));
1313 assert(new_type_details->body_size);
1314 /* We always allocated the full length item with PURIFY. To do this
1315 we fake things so that arena is false for all 16 types.. */
1316 if(new_type_details->arena) {
1317 /* This points to the start of the allocated area. */
1318 new_body_inline(new_body, new_type);
1319 Zero(new_body, new_type_details->body_size, char);
1320 new_body = ((char *)new_body) - new_type_details->offset;
1322 new_body = new_NOARENAZ(new_type_details);
1324 SvANY(sv) = new_body;
1326 if (old_type_details->copy) {
1327 Copy((char *)old_body + old_type_details->offset,
1328 (char *)new_body + old_type_details->offset,
1329 old_type_details->copy, char);
1332 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1333 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1334 * correct 0.0 for us. Otherwise, if the old body didn't have an
1335 * NV slot, but the new one does, then we need to initialise the
1336 * freshly created NV slot with whatever the correct bit pattern is
1338 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1342 if (new_type == SVt_PVIO)
1343 IoPAGE_LEN(sv) = 60;
1344 if (old_type < SVt_RV)
1348 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1349 (unsigned long)new_type);
1352 if (old_type_details->arena) {
1353 /* If there was an old body, then we need to free it.
1354 Note that there is an assumption that all bodies of types that
1355 can be upgraded came from arenas. Only the more complex non-
1356 upgradable types are allowed to be directly malloc()ed. */
1358 my_safefree(old_body);
1360 del_body((void*)((char*)old_body + old_type_details->offset),
1361 &PL_body_roots[old_type]);
1367 =for apidoc sv_backoff
1369 Remove any string offset. You should normally use the C<SvOOK_off> macro
1376 Perl_sv_backoff(pTHX_ register SV *sv)
1379 assert(SvTYPE(sv) != SVt_PVHV);
1380 assert(SvTYPE(sv) != SVt_PVAV);
1382 const char * const s = SvPVX_const(sv);
1383 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1384 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1386 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1388 SvFLAGS(sv) &= ~SVf_OOK;
1395 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1396 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1397 Use the C<SvGROW> wrapper instead.
1403 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1407 #ifdef HAS_64K_LIMIT
1408 if (newlen >= 0x10000) {
1409 PerlIO_printf(Perl_debug_log,
1410 "Allocation too large: %"UVxf"\n", (UV)newlen);
1413 #endif /* HAS_64K_LIMIT */
1416 if (SvTYPE(sv) < SVt_PV) {
1417 sv_upgrade(sv, SVt_PV);
1418 s = SvPVX_mutable(sv);
1420 else if (SvOOK(sv)) { /* pv is offset? */
1422 s = SvPVX_mutable(sv);
1423 if (newlen > SvLEN(sv))
1424 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1425 #ifdef HAS_64K_LIMIT
1426 if (newlen >= 0x10000)
1431 s = SvPVX_mutable(sv);
1433 if (newlen > SvLEN(sv)) { /* need more room? */
1434 newlen = PERL_STRLEN_ROUNDUP(newlen);
1435 if (SvLEN(sv) && s) {
1437 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1443 s = saferealloc(s, newlen);
1446 s = safemalloc(newlen);
1447 if (SvPVX_const(sv) && SvCUR(sv)) {
1448 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1452 SvLEN_set(sv, newlen);
1458 =for apidoc sv_setiv
1460 Copies an integer into the given SV, upgrading first if necessary.
1461 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1467 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1470 SV_CHECK_THINKFIRST_COW_DROP(sv);
1471 switch (SvTYPE(sv)) {
1473 sv_upgrade(sv, SVt_IV);
1476 sv_upgrade(sv, SVt_PVNV);
1480 sv_upgrade(sv, SVt_PVIV);
1489 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1492 (void)SvIOK_only(sv); /* validate number */
1498 =for apidoc sv_setiv_mg
1500 Like C<sv_setiv>, but also handles 'set' magic.
1506 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1513 =for apidoc sv_setuv
1515 Copies an unsigned integer into the given SV, upgrading first if necessary.
1516 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1522 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1524 /* With these two if statements:
1525 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1528 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1530 If you wish to remove them, please benchmark to see what the effect is
1532 if (u <= (UV)IV_MAX) {
1533 sv_setiv(sv, (IV)u);
1542 =for apidoc sv_setuv_mg
1544 Like C<sv_setuv>, but also handles 'set' magic.
1550 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1559 =for apidoc sv_setnv
1561 Copies a double into the given SV, upgrading first if necessary.
1562 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1568 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1571 SV_CHECK_THINKFIRST_COW_DROP(sv);
1572 switch (SvTYPE(sv)) {
1575 sv_upgrade(sv, SVt_NV);
1580 sv_upgrade(sv, SVt_PVNV);
1589 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1593 (void)SvNOK_only(sv); /* validate number */
1598 =for apidoc sv_setnv_mg
1600 Like C<sv_setnv>, but also handles 'set' magic.
1606 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1612 /* Print an "isn't numeric" warning, using a cleaned-up,
1613 * printable version of the offending string
1617 S_not_a_number(pTHX_ SV *sv)
1625 dsv = sv_2mortal(newSVpvs(""));
1626 pv = sv_uni_display(dsv, sv, 10, 0);
1629 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1630 /* each *s can expand to 4 chars + "...\0",
1631 i.e. need room for 8 chars */
1633 const char *s = SvPVX_const(sv);
1634 const char * const end = s + SvCUR(sv);
1635 for ( ; s < end && d < limit; s++ ) {
1637 if (ch & 128 && !isPRINT_LC(ch)) {
1646 else if (ch == '\r') {
1650 else if (ch == '\f') {
1654 else if (ch == '\\') {
1658 else if (ch == '\0') {
1662 else if (isPRINT_LC(ch))
1679 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1680 "Argument \"%s\" isn't numeric in %s", pv,
1683 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1684 "Argument \"%s\" isn't numeric", pv);
1688 =for apidoc looks_like_number
1690 Test if the content of an SV looks like a number (or is a number).
1691 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1692 non-numeric warning), even if your atof() doesn't grok them.
1698 Perl_looks_like_number(pTHX_ SV *sv)
1700 register const char *sbegin;
1704 sbegin = SvPVX_const(sv);
1707 else if (SvPOKp(sv))
1708 sbegin = SvPV_const(sv, len);
1710 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1711 return grok_number(sbegin, len, NULL);
1714 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1715 until proven guilty, assume that things are not that bad... */
1720 As 64 bit platforms often have an NV that doesn't preserve all bits of
1721 an IV (an assumption perl has been based on to date) it becomes necessary
1722 to remove the assumption that the NV always carries enough precision to
1723 recreate the IV whenever needed, and that the NV is the canonical form.
1724 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1725 precision as a side effect of conversion (which would lead to insanity
1726 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1727 1) to distinguish between IV/UV/NV slots that have cached a valid
1728 conversion where precision was lost and IV/UV/NV slots that have a
1729 valid conversion which has lost no precision
1730 2) to ensure that if a numeric conversion to one form is requested that
1731 would lose precision, the precise conversion (or differently
1732 imprecise conversion) is also performed and cached, to prevent
1733 requests for different numeric formats on the same SV causing
1734 lossy conversion chains. (lossless conversion chains are perfectly
1739 SvIOKp is true if the IV slot contains a valid value
1740 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1741 SvNOKp is true if the NV slot contains a valid value
1742 SvNOK is true only if the NV value is accurate
1745 while converting from PV to NV, check to see if converting that NV to an
1746 IV(or UV) would lose accuracy over a direct conversion from PV to
1747 IV(or UV). If it would, cache both conversions, return NV, but mark
1748 SV as IOK NOKp (ie not NOK).
1750 While converting from PV to IV, check to see if converting that IV to an
1751 NV would lose accuracy over a direct conversion from PV to NV. If it
1752 would, cache both conversions, flag similarly.
1754 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1755 correctly because if IV & NV were set NV *always* overruled.
1756 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1757 changes - now IV and NV together means that the two are interchangeable:
1758 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1760 The benefit of this is that operations such as pp_add know that if
1761 SvIOK is true for both left and right operands, then integer addition
1762 can be used instead of floating point (for cases where the result won't
1763 overflow). Before, floating point was always used, which could lead to
1764 loss of precision compared with integer addition.
1766 * making IV and NV equal status should make maths accurate on 64 bit
1768 * may speed up maths somewhat if pp_add and friends start to use
1769 integers when possible instead of fp. (Hopefully the overhead in
1770 looking for SvIOK and checking for overflow will not outweigh the
1771 fp to integer speedup)
1772 * will slow down integer operations (callers of SvIV) on "inaccurate"
1773 values, as the change from SvIOK to SvIOKp will cause a call into
1774 sv_2iv each time rather than a macro access direct to the IV slot
1775 * should speed up number->string conversion on integers as IV is
1776 favoured when IV and NV are equally accurate
1778 ####################################################################
1779 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1780 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1781 On the other hand, SvUOK is true iff UV.
1782 ####################################################################
1784 Your mileage will vary depending your CPU's relative fp to integer
1788 #ifndef NV_PRESERVES_UV
1789 # define IS_NUMBER_UNDERFLOW_IV 1
1790 # define IS_NUMBER_UNDERFLOW_UV 2
1791 # define IS_NUMBER_IV_AND_UV 2
1792 # define IS_NUMBER_OVERFLOW_IV 4
1793 # define IS_NUMBER_OVERFLOW_UV 5
1795 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1797 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1799 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1802 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1803 if (SvNVX(sv) < (NV)IV_MIN) {
1804 (void)SvIOKp_on(sv);
1806 SvIV_set(sv, IV_MIN);
1807 return IS_NUMBER_UNDERFLOW_IV;
1809 if (SvNVX(sv) > (NV)UV_MAX) {
1810 (void)SvIOKp_on(sv);
1813 SvUV_set(sv, UV_MAX);
1814 return IS_NUMBER_OVERFLOW_UV;
1816 (void)SvIOKp_on(sv);
1818 /* Can't use strtol etc to convert this string. (See truth table in
1820 if (SvNVX(sv) <= (UV)IV_MAX) {
1821 SvIV_set(sv, I_V(SvNVX(sv)));
1822 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1823 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1825 /* Integer is imprecise. NOK, IOKp */
1827 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1830 SvUV_set(sv, U_V(SvNVX(sv)));
1831 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1832 if (SvUVX(sv) == UV_MAX) {
1833 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1834 possibly be preserved by NV. Hence, it must be overflow.
1836 return IS_NUMBER_OVERFLOW_UV;
1838 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1840 /* Integer is imprecise. NOK, IOKp */
1842 return IS_NUMBER_OVERFLOW_IV;
1844 #endif /* !NV_PRESERVES_UV*/
1847 S_sv_2iuv_common(pTHX_ SV *sv) {
1850 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1851 * without also getting a cached IV/UV from it at the same time
1852 * (ie PV->NV conversion should detect loss of accuracy and cache
1853 * IV or UV at same time to avoid this. */
1854 /* IV-over-UV optimisation - choose to cache IV if possible */
1856 if (SvTYPE(sv) == SVt_NV)
1857 sv_upgrade(sv, SVt_PVNV);
1859 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1860 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1861 certainly cast into the IV range at IV_MAX, whereas the correct
1862 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1864 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1865 SvIV_set(sv, I_V(SvNVX(sv)));
1866 if (SvNVX(sv) == (NV) SvIVX(sv)
1867 #ifndef NV_PRESERVES_UV
1868 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1869 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1870 /* Don't flag it as "accurately an integer" if the number
1871 came from a (by definition imprecise) NV operation, and
1872 we're outside the range of NV integer precision */
1875 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1876 DEBUG_c(PerlIO_printf(Perl_debug_log,
1877 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1883 /* IV not precise. No need to convert from PV, as NV
1884 conversion would already have cached IV if it detected
1885 that PV->IV would be better than PV->NV->IV
1886 flags already correct - don't set public IOK. */
1887 DEBUG_c(PerlIO_printf(Perl_debug_log,
1888 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1893 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1894 but the cast (NV)IV_MIN rounds to a the value less (more
1895 negative) than IV_MIN which happens to be equal to SvNVX ??
1896 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1897 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1898 (NV)UVX == NVX are both true, but the values differ. :-(
1899 Hopefully for 2s complement IV_MIN is something like
1900 0x8000000000000000 which will be exact. NWC */
1903 SvUV_set(sv, U_V(SvNVX(sv)));
1905 (SvNVX(sv) == (NV) SvUVX(sv))
1906 #ifndef NV_PRESERVES_UV
1907 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1908 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1909 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1910 /* Don't flag it as "accurately an integer" if the number
1911 came from a (by definition imprecise) NV operation, and
1912 we're outside the range of NV integer precision */
1917 DEBUG_c(PerlIO_printf(Perl_debug_log,
1918 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1924 else if (SvPOKp(sv) && SvLEN(sv)) {
1926 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1927 /* We want to avoid a possible problem when we cache an IV/ a UV which
1928 may be later translated to an NV, and the resulting NV is not
1929 the same as the direct translation of the initial string
1930 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1931 be careful to ensure that the value with the .456 is around if the
1932 NV value is requested in the future).
1934 This means that if we cache such an IV/a UV, we need to cache the
1935 NV as well. Moreover, we trade speed for space, and do not
1936 cache the NV if we are sure it's not needed.
1939 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1940 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1941 == IS_NUMBER_IN_UV) {
1942 /* It's definitely an integer, only upgrade to PVIV */
1943 if (SvTYPE(sv) < SVt_PVIV)
1944 sv_upgrade(sv, SVt_PVIV);
1946 } else if (SvTYPE(sv) < SVt_PVNV)
1947 sv_upgrade(sv, SVt_PVNV);
1949 /* If NVs preserve UVs then we only use the UV value if we know that
1950 we aren't going to call atof() below. If NVs don't preserve UVs
1951 then the value returned may have more precision than atof() will
1952 return, even though value isn't perfectly accurate. */
1953 if ((numtype & (IS_NUMBER_IN_UV
1954 #ifdef NV_PRESERVES_UV
1957 )) == IS_NUMBER_IN_UV) {
1958 /* This won't turn off the public IOK flag if it was set above */
1959 (void)SvIOKp_on(sv);
1961 if (!(numtype & IS_NUMBER_NEG)) {
1963 if (value <= (UV)IV_MAX) {
1964 SvIV_set(sv, (IV)value);
1966 /* it didn't overflow, and it was positive. */
1967 SvUV_set(sv, value);
1971 /* 2s complement assumption */
1972 if (value <= (UV)IV_MIN) {
1973 SvIV_set(sv, -(IV)value);
1975 /* Too negative for an IV. This is a double upgrade, but
1976 I'm assuming it will be rare. */
1977 if (SvTYPE(sv) < SVt_PVNV)
1978 sv_upgrade(sv, SVt_PVNV);
1982 SvNV_set(sv, -(NV)value);
1983 SvIV_set(sv, IV_MIN);
1987 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1988 will be in the previous block to set the IV slot, and the next
1989 block to set the NV slot. So no else here. */
1991 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1992 != IS_NUMBER_IN_UV) {
1993 /* It wasn't an (integer that doesn't overflow the UV). */
1994 SvNV_set(sv, Atof(SvPVX_const(sv)));
1996 if (! numtype && ckWARN(WARN_NUMERIC))
1999 #if defined(USE_LONG_DOUBLE)
2000 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2001 PTR2UV(sv), SvNVX(sv)));
2003 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2004 PTR2UV(sv), SvNVX(sv)));
2007 #ifdef NV_PRESERVES_UV
2008 (void)SvIOKp_on(sv);
2010 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2011 SvIV_set(sv, I_V(SvNVX(sv)));
2012 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2015 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp */
2017 /* UV will not work better than IV */
2019 if (SvNVX(sv) > (NV)UV_MAX) {
2021 /* Integer is inaccurate. NOK, IOKp, is UV */
2022 SvUV_set(sv, UV_MAX);
2024 SvUV_set(sv, U_V(SvNVX(sv)));
2025 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2026 NV preservse UV so can do correct comparison. */
2027 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2030 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp, is UV */
2035 #else /* NV_PRESERVES_UV */
2036 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2037 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2038 /* The IV/UV slot will have been set from value returned by
2039 grok_number above. The NV slot has just been set using
2042 assert (SvIOKp(sv));
2044 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2045 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2046 /* Small enough to preserve all bits. */
2047 (void)SvIOKp_on(sv);
2049 SvIV_set(sv, I_V(SvNVX(sv)));
2050 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2052 /* Assumption: first non-preserved integer is < IV_MAX,
2053 this NV is in the preserved range, therefore: */
2054 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2056 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);
2060 0 0 already failed to read UV.
2061 0 1 already failed to read UV.
2062 1 0 you won't get here in this case. IV/UV
2063 slot set, public IOK, Atof() unneeded.
2064 1 1 already read UV.
2065 so there's no point in sv_2iuv_non_preserve() attempting
2066 to use atol, strtol, strtoul etc. */
2067 sv_2iuv_non_preserve (sv, numtype);
2070 #endif /* NV_PRESERVES_UV */
2074 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2075 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2078 if (SvTYPE(sv) < SVt_IV)
2079 /* Typically the caller expects that sv_any is not NULL now. */
2080 sv_upgrade(sv, SVt_IV);
2081 /* Return 0 from the caller. */
2088 =for apidoc sv_2iv_flags
2090 Return the integer value of an SV, doing any necessary string
2091 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2092 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2098 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2103 if (SvGMAGICAL(sv)) {
2104 if (flags & SV_GMAGIC)
2109 return I_V(SvNVX(sv));
2111 if (SvPOKp(sv) && SvLEN(sv)) {
2114 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2116 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2117 == IS_NUMBER_IN_UV) {
2118 /* It's definitely an integer */
2119 if (numtype & IS_NUMBER_NEG) {
2120 if (value < (UV)IV_MIN)
2123 if (value < (UV)IV_MAX)
2128 if (ckWARN(WARN_NUMERIC))
2131 return I_V(Atof(SvPVX_const(sv)));
2136 assert(SvTYPE(sv) >= SVt_PVMG);
2137 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2138 } else if (SvTHINKFIRST(sv)) {
2142 SV * const tmpstr=AMG_CALLun(sv,numer);
2143 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2144 return SvIV(tmpstr);
2147 return PTR2IV(SvRV(sv));
2150 sv_force_normal_flags(sv, 0);
2152 if (SvREADONLY(sv) && !SvOK(sv)) {
2153 if (ckWARN(WARN_UNINITIALIZED))
2159 if (S_sv_2iuv_common(aTHX_ sv))
2162 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2163 PTR2UV(sv),SvIVX(sv)));
2164 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2168 =for apidoc sv_2uv_flags
2170 Return the unsigned integer value of an SV, doing any necessary string
2171 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2172 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2178 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2183 if (SvGMAGICAL(sv)) {
2184 if (flags & SV_GMAGIC)
2189 return U_V(SvNVX(sv));
2190 if (SvPOKp(sv) && SvLEN(sv)) {
2193 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2195 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2196 == IS_NUMBER_IN_UV) {
2197 /* It's definitely an integer */
2198 if (!(numtype & IS_NUMBER_NEG))
2202 if (ckWARN(WARN_NUMERIC))
2205 return U_V(Atof(SvPVX_const(sv)));
2210 assert(SvTYPE(sv) >= SVt_PVMG);
2211 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2212 } else if (SvTHINKFIRST(sv)) {
2216 SV *const tmpstr = AMG_CALLun(sv,numer);
2217 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2218 return SvUV(tmpstr);
2221 return PTR2UV(SvRV(sv));
2224 sv_force_normal_flags(sv, 0);
2226 if (SvREADONLY(sv) && !SvOK(sv)) {
2227 if (ckWARN(WARN_UNINITIALIZED))
2233 if (S_sv_2iuv_common(aTHX_ sv))
2237 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2238 PTR2UV(sv),SvUVX(sv)));
2239 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2245 Return the num value of an SV, doing any necessary string or integer
2246 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2253 Perl_sv_2nv(pTHX_ register SV *sv)
2258 if (SvGMAGICAL(sv)) {
2262 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2263 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2264 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2266 return Atof(SvPVX_const(sv));
2270 return (NV)SvUVX(sv);
2272 return (NV)SvIVX(sv);
2277 assert(SvTYPE(sv) >= SVt_PVMG);
2278 /* This falls through to the report_uninit near the end of the
2280 } else if (SvTHINKFIRST(sv)) {
2284 SV *const tmpstr = AMG_CALLun(sv,numer);
2285 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2286 return SvNV(tmpstr);
2289 return PTR2NV(SvRV(sv));
2292 sv_force_normal_flags(sv, 0);
2294 if (SvREADONLY(sv) && !SvOK(sv)) {
2295 if (ckWARN(WARN_UNINITIALIZED))
2300 if (SvTYPE(sv) < SVt_NV) {
2301 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2302 sv_upgrade(sv, SVt_NV);
2303 #ifdef USE_LONG_DOUBLE
2305 STORE_NUMERIC_LOCAL_SET_STANDARD();
2306 PerlIO_printf(Perl_debug_log,
2307 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2308 PTR2UV(sv), SvNVX(sv));
2309 RESTORE_NUMERIC_LOCAL();
2313 STORE_NUMERIC_LOCAL_SET_STANDARD();
2314 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2315 PTR2UV(sv), SvNVX(sv));
2316 RESTORE_NUMERIC_LOCAL();
2320 else if (SvTYPE(sv) < SVt_PVNV)
2321 sv_upgrade(sv, SVt_PVNV);
2326 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2327 #ifdef NV_PRESERVES_UV
2330 /* Only set the public NV OK flag if this NV preserves the IV */
2331 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2332 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2333 : (SvIVX(sv) == I_V(SvNVX(sv))))
2339 else if (SvPOKp(sv) && SvLEN(sv)) {
2341 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2342 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2344 #ifdef NV_PRESERVES_UV
2345 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2346 == IS_NUMBER_IN_UV) {
2347 /* It's definitely an integer */
2348 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2350 SvNV_set(sv, Atof(SvPVX_const(sv)));
2353 SvNV_set(sv, Atof(SvPVX_const(sv)));
2354 /* Only set the public NV OK flag if this NV preserves the value in
2355 the PV at least as well as an IV/UV would.
2356 Not sure how to do this 100% reliably. */
2357 /* if that shift count is out of range then Configure's test is
2358 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2360 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2361 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2362 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2363 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2364 /* Can't use strtol etc to convert this string, so don't try.
2365 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2368 /* value has been set. It may not be precise. */
2369 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2370 /* 2s complement assumption for (UV)IV_MIN */
2371 SvNOK_on(sv); /* Integer is too negative. */
2376 if (numtype & IS_NUMBER_NEG) {
2377 SvIV_set(sv, -(IV)value);
2378 } else if (value <= (UV)IV_MAX) {
2379 SvIV_set(sv, (IV)value);
2381 SvUV_set(sv, value);
2385 if (numtype & IS_NUMBER_NOT_INT) {
2386 /* I believe that even if the original PV had decimals,
2387 they are lost beyond the limit of the FP precision.
2388 However, neither is canonical, so both only get p
2389 flags. NWC, 2000/11/25 */
2390 /* Both already have p flags, so do nothing */
2392 const NV nv = SvNVX(sv);
2393 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2394 if (SvIVX(sv) == I_V(nv)) {
2397 /* It had no "." so it must be integer. */
2401 /* between IV_MAX and NV(UV_MAX).
2402 Could be slightly > UV_MAX */
2404 if (numtype & IS_NUMBER_NOT_INT) {
2405 /* UV and NV both imprecise. */
2407 const UV nv_as_uv = U_V(nv);
2409 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2418 #endif /* NV_PRESERVES_UV */
2421 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2423 assert (SvTYPE(sv) >= SVt_NV);
2424 /* Typically the caller expects that sv_any is not NULL now. */
2425 /* XXX Ilya implies that this is a bug in callers that assume this
2426 and ideally should be fixed. */
2429 #if defined(USE_LONG_DOUBLE)
2431 STORE_NUMERIC_LOCAL_SET_STANDARD();
2432 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2433 PTR2UV(sv), SvNVX(sv));
2434 RESTORE_NUMERIC_LOCAL();
2438 STORE_NUMERIC_LOCAL_SET_STANDARD();
2439 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2440 PTR2UV(sv), SvNVX(sv));
2441 RESTORE_NUMERIC_LOCAL();
2447 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2448 * UV as a string towards the end of buf, and return pointers to start and
2451 * We assume that buf is at least TYPE_CHARS(UV) long.
2455 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2457 char *ptr = buf + TYPE_CHARS(UV);
2458 char * const ebuf = ptr;
2471 *--ptr = '0' + (char)(uv % 10);
2479 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2480 * a regexp to its stringified form.
2484 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2486 const regexp * const re = (regexp *)mg->mg_obj;
2489 const char *fptr = "msix";
2494 bool need_newline = 0;
2495 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2497 while((ch = *fptr++)) {
2499 reflags[left++] = ch;
2502 reflags[right--] = ch;
2507 reflags[left] = '-';
2511 mg->mg_len = re->prelen + 4 + left;
2513 * If /x was used, we have to worry about a regex ending with a
2514 * comment later being embedded within another regex. If so, we don't
2515 * want this regex's "commentization" to leak out to the right part of
2516 * the enclosing regex, we must cap it with a newline.
2518 * So, if /x was used, we scan backwards from the end of the regex. If
2519 * we find a '#' before we find a newline, we need to add a newline
2520 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2521 * we don't need to add anything. -jfriedl
2523 if (PMf_EXTENDED & re->reganch) {
2524 const char *endptr = re->precomp + re->prelen;
2525 while (endptr >= re->precomp) {
2526 const char c = *(endptr--);
2528 break; /* don't need another */
2530 /* we end while in a comment, so we need a newline */
2531 mg->mg_len++; /* save space for it */
2532 need_newline = 1; /* note to add it */
2538 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2539 mg->mg_ptr[0] = '(';
2540 mg->mg_ptr[1] = '?';
2541 Copy(reflags, mg->mg_ptr+2, left, char);
2542 *(mg->mg_ptr+left+2) = ':';
2543 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2545 mg->mg_ptr[mg->mg_len - 2] = '\n';
2546 mg->mg_ptr[mg->mg_len - 1] = ')';
2547 mg->mg_ptr[mg->mg_len] = 0;
2549 PL_reginterp_cnt += re->program[0].next_off;
2551 if (re->reganch & ROPT_UTF8)
2561 =for apidoc sv_2pv_flags
2563 Returns a pointer to the string value of an SV, and sets *lp to its length.
2564 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2566 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2567 usually end up here too.
2573 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2583 if (SvGMAGICAL(sv)) {
2584 if (flags & SV_GMAGIC)
2589 if (flags & SV_MUTABLE_RETURN)
2590 return SvPVX_mutable(sv);
2591 if (flags & SV_CONST_RETURN)
2592 return (char *)SvPVX_const(sv);
2595 if (SvIOKp(sv) || SvNOKp(sv)) {
2596 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2600 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2601 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2603 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2610 #ifdef FIXNEGATIVEZERO
2611 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2617 SvUPGRADE(sv, SVt_PV);
2620 s = SvGROW_mutable(sv, len + 1);
2623 return memcpy(s, tbuf, len + 1);
2629 assert(SvTYPE(sv) >= SVt_PVMG);
2630 /* This falls through to the report_uninit near the end of the
2632 } else if (SvTHINKFIRST(sv)) {
2636 SV *const tmpstr = AMG_CALLun(sv,string);
2637 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2639 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2643 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2644 if (flags & SV_CONST_RETURN) {
2645 pv = (char *) SvPVX_const(tmpstr);
2647 pv = (flags & SV_MUTABLE_RETURN)
2648 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2651 *lp = SvCUR(tmpstr);
2653 pv = sv_2pv_flags(tmpstr, lp, flags);
2665 const SV *const referent = (SV*)SvRV(sv);
2668 tsv = sv_2mortal(newSVpvs("NULLREF"));
2669 } else if (SvTYPE(referent) == SVt_PVMG
2670 && ((SvFLAGS(referent) &
2671 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2672 == (SVs_OBJECT|SVs_SMG))
2673 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2674 return stringify_regexp(sv, mg, lp);
2676 const char *const typestr = sv_reftype(referent, 0);
2678 tsv = sv_newmortal();
2679 if (SvOBJECT(referent)) {
2680 const char *const name = HvNAME_get(SvSTASH(referent));
2681 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2682 name ? name : "__ANON__" , typestr,
2686 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2694 if (SvREADONLY(sv) && !SvOK(sv)) {
2695 if (ckWARN(WARN_UNINITIALIZED))
2702 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2703 /* I'm assuming that if both IV and NV are equally valid then
2704 converting the IV is going to be more efficient */
2705 const U32 isIOK = SvIOK(sv);
2706 const U32 isUIOK = SvIsUV(sv);
2707 char buf[TYPE_CHARS(UV)];
2710 if (SvTYPE(sv) < SVt_PVIV)
2711 sv_upgrade(sv, SVt_PVIV);
2712 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2713 /* inlined from sv_setpvn */
2714 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2715 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2716 SvCUR_set(sv, ebuf - ptr);
2726 else if (SvNOKp(sv)) {
2727 const int olderrno = errno;
2728 if (SvTYPE(sv) < SVt_PVNV)
2729 sv_upgrade(sv, SVt_PVNV);
2730 /* The +20 is pure guesswork. Configure test needed. --jhi */
2731 s = SvGROW_mutable(sv, NV_DIG + 20);
2732 /* some Xenix systems wipe out errno here */
2734 if (SvNVX(sv) == 0.0)
2735 (void)strcpy(s,"0");
2739 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2742 #ifdef FIXNEGATIVEZERO
2743 if (*s == '-' && s[1] == '0' && !s[2])
2753 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2757 if (SvTYPE(sv) < SVt_PV)
2758 /* Typically the caller expects that sv_any is not NULL now. */
2759 sv_upgrade(sv, SVt_PV);
2763 const STRLEN len = s - SvPVX_const(sv);
2769 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2770 PTR2UV(sv),SvPVX_const(sv)));
2771 if (flags & SV_CONST_RETURN)
2772 return (char *)SvPVX_const(sv);
2773 if (flags & SV_MUTABLE_RETURN)
2774 return SvPVX_mutable(sv);
2779 =for apidoc sv_copypv
2781 Copies a stringified representation of the source SV into the
2782 destination SV. Automatically performs any necessary mg_get and
2783 coercion of numeric values into strings. Guaranteed to preserve
2784 UTF-8 flag even from overloaded objects. Similar in nature to
2785 sv_2pv[_flags] but operates directly on an SV instead of just the
2786 string. Mostly uses sv_2pv_flags to do its work, except when that
2787 would lose the UTF-8'ness of the PV.
2793 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2796 const char * const s = SvPV_const(ssv,len);
2797 sv_setpvn(dsv,s,len);
2805 =for apidoc sv_2pvbyte
2807 Return a pointer to the byte-encoded representation of the SV, and set *lp
2808 to its length. May cause the SV to be downgraded from UTF-8 as a
2811 Usually accessed via the C<SvPVbyte> macro.
2817 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2819 sv_utf8_downgrade(sv,0);
2820 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2824 =for apidoc sv_2pvutf8
2826 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2827 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2829 Usually accessed via the C<SvPVutf8> macro.
2835 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2837 sv_utf8_upgrade(sv);
2838 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2843 =for apidoc sv_2bool
2845 This function is only called on magical items, and is only used by
2846 sv_true() or its macro equivalent.
2852 Perl_sv_2bool(pTHX_ register SV *sv)
2861 SV * const tmpsv = AMG_CALLun(sv,bool_);
2862 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2863 return (bool)SvTRUE(tmpsv);
2865 return SvRV(sv) != 0;
2868 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2870 (*sv->sv_u.svu_pv > '0' ||
2871 Xpvtmp->xpv_cur > 1 ||
2872 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2879 return SvIVX(sv) != 0;
2882 return SvNVX(sv) != 0.0;
2890 =for apidoc sv_utf8_upgrade
2892 Converts the PV of an SV to its UTF-8-encoded form.
2893 Forces the SV to string form if it is not already.
2894 Always sets the SvUTF8 flag to avoid future validity checks even
2895 if all the bytes have hibit clear.
2897 This is not as a general purpose byte encoding to Unicode interface:
2898 use the Encode extension for that.
2900 =for apidoc sv_utf8_upgrade_flags
2902 Converts the PV of an SV to its UTF-8-encoded form.
2903 Forces the SV to string form if it is not already.
2904 Always sets the SvUTF8 flag to avoid future validity checks even
2905 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2906 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2907 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2909 This is not as a general purpose byte encoding to Unicode interface:
2910 use the Encode extension for that.
2916 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2919 if (sv == &PL_sv_undef)
2923 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2924 (void) sv_2pv_flags(sv,&len, flags);
2928 (void) SvPV_force(sv,len);
2937 sv_force_normal_flags(sv, 0);
2940 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2941 sv_recode_to_utf8(sv, PL_encoding);
2942 else { /* Assume Latin-1/EBCDIC */
2943 /* This function could be much more efficient if we
2944 * had a FLAG in SVs to signal if there are any hibit
2945 * chars in the PV. Given that there isn't such a flag
2946 * make the loop as fast as possible. */
2947 const U8 * const s = (U8 *) SvPVX_const(sv);
2948 const U8 * const e = (U8 *) SvEND(sv);
2953 /* Check for hi bit */
2954 if (!NATIVE_IS_INVARIANT(ch)) {
2955 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2956 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2958 SvPV_free(sv); /* No longer using what was there before. */
2959 SvPV_set(sv, (char*)recoded);
2960 SvCUR_set(sv, len - 1);
2961 SvLEN_set(sv, len); /* No longer know the real size. */
2965 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2972 =for apidoc sv_utf8_downgrade
2974 Attempts to convert the PV of an SV from characters to bytes.
2975 If the PV contains a character beyond byte, this conversion will fail;
2976 in this case, either returns false or, if C<fail_ok> is not
2979 This is not as a general purpose Unicode to byte encoding interface:
2980 use the Encode extension for that.
2986 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2989 if (SvPOKp(sv) && SvUTF8(sv)) {
2995 sv_force_normal_flags(sv, 0);
2997 s = (U8 *) SvPV(sv, len);
2998 if (!utf8_to_bytes(s, &len)) {
3003 Perl_croak(aTHX_ "Wide character in %s",
3006 Perl_croak(aTHX_ "Wide character");
3017 =for apidoc sv_utf8_encode
3019 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3020 flag off so that it looks like octets again.
3026 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3028 (void) sv_utf8_upgrade(sv);
3030 sv_force_normal_flags(sv, 0);
3032 if (SvREADONLY(sv)) {
3033 Perl_croak(aTHX_ PL_no_modify);
3039 =for apidoc sv_utf8_decode
3041 If the PV of the SV is an octet sequence in UTF-8
3042 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3043 so that it looks like a character. If the PV contains only single-byte
3044 characters, the C<SvUTF8> flag stays being off.
3045 Scans PV for validity and returns false if the PV is invalid UTF-8.
3051 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3057 /* The octets may have got themselves encoded - get them back as
3060 if (!sv_utf8_downgrade(sv, TRUE))
3063 /* it is actually just a matter of turning the utf8 flag on, but
3064 * we want to make sure everything inside is valid utf8 first.
3066 c = (const U8 *) SvPVX_const(sv);
3067 if (!is_utf8_string(c, SvCUR(sv)+1))
3069 e = (const U8 *) SvEND(sv);
3072 if (!UTF8_IS_INVARIANT(ch)) {
3082 =for apidoc sv_setsv
3084 Copies the contents of the source SV C<ssv> into the destination SV
3085 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3086 function if the source SV needs to be reused. Does not handle 'set' magic.
3087 Loosely speaking, it performs a copy-by-value, obliterating any previous
3088 content of the destination.
3090 You probably want to use one of the assortment of wrappers, such as
3091 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3092 C<SvSetMagicSV_nosteal>.
3094 =for apidoc sv_setsv_flags
3096 Copies the contents of the source SV C<ssv> into the destination SV
3097 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3098 function if the source SV needs to be reused. Does not handle 'set' magic.
3099 Loosely speaking, it performs a copy-by-value, obliterating any previous
3100 content of the destination.
3101 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3102 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3103 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3104 and C<sv_setsv_nomg> are implemented in terms of this function.
3106 You probably want to use one of the assortment of wrappers, such as
3107 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3108 C<SvSetMagicSV_nosteal>.
3110 This is the primary function for copying scalars, and most other
3111 copy-ish functions and macros use this underneath.
3117 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3119 if (dtype != SVt_PVGV) {
3120 const char * const name = GvNAME(sstr);
3121 const STRLEN len = GvNAMELEN(sstr);
3122 /* don't upgrade SVt_PVLV: it can hold a glob */
3123 if (dtype != SVt_PVLV)
3124 sv_upgrade(dstr, SVt_PVGV);
3125 sv_magic(dstr, dstr, PERL_MAGIC_glob, NULL, 0);
3126 GvSTASH(dstr) = GvSTASH(sstr);
3128 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3129 GvNAME(dstr) = savepvn(name, len);
3130 GvNAMELEN(dstr) = len;
3131 SvFAKE_on(dstr); /* can coerce to non-glob */
3134 #ifdef GV_UNIQUE_CHECK
3135 if (GvUNIQUE((GV*)dstr)) {
3136 Perl_croak(aTHX_ PL_no_modify);
3140 (void)SvOK_off(dstr);
3141 GvINTRO_off(dstr); /* one-shot flag */
3143 GvGP(dstr) = gp_ref(GvGP(sstr));
3144 if (SvTAINTED(sstr))
3146 if (GvIMPORTED(dstr) != GVf_IMPORTED
3147 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3149 GvIMPORTED_on(dstr);
3156 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3157 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3159 const int intro = GvINTRO(dstr);
3162 const U32 stype = SvTYPE(sref);
3165 #ifdef GV_UNIQUE_CHECK
3166 if (GvUNIQUE((GV*)dstr)) {
3167 Perl_croak(aTHX_ PL_no_modify);
3172 GvINTRO_off(dstr); /* one-shot flag */
3173 GvLINE(dstr) = CopLINE(PL_curcop);
3174 GvEGV(dstr) = (GV*)dstr;
3179 location = (SV **) &GvCV(dstr);
3180 import_flag = GVf_IMPORTED_CV;
3183 location = (SV **) &GvHV(dstr);
3184 import_flag = GVf_IMPORTED_HV;
3187 location = (SV **) &GvAV(dstr);
3188 import_flag = GVf_IMPORTED_AV;
3191 location = (SV **) &GvIOp(dstr);
3194 location = (SV **) &GvFORM(dstr);
3196 location = &GvSV(dstr);
3197 import_flag = GVf_IMPORTED_SV;
3200 if (stype == SVt_PVCV) {
3201 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3202 SvREFCNT_dec(GvCV(dstr));
3204 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3205 PL_sub_generation++;
3208 SAVEGENERICSV(*location);
3212 if (stype == SVt_PVCV && *location != sref) {
3213 CV* const cv = (CV*)*location;
3215 if (!GvCVGEN((GV*)dstr) &&
3216 (CvROOT(cv) || CvXSUB(cv)))
3218 /* Redefining a sub - warning is mandatory if
3219 it was a const and its value changed. */
3220 if (CvCONST(cv) && CvCONST((CV*)sref)
3221 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3223 /* They are 2 constant subroutines generated from
3224 the same constant. This probably means that
3225 they are really the "same" proxy subroutine
3226 instantiated in 2 places. Most likely this is
3227 when a constant is exported twice. Don't warn.
3230 else if (ckWARN(WARN_REDEFINE)
3232 && (!CvCONST((CV*)sref)
3233 || sv_cmp(cv_const_sv(cv),
3234 cv_const_sv((CV*)sref))))) {
3235 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3237 ? "Constant subroutine %s::%s redefined"
3238 : "Subroutine %s::%s redefined",
3239 HvNAME_get(GvSTASH((GV*)dstr)),
3240 GvENAME((GV*)dstr));
3244 cv_ckproto(cv, (GV*)dstr,
3245 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3247 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3248 GvASSUMECV_on(dstr);
3249 PL_sub_generation++;
3252 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3253 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3254 GvFLAGS(dstr) |= import_flag;
3260 if (SvTAINTED(sstr))
3266 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3269 register U32 sflags;
3275 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3277 sstr = &PL_sv_undef;
3278 stype = SvTYPE(sstr);
3279 dtype = SvTYPE(dstr);
3284 /* need to nuke the magic */
3286 SvRMAGICAL_off(dstr);
3289 /* There's a lot of redundancy below but we're going for speed here */
3294 if (dtype != SVt_PVGV) {
3295 (void)SvOK_off(dstr);
3303 sv_upgrade(dstr, SVt_IV);
3306 sv_upgrade(dstr, SVt_PVNV);
3310 sv_upgrade(dstr, SVt_PVIV);
3313 (void)SvIOK_only(dstr);
3314 SvIV_set(dstr, SvIVX(sstr));
3317 /* SvTAINTED can only be true if the SV has taint magic, which in
3318 turn means that the SV type is PVMG (or greater). This is the
3319 case statement for SVt_IV, so this cannot be true (whatever gcov
3321 assert(!SvTAINTED(sstr));
3331 sv_upgrade(dstr, SVt_NV);
3336 sv_upgrade(dstr, SVt_PVNV);
3339 SvNV_set(dstr, SvNVX(sstr));
3340 (void)SvNOK_only(dstr);
3341 /* SvTAINTED can only be true if the SV has taint magic, which in
3342 turn means that the SV type is PVMG (or greater). This is the
3343 case statement for SVt_NV, so this cannot be true (whatever gcov
3345 assert(!SvTAINTED(sstr));
3352 sv_upgrade(dstr, SVt_RV);
3355 #ifdef PERL_OLD_COPY_ON_WRITE
3356 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3357 if (dtype < SVt_PVIV)
3358 sv_upgrade(dstr, SVt_PVIV);
3365 sv_upgrade(dstr, SVt_PV);
3368 if (dtype < SVt_PVIV)
3369 sv_upgrade(dstr, SVt_PVIV);
3372 if (dtype < SVt_PVNV)
3373 sv_upgrade(dstr, SVt_PVNV);
3380 const char * const type = sv_reftype(sstr,0);
3382 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3384 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3389 if (dtype <= SVt_PVGV) {
3390 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3396 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3398 if ((int)SvTYPE(sstr) != stype) {
3399 stype = SvTYPE(sstr);
3400 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3401 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3406 if (stype == SVt_PVLV)
3407 SvUPGRADE(dstr, SVt_PVNV);
3409 SvUPGRADE(dstr, (U32)stype);
3412 sflags = SvFLAGS(sstr);
3414 if (sflags & SVf_ROK) {
3415 if (dtype == SVt_PVGV &&
3416 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3419 if (GvIMPORTED(dstr) != GVf_IMPORTED
3420 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3422 GvIMPORTED_on(dstr);
3427 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3431 if (dtype >= SVt_PV) {
3432 if (dtype == SVt_PVGV) {
3433 S_glob_assign_ref(aTHX_ dstr, sstr);
3436 if (SvPVX_const(dstr)) {
3442 (void)SvOK_off(dstr);
3443 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3444 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3445 assert(!(sflags & SVp_NOK));
3446 assert(!(sflags & SVp_IOK));
3447 assert(!(sflags & SVf_NOK));
3448 assert(!(sflags & SVf_IOK));
3450 else if (sflags & SVp_POK) {
3454 * Check to see if we can just swipe the string. If so, it's a
3455 * possible small lose on short strings, but a big win on long ones.
3456 * It might even be a win on short strings if SvPVX_const(dstr)
3457 * has to be allocated and SvPVX_const(sstr) has to be freed.
3460 /* Whichever path we take through the next code, we want this true,
3461 and doing it now facilitates the COW check. */
3462 (void)SvPOK_only(dstr);
3465 /* We're not already COW */
3466 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3467 #ifndef PERL_OLD_COPY_ON_WRITE
3468 /* or we are, but dstr isn't a suitable target. */
3469 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3474 (sflags & SVs_TEMP) && /* slated for free anyway? */
3475 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3476 (!(flags & SV_NOSTEAL)) &&
3477 /* and we're allowed to steal temps */
3478 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3479 SvLEN(sstr) && /* and really is a string */
3480 /* and won't be needed again, potentially */
3481 !(PL_op && PL_op->op_type == OP_AASSIGN))
3482 #ifdef PERL_OLD_COPY_ON_WRITE
3483 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3484 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3485 && SvTYPE(sstr) >= SVt_PVIV)
3488 /* Failed the swipe test, and it's not a shared hash key either.
3489 Have to copy the string. */
3490 STRLEN len = SvCUR(sstr);
3491 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3492 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3493 SvCUR_set(dstr, len);
3494 *SvEND(dstr) = '\0';
3496 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3498 /* Either it's a shared hash key, or it's suitable for
3499 copy-on-write or we can swipe the string. */
3501 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3505 #ifdef PERL_OLD_COPY_ON_WRITE
3507 /* I believe I should acquire a global SV mutex if
3508 it's a COW sv (not a shared hash key) to stop
3509 it going un copy-on-write.
3510 If the source SV has gone un copy on write between up there
3511 and down here, then (assert() that) it is of the correct
3512 form to make it copy on write again */
3513 if ((sflags & (SVf_FAKE | SVf_READONLY))
3514 != (SVf_FAKE | SVf_READONLY)) {
3515 SvREADONLY_on(sstr);
3517 /* Make the source SV into a loop of 1.
3518 (about to become 2) */
3519 SV_COW_NEXT_SV_SET(sstr, sstr);
3523 /* Initial code is common. */
3524 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3529 /* making another shared SV. */
3530 STRLEN cur = SvCUR(sstr);
3531 STRLEN len = SvLEN(sstr);
3532 #ifdef PERL_OLD_COPY_ON_WRITE
3534 assert (SvTYPE(dstr) >= SVt_PVIV);
3535 /* SvIsCOW_normal */
3536 /* splice us in between source and next-after-source. */
3537 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3538 SV_COW_NEXT_SV_SET(sstr, dstr);
3539 SvPV_set(dstr, SvPVX_mutable(sstr));
3543 /* SvIsCOW_shared_hash */
3544 DEBUG_C(PerlIO_printf(Perl_debug_log,
3545 "Copy on write: Sharing hash\n"));
3547 assert (SvTYPE(dstr) >= SVt_PV);
3549 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3551 SvLEN_set(dstr, len);
3552 SvCUR_set(dstr, cur);
3553 SvREADONLY_on(dstr);
3555 /* Relesase a global SV mutex. */
3558 { /* Passes the swipe test. */
3559 SvPV_set(dstr, SvPVX_mutable(sstr));
3560 SvLEN_set(dstr, SvLEN(sstr));
3561 SvCUR_set(dstr, SvCUR(sstr));
3564 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3565 SvPV_set(sstr, NULL);
3571 if (sflags & SVp_NOK) {
3572 SvNV_set(dstr, SvNVX(sstr));
3574 if (sflags & SVp_IOK) {
3575 SvRELEASE_IVX(dstr);
3576 SvIV_set(dstr, SvIVX(sstr));
3577 /* Must do this otherwise some other overloaded use of 0x80000000
3578 gets confused. I guess SVpbm_VALID */
3579 if (sflags & SVf_IVisUV)
3582 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3584 const MAGIC * const smg = SvVOK(sstr);
3586 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3587 smg->mg_ptr, smg->mg_len);
3588 SvRMAGICAL_on(dstr);
3592 else if (sflags & (SVp_IOK|SVp_NOK)) {
3593 (void)SvOK_off(dstr);
3594 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3595 if (sflags & SVp_IOK) {
3596 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3597 SvIV_set(dstr, SvIVX(sstr));
3599 if (sflags & SVp_NOK) {
3600 SvNV_set(dstr, SvNVX(sstr));
3604 if (dtype == SVt_PVGV) {
3605 if (ckWARN(WARN_MISC))
3606 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3609 (void)SvOK_off(dstr);
3611 if (SvTAINTED(sstr))
3616 =for apidoc sv_setsv_mg
3618 Like C<sv_setsv>, but also handles 'set' magic.
3624 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3626 sv_setsv(dstr,sstr);
3630 #ifdef PERL_OLD_COPY_ON_WRITE
3632 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3634 STRLEN cur = SvCUR(sstr);
3635 STRLEN len = SvLEN(sstr);
3636 register char *new_pv;
3639 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3647 if (SvTHINKFIRST(dstr))
3648 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3649 else if (SvPVX_const(dstr))
3650 Safefree(SvPVX_const(dstr));
3654 SvUPGRADE(dstr, SVt_PVIV);
3656 assert (SvPOK(sstr));
3657 assert (SvPOKp(sstr));
3658 assert (!SvIOK(sstr));
3659 assert (!SvIOKp(sstr));
3660 assert (!SvNOK(sstr));
3661 assert (!SvNOKp(sstr));
3663 if (SvIsCOW(sstr)) {
3665 if (SvLEN(sstr) == 0) {
3666 /* source is a COW shared hash key. */
3667 DEBUG_C(PerlIO_printf(Perl_debug_log,
3668 "Fast copy on write: Sharing hash\n"));
3669 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3672 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3674 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3675 SvUPGRADE(sstr, SVt_PVIV);
3676 SvREADONLY_on(sstr);
3678 DEBUG_C(PerlIO_printf(Perl_debug_log,
3679 "Fast copy on write: Converting sstr to COW\n"));
3680 SV_COW_NEXT_SV_SET(dstr, sstr);
3682 SV_COW_NEXT_SV_SET(sstr, dstr);
3683 new_pv = SvPVX_mutable(sstr);
3686 SvPV_set(dstr, new_pv);
3687 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3690 SvLEN_set(dstr, len);
3691 SvCUR_set(dstr, cur);
3700 =for apidoc sv_setpvn
3702 Copies a string into an SV. The C<len> parameter indicates the number of
3703 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3704 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3710 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3713 register char *dptr;
3715 SV_CHECK_THINKFIRST_COW_DROP(sv);
3721 /* len is STRLEN which is unsigned, need to copy to signed */
3724 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3726 SvUPGRADE(sv, SVt_PV);
3728 dptr = SvGROW(sv, len + 1);
3729 Move(ptr,dptr,len,char);
3732 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3737 =for apidoc sv_setpvn_mg
3739 Like C<sv_setpvn>, but also handles 'set' magic.
3745 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3747 sv_setpvn(sv,ptr,len);
3752 =for apidoc sv_setpv
3754 Copies a string into an SV. The string must be null-terminated. Does not
3755 handle 'set' magic. See C<sv_setpv_mg>.
3761 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3764 register STRLEN len;
3766 SV_CHECK_THINKFIRST_COW_DROP(sv);
3772 SvUPGRADE(sv, SVt_PV);
3774 SvGROW(sv, len + 1);
3775 Move(ptr,SvPVX(sv),len+1,char);
3777 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3782 =for apidoc sv_setpv_mg
3784 Like C<sv_setpv>, but also handles 'set' magic.
3790 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3797 =for apidoc sv_usepvn
3799 Tells an SV to use C<ptr> to find its string value. Normally the string is
3800 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3801 The C<ptr> should point to memory that was allocated by C<malloc>. The
3802 string length, C<len>, must be supplied. This function will realloc the
3803 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3804 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3805 See C<sv_usepvn_mg>.
3811 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3815 SV_CHECK_THINKFIRST_COW_DROP(sv);
3816 SvUPGRADE(sv, SVt_PV);
3821 if (SvPVX_const(sv))
3824 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3825 ptr = saferealloc (ptr, allocate);
3828 SvLEN_set(sv, allocate);
3830 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3835 =for apidoc sv_usepvn_mg
3837 Like C<sv_usepvn>, but also handles 'set' magic.
3843 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3845 sv_usepvn(sv,ptr,len);
3849 #ifdef PERL_OLD_COPY_ON_WRITE
3850 /* Need to do this *after* making the SV normal, as we need the buffer
3851 pointer to remain valid until after we've copied it. If we let go too early,
3852 another thread could invalidate it by unsharing last of the same hash key
3853 (which it can do by means other than releasing copy-on-write Svs)
3854 or by changing the other copy-on-write SVs in the loop. */
3856 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3858 if (len) { /* this SV was SvIsCOW_normal(sv) */
3859 /* we need to find the SV pointing to us. */
3860 SV *current = SV_COW_NEXT_SV(after);
3862 if (current == sv) {
3863 /* The SV we point to points back to us (there were only two of us
3865 Hence other SV is no longer copy on write either. */
3867 SvREADONLY_off(after);
3869 /* We need to follow the pointers around the loop. */
3871 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3874 /* don't loop forever if the structure is bust, and we have
3875 a pointer into a closed loop. */
3876 assert (current != after);
3877 assert (SvPVX_const(current) == pvx);
3879 /* Make the SV before us point to the SV after us. */
3880 SV_COW_NEXT_SV_SET(current, after);
3883 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3888 Perl_sv_release_IVX(pTHX_ register SV *sv)
3891 sv_force_normal_flags(sv, 0);
3897 =for apidoc sv_force_normal_flags
3899 Undo various types of fakery on an SV: if the PV is a shared string, make
3900 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3901 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3902 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3903 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3904 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3905 set to some other value.) In addition, the C<flags> parameter gets passed to
3906 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3907 with flags set to 0.
3913 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3916 #ifdef PERL_OLD_COPY_ON_WRITE
3917 if (SvREADONLY(sv)) {
3918 /* At this point I believe I should acquire a global SV mutex. */
3920 const char * const pvx = SvPVX_const(sv);
3921 const STRLEN len = SvLEN(sv);
3922 const STRLEN cur = SvCUR(sv);
3923 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3925 PerlIO_printf(Perl_debug_log,
3926 "Copy on write: Force normal %ld\n",
3932 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3935 if (flags & SV_COW_DROP_PV) {
3936 /* OK, so we don't need to copy our buffer. */
3939 SvGROW(sv, cur + 1);
3940 Move(pvx,SvPVX(sv),cur,char);
3944 sv_release_COW(sv, pvx, len, next);
3949 else if (IN_PERL_RUNTIME)
3950 Perl_croak(aTHX_ PL_no_modify);
3951 /* At this point I believe that I can drop the global SV mutex. */
3954 if (SvREADONLY(sv)) {
3956 const char * const pvx = SvPVX_const(sv);
3957 const STRLEN len = SvCUR(sv);
3962 SvGROW(sv, len + 1);
3963 Move(pvx,SvPVX(sv),len,char);
3965 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3967 else if (IN_PERL_RUNTIME)
3968 Perl_croak(aTHX_ PL_no_modify);
3972 sv_unref_flags(sv, flags);
3973 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3980 Efficient removal of characters from the beginning of the string buffer.
3981 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3982 the string buffer. The C<ptr> becomes the first character of the adjusted
3983 string. Uses the "OOK hack".
3984 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3985 refer to the same chunk of data.
3991 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3993 register STRLEN delta;
3994 if (!ptr || !SvPOKp(sv))
3996 delta = ptr - SvPVX_const(sv);
3997 SV_CHECK_THINKFIRST(sv);
3998 if (SvTYPE(sv) < SVt_PVIV)
3999 sv_upgrade(sv,SVt_PVIV);
4002 if (!SvLEN(sv)) { /* make copy of shared string */
4003 const char *pvx = SvPVX_const(sv);
4004 const STRLEN len = SvCUR(sv);
4005 SvGROW(sv, len + 1);
4006 Move(pvx,SvPVX(sv),len,char);
4010 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4011 and we do that anyway inside the SvNIOK_off
4013 SvFLAGS(sv) |= SVf_OOK;
4016 SvLEN_set(sv, SvLEN(sv) - delta);
4017 SvCUR_set(sv, SvCUR(sv) - delta);
4018 SvPV_set(sv, SvPVX(sv) + delta);
4019 SvIV_set(sv, SvIVX(sv) + delta);
4023 =for apidoc sv_catpvn
4025 Concatenates the string onto the end of the string which is in the SV. The
4026 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4027 status set, then the bytes appended should be valid UTF-8.
4028 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4030 =for apidoc sv_catpvn_flags
4032 Concatenates the string onto the end of the string which is in the SV. The
4033 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4034 status set, then the bytes appended should be valid UTF-8.
4035 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4036 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4037 in terms of this function.
4043 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4047 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4049 SvGROW(dsv, dlen + slen + 1);
4051 sstr = SvPVX_const(dsv);
4052 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4053 SvCUR_set(dsv, SvCUR(dsv) + slen);
4055 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4057 if (flags & SV_SMAGIC)
4062 =for apidoc sv_catsv
4064 Concatenates the string from SV C<ssv> onto the end of the string in
4065 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4066 not 'set' magic. See C<sv_catsv_mg>.
4068 =for apidoc sv_catsv_flags
4070 Concatenates the string from SV C<ssv> onto the end of the string in
4071 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4072 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4073 and C<sv_catsv_nomg> are implemented in terms of this function.
4078 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4083 const char *spv = SvPV_const(ssv, slen);
4085 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4086 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4087 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4088 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4089 dsv->sv_flags doesn't have that bit set.
4090 Andy Dougherty 12 Oct 2001
4092 const I32 sutf8 = DO_UTF8(ssv);
4095 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4097 dutf8 = DO_UTF8(dsv);
4099 if (dutf8 != sutf8) {
4101 /* Not modifying source SV, so taking a temporary copy. */
4102 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4104 sv_utf8_upgrade(csv);
4105 spv = SvPV_const(csv, slen);
4108 sv_utf8_upgrade_nomg(dsv);
4110 sv_catpvn_nomg(dsv, spv, slen);
4113 if (flags & SV_SMAGIC)
4118 =for apidoc sv_catpv
4120 Concatenates the string onto the end of the string which is in the SV.
4121 If the SV has the UTF-8 status set, then the bytes appended should be
4122 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4127 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4130 register STRLEN len;
4136 junk = SvPV_force(sv, tlen);
4138 SvGROW(sv, tlen + len + 1);
4140 ptr = SvPVX_const(sv);
4141 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4142 SvCUR_set(sv, SvCUR(sv) + len);
4143 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4148 =for apidoc sv_catpv_mg
4150 Like C<sv_catpv>, but also handles 'set' magic.
4156 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4165 Creates a new SV. A non-zero C<len> parameter indicates the number of
4166 bytes of preallocated string space the SV should have. An extra byte for a
4167 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4168 space is allocated.) The reference count for the new SV is set to 1.
4170 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4171 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4172 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4173 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4174 modules supporting older perls.
4180 Perl_newSV(pTHX_ STRLEN len)
4187 sv_upgrade(sv, SVt_PV);
4188 SvGROW(sv, len + 1);
4193 =for apidoc sv_magicext
4195 Adds magic to an SV, upgrading it if necessary. Applies the
4196 supplied vtable and returns a pointer to the magic added.
4198 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4199 In particular, you can add magic to SvREADONLY SVs, and add more than
4200 one instance of the same 'how'.
4202 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4203 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4204 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4205 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4207 (This is now used as a subroutine by C<sv_magic>.)
4212 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4213 const char* name, I32 namlen)
4218 if (SvTYPE(sv) < SVt_PVMG) {
4219 SvUPGRADE(sv, SVt_PVMG);
4221 Newxz(mg, 1, MAGIC);
4222 mg->mg_moremagic = SvMAGIC(sv);
4223 SvMAGIC_set(sv, mg);
4225 /* Sometimes a magic contains a reference loop, where the sv and
4226 object refer to each other. To prevent a reference loop that
4227 would prevent such objects being freed, we look for such loops
4228 and if we find one we avoid incrementing the object refcount.
4230 Note we cannot do this to avoid self-tie loops as intervening RV must
4231 have its REFCNT incremented to keep it in existence.
4234 if (!obj || obj == sv ||
4235 how == PERL_MAGIC_arylen ||
4236 how == PERL_MAGIC_qr ||
4237 how == PERL_MAGIC_symtab ||
4238 (SvTYPE(obj) == SVt_PVGV &&
4239 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4240 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4241 GvFORM(obj) == (CV*)sv)))
4246 mg->mg_obj = SvREFCNT_inc(obj);
4247 mg->mg_flags |= MGf_REFCOUNTED;
4250 /* Normal self-ties simply pass a null object, and instead of
4251 using mg_obj directly, use the SvTIED_obj macro to produce a
4252 new RV as needed. For glob "self-ties", we are tieing the PVIO
4253 with an RV obj pointing to the glob containing the PVIO. In
4254 this case, to avoid a reference loop, we need to weaken the
4258 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4259 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4265 mg->mg_len = namlen;
4268 mg->mg_ptr = savepvn(name, namlen);
4269 else if (namlen == HEf_SVKEY)
4270 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4272 mg->mg_ptr = (char *) name;
4274 mg->mg_virtual = vtable;
4278 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4283 =for apidoc sv_magic
4285 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4286 then adds a new magic item of type C<how> to the head of the magic list.
4288 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4289 handling of the C<name> and C<namlen> arguments.
4291 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4292 to add more than one instance of the same 'how'.
4298 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4304 #ifdef PERL_OLD_COPY_ON_WRITE
4306 sv_force_normal_flags(sv, 0);
4308 if (SvREADONLY(sv)) {
4310 /* its okay to attach magic to shared strings; the subsequent
4311 * upgrade to PVMG will unshare the string */
4312 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4315 && how != PERL_MAGIC_regex_global
4316 && how != PERL_MAGIC_bm
4317 && how != PERL_MAGIC_fm
4318 && how != PERL_MAGIC_sv
4319 && how != PERL_MAGIC_backref
4322 Perl_croak(aTHX_ PL_no_modify);
4325 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4326 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4327 /* sv_magic() refuses to add a magic of the same 'how' as an
4330 if (how == PERL_MAGIC_taint) {
4332 /* Any scalar which already had taint magic on which someone
4333 (erroneously?) did SvIOK_on() or similar will now be
4334 incorrectly sporting public "OK" flags. */
4335 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4343 vtable = &PL_vtbl_sv;
4345 case PERL_MAGIC_overload:
4346 vtable = &PL_vtbl_amagic;
4348 case PERL_MAGIC_overload_elem:
4349 vtable = &PL_vtbl_amagicelem;
4351 case PERL_MAGIC_overload_table:
4352 vtable = &PL_vtbl_ovrld;
4355 vtable = &PL_vtbl_bm;
4357 case PERL_MAGIC_regdata:
4358 vtable = &PL_vtbl_regdata;
4360 case PERL_MAGIC_regdatum:
4361 vtable = &PL_vtbl_regdatum;
4363 case PERL_MAGIC_env:
4364 vtable = &PL_vtbl_env;
4367 vtable = &PL_vtbl_fm;
4369 case PERL_MAGIC_envelem:
4370 vtable = &PL_vtbl_envelem;
4372 case PERL_MAGIC_regex_global:
4373 vtable = &PL_vtbl_mglob;
4375 case PERL_MAGIC_isa:
4376 vtable = &PL_vtbl_isa;
4378 case PERL_MAGIC_isaelem:
4379 vtable = &PL_vtbl_isaelem;
4381 case PERL_MAGIC_nkeys:
4382 vtable = &PL_vtbl_nkeys;
4384 case PERL_MAGIC_dbfile:
4387 case PERL_MAGIC_dbline:
4388 vtable = &PL_vtbl_dbline;
4390 #ifdef USE_LOCALE_COLLATE
4391 case PERL_MAGIC_collxfrm:
4392 vtable = &PL_vtbl_collxfrm;
4394 #endif /* USE_LOCALE_COLLATE */
4395 case PERL_MAGIC_tied:
4396 vtable = &PL_vtbl_pack;
4398 case PERL_MAGIC_tiedelem:
4399 case PERL_MAGIC_tiedscalar:
4400 vtable = &PL_vtbl_packelem;
4403 vtable = &PL_vtbl_regexp;
4405 case PERL_MAGIC_sig:
4406 vtable = &PL_vtbl_sig;
4408 case PERL_MAGIC_sigelem:
4409 vtable = &PL_vtbl_sigelem;
4411 case PERL_MAGIC_taint:
4412 vtable = &PL_vtbl_taint;
4414 case PERL_MAGIC_uvar:
4415 vtable = &PL_vtbl_uvar;
4417 case PERL_MAGIC_vec:
4418 vtable = &PL_vtbl_vec;
4420 case PERL_MAGIC_arylen_p:
4421 case PERL_MAGIC_rhash:
4422 case PERL_MAGIC_symtab:
4423 case PERL_MAGIC_vstring:
4426 case PERL_MAGIC_utf8:
4427 vtable = &PL_vtbl_utf8;
4429 case PERL_MAGIC_substr:
4430 vtable = &PL_vtbl_substr;
4432 case PERL_MAGIC_defelem:
4433 vtable = &PL_vtbl_defelem;
4435 case PERL_MAGIC_glob:
4436 vtable = &PL_vtbl_glob;
4438 case PERL_MAGIC_arylen:
4439 vtable = &PL_vtbl_arylen;
4441 case PERL_MAGIC_pos:
4442 vtable = &PL_vtbl_pos;
4444 case PERL_MAGIC_backref:
4445 vtable = &PL_vtbl_backref;
4447 case PERL_MAGIC_ext:
4448 /* Reserved for use by extensions not perl internals. */
4449 /* Useful for attaching extension internal data to perl vars. */
4450 /* Note that multiple extensions may clash if magical scalars */
4451 /* etc holding private data from one are passed to another. */
4455 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4458 /* Rest of work is done else where */
4459 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4462 case PERL_MAGIC_taint:
4465 case PERL_MAGIC_ext:
4466 case PERL_MAGIC_dbfile:
4473 =for apidoc sv_unmagic
4475 Removes all magic of type C<type> from an SV.
4481 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4485 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4488 for (mg = *mgp; mg; mg = *mgp) {
4489 if (mg->mg_type == type) {
4490 const MGVTBL* const vtbl = mg->mg_virtual;
4491 *mgp = mg->mg_moremagic;
4492 if (vtbl && vtbl->svt_free)
4493 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4494 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4496 Safefree(mg->mg_ptr);
4497 else if (mg->mg_len == HEf_SVKEY)
4498 SvREFCNT_dec((SV*)mg->mg_ptr);
4499 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4500 Safefree(mg->mg_ptr);
4502 if (mg->mg_flags & MGf_REFCOUNTED)
4503 SvREFCNT_dec(mg->mg_obj);
4507 mgp = &mg->mg_moremagic;
4511 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4512 SvMAGIC_set(sv, NULL);
4519 =for apidoc sv_rvweaken
4521 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4522 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4523 push a back-reference to this RV onto the array of backreferences
4524 associated with that magic.
4530 Perl_sv_rvweaken(pTHX_ SV *sv)
4533 if (!SvOK(sv)) /* let undefs pass */
4536 Perl_croak(aTHX_ "Can't weaken a nonreference");
4537 else if (SvWEAKREF(sv)) {
4538 if (ckWARN(WARN_MISC))
4539 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4543 Perl_sv_add_backref(aTHX_ tsv, sv);
4549 /* Give tsv backref magic if it hasn't already got it, then push a
4550 * back-reference to sv onto the array associated with the backref magic.
4554 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4559 if (SvTYPE(tsv) == SVt_PVHV) {
4560 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4564 /* There is no AV in the offical place - try a fixup. */
4565 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4568 /* Aha. They've got it stowed in magic. Bring it back. */
4569 av = (AV*)mg->mg_obj;
4570 /* Stop mg_free decreasing the refernce count. */
4572 /* Stop mg_free even calling the destructor, given that
4573 there's no AV to free up. */
4575 sv_unmagic(tsv, PERL_MAGIC_backref);
4584 const MAGIC *const mg
4585 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4587 av = (AV*)mg->mg_obj;
4591 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4592 /* av now has a refcnt of 2, which avoids it getting freed
4593 * before us during global cleanup. The extra ref is removed
4594 * by magic_killbackrefs() when tsv is being freed */
4597 if (AvFILLp(av) >= AvMAX(av)) {
4598 av_extend(av, AvFILLp(av)+1);
4600 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4603 /* delete a back-reference to ourselves from the backref magic associated
4604 * with the SV we point to.
4608 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4615 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4616 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4617 /* We mustn't attempt to "fix up" the hash here by moving the
4618 backreference array back to the hv_aux structure, as that is stored
4619 in the main HvARRAY(), and hfreentries assumes that no-one
4620 reallocates HvARRAY() while it is running. */
4623 const MAGIC *const mg
4624 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4626 av = (AV *)mg->mg_obj;
4629 if (PL_in_clean_all)
4631 Perl_croak(aTHX_ "panic: del_backref");
4638 /* We shouldn't be in here more than once, but for paranoia reasons lets
4640 for (i = AvFILLp(av); i >= 0; i--) {
4642 const SSize_t fill = AvFILLp(av);
4644 /* We weren't the last entry.
4645 An unordered list has this property that you can take the
4646 last element off the end to fill the hole, and it's still
4647 an unordered list :-)
4652 AvFILLp(av) = fill - 1;
4658 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4660 SV **svp = AvARRAY(av);
4662 PERL_UNUSED_ARG(sv);
4664 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4665 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4666 if (svp && !SvIS_FREED(av)) {
4667 SV *const *const last = svp + AvFILLp(av);
4669 while (svp <= last) {
4671 SV *const referrer = *svp;
4672 if (SvWEAKREF(referrer)) {
4673 /* XXX Should we check that it hasn't changed? */
4674 SvRV_set(referrer, 0);
4676 SvWEAKREF_off(referrer);
4677 } else if (SvTYPE(referrer) == SVt_PVGV ||
4678 SvTYPE(referrer) == SVt_PVLV) {
4679 /* You lookin' at me? */
4680 assert(GvSTASH(referrer));
4681 assert(GvSTASH(referrer) == (HV*)sv);
4682 GvSTASH(referrer) = 0;
4685 "panic: magic_killbackrefs (flags=%"UVxf")",
4686 (UV)SvFLAGS(referrer));
4694 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4699 =for apidoc sv_insert
4701 Inserts a string at the specified offset/length within the SV. Similar to
4702 the Perl substr() function.
4708 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4713 register char *midend;
4714 register char *bigend;
4720 Perl_croak(aTHX_ "Can't modify non-existent substring");
4721 SvPV_force(bigstr, curlen);
4722 (void)SvPOK_only_UTF8(bigstr);
4723 if (offset + len > curlen) {
4724 SvGROW(bigstr, offset+len+1);
4725 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4726 SvCUR_set(bigstr, offset+len);
4730 i = littlelen - len;
4731 if (i > 0) { /* string might grow */
4732 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4733 mid = big + offset + len;
4734 midend = bigend = big + SvCUR(bigstr);
4737 while (midend > mid) /* shove everything down */
4738 *--bigend = *--midend;
4739 Move(little,big+offset,littlelen,char);
4740 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4745 Move(little,SvPVX(bigstr)+offset,len,char);
4750 big = SvPVX(bigstr);
4753 bigend = big + SvCUR(bigstr);
4755 if (midend > bigend)
4756 Perl_croak(aTHX_ "panic: sv_insert");
4758 if (mid - big > bigend - midend) { /* faster to shorten from end */
4760 Move(little, mid, littlelen,char);
4763 i = bigend - midend;
4765 Move(midend, mid, i,char);
4769 SvCUR_set(bigstr, mid - big);
4771 else if ((i = mid - big)) { /* faster from front */
4772 midend -= littlelen;
4774 sv_chop(bigstr,midend-i);
4779 Move(little, mid, littlelen,char);
4781 else if (littlelen) {
4782 midend -= littlelen;
4783 sv_chop(bigstr,midend);
4784 Move(little,midend,littlelen,char);
4787 sv_chop(bigstr,midend);
4793 =for apidoc sv_replace
4795 Make the first argument a copy of the second, then delete the original.
4796 The target SV physically takes over ownership of the body of the source SV
4797 and inherits its flags; however, the target keeps any magic it owns,
4798 and any magic in the source is discarded.
4799 Note that this is a rather specialist SV copying operation; most of the
4800 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4806 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4809 const U32 refcnt = SvREFCNT(sv);
4810 SV_CHECK_THINKFIRST_COW_DROP(sv);
4811 if (SvREFCNT(nsv) != 1) {
4812 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4813 UVuf " != 1)", (UV) SvREFCNT(nsv));
4815 if (SvMAGICAL(sv)) {
4819 sv_upgrade(nsv, SVt_PVMG);
4820 SvMAGIC_set(nsv, SvMAGIC(sv));
4821 SvFLAGS(nsv) |= SvMAGICAL(sv);
4823 SvMAGIC_set(sv, NULL);
4827 assert(!SvREFCNT(sv));
4828 #ifdef DEBUG_LEAKING_SCALARS
4829 sv->sv_flags = nsv->sv_flags;
4830 sv->sv_any = nsv->sv_any;
4831 sv->sv_refcnt = nsv->sv_refcnt;
4832 sv->sv_u = nsv->sv_u;
4834 StructCopy(nsv,sv,SV);
4836 /* Currently could join these into one piece of pointer arithmetic, but
4837 it would be unclear. */
4838 if(SvTYPE(sv) == SVt_IV)
4840 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4841 else if (SvTYPE(sv) == SVt_RV) {
4842 SvANY(sv) = &sv->sv_u.svu_rv;
4846 #ifdef PERL_OLD_COPY_ON_WRITE
4847 if (SvIsCOW_normal(nsv)) {
4848 /* We need to follow the pointers around the loop to make the
4849 previous SV point to sv, rather than nsv. */
4852 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4855 assert(SvPVX_const(current) == SvPVX_const(nsv));
4857 /* Make the SV before us point to the SV after us. */
4859 PerlIO_printf(Perl_debug_log, "previous is\n");
4861 PerlIO_printf(Perl_debug_log,
4862 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4863 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4865 SV_COW_NEXT_SV_SET(current, sv);
4868 SvREFCNT(sv) = refcnt;
4869 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4875 =for apidoc sv_clear
4877 Clear an SV: call any destructors, free up any memory used by the body,
4878 and free the body itself. The SV's head is I<not> freed, although
4879 its type is set to all 1's so that it won't inadvertently be assumed
4880 to be live during global destruction etc.
4881 This function should only be called when REFCNT is zero. Most of the time
4882 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4889 Perl_sv_clear(pTHX_ register SV *sv)
4892 const U32 type = SvTYPE(sv);
4893 const struct body_details *const sv_type_details
4894 = bodies_by_type + type;
4897 assert(SvREFCNT(sv) == 0);
4899 if (type <= SVt_IV) {
4900 /* See the comment in sv.h about the collusion between this early
4901 return and the overloading of the NULL and IV slots in the size
4907 if (PL_defstash) { /* Still have a symbol table? */
4912 stash = SvSTASH(sv);
4913 destructor = StashHANDLER(stash,DESTROY);
4915 SV* const tmpref = newRV(sv);
4916 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4918 PUSHSTACKi(PERLSI_DESTROY);
4923 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4929 if(SvREFCNT(tmpref) < 2) {
4930 /* tmpref is not kept alive! */
4932 SvRV_set(tmpref, NULL);
4935 SvREFCNT_dec(tmpref);
4937 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4941 if (PL_in_clean_objs)
4942 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4944 /* DESTROY gave object new lease on life */
4950 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4951 SvOBJECT_off(sv); /* Curse the object. */
4952 if (type != SVt_PVIO)
4953 --PL_sv_objcount; /* XXX Might want something more general */
4956 if (type >= SVt_PVMG) {
4959 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4960 SvREFCNT_dec(SvSTASH(sv));
4965 IoIFP(sv) != PerlIO_stdin() &&
4966 IoIFP(sv) != PerlIO_stdout() &&
4967 IoIFP(sv) != PerlIO_stderr())
4969 io_close((IO*)sv, FALSE);
4971 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4972 PerlDir_close(IoDIRP(sv));
4973 IoDIRP(sv) = (DIR*)NULL;
4974 Safefree(IoTOP_NAME(sv));
4975 Safefree(IoFMT_NAME(sv));
4976 Safefree(IoBOTTOM_NAME(sv));
4985 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4992 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4993 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4994 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4995 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4997 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4998 SvREFCNT_dec(LvTARG(sv));
5002 Safefree(GvNAME(sv));
5003 /* If we're in a stash, we don't own a reference to it. However it does
5004 have a back reference to us, which needs to be cleared. */
5006 sv_del_backref((SV*)GvSTASH(sv), sv);
5011 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5013 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5014 /* Don't even bother with turning off the OOK flag. */
5019 SV *target = SvRV(sv);
5021 sv_del_backref(target, sv);
5023 SvREFCNT_dec(target);
5025 #ifdef PERL_OLD_COPY_ON_WRITE
5026 else if (SvPVX_const(sv)) {
5028 /* I believe I need to grab the global SV mutex here and
5029 then recheck the COW status. */
5031 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5034 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5035 SV_COW_NEXT_SV(sv));
5036 /* And drop it here. */
5038 } else if (SvLEN(sv)) {
5039 Safefree(SvPVX_const(sv));
5043 else if (SvPVX_const(sv) && SvLEN(sv))
5044 Safefree(SvPVX_mutable(sv));
5045 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5046 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5055 SvFLAGS(sv) &= SVf_BREAK;
5056 SvFLAGS(sv) |= SVTYPEMASK;
5058 if (sv_type_details->arena) {
5059 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5060 &PL_body_roots[type]);
5062 else if (sv_type_details->body_size) {
5063 my_safefree(SvANY(sv));
5068 =for apidoc sv_newref
5070 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5077 Perl_sv_newref(pTHX_ SV *sv)
5087 Decrement an SV's reference count, and if it drops to zero, call
5088 C<sv_clear> to invoke destructors and free up any memory used by
5089 the body; finally, deallocate the SV's head itself.
5090 Normally called via a wrapper macro C<SvREFCNT_dec>.
5096 Perl_sv_free(pTHX_ SV *sv)
5101 if (SvREFCNT(sv) == 0) {
5102 if (SvFLAGS(sv) & SVf_BREAK)
5103 /* this SV's refcnt has been artificially decremented to
5104 * trigger cleanup */
5106 if (PL_in_clean_all) /* All is fair */
5108 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5109 /* make sure SvREFCNT(sv)==0 happens very seldom */
5110 SvREFCNT(sv) = (~(U32)0)/2;
5113 if (ckWARN_d(WARN_INTERNAL)) {
5114 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5115 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5116 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5117 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5118 Perl_dump_sv_child(aTHX_ sv);
5123 if (--(SvREFCNT(sv)) > 0)
5125 Perl_sv_free2(aTHX_ sv);
5129 Perl_sv_free2(pTHX_ SV *sv)
5134 if (ckWARN_d(WARN_DEBUGGING))
5135 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5136 "Attempt to free temp prematurely: SV 0x%"UVxf
5137 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5141 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5142 /* make sure SvREFCNT(sv)==0 happens very seldom */
5143 SvREFCNT(sv) = (~(U32)0)/2;
5154 Returns the length of the string in the SV. Handles magic and type
5155 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5161 Perl_sv_len(pTHX_ register SV *sv)
5169 len = mg_length(sv);
5171 (void)SvPV_const(sv, len);
5176 =for apidoc sv_len_utf8
5178 Returns the number of characters in the string in an SV, counting wide
5179 UTF-8 bytes as a single character. Handles magic and type coercion.
5185 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5186 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5187 * (Note that the mg_len is not the length of the mg_ptr field.)
5192 Perl_sv_len_utf8(pTHX_ register SV *sv)
5198 return mg_length(sv);
5202 const U8 *s = (U8*)SvPV_const(sv, len);
5203 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5205 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5207 #ifdef PERL_UTF8_CACHE_ASSERT
5208 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5212 ulen = Perl_utf8_length(aTHX_ s, s + len);
5213 if (!mg && !SvREADONLY(sv)) {
5214 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5215 mg = mg_find(sv, PERL_MAGIC_utf8);
5225 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5226 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5227 * between UTF-8 and byte offsets. There are two (substr offset and substr
5228 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5229 * and byte offset) cache positions.
5231 * The mg_len field is used by sv_len_utf8(), see its comments.
5232 * Note that the mg_len is not the length of the mg_ptr field.
5236 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5237 I32 offsetp, const U8 *s, const U8 *start)
5241 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5243 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5247 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5249 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5250 (*mgp)->mg_ptr = (char *) *cachep;
5254 (*cachep)[i] = offsetp;
5255 (*cachep)[i+1] = s - start;
5263 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5264 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5265 * between UTF-8 and byte offsets. See also the comments of
5266 * S_utf8_mg_pos_init().
5270 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, const U8 **sp, const U8 *start, const U8 *send)
5274 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5276 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5277 if (*mgp && (*mgp)->mg_ptr) {
5278 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5279 ASSERT_UTF8_CACHE(*cachep);
5280 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5282 else { /* We will skip to the right spot. */
5287 /* The assumption is that going backward is half
5288 * the speed of going forward (that's where the
5289 * 2 * backw in the below comes from). (The real
5290 * figure of course depends on the UTF-8 data.) */
5292 if ((*cachep)[i] > (STRLEN)uoff) {
5294 backw = (*cachep)[i] - (STRLEN)uoff;
5296 if (forw < 2 * backw)
5299 p = start + (*cachep)[i+1];
5301 /* Try this only for the substr offset (i == 0),
5302 * not for the substr length (i == 2). */
5303 else if (i == 0) { /* (*cachep)[i] < uoff */
5304 const STRLEN ulen = sv_len_utf8(sv);
5306 if ((STRLEN)uoff < ulen) {
5307 forw = (STRLEN)uoff - (*cachep)[i];
5308 backw = ulen - (STRLEN)uoff;
5310 if (forw < 2 * backw)
5311 p = start + (*cachep)[i+1];
5316 /* If the string is not long enough for uoff,
5317 * we could extend it, but not at this low a level. */
5321 if (forw < 2 * backw) {
5328 while (UTF8_IS_CONTINUATION(*p))
5333 /* Update the cache. */
5334 (*cachep)[i] = (STRLEN)uoff;
5335 (*cachep)[i+1] = p - start;
5337 /* Drop the stale "length" cache */
5346 if (found) { /* Setup the return values. */
5347 *offsetp = (*cachep)[i+1];
5348 *sp = start + *offsetp;
5351 *offsetp = send - start;
5353 else if (*sp < start) {
5359 #ifdef PERL_UTF8_CACHE_ASSERT
5364 while (n-- && s < send)
5368 assert(*offsetp == s - start);
5369 assert((*cachep)[0] == (STRLEN)uoff);
5370 assert((*cachep)[1] == *offsetp);
5372 ASSERT_UTF8_CACHE(*cachep);
5381 =for apidoc sv_pos_u2b
5383 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5384 the start of the string, to a count of the equivalent number of bytes; if
5385 lenp is non-zero, it does the same to lenp, but this time starting from
5386 the offset, rather than from the start of the string. Handles magic and
5393 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5394 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5395 * byte offsets. See also the comments of S_utf8_mg_pos().
5400 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5408 start = (U8*)SvPV_const(sv, len);
5411 STRLEN *cache = NULL;
5412 const U8 *s = start;
5413 I32 uoffset = *offsetp;
5414 const U8 * const send = s + len;
5416 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5418 if (!found && uoffset > 0) {
5419 while (s < send && uoffset--)
5423 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5425 *offsetp = s - start;
5430 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5434 if (!found && *lenp > 0) {
5437 while (s < send && ulen--)
5441 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5445 ASSERT_UTF8_CACHE(cache);
5457 =for apidoc sv_pos_b2u
5459 Converts the value pointed to by offsetp from a count of bytes from the
5460 start of the string, to a count of the equivalent number of UTF-8 chars.
5461 Handles magic and type coercion.
5467 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5468 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5469 * byte offsets. See also the comments of S_utf8_mg_pos().
5474 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5482 s = (const U8*)SvPV_const(sv, len);
5483 if ((I32)len < *offsetp)
5484 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5486 const U8* send = s + *offsetp;
5488 STRLEN *cache = NULL;
5492 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5493 mg = mg_find(sv, PERL_MAGIC_utf8);
5494 if (mg && mg->mg_ptr) {
5495 cache = (STRLEN *) mg->mg_ptr;
5496 if (cache[1] == (STRLEN)*offsetp) {
5497 /* An exact match. */
5498 *offsetp = cache[0];
5502 else if (cache[1] < (STRLEN)*offsetp) {
5503 /* We already know part of the way. */
5506 /* Let the below loop do the rest. */
5508 else { /* cache[1] > *offsetp */
5509 /* We already know all of the way, now we may
5510 * be able to walk back. The same assumption
5511 * is made as in S_utf8_mg_pos(), namely that
5512 * walking backward is twice slower than
5513 * walking forward. */
5514 const STRLEN forw = *offsetp;
5515 STRLEN backw = cache[1] - *offsetp;
5517 if (!(forw < 2 * backw)) {
5518 const U8 *p = s + cache[1];
5525 while (UTF8_IS_CONTINUATION(*p)) {
5533 *offsetp = cache[0];
5535 /* Drop the stale "length" cache */
5543 ASSERT_UTF8_CACHE(cache);
5549 /* Call utf8n_to_uvchr() to validate the sequence
5550 * (unless a simple non-UTF character) */
5551 if (!UTF8_IS_INVARIANT(*s))
5552 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5561 if (!SvREADONLY(sv)) {
5563 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5564 mg = mg_find(sv, PERL_MAGIC_utf8);
5569 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5570 mg->mg_ptr = (char *) cache;
5575 cache[1] = *offsetp;
5576 /* Drop the stale "length" cache */
5589 Returns a boolean indicating whether the strings in the two SVs are
5590 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5591 coerce its args to strings if necessary.
5597 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5606 SV* svrecode = NULL;
5613 pv1 = SvPV_const(sv1, cur1);
5620 pv2 = SvPV_const(sv2, cur2);
5622 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5623 /* Differing utf8ness.
5624 * Do not UTF8size the comparands as a side-effect. */
5627 svrecode = newSVpvn(pv2, cur2);
5628 sv_recode_to_utf8(svrecode, PL_encoding);
5629 pv2 = SvPV_const(svrecode, cur2);
5632 svrecode = newSVpvn(pv1, cur1);
5633 sv_recode_to_utf8(svrecode, PL_encoding);
5634 pv1 = SvPV_const(svrecode, cur1);
5636 /* Now both are in UTF-8. */
5638 SvREFCNT_dec(svrecode);
5643 bool is_utf8 = TRUE;
5646 /* sv1 is the UTF-8 one,
5647 * if is equal it must be downgrade-able */
5648 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5654 /* sv2 is the UTF-8 one,
5655 * if is equal it must be downgrade-able */
5656 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5662 /* Downgrade not possible - cannot be eq */
5670 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5673 SvREFCNT_dec(svrecode);
5684 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5685 string in C<sv1> is less than, equal to, or greater than the string in
5686 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5687 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5693 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5697 const char *pv1, *pv2;
5700 SV *svrecode = NULL;
5707 pv1 = SvPV_const(sv1, cur1);
5714 pv2 = SvPV_const(sv2, cur2);
5716 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5717 /* Differing utf8ness.
5718 * Do not UTF8size the comparands as a side-effect. */
5721 svrecode = newSVpvn(pv2, cur2);
5722 sv_recode_to_utf8(svrecode, PL_encoding);
5723 pv2 = SvPV_const(svrecode, cur2);
5726 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5731 svrecode = newSVpvn(pv1, cur1);
5732 sv_recode_to_utf8(svrecode, PL_encoding);
5733 pv1 = SvPV_const(svrecode, cur1);
5736 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5742 cmp = cur2 ? -1 : 0;
5746 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5749 cmp = retval < 0 ? -1 : 1;
5750 } else if (cur1 == cur2) {
5753 cmp = cur1 < cur2 ? -1 : 1;
5758 SvREFCNT_dec(svrecode);
5767 =for apidoc sv_cmp_locale
5769 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5770 'use bytes' aware, handles get magic, and will coerce its args to strings
5771 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5777 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5780 #ifdef USE_LOCALE_COLLATE
5786 if (PL_collation_standard)
5790 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5792 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5794 if (!pv1 || !len1) {
5805 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5808 return retval < 0 ? -1 : 1;
5811 * When the result of collation is equality, that doesn't mean
5812 * that there are no differences -- some locales exclude some
5813 * characters from consideration. So to avoid false equalities,
5814 * we use the raw string as a tiebreaker.
5820 #endif /* USE_LOCALE_COLLATE */
5822 return sv_cmp(sv1, sv2);
5826 #ifdef USE_LOCALE_COLLATE
5829 =for apidoc sv_collxfrm
5831 Add Collate Transform magic to an SV if it doesn't already have it.
5833 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5834 scalar data of the variable, but transformed to such a format that a normal
5835 memory comparison can be used to compare the data according to the locale
5842 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5847 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5848 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5854 Safefree(mg->mg_ptr);
5855 s = SvPV_const(sv, len);
5856 if ((xf = mem_collxfrm(s, len, &xlen))) {
5857 if (SvREADONLY(sv)) {
5860 return xf + sizeof(PL_collation_ix);
5863 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5864 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5877 if (mg && mg->mg_ptr) {
5879 return mg->mg_ptr + sizeof(PL_collation_ix);
5887 #endif /* USE_LOCALE_COLLATE */
5892 Get a line from the filehandle and store it into the SV, optionally
5893 appending to the currently-stored string.
5899 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5904 register STDCHAR rslast;
5905 register STDCHAR *bp;
5911 if (SvTHINKFIRST(sv))
5912 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5913 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5915 However, perlbench says it's slower, because the existing swipe code
5916 is faster than copy on write.
5917 Swings and roundabouts. */
5918 SvUPGRADE(sv, SVt_PV);
5923 if (PerlIO_isutf8(fp)) {
5925 sv_utf8_upgrade_nomg(sv);
5926 sv_pos_u2b(sv,&append,0);
5928 } else if (SvUTF8(sv)) {
5929 SV * const tsv = newSV(0);
5930 sv_gets(tsv, fp, 0);
5931 sv_utf8_upgrade_nomg(tsv);
5932 SvCUR_set(sv,append);
5935 goto return_string_or_null;
5940 if (PerlIO_isutf8(fp))
5943 if (IN_PERL_COMPILETIME) {
5944 /* we always read code in line mode */
5948 else if (RsSNARF(PL_rs)) {
5949 /* If it is a regular disk file use size from stat() as estimate
5950 of amount we are going to read - may result in malloc-ing
5951 more memory than we realy need if layers bellow reduce
5952 size we read (e.g. CRLF or a gzip layer)
5955 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5956 const Off_t offset = PerlIO_tell(fp);
5957 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5958 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5964 else if (RsRECORD(PL_rs)) {
5968 /* Grab the size of the record we're getting */
5969 recsize = SvIV(SvRV(PL_rs));
5970 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5973 /* VMS wants read instead of fread, because fread doesn't respect */
5974 /* RMS record boundaries. This is not necessarily a good thing to be */
5975 /* doing, but we've got no other real choice - except avoid stdio
5976 as implementation - perhaps write a :vms layer ?
5978 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5980 bytesread = PerlIO_read(fp, buffer, recsize);
5984 SvCUR_set(sv, bytesread += append);
5985 buffer[bytesread] = '\0';
5986 goto return_string_or_null;
5988 else if (RsPARA(PL_rs)) {
5994 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5995 if (PerlIO_isutf8(fp)) {
5996 rsptr = SvPVutf8(PL_rs, rslen);
5999 if (SvUTF8(PL_rs)) {
6000 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6001 Perl_croak(aTHX_ "Wide character in $/");
6004 rsptr = SvPV_const(PL_rs, rslen);
6008 rslast = rslen ? rsptr[rslen - 1] : '\0';
6010 if (rspara) { /* have to do this both before and after */
6011 do { /* to make sure file boundaries work right */
6014 i = PerlIO_getc(fp);
6018 PerlIO_ungetc(fp,i);
6024 /* See if we know enough about I/O mechanism to cheat it ! */
6026 /* This used to be #ifdef test - it is made run-time test for ease
6027 of abstracting out stdio interface. One call should be cheap
6028 enough here - and may even be a macro allowing compile
6032 if (PerlIO_fast_gets(fp)) {
6035 * We're going to steal some values from the stdio struct
6036 * and put EVERYTHING in the innermost loop into registers.
6038 register STDCHAR *ptr;
6042 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6043 /* An ungetc()d char is handled separately from the regular
6044 * buffer, so we getc() it back out and stuff it in the buffer.
6046 i = PerlIO_getc(fp);
6047 if (i == EOF) return 0;
6048 *(--((*fp)->_ptr)) = (unsigned char) i;
6052 /* Here is some breathtakingly efficient cheating */
6054 cnt = PerlIO_get_cnt(fp); /* get count into register */
6055 /* make sure we have the room */
6056 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6057 /* Not room for all of it
6058 if we are looking for a separator and room for some
6060 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6061 /* just process what we have room for */
6062 shortbuffered = cnt - SvLEN(sv) + append + 1;
6063 cnt -= shortbuffered;
6067 /* remember that cnt can be negative */
6068 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6073 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6074 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6075 DEBUG_P(PerlIO_printf(Perl_debug_log,
6076 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6077 DEBUG_P(PerlIO_printf(Perl_debug_log,
6078 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6079 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6080 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6085 while (cnt > 0) { /* this | eat */
6087 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6088 goto thats_all_folks; /* screams | sed :-) */
6092 Copy(ptr, bp, cnt, char); /* this | eat */
6093 bp += cnt; /* screams | dust */
6094 ptr += cnt; /* louder | sed :-) */
6099 if (shortbuffered) { /* oh well, must extend */
6100 cnt = shortbuffered;
6102 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6104 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6105 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6109 DEBUG_P(PerlIO_printf(Perl_debug_log,
6110 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6111 PTR2UV(ptr),(long)cnt));
6112 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6114 DEBUG_P(PerlIO_printf(Perl_debug_log,
6115 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6116 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6117 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6119 /* This used to call 'filbuf' in stdio form, but as that behaves like
6120 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6121 another abstraction. */
6122 i = PerlIO_getc(fp); /* get more characters */
6124 DEBUG_P(PerlIO_printf(Perl_debug_log,
6125 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6126 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6127 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6129 cnt = PerlIO_get_cnt(fp);
6130 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6131 DEBUG_P(PerlIO_printf(Perl_debug_log,
6132 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6134 if (i == EOF) /* all done for ever? */
6135 goto thats_really_all_folks;
6137 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6139 SvGROW(sv, bpx + cnt + 2);
6140 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6142 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6144 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6145 goto thats_all_folks;
6149 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6150 memNE((char*)bp - rslen, rsptr, rslen))
6151 goto screamer; /* go back to the fray */
6152 thats_really_all_folks:
6154 cnt += shortbuffered;
6155 DEBUG_P(PerlIO_printf(Perl_debug_log,
6156 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6157 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6158 DEBUG_P(PerlIO_printf(Perl_debug_log,
6159 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6160 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6161 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6163 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6164 DEBUG_P(PerlIO_printf(Perl_debug_log,
6165 "Screamer: done, len=%ld, string=|%.*s|\n",
6166 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6170 /*The big, slow, and stupid way. */
6171 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6172 STDCHAR *buf = NULL;
6173 Newx(buf, 8192, STDCHAR);
6181 register const STDCHAR * const bpe = buf + sizeof(buf);
6183 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6184 ; /* keep reading */
6188 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6189 /* Accomodate broken VAXC compiler, which applies U8 cast to
6190 * both args of ?: operator, causing EOF to change into 255
6193 i = (U8)buf[cnt - 1];
6199 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6201 sv_catpvn(sv, (char *) buf, cnt);
6203 sv_setpvn(sv, (char *) buf, cnt);
6205 if (i != EOF && /* joy */
6207 SvCUR(sv) < rslen ||
6208 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6212 * If we're reading from a TTY and we get a short read,
6213 * indicating that the user hit his EOF character, we need
6214 * to notice it now, because if we try to read from the TTY
6215 * again, the EOF condition will disappear.
6217 * The comparison of cnt to sizeof(buf) is an optimization
6218 * that prevents unnecessary calls to feof().
6222 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6226 #ifdef USE_HEAP_INSTEAD_OF_STACK
6231 if (rspara) { /* have to do this both before and after */
6232 while (i != EOF) { /* to make sure file boundaries work right */
6233 i = PerlIO_getc(fp);
6235 PerlIO_ungetc(fp,i);
6241 return_string_or_null:
6242 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6248 Auto-increment of the value in the SV, doing string to numeric conversion
6249 if necessary. Handles 'get' magic.
6255 Perl_sv_inc(pTHX_ register SV *sv)
6264 if (SvTHINKFIRST(sv)) {
6266 sv_force_normal_flags(sv, 0);
6267 if (SvREADONLY(sv)) {
6268 if (IN_PERL_RUNTIME)
6269 Perl_croak(aTHX_ PL_no_modify);
6273 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6275 i = PTR2IV(SvRV(sv));
6280 flags = SvFLAGS(sv);
6281 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6282 /* It's (privately or publicly) a float, but not tested as an
6283 integer, so test it to see. */
6285 flags = SvFLAGS(sv);
6287 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6288 /* It's publicly an integer, or privately an integer-not-float */
6289 #ifdef PERL_PRESERVE_IVUV
6293 if (SvUVX(sv) == UV_MAX)
6294 sv_setnv(sv, UV_MAX_P1);
6296 (void)SvIOK_only_UV(sv);
6297 SvUV_set(sv, SvUVX(sv) + 1);
6299 if (SvIVX(sv) == IV_MAX)
6300 sv_setuv(sv, (UV)IV_MAX + 1);
6302 (void)SvIOK_only(sv);
6303 SvIV_set(sv, SvIVX(sv) + 1);
6308 if (flags & SVp_NOK) {
6309 (void)SvNOK_only(sv);
6310 SvNV_set(sv, SvNVX(sv) + 1.0);
6314 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6315 if ((flags & SVTYPEMASK) < SVt_PVIV)
6316 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6317 (void)SvIOK_only(sv);
6322 while (isALPHA(*d)) d++;
6323 while (isDIGIT(*d)) d++;
6325 #ifdef PERL_PRESERVE_IVUV
6326 /* Got to punt this as an integer if needs be, but we don't issue
6327 warnings. Probably ought to make the sv_iv_please() that does
6328 the conversion if possible, and silently. */
6329 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6330 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6331 /* Need to try really hard to see if it's an integer.
6332 9.22337203685478e+18 is an integer.
6333 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6334 so $a="9.22337203685478e+18"; $a+0; $a++
6335 needs to be the same as $a="9.22337203685478e+18"; $a++
6342 /* sv_2iv *should* have made this an NV */
6343 if (flags & SVp_NOK) {
6344 (void)SvNOK_only(sv);
6345 SvNV_set(sv, SvNVX(sv) + 1.0);
6348 /* I don't think we can get here. Maybe I should assert this
6349 And if we do get here I suspect that sv_setnv will croak. NWC
6351 #if defined(USE_LONG_DOUBLE)
6352 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",
6353 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6355 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6356 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6359 #endif /* PERL_PRESERVE_IVUV */
6360 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6364 while (d >= SvPVX_const(sv)) {
6372 /* MKS: The original code here died if letters weren't consecutive.
6373 * at least it didn't have to worry about non-C locales. The
6374 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6375 * arranged in order (although not consecutively) and that only
6376 * [A-Za-z] are accepted by isALPHA in the C locale.
6378 if (*d != 'z' && *d != 'Z') {
6379 do { ++*d; } while (!isALPHA(*d));
6382 *(d--) -= 'z' - 'a';
6387 *(d--) -= 'z' - 'a' + 1;
6391 /* oh,oh, the number grew */
6392 SvGROW(sv, SvCUR(sv) + 2);
6393 SvCUR_set(sv, SvCUR(sv) + 1);
6394 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6405 Auto-decrement of the value in the SV, doing string to numeric conversion
6406 if necessary. Handles 'get' magic.
6412 Perl_sv_dec(pTHX_ register SV *sv)
6420 if (SvTHINKFIRST(sv)) {
6422 sv_force_normal_flags(sv, 0);
6423 if (SvREADONLY(sv)) {
6424 if (IN_PERL_RUNTIME)
6425 Perl_croak(aTHX_ PL_no_modify);
6429 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6431 i = PTR2IV(SvRV(sv));
6436 /* Unlike sv_inc we don't have to worry about string-never-numbers
6437 and keeping them magic. But we mustn't warn on punting */
6438 flags = SvFLAGS(sv);
6439 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6440 /* It's publicly an integer, or privately an integer-not-float */
6441 #ifdef PERL_PRESERVE_IVUV
6445 if (SvUVX(sv) == 0) {
6446 (void)SvIOK_only(sv);
6450 (void)SvIOK_only_UV(sv);
6451 SvUV_set(sv, SvUVX(sv) - 1);
6454 if (SvIVX(sv) == IV_MIN)
6455 sv_setnv(sv, (NV)IV_MIN - 1.0);
6457 (void)SvIOK_only(sv);
6458 SvIV_set(sv, SvIVX(sv) - 1);
6463 if (flags & SVp_NOK) {
6464 SvNV_set(sv, SvNVX(sv) - 1.0);
6465 (void)SvNOK_only(sv);
6468 if (!(flags & SVp_POK)) {
6469 if ((flags & SVTYPEMASK) < SVt_PVIV)
6470 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6472 (void)SvIOK_only(sv);
6475 #ifdef PERL_PRESERVE_IVUV
6477 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6478 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6479 /* Need to try really hard to see if it's an integer.
6480 9.22337203685478e+18 is an integer.
6481 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6482 so $a="9.22337203685478e+18"; $a+0; $a--
6483 needs to be the same as $a="9.22337203685478e+18"; $a--
6490 /* sv_2iv *should* have made this an NV */
6491 if (flags & SVp_NOK) {
6492 (void)SvNOK_only(sv);
6493 SvNV_set(sv, SvNVX(sv) - 1.0);
6496 /* I don't think we can get here. Maybe I should assert this
6497 And if we do get here I suspect that sv_setnv will croak. NWC
6499 #if defined(USE_LONG_DOUBLE)
6500 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",
6501 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6503 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6504 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6508 #endif /* PERL_PRESERVE_IVUV */
6509 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6513 =for apidoc sv_mortalcopy
6515 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6516 The new SV is marked as mortal. It will be destroyed "soon", either by an
6517 explicit call to FREETMPS, or by an implicit call at places such as
6518 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6523 /* Make a string that will exist for the duration of the expression
6524 * evaluation. Actually, it may have to last longer than that, but
6525 * hopefully we won't free it until it has been assigned to a
6526 * permanent location. */
6529 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6535 sv_setsv(sv,oldstr);
6537 PL_tmps_stack[++PL_tmps_ix] = sv;
6543 =for apidoc sv_newmortal
6545 Creates a new null SV which is mortal. The reference count of the SV is
6546 set to 1. It will be destroyed "soon", either by an explicit call to
6547 FREETMPS, or by an implicit call at places such as statement boundaries.
6548 See also C<sv_mortalcopy> and C<sv_2mortal>.
6554 Perl_sv_newmortal(pTHX)
6560 SvFLAGS(sv) = SVs_TEMP;
6562 PL_tmps_stack[++PL_tmps_ix] = sv;
6567 =for apidoc sv_2mortal
6569 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6570 by an explicit call to FREETMPS, or by an implicit call at places such as
6571 statement boundaries. SvTEMP() is turned on which means that the SV's
6572 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6573 and C<sv_mortalcopy>.
6579 Perl_sv_2mortal(pTHX_ register SV *sv)
6584 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6587 PL_tmps_stack[++PL_tmps_ix] = sv;
6595 Creates a new SV and copies a string into it. The reference count for the
6596 SV is set to 1. If C<len> is zero, Perl will compute the length using
6597 strlen(). For efficiency, consider using C<newSVpvn> instead.
6603 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6609 sv_setpvn(sv,s,len ? len : strlen(s));
6614 =for apidoc newSVpvn
6616 Creates a new SV and copies a string into it. The reference count for the
6617 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6618 string. You are responsible for ensuring that the source string is at least
6619 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6625 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6631 sv_setpvn(sv,s,len);
6637 =for apidoc newSVhek
6639 Creates a new SV from the hash key structure. It will generate scalars that
6640 point to the shared string table where possible. Returns a new (undefined)
6641 SV if the hek is NULL.
6647 Perl_newSVhek(pTHX_ const HEK *hek)
6657 if (HEK_LEN(hek) == HEf_SVKEY) {
6658 return newSVsv(*(SV**)HEK_KEY(hek));
6660 const int flags = HEK_FLAGS(hek);
6661 if (flags & HVhek_WASUTF8) {
6663 Andreas would like keys he put in as utf8 to come back as utf8
6665 STRLEN utf8_len = HEK_LEN(hek);
6666 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6667 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6670 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6672 } else if (flags & HVhek_REHASH) {
6673 /* We don't have a pointer to the hv, so we have to replicate the
6674 flag into every HEK. This hv is using custom a hasing
6675 algorithm. Hence we can't return a shared string scalar, as
6676 that would contain the (wrong) hash value, and might get passed
6677 into an hv routine with a regular hash */
6679 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6684 /* This will be overwhelminly the most common case. */
6685 return newSVpvn_share(HEK_KEY(hek),
6686 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6692 =for apidoc newSVpvn_share
6694 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6695 table. If the string does not already exist in the table, it is created
6696 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6697 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6698 otherwise the hash is computed. The idea here is that as the string table
6699 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6700 hash lookup will avoid string compare.
6706 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6710 bool is_utf8 = FALSE;
6712 STRLEN tmplen = -len;
6714 /* See the note in hv.c:hv_fetch() --jhi */
6715 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6719 PERL_HASH(hash, src, len);
6721 sv_upgrade(sv, SVt_PV);
6722 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6734 #if defined(PERL_IMPLICIT_CONTEXT)
6736 /* pTHX_ magic can't cope with varargs, so this is a no-context
6737 * version of the main function, (which may itself be aliased to us).
6738 * Don't access this version directly.
6742 Perl_newSVpvf_nocontext(const char* pat, ...)
6747 va_start(args, pat);
6748 sv = vnewSVpvf(pat, &args);
6755 =for apidoc newSVpvf
6757 Creates a new SV and initializes it with the string formatted like
6764 Perl_newSVpvf(pTHX_ const char* pat, ...)
6768 va_start(args, pat);
6769 sv = vnewSVpvf(pat, &args);
6774 /* backend for newSVpvf() and newSVpvf_nocontext() */
6777 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6782 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
6789 Creates a new SV and copies a floating point value into it.
6790 The reference count for the SV is set to 1.
6796 Perl_newSVnv(pTHX_ NV n)
6809 Creates a new SV and copies an integer into it. The reference count for the
6816 Perl_newSViv(pTHX_ IV i)
6829 Creates a new SV and copies an unsigned integer into it.
6830 The reference count for the SV is set to 1.
6836 Perl_newSVuv(pTHX_ UV u)
6847 =for apidoc newRV_noinc
6849 Creates an RV wrapper for an SV. The reference count for the original
6850 SV is B<not> incremented.
6856 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6862 sv_upgrade(sv, SVt_RV);
6864 SvRV_set(sv, tmpRef);
6869 /* newRV_inc is the official function name to use now.
6870 * newRV_inc is in fact #defined to newRV in sv.h
6874 Perl_newRV(pTHX_ SV *tmpRef)
6877 return newRV_noinc(SvREFCNT_inc(tmpRef));
6883 Creates a new SV which is an exact duplicate of the original SV.
6890 Perl_newSVsv(pTHX_ register SV *old)
6897 if (SvTYPE(old) == SVTYPEMASK) {
6898 if (ckWARN_d(WARN_INTERNAL))
6899 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6903 /* SV_GMAGIC is the default for sv_setv()
6904 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6905 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6906 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6911 =for apidoc sv_reset
6913 Underlying implementation for the C<reset> Perl function.
6914 Note that the perl-level function is vaguely deprecated.
6920 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6923 char todo[PERL_UCHAR_MAX+1];
6928 if (!*s) { /* reset ?? searches */
6929 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6931 PMOP *pm = (PMOP *) mg->mg_obj;
6933 pm->op_pmdynflags &= ~PMdf_USED;
6940 /* reset variables */
6942 if (!HvARRAY(stash))
6945 Zero(todo, 256, char);
6948 I32 i = (unsigned char)*s;
6952 max = (unsigned char)*s++;
6953 for ( ; i <= max; i++) {
6956 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6958 for (entry = HvARRAY(stash)[i];
6960 entry = HeNEXT(entry))
6965 if (!todo[(U8)*HeKEY(entry)])
6967 gv = (GV*)HeVAL(entry);
6970 if (SvTHINKFIRST(sv)) {
6971 if (!SvREADONLY(sv) && SvROK(sv))
6973 /* XXX Is this continue a bug? Why should THINKFIRST
6974 exempt us from resetting arrays and hashes? */
6978 if (SvTYPE(sv) >= SVt_PV) {
6980 if (SvPVX_const(sv) != NULL)
6988 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6990 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6993 # if defined(USE_ENVIRON_ARRAY)
6996 # endif /* USE_ENVIRON_ARRAY */
7007 Using various gambits, try to get an IO from an SV: the IO slot if its a
7008 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7009 named after the PV if we're a string.
7015 Perl_sv_2io(pTHX_ SV *sv)
7020 switch (SvTYPE(sv)) {
7028 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7032 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7034 return sv_2io(SvRV(sv));
7035 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7041 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7050 Using various gambits, try to get a CV from an SV; in addition, try if
7051 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7052 The flags in C<lref> are passed to sv_fetchsv.
7058 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7069 switch (SvTYPE(sv)) {
7088 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7089 tryAMAGICunDEREF(to_cv);
7092 if (SvTYPE(sv) == SVt_PVCV) {
7101 Perl_croak(aTHX_ "Not a subroutine reference");
7106 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7112 /* Some flags to gv_fetchsv mean don't really create the GV */
7113 if (SvTYPE(gv) != SVt_PVGV) {
7119 if (lref && !GvCVu(gv)) {
7123 gv_efullname3(tmpsv, gv, NULL);
7124 /* XXX this is probably not what they think they're getting.
7125 * It has the same effect as "sub name;", i.e. just a forward
7127 newSUB(start_subparse(FALSE, 0),
7128 newSVOP(OP_CONST, 0, tmpsv),
7132 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7142 Returns true if the SV has a true value by Perl's rules.
7143 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7144 instead use an in-line version.
7150 Perl_sv_true(pTHX_ register SV *sv)
7155 register const XPV* const tXpv = (XPV*)SvANY(sv);
7157 (tXpv->xpv_cur > 1 ||
7158 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7165 return SvIVX(sv) != 0;
7168 return SvNVX(sv) != 0.0;
7170 return sv_2bool(sv);
7176 =for apidoc sv_pvn_force
7178 Get a sensible string out of the SV somehow.
7179 A private implementation of the C<SvPV_force> macro for compilers which
7180 can't cope with complex macro expressions. Always use the macro instead.
7182 =for apidoc sv_pvn_force_flags
7184 Get a sensible string out of the SV somehow.
7185 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7186 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7187 implemented in terms of this function.
7188 You normally want to use the various wrapper macros instead: see
7189 C<SvPV_force> and C<SvPV_force_nomg>
7195 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7198 if (SvTHINKFIRST(sv) && !SvROK(sv))
7199 sv_force_normal_flags(sv, 0);
7209 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7210 const char * const ref = sv_reftype(sv,0);
7212 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7213 ref, OP_NAME(PL_op));
7215 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7217 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7218 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7220 s = sv_2pv_flags(sv, &len, flags);
7224 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7227 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7228 SvGROW(sv, len + 1);
7229 Move(s,SvPVX(sv),len,char);
7234 SvPOK_on(sv); /* validate pointer */
7236 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7237 PTR2UV(sv),SvPVX_const(sv)));
7240 return SvPVX_mutable(sv);
7244 =for apidoc sv_pvbyten_force
7246 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7252 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7254 sv_pvn_force(sv,lp);
7255 sv_utf8_downgrade(sv,0);
7261 =for apidoc sv_pvutf8n_force
7263 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7269 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7271 sv_pvn_force(sv,lp);
7272 sv_utf8_upgrade(sv);
7278 =for apidoc sv_reftype
7280 Returns a string describing what the SV is a reference to.
7286 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7288 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7289 inside return suggests a const propagation bug in g++. */
7290 if (ob && SvOBJECT(sv)) {
7291 char * const name = HvNAME_get(SvSTASH(sv));
7292 return name ? name : (char *) "__ANON__";
7295 switch (SvTYPE(sv)) {
7312 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7313 /* tied lvalues should appear to be
7314 * scalars for backwards compatitbility */
7315 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7316 ? "SCALAR" : "LVALUE");
7317 case SVt_PVAV: return "ARRAY";
7318 case SVt_PVHV: return "HASH";
7319 case SVt_PVCV: return "CODE";
7320 case SVt_PVGV: return "GLOB";
7321 case SVt_PVFM: return "FORMAT";
7322 case SVt_PVIO: return "IO";
7323 default: return "UNKNOWN";
7329 =for apidoc sv_isobject
7331 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7332 object. If the SV is not an RV, or if the object is not blessed, then this
7339 Perl_sv_isobject(pTHX_ SV *sv)
7355 Returns a boolean indicating whether the SV is blessed into the specified
7356 class. This does not check for subtypes; use C<sv_derived_from> to verify
7357 an inheritance relationship.
7363 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7374 hvname = HvNAME_get(SvSTASH(sv));
7378 return strEQ(hvname, name);
7384 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7385 it will be upgraded to one. If C<classname> is non-null then the new SV will
7386 be blessed in the specified package. The new SV is returned and its
7387 reference count is 1.
7393 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7400 SV_CHECK_THINKFIRST_COW_DROP(rv);
7403 if (SvTYPE(rv) >= SVt_PVMG) {
7404 const U32 refcnt = SvREFCNT(rv);
7408 SvREFCNT(rv) = refcnt;
7411 if (SvTYPE(rv) < SVt_RV)
7412 sv_upgrade(rv, SVt_RV);
7413 else if (SvTYPE(rv) > SVt_RV) {
7424 HV* const stash = gv_stashpv(classname, TRUE);
7425 (void)sv_bless(rv, stash);
7431 =for apidoc sv_setref_pv
7433 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7434 argument will be upgraded to an RV. That RV will be modified to point to
7435 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7436 into the SV. The C<classname> argument indicates the package for the
7437 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7438 will have a reference count of 1, and the RV will be returned.
7440 Do not use with other Perl types such as HV, AV, SV, CV, because those
7441 objects will become corrupted by the pointer copy process.
7443 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7449 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7453 sv_setsv(rv, &PL_sv_undef);
7457 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7462 =for apidoc sv_setref_iv
7464 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7465 argument will be upgraded to an RV. That RV will be modified to point to
7466 the new SV. The C<classname> argument indicates the package for the
7467 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7468 will have a reference count of 1, and the RV will be returned.
7474 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7476 sv_setiv(newSVrv(rv,classname), iv);
7481 =for apidoc sv_setref_uv
7483 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7484 argument will be upgraded to an RV. That RV will be modified to point to
7485 the new SV. The C<classname> argument indicates the package for the
7486 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7487 will have a reference count of 1, and the RV will be returned.
7493 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7495 sv_setuv(newSVrv(rv,classname), uv);
7500 =for apidoc sv_setref_nv
7502 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7503 argument will be upgraded to an RV. That RV will be modified to point to
7504 the new SV. The C<classname> argument indicates the package for the
7505 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7506 will have a reference count of 1, and the RV will be returned.
7512 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7514 sv_setnv(newSVrv(rv,classname), nv);
7519 =for apidoc sv_setref_pvn
7521 Copies a string into a new SV, optionally blessing the SV. The length of the
7522 string must be specified with C<n>. The C<rv> argument will be upgraded to
7523 an RV. That RV will be modified to point to the new SV. The C<classname>
7524 argument indicates the package for the blessing. Set C<classname> to
7525 C<NULL> to avoid the blessing. The new SV will have a reference count
7526 of 1, and the RV will be returned.
7528 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7534 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7536 sv_setpvn(newSVrv(rv,classname), pv, n);
7541 =for apidoc sv_bless
7543 Blesses an SV into a specified package. The SV must be an RV. The package
7544 must be designated by its stash (see C<gv_stashpv()>). The reference count
7545 of the SV is unaffected.
7551 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7556 Perl_croak(aTHX_ "Can't bless non-reference value");
7558 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7559 if (SvREADONLY(tmpRef))
7560 Perl_croak(aTHX_ PL_no_modify);
7561 if (SvOBJECT(tmpRef)) {
7562 if (SvTYPE(tmpRef) != SVt_PVIO)
7564 SvREFCNT_dec(SvSTASH(tmpRef));
7567 SvOBJECT_on(tmpRef);
7568 if (SvTYPE(tmpRef) != SVt_PVIO)
7570 SvUPGRADE(tmpRef, SVt_PVMG);
7571 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7578 if(SvSMAGICAL(tmpRef))
7579 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7587 /* Downgrades a PVGV to a PVMG.
7591 S_sv_unglob(pTHX_ SV *sv)
7596 assert(SvTYPE(sv) == SVt_PVGV);
7601 sv_del_backref((SV*)GvSTASH(sv), sv);
7604 sv_unmagic(sv, PERL_MAGIC_glob);
7605 Safefree(GvNAME(sv));
7608 /* need to keep SvANY(sv) in the right arena */
7609 xpvmg = new_XPVMG();
7610 StructCopy(SvANY(sv), xpvmg, XPVMG);
7611 del_XPVGV(SvANY(sv));
7614 SvFLAGS(sv) &= ~SVTYPEMASK;
7615 SvFLAGS(sv) |= SVt_PVMG;
7619 =for apidoc sv_unref_flags
7621 Unsets the RV status of the SV, and decrements the reference count of
7622 whatever was being referenced by the RV. This can almost be thought of
7623 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7624 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7625 (otherwise the decrementing is conditional on the reference count being
7626 different from one or the reference being a readonly SV).
7633 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7635 SV* const target = SvRV(ref);
7637 if (SvWEAKREF(ref)) {
7638 sv_del_backref(target, ref);
7640 SvRV_set(ref, NULL);
7643 SvRV_set(ref, NULL);
7645 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7646 assigned to as BEGIN {$a = \"Foo"} will fail. */
7647 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7648 SvREFCNT_dec(target);
7649 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7650 sv_2mortal(target); /* Schedule for freeing later */
7654 =for apidoc sv_untaint
7656 Untaint an SV. Use C<SvTAINTED_off> instead.
7661 Perl_sv_untaint(pTHX_ SV *sv)
7663 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7664 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7671 =for apidoc sv_tainted
7673 Test an SV for taintedness. Use C<SvTAINTED> instead.
7678 Perl_sv_tainted(pTHX_ SV *sv)
7680 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7681 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7682 if (mg && (mg->mg_len & 1) )
7689 =for apidoc sv_setpviv
7691 Copies an integer into the given SV, also updating its string value.
7692 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7698 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7700 char buf[TYPE_CHARS(UV)];
7702 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7704 sv_setpvn(sv, ptr, ebuf - ptr);
7708 =for apidoc sv_setpviv_mg
7710 Like C<sv_setpviv>, but also handles 'set' magic.
7716 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7722 #if defined(PERL_IMPLICIT_CONTEXT)
7724 /* pTHX_ magic can't cope with varargs, so this is a no-context
7725 * version of the main function, (which may itself be aliased to us).
7726 * Don't access this version directly.
7730 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7734 va_start(args, pat);
7735 sv_vsetpvf(sv, pat, &args);
7739 /* pTHX_ magic can't cope with varargs, so this is a no-context
7740 * version of the main function, (which may itself be aliased to us).
7741 * Don't access this version directly.
7745 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7749 va_start(args, pat);
7750 sv_vsetpvf_mg(sv, pat, &args);
7756 =for apidoc sv_setpvf
7758 Works like C<sv_catpvf> but copies the text into the SV instead of
7759 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7765 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7768 va_start(args, pat);
7769 sv_vsetpvf(sv, pat, &args);
7774 =for apidoc sv_vsetpvf
7776 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7777 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7779 Usually used via its frontend C<sv_setpvf>.
7785 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7787 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7791 =for apidoc sv_setpvf_mg
7793 Like C<sv_setpvf>, but also handles 'set' magic.
7799 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7802 va_start(args, pat);
7803 sv_vsetpvf_mg(sv, pat, &args);
7808 =for apidoc sv_vsetpvf_mg
7810 Like C<sv_vsetpvf>, but also handles 'set' magic.
7812 Usually used via its frontend C<sv_setpvf_mg>.
7818 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7820 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7824 #if defined(PERL_IMPLICIT_CONTEXT)
7826 /* pTHX_ magic can't cope with varargs, so this is a no-context
7827 * version of the main function, (which may itself be aliased to us).
7828 * Don't access this version directly.
7832 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7836 va_start(args, pat);
7837 sv_vcatpvf(sv, pat, &args);
7841 /* pTHX_ magic can't cope with varargs, so this is a no-context
7842 * version of the main function, (which may itself be aliased to us).
7843 * Don't access this version directly.
7847 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7851 va_start(args, pat);
7852 sv_vcatpvf_mg(sv, pat, &args);
7858 =for apidoc sv_catpvf
7860 Processes its arguments like C<sprintf> and appends the formatted
7861 output to an SV. If the appended data contains "wide" characters
7862 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7863 and characters >255 formatted with %c), the original SV might get
7864 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7865 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7866 valid UTF-8; if the original SV was bytes, the pattern should be too.
7871 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7874 va_start(args, pat);
7875 sv_vcatpvf(sv, pat, &args);
7880 =for apidoc sv_vcatpvf
7882 Processes its arguments like C<vsprintf> and appends the formatted output
7883 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7885 Usually used via its frontend C<sv_catpvf>.
7891 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7893 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7897 =for apidoc sv_catpvf_mg
7899 Like C<sv_catpvf>, but also handles 'set' magic.
7905 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7908 va_start(args, pat);
7909 sv_vcatpvf_mg(sv, pat, &args);
7914 =for apidoc sv_vcatpvf_mg
7916 Like C<sv_vcatpvf>, but also handles 'set' magic.
7918 Usually used via its frontend C<sv_catpvf_mg>.
7924 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7926 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7931 =for apidoc sv_vsetpvfn
7933 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7936 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7942 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7944 sv_setpvn(sv, "", 0);
7945 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7949 S_expect_number(pTHX_ char** pattern)
7953 switch (**pattern) {
7954 case '1': case '2': case '3':
7955 case '4': case '5': case '6':
7956 case '7': case '8': case '9':
7957 var = *(*pattern)++ - '0';
7958 while (isDIGIT(**pattern)) {
7959 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
7961 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7969 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7971 const int neg = nv < 0;
7980 if (uv & 1 && uv == nv)
7981 uv--; /* Round to even */
7983 const unsigned dig = uv % 10;
7996 =for apidoc sv_vcatpvfn
7998 Processes its arguments like C<vsprintf> and appends the formatted output
7999 to an SV. Uses an array of SVs if the C style variable argument list is
8000 missing (NULL). When running with taint checks enabled, indicates via
8001 C<maybe_tainted> if results are untrustworthy (often due to the use of
8004 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8010 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8011 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8012 vec_utf8 = DO_UTF8(vecsv);
8014 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8017 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8025 static const char nullstr[] = "(null)";
8027 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8028 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8030 /* Times 4: a decimal digit takes more than 3 binary digits.
8031 * NV_DIG: mantissa takes than many decimal digits.
8032 * Plus 32: Playing safe. */
8033 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8034 /* large enough for "%#.#f" --chip */
8035 /* what about long double NVs? --jhi */
8037 PERL_UNUSED_ARG(maybe_tainted);
8039 /* no matter what, this is a string now */
8040 (void)SvPV_force(sv, origlen);
8042 /* special-case "", "%s", and "%-p" (SVf - see below) */
8045 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8047 const char * const s = va_arg(*args, char*);
8048 sv_catpv(sv, s ? s : nullstr);
8050 else if (svix < svmax) {
8051 sv_catsv(sv, *svargs);
8055 if (args && patlen == 3 && pat[0] == '%' &&
8056 pat[1] == '-' && pat[2] == 'p') {
8057 argsv = va_arg(*args, SV*);
8058 sv_catsv(sv, argsv);
8062 #ifndef USE_LONG_DOUBLE
8063 /* special-case "%.<number>[gf]" */
8064 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8065 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8066 unsigned digits = 0;
8070 while (*pp >= '0' && *pp <= '9')
8071 digits = 10 * digits + (*pp++ - '0');
8072 if (pp - pat == (int)patlen - 1) {
8080 /* Add check for digits != 0 because it seems that some
8081 gconverts are buggy in this case, and we don't yet have
8082 a Configure test for this. */
8083 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8084 /* 0, point, slack */
8085 Gconvert(nv, (int)digits, 0, ebuf);
8087 if (*ebuf) /* May return an empty string for digits==0 */
8090 } else if (!digits) {
8093 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8094 sv_catpvn(sv, p, l);
8100 #endif /* !USE_LONG_DOUBLE */
8102 if (!args && svix < svmax && DO_UTF8(*svargs))
8105 patend = (char*)pat + patlen;
8106 for (p = (char*)pat; p < patend; p = q) {
8109 bool vectorize = FALSE;
8110 bool vectorarg = FALSE;
8111 bool vec_utf8 = FALSE;
8117 bool has_precis = FALSE;
8119 const I32 osvix = svix;
8120 bool is_utf8 = FALSE; /* is this item utf8? */
8121 #ifdef HAS_LDBL_SPRINTF_BUG
8122 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8123 with sfio - Allen <allens@cpan.org> */
8124 bool fix_ldbl_sprintf_bug = FALSE;
8128 U8 utf8buf[UTF8_MAXBYTES+1];
8129 STRLEN esignlen = 0;
8131 const char *eptr = NULL;
8134 const U8 *vecstr = NULL;
8141 /* we need a long double target in case HAS_LONG_DOUBLE but
8144 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8152 const char *dotstr = ".";
8153 STRLEN dotstrlen = 1;
8154 I32 efix = 0; /* explicit format parameter index */
8155 I32 ewix = 0; /* explicit width index */
8156 I32 epix = 0; /* explicit precision index */
8157 I32 evix = 0; /* explicit vector index */
8158 bool asterisk = FALSE;
8160 /* echo everything up to the next format specification */
8161 for (q = p; q < patend && *q != '%'; ++q) ;
8163 if (has_utf8 && !pat_utf8)
8164 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8166 sv_catpvn(sv, p, q - p);
8173 We allow format specification elements in this order:
8174 \d+\$ explicit format parameter index
8176 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8177 0 flag (as above): repeated to allow "v02"
8178 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8179 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8181 [%bcdefginopsuxDFOUX] format (mandatory)
8186 As of perl5.9.3, printf format checking is on by default.
8187 Internally, perl uses %p formats to provide an escape to
8188 some extended formatting. This block deals with those
8189 extensions: if it does not match, (char*)q is reset and
8190 the normal format processing code is used.
8192 Currently defined extensions are:
8193 %p include pointer address (standard)
8194 %-p (SVf) include an SV (previously %_)
8195 %-<num>p include an SV with precision <num>
8196 %1p (VDf) include a v-string (as %vd)
8197 %<num>p reserved for future extensions
8199 Robin Barker 2005-07-14
8206 n = expect_number(&q);
8213 argsv = va_arg(*args, SV*);
8214 eptr = SvPVx_const(argsv, elen);
8220 else if (n == vdNUMBER) { /* VDf */
8227 if (ckWARN_d(WARN_INTERNAL))
8228 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8229 "internal %%<num>p might conflict with future printf extensions");
8235 if ( (width = expect_number(&q)) ) {
8276 if ( (ewix = expect_number(&q)) )
8285 if ((vectorarg = asterisk)) {
8298 width = expect_number(&q);
8304 vecsv = va_arg(*args, SV*);
8306 vecsv = (evix > 0 && evix <= svmax)
8307 ? svargs[evix-1] : &PL_sv_undef;
8309 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8311 dotstr = SvPV_const(vecsv, dotstrlen);
8312 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8313 bad with tied or overloaded values that return UTF8. */
8316 else if (has_utf8) {
8317 vecsv = sv_mortalcopy(vecsv);
8318 sv_utf8_upgrade(vecsv);
8319 dotstr = SvPV_const(vecsv, dotstrlen);
8326 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8327 vecsv = svargs[efix ? efix-1 : svix++];
8328 vecstr = (U8*)SvPV_const(vecsv,veclen);
8329 vec_utf8 = DO_UTF8(vecsv);
8331 /* if this is a version object, we need to convert
8332 * back into v-string notation and then let the
8333 * vectorize happen normally
8335 if (sv_derived_from(vecsv, "version")) {
8336 char *version = savesvpv(vecsv);
8337 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8338 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8339 "vector argument not supported with alpha versions");
8342 vecsv = sv_newmortal();
8343 /* scan_vstring is expected to be called during
8344 * tokenization, so we need to fake up the end
8345 * of the buffer for it
8347 PL_bufend = version + veclen;
8348 scan_vstring(version, vecsv);
8349 vecstr = (U8*)SvPV_const(vecsv, veclen);
8350 vec_utf8 = DO_UTF8(vecsv);
8362 i = va_arg(*args, int);
8364 i = (ewix ? ewix <= svmax : svix < svmax) ?
8365 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8367 width = (i < 0) ? -i : i;
8377 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8379 /* XXX: todo, support specified precision parameter */
8383 i = va_arg(*args, int);
8385 i = (ewix ? ewix <= svmax : svix < svmax)
8386 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8387 precis = (i < 0) ? 0 : i;
8392 precis = precis * 10 + (*q++ - '0');
8401 case 'I': /* Ix, I32x, and I64x */
8403 if (q[1] == '6' && q[2] == '4') {
8409 if (q[1] == '3' && q[2] == '2') {
8419 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8430 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8431 if (*(q + 1) == 'l') { /* lld, llf */
8457 if (!vectorize && !args) {
8459 const I32 i = efix-1;
8460 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8462 argsv = (svix >= 0 && svix < svmax)
8463 ? svargs[svix++] : &PL_sv_undef;
8474 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8476 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8478 eptr = (char*)utf8buf;
8479 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8493 eptr = va_arg(*args, char*);
8495 #ifdef MACOS_TRADITIONAL
8496 /* On MacOS, %#s format is used for Pascal strings */
8501 elen = strlen(eptr);
8503 eptr = (char *)nullstr;
8504 elen = sizeof nullstr - 1;
8508 eptr = SvPVx_const(argsv, elen);
8509 if (DO_UTF8(argsv)) {
8510 if (has_precis && precis < elen) {
8512 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8515 if (width) { /* fudge width (can't fudge elen) */
8516 width += elen - sv_len_utf8(argsv);
8523 if (has_precis && elen > precis)
8530 if (alt || vectorize)
8532 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8553 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8562 esignbuf[esignlen++] = plus;
8566 case 'h': iv = (short)va_arg(*args, int); break;
8567 case 'l': iv = va_arg(*args, long); break;
8568 case 'V': iv = va_arg(*args, IV); break;
8569 default: iv = va_arg(*args, int); break;
8571 case 'q': iv = va_arg(*args, Quad_t); break;
8576 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8578 case 'h': iv = (short)tiv; break;
8579 case 'l': iv = (long)tiv; break;
8581 default: iv = tiv; break;
8583 case 'q': iv = (Quad_t)tiv; break;
8587 if ( !vectorize ) /* we already set uv above */
8592 esignbuf[esignlen++] = plus;
8596 esignbuf[esignlen++] = '-';
8639 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8650 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8651 case 'l': uv = va_arg(*args, unsigned long); break;
8652 case 'V': uv = va_arg(*args, UV); break;
8653 default: uv = va_arg(*args, unsigned); break;
8655 case 'q': uv = va_arg(*args, Uquad_t); break;
8660 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8662 case 'h': uv = (unsigned short)tuv; break;
8663 case 'l': uv = (unsigned long)tuv; break;
8665 default: uv = tuv; break;
8667 case 'q': uv = (Uquad_t)tuv; break;
8674 char *ptr = ebuf + sizeof ebuf;
8680 p = (char*)((c == 'X')
8681 ? "0123456789ABCDEF" : "0123456789abcdef");
8687 esignbuf[esignlen++] = '0';
8688 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8696 if (alt && *ptr != '0')
8707 esignbuf[esignlen++] = '0';
8708 esignbuf[esignlen++] = 'b';
8711 default: /* it had better be ten or less */
8715 } while (uv /= base);
8718 elen = (ebuf + sizeof ebuf) - ptr;
8722 zeros = precis - elen;
8723 else if (precis == 0 && elen == 1 && *eptr == '0')
8729 /* FLOATING POINT */
8732 c = 'f'; /* maybe %F isn't supported here */
8740 /* This is evil, but floating point is even more evil */
8742 /* for SV-style calling, we can only get NV
8743 for C-style calling, we assume %f is double;
8744 for simplicity we allow any of %Lf, %llf, %qf for long double
8748 #if defined(USE_LONG_DOUBLE)
8752 /* [perl #20339] - we should accept and ignore %lf rather than die */
8756 #if defined(USE_LONG_DOUBLE)
8757 intsize = args ? 0 : 'q';
8761 #if defined(HAS_LONG_DOUBLE)
8770 /* now we need (long double) if intsize == 'q', else (double) */
8772 #if LONG_DOUBLESIZE > DOUBLESIZE
8774 va_arg(*args, long double) :
8775 va_arg(*args, double)
8777 va_arg(*args, double)
8782 if (c != 'e' && c != 'E') {
8784 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8785 will cast our (long double) to (double) */
8786 (void)Perl_frexp(nv, &i);
8787 if (i == PERL_INT_MIN)
8788 Perl_die(aTHX_ "panic: frexp");
8790 need = BIT_DIGITS(i);
8792 need += has_precis ? precis : 6; /* known default */
8797 #ifdef HAS_LDBL_SPRINTF_BUG
8798 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8799 with sfio - Allen <allens@cpan.org> */
8802 # define MY_DBL_MAX DBL_MAX
8803 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8804 # if DOUBLESIZE >= 8
8805 # define MY_DBL_MAX 1.7976931348623157E+308L
8807 # define MY_DBL_MAX 3.40282347E+38L
8811 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8812 # define MY_DBL_MAX_BUG 1L
8814 # define MY_DBL_MAX_BUG MY_DBL_MAX
8818 # define MY_DBL_MIN DBL_MIN
8819 # else /* XXX guessing! -Allen */
8820 # if DOUBLESIZE >= 8
8821 # define MY_DBL_MIN 2.2250738585072014E-308L
8823 # define MY_DBL_MIN 1.17549435E-38L
8827 if ((intsize == 'q') && (c == 'f') &&
8828 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8830 /* it's going to be short enough that
8831 * long double precision is not needed */
8833 if ((nv <= 0L) && (nv >= -0L))
8834 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8836 /* would use Perl_fp_class as a double-check but not
8837 * functional on IRIX - see perl.h comments */
8839 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8840 /* It's within the range that a double can represent */
8841 #if defined(DBL_MAX) && !defined(DBL_MIN)
8842 if ((nv >= ((long double)1/DBL_MAX)) ||
8843 (nv <= (-(long double)1/DBL_MAX)))
8845 fix_ldbl_sprintf_bug = TRUE;
8848 if (fix_ldbl_sprintf_bug == TRUE) {
8858 # undef MY_DBL_MAX_BUG
8861 #endif /* HAS_LDBL_SPRINTF_BUG */
8863 need += 20; /* fudge factor */
8864 if (PL_efloatsize < need) {
8865 Safefree(PL_efloatbuf);
8866 PL_efloatsize = need + 20; /* more fudge */
8867 Newx(PL_efloatbuf, PL_efloatsize, char);
8868 PL_efloatbuf[0] = '\0';
8871 if ( !(width || left || plus || alt) && fill != '0'
8872 && has_precis && intsize != 'q' ) { /* Shortcuts */
8873 /* See earlier comment about buggy Gconvert when digits,
8875 if ( c == 'g' && precis) {
8876 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8877 /* May return an empty string for digits==0 */
8878 if (*PL_efloatbuf) {
8879 elen = strlen(PL_efloatbuf);
8880 goto float_converted;
8882 } else if ( c == 'f' && !precis) {
8883 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8888 char *ptr = ebuf + sizeof ebuf;
8891 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8892 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8893 if (intsize == 'q') {
8894 /* Copy the one or more characters in a long double
8895 * format before the 'base' ([efgEFG]) character to
8896 * the format string. */
8897 static char const prifldbl[] = PERL_PRIfldbl;
8898 char const *p = prifldbl + sizeof(prifldbl) - 3;
8899 while (p >= prifldbl) { *--ptr = *p--; }
8904 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8909 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8921 /* No taint. Otherwise we are in the strange situation
8922 * where printf() taints but print($float) doesn't.
8924 #if defined(HAS_LONG_DOUBLE)
8925 elen = ((intsize == 'q')
8926 ? my_sprintf(PL_efloatbuf, ptr, nv)
8927 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8929 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8933 eptr = PL_efloatbuf;
8941 i = SvCUR(sv) - origlen;
8944 case 'h': *(va_arg(*args, short*)) = i; break;
8945 default: *(va_arg(*args, int*)) = i; break;
8946 case 'l': *(va_arg(*args, long*)) = i; break;
8947 case 'V': *(va_arg(*args, IV*)) = i; break;
8949 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8954 sv_setuv_mg(argsv, (UV)i);
8955 continue; /* not "break" */
8962 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8963 && ckWARN(WARN_PRINTF))
8965 SV * const msg = sv_newmortal();
8966 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8967 (PL_op->op_type == OP_PRTF) ? "" : "s");
8970 Perl_sv_catpvf(aTHX_ msg,
8971 "\"%%%c\"", c & 0xFF);
8973 Perl_sv_catpvf(aTHX_ msg,
8974 "\"%%\\%03"UVof"\"",
8977 sv_catpvs(msg, "end of string");
8978 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8981 /* output mangled stuff ... */
8987 /* ... right here, because formatting flags should not apply */
8988 SvGROW(sv, SvCUR(sv) + elen + 1);
8990 Copy(eptr, p, elen, char);
8993 SvCUR_set(sv, p - SvPVX_const(sv));
8995 continue; /* not "break" */
8998 /* calculate width before utf8_upgrade changes it */
8999 have = esignlen + zeros + elen;
9001 Perl_croak_nocontext(PL_memory_wrap);
9003 if (is_utf8 != has_utf8) {
9006 sv_utf8_upgrade(sv);
9009 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9010 sv_utf8_upgrade(nsv);
9011 eptr = SvPVX_const(nsv);
9014 SvGROW(sv, SvCUR(sv) + elen + 1);
9019 need = (have > width ? have : width);
9022 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9023 Perl_croak_nocontext(PL_memory_wrap);
9024 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9026 if (esignlen && fill == '0') {
9028 for (i = 0; i < (int)esignlen; i++)
9032 memset(p, fill, gap);
9035 if (esignlen && fill != '0') {
9037 for (i = 0; i < (int)esignlen; i++)
9042 for (i = zeros; i; i--)
9046 Copy(eptr, p, elen, char);
9050 memset(p, ' ', gap);
9055 Copy(dotstr, p, dotstrlen, char);
9059 vectorize = FALSE; /* done iterating over vecstr */
9066 SvCUR_set(sv, p - SvPVX_const(sv));
9074 /* =========================================================================
9076 =head1 Cloning an interpreter
9078 All the macros and functions in this section are for the private use of
9079 the main function, perl_clone().
9081 The foo_dup() functions make an exact copy of an existing foo thinngy.
9082 During the course of a cloning, a hash table is used to map old addresses
9083 to new addresses. The table is created and manipulated with the
9084 ptr_table_* functions.
9088 ============================================================================*/
9091 #if defined(USE_ITHREADS)
9093 #ifndef GpREFCNT_inc
9094 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9098 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9099 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9100 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9101 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9102 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9103 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9104 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9105 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9106 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9107 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9108 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9109 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9110 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9113 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9114 regcomp.c. AMS 20010712 */
9117 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9122 struct reg_substr_datum *s;
9125 return (REGEXP *)NULL;
9127 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9130 len = r->offsets[0];
9131 npar = r->nparens+1;
9133 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9134 Copy(r->program, ret->program, len+1, regnode);
9136 Newx(ret->startp, npar, I32);
9137 Copy(r->startp, ret->startp, npar, I32);
9138 Newx(ret->endp, npar, I32);
9139 Copy(r->startp, ret->startp, npar, I32);
9141 Newx(ret->substrs, 1, struct reg_substr_data);
9142 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9143 s->min_offset = r->substrs->data[i].min_offset;
9144 s->max_offset = r->substrs->data[i].max_offset;
9145 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9146 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9149 ret->regstclass = NULL;
9152 const int count = r->data->count;
9155 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9156 char, struct reg_data);
9157 Newx(d->what, count, U8);
9160 for (i = 0; i < count; i++) {
9161 d->what[i] = r->data->what[i];
9162 switch (d->what[i]) {
9163 /* legal options are one of: sfpont
9164 see also regcomp.h and pregfree() */
9166 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9169 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9172 /* This is cheating. */
9173 Newx(d->data[i], 1, struct regnode_charclass_class);
9174 StructCopy(r->data->data[i], d->data[i],
9175 struct regnode_charclass_class);
9176 ret->regstclass = (regnode*)d->data[i];
9179 /* Compiled op trees are readonly, and can thus be
9180 shared without duplication. */
9182 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9186 d->data[i] = r->data->data[i];
9189 d->data[i] = r->data->data[i];
9191 ((reg_trie_data*)d->data[i])->refcount++;
9195 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9204 Newx(ret->offsets, 2*len+1, U32);
9205 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9207 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9208 ret->refcnt = r->refcnt;
9209 ret->minlen = r->minlen;
9210 ret->prelen = r->prelen;
9211 ret->nparens = r->nparens;
9212 ret->lastparen = r->lastparen;
9213 ret->lastcloseparen = r->lastcloseparen;
9214 ret->reganch = r->reganch;
9216 ret->sublen = r->sublen;
9218 if (RX_MATCH_COPIED(ret))
9219 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9222 #ifdef PERL_OLD_COPY_ON_WRITE
9223 ret->saved_copy = NULL;
9226 ptr_table_store(PL_ptr_table, r, ret);
9230 /* duplicate a file handle */
9233 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9237 PERL_UNUSED_ARG(type);
9240 return (PerlIO*)NULL;
9242 /* look for it in the table first */
9243 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9247 /* create anew and remember what it is */
9248 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9249 ptr_table_store(PL_ptr_table, fp, ret);
9253 /* duplicate a directory handle */
9256 Perl_dirp_dup(pTHX_ DIR *dp)
9264 /* duplicate a typeglob */
9267 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9272 /* look for it in the table first */
9273 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9277 /* create anew and remember what it is */
9279 ptr_table_store(PL_ptr_table, gp, ret);
9282 ret->gp_refcnt = 0; /* must be before any other dups! */
9283 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9284 ret->gp_io = io_dup_inc(gp->gp_io, param);
9285 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9286 ret->gp_av = av_dup_inc(gp->gp_av, param);
9287 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9288 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9289 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9290 ret->gp_cvgen = gp->gp_cvgen;
9291 ret->gp_line = gp->gp_line;
9292 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9296 /* duplicate a chain of magic */
9299 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9301 MAGIC *mgprev = (MAGIC*)NULL;
9304 return (MAGIC*)NULL;
9305 /* look for it in the table first */
9306 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9310 for (; mg; mg = mg->mg_moremagic) {
9312 Newxz(nmg, 1, MAGIC);
9314 mgprev->mg_moremagic = nmg;
9317 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9318 nmg->mg_private = mg->mg_private;
9319 nmg->mg_type = mg->mg_type;
9320 nmg->mg_flags = mg->mg_flags;
9321 if (mg->mg_type == PERL_MAGIC_qr) {
9322 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9324 else if(mg->mg_type == PERL_MAGIC_backref) {
9325 /* The backref AV has its reference count deliberately bumped by
9327 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9329 else if (mg->mg_type == PERL_MAGIC_symtab) {
9330 nmg->mg_obj = mg->mg_obj;
9333 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9334 ? sv_dup_inc(mg->mg_obj, param)
9335 : sv_dup(mg->mg_obj, param);
9337 nmg->mg_len = mg->mg_len;
9338 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9339 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9340 if (mg->mg_len > 0) {
9341 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9342 if (mg->mg_type == PERL_MAGIC_overload_table &&
9343 AMT_AMAGIC((AMT*)mg->mg_ptr))
9345 const AMT * const amtp = (AMT*)mg->mg_ptr;
9346 AMT * const namtp = (AMT*)nmg->mg_ptr;
9348 for (i = 1; i < NofAMmeth; i++) {
9349 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9353 else if (mg->mg_len == HEf_SVKEY)
9354 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9356 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9357 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9364 /* create a new pointer-mapping table */
9367 Perl_ptr_table_new(pTHX)
9370 Newxz(tbl, 1, PTR_TBL_t);
9373 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9377 #define PTR_TABLE_HASH(ptr) \
9378 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9381 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9382 following define) and at call to new_body_inline made below in
9383 Perl_ptr_table_store()
9386 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9388 /* map an existing pointer using a table */
9390 STATIC PTR_TBL_ENT_t *
9391 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9392 PTR_TBL_ENT_t *tblent;
9393 const UV hash = PTR_TABLE_HASH(sv);
9395 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9396 for (; tblent; tblent = tblent->next) {
9397 if (tblent->oldval == sv)
9404 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9406 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9407 return tblent ? tblent->newval : (void *) 0;
9410 /* add a new entry to a pointer-mapping table */
9413 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9415 PTR_TBL_ENT_t *tblent = S_ptr_table_find(tbl, oldsv);
9418 tblent->newval = newsv;
9420 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9422 new_body_inline(tblent, PTE_SVSLOT);
9424 tblent->oldval = oldsv;
9425 tblent->newval = newsv;
9426 tblent->next = tbl->tbl_ary[entry];
9427 tbl->tbl_ary[entry] = tblent;
9429 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9430 ptr_table_split(tbl);
9434 /* double the hash bucket size of an existing ptr table */
9437 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9439 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9440 const UV oldsize = tbl->tbl_max + 1;
9441 UV newsize = oldsize * 2;
9444 Renew(ary, newsize, PTR_TBL_ENT_t*);
9445 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9446 tbl->tbl_max = --newsize;
9448 for (i=0; i < oldsize; i++, ary++) {
9449 PTR_TBL_ENT_t **curentp, **entp, *ent;
9452 curentp = ary + oldsize;
9453 for (entp = ary, ent = *ary; ent; ent = *entp) {
9454 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9456 ent->next = *curentp;
9466 /* remove all the entries from a ptr table */
9469 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9471 if (tbl && tbl->tbl_items) {
9472 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9473 UV riter = tbl->tbl_max;
9476 PTR_TBL_ENT_t *entry = array[riter];
9479 PTR_TBL_ENT_t * const oentry = entry;
9480 entry = entry->next;
9489 /* clear and free a ptr table */
9492 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9497 ptr_table_clear(tbl);
9498 Safefree(tbl->tbl_ary);
9504 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9507 SvRV_set(dstr, SvWEAKREF(sstr)
9508 ? sv_dup(SvRV(sstr), param)
9509 : sv_dup_inc(SvRV(sstr), param));
9512 else if (SvPVX_const(sstr)) {
9513 /* Has something there */
9515 /* Normal PV - clone whole allocated space */
9516 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9517 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9518 /* Not that normal - actually sstr is copy on write.
9519 But we are a true, independant SV, so: */
9520 SvREADONLY_off(dstr);
9525 /* Special case - not normally malloced for some reason */
9526 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9527 /* A "shared" PV - clone it as "shared" PV */
9529 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9533 /* Some other special case - random pointer */
9534 SvPV_set(dstr, SvPVX(sstr));
9540 if (SvTYPE(dstr) == SVt_RV)
9541 SvRV_set(dstr, NULL);
9543 SvPV_set(dstr, NULL);
9547 /* duplicate an SV of any type (including AV, HV etc) */
9550 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9555 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9557 /* look for it in the table first */
9558 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9562 if(param->flags & CLONEf_JOIN_IN) {
9563 /** We are joining here so we don't want do clone
9564 something that is bad **/
9565 if (SvTYPE(sstr) == SVt_PVHV) {
9566 const char * const hvname = HvNAME_get(sstr);
9568 /** don't clone stashes if they already exist **/
9569 return (SV*)gv_stashpv(hvname,0);
9573 /* create anew and remember what it is */
9576 #ifdef DEBUG_LEAKING_SCALARS
9577 dstr->sv_debug_optype = sstr->sv_debug_optype;
9578 dstr->sv_debug_line = sstr->sv_debug_line;
9579 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9580 dstr->sv_debug_cloned = 1;
9581 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9584 ptr_table_store(PL_ptr_table, sstr, dstr);
9587 SvFLAGS(dstr) = SvFLAGS(sstr);
9588 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9589 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9592 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9593 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9594 PL_watch_pvx, SvPVX_const(sstr));
9597 /* don't clone objects whose class has asked us not to */
9598 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9599 SvFLAGS(dstr) &= ~SVTYPEMASK;
9604 switch (SvTYPE(sstr)) {
9609 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9610 SvIV_set(dstr, SvIVX(sstr));
9613 SvANY(dstr) = new_XNV();
9614 SvNV_set(dstr, SvNVX(sstr));
9617 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9618 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9622 /* These are all the types that need complex bodies allocating. */
9624 const svtype sv_type = SvTYPE(sstr);
9625 const struct body_details *const sv_type_details
9626 = bodies_by_type + sv_type;
9630 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9634 if (GvUNIQUE((GV*)sstr)) {
9635 /*EMPTY*/; /* Do sharing here, and fall through */
9648 assert(sv_type_details->body_size);
9649 if (sv_type_details->arena) {
9650 new_body_inline(new_body, sv_type);
9652 = (void*)((char*)new_body - sv_type_details->offset);
9654 new_body = new_NOARENA(sv_type_details);
9658 SvANY(dstr) = new_body;
9661 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9662 ((char*)SvANY(dstr)) + sv_type_details->offset,
9663 sv_type_details->copy, char);
9665 Copy(((char*)SvANY(sstr)),
9666 ((char*)SvANY(dstr)),
9667 sv_type_details->body_size + sv_type_details->offset, char);
9670 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9671 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9673 /* The Copy above means that all the source (unduplicated) pointers
9674 are now in the destination. We can check the flags and the
9675 pointers in either, but it's possible that there's less cache
9676 missing by always going for the destination.
9677 FIXME - instrument and check that assumption */
9678 if (sv_type >= SVt_PVMG) {
9680 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9682 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9685 /* The cast silences a GCC warning about unhandled types. */
9686 switch ((int)sv_type) {
9698 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9699 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9700 LvTARG(dstr) = dstr;
9701 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9702 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9704 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9707 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9708 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9709 /* Don't call sv_add_backref here as it's going to be created
9710 as part of the magic cloning of the symbol table. */
9711 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9712 (void)GpREFCNT_inc(GvGP(dstr));
9715 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9716 if (IoOFP(dstr) == IoIFP(sstr))
9717 IoOFP(dstr) = IoIFP(dstr);
9719 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9720 /* PL_rsfp_filters entries have fake IoDIRP() */
9721 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9722 /* I have no idea why fake dirp (rsfps)
9723 should be treated differently but otherwise
9724 we end up with leaks -- sky*/
9725 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9726 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9727 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9729 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9730 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9731 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9733 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9736 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
9739 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9740 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9741 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9744 if (AvARRAY((AV*)sstr)) {
9745 SV **dst_ary, **src_ary;
9746 SSize_t items = AvFILLp((AV*)sstr) + 1;
9748 src_ary = AvARRAY((AV*)sstr);
9749 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9750 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9751 SvPV_set(dstr, (char*)dst_ary);
9752 AvALLOC((AV*)dstr) = dst_ary;
9753 if (AvREAL((AV*)sstr)) {
9755 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9759 *dst_ary++ = sv_dup(*src_ary++, param);
9761 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9762 while (items-- > 0) {
9763 *dst_ary++ = &PL_sv_undef;
9767 SvPV_set(dstr, NULL);
9768 AvALLOC((AV*)dstr) = (SV**)NULL;
9775 if (HvARRAY((HV*)sstr)) {
9777 const bool sharekeys = !!HvSHAREKEYS(sstr);
9778 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9779 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9781 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9782 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9784 HvARRAY(dstr) = (HE**)darray;
9785 while (i <= sxhv->xhv_max) {
9786 const HE *source = HvARRAY(sstr)[i];
9787 HvARRAY(dstr)[i] = source
9788 ? he_dup(source, sharekeys, param) : 0;
9792 struct xpvhv_aux * const saux = HvAUX(sstr);
9793 struct xpvhv_aux * const daux = HvAUX(dstr);
9794 /* This flag isn't copied. */
9795 /* SvOOK_on(hv) attacks the IV flags. */
9796 SvFLAGS(dstr) |= SVf_OOK;
9798 hvname = saux->xhv_name;
9800 = hvname ? hek_dup(hvname, param) : hvname;
9802 daux->xhv_riter = saux->xhv_riter;
9803 daux->xhv_eiter = saux->xhv_eiter
9804 ? he_dup(saux->xhv_eiter,
9805 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9806 daux->xhv_backreferences = saux->xhv_backreferences
9807 ? (AV*) SvREFCNT_inc(
9815 SvPV_set(dstr, NULL);
9817 /* Record stashes for possible cloning in Perl_clone(). */
9819 av_push(param->stashes, dstr);
9824 /* NOTE: not refcounted */
9825 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9827 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9829 if (CvCONST(dstr)) {
9830 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9831 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9832 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9834 /* don't dup if copying back - CvGV isn't refcounted, so the
9835 * duped GV may never be freed. A bit of a hack! DAPM */
9836 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9837 NULL : gv_dup(CvGV(dstr), param) ;
9838 if (!(param->flags & CLONEf_COPY_STACKS)) {
9841 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9844 ? cv_dup( CvOUTSIDE(dstr), param)
9845 : cv_dup_inc(CvOUTSIDE(dstr), param);
9846 if (!CvISXSUB(dstr))
9847 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9853 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9859 /* duplicate a context */
9862 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9867 return (PERL_CONTEXT*)NULL;
9869 /* look for it in the table first */
9870 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9874 /* create anew and remember what it is */
9875 Newxz(ncxs, max + 1, PERL_CONTEXT);
9876 ptr_table_store(PL_ptr_table, cxs, ncxs);
9879 PERL_CONTEXT * const cx = &cxs[ix];
9880 PERL_CONTEXT * const ncx = &ncxs[ix];
9881 ncx->cx_type = cx->cx_type;
9882 if (CxTYPE(cx) == CXt_SUBST) {
9883 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9886 ncx->blk_oldsp = cx->blk_oldsp;
9887 ncx->blk_oldcop = cx->blk_oldcop;
9888 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9889 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9890 ncx->blk_oldpm = cx->blk_oldpm;
9891 ncx->blk_gimme = cx->blk_gimme;
9892 switch (CxTYPE(cx)) {
9894 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9895 ? cv_dup_inc(cx->blk_sub.cv, param)
9896 : cv_dup(cx->blk_sub.cv,param));
9897 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9898 ? av_dup_inc(cx->blk_sub.argarray, param)
9900 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9901 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9902 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9903 ncx->blk_sub.lval = cx->blk_sub.lval;
9904 ncx->blk_sub.retop = cx->blk_sub.retop;
9907 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9908 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9909 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9910 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9911 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9912 ncx->blk_eval.retop = cx->blk_eval.retop;
9915 ncx->blk_loop.label = cx->blk_loop.label;
9916 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9917 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9918 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9919 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9920 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9921 ? cx->blk_loop.iterdata
9922 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9923 ncx->blk_loop.oldcomppad
9924 = (PAD*)ptr_table_fetch(PL_ptr_table,
9925 cx->blk_loop.oldcomppad);
9926 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9927 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9928 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9929 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9930 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9933 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9934 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9935 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9936 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9937 ncx->blk_sub.retop = cx->blk_sub.retop;
9949 /* duplicate a stack info structure */
9952 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9957 return (PERL_SI*)NULL;
9959 /* look for it in the table first */
9960 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9964 /* create anew and remember what it is */
9965 Newxz(nsi, 1, PERL_SI);
9966 ptr_table_store(PL_ptr_table, si, nsi);
9968 nsi->si_stack = av_dup_inc(si->si_stack, param);
9969 nsi->si_cxix = si->si_cxix;
9970 nsi->si_cxmax = si->si_cxmax;
9971 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9972 nsi->si_type = si->si_type;
9973 nsi->si_prev = si_dup(si->si_prev, param);
9974 nsi->si_next = si_dup(si->si_next, param);
9975 nsi->si_markoff = si->si_markoff;
9980 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9981 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9982 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9983 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9984 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9985 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9986 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9987 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9988 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9989 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9990 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9991 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9992 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9993 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9996 #define pv_dup_inc(p) SAVEPV(p)
9997 #define pv_dup(p) SAVEPV(p)
9998 #define svp_dup_inc(p,pp) any_dup(p,pp)
10000 /* map any object to the new equivent - either something in the
10001 * ptr table, or something in the interpreter structure
10005 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10010 return (void*)NULL;
10012 /* look for it in the table first */
10013 ret = ptr_table_fetch(PL_ptr_table, v);
10017 /* see if it is part of the interpreter structure */
10018 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10019 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10027 /* duplicate the save stack */
10030 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10032 ANY * const ss = proto_perl->Tsavestack;
10033 const I32 max = proto_perl->Tsavestack_max;
10034 I32 ix = proto_perl->Tsavestack_ix;
10046 void (*dptr) (void*);
10047 void (*dxptr) (pTHX_ void*);
10049 Newxz(nss, max, ANY);
10052 I32 i = POPINT(ss,ix);
10053 TOPINT(nss,ix) = i;
10055 case SAVEt_ITEM: /* normal string */
10056 sv = (SV*)POPPTR(ss,ix);
10057 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10058 sv = (SV*)POPPTR(ss,ix);
10059 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10061 case SAVEt_SV: /* scalar reference */
10062 sv = (SV*)POPPTR(ss,ix);
10063 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10064 gv = (GV*)POPPTR(ss,ix);
10065 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10067 case SAVEt_GENERIC_PVREF: /* generic char* */
10068 c = (char*)POPPTR(ss,ix);
10069 TOPPTR(nss,ix) = pv_dup(c);
10070 ptr = POPPTR(ss,ix);
10071 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10073 case SAVEt_SHARED_PVREF: /* char* in shared space */
10074 c = (char*)POPPTR(ss,ix);
10075 TOPPTR(nss,ix) = savesharedpv(c);
10076 ptr = POPPTR(ss,ix);
10077 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10079 case SAVEt_GENERIC_SVREF: /* generic sv */
10080 case SAVEt_SVREF: /* scalar reference */
10081 sv = (SV*)POPPTR(ss,ix);
10082 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10083 ptr = POPPTR(ss,ix);
10084 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10086 case SAVEt_AV: /* array reference */
10087 av = (AV*)POPPTR(ss,ix);
10088 TOPPTR(nss,ix) = av_dup_inc(av, param);
10089 gv = (GV*)POPPTR(ss,ix);
10090 TOPPTR(nss,ix) = gv_dup(gv, param);
10092 case SAVEt_HV: /* hash reference */
10093 hv = (HV*)POPPTR(ss,ix);
10094 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10095 gv = (GV*)POPPTR(ss,ix);
10096 TOPPTR(nss,ix) = gv_dup(gv, param);
10098 case SAVEt_INT: /* int reference */
10099 ptr = POPPTR(ss,ix);
10100 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10101 intval = (int)POPINT(ss,ix);
10102 TOPINT(nss,ix) = intval;
10104 case SAVEt_LONG: /* long reference */
10105 ptr = POPPTR(ss,ix);
10106 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10107 longval = (long)POPLONG(ss,ix);
10108 TOPLONG(nss,ix) = longval;
10110 case SAVEt_I32: /* I32 reference */
10111 case SAVEt_I16: /* I16 reference */
10112 case SAVEt_I8: /* I8 reference */
10113 ptr = POPPTR(ss,ix);
10114 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10116 TOPINT(nss,ix) = i;
10118 case SAVEt_IV: /* IV reference */
10119 ptr = POPPTR(ss,ix);
10120 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10122 TOPIV(nss,ix) = iv;
10124 case SAVEt_SPTR: /* SV* reference */
10125 ptr = POPPTR(ss,ix);
10126 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10127 sv = (SV*)POPPTR(ss,ix);
10128 TOPPTR(nss,ix) = sv_dup(sv, param);
10130 case SAVEt_VPTR: /* random* reference */
10131 ptr = POPPTR(ss,ix);
10132 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10133 ptr = POPPTR(ss,ix);
10134 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10136 case SAVEt_PPTR: /* char* reference */
10137 ptr = POPPTR(ss,ix);
10138 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10139 c = (char*)POPPTR(ss,ix);
10140 TOPPTR(nss,ix) = pv_dup(c);
10142 case SAVEt_HPTR: /* HV* reference */
10143 ptr = POPPTR(ss,ix);
10144 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10145 hv = (HV*)POPPTR(ss,ix);
10146 TOPPTR(nss,ix) = hv_dup(hv, param);
10148 case SAVEt_APTR: /* AV* reference */
10149 ptr = POPPTR(ss,ix);
10150 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10151 av = (AV*)POPPTR(ss,ix);
10152 TOPPTR(nss,ix) = av_dup(av, param);
10155 gv = (GV*)POPPTR(ss,ix);
10156 TOPPTR(nss,ix) = gv_dup(gv, param);
10158 case SAVEt_GP: /* scalar reference */
10159 gp = (GP*)POPPTR(ss,ix);
10160 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10161 (void)GpREFCNT_inc(gp);
10162 gv = (GV*)POPPTR(ss,ix);
10163 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10164 c = (char*)POPPTR(ss,ix);
10165 TOPPTR(nss,ix) = pv_dup(c);
10167 TOPIV(nss,ix) = iv;
10169 TOPIV(nss,ix) = iv;
10172 case SAVEt_MORTALIZESV:
10173 sv = (SV*)POPPTR(ss,ix);
10174 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10177 ptr = POPPTR(ss,ix);
10178 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10179 /* these are assumed to be refcounted properly */
10181 switch (((OP*)ptr)->op_type) {
10183 case OP_LEAVESUBLV:
10187 case OP_LEAVEWRITE:
10188 TOPPTR(nss,ix) = ptr;
10193 TOPPTR(nss,ix) = NULL;
10198 TOPPTR(nss,ix) = NULL;
10201 c = (char*)POPPTR(ss,ix);
10202 TOPPTR(nss,ix) = pv_dup_inc(c);
10204 case SAVEt_CLEARSV:
10205 longval = POPLONG(ss,ix);
10206 TOPLONG(nss,ix) = longval;
10209 hv = (HV*)POPPTR(ss,ix);
10210 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10211 c = (char*)POPPTR(ss,ix);
10212 TOPPTR(nss,ix) = pv_dup_inc(c);
10214 TOPINT(nss,ix) = i;
10216 case SAVEt_DESTRUCTOR:
10217 ptr = POPPTR(ss,ix);
10218 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10219 dptr = POPDPTR(ss,ix);
10220 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10221 any_dup(FPTR2DPTR(void *, dptr),
10224 case SAVEt_DESTRUCTOR_X:
10225 ptr = POPPTR(ss,ix);
10226 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10227 dxptr = POPDXPTR(ss,ix);
10228 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10229 any_dup(FPTR2DPTR(void *, dxptr),
10232 case SAVEt_REGCONTEXT:
10235 TOPINT(nss,ix) = i;
10238 case SAVEt_STACK_POS: /* Position on Perl stack */
10240 TOPINT(nss,ix) = i;
10242 case SAVEt_AELEM: /* array element */
10243 sv = (SV*)POPPTR(ss,ix);
10244 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10246 TOPINT(nss,ix) = i;
10247 av = (AV*)POPPTR(ss,ix);
10248 TOPPTR(nss,ix) = av_dup_inc(av, param);
10250 case SAVEt_HELEM: /* hash element */
10251 sv = (SV*)POPPTR(ss,ix);
10252 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10253 sv = (SV*)POPPTR(ss,ix);
10254 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10255 hv = (HV*)POPPTR(ss,ix);
10256 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10259 ptr = POPPTR(ss,ix);
10260 TOPPTR(nss,ix) = ptr;
10264 TOPINT(nss,ix) = i;
10266 case SAVEt_COMPPAD:
10267 av = (AV*)POPPTR(ss,ix);
10268 TOPPTR(nss,ix) = av_dup(av, param);
10271 longval = (long)POPLONG(ss,ix);
10272 TOPLONG(nss,ix) = longval;
10273 ptr = POPPTR(ss,ix);
10274 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10275 sv = (SV*)POPPTR(ss,ix);
10276 TOPPTR(nss,ix) = sv_dup(sv, param);
10279 ptr = POPPTR(ss,ix);
10280 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10281 longval = (long)POPBOOL(ss,ix);
10282 TOPBOOL(nss,ix) = (bool)longval;
10284 case SAVEt_SET_SVFLAGS:
10286 TOPINT(nss,ix) = i;
10288 TOPINT(nss,ix) = i;
10289 sv = (SV*)POPPTR(ss,ix);
10290 TOPPTR(nss,ix) = sv_dup(sv, param);
10293 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10301 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10302 * flag to the result. This is done for each stash before cloning starts,
10303 * so we know which stashes want their objects cloned */
10306 do_mark_cloneable_stash(pTHX_ SV *sv)
10308 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10310 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10311 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10312 if (cloner && GvCV(cloner)) {
10319 XPUSHs(sv_2mortal(newSVhek(hvname)));
10321 call_sv((SV*)GvCV(cloner), G_SCALAR);
10328 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10336 =for apidoc perl_clone
10338 Create and return a new interpreter by cloning the current one.
10340 perl_clone takes these flags as parameters:
10342 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10343 without it we only clone the data and zero the stacks,
10344 with it we copy the stacks and the new perl interpreter is
10345 ready to run at the exact same point as the previous one.
10346 The pseudo-fork code uses COPY_STACKS while the
10347 threads->new doesn't.
10349 CLONEf_KEEP_PTR_TABLE
10350 perl_clone keeps a ptr_table with the pointer of the old
10351 variable as a key and the new variable as a value,
10352 this allows it to check if something has been cloned and not
10353 clone it again but rather just use the value and increase the
10354 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10355 the ptr_table using the function
10356 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10357 reason to keep it around is if you want to dup some of your own
10358 variable who are outside the graph perl scans, example of this
10359 code is in threads.xs create
10362 This is a win32 thing, it is ignored on unix, it tells perls
10363 win32host code (which is c++) to clone itself, this is needed on
10364 win32 if you want to run two threads at the same time,
10365 if you just want to do some stuff in a separate perl interpreter
10366 and then throw it away and return to the original one,
10367 you don't need to do anything.
10372 /* XXX the above needs expanding by someone who actually understands it ! */
10373 EXTERN_C PerlInterpreter *
10374 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10377 perl_clone(PerlInterpreter *proto_perl, UV flags)
10380 #ifdef PERL_IMPLICIT_SYS
10382 /* perlhost.h so we need to call into it
10383 to clone the host, CPerlHost should have a c interface, sky */
10385 if (flags & CLONEf_CLONE_HOST) {
10386 return perl_clone_host(proto_perl,flags);
10388 return perl_clone_using(proto_perl, flags,
10390 proto_perl->IMemShared,
10391 proto_perl->IMemParse,
10393 proto_perl->IStdIO,
10397 proto_perl->IProc);
10401 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10402 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10403 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10404 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10405 struct IPerlDir* ipD, struct IPerlSock* ipS,
10406 struct IPerlProc* ipP)
10408 /* XXX many of the string copies here can be optimized if they're
10409 * constants; they need to be allocated as common memory and just
10410 * their pointers copied. */
10413 CLONE_PARAMS clone_params;
10414 CLONE_PARAMS* const param = &clone_params;
10416 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10417 /* for each stash, determine whether its objects should be cloned */
10418 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10419 PERL_SET_THX(my_perl);
10422 Poison(my_perl, 1, PerlInterpreter);
10428 PL_savestack_ix = 0;
10429 PL_savestack_max = -1;
10430 PL_sig_pending = 0;
10431 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10432 # else /* !DEBUGGING */
10433 Zero(my_perl, 1, PerlInterpreter);
10434 # endif /* DEBUGGING */
10436 /* host pointers */
10438 PL_MemShared = ipMS;
10439 PL_MemParse = ipMP;
10446 #else /* !PERL_IMPLICIT_SYS */
10448 CLONE_PARAMS clone_params;
10449 CLONE_PARAMS* param = &clone_params;
10450 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10451 /* for each stash, determine whether its objects should be cloned */
10452 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10453 PERL_SET_THX(my_perl);
10456 Poison(my_perl, 1, PerlInterpreter);
10462 PL_savestack_ix = 0;
10463 PL_savestack_max = -1;
10464 PL_sig_pending = 0;
10465 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10466 # else /* !DEBUGGING */
10467 Zero(my_perl, 1, PerlInterpreter);
10468 # endif /* DEBUGGING */
10469 #endif /* PERL_IMPLICIT_SYS */
10470 param->flags = flags;
10471 param->proto_perl = proto_perl;
10473 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10475 PL_body_arenas = NULL;
10476 Zero(&PL_body_roots, 1, PL_body_roots);
10478 PL_nice_chunk = NULL;
10479 PL_nice_chunk_size = 0;
10481 PL_sv_objcount = 0;
10483 PL_sv_arenaroot = NULL;
10485 PL_debug = proto_perl->Idebug;
10487 PL_hash_seed = proto_perl->Ihash_seed;
10488 PL_rehash_seed = proto_perl->Irehash_seed;
10490 #ifdef USE_REENTRANT_API
10491 /* XXX: things like -Dm will segfault here in perlio, but doing
10492 * PERL_SET_CONTEXT(proto_perl);
10493 * breaks too many other things
10495 Perl_reentrant_init(aTHX);
10498 /* create SV map for pointer relocation */
10499 PL_ptr_table = ptr_table_new();
10501 /* initialize these special pointers as early as possible */
10502 SvANY(&PL_sv_undef) = NULL;
10503 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10504 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10505 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10507 SvANY(&PL_sv_no) = new_XPVNV();
10508 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10509 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10510 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10511 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10512 SvCUR_set(&PL_sv_no, 0);
10513 SvLEN_set(&PL_sv_no, 1);
10514 SvIV_set(&PL_sv_no, 0);
10515 SvNV_set(&PL_sv_no, 0);
10516 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10518 SvANY(&PL_sv_yes) = new_XPVNV();
10519 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10520 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10521 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10522 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10523 SvCUR_set(&PL_sv_yes, 1);
10524 SvLEN_set(&PL_sv_yes, 2);
10525 SvIV_set(&PL_sv_yes, 1);
10526 SvNV_set(&PL_sv_yes, 1);
10527 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10529 /* create (a non-shared!) shared string table */
10530 PL_strtab = newHV();
10531 HvSHAREKEYS_off(PL_strtab);
10532 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10533 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10535 PL_compiling = proto_perl->Icompiling;
10537 /* These two PVs will be free'd special way so must set them same way op.c does */
10538 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10539 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10541 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10542 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10544 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10545 if (!specialWARN(PL_compiling.cop_warnings))
10546 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10547 if (!specialCopIO(PL_compiling.cop_io))
10548 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10549 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10551 /* pseudo environmental stuff */
10552 PL_origargc = proto_perl->Iorigargc;
10553 PL_origargv = proto_perl->Iorigargv;
10555 param->stashes = newAV(); /* Setup array of objects to call clone on */
10557 /* Set tainting stuff before PerlIO_debug can possibly get called */
10558 PL_tainting = proto_perl->Itainting;
10559 PL_taint_warn = proto_perl->Itaint_warn;
10561 #ifdef PERLIO_LAYERS
10562 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10563 PerlIO_clone(aTHX_ proto_perl, param);
10566 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10567 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10568 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10569 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10570 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10571 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10574 PL_minus_c = proto_perl->Iminus_c;
10575 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10576 PL_localpatches = proto_perl->Ilocalpatches;
10577 PL_splitstr = proto_perl->Isplitstr;
10578 PL_preprocess = proto_perl->Ipreprocess;
10579 PL_minus_n = proto_perl->Iminus_n;
10580 PL_minus_p = proto_perl->Iminus_p;
10581 PL_minus_l = proto_perl->Iminus_l;
10582 PL_minus_a = proto_perl->Iminus_a;
10583 PL_minus_E = proto_perl->Iminus_E;
10584 PL_minus_F = proto_perl->Iminus_F;
10585 PL_doswitches = proto_perl->Idoswitches;
10586 PL_dowarn = proto_perl->Idowarn;
10587 PL_doextract = proto_perl->Idoextract;
10588 PL_sawampersand = proto_perl->Isawampersand;
10589 PL_unsafe = proto_perl->Iunsafe;
10590 PL_inplace = SAVEPV(proto_perl->Iinplace);
10591 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10592 PL_perldb = proto_perl->Iperldb;
10593 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10594 PL_exit_flags = proto_perl->Iexit_flags;
10596 /* magical thingies */
10597 /* XXX time(&PL_basetime) when asked for? */
10598 PL_basetime = proto_perl->Ibasetime;
10599 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10601 PL_maxsysfd = proto_perl->Imaxsysfd;
10602 PL_multiline = proto_perl->Imultiline;
10603 PL_statusvalue = proto_perl->Istatusvalue;
10605 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10607 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10609 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10611 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10612 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10613 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10615 /* Clone the regex array */
10616 PL_regex_padav = newAV();
10618 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10619 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10621 av_push(PL_regex_padav,
10622 sv_dup_inc(regexen[0],param));
10623 for(i = 1; i <= len; i++) {
10624 const SV * const regex = regexen[i];
10627 ? sv_dup_inc(regex, param)
10629 newSViv(PTR2IV(re_dup(
10630 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10632 av_push(PL_regex_padav, sv);
10635 PL_regex_pad = AvARRAY(PL_regex_padav);
10637 /* shortcuts to various I/O objects */
10638 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10639 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10640 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10641 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10642 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10643 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10645 /* shortcuts to regexp stuff */
10646 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10648 /* shortcuts to misc objects */
10649 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10651 /* shortcuts to debugging objects */
10652 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10653 PL_DBline = gv_dup(proto_perl->IDBline, param);
10654 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10655 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10656 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10657 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10658 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10659 PL_lineary = av_dup(proto_perl->Ilineary, param);
10660 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10662 /* symbol tables */
10663 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10664 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10665 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10666 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10667 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10669 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10670 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10671 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10672 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10673 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10674 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10676 PL_sub_generation = proto_perl->Isub_generation;
10678 /* funky return mechanisms */
10679 PL_forkprocess = proto_perl->Iforkprocess;
10681 /* subprocess state */
10682 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10684 /* internal state */
10685 PL_maxo = proto_perl->Imaxo;
10686 if (proto_perl->Iop_mask)
10687 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10690 /* PL_asserting = proto_perl->Iasserting; */
10692 /* current interpreter roots */
10693 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10694 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10695 PL_main_start = proto_perl->Imain_start;
10696 PL_eval_root = proto_perl->Ieval_root;
10697 PL_eval_start = proto_perl->Ieval_start;
10699 /* runtime control stuff */
10700 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10701 PL_copline = proto_perl->Icopline;
10703 PL_filemode = proto_perl->Ifilemode;
10704 PL_lastfd = proto_perl->Ilastfd;
10705 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10708 PL_gensym = proto_perl->Igensym;
10709 PL_preambled = proto_perl->Ipreambled;
10710 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10711 PL_laststatval = proto_perl->Ilaststatval;
10712 PL_laststype = proto_perl->Ilaststype;
10715 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10717 /* interpreter atexit processing */
10718 PL_exitlistlen = proto_perl->Iexitlistlen;
10719 if (PL_exitlistlen) {
10720 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10721 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10724 PL_exitlist = (PerlExitListEntry*)NULL;
10726 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10727 if (PL_my_cxt_size) {
10728 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10729 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10732 PL_my_cxt_list = (void**)NULL;
10733 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10734 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10735 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10737 PL_profiledata = NULL;
10738 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10739 /* PL_rsfp_filters entries have fake IoDIRP() */
10740 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10742 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10744 PAD_CLONE_VARS(proto_perl, param);
10746 #ifdef HAVE_INTERP_INTERN
10747 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10750 /* more statics moved here */
10751 PL_generation = proto_perl->Igeneration;
10752 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10754 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10755 PL_in_clean_all = proto_perl->Iin_clean_all;
10757 PL_uid = proto_perl->Iuid;
10758 PL_euid = proto_perl->Ieuid;
10759 PL_gid = proto_perl->Igid;
10760 PL_egid = proto_perl->Iegid;
10761 PL_nomemok = proto_perl->Inomemok;
10762 PL_an = proto_perl->Ian;
10763 PL_evalseq = proto_perl->Ievalseq;
10764 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10765 PL_origalen = proto_perl->Iorigalen;
10766 #ifdef PERL_USES_PL_PIDSTATUS
10767 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10769 PL_osname = SAVEPV(proto_perl->Iosname);
10770 PL_sighandlerp = proto_perl->Isighandlerp;
10772 PL_runops = proto_perl->Irunops;
10774 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10777 PL_cshlen = proto_perl->Icshlen;
10778 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10781 PL_lex_state = proto_perl->Ilex_state;
10782 PL_lex_defer = proto_perl->Ilex_defer;
10783 PL_lex_expect = proto_perl->Ilex_expect;
10784 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10785 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10786 PL_lex_starts = proto_perl->Ilex_starts;
10787 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10788 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10789 PL_lex_op = proto_perl->Ilex_op;
10790 PL_lex_inpat = proto_perl->Ilex_inpat;
10791 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10792 PL_lex_brackets = proto_perl->Ilex_brackets;
10793 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10794 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10795 PL_lex_casemods = proto_perl->Ilex_casemods;
10796 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10797 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10799 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10800 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10801 PL_nexttoke = proto_perl->Inexttoke;
10803 /* XXX This is probably masking the deeper issue of why
10804 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10805 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10806 * (A little debugging with a watchpoint on it may help.)
10808 if (SvANY(proto_perl->Ilinestr)) {
10809 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10810 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10811 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10812 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10813 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10814 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10815 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10816 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10817 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10820 PL_linestr = newSV(79);
10821 sv_upgrade(PL_linestr,SVt_PVIV);
10822 sv_setpvn(PL_linestr,"",0);
10823 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10825 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10826 PL_pending_ident = proto_perl->Ipending_ident;
10827 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10829 PL_expect = proto_perl->Iexpect;
10831 PL_multi_start = proto_perl->Imulti_start;
10832 PL_multi_end = proto_perl->Imulti_end;
10833 PL_multi_open = proto_perl->Imulti_open;
10834 PL_multi_close = proto_perl->Imulti_close;
10836 PL_error_count = proto_perl->Ierror_count;
10837 PL_subline = proto_perl->Isubline;
10838 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10840 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10841 if (SvANY(proto_perl->Ilinestr)) {
10842 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10843 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10844 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10845 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10846 PL_last_lop_op = proto_perl->Ilast_lop_op;
10849 PL_last_uni = SvPVX(PL_linestr);
10850 PL_last_lop = SvPVX(PL_linestr);
10851 PL_last_lop_op = 0;
10853 PL_in_my = proto_perl->Iin_my;
10854 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10856 PL_cryptseen = proto_perl->Icryptseen;
10859 PL_hints = proto_perl->Ihints;
10861 PL_amagic_generation = proto_perl->Iamagic_generation;
10863 #ifdef USE_LOCALE_COLLATE
10864 PL_collation_ix = proto_perl->Icollation_ix;
10865 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10866 PL_collation_standard = proto_perl->Icollation_standard;
10867 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10868 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10869 #endif /* USE_LOCALE_COLLATE */
10871 #ifdef USE_LOCALE_NUMERIC
10872 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10873 PL_numeric_standard = proto_perl->Inumeric_standard;
10874 PL_numeric_local = proto_perl->Inumeric_local;
10875 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10876 #endif /* !USE_LOCALE_NUMERIC */
10878 /* utf8 character classes */
10879 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10880 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10881 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10882 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10883 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10884 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10885 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10886 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10887 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10888 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10889 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10890 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10891 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10892 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10893 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10894 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10895 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10896 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10897 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10898 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10900 /* Did the locale setup indicate UTF-8? */
10901 PL_utf8locale = proto_perl->Iutf8locale;
10902 /* Unicode features (see perlrun/-C) */
10903 PL_unicode = proto_perl->Iunicode;
10905 /* Pre-5.8 signals control */
10906 PL_signals = proto_perl->Isignals;
10908 /* times() ticks per second */
10909 PL_clocktick = proto_perl->Iclocktick;
10911 /* Recursion stopper for PerlIO_find_layer */
10912 PL_in_load_module = proto_perl->Iin_load_module;
10914 /* sort() routine */
10915 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10917 /* Not really needed/useful since the reenrant_retint is "volatile",
10918 * but do it for consistency's sake. */
10919 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10921 /* Hooks to shared SVs and locks. */
10922 PL_sharehook = proto_perl->Isharehook;
10923 PL_lockhook = proto_perl->Ilockhook;
10924 PL_unlockhook = proto_perl->Iunlockhook;
10925 PL_threadhook = proto_perl->Ithreadhook;
10927 PL_runops_std = proto_perl->Irunops_std;
10928 PL_runops_dbg = proto_perl->Irunops_dbg;
10930 #ifdef THREADS_HAVE_PIDS
10931 PL_ppid = proto_perl->Ippid;
10935 PL_last_swash_hv = NULL; /* reinits on demand */
10936 PL_last_swash_klen = 0;
10937 PL_last_swash_key[0]= '\0';
10938 PL_last_swash_tmps = (U8*)NULL;
10939 PL_last_swash_slen = 0;
10941 PL_glob_index = proto_perl->Iglob_index;
10942 PL_srand_called = proto_perl->Isrand_called;
10943 PL_uudmap['M'] = 0; /* reinits on demand */
10944 PL_bitcount = NULL; /* reinits on demand */
10946 if (proto_perl->Ipsig_pend) {
10947 Newxz(PL_psig_pend, SIG_SIZE, int);
10950 PL_psig_pend = (int*)NULL;
10953 if (proto_perl->Ipsig_ptr) {
10954 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10955 Newxz(PL_psig_name, SIG_SIZE, SV*);
10956 for (i = 1; i < SIG_SIZE; i++) {
10957 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10958 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10962 PL_psig_ptr = (SV**)NULL;
10963 PL_psig_name = (SV**)NULL;
10966 /* thrdvar.h stuff */
10968 if (flags & CLONEf_COPY_STACKS) {
10969 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10970 PL_tmps_ix = proto_perl->Ttmps_ix;
10971 PL_tmps_max = proto_perl->Ttmps_max;
10972 PL_tmps_floor = proto_perl->Ttmps_floor;
10973 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10975 while (i <= PL_tmps_ix) {
10976 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10980 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10981 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10982 Newxz(PL_markstack, i, I32);
10983 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10984 - proto_perl->Tmarkstack);
10985 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10986 - proto_perl->Tmarkstack);
10987 Copy(proto_perl->Tmarkstack, PL_markstack,
10988 PL_markstack_ptr - PL_markstack + 1, I32);
10990 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10991 * NOTE: unlike the others! */
10992 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10993 PL_scopestack_max = proto_perl->Tscopestack_max;
10994 Newxz(PL_scopestack, PL_scopestack_max, I32);
10995 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10997 /* NOTE: si_dup() looks at PL_markstack */
10998 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11000 /* PL_curstack = PL_curstackinfo->si_stack; */
11001 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11002 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11004 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11005 PL_stack_base = AvARRAY(PL_curstack);
11006 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11007 - proto_perl->Tstack_base);
11008 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11010 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11011 * NOTE: unlike the others! */
11012 PL_savestack_ix = proto_perl->Tsavestack_ix;
11013 PL_savestack_max = proto_perl->Tsavestack_max;
11014 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11015 PL_savestack = ss_dup(proto_perl, param);
11019 ENTER; /* perl_destruct() wants to LEAVE; */
11021 /* although we're not duplicating the tmps stack, we should still
11022 * add entries for any SVs on the tmps stack that got cloned by a
11023 * non-refcount means (eg a temp in @_); otherwise they will be
11026 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11027 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11028 proto_perl->Ttmps_stack[i]);
11029 if (nsv && !SvREFCNT(nsv)) {
11031 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
11036 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11037 PL_top_env = &PL_start_env;
11039 PL_op = proto_perl->Top;
11042 PL_Xpv = (XPV*)NULL;
11043 PL_na = proto_perl->Tna;
11045 PL_statbuf = proto_perl->Tstatbuf;
11046 PL_statcache = proto_perl->Tstatcache;
11047 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11048 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11050 PL_timesbuf = proto_perl->Ttimesbuf;
11053 PL_tainted = proto_perl->Ttainted;
11054 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11055 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11056 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11057 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11058 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11059 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11060 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11061 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11062 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11064 PL_restartop = proto_perl->Trestartop;
11065 PL_in_eval = proto_perl->Tin_eval;
11066 PL_delaymagic = proto_perl->Tdelaymagic;
11067 PL_dirty = proto_perl->Tdirty;
11068 PL_localizing = proto_perl->Tlocalizing;
11070 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11071 PL_hv_fetch_ent_mh = NULL;
11072 PL_modcount = proto_perl->Tmodcount;
11073 PL_lastgotoprobe = NULL;
11074 PL_dumpindent = proto_perl->Tdumpindent;
11076 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11077 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11078 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11079 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11080 PL_efloatbuf = NULL; /* reinits on demand */
11081 PL_efloatsize = 0; /* reinits on demand */
11085 PL_screamfirst = NULL;
11086 PL_screamnext = NULL;
11087 PL_maxscream = -1; /* reinits on demand */
11088 PL_lastscream = NULL;
11090 PL_watchaddr = NULL;
11093 PL_regdummy = proto_perl->Tregdummy;
11094 PL_regprecomp = NULL;
11097 PL_colorset = 0; /* reinits PL_colors[] */
11098 /*PL_colors[6] = {0,0,0,0,0,0};*/
11099 PL_reginput = NULL;
11102 PL_regstartp = (I32*)NULL;
11103 PL_regendp = (I32*)NULL;
11104 PL_reglastparen = (U32*)NULL;
11105 PL_reglastcloseparen = (U32*)NULL;
11107 PL_reg_start_tmp = (char**)NULL;
11108 PL_reg_start_tmpl = 0;
11109 PL_regdata = (struct reg_data*)NULL;
11112 PL_reg_eval_set = 0;
11114 PL_regprogram = (regnode*)NULL;
11116 PL_regcc = (CURCUR*)NULL;
11117 PL_reg_call_cc = (struct re_cc_state*)NULL;
11118 PL_reg_re = (regexp*)NULL;
11119 PL_reg_ganch = NULL;
11121 PL_reg_match_utf8 = FALSE;
11122 PL_reg_magic = (MAGIC*)NULL;
11124 PL_reg_oldcurpm = (PMOP*)NULL;
11125 PL_reg_curpm = (PMOP*)NULL;
11126 PL_reg_oldsaved = NULL;
11127 PL_reg_oldsavedlen = 0;
11128 #ifdef PERL_OLD_COPY_ON_WRITE
11131 PL_reg_maxiter = 0;
11132 PL_reg_leftiter = 0;
11133 PL_reg_poscache = NULL;
11134 PL_reg_poscache_size= 0;
11136 /* RE engine - function pointers */
11137 PL_regcompp = proto_perl->Tregcompp;
11138 PL_regexecp = proto_perl->Tregexecp;
11139 PL_regint_start = proto_perl->Tregint_start;
11140 PL_regint_string = proto_perl->Tregint_string;
11141 PL_regfree = proto_perl->Tregfree;
11143 PL_reginterp_cnt = 0;
11144 PL_reg_starttry = 0;
11146 /* Pluggable optimizer */
11147 PL_peepp = proto_perl->Tpeepp;
11149 PL_stashcache = newHV();
11151 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11152 ptr_table_free(PL_ptr_table);
11153 PL_ptr_table = NULL;
11156 /* Call the ->CLONE method, if it exists, for each of the stashes
11157 identified by sv_dup() above.
11159 while(av_len(param->stashes) != -1) {
11160 HV* const stash = (HV*) av_shift(param->stashes);
11161 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11162 if (cloner && GvCV(cloner)) {
11167 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11169 call_sv((SV*)GvCV(cloner), G_DISCARD);
11175 SvREFCNT_dec(param->stashes);
11177 /* orphaned? eg threads->new inside BEGIN or use */
11178 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11179 (void)SvREFCNT_inc(PL_compcv);
11180 SAVEFREESV(PL_compcv);
11186 #endif /* USE_ITHREADS */
11189 =head1 Unicode Support
11191 =for apidoc sv_recode_to_utf8
11193 The encoding is assumed to be an Encode object, on entry the PV
11194 of the sv is assumed to be octets in that encoding, and the sv
11195 will be converted into Unicode (and UTF-8).
11197 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11198 is not a reference, nothing is done to the sv. If the encoding is not
11199 an C<Encode::XS> Encoding object, bad things will happen.
11200 (See F<lib/encoding.pm> and L<Encode>).
11202 The PV of the sv is returned.
11207 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11210 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11224 Passing sv_yes is wrong - it needs to be or'ed set of constants
11225 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11226 remove converted chars from source.
11228 Both will default the value - let them.
11230 XPUSHs(&PL_sv_yes);
11233 call_method("decode", G_SCALAR);
11237 s = SvPV_const(uni, len);
11238 if (s != SvPVX_const(sv)) {
11239 SvGROW(sv, len + 1);
11240 Move(s, SvPVX(sv), len + 1, char);
11241 SvCUR_set(sv, len);
11248 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11252 =for apidoc sv_cat_decode
11254 The encoding is assumed to be an Encode object, the PV of the ssv is
11255 assumed to be octets in that encoding and decoding the input starts
11256 from the position which (PV + *offset) pointed to. The dsv will be
11257 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11258 when the string tstr appears in decoding output or the input ends on
11259 the PV of the ssv. The value which the offset points will be modified
11260 to the last input position on the ssv.
11262 Returns TRUE if the terminator was found, else returns FALSE.
11267 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11268 SV *ssv, int *offset, char *tstr, int tlen)
11272 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11283 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11284 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11286 call_method("cat_decode", G_SCALAR);
11288 ret = SvTRUE(TOPs);
11289 *offset = SvIV(offsv);
11295 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11300 /* ---------------------------------------------------------------------
11302 * support functions for report_uninit()
11305 /* the maxiumum size of array or hash where we will scan looking
11306 * for the undefined element that triggered the warning */
11308 #define FUV_MAX_SEARCH_SIZE 1000
11310 /* Look for an entry in the hash whose value has the same SV as val;
11311 * If so, return a mortal copy of the key. */
11314 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11317 register HE **array;
11320 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11321 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11324 array = HvARRAY(hv);
11326 for (i=HvMAX(hv); i>0; i--) {
11327 register HE *entry;
11328 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11329 if (HeVAL(entry) != val)
11331 if ( HeVAL(entry) == &PL_sv_undef ||
11332 HeVAL(entry) == &PL_sv_placeholder)
11336 if (HeKLEN(entry) == HEf_SVKEY)
11337 return sv_mortalcopy(HeKEY_sv(entry));
11338 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11344 /* Look for an entry in the array whose value has the same SV as val;
11345 * If so, return the index, otherwise return -1. */
11348 S_find_array_subscript(pTHX_ AV *av, SV* val)
11353 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11354 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11358 for (i=AvFILLp(av); i>=0; i--) {
11359 if (svp[i] == val && svp[i] != &PL_sv_undef)
11365 /* S_varname(): return the name of a variable, optionally with a subscript.
11366 * If gv is non-zero, use the name of that global, along with gvtype (one
11367 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11368 * targ. Depending on the value of the subscript_type flag, return:
11371 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11372 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11373 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11374 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11377 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11378 SV* keyname, I32 aindex, int subscript_type)
11381 SV * const name = sv_newmortal();
11384 buffer[0] = gvtype;
11387 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11389 gv_fullname4(name, gv, buffer, 0);
11391 if ((unsigned int)SvPVX(name)[1] <= 26) {
11393 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11395 /* Swap the 1 unprintable control character for the 2 byte pretty
11396 version - ie substr($name, 1, 1) = $buffer; */
11397 sv_insert(name, 1, 1, buffer, 2);
11402 CV * const cv = find_runcv(&unused);
11406 if (!cv || !CvPADLIST(cv))
11408 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11409 sv = *av_fetch(av, targ, FALSE);
11410 /* SvLEN in a pad name is not to be trusted */
11411 sv_setpv(name, SvPV_nolen_const(sv));
11414 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11415 SV * const sv = newSV(0);
11416 *SvPVX(name) = '$';
11417 Perl_sv_catpvf(aTHX_ name, "{%s}",
11418 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11421 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11422 *SvPVX(name) = '$';
11423 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11425 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11426 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11433 =for apidoc find_uninit_var
11435 Find the name of the undefined variable (if any) that caused the operator o
11436 to issue a "Use of uninitialized value" warning.
11437 If match is true, only return a name if it's value matches uninit_sv.
11438 So roughly speaking, if a unary operator (such as OP_COS) generates a
11439 warning, then following the direct child of the op may yield an
11440 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11441 other hand, with OP_ADD there are two branches to follow, so we only print
11442 the variable name if we get an exact match.
11444 The name is returned as a mortal SV.
11446 Assumes that PL_op is the op that originally triggered the error, and that
11447 PL_comppad/PL_curpad points to the currently executing pad.
11453 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11461 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11462 uninit_sv == &PL_sv_placeholder)))
11465 switch (obase->op_type) {
11472 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11473 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11476 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11478 if (pad) { /* @lex, %lex */
11479 sv = PAD_SVl(obase->op_targ);
11483 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11484 /* @global, %global */
11485 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11488 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11490 else /* @{expr}, %{expr} */
11491 return find_uninit_var(cUNOPx(obase)->op_first,
11495 /* attempt to find a match within the aggregate */
11497 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11499 subscript_type = FUV_SUBSCRIPT_HASH;
11502 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11504 subscript_type = FUV_SUBSCRIPT_ARRAY;
11507 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11510 return varname(gv, hash ? '%' : '@', obase->op_targ,
11511 keysv, index, subscript_type);
11515 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11517 return varname(NULL, '$', obase->op_targ,
11518 NULL, 0, FUV_SUBSCRIPT_NONE);
11521 gv = cGVOPx_gv(obase);
11522 if (!gv || (match && GvSV(gv) != uninit_sv))
11524 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11527 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11530 av = (AV*)PAD_SV(obase->op_targ);
11531 if (!av || SvRMAGICAL(av))
11533 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11534 if (!svp || *svp != uninit_sv)
11537 return varname(NULL, '$', obase->op_targ,
11538 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11541 gv = cGVOPx_gv(obase);
11547 if (!av || SvRMAGICAL(av))
11549 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11550 if (!svp || *svp != uninit_sv)
11553 return varname(gv, '$', 0,
11554 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11559 o = cUNOPx(obase)->op_first;
11560 if (!o || o->op_type != OP_NULL ||
11561 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11563 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11567 if (PL_op == obase)
11568 /* $a[uninit_expr] or $h{uninit_expr} */
11569 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11572 o = cBINOPx(obase)->op_first;
11573 kid = cBINOPx(obase)->op_last;
11575 /* get the av or hv, and optionally the gv */
11577 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11578 sv = PAD_SV(o->op_targ);
11580 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11581 && cUNOPo->op_first->op_type == OP_GV)
11583 gv = cGVOPx_gv(cUNOPo->op_first);
11586 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11591 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11592 /* index is constant */
11596 if (obase->op_type == OP_HELEM) {
11597 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11598 if (!he || HeVAL(he) != uninit_sv)
11602 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11603 if (!svp || *svp != uninit_sv)
11607 if (obase->op_type == OP_HELEM)
11608 return varname(gv, '%', o->op_targ,
11609 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11611 return varname(gv, '@', o->op_targ, NULL,
11612 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11615 /* index is an expression;
11616 * attempt to find a match within the aggregate */
11617 if (obase->op_type == OP_HELEM) {
11618 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11620 return varname(gv, '%', o->op_targ,
11621 keysv, 0, FUV_SUBSCRIPT_HASH);
11624 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11626 return varname(gv, '@', o->op_targ,
11627 NULL, index, FUV_SUBSCRIPT_ARRAY);
11632 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11634 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11639 /* only examine RHS */
11640 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11643 o = cUNOPx(obase)->op_first;
11644 if (o->op_type == OP_PUSHMARK)
11647 if (!o->op_sibling) {
11648 /* one-arg version of open is highly magical */
11650 if (o->op_type == OP_GV) { /* open FOO; */
11652 if (match && GvSV(gv) != uninit_sv)
11654 return varname(gv, '$', 0,
11655 NULL, 0, FUV_SUBSCRIPT_NONE);
11657 /* other possibilities not handled are:
11658 * open $x; or open my $x; should return '${*$x}'
11659 * open expr; should return '$'.expr ideally
11665 /* ops where $_ may be an implicit arg */
11669 if ( !(obase->op_flags & OPf_STACKED)) {
11670 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11671 ? PAD_SVl(obase->op_targ)
11674 sv = sv_newmortal();
11675 sv_setpvn(sv, "$_", 2);
11683 /* skip filehandle as it can't produce 'undef' warning */
11684 o = cUNOPx(obase)->op_first;
11685 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11686 o = o->op_sibling->op_sibling;
11693 match = 1; /* XS or custom code could trigger random warnings */
11698 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11699 return sv_2mortal(newSVpvs("${$/}"));
11704 if (!(obase->op_flags & OPf_KIDS))
11706 o = cUNOPx(obase)->op_first;
11712 /* if all except one arg are constant, or have no side-effects,
11713 * or are optimized away, then it's unambiguous */
11715 for (kid=o; kid; kid = kid->op_sibling) {
11717 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11718 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11719 || (kid->op_type == OP_PUSHMARK)
11723 if (o2) { /* more than one found */
11730 return find_uninit_var(o2, uninit_sv, match);
11732 /* scan all args */
11734 sv = find_uninit_var(o, uninit_sv, 1);
11746 =for apidoc report_uninit
11748 Print appropriate "Use of uninitialized variable" warning
11754 Perl_report_uninit(pTHX_ SV* uninit_sv)
11758 SV* varname = NULL;
11760 varname = find_uninit_var(PL_op, uninit_sv,0);
11762 sv_insert(varname, 0, 0, " ", 1);
11764 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11765 varname ? SvPV_nolen_const(varname) : "",
11766 " in ", OP_DESC(PL_op));
11769 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11775 * c-indentation-style: bsd
11776 * c-basic-offset: 4
11777 * indent-tabs-mode: t
11780 * ex: set ts=8 sts=4 sw=4 noet:
https://perl5.git.perl.org / perl5.git / blob