sv.c

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