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