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