sv.c

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