sv.c

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