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