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