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