sv.c

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