sv.c

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