sv.c

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