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