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