sv.c

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