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