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