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 = SvROK(sv) ? "REF":"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                     if (HvNAME(SvSTASH(sv)))
3084                         Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
3085                     else
3086                         Perl_sv_setpvf(aTHX_ tsv, "__ANON__=%s", s);
3087                 else
3088                     sv_setpv(tsv, s);
3089                 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
3090                 goto tokensaveref;
3091             }
3092             *lp = strlen(s);
3093             return s;
3094         }
3095         if (SvREADONLY(sv) && !SvOK(sv)) {
3096             if (ckWARN(WARN_UNINITIALIZED))
3097                 report_uninit();
3098             *lp = 0;
3099             return "";
3100         }
3101     }
3102     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3103         /* I'm assuming that if both IV and NV are equally valid then
3104            converting the IV is going to be more efficient */
3105         U32 isIOK = SvIOK(sv);
3106         U32 isUIOK = SvIsUV(sv);
3107         char buf[TYPE_CHARS(UV)];
3108         char *ebuf, *ptr;
3109
3110         if (SvTYPE(sv) < SVt_PVIV)
3111             sv_upgrade(sv, SVt_PVIV);
3112         if (isUIOK)
3113             ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3114         else
3115             ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3116         SvGROW(sv, (STRLEN)(ebuf - ptr + 1));   /* inlined from sv_setpvn */
3117         Move(ptr,SvPVX(sv),ebuf - ptr,char);
3118         SvCUR_set(sv, ebuf - ptr);
3119         s = SvEND(sv);
3120         *s = '\0';
3121         if (isIOK)
3122             SvIOK_on(sv);
3123         else
3124             SvIOKp_on(sv);
3125         if (isUIOK)
3126             SvIsUV_on(sv);
3127     }
3128     else if (SvNOKp(sv)) {
3129         if (SvTYPE(sv) < SVt_PVNV)
3130             sv_upgrade(sv, SVt_PVNV);
3131         /* The +20 is pure guesswork.  Configure test needed. --jhi */
3132         SvGROW(sv, NV_DIG + 20);
3133         s = SvPVX(sv);
3134         olderrno = errno;       /* some Xenix systems wipe out errno here */
3135 #ifdef apollo
3136         if (SvNVX(sv) == 0.0)
3137             (void)strcpy(s,"0");
3138         else
3139 #endif /*apollo*/
3140         {
3141             Gconvert(SvNVX(sv), NV_DIG, 0, s);
3142         }
3143         errno = olderrno;
3144 #ifdef FIXNEGATIVEZERO
3145         if (*s == '-' && s[1] == '0' && !s[2])
3146             strcpy(s,"0");
3147 #endif
3148         while (*s) s++;
3149 #ifdef hcx
3150         if (s[-1] == '.')
3151             *--s = '\0';
3152 #endif
3153     }
3154     else {
3155         if (ckWARN(WARN_UNINITIALIZED)
3156             && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3157             report_uninit();
3158         *lp = 0;
3159         if (SvTYPE(sv) < SVt_PV)
3160             /* Typically the caller expects that sv_any is not NULL now.  */
3161             sv_upgrade(sv, SVt_PV);
3162         return "";
3163     }
3164     *lp = s - SvPVX(sv);
3165     SvCUR_set(sv, *lp);
3166     SvPOK_on(sv);
3167     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3168                           PTR2UV(sv),SvPVX(sv)));
3169     return SvPVX(sv);
3170
3171   tokensave:
3172     if (SvROK(sv)) {    /* XXX Skip this when sv_pvn_force calls */
3173         /* Sneaky stuff here */
3174
3175       tokensaveref:
3176         if (!tsv)
3177             tsv = newSVpv(tmpbuf, 0);
3178         sv_2mortal(tsv);
3179         *lp = SvCUR(tsv);
3180         return SvPVX(tsv);
3181     }
3182     else {
3183         STRLEN len;
3184         char *t;
3185
3186         if (tsv) {
3187             sv_2mortal(tsv);
3188             t = SvPVX(tsv);
3189             len = SvCUR(tsv);
3190         }
3191         else {
3192             t = tmpbuf;
3193             len = strlen(tmpbuf);
3194         }
3195 #ifdef FIXNEGATIVEZERO
3196         if (len == 2 && t[0] == '-' && t[1] == '0') {
3197             t = "0";
3198             len = 1;
3199         }
3200 #endif
3201         (void)SvUPGRADE(sv, SVt_PV);
3202         *lp = len;
3203         s = SvGROW(sv, len + 1);
3204         SvCUR_set(sv, len);
3205         (void)strcpy(s, t);
3206         SvPOKp_on(sv);
3207         return s;
3208     }
3209 }
3210
3211 /*
3212 =for apidoc sv_copypv
3213
3214 Copies a stringified representation of the source SV into the
3215 destination SV.  Automatically performs any necessary mg_get and
3216 coercion of numeric values into strings.  Guaranteed to preserve
3217 UTF-8 flag even from overloaded objects.  Similar in nature to
3218 sv_2pv[_flags] but operates directly on an SV instead of just the
3219 string.  Mostly uses sv_2pv_flags to do its work, except when that
3220 would lose the UTF-8'ness of the PV.
3221
3222 =cut
3223 */
3224
3225 void
3226 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3227 {
3228     STRLEN len;
3229     char *s;
3230     s = SvPV(ssv,len);
3231     sv_setpvn(dsv,s,len);
3232     if (SvUTF8(ssv))
3233         SvUTF8_on(dsv);
3234     else
3235         SvUTF8_off(dsv);
3236 }
3237
3238 /*
3239 =for apidoc sv_2pvbyte_nolen
3240
3241 Return a pointer to the byte-encoded representation of the SV.
3242 May cause the SV to be downgraded from UTF8 as a side-effect.
3243
3244 Usually accessed via the C<SvPVbyte_nolen> macro.
3245
3246 =cut
3247 */
3248
3249 char *
3250 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3251 {
3252     STRLEN n_a;
3253     return sv_2pvbyte(sv, &n_a);
3254 }
3255
3256 /*
3257 =for apidoc sv_2pvbyte
3258
3259 Return a pointer to the byte-encoded representation of the SV, and set *lp
3260 to its length.  May cause the SV to be downgraded from UTF8 as a
3261 side-effect.
3262
3263 Usually accessed via the C<SvPVbyte> macro.
3264
3265 =cut
3266 */
3267
3268 char *
3269 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3270 {
3271     sv_utf8_downgrade(sv,0);
3272     return SvPV(sv,*lp);
3273 }
3274
3275 /*
3276 =for apidoc sv_2pvutf8_nolen
3277
3278 Return a pointer to the UTF8-encoded representation of the SV.
3279 May cause the SV to be upgraded to UTF8 as a side-effect.
3280
3281 Usually accessed via the C<SvPVutf8_nolen> macro.
3282
3283 =cut
3284 */
3285
3286 char *
3287 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3288 {
3289     STRLEN n_a;
3290     return sv_2pvutf8(sv, &n_a);
3291 }
3292
3293 /*
3294 =for apidoc sv_2pvutf8
3295
3296 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3297 to its length.  May cause the SV to be upgraded to UTF8 as a side-effect.
3298
3299 Usually accessed via the C<SvPVutf8> macro.
3300
3301 =cut
3302 */
3303
3304 char *
3305 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3306 {
3307     sv_utf8_upgrade(sv);
3308     return SvPV(sv,*lp);
3309 }
3310
3311 /*
3312 =for apidoc sv_2bool
3313
3314 This function is only called on magical items, and is only used by
3315 sv_true() or its macro equivalent.
3316
3317 =cut
3318 */
3319
3320 bool
3321 Perl_sv_2bool(pTHX_ register SV *sv)
3322 {
3323     if (SvGMAGICAL(sv))
3324         mg_get(sv);
3325
3326     if (!SvOK(sv))
3327         return 0;
3328     if (SvROK(sv)) {
3329         SV* tmpsv;
3330         if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3331                 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3332             return (bool)SvTRUE(tmpsv);
3333       return SvRV(sv) != 0;
3334     }
3335     if (SvPOKp(sv)) {
3336         register XPV* Xpvtmp;
3337         if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3338                 (*Xpvtmp->xpv_pv > '0' ||
3339                 Xpvtmp->xpv_cur > 1 ||
3340                 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3341             return 1;
3342         else
3343             return 0;
3344     }
3345     else {
3346         if (SvIOKp(sv))
3347             return SvIVX(sv) != 0;
3348         else {
3349             if (SvNOKp(sv))
3350                 return SvNVX(sv) != 0.0;
3351             else
3352                 return FALSE;
3353         }
3354     }
3355 }
3356
3357 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3358  * this function provided for binary compatibility only
3359  */
3360
3361
3362 STRLEN
3363 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3364 {
3365     return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3366 }
3367
3368 /*
3369 =for apidoc sv_utf8_upgrade
3370
3371 Convert the PV of an SV to its UTF8-encoded form.
3372 Forces the SV to string form if it is not already.
3373 Always sets the SvUTF8 flag to avoid future validity checks even
3374 if all the bytes have hibit clear.
3375
3376 This is not as a general purpose byte encoding to Unicode interface:
3377 use the Encode extension for that.
3378
3379 =for apidoc sv_utf8_upgrade_flags
3380
3381 Convert the PV of an SV to its UTF8-encoded form.
3382 Forces the SV to string form if it is not already.
3383 Always sets the SvUTF8 flag to avoid future validity checks even
3384 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3385 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3386 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3387
3388 This is not as a general purpose byte encoding to Unicode interface:
3389 use the Encode extension for that.
3390
3391 =cut
3392 */
3393
3394 STRLEN
3395 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3396 {
3397     U8 *s, *t, *e;
3398     int  hibit = 0;
3399
3400     if (!sv)
3401         return 0;
3402
3403     if (!SvPOK(sv)) {
3404         STRLEN len = 0;
3405         (void) sv_2pv_flags(sv,&len, flags);
3406         if (!SvPOK(sv))
3407              return len;
3408     }
3409
3410     if (SvUTF8(sv))
3411         return SvCUR(sv);
3412
3413     if (SvIsCOW(sv)) {
3414         sv_force_normal_flags(sv, 0);
3415     }
3416
3417     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3418         sv_recode_to_utf8(sv, PL_encoding);
3419     else { /* Assume Latin-1/EBCDIC */
3420          /* This function could be much more efficient if we
3421           * had a FLAG in SVs to signal if there are any hibit
3422           * chars in the PV.  Given that there isn't such a flag
3423           * make the loop as fast as possible. */
3424          s = (U8 *) SvPVX(sv);
3425          e = (U8 *) SvEND(sv);
3426          t = s;
3427          while (t < e) {
3428               U8 ch = *t++;
3429               if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3430                    break;
3431          }
3432          if (hibit) {
3433               STRLEN len;
3434
3435               len = SvCUR(sv) + 1; /* Plus the \0 */
3436               SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3437               SvCUR(sv) = len - 1;
3438               if (SvLEN(sv) != 0)
3439                    Safefree(s); /* No longer using what was there before. */
3440               SvLEN(sv) = len; /* No longer know the real size. */
3441          }
3442          /* Mark as UTF-8 even if no hibit - saves scanning loop */
3443          SvUTF8_on(sv);
3444     }
3445     return SvCUR(sv);
3446 }
3447
3448 /*
3449 =for apidoc sv_utf8_downgrade
3450
3451 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3452 This may not be possible if the PV contains non-byte encoding characters;
3453 if this is the case, either returns false or, if C<fail_ok> is not
3454 true, croaks.
3455
3456 This is not as a general purpose Unicode to byte encoding interface:
3457 use the Encode extension for that.
3458
3459 =cut
3460 */
3461
3462 bool
3463 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3464 {
3465     if (SvPOK(sv) && SvUTF8(sv)) {
3466         if (SvCUR(sv)) {
3467             U8 *s;
3468             STRLEN len;
3469
3470             if (SvIsCOW(sv)) {
3471                 sv_force_normal_flags(sv, 0);
3472             }
3473             s = (U8 *) SvPV(sv, len);
3474             if (!utf8_to_bytes(s, &len)) {
3475                 if (fail_ok)
3476                     return FALSE;
3477                 else {
3478                     if (PL_op)
3479                         Perl_croak(aTHX_ "Wide character in %s",
3480                                    OP_DESC(PL_op));
3481                     else
3482                         Perl_croak(aTHX_ "Wide character");
3483                 }
3484             }
3485             SvCUR(sv) = len;
3486         }
3487     }
3488     SvUTF8_off(sv);
3489     return TRUE;
3490 }
3491
3492 /*
3493 =for apidoc sv_utf8_encode
3494
3495 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3496 flag so that it looks like octets again. Used as a building block
3497 for encode_utf8 in Encode.xs
3498
3499 =cut
3500 */
3501
3502 void
3503 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3504 {
3505     (void) sv_utf8_upgrade(sv);
3506     SvUTF8_off(sv);
3507 }
3508
3509 /*
3510 =for apidoc sv_utf8_decode
3511
3512 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3513 turn off SvUTF8 if needed so that we see characters. Used as a building block
3514 for decode_utf8 in Encode.xs
3515
3516 =cut
3517 */
3518
3519 bool
3520 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3521 {
3522     if (SvPOK(sv)) {
3523         U8 *c;
3524         U8 *e;
3525
3526         /* The octets may have got themselves encoded - get them back as
3527          * bytes
3528          */
3529         if (!sv_utf8_downgrade(sv, TRUE))
3530             return FALSE;
3531
3532         /* it is actually just a matter of turning the utf8 flag on, but
3533          * we want to make sure everything inside is valid utf8 first.
3534          */
3535         c = (U8 *) SvPVX(sv);
3536         if (!is_utf8_string(c, SvCUR(sv)+1))
3537             return FALSE;
3538         e = (U8 *) SvEND(sv);
3539         while (c < e) {
3540             U8 ch = *c++;
3541             if (!UTF8_IS_INVARIANT(ch)) {
3542                 SvUTF8_on(sv);
3543                 break;
3544             }
3545         }
3546     }
3547     return TRUE;
3548 }
3549
3550 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
3551  * this function provided for binary compatibility only
3552  */
3553
3554 void
3555 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3556 {
3557     sv_setsv_flags(dstr, sstr, SV_GMAGIC);
3558 }
3559
3560 /*
3561 =for apidoc sv_setsv
3562
3563 Copies the contents of the source SV C<ssv> into the destination SV
3564 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3565 function if the source SV needs to be reused. Does not handle 'set' magic.
3566 Loosely speaking, it performs a copy-by-value, obliterating any previous
3567 content of the destination.
3568
3569 You probably want to use one of the assortment of wrappers, such as
3570 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3571 C<SvSetMagicSV_nosteal>.
3572
3573 =for apidoc sv_setsv_flags
3574
3575 Copies the contents of the source SV C<ssv> into the destination SV
3576 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3577 function if the source SV needs to be reused. Does not handle 'set' magic.
3578 Loosely speaking, it performs a copy-by-value, obliterating any previous
3579 content of the destination.
3580 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3581 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3582 implemented in terms of this function.
3583
3584 You probably want to use one of the assortment of wrappers, such as
3585 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3586 C<SvSetMagicSV_nosteal>.
3587
3588 This is the primary function for copying scalars, and most other
3589 copy-ish functions and macros use this underneath.
3590
3591 =cut
3592 */
3593
3594 void
3595 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3596 {
3597     register U32 sflags;
3598     register int dtype;
3599     register int stype;
3600
3601     if (sstr == dstr)
3602         return;
3603     SV_CHECK_THINKFIRST_COW_DROP(dstr);
3604     if (!sstr)
3605         sstr = &PL_sv_undef;
3606     stype = SvTYPE(sstr);
3607     dtype = SvTYPE(dstr);
3608
3609     SvAMAGIC_off(dstr);
3610     if ( SvVOK(dstr) )
3611     {
3612         /* need to nuke the magic */
3613         mg_free(dstr);
3614         SvRMAGICAL_off(dstr);
3615     }
3616
3617     /* There's a lot of redundancy below but we're going for speed here */
3618
3619     switch (stype) {
3620     case SVt_NULL:
3621       undef_sstr:
3622         if (dtype != SVt_PVGV) {
3623             (void)SvOK_off(dstr);
3624             return;
3625         }
3626         break;
3627     case SVt_IV:
3628         if (SvIOK(sstr)) {
3629             switch (dtype) {
3630             case SVt_NULL:
3631                 sv_upgrade(dstr, SVt_IV);
3632                 break;
3633             case SVt_NV:
3634                 sv_upgrade(dstr, SVt_PVNV);
3635                 break;
3636             case SVt_RV:
3637             case SVt_PV:
3638                 sv_upgrade(dstr, SVt_PVIV);
3639                 break;
3640             }
3641             (void)SvIOK_only(dstr);
3642             SvIVX(dstr) = SvIVX(sstr);
3643             if (SvIsUV(sstr))
3644                 SvIsUV_on(dstr);
3645             if (SvTAINTED(sstr))
3646                 SvTAINT(dstr);
3647             return;
3648         }
3649         goto undef_sstr;
3650
3651     case SVt_NV:
3652         if (SvNOK(sstr)) {
3653             switch (dtype) {
3654             case SVt_NULL:
3655             case SVt_IV:
3656                 sv_upgrade(dstr, SVt_NV);
3657                 break;
3658             case SVt_RV:
3659             case SVt_PV:
3660             case SVt_PVIV:
3661                 sv_upgrade(dstr, SVt_PVNV);
3662                 break;
3663             }
3664             SvNVX(dstr) = SvNVX(sstr);
3665             (void)SvNOK_only(dstr);
3666             if (SvTAINTED(sstr))
3667                 SvTAINT(dstr);
3668             return;
3669         }
3670         goto undef_sstr;
3671
3672     case SVt_RV:
3673         if (dtype < SVt_RV)
3674             sv_upgrade(dstr, SVt_RV);
3675         else if (dtype == SVt_PVGV &&
3676                  SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3677             sstr = SvRV(sstr);
3678             if (sstr == dstr) {
3679                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3680                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3681                 {
3682                     GvIMPORTED_on(dstr);
3683                 }
3684                 GvMULTI_on(dstr);
3685                 return;
3686             }
3687             goto glob_assign;
3688         }
3689         break;
3690     case SVt_PVFM:
3691 #ifdef PERL_COPY_ON_WRITE
3692         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3693             if (dtype < SVt_PVIV)
3694                 sv_upgrade(dstr, SVt_PVIV);
3695             break;
3696         }
3697         /* Fall through */
3698 #endif
3699     case SVt_PV:
3700         if (dtype < SVt_PV)
3701             sv_upgrade(dstr, SVt_PV);
3702         break;
3703     case SVt_PVIV:
3704         if (dtype < SVt_PVIV)
3705             sv_upgrade(dstr, SVt_PVIV);
3706         break;
3707     case SVt_PVNV:
3708         if (dtype < SVt_PVNV)
3709             sv_upgrade(dstr, SVt_PVNV);
3710         break;
3711     case SVt_PVAV:
3712     case SVt_PVHV:
3713     case SVt_PVCV:
3714     case SVt_PVIO:
3715         if (PL_op)
3716             Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
3717                 OP_NAME(PL_op));
3718         else
3719             Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
3720         break;
3721
3722     case SVt_PVGV:
3723         if (dtype <= SVt_PVGV) {
3724   glob_assign:
3725             if (dtype != SVt_PVGV) {
3726                 char *name = GvNAME(sstr);
3727                 STRLEN len = GvNAMELEN(sstr);
3728                 sv_upgrade(dstr, SVt_PVGV);
3729                 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3730                 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3731                 GvNAME(dstr) = savepvn(name, len);
3732                 GvNAMELEN(dstr) = len;
3733                 SvFAKE_on(dstr);        /* can coerce to non-glob */
3734             }
3735             /* ahem, death to those who redefine active sort subs */
3736             else if (PL_curstackinfo->si_type == PERLSI_SORT
3737                      && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3738                 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3739                       GvNAME(dstr));
3740
3741 #ifdef GV_UNIQUE_CHECK
3742                 if (GvUNIQUE((GV*)dstr)) {
3743                     Perl_croak(aTHX_ PL_no_modify);
3744                 }
3745 #endif
3746
3747             (void)SvOK_off(dstr);
3748             GvINTRO_off(dstr);          /* one-shot flag */
3749             gp_free((GV*)dstr);
3750             GvGP(dstr) = gp_ref(GvGP(sstr));
3751             if (SvTAINTED(sstr))
3752                 SvTAINT(dstr);
3753             if (GvIMPORTED(dstr) != GVf_IMPORTED
3754                 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3755             {
3756                 GvIMPORTED_on(dstr);
3757             }
3758             GvMULTI_on(dstr);
3759             return;
3760         }
3761         /* FALL THROUGH */
3762
3763     default:
3764         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3765             mg_get(sstr);
3766             if ((int)SvTYPE(sstr) != stype) {
3767                 stype = SvTYPE(sstr);
3768                 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3769                     goto glob_assign;
3770             }
3771         }
3772         if (stype == SVt_PVLV)
3773             (void)SvUPGRADE(dstr, SVt_PVNV);
3774         else
3775             (void)SvUPGRADE(dstr, (U32)stype);
3776     }
3777
3778     sflags = SvFLAGS(sstr);
3779
3780     if (sflags & SVf_ROK) {
3781         if (dtype >= SVt_PV) {
3782             if (dtype == SVt_PVGV) {
3783                 SV *sref = SvREFCNT_inc(SvRV(sstr));
3784                 SV *dref = 0;
3785                 int intro = GvINTRO(dstr);
3786
3787 #ifdef GV_UNIQUE_CHECK
3788                 if (GvUNIQUE((GV*)dstr)) {
3789                     Perl_croak(aTHX_ PL_no_modify);
3790                 }
3791 #endif
3792
3793                 if (intro) {
3794                     GvINTRO_off(dstr);  /* one-shot flag */
3795                     GvLINE(dstr) = CopLINE(PL_curcop);
3796                     GvEGV(dstr) = (GV*)dstr;
3797                 }
3798                 GvMULTI_on(dstr);
3799                 switch (SvTYPE(sref)) {
3800                 case SVt_PVAV:
3801                     if (intro)
3802                         SAVEGENERICSV(GvAV(dstr));
3803                     else
3804                         dref = (SV*)GvAV(dstr);
3805                     GvAV(dstr) = (AV*)sref;
3806                     if (!GvIMPORTED_AV(dstr)
3807                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3808                     {
3809                         GvIMPORTED_AV_on(dstr);
3810                     }
3811                     break;
3812                 case SVt_PVHV:
3813                     if (intro)
3814                         SAVEGENERICSV(GvHV(dstr));
3815                     else
3816                         dref = (SV*)GvHV(dstr);
3817                     GvHV(dstr) = (HV*)sref;
3818                     if (!GvIMPORTED_HV(dstr)
3819                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3820                     {
3821                         GvIMPORTED_HV_on(dstr);
3822                     }
3823                     break;
3824                 case SVt_PVCV:
3825                     if (intro) {
3826                         if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3827                             SvREFCNT_dec(GvCV(dstr));
3828                             GvCV(dstr) = Nullcv;
3829                             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3830                             PL_sub_generation++;
3831                         }
3832                         SAVEGENERICSV(GvCV(dstr));
3833                     }
3834                     else
3835                         dref = (SV*)GvCV(dstr);
3836                     if (GvCV(dstr) != (CV*)sref) {
3837                         CV* cv = GvCV(dstr);
3838                         if (cv) {
3839                             if (!GvCVGEN((GV*)dstr) &&
3840                                 (CvROOT(cv) || CvXSUB(cv)))
3841                             {
3842                                 /* ahem, death to those who redefine
3843                                  * active sort subs */
3844                                 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3845                                       PL_sortcop == CvSTART(cv))
3846                                     Perl_croak(aTHX_
3847                                     "Can't redefine active sort subroutine %s",
3848                                           GvENAME((GV*)dstr));
3849                                 /* Redefining a sub - warning is mandatory if
3850                                    it was a const and its value changed. */
3851                                 if (ckWARN(WARN_REDEFINE)
3852                                     || (CvCONST(cv)
3853                                         && (!CvCONST((CV*)sref)
3854                                             || sv_cmp(cv_const_sv(cv),
3855                                                       cv_const_sv((CV*)sref)))))
3856                                 {
3857                                     Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3858                                         CvCONST(cv)
3859                                         ? "Constant subroutine %s::%s redefined"
3860                                         : "Subroutine %s::%s redefined",
3861                                         HvNAME(GvSTASH((GV*)dstr)),
3862                                         GvENAME((GV*)dstr));
3863                                 }
3864                             }
3865                             if (!intro)
3866                                 cv_ckproto(cv, (GV*)dstr,
3867                                         SvPOK(sref) ? SvPVX(sref) : Nullch);
3868                         }
3869                         GvCV(dstr) = (CV*)sref;
3870                         GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3871                         GvASSUMECV_on(dstr);
3872                         PL_sub_generation++;
3873                     }
3874                     if (!GvIMPORTED_CV(dstr)
3875                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3876                     {
3877                         GvIMPORTED_CV_on(dstr);
3878                     }
3879                     break;
3880                 case SVt_PVIO:
3881                     if (intro)
3882                         SAVEGENERICSV(GvIOp(dstr));
3883                     else
3884                         dref = (SV*)GvIOp(dstr);
3885                     GvIOp(dstr) = (IO*)sref;
3886                     break;
3887                 case SVt_PVFM:
3888                     if (intro)
3889                         SAVEGENERICSV(GvFORM(dstr));
3890                     else
3891                         dref = (SV*)GvFORM(dstr);
3892                     GvFORM(dstr) = (CV*)sref;
3893                     break;
3894                 default:
3895                     if (intro)
3896                         SAVEGENERICSV(GvSV(dstr));
3897                     else
3898                         dref = (SV*)GvSV(dstr);
3899                     GvSV(dstr) = sref;
3900                     if (!GvIMPORTED_SV(dstr)
3901                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3902                     {
3903                         GvIMPORTED_SV_on(dstr);
3904                     }
3905                     break;
3906                 }
3907                 if (dref)
3908                     SvREFCNT_dec(dref);
3909                 if (SvTAINTED(sstr))
3910                     SvTAINT(dstr);
3911                 return;
3912             }
3913             if (SvPVX(dstr)) {
3914                 (void)SvOOK_off(dstr);          /* backoff */
3915                 if (SvLEN(dstr))
3916                     Safefree(SvPVX(dstr));
3917                 SvLEN(dstr)=SvCUR(dstr)=0;
3918             }
3919         }
3920         (void)SvOK_off(dstr);
3921         SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
3922         SvROK_on(dstr);
3923         if (sflags & SVp_NOK) {
3924             SvNOKp_on(dstr);
3925             /* Only set the public OK flag if the source has public OK.  */
3926             if (sflags & SVf_NOK)
3927                 SvFLAGS(dstr) |= SVf_NOK;
3928             SvNVX(dstr) = SvNVX(sstr);
3929         }
3930         if (sflags & SVp_IOK) {
3931             (void)SvIOKp_on(dstr);
3932             if (sflags & SVf_IOK)
3933                 SvFLAGS(dstr) |= SVf_IOK;
3934             if (sflags & SVf_IVisUV)
3935                 SvIsUV_on(dstr);
3936             SvIVX(dstr) = SvIVX(sstr);
3937         }
3938         if (SvAMAGIC(sstr)) {
3939             SvAMAGIC_on(dstr);
3940         }
3941     }
3942     else if (sflags & SVp_POK) {
3943         bool isSwipe = 0;
3944
3945         /*
3946          * Check to see if we can just swipe the string.  If so, it's a
3947          * possible small lose on short strings, but a big win on long ones.
3948          * It might even be a win on short strings if SvPVX(dstr)
3949          * has to be allocated and SvPVX(sstr) has to be freed.
3950          */
3951
3952         if (
3953 #ifdef PERL_COPY_ON_WRITE
3954             (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3955             &&
3956 #endif
3957             !(isSwipe =
3958                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
3959                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
3960                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
3961                  SvLEN(sstr)    &&        /* and really is a string */
3962                                 /* and won't be needed again, potentially */
3963               !(PL_op && PL_op->op_type == OP_AASSIGN))
3964 #ifdef PERL_COPY_ON_WRITE
3965             && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3966                  && SvTYPE(sstr) >= SVt_PVIV)
3967 #endif
3968             ) {
3969             /* Failed the swipe test, and it's not a shared hash key either.
3970                Have to copy the string.  */
3971             STRLEN len = SvCUR(sstr);
3972             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
3973             Move(SvPVX(sstr),SvPVX(dstr),len,char);
3974             SvCUR_set(dstr, len);
3975             *SvEND(dstr) = '\0';
3976             (void)SvPOK_only(dstr);
3977         } else {
3978             /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
3979                be true in here.  */
3980 #ifdef PERL_COPY_ON_WRITE
3981             /* Either it's a shared hash key, or it's suitable for
3982                copy-on-write or we can swipe the string.  */
3983             if (DEBUG_C_TEST) {
3984                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3985                 sv_dump(sstr);
3986                 sv_dump(dstr);
3987             }
3988             if (!isSwipe) {
3989                 /* I believe I should acquire a global SV mutex if
3990                    it's a COW sv (not a shared hash key) to stop
3991                    it going un copy-on-write.
3992                    If the source SV has gone un copy on write between up there
3993                    and down here, then (assert() that) it is of the correct
3994                    form to make it copy on write again */
3995                 if ((sflags & (SVf_FAKE | SVf_READONLY))
3996                     != (SVf_FAKE | SVf_READONLY)) {
3997                     SvREADONLY_on(sstr);
3998                     SvFAKE_on(sstr);
3999                     /* Make the source SV into a loop of 1.
4000                        (about to become 2) */
4001                     SV_COW_NEXT_SV_SET(sstr, sstr);
4002                 }
4003             }
4004 #endif
4005             /* Initial code is common.  */
4006             if (SvPVX(dstr)) {          /* we know that dtype >= SVt_PV */
4007                 if (SvOOK(dstr)) {
4008                     SvFLAGS(dstr) &= ~SVf_OOK;
4009                     Safefree(SvPVX(dstr) - SvIVX(dstr));
4010                 }
4011                 else if (SvLEN(dstr))
4012                     Safefree(SvPVX(dstr));
4013             }
4014             (void)SvPOK_only(dstr);
4015
4016 #ifdef PERL_COPY_ON_WRITE
4017             if (!isSwipe) {
4018                 /* making another shared SV.  */
4019                 STRLEN cur = SvCUR(sstr);
4020                 STRLEN len = SvLEN(sstr);
4021                 assert (SvTYPE(dstr) >= SVt_PVIV);
4022                 if (len) {
4023                     /* SvIsCOW_normal */
4024                     /* splice us in between source and next-after-source.  */
4025                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4026                     SV_COW_NEXT_SV_SET(sstr, dstr);
4027                     SvPV_set(dstr, SvPVX(sstr));
4028                 } else {
4029                     /* SvIsCOW_shared_hash */
4030                     UV hash = SvUVX(sstr);
4031                     DEBUG_C(PerlIO_printf(Perl_debug_log,
4032                                           "Copy on write: Sharing hash\n"));
4033                     SvPV_set(dstr,
4034                              sharepvn(SvPVX(sstr),
4035                                       (sflags & SVf_UTF8?-cur:cur), hash));
4036                     SvUVX(dstr) = hash;
4037                 }
4038                 SvLEN(dstr) = len;
4039                 SvCUR(dstr) = cur;
4040                 SvREADONLY_on(dstr);
4041                 SvFAKE_on(dstr);
4042                 /* Relesase a global SV mutex.  */
4043             }
4044             else
4045 #endif
4046                 {       /* Passes the swipe test.  */
4047                 SvPV_set(dstr, SvPVX(sstr));
4048                 SvLEN_set(dstr, SvLEN(sstr));
4049                 SvCUR_set(dstr, SvCUR(sstr));
4050
4051                 SvTEMP_off(dstr);
4052                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
4053                 SvPV_set(sstr, Nullch);
4054                 SvLEN_set(sstr, 0);
4055                 SvCUR_set(sstr, 0);
4056                 SvTEMP_off(sstr);
4057             }
4058         }
4059         if (sflags & SVf_UTF8)
4060             SvUTF8_on(dstr);
4061         /*SUPPRESS 560*/
4062         if (sflags & SVp_NOK) {
4063             SvNOKp_on(dstr);
4064             if (sflags & SVf_NOK)
4065                 SvFLAGS(dstr) |= SVf_NOK;
4066             SvNVX(dstr) = SvNVX(sstr);
4067         }
4068         if (sflags & SVp_IOK) {
4069             (void)SvIOKp_on(dstr);
4070             if (sflags & SVf_IOK)
4071                 SvFLAGS(dstr) |= SVf_IOK;
4072             if (sflags & SVf_IVisUV)
4073                 SvIsUV_on(dstr);
4074             SvIVX(dstr) = SvIVX(sstr);
4075         }
4076         if (SvVOK(sstr)) {
4077             MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4078             sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4079                         smg->mg_ptr, smg->mg_len);
4080             SvRMAGICAL_on(dstr);
4081         }
4082     }
4083     else if (sflags & SVp_IOK) {
4084         if (sflags & SVf_IOK)
4085             (void)SvIOK_only(dstr);
4086         else {
4087             (void)SvOK_off(dstr);
4088             (void)SvIOKp_on(dstr);
4089         }
4090         /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
4091         if (sflags & SVf_IVisUV)
4092             SvIsUV_on(dstr);
4093         SvIVX(dstr) = SvIVX(sstr);
4094         if (sflags & SVp_NOK) {
4095             if (sflags & SVf_NOK)
4096                 (void)SvNOK_on(dstr);
4097             else
4098                 (void)SvNOKp_on(dstr);
4099             SvNVX(dstr) = SvNVX(sstr);
4100         }
4101     }
4102     else if (sflags & SVp_NOK) {
4103         if (sflags & SVf_NOK)
4104             (void)SvNOK_only(dstr);
4105         else {
4106             (void)SvOK_off(dstr);
4107             SvNOKp_on(dstr);
4108         }
4109         SvNVX(dstr) = SvNVX(sstr);
4110     }
4111     else {
4112         if (dtype == SVt_PVGV) {
4113             if (ckWARN(WARN_MISC))
4114                 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4115         }
4116         else
4117             (void)SvOK_off(dstr);
4118     }
4119     if (SvTAINTED(sstr))
4120         SvTAINT(dstr);
4121 }
4122
4123 /*
4124 =for apidoc sv_setsv_mg
4125
4126 Like C<sv_setsv>, but also handles 'set' magic.
4127
4128 =cut
4129 */
4130
4131 void
4132 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4133 {
4134     sv_setsv(dstr,sstr);
4135     SvSETMAGIC(dstr);
4136 }
4137
4138 #ifdef PERL_COPY_ON_WRITE
4139 SV *
4140 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4141 {
4142     STRLEN cur = SvCUR(sstr);
4143     STRLEN len = SvLEN(sstr);
4144     register char *new_pv;
4145
4146     if (DEBUG_C_TEST) {
4147         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4148                       sstr, dstr);
4149         sv_dump(sstr);
4150         if (dstr)
4151                     sv_dump(dstr);
4152     }
4153
4154     if (dstr) {
4155         if (SvTHINKFIRST(dstr))
4156             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4157         else if (SvPVX(dstr))
4158             Safefree(SvPVX(dstr));
4159     }
4160     else
4161         new_SV(dstr);
4162     SvUPGRADE (dstr, SVt_PVIV);
4163
4164     assert (SvPOK(sstr));
4165     assert (SvPOKp(sstr));
4166     assert (!SvIOK(sstr));
4167     assert (!SvIOKp(sstr));
4168     assert (!SvNOK(sstr));
4169     assert (!SvNOKp(sstr));
4170
4171     if (SvIsCOW(sstr)) {
4172
4173         if (SvLEN(sstr) == 0) {
4174             /* source is a COW shared hash key.  */
4175             UV hash = SvUVX(sstr);
4176             DEBUG_C(PerlIO_printf(Perl_debug_log,
4177                                   "Fast copy on write: Sharing hash\n"));
4178             SvUVX(dstr) = hash;
4179             new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4180             goto common_exit;
4181         }
4182         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4183     } else {
4184         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4185         SvUPGRADE (sstr, SVt_PVIV);
4186         SvREADONLY_on(sstr);
4187         SvFAKE_on(sstr);
4188         DEBUG_C(PerlIO_printf(Perl_debug_log,
4189                               "Fast copy on write: Converting sstr to COW\n"));
4190         SV_COW_NEXT_SV_SET(dstr, sstr);
4191     }
4192     SV_COW_NEXT_SV_SET(sstr, dstr);
4193     new_pv = SvPVX(sstr);
4194
4195   common_exit:
4196     SvPV_set(dstr, new_pv);
4197     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4198     if (SvUTF8(sstr))
4199         SvUTF8_on(dstr);
4200     SvLEN(dstr) = len;
4201     SvCUR(dstr) = cur;
4202     if (DEBUG_C_TEST) {
4203         sv_dump(dstr);
4204     }
4205     return dstr;
4206 }
4207 #endif
4208
4209 /*
4210 =for apidoc sv_setpvn
4211
4212 Copies a string into an SV.  The C<len> parameter indicates the number of
4213 bytes to be copied.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
4214
4215 =cut
4216 */
4217
4218 void
4219 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4220 {
4221     register char *dptr;
4222
4223     SV_CHECK_THINKFIRST_COW_DROP(sv);
4224     if (!ptr) {
4225         (void)SvOK_off(sv);
4226         return;
4227     }
4228     else {
4229         /* len is STRLEN which is unsigned, need to copy to signed */
4230         IV iv = len;
4231         if (iv < 0)
4232             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4233     }
4234     (void)SvUPGRADE(sv, SVt_PV);
4235
4236     SvGROW(sv, len + 1);
4237     dptr = SvPVX(sv);
4238     Move(ptr,dptr,len,char);
4239     dptr[len] = '\0';
4240     SvCUR_set(sv, len);
4241     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4242     SvTAINT(sv);
4243 }
4244
4245 /*
4246 =for apidoc sv_setpvn_mg
4247
4248 Like C<sv_setpvn>, but also handles 'set' magic.
4249
4250 =cut
4251 */
4252
4253 void
4254 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4255 {
4256     sv_setpvn(sv,ptr,len);
4257     SvSETMAGIC(sv);
4258 }
4259
4260 /*
4261 =for apidoc sv_setpv
4262
4263 Copies a string into an SV.  The string must be null-terminated.  Does not
4264 handle 'set' magic.  See C<sv_setpv_mg>.
4265
4266 =cut
4267 */
4268
4269 void
4270 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4271 {
4272     register STRLEN len;
4273
4274     SV_CHECK_THINKFIRST_COW_DROP(sv);
4275     if (!ptr) {
4276         (void)SvOK_off(sv);
4277         return;
4278     }
4279     len = strlen(ptr);
4280     (void)SvUPGRADE(sv, SVt_PV);
4281
4282     SvGROW(sv, len + 1);
4283     Move(ptr,SvPVX(sv),len+1,char);
4284     SvCUR_set(sv, len);
4285     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4286     SvTAINT(sv);
4287 }
4288
4289 /*
4290 =for apidoc sv_setpv_mg
4291
4292 Like C<sv_setpv>, but also handles 'set' magic.
4293
4294 =cut
4295 */
4296
4297 void
4298 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4299 {
4300     sv_setpv(sv,ptr);
4301     SvSETMAGIC(sv);
4302 }
4303
4304 /*
4305 =for apidoc sv_usepvn
4306
4307 Tells an SV to use C<ptr> to find its string value.  Normally the string is
4308 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4309 The C<ptr> should point to memory that was allocated by C<malloc>.  The
4310 string length, C<len>, must be supplied.  This function will realloc the
4311 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4312 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
4313 See C<sv_usepvn_mg>.
4314
4315 =cut
4316 */
4317
4318 void
4319 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4320 {
4321     SV_CHECK_THINKFIRST_COW_DROP(sv);
4322     (void)SvUPGRADE(sv, SVt_PV);
4323     if (!ptr) {
4324         (void)SvOK_off(sv);
4325         return;
4326     }
4327     (void)SvOOK_off(sv);
4328     if (SvPVX(sv) && SvLEN(sv))
4329         Safefree(SvPVX(sv));
4330     Renew(ptr, len+1, char);
4331     SvPVX(sv) = ptr;
4332     SvCUR_set(sv, len);
4333     SvLEN_set(sv, len+1);
4334     *SvEND(sv) = '\0';
4335     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4336     SvTAINT(sv);
4337 }
4338
4339 /*
4340 =for apidoc sv_usepvn_mg
4341
4342 Like C<sv_usepvn>, but also handles 'set' magic.
4343
4344 =cut
4345 */
4346
4347 void
4348 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4349 {
4350     sv_usepvn(sv,ptr,len);
4351     SvSETMAGIC(sv);
4352 }
4353
4354 #ifdef PERL_COPY_ON_WRITE
4355 /* Need to do this *after* making the SV normal, as we need the buffer
4356    pointer to remain valid until after we've copied it.  If we let go too early,
4357    another thread could invalidate it by unsharing last of the same hash key
4358    (which it can do by means other than releasing copy-on-write Svs)
4359    or by changing the other copy-on-write SVs in the loop.  */
4360 STATIC void
4361 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4362                  U32 hash, SV *after)
4363 {
4364     if (len) { /* this SV was SvIsCOW_normal(sv) */
4365          /* we need to find the SV pointing to us.  */
4366         SV *current = SV_COW_NEXT_SV(after);
4367
4368         if (current == sv) {
4369             /* The SV we point to points back to us (there were only two of us
4370                in the loop.)
4371                Hence other SV is no longer copy on write either.  */
4372             SvFAKE_off(after);
4373             SvREADONLY_off(after);
4374         } else {
4375             /* We need to follow the pointers around the loop.  */
4376             SV *next;
4377             while ((next = SV_COW_NEXT_SV(current)) != sv) {
4378                 assert (next);
4379                 current = next;
4380                  /* don't loop forever if the structure is bust, and we have
4381                     a pointer into a closed loop.  */
4382                 assert (current != after);
4383                 assert (SvPVX(current) == pvx);
4384             }
4385             /* Make the SV before us point to the SV after us.  */
4386             SV_COW_NEXT_SV_SET(current, after);
4387         }
4388     } else {
4389         unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4390     }
4391 }
4392
4393 int
4394 Perl_sv_release_IVX(pTHX_ register SV *sv)
4395 {
4396     if (SvIsCOW(sv))
4397         sv_force_normal_flags(sv, 0);
4398     return SvOOK_off(sv);
4399 }
4400 #endif
4401 /*
4402 =for apidoc sv_force_normal_flags
4403
4404 Undo various types of fakery on an SV: if the PV is a shared string, make
4405 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4406 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4407 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4408 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4409 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4410 set to some other value.) In addition, the C<flags> parameter gets passed to
4411 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4412 with flags set to 0.
4413
4414 =cut
4415 */
4416
4417 void
4418 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4419 {
4420 #ifdef PERL_COPY_ON_WRITE
4421     if (SvREADONLY(sv)) {
4422         /* At this point I believe I should acquire a global SV mutex.  */
4423         if (SvFAKE(sv)) {
4424             char *pvx = SvPVX(sv);
4425             STRLEN len = SvLEN(sv);
4426             STRLEN cur = SvCUR(sv);
4427             U32 hash = SvUVX(sv);
4428             SV *next = SV_COW_NEXT_SV(sv);   /* next COW sv in the loop. */
4429             if (DEBUG_C_TEST) {
4430                 PerlIO_printf(Perl_debug_log,
4431                               "Copy on write: Force normal %ld\n",
4432                               (long) flags);
4433                 sv_dump(sv);
4434             }
4435             SvFAKE_off(sv);
4436             SvREADONLY_off(sv);
4437             /* This SV doesn't own the buffer, so need to New() a new one:  */
4438             SvPVX(sv) = 0;
4439             SvLEN(sv) = 0;
4440             if (flags & SV_COW_DROP_PV) {
4441                 /* OK, so we don't need to copy our buffer.  */
4442                 SvPOK_off(sv);
4443             } else {
4444                 SvGROW(sv, cur + 1);
4445                 Move(pvx,SvPVX(sv),cur,char);
4446                 SvCUR(sv) = cur;
4447                 *SvEND(sv) = '\0';
4448             }
4449             sv_release_COW(sv, pvx, cur, len, hash, next);
4450             if (DEBUG_C_TEST) {
4451                 sv_dump(sv);
4452             }
4453         }
4454         else if (PL_curcop != &PL_compiling)
4455             Perl_croak(aTHX_ PL_no_modify);
4456         /* At this point I believe that I can drop the global SV mutex.  */
4457     }
4458 #else
4459     if (SvREADONLY(sv)) {
4460         if (SvFAKE(sv)) {
4461             char *pvx = SvPVX(sv);
4462             STRLEN len = SvCUR(sv);
4463             U32 hash   = SvUVX(sv);
4464             SvFAKE_off(sv);
4465             SvREADONLY_off(sv);
4466             SvGROW(sv, len + 1);
4467             Move(pvx,SvPVX(sv),len,char);
4468             *SvEND(sv) = '\0';
4469             unsharepvn(pvx, SvUTF8(sv) ? -(I32)len : len, hash);
4470         }
4471         else if (PL_curcop != &PL_compiling)
4472             Perl_croak(aTHX_ PL_no_modify);
4473     }
4474 #endif
4475     if (SvROK(sv))
4476         sv_unref_flags(sv, flags);
4477     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4478         sv_unglob(sv);
4479 }
4480
4481 /*
4482 =for apidoc sv_force_normal
4483
4484 Undo various types of fakery on an SV: if the PV is a shared string, make
4485 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4486 an xpvmg. See also C<sv_force_normal_flags>.
4487
4488 =cut
4489 */
4490
4491 void
4492 Perl_sv_force_normal(pTHX_ register SV *sv)
4493 {
4494     sv_force_normal_flags(sv, 0);
4495 }
4496
4497 /*
4498 =for apidoc sv_chop
4499
4500 Efficient removal of characters from the beginning of the string buffer.
4501 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4502 the string buffer.  The C<ptr> becomes the first character of the adjusted
4503 string. Uses the "OOK hack".
4504 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
4505 refer to the same chunk of data.
4506
4507 =cut
4508 */
4509
4510 void
4511 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
4512 {
4513     register STRLEN delta;
4514     if (!ptr || !SvPOKp(sv))
4515         return;
4516     delta = ptr - SvPVX(sv);
4517     SV_CHECK_THINKFIRST(sv);
4518     if (SvTYPE(sv) < SVt_PVIV)
4519         sv_upgrade(sv,SVt_PVIV);
4520
4521     if (!SvOOK(sv)) {
4522         if (!SvLEN(sv)) { /* make copy of shared string */
4523             char *pvx = SvPVX(sv);
4524             STRLEN len = SvCUR(sv);
4525             SvGROW(sv, len + 1);
4526             Move(pvx,SvPVX(sv),len,char);
4527             *SvEND(sv) = '\0';
4528         }
4529         SvIVX(sv) = 0;
4530         /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4531            and we do that anyway inside the SvNIOK_off
4532         */
4533         SvFLAGS(sv) |= SVf_OOK;
4534     }
4535     SvNIOK_off(sv);
4536     SvLEN(sv) -= delta;
4537     SvCUR(sv) -= delta;
4538     SvPVX(sv) += delta;
4539     SvIVX(sv) += delta;
4540 }
4541
4542 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4543  * this function provided for binary compatibility only
4544  */
4545
4546 void
4547 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4548 {
4549     sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4550 }
4551
4552 /*
4553 =for apidoc sv_catpvn
4554
4555 Concatenates the string onto the end of the string which is in the SV.  The
4556 C<len> indicates number of bytes to copy.  If the SV has the UTF8
4557 status set, then the bytes appended should be valid UTF8.
4558 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4559
4560 =for apidoc sv_catpvn_flags
4561
4562 Concatenates the string onto the end of the string which is in the SV.  The
4563 C<len> indicates number of bytes to copy.  If the SV has the UTF8
4564 status set, then the bytes appended should be valid UTF8.
4565 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4566 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4567 in terms of this function.
4568
4569 =cut
4570 */
4571
4572 void
4573 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4574 {
4575     STRLEN dlen;
4576     char *dstr;
4577
4578     dstr = SvPV_force_flags(dsv, dlen, flags);
4579     SvGROW(dsv, dlen + slen + 1);
4580     if (sstr == dstr)
4581         sstr = SvPVX(dsv);
4582     Move(sstr, SvPVX(dsv) + dlen, slen, char);
4583     SvCUR(dsv) += slen;
4584     *SvEND(dsv) = '\0';
4585     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
4586     SvTAINT(dsv);
4587 }
4588
4589 /*
4590 =for apidoc sv_catpvn_mg
4591
4592 Like C<sv_catpvn>, but also handles 'set' magic.
4593
4594 =cut
4595 */
4596
4597 void
4598 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4599 {
4600     sv_catpvn(sv,ptr,len);
4601     SvSETMAGIC(sv);
4602 }
4603
4604 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4605  * this function provided for binary compatibility only
4606  */
4607
4608 void
4609 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4610 {
4611     sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4612 }
4613
4614 /*
4615 =for apidoc sv_catsv
4616
4617 Concatenates the string from SV C<ssv> onto the end of the string in
4618 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
4619 not 'set' magic.  See C<sv_catsv_mg>.
4620
4621 =for apidoc sv_catsv_flags
4622
4623 Concatenates the string from SV C<ssv> onto the end of the string in
4624 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
4625 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4626 and C<sv_catsv_nomg> are implemented in terms of this function.
4627
4628 =cut */
4629
4630 void
4631 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4632 {
4633     char *spv;
4634     STRLEN slen;
4635     if (!ssv)
4636         return;
4637     if ((spv = SvPV(ssv, slen))) {
4638         /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4639             gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4640             Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4641             get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
4642             dsv->sv_flags doesn't have that bit set.
4643                 Andy Dougherty  12 Oct 2001
4644         */
4645         I32 sutf8 = DO_UTF8(ssv);
4646         I32 dutf8;
4647
4648         if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4649             mg_get(dsv);
4650         dutf8 = DO_UTF8(dsv);
4651
4652         if (dutf8 != sutf8) {
4653             if (dutf8) {
4654                 /* Not modifying source SV, so taking a temporary copy. */
4655                 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4656
4657                 sv_utf8_upgrade(csv);
4658                 spv = SvPV(csv, slen);
4659             }
4660             else
4661                 sv_utf8_upgrade_nomg(dsv);
4662         }
4663         sv_catpvn_nomg(dsv, spv, slen);
4664     }
4665 }
4666
4667 /*
4668 =for apidoc sv_catsv_mg
4669
4670 Like C<sv_catsv>, but also handles 'set' magic.
4671
4672 =cut
4673 */
4674
4675 void
4676 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4677 {
4678     sv_catsv(dsv,ssv);
4679     SvSETMAGIC(dsv);
4680 }
4681
4682 /*
4683 =for apidoc sv_catpv
4684
4685 Concatenates the string onto the end of the string which is in the SV.
4686 If the SV has the UTF8 status set, then the bytes appended should be
4687 valid UTF8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
4688
4689 =cut */
4690
4691 void
4692 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4693 {
4694     register STRLEN len;
4695     STRLEN tlen;
4696     char *junk;
4697
4698     if (!ptr)
4699         return;
4700     junk = SvPV_force(sv, tlen);
4701     len = strlen(ptr);
4702     SvGROW(sv, tlen + len + 1);
4703     if (ptr == junk)
4704         ptr = SvPVX(sv);
4705     Move(ptr,SvPVX(sv)+tlen,len+1,char);
4706     SvCUR(sv) += len;
4707     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4708     SvTAINT(sv);
4709 }
4710
4711 /*
4712 =for apidoc sv_catpv_mg
4713
4714 Like C<sv_catpv>, but also handles 'set' magic.
4715
4716 =cut
4717 */
4718
4719 void
4720 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4721 {
4722     sv_catpv(sv,ptr);
4723     SvSETMAGIC(sv);
4724 }
4725
4726 /*
4727 =for apidoc newSV
4728
4729 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4730 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4731 macro.
4732
4733 =cut
4734 */
4735
4736 SV *
4737 Perl_newSV(pTHX_ STRLEN len)
4738 {
4739     register SV *sv;
4740
4741     new_SV(sv);
4742     if (len) {
4743         sv_upgrade(sv, SVt_PV);
4744         SvGROW(sv, len + 1);
4745     }
4746     return sv;
4747 }
4748 /*
4749 =for apidoc sv_magicext
4750
4751 Adds magic to an SV, upgrading it if necessary. Applies the
4752 supplied vtable and returns pointer to the magic added.
4753
4754 Note that sv_magicext will allow things that sv_magic will not.
4755 In particular you can add magic to SvREADONLY SVs and and more than
4756 one instance of the same 'how'
4757
4758 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4759 if C<namelen> is zero then C<name> is stored as-is and - as another special
4760 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4761 an C<SV*> and has its REFCNT incremented
4762
4763 (This is now used as a subroutine by sv_magic.)
4764
4765 =cut
4766 */
4767 MAGIC *
4768 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4769                  const char* name, I32 namlen)
4770 {
4771     MAGIC* mg;
4772
4773     if (SvTYPE(sv) < SVt_PVMG) {
4774         (void)SvUPGRADE(sv, SVt_PVMG);
4775     }
4776     Newz(702,mg, 1, MAGIC);
4777     mg->mg_moremagic = SvMAGIC(sv);
4778     SvMAGIC(sv) = mg;
4779
4780     /* Some magic sontains a reference loop, where the sv and object refer to
4781        each other.  To prevent a reference loop that would prevent such
4782        objects being freed, we look for such loops and if we find one we
4783        avoid incrementing the object refcount.
4784
4785        Note we cannot do this to avoid self-tie loops as intervening RV must
4786        have its REFCNT incremented to keep it in existence.
4787
4788     */
4789     if (!obj || obj == sv ||
4790         how == PERL_MAGIC_arylen ||
4791         how == PERL_MAGIC_qr ||
4792         (SvTYPE(obj) == SVt_PVGV &&
4793             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4794             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4795             GvFORM(obj) == (CV*)sv)))
4796     {
4797         mg->mg_obj = obj;
4798     }
4799     else {
4800         mg->mg_obj = SvREFCNT_inc(obj);
4801         mg->mg_flags |= MGf_REFCOUNTED;
4802     }
4803
4804     /* Normal self-ties simply pass a null object, and instead of
4805        using mg_obj directly, use the SvTIED_obj macro to produce a
4806        new RV as needed.  For glob "self-ties", we are tieing the PVIO
4807        with an RV obj pointing to the glob containing the PVIO.  In
4808        this case, to avoid a reference loop, we need to weaken the
4809        reference.
4810     */
4811
4812     if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4813         obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4814     {
4815       sv_rvweaken(obj);
4816     }
4817
4818     mg->mg_type = how;
4819     mg->mg_len = namlen;
4820     if (name) {
4821         if (namlen > 0)
4822             mg->mg_ptr = savepvn(name, namlen);
4823         else if (namlen == HEf_SVKEY)
4824             mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4825         else
4826             mg->mg_ptr = (char *) name;
4827     }
4828     mg->mg_virtual = vtable;
4829
4830     mg_magical(sv);
4831     if (SvGMAGICAL(sv))
4832         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4833     return mg;
4834 }
4835
4836 /*
4837 =for apidoc sv_magic
4838
4839 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4840 then adds a new magic item of type C<how> to the head of the magic list.
4841
4842 =cut
4843 */
4844
4845 void
4846 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4847 {
4848     MAGIC* mg;
4849     MGVTBL *vtable = 0;
4850
4851 #ifdef PERL_COPY_ON_WRITE
4852     if (SvIsCOW(sv))
4853         sv_force_normal_flags(sv, 0);
4854 #endif
4855     if (SvREADONLY(sv)) {
4856         if (PL_curcop != &PL_compiling
4857             && how != PERL_MAGIC_regex_global
4858             && how != PERL_MAGIC_bm
4859             && how != PERL_MAGIC_fm
4860             && how != PERL_MAGIC_sv
4861            )
4862         {
4863             Perl_croak(aTHX_ PL_no_modify);
4864         }
4865     }
4866     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4867         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4868             /* sv_magic() refuses to add a magic of the same 'how' as an
4869                existing one
4870              */
4871             if (how == PERL_MAGIC_taint)
4872                 mg->mg_len |= 1;
4873             return;
4874         }
4875     }
4876
4877     switch (how) {
4878     case PERL_MAGIC_sv:
4879         vtable = &PL_vtbl_sv;
4880         break;
4881     case PERL_MAGIC_overload:
4882         vtable = &PL_vtbl_amagic;
4883         break;
4884     case PERL_MAGIC_overload_elem:
4885         vtable = &PL_vtbl_amagicelem;
4886         break;
4887     case PERL_MAGIC_overload_table:
4888         vtable = &PL_vtbl_ovrld;
4889         break;
4890     case PERL_MAGIC_bm:
4891         vtable = &PL_vtbl_bm;
4892         break;
4893     case PERL_MAGIC_regdata:
4894         vtable = &PL_vtbl_regdata;
4895         break;
4896     case PERL_MAGIC_regdatum:
4897         vtable = &PL_vtbl_regdatum;
4898         break;
4899     case PERL_MAGIC_env:
4900         vtable = &PL_vtbl_env;
4901         break;
4902     case PERL_MAGIC_fm:
4903         vtable = &PL_vtbl_fm;
4904         break;
4905     case PERL_MAGIC_envelem:
4906         vtable = &PL_vtbl_envelem;
4907         break;
4908     case PERL_MAGIC_regex_global:
4909         vtable = &PL_vtbl_mglob;
4910         break;
4911     case PERL_MAGIC_isa:
4912         vtable = &PL_vtbl_isa;
4913         break;
4914     case PERL_MAGIC_isaelem:
4915         vtable = &PL_vtbl_isaelem;
4916         break;
4917     case PERL_MAGIC_nkeys:
4918         vtable = &PL_vtbl_nkeys;
4919         break;
4920     case PERL_MAGIC_dbfile:
4921         vtable = 0;
4922         break;
4923     case PERL_MAGIC_dbline:
4924         vtable = &PL_vtbl_dbline;
4925         break;
4926 #ifdef USE_LOCALE_COLLATE
4927     case PERL_MAGIC_collxfrm:
4928         vtable = &PL_vtbl_collxfrm;
4929         break;
4930 #endif /* USE_LOCALE_COLLATE */
4931     case PERL_MAGIC_tied:
4932         vtable = &PL_vtbl_pack;
4933         break;
4934     case PERL_MAGIC_tiedelem:
4935     case PERL_MAGIC_tiedscalar:
4936         vtable = &PL_vtbl_packelem;
4937         break;
4938     case PERL_MAGIC_qr:
4939         vtable = &PL_vtbl_regexp;
4940         break;
4941     case PERL_MAGIC_sig:
4942         vtable = &PL_vtbl_sig;
4943         break;
4944     case PERL_MAGIC_sigelem:
4945         vtable = &PL_vtbl_sigelem;
4946         break;
4947     case PERL_MAGIC_taint:
4948         vtable = &PL_vtbl_taint;
4949         break;
4950     case PERL_MAGIC_uvar:
4951         vtable = &PL_vtbl_uvar;
4952         break;
4953     case PERL_MAGIC_vec:
4954         vtable = &PL_vtbl_vec;
4955         break;
4956     case PERL_MAGIC_vstring:
4957         vtable = 0;
4958         break;
4959     case PERL_MAGIC_utf8:
4960         vtable = &PL_vtbl_utf8;
4961         break;
4962     case PERL_MAGIC_substr:
4963         vtable = &PL_vtbl_substr;
4964         break;
4965     case PERL_MAGIC_defelem:
4966         vtable = &PL_vtbl_defelem;
4967         break;
4968     case PERL_MAGIC_glob:
4969         vtable = &PL_vtbl_glob;
4970         break;
4971     case PERL_MAGIC_arylen:
4972         vtable = &PL_vtbl_arylen;
4973         break;
4974     case PERL_MAGIC_pos:
4975         vtable = &PL_vtbl_pos;
4976         break;
4977     case PERL_MAGIC_backref:
4978         vtable = &PL_vtbl_backref;
4979         break;
4980     case PERL_MAGIC_ext:
4981         /* Reserved for use by extensions not perl internals.           */
4982         /* Useful for attaching extension internal data to perl vars.   */
4983         /* Note that multiple extensions may clash if magical scalars   */
4984         /* etc holding private data from one are passed to another.     */
4985         break;
4986     default:
4987         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4988     }
4989
4990     /* Rest of work is done else where */
4991     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4992
4993     switch (how) {
4994     case PERL_MAGIC_taint:
4995         mg->mg_len = 1;
4996         break;
4997     case PERL_MAGIC_ext:
4998     case PERL_MAGIC_dbfile:
4999         SvRMAGICAL_on(sv);
5000         break;
5001     }
5002 }
5003
5004 /*
5005 =for apidoc sv_unmagic
5006
5007 Removes all magic of type C<type> from an SV.
5008
5009 =cut
5010 */
5011
5012 int
5013 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5014 {
5015     MAGIC* mg;
5016     MAGIC** mgp;
5017     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5018         return 0;
5019     mgp = &SvMAGIC(sv);
5020     for (mg = *mgp; mg; mg = *mgp) {
5021         if (mg->mg_type == type) {
5022             MGVTBL* vtbl = mg->mg_virtual;
5023             *mgp = mg->mg_moremagic;
5024             if (vtbl && vtbl->svt_free)
5025                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5026             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5027                 if (mg->mg_len > 0)
5028                     Safefree(mg->mg_ptr);
5029                 else if (mg->mg_len == HEf_SVKEY)
5030                     SvREFCNT_dec((SV*)mg->mg_ptr);
5031                 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5032                     Safefree(mg->mg_ptr);
5033             }
5034             if (mg->mg_flags & MGf_REFCOUNTED)
5035                 SvREFCNT_dec(mg->mg_obj);
5036             Safefree(mg);
5037         }
5038         else
5039             mgp = &mg->mg_moremagic;
5040     }
5041     if (!SvMAGIC(sv)) {
5042         SvMAGICAL_off(sv);
5043        SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5044     }
5045
5046     return 0;
5047 }
5048
5049 /*
5050 =for apidoc sv_rvweaken
5051
5052 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5053 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5054 push a back-reference to this RV onto the array of backreferences
5055 associated with that magic.
5056
5057 =cut
5058 */
5059
5060 SV *
5061 Perl_sv_rvweaken(pTHX_ SV *sv)
5062 {
5063     SV *tsv;
5064     if (!SvOK(sv))  /* let undefs pass */
5065         return sv;
5066     if (!SvROK(sv))
5067         Perl_croak(aTHX_ "Can't weaken a nonreference");
5068     else if (SvWEAKREF(sv)) {
5069         if (ckWARN(WARN_MISC))
5070             Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5071         return sv;
5072     }
5073     tsv = SvRV(sv);
5074     sv_add_backref(tsv, sv);
5075     SvWEAKREF_on(sv);
5076     SvREFCNT_dec(tsv);
5077     return sv;
5078 }
5079
5080 /* Give tsv backref magic if it hasn't already got it, then push a
5081  * back-reference to sv onto the array associated with the backref magic.
5082  */
5083
5084 STATIC void
5085 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5086 {
5087     AV *av;
5088     MAGIC *mg;
5089     if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5090         av = (AV*)mg->mg_obj;
5091     else {
5092         av = newAV();
5093         sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5094         SvREFCNT_dec(av);           /* for sv_magic */
5095     }
5096     if (AvFILLp(av) >= AvMAX(av)) {
5097         SV **svp = AvARRAY(av);
5098         I32 i = AvFILLp(av);
5099         while (i >= 0) {
5100             if (svp[i] == &PL_sv_undef) {
5101                 svp[i] = sv;        /* reuse the slot */
5102                 return;
5103             }
5104             i--;
5105         }
5106         av_extend(av, AvFILLp(av)+1);
5107     }
5108     AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5109 }
5110
5111 /* delete a back-reference to ourselves from the backref magic associated
5112  * with the SV we point to.
5113  */
5114
5115 STATIC void
5116 S_sv_del_backref(pTHX_ SV *sv)
5117 {
5118     AV *av;
5119     SV **svp;
5120     I32 i;
5121     SV *tsv = SvRV(sv);
5122     MAGIC *mg = NULL;
5123     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5124         Perl_croak(aTHX_ "panic: del_backref");
5125     av = (AV *)mg->mg_obj;
5126     svp = AvARRAY(av);
5127     i = AvFILLp(av);
5128     while (i >= 0) {
5129         if (svp[i] == sv) {
5130             svp[i] = &PL_sv_undef; /* XXX */
5131         }
5132         i--;
5133     }
5134 }
5135
5136 /*
5137 =for apidoc sv_insert
5138
5139 Inserts a string at the specified offset/length within the SV. Similar to
5140 the Perl substr() function.
5141
5142 =cut
5143 */
5144
5145 void
5146 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
5147 {
5148     register char *big;
5149     register char *mid;
5150     register char *midend;
5151     register char *bigend;
5152     register I32 i;
5153     STRLEN curlen;
5154
5155
5156     if (!bigstr)
5157         Perl_croak(aTHX_ "Can't modify non-existent substring");
5158     SvPV_force(bigstr, curlen);
5159     (void)SvPOK_only_UTF8(bigstr);
5160     if (offset + len > curlen) {
5161         SvGROW(bigstr, offset+len+1);
5162         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5163         SvCUR_set(bigstr, offset+len);
5164     }
5165
5166     SvTAINT(bigstr);
5167     i = littlelen - len;
5168     if (i > 0) {                        /* string might grow */
5169         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5170         mid = big + offset + len;
5171         midend = bigend = big + SvCUR(bigstr);
5172         bigend += i;
5173         *bigend = '\0';
5174         while (midend > mid)            /* shove everything down */
5175             *--bigend = *--midend;
5176         Move(little,big+offset,littlelen,char);
5177         SvCUR(bigstr) += i;
5178         SvSETMAGIC(bigstr);
5179         return;
5180     }
5181     else if (i == 0) {
5182         Move(little,SvPVX(bigstr)+offset,len,char);
5183         SvSETMAGIC(bigstr);
5184         return;
5185     }
5186
5187     big = SvPVX(bigstr);
5188     mid = big + offset;
5189     midend = mid + len;
5190     bigend = big + SvCUR(bigstr);
5191
5192     if (midend > bigend)
5193         Perl_croak(aTHX_ "panic: sv_insert");
5194
5195     if (mid - big > bigend - midend) {  /* faster to shorten from end */
5196         if (littlelen) {
5197             Move(little, mid, littlelen,char);
5198             mid += littlelen;
5199         }
5200         i = bigend - midend;
5201         if (i > 0) {
5202             Move(midend, mid, i,char);
5203             mid += i;
5204         }
5205         *mid = '\0';
5206         SvCUR_set(bigstr, mid - big);
5207     }
5208     /*SUPPRESS 560*/
5209     else if ((i = mid - big)) { /* faster from front */
5210         midend -= littlelen;
5211         mid = midend;
5212         sv_chop(bigstr,midend-i);
5213         big += i;
5214         while (i--)
5215             *--midend = *--big;
5216         if (littlelen)
5217             Move(little, mid, littlelen,char);
5218     }
5219     else if (littlelen) {
5220         midend -= littlelen;
5221         sv_chop(bigstr,midend);
5222         Move(little,midend,littlelen,char);
5223     }
5224     else {
5225         sv_chop(bigstr,midend);
5226     }
5227     SvSETMAGIC(bigstr);
5228 }
5229
5230 /*
5231 =for apidoc sv_replace
5232
5233 Make the first argument a copy of the second, then delete the original.
5234 The target SV physically takes over ownership of the body of the source SV
5235 and inherits its flags; however, the target keeps any magic it owns,
5236 and any magic in the source is discarded.
5237 Note that this is a rather specialist SV copying operation; most of the
5238 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5239
5240 =cut
5241 */
5242
5243 void
5244 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5245 {
5246     U32 refcnt = SvREFCNT(sv);
5247     SV_CHECK_THINKFIRST_COW_DROP(sv);
5248     if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5249         Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5250     if (SvMAGICAL(sv)) {
5251         if (SvMAGICAL(nsv))
5252             mg_free(nsv);
5253         else
5254             sv_upgrade(nsv, SVt_PVMG);
5255         SvMAGIC(nsv) = SvMAGIC(sv);
5256         SvFLAGS(nsv) |= SvMAGICAL(sv);
5257         SvMAGICAL_off(sv);
5258         SvMAGIC(sv) = 0;
5259     }
5260     SvREFCNT(sv) = 0;
5261     sv_clear(sv);
5262     assert(!SvREFCNT(sv));
5263     StructCopy(nsv,sv,SV);
5264 #ifdef PERL_COPY_ON_WRITE
5265     if (SvIsCOW_normal(nsv)) {
5266         /* We need to follow the pointers around the loop to make the
5267            previous SV point to sv, rather than nsv.  */
5268         SV *next;
5269         SV *current = nsv;
5270         while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5271             assert(next);
5272             current = next;
5273             assert(SvPVX(current) == SvPVX(nsv));
5274         }
5275         /* Make the SV before us point to the SV after us.  */
5276         if (DEBUG_C_TEST) {
5277             PerlIO_printf(Perl_debug_log, "previous is\n");
5278             sv_dump(current);
5279             PerlIO_printf(Perl_debug_log,
5280                           "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5281                           (UV) SV_COW_NEXT_SV(current), (UV) sv);
5282         }
5283         SV_COW_NEXT_SV_SET(current, sv);
5284     }
5285 #endif
5286     SvREFCNT(sv) = refcnt;
5287     SvFLAGS(nsv) |= SVTYPEMASK;         /* Mark as freed */
5288     del_SV(nsv);
5289 }
5290
5291 /*
5292 =for apidoc sv_clear
5293
5294 Clear an SV: call any destructors, free up any memory used by the body,
5295 and free the body itself. The SV's head is I<not> freed, although
5296 its type is set to all 1's so that it won't inadvertently be assumed
5297 to be live during global destruction etc.
5298 This function should only be called when REFCNT is zero. Most of the time
5299 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5300 instead.
5301
5302 =cut
5303 */
5304
5305 void
5306 Perl_sv_clear(pTHX_ register SV *sv)
5307 {
5308     HV* stash;
5309     assert(sv);
5310     assert(SvREFCNT(sv) == 0);
5311
5312     if (SvOBJECT(sv)) {
5313         if (PL_defstash) {              /* Still have a symbol table? */
5314             dSP;
5315             CV* destructor;
5316
5317
5318
5319             do {
5320                 stash = SvSTASH(sv);
5321                 destructor = StashHANDLER(stash,DESTROY);
5322                 if (destructor) {
5323                     SV* tmpref = newRV(sv);
5324                     SvREADONLY_on(tmpref);   /* DESTROY() could be naughty */
5325                     ENTER;
5326                     PUSHSTACKi(PERLSI_DESTROY);
5327                     EXTEND(SP, 2);
5328                     PUSHMARK(SP);
5329                     PUSHs(tmpref);
5330                     PUTBACK;
5331                     call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5332
5333
5334                     POPSTACK;
5335                     SPAGAIN;
5336                     LEAVE;
5337                     if(SvREFCNT(tmpref) < 2) {
5338                         /* tmpref is not kept alive! */
5339                         SvREFCNT(sv)--;
5340                         SvRV(tmpref) = 0;
5341                         SvROK_off(tmpref);
5342                     }
5343                     SvREFCNT_dec(tmpref);
5344                 }
5345             } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5346
5347
5348             if (SvREFCNT(sv)) {
5349                 if (PL_in_clean_objs)
5350                     Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5351                           HvNAME(stash));
5352                 /* DESTROY gave object new lease on life */
5353                 return;
5354             }
5355         }
5356
5357         if (SvOBJECT(sv)) {
5358             SvREFCNT_dec(SvSTASH(sv));  /* possibly of changed persuasion */
5359             SvOBJECT_off(sv);   /* Curse the object. */
5360             if (SvTYPE(sv) != SVt_PVIO)
5361                 --PL_sv_objcount;       /* XXX Might want something more general */
5362         }
5363     }
5364     if (SvTYPE(sv) >= SVt_PVMG) {
5365         if (SvMAGIC(sv))
5366             mg_free(sv);
5367         if (SvFLAGS(sv) & SVpad_TYPED)
5368             SvREFCNT_dec(SvSTASH(sv));
5369     }
5370     stash = NULL;
5371     switch (SvTYPE(sv)) {
5372     case SVt_PVIO:
5373         if (IoIFP(sv) &&
5374             IoIFP(sv) != PerlIO_stdin() &&
5375             IoIFP(sv) != PerlIO_stdout() &&
5376             IoIFP(sv) != PerlIO_stderr())
5377         {
5378             io_close((IO*)sv, FALSE);
5379         }
5380         if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5381             PerlDir_close(IoDIRP(sv));
5382         IoDIRP(sv) = (DIR*)NULL;
5383         Safefree(IoTOP_NAME(sv));
5384         Safefree(IoFMT_NAME(sv));
5385         Safefree(IoBOTTOM_NAME(sv));
5386         /* FALL THROUGH */
5387     case SVt_PVBM:
5388         goto freescalar;
5389     case SVt_PVCV:
5390     case SVt_PVFM:
5391         cv_undef((CV*)sv);
5392         goto freescalar;
5393     case SVt_PVHV:
5394         hv_undef((HV*)sv);
5395         break;
5396     case SVt_PVAV:
5397         av_undef((AV*)sv);
5398         break;
5399     case SVt_PVLV:
5400         if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5401             SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5402             HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5403             PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5404         }
5405         else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV**  */
5406             SvREFCNT_dec(LvTARG(sv));
5407         goto freescalar;
5408     case SVt_PVGV:
5409         gp_free((GV*)sv);
5410         Safefree(GvNAME(sv));
5411         /* cannot decrease stash refcount yet, as we might recursively delete
5412            ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5413            of stash until current sv is completely gone.
5414            -- JohnPC, 27 Mar 1998 */
5415         stash = GvSTASH(sv);
5416         /* FALL THROUGH */
5417     case SVt_PVMG:
5418     case SVt_PVNV:
5419     case SVt_PVIV:
5420       freescalar:
5421         (void)SvOOK_off(sv);
5422         /* FALL THROUGH */
5423     case SVt_PV:
5424     case SVt_RV:
5425         if (SvROK(sv)) {
5426             if (SvWEAKREF(sv))
5427                 sv_del_backref(sv);
5428             else
5429                 SvREFCNT_dec(SvRV(sv));
5430         }
5431 #ifdef PERL_COPY_ON_WRITE
5432         else if (SvPVX(sv)) {
5433             if (SvIsCOW(sv)) {
5434                 /* I believe I need to grab the global SV mutex here and
5435                    then recheck the COW status.  */
5436                 if (DEBUG_C_TEST) {
5437                     PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5438                     sv_dump(sv);
5439                 }
5440                 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5441                                  SvUVX(sv), SV_COW_NEXT_SV(sv));
5442                 /* And drop it here.  */
5443                 SvFAKE_off(sv);
5444             } else if (SvLEN(sv)) {
5445                 Safefree(SvPVX(sv));
5446             }
5447         }
5448 #else
5449         else if (SvPVX(sv) && SvLEN(sv))
5450             Safefree(SvPVX(sv));
5451         else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5452             unsharepvn(SvPVX(sv),
5453                        SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5454                        SvUVX(sv));
5455             SvFAKE_off(sv);
5456         }
5457 #endif
5458         break;
5459 /*
5460     case SVt_NV:
5461     case SVt_IV:
5462     case SVt_NULL:
5463         break;
5464 */
5465     }
5466
5467     switch (SvTYPE(sv)) {
5468     case SVt_NULL:
5469         break;
5470     case SVt_IV:
5471         del_XIV(SvANY(sv));
5472         break;
5473     case SVt_NV:
5474         del_XNV(SvANY(sv));
5475         break;
5476     case SVt_RV:
5477         del_XRV(SvANY(sv));
5478         break;
5479     case SVt_PV:
5480         del_XPV(SvANY(sv));
5481         break;
5482     case SVt_PVIV:
5483         del_XPVIV(SvANY(sv));
5484         break;
5485     case SVt_PVNV:
5486         del_XPVNV(SvANY(sv));
5487         break;
5488     case SVt_PVMG:
5489         del_XPVMG(SvANY(sv));
5490         break;
5491     case SVt_PVLV:
5492         del_XPVLV(SvANY(sv));
5493         break;
5494     case SVt_PVAV:
5495         del_XPVAV(SvANY(sv));
5496         break;
5497     case SVt_PVHV:
5498         del_XPVHV(SvANY(sv));
5499         break;
5500     case SVt_PVCV:
5501         del_XPVCV(SvANY(sv));
5502         break;
5503     case SVt_PVGV:
5504         del_XPVGV(SvANY(sv));
5505         /* code duplication for increased performance. */
5506         SvFLAGS(sv) &= SVf_BREAK;
5507         SvFLAGS(sv) |= SVTYPEMASK;
5508         /* decrease refcount of the stash that owns this GV, if any */
5509         if (stash)
5510             SvREFCNT_dec(stash);
5511         return; /* not break, SvFLAGS reset already happened */
5512     case SVt_PVBM:
5513         del_XPVBM(SvANY(sv));
5514         break;
5515     case SVt_PVFM:
5516         del_XPVFM(SvANY(sv));
5517         break;
5518     case SVt_PVIO:
5519         del_XPVIO(SvANY(sv));
5520         break;
5521     }
5522     SvFLAGS(sv) &= SVf_BREAK;
5523     SvFLAGS(sv) |= SVTYPEMASK;
5524 }
5525
5526 /*
5527 =for apidoc sv_newref
5528
5529 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5530 instead.
5531
5532 =cut
5533 */
5534
5535 SV *
5536 Perl_sv_newref(pTHX_ SV *sv)
5537 {
5538     if (sv)
5539         (SvREFCNT(sv))++;
5540     return sv;
5541 }
5542
5543 /*
5544 =for apidoc sv_free
5545
5546 Decrement an SV's reference count, and if it drops to zero, call
5547 C<sv_clear> to invoke destructors and free up any memory used by
5548 the body; finally, deallocate the SV's head itself.
5549 Normally called via a wrapper macro C<SvREFCNT_dec>.
5550
5551 =cut
5552 */
5553
5554 void
5555 Perl_sv_free(pTHX_ SV *sv)
5556 {
5557     if (!sv)
5558         return;
5559     if (SvREFCNT(sv) == 0) {
5560         if (SvFLAGS(sv) & SVf_BREAK)
5561             /* this SV's refcnt has been artificially decremented to
5562              * trigger cleanup */
5563             return;
5564         if (PL_in_clean_all) /* All is fair */
5565             return;
5566         if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5567             /* make sure SvREFCNT(sv)==0 happens very seldom */
5568             SvREFCNT(sv) = (~(U32)0)/2;
5569             return;
5570         }
5571         if (ckWARN_d(WARN_INTERNAL))
5572             Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Attempt to free unreferenced scalar");
5573         return;
5574     }
5575     if (--(SvREFCNT(sv)) > 0)
5576         return;
5577     Perl_sv_free2(aTHX_ sv);
5578 }
5579
5580 void
5581 Perl_sv_free2(pTHX_ SV *sv)
5582 {
5583 #ifdef DEBUGGING
5584     if (SvTEMP(sv)) {
5585         if (ckWARN_d(WARN_DEBUGGING))
5586             Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5587                         "Attempt to free temp prematurely: SV 0x%"UVxf,
5588                         PTR2UV(sv));
5589         return;
5590     }
5591 #endif
5592     if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5593         /* make sure SvREFCNT(sv)==0 happens very seldom */
5594         SvREFCNT(sv) = (~(U32)0)/2;
5595         return;
5596     }
5597     sv_clear(sv);
5598     if (! SvREFCNT(sv))
5599         del_SV(sv);
5600 }
5601
5602 /*
5603 =for apidoc sv_len
5604
5605 Returns the length of the string in the SV. Handles magic and type
5606 coercion.  See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5607
5608 =cut
5609 */
5610
5611 STRLEN
5612 Perl_sv_len(pTHX_ register SV *sv)
5613 {
5614     STRLEN len;
5615
5616     if (!sv)
5617         return 0;
5618
5619     if (SvGMAGICAL(sv))
5620         len = mg_length(sv);
5621     else
5622         (void)SvPV(sv, len);
5623     return len;
5624 }
5625
5626 /*
5627 =for apidoc sv_len_utf8
5628
5629 Returns the number of characters in the string in an SV, counting wide
5630 UTF8 bytes as a single character. Handles magic and type coercion.
5631
5632 =cut
5633 */
5634
5635 /*
5636  * The length is cached in PERL_UTF8_magic, in the mg_len field.  Also the
5637  * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5638  * (Note that the mg_len is not the length of the mg_ptr field.)
5639  *
5640  */
5641
5642 STRLEN
5643 Perl_sv_len_utf8(pTHX_ register SV *sv)
5644 {
5645     if (!sv)
5646         return 0;
5647
5648     if (SvGMAGICAL(sv))
5649         return mg_length(sv);
5650     else
5651     {
5652         STRLEN len, ulen;
5653         U8 *s = (U8*)SvPV(sv, len);
5654         MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5655
5656         if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0))
5657             ulen = mg->mg_len;
5658         else {
5659             ulen = Perl_utf8_length(aTHX_ s, s + len);
5660             if (!mg && !SvREADONLY(sv)) {
5661                 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5662                 mg = mg_find(sv, PERL_MAGIC_utf8);
5663                 assert(mg);
5664             }
5665             if (mg)
5666                 mg->mg_len = ulen;
5667         }
5668         return ulen;
5669     }
5670 }
5671
5672 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5673  * a PERL_UTF8_magic.  The mg_ptr is used to store the mapping
5674  * between UTF-8 and byte offsets.  There are two (substr offset and substr
5675  * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5676  * and byte offset) cache positions.
5677  *
5678  * The mg_len field is used by sv_len_utf8(), see its comments.
5679  * Note that the mg_len is not the length of the mg_ptr field.
5680  *
5681  */
5682 STATIC bool
5683 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
5684 {
5685     bool found = FALSE;
5686
5687     if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5688         if (!*mgp) {
5689             sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5690             *mgp = mg_find(sv, PERL_MAGIC_utf8);
5691         }
5692         assert(*mgp);
5693
5694         if ((*mgp)->mg_ptr)
5695             *cachep = (STRLEN *) (*mgp)->mg_ptr;
5696         else {
5697             Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5698             (*mgp)->mg_ptr = (char *) *cachep;
5699         }
5700         assert(*cachep);
5701
5702         (*cachep)[i]   = *offsetp;
5703         (*cachep)[i+1] = s - start;
5704         found = TRUE;
5705     }
5706
5707     return found;
5708 }
5709
5710 /*
5711  * S_utf8_mg_pos() is used to query and update mg_ptr field of
5712  * a PERL_UTF8_magic.  The mg_ptr is used to store the mapping
5713  * between UTF-8 and byte offsets.  See also the comments of
5714  * S_utf8_mg_pos_init().
5715  *
5716  */
5717 STATIC bool
5718 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
5719 {
5720     bool found = FALSE;
5721
5722     if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5723         if (!*mgp)
5724             *mgp = mg_find(sv, PERL_MAGIC_utf8);
5725         if (*mgp && (*mgp)->mg_ptr) {
5726             *cachep = (STRLEN *) (*mgp)->mg_ptr;
5727             if ((*cachep)[i] == (STRLEN)uoff)   /* An exact match. */
5728                  found = TRUE;
5729             else {                      /* We will skip to the right spot. */
5730                  STRLEN forw  = 0;
5731                  STRLEN backw = 0;
5732                  U8* p = NULL;
5733
5734                  /* The assumption is that going backward is half
5735                   * the speed of going forward (that's where the
5736                   * 2 * backw in the below comes from).  (The real
5737                   * figure of course depends on the UTF-8 data.) */
5738
5739                  if ((*cachep)[i] > (STRLEN)uoff) {
5740                       forw  = uoff;
5741                       backw = (*cachep)[i] - (STRLEN)uoff;
5742
5743                       if (forw < 2 * backw)
5744                            p = start;
5745                       else
5746                            p = start + (*cachep)[i+1];
5747                  }
5748                  /* Try this only for the substr offset (i == 0),
5749                   * not for the substr length (i == 2). */
5750                  else if (i == 0) { /* (*cachep)[i] < uoff */
5751                       STRLEN ulen = sv_len_utf8(sv);
5752
5753                       if ((STRLEN)uoff < ulen) {
5754                            forw  = (STRLEN)uoff - (*cachep)[i];
5755                            backw = ulen - (STRLEN)uoff;
5756
5757                            if (forw < 2 * backw)
5758                                 p = start + (*cachep)[i+1];
5759                            else
5760                                 p = send;
5761                       }
5762
5763                       /* If the string is not long enough for uoff,
5764                        * we could extend it, but not at this low a level. */
5765                  }
5766
5767                  if (p) {
5768                       if (forw < 2 * backw) {
5769                            while (forw--)
5770                                 p += UTF8SKIP(p);
5771                       }
5772                       else {
5773                            while (backw--) {
5774                                 p--;
5775                                 while (UTF8_IS_CONTINUATION(*p))
5776                                      p--;
5777                            }
5778                       }
5779
5780                       /* Update the cache. */
5781                       (*cachep)[i]   = (STRLEN)uoff;
5782                       (*cachep)[i+1] = p - start;
5783
5784                       found = TRUE;
5785                  }
5786             }
5787             if (found) {        /* Setup the return values. */
5788                  *offsetp = (*cachep)[i+1];
5789                  *sp = start + *offsetp;
5790                  if (*sp >= send) {
5791                       *sp = send;
5792                       *offsetp = send - start;
5793                  }
5794                  else if (*sp < start) {
5795                       *sp = start;
5796                       *offsetp = 0;
5797                  }
5798             }
5799         }
5800     }
5801     return found;
5802 }
5803
5804 /*
5805 =for apidoc sv_pos_u2b
5806
5807 Converts the value pointed to by offsetp from a count of UTF8 chars from
5808 the start of the string, to a count of the equivalent number of bytes; if
5809 lenp is non-zero, it does the same to lenp, but this time starting from
5810 the offset, rather than from the start of the string. Handles magic and
5811 type coercion.
5812
5813 =cut
5814 */
5815
5816 /*
5817  * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5818  * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5819  * byte offsets.  See also the comments of S_utf8_mg_pos().
5820  *
5821  */
5822
5823 void
5824 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5825 {
5826     U8 *start;
5827     U8 *s;
5828     STRLEN len;
5829     STRLEN *cache = 0;
5830     STRLEN boffset = 0;
5831
5832     if (!sv)
5833         return;
5834
5835     start = s = (U8*)SvPV(sv, len);
5836     if (len) {
5837          I32 uoffset = *offsetp;
5838          U8 *send = s + len;
5839          MAGIC *mg = 0;
5840          bool found = FALSE;
5841
5842          if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5843              found = TRUE;
5844          if (!found && uoffset > 0) {
5845               while (s < send && uoffset--)
5846                    s += UTF8SKIP(s);
5847               if (s >= send)
5848                    s = send;
5849               if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
5850                   boffset = cache[1];
5851               *offsetp = s - start;
5852          }
5853          if (lenp) {
5854               found = FALSE;
5855               start = s;
5856               if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
5857                   *lenp -= boffset;
5858                   found = TRUE;
5859               }
5860               if (!found && *lenp > 0) {
5861                    I32 ulen = *lenp;
5862                    if (ulen > 0)
5863                         while (s < send && ulen--)
5864                              s += UTF8SKIP(s);
5865                    if (s >= send)
5866                         s = send;
5867                    if (utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start))
5868                         cache[2] += *offsetp;
5869               }
5870               *lenp = s - start;
5871          }
5872     }
5873     else {
5874          *offsetp = 0;
5875          if (lenp)
5876               *lenp = 0;
5877     }
5878     return;
5879 }
5880
5881 /*
5882 =for apidoc sv_pos_b2u
5883
5884 Converts the value pointed to by offsetp from a count of bytes from the
5885 start of the string, to a count of the equivalent number of UTF8 chars.
5886 Handles magic and type coercion.
5887
5888 =cut
5889 */
5890
5891 /*
5892  * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5893  * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5894  * byte offsets.  See also the comments of S_utf8_mg_pos().
5895  *
5896  */
5897
5898 void
5899 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5900 {
5901     U8* s;
5902     STRLEN len;
5903
5904     if (!sv)
5905         return;
5906
5907     s = (U8*)SvPV(sv, len);
5908     if ((I32)len < *offsetp)
5909         Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5910     else {
5911         U8* send = s + *offsetp;
5912         MAGIC* mg = NULL;
5913         STRLEN *cache = NULL;
5914
5915         len = 0;
5916
5917         if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5918             mg = mg_find(sv, PERL_MAGIC_utf8);
5919             if (mg && mg->mg_ptr) {
5920                 cache = (STRLEN *) mg->mg_ptr;
5921                 if (cache[1] == (STRLEN)*offsetp) {
5922                     /* An exact match. */
5923                     *offsetp = cache[0];
5924
5925                     return;
5926                 }
5927                 else if (cache[1] < (STRLEN)*offsetp) {
5928                     /* We already know part of the way. */
5929                     len = cache[0];
5930                     s  += cache[1];
5931                     /* Let the below loop do the rest. */
5932                 }
5933                 else { /* cache[1] > *offsetp */
5934                     /* We already know all of the way, now we may
5935                      * be able to walk back.  The same assumption
5936                      * is made as in S_utf8_mg_pos(), namely that
5937                      * walking backward is twice slower than
5938                      * walking forward. */
5939                     STRLEN forw  = *offsetp;
5940                     STRLEN backw = cache[1] - *offsetp;
5941
5942                     if (!(forw < 2 * backw)) {
5943                         U8 *p = s + cache[1];
5944                         STRLEN ubackw = 0;
5945
5946                         cache[1] -= backw;
5947
5948                         while (backw--) {
5949                             p--;
5950                             while (UTF8_IS_CONTINUATION(*p)) {
5951                                 p--;
5952                                 backw--;
5953                             }
5954                             ubackw++;
5955                         }
5956
5957                         cache[0] -= ubackw;
5958                         *offsetp = cache[0];
5959                         return;
5960                     }
5961                 }
5962             }
5963         }
5964
5965         while (s < send) {
5966             STRLEN n = 1;
5967
5968             /* Call utf8n_to_uvchr() to validate the sequence
5969              * (unless a simple non-UTF character) */
5970             if (!UTF8_IS_INVARIANT(*s))
5971                 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5972             if (n > 0) {
5973                 s += n;
5974                 len++;
5975             }
5976             else
5977                 break;
5978         }
5979
5980         if (!SvREADONLY(sv)) {
5981             if (!mg) {
5982                 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5983                 mg = mg_find(sv, PERL_MAGIC_utf8);
5984             }
5985             assert(mg);
5986
5987             if (!mg->mg_ptr) {
5988                 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5989                 mg->mg_ptr = (char *) cache;
5990             }
5991             assert(cache);
5992
5993             cache[0] = len;
5994             cache[1] = *offsetp;
5995         }
5996
5997         *offsetp = len;
5998     }
5999     return;
6000 }
6001
6002 /*
6003 =for apidoc sv_eq
6004
6005 Returns a boolean indicating whether the strings in the two SVs are
6006 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6007 coerce its args to strings if necessary.
6008
6009 =cut
6010 */
6011
6012 I32
6013 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6014 {
6015     char *pv1;
6016     STRLEN cur1;
6017     char *pv2;
6018     STRLEN cur2;
6019     I32  eq     = 0;
6020     char *tpv   = Nullch;
6021     SV* svrecode = Nullsv;
6022
6023     if (!sv1) {
6024         pv1 = "";
6025         cur1 = 0;
6026     }
6027     else
6028         pv1 = SvPV(sv1, cur1);
6029
6030     if (!sv2){
6031         pv2 = "";
6032         cur2 = 0;
6033     }
6034     else
6035         pv2 = SvPV(sv2, cur2);
6036
6037     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6038         /* Differing utf8ness.
6039          * Do not UTF8size the comparands as a side-effect. */
6040          if (PL_encoding) {
6041               if (SvUTF8(sv1)) {
6042                    svrecode = newSVpvn(pv2, cur2);
6043                    sv_recode_to_utf8(svrecode, PL_encoding);
6044                    pv2 = SvPV(svrecode, cur2);
6045               }
6046               else {
6047                    svrecode = newSVpvn(pv1, cur1);
6048                    sv_recode_to_utf8(svrecode, PL_encoding);
6049                    pv1 = SvPV(svrecode, cur1);
6050               }
6051               /* Now both are in UTF-8. */
6052               if (cur1 != cur2)
6053                    return FALSE;
6054          }
6055          else {
6056               bool is_utf8 = TRUE;
6057
6058               if (SvUTF8(sv1)) {
6059                    /* sv1 is the UTF-8 one,
6060                     * if is equal it must be downgrade-able */
6061                    char *pv = (char*)bytes_from_utf8((U8*)pv1,
6062                                                      &cur1, &is_utf8);
6063                    if (pv != pv1)
6064                         pv1 = tpv = pv;
6065               }
6066               else {
6067                    /* sv2 is the UTF-8 one,
6068                     * if is equal it must be downgrade-able */
6069                    char *pv = (char *)bytes_from_utf8((U8*)pv2,
6070                                                       &cur2, &is_utf8);
6071                    if (pv != pv2)
6072                         pv2 = tpv = pv;
6073               }
6074               if (is_utf8) {
6075                    /* Downgrade not possible - cannot be eq */
6076                    return FALSE;
6077               }
6078          }
6079     }
6080
6081     if (cur1 == cur2)
6082         eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6083
6084     if (svrecode)
6085          SvREFCNT_dec(svrecode);
6086
6087     if (tpv)
6088         Safefree(tpv);
6089
6090     return eq;
6091 }
6092
6093 /*
6094 =for apidoc sv_cmp
6095
6096 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
6097 string in C<sv1> is less than, equal to, or greater than the string in
6098 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6099 coerce its args to strings if necessary.  See also C<sv_cmp_locale>.
6100
6101 =cut
6102 */
6103
6104 I32
6105 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6106 {
6107     STRLEN cur1, cur2;
6108     char *pv1, *pv2, *tpv = Nullch;
6109     I32  cmp;
6110     SV *svrecode = Nullsv;
6111
6112     if (!sv1) {
6113         pv1 = "";
6114         cur1 = 0;
6115     }
6116     else
6117         pv1 = SvPV(sv1, cur1);
6118
6119     if (!sv2) {
6120         pv2 = "";
6121         cur2 = 0;
6122     }
6123     else
6124         pv2 = SvPV(sv2, cur2);
6125
6126     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6127         /* Differing utf8ness.
6128          * Do not UTF8size the comparands as a side-effect. */
6129         if (SvUTF8(sv1)) {
6130             if (PL_encoding) {
6131                  svrecode = newSVpvn(pv2, cur2);
6132                  sv_recode_to_utf8(svrecode, PL_encoding);
6133                  pv2 = SvPV(svrecode, cur2);
6134             }
6135             else {
6136                  pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
6137             }
6138         }
6139         else {
6140             if (PL_encoding) {
6141                  svrecode = newSVpvn(pv1, cur1);
6142                  sv_recode_to_utf8(svrecode, PL_encoding);
6143                  pv1 = SvPV(svrecode, cur1);
6144             }
6145             else {
6146                  pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
6147             }
6148         }
6149     }
6150
6151     if (!cur1) {
6152         cmp = cur2 ? -1 : 0;
6153     } else if (!cur2) {
6154         cmp = 1;
6155     } else {
6156         I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
6157
6158         if (retval) {
6159             cmp = retval < 0 ? -1 : 1;
6160         } else if (cur1 == cur2) {
6161             cmp = 0;
6162         } else {
6163             cmp = cur1 < cur2 ? -1 : 1;
6164         }
6165     }
6166
6167     if (svrecode)
6168          SvREFCNT_dec(svrecode);
6169
6170     if (tpv)
6171         Safefree(tpv);
6172
6173     return cmp;
6174 }
6175
6176 /*
6177 =for apidoc sv_cmp_locale
6178
6179 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6180 'use bytes' aware, handles get magic, and will coerce its args to strings
6181 if necessary.  See also C<sv_cmp_locale>.  See also C<sv_cmp>.
6182
6183 =cut
6184 */
6185
6186 I32
6187 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6188 {
6189 #ifdef USE_LOCALE_COLLATE
6190
6191     char *pv1, *pv2;
6192     STRLEN len1, len2;
6193     I32 retval;
6194
6195     if (PL_collation_standard)
6196         goto raw_compare;
6197
6198     len1 = 0;
6199     pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6200     len2 = 0;
6201     pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6202
6203     if (!pv1 || !len1) {
6204         if (pv2 && len2)
6205             return -1;
6206         else
6207             goto raw_compare;
6208     }
6209     else {
6210         if (!pv2 || !len2)
6211             return 1;
6212     }
6213
6214     retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6215
6216     if (retval)
6217         return retval < 0 ? -1 : 1;
6218
6219     /*
6220      * When the result of collation is equality, that doesn't mean
6221      * that there are no differences -- some locales exclude some
6222      * characters from consideration.  So to avoid false equalities,
6223      * we use the raw string as a tiebreaker.
6224      */
6225
6226   raw_compare:
6227     /* FALL THROUGH */
6228
6229 #endif /* USE_LOCALE_COLLATE */
6230
6231     return sv_cmp(sv1, sv2);
6232 }
6233
6234
6235 #ifdef USE_LOCALE_COLLATE
6236
6237 /*
6238 =for apidoc sv_collxfrm
6239
6240 Add Collate Transform magic to an SV if it doesn't already have it.
6241
6242 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6243 scalar data of the variable, but transformed to such a format that a normal
6244 memory comparison can be used to compare the data according to the locale
6245 settings.
6246
6247 =cut
6248 */
6249
6250 char *
6251 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6252 {
6253     MAGIC *mg;
6254
6255     mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6256     if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6257         char *s, *xf;
6258         STRLEN len, xlen;
6259
6260         if (mg)
6261             Safefree(mg->mg_ptr);
6262         s = SvPV(sv, len);
6263         if ((xf = mem_collxfrm(s, len, &xlen))) {
6264             if (SvREADONLY(sv)) {
6265                 SAVEFREEPV(xf);
6266                 *nxp = xlen;
6267                 return xf + sizeof(PL_collation_ix);
6268             }
6269             if (! mg) {
6270                 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6271                 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6272                 assert(mg);
6273             }
6274             mg->mg_ptr = xf;
6275             mg->mg_len = xlen;
6276         }
6277         else {
6278             if (mg) {
6279                 mg->mg_ptr = NULL;
6280                 mg->mg_len = -1;
6281             }
6282         }
6283     }
6284     if (mg && mg->mg_ptr) {
6285         *nxp = mg->mg_len;
6286         return mg->mg_ptr + sizeof(PL_collation_ix);
6287     }
6288     else {
6289         *nxp = 0;
6290         return NULL;
6291     }
6292 }
6293
6294 #endif /* USE_LOCALE_COLLATE */
6295
6296 /*
6297 =for apidoc sv_gets
6298
6299 Get a line from the filehandle and store it into the SV, optionally
6300 appending to the currently-stored string.
6301
6302 =cut
6303 */
6304
6305 char *
6306 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6307 {
6308     char *rsptr;
6309     STRLEN rslen;
6310     register STDCHAR rslast;
6311     register STDCHAR *bp;
6312     register I32 cnt;
6313     I32 i = 0;
6314     I32 rspara = 0;
6315     I32 recsize;
6316
6317     if (SvTHINKFIRST(sv))
6318         sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6319     /* XXX. If you make this PVIV, then copy on write can copy scalars read
6320        from <>.
6321        However, perlbench says it's slower, because the existing swipe code
6322        is faster than copy on write.
6323        Swings and roundabouts.  */
6324     (void)SvUPGRADE(sv, SVt_PV);
6325
6326     SvSCREAM_off(sv);
6327
6328     if (append) {
6329         if (PerlIO_isutf8(fp)) {
6330             if (!SvUTF8(sv)) {
6331                 sv_utf8_upgrade_nomg(sv);
6332                 sv_pos_u2b(sv,&append,0);
6333             }
6334         } else if (SvUTF8(sv)) {
6335             SV *tsv = NEWSV(0,0);
6336             sv_gets(tsv, fp, 0);
6337             sv_utf8_upgrade_nomg(tsv);
6338             SvCUR_set(sv,append);
6339             sv_catsv(sv,tsv);
6340             sv_free(tsv);
6341             goto return_string_or_null;
6342         }
6343     }
6344
6345     SvPOK_only(sv);
6346     if (PerlIO_isutf8(fp))
6347         SvUTF8_on(sv);
6348
6349     if (PL_curcop == &PL_compiling) {
6350         /* we always read code in line mode */
6351         rsptr = "\n";
6352         rslen = 1;
6353     }
6354     else if (RsSNARF(PL_rs)) {
6355         /* If it is a regular disk file use size from stat() as estimate
6356            of amount we are going to read - may result in malloc-ing
6357            more memory than we realy need if layers bellow reduce
6358            size we read (e.g. CRLF or a gzip layer)
6359          */
6360         Stat_t st;
6361         if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode))  {
6362             Off_t offset = PerlIO_tell(fp);
6363             if (offset != (Off_t) -1 && st.st_size + append > offset) {
6364                 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6365             }
6366         }
6367         rsptr = NULL;
6368         rslen = 0;
6369     }
6370     else if (RsRECORD(PL_rs)) {
6371       I32 bytesread;
6372       char *buffer;
6373
6374       /* Grab the size of the record we're getting */
6375       recsize = SvIV(SvRV(PL_rs));
6376       buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6377       /* Go yank in */
6378 #ifdef VMS
6379       /* VMS wants read instead of fread, because fread doesn't respect */
6380       /* RMS record boundaries. This is not necessarily a good thing to be */
6381       /* doing, but we've got no other real choice - except avoid stdio
6382          as implementation - perhaps write a :vms layer ?
6383        */
6384       bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6385 #else
6386       bytesread = PerlIO_read(fp, buffer, recsize);
6387 #endif
6388       if (bytesread < 0)
6389           bytesread = 0;
6390       SvCUR_set(sv, bytesread += append);
6391       buffer[bytesread] = '\0';
6392       goto return_string_or_null;
6393     }
6394     else if (RsPARA(PL_rs)) {
6395         rsptr = "\n\n";
6396         rslen = 2;
6397         rspara = 1;
6398     }
6399     else {
6400         /* Get $/ i.e. PL_rs into same encoding as stream wants */
6401         if (PerlIO_isutf8(fp)) {
6402             rsptr = SvPVutf8(PL_rs, rslen);
6403         }
6404         else {
6405             if (SvUTF8(PL_rs)) {
6406                 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6407                     Perl_croak(aTHX_ "Wide character in $/");
6408                 }
6409             }
6410             rsptr = SvPV(PL_rs, rslen);
6411         }
6412     }
6413
6414     rslast = rslen ? rsptr[rslen - 1] : '\0';
6415
6416     if (rspara) {               /* have to do this both before and after */
6417         do {                    /* to make sure file boundaries work right */
6418             if (PerlIO_eof(fp))
6419                 return 0;
6420             i = PerlIO_getc(fp);
6421             if (i != '\n') {
6422                 if (i == -1)
6423                     return 0;
6424                 PerlIO_ungetc(fp,i);
6425                 break;
6426             }
6427         } while (i != EOF);
6428     }
6429
6430     /* See if we know enough about I/O mechanism to cheat it ! */
6431
6432     /* This used to be #ifdef test - it is made run-time test for ease
6433        of abstracting out stdio interface. One call should be cheap
6434        enough here - and may even be a macro allowing compile
6435        time optimization.
6436      */
6437
6438     if (PerlIO_fast_gets(fp)) {
6439
6440     /*
6441      * We're going to steal some values from the stdio struct
6442      * and put EVERYTHING in the innermost loop into registers.
6443      */
6444     register STDCHAR *ptr;
6445     STRLEN bpx;
6446     I32 shortbuffered;
6447
6448 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6449     /* An ungetc()d char is handled separately from the regular
6450      * buffer, so we getc() it back out and stuff it in the buffer.
6451      */
6452     i = PerlIO_getc(fp);
6453     if (i == EOF) return 0;
6454     *(--((*fp)->_ptr)) = (unsigned char) i;
6455     (*fp)->_cnt++;
6456 #endif
6457
6458     /* Here is some breathtakingly efficient cheating */
6459
6460     cnt = PerlIO_get_cnt(fp);                   /* get count into register */
6461     /* make sure we have the room */
6462     if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6463         /* Not room for all of it
6464            if we are looking for a separator and room for some
6465          */
6466         if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6467             /* just process what we have room for */
6468             shortbuffered = cnt - SvLEN(sv) + append + 1;
6469             cnt -= shortbuffered;
6470         }
6471         else {
6472             shortbuffered = 0;
6473             /* remember that cnt can be negative */
6474             SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6475         }
6476     }
6477     else
6478         shortbuffered = 0;
6479     bp = (STDCHAR*)SvPVX(sv) + append;  /* move these two too to registers */
6480     ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6481     DEBUG_P(PerlIO_printf(Perl_debug_log,
6482         "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6483     DEBUG_P(PerlIO_printf(Perl_debug_log,
6484         "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6485                PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6486                PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6487     for (;;) {
6488       screamer:
6489         if (cnt > 0) {
6490             if (rslen) {
6491                 while (cnt > 0) {                    /* this     |  eat */
6492                     cnt--;
6493                     if ((*bp++ = *ptr++) == rslast)  /* really   |  dust */
6494                         goto thats_all_folks;        /* screams  |  sed :-) */
6495                 }
6496             }
6497             else {
6498                 Copy(ptr, bp, cnt, char);            /* this     |  eat */
6499                 bp += cnt;                           /* screams  |  dust */
6500                 ptr += cnt;                          /* louder   |  sed :-) */
6501                 cnt = 0;
6502             }
6503         }
6504
6505         if (shortbuffered) {            /* oh well, must extend */
6506             cnt = shortbuffered;
6507             shortbuffered = 0;
6508             bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6509             SvCUR_set(sv, bpx);
6510             SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6511             bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6512             continue;
6513         }
6514
6515         DEBUG_P(PerlIO_printf(Perl_debug_log,
6516                               "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6517                               PTR2UV(ptr),(long)cnt));
6518         PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6519 #if 0
6520         DEBUG_P(PerlIO_printf(Perl_debug_log,
6521             "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6522             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6523             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6524 #endif
6525         /* This used to call 'filbuf' in stdio form, but as that behaves like
6526            getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6527            another abstraction.  */
6528         i   = PerlIO_getc(fp);          /* get more characters */
6529 #if 0
6530         DEBUG_P(PerlIO_printf(Perl_debug_log,
6531             "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6532             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6533             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6534 #endif
6535         cnt = PerlIO_get_cnt(fp);
6536         ptr = (STDCHAR*)PerlIO_get_ptr(fp);     /* reregisterize cnt and ptr */
6537         DEBUG_P(PerlIO_printf(Perl_debug_log,
6538             "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6539
6540         if (i == EOF)                   /* all done for ever? */
6541             goto thats_really_all_folks;
6542
6543         bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
6544         SvCUR_set(sv, bpx);
6545         SvGROW(sv, bpx + cnt + 2);
6546         bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6547
6548         *bp++ = (STDCHAR)i;             /* store character from PerlIO_getc */
6549
6550         if (rslen && (STDCHAR)i == rslast)  /* all done for now? */
6551             goto thats_all_folks;
6552     }
6553
6554 thats_all_folks:
6555     if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
6556           memNE((char*)bp - rslen, rsptr, rslen))
6557         goto screamer;                          /* go back to the fray */
6558 thats_really_all_folks:
6559     if (shortbuffered)
6560         cnt += shortbuffered;
6561         DEBUG_P(PerlIO_printf(Perl_debug_log,
6562             "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6563     PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt);  /* put these back or we're in trouble */
6564     DEBUG_P(PerlIO_printf(Perl_debug_log,
6565         "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6566         PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6567         PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6568     *bp = '\0';
6569     SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv));    /* set length */
6570     DEBUG_P(PerlIO_printf(Perl_debug_log,
6571         "Screamer: done, len=%ld, string=|%.*s|\n",
6572         (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
6573     }
6574    else
6575     {
6576 #ifndef EPOC
6577        /*The big, slow, and stupid way */
6578         STDCHAR buf[8192];
6579 #else
6580         /* Need to work around EPOC SDK features          */
6581         /* On WINS: MS VC5 generates calls to _chkstk,    */
6582         /* if a `large' stack frame is allocated          */
6583         /* gcc on MARM does not generate calls like these */
6584         STDCHAR buf[1024];
6585 #endif
6586
6587 screamer2:
6588         if (rslen) {
6589             register STDCHAR *bpe = buf + sizeof(buf);
6590             bp = buf;
6591             while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6592                 ; /* keep reading */
6593             cnt = bp - buf;
6594         }
6595         else {
6596             cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6597             /* Accomodate broken VAXC compiler, which applies U8 cast to
6598              * both args of ?: operator, causing EOF to change into 255
6599              */
6600             if (cnt > 0)
6601                  i = (U8)buf[cnt - 1];
6602             else
6603                  i = EOF;
6604         }
6605
6606         if (cnt < 0)
6607             cnt = 0;  /* we do need to re-set the sv even when cnt <= 0 */
6608         if (append)
6609              sv_catpvn(sv, (char *) buf, cnt);
6610         else
6611              sv_setpvn(sv, (char *) buf, cnt);
6612
6613         if (i != EOF &&                 /* joy */
6614             (!rslen ||
6615              SvCUR(sv) < rslen ||
6616              memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6617         {
6618             append = -1;
6619             /*
6620              * If we're reading from a TTY and we get a short read,
6621              * indicating that the user hit his EOF character, we need
6622              * to notice it now, because if we try to read from the TTY
6623              * again, the EOF condition will disappear.
6624              *
6625              * The comparison of cnt to sizeof(buf) is an optimization
6626              * that prevents unnecessary calls to feof().
6627              *
6628              * - jik 9/25/96
6629              */
6630             if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6631                 goto screamer2;
6632         }
6633     }
6634
6635     if (rspara) {               /* have to do this both before and after */
6636         while (i != EOF) {      /* to make sure file boundaries work right */
6637             i = PerlIO_getc(fp);
6638             if (i != '\n') {
6639                 PerlIO_ungetc(fp,i);
6640                 break;
6641             }
6642         }
6643     }
6644
6645 return_string_or_null:
6646     return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6647 }
6648
6649 /*
6650 =for apidoc sv_inc
6651
6652 Auto-increment of the value in the SV, doing string to numeric conversion
6653 if necessary. Handles 'get' magic.
6654
6655 =cut
6656 */
6657
6658 void
6659 Perl_sv_inc(pTHX_ register SV *sv)
6660 {
6661     register char *d;
6662     int flags;
6663
6664     if (!sv)
6665         return;
6666     if (SvGMAGICAL(sv))
6667         mg_get(sv);
6668     if (SvTHINKFIRST(sv)) {
6669         if (SvIsCOW(sv))
6670             sv_force_normal_flags(sv, 0);
6671         if (SvREADONLY(sv)) {
6672             if (PL_curcop != &PL_compiling)
6673                 Perl_croak(aTHX_ PL_no_modify);
6674         }
6675         if (SvROK(sv)) {
6676             IV i;
6677             if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6678                 return;
6679             i = PTR2IV(SvRV(sv));
6680             sv_unref(sv);
6681             sv_setiv(sv, i);
6682         }
6683     }
6684     flags = SvFLAGS(sv);
6685     if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6686         /* It's (privately or publicly) a float, but not tested as an
6687            integer, so test it to see. */
6688         (void) SvIV(sv);
6689         flags = SvFLAGS(sv);
6690     }
6691     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6692         /* It's publicly an integer, or privately an integer-not-float */
6693 #ifdef PERL_PRESERVE_IVUV
6694       oops_its_int:
6695 #endif
6696         if (SvIsUV(sv)) {
6697             if (SvUVX(sv) == UV_MAX)
6698                 sv_setnv(sv, UV_MAX_P1);
6699             else
6700                 (void)SvIOK_only_UV(sv);
6701                 ++SvUVX(sv);
6702         } else {
6703             if (SvIVX(sv) == IV_MAX)
6704                 sv_setuv(sv, (UV)IV_MAX + 1);
6705             else {
6706                 (void)SvIOK_only(sv);
6707                 ++SvIVX(sv);
6708             }
6709         }
6710         return;
6711     }
6712     if (flags & SVp_NOK) {
6713         (void)SvNOK_only(sv);
6714         SvNVX(sv) += 1.0;
6715         return;
6716     }
6717
6718     if (!(flags & SVp_POK) || !*SvPVX(sv)) {
6719         if ((flags & SVTYPEMASK) < SVt_PVIV)
6720             sv_upgrade(sv, SVt_IV);
6721         (void)SvIOK_only(sv);
6722         SvIVX(sv) = 1;
6723         return;
6724     }
6725     d = SvPVX(sv);
6726     while (isALPHA(*d)) d++;
6727     while (isDIGIT(*d)) d++;
6728     if (*d) {
6729 #ifdef PERL_PRESERVE_IVUV
6730         /* Got to punt this as an integer if needs be, but we don't issue
6731            warnings. Probably ought to make the sv_iv_please() that does
6732            the conversion if possible, and silently.  */
6733         int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6734         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6735             /* Need to try really hard to see if it's an integer.
6736                9.22337203685478e+18 is an integer.
6737                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6738                so $a="9.22337203685478e+18"; $a+0; $a++
6739                needs to be the same as $a="9.22337203685478e+18"; $a++
6740                or we go insane. */
6741
6742             (void) sv_2iv(sv);
6743             if (SvIOK(sv))
6744                 goto oops_its_int;
6745
6746             /* sv_2iv *should* have made this an NV */
6747             if (flags & SVp_NOK) {
6748                 (void)SvNOK_only(sv);
6749                 SvNVX(sv) += 1.0;
6750                 return;
6751             }
6752             /* I don't think we can get here. Maybe I should assert this
6753                And if we do get here I suspect that sv_setnv will croak. NWC
6754                Fall through. */
6755 #if defined(USE_LONG_DOUBLE)
6756             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",
6757                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6758 #else
6759             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6760                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6761 #endif
6762         }
6763 #endif /* PERL_PRESERVE_IVUV */
6764         sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
6765         return;
6766     }
6767     d--;
6768     while (d >= SvPVX(sv)) {
6769         if (isDIGIT(*d)) {
6770             if (++*d <= '9')
6771                 return;
6772             *(d--) = '0';
6773         }
6774         else {
6775 #ifdef EBCDIC
6776             /* MKS: The original code here died if letters weren't consecutive.
6777              * at least it didn't have to worry about non-C locales.  The
6778              * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6779              * arranged in order (although not consecutively) and that only
6780              * [A-Za-z] are accepted by isALPHA in the C locale.
6781              */
6782             if (*d != 'z' && *d != 'Z') {
6783                 do { ++*d; } while (!isALPHA(*d));
6784                 return;
6785             }
6786             *(d--) -= 'z' - 'a';
6787 #else
6788             ++*d;
6789             if (isALPHA(*d))
6790                 return;
6791             *(d--) -= 'z' - 'a' + 1;
6792 #endif
6793         }
6794     }
6795     /* oh,oh, the number grew */
6796     SvGROW(sv, SvCUR(sv) + 2);
6797     SvCUR(sv)++;
6798     for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
6799         *d = d[-1];
6800     if (isDIGIT(d[1]))
6801         *d = '1';
6802     else
6803         *d = d[1];
6804 }
6805
6806 /*
6807 =for apidoc sv_dec
6808
6809 Auto-decrement of the value in the SV, doing string to numeric conversion
6810 if necessary. Handles 'get' magic.
6811
6812 =cut
6813 */
6814
6815 void
6816 Perl_sv_dec(pTHX_ register SV *sv)
6817 {
6818     int flags;
6819
6820     if (!sv)
6821         return;
6822     if (SvGMAGICAL(sv))
6823         mg_get(sv);
6824     if (SvTHINKFIRST(sv)) {
6825         if (SvIsCOW(sv))
6826             sv_force_normal_flags(sv, 0);
6827         if (SvREADONLY(sv)) {
6828             if (PL_curcop != &PL_compiling)
6829                 Perl_croak(aTHX_ PL_no_modify);
6830         }
6831         if (SvROK(sv)) {
6832             IV i;
6833             if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6834                 return;
6835             i = PTR2IV(SvRV(sv));
6836             sv_unref(sv);
6837             sv_setiv(sv, i);
6838         }
6839     }
6840     /* Unlike sv_inc we don't have to worry about string-never-numbers
6841        and keeping them magic. But we mustn't warn on punting */
6842     flags = SvFLAGS(sv);
6843     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6844         /* It's publicly an integer, or privately an integer-not-float */
6845 #ifdef PERL_PRESERVE_IVUV
6846       oops_its_int:
6847 #endif
6848         if (SvIsUV(sv)) {
6849             if (SvUVX(sv) == 0) {
6850                 (void)SvIOK_only(sv);
6851                 SvIVX(sv) = -1;
6852             }
6853             else {
6854                 (void)SvIOK_only_UV(sv);
6855                 --SvUVX(sv);
6856             }
6857         } else {
6858             if (SvIVX(sv) == IV_MIN)
6859                 sv_setnv(sv, (NV)IV_MIN - 1.0);
6860             else {
6861                 (void)SvIOK_only(sv);
6862                 --SvIVX(sv);
6863             }
6864         }
6865         return;
6866     }
6867     if (flags & SVp_NOK) {
6868         SvNVX(sv) -= 1.0;
6869         (void)SvNOK_only(sv);
6870         return;
6871     }
6872     if (!(flags & SVp_POK)) {
6873         if ((flags & SVTYPEMASK) < SVt_PVNV)
6874             sv_upgrade(sv, SVt_NV);
6875         SvNVX(sv) = -1.0;
6876         (void)SvNOK_only(sv);
6877         return;
6878     }
6879 #ifdef PERL_PRESERVE_IVUV
6880     {
6881         int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
6882         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6883             /* Need to try really hard to see if it's an integer.
6884                9.22337203685478e+18 is an integer.
6885                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6886                so $a="9.22337203685478e+18"; $a+0; $a--
6887                needs to be the same as $a="9.22337203685478e+18"; $a--
6888                or we go insane. */
6889
6890             (void) sv_2iv(sv);
6891             if (SvIOK(sv))
6892                 goto oops_its_int;
6893
6894             /* sv_2iv *should* have made this an NV */
6895             if (flags & SVp_NOK) {
6896                 (void)SvNOK_only(sv);
6897                 SvNVX(sv) -= 1.0;
6898                 return;
6899             }
6900             /* I don't think we can get here. Maybe I should assert this
6901                And if we do get here I suspect that sv_setnv will croak. NWC
6902                Fall through. */
6903 #if defined(USE_LONG_DOUBLE)
6904             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",
6905                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6906 #else
6907             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6908                                   SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6909 #endif
6910         }
6911     }
6912 #endif /* PERL_PRESERVE_IVUV */
6913     sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
6914 }
6915
6916 /*
6917 =for apidoc sv_mortalcopy
6918
6919 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6920 The new SV is marked as mortal. It will be destroyed "soon", either by an
6921 explicit call to FREETMPS, or by an implicit call at places such as
6922 statement boundaries.  See also C<sv_newmortal> and C<sv_2mortal>.
6923
6924 =cut
6925 */
6926
6927 /* Make a string that will exist for the duration of the expression
6928  * evaluation.  Actually, it may have to last longer than that, but
6929  * hopefully we won't free it until it has been assigned to a
6930  * permanent location. */
6931
6932 SV *
6933 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6934 {
6935     register SV *sv;
6936
6937     new_SV(sv);
6938     sv_setsv(sv,oldstr);
6939     EXTEND_MORTAL(1);
6940     PL_tmps_stack[++PL_tmps_ix] = sv;
6941     SvTEMP_on(sv);
6942     return sv;
6943 }
6944
6945 /*
6946 =for apidoc sv_newmortal
6947
6948 Creates a new null SV which is mortal.  The reference count of the SV is
6949 set to 1. It will be destroyed "soon", either by an explicit call to
6950 FREETMPS, or by an implicit call at places such as statement boundaries.
6951 See also C<sv_mortalcopy> and C<sv_2mortal>.
6952
6953 =cut
6954 */
6955
6956 SV *
6957 Perl_sv_newmortal(pTHX)
6958 {
6959     register SV *sv;
6960
6961     new_SV(sv);
6962     SvFLAGS(sv) = SVs_TEMP;
6963     EXTEND_MORTAL(1);
6964     PL_tmps_stack[++PL_tmps_ix] = sv;
6965     return sv;
6966 }
6967
6968 /*
6969 =for apidoc sv_2mortal
6970
6971 Marks an existing SV as mortal.  The SV will be destroyed "soon", either
6972 by an explicit call to FREETMPS, or by an implicit call at places such as
6973 statement boundaries.  See also C<sv_newmortal> and C<sv_mortalcopy>.
6974
6975 =cut
6976 */
6977
6978 SV *
6979 Perl_sv_2mortal(pTHX_ register SV *sv)
6980 {
6981     if (!sv)
6982         return sv;
6983     if (SvREADONLY(sv) && SvIMMORTAL(sv))
6984         return sv;
6985     EXTEND_MORTAL(1);
6986     PL_tmps_stack[++PL_tmps_ix] = sv;
6987     SvTEMP_on(sv);
6988     return sv;
6989 }
6990
6991 /*
6992 =for apidoc newSVpv
6993
6994 Creates a new SV and copies a string into it.  The reference count for the
6995 SV is set to 1.  If C<len> is zero, Perl will compute the length using
6996 strlen().  For efficiency, consider using C<newSVpvn> instead.
6997
6998 =cut
6999 */
7000
7001 SV *
7002 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7003 {
7004     register SV *sv;
7005
7006     new_SV(sv);
7007     if (!len)
7008         len = strlen(s);
7009     sv_setpvn(sv,s,len);
7010     return sv;
7011 }
7012
7013 /*
7014 =for apidoc newSVpvn
7015
7016 Creates a new SV and copies a string into it.  The reference count for the
7017 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
7018 string.  You are responsible for ensuring that the source string is at least
7019 C<len> bytes long.
7020
7021 =cut
7022 */
7023
7024 SV *
7025 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7026 {
7027     register SV *sv;
7028
7029     new_SV(sv);
7030     sv_setpvn(sv,s,len);
7031     return sv;
7032 }
7033
7034 /*
7035 =for apidoc newSVpvn_share
7036
7037 Creates a new SV with its SvPVX pointing to a shared string in the string
7038 table. If the string does not already exist in the table, it is created
7039 first.  Turns on READONLY and FAKE.  The string's hash is stored in the UV
7040 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7041 otherwise the hash is computed.  The idea here is that as the string table
7042 is used for shared hash keys these strings will have SvPVX == HeKEY and
7043 hash lookup will avoid string compare.
7044
7045 =cut
7046 */
7047
7048 SV *
7049 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7050 {
7051     register SV *sv;
7052     bool is_utf8 = FALSE;
7053     if (len < 0) {
7054         STRLEN tmplen = -len;
7055         is_utf8 = TRUE;
7056         /* See the note in hv.c:hv_fetch() --jhi */
7057         src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
7058         len = tmplen;
7059     }
7060     if (!hash)
7061         PERL_HASH(hash, src, len);
7062     new_SV(sv);
7063     sv_upgrade(sv, SVt_PVIV);
7064     SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
7065     SvCUR(sv) = len;
7066     SvUVX(sv) = hash;
7067     SvLEN(sv) = 0;
7068     SvREADONLY_on(sv);
7069     SvFAKE_on(sv);
7070     SvPOK_on(sv);
7071     if (is_utf8)
7072         SvUTF8_on(sv);
7073     return sv;
7074 }
7075
7076
7077 #if defined(PERL_IMPLICIT_CONTEXT)
7078
7079 /* pTHX_ magic can't cope with varargs, so this is a no-context
7080  * version of the main function, (which may itself be aliased to us).
7081  * Don't access this version directly.
7082  */
7083
7084 SV *
7085 Perl_newSVpvf_nocontext(const char* pat, ...)
7086 {
7087     dTHX;
7088     register SV *sv;
7089     va_list args;
7090     va_start(args, pat);
7091     sv = vnewSVpvf(pat, &args);
7092     va_end(args);
7093     return sv;
7094 }
7095 #endif
7096
7097 /*
7098 =for apidoc newSVpvf
7099
7100 Creates a new SV and initializes it with the string formatted like
7101 C<sprintf>.
7102
7103 =cut
7104 */
7105
7106 SV *
7107 Perl_newSVpvf(pTHX_ const char* pat, ...)
7108 {
7109     register SV *sv;
7110     va_list args;
7111     va_start(args, pat);
7112     sv = vnewSVpvf(pat, &args);
7113     va_end(args);
7114     return sv;
7115 }
7116
7117 /* backend for newSVpvf() and newSVpvf_nocontext() */
7118
7119 SV *
7120 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7121 {
7122     register SV *sv;
7123     new_SV(sv);
7124     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7125     return sv;
7126 }
7127
7128 /*
7129 =for apidoc newSVnv
7130
7131 Creates a new SV and copies a floating point value into it.
7132 The reference count for the SV is set to 1.
7133
7134 =cut
7135 */
7136
7137 SV *
7138 Perl_newSVnv(pTHX_ NV n)
7139 {
7140     register SV *sv;
7141
7142     new_SV(sv);
7143     sv_setnv(sv,n);
7144     return sv;
7145 }
7146
7147 /*
7148 =for apidoc newSViv
7149
7150 Creates a new SV and copies an integer into it.  The reference count for the
7151 SV is set to 1.
7152
7153 =cut
7154 */
7155
7156 SV *
7157 Perl_newSViv(pTHX_ IV i)
7158 {
7159     register SV *sv;
7160
7161     new_SV(sv);
7162     sv_setiv(sv,i);
7163     return sv;
7164 }
7165
7166 /*
7167 =for apidoc newSVuv
7168
7169 Creates a new SV and copies an unsigned integer into it.
7170 The reference count for the SV is set to 1.
7171
7172 =cut
7173 */
7174
7175 SV *
7176 Perl_newSVuv(pTHX_ UV u)
7177 {
7178     register SV *sv;
7179
7180     new_SV(sv);
7181     sv_setuv(sv,u);
7182     return sv;
7183 }
7184
7185 /*
7186 =for apidoc newRV_noinc
7187
7188 Creates an RV wrapper for an SV.  The reference count for the original
7189 SV is B<not> incremented.
7190
7191 =cut
7192 */
7193
7194 SV *
7195 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7196 {
7197     register SV *sv;
7198
7199     new_SV(sv);
7200     sv_upgrade(sv, SVt_RV);
7201     SvTEMP_off(tmpRef);
7202     SvRV(sv) = tmpRef;
7203     SvROK_on(sv);
7204     return sv;
7205 }
7206
7207 /* newRV_inc is the official function name to use now.
7208  * newRV_inc is in fact #defined to newRV in sv.h
7209  */
7210
7211 SV *
7212 Perl_newRV(pTHX_ SV *tmpRef)
7213 {
7214     return newRV_noinc(SvREFCNT_inc(tmpRef));
7215 }
7216
7217 /*
7218 =for apidoc newSVsv
7219
7220 Creates a new SV which is an exact duplicate of the original SV.
7221 (Uses C<sv_setsv>).
7222
7223 =cut
7224 */
7225
7226 SV *
7227 Perl_newSVsv(pTHX_ register SV *old)
7228 {
7229     register SV *sv;
7230
7231     if (!old)
7232         return Nullsv;
7233     if (SvTYPE(old) == SVTYPEMASK) {
7234         if (ckWARN_d(WARN_INTERNAL))
7235             Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7236         return Nullsv;
7237     }
7238     new_SV(sv);
7239     if (SvTEMP(old)) {
7240         SvTEMP_off(old);
7241         sv_setsv(sv,old);
7242         SvTEMP_on(old);
7243     }
7244     else
7245         sv_setsv(sv,old);
7246     return sv;
7247 }
7248
7249 /*
7250 =for apidoc sv_reset
7251
7252 Underlying implementation for the C<reset> Perl function.
7253 Note that the perl-level function is vaguely deprecated.
7254
7255 =cut
7256 */
7257
7258 void
7259 Perl_sv_reset(pTHX_ register char *s, HV *stash)
7260 {
7261     register HE *entry;
7262     register GV *gv;
7263     register SV *sv;
7264     register I32 i;
7265     register PMOP *pm;
7266     register I32 max;
7267     char todo[PERL_UCHAR_MAX+1];
7268
7269     if (!stash)
7270         return;
7271
7272     if (!*s) {          /* reset ?? searches */
7273         for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7274             pm->op_pmdynflags &= ~PMdf_USED;
7275         }
7276         return;
7277     }
7278
7279     /* reset variables */
7280
7281     if (!HvARRAY(stash))
7282         return;
7283
7284     Zero(todo, 256, char);
7285     while (*s) {
7286         i = (unsigned char)*s;
7287         if (s[1] == '-') {
7288             s += 2;
7289         }
7290         max = (unsigned char)*s++;
7291         for ( ; i <= max; i++) {
7292             todo[i] = 1;
7293         }
7294         for (i = 0; i <= (I32) HvMAX(stash); i++) {
7295             for (entry = HvARRAY(stash)[i];
7296                  entry;
7297                  entry = HeNEXT(entry))
7298             {
7299                 if (!todo[(U8)*HeKEY(entry)])
7300                     continue;
7301                 gv = (GV*)HeVAL(entry);
7302                 sv = GvSV(gv);
7303                 if (SvTHINKFIRST(sv)) {
7304                     if (!SvREADONLY(sv) && SvROK(sv))
7305                         sv_unref(sv);
7306                     continue;
7307                 }
7308                 (void)SvOK_off(sv);
7309                 if (SvTYPE(sv) >= SVt_PV) {
7310                     SvCUR_set(sv, 0);
7311                     if (SvPVX(sv) != Nullch)
7312                         *SvPVX(sv) = '\0';
7313                     SvTAINT(sv);
7314                 }
7315                 if (GvAV(gv)) {
7316                     av_clear(GvAV(gv));
7317                 }
7318                 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7319                     hv_clear(GvHV(gv));
7320 #ifdef USE_ENVIRON_ARRAY
7321                     if (gv == PL_envgv
7322 #  ifdef USE_ITHREADS
7323                         && PL_curinterp == aTHX
7324 #  endif
7325                     )
7326                     {
7327                         environ[0] = Nullch;
7328                     }
7329 #endif
7330                 }
7331             }
7332         }
7333     }
7334 }
7335
7336 /*
7337 =for apidoc sv_2io
7338
7339 Using various gambits, try to get an IO from an SV: the IO slot if its a
7340 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7341 named after the PV if we're a string.
7342
7343 =cut
7344 */
7345
7346 IO*
7347 Perl_sv_2io(pTHX_ SV *sv)
7348 {
7349     IO* io;
7350     GV* gv;
7351     STRLEN n_a;
7352
7353     switch (SvTYPE(sv)) {
7354     case SVt_PVIO:
7355         io = (IO*)sv;
7356         break;
7357     case SVt_PVGV:
7358         gv = (GV*)sv;
7359         io = GvIO(gv);
7360         if (!io)
7361             Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7362         break;
7363     default:
7364         if (!SvOK(sv))
7365             Perl_croak(aTHX_ PL_no_usym, "filehandle");
7366         if (SvROK(sv))
7367             return sv_2io(SvRV(sv));
7368         gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
7369         if (gv)
7370             io = GvIO(gv);
7371         else
7372             io = 0;
7373         if (!io)
7374             Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7375         break;
7376     }
7377     return io;
7378 }
7379
7380 /*
7381 =for apidoc sv_2cv
7382
7383 Using various gambits, try to get a CV from an SV; in addition, try if
7384 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7385
7386 =cut
7387 */
7388
7389 CV *
7390 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7391 {
7392     GV *gv = Nullgv;
7393     CV *cv = Nullcv;
7394     STRLEN n_a;
7395
7396     if (!sv)
7397         return *gvp = Nullgv, Nullcv;
7398     switch (SvTYPE(sv)) {
7399     case SVt_PVCV:
7400         *st = CvSTASH(sv);
7401         *gvp = Nullgv;
7402         return (CV*)sv;
7403     case SVt_PVHV:
7404     case SVt_PVAV:
7405         *gvp = Nullgv;
7406         return Nullcv;
7407     case SVt_PVGV:
7408         gv = (GV*)sv;
7409         *gvp = gv;
7410         *st = GvESTASH(gv);
7411         goto fix_gv;
7412
7413     default:
7414         if (SvGMAGICAL(sv))
7415             mg_get(sv);
7416         if (SvROK(sv)) {
7417             SV **sp = &sv;              /* Used in tryAMAGICunDEREF macro. */
7418             tryAMAGICunDEREF(to_cv);
7419
7420             sv = SvRV(sv);
7421             if (SvTYPE(sv) == SVt_PVCV) {
7422                 cv = (CV*)sv;
7423                 *gvp = Nullgv;
7424                 *st = CvSTASH(cv);
7425                 return cv;
7426             }
7427             else if(isGV(sv))
7428                 gv = (GV*)sv;
7429             else
7430                 Perl_croak(aTHX_ "Not a subroutine reference");
7431         }
7432         else if (isGV(sv))
7433             gv = (GV*)sv;
7434         else
7435             gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
7436         *gvp = gv;
7437         if (!gv)
7438             return Nullcv;
7439         *st = GvESTASH(gv);
7440     fix_gv:
7441         if (lref && !GvCVu(gv)) {
7442             SV *tmpsv;
7443             ENTER;
7444             tmpsv = NEWSV(704,0);
7445             gv_efullname3(tmpsv, gv, Nullch);
7446             /* XXX this is probably not what they think they're getting.
7447              * It has the same effect as "sub name;", i.e. just a forward
7448              * declaration! */
7449             newSUB(start_subparse(FALSE, 0),
7450                    newSVOP(OP_CONST, 0, tmpsv),
7451                    Nullop,
7452                    Nullop);
7453             LEAVE;
7454             if (!GvCVu(gv))
7455                 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7456                            sv);
7457         }
7458         return GvCVu(gv);
7459     }
7460 }
7461
7462 /*
7463 =for apidoc sv_true
7464
7465 Returns true if the SV has a true value by Perl's rules.
7466 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7467 instead use an in-line version.
7468
7469 =cut
7470 */
7471
7472 I32
7473 Perl_sv_true(pTHX_ register SV *sv)
7474 {
7475     if (!sv)
7476         return 0;
7477     if (SvPOK(sv)) {
7478         register XPV* tXpv;
7479         if ((tXpv = (XPV*)SvANY(sv)) &&
7480                 (tXpv->xpv_cur > 1 ||
7481                 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
7482             return 1;
7483         else
7484             return 0;
7485     }
7486     else {
7487         if (SvIOK(sv))
7488             return SvIVX(sv) != 0;
7489         else {
7490             if (SvNOK(sv))
7491                 return SvNVX(sv) != 0.0;
7492             else
7493                 return sv_2bool(sv);
7494         }
7495     }
7496 }
7497
7498 /*
7499 =for apidoc sv_iv
7500
7501 A private implementation of the C<SvIVx> macro for compilers which can't
7502 cope with complex macro expressions. Always use the macro instead.
7503
7504 =cut
7505 */
7506
7507 IV
7508 Perl_sv_iv(pTHX_ register SV *sv)
7509 {
7510     if (SvIOK(sv)) {
7511         if (SvIsUV(sv))
7512             return (IV)SvUVX(sv);
7513         return SvIVX(sv);
7514     }
7515     return sv_2iv(sv);
7516 }
7517
7518 /*
7519 =for apidoc sv_uv
7520
7521 A private implementation of the C<SvUVx> macro for compilers which can't
7522 cope with complex macro expressions. Always use the macro instead.
7523
7524 =cut
7525 */
7526
7527 UV
7528 Perl_sv_uv(pTHX_ register SV *sv)
7529 {
7530     if (SvIOK(sv)) {
7531         if (SvIsUV(sv))
7532             return SvUVX(sv);
7533         return (UV)SvIVX(sv);
7534     }
7535     return sv_2uv(sv);
7536 }
7537
7538 /*
7539 =for apidoc sv_nv
7540
7541 A private implementation of the C<SvNVx> macro for compilers which can't
7542 cope with complex macro expressions. Always use the macro instead.
7543
7544 =cut
7545 */
7546
7547 NV
7548 Perl_sv_nv(pTHX_ register SV *sv)
7549 {
7550     if (SvNOK(sv))
7551         return SvNVX(sv);
7552     return sv_2nv(sv);
7553 }
7554
7555 /* sv_pv() is now a macro using SvPV_nolen();
7556  * this function provided for binary compatibility only
7557  */
7558
7559 char *
7560 Perl_sv_pv(pTHX_ SV *sv)
7561 {
7562     STRLEN n_a;
7563
7564     if (SvPOK(sv))
7565         return SvPVX(sv);
7566
7567     return sv_2pv(sv, &n_a);
7568 }
7569
7570 /*
7571 =for apidoc sv_pv
7572
7573 Use the C<SvPV_nolen> macro instead
7574
7575 =for apidoc sv_pvn
7576
7577 A private implementation of the C<SvPV> macro for compilers which can't
7578 cope with complex macro expressions. Always use the macro instead.
7579
7580 =cut
7581 */
7582
7583 char *
7584 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7585 {
7586     if (SvPOK(sv)) {
7587         *lp = SvCUR(sv);
7588         return SvPVX(sv);
7589     }
7590     return sv_2pv(sv, lp);
7591 }
7592
7593
7594 char *
7595 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7596 {
7597     if (SvPOK(sv)) {
7598         *lp = SvCUR(sv);
7599         return SvPVX(sv);
7600     }
7601     return sv_2pv_flags(sv, lp, 0);
7602 }
7603
7604 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7605  * this function provided for binary compatibility only
7606  */
7607
7608 char *
7609 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7610 {
7611     return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7612 }
7613
7614 /*
7615 =for apidoc sv_pvn_force
7616
7617 Get a sensible string out of the SV somehow.
7618 A private implementation of the C<SvPV_force> macro for compilers which
7619 can't cope with complex macro expressions. Always use the macro instead.
7620
7621 =for apidoc sv_pvn_force_flags
7622
7623 Get a sensible string out of the SV somehow.
7624 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7625 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7626 implemented in terms of this function.
7627 You normally want to use the various wrapper macros instead: see
7628 C<SvPV_force> and C<SvPV_force_nomg>
7629
7630 =cut
7631 */
7632
7633 char *
7634 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7635 {
7636     char *s = NULL;
7637
7638     if (SvTHINKFIRST(sv) && !SvROK(sv))
7639         sv_force_normal_flags(sv, 0);
7640
7641     if (SvPOK(sv)) {
7642         *lp = SvCUR(sv);
7643     }
7644     else {
7645         if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7646             Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7647                 OP_NAME(PL_op));
7648         }
7649         else
7650             s = sv_2pv_flags(sv, lp, flags);
7651         if (s != SvPVX(sv)) {   /* Almost, but not quite, sv_setpvn() */
7652             STRLEN len = *lp;
7653
7654             if (SvROK(sv))
7655                 sv_unref(sv);
7656             (void)SvUPGRADE(sv, SVt_PV);                /* Never FALSE */
7657             SvGROW(sv, len + 1);
7658             Move(s,SvPVX(sv),len,char);
7659             SvCUR_set(sv, len);
7660             *SvEND(sv) = '\0';
7661         }
7662         if (!SvPOK(sv)) {
7663             SvPOK_on(sv);               /* validate pointer */
7664             SvTAINT(sv);
7665             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7666                                   PTR2UV(sv),SvPVX(sv)));
7667         }
7668     }
7669     return SvPVX(sv);
7670 }
7671
7672 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7673  * this function provided for binary compatibility only
7674  */
7675
7676 char *
7677 Perl_sv_pvbyte(pTHX_ SV *sv)
7678 {
7679     sv_utf8_downgrade(sv,0);
7680     return sv_pv(sv);
7681 }
7682
7683 /*
7684 =for apidoc sv_pvbyte
7685
7686 Use C<SvPVbyte_nolen> instead.
7687
7688 =for apidoc sv_pvbyten
7689
7690 A private implementation of the C<SvPVbyte> macro for compilers
7691 which can't cope with complex macro expressions. Always use the macro
7692 instead.
7693
7694 =cut
7695 */
7696
7697 char *
7698 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7699 {
7700     sv_utf8_downgrade(sv,0);
7701     return sv_pvn(sv,lp);
7702 }
7703
7704 /*
7705 =for apidoc sv_pvbyten_force
7706
7707 A private implementation of the C<SvPVbytex_force> macro for compilers
7708 which can't cope with complex macro expressions. Always use the macro
7709 instead.
7710
7711 =cut
7712 */
7713
7714 char *
7715 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7716 {
7717     sv_utf8_downgrade(sv,0);
7718     return sv_pvn_force(sv,lp);
7719 }
7720
7721 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
7722  * this function provided for binary compatibility only
7723  */
7724
7725 char *
7726 Perl_sv_pvutf8(pTHX_ SV *sv)
7727 {
7728     sv_utf8_upgrade(sv);
7729     return sv_pv(sv);
7730 }
7731
7732 /*
7733 =for apidoc sv_pvutf8
7734
7735 Use the C<SvPVutf8_nolen> macro instead
7736
7737 =for apidoc sv_pvutf8n
7738
7739 A private implementation of the C<SvPVutf8> macro for compilers
7740 which can't cope with complex macro expressions. Always use the macro
7741 instead.
7742
7743 =cut
7744 */
7745
7746 char *
7747 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7748 {
7749     sv_utf8_upgrade(sv);
7750     return sv_pvn(sv,lp);
7751 }
7752
7753 /*
7754 =for apidoc sv_pvutf8n_force
7755
7756 A private implementation of the C<SvPVutf8_force> macro for compilers
7757 which can't cope with complex macro expressions. Always use the macro
7758 instead.
7759
7760 =cut
7761 */
7762
7763 char *
7764 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7765 {
7766     sv_utf8_upgrade(sv);
7767     return sv_pvn_force(sv,lp);
7768 }
7769
7770 /*
7771 =for apidoc sv_reftype
7772
7773 Returns a string describing what the SV is a reference to.
7774
7775 =cut
7776 */
7777
7778 char *
7779 Perl_sv_reftype(pTHX_ SV *sv, int ob)
7780 {
7781     if (ob && SvOBJECT(sv)) {
7782         if (HvNAME(SvSTASH(sv)))
7783             return HvNAME(SvSTASH(sv));
7784         else
7785             return "__ANON__";
7786     }
7787     else {
7788         switch (SvTYPE(sv)) {
7789         case SVt_NULL:
7790         case SVt_IV:
7791         case SVt_NV:
7792         case SVt_RV:
7793         case SVt_PV:
7794         case SVt_PVIV:
7795         case SVt_PVNV:
7796         case SVt_PVMG:
7797         case SVt_PVBM:
7798                                 if (SvVOK(sv))
7799                                     return "VSTRING";
7800                                 if (SvROK(sv))
7801                                     return "REF";
7802                                 else
7803                                     return "SCALAR";
7804         case SVt_PVLV:          return SvROK(sv) ? "REF" : "LVALUE";
7805         case SVt_PVAV:          return "ARRAY";
7806         case SVt_PVHV:          return "HASH";
7807         case SVt_PVCV:          return "CODE";
7808         case SVt_PVGV:          return "GLOB";
7809         case SVt_PVFM:          return "FORMAT";
7810         case SVt_PVIO:          return "IO";
7811         default:                return "UNKNOWN";
7812         }
7813     }
7814 }
7815
7816 /*
7817 =for apidoc sv_isobject
7818
7819 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7820 object.  If the SV is not an RV, or if the object is not blessed, then this
7821 will return false.
7822
7823 =cut
7824 */
7825
7826 int
7827 Perl_sv_isobject(pTHX_ SV *sv)
7828 {
7829     if (!sv)
7830         return 0;
7831     if (SvGMAGICAL(sv))
7832         mg_get(sv);
7833     if (!SvROK(sv))
7834         return 0;
7835     sv = (SV*)SvRV(sv);
7836     if (!SvOBJECT(sv))
7837         return 0;
7838     return 1;
7839 }
7840
7841 /*
7842 =for apidoc sv_isa
7843
7844 Returns a boolean indicating whether the SV is blessed into the specified
7845 class.  This does not check for subtypes; use C<sv_derived_from> to verify
7846 an inheritance relationship.
7847
7848 =cut
7849 */
7850
7851 int
7852 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7853 {
7854     if (!sv)
7855         return 0;
7856     if (SvGMAGICAL(sv))
7857         mg_get(sv);
7858     if (!SvROK(sv))
7859         return 0;
7860     sv = (SV*)SvRV(sv);
7861     if (!SvOBJECT(sv))
7862         return 0;
7863     if (!HvNAME(SvSTASH(sv)))
7864         return 0;
7865
7866     return strEQ(HvNAME(SvSTASH(sv)), name);
7867 }
7868
7869 /*
7870 =for apidoc newSVrv
7871
7872 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
7873 it will be upgraded to one.  If C<classname> is non-null then the new SV will
7874 be blessed in the specified package.  The new SV is returned and its
7875 reference count is 1.
7876
7877 =cut
7878 */
7879
7880 SV*
7881 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7882 {
7883     SV *sv;
7884
7885     new_SV(sv);
7886
7887     SV_CHECK_THINKFIRST_COW_DROP(rv);
7888     SvAMAGIC_off(rv);
7889
7890     if (SvTYPE(rv) >= SVt_PVMG) {
7891         U32 refcnt = SvREFCNT(rv);
7892         SvREFCNT(rv) = 0;
7893         sv_clear(rv);
7894         SvFLAGS(rv) = 0;
7895         SvREFCNT(rv) = refcnt;
7896     }
7897
7898     if (SvTYPE(rv) < SVt_RV)
7899         sv_upgrade(rv, SVt_RV);
7900     else if (SvTYPE(rv) > SVt_RV) {
7901         (void)SvOOK_off(rv);
7902         if (SvPVX(rv) && SvLEN(rv))
7903             Safefree(SvPVX(rv));
7904         SvCUR_set(rv, 0);
7905         SvLEN_set(rv, 0);
7906     }
7907
7908     (void)SvOK_off(rv);
7909     SvRV(rv) = sv;
7910     SvROK_on(rv);
7911
7912     if (classname) {
7913         HV* stash = gv_stashpv(classname, TRUE);
7914         (void)sv_bless(rv, stash);
7915     }
7916     return sv;
7917 }
7918
7919 /*
7920 =for apidoc sv_setref_pv
7921
7922 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
7923 argument will be upgraded to an RV.  That RV will be modified to point to
7924 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7925 into the SV.  The C<classname> argument indicates the package for the
7926 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7927 will be returned and will have a reference count of 1.
7928
7929 Do not use with other Perl types such as HV, AV, SV, CV, because those
7930 objects will become corrupted by the pointer copy process.
7931
7932 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7933
7934 =cut
7935 */
7936
7937 SV*
7938 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7939 {
7940     if (!pv) {
7941         sv_setsv(rv, &PL_sv_undef);
7942         SvSETMAGIC(rv);
7943     }
7944     else
7945         sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7946     return rv;
7947 }
7948
7949 /*
7950 =for apidoc sv_setref_iv
7951
7952 Copies an 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_iv(pTHX_ SV *rv, const char *classname, IV iv)
7963 {
7964     sv_setiv(newSVrv(rv,classname), iv);
7965     return rv;
7966 }
7967
7968 /*
7969 =for apidoc sv_setref_uv
7970
7971 Copies an unsigned integer 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_uv(pTHX_ SV *rv, const char *classname, UV uv)
7982 {
7983     sv_setuv(newSVrv(rv,classname), uv);
7984     return rv;
7985 }
7986
7987 /*
7988 =for apidoc sv_setref_nv
7989
7990 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
7991 argument will be upgraded to an RV.  That RV will be modified to point to
7992 the new SV.  The C<classname> argument indicates the package for the
7993 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
7994 will be returned and will have a reference count of 1.
7995
7996 =cut
7997 */
7998
7999 SV*
8000 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8001 {
8002     sv_setnv(newSVrv(rv,classname), nv);
8003     return rv;
8004 }
8005
8006 /*
8007 =for apidoc sv_setref_pvn
8008
8009 Copies a string into a new SV, optionally blessing the SV.  The length of the
8010 string must be specified with C<n>.  The C<rv> argument will be upgraded to
8011 an RV.  That RV will be modified to point to the new SV.  The C<classname>
8012 argument indicates the package for the blessing.  Set C<classname> to
8013 C<Nullch> to avoid the blessing.  The new SV will be returned and will have
8014 a reference count of 1.
8015
8016 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8017
8018 =cut
8019 */
8020
8021 SV*
8022 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8023 {
8024     sv_setpvn(newSVrv(rv,classname), pv, n);
8025     return rv;
8026 }
8027
8028 /*
8029 =for apidoc sv_bless
8030
8031 Blesses an SV into a specified package.  The SV must be an RV.  The package
8032 must be designated by its stash (see C<gv_stashpv()>).  The reference count
8033 of the SV is unaffected.
8034
8035 =cut
8036 */
8037
8038 SV*
8039 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8040 {
8041     SV *tmpRef;
8042     if (!SvROK(sv))
8043         Perl_croak(aTHX_ "Can't bless non-reference value");
8044     tmpRef = SvRV(sv);
8045     if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8046         if (SvREADONLY(tmpRef))
8047             Perl_croak(aTHX_ PL_no_modify);
8048         if (SvOBJECT(tmpRef)) {
8049             if (SvTYPE(tmpRef) != SVt_PVIO)
8050                 --PL_sv_objcount;
8051             SvREFCNT_dec(SvSTASH(tmpRef));
8052         }
8053     }
8054     SvOBJECT_on(tmpRef);
8055     if (SvTYPE(tmpRef) != SVt_PVIO)
8056         ++PL_sv_objcount;
8057     (void)SvUPGRADE(tmpRef, SVt_PVMG);
8058     SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
8059
8060     if (Gv_AMG(stash))
8061         SvAMAGIC_on(sv);
8062     else
8063         SvAMAGIC_off(sv);
8064
8065     if(SvSMAGICAL(tmpRef))
8066         if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8067             mg_set(tmpRef);
8068
8069
8070
8071     return sv;
8072 }
8073
8074 /* Downgrades a PVGV to a PVMG.
8075  */
8076
8077 STATIC void
8078 S_sv_unglob(pTHX_ SV *sv)
8079 {
8080     void *xpvmg;
8081
8082     assert(SvTYPE(sv) == SVt_PVGV);
8083     SvFAKE_off(sv);
8084     if (GvGP(sv))
8085         gp_free((GV*)sv);
8086     if (GvSTASH(sv)) {
8087         SvREFCNT_dec(GvSTASH(sv));
8088         GvSTASH(sv) = Nullhv;
8089     }
8090     sv_unmagic(sv, PERL_MAGIC_glob);
8091     Safefree(GvNAME(sv));
8092     GvMULTI_off(sv);
8093
8094     /* need to keep SvANY(sv) in the right arena */
8095     xpvmg = new_XPVMG();
8096     StructCopy(SvANY(sv), xpvmg, XPVMG);
8097     del_XPVGV(SvANY(sv));
8098     SvANY(sv) = xpvmg;
8099
8100     SvFLAGS(sv) &= ~SVTYPEMASK;
8101     SvFLAGS(sv) |= SVt_PVMG;
8102 }
8103
8104 /*
8105 =for apidoc sv_unref_flags
8106
8107 Unsets the RV status of the SV, and decrements the reference count of
8108 whatever was being referenced by the RV.  This can almost be thought of
8109 as a reversal of C<newSVrv>.  The C<cflags> argument can contain
8110 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8111 (otherwise the decrementing is conditional on the reference count being
8112 different from one or the reference being a readonly SV).
8113 See C<SvROK_off>.
8114
8115 =cut
8116 */
8117
8118 void
8119 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8120 {
8121     SV* rv = SvRV(sv);
8122
8123     if (SvWEAKREF(sv)) {
8124         sv_del_backref(sv);
8125         SvWEAKREF_off(sv);
8126         SvRV(sv) = 0;
8127         return;
8128     }
8129     SvRV(sv) = 0;
8130     SvROK_off(sv);
8131     /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8132        assigned to as BEGIN {$a = \"Foo"} will fail.  */
8133     if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8134         SvREFCNT_dec(rv);
8135     else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8136         sv_2mortal(rv);         /* Schedule for freeing later */
8137 }
8138
8139 /*
8140 =for apidoc sv_unref
8141
8142 Unsets the RV status of the SV, and decrements the reference count of
8143 whatever was being referenced by the RV.  This can almost be thought of
8144 as a reversal of C<newSVrv>.  This is C<sv_unref_flags> with the C<flag>
8145 being zero.  See C<SvROK_off>.
8146
8147 =cut
8148 */
8149
8150 void
8151 Perl_sv_unref(pTHX_ SV *sv)
8152 {
8153     sv_unref_flags(sv, 0);
8154 }
8155
8156 /*
8157 =for apidoc sv_taint
8158
8159 Taint an SV. Use C<SvTAINTED_on> instead.
8160 =cut
8161 */
8162
8163 void
8164 Perl_sv_taint(pTHX_ SV *sv)
8165 {
8166     sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8167 }
8168
8169 /*
8170 =for apidoc sv_untaint
8171
8172 Untaint an SV. Use C<SvTAINTED_off> instead.
8173 =cut
8174 */
8175
8176 void
8177 Perl_sv_untaint(pTHX_ SV *sv)
8178 {
8179     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8180         MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8181         if (mg)
8182             mg->mg_len &= ~1;
8183     }
8184 }
8185
8186 /*
8187 =for apidoc sv_tainted
8188
8189 Test an SV for taintedness. Use C<SvTAINTED> instead.
8190 =cut
8191 */
8192
8193 bool
8194 Perl_sv_tainted(pTHX_ SV *sv)
8195 {
8196     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8197         MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8198         if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8199             return TRUE;
8200     }
8201     return FALSE;
8202 }
8203
8204 /*
8205 =for apidoc sv_setpviv
8206
8207 Copies an integer into the given SV, also updating its string value.
8208 Does not handle 'set' magic.  See C<sv_setpviv_mg>.
8209
8210 =cut
8211 */
8212
8213 void
8214 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8215 {
8216     char buf[TYPE_CHARS(UV)];
8217     char *ebuf;
8218     char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8219
8220     sv_setpvn(sv, ptr, ebuf - ptr);
8221 }
8222
8223 /*
8224 =for apidoc sv_setpviv_mg
8225
8226 Like C<sv_setpviv>, but also handles 'set' magic.
8227
8228 =cut
8229 */
8230
8231 void
8232 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8233 {
8234     char buf[TYPE_CHARS(UV)];
8235     char *ebuf;
8236     char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8237
8238     sv_setpvn(sv, ptr, ebuf - ptr);
8239     SvSETMAGIC(sv);
8240 }
8241
8242 #if defined(PERL_IMPLICIT_CONTEXT)
8243
8244 /* pTHX_ magic can't cope with varargs, so this is a no-context
8245  * version of the main function, (which may itself be aliased to us).
8246  * Don't access this version directly.
8247  */
8248
8249 void
8250 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8251 {
8252     dTHX;
8253     va_list args;
8254     va_start(args, pat);
8255     sv_vsetpvf(sv, pat, &args);
8256     va_end(args);
8257 }
8258
8259 /* pTHX_ magic can't cope with varargs, so this is a no-context
8260  * version of the main function, (which may itself be aliased to us).
8261  * Don't access this version directly.
8262  */
8263
8264 void
8265 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8266 {
8267     dTHX;
8268     va_list args;
8269     va_start(args, pat);
8270     sv_vsetpvf_mg(sv, pat, &args);
8271     va_end(args);
8272 }
8273 #endif
8274
8275 /*
8276 =for apidoc sv_setpvf
8277
8278 Processes its arguments like C<sprintf> and sets an SV to the formatted
8279 output.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
8280
8281 =cut
8282 */
8283
8284 void
8285 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8286 {
8287     va_list args;
8288     va_start(args, pat);
8289     sv_vsetpvf(sv, pat, &args);
8290     va_end(args);
8291 }
8292
8293 /* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8294
8295 void
8296 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8297 {
8298     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8299 }
8300
8301 /*
8302 =for apidoc sv_setpvf_mg
8303
8304 Like C<sv_setpvf>, but also handles 'set' magic.
8305
8306 =cut
8307 */
8308
8309 void
8310 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8311 {
8312     va_list args;
8313     va_start(args, pat);
8314     sv_vsetpvf_mg(sv, pat, &args);
8315     va_end(args);
8316 }
8317
8318 /* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8319
8320 void
8321 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8322 {
8323     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8324     SvSETMAGIC(sv);
8325 }
8326
8327 #if defined(PERL_IMPLICIT_CONTEXT)
8328
8329 /* pTHX_ magic can't cope with varargs, so this is a no-context
8330  * version of the main function, (which may itself be aliased to us).
8331  * Don't access this version directly.
8332  */
8333
8334 void
8335 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8336 {
8337     dTHX;
8338     va_list args;
8339     va_start(args, pat);
8340     sv_vcatpvf(sv, pat, &args);
8341     va_end(args);
8342 }
8343
8344 /* pTHX_ magic can't cope with varargs, so this is a no-context
8345  * version of the main function, (which may itself be aliased to us).
8346  * Don't access this version directly.
8347  */
8348
8349 void
8350 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8351 {
8352     dTHX;
8353     va_list args;
8354     va_start(args, pat);
8355     sv_vcatpvf_mg(sv, pat, &args);
8356     va_end(args);
8357 }
8358 #endif
8359
8360 /*
8361 =for apidoc sv_catpvf
8362
8363 Processes its arguments like C<sprintf> and appends the formatted
8364 output to an SV.  If the appended data contains "wide" characters
8365 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8366 and characters >255 formatted with %c), the original SV might get
8367 upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.
8368 C<SvSETMAGIC()> must typically be called after calling this function
8369 to handle 'set' magic.
8370
8371 =cut */
8372
8373 void
8374 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8375 {
8376     va_list args;
8377     va_start(args, pat);
8378     sv_vcatpvf(sv, pat, &args);
8379     va_end(args);
8380 }
8381
8382 /* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8383
8384 void
8385 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8386 {
8387     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8388 }
8389
8390 /*
8391 =for apidoc sv_catpvf_mg
8392
8393 Like C<sv_catpvf>, but also handles 'set' magic.
8394
8395 =cut
8396 */
8397
8398 void
8399 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8400 {
8401     va_list args;
8402     va_start(args, pat);
8403     sv_vcatpvf_mg(sv, pat, &args);
8404     va_end(args);
8405 }
8406
8407 /* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
8408
8409 void
8410 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8411 {
8412     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8413     SvSETMAGIC(sv);
8414 }
8415
8416 /*
8417 =for apidoc sv_vsetpvfn
8418
8419 Works like C<vcatpvfn> but copies the text into the SV instead of
8420 appending it.
8421
8422 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
8423
8424 =cut
8425 */
8426
8427 void
8428 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8429 {
8430     sv_setpvn(sv, "", 0);
8431     sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8432 }
8433
8434 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8435
8436 STATIC I32
8437 S_expect_number(pTHX_ char** pattern)
8438 {
8439     I32 var = 0;
8440     switch (**pattern) {
8441     case '1': case '2': case '3':
8442     case '4': case '5': case '6':
8443     case '7': case '8': case '9':
8444         while (isDIGIT(**pattern))
8445             var = var * 10 + (*(*pattern)++ - '0');
8446     }
8447     return var;
8448 }
8449 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8450
8451 /*
8452 =for apidoc sv_vcatpvfn
8453
8454 Processes its arguments like C<vsprintf> and appends the formatted output
8455 to an SV.  Uses an array of SVs if the C style variable argument list is
8456 missing (NULL).  When running with taint checks enabled, indicates via
8457 C<maybe_tainted> if results are untrustworthy (often due to the use of
8458 locales).
8459
8460 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
8461
8462 =cut
8463 */
8464
8465 void
8466 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8467 {
8468     char *p;
8469     char *q;
8470     char *patend;
8471     STRLEN origlen;
8472     I32 svix = 0;
8473     static char nullstr[] = "(null)";
8474     SV *argsv = Nullsv;
8475     bool has_utf8; /* has the result utf8? */
8476     bool pat_utf8; /* the pattern is in utf8? */
8477     SV *nsv = Nullsv;
8478
8479     has_utf8 = pat_utf8 = DO_UTF8(sv);
8480
8481     /* no matter what, this is a string now */
8482     (void)SvPV_force(sv, origlen);
8483
8484     /* special-case "", "%s", and "%_" */
8485     if (patlen == 0)
8486         return;
8487     if (patlen == 2 && pat[0] == '%') {
8488         switch (pat[1]) {
8489         case 's':
8490             if (args) {
8491                 char *s = va_arg(*args, char*);
8492                 sv_catpv(sv, s ? s : nullstr);
8493             }
8494             else if (svix < svmax) {
8495                 sv_catsv(sv, *svargs);
8496                 if (DO_UTF8(*svargs))
8497                     SvUTF8_on(sv);
8498             }
8499             return;
8500         case '_':
8501             if (args) {
8502                 argsv = va_arg(*args, SV*);
8503                 sv_catsv(sv, argsv);
8504                 if (DO_UTF8(argsv))
8505                     SvUTF8_on(sv);
8506                 return;
8507             }
8508             /* See comment on '_' below */
8509             break;
8510         }
8511     }
8512
8513     if (!args && svix < svmax && DO_UTF8(*svargs))
8514         has_utf8 = TRUE;
8515
8516     patend = (char*)pat + patlen;
8517     for (p = (char*)pat; p < patend; p = q) {
8518         bool alt = FALSE;
8519         bool left = FALSE;
8520         bool vectorize = FALSE;
8521         bool vectorarg = FALSE;
8522         bool vec_utf8 = FALSE;
8523         char fill = ' ';
8524         char plus = 0;
8525         char intsize = 0;
8526         STRLEN width = 0;
8527         STRLEN zeros = 0;
8528         bool has_precis = FALSE;
8529         STRLEN precis = 0;
8530         I32 osvix = svix;
8531         bool is_utf8 = FALSE;  /* is this item utf8?   */
8532 #ifdef HAS_LDBL_SPRINTF_BUG
8533         /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8534            with sfio - Allen <allens@cpan.org> */
8535         bool fix_ldbl_sprintf_bug = FALSE;
8536 #endif
8537
8538         char esignbuf[4];
8539         U8 utf8buf[UTF8_MAXLEN+1];
8540         STRLEN esignlen = 0;
8541
8542         char *eptr = Nullch;
8543         STRLEN elen = 0;
8544         /* Times 4: a decimal digit takes more than 3 binary digits.
8545          * NV_DIG: mantissa takes than many decimal digits.
8546          * Plus 32: Playing safe. */
8547         char ebuf[IV_DIG * 4 + NV_DIG + 32];
8548         /* large enough for "%#.#f" --chip */
8549         /* what about long double NVs? --jhi */
8550
8551         SV *vecsv = Nullsv;
8552         U8 *vecstr = Null(U8*);
8553         STRLEN veclen = 0;
8554         char c = 0;
8555         int i;
8556         unsigned base = 0;
8557         IV iv = 0;
8558         UV uv = 0;
8559         /* we need a long double target in case HAS_LONG_DOUBLE but
8560            not USE_LONG_DOUBLE
8561         */
8562 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8563         long double nv;
8564 #else
8565         NV nv;
8566 #endif
8567         STRLEN have;
8568         STRLEN need;
8569         STRLEN gap;
8570         char *dotstr = ".";
8571         STRLEN dotstrlen = 1;
8572         I32 efix = 0; /* explicit format parameter index */
8573         I32 ewix = 0; /* explicit width index */
8574         I32 epix = 0; /* explicit precision index */
8575         I32 evix = 0; /* explicit vector index */
8576         bool asterisk = FALSE;
8577
8578         /* echo everything up to the next format specification */
8579         for (q = p; q < patend && *q != '%'; ++q) ;
8580         if (q > p) {
8581             if (has_utf8 && !pat_utf8)
8582                 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8583             else
8584                 sv_catpvn(sv, p, q - p);
8585             p = q;
8586         }
8587         if (q++ >= patend)
8588             break;
8589
8590 /*
8591     We allow format specification elements in this order:
8592         \d+\$              explicit format parameter index
8593         [-+ 0#]+           flags
8594         v|\*(\d+\$)?v      vector with optional (optionally specified) arg
8595         0                  flag (as above): repeated to allow "v02"
8596         \d+|\*(\d+\$)?     width using optional (optionally specified) arg
8597         \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8598         [hlqLV]            size
8599     [%bcdefginopsux_DFOUX] format (mandatory)
8600 */
8601         if (EXPECT_NUMBER(q, width)) {
8602             if (*q == '$') {
8603                 ++q;
8604                 efix = width;
8605             } else {
8606                 goto gotwidth;
8607             }
8608         }
8609
8610         /* FLAGS */
8611
8612         while (*q) {
8613             switch (*q) {
8614             case ' ':
8615             case '+':
8616                 plus = *q++;
8617                 continue;
8618
8619             case '-':
8620                 left = TRUE;
8621                 q++;
8622                 continue;
8623
8624             case '0':
8625                 fill = *q++;
8626                 continue;
8627
8628             case '#':
8629                 alt = TRUE;
8630                 q++;
8631                 continue;
8632
8633             default:
8634                 break;
8635             }
8636             break;
8637         }
8638
8639       tryasterisk:
8640         if (*q == '*') {
8641             q++;
8642             if (EXPECT_NUMBER(q, ewix))
8643                 if (*q++ != '$')
8644                     goto unknown;
8645             asterisk = TRUE;
8646         }
8647         if (*q == 'v') {
8648             q++;
8649             if (vectorize)
8650                 goto unknown;
8651             if ((vectorarg = asterisk)) {
8652                 evix = ewix;
8653                 ewix = 0;
8654                 asterisk = FALSE;
8655             }
8656             vectorize = TRUE;
8657             goto tryasterisk;
8658         }
8659
8660         if (!asterisk)
8661             if( *q == '0' )
8662                 fill = *q++;
8663             EXPECT_NUMBER(q, width);
8664
8665         if (vectorize) {
8666             if (vectorarg) {
8667                 if (args)
8668                     vecsv = va_arg(*args, SV*);
8669                 else
8670                     vecsv = (evix ? evix <= svmax : svix < svmax) ?
8671                         svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
8672                 dotstr = SvPVx(vecsv, dotstrlen);
8673                 if (DO_UTF8(vecsv))
8674                     is_utf8 = TRUE;
8675             }
8676             if (args) {
8677                 vecsv = va_arg(*args, SV*);
8678                 vecstr = (U8*)SvPVx(vecsv,veclen);
8679                 vec_utf8 = DO_UTF8(vecsv);
8680             }
8681             else if (efix ? efix <= svmax : svix < svmax) {
8682                 vecsv = svargs[efix ? efix-1 : svix++];
8683                 vecstr = (U8*)SvPVx(vecsv,veclen);
8684                 vec_utf8 = DO_UTF8(vecsv);
8685             }
8686             else {
8687                 vecstr = (U8*)"";
8688                 veclen = 0;
8689             }
8690         }
8691
8692         if (asterisk) {
8693             if (args)
8694                 i = va_arg(*args, int);
8695             else
8696                 i = (ewix ? ewix <= svmax : svix < svmax) ?
8697                     SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8698             left |= (i < 0);
8699             width = (i < 0) ? -i : i;
8700         }
8701       gotwidth:
8702
8703         /* PRECISION */
8704
8705         if (*q == '.') {
8706             q++;
8707             if (*q == '*') {
8708                 q++;
8709                 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8710                     goto unknown;
8711                 /* XXX: todo, support specified precision parameter */
8712                 if (epix)
8713                     goto unknown;
8714                 if (args)
8715                     i = va_arg(*args, int);
8716                 else
8717                     i = (ewix ? ewix <= svmax : svix < svmax)
8718                         ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8719                 precis = (i < 0) ? 0 : i;
8720             }
8721             else {
8722                 precis = 0;
8723                 while (isDIGIT(*q))
8724                     precis = precis * 10 + (*q++ - '0');
8725             }
8726             has_precis = TRUE;
8727         }
8728
8729         /* SIZE */
8730
8731         switch (*q) {
8732 #ifdef WIN32
8733         case 'I':                       /* Ix, I32x, and I64x */
8734 #  ifdef WIN64
8735             if (q[1] == '6' && q[2] == '4') {
8736                 q += 3;
8737                 intsize = 'q';
8738                 break;
8739             }
8740 #  endif
8741             if (q[1] == '3' && q[2] == '2') {
8742                 q += 3;
8743                 break;
8744             }
8745 #  ifdef WIN64
8746             intsize = 'q';
8747 #  endif
8748             q++;
8749             break;
8750 #endif
8751 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8752         case 'L':                       /* Ld */
8753             /* FALL THROUGH */
8754 #ifdef HAS_QUAD
8755         case 'q':                       /* qd */
8756 #endif
8757             intsize = 'q';
8758             q++;
8759             break;
8760 #endif
8761         case 'l':
8762 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8763             if (*(q + 1) == 'l') {      /* lld, llf */
8764                 intsize = 'q';
8765                 q += 2;
8766                 break;
8767              }
8768 #endif
8769             /* FALL THROUGH */
8770         case 'h':
8771             /* FALL THROUGH */
8772         case 'V':
8773             intsize = *q++;
8774             break;
8775         }
8776
8777         /* CONVERSION */
8778
8779         if (*q == '%') {
8780             eptr = q++;
8781             elen = 1;
8782             goto string;
8783         }
8784
8785         if (vectorize)
8786             argsv = vecsv;
8787         else if (!args)
8788             argsv = (efix ? efix <= svmax : svix < svmax) ?
8789                     svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8790
8791         switch (c = *q++) {
8792
8793             /* STRINGS */
8794
8795         case 'c':
8796             uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8797             if ((uv > 255 ||
8798                  (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8799                 && !IN_BYTES) {
8800                 eptr = (char*)utf8buf;
8801                 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8802                 is_utf8 = TRUE;
8803             }
8804             else {
8805                 c = (char)uv;
8806                 eptr = &c;
8807                 elen = 1;
8808             }
8809             goto string;
8810
8811         case 's':
8812             if (args && !vectorize) {
8813                 eptr = va_arg(*args, char*);
8814                 if (eptr)
8815 #ifdef MACOS_TRADITIONAL
8816                   /* On MacOS, %#s format is used for Pascal strings */
8817                   if (alt)
8818                     elen = *eptr++;
8819                   else
8820 #endif
8821                     elen = strlen(eptr);
8822                 else {
8823                     eptr = nullstr;
8824                     elen = sizeof nullstr - 1;
8825                 }
8826             }
8827             else {
8828                 eptr = SvPVx(argsv, elen);
8829                 if (DO_UTF8(argsv)) {
8830                     if (has_precis && precis < elen) {
8831                         I32 p = precis;
8832                         sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8833                         precis = p;
8834                     }
8835                     if (width) { /* fudge width (can't fudge elen) */
8836                         width += elen - sv_len_utf8(argsv);
8837                     }
8838                     is_utf8 = TRUE;
8839                 }
8840             }
8841             goto string;
8842
8843         case '_':
8844             /*
8845              * The "%_" hack might have to be changed someday,
8846              * if ISO or ANSI decide to use '_' for something.
8847              * So we keep it hidden from users' code.
8848              */
8849             if (!args || vectorize)
8850                 goto unknown;
8851             argsv = va_arg(*args, SV*);
8852             eptr = SvPVx(argsv, elen);
8853             if (DO_UTF8(argsv))
8854                 is_utf8 = TRUE;
8855
8856         string:
8857             vectorize = FALSE;
8858             if (has_precis && elen > precis)
8859                 elen = precis;
8860             break;
8861
8862             /* INTEGERS */
8863
8864         case 'p':
8865             if (alt || vectorize)
8866                 goto unknown;
8867             uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8868             base = 16;
8869             goto integer;
8870
8871         case 'D':
8872 #ifdef IV_IS_QUAD
8873             intsize = 'q';
8874 #else
8875             intsize = 'l';
8876 #endif
8877             /* FALL THROUGH */
8878         case 'd':
8879         case 'i':
8880             if (vectorize) {
8881                 STRLEN ulen;
8882                 if (!veclen)
8883                     continue;
8884                 if (vec_utf8)
8885                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8886                                         UTF8_ALLOW_ANYUV);
8887                 else {
8888                     uv = *vecstr;
8889                     ulen = 1;
8890                 }
8891                 vecstr += ulen;
8892                 veclen -= ulen;
8893                 if (plus)
8894                      esignbuf[esignlen++] = plus;
8895             }
8896             else if (args) {
8897                 switch (intsize) {
8898                 case 'h':       iv = (short)va_arg(*args, int); break;
8899                 default:        iv = va_arg(*args, int); break;
8900                 case 'l':       iv = va_arg(*args, long); break;
8901                 case 'V':       iv = va_arg(*args, IV); break;
8902 #ifdef HAS_QUAD
8903                 case 'q':       iv = va_arg(*args, Quad_t); break;
8904 #endif
8905                 }
8906             }
8907             else {
8908                 iv = SvIVx(argsv);
8909                 switch (intsize) {
8910                 case 'h':       iv = (short)iv; break;
8911                 default:        break;
8912                 case 'l':       iv = (long)iv; break;
8913                 case 'V':       break;
8914 #ifdef HAS_QUAD
8915                 case 'q':       iv = (Quad_t)iv; break;
8916 #endif
8917                 }
8918             }
8919             if ( !vectorize )   /* we already set uv above */
8920             {
8921                 if (iv >= 0) {
8922                     uv = iv;
8923                     if (plus)
8924                         esignbuf[esignlen++] = plus;
8925                 }
8926                 else {
8927                     uv = -iv;
8928                     esignbuf[esignlen++] = '-';
8929                 }
8930             }
8931             base = 10;
8932             goto integer;
8933
8934         case 'U':
8935 #ifdef IV_IS_QUAD
8936             intsize = 'q';
8937 #else
8938             intsize = 'l';
8939 #endif
8940             /* FALL THROUGH */
8941         case 'u':
8942             base = 10;
8943             goto uns_integer;
8944
8945         case 'b':
8946             base = 2;
8947             goto uns_integer;
8948
8949         case 'O':
8950 #ifdef IV_IS_QUAD
8951             intsize = 'q';
8952 #else
8953             intsize = 'l';
8954 #endif
8955             /* FALL THROUGH */
8956         case 'o':
8957             base = 8;
8958             goto uns_integer;
8959
8960         case 'X':
8961         case 'x':
8962             base = 16;
8963
8964         uns_integer:
8965             if (vectorize) {
8966                 STRLEN ulen;
8967         vector:
8968                 if (!veclen)
8969                     continue;
8970                 if (vec_utf8)
8971                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8972                                         UTF8_ALLOW_ANYUV);
8973                 else {
8974                     uv = *vecstr;
8975                     ulen = 1;
8976                 }
8977                 vecstr += ulen;
8978                 veclen -= ulen;
8979             }
8980             else if (args) {
8981                 switch (intsize) {
8982                 case 'h':  uv = (unsigned short)va_arg(*args, unsigned); break;
8983                 default:   uv = va_arg(*args, unsigned); break;
8984                 case 'l':  uv = va_arg(*args, unsigned long); break;
8985                 case 'V':  uv = va_arg(*args, UV); break;
8986 #ifdef HAS_QUAD
8987                 case 'q':  uv = va_arg(*args, Quad_t); break;
8988 #endif
8989                 }
8990             }
8991             else {
8992                 uv = SvUVx(argsv);
8993                 switch (intsize) {
8994                 case 'h':       uv = (unsigned short)uv; break;
8995                 default:        break;
8996                 case 'l':       uv = (unsigned long)uv; break;
8997                 case 'V':       break;
8998 #ifdef HAS_QUAD
8999                 case 'q':       uv = (Quad_t)uv; break;
9000 #endif
9001                 }
9002             }
9003
9004         integer:
9005             eptr = ebuf + sizeof ebuf;
9006             switch (base) {
9007                 unsigned dig;
9008             case 16:
9009                 if (!uv)
9010                     alt = FALSE;
9011                 p = (char*)((c == 'X')
9012                             ? "0123456789ABCDEF" : "0123456789abcdef");
9013                 do {
9014                     dig = uv & 15;
9015                     *--eptr = p[dig];
9016                 } while (uv >>= 4);
9017                 if (alt) {
9018                     esignbuf[esignlen++] = '0';
9019                     esignbuf[esignlen++] = c;  /* 'x' or 'X' */
9020                 }
9021                 break;
9022             case 8:
9023                 do {
9024                     dig = uv & 7;
9025                     *--eptr = '0' + dig;
9026                 } while (uv >>= 3);
9027                 if (alt && *eptr != '0')
9028                     *--eptr = '0';
9029                 break;
9030             case 2:
9031                 do {
9032                     dig = uv & 1;
9033                     *--eptr = '0' + dig;
9034                 } while (uv >>= 1);
9035                 if (alt) {
9036                     esignbuf[esignlen++] = '0';
9037                     esignbuf[esignlen++] = 'b';
9038                 }
9039                 break;
9040             default:            /* it had better be ten or less */
9041 #if defined(PERL_Y2KWARN)
9042                 if (ckWARN(WARN_Y2K)) {
9043                     STRLEN n;
9044                     char *s = SvPV(sv,n);
9045                     if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9046                         && (n == 2 || !isDIGIT(s[n-3])))
9047                     {
9048                         Perl_warner(aTHX_ packWARN(WARN_Y2K),
9049                                     "Possible Y2K bug: %%%c %s",
9050                                     c, "format string following '19'");
9051                     }
9052                 }
9053 #endif
9054                 do {
9055                     dig = uv % base;
9056                     *--eptr = '0' + dig;
9057                 } while (uv /= base);
9058                 break;
9059             }
9060             elen = (ebuf + sizeof ebuf) - eptr;
9061             if (has_precis) {
9062                 if (precis > elen)
9063                     zeros = precis - elen;
9064                 else if (precis == 0 && elen == 1 && *eptr == '0')
9065                     elen = 0;
9066             }
9067             break;
9068
9069             /* FLOATING POINT */
9070
9071         case 'F':
9072             c = 'f';            /* maybe %F isn't supported here */
9073             /* FALL THROUGH */
9074         case 'e': case 'E':
9075         case 'f':
9076         case 'g': case 'G':
9077
9078             /* This is evil, but floating point is even more evil */
9079
9080             /* for SV-style calling, we can only get NV
9081                for C-style calling, we assume %f is double;
9082                for simplicity we allow any of %Lf, %llf, %qf for long double
9083             */
9084             switch (intsize) {
9085             case 'V':
9086 #if defined(USE_LONG_DOUBLE)
9087                 intsize = 'q';
9088 #endif
9089                 break;
9090 /* [perl #20339] - we should accept and ignore %lf rather than die */
9091             case 'l':
9092                 /* FALL THROUGH */
9093             default:
9094 #if defined(USE_LONG_DOUBLE)
9095                 intsize = args ? 0 : 'q';
9096 #endif
9097                 break;
9098             case 'q':
9099 #if defined(HAS_LONG_DOUBLE)
9100                 break;
9101 #else
9102                 /* FALL THROUGH */
9103 #endif
9104             case 'h':
9105                 goto unknown;
9106             }
9107
9108             /* now we need (long double) if intsize == 'q', else (double) */
9109             nv = (args && !vectorize) ?
9110 #if LONG_DOUBLESIZE > DOUBLESIZE
9111                 intsize == 'q' ?
9112                     va_arg(*args, long double) :
9113                     va_arg(*args, double)
9114 #else
9115                     va_arg(*args, double)
9116 #endif
9117                 : SvNVx(argsv);
9118
9119             need = 0;
9120             vectorize = FALSE;
9121             if (c != 'e' && c != 'E') {
9122                 i = PERL_INT_MIN;
9123                 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9124                    will cast our (long double) to (double) */
9125                 (void)Perl_frexp(nv, &i);
9126                 if (i == PERL_INT_MIN)
9127                     Perl_die(aTHX_ "panic: frexp");
9128                 if (i > 0)
9129                     need = BIT_DIGITS(i);
9130             }
9131             need += has_precis ? precis : 6; /* known default */
9132
9133             if (need < width)
9134                 need = width;
9135
9136 #ifdef HAS_LDBL_SPRINTF_BUG
9137             /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9138                with sfio - Allen <allens@cpan.org> */
9139
9140 #  ifdef DBL_MAX
9141 #    define MY_DBL_MAX DBL_MAX
9142 #  else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9143 #    if DOUBLESIZE >= 8
9144 #      define MY_DBL_MAX 1.7976931348623157E+308L
9145 #    else
9146 #      define MY_DBL_MAX 3.40282347E+38L
9147 #    endif
9148 #  endif
9149
9150 #  ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9151 #    define MY_DBL_MAX_BUG 1L
9152 #  else
9153 #    define MY_DBL_MAX_BUG MY_DBL_MAX
9154 #  endif
9155
9156 #  ifdef DBL_MIN
9157 #    define MY_DBL_MIN DBL_MIN
9158 #  else  /* XXX guessing! -Allen */
9159 #    if DOUBLESIZE >= 8
9160 #      define MY_DBL_MIN 2.2250738585072014E-308L
9161 #    else
9162 #      define MY_DBL_MIN 1.17549435E-38L
9163 #    endif
9164 #  endif
9165
9166             if ((intsize == 'q') && (c == 'f') &&
9167                 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9168                 (need < DBL_DIG)) {
9169                 /* it's going to be short enough that
9170                  * long double precision is not needed */
9171
9172                 if ((nv <= 0L) && (nv >= -0L))
9173                     fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9174                 else {
9175                     /* would use Perl_fp_class as a double-check but not
9176                      * functional on IRIX - see perl.h comments */
9177
9178                     if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9179                         /* It's within the range that a double can represent */
9180 #if defined(DBL_MAX) && !defined(DBL_MIN)
9181                         if ((nv >= ((long double)1/DBL_MAX)) ||
9182                             (nv <= (-(long double)1/DBL_MAX)))
9183 #endif
9184                         fix_ldbl_sprintf_bug = TRUE;
9185                     }
9186                 }
9187                 if (fix_ldbl_sprintf_bug == TRUE) {
9188                     double temp;
9189
9190                     intsize = 0;
9191                     temp = (double)nv;
9192                     nv = (NV)temp;
9193                 }
9194             }
9195
9196 #  undef MY_DBL_MAX
9197 #  undef MY_DBL_MAX_BUG
9198 #  undef MY_DBL_MIN
9199
9200 #endif /* HAS_LDBL_SPRINTF_BUG */
9201
9202             need += 20; /* fudge factor */
9203             if (PL_efloatsize < need) {
9204                 Safefree(PL_efloatbuf);
9205                 PL_efloatsize = need + 20; /* more fudge */
9206                 New(906, PL_efloatbuf, PL_efloatsize, char);
9207                 PL_efloatbuf[0] = '\0';
9208             }
9209
9210             eptr = ebuf + sizeof ebuf;
9211             *--eptr = '\0';
9212             *--eptr = c;
9213             /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9214 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9215             if (intsize == 'q') {
9216                 /* Copy the one or more characters in a long double
9217                  * format before the 'base' ([efgEFG]) character to
9218                  * the format string. */
9219                 static char const prifldbl[] = PERL_PRIfldbl;
9220                 char const *p = prifldbl + sizeof(prifldbl) - 3;
9221                 while (p >= prifldbl) { *--eptr = *p--; }
9222             }
9223 #endif
9224             if (has_precis) {
9225                 base = precis;
9226                 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9227                 *--eptr = '.';
9228             }
9229             if (width) {
9230                 base = width;
9231                 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9232             }
9233             if (fill == '0')
9234                 *--eptr = fill;
9235             if (left)
9236                 *--eptr = '-';
9237             if (plus)
9238                 *--eptr = plus;
9239             if (alt)
9240                 *--eptr = '#';
9241             *--eptr = '%';
9242
9243             /* No taint.  Otherwise we are in the strange situation
9244              * where printf() taints but print($float) doesn't.
9245              * --jhi */
9246 #if defined(HAS_LONG_DOUBLE)
9247             if (intsize == 'q')
9248                 (void)sprintf(PL_efloatbuf, eptr, nv);
9249             else
9250                 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9251 #else
9252             (void)sprintf(PL_efloatbuf, eptr, nv);
9253 #endif
9254             eptr = PL_efloatbuf;
9255             elen = strlen(PL_efloatbuf);
9256             break;
9257
9258             /* SPECIAL */
9259
9260         case 'n':
9261             i = SvCUR(sv) - origlen;
9262             if (args && !vectorize) {
9263                 switch (intsize) {
9264                 case 'h':       *(va_arg(*args, short*)) = i; break;
9265                 default:        *(va_arg(*args, int*)) = i; break;
9266                 case 'l':       *(va_arg(*args, long*)) = i; break;
9267                 case 'V':       *(va_arg(*args, IV*)) = i; break;
9268 #ifdef HAS_QUAD
9269                 case 'q':       *(va_arg(*args, Quad_t*)) = i; break;
9270 #endif
9271                 }
9272             }
9273             else
9274                 sv_setuv_mg(argsv, (UV)i);
9275             vectorize = FALSE;
9276             continue;   /* not "break" */
9277
9278             /* UNKNOWN */
9279
9280         default:
9281       unknown:
9282             if (!args && ckWARN(WARN_PRINTF) &&
9283                   (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9284                 SV *msg = sv_newmortal();
9285                 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9286                           (PL_op->op_type == OP_PRTF) ? "" : "s");
9287                 if (c) {
9288                     if (isPRINT(c))
9289                         Perl_sv_catpvf(aTHX_ msg,
9290                                        "\"%%%c\"", c & 0xFF);
9291                     else
9292                         Perl_sv_catpvf(aTHX_ msg,
9293                                        "\"%%\\%03"UVof"\"",
9294                                        (UV)c & 0xFF);
9295                 } else
9296                     sv_catpv(msg, "end of string");
9297                 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9298             }
9299
9300             /* output mangled stuff ... */
9301             if (c == '\0')
9302                 --q;
9303             eptr = p;
9304             elen = q - p;
9305
9306             /* ... right here, because formatting flags should not apply */
9307             SvGROW(sv, SvCUR(sv) + elen + 1);
9308             p = SvEND(sv);
9309             Copy(eptr, p, elen, char);
9310             p += elen;
9311             *p = '\0';
9312             SvCUR(sv) = p - SvPVX(sv);
9313             svix = osvix;
9314             continue;   /* not "break" */
9315         }
9316
9317         if (is_utf8 != has_utf8) {
9318              if (is_utf8) {
9319                   if (SvCUR(sv))
9320                        sv_utf8_upgrade(sv);
9321              }
9322              else {
9323                   SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9324                   sv_utf8_upgrade(nsv);
9325                   eptr = SvPVX(nsv);
9326                   elen = SvCUR(nsv);
9327              }
9328              SvGROW(sv, SvCUR(sv) + elen + 1);
9329              p = SvEND(sv);
9330              *p = '\0';
9331         }
9332         /* Use memchr() instead of strchr(), as eptr is not guaranteed */
9333         /* to point to a null-terminated string.                       */
9334         if (left && ckWARN(WARN_PRINTF) && memchr(eptr, '\n', elen) &&
9335             (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF))
9336             Perl_warner(aTHX_ packWARN(WARN_PRINTF),
9337                 "Newline in left-justified string for %sprintf",
9338                         (PL_op->op_type == OP_PRTF) ? "" : "s");
9339
9340         have = esignlen + zeros + elen;
9341         need = (have > width ? have : width);
9342         gap = need - have;
9343
9344         SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9345         p = SvEND(sv);
9346         if (esignlen && fill == '0') {
9347             for (i = 0; i < (int)esignlen; i++)
9348                 *p++ = esignbuf[i];
9349         }
9350         if (gap && !left) {
9351             memset(p, fill, gap);
9352             p += gap;
9353         }
9354         if (esignlen && fill != '0') {
9355             for (i = 0; i < (int)esignlen; i++)
9356                 *p++ = esignbuf[i];
9357         }
9358         if (zeros) {
9359             for (i = zeros; i; i--)
9360                 *p++ = '0';
9361         }
9362         if (elen) {
9363             Copy(eptr, p, elen, char);
9364             p += elen;
9365         }
9366         if (gap && left) {
9367             memset(p, ' ', gap);
9368             p += gap;
9369         }
9370         if (vectorize) {
9371             if (veclen) {
9372                 Copy(dotstr, p, dotstrlen, char);
9373                 p += dotstrlen;
9374             }
9375             else
9376                 vectorize = FALSE;              /* done iterating over vecstr */
9377         }
9378         if (is_utf8)
9379             has_utf8 = TRUE;
9380         if (has_utf8)
9381             SvUTF8_on(sv);
9382         *p = '\0';
9383         SvCUR(sv) = p - SvPVX(sv);
9384         if (vectorize) {
9385             esignlen = 0;
9386             goto vector;
9387         }
9388     }
9389 }
9390
9391 /* =========================================================================
9392
9393 =head1 Cloning an interpreter
9394
9395 All the macros and functions in this section are for the private use of
9396 the main function, perl_clone().
9397
9398 The foo_dup() functions make an exact copy of an existing foo thinngy.
9399 During the course of a cloning, a hash table is used to map old addresses
9400 to new addresses. The table is created and manipulated with the
9401 ptr_table_* functions.
9402
9403 =cut
9404
9405 ============================================================================*/
9406
9407
9408 #if defined(USE_ITHREADS)
9409
9410 #ifndef GpREFCNT_inc
9411 #  define GpREFCNT_inc(gp)      ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9412 #endif
9413
9414
9415 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9416 #define av_dup(s,t)     (AV*)sv_dup((SV*)s,t)
9417 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9418 #define hv_dup(s,t)     (HV*)sv_dup((SV*)s,t)
9419 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9420 #define cv_dup(s,t)     (CV*)sv_dup((SV*)s,t)
9421 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9422 #define io_dup(s,t)     (IO*)sv_dup((SV*)s,t)
9423 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9424 #define gv_dup(s,t)     (GV*)sv_dup((SV*)s,t)
9425 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9426 #define SAVEPV(p)       (p ? savepv(p) : Nullch)
9427 #define SAVEPVN(p,n)    (p ? savepvn(p,n) : Nullch)
9428
9429
9430 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9431    regcomp.c. AMS 20010712 */
9432
9433 REGEXP *
9434 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
9435 {
9436     REGEXP *ret;
9437     int i, len, npar;
9438     struct reg_substr_datum *s;
9439
9440     if (!r)
9441         return (REGEXP *)NULL;
9442
9443     if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9444         return ret;
9445
9446     len = r->offsets[0];
9447     npar = r->nparens+1;
9448
9449     Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9450     Copy(r->program, ret->program, len+1, regnode);
9451
9452     New(0, ret->startp, npar, I32);
9453     Copy(r->startp, ret->startp, npar, I32);
9454     New(0, ret->endp, npar, I32);
9455     Copy(r->startp, ret->startp, npar, I32);
9456
9457     New(0, ret->substrs, 1, struct reg_substr_data);
9458     for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9459         s->min_offset = r->substrs->data[i].min_offset;
9460         s->max_offset = r->substrs->data[i].max_offset;
9461         s->substr     = sv_dup_inc(r->substrs->data[i].substr, param);
9462         s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9463     }
9464
9465     ret->regstclass = NULL;
9466     if (r->data) {
9467         struct reg_data *d;
9468         int count = r->data->count;
9469
9470         Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9471                 char, struct reg_data);
9472         New(0, d->what, count, U8);
9473
9474         d->count = count;
9475         for (i = 0; i < count; i++) {
9476             d->what[i] = r->data->what[i];
9477             switch (d->what[i]) {
9478             case 's':
9479                 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9480                 break;
9481             case 'p':
9482                 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9483                 break;
9484             case 'f':
9485                 /* This is cheating. */
9486                 New(0, d->data[i], 1, struct regnode_charclass_class);
9487                 StructCopy(r->data->data[i], d->data[i],
9488                             struct regnode_charclass_class);
9489                 ret->regstclass = (regnode*)d->data[i];
9490                 break;
9491             case 'o':
9492                 /* Compiled op trees are readonly, and can thus be
9493                    shared without duplication. */
9494                 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9495                 break;
9496             case 'n':
9497                 d->data[i] = r->data->data[i];
9498                 break;
9499             }
9500         }
9501
9502         ret->data = d;
9503     }
9504     else
9505         ret->data = NULL;
9506
9507     New(0, ret->offsets, 2*len+1, U32);
9508     Copy(r->offsets, ret->offsets, 2*len+1, U32);
9509
9510     ret->precomp        = SAVEPV(r->precomp);
9511     ret->refcnt         = r->refcnt;
9512     ret->minlen         = r->minlen;
9513     ret->prelen         = r->prelen;
9514     ret->nparens        = r->nparens;
9515     ret->lastparen      = r->lastparen;
9516     ret->lastcloseparen = r->lastcloseparen;
9517     ret->reganch        = r->reganch;
9518
9519     ret->sublen         = r->sublen;
9520
9521     if (RX_MATCH_COPIED(ret))
9522         ret->subbeg  = SAVEPV(r->subbeg);
9523     else
9524         ret->subbeg = Nullch;
9525 #ifdef PERL_COPY_ON_WRITE
9526     ret->saved_copy = Nullsv;
9527 #endif
9528
9529     ptr_table_store(PL_ptr_table, r, ret);
9530     return ret;
9531 }
9532
9533 /* duplicate a file handle */
9534
9535 PerlIO *
9536 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9537 {
9538     PerlIO *ret;
9539     if (!fp)
9540         return (PerlIO*)NULL;
9541
9542     /* look for it in the table first */
9543     ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9544     if (ret)
9545         return ret;
9546
9547     /* create anew and remember what it is */
9548     ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9549     ptr_table_store(PL_ptr_table, fp, ret);
9550     return ret;
9551 }
9552
9553 /* duplicate a directory handle */
9554
9555 DIR *
9556 Perl_dirp_dup(pTHX_ DIR *dp)
9557 {
9558     if (!dp)
9559         return (DIR*)NULL;
9560     /* XXX TODO */
9561     return dp;
9562 }
9563
9564 /* duplicate a typeglob */
9565
9566 GP *
9567 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9568 {
9569     GP *ret;
9570     if (!gp)
9571         return (GP*)NULL;
9572     /* look for it in the table first */
9573     ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9574     if (ret)
9575         return ret;
9576
9577     /* create anew and remember what it is */
9578     Newz(0, ret, 1, GP);
9579     ptr_table_store(PL_ptr_table, gp, ret);
9580
9581     /* clone */
9582     ret->gp_refcnt      = 0;                    /* must be before any other dups! */
9583     ret->gp_sv          = sv_dup_inc(gp->gp_sv, param);
9584     ret->gp_io          = io_dup_inc(gp->gp_io, param);
9585     ret->gp_form        = cv_dup_inc(gp->gp_form, param);
9586     ret->gp_av          = av_dup_inc(gp->gp_av, param);
9587     ret->gp_hv          = hv_dup_inc(gp->gp_hv, param);
9588     ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9589     ret->gp_cv          = cv_dup_inc(gp->gp_cv, param);
9590     ret->gp_cvgen       = gp->gp_cvgen;
9591     ret->gp_flags       = gp->gp_flags;
9592     ret->gp_line        = gp->gp_line;
9593     ret->gp_file        = gp->gp_file;          /* points to COP.cop_file */
9594     return ret;
9595 }
9596
9597 /* duplicate a chain of magic */
9598
9599 MAGIC *
9600 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9601 {
9602     MAGIC *mgprev = (MAGIC*)NULL;
9603     MAGIC *mgret;
9604     if (!mg)
9605         return (MAGIC*)NULL;
9606     /* look for it in the table first */
9607     mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9608     if (mgret)
9609         return mgret;
9610
9611     for (; mg; mg = mg->mg_moremagic) {
9612         MAGIC *nmg;
9613         Newz(0, nmg, 1, MAGIC);
9614         if (mgprev)
9615             mgprev->mg_moremagic = nmg;
9616         else
9617             mgret = nmg;
9618         nmg->mg_virtual = mg->mg_virtual;       /* XXX copy dynamic vtable? */
9619         nmg->mg_private = mg->mg_private;
9620         nmg->mg_type    = mg->mg_type;
9621         nmg->mg_flags   = mg->mg_flags;
9622         if (mg->mg_type == PERL_MAGIC_qr) {
9623             nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9624         }
9625         else if(mg->mg_type == PERL_MAGIC_backref) {
9626              AV *av = (AV*) mg->mg_obj;
9627              SV **svp;
9628              I32 i;
9629              nmg->mg_obj = (SV*)newAV();
9630              svp = AvARRAY(av);
9631              i = AvFILLp(av);
9632              while (i >= 0) {
9633                   av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9634                   i--;
9635              }
9636         }
9637         else {
9638             nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9639                               ? sv_dup_inc(mg->mg_obj, param)
9640                               : sv_dup(mg->mg_obj, param);
9641         }
9642         nmg->mg_len     = mg->mg_len;
9643         nmg->mg_ptr     = mg->mg_ptr;   /* XXX random ptr? */
9644         if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9645             if (mg->mg_len > 0) {
9646                 nmg->mg_ptr     = SAVEPVN(mg->mg_ptr, mg->mg_len);
9647                 if (mg->mg_type == PERL_MAGIC_overload_table &&
9648                         AMT_AMAGIC((AMT*)mg->mg_ptr))
9649                 {
9650                     AMT *amtp = (AMT*)mg->mg_ptr;
9651                     AMT *namtp = (AMT*)nmg->mg_ptr;
9652                     I32 i;
9653                     for (i = 1; i < NofAMmeth; i++) {
9654                         namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9655                     }
9656                 }
9657             }
9658             else if (mg->mg_len == HEf_SVKEY)
9659                 nmg->mg_ptr     = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9660         }
9661         if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9662             CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9663         }
9664         mgprev = nmg;
9665     }
9666     return mgret;
9667 }
9668
9669 /* create a new pointer-mapping table */
9670
9671 PTR_TBL_t *
9672 Perl_ptr_table_new(pTHX)
9673 {
9674     PTR_TBL_t *tbl;
9675     Newz(0, tbl, 1, PTR_TBL_t);
9676     tbl->tbl_max        = 511;
9677     tbl->tbl_items      = 0;
9678     Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9679     return tbl;
9680 }
9681
9682 /* map an existing pointer using a table */
9683
9684 void *
9685 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
9686 {
9687     PTR_TBL_ENT_t *tblent;
9688     UV hash = PTR2UV(sv);
9689     assert(tbl);
9690     tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9691     for (; tblent; tblent = tblent->next) {
9692         if (tblent->oldval == sv)
9693             return tblent->newval;
9694     }
9695     return (void*)NULL;
9696 }
9697
9698 /* add a new entry to a pointer-mapping table */
9699
9700 void
9701 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
9702 {
9703     PTR_TBL_ENT_t *tblent, **otblent;
9704     /* XXX this may be pessimal on platforms where pointers aren't good
9705      * hash values e.g. if they grow faster in the most significant
9706      * bits */
9707     UV hash = PTR2UV(oldv);
9708     bool i = 1;
9709
9710     assert(tbl);
9711     otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9712     for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
9713         if (tblent->oldval == oldv) {
9714             tblent->newval = newv;
9715             return;
9716         }
9717     }
9718     Newz(0, tblent, 1, PTR_TBL_ENT_t);
9719     tblent->oldval = oldv;
9720     tblent->newval = newv;
9721     tblent->next = *otblent;
9722     *otblent = tblent;
9723     tbl->tbl_items++;
9724     if (i && tbl->tbl_items > tbl->tbl_max)
9725         ptr_table_split(tbl);
9726 }
9727
9728 /* double the hash bucket size of an existing ptr table */
9729
9730 void
9731 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9732 {
9733     PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9734     UV oldsize = tbl->tbl_max + 1;
9735     UV newsize = oldsize * 2;
9736     UV i;
9737
9738     Renew(ary, newsize, PTR_TBL_ENT_t*);
9739     Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9740     tbl->tbl_max = --newsize;
9741     tbl->tbl_ary = ary;
9742     for (i=0; i < oldsize; i++, ary++) {
9743         PTR_TBL_ENT_t **curentp, **entp, *ent;
9744         if (!*ary)
9745             continue;
9746         curentp = ary + oldsize;
9747         for (entp = ary, ent = *ary; ent; ent = *entp) {
9748             if ((newsize & PTR2UV(ent->oldval)) != i) {
9749                 *entp = ent->next;
9750                 ent->next = *curentp;
9751                 *curentp = ent;
9752                 continue;
9753             }
9754             else
9755                 entp = &ent->next;
9756         }
9757     }
9758 }
9759
9760 /* remove all the entries from a ptr table */
9761
9762 void
9763 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9764 {
9765     register PTR_TBL_ENT_t **array;
9766     register PTR_TBL_ENT_t *entry;
9767     register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
9768     UV riter = 0;
9769     UV max;
9770
9771     if (!tbl || !tbl->tbl_items) {
9772         return;
9773     }
9774
9775     array = tbl->tbl_ary;
9776     entry = array[0];
9777     max = tbl->tbl_max;
9778
9779     for (;;) {
9780         if (entry) {
9781             oentry = entry;
9782             entry = entry->next;
9783             Safefree(oentry);
9784         }
9785         if (!entry) {
9786             if (++riter > max) {
9787                 break;
9788             }
9789             entry = array[riter];
9790         }
9791     }
9792
9793     tbl->tbl_items = 0;
9794 }
9795
9796 /* clear and free a ptr table */
9797
9798 void
9799 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9800 {
9801     if (!tbl) {
9802         return;
9803     }
9804     ptr_table_clear(tbl);
9805     Safefree(tbl->tbl_ary);
9806     Safefree(tbl);
9807 }
9808
9809 #ifdef DEBUGGING
9810 char *PL_watch_pvx;
9811 #endif
9812
9813 /* attempt to make everything in the typeglob readonly */
9814
9815 STATIC SV *
9816 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
9817 {
9818     GV *gv = (GV*)sstr;
9819     SV *sv = &param->proto_perl->Isv_no; /* just need SvREADONLY-ness */
9820
9821     if (GvIO(gv) || GvFORM(gv)) {
9822         GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
9823     }
9824     else if (!GvCV(gv)) {
9825         GvCV(gv) = (CV*)sv;
9826     }
9827     else {
9828         /* CvPADLISTs cannot be shared */
9829         if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
9830             GvUNIQUE_off(gv);
9831         }
9832     }
9833
9834     if (!GvUNIQUE(gv)) {
9835 #if 0
9836         PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
9837                       HvNAME(GvSTASH(gv)), GvNAME(gv));
9838 #endif
9839         return Nullsv;
9840     }
9841
9842     /*
9843      * write attempts will die with
9844      * "Modification of a read-only value attempted"
9845      */
9846     if (!GvSV(gv)) {
9847         GvSV(gv) = sv;
9848     }
9849     else {
9850         SvREADONLY_on(GvSV(gv));
9851     }
9852
9853     if (!GvAV(gv)) {
9854         GvAV(gv) = (AV*)sv;
9855     }
9856     else {
9857         SvREADONLY_on(GvAV(gv));
9858     }
9859
9860     if (!GvHV(gv)) {
9861         GvHV(gv) = (HV*)sv;
9862     }
9863     else {
9864         SvREADONLY_on(GvAV(gv));
9865     }
9866
9867     return sstr; /* he_dup() will SvREFCNT_inc() */
9868 }
9869
9870 /* duplicate an SV of any type (including AV, HV etc) */
9871
9872 void
9873 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9874 {
9875     if (SvROK(sstr)) {
9876         SvRV(dstr) = SvWEAKREF(sstr)
9877                      ? sv_dup(SvRV(sstr), param)
9878                      : sv_dup_inc(SvRV(sstr), param);
9879     }
9880     else if (SvPVX(sstr)) {
9881         /* Has something there */
9882         if (SvLEN(sstr)) {
9883             /* Normal PV - clone whole allocated space */
9884             SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
9885             if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9886                 /* Not that normal - actually sstr is copy on write.
9887                    But we are a true, independant SV, so:  */
9888                 SvREADONLY_off(dstr);
9889                 SvFAKE_off(dstr);
9890             }
9891         }
9892         else {
9893             /* Special case - not normally malloced for some reason */
9894             if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9895                 /* A "shared" PV - clone it as unshared string */
9896                 if(SvPADTMP(sstr)) {
9897                     /* However, some of them live in the pad
9898                        and they should not have these flags
9899                        turned off */
9900
9901                     SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
9902                                            SvUVX(sstr));
9903                     SvUVX(dstr) = SvUVX(sstr);
9904                 } else {
9905
9906                     SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
9907                     SvFAKE_off(dstr);
9908                     SvREADONLY_off(dstr);
9909                 }
9910             }
9911             else {
9912                 /* Some other special case - random pointer */
9913                 SvPVX(dstr) = SvPVX(sstr);
9914             }
9915         }
9916     }
9917     else {
9918         /* Copy the Null */
9919         SvPVX(dstr) = SvPVX(sstr);
9920     }
9921 }
9922
9923 SV *
9924 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9925 {
9926     SV *dstr;
9927
9928     if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9929         return Nullsv;
9930     /* look for it in the table first */
9931     dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9932     if (dstr)
9933         return dstr;
9934
9935     if(param->flags & CLONEf_JOIN_IN) {
9936         /** We are joining here so we don't want do clone
9937             something that is bad **/
9938
9939         if(SvTYPE(sstr) == SVt_PVHV &&
9940            HvNAME(sstr)) {
9941             /** don't clone stashes if they already exist **/
9942             HV* old_stash = gv_stashpv(HvNAME(sstr),0);
9943             return (SV*) old_stash;
9944         }
9945     }
9946
9947     /* create anew and remember what it is */
9948     new_SV(dstr);
9949     ptr_table_store(PL_ptr_table, sstr, dstr);
9950
9951     /* clone */
9952     SvFLAGS(dstr)       = SvFLAGS(sstr);
9953     SvFLAGS(dstr)       &= ~SVf_OOK;            /* don't propagate OOK hack */
9954     SvREFCNT(dstr)      = 0;                    /* must be before any other dups! */
9955
9956 #ifdef DEBUGGING
9957     if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
9958         PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9959                       PL_watch_pvx, SvPVX(sstr));
9960 #endif
9961
9962     switch (SvTYPE(sstr)) {
9963     case SVt_NULL:
9964         SvANY(dstr)     = NULL;
9965         break;
9966     case SVt_IV:
9967         SvANY(dstr)     = new_XIV();
9968         SvIVX(dstr)     = SvIVX(sstr);
9969         break;
9970     case SVt_NV:
9971         SvANY(dstr)     = new_XNV();
9972         SvNVX(dstr)     = SvNVX(sstr);
9973         break;
9974     case SVt_RV:
9975         SvANY(dstr)     = new_XRV();
9976         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9977         break;
9978     case SVt_PV:
9979         SvANY(dstr)     = new_XPV();
9980         SvCUR(dstr)     = SvCUR(sstr);
9981         SvLEN(dstr)     = SvLEN(sstr);
9982         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9983         break;
9984     case SVt_PVIV:
9985         SvANY(dstr)     = new_XPVIV();
9986         SvCUR(dstr)     = SvCUR(sstr);
9987         SvLEN(dstr)     = SvLEN(sstr);
9988         SvIVX(dstr)     = SvIVX(sstr);
9989         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9990         break;
9991     case SVt_PVNV:
9992         SvANY(dstr)     = new_XPVNV();
9993         SvCUR(dstr)     = SvCUR(sstr);
9994         SvLEN(dstr)     = SvLEN(sstr);
9995         SvIVX(dstr)     = SvIVX(sstr);
9996         SvNVX(dstr)     = SvNVX(sstr);
9997         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9998         break;
9999     case SVt_PVMG:
10000         SvANY(dstr)     = new_XPVMG();
10001         SvCUR(dstr)     = SvCUR(sstr);
10002         SvLEN(dstr)     = SvLEN(sstr);
10003         SvIVX(dstr)     = SvIVX(sstr);
10004         SvNVX(dstr)     = SvNVX(sstr);
10005         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10006         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10007         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10008         break;
10009     case SVt_PVBM:
10010         SvANY(dstr)     = new_XPVBM();
10011         SvCUR(dstr)     = SvCUR(sstr);
10012         SvLEN(dstr)     = SvLEN(sstr);
10013         SvIVX(dstr)     = SvIVX(sstr);
10014         SvNVX(dstr)     = SvNVX(sstr);
10015         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10016         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10017         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10018         BmRARE(dstr)    = BmRARE(sstr);
10019         BmUSEFUL(dstr)  = BmUSEFUL(sstr);
10020         BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10021         break;
10022     case SVt_PVLV:
10023         SvANY(dstr)     = new_XPVLV();
10024         SvCUR(dstr)     = SvCUR(sstr);
10025         SvLEN(dstr)     = SvLEN(sstr);
10026         SvIVX(dstr)     = SvIVX(sstr);
10027         SvNVX(dstr)     = SvNVX(sstr);
10028         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10029         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10030         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10031         LvTARGOFF(dstr) = LvTARGOFF(sstr);      /* XXX sometimes holds PMOP* when DEBUGGING */
10032         LvTARGLEN(dstr) = LvTARGLEN(sstr);
10033         if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10034             LvTARG(dstr) = dstr;
10035         else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10036             LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10037         else
10038             LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10039         LvTYPE(dstr)    = LvTYPE(sstr);
10040         break;
10041     case SVt_PVGV:
10042         if (GvUNIQUE((GV*)sstr)) {
10043             SV *share;
10044             if ((share = gv_share(sstr, param))) {
10045                 del_SV(dstr);
10046                 dstr = share;
10047                 ptr_table_store(PL_ptr_table, sstr, dstr);
10048 #if 0
10049                 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10050                               HvNAME(GvSTASH(share)), GvNAME(share));
10051 #endif
10052                 break;
10053             }
10054         }
10055         SvANY(dstr)     = new_XPVGV();
10056         SvCUR(dstr)     = SvCUR(sstr);
10057         SvLEN(dstr)     = SvLEN(sstr);
10058         SvIVX(dstr)     = SvIVX(sstr);
10059         SvNVX(dstr)     = SvNVX(sstr);
10060         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10061         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10062         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10063         GvNAMELEN(dstr) = GvNAMELEN(sstr);
10064         GvNAME(dstr)    = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10065         GvSTASH(dstr)   = hv_dup_inc(GvSTASH(sstr), param);
10066         GvFLAGS(dstr)   = GvFLAGS(sstr);
10067         GvGP(dstr)      = gp_dup(GvGP(sstr), param);
10068         (void)GpREFCNT_inc(GvGP(dstr));
10069         break;
10070     case SVt_PVIO:
10071         SvANY(dstr)     = new_XPVIO();
10072         SvCUR(dstr)     = SvCUR(sstr);
10073         SvLEN(dstr)     = SvLEN(sstr);
10074         SvIVX(dstr)     = SvIVX(sstr);
10075         SvNVX(dstr)     = SvNVX(sstr);
10076         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10077         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10078         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10079         IoIFP(dstr)     = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10080         if (IoOFP(sstr) == IoIFP(sstr))
10081             IoOFP(dstr) = IoIFP(dstr);
10082         else
10083             IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10084         /* PL_rsfp_filters entries have fake IoDIRP() */
10085         if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10086             IoDIRP(dstr)        = dirp_dup(IoDIRP(sstr));
10087         else
10088             IoDIRP(dstr)        = IoDIRP(sstr);
10089         IoLINES(dstr)           = IoLINES(sstr);
10090         IoPAGE(dstr)            = IoPAGE(sstr);
10091         IoPAGE_LEN(dstr)        = IoPAGE_LEN(sstr);
10092         IoLINES_LEFT(dstr)      = IoLINES_LEFT(sstr);
10093         if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10094             /* I have no idea why fake dirp (rsfps)
10095                should be treaded differently but otherwise
10096                we end up with leaks -- sky*/
10097             IoTOP_GV(dstr)      = gv_dup_inc(IoTOP_GV(sstr), param);
10098             IoFMT_GV(dstr)      = gv_dup_inc(IoFMT_GV(sstr), param);
10099             IoBOTTOM_GV(dstr)   = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10100         } else {
10101             IoTOP_GV(dstr)      = gv_dup(IoTOP_GV(sstr), param);
10102             IoFMT_GV(dstr)      = gv_dup(IoFMT_GV(sstr), param);
10103             IoBOTTOM_GV(dstr)   = gv_dup(IoBOTTOM_GV(sstr), param);
10104         }
10105         IoTOP_NAME(dstr)        = SAVEPV(IoTOP_NAME(sstr));
10106         IoFMT_NAME(dstr)        = SAVEPV(IoFMT_NAME(sstr));
10107         IoBOTTOM_NAME(dstr)     = SAVEPV(IoBOTTOM_NAME(sstr));
10108         IoSUBPROCESS(dstr)      = IoSUBPROCESS(sstr);
10109         IoTYPE(dstr)            = IoTYPE(sstr);
10110         IoFLAGS(dstr)           = IoFLAGS(sstr);
10111         break;
10112     case SVt_PVAV:
10113         SvANY(dstr)     = new_XPVAV();
10114         SvCUR(dstr)     = SvCUR(sstr);
10115         SvLEN(dstr)     = SvLEN(sstr);
10116         SvIVX(dstr)     = SvIVX(sstr);
10117         SvNVX(dstr)     = SvNVX(sstr);
10118         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10119         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10120         AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10121         AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10122         if (AvARRAY((AV*)sstr)) {
10123             SV **dst_ary, **src_ary;
10124             SSize_t items = AvFILLp((AV*)sstr) + 1;
10125
10126             src_ary = AvARRAY((AV*)sstr);
10127             Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10128             ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10129             SvPVX(dstr) = (char*)dst_ary;
10130             AvALLOC((AV*)dstr) = dst_ary;
10131             if (AvREAL((AV*)sstr)) {
10132                 while (items-- > 0)
10133                     *dst_ary++ = sv_dup_inc(*src_ary++, param);
10134             }
10135             else {
10136                 while (items-- > 0)
10137                     *dst_ary++ = sv_dup(*src_ary++, param);
10138             }
10139             items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10140             while (items-- > 0) {
10141                 *dst_ary++ = &PL_sv_undef;
10142             }
10143         }
10144         else {
10145             SvPVX(dstr)         = Nullch;
10146             AvALLOC((AV*)dstr)  = (SV**)NULL;
10147         }
10148         break;
10149     case SVt_PVHV:
10150         SvANY(dstr)     = new_XPVHV();
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         HvRITER((HV*)dstr)      = HvRITER((HV*)sstr);
10158         if (HvARRAY((HV*)sstr)) {
10159             STRLEN i = 0;
10160             XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10161             XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10162             Newz(0, dxhv->xhv_array,
10163                  PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10164             while (i <= sxhv->xhv_max) {
10165                 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10166                                                     (bool)!!HvSHAREKEYS(sstr),
10167                                                     param);
10168                 ++i;
10169             }
10170             dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10171                                      (bool)!!HvSHAREKEYS(sstr), param);
10172         }
10173         else {
10174             SvPVX(dstr)         = Nullch;
10175             HvEITER((HV*)dstr)  = (HE*)NULL;
10176         }
10177         HvPMROOT((HV*)dstr)     = HvPMROOT((HV*)sstr);          /* XXX */
10178         HvNAME((HV*)dstr)       = SAVEPV(HvNAME((HV*)sstr));
10179     /* Record stashes for possible cloning in Perl_clone(). */
10180         if(HvNAME((HV*)dstr))
10181             av_push(param->stashes, dstr);
10182         break;
10183     case SVt_PVFM:
10184         SvANY(dstr)     = new_XPVFM();
10185         FmLINES(dstr)   = FmLINES(sstr);
10186         goto dup_pvcv;
10187         /* NOTREACHED */
10188     case SVt_PVCV:
10189         SvANY(dstr)     = new_XPVCV();
10190         dup_pvcv:
10191         SvCUR(dstr)     = SvCUR(sstr);
10192         SvLEN(dstr)     = SvLEN(sstr);
10193         SvIVX(dstr)     = SvIVX(sstr);
10194         SvNVX(dstr)     = SvNVX(sstr);
10195         SvMAGIC(dstr)   = mg_dup(SvMAGIC(sstr), param);
10196         SvSTASH(dstr)   = hv_dup_inc(SvSTASH(sstr), param);
10197         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10198         CvSTASH(dstr)   = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10199         CvSTART(dstr)   = CvSTART(sstr);
10200         CvROOT(dstr)    = OpREFCNT_inc(CvROOT(sstr));
10201         CvXSUB(dstr)    = CvXSUB(sstr);
10202         CvXSUBANY(dstr) = CvXSUBANY(sstr);
10203         if (CvCONST(sstr)) {
10204             CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10205                 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10206                 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10207         }
10208         CvGV(dstr)      = gv_dup(CvGV(sstr), param);
10209         if (param->flags & CLONEf_COPY_STACKS) {
10210           CvDEPTH(dstr) = CvDEPTH(sstr);
10211         } else {
10212           CvDEPTH(dstr) = 0;
10213         }
10214         PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10215         CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10216         CvOUTSIDE(dstr) =
10217                 CvWEAKOUTSIDE(sstr)
10218                         ? cv_dup(    CvOUTSIDE(sstr), param)
10219                         : cv_dup_inc(CvOUTSIDE(sstr), param);
10220         CvFLAGS(dstr)   = CvFLAGS(sstr);
10221         CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10222         break;
10223     default:
10224         Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10225         break;
10226     }
10227
10228     if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10229         ++PL_sv_objcount;
10230
10231     return dstr;
10232  }
10233
10234 /* duplicate a context */
10235
10236 PERL_CONTEXT *
10237 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10238 {
10239     PERL_CONTEXT *ncxs;
10240
10241     if (!cxs)
10242         return (PERL_CONTEXT*)NULL;
10243
10244     /* look for it in the table first */
10245     ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10246     if (ncxs)
10247         return ncxs;
10248
10249     /* create anew and remember what it is */
10250     Newz(56, ncxs, max + 1, PERL_CONTEXT);
10251     ptr_table_store(PL_ptr_table, cxs, ncxs);
10252
10253     while (ix >= 0) {
10254         PERL_CONTEXT *cx = &cxs[ix];
10255         PERL_CONTEXT *ncx = &ncxs[ix];
10256         ncx->cx_type    = cx->cx_type;
10257         if (CxTYPE(cx) == CXt_SUBST) {
10258             Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10259         }
10260         else {
10261             ncx->blk_oldsp      = cx->blk_oldsp;
10262             ncx->blk_oldcop     = cx->blk_oldcop;
10263             ncx->blk_oldretsp   = cx->blk_oldretsp;
10264             ncx->blk_oldmarksp  = cx->blk_oldmarksp;
10265             ncx->blk_oldscopesp = cx->blk_oldscopesp;
10266             ncx->blk_oldpm      = cx->blk_oldpm;
10267             ncx->blk_gimme      = cx->blk_gimme;
10268             switch (CxTYPE(cx)) {
10269             case CXt_SUB:
10270                 ncx->blk_sub.cv         = (cx->blk_sub.olddepth == 0
10271                                            ? cv_dup_inc(cx->blk_sub.cv, param)
10272                                            : cv_dup(cx->blk_sub.cv,param));
10273                 ncx->blk_sub.argarray   = (cx->blk_sub.hasargs
10274                                            ? av_dup_inc(cx->blk_sub.argarray, param)
10275                                            : Nullav);
10276                 ncx->blk_sub.savearray  = av_dup_inc(cx->blk_sub.savearray, param);
10277                 ncx->blk_sub.olddepth   = cx->blk_sub.olddepth;
10278                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
10279                 ncx->blk_sub.lval       = cx->blk_sub.lval;
10280                 break;
10281             case CXt_EVAL:
10282                 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10283                 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10284                 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10285                 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10286                 ncx->blk_eval.cur_text  = sv_dup(cx->blk_eval.cur_text, param);
10287                 break;
10288             case CXt_LOOP:
10289                 ncx->blk_loop.label     = cx->blk_loop.label;
10290                 ncx->blk_loop.resetsp   = cx->blk_loop.resetsp;
10291                 ncx->blk_loop.redo_op   = cx->blk_loop.redo_op;
10292                 ncx->blk_loop.next_op   = cx->blk_loop.next_op;
10293                 ncx->blk_loop.last_op   = cx->blk_loop.last_op;
10294                 ncx->blk_loop.iterdata  = (CxPADLOOP(cx)
10295                                            ? cx->blk_loop.iterdata
10296                                            : gv_dup((GV*)cx->blk_loop.iterdata, param));
10297                 ncx->blk_loop.oldcomppad
10298                     = (PAD*)ptr_table_fetch(PL_ptr_table,
10299                                             cx->blk_loop.oldcomppad);
10300                 ncx->blk_loop.itersave  = sv_dup_inc(cx->blk_loop.itersave, param);
10301                 ncx->blk_loop.iterlval  = sv_dup_inc(cx->blk_loop.iterlval, param);
10302                 ncx->blk_loop.iterary   = av_dup_inc(cx->blk_loop.iterary, param);
10303                 ncx->blk_loop.iterix    = cx->blk_loop.iterix;
10304                 ncx->blk_loop.itermax   = cx->blk_loop.itermax;
10305                 break;
10306             case CXt_FORMAT:
10307                 ncx->blk_sub.cv         = cv_dup(cx->blk_sub.cv, param);
10308                 ncx->blk_sub.gv         = gv_dup(cx->blk_sub.gv, param);
10309                 ncx->blk_sub.dfoutgv    = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10310                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
10311                 break;
10312             case CXt_BLOCK:
10313             case CXt_NULL:
10314                 break;
10315             }
10316         }
10317         --ix;
10318     }
10319     return ncxs;
10320 }
10321
10322 /* duplicate a stack info structure */
10323
10324 PERL_SI *
10325 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10326 {
10327     PERL_SI *nsi;
10328
10329     if (!si)
10330         return (PERL_SI*)NULL;
10331
10332     /* look for it in the table first */
10333     nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10334     if (nsi)
10335         return nsi;
10336
10337     /* create anew and remember what it is */
10338     Newz(56, nsi, 1, PERL_SI);
10339     ptr_table_store(PL_ptr_table, si, nsi);
10340
10341     nsi->si_stack       = av_dup_inc(si->si_stack, param);
10342     nsi->si_cxix        = si->si_cxix;
10343     nsi->si_cxmax       = si->si_cxmax;
10344     nsi->si_cxstack     = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10345     nsi->si_type        = si->si_type;
10346     nsi->si_prev        = si_dup(si->si_prev, param);
10347     nsi->si_next        = si_dup(si->si_next, param);
10348     nsi->si_markoff     = si->si_markoff;
10349
10350     return nsi;
10351 }
10352
10353 #define POPINT(ss,ix)   ((ss)[--(ix)].any_i32)
10354 #define TOPINT(ss,ix)   ((ss)[ix].any_i32)
10355 #define POPLONG(ss,ix)  ((ss)[--(ix)].any_long)
10356 #define TOPLONG(ss,ix)  ((ss)[ix].any_long)
10357 #define POPIV(ss,ix)    ((ss)[--(ix)].any_iv)
10358 #define TOPIV(ss,ix)    ((ss)[ix].any_iv)
10359 #define POPBOOL(ss,ix)  ((ss)[--(ix)].any_bool)
10360 #define TOPBOOL(ss,ix)  ((ss)[ix].any_bool)
10361 #define POPPTR(ss,ix)   ((ss)[--(ix)].any_ptr)
10362 #define TOPPTR(ss,ix)   ((ss)[ix].any_ptr)
10363 #define POPDPTR(ss,ix)  ((ss)[--(ix)].any_dptr)
10364 #define TOPDPTR(ss,ix)  ((ss)[ix].any_dptr)
10365 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10366 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10367
10368 /* XXXXX todo */
10369 #define pv_dup_inc(p)   SAVEPV(p)
10370 #define pv_dup(p)       SAVEPV(p)
10371 #define svp_dup_inc(p,pp)       any_dup(p,pp)
10372
10373 /* map any object to the new equivent - either something in the
10374  * ptr table, or something in the interpreter structure
10375  */
10376
10377 void *
10378 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10379 {
10380     void *ret;
10381
10382     if (!v)
10383         return (void*)NULL;
10384
10385     /* look for it in the table first */
10386     ret = ptr_table_fetch(PL_ptr_table, v);
10387     if (ret)
10388         return ret;
10389
10390     /* see if it is part of the interpreter structure */
10391     if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10392         ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10393     else {
10394         ret = v;
10395     }
10396
10397     return ret;
10398 }
10399
10400 /* duplicate the save stack */
10401
10402 ANY *
10403 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10404 {
10405     ANY *ss     = proto_perl->Tsavestack;
10406     I32 ix      = proto_perl->Tsavestack_ix;
10407     I32 max     = proto_perl->Tsavestack_max;
10408     ANY *nss;
10409     SV *sv;
10410     GV *gv;
10411     AV *av;
10412     HV *hv;
10413     void* ptr;
10414     int intval;
10415     long longval;
10416     GP *gp;
10417     IV iv;
10418     I32 i;
10419     char *c = NULL;
10420     void (*dptr) (void*);
10421     void (*dxptr) (pTHX_ void*);
10422     OP *o;
10423
10424     Newz(54, nss, max, ANY);
10425
10426     while (ix > 0) {
10427         i = POPINT(ss,ix);
10428         TOPINT(nss,ix) = i;
10429         switch (i) {
10430         case SAVEt_ITEM:                        /* normal string */
10431             sv = (SV*)POPPTR(ss,ix);
10432             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10433             sv = (SV*)POPPTR(ss,ix);
10434             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10435             break;
10436         case SAVEt_SV:                          /* scalar reference */
10437             sv = (SV*)POPPTR(ss,ix);
10438             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10439             gv = (GV*)POPPTR(ss,ix);
10440             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10441             break;
10442         case SAVEt_GENERIC_PVREF:               /* generic char* */
10443             c = (char*)POPPTR(ss,ix);
10444             TOPPTR(nss,ix) = pv_dup(c);
10445             ptr = POPPTR(ss,ix);
10446             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10447             break;
10448         case SAVEt_SHARED_PVREF:                /* char* in shared space */
10449             c = (char*)POPPTR(ss,ix);
10450             TOPPTR(nss,ix) = savesharedpv(c);
10451             ptr = POPPTR(ss,ix);
10452             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10453             break;
10454         case SAVEt_GENERIC_SVREF:               /* generic sv */
10455         case SAVEt_SVREF:                       /* scalar reference */
10456             sv = (SV*)POPPTR(ss,ix);
10457             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10458             ptr = POPPTR(ss,ix);
10459             TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10460             break;
10461         case SAVEt_AV:                          /* array reference */
10462             av = (AV*)POPPTR(ss,ix);
10463             TOPPTR(nss,ix) = av_dup_inc(av, param);
10464             gv = (GV*)POPPTR(ss,ix);
10465             TOPPTR(nss,ix) = gv_dup(gv, param);
10466             break;
10467         case SAVEt_HV:                          /* hash reference */
10468             hv = (HV*)POPPTR(ss,ix);
10469             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10470             gv = (GV*)POPPTR(ss,ix);
10471             TOPPTR(nss,ix) = gv_dup(gv, param);
10472             break;
10473         case SAVEt_INT:                         /* int reference */
10474             ptr = POPPTR(ss,ix);
10475             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10476             intval = (int)POPINT(ss,ix);
10477             TOPINT(nss,ix) = intval;
10478             break;
10479         case SAVEt_LONG:                        /* long reference */
10480             ptr = POPPTR(ss,ix);
10481             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10482             longval = (long)POPLONG(ss,ix);
10483             TOPLONG(nss,ix) = longval;
10484             break;
10485         case SAVEt_I32:                         /* I32 reference */
10486         case SAVEt_I16:                         /* I16 reference */
10487         case SAVEt_I8:                          /* I8 reference */
10488             ptr = POPPTR(ss,ix);
10489             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10490             i = POPINT(ss,ix);
10491             TOPINT(nss,ix) = i;
10492             break;
10493         case SAVEt_IV:                          /* IV reference */
10494             ptr = POPPTR(ss,ix);
10495             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10496             iv = POPIV(ss,ix);
10497             TOPIV(nss,ix) = iv;
10498             break;
10499         case SAVEt_SPTR:                        /* SV* reference */
10500             ptr = POPPTR(ss,ix);
10501             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10502             sv = (SV*)POPPTR(ss,ix);
10503             TOPPTR(nss,ix) = sv_dup(sv, param);
10504             break;
10505         case SAVEt_VPTR:                        /* random* reference */
10506             ptr = POPPTR(ss,ix);
10507             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10508             ptr = POPPTR(ss,ix);
10509             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10510             break;
10511         case SAVEt_PPTR:                        /* char* reference */
10512             ptr = POPPTR(ss,ix);
10513             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10514             c = (char*)POPPTR(ss,ix);
10515             TOPPTR(nss,ix) = pv_dup(c);
10516             break;
10517         case SAVEt_HPTR:                        /* HV* reference */
10518             ptr = POPPTR(ss,ix);
10519             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10520             hv = (HV*)POPPTR(ss,ix);
10521             TOPPTR(nss,ix) = hv_dup(hv, param);
10522             break;
10523         case SAVEt_APTR:                        /* AV* reference */
10524             ptr = POPPTR(ss,ix);
10525             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10526             av = (AV*)POPPTR(ss,ix);
10527             TOPPTR(nss,ix) = av_dup(av, param);
10528             break;
10529         case SAVEt_NSTAB:
10530             gv = (GV*)POPPTR(ss,ix);
10531             TOPPTR(nss,ix) = gv_dup(gv, param);
10532             break;
10533         case SAVEt_GP:                          /* scalar reference */
10534             gp = (GP*)POPPTR(ss,ix);
10535             TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10536             (void)GpREFCNT_inc(gp);
10537             gv = (GV*)POPPTR(ss,ix);
10538             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10539             c = (char*)POPPTR(ss,ix);
10540             TOPPTR(nss,ix) = pv_dup(c);
10541             iv = POPIV(ss,ix);
10542             TOPIV(nss,ix) = iv;
10543             iv = POPIV(ss,ix);
10544             TOPIV(nss,ix) = iv;
10545             break;
10546         case SAVEt_FREESV:
10547         case SAVEt_MORTALIZESV:
10548             sv = (SV*)POPPTR(ss,ix);
10549             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10550             break;
10551         case SAVEt_FREEOP:
10552             ptr = POPPTR(ss,ix);
10553             if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10554                 /* these are assumed to be refcounted properly */
10555                 switch (((OP*)ptr)->op_type) {
10556                 case OP_LEAVESUB:
10557                 case OP_LEAVESUBLV:
10558                 case OP_LEAVEEVAL:
10559                 case OP_LEAVE:
10560                 case OP_SCOPE:
10561                 case OP_LEAVEWRITE:
10562                     TOPPTR(nss,ix) = ptr;
10563                     o = (OP*)ptr;
10564                     OpREFCNT_inc(o);
10565                     break;
10566                 default:
10567                     TOPPTR(nss,ix) = Nullop;
10568                     break;
10569                 }
10570             }
10571             else
10572                 TOPPTR(nss,ix) = Nullop;
10573             break;
10574         case SAVEt_FREEPV:
10575             c = (char*)POPPTR(ss,ix);
10576             TOPPTR(nss,ix) = pv_dup_inc(c);
10577             break;
10578         case SAVEt_CLEARSV:
10579             longval = POPLONG(ss,ix);
10580             TOPLONG(nss,ix) = longval;
10581             break;
10582         case SAVEt_DELETE:
10583             hv = (HV*)POPPTR(ss,ix);
10584             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10585             c = (char*)POPPTR(ss,ix);
10586             TOPPTR(nss,ix) = pv_dup_inc(c);
10587             i = POPINT(ss,ix);
10588             TOPINT(nss,ix) = i;
10589             break;
10590         case SAVEt_DESTRUCTOR:
10591             ptr = POPPTR(ss,ix);
10592             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
10593             dptr = POPDPTR(ss,ix);
10594             TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
10595             break;
10596         case SAVEt_DESTRUCTOR_X:
10597             ptr = POPPTR(ss,ix);
10598             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
10599             dxptr = POPDXPTR(ss,ix);
10600             TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
10601             break;
10602         case SAVEt_REGCONTEXT:
10603         case SAVEt_ALLOC:
10604             i = POPINT(ss,ix);
10605             TOPINT(nss,ix) = i;
10606             ix -= i;
10607             break;
10608         case SAVEt_STACK_POS:           /* Position on Perl stack */
10609             i = POPINT(ss,ix);
10610             TOPINT(nss,ix) = i;
10611             break;
10612         case SAVEt_AELEM:               /* array element */
10613             sv = (SV*)POPPTR(ss,ix);
10614             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10615             i = POPINT(ss,ix);
10616             TOPINT(nss,ix) = i;
10617             av = (AV*)POPPTR(ss,ix);
10618             TOPPTR(nss,ix) = av_dup_inc(av, param);
10619             break;
10620         case SAVEt_HELEM:               /* hash element */
10621             sv = (SV*)POPPTR(ss,ix);
10622             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10623             sv = (SV*)POPPTR(ss,ix);
10624             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10625             hv = (HV*)POPPTR(ss,ix);
10626             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10627             break;
10628         case SAVEt_OP:
10629             ptr = POPPTR(ss,ix);
10630             TOPPTR(nss,ix) = ptr;
10631             break;
10632         case SAVEt_HINTS:
10633             i = POPINT(ss,ix);
10634             TOPINT(nss,ix) = i;
10635             break;
10636         case SAVEt_COMPPAD:
10637             av = (AV*)POPPTR(ss,ix);
10638             TOPPTR(nss,ix) = av_dup(av, param);
10639             break;
10640         case SAVEt_PADSV:
10641             longval = (long)POPLONG(ss,ix);
10642             TOPLONG(nss,ix) = longval;
10643             ptr = POPPTR(ss,ix);
10644             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10645             sv = (SV*)POPPTR(ss,ix);
10646             TOPPTR(nss,ix) = sv_dup(sv, param);
10647             break;
10648         case SAVEt_BOOL:
10649             ptr = POPPTR(ss,ix);
10650             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10651             longval = (long)POPBOOL(ss,ix);
10652             TOPBOOL(nss,ix) = (bool)longval;
10653             break;
10654         default:
10655             Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10656         }
10657     }
10658
10659     return nss;
10660 }
10661
10662 /*
10663 =for apidoc perl_clone
10664
10665 Create and return a new interpreter by cloning the current one.
10666
10667 perl_clone takes these flags as paramters:
10668
10669 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10670 without it we only clone the data and zero the stacks,
10671 with it we copy the stacks and the new perl interpreter is
10672 ready to run at the exact same point as the previous one.
10673 The pseudo-fork code uses COPY_STACKS while the
10674 threads->new doesn't.
10675
10676 CLONEf_KEEP_PTR_TABLE
10677 perl_clone keeps a ptr_table with the pointer of the old
10678 variable as a key and the new variable as a value,
10679 this allows it to check if something has been cloned and not
10680 clone it again but rather just use the value and increase the
10681 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10682 the ptr_table using the function
10683 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10684 reason to keep it around is if you want to dup some of your own
10685 variable who are outside the graph perl scans, example of this
10686 code is in threads.xs create
10687
10688 CLONEf_CLONE_HOST
10689 This is a win32 thing, it is ignored on unix, it tells perls
10690 win32host code (which is c++) to clone itself, this is needed on
10691 win32 if you want to run two threads at the same time,
10692 if you just want to do some stuff in a separate perl interpreter
10693 and then throw it away and return to the original one,
10694 you don't need to do anything.
10695
10696 =cut
10697 */
10698
10699 /* XXX the above needs expanding by someone who actually understands it ! */
10700 EXTERN_C PerlInterpreter *
10701 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10702
10703 PerlInterpreter *
10704 perl_clone(PerlInterpreter *proto_perl, UV flags)
10705 {
10706 #ifdef PERL_IMPLICIT_SYS
10707
10708    /* perlhost.h so we need to call into it
10709    to clone the host, CPerlHost should have a c interface, sky */
10710
10711    if (flags & CLONEf_CLONE_HOST) {
10712        return perl_clone_host(proto_perl,flags);
10713    }
10714    return perl_clone_using(proto_perl, flags,
10715                             proto_perl->IMem,
10716                             proto_perl->IMemShared,
10717                             proto_perl->IMemParse,
10718                             proto_perl->IEnv,
10719                             proto_perl->IStdIO,
10720                             proto_perl->ILIO,
10721                             proto_perl->IDir,
10722                             proto_perl->ISock,
10723                             proto_perl->IProc);
10724 }
10725
10726 PerlInterpreter *
10727 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10728                  struct IPerlMem* ipM, struct IPerlMem* ipMS,
10729                  struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10730                  struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10731                  struct IPerlDir* ipD, struct IPerlSock* ipS,
10732                  struct IPerlProc* ipP)
10733 {
10734     /* XXX many of the string copies here can be optimized if they're
10735      * constants; they need to be allocated as common memory and just
10736      * their pointers copied. */
10737
10738     IV i;
10739     CLONE_PARAMS clone_params;
10740     CLONE_PARAMS* param = &clone_params;
10741
10742     PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10743     PERL_SET_THX(my_perl);
10744
10745 #  ifdef DEBUGGING
10746     Poison(my_perl, 1, PerlInterpreter);
10747     PL_markstack = 0;
10748     PL_scopestack = 0;
10749     PL_savestack = 0;
10750     PL_retstack = 0;
10751     PL_sig_pending = 0;
10752     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10753 #  else /* !DEBUGGING */
10754     Zero(my_perl, 1, PerlInterpreter);
10755 #  endif        /* DEBUGGING */
10756
10757     /* host pointers */
10758     PL_Mem              = ipM;
10759     PL_MemShared        = ipMS;
10760     PL_MemParse         = ipMP;
10761     PL_Env              = ipE;
10762     PL_StdIO            = ipStd;
10763     PL_LIO              = ipLIO;
10764     PL_Dir              = ipD;
10765     PL_Sock             = ipS;
10766     PL_Proc             = ipP;
10767 #else           /* !PERL_IMPLICIT_SYS */
10768     IV i;
10769     CLONE_PARAMS clone_params;
10770     CLONE_PARAMS* param = &clone_params;
10771     PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10772     PERL_SET_THX(my_perl);
10773
10774
10775
10776 #    ifdef DEBUGGING
10777     Poison(my_perl, 1, PerlInterpreter);
10778     PL_markstack = 0;
10779     PL_scopestack = 0;
10780     PL_savestack = 0;
10781     PL_retstack = 0;
10782     PL_sig_pending = 0;
10783     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10784 #    else       /* !DEBUGGING */
10785     Zero(my_perl, 1, PerlInterpreter);
10786 #    endif      /* DEBUGGING */
10787 #endif          /* PERL_IMPLICIT_SYS */
10788     param->flags = flags;
10789     param->proto_perl = proto_perl;
10790
10791     /* arena roots */
10792     PL_xiv_arenaroot    = NULL;
10793     PL_xiv_root         = NULL;
10794     PL_xnv_arenaroot    = NULL;
10795     PL_xnv_root         = NULL;
10796     PL_xrv_arenaroot    = NULL;
10797     PL_xrv_root         = NULL;
10798     PL_xpv_arenaroot    = NULL;
10799     PL_xpv_root         = NULL;
10800     PL_xpviv_arenaroot  = NULL;
10801     PL_xpviv_root       = NULL;
10802     PL_xpvnv_arenaroot  = NULL;
10803     PL_xpvnv_root       = NULL;
10804     PL_xpvcv_arenaroot  = NULL;
10805     PL_xpvcv_root       = NULL;
10806     PL_xpvav_arenaroot  = NULL;
10807     PL_xpvav_root       = NULL;
10808     PL_xpvhv_arenaroot  = NULL;
10809     PL_xpvhv_root       = NULL;
10810     PL_xpvmg_arenaroot  = NULL;
10811     PL_xpvmg_root       = NULL;
10812     PL_xpvlv_arenaroot  = NULL;
10813     PL_xpvlv_root       = NULL;
10814     PL_xpvbm_arenaroot  = NULL;
10815     PL_xpvbm_root       = NULL;
10816     PL_he_arenaroot     = NULL;
10817     PL_he_root          = NULL;
10818     PL_nice_chunk       = NULL;
10819     PL_nice_chunk_size  = 0;
10820     PL_sv_count         = 0;
10821     PL_sv_objcount      = 0;
10822     PL_sv_root          = Nullsv;
10823     PL_sv_arenaroot     = Nullsv;
10824
10825     PL_debug            = proto_perl->Idebug;
10826
10827 #ifdef USE_REENTRANT_API
10828     Perl_reentrant_init(aTHX);
10829 #endif
10830
10831     /* create SV map for pointer relocation */
10832     PL_ptr_table = ptr_table_new();
10833
10834     /* initialize these special pointers as early as possible */
10835     SvANY(&PL_sv_undef)         = NULL;
10836     SvREFCNT(&PL_sv_undef)      = (~(U32)0)/2;
10837     SvFLAGS(&PL_sv_undef)       = SVf_READONLY|SVt_NULL;
10838     ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10839
10840     SvANY(&PL_sv_no)            = new_XPVNV();
10841     SvREFCNT(&PL_sv_no)         = (~(U32)0)/2;
10842     SvFLAGS(&PL_sv_no)          = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10843     SvPVX(&PL_sv_no)            = SAVEPVN(PL_No, 0);
10844     SvCUR(&PL_sv_no)            = 0;
10845     SvLEN(&PL_sv_no)            = 1;
10846     SvNVX(&PL_sv_no)            = 0;
10847     ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10848
10849     SvANY(&PL_sv_yes)           = new_XPVNV();
10850     SvREFCNT(&PL_sv_yes)        = (~(U32)0)/2;
10851     SvFLAGS(&PL_sv_yes)         = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10852     SvPVX(&PL_sv_yes)           = SAVEPVN(PL_Yes, 1);
10853     SvCUR(&PL_sv_yes)           = 1;
10854     SvLEN(&PL_sv_yes)           = 2;
10855     SvNVX(&PL_sv_yes)           = 1;
10856     ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10857
10858     /* create (a non-shared!) shared string table */
10859     PL_strtab           = newHV();
10860     HvSHAREKEYS_off(PL_strtab);
10861     hv_ksplit(PL_strtab, 512);
10862     ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10863
10864     PL_compiling = proto_perl->Icompiling;
10865
10866     /* These two PVs will be free'd special way so must set them same way op.c does */
10867     PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10868     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10869
10870     PL_compiling.cop_file    = savesharedpv(PL_compiling.cop_file);
10871     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10872
10873     ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10874     if (!specialWARN(PL_compiling.cop_warnings))
10875         PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10876     if (!specialCopIO(PL_compiling.cop_io))
10877         PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10878     PL_curcop           = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10879
10880     /* pseudo environmental stuff */
10881     PL_origargc         = proto_perl->Iorigargc;
10882     PL_origargv         = proto_perl->Iorigargv;
10883
10884     param->stashes      = newAV();  /* Setup array of objects to call clone on */
10885
10886 #ifdef PERLIO_LAYERS
10887     /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10888     PerlIO_clone(aTHX_ proto_perl, param);
10889 #endif
10890
10891     PL_envgv            = gv_dup(proto_perl->Ienvgv, param);
10892     PL_incgv            = gv_dup(proto_perl->Iincgv, param);
10893     PL_hintgv           = gv_dup(proto_perl->Ihintgv, param);
10894     PL_origfilename     = SAVEPV(proto_perl->Iorigfilename);
10895     PL_diehook          = sv_dup_inc(proto_perl->Idiehook, param);
10896     PL_warnhook         = sv_dup_inc(proto_perl->Iwarnhook, param);
10897
10898     /* switches */
10899     PL_minus_c          = proto_perl->Iminus_c;
10900     PL_patchlevel       = sv_dup_inc(proto_perl->Ipatchlevel, param);
10901     PL_localpatches     = proto_perl->Ilocalpatches;
10902     PL_splitstr         = proto_perl->Isplitstr;
10903     PL_preprocess       = proto_perl->Ipreprocess;
10904     PL_minus_n          = proto_perl->Iminus_n;
10905     PL_minus_p          = proto_perl->Iminus_p;
10906     PL_minus_l          = proto_perl->Iminus_l;
10907     PL_minus_a          = proto_perl->Iminus_a;
10908     PL_minus_F          = proto_perl->Iminus_F;
10909     PL_doswitches       = proto_perl->Idoswitches;
10910     PL_dowarn           = proto_perl->Idowarn;
10911     PL_doextract        = proto_perl->Idoextract;
10912     PL_sawampersand     = proto_perl->Isawampersand;
10913     PL_unsafe           = proto_perl->Iunsafe;
10914     PL_inplace          = SAVEPV(proto_perl->Iinplace);
10915     PL_e_script         = sv_dup_inc(proto_perl->Ie_script, param);
10916     PL_perldb           = proto_perl->Iperldb;
10917     PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10918     PL_exit_flags       = proto_perl->Iexit_flags;
10919
10920     /* magical thingies */
10921     /* XXX time(&PL_basetime) when asked for? */
10922     PL_basetime         = proto_perl->Ibasetime;
10923     PL_formfeed         = sv_dup(proto_perl->Iformfeed, param);
10924
10925     PL_maxsysfd         = proto_perl->Imaxsysfd;
10926     PL_multiline        = proto_perl->Imultiline;
10927     PL_statusvalue      = proto_perl->Istatusvalue;
10928 #ifdef VMS
10929     PL_statusvalue_vms  = proto_perl->Istatusvalue_vms;
10930 #endif
10931     PL_encoding         = sv_dup(proto_perl->Iencoding, param);
10932
10933     sv_setpvn(PERL_DEBUG_PAD(0), "", 0);        /* For regex debugging. */
10934     sv_setpvn(PERL_DEBUG_PAD(1), "", 0);        /* ext/re needs these */
10935     sv_setpvn(PERL_DEBUG_PAD(2), "", 0);        /* even without DEBUGGING. */
10936
10937     /* Clone the regex array */
10938     PL_regex_padav = newAV();
10939     {
10940         I32 len = av_len((AV*)proto_perl->Iregex_padav);
10941         SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10942         av_push(PL_regex_padav,
10943                 sv_dup_inc(regexen[0],param));
10944         for(i = 1; i <= len; i++) {
10945             if(SvREPADTMP(regexen[i])) {
10946               av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10947             } else {
10948                 av_push(PL_regex_padav,
10949                     SvREFCNT_inc(
10950                         newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10951                              SvIVX(regexen[i])), param)))
10952                        ));
10953             }
10954         }
10955     }
10956     PL_regex_pad = AvARRAY(PL_regex_padav);
10957
10958     /* shortcuts to various I/O objects */
10959     PL_stdingv          = gv_dup(proto_perl->Istdingv, param);
10960     PL_stderrgv         = gv_dup(proto_perl->Istderrgv, param);
10961     PL_defgv            = gv_dup(proto_perl->Idefgv, param);
10962     PL_argvgv           = gv_dup(proto_perl->Iargvgv, param);
10963     PL_argvoutgv        = gv_dup(proto_perl->Iargvoutgv, param);
10964     PL_argvout_stack    = av_dup_inc(proto_perl->Iargvout_stack, param);
10965
10966     /* shortcuts to regexp stuff */
10967     PL_replgv           = gv_dup(proto_perl->Ireplgv, param);
10968
10969     /* shortcuts to misc objects */
10970     PL_errgv            = gv_dup(proto_perl->Ierrgv, param);
10971
10972     /* shortcuts to debugging objects */
10973     PL_DBgv             = gv_dup(proto_perl->IDBgv, param);
10974     PL_DBline           = gv_dup(proto_perl->IDBline, param);
10975     PL_DBsub            = gv_dup(proto_perl->IDBsub, param);
10976     PL_DBsingle         = sv_dup(proto_perl->IDBsingle, param);
10977     PL_DBtrace          = sv_dup(proto_perl->IDBtrace, param);
10978     PL_DBsignal         = sv_dup(proto_perl->IDBsignal, param);
10979     PL_DBassertion      = sv_dup(proto_perl->IDBassertion, param);
10980     PL_lineary          = av_dup(proto_perl->Ilineary, param);
10981     PL_dbargs           = av_dup(proto_perl->Idbargs, param);
10982
10983     /* symbol tables */
10984     PL_defstash         = hv_dup_inc(proto_perl->Tdefstash, param);
10985     PL_curstash         = hv_dup(proto_perl->Tcurstash, param);
10986     PL_debstash         = hv_dup(proto_perl->Idebstash, param);
10987     PL_globalstash      = hv_dup(proto_perl->Iglobalstash, param);
10988     PL_curstname        = sv_dup_inc(proto_perl->Icurstname, param);
10989
10990     PL_beginav          = av_dup_inc(proto_perl->Ibeginav, param);
10991     PL_beginav_save     = av_dup_inc(proto_perl->Ibeginav_save, param);
10992     PL_checkav_save     = av_dup_inc(proto_perl->Icheckav_save, param);
10993     PL_endav            = av_dup_inc(proto_perl->Iendav, param);
10994     PL_checkav          = av_dup_inc(proto_perl->Icheckav, param);
10995     PL_initav           = av_dup_inc(proto_perl->Iinitav, param);
10996
10997     PL_sub_generation   = proto_perl->Isub_generation;
10998
10999     /* funky return mechanisms */
11000     PL_forkprocess      = proto_perl->Iforkprocess;
11001
11002     /* subprocess state */
11003     PL_fdpid            = av_dup_inc(proto_perl->Ifdpid, param);
11004
11005     /* internal state */
11006     PL_tainting         = proto_perl->Itainting;
11007     PL_taint_warn       = proto_perl->Itaint_warn;
11008     PL_maxo             = proto_perl->Imaxo;
11009     if (proto_perl->Iop_mask)
11010         PL_op_mask      = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11011     else
11012         PL_op_mask      = Nullch;
11013     /* PL_asserting        = proto_perl->Iasserting; */
11014
11015     /* current interpreter roots */
11016     PL_main_cv          = cv_dup_inc(proto_perl->Imain_cv, param);
11017     PL_main_root        = OpREFCNT_inc(proto_perl->Imain_root);
11018     PL_main_start       = proto_perl->Imain_start;
11019     PL_eval_root        = proto_perl->Ieval_root;
11020     PL_eval_start       = proto_perl->Ieval_start;
11021
11022     /* runtime control stuff */
11023     PL_curcopdb         = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11024     PL_copline          = proto_perl->Icopline;
11025
11026     PL_filemode         = proto_perl->Ifilemode;
11027     PL_lastfd           = proto_perl->Ilastfd;
11028     PL_oldname          = proto_perl->Ioldname;         /* XXX not quite right */
11029     PL_Argv             = NULL;
11030     PL_Cmd              = Nullch;
11031     PL_gensym           = proto_perl->Igensym;
11032     PL_preambled        = proto_perl->Ipreambled;
11033     PL_preambleav       = av_dup_inc(proto_perl->Ipreambleav, param);
11034     PL_laststatval      = proto_perl->Ilaststatval;
11035     PL_laststype        = proto_perl->Ilaststype;
11036     PL_mess_sv          = Nullsv;
11037
11038     PL_ors_sv           = sv_dup_inc(proto_perl->Iors_sv, param);
11039     PL_ofmt             = SAVEPV(proto_perl->Iofmt);
11040
11041     /* interpreter atexit processing */
11042     PL_exitlistlen      = proto_perl->Iexitlistlen;
11043     if (PL_exitlistlen) {
11044         New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11045         Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11046     }
11047     else
11048         PL_exitlist     = (PerlExitListEntry*)NULL;
11049     PL_modglobal        = hv_dup_inc(proto_perl->Imodglobal, param);
11050     PL_custom_op_names  = hv_dup_inc(proto_perl->Icustom_op_names,param);
11051     PL_custom_op_descs  = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11052
11053     PL_profiledata      = NULL;
11054     PL_rsfp             = fp_dup(proto_perl->Irsfp, '<', param);
11055     /* PL_rsfp_filters entries have fake IoDIRP() */
11056     PL_rsfp_filters     = av_dup_inc(proto_perl->Irsfp_filters, param);
11057
11058     PL_compcv                   = cv_dup(proto_perl->Icompcv, param);
11059
11060     PAD_CLONE_VARS(proto_perl, param);
11061
11062 #ifdef HAVE_INTERP_INTERN
11063     sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11064 #endif
11065
11066     /* more statics moved here */
11067     PL_generation       = proto_perl->Igeneration;
11068     PL_DBcv             = cv_dup(proto_perl->IDBcv, param);
11069
11070     PL_in_clean_objs    = proto_perl->Iin_clean_objs;
11071     PL_in_clean_all     = proto_perl->Iin_clean_all;
11072
11073     PL_uid              = proto_perl->Iuid;
11074     PL_euid             = proto_perl->Ieuid;
11075     PL_gid              = proto_perl->Igid;
11076     PL_egid             = proto_perl->Iegid;
11077     PL_nomemok          = proto_perl->Inomemok;
11078     PL_an               = proto_perl->Ian;
11079     PL_op_seqmax        = proto_perl->Iop_seqmax;
11080     PL_evalseq          = proto_perl->Ievalseq;
11081     PL_origenviron      = proto_perl->Iorigenviron;     /* XXX not quite right */
11082     PL_origalen         = proto_perl->Iorigalen;
11083     PL_pidstatus        = newHV();                      /* XXX flag for cloning? */
11084     PL_osname           = SAVEPV(proto_perl->Iosname);
11085     PL_sh_path_compat   = proto_perl->Ish_path_compat; /* XXX never deallocated */
11086     PL_sighandlerp      = proto_perl->Isighandlerp;
11087
11088
11089     PL_runops           = proto_perl->Irunops;
11090
11091     Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11092
11093 #ifdef CSH
11094     PL_cshlen           = proto_perl->Icshlen;
11095     PL_cshname          = proto_perl->Icshname; /* XXX never deallocated */
11096 #endif
11097
11098     PL_lex_state        = proto_perl->Ilex_state;
11099     PL_lex_defer        = proto_perl->Ilex_defer;
11100     PL_lex_expect       = proto_perl->Ilex_expect;
11101     PL_lex_formbrack    = proto_perl->Ilex_formbrack;
11102     PL_lex_dojoin       = proto_perl->Ilex_dojoin;
11103     PL_lex_starts       = proto_perl->Ilex_starts;
11104     PL_lex_stuff        = sv_dup_inc(proto_perl->Ilex_stuff, param);
11105     PL_lex_repl         = sv_dup_inc(proto_perl->Ilex_repl, param);
11106     PL_lex_op           = proto_perl->Ilex_op;
11107     PL_lex_inpat        = proto_perl->Ilex_inpat;
11108     PL_lex_inwhat       = proto_perl->Ilex_inwhat;
11109     PL_lex_brackets     = proto_perl->Ilex_brackets;
11110     i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11111     PL_lex_brackstack   = SAVEPVN(proto_perl->Ilex_brackstack,i);
11112     PL_lex_casemods     = proto_perl->Ilex_casemods;
11113     i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11114     PL_lex_casestack    = SAVEPVN(proto_perl->Ilex_casestack,i);
11115
11116     Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11117     Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11118     PL_nexttoke         = proto_perl->Inexttoke;
11119
11120     /* XXX This is probably masking the deeper issue of why
11121      * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11122      * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11123      * (A little debugging with a watchpoint on it may help.)
11124      */
11125     if (SvANY(proto_perl->Ilinestr)) {
11126         PL_linestr              = sv_dup_inc(proto_perl->Ilinestr, param);
11127         i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11128         PL_bufptr               = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11129         i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11130         PL_oldbufptr    = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11131         i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11132         PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11133         i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11134         PL_linestart    = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11135     }
11136     else {
11137         PL_linestr = NEWSV(65,79);
11138         sv_upgrade(PL_linestr,SVt_PVIV);
11139         sv_setpvn(PL_linestr,"",0);
11140         PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11141     }
11142     PL_bufend           = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11143     PL_pending_ident    = proto_perl->Ipending_ident;
11144     PL_sublex_info      = proto_perl->Isublex_info;     /* XXX not quite right */
11145
11146     PL_expect           = proto_perl->Iexpect;
11147
11148     PL_multi_start      = proto_perl->Imulti_start;
11149     PL_multi_end        = proto_perl->Imulti_end;
11150     PL_multi_open       = proto_perl->Imulti_open;
11151     PL_multi_close      = proto_perl->Imulti_close;
11152
11153     PL_error_count      = proto_perl->Ierror_count;
11154     PL_subline          = proto_perl->Isubline;
11155     PL_subname          = sv_dup_inc(proto_perl->Isubname, param);
11156
11157     /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11158     if (SvANY(proto_perl->Ilinestr)) {
11159         i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11160         PL_last_uni             = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11161         i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11162         PL_last_lop             = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11163         PL_last_lop_op  = proto_perl->Ilast_lop_op;
11164     }
11165     else {
11166         PL_last_uni     = SvPVX(PL_linestr);
11167         PL_last_lop     = SvPVX(PL_linestr);
11168         PL_last_lop_op  = 0;
11169     }
11170     PL_in_my            = proto_perl->Iin_my;
11171     PL_in_my_stash      = hv_dup(proto_perl->Iin_my_stash, param);
11172 #ifdef FCRYPT
11173     PL_cryptseen        = proto_perl->Icryptseen;
11174 #endif
11175
11176     PL_hints            = proto_perl->Ihints;
11177
11178     PL_amagic_generation        = proto_perl->Iamagic_generation;
11179
11180 #ifdef USE_LOCALE_COLLATE
11181     PL_collation_ix     = proto_perl->Icollation_ix;
11182     PL_collation_name   = SAVEPV(proto_perl->Icollation_name);
11183     PL_collation_standard       = proto_perl->Icollation_standard;
11184     PL_collxfrm_base    = proto_perl->Icollxfrm_base;
11185     PL_collxfrm_mult    = proto_perl->Icollxfrm_mult;
11186 #endif /* USE_LOCALE_COLLATE */
11187
11188 #ifdef USE_LOCALE_NUMERIC
11189     PL_numeric_name     = SAVEPV(proto_perl->Inumeric_name);
11190     PL_numeric_standard = proto_perl->Inumeric_standard;
11191     PL_numeric_local    = proto_perl->Inumeric_local;
11192     PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11193 #endif /* !USE_LOCALE_NUMERIC */
11194
11195     /* utf8 character classes */
11196     PL_utf8_alnum       = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11197     PL_utf8_alnumc      = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11198     PL_utf8_ascii       = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11199     PL_utf8_alpha       = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11200     PL_utf8_space       = sv_dup_inc(proto_perl->Iutf8_space, param);
11201     PL_utf8_cntrl       = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11202     PL_utf8_graph       = sv_dup_inc(proto_perl->Iutf8_graph, param);
11203     PL_utf8_digit       = sv_dup_inc(proto_perl->Iutf8_digit, param);
11204     PL_utf8_upper       = sv_dup_inc(proto_perl->Iutf8_upper, param);
11205     PL_utf8_lower       = sv_dup_inc(proto_perl->Iutf8_lower, param);
11206     PL_utf8_print       = sv_dup_inc(proto_perl->Iutf8_print, param);
11207     PL_utf8_punct       = sv_dup_inc(proto_perl->Iutf8_punct, param);
11208     PL_utf8_xdigit      = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11209     PL_utf8_mark        = sv_dup_inc(proto_perl->Iutf8_mark, param);
11210     PL_utf8_toupper     = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11211     PL_utf8_totitle     = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11212     PL_utf8_tolower     = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11213     PL_utf8_tofold      = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11214     PL_utf8_idstart     = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11215     PL_utf8_idcont      = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11216
11217     /* Did the locale setup indicate UTF-8? */
11218     PL_utf8locale       = proto_perl->Iutf8locale;
11219     /* Unicode features (see perlrun/-C) */
11220     PL_unicode          = proto_perl->Iunicode;
11221
11222     /* Pre-5.8 signals control */
11223     PL_signals          = proto_perl->Isignals;
11224
11225     /* times() ticks per second */
11226     PL_clocktick        = proto_perl->Iclocktick;
11227
11228     /* Recursion stopper for PerlIO_find_layer */
11229     PL_in_load_module   = proto_perl->Iin_load_module;
11230
11231     /* sort() routine */
11232     PL_sort_RealCmp     = proto_perl->Isort_RealCmp;
11233
11234     /* Not really needed/useful since the reenrant_retint is "volatile",
11235      * but do it for consistency's sake. */
11236     PL_reentrant_retint = proto_perl->Ireentrant_retint;
11237
11238     /* Hooks to shared SVs and locks. */
11239     PL_sharehook        = proto_perl->Isharehook;
11240     PL_lockhook         = proto_perl->Ilockhook;
11241     PL_unlockhook       = proto_perl->Iunlockhook;
11242     PL_threadhook       = proto_perl->Ithreadhook;
11243
11244     PL_runops_std       = proto_perl->Irunops_std;
11245     PL_runops_dbg       = proto_perl->Irunops_dbg;
11246
11247 #ifdef THREADS_HAVE_PIDS
11248     PL_ppid             = proto_perl->Ippid;
11249 #endif
11250
11251     /* swatch cache */
11252     PL_last_swash_hv    = Nullhv;       /* reinits on demand */
11253     PL_last_swash_klen  = 0;
11254     PL_last_swash_key[0]= '\0';
11255     PL_last_swash_tmps  = (U8*)NULL;
11256     PL_last_swash_slen  = 0;
11257
11258     /* perly.c globals */
11259     PL_yydebug          = proto_perl->Iyydebug;
11260     PL_yynerrs          = proto_perl->Iyynerrs;
11261     PL_yyerrflag        = proto_perl->Iyyerrflag;
11262     PL_yychar           = proto_perl->Iyychar;
11263     PL_yyval            = proto_perl->Iyyval;
11264     PL_yylval           = proto_perl->Iyylval;
11265
11266     PL_glob_index       = proto_perl->Iglob_index;
11267     PL_srand_called     = proto_perl->Isrand_called;
11268     PL_uudmap['M']      = 0;            /* reinits on demand */
11269     PL_bitcount         = Nullch;       /* reinits on demand */
11270
11271     if (proto_perl->Ipsig_pend) {
11272         Newz(0, PL_psig_pend, SIG_SIZE, int);
11273     }
11274     else {
11275         PL_psig_pend    = (int*)NULL;
11276     }
11277
11278     if (proto_perl->Ipsig_ptr) {
11279         Newz(0, PL_psig_ptr,  SIG_SIZE, SV*);
11280         Newz(0, PL_psig_name, SIG_SIZE, SV*);
11281         for (i = 1; i < SIG_SIZE; i++) {
11282             PL_psig_ptr[i]  = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11283             PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11284         }
11285     }
11286     else {
11287         PL_psig_ptr     = (SV**)NULL;
11288         PL_psig_name    = (SV**)NULL;
11289     }
11290
11291     /* thrdvar.h stuff */
11292
11293     if (flags & CLONEf_COPY_STACKS) {
11294         /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11295         PL_tmps_ix              = proto_perl->Ttmps_ix;
11296         PL_tmps_max             = proto_perl->Ttmps_max;
11297         PL_tmps_floor           = proto_perl->Ttmps_floor;
11298         Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
11299         i = 0;
11300         while (i <= PL_tmps_ix) {
11301             PL_tmps_stack[i]    = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11302             ++i;
11303         }
11304
11305         /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11306         i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11307         Newz(54, PL_markstack, i, I32);
11308         PL_markstack_max        = PL_markstack + (proto_perl->Tmarkstack_max
11309                                                   - proto_perl->Tmarkstack);
11310         PL_markstack_ptr        = PL_markstack + (proto_perl->Tmarkstack_ptr
11311                                                   - proto_perl->Tmarkstack);
11312         Copy(proto_perl->Tmarkstack, PL_markstack,
11313              PL_markstack_ptr - PL_markstack + 1, I32);
11314
11315         /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11316          * NOTE: unlike the others! */
11317         PL_scopestack_ix        = proto_perl->Tscopestack_ix;
11318         PL_scopestack_max       = proto_perl->Tscopestack_max;
11319         Newz(54, PL_scopestack, PL_scopestack_max, I32);
11320         Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11321
11322         /* next push_return() sets PL_retstack[PL_retstack_ix]
11323          * NOTE: unlike the others! */
11324         PL_retstack_ix          = proto_perl->Tretstack_ix;
11325         PL_retstack_max         = proto_perl->Tretstack_max;
11326         Newz(54, PL_retstack, PL_retstack_max, OP*);
11327         Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
11328
11329         /* NOTE: si_dup() looks at PL_markstack */
11330         PL_curstackinfo         = si_dup(proto_perl->Tcurstackinfo, param);
11331
11332         /* PL_curstack          = PL_curstackinfo->si_stack; */
11333         PL_curstack             = av_dup(proto_perl->Tcurstack, param);
11334         PL_mainstack            = av_dup(proto_perl->Tmainstack, param);
11335
11336         /* next PUSHs() etc. set *(PL_stack_sp+1) */
11337         PL_stack_base           = AvARRAY(PL_curstack);
11338         PL_stack_sp             = PL_stack_base + (proto_perl->Tstack_sp
11339                                                    - proto_perl->Tstack_base);
11340         PL_stack_max            = PL_stack_base + AvMAX(PL_curstack);
11341
11342         /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11343          * NOTE: unlike the others! */
11344         PL_savestack_ix         = proto_perl->Tsavestack_ix;
11345         PL_savestack_max        = proto_perl->Tsavestack_max;
11346         /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11347         PL_savestack            = ss_dup(proto_perl, param);
11348     }
11349     else {
11350         init_stacks();
11351         ENTER;                  /* perl_destruct() wants to LEAVE; */
11352     }
11353
11354     PL_start_env        = proto_perl->Tstart_env;       /* XXXXXX */
11355     PL_top_env          = &PL_start_env;
11356
11357     PL_op               = proto_perl->Top;
11358
11359     PL_Sv               = Nullsv;
11360     PL_Xpv              = (XPV*)NULL;
11361     PL_na               = proto_perl->Tna;
11362
11363     PL_statbuf          = proto_perl->Tstatbuf;
11364     PL_statcache        = proto_perl->Tstatcache;
11365     PL_statgv           = gv_dup(proto_perl->Tstatgv, param);
11366     PL_statname         = sv_dup_inc(proto_perl->Tstatname, param);
11367 #ifdef HAS_TIMES
11368     PL_timesbuf         = proto_perl->Ttimesbuf;
11369 #endif
11370
11371     PL_tainted          = proto_perl->Ttainted;
11372     PL_curpm            = proto_perl->Tcurpm;   /* XXX No PMOP ref count */
11373     PL_rs               = sv_dup_inc(proto_perl->Trs, param);
11374     PL_last_in_gv       = gv_dup(proto_perl->Tlast_in_gv, param);
11375     PL_ofs_sv           = sv_dup_inc(proto_perl->Tofs_sv, param);
11376     PL_defoutgv         = gv_dup_inc(proto_perl->Tdefoutgv, param);
11377     PL_chopset          = proto_perl->Tchopset; /* XXX never deallocated */
11378     PL_toptarget        = sv_dup_inc(proto_perl->Ttoptarget, param);
11379     PL_bodytarget       = sv_dup_inc(proto_perl->Tbodytarget, param);
11380     PL_formtarget       = sv_dup(proto_perl->Tformtarget, param);
11381
11382     PL_restartop        = proto_perl->Trestartop;
11383     PL_in_eval          = proto_perl->Tin_eval;
11384     PL_delaymagic       = proto_perl->Tdelaymagic;
11385     PL_dirty            = proto_perl->Tdirty;
11386     PL_localizing       = proto_perl->Tlocalizing;
11387
11388 #ifdef PERL_FLEXIBLE_EXCEPTIONS
11389     PL_protect          = proto_perl->Tprotect;
11390 #endif
11391     PL_errors           = sv_dup_inc(proto_perl->Terrors, param);
11392     PL_hv_fetch_ent_mh  = Nullhe;
11393     PL_modcount         = proto_perl->Tmodcount;
11394     PL_lastgotoprobe    = Nullop;
11395     PL_dumpindent       = proto_perl->Tdumpindent;
11396
11397     PL_sortcop          = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11398     PL_sortstash        = hv_dup(proto_perl->Tsortstash, param);
11399     PL_firstgv          = gv_dup(proto_perl->Tfirstgv, param);
11400     PL_secondgv         = gv_dup(proto_perl->Tsecondgv, param);
11401     PL_sortcxix         = proto_perl->Tsortcxix;
11402     PL_efloatbuf        = Nullch;               /* reinits on demand */
11403     PL_efloatsize       = 0;                    /* reinits on demand */
11404
11405     /* regex stuff */
11406
11407     PL_screamfirst      = NULL;
11408     PL_screamnext       = NULL;
11409     PL_maxscream        = -1;                   /* reinits on demand */
11410     PL_lastscream       = Nullsv;
11411
11412     PL_watchaddr        = NULL;
11413     PL_watchok          = Nullch;
11414
11415     PL_regdummy         = proto_perl->Tregdummy;
11416     PL_regprecomp       = Nullch;
11417     PL_regnpar          = 0;
11418     PL_regsize          = 0;
11419     PL_colorset         = 0;            /* reinits PL_colors[] */
11420     /*PL_colors[6]      = {0,0,0,0,0,0};*/
11421     PL_reginput         = Nullch;
11422     PL_regbol           = Nullch;
11423     PL_regeol           = Nullch;
11424     PL_regstartp        = (I32*)NULL;
11425     PL_regendp          = (I32*)NULL;
11426     PL_reglastparen     = (U32*)NULL;
11427     PL_regtill          = Nullch;
11428     PL_reg_start_tmp    = (char**)NULL;
11429     PL_reg_start_tmpl   = 0;
11430     PL_regdata          = (struct reg_data*)NULL;
11431     PL_bostr            = Nullch;
11432     PL_reg_flags        = 0;
11433     PL_reg_eval_set     = 0;
11434     PL_regnarrate       = 0;
11435     PL_regprogram       = (regnode*)NULL;
11436     PL_regindent        = 0;
11437     PL_regcc            = (CURCUR*)NULL;
11438     PL_reg_call_cc      = (struct re_cc_state*)NULL;
11439     PL_reg_re           = (regexp*)NULL;
11440     PL_reg_ganch        = Nullch;
11441     PL_reg_sv           = Nullsv;
11442     PL_reg_match_utf8   = FALSE;
11443     PL_reg_magic        = (MAGIC*)NULL;
11444     PL_reg_oldpos       = 0;
11445     PL_reg_oldcurpm     = (PMOP*)NULL;
11446     PL_reg_curpm        = (PMOP*)NULL;
11447     PL_reg_oldsaved     = Nullch;
11448     PL_reg_oldsavedlen  = 0;
11449 #ifdef PERL_COPY_ON_WRITE
11450     PL_nrs              = Nullsv;
11451 #endif
11452     PL_reg_maxiter      = 0;
11453     PL_reg_leftiter     = 0;
11454     PL_reg_poscache     = Nullch;
11455     PL_reg_poscache_size= 0;
11456
11457     /* RE engine - function pointers */
11458     PL_regcompp         = proto_perl->Tregcompp;
11459     PL_regexecp         = proto_perl->Tregexecp;
11460     PL_regint_start     = proto_perl->Tregint_start;
11461     PL_regint_string    = proto_perl->Tregint_string;
11462     PL_regfree          = proto_perl->Tregfree;
11463
11464     PL_reginterp_cnt    = 0;
11465     PL_reg_starttry     = 0;
11466
11467     /* Pluggable optimizer */
11468     PL_peepp            = proto_perl->Tpeepp;
11469
11470     PL_stashcache       = newHV();
11471
11472     if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11473         ptr_table_free(PL_ptr_table);
11474         PL_ptr_table = NULL;
11475     }
11476
11477     /* Call the ->CLONE method, if it exists, for each of the stashes
11478        identified by sv_dup() above.
11479     */
11480     while(av_len(param->stashes) != -1) {
11481         HV* stash = (HV*) av_shift(param->stashes);
11482         GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11483         if (cloner && GvCV(cloner)) {
11484             dSP;
11485             ENTER;
11486             SAVETMPS;
11487             PUSHMARK(SP);
11488            XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
11489             PUTBACK;
11490             call_sv((SV*)GvCV(cloner), G_DISCARD);
11491             FREETMPS;
11492             LEAVE;
11493         }
11494     }
11495
11496     SvREFCNT_dec(param->stashes);
11497
11498     return my_perl;
11499 }
11500
11501 #endif /* USE_ITHREADS */
11502
11503 /*
11504 =head1 Unicode Support
11505
11506 =for apidoc sv_recode_to_utf8
11507
11508 The encoding is assumed to be an Encode object, on entry the PV
11509 of the sv is assumed to be octets in that encoding, and the sv
11510 will be converted into Unicode (and UTF-8).
11511
11512 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11513 is not a reference, nothing is done to the sv.  If the encoding is not
11514 an C<Encode::XS> Encoding object, bad things will happen.
11515 (See F<lib/encoding.pm> and L<Encode>).
11516
11517 The PV of the sv is returned.
11518
11519 =cut */
11520
11521 char *
11522 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11523 {
11524     if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11525         SV *uni;
11526         STRLEN len;
11527         char *s;
11528         dSP;
11529         ENTER;
11530         SAVETMPS;
11531         save_re_context();
11532         PUSHMARK(sp);
11533         EXTEND(SP, 3);
11534         XPUSHs(encoding);
11535         XPUSHs(sv);
11536 /*
11537   NI-S 2002/07/09
11538   Passing sv_yes is wrong - it needs to be or'ed set of constants
11539   for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11540   remove converted chars from source.
11541
11542   Both will default the value - let them.
11543
11544         XPUSHs(&PL_sv_yes);
11545 */
11546         PUTBACK;
11547         call_method("decode", G_SCALAR);
11548         SPAGAIN;
11549         uni = POPs;
11550         PUTBACK;
11551         s = SvPV(uni, len);
11552         if (s != SvPVX(sv)) {
11553             SvGROW(sv, len + 1);
11554             Move(s, SvPVX(sv), len, char);
11555             SvCUR_set(sv, len);
11556             SvPVX(sv)[len] = 0;
11557         }
11558         FREETMPS;
11559         LEAVE;
11560         SvUTF8_on(sv);
11561     }
11562     return SvPVX(sv);
11563 }
11564
11565 /*
11566 =for apidoc sv_cat_decode
11567
11568 The encoding is assumed to be an Encode object, the PV of the ssv is
11569 assumed to be octets in that encoding and decoding the input starts
11570 from the position which (PV + *offset) pointed to.  The dsv will be
11571 concatenated the decoded UTF-8 string from ssv.  Decoding will terminate
11572 when the string tstr appears in decoding output or the input ends on
11573 the PV of the ssv. The value which the offset points will be modified
11574 to the last input position on the ssv.
11575
11576 Returns TRUE if the terminator was found, else returns FALSE.
11577
11578 =cut */
11579
11580 bool
11581 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11582                    SV *ssv, int *offset, char *tstr, int tlen)
11583 {
11584     bool ret = FALSE;
11585     if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11586         SV *offsv;
11587         dSP;
11588         ENTER;
11589         SAVETMPS;
11590         save_re_context();
11591         PUSHMARK(sp);
11592         EXTEND(SP, 6);
11593         XPUSHs(encoding);
11594         XPUSHs(dsv);
11595         XPUSHs(ssv);
11596         XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11597         XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11598         PUTBACK;
11599         call_method("cat_decode", G_SCALAR);
11600         SPAGAIN;
11601         ret = SvTRUE(TOPs);
11602         *offset = SvIV(offsv);
11603         PUTBACK;
11604         FREETMPS;
11605         LEAVE;
11606     }
11607     else
11608         Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11609     return ret;
11610 }
11611