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);
443 /* called by sv_clean_objs() for each live SV */
446 do_clean_objs(pTHX_ SV *ref)
450 SV * const target = SvRV(ref);
451 if (SvOBJECT(target)) {
452 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
453 if (SvWEAKREF(ref)) {
454 sv_del_backref(target, ref);
460 SvREFCNT_dec(target);
465 /* XXX Might want to check arrays, etc. */
468 /* called by sv_clean_objs() for each live SV */
470 #ifndef DISABLE_DESTRUCTOR_KLUDGE
472 do_clean_named_objs(pTHX_ SV *sv)
475 if (SvTYPE(sv) == SVt_PVGV && isGV_with_GP(sv) && GvGP(sv)) {
477 #ifdef PERL_DONT_CREATE_GVSV
480 SvOBJECT(GvSV(sv))) ||
481 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
482 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
483 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
484 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
486 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
487 SvFLAGS(sv) |= SVf_BREAK;
495 =for apidoc sv_clean_objs
497 Attempt to destroy all objects not yet freed
503 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
521 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
522 SvFLAGS(sv) |= SVf_BREAK;
523 if (PL_comppad == (AV*)sv) {
531 =for apidoc sv_clean_all
533 Decrement the refcnt of each remaining SV, possibly triggering a
534 cleanup. This function may have to be called multiple times to free
535 SVs which are in complex self-referential hierarchies.
541 Perl_sv_clean_all(pTHX)
545 PL_in_clean_all = TRUE;
546 cleaned = visit(do_clean_all, 0,0);
547 PL_in_clean_all = FALSE;
552 ARENASETS: a meta-arena implementation which separates arena-info
553 into struct arena_set, which contains an array of struct
554 arena_descs, each holding info for a single arena. By separating
555 the meta-info from the arena, we recover the 1st slot, formerly
556 borrowed for list management. The arena_set is about the size of an
557 arena, avoiding the needless malloc overhead of a naive linked-list
559 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
560 memory in the last arena-set (1/2 on average). In trade, we get
561 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
562 smaller types). The recovery of the wasted space allows use of
563 small arenas for large, rare body types,
566 char *arena; /* the raw storage, allocated aligned */
567 size_t size; /* its size ~4k typ */
568 int unit_type; /* useful for arena audits */
569 /* info for sv-heads (eventually)
576 /* Get the maximum number of elements in set[] such that struct arena_set
577 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
578 therefore likely to be 1 aligned memory page. */
580 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
581 - 2 * sizeof(int)) / sizeof (struct arena_desc))
584 struct arena_set* next;
585 int set_size; /* ie ARENAS_PER_SET */
586 int curr; /* index of next available arena-desc */
587 struct arena_desc set[ARENAS_PER_SET];
591 =for apidoc sv_free_arenas
593 Deallocate the memory used by all arenas. Note that all the individual SV
594 heads and bodies within the arenas must already have been freed.
599 Perl_sv_free_arenas(pTHX)
606 /* Free arenas here, but be careful about fake ones. (We assume
607 contiguity of the fake ones with the corresponding real ones.) */
609 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
610 svanext = (SV*) SvANY(sva);
611 while (svanext && SvFAKE(svanext))
612 svanext = (SV*) SvANY(svanext);
619 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
621 for (; aroot; aroot = next) {
622 const int max = aroot->curr;
623 for (i=0; i<max; i++) {
624 assert(aroot->set[i].arena);
625 Safefree(aroot->set[i].arena);
633 for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
634 PL_body_roots[i] = 0;
636 Safefree(PL_nice_chunk);
637 PL_nice_chunk = NULL;
638 PL_nice_chunk_size = 0;
644 Here are mid-level routines that manage the allocation of bodies out
645 of the various arenas. There are 5 kinds of arenas:
647 1. SV-head arenas, which are discussed and handled above
648 2. regular body arenas
649 3. arenas for reduced-size bodies
651 5. pte arenas (thread related)
653 Arena types 2 & 3 are chained by body-type off an array of
654 arena-root pointers, which is indexed by svtype. Some of the
655 larger/less used body types are malloced singly, since a large
656 unused block of them is wasteful. Also, several svtypes dont have
657 bodies; the data fits into the sv-head itself. The arena-root
658 pointer thus has a few unused root-pointers (which may be hijacked
659 later for arena types 4,5)
661 3 differs from 2 as an optimization; some body types have several
662 unused fields in the front of the structure (which are kept in-place
663 for consistency). These bodies can be allocated in smaller chunks,
664 because the leading fields arent accessed. Pointers to such bodies
665 are decremented to point at the unused 'ghost' memory, knowing that
666 the pointers are used with offsets to the real memory.
668 HE, HEK arenas are managed separately, with separate code, but may
669 be merge-able later..
671 PTE arenas are not sv-bodies, but they share these mid-level
672 mechanics, so are considered here. The new mid-level mechanics rely
673 on the sv_type of the body being allocated, so we just reserve one
674 of the unused body-slots for PTEs, then use it in those (2) PTE
675 contexts below (line ~10k)
678 /* get_arena(size): this creates custom-sized arenas
679 TBD: export properly for hv.c: S_more_he().
682 Perl_get_arena(pTHX_ int arena_size)
684 struct arena_desc* adesc;
685 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
688 /* shouldnt need this
689 if (!arena_size) arena_size = PERL_ARENA_SIZE;
692 /* may need new arena-set to hold new arena */
693 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
694 Newxz(newroot, 1, struct arena_set);
695 newroot->set_size = ARENAS_PER_SET;
696 newroot->next = *aroot;
698 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", *aroot));
701 /* ok, now have arena-set with at least 1 empty/available arena-desc */
702 curr = (*aroot)->curr++;
703 adesc = &((*aroot)->set[curr]);
704 assert(!adesc->arena);
706 Newxz(adesc->arena, arena_size, char);
707 adesc->size = arena_size;
708 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
709 curr, adesc->arena, arena_size));
715 /* return a thing to the free list */
717 #define del_body(thing, root) \
719 void ** const thing_copy = (void **)thing;\
721 *thing_copy = *root; \
722 *root = (void*)thing_copy; \
728 =head1 SV-Body Allocation
730 Allocation of SV-bodies is similar to SV-heads, differing as follows;
731 the allocation mechanism is used for many body types, so is somewhat
732 more complicated, it uses arena-sets, and has no need for still-live
735 At the outermost level, (new|del)_X*V macros return bodies of the
736 appropriate type. These macros call either (new|del)_body_type or
737 (new|del)_body_allocated macro pairs, depending on specifics of the
738 type. Most body types use the former pair, the latter pair is used to
739 allocate body types with "ghost fields".
741 "ghost fields" are fields that are unused in certain types, and
742 consequently dont need to actually exist. They are declared because
743 they're part of a "base type", which allows use of functions as
744 methods. The simplest examples are AVs and HVs, 2 aggregate types
745 which don't use the fields which support SCALAR semantics.
747 For these types, the arenas are carved up into *_allocated size
748 chunks, we thus avoid wasted memory for those unaccessed members.
749 When bodies are allocated, we adjust the pointer back in memory by the
750 size of the bit not allocated, so it's as if we allocated the full
751 structure. (But things will all go boom if you write to the part that
752 is "not there", because you'll be overwriting the last members of the
753 preceding structure in memory.)
755 We calculate the correction using the STRUCT_OFFSET macro. For
756 example, if xpv_allocated is the same structure as XPV then the two
757 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
758 structure is smaller (no initial NV actually allocated) then the net
759 effect is to subtract the size of the NV from the pointer, to return a
760 new pointer as if an initial NV were actually allocated.
762 This is the same trick as was used for NV and IV bodies. Ironically it
763 doesn't need to be used for NV bodies any more, because NV is now at
764 the start of the structure. IV bodies don't need it either, because
765 they are no longer allocated.
767 In turn, the new_body_* allocators call S_new_body(), which invokes
768 new_body_inline macro, which takes a lock, and takes a body off the
769 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
770 necessary to refresh an empty list. Then the lock is released, and
771 the body is returned.
773 S_more_bodies calls get_arena(), and carves it up into an array of N
774 bodies, which it strings into a linked list. It looks up arena-size
775 and body-size from the body_details table described below, thus
776 supporting the multiple body-types.
778 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
779 the (new|del)_X*V macros are mapped directly to malloc/free.
785 For each sv-type, struct body_details bodies_by_type[] carries
786 parameters which control these aspects of SV handling:
788 Arena_size determines whether arenas are used for this body type, and if
789 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
790 zero, forcing individual mallocs and frees.
792 Body_size determines how big a body is, and therefore how many fit into
793 each arena. Offset carries the body-pointer adjustment needed for
794 *_allocated body types, and is used in *_allocated macros.
796 But its main purpose is to parameterize info needed in
797 Perl_sv_upgrade(). The info here dramatically simplifies the function
798 vs the implementation in 5.8.7, making it table-driven. All fields
799 are used for this, except for arena_size.
801 For the sv-types that have no bodies, arenas are not used, so those
802 PL_body_roots[sv_type] are unused, and can be overloaded. In
803 something of a special case, SVt_NULL is borrowed for HE arenas;
804 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
805 bodies_by_type[SVt_NULL] slot is not used, as the table is not
808 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
809 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
810 they can just use the same allocation semantics. At first, PTEs were
811 also overloaded to a non-body sv-type, but this yielded hard-to-find
812 malloc bugs, so was simplified by claiming a new slot. This choice
813 has no consequence at this time.
817 struct body_details {
818 U8 body_size; /* Size to allocate */
819 U8 copy; /* Size of structure to copy (may be shorter) */
821 unsigned int type : 4; /* We have space for a sanity check. */
822 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
823 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
824 unsigned int arena : 1; /* Allocated from an arena */
825 size_t arena_size; /* Size of arena to allocate */
833 /* With -DPURFIY we allocate everything directly, and don't use arenas.
834 This seems a rather elegant way to simplify some of the code below. */
835 #define HASARENA FALSE
837 #define HASARENA TRUE
839 #define NOARENA FALSE
841 /* Size the arenas to exactly fit a given number of bodies. A count
842 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
843 simplifying the default. If count > 0, the arena is sized to fit
844 only that many bodies, allowing arenas to be used for large, rare
845 bodies (XPVFM, XPVIO) without undue waste. The arena size is
846 limited by PERL_ARENA_SIZE, so we can safely oversize the
849 #define FIT_ARENA0(body_size) \
850 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
851 #define FIT_ARENAn(count,body_size) \
852 ( count * body_size <= PERL_ARENA_SIZE) \
853 ? count * body_size \
854 : FIT_ARENA0 (body_size)
855 #define FIT_ARENA(count,body_size) \
857 ? FIT_ARENAn (count, body_size) \
858 : FIT_ARENA0 (body_size)
860 /* A macro to work out the offset needed to subtract from a pointer to (say)
867 to make its members accessible via a pointer to (say)
877 #define relative_STRUCT_OFFSET(longer, shorter, member) \
878 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
880 /* Calculate the length to copy. Specifically work out the length less any
881 final padding the compiler needed to add. See the comment in sv_upgrade
882 for why copying the padding proved to be a bug. */
884 #define copy_length(type, last_member) \
885 STRUCT_OFFSET(type, last_member) \
886 + sizeof (((type*)SvANY((SV*)0))->last_member)
888 static const struct body_details bodies_by_type[] = {
889 { sizeof(HE), 0, 0, SVt_NULL,
890 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
892 /* IVs are in the head, so the allocation size is 0.
893 However, the slot is overloaded for PTEs. */
894 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
895 sizeof(IV), /* This is used to copy out the IV body. */
896 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
897 NOARENA /* IVS don't need an arena */,
898 /* But PTEs need to know the size of their arena */
899 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
902 /* 8 bytes on most ILP32 with IEEE doubles */
903 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
904 FIT_ARENA(0, sizeof(NV)) },
906 /* RVs are in the head now. */
907 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
909 /* 8 bytes on most ILP32 with IEEE doubles */
910 { sizeof(xpv_allocated),
911 copy_length(XPV, xpv_len)
912 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
913 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
914 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
917 { sizeof(xpviv_allocated),
918 copy_length(XPVIV, xiv_u)
919 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
920 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
921 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
924 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
925 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
928 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
929 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
932 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
933 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
936 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
937 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
940 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
941 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
943 { sizeof(xpvav_allocated),
944 copy_length(XPVAV, xmg_stash)
945 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
946 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
947 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
949 { sizeof(xpvhv_allocated),
950 copy_length(XPVHV, xmg_stash)
951 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
952 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
953 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
956 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
957 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
958 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
960 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
961 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
962 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
964 /* XPVIO is 84 bytes, fits 48x */
965 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
966 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
969 #define new_body_type(sv_type) \
970 (void *)((char *)S_new_body(aTHX_ sv_type))
972 #define del_body_type(p, sv_type) \
973 del_body(p, &PL_body_roots[sv_type])
976 #define new_body_allocated(sv_type) \
977 (void *)((char *)S_new_body(aTHX_ sv_type) \
978 - bodies_by_type[sv_type].offset)
980 #define del_body_allocated(p, sv_type) \
981 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
984 #define my_safemalloc(s) (void*)safemalloc(s)
985 #define my_safecalloc(s) (void*)safecalloc(s, 1)
986 #define my_safefree(p) safefree((char*)p)
990 #define new_XNV() my_safemalloc(sizeof(XPVNV))
991 #define del_XNV(p) my_safefree(p)
993 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
994 #define del_XPVNV(p) my_safefree(p)
996 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
997 #define del_XPVAV(p) my_safefree(p)
999 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1000 #define del_XPVHV(p) my_safefree(p)
1002 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1003 #define del_XPVMG(p) my_safefree(p)
1005 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1006 #define del_XPVGV(p) my_safefree(p)
1010 #define new_XNV() new_body_type(SVt_NV)
1011 #define del_XNV(p) del_body_type(p, SVt_NV)
1013 #define new_XPVNV() new_body_type(SVt_PVNV)
1014 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1016 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1017 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1019 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1020 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1022 #define new_XPVMG() new_body_type(SVt_PVMG)
1023 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1025 #define new_XPVGV() new_body_type(SVt_PVGV)
1026 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1030 /* no arena for you! */
1032 #define new_NOARENA(details) \
1033 my_safemalloc((details)->body_size + (details)->offset)
1034 #define new_NOARENAZ(details) \
1035 my_safecalloc((details)->body_size + (details)->offset)
1038 static bool done_sanity_check;
1042 S_more_bodies (pTHX_ svtype sv_type)
1045 void ** const root = &PL_body_roots[sv_type];
1046 const struct body_details * const bdp = &bodies_by_type[sv_type];
1047 const size_t body_size = bdp->body_size;
1051 assert(bdp->arena_size);
1054 if (!done_sanity_check) {
1055 unsigned int i = SVt_LAST;
1057 done_sanity_check = TRUE;
1060 assert (bodies_by_type[i].type == i);
1064 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1066 end = start + bdp->arena_size - body_size;
1068 /* computed count doesnt reflect the 1st slot reservation */
1069 DEBUG_m(PerlIO_printf(Perl_debug_log,
1070 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1071 start, end, bdp->arena_size, sv_type, body_size,
1072 bdp->arena_size / body_size));
1074 *root = (void *)start;
1076 while (start < end) {
1077 char * const next = start + body_size;
1078 *(void**) start = (void *)next;
1081 *(void **)start = 0;
1086 /* grab a new thing from the free list, allocating more if necessary.
1087 The inline version is used for speed in hot routines, and the
1088 function using it serves the rest (unless PURIFY).
1090 #define new_body_inline(xpv, sv_type) \
1092 void ** const r3wt = &PL_body_roots[sv_type]; \
1094 xpv = *((void **)(r3wt)) \
1095 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ sv_type); \
1096 *(r3wt) = *(void**)(xpv); \
1103 S_new_body(pTHX_ svtype sv_type)
1107 new_body_inline(xpv, sv_type);
1114 =for apidoc sv_upgrade
1116 Upgrade an SV to a more complex form. Generally adds a new body type to the
1117 SV, then copies across as much information as possible from the old body.
1118 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1124 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1129 const U32 old_type = SvTYPE(sv);
1130 const struct body_details *new_type_details;
1131 const struct body_details *const old_type_details
1132 = bodies_by_type + old_type;
1134 if (new_type != SVt_PV && SvIsCOW(sv)) {
1135 sv_force_normal_flags(sv, 0);
1138 if (old_type == new_type)
1141 if (old_type > new_type)
1142 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1143 (int)old_type, (int)new_type);
1146 old_body = SvANY(sv);
1148 /* Copying structures onto other structures that have been neatly zeroed
1149 has a subtle gotcha. Consider XPVMG
1151 +------+------+------+------+------+-------+-------+
1152 | NV | CUR | LEN | IV | MAGIC | STASH |
1153 +------+------+------+------+------+-------+-------+
1154 0 4 8 12 16 20 24 28
1156 where NVs are aligned to 8 bytes, so that sizeof that structure is
1157 actually 32 bytes long, with 4 bytes of padding at the end:
1159 +------+------+------+------+------+-------+-------+------+
1160 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1161 +------+------+------+------+------+-------+-------+------+
1162 0 4 8 12 16 20 24 28 32
1164 so what happens if you allocate memory for this structure:
1166 +------+------+------+------+------+-------+-------+------+------+...
1167 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1168 +------+------+------+------+------+-------+-------+------+------+...
1169 0 4 8 12 16 20 24 28 32 36
1171 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1172 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1173 started out as zero once, but it's quite possible that it isn't. So now,
1174 rather than a nicely zeroed GP, you have it pointing somewhere random.
1177 (In fact, GP ends up pointing at a previous GP structure, because the
1178 principle cause of the padding in XPVMG getting garbage is a copy of
1179 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1181 So we are careful and work out the size of used parts of all the
1188 if (new_type < SVt_PVIV) {
1189 new_type = (new_type == SVt_NV)
1190 ? SVt_PVNV : SVt_PVIV;
1194 if (new_type < SVt_PVNV) {
1195 new_type = SVt_PVNV;
1201 assert(new_type > SVt_PV);
1202 assert(SVt_IV < SVt_PV);
1203 assert(SVt_NV < SVt_PV);
1210 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1211 there's no way that it can be safely upgraded, because perl.c
1212 expects to Safefree(SvANY(PL_mess_sv)) */
1213 assert(sv != PL_mess_sv);
1214 /* This flag bit is used to mean other things in other scalar types.
1215 Given that it only has meaning inside the pad, it shouldn't be set
1216 on anything that can get upgraded. */
1217 assert(!SvPAD_TYPED(sv));
1220 if (old_type_details->cant_upgrade)
1221 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1222 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1224 new_type_details = bodies_by_type + new_type;
1226 SvFLAGS(sv) &= ~SVTYPEMASK;
1227 SvFLAGS(sv) |= new_type;
1229 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1230 the return statements above will have triggered. */
1231 assert (new_type != SVt_NULL);
1234 assert(old_type == SVt_NULL);
1235 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1239 assert(old_type == SVt_NULL);
1240 SvANY(sv) = new_XNV();
1244 assert(old_type == SVt_NULL);
1245 SvANY(sv) = &sv->sv_u.svu_rv;
1250 assert(new_type_details->body_size);
1253 assert(new_type_details->arena);
1254 assert(new_type_details->arena_size);
1255 /* This points to the start of the allocated area. */
1256 new_body_inline(new_body, new_type);
1257 Zero(new_body, new_type_details->body_size, char);
1258 new_body = ((char *)new_body) - new_type_details->offset;
1260 /* We always allocated the full length item with PURIFY. To do this
1261 we fake things so that arena is false for all 16 types.. */
1262 new_body = new_NOARENAZ(new_type_details);
1264 SvANY(sv) = new_body;
1265 if (new_type == SVt_PVAV) {
1271 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1272 The target created by newSVrv also is, and it can have magic.
1273 However, it never has SvPVX set.
1275 if (old_type >= SVt_RV) {
1276 assert(SvPVX_const(sv) == 0);
1279 /* Could put this in the else clause below, as PVMG must have SvPVX
1280 0 already (the assertion above) */
1283 if (old_type >= SVt_PVMG) {
1284 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1285 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1291 /* XXX Is this still needed? Was it ever needed? Surely as there is
1292 no route from NV to PVIV, NOK can never be true */
1293 assert(!SvNOKp(sv));
1305 assert(new_type_details->body_size);
1306 /* We always allocated the full length item with PURIFY. To do this
1307 we fake things so that arena is false for all 16 types.. */
1308 if(new_type_details->arena) {
1309 /* This points to the start of the allocated area. */
1310 new_body_inline(new_body, new_type);
1311 Zero(new_body, new_type_details->body_size, char);
1312 new_body = ((char *)new_body) - new_type_details->offset;
1314 new_body = new_NOARENAZ(new_type_details);
1316 SvANY(sv) = new_body;
1318 if (old_type_details->copy) {
1319 /* There is now the potential for an upgrade from something without
1320 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1321 int offset = old_type_details->offset;
1322 int length = old_type_details->copy;
1324 if (new_type_details->offset > old_type_details->offset) {
1326 = new_type_details->offset - old_type_details->offset;
1327 offset += difference;
1328 length -= difference;
1330 assert (length >= 0);
1332 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1336 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1337 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1338 * correct 0.0 for us. Otherwise, if the old body didn't have an
1339 * NV slot, but the new one does, then we need to initialise the
1340 * freshly created NV slot with whatever the correct bit pattern is
1342 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1346 if (new_type == SVt_PVIO)
1347 IoPAGE_LEN(sv) = 60;
1348 if (old_type < SVt_RV)
1352 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1353 (unsigned long)new_type);
1356 if (old_type_details->arena) {
1357 /* If there was an old body, then we need to free it.
1358 Note that there is an assumption that all bodies of types that
1359 can be upgraded came from arenas. Only the more complex non-
1360 upgradable types are allowed to be directly malloc()ed. */
1362 my_safefree(old_body);
1364 del_body((void*)((char*)old_body + old_type_details->offset),
1365 &PL_body_roots[old_type]);
1371 =for apidoc sv_backoff
1373 Remove any string offset. You should normally use the C<SvOOK_off> macro
1380 Perl_sv_backoff(pTHX_ register SV *sv)
1382 PERL_UNUSED_CONTEXT;
1384 assert(SvTYPE(sv) != SVt_PVHV);
1385 assert(SvTYPE(sv) != SVt_PVAV);
1387 const char * const s = SvPVX_const(sv);
1388 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1389 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1391 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1393 SvFLAGS(sv) &= ~SVf_OOK;
1400 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1401 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1402 Use the C<SvGROW> wrapper instead.
1408 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1412 if (PL_madskills && newlen >= 0x100000) {
1413 PerlIO_printf(Perl_debug_log,
1414 "Allocation too large: %"UVxf"\n", (UV)newlen);
1416 #ifdef HAS_64K_LIMIT
1417 if (newlen >= 0x10000) {
1418 PerlIO_printf(Perl_debug_log,
1419 "Allocation too large: %"UVxf"\n", (UV)newlen);
1422 #endif /* HAS_64K_LIMIT */
1425 if (SvTYPE(sv) < SVt_PV) {
1426 sv_upgrade(sv, SVt_PV);
1427 s = SvPVX_mutable(sv);
1429 else if (SvOOK(sv)) { /* pv is offset? */
1431 s = SvPVX_mutable(sv);
1432 if (newlen > SvLEN(sv))
1433 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1434 #ifdef HAS_64K_LIMIT
1435 if (newlen >= 0x10000)
1440 s = SvPVX_mutable(sv);
1442 if (newlen > SvLEN(sv)) { /* need more room? */
1443 newlen = PERL_STRLEN_ROUNDUP(newlen);
1444 if (SvLEN(sv) && s) {
1446 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1452 s = saferealloc(s, newlen);
1455 s = safemalloc(newlen);
1456 if (SvPVX_const(sv) && SvCUR(sv)) {
1457 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1461 SvLEN_set(sv, newlen);
1467 =for apidoc sv_setiv
1469 Copies an integer into the given SV, upgrading first if necessary.
1470 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1476 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1479 SV_CHECK_THINKFIRST_COW_DROP(sv);
1480 switch (SvTYPE(sv)) {
1482 sv_upgrade(sv, SVt_IV);
1485 sv_upgrade(sv, SVt_PVNV);
1489 sv_upgrade(sv, SVt_PVIV);
1498 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1501 (void)SvIOK_only(sv); /* validate number */
1507 =for apidoc sv_setiv_mg
1509 Like C<sv_setiv>, but also handles 'set' magic.
1515 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1522 =for apidoc sv_setuv
1524 Copies an unsigned integer into the given SV, upgrading first if necessary.
1525 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1531 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1533 /* With these two if statements:
1534 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1537 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1539 If you wish to remove them, please benchmark to see what the effect is
1541 if (u <= (UV)IV_MAX) {
1542 sv_setiv(sv, (IV)u);
1551 =for apidoc sv_setuv_mg
1553 Like C<sv_setuv>, but also handles 'set' magic.
1559 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1568 =for apidoc sv_setnv
1570 Copies a double into the given SV, upgrading first if necessary.
1571 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1577 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1580 SV_CHECK_THINKFIRST_COW_DROP(sv);
1581 switch (SvTYPE(sv)) {
1584 sv_upgrade(sv, SVt_NV);
1589 sv_upgrade(sv, SVt_PVNV);
1598 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1602 (void)SvNOK_only(sv); /* validate number */
1607 =for apidoc sv_setnv_mg
1609 Like C<sv_setnv>, but also handles 'set' magic.
1615 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1621 /* Print an "isn't numeric" warning, using a cleaned-up,
1622 * printable version of the offending string
1626 S_not_a_number(pTHX_ SV *sv)
1634 dsv = sv_2mortal(newSVpvs(""));
1635 pv = sv_uni_display(dsv, sv, 10, 0);
1638 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1639 /* each *s can expand to 4 chars + "...\0",
1640 i.e. need room for 8 chars */
1642 const char *s = SvPVX_const(sv);
1643 const char * const end = s + SvCUR(sv);
1644 for ( ; s < end && d < limit; s++ ) {
1646 if (ch & 128 && !isPRINT_LC(ch)) {
1655 else if (ch == '\r') {
1659 else if (ch == '\f') {
1663 else if (ch == '\\') {
1667 else if (ch == '\0') {
1671 else if (isPRINT_LC(ch))
1688 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1689 "Argument \"%s\" isn't numeric in %s", pv,
1692 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1693 "Argument \"%s\" isn't numeric", pv);
1697 =for apidoc looks_like_number
1699 Test if the content of an SV looks like a number (or is a number).
1700 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1701 non-numeric warning), even if your atof() doesn't grok them.
1707 Perl_looks_like_number(pTHX_ SV *sv)
1709 register const char *sbegin;
1713 sbegin = SvPVX_const(sv);
1716 else if (SvPOKp(sv))
1717 sbegin = SvPV_const(sv, len);
1719 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1720 return grok_number(sbegin, len, NULL);
1724 S_glob_2inpuv(pTHX_ GV *gv, STRLEN *len, bool want_number)
1726 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1727 SV *const buffer = sv_newmortal();
1729 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1732 gv_efullname3(buffer, gv, "*");
1733 SvFLAGS(gv) |= wasfake;
1736 /* We know that all GVs stringify to something that is not-a-number,
1737 so no need to test that. */
1738 if (ckWARN(WARN_NUMERIC))
1739 not_a_number(buffer);
1740 /* We just want something true to return, so that S_sv_2iuv_common
1741 can tail call us and return true. */
1744 return SvPV(buffer, *len);
1748 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1749 until proven guilty, assume that things are not that bad... */
1754 As 64 bit platforms often have an NV that doesn't preserve all bits of
1755 an IV (an assumption perl has been based on to date) it becomes necessary
1756 to remove the assumption that the NV always carries enough precision to
1757 recreate the IV whenever needed, and that the NV is the canonical form.
1758 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1759 precision as a side effect of conversion (which would lead to insanity
1760 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1761 1) to distinguish between IV/UV/NV slots that have cached a valid
1762 conversion where precision was lost and IV/UV/NV slots that have a
1763 valid conversion which has lost no precision
1764 2) to ensure that if a numeric conversion to one form is requested that
1765 would lose precision, the precise conversion (or differently
1766 imprecise conversion) is also performed and cached, to prevent
1767 requests for different numeric formats on the same SV causing
1768 lossy conversion chains. (lossless conversion chains are perfectly
1773 SvIOKp is true if the IV slot contains a valid value
1774 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1775 SvNOKp is true if the NV slot contains a valid value
1776 SvNOK is true only if the NV value is accurate
1779 while converting from PV to NV, check to see if converting that NV to an
1780 IV(or UV) would lose accuracy over a direct conversion from PV to
1781 IV(or UV). If it would, cache both conversions, return NV, but mark
1782 SV as IOK NOKp (ie not NOK).
1784 While converting from PV to IV, check to see if converting that IV to an
1785 NV would lose accuracy over a direct conversion from PV to NV. If it
1786 would, cache both conversions, flag similarly.
1788 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1789 correctly because if IV & NV were set NV *always* overruled.
1790 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1791 changes - now IV and NV together means that the two are interchangeable:
1792 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1794 The benefit of this is that operations such as pp_add know that if
1795 SvIOK is true for both left and right operands, then integer addition
1796 can be used instead of floating point (for cases where the result won't
1797 overflow). Before, floating point was always used, which could lead to
1798 loss of precision compared with integer addition.
1800 * making IV and NV equal status should make maths accurate on 64 bit
1802 * may speed up maths somewhat if pp_add and friends start to use
1803 integers when possible instead of fp. (Hopefully the overhead in
1804 looking for SvIOK and checking for overflow will not outweigh the
1805 fp to integer speedup)
1806 * will slow down integer operations (callers of SvIV) on "inaccurate"
1807 values, as the change from SvIOK to SvIOKp will cause a call into
1808 sv_2iv each time rather than a macro access direct to the IV slot
1809 * should speed up number->string conversion on integers as IV is
1810 favoured when IV and NV are equally accurate
1812 ####################################################################
1813 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1814 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1815 On the other hand, SvUOK is true iff UV.
1816 ####################################################################
1818 Your mileage will vary depending your CPU's relative fp to integer
1822 #ifndef NV_PRESERVES_UV
1823 # define IS_NUMBER_UNDERFLOW_IV 1
1824 # define IS_NUMBER_UNDERFLOW_UV 2
1825 # define IS_NUMBER_IV_AND_UV 2
1826 # define IS_NUMBER_OVERFLOW_IV 4
1827 # define IS_NUMBER_OVERFLOW_UV 5
1829 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1831 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1833 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1836 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));
1837 if (SvNVX(sv) < (NV)IV_MIN) {
1838 (void)SvIOKp_on(sv);
1840 SvIV_set(sv, IV_MIN);
1841 return IS_NUMBER_UNDERFLOW_IV;
1843 if (SvNVX(sv) > (NV)UV_MAX) {
1844 (void)SvIOKp_on(sv);
1847 SvUV_set(sv, UV_MAX);
1848 return IS_NUMBER_OVERFLOW_UV;
1850 (void)SvIOKp_on(sv);
1852 /* Can't use strtol etc to convert this string. (See truth table in
1854 if (SvNVX(sv) <= (UV)IV_MAX) {
1855 SvIV_set(sv, I_V(SvNVX(sv)));
1856 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1857 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1859 /* Integer is imprecise. NOK, IOKp */
1861 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1864 SvUV_set(sv, U_V(SvNVX(sv)));
1865 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1866 if (SvUVX(sv) == UV_MAX) {
1867 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1868 possibly be preserved by NV. Hence, it must be overflow.
1870 return IS_NUMBER_OVERFLOW_UV;
1872 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1874 /* Integer is imprecise. NOK, IOKp */
1876 return IS_NUMBER_OVERFLOW_IV;
1878 #endif /* !NV_PRESERVES_UV*/
1881 S_sv_2iuv_common(pTHX_ SV *sv) {
1884 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1885 * without also getting a cached IV/UV from it at the same time
1886 * (ie PV->NV conversion should detect loss of accuracy and cache
1887 * IV or UV at same time to avoid this. */
1888 /* IV-over-UV optimisation - choose to cache IV if possible */
1890 if (SvTYPE(sv) == SVt_NV)
1891 sv_upgrade(sv, SVt_PVNV);
1893 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1894 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1895 certainly cast into the IV range at IV_MAX, whereas the correct
1896 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1898 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1899 SvIV_set(sv, I_V(SvNVX(sv)));
1900 if (SvNVX(sv) == (NV) SvIVX(sv)
1901 #ifndef NV_PRESERVES_UV
1902 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1903 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1904 /* Don't flag it as "accurately an integer" if the number
1905 came from a (by definition imprecise) NV operation, and
1906 we're outside the range of NV integer precision */
1909 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1910 DEBUG_c(PerlIO_printf(Perl_debug_log,
1911 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1917 /* IV not precise. No need to convert from PV, as NV
1918 conversion would already have cached IV if it detected
1919 that PV->IV would be better than PV->NV->IV
1920 flags already correct - don't set public IOK. */
1921 DEBUG_c(PerlIO_printf(Perl_debug_log,
1922 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1927 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1928 but the cast (NV)IV_MIN rounds to a the value less (more
1929 negative) than IV_MIN which happens to be equal to SvNVX ??
1930 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1931 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1932 (NV)UVX == NVX are both true, but the values differ. :-(
1933 Hopefully for 2s complement IV_MIN is something like
1934 0x8000000000000000 which will be exact. NWC */
1937 SvUV_set(sv, U_V(SvNVX(sv)));
1939 (SvNVX(sv) == (NV) SvUVX(sv))
1940 #ifndef NV_PRESERVES_UV
1941 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1942 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1943 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1944 /* Don't flag it as "accurately an integer" if the number
1945 came from a (by definition imprecise) NV operation, and
1946 we're outside the range of NV integer precision */
1951 DEBUG_c(PerlIO_printf(Perl_debug_log,
1952 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1958 else if (SvPOKp(sv) && SvLEN(sv)) {
1960 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1961 /* We want to avoid a possible problem when we cache an IV/ a UV which
1962 may be later translated to an NV, and the resulting NV is not
1963 the same as the direct translation of the initial string
1964 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1965 be careful to ensure that the value with the .456 is around if the
1966 NV value is requested in the future).
1968 This means that if we cache such an IV/a UV, we need to cache the
1969 NV as well. Moreover, we trade speed for space, and do not
1970 cache the NV if we are sure it's not needed.
1973 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1974 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1975 == IS_NUMBER_IN_UV) {
1976 /* It's definitely an integer, only upgrade to PVIV */
1977 if (SvTYPE(sv) < SVt_PVIV)
1978 sv_upgrade(sv, SVt_PVIV);
1980 } else if (SvTYPE(sv) < SVt_PVNV)
1981 sv_upgrade(sv, SVt_PVNV);
1983 /* If NVs preserve UVs then we only use the UV value if we know that
1984 we aren't going to call atof() below. If NVs don't preserve UVs
1985 then the value returned may have more precision than atof() will
1986 return, even though value isn't perfectly accurate. */
1987 if ((numtype & (IS_NUMBER_IN_UV
1988 #ifdef NV_PRESERVES_UV
1991 )) == IS_NUMBER_IN_UV) {
1992 /* This won't turn off the public IOK flag if it was set above */
1993 (void)SvIOKp_on(sv);
1995 if (!(numtype & IS_NUMBER_NEG)) {
1997 if (value <= (UV)IV_MAX) {
1998 SvIV_set(sv, (IV)value);
2000 /* it didn't overflow, and it was positive. */
2001 SvUV_set(sv, value);
2005 /* 2s complement assumption */
2006 if (value <= (UV)IV_MIN) {
2007 SvIV_set(sv, -(IV)value);
2009 /* Too negative for an IV. This is a double upgrade, but
2010 I'm assuming it will be rare. */
2011 if (SvTYPE(sv) < SVt_PVNV)
2012 sv_upgrade(sv, SVt_PVNV);
2016 SvNV_set(sv, -(NV)value);
2017 SvIV_set(sv, IV_MIN);
2021 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2022 will be in the previous block to set the IV slot, and the next
2023 block to set the NV slot. So no else here. */
2025 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2026 != IS_NUMBER_IN_UV) {
2027 /* It wasn't an (integer that doesn't overflow the UV). */
2028 SvNV_set(sv, Atof(SvPVX_const(sv)));
2030 if (! numtype && ckWARN(WARN_NUMERIC))
2033 #if defined(USE_LONG_DOUBLE)
2034 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2035 PTR2UV(sv), SvNVX(sv)));
2037 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2038 PTR2UV(sv), SvNVX(sv)));
2041 #ifdef NV_PRESERVES_UV
2042 (void)SvIOKp_on(sv);
2044 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2045 SvIV_set(sv, I_V(SvNVX(sv)));
2046 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2049 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp */
2051 /* UV will not work better than IV */
2053 if (SvNVX(sv) > (NV)UV_MAX) {
2055 /* Integer is inaccurate. NOK, IOKp, is UV */
2056 SvUV_set(sv, UV_MAX);
2058 SvUV_set(sv, U_V(SvNVX(sv)));
2059 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2060 NV preservse UV so can do correct comparison. */
2061 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2064 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp, is UV */
2069 #else /* NV_PRESERVES_UV */
2070 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2071 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2072 /* The IV/UV slot will have been set from value returned by
2073 grok_number above. The NV slot has just been set using
2076 assert (SvIOKp(sv));
2078 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2079 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2080 /* Small enough to preserve all bits. */
2081 (void)SvIOKp_on(sv);
2083 SvIV_set(sv, I_V(SvNVX(sv)));
2084 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2086 /* Assumption: first non-preserved integer is < IV_MAX,
2087 this NV is in the preserved range, therefore: */
2088 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2090 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);
2094 0 0 already failed to read UV.
2095 0 1 already failed to read UV.
2096 1 0 you won't get here in this case. IV/UV
2097 slot set, public IOK, Atof() unneeded.
2098 1 1 already read UV.
2099 so there's no point in sv_2iuv_non_preserve() attempting
2100 to use atol, strtol, strtoul etc. */
2101 sv_2iuv_non_preserve (sv, numtype);
2104 #endif /* NV_PRESERVES_UV */
2108 if (isGV_with_GP(sv)) {
2109 return (bool)PTR2IV(glob_2inpuv((GV *)sv, NULL, TRUE));
2112 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2113 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2116 if (SvTYPE(sv) < SVt_IV)
2117 /* Typically the caller expects that sv_any is not NULL now. */
2118 sv_upgrade(sv, SVt_IV);
2119 /* Return 0 from the caller. */
2126 =for apidoc sv_2iv_flags
2128 Return the integer value of an SV, doing any necessary string
2129 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2130 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2136 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2141 if (SvGMAGICAL(sv)) {
2142 if (flags & SV_GMAGIC)
2147 return I_V(SvNVX(sv));
2149 if (SvPOKp(sv) && SvLEN(sv)) {
2152 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2154 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2155 == IS_NUMBER_IN_UV) {
2156 /* It's definitely an integer */
2157 if (numtype & IS_NUMBER_NEG) {
2158 if (value < (UV)IV_MIN)
2161 if (value < (UV)IV_MAX)
2166 if (ckWARN(WARN_NUMERIC))
2169 return I_V(Atof(SvPVX_const(sv)));
2174 assert(SvTYPE(sv) >= SVt_PVMG);
2175 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2176 } else if (SvTHINKFIRST(sv)) {
2180 SV * const tmpstr=AMG_CALLun(sv,numer);
2181 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2182 return SvIV(tmpstr);
2185 return PTR2IV(SvRV(sv));
2188 sv_force_normal_flags(sv, 0);
2190 if (SvREADONLY(sv) && !SvOK(sv)) {
2191 if (ckWARN(WARN_UNINITIALIZED))
2197 if (S_sv_2iuv_common(aTHX_ sv))
2200 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2201 PTR2UV(sv),SvIVX(sv)));
2202 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2206 =for apidoc sv_2uv_flags
2208 Return the unsigned integer value of an SV, doing any necessary string
2209 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2210 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2216 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2221 if (SvGMAGICAL(sv)) {
2222 if (flags & SV_GMAGIC)
2227 return U_V(SvNVX(sv));
2228 if (SvPOKp(sv) && SvLEN(sv)) {
2231 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2233 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2234 == IS_NUMBER_IN_UV) {
2235 /* It's definitely an integer */
2236 if (!(numtype & IS_NUMBER_NEG))
2240 if (ckWARN(WARN_NUMERIC))
2243 return U_V(Atof(SvPVX_const(sv)));
2248 assert(SvTYPE(sv) >= SVt_PVMG);
2249 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2250 } else if (SvTHINKFIRST(sv)) {
2254 SV *const tmpstr = AMG_CALLun(sv,numer);
2255 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2256 return SvUV(tmpstr);
2259 return PTR2UV(SvRV(sv));
2262 sv_force_normal_flags(sv, 0);
2264 if (SvREADONLY(sv) && !SvOK(sv)) {
2265 if (ckWARN(WARN_UNINITIALIZED))
2271 if (S_sv_2iuv_common(aTHX_ sv))
2275 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2276 PTR2UV(sv),SvUVX(sv)));
2277 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2283 Return the num value of an SV, doing any necessary string or integer
2284 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2291 Perl_sv_2nv(pTHX_ register SV *sv)
2296 if (SvGMAGICAL(sv)) {
2300 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2301 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2302 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2304 return Atof(SvPVX_const(sv));
2308 return (NV)SvUVX(sv);
2310 return (NV)SvIVX(sv);
2315 assert(SvTYPE(sv) >= SVt_PVMG);
2316 /* This falls through to the report_uninit near the end of the
2318 } else if (SvTHINKFIRST(sv)) {
2322 SV *const tmpstr = AMG_CALLun(sv,numer);
2323 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2324 return SvNV(tmpstr);
2327 return PTR2NV(SvRV(sv));
2330 sv_force_normal_flags(sv, 0);
2332 if (SvREADONLY(sv) && !SvOK(sv)) {
2333 if (ckWARN(WARN_UNINITIALIZED))
2338 if (SvTYPE(sv) < SVt_NV) {
2339 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2340 sv_upgrade(sv, SVt_NV);
2341 #ifdef USE_LONG_DOUBLE
2343 STORE_NUMERIC_LOCAL_SET_STANDARD();
2344 PerlIO_printf(Perl_debug_log,
2345 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2346 PTR2UV(sv), SvNVX(sv));
2347 RESTORE_NUMERIC_LOCAL();
2351 STORE_NUMERIC_LOCAL_SET_STANDARD();
2352 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2353 PTR2UV(sv), SvNVX(sv));
2354 RESTORE_NUMERIC_LOCAL();
2358 else if (SvTYPE(sv) < SVt_PVNV)
2359 sv_upgrade(sv, SVt_PVNV);
2364 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2365 #ifdef NV_PRESERVES_UV
2368 /* Only set the public NV OK flag if this NV preserves the IV */
2369 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2370 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2371 : (SvIVX(sv) == I_V(SvNVX(sv))))
2377 else if (SvPOKp(sv) && SvLEN(sv)) {
2379 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2380 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2382 #ifdef NV_PRESERVES_UV
2383 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2384 == IS_NUMBER_IN_UV) {
2385 /* It's definitely an integer */
2386 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2388 SvNV_set(sv, Atof(SvPVX_const(sv)));
2391 SvNV_set(sv, Atof(SvPVX_const(sv)));
2392 /* Only set the public NV OK flag if this NV preserves the value in
2393 the PV at least as well as an IV/UV would.
2394 Not sure how to do this 100% reliably. */
2395 /* if that shift count is out of range then Configure's test is
2396 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2398 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2399 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2400 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2401 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2402 /* Can't use strtol etc to convert this string, so don't try.
2403 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2406 /* value has been set. It may not be precise. */
2407 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2408 /* 2s complement assumption for (UV)IV_MIN */
2409 SvNOK_on(sv); /* Integer is too negative. */
2414 if (numtype & IS_NUMBER_NEG) {
2415 SvIV_set(sv, -(IV)value);
2416 } else if (value <= (UV)IV_MAX) {
2417 SvIV_set(sv, (IV)value);
2419 SvUV_set(sv, value);
2423 if (numtype & IS_NUMBER_NOT_INT) {
2424 /* I believe that even if the original PV had decimals,
2425 they are lost beyond the limit of the FP precision.
2426 However, neither is canonical, so both only get p
2427 flags. NWC, 2000/11/25 */
2428 /* Both already have p flags, so do nothing */
2430 const NV nv = SvNVX(sv);
2431 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2432 if (SvIVX(sv) == I_V(nv)) {
2435 /* It had no "." so it must be integer. */
2439 /* between IV_MAX and NV(UV_MAX).
2440 Could be slightly > UV_MAX */
2442 if (numtype & IS_NUMBER_NOT_INT) {
2443 /* UV and NV both imprecise. */
2445 const UV nv_as_uv = U_V(nv);
2447 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2456 #endif /* NV_PRESERVES_UV */
2459 if (isGV_with_GP(sv)) {
2460 glob_2inpuv((GV *)sv, NULL, TRUE);
2464 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2466 assert (SvTYPE(sv) >= SVt_NV);
2467 /* Typically the caller expects that sv_any is not NULL now. */
2468 /* XXX Ilya implies that this is a bug in callers that assume this
2469 and ideally should be fixed. */
2472 #if defined(USE_LONG_DOUBLE)
2474 STORE_NUMERIC_LOCAL_SET_STANDARD();
2475 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2476 PTR2UV(sv), SvNVX(sv));
2477 RESTORE_NUMERIC_LOCAL();
2481 STORE_NUMERIC_LOCAL_SET_STANDARD();
2482 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2483 PTR2UV(sv), SvNVX(sv));
2484 RESTORE_NUMERIC_LOCAL();
2490 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2491 * UV as a string towards the end of buf, and return pointers to start and
2494 * We assume that buf is at least TYPE_CHARS(UV) long.
2498 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2500 char *ptr = buf + TYPE_CHARS(UV);
2501 char * const ebuf = ptr;
2514 *--ptr = '0' + (char)(uv % 10);
2522 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2523 * a regexp to its stringified form.
2527 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2529 const regexp * const re = (regexp *)mg->mg_obj;
2532 const char *fptr = "msix";
2537 bool need_newline = 0;
2538 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2540 while((ch = *fptr++)) {
2542 reflags[left++] = ch;
2545 reflags[right--] = ch;
2550 reflags[left] = '-';
2554 mg->mg_len = re->prelen + 4 + left;
2556 * If /x was used, we have to worry about a regex ending with a
2557 * comment later being embedded within another regex. If so, we don't
2558 * want this regex's "commentization" to leak out to the right part of
2559 * the enclosing regex, we must cap it with a newline.
2561 * So, if /x was used, we scan backwards from the end of the regex. If
2562 * we find a '#' before we find a newline, we need to add a newline
2563 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2564 * we don't need to add anything. -jfriedl
2566 if (PMf_EXTENDED & re->reganch) {
2567 const char *endptr = re->precomp + re->prelen;
2568 while (endptr >= re->precomp) {
2569 const char c = *(endptr--);
2571 break; /* don't need another */
2573 /* we end while in a comment, so we need a newline */
2574 mg->mg_len++; /* save space for it */
2575 need_newline = 1; /* note to add it */
2581 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2582 mg->mg_ptr[0] = '(';
2583 mg->mg_ptr[1] = '?';
2584 Copy(reflags, mg->mg_ptr+2, left, char);
2585 *(mg->mg_ptr+left+2) = ':';
2586 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2588 mg->mg_ptr[mg->mg_len - 2] = '\n';
2589 mg->mg_ptr[mg->mg_len - 1] = ')';
2590 mg->mg_ptr[mg->mg_len] = 0;
2592 PL_reginterp_cnt += re->program[0].next_off;
2594 if (re->reganch & ROPT_UTF8)
2604 =for apidoc sv_2pv_flags
2606 Returns a pointer to the string value of an SV, and sets *lp to its length.
2607 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2609 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2610 usually end up here too.
2616 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2626 if (SvGMAGICAL(sv)) {
2627 if (flags & SV_GMAGIC)
2632 if (flags & SV_MUTABLE_RETURN)
2633 return SvPVX_mutable(sv);
2634 if (flags & SV_CONST_RETURN)
2635 return (char *)SvPVX_const(sv);
2638 if (SvIOKp(sv) || SvNOKp(sv)) {
2639 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2643 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2644 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2646 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2653 #ifdef FIXNEGATIVEZERO
2654 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2660 SvUPGRADE(sv, SVt_PV);
2663 s = SvGROW_mutable(sv, len + 1);
2666 return memcpy(s, tbuf, len + 1);
2672 assert(SvTYPE(sv) >= SVt_PVMG);
2673 /* This falls through to the report_uninit near the end of the
2675 } else if (SvTHINKFIRST(sv)) {
2679 SV *const tmpstr = AMG_CALLun(sv,string);
2680 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2682 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2686 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2687 if (flags & SV_CONST_RETURN) {
2688 pv = (char *) SvPVX_const(tmpstr);
2690 pv = (flags & SV_MUTABLE_RETURN)
2691 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2694 *lp = SvCUR(tmpstr);
2696 pv = sv_2pv_flags(tmpstr, lp, flags);
2708 const SV *const referent = (SV*)SvRV(sv);
2711 tsv = sv_2mortal(newSVpvs("NULLREF"));
2712 } else if (SvTYPE(referent) == SVt_PVMG
2713 && ((SvFLAGS(referent) &
2714 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2715 == (SVs_OBJECT|SVs_SMG))
2716 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2717 return stringify_regexp(sv, mg, lp);
2719 const char *const typestr = sv_reftype(referent, 0);
2721 tsv = sv_newmortal();
2722 if (SvOBJECT(referent)) {
2723 const char *const name = HvNAME_get(SvSTASH(referent));
2724 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2725 name ? name : "__ANON__" , typestr,
2729 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2737 if (SvREADONLY(sv) && !SvOK(sv)) {
2738 if (ckWARN(WARN_UNINITIALIZED))
2745 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2746 /* I'm assuming that if both IV and NV are equally valid then
2747 converting the IV is going to be more efficient */
2748 const U32 isIOK = SvIOK(sv);
2749 const U32 isUIOK = SvIsUV(sv);
2750 char buf[TYPE_CHARS(UV)];
2753 if (SvTYPE(sv) < SVt_PVIV)
2754 sv_upgrade(sv, SVt_PVIV);
2755 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2756 /* inlined from sv_setpvn */
2757 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2758 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2759 SvCUR_set(sv, ebuf - ptr);
2769 else if (SvNOKp(sv)) {
2770 const int olderrno = errno;
2771 if (SvTYPE(sv) < SVt_PVNV)
2772 sv_upgrade(sv, SVt_PVNV);
2773 /* The +20 is pure guesswork. Configure test needed. --jhi */
2774 s = SvGROW_mutable(sv, NV_DIG + 20);
2775 /* some Xenix systems wipe out errno here */
2777 if (SvNVX(sv) == 0.0)
2778 (void)strcpy(s,"0");
2782 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2785 #ifdef FIXNEGATIVEZERO
2786 if (*s == '-' && s[1] == '0' && !s[2])
2796 if (isGV_with_GP(sv)) {
2797 return glob_2inpuv((GV *)sv, lp, FALSE);
2800 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2804 if (SvTYPE(sv) < SVt_PV)
2805 /* Typically the caller expects that sv_any is not NULL now. */
2806 sv_upgrade(sv, SVt_PV);
2810 const STRLEN len = s - SvPVX_const(sv);
2816 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2817 PTR2UV(sv),SvPVX_const(sv)));
2818 if (flags & SV_CONST_RETURN)
2819 return (char *)SvPVX_const(sv);
2820 if (flags & SV_MUTABLE_RETURN)
2821 return SvPVX_mutable(sv);
2826 =for apidoc sv_copypv
2828 Copies a stringified representation of the source SV into the
2829 destination SV. Automatically performs any necessary mg_get and
2830 coercion of numeric values into strings. Guaranteed to preserve
2831 UTF-8 flag even from overloaded objects. Similar in nature to
2832 sv_2pv[_flags] but operates directly on an SV instead of just the
2833 string. Mostly uses sv_2pv_flags to do its work, except when that
2834 would lose the UTF-8'ness of the PV.
2840 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2843 const char * const s = SvPV_const(ssv,len);
2844 sv_setpvn(dsv,s,len);
2852 =for apidoc sv_2pvbyte
2854 Return a pointer to the byte-encoded representation of the SV, and set *lp
2855 to its length. May cause the SV to be downgraded from UTF-8 as a
2858 Usually accessed via the C<SvPVbyte> macro.
2864 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2866 sv_utf8_downgrade(sv,0);
2867 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2871 =for apidoc sv_2pvutf8
2873 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2874 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2876 Usually accessed via the C<SvPVutf8> macro.
2882 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2884 sv_utf8_upgrade(sv);
2885 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2890 =for apidoc sv_2bool
2892 This function is only called on magical items, and is only used by
2893 sv_true() or its macro equivalent.
2899 Perl_sv_2bool(pTHX_ register SV *sv)
2908 SV * const tmpsv = AMG_CALLun(sv,bool_);
2909 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2910 return (bool)SvTRUE(tmpsv);
2912 return SvRV(sv) != 0;
2915 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2917 (*sv->sv_u.svu_pv > '0' ||
2918 Xpvtmp->xpv_cur > 1 ||
2919 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2926 return SvIVX(sv) != 0;
2929 return SvNVX(sv) != 0.0;
2931 if (isGV_with_GP(sv))
2941 =for apidoc sv_utf8_upgrade
2943 Converts the PV of an SV to its UTF-8-encoded form.
2944 Forces the SV to string form if it is not already.
2945 Always sets the SvUTF8 flag to avoid future validity checks even
2946 if all the bytes have hibit clear.
2948 This is not as a general purpose byte encoding to Unicode interface:
2949 use the Encode extension for that.
2951 =for apidoc sv_utf8_upgrade_flags
2953 Converts the PV of an SV to its UTF-8-encoded form.
2954 Forces the SV to string form if it is not already.
2955 Always sets the SvUTF8 flag to avoid future validity checks even
2956 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2957 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2958 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2960 This is not as a general purpose byte encoding to Unicode interface:
2961 use the Encode extension for that.
2967 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2970 if (sv == &PL_sv_undef)
2974 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2975 (void) sv_2pv_flags(sv,&len, flags);
2979 (void) SvPV_force(sv,len);
2988 sv_force_normal_flags(sv, 0);
2991 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2992 sv_recode_to_utf8(sv, PL_encoding);
2993 else { /* Assume Latin-1/EBCDIC */
2994 /* This function could be much more efficient if we
2995 * had a FLAG in SVs to signal if there are any hibit
2996 * chars in the PV. Given that there isn't such a flag
2997 * make the loop as fast as possible. */
2998 const U8 * const s = (U8 *) SvPVX_const(sv);
2999 const U8 * const e = (U8 *) SvEND(sv);
3004 /* Check for hi bit */
3005 if (!NATIVE_IS_INVARIANT(ch)) {
3006 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3007 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3009 SvPV_free(sv); /* No longer using what was there before. */
3010 SvPV_set(sv, (char*)recoded);
3011 SvCUR_set(sv, len - 1);
3012 SvLEN_set(sv, len); /* No longer know the real size. */
3016 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3023 =for apidoc sv_utf8_downgrade
3025 Attempts to convert the PV of an SV from characters to bytes.
3026 If the PV contains a character beyond byte, this conversion will fail;
3027 in this case, either returns false or, if C<fail_ok> is not
3030 This is not as a general purpose Unicode to byte encoding interface:
3031 use the Encode extension for that.
3037 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3040 if (SvPOKp(sv) && SvUTF8(sv)) {
3046 sv_force_normal_flags(sv, 0);
3048 s = (U8 *) SvPV(sv, len);
3049 if (!utf8_to_bytes(s, &len)) {
3054 Perl_croak(aTHX_ "Wide character in %s",
3057 Perl_croak(aTHX_ "Wide character");
3068 =for apidoc sv_utf8_encode
3070 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3071 flag off so that it looks like octets again.
3077 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3079 (void) sv_utf8_upgrade(sv);
3081 sv_force_normal_flags(sv, 0);
3083 if (SvREADONLY(sv)) {
3084 Perl_croak(aTHX_ PL_no_modify);
3090 =for apidoc sv_utf8_decode
3092 If the PV of the SV is an octet sequence in UTF-8
3093 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3094 so that it looks like a character. If the PV contains only single-byte
3095 characters, the C<SvUTF8> flag stays being off.
3096 Scans PV for validity and returns false if the PV is invalid UTF-8.
3102 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3108 /* The octets may have got themselves encoded - get them back as
3111 if (!sv_utf8_downgrade(sv, TRUE))
3114 /* it is actually just a matter of turning the utf8 flag on, but
3115 * we want to make sure everything inside is valid utf8 first.
3117 c = (const U8 *) SvPVX_const(sv);
3118 if (!is_utf8_string(c, SvCUR(sv)+1))
3120 e = (const U8 *) SvEND(sv);
3123 if (!UTF8_IS_INVARIANT(ch)) {
3133 =for apidoc sv_setsv
3135 Copies the contents of the source SV C<ssv> into the destination SV
3136 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3137 function if the source SV needs to be reused. Does not handle 'set' magic.
3138 Loosely speaking, it performs a copy-by-value, obliterating any previous
3139 content of the destination.
3141 You probably want to use one of the assortment of wrappers, such as
3142 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3143 C<SvSetMagicSV_nosteal>.
3145 =for apidoc sv_setsv_flags
3147 Copies the contents of the source SV C<ssv> into the destination SV
3148 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3149 function if the source SV needs to be reused. Does not handle 'set' magic.
3150 Loosely speaking, it performs a copy-by-value, obliterating any previous
3151 content of the destination.
3152 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3153 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3154 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3155 and C<sv_setsv_nomg> are implemented in terms of this function.
3157 You probably want to use one of the assortment of wrappers, such as
3158 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3159 C<SvSetMagicSV_nosteal>.
3161 This is the primary function for copying scalars, and most other
3162 copy-ish functions and macros use this underneath.
3168 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3170 if (dtype != SVt_PVGV) {
3171 const char * const name = GvNAME(sstr);
3172 const STRLEN len = GvNAMELEN(sstr);
3173 /* don't upgrade SVt_PVLV: it can hold a glob */
3174 if (dtype != SVt_PVLV) {
3175 if (dtype >= SVt_PV) {
3181 sv_upgrade(dstr, SVt_PVGV);
3182 (void)SvOK_off(dstr);
3185 GvSTASH(dstr) = GvSTASH(sstr);
3187 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3188 gv_name_set((GV *)dstr, name, len, GV_ADD);
3189 SvFAKE_on(dstr); /* can coerce to non-glob */
3192 #ifdef GV_UNIQUE_CHECK
3193 if (GvUNIQUE((GV*)dstr)) {
3194 Perl_croak(aTHX_ PL_no_modify);
3200 (void)SvOK_off(dstr);
3202 GvINTRO_off(dstr); /* one-shot flag */
3203 GvGP(dstr) = gp_ref(GvGP(sstr));
3204 if (SvTAINTED(sstr))
3206 if (GvIMPORTED(dstr) != GVf_IMPORTED
3207 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3209 GvIMPORTED_on(dstr);
3216 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3217 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3219 const int intro = GvINTRO(dstr);
3222 const U32 stype = SvTYPE(sref);
3225 #ifdef GV_UNIQUE_CHECK
3226 if (GvUNIQUE((GV*)dstr)) {
3227 Perl_croak(aTHX_ PL_no_modify);
3232 GvINTRO_off(dstr); /* one-shot flag */
3233 GvLINE(dstr) = CopLINE(PL_curcop);
3234 GvEGV(dstr) = (GV*)dstr;
3239 location = (SV **) &GvCV(dstr);
3240 import_flag = GVf_IMPORTED_CV;
3243 location = (SV **) &GvHV(dstr);
3244 import_flag = GVf_IMPORTED_HV;
3247 location = (SV **) &GvAV(dstr);
3248 import_flag = GVf_IMPORTED_AV;
3251 location = (SV **) &GvIOp(dstr);
3254 location = (SV **) &GvFORM(dstr);
3256 location = &GvSV(dstr);
3257 import_flag = GVf_IMPORTED_SV;
3260 if (stype == SVt_PVCV) {
3261 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3262 SvREFCNT_dec(GvCV(dstr));
3264 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3265 PL_sub_generation++;
3268 SAVEGENERICSV(*location);
3272 if (stype == SVt_PVCV && *location != sref) {
3273 CV* const cv = (CV*)*location;
3275 if (!GvCVGEN((GV*)dstr) &&
3276 (CvROOT(cv) || CvXSUB(cv)))
3278 /* Redefining a sub - warning is mandatory if
3279 it was a const and its value changed. */
3280 if (CvCONST(cv) && CvCONST((CV*)sref)
3281 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3283 /* They are 2 constant subroutines generated from
3284 the same constant. This probably means that
3285 they are really the "same" proxy subroutine
3286 instantiated in 2 places. Most likely this is
3287 when a constant is exported twice. Don't warn.
3290 else if (ckWARN(WARN_REDEFINE)
3292 && (!CvCONST((CV*)sref)
3293 || sv_cmp(cv_const_sv(cv),
3294 cv_const_sv((CV*)sref))))) {
3295 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3297 ? "Constant subroutine %s::%s redefined"
3298 : "Subroutine %s::%s redefined",
3299 HvNAME_get(GvSTASH((GV*)dstr)),
3300 GvENAME((GV*)dstr));
3304 cv_ckproto(cv, (GV*)dstr,
3305 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3307 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3308 GvASSUMECV_on(dstr);
3309 PL_sub_generation++;
3312 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3313 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3314 GvFLAGS(dstr) |= import_flag;
3319 if (SvTAINTED(sstr))
3325 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3328 register U32 sflags;
3334 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3336 sstr = &PL_sv_undef;
3337 stype = SvTYPE(sstr);
3338 dtype = SvTYPE(dstr);
3343 /* need to nuke the magic */
3345 SvRMAGICAL_off(dstr);
3348 /* There's a lot of redundancy below but we're going for speed here */
3353 if (dtype != SVt_PVGV) {
3354 (void)SvOK_off(dstr);
3362 sv_upgrade(dstr, SVt_IV);
3367 sv_upgrade(dstr, SVt_PVIV);
3370 (void)SvIOK_only(dstr);
3371 SvIV_set(dstr, SvIVX(sstr));
3374 /* SvTAINTED can only be true if the SV has taint magic, which in
3375 turn means that the SV type is PVMG (or greater). This is the
3376 case statement for SVt_IV, so this cannot be true (whatever gcov
3378 assert(!SvTAINTED(sstr));
3388 sv_upgrade(dstr, SVt_NV);
3393 sv_upgrade(dstr, SVt_PVNV);
3396 SvNV_set(dstr, SvNVX(sstr));
3397 (void)SvNOK_only(dstr);
3398 /* SvTAINTED can only be true if the SV has taint magic, which in
3399 turn means that the SV type is PVMG (or greater). This is the
3400 case statement for SVt_NV, so this cannot be true (whatever gcov
3402 assert(!SvTAINTED(sstr));
3409 sv_upgrade(dstr, SVt_RV);
3412 #ifdef PERL_OLD_COPY_ON_WRITE
3413 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3414 if (dtype < SVt_PVIV)
3415 sv_upgrade(dstr, SVt_PVIV);
3422 sv_upgrade(dstr, SVt_PV);
3425 if (dtype < SVt_PVIV)
3426 sv_upgrade(dstr, SVt_PVIV);
3429 if (dtype < SVt_PVNV)
3430 sv_upgrade(dstr, SVt_PVNV);
3434 const char * const type = sv_reftype(sstr,0);
3436 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3438 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3443 if (dtype <= SVt_PVGV) {
3444 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3452 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3454 if ((int)SvTYPE(sstr) != stype) {
3455 stype = SvTYPE(sstr);
3456 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3457 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3462 if (stype == SVt_PVLV)
3463 SvUPGRADE(dstr, SVt_PVNV);
3465 SvUPGRADE(dstr, (U32)stype);
3468 /* dstr may have been upgraded. */
3469 dtype = SvTYPE(dstr);
3470 sflags = SvFLAGS(sstr);
3472 if (sflags & SVf_ROK) {
3473 if (dtype == SVt_PVGV &&
3474 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3477 if (GvIMPORTED(dstr) != GVf_IMPORTED
3478 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3480 GvIMPORTED_on(dstr);
3485 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3489 if (dtype >= SVt_PV) {
3490 if (dtype == SVt_PVGV) {
3491 S_glob_assign_ref(aTHX_ dstr, sstr);
3494 if (SvPVX_const(dstr)) {
3500 (void)SvOK_off(dstr);
3501 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3502 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3503 assert(!(sflags & SVp_NOK));
3504 assert(!(sflags & SVp_IOK));
3505 assert(!(sflags & SVf_NOK));
3506 assert(!(sflags & SVf_IOK));
3508 else if (dtype == SVt_PVGV) {
3509 if (!(sflags & SVf_OK)) {
3510 if (ckWARN(WARN_MISC))
3511 Perl_warner(aTHX_ packWARN(WARN_MISC),
3512 "Undefined value assigned to typeglob");
3515 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3516 if (dstr != (SV*)gv) {
3519 GvGP(dstr) = gp_ref(GvGP(gv));
3523 else if (sflags & SVp_POK) {
3527 * Check to see if we can just swipe the string. If so, it's a
3528 * possible small lose on short strings, but a big win on long ones.
3529 * It might even be a win on short strings if SvPVX_const(dstr)
3530 * has to be allocated and SvPVX_const(sstr) has to be freed.
3533 /* Whichever path we take through the next code, we want this true,
3534 and doing it now facilitates the COW check. */
3535 (void)SvPOK_only(dstr);
3538 /* We're not already COW */
3539 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3540 #ifndef PERL_OLD_COPY_ON_WRITE
3541 /* or we are, but dstr isn't a suitable target. */
3542 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3547 (sflags & SVs_TEMP) && /* slated for free anyway? */
3548 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3549 (!(flags & SV_NOSTEAL)) &&
3550 /* and we're allowed to steal temps */
3551 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3552 SvLEN(sstr) && /* and really is a string */
3553 /* and won't be needed again, potentially */
3554 !(PL_op && PL_op->op_type == OP_AASSIGN))
3555 #ifdef PERL_OLD_COPY_ON_WRITE
3556 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3557 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3558 && SvTYPE(sstr) >= SVt_PVIV)
3561 /* Failed the swipe test, and it's not a shared hash key either.
3562 Have to copy the string. */
3563 STRLEN len = SvCUR(sstr);
3564 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3565 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3566 SvCUR_set(dstr, len);
3567 *SvEND(dstr) = '\0';
3569 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3571 /* Either it's a shared hash key, or it's suitable for
3572 copy-on-write or we can swipe the string. */
3574 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3578 #ifdef PERL_OLD_COPY_ON_WRITE
3580 /* I believe I should acquire a global SV mutex if
3581 it's a COW sv (not a shared hash key) to stop
3582 it going un copy-on-write.
3583 If the source SV has gone un copy on write between up there
3584 and down here, then (assert() that) it is of the correct
3585 form to make it copy on write again */
3586 if ((sflags & (SVf_FAKE | SVf_READONLY))
3587 != (SVf_FAKE | SVf_READONLY)) {
3588 SvREADONLY_on(sstr);
3590 /* Make the source SV into a loop of 1.
3591 (about to become 2) */
3592 SV_COW_NEXT_SV_SET(sstr, sstr);
3596 /* Initial code is common. */
3597 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3602 /* making another shared SV. */
3603 STRLEN cur = SvCUR(sstr);
3604 STRLEN len = SvLEN(sstr);
3605 #ifdef PERL_OLD_COPY_ON_WRITE
3607 assert (SvTYPE(dstr) >= SVt_PVIV);
3608 /* SvIsCOW_normal */
3609 /* splice us in between source and next-after-source. */
3610 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3611 SV_COW_NEXT_SV_SET(sstr, dstr);
3612 SvPV_set(dstr, SvPVX_mutable(sstr));
3616 /* SvIsCOW_shared_hash */
3617 DEBUG_C(PerlIO_printf(Perl_debug_log,
3618 "Copy on write: Sharing hash\n"));
3620 assert (SvTYPE(dstr) >= SVt_PV);
3622 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3624 SvLEN_set(dstr, len);
3625 SvCUR_set(dstr, cur);
3626 SvREADONLY_on(dstr);
3628 /* Relesase a global SV mutex. */
3631 { /* Passes the swipe test. */
3632 SvPV_set(dstr, SvPVX_mutable(sstr));
3633 SvLEN_set(dstr, SvLEN(sstr));
3634 SvCUR_set(dstr, SvCUR(sstr));
3637 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3638 SvPV_set(sstr, NULL);
3644 if (sflags & SVp_NOK) {
3645 SvNV_set(dstr, SvNVX(sstr));
3647 if (sflags & SVp_IOK) {
3648 SvRELEASE_IVX(dstr);
3649 SvIV_set(dstr, SvIVX(sstr));
3650 /* Must do this otherwise some other overloaded use of 0x80000000
3651 gets confused. I guess SVpbm_VALID */
3652 if (sflags & SVf_IVisUV)
3655 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3657 const MAGIC * const smg = SvVOK(sstr);
3659 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3660 smg->mg_ptr, smg->mg_len);
3661 SvRMAGICAL_on(dstr);
3665 else if (sflags & (SVp_IOK|SVp_NOK)) {
3666 (void)SvOK_off(dstr);
3667 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3668 if (sflags & SVp_IOK) {
3669 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3670 SvIV_set(dstr, SvIVX(sstr));
3672 if (sflags & SVp_NOK) {
3673 SvNV_set(dstr, SvNVX(sstr));
3677 if (isGV_with_GP(sstr)) {
3678 /* This stringification rule for globs is spread in 3 places.
3679 This feels bad. FIXME. */
3680 const U32 wasfake = sflags & SVf_FAKE;
3682 /* FAKE globs can get coerced, so need to turn this off
3683 temporarily if it is on. */
3685 gv_efullname3(dstr, (GV *)sstr, "*");
3686 SvFLAGS(sstr) |= wasfake;
3689 (void)SvOK_off(dstr);
3691 if (SvTAINTED(sstr))
3696 =for apidoc sv_setsv_mg
3698 Like C<sv_setsv>, but also handles 'set' magic.
3704 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3706 sv_setsv(dstr,sstr);
3710 #ifdef PERL_OLD_COPY_ON_WRITE
3712 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3714 STRLEN cur = SvCUR(sstr);
3715 STRLEN len = SvLEN(sstr);
3716 register char *new_pv;
3719 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3727 if (SvTHINKFIRST(dstr))
3728 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3729 else if (SvPVX_const(dstr))
3730 Safefree(SvPVX_const(dstr));
3734 SvUPGRADE(dstr, SVt_PVIV);
3736 assert (SvPOK(sstr));
3737 assert (SvPOKp(sstr));
3738 assert (!SvIOK(sstr));
3739 assert (!SvIOKp(sstr));
3740 assert (!SvNOK(sstr));
3741 assert (!SvNOKp(sstr));
3743 if (SvIsCOW(sstr)) {
3745 if (SvLEN(sstr) == 0) {
3746 /* source is a COW shared hash key. */
3747 DEBUG_C(PerlIO_printf(Perl_debug_log,
3748 "Fast copy on write: Sharing hash\n"));
3749 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3752 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3754 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3755 SvUPGRADE(sstr, SVt_PVIV);
3756 SvREADONLY_on(sstr);
3758 DEBUG_C(PerlIO_printf(Perl_debug_log,
3759 "Fast copy on write: Converting sstr to COW\n"));
3760 SV_COW_NEXT_SV_SET(dstr, sstr);
3762 SV_COW_NEXT_SV_SET(sstr, dstr);
3763 new_pv = SvPVX_mutable(sstr);
3766 SvPV_set(dstr, new_pv);
3767 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3770 SvLEN_set(dstr, len);
3771 SvCUR_set(dstr, cur);
3780 =for apidoc sv_setpvn
3782 Copies a string into an SV. The C<len> parameter indicates the number of
3783 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3784 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3790 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3793 register char *dptr;
3795 SV_CHECK_THINKFIRST_COW_DROP(sv);
3801 /* len is STRLEN which is unsigned, need to copy to signed */
3804 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3806 SvUPGRADE(sv, SVt_PV);
3808 dptr = SvGROW(sv, len + 1);
3809 Move(ptr,dptr,len,char);
3812 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3817 =for apidoc sv_setpvn_mg
3819 Like C<sv_setpvn>, but also handles 'set' magic.
3825 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3827 sv_setpvn(sv,ptr,len);
3832 =for apidoc sv_setpv
3834 Copies a string into an SV. The string must be null-terminated. Does not
3835 handle 'set' magic. See C<sv_setpv_mg>.
3841 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3844 register STRLEN len;
3846 SV_CHECK_THINKFIRST_COW_DROP(sv);
3852 SvUPGRADE(sv, SVt_PV);
3854 SvGROW(sv, len + 1);
3855 Move(ptr,SvPVX(sv),len+1,char);
3857 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3862 =for apidoc sv_setpv_mg
3864 Like C<sv_setpv>, but also handles 'set' magic.
3870 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3877 =for apidoc sv_usepvn
3879 Tells an SV to use C<ptr> to find its string value. Normally the string is
3880 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3881 The C<ptr> should point to memory that was allocated by C<malloc>. The
3882 string length, C<len>, must be supplied. This function will realloc the
3883 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3884 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3885 See C<sv_usepvn_mg>.
3891 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3895 SV_CHECK_THINKFIRST_COW_DROP(sv);
3896 SvUPGRADE(sv, SVt_PV);
3901 if (SvPVX_const(sv))
3904 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3905 ptr = saferealloc (ptr, allocate);
3908 SvLEN_set(sv, allocate);
3910 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3915 =for apidoc sv_usepvn_mg
3917 Like C<sv_usepvn>, but also handles 'set' magic.
3923 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3925 sv_usepvn(sv,ptr,len);
3929 #ifdef PERL_OLD_COPY_ON_WRITE
3930 /* Need to do this *after* making the SV normal, as we need the buffer
3931 pointer to remain valid until after we've copied it. If we let go too early,
3932 another thread could invalidate it by unsharing last of the same hash key
3933 (which it can do by means other than releasing copy-on-write Svs)
3934 or by changing the other copy-on-write SVs in the loop. */
3936 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3938 if (len) { /* this SV was SvIsCOW_normal(sv) */
3939 /* we need to find the SV pointing to us. */
3940 SV *current = SV_COW_NEXT_SV(after);
3942 if (current == sv) {
3943 /* The SV we point to points back to us (there were only two of us
3945 Hence other SV is no longer copy on write either. */
3947 SvREADONLY_off(after);
3949 /* We need to follow the pointers around the loop. */
3951 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3954 /* don't loop forever if the structure is bust, and we have
3955 a pointer into a closed loop. */
3956 assert (current != after);
3957 assert (SvPVX_const(current) == pvx);
3959 /* Make the SV before us point to the SV after us. */
3960 SV_COW_NEXT_SV_SET(current, after);
3963 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3968 Perl_sv_release_IVX(pTHX_ register SV *sv)
3971 sv_force_normal_flags(sv, 0);
3977 =for apidoc sv_force_normal_flags
3979 Undo various types of fakery on an SV: if the PV is a shared string, make
3980 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3981 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3982 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3983 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3984 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3985 set to some other value.) In addition, the C<flags> parameter gets passed to
3986 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3987 with flags set to 0.
3993 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3996 #ifdef PERL_OLD_COPY_ON_WRITE
3997 if (SvREADONLY(sv)) {
3998 /* At this point I believe I should acquire a global SV mutex. */
4000 const char * const pvx = SvPVX_const(sv);
4001 const STRLEN len = SvLEN(sv);
4002 const STRLEN cur = SvCUR(sv);
4003 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4005 PerlIO_printf(Perl_debug_log,
4006 "Copy on write: Force normal %ld\n",
4012 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4015 if (flags & SV_COW_DROP_PV) {
4016 /* OK, so we don't need to copy our buffer. */
4019 SvGROW(sv, cur + 1);
4020 Move(pvx,SvPVX(sv),cur,char);
4024 sv_release_COW(sv, pvx, len, next);
4029 else if (IN_PERL_RUNTIME)
4030 Perl_croak(aTHX_ PL_no_modify);
4031 /* At this point I believe that I can drop the global SV mutex. */
4034 if (SvREADONLY(sv)) {
4036 const char * const pvx = SvPVX_const(sv);
4037 const STRLEN len = SvCUR(sv);
4042 SvGROW(sv, len + 1);
4043 Move(pvx,SvPVX(sv),len,char);
4045 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4047 else if (IN_PERL_RUNTIME)
4048 Perl_croak(aTHX_ PL_no_modify);
4052 sv_unref_flags(sv, flags);
4053 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4060 Efficient removal of characters from the beginning of the string buffer.
4061 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4062 the string buffer. The C<ptr> becomes the first character of the adjusted
4063 string. Uses the "OOK hack".
4064 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4065 refer to the same chunk of data.
4071 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4073 register STRLEN delta;
4074 if (!ptr || !SvPOKp(sv))
4076 delta = ptr - SvPVX_const(sv);
4077 SV_CHECK_THINKFIRST(sv);
4078 if (SvTYPE(sv) < SVt_PVIV)
4079 sv_upgrade(sv,SVt_PVIV);
4082 if (!SvLEN(sv)) { /* make copy of shared string */
4083 const char *pvx = SvPVX_const(sv);
4084 const STRLEN len = SvCUR(sv);
4085 SvGROW(sv, len + 1);
4086 Move(pvx,SvPVX(sv),len,char);
4090 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4091 and we do that anyway inside the SvNIOK_off
4093 SvFLAGS(sv) |= SVf_OOK;
4096 SvLEN_set(sv, SvLEN(sv) - delta);
4097 SvCUR_set(sv, SvCUR(sv) - delta);
4098 SvPV_set(sv, SvPVX(sv) + delta);
4099 SvIV_set(sv, SvIVX(sv) + delta);
4103 =for apidoc sv_catpvn
4105 Concatenates the string onto the end of the string which is in the SV. The
4106 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4107 status set, then the bytes appended should be valid UTF-8.
4108 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4110 =for apidoc sv_catpvn_flags
4112 Concatenates the string onto the end of the string which is in the SV. The
4113 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4114 status set, then the bytes appended should be valid UTF-8.
4115 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4116 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4117 in terms of this function.
4123 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4127 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4129 SvGROW(dsv, dlen + slen + 1);
4131 sstr = SvPVX_const(dsv);
4132 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4133 SvCUR_set(dsv, SvCUR(dsv) + slen);
4135 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4137 if (flags & SV_SMAGIC)
4142 =for apidoc sv_catsv
4144 Concatenates the string from SV C<ssv> onto the end of the string in
4145 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4146 not 'set' magic. See C<sv_catsv_mg>.
4148 =for apidoc sv_catsv_flags
4150 Concatenates the string from SV C<ssv> onto the end of the string in
4151 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4152 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4153 and C<sv_catsv_nomg> are implemented in terms of this function.
4158 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4163 const char *spv = SvPV_const(ssv, slen);
4165 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4166 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4167 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4168 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4169 dsv->sv_flags doesn't have that bit set.
4170 Andy Dougherty 12 Oct 2001
4172 const I32 sutf8 = DO_UTF8(ssv);
4175 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4177 dutf8 = DO_UTF8(dsv);
4179 if (dutf8 != sutf8) {
4181 /* Not modifying source SV, so taking a temporary copy. */
4182 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4184 sv_utf8_upgrade(csv);
4185 spv = SvPV_const(csv, slen);
4188 sv_utf8_upgrade_nomg(dsv);
4190 sv_catpvn_nomg(dsv, spv, slen);
4193 if (flags & SV_SMAGIC)
4198 =for apidoc sv_catpv
4200 Concatenates the string onto the end of the string which is in the SV.
4201 If the SV has the UTF-8 status set, then the bytes appended should be
4202 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4207 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4210 register STRLEN len;
4216 junk = SvPV_force(sv, tlen);
4218 SvGROW(sv, tlen + len + 1);
4220 ptr = SvPVX_const(sv);
4221 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4222 SvCUR_set(sv, SvCUR(sv) + len);
4223 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4228 =for apidoc sv_catpv_mg
4230 Like C<sv_catpv>, but also handles 'set' magic.
4236 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4245 Creates a new SV. A non-zero C<len> parameter indicates the number of
4246 bytes of preallocated string space the SV should have. An extra byte for a
4247 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4248 space is allocated.) The reference count for the new SV is set to 1.
4250 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4251 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4252 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4253 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4254 modules supporting older perls.
4260 Perl_newSV(pTHX_ STRLEN len)
4267 sv_upgrade(sv, SVt_PV);
4268 SvGROW(sv, len + 1);
4273 =for apidoc sv_magicext
4275 Adds magic to an SV, upgrading it if necessary. Applies the
4276 supplied vtable and returns a pointer to the magic added.
4278 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4279 In particular, you can add magic to SvREADONLY SVs, and add more than
4280 one instance of the same 'how'.
4282 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4283 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4284 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4285 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4287 (This is now used as a subroutine by C<sv_magic>.)
4292 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4293 const char* name, I32 namlen)
4298 if (SvTYPE(sv) < SVt_PVMG) {
4299 SvUPGRADE(sv, SVt_PVMG);
4301 Newxz(mg, 1, MAGIC);
4302 mg->mg_moremagic = SvMAGIC(sv);
4303 SvMAGIC_set(sv, mg);
4305 /* Sometimes a magic contains a reference loop, where the sv and
4306 object refer to each other. To prevent a reference loop that
4307 would prevent such objects being freed, we look for such loops
4308 and if we find one we avoid incrementing the object refcount.
4310 Note we cannot do this to avoid self-tie loops as intervening RV must
4311 have its REFCNT incremented to keep it in existence.
4314 if (!obj || obj == sv ||
4315 how == PERL_MAGIC_arylen ||
4316 how == PERL_MAGIC_qr ||
4317 how == PERL_MAGIC_symtab ||
4318 (SvTYPE(obj) == SVt_PVGV &&
4319 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4320 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4321 GvFORM(obj) == (CV*)sv)))
4326 mg->mg_obj = SvREFCNT_inc_simple(obj);
4327 mg->mg_flags |= MGf_REFCOUNTED;
4330 /* Normal self-ties simply pass a null object, and instead of
4331 using mg_obj directly, use the SvTIED_obj macro to produce a
4332 new RV as needed. For glob "self-ties", we are tieing the PVIO
4333 with an RV obj pointing to the glob containing the PVIO. In
4334 this case, to avoid a reference loop, we need to weaken the
4338 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4339 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4345 mg->mg_len = namlen;
4348 mg->mg_ptr = savepvn(name, namlen);
4349 else if (namlen == HEf_SVKEY)
4350 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4352 mg->mg_ptr = (char *) name;
4354 mg->mg_virtual = vtable;
4358 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4363 =for apidoc sv_magic
4365 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4366 then adds a new magic item of type C<how> to the head of the magic list.
4368 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4369 handling of the C<name> and C<namlen> arguments.
4371 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4372 to add more than one instance of the same 'how'.
4378 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4384 #ifdef PERL_OLD_COPY_ON_WRITE
4386 sv_force_normal_flags(sv, 0);
4388 if (SvREADONLY(sv)) {
4390 /* its okay to attach magic to shared strings; the subsequent
4391 * upgrade to PVMG will unshare the string */
4392 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4395 && how != PERL_MAGIC_regex_global
4396 && how != PERL_MAGIC_bm
4397 && how != PERL_MAGIC_fm
4398 && how != PERL_MAGIC_sv
4399 && how != PERL_MAGIC_backref
4402 Perl_croak(aTHX_ PL_no_modify);
4405 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4406 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4407 /* sv_magic() refuses to add a magic of the same 'how' as an
4410 if (how == PERL_MAGIC_taint) {
4412 /* Any scalar which already had taint magic on which someone
4413 (erroneously?) did SvIOK_on() or similar will now be
4414 incorrectly sporting public "OK" flags. */
4415 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4423 vtable = &PL_vtbl_sv;
4425 case PERL_MAGIC_overload:
4426 vtable = &PL_vtbl_amagic;
4428 case PERL_MAGIC_overload_elem:
4429 vtable = &PL_vtbl_amagicelem;
4431 case PERL_MAGIC_overload_table:
4432 vtable = &PL_vtbl_ovrld;
4435 vtable = &PL_vtbl_bm;
4437 case PERL_MAGIC_regdata:
4438 vtable = &PL_vtbl_regdata;
4440 case PERL_MAGIC_regdatum:
4441 vtable = &PL_vtbl_regdatum;
4443 case PERL_MAGIC_env:
4444 vtable = &PL_vtbl_env;
4447 vtable = &PL_vtbl_fm;
4449 case PERL_MAGIC_envelem:
4450 vtable = &PL_vtbl_envelem;
4452 case PERL_MAGIC_regex_global:
4453 vtable = &PL_vtbl_mglob;
4455 case PERL_MAGIC_isa:
4456 vtable = &PL_vtbl_isa;
4458 case PERL_MAGIC_isaelem:
4459 vtable = &PL_vtbl_isaelem;
4461 case PERL_MAGIC_nkeys:
4462 vtable = &PL_vtbl_nkeys;
4464 case PERL_MAGIC_dbfile:
4467 case PERL_MAGIC_dbline:
4468 vtable = &PL_vtbl_dbline;
4470 #ifdef USE_LOCALE_COLLATE
4471 case PERL_MAGIC_collxfrm:
4472 vtable = &PL_vtbl_collxfrm;
4474 #endif /* USE_LOCALE_COLLATE */
4475 case PERL_MAGIC_tied:
4476 vtable = &PL_vtbl_pack;
4478 case PERL_MAGIC_tiedelem:
4479 case PERL_MAGIC_tiedscalar:
4480 vtable = &PL_vtbl_packelem;
4483 vtable = &PL_vtbl_regexp;
4485 case PERL_MAGIC_sig:
4486 vtable = &PL_vtbl_sig;
4488 case PERL_MAGIC_sigelem:
4489 vtable = &PL_vtbl_sigelem;
4491 case PERL_MAGIC_taint:
4492 vtable = &PL_vtbl_taint;
4494 case PERL_MAGIC_uvar:
4495 vtable = &PL_vtbl_uvar;
4497 case PERL_MAGIC_vec:
4498 vtable = &PL_vtbl_vec;
4500 case PERL_MAGIC_arylen_p:
4501 case PERL_MAGIC_rhash:
4502 case PERL_MAGIC_symtab:
4503 case PERL_MAGIC_vstring:
4506 case PERL_MAGIC_utf8:
4507 vtable = &PL_vtbl_utf8;
4509 case PERL_MAGIC_substr:
4510 vtable = &PL_vtbl_substr;
4512 case PERL_MAGIC_defelem:
4513 vtable = &PL_vtbl_defelem;
4515 case PERL_MAGIC_arylen:
4516 vtable = &PL_vtbl_arylen;
4518 case PERL_MAGIC_pos:
4519 vtable = &PL_vtbl_pos;
4521 case PERL_MAGIC_backref:
4522 vtable = &PL_vtbl_backref;
4524 case PERL_MAGIC_ext:
4525 /* Reserved for use by extensions not perl internals. */
4526 /* Useful for attaching extension internal data to perl vars. */
4527 /* Note that multiple extensions may clash if magical scalars */
4528 /* etc holding private data from one are passed to another. */
4532 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4535 /* Rest of work is done else where */
4536 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4539 case PERL_MAGIC_taint:
4542 case PERL_MAGIC_ext:
4543 case PERL_MAGIC_dbfile:
4550 =for apidoc sv_unmagic
4552 Removes all magic of type C<type> from an SV.
4558 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4562 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4564 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4565 for (mg = *mgp; mg; mg = *mgp) {
4566 if (mg->mg_type == type) {
4567 const MGVTBL* const vtbl = mg->mg_virtual;
4568 *mgp = mg->mg_moremagic;
4569 if (vtbl && vtbl->svt_free)
4570 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4571 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4573 Safefree(mg->mg_ptr);
4574 else if (mg->mg_len == HEf_SVKEY)
4575 SvREFCNT_dec((SV*)mg->mg_ptr);
4576 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4577 Safefree(mg->mg_ptr);
4579 if (mg->mg_flags & MGf_REFCOUNTED)
4580 SvREFCNT_dec(mg->mg_obj);
4584 mgp = &mg->mg_moremagic;
4588 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4589 SvMAGIC_set(sv, NULL);
4596 =for apidoc sv_rvweaken
4598 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4599 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4600 push a back-reference to this RV onto the array of backreferences
4601 associated with that magic.
4607 Perl_sv_rvweaken(pTHX_ SV *sv)
4610 if (!SvOK(sv)) /* let undefs pass */
4613 Perl_croak(aTHX_ "Can't weaken a nonreference");
4614 else if (SvWEAKREF(sv)) {
4615 if (ckWARN(WARN_MISC))
4616 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4620 Perl_sv_add_backref(aTHX_ tsv, sv);
4626 /* Give tsv backref magic if it hasn't already got it, then push a
4627 * back-reference to sv onto the array associated with the backref magic.
4631 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4636 if (SvTYPE(tsv) == SVt_PVHV) {
4637 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4641 /* There is no AV in the offical place - try a fixup. */
4642 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4645 /* Aha. They've got it stowed in magic. Bring it back. */
4646 av = (AV*)mg->mg_obj;
4647 /* Stop mg_free decreasing the refernce count. */
4649 /* Stop mg_free even calling the destructor, given that
4650 there's no AV to free up. */
4652 sv_unmagic(tsv, PERL_MAGIC_backref);
4656 SvREFCNT_inc_simple_void(av);
4661 const MAGIC *const mg
4662 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4664 av = (AV*)mg->mg_obj;
4668 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4669 /* av now has a refcnt of 2, which avoids it getting freed
4670 * before us during global cleanup. The extra ref is removed
4671 * by magic_killbackrefs() when tsv is being freed */
4674 if (AvFILLp(av) >= AvMAX(av)) {
4675 av_extend(av, AvFILLp(av)+1);
4677 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4680 /* delete a back-reference to ourselves from the backref magic associated
4681 * with the SV we point to.
4685 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4692 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4693 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4694 /* We mustn't attempt to "fix up" the hash here by moving the
4695 backreference array back to the hv_aux structure, as that is stored
4696 in the main HvARRAY(), and hfreentries assumes that no-one
4697 reallocates HvARRAY() while it is running. */
4700 const MAGIC *const mg
4701 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4703 av = (AV *)mg->mg_obj;
4706 if (PL_in_clean_all)
4708 Perl_croak(aTHX_ "panic: del_backref");
4715 /* We shouldn't be in here more than once, but for paranoia reasons lets
4717 for (i = AvFILLp(av); i >= 0; i--) {
4719 const SSize_t fill = AvFILLp(av);
4721 /* We weren't the last entry.
4722 An unordered list has this property that you can take the
4723 last element off the end to fill the hole, and it's still
4724 an unordered list :-)
4729 AvFILLp(av) = fill - 1;
4735 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4737 SV **svp = AvARRAY(av);
4739 PERL_UNUSED_ARG(sv);
4741 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4742 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4743 if (svp && !SvIS_FREED(av)) {
4744 SV *const *const last = svp + AvFILLp(av);
4746 while (svp <= last) {
4748 SV *const referrer = *svp;
4749 if (SvWEAKREF(referrer)) {
4750 /* XXX Should we check that it hasn't changed? */
4751 SvRV_set(referrer, 0);
4753 SvWEAKREF_off(referrer);
4754 } else if (SvTYPE(referrer) == SVt_PVGV ||
4755 SvTYPE(referrer) == SVt_PVLV) {
4756 /* You lookin' at me? */
4757 assert(GvSTASH(referrer));
4758 assert(GvSTASH(referrer) == (HV*)sv);
4759 GvSTASH(referrer) = 0;
4762 "panic: magic_killbackrefs (flags=%"UVxf")",
4763 (UV)SvFLAGS(referrer));
4771 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4776 =for apidoc sv_insert
4778 Inserts a string at the specified offset/length within the SV. Similar to
4779 the Perl substr() function.
4785 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4790 register char *midend;
4791 register char *bigend;
4797 Perl_croak(aTHX_ "Can't modify non-existent substring");
4798 SvPV_force(bigstr, curlen);
4799 (void)SvPOK_only_UTF8(bigstr);
4800 if (offset + len > curlen) {
4801 SvGROW(bigstr, offset+len+1);
4802 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4803 SvCUR_set(bigstr, offset+len);
4807 i = littlelen - len;
4808 if (i > 0) { /* string might grow */
4809 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4810 mid = big + offset + len;
4811 midend = bigend = big + SvCUR(bigstr);
4814 while (midend > mid) /* shove everything down */
4815 *--bigend = *--midend;
4816 Move(little,big+offset,littlelen,char);
4817 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4822 Move(little,SvPVX(bigstr)+offset,len,char);
4827 big = SvPVX(bigstr);
4830 bigend = big + SvCUR(bigstr);
4832 if (midend > bigend)
4833 Perl_croak(aTHX_ "panic: sv_insert");
4835 if (mid - big > bigend - midend) { /* faster to shorten from end */
4837 Move(little, mid, littlelen,char);
4840 i = bigend - midend;
4842 Move(midend, mid, i,char);
4846 SvCUR_set(bigstr, mid - big);
4848 else if ((i = mid - big)) { /* faster from front */
4849 midend -= littlelen;
4851 sv_chop(bigstr,midend-i);
4856 Move(little, mid, littlelen,char);
4858 else if (littlelen) {
4859 midend -= littlelen;
4860 sv_chop(bigstr,midend);
4861 Move(little,midend,littlelen,char);
4864 sv_chop(bigstr,midend);
4870 =for apidoc sv_replace
4872 Make the first argument a copy of the second, then delete the original.
4873 The target SV physically takes over ownership of the body of the source SV
4874 and inherits its flags; however, the target keeps any magic it owns,
4875 and any magic in the source is discarded.
4876 Note that this is a rather specialist SV copying operation; most of the
4877 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4883 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4886 const U32 refcnt = SvREFCNT(sv);
4887 SV_CHECK_THINKFIRST_COW_DROP(sv);
4888 if (SvREFCNT(nsv) != 1) {
4889 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4890 UVuf " != 1)", (UV) SvREFCNT(nsv));
4892 if (SvMAGICAL(sv)) {
4896 sv_upgrade(nsv, SVt_PVMG);
4897 SvMAGIC_set(nsv, SvMAGIC(sv));
4898 SvFLAGS(nsv) |= SvMAGICAL(sv);
4900 SvMAGIC_set(sv, NULL);
4904 assert(!SvREFCNT(sv));
4905 #ifdef DEBUG_LEAKING_SCALARS
4906 sv->sv_flags = nsv->sv_flags;
4907 sv->sv_any = nsv->sv_any;
4908 sv->sv_refcnt = nsv->sv_refcnt;
4909 sv->sv_u = nsv->sv_u;
4911 StructCopy(nsv,sv,SV);
4913 /* Currently could join these into one piece of pointer arithmetic, but
4914 it would be unclear. */
4915 if(SvTYPE(sv) == SVt_IV)
4917 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4918 else if (SvTYPE(sv) == SVt_RV) {
4919 SvANY(sv) = &sv->sv_u.svu_rv;
4923 #ifdef PERL_OLD_COPY_ON_WRITE
4924 if (SvIsCOW_normal(nsv)) {
4925 /* We need to follow the pointers around the loop to make the
4926 previous SV point to sv, rather than nsv. */
4929 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4932 assert(SvPVX_const(current) == SvPVX_const(nsv));
4934 /* Make the SV before us point to the SV after us. */
4936 PerlIO_printf(Perl_debug_log, "previous is\n");
4938 PerlIO_printf(Perl_debug_log,
4939 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4940 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4942 SV_COW_NEXT_SV_SET(current, sv);
4945 SvREFCNT(sv) = refcnt;
4946 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4952 =for apidoc sv_clear
4954 Clear an SV: call any destructors, free up any memory used by the body,
4955 and free the body itself. The SV's head is I<not> freed, although
4956 its type is set to all 1's so that it won't inadvertently be assumed
4957 to be live during global destruction etc.
4958 This function should only be called when REFCNT is zero. Most of the time
4959 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4966 Perl_sv_clear(pTHX_ register SV *sv)
4969 const U32 type = SvTYPE(sv);
4970 const struct body_details *const sv_type_details
4971 = bodies_by_type + type;
4974 assert(SvREFCNT(sv) == 0);
4976 if (type <= SVt_IV) {
4977 /* See the comment in sv.h about the collusion between this early
4978 return and the overloading of the NULL and IV slots in the size
4984 if (PL_defstash) { /* Still have a symbol table? */
4989 stash = SvSTASH(sv);
4990 destructor = StashHANDLER(stash,DESTROY);
4992 SV* const tmpref = newRV(sv);
4993 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4995 PUSHSTACKi(PERLSI_DESTROY);
5000 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5006 if(SvREFCNT(tmpref) < 2) {
5007 /* tmpref is not kept alive! */
5009 SvRV_set(tmpref, NULL);
5012 SvREFCNT_dec(tmpref);
5014 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5018 if (PL_in_clean_objs)
5019 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5021 /* DESTROY gave object new lease on life */
5027 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5028 SvOBJECT_off(sv); /* Curse the object. */
5029 if (type != SVt_PVIO)
5030 --PL_sv_objcount; /* XXX Might want something more general */
5033 if (type >= SVt_PVMG) {
5035 if ((type == SVt_PVMG || type == SVt_PVGV) &&
5036 (ourstash = OURSTASH(sv))) {
5037 SvREFCNT_dec(ourstash);
5038 } else if (SvMAGIC(sv))
5040 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5041 SvREFCNT_dec(SvSTASH(sv));
5046 IoIFP(sv) != PerlIO_stdin() &&
5047 IoIFP(sv) != PerlIO_stdout() &&
5048 IoIFP(sv) != PerlIO_stderr())
5050 io_close((IO*)sv, FALSE);
5052 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5053 PerlDir_close(IoDIRP(sv));
5054 IoDIRP(sv) = (DIR*)NULL;
5055 Safefree(IoTOP_NAME(sv));
5056 Safefree(IoFMT_NAME(sv));
5057 Safefree(IoBOTTOM_NAME(sv));
5066 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5073 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5074 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5075 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5076 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5078 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5079 SvREFCNT_dec(LvTARG(sv));
5083 if (GvNAME_HEK(sv)) {
5084 unshare_hek(GvNAME_HEK(sv));
5086 /* If we're in a stash, we don't own a reference to it. However it does
5087 have a back reference to us, which needs to be cleared. */
5089 sv_del_backref((SV*)GvSTASH(sv), sv);
5094 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5096 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5097 /* Don't even bother with turning off the OOK flag. */
5102 SV * const target = SvRV(sv);
5104 sv_del_backref(target, sv);
5106 SvREFCNT_dec(target);
5108 #ifdef PERL_OLD_COPY_ON_WRITE
5109 else if (SvPVX_const(sv)) {
5111 /* I believe I need to grab the global SV mutex here and
5112 then recheck the COW status. */
5114 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5117 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5118 SV_COW_NEXT_SV(sv));
5119 /* And drop it here. */
5121 } else if (SvLEN(sv)) {
5122 Safefree(SvPVX_const(sv));
5126 else if (SvPVX_const(sv) && SvLEN(sv))
5127 Safefree(SvPVX_mutable(sv));
5128 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5129 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5138 SvFLAGS(sv) &= SVf_BREAK;
5139 SvFLAGS(sv) |= SVTYPEMASK;
5141 if (sv_type_details->arena) {
5142 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5143 &PL_body_roots[type]);
5145 else if (sv_type_details->body_size) {
5146 my_safefree(SvANY(sv));
5151 =for apidoc sv_newref
5153 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5160 Perl_sv_newref(pTHX_ SV *sv)
5162 PERL_UNUSED_CONTEXT;
5171 Decrement an SV's reference count, and if it drops to zero, call
5172 C<sv_clear> to invoke destructors and free up any memory used by
5173 the body; finally, deallocate the SV's head itself.
5174 Normally called via a wrapper macro C<SvREFCNT_dec>.
5180 Perl_sv_free(pTHX_ SV *sv)
5185 if (SvREFCNT(sv) == 0) {
5186 if (SvFLAGS(sv) & SVf_BREAK)
5187 /* this SV's refcnt has been artificially decremented to
5188 * trigger cleanup */
5190 if (PL_in_clean_all) /* All is fair */
5192 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5193 /* make sure SvREFCNT(sv)==0 happens very seldom */
5194 SvREFCNT(sv) = (~(U32)0)/2;
5197 if (ckWARN_d(WARN_INTERNAL)) {
5198 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5199 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5200 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5201 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5202 Perl_dump_sv_child(aTHX_ sv);
5207 if (--(SvREFCNT(sv)) > 0)
5209 Perl_sv_free2(aTHX_ sv);
5213 Perl_sv_free2(pTHX_ SV *sv)
5218 if (ckWARN_d(WARN_DEBUGGING))
5219 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5220 "Attempt to free temp prematurely: SV 0x%"UVxf
5221 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5225 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5226 /* make sure SvREFCNT(sv)==0 happens very seldom */
5227 SvREFCNT(sv) = (~(U32)0)/2;
5238 Returns the length of the string in the SV. Handles magic and type
5239 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5245 Perl_sv_len(pTHX_ register SV *sv)
5253 len = mg_length(sv);
5255 (void)SvPV_const(sv, len);
5260 =for apidoc sv_len_utf8
5262 Returns the number of characters in the string in an SV, counting wide
5263 UTF-8 bytes as a single character. Handles magic and type coercion.
5269 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5270 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5271 * (Note that the mg_len is not the length of the mg_ptr field.)
5276 Perl_sv_len_utf8(pTHX_ register SV *sv)
5282 return mg_length(sv);
5286 const U8 *s = (U8*)SvPV_const(sv, len);
5287 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5289 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5291 #ifdef PERL_UTF8_CACHE_ASSERT
5292 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5296 ulen = Perl_utf8_length(aTHX_ s, s + len);
5297 if (!mg && !SvREADONLY(sv)) {
5298 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5299 mg = mg_find(sv, PERL_MAGIC_utf8);
5309 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5310 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5311 * between UTF-8 and byte offsets. There are two (substr offset and substr
5312 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5313 * and byte offset) cache positions.
5315 * The mg_len field is used by sv_len_utf8(), see its comments.
5316 * Note that the mg_len is not the length of the mg_ptr field.
5320 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5321 I32 offsetp, const U8 *s, const U8 *start)
5325 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5327 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5331 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5333 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5334 (*mgp)->mg_ptr = (char *) *cachep;
5338 (*cachep)[i] = offsetp;
5339 (*cachep)[i+1] = s - start;
5347 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5348 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5349 * between UTF-8 and byte offsets. See also the comments of
5350 * S_utf8_mg_pos_init().
5354 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)
5358 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5360 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5361 if (*mgp && (*mgp)->mg_ptr) {
5362 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5363 ASSERT_UTF8_CACHE(*cachep);
5364 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5366 else { /* We will skip to the right spot. */
5371 /* The assumption is that going backward is half
5372 * the speed of going forward (that's where the
5373 * 2 * backw in the below comes from). (The real
5374 * figure of course depends on the UTF-8 data.) */
5376 if ((*cachep)[i] > (STRLEN)uoff) {
5378 backw = (*cachep)[i] - (STRLEN)uoff;
5380 if (forw < 2 * backw)
5383 p = start + (*cachep)[i+1];
5385 /* Try this only for the substr offset (i == 0),
5386 * not for the substr length (i == 2). */
5387 else if (i == 0) { /* (*cachep)[i] < uoff */
5388 const STRLEN ulen = sv_len_utf8(sv);
5390 if ((STRLEN)uoff < ulen) {
5391 forw = (STRLEN)uoff - (*cachep)[i];
5392 backw = ulen - (STRLEN)uoff;
5394 if (forw < 2 * backw)
5395 p = start + (*cachep)[i+1];
5400 /* If the string is not long enough for uoff,
5401 * we could extend it, but not at this low a level. */
5405 if (forw < 2 * backw) {
5412 while (UTF8_IS_CONTINUATION(*p))
5417 /* Update the cache. */
5418 (*cachep)[i] = (STRLEN)uoff;
5419 (*cachep)[i+1] = p - start;
5421 /* Drop the stale "length" cache */
5430 if (found) { /* Setup the return values. */
5431 *offsetp = (*cachep)[i+1];
5432 *sp = start + *offsetp;
5435 *offsetp = send - start;
5437 else if (*sp < start) {
5443 #ifdef PERL_UTF8_CACHE_ASSERT
5448 while (n-- && s < send)
5452 assert(*offsetp == s - start);
5453 assert((*cachep)[0] == (STRLEN)uoff);
5454 assert((*cachep)[1] == *offsetp);
5456 ASSERT_UTF8_CACHE(*cachep);
5465 =for apidoc sv_pos_u2b
5467 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5468 the start of the string, to a count of the equivalent number of bytes; if
5469 lenp is non-zero, it does the same to lenp, but this time starting from
5470 the offset, rather than from the start of the string. Handles magic and
5477 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5478 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5479 * byte offsets. See also the comments of S_utf8_mg_pos().
5484 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5492 start = (U8*)SvPV_const(sv, len);
5495 STRLEN *cache = NULL;
5496 const U8 *s = start;
5497 I32 uoffset = *offsetp;
5498 const U8 * const send = s + len;
5500 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5502 if (!found && uoffset > 0) {
5503 while (s < send && uoffset--)
5507 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5509 *offsetp = s - start;
5514 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5518 if (!found && *lenp > 0) {
5521 while (s < send && ulen--)
5525 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5529 ASSERT_UTF8_CACHE(cache);
5541 =for apidoc sv_pos_b2u
5543 Converts the value pointed to by offsetp from a count of bytes from the
5544 start of the string, to a count of the equivalent number of UTF-8 chars.
5545 Handles magic and type coercion.
5551 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5552 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5553 * byte offsets. See also the comments of S_utf8_mg_pos().
5558 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5566 s = (const U8*)SvPV_const(sv, len);
5567 if ((I32)len < *offsetp)
5568 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5570 const U8* send = s + *offsetp;
5572 STRLEN *cache = NULL;
5576 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5577 mg = mg_find(sv, PERL_MAGIC_utf8);
5578 if (mg && mg->mg_ptr) {
5579 cache = (STRLEN *) mg->mg_ptr;
5580 if (cache[1] == (STRLEN)*offsetp) {
5581 /* An exact match. */
5582 *offsetp = cache[0];
5586 else if (cache[1] < (STRLEN)*offsetp) {
5587 /* We already know part of the way. */
5590 /* Let the below loop do the rest. */
5592 else { /* cache[1] > *offsetp */
5593 /* We already know all of the way, now we may
5594 * be able to walk back. The same assumption
5595 * is made as in S_utf8_mg_pos(), namely that
5596 * walking backward is twice slower than
5597 * walking forward. */
5598 const STRLEN forw = *offsetp;
5599 STRLEN backw = cache[1] - *offsetp;
5601 if (!(forw < 2 * backw)) {
5602 const U8 *p = s + cache[1];
5609 while (UTF8_IS_CONTINUATION(*p)) {
5617 *offsetp = cache[0];
5619 /* Drop the stale "length" cache */
5627 ASSERT_UTF8_CACHE(cache);
5633 /* Call utf8n_to_uvchr() to validate the sequence
5634 * (unless a simple non-UTF character) */
5635 if (!UTF8_IS_INVARIANT(*s))
5636 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5645 if (!SvREADONLY(sv)) {
5647 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5648 mg = mg_find(sv, PERL_MAGIC_utf8);
5653 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5654 mg->mg_ptr = (char *) cache;
5659 cache[1] = *offsetp;
5660 /* Drop the stale "length" cache */
5673 Returns a boolean indicating whether the strings in the two SVs are
5674 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5675 coerce its args to strings if necessary.
5681 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5690 SV* svrecode = NULL;
5697 pv1 = SvPV_const(sv1, cur1);
5704 pv2 = SvPV_const(sv2, cur2);
5706 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5707 /* Differing utf8ness.
5708 * Do not UTF8size the comparands as a side-effect. */
5711 svrecode = newSVpvn(pv2, cur2);
5712 sv_recode_to_utf8(svrecode, PL_encoding);
5713 pv2 = SvPV_const(svrecode, cur2);
5716 svrecode = newSVpvn(pv1, cur1);
5717 sv_recode_to_utf8(svrecode, PL_encoding);
5718 pv1 = SvPV_const(svrecode, cur1);
5720 /* Now both are in UTF-8. */
5722 SvREFCNT_dec(svrecode);
5727 bool is_utf8 = TRUE;
5730 /* sv1 is the UTF-8 one,
5731 * if is equal it must be downgrade-able */
5732 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5738 /* sv2 is the UTF-8 one,
5739 * if is equal it must be downgrade-able */
5740 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5746 /* Downgrade not possible - cannot be eq */
5754 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5756 SvREFCNT_dec(svrecode);
5766 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5767 string in C<sv1> is less than, equal to, or greater than the string in
5768 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5769 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5775 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5779 const char *pv1, *pv2;
5782 SV *svrecode = NULL;
5789 pv1 = SvPV_const(sv1, cur1);
5796 pv2 = SvPV_const(sv2, cur2);
5798 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5799 /* Differing utf8ness.
5800 * Do not UTF8size the comparands as a side-effect. */
5803 svrecode = newSVpvn(pv2, cur2);
5804 sv_recode_to_utf8(svrecode, PL_encoding);
5805 pv2 = SvPV_const(svrecode, cur2);
5808 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5813 svrecode = newSVpvn(pv1, cur1);
5814 sv_recode_to_utf8(svrecode, PL_encoding);
5815 pv1 = SvPV_const(svrecode, cur1);
5818 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5824 cmp = cur2 ? -1 : 0;
5828 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5831 cmp = retval < 0 ? -1 : 1;
5832 } else if (cur1 == cur2) {
5835 cmp = cur1 < cur2 ? -1 : 1;
5839 SvREFCNT_dec(svrecode);
5847 =for apidoc sv_cmp_locale
5849 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5850 'use bytes' aware, handles get magic, and will coerce its args to strings
5851 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5857 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5860 #ifdef USE_LOCALE_COLLATE
5866 if (PL_collation_standard)
5870 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5872 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5874 if (!pv1 || !len1) {
5885 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5888 return retval < 0 ? -1 : 1;
5891 * When the result of collation is equality, that doesn't mean
5892 * that there are no differences -- some locales exclude some
5893 * characters from consideration. So to avoid false equalities,
5894 * we use the raw string as a tiebreaker.
5900 #endif /* USE_LOCALE_COLLATE */
5902 return sv_cmp(sv1, sv2);
5906 #ifdef USE_LOCALE_COLLATE
5909 =for apidoc sv_collxfrm
5911 Add Collate Transform magic to an SV if it doesn't already have it.
5913 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5914 scalar data of the variable, but transformed to such a format that a normal
5915 memory comparison can be used to compare the data according to the locale
5922 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5927 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5928 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5934 Safefree(mg->mg_ptr);
5935 s = SvPV_const(sv, len);
5936 if ((xf = mem_collxfrm(s, len, &xlen))) {
5937 if (SvREADONLY(sv)) {
5940 return xf + sizeof(PL_collation_ix);
5943 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5944 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5957 if (mg && mg->mg_ptr) {
5959 return mg->mg_ptr + sizeof(PL_collation_ix);
5967 #endif /* USE_LOCALE_COLLATE */
5972 Get a line from the filehandle and store it into the SV, optionally
5973 appending to the currently-stored string.
5979 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5984 register STDCHAR rslast;
5985 register STDCHAR *bp;
5991 if (SvTHINKFIRST(sv))
5992 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5993 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5995 However, perlbench says it's slower, because the existing swipe code
5996 is faster than copy on write.
5997 Swings and roundabouts. */
5998 SvUPGRADE(sv, SVt_PV);
6003 if (PerlIO_isutf8(fp)) {
6005 sv_utf8_upgrade_nomg(sv);
6006 sv_pos_u2b(sv,&append,0);
6008 } else if (SvUTF8(sv)) {
6009 SV * const tsv = newSV(0);
6010 sv_gets(tsv, fp, 0);
6011 sv_utf8_upgrade_nomg(tsv);
6012 SvCUR_set(sv,append);
6015 goto return_string_or_null;
6020 if (PerlIO_isutf8(fp))
6023 if (IN_PERL_COMPILETIME) {
6024 /* we always read code in line mode */
6028 else if (RsSNARF(PL_rs)) {
6029 /* If it is a regular disk file use size from stat() as estimate
6030 of amount we are going to read - may result in malloc-ing
6031 more memory than we realy need if layers bellow reduce
6032 size we read (e.g. CRLF or a gzip layer)
6035 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6036 const Off_t offset = PerlIO_tell(fp);
6037 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6038 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6044 else if (RsRECORD(PL_rs)) {
6048 /* Grab the size of the record we're getting */
6049 recsize = SvIV(SvRV(PL_rs));
6050 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6053 /* VMS wants read instead of fread, because fread doesn't respect */
6054 /* RMS record boundaries. This is not necessarily a good thing to be */
6055 /* doing, but we've got no other real choice - except avoid stdio
6056 as implementation - perhaps write a :vms layer ?
6058 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6060 bytesread = PerlIO_read(fp, buffer, recsize);
6064 SvCUR_set(sv, bytesread += append);
6065 buffer[bytesread] = '\0';
6066 goto return_string_or_null;
6068 else if (RsPARA(PL_rs)) {
6074 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6075 if (PerlIO_isutf8(fp)) {
6076 rsptr = SvPVutf8(PL_rs, rslen);
6079 if (SvUTF8(PL_rs)) {
6080 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6081 Perl_croak(aTHX_ "Wide character in $/");
6084 rsptr = SvPV_const(PL_rs, rslen);
6088 rslast = rslen ? rsptr[rslen - 1] : '\0';
6090 if (rspara) { /* have to do this both before and after */
6091 do { /* to make sure file boundaries work right */
6094 i = PerlIO_getc(fp);
6098 PerlIO_ungetc(fp,i);
6104 /* See if we know enough about I/O mechanism to cheat it ! */
6106 /* This used to be #ifdef test - it is made run-time test for ease
6107 of abstracting out stdio interface. One call should be cheap
6108 enough here - and may even be a macro allowing compile
6112 if (PerlIO_fast_gets(fp)) {
6115 * We're going to steal some values from the stdio struct
6116 * and put EVERYTHING in the innermost loop into registers.
6118 register STDCHAR *ptr;
6122 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6123 /* An ungetc()d char is handled separately from the regular
6124 * buffer, so we getc() it back out and stuff it in the buffer.
6126 i = PerlIO_getc(fp);
6127 if (i == EOF) return 0;
6128 *(--((*fp)->_ptr)) = (unsigned char) i;
6132 /* Here is some breathtakingly efficient cheating */
6134 cnt = PerlIO_get_cnt(fp); /* get count into register */
6135 /* make sure we have the room */
6136 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6137 /* Not room for all of it
6138 if we are looking for a separator and room for some
6140 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6141 /* just process what we have room for */
6142 shortbuffered = cnt - SvLEN(sv) + append + 1;
6143 cnt -= shortbuffered;
6147 /* remember that cnt can be negative */
6148 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6153 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6154 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6155 DEBUG_P(PerlIO_printf(Perl_debug_log,
6156 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6157 DEBUG_P(PerlIO_printf(Perl_debug_log,
6158 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6159 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6160 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6165 while (cnt > 0) { /* this | eat */
6167 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6168 goto thats_all_folks; /* screams | sed :-) */
6172 Copy(ptr, bp, cnt, char); /* this | eat */
6173 bp += cnt; /* screams | dust */
6174 ptr += cnt; /* louder | sed :-) */
6179 if (shortbuffered) { /* oh well, must extend */
6180 cnt = shortbuffered;
6182 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6184 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6185 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6189 DEBUG_P(PerlIO_printf(Perl_debug_log,
6190 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6191 PTR2UV(ptr),(long)cnt));
6192 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6194 DEBUG_P(PerlIO_printf(Perl_debug_log,
6195 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6196 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6197 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6199 /* This used to call 'filbuf' in stdio form, but as that behaves like
6200 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6201 another abstraction. */
6202 i = PerlIO_getc(fp); /* get more characters */
6204 DEBUG_P(PerlIO_printf(Perl_debug_log,
6205 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6206 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6207 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6209 cnt = PerlIO_get_cnt(fp);
6210 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6211 DEBUG_P(PerlIO_printf(Perl_debug_log,
6212 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6214 if (i == EOF) /* all done for ever? */
6215 goto thats_really_all_folks;
6217 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6219 SvGROW(sv, bpx + cnt + 2);
6220 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6222 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6224 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6225 goto thats_all_folks;
6229 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6230 memNE((char*)bp - rslen, rsptr, rslen))
6231 goto screamer; /* go back to the fray */
6232 thats_really_all_folks:
6234 cnt += shortbuffered;
6235 DEBUG_P(PerlIO_printf(Perl_debug_log,
6236 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6237 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6238 DEBUG_P(PerlIO_printf(Perl_debug_log,
6239 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6240 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6241 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6243 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6244 DEBUG_P(PerlIO_printf(Perl_debug_log,
6245 "Screamer: done, len=%ld, string=|%.*s|\n",
6246 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6250 /*The big, slow, and stupid way. */
6251 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6252 STDCHAR *buf = NULL;
6253 Newx(buf, 8192, STDCHAR);
6261 register const STDCHAR * const bpe = buf + sizeof(buf);
6263 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6264 ; /* keep reading */
6268 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6269 /* Accomodate broken VAXC compiler, which applies U8 cast to
6270 * both args of ?: operator, causing EOF to change into 255
6273 i = (U8)buf[cnt - 1];
6279 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6281 sv_catpvn(sv, (char *) buf, cnt);
6283 sv_setpvn(sv, (char *) buf, cnt);
6285 if (i != EOF && /* joy */
6287 SvCUR(sv) < rslen ||
6288 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6292 * If we're reading from a TTY and we get a short read,
6293 * indicating that the user hit his EOF character, we need
6294 * to notice it now, because if we try to read from the TTY
6295 * again, the EOF condition will disappear.
6297 * The comparison of cnt to sizeof(buf) is an optimization
6298 * that prevents unnecessary calls to feof().
6302 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6306 #ifdef USE_HEAP_INSTEAD_OF_STACK
6311 if (rspara) { /* have to do this both before and after */
6312 while (i != EOF) { /* to make sure file boundaries work right */
6313 i = PerlIO_getc(fp);
6315 PerlIO_ungetc(fp,i);
6321 return_string_or_null:
6322 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6328 Auto-increment of the value in the SV, doing string to numeric conversion
6329 if necessary. Handles 'get' magic.
6335 Perl_sv_inc(pTHX_ register SV *sv)
6344 if (SvTHINKFIRST(sv)) {
6346 sv_force_normal_flags(sv, 0);
6347 if (SvREADONLY(sv)) {
6348 if (IN_PERL_RUNTIME)
6349 Perl_croak(aTHX_ PL_no_modify);
6353 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6355 i = PTR2IV(SvRV(sv));
6360 flags = SvFLAGS(sv);
6361 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6362 /* It's (privately or publicly) a float, but not tested as an
6363 integer, so test it to see. */
6365 flags = SvFLAGS(sv);
6367 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6368 /* It's publicly an integer, or privately an integer-not-float */
6369 #ifdef PERL_PRESERVE_IVUV
6373 if (SvUVX(sv) == UV_MAX)
6374 sv_setnv(sv, UV_MAX_P1);
6376 (void)SvIOK_only_UV(sv);
6377 SvUV_set(sv, SvUVX(sv) + 1);
6379 if (SvIVX(sv) == IV_MAX)
6380 sv_setuv(sv, (UV)IV_MAX + 1);
6382 (void)SvIOK_only(sv);
6383 SvIV_set(sv, SvIVX(sv) + 1);
6388 if (flags & SVp_NOK) {
6389 (void)SvNOK_only(sv);
6390 SvNV_set(sv, SvNVX(sv) + 1.0);
6394 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6395 if ((flags & SVTYPEMASK) < SVt_PVIV)
6396 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6397 (void)SvIOK_only(sv);
6402 while (isALPHA(*d)) d++;
6403 while (isDIGIT(*d)) d++;
6405 #ifdef PERL_PRESERVE_IVUV
6406 /* Got to punt this as an integer if needs be, but we don't issue
6407 warnings. Probably ought to make the sv_iv_please() that does
6408 the conversion if possible, and silently. */
6409 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6410 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6411 /* Need to try really hard to see if it's an integer.
6412 9.22337203685478e+18 is an integer.
6413 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6414 so $a="9.22337203685478e+18"; $a+0; $a++
6415 needs to be the same as $a="9.22337203685478e+18"; $a++
6422 /* sv_2iv *should* have made this an NV */
6423 if (flags & SVp_NOK) {
6424 (void)SvNOK_only(sv);
6425 SvNV_set(sv, SvNVX(sv) + 1.0);
6428 /* I don't think we can get here. Maybe I should assert this
6429 And if we do get here I suspect that sv_setnv will croak. NWC
6431 #if defined(USE_LONG_DOUBLE)
6432 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",
6433 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6435 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6436 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6439 #endif /* PERL_PRESERVE_IVUV */
6440 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6444 while (d >= SvPVX_const(sv)) {
6452 /* MKS: The original code here died if letters weren't consecutive.
6453 * at least it didn't have to worry about non-C locales. The
6454 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6455 * arranged in order (although not consecutively) and that only
6456 * [A-Za-z] are accepted by isALPHA in the C locale.
6458 if (*d != 'z' && *d != 'Z') {
6459 do { ++*d; } while (!isALPHA(*d));
6462 *(d--) -= 'z' - 'a';
6467 *(d--) -= 'z' - 'a' + 1;
6471 /* oh,oh, the number grew */
6472 SvGROW(sv, SvCUR(sv) + 2);
6473 SvCUR_set(sv, SvCUR(sv) + 1);
6474 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6485 Auto-decrement of the value in the SV, doing string to numeric conversion
6486 if necessary. Handles 'get' magic.
6492 Perl_sv_dec(pTHX_ register SV *sv)
6500 if (SvTHINKFIRST(sv)) {
6502 sv_force_normal_flags(sv, 0);
6503 if (SvREADONLY(sv)) {
6504 if (IN_PERL_RUNTIME)
6505 Perl_croak(aTHX_ PL_no_modify);
6509 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6511 i = PTR2IV(SvRV(sv));
6516 /* Unlike sv_inc we don't have to worry about string-never-numbers
6517 and keeping them magic. But we mustn't warn on punting */
6518 flags = SvFLAGS(sv);
6519 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6520 /* It's publicly an integer, or privately an integer-not-float */
6521 #ifdef PERL_PRESERVE_IVUV
6525 if (SvUVX(sv) == 0) {
6526 (void)SvIOK_only(sv);
6530 (void)SvIOK_only_UV(sv);
6531 SvUV_set(sv, SvUVX(sv) - 1);
6534 if (SvIVX(sv) == IV_MIN)
6535 sv_setnv(sv, (NV)IV_MIN - 1.0);
6537 (void)SvIOK_only(sv);
6538 SvIV_set(sv, SvIVX(sv) - 1);
6543 if (flags & SVp_NOK) {
6544 SvNV_set(sv, SvNVX(sv) - 1.0);
6545 (void)SvNOK_only(sv);
6548 if (!(flags & SVp_POK)) {
6549 if ((flags & SVTYPEMASK) < SVt_PVIV)
6550 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6552 (void)SvIOK_only(sv);
6555 #ifdef PERL_PRESERVE_IVUV
6557 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6558 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6559 /* Need to try really hard to see if it's an integer.
6560 9.22337203685478e+18 is an integer.
6561 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6562 so $a="9.22337203685478e+18"; $a+0; $a--
6563 needs to be the same as $a="9.22337203685478e+18"; $a--
6570 /* sv_2iv *should* have made this an NV */
6571 if (flags & SVp_NOK) {
6572 (void)SvNOK_only(sv);
6573 SvNV_set(sv, SvNVX(sv) - 1.0);
6576 /* I don't think we can get here. Maybe I should assert this
6577 And if we do get here I suspect that sv_setnv will croak. NWC
6579 #if defined(USE_LONG_DOUBLE)
6580 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",
6581 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6583 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6584 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6588 #endif /* PERL_PRESERVE_IVUV */
6589 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6593 =for apidoc sv_mortalcopy
6595 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6596 The new SV is marked as mortal. It will be destroyed "soon", either by an
6597 explicit call to FREETMPS, or by an implicit call at places such as
6598 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6603 /* Make a string that will exist for the duration of the expression
6604 * evaluation. Actually, it may have to last longer than that, but
6605 * hopefully we won't free it until it has been assigned to a
6606 * permanent location. */
6609 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6615 sv_setsv(sv,oldstr);
6617 PL_tmps_stack[++PL_tmps_ix] = sv;
6623 =for apidoc sv_newmortal
6625 Creates a new null SV which is mortal. The reference count of the SV is
6626 set to 1. It will be destroyed "soon", either by an explicit call to
6627 FREETMPS, or by an implicit call at places such as statement boundaries.
6628 See also C<sv_mortalcopy> and C<sv_2mortal>.
6634 Perl_sv_newmortal(pTHX)
6640 SvFLAGS(sv) = SVs_TEMP;
6642 PL_tmps_stack[++PL_tmps_ix] = sv;
6647 =for apidoc sv_2mortal
6649 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6650 by an explicit call to FREETMPS, or by an implicit call at places such as
6651 statement boundaries. SvTEMP() is turned on which means that the SV's
6652 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6653 and C<sv_mortalcopy>.
6659 Perl_sv_2mortal(pTHX_ register SV *sv)
6664 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6667 PL_tmps_stack[++PL_tmps_ix] = sv;
6675 Creates a new SV and copies a string into it. The reference count for the
6676 SV is set to 1. If C<len> is zero, Perl will compute the length using
6677 strlen(). For efficiency, consider using C<newSVpvn> instead.
6683 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6689 sv_setpvn(sv,s,len ? len : strlen(s));
6694 =for apidoc newSVpvn
6696 Creates a new SV and copies a string into it. The reference count for the
6697 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6698 string. You are responsible for ensuring that the source string is at least
6699 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6705 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6711 sv_setpvn(sv,s,len);
6717 =for apidoc newSVhek
6719 Creates a new SV from the hash key structure. It will generate scalars that
6720 point to the shared string table where possible. Returns a new (undefined)
6721 SV if the hek is NULL.
6727 Perl_newSVhek(pTHX_ const HEK *hek)
6737 if (HEK_LEN(hek) == HEf_SVKEY) {
6738 return newSVsv(*(SV**)HEK_KEY(hek));
6740 const int flags = HEK_FLAGS(hek);
6741 if (flags & HVhek_WASUTF8) {
6743 Andreas would like keys he put in as utf8 to come back as utf8
6745 STRLEN utf8_len = HEK_LEN(hek);
6746 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6747 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6750 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6752 } else if (flags & HVhek_REHASH) {
6753 /* We don't have a pointer to the hv, so we have to replicate the
6754 flag into every HEK. This hv is using custom a hasing
6755 algorithm. Hence we can't return a shared string scalar, as
6756 that would contain the (wrong) hash value, and might get passed
6757 into an hv routine with a regular hash */
6759 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6764 /* This will be overwhelminly the most common case. */
6765 return newSVpvn_share(HEK_KEY(hek),
6766 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6772 =for apidoc newSVpvn_share
6774 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6775 table. If the string does not already exist in the table, it is created
6776 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6777 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6778 otherwise the hash is computed. The idea here is that as the string table
6779 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6780 hash lookup will avoid string compare.
6786 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6790 bool is_utf8 = FALSE;
6792 STRLEN tmplen = -len;
6794 /* See the note in hv.c:hv_fetch() --jhi */
6795 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6799 PERL_HASH(hash, src, len);
6801 sv_upgrade(sv, SVt_PV);
6802 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6814 #if defined(PERL_IMPLICIT_CONTEXT)
6816 /* pTHX_ magic can't cope with varargs, so this is a no-context
6817 * version of the main function, (which may itself be aliased to us).
6818 * Don't access this version directly.
6822 Perl_newSVpvf_nocontext(const char* pat, ...)
6827 va_start(args, pat);
6828 sv = vnewSVpvf(pat, &args);
6835 =for apidoc newSVpvf
6837 Creates a new SV and initializes it with the string formatted like
6844 Perl_newSVpvf(pTHX_ const char* pat, ...)
6848 va_start(args, pat);
6849 sv = vnewSVpvf(pat, &args);
6854 /* backend for newSVpvf() and newSVpvf_nocontext() */
6857 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6862 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
6869 Creates a new SV and copies a floating point value into it.
6870 The reference count for the SV is set to 1.
6876 Perl_newSVnv(pTHX_ NV n)
6889 Creates a new SV and copies an integer into it. The reference count for the
6896 Perl_newSViv(pTHX_ IV i)
6909 Creates a new SV and copies an unsigned integer into it.
6910 The reference count for the SV is set to 1.
6916 Perl_newSVuv(pTHX_ UV u)
6927 =for apidoc newRV_noinc
6929 Creates an RV wrapper for an SV. The reference count for the original
6930 SV is B<not> incremented.
6936 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6942 sv_upgrade(sv, SVt_RV);
6944 SvRV_set(sv, tmpRef);
6949 /* newRV_inc is the official function name to use now.
6950 * newRV_inc is in fact #defined to newRV in sv.h
6954 Perl_newRV(pTHX_ SV *sv)
6957 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
6963 Creates a new SV which is an exact duplicate of the original SV.
6970 Perl_newSVsv(pTHX_ register SV *old)
6977 if (SvTYPE(old) == SVTYPEMASK) {
6978 if (ckWARN_d(WARN_INTERNAL))
6979 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6983 /* SV_GMAGIC is the default for sv_setv()
6984 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6985 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6986 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6991 =for apidoc sv_reset
6993 Underlying implementation for the C<reset> Perl function.
6994 Note that the perl-level function is vaguely deprecated.
7000 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7003 char todo[PERL_UCHAR_MAX+1];
7008 if (!*s) { /* reset ?? searches */
7009 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7011 PMOP *pm = (PMOP *) mg->mg_obj;
7013 pm->op_pmdynflags &= ~PMdf_USED;
7020 /* reset variables */
7022 if (!HvARRAY(stash))
7025 Zero(todo, 256, char);
7028 I32 i = (unsigned char)*s;
7032 max = (unsigned char)*s++;
7033 for ( ; i <= max; i++) {
7036 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7038 for (entry = HvARRAY(stash)[i];
7040 entry = HeNEXT(entry))
7045 if (!todo[(U8)*HeKEY(entry)])
7047 gv = (GV*)HeVAL(entry);
7050 if (SvTHINKFIRST(sv)) {
7051 if (!SvREADONLY(sv) && SvROK(sv))
7053 /* XXX Is this continue a bug? Why should THINKFIRST
7054 exempt us from resetting arrays and hashes? */
7058 if (SvTYPE(sv) >= SVt_PV) {
7060 if (SvPVX_const(sv) != NULL)
7068 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7070 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7073 # if defined(USE_ENVIRON_ARRAY)
7076 # endif /* USE_ENVIRON_ARRAY */
7087 Using various gambits, try to get an IO from an SV: the IO slot if its a
7088 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7089 named after the PV if we're a string.
7095 Perl_sv_2io(pTHX_ SV *sv)
7100 switch (SvTYPE(sv)) {
7108 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7112 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7114 return sv_2io(SvRV(sv));
7115 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7121 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7130 Using various gambits, try to get a CV from an SV; in addition, try if
7131 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7132 The flags in C<lref> are passed to sv_fetchsv.
7138 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7149 switch (SvTYPE(sv)) {
7168 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7169 tryAMAGICunDEREF(to_cv);
7172 if (SvTYPE(sv) == SVt_PVCV) {
7181 Perl_croak(aTHX_ "Not a subroutine reference");
7186 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7192 /* Some flags to gv_fetchsv mean don't really create the GV */
7193 if (SvTYPE(gv) != SVt_PVGV) {
7199 if (lref && !GvCVu(gv)) {
7203 gv_efullname3(tmpsv, gv, NULL);
7204 /* XXX this is probably not what they think they're getting.
7205 * It has the same effect as "sub name;", i.e. just a forward
7207 newSUB(start_subparse(FALSE, 0),
7208 newSVOP(OP_CONST, 0, tmpsv),
7212 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7222 Returns true if the SV has a true value by Perl's rules.
7223 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7224 instead use an in-line version.
7230 Perl_sv_true(pTHX_ register SV *sv)
7235 register const XPV* const tXpv = (XPV*)SvANY(sv);
7237 (tXpv->xpv_cur > 1 ||
7238 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7245 return SvIVX(sv) != 0;
7248 return SvNVX(sv) != 0.0;
7250 return sv_2bool(sv);
7256 =for apidoc sv_pvn_force
7258 Get a sensible string out of the SV somehow.
7259 A private implementation of the C<SvPV_force> macro for compilers which
7260 can't cope with complex macro expressions. Always use the macro instead.
7262 =for apidoc sv_pvn_force_flags
7264 Get a sensible string out of the SV somehow.
7265 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7266 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7267 implemented in terms of this function.
7268 You normally want to use the various wrapper macros instead: see
7269 C<SvPV_force> and C<SvPV_force_nomg>
7275 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7278 if (SvTHINKFIRST(sv) && !SvROK(sv))
7279 sv_force_normal_flags(sv, 0);
7289 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7290 const char * const ref = sv_reftype(sv,0);
7292 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7293 ref, OP_NAME(PL_op));
7295 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7297 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7298 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7300 s = sv_2pv_flags(sv, &len, flags);
7304 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7307 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7308 SvGROW(sv, len + 1);
7309 Move(s,SvPVX(sv),len,char);
7314 SvPOK_on(sv); /* validate pointer */
7316 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7317 PTR2UV(sv),SvPVX_const(sv)));
7320 return SvPVX_mutable(sv);
7324 =for apidoc sv_pvbyten_force
7326 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7332 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7334 sv_pvn_force(sv,lp);
7335 sv_utf8_downgrade(sv,0);
7341 =for apidoc sv_pvutf8n_force
7343 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7349 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7351 sv_pvn_force(sv,lp);
7352 sv_utf8_upgrade(sv);
7358 =for apidoc sv_reftype
7360 Returns a string describing what the SV is a reference to.
7366 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7368 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7369 inside return suggests a const propagation bug in g++. */
7370 if (ob && SvOBJECT(sv)) {
7371 char * const name = HvNAME_get(SvSTASH(sv));
7372 return name ? name : (char *) "__ANON__";
7375 switch (SvTYPE(sv)) {
7392 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7393 /* tied lvalues should appear to be
7394 * scalars for backwards compatitbility */
7395 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7396 ? "SCALAR" : "LVALUE");
7397 case SVt_PVAV: return "ARRAY";
7398 case SVt_PVHV: return "HASH";
7399 case SVt_PVCV: return "CODE";
7400 case SVt_PVGV: return "GLOB";
7401 case SVt_PVFM: return "FORMAT";
7402 case SVt_PVIO: return "IO";
7403 default: return "UNKNOWN";
7409 =for apidoc sv_isobject
7411 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7412 object. If the SV is not an RV, or if the object is not blessed, then this
7419 Perl_sv_isobject(pTHX_ SV *sv)
7435 Returns a boolean indicating whether the SV is blessed into the specified
7436 class. This does not check for subtypes; use C<sv_derived_from> to verify
7437 an inheritance relationship.
7443 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7454 hvname = HvNAME_get(SvSTASH(sv));
7458 return strEQ(hvname, name);
7464 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7465 it will be upgraded to one. If C<classname> is non-null then the new SV will
7466 be blessed in the specified package. The new SV is returned and its
7467 reference count is 1.
7473 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7480 SV_CHECK_THINKFIRST_COW_DROP(rv);
7483 if (SvTYPE(rv) >= SVt_PVMG) {
7484 const U32 refcnt = SvREFCNT(rv);
7488 SvREFCNT(rv) = refcnt;
7491 if (SvTYPE(rv) < SVt_RV)
7492 sv_upgrade(rv, SVt_RV);
7493 else if (SvTYPE(rv) > SVt_RV) {
7504 HV* const stash = gv_stashpv(classname, TRUE);
7505 (void)sv_bless(rv, stash);
7511 =for apidoc sv_setref_pv
7513 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7514 argument will be upgraded to an RV. That RV will be modified to point to
7515 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7516 into the SV. The C<classname> argument indicates the package for the
7517 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7518 will have a reference count of 1, and the RV will be returned.
7520 Do not use with other Perl types such as HV, AV, SV, CV, because those
7521 objects will become corrupted by the pointer copy process.
7523 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7529 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7533 sv_setsv(rv, &PL_sv_undef);
7537 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7542 =for apidoc sv_setref_iv
7544 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7545 argument will be upgraded to an RV. That RV will be modified to point to
7546 the new SV. The C<classname> argument indicates the package for the
7547 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7548 will have a reference count of 1, and the RV will be returned.
7554 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7556 sv_setiv(newSVrv(rv,classname), iv);
7561 =for apidoc sv_setref_uv
7563 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7564 argument will be upgraded to an RV. That RV will be modified to point to
7565 the new SV. The C<classname> argument indicates the package for the
7566 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7567 will have a reference count of 1, and the RV will be returned.
7573 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7575 sv_setuv(newSVrv(rv,classname), uv);
7580 =for apidoc sv_setref_nv
7582 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7583 argument will be upgraded to an RV. That RV will be modified to point to
7584 the new SV. The C<classname> argument indicates the package for the
7585 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7586 will have a reference count of 1, and the RV will be returned.
7592 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7594 sv_setnv(newSVrv(rv,classname), nv);
7599 =for apidoc sv_setref_pvn
7601 Copies a string into a new SV, optionally blessing the SV. The length of the
7602 string must be specified with C<n>. The C<rv> argument will be upgraded to
7603 an RV. That RV will be modified to point to the new SV. The C<classname>
7604 argument indicates the package for the blessing. Set C<classname> to
7605 C<NULL> to avoid the blessing. The new SV will have a reference count
7606 of 1, and the RV will be returned.
7608 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7614 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7616 sv_setpvn(newSVrv(rv,classname), pv, n);
7621 =for apidoc sv_bless
7623 Blesses an SV into a specified package. The SV must be an RV. The package
7624 must be designated by its stash (see C<gv_stashpv()>). The reference count
7625 of the SV is unaffected.
7631 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7636 Perl_croak(aTHX_ "Can't bless non-reference value");
7638 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7639 if (SvREADONLY(tmpRef))
7640 Perl_croak(aTHX_ PL_no_modify);
7641 if (SvOBJECT(tmpRef)) {
7642 if (SvTYPE(tmpRef) != SVt_PVIO)
7644 SvREFCNT_dec(SvSTASH(tmpRef));
7647 SvOBJECT_on(tmpRef);
7648 if (SvTYPE(tmpRef) != SVt_PVIO)
7650 SvUPGRADE(tmpRef, SVt_PVMG);
7651 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7658 if(SvSMAGICAL(tmpRef))
7659 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7667 /* Downgrades a PVGV to a PVMG.
7671 S_sv_unglob(pTHX_ SV *sv)
7675 SV * const temp = sv_newmortal();
7677 assert(SvTYPE(sv) == SVt_PVGV);
7679 gv_efullname3(temp, (GV *) sv, "*");
7685 sv_del_backref((SV*)GvSTASH(sv), sv);
7689 if (GvNAME_HEK(sv)) {
7690 unshare_hek(GvNAME_HEK(sv));
7694 /* need to keep SvANY(sv) in the right arena */
7695 xpvmg = new_XPVMG();
7696 StructCopy(SvANY(sv), xpvmg, XPVMG);
7697 del_XPVGV(SvANY(sv));
7700 SvFLAGS(sv) &= ~SVTYPEMASK;
7701 SvFLAGS(sv) |= SVt_PVMG;
7703 /* Intentionally not calling any local SET magic, as this isn't so much a
7704 set operation as merely an internal storage change. */
7705 sv_setsv_flags(sv, temp, 0);
7709 =for apidoc sv_unref_flags
7711 Unsets the RV status of the SV, and decrements the reference count of
7712 whatever was being referenced by the RV. This can almost be thought of
7713 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7714 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7715 (otherwise the decrementing is conditional on the reference count being
7716 different from one or the reference being a readonly SV).
7723 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7725 SV* const target = SvRV(ref);
7727 if (SvWEAKREF(ref)) {
7728 sv_del_backref(target, ref);
7730 SvRV_set(ref, NULL);
7733 SvRV_set(ref, NULL);
7735 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7736 assigned to as BEGIN {$a = \"Foo"} will fail. */
7737 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7738 SvREFCNT_dec(target);
7739 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7740 sv_2mortal(target); /* Schedule for freeing later */
7744 =for apidoc sv_untaint
7746 Untaint an SV. Use C<SvTAINTED_off> instead.
7751 Perl_sv_untaint(pTHX_ SV *sv)
7753 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7754 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7761 =for apidoc sv_tainted
7763 Test an SV for taintedness. Use C<SvTAINTED> instead.
7768 Perl_sv_tainted(pTHX_ SV *sv)
7770 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7771 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7772 if (mg && (mg->mg_len & 1) )
7779 =for apidoc sv_setpviv
7781 Copies an integer into the given SV, also updating its string value.
7782 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7788 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7790 char buf[TYPE_CHARS(UV)];
7792 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7794 sv_setpvn(sv, ptr, ebuf - ptr);
7798 =for apidoc sv_setpviv_mg
7800 Like C<sv_setpviv>, but also handles 'set' magic.
7806 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7812 #if defined(PERL_IMPLICIT_CONTEXT)
7814 /* pTHX_ magic can't cope with varargs, so this is a no-context
7815 * version of the main function, (which may itself be aliased to us).
7816 * Don't access this version directly.
7820 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7824 va_start(args, pat);
7825 sv_vsetpvf(sv, pat, &args);
7829 /* pTHX_ magic can't cope with varargs, so this is a no-context
7830 * version of the main function, (which may itself be aliased to us).
7831 * Don't access this version directly.
7835 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7839 va_start(args, pat);
7840 sv_vsetpvf_mg(sv, pat, &args);
7846 =for apidoc sv_setpvf
7848 Works like C<sv_catpvf> but copies the text into the SV instead of
7849 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7855 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7858 va_start(args, pat);
7859 sv_vsetpvf(sv, pat, &args);
7864 =for apidoc sv_vsetpvf
7866 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7867 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7869 Usually used via its frontend C<sv_setpvf>.
7875 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7877 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7881 =for apidoc sv_setpvf_mg
7883 Like C<sv_setpvf>, but also handles 'set' magic.
7889 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7892 va_start(args, pat);
7893 sv_vsetpvf_mg(sv, pat, &args);
7898 =for apidoc sv_vsetpvf_mg
7900 Like C<sv_vsetpvf>, but also handles 'set' magic.
7902 Usually used via its frontend C<sv_setpvf_mg>.
7908 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7910 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7914 #if defined(PERL_IMPLICIT_CONTEXT)
7916 /* pTHX_ magic can't cope with varargs, so this is a no-context
7917 * version of the main function, (which may itself be aliased to us).
7918 * Don't access this version directly.
7922 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7926 va_start(args, pat);
7927 sv_vcatpvf(sv, pat, &args);
7931 /* pTHX_ magic can't cope with varargs, so this is a no-context
7932 * version of the main function, (which may itself be aliased to us).
7933 * Don't access this version directly.
7937 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7941 va_start(args, pat);
7942 sv_vcatpvf_mg(sv, pat, &args);
7948 =for apidoc sv_catpvf
7950 Processes its arguments like C<sprintf> and appends the formatted
7951 output to an SV. If the appended data contains "wide" characters
7952 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7953 and characters >255 formatted with %c), the original SV might get
7954 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7955 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7956 valid UTF-8; if the original SV was bytes, the pattern should be too.
7961 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7964 va_start(args, pat);
7965 sv_vcatpvf(sv, pat, &args);
7970 =for apidoc sv_vcatpvf
7972 Processes its arguments like C<vsprintf> and appends the formatted output
7973 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7975 Usually used via its frontend C<sv_catpvf>.
7981 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7983 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7987 =for apidoc sv_catpvf_mg
7989 Like C<sv_catpvf>, but also handles 'set' magic.
7995 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7998 va_start(args, pat);
7999 sv_vcatpvf_mg(sv, pat, &args);
8004 =for apidoc sv_vcatpvf_mg
8006 Like C<sv_vcatpvf>, but also handles 'set' magic.
8008 Usually used via its frontend C<sv_catpvf_mg>.
8014 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8016 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8021 =for apidoc sv_vsetpvfn
8023 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8026 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8032 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8034 sv_setpvn(sv, "", 0);
8035 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8039 S_expect_number(pTHX_ char** pattern)
8043 switch (**pattern) {
8044 case '1': case '2': case '3':
8045 case '4': case '5': case '6':
8046 case '7': case '8': case '9':
8047 var = *(*pattern)++ - '0';
8048 while (isDIGIT(**pattern)) {
8049 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8051 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8059 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8061 const int neg = nv < 0;
8070 if (uv & 1 && uv == nv)
8071 uv--; /* Round to even */
8073 const unsigned dig = uv % 10;
8086 =for apidoc sv_vcatpvfn
8088 Processes its arguments like C<vsprintf> and appends the formatted output
8089 to an SV. Uses an array of SVs if the C style variable argument list is
8090 missing (NULL). When running with taint checks enabled, indicates via
8091 C<maybe_tainted> if results are untrustworthy (often due to the use of
8094 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8100 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8101 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8102 vec_utf8 = DO_UTF8(vecsv);
8104 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8107 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8115 static const char nullstr[] = "(null)";
8117 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8118 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8120 /* Times 4: a decimal digit takes more than 3 binary digits.
8121 * NV_DIG: mantissa takes than many decimal digits.
8122 * Plus 32: Playing safe. */
8123 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8124 /* large enough for "%#.#f" --chip */
8125 /* what about long double NVs? --jhi */
8127 PERL_UNUSED_ARG(maybe_tainted);
8129 /* no matter what, this is a string now */
8130 (void)SvPV_force(sv, origlen);
8132 /* special-case "", "%s", and "%-p" (SVf - see below) */
8135 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8137 const char * const s = va_arg(*args, char*);
8138 sv_catpv(sv, s ? s : nullstr);
8140 else if (svix < svmax) {
8141 sv_catsv(sv, *svargs);
8145 if (args && patlen == 3 && pat[0] == '%' &&
8146 pat[1] == '-' && pat[2] == 'p') {
8147 argsv = va_arg(*args, SV*);
8148 sv_catsv(sv, argsv);
8152 #ifndef USE_LONG_DOUBLE
8153 /* special-case "%.<number>[gf]" */
8154 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8155 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8156 unsigned digits = 0;
8160 while (*pp >= '0' && *pp <= '9')
8161 digits = 10 * digits + (*pp++ - '0');
8162 if (pp - pat == (int)patlen - 1) {
8170 /* Add check for digits != 0 because it seems that some
8171 gconverts are buggy in this case, and we don't yet have
8172 a Configure test for this. */
8173 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8174 /* 0, point, slack */
8175 Gconvert(nv, (int)digits, 0, ebuf);
8177 if (*ebuf) /* May return an empty string for digits==0 */
8180 } else if (!digits) {
8183 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8184 sv_catpvn(sv, p, l);
8190 #endif /* !USE_LONG_DOUBLE */
8192 if (!args && svix < svmax && DO_UTF8(*svargs))
8195 patend = (char*)pat + patlen;
8196 for (p = (char*)pat; p < patend; p = q) {
8199 bool vectorize = FALSE;
8200 bool vectorarg = FALSE;
8201 bool vec_utf8 = FALSE;
8207 bool has_precis = FALSE;
8209 const I32 osvix = svix;
8210 bool is_utf8 = FALSE; /* is this item utf8? */
8211 #ifdef HAS_LDBL_SPRINTF_BUG
8212 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8213 with sfio - Allen <allens@cpan.org> */
8214 bool fix_ldbl_sprintf_bug = FALSE;
8218 U8 utf8buf[UTF8_MAXBYTES+1];
8219 STRLEN esignlen = 0;
8221 const char *eptr = NULL;
8224 const U8 *vecstr = NULL;
8231 /* we need a long double target in case HAS_LONG_DOUBLE but
8234 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8242 const char *dotstr = ".";
8243 STRLEN dotstrlen = 1;
8244 I32 efix = 0; /* explicit format parameter index */
8245 I32 ewix = 0; /* explicit width index */
8246 I32 epix = 0; /* explicit precision index */
8247 I32 evix = 0; /* explicit vector index */
8248 bool asterisk = FALSE;
8250 /* echo everything up to the next format specification */
8251 for (q = p; q < patend && *q != '%'; ++q) ;
8253 if (has_utf8 && !pat_utf8)
8254 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8256 sv_catpvn(sv, p, q - p);
8263 We allow format specification elements in this order:
8264 \d+\$ explicit format parameter index
8266 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8267 0 flag (as above): repeated to allow "v02"
8268 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8269 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8271 [%bcdefginopsuxDFOUX] format (mandatory)
8276 As of perl5.9.3, printf format checking is on by default.
8277 Internally, perl uses %p formats to provide an escape to
8278 some extended formatting. This block deals with those
8279 extensions: if it does not match, (char*)q is reset and
8280 the normal format processing code is used.
8282 Currently defined extensions are:
8283 %p include pointer address (standard)
8284 %-p (SVf) include an SV (previously %_)
8285 %-<num>p include an SV with precision <num>
8286 %1p (VDf) include a v-string (as %vd)
8287 %<num>p reserved for future extensions
8289 Robin Barker 2005-07-14
8296 n = expect_number(&q);
8303 argsv = va_arg(*args, SV*);
8304 eptr = SvPVx_const(argsv, elen);
8310 else if (n == vdNUMBER) { /* VDf */
8317 if (ckWARN_d(WARN_INTERNAL))
8318 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8319 "internal %%<num>p might conflict with future printf extensions");
8325 if ( (width = expect_number(&q)) ) {
8366 if ( (ewix = expect_number(&q)) )
8375 if ((vectorarg = asterisk)) {
8388 width = expect_number(&q);
8394 vecsv = va_arg(*args, SV*);
8396 vecsv = (evix > 0 && evix <= svmax)
8397 ? svargs[evix-1] : &PL_sv_undef;
8399 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8401 dotstr = SvPV_const(vecsv, dotstrlen);
8402 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8403 bad with tied or overloaded values that return UTF8. */
8406 else if (has_utf8) {
8407 vecsv = sv_mortalcopy(vecsv);
8408 sv_utf8_upgrade(vecsv);
8409 dotstr = SvPV_const(vecsv, dotstrlen);
8416 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8417 vecsv = svargs[efix ? efix-1 : svix++];
8418 vecstr = (U8*)SvPV_const(vecsv,veclen);
8419 vec_utf8 = DO_UTF8(vecsv);
8421 /* if this is a version object, we need to convert
8422 * back into v-string notation and then let the
8423 * vectorize happen normally
8425 if (sv_derived_from(vecsv, "version")) {
8426 char *version = savesvpv(vecsv);
8427 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8428 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8429 "vector argument not supported with alpha versions");
8432 vecsv = sv_newmortal();
8433 /* scan_vstring is expected to be called during
8434 * tokenization, so we need to fake up the end
8435 * of the buffer for it
8437 PL_bufend = version + veclen;
8438 scan_vstring(version, vecsv);
8439 vecstr = (U8*)SvPV_const(vecsv, veclen);
8440 vec_utf8 = DO_UTF8(vecsv);
8452 i = va_arg(*args, int);
8454 i = (ewix ? ewix <= svmax : svix < svmax) ?
8455 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8457 width = (i < 0) ? -i : i;
8467 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8469 /* XXX: todo, support specified precision parameter */
8473 i = va_arg(*args, int);
8475 i = (ewix ? ewix <= svmax : svix < svmax)
8476 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8477 precis = (i < 0) ? 0 : i;
8482 precis = precis * 10 + (*q++ - '0');
8491 case 'I': /* Ix, I32x, and I64x */
8493 if (q[1] == '6' && q[2] == '4') {
8499 if (q[1] == '3' && q[2] == '2') {
8509 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8520 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8521 if (*(q + 1) == 'l') { /* lld, llf */
8547 if (!vectorize && !args) {
8549 const I32 i = efix-1;
8550 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8552 argsv = (svix >= 0 && svix < svmax)
8553 ? svargs[svix++] : &PL_sv_undef;
8564 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8566 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8568 eptr = (char*)utf8buf;
8569 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8583 eptr = va_arg(*args, char*);
8585 #ifdef MACOS_TRADITIONAL
8586 /* On MacOS, %#s format is used for Pascal strings */
8591 elen = strlen(eptr);
8593 eptr = (char *)nullstr;
8594 elen = sizeof nullstr - 1;
8598 eptr = SvPVx_const(argsv, elen);
8599 if (DO_UTF8(argsv)) {
8600 if (has_precis && precis < elen) {
8602 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8605 if (width) { /* fudge width (can't fudge elen) */
8606 width += elen - sv_len_utf8(argsv);
8613 if (has_precis && elen > precis)
8620 if (alt || vectorize)
8622 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8643 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8652 esignbuf[esignlen++] = plus;
8656 case 'h': iv = (short)va_arg(*args, int); break;
8657 case 'l': iv = va_arg(*args, long); break;
8658 case 'V': iv = va_arg(*args, IV); break;
8659 default: iv = va_arg(*args, int); break;
8661 case 'q': iv = va_arg(*args, Quad_t); break;
8666 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8668 case 'h': iv = (short)tiv; break;
8669 case 'l': iv = (long)tiv; break;
8671 default: iv = tiv; break;
8673 case 'q': iv = (Quad_t)tiv; break;
8677 if ( !vectorize ) /* we already set uv above */
8682 esignbuf[esignlen++] = plus;
8686 esignbuf[esignlen++] = '-';
8729 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8740 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8741 case 'l': uv = va_arg(*args, unsigned long); break;
8742 case 'V': uv = va_arg(*args, UV); break;
8743 default: uv = va_arg(*args, unsigned); break;
8745 case 'q': uv = va_arg(*args, Uquad_t); break;
8750 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8752 case 'h': uv = (unsigned short)tuv; break;
8753 case 'l': uv = (unsigned long)tuv; break;
8755 default: uv = tuv; break;
8757 case 'q': uv = (Uquad_t)tuv; break;
8764 char *ptr = ebuf + sizeof ebuf;
8770 p = (char*)((c == 'X')
8771 ? "0123456789ABCDEF" : "0123456789abcdef");
8777 esignbuf[esignlen++] = '0';
8778 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8786 if (alt && *ptr != '0')
8797 esignbuf[esignlen++] = '0';
8798 esignbuf[esignlen++] = 'b';
8801 default: /* it had better be ten or less */
8805 } while (uv /= base);
8808 elen = (ebuf + sizeof ebuf) - ptr;
8812 zeros = precis - elen;
8813 else if (precis == 0 && elen == 1 && *eptr == '0')
8819 /* FLOATING POINT */
8822 c = 'f'; /* maybe %F isn't supported here */
8830 /* This is evil, but floating point is even more evil */
8832 /* for SV-style calling, we can only get NV
8833 for C-style calling, we assume %f is double;
8834 for simplicity we allow any of %Lf, %llf, %qf for long double
8838 #if defined(USE_LONG_DOUBLE)
8842 /* [perl #20339] - we should accept and ignore %lf rather than die */
8846 #if defined(USE_LONG_DOUBLE)
8847 intsize = args ? 0 : 'q';
8851 #if defined(HAS_LONG_DOUBLE)
8860 /* now we need (long double) if intsize == 'q', else (double) */
8862 #if LONG_DOUBLESIZE > DOUBLESIZE
8864 va_arg(*args, long double) :
8865 va_arg(*args, double)
8867 va_arg(*args, double)
8872 if (c != 'e' && c != 'E') {
8874 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8875 will cast our (long double) to (double) */
8876 (void)Perl_frexp(nv, &i);
8877 if (i == PERL_INT_MIN)
8878 Perl_die(aTHX_ "panic: frexp");
8880 need = BIT_DIGITS(i);
8882 need += has_precis ? precis : 6; /* known default */
8887 #ifdef HAS_LDBL_SPRINTF_BUG
8888 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8889 with sfio - Allen <allens@cpan.org> */
8892 # define MY_DBL_MAX DBL_MAX
8893 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8894 # if DOUBLESIZE >= 8
8895 # define MY_DBL_MAX 1.7976931348623157E+308L
8897 # define MY_DBL_MAX 3.40282347E+38L
8901 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8902 # define MY_DBL_MAX_BUG 1L
8904 # define MY_DBL_MAX_BUG MY_DBL_MAX
8908 # define MY_DBL_MIN DBL_MIN
8909 # else /* XXX guessing! -Allen */
8910 # if DOUBLESIZE >= 8
8911 # define MY_DBL_MIN 2.2250738585072014E-308L
8913 # define MY_DBL_MIN 1.17549435E-38L
8917 if ((intsize == 'q') && (c == 'f') &&
8918 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8920 /* it's going to be short enough that
8921 * long double precision is not needed */
8923 if ((nv <= 0L) && (nv >= -0L))
8924 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8926 /* would use Perl_fp_class as a double-check but not
8927 * functional on IRIX - see perl.h comments */
8929 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8930 /* It's within the range that a double can represent */
8931 #if defined(DBL_MAX) && !defined(DBL_MIN)
8932 if ((nv >= ((long double)1/DBL_MAX)) ||
8933 (nv <= (-(long double)1/DBL_MAX)))
8935 fix_ldbl_sprintf_bug = TRUE;
8938 if (fix_ldbl_sprintf_bug == TRUE) {
8948 # undef MY_DBL_MAX_BUG
8951 #endif /* HAS_LDBL_SPRINTF_BUG */
8953 need += 20; /* fudge factor */
8954 if (PL_efloatsize < need) {
8955 Safefree(PL_efloatbuf);
8956 PL_efloatsize = need + 20; /* more fudge */
8957 Newx(PL_efloatbuf, PL_efloatsize, char);
8958 PL_efloatbuf[0] = '\0';
8961 if ( !(width || left || plus || alt) && fill != '0'
8962 && has_precis && intsize != 'q' ) { /* Shortcuts */
8963 /* See earlier comment about buggy Gconvert when digits,
8965 if ( c == 'g' && precis) {
8966 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8967 /* May return an empty string for digits==0 */
8968 if (*PL_efloatbuf) {
8969 elen = strlen(PL_efloatbuf);
8970 goto float_converted;
8972 } else if ( c == 'f' && !precis) {
8973 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8978 char *ptr = ebuf + sizeof ebuf;
8981 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8982 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8983 if (intsize == 'q') {
8984 /* Copy the one or more characters in a long double
8985 * format before the 'base' ([efgEFG]) character to
8986 * the format string. */
8987 static char const prifldbl[] = PERL_PRIfldbl;
8988 char const *p = prifldbl + sizeof(prifldbl) - 3;
8989 while (p >= prifldbl) { *--ptr = *p--; }
8994 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8999 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9011 /* No taint. Otherwise we are in the strange situation
9012 * where printf() taints but print($float) doesn't.
9014 #if defined(HAS_LONG_DOUBLE)
9015 elen = ((intsize == 'q')
9016 ? my_sprintf(PL_efloatbuf, ptr, nv)
9017 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9019 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9023 eptr = PL_efloatbuf;
9031 i = SvCUR(sv) - origlen;
9034 case 'h': *(va_arg(*args, short*)) = i; break;
9035 default: *(va_arg(*args, int*)) = i; break;
9036 case 'l': *(va_arg(*args, long*)) = i; break;
9037 case 'V': *(va_arg(*args, IV*)) = i; break;
9039 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9044 sv_setuv_mg(argsv, (UV)i);
9045 continue; /* not "break" */
9052 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9053 && ckWARN(WARN_PRINTF))
9055 SV * const msg = sv_newmortal();
9056 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9057 (PL_op->op_type == OP_PRTF) ? "" : "s");
9060 Perl_sv_catpvf(aTHX_ msg,
9061 "\"%%%c\"", c & 0xFF);
9063 Perl_sv_catpvf(aTHX_ msg,
9064 "\"%%\\%03"UVof"\"",
9067 sv_catpvs(msg, "end of string");
9068 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9071 /* output mangled stuff ... */
9077 /* ... right here, because formatting flags should not apply */
9078 SvGROW(sv, SvCUR(sv) + elen + 1);
9080 Copy(eptr, p, elen, char);
9083 SvCUR_set(sv, p - SvPVX_const(sv));
9085 continue; /* not "break" */
9088 /* calculate width before utf8_upgrade changes it */
9089 have = esignlen + zeros + elen;
9091 Perl_croak_nocontext(PL_memory_wrap);
9093 if (is_utf8 != has_utf8) {
9096 sv_utf8_upgrade(sv);
9099 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9100 sv_utf8_upgrade(nsv);
9101 eptr = SvPVX_const(nsv);
9104 SvGROW(sv, SvCUR(sv) + elen + 1);
9109 need = (have > width ? have : width);
9112 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9113 Perl_croak_nocontext(PL_memory_wrap);
9114 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9116 if (esignlen && fill == '0') {
9118 for (i = 0; i < (int)esignlen; i++)
9122 memset(p, fill, gap);
9125 if (esignlen && fill != '0') {
9127 for (i = 0; i < (int)esignlen; i++)
9132 for (i = zeros; i; i--)
9136 Copy(eptr, p, elen, char);
9140 memset(p, ' ', gap);
9145 Copy(dotstr, p, dotstrlen, char);
9149 vectorize = FALSE; /* done iterating over vecstr */
9156 SvCUR_set(sv, p - SvPVX_const(sv));
9164 /* =========================================================================
9166 =head1 Cloning an interpreter
9168 All the macros and functions in this section are for the private use of
9169 the main function, perl_clone().
9171 The foo_dup() functions make an exact copy of an existing foo thinngy.
9172 During the course of a cloning, a hash table is used to map old addresses
9173 to new addresses. The table is created and manipulated with the
9174 ptr_table_* functions.
9178 ============================================================================*/
9181 #if defined(USE_ITHREADS)
9183 #ifndef GpREFCNT_inc
9184 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9188 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9189 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9190 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9191 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9192 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9193 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9194 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9195 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9196 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9197 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9198 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9199 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9200 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9201 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9204 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9205 regcomp.c. AMS 20010712 */
9208 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9213 struct reg_substr_datum *s;
9216 return (REGEXP *)NULL;
9218 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9221 len = r->offsets[0];
9222 npar = r->nparens+1;
9224 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9225 Copy(r->program, ret->program, len+1, regnode);
9227 Newx(ret->startp, npar, I32);
9228 Copy(r->startp, ret->startp, npar, I32);
9229 Newx(ret->endp, npar, I32);
9230 Copy(r->startp, ret->startp, npar, I32);
9232 Newx(ret->substrs, 1, struct reg_substr_data);
9233 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9234 s->min_offset = r->substrs->data[i].min_offset;
9235 s->max_offset = r->substrs->data[i].max_offset;
9236 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9237 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9240 ret->regstclass = NULL;
9243 const int count = r->data->count;
9246 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9247 char, struct reg_data);
9248 Newx(d->what, count, U8);
9251 for (i = 0; i < count; i++) {
9252 d->what[i] = r->data->what[i];
9253 switch (d->what[i]) {
9254 /* legal options are one of: sfpont
9255 see also regcomp.h and pregfree() */
9257 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9260 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9263 /* This is cheating. */
9264 Newx(d->data[i], 1, struct regnode_charclass_class);
9265 StructCopy(r->data->data[i], d->data[i],
9266 struct regnode_charclass_class);
9267 ret->regstclass = (regnode*)d->data[i];
9270 /* Compiled op trees are readonly, and can thus be
9271 shared without duplication. */
9273 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9277 d->data[i] = r->data->data[i];
9280 d->data[i] = r->data->data[i];
9282 ((reg_trie_data*)d->data[i])->refcount++;
9286 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9295 Newx(ret->offsets, 2*len+1, U32);
9296 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9298 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9299 ret->refcnt = r->refcnt;
9300 ret->minlen = r->minlen;
9301 ret->prelen = r->prelen;
9302 ret->nparens = r->nparens;
9303 ret->lastparen = r->lastparen;
9304 ret->lastcloseparen = r->lastcloseparen;
9305 ret->reganch = r->reganch;
9307 ret->sublen = r->sublen;
9309 if (RX_MATCH_COPIED(ret))
9310 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9313 #ifdef PERL_OLD_COPY_ON_WRITE
9314 ret->saved_copy = NULL;
9317 ptr_table_store(PL_ptr_table, r, ret);
9321 /* duplicate a file handle */
9324 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9328 PERL_UNUSED_ARG(type);
9331 return (PerlIO*)NULL;
9333 /* look for it in the table first */
9334 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9338 /* create anew and remember what it is */
9339 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9340 ptr_table_store(PL_ptr_table, fp, ret);
9344 /* duplicate a directory handle */
9347 Perl_dirp_dup(pTHX_ DIR *dp)
9349 PERL_UNUSED_CONTEXT;
9356 /* duplicate a typeglob */
9359 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9365 /* look for it in the table first */
9366 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9370 /* create anew and remember what it is */
9372 ptr_table_store(PL_ptr_table, gp, ret);
9375 ret->gp_refcnt = 0; /* must be before any other dups! */
9376 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9377 ret->gp_io = io_dup_inc(gp->gp_io, param);
9378 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9379 ret->gp_av = av_dup_inc(gp->gp_av, param);
9380 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9381 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9382 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9383 ret->gp_cvgen = gp->gp_cvgen;
9384 ret->gp_line = gp->gp_line;
9385 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9389 /* duplicate a chain of magic */
9392 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9394 MAGIC *mgprev = (MAGIC*)NULL;
9397 return (MAGIC*)NULL;
9398 /* look for it in the table first */
9399 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9403 for (; mg; mg = mg->mg_moremagic) {
9405 Newxz(nmg, 1, MAGIC);
9407 mgprev->mg_moremagic = nmg;
9410 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9411 nmg->mg_private = mg->mg_private;
9412 nmg->mg_type = mg->mg_type;
9413 nmg->mg_flags = mg->mg_flags;
9414 if (mg->mg_type == PERL_MAGIC_qr) {
9415 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9417 else if(mg->mg_type == PERL_MAGIC_backref) {
9418 /* The backref AV has its reference count deliberately bumped by
9420 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9422 else if (mg->mg_type == PERL_MAGIC_symtab) {
9423 nmg->mg_obj = mg->mg_obj;
9426 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9427 ? sv_dup_inc(mg->mg_obj, param)
9428 : sv_dup(mg->mg_obj, param);
9430 nmg->mg_len = mg->mg_len;
9431 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9432 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9433 if (mg->mg_len > 0) {
9434 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9435 if (mg->mg_type == PERL_MAGIC_overload_table &&
9436 AMT_AMAGIC((AMT*)mg->mg_ptr))
9438 const AMT * const amtp = (AMT*)mg->mg_ptr;
9439 AMT * const namtp = (AMT*)nmg->mg_ptr;
9441 for (i = 1; i < NofAMmeth; i++) {
9442 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9446 else if (mg->mg_len == HEf_SVKEY)
9447 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9449 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9450 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9457 /* create a new pointer-mapping table */
9460 Perl_ptr_table_new(pTHX)
9463 PERL_UNUSED_CONTEXT;
9465 Newxz(tbl, 1, PTR_TBL_t);
9468 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9472 #define PTR_TABLE_HASH(ptr) \
9473 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9476 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9477 following define) and at call to new_body_inline made below in
9478 Perl_ptr_table_store()
9481 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9483 /* map an existing pointer using a table */
9485 STATIC PTR_TBL_ENT_t *
9486 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9487 PTR_TBL_ENT_t *tblent;
9488 const UV hash = PTR_TABLE_HASH(sv);
9490 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9491 for (; tblent; tblent = tblent->next) {
9492 if (tblent->oldval == sv)
9499 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9501 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9502 PERL_UNUSED_CONTEXT;
9503 return tblent ? tblent->newval : (void *) 0;
9506 /* add a new entry to a pointer-mapping table */
9509 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9511 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9512 PERL_UNUSED_CONTEXT;
9515 tblent->newval = newsv;
9517 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9519 new_body_inline(tblent, PTE_SVSLOT);
9521 tblent->oldval = oldsv;
9522 tblent->newval = newsv;
9523 tblent->next = tbl->tbl_ary[entry];
9524 tbl->tbl_ary[entry] = tblent;
9526 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9527 ptr_table_split(tbl);
9531 /* double the hash bucket size of an existing ptr table */
9534 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9536 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9537 const UV oldsize = tbl->tbl_max + 1;
9538 UV newsize = oldsize * 2;
9540 PERL_UNUSED_CONTEXT;
9542 Renew(ary, newsize, PTR_TBL_ENT_t*);
9543 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9544 tbl->tbl_max = --newsize;
9546 for (i=0; i < oldsize; i++, ary++) {
9547 PTR_TBL_ENT_t **curentp, **entp, *ent;
9550 curentp = ary + oldsize;
9551 for (entp = ary, ent = *ary; ent; ent = *entp) {
9552 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9554 ent->next = *curentp;
9564 /* remove all the entries from a ptr table */
9567 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9569 if (tbl && tbl->tbl_items) {
9570 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9571 UV riter = tbl->tbl_max;
9574 PTR_TBL_ENT_t *entry = array[riter];
9577 PTR_TBL_ENT_t * const oentry = entry;
9578 entry = entry->next;
9587 /* clear and free a ptr table */
9590 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9595 ptr_table_clear(tbl);
9596 Safefree(tbl->tbl_ary);
9602 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9605 SvRV_set(dstr, SvWEAKREF(sstr)
9606 ? sv_dup(SvRV(sstr), param)
9607 : sv_dup_inc(SvRV(sstr), param));
9610 else if (SvPVX_const(sstr)) {
9611 /* Has something there */
9613 /* Normal PV - clone whole allocated space */
9614 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9615 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9616 /* Not that normal - actually sstr is copy on write.
9617 But we are a true, independant SV, so: */
9618 SvREADONLY_off(dstr);
9623 /* Special case - not normally malloced for some reason */
9624 if (isGV_with_GP(sstr)) {
9625 /* Don't need to do anything here. */
9627 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9628 /* A "shared" PV - clone it as "shared" PV */
9630 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9634 /* Some other special case - random pointer */
9635 SvPV_set(dstr, SvPVX(sstr));
9641 if (SvTYPE(dstr) == SVt_RV)
9642 SvRV_set(dstr, NULL);
9644 SvPV_set(dstr, NULL);
9648 /* duplicate an SV of any type (including AV, HV etc) */
9651 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9656 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9658 /* look for it in the table first */
9659 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9663 if(param->flags & CLONEf_JOIN_IN) {
9664 /** We are joining here so we don't want do clone
9665 something that is bad **/
9666 if (SvTYPE(sstr) == SVt_PVHV) {
9667 const char * const hvname = HvNAME_get(sstr);
9669 /** don't clone stashes if they already exist **/
9670 return (SV*)gv_stashpv(hvname,0);
9674 /* create anew and remember what it is */
9677 #ifdef DEBUG_LEAKING_SCALARS
9678 dstr->sv_debug_optype = sstr->sv_debug_optype;
9679 dstr->sv_debug_line = sstr->sv_debug_line;
9680 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9681 dstr->sv_debug_cloned = 1;
9682 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9685 ptr_table_store(PL_ptr_table, sstr, dstr);
9688 SvFLAGS(dstr) = SvFLAGS(sstr);
9689 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9690 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9693 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9694 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9695 PL_watch_pvx, SvPVX_const(sstr));
9698 /* don't clone objects whose class has asked us not to */
9699 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9700 SvFLAGS(dstr) &= ~SVTYPEMASK;
9705 switch (SvTYPE(sstr)) {
9710 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9711 SvIV_set(dstr, SvIVX(sstr));
9714 SvANY(dstr) = new_XNV();
9715 SvNV_set(dstr, SvNVX(sstr));
9718 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9719 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9723 /* These are all the types that need complex bodies allocating. */
9725 const svtype sv_type = SvTYPE(sstr);
9726 const struct body_details *const sv_type_details
9727 = bodies_by_type + sv_type;
9731 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9735 if (GvUNIQUE((GV*)sstr)) {
9736 /*EMPTY*/; /* Do sharing here, and fall through */
9749 assert(sv_type_details->body_size);
9750 if (sv_type_details->arena) {
9751 new_body_inline(new_body, sv_type);
9753 = (void*)((char*)new_body - sv_type_details->offset);
9755 new_body = new_NOARENA(sv_type_details);
9759 SvANY(dstr) = new_body;
9762 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9763 ((char*)SvANY(dstr)) + sv_type_details->offset,
9764 sv_type_details->copy, char);
9766 Copy(((char*)SvANY(sstr)),
9767 ((char*)SvANY(dstr)),
9768 sv_type_details->body_size + sv_type_details->offset, char);
9771 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9772 && !isGV_with_GP(dstr))
9773 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9775 /* The Copy above means that all the source (unduplicated) pointers
9776 are now in the destination. We can check the flags and the
9777 pointers in either, but it's possible that there's less cache
9778 missing by always going for the destination.
9779 FIXME - instrument and check that assumption */
9780 if (sv_type >= SVt_PVMG) {
9782 if ((sv_type == SVt_PVMG) && (ourstash = OURSTASH(dstr))) {
9783 OURSTASH_set(dstr, hv_dup_inc(ourstash, param));
9784 } else if (SvMAGIC(dstr))
9785 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9787 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9790 /* The cast silences a GCC warning about unhandled types. */
9791 switch ((int)sv_type) {
9803 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9804 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9805 LvTARG(dstr) = dstr;
9806 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9807 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9809 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9812 if (GvNAME_HEK(dstr))
9813 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
9815 /* Don't call sv_add_backref here as it's going to be created
9816 as part of the magic cloning of the symbol table. */
9817 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9818 if(isGV_with_GP(sstr)) {
9819 /* Danger Will Robinson - GvGP(dstr) isn't initialised
9820 at the point of this comment. */
9821 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9822 (void)GpREFCNT_inc(GvGP(dstr));
9824 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9827 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9828 if (IoOFP(dstr) == IoIFP(sstr))
9829 IoOFP(dstr) = IoIFP(dstr);
9831 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9832 /* PL_rsfp_filters entries have fake IoDIRP() */
9833 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9834 /* I have no idea why fake dirp (rsfps)
9835 should be treated differently but otherwise
9836 we end up with leaks -- sky*/
9837 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9838 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9839 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9841 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9842 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9843 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9845 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9848 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
9851 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9852 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9853 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9856 if (AvARRAY((AV*)sstr)) {
9857 SV **dst_ary, **src_ary;
9858 SSize_t items = AvFILLp((AV*)sstr) + 1;
9860 src_ary = AvARRAY((AV*)sstr);
9861 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9862 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9863 SvPV_set(dstr, (char*)dst_ary);
9864 AvALLOC((AV*)dstr) = dst_ary;
9865 if (AvREAL((AV*)sstr)) {
9867 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9871 *dst_ary++ = sv_dup(*src_ary++, param);
9873 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9874 while (items-- > 0) {
9875 *dst_ary++ = &PL_sv_undef;
9879 SvPV_set(dstr, NULL);
9880 AvALLOC((AV*)dstr) = (SV**)NULL;
9887 if (HvARRAY((HV*)sstr)) {
9889 const bool sharekeys = !!HvSHAREKEYS(sstr);
9890 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9891 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9893 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9894 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9896 HvARRAY(dstr) = (HE**)darray;
9897 while (i <= sxhv->xhv_max) {
9898 const HE *source = HvARRAY(sstr)[i];
9899 HvARRAY(dstr)[i] = source
9900 ? he_dup(source, sharekeys, param) : 0;
9904 struct xpvhv_aux * const saux = HvAUX(sstr);
9905 struct xpvhv_aux * const daux = HvAUX(dstr);
9906 /* This flag isn't copied. */
9907 /* SvOOK_on(hv) attacks the IV flags. */
9908 SvFLAGS(dstr) |= SVf_OOK;
9910 hvname = saux->xhv_name;
9912 = hvname ? hek_dup(hvname, param) : hvname;
9914 daux->xhv_riter = saux->xhv_riter;
9915 daux->xhv_eiter = saux->xhv_eiter
9916 ? he_dup(saux->xhv_eiter,
9917 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9918 daux->xhv_backreferences = saux->xhv_backreferences
9919 ? (AV*) SvREFCNT_inc(
9927 SvPV_set(dstr, NULL);
9929 /* Record stashes for possible cloning in Perl_clone(). */
9931 av_push(param->stashes, dstr);
9935 if (!(param->flags & CLONEf_COPY_STACKS)) {
9939 /* NOTE: not refcounted */
9940 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9942 if (!CvISXSUB(dstr))
9943 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9945 if (CvCONST(dstr) && CvISXSUB(dstr)) {
9946 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9947 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9948 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9950 /* don't dup if copying back - CvGV isn't refcounted, so the
9951 * duped GV may never be freed. A bit of a hack! DAPM */
9952 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9953 NULL : gv_dup(CvGV(dstr), param) ;
9954 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9957 ? cv_dup( CvOUTSIDE(dstr), param)
9958 : cv_dup_inc(CvOUTSIDE(dstr), param);
9959 if (!CvISXSUB(dstr))
9960 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9966 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9972 /* duplicate a context */
9975 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9980 return (PERL_CONTEXT*)NULL;
9982 /* look for it in the table first */
9983 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9987 /* create anew and remember what it is */
9988 Newxz(ncxs, max + 1, PERL_CONTEXT);
9989 ptr_table_store(PL_ptr_table, cxs, ncxs);
9992 PERL_CONTEXT * const cx = &cxs[ix];
9993 PERL_CONTEXT * const ncx = &ncxs[ix];
9994 ncx->cx_type = cx->cx_type;
9995 if (CxTYPE(cx) == CXt_SUBST) {
9996 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9999 ncx->blk_oldsp = cx->blk_oldsp;
10000 ncx->blk_oldcop = cx->blk_oldcop;
10001 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10002 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10003 ncx->blk_oldpm = cx->blk_oldpm;
10004 ncx->blk_gimme = cx->blk_gimme;
10005 switch (CxTYPE(cx)) {
10007 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10008 ? cv_dup_inc(cx->blk_sub.cv, param)
10009 : cv_dup(cx->blk_sub.cv,param));
10010 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10011 ? av_dup_inc(cx->blk_sub.argarray, param)
10013 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10014 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10015 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10016 ncx->blk_sub.lval = cx->blk_sub.lval;
10017 ncx->blk_sub.retop = cx->blk_sub.retop;
10020 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10021 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10022 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10023 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10024 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10025 ncx->blk_eval.retop = cx->blk_eval.retop;
10028 ncx->blk_loop.label = cx->blk_loop.label;
10029 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10030 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10031 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10032 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10033 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10034 ? cx->blk_loop.iterdata
10035 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10036 ncx->blk_loop.oldcomppad
10037 = (PAD*)ptr_table_fetch(PL_ptr_table,
10038 cx->blk_loop.oldcomppad);
10039 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10040 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10041 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10042 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10043 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10046 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10047 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10048 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10049 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10050 ncx->blk_sub.retop = cx->blk_sub.retop;
10062 /* duplicate a stack info structure */
10065 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10070 return (PERL_SI*)NULL;
10072 /* look for it in the table first */
10073 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10077 /* create anew and remember what it is */
10078 Newxz(nsi, 1, PERL_SI);
10079 ptr_table_store(PL_ptr_table, si, nsi);
10081 nsi->si_stack = av_dup_inc(si->si_stack, param);
10082 nsi->si_cxix = si->si_cxix;
10083 nsi->si_cxmax = si->si_cxmax;
10084 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10085 nsi->si_type = si->si_type;
10086 nsi->si_prev = si_dup(si->si_prev, param);
10087 nsi->si_next = si_dup(si->si_next, param);
10088 nsi->si_markoff = si->si_markoff;
10093 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10094 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10095 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10096 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10097 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10098 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10099 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10100 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10101 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10102 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10103 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10104 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10105 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10106 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10109 #define pv_dup_inc(p) SAVEPV(p)
10110 #define pv_dup(p) SAVEPV(p)
10111 #define svp_dup_inc(p,pp) any_dup(p,pp)
10113 /* map any object to the new equivent - either something in the
10114 * ptr table, or something in the interpreter structure
10118 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10123 return (void*)NULL;
10125 /* look for it in the table first */
10126 ret = ptr_table_fetch(PL_ptr_table, v);
10130 /* see if it is part of the interpreter structure */
10131 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10132 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10140 /* duplicate the save stack */
10143 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10145 ANY * const ss = proto_perl->Tsavestack;
10146 const I32 max = proto_perl->Tsavestack_max;
10147 I32 ix = proto_perl->Tsavestack_ix;
10159 void (*dptr) (void*);
10160 void (*dxptr) (pTHX_ void*);
10162 Newxz(nss, max, ANY);
10165 I32 i = POPINT(ss,ix);
10166 TOPINT(nss,ix) = i;
10168 case SAVEt_ITEM: /* normal string */
10169 sv = (SV*)POPPTR(ss,ix);
10170 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10171 sv = (SV*)POPPTR(ss,ix);
10172 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10174 case SAVEt_SV: /* scalar reference */
10175 sv = (SV*)POPPTR(ss,ix);
10176 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10177 gv = (GV*)POPPTR(ss,ix);
10178 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10180 case SAVEt_GENERIC_PVREF: /* generic char* */
10181 c = (char*)POPPTR(ss,ix);
10182 TOPPTR(nss,ix) = pv_dup(c);
10183 ptr = POPPTR(ss,ix);
10184 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10186 case SAVEt_SHARED_PVREF: /* char* in shared space */
10187 c = (char*)POPPTR(ss,ix);
10188 TOPPTR(nss,ix) = savesharedpv(c);
10189 ptr = POPPTR(ss,ix);
10190 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10192 case SAVEt_GENERIC_SVREF: /* generic sv */
10193 case SAVEt_SVREF: /* scalar reference */
10194 sv = (SV*)POPPTR(ss,ix);
10195 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10196 ptr = POPPTR(ss,ix);
10197 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10199 case SAVEt_AV: /* array reference */
10200 av = (AV*)POPPTR(ss,ix);
10201 TOPPTR(nss,ix) = av_dup_inc(av, param);
10202 gv = (GV*)POPPTR(ss,ix);
10203 TOPPTR(nss,ix) = gv_dup(gv, param);
10205 case SAVEt_HV: /* hash reference */
10206 hv = (HV*)POPPTR(ss,ix);
10207 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10208 gv = (GV*)POPPTR(ss,ix);
10209 TOPPTR(nss,ix) = gv_dup(gv, param);
10211 case SAVEt_INT: /* int reference */
10212 ptr = POPPTR(ss,ix);
10213 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10214 intval = (int)POPINT(ss,ix);
10215 TOPINT(nss,ix) = intval;
10217 case SAVEt_LONG: /* long reference */
10218 ptr = POPPTR(ss,ix);
10219 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10220 longval = (long)POPLONG(ss,ix);
10221 TOPLONG(nss,ix) = longval;
10223 case SAVEt_I32: /* I32 reference */
10224 case SAVEt_I16: /* I16 reference */
10225 case SAVEt_I8: /* I8 reference */
10226 ptr = POPPTR(ss,ix);
10227 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10229 TOPINT(nss,ix) = i;
10231 case SAVEt_IV: /* IV reference */
10232 ptr = POPPTR(ss,ix);
10233 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10235 TOPIV(nss,ix) = iv;
10237 case SAVEt_SPTR: /* SV* reference */
10238 ptr = POPPTR(ss,ix);
10239 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10240 sv = (SV*)POPPTR(ss,ix);
10241 TOPPTR(nss,ix) = sv_dup(sv, param);
10243 case SAVEt_VPTR: /* random* reference */
10244 ptr = POPPTR(ss,ix);
10245 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10246 ptr = POPPTR(ss,ix);
10247 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10249 case SAVEt_PPTR: /* char* reference */
10250 ptr = POPPTR(ss,ix);
10251 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10252 c = (char*)POPPTR(ss,ix);
10253 TOPPTR(nss,ix) = pv_dup(c);
10255 case SAVEt_HPTR: /* HV* reference */
10256 ptr = POPPTR(ss,ix);
10257 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10258 hv = (HV*)POPPTR(ss,ix);
10259 TOPPTR(nss,ix) = hv_dup(hv, param);
10261 case SAVEt_APTR: /* AV* reference */
10262 ptr = POPPTR(ss,ix);
10263 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10264 av = (AV*)POPPTR(ss,ix);
10265 TOPPTR(nss,ix) = av_dup(av, param);
10268 gv = (GV*)POPPTR(ss,ix);
10269 TOPPTR(nss,ix) = gv_dup(gv, param);
10271 case SAVEt_GP: /* scalar reference */
10272 gp = (GP*)POPPTR(ss,ix);
10273 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10274 (void)GpREFCNT_inc(gp);
10275 gv = (GV*)POPPTR(ss,ix);
10276 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10277 c = (char*)POPPTR(ss,ix);
10278 TOPPTR(nss,ix) = pv_dup(c);
10280 TOPIV(nss,ix) = iv;
10282 TOPIV(nss,ix) = iv;
10285 case SAVEt_MORTALIZESV:
10286 sv = (SV*)POPPTR(ss,ix);
10287 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10290 ptr = POPPTR(ss,ix);
10291 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10292 /* these are assumed to be refcounted properly */
10294 switch (((OP*)ptr)->op_type) {
10296 case OP_LEAVESUBLV:
10300 case OP_LEAVEWRITE:
10301 TOPPTR(nss,ix) = ptr;
10306 TOPPTR(nss,ix) = NULL;
10311 TOPPTR(nss,ix) = NULL;
10314 c = (char*)POPPTR(ss,ix);
10315 TOPPTR(nss,ix) = pv_dup_inc(c);
10317 case SAVEt_CLEARSV:
10318 longval = POPLONG(ss,ix);
10319 TOPLONG(nss,ix) = longval;
10322 hv = (HV*)POPPTR(ss,ix);
10323 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10324 c = (char*)POPPTR(ss,ix);
10325 TOPPTR(nss,ix) = pv_dup_inc(c);
10327 TOPINT(nss,ix) = i;
10329 case SAVEt_DESTRUCTOR:
10330 ptr = POPPTR(ss,ix);
10331 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10332 dptr = POPDPTR(ss,ix);
10333 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10334 any_dup(FPTR2DPTR(void *, dptr),
10337 case SAVEt_DESTRUCTOR_X:
10338 ptr = POPPTR(ss,ix);
10339 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10340 dxptr = POPDXPTR(ss,ix);
10341 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10342 any_dup(FPTR2DPTR(void *, dxptr),
10345 case SAVEt_REGCONTEXT:
10348 TOPINT(nss,ix) = i;
10351 case SAVEt_STACK_POS: /* Position on Perl stack */
10353 TOPINT(nss,ix) = i;
10355 case SAVEt_AELEM: /* array element */
10356 sv = (SV*)POPPTR(ss,ix);
10357 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10359 TOPINT(nss,ix) = i;
10360 av = (AV*)POPPTR(ss,ix);
10361 TOPPTR(nss,ix) = av_dup_inc(av, param);
10363 case SAVEt_HELEM: /* hash element */
10364 sv = (SV*)POPPTR(ss,ix);
10365 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10366 sv = (SV*)POPPTR(ss,ix);
10367 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10368 hv = (HV*)POPPTR(ss,ix);
10369 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10372 ptr = POPPTR(ss,ix);
10373 TOPPTR(nss,ix) = ptr;
10377 TOPINT(nss,ix) = i;
10379 case SAVEt_COMPPAD:
10380 av = (AV*)POPPTR(ss,ix);
10381 TOPPTR(nss,ix) = av_dup(av, param);
10384 longval = (long)POPLONG(ss,ix);
10385 TOPLONG(nss,ix) = longval;
10386 ptr = POPPTR(ss,ix);
10387 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10388 sv = (SV*)POPPTR(ss,ix);
10389 TOPPTR(nss,ix) = sv_dup(sv, param);
10392 ptr = POPPTR(ss,ix);
10393 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10394 longval = (long)POPBOOL(ss,ix);
10395 TOPBOOL(nss,ix) = (bool)longval;
10397 case SAVEt_SET_SVFLAGS:
10399 TOPINT(nss,ix) = i;
10401 TOPINT(nss,ix) = i;
10402 sv = (SV*)POPPTR(ss,ix);
10403 TOPPTR(nss,ix) = sv_dup(sv, param);
10406 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10414 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10415 * flag to the result. This is done for each stash before cloning starts,
10416 * so we know which stashes want their objects cloned */
10419 do_mark_cloneable_stash(pTHX_ SV *sv)
10421 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10423 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10424 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10425 if (cloner && GvCV(cloner)) {
10432 XPUSHs(sv_2mortal(newSVhek(hvname)));
10434 call_sv((SV*)GvCV(cloner), G_SCALAR);
10441 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10449 =for apidoc perl_clone
10451 Create and return a new interpreter by cloning the current one.
10453 perl_clone takes these flags as parameters:
10455 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10456 without it we only clone the data and zero the stacks,
10457 with it we copy the stacks and the new perl interpreter is
10458 ready to run at the exact same point as the previous one.
10459 The pseudo-fork code uses COPY_STACKS while the
10460 threads->new doesn't.
10462 CLONEf_KEEP_PTR_TABLE
10463 perl_clone keeps a ptr_table with the pointer of the old
10464 variable as a key and the new variable as a value,
10465 this allows it to check if something has been cloned and not
10466 clone it again but rather just use the value and increase the
10467 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10468 the ptr_table using the function
10469 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10470 reason to keep it around is if you want to dup some of your own
10471 variable who are outside the graph perl scans, example of this
10472 code is in threads.xs create
10475 This is a win32 thing, it is ignored on unix, it tells perls
10476 win32host code (which is c++) to clone itself, this is needed on
10477 win32 if you want to run two threads at the same time,
10478 if you just want to do some stuff in a separate perl interpreter
10479 and then throw it away and return to the original one,
10480 you don't need to do anything.
10485 /* XXX the above needs expanding by someone who actually understands it ! */
10486 EXTERN_C PerlInterpreter *
10487 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10490 perl_clone(PerlInterpreter *proto_perl, UV flags)
10493 #ifdef PERL_IMPLICIT_SYS
10495 /* perlhost.h so we need to call into it
10496 to clone the host, CPerlHost should have a c interface, sky */
10498 if (flags & CLONEf_CLONE_HOST) {
10499 return perl_clone_host(proto_perl,flags);
10501 return perl_clone_using(proto_perl, flags,
10503 proto_perl->IMemShared,
10504 proto_perl->IMemParse,
10506 proto_perl->IStdIO,
10510 proto_perl->IProc);
10514 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10515 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10516 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10517 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10518 struct IPerlDir* ipD, struct IPerlSock* ipS,
10519 struct IPerlProc* ipP)
10521 /* XXX many of the string copies here can be optimized if they're
10522 * constants; they need to be allocated as common memory and just
10523 * their pointers copied. */
10526 CLONE_PARAMS clone_params;
10527 CLONE_PARAMS* const param = &clone_params;
10529 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10530 /* for each stash, determine whether its objects should be cloned */
10531 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10532 PERL_SET_THX(my_perl);
10535 Poison(my_perl, 1, PerlInterpreter);
10541 PL_savestack_ix = 0;
10542 PL_savestack_max = -1;
10543 PL_sig_pending = 0;
10544 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10545 # else /* !DEBUGGING */
10546 Zero(my_perl, 1, PerlInterpreter);
10547 # endif /* DEBUGGING */
10549 /* host pointers */
10551 PL_MemShared = ipMS;
10552 PL_MemParse = ipMP;
10559 #else /* !PERL_IMPLICIT_SYS */
10561 CLONE_PARAMS clone_params;
10562 CLONE_PARAMS* param = &clone_params;
10563 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10564 /* for each stash, determine whether its objects should be cloned */
10565 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10566 PERL_SET_THX(my_perl);
10569 Poison(my_perl, 1, PerlInterpreter);
10575 PL_savestack_ix = 0;
10576 PL_savestack_max = -1;
10577 PL_sig_pending = 0;
10578 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10579 # else /* !DEBUGGING */
10580 Zero(my_perl, 1, PerlInterpreter);
10581 # endif /* DEBUGGING */
10582 #endif /* PERL_IMPLICIT_SYS */
10583 param->flags = flags;
10584 param->proto_perl = proto_perl;
10586 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10588 PL_body_arenas = NULL;
10589 Zero(&PL_body_roots, 1, PL_body_roots);
10591 PL_nice_chunk = NULL;
10592 PL_nice_chunk_size = 0;
10594 PL_sv_objcount = 0;
10596 PL_sv_arenaroot = NULL;
10598 PL_debug = proto_perl->Idebug;
10600 PL_hash_seed = proto_perl->Ihash_seed;
10601 PL_rehash_seed = proto_perl->Irehash_seed;
10603 #ifdef USE_REENTRANT_API
10604 /* XXX: things like -Dm will segfault here in perlio, but doing
10605 * PERL_SET_CONTEXT(proto_perl);
10606 * breaks too many other things
10608 Perl_reentrant_init(aTHX);
10611 /* create SV map for pointer relocation */
10612 PL_ptr_table = ptr_table_new();
10614 /* initialize these special pointers as early as possible */
10615 SvANY(&PL_sv_undef) = NULL;
10616 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10617 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10618 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10620 SvANY(&PL_sv_no) = new_XPVNV();
10621 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10622 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10623 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10624 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10625 SvCUR_set(&PL_sv_no, 0);
10626 SvLEN_set(&PL_sv_no, 1);
10627 SvIV_set(&PL_sv_no, 0);
10628 SvNV_set(&PL_sv_no, 0);
10629 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10631 SvANY(&PL_sv_yes) = new_XPVNV();
10632 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10633 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10634 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10635 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10636 SvCUR_set(&PL_sv_yes, 1);
10637 SvLEN_set(&PL_sv_yes, 2);
10638 SvIV_set(&PL_sv_yes, 1);
10639 SvNV_set(&PL_sv_yes, 1);
10640 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10642 /* create (a non-shared!) shared string table */
10643 PL_strtab = newHV();
10644 HvSHAREKEYS_off(PL_strtab);
10645 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10646 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10648 PL_compiling = proto_perl->Icompiling;
10650 /* These two PVs will be free'd special way so must set them same way op.c does */
10651 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10652 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10654 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10655 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10657 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10658 if (!specialWARN(PL_compiling.cop_warnings))
10659 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10660 if (!specialCopIO(PL_compiling.cop_io))
10661 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10662 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10664 /* pseudo environmental stuff */
10665 PL_origargc = proto_perl->Iorigargc;
10666 PL_origargv = proto_perl->Iorigargv;
10668 param->stashes = newAV(); /* Setup array of objects to call clone on */
10670 /* Set tainting stuff before PerlIO_debug can possibly get called */
10671 PL_tainting = proto_perl->Itainting;
10672 PL_taint_warn = proto_perl->Itaint_warn;
10674 #ifdef PERLIO_LAYERS
10675 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10676 PerlIO_clone(aTHX_ proto_perl, param);
10679 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10680 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10681 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10682 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10683 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10684 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10687 PL_minus_c = proto_perl->Iminus_c;
10688 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10689 PL_localpatches = proto_perl->Ilocalpatches;
10690 PL_splitstr = proto_perl->Isplitstr;
10691 PL_preprocess = proto_perl->Ipreprocess;
10692 PL_minus_n = proto_perl->Iminus_n;
10693 PL_minus_p = proto_perl->Iminus_p;
10694 PL_minus_l = proto_perl->Iminus_l;
10695 PL_minus_a = proto_perl->Iminus_a;
10696 PL_minus_E = proto_perl->Iminus_E;
10697 PL_minus_F = proto_perl->Iminus_F;
10698 PL_doswitches = proto_perl->Idoswitches;
10699 PL_dowarn = proto_perl->Idowarn;
10700 PL_doextract = proto_perl->Idoextract;
10701 PL_sawampersand = proto_perl->Isawampersand;
10702 PL_unsafe = proto_perl->Iunsafe;
10703 PL_inplace = SAVEPV(proto_perl->Iinplace);
10704 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10705 PL_perldb = proto_perl->Iperldb;
10706 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10707 PL_exit_flags = proto_perl->Iexit_flags;
10709 /* magical thingies */
10710 /* XXX time(&PL_basetime) when asked for? */
10711 PL_basetime = proto_perl->Ibasetime;
10712 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10714 PL_maxsysfd = proto_perl->Imaxsysfd;
10715 PL_multiline = proto_perl->Imultiline;
10716 PL_statusvalue = proto_perl->Istatusvalue;
10718 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10720 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10722 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10724 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10725 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10726 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10728 /* Clone the regex array */
10729 PL_regex_padav = newAV();
10731 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10732 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10734 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10735 for(i = 1; i <= len; i++) {
10736 const SV * const regex = regexen[i];
10739 ? sv_dup_inc(regex, param)
10741 newSViv(PTR2IV(re_dup(
10742 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10744 av_push(PL_regex_padav, sv);
10747 PL_regex_pad = AvARRAY(PL_regex_padav);
10749 /* shortcuts to various I/O objects */
10750 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10751 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10752 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10753 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10754 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10755 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10757 /* shortcuts to regexp stuff */
10758 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10760 /* shortcuts to misc objects */
10761 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10763 /* shortcuts to debugging objects */
10764 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10765 PL_DBline = gv_dup(proto_perl->IDBline, param);
10766 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10767 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10768 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10769 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10770 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10771 PL_lineary = av_dup(proto_perl->Ilineary, param);
10772 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10774 /* symbol tables */
10775 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10776 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10777 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10778 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10779 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10781 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10782 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10783 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10784 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10785 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10786 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10788 PL_sub_generation = proto_perl->Isub_generation;
10790 /* funky return mechanisms */
10791 PL_forkprocess = proto_perl->Iforkprocess;
10793 /* subprocess state */
10794 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10796 /* internal state */
10797 PL_maxo = proto_perl->Imaxo;
10798 if (proto_perl->Iop_mask)
10799 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10802 /* PL_asserting = proto_perl->Iasserting; */
10804 /* current interpreter roots */
10805 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10806 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10807 PL_main_start = proto_perl->Imain_start;
10808 PL_eval_root = proto_perl->Ieval_root;
10809 PL_eval_start = proto_perl->Ieval_start;
10811 /* runtime control stuff */
10812 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10813 PL_copline = proto_perl->Icopline;
10815 PL_filemode = proto_perl->Ifilemode;
10816 PL_lastfd = proto_perl->Ilastfd;
10817 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10820 PL_gensym = proto_perl->Igensym;
10821 PL_preambled = proto_perl->Ipreambled;
10822 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10823 PL_laststatval = proto_perl->Ilaststatval;
10824 PL_laststype = proto_perl->Ilaststype;
10827 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10829 /* interpreter atexit processing */
10830 PL_exitlistlen = proto_perl->Iexitlistlen;
10831 if (PL_exitlistlen) {
10832 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10833 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10836 PL_exitlist = (PerlExitListEntry*)NULL;
10838 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10839 if (PL_my_cxt_size) {
10840 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10841 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10844 PL_my_cxt_list = (void**)NULL;
10845 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10846 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10847 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10849 PL_profiledata = NULL;
10850 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10851 /* PL_rsfp_filters entries have fake IoDIRP() */
10852 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10854 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10856 PAD_CLONE_VARS(proto_perl, param);
10858 #ifdef HAVE_INTERP_INTERN
10859 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10862 /* more statics moved here */
10863 PL_generation = proto_perl->Igeneration;
10864 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10866 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10867 PL_in_clean_all = proto_perl->Iin_clean_all;
10869 PL_uid = proto_perl->Iuid;
10870 PL_euid = proto_perl->Ieuid;
10871 PL_gid = proto_perl->Igid;
10872 PL_egid = proto_perl->Iegid;
10873 PL_nomemok = proto_perl->Inomemok;
10874 PL_an = proto_perl->Ian;
10875 PL_evalseq = proto_perl->Ievalseq;
10876 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10877 PL_origalen = proto_perl->Iorigalen;
10878 #ifdef PERL_USES_PL_PIDSTATUS
10879 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10881 PL_osname = SAVEPV(proto_perl->Iosname);
10882 PL_sighandlerp = proto_perl->Isighandlerp;
10884 PL_runops = proto_perl->Irunops;
10886 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10889 PL_cshlen = proto_perl->Icshlen;
10890 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10893 PL_lex_state = proto_perl->Ilex_state;
10894 PL_lex_defer = proto_perl->Ilex_defer;
10895 PL_lex_expect = proto_perl->Ilex_expect;
10896 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10897 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10898 PL_lex_starts = proto_perl->Ilex_starts;
10899 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10900 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10901 PL_lex_op = proto_perl->Ilex_op;
10902 PL_lex_inpat = proto_perl->Ilex_inpat;
10903 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10904 PL_lex_brackets = proto_perl->Ilex_brackets;
10905 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10906 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10907 PL_lex_casemods = proto_perl->Ilex_casemods;
10908 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10909 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10912 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
10913 PL_lasttoke = proto_perl->Ilasttoke;
10914 PL_realtokenstart = proto_perl->Irealtokenstart;
10915 PL_faketokens = proto_perl->Ifaketokens;
10916 PL_thismad = proto_perl->Ithismad;
10917 PL_thistoken = proto_perl->Ithistoken;
10918 PL_thisopen = proto_perl->Ithisopen;
10919 PL_thisstuff = proto_perl->Ithisstuff;
10920 PL_thisclose = proto_perl->Ithisclose;
10921 PL_thiswhite = proto_perl->Ithiswhite;
10922 PL_nextwhite = proto_perl->Inextwhite;
10923 PL_skipwhite = proto_perl->Iskipwhite;
10924 PL_endwhite = proto_perl->Iendwhite;
10925 PL_curforce = proto_perl->Icurforce;
10927 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10928 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10929 PL_nexttoke = proto_perl->Inexttoke;
10932 /* XXX This is probably masking the deeper issue of why
10933 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10934 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10935 * (A little debugging with a watchpoint on it may help.)
10937 if (SvANY(proto_perl->Ilinestr)) {
10938 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10939 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10940 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10941 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10942 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10943 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10944 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10945 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10946 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10949 PL_linestr = newSV(79);
10950 sv_upgrade(PL_linestr,SVt_PVIV);
10951 sv_setpvn(PL_linestr,"",0);
10952 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10954 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10955 PL_pending_ident = proto_perl->Ipending_ident;
10956 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10958 PL_expect = proto_perl->Iexpect;
10960 PL_multi_start = proto_perl->Imulti_start;
10961 PL_multi_end = proto_perl->Imulti_end;
10962 PL_multi_open = proto_perl->Imulti_open;
10963 PL_multi_close = proto_perl->Imulti_close;
10965 PL_error_count = proto_perl->Ierror_count;
10966 PL_subline = proto_perl->Isubline;
10967 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10969 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10970 if (SvANY(proto_perl->Ilinestr)) {
10971 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10972 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10973 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10974 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10975 PL_last_lop_op = proto_perl->Ilast_lop_op;
10978 PL_last_uni = SvPVX(PL_linestr);
10979 PL_last_lop = SvPVX(PL_linestr);
10980 PL_last_lop_op = 0;
10982 PL_in_my = proto_perl->Iin_my;
10983 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10985 PL_cryptseen = proto_perl->Icryptseen;
10988 PL_hints = proto_perl->Ihints;
10990 PL_amagic_generation = proto_perl->Iamagic_generation;
10992 #ifdef USE_LOCALE_COLLATE
10993 PL_collation_ix = proto_perl->Icollation_ix;
10994 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10995 PL_collation_standard = proto_perl->Icollation_standard;
10996 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10997 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10998 #endif /* USE_LOCALE_COLLATE */
11000 #ifdef USE_LOCALE_NUMERIC
11001 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11002 PL_numeric_standard = proto_perl->Inumeric_standard;
11003 PL_numeric_local = proto_perl->Inumeric_local;
11004 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11005 #endif /* !USE_LOCALE_NUMERIC */
11007 /* utf8 character classes */
11008 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11009 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11010 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11011 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11012 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11013 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11014 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11015 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11016 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11017 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11018 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11019 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11020 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11021 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11022 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11023 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11024 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11025 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11026 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11027 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11029 /* Did the locale setup indicate UTF-8? */
11030 PL_utf8locale = proto_perl->Iutf8locale;
11031 /* Unicode features (see perlrun/-C) */
11032 PL_unicode = proto_perl->Iunicode;
11034 /* Pre-5.8 signals control */
11035 PL_signals = proto_perl->Isignals;
11037 /* times() ticks per second */
11038 PL_clocktick = proto_perl->Iclocktick;
11040 /* Recursion stopper for PerlIO_find_layer */
11041 PL_in_load_module = proto_perl->Iin_load_module;
11043 /* sort() routine */
11044 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11046 /* Not really needed/useful since the reenrant_retint is "volatile",
11047 * but do it for consistency's sake. */
11048 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11050 /* Hooks to shared SVs and locks. */
11051 PL_sharehook = proto_perl->Isharehook;
11052 PL_lockhook = proto_perl->Ilockhook;
11053 PL_unlockhook = proto_perl->Iunlockhook;
11054 PL_threadhook = proto_perl->Ithreadhook;
11056 PL_runops_std = proto_perl->Irunops_std;
11057 PL_runops_dbg = proto_perl->Irunops_dbg;
11059 #ifdef THREADS_HAVE_PIDS
11060 PL_ppid = proto_perl->Ippid;
11064 PL_last_swash_hv = NULL; /* reinits on demand */
11065 PL_last_swash_klen = 0;
11066 PL_last_swash_key[0]= '\0';
11067 PL_last_swash_tmps = (U8*)NULL;
11068 PL_last_swash_slen = 0;
11070 PL_glob_index = proto_perl->Iglob_index;
11071 PL_srand_called = proto_perl->Isrand_called;
11072 PL_uudmap['M'] = 0; /* reinits on demand */
11073 PL_bitcount = NULL; /* reinits on demand */
11075 if (proto_perl->Ipsig_pend) {
11076 Newxz(PL_psig_pend, SIG_SIZE, int);
11079 PL_psig_pend = (int*)NULL;
11082 if (proto_perl->Ipsig_ptr) {
11083 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11084 Newxz(PL_psig_name, SIG_SIZE, SV*);
11085 for (i = 1; i < SIG_SIZE; i++) {
11086 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11087 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11091 PL_psig_ptr = (SV**)NULL;
11092 PL_psig_name = (SV**)NULL;
11095 /* thrdvar.h stuff */
11097 if (flags & CLONEf_COPY_STACKS) {
11098 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11099 PL_tmps_ix = proto_perl->Ttmps_ix;
11100 PL_tmps_max = proto_perl->Ttmps_max;
11101 PL_tmps_floor = proto_perl->Ttmps_floor;
11102 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11104 while (i <= PL_tmps_ix) {
11105 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11109 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11110 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11111 Newxz(PL_markstack, i, I32);
11112 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11113 - proto_perl->Tmarkstack);
11114 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11115 - proto_perl->Tmarkstack);
11116 Copy(proto_perl->Tmarkstack, PL_markstack,
11117 PL_markstack_ptr - PL_markstack + 1, I32);
11119 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11120 * NOTE: unlike the others! */
11121 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11122 PL_scopestack_max = proto_perl->Tscopestack_max;
11123 Newxz(PL_scopestack, PL_scopestack_max, I32);
11124 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11126 /* NOTE: si_dup() looks at PL_markstack */
11127 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11129 /* PL_curstack = PL_curstackinfo->si_stack; */
11130 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11131 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11133 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11134 PL_stack_base = AvARRAY(PL_curstack);
11135 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11136 - proto_perl->Tstack_base);
11137 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11139 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11140 * NOTE: unlike the others! */
11141 PL_savestack_ix = proto_perl->Tsavestack_ix;
11142 PL_savestack_max = proto_perl->Tsavestack_max;
11143 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11144 PL_savestack = ss_dup(proto_perl, param);
11148 ENTER; /* perl_destruct() wants to LEAVE; */
11150 /* although we're not duplicating the tmps stack, we should still
11151 * add entries for any SVs on the tmps stack that got cloned by a
11152 * non-refcount means (eg a temp in @_); otherwise they will be
11155 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11156 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11157 proto_perl->Ttmps_stack[i]);
11158 if (nsv && !SvREFCNT(nsv)) {
11160 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11165 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11166 PL_top_env = &PL_start_env;
11168 PL_op = proto_perl->Top;
11171 PL_Xpv = (XPV*)NULL;
11172 PL_na = proto_perl->Tna;
11174 PL_statbuf = proto_perl->Tstatbuf;
11175 PL_statcache = proto_perl->Tstatcache;
11176 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11177 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11179 PL_timesbuf = proto_perl->Ttimesbuf;
11182 PL_tainted = proto_perl->Ttainted;
11183 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11184 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11185 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11186 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11187 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11188 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11189 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11190 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11191 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11193 PL_restartop = proto_perl->Trestartop;
11194 PL_in_eval = proto_perl->Tin_eval;
11195 PL_delaymagic = proto_perl->Tdelaymagic;
11196 PL_dirty = proto_perl->Tdirty;
11197 PL_localizing = proto_perl->Tlocalizing;
11199 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11200 PL_hv_fetch_ent_mh = NULL;
11201 PL_modcount = proto_perl->Tmodcount;
11202 PL_lastgotoprobe = NULL;
11203 PL_dumpindent = proto_perl->Tdumpindent;
11205 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11206 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11207 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11208 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11209 PL_efloatbuf = NULL; /* reinits on demand */
11210 PL_efloatsize = 0; /* reinits on demand */
11214 PL_screamfirst = NULL;
11215 PL_screamnext = NULL;
11216 PL_maxscream = -1; /* reinits on demand */
11217 PL_lastscream = NULL;
11219 PL_watchaddr = NULL;
11222 PL_regdummy = proto_perl->Tregdummy;
11223 PL_regprecomp = NULL;
11226 PL_colorset = 0; /* reinits PL_colors[] */
11227 /*PL_colors[6] = {0,0,0,0,0,0};*/
11228 PL_reginput = NULL;
11231 PL_regstartp = (I32*)NULL;
11232 PL_regendp = (I32*)NULL;
11233 PL_reglastparen = (U32*)NULL;
11234 PL_reglastcloseparen = (U32*)NULL;
11236 PL_reg_start_tmp = (char**)NULL;
11237 PL_reg_start_tmpl = 0;
11238 PL_regdata = (struct reg_data*)NULL;
11241 PL_reg_eval_set = 0;
11243 PL_regprogram = (regnode*)NULL;
11245 PL_regcc = (CURCUR*)NULL;
11246 PL_reg_call_cc = (struct re_cc_state*)NULL;
11247 PL_reg_re = (regexp*)NULL;
11248 PL_reg_ganch = NULL;
11250 PL_reg_match_utf8 = FALSE;
11251 PL_reg_magic = (MAGIC*)NULL;
11253 PL_reg_oldcurpm = (PMOP*)NULL;
11254 PL_reg_curpm = (PMOP*)NULL;
11255 PL_reg_oldsaved = NULL;
11256 PL_reg_oldsavedlen = 0;
11257 #ifdef PERL_OLD_COPY_ON_WRITE
11260 PL_reg_maxiter = 0;
11261 PL_reg_leftiter = 0;
11262 PL_reg_poscache = NULL;
11263 PL_reg_poscache_size= 0;
11265 /* RE engine - function pointers */
11266 PL_regcompp = proto_perl->Tregcompp;
11267 PL_regexecp = proto_perl->Tregexecp;
11268 PL_regint_start = proto_perl->Tregint_start;
11269 PL_regint_string = proto_perl->Tregint_string;
11270 PL_regfree = proto_perl->Tregfree;
11272 PL_reginterp_cnt = 0;
11273 PL_reg_starttry = 0;
11275 /* Pluggable optimizer */
11276 PL_peepp = proto_perl->Tpeepp;
11278 PL_stashcache = newHV();
11280 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11281 ptr_table_free(PL_ptr_table);
11282 PL_ptr_table = NULL;
11285 /* Call the ->CLONE method, if it exists, for each of the stashes
11286 identified by sv_dup() above.
11288 while(av_len(param->stashes) != -1) {
11289 HV* const stash = (HV*) av_shift(param->stashes);
11290 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11291 if (cloner && GvCV(cloner)) {
11296 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11298 call_sv((SV*)GvCV(cloner), G_DISCARD);
11304 SvREFCNT_dec(param->stashes);
11306 /* orphaned? eg threads->new inside BEGIN or use */
11307 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11308 SvREFCNT_inc_simple_void(PL_compcv);
11309 SAVEFREESV(PL_compcv);
11315 #endif /* USE_ITHREADS */
11318 =head1 Unicode Support
11320 =for apidoc sv_recode_to_utf8
11322 The encoding is assumed to be an Encode object, on entry the PV
11323 of the sv is assumed to be octets in that encoding, and the sv
11324 will be converted into Unicode (and UTF-8).
11326 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11327 is not a reference, nothing is done to the sv. If the encoding is not
11328 an C<Encode::XS> Encoding object, bad things will happen.
11329 (See F<lib/encoding.pm> and L<Encode>).
11331 The PV of the sv is returned.
11336 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11339 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11353 Passing sv_yes is wrong - it needs to be or'ed set of constants
11354 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11355 remove converted chars from source.
11357 Both will default the value - let them.
11359 XPUSHs(&PL_sv_yes);
11362 call_method("decode", G_SCALAR);
11366 s = SvPV_const(uni, len);
11367 if (s != SvPVX_const(sv)) {
11368 SvGROW(sv, len + 1);
11369 Move(s, SvPVX(sv), len + 1, char);
11370 SvCUR_set(sv, len);
11377 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11381 =for apidoc sv_cat_decode
11383 The encoding is assumed to be an Encode object, the PV of the ssv is
11384 assumed to be octets in that encoding and decoding the input starts
11385 from the position which (PV + *offset) pointed to. The dsv will be
11386 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11387 when the string tstr appears in decoding output or the input ends on
11388 the PV of the ssv. The value which the offset points will be modified
11389 to the last input position on the ssv.
11391 Returns TRUE if the terminator was found, else returns FALSE.
11396 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11397 SV *ssv, int *offset, char *tstr, int tlen)
11401 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11412 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11413 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11415 call_method("cat_decode", G_SCALAR);
11417 ret = SvTRUE(TOPs);
11418 *offset = SvIV(offsv);
11424 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11429 /* ---------------------------------------------------------------------
11431 * support functions for report_uninit()
11434 /* the maxiumum size of array or hash where we will scan looking
11435 * for the undefined element that triggered the warning */
11437 #define FUV_MAX_SEARCH_SIZE 1000
11439 /* Look for an entry in the hash whose value has the same SV as val;
11440 * If so, return a mortal copy of the key. */
11443 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11446 register HE **array;
11449 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11450 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11453 array = HvARRAY(hv);
11455 for (i=HvMAX(hv); i>0; i--) {
11456 register HE *entry;
11457 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11458 if (HeVAL(entry) != val)
11460 if ( HeVAL(entry) == &PL_sv_undef ||
11461 HeVAL(entry) == &PL_sv_placeholder)
11465 if (HeKLEN(entry) == HEf_SVKEY)
11466 return sv_mortalcopy(HeKEY_sv(entry));
11467 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11473 /* Look for an entry in the array whose value has the same SV as val;
11474 * If so, return the index, otherwise return -1. */
11477 S_find_array_subscript(pTHX_ AV *av, SV* val)
11482 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11483 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11487 for (i=AvFILLp(av); i>=0; i--) {
11488 if (svp[i] == val && svp[i] != &PL_sv_undef)
11494 /* S_varname(): return the name of a variable, optionally with a subscript.
11495 * If gv is non-zero, use the name of that global, along with gvtype (one
11496 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11497 * targ. Depending on the value of the subscript_type flag, return:
11500 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11501 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11502 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11503 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11506 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11507 SV* keyname, I32 aindex, int subscript_type)
11510 SV * const name = sv_newmortal();
11513 buffer[0] = gvtype;
11516 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11518 gv_fullname4(name, gv, buffer, 0);
11520 if ((unsigned int)SvPVX(name)[1] <= 26) {
11522 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11524 /* Swap the 1 unprintable control character for the 2 byte pretty
11525 version - ie substr($name, 1, 1) = $buffer; */
11526 sv_insert(name, 1, 1, buffer, 2);
11531 CV * const cv = find_runcv(&unused);
11535 if (!cv || !CvPADLIST(cv))
11537 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11538 sv = *av_fetch(av, targ, FALSE);
11539 /* SvLEN in a pad name is not to be trusted */
11540 sv_setpv(name, SvPV_nolen_const(sv));
11543 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11544 SV * const sv = newSV(0);
11545 *SvPVX(name) = '$';
11546 Perl_sv_catpvf(aTHX_ name, "{%s}",
11547 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11550 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11551 *SvPVX(name) = '$';
11552 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11554 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11555 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11562 =for apidoc find_uninit_var
11564 Find the name of the undefined variable (if any) that caused the operator o
11565 to issue a "Use of uninitialized value" warning.
11566 If match is true, only return a name if it's value matches uninit_sv.
11567 So roughly speaking, if a unary operator (such as OP_COS) generates a
11568 warning, then following the direct child of the op may yield an
11569 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11570 other hand, with OP_ADD there are two branches to follow, so we only print
11571 the variable name if we get an exact match.
11573 The name is returned as a mortal SV.
11575 Assumes that PL_op is the op that originally triggered the error, and that
11576 PL_comppad/PL_curpad points to the currently executing pad.
11582 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11590 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11591 uninit_sv == &PL_sv_placeholder)))
11594 switch (obase->op_type) {
11601 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11602 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11605 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11607 if (pad) { /* @lex, %lex */
11608 sv = PAD_SVl(obase->op_targ);
11612 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11613 /* @global, %global */
11614 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11617 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11619 else /* @{expr}, %{expr} */
11620 return find_uninit_var(cUNOPx(obase)->op_first,
11624 /* attempt to find a match within the aggregate */
11626 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11628 subscript_type = FUV_SUBSCRIPT_HASH;
11631 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11633 subscript_type = FUV_SUBSCRIPT_ARRAY;
11636 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11639 return varname(gv, hash ? '%' : '@', obase->op_targ,
11640 keysv, index, subscript_type);
11644 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11646 return varname(NULL, '$', obase->op_targ,
11647 NULL, 0, FUV_SUBSCRIPT_NONE);
11650 gv = cGVOPx_gv(obase);
11651 if (!gv || (match && GvSV(gv) != uninit_sv))
11653 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11656 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11659 av = (AV*)PAD_SV(obase->op_targ);
11660 if (!av || SvRMAGICAL(av))
11662 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11663 if (!svp || *svp != uninit_sv)
11666 return varname(NULL, '$', obase->op_targ,
11667 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11670 gv = cGVOPx_gv(obase);
11676 if (!av || SvRMAGICAL(av))
11678 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11679 if (!svp || *svp != uninit_sv)
11682 return varname(gv, '$', 0,
11683 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11688 o = cUNOPx(obase)->op_first;
11689 if (!o || o->op_type != OP_NULL ||
11690 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11692 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11696 if (PL_op == obase)
11697 /* $a[uninit_expr] or $h{uninit_expr} */
11698 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11701 o = cBINOPx(obase)->op_first;
11702 kid = cBINOPx(obase)->op_last;
11704 /* get the av or hv, and optionally the gv */
11706 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11707 sv = PAD_SV(o->op_targ);
11709 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11710 && cUNOPo->op_first->op_type == OP_GV)
11712 gv = cGVOPx_gv(cUNOPo->op_first);
11715 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11720 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11721 /* index is constant */
11725 if (obase->op_type == OP_HELEM) {
11726 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11727 if (!he || HeVAL(he) != uninit_sv)
11731 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11732 if (!svp || *svp != uninit_sv)
11736 if (obase->op_type == OP_HELEM)
11737 return varname(gv, '%', o->op_targ,
11738 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11740 return varname(gv, '@', o->op_targ, NULL,
11741 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11744 /* index is an expression;
11745 * attempt to find a match within the aggregate */
11746 if (obase->op_type == OP_HELEM) {
11747 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11749 return varname(gv, '%', o->op_targ,
11750 keysv, 0, FUV_SUBSCRIPT_HASH);
11753 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11755 return varname(gv, '@', o->op_targ,
11756 NULL, index, FUV_SUBSCRIPT_ARRAY);
11761 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11763 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11768 /* only examine RHS */
11769 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11772 o = cUNOPx(obase)->op_first;
11773 if (o->op_type == OP_PUSHMARK)
11776 if (!o->op_sibling) {
11777 /* one-arg version of open is highly magical */
11779 if (o->op_type == OP_GV) { /* open FOO; */
11781 if (match && GvSV(gv) != uninit_sv)
11783 return varname(gv, '$', 0,
11784 NULL, 0, FUV_SUBSCRIPT_NONE);
11786 /* other possibilities not handled are:
11787 * open $x; or open my $x; should return '${*$x}'
11788 * open expr; should return '$'.expr ideally
11794 /* ops where $_ may be an implicit arg */
11798 if ( !(obase->op_flags & OPf_STACKED)) {
11799 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11800 ? PAD_SVl(obase->op_targ)
11803 sv = sv_newmortal();
11804 sv_setpvn(sv, "$_", 2);
11812 /* skip filehandle as it can't produce 'undef' warning */
11813 o = cUNOPx(obase)->op_first;
11814 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11815 o = o->op_sibling->op_sibling;
11822 match = 1; /* XS or custom code could trigger random warnings */
11827 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11828 return sv_2mortal(newSVpvs("${$/}"));
11833 if (!(obase->op_flags & OPf_KIDS))
11835 o = cUNOPx(obase)->op_first;
11841 /* if all except one arg are constant, or have no side-effects,
11842 * or are optimized away, then it's unambiguous */
11844 for (kid=o; kid; kid = kid->op_sibling) {
11846 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11847 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11848 || (kid->op_type == OP_PUSHMARK)
11852 if (o2) { /* more than one found */
11859 return find_uninit_var(o2, uninit_sv, match);
11861 /* scan all args */
11863 sv = find_uninit_var(o, uninit_sv, 1);
11875 =for apidoc report_uninit
11877 Print appropriate "Use of uninitialized variable" warning
11883 Perl_report_uninit(pTHX_ SV* uninit_sv)
11887 SV* varname = NULL;
11889 varname = find_uninit_var(PL_op, uninit_sv,0);
11891 sv_insert(varname, 0, 0, " ", 1);
11893 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11894 varname ? SvPV_nolen_const(varname) : "",
11895 " in ", OP_DESC(PL_op));
11898 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11904 * c-indentation-style: bsd
11905 * c-basic-offset: 4
11906 * indent-tabs-mode: t
11909 * ex: set ts=8 sts=4 sw=4 noet: