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