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