sv.c

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