sv.c

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