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<name> is NULL then namelen bytes are allocated and Zero()-ed),
4408 if C<namelen> is zero then C<name> is stored as-is and - as another special
4409 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4410 an C<SV*> and has its REFCNT incremented
4411
4412 (This is now used as a subroutine by sv_magic.)
4413
4414 =cut
4415 */
4416 MAGIC *
4417 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4418                  const char* name, I32 namlen)
4419 {
4420     MAGIC* mg;
4421
4422     if (SvTYPE(sv) < SVt_PVMG) {
4423         (void)SvUPGRADE(sv, SVt_PVMG);
4424     }
4425     Newz(702,mg, 1, MAGIC);
4426     mg->mg_moremagic = SvMAGIC(sv);
4427     SvMAGIC(sv) = mg;
4428
4429     /* Some magic sontains a reference loop, where the sv and object refer to
4430        each other.  To prevent a reference loop that would prevent such
4431        objects being freed, we look for such loops and if we find one we
4432        avoid incrementing the object refcount. */
4433     if (!obj || obj == sv ||
4434         how == PERL_MAGIC_arylen ||
4435         how == PERL_MAGIC_qr ||
4436         (SvTYPE(obj) == SVt_PVGV &&
4437             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4438             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4439             GvFORM(obj) == (CV*)sv)))
4440     {
4441         mg->mg_obj = obj;
4442     }
4443     else {
4444         mg->mg_obj = SvREFCNT_inc(obj);
4445         mg->mg_flags |= MGf_REFCOUNTED;
4446     }
4447     mg->mg_type = how;
4448     mg->mg_len = namlen;
4449     if (name) {
4450         if (namlen > 0)
4451             mg->mg_ptr = savepvn(name, namlen);
4452         else if (namlen == HEf_SVKEY)
4453             mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4454         else
4455             mg->mg_ptr = (char *) name;
4456     }
4457     mg->mg_virtual = vtable;
4458
4459     mg_magical(sv);
4460     if (SvGMAGICAL(sv))
4461         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4462     return mg;
4463 }
4464
4465 /*
4466 =for apidoc sv_magic
4467
4468 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4469 then adds a new magic item of type C<how> to the head of the magic list.
4470
4471 =cut
4472 */
4473
4474 void
4475 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4476 {
4477     MAGIC* mg;
4478     MGVTBL *vtable = 0;
4479
4480     if (SvREADONLY(sv)) {
4481         if (PL_curcop != &PL_compiling
4482             && how != PERL_MAGIC_regex_global
4483             && how != PERL_MAGIC_bm
4484             && how != PERL_MAGIC_fm
4485             && how != PERL_MAGIC_sv
4486            )
4487         {
4488             Perl_croak(aTHX_ PL_no_modify);
4489         }
4490     }
4491     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4492         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4493             /* sv_magic() refuses to add a magic of the same 'how' as an
4494                existing one
4495              */
4496             if (how == PERL_MAGIC_taint)
4497                 mg->mg_len |= 1;
4498             return;
4499         }
4500     }
4501
4502     switch (how) {
4503     case PERL_MAGIC_sv:
4504         vtable = &PL_vtbl_sv;
4505         break;
4506     case PERL_MAGIC_overload:
4507         vtable = &PL_vtbl_amagic;
4508         break;
4509     case PERL_MAGIC_overload_elem:
4510         vtable = &PL_vtbl_amagicelem;
4511         break;
4512     case PERL_MAGIC_overload_table:
4513         vtable = &PL_vtbl_ovrld;
4514         break;
4515     case PERL_MAGIC_bm:
4516         vtable = &PL_vtbl_bm;
4517         break;
4518     case PERL_MAGIC_regdata:
4519         vtable = &PL_vtbl_regdata;
4520         break;
4521     case PERL_MAGIC_regdatum:
4522         vtable = &PL_vtbl_regdatum;
4523         break;
4524     case PERL_MAGIC_env:
4525         vtable = &PL_vtbl_env;
4526         break;
4527     case PERL_MAGIC_fm:
4528         vtable = &PL_vtbl_fm;
4529         break;
4530     case PERL_MAGIC_envelem:
4531         vtable = &PL_vtbl_envelem;
4532         break;
4533     case PERL_MAGIC_regex_global:
4534         vtable = &PL_vtbl_mglob;
4535         break;
4536     case PERL_MAGIC_isa:
4537         vtable = &PL_vtbl_isa;
4538         break;
4539     case PERL_MAGIC_isaelem:
4540         vtable = &PL_vtbl_isaelem;
4541         break;
4542     case PERL_MAGIC_nkeys:
4543         vtable = &PL_vtbl_nkeys;
4544         break;
4545     case PERL_MAGIC_dbfile:
4546         vtable = 0;
4547         break;
4548     case PERL_MAGIC_dbline:
4549         vtable = &PL_vtbl_dbline;
4550         break;
4551 #ifdef USE_5005THREADS
4552     case PERL_MAGIC_mutex:
4553         vtable = &PL_vtbl_mutex;
4554         break;
4555 #endif /* USE_5005THREADS */
4556 #ifdef USE_LOCALE_COLLATE
4557     case PERL_MAGIC_collxfrm:
4558         vtable = &PL_vtbl_collxfrm;
4559         break;
4560 #endif /* USE_LOCALE_COLLATE */
4561     case PERL_MAGIC_tied:
4562         vtable = &PL_vtbl_pack;
4563         break;
4564     case PERL_MAGIC_tiedelem:
4565     case PERL_MAGIC_tiedscalar:
4566         vtable = &PL_vtbl_packelem;
4567         break;
4568     case PERL_MAGIC_qr:
4569         vtable = &PL_vtbl_regexp;
4570         break;
4571     case PERL_MAGIC_sig:
4572         vtable = &PL_vtbl_sig;
4573         break;
4574     case PERL_MAGIC_sigelem:
4575         vtable = &PL_vtbl_sigelem;
4576         break;
4577     case PERL_MAGIC_taint:
4578         vtable = &PL_vtbl_taint;
4579         break;
4580     case PERL_MAGIC_uvar:
4581         vtable = &PL_vtbl_uvar;
4582         break;
4583     case PERL_MAGIC_vec:
4584         vtable = &PL_vtbl_vec;
4585         break;
4586     case PERL_MAGIC_substr:
4587         vtable = &PL_vtbl_substr;
4588         break;
4589     case PERL_MAGIC_defelem:
4590         vtable = &PL_vtbl_defelem;
4591         break;
4592     case PERL_MAGIC_glob:
4593         vtable = &PL_vtbl_glob;
4594         break;
4595     case PERL_MAGIC_arylen:
4596         vtable = &PL_vtbl_arylen;
4597         break;
4598     case PERL_MAGIC_pos:
4599         vtable = &PL_vtbl_pos;
4600         break;
4601     case PERL_MAGIC_backref:
4602         vtable = &PL_vtbl_backref;
4603         break;
4604     case PERL_MAGIC_ext:
4605         /* Reserved for use by extensions not perl internals.           */
4606         /* Useful for attaching extension internal data to perl vars.   */
4607         /* Note that multiple extensions may clash if magical scalars   */
4608         /* etc holding private data from one are passed to another.     */
4609         break;
4610     default:
4611         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4612     }
4613
4614     /* Rest of work is done else where */
4615     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4616
4617     switch (how) {
4618     case PERL_MAGIC_taint:
4619         mg->mg_len = 1;
4620         break;
4621     case PERL_MAGIC_ext:
4622     case PERL_MAGIC_dbfile:
4623         SvRMAGICAL_on(sv);
4624         break;
4625     }
4626 }
4627
4628 /*
4629 =for apidoc sv_unmagic
4630
4631 Removes all magic of type C<type> from an SV.
4632
4633 =cut
4634 */
4635
4636 int
4637 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4638 {
4639     MAGIC* mg;
4640     MAGIC** mgp;
4641     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4642         return 0;
4643     mgp = &SvMAGIC(sv);
4644     for (mg = *mgp; mg; mg = *mgp) {
4645         if (mg->mg_type == type) {
4646             MGVTBL* vtbl = mg->mg_virtual;
4647             *mgp = mg->mg_moremagic;
4648             if (vtbl && vtbl->svt_free)
4649                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4650             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4651                 if (mg->mg_len > 0)
4652                     Safefree(mg->mg_ptr);
4653                 else if (mg->mg_len == HEf_SVKEY)
4654                     SvREFCNT_dec((SV*)mg->mg_ptr);
4655             }
4656             if (mg->mg_flags & MGf_REFCOUNTED)
4657                 SvREFCNT_dec(mg->mg_obj);
4658             Safefree(mg);
4659         }
4660         else
4661             mgp = &mg->mg_moremagic;
4662     }
4663     if (!SvMAGIC(sv)) {
4664         SvMAGICAL_off(sv);
4665        SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4666     }
4667
4668     return 0;
4669 }
4670
4671 /*
4672 =for apidoc sv_rvweaken
4673
4674 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4675 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4676 push a back-reference to this RV onto the array of backreferences
4677 associated with that magic.
4678
4679 =cut
4680 */
4681
4682 SV *
4683 Perl_sv_rvweaken(pTHX_ SV *sv)
4684 {
4685     SV *tsv;
4686     if (!SvOK(sv))  /* let undefs pass */
4687         return sv;
4688     if (!SvROK(sv))
4689         Perl_croak(aTHX_ "Can't weaken a nonreference");
4690     else if (SvWEAKREF(sv)) {
4691         if (ckWARN(WARN_MISC))
4692             Perl_warner(aTHX_ WARN_MISC, "Reference is already weak");
4693         return sv;
4694     }
4695     tsv = SvRV(sv);
4696     sv_add_backref(tsv, sv);
4697     SvWEAKREF_on(sv);
4698     SvREFCNT_dec(tsv);
4699     return sv;
4700 }
4701
4702 /* Give tsv backref magic if it hasn't already got it, then push a
4703  * back-reference to sv onto the array associated with the backref magic.
4704  */
4705
4706 STATIC void
4707 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4708 {
4709     AV *av;
4710     MAGIC *mg;
4711     if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4712         av = (AV*)mg->mg_obj;
4713     else {
4714         av = newAV();
4715         sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4716         SvREFCNT_dec(av);           /* for sv_magic */
4717     }
4718     av_push(av,sv);
4719 }
4720
4721 /* delete a back-reference to ourselves from the backref magic associated
4722  * with the SV we point to.
4723  */
4724
4725 STATIC void
4726 S_sv_del_backref(pTHX_ SV *sv)
4727 {
4728     AV *av;
4729     SV **svp;
4730     I32 i;
4731     SV *tsv = SvRV(sv);
4732     MAGIC *mg;
4733     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4734         Perl_croak(aTHX_ "panic: del_backref");
4735     av = (AV *)mg->mg_obj;
4736     svp = AvARRAY(av);
4737     i = AvFILLp(av);
4738     while (i >= 0) {
4739         if (svp[i] == sv) {
4740             svp[i] = &PL_sv_undef; /* XXX */
4741         }
4742         i--;
4743     }
4744 }
4745
4746 /*
4747 =for apidoc sv_insert
4748
4749 Inserts a string at the specified offset/length within the SV. Similar to
4750 the Perl substr() function.
4751
4752 =cut
4753 */
4754
4755 void
4756 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
4757 {
4758     register char *big;
4759     register char *mid;
4760     register char *midend;
4761     register char *bigend;
4762     register I32 i;
4763     STRLEN curlen;
4764
4765
4766     if (!bigstr)
4767         Perl_croak(aTHX_ "Can't modify non-existent substring");
4768     SvPV_force(bigstr, curlen);
4769     (void)SvPOK_only_UTF8(bigstr);
4770     if (offset + len > curlen) {
4771         SvGROW(bigstr, offset+len+1);
4772         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4773         SvCUR_set(bigstr, offset+len);
4774     }
4775
4776     SvTAINT(bigstr);
4777     i = littlelen - len;
4778     if (i > 0) {                        /* string might grow */
4779         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4780         mid = big + offset + len;
4781         midend = bigend = big + SvCUR(bigstr);
4782         bigend += i;
4783         *bigend = '\0';
4784         while (midend > mid)            /* shove everything down */
4785             *--bigend = *--midend;
4786         Move(little,big+offset,littlelen,char);
4787         SvCUR(bigstr) += i;
4788         SvSETMAGIC(bigstr);
4789         return;
4790     }
4791     else if (i == 0) {
4792         Move(little,SvPVX(bigstr)+offset,len,char);
4793         SvSETMAGIC(bigstr);
4794         return;
4795     }
4796
4797     big = SvPVX(bigstr);
4798     mid = big + offset;
4799     midend = mid + len;
4800     bigend = big + SvCUR(bigstr);
4801
4802     if (midend > bigend)
4803         Perl_croak(aTHX_ "panic: sv_insert");
4804
4805     if (mid - big > bigend - midend) {  /* faster to shorten from end */
4806         if (littlelen) {
4807             Move(little, mid, littlelen,char);
4808             mid += littlelen;
4809         }
4810         i = bigend - midend;
4811         if (i > 0) {
4812             Move(midend, mid, i,char);
4813             mid += i;
4814         }
4815         *mid = '\0';
4816         SvCUR_set(bigstr, mid - big);
4817     }
4818     /*SUPPRESS 560*/
4819     else if ((i = mid - big)) { /* faster from front */
4820         midend -= littlelen;
4821         mid = midend;
4822         sv_chop(bigstr,midend-i);
4823         big += i;
4824         while (i--)
4825             *--midend = *--big;
4826         if (littlelen)
4827             Move(little, mid, littlelen,char);
4828     }
4829     else if (littlelen) {
4830         midend -= littlelen;
4831         sv_chop(bigstr,midend);
4832         Move(little,midend,littlelen,char);
4833     }
4834     else {
4835         sv_chop(bigstr,midend);
4836     }
4837     SvSETMAGIC(bigstr);
4838 }
4839
4840 /*
4841 =for apidoc sv_replace
4842
4843 Make the first argument a copy of the second, then delete the original.
4844 The target SV physically takes over ownership of the body of the source SV
4845 and inherits its flags; however, the target keeps any magic it owns,
4846 and any magic in the source is discarded.
4847 Note that this is a rather specialist SV copying operation; most of the
4848 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4849
4850 =cut
4851 */
4852
4853 void
4854 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4855 {
4856     U32 refcnt = SvREFCNT(sv);
4857     SV_CHECK_THINKFIRST(sv);
4858     if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
4859         Perl_warner(aTHX_ WARN_INTERNAL, "Reference miscount in sv_replace()");
4860     if (SvMAGICAL(sv)) {
4861         if (SvMAGICAL(nsv))
4862             mg_free(nsv);
4863         else
4864             sv_upgrade(nsv, SVt_PVMG);
4865         SvMAGIC(nsv) = SvMAGIC(sv);
4866         SvFLAGS(nsv) |= SvMAGICAL(sv);
4867         SvMAGICAL_off(sv);
4868         SvMAGIC(sv) = 0;
4869     }
4870     SvREFCNT(sv) = 0;
4871     sv_clear(sv);
4872     assert(!SvREFCNT(sv));
4873     StructCopy(nsv,sv,SV);
4874     SvREFCNT(sv) = refcnt;
4875     SvFLAGS(nsv) |= SVTYPEMASK;         /* Mark as freed */
4876     del_SV(nsv);
4877 }
4878
4879 /*
4880 =for apidoc sv_clear
4881
4882 Clear an SV: call any destructors, free up any memory used by the body,
4883 and free the body itself. The SV's head is I<not> freed, although
4884 its type is set to all 1's so that it won't inadvertently be assumed
4885 to be live during global destruction etc.
4886 This function should only be called when REFCNT is zero. Most of the time
4887 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4888 instead.
4889
4890 =cut
4891 */
4892
4893 void
4894 Perl_sv_clear(pTHX_ register SV *sv)
4895 {
4896     HV* stash;
4897     assert(sv);
4898     assert(SvREFCNT(sv) == 0);
4899
4900     if (SvOBJECT(sv)) {
4901         if (PL_defstash) {              /* Still have a symbol table? */
4902             dSP;
4903             CV* destructor;
4904             SV tmpref;
4905
4906             Zero(&tmpref, 1, SV);
4907             sv_upgrade(&tmpref, SVt_RV);
4908             SvROK_on(&tmpref);
4909             SvREADONLY_on(&tmpref);     /* DESTROY() could be naughty */
4910             SvREFCNT(&tmpref) = 1;
4911
4912             do {
4913                 stash = SvSTASH(sv);
4914                 destructor = StashHANDLER(stash,DESTROY);
4915                 if (destructor) {
4916                     ENTER;
4917                     PUSHSTACKi(PERLSI_DESTROY);
4918                     SvRV(&tmpref) = SvREFCNT_inc(sv);
4919                     EXTEND(SP, 2);
4920                     PUSHMARK(SP);
4921                     PUSHs(&tmpref);
4922                     PUTBACK;
4923                     call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR);
4924                     SvREFCNT(sv)--;
4925                     POPSTACK;
4926                     SPAGAIN;
4927                     LEAVE;
4928                 }
4929             } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4930
4931             del_XRV(SvANY(&tmpref));
4932
4933             if (SvREFCNT(sv)) {
4934                 if (PL_in_clean_objs)
4935                     Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4936                           HvNAME(stash));
4937                 /* DESTROY gave object new lease on life */
4938                 return;
4939             }
4940         }
4941
4942         if (SvOBJECT(sv)) {
4943             SvREFCNT_dec(SvSTASH(sv));  /* possibly of changed persuasion */
4944             SvOBJECT_off(sv);   /* Curse the object. */
4945             if (SvTYPE(sv) != SVt_PVIO)
4946                 --PL_sv_objcount;       /* XXX Might want something more general */
4947         }
4948     }
4949     if (SvTYPE(sv) >= SVt_PVMG) {
4950         if (SvMAGIC(sv))
4951             mg_free(sv);
4952         if (SvFLAGS(sv) & SVpad_TYPED)
4953             SvREFCNT_dec(SvSTASH(sv));
4954     }
4955     stash = NULL;
4956     switch (SvTYPE(sv)) {
4957     case SVt_PVIO:
4958         if (IoIFP(sv) &&
4959             IoIFP(sv) != PerlIO_stdin() &&
4960             IoIFP(sv) != PerlIO_stdout() &&
4961             IoIFP(sv) != PerlIO_stderr())
4962         {
4963             io_close((IO*)sv, FALSE);
4964         }
4965         if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4966             PerlDir_close(IoDIRP(sv));
4967         IoDIRP(sv) = (DIR*)NULL;
4968         Safefree(IoTOP_NAME(sv));
4969         Safefree(IoFMT_NAME(sv));
4970         Safefree(IoBOTTOM_NAME(sv));
4971         /* FALL THROUGH */
4972     case SVt_PVBM:
4973         goto freescalar;
4974     case SVt_PVCV:
4975     case SVt_PVFM:
4976         cv_undef((CV*)sv);
4977         goto freescalar;
4978     case SVt_PVHV:
4979         hv_undef((HV*)sv);
4980         break;
4981     case SVt_PVAV:
4982         av_undef((AV*)sv);
4983         break;
4984     case SVt_PVLV:
4985         SvREFCNT_dec(LvTARG(sv));
4986         goto freescalar;
4987     case SVt_PVGV:
4988         gp_free((GV*)sv);
4989         Safefree(GvNAME(sv));
4990         /* cannot decrease stash refcount yet, as we might recursively delete
4991            ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
4992            of stash until current sv is completely gone.
4993            -- JohnPC, 27 Mar 1998 */
4994         stash = GvSTASH(sv);
4995         /* FALL THROUGH */
4996     case SVt_PVMG:
4997     case SVt_PVNV:
4998     case SVt_PVIV:
4999       freescalar:
5000         (void)SvOOK_off(sv);
5001         /* FALL THROUGH */
5002     case SVt_PV:
5003     case SVt_RV:
5004         if (SvROK(sv)) {
5005             if (SvWEAKREF(sv))
5006                 sv_del_backref(sv);
5007             else
5008                 SvREFCNT_dec(SvRV(sv));
5009         }
5010         else if (SvPVX(sv) && SvLEN(sv))
5011             Safefree(SvPVX(sv));
5012         else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5013             unsharepvn(SvPVX(sv),
5014                        SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5015                        SvUVX(sv));
5016             SvFAKE_off(sv);
5017         }
5018         break;
5019 /*
5020     case SVt_NV:
5021     case SVt_IV:
5022     case SVt_NULL:
5023         break;
5024 */
5025     }
5026
5027     switch (SvTYPE(sv)) {
5028     case SVt_NULL:
5029         break;
5030     case SVt_IV:
5031         del_XIV(SvANY(sv));
5032         break;
5033     case SVt_NV:
5034         del_XNV(SvANY(sv));
5035         break;
5036     case SVt_RV:
5037         del_XRV(SvANY(sv));
5038         break;
5039     case SVt_PV:
5040         del_XPV(SvANY(sv));
5041         break;
5042     case SVt_PVIV:
5043         del_XPVIV(SvANY(sv));
5044         break;
5045     case SVt_PVNV:
5046         del_XPVNV(SvANY(sv));
5047         break;
5048     case SVt_PVMG:
5049         del_XPVMG(SvANY(sv));
5050         break;
5051     case SVt_PVLV:
5052         del_XPVLV(SvANY(sv));
5053         break;
5054     case SVt_PVAV:
5055         del_XPVAV(SvANY(sv));
5056         break;
5057     case SVt_PVHV:
5058         del_XPVHV(SvANY(sv));
5059         break;
5060     case SVt_PVCV:
5061         del_XPVCV(SvANY(sv));
5062         break;
5063     case SVt_PVGV:
5064         del_XPVGV(SvANY(sv));
5065         /* code duplication for increased performance. */
5066         SvFLAGS(sv) &= SVf_BREAK;
5067         SvFLAGS(sv) |= SVTYPEMASK;
5068         /* decrease refcount of the stash that owns this GV, if any */
5069         if (stash)
5070             SvREFCNT_dec(stash);
5071         return; /* not break, SvFLAGS reset already happened */
5072     case SVt_PVBM:
5073         del_XPVBM(SvANY(sv));
5074         break;
5075     case SVt_PVFM:
5076         del_XPVFM(SvANY(sv));
5077         break;
5078     case SVt_PVIO:
5079         del_XPVIO(SvANY(sv));
5080         break;
5081     }
5082     SvFLAGS(sv) &= SVf_BREAK;
5083     SvFLAGS(sv) |= SVTYPEMASK;
5084 }
5085
5086 /*
5087 =for apidoc sv_newref
5088
5089 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5090 instead.
5091
5092 =cut
5093 */
5094
5095 SV *
5096 Perl_sv_newref(pTHX_ SV *sv)
5097 {
5098     if (sv)
5099         ATOMIC_INC(SvREFCNT(sv));
5100     return sv;
5101 }
5102
5103 /*
5104 =for apidoc sv_free
5105
5106 Decrement an SV's reference count, and if it drops to zero, call
5107 C<sv_clear> to invoke destructors and free up any memory used by
5108 the body; finally, deallocate the SV's head itself.
5109 Normally called via a wrapper macro C<SvREFCNT_dec>.
5110
5111 =cut
5112 */
5113
5114 void
5115 Perl_sv_free(pTHX_ SV *sv)
5116 {
5117     int refcount_is_zero;
5118
5119     if (!sv)
5120         return;
5121     if (SvREFCNT(sv) == 0) {
5122         if (SvFLAGS(sv) & SVf_BREAK)
5123             /* this SV's refcnt has been artificially decremented to
5124              * trigger cleanup */
5125             return;
5126         if (PL_in_clean_all) /* All is fair */
5127             return;
5128         if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5129             /* make sure SvREFCNT(sv)==0 happens very seldom */
5130             SvREFCNT(sv) = (~(U32)0)/2;
5131             return;
5132         }
5133         if (ckWARN_d(WARN_INTERNAL))
5134             Perl_warner(aTHX_ WARN_INTERNAL, "Attempt to free unreferenced scalar");
5135         return;
5136     }
5137     ATOMIC_DEC_AND_TEST(refcount_is_zero, SvREFCNT(sv));
5138     if (!refcount_is_zero)
5139         return;
5140 #ifdef DEBUGGING
5141     if (SvTEMP(sv)) {
5142         if (ckWARN_d(WARN_DEBUGGING))
5143             Perl_warner(aTHX_ WARN_DEBUGGING,
5144                         "Attempt to free temp prematurely: SV 0x%"UVxf,
5145                         PTR2UV(sv));
5146         return;
5147     }
5148 #endif
5149     if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5150         /* make sure SvREFCNT(sv)==0 happens very seldom */
5151         SvREFCNT(sv) = (~(U32)0)/2;
5152         return;
5153     }
5154     sv_clear(sv);
5155     if (! SvREFCNT(sv))
5156         del_SV(sv);
5157 }
5158
5159 /*
5160 =for apidoc sv_len
5161
5162 Returns the length of the string in the SV. Handles magic and type
5163 coercion.  See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5164
5165 =cut
5166 */
5167
5168 STRLEN
5169 Perl_sv_len(pTHX_ register SV *sv)
5170 {
5171     STRLEN len;
5172
5173     if (!sv)
5174         return 0;
5175
5176     if (SvGMAGICAL(sv))
5177         len = mg_length(sv);
5178     else
5179         (void)SvPV(sv, len);
5180     return len;
5181 }
5182
5183 /*
5184 =for apidoc sv_len_utf8
5185
5186 Returns the number of characters in the string in an SV, counting wide
5187 UTF8 bytes as a single character. Handles magic and type coercion.
5188
5189 =cut
5190 */
5191
5192 STRLEN
5193 Perl_sv_len_utf8(pTHX_ register SV *sv)
5194 {
5195     if (!sv)
5196         return 0;
5197
5198     if (SvGMAGICAL(sv))
5199         return mg_length(sv);
5200     else
5201     {
5202         STRLEN len;
5203         U8 *s = (U8*)SvPV(sv, len);
5204
5205         return Perl_utf8_length(aTHX_ s, s + len);
5206     }
5207 }
5208
5209 /*
5210 =for apidoc sv_pos_u2b
5211
5212 Converts the value pointed to by offsetp from a count of UTF8 chars from
5213 the start of the string, to a count of the equivalent number of bytes; if
5214 lenp is non-zero, it does the same to lenp, but this time starting from
5215 the offset, rather than from the start of the string. Handles magic and
5216 type coercion.
5217
5218 =cut
5219 */
5220
5221 void
5222 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5223 {
5224     U8 *start;
5225     U8 *s;
5226     U8 *send;
5227     I32 uoffset = *offsetp;
5228     STRLEN len;
5229
5230     if (!sv)
5231         return;
5232
5233     start = s = (U8*)SvPV(sv, len);
5234     send = s + len;
5235     while (s < send && uoffset--)
5236         s += UTF8SKIP(s);
5237     if (s >= send)
5238         s = send;
5239     *offsetp = s - start;
5240     if (lenp) {
5241         I32 ulen = *lenp;
5242         start = s;
5243         while (s < send && ulen--)
5244             s += UTF8SKIP(s);
5245         if (s >= send)
5246             s = send;
5247         *lenp = s - start;
5248     }
5249     return;
5250 }
5251
5252 /*
5253 =for apidoc sv_pos_b2u
5254
5255 Converts the value pointed to by offsetp from a count of bytes from the
5256 start of the string, to a count of the equivalent number of UTF8 chars.
5257 Handles magic and type coercion.
5258
5259 =cut
5260 */
5261
5262 void
5263 Perl_sv_pos_b2u(pTHX_ register SV *sv, I32* offsetp)
5264 {
5265     U8 *s;
5266     U8 *send;
5267     STRLEN len;
5268
5269     if (!sv)
5270         return;
5271
5272     s = (U8*)SvPV(sv, len);
5273     if (len < *offsetp)
5274         Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5275     send = s + *offsetp;
5276     len = 0;
5277     while (s < send) {
5278         STRLEN n;
5279         /* Call utf8n_to_uvchr() to validate the sequence */
5280         utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5281         if (n > 0) {
5282             s += n;
5283             len++;
5284         }
5285         else
5286             break;
5287     }
5288     *offsetp = len;
5289     return;
5290 }
5291
5292 /*
5293 =for apidoc sv_eq
5294
5295 Returns a boolean indicating whether the strings in the two SVs are
5296 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5297 coerce its args to strings if necessary.
5298
5299 =cut
5300 */
5301
5302 I32
5303 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5304 {
5305     char *pv1;
5306     STRLEN cur1;
5307     char *pv2;
5308     STRLEN cur2;
5309     I32  eq     = 0;
5310     char *tpv   = Nullch;
5311
5312     if (!sv1) {
5313         pv1 = "";
5314         cur1 = 0;
5315     }
5316     else
5317         pv1 = SvPV(sv1, cur1);
5318
5319     if (!sv2){
5320         pv2 = "";
5321         cur2 = 0;
5322     }
5323     else
5324         pv2 = SvPV(sv2, cur2);
5325
5326     /* do not utf8ize the comparands as a side-effect */
5327     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5328         bool is_utf8 = TRUE;
5329         /* UTF-8ness differs */
5330
5331         if (SvUTF8(sv1)) {
5332             /* sv1 is the UTF-8 one , If is equal it must be downgrade-able */
5333             char *pv = (char*)bytes_from_utf8((U8*)pv1, &cur1, &is_utf8);
5334             if (pv != pv1)
5335                 pv1 = tpv = pv;
5336         }
5337         else {
5338             /* sv2 is the UTF-8 one , If is equal it must be downgrade-able */
5339             char *pv = (char *)bytes_from_utf8((U8*)pv2, &cur2, &is_utf8);
5340             if (pv != pv2)
5341                 pv2 = tpv = pv;
5342         }
5343         if (is_utf8) {
5344             /* Downgrade not possible - cannot be eq */
5345             return FALSE;
5346         }
5347     }
5348
5349     if (cur1 == cur2)
5350         eq = memEQ(pv1, pv2, cur1);
5351
5352     if (tpv != Nullch)
5353         Safefree(tpv);
5354
5355     return eq;
5356 }
5357
5358 /*
5359 =for apidoc sv_cmp
5360
5361 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
5362 string in C<sv1> is less than, equal to, or greater than the string in
5363 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5364 coerce its args to strings if necessary.  See also C<sv_cmp_locale>.
5365
5366 =cut
5367 */
5368
5369 I32
5370 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5371 {
5372     STRLEN cur1, cur2;
5373     char *pv1, *pv2;
5374     I32  cmp;
5375     bool pv1tmp = FALSE;
5376     bool pv2tmp = FALSE;
5377
5378     if (!sv1) {
5379         pv1 = "";
5380         cur1 = 0;
5381     }
5382     else
5383         pv1 = SvPV(sv1, cur1);
5384
5385     if (!sv2){
5386         pv2 = "";
5387         cur2 = 0;
5388     }
5389     else
5390         pv2 = SvPV(sv2, cur2);
5391
5392     /* do not utf8ize the comparands as a side-effect */
5393     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5394         if (SvUTF8(sv1)) {
5395             pv2 = (char*)bytes_to_utf8((U8*)pv2, &cur2);
5396             pv2tmp = TRUE;
5397         }
5398         else {
5399             pv1 = (char*)bytes_to_utf8((U8*)pv1, &cur1);
5400             pv1tmp = TRUE;
5401         }
5402     }
5403
5404     if (!cur1) {
5405         cmp = cur2 ? -1 : 0;
5406     } else if (!cur2) {
5407         cmp = 1;
5408     } else {
5409         I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
5410
5411         if (retval) {
5412             cmp = retval < 0 ? -1 : 1;
5413         } else if (cur1 == cur2) {
5414             cmp = 0;
5415         } else {
5416             cmp = cur1 < cur2 ? -1 : 1;
5417         }
5418     }
5419
5420     if (pv1tmp)
5421         Safefree(pv1);
5422     if (pv2tmp)
5423         Safefree(pv2);
5424
5425     return cmp;
5426 }
5427
5428 /*
5429 =for apidoc sv_cmp_locale
5430
5431 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5432 'use bytes' aware, handles get magic, and will coerce its args to strings
5433 if necessary.  See also C<sv_cmp_locale>.  See also C<sv_cmp>.
5434
5435 =cut
5436 */
5437
5438 I32
5439 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5440 {
5441 #ifdef USE_LOCALE_COLLATE
5442
5443     char *pv1, *pv2;
5444     STRLEN len1, len2;
5445     I32 retval;
5446
5447     if (PL_collation_standard)
5448         goto raw_compare;
5449
5450     len1 = 0;
5451     pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5452     len2 = 0;
5453     pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5454
5455     if (!pv1 || !len1) {
5456         if (pv2 && len2)
5457             return -1;
5458         else
5459             goto raw_compare;
5460     }
5461     else {
5462         if (!pv2 || !len2)
5463             return 1;
5464     }
5465
5466     retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5467
5468     if (retval)
5469         return retval < 0 ? -1 : 1;
5470
5471     /*
5472      * When the result of collation is equality, that doesn't mean
5473      * that there are no differences -- some locales exclude some
5474      * characters from consideration.  So to avoid false equalities,
5475      * we use the raw string as a tiebreaker.
5476      */
5477
5478   raw_compare:
5479     /* FALL THROUGH */
5480
5481 #endif /* USE_LOCALE_COLLATE */
5482
5483     return sv_cmp(sv1, sv2);
5484 }
5485
5486
5487 #ifdef USE_LOCALE_COLLATE
5488
5489 /*
5490 =for apidoc sv_collxfrm
5491
5492 Add Collate Transform magic to an SV if it doesn't already have it.
5493
5494 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5495 scalar data of the variable, but transformed to such a format that a normal
5496 memory comparison can be used to compare the data according to the locale
5497 settings.
5498
5499 =cut
5500 */
5501
5502 char *
5503 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5504 {
5505     MAGIC *mg;
5506
5507     mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5508     if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5509         char *s, *xf;
5510         STRLEN len, xlen;
5511
5512         if (mg)
5513             Safefree(mg->mg_ptr);
5514         s = SvPV(sv, len);
5515         if ((xf = mem_collxfrm(s, len, &xlen))) {
5516             if (SvREADONLY(sv)) {
5517                 SAVEFREEPV(xf);
5518                 *nxp = xlen;
5519                 return xf + sizeof(PL_collation_ix);
5520             }
5521             if (! mg) {
5522                 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5523                 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5524                 assert(mg);
5525             }
5526             mg->mg_ptr = xf;
5527             mg->mg_len = xlen;
5528         }
5529         else {
5530             if (mg) {
5531                 mg->mg_ptr = NULL;
5532                 mg->mg_len = -1;
5533             }
5534         }
5535     }
5536     if (mg && mg->mg_ptr) {
5537         *nxp = mg->mg_len;
5538         return mg->mg_ptr + sizeof(PL_collation_ix);
5539     }
5540     else {
5541         *nxp = 0;
5542         return NULL;
5543     }
5544 }
5545
5546 #endif /* USE_LOCALE_COLLATE */
5547
5548 /*
5549 =for apidoc sv_gets
5550
5551 Get a line from the filehandle and store it into the SV, optionally
5552 appending to the currently-stored string.
5553
5554 =cut
5555 */
5556
5557 char *
5558 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5559 {
5560     char *rsptr;
5561     STRLEN rslen;
5562     register STDCHAR rslast;
5563     register STDCHAR *bp;
5564     register I32 cnt;
5565     I32 i = 0;
5566     I32 rspara = 0;
5567
5568     SV_CHECK_THINKFIRST(sv);
5569     (void)SvUPGRADE(sv, SVt_PV);
5570
5571     SvSCREAM_off(sv);
5572
5573     if (PL_curcop == &PL_compiling) {
5574         /* we always read code in line mode */
5575         rsptr = "\n";
5576         rslen = 1;
5577     }
5578     else if (RsSNARF(PL_rs)) {
5579         rsptr = NULL;
5580         rslen = 0;
5581     }
5582     else if (RsRECORD(PL_rs)) {
5583       I32 recsize, bytesread;
5584       char *buffer;
5585
5586       /* Grab the size of the record we're getting */
5587       recsize = SvIV(SvRV(PL_rs));
5588       (void)SvPOK_only(sv);    /* Validate pointer */
5589       buffer = SvGROW(sv, recsize + 1);
5590       /* Go yank in */
5591 #ifdef VMS
5592       /* VMS wants read instead of fread, because fread doesn't respect */
5593       /* RMS record boundaries. This is not necessarily a good thing to be */
5594       /* doing, but we've got no other real choice */
5595       bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5596 #else
5597       bytesread = PerlIO_read(fp, buffer, recsize);
5598 #endif
5599       SvCUR_set(sv, bytesread);
5600       buffer[bytesread] = '\0';
5601       if (PerlIO_isutf8(fp))
5602         SvUTF8_on(sv);
5603       else
5604         SvUTF8_off(sv);
5605       return(SvCUR(sv) ? SvPVX(sv) : Nullch);
5606     }
5607     else if (RsPARA(PL_rs)) {
5608         rsptr = "\n\n";
5609         rslen = 2;
5610         rspara = 1;
5611     }
5612     else {
5613         /* Get $/ i.e. PL_rs into same encoding as stream wants */
5614         if (PerlIO_isutf8(fp)) {
5615             rsptr = SvPVutf8(PL_rs, rslen);
5616         }
5617         else {
5618             if (SvUTF8(PL_rs)) {
5619                 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5620                     Perl_croak(aTHX_ "Wide character in $/");
5621                 }
5622             }
5623             rsptr = SvPV(PL_rs, rslen);
5624         }
5625     }
5626
5627     rslast = rslen ? rsptr[rslen - 1] : '\0';
5628
5629     if (rspara) {               /* have to do this both before and after */
5630         do {                    /* to make sure file boundaries work right */
5631             if (PerlIO_eof(fp))
5632                 return 0;
5633             i = PerlIO_getc(fp);
5634             if (i != '\n') {
5635                 if (i == -1)
5636                     return 0;
5637                 PerlIO_ungetc(fp,i);
5638                 break;
5639             }
5640         } while (i != EOF);
5641     }
5642
5643     /* See if we know enough about I/O mechanism to cheat it ! */
5644
5645     /* This used to be #ifdef test - it is made run-time test for ease
5646        of abstracting out stdio interface. One call should be cheap
5647        enough here - and may even be a macro allowing compile
5648        time optimization.
5649      */
5650
5651     if (PerlIO_fast_gets(fp)) {
5652
5653     /*
5654      * We're going to steal some values from the stdio struct
5655      * and put EVERYTHING in the innermost loop into registers.
5656      */
5657     register STDCHAR *ptr;
5658     STRLEN bpx;
5659     I32 shortbuffered;
5660
5661 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5662     /* An ungetc()d char is handled separately from the regular
5663      * buffer, so we getc() it back out and stuff it in the buffer.
5664      */
5665     i = PerlIO_getc(fp);
5666     if (i == EOF) return 0;
5667     *(--((*fp)->_ptr)) = (unsigned char) i;
5668     (*fp)->_cnt++;
5669 #endif
5670
5671     /* Here is some breathtakingly efficient cheating */
5672
5673     cnt = PerlIO_get_cnt(fp);                   /* get count into register */
5674     (void)SvPOK_only(sv);               /* validate pointer */
5675     if (SvLEN(sv) - append <= cnt + 1) { /* make sure we have the room */
5676         if (cnt > 80 && SvLEN(sv) > append) {
5677             shortbuffered = cnt - SvLEN(sv) + append + 1;
5678             cnt -= shortbuffered;
5679         }
5680         else {
5681             shortbuffered = 0;
5682             /* remember that cnt can be negative */
5683             SvGROW(sv, append + (cnt <= 0 ? 2 : (cnt + 1)));
5684         }
5685     }
5686     else
5687         shortbuffered = 0;
5688     bp = (STDCHAR*)SvPVX(sv) + append;  /* move these two too to registers */
5689     ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5690     DEBUG_P(PerlIO_printf(Perl_debug_log,
5691         "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5692     DEBUG_P(PerlIO_printf(Perl_debug_log,
5693         "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5694                PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5695                PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5696     for (;;) {
5697       screamer:
5698         if (cnt > 0) {
5699             if (rslen) {
5700                 while (cnt > 0) {                    /* this     |  eat */
5701                     cnt--;
5702                     if ((*bp++ = *ptr++) == rslast)  /* really   |  dust */
5703                         goto thats_all_folks;        /* screams  |  sed :-) */
5704                 }
5705             }
5706             else {
5707                 Copy(ptr, bp, cnt, char);            /* this     |  eat */
5708                 bp += cnt;                           /* screams  |  dust */
5709                 ptr += cnt;                          /* louder   |  sed :-) */
5710                 cnt = 0;
5711             }
5712         }
5713
5714         if (shortbuffered) {            /* oh well, must extend */
5715             cnt = shortbuffered;
5716             shortbuffered = 0;
5717             bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
5718             SvCUR_set(sv, bpx);
5719             SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5720             bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
5721             continue;
5722         }
5723
5724         DEBUG_P(PerlIO_printf(Perl_debug_log,
5725                               "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5726                               PTR2UV(ptr),(long)cnt));
5727         PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5728 #if 0
5729         DEBUG_P(PerlIO_printf(Perl_debug_log,
5730             "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5731             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5732             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5733 #endif
5734         /* This used to call 'filbuf' in stdio form, but as that behaves like
5735            getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5736            another abstraction.  */
5737         i   = PerlIO_getc(fp);          /* get more characters */
5738 #if 0
5739         DEBUG_P(PerlIO_printf(Perl_debug_log,
5740             "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5741             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5742             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5743 #endif
5744         cnt = PerlIO_get_cnt(fp);
5745         ptr = (STDCHAR*)PerlIO_get_ptr(fp);     /* reregisterize cnt and ptr */
5746         DEBUG_P(PerlIO_printf(Perl_debug_log,
5747             "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5748
5749         if (i == EOF)                   /* all done for ever? */
5750             goto thats_really_all_folks;
5751
5752         bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
5753         SvCUR_set(sv, bpx);
5754         SvGROW(sv, bpx + cnt + 2);
5755         bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
5756
5757         *bp++ = i;                      /* store character from PerlIO_getc */
5758
5759         if (rslen && (STDCHAR)i == rslast)  /* all done for now? */
5760             goto thats_all_folks;
5761     }
5762
5763 thats_all_folks:
5764     if ((rslen > 1 && (bp - (STDCHAR*)SvPVX(sv) < rslen)) ||
5765           memNE((char*)bp - rslen, rsptr, rslen))
5766         goto screamer;                          /* go back to the fray */
5767 thats_really_all_folks:
5768     if (shortbuffered)
5769         cnt += shortbuffered;
5770         DEBUG_P(PerlIO_printf(Perl_debug_log,
5771             "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5772     PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt);  /* put these back or we're in trouble */
5773     DEBUG_P(PerlIO_printf(Perl_debug_log,
5774         "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5775         PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5776         PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5777     *bp = '\0';
5778     SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv));    /* set length */
5779     DEBUG_P(PerlIO_printf(Perl_debug_log,
5780         "Screamer: done, len=%ld, string=|%.*s|\n",
5781         (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
5782     }
5783    else
5784     {
5785 #ifndef EPOC
5786        /*The big, slow, and stupid way */
5787         STDCHAR buf[8192];
5788 #else
5789         /* Need to work around EPOC SDK features          */
5790         /* On WINS: MS VC5 generates calls to _chkstk,    */
5791         /* if a `large' stack frame is allocated          */
5792         /* gcc on MARM does not generate calls like these */
5793         STDCHAR buf[1024];
5794 #endif
5795
5796 screamer2:
5797         if (rslen) {
5798             register STDCHAR *bpe = buf + sizeof(buf);
5799             bp = buf;
5800             while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = i) != rslast && bp < bpe)
5801                 ; /* keep reading */
5802             cnt = bp - buf;
5803         }
5804         else {
5805             cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5806             /* Accomodate broken VAXC compiler, which applies U8 cast to
5807              * both args of ?: operator, causing EOF to change into 255
5808              */
5809             if (cnt) { i = (U8)buf[cnt - 1]; } else { i = EOF; }
5810         }
5811
5812         if (append)
5813             sv_catpvn(sv, (char *) buf, cnt);
5814         else
5815             sv_setpvn(sv, (char *) buf, cnt);
5816
5817         if (i != EOF &&                 /* joy */
5818             (!rslen ||
5819              SvCUR(sv) < rslen ||
5820              memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5821         {
5822             append = -1;
5823             /*
5824              * If we're reading from a TTY and we get a short read,
5825              * indicating that the user hit his EOF character, we need
5826              * to notice it now, because if we try to read from the TTY
5827              * again, the EOF condition will disappear.
5828              *
5829              * The comparison of cnt to sizeof(buf) is an optimization
5830              * that prevents unnecessary calls to feof().
5831              *
5832              * - jik 9/25/96
5833              */
5834             if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5835                 goto screamer2;
5836         }
5837     }
5838
5839     if (rspara) {               /* have to do this both before and after */
5840         while (i != EOF) {      /* to make sure file boundaries work right */
5841             i = PerlIO_getc(fp);
5842             if (i != '\n') {
5843                 PerlIO_ungetc(fp,i);
5844                 break;
5845             }
5846         }
5847     }
5848
5849     if (PerlIO_isutf8(fp))
5850         SvUTF8_on(sv);
5851     else
5852         SvUTF8_off(sv);
5853
5854     return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5855 }
5856
5857 /*
5858 =for apidoc sv_inc
5859
5860 Auto-increment of the value in the SV, doing string to numeric conversion
5861 if necessary. Handles 'get' magic.
5862
5863 =cut
5864 */
5865
5866 void
5867 Perl_sv_inc(pTHX_ register SV *sv)
5868 {
5869     register char *d;
5870     int flags;
5871
5872     if (!sv)
5873         return;
5874     if (SvGMAGICAL(sv))
5875         mg_get(sv);
5876     if (SvTHINKFIRST(sv)) {
5877         if (SvREADONLY(sv) && SvFAKE(sv))
5878             sv_force_normal(sv);
5879         if (SvREADONLY(sv)) {
5880             if (PL_curcop != &PL_compiling)
5881                 Perl_croak(aTHX_ PL_no_modify);
5882         }
5883         if (SvROK(sv)) {
5884             IV i;
5885             if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5886                 return;
5887             i = PTR2IV(SvRV(sv));
5888             sv_unref(sv);
5889             sv_setiv(sv, i);
5890         }
5891     }
5892     flags = SvFLAGS(sv);
5893     if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5894         /* It's (privately or publicly) a float, but not tested as an
5895            integer, so test it to see. */
5896         (void) SvIV(sv);
5897         flags = SvFLAGS(sv);
5898     }
5899     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5900         /* It's publicly an integer, or privately an integer-not-float */
5901 #ifdef PERL_PRESERVE_IVUV
5902       oops_its_int:
5903 #endif
5904         if (SvIsUV(sv)) {
5905             if (SvUVX(sv) == UV_MAX)
5906                 sv_setnv(sv, UV_MAX_P1);
5907             else
5908                 (void)SvIOK_only_UV(sv);
5909                 ++SvUVX(sv);
5910         } else {
5911             if (SvIVX(sv) == IV_MAX)
5912                 sv_setuv(sv, (UV)IV_MAX + 1);
5913             else {
5914                 (void)SvIOK_only(sv);
5915                 ++SvIVX(sv);
5916             }
5917         }
5918         return;
5919     }
5920     if (flags & SVp_NOK) {
5921         (void)SvNOK_only(sv);
5922         SvNVX(sv) += 1.0;
5923         return;
5924     }
5925
5926     if (!(flags & SVp_POK) || !*SvPVX(sv)) {
5927         if ((flags & SVTYPEMASK) < SVt_PVIV)
5928             sv_upgrade(sv, SVt_IV);
5929         (void)SvIOK_only(sv);
5930         SvIVX(sv) = 1;
5931         return;
5932     }
5933     d = SvPVX(sv);
5934     while (isALPHA(*d)) d++;
5935     while (isDIGIT(*d)) d++;
5936     if (*d) {
5937 #ifdef PERL_PRESERVE_IVUV
5938         /* Got to punt this as an integer if needs be, but we don't issue
5939            warnings. Probably ought to make the sv_iv_please() that does
5940            the conversion if possible, and silently.  */
5941         int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
5942         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
5943             /* Need to try really hard to see if it's an integer.
5944                9.22337203685478e+18 is an integer.
5945                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
5946                so $a="9.22337203685478e+18"; $a+0; $a++
5947                needs to be the same as $a="9.22337203685478e+18"; $a++
5948                or we go insane. */
5949
5950             (void) sv_2iv(sv);
5951             if (SvIOK(sv))
5952                 goto oops_its_int;
5953
5954             /* sv_2iv *should* have made this an NV */
5955             if (flags & SVp_NOK) {
5956                 (void)SvNOK_only(sv);
5957                 SvNVX(sv) += 1.0;
5958                 return;
5959             }
5960             /* I don't think we can get here. Maybe I should assert this
5961                And if we do get here I suspect that sv_setnv will croak. NWC
5962                Fall through. */
5963 #if defined(USE_LONG_DOUBLE)
5964             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",
5965                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
5966 #else
5967             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
5968                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
5969 #endif
5970         }
5971 #endif /* PERL_PRESERVE_IVUV */
5972         sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
5973         return;
5974     }
5975     d--;
5976     while (d >= SvPVX(sv)) {
5977         if (isDIGIT(*d)) {
5978             if (++*d <= '9')
5979                 return;
5980             *(d--) = '0';
5981         }
5982         else {
5983 #ifdef EBCDIC
5984             /* MKS: The original code here died if letters weren't consecutive.
5985              * at least it didn't have to worry about non-C locales.  The
5986              * new code assumes that ('z'-'a')==('Z'-'A'), letters are
5987              * arranged in order (although not consecutively) and that only
5988              * [A-Za-z] are accepted by isALPHA in the C locale.
5989              */
5990             if (*d != 'z' && *d != 'Z') {
5991                 do { ++*d; } while (!isALPHA(*d));
5992                 return;
5993             }
5994             *(d--) -= 'z' - 'a';
5995 #else
5996             ++*d;
5997             if (isALPHA(*d))
5998                 return;
5999             *(d--) -= 'z' - 'a' + 1;
6000 #endif
6001         }
6002     }
6003     /* oh,oh, the number grew */
6004     SvGROW(sv, SvCUR(sv) + 2);
6005     SvCUR(sv)++;
6006     for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6007         *d = d[-1];
6008     if (isDIGIT(d[1]))
6009         *d = '1';
6010     else
6011         *d = d[1];
6012 }
6013
6014 /*
6015 =for apidoc sv_dec
6016
6017 Auto-decrement of the value in the SV, doing string to numeric conversion
6018 if necessary. Handles 'get' magic.
6019
6020 =cut
6021 */
6022
6023 void
6024 Perl_sv_dec(pTHX_ register SV *sv)
6025 {
6026     int flags;
6027
6028     if (!sv)
6029         return;
6030     if (SvGMAGICAL(sv))
6031         mg_get(sv);
6032     if (SvTHINKFIRST(sv)) {
6033         if (SvREADONLY(sv) && SvFAKE(sv))
6034             sv_force_normal(sv);
6035         if (SvREADONLY(sv)) {
6036             if (PL_curcop != &PL_compiling)
6037                 Perl_croak(aTHX_ PL_no_modify);
6038         }
6039         if (SvROK(sv)) {
6040             IV i;
6041             if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6042                 return;
6043             i = PTR2IV(SvRV(sv));
6044             sv_unref(sv);
6045             sv_setiv(sv, i);
6046         }
6047     }
6048     /* Unlike sv_inc we don't have to worry about string-never-numbers
6049        and keeping them magic. But we mustn't warn on punting */
6050     flags = SvFLAGS(sv);
6051     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6052         /* It's publicly an integer, or privately an integer-not-float */
6053 #ifdef PERL_PRESERVE_IVUV
6054       oops_its_int:
6055 #endif
6056         if (SvIsUV(sv)) {
6057             if (SvUVX(sv) == 0) {
6058                 (void)SvIOK_only(sv);
6059                 SvIVX(sv) = -1;
6060             }
6061             else {
6062                 (void)SvIOK_only_UV(sv);
6063                 --SvUVX(sv);
6064             }
6065         } else {
6066             if (SvIVX(sv) == IV_MIN)
6067                 sv_setnv(sv, (NV)IV_MIN - 1.0);
6068             else {
6069                 (void)SvIOK_only(sv);
6070                 --SvIVX(sv);
6071             }
6072         }
6073         return;
6074     }
6075     if (flags & SVp_NOK) {
6076         SvNVX(sv) -= 1.0;
6077         (void)SvNOK_only(sv);
6078         return;
6079     }
6080     if (!(flags & SVp_POK)) {
6081         if ((flags & SVTYPEMASK) < SVt_PVNV)
6082             sv_upgrade(sv, SVt_NV);
6083         SvNVX(sv) = -1.0;
6084         (void)SvNOK_only(sv);
6085         return;
6086     }
6087 #ifdef PERL_PRESERVE_IVUV
6088     {
6089         int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6090         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6091             /* Need to try really hard to see if it's an integer.
6092                9.22337203685478e+18 is an integer.
6093                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6094                so $a="9.22337203685478e+18"; $a+0; $a--
6095                needs to be the same as $a="9.22337203685478e+18"; $a--
6096                or we go insane. */
6097
6098             (void) sv_2iv(sv);
6099             if (SvIOK(sv))
6100                 goto oops_its_int;
6101
6102             /* sv_2iv *should* have made this an NV */
6103             if (flags & SVp_NOK) {
6104                 (void)SvNOK_only(sv);
6105                 SvNVX(sv) -= 1.0;
6106                 return;
6107             }
6108             /* I don't think we can get here. Maybe I should assert this
6109                And if we do get here I suspect that sv_setnv will croak. NWC
6110                Fall through. */
6111 #if defined(USE_LONG_DOUBLE)
6112             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",
6113                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6114 #else
6115             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6116                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6117 #endif
6118         }
6119     }
6120 #endif /* PERL_PRESERVE_IVUV */
6121     sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6122 }
6123
6124 /*
6125 =for apidoc sv_mortalcopy
6126
6127 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6128 The new SV is marked as mortal. It will be destroyed "soon", either by an
6129 explicit call to FREETMPS, or by an implicit call at places such as
6130 statement boundaries.  See also C<sv_newmortal> and C<sv_2mortal>.
6131
6132 =cut
6133 */
6134
6135 /* Make a string that will exist for the duration of the expression
6136  * evaluation.  Actually, it may have to last longer than that, but
6137  * hopefully we won't free it until it has been assigned to a
6138  * permanent location. */
6139
6140 SV *
6141 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6142 {
6143     register SV *sv;
6144
6145     new_SV(sv);
6146     sv_setsv(sv,oldstr);
6147     EXTEND_MORTAL(1);
6148     PL_tmps_stack[++PL_tmps_ix] = sv;
6149     SvTEMP_on(sv);
6150     return sv;
6151 }
6152
6153 /*
6154 =for apidoc sv_newmortal
6155
6156 Creates a new null SV which is mortal.  The reference count of the SV is
6157 set to 1. It will be destroyed "soon", either by an explicit call to
6158 FREETMPS, or by an implicit call at places such as statement boundaries.
6159 See also C<sv_mortalcopy> and C<sv_2mortal>.
6160
6161 =cut
6162 */
6163
6164 SV *
6165 Perl_sv_newmortal(pTHX)
6166 {
6167     register SV *sv;
6168
6169     new_SV(sv);
6170     SvFLAGS(sv) = SVs_TEMP;
6171     EXTEND_MORTAL(1);
6172     PL_tmps_stack[++PL_tmps_ix] = sv;
6173     return sv;
6174 }
6175
6176 /*
6177 =for apidoc sv_2mortal
6178
6179 Marks an existing SV as mortal.  The SV will be destroyed "soon", either
6180 by an explicit call to FREETMPS, or by an implicit call at places such as
6181 statement boundaries.  See also C<sv_newmortal> and C<sv_mortalcopy>.
6182
6183 =cut
6184 */
6185
6186 SV *
6187 Perl_sv_2mortal(pTHX_ register SV *sv)
6188 {
6189     if (!sv)
6190         return sv;
6191     if (SvREADONLY(sv) && SvIMMORTAL(sv))
6192         return sv;
6193     EXTEND_MORTAL(1);
6194     PL_tmps_stack[++PL_tmps_ix] = sv;
6195     SvTEMP_on(sv);
6196     return sv;
6197 }
6198
6199 /*
6200 =for apidoc newSVpv
6201
6202 Creates a new SV and copies a string into it.  The reference count for the
6203 SV is set to 1.  If C<len> is zero, Perl will compute the length using
6204 strlen().  For efficiency, consider using C<newSVpvn> instead.
6205
6206 =cut
6207 */
6208
6209 SV *
6210 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6211 {
6212     register SV *sv;
6213
6214     new_SV(sv);
6215     if (!len)
6216         len = strlen(s);
6217     sv_setpvn(sv,s,len);
6218     return sv;
6219 }
6220
6221 /*
6222 =for apidoc newSVpvn
6223
6224 Creates a new SV and copies a string into it.  The reference count for the
6225 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
6226 string.  You are responsible for ensuring that the source string is at least
6227 C<len> bytes long.
6228
6229 =cut
6230 */
6231
6232 SV *
6233 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6234 {
6235     register SV *sv;
6236
6237     new_SV(sv);
6238     sv_setpvn(sv,s,len);
6239     return sv;
6240 }
6241
6242 /*
6243 =for apidoc newSVpvn_share
6244
6245 Creates a new SV with its SvPVX pointing to a shared string in the string
6246 table. If the string does not already exist in the table, it is created
6247 first.  Turns on READONLY and FAKE.  The string's hash is stored in the UV
6248 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6249 otherwise the hash is computed.  The idea here is that as the string table
6250 is used for shared hash keys these strings will have SvPVX == HeKEY and
6251 hash lookup will avoid string compare.
6252
6253 =cut
6254 */
6255
6256 SV *
6257 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6258 {
6259     register SV *sv;
6260     bool is_utf8 = FALSE;
6261     if (len < 0) {
6262         STRLEN tmplen = -len;
6263         is_utf8 = TRUE;
6264         /* See the note in hv.c:hv_fetch() --jhi */
6265         src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
6266         len = tmplen;
6267     }
6268     if (!hash)
6269         PERL_HASH(hash, src, len);
6270     new_SV(sv);
6271     sv_upgrade(sv, SVt_PVIV);
6272     SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
6273     SvCUR(sv) = len;
6274     SvUVX(sv) = hash;
6275     SvLEN(sv) = 0;
6276     SvREADONLY_on(sv);
6277     SvFAKE_on(sv);
6278     SvPOK_on(sv);
6279     if (is_utf8)
6280         SvUTF8_on(sv);
6281     return sv;
6282 }
6283
6284
6285 #if defined(PERL_IMPLICIT_CONTEXT)
6286
6287 /* pTHX_ magic can't cope with varargs, so this is a no-context
6288  * version of the main function, (which may itself be aliased to us).
6289  * Don't access this version directly.
6290  */
6291
6292 SV *
6293 Perl_newSVpvf_nocontext(const char* pat, ...)
6294 {
6295     dTHX;
6296     register SV *sv;
6297     va_list args;
6298     va_start(args, pat);
6299     sv = vnewSVpvf(pat, &args);
6300     va_end(args);
6301     return sv;
6302 }
6303 #endif
6304
6305 /*
6306 =for apidoc newSVpvf
6307
6308 Creates a new SV and initializes it with the string formatted like
6309 C<sprintf>.
6310
6311 =cut
6312 */
6313
6314 SV *
6315 Perl_newSVpvf(pTHX_ const char* pat, ...)
6316 {
6317     register SV *sv;
6318     va_list args;
6319     va_start(args, pat);
6320     sv = vnewSVpvf(pat, &args);
6321     va_end(args);
6322     return sv;
6323 }
6324
6325 /* backend for newSVpvf() and newSVpvf_nocontext() */
6326
6327 SV *
6328 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6329 {
6330     register SV *sv;
6331     new_SV(sv);
6332     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6333     return sv;
6334 }
6335
6336 /*
6337 =for apidoc newSVnv
6338
6339 Creates a new SV and copies a floating point value into it.
6340 The reference count for the SV is set to 1.
6341
6342 =cut
6343 */
6344
6345 SV *
6346 Perl_newSVnv(pTHX_ NV n)
6347 {
6348     register SV *sv;
6349
6350     new_SV(sv);
6351     sv_setnv(sv,n);
6352     return sv;
6353 }
6354
6355 /*
6356 =for apidoc newSViv
6357
6358 Creates a new SV and copies an integer into it.  The reference count for the
6359 SV is set to 1.
6360
6361 =cut
6362 */
6363
6364 SV *
6365 Perl_newSViv(pTHX_ IV i)
6366 {
6367     register SV *sv;
6368
6369     new_SV(sv);
6370     sv_setiv(sv,i);
6371     return sv;
6372 }
6373
6374 /*
6375 =for apidoc newSVuv
6376
6377 Creates a new SV and copies an unsigned integer into it.
6378 The reference count for the SV is set to 1.
6379
6380 =cut
6381 */
6382
6383 SV *
6384 Perl_newSVuv(pTHX_ UV u)
6385 {
6386     register SV *sv;
6387
6388     new_SV(sv);
6389     sv_setuv(sv,u);
6390     return sv;
6391 }
6392
6393 /*
6394 =for apidoc newRV_noinc
6395
6396 Creates an RV wrapper for an SV.  The reference count for the original
6397 SV is B<not> incremented.
6398
6399 =cut
6400 */
6401
6402 SV *
6403 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6404 {
6405     register SV *sv;
6406
6407     new_SV(sv);
6408     sv_upgrade(sv, SVt_RV);
6409     SvTEMP_off(tmpRef);
6410     SvRV(sv) = tmpRef;
6411     SvROK_on(sv);
6412     return sv;
6413 }
6414
6415 /* newRV_inc is the official function name to use now.
6416  * newRV_inc is in fact #defined to newRV in sv.h
6417  */
6418
6419 SV *
6420 Perl_newRV(pTHX_ SV *tmpRef)
6421 {
6422     return newRV_noinc(SvREFCNT_inc(tmpRef));
6423 }
6424
6425 /*
6426 =for apidoc newSVsv
6427
6428 Creates a new SV which is an exact duplicate of the original SV.
6429 (Uses C<sv_setsv>).
6430
6431 =cut
6432 */
6433
6434 SV *
6435 Perl_newSVsv(pTHX_ register SV *old)
6436 {
6437     register SV *sv;
6438
6439     if (!old)
6440         return Nullsv;
6441     if (SvTYPE(old) == SVTYPEMASK) {
6442         if (ckWARN_d(WARN_INTERNAL))
6443             Perl_warner(aTHX_ WARN_INTERNAL, "semi-panic: attempt to dup freed string");
6444         return Nullsv;
6445     }
6446     new_SV(sv);
6447     if (SvTEMP(old)) {
6448         SvTEMP_off(old);
6449         sv_setsv(sv,old);
6450         SvTEMP_on(old);
6451     }
6452     else
6453         sv_setsv(sv,old);
6454     return sv;
6455 }
6456
6457 /*
6458 =for apidoc sv_reset
6459
6460 Underlying implementation for the C<reset> Perl function.
6461 Note that the perl-level function is vaguely deprecated.
6462
6463 =cut
6464 */
6465
6466 void
6467 Perl_sv_reset(pTHX_ register char *s, HV *stash)
6468 {
6469     register HE *entry;
6470     register GV *gv;
6471     register SV *sv;
6472     register I32 i;
6473     register PMOP *pm;
6474     register I32 max;
6475     char todo[PERL_UCHAR_MAX+1];
6476
6477     if (!stash)
6478         return;
6479
6480     if (!*s) {          /* reset ?? searches */
6481         for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
6482             pm->op_pmdynflags &= ~PMdf_USED;
6483         }
6484         return;
6485     }
6486
6487     /* reset variables */
6488
6489     if (!HvARRAY(stash))
6490         return;
6491
6492     Zero(todo, 256, char);
6493     while (*s) {
6494         i = (unsigned char)*s;
6495         if (s[1] == '-') {
6496             s += 2;
6497         }
6498         max = (unsigned char)*s++;
6499         for ( ; i <= max; i++) {
6500             todo[i] = 1;
6501         }
6502         for (i = 0; i <= (I32) HvMAX(stash); i++) {
6503             for (entry = HvARRAY(stash)[i];
6504                  entry;
6505                  entry = HeNEXT(entry))
6506             {
6507                 if (!todo[(U8)*HeKEY(entry)])
6508                     continue;
6509                 gv = (GV*)HeVAL(entry);
6510                 sv = GvSV(gv);
6511                 if (SvTHINKFIRST(sv)) {
6512                     if (!SvREADONLY(sv) && SvROK(sv))
6513                         sv_unref(sv);
6514                     continue;
6515                 }
6516                 (void)SvOK_off(sv);
6517                 if (SvTYPE(sv) >= SVt_PV) {
6518                     SvCUR_set(sv, 0);
6519                     if (SvPVX(sv) != Nullch)
6520                         *SvPVX(sv) = '\0';
6521                     SvTAINT(sv);
6522                 }
6523                 if (GvAV(gv)) {
6524                     av_clear(GvAV(gv));
6525                 }
6526                 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
6527                     hv_clear(GvHV(gv));
6528 #ifdef USE_ENVIRON_ARRAY
6529                     if (gv == PL_envgv)
6530                         environ[0] = Nullch;
6531 #endif
6532                 }
6533             }
6534         }
6535     }
6536 }
6537
6538 /*
6539 =for apidoc sv_2io
6540
6541 Using various gambits, try to get an IO from an SV: the IO slot if its a
6542 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6543 named after the PV if we're a string.
6544
6545 =cut
6546 */
6547
6548 IO*
6549 Perl_sv_2io(pTHX_ SV *sv)
6550 {
6551     IO* io;
6552     GV* gv;
6553     STRLEN n_a;
6554
6555     switch (SvTYPE(sv)) {
6556     case SVt_PVIO:
6557         io = (IO*)sv;
6558         break;
6559     case SVt_PVGV:
6560         gv = (GV*)sv;
6561         io = GvIO(gv);
6562         if (!io)
6563             Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6564         break;
6565     default:
6566         if (!SvOK(sv))
6567             Perl_croak(aTHX_ PL_no_usym, "filehandle");
6568         if (SvROK(sv))
6569             return sv_2io(SvRV(sv));
6570         gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
6571         if (gv)
6572             io = GvIO(gv);
6573         else
6574             io = 0;
6575         if (!io)
6576             Perl_croak(aTHX_ "Bad filehandle: %s", SvPV(sv,n_a));
6577         break;
6578     }
6579     return io;
6580 }
6581
6582 /*
6583 =for apidoc sv_2cv
6584
6585 Using various gambits, try to get a CV from an SV; in addition, try if
6586 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6587
6588 =cut
6589 */
6590
6591 CV *
6592 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6593 {
6594     GV *gv;
6595     CV *cv;
6596     STRLEN n_a;
6597
6598     if (!sv)
6599         return *gvp = Nullgv, Nullcv;
6600     switch (SvTYPE(sv)) {
6601     case SVt_PVCV:
6602         *st = CvSTASH(sv);
6603         *gvp = Nullgv;
6604         return (CV*)sv;
6605     case SVt_PVHV:
6606     case SVt_PVAV:
6607         *gvp = Nullgv;
6608         return Nullcv;
6609     case SVt_PVGV:
6610         gv = (GV*)sv;
6611         *gvp = gv;
6612         *st = GvESTASH(gv);
6613         goto fix_gv;
6614
6615     default:
6616         if (SvGMAGICAL(sv))
6617             mg_get(sv);
6618         if (SvROK(sv)) {
6619             SV **sp = &sv;              /* Used in tryAMAGICunDEREF macro. */
6620             tryAMAGICunDEREF(to_cv);
6621
6622             sv = SvRV(sv);
6623             if (SvTYPE(sv) == SVt_PVCV) {
6624                 cv = (CV*)sv;
6625                 *gvp = Nullgv;
6626                 *st = CvSTASH(cv);
6627                 return cv;
6628             }
6629             else if(isGV(sv))
6630                 gv = (GV*)sv;
6631             else
6632                 Perl_croak(aTHX_ "Not a subroutine reference");
6633         }
6634         else if (isGV(sv))
6635             gv = (GV*)sv;
6636         else
6637             gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
6638         *gvp = gv;
6639         if (!gv)
6640             return Nullcv;
6641         *st = GvESTASH(gv);
6642     fix_gv:
6643         if (lref && !GvCVu(gv)) {
6644             SV *tmpsv;
6645             ENTER;
6646             tmpsv = NEWSV(704,0);
6647             gv_efullname3(tmpsv, gv, Nullch);
6648             /* XXX this is probably not what they think they're getting.
6649              * It has the same effect as "sub name;", i.e. just a forward
6650              * declaration! */
6651             newSUB(start_subparse(FALSE, 0),
6652                    newSVOP(OP_CONST, 0, tmpsv),
6653                    Nullop,
6654                    Nullop);
6655             LEAVE;
6656             if (!GvCVu(gv))
6657                 Perl_croak(aTHX_ "Unable to create sub named \"%s\"", SvPV(sv,n_a));
6658         }
6659         return GvCVu(gv);
6660     }
6661 }
6662
6663 /*
6664 =for apidoc sv_true
6665
6666 Returns true if the SV has a true value by Perl's rules.
6667 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6668 instead use an in-line version.
6669
6670 =cut
6671 */
6672
6673 I32
6674 Perl_sv_true(pTHX_ register SV *sv)
6675 {
6676     if (!sv)
6677         return 0;
6678     if (SvPOK(sv)) {
6679         register XPV* tXpv;
6680         if ((tXpv = (XPV*)SvANY(sv)) &&
6681                 (tXpv->xpv_cur > 1 ||
6682                 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
6683             return 1;
6684         else
6685             return 0;
6686     }
6687     else {
6688         if (SvIOK(sv))
6689             return SvIVX(sv) != 0;
6690         else {
6691             if (SvNOK(sv))
6692                 return SvNVX(sv) != 0.0;
6693             else
6694                 return sv_2bool(sv);
6695         }
6696     }
6697 }
6698
6699 /*
6700 =for apidoc sv_iv
6701
6702 A private implementation of the C<SvIVx> macro for compilers which can't
6703 cope with complex macro expressions. Always use the macro instead.
6704
6705 =cut
6706 */
6707
6708 IV
6709 Perl_sv_iv(pTHX_ register SV *sv)
6710 {
6711     if (SvIOK(sv)) {
6712         if (SvIsUV(sv))
6713             return (IV)SvUVX(sv);
6714         return SvIVX(sv);
6715     }
6716     return sv_2iv(sv);
6717 }
6718
6719 /*
6720 =for apidoc sv_uv
6721
6722 A private implementation of the C<SvUVx> macro for compilers which can't
6723 cope with complex macro expressions. Always use the macro instead.
6724
6725 =cut
6726 */
6727
6728 UV
6729 Perl_sv_uv(pTHX_ register SV *sv)
6730 {
6731     if (SvIOK(sv)) {
6732         if (SvIsUV(sv))
6733             return SvUVX(sv);
6734         return (UV)SvIVX(sv);
6735     }
6736     return sv_2uv(sv);
6737 }
6738
6739 /*
6740 =for apidoc sv_nv
6741
6742 A private implementation of the C<SvNVx> macro for compilers which can't
6743 cope with complex macro expressions. Always use the macro instead.
6744
6745 =cut
6746 */
6747
6748 NV
6749 Perl_sv_nv(pTHX_ register SV *sv)
6750 {
6751     if (SvNOK(sv))
6752         return SvNVX(sv);
6753     return sv_2nv(sv);
6754 }
6755
6756 /*
6757 =for apidoc sv_pv
6758
6759 A private implementation of the C<SvPV_nolen> macro for compilers which can't
6760 cope with complex macro expressions. Always use the macro instead.
6761
6762 =cut
6763 */
6764
6765 char *
6766 Perl_sv_pv(pTHX_ SV *sv)
6767 {
6768     STRLEN n_a;
6769
6770     if (SvPOK(sv))
6771         return SvPVX(sv);
6772
6773     return sv_2pv(sv, &n_a);
6774 }
6775
6776 /*
6777 =for apidoc sv_pvn
6778
6779 A private implementation of the C<SvPV> macro for compilers which can't
6780 cope with complex macro expressions. Always use the macro instead.
6781
6782 =cut
6783 */
6784
6785 char *
6786 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
6787 {
6788     if (SvPOK(sv)) {
6789         *lp = SvCUR(sv);
6790         return SvPVX(sv);
6791     }
6792     return sv_2pv(sv, lp);
6793 }
6794
6795 /* For -DCRIPPLED_CC only. See also C<sv_2pv_flags()>.
6796  */
6797
6798 char *
6799 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
6800 {
6801     if (SvPOK(sv)) {
6802         *lp = SvCUR(sv);
6803         return SvPVX(sv);
6804     }
6805     return sv_2pv_flags(sv, lp, 0);
6806 }
6807
6808 /*
6809 =for apidoc sv_pvn_force
6810
6811 Get a sensible string out of the SV somehow.
6812 A private implementation of the C<SvPV_force> macro for compilers which
6813 can't cope with complex macro expressions. Always use the macro instead.
6814
6815 =cut
6816 */
6817
6818 char *
6819 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
6820 {
6821     return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
6822 }
6823
6824 /*
6825 =for apidoc sv_pvn_force_flags
6826
6827 Get a sensible string out of the SV somehow.
6828 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6829 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6830 implemented in terms of this function.
6831 You normally want to use the various wrapper macros instead: see
6832 C<SvPV_force> and C<SvPV_force_nomg>
6833
6834 =cut
6835 */
6836
6837 char *
6838 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6839 {
6840     char *s;
6841
6842     if (SvTHINKFIRST(sv) && !SvROK(sv))
6843         sv_force_normal(sv);
6844
6845     if (SvPOK(sv)) {
6846         *lp = SvCUR(sv);
6847     }
6848     else {
6849         if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
6850             Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6851                 OP_NAME(PL_op));
6852         }
6853         else
6854             s = sv_2pv_flags(sv, lp, flags);
6855         if (s != SvPVX(sv)) {   /* Almost, but not quite, sv_setpvn() */
6856             STRLEN len = *lp;
6857
6858             if (SvROK(sv))
6859                 sv_unref(sv);
6860             (void)SvUPGRADE(sv, SVt_PV);                /* Never FALSE */
6861             SvGROW(sv, len + 1);
6862             Move(s,SvPVX(sv),len,char);
6863             SvCUR_set(sv, len);
6864             *SvEND(sv) = '\0';
6865         }
6866         if (!SvPOK(sv)) {
6867             SvPOK_on(sv);               /* validate pointer */
6868             SvTAINT(sv);
6869             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6870                                   PTR2UV(sv),SvPVX(sv)));
6871         }
6872     }
6873     return SvPVX(sv);
6874 }
6875
6876 /*
6877 =for apidoc sv_pvbyte
6878
6879 A private implementation of the C<SvPVbyte_nolen> macro for compilers
6880 which can't cope with complex macro expressions. Always use the macro
6881 instead.
6882
6883 =cut
6884 */
6885
6886 char *
6887 Perl_sv_pvbyte(pTHX_ SV *sv)
6888 {
6889     sv_utf8_downgrade(sv,0);
6890     return sv_pv(sv);
6891 }
6892
6893 /*
6894 =for apidoc sv_pvbyten
6895
6896 A private implementation of the C<SvPVbyte> macro for compilers
6897 which can't cope with complex macro expressions. Always use the macro
6898 instead.
6899
6900 =cut
6901 */
6902
6903 char *
6904 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
6905 {
6906     sv_utf8_downgrade(sv,0);
6907     return sv_pvn(sv,lp);
6908 }
6909
6910 /*
6911 =for apidoc sv_pvbyten_force
6912
6913 A private implementation of the C<SvPVbytex_force> macro for compilers
6914 which can't cope with complex macro expressions. Always use the macro
6915 instead.
6916
6917 =cut
6918 */
6919
6920 char *
6921 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6922 {
6923     sv_utf8_downgrade(sv,0);
6924     return sv_pvn_force(sv,lp);
6925 }
6926
6927 /*
6928 =for apidoc sv_pvutf8
6929
6930 A private implementation of the C<SvPVutf8_nolen> macro for compilers
6931 which can't cope with complex macro expressions. Always use the macro
6932 instead.
6933
6934 =cut
6935 */
6936
6937 char *
6938 Perl_sv_pvutf8(pTHX_ SV *sv)
6939 {
6940     sv_utf8_upgrade(sv);
6941     return sv_pv(sv);
6942 }
6943
6944 /*
6945 =for apidoc sv_pvutf8n
6946
6947 A private implementation of the C<SvPVutf8> macro for compilers
6948 which can't cope with complex macro expressions. Always use the macro
6949 instead.
6950
6951 =cut
6952 */
6953
6954 char *
6955 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
6956 {
6957     sv_utf8_upgrade(sv);
6958     return sv_pvn(sv,lp);
6959 }
6960
6961 /*
6962 =for apidoc sv_pvutf8n_force
6963
6964 A private implementation of the C<SvPVutf8_force> macro for compilers
6965 which can't cope with complex macro expressions. Always use the macro
6966 instead.
6967
6968 =cut
6969 */
6970
6971 char *
6972 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6973 {
6974     sv_utf8_upgrade(sv);
6975     return sv_pvn_force(sv,lp);
6976 }
6977
6978 /*
6979 =for apidoc sv_reftype
6980
6981 Returns a string describing what the SV is a reference to.
6982
6983 =cut
6984 */
6985
6986 char *
6987 Perl_sv_reftype(pTHX_ SV *sv, int ob)
6988 {
6989     if (ob && SvOBJECT(sv)) {
6990         HV *svs = SvSTASH(sv);
6991         /* [20011101.072] This bandaid for C<package;> should eventually
6992            be removed. AMS 20011103 */
6993         return (svs ? HvNAME(svs) : "<none>");
6994     }
6995     else {
6996         switch (SvTYPE(sv)) {
6997         case SVt_NULL:
6998         case SVt_IV:
6999         case SVt_NV:
7000         case SVt_RV:
7001         case SVt_PV:
7002         case SVt_PVIV:
7003         case SVt_PVNV:
7004         case SVt_PVMG:
7005         case SVt_PVBM:
7006                                 if (SvROK(sv))
7007                                     return "REF";
7008                                 else
7009                                     return "SCALAR";
7010         case SVt_PVLV:          return "LVALUE";
7011         case SVt_PVAV:          return "ARRAY";
7012         case SVt_PVHV:          return "HASH";
7013         case SVt_PVCV:          return "CODE";
7014         case SVt_PVGV:          return "GLOB";
7015         case SVt_PVFM:          return "FORMAT";
7016         case SVt_PVIO:          return "IO";
7017         default:                return "UNKNOWN";
7018         }
7019     }
7020 }
7021
7022 /*
7023 =for apidoc sv_isobject
7024
7025 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7026 object.  If the SV is not an RV, or if the object is not blessed, then this
7027 will return false.
7028
7029 =cut
7030 */
7031
7032 int
7033 Perl_sv_isobject(pTHX_ SV *sv)
7034 {
7035     if (!sv)
7036         return 0;
7037     if (SvGMAGICAL(sv))
7038         mg_get(sv);
7039     if (!SvROK(sv))
7040         return 0;
7041     sv = (SV*)SvRV(sv);
7042     if (!SvOBJECT(sv))
7043         return 0;
7044     return 1;
7045 }
7046
7047 /*
7048 =for apidoc sv_isa
7049
7050 Returns a boolean indicating whether the SV is blessed into the specified
7051 class.  This does not check for subtypes; use C<sv_derived_from> to verify
7052 an inheritance relationship.
7053
7054 =cut
7055 */
7056
7057 int
7058 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7059 {
7060     if (!sv)
7061         return 0;
7062     if (SvGMAGICAL(sv))
7063         mg_get(sv);
7064     if (!SvROK(sv))
7065         return 0;
7066     sv = (SV*)SvRV(sv);
7067     if (!SvOBJECT(sv))
7068         return 0;
7069
7070     return strEQ(HvNAME(SvSTASH(sv)), name);
7071 }
7072
7073 /*
7074 =for apidoc newSVrv
7075
7076 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
7077 it will be upgraded to one.  If C<classname> is non-null then the new SV will
7078 be blessed in the specified package.  The new SV is returned and its
7079 reference count is 1.
7080
7081 =cut
7082 */
7083
7084 SV*
7085 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7086 {
7087     SV *sv;
7088
7089     new_SV(sv);
7090
7091     SV_CHECK_THINKFIRST(rv);
7092     SvAMAGIC_off(rv);
7093
7094     if (SvTYPE(rv) >= SVt_PVMG) {
7095         U32 refcnt = SvREFCNT(rv);
7096         SvREFCNT(rv) = 0;
7097         sv_clear(rv);
7098         SvFLAGS(rv) = 0;
7099         SvREFCNT(rv) = refcnt;
7100     }
7101
7102     if (SvTYPE(rv) < SVt_RV)
7103         sv_upgrade(rv, SVt_RV);
7104     else if (SvTYPE(rv) > SVt_RV) {
7105         (void)SvOOK_off(rv);
7106         if (SvPVX(rv) && SvLEN(rv))
7107             Safefree(SvPVX(rv));
7108         SvCUR_set(rv, 0);
7109         SvLEN_set(rv, 0);
7110     }
7111
7112     (void)SvOK_off(rv);
7113     SvRV(rv) = sv;
7114     SvROK_on(rv);
7115
7116     if (classname) {
7117         HV* stash = gv_stashpv(classname, TRUE);
7118         (void)sv_bless(rv, stash);
7119     }
7120     return sv;
7121 }
7122
7123 /*
7124 =for apidoc sv_setref_pv
7125
7126 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
7127 argument will be upgraded to an RV.  That RV will be modified to point to
7128 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7129 into the SV.  The C<classname> argument indicates the package for the
7130 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7131 will be returned and will have a reference count of 1.
7132
7133 Do not use with other Perl types such as HV, AV, SV, CV, because those
7134 objects will become corrupted by the pointer copy process.
7135
7136 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7137
7138 =cut
7139 */
7140
7141 SV*
7142 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7143 {
7144     if (!pv) {
7145         sv_setsv(rv, &PL_sv_undef);
7146         SvSETMAGIC(rv);
7147     }
7148     else
7149         sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7150     return rv;
7151 }
7152
7153 /*
7154 =for apidoc sv_setref_iv
7155
7156 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
7157 argument will be upgraded to an RV.  That RV will be modified to point to
7158 the new SV.  The C<classname> argument indicates the package for the
7159 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7160 will be returned and will have a reference count of 1.
7161
7162 =cut
7163 */
7164
7165 SV*
7166 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7167 {
7168     sv_setiv(newSVrv(rv,classname), iv);
7169     return rv;
7170 }
7171
7172 /*
7173 =for apidoc sv_setref_uv
7174
7175 Copies an unsigned integer into a new SV, optionally blessing the SV.  The C<rv>
7176 argument will be upgraded to an RV.  That RV will be modified to point to
7177 the new SV.  The C<classname> argument indicates the package for the
7178 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7179 will be returned and will have a reference count of 1.
7180
7181 =cut
7182 */
7183
7184 SV*
7185 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7186 {
7187     sv_setuv(newSVrv(rv,classname), uv);
7188     return rv;
7189 }
7190
7191 /*
7192 =for apidoc sv_setref_nv
7193
7194 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
7195 argument will be upgraded to an RV.  That RV will be modified to point to
7196 the new SV.  The C<classname> argument indicates the package for the
7197 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7198 will be returned and will have a reference count of 1.
7199
7200 =cut
7201 */
7202
7203 SV*
7204 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7205 {
7206     sv_setnv(newSVrv(rv,classname), nv);
7207     return rv;
7208 }
7209
7210 /*
7211 =for apidoc sv_setref_pvn
7212
7213 Copies a string into a new SV, optionally blessing the SV.  The length of the
7214 string must be specified with C<n>.  The C<rv> argument will be upgraded to
7215 an RV.  That RV will be modified to point to the new SV.  The C<classname>
7216 argument indicates the package for the blessing.  Set C<classname> to
7217 C<Nullch> to avoid the blessing.  The new SV will be returned and will have
7218 a reference count of 1.
7219
7220 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7221
7222 =cut
7223 */
7224
7225 SV*
7226 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
7227 {
7228     sv_setpvn(newSVrv(rv,classname), pv, n);
7229     return rv;
7230 }
7231
7232 /*
7233 =for apidoc sv_bless
7234
7235 Blesses an SV into a specified package.  The SV must be an RV.  The package
7236 must be designated by its stash (see C<gv_stashpv()>).  The reference count
7237 of the SV is unaffected.
7238
7239 =cut
7240 */
7241
7242 SV*
7243 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7244 {
7245     SV *tmpRef;
7246     if (!SvROK(sv))
7247         Perl_croak(aTHX_ "Can't bless non-reference value");
7248     tmpRef = SvRV(sv);
7249     if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7250         if (SvREADONLY(tmpRef))
7251             Perl_croak(aTHX_ PL_no_modify);
7252         if (SvOBJECT(tmpRef)) {
7253             if (SvTYPE(tmpRef) != SVt_PVIO)
7254                 --PL_sv_objcount;
7255             SvREFCNT_dec(SvSTASH(tmpRef));
7256         }
7257     }
7258     SvOBJECT_on(tmpRef);
7259     if (SvTYPE(tmpRef) != SVt_PVIO)
7260         ++PL_sv_objcount;
7261     (void)SvUPGRADE(tmpRef, SVt_PVMG);
7262     SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
7263
7264     if (Gv_AMG(stash))
7265         SvAMAGIC_on(sv);
7266     else
7267         SvAMAGIC_off(sv);
7268
7269     if(SvSMAGICAL(tmpRef))
7270         if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7271             mg_set(tmpRef);
7272
7273
7274
7275     return sv;
7276 }
7277
7278 /* Downgrades a PVGV to a PVMG.
7279  *
7280  * XXX This function doesn't actually appear to be used anywhere
7281  * DAPM 15-Jun-01
7282  */
7283
7284 STATIC void
7285 S_sv_unglob(pTHX_ SV *sv)
7286 {
7287     void *xpvmg;
7288
7289     assert(SvTYPE(sv) == SVt_PVGV);
7290     SvFAKE_off(sv);
7291     if (GvGP(sv))
7292         gp_free((GV*)sv);
7293     if (GvSTASH(sv)) {
7294         SvREFCNT_dec(GvSTASH(sv));
7295         GvSTASH(sv) = Nullhv;
7296     }
7297     sv_unmagic(sv, PERL_MAGIC_glob);
7298     Safefree(GvNAME(sv));
7299     GvMULTI_off(sv);
7300
7301     /* need to keep SvANY(sv) in the right arena */
7302     xpvmg = new_XPVMG();
7303     StructCopy(SvANY(sv), xpvmg, XPVMG);
7304     del_XPVGV(SvANY(sv));
7305     SvANY(sv) = xpvmg;
7306
7307     SvFLAGS(sv) &= ~SVTYPEMASK;
7308     SvFLAGS(sv) |= SVt_PVMG;
7309 }
7310
7311 /*
7312 =for apidoc sv_unref_flags
7313
7314 Unsets the RV status of the SV, and decrements the reference count of
7315 whatever was being referenced by the RV.  This can almost be thought of
7316 as a reversal of C<newSVrv>.  The C<cflags> argument can contain
7317 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7318 (otherwise the decrementing is conditional on the reference count being
7319 different from one or the reference being a readonly SV).
7320 See C<SvROK_off>.
7321
7322 =cut
7323 */
7324
7325 void
7326 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
7327 {
7328     SV* rv = SvRV(sv);
7329
7330     if (SvWEAKREF(sv)) {
7331         sv_del_backref(sv);
7332         SvWEAKREF_off(sv);
7333         SvRV(sv) = 0;
7334         return;
7335     }
7336     SvRV(sv) = 0;
7337     SvROK_off(sv);
7338     if (SvREFCNT(rv) != 1 || SvREADONLY(rv) || flags) /* SV_IMMEDIATE_UNREF */
7339         SvREFCNT_dec(rv);
7340     else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7341         sv_2mortal(rv);         /* Schedule for freeing later */
7342 }
7343
7344 /*
7345 =for apidoc sv_unref
7346
7347 Unsets the RV status of the SV, and decrements the reference count of
7348 whatever was being referenced by the RV.  This can almost be thought of
7349 as a reversal of C<newSVrv>.  This is C<sv_unref_flags> with the C<flag>
7350 being zero.  See C<SvROK_off>.
7351
7352 =cut
7353 */
7354
7355 void
7356 Perl_sv_unref(pTHX_ SV *sv)
7357 {
7358     sv_unref_flags(sv, 0);
7359 }
7360
7361 /*
7362 =for apidoc sv_taint
7363
7364 Taint an SV. Use C<SvTAINTED_on> instead.
7365 =cut
7366 */
7367
7368 void
7369 Perl_sv_taint(pTHX_ SV *sv)
7370 {
7371     sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
7372 }
7373
7374 /*
7375 =for apidoc sv_untaint
7376
7377 Untaint an SV. Use C<SvTAINTED_off> instead.
7378 =cut
7379 */
7380
7381 void
7382 Perl_sv_untaint(pTHX_ SV *sv)
7383 {
7384     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7385         MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7386         if (mg)
7387             mg->mg_len &= ~1;
7388     }
7389 }
7390
7391 /*
7392 =for apidoc sv_tainted
7393
7394 Test an SV for taintedness. Use C<SvTAINTED> instead.
7395 =cut
7396 */
7397
7398 bool
7399 Perl_sv_tainted(pTHX_ SV *sv)
7400 {
7401     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7402         MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
7403         if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
7404             return TRUE;
7405     }
7406     return FALSE;
7407 }
7408
7409 /*
7410 =for apidoc sv_setpviv
7411
7412 Copies an integer into the given SV, also updating its string value.
7413 Does not handle 'set' magic.  See C<sv_setpviv_mg>.
7414
7415 =cut
7416 */
7417
7418 void
7419 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7420 {
7421     char buf[TYPE_CHARS(UV)];
7422     char *ebuf;
7423     char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7424
7425     sv_setpvn(sv, ptr, ebuf - ptr);
7426 }
7427
7428 /*
7429 =for apidoc sv_setpviv_mg
7430
7431 Like C<sv_setpviv>, but also handles 'set' magic.
7432
7433 =cut
7434 */
7435
7436 void
7437 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7438 {
7439     char buf[TYPE_CHARS(UV)];
7440     char *ebuf;
7441     char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7442
7443     sv_setpvn(sv, ptr, ebuf - ptr);
7444     SvSETMAGIC(sv);
7445 }
7446
7447 #if defined(PERL_IMPLICIT_CONTEXT)
7448
7449 /* pTHX_ magic can't cope with varargs, so this is a no-context
7450  * version of the main function, (which may itself be aliased to us).
7451  * Don't access this version directly.
7452  */
7453
7454 void
7455 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7456 {
7457     dTHX;
7458     va_list args;
7459     va_start(args, pat);
7460     sv_vsetpvf(sv, pat, &args);
7461     va_end(args);
7462 }
7463
7464 /* pTHX_ magic can't cope with varargs, so this is a no-context
7465  * version of the main function, (which may itself be aliased to us).
7466  * Don't access this version directly.
7467  */
7468
7469 void
7470 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7471 {
7472     dTHX;
7473     va_list args;
7474     va_start(args, pat);
7475     sv_vsetpvf_mg(sv, pat, &args);
7476     va_end(args);
7477 }
7478 #endif
7479
7480 /*
7481 =for apidoc sv_setpvf
7482
7483 Processes its arguments like C<sprintf> and sets an SV to the formatted
7484 output.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
7485
7486 =cut
7487 */
7488
7489 void
7490 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7491 {
7492     va_list args;
7493     va_start(args, pat);
7494     sv_vsetpvf(sv, pat, &args);
7495     va_end(args);
7496 }
7497
7498 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
7499
7500 void
7501 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7502 {
7503     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7504 }
7505
7506 /*
7507 =for apidoc sv_setpvf_mg
7508
7509 Like C<sv_setpvf>, but also handles 'set' magic.
7510
7511 =cut
7512 */
7513
7514 void
7515 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7516 {
7517     va_list args;
7518     va_start(args, pat);
7519     sv_vsetpvf_mg(sv, pat, &args);
7520     va_end(args);
7521 }
7522
7523 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
7524
7525 void
7526 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7527 {
7528     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7529     SvSETMAGIC(sv);
7530 }
7531
7532 #if defined(PERL_IMPLICIT_CONTEXT)
7533
7534 /* pTHX_ magic can't cope with varargs, so this is a no-context
7535  * version of the main function, (which may itself be aliased to us).
7536  * Don't access this version directly.
7537  */
7538
7539 void
7540 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7541 {
7542     dTHX;
7543     va_list args;
7544     va_start(args, pat);
7545     sv_vcatpvf(sv, pat, &args);
7546     va_end(args);
7547 }
7548
7549 /* pTHX_ magic can't cope with varargs, so this is a no-context
7550  * version of the main function, (which may itself be aliased to us).
7551  * Don't access this version directly.
7552  */
7553
7554 void
7555 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7556 {
7557     dTHX;
7558     va_list args;
7559     va_start(args, pat);
7560     sv_vcatpvf_mg(sv, pat, &args);
7561     va_end(args);
7562 }
7563 #endif
7564
7565 /*
7566 =for apidoc sv_catpvf
7567
7568 Processes its arguments like C<sprintf> and appends the formatted
7569 output to an SV.  If the appended data contains "wide" characters
7570 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7571 and characters >255 formatted with %c), the original SV might get
7572 upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.
7573 C<SvSETMAGIC()> must typically be called after calling this function
7574 to handle 'set' magic.
7575
7576 =cut */
7577
7578 void
7579 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7580 {
7581     va_list args;
7582     va_start(args, pat);
7583     sv_vcatpvf(sv, pat, &args);
7584     va_end(args);
7585 }
7586
7587 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
7588
7589 void
7590 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7591 {
7592     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7593 }
7594
7595 /*
7596 =for apidoc sv_catpvf_mg
7597
7598 Like C<sv_catpvf>, but also handles 'set' magic.
7599
7600 =cut
7601 */
7602
7603 void
7604 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7605 {
7606     va_list args;
7607     va_start(args, pat);
7608     sv_vcatpvf_mg(sv, pat, &args);
7609     va_end(args);
7610 }
7611
7612 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
7613
7614 void
7615 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7616 {
7617     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7618     SvSETMAGIC(sv);
7619 }
7620
7621 /*
7622 =for apidoc sv_vsetpvfn
7623
7624 Works like C<vcatpvfn> but copies the text into the SV instead of
7625 appending it.
7626
7627 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
7628
7629 =cut
7630 */
7631
7632 void
7633 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7634 {
7635     sv_setpvn(sv, "", 0);
7636     sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7637 }
7638
7639 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7640
7641 STATIC I32
7642 S_expect_number(pTHX_ char** pattern)
7643 {
7644     I32 var = 0;
7645     switch (**pattern) {
7646     case '1': case '2': case '3':
7647     case '4': case '5': case '6':
7648     case '7': case '8': case '9':
7649         while (isDIGIT(**pattern))
7650             var = var * 10 + (*(*pattern)++ - '0');
7651     }
7652     return var;
7653 }
7654 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7655
7656 /*
7657 =for apidoc sv_vcatpvfn
7658
7659 Processes its arguments like C<vsprintf> and appends the formatted output
7660 to an SV.  Uses an array of SVs if the C style variable argument list is
7661 missing (NULL).  When running with taint checks enabled, indicates via
7662 C<maybe_tainted> if results are untrustworthy (often due to the use of
7663 locales).
7664
7665 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
7666
7667 =cut
7668 */
7669
7670 void
7671 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7672 {
7673     char *p;
7674     char *q;
7675     char *patend;
7676     STRLEN origlen;
7677     I32 svix = 0;
7678     static char nullstr[] = "(null)";
7679     SV *argsv = Nullsv;
7680     bool has_utf8 = FALSE; /* has the result utf8? */
7681
7682     /* no matter what, this is a string now */
7683     (void)SvPV_force(sv, origlen);
7684
7685     /* special-case "", "%s", and "%_" */
7686     if (patlen == 0)
7687         return;
7688     if (patlen == 2 && pat[0] == '%') {
7689         switch (pat[1]) {
7690         case 's':
7691             if (args) {
7692                 char *s = va_arg(*args, char*);
7693                 sv_catpv(sv, s ? s : nullstr);
7694             }
7695             else if (svix < svmax) {
7696                 sv_catsv(sv, *svargs);
7697                 if (DO_UTF8(*svargs))
7698                     SvUTF8_on(sv);
7699             }
7700             return;
7701         case '_':
7702             if (args) {
7703                 argsv = va_arg(*args, SV*);
7704                 sv_catsv(sv, argsv);
7705                 if (DO_UTF8(argsv))
7706                     SvUTF8_on(sv);
7707                 return;
7708             }
7709             /* See comment on '_' below */
7710             break;
7711         }
7712     }
7713
7714     if (!args && svix < svmax && DO_UTF8(*svargs))
7715         has_utf8 = TRUE;
7716
7717     patend = (char*)pat + patlen;
7718     for (p = (char*)pat; p < patend; p = q) {
7719         bool alt = FALSE;
7720         bool left = FALSE;
7721         bool vectorize = FALSE;
7722         bool vectorarg = FALSE;
7723         bool vec_utf8 = FALSE;
7724         char fill = ' ';
7725         char plus = 0;
7726         char intsize = 0;
7727         STRLEN width = 0;
7728         STRLEN zeros = 0;
7729         bool has_precis = FALSE;
7730         STRLEN precis = 0;
7731         bool is_utf8 = FALSE;  /* is this item utf8?   */
7732
7733         char esignbuf[4];
7734         U8 utf8buf[UTF8_MAXLEN+1];
7735         STRLEN esignlen = 0;
7736
7737         char *eptr = Nullch;
7738         STRLEN elen = 0;
7739         /* Times 4: a decimal digit takes more than 3 binary digits.
7740          * NV_DIG: mantissa takes than many decimal digits.
7741          * Plus 32: Playing safe. */
7742         char ebuf[IV_DIG * 4 + NV_DIG + 32];
7743         /* large enough for "%#.#f" --chip */
7744         /* what about long double NVs? --jhi */
7745
7746         SV *vecsv;
7747         U8 *vecstr = Null(U8*);
7748         STRLEN veclen = 0;
7749         char c;
7750         int i;
7751         unsigned base = 0;
7752         IV iv = 0;
7753         UV uv = 0;
7754         NV nv;
7755         STRLEN have;
7756         STRLEN need;
7757         STRLEN gap;
7758         char *dotstr = ".";
7759         STRLEN dotstrlen = 1;
7760         I32 efix = 0; /* explicit format parameter index */
7761         I32 ewix = 0; /* explicit width index */
7762         I32 epix = 0; /* explicit precision index */
7763         I32 evix = 0; /* explicit vector index */
7764         bool asterisk = FALSE;
7765
7766         /* echo everything up to the next format specification */
7767         for (q = p; q < patend && *q != '%'; ++q) ;
7768         if (q > p) {
7769             sv_catpvn(sv, p, q - p);
7770             p = q;
7771         }
7772         if (q++ >= patend)
7773             break;
7774
7775 /*
7776     We allow format specification elements in this order:
7777         \d+\$              explicit format parameter index
7778         [-+ 0#]+           flags
7779         \*?(\d+\$)?v       vector with optional (optionally specified) arg
7780         \d+|\*(\d+\$)?     width using optional (optionally specified) arg
7781         \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7782         [hlqLV]            size
7783     [%bcdefginopsux_DFOUX] format (mandatory)
7784 */
7785         if (EXPECT_NUMBER(q, width)) {
7786             if (*q == '$') {
7787                 ++q;
7788                 efix = width;
7789             } else {
7790                 goto gotwidth;
7791             }
7792         }
7793
7794         /* FLAGS */
7795
7796         while (*q) {
7797             switch (*q) {
7798             case ' ':
7799             case '+':
7800                 plus = *q++;
7801                 continue;
7802
7803             case '-':
7804                 left = TRUE;
7805                 q++;
7806                 continue;
7807
7808             case '0':
7809                 fill = *q++;
7810                 continue;
7811
7812             case '#':
7813                 alt = TRUE;
7814                 q++;
7815                 continue;
7816
7817             default:
7818                 break;
7819             }
7820             break;
7821         }
7822
7823       tryasterisk:
7824         if (*q == '*') {
7825             q++;
7826             if (EXPECT_NUMBER(q, ewix))
7827                 if (*q++ != '$')
7828                     goto unknown;
7829             asterisk = TRUE;
7830         }
7831         if (*q == 'v') {
7832             q++;
7833             if (vectorize)
7834                 goto unknown;
7835             if ((vectorarg = asterisk)) {
7836                 evix = ewix;
7837                 ewix = 0;
7838                 asterisk = FALSE;
7839             }
7840             vectorize = TRUE;
7841             goto tryasterisk;
7842         }
7843
7844         if (!asterisk)
7845             EXPECT_NUMBER(q, width);
7846
7847         if (vectorize) {
7848             if (vectorarg) {
7849                 if (args)
7850                     vecsv = va_arg(*args, SV*);
7851                 else
7852                     vecsv = (evix ? evix <= svmax : svix < svmax) ?
7853                         svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
7854                 dotstr = SvPVx(vecsv, dotstrlen);
7855                 if (DO_UTF8(vecsv))
7856                     is_utf8 = TRUE;
7857             }
7858             if (args) {
7859                 vecsv = va_arg(*args, SV*);
7860                 vecstr = (U8*)SvPVx(vecsv,veclen);
7861                 vec_utf8 = DO_UTF8(vecsv);
7862             }
7863             else if (efix ? efix <= svmax : svix < svmax) {
7864                 vecsv = svargs[efix ? efix-1 : svix++];
7865                 vecstr = (U8*)SvPVx(vecsv,veclen);
7866                 vec_utf8 = DO_UTF8(vecsv);
7867             }
7868             else {
7869                 vecstr = (U8*)"";
7870                 veclen = 0;
7871             }
7872         }
7873
7874         if (asterisk) {
7875             if (args)
7876                 i = va_arg(*args, int);
7877             else
7878                 i = (ewix ? ewix <= svmax : svix < svmax) ?
7879                     SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
7880             left |= (i < 0);
7881             width = (i < 0) ? -i : i;
7882         }
7883       gotwidth:
7884
7885         /* PRECISION */
7886
7887         if (*q == '.') {
7888             q++;
7889             if (*q == '*') {
7890                 q++;
7891                 if (EXPECT_NUMBER(q, epix) && *q++ != '$') /* epix currently unused */
7892                     goto unknown;
7893                 if (args)
7894                     i = va_arg(*args, int);
7895                 else
7896                     i = (ewix ? ewix <= svmax : svix < svmax)
7897                         ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
7898                 precis = (i < 0) ? 0 : i;
7899             }
7900             else {
7901                 precis = 0;
7902                 while (isDIGIT(*q))
7903                     precis = precis * 10 + (*q++ - '0');
7904             }
7905             has_precis = TRUE;
7906         }
7907
7908         /* SIZE */
7909
7910         switch (*q) {
7911 #if defined(HAS_QUAD) || (defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE))
7912         case 'L':                       /* Ld */
7913             /* FALL THROUGH */
7914 #endif
7915 #ifdef HAS_QUAD
7916         case 'q':                       /* qd */
7917             intsize = 'q';
7918             q++;
7919             break;
7920 #endif
7921         case 'l':
7922 #if defined(HAS_QUAD) || (defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE))
7923              if (*(q + 1) == 'l') {     /* lld, llf */
7924                 intsize = 'q';
7925                 q += 2;
7926                 break;
7927              }
7928 #endif
7929             /* FALL THROUGH */
7930         case 'h':
7931             /* FALL THROUGH */
7932         case 'V':
7933             intsize = *q++;
7934             break;
7935         }
7936
7937         /* CONVERSION */
7938
7939         if (*q == '%') {
7940             eptr = q++;
7941             elen = 1;
7942             goto string;
7943         }
7944
7945         if (!args)
7946             argsv = (efix ? efix <= svmax : svix < svmax) ?
7947                     svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
7948
7949         switch (c = *q++) {
7950
7951             /* STRINGS */
7952
7953         case 'c':
7954             uv = args ? va_arg(*args, int) : SvIVx(argsv);
7955             if ((uv > 255 ||
7956                  (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
7957                 && !IN_BYTES) {
7958                 eptr = (char*)utf8buf;
7959                 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
7960                 is_utf8 = TRUE;
7961             }
7962             else {
7963                 c = (char)uv;
7964                 eptr = &c;
7965                 elen = 1;
7966             }
7967             goto string;
7968
7969         case 's':
7970             if (args) {
7971                 eptr = va_arg(*args, char*);
7972                 if (eptr)
7973 #ifdef MACOS_TRADITIONAL
7974                   /* On MacOS, %#s format is used for Pascal strings */
7975                   if (alt)
7976                     elen = *eptr++;
7977                   else
7978 #endif
7979                     elen = strlen(eptr);
7980                 else {
7981                     eptr = nullstr;
7982                     elen = sizeof nullstr - 1;
7983                 }
7984             }
7985             else {
7986                 eptr = SvPVx(argsv, elen);
7987                 if (DO_UTF8(argsv)) {
7988                     if (has_precis && precis < elen) {
7989                         I32 p = precis;
7990                         sv_pos_u2b(argsv, &p, 0); /* sticks at end */
7991                         precis = p;
7992                     }
7993                     if (width) { /* fudge width (can't fudge elen) */
7994                         width += elen - sv_len_utf8(argsv);
7995                     }
7996                     is_utf8 = TRUE;
7997                 }
7998             }
7999             goto string;
8000
8001         case '_':
8002             /*
8003              * The "%_" hack might have to be changed someday,
8004              * if ISO or ANSI decide to use '_' for something.
8005              * So we keep it hidden from users' code.
8006              */
8007             if (!args)
8008                 goto unknown;
8009             argsv = va_arg(*args, SV*);
8010             eptr = SvPVx(argsv, elen);
8011             if (DO_UTF8(argsv))
8012                 is_utf8 = TRUE;
8013
8014         string:
8015             vectorize = FALSE;
8016             if (has_precis && elen > precis)
8017                 elen = precis;
8018             break;
8019
8020             /* INTEGERS */
8021
8022         case 'p':
8023             if (alt)
8024                 goto unknown;
8025             uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8026             base = 16;
8027             goto integer;
8028
8029         case 'D':
8030 #ifdef IV_IS_QUAD
8031             intsize = 'q';
8032 #else
8033             intsize = 'l';
8034 #endif
8035             /* FALL THROUGH */
8036         case 'd':
8037         case 'i':
8038             if (vectorize) {
8039                 STRLEN ulen;
8040                 if (!veclen)
8041                     continue;
8042                 if (vec_utf8)
8043                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8044                                         UTF8_ALLOW_ANYUV);
8045                 else {
8046                     uv = *vecstr;
8047                     ulen = 1;
8048                 }
8049                 vecstr += ulen;
8050                 veclen -= ulen;
8051                 if (plus)
8052                      esignbuf[esignlen++] = plus;
8053             }
8054             else if (args) {
8055                 switch (intsize) {
8056                 case 'h':       iv = (short)va_arg(*args, int); break;
8057                 default:        iv = va_arg(*args, int); break;
8058                 case 'l':       iv = va_arg(*args, long); break;
8059                 case 'V':       iv = va_arg(*args, IV); break;
8060 #ifdef HAS_QUAD
8061                 case 'q':       iv = va_arg(*args, Quad_t); break;
8062 #endif
8063                 }
8064             }
8065             else {
8066                 iv = SvIVx(argsv);
8067                 switch (intsize) {
8068                 case 'h':       iv = (short)iv; break;
8069                 default:        break;
8070                 case 'l':       iv = (long)iv; break;
8071                 case 'V':       break;
8072 #ifdef HAS_QUAD
8073                 case 'q':       iv = (Quad_t)iv; break;
8074 #endif
8075                 }
8076             }
8077             if ( !vectorize )   /* we already set uv above */
8078             {
8079                 if (iv >= 0) {
8080                     uv = iv;
8081                     if (plus)
8082                         esignbuf[esignlen++] = plus;
8083                 }
8084                 else {
8085                     uv = -iv;
8086                     esignbuf[esignlen++] = '-';
8087                 }
8088             }
8089             base = 10;
8090             goto integer;
8091
8092         case 'U':
8093 #ifdef IV_IS_QUAD
8094             intsize = 'q';
8095 #else
8096             intsize = 'l';
8097 #endif
8098             /* FALL THROUGH */
8099         case 'u':
8100             base = 10;
8101             goto uns_integer;
8102
8103         case 'b':
8104             base = 2;
8105             goto uns_integer;
8106
8107         case 'O':
8108 #ifdef IV_IS_QUAD
8109             intsize = 'q';
8110 #else
8111             intsize = 'l';
8112 #endif
8113             /* FALL THROUGH */
8114         case 'o':
8115             base = 8;
8116             goto uns_integer;
8117
8118         case 'X':
8119         case 'x':
8120             base = 16;
8121
8122         uns_integer:
8123             if (vectorize) {
8124                 STRLEN ulen;
8125         vector:
8126                 if (!veclen)
8127                     continue;
8128                 if (vec_utf8)
8129                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8130                                         UTF8_ALLOW_ANYUV);
8131                 else {
8132                     uv = *vecstr;
8133                     ulen = 1;
8134                 }
8135                 vecstr += ulen;
8136                 veclen -= ulen;
8137             }
8138             else if (args) {
8139                 switch (intsize) {
8140                 case 'h':  uv = (unsigned short)va_arg(*args, unsigned); break;
8141                 default:   uv = va_arg(*args, unsigned); break;
8142                 case 'l':  uv = va_arg(*args, unsigned long); break;
8143                 case 'V':  uv = va_arg(*args, UV); break;
8144 #ifdef HAS_QUAD
8145                 case 'q':  uv = va_arg(*args, Quad_t); break;
8146 #endif
8147                 }
8148             }
8149             else {
8150                 uv = SvUVx(argsv);
8151                 switch (intsize) {
8152                 case 'h':       uv = (unsigned short)uv; break;
8153                 default:        break;
8154                 case 'l':       uv = (unsigned long)uv; break;
8155                 case 'V':       break;
8156 #ifdef HAS_QUAD
8157                 case 'q':       uv = (Quad_t)uv; break;
8158 #endif
8159                 }
8160             }
8161
8162         integer:
8163             eptr = ebuf + sizeof ebuf;
8164             switch (base) {
8165                 unsigned dig;
8166             case 16:
8167                 if (!uv)
8168                     alt = FALSE;
8169                 p = (char*)((c == 'X')
8170                             ? "0123456789ABCDEF" : "0123456789abcdef");
8171                 do {
8172                     dig = uv & 15;
8173                     *--eptr = p[dig];
8174                 } while (uv >>= 4);
8175                 if (alt) {
8176                     esignbuf[esignlen++] = '0';
8177                     esignbuf[esignlen++] = c;  /* 'x' or 'X' */
8178                 }
8179                 break;
8180             case 8:
8181                 do {
8182                     dig = uv & 7;
8183                     *--eptr = '0' + dig;
8184                 } while (uv >>= 3);
8185                 if (alt && *eptr != '0')
8186                     *--eptr = '0';
8187                 break;
8188             case 2:
8189                 do {
8190                     dig = uv & 1;
8191                     *--eptr = '0' + dig;
8192                 } while (uv >>= 1);
8193                 if (alt) {
8194                     esignbuf[esignlen++] = '0';
8195                     esignbuf[esignlen++] = 'b';
8196                 }
8197                 break;
8198             default:            /* it had better be ten or less */
8199 #if defined(PERL_Y2KWARN)
8200                 if (ckWARN(WARN_Y2K)) {
8201                     STRLEN n;
8202                     char *s = SvPV(sv,n);
8203                     if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
8204                         && (n == 2 || !isDIGIT(s[n-3])))
8205                     {
8206                         Perl_warner(aTHX_ WARN_Y2K,
8207                                     "Possible Y2K bug: %%%c %s",
8208                                     c, "format string following '19'");
8209                     }
8210                 }
8211 #endif
8212                 do {
8213                     dig = uv % base;
8214                     *--eptr = '0' + dig;
8215                 } while (uv /= base);
8216                 break;
8217             }
8218             elen = (ebuf + sizeof ebuf) - eptr;
8219             if (has_precis) {
8220                 if (precis > elen)
8221                     zeros = precis - elen;
8222                 else if (precis == 0 && elen == 1 && *eptr == '0')
8223                     elen = 0;
8224             }
8225             break;
8226
8227             /* FLOATING POINT */
8228
8229         case 'F':
8230             c = 'f';            /* maybe %F isn't supported here */
8231             /* FALL THROUGH */
8232         case 'e': case 'E':
8233         case 'f':
8234         case 'g': case 'G':
8235
8236             /* This is evil, but floating point is even more evil */
8237
8238             vectorize = FALSE;
8239             nv = args ? va_arg(*args, NV) : SvNVx(argsv);
8240
8241             need = 0;
8242             if (c != 'e' && c != 'E') {
8243                 i = PERL_INT_MIN;
8244                 (void)Perl_frexp(nv, &i);
8245                 if (i == PERL_INT_MIN)
8246                     Perl_die(aTHX_ "panic: frexp");
8247                 if (i > 0)
8248                     need = BIT_DIGITS(i);
8249             }
8250             need += has_precis ? precis : 6; /* known default */
8251             if (need < width)
8252                 need = width;
8253
8254             need += 20; /* fudge factor */
8255             if (PL_efloatsize < need) {
8256                 Safefree(PL_efloatbuf);
8257                 PL_efloatsize = need + 20; /* more fudge */
8258                 New(906, PL_efloatbuf, PL_efloatsize, char);
8259                 PL_efloatbuf[0] = '\0';
8260             }
8261
8262             eptr = ebuf + sizeof ebuf;
8263             *--eptr = '\0';
8264             *--eptr = c;
8265 #if defined(USE_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8266             {
8267                 /* Copy the one or more characters in a long double
8268                  * format before the 'base' ([efgEFG]) character to
8269                  * the format string. */
8270                 static char const prifldbl[] = PERL_PRIfldbl;
8271                 char const *p = prifldbl + sizeof(prifldbl) - 3;
8272                 while (p >= prifldbl) { *--eptr = *p--; }
8273             }
8274 #endif
8275             if (has_precis) {
8276                 base = precis;
8277                 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8278                 *--eptr = '.';
8279             }
8280             if (width) {
8281                 base = width;
8282                 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8283             }
8284             if (fill == '0')
8285                 *--eptr = fill;
8286             if (left)
8287                 *--eptr = '-';
8288             if (plus)
8289                 *--eptr = plus;
8290             if (alt)
8291                 *--eptr = '#';
8292             *--eptr = '%';
8293
8294             /* No taint.  Otherwise we are in the strange situation
8295              * where printf() taints but print($float) doesn't.
8296              * --jhi */
8297             (void)sprintf(PL_efloatbuf, eptr, nv);
8298
8299             eptr = PL_efloatbuf;
8300             elen = strlen(PL_efloatbuf);
8301             break;
8302
8303             /* SPECIAL */
8304
8305         case 'n':
8306             vectorize = FALSE;
8307             i = SvCUR(sv) - origlen;
8308             if (args) {
8309                 switch (intsize) {
8310                 case 'h':       *(va_arg(*args, short*)) = i; break;
8311                 default:        *(va_arg(*args, int*)) = i; break;
8312                 case 'l':       *(va_arg(*args, long*)) = i; break;
8313                 case 'V':       *(va_arg(*args, IV*)) = i; break;
8314 #ifdef HAS_QUAD
8315                 case 'q':       *(va_arg(*args, Quad_t*)) = i; break;
8316 #endif
8317                 }
8318             }
8319             else
8320                 sv_setuv_mg(argsv, (UV)i);
8321             continue;   /* not "break" */
8322
8323             /* UNKNOWN */
8324
8325         default:
8326       unknown:
8327             vectorize = FALSE;
8328             if (!args && ckWARN(WARN_PRINTF) &&
8329                   (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
8330                 SV *msg = sv_newmortal();
8331                 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %s: ",
8332                           (PL_op->op_type == OP_PRTF) ? "printf" : "sprintf");
8333                 if (c) {
8334                     if (isPRINT(c))
8335                         Perl_sv_catpvf(aTHX_ msg,
8336                                        "\"%%%c\"", c & 0xFF);
8337                     else
8338                         Perl_sv_catpvf(aTHX_ msg,
8339                                        "\"%%\\%03"UVof"\"",
8340                                        (UV)c & 0xFF);
8341                 } else
8342                     sv_catpv(msg, "end of string");
8343                 Perl_warner(aTHX_ WARN_PRINTF, "%"SVf, msg); /* yes, this is reentrant */
8344             }
8345
8346             /* output mangled stuff ... */
8347             if (c == '\0')
8348                 --q;
8349             eptr = p;
8350             elen = q - p;
8351
8352             /* ... right here, because formatting flags should not apply */
8353             SvGROW(sv, SvCUR(sv) + elen + 1);
8354             p = SvEND(sv);
8355             Copy(eptr, p, elen, char);
8356             p += elen;
8357             *p = '\0';
8358             SvCUR(sv) = p - SvPVX(sv);
8359             continue;   /* not "break" */
8360         }
8361
8362         if (is_utf8 != has_utf8) {
8363              if (is_utf8) {
8364                   if (SvCUR(sv))
8365                        sv_utf8_upgrade(sv);
8366              }
8367              else {
8368                   SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
8369                   sv_utf8_upgrade(nsv);
8370                   eptr = SvPVX(nsv);
8371                   elen = SvCUR(nsv);
8372              }
8373              SvGROW(sv, SvCUR(sv) + elen + 1);
8374              p = SvEND(sv);
8375              *p = '\0';
8376         }
8377
8378         have = esignlen + zeros + elen;
8379         need = (have > width ? have : width);
8380         gap = need - have;
8381
8382         SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8383         p = SvEND(sv);
8384         if (esignlen && fill == '0') {
8385             for (i = 0; i < esignlen; i++)
8386                 *p++ = esignbuf[i];
8387         }
8388         if (gap && !left) {
8389             memset(p, fill, gap);
8390             p += gap;
8391         }
8392         if (esignlen && fill != '0') {
8393             for (i = 0; i < esignlen; i++)
8394                 *p++ = esignbuf[i];
8395         }
8396         if (zeros) {
8397             for (i = zeros; i; i--)
8398                 *p++ = '0';
8399         }
8400         if (elen) {
8401             Copy(eptr, p, elen, char);
8402             p += elen;
8403         }
8404         if (gap && left) {
8405             memset(p, ' ', gap);
8406             p += gap;
8407         }
8408         if (vectorize) {
8409             if (veclen) {
8410                 Copy(dotstr, p, dotstrlen, char);
8411                 p += dotstrlen;
8412             }
8413             else
8414                 vectorize = FALSE;              /* done iterating over vecstr */
8415         }
8416         if (is_utf8)
8417             has_utf8 = TRUE;
8418         if (has_utf8)
8419             SvUTF8_on(sv);
8420         *p = '\0';
8421         SvCUR(sv) = p - SvPVX(sv);
8422         if (vectorize) {
8423             esignlen = 0;
8424             goto vector;
8425         }
8426     }
8427 }
8428
8429 /* =========================================================================
8430
8431 =head1 Cloning an interpreter
8432
8433 All the macros and functions in this section are for the private use of
8434 the main function, perl_clone().
8435
8436 The foo_dup() functions make an exact copy of an existing foo thinngy.
8437 During the course of a cloning, a hash table is used to map old addresses
8438 to new addresses. The table is created and manipulated with the
8439 ptr_table_* functions.
8440
8441 =cut
8442
8443 ============================================================================*/
8444
8445
8446 #if defined(USE_ITHREADS)
8447
8448 #if defined(USE_5005THREADS)
8449 #  include "error: USE_5005THREADS and USE_ITHREADS are incompatible"
8450 #endif
8451
8452 #ifndef GpREFCNT_inc
8453 #  define GpREFCNT_inc(gp)      ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8454 #endif
8455
8456
8457 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8458 #define av_dup(s,t)     (AV*)sv_dup((SV*)s,t)
8459 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8460 #define hv_dup(s,t)     (HV*)sv_dup((SV*)s,t)
8461 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8462 #define cv_dup(s,t)     (CV*)sv_dup((SV*)s,t)
8463 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8464 #define io_dup(s,t)     (IO*)sv_dup((SV*)s,t)
8465 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8466 #define gv_dup(s,t)     (GV*)sv_dup((SV*)s,t)
8467 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8468 #define SAVEPV(p)       (p ? savepv(p) : Nullch)
8469 #define SAVEPVN(p,n)    (p ? savepvn(p,n) : Nullch)
8470
8471
8472 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8473    regcomp.c. AMS 20010712 */
8474
8475 REGEXP *
8476 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
8477 {
8478     REGEXP *ret;
8479     int i, len, npar;
8480     struct reg_substr_datum *s;
8481
8482     if (!r)
8483         return (REGEXP *)NULL;
8484
8485     if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8486         return ret;
8487
8488     len = r->offsets[0];
8489     npar = r->nparens+1;
8490
8491     Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8492     Copy(r->program, ret->program, len+1, regnode);
8493
8494     New(0, ret->startp, npar, I32);
8495     Copy(r->startp, ret->startp, npar, I32);
8496     New(0, ret->endp, npar, I32);
8497     Copy(r->startp, ret->startp, npar, I32);
8498
8499     New(0, ret->substrs, 1, struct reg_substr_data);
8500     for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8501         s->min_offset = r->substrs->data[i].min_offset;
8502         s->max_offset = r->substrs->data[i].max_offset;
8503         s->substr     = sv_dup_inc(r->substrs->data[i].substr, param);
8504     }
8505
8506     ret->regstclass = NULL;
8507     if (r->data) {
8508         struct reg_data *d;
8509         int count = r->data->count;
8510
8511         Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
8512                 char, struct reg_data);
8513         New(0, d->what, count, U8);
8514
8515         d->count = count;
8516         for (i = 0; i < count; i++) {
8517             d->what[i] = r->data->what[i];
8518             switch (d->what[i]) {
8519             case 's':
8520                 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8521                 break;
8522             case 'p':
8523                 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8524                 break;
8525             case 'f':
8526                 /* This is cheating. */
8527                 New(0, d->data[i], 1, struct regnode_charclass_class);
8528                 StructCopy(r->data->data[i], d->data[i],
8529                             struct regnode_charclass_class);
8530                 ret->regstclass = (regnode*)d->data[i];
8531                 break;
8532             case 'o':
8533                 /* Compiled op trees are readonly, and can thus be
8534                    shared without duplication. */
8535                 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8536                 break;
8537             case 'n':
8538                 d->data[i] = r->data->data[i];
8539                 break;
8540             }
8541         }
8542
8543         ret->data = d;
8544     }
8545     else
8546         ret->data = NULL;
8547
8548     New(0, ret->offsets, 2*len+1, U32);
8549     Copy(r->offsets, ret->offsets, 2*len+1, U32);
8550
8551     ret->precomp        = SAVEPV(r->precomp);
8552     ret->refcnt         = r->refcnt;
8553     ret->minlen         = r->minlen;
8554     ret->prelen         = r->prelen;
8555     ret->nparens        = r->nparens;
8556     ret->lastparen      = r->lastparen;
8557     ret->lastcloseparen = r->lastcloseparen;
8558     ret->reganch        = r->reganch;
8559
8560     ret->sublen         = r->sublen;
8561
8562     if (RX_MATCH_COPIED(ret))
8563         ret->subbeg  = SAVEPV(r->subbeg);
8564     else
8565         ret->subbeg = Nullch;
8566
8567     ptr_table_store(PL_ptr_table, r, ret);
8568     return ret;
8569 }
8570
8571 /* duplicate a file handle */
8572
8573 PerlIO *
8574 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8575 {
8576     PerlIO *ret;
8577     if (!fp)
8578         return (PerlIO*)NULL;
8579
8580     /* look for it in the table first */
8581     ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8582     if (ret)
8583         return ret;
8584
8585     /* create anew and remember what it is */
8586     ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8587     ptr_table_store(PL_ptr_table, fp, ret);
8588     return ret;
8589 }
8590
8591 /* duplicate a directory handle */
8592
8593 DIR *
8594 Perl_dirp_dup(pTHX_ DIR *dp)
8595 {
8596     if (!dp)
8597         return (DIR*)NULL;
8598     /* XXX TODO */
8599     return dp;
8600 }
8601
8602 /* duplicate a typeglob */
8603
8604 GP *
8605 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8606 {
8607     GP *ret;
8608     if (!gp)
8609         return (GP*)NULL;
8610     /* look for it in the table first */
8611     ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8612     if (ret)
8613         return ret;
8614
8615     /* create anew and remember what it is */
8616     Newz(0, ret, 1, GP);
8617     ptr_table_store(PL_ptr_table, gp, ret);
8618
8619     /* clone */
8620     ret->gp_refcnt      = 0;                    /* must be before any other dups! */
8621     ret->gp_sv          = sv_dup_inc(gp->gp_sv, param);
8622     ret->gp_io          = io_dup_inc(gp->gp_io, param);
8623     ret->gp_form        = cv_dup_inc(gp->gp_form, param);
8624     ret->gp_av          = av_dup_inc(gp->gp_av, param);
8625     ret->gp_hv          = hv_dup_inc(gp->gp_hv, param);
8626     ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8627     ret->gp_cv          = cv_dup_inc(gp->gp_cv, param);
8628     ret->gp_cvgen       = gp->gp_cvgen;
8629     ret->gp_flags       = gp->gp_flags;
8630     ret->gp_line        = gp->gp_line;
8631     ret->gp_file        = gp->gp_file;          /* points to COP.cop_file */
8632     return ret;
8633 }
8634
8635 /* duplicate a chain of magic */
8636
8637 MAGIC *
8638 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8639 {
8640     MAGIC *mgprev = (MAGIC*)NULL;
8641     MAGIC *mgret;
8642     if (!mg)
8643         return (MAGIC*)NULL;
8644     /* look for it in the table first */
8645     mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8646     if (mgret)
8647         return mgret;
8648
8649     for (; mg; mg = mg->mg_moremagic) {
8650         MAGIC *nmg;
8651         Newz(0, nmg, 1, MAGIC);
8652         if (mgprev)
8653             mgprev->mg_moremagic = nmg;
8654         else
8655             mgret = nmg;
8656         nmg->mg_virtual = mg->mg_virtual;       /* XXX copy dynamic vtable? */
8657         nmg->mg_private = mg->mg_private;
8658         nmg->mg_type    = mg->mg_type;
8659         nmg->mg_flags   = mg->mg_flags;
8660         if (mg->mg_type == PERL_MAGIC_qr) {
8661             nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8662         }
8663         else if(mg->mg_type == PERL_MAGIC_backref) {
8664              AV *av = (AV*) mg->mg_obj;
8665              SV **svp;
8666              I32 i;
8667              nmg->mg_obj = (SV*)newAV();
8668              svp = AvARRAY(av);
8669              i = AvFILLp(av);
8670              while (i >= 0) {
8671                   av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8672                   i--;
8673              }
8674         }
8675         else {
8676             nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
8677                               ? sv_dup_inc(mg->mg_obj, param)
8678                               : sv_dup(mg->mg_obj, param);
8679         }
8680         nmg->mg_len     = mg->mg_len;
8681         nmg->mg_ptr     = mg->mg_ptr;   /* XXX random ptr? */
8682         if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
8683             if (mg->mg_len >= 0) {
8684                 nmg->mg_ptr     = SAVEPVN(mg->mg_ptr, mg->mg_len);
8685                 if (mg->mg_type == PERL_MAGIC_overload_table &&
8686                         AMT_AMAGIC((AMT*)mg->mg_ptr))
8687                 {
8688                     AMT *amtp = (AMT*)mg->mg_ptr;
8689                     AMT *namtp = (AMT*)nmg->mg_ptr;
8690                     I32 i;
8691                     for (i = 1; i < NofAMmeth; i++) {
8692                         namtp->table[i] = cv_dup_inc(amtp->table[i], param);
8693                     }
8694                 }
8695             }
8696             else if (mg->mg_len == HEf_SVKEY)
8697                 nmg->mg_ptr     = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
8698         }
8699         mgprev = nmg;
8700     }
8701     return mgret;
8702 }
8703
8704 /* create a new pointer-mapping table */
8705
8706 PTR_TBL_t *
8707 Perl_ptr_table_new(pTHX)
8708 {
8709     PTR_TBL_t *tbl;
8710     Newz(0, tbl, 1, PTR_TBL_t);
8711     tbl->tbl_max        = 511;
8712     tbl->tbl_items      = 0;
8713     Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
8714     return tbl;
8715 }
8716
8717 /* map an existing pointer using a table */
8718
8719 void *
8720 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
8721 {
8722     PTR_TBL_ENT_t *tblent;
8723     UV hash = PTR2UV(sv);
8724     assert(tbl);
8725     tblent = tbl->tbl_ary[hash & tbl->tbl_max];
8726     for (; tblent; tblent = tblent->next) {
8727         if (tblent->oldval == sv)
8728             return tblent->newval;
8729     }
8730     return (void*)NULL;
8731 }
8732
8733 /* add a new entry to a pointer-mapping table */
8734
8735 void
8736 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
8737 {
8738     PTR_TBL_ENT_t *tblent, **otblent;
8739     /* XXX this may be pessimal on platforms where pointers aren't good
8740      * hash values e.g. if they grow faster in the most significant
8741      * bits */
8742     UV hash = PTR2UV(oldv);
8743     bool i = 1;
8744
8745     assert(tbl);
8746     otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
8747     for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
8748         if (tblent->oldval == oldv) {
8749             tblent->newval = newv;
8750             tbl->tbl_items++;
8751             return;
8752         }
8753     }
8754     Newz(0, tblent, 1, PTR_TBL_ENT_t);
8755     tblent->oldval = oldv;
8756     tblent->newval = newv;
8757     tblent->next = *otblent;
8758     *otblent = tblent;
8759     tbl->tbl_items++;
8760     if (i && tbl->tbl_items > tbl->tbl_max)
8761         ptr_table_split(tbl);
8762 }
8763
8764 /* double the hash bucket size of an existing ptr table */
8765
8766 void
8767 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
8768 {
8769     PTR_TBL_ENT_t **ary = tbl->tbl_ary;
8770     UV oldsize = tbl->tbl_max + 1;
8771     UV newsize = oldsize * 2;
8772     UV i;
8773
8774     Renew(ary, newsize, PTR_TBL_ENT_t*);
8775     Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
8776     tbl->tbl_max = --newsize;
8777     tbl->tbl_ary = ary;
8778     for (i=0; i < oldsize; i++, ary++) {
8779         PTR_TBL_ENT_t **curentp, **entp, *ent;
8780         if (!*ary)
8781             continue;
8782         curentp = ary + oldsize;
8783         for (entp = ary, ent = *ary; ent; ent = *entp) {
8784             if ((newsize & PTR2UV(ent->oldval)) != i) {
8785                 *entp = ent->next;
8786                 ent->next = *curentp;
8787                 *curentp = ent;
8788                 continue;
8789             }
8790             else
8791                 entp = &ent->next;
8792         }
8793     }
8794 }
8795
8796 /* remove all the entries from a ptr table */
8797
8798 void
8799 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
8800 {
8801     register PTR_TBL_ENT_t **array;
8802     register PTR_TBL_ENT_t *entry;
8803     register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
8804     UV riter = 0;
8805     UV max;
8806
8807     if (!tbl || !tbl->tbl_items) {
8808         return;
8809     }
8810
8811     array = tbl->tbl_ary;
8812     entry = array[0];
8813     max = tbl->tbl_max;
8814
8815     for (;;) {
8816         if (entry) {
8817             oentry = entry;
8818             entry = entry->next;
8819             Safefree(oentry);
8820         }
8821         if (!entry) {
8822             if (++riter > max) {
8823                 break;
8824             }
8825             entry = array[riter];
8826         }
8827     }
8828
8829     tbl->tbl_items = 0;
8830 }
8831
8832 /* clear and free a ptr table */
8833
8834 void
8835 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
8836 {
8837     if (!tbl) {
8838         return;
8839     }
8840     ptr_table_clear(tbl);
8841     Safefree(tbl->tbl_ary);
8842     Safefree(tbl);
8843 }
8844
8845 #ifdef DEBUGGING
8846 char *PL_watch_pvx;
8847 #endif
8848
8849 /* attempt to make everything in the typeglob readonly */
8850
8851 STATIC SV *
8852 S_gv_share(pTHX_ SV *sstr)
8853 {
8854     GV *gv = (GV*)sstr;
8855     SV *sv = &PL_sv_no; /* just need SvREADONLY-ness */
8856
8857     if (GvIO(gv) || GvFORM(gv)) {
8858         GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
8859     }
8860     else if (!GvCV(gv)) {
8861         GvCV(gv) = (CV*)sv;
8862     }
8863     else {
8864         /* CvPADLISTs cannot be shared */
8865         if (!CvXSUB(GvCV(gv))) {
8866             GvUNIQUE_off(gv);
8867         }
8868     }
8869
8870     if (!GvUNIQUE(gv)) {
8871 #if 0
8872         PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
8873                       HvNAME(GvSTASH(gv)), GvNAME(gv));
8874 #endif
8875         return Nullsv;
8876     }
8877
8878     /*
8879      * write attempts will die with
8880      * "Modification of a read-only value attempted"
8881      */
8882     if (!GvSV(gv)) {
8883         GvSV(gv) = sv;
8884     }
8885     else {
8886         SvREADONLY_on(GvSV(gv));
8887     }
8888
8889     if (!GvAV(gv)) {
8890         GvAV(gv) = (AV*)sv;
8891     }
8892     else {
8893         SvREADONLY_on(GvAV(gv));
8894     }
8895
8896     if (!GvHV(gv)) {
8897         GvHV(gv) = (HV*)sv;
8898     }
8899     else {
8900         SvREADONLY_on(GvAV(gv));
8901     }
8902
8903     return sstr; /* he_dup() will SvREFCNT_inc() */
8904 }
8905
8906 /* duplicate an SV of any type (including AV, HV etc) */
8907
8908 void
8909 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
8910 {
8911     if (SvROK(sstr)) {
8912         SvRV(dstr) = SvWEAKREF(sstr)
8913                      ? sv_dup(SvRV(sstr), param)
8914                      : sv_dup_inc(SvRV(sstr), param);
8915     }
8916     else if (SvPVX(sstr)) {
8917         /* Has something there */
8918         if (SvLEN(sstr)) {
8919             /* Normal PV - clone whole allocated space */
8920             SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
8921         }
8922         else {
8923             /* Special case - not normally malloced for some reason */
8924             if (SvREADONLY(sstr) && SvFAKE(sstr)) {
8925                 /* A "shared" PV - clone it as unshared string */
8926                 SvFAKE_off(dstr);
8927                 SvREADONLY_off(dstr);
8928                 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
8929             }
8930             else {
8931                 /* Some other special case - random pointer */
8932                 SvPVX(dstr) = SvPVX(sstr);
8933             }
8934         }
8935     }
8936     else {
8937         /* Copy the Null */
8938         SvPVX(dstr) = SvPVX(sstr);
8939     }
8940 }
8941
8942 SV *
8943 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
8944 {
8945     SV *dstr;
8946
8947     if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
8948         return Nullsv;
8949     /* look for it in the table first */
8950     dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
8951     if (dstr)
8952         return dstr;
8953
8954     /* create anew and remember what it is */
8955     new_SV(dstr);
8956     ptr_table_store(PL_ptr_table, sstr, dstr);
8957
8958     /* clone */
8959     SvFLAGS(dstr)       = SvFLAGS(sstr);
8960     SvFLAGS(dstr)       &= ~SVf_OOK;            /* don't propagate OOK hack */
8961     SvREFCNT(dstr)      = 0;                    /* must be before any other dups! */
8962
8963 #ifdef DEBUGGING
8964     if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
8965         PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
8966                       PL_watch_pvx, SvPVX(sstr));
8967 #endif
8968
8969     switch (SvTYPE(sstr)) {
8970     case SVt_NULL:
8971         SvANY(dstr)     = NULL;
8972         break;
8973     case SVt_IV:
8974         SvANY(dstr)     = new_XIV();
8975         SvIVX(dstr)     = SvIVX(sstr);
8976         break;
8977     case SVt_NV:
8978         SvANY(dstr)     = new_XNV();
8979         SvNVX(dstr)     = SvNVX(sstr);
8980         break;
8981     case SVt_RV:
8982         SvANY(dstr)     = new_XRV();
8983         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
8984         break;
8985     case SVt_PV:
8986         SvANY(dstr)     = new_XPV();
8987         SvCUR(dstr)     = SvCUR(sstr);
8988         SvLEN(dstr)     = SvLEN(sstr);
8989         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
8990         break;
8991     case SVt_PVIV:
8992         SvANY(dstr)     = new_XPVIV();
8993         SvCUR(dstr)     = SvCUR(sstr);
8994         SvLEN(dstr)     = SvLEN(sstr);
8995         SvIVX(dstr)     = SvIVX(sstr);
8996         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
8997         break;
8998     case SVt_PVNV:
8999         SvANY(dstr)     = new_XPVNV();
9000         SvCUR(dstr)     = SvCUR(sstr);
9001         SvLEN(dstr)     = SvLEN(sstr);
9002         SvIVX(dstr)     = SvIVX(sstr);
9003         SvNVX(dstr)     = SvNVX(sstr);
9004         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9005         break;
9006     case SVt_PVMG:
9007         SvANY(dstr)     = new_XPVMG();
9008         SvCUR(dstr)     = SvCUR(sstr);
9009         SvLEN(dstr)     = SvLEN(sstr);
9010         SvIVX(dstr)     = SvIVX(sstr);
9011         SvNVX(dstr)     = SvNVX(sstr);
9012         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9013         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9014         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9015         break;
9016     case SVt_PVBM:
9017         SvANY(dstr)     = new_XPVBM();
9018         SvCUR(dstr)     = SvCUR(sstr);
9019         SvLEN(dstr)     = SvLEN(sstr);
9020         SvIVX(dstr)     = SvIVX(sstr);
9021         SvNVX(dstr)     = SvNVX(sstr);
9022         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9023         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9024         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9025         BmRARE(dstr)    = BmRARE(sstr);
9026         BmUSEFUL(dstr)  = BmUSEFUL(sstr);
9027         BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
9028         break;
9029     case SVt_PVLV:
9030         SvANY(dstr)     = new_XPVLV();
9031         SvCUR(dstr)     = SvCUR(sstr);
9032         SvLEN(dstr)     = SvLEN(sstr);
9033         SvIVX(dstr)     = SvIVX(sstr);
9034         SvNVX(dstr)     = SvNVX(sstr);
9035         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9036         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9037         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9038         LvTARGOFF(dstr) = LvTARGOFF(sstr);      /* XXX sometimes holds PMOP* when DEBUGGING */
9039         LvTARGLEN(dstr) = LvTARGLEN(sstr);
9040         LvTARG(dstr)    = sv_dup_inc(LvTARG(sstr), param);
9041         LvTYPE(dstr)    = LvTYPE(sstr);
9042         break;
9043     case SVt_PVGV:
9044         if (GvUNIQUE((GV*)sstr)) {
9045             SV *share;
9046             if ((share = gv_share(sstr))) {
9047                 del_SV(dstr);
9048                 dstr = share;
9049 #if 0
9050                 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
9051                               HvNAME(GvSTASH(share)), GvNAME(share));
9052 #endif
9053                 break;
9054             }
9055         }
9056         SvANY(dstr)     = new_XPVGV();
9057         SvCUR(dstr)     = SvCUR(sstr);
9058         SvLEN(dstr)     = SvLEN(sstr);
9059         SvIVX(dstr)     = SvIVX(sstr);
9060         SvNVX(dstr)     = SvNVX(sstr);
9061         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9062         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9063         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9064         GvNAMELEN(dstr) = GvNAMELEN(sstr);
9065         GvNAME(dstr)    = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
9066         GvSTASH(dstr)   = hv_dup_inc(GvSTASH(sstr), param);
9067         GvFLAGS(dstr)   = GvFLAGS(sstr);
9068         GvGP(dstr)      = gp_dup(GvGP(sstr), param);
9069         (void)GpREFCNT_inc(GvGP(dstr));
9070         break;
9071     case SVt_PVIO:
9072         SvANY(dstr)     = new_XPVIO();
9073         SvCUR(dstr)     = SvCUR(sstr);
9074         SvLEN(dstr)     = SvLEN(sstr);
9075         SvIVX(dstr)     = SvIVX(sstr);
9076         SvNVX(dstr)     = SvNVX(sstr);
9077         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9078         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9079         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9080         IoIFP(dstr)     = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
9081         if (IoOFP(sstr) == IoIFP(sstr))
9082             IoOFP(dstr) = IoIFP(dstr);
9083         else
9084             IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
9085         /* PL_rsfp_filters entries have fake IoDIRP() */
9086         if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
9087             IoDIRP(dstr)        = dirp_dup(IoDIRP(sstr));
9088         else
9089             IoDIRP(dstr)        = IoDIRP(sstr);
9090         IoLINES(dstr)           = IoLINES(sstr);
9091         IoPAGE(dstr)            = IoPAGE(sstr);
9092         IoPAGE_LEN(dstr)        = IoPAGE_LEN(sstr);
9093         IoLINES_LEFT(dstr)      = IoLINES_LEFT(sstr);
9094         IoTOP_NAME(dstr)        = SAVEPV(IoTOP_NAME(sstr));
9095         IoTOP_GV(dstr)          = gv_dup(IoTOP_GV(sstr), param);
9096         IoFMT_NAME(dstr)        = SAVEPV(IoFMT_NAME(sstr));
9097         IoFMT_GV(dstr)          = gv_dup(IoFMT_GV(sstr), param);
9098         IoBOTTOM_NAME(dstr)     = SAVEPV(IoBOTTOM_NAME(sstr));
9099         IoBOTTOM_GV(dstr)       = gv_dup(IoBOTTOM_GV(sstr), param);
9100         IoSUBPROCESS(dstr)      = IoSUBPROCESS(sstr);
9101         IoTYPE(dstr)            = IoTYPE(sstr);
9102         IoFLAGS(dstr)           = IoFLAGS(sstr);
9103         break;
9104     case SVt_PVAV:
9105         SvANY(dstr)     = new_XPVAV();
9106         SvCUR(dstr)     = SvCUR(sstr);
9107         SvLEN(dstr)     = SvLEN(sstr);
9108         SvIVX(dstr)     = SvIVX(sstr);
9109         SvNVX(dstr)     = SvNVX(sstr);
9110         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9111         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9112         AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
9113         AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
9114         if (AvARRAY((AV*)sstr)) {
9115             SV **dst_ary, **src_ary;
9116             SSize_t items = AvFILLp((AV*)sstr) + 1;
9117
9118             src_ary = AvARRAY((AV*)sstr);
9119             Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
9120             ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9121             SvPVX(dstr) = (char*)dst_ary;
9122             AvALLOC((AV*)dstr) = dst_ary;
9123             if (AvREAL((AV*)sstr)) {
9124                 while (items-- > 0)
9125                     *dst_ary++ = sv_dup_inc(*src_ary++, param);
9126             }
9127             else {
9128                 while (items-- > 0)
9129                     *dst_ary++ = sv_dup(*src_ary++, param);
9130             }
9131             items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9132             while (items-- > 0) {
9133                 *dst_ary++ = &PL_sv_undef;
9134             }
9135         }
9136         else {
9137             SvPVX(dstr)         = Nullch;
9138             AvALLOC((AV*)dstr)  = (SV**)NULL;
9139         }
9140         break;
9141     case SVt_PVHV:
9142         SvANY(dstr)     = new_XPVHV();
9143         SvCUR(dstr)     = SvCUR(sstr);
9144         SvLEN(dstr)     = SvLEN(sstr);
9145         SvIVX(dstr)     = SvIVX(sstr);
9146         SvNVX(dstr)     = SvNVX(sstr);
9147         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9148         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9149         HvRITER((HV*)dstr)      = HvRITER((HV*)sstr);
9150         if (HvARRAY((HV*)sstr)) {
9151             STRLEN i = 0;
9152             XPVHV *dxhv = (XPVHV*)SvANY(dstr);
9153             XPVHV *sxhv = (XPVHV*)SvANY(sstr);
9154             Newz(0, dxhv->xhv_array,
9155                  PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
9156             while (i <= sxhv->xhv_max) {
9157                 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
9158                                                     !!HvSHAREKEYS(sstr), param);
9159                 ++i;
9160             }
9161             dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter, !!HvSHAREKEYS(sstr), param);
9162         }
9163         else {
9164             SvPVX(dstr)         = Nullch;
9165             HvEITER((HV*)dstr)  = (HE*)NULL;
9166         }
9167         HvPMROOT((HV*)dstr)     = HvPMROOT((HV*)sstr);          /* XXX */
9168         HvNAME((HV*)dstr)       = SAVEPV(HvNAME((HV*)sstr));
9169     /* Record stashes for possible cloning in Perl_clone(). */
9170         if(HvNAME((HV*)dstr))
9171             av_push(param->stashes, dstr);
9172         break;
9173     case SVt_PVFM:
9174         SvANY(dstr)     = new_XPVFM();
9175         FmLINES(dstr)   = FmLINES(sstr);
9176         goto dup_pvcv;
9177         /* NOTREACHED */
9178     case SVt_PVCV:
9179         SvANY(dstr)     = new_XPVCV();
9180         dup_pvcv:
9181         SvCUR(dstr)     = SvCUR(sstr);
9182         SvLEN(dstr)     = SvLEN(sstr);
9183         SvIVX(dstr)     = SvIVX(sstr);
9184         SvNVX(dstr)     = SvNVX(sstr);
9185         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
9186         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
9187         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9188         CvSTASH(dstr)   = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
9189         CvSTART(dstr)   = CvSTART(sstr);
9190         CvROOT(dstr)    = OpREFCNT_inc(CvROOT(sstr));
9191         CvXSUB(dstr)    = CvXSUB(sstr);
9192         CvXSUBANY(dstr) = CvXSUBANY(sstr);
9193         if (CvCONST(sstr)) {
9194             CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
9195                 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
9196                 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
9197         }
9198         CvGV(dstr)      = gv_dup(CvGV(sstr), param);
9199         if (param->flags & CLONEf_COPY_STACKS) {
9200           CvDEPTH(dstr) = CvDEPTH(sstr);
9201         } else {
9202           CvDEPTH(dstr) = 0;
9203         }
9204         if (CvPADLIST(sstr) && !AvREAL(CvPADLIST(sstr))) {
9205             /* XXX padlists are real, but pretend to be not */
9206             AvREAL_on(CvPADLIST(sstr));
9207             CvPADLIST(dstr)     = av_dup_inc(CvPADLIST(sstr), param);
9208             AvREAL_off(CvPADLIST(sstr));
9209             AvREAL_off(CvPADLIST(dstr));
9210         }
9211         else
9212             CvPADLIST(dstr)     = av_dup_inc(CvPADLIST(sstr), param);
9213         if (!CvANON(sstr) || CvCLONED(sstr))
9214             CvOUTSIDE(dstr)     = cv_dup_inc(CvOUTSIDE(sstr), param);
9215         else
9216             CvOUTSIDE(dstr)     = cv_dup(CvOUTSIDE(sstr), param);
9217         CvFLAGS(dstr)   = CvFLAGS(sstr);
9218         CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
9219         break;
9220     default:
9221         Perl_croak(aTHX_ "Bizarre SvTYPE [%d]", SvTYPE(sstr));
9222         break;
9223     }
9224
9225     if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9226         ++PL_sv_objcount;
9227
9228     return dstr;
9229  }
9230
9231 /* duplicate a context */
9232
9233 PERL_CONTEXT *
9234 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9235 {
9236     PERL_CONTEXT *ncxs;
9237
9238     if (!cxs)
9239         return (PERL_CONTEXT*)NULL;
9240
9241     /* look for it in the table first */
9242     ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9243     if (ncxs)
9244         return ncxs;
9245
9246     /* create anew and remember what it is */
9247     Newz(56, ncxs, max + 1, PERL_CONTEXT);
9248     ptr_table_store(PL_ptr_table, cxs, ncxs);
9249
9250     while (ix >= 0) {
9251         PERL_CONTEXT *cx = &cxs[ix];
9252         PERL_CONTEXT *ncx = &ncxs[ix];
9253         ncx->cx_type    = cx->cx_type;
9254         if (CxTYPE(cx) == CXt_SUBST) {
9255             Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9256         }
9257         else {
9258             ncx->blk_oldsp      = cx->blk_oldsp;
9259             ncx->blk_oldcop     = cx->blk_oldcop;
9260             ncx->blk_oldretsp   = cx->blk_oldretsp;
9261             ncx->blk_oldmarksp  = cx->blk_oldmarksp;
9262             ncx->blk_oldscopesp = cx->blk_oldscopesp;
9263             ncx->blk_oldpm      = cx->blk_oldpm;
9264             ncx->blk_gimme      = cx->blk_gimme;
9265             switch (CxTYPE(cx)) {
9266             case CXt_SUB:
9267                 ncx->blk_sub.cv         = (cx->blk_sub.olddepth == 0
9268                                            ? cv_dup_inc(cx->blk_sub.cv, param)
9269                                            : cv_dup(cx->blk_sub.cv,param));
9270                 ncx->blk_sub.argarray   = (cx->blk_sub.hasargs
9271                                            ? av_dup_inc(cx->blk_sub.argarray, param)
9272                                            : Nullav);
9273                 ncx->blk_sub.savearray  = av_dup_inc(cx->blk_sub.savearray, param);
9274                 ncx->blk_sub.olddepth   = cx->blk_sub.olddepth;
9275                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
9276                 ncx->blk_sub.lval       = cx->blk_sub.lval;
9277                 break;
9278             case CXt_EVAL:
9279                 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9280                 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9281                 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);;
9282                 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9283                 ncx->blk_eval.cur_text  = sv_dup(cx->blk_eval.cur_text, param);
9284                 break;
9285             case CXt_LOOP:
9286                 ncx->blk_loop.label     = cx->blk_loop.label;
9287                 ncx->blk_loop.resetsp   = cx->blk_loop.resetsp;
9288                 ncx->blk_loop.redo_op   = cx->blk_loop.redo_op;
9289                 ncx->blk_loop.next_op   = cx->blk_loop.next_op;
9290                 ncx->blk_loop.last_op   = cx->blk_loop.last_op;
9291                 ncx->blk_loop.iterdata  = (CxPADLOOP(cx)
9292                                            ? cx->blk_loop.iterdata
9293                                            : gv_dup((GV*)cx->blk_loop.iterdata, param));
9294                 ncx->blk_loop.oldcurpad
9295                     = (SV**)ptr_table_fetch(PL_ptr_table,
9296                                             cx->blk_loop.oldcurpad);
9297                 ncx->blk_loop.itersave  = sv_dup_inc(cx->blk_loop.itersave, param);
9298                 ncx->blk_loop.iterlval  = sv_dup_inc(cx->blk_loop.iterlval, param);
9299                 ncx->blk_loop.iterary   = av_dup_inc(cx->blk_loop.iterary, param);
9300                 ncx->blk_loop.iterix    = cx->blk_loop.iterix;
9301                 ncx->blk_loop.itermax   = cx->blk_loop.itermax;
9302                 break;
9303             case CXt_FORMAT:
9304                 ncx->blk_sub.cv         = cv_dup(cx->blk_sub.cv, param);
9305                 ncx->blk_sub.gv         = gv_dup(cx->blk_sub.gv, param);
9306                 ncx->blk_sub.dfoutgv    = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9307                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
9308                 break;
9309             case CXt_BLOCK:
9310             case CXt_NULL:
9311                 break;
9312             }
9313         }
9314         --ix;
9315     }
9316     return ncxs;
9317 }
9318
9319 /* duplicate a stack info structure */
9320
9321 PERL_SI *
9322 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9323 {
9324     PERL_SI *nsi;
9325
9326     if (!si)
9327         return (PERL_SI*)NULL;
9328
9329     /* look for it in the table first */
9330     nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9331     if (nsi)
9332         return nsi;
9333
9334     /* create anew and remember what it is */
9335     Newz(56, nsi, 1, PERL_SI);
9336     ptr_table_store(PL_ptr_table, si, nsi);
9337
9338     nsi->si_stack       = av_dup_inc(si->si_stack, param);
9339     nsi->si_cxix        = si->si_cxix;
9340     nsi->si_cxmax       = si->si_cxmax;
9341     nsi->si_cxstack     = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9342     nsi->si_type        = si->si_type;
9343     nsi->si_prev        = si_dup(si->si_prev, param);
9344     nsi->si_next        = si_dup(si->si_next, param);
9345     nsi->si_markoff     = si->si_markoff;
9346
9347     return nsi;
9348 }
9349
9350 #define POPINT(ss,ix)   ((ss)[--(ix)].any_i32)
9351 #define TOPINT(ss,ix)   ((ss)[ix].any_i32)
9352 #define POPLONG(ss,ix)  ((ss)[--(ix)].any_long)
9353 #define TOPLONG(ss,ix)  ((ss)[ix].any_long)
9354 #define POPIV(ss,ix)    ((ss)[--(ix)].any_iv)
9355 #define TOPIV(ss,ix)    ((ss)[ix].any_iv)
9356 #define POPPTR(ss,ix)   ((ss)[--(ix)].any_ptr)
9357 #define TOPPTR(ss,ix)   ((ss)[ix].any_ptr)
9358 #define POPDPTR(ss,ix)  ((ss)[--(ix)].any_dptr)
9359 #define TOPDPTR(ss,ix)  ((ss)[ix].any_dptr)
9360 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9361 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9362
9363 /* XXXXX todo */
9364 #define pv_dup_inc(p)   SAVEPV(p)
9365 #define pv_dup(p)       SAVEPV(p)
9366 #define svp_dup_inc(p,pp)       any_dup(p,pp)
9367
9368 /* map any object to the new equivent - either something in the
9369  * ptr table, or something in the interpreter structure
9370  */
9371
9372 void *
9373 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
9374 {
9375     void *ret;
9376
9377     if (!v)
9378         return (void*)NULL;
9379
9380     /* look for it in the table first */
9381     ret = ptr_table_fetch(PL_ptr_table, v);
9382     if (ret)
9383         return ret;
9384
9385     /* see if it is part of the interpreter structure */
9386     if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9387         ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9388     else {
9389         ret = v;
9390     }
9391
9392     return ret;
9393 }
9394
9395 /* duplicate the save stack */
9396
9397 ANY *
9398 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9399 {
9400     ANY *ss     = proto_perl->Tsavestack;
9401     I32 ix      = proto_perl->Tsavestack_ix;
9402     I32 max     = proto_perl->Tsavestack_max;
9403     ANY *nss;
9404     SV *sv;
9405     GV *gv;
9406     AV *av;
9407     HV *hv;
9408     void* ptr;
9409     int intval;
9410     long longval;
9411     GP *gp;
9412     IV iv;
9413     I32 i;
9414     char *c = NULL;
9415     void (*dptr) (void*);
9416     void (*dxptr) (pTHX_ void*);
9417     OP *o;
9418
9419     Newz(54, nss, max, ANY);
9420
9421     while (ix > 0) {
9422         i = POPINT(ss,ix);
9423         TOPINT(nss,ix) = i;
9424         switch (i) {
9425         case SAVEt_ITEM:                        /* normal string */
9426             sv = (SV*)POPPTR(ss,ix);
9427             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9428             sv = (SV*)POPPTR(ss,ix);
9429             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9430             break;
9431         case SAVEt_SV:                          /* scalar reference */
9432             sv = (SV*)POPPTR(ss,ix);
9433             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9434             gv = (GV*)POPPTR(ss,ix);
9435             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9436             break;
9437         case SAVEt_GENERIC_PVREF:               /* generic char* */
9438             c = (char*)POPPTR(ss,ix);
9439             TOPPTR(nss,ix) = pv_dup(c);
9440             ptr = POPPTR(ss,ix);
9441             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9442             break;
9443         case SAVEt_SHARED_PVREF:                /* char* in shared space */
9444             c = (char*)POPPTR(ss,ix);
9445             TOPPTR(nss,ix) = savesharedpv(c);
9446             ptr = POPPTR(ss,ix);
9447             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9448             break;
9449         case SAVEt_GENERIC_SVREF:               /* generic sv */
9450         case SAVEt_SVREF:                       /* scalar reference */
9451             sv = (SV*)POPPTR(ss,ix);
9452             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9453             ptr = POPPTR(ss,ix);
9454             TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9455             break;
9456         case SAVEt_AV:                          /* array reference */
9457             av = (AV*)POPPTR(ss,ix);
9458             TOPPTR(nss,ix) = av_dup_inc(av, param);
9459             gv = (GV*)POPPTR(ss,ix);
9460             TOPPTR(nss,ix) = gv_dup(gv, param);
9461             break;
9462         case SAVEt_HV:                          /* hash reference */
9463             hv = (HV*)POPPTR(ss,ix);
9464             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9465             gv = (GV*)POPPTR(ss,ix);
9466             TOPPTR(nss,ix) = gv_dup(gv, param);
9467             break;
9468         case SAVEt_INT:                         /* int reference */
9469             ptr = POPPTR(ss,ix);
9470             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9471             intval = (int)POPINT(ss,ix);
9472             TOPINT(nss,ix) = intval;
9473             break;
9474         case SAVEt_LONG:                        /* long reference */
9475             ptr = POPPTR(ss,ix);
9476             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9477             longval = (long)POPLONG(ss,ix);
9478             TOPLONG(nss,ix) = longval;
9479             break;
9480         case SAVEt_I32:                         /* I32 reference */
9481         case SAVEt_I16:                         /* I16 reference */
9482         case SAVEt_I8:                          /* I8 reference */
9483             ptr = POPPTR(ss,ix);
9484             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9485             i = POPINT(ss,ix);
9486             TOPINT(nss,ix) = i;
9487             break;
9488         case SAVEt_IV:                          /* IV reference */
9489             ptr = POPPTR(ss,ix);
9490             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9491             iv = POPIV(ss,ix);
9492             TOPIV(nss,ix) = iv;
9493             break;
9494         case SAVEt_SPTR:                        /* SV* reference */
9495             ptr = POPPTR(ss,ix);
9496             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9497             sv = (SV*)POPPTR(ss,ix);
9498             TOPPTR(nss,ix) = sv_dup(sv, param);
9499             break;
9500         case SAVEt_VPTR:                        /* random* reference */
9501             ptr = POPPTR(ss,ix);
9502             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9503             ptr = POPPTR(ss,ix);
9504             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9505             break;
9506         case SAVEt_PPTR:                        /* char* reference */
9507             ptr = POPPTR(ss,ix);
9508             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9509             c = (char*)POPPTR(ss,ix);
9510             TOPPTR(nss,ix) = pv_dup(c);
9511             break;
9512         case SAVEt_HPTR:                        /* HV* reference */
9513             ptr = POPPTR(ss,ix);
9514             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9515             hv = (HV*)POPPTR(ss,ix);
9516             TOPPTR(nss,ix) = hv_dup(hv, param);
9517             break;
9518         case SAVEt_APTR:                        /* AV* reference */
9519             ptr = POPPTR(ss,ix);
9520             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9521             av = (AV*)POPPTR(ss,ix);
9522             TOPPTR(nss,ix) = av_dup(av, param);
9523             break;
9524         case SAVEt_NSTAB:
9525             gv = (GV*)POPPTR(ss,ix);
9526             TOPPTR(nss,ix) = gv_dup(gv, param);
9527             break;
9528         case SAVEt_GP:                          /* scalar reference */
9529             gp = (GP*)POPPTR(ss,ix);
9530             TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9531             (void)GpREFCNT_inc(gp);
9532             gv = (GV*)POPPTR(ss,ix);
9533             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9534             c = (char*)POPPTR(ss,ix);
9535             TOPPTR(nss,ix) = pv_dup(c);
9536             iv = POPIV(ss,ix);
9537             TOPIV(nss,ix) = iv;
9538             iv = POPIV(ss,ix);
9539             TOPIV(nss,ix) = iv;
9540             break;
9541         case SAVEt_FREESV:
9542         case SAVEt_MORTALIZESV:
9543             sv = (SV*)POPPTR(ss,ix);
9544             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9545             break;
9546         case SAVEt_FREEOP:
9547             ptr = POPPTR(ss,ix);
9548             if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9549                 /* these are assumed to be refcounted properly */
9550                 switch (((OP*)ptr)->op_type) {
9551                 case OP_LEAVESUB:
9552                 case OP_LEAVESUBLV:
9553                 case OP_LEAVEEVAL:
9554                 case OP_LEAVE:
9555                 case OP_SCOPE:
9556                 case OP_LEAVEWRITE:
9557                     TOPPTR(nss,ix) = ptr;
9558                     o = (OP*)ptr;
9559                     OpREFCNT_inc(o);
9560                     break;
9561                 default:
9562                     TOPPTR(nss,ix) = Nullop;
9563                     break;
9564                 }
9565             }
9566             else
9567                 TOPPTR(nss,ix) = Nullop;
9568             break;
9569         case SAVEt_FREEPV:
9570             c = (char*)POPPTR(ss,ix);
9571             TOPPTR(nss,ix) = pv_dup_inc(c);
9572             break;
9573         case SAVEt_CLEARSV:
9574             longval = POPLONG(ss,ix);
9575             TOPLONG(nss,ix) = longval;
9576             break;
9577         case SAVEt_DELETE:
9578             hv = (HV*)POPPTR(ss,ix);
9579             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9580             c = (char*)POPPTR(ss,ix);
9581             TOPPTR(nss,ix) = pv_dup_inc(c);
9582             i = POPINT(ss,ix);
9583             TOPINT(nss,ix) = i;
9584             break;
9585         case SAVEt_DESTRUCTOR:
9586             ptr = POPPTR(ss,ix);
9587             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
9588             dptr = POPDPTR(ss,ix);
9589             TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
9590             break;
9591         case SAVEt_DESTRUCTOR_X:
9592             ptr = POPPTR(ss,ix);
9593             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
9594             dxptr = POPDXPTR(ss,ix);
9595             TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
9596             break;
9597         case SAVEt_REGCONTEXT:
9598         case SAVEt_ALLOC:
9599             i = POPINT(ss,ix);
9600             TOPINT(nss,ix) = i;
9601             ix -= i;
9602             break;
9603         case SAVEt_STACK_POS:           /* Position on Perl stack */
9604             i = POPINT(ss,ix);
9605             TOPINT(nss,ix) = i;
9606             break;
9607         case SAVEt_AELEM:               /* array element */
9608             sv = (SV*)POPPTR(ss,ix);
9609             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9610             i = POPINT(ss,ix);
9611             TOPINT(nss,ix) = i;
9612             av = (AV*)POPPTR(ss,ix);
9613             TOPPTR(nss,ix) = av_dup_inc(av, param);
9614             break;
9615         case SAVEt_HELEM:               /* hash element */
9616             sv = (SV*)POPPTR(ss,ix);
9617             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9618             sv = (SV*)POPPTR(ss,ix);
9619             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9620             hv = (HV*)POPPTR(ss,ix);
9621             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9622             break;
9623         case SAVEt_OP:
9624             ptr = POPPTR(ss,ix);
9625             TOPPTR(nss,ix) = ptr;
9626             break;
9627         case SAVEt_HINTS:
9628             i = POPINT(ss,ix);
9629             TOPINT(nss,ix) = i;
9630             break;
9631         case SAVEt_COMPPAD:
9632             av = (AV*)POPPTR(ss,ix);
9633             TOPPTR(nss,ix) = av_dup(av, param);
9634             break;
9635         case SAVEt_PADSV:
9636             longval = (long)POPLONG(ss,ix);
9637             TOPLONG(nss,ix) = longval;
9638             ptr = POPPTR(ss,ix);
9639             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9640             sv = (SV*)POPPTR(ss,ix);
9641             TOPPTR(nss,ix) = sv_dup(sv, param);
9642             break;
9643         default:
9644             Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9645         }
9646     }
9647
9648     return nss;
9649 }
9650
9651 /*
9652 =for apidoc perl_clone
9653
9654 Create and return a new interpreter by cloning the current one.
9655
9656 =cut
9657 */
9658
9659 /* XXX the above needs expanding by someone who actually understands it ! */
9660 EXTERN_C PerlInterpreter *
9661 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
9662
9663 PerlInterpreter *
9664 perl_clone(PerlInterpreter *proto_perl, UV flags)
9665 {
9666 #ifdef PERL_IMPLICIT_SYS
9667
9668    /* perlhost.h so we need to call into it
9669    to clone the host, CPerlHost should have a c interface, sky */
9670
9671    if (flags & CLONEf_CLONE_HOST) {
9672        return perl_clone_host(proto_perl,flags);
9673    }
9674    return perl_clone_using(proto_perl, flags,
9675                             proto_perl->IMem,
9676                             proto_perl->IMemShared,
9677                             proto_perl->IMemParse,
9678                             proto_perl->IEnv,
9679                             proto_perl->IStdIO,
9680                             proto_perl->ILIO,
9681                             proto_perl->IDir,
9682                             proto_perl->ISock,
9683                             proto_perl->IProc);
9684 }
9685
9686 PerlInterpreter *
9687 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
9688                  struct IPerlMem* ipM, struct IPerlMem* ipMS,
9689                  struct IPerlMem* ipMP, struct IPerlEnv* ipE,
9690                  struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
9691                  struct IPerlDir* ipD, struct IPerlSock* ipS,
9692                  struct IPerlProc* ipP)
9693 {
9694     /* XXX many of the string copies here can be optimized if they're
9695      * constants; they need to be allocated as common memory and just
9696      * their pointers copied. */
9697
9698     IV i;
9699     CLONE_PARAMS clone_params;
9700     CLONE_PARAMS* param = &clone_params;
9701
9702     PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
9703     PERL_SET_THX(my_perl);
9704
9705 #  ifdef DEBUGGING
9706     memset(my_perl, 0xab, sizeof(PerlInterpreter));
9707     PL_markstack = 0;
9708     PL_scopestack = 0;
9709     PL_savestack = 0;
9710     PL_retstack = 0;
9711     PL_sig_pending = 0;
9712     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
9713 #  else /* !DEBUGGING */
9714     Zero(my_perl, 1, PerlInterpreter);
9715 #  endif        /* DEBUGGING */
9716
9717     /* host pointers */
9718     PL_Mem              = ipM;
9719     PL_MemShared        = ipMS;
9720     PL_MemParse         = ipMP;
9721     PL_Env              = ipE;
9722     PL_StdIO            = ipStd;
9723     PL_LIO              = ipLIO;
9724     PL_Dir              = ipD;
9725     PL_Sock             = ipS;
9726     PL_Proc             = ipP;
9727 #else           /* !PERL_IMPLICIT_SYS */
9728     IV i;
9729     CLONE_PARAMS clone_params;
9730     CLONE_PARAMS* param = &clone_params;
9731     PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
9732     PERL_SET_THX(my_perl);
9733
9734
9735
9736 #    ifdef DEBUGGING
9737     memset(my_perl, 0xab, sizeof(PerlInterpreter));
9738     PL_markstack = 0;
9739     PL_scopestack = 0;
9740     PL_savestack = 0;
9741     PL_retstack = 0;
9742     PL_sig_pending = 0;
9743     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
9744 #    else       /* !DEBUGGING */
9745     Zero(my_perl, 1, PerlInterpreter);
9746 #    endif      /* DEBUGGING */
9747 #endif          /* PERL_IMPLICIT_SYS */
9748     param->flags = flags;
9749
9750     /* arena roots */
9751     PL_xiv_arenaroot    = NULL;
9752     PL_xiv_root         = NULL;
9753     PL_xnv_arenaroot    = NULL;
9754     PL_xnv_root         = NULL;
9755     PL_xrv_arenaroot    = NULL;
9756     PL_xrv_root         = NULL;
9757     PL_xpv_arenaroot    = NULL;
9758     PL_xpv_root         = NULL;
9759     PL_xpviv_arenaroot  = NULL;
9760     PL_xpviv_root       = NULL;
9761     PL_xpvnv_arenaroot  = NULL;
9762     PL_xpvnv_root       = NULL;
9763     PL_xpvcv_arenaroot  = NULL;
9764     PL_xpvcv_root       = NULL;
9765     PL_xpvav_arenaroot  = NULL;
9766     PL_xpvav_root       = NULL;
9767     PL_xpvhv_arenaroot  = NULL;
9768     PL_xpvhv_root       = NULL;
9769     PL_xpvmg_arenaroot  = NULL;
9770     PL_xpvmg_root       = NULL;
9771     PL_xpvlv_arenaroot  = NULL;
9772     PL_xpvlv_root       = NULL;
9773     PL_xpvbm_arenaroot  = NULL;
9774     PL_xpvbm_root       = NULL;
9775     PL_he_arenaroot     = NULL;
9776     PL_he_root          = NULL;
9777     PL_nice_chunk       = NULL;
9778     PL_nice_chunk_size  = 0;
9779     PL_sv_count         = 0;
9780     PL_sv_objcount      = 0;
9781     PL_sv_root          = Nullsv;
9782     PL_sv_arenaroot     = Nullsv;
9783
9784     PL_debug            = proto_perl->Idebug;
9785
9786 #ifdef USE_REENTRANT_API
9787     New(31337, PL_reentrant_buffer,1, REBUF);
9788     New(31337, PL_reentrant_buffer->tmbuff,1, struct tm);
9789 #endif
9790
9791     /* create SV map for pointer relocation */
9792     PL_ptr_table = ptr_table_new();
9793
9794     /* initialize these special pointers as early as possible */
9795     SvANY(&PL_sv_undef)         = NULL;
9796     SvREFCNT(&PL_sv_undef)      = (~(U32)0)/2;
9797     SvFLAGS(&PL_sv_undef)       = SVf_READONLY|SVt_NULL;
9798     ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
9799
9800     SvANY(&PL_sv_no)            = new_XPVNV();
9801     SvREFCNT(&PL_sv_no)         = (~(U32)0)/2;
9802     SvFLAGS(&PL_sv_no)          = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
9803     SvPVX(&PL_sv_no)            = SAVEPVN(PL_No, 0);
9804     SvCUR(&PL_sv_no)            = 0;
9805     SvLEN(&PL_sv_no)            = 1;
9806     SvNVX(&PL_sv_no)            = 0;
9807     ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
9808
9809     SvANY(&PL_sv_yes)           = new_XPVNV();
9810     SvREFCNT(&PL_sv_yes)        = (~(U32)0)/2;
9811     SvFLAGS(&PL_sv_yes)         = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
9812     SvPVX(&PL_sv_yes)           = SAVEPVN(PL_Yes, 1);
9813     SvCUR(&PL_sv_yes)           = 1;
9814     SvLEN(&PL_sv_yes)           = 2;
9815     SvNVX(&PL_sv_yes)           = 1;
9816     ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
9817
9818     /* create (a non-shared!) shared string table */
9819     PL_strtab           = newHV();
9820     HvSHAREKEYS_off(PL_strtab);
9821     hv_ksplit(PL_strtab, 512);
9822     ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
9823
9824     PL_compiling = proto_perl->Icompiling;
9825
9826     /* These two PVs will be free'd special way so must set them same way op.c does */
9827     PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
9828     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
9829
9830     PL_compiling.cop_file    = savesharedpv(PL_compiling.cop_file);
9831     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
9832
9833     ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
9834     if (!specialWARN(PL_compiling.cop_warnings))
9835         PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
9836     if (!specialCopIO(PL_compiling.cop_io))
9837         PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
9838     PL_curcop           = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
9839
9840     /* pseudo environmental stuff */
9841     PL_origargc         = proto_perl->Iorigargc;
9842     i = PL_origargc;
9843     New(0, PL_origargv, i+1, char*);
9844     PL_origargv[i] = '\0';
9845     while (i-- > 0) {
9846         PL_origargv[i]  = SAVEPV(proto_perl->Iorigargv[i]);
9847     }
9848
9849     param->stashes      = newAV();  /* Setup array of objects to call clone on */
9850
9851 #ifdef PERLIO_LAYERS
9852     /* Clone PerlIO tables as soon as we can handle general xx_dup() */
9853     PerlIO_clone(aTHX_ proto_perl, param);
9854 #endif
9855
9856     PL_envgv            = gv_dup(proto_perl->Ienvgv, param);
9857     PL_incgv            = gv_dup(proto_perl->Iincgv, param);
9858     PL_hintgv           = gv_dup(proto_perl->Ihintgv, param);
9859     PL_origfilename     = SAVEPV(proto_perl->Iorigfilename);
9860     PL_diehook          = sv_dup_inc(proto_perl->Idiehook, param);
9861     PL_warnhook         = sv_dup_inc(proto_perl->Iwarnhook, param);
9862
9863     /* switches */
9864     PL_minus_c          = proto_perl->Iminus_c;
9865     PL_patchlevel       = sv_dup_inc(proto_perl->Ipatchlevel, param);
9866     PL_localpatches     = proto_perl->Ilocalpatches;
9867     PL_splitstr         = proto_perl->Isplitstr;
9868     PL_preprocess       = proto_perl->Ipreprocess;
9869     PL_minus_n          = proto_perl->Iminus_n;
9870     PL_minus_p          = proto_perl->Iminus_p;
9871     PL_minus_l          = proto_perl->Iminus_l;
9872     PL_minus_a          = proto_perl->Iminus_a;
9873     PL_minus_F          = proto_perl->Iminus_F;
9874     PL_doswitches       = proto_perl->Idoswitches;
9875     PL_dowarn           = proto_perl->Idowarn;
9876     PL_doextract        = proto_perl->Idoextract;
9877     PL_sawampersand     = proto_perl->Isawampersand;
9878     PL_unsafe           = proto_perl->Iunsafe;
9879     PL_inplace          = SAVEPV(proto_perl->Iinplace);
9880     PL_e_script         = sv_dup_inc(proto_perl->Ie_script, param);
9881     PL_perldb           = proto_perl->Iperldb;
9882     PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
9883     PL_exit_flags       = proto_perl->Iexit_flags;
9884
9885     /* magical thingies */
9886     /* XXX time(&PL_basetime) when asked for? */
9887     PL_basetime         = proto_perl->Ibasetime;
9888     PL_formfeed         = sv_dup(proto_perl->Iformfeed, param);
9889
9890     PL_maxsysfd         = proto_perl->Imaxsysfd;
9891     PL_multiline        = proto_perl->Imultiline;
9892     PL_statusvalue      = proto_perl->Istatusvalue;
9893 #ifdef VMS
9894     PL_statusvalue_vms  = proto_perl->Istatusvalue_vms;
9895 #endif
9896     PL_encoding         = sv_dup(proto_perl->Iencoding, param);
9897
9898     /* Clone the regex array */
9899     PL_regex_padav = newAV();
9900     {
9901         I32 len = av_len((AV*)proto_perl->Iregex_padav);
9902         SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
9903         av_push(PL_regex_padav,
9904                 sv_dup_inc(regexen[0],param));
9905         for(i = 1; i <= len; i++) {
9906             if(SvREPADTMP(regexen[i])) {
9907               av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
9908             } else {
9909                 av_push(PL_regex_padav,
9910                     SvREFCNT_inc(
9911                         newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
9912                              SvIVX(regexen[i])), param)))
9913                        ));
9914             }
9915         }
9916     }
9917     PL_regex_pad = AvARRAY(PL_regex_padav);
9918
9919     /* shortcuts to various I/O objects */
9920     PL_stdingv          = gv_dup(proto_perl->Istdingv, param);
9921     PL_stderrgv         = gv_dup(proto_perl->Istderrgv, param);
9922     PL_defgv            = gv_dup(proto_perl->Idefgv, param);
9923     PL_argvgv           = gv_dup(proto_perl->Iargvgv, param);
9924     PL_argvoutgv        = gv_dup(proto_perl->Iargvoutgv, param);
9925     PL_argvout_stack    = av_dup_inc(proto_perl->Iargvout_stack, param);
9926
9927     /* shortcuts to regexp stuff */
9928     PL_replgv           = gv_dup(proto_perl->Ireplgv, param);
9929
9930     /* shortcuts to misc objects */
9931     PL_errgv            = gv_dup(proto_perl->Ierrgv, param);
9932
9933     /* shortcuts to debugging objects */
9934     PL_DBgv             = gv_dup(proto_perl->IDBgv, param);
9935     PL_DBline           = gv_dup(proto_perl->IDBline, param);
9936     PL_DBsub            = gv_dup(proto_perl->IDBsub, param);
9937     PL_DBsingle         = sv_dup(proto_perl->IDBsingle, param);
9938     PL_DBtrace          = sv_dup(proto_perl->IDBtrace, param);
9939     PL_DBsignal         = sv_dup(proto_perl->IDBsignal, param);
9940     PL_lineary          = av_dup(proto_perl->Ilineary, param);
9941     PL_dbargs           = av_dup(proto_perl->Idbargs, param);
9942
9943     /* symbol tables */
9944     PL_defstash         = hv_dup_inc(proto_perl->Tdefstash, param);
9945     PL_curstash         = hv_dup(proto_perl->Tcurstash, param);
9946     PL_nullstash       = hv_dup(proto_perl->Inullstash, param);
9947     PL_debstash         = hv_dup(proto_perl->Idebstash, param);
9948     PL_globalstash      = hv_dup(proto_perl->Iglobalstash, param);
9949     PL_curstname        = sv_dup_inc(proto_perl->Icurstname, param);
9950
9951     PL_beginav          = av_dup_inc(proto_perl->Ibeginav, param);
9952     PL_beginav_save     = av_dup_inc(proto_perl->Ibeginav_save, param);
9953     PL_endav            = av_dup_inc(proto_perl->Iendav, param);
9954     PL_checkav          = av_dup_inc(proto_perl->Icheckav, param);
9955     PL_initav           = av_dup_inc(proto_perl->Iinitav, param);
9956
9957     PL_sub_generation   = proto_perl->Isub_generation;
9958
9959     /* funky return mechanisms */
9960     PL_forkprocess      = proto_perl->Iforkprocess;
9961
9962     /* subprocess state */
9963     PL_fdpid            = av_dup_inc(proto_perl->Ifdpid, param);
9964
9965     /* internal state */
9966     PL_tainting         = proto_perl->Itainting;
9967     PL_maxo             = proto_perl->Imaxo;
9968     if (proto_perl->Iop_mask)
9969         PL_op_mask      = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
9970     else
9971         PL_op_mask      = Nullch;
9972
9973     /* current interpreter roots */
9974     PL_main_cv          = cv_dup_inc(proto_perl->Imain_cv, param);
9975     PL_main_root        = OpREFCNT_inc(proto_perl->Imain_root);
9976     PL_main_start       = proto_perl->Imain_start;
9977     PL_eval_root        = proto_perl->Ieval_root;
9978     PL_eval_start       = proto_perl->Ieval_start;
9979
9980     /* runtime control stuff */
9981     PL_curcopdb         = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
9982     PL_copline          = proto_perl->Icopline;
9983
9984     PL_filemode         = proto_perl->Ifilemode;
9985     PL_lastfd           = proto_perl->Ilastfd;
9986     PL_oldname          = proto_perl->Ioldname;         /* XXX not quite right */
9987     PL_Argv             = NULL;
9988     PL_Cmd              = Nullch;
9989     PL_gensym           = proto_perl->Igensym;
9990     PL_preambled        = proto_perl->Ipreambled;
9991     PL_preambleav       = av_dup_inc(proto_perl->Ipreambleav, param);
9992     PL_laststatval      = proto_perl->Ilaststatval;
9993     PL_laststype        = proto_perl->Ilaststype;
9994     PL_mess_sv          = Nullsv;
9995
9996     PL_ors_sv           = sv_dup_inc(proto_perl->Iors_sv, param);
9997     PL_ofmt             = SAVEPV(proto_perl->Iofmt);
9998
9999     /* interpreter atexit processing */
10000     PL_exitlistlen      = proto_perl->Iexitlistlen;
10001     if (PL_exitlistlen) {
10002         New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10003         Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10004     }
10005     else
10006         PL_exitlist     = (PerlExitListEntry*)NULL;
10007     PL_modglobal        = hv_dup_inc(proto_perl->Imodglobal, param);
10008     PL_custom_op_names  = hv_dup_inc(proto_perl->Icustom_op_names,param);
10009     PL_custom_op_descs  = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10010
10011     PL_profiledata      = NULL;
10012     PL_rsfp             = fp_dup(proto_perl->Irsfp, '<', param);
10013     /* PL_rsfp_filters entries have fake IoDIRP() */
10014     PL_rsfp_filters     = av_dup_inc(proto_perl->Irsfp_filters, param);
10015
10016     PL_compcv                   = cv_dup(proto_perl->Icompcv, param);
10017     PL_comppad                  = av_dup(proto_perl->Icomppad, param);
10018     PL_comppad_name             = av_dup(proto_perl->Icomppad_name, param);
10019     PL_comppad_name_fill        = proto_perl->Icomppad_name_fill;
10020     PL_comppad_name_floor       = proto_perl->Icomppad_name_floor;
10021     PL_curpad                   = (SV**)ptr_table_fetch(PL_ptr_table,
10022                                                         proto_perl->Tcurpad);
10023
10024 #ifdef HAVE_INTERP_INTERN
10025     sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10026 #endif
10027
10028     /* more statics moved here */
10029     PL_generation       = proto_perl->Igeneration;
10030     PL_DBcv             = cv_dup(proto_perl->IDBcv, param);
10031
10032     PL_in_clean_objs    = proto_perl->Iin_clean_objs;
10033     PL_in_clean_all     = proto_perl->Iin_clean_all;
10034
10035     PL_uid              = proto_perl->Iuid;
10036     PL_euid             = proto_perl->Ieuid;
10037     PL_gid              = proto_perl->Igid;
10038     PL_egid             = proto_perl->Iegid;
10039     PL_nomemok          = proto_perl->Inomemok;
10040     PL_an               = proto_perl->Ian;
10041     PL_cop_seqmax       = proto_perl->Icop_seqmax;
10042     PL_op_seqmax        = proto_perl->Iop_seqmax;
10043     PL_evalseq          = proto_perl->Ievalseq;
10044     PL_origenviron      = proto_perl->Iorigenviron;     /* XXX not quite right */
10045     PL_origalen         = proto_perl->Iorigalen;
10046     PL_pidstatus        = newHV();                      /* XXX flag for cloning? */
10047     PL_osname           = SAVEPV(proto_perl->Iosname);
10048     PL_sh_path          = proto_perl->Ish_path; /* XXX never deallocated */
10049     PL_sighandlerp      = proto_perl->Isighandlerp;
10050
10051
10052     PL_runops           = proto_perl->Irunops;
10053
10054     Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10055
10056 #ifdef CSH
10057     PL_cshlen           = proto_perl->Icshlen;
10058     PL_cshname          = proto_perl->Icshname; /* XXX never deallocated */
10059 #endif
10060
10061     PL_lex_state        = proto_perl->Ilex_state;
10062     PL_lex_defer        = proto_perl->Ilex_defer;
10063     PL_lex_expect       = proto_perl->Ilex_expect;
10064     PL_lex_formbrack    = proto_perl->Ilex_formbrack;
10065     PL_lex_dojoin       = proto_perl->Ilex_dojoin;
10066     PL_lex_starts       = proto_perl->Ilex_starts;
10067     PL_lex_stuff        = sv_dup_inc(proto_perl->Ilex_stuff, param);
10068     PL_lex_repl         = sv_dup_inc(proto_perl->Ilex_repl, param);
10069     PL_lex_op           = proto_perl->Ilex_op;
10070     PL_lex_inpat        = proto_perl->Ilex_inpat;
10071     PL_lex_inwhat       = proto_perl->Ilex_inwhat;
10072     PL_lex_brackets     = proto_perl->Ilex_brackets;
10073     i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10074     PL_lex_brackstack   = SAVEPVN(proto_perl->Ilex_brackstack,i);
10075     PL_lex_casemods     = proto_perl->Ilex_casemods;
10076     i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10077     PL_lex_casestack    = SAVEPVN(proto_perl->Ilex_casestack,i);
10078
10079     Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10080     Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10081     PL_nexttoke         = proto_perl->Inexttoke;
10082
10083     PL_linestr          = sv_dup_inc(proto_perl->Ilinestr, param);
10084     i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
10085     PL_bufptr           = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10086     i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
10087     PL_oldbufptr        = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10088     i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
10089     PL_oldoldbufptr     = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10090     PL_bufend           = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10091     i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
10092     PL_linestart        = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10093     PL_pending_ident    = proto_perl->Ipending_ident;
10094     PL_sublex_info      = proto_perl->Isublex_info;     /* XXX not quite right */
10095
10096     PL_expect           = proto_perl->Iexpect;
10097
10098     PL_multi_start      = proto_perl->Imulti_start;
10099     PL_multi_end        = proto_perl->Imulti_end;
10100     PL_multi_open       = proto_perl->Imulti_open;
10101     PL_multi_close      = proto_perl->Imulti_close;
10102
10103     PL_error_count      = proto_perl->Ierror_count;
10104     PL_subline          = proto_perl->Isubline;
10105     PL_subname          = sv_dup_inc(proto_perl->Isubname, param);
10106
10107     PL_min_intro_pending        = proto_perl->Imin_intro_pending;
10108     PL_max_intro_pending        = proto_perl->Imax_intro_pending;
10109     PL_padix                    = proto_perl->Ipadix;
10110     PL_padix_floor              = proto_perl->Ipadix_floor;
10111     PL_pad_reset_pending        = proto_perl->Ipad_reset_pending;
10112
10113     i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
10114     PL_last_uni         = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10115     i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
10116     PL_last_lop         = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10117     PL_last_lop_op      = proto_perl->Ilast_lop_op;
10118     PL_in_my            = proto_perl->Iin_my;
10119     PL_in_my_stash      = hv_dup(proto_perl->Iin_my_stash, param);
10120 #ifdef FCRYPT
10121     PL_cryptseen        = proto_perl->Icryptseen;
10122 #endif
10123
10124     PL_hints            = proto_perl->Ihints;
10125
10126     PL_amagic_generation        = proto_perl->Iamagic_generation;
10127
10128 #ifdef USE_LOCALE_COLLATE
10129     PL_collation_ix     = proto_perl->Icollation_ix;
10130     PL_collation_name   = SAVEPV(proto_perl->Icollation_name);
10131     PL_collation_standard       = proto_perl->Icollation_standard;
10132     PL_collxfrm_base    = proto_perl->Icollxfrm_base;
10133     PL_collxfrm_mult    = proto_perl->Icollxfrm_mult;
10134 #endif /* USE_LOCALE_COLLATE */
10135
10136 #ifdef USE_LOCALE_NUMERIC
10137     PL_numeric_name     = SAVEPV(proto_perl->Inumeric_name);
10138     PL_numeric_standard = proto_perl->Inumeric_standard;
10139     PL_numeric_local    = proto_perl->Inumeric_local;
10140     PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10141 #endif /* !USE_LOCALE_NUMERIC */
10142
10143     /* utf8 character classes */
10144     PL_utf8_alnum       = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10145     PL_utf8_alnumc      = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10146     PL_utf8_ascii       = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10147     PL_utf8_alpha       = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10148     PL_utf8_space       = sv_dup_inc(proto_perl->Iutf8_space, param);
10149     PL_utf8_cntrl       = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10150     PL_utf8_graph       = sv_dup_inc(proto_perl->Iutf8_graph, param);
10151     PL_utf8_digit       = sv_dup_inc(proto_perl->Iutf8_digit, param);
10152     PL_utf8_upper       = sv_dup_inc(proto_perl->Iutf8_upper, param);
10153     PL_utf8_lower       = sv_dup_inc(proto_perl->Iutf8_lower, param);
10154     PL_utf8_print       = sv_dup_inc(proto_perl->Iutf8_print, param);
10155     PL_utf8_punct       = sv_dup_inc(proto_perl->Iutf8_punct, param);
10156     PL_utf8_xdigit      = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10157     PL_utf8_mark        = sv_dup_inc(proto_perl->Iutf8_mark, param);
10158     PL_utf8_toupper     = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10159     PL_utf8_totitle     = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10160     PL_utf8_tolower     = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10161     PL_utf8_tofold      = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10162
10163     /* swatch cache */
10164     PL_last_swash_hv    = Nullhv;       /* reinits on demand */
10165     PL_last_swash_klen  = 0;
10166     PL_last_swash_key[0]= '\0';
10167     PL_last_swash_tmps  = (U8*)NULL;
10168     PL_last_swash_slen  = 0;
10169
10170     /* perly.c globals */
10171     PL_yydebug          = proto_perl->Iyydebug;
10172     PL_yynerrs          = proto_perl->Iyynerrs;
10173     PL_yyerrflag        = proto_perl->Iyyerrflag;
10174     PL_yychar           = proto_perl->Iyychar;
10175     PL_yyval            = proto_perl->Iyyval;
10176     PL_yylval           = proto_perl->Iyylval;
10177
10178     PL_glob_index       = proto_perl->Iglob_index;
10179     PL_srand_called     = proto_perl->Isrand_called;
10180     PL_uudmap['M']      = 0;            /* reinits on demand */
10181     PL_bitcount         = Nullch;       /* reinits on demand */
10182
10183     if (proto_perl->Ipsig_pend) {
10184         Newz(0, PL_psig_pend, SIG_SIZE, int);
10185     }
10186     else {
10187         PL_psig_pend    = (int*)NULL;
10188     }
10189
10190     if (proto_perl->Ipsig_ptr) {
10191         Newz(0, PL_psig_ptr,  SIG_SIZE, SV*);
10192         Newz(0, PL_psig_name, SIG_SIZE, SV*);
10193         for (i = 1; i < SIG_SIZE; i++) {
10194             PL_psig_ptr[i]  = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10195             PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10196         }
10197     }
10198     else {
10199         PL_psig_ptr     = (SV**)NULL;
10200         PL_psig_name    = (SV**)NULL;
10201     }
10202
10203     /* thrdvar.h stuff */
10204
10205     if (flags & CLONEf_COPY_STACKS) {
10206         /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10207         PL_tmps_ix              = proto_perl->Ttmps_ix;
10208         PL_tmps_max             = proto_perl->Ttmps_max;
10209         PL_tmps_floor           = proto_perl->Ttmps_floor;
10210         Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
10211         i = 0;
10212         while (i <= PL_tmps_ix) {
10213             PL_tmps_stack[i]    = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10214             ++i;
10215         }
10216
10217         /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10218         i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10219         Newz(54, PL_markstack, i, I32);
10220         PL_markstack_max        = PL_markstack + (proto_perl->Tmarkstack_max
10221                                                   - proto_perl->Tmarkstack);
10222         PL_markstack_ptr        = PL_markstack + (proto_perl->Tmarkstack_ptr
10223                                                   - proto_perl->Tmarkstack);
10224         Copy(proto_perl->Tmarkstack, PL_markstack,
10225              PL_markstack_ptr - PL_markstack + 1, I32);
10226
10227         /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10228          * NOTE: unlike the others! */
10229         PL_scopestack_ix        = proto_perl->Tscopestack_ix;
10230         PL_scopestack_max       = proto_perl->Tscopestack_max;
10231         Newz(54, PL_scopestack, PL_scopestack_max, I32);
10232         Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10233
10234         /* next push_return() sets PL_retstack[PL_retstack_ix]
10235          * NOTE: unlike the others! */
10236         PL_retstack_ix          = proto_perl->Tretstack_ix;
10237         PL_retstack_max         = proto_perl->Tretstack_max;
10238         Newz(54, PL_retstack, PL_retstack_max, OP*);
10239         Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, I32);
10240
10241         /* NOTE: si_dup() looks at PL_markstack */
10242         PL_curstackinfo         = si_dup(proto_perl->Tcurstackinfo, param);
10243
10244         /* PL_curstack          = PL_curstackinfo->si_stack; */
10245         PL_curstack             = av_dup(proto_perl->Tcurstack, param);
10246         PL_mainstack            = av_dup(proto_perl->Tmainstack, param);
10247
10248         /* next PUSHs() etc. set *(PL_stack_sp+1) */
10249         PL_stack_base           = AvARRAY(PL_curstack);
10250         PL_stack_sp             = PL_stack_base + (proto_perl->Tstack_sp
10251                                                    - proto_perl->Tstack_base);
10252         PL_stack_max            = PL_stack_base + AvMAX(PL_curstack);
10253
10254         /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10255          * NOTE: unlike the others! */
10256         PL_savestack_ix         = proto_perl->Tsavestack_ix;
10257         PL_savestack_max        = proto_perl->Tsavestack_max;
10258         /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
10259         PL_savestack            = ss_dup(proto_perl, param);
10260     }
10261     else {
10262         init_stacks();
10263         ENTER;                  /* perl_destruct() wants to LEAVE; */
10264     }
10265
10266     PL_start_env        = proto_perl->Tstart_env;       /* XXXXXX */
10267     PL_top_env          = &PL_start_env;
10268
10269     PL_op               = proto_perl->Top;
10270
10271     PL_Sv               = Nullsv;
10272     PL_Xpv              = (XPV*)NULL;
10273     PL_na               = proto_perl->Tna;
10274
10275     PL_statbuf          = proto_perl->Tstatbuf;
10276     PL_statcache        = proto_perl->Tstatcache;
10277     PL_statgv           = gv_dup(proto_perl->Tstatgv, param);
10278     PL_statname         = sv_dup_inc(proto_perl->Tstatname, param);
10279 #ifdef HAS_TIMES
10280     PL_timesbuf         = proto_perl->Ttimesbuf;
10281 #endif
10282
10283     PL_tainted          = proto_perl->Ttainted;
10284     PL_curpm            = proto_perl->Tcurpm;   /* XXX No PMOP ref count */
10285     PL_rs               = sv_dup_inc(proto_perl->Trs, param);
10286     PL_last_in_gv       = gv_dup(proto_perl->Tlast_in_gv, param);
10287     PL_ofs_sv           = sv_dup_inc(proto_perl->Tofs_sv, param);
10288     PL_defoutgv         = gv_dup_inc(proto_perl->Tdefoutgv, param);
10289     PL_chopset          = proto_perl->Tchopset; /* XXX never deallocated */
10290     PL_toptarget        = sv_dup_inc(proto_perl->Ttoptarget, param);
10291     PL_bodytarget       = sv_dup_inc(proto_perl->Tbodytarget, param);
10292     PL_formtarget       = sv_dup(proto_perl->Tformtarget, param);
10293
10294     PL_restartop        = proto_perl->Trestartop;
10295     PL_in_eval          = proto_perl->Tin_eval;
10296     PL_delaymagic       = proto_perl->Tdelaymagic;
10297     PL_dirty            = proto_perl->Tdirty;
10298     PL_localizing       = proto_perl->Tlocalizing;
10299
10300 #ifdef PERL_FLEXIBLE_EXCEPTIONS
10301     PL_protect          = proto_perl->Tprotect;
10302 #endif
10303     PL_errors           = sv_dup_inc(proto_perl->Terrors, param);
10304     PL_av_fetch_sv      = Nullsv;
10305     PL_hv_fetch_sv      = Nullsv;
10306     Zero(&PL_hv_fetch_ent_mh, 1, HE);                   /* XXX */
10307     PL_modcount         = proto_perl->Tmodcount;
10308     PL_lastgotoprobe    = Nullop;
10309     PL_dumpindent       = proto_perl->Tdumpindent;
10310
10311     PL_sortcop          = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10312     PL_sortstash        = hv_dup(proto_perl->Tsortstash, param);
10313     PL_firstgv          = gv_dup(proto_perl->Tfirstgv, param);
10314     PL_secondgv         = gv_dup(proto_perl->Tsecondgv, param);
10315     PL_sortcxix         = proto_perl->Tsortcxix;
10316     PL_efloatbuf        = Nullch;               /* reinits on demand */
10317     PL_efloatsize       = 0;                    /* reinits on demand */
10318
10319     /* regex stuff */
10320
10321     PL_screamfirst      = NULL;
10322     PL_screamnext       = NULL;
10323     PL_maxscream        = -1;                   /* reinits on demand */
10324     PL_lastscream       = Nullsv;
10325
10326     PL_watchaddr        = NULL;
10327     PL_watchok          = Nullch;
10328
10329     PL_regdummy         = proto_perl->Tregdummy;
10330     PL_regcomp_parse    = Nullch;
10331     PL_regxend          = Nullch;
10332     PL_regcode          = (regnode*)NULL;
10333     PL_regnaughty       = 0;
10334     PL_regsawback       = 0;
10335     PL_regprecomp       = Nullch;
10336     PL_regnpar          = 0;
10337     PL_regsize          = 0;
10338     PL_regflags         = 0;
10339     PL_regseen          = 0;
10340     PL_seen_zerolen     = 0;
10341     PL_seen_evals       = 0;
10342     PL_regcomp_rx       = (regexp*)NULL;
10343     PL_extralen         = 0;
10344     PL_colorset         = 0;            /* reinits PL_colors[] */
10345     /*PL_colors[6]      = {0,0,0,0,0,0};*/
10346     PL_reg_whilem_seen  = 0;
10347     PL_reginput         = Nullch;
10348     PL_regbol           = Nullch;
10349     PL_regeol           = Nullch;
10350     PL_regstartp        = (I32*)NULL;
10351     PL_regendp          = (I32*)NULL;
10352     PL_reglastparen     = (U32*)NULL;
10353     PL_regtill          = Nullch;
10354     PL_reg_start_tmp    = (char**)NULL;
10355     PL_reg_start_tmpl   = 0;
10356     PL_regdata          = (struct reg_data*)NULL;
10357     PL_bostr            = Nullch;
10358     PL_reg_flags        = 0;
10359     PL_reg_eval_set     = 0;
10360     PL_regnarrate       = 0;
10361     PL_regprogram       = (regnode*)NULL;
10362     PL_regindent        = 0;
10363     PL_regcc            = (CURCUR*)NULL;
10364     PL_reg_call_cc      = (struct re_cc_state*)NULL;
10365     PL_reg_re           = (regexp*)NULL;
10366     PL_reg_ganch        = Nullch;
10367     PL_reg_sv           = Nullsv;
10368     PL_reg_match_utf8   = FALSE;
10369     PL_reg_magic        = (MAGIC*)NULL;
10370     PL_reg_oldpos       = 0;
10371     PL_reg_oldcurpm     = (PMOP*)NULL;
10372     PL_reg_curpm        = (PMOP*)NULL;
10373     PL_reg_oldsaved     = Nullch;
10374     PL_reg_oldsavedlen  = 0;
10375     PL_reg_maxiter      = 0;
10376     PL_reg_leftiter     = 0;
10377     PL_reg_poscache     = Nullch;
10378     PL_reg_poscache_size= 0;
10379
10380     /* RE engine - function pointers */
10381     PL_regcompp         = proto_perl->Tregcompp;
10382     PL_regexecp         = proto_perl->Tregexecp;
10383     PL_regint_start     = proto_perl->Tregint_start;
10384     PL_regint_string    = proto_perl->Tregint_string;
10385     PL_regfree          = proto_perl->Tregfree;
10386
10387     PL_reginterp_cnt    = 0;
10388     PL_reg_starttry     = 0;
10389
10390     /* Pluggable optimizer */
10391     PL_peepp            = proto_perl->Tpeepp;
10392
10393     if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10394         ptr_table_free(PL_ptr_table);
10395         PL_ptr_table = NULL;
10396     }
10397
10398     /* Call the ->CLONE method, if it exists, for each of the stashes
10399        identified by sv_dup() above.
10400     */
10401     while(av_len(param->stashes) != -1) {
10402         HV* stash = (HV*) av_shift(param->stashes);
10403         GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10404         if (cloner && GvCV(cloner)) {
10405             dSP;
10406             ENTER;
10407             SAVETMPS;
10408             PUSHMARK(SP);
10409            XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
10410             PUTBACK;
10411             call_sv((SV*)GvCV(cloner), G_DISCARD);
10412             FREETMPS;
10413             LEAVE;
10414         }
10415     }
10416
10417     SvREFCNT_dec(param->stashes);
10418
10419     return my_perl;
10420 }
10421
10422 #endif /* USE_ITHREADS */
10423
10424 /*
10425 =head1 Unicode Support
10426
10427 =for apidoc sv_recode_to_utf8
10428
10429 The encoding is assumed to be an Encode object, on entry the PV
10430 of the sv is assumed to be octets in that encoding, and the sv
10431 will be converted into Unicode (and UTF-8).
10432
10433 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10434 is not a reference, nothing is done to the sv.  If the encoding is not
10435 an C<Encode::XS> Encoding object, bad things will happen.
10436 (See F<lib/encoding.pm> and L<Encode>).
10437
10438 The PV of the sv is returned.
10439
10440 =cut */
10441
10442 char *
10443 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10444 {
10445      if (SvPOK(sv) && !DO_UTF8(sv) && SvROK(encoding)) {
10446           SV *uni;
10447           STRLEN len;
10448           char *s;
10449           dSP;
10450           ENTER;
10451           SAVETMPS;
10452           PUSHMARK(sp);
10453           EXTEND(SP, 3);
10454           XPUSHs(encoding);
10455           XPUSHs(sv);
10456           XPUSHs(&PL_sv_yes);
10457           PUTBACK;
10458           call_method("decode", G_SCALAR);
10459           SPAGAIN;
10460           uni = POPs;
10461           PUTBACK;
10462           s = SvPV(uni, len);
10463           if (s != SvPVX(sv)) {
10464                SvGROW(sv, len);
10465                Move(s, SvPVX(sv), len, char);
10466                SvCUR_set(sv, len);
10467           }
10468           FREETMPS;
10469           LEAVE;
10470           SvUTF8_on(sv);
10471      }
10472      return SvPVX(sv);
10473 }
10474