This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Don't use vars in DynaLoader
[perl5.git] / sv.c
... / ...
CommitLineData
1/* sv.c
2 *
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
5 *
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.
8 *
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
10 *
11 *
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
17 * in the pp*.c files.
18 */
19
20#include "EXTERN.h"
21#define PERL_IN_SV_C
22#include "perl.h"
23#include "regcomp.h"
24
25#define FCALL *f
26
27#ifdef __Lynx__
28/* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
30#endif
31
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
42 * --jhi
43 */
44#define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
46#else
47#define ASSERT_UTF8_CACHE(cache) NOOP
48#endif
49
50#ifdef PERL_COPY_ON_WRITE
51#define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52#define SV_COW_NEXT_SV_SET(current,next) SvUVX(current) = PTR2UV(next)
53/* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 on-write. */
55#endif
56
57/* ============================================================================
58
59=head1 Allocation and deallocation of SVs.
60
61An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62av, hv...) contains type and reference count information, as well as a
63pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64specific to each type.
65
66Normally, this allocation is done using arenas, which are approximately
671K chunks of memory parcelled up into N heads or bodies. The first slot
68in each arena is reserved, and is used to hold a link to the next arena.
69In the case of heads, the unused first slot also contains some flags and
70a note of the number of slots. Snaked through each arena chain is a
71linked list of free items; when this becomes empty, an extra arena is
72allocated and divided up into N items which are threaded into the free
73list.
74
75The following global variables are associated with arenas:
76
77 PL_sv_arenaroot pointer to list of SV arenas
78 PL_sv_root pointer to list of free SV structures
79
80 PL_foo_arenaroot pointer to list of foo arenas,
81 PL_foo_root pointer to list of free foo bodies
82 ... for foo in xiv, xnv, xrv, xpv etc.
83
84Note that some of the larger and more rarely used body types (eg xpvio)
85are not allocated using arenas, but are instead just malloc()/free()ed as
86required. Also, if PURIFY is defined, arenas are abandoned altogether,
87with all items individually malloc()ed. In addition, a few SV heads are
88not allocated from an arena, but are instead directly created as static
89or auto variables, eg PL_sv_undef.
90
91The SV arena serves the secondary purpose of allowing still-live SVs
92to be located and destroyed during final cleanup.
93
94At the lowest level, the macros new_SV() and del_SV() grab and free
95an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96to return the SV to the free list with error checking.) new_SV() calls
97more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98SVs in the free list have their SvTYPE field set to all ones.
99
100Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101that allocate and return individual body types. Normally these are mapped
102to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103instead mapped directly to malloc()/free() if PURIFY is defined. The
104new/del functions remove from, or add to, the appropriate PL_foo_root
105list, and call more_xiv() etc to add a new arena if the list is empty.
106
107At the time of very final cleanup, sv_free_arenas() is called from
108perl_destruct() to physically free all the arenas allocated since the
109start of the interpreter. Note that this also clears PL_he_arenaroot,
110which is otherwise dealt with in hv.c.
111
112Manipulation of any of the PL_*root pointers is protected by enclosing
113LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114if threads are enabled.
115
116The function visit() scans the SV arenas list, and calls a specified
117function for each SV it finds which is still live - ie which has an SvTYPE
118other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119following functions (specified as [function that calls visit()] / [function
120called by visit() for each SV]):
121
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
124
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
131 below.
132
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
142
143=head2 Summary
144
145Private API to rest of sv.c
146
147 new_SV(), del_SV(),
148
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
151 etc
152
153Public API:
154
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
156
157
158=cut
159
160============================================================================ */
161
162
163
164/*
165 * "A time to plant, and a time to uproot what was planted..."
166 */
167
168#define plant_SV(p) \
169 STMT_START { \
170 SvANY(p) = (void *)PL_sv_root; \
171 SvFLAGS(p) = SVTYPEMASK; \
172 PL_sv_root = (p); \
173 --PL_sv_count; \
174 } STMT_END
175
176/* sv_mutex must be held while calling uproot_SV() */
177#define uproot_SV(p) \
178 STMT_START { \
179 (p) = PL_sv_root; \
180 PL_sv_root = (SV*)SvANY(p); \
181 ++PL_sv_count; \
182 } STMT_END
183
184
185/* new_SV(): return a new, empty SV head */
186
187#ifdef DEBUG_LEAKING_SCALARS
188/* provide a real function for a debugger to play with */
189STATIC SV*
190S_new_SV(pTHX)
191{
192 SV* sv;
193
194 LOCK_SV_MUTEX;
195 if (PL_sv_root)
196 uproot_SV(sv);
197 else
198 sv = more_sv();
199 UNLOCK_SV_MUTEX;
200 SvANY(sv) = 0;
201 SvREFCNT(sv) = 1;
202 SvFLAGS(sv) = 0;
203 return sv;
204}
205# define new_SV(p) (p)=S_new_SV(aTHX)
206
207#else
208# define new_SV(p) \
209 STMT_START { \
210 LOCK_SV_MUTEX; \
211 if (PL_sv_root) \
212 uproot_SV(p); \
213 else \
214 (p) = more_sv(); \
215 UNLOCK_SV_MUTEX; \
216 SvANY(p) = 0; \
217 SvREFCNT(p) = 1; \
218 SvFLAGS(p) = 0; \
219 } STMT_END
220#endif
221
222
223/* del_SV(): return an empty SV head to the free list */
224
225#ifdef DEBUGGING
226
227#define del_SV(p) \
228 STMT_START { \
229 LOCK_SV_MUTEX; \
230 if (DEBUG_D_TEST) \
231 del_sv(p); \
232 else \
233 plant_SV(p); \
234 UNLOCK_SV_MUTEX; \
235 } STMT_END
236
237STATIC void
238S_del_sv(pTHX_ SV *p)
239{
240 if (DEBUG_D_TEST) {
241 SV* sva;
242 SV* sv;
243 SV* svend;
244 int ok = 0;
245 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
246 sv = sva + 1;
247 svend = &sva[SvREFCNT(sva)];
248 if (p >= sv && p < svend)
249 ok = 1;
250 }
251 if (!ok) {
252 if (ckWARN_d(WARN_INTERNAL))
253 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
254 "Attempt to free non-arena SV: 0x%"UVxf
255 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
256 return;
257 }
258 }
259 plant_SV(p);
260}
261
262#else /* ! DEBUGGING */
263
264#define del_SV(p) plant_SV(p)
265
266#endif /* DEBUGGING */
267
268
269/*
270=head1 SV Manipulation Functions
271
272=for apidoc sv_add_arena
273
274Given a chunk of memory, link it to the head of the list of arenas,
275and split it into a list of free SVs.
276
277=cut
278*/
279
280void
281Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
282{
283 SV* sva = (SV*)ptr;
284 register SV* sv;
285 register SV* svend;
286
287 /* The first SV in an arena isn't an SV. */
288 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
289 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
290 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
291
292 PL_sv_arenaroot = sva;
293 PL_sv_root = sva + 1;
294
295 svend = &sva[SvREFCNT(sva) - 1];
296 sv = sva + 1;
297 while (sv < svend) {
298 SvANY(sv) = (void *)(SV*)(sv + 1);
299 SvREFCNT(sv) = 0;
300 SvFLAGS(sv) = SVTYPEMASK;
301 sv++;
302 }
303 SvANY(sv) = 0;
304 SvFLAGS(sv) = SVTYPEMASK;
305}
306
307/* make some more SVs by adding another arena */
308
309/* sv_mutex must be held while calling more_sv() */
310STATIC SV*
311S_more_sv(pTHX)
312{
313 register SV* sv;
314
315 if (PL_nice_chunk) {
316 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
317 PL_nice_chunk = Nullch;
318 PL_nice_chunk_size = 0;
319 }
320 else {
321 char *chunk; /* must use New here to match call to */
322 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
323 sv_add_arena(chunk, 1008, 0);
324 }
325 uproot_SV(sv);
326 return sv;
327}
328
329/* visit(): call the named function for each non-free SV in the arenas
330 * whose flags field matches the flags/mask args. */
331
332STATIC I32
333S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
334{
335 SV* sva;
336 SV* sv;
337 register SV* svend;
338 I32 visited = 0;
339
340 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
341 svend = &sva[SvREFCNT(sva)];
342 for (sv = sva + 1; sv < svend; ++sv) {
343 if (SvTYPE(sv) != SVTYPEMASK
344 && (sv->sv_flags & mask) == flags
345 && SvREFCNT(sv))
346 {
347 (FCALL)(aTHX_ sv);
348 ++visited;
349 }
350 }
351 }
352 return visited;
353}
354
355#ifdef DEBUGGING
356
357/* called by sv_report_used() for each live SV */
358
359static void
360do_report_used(pTHX_ SV *sv)
361{
362 if (SvTYPE(sv) != SVTYPEMASK) {
363 PerlIO_printf(Perl_debug_log, "****\n");
364 sv_dump(sv);
365 }
366}
367#endif
368
369/*
370=for apidoc sv_report_used
371
372Dump the contents of all SVs not yet freed. (Debugging aid).
373
374=cut
375*/
376
377void
378Perl_sv_report_used(pTHX)
379{
380#ifdef DEBUGGING
381 visit(do_report_used, 0, 0);
382#endif
383}
384
385/* called by sv_clean_objs() for each live SV */
386
387static void
388do_clean_objs(pTHX_ SV *sv)
389{
390 SV* rv;
391
392 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
393 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
394 if (SvWEAKREF(sv)) {
395 sv_del_backref(sv);
396 SvWEAKREF_off(sv);
397 SvRV(sv) = 0;
398 } else {
399 SvROK_off(sv);
400 SvRV(sv) = 0;
401 SvREFCNT_dec(rv);
402 }
403 }
404
405 /* XXX Might want to check arrays, etc. */
406}
407
408/* called by sv_clean_objs() for each live SV */
409
410#ifndef DISABLE_DESTRUCTOR_KLUDGE
411static void
412do_clean_named_objs(pTHX_ SV *sv)
413{
414 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
415 if ( SvOBJECT(GvSV(sv)) ||
416 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
417 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
418 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
419 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
420 {
421 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
422 SvFLAGS(sv) |= SVf_BREAK;
423 SvREFCNT_dec(sv);
424 }
425 }
426}
427#endif
428
429/*
430=for apidoc sv_clean_objs
431
432Attempt to destroy all objects not yet freed
433
434=cut
435*/
436
437void
438Perl_sv_clean_objs(pTHX)
439{
440 PL_in_clean_objs = TRUE;
441 visit(do_clean_objs, SVf_ROK, SVf_ROK);
442#ifndef DISABLE_DESTRUCTOR_KLUDGE
443 /* some barnacles may yet remain, clinging to typeglobs */
444 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
445#endif
446 PL_in_clean_objs = FALSE;
447}
448
449/* called by sv_clean_all() for each live SV */
450
451static void
452do_clean_all(pTHX_ SV *sv)
453{
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
455 SvFLAGS(sv) |= SVf_BREAK;
456 if (PL_comppad == (AV*)sv) {
457 PL_comppad = Nullav;
458 PL_curpad = Null(SV**);
459 }
460 SvREFCNT_dec(sv);
461}
462
463/*
464=for apidoc sv_clean_all
465
466Decrement the refcnt of each remaining SV, possibly triggering a
467cleanup. This function may have to be called multiple times to free
468SVs which are in complex self-referential hierarchies.
469
470=cut
471*/
472
473I32
474Perl_sv_clean_all(pTHX)
475{
476 I32 cleaned;
477 PL_in_clean_all = TRUE;
478 cleaned = visit(do_clean_all, 0,0);
479 PL_in_clean_all = FALSE;
480 return cleaned;
481}
482
483/*
484=for apidoc sv_free_arenas
485
486Deallocate the memory used by all arenas. Note that all the individual SV
487heads and bodies within the arenas must already have been freed.
488
489=cut
490*/
491
492void
493Perl_sv_free_arenas(pTHX)
494{
495 SV* sva;
496 SV* svanext;
497 XPV *arena, *arenanext;
498
499 /* Free arenas here, but be careful about fake ones. (We assume
500 contiguity of the fake ones with the corresponding real ones.) */
501
502 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
503 svanext = (SV*) SvANY(sva);
504 while (svanext && SvFAKE(svanext))
505 svanext = (SV*) SvANY(svanext);
506
507 if (!SvFAKE(sva))
508 Safefree((void *)sva);
509 }
510
511 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
512 arenanext = (XPV*)arena->xpv_pv;
513 Safefree(arena);
514 }
515 PL_xiv_arenaroot = 0;
516 PL_xiv_root = 0;
517
518 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
519 arenanext = (XPV*)arena->xpv_pv;
520 Safefree(arena);
521 }
522 PL_xnv_arenaroot = 0;
523 PL_xnv_root = 0;
524
525 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
526 arenanext = (XPV*)arena->xpv_pv;
527 Safefree(arena);
528 }
529 PL_xrv_arenaroot = 0;
530 PL_xrv_root = 0;
531
532 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
533 arenanext = (XPV*)arena->xpv_pv;
534 Safefree(arena);
535 }
536 PL_xpv_arenaroot = 0;
537 PL_xpv_root = 0;
538
539 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
540 arenanext = (XPV*)arena->xpv_pv;
541 Safefree(arena);
542 }
543 PL_xpviv_arenaroot = 0;
544 PL_xpviv_root = 0;
545
546 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
547 arenanext = (XPV*)arena->xpv_pv;
548 Safefree(arena);
549 }
550 PL_xpvnv_arenaroot = 0;
551 PL_xpvnv_root = 0;
552
553 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
554 arenanext = (XPV*)arena->xpv_pv;
555 Safefree(arena);
556 }
557 PL_xpvcv_arenaroot = 0;
558 PL_xpvcv_root = 0;
559
560 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
561 arenanext = (XPV*)arena->xpv_pv;
562 Safefree(arena);
563 }
564 PL_xpvav_arenaroot = 0;
565 PL_xpvav_root = 0;
566
567 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
568 arenanext = (XPV*)arena->xpv_pv;
569 Safefree(arena);
570 }
571 PL_xpvhv_arenaroot = 0;
572 PL_xpvhv_root = 0;
573
574 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
575 arenanext = (XPV*)arena->xpv_pv;
576 Safefree(arena);
577 }
578 PL_xpvmg_arenaroot = 0;
579 PL_xpvmg_root = 0;
580
581 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
582 arenanext = (XPV*)arena->xpv_pv;
583 Safefree(arena);
584 }
585 PL_xpvlv_arenaroot = 0;
586 PL_xpvlv_root = 0;
587
588 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
589 arenanext = (XPV*)arena->xpv_pv;
590 Safefree(arena);
591 }
592 PL_xpvbm_arenaroot = 0;
593 PL_xpvbm_root = 0;
594
595 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
596 arenanext = (XPV*)arena->xpv_pv;
597 Safefree(arena);
598 }
599 PL_he_arenaroot = 0;
600 PL_he_root = 0;
601
602 if (PL_nice_chunk)
603 Safefree(PL_nice_chunk);
604 PL_nice_chunk = Nullch;
605 PL_nice_chunk_size = 0;
606 PL_sv_arenaroot = 0;
607 PL_sv_root = 0;
608}
609
610/* ---------------------------------------------------------------------
611 *
612 * support functions for report_uninit()
613 */
614
615/* the maxiumum size of array or hash where we will scan looking
616 * for the undefined element that triggered the warning */
617
618#define FUV_MAX_SEARCH_SIZE 1000
619
620/* Look for an entry in the hash whose value has the same SV as val;
621 * If so, return a mortal copy of the key. */
622
623STATIC SV*
624S_find_hash_subscript(pTHX_ HV *hv, SV* val)
625{
626 register HE **array;
627 register HE *entry;
628 I32 i;
629
630 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
631 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
632 return Nullsv;
633
634 array = HvARRAY(hv);
635
636 for (i=HvMAX(hv); i>0; i--) {
637 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
638 if (HeVAL(entry) != val)
639 continue;
640 if ( HeVAL(entry) == &PL_sv_undef ||
641 HeVAL(entry) == &PL_sv_placeholder)
642 continue;
643 if (!HeKEY(entry))
644 return Nullsv;
645 if (HeKLEN(entry) == HEf_SVKEY)
646 return sv_mortalcopy(HeKEY_sv(entry));
647 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
648 }
649 }
650 return Nullsv;
651}
652
653/* Look for an entry in the array whose value has the same SV as val;
654 * If so, return the index, otherwise return -1. */
655
656STATIC I32
657S_find_array_subscript(pTHX_ AV *av, SV* val)
658{
659 SV** svp;
660 I32 i;
661 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
662 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
663 return -1;
664
665 svp = AvARRAY(av);
666 for (i=AvFILLp(av); i>=0; i--) {
667 if (svp[i] == val && svp[i] != &PL_sv_undef)
668 return i;
669 }
670 return -1;
671}
672
673/* S_varname(): return the name of a variable, optionally with a subscript.
674 * If gv is non-zero, use the name of that global, along with gvtype (one
675 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
676 * targ. Depending on the value of the subscript_type flag, return:
677 */
678
679#define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
680#define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
681#define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
682#define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
683
684STATIC SV*
685S_varname(pTHX_ GV *gv, char *gvtype, PADOFFSET targ,
686 SV* keyname, I32 aindex, int subscript_type)
687{
688 AV *av;
689
690 SV *sv, *name;
691
692 name = sv_newmortal();
693 if (gv) {
694
695 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
696 * XXX get rid of all this if gv_fullnameX() ever supports this
697 * directly */
698
699 char *p;
700 HV *hv = GvSTASH(gv);
701 sv_setpv(name, gvtype);
702 if (!hv)
703 p = "???";
704 else if (!HvNAME(hv))
705 p = "__ANON__";
706 else
707 p = HvNAME(hv);
708 if (strNE(p, "main")) {
709 sv_catpv(name,p);
710 sv_catpvn(name,"::", 2);
711 }
712 if (GvNAMELEN(gv)>= 1 &&
713 ((unsigned int)*GvNAME(gv)) <= 26)
714 { /* handle $^FOO */
715 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
716 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
717 }
718 else
719 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
720 }
721 else {
722 U32 u;
723 CV *cv = find_runcv(&u);
724 if (!cv || !CvPADLIST(cv))
725 return Nullsv;;
726 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
727 sv = *av_fetch(av, targ, FALSE);
728 /* SvLEN in a pad name is not to be trusted */
729 sv_setpv(name, SvPV_nolen(sv));
730 }
731
732 if (subscript_type == FUV_SUBSCRIPT_HASH) {
733 *SvPVX(name) = '$';
734 sv = NEWSV(0,0);
735 Perl_sv_catpvf(aTHX_ name, "{%s}",
736 pv_display(sv,SvPVX(keyname), SvCUR(keyname), 0, 32));
737 SvREFCNT_dec(sv);
738 }
739 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
740 *SvPVX(name) = '$';
741 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
742 }
743 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
744 sv_insert(name, 0, 0, "within ", 7);
745
746 return name;
747}
748
749
750/*
751=for apidoc find_uninit_var
752
753Find the name of the undefined variable (if any) that caused the operator o
754to issue a "Use of uninitialized value" warning.
755If match is true, only return a name if it's value matches uninit_sv.
756So roughly speaking, if a unary operator (such as OP_COS) generates a
757warning, then following the direct child of the op may yield an
758OP_PADSV or OP_GV that gives the name of the undefined variable. On the
759other hand, with OP_ADD there are two branches to follow, so we only print
760the variable name if we get an exact match.
761
762The name is returned as a mortal SV.
763
764Assumes that PL_op is the op that originally triggered the error, and that
765PL_comppad/PL_curpad points to the currently executing pad.
766
767=cut
768*/
769
770STATIC SV *
771S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
772{
773 SV *sv;
774 AV *av;
775 SV **svp;
776 GV *gv;
777 OP *o, *o2, *kid;
778
779 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
780 uninit_sv == &PL_sv_placeholder)))
781 return Nullsv;
782
783 switch (obase->op_type) {
784
785 case OP_RV2AV:
786 case OP_RV2HV:
787 case OP_PADAV:
788 case OP_PADHV:
789 {
790 bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
791 bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
792 I32 index = 0;
793 SV *keysv = Nullsv;
794 int subscript_type = FUV_SUBSCRIPT_WITHIN;
795
796 if (pad) { /* @lex, %lex */
797 sv = PAD_SVl(obase->op_targ);
798 gv = Nullgv;
799 }
800 else {
801 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
802 /* @global, %global */
803 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
804 if (!gv)
805 break;
806 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
807 }
808 else /* @{expr}, %{expr} */
809 return find_uninit_var(cUNOPx(obase)->op_first,
810 uninit_sv, match);
811 }
812
813 /* attempt to find a match within the aggregate */
814 if (hash) {
815 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
816 if (keysv)
817 subscript_type = FUV_SUBSCRIPT_HASH;
818 }
819 else {
820 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
821 if (index >= 0)
822 subscript_type = FUV_SUBSCRIPT_ARRAY;
823 }
824
825 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
826 break;
827
828 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
829 keysv, index, subscript_type);
830 }
831
832 case OP_PADSV:
833 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
834 break;
835 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
836 Nullsv, 0, FUV_SUBSCRIPT_NONE);
837
838 case OP_GVSV:
839 gv = cGVOPx_gv(obase);
840 if (!gv || (match && GvSV(gv) != uninit_sv))
841 break;
842 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
843
844 case OP_AELEMFAST:
845 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
846 if (match) {
847 av = (AV*)PAD_SV(obase->op_targ);
848 if (!av || SvRMAGICAL(av))
849 break;
850 svp = av_fetch(av, (I32)obase->op_private, FALSE);
851 if (!svp || *svp != uninit_sv)
852 break;
853 }
854 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
855 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
856 }
857 else {
858 gv = cGVOPx_gv(obase);
859 if (!gv)
860 break;
861 if (match) {
862 av = GvAV(gv);
863 if (!av || SvRMAGICAL(av))
864 break;
865 svp = av_fetch(av, (I32)obase->op_private, FALSE);
866 if (!svp || *svp != uninit_sv)
867 break;
868 }
869 return S_varname(aTHX_ gv, "$", 0,
870 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
871 }
872 break;
873
874 case OP_EXISTS:
875 o = cUNOPx(obase)->op_first;
876 if (!o || o->op_type != OP_NULL ||
877 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
878 break;
879 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
880
881 case OP_AELEM:
882 case OP_HELEM:
883 if (PL_op == obase)
884 /* $a[uninit_expr] or $h{uninit_expr} */
885 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
886
887 gv = Nullgv;
888 o = cBINOPx(obase)->op_first;
889 kid = cBINOPx(obase)->op_last;
890
891 /* get the av or hv, and optionally the gv */
892 sv = Nullsv;
893 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
894 sv = PAD_SV(o->op_targ);
895 }
896 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
897 && cUNOPo->op_first->op_type == OP_GV)
898 {
899 gv = cGVOPx_gv(cUNOPo->op_first);
900 if (!gv)
901 break;
902 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
903 }
904 if (!sv)
905 break;
906
907 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
908 /* index is constant */
909 if (match) {
910 if (SvMAGICAL(sv))
911 break;
912 if (obase->op_type == OP_HELEM) {
913 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
914 if (!he || HeVAL(he) != uninit_sv)
915 break;
916 }
917 else {
918 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
919 if (!svp || *svp != uninit_sv)
920 break;
921 }
922 }
923 if (obase->op_type == OP_HELEM)
924 return S_varname(aTHX_ gv, "%", o->op_targ,
925 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
926 else
927 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
928 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
929 ;
930 }
931 else {
932 /* index is an expression;
933 * attempt to find a match within the aggregate */
934 if (obase->op_type == OP_HELEM) {
935 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
936 if (keysv)
937 return S_varname(aTHX_ gv, "%", o->op_targ,
938 keysv, 0, FUV_SUBSCRIPT_HASH);
939 }
940 else {
941 I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
942 if (index >= 0)
943 return S_varname(aTHX_ gv, "@", o->op_targ,
944 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
945 }
946 if (match)
947 break;
948 return S_varname(aTHX_ gv,
949 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
950 ? "@" : "%",
951 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
952 }
953
954 break;
955
956 case OP_AASSIGN:
957 /* only examine RHS */
958 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
959
960 case OP_OPEN:
961 o = cUNOPx(obase)->op_first;
962 if (o->op_type == OP_PUSHMARK)
963 o = o->op_sibling;
964
965 if (!o->op_sibling) {
966 /* one-arg version of open is highly magical */
967
968 if (o->op_type == OP_GV) { /* open FOO; */
969 gv = cGVOPx_gv(o);
970 if (match && GvSV(gv) != uninit_sv)
971 break;
972 return S_varname(aTHX_ gv, "$", 0,
973 Nullsv, 0, FUV_SUBSCRIPT_NONE);
974 }
975 /* other possibilities not handled are:
976 * open $x; or open my $x; should return '${*$x}'
977 * open expr; should return '$'.expr ideally
978 */
979 break;
980 }
981 goto do_op;
982
983 /* ops where $_ may be an implicit arg */
984 case OP_TRANS:
985 case OP_SUBST:
986 case OP_MATCH:
987 if ( !(obase->op_flags & OPf_STACKED)) {
988 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
989 ? PAD_SVl(obase->op_targ)
990 : DEFSV))
991 {
992 sv = sv_newmortal();
993 sv_setpv(sv, "$_");
994 return sv;
995 }
996 }
997 goto do_op;
998
999 case OP_PRTF:
1000 case OP_PRINT:
1001 /* skip filehandle as it can't produce 'undef' warning */
1002 o = cUNOPx(obase)->op_first;
1003 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1004 o = o->op_sibling->op_sibling;
1005 goto do_op2;
1006
1007
1008 case OP_RV2SV:
1009 case OP_CUSTOM:
1010 case OP_ENTERSUB:
1011 match = 1; /* XS or custom code could trigger random warnings */
1012 goto do_op;
1013
1014 case OP_SCHOMP:
1015 case OP_CHOMP:
1016 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1017 return sv_2mortal(newSVpv("${$/}", 0));
1018 /* FALL THROUGH */
1019
1020 default:
1021 do_op:
1022 if (!(obase->op_flags & OPf_KIDS))
1023 break;
1024 o = cUNOPx(obase)->op_first;
1025
1026 do_op2:
1027 if (!o)
1028 break;
1029
1030 /* if all except one arg are constant, or have no side-effects,
1031 * or are optimized away, then it's unambiguous */
1032 o2 = Nullop;
1033 for (kid=o; kid; kid = kid->op_sibling) {
1034 if (kid &&
1035 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1036 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1037 || (kid->op_type == OP_PUSHMARK)
1038 )
1039 )
1040 continue;
1041 if (o2) { /* more than one found */
1042 o2 = Nullop;
1043 break;
1044 }
1045 o2 = kid;
1046 }
1047 if (o2)
1048 return find_uninit_var(o2, uninit_sv, match);
1049
1050 /* scan all args */
1051 while (o) {
1052 sv = find_uninit_var(o, uninit_sv, 1);
1053 if (sv)
1054 return sv;
1055 o = o->op_sibling;
1056 }
1057 break;
1058 }
1059 return Nullsv;
1060}
1061
1062
1063/*
1064=for apidoc report_uninit
1065
1066Print appropriate "Use of uninitialized variable" warning
1067
1068=cut
1069*/
1070
1071void
1072Perl_report_uninit(pTHX_ SV* uninit_sv)
1073{
1074 if (PL_op) {
1075 SV* varname = Nullsv;
1076 if (uninit_sv) {
1077 varname = find_uninit_var(PL_op, uninit_sv,0);
1078 if (varname)
1079 sv_insert(varname, 0, 0, " ", 1);
1080 }
1081 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1082 varname ? SvPV_nolen(varname) : "",
1083 " in ", OP_DESC(PL_op));
1084 }
1085 else
1086 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1087 "", "", "");
1088}
1089
1090/* grab a new IV body from the free list, allocating more if necessary */
1091
1092STATIC XPVIV*
1093S_new_xiv(pTHX)
1094{
1095 IV* xiv;
1096 LOCK_SV_MUTEX;
1097 if (!PL_xiv_root)
1098 more_xiv();
1099 xiv = PL_xiv_root;
1100 /*
1101 * See comment in more_xiv() -- RAM.
1102 */
1103 PL_xiv_root = *(IV**)xiv;
1104 UNLOCK_SV_MUTEX;
1105 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
1106}
1107
1108/* return an IV body to the free list */
1109
1110STATIC void
1111S_del_xiv(pTHX_ XPVIV *p)
1112{
1113 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
1114 LOCK_SV_MUTEX;
1115 *(IV**)xiv = PL_xiv_root;
1116 PL_xiv_root = xiv;
1117 UNLOCK_SV_MUTEX;
1118}
1119
1120/* allocate another arena's worth of IV bodies */
1121
1122STATIC void
1123S_more_xiv(pTHX)
1124{
1125 register IV* xiv;
1126 register IV* xivend;
1127 XPV* ptr;
1128 New(705, ptr, 1008/sizeof(XPV), XPV);
1129 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
1130 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
1131
1132 xiv = (IV*) ptr;
1133 xivend = &xiv[1008 / sizeof(IV) - 1];
1134 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
1135 PL_xiv_root = xiv;
1136 while (xiv < xivend) {
1137 *(IV**)xiv = (IV *)(xiv + 1);
1138 xiv++;
1139 }
1140 *(IV**)xiv = 0;
1141}
1142
1143/* grab a new NV body from the free list, allocating more if necessary */
1144
1145STATIC XPVNV*
1146S_new_xnv(pTHX)
1147{
1148 NV* xnv;
1149 LOCK_SV_MUTEX;
1150 if (!PL_xnv_root)
1151 more_xnv();
1152 xnv = PL_xnv_root;
1153 PL_xnv_root = *(NV**)xnv;
1154 UNLOCK_SV_MUTEX;
1155 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1156}
1157
1158/* return an NV body to the free list */
1159
1160STATIC void
1161S_del_xnv(pTHX_ XPVNV *p)
1162{
1163 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1164 LOCK_SV_MUTEX;
1165 *(NV**)xnv = PL_xnv_root;
1166 PL_xnv_root = xnv;
1167 UNLOCK_SV_MUTEX;
1168}
1169
1170/* allocate another arena's worth of NV bodies */
1171
1172STATIC void
1173S_more_xnv(pTHX)
1174{
1175 register NV* xnv;
1176 register NV* xnvend;
1177 XPV *ptr;
1178 New(711, ptr, 1008/sizeof(XPV), XPV);
1179 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
1180 PL_xnv_arenaroot = ptr;
1181
1182 xnv = (NV*) ptr;
1183 xnvend = &xnv[1008 / sizeof(NV) - 1];
1184 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
1185 PL_xnv_root = xnv;
1186 while (xnv < xnvend) {
1187 *(NV**)xnv = (NV*)(xnv + 1);
1188 xnv++;
1189 }
1190 *(NV**)xnv = 0;
1191}
1192
1193/* grab a new struct xrv from the free list, allocating more if necessary */
1194
1195STATIC XRV*
1196S_new_xrv(pTHX)
1197{
1198 XRV* xrv;
1199 LOCK_SV_MUTEX;
1200 if (!PL_xrv_root)
1201 more_xrv();
1202 xrv = PL_xrv_root;
1203 PL_xrv_root = (XRV*)xrv->xrv_rv;
1204 UNLOCK_SV_MUTEX;
1205 return xrv;
1206}
1207
1208/* return a struct xrv to the free list */
1209
1210STATIC void
1211S_del_xrv(pTHX_ XRV *p)
1212{
1213 LOCK_SV_MUTEX;
1214 p->xrv_rv = (SV*)PL_xrv_root;
1215 PL_xrv_root = p;
1216 UNLOCK_SV_MUTEX;
1217}
1218
1219/* allocate another arena's worth of struct xrv */
1220
1221STATIC void
1222S_more_xrv(pTHX)
1223{
1224 register XRV* xrv;
1225 register XRV* xrvend;
1226 XPV *ptr;
1227 New(712, ptr, 1008/sizeof(XPV), XPV);
1228 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
1229 PL_xrv_arenaroot = ptr;
1230
1231 xrv = (XRV*) ptr;
1232 xrvend = &xrv[1008 / sizeof(XRV) - 1];
1233 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
1234 PL_xrv_root = xrv;
1235 while (xrv < xrvend) {
1236 xrv->xrv_rv = (SV*)(xrv + 1);
1237 xrv++;
1238 }
1239 xrv->xrv_rv = 0;
1240}
1241
1242/* grab a new struct xpv from the free list, allocating more if necessary */
1243
1244STATIC XPV*
1245S_new_xpv(pTHX)
1246{
1247 XPV* xpv;
1248 LOCK_SV_MUTEX;
1249 if (!PL_xpv_root)
1250 more_xpv();
1251 xpv = PL_xpv_root;
1252 PL_xpv_root = (XPV*)xpv->xpv_pv;
1253 UNLOCK_SV_MUTEX;
1254 return xpv;
1255}
1256
1257/* return a struct xpv to the free list */
1258
1259STATIC void
1260S_del_xpv(pTHX_ XPV *p)
1261{
1262 LOCK_SV_MUTEX;
1263 p->xpv_pv = (char*)PL_xpv_root;
1264 PL_xpv_root = p;
1265 UNLOCK_SV_MUTEX;
1266}
1267
1268/* allocate another arena's worth of struct xpv */
1269
1270STATIC void
1271S_more_xpv(pTHX)
1272{
1273 register XPV* xpv;
1274 register XPV* xpvend;
1275 New(713, xpv, 1008/sizeof(XPV), XPV);
1276 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
1277 PL_xpv_arenaroot = xpv;
1278
1279 xpvend = &xpv[1008 / sizeof(XPV) - 1];
1280 PL_xpv_root = ++xpv;
1281 while (xpv < xpvend) {
1282 xpv->xpv_pv = (char*)(xpv + 1);
1283 xpv++;
1284 }
1285 xpv->xpv_pv = 0;
1286}
1287
1288/* grab a new struct xpviv from the free list, allocating more if necessary */
1289
1290STATIC XPVIV*
1291S_new_xpviv(pTHX)
1292{
1293 XPVIV* xpviv;
1294 LOCK_SV_MUTEX;
1295 if (!PL_xpviv_root)
1296 more_xpviv();
1297 xpviv = PL_xpviv_root;
1298 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
1299 UNLOCK_SV_MUTEX;
1300 return xpviv;
1301}
1302
1303/* return a struct xpviv to the free list */
1304
1305STATIC void
1306S_del_xpviv(pTHX_ XPVIV *p)
1307{
1308 LOCK_SV_MUTEX;
1309 p->xpv_pv = (char*)PL_xpviv_root;
1310 PL_xpviv_root = p;
1311 UNLOCK_SV_MUTEX;
1312}
1313
1314/* allocate another arena's worth of struct xpviv */
1315
1316STATIC void
1317S_more_xpviv(pTHX)
1318{
1319 register XPVIV* xpviv;
1320 register XPVIV* xpvivend;
1321 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
1322 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
1323 PL_xpviv_arenaroot = xpviv;
1324
1325 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
1326 PL_xpviv_root = ++xpviv;
1327 while (xpviv < xpvivend) {
1328 xpviv->xpv_pv = (char*)(xpviv + 1);
1329 xpviv++;
1330 }
1331 xpviv->xpv_pv = 0;
1332}
1333
1334/* grab a new struct xpvnv from the free list, allocating more if necessary */
1335
1336STATIC XPVNV*
1337S_new_xpvnv(pTHX)
1338{
1339 XPVNV* xpvnv;
1340 LOCK_SV_MUTEX;
1341 if (!PL_xpvnv_root)
1342 more_xpvnv();
1343 xpvnv = PL_xpvnv_root;
1344 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
1345 UNLOCK_SV_MUTEX;
1346 return xpvnv;
1347}
1348
1349/* return a struct xpvnv to the free list */
1350
1351STATIC void
1352S_del_xpvnv(pTHX_ XPVNV *p)
1353{
1354 LOCK_SV_MUTEX;
1355 p->xpv_pv = (char*)PL_xpvnv_root;
1356 PL_xpvnv_root = p;
1357 UNLOCK_SV_MUTEX;
1358}
1359
1360/* allocate another arena's worth of struct xpvnv */
1361
1362STATIC void
1363S_more_xpvnv(pTHX)
1364{
1365 register XPVNV* xpvnv;
1366 register XPVNV* xpvnvend;
1367 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
1368 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
1369 PL_xpvnv_arenaroot = xpvnv;
1370
1371 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
1372 PL_xpvnv_root = ++xpvnv;
1373 while (xpvnv < xpvnvend) {
1374 xpvnv->xpv_pv = (char*)(xpvnv + 1);
1375 xpvnv++;
1376 }
1377 xpvnv->xpv_pv = 0;
1378}
1379
1380/* grab a new struct xpvcv from the free list, allocating more if necessary */
1381
1382STATIC XPVCV*
1383S_new_xpvcv(pTHX)
1384{
1385 XPVCV* xpvcv;
1386 LOCK_SV_MUTEX;
1387 if (!PL_xpvcv_root)
1388 more_xpvcv();
1389 xpvcv = PL_xpvcv_root;
1390 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
1391 UNLOCK_SV_MUTEX;
1392 return xpvcv;
1393}
1394
1395/* return a struct xpvcv to the free list */
1396
1397STATIC void
1398S_del_xpvcv(pTHX_ XPVCV *p)
1399{
1400 LOCK_SV_MUTEX;
1401 p->xpv_pv = (char*)PL_xpvcv_root;
1402 PL_xpvcv_root = p;
1403 UNLOCK_SV_MUTEX;
1404}
1405
1406/* allocate another arena's worth of struct xpvcv */
1407
1408STATIC void
1409S_more_xpvcv(pTHX)
1410{
1411 register XPVCV* xpvcv;
1412 register XPVCV* xpvcvend;
1413 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
1414 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
1415 PL_xpvcv_arenaroot = xpvcv;
1416
1417 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
1418 PL_xpvcv_root = ++xpvcv;
1419 while (xpvcv < xpvcvend) {
1420 xpvcv->xpv_pv = (char*)(xpvcv + 1);
1421 xpvcv++;
1422 }
1423 xpvcv->xpv_pv = 0;
1424}
1425
1426/* grab a new struct xpvav from the free list, allocating more if necessary */
1427
1428STATIC XPVAV*
1429S_new_xpvav(pTHX)
1430{
1431 XPVAV* xpvav;
1432 LOCK_SV_MUTEX;
1433 if (!PL_xpvav_root)
1434 more_xpvav();
1435 xpvav = PL_xpvav_root;
1436 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
1437 UNLOCK_SV_MUTEX;
1438 return xpvav;
1439}
1440
1441/* return a struct xpvav to the free list */
1442
1443STATIC void
1444S_del_xpvav(pTHX_ XPVAV *p)
1445{
1446 LOCK_SV_MUTEX;
1447 p->xav_array = (char*)PL_xpvav_root;
1448 PL_xpvav_root = p;
1449 UNLOCK_SV_MUTEX;
1450}
1451
1452/* allocate another arena's worth of struct xpvav */
1453
1454STATIC void
1455S_more_xpvav(pTHX)
1456{
1457 register XPVAV* xpvav;
1458 register XPVAV* xpvavend;
1459 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
1460 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
1461 PL_xpvav_arenaroot = xpvav;
1462
1463 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
1464 PL_xpvav_root = ++xpvav;
1465 while (xpvav < xpvavend) {
1466 xpvav->xav_array = (char*)(xpvav + 1);
1467 xpvav++;
1468 }
1469 xpvav->xav_array = 0;
1470}
1471
1472/* grab a new struct xpvhv from the free list, allocating more if necessary */
1473
1474STATIC XPVHV*
1475S_new_xpvhv(pTHX)
1476{
1477 XPVHV* xpvhv;
1478 LOCK_SV_MUTEX;
1479 if (!PL_xpvhv_root)
1480 more_xpvhv();
1481 xpvhv = PL_xpvhv_root;
1482 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
1483 UNLOCK_SV_MUTEX;
1484 return xpvhv;
1485}
1486
1487/* return a struct xpvhv to the free list */
1488
1489STATIC void
1490S_del_xpvhv(pTHX_ XPVHV *p)
1491{
1492 LOCK_SV_MUTEX;
1493 p->xhv_array = (char*)PL_xpvhv_root;
1494 PL_xpvhv_root = p;
1495 UNLOCK_SV_MUTEX;
1496}
1497
1498/* allocate another arena's worth of struct xpvhv */
1499
1500STATIC void
1501S_more_xpvhv(pTHX)
1502{
1503 register XPVHV* xpvhv;
1504 register XPVHV* xpvhvend;
1505 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
1506 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1507 PL_xpvhv_arenaroot = xpvhv;
1508
1509 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
1510 PL_xpvhv_root = ++xpvhv;
1511 while (xpvhv < xpvhvend) {
1512 xpvhv->xhv_array = (char*)(xpvhv + 1);
1513 xpvhv++;
1514 }
1515 xpvhv->xhv_array = 0;
1516}
1517
1518/* grab a new struct xpvmg from the free list, allocating more if necessary */
1519
1520STATIC XPVMG*
1521S_new_xpvmg(pTHX)
1522{
1523 XPVMG* xpvmg;
1524 LOCK_SV_MUTEX;
1525 if (!PL_xpvmg_root)
1526 more_xpvmg();
1527 xpvmg = PL_xpvmg_root;
1528 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1529 UNLOCK_SV_MUTEX;
1530 return xpvmg;
1531}
1532
1533/* return a struct xpvmg to the free list */
1534
1535STATIC void
1536S_del_xpvmg(pTHX_ XPVMG *p)
1537{
1538 LOCK_SV_MUTEX;
1539 p->xpv_pv = (char*)PL_xpvmg_root;
1540 PL_xpvmg_root = p;
1541 UNLOCK_SV_MUTEX;
1542}
1543
1544/* allocate another arena's worth of struct xpvmg */
1545
1546STATIC void
1547S_more_xpvmg(pTHX)
1548{
1549 register XPVMG* xpvmg;
1550 register XPVMG* xpvmgend;
1551 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1552 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1553 PL_xpvmg_arenaroot = xpvmg;
1554
1555 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1556 PL_xpvmg_root = ++xpvmg;
1557 while (xpvmg < xpvmgend) {
1558 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1559 xpvmg++;
1560 }
1561 xpvmg->xpv_pv = 0;
1562}
1563
1564/* grab a new struct xpvlv from the free list, allocating more if necessary */
1565
1566STATIC XPVLV*
1567S_new_xpvlv(pTHX)
1568{
1569 XPVLV* xpvlv;
1570 LOCK_SV_MUTEX;
1571 if (!PL_xpvlv_root)
1572 more_xpvlv();
1573 xpvlv = PL_xpvlv_root;
1574 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1575 UNLOCK_SV_MUTEX;
1576 return xpvlv;
1577}
1578
1579/* return a struct xpvlv to the free list */
1580
1581STATIC void
1582S_del_xpvlv(pTHX_ XPVLV *p)
1583{
1584 LOCK_SV_MUTEX;
1585 p->xpv_pv = (char*)PL_xpvlv_root;
1586 PL_xpvlv_root = p;
1587 UNLOCK_SV_MUTEX;
1588}
1589
1590/* allocate another arena's worth of struct xpvlv */
1591
1592STATIC void
1593S_more_xpvlv(pTHX)
1594{
1595 register XPVLV* xpvlv;
1596 register XPVLV* xpvlvend;
1597 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1598 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1599 PL_xpvlv_arenaroot = xpvlv;
1600
1601 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1602 PL_xpvlv_root = ++xpvlv;
1603 while (xpvlv < xpvlvend) {
1604 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1605 xpvlv++;
1606 }
1607 xpvlv->xpv_pv = 0;
1608}
1609
1610/* grab a new struct xpvbm from the free list, allocating more if necessary */
1611
1612STATIC XPVBM*
1613S_new_xpvbm(pTHX)
1614{
1615 XPVBM* xpvbm;
1616 LOCK_SV_MUTEX;
1617 if (!PL_xpvbm_root)
1618 more_xpvbm();
1619 xpvbm = PL_xpvbm_root;
1620 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1621 UNLOCK_SV_MUTEX;
1622 return xpvbm;
1623}
1624
1625/* return a struct xpvbm to the free list */
1626
1627STATIC void
1628S_del_xpvbm(pTHX_ XPVBM *p)
1629{
1630 LOCK_SV_MUTEX;
1631 p->xpv_pv = (char*)PL_xpvbm_root;
1632 PL_xpvbm_root = p;
1633 UNLOCK_SV_MUTEX;
1634}
1635
1636/* allocate another arena's worth of struct xpvbm */
1637
1638STATIC void
1639S_more_xpvbm(pTHX)
1640{
1641 register XPVBM* xpvbm;
1642 register XPVBM* xpvbmend;
1643 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1644 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1645 PL_xpvbm_arenaroot = xpvbm;
1646
1647 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1648 PL_xpvbm_root = ++xpvbm;
1649 while (xpvbm < xpvbmend) {
1650 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1651 xpvbm++;
1652 }
1653 xpvbm->xpv_pv = 0;
1654}
1655
1656#define my_safemalloc(s) (void*)safemalloc(s)
1657#define my_safefree(p) safefree((char*)p)
1658
1659#ifdef PURIFY
1660
1661#define new_XIV() my_safemalloc(sizeof(XPVIV))
1662#define del_XIV(p) my_safefree(p)
1663
1664#define new_XNV() my_safemalloc(sizeof(XPVNV))
1665#define del_XNV(p) my_safefree(p)
1666
1667#define new_XRV() my_safemalloc(sizeof(XRV))
1668#define del_XRV(p) my_safefree(p)
1669
1670#define new_XPV() my_safemalloc(sizeof(XPV))
1671#define del_XPV(p) my_safefree(p)
1672
1673#define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1674#define del_XPVIV(p) my_safefree(p)
1675
1676#define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1677#define del_XPVNV(p) my_safefree(p)
1678
1679#define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1680#define del_XPVCV(p) my_safefree(p)
1681
1682#define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1683#define del_XPVAV(p) my_safefree(p)
1684
1685#define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1686#define del_XPVHV(p) my_safefree(p)
1687
1688#define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1689#define del_XPVMG(p) my_safefree(p)
1690
1691#define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1692#define del_XPVLV(p) my_safefree(p)
1693
1694#define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1695#define del_XPVBM(p) my_safefree(p)
1696
1697#else /* !PURIFY */
1698
1699#define new_XIV() (void*)new_xiv()
1700#define del_XIV(p) del_xiv((XPVIV*) p)
1701
1702#define new_XNV() (void*)new_xnv()
1703#define del_XNV(p) del_xnv((XPVNV*) p)
1704
1705#define new_XRV() (void*)new_xrv()
1706#define del_XRV(p) del_xrv((XRV*) p)
1707
1708#define new_XPV() (void*)new_xpv()
1709#define del_XPV(p) del_xpv((XPV *)p)
1710
1711#define new_XPVIV() (void*)new_xpviv()
1712#define del_XPVIV(p) del_xpviv((XPVIV *)p)
1713
1714#define new_XPVNV() (void*)new_xpvnv()
1715#define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1716
1717#define new_XPVCV() (void*)new_xpvcv()
1718#define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1719
1720#define new_XPVAV() (void*)new_xpvav()
1721#define del_XPVAV(p) del_xpvav((XPVAV *)p)
1722
1723#define new_XPVHV() (void*)new_xpvhv()
1724#define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1725
1726#define new_XPVMG() (void*)new_xpvmg()
1727#define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1728
1729#define new_XPVLV() (void*)new_xpvlv()
1730#define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1731
1732#define new_XPVBM() (void*)new_xpvbm()
1733#define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1734
1735#endif /* PURIFY */
1736
1737#define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1738#define del_XPVGV(p) my_safefree(p)
1739
1740#define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1741#define del_XPVFM(p) my_safefree(p)
1742
1743#define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1744#define del_XPVIO(p) my_safefree(p)
1745
1746/*
1747=for apidoc sv_upgrade
1748
1749Upgrade an SV to a more complex form. Generally adds a new body type to the
1750SV, then copies across as much information as possible from the old body.
1751You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1752
1753=cut
1754*/
1755
1756bool
1757Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1758{
1759
1760 char* pv = NULL;
1761 U32 cur = 0;
1762 U32 len = 0;
1763 IV iv = 0;
1764 NV nv = 0.0;
1765 MAGIC* magic = NULL;
1766 HV* stash = Nullhv;
1767
1768 if (mt != SVt_PV && SvIsCOW(sv)) {
1769 sv_force_normal_flags(sv, 0);
1770 }
1771
1772 if (SvTYPE(sv) == mt)
1773 return TRUE;
1774
1775 if (mt < SVt_PVIV)
1776 (void)SvOOK_off(sv);
1777
1778 switch (SvTYPE(sv)) {
1779 case SVt_NULL:
1780 pv = 0;
1781 cur = 0;
1782 len = 0;
1783 iv = 0;
1784 nv = 0.0;
1785 magic = 0;
1786 stash = 0;
1787 break;
1788 case SVt_IV:
1789 pv = 0;
1790 cur = 0;
1791 len = 0;
1792 iv = SvIVX(sv);
1793 nv = (NV)SvIVX(sv);
1794 del_XIV(SvANY(sv));
1795 magic = 0;
1796 stash = 0;
1797 if (mt == SVt_NV)
1798 mt = SVt_PVNV;
1799 else if (mt < SVt_PVIV)
1800 mt = SVt_PVIV;
1801 break;
1802 case SVt_NV:
1803 pv = 0;
1804 cur = 0;
1805 len = 0;
1806 nv = SvNVX(sv);
1807 iv = I_V(nv);
1808 magic = 0;
1809 stash = 0;
1810 del_XNV(SvANY(sv));
1811 SvANY(sv) = 0;
1812 if (mt < SVt_PVNV)
1813 mt = SVt_PVNV;
1814 break;
1815 case SVt_RV:
1816 pv = (char*)SvRV(sv);
1817 cur = 0;
1818 len = 0;
1819 iv = PTR2IV(pv);
1820 nv = PTR2NV(pv);
1821 del_XRV(SvANY(sv));
1822 magic = 0;
1823 stash = 0;
1824 break;
1825 case SVt_PV:
1826 pv = SvPVX(sv);
1827 cur = SvCUR(sv);
1828 len = SvLEN(sv);
1829 iv = 0;
1830 nv = 0.0;
1831 magic = 0;
1832 stash = 0;
1833 del_XPV(SvANY(sv));
1834 if (mt <= SVt_IV)
1835 mt = SVt_PVIV;
1836 else if (mt == SVt_NV)
1837 mt = SVt_PVNV;
1838 break;
1839 case SVt_PVIV:
1840 pv = SvPVX(sv);
1841 cur = SvCUR(sv);
1842 len = SvLEN(sv);
1843 iv = SvIVX(sv);
1844 nv = 0.0;
1845 magic = 0;
1846 stash = 0;
1847 del_XPVIV(SvANY(sv));
1848 break;
1849 case SVt_PVNV:
1850 pv = SvPVX(sv);
1851 cur = SvCUR(sv);
1852 len = SvLEN(sv);
1853 iv = SvIVX(sv);
1854 nv = SvNVX(sv);
1855 magic = 0;
1856 stash = 0;
1857 del_XPVNV(SvANY(sv));
1858 break;
1859 case SVt_PVMG:
1860 pv = SvPVX(sv);
1861 cur = SvCUR(sv);
1862 len = SvLEN(sv);
1863 iv = SvIVX(sv);
1864 nv = SvNVX(sv);
1865 magic = SvMAGIC(sv);
1866 stash = SvSTASH(sv);
1867 del_XPVMG(SvANY(sv));
1868 break;
1869 default:
1870 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1871 }
1872
1873 SvFLAGS(sv) &= ~SVTYPEMASK;
1874 SvFLAGS(sv) |= mt;
1875
1876 switch (mt) {
1877 case SVt_NULL:
1878 Perl_croak(aTHX_ "Can't upgrade to undef");
1879 case SVt_IV:
1880 SvANY(sv) = new_XIV();
1881 SvIVX(sv) = iv;
1882 break;
1883 case SVt_NV:
1884 SvANY(sv) = new_XNV();
1885 SvNVX(sv) = nv;
1886 break;
1887 case SVt_RV:
1888 SvANY(sv) = new_XRV();
1889 SvRV(sv) = (SV*)pv;
1890 break;
1891 case SVt_PV:
1892 SvANY(sv) = new_XPV();
1893 SvPVX(sv) = pv;
1894 SvCUR(sv) = cur;
1895 SvLEN(sv) = len;
1896 break;
1897 case SVt_PVIV:
1898 SvANY(sv) = new_XPVIV();
1899 SvPVX(sv) = pv;
1900 SvCUR(sv) = cur;
1901 SvLEN(sv) = len;
1902 SvIVX(sv) = iv;
1903 if (SvNIOK(sv))
1904 (void)SvIOK_on(sv);
1905 SvNOK_off(sv);
1906 break;
1907 case SVt_PVNV:
1908 SvANY(sv) = new_XPVNV();
1909 SvPVX(sv) = pv;
1910 SvCUR(sv) = cur;
1911 SvLEN(sv) = len;
1912 SvIVX(sv) = iv;
1913 SvNVX(sv) = nv;
1914 break;
1915 case SVt_PVMG:
1916 SvANY(sv) = new_XPVMG();
1917 SvPVX(sv) = pv;
1918 SvCUR(sv) = cur;
1919 SvLEN(sv) = len;
1920 SvIVX(sv) = iv;
1921 SvNVX(sv) = nv;
1922 SvMAGIC(sv) = magic;
1923 SvSTASH(sv) = stash;
1924 break;
1925 case SVt_PVLV:
1926 SvANY(sv) = new_XPVLV();
1927 SvPVX(sv) = pv;
1928 SvCUR(sv) = cur;
1929 SvLEN(sv) = len;
1930 SvIVX(sv) = iv;
1931 SvNVX(sv) = nv;
1932 SvMAGIC(sv) = magic;
1933 SvSTASH(sv) = stash;
1934 LvTARGOFF(sv) = 0;
1935 LvTARGLEN(sv) = 0;
1936 LvTARG(sv) = 0;
1937 LvTYPE(sv) = 0;
1938 GvGP(sv) = 0;
1939 GvNAME(sv) = 0;
1940 GvNAMELEN(sv) = 0;
1941 GvSTASH(sv) = 0;
1942 GvFLAGS(sv) = 0;
1943 break;
1944 case SVt_PVAV:
1945 SvANY(sv) = new_XPVAV();
1946 if (pv)
1947 Safefree(pv);
1948 SvPVX(sv) = 0;
1949 AvMAX(sv) = -1;
1950 AvFILLp(sv) = -1;
1951 SvIVX(sv) = 0;
1952 SvNVX(sv) = 0.0;
1953 SvMAGIC(sv) = magic;
1954 SvSTASH(sv) = stash;
1955 AvALLOC(sv) = 0;
1956 AvARYLEN(sv) = 0;
1957 AvFLAGS(sv) = AVf_REAL;
1958 break;
1959 case SVt_PVHV:
1960 SvANY(sv) = new_XPVHV();
1961 if (pv)
1962 Safefree(pv);
1963 SvPVX(sv) = 0;
1964 HvFILL(sv) = 0;
1965 HvMAX(sv) = 0;
1966 HvTOTALKEYS(sv) = 0;
1967 HvPLACEHOLDERS(sv) = 0;
1968 SvMAGIC(sv) = magic;
1969 SvSTASH(sv) = stash;
1970 HvRITER(sv) = 0;
1971 HvEITER(sv) = 0;
1972 HvPMROOT(sv) = 0;
1973 HvNAME(sv) = 0;
1974 break;
1975 case SVt_PVCV:
1976 SvANY(sv) = new_XPVCV();
1977 Zero(SvANY(sv), 1, XPVCV);
1978 SvPVX(sv) = pv;
1979 SvCUR(sv) = cur;
1980 SvLEN(sv) = len;
1981 SvIVX(sv) = iv;
1982 SvNVX(sv) = nv;
1983 SvMAGIC(sv) = magic;
1984 SvSTASH(sv) = stash;
1985 break;
1986 case SVt_PVGV:
1987 SvANY(sv) = new_XPVGV();
1988 SvPVX(sv) = pv;
1989 SvCUR(sv) = cur;
1990 SvLEN(sv) = len;
1991 SvIVX(sv) = iv;
1992 SvNVX(sv) = nv;
1993 SvMAGIC(sv) = magic;
1994 SvSTASH(sv) = stash;
1995 GvGP(sv) = 0;
1996 GvNAME(sv) = 0;
1997 GvNAMELEN(sv) = 0;
1998 GvSTASH(sv) = 0;
1999 GvFLAGS(sv) = 0;
2000 break;
2001 case SVt_PVBM:
2002 SvANY(sv) = new_XPVBM();
2003 SvPVX(sv) = pv;
2004 SvCUR(sv) = cur;
2005 SvLEN(sv) = len;
2006 SvIVX(sv) = iv;
2007 SvNVX(sv) = nv;
2008 SvMAGIC(sv) = magic;
2009 SvSTASH(sv) = stash;
2010 BmRARE(sv) = 0;
2011 BmUSEFUL(sv) = 0;
2012 BmPREVIOUS(sv) = 0;
2013 break;
2014 case SVt_PVFM:
2015 SvANY(sv) = new_XPVFM();
2016 Zero(SvANY(sv), 1, XPVFM);
2017 SvPVX(sv) = pv;
2018 SvCUR(sv) = cur;
2019 SvLEN(sv) = len;
2020 SvIVX(sv) = iv;
2021 SvNVX(sv) = nv;
2022 SvMAGIC(sv) = magic;
2023 SvSTASH(sv) = stash;
2024 break;
2025 case SVt_PVIO:
2026 SvANY(sv) = new_XPVIO();
2027 Zero(SvANY(sv), 1, XPVIO);
2028 SvPVX(sv) = pv;
2029 SvCUR(sv) = cur;
2030 SvLEN(sv) = len;
2031 SvIVX(sv) = iv;
2032 SvNVX(sv) = nv;
2033 SvMAGIC(sv) = magic;
2034 SvSTASH(sv) = stash;
2035 IoPAGE_LEN(sv) = 60;
2036 break;
2037 }
2038 return TRUE;
2039}
2040
2041/*
2042=for apidoc sv_backoff
2043
2044Remove any string offset. You should normally use the C<SvOOK_off> macro
2045wrapper instead.
2046
2047=cut
2048*/
2049
2050int
2051Perl_sv_backoff(pTHX_ register SV *sv)
2052{
2053 assert(SvOOK(sv));
2054 if (SvIVX(sv)) {
2055 char *s = SvPVX(sv);
2056 SvLEN(sv) += SvIVX(sv);
2057 SvPVX(sv) -= SvIVX(sv);
2058 SvIV_set(sv, 0);
2059 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
2060 }
2061 SvFLAGS(sv) &= ~SVf_OOK;
2062 return 0;
2063}
2064
2065/*
2066=for apidoc sv_grow
2067
2068Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2069upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2070Use the C<SvGROW> wrapper instead.
2071
2072=cut
2073*/
2074
2075char *
2076Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2077{
2078 register char *s;
2079
2080#ifdef HAS_64K_LIMIT
2081 if (newlen >= 0x10000) {
2082 PerlIO_printf(Perl_debug_log,
2083 "Allocation too large: %"UVxf"\n", (UV)newlen);
2084 my_exit(1);
2085 }
2086#endif /* HAS_64K_LIMIT */
2087 if (SvROK(sv))
2088 sv_unref(sv);
2089 if (SvTYPE(sv) < SVt_PV) {
2090 sv_upgrade(sv, SVt_PV);
2091 s = SvPVX(sv);
2092 }
2093 else if (SvOOK(sv)) { /* pv is offset? */
2094 sv_backoff(sv);
2095 s = SvPVX(sv);
2096 if (newlen > SvLEN(sv))
2097 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2098#ifdef HAS_64K_LIMIT
2099 if (newlen >= 0x10000)
2100 newlen = 0xFFFF;
2101#endif
2102 }
2103 else
2104 s = SvPVX(sv);
2105
2106 if (newlen > SvLEN(sv)) { /* need more room? */
2107 if (SvLEN(sv) && s) {
2108#ifdef MYMALLOC
2109 STRLEN l = malloced_size((void*)SvPVX(sv));
2110 if (newlen <= l) {
2111 SvLEN_set(sv, l);
2112 return s;
2113 } else
2114#endif
2115 Renew(s,newlen,char);
2116 }
2117 else {
2118 New(703, s, newlen, char);
2119 if (SvPVX(sv) && SvCUR(sv)) {
2120 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2121 }
2122 }
2123 SvPV_set(sv, s);
2124 SvLEN_set(sv, newlen);
2125 }
2126 return s;
2127}
2128
2129/*
2130=for apidoc sv_setiv
2131
2132Copies an integer into the given SV, upgrading first if necessary.
2133Does not handle 'set' magic. See also C<sv_setiv_mg>.
2134
2135=cut
2136*/
2137
2138void
2139Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2140{
2141 SV_CHECK_THINKFIRST_COW_DROP(sv);
2142 switch (SvTYPE(sv)) {
2143 case SVt_NULL:
2144 sv_upgrade(sv, SVt_IV);
2145 break;
2146 case SVt_NV:
2147 sv_upgrade(sv, SVt_PVNV);
2148 break;
2149 case SVt_RV:
2150 case SVt_PV:
2151 sv_upgrade(sv, SVt_PVIV);
2152 break;
2153
2154 case SVt_PVGV:
2155 case SVt_PVAV:
2156 case SVt_PVHV:
2157 case SVt_PVCV:
2158 case SVt_PVFM:
2159 case SVt_PVIO:
2160 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2161 OP_DESC(PL_op));
2162 }
2163 (void)SvIOK_only(sv); /* validate number */
2164 SvIVX(sv) = i;
2165 SvTAINT(sv);
2166}
2167
2168/*
2169=for apidoc sv_setiv_mg
2170
2171Like C<sv_setiv>, but also handles 'set' magic.
2172
2173=cut
2174*/
2175
2176void
2177Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2178{
2179 sv_setiv(sv,i);
2180 SvSETMAGIC(sv);
2181}
2182
2183/*
2184=for apidoc sv_setuv
2185
2186Copies an unsigned integer into the given SV, upgrading first if necessary.
2187Does not handle 'set' magic. See also C<sv_setuv_mg>.
2188
2189=cut
2190*/
2191
2192void
2193Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2194{
2195 /* With these two if statements:
2196 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2197
2198 without
2199 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2200
2201 If you wish to remove them, please benchmark to see what the effect is
2202 */
2203 if (u <= (UV)IV_MAX) {
2204 sv_setiv(sv, (IV)u);
2205 return;
2206 }
2207 sv_setiv(sv, 0);
2208 SvIsUV_on(sv);
2209 SvUVX(sv) = u;
2210}
2211
2212/*
2213=for apidoc sv_setuv_mg
2214
2215Like C<sv_setuv>, but also handles 'set' magic.
2216
2217=cut
2218*/
2219
2220void
2221Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2222{
2223 /* With these two if statements:
2224 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2225
2226 without
2227 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2228
2229 If you wish to remove them, please benchmark to see what the effect is
2230 */
2231 if (u <= (UV)IV_MAX) {
2232 sv_setiv(sv, (IV)u);
2233 } else {
2234 sv_setiv(sv, 0);
2235 SvIsUV_on(sv);
2236 sv_setuv(sv,u);
2237 }
2238 SvSETMAGIC(sv);
2239}
2240
2241/*
2242=for apidoc sv_setnv
2243
2244Copies a double into the given SV, upgrading first if necessary.
2245Does not handle 'set' magic. See also C<sv_setnv_mg>.
2246
2247=cut
2248*/
2249
2250void
2251Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2252{
2253 SV_CHECK_THINKFIRST_COW_DROP(sv);
2254 switch (SvTYPE(sv)) {
2255 case SVt_NULL:
2256 case SVt_IV:
2257 sv_upgrade(sv, SVt_NV);
2258 break;
2259 case SVt_RV:
2260 case SVt_PV:
2261 case SVt_PVIV:
2262 sv_upgrade(sv, SVt_PVNV);
2263 break;
2264
2265 case SVt_PVGV:
2266 case SVt_PVAV:
2267 case SVt_PVHV:
2268 case SVt_PVCV:
2269 case SVt_PVFM:
2270 case SVt_PVIO:
2271 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2272 OP_NAME(PL_op));
2273 }
2274 SvNVX(sv) = num;
2275 (void)SvNOK_only(sv); /* validate number */
2276 SvTAINT(sv);
2277}
2278
2279/*
2280=for apidoc sv_setnv_mg
2281
2282Like C<sv_setnv>, but also handles 'set' magic.
2283
2284=cut
2285*/
2286
2287void
2288Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2289{
2290 sv_setnv(sv,num);
2291 SvSETMAGIC(sv);
2292}
2293
2294/* Print an "isn't numeric" warning, using a cleaned-up,
2295 * printable version of the offending string
2296 */
2297
2298STATIC void
2299S_not_a_number(pTHX_ SV *sv)
2300{
2301 SV *dsv;
2302 char tmpbuf[64];
2303 char *pv;
2304
2305 if (DO_UTF8(sv)) {
2306 dsv = sv_2mortal(newSVpv("", 0));
2307 pv = sv_uni_display(dsv, sv, 10, 0);
2308 } else {
2309 char *d = tmpbuf;
2310 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2311 /* each *s can expand to 4 chars + "...\0",
2312 i.e. need room for 8 chars */
2313
2314 char *s, *end;
2315 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2316 int ch = *s & 0xFF;
2317 if (ch & 128 && !isPRINT_LC(ch)) {
2318 *d++ = 'M';
2319 *d++ = '-';
2320 ch &= 127;
2321 }
2322 if (ch == '\n') {
2323 *d++ = '\\';
2324 *d++ = 'n';
2325 }
2326 else if (ch == '\r') {
2327 *d++ = '\\';
2328 *d++ = 'r';
2329 }
2330 else if (ch == '\f') {
2331 *d++ = '\\';
2332 *d++ = 'f';
2333 }
2334 else if (ch == '\\') {
2335 *d++ = '\\';
2336 *d++ = '\\';
2337 }
2338 else if (ch == '\0') {
2339 *d++ = '\\';
2340 *d++ = '0';
2341 }
2342 else if (isPRINT_LC(ch))
2343 *d++ = ch;
2344 else {
2345 *d++ = '^';
2346 *d++ = toCTRL(ch);
2347 }
2348 }
2349 if (s < end) {
2350 *d++ = '.';
2351 *d++ = '.';
2352 *d++ = '.';
2353 }
2354 *d = '\0';
2355 pv = tmpbuf;
2356 }
2357
2358 if (PL_op)
2359 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2360 "Argument \"%s\" isn't numeric in %s", pv,
2361 OP_DESC(PL_op));
2362 else
2363 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2364 "Argument \"%s\" isn't numeric", pv);
2365}
2366
2367/*
2368=for apidoc looks_like_number
2369
2370Test if the content of an SV looks like a number (or is a number).
2371C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2372non-numeric warning), even if your atof() doesn't grok them.
2373
2374=cut
2375*/
2376
2377I32
2378Perl_looks_like_number(pTHX_ SV *sv)
2379{
2380 register char *sbegin;
2381 STRLEN len;
2382
2383 if (SvPOK(sv)) {
2384 sbegin = SvPVX(sv);
2385 len = SvCUR(sv);
2386 }
2387 else if (SvPOKp(sv))
2388 sbegin = SvPV(sv, len);
2389 else
2390 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2391 return grok_number(sbegin, len, NULL);
2392}
2393
2394/* Actually, ISO C leaves conversion of UV to IV undefined, but
2395 until proven guilty, assume that things are not that bad... */
2396
2397/*
2398 NV_PRESERVES_UV:
2399
2400 As 64 bit platforms often have an NV that doesn't preserve all bits of
2401 an IV (an assumption perl has been based on to date) it becomes necessary
2402 to remove the assumption that the NV always carries enough precision to
2403 recreate the IV whenever needed, and that the NV is the canonical form.
2404 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2405 precision as a side effect of conversion (which would lead to insanity
2406 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2407 1) to distinguish between IV/UV/NV slots that have cached a valid
2408 conversion where precision was lost and IV/UV/NV slots that have a
2409 valid conversion which has lost no precision
2410 2) to ensure that if a numeric conversion to one form is requested that
2411 would lose precision, the precise conversion (or differently
2412 imprecise conversion) is also performed and cached, to prevent
2413 requests for different numeric formats on the same SV causing
2414 lossy conversion chains. (lossless conversion chains are perfectly
2415 acceptable (still))
2416
2417
2418 flags are used:
2419 SvIOKp is true if the IV slot contains a valid value
2420 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2421 SvNOKp is true if the NV slot contains a valid value
2422 SvNOK is true only if the NV value is accurate
2423
2424 so
2425 while converting from PV to NV, check to see if converting that NV to an
2426 IV(or UV) would lose accuracy over a direct conversion from PV to
2427 IV(or UV). If it would, cache both conversions, return NV, but mark
2428 SV as IOK NOKp (ie not NOK).
2429
2430 While converting from PV to IV, check to see if converting that IV to an
2431 NV would lose accuracy over a direct conversion from PV to NV. If it
2432 would, cache both conversions, flag similarly.
2433
2434 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2435 correctly because if IV & NV were set NV *always* overruled.
2436 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2437 changes - now IV and NV together means that the two are interchangeable:
2438 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2439
2440 The benefit of this is that operations such as pp_add know that if
2441 SvIOK is true for both left and right operands, then integer addition
2442 can be used instead of floating point (for cases where the result won't
2443 overflow). Before, floating point was always used, which could lead to
2444 loss of precision compared with integer addition.
2445
2446 * making IV and NV equal status should make maths accurate on 64 bit
2447 platforms
2448 * may speed up maths somewhat if pp_add and friends start to use
2449 integers when possible instead of fp. (Hopefully the overhead in
2450 looking for SvIOK and checking for overflow will not outweigh the
2451 fp to integer speedup)
2452 * will slow down integer operations (callers of SvIV) on "inaccurate"
2453 values, as the change from SvIOK to SvIOKp will cause a call into
2454 sv_2iv each time rather than a macro access direct to the IV slot
2455 * should speed up number->string conversion on integers as IV is
2456 favoured when IV and NV are equally accurate
2457
2458 ####################################################################
2459 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2460 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2461 On the other hand, SvUOK is true iff UV.
2462 ####################################################################
2463
2464 Your mileage will vary depending your CPU's relative fp to integer
2465 performance ratio.
2466*/
2467
2468#ifndef NV_PRESERVES_UV
2469# define IS_NUMBER_UNDERFLOW_IV 1
2470# define IS_NUMBER_UNDERFLOW_UV 2
2471# define IS_NUMBER_IV_AND_UV 2
2472# define IS_NUMBER_OVERFLOW_IV 4
2473# define IS_NUMBER_OVERFLOW_UV 5
2474
2475/* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2476
2477/* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2478STATIC int
2479S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2480{
2481 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2482 if (SvNVX(sv) < (NV)IV_MIN) {
2483 (void)SvIOKp_on(sv);
2484 (void)SvNOK_on(sv);
2485 SvIVX(sv) = IV_MIN;
2486 return IS_NUMBER_UNDERFLOW_IV;
2487 }
2488 if (SvNVX(sv) > (NV)UV_MAX) {
2489 (void)SvIOKp_on(sv);
2490 (void)SvNOK_on(sv);
2491 SvIsUV_on(sv);
2492 SvUVX(sv) = UV_MAX;
2493 return IS_NUMBER_OVERFLOW_UV;
2494 }
2495 (void)SvIOKp_on(sv);
2496 (void)SvNOK_on(sv);
2497 /* Can't use strtol etc to convert this string. (See truth table in
2498 sv_2iv */
2499 if (SvNVX(sv) <= (UV)IV_MAX) {
2500 SvIVX(sv) = I_V(SvNVX(sv));
2501 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2502 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2503 } else {
2504 /* Integer is imprecise. NOK, IOKp */
2505 }
2506 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2507 }
2508 SvIsUV_on(sv);
2509 SvUVX(sv) = U_V(SvNVX(sv));
2510 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2511 if (SvUVX(sv) == UV_MAX) {
2512 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2513 possibly be preserved by NV. Hence, it must be overflow.
2514 NOK, IOKp */
2515 return IS_NUMBER_OVERFLOW_UV;
2516 }
2517 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2518 } else {
2519 /* Integer is imprecise. NOK, IOKp */
2520 }
2521 return IS_NUMBER_OVERFLOW_IV;
2522}
2523#endif /* !NV_PRESERVES_UV*/
2524
2525/* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2526 * this function provided for binary compatibility only
2527 */
2528
2529IV
2530Perl_sv_2iv(pTHX_ register SV *sv)
2531{
2532 return sv_2iv_flags(sv, SV_GMAGIC);
2533}
2534
2535/*
2536=for apidoc sv_2iv_flags
2537
2538Return the integer value of an SV, doing any necessary string
2539conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2540Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2541
2542=cut
2543*/
2544
2545IV
2546Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2547{
2548 if (!sv)
2549 return 0;
2550 if (SvGMAGICAL(sv)) {
2551 if (flags & SV_GMAGIC)
2552 mg_get(sv);
2553 if (SvIOKp(sv))
2554 return SvIVX(sv);
2555 if (SvNOKp(sv)) {
2556 return I_V(SvNVX(sv));
2557 }
2558 if (SvPOKp(sv) && SvLEN(sv))
2559 return asIV(sv);
2560 if (!SvROK(sv)) {
2561 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2562 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2563 report_uninit(sv);
2564 }
2565 return 0;
2566 }
2567 }
2568 if (SvTHINKFIRST(sv)) {
2569 if (SvROK(sv)) {
2570 SV* tmpstr;
2571 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2572 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2573 return SvIV(tmpstr);
2574 return PTR2IV(SvRV(sv));
2575 }
2576 if (SvIsCOW(sv)) {
2577 sv_force_normal_flags(sv, 0);
2578 }
2579 if (SvREADONLY(sv) && !SvOK(sv)) {
2580 if (ckWARN(WARN_UNINITIALIZED))
2581 report_uninit(sv);
2582 return 0;
2583 }
2584 }
2585 if (SvIOKp(sv)) {
2586 if (SvIsUV(sv)) {
2587 return (IV)(SvUVX(sv));
2588 }
2589 else {
2590 return SvIVX(sv);
2591 }
2592 }
2593 if (SvNOKp(sv)) {
2594 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2595 * without also getting a cached IV/UV from it at the same time
2596 * (ie PV->NV conversion should detect loss of accuracy and cache
2597 * IV or UV at same time to avoid this. NWC */
2598
2599 if (SvTYPE(sv) == SVt_NV)
2600 sv_upgrade(sv, SVt_PVNV);
2601
2602 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2603 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2604 certainly cast into the IV range at IV_MAX, whereas the correct
2605 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2606 cases go to UV */
2607 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2608 SvIVX(sv) = I_V(SvNVX(sv));
2609 if (SvNVX(sv) == (NV) SvIVX(sv)
2610#ifndef NV_PRESERVES_UV
2611 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2612 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2613 /* Don't flag it as "accurately an integer" if the number
2614 came from a (by definition imprecise) NV operation, and
2615 we're outside the range of NV integer precision */
2616#endif
2617 ) {
2618 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2619 DEBUG_c(PerlIO_printf(Perl_debug_log,
2620 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2621 PTR2UV(sv),
2622 SvNVX(sv),
2623 SvIVX(sv)));
2624
2625 } else {
2626 /* IV not precise. No need to convert from PV, as NV
2627 conversion would already have cached IV if it detected
2628 that PV->IV would be better than PV->NV->IV
2629 flags already correct - don't set public IOK. */
2630 DEBUG_c(PerlIO_printf(Perl_debug_log,
2631 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2632 PTR2UV(sv),
2633 SvNVX(sv),
2634 SvIVX(sv)));
2635 }
2636 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2637 but the cast (NV)IV_MIN rounds to a the value less (more
2638 negative) than IV_MIN which happens to be equal to SvNVX ??
2639 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2640 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2641 (NV)UVX == NVX are both true, but the values differ. :-(
2642 Hopefully for 2s complement IV_MIN is something like
2643 0x8000000000000000 which will be exact. NWC */
2644 }
2645 else {
2646 SvUVX(sv) = U_V(SvNVX(sv));
2647 if (
2648 (SvNVX(sv) == (NV) SvUVX(sv))
2649#ifndef NV_PRESERVES_UV
2650 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2651 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2652 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2653 /* Don't flag it as "accurately an integer" if the number
2654 came from a (by definition imprecise) NV operation, and
2655 we're outside the range of NV integer precision */
2656#endif
2657 )
2658 SvIOK_on(sv);
2659 SvIsUV_on(sv);
2660 ret_iv_max:
2661 DEBUG_c(PerlIO_printf(Perl_debug_log,
2662 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2663 PTR2UV(sv),
2664 SvUVX(sv),
2665 SvUVX(sv)));
2666 return (IV)SvUVX(sv);
2667 }
2668 }
2669 else if (SvPOKp(sv) && SvLEN(sv)) {
2670 UV value;
2671 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2672 /* We want to avoid a possible problem when we cache an IV which
2673 may be later translated to an NV, and the resulting NV is not
2674 the same as the direct translation of the initial string
2675 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2676 be careful to ensure that the value with the .456 is around if the
2677 NV value is requested in the future).
2678
2679 This means that if we cache such an IV, we need to cache the
2680 NV as well. Moreover, we trade speed for space, and do not
2681 cache the NV if we are sure it's not needed.
2682 */
2683
2684 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2685 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2686 == IS_NUMBER_IN_UV) {
2687 /* It's definitely an integer, only upgrade to PVIV */
2688 if (SvTYPE(sv) < SVt_PVIV)
2689 sv_upgrade(sv, SVt_PVIV);
2690 (void)SvIOK_on(sv);
2691 } else if (SvTYPE(sv) < SVt_PVNV)
2692 sv_upgrade(sv, SVt_PVNV);
2693
2694 /* If NV preserves UV then we only use the UV value if we know that
2695 we aren't going to call atof() below. If NVs don't preserve UVs
2696 then the value returned may have more precision than atof() will
2697 return, even though value isn't perfectly accurate. */
2698 if ((numtype & (IS_NUMBER_IN_UV
2699#ifdef NV_PRESERVES_UV
2700 | IS_NUMBER_NOT_INT
2701#endif
2702 )) == IS_NUMBER_IN_UV) {
2703 /* This won't turn off the public IOK flag if it was set above */
2704 (void)SvIOKp_on(sv);
2705
2706 if (!(numtype & IS_NUMBER_NEG)) {
2707 /* positive */;
2708 if (value <= (UV)IV_MAX) {
2709 SvIVX(sv) = (IV)value;
2710 } else {
2711 SvUVX(sv) = value;
2712 SvIsUV_on(sv);
2713 }
2714 } else {
2715 /* 2s complement assumption */
2716 if (value <= (UV)IV_MIN) {
2717 SvIVX(sv) = -(IV)value;
2718 } else {
2719 /* Too negative for an IV. This is a double upgrade, but
2720 I'm assuming it will be rare. */
2721 if (SvTYPE(sv) < SVt_PVNV)
2722 sv_upgrade(sv, SVt_PVNV);
2723 SvNOK_on(sv);
2724 SvIOK_off(sv);
2725 SvIOKp_on(sv);
2726 SvNVX(sv) = -(NV)value;
2727 SvIVX(sv) = IV_MIN;
2728 }
2729 }
2730 }
2731 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2732 will be in the previous block to set the IV slot, and the next
2733 block to set the NV slot. So no else here. */
2734
2735 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2736 != IS_NUMBER_IN_UV) {
2737 /* It wasn't an (integer that doesn't overflow the UV). */
2738 SvNVX(sv) = Atof(SvPVX(sv));
2739
2740 if (! numtype && ckWARN(WARN_NUMERIC))
2741 not_a_number(sv);
2742
2743#if defined(USE_LONG_DOUBLE)
2744 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2745 PTR2UV(sv), SvNVX(sv)));
2746#else
2747 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2748 PTR2UV(sv), SvNVX(sv)));
2749#endif
2750
2751
2752#ifdef NV_PRESERVES_UV
2753 (void)SvIOKp_on(sv);
2754 (void)SvNOK_on(sv);
2755 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2756 SvIVX(sv) = I_V(SvNVX(sv));
2757 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2758 SvIOK_on(sv);
2759 } else {
2760 /* Integer is imprecise. NOK, IOKp */
2761 }
2762 /* UV will not work better than IV */
2763 } else {
2764 if (SvNVX(sv) > (NV)UV_MAX) {
2765 SvIsUV_on(sv);
2766 /* Integer is inaccurate. NOK, IOKp, is UV */
2767 SvUVX(sv) = UV_MAX;
2768 SvIsUV_on(sv);
2769 } else {
2770 SvUVX(sv) = U_V(SvNVX(sv));
2771 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2772 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2773 SvIOK_on(sv);
2774 SvIsUV_on(sv);
2775 } else {
2776 /* Integer is imprecise. NOK, IOKp, is UV */
2777 SvIsUV_on(sv);
2778 }
2779 }
2780 goto ret_iv_max;
2781 }
2782#else /* NV_PRESERVES_UV */
2783 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2784 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2785 /* The IV slot will have been set from value returned by
2786 grok_number above. The NV slot has just been set using
2787 Atof. */
2788 SvNOK_on(sv);
2789 assert (SvIOKp(sv));
2790 } else {
2791 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2792 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2793 /* Small enough to preserve all bits. */
2794 (void)SvIOKp_on(sv);
2795 SvNOK_on(sv);
2796 SvIVX(sv) = I_V(SvNVX(sv));
2797 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2798 SvIOK_on(sv);
2799 /* Assumption: first non-preserved integer is < IV_MAX,
2800 this NV is in the preserved range, therefore: */
2801 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2802 < (UV)IV_MAX)) {
2803 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);
2804 }
2805 } else {
2806 /* IN_UV NOT_INT
2807 0 0 already failed to read UV.
2808 0 1 already failed to read UV.
2809 1 0 you won't get here in this case. IV/UV
2810 slot set, public IOK, Atof() unneeded.
2811 1 1 already read UV.
2812 so there's no point in sv_2iuv_non_preserve() attempting
2813 to use atol, strtol, strtoul etc. */
2814 if (sv_2iuv_non_preserve (sv, numtype)
2815 >= IS_NUMBER_OVERFLOW_IV)
2816 goto ret_iv_max;
2817 }
2818 }
2819#endif /* NV_PRESERVES_UV */
2820 }
2821 } else {
2822 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2823 report_uninit(sv);
2824 if (SvTYPE(sv) < SVt_IV)
2825 /* Typically the caller expects that sv_any is not NULL now. */
2826 sv_upgrade(sv, SVt_IV);
2827 return 0;
2828 }
2829 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2830 PTR2UV(sv),SvIVX(sv)));
2831 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2832}
2833
2834/* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2835 * this function provided for binary compatibility only
2836 */
2837
2838UV
2839Perl_sv_2uv(pTHX_ register SV *sv)
2840{
2841 return sv_2uv_flags(sv, SV_GMAGIC);
2842}
2843
2844/*
2845=for apidoc sv_2uv_flags
2846
2847Return the unsigned integer value of an SV, doing any necessary string
2848conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2849Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2850
2851=cut
2852*/
2853
2854UV
2855Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2856{
2857 if (!sv)
2858 return 0;
2859 if (SvGMAGICAL(sv)) {
2860 if (flags & SV_GMAGIC)
2861 mg_get(sv);
2862 if (SvIOKp(sv))
2863 return SvUVX(sv);
2864 if (SvNOKp(sv))
2865 return U_V(SvNVX(sv));
2866 if (SvPOKp(sv) && SvLEN(sv))
2867 return asUV(sv);
2868 if (!SvROK(sv)) {
2869 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2870 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2871 report_uninit(sv);
2872 }
2873 return 0;
2874 }
2875 }
2876 if (SvTHINKFIRST(sv)) {
2877 if (SvROK(sv)) {
2878 SV* tmpstr;
2879 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2880 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2881 return SvUV(tmpstr);
2882 return PTR2UV(SvRV(sv));
2883 }
2884 if (SvIsCOW(sv)) {
2885 sv_force_normal_flags(sv, 0);
2886 }
2887 if (SvREADONLY(sv) && !SvOK(sv)) {
2888 if (ckWARN(WARN_UNINITIALIZED))
2889 report_uninit(sv);
2890 return 0;
2891 }
2892 }
2893 if (SvIOKp(sv)) {
2894 if (SvIsUV(sv)) {
2895 return SvUVX(sv);
2896 }
2897 else {
2898 return (UV)SvIVX(sv);
2899 }
2900 }
2901 if (SvNOKp(sv)) {
2902 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2903 * without also getting a cached IV/UV from it at the same time
2904 * (ie PV->NV conversion should detect loss of accuracy and cache
2905 * IV or UV at same time to avoid this. */
2906 /* IV-over-UV optimisation - choose to cache IV if possible */
2907
2908 if (SvTYPE(sv) == SVt_NV)
2909 sv_upgrade(sv, SVt_PVNV);
2910
2911 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2912 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2913 SvIVX(sv) = I_V(SvNVX(sv));
2914 if (SvNVX(sv) == (NV) SvIVX(sv)
2915#ifndef NV_PRESERVES_UV
2916 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2917 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2918 /* Don't flag it as "accurately an integer" if the number
2919 came from a (by definition imprecise) NV operation, and
2920 we're outside the range of NV integer precision */
2921#endif
2922 ) {
2923 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2924 DEBUG_c(PerlIO_printf(Perl_debug_log,
2925 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2926 PTR2UV(sv),
2927 SvNVX(sv),
2928 SvIVX(sv)));
2929
2930 } else {
2931 /* IV not precise. No need to convert from PV, as NV
2932 conversion would already have cached IV if it detected
2933 that PV->IV would be better than PV->NV->IV
2934 flags already correct - don't set public IOK. */
2935 DEBUG_c(PerlIO_printf(Perl_debug_log,
2936 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2937 PTR2UV(sv),
2938 SvNVX(sv),
2939 SvIVX(sv)));
2940 }
2941 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2942 but the cast (NV)IV_MIN rounds to a the value less (more
2943 negative) than IV_MIN which happens to be equal to SvNVX ??
2944 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2945 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2946 (NV)UVX == NVX are both true, but the values differ. :-(
2947 Hopefully for 2s complement IV_MIN is something like
2948 0x8000000000000000 which will be exact. NWC */
2949 }
2950 else {
2951 SvUVX(sv) = U_V(SvNVX(sv));
2952 if (
2953 (SvNVX(sv) == (NV) SvUVX(sv))
2954#ifndef NV_PRESERVES_UV
2955 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2956 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2957 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2958 /* Don't flag it as "accurately an integer" if the number
2959 came from a (by definition imprecise) NV operation, and
2960 we're outside the range of NV integer precision */
2961#endif
2962 )
2963 SvIOK_on(sv);
2964 SvIsUV_on(sv);
2965 DEBUG_c(PerlIO_printf(Perl_debug_log,
2966 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2967 PTR2UV(sv),
2968 SvUVX(sv),
2969 SvUVX(sv)));
2970 }
2971 }
2972 else if (SvPOKp(sv) && SvLEN(sv)) {
2973 UV value;
2974 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2975
2976 /* We want to avoid a possible problem when we cache a UV which
2977 may be later translated to an NV, and the resulting NV is not
2978 the translation of the initial data.
2979
2980 This means that if we cache such a UV, we need to cache the
2981 NV as well. Moreover, we trade speed for space, and do not
2982 cache the NV if not needed.
2983 */
2984
2985 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2986 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2987 == IS_NUMBER_IN_UV) {
2988 /* It's definitely an integer, only upgrade to PVIV */
2989 if (SvTYPE(sv) < SVt_PVIV)
2990 sv_upgrade(sv, SVt_PVIV);
2991 (void)SvIOK_on(sv);
2992 } else if (SvTYPE(sv) < SVt_PVNV)
2993 sv_upgrade(sv, SVt_PVNV);
2994
2995 /* If NV preserves UV then we only use the UV value if we know that
2996 we aren't going to call atof() below. If NVs don't preserve UVs
2997 then the value returned may have more precision than atof() will
2998 return, even though it isn't accurate. */
2999 if ((numtype & (IS_NUMBER_IN_UV
3000#ifdef NV_PRESERVES_UV
3001 | IS_NUMBER_NOT_INT
3002#endif
3003 )) == IS_NUMBER_IN_UV) {
3004 /* This won't turn off the public IOK flag if it was set above */
3005 (void)SvIOKp_on(sv);
3006
3007 if (!(numtype & IS_NUMBER_NEG)) {
3008 /* positive */;
3009 if (value <= (UV)IV_MAX) {
3010 SvIVX(sv) = (IV)value;
3011 } else {
3012 /* it didn't overflow, and it was positive. */
3013 SvUVX(sv) = value;
3014 SvIsUV_on(sv);
3015 }
3016 } else {
3017 /* 2s complement assumption */
3018 if (value <= (UV)IV_MIN) {
3019 SvIVX(sv) = -(IV)value;
3020 } else {
3021 /* Too negative for an IV. This is a double upgrade, but
3022 I'm assuming it will be rare. */
3023 if (SvTYPE(sv) < SVt_PVNV)
3024 sv_upgrade(sv, SVt_PVNV);
3025 SvNOK_on(sv);
3026 SvIOK_off(sv);
3027 SvIOKp_on(sv);
3028 SvNVX(sv) = -(NV)value;
3029 SvIVX(sv) = IV_MIN;
3030 }
3031 }
3032 }
3033
3034 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3035 != IS_NUMBER_IN_UV) {
3036 /* It wasn't an integer, or it overflowed the UV. */
3037 SvNVX(sv) = Atof(SvPVX(sv));
3038
3039 if (! numtype && ckWARN(WARN_NUMERIC))
3040 not_a_number(sv);
3041
3042#if defined(USE_LONG_DOUBLE)
3043 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
3044 PTR2UV(sv), SvNVX(sv)));
3045#else
3046 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
3047 PTR2UV(sv), SvNVX(sv)));
3048#endif
3049
3050#ifdef NV_PRESERVES_UV
3051 (void)SvIOKp_on(sv);
3052 (void)SvNOK_on(sv);
3053 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3054 SvIVX(sv) = I_V(SvNVX(sv));
3055 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
3056 SvIOK_on(sv);
3057 } else {
3058 /* Integer is imprecise. NOK, IOKp */
3059 }
3060 /* UV will not work better than IV */
3061 } else {
3062 if (SvNVX(sv) > (NV)UV_MAX) {
3063 SvIsUV_on(sv);
3064 /* Integer is inaccurate. NOK, IOKp, is UV */
3065 SvUVX(sv) = UV_MAX;
3066 SvIsUV_on(sv);
3067 } else {
3068 SvUVX(sv) = U_V(SvNVX(sv));
3069 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3070 NV preservse UV so can do correct comparison. */
3071 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3072 SvIOK_on(sv);
3073 SvIsUV_on(sv);
3074 } else {
3075 /* Integer is imprecise. NOK, IOKp, is UV */
3076 SvIsUV_on(sv);
3077 }
3078 }
3079 }
3080#else /* NV_PRESERVES_UV */
3081 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3082 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3083 /* The UV slot will have been set from value returned by
3084 grok_number above. The NV slot has just been set using
3085 Atof. */
3086 SvNOK_on(sv);
3087 assert (SvIOKp(sv));
3088 } else {
3089 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3090 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3091 /* Small enough to preserve all bits. */
3092 (void)SvIOKp_on(sv);
3093 SvNOK_on(sv);
3094 SvIVX(sv) = I_V(SvNVX(sv));
3095 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3096 SvIOK_on(sv);
3097 /* Assumption: first non-preserved integer is < IV_MAX,
3098 this NV is in the preserved range, therefore: */
3099 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3100 < (UV)IV_MAX)) {
3101 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
3102 }
3103 } else
3104 sv_2iuv_non_preserve (sv, numtype);
3105 }
3106#endif /* NV_PRESERVES_UV */
3107 }
3108 }
3109 else {
3110 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3111 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3112 report_uninit(sv);
3113 }
3114 if (SvTYPE(sv) < SVt_IV)
3115 /* Typically the caller expects that sv_any is not NULL now. */
3116 sv_upgrade(sv, SVt_IV);
3117 return 0;
3118 }
3119
3120 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3121 PTR2UV(sv),SvUVX(sv)));
3122 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3123}
3124
3125/*
3126=for apidoc sv_2nv
3127
3128Return the num value of an SV, doing any necessary string or integer
3129conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3130macros.
3131
3132=cut
3133*/
3134
3135NV
3136Perl_sv_2nv(pTHX_ register SV *sv)
3137{
3138 if (!sv)
3139 return 0.0;
3140 if (SvGMAGICAL(sv)) {
3141 mg_get(sv);
3142 if (SvNOKp(sv))
3143 return SvNVX(sv);
3144 if (SvPOKp(sv) && SvLEN(sv)) {
3145 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3146 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
3147 not_a_number(sv);
3148 return Atof(SvPVX(sv));
3149 }
3150 if (SvIOKp(sv)) {
3151 if (SvIsUV(sv))
3152 return (NV)SvUVX(sv);
3153 else
3154 return (NV)SvIVX(sv);
3155 }
3156 if (!SvROK(sv)) {
3157 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3158 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3159 report_uninit(sv);
3160 }
3161 return 0;
3162 }
3163 }
3164 if (SvTHINKFIRST(sv)) {
3165 if (SvROK(sv)) {
3166 SV* tmpstr;
3167 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3168 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3169 return SvNV(tmpstr);
3170 return PTR2NV(SvRV(sv));
3171 }
3172 if (SvIsCOW(sv)) {
3173 sv_force_normal_flags(sv, 0);
3174 }
3175 if (SvREADONLY(sv) && !SvOK(sv)) {
3176 if (ckWARN(WARN_UNINITIALIZED))
3177 report_uninit(sv);
3178 return 0.0;
3179 }
3180 }
3181 if (SvTYPE(sv) < SVt_NV) {
3182 if (SvTYPE(sv) == SVt_IV)
3183 sv_upgrade(sv, SVt_PVNV);
3184 else
3185 sv_upgrade(sv, SVt_NV);
3186#ifdef USE_LONG_DOUBLE
3187 DEBUG_c({
3188 STORE_NUMERIC_LOCAL_SET_STANDARD();
3189 PerlIO_printf(Perl_debug_log,
3190 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3191 PTR2UV(sv), SvNVX(sv));
3192 RESTORE_NUMERIC_LOCAL();
3193 });
3194#else
3195 DEBUG_c({
3196 STORE_NUMERIC_LOCAL_SET_STANDARD();
3197 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3198 PTR2UV(sv), SvNVX(sv));
3199 RESTORE_NUMERIC_LOCAL();
3200 });
3201#endif
3202 }
3203 else if (SvTYPE(sv) < SVt_PVNV)
3204 sv_upgrade(sv, SVt_PVNV);
3205 if (SvNOKp(sv)) {
3206 return SvNVX(sv);
3207 }
3208 if (SvIOKp(sv)) {
3209 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
3210#ifdef NV_PRESERVES_UV
3211 SvNOK_on(sv);
3212#else
3213 /* Only set the public NV OK flag if this NV preserves the IV */
3214 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3215 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3216 : (SvIVX(sv) == I_V(SvNVX(sv))))
3217 SvNOK_on(sv);
3218 else
3219 SvNOKp_on(sv);
3220#endif
3221 }
3222 else if (SvPOKp(sv) && SvLEN(sv)) {
3223 UV value;
3224 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3225 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3226 not_a_number(sv);
3227#ifdef NV_PRESERVES_UV
3228 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3229 == IS_NUMBER_IN_UV) {
3230 /* It's definitely an integer */
3231 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
3232 } else
3233 SvNVX(sv) = Atof(SvPVX(sv));
3234 SvNOK_on(sv);
3235#else
3236 SvNVX(sv) = Atof(SvPVX(sv));
3237 /* Only set the public NV OK flag if this NV preserves the value in
3238 the PV at least as well as an IV/UV would.
3239 Not sure how to do this 100% reliably. */
3240 /* if that shift count is out of range then Configure's test is
3241 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3242 UV_BITS */
3243 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3244 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3245 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3246 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3247 /* Can't use strtol etc to convert this string, so don't try.
3248 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3249 SvNOK_on(sv);
3250 } else {
3251 /* value has been set. It may not be precise. */
3252 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3253 /* 2s complement assumption for (UV)IV_MIN */
3254 SvNOK_on(sv); /* Integer is too negative. */
3255 } else {
3256 SvNOKp_on(sv);
3257 SvIOKp_on(sv);
3258
3259 if (numtype & IS_NUMBER_NEG) {
3260 SvIVX(sv) = -(IV)value;
3261 } else if (value <= (UV)IV_MAX) {
3262 SvIVX(sv) = (IV)value;
3263 } else {
3264 SvUVX(sv) = value;
3265 SvIsUV_on(sv);
3266 }
3267
3268 if (numtype & IS_NUMBER_NOT_INT) {
3269 /* I believe that even if the original PV had decimals,
3270 they are lost beyond the limit of the FP precision.
3271 However, neither is canonical, so both only get p
3272 flags. NWC, 2000/11/25 */
3273 /* Both already have p flags, so do nothing */
3274 } else {
3275 NV nv = SvNVX(sv);
3276 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3277 if (SvIVX(sv) == I_V(nv)) {
3278 SvNOK_on(sv);
3279 SvIOK_on(sv);
3280 } else {
3281 SvIOK_on(sv);
3282 /* It had no "." so it must be integer. */
3283 }
3284 } else {
3285 /* between IV_MAX and NV(UV_MAX).
3286 Could be slightly > UV_MAX */
3287
3288 if (numtype & IS_NUMBER_NOT_INT) {
3289 /* UV and NV both imprecise. */
3290 } else {
3291 UV nv_as_uv = U_V(nv);
3292
3293 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3294 SvNOK_on(sv);
3295 SvIOK_on(sv);
3296 } else {
3297 SvIOK_on(sv);
3298 }
3299 }
3300 }
3301 }
3302 }
3303 }
3304#endif /* NV_PRESERVES_UV */
3305 }
3306 else {
3307 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3308 report_uninit(sv);
3309 if (SvTYPE(sv) < SVt_NV)
3310 /* Typically the caller expects that sv_any is not NULL now. */
3311 /* XXX Ilya implies that this is a bug in callers that assume this
3312 and ideally should be fixed. */
3313 sv_upgrade(sv, SVt_NV);
3314 return 0.0;
3315 }
3316#if defined(USE_LONG_DOUBLE)
3317 DEBUG_c({
3318 STORE_NUMERIC_LOCAL_SET_STANDARD();
3319 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3320 PTR2UV(sv), SvNVX(sv));
3321 RESTORE_NUMERIC_LOCAL();
3322 });
3323#else
3324 DEBUG_c({
3325 STORE_NUMERIC_LOCAL_SET_STANDARD();
3326 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3327 PTR2UV(sv), SvNVX(sv));
3328 RESTORE_NUMERIC_LOCAL();
3329 });
3330#endif
3331 return SvNVX(sv);
3332}
3333
3334/* asIV(): extract an integer from the string value of an SV.
3335 * Caller must validate PVX */
3336
3337STATIC IV
3338S_asIV(pTHX_ SV *sv)
3339{
3340 UV value;
3341 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3342
3343 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3344 == IS_NUMBER_IN_UV) {
3345 /* It's definitely an integer */
3346 if (numtype & IS_NUMBER_NEG) {
3347 if (value < (UV)IV_MIN)
3348 return -(IV)value;
3349 } else {
3350 if (value < (UV)IV_MAX)
3351 return (IV)value;
3352 }
3353 }
3354 if (!numtype) {
3355 if (ckWARN(WARN_NUMERIC))
3356 not_a_number(sv);
3357 }
3358 return I_V(Atof(SvPVX(sv)));
3359}
3360
3361/* asUV(): extract an unsigned integer from the string value of an SV
3362 * Caller must validate PVX */
3363
3364STATIC UV
3365S_asUV(pTHX_ SV *sv)
3366{
3367 UV value;
3368 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3369
3370 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3371 == IS_NUMBER_IN_UV) {
3372 /* It's definitely an integer */
3373 if (!(numtype & IS_NUMBER_NEG))
3374 return value;
3375 }
3376 if (!numtype) {
3377 if (ckWARN(WARN_NUMERIC))
3378 not_a_number(sv);
3379 }
3380 return U_V(Atof(SvPVX(sv)));
3381}
3382
3383/*
3384=for apidoc sv_2pv_nolen
3385
3386Like C<sv_2pv()>, but doesn't return the length too. You should usually
3387use the macro wrapper C<SvPV_nolen(sv)> instead.
3388=cut
3389*/
3390
3391char *
3392Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3393{
3394 STRLEN n_a;
3395 return sv_2pv(sv, &n_a);
3396}
3397
3398/* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3399 * UV as a string towards the end of buf, and return pointers to start and
3400 * end of it.
3401 *
3402 * We assume that buf is at least TYPE_CHARS(UV) long.
3403 */
3404
3405static char *
3406uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3407{
3408 char *ptr = buf + TYPE_CHARS(UV);
3409 char *ebuf = ptr;
3410 int sign;
3411
3412 if (is_uv)
3413 sign = 0;
3414 else if (iv >= 0) {
3415 uv = iv;
3416 sign = 0;
3417 } else {
3418 uv = -iv;
3419 sign = 1;
3420 }
3421 do {
3422 *--ptr = '0' + (char)(uv % 10);
3423 } while (uv /= 10);
3424 if (sign)
3425 *--ptr = '-';
3426 *peob = ebuf;
3427 return ptr;
3428}
3429
3430/* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3431 * this function provided for binary compatibility only
3432 */
3433
3434char *
3435Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3436{
3437 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3438}
3439
3440/*
3441=for apidoc sv_2pv_flags
3442
3443Returns a pointer to the string value of an SV, and sets *lp to its length.
3444If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3445if necessary.
3446Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3447usually end up here too.
3448
3449=cut
3450*/
3451
3452char *
3453Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3454{
3455 register char *s;
3456 int olderrno;
3457 SV *tsv, *origsv;
3458 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3459 char *tmpbuf = tbuf;
3460
3461 if (!sv) {
3462 *lp = 0;
3463 return "";
3464 }
3465 if (SvGMAGICAL(sv)) {
3466 if (flags & SV_GMAGIC)
3467 mg_get(sv);
3468 if (SvPOKp(sv)) {
3469 *lp = SvCUR(sv);
3470 return SvPVX(sv);
3471 }
3472 if (SvIOKp(sv)) {
3473 if (SvIsUV(sv))
3474 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3475 else
3476 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3477 tsv = Nullsv;
3478 goto tokensave;
3479 }
3480 if (SvNOKp(sv)) {
3481 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3482 tsv = Nullsv;
3483 goto tokensave;
3484 }
3485 if (!SvROK(sv)) {
3486 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3487 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3488 report_uninit(sv);
3489 }
3490 *lp = 0;
3491 return "";
3492 }
3493 }
3494 if (SvTHINKFIRST(sv)) {
3495 if (SvROK(sv)) {
3496 SV* tmpstr;
3497 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3498 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3499 char *pv = SvPV(tmpstr, *lp);
3500 if (SvUTF8(tmpstr))
3501 SvUTF8_on(sv);
3502 else
3503 SvUTF8_off(sv);
3504 return pv;
3505 }
3506 origsv = sv;
3507 sv = (SV*)SvRV(sv);
3508 if (!sv)
3509 s = "NULLREF";
3510 else {
3511 MAGIC *mg;
3512
3513 switch (SvTYPE(sv)) {
3514 case SVt_PVMG:
3515 if ( ((SvFLAGS(sv) &
3516 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3517 == (SVs_OBJECT|SVs_SMG))
3518 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3519 regexp *re = (regexp *)mg->mg_obj;
3520
3521 if (!mg->mg_ptr) {
3522 char *fptr = "msix";
3523 char reflags[6];
3524 char ch;
3525 int left = 0;
3526 int right = 4;
3527 char need_newline = 0;
3528 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3529
3530 while((ch = *fptr++)) {
3531 if(reganch & 1) {
3532 reflags[left++] = ch;
3533 }
3534 else {
3535 reflags[right--] = ch;
3536 }
3537 reganch >>= 1;
3538 }
3539 if(left != 4) {
3540 reflags[left] = '-';
3541 left = 5;
3542 }
3543
3544 mg->mg_len = re->prelen + 4 + left;
3545 /*
3546 * If /x was used, we have to worry about a regex
3547 * ending with a comment later being embedded
3548 * within another regex. If so, we don't want this
3549 * regex's "commentization" to leak out to the
3550 * right part of the enclosing regex, we must cap
3551 * it with a newline.
3552 *
3553 * So, if /x was used, we scan backwards from the
3554 * end of the regex. If we find a '#' before we
3555 * find a newline, we need to add a newline
3556 * ourself. If we find a '\n' first (or if we
3557 * don't find '#' or '\n'), we don't need to add
3558 * anything. -jfriedl
3559 */
3560 if (PMf_EXTENDED & re->reganch)
3561 {
3562 char *endptr = re->precomp + re->prelen;
3563 while (endptr >= re->precomp)
3564 {
3565 char c = *(endptr--);
3566 if (c == '\n')
3567 break; /* don't need another */
3568 if (c == '#') {
3569 /* we end while in a comment, so we
3570 need a newline */
3571 mg->mg_len++; /* save space for it */
3572 need_newline = 1; /* note to add it */
3573 break;
3574 }
3575 }
3576 }
3577
3578 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3579 Copy("(?", mg->mg_ptr, 2, char);
3580 Copy(reflags, mg->mg_ptr+2, left, char);
3581 Copy(":", mg->mg_ptr+left+2, 1, char);
3582 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3583 if (need_newline)
3584 mg->mg_ptr[mg->mg_len - 2] = '\n';
3585 mg->mg_ptr[mg->mg_len - 1] = ')';
3586 mg->mg_ptr[mg->mg_len] = 0;
3587 }
3588 PL_reginterp_cnt += re->program[0].next_off;
3589
3590 if (re->reganch & ROPT_UTF8)
3591 SvUTF8_on(origsv);
3592 else
3593 SvUTF8_off(origsv);
3594 *lp = mg->mg_len;
3595 return mg->mg_ptr;
3596 }
3597 /* Fall through */
3598 case SVt_NULL:
3599 case SVt_IV:
3600 case SVt_NV:
3601 case SVt_RV:
3602 case SVt_PV:
3603 case SVt_PVIV:
3604 case SVt_PVNV:
3605 case SVt_PVBM: if (SvROK(sv))
3606 s = "REF";
3607 else
3608 s = "SCALAR"; break;
3609 case SVt_PVLV: s = SvROK(sv) ? "REF"
3610 /* tied lvalues should appear to be
3611 * scalars for backwards compatitbility */
3612 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3613 ? "SCALAR" : "LVALUE"; break;
3614 case SVt_PVAV: s = "ARRAY"; break;
3615 case SVt_PVHV: s = "HASH"; break;
3616 case SVt_PVCV: s = "CODE"; break;
3617 case SVt_PVGV: s = "GLOB"; break;
3618 case SVt_PVFM: s = "FORMAT"; break;
3619 case SVt_PVIO: s = "IO"; break;
3620 default: s = "UNKNOWN"; break;
3621 }
3622 tsv = NEWSV(0,0);
3623 if (SvOBJECT(sv)) {
3624 const char *name = HvNAME(SvSTASH(sv));
3625 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3626 name ? name : "__ANON__" , s, PTR2UV(sv));
3627 }
3628 else
3629 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", s, PTR2UV(sv));
3630 goto tokensaveref;
3631 }
3632 *lp = strlen(s);
3633 return s;
3634 }
3635 if (SvREADONLY(sv) && !SvOK(sv)) {
3636 if (ckWARN(WARN_UNINITIALIZED))
3637 report_uninit(sv);
3638 *lp = 0;
3639 return "";
3640 }
3641 }
3642 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3643 /* I'm assuming that if both IV and NV are equally valid then
3644 converting the IV is going to be more efficient */
3645 U32 isIOK = SvIOK(sv);
3646 U32 isUIOK = SvIsUV(sv);
3647 char buf[TYPE_CHARS(UV)];
3648 char *ebuf, *ptr;
3649
3650 if (SvTYPE(sv) < SVt_PVIV)
3651 sv_upgrade(sv, SVt_PVIV);
3652 if (isUIOK)
3653 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3654 else
3655 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3656 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3657 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3658 SvCUR_set(sv, ebuf - ptr);
3659 s = SvEND(sv);
3660 *s = '\0';
3661 if (isIOK)
3662 SvIOK_on(sv);
3663 else
3664 SvIOKp_on(sv);
3665 if (isUIOK)
3666 SvIsUV_on(sv);
3667 }
3668 else if (SvNOKp(sv)) {
3669 if (SvTYPE(sv) < SVt_PVNV)
3670 sv_upgrade(sv, SVt_PVNV);
3671 /* The +20 is pure guesswork. Configure test needed. --jhi */
3672 SvGROW(sv, NV_DIG + 20);
3673 s = SvPVX(sv);
3674 olderrno = errno; /* some Xenix systems wipe out errno here */
3675#ifdef apollo
3676 if (SvNVX(sv) == 0.0)
3677 (void)strcpy(s,"0");
3678 else
3679#endif /*apollo*/
3680 {
3681 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3682 }
3683 errno = olderrno;
3684#ifdef FIXNEGATIVEZERO
3685 if (*s == '-' && s[1] == '0' && !s[2])
3686 strcpy(s,"0");
3687#endif
3688 while (*s) s++;
3689#ifdef hcx
3690 if (s[-1] == '.')
3691 *--s = '\0';
3692#endif
3693 }
3694 else {
3695 if (ckWARN(WARN_UNINITIALIZED)
3696 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3697 report_uninit(sv);
3698 *lp = 0;
3699 if (SvTYPE(sv) < SVt_PV)
3700 /* Typically the caller expects that sv_any is not NULL now. */
3701 sv_upgrade(sv, SVt_PV);
3702 return "";
3703 }
3704 *lp = s - SvPVX(sv);
3705 SvCUR_set(sv, *lp);
3706 SvPOK_on(sv);
3707 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3708 PTR2UV(sv),SvPVX(sv)));
3709 return SvPVX(sv);
3710
3711 tokensave:
3712 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3713 /* Sneaky stuff here */
3714
3715 tokensaveref:
3716 if (!tsv)
3717 tsv = newSVpv(tmpbuf, 0);
3718 sv_2mortal(tsv);
3719 *lp = SvCUR(tsv);
3720 return SvPVX(tsv);
3721 }
3722 else {
3723 STRLEN len;
3724 char *t;
3725
3726 if (tsv) {
3727 sv_2mortal(tsv);
3728 t = SvPVX(tsv);
3729 len = SvCUR(tsv);
3730 }
3731 else {
3732 t = tmpbuf;
3733 len = strlen(tmpbuf);
3734 }
3735#ifdef FIXNEGATIVEZERO
3736 if (len == 2 && t[0] == '-' && t[1] == '0') {
3737 t = "0";
3738 len = 1;
3739 }
3740#endif
3741 (void)SvUPGRADE(sv, SVt_PV);
3742 *lp = len;
3743 s = SvGROW(sv, len + 1);
3744 SvCUR_set(sv, len);
3745 SvPOKp_on(sv);
3746 return strcpy(s, t);
3747 }
3748}
3749
3750/*
3751=for apidoc sv_copypv
3752
3753Copies a stringified representation of the source SV into the
3754destination SV. Automatically performs any necessary mg_get and
3755coercion of numeric values into strings. Guaranteed to preserve
3756UTF-8 flag even from overloaded objects. Similar in nature to
3757sv_2pv[_flags] but operates directly on an SV instead of just the
3758string. Mostly uses sv_2pv_flags to do its work, except when that
3759would lose the UTF-8'ness of the PV.
3760
3761=cut
3762*/
3763
3764void
3765Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3766{
3767 STRLEN len;
3768 char *s;
3769 s = SvPV(ssv,len);
3770 sv_setpvn(dsv,s,len);
3771 if (SvUTF8(ssv))
3772 SvUTF8_on(dsv);
3773 else
3774 SvUTF8_off(dsv);
3775}
3776
3777/*
3778=for apidoc sv_2pvbyte_nolen
3779
3780Return a pointer to the byte-encoded representation of the SV.
3781May cause the SV to be downgraded from UTF-8 as a side-effect.
3782
3783Usually accessed via the C<SvPVbyte_nolen> macro.
3784
3785=cut
3786*/
3787
3788char *
3789Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3790{
3791 STRLEN n_a;
3792 return sv_2pvbyte(sv, &n_a);
3793}
3794
3795/*
3796=for apidoc sv_2pvbyte
3797
3798Return a pointer to the byte-encoded representation of the SV, and set *lp
3799to its length. May cause the SV to be downgraded from UTF-8 as a
3800side-effect.
3801
3802Usually accessed via the C<SvPVbyte> macro.
3803
3804=cut
3805*/
3806
3807char *
3808Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3809{
3810 sv_utf8_downgrade(sv,0);
3811 return SvPV(sv,*lp);
3812}
3813
3814/*
3815=for apidoc sv_2pvutf8_nolen
3816
3817Return a pointer to the UTF-8-encoded representation of the SV.
3818May cause the SV to be upgraded to UTF-8 as a side-effect.
3819
3820Usually accessed via the C<SvPVutf8_nolen> macro.
3821
3822=cut
3823*/
3824
3825char *
3826Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3827{
3828 STRLEN n_a;
3829 return sv_2pvutf8(sv, &n_a);
3830}
3831
3832/*
3833=for apidoc sv_2pvutf8
3834
3835Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3836to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3837
3838Usually accessed via the C<SvPVutf8> macro.
3839
3840=cut
3841*/
3842
3843char *
3844Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3845{
3846 sv_utf8_upgrade(sv);
3847 return SvPV(sv,*lp);
3848}
3849
3850/*
3851=for apidoc sv_2bool
3852
3853This function is only called on magical items, and is only used by
3854sv_true() or its macro equivalent.
3855
3856=cut
3857*/
3858
3859bool
3860Perl_sv_2bool(pTHX_ register SV *sv)
3861{
3862 if (SvGMAGICAL(sv))
3863 mg_get(sv);
3864
3865 if (!SvOK(sv))
3866 return 0;
3867 if (SvROK(sv)) {
3868 SV* tmpsv;
3869 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3870 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3871 return (bool)SvTRUE(tmpsv);
3872 return SvRV(sv) != 0;
3873 }
3874 if (SvPOKp(sv)) {
3875 register XPV* Xpvtmp;
3876 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3877 (*Xpvtmp->xpv_pv > '0' ||
3878 Xpvtmp->xpv_cur > 1 ||
3879 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3880 return 1;
3881 else
3882 return 0;
3883 }
3884 else {
3885 if (SvIOKp(sv))
3886 return SvIVX(sv) != 0;
3887 else {
3888 if (SvNOKp(sv))
3889 return SvNVX(sv) != 0.0;
3890 else
3891 return FALSE;
3892 }
3893 }
3894}
3895
3896/* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3897 * this function provided for binary compatibility only
3898 */
3899
3900
3901STRLEN
3902Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3903{
3904 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3905}
3906
3907/*
3908=for apidoc sv_utf8_upgrade
3909
3910Converts the PV of an SV to its UTF-8-encoded form.
3911Forces the SV to string form if it is not already.
3912Always sets the SvUTF8 flag to avoid future validity checks even
3913if all the bytes have hibit clear.
3914
3915This is not as a general purpose byte encoding to Unicode interface:
3916use the Encode extension for that.
3917
3918=for apidoc sv_utf8_upgrade_flags
3919
3920Converts the PV of an SV to its UTF-8-encoded form.
3921Forces the SV to string form if it is not already.
3922Always sets the SvUTF8 flag to avoid future validity checks even
3923if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3924will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3925C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3926
3927This is not as a general purpose byte encoding to Unicode interface:
3928use the Encode extension for that.
3929
3930=cut
3931*/
3932
3933STRLEN
3934Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3935{
3936 U8 *s, *t, *e;
3937 int hibit = 0;
3938
3939 if (sv == &PL_sv_undef)
3940 return 0;
3941 if (!SvPOK(sv)) {
3942 STRLEN len = 0;
3943 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3944 (void) sv_2pv_flags(sv,&len, flags);
3945 if (SvUTF8(sv))
3946 return len;
3947 } else {
3948 (void) SvPV_force(sv,len);
3949 }
3950 }
3951
3952 if (SvUTF8(sv)) {
3953 return SvCUR(sv);
3954 }
3955
3956 if (SvIsCOW(sv)) {
3957 sv_force_normal_flags(sv, 0);
3958 }
3959
3960 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3961 sv_recode_to_utf8(sv, PL_encoding);
3962 else { /* Assume Latin-1/EBCDIC */
3963 /* This function could be much more efficient if we
3964 * had a FLAG in SVs to signal if there are any hibit
3965 * chars in the PV. Given that there isn't such a flag
3966 * make the loop as fast as possible. */
3967 s = (U8 *) SvPVX(sv);
3968 e = (U8 *) SvEND(sv);
3969 t = s;
3970 while (t < e) {
3971 U8 ch = *t++;
3972 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3973 break;
3974 }
3975 if (hibit) {
3976 STRLEN len;
3977 (void)SvOOK_off(sv);
3978 s = (U8*)SvPVX(sv);
3979 len = SvCUR(sv) + 1; /* Plus the \0 */
3980 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3981 SvCUR(sv) = len - 1;
3982 if (SvLEN(sv) != 0)
3983 Safefree(s); /* No longer using what was there before. */
3984 SvLEN(sv) = len; /* No longer know the real size. */
3985 }
3986 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3987 SvUTF8_on(sv);
3988 }
3989 return SvCUR(sv);
3990}
3991
3992/*
3993=for apidoc sv_utf8_downgrade
3994
3995Attempts to convert the PV of an SV from characters to bytes.
3996If the PV contains a character beyond byte, this conversion will fail;
3997in this case, either returns false or, if C<fail_ok> is not
3998true, croaks.
3999
4000This is not as a general purpose Unicode to byte encoding interface:
4001use the Encode extension for that.
4002
4003=cut
4004*/
4005
4006bool
4007Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
4008{
4009 if (SvPOKp(sv) && SvUTF8(sv)) {
4010 if (SvCUR(sv)) {
4011 U8 *s;
4012 STRLEN len;
4013
4014 if (SvIsCOW(sv)) {
4015 sv_force_normal_flags(sv, 0);
4016 }
4017 s = (U8 *) SvPV(sv, len);
4018 if (!utf8_to_bytes(s, &len)) {
4019 if (fail_ok)
4020 return FALSE;
4021 else {
4022 if (PL_op)
4023 Perl_croak(aTHX_ "Wide character in %s",
4024 OP_DESC(PL_op));
4025 else
4026 Perl_croak(aTHX_ "Wide character");
4027 }
4028 }
4029 SvCUR(sv) = len;
4030 }
4031 }
4032 SvUTF8_off(sv);
4033 return TRUE;
4034}
4035
4036/*
4037=for apidoc sv_utf8_encode
4038
4039Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4040flag off so that it looks like octets again.
4041
4042=cut
4043*/
4044
4045void
4046Perl_sv_utf8_encode(pTHX_ register SV *sv)
4047{
4048 (void) sv_utf8_upgrade(sv);
4049 if (SvIsCOW(sv)) {
4050 sv_force_normal_flags(sv, 0);
4051 }
4052 if (SvREADONLY(sv)) {
4053 Perl_croak(aTHX_ PL_no_modify);
4054 }
4055 SvUTF8_off(sv);
4056}
4057
4058/*
4059=for apidoc sv_utf8_decode
4060
4061If the PV of the SV is an octet sequence in UTF-8
4062and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4063so that it looks like a character. If the PV contains only single-byte
4064characters, the C<SvUTF8> flag stays being off.
4065Scans PV for validity and returns false if the PV is invalid UTF-8.
4066
4067=cut
4068*/
4069
4070bool
4071Perl_sv_utf8_decode(pTHX_ register SV *sv)
4072{
4073 if (SvPOKp(sv)) {
4074 U8 *c;
4075 U8 *e;
4076
4077 /* The octets may have got themselves encoded - get them back as
4078 * bytes
4079 */
4080 if (!sv_utf8_downgrade(sv, TRUE))
4081 return FALSE;
4082
4083 /* it is actually just a matter of turning the utf8 flag on, but
4084 * we want to make sure everything inside is valid utf8 first.
4085 */
4086 c = (U8 *) SvPVX(sv);
4087 if (!is_utf8_string(c, SvCUR(sv)+1))
4088 return FALSE;
4089 e = (U8 *) SvEND(sv);
4090 while (c < e) {
4091 U8 ch = *c++;
4092 if (!UTF8_IS_INVARIANT(ch)) {
4093 SvUTF8_on(sv);
4094 break;
4095 }
4096 }
4097 }
4098 return TRUE;
4099}
4100
4101/* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4102 * this function provided for binary compatibility only
4103 */
4104
4105void
4106Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4107{
4108 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4109}
4110
4111/*
4112=for apidoc sv_setsv
4113
4114Copies the contents of the source SV C<ssv> into the destination SV
4115C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4116function if the source SV needs to be reused. Does not handle 'set' magic.
4117Loosely speaking, it performs a copy-by-value, obliterating any previous
4118content of the destination.
4119
4120You probably want to use one of the assortment of wrappers, such as
4121C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4122C<SvSetMagicSV_nosteal>.
4123
4124=for apidoc sv_setsv_flags
4125
4126Copies the contents of the source SV C<ssv> into the destination SV
4127C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4128function if the source SV needs to be reused. Does not handle 'set' magic.
4129Loosely speaking, it performs a copy-by-value, obliterating any previous
4130content of the destination.
4131If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4132C<ssv> if appropriate, else not. If the C<flags> parameter has the
4133C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4134and C<sv_setsv_nomg> are implemented in terms of this function.
4135
4136You probably want to use one of the assortment of wrappers, such as
4137C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4138C<SvSetMagicSV_nosteal>.
4139
4140This is the primary function for copying scalars, and most other
4141copy-ish functions and macros use this underneath.
4142
4143=cut
4144*/
4145
4146void
4147Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4148{
4149 register U32 sflags;
4150 register int dtype;
4151 register int stype;
4152
4153 if (sstr == dstr)
4154 return;
4155 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4156 if (!sstr)
4157 sstr = &PL_sv_undef;
4158 stype = SvTYPE(sstr);
4159 dtype = SvTYPE(dstr);
4160
4161 SvAMAGIC_off(dstr);
4162 if ( SvVOK(dstr) )
4163 {
4164 /* need to nuke the magic */
4165 mg_free(dstr);
4166 SvRMAGICAL_off(dstr);
4167 }
4168
4169 /* There's a lot of redundancy below but we're going for speed here */
4170
4171 switch (stype) {
4172 case SVt_NULL:
4173 undef_sstr:
4174 if (dtype != SVt_PVGV) {
4175 (void)SvOK_off(dstr);
4176 return;
4177 }
4178 break;
4179 case SVt_IV:
4180 if (SvIOK(sstr)) {
4181 switch (dtype) {
4182 case SVt_NULL:
4183 sv_upgrade(dstr, SVt_IV);
4184 break;
4185 case SVt_NV:
4186 sv_upgrade(dstr, SVt_PVNV);
4187 break;
4188 case SVt_RV:
4189 case SVt_PV:
4190 sv_upgrade(dstr, SVt_PVIV);
4191 break;
4192 }
4193 (void)SvIOK_only(dstr);
4194 SvIVX(dstr) = SvIVX(sstr);
4195 if (SvIsUV(sstr))
4196 SvIsUV_on(dstr);
4197 if (SvTAINTED(sstr))
4198 SvTAINT(dstr);
4199 return;
4200 }
4201 goto undef_sstr;
4202
4203 case SVt_NV:
4204 if (SvNOK(sstr)) {
4205 switch (dtype) {
4206 case SVt_NULL:
4207 case SVt_IV:
4208 sv_upgrade(dstr, SVt_NV);
4209 break;
4210 case SVt_RV:
4211 case SVt_PV:
4212 case SVt_PVIV:
4213 sv_upgrade(dstr, SVt_PVNV);
4214 break;
4215 }
4216 SvNVX(dstr) = SvNVX(sstr);
4217 (void)SvNOK_only(dstr);
4218 if (SvTAINTED(sstr))
4219 SvTAINT(dstr);
4220 return;
4221 }
4222 goto undef_sstr;
4223
4224 case SVt_RV:
4225 if (dtype < SVt_RV)
4226 sv_upgrade(dstr, SVt_RV);
4227 else if (dtype == SVt_PVGV &&
4228 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4229 sstr = SvRV(sstr);
4230 if (sstr == dstr) {
4231 if (GvIMPORTED(dstr) != GVf_IMPORTED
4232 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4233 {
4234 GvIMPORTED_on(dstr);
4235 }
4236 GvMULTI_on(dstr);
4237 return;
4238 }
4239 goto glob_assign;
4240 }
4241 break;
4242 case SVt_PVFM:
4243#ifdef PERL_COPY_ON_WRITE
4244 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4245 if (dtype < SVt_PVIV)
4246 sv_upgrade(dstr, SVt_PVIV);
4247 break;
4248 }
4249 /* Fall through */
4250#endif
4251 case SVt_PV:
4252 if (dtype < SVt_PV)
4253 sv_upgrade(dstr, SVt_PV);
4254 break;
4255 case SVt_PVIV:
4256 if (dtype < SVt_PVIV)
4257 sv_upgrade(dstr, SVt_PVIV);
4258 break;
4259 case SVt_PVNV:
4260 if (dtype < SVt_PVNV)
4261 sv_upgrade(dstr, SVt_PVNV);
4262 break;
4263 case SVt_PVAV:
4264 case SVt_PVHV:
4265 case SVt_PVCV:
4266 case SVt_PVIO:
4267 if (PL_op)
4268 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
4269 OP_NAME(PL_op));
4270 else
4271 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
4272 break;
4273
4274 case SVt_PVGV:
4275 if (dtype <= SVt_PVGV) {
4276 glob_assign:
4277 if (dtype != SVt_PVGV) {
4278 char *name = GvNAME(sstr);
4279 STRLEN len = GvNAMELEN(sstr);
4280 /* don't upgrade SVt_PVLV: it can hold a glob */
4281 if (dtype != SVt_PVLV)
4282 sv_upgrade(dstr, SVt_PVGV);
4283 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4284 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4285 GvNAME(dstr) = savepvn(name, len);
4286 GvNAMELEN(dstr) = len;
4287 SvFAKE_on(dstr); /* can coerce to non-glob */
4288 }
4289 /* ahem, death to those who redefine active sort subs */
4290 else if (PL_curstackinfo->si_type == PERLSI_SORT
4291 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4292 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4293 GvNAME(dstr));
4294
4295#ifdef GV_UNIQUE_CHECK
4296 if (GvUNIQUE((GV*)dstr)) {
4297 Perl_croak(aTHX_ PL_no_modify);
4298 }
4299#endif
4300
4301 (void)SvOK_off(dstr);
4302 GvINTRO_off(dstr); /* one-shot flag */
4303 gp_free((GV*)dstr);
4304 GvGP(dstr) = gp_ref(GvGP(sstr));
4305 if (SvTAINTED(sstr))
4306 SvTAINT(dstr);
4307 if (GvIMPORTED(dstr) != GVf_IMPORTED
4308 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4309 {
4310 GvIMPORTED_on(dstr);
4311 }
4312 GvMULTI_on(dstr);
4313 return;
4314 }
4315 /* FALL THROUGH */
4316
4317 default:
4318 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4319 mg_get(sstr);
4320 if ((int)SvTYPE(sstr) != stype) {
4321 stype = SvTYPE(sstr);
4322 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4323 goto glob_assign;
4324 }
4325 }
4326 if (stype == SVt_PVLV)
4327 (void)SvUPGRADE(dstr, SVt_PVNV);
4328 else
4329 (void)SvUPGRADE(dstr, (U32)stype);
4330 }
4331
4332 sflags = SvFLAGS(sstr);
4333
4334 if (sflags & SVf_ROK) {
4335 if (dtype >= SVt_PV) {
4336 if (dtype == SVt_PVGV) {
4337 SV *sref = SvREFCNT_inc(SvRV(sstr));
4338 SV *dref = 0;
4339 int intro = GvINTRO(dstr);
4340
4341#ifdef GV_UNIQUE_CHECK
4342 if (GvUNIQUE((GV*)dstr)) {
4343 Perl_croak(aTHX_ PL_no_modify);
4344 }
4345#endif
4346
4347 if (intro) {
4348 GvINTRO_off(dstr); /* one-shot flag */
4349 GvLINE(dstr) = CopLINE(PL_curcop);
4350 GvEGV(dstr) = (GV*)dstr;
4351 }
4352 GvMULTI_on(dstr);
4353 switch (SvTYPE(sref)) {
4354 case SVt_PVAV:
4355 if (intro)
4356 SAVEGENERICSV(GvAV(dstr));
4357 else
4358 dref = (SV*)GvAV(dstr);
4359 GvAV(dstr) = (AV*)sref;
4360 if (!GvIMPORTED_AV(dstr)
4361 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4362 {
4363 GvIMPORTED_AV_on(dstr);
4364 }
4365 break;
4366 case SVt_PVHV:
4367 if (intro)
4368 SAVEGENERICSV(GvHV(dstr));
4369 else
4370 dref = (SV*)GvHV(dstr);
4371 GvHV(dstr) = (HV*)sref;
4372 if (!GvIMPORTED_HV(dstr)
4373 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4374 {
4375 GvIMPORTED_HV_on(dstr);
4376 }
4377 break;
4378 case SVt_PVCV:
4379 if (intro) {
4380 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4381 SvREFCNT_dec(GvCV(dstr));
4382 GvCV(dstr) = Nullcv;
4383 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4384 PL_sub_generation++;
4385 }
4386 SAVEGENERICSV(GvCV(dstr));
4387 }
4388 else
4389 dref = (SV*)GvCV(dstr);
4390 if (GvCV(dstr) != (CV*)sref) {
4391 CV* cv = GvCV(dstr);
4392 if (cv) {
4393 if (!GvCVGEN((GV*)dstr) &&
4394 (CvROOT(cv) || CvXSUB(cv)))
4395 {
4396 /* ahem, death to those who redefine
4397 * active sort subs */
4398 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4399 PL_sortcop == CvSTART(cv))
4400 Perl_croak(aTHX_
4401 "Can't redefine active sort subroutine %s",
4402 GvENAME((GV*)dstr));
4403 /* Redefining a sub - warning is mandatory if
4404 it was a const and its value changed. */
4405 if (ckWARN(WARN_REDEFINE)
4406 || (CvCONST(cv)
4407 && (!CvCONST((CV*)sref)
4408 || sv_cmp(cv_const_sv(cv),
4409 cv_const_sv((CV*)sref)))))
4410 {
4411 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4412 CvCONST(cv)
4413 ? "Constant subroutine %s::%s redefined"
4414 : "Subroutine %s::%s redefined",
4415 HvNAME(GvSTASH((GV*)dstr)),
4416 GvENAME((GV*)dstr));
4417 }
4418 }
4419 if (!intro)
4420 cv_ckproto(cv, (GV*)dstr,
4421 SvPOK(sref) ? SvPVX(sref) : Nullch);
4422 }
4423 GvCV(dstr) = (CV*)sref;
4424 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4425 GvASSUMECV_on(dstr);
4426 PL_sub_generation++;
4427 }
4428 if (!GvIMPORTED_CV(dstr)
4429 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4430 {
4431 GvIMPORTED_CV_on(dstr);
4432 }
4433 break;
4434 case SVt_PVIO:
4435 if (intro)
4436 SAVEGENERICSV(GvIOp(dstr));
4437 else
4438 dref = (SV*)GvIOp(dstr);
4439 GvIOp(dstr) = (IO*)sref;
4440 break;
4441 case SVt_PVFM:
4442 if (intro)
4443 SAVEGENERICSV(GvFORM(dstr));
4444 else
4445 dref = (SV*)GvFORM(dstr);
4446 GvFORM(dstr) = (CV*)sref;
4447 break;
4448 default:
4449 if (intro)
4450 SAVEGENERICSV(GvSV(dstr));
4451 else
4452 dref = (SV*)GvSV(dstr);
4453 GvSV(dstr) = sref;
4454 if (!GvIMPORTED_SV(dstr)
4455 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4456 {
4457 GvIMPORTED_SV_on(dstr);
4458 }
4459 break;
4460 }
4461 if (dref)
4462 SvREFCNT_dec(dref);
4463 if (SvTAINTED(sstr))
4464 SvTAINT(dstr);
4465 return;
4466 }
4467 if (SvPVX(dstr)) {
4468 (void)SvOOK_off(dstr); /* backoff */
4469 if (SvLEN(dstr))
4470 Safefree(SvPVX(dstr));
4471 SvLEN(dstr)=SvCUR(dstr)=0;
4472 }
4473 }
4474 (void)SvOK_off(dstr);
4475 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
4476 SvROK_on(dstr);
4477 if (sflags & SVp_NOK) {
4478 SvNOKp_on(dstr);
4479 /* Only set the public OK flag if the source has public OK. */
4480 if (sflags & SVf_NOK)
4481 SvFLAGS(dstr) |= SVf_NOK;
4482 SvNVX(dstr) = SvNVX(sstr);
4483 }
4484 if (sflags & SVp_IOK) {
4485 (void)SvIOKp_on(dstr);
4486 if (sflags & SVf_IOK)
4487 SvFLAGS(dstr) |= SVf_IOK;
4488 if (sflags & SVf_IVisUV)
4489 SvIsUV_on(dstr);
4490 SvIVX(dstr) = SvIVX(sstr);
4491 }
4492 if (SvAMAGIC(sstr)) {
4493 SvAMAGIC_on(dstr);
4494 }
4495 }
4496 else if (sflags & SVp_POK) {
4497 bool isSwipe = 0;
4498
4499 /*
4500 * Check to see if we can just swipe the string. If so, it's a
4501 * possible small lose on short strings, but a big win on long ones.
4502 * It might even be a win on short strings if SvPVX(dstr)
4503 * has to be allocated and SvPVX(sstr) has to be freed.
4504 */
4505
4506 /* Whichever path we take through the next code, we want this true,
4507 and doing it now facilitates the COW check. */
4508 (void)SvPOK_only(dstr);
4509
4510 if (
4511#ifdef PERL_COPY_ON_WRITE
4512 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4513 &&
4514#endif
4515 !(isSwipe =
4516 (sflags & SVs_TEMP) && /* slated for free anyway? */
4517 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4518 (!(flags & SV_NOSTEAL)) &&
4519 /* and we're allowed to steal temps */
4520 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4521 SvLEN(sstr) && /* and really is a string */
4522 /* and won't be needed again, potentially */
4523 !(PL_op && PL_op->op_type == OP_AASSIGN))
4524#ifdef PERL_COPY_ON_WRITE
4525 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4526 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4527 && SvTYPE(sstr) >= SVt_PVIV)
4528#endif
4529 ) {
4530 /* Failed the swipe test, and it's not a shared hash key either.
4531 Have to copy the string. */
4532 STRLEN len = SvCUR(sstr);
4533 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4534 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4535 SvCUR_set(dstr, len);
4536 *SvEND(dstr) = '\0';
4537 } else {
4538 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4539 be true in here. */
4540#ifdef PERL_COPY_ON_WRITE
4541 /* Either it's a shared hash key, or it's suitable for
4542 copy-on-write or we can swipe the string. */
4543 if (DEBUG_C_TEST) {
4544 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4545 sv_dump(sstr);
4546 sv_dump(dstr);
4547 }
4548 if (!isSwipe) {
4549 /* I believe I should acquire a global SV mutex if
4550 it's a COW sv (not a shared hash key) to stop
4551 it going un copy-on-write.
4552 If the source SV has gone un copy on write between up there
4553 and down here, then (assert() that) it is of the correct
4554 form to make it copy on write again */
4555 if ((sflags & (SVf_FAKE | SVf_READONLY))
4556 != (SVf_FAKE | SVf_READONLY)) {
4557 SvREADONLY_on(sstr);
4558 SvFAKE_on(sstr);
4559 /* Make the source SV into a loop of 1.
4560 (about to become 2) */
4561 SV_COW_NEXT_SV_SET(sstr, sstr);
4562 }
4563 }
4564#endif
4565 /* Initial code is common. */
4566 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4567 if (SvOOK(dstr)) {
4568 SvFLAGS(dstr) &= ~SVf_OOK;
4569 Safefree(SvPVX(dstr) - SvIVX(dstr));
4570 }
4571 else if (SvLEN(dstr))
4572 Safefree(SvPVX(dstr));
4573 }
4574
4575#ifdef PERL_COPY_ON_WRITE
4576 if (!isSwipe) {
4577 /* making another shared SV. */
4578 STRLEN cur = SvCUR(sstr);
4579 STRLEN len = SvLEN(sstr);
4580 assert (SvTYPE(dstr) >= SVt_PVIV);
4581 if (len) {
4582 /* SvIsCOW_normal */
4583 /* splice us in between source and next-after-source. */
4584 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4585 SV_COW_NEXT_SV_SET(sstr, dstr);
4586 SvPV_set(dstr, SvPVX(sstr));
4587 } else {
4588 /* SvIsCOW_shared_hash */
4589 UV hash = SvUVX(sstr);
4590 DEBUG_C(PerlIO_printf(Perl_debug_log,
4591 "Copy on write: Sharing hash\n"));
4592 SvPV_set(dstr,
4593 sharepvn(SvPVX(sstr),
4594 (sflags & SVf_UTF8?-cur:cur), hash));
4595 SvUVX(dstr) = hash;
4596 }
4597 SvLEN(dstr) = len;
4598 SvCUR(dstr) = cur;
4599 SvREADONLY_on(dstr);
4600 SvFAKE_on(dstr);
4601 /* Relesase a global SV mutex. */
4602 }
4603 else
4604#endif
4605 { /* Passes the swipe test. */
4606 SvPV_set(dstr, SvPVX(sstr));
4607 SvLEN_set(dstr, SvLEN(sstr));
4608 SvCUR_set(dstr, SvCUR(sstr));
4609
4610 SvTEMP_off(dstr);
4611 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4612 SvPV_set(sstr, Nullch);
4613 SvLEN_set(sstr, 0);
4614 SvCUR_set(sstr, 0);
4615 SvTEMP_off(sstr);
4616 }
4617 }
4618 if (sflags & SVf_UTF8)
4619 SvUTF8_on(dstr);
4620 /*SUPPRESS 560*/
4621 if (sflags & SVp_NOK) {
4622 SvNOKp_on(dstr);
4623 if (sflags & SVf_NOK)
4624 SvFLAGS(dstr) |= SVf_NOK;
4625 SvNVX(dstr) = SvNVX(sstr);
4626 }
4627 if (sflags & SVp_IOK) {
4628 (void)SvIOKp_on(dstr);
4629 if (sflags & SVf_IOK)
4630 SvFLAGS(dstr) |= SVf_IOK;
4631 if (sflags & SVf_IVisUV)
4632 SvIsUV_on(dstr);
4633 SvIVX(dstr) = SvIVX(sstr);
4634 }
4635 if (SvVOK(sstr)) {
4636 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4637 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4638 smg->mg_ptr, smg->mg_len);
4639 SvRMAGICAL_on(dstr);
4640 }
4641 }
4642 else if (sflags & SVp_IOK) {
4643 if (sflags & SVf_IOK)
4644 (void)SvIOK_only(dstr);
4645 else {
4646 (void)SvOK_off(dstr);
4647 (void)SvIOKp_on(dstr);
4648 }
4649 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4650 if (sflags & SVf_IVisUV)
4651 SvIsUV_on(dstr);
4652 SvIVX(dstr) = SvIVX(sstr);
4653 if (sflags & SVp_NOK) {
4654 if (sflags & SVf_NOK)
4655 (void)SvNOK_on(dstr);
4656 else
4657 (void)SvNOKp_on(dstr);
4658 SvNVX(dstr) = SvNVX(sstr);
4659 }
4660 }
4661 else if (sflags & SVp_NOK) {
4662 if (sflags & SVf_NOK)
4663 (void)SvNOK_only(dstr);
4664 else {
4665 (void)SvOK_off(dstr);
4666 SvNOKp_on(dstr);
4667 }
4668 SvNVX(dstr) = SvNVX(sstr);
4669 }
4670 else {
4671 if (dtype == SVt_PVGV) {
4672 if (ckWARN(WARN_MISC))
4673 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4674 }
4675 else
4676 (void)SvOK_off(dstr);
4677 }
4678 if (SvTAINTED(sstr))
4679 SvTAINT(dstr);
4680}
4681
4682/*
4683=for apidoc sv_setsv_mg
4684
4685Like C<sv_setsv>, but also handles 'set' magic.
4686
4687=cut
4688*/
4689
4690void
4691Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4692{
4693 sv_setsv(dstr,sstr);
4694 SvSETMAGIC(dstr);
4695}
4696
4697#ifdef PERL_COPY_ON_WRITE
4698SV *
4699Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4700{
4701 STRLEN cur = SvCUR(sstr);
4702 STRLEN len = SvLEN(sstr);
4703 register char *new_pv;
4704
4705 if (DEBUG_C_TEST) {
4706 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4707 sstr, dstr);
4708 sv_dump(sstr);
4709 if (dstr)
4710 sv_dump(dstr);
4711 }
4712
4713 if (dstr) {
4714 if (SvTHINKFIRST(dstr))
4715 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4716 else if (SvPVX(dstr))
4717 Safefree(SvPVX(dstr));
4718 }
4719 else
4720 new_SV(dstr);
4721 (void)SvUPGRADE (dstr, SVt_PVIV);
4722
4723 assert (SvPOK(sstr));
4724 assert (SvPOKp(sstr));
4725 assert (!SvIOK(sstr));
4726 assert (!SvIOKp(sstr));
4727 assert (!SvNOK(sstr));
4728 assert (!SvNOKp(sstr));
4729
4730 if (SvIsCOW(sstr)) {
4731
4732 if (SvLEN(sstr) == 0) {
4733 /* source is a COW shared hash key. */
4734 UV hash = SvUVX(sstr);
4735 DEBUG_C(PerlIO_printf(Perl_debug_log,
4736 "Fast copy on write: Sharing hash\n"));
4737 SvUVX(dstr) = hash;
4738 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4739 goto common_exit;
4740 }
4741 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4742 } else {
4743 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4744 (void)SvUPGRADE (sstr, SVt_PVIV);
4745 SvREADONLY_on(sstr);
4746 SvFAKE_on(sstr);
4747 DEBUG_C(PerlIO_printf(Perl_debug_log,
4748 "Fast copy on write: Converting sstr to COW\n"));
4749 SV_COW_NEXT_SV_SET(dstr, sstr);
4750 }
4751 SV_COW_NEXT_SV_SET(sstr, dstr);
4752 new_pv = SvPVX(sstr);
4753
4754 common_exit:
4755 SvPV_set(dstr, new_pv);
4756 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4757 if (SvUTF8(sstr))
4758 SvUTF8_on(dstr);
4759 SvLEN(dstr) = len;
4760 SvCUR(dstr) = cur;
4761 if (DEBUG_C_TEST) {
4762 sv_dump(dstr);
4763 }
4764 return dstr;
4765}
4766#endif
4767
4768/*
4769=for apidoc sv_setpvn
4770
4771Copies a string into an SV. The C<len> parameter indicates the number of
4772bytes to be copied. If the C<ptr> argument is NULL the SV will become
4773undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4774
4775=cut
4776*/
4777
4778void
4779Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4780{
4781 register char *dptr;
4782
4783 SV_CHECK_THINKFIRST_COW_DROP(sv);
4784 if (!ptr) {
4785 (void)SvOK_off(sv);
4786 return;
4787 }
4788 else {
4789 /* len is STRLEN which is unsigned, need to copy to signed */
4790 IV iv = len;
4791 if (iv < 0)
4792 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4793 }
4794 (void)SvUPGRADE(sv, SVt_PV);
4795
4796 SvGROW(sv, len + 1);
4797 dptr = SvPVX(sv);
4798 Move(ptr,dptr,len,char);
4799 dptr[len] = '\0';
4800 SvCUR_set(sv, len);
4801 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4802 SvTAINT(sv);
4803}
4804
4805/*
4806=for apidoc sv_setpvn_mg
4807
4808Like C<sv_setpvn>, but also handles 'set' magic.
4809
4810=cut
4811*/
4812
4813void
4814Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4815{
4816 sv_setpvn(sv,ptr,len);
4817 SvSETMAGIC(sv);
4818}
4819
4820/*
4821=for apidoc sv_setpv
4822
4823Copies a string into an SV. The string must be null-terminated. Does not
4824handle 'set' magic. See C<sv_setpv_mg>.
4825
4826=cut
4827*/
4828
4829void
4830Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4831{
4832 register STRLEN len;
4833
4834 SV_CHECK_THINKFIRST_COW_DROP(sv);
4835 if (!ptr) {
4836 (void)SvOK_off(sv);
4837 return;
4838 }
4839 len = strlen(ptr);
4840 (void)SvUPGRADE(sv, SVt_PV);
4841
4842 SvGROW(sv, len + 1);
4843 Move(ptr,SvPVX(sv),len+1,char);
4844 SvCUR_set(sv, len);
4845 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4846 SvTAINT(sv);
4847}
4848
4849/*
4850=for apidoc sv_setpv_mg
4851
4852Like C<sv_setpv>, but also handles 'set' magic.
4853
4854=cut
4855*/
4856
4857void
4858Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4859{
4860 sv_setpv(sv,ptr);
4861 SvSETMAGIC(sv);
4862}
4863
4864/*
4865=for apidoc sv_usepvn
4866
4867Tells an SV to use C<ptr> to find its string value. Normally the string is
4868stored inside the SV but sv_usepvn allows the SV to use an outside string.
4869The C<ptr> should point to memory that was allocated by C<malloc>. The
4870string length, C<len>, must be supplied. This function will realloc the
4871memory pointed to by C<ptr>, so that pointer should not be freed or used by
4872the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4873See C<sv_usepvn_mg>.
4874
4875=cut
4876*/
4877
4878void
4879Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4880{
4881 SV_CHECK_THINKFIRST_COW_DROP(sv);
4882 (void)SvUPGRADE(sv, SVt_PV);
4883 if (!ptr) {
4884 (void)SvOK_off(sv);
4885 return;
4886 }
4887 (void)SvOOK_off(sv);
4888 if (SvPVX(sv) && SvLEN(sv))
4889 Safefree(SvPVX(sv));
4890 Renew(ptr, len+1, char);
4891 SvPVX(sv) = ptr;
4892 SvCUR_set(sv, len);
4893 SvLEN_set(sv, len+1);
4894 *SvEND(sv) = '\0';
4895 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4896 SvTAINT(sv);
4897}
4898
4899/*
4900=for apidoc sv_usepvn_mg
4901
4902Like C<sv_usepvn>, but also handles 'set' magic.
4903
4904=cut
4905*/
4906
4907void
4908Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4909{
4910 sv_usepvn(sv,ptr,len);
4911 SvSETMAGIC(sv);
4912}
4913
4914#ifdef PERL_COPY_ON_WRITE
4915/* Need to do this *after* making the SV normal, as we need the buffer
4916 pointer to remain valid until after we've copied it. If we let go too early,
4917 another thread could invalidate it by unsharing last of the same hash key
4918 (which it can do by means other than releasing copy-on-write Svs)
4919 or by changing the other copy-on-write SVs in the loop. */
4920STATIC void
4921S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4922 U32 hash, SV *after)
4923{
4924 if (len) { /* this SV was SvIsCOW_normal(sv) */
4925 /* we need to find the SV pointing to us. */
4926 SV *current = SV_COW_NEXT_SV(after);
4927
4928 if (current == sv) {
4929 /* The SV we point to points back to us (there were only two of us
4930 in the loop.)
4931 Hence other SV is no longer copy on write either. */
4932 SvFAKE_off(after);
4933 SvREADONLY_off(after);
4934 } else {
4935 /* We need to follow the pointers around the loop. */
4936 SV *next;
4937 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4938 assert (next);
4939 current = next;
4940 /* don't loop forever if the structure is bust, and we have
4941 a pointer into a closed loop. */
4942 assert (current != after);
4943 assert (SvPVX(current) == pvx);
4944 }
4945 /* Make the SV before us point to the SV after us. */
4946 SV_COW_NEXT_SV_SET(current, after);
4947 }
4948 } else {
4949 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4950 }
4951}
4952
4953int
4954Perl_sv_release_IVX(pTHX_ register SV *sv)
4955{
4956 if (SvIsCOW(sv))
4957 sv_force_normal_flags(sv, 0);
4958 SvOOK_off(sv);
4959 return 0;
4960}
4961#endif
4962/*
4963=for apidoc sv_force_normal_flags
4964
4965Undo various types of fakery on an SV: if the PV is a shared string, make
4966a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4967an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4968we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4969then a copy-on-write scalar drops its PV buffer (if any) and becomes
4970SvPOK_off rather than making a copy. (Used where this scalar is about to be
4971set to some other value.) In addition, the C<flags> parameter gets passed to
4972C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4973with flags set to 0.
4974
4975=cut
4976*/
4977
4978void
4979Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4980{
4981#ifdef PERL_COPY_ON_WRITE
4982 if (SvREADONLY(sv)) {
4983 /* At this point I believe I should acquire a global SV mutex. */
4984 if (SvFAKE(sv)) {
4985 char *pvx = SvPVX(sv);
4986 STRLEN len = SvLEN(sv);
4987 STRLEN cur = SvCUR(sv);
4988 U32 hash = SvUVX(sv);
4989 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4990 if (DEBUG_C_TEST) {
4991 PerlIO_printf(Perl_debug_log,
4992 "Copy on write: Force normal %ld\n",
4993 (long) flags);
4994 sv_dump(sv);
4995 }
4996 SvFAKE_off(sv);
4997 SvREADONLY_off(sv);
4998 /* This SV doesn't own the buffer, so need to New() a new one: */
4999 SvPVX(sv) = 0;
5000 SvLEN(sv) = 0;
5001 if (flags & SV_COW_DROP_PV) {
5002 /* OK, so we don't need to copy our buffer. */
5003 SvPOK_off(sv);
5004 } else {
5005 SvGROW(sv, cur + 1);
5006 Move(pvx,SvPVX(sv),cur,char);
5007 SvCUR(sv) = cur;
5008 *SvEND(sv) = '\0';
5009 }
5010 sv_release_COW(sv, pvx, cur, len, hash, next);
5011 if (DEBUG_C_TEST) {
5012 sv_dump(sv);
5013 }
5014 }
5015 else if (IN_PERL_RUNTIME)
5016 Perl_croak(aTHX_ PL_no_modify);
5017 /* At this point I believe that I can drop the global SV mutex. */
5018 }
5019#else
5020 if (SvREADONLY(sv)) {
5021 if (SvFAKE(sv)) {
5022 char *pvx = SvPVX(sv);
5023 int is_utf8 = SvUTF8(sv);
5024 STRLEN len = SvCUR(sv);
5025 U32 hash = SvUVX(sv);
5026 SvFAKE_off(sv);
5027 SvREADONLY_off(sv);
5028 SvPVX(sv) = 0;
5029 SvLEN(sv) = 0;
5030 SvGROW(sv, len + 1);
5031 Move(pvx,SvPVX(sv),len,char);
5032 *SvEND(sv) = '\0';
5033 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
5034 }
5035 else if (IN_PERL_RUNTIME)
5036 Perl_croak(aTHX_ PL_no_modify);
5037 }
5038#endif
5039 if (SvROK(sv))
5040 sv_unref_flags(sv, flags);
5041 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
5042 sv_unglob(sv);
5043}
5044
5045/*
5046=for apidoc sv_force_normal
5047
5048Undo various types of fakery on an SV: if the PV is a shared string, make
5049a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5050an xpvmg. See also C<sv_force_normal_flags>.
5051
5052=cut
5053*/
5054
5055void
5056Perl_sv_force_normal(pTHX_ register SV *sv)
5057{
5058 sv_force_normal_flags(sv, 0);
5059}
5060
5061/*
5062=for apidoc sv_chop
5063
5064Efficient removal of characters from the beginning of the string buffer.
5065SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5066the string buffer. The C<ptr> becomes the first character of the adjusted
5067string. Uses the "OOK hack".
5068Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
5069refer to the same chunk of data.
5070
5071=cut
5072*/
5073
5074void
5075Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
5076{
5077 register STRLEN delta;
5078 if (!ptr || !SvPOKp(sv))
5079 return;
5080 delta = ptr - SvPVX(sv);
5081 SV_CHECK_THINKFIRST(sv);
5082 if (SvTYPE(sv) < SVt_PVIV)
5083 sv_upgrade(sv,SVt_PVIV);
5084
5085 if (!SvOOK(sv)) {
5086 if (!SvLEN(sv)) { /* make copy of shared string */
5087 char *pvx = SvPVX(sv);
5088 STRLEN len = SvCUR(sv);
5089 SvGROW(sv, len + 1);
5090 Move(pvx,SvPVX(sv),len,char);
5091 *SvEND(sv) = '\0';
5092 }
5093 SvIVX(sv) = 0;
5094 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5095 and we do that anyway inside the SvNIOK_off
5096 */
5097 SvFLAGS(sv) |= SVf_OOK;
5098 }
5099 SvNIOK_off(sv);
5100 SvLEN(sv) -= delta;
5101 SvCUR(sv) -= delta;
5102 SvPVX(sv) += delta;
5103 SvIVX(sv) += delta;
5104}
5105
5106/* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5107 * this function provided for binary compatibility only
5108 */
5109
5110void
5111Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5112{
5113 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5114}
5115
5116/*
5117=for apidoc sv_catpvn
5118
5119Concatenates the string onto the end of the string which is in the SV. The
5120C<len> indicates number of bytes to copy. If the SV has the UTF-8
5121status set, then the bytes appended should be valid UTF-8.
5122Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5123
5124=for apidoc sv_catpvn_flags
5125
5126Concatenates the string onto the end of the string which is in the SV. The
5127C<len> indicates number of bytes to copy. If the SV has the UTF-8
5128status set, then the bytes appended should be valid UTF-8.
5129If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5130appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5131in terms of this function.
5132
5133=cut
5134*/
5135
5136void
5137Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5138{
5139 STRLEN dlen;
5140 char *dstr;
5141
5142 dstr = SvPV_force_flags(dsv, dlen, flags);
5143 SvGROW(dsv, dlen + slen + 1);
5144 if (sstr == dstr)
5145 sstr = SvPVX(dsv);
5146 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5147 SvCUR(dsv) += slen;
5148 *SvEND(dsv) = '\0';
5149 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5150 SvTAINT(dsv);
5151}
5152
5153/*
5154=for apidoc sv_catpvn_mg
5155
5156Like C<sv_catpvn>, but also handles 'set' magic.
5157
5158=cut
5159*/
5160
5161void
5162Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5163{
5164 sv_catpvn(sv,ptr,len);
5165 SvSETMAGIC(sv);
5166}
5167
5168/* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5169 * this function provided for binary compatibility only
5170 */
5171
5172void
5173Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5174{
5175 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5176}
5177
5178/*
5179=for apidoc sv_catsv
5180
5181Concatenates the string from SV C<ssv> onto the end of the string in
5182SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5183not 'set' magic. See C<sv_catsv_mg>.
5184
5185=for apidoc sv_catsv_flags
5186
5187Concatenates the string from SV C<ssv> onto the end of the string in
5188SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5189bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5190and C<sv_catsv_nomg> are implemented in terms of this function.
5191
5192=cut */
5193
5194void
5195Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5196{
5197 char *spv;
5198 STRLEN slen;
5199 if (!ssv)
5200 return;
5201 if ((spv = SvPV(ssv, slen))) {
5202 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5203 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5204 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5205 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5206 dsv->sv_flags doesn't have that bit set.
5207 Andy Dougherty 12 Oct 2001
5208 */
5209 I32 sutf8 = DO_UTF8(ssv);
5210 I32 dutf8;
5211
5212 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5213 mg_get(dsv);
5214 dutf8 = DO_UTF8(dsv);
5215
5216 if (dutf8 != sutf8) {
5217 if (dutf8) {
5218 /* Not modifying source SV, so taking a temporary copy. */
5219 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5220
5221 sv_utf8_upgrade(csv);
5222 spv = SvPV(csv, slen);
5223 }
5224 else
5225 sv_utf8_upgrade_nomg(dsv);
5226 }
5227 sv_catpvn_nomg(dsv, spv, slen);
5228 }
5229}
5230
5231/*
5232=for apidoc sv_catsv_mg
5233
5234Like C<sv_catsv>, but also handles 'set' magic.
5235
5236=cut
5237*/
5238
5239void
5240Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5241{
5242 sv_catsv(dsv,ssv);
5243 SvSETMAGIC(dsv);
5244}
5245
5246/*
5247=for apidoc sv_catpv
5248
5249Concatenates the string onto the end of the string which is in the SV.
5250If the SV has the UTF-8 status set, then the bytes appended should be
5251valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5252
5253=cut */
5254
5255void
5256Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5257{
5258 register STRLEN len;
5259 STRLEN tlen;
5260 char *junk;
5261
5262 if (!ptr)
5263 return;
5264 junk = SvPV_force(sv, tlen);
5265 len = strlen(ptr);
5266 SvGROW(sv, tlen + len + 1);
5267 if (ptr == junk)
5268 ptr = SvPVX(sv);
5269 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5270 SvCUR(sv) += len;
5271 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5272 SvTAINT(sv);
5273}
5274
5275/*
5276=for apidoc sv_catpv_mg
5277
5278Like C<sv_catpv>, but also handles 'set' magic.
5279
5280=cut
5281*/
5282
5283void
5284Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5285{
5286 sv_catpv(sv,ptr);
5287 SvSETMAGIC(sv);
5288}
5289
5290/*
5291=for apidoc newSV
5292
5293Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5294with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5295macro.
5296
5297=cut
5298*/
5299
5300SV *
5301Perl_newSV(pTHX_ STRLEN len)
5302{
5303 register SV *sv;
5304
5305 new_SV(sv);
5306 if (len) {
5307 sv_upgrade(sv, SVt_PV);
5308 SvGROW(sv, len + 1);
5309 }
5310 return sv;
5311}
5312/*
5313=for apidoc sv_magicext
5314
5315Adds magic to an SV, upgrading it if necessary. Applies the
5316supplied vtable and returns a pointer to the magic added.
5317
5318Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5319In particular, you can add magic to SvREADONLY SVs, and add more than
5320one instance of the same 'how'.
5321
5322If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5323stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5324special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5325to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5326
5327(This is now used as a subroutine by C<sv_magic>.)
5328
5329=cut
5330*/
5331MAGIC *
5332Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
5333 const char* name, I32 namlen)
5334{
5335 MAGIC* mg;
5336
5337 if (SvTYPE(sv) < SVt_PVMG) {
5338 (void)SvUPGRADE(sv, SVt_PVMG);
5339 }
5340 Newz(702,mg, 1, MAGIC);
5341 mg->mg_moremagic = SvMAGIC(sv);
5342 SvMAGIC(sv) = mg;
5343
5344 /* Sometimes a magic contains a reference loop, where the sv and
5345 object refer to each other. To prevent a reference loop that
5346 would prevent such objects being freed, we look for such loops
5347 and if we find one we avoid incrementing the object refcount.
5348
5349 Note we cannot do this to avoid self-tie loops as intervening RV must
5350 have its REFCNT incremented to keep it in existence.
5351
5352 */
5353 if (!obj || obj == sv ||
5354 how == PERL_MAGIC_arylen ||
5355 how == PERL_MAGIC_qr ||
5356 (SvTYPE(obj) == SVt_PVGV &&
5357 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5358 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5359 GvFORM(obj) == (CV*)sv)))
5360 {
5361 mg->mg_obj = obj;
5362 }
5363 else {
5364 mg->mg_obj = SvREFCNT_inc(obj);
5365 mg->mg_flags |= MGf_REFCOUNTED;
5366 }
5367
5368 /* Normal self-ties simply pass a null object, and instead of
5369 using mg_obj directly, use the SvTIED_obj macro to produce a
5370 new RV as needed. For glob "self-ties", we are tieing the PVIO
5371 with an RV obj pointing to the glob containing the PVIO. In
5372 this case, to avoid a reference loop, we need to weaken the
5373 reference.
5374 */
5375
5376 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5377 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5378 {
5379 sv_rvweaken(obj);
5380 }
5381
5382 mg->mg_type = how;
5383 mg->mg_len = namlen;
5384 if (name) {
5385 if (namlen > 0)
5386 mg->mg_ptr = savepvn(name, namlen);
5387 else if (namlen == HEf_SVKEY)
5388 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5389 else
5390 mg->mg_ptr = (char *) name;
5391 }
5392 mg->mg_virtual = vtable;
5393
5394 mg_magical(sv);
5395 if (SvGMAGICAL(sv))
5396 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5397 return mg;
5398}
5399
5400/*
5401=for apidoc sv_magic
5402
5403Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5404then adds a new magic item of type C<how> to the head of the magic list.
5405
5406See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5407handling of the C<name> and C<namlen> arguments.
5408
5409You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5410to add more than one instance of the same 'how'.
5411
5412=cut
5413*/
5414
5415void
5416Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5417{
5418 MAGIC* mg;
5419 MGVTBL *vtable = 0;
5420
5421#ifdef PERL_COPY_ON_WRITE
5422 if (SvIsCOW(sv))
5423 sv_force_normal_flags(sv, 0);
5424#endif
5425 if (SvREADONLY(sv)) {
5426 if (IN_PERL_RUNTIME
5427 && how != PERL_MAGIC_regex_global
5428 && how != PERL_MAGIC_bm
5429 && how != PERL_MAGIC_fm
5430 && how != PERL_MAGIC_sv
5431 && how != PERL_MAGIC_backref
5432 )
5433 {
5434 Perl_croak(aTHX_ PL_no_modify);
5435 }
5436 }
5437 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5438 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5439 /* sv_magic() refuses to add a magic of the same 'how' as an
5440 existing one
5441 */
5442 if (how == PERL_MAGIC_taint)
5443 mg->mg_len |= 1;
5444 return;
5445 }
5446 }
5447
5448 switch (how) {
5449 case PERL_MAGIC_sv:
5450 vtable = &PL_vtbl_sv;
5451 break;
5452 case PERL_MAGIC_overload:
5453 vtable = &PL_vtbl_amagic;
5454 break;
5455 case PERL_MAGIC_overload_elem:
5456 vtable = &PL_vtbl_amagicelem;
5457 break;
5458 case PERL_MAGIC_overload_table:
5459 vtable = &PL_vtbl_ovrld;
5460 break;
5461 case PERL_MAGIC_bm:
5462 vtable = &PL_vtbl_bm;
5463 break;
5464 case PERL_MAGIC_regdata:
5465 vtable = &PL_vtbl_regdata;
5466 break;
5467 case PERL_MAGIC_regdatum:
5468 vtable = &PL_vtbl_regdatum;
5469 break;
5470 case PERL_MAGIC_env:
5471 vtable = &PL_vtbl_env;
5472 break;
5473 case PERL_MAGIC_fm:
5474 vtable = &PL_vtbl_fm;
5475 break;
5476 case PERL_MAGIC_envelem:
5477 vtable = &PL_vtbl_envelem;
5478 break;
5479 case PERL_MAGIC_regex_global:
5480 vtable = &PL_vtbl_mglob;
5481 break;
5482 case PERL_MAGIC_isa:
5483 vtable = &PL_vtbl_isa;
5484 break;
5485 case PERL_MAGIC_isaelem:
5486 vtable = &PL_vtbl_isaelem;
5487 break;
5488 case PERL_MAGIC_nkeys:
5489 vtable = &PL_vtbl_nkeys;
5490 break;
5491 case PERL_MAGIC_dbfile:
5492 vtable = 0;
5493 break;
5494 case PERL_MAGIC_dbline:
5495 vtable = &PL_vtbl_dbline;
5496 break;
5497#ifdef USE_LOCALE_COLLATE
5498 case PERL_MAGIC_collxfrm:
5499 vtable = &PL_vtbl_collxfrm;
5500 break;
5501#endif /* USE_LOCALE_COLLATE */
5502 case PERL_MAGIC_tied:
5503 vtable = &PL_vtbl_pack;
5504 break;
5505 case PERL_MAGIC_tiedelem:
5506 case PERL_MAGIC_tiedscalar:
5507 vtable = &PL_vtbl_packelem;
5508 break;
5509 case PERL_MAGIC_qr:
5510 vtable = &PL_vtbl_regexp;
5511 break;
5512 case PERL_MAGIC_sig:
5513 vtable = &PL_vtbl_sig;
5514 break;
5515 case PERL_MAGIC_sigelem:
5516 vtable = &PL_vtbl_sigelem;
5517 break;
5518 case PERL_MAGIC_taint:
5519 vtable = &PL_vtbl_taint;
5520 break;
5521 case PERL_MAGIC_uvar:
5522 vtable = &PL_vtbl_uvar;
5523 break;
5524 case PERL_MAGIC_vec:
5525 vtable = &PL_vtbl_vec;
5526 break;
5527 case PERL_MAGIC_vstring:
5528 vtable = 0;
5529 break;
5530 case PERL_MAGIC_utf8:
5531 vtable = &PL_vtbl_utf8;
5532 break;
5533 case PERL_MAGIC_substr:
5534 vtable = &PL_vtbl_substr;
5535 break;
5536 case PERL_MAGIC_defelem:
5537 vtable = &PL_vtbl_defelem;
5538 break;
5539 case PERL_MAGIC_glob:
5540 vtable = &PL_vtbl_glob;
5541 break;
5542 case PERL_MAGIC_arylen:
5543 vtable = &PL_vtbl_arylen;
5544 break;
5545 case PERL_MAGIC_pos:
5546 vtable = &PL_vtbl_pos;
5547 break;
5548 case PERL_MAGIC_backref:
5549 vtable = &PL_vtbl_backref;
5550 break;
5551 case PERL_MAGIC_ext:
5552 /* Reserved for use by extensions not perl internals. */
5553 /* Useful for attaching extension internal data to perl vars. */
5554 /* Note that multiple extensions may clash if magical scalars */
5555 /* etc holding private data from one are passed to another. */
5556 break;
5557 default:
5558 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5559 }
5560
5561 /* Rest of work is done else where */
5562 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5563
5564 switch (how) {
5565 case PERL_MAGIC_taint:
5566 mg->mg_len = 1;
5567 break;
5568 case PERL_MAGIC_ext:
5569 case PERL_MAGIC_dbfile:
5570 SvRMAGICAL_on(sv);
5571 break;
5572 }
5573}
5574
5575/*
5576=for apidoc sv_unmagic
5577
5578Removes all magic of type C<type> from an SV.
5579
5580=cut
5581*/
5582
5583int
5584Perl_sv_unmagic(pTHX_ SV *sv, int type)
5585{
5586 MAGIC* mg;
5587 MAGIC** mgp;
5588 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5589 return 0;
5590 mgp = &SvMAGIC(sv);
5591 for (mg = *mgp; mg; mg = *mgp) {
5592 if (mg->mg_type == type) {
5593 MGVTBL* vtbl = mg->mg_virtual;
5594 *mgp = mg->mg_moremagic;
5595 if (vtbl && vtbl->svt_free)
5596 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5597 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5598 if (mg->mg_len > 0)
5599 Safefree(mg->mg_ptr);
5600 else if (mg->mg_len == HEf_SVKEY)
5601 SvREFCNT_dec((SV*)mg->mg_ptr);
5602 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5603 Safefree(mg->mg_ptr);
5604 }
5605 if (mg->mg_flags & MGf_REFCOUNTED)
5606 SvREFCNT_dec(mg->mg_obj);
5607 Safefree(mg);
5608 }
5609 else
5610 mgp = &mg->mg_moremagic;
5611 }
5612 if (!SvMAGIC(sv)) {
5613 SvMAGICAL_off(sv);
5614 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5615 }
5616
5617 return 0;
5618}
5619
5620/*
5621=for apidoc sv_rvweaken
5622
5623Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5624referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5625push a back-reference to this RV onto the array of backreferences
5626associated with that magic.
5627
5628=cut
5629*/
5630
5631SV *
5632Perl_sv_rvweaken(pTHX_ SV *sv)
5633{
5634 SV *tsv;
5635 if (!SvOK(sv)) /* let undefs pass */
5636 return sv;
5637 if (!SvROK(sv))
5638 Perl_croak(aTHX_ "Can't weaken a nonreference");
5639 else if (SvWEAKREF(sv)) {
5640 if (ckWARN(WARN_MISC))
5641 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5642 return sv;
5643 }
5644 tsv = SvRV(sv);
5645 sv_add_backref(tsv, sv);
5646 SvWEAKREF_on(sv);
5647 SvREFCNT_dec(tsv);
5648 return sv;
5649}
5650
5651/* Give tsv backref magic if it hasn't already got it, then push a
5652 * back-reference to sv onto the array associated with the backref magic.
5653 */
5654
5655STATIC void
5656S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5657{
5658 AV *av;
5659 MAGIC *mg;
5660 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5661 av = (AV*)mg->mg_obj;
5662 else {
5663 av = newAV();
5664 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5665 /* av now has a refcnt of 2, which avoids it getting freed
5666 * before us during global cleanup. The extra ref is removed
5667 * by magic_killbackrefs() when tsv is being freed */
5668 }
5669 if (AvFILLp(av) >= AvMAX(av)) {
5670 I32 i;
5671 SV **svp = AvARRAY(av);
5672 for (i = AvFILLp(av); i >= 0; i--)
5673 if (!svp[i]) {
5674 svp[i] = sv; /* reuse the slot */
5675 return;
5676 }
5677 av_extend(av, AvFILLp(av)+1);
5678 }
5679 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5680}
5681
5682/* delete a back-reference to ourselves from the backref magic associated
5683 * with the SV we point to.
5684 */
5685
5686STATIC void
5687S_sv_del_backref(pTHX_ SV *sv)
5688{
5689 AV *av;
5690 SV **svp;
5691 I32 i;
5692 SV *tsv = SvRV(sv);
5693 MAGIC *mg = NULL;
5694 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5695 Perl_croak(aTHX_ "panic: del_backref");
5696 av = (AV *)mg->mg_obj;
5697 svp = AvARRAY(av);
5698 for (i = AvFILLp(av); i >= 0; i--)
5699 if (svp[i] == sv) svp[i] = Nullsv;
5700}
5701
5702/*
5703=for apidoc sv_insert
5704
5705Inserts a string at the specified offset/length within the SV. Similar to
5706the Perl substr() function.
5707
5708=cut
5709*/
5710
5711void
5712Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5713{
5714 register char *big;
5715 register char *mid;
5716 register char *midend;
5717 register char *bigend;
5718 register I32 i;
5719 STRLEN curlen;
5720
5721
5722 if (!bigstr)
5723 Perl_croak(aTHX_ "Can't modify non-existent substring");
5724 SvPV_force(bigstr, curlen);
5725 (void)SvPOK_only_UTF8(bigstr);
5726 if (offset + len > curlen) {
5727 SvGROW(bigstr, offset+len+1);
5728 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5729 SvCUR_set(bigstr, offset+len);
5730 }
5731
5732 SvTAINT(bigstr);
5733 i = littlelen - len;
5734 if (i > 0) { /* string might grow */
5735 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5736 mid = big + offset + len;
5737 midend = bigend = big + SvCUR(bigstr);
5738 bigend += i;
5739 *bigend = '\0';
5740 while (midend > mid) /* shove everything down */
5741 *--bigend = *--midend;
5742 Move(little,big+offset,littlelen,char);
5743 SvCUR(bigstr) += i;
5744 SvSETMAGIC(bigstr);
5745 return;
5746 }
5747 else if (i == 0) {
5748 Move(little,SvPVX(bigstr)+offset,len,char);
5749 SvSETMAGIC(bigstr);
5750 return;
5751 }
5752
5753 big = SvPVX(bigstr);
5754 mid = big + offset;
5755 midend = mid + len;
5756 bigend = big + SvCUR(bigstr);
5757
5758 if (midend > bigend)
5759 Perl_croak(aTHX_ "panic: sv_insert");
5760
5761 if (mid - big > bigend - midend) { /* faster to shorten from end */
5762 if (littlelen) {
5763 Move(little, mid, littlelen,char);
5764 mid += littlelen;
5765 }
5766 i = bigend - midend;
5767 if (i > 0) {
5768 Move(midend, mid, i,char);
5769 mid += i;
5770 }
5771 *mid = '\0';
5772 SvCUR_set(bigstr, mid - big);
5773 }
5774 /*SUPPRESS 560*/
5775 else if ((i = mid - big)) { /* faster from front */
5776 midend -= littlelen;
5777 mid = midend;
5778 sv_chop(bigstr,midend-i);
5779 big += i;
5780 while (i--)
5781 *--midend = *--big;
5782 if (littlelen)
5783 Move(little, mid, littlelen,char);
5784 }
5785 else if (littlelen) {
5786 midend -= littlelen;
5787 sv_chop(bigstr,midend);
5788 Move(little,midend,littlelen,char);
5789 }
5790 else {
5791 sv_chop(bigstr,midend);
5792 }
5793 SvSETMAGIC(bigstr);
5794}
5795
5796/*
5797=for apidoc sv_replace
5798
5799Make the first argument a copy of the second, then delete the original.
5800The target SV physically takes over ownership of the body of the source SV
5801and inherits its flags; however, the target keeps any magic it owns,
5802and any magic in the source is discarded.
5803Note that this is a rather specialist SV copying operation; most of the
5804time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5805
5806=cut
5807*/
5808
5809void
5810Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5811{
5812 U32 refcnt = SvREFCNT(sv);
5813 SV_CHECK_THINKFIRST_COW_DROP(sv);
5814 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5815 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5816 if (SvMAGICAL(sv)) {
5817 if (SvMAGICAL(nsv))
5818 mg_free(nsv);
5819 else
5820 sv_upgrade(nsv, SVt_PVMG);
5821 SvMAGIC(nsv) = SvMAGIC(sv);
5822 SvFLAGS(nsv) |= SvMAGICAL(sv);
5823 SvMAGICAL_off(sv);
5824 SvMAGIC(sv) = 0;
5825 }
5826 SvREFCNT(sv) = 0;
5827 sv_clear(sv);
5828 assert(!SvREFCNT(sv));
5829 StructCopy(nsv,sv,SV);
5830#ifdef PERL_COPY_ON_WRITE
5831 if (SvIsCOW_normal(nsv)) {
5832 /* We need to follow the pointers around the loop to make the
5833 previous SV point to sv, rather than nsv. */
5834 SV *next;
5835 SV *current = nsv;
5836 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5837 assert(next);
5838 current = next;
5839 assert(SvPVX(current) == SvPVX(nsv));
5840 }
5841 /* Make the SV before us point to the SV after us. */
5842 if (DEBUG_C_TEST) {
5843 PerlIO_printf(Perl_debug_log, "previous is\n");
5844 sv_dump(current);
5845 PerlIO_printf(Perl_debug_log,
5846 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5847 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5848 }
5849 SV_COW_NEXT_SV_SET(current, sv);
5850 }
5851#endif
5852 SvREFCNT(sv) = refcnt;
5853 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5854 SvREFCNT(nsv) = 0;
5855 del_SV(nsv);
5856}
5857
5858/*
5859=for apidoc sv_clear
5860
5861Clear an SV: call any destructors, free up any memory used by the body,
5862and free the body itself. The SV's head is I<not> freed, although
5863its type is set to all 1's so that it won't inadvertently be assumed
5864to be live during global destruction etc.
5865This function should only be called when REFCNT is zero. Most of the time
5866you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5867instead.
5868
5869=cut
5870*/
5871
5872void
5873Perl_sv_clear(pTHX_ register SV *sv)
5874{
5875 HV* stash;
5876 assert(sv);
5877 assert(SvREFCNT(sv) == 0);
5878
5879 if (SvOBJECT(sv)) {
5880 if (PL_defstash) { /* Still have a symbol table? */
5881 dSP;
5882 CV* destructor;
5883
5884
5885
5886 do {
5887 stash = SvSTASH(sv);
5888 destructor = StashHANDLER(stash,DESTROY);
5889 if (destructor) {
5890 SV* tmpref = newRV(sv);
5891 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5892 ENTER;
5893 PUSHSTACKi(PERLSI_DESTROY);
5894 EXTEND(SP, 2);
5895 PUSHMARK(SP);
5896 PUSHs(tmpref);
5897 PUTBACK;
5898 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5899
5900
5901 POPSTACK;
5902 SPAGAIN;
5903 LEAVE;
5904 if(SvREFCNT(tmpref) < 2) {
5905 /* tmpref is not kept alive! */
5906 SvREFCNT(sv)--;
5907 SvRV(tmpref) = 0;
5908 SvROK_off(tmpref);
5909 }
5910 SvREFCNT_dec(tmpref);
5911 }
5912 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5913
5914
5915 if (SvREFCNT(sv)) {
5916 if (PL_in_clean_objs)
5917 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5918 HvNAME(stash));
5919 /* DESTROY gave object new lease on life */
5920 return;
5921 }
5922 }
5923
5924 if (SvOBJECT(sv)) {
5925 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5926 SvOBJECT_off(sv); /* Curse the object. */
5927 if (SvTYPE(sv) != SVt_PVIO)
5928 --PL_sv_objcount; /* XXX Might want something more general */
5929 }
5930 }
5931 if (SvTYPE(sv) >= SVt_PVMG) {
5932 if (SvMAGIC(sv))
5933 mg_free(sv);
5934 if (SvFLAGS(sv) & SVpad_TYPED)
5935 SvREFCNT_dec(SvSTASH(sv));
5936 }
5937 stash = NULL;
5938 switch (SvTYPE(sv)) {
5939 case SVt_PVIO:
5940 if (IoIFP(sv) &&
5941 IoIFP(sv) != PerlIO_stdin() &&
5942 IoIFP(sv) != PerlIO_stdout() &&
5943 IoIFP(sv) != PerlIO_stderr())
5944 {
5945 io_close((IO*)sv, FALSE);
5946 }
5947 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5948 PerlDir_close(IoDIRP(sv));
5949 IoDIRP(sv) = (DIR*)NULL;
5950 Safefree(IoTOP_NAME(sv));
5951 Safefree(IoFMT_NAME(sv));
5952 Safefree(IoBOTTOM_NAME(sv));
5953 /* FALL THROUGH */
5954 case SVt_PVBM:
5955 goto freescalar;
5956 case SVt_PVCV:
5957 case SVt_PVFM:
5958 cv_undef((CV*)sv);
5959 goto freescalar;
5960 case SVt_PVHV:
5961 hv_undef((HV*)sv);
5962 break;
5963 case SVt_PVAV:
5964 av_undef((AV*)sv);
5965 break;
5966 case SVt_PVLV:
5967 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5968 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5969 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5970 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5971 }
5972 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5973 SvREFCNT_dec(LvTARG(sv));
5974 goto freescalar;
5975 case SVt_PVGV:
5976 gp_free((GV*)sv);
5977 Safefree(GvNAME(sv));
5978 /* cannot decrease stash refcount yet, as we might recursively delete
5979 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5980 of stash until current sv is completely gone.
5981 -- JohnPC, 27 Mar 1998 */
5982 stash = GvSTASH(sv);
5983 /* FALL THROUGH */
5984 case SVt_PVMG:
5985 case SVt_PVNV:
5986 case SVt_PVIV:
5987 freescalar:
5988 SvOOK_off(sv);
5989 /* FALL THROUGH */
5990 case SVt_PV:
5991 case SVt_RV:
5992 if (SvROK(sv)) {
5993 if (SvWEAKREF(sv))
5994 sv_del_backref(sv);
5995 else
5996 SvREFCNT_dec(SvRV(sv));
5997 }
5998#ifdef PERL_COPY_ON_WRITE
5999 else if (SvPVX(sv)) {
6000 if (SvIsCOW(sv)) {
6001 /* I believe I need to grab the global SV mutex here and
6002 then recheck the COW status. */
6003 if (DEBUG_C_TEST) {
6004 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6005 sv_dump(sv);
6006 }
6007 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
6008 SvUVX(sv), SV_COW_NEXT_SV(sv));
6009 /* And drop it here. */
6010 SvFAKE_off(sv);
6011 } else if (SvLEN(sv)) {
6012 Safefree(SvPVX(sv));
6013 }
6014 }
6015#else
6016 else if (SvPVX(sv) && SvLEN(sv))
6017 Safefree(SvPVX(sv));
6018 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6019 unsharepvn(SvPVX(sv),
6020 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
6021 SvUVX(sv));
6022 SvFAKE_off(sv);
6023 }
6024#endif
6025 break;
6026/*
6027 case SVt_NV:
6028 case SVt_IV:
6029 case SVt_NULL:
6030 break;
6031*/
6032 }
6033
6034 switch (SvTYPE(sv)) {
6035 case SVt_NULL:
6036 break;
6037 case SVt_IV:
6038 del_XIV(SvANY(sv));
6039 break;
6040 case SVt_NV:
6041 del_XNV(SvANY(sv));
6042 break;
6043 case SVt_RV:
6044 del_XRV(SvANY(sv));
6045 break;
6046 case SVt_PV:
6047 del_XPV(SvANY(sv));
6048 break;
6049 case SVt_PVIV:
6050 del_XPVIV(SvANY(sv));
6051 break;
6052 case SVt_PVNV:
6053 del_XPVNV(SvANY(sv));
6054 break;
6055 case SVt_PVMG:
6056 del_XPVMG(SvANY(sv));
6057 break;
6058 case SVt_PVLV:
6059 del_XPVLV(SvANY(sv));
6060 break;
6061 case SVt_PVAV:
6062 del_XPVAV(SvANY(sv));
6063 break;
6064 case SVt_PVHV:
6065 del_XPVHV(SvANY(sv));
6066 break;
6067 case SVt_PVCV:
6068 del_XPVCV(SvANY(sv));
6069 break;
6070 case SVt_PVGV:
6071 del_XPVGV(SvANY(sv));
6072 /* code duplication for increased performance. */
6073 SvFLAGS(sv) &= SVf_BREAK;
6074 SvFLAGS(sv) |= SVTYPEMASK;
6075 /* decrease refcount of the stash that owns this GV, if any */
6076 if (stash)
6077 SvREFCNT_dec(stash);
6078 return; /* not break, SvFLAGS reset already happened */
6079 case SVt_PVBM:
6080 del_XPVBM(SvANY(sv));
6081 break;
6082 case SVt_PVFM:
6083 del_XPVFM(SvANY(sv));
6084 break;
6085 case SVt_PVIO:
6086 del_XPVIO(SvANY(sv));
6087 break;
6088 }
6089 SvFLAGS(sv) &= SVf_BREAK;
6090 SvFLAGS(sv) |= SVTYPEMASK;
6091}
6092
6093/*
6094=for apidoc sv_newref
6095
6096Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6097instead.
6098
6099=cut
6100*/
6101
6102SV *
6103Perl_sv_newref(pTHX_ SV *sv)
6104{
6105 if (sv)
6106 (SvREFCNT(sv))++;
6107 return sv;
6108}
6109
6110/*
6111=for apidoc sv_free
6112
6113Decrement an SV's reference count, and if it drops to zero, call
6114C<sv_clear> to invoke destructors and free up any memory used by
6115the body; finally, deallocate the SV's head itself.
6116Normally called via a wrapper macro C<SvREFCNT_dec>.
6117
6118=cut
6119*/
6120
6121void
6122Perl_sv_free(pTHX_ SV *sv)
6123{
6124 if (!sv)
6125 return;
6126 if (SvREFCNT(sv) == 0) {
6127 if (SvFLAGS(sv) & SVf_BREAK)
6128 /* this SV's refcnt has been artificially decremented to
6129 * trigger cleanup */
6130 return;
6131 if (PL_in_clean_all) /* All is fair */
6132 return;
6133 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6134 /* make sure SvREFCNT(sv)==0 happens very seldom */
6135 SvREFCNT(sv) = (~(U32)0)/2;
6136 return;
6137 }
6138 if (ckWARN_d(WARN_INTERNAL))
6139 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6140 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6141 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6142 return;
6143 }
6144 if (--(SvREFCNT(sv)) > 0)
6145 return;
6146 Perl_sv_free2(aTHX_ sv);
6147}
6148
6149void
6150Perl_sv_free2(pTHX_ SV *sv)
6151{
6152#ifdef DEBUGGING
6153 if (SvTEMP(sv)) {
6154 if (ckWARN_d(WARN_DEBUGGING))
6155 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6156 "Attempt to free temp prematurely: SV 0x%"UVxf
6157 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6158 return;
6159 }
6160#endif
6161 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6162 /* make sure SvREFCNT(sv)==0 happens very seldom */
6163 SvREFCNT(sv) = (~(U32)0)/2;
6164 return;
6165 }
6166 sv_clear(sv);
6167 if (! SvREFCNT(sv))
6168 del_SV(sv);
6169}
6170
6171/*
6172=for apidoc sv_len
6173
6174Returns the length of the string in the SV. Handles magic and type
6175coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6176
6177=cut
6178*/
6179
6180STRLEN
6181Perl_sv_len(pTHX_ register SV *sv)
6182{
6183 STRLEN len;
6184
6185 if (!sv)
6186 return 0;
6187
6188 if (SvGMAGICAL(sv))
6189 len = mg_length(sv);
6190 else
6191 (void)SvPV(sv, len);
6192 return len;
6193}
6194
6195/*
6196=for apidoc sv_len_utf8
6197
6198Returns the number of characters in the string in an SV, counting wide
6199UTF-8 bytes as a single character. Handles magic and type coercion.
6200
6201=cut
6202*/
6203
6204/*
6205 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6206 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6207 * (Note that the mg_len is not the length of the mg_ptr field.)
6208 *
6209 */
6210
6211STRLEN
6212Perl_sv_len_utf8(pTHX_ register SV *sv)
6213{
6214 if (!sv)
6215 return 0;
6216
6217 if (SvGMAGICAL(sv))
6218 return mg_length(sv);
6219 else
6220 {
6221 STRLEN len, ulen;
6222 U8 *s = (U8*)SvPV(sv, len);
6223 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6224
6225 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6226 ulen = mg->mg_len;
6227#ifdef PERL_UTF8_CACHE_ASSERT
6228 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6229#endif
6230 }
6231 else {
6232 ulen = Perl_utf8_length(aTHX_ s, s + len);
6233 if (!mg && !SvREADONLY(sv)) {
6234 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6235 mg = mg_find(sv, PERL_MAGIC_utf8);
6236 assert(mg);
6237 }
6238 if (mg)
6239 mg->mg_len = ulen;
6240 }
6241 return ulen;
6242 }
6243}
6244
6245/* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6246 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6247 * between UTF-8 and byte offsets. There are two (substr offset and substr
6248 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6249 * and byte offset) cache positions.
6250 *
6251 * The mg_len field is used by sv_len_utf8(), see its comments.
6252 * Note that the mg_len is not the length of the mg_ptr field.
6253 *
6254 */
6255STATIC bool
6256S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
6257{
6258 bool found = FALSE;
6259
6260 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6261 if (!*mgp)
6262 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6263 assert(*mgp);
6264
6265 if ((*mgp)->mg_ptr)
6266 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6267 else {
6268 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6269 (*mgp)->mg_ptr = (char *) *cachep;
6270 }
6271 assert(*cachep);
6272
6273 (*cachep)[i] = *offsetp;
6274 (*cachep)[i+1] = s - start;
6275 found = TRUE;
6276 }
6277
6278 return found;
6279}
6280
6281/*
6282 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6283 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6284 * between UTF-8 and byte offsets. See also the comments of
6285 * S_utf8_mg_pos_init().
6286 *
6287 */
6288STATIC bool
6289S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6290{
6291 bool found = FALSE;
6292
6293 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6294 if (!*mgp)
6295 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6296 if (*mgp && (*mgp)->mg_ptr) {
6297 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6298 ASSERT_UTF8_CACHE(*cachep);
6299 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6300 found = TRUE;
6301 else { /* We will skip to the right spot. */
6302 STRLEN forw = 0;
6303 STRLEN backw = 0;
6304 U8* p = NULL;
6305
6306 /* The assumption is that going backward is half
6307 * the speed of going forward (that's where the
6308 * 2 * backw in the below comes from). (The real
6309 * figure of course depends on the UTF-8 data.) */
6310
6311 if ((*cachep)[i] > (STRLEN)uoff) {
6312 forw = uoff;
6313 backw = (*cachep)[i] - (STRLEN)uoff;
6314
6315 if (forw < 2 * backw)
6316 p = start;
6317 else
6318 p = start + (*cachep)[i+1];
6319 }
6320 /* Try this only for the substr offset (i == 0),
6321 * not for the substr length (i == 2). */
6322 else if (i == 0) { /* (*cachep)[i] < uoff */
6323 STRLEN ulen = sv_len_utf8(sv);
6324
6325 if ((STRLEN)uoff < ulen) {
6326 forw = (STRLEN)uoff - (*cachep)[i];
6327 backw = ulen - (STRLEN)uoff;
6328
6329 if (forw < 2 * backw)
6330 p = start + (*cachep)[i+1];
6331 else
6332 p = send;
6333 }
6334
6335 /* If the string is not long enough for uoff,
6336 * we could extend it, but not at this low a level. */
6337 }
6338
6339 if (p) {
6340 if (forw < 2 * backw) {
6341 while (forw--)
6342 p += UTF8SKIP(p);
6343 }
6344 else {
6345 while (backw--) {
6346 p--;
6347 while (UTF8_IS_CONTINUATION(*p))
6348 p--;
6349 }
6350 }
6351
6352 /* Update the cache. */
6353 (*cachep)[i] = (STRLEN)uoff;
6354 (*cachep)[i+1] = p - start;
6355
6356 /* Drop the stale "length" cache */
6357 if (i == 0) {
6358 (*cachep)[2] = 0;
6359 (*cachep)[3] = 0;
6360 }
6361
6362 found = TRUE;
6363 }
6364 }
6365 if (found) { /* Setup the return values. */
6366 *offsetp = (*cachep)[i+1];
6367 *sp = start + *offsetp;
6368 if (*sp >= send) {
6369 *sp = send;
6370 *offsetp = send - start;
6371 }
6372 else if (*sp < start) {
6373 *sp = start;
6374 *offsetp = 0;
6375 }
6376 }
6377 }
6378#ifdef PERL_UTF8_CACHE_ASSERT
6379 if (found) {
6380 U8 *s = start;
6381 I32 n = uoff;
6382
6383 while (n-- && s < send)
6384 s += UTF8SKIP(s);
6385
6386 if (i == 0) {
6387 assert(*offsetp == s - start);
6388 assert((*cachep)[0] == (STRLEN)uoff);
6389 assert((*cachep)[1] == *offsetp);
6390 }
6391 ASSERT_UTF8_CACHE(*cachep);
6392 }
6393#endif
6394 }
6395
6396 return found;
6397}
6398
6399/*
6400=for apidoc sv_pos_u2b
6401
6402Converts the value pointed to by offsetp from a count of UTF-8 chars from
6403the start of the string, to a count of the equivalent number of bytes; if
6404lenp is non-zero, it does the same to lenp, but this time starting from
6405the offset, rather than from the start of the string. Handles magic and
6406type coercion.
6407
6408=cut
6409*/
6410
6411/*
6412 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6413 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6414 * byte offsets. See also the comments of S_utf8_mg_pos().
6415 *
6416 */
6417
6418void
6419Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6420{
6421 U8 *start;
6422 U8 *s;
6423 STRLEN len;
6424 STRLEN *cache = 0;
6425 STRLEN boffset = 0;
6426
6427 if (!sv)
6428 return;
6429
6430 start = s = (U8*)SvPV(sv, len);
6431 if (len) {
6432 I32 uoffset = *offsetp;
6433 U8 *send = s + len;
6434 MAGIC *mg = 0;
6435 bool found = FALSE;
6436
6437 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6438 found = TRUE;
6439 if (!found && uoffset > 0) {
6440 while (s < send && uoffset--)
6441 s += UTF8SKIP(s);
6442 if (s >= send)
6443 s = send;
6444 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
6445 boffset = cache[1];
6446 *offsetp = s - start;
6447 }
6448 if (lenp) {
6449 found = FALSE;
6450 start = s;
6451 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
6452 *lenp -= boffset;
6453 found = TRUE;
6454 }
6455 if (!found && *lenp > 0) {
6456 I32 ulen = *lenp;
6457 if (ulen > 0)
6458 while (s < send && ulen--)
6459 s += UTF8SKIP(s);
6460 if (s >= send)
6461 s = send;
6462 utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start);
6463 }
6464 *lenp = s - start;
6465 }
6466 ASSERT_UTF8_CACHE(cache);
6467 }
6468 else {
6469 *offsetp = 0;
6470 if (lenp)
6471 *lenp = 0;
6472 }
6473
6474 return;
6475}
6476
6477/*
6478=for apidoc sv_pos_b2u
6479
6480Converts the value pointed to by offsetp from a count of bytes from the
6481start of the string, to a count of the equivalent number of UTF-8 chars.
6482Handles magic and type coercion.
6483
6484=cut
6485*/
6486
6487/*
6488 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6489 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6490 * byte offsets. See also the comments of S_utf8_mg_pos().
6491 *
6492 */
6493
6494void
6495Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6496{
6497 U8* s;
6498 STRLEN len;
6499
6500 if (!sv)
6501 return;
6502
6503 s = (U8*)SvPV(sv, len);
6504 if ((I32)len < *offsetp)
6505 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6506 else {
6507 U8* send = s + *offsetp;
6508 MAGIC* mg = NULL;
6509 STRLEN *cache = NULL;
6510
6511 len = 0;
6512
6513 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6514 mg = mg_find(sv, PERL_MAGIC_utf8);
6515 if (mg && mg->mg_ptr) {
6516 cache = (STRLEN *) mg->mg_ptr;
6517 if (cache[1] == (STRLEN)*offsetp) {
6518 /* An exact match. */
6519 *offsetp = cache[0];
6520
6521 return;
6522 }
6523 else if (cache[1] < (STRLEN)*offsetp) {
6524 /* We already know part of the way. */
6525 len = cache[0];
6526 s += cache[1];
6527 /* Let the below loop do the rest. */
6528 }
6529 else { /* cache[1] > *offsetp */
6530 /* We already know all of the way, now we may
6531 * be able to walk back. The same assumption
6532 * is made as in S_utf8_mg_pos(), namely that
6533 * walking backward is twice slower than
6534 * walking forward. */
6535 STRLEN forw = *offsetp;
6536 STRLEN backw = cache[1] - *offsetp;
6537
6538 if (!(forw < 2 * backw)) {
6539 U8 *p = s + cache[1];
6540 STRLEN ubackw = 0;
6541
6542 cache[1] -= backw;
6543
6544 while (backw--) {
6545 p--;
6546 while (UTF8_IS_CONTINUATION(*p)) {
6547 p--;
6548 backw--;
6549 }
6550 ubackw++;
6551 }
6552
6553 cache[0] -= ubackw;
6554 *offsetp = cache[0];
6555
6556 /* Drop the stale "length" cache */
6557 cache[2] = 0;
6558 cache[3] = 0;
6559
6560 return;
6561 }
6562 }
6563 }
6564 ASSERT_UTF8_CACHE(cache);
6565 }
6566
6567 while (s < send) {
6568 STRLEN n = 1;
6569
6570 /* Call utf8n_to_uvchr() to validate the sequence
6571 * (unless a simple non-UTF character) */
6572 if (!UTF8_IS_INVARIANT(*s))
6573 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6574 if (n > 0) {
6575 s += n;
6576 len++;
6577 }
6578 else
6579 break;
6580 }
6581
6582 if (!SvREADONLY(sv)) {
6583 if (!mg) {
6584 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6585 mg = mg_find(sv, PERL_MAGIC_utf8);
6586 }
6587 assert(mg);
6588
6589 if (!mg->mg_ptr) {
6590 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6591 mg->mg_ptr = (char *) cache;
6592 }
6593 assert(cache);
6594
6595 cache[0] = len;
6596 cache[1] = *offsetp;
6597 /* Drop the stale "length" cache */
6598 cache[2] = 0;
6599 cache[3] = 0;
6600 }
6601
6602 *offsetp = len;
6603 }
6604 return;
6605}
6606
6607/*
6608=for apidoc sv_eq
6609
6610Returns a boolean indicating whether the strings in the two SVs are
6611identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6612coerce its args to strings if necessary.
6613
6614=cut
6615*/
6616
6617I32
6618Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6619{
6620 char *pv1;
6621 STRLEN cur1;
6622 char *pv2;
6623 STRLEN cur2;
6624 I32 eq = 0;
6625 char *tpv = Nullch;
6626 SV* svrecode = Nullsv;
6627
6628 if (!sv1) {
6629 pv1 = "";
6630 cur1 = 0;
6631 }
6632 else
6633 pv1 = SvPV(sv1, cur1);
6634
6635 if (!sv2){
6636 pv2 = "";
6637 cur2 = 0;
6638 }
6639 else
6640 pv2 = SvPV(sv2, cur2);
6641
6642 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6643 /* Differing utf8ness.
6644 * Do not UTF8size the comparands as a side-effect. */
6645 if (PL_encoding) {
6646 if (SvUTF8(sv1)) {
6647 svrecode = newSVpvn(pv2, cur2);
6648 sv_recode_to_utf8(svrecode, PL_encoding);
6649 pv2 = SvPV(svrecode, cur2);
6650 }
6651 else {
6652 svrecode = newSVpvn(pv1, cur1);
6653 sv_recode_to_utf8(svrecode, PL_encoding);
6654 pv1 = SvPV(svrecode, cur1);
6655 }
6656 /* Now both are in UTF-8. */
6657 if (cur1 != cur2) {
6658 SvREFCNT_dec(svrecode);
6659 return FALSE;
6660 }
6661 }
6662 else {
6663 bool is_utf8 = TRUE;
6664
6665 if (SvUTF8(sv1)) {
6666 /* sv1 is the UTF-8 one,
6667 * if is equal it must be downgrade-able */
6668 char *pv = (char*)bytes_from_utf8((U8*)pv1,
6669 &cur1, &is_utf8);
6670 if (pv != pv1)
6671 pv1 = tpv = pv;
6672 }
6673 else {
6674 /* sv2 is the UTF-8 one,
6675 * if is equal it must be downgrade-able */
6676 char *pv = (char *)bytes_from_utf8((U8*)pv2,
6677 &cur2, &is_utf8);
6678 if (pv != pv2)
6679 pv2 = tpv = pv;
6680 }
6681 if (is_utf8) {
6682 /* Downgrade not possible - cannot be eq */
6683 assert (tpv == 0);
6684 return FALSE;
6685 }
6686 }
6687 }
6688
6689 if (cur1 == cur2)
6690 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6691
6692 if (svrecode)
6693 SvREFCNT_dec(svrecode);
6694
6695 if (tpv)
6696 Safefree(tpv);
6697
6698 return eq;
6699}
6700
6701/*
6702=for apidoc sv_cmp
6703
6704Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6705string in C<sv1> is less than, equal to, or greater than the string in
6706C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6707coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6708
6709=cut
6710*/
6711
6712I32
6713Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6714{
6715 STRLEN cur1, cur2;
6716 char *pv1, *pv2, *tpv = Nullch;
6717 I32 cmp;
6718 SV *svrecode = Nullsv;
6719
6720 if (!sv1) {
6721 pv1 = "";
6722 cur1 = 0;
6723 }
6724 else
6725 pv1 = SvPV(sv1, cur1);
6726
6727 if (!sv2) {
6728 pv2 = "";
6729 cur2 = 0;
6730 }
6731 else
6732 pv2 = SvPV(sv2, cur2);
6733
6734 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6735 /* Differing utf8ness.
6736 * Do not UTF8size the comparands as a side-effect. */
6737 if (SvUTF8(sv1)) {
6738 if (PL_encoding) {
6739 svrecode = newSVpvn(pv2, cur2);
6740 sv_recode_to_utf8(svrecode, PL_encoding);
6741 pv2 = SvPV(svrecode, cur2);
6742 }
6743 else {
6744 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
6745 }
6746 }
6747 else {
6748 if (PL_encoding) {
6749 svrecode = newSVpvn(pv1, cur1);
6750 sv_recode_to_utf8(svrecode, PL_encoding);
6751 pv1 = SvPV(svrecode, cur1);
6752 }
6753 else {
6754 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
6755 }
6756 }
6757 }
6758
6759 if (!cur1) {
6760 cmp = cur2 ? -1 : 0;
6761 } else if (!cur2) {
6762 cmp = 1;
6763 } else {
6764 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6765
6766 if (retval) {
6767 cmp = retval < 0 ? -1 : 1;
6768 } else if (cur1 == cur2) {
6769 cmp = 0;
6770 } else {
6771 cmp = cur1 < cur2 ? -1 : 1;
6772 }
6773 }
6774
6775 if (svrecode)
6776 SvREFCNT_dec(svrecode);
6777
6778 if (tpv)
6779 Safefree(tpv);
6780
6781 return cmp;
6782}
6783
6784/*
6785=for apidoc sv_cmp_locale
6786
6787Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6788'use bytes' aware, handles get magic, and will coerce its args to strings
6789if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6790
6791=cut
6792*/
6793
6794I32
6795Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6796{
6797#ifdef USE_LOCALE_COLLATE
6798
6799 char *pv1, *pv2;
6800 STRLEN len1, len2;
6801 I32 retval;
6802
6803 if (PL_collation_standard)
6804 goto raw_compare;
6805
6806 len1 = 0;
6807 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6808 len2 = 0;
6809 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6810
6811 if (!pv1 || !len1) {
6812 if (pv2 && len2)
6813 return -1;
6814 else
6815 goto raw_compare;
6816 }
6817 else {
6818 if (!pv2 || !len2)
6819 return 1;
6820 }
6821
6822 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6823
6824 if (retval)
6825 return retval < 0 ? -1 : 1;
6826
6827 /*
6828 * When the result of collation is equality, that doesn't mean
6829 * that there are no differences -- some locales exclude some
6830 * characters from consideration. So to avoid false equalities,
6831 * we use the raw string as a tiebreaker.
6832 */
6833
6834 raw_compare:
6835 /* FALL THROUGH */
6836
6837#endif /* USE_LOCALE_COLLATE */
6838
6839 return sv_cmp(sv1, sv2);
6840}
6841
6842
6843#ifdef USE_LOCALE_COLLATE
6844
6845/*
6846=for apidoc sv_collxfrm
6847
6848Add Collate Transform magic to an SV if it doesn't already have it.
6849
6850Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6851scalar data of the variable, but transformed to such a format that a normal
6852memory comparison can be used to compare the data according to the locale
6853settings.
6854
6855=cut
6856*/
6857
6858char *
6859Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6860{
6861 MAGIC *mg;
6862
6863 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6864 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6865 char *s, *xf;
6866 STRLEN len, xlen;
6867
6868 if (mg)
6869 Safefree(mg->mg_ptr);
6870 s = SvPV(sv, len);
6871 if ((xf = mem_collxfrm(s, len, &xlen))) {
6872 if (SvREADONLY(sv)) {
6873 SAVEFREEPV(xf);
6874 *nxp = xlen;
6875 return xf + sizeof(PL_collation_ix);
6876 }
6877 if (! mg) {
6878 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6879 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6880 assert(mg);
6881 }
6882 mg->mg_ptr = xf;
6883 mg->mg_len = xlen;
6884 }
6885 else {
6886 if (mg) {
6887 mg->mg_ptr = NULL;
6888 mg->mg_len = -1;
6889 }
6890 }
6891 }
6892 if (mg && mg->mg_ptr) {
6893 *nxp = mg->mg_len;
6894 return mg->mg_ptr + sizeof(PL_collation_ix);
6895 }
6896 else {
6897 *nxp = 0;
6898 return NULL;
6899 }
6900}
6901
6902#endif /* USE_LOCALE_COLLATE */
6903
6904/*
6905=for apidoc sv_gets
6906
6907Get a line from the filehandle and store it into the SV, optionally
6908appending to the currently-stored string.
6909
6910=cut
6911*/
6912
6913char *
6914Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6915{
6916 char *rsptr;
6917 STRLEN rslen;
6918 register STDCHAR rslast;
6919 register STDCHAR *bp;
6920 register I32 cnt;
6921 I32 i = 0;
6922 I32 rspara = 0;
6923 I32 recsize;
6924
6925 if (SvTHINKFIRST(sv))
6926 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6927 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6928 from <>.
6929 However, perlbench says it's slower, because the existing swipe code
6930 is faster than copy on write.
6931 Swings and roundabouts. */
6932 (void)SvUPGRADE(sv, SVt_PV);
6933
6934 SvSCREAM_off(sv);
6935
6936 if (append) {
6937 if (PerlIO_isutf8(fp)) {
6938 if (!SvUTF8(sv)) {
6939 sv_utf8_upgrade_nomg(sv);
6940 sv_pos_u2b(sv,&append,0);
6941 }
6942 } else if (SvUTF8(sv)) {
6943 SV *tsv = NEWSV(0,0);
6944 sv_gets(tsv, fp, 0);
6945 sv_utf8_upgrade_nomg(tsv);
6946 SvCUR_set(sv,append);
6947 sv_catsv(sv,tsv);
6948 sv_free(tsv);
6949 goto return_string_or_null;
6950 }
6951 }
6952
6953 SvPOK_only(sv);
6954 if (PerlIO_isutf8(fp))
6955 SvUTF8_on(sv);
6956
6957 if (IN_PERL_COMPILETIME) {
6958 /* we always read code in line mode */
6959 rsptr = "\n";
6960 rslen = 1;
6961 }
6962 else if (RsSNARF(PL_rs)) {
6963 /* If it is a regular disk file use size from stat() as estimate
6964 of amount we are going to read - may result in malloc-ing
6965 more memory than we realy need if layers bellow reduce
6966 size we read (e.g. CRLF or a gzip layer)
6967 */
6968 Stat_t st;
6969 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6970 Off_t offset = PerlIO_tell(fp);
6971 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6972 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6973 }
6974 }
6975 rsptr = NULL;
6976 rslen = 0;
6977 }
6978 else if (RsRECORD(PL_rs)) {
6979 I32 bytesread;
6980 char *buffer;
6981
6982 /* Grab the size of the record we're getting */
6983 recsize = SvIV(SvRV(PL_rs));
6984 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6985 /* Go yank in */
6986#ifdef VMS
6987 /* VMS wants read instead of fread, because fread doesn't respect */
6988 /* RMS record boundaries. This is not necessarily a good thing to be */
6989 /* doing, but we've got no other real choice - except avoid stdio
6990 as implementation - perhaps write a :vms layer ?
6991 */
6992 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6993#else
6994 bytesread = PerlIO_read(fp, buffer, recsize);
6995#endif
6996 if (bytesread < 0)
6997 bytesread = 0;
6998 SvCUR_set(sv, bytesread += append);
6999 buffer[bytesread] = '\0';
7000 goto return_string_or_null;
7001 }
7002 else if (RsPARA(PL_rs)) {
7003 rsptr = "\n\n";
7004 rslen = 2;
7005 rspara = 1;
7006 }
7007 else {
7008 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7009 if (PerlIO_isutf8(fp)) {
7010 rsptr = SvPVutf8(PL_rs, rslen);
7011 }
7012 else {
7013 if (SvUTF8(PL_rs)) {
7014 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7015 Perl_croak(aTHX_ "Wide character in $/");
7016 }
7017 }
7018 rsptr = SvPV(PL_rs, rslen);
7019 }
7020 }
7021
7022 rslast = rslen ? rsptr[rslen - 1] : '\0';
7023
7024 if (rspara) { /* have to do this both before and after */
7025 do { /* to make sure file boundaries work right */
7026 if (PerlIO_eof(fp))
7027 return 0;
7028 i = PerlIO_getc(fp);
7029 if (i != '\n') {
7030 if (i == -1)
7031 return 0;
7032 PerlIO_ungetc(fp,i);
7033 break;
7034 }
7035 } while (i != EOF);
7036 }
7037
7038 /* See if we know enough about I/O mechanism to cheat it ! */
7039
7040 /* This used to be #ifdef test - it is made run-time test for ease
7041 of abstracting out stdio interface. One call should be cheap
7042 enough here - and may even be a macro allowing compile
7043 time optimization.
7044 */
7045
7046 if (PerlIO_fast_gets(fp)) {
7047
7048 /*
7049 * We're going to steal some values from the stdio struct
7050 * and put EVERYTHING in the innermost loop into registers.
7051 */
7052 register STDCHAR *ptr;
7053 STRLEN bpx;
7054 I32 shortbuffered;
7055
7056#if defined(VMS) && defined(PERLIO_IS_STDIO)
7057 /* An ungetc()d char is handled separately from the regular
7058 * buffer, so we getc() it back out and stuff it in the buffer.
7059 */
7060 i = PerlIO_getc(fp);
7061 if (i == EOF) return 0;
7062 *(--((*fp)->_ptr)) = (unsigned char) i;
7063 (*fp)->_cnt++;
7064#endif
7065
7066 /* Here is some breathtakingly efficient cheating */
7067
7068 cnt = PerlIO_get_cnt(fp); /* get count into register */
7069 /* make sure we have the room */
7070 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7071 /* Not room for all of it
7072 if we are looking for a separator and room for some
7073 */
7074 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7075 /* just process what we have room for */
7076 shortbuffered = cnt - SvLEN(sv) + append + 1;
7077 cnt -= shortbuffered;
7078 }
7079 else {
7080 shortbuffered = 0;
7081 /* remember that cnt can be negative */
7082 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7083 }
7084 }
7085 else
7086 shortbuffered = 0;
7087 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
7088 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7089 DEBUG_P(PerlIO_printf(Perl_debug_log,
7090 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7091 DEBUG_P(PerlIO_printf(Perl_debug_log,
7092 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7093 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7094 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7095 for (;;) {
7096 screamer:
7097 if (cnt > 0) {
7098 if (rslen) {
7099 while (cnt > 0) { /* this | eat */
7100 cnt--;
7101 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7102 goto thats_all_folks; /* screams | sed :-) */
7103 }
7104 }
7105 else {
7106 Copy(ptr, bp, cnt, char); /* this | eat */
7107 bp += cnt; /* screams | dust */
7108 ptr += cnt; /* louder | sed :-) */
7109 cnt = 0;
7110 }
7111 }
7112
7113 if (shortbuffered) { /* oh well, must extend */
7114 cnt = shortbuffered;
7115 shortbuffered = 0;
7116 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7117 SvCUR_set(sv, bpx);
7118 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7119 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7120 continue;
7121 }
7122
7123 DEBUG_P(PerlIO_printf(Perl_debug_log,
7124 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7125 PTR2UV(ptr),(long)cnt));
7126 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7127#if 0
7128 DEBUG_P(PerlIO_printf(Perl_debug_log,
7129 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7130 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7131 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7132#endif
7133 /* This used to call 'filbuf' in stdio form, but as that behaves like
7134 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7135 another abstraction. */
7136 i = PerlIO_getc(fp); /* get more characters */
7137#if 0
7138 DEBUG_P(PerlIO_printf(Perl_debug_log,
7139 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7140 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7141 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7142#endif
7143 cnt = PerlIO_get_cnt(fp);
7144 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7145 DEBUG_P(PerlIO_printf(Perl_debug_log,
7146 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7147
7148 if (i == EOF) /* all done for ever? */
7149 goto thats_really_all_folks;
7150
7151 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7152 SvCUR_set(sv, bpx);
7153 SvGROW(sv, bpx + cnt + 2);
7154 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7155
7156 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7157
7158 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7159 goto thats_all_folks;
7160 }
7161
7162thats_all_folks:
7163 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
7164 memNE((char*)bp - rslen, rsptr, rslen))
7165 goto screamer; /* go back to the fray */
7166thats_really_all_folks:
7167 if (shortbuffered)
7168 cnt += shortbuffered;
7169 DEBUG_P(PerlIO_printf(Perl_debug_log,
7170 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7171 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7172 DEBUG_P(PerlIO_printf(Perl_debug_log,
7173 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7174 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7175 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7176 *bp = '\0';
7177 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
7178 DEBUG_P(PerlIO_printf(Perl_debug_log,
7179 "Screamer: done, len=%ld, string=|%.*s|\n",
7180 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
7181 }
7182 else
7183 {
7184 /*The big, slow, and stupid way. */
7185
7186 /* Any stack-challenged places. */
7187#if defined(EPOC)
7188 /* EPOC: need to work around SDK features. *
7189 * On WINS: MS VC5 generates calls to _chkstk, *
7190 * if a "large" stack frame is allocated. *
7191 * gcc on MARM does not generate calls like these. */
7192# define USEHEAPINSTEADOFSTACK
7193#endif
7194
7195#ifdef USEHEAPINSTEADOFSTACK
7196 STDCHAR *buf = 0;
7197 New(0, buf, 8192, STDCHAR);
7198 assert(buf);
7199#else
7200 STDCHAR buf[8192];
7201#endif
7202
7203screamer2:
7204 if (rslen) {
7205 register STDCHAR *bpe = buf + sizeof(buf);
7206 bp = buf;
7207 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7208 ; /* keep reading */
7209 cnt = bp - buf;
7210 }
7211 else {
7212 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7213 /* Accomodate broken VAXC compiler, which applies U8 cast to
7214 * both args of ?: operator, causing EOF to change into 255
7215 */
7216 if (cnt > 0)
7217 i = (U8)buf[cnt - 1];
7218 else
7219 i = EOF;
7220 }
7221
7222 if (cnt < 0)
7223 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7224 if (append)
7225 sv_catpvn(sv, (char *) buf, cnt);
7226 else
7227 sv_setpvn(sv, (char *) buf, cnt);
7228
7229 if (i != EOF && /* joy */
7230 (!rslen ||
7231 SvCUR(sv) < rslen ||
7232 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7233 {
7234 append = -1;
7235 /*
7236 * If we're reading from a TTY and we get a short read,
7237 * indicating that the user hit his EOF character, we need
7238 * to notice it now, because if we try to read from the TTY
7239 * again, the EOF condition will disappear.
7240 *
7241 * The comparison of cnt to sizeof(buf) is an optimization
7242 * that prevents unnecessary calls to feof().
7243 *
7244 * - jik 9/25/96
7245 */
7246 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7247 goto screamer2;
7248 }
7249
7250#ifdef USEHEAPINSTEADOFSTACK
7251 Safefree(buf);
7252#endif
7253 }
7254
7255 if (rspara) { /* have to do this both before and after */
7256 while (i != EOF) { /* to make sure file boundaries work right */
7257 i = PerlIO_getc(fp);
7258 if (i != '\n') {
7259 PerlIO_ungetc(fp,i);
7260 break;
7261 }
7262 }
7263 }
7264
7265return_string_or_null:
7266 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7267}
7268
7269/*
7270=for apidoc sv_inc
7271
7272Auto-increment of the value in the SV, doing string to numeric conversion
7273if necessary. Handles 'get' magic.
7274
7275=cut
7276*/
7277
7278void
7279Perl_sv_inc(pTHX_ register SV *sv)
7280{
7281 register char *d;
7282 int flags;
7283
7284 if (!sv)
7285 return;
7286 if (SvGMAGICAL(sv))
7287 mg_get(sv);
7288 if (SvTHINKFIRST(sv)) {
7289 if (SvIsCOW(sv))
7290 sv_force_normal_flags(sv, 0);
7291 if (SvREADONLY(sv)) {
7292 if (IN_PERL_RUNTIME)
7293 Perl_croak(aTHX_ PL_no_modify);
7294 }
7295 if (SvROK(sv)) {
7296 IV i;
7297 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7298 return;
7299 i = PTR2IV(SvRV(sv));
7300 sv_unref(sv);
7301 sv_setiv(sv, i);
7302 }
7303 }
7304 flags = SvFLAGS(sv);
7305 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7306 /* It's (privately or publicly) a float, but not tested as an
7307 integer, so test it to see. */
7308 (void) SvIV(sv);
7309 flags = SvFLAGS(sv);
7310 }
7311 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7312 /* It's publicly an integer, or privately an integer-not-float */
7313#ifdef PERL_PRESERVE_IVUV
7314 oops_its_int:
7315#endif
7316 if (SvIsUV(sv)) {
7317 if (SvUVX(sv) == UV_MAX)
7318 sv_setnv(sv, UV_MAX_P1);
7319 else
7320 (void)SvIOK_only_UV(sv);
7321 ++SvUVX(sv);
7322 } else {
7323 if (SvIVX(sv) == IV_MAX)
7324 sv_setuv(sv, (UV)IV_MAX + 1);
7325 else {
7326 (void)SvIOK_only(sv);
7327 ++SvIVX(sv);
7328 }
7329 }
7330 return;
7331 }
7332 if (flags & SVp_NOK) {
7333 (void)SvNOK_only(sv);
7334 SvNVX(sv) += 1.0;
7335 return;
7336 }
7337
7338 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
7339 if ((flags & SVTYPEMASK) < SVt_PVIV)
7340 sv_upgrade(sv, SVt_IV);
7341 (void)SvIOK_only(sv);
7342 SvIVX(sv) = 1;
7343 return;
7344 }
7345 d = SvPVX(sv);
7346 while (isALPHA(*d)) d++;
7347 while (isDIGIT(*d)) d++;
7348 if (*d) {
7349#ifdef PERL_PRESERVE_IVUV
7350 /* Got to punt this as an integer if needs be, but we don't issue
7351 warnings. Probably ought to make the sv_iv_please() that does
7352 the conversion if possible, and silently. */
7353 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7354 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7355 /* Need to try really hard to see if it's an integer.
7356 9.22337203685478e+18 is an integer.
7357 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7358 so $a="9.22337203685478e+18"; $a+0; $a++
7359 needs to be the same as $a="9.22337203685478e+18"; $a++
7360 or we go insane. */
7361
7362 (void) sv_2iv(sv);
7363 if (SvIOK(sv))
7364 goto oops_its_int;
7365
7366 /* sv_2iv *should* have made this an NV */
7367 if (flags & SVp_NOK) {
7368 (void)SvNOK_only(sv);
7369 SvNVX(sv) += 1.0;
7370 return;
7371 }
7372 /* I don't think we can get here. Maybe I should assert this
7373 And if we do get here I suspect that sv_setnv will croak. NWC
7374 Fall through. */
7375#if defined(USE_LONG_DOUBLE)
7376 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",
7377 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7378#else
7379 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7380 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7381#endif
7382 }
7383#endif /* PERL_PRESERVE_IVUV */
7384 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
7385 return;
7386 }
7387 d--;
7388 while (d >= SvPVX(sv)) {
7389 if (isDIGIT(*d)) {
7390 if (++*d <= '9')
7391 return;
7392 *(d--) = '0';
7393 }
7394 else {
7395#ifdef EBCDIC
7396 /* MKS: The original code here died if letters weren't consecutive.
7397 * at least it didn't have to worry about non-C locales. The
7398 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7399 * arranged in order (although not consecutively) and that only
7400 * [A-Za-z] are accepted by isALPHA in the C locale.
7401 */
7402 if (*d != 'z' && *d != 'Z') {
7403 do { ++*d; } while (!isALPHA(*d));
7404 return;
7405 }
7406 *(d--) -= 'z' - 'a';
7407#else
7408 ++*d;
7409 if (isALPHA(*d))
7410 return;
7411 *(d--) -= 'z' - 'a' + 1;
7412#endif
7413 }
7414 }
7415 /* oh,oh, the number grew */
7416 SvGROW(sv, SvCUR(sv) + 2);
7417 SvCUR(sv)++;
7418 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
7419 *d = d[-1];
7420 if (isDIGIT(d[1]))
7421 *d = '1';
7422 else
7423 *d = d[1];
7424}
7425
7426/*
7427=for apidoc sv_dec
7428
7429Auto-decrement of the value in the SV, doing string to numeric conversion
7430if necessary. Handles 'get' magic.
7431
7432=cut
7433*/
7434
7435void
7436Perl_sv_dec(pTHX_ register SV *sv)
7437{
7438 int flags;
7439
7440 if (!sv)
7441 return;
7442 if (SvGMAGICAL(sv))
7443 mg_get(sv);
7444 if (SvTHINKFIRST(sv)) {
7445 if (SvIsCOW(sv))
7446 sv_force_normal_flags(sv, 0);
7447 if (SvREADONLY(sv)) {
7448 if (IN_PERL_RUNTIME)
7449 Perl_croak(aTHX_ PL_no_modify);
7450 }
7451 if (SvROK(sv)) {
7452 IV i;
7453 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7454 return;
7455 i = PTR2IV(SvRV(sv));
7456 sv_unref(sv);
7457 sv_setiv(sv, i);
7458 }
7459 }
7460 /* Unlike sv_inc we don't have to worry about string-never-numbers
7461 and keeping them magic. But we mustn't warn on punting */
7462 flags = SvFLAGS(sv);
7463 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7464 /* It's publicly an integer, or privately an integer-not-float */
7465#ifdef PERL_PRESERVE_IVUV
7466 oops_its_int:
7467#endif
7468 if (SvIsUV(sv)) {
7469 if (SvUVX(sv) == 0) {
7470 (void)SvIOK_only(sv);
7471 SvIVX(sv) = -1;
7472 }
7473 else {
7474 (void)SvIOK_only_UV(sv);
7475 --SvUVX(sv);
7476 }
7477 } else {
7478 if (SvIVX(sv) == IV_MIN)
7479 sv_setnv(sv, (NV)IV_MIN - 1.0);
7480 else {
7481 (void)SvIOK_only(sv);
7482 --SvIVX(sv);
7483 }
7484 }
7485 return;
7486 }
7487 if (flags & SVp_NOK) {
7488 SvNVX(sv) -= 1.0;
7489 (void)SvNOK_only(sv);
7490 return;
7491 }
7492 if (!(flags & SVp_POK)) {
7493 if ((flags & SVTYPEMASK) < SVt_PVNV)
7494 sv_upgrade(sv, SVt_NV);
7495 SvNVX(sv) = -1.0;
7496 (void)SvNOK_only(sv);
7497 return;
7498 }
7499#ifdef PERL_PRESERVE_IVUV
7500 {
7501 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7502 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7503 /* Need to try really hard to see if it's an integer.
7504 9.22337203685478e+18 is an integer.
7505 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7506 so $a="9.22337203685478e+18"; $a+0; $a--
7507 needs to be the same as $a="9.22337203685478e+18"; $a--
7508 or we go insane. */
7509
7510 (void) sv_2iv(sv);
7511 if (SvIOK(sv))
7512 goto oops_its_int;
7513
7514 /* sv_2iv *should* have made this an NV */
7515 if (flags & SVp_NOK) {
7516 (void)SvNOK_only(sv);
7517 SvNVX(sv) -= 1.0;
7518 return;
7519 }
7520 /* I don't think we can get here. Maybe I should assert this
7521 And if we do get here I suspect that sv_setnv will croak. NWC
7522 Fall through. */
7523#if defined(USE_LONG_DOUBLE)
7524 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",
7525 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7526#else
7527 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7528 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7529#endif
7530 }
7531 }
7532#endif /* PERL_PRESERVE_IVUV */
7533 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
7534}
7535
7536/*
7537=for apidoc sv_mortalcopy
7538
7539Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7540The new SV is marked as mortal. It will be destroyed "soon", either by an
7541explicit call to FREETMPS, or by an implicit call at places such as
7542statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7543
7544=cut
7545*/
7546
7547/* Make a string that will exist for the duration of the expression
7548 * evaluation. Actually, it may have to last longer than that, but
7549 * hopefully we won't free it until it has been assigned to a
7550 * permanent location. */
7551
7552SV *
7553Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7554{
7555 register SV *sv;
7556
7557 new_SV(sv);
7558 sv_setsv(sv,oldstr);
7559 EXTEND_MORTAL(1);
7560 PL_tmps_stack[++PL_tmps_ix] = sv;
7561 SvTEMP_on(sv);
7562 return sv;
7563}
7564
7565/*
7566=for apidoc sv_newmortal
7567
7568Creates a new null SV which is mortal. The reference count of the SV is
7569set to 1. It will be destroyed "soon", either by an explicit call to
7570FREETMPS, or by an implicit call at places such as statement boundaries.
7571See also C<sv_mortalcopy> and C<sv_2mortal>.
7572
7573=cut
7574*/
7575
7576SV *
7577Perl_sv_newmortal(pTHX)
7578{
7579 register SV *sv;
7580
7581 new_SV(sv);
7582 SvFLAGS(sv) = SVs_TEMP;
7583 EXTEND_MORTAL(1);
7584 PL_tmps_stack[++PL_tmps_ix] = sv;
7585 return sv;
7586}
7587
7588/*
7589=for apidoc sv_2mortal
7590
7591Marks an existing SV as mortal. The SV will be destroyed "soon", either
7592by an explicit call to FREETMPS, or by an implicit call at places such as
7593statement boundaries. SvTEMP() is turned on which means that the SV's
7594string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7595and C<sv_mortalcopy>.
7596
7597=cut
7598*/
7599
7600SV *
7601Perl_sv_2mortal(pTHX_ register SV *sv)
7602{
7603 if (!sv)
7604 return sv;
7605 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7606 return sv;
7607 EXTEND_MORTAL(1);
7608 PL_tmps_stack[++PL_tmps_ix] = sv;
7609 SvTEMP_on(sv);
7610 return sv;
7611}
7612
7613/*
7614=for apidoc newSVpv
7615
7616Creates a new SV and copies a string into it. The reference count for the
7617SV is set to 1. If C<len> is zero, Perl will compute the length using
7618strlen(). For efficiency, consider using C<newSVpvn> instead.
7619
7620=cut
7621*/
7622
7623SV *
7624Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7625{
7626 register SV *sv;
7627
7628 new_SV(sv);
7629 if (!len)
7630 len = strlen(s);
7631 sv_setpvn(sv,s,len);
7632 return sv;
7633}
7634
7635/*
7636=for apidoc newSVpvn
7637
7638Creates a new SV and copies a string into it. The reference count for the
7639SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7640string. You are responsible for ensuring that the source string is at least
7641C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7642
7643=cut
7644*/
7645
7646SV *
7647Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7648{
7649 register SV *sv;
7650
7651 new_SV(sv);
7652 sv_setpvn(sv,s,len);
7653 return sv;
7654}
7655
7656/*
7657=for apidoc newSVpvn_share
7658
7659Creates a new SV with its SvPVX pointing to a shared string in the string
7660table. If the string does not already exist in the table, it is created
7661first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7662slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7663otherwise the hash is computed. The idea here is that as the string table
7664is used for shared hash keys these strings will have SvPVX == HeKEY and
7665hash lookup will avoid string compare.
7666
7667=cut
7668*/
7669
7670SV *
7671Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7672{
7673 register SV *sv;
7674 bool is_utf8 = FALSE;
7675 if (len < 0) {
7676 STRLEN tmplen = -len;
7677 is_utf8 = TRUE;
7678 /* See the note in hv.c:hv_fetch() --jhi */
7679 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
7680 len = tmplen;
7681 }
7682 if (!hash)
7683 PERL_HASH(hash, src, len);
7684 new_SV(sv);
7685 sv_upgrade(sv, SVt_PVIV);
7686 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
7687 SvCUR(sv) = len;
7688 SvUVX(sv) = hash;
7689 SvLEN(sv) = 0;
7690 SvREADONLY_on(sv);
7691 SvFAKE_on(sv);
7692 SvPOK_on(sv);
7693 if (is_utf8)
7694 SvUTF8_on(sv);
7695 return sv;
7696}
7697
7698
7699#if defined(PERL_IMPLICIT_CONTEXT)
7700
7701/* pTHX_ magic can't cope with varargs, so this is a no-context
7702 * version of the main function, (which may itself be aliased to us).
7703 * Don't access this version directly.
7704 */
7705
7706SV *
7707Perl_newSVpvf_nocontext(const char* pat, ...)
7708{
7709 dTHX;
7710 register SV *sv;
7711 va_list args;
7712 va_start(args, pat);
7713 sv = vnewSVpvf(pat, &args);
7714 va_end(args);
7715 return sv;
7716}
7717#endif
7718
7719/*
7720=for apidoc newSVpvf
7721
7722Creates a new SV and initializes it with the string formatted like
7723C<sprintf>.
7724
7725=cut
7726*/
7727
7728SV *
7729Perl_newSVpvf(pTHX_ const char* pat, ...)
7730{
7731 register SV *sv;
7732 va_list args;
7733 va_start(args, pat);
7734 sv = vnewSVpvf(pat, &args);
7735 va_end(args);
7736 return sv;
7737}
7738
7739/* backend for newSVpvf() and newSVpvf_nocontext() */
7740
7741SV *
7742Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7743{
7744 register SV *sv;
7745 new_SV(sv);
7746 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7747 return sv;
7748}
7749
7750/*
7751=for apidoc newSVnv
7752
7753Creates a new SV and copies a floating point value into it.
7754The reference count for the SV is set to 1.
7755
7756=cut
7757*/
7758
7759SV *
7760Perl_newSVnv(pTHX_ NV n)
7761{
7762 register SV *sv;
7763
7764 new_SV(sv);
7765 sv_setnv(sv,n);
7766 return sv;
7767}
7768
7769/*
7770=for apidoc newSViv
7771
7772Creates a new SV and copies an integer into it. The reference count for the
7773SV is set to 1.
7774
7775=cut
7776*/
7777
7778SV *
7779Perl_newSViv(pTHX_ IV i)
7780{
7781 register SV *sv;
7782
7783 new_SV(sv);
7784 sv_setiv(sv,i);
7785 return sv;
7786}
7787
7788/*
7789=for apidoc newSVuv
7790
7791Creates a new SV and copies an unsigned integer into it.
7792The reference count for the SV is set to 1.
7793
7794=cut
7795*/
7796
7797SV *
7798Perl_newSVuv(pTHX_ UV u)
7799{
7800 register SV *sv;
7801
7802 new_SV(sv);
7803 sv_setuv(sv,u);
7804 return sv;
7805}
7806
7807/*
7808=for apidoc newRV_noinc
7809
7810Creates an RV wrapper for an SV. The reference count for the original
7811SV is B<not> incremented.
7812
7813=cut
7814*/
7815
7816SV *
7817Perl_newRV_noinc(pTHX_ SV *tmpRef)
7818{
7819 register SV *sv;
7820
7821 new_SV(sv);
7822 sv_upgrade(sv, SVt_RV);
7823 SvTEMP_off(tmpRef);
7824 SvRV(sv) = tmpRef;
7825 SvROK_on(sv);
7826 return sv;
7827}
7828
7829/* newRV_inc is the official function name to use now.
7830 * newRV_inc is in fact #defined to newRV in sv.h
7831 */
7832
7833SV *
7834Perl_newRV(pTHX_ SV *tmpRef)
7835{
7836 return newRV_noinc(SvREFCNT_inc(tmpRef));
7837}
7838
7839/*
7840=for apidoc newSVsv
7841
7842Creates a new SV which is an exact duplicate of the original SV.
7843(Uses C<sv_setsv>).
7844
7845=cut
7846*/
7847
7848SV *
7849Perl_newSVsv(pTHX_ register SV *old)
7850{
7851 register SV *sv;
7852
7853 if (!old)
7854 return Nullsv;
7855 if (SvTYPE(old) == SVTYPEMASK) {
7856 if (ckWARN_d(WARN_INTERNAL))
7857 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7858 return Nullsv;
7859 }
7860 new_SV(sv);
7861 /* SV_GMAGIC is the default for sv_setv()
7862 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7863 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7864 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7865 return sv;
7866}
7867
7868/*
7869=for apidoc sv_reset
7870
7871Underlying implementation for the C<reset> Perl function.
7872Note that the perl-level function is vaguely deprecated.
7873
7874=cut
7875*/
7876
7877void
7878Perl_sv_reset(pTHX_ register char *s, HV *stash)
7879{
7880 register HE *entry;
7881 register GV *gv;
7882 register SV *sv;
7883 register I32 i;
7884 register PMOP *pm;
7885 register I32 max;
7886 char todo[PERL_UCHAR_MAX+1];
7887
7888 if (!stash)
7889 return;
7890
7891 if (!*s) { /* reset ?? searches */
7892 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7893 pm->op_pmdynflags &= ~PMdf_USED;
7894 }
7895 return;
7896 }
7897
7898 /* reset variables */
7899
7900 if (!HvARRAY(stash))
7901 return;
7902
7903 Zero(todo, 256, char);
7904 while (*s) {
7905 i = (unsigned char)*s;
7906 if (s[1] == '-') {
7907 s += 2;
7908 }
7909 max = (unsigned char)*s++;
7910 for ( ; i <= max; i++) {
7911 todo[i] = 1;
7912 }
7913 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7914 for (entry = HvARRAY(stash)[i];
7915 entry;
7916 entry = HeNEXT(entry))
7917 {
7918 if (!todo[(U8)*HeKEY(entry)])
7919 continue;
7920 gv = (GV*)HeVAL(entry);
7921 sv = GvSV(gv);
7922 if (SvTHINKFIRST(sv)) {
7923 if (!SvREADONLY(sv) && SvROK(sv))
7924 sv_unref(sv);
7925 continue;
7926 }
7927 SvOK_off(sv);
7928 if (SvTYPE(sv) >= SVt_PV) {
7929 SvCUR_set(sv, 0);
7930 if (SvPVX(sv) != Nullch)
7931 *SvPVX(sv) = '\0';
7932 SvTAINT(sv);
7933 }
7934 if (GvAV(gv)) {
7935 av_clear(GvAV(gv));
7936 }
7937 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7938 hv_clear(GvHV(gv));
7939#ifndef PERL_MICRO
7940#ifdef USE_ENVIRON_ARRAY
7941 if (gv == PL_envgv
7942# ifdef USE_ITHREADS
7943 && PL_curinterp == aTHX
7944# endif
7945 )
7946 {
7947 environ[0] = Nullch;
7948 }
7949#endif
7950#endif /* !PERL_MICRO */
7951 }
7952 }
7953 }
7954 }
7955}
7956
7957/*
7958=for apidoc sv_2io
7959
7960Using various gambits, try to get an IO from an SV: the IO slot if its a
7961GV; or the recursive result if we're an RV; or the IO slot of the symbol
7962named after the PV if we're a string.
7963
7964=cut
7965*/
7966
7967IO*
7968Perl_sv_2io(pTHX_ SV *sv)
7969{
7970 IO* io;
7971 GV* gv;
7972
7973 switch (SvTYPE(sv)) {
7974 case SVt_PVIO:
7975 io = (IO*)sv;
7976 break;
7977 case SVt_PVGV:
7978 gv = (GV*)sv;
7979 io = GvIO(gv);
7980 if (!io)
7981 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7982 break;
7983 default:
7984 if (!SvOK(sv))
7985 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7986 if (SvROK(sv))
7987 return sv_2io(SvRV(sv));
7988 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7989 if (gv)
7990 io = GvIO(gv);
7991 else
7992 io = 0;
7993 if (!io)
7994 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7995 break;
7996 }
7997 return io;
7998}
7999
8000/*
8001=for apidoc sv_2cv
8002
8003Using various gambits, try to get a CV from an SV; in addition, try if
8004possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8005
8006=cut
8007*/
8008
8009CV *
8010Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8011{
8012 GV *gv = Nullgv;
8013 CV *cv = Nullcv;
8014
8015 if (!sv)
8016 return *gvp = Nullgv, Nullcv;
8017 switch (SvTYPE(sv)) {
8018 case SVt_PVCV:
8019 *st = CvSTASH(sv);
8020 *gvp = Nullgv;
8021 return (CV*)sv;
8022 case SVt_PVHV:
8023 case SVt_PVAV:
8024 *gvp = Nullgv;
8025 return Nullcv;
8026 case SVt_PVGV:
8027 gv = (GV*)sv;
8028 *gvp = gv;
8029 *st = GvESTASH(gv);
8030 goto fix_gv;
8031
8032 default:
8033 if (SvGMAGICAL(sv))
8034 mg_get(sv);
8035 if (SvROK(sv)) {
8036 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8037 tryAMAGICunDEREF(to_cv);
8038
8039 sv = SvRV(sv);
8040 if (SvTYPE(sv) == SVt_PVCV) {
8041 cv = (CV*)sv;
8042 *gvp = Nullgv;
8043 *st = CvSTASH(cv);
8044 return cv;
8045 }
8046 else if(isGV(sv))
8047 gv = (GV*)sv;
8048 else
8049 Perl_croak(aTHX_ "Not a subroutine reference");
8050 }
8051 else if (isGV(sv))
8052 gv = (GV*)sv;
8053 else
8054 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8055 *gvp = gv;
8056 if (!gv)
8057 return Nullcv;
8058 *st = GvESTASH(gv);
8059 fix_gv:
8060 if (lref && !GvCVu(gv)) {
8061 SV *tmpsv;
8062 ENTER;
8063 tmpsv = NEWSV(704,0);
8064 gv_efullname3(tmpsv, gv, Nullch);
8065 /* XXX this is probably not what they think they're getting.
8066 * It has the same effect as "sub name;", i.e. just a forward
8067 * declaration! */
8068 newSUB(start_subparse(FALSE, 0),
8069 newSVOP(OP_CONST, 0, tmpsv),
8070 Nullop,
8071 Nullop);
8072 LEAVE;
8073 if (!GvCVu(gv))
8074 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8075 sv);
8076 }
8077 return GvCVu(gv);
8078 }
8079}
8080
8081/*
8082=for apidoc sv_true
8083
8084Returns true if the SV has a true value by Perl's rules.
8085Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8086instead use an in-line version.
8087
8088=cut
8089*/
8090
8091I32
8092Perl_sv_true(pTHX_ register SV *sv)
8093{
8094 if (!sv)
8095 return 0;
8096 if (SvPOK(sv)) {
8097 register XPV* tXpv;
8098 if ((tXpv = (XPV*)SvANY(sv)) &&
8099 (tXpv->xpv_cur > 1 ||
8100 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
8101 return 1;
8102 else
8103 return 0;
8104 }
8105 else {
8106 if (SvIOK(sv))
8107 return SvIVX(sv) != 0;
8108 else {
8109 if (SvNOK(sv))
8110 return SvNVX(sv) != 0.0;
8111 else
8112 return sv_2bool(sv);
8113 }
8114 }
8115}
8116
8117/*
8118=for apidoc sv_iv
8119
8120A private implementation of the C<SvIVx> macro for compilers which can't
8121cope with complex macro expressions. Always use the macro instead.
8122
8123=cut
8124*/
8125
8126IV
8127Perl_sv_iv(pTHX_ register SV *sv)
8128{
8129 if (SvIOK(sv)) {
8130 if (SvIsUV(sv))
8131 return (IV)SvUVX(sv);
8132 return SvIVX(sv);
8133 }
8134 return sv_2iv(sv);
8135}
8136
8137/*
8138=for apidoc sv_uv
8139
8140A private implementation of the C<SvUVx> macro for compilers which can't
8141cope with complex macro expressions. Always use the macro instead.
8142
8143=cut
8144*/
8145
8146UV
8147Perl_sv_uv(pTHX_ register SV *sv)
8148{
8149 if (SvIOK(sv)) {
8150 if (SvIsUV(sv))
8151 return SvUVX(sv);
8152 return (UV)SvIVX(sv);
8153 }
8154 return sv_2uv(sv);
8155}
8156
8157/*
8158=for apidoc sv_nv
8159
8160A private implementation of the C<SvNVx> macro for compilers which can't
8161cope with complex macro expressions. Always use the macro instead.
8162
8163=cut
8164*/
8165
8166NV
8167Perl_sv_nv(pTHX_ register SV *sv)
8168{
8169 if (SvNOK(sv))
8170 return SvNVX(sv);
8171 return sv_2nv(sv);
8172}
8173
8174/* sv_pv() is now a macro using SvPV_nolen();
8175 * this function provided for binary compatibility only
8176 */
8177
8178char *
8179Perl_sv_pv(pTHX_ SV *sv)
8180{
8181 STRLEN n_a;
8182
8183 if (SvPOK(sv))
8184 return SvPVX(sv);
8185
8186 return sv_2pv(sv, &n_a);
8187}
8188
8189/*
8190=for apidoc sv_pv
8191
8192Use the C<SvPV_nolen> macro instead
8193
8194=for apidoc sv_pvn
8195
8196A private implementation of the C<SvPV> macro for compilers which can't
8197cope with complex macro expressions. Always use the macro instead.
8198
8199=cut
8200*/
8201
8202char *
8203Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8204{
8205 if (SvPOK(sv)) {
8206 *lp = SvCUR(sv);
8207 return SvPVX(sv);
8208 }
8209 return sv_2pv(sv, lp);
8210}
8211
8212
8213char *
8214Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8215{
8216 if (SvPOK(sv)) {
8217 *lp = SvCUR(sv);
8218 return SvPVX(sv);
8219 }
8220 return sv_2pv_flags(sv, lp, 0);
8221}
8222
8223/* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8224 * this function provided for binary compatibility only
8225 */
8226
8227char *
8228Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8229{
8230 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8231}
8232
8233/*
8234=for apidoc sv_pvn_force
8235
8236Get a sensible string out of the SV somehow.
8237A private implementation of the C<SvPV_force> macro for compilers which
8238can't cope with complex macro expressions. Always use the macro instead.
8239
8240=for apidoc sv_pvn_force_flags
8241
8242Get a sensible string out of the SV somehow.
8243If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8244appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8245implemented in terms of this function.
8246You normally want to use the various wrapper macros instead: see
8247C<SvPV_force> and C<SvPV_force_nomg>
8248
8249=cut
8250*/
8251
8252char *
8253Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8254{
8255 char *s = NULL;
8256
8257 if (SvTHINKFIRST(sv) && !SvROK(sv))
8258 sv_force_normal_flags(sv, 0);
8259
8260 if (SvPOK(sv)) {
8261 *lp = SvCUR(sv);
8262 }
8263 else {
8264 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8265 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8266 OP_NAME(PL_op));
8267 }
8268 else
8269 s = sv_2pv_flags(sv, lp, flags);
8270 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
8271 STRLEN len = *lp;
8272
8273 if (SvROK(sv))
8274 sv_unref(sv);
8275 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8276 SvGROW(sv, len + 1);
8277 Move(s,SvPVX(sv),len,char);
8278 SvCUR_set(sv, len);
8279 *SvEND(sv) = '\0';
8280 }
8281 if (!SvPOK(sv)) {
8282 SvPOK_on(sv); /* validate pointer */
8283 SvTAINT(sv);
8284 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8285 PTR2UV(sv),SvPVX(sv)));
8286 }
8287 }
8288 return SvPVX(sv);
8289}
8290
8291/* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8292 * this function provided for binary compatibility only
8293 */
8294
8295char *
8296Perl_sv_pvbyte(pTHX_ SV *sv)
8297{
8298 sv_utf8_downgrade(sv,0);
8299 return sv_pv(sv);
8300}
8301
8302/*
8303=for apidoc sv_pvbyte
8304
8305Use C<SvPVbyte_nolen> instead.
8306
8307=for apidoc sv_pvbyten
8308
8309A private implementation of the C<SvPVbyte> macro for compilers
8310which can't cope with complex macro expressions. Always use the macro
8311instead.
8312
8313=cut
8314*/
8315
8316char *
8317Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8318{
8319 sv_utf8_downgrade(sv,0);
8320 return sv_pvn(sv,lp);
8321}
8322
8323/*
8324=for apidoc sv_pvbyten_force
8325
8326A private implementation of the C<SvPVbytex_force> macro for compilers
8327which can't cope with complex macro expressions. Always use the macro
8328instead.
8329
8330=cut
8331*/
8332
8333char *
8334Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8335{
8336 sv_pvn_force(sv,lp);
8337 sv_utf8_downgrade(sv,0);
8338 *lp = SvCUR(sv);
8339 return SvPVX(sv);
8340}
8341
8342/* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8343 * this function provided for binary compatibility only
8344 */
8345
8346char *
8347Perl_sv_pvutf8(pTHX_ SV *sv)
8348{
8349 sv_utf8_upgrade(sv);
8350 return sv_pv(sv);
8351}
8352
8353/*
8354=for apidoc sv_pvutf8
8355
8356Use the C<SvPVutf8_nolen> macro instead
8357
8358=for apidoc sv_pvutf8n
8359
8360A private implementation of the C<SvPVutf8> macro for compilers
8361which can't cope with complex macro expressions. Always use the macro
8362instead.
8363
8364=cut
8365*/
8366
8367char *
8368Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8369{
8370 sv_utf8_upgrade(sv);
8371 return sv_pvn(sv,lp);
8372}
8373
8374/*
8375=for apidoc sv_pvutf8n_force
8376
8377A private implementation of the C<SvPVutf8_force> macro for compilers
8378which can't cope with complex macro expressions. Always use the macro
8379instead.
8380
8381=cut
8382*/
8383
8384char *
8385Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8386{
8387 sv_pvn_force(sv,lp);
8388 sv_utf8_upgrade(sv);
8389 *lp = SvCUR(sv);
8390 return SvPVX(sv);
8391}
8392
8393/*
8394=for apidoc sv_reftype
8395
8396Returns a string describing what the SV is a reference to.
8397
8398=cut
8399*/
8400
8401char *
8402Perl_sv_reftype(pTHX_ SV *sv, int ob)
8403{
8404 if (ob && SvOBJECT(sv)) {
8405 char *name = HvNAME(SvSTASH(sv));
8406 return name ? name : "__ANON__";
8407 }
8408 else {
8409 switch (SvTYPE(sv)) {
8410 case SVt_NULL:
8411 case SVt_IV:
8412 case SVt_NV:
8413 case SVt_RV:
8414 case SVt_PV:
8415 case SVt_PVIV:
8416 case SVt_PVNV:
8417 case SVt_PVMG:
8418 case SVt_PVBM:
8419 if (SvVOK(sv))
8420 return "VSTRING";
8421 if (SvROK(sv))
8422 return "REF";
8423 else
8424 return "SCALAR";
8425
8426 case SVt_PVLV: return SvROK(sv) ? "REF"
8427 /* tied lvalues should appear to be
8428 * scalars for backwards compatitbility */
8429 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8430 ? "SCALAR" : "LVALUE";
8431 case SVt_PVAV: return "ARRAY";
8432 case SVt_PVHV: return "HASH";
8433 case SVt_PVCV: return "CODE";
8434 case SVt_PVGV: return "GLOB";
8435 case SVt_PVFM: return "FORMAT";
8436 case SVt_PVIO: return "IO";
8437 default: return "UNKNOWN";
8438 }
8439 }
8440}
8441
8442/*
8443=for apidoc sv_isobject
8444
8445Returns a boolean indicating whether the SV is an RV pointing to a blessed
8446object. If the SV is not an RV, or if the object is not blessed, then this
8447will return false.
8448
8449=cut
8450*/
8451
8452int
8453Perl_sv_isobject(pTHX_ SV *sv)
8454{
8455 if (!sv)
8456 return 0;
8457 if (SvGMAGICAL(sv))
8458 mg_get(sv);
8459 if (!SvROK(sv))
8460 return 0;
8461 sv = (SV*)SvRV(sv);
8462 if (!SvOBJECT(sv))
8463 return 0;
8464 return 1;
8465}
8466
8467/*
8468=for apidoc sv_isa
8469
8470Returns a boolean indicating whether the SV is blessed into the specified
8471class. This does not check for subtypes; use C<sv_derived_from> to verify
8472an inheritance relationship.
8473
8474=cut
8475*/
8476
8477int
8478Perl_sv_isa(pTHX_ SV *sv, const char *name)
8479{
8480 if (!sv)
8481 return 0;
8482 if (SvGMAGICAL(sv))
8483 mg_get(sv);
8484 if (!SvROK(sv))
8485 return 0;
8486 sv = (SV*)SvRV(sv);
8487 if (!SvOBJECT(sv))
8488 return 0;
8489 if (!HvNAME(SvSTASH(sv)))
8490 return 0;
8491
8492 return strEQ(HvNAME(SvSTASH(sv)), name);
8493}
8494
8495/*
8496=for apidoc newSVrv
8497
8498Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8499it will be upgraded to one. If C<classname> is non-null then the new SV will
8500be blessed in the specified package. The new SV is returned and its
8501reference count is 1.
8502
8503=cut
8504*/
8505
8506SV*
8507Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8508{
8509 SV *sv;
8510
8511 new_SV(sv);
8512
8513 SV_CHECK_THINKFIRST_COW_DROP(rv);
8514 SvAMAGIC_off(rv);
8515
8516 if (SvTYPE(rv) >= SVt_PVMG) {
8517 U32 refcnt = SvREFCNT(rv);
8518 SvREFCNT(rv) = 0;
8519 sv_clear(rv);
8520 SvFLAGS(rv) = 0;
8521 SvREFCNT(rv) = refcnt;
8522 }
8523
8524 if (SvTYPE(rv) < SVt_RV)
8525 sv_upgrade(rv, SVt_RV);
8526 else if (SvTYPE(rv) > SVt_RV) {
8527 SvOOK_off(rv);
8528 if (SvPVX(rv) && SvLEN(rv))
8529 Safefree(SvPVX(rv));
8530 SvCUR_set(rv, 0);
8531 SvLEN_set(rv, 0);
8532 }
8533
8534 SvOK_off(rv);
8535 SvRV(rv) = sv;
8536 SvROK_on(rv);
8537
8538 if (classname) {
8539 HV* stash = gv_stashpv(classname, TRUE);
8540 (void)sv_bless(rv, stash);
8541 }
8542 return sv;
8543}
8544
8545/*
8546=for apidoc sv_setref_pv
8547
8548Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8549argument will be upgraded to an RV. That RV will be modified to point to
8550the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8551into the SV. The C<classname> argument indicates the package for the
8552blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8553will have a reference count of 1, and the RV will be returned.
8554
8555Do not use with other Perl types such as HV, AV, SV, CV, because those
8556objects will become corrupted by the pointer copy process.
8557
8558Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8559
8560=cut
8561*/
8562
8563SV*
8564Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8565{
8566 if (!pv) {
8567 sv_setsv(rv, &PL_sv_undef);
8568 SvSETMAGIC(rv);
8569 }
8570 else
8571 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8572 return rv;
8573}
8574
8575/*
8576=for apidoc sv_setref_iv
8577
8578Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8579argument will be upgraded to an RV. That RV will be modified to point to
8580the new SV. The C<classname> argument indicates the package for the
8581blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8582will have a reference count of 1, and the RV will be returned.
8583
8584=cut
8585*/
8586
8587SV*
8588Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8589{
8590 sv_setiv(newSVrv(rv,classname), iv);
8591 return rv;
8592}
8593
8594/*
8595=for apidoc sv_setref_uv
8596
8597Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8598argument will be upgraded to an RV. That RV will be modified to point to
8599the new SV. The C<classname> argument indicates the package for the
8600blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8601will have a reference count of 1, and the RV will be returned.
8602
8603=cut
8604*/
8605
8606SV*
8607Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8608{
8609 sv_setuv(newSVrv(rv,classname), uv);
8610 return rv;
8611}
8612
8613/*
8614=for apidoc sv_setref_nv
8615
8616Copies a double into a new SV, optionally blessing the SV. The C<rv>
8617argument will be upgraded to an RV. That RV will be modified to point to
8618the new SV. The C<classname> argument indicates the package for the
8619blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8620will have a reference count of 1, and the RV will be returned.
8621
8622=cut
8623*/
8624
8625SV*
8626Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8627{
8628 sv_setnv(newSVrv(rv,classname), nv);
8629 return rv;
8630}
8631
8632/*
8633=for apidoc sv_setref_pvn
8634
8635Copies a string into a new SV, optionally blessing the SV. The length of the
8636string must be specified with C<n>. The C<rv> argument will be upgraded to
8637an RV. That RV will be modified to point to the new SV. The C<classname>
8638argument indicates the package for the blessing. Set C<classname> to
8639C<Nullch> to avoid the blessing. The new SV will have a reference count
8640of 1, and the RV will be returned.
8641
8642Note that C<sv_setref_pv> copies the pointer while this copies the string.
8643
8644=cut
8645*/
8646
8647SV*
8648Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8649{
8650 sv_setpvn(newSVrv(rv,classname), pv, n);
8651 return rv;
8652}
8653
8654/*
8655=for apidoc sv_bless
8656
8657Blesses an SV into a specified package. The SV must be an RV. The package
8658must be designated by its stash (see C<gv_stashpv()>). The reference count
8659of the SV is unaffected.
8660
8661=cut
8662*/
8663
8664SV*
8665Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8666{
8667 SV *tmpRef;
8668 if (!SvROK(sv))
8669 Perl_croak(aTHX_ "Can't bless non-reference value");
8670 tmpRef = SvRV(sv);
8671 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8672 if (SvREADONLY(tmpRef))
8673 Perl_croak(aTHX_ PL_no_modify);
8674 if (SvOBJECT(tmpRef)) {
8675 if (SvTYPE(tmpRef) != SVt_PVIO)
8676 --PL_sv_objcount;
8677 SvREFCNT_dec(SvSTASH(tmpRef));
8678 }
8679 }
8680 SvOBJECT_on(tmpRef);
8681 if (SvTYPE(tmpRef) != SVt_PVIO)
8682 ++PL_sv_objcount;
8683 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8684 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
8685
8686 if (Gv_AMG(stash))
8687 SvAMAGIC_on(sv);
8688 else
8689 SvAMAGIC_off(sv);
8690
8691 if(SvSMAGICAL(tmpRef))
8692 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8693 mg_set(tmpRef);
8694
8695
8696
8697 return sv;
8698}
8699
8700/* Downgrades a PVGV to a PVMG.
8701 */
8702
8703STATIC void
8704S_sv_unglob(pTHX_ SV *sv)
8705{
8706 void *xpvmg;
8707
8708 assert(SvTYPE(sv) == SVt_PVGV);
8709 SvFAKE_off(sv);
8710 if (GvGP(sv))
8711 gp_free((GV*)sv);
8712 if (GvSTASH(sv)) {
8713 SvREFCNT_dec(GvSTASH(sv));
8714 GvSTASH(sv) = Nullhv;
8715 }
8716 sv_unmagic(sv, PERL_MAGIC_glob);
8717 Safefree(GvNAME(sv));
8718 GvMULTI_off(sv);
8719
8720 /* need to keep SvANY(sv) in the right arena */
8721 xpvmg = new_XPVMG();
8722 StructCopy(SvANY(sv), xpvmg, XPVMG);
8723 del_XPVGV(SvANY(sv));
8724 SvANY(sv) = xpvmg;
8725
8726 SvFLAGS(sv) &= ~SVTYPEMASK;
8727 SvFLAGS(sv) |= SVt_PVMG;
8728}
8729
8730/*
8731=for apidoc sv_unref_flags
8732
8733Unsets the RV status of the SV, and decrements the reference count of
8734whatever was being referenced by the RV. This can almost be thought of
8735as a reversal of C<newSVrv>. The C<cflags> argument can contain
8736C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8737(otherwise the decrementing is conditional on the reference count being
8738different from one or the reference being a readonly SV).
8739See C<SvROK_off>.
8740
8741=cut
8742*/
8743
8744void
8745Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8746{
8747 SV* rv = SvRV(sv);
8748
8749 if (SvWEAKREF(sv)) {
8750 sv_del_backref(sv);
8751 SvWEAKREF_off(sv);
8752 SvRV(sv) = 0;
8753 return;
8754 }
8755 SvRV(sv) = 0;
8756 SvROK_off(sv);
8757 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8758 assigned to as BEGIN {$a = \"Foo"} will fail. */
8759 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8760 SvREFCNT_dec(rv);
8761 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8762 sv_2mortal(rv); /* Schedule for freeing later */
8763}
8764
8765/*
8766=for apidoc sv_unref
8767
8768Unsets the RV status of the SV, and decrements the reference count of
8769whatever was being referenced by the RV. This can almost be thought of
8770as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8771being zero. See C<SvROK_off>.
8772
8773=cut
8774*/
8775
8776void
8777Perl_sv_unref(pTHX_ SV *sv)
8778{
8779 sv_unref_flags(sv, 0);
8780}
8781
8782/*
8783=for apidoc sv_taint
8784
8785Taint an SV. Use C<SvTAINTED_on> instead.
8786=cut
8787*/
8788
8789void
8790Perl_sv_taint(pTHX_ SV *sv)
8791{
8792 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8793}
8794
8795/*
8796=for apidoc sv_untaint
8797
8798Untaint an SV. Use C<SvTAINTED_off> instead.
8799=cut
8800*/
8801
8802void
8803Perl_sv_untaint(pTHX_ SV *sv)
8804{
8805 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8806 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8807 if (mg)
8808 mg->mg_len &= ~1;
8809 }
8810}
8811
8812/*
8813=for apidoc sv_tainted
8814
8815Test an SV for taintedness. Use C<SvTAINTED> instead.
8816=cut
8817*/
8818
8819bool
8820Perl_sv_tainted(pTHX_ SV *sv)
8821{
8822 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8823 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8824 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8825 return TRUE;
8826 }
8827 return FALSE;
8828}
8829
8830/*
8831=for apidoc sv_setpviv
8832
8833Copies an integer into the given SV, also updating its string value.
8834Does not handle 'set' magic. See C<sv_setpviv_mg>.
8835
8836=cut
8837*/
8838
8839void
8840Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8841{
8842 char buf[TYPE_CHARS(UV)];
8843 char *ebuf;
8844 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8845
8846 sv_setpvn(sv, ptr, ebuf - ptr);
8847}
8848
8849/*
8850=for apidoc sv_setpviv_mg
8851
8852Like C<sv_setpviv>, but also handles 'set' magic.
8853
8854=cut
8855*/
8856
8857void
8858Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8859{
8860 char buf[TYPE_CHARS(UV)];
8861 char *ebuf;
8862 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8863
8864 sv_setpvn(sv, ptr, ebuf - ptr);
8865 SvSETMAGIC(sv);
8866}
8867
8868#if defined(PERL_IMPLICIT_CONTEXT)
8869
8870/* pTHX_ magic can't cope with varargs, so this is a no-context
8871 * version of the main function, (which may itself be aliased to us).
8872 * Don't access this version directly.
8873 */
8874
8875void
8876Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8877{
8878 dTHX;
8879 va_list args;
8880 va_start(args, pat);
8881 sv_vsetpvf(sv, pat, &args);
8882 va_end(args);
8883}
8884
8885/* pTHX_ magic can't cope with varargs, so this is a no-context
8886 * version of the main function, (which may itself be aliased to us).
8887 * Don't access this version directly.
8888 */
8889
8890void
8891Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8892{
8893 dTHX;
8894 va_list args;
8895 va_start(args, pat);
8896 sv_vsetpvf_mg(sv, pat, &args);
8897 va_end(args);
8898}
8899#endif
8900
8901/*
8902=for apidoc sv_setpvf
8903
8904Works like C<sv_catpvf> but copies the text into the SV instead of
8905appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8906
8907=cut
8908*/
8909
8910void
8911Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8912{
8913 va_list args;
8914 va_start(args, pat);
8915 sv_vsetpvf(sv, pat, &args);
8916 va_end(args);
8917}
8918
8919/*
8920=for apidoc sv_vsetpvf
8921
8922Works like C<sv_vcatpvf> but copies the text into the SV instead of
8923appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8924
8925Usually used via its frontend C<sv_setpvf>.
8926
8927=cut
8928*/
8929
8930void
8931Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8932{
8933 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8934}
8935
8936/*
8937=for apidoc sv_setpvf_mg
8938
8939Like C<sv_setpvf>, but also handles 'set' magic.
8940
8941=cut
8942*/
8943
8944void
8945Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8946{
8947 va_list args;
8948 va_start(args, pat);
8949 sv_vsetpvf_mg(sv, pat, &args);
8950 va_end(args);
8951}
8952
8953/*
8954=for apidoc sv_vsetpvf_mg
8955
8956Like C<sv_vsetpvf>, but also handles 'set' magic.
8957
8958Usually used via its frontend C<sv_setpvf_mg>.
8959
8960=cut
8961*/
8962
8963void
8964Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8965{
8966 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8967 SvSETMAGIC(sv);
8968}
8969
8970#if defined(PERL_IMPLICIT_CONTEXT)
8971
8972/* pTHX_ magic can't cope with varargs, so this is a no-context
8973 * version of the main function, (which may itself be aliased to us).
8974 * Don't access this version directly.
8975 */
8976
8977void
8978Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8979{
8980 dTHX;
8981 va_list args;
8982 va_start(args, pat);
8983 sv_vcatpvf(sv, pat, &args);
8984 va_end(args);
8985}
8986
8987/* pTHX_ magic can't cope with varargs, so this is a no-context
8988 * version of the main function, (which may itself be aliased to us).
8989 * Don't access this version directly.
8990 */
8991
8992void
8993Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8994{
8995 dTHX;
8996 va_list args;
8997 va_start(args, pat);
8998 sv_vcatpvf_mg(sv, pat, &args);
8999 va_end(args);
9000}
9001#endif
9002
9003/*
9004=for apidoc sv_catpvf
9005
9006Processes its arguments like C<sprintf> and appends the formatted
9007output to an SV. If the appended data contains "wide" characters
9008(including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9009and characters >255 formatted with %c), the original SV might get
9010upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9011C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9012valid UTF-8; if the original SV was bytes, the pattern should be too.
9013
9014=cut */
9015
9016void
9017Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
9018{
9019 va_list args;
9020 va_start(args, pat);
9021 sv_vcatpvf(sv, pat, &args);
9022 va_end(args);
9023}
9024
9025/*
9026=for apidoc sv_vcatpvf
9027
9028Processes its arguments like C<vsprintf> and appends the formatted output
9029to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9030
9031Usually used via its frontend C<sv_catpvf>.
9032
9033=cut
9034*/
9035
9036void
9037Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9038{
9039 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9040}
9041
9042/*
9043=for apidoc sv_catpvf_mg
9044
9045Like C<sv_catpvf>, but also handles 'set' magic.
9046
9047=cut
9048*/
9049
9050void
9051Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9052{
9053 va_list args;
9054 va_start(args, pat);
9055 sv_vcatpvf_mg(sv, pat, &args);
9056 va_end(args);
9057}
9058
9059/*
9060=for apidoc sv_vcatpvf_mg
9061
9062Like C<sv_vcatpvf>, but also handles 'set' magic.
9063
9064Usually used via its frontend C<sv_catpvf_mg>.
9065
9066=cut
9067*/
9068
9069void
9070Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9071{
9072 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9073 SvSETMAGIC(sv);
9074}
9075
9076/*
9077=for apidoc sv_vsetpvfn
9078
9079Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9080appending it.
9081
9082Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9083
9084=cut
9085*/
9086
9087void
9088Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9089{
9090 sv_setpvn(sv, "", 0);
9091 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9092}
9093
9094/* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9095
9096STATIC I32
9097S_expect_number(pTHX_ char** pattern)
9098{
9099 I32 var = 0;
9100 switch (**pattern) {
9101 case '1': case '2': case '3':
9102 case '4': case '5': case '6':
9103 case '7': case '8': case '9':
9104 while (isDIGIT(**pattern))
9105 var = var * 10 + (*(*pattern)++ - '0');
9106 }
9107 return var;
9108}
9109#define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9110
9111static char *
9112F0convert(NV nv, char *endbuf, STRLEN *len)
9113{
9114 int neg = nv < 0;
9115 UV uv;
9116 char *p = endbuf;
9117
9118 if (neg)
9119 nv = -nv;
9120 if (nv < UV_MAX) {
9121 nv += 0.5;
9122 uv = (UV)nv;
9123 if (uv & 1 && uv == nv)
9124 uv--; /* Round to even */
9125 do {
9126 unsigned dig = uv % 10;
9127 *--p = '0' + dig;
9128 } while (uv /= 10);
9129 if (neg)
9130 *--p = '-';
9131 *len = endbuf - p;
9132 return p;
9133 }
9134 return Nullch;
9135}
9136
9137
9138/*
9139=for apidoc sv_vcatpvfn
9140
9141Processes its arguments like C<vsprintf> and appends the formatted output
9142to an SV. Uses an array of SVs if the C style variable argument list is
9143missing (NULL). When running with taint checks enabled, indicates via
9144C<maybe_tainted> if results are untrustworthy (often due to the use of
9145locales).
9146
9147Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9148
9149=cut
9150*/
9151
9152void
9153Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9154{
9155 char *p;
9156 char *q;
9157 char *patend;
9158 STRLEN origlen;
9159 I32 svix = 0;
9160 static char nullstr[] = "(null)";
9161 SV *argsv = Nullsv;
9162 bool has_utf8; /* has the result utf8? */
9163 bool pat_utf8; /* the pattern is in utf8? */
9164 SV *nsv = Nullsv;
9165 /* Times 4: a decimal digit takes more than 3 binary digits.
9166 * NV_DIG: mantissa takes than many decimal digits.
9167 * Plus 32: Playing safe. */
9168 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9169 /* large enough for "%#.#f" --chip */
9170 /* what about long double NVs? --jhi */
9171
9172 has_utf8 = pat_utf8 = DO_UTF8(sv);
9173
9174 /* no matter what, this is a string now */
9175 (void)SvPV_force(sv, origlen);
9176
9177 /* special-case "", "%s", and "%_" */
9178 if (patlen == 0)
9179 return;
9180 if (patlen == 2 && pat[0] == '%') {
9181 switch (pat[1]) {
9182 case 's':
9183 if (args) {
9184 char *s = va_arg(*args, char*);
9185 sv_catpv(sv, s ? s : nullstr);
9186 }
9187 else if (svix < svmax) {
9188 sv_catsv(sv, *svargs);
9189 if (DO_UTF8(*svargs))
9190 SvUTF8_on(sv);
9191 }
9192 return;
9193 case '_':
9194 if (args) {
9195 argsv = va_arg(*args, SV*);
9196 sv_catsv(sv, argsv);
9197 if (DO_UTF8(argsv))
9198 SvUTF8_on(sv);
9199 return;
9200 }
9201 /* See comment on '_' below */
9202 break;
9203 }
9204 }
9205
9206#ifndef USE_LONG_DOUBLE
9207 /* special-case "%.<number>[gf]" */
9208 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9209 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9210 unsigned digits = 0;
9211 const char *pp;
9212
9213 pp = pat + 2;
9214 while (*pp >= '0' && *pp <= '9')
9215 digits = 10 * digits + (*pp++ - '0');
9216 if (pp - pat == (int)patlen - 1) {
9217 NV nv;
9218
9219 if (args)
9220 nv = (NV)va_arg(*args, double);
9221 else if (svix < svmax)
9222 nv = SvNV(*svargs);
9223 else
9224 return;
9225 if (*pp == 'g') {
9226 /* Add check for digits != 0 because it seems that some
9227 gconverts are buggy in this case, and we don't yet have
9228 a Configure test for this. */
9229 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9230 /* 0, point, slack */
9231 Gconvert(nv, (int)digits, 0, ebuf);
9232 sv_catpv(sv, ebuf);
9233 if (*ebuf) /* May return an empty string for digits==0 */
9234 return;
9235 }
9236 } else if (!digits) {
9237 STRLEN l;
9238
9239 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9240 sv_catpvn(sv, p, l);
9241 return;
9242 }
9243 }
9244 }
9245 }
9246#endif /* !USE_LONG_DOUBLE */
9247
9248 if (!args && svix < svmax && DO_UTF8(*svargs))
9249 has_utf8 = TRUE;
9250
9251 patend = (char*)pat + patlen;
9252 for (p = (char*)pat; p < patend; p = q) {
9253 bool alt = FALSE;
9254 bool left = FALSE;
9255 bool vectorize = FALSE;
9256 bool vectorarg = FALSE;
9257 bool vec_utf8 = FALSE;
9258 char fill = ' ';
9259 char plus = 0;
9260 char intsize = 0;
9261 STRLEN width = 0;
9262 STRLEN zeros = 0;
9263 bool has_precis = FALSE;
9264 STRLEN precis = 0;
9265 I32 osvix = svix;
9266 bool is_utf8 = FALSE; /* is this item utf8? */
9267#ifdef HAS_LDBL_SPRINTF_BUG
9268 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9269 with sfio - Allen <allens@cpan.org> */
9270 bool fix_ldbl_sprintf_bug = FALSE;
9271#endif
9272
9273 char esignbuf[4];
9274 U8 utf8buf[UTF8_MAXBYTES+1];
9275 STRLEN esignlen = 0;
9276
9277 char *eptr = Nullch;
9278 STRLEN elen = 0;
9279 SV *vecsv = Nullsv;
9280 U8 *vecstr = Null(U8*);
9281 STRLEN veclen = 0;
9282 char c = 0;
9283 int i;
9284 unsigned base = 0;
9285 IV iv = 0;
9286 UV uv = 0;
9287 /* we need a long double target in case HAS_LONG_DOUBLE but
9288 not USE_LONG_DOUBLE
9289 */
9290#if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9291 long double nv;
9292#else
9293 NV nv;
9294#endif
9295 STRLEN have;
9296 STRLEN need;
9297 STRLEN gap;
9298 char *dotstr = ".";
9299 STRLEN dotstrlen = 1;
9300 I32 efix = 0; /* explicit format parameter index */
9301 I32 ewix = 0; /* explicit width index */
9302 I32 epix = 0; /* explicit precision index */
9303 I32 evix = 0; /* explicit vector index */
9304 bool asterisk = FALSE;
9305
9306 /* echo everything up to the next format specification */
9307 for (q = p; q < patend && *q != '%'; ++q) ;
9308 if (q > p) {
9309 if (has_utf8 && !pat_utf8)
9310 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9311 else
9312 sv_catpvn(sv, p, q - p);
9313 p = q;
9314 }
9315 if (q++ >= patend)
9316 break;
9317
9318/*
9319 We allow format specification elements in this order:
9320 \d+\$ explicit format parameter index
9321 [-+ 0#]+ flags
9322 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9323 0 flag (as above): repeated to allow "v02"
9324 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9325 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9326 [hlqLV] size
9327 [%bcdefginopsux_DFOUX] format (mandatory)
9328*/
9329 if (EXPECT_NUMBER(q, width)) {
9330 if (*q == '$') {
9331 ++q;
9332 efix = width;
9333 } else {
9334 goto gotwidth;
9335 }
9336 }
9337
9338 /* FLAGS */
9339
9340 while (*q) {
9341 switch (*q) {
9342 case ' ':
9343 case '+':
9344 plus = *q++;
9345 continue;
9346
9347 case '-':
9348 left = TRUE;
9349 q++;
9350 continue;
9351
9352 case '0':
9353 fill = *q++;
9354 continue;
9355
9356 case '#':
9357 alt = TRUE;
9358 q++;
9359 continue;
9360
9361 default:
9362 break;
9363 }
9364 break;
9365 }
9366
9367 tryasterisk:
9368 if (*q == '*') {
9369 q++;
9370 if (EXPECT_NUMBER(q, ewix))
9371 if (*q++ != '$')
9372 goto unknown;
9373 asterisk = TRUE;
9374 }
9375 if (*q == 'v') {
9376 q++;
9377 if (vectorize)
9378 goto unknown;
9379 if ((vectorarg = asterisk)) {
9380 evix = ewix;
9381 ewix = 0;
9382 asterisk = FALSE;
9383 }
9384 vectorize = TRUE;
9385 goto tryasterisk;
9386 }
9387
9388 if (!asterisk)
9389 if( *q == '0' )
9390 fill = *q++;
9391 EXPECT_NUMBER(q, width);
9392
9393 if (vectorize) {
9394 if (vectorarg) {
9395 if (args)
9396 vecsv = va_arg(*args, SV*);
9397 else
9398 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9399 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9400 dotstr = SvPVx(vecsv, dotstrlen);
9401 if (DO_UTF8(vecsv))
9402 is_utf8 = TRUE;
9403 }
9404 if (args) {
9405 vecsv = va_arg(*args, SV*);
9406 vecstr = (U8*)SvPVx(vecsv,veclen);
9407 vec_utf8 = DO_UTF8(vecsv);
9408 }
9409 else if (efix ? efix <= svmax : svix < svmax) {
9410 vecsv = svargs[efix ? efix-1 : svix++];
9411 vecstr = (U8*)SvPVx(vecsv,veclen);
9412 vec_utf8 = DO_UTF8(vecsv);
9413 /* if this is a version object, we need to return the
9414 * stringified representation (which the SvPVX has
9415 * already done for us), but not vectorize the args
9416 */
9417 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9418 {
9419 q++; /* skip past the rest of the %vd format */
9420 eptr = (char *) vecstr;
9421 elen = strlen(eptr);
9422 vectorize=FALSE;
9423 goto string;
9424 }
9425 }
9426 else {
9427 vecstr = (U8*)"";
9428 veclen = 0;
9429 }
9430 }
9431
9432 if (asterisk) {
9433 if (args)
9434 i = va_arg(*args, int);
9435 else
9436 i = (ewix ? ewix <= svmax : svix < svmax) ?
9437 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9438 left |= (i < 0);
9439 width = (i < 0) ? -i : i;
9440 }
9441 gotwidth:
9442
9443 /* PRECISION */
9444
9445 if (*q == '.') {
9446 q++;
9447 if (*q == '*') {
9448 q++;
9449 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9450 goto unknown;
9451 /* XXX: todo, support specified precision parameter */
9452 if (epix)
9453 goto unknown;
9454 if (args)
9455 i = va_arg(*args, int);
9456 else
9457 i = (ewix ? ewix <= svmax : svix < svmax)
9458 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9459 precis = (i < 0) ? 0 : i;
9460 }
9461 else {
9462 precis = 0;
9463 while (isDIGIT(*q))
9464 precis = precis * 10 + (*q++ - '0');
9465 }
9466 has_precis = TRUE;
9467 }
9468
9469 /* SIZE */
9470
9471 switch (*q) {
9472#ifdef WIN32
9473 case 'I': /* Ix, I32x, and I64x */
9474# ifdef WIN64
9475 if (q[1] == '6' && q[2] == '4') {
9476 q += 3;
9477 intsize = 'q';
9478 break;
9479 }
9480# endif
9481 if (q[1] == '3' && q[2] == '2') {
9482 q += 3;
9483 break;
9484 }
9485# ifdef WIN64
9486 intsize = 'q';
9487# endif
9488 q++;
9489 break;
9490#endif
9491#if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9492 case 'L': /* Ld */
9493 /* FALL THROUGH */
9494#ifdef HAS_QUAD
9495 case 'q': /* qd */
9496#endif
9497 intsize = 'q';
9498 q++;
9499 break;
9500#endif
9501 case 'l':
9502#if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9503 if (*(q + 1) == 'l') { /* lld, llf */
9504 intsize = 'q';
9505 q += 2;
9506 break;
9507 }
9508#endif
9509 /* FALL THROUGH */
9510 case 'h':
9511 /* FALL THROUGH */
9512 case 'V':
9513 intsize = *q++;
9514 break;
9515 }
9516
9517 /* CONVERSION */
9518
9519 if (*q == '%') {
9520 eptr = q++;
9521 elen = 1;
9522 goto string;
9523 }
9524
9525 if (vectorize)
9526 argsv = vecsv;
9527 else if (!args)
9528 argsv = (efix ? efix <= svmax : svix < svmax) ?
9529 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9530
9531 switch (c = *q++) {
9532
9533 /* STRINGS */
9534
9535 case 'c':
9536 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9537 if ((uv > 255 ||
9538 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9539 && !IN_BYTES) {
9540 eptr = (char*)utf8buf;
9541 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9542 is_utf8 = TRUE;
9543 }
9544 else {
9545 c = (char)uv;
9546 eptr = &c;
9547 elen = 1;
9548 }
9549 goto string;
9550
9551 case 's':
9552 if (args && !vectorize) {
9553 eptr = va_arg(*args, char*);
9554 if (eptr)
9555#ifdef MACOS_TRADITIONAL
9556 /* On MacOS, %#s format is used for Pascal strings */
9557 if (alt)
9558 elen = *eptr++;
9559 else
9560#endif
9561 elen = strlen(eptr);
9562 else {
9563 eptr = nullstr;
9564 elen = sizeof nullstr - 1;
9565 }
9566 }
9567 else {
9568 eptr = SvPVx(argsv, elen);
9569 if (DO_UTF8(argsv)) {
9570 if (has_precis && precis < elen) {
9571 I32 p = precis;
9572 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9573 precis = p;
9574 }
9575 if (width) { /* fudge width (can't fudge elen) */
9576 width += elen - sv_len_utf8(argsv);
9577 }
9578 is_utf8 = TRUE;
9579 }
9580 }
9581 goto string;
9582
9583 case '_':
9584#ifdef CHECK_FORMAT
9585 format_sv:
9586#endif
9587 /*
9588 * The "%_" hack might have to be changed someday,
9589 * if ISO or ANSI decide to use '_' for something.
9590 * So we keep it hidden from users' code.
9591 */
9592 if (!args || vectorize)
9593 goto unknown;
9594 argsv = va_arg(*args, SV*);
9595 eptr = SvPVx(argsv, elen);
9596 if (DO_UTF8(argsv))
9597 is_utf8 = TRUE;
9598
9599 string:
9600 vectorize = FALSE;
9601 if (has_precis && elen > precis)
9602 elen = precis;
9603 break;
9604
9605 /* INTEGERS */
9606
9607 case 'p':
9608#ifdef CHECK_FORMAT
9609 if (left) {
9610 left = FALSE;
9611 if (!width)
9612 goto format_sv; /* %-p -> %_ */
9613 precis = width;
9614 has_precis = TRUE;
9615 width = 0;
9616 goto format_sv; /* %-Np -> %.N_ */
9617 }
9618#endif
9619 if (alt || vectorize)
9620 goto unknown;
9621 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9622 base = 16;
9623 goto integer;
9624
9625 case 'D':
9626#ifdef IV_IS_QUAD
9627 intsize = 'q';
9628#else
9629 intsize = 'l';
9630#endif
9631 /* FALL THROUGH */
9632 case 'd':
9633 case 'i':
9634 if (vectorize) {
9635 STRLEN ulen;
9636 if (!veclen)
9637 continue;
9638 if (vec_utf8)
9639 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9640 UTF8_ALLOW_ANYUV);
9641 else {
9642 uv = *vecstr;
9643 ulen = 1;
9644 }
9645 vecstr += ulen;
9646 veclen -= ulen;
9647 if (plus)
9648 esignbuf[esignlen++] = plus;
9649 }
9650 else if (args) {
9651 switch (intsize) {
9652 case 'h': iv = (short)va_arg(*args, int); break;
9653 case 'l': iv = va_arg(*args, long); break;
9654 case 'V': iv = va_arg(*args, IV); break;
9655 default: iv = va_arg(*args, int); break;
9656#ifdef HAS_QUAD
9657 case 'q': iv = va_arg(*args, Quad_t); break;
9658#endif
9659 }
9660 }
9661 else {
9662 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9663 switch (intsize) {
9664 case 'h': iv = (short)tiv; break;
9665 case 'l': iv = (long)tiv; break;
9666 case 'V':
9667 default: iv = tiv; break;
9668#ifdef HAS_QUAD
9669 case 'q': iv = (Quad_t)tiv; break;
9670#endif
9671 }
9672 }
9673 if ( !vectorize ) /* we already set uv above */
9674 {
9675 if (iv >= 0) {
9676 uv = iv;
9677 if (plus)
9678 esignbuf[esignlen++] = plus;
9679 }
9680 else {
9681 uv = -iv;
9682 esignbuf[esignlen++] = '-';
9683 }
9684 }
9685 base = 10;
9686 goto integer;
9687
9688 case 'U':
9689#ifdef IV_IS_QUAD
9690 intsize = 'q';
9691#else
9692 intsize = 'l';
9693#endif
9694 /* FALL THROUGH */
9695 case 'u':
9696 base = 10;
9697 goto uns_integer;
9698
9699 case 'b':
9700 base = 2;
9701 goto uns_integer;
9702
9703 case 'O':
9704#ifdef IV_IS_QUAD
9705 intsize = 'q';
9706#else
9707 intsize = 'l';
9708#endif
9709 /* FALL THROUGH */
9710 case 'o':
9711 base = 8;
9712 goto uns_integer;
9713
9714 case 'X':
9715 case 'x':
9716 base = 16;
9717
9718 uns_integer:
9719 if (vectorize) {
9720 STRLEN ulen;
9721 vector:
9722 if (!veclen)
9723 continue;
9724 if (vec_utf8)
9725 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9726 UTF8_ALLOW_ANYUV);
9727 else {
9728 uv = *vecstr;
9729 ulen = 1;
9730 }
9731 vecstr += ulen;
9732 veclen -= ulen;
9733 }
9734 else if (args) {
9735 switch (intsize) {
9736 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9737 case 'l': uv = va_arg(*args, unsigned long); break;
9738 case 'V': uv = va_arg(*args, UV); break;
9739 default: uv = va_arg(*args, unsigned); break;
9740#ifdef HAS_QUAD
9741 case 'q': uv = va_arg(*args, Uquad_t); break;
9742#endif
9743 }
9744 }
9745 else {
9746 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9747 switch (intsize) {
9748 case 'h': uv = (unsigned short)tuv; break;
9749 case 'l': uv = (unsigned long)tuv; break;
9750 case 'V':
9751 default: uv = tuv; break;
9752#ifdef HAS_QUAD
9753 case 'q': uv = (Uquad_t)tuv; break;
9754#endif
9755 }
9756 }
9757
9758 integer:
9759 eptr = ebuf + sizeof ebuf;
9760 switch (base) {
9761 unsigned dig;
9762 case 16:
9763 if (!uv)
9764 alt = FALSE;
9765 p = (char*)((c == 'X')
9766 ? "0123456789ABCDEF" : "0123456789abcdef");
9767 do {
9768 dig = uv & 15;
9769 *--eptr = p[dig];
9770 } while (uv >>= 4);
9771 if (alt) {
9772 esignbuf[esignlen++] = '0';
9773 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9774 }
9775 break;
9776 case 8:
9777 do {
9778 dig = uv & 7;
9779 *--eptr = '0' + dig;
9780 } while (uv >>= 3);
9781 if (alt && *eptr != '0')
9782 *--eptr = '0';
9783 break;
9784 case 2:
9785 do {
9786 dig = uv & 1;
9787 *--eptr = '0' + dig;
9788 } while (uv >>= 1);
9789 if (alt) {
9790 esignbuf[esignlen++] = '0';
9791 esignbuf[esignlen++] = 'b';
9792 }
9793 break;
9794 default: /* it had better be ten or less */
9795#if defined(PERL_Y2KWARN)
9796 if (ckWARN(WARN_Y2K)) {
9797 STRLEN n;
9798 char *s = SvPV(sv,n);
9799 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9800 && (n == 2 || !isDIGIT(s[n-3])))
9801 {
9802 Perl_warner(aTHX_ packWARN(WARN_Y2K),
9803 "Possible Y2K bug: %%%c %s",
9804 c, "format string following '19'");
9805 }
9806 }
9807#endif
9808 do {
9809 dig = uv % base;
9810 *--eptr = '0' + dig;
9811 } while (uv /= base);
9812 break;
9813 }
9814 elen = (ebuf + sizeof ebuf) - eptr;
9815 if (has_precis) {
9816 if (precis > elen)
9817 zeros = precis - elen;
9818 else if (precis == 0 && elen == 1 && *eptr == '0')
9819 elen = 0;
9820 }
9821 break;
9822
9823 /* FLOATING POINT */
9824
9825 case 'F':
9826 c = 'f'; /* maybe %F isn't supported here */
9827 /* FALL THROUGH */
9828 case 'e': case 'E':
9829 case 'f':
9830 case 'g': case 'G':
9831
9832 /* This is evil, but floating point is even more evil */
9833
9834 /* for SV-style calling, we can only get NV
9835 for C-style calling, we assume %f is double;
9836 for simplicity we allow any of %Lf, %llf, %qf for long double
9837 */
9838 switch (intsize) {
9839 case 'V':
9840#if defined(USE_LONG_DOUBLE)
9841 intsize = 'q';
9842#endif
9843 break;
9844/* [perl #20339] - we should accept and ignore %lf rather than die */
9845 case 'l':
9846 /* FALL THROUGH */
9847 default:
9848#if defined(USE_LONG_DOUBLE)
9849 intsize = args ? 0 : 'q';
9850#endif
9851 break;
9852 case 'q':
9853#if defined(HAS_LONG_DOUBLE)
9854 break;
9855#else
9856 /* FALL THROUGH */
9857#endif
9858 case 'h':
9859 goto unknown;
9860 }
9861
9862 /* now we need (long double) if intsize == 'q', else (double) */
9863 nv = (args && !vectorize) ?
9864#if LONG_DOUBLESIZE > DOUBLESIZE
9865 intsize == 'q' ?
9866 va_arg(*args, long double) :
9867 va_arg(*args, double)
9868#else
9869 va_arg(*args, double)
9870#endif
9871 : SvNVx(argsv);
9872
9873 need = 0;
9874 vectorize = FALSE;
9875 if (c != 'e' && c != 'E') {
9876 i = PERL_INT_MIN;
9877 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9878 will cast our (long double) to (double) */
9879 (void)Perl_frexp(nv, &i);
9880 if (i == PERL_INT_MIN)
9881 Perl_die(aTHX_ "panic: frexp");
9882 if (i > 0)
9883 need = BIT_DIGITS(i);
9884 }
9885 need += has_precis ? precis : 6; /* known default */
9886
9887 if (need < width)
9888 need = width;
9889
9890#ifdef HAS_LDBL_SPRINTF_BUG
9891 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9892 with sfio - Allen <allens@cpan.org> */
9893
9894# ifdef DBL_MAX
9895# define MY_DBL_MAX DBL_MAX
9896# else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9897# if DOUBLESIZE >= 8
9898# define MY_DBL_MAX 1.7976931348623157E+308L
9899# else
9900# define MY_DBL_MAX 3.40282347E+38L
9901# endif
9902# endif
9903
9904# ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9905# define MY_DBL_MAX_BUG 1L
9906# else
9907# define MY_DBL_MAX_BUG MY_DBL_MAX
9908# endif
9909
9910# ifdef DBL_MIN
9911# define MY_DBL_MIN DBL_MIN
9912# else /* XXX guessing! -Allen */
9913# if DOUBLESIZE >= 8
9914# define MY_DBL_MIN 2.2250738585072014E-308L
9915# else
9916# define MY_DBL_MIN 1.17549435E-38L
9917# endif
9918# endif
9919
9920 if ((intsize == 'q') && (c == 'f') &&
9921 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9922 (need < DBL_DIG)) {
9923 /* it's going to be short enough that
9924 * long double precision is not needed */
9925
9926 if ((nv <= 0L) && (nv >= -0L))
9927 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9928 else {
9929 /* would use Perl_fp_class as a double-check but not
9930 * functional on IRIX - see perl.h comments */
9931
9932 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9933 /* It's within the range that a double can represent */
9934#if defined(DBL_MAX) && !defined(DBL_MIN)
9935 if ((nv >= ((long double)1/DBL_MAX)) ||
9936 (nv <= (-(long double)1/DBL_MAX)))
9937#endif
9938 fix_ldbl_sprintf_bug = TRUE;
9939 }
9940 }
9941 if (fix_ldbl_sprintf_bug == TRUE) {
9942 double temp;
9943
9944 intsize = 0;
9945 temp = (double)nv;
9946 nv = (NV)temp;
9947 }
9948 }
9949
9950# undef MY_DBL_MAX
9951# undef MY_DBL_MAX_BUG
9952# undef MY_DBL_MIN
9953
9954#endif /* HAS_LDBL_SPRINTF_BUG */
9955
9956 need += 20; /* fudge factor */
9957 if (PL_efloatsize < need) {
9958 Safefree(PL_efloatbuf);
9959 PL_efloatsize = need + 20; /* more fudge */
9960 New(906, PL_efloatbuf, PL_efloatsize, char);
9961 PL_efloatbuf[0] = '\0';
9962 }
9963
9964 if ( !(width || left || plus || alt) && fill != '0'
9965 && has_precis && intsize != 'q' ) { /* Shortcuts */
9966 /* See earlier comment about buggy Gconvert when digits,
9967 aka precis is 0 */
9968 if ( c == 'g' && precis) {
9969 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9970 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9971 goto float_converted;
9972 } else if ( c == 'f' && !precis) {
9973 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9974 break;
9975 }
9976 }
9977 eptr = ebuf + sizeof ebuf;
9978 *--eptr = '\0';
9979 *--eptr = c;
9980 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9981#if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9982 if (intsize == 'q') {
9983 /* Copy the one or more characters in a long double
9984 * format before the 'base' ([efgEFG]) character to
9985 * the format string. */
9986 static char const prifldbl[] = PERL_PRIfldbl;
9987 char const *p = prifldbl + sizeof(prifldbl) - 3;
9988 while (p >= prifldbl) { *--eptr = *p--; }
9989 }
9990#endif
9991 if (has_precis) {
9992 base = precis;
9993 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9994 *--eptr = '.';
9995 }
9996 if (width) {
9997 base = width;
9998 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9999 }
10000 if (fill == '0')
10001 *--eptr = fill;
10002 if (left)
10003 *--eptr = '-';
10004 if (plus)
10005 *--eptr = plus;
10006 if (alt)
10007 *--eptr = '#';
10008 *--eptr = '%';
10009
10010 /* No taint. Otherwise we are in the strange situation
10011 * where printf() taints but print($float) doesn't.
10012 * --jhi */
10013#if defined(HAS_LONG_DOUBLE)
10014 if (intsize == 'q')
10015 (void)sprintf(PL_efloatbuf, eptr, nv);
10016 else
10017 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
10018#else
10019 (void)sprintf(PL_efloatbuf, eptr, nv);
10020#endif
10021 float_converted:
10022 eptr = PL_efloatbuf;
10023 elen = strlen(PL_efloatbuf);
10024 break;
10025
10026 /* SPECIAL */
10027
10028 case 'n':
10029 i = SvCUR(sv) - origlen;
10030 if (args && !vectorize) {
10031 switch (intsize) {
10032 case 'h': *(va_arg(*args, short*)) = i; break;
10033 default: *(va_arg(*args, int*)) = i; break;
10034 case 'l': *(va_arg(*args, long*)) = i; break;
10035 case 'V': *(va_arg(*args, IV*)) = i; break;
10036#ifdef HAS_QUAD
10037 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10038#endif
10039 }
10040 }
10041 else
10042 sv_setuv_mg(argsv, (UV)i);
10043 vectorize = FALSE;
10044 continue; /* not "break" */
10045
10046 /* UNKNOWN */
10047
10048 default:
10049 unknown:
10050 if (!args && ckWARN(WARN_PRINTF) &&
10051 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
10052 SV *msg = sv_newmortal();
10053 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10054 (PL_op->op_type == OP_PRTF) ? "" : "s");
10055 if (c) {
10056 if (isPRINT(c))
10057 Perl_sv_catpvf(aTHX_ msg,
10058 "\"%%%c\"", c & 0xFF);
10059 else
10060 Perl_sv_catpvf(aTHX_ msg,
10061 "\"%%\\%03"UVof"\"",
10062 (UV)c & 0xFF);
10063 } else
10064 sv_catpv(msg, "end of string");
10065 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10066 }
10067
10068 /* output mangled stuff ... */
10069 if (c == '\0')
10070 --q;
10071 eptr = p;
10072 elen = q - p;
10073
10074 /* ... right here, because formatting flags should not apply */
10075 SvGROW(sv, SvCUR(sv) + elen + 1);
10076 p = SvEND(sv);
10077 Copy(eptr, p, elen, char);
10078 p += elen;
10079 *p = '\0';
10080 SvCUR(sv) = p - SvPVX(sv);
10081 svix = osvix;
10082 continue; /* not "break" */
10083 }
10084
10085 /* calculate width before utf8_upgrade changes it */
10086 have = esignlen + zeros + elen;
10087
10088 if (is_utf8 != has_utf8) {
10089 if (is_utf8) {
10090 if (SvCUR(sv))
10091 sv_utf8_upgrade(sv);
10092 }
10093 else {
10094 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10095 sv_utf8_upgrade(nsv);
10096 eptr = SvPVX(nsv);
10097 elen = SvCUR(nsv);
10098 }
10099 SvGROW(sv, SvCUR(sv) + elen + 1);
10100 p = SvEND(sv);
10101 *p = '\0';
10102 }
10103
10104 need = (have > width ? have : width);
10105 gap = need - have;
10106
10107 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10108 p = SvEND(sv);
10109 if (esignlen && fill == '0') {
10110 for (i = 0; i < (int)esignlen; i++)
10111 *p++ = esignbuf[i];
10112 }
10113 if (gap && !left) {
10114 memset(p, fill, gap);
10115 p += gap;
10116 }
10117 if (esignlen && fill != '0') {
10118 for (i = 0; i < (int)esignlen; i++)
10119 *p++ = esignbuf[i];
10120 }
10121 if (zeros) {
10122 for (i = zeros; i; i--)
10123 *p++ = '0';
10124 }
10125 if (elen) {
10126 Copy(eptr, p, elen, char);
10127 p += elen;
10128 }
10129 if (gap && left) {
10130 memset(p, ' ', gap);
10131 p += gap;
10132 }
10133 if (vectorize) {
10134 if (veclen) {
10135 Copy(dotstr, p, dotstrlen, char);
10136 p += dotstrlen;
10137 }
10138 else
10139 vectorize = FALSE; /* done iterating over vecstr */
10140 }
10141 if (is_utf8)
10142 has_utf8 = TRUE;
10143 if (has_utf8)
10144 SvUTF8_on(sv);
10145 *p = '\0';
10146 SvCUR(sv) = p - SvPVX(sv);
10147 if (vectorize) {
10148 esignlen = 0;
10149 goto vector;
10150 }
10151 }
10152}
10153
10154/* =========================================================================
10155
10156=head1 Cloning an interpreter
10157
10158All the macros and functions in this section are for the private use of
10159the main function, perl_clone().
10160
10161The foo_dup() functions make an exact copy of an existing foo thinngy.
10162During the course of a cloning, a hash table is used to map old addresses
10163to new addresses. The table is created and manipulated with the
10164ptr_table_* functions.
10165
10166=cut
10167
10168============================================================================*/
10169
10170
10171#if defined(USE_ITHREADS)
10172
10173#ifndef GpREFCNT_inc
10174# define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10175#endif
10176
10177
10178#define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10179#define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10180#define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10181#define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10182#define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10183#define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10184#define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10185#define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10186#define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10187#define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10188#define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10189#define SAVEPV(p) (p ? savepv(p) : Nullch)
10190#define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10191
10192
10193/* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10194 regcomp.c. AMS 20010712 */
10195
10196REGEXP *
10197Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10198{
10199 REGEXP *ret;
10200 int i, len, npar;
10201 struct reg_substr_datum *s;
10202
10203 if (!r)
10204 return (REGEXP *)NULL;
10205
10206 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10207 return ret;
10208
10209 len = r->offsets[0];
10210 npar = r->nparens+1;
10211
10212 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10213 Copy(r->program, ret->program, len+1, regnode);
10214
10215 New(0, ret->startp, npar, I32);
10216 Copy(r->startp, ret->startp, npar, I32);
10217 New(0, ret->endp, npar, I32);
10218 Copy(r->startp, ret->startp, npar, I32);
10219
10220 New(0, ret->substrs, 1, struct reg_substr_data);
10221 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10222 s->min_offset = r->substrs->data[i].min_offset;
10223 s->max_offset = r->substrs->data[i].max_offset;
10224 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10225 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10226 }
10227
10228 ret->regstclass = NULL;
10229 if (r->data) {
10230 struct reg_data *d;
10231 int count = r->data->count;
10232
10233 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10234 char, struct reg_data);
10235 New(0, d->what, count, U8);
10236
10237 d->count = count;
10238 for (i = 0; i < count; i++) {
10239 d->what[i] = r->data->what[i];
10240 switch (d->what[i]) {
10241 case 's':
10242 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10243 break;
10244 case 'p':
10245 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10246 break;
10247 case 'f':
10248 /* This is cheating. */
10249 New(0, d->data[i], 1, struct regnode_charclass_class);
10250 StructCopy(r->data->data[i], d->data[i],
10251 struct regnode_charclass_class);
10252 ret->regstclass = (regnode*)d->data[i];
10253 break;
10254 case 'o':
10255 /* Compiled op trees are readonly, and can thus be
10256 shared without duplication. */
10257 OP_REFCNT_LOCK;
10258 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10259 OP_REFCNT_UNLOCK;
10260 break;
10261 case 'n':
10262 d->data[i] = r->data->data[i];
10263 break;
10264 }
10265 }
10266
10267 ret->data = d;
10268 }
10269 else
10270 ret->data = NULL;
10271
10272 New(0, ret->offsets, 2*len+1, U32);
10273 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10274
10275 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10276 ret->refcnt = r->refcnt;
10277 ret->minlen = r->minlen;
10278 ret->prelen = r->prelen;
10279 ret->nparens = r->nparens;
10280 ret->lastparen = r->lastparen;
10281 ret->lastcloseparen = r->lastcloseparen;
10282 ret->reganch = r->reganch;
10283
10284 ret->sublen = r->sublen;
10285
10286 if (RX_MATCH_COPIED(ret))
10287 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10288 else
10289 ret->subbeg = Nullch;
10290#ifdef PERL_COPY_ON_WRITE
10291 ret->saved_copy = Nullsv;
10292#endif
10293
10294 ptr_table_store(PL_ptr_table, r, ret);
10295 return ret;
10296}
10297
10298/* duplicate a file handle */
10299
10300PerlIO *
10301Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10302{
10303 PerlIO *ret;
10304 if (!fp)
10305 return (PerlIO*)NULL;
10306
10307 /* look for it in the table first */
10308 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10309 if (ret)
10310 return ret;
10311
10312 /* create anew and remember what it is */
10313 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10314 ptr_table_store(PL_ptr_table, fp, ret);
10315 return ret;
10316}
10317
10318/* duplicate a directory handle */
10319
10320DIR *
10321Perl_dirp_dup(pTHX_ DIR *dp)
10322{
10323 if (!dp)
10324 return (DIR*)NULL;
10325 /* XXX TODO */
10326 return dp;
10327}
10328
10329/* duplicate a typeglob */
10330
10331GP *
10332Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10333{
10334 GP *ret;
10335 if (!gp)
10336 return (GP*)NULL;
10337 /* look for it in the table first */
10338 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10339 if (ret)
10340 return ret;
10341
10342 /* create anew and remember what it is */
10343 Newz(0, ret, 1, GP);
10344 ptr_table_store(PL_ptr_table, gp, ret);
10345
10346 /* clone */
10347 ret->gp_refcnt = 0; /* must be before any other dups! */
10348 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10349 ret->gp_io = io_dup_inc(gp->gp_io, param);
10350 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10351 ret->gp_av = av_dup_inc(gp->gp_av, param);
10352 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10353 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10354 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10355 ret->gp_cvgen = gp->gp_cvgen;
10356 ret->gp_flags = gp->gp_flags;
10357 ret->gp_line = gp->gp_line;
10358 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10359 return ret;
10360}
10361
10362/* duplicate a chain of magic */
10363
10364MAGIC *
10365Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10366{
10367 MAGIC *mgprev = (MAGIC*)NULL;
10368 MAGIC *mgret;
10369 if (!mg)
10370 return (MAGIC*)NULL;
10371 /* look for it in the table first */
10372 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10373 if (mgret)
10374 return mgret;
10375
10376 for (; mg; mg = mg->mg_moremagic) {
10377 MAGIC *nmg;
10378 Newz(0, nmg, 1, MAGIC);
10379 if (mgprev)
10380 mgprev->mg_moremagic = nmg;
10381 else
10382 mgret = nmg;
10383 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10384 nmg->mg_private = mg->mg_private;
10385 nmg->mg_type = mg->mg_type;
10386 nmg->mg_flags = mg->mg_flags;
10387 if (mg->mg_type == PERL_MAGIC_qr) {
10388 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10389 }
10390 else if(mg->mg_type == PERL_MAGIC_backref) {
10391 AV *av = (AV*) mg->mg_obj;
10392 SV **svp;
10393 I32 i;
10394 SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10395 svp = AvARRAY(av);
10396 for (i = AvFILLp(av); i >= 0; i--) {
10397 if (!svp[i]) continue;
10398 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10399 }
10400 }
10401 else {
10402 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10403 ? sv_dup_inc(mg->mg_obj, param)
10404 : sv_dup(mg->mg_obj, param);
10405 }
10406 nmg->mg_len = mg->mg_len;
10407 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10408 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10409 if (mg->mg_len > 0) {
10410 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10411 if (mg->mg_type == PERL_MAGIC_overload_table &&
10412 AMT_AMAGIC((AMT*)mg->mg_ptr))
10413 {
10414 AMT *amtp = (AMT*)mg->mg_ptr;
10415 AMT *namtp = (AMT*)nmg->mg_ptr;
10416 I32 i;
10417 for (i = 1; i < NofAMmeth; i++) {
10418 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10419 }
10420 }
10421 }
10422 else if (mg->mg_len == HEf_SVKEY)
10423 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10424 }
10425 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10426 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10427 }
10428 mgprev = nmg;
10429 }
10430 return mgret;
10431}
10432
10433/* create a new pointer-mapping table */
10434
10435PTR_TBL_t *
10436Perl_ptr_table_new(pTHX)
10437{
10438 PTR_TBL_t *tbl;
10439 Newz(0, tbl, 1, PTR_TBL_t);
10440 tbl->tbl_max = 511;
10441 tbl->tbl_items = 0;
10442 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10443 return tbl;
10444}
10445
10446#if (PTRSIZE == 8)
10447# define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10448#else
10449# define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10450#endif
10451
10452/* map an existing pointer using a table */
10453
10454void *
10455Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10456{
10457 PTR_TBL_ENT_t *tblent;
10458 UV hash = PTR_TABLE_HASH(sv);
10459 assert(tbl);
10460 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10461 for (; tblent; tblent = tblent->next) {
10462 if (tblent->oldval == sv)
10463 return tblent->newval;
10464 }
10465 return (void*)NULL;
10466}
10467
10468/* add a new entry to a pointer-mapping table */
10469
10470void
10471Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10472{
10473 PTR_TBL_ENT_t *tblent, **otblent;
10474 /* XXX this may be pessimal on platforms where pointers aren't good
10475 * hash values e.g. if they grow faster in the most significant
10476 * bits */
10477 UV hash = PTR_TABLE_HASH(oldv);
10478 bool empty = 1;
10479
10480 assert(tbl);
10481 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10482 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10483 if (tblent->oldval == oldv) {
10484 tblent->newval = newv;
10485 return;
10486 }
10487 }
10488 Newz(0, tblent, 1, PTR_TBL_ENT_t);
10489 tblent->oldval = oldv;
10490 tblent->newval = newv;
10491 tblent->next = *otblent;
10492 *otblent = tblent;
10493 tbl->tbl_items++;
10494 if (!empty && tbl->tbl_items > tbl->tbl_max)
10495 ptr_table_split(tbl);
10496}
10497
10498/* double the hash bucket size of an existing ptr table */
10499
10500void
10501Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10502{
10503 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10504 UV oldsize = tbl->tbl_max + 1;
10505 UV newsize = oldsize * 2;
10506 UV i;
10507
10508 Renew(ary, newsize, PTR_TBL_ENT_t*);
10509 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10510 tbl->tbl_max = --newsize;
10511 tbl->tbl_ary = ary;
10512 for (i=0; i < oldsize; i++, ary++) {
10513 PTR_TBL_ENT_t **curentp, **entp, *ent;
10514 if (!*ary)
10515 continue;
10516 curentp = ary + oldsize;
10517 for (entp = ary, ent = *ary; ent; ent = *entp) {
10518 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10519 *entp = ent->next;
10520 ent->next = *curentp;
10521 *curentp = ent;
10522 continue;
10523 }
10524 else
10525 entp = &ent->next;
10526 }
10527 }
10528}
10529
10530/* remove all the entries from a ptr table */
10531
10532void
10533Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10534{
10535 register PTR_TBL_ENT_t **array;
10536 register PTR_TBL_ENT_t *entry;
10537 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
10538 UV riter = 0;
10539 UV max;
10540
10541 if (!tbl || !tbl->tbl_items) {
10542 return;
10543 }
10544
10545 array = tbl->tbl_ary;
10546 entry = array[0];
10547 max = tbl->tbl_max;
10548
10549 for (;;) {
10550 if (entry) {
10551 oentry = entry;
10552 entry = entry->next;
10553 Safefree(oentry);
10554 }
10555 if (!entry) {
10556 if (++riter > max) {
10557 break;
10558 }
10559 entry = array[riter];
10560 }
10561 }
10562
10563 tbl->tbl_items = 0;
10564}
10565
10566/* clear and free a ptr table */
10567
10568void
10569Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10570{
10571 if (!tbl) {
10572 return;
10573 }
10574 ptr_table_clear(tbl);
10575 Safefree(tbl->tbl_ary);
10576 Safefree(tbl);
10577}
10578
10579#ifdef DEBUGGING
10580char *PL_watch_pvx;
10581#endif
10582
10583/* attempt to make everything in the typeglob readonly */
10584
10585STATIC SV *
10586S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10587{
10588 GV *gv = (GV*)sstr;
10589 SV *sv = &param->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10590
10591 if (GvIO(gv) || GvFORM(gv)) {
10592 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10593 }
10594 else if (!GvCV(gv)) {
10595 GvCV(gv) = (CV*)sv;
10596 }
10597 else {
10598 /* CvPADLISTs cannot be shared */
10599 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10600 GvUNIQUE_off(gv);
10601 }
10602 }
10603
10604 if (!GvUNIQUE(gv)) {
10605#if 0
10606 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10607 HvNAME(GvSTASH(gv)), GvNAME(gv));
10608#endif
10609 return Nullsv;
10610 }
10611
10612 /*
10613 * write attempts will die with
10614 * "Modification of a read-only value attempted"
10615 */
10616 if (!GvSV(gv)) {
10617 GvSV(gv) = sv;
10618 }
10619 else {
10620 SvREADONLY_on(GvSV(gv));
10621 }
10622
10623 if (!GvAV(gv)) {
10624 GvAV(gv) = (AV*)sv;
10625 }
10626 else {
10627 SvREADONLY_on(GvAV(gv));
10628 }
10629
10630 if (!GvHV(gv)) {
10631 GvHV(gv) = (HV*)sv;
10632 }
10633 else {
10634 SvREADONLY_on(GvHV(gv));
10635 }
10636
10637 return sstr; /* he_dup() will SvREFCNT_inc() */
10638}
10639
10640/* duplicate an SV of any type (including AV, HV etc) */
10641
10642void
10643Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10644{
10645 if (SvROK(sstr)) {
10646 SvRV(dstr) = SvWEAKREF(sstr)
10647 ? sv_dup(SvRV(sstr), param)
10648 : sv_dup_inc(SvRV(sstr), param);
10649 }
10650 else if (SvPVX(sstr)) {
10651 /* Has something there */
10652 if (SvLEN(sstr)) {
10653 /* Normal PV - clone whole allocated space */
10654 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
10655 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10656 /* Not that normal - actually sstr is copy on write.
10657 But we are a true, independant SV, so: */
10658 SvREADONLY_off(dstr);
10659 SvFAKE_off(dstr);
10660 }
10661 }
10662 else {
10663 /* Special case - not normally malloced for some reason */
10664 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10665 /* A "shared" PV - clone it as unshared string */
10666 if(SvPADTMP(sstr)) {
10667 /* However, some of them live in the pad
10668 and they should not have these flags
10669 turned off */
10670
10671 SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
10672 SvUVX(sstr));
10673 SvUVX(dstr) = SvUVX(sstr);
10674 } else {
10675
10676 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
10677 SvFAKE_off(dstr);
10678 SvREADONLY_off(dstr);
10679 }
10680 }
10681 else {
10682 /* Some other special case - random pointer */
10683 SvPVX(dstr) = SvPVX(sstr);
10684 }
10685 }
10686 }
10687 else {
10688 /* Copy the Null */
10689 SvPVX(dstr) = SvPVX(sstr);
10690 }
10691}
10692
10693SV *
10694Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10695{
10696 SV *dstr;
10697
10698 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10699 return Nullsv;
10700 /* look for it in the table first */
10701 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10702 if (dstr)
10703 return dstr;
10704
10705 if(param->flags & CLONEf_JOIN_IN) {
10706 /** We are joining here so we don't want do clone
10707 something that is bad **/
10708
10709 if(SvTYPE(sstr) == SVt_PVHV &&
10710 HvNAME(sstr)) {
10711 /** don't clone stashes if they already exist **/
10712 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10713 return (SV*) old_stash;
10714 }
10715 }
10716
10717 /* create anew and remember what it is */
10718 new_SV(dstr);
10719 ptr_table_store(PL_ptr_table, sstr, dstr);
10720
10721 /* clone */
10722 SvFLAGS(dstr) = SvFLAGS(sstr);
10723 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10724 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10725
10726#ifdef DEBUGGING
10727 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10728 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10729 PL_watch_pvx, SvPVX(sstr));
10730#endif
10731
10732 switch (SvTYPE(sstr)) {
10733 case SVt_NULL:
10734 SvANY(dstr) = NULL;
10735 break;
10736 case SVt_IV:
10737 SvANY(dstr) = new_XIV();
10738 SvIVX(dstr) = SvIVX(sstr);
10739 break;
10740 case SVt_NV:
10741 SvANY(dstr) = new_XNV();
10742 SvNVX(dstr) = SvNVX(sstr);
10743 break;
10744 case SVt_RV:
10745 SvANY(dstr) = new_XRV();
10746 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10747 break;
10748 case SVt_PV:
10749 SvANY(dstr) = new_XPV();
10750 SvCUR(dstr) = SvCUR(sstr);
10751 SvLEN(dstr) = SvLEN(sstr);
10752 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10753 break;
10754 case SVt_PVIV:
10755 SvANY(dstr) = new_XPVIV();
10756 SvCUR(dstr) = SvCUR(sstr);
10757 SvLEN(dstr) = SvLEN(sstr);
10758 SvIVX(dstr) = SvIVX(sstr);
10759 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10760 break;
10761 case SVt_PVNV:
10762 SvANY(dstr) = new_XPVNV();
10763 SvCUR(dstr) = SvCUR(sstr);
10764 SvLEN(dstr) = SvLEN(sstr);
10765 SvIVX(dstr) = SvIVX(sstr);
10766 SvNVX(dstr) = SvNVX(sstr);
10767 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10768 break;
10769 case SVt_PVMG:
10770 SvANY(dstr) = new_XPVMG();
10771 SvCUR(dstr) = SvCUR(sstr);
10772 SvLEN(dstr) = SvLEN(sstr);
10773 SvIVX(dstr) = SvIVX(sstr);
10774 SvNVX(dstr) = SvNVX(sstr);
10775 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10776 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10777 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10778 break;
10779 case SVt_PVBM:
10780 SvANY(dstr) = new_XPVBM();
10781 SvCUR(dstr) = SvCUR(sstr);
10782 SvLEN(dstr) = SvLEN(sstr);
10783 SvIVX(dstr) = SvIVX(sstr);
10784 SvNVX(dstr) = SvNVX(sstr);
10785 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10786 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10787 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10788 BmRARE(dstr) = BmRARE(sstr);
10789 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10790 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10791 break;
10792 case SVt_PVLV:
10793 SvANY(dstr) = new_XPVLV();
10794 SvCUR(dstr) = SvCUR(sstr);
10795 SvLEN(dstr) = SvLEN(sstr);
10796 SvIVX(dstr) = SvIVX(sstr);
10797 SvNVX(dstr) = SvNVX(sstr);
10798 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10799 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10800 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10801 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10802 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10803 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10804 LvTARG(dstr) = dstr;
10805 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10806 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10807 else
10808 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10809 LvTYPE(dstr) = LvTYPE(sstr);
10810 break;
10811 case SVt_PVGV:
10812 if (GvUNIQUE((GV*)sstr)) {
10813 SV *share;
10814 if ((share = gv_share(sstr, param))) {
10815 del_SV(dstr);
10816 dstr = share;
10817 ptr_table_store(PL_ptr_table, sstr, dstr);
10818#if 0
10819 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10820 HvNAME(GvSTASH(share)), GvNAME(share));
10821#endif
10822 break;
10823 }
10824 }
10825 SvANY(dstr) = new_XPVGV();
10826 SvCUR(dstr) = SvCUR(sstr);
10827 SvLEN(dstr) = SvLEN(sstr);
10828 SvIVX(dstr) = SvIVX(sstr);
10829 SvNVX(dstr) = SvNVX(sstr);
10830 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10831 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10832 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10833 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10834 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10835 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10836 GvFLAGS(dstr) = GvFLAGS(sstr);
10837 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10838 (void)GpREFCNT_inc(GvGP(dstr));
10839 break;
10840 case SVt_PVIO:
10841 SvANY(dstr) = new_XPVIO();
10842 SvCUR(dstr) = SvCUR(sstr);
10843 SvLEN(dstr) = SvLEN(sstr);
10844 SvIVX(dstr) = SvIVX(sstr);
10845 SvNVX(dstr) = SvNVX(sstr);
10846 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10847 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10848 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10849 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10850 if (IoOFP(sstr) == IoIFP(sstr))
10851 IoOFP(dstr) = IoIFP(dstr);
10852 else
10853 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10854 /* PL_rsfp_filters entries have fake IoDIRP() */
10855 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10856 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10857 else
10858 IoDIRP(dstr) = IoDIRP(sstr);
10859 IoLINES(dstr) = IoLINES(sstr);
10860 IoPAGE(dstr) = IoPAGE(sstr);
10861 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10862 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10863 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10864 /* I have no idea why fake dirp (rsfps)
10865 should be treaded differently but otherwise
10866 we end up with leaks -- sky*/
10867 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10868 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10869 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10870 } else {
10871 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10872 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10873 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10874 }
10875 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10876 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10877 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10878 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10879 IoTYPE(dstr) = IoTYPE(sstr);
10880 IoFLAGS(dstr) = IoFLAGS(sstr);
10881 break;
10882 case SVt_PVAV:
10883 SvANY(dstr) = new_XPVAV();
10884 SvCUR(dstr) = SvCUR(sstr);
10885 SvLEN(dstr) = SvLEN(sstr);
10886 SvIVX(dstr) = SvIVX(sstr);
10887 SvNVX(dstr) = SvNVX(sstr);
10888 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10889 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10890 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10891 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10892 if (AvARRAY((AV*)sstr)) {
10893 SV **dst_ary, **src_ary;
10894 SSize_t items = AvFILLp((AV*)sstr) + 1;
10895
10896 src_ary = AvARRAY((AV*)sstr);
10897 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10898 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10899 SvPVX(dstr) = (char*)dst_ary;
10900 AvALLOC((AV*)dstr) = dst_ary;
10901 if (AvREAL((AV*)sstr)) {
10902 while (items-- > 0)
10903 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10904 }
10905 else {
10906 while (items-- > 0)
10907 *dst_ary++ = sv_dup(*src_ary++, param);
10908 }
10909 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10910 while (items-- > 0) {
10911 *dst_ary++ = &PL_sv_undef;
10912 }
10913 }
10914 else {
10915 SvPVX(dstr) = Nullch;
10916 AvALLOC((AV*)dstr) = (SV**)NULL;
10917 }
10918 break;
10919 case SVt_PVHV:
10920 SvANY(dstr) = new_XPVHV();
10921 SvCUR(dstr) = SvCUR(sstr);
10922 SvLEN(dstr) = SvLEN(sstr);
10923 SvIVX(dstr) = SvIVX(sstr);
10924 SvNVX(dstr) = SvNVX(sstr);
10925 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10926 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10927 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
10928 if (HvARRAY((HV*)sstr)) {
10929 STRLEN i = 0;
10930 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10931 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10932 Newz(0, dxhv->xhv_array,
10933 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10934 while (i <= sxhv->xhv_max) {
10935 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10936 (bool)!!HvSHAREKEYS(sstr),
10937 param);
10938 ++i;
10939 }
10940 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10941 (bool)!!HvSHAREKEYS(sstr), param);
10942 }
10943 else {
10944 SvPVX(dstr) = Nullch;
10945 HvEITER((HV*)dstr) = (HE*)NULL;
10946 }
10947 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
10948 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
10949 /* Record stashes for possible cloning in Perl_clone(). */
10950 if(HvNAME((HV*)dstr))
10951 av_push(param->stashes, dstr);
10952 break;
10953 case SVt_PVFM:
10954 SvANY(dstr) = new_XPVFM();
10955 FmLINES(dstr) = FmLINES(sstr);
10956 goto dup_pvcv;
10957 /* NOTREACHED */
10958 case SVt_PVCV:
10959 SvANY(dstr) = new_XPVCV();
10960 dup_pvcv:
10961 SvCUR(dstr) = SvCUR(sstr);
10962 SvLEN(dstr) = SvLEN(sstr);
10963 SvIVX(dstr) = SvIVX(sstr);
10964 SvNVX(dstr) = SvNVX(sstr);
10965 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10966 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10967 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10968 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10969 CvSTART(dstr) = CvSTART(sstr);
10970 OP_REFCNT_LOCK;
10971 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10972 OP_REFCNT_UNLOCK;
10973 CvXSUB(dstr) = CvXSUB(sstr);
10974 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10975 if (CvCONST(sstr)) {
10976 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10977 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10978 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10979 }
10980 /* don't dup if copying back - CvGV isn't refcounted, so the
10981 * duped GV may never be freed. A bit of a hack! DAPM */
10982 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10983 Nullgv : gv_dup(CvGV(sstr), param) ;
10984 if (param->flags & CLONEf_COPY_STACKS) {
10985 CvDEPTH(dstr) = CvDEPTH(sstr);
10986 } else {
10987 CvDEPTH(dstr) = 0;
10988 }
10989 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10990 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10991 CvOUTSIDE(dstr) =
10992 CvWEAKOUTSIDE(sstr)
10993 ? cv_dup( CvOUTSIDE(sstr), param)
10994 : cv_dup_inc(CvOUTSIDE(sstr), param);
10995 CvFLAGS(dstr) = CvFLAGS(sstr);
10996 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10997 break;
10998 default:
10999 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11000 break;
11001 }
11002
11003 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11004 ++PL_sv_objcount;
11005
11006 return dstr;
11007 }
11008
11009/* duplicate a context */
11010
11011PERL_CONTEXT *
11012Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11013{
11014 PERL_CONTEXT *ncxs;
11015
11016 if (!cxs)
11017 return (PERL_CONTEXT*)NULL;
11018
11019 /* look for it in the table first */
11020 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11021 if (ncxs)
11022 return ncxs;
11023
11024 /* create anew and remember what it is */
11025 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11026 ptr_table_store(PL_ptr_table, cxs, ncxs);
11027
11028 while (ix >= 0) {
11029 PERL_CONTEXT *cx = &cxs[ix];
11030 PERL_CONTEXT *ncx = &ncxs[ix];
11031 ncx->cx_type = cx->cx_type;
11032 if (CxTYPE(cx) == CXt_SUBST) {
11033 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11034 }
11035 else {
11036 ncx->blk_oldsp = cx->blk_oldsp;
11037 ncx->blk_oldcop = cx->blk_oldcop;
11038 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11039 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11040 ncx->blk_oldpm = cx->blk_oldpm;
11041 ncx->blk_gimme = cx->blk_gimme;
11042 switch (CxTYPE(cx)) {
11043 case CXt_SUB:
11044 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11045 ? cv_dup_inc(cx->blk_sub.cv, param)
11046 : cv_dup(cx->blk_sub.cv,param));
11047 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11048 ? av_dup_inc(cx->blk_sub.argarray, param)
11049 : Nullav);
11050 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11051 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11052 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11053 ncx->blk_sub.lval = cx->blk_sub.lval;
11054 ncx->blk_sub.retop = cx->blk_sub.retop;
11055 break;
11056 case CXt_EVAL:
11057 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11058 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11059 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11060 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11061 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11062 ncx->blk_eval.retop = cx->blk_eval.retop;
11063 break;
11064 case CXt_LOOP:
11065 ncx->blk_loop.label = cx->blk_loop.label;
11066 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11067 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11068 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11069 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11070 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11071 ? cx->blk_loop.iterdata
11072 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11073 ncx->blk_loop.oldcomppad
11074 = (PAD*)ptr_table_fetch(PL_ptr_table,
11075 cx->blk_loop.oldcomppad);
11076 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11077 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11078 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11079 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11080 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11081 break;
11082 case CXt_FORMAT:
11083 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11084 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11085 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11086 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11087 ncx->blk_sub.retop = cx->blk_sub.retop;
11088 break;
11089 case CXt_BLOCK:
11090 case CXt_NULL:
11091 break;
11092 }
11093 }
11094 --ix;
11095 }
11096 return ncxs;
11097}
11098
11099/* duplicate a stack info structure */
11100
11101PERL_SI *
11102Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11103{
11104 PERL_SI *nsi;
11105
11106 if (!si)
11107 return (PERL_SI*)NULL;
11108
11109 /* look for it in the table first */
11110 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11111 if (nsi)
11112 return nsi;
11113
11114 /* create anew and remember what it is */
11115 Newz(56, nsi, 1, PERL_SI);
11116 ptr_table_store(PL_ptr_table, si, nsi);
11117
11118 nsi->si_stack = av_dup_inc(si->si_stack, param);
11119 nsi->si_cxix = si->si_cxix;
11120 nsi->si_cxmax = si->si_cxmax;
11121 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11122 nsi->si_type = si->si_type;
11123 nsi->si_prev = si_dup(si->si_prev, param);
11124 nsi->si_next = si_dup(si->si_next, param);
11125 nsi->si_markoff = si->si_markoff;
11126
11127 return nsi;
11128}
11129
11130#define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11131#define TOPINT(ss,ix) ((ss)[ix].any_i32)
11132#define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11133#define TOPLONG(ss,ix) ((ss)[ix].any_long)
11134#define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11135#define TOPIV(ss,ix) ((ss)[ix].any_iv)
11136#define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11137#define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11138#define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11139#define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11140#define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11141#define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11142#define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11143#define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11144
11145/* XXXXX todo */
11146#define pv_dup_inc(p) SAVEPV(p)
11147#define pv_dup(p) SAVEPV(p)
11148#define svp_dup_inc(p,pp) any_dup(p,pp)
11149
11150/* map any object to the new equivent - either something in the
11151 * ptr table, or something in the interpreter structure
11152 */
11153
11154void *
11155Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11156{
11157 void *ret;
11158
11159 if (!v)
11160 return (void*)NULL;
11161
11162 /* look for it in the table first */
11163 ret = ptr_table_fetch(PL_ptr_table, v);
11164 if (ret)
11165 return ret;
11166
11167 /* see if it is part of the interpreter structure */
11168 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11169 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11170 else {
11171 ret = v;
11172 }
11173
11174 return ret;
11175}
11176
11177/* duplicate the save stack */
11178
11179ANY *
11180Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11181{
11182 ANY *ss = proto_perl->Tsavestack;
11183 I32 ix = proto_perl->Tsavestack_ix;
11184 I32 max = proto_perl->Tsavestack_max;
11185 ANY *nss;
11186 SV *sv;
11187 GV *gv;
11188 AV *av;
11189 HV *hv;
11190 void* ptr;
11191 int intval;
11192 long longval;
11193 GP *gp;
11194 IV iv;
11195 I32 i;
11196 char *c = NULL;
11197 void (*dptr) (void*);
11198 void (*dxptr) (pTHX_ void*);
11199 OP *o;
11200
11201 Newz(54, nss, max, ANY);
11202
11203 while (ix > 0) {
11204 i = POPINT(ss,ix);
11205 TOPINT(nss,ix) = i;
11206 switch (i) {
11207 case SAVEt_ITEM: /* normal string */
11208 sv = (SV*)POPPTR(ss,ix);
11209 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11210 sv = (SV*)POPPTR(ss,ix);
11211 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11212 break;
11213 case SAVEt_SV: /* scalar reference */
11214 sv = (SV*)POPPTR(ss,ix);
11215 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11216 gv = (GV*)POPPTR(ss,ix);
11217 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11218 break;
11219 case SAVEt_GENERIC_PVREF: /* generic char* */
11220 c = (char*)POPPTR(ss,ix);
11221 TOPPTR(nss,ix) = pv_dup(c);
11222 ptr = POPPTR(ss,ix);
11223 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11224 break;
11225 case SAVEt_SHARED_PVREF: /* char* in shared space */
11226 c = (char*)POPPTR(ss,ix);
11227 TOPPTR(nss,ix) = savesharedpv(c);
11228 ptr = POPPTR(ss,ix);
11229 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11230 break;
11231 case SAVEt_GENERIC_SVREF: /* generic sv */
11232 case SAVEt_SVREF: /* scalar reference */
11233 sv = (SV*)POPPTR(ss,ix);
11234 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11235 ptr = POPPTR(ss,ix);
11236 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11237 break;
11238 case SAVEt_AV: /* array reference */
11239 av = (AV*)POPPTR(ss,ix);
11240 TOPPTR(nss,ix) = av_dup_inc(av, param);
11241 gv = (GV*)POPPTR(ss,ix);
11242 TOPPTR(nss,ix) = gv_dup(gv, param);
11243 break;
11244 case SAVEt_HV: /* hash reference */
11245 hv = (HV*)POPPTR(ss,ix);
11246 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11247 gv = (GV*)POPPTR(ss,ix);
11248 TOPPTR(nss,ix) = gv_dup(gv, param);
11249 break;
11250 case SAVEt_INT: /* int reference */
11251 ptr = POPPTR(ss,ix);
11252 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11253 intval = (int)POPINT(ss,ix);
11254 TOPINT(nss,ix) = intval;
11255 break;
11256 case SAVEt_LONG: /* long reference */
11257 ptr = POPPTR(ss,ix);
11258 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11259 longval = (long)POPLONG(ss,ix);
11260 TOPLONG(nss,ix) = longval;
11261 break;
11262 case SAVEt_I32: /* I32 reference */
11263 case SAVEt_I16: /* I16 reference */
11264 case SAVEt_I8: /* I8 reference */
11265 ptr = POPPTR(ss,ix);
11266 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11267 i = POPINT(ss,ix);
11268 TOPINT(nss,ix) = i;
11269 break;
11270 case SAVEt_IV: /* IV reference */
11271 ptr = POPPTR(ss,ix);
11272 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11273 iv = POPIV(ss,ix);
11274 TOPIV(nss,ix) = iv;
11275 break;
11276 case SAVEt_SPTR: /* SV* reference */
11277 ptr = POPPTR(ss,ix);
11278 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11279 sv = (SV*)POPPTR(ss,ix);
11280 TOPPTR(nss,ix) = sv_dup(sv, param);
11281 break;
11282 case SAVEt_VPTR: /* random* reference */
11283 ptr = POPPTR(ss,ix);
11284 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11285 ptr = POPPTR(ss,ix);
11286 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11287 break;
11288 case SAVEt_PPTR: /* char* reference */
11289 ptr = POPPTR(ss,ix);
11290 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11291 c = (char*)POPPTR(ss,ix);
11292 TOPPTR(nss,ix) = pv_dup(c);
11293 break;
11294 case SAVEt_HPTR: /* HV* reference */
11295 ptr = POPPTR(ss,ix);
11296 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11297 hv = (HV*)POPPTR(ss,ix);
11298 TOPPTR(nss,ix) = hv_dup(hv, param);
11299 break;
11300 case SAVEt_APTR: /* AV* reference */
11301 ptr = POPPTR(ss,ix);
11302 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11303 av = (AV*)POPPTR(ss,ix);
11304 TOPPTR(nss,ix) = av_dup(av, param);
11305 break;
11306 case SAVEt_NSTAB:
11307 gv = (GV*)POPPTR(ss,ix);
11308 TOPPTR(nss,ix) = gv_dup(gv, param);
11309 break;
11310 case SAVEt_GP: /* scalar reference */
11311 gp = (GP*)POPPTR(ss,ix);
11312 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11313 (void)GpREFCNT_inc(gp);
11314 gv = (GV*)POPPTR(ss,ix);
11315 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11316 c = (char*)POPPTR(ss,ix);
11317 TOPPTR(nss,ix) = pv_dup(c);
11318 iv = POPIV(ss,ix);
11319 TOPIV(nss,ix) = iv;
11320 iv = POPIV(ss,ix);
11321 TOPIV(nss,ix) = iv;
11322 break;
11323 case SAVEt_FREESV:
11324 case SAVEt_MORTALIZESV:
11325 sv = (SV*)POPPTR(ss,ix);
11326 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11327 break;
11328 case SAVEt_FREEOP:
11329 ptr = POPPTR(ss,ix);
11330 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11331 /* these are assumed to be refcounted properly */
11332 switch (((OP*)ptr)->op_type) {
11333 case OP_LEAVESUB:
11334 case OP_LEAVESUBLV:
11335 case OP_LEAVEEVAL:
11336 case OP_LEAVE:
11337 case OP_SCOPE:
11338 case OP_LEAVEWRITE:
11339 TOPPTR(nss,ix) = ptr;
11340 o = (OP*)ptr;
11341 OpREFCNT_inc(o);
11342 break;
11343 default:
11344 TOPPTR(nss,ix) = Nullop;
11345 break;
11346 }
11347 }
11348 else
11349 TOPPTR(nss,ix) = Nullop;
11350 break;
11351 case SAVEt_FREEPV:
11352 c = (char*)POPPTR(ss,ix);
11353 TOPPTR(nss,ix) = pv_dup_inc(c);
11354 break;
11355 case SAVEt_CLEARSV:
11356 longval = POPLONG(ss,ix);
11357 TOPLONG(nss,ix) = longval;
11358 break;
11359 case SAVEt_DELETE:
11360 hv = (HV*)POPPTR(ss,ix);
11361 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11362 c = (char*)POPPTR(ss,ix);
11363 TOPPTR(nss,ix) = pv_dup_inc(c);
11364 i = POPINT(ss,ix);
11365 TOPINT(nss,ix) = i;
11366 break;
11367 case SAVEt_DESTRUCTOR:
11368 ptr = POPPTR(ss,ix);
11369 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11370 dptr = POPDPTR(ss,ix);
11371 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
11372 break;
11373 case SAVEt_DESTRUCTOR_X:
11374 ptr = POPPTR(ss,ix);
11375 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11376 dxptr = POPDXPTR(ss,ix);
11377 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
11378 break;
11379 case SAVEt_REGCONTEXT:
11380 case SAVEt_ALLOC:
11381 i = POPINT(ss,ix);
11382 TOPINT(nss,ix) = i;
11383 ix -= i;
11384 break;
11385 case SAVEt_STACK_POS: /* Position on Perl stack */
11386 i = POPINT(ss,ix);
11387 TOPINT(nss,ix) = i;
11388 break;
11389 case SAVEt_AELEM: /* array element */
11390 sv = (SV*)POPPTR(ss,ix);
11391 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11392 i = POPINT(ss,ix);
11393 TOPINT(nss,ix) = i;
11394 av = (AV*)POPPTR(ss,ix);
11395 TOPPTR(nss,ix) = av_dup_inc(av, param);
11396 break;
11397 case SAVEt_HELEM: /* hash element */
11398 sv = (SV*)POPPTR(ss,ix);
11399 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11400 sv = (SV*)POPPTR(ss,ix);
11401 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11402 hv = (HV*)POPPTR(ss,ix);
11403 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11404 break;
11405 case SAVEt_OP:
11406 ptr = POPPTR(ss,ix);
11407 TOPPTR(nss,ix) = ptr;
11408 break;
11409 case SAVEt_HINTS:
11410 i = POPINT(ss,ix);
11411 TOPINT(nss,ix) = i;
11412 break;
11413 case SAVEt_COMPPAD:
11414 av = (AV*)POPPTR(ss,ix);
11415 TOPPTR(nss,ix) = av_dup(av, param);
11416 break;
11417 case SAVEt_PADSV:
11418 longval = (long)POPLONG(ss,ix);
11419 TOPLONG(nss,ix) = longval;
11420 ptr = POPPTR(ss,ix);
11421 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11422 sv = (SV*)POPPTR(ss,ix);
11423 TOPPTR(nss,ix) = sv_dup(sv, param);
11424 break;
11425 case SAVEt_BOOL:
11426 ptr = POPPTR(ss,ix);
11427 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11428 longval = (long)POPBOOL(ss,ix);
11429 TOPBOOL(nss,ix) = (bool)longval;
11430 break;
11431 case SAVEt_SET_SVFLAGS:
11432 i = POPINT(ss,ix);
11433 TOPINT(nss,ix) = i;
11434 i = POPINT(ss,ix);
11435 TOPINT(nss,ix) = i;
11436 sv = (SV*)POPPTR(ss,ix);
11437 TOPPTR(nss,ix) = sv_dup(sv, param);
11438 break;
11439 default:
11440 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11441 }
11442 }
11443
11444 return nss;
11445}
11446
11447/*
11448=for apidoc perl_clone
11449
11450Create and return a new interpreter by cloning the current one.
11451
11452perl_clone takes these flags as parameters:
11453
11454CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11455without it we only clone the data and zero the stacks,
11456with it we copy the stacks and the new perl interpreter is
11457ready to run at the exact same point as the previous one.
11458The pseudo-fork code uses COPY_STACKS while the
11459threads->new doesn't.
11460
11461CLONEf_KEEP_PTR_TABLE
11462perl_clone keeps a ptr_table with the pointer of the old
11463variable as a key and the new variable as a value,
11464this allows it to check if something has been cloned and not
11465clone it again but rather just use the value and increase the
11466refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11467the ptr_table using the function
11468C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11469reason to keep it around is if you want to dup some of your own
11470variable who are outside the graph perl scans, example of this
11471code is in threads.xs create
11472
11473CLONEf_CLONE_HOST
11474This is a win32 thing, it is ignored on unix, it tells perls
11475win32host code (which is c++) to clone itself, this is needed on
11476win32 if you want to run two threads at the same time,
11477if you just want to do some stuff in a separate perl interpreter
11478and then throw it away and return to the original one,
11479you don't need to do anything.
11480
11481=cut
11482*/
11483
11484/* XXX the above needs expanding by someone who actually understands it ! */
11485EXTERN_C PerlInterpreter *
11486perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11487
11488PerlInterpreter *
11489perl_clone(PerlInterpreter *proto_perl, UV flags)
11490{
11491#ifdef PERL_IMPLICIT_SYS
11492
11493 /* perlhost.h so we need to call into it
11494 to clone the host, CPerlHost should have a c interface, sky */
11495
11496 if (flags & CLONEf_CLONE_HOST) {
11497 return perl_clone_host(proto_perl,flags);
11498 }
11499 return perl_clone_using(proto_perl, flags,
11500 proto_perl->IMem,
11501 proto_perl->IMemShared,
11502 proto_perl->IMemParse,
11503 proto_perl->IEnv,
11504 proto_perl->IStdIO,
11505 proto_perl->ILIO,
11506 proto_perl->IDir,
11507 proto_perl->ISock,
11508 proto_perl->IProc);
11509}
11510
11511PerlInterpreter *
11512perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11513 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11514 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11515 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11516 struct IPerlDir* ipD, struct IPerlSock* ipS,
11517 struct IPerlProc* ipP)
11518{
11519 /* XXX many of the string copies here can be optimized if they're
11520 * constants; they need to be allocated as common memory and just
11521 * their pointers copied. */
11522
11523 IV i;
11524 CLONE_PARAMS clone_params;
11525 CLONE_PARAMS* param = &clone_params;
11526
11527 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11528 PERL_SET_THX(my_perl);
11529
11530# ifdef DEBUGGING
11531 Poison(my_perl, 1, PerlInterpreter);
11532 PL_markstack = 0;
11533 PL_scopestack = 0;
11534 PL_savestack = 0;
11535 PL_savestack_ix = 0;
11536 PL_savestack_max = -1;
11537 PL_sig_pending = 0;
11538 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11539# else /* !DEBUGGING */
11540 Zero(my_perl, 1, PerlInterpreter);
11541# endif /* DEBUGGING */
11542
11543 /* host pointers */
11544 PL_Mem = ipM;
11545 PL_MemShared = ipMS;
11546 PL_MemParse = ipMP;
11547 PL_Env = ipE;
11548 PL_StdIO = ipStd;
11549 PL_LIO = ipLIO;
11550 PL_Dir = ipD;
11551 PL_Sock = ipS;
11552 PL_Proc = ipP;
11553#else /* !PERL_IMPLICIT_SYS */
11554 IV i;
11555 CLONE_PARAMS clone_params;
11556 CLONE_PARAMS* param = &clone_params;
11557 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11558 PERL_SET_THX(my_perl);
11559
11560
11561
11562# ifdef DEBUGGING
11563 Poison(my_perl, 1, PerlInterpreter);
11564 PL_markstack = 0;
11565 PL_scopestack = 0;
11566 PL_savestack = 0;
11567 PL_savestack_ix = 0;
11568 PL_savestack_max = -1;
11569 PL_sig_pending = 0;
11570 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11571# else /* !DEBUGGING */
11572 Zero(my_perl, 1, PerlInterpreter);
11573# endif /* DEBUGGING */
11574#endif /* PERL_IMPLICIT_SYS */
11575 param->flags = flags;
11576 param->proto_perl = proto_perl;
11577
11578 /* arena roots */
11579 PL_xiv_arenaroot = NULL;
11580 PL_xiv_root = NULL;
11581 PL_xnv_arenaroot = NULL;
11582 PL_xnv_root = NULL;
11583 PL_xrv_arenaroot = NULL;
11584 PL_xrv_root = NULL;
11585 PL_xpv_arenaroot = NULL;
11586 PL_xpv_root = NULL;
11587 PL_xpviv_arenaroot = NULL;
11588 PL_xpviv_root = NULL;
11589 PL_xpvnv_arenaroot = NULL;
11590 PL_xpvnv_root = NULL;
11591 PL_xpvcv_arenaroot = NULL;
11592 PL_xpvcv_root = NULL;
11593 PL_xpvav_arenaroot = NULL;
11594 PL_xpvav_root = NULL;
11595 PL_xpvhv_arenaroot = NULL;
11596 PL_xpvhv_root = NULL;
11597 PL_xpvmg_arenaroot = NULL;
11598 PL_xpvmg_root = NULL;
11599 PL_xpvlv_arenaroot = NULL;
11600 PL_xpvlv_root = NULL;
11601 PL_xpvbm_arenaroot = NULL;
11602 PL_xpvbm_root = NULL;
11603 PL_he_arenaroot = NULL;
11604 PL_he_root = NULL;
11605 PL_nice_chunk = NULL;
11606 PL_nice_chunk_size = 0;
11607 PL_sv_count = 0;
11608 PL_sv_objcount = 0;
11609 PL_sv_root = Nullsv;
11610 PL_sv_arenaroot = Nullsv;
11611
11612 PL_debug = proto_perl->Idebug;
11613
11614#ifdef USE_REENTRANT_API
11615 /* XXX: things like -Dm will segfault here in perlio, but doing
11616 * PERL_SET_CONTEXT(proto_perl);
11617 * breaks too many other things
11618 */
11619 Perl_reentrant_init(aTHX);
11620#endif
11621
11622 /* create SV map for pointer relocation */
11623 PL_ptr_table = ptr_table_new();
11624
11625 /* initialize these special pointers as early as possible */
11626 SvANY(&PL_sv_undef) = NULL;
11627 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11628 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11629 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11630
11631 SvANY(&PL_sv_no) = new_XPVNV();
11632 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11633 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11634 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11635 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
11636 SvCUR(&PL_sv_no) = 0;
11637 SvLEN(&PL_sv_no) = 1;
11638 SvIVX(&PL_sv_no) = 0;
11639 SvNVX(&PL_sv_no) = 0;
11640 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11641
11642 SvANY(&PL_sv_yes) = new_XPVNV();
11643 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11644 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11645 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11646 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
11647 SvCUR(&PL_sv_yes) = 1;
11648 SvLEN(&PL_sv_yes) = 2;
11649 SvIVX(&PL_sv_yes) = 1;
11650 SvNVX(&PL_sv_yes) = 1;
11651 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11652
11653 /* create (a non-shared!) shared string table */
11654 PL_strtab = newHV();
11655 HvSHAREKEYS_off(PL_strtab);
11656 hv_ksplit(PL_strtab, 512);
11657 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11658
11659 PL_compiling = proto_perl->Icompiling;
11660
11661 /* These two PVs will be free'd special way so must set them same way op.c does */
11662 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11663 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11664
11665 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11666 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11667
11668 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11669 if (!specialWARN(PL_compiling.cop_warnings))
11670 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11671 if (!specialCopIO(PL_compiling.cop_io))
11672 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11673 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11674
11675 /* pseudo environmental stuff */
11676 PL_origargc = proto_perl->Iorigargc;
11677 PL_origargv = proto_perl->Iorigargv;
11678
11679 param->stashes = newAV(); /* Setup array of objects to call clone on */
11680
11681#ifdef PERLIO_LAYERS
11682 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11683 PerlIO_clone(aTHX_ proto_perl, param);
11684#endif
11685
11686 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11687 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11688 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11689 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11690 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11691 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11692
11693 /* switches */
11694 PL_minus_c = proto_perl->Iminus_c;
11695 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11696 PL_localpatches = proto_perl->Ilocalpatches;
11697 PL_splitstr = proto_perl->Isplitstr;
11698 PL_preprocess = proto_perl->Ipreprocess;
11699 PL_minus_n = proto_perl->Iminus_n;
11700 PL_minus_p = proto_perl->Iminus_p;
11701 PL_minus_l = proto_perl->Iminus_l;
11702 PL_minus_a = proto_perl->Iminus_a;
11703 PL_minus_F = proto_perl->Iminus_F;
11704 PL_doswitches = proto_perl->Idoswitches;
11705 PL_dowarn = proto_perl->Idowarn;
11706 PL_doextract = proto_perl->Idoextract;
11707 PL_sawampersand = proto_perl->Isawampersand;
11708 PL_unsafe = proto_perl->Iunsafe;
11709 PL_inplace = SAVEPV(proto_perl->Iinplace);
11710 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11711 PL_perldb = proto_perl->Iperldb;
11712 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11713 PL_exit_flags = proto_perl->Iexit_flags;
11714
11715 /* magical thingies */
11716 /* XXX time(&PL_basetime) when asked for? */
11717 PL_basetime = proto_perl->Ibasetime;
11718 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11719
11720 PL_maxsysfd = proto_perl->Imaxsysfd;
11721 PL_multiline = proto_perl->Imultiline;
11722 PL_statusvalue = proto_perl->Istatusvalue;
11723#ifdef VMS
11724 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11725#endif
11726 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11727
11728 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11729 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11730 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11731
11732 /* Clone the regex array */
11733 PL_regex_padav = newAV();
11734 {
11735 I32 len = av_len((AV*)proto_perl->Iregex_padav);
11736 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11737 av_push(PL_regex_padav,
11738 sv_dup_inc(regexen[0],param));
11739 for(i = 1; i <= len; i++) {
11740 if(SvREPADTMP(regexen[i])) {
11741 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11742 } else {
11743 av_push(PL_regex_padav,
11744 SvREFCNT_inc(
11745 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11746 SvIVX(regexen[i])), param)))
11747 ));
11748 }
11749 }
11750 }
11751 PL_regex_pad = AvARRAY(PL_regex_padav);
11752
11753 /* shortcuts to various I/O objects */
11754 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11755 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11756 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11757 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11758 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11759 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11760
11761 /* shortcuts to regexp stuff */
11762 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11763
11764 /* shortcuts to misc objects */
11765 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11766
11767 /* shortcuts to debugging objects */
11768 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11769 PL_DBline = gv_dup(proto_perl->IDBline, param);
11770 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11771 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11772 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11773 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11774 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11775 PL_lineary = av_dup(proto_perl->Ilineary, param);
11776 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11777
11778 /* symbol tables */
11779 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11780 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11781 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11782 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11783 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11784
11785 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11786 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11787 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11788 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11789 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11790 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11791
11792 PL_sub_generation = proto_perl->Isub_generation;
11793
11794 /* funky return mechanisms */
11795 PL_forkprocess = proto_perl->Iforkprocess;
11796
11797 /* subprocess state */
11798 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11799
11800 /* internal state */
11801 PL_tainting = proto_perl->Itainting;
11802 PL_taint_warn = proto_perl->Itaint_warn;
11803 PL_maxo = proto_perl->Imaxo;
11804 if (proto_perl->Iop_mask)
11805 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11806 else
11807 PL_op_mask = Nullch;
11808 /* PL_asserting = proto_perl->Iasserting; */
11809
11810 /* current interpreter roots */
11811 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11812 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11813 PL_main_start = proto_perl->Imain_start;
11814 PL_eval_root = proto_perl->Ieval_root;
11815 PL_eval_start = proto_perl->Ieval_start;
11816
11817 /* runtime control stuff */
11818 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11819 PL_copline = proto_perl->Icopline;
11820
11821 PL_filemode = proto_perl->Ifilemode;
11822 PL_lastfd = proto_perl->Ilastfd;
11823 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11824 PL_Argv = NULL;
11825 PL_Cmd = Nullch;
11826 PL_gensym = proto_perl->Igensym;
11827 PL_preambled = proto_perl->Ipreambled;
11828 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11829 PL_laststatval = proto_perl->Ilaststatval;
11830 PL_laststype = proto_perl->Ilaststype;
11831 PL_mess_sv = Nullsv;
11832
11833 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11834 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11835
11836 /* interpreter atexit processing */
11837 PL_exitlistlen = proto_perl->Iexitlistlen;
11838 if (PL_exitlistlen) {
11839 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11840 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11841 }
11842 else
11843 PL_exitlist = (PerlExitListEntry*)NULL;
11844 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11845 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11846 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11847
11848 PL_profiledata = NULL;
11849 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11850 /* PL_rsfp_filters entries have fake IoDIRP() */
11851 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11852
11853 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11854
11855 PAD_CLONE_VARS(proto_perl, param);
11856
11857#ifdef HAVE_INTERP_INTERN
11858 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11859#endif
11860
11861 /* more statics moved here */
11862 PL_generation = proto_perl->Igeneration;
11863 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11864
11865 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11866 PL_in_clean_all = proto_perl->Iin_clean_all;
11867
11868 PL_uid = proto_perl->Iuid;
11869 PL_euid = proto_perl->Ieuid;
11870 PL_gid = proto_perl->Igid;
11871 PL_egid = proto_perl->Iegid;
11872 PL_nomemok = proto_perl->Inomemok;
11873 PL_an = proto_perl->Ian;
11874 PL_evalseq = proto_perl->Ievalseq;
11875 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11876 PL_origalen = proto_perl->Iorigalen;
11877 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11878 PL_osname = SAVEPV(proto_perl->Iosname);
11879 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11880 PL_sighandlerp = proto_perl->Isighandlerp;
11881
11882
11883 PL_runops = proto_perl->Irunops;
11884
11885 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11886
11887#ifdef CSH
11888 PL_cshlen = proto_perl->Icshlen;
11889 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11890#endif
11891
11892 PL_lex_state = proto_perl->Ilex_state;
11893 PL_lex_defer = proto_perl->Ilex_defer;
11894 PL_lex_expect = proto_perl->Ilex_expect;
11895 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11896 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11897 PL_lex_starts = proto_perl->Ilex_starts;
11898 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11899 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11900 PL_lex_op = proto_perl->Ilex_op;
11901 PL_lex_inpat = proto_perl->Ilex_inpat;
11902 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11903 PL_lex_brackets = proto_perl->Ilex_brackets;
11904 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11905 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11906 PL_lex_casemods = proto_perl->Ilex_casemods;
11907 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11908 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11909
11910 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11911 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11912 PL_nexttoke = proto_perl->Inexttoke;
11913
11914 /* XXX This is probably masking the deeper issue of why
11915 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11916 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11917 * (A little debugging with a watchpoint on it may help.)
11918 */
11919 if (SvANY(proto_perl->Ilinestr)) {
11920 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11921 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11922 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11923 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11924 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11925 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11926 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11927 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11928 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11929 }
11930 else {
11931 PL_linestr = NEWSV(65,79);
11932 sv_upgrade(PL_linestr,SVt_PVIV);
11933 sv_setpvn(PL_linestr,"",0);
11934 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11935 }
11936 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11937 PL_pending_ident = proto_perl->Ipending_ident;
11938 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11939
11940 PL_expect = proto_perl->Iexpect;
11941
11942 PL_multi_start = proto_perl->Imulti_start;
11943 PL_multi_end = proto_perl->Imulti_end;
11944 PL_multi_open = proto_perl->Imulti_open;
11945 PL_multi_close = proto_perl->Imulti_close;
11946
11947 PL_error_count = proto_perl->Ierror_count;
11948 PL_subline = proto_perl->Isubline;
11949 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11950
11951 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11952 if (SvANY(proto_perl->Ilinestr)) {
11953 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11954 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11955 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11956 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11957 PL_last_lop_op = proto_perl->Ilast_lop_op;
11958 }
11959 else {
11960 PL_last_uni = SvPVX(PL_linestr);
11961 PL_last_lop = SvPVX(PL_linestr);
11962 PL_last_lop_op = 0;
11963 }
11964 PL_in_my = proto_perl->Iin_my;
11965 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11966#ifdef FCRYPT
11967 PL_cryptseen = proto_perl->Icryptseen;
11968#endif
11969
11970 PL_hints = proto_perl->Ihints;
11971
11972 PL_amagic_generation = proto_perl->Iamagic_generation;
11973
11974#ifdef USE_LOCALE_COLLATE
11975 PL_collation_ix = proto_perl->Icollation_ix;
11976 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11977 PL_collation_standard = proto_perl->Icollation_standard;
11978 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11979 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11980#endif /* USE_LOCALE_COLLATE */
11981
11982#ifdef USE_LOCALE_NUMERIC
11983 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11984 PL_numeric_standard = proto_perl->Inumeric_standard;
11985 PL_numeric_local = proto_perl->Inumeric_local;
11986 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11987#endif /* !USE_LOCALE_NUMERIC */
11988
11989 /* utf8 character classes */
11990 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11991 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11992 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11993 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11994 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11995 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11996 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11997 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11998 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11999 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12000 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12001 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12002 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12003 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12004 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12005 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12006 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12007 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12008 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12009 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12010
12011 /* Did the locale setup indicate UTF-8? */
12012 PL_utf8locale = proto_perl->Iutf8locale;
12013 /* Unicode features (see perlrun/-C) */
12014 PL_unicode = proto_perl->Iunicode;
12015
12016 /* Pre-5.8 signals control */
12017 PL_signals = proto_perl->Isignals;
12018
12019 /* times() ticks per second */
12020 PL_clocktick = proto_perl->Iclocktick;
12021
12022 /* Recursion stopper for PerlIO_find_layer */
12023 PL_in_load_module = proto_perl->Iin_load_module;
12024
12025 /* sort() routine */
12026 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12027
12028 /* Not really needed/useful since the reenrant_retint is "volatile",
12029 * but do it for consistency's sake. */
12030 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12031
12032 /* Hooks to shared SVs and locks. */
12033 PL_sharehook = proto_perl->Isharehook;
12034 PL_lockhook = proto_perl->Ilockhook;
12035 PL_unlockhook = proto_perl->Iunlockhook;
12036 PL_threadhook = proto_perl->Ithreadhook;
12037
12038 PL_runops_std = proto_perl->Irunops_std;
12039 PL_runops_dbg = proto_perl->Irunops_dbg;
12040
12041#ifdef THREADS_HAVE_PIDS
12042 PL_ppid = proto_perl->Ippid;
12043#endif
12044
12045 /* swatch cache */
12046 PL_last_swash_hv = Nullhv; /* reinits on demand */
12047 PL_last_swash_klen = 0;
12048 PL_last_swash_key[0]= '\0';
12049 PL_last_swash_tmps = (U8*)NULL;
12050 PL_last_swash_slen = 0;
12051
12052 PL_glob_index = proto_perl->Iglob_index;
12053 PL_srand_called = proto_perl->Isrand_called;
12054 PL_hash_seed = proto_perl->Ihash_seed;
12055 PL_rehash_seed = proto_perl->Irehash_seed;
12056 PL_uudmap['M'] = 0; /* reinits on demand */
12057 PL_bitcount = Nullch; /* reinits on demand */
12058
12059 if (proto_perl->Ipsig_pend) {
12060 Newz(0, PL_psig_pend, SIG_SIZE, int);
12061 }
12062 else {
12063 PL_psig_pend = (int*)NULL;
12064 }
12065
12066 if (proto_perl->Ipsig_ptr) {
12067 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12068 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12069 for (i = 1; i < SIG_SIZE; i++) {
12070 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12071 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12072 }
12073 }
12074 else {
12075 PL_psig_ptr = (SV**)NULL;
12076 PL_psig_name = (SV**)NULL;
12077 }
12078
12079 /* thrdvar.h stuff */
12080
12081 if (flags & CLONEf_COPY_STACKS) {
12082 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12083 PL_tmps_ix = proto_perl->Ttmps_ix;
12084 PL_tmps_max = proto_perl->Ttmps_max;
12085 PL_tmps_floor = proto_perl->Ttmps_floor;
12086 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12087 i = 0;
12088 while (i <= PL_tmps_ix) {
12089 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12090 ++i;
12091 }
12092
12093 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12094 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12095 Newz(54, PL_markstack, i, I32);
12096 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12097 - proto_perl->Tmarkstack);
12098 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12099 - proto_perl->Tmarkstack);
12100 Copy(proto_perl->Tmarkstack, PL_markstack,
12101 PL_markstack_ptr - PL_markstack + 1, I32);
12102
12103 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12104 * NOTE: unlike the others! */
12105 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12106 PL_scopestack_max = proto_perl->Tscopestack_max;
12107 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12108 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12109
12110 /* NOTE: si_dup() looks at PL_markstack */
12111 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12112
12113 /* PL_curstack = PL_curstackinfo->si_stack; */
12114 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12115 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12116
12117 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12118 PL_stack_base = AvARRAY(PL_curstack);
12119 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12120 - proto_perl->Tstack_base);
12121 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12122
12123 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12124 * NOTE: unlike the others! */
12125 PL_savestack_ix = proto_perl->Tsavestack_ix;
12126 PL_savestack_max = proto_perl->Tsavestack_max;
12127 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12128 PL_savestack = ss_dup(proto_perl, param);
12129 }
12130 else {
12131 init_stacks();
12132 ENTER; /* perl_destruct() wants to LEAVE; */
12133 }
12134
12135 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12136 PL_top_env = &PL_start_env;
12137
12138 PL_op = proto_perl->Top;
12139
12140 PL_Sv = Nullsv;
12141 PL_Xpv = (XPV*)NULL;
12142 PL_na = proto_perl->Tna;
12143
12144 PL_statbuf = proto_perl->Tstatbuf;
12145 PL_statcache = proto_perl->Tstatcache;
12146 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12147 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12148#ifdef HAS_TIMES
12149 PL_timesbuf = proto_perl->Ttimesbuf;
12150#endif
12151
12152 PL_tainted = proto_perl->Ttainted;
12153 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12154 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12155 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12156 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12157 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12158 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12159 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12160 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12161 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12162
12163 PL_restartop = proto_perl->Trestartop;
12164 PL_in_eval = proto_perl->Tin_eval;
12165 PL_delaymagic = proto_perl->Tdelaymagic;
12166 PL_dirty = proto_perl->Tdirty;
12167 PL_localizing = proto_perl->Tlocalizing;
12168
12169 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12170 PL_hv_fetch_ent_mh = Nullhe;
12171 PL_modcount = proto_perl->Tmodcount;
12172 PL_lastgotoprobe = Nullop;
12173 PL_dumpindent = proto_perl->Tdumpindent;
12174
12175 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12176 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12177 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12178 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12179 PL_sortcxix = proto_perl->Tsortcxix;
12180 PL_efloatbuf = Nullch; /* reinits on demand */
12181 PL_efloatsize = 0; /* reinits on demand */
12182
12183 /* regex stuff */
12184
12185 PL_screamfirst = NULL;
12186 PL_screamnext = NULL;
12187 PL_maxscream = -1; /* reinits on demand */
12188 PL_lastscream = Nullsv;
12189
12190 PL_watchaddr = NULL;
12191 PL_watchok = Nullch;
12192
12193 PL_regdummy = proto_perl->Tregdummy;
12194 PL_regprecomp = Nullch;
12195 PL_regnpar = 0;
12196 PL_regsize = 0;
12197 PL_colorset = 0; /* reinits PL_colors[] */
12198 /*PL_colors[6] = {0,0,0,0,0,0};*/
12199 PL_reginput = Nullch;
12200 PL_regbol = Nullch;
12201 PL_regeol = Nullch;
12202 PL_regstartp = (I32*)NULL;
12203 PL_regendp = (I32*)NULL;
12204 PL_reglastparen = (U32*)NULL;
12205 PL_reglastcloseparen = (U32*)NULL;
12206 PL_regtill = Nullch;
12207 PL_reg_start_tmp = (char**)NULL;
12208 PL_reg_start_tmpl = 0;
12209 PL_regdata = (struct reg_data*)NULL;
12210 PL_bostr = Nullch;
12211 PL_reg_flags = 0;
12212 PL_reg_eval_set = 0;
12213 PL_regnarrate = 0;
12214 PL_regprogram = (regnode*)NULL;
12215 PL_regindent = 0;
12216 PL_regcc = (CURCUR*)NULL;
12217 PL_reg_call_cc = (struct re_cc_state*)NULL;
12218 PL_reg_re = (regexp*)NULL;
12219 PL_reg_ganch = Nullch;
12220 PL_reg_sv = Nullsv;
12221 PL_reg_match_utf8 = FALSE;
12222 PL_reg_magic = (MAGIC*)NULL;
12223 PL_reg_oldpos = 0;
12224 PL_reg_oldcurpm = (PMOP*)NULL;
12225 PL_reg_curpm = (PMOP*)NULL;
12226 PL_reg_oldsaved = Nullch;
12227 PL_reg_oldsavedlen = 0;
12228#ifdef PERL_COPY_ON_WRITE
12229 PL_nrs = Nullsv;
12230#endif
12231 PL_reg_maxiter = 0;
12232 PL_reg_leftiter = 0;
12233 PL_reg_poscache = Nullch;
12234 PL_reg_poscache_size= 0;
12235
12236 /* RE engine - function pointers */
12237 PL_regcompp = proto_perl->Tregcompp;
12238 PL_regexecp = proto_perl->Tregexecp;
12239 PL_regint_start = proto_perl->Tregint_start;
12240 PL_regint_string = proto_perl->Tregint_string;
12241 PL_regfree = proto_perl->Tregfree;
12242
12243 PL_reginterp_cnt = 0;
12244 PL_reg_starttry = 0;
12245
12246 /* Pluggable optimizer */
12247 PL_peepp = proto_perl->Tpeepp;
12248
12249 PL_stashcache = newHV();
12250
12251 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12252 ptr_table_free(PL_ptr_table);
12253 PL_ptr_table = NULL;
12254 }
12255
12256 /* Call the ->CLONE method, if it exists, for each of the stashes
12257 identified by sv_dup() above.
12258 */
12259 while(av_len(param->stashes) != -1) {
12260 HV* stash = (HV*) av_shift(param->stashes);
12261 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12262 if (cloner && GvCV(cloner)) {
12263 dSP;
12264 ENTER;
12265 SAVETMPS;
12266 PUSHMARK(SP);
12267 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
12268 PUTBACK;
12269 call_sv((SV*)GvCV(cloner), G_DISCARD);
12270 FREETMPS;
12271 LEAVE;
12272 }
12273 }
12274
12275 SvREFCNT_dec(param->stashes);
12276
12277 return my_perl;
12278}
12279
12280#endif /* USE_ITHREADS */
12281
12282/*
12283=head1 Unicode Support
12284
12285=for apidoc sv_recode_to_utf8
12286
12287The encoding is assumed to be an Encode object, on entry the PV
12288of the sv is assumed to be octets in that encoding, and the sv
12289will be converted into Unicode (and UTF-8).
12290
12291If the sv already is UTF-8 (or if it is not POK), or if the encoding
12292is not a reference, nothing is done to the sv. If the encoding is not
12293an C<Encode::XS> Encoding object, bad things will happen.
12294(See F<lib/encoding.pm> and L<Encode>).
12295
12296The PV of the sv is returned.
12297
12298=cut */
12299
12300char *
12301Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12302{
12303 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12304 SV *uni;
12305 STRLEN len;
12306 char *s;
12307 dSP;
12308 ENTER;
12309 SAVETMPS;
12310 save_re_context();
12311 PUSHMARK(sp);
12312 EXTEND(SP, 3);
12313 XPUSHs(encoding);
12314 XPUSHs(sv);
12315/*
12316 NI-S 2002/07/09
12317 Passing sv_yes is wrong - it needs to be or'ed set of constants
12318 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12319 remove converted chars from source.
12320
12321 Both will default the value - let them.
12322
12323 XPUSHs(&PL_sv_yes);
12324*/
12325 PUTBACK;
12326 call_method("decode", G_SCALAR);
12327 SPAGAIN;
12328 uni = POPs;
12329 PUTBACK;
12330 s = SvPV(uni, len);
12331 if (s != SvPVX(sv)) {
12332 SvGROW(sv, len + 1);
12333 Move(s, SvPVX(sv), len, char);
12334 SvCUR_set(sv, len);
12335 SvPVX(sv)[len] = 0;
12336 }
12337 FREETMPS;
12338 LEAVE;
12339 SvUTF8_on(sv);
12340 return SvPVX(sv);
12341 }
12342 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12343}
12344
12345/*
12346=for apidoc sv_cat_decode
12347
12348The encoding is assumed to be an Encode object, the PV of the ssv is
12349assumed to be octets in that encoding and decoding the input starts
12350from the position which (PV + *offset) pointed to. The dsv will be
12351concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12352when the string tstr appears in decoding output or the input ends on
12353the PV of the ssv. The value which the offset points will be modified
12354to the last input position on the ssv.
12355
12356Returns TRUE if the terminator was found, else returns FALSE.
12357
12358=cut */
12359
12360bool
12361Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12362 SV *ssv, int *offset, char *tstr, int tlen)
12363{
12364 bool ret = FALSE;
12365 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12366 SV *offsv;
12367 dSP;
12368 ENTER;
12369 SAVETMPS;
12370 save_re_context();
12371 PUSHMARK(sp);
12372 EXTEND(SP, 6);
12373 XPUSHs(encoding);
12374 XPUSHs(dsv);
12375 XPUSHs(ssv);
12376 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12377 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12378 PUTBACK;
12379 call_method("cat_decode", G_SCALAR);
12380 SPAGAIN;
12381 ret = SvTRUE(TOPs);
12382 *offset = SvIV(offsv);
12383 PUTBACK;
12384 FREETMPS;
12385 LEAVE;
12386 }
12387 else
12388 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12389 return ret;
12390}
12391
12392/*
12393 * Local variables:
12394 * c-indentation-style: bsd
12395 * c-basic-offset: 4
12396 * indent-tabs-mode: t
12397 * End:
12398 *
12399 * vim: shiftwidth=4:
12400*/