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