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