sv.c

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