sv.c

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