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