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 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 *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 = 0;
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 = 0;
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 = 0;
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         break;
5144     default:
5145         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5146     }
5147
5148     /* Rest of work is done else where */
5149     mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5150
5151     switch (how) {
5152     case PERL_MAGIC_taint:
5153         mg->mg_len = 1;
5154         break;
5155     case PERL_MAGIC_ext:
5156     case PERL_MAGIC_dbfile:
5157         SvRMAGICAL_on(sv);
5158         break;
5159     }
5160 }
5161
5162 /*
5163 =for apidoc sv_unmagic
5164
5165 Removes all magic of type C<type> from an SV.
5166
5167 =cut
5168 */
5169
5170 int
5171 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5172 {
5173     MAGIC* mg;
5174     MAGIC** mgp;
5175     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5176         return 0;
5177     mgp = &SvMAGIC(sv);
5178     for (mg = *mgp; mg; mg = *mgp) {
5179         if (mg->mg_type == type) {
5180             const MGVTBL* const vtbl = mg->mg_virtual;
5181             *mgp = mg->mg_moremagic;
5182             if (vtbl && vtbl->svt_free)
5183                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5184             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5185                 if (mg->mg_len > 0)
5186                     Safefree(mg->mg_ptr);
5187                 else if (mg->mg_len == HEf_SVKEY)
5188                     SvREFCNT_dec((SV*)mg->mg_ptr);
5189                 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5190                     Safefree(mg->mg_ptr);
5191             }
5192             if (mg->mg_flags & MGf_REFCOUNTED)
5193                 SvREFCNT_dec(mg->mg_obj);
5194             Safefree(mg);
5195         }
5196         else
5197             mgp = &mg->mg_moremagic;
5198     }
5199     if (!SvMAGIC(sv)) {
5200         SvMAGICAL_off(sv);
5201        SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5202     }
5203
5204     return 0;
5205 }
5206
5207 /*
5208 =for apidoc sv_rvweaken
5209
5210 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5211 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5212 push a back-reference to this RV onto the array of backreferences
5213 associated with that magic.
5214
5215 =cut
5216 */
5217
5218 SV *
5219 Perl_sv_rvweaken(pTHX_ SV *sv)
5220 {
5221     SV *tsv;
5222     if (!SvOK(sv))  /* let undefs pass */
5223         return sv;
5224     if (!SvROK(sv))
5225         Perl_croak(aTHX_ "Can't weaken a nonreference");
5226     else if (SvWEAKREF(sv)) {
5227         if (ckWARN(WARN_MISC))
5228             Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5229         return sv;
5230     }
5231     tsv = SvRV(sv);
5232     Perl_sv_add_backref(aTHX_ tsv, sv);
5233     SvWEAKREF_on(sv);
5234     SvREFCNT_dec(tsv);
5235     return sv;
5236 }
5237
5238 /* Give tsv backref magic if it hasn't already got it, then push a
5239  * back-reference to sv onto the array associated with the backref magic.
5240  */
5241
5242 void
5243 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5244 {
5245     AV *av;
5246     MAGIC *mg;
5247     if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5248         av = (AV*)mg->mg_obj;
5249     else {
5250         av = newAV();
5251         sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5252         /* av now has a refcnt of 2, which avoids it getting freed
5253          * before us during global cleanup. The extra ref is removed
5254          * by magic_killbackrefs() when tsv is being freed */
5255     }
5256     if (AvFILLp(av) >= AvMAX(av)) {
5257         av_extend(av, AvFILLp(av)+1);
5258     }
5259     AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5260 }
5261
5262 /* delete a back-reference to ourselves from the backref magic associated
5263  * with the SV we point to.
5264  */
5265
5266 STATIC void
5267 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
5268 {
5269     AV *av;
5270     SV **svp;
5271     I32 i;
5272     MAGIC *mg = NULL;
5273     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
5274         if (PL_in_clean_all)
5275             return;
5276     }
5277     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5278         Perl_croak(aTHX_ "panic: del_backref");
5279     av = (AV *)mg->mg_obj;
5280     svp = AvARRAY(av);
5281     /* We shouldn't be in here more than once, but for paranoia reasons lets
5282        not assume this.  */
5283     for (i = AvFILLp(av); i >= 0; i--) {
5284         if (svp[i] == sv) {
5285             const SSize_t fill = AvFILLp(av);
5286             if (i != fill) {
5287                 /* We weren't the last entry.
5288                    An unordered list has this property that you can take the
5289                    last element off the end to fill the hole, and it's still
5290                    an unordered list :-)
5291                 */
5292                 svp[i] = svp[fill];
5293             }
5294             svp[fill] = Nullsv;
5295             AvFILLp(av) = fill - 1;
5296         }
5297     }
5298 }
5299
5300 /*
5301 =for apidoc sv_insert
5302
5303 Inserts a string at the specified offset/length within the SV. Similar to
5304 the Perl substr() function.
5305
5306 =cut
5307 */
5308
5309 void
5310 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5311 {
5312     register char *big;
5313     register char *mid;
5314     register char *midend;
5315     register char *bigend;
5316     register I32 i;
5317     STRLEN curlen;
5318
5319
5320     if (!bigstr)
5321         Perl_croak(aTHX_ "Can't modify non-existent substring");
5322     SvPV_force(bigstr, curlen);
5323     (void)SvPOK_only_UTF8(bigstr);
5324     if (offset + len > curlen) {
5325         SvGROW(bigstr, offset+len+1);
5326         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5327         SvCUR_set(bigstr, offset+len);
5328     }
5329
5330     SvTAINT(bigstr);
5331     i = littlelen - len;
5332     if (i > 0) {                        /* string might grow */
5333         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5334         mid = big + offset + len;
5335         midend = bigend = big + SvCUR(bigstr);
5336         bigend += i;
5337         *bigend = '\0';
5338         while (midend > mid)            /* shove everything down */
5339             *--bigend = *--midend;
5340         Move(little,big+offset,littlelen,char);
5341         SvCUR_set(bigstr, SvCUR(bigstr) + i);
5342         SvSETMAGIC(bigstr);
5343         return;
5344     }
5345     else if (i == 0) {
5346         Move(little,SvPVX(bigstr)+offset,len,char);
5347         SvSETMAGIC(bigstr);
5348         return;
5349     }
5350
5351     big = SvPVX(bigstr);
5352     mid = big + offset;
5353     midend = mid + len;
5354     bigend = big + SvCUR(bigstr);
5355
5356     if (midend > bigend)
5357         Perl_croak(aTHX_ "panic: sv_insert");
5358
5359     if (mid - big > bigend - midend) {  /* faster to shorten from end */
5360         if (littlelen) {
5361             Move(little, mid, littlelen,char);
5362             mid += littlelen;
5363         }
5364         i = bigend - midend;
5365         if (i > 0) {
5366             Move(midend, mid, i,char);
5367             mid += i;
5368         }
5369         *mid = '\0';
5370         SvCUR_set(bigstr, mid - big);
5371     }
5372     else if ((i = mid - big)) { /* faster from front */
5373         midend -= littlelen;
5374         mid = midend;
5375         sv_chop(bigstr,midend-i);
5376         big += i;
5377         while (i--)
5378             *--midend = *--big;
5379         if (littlelen)
5380             Move(little, mid, littlelen,char);
5381     }
5382     else if (littlelen) {
5383         midend -= littlelen;
5384         sv_chop(bigstr,midend);
5385         Move(little,midend,littlelen,char);
5386     }
5387     else {
5388         sv_chop(bigstr,midend);
5389     }
5390     SvSETMAGIC(bigstr);
5391 }
5392
5393 /*
5394 =for apidoc sv_replace
5395
5396 Make the first argument a copy of the second, then delete the original.
5397 The target SV physically takes over ownership of the body of the source SV
5398 and inherits its flags; however, the target keeps any magic it owns,
5399 and any magic in the source is discarded.
5400 Note that this is a rather specialist SV copying operation; most of the
5401 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5402
5403 =cut
5404 */
5405
5406 void
5407 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5408 {
5409     const U32 refcnt = SvREFCNT(sv);
5410     SV_CHECK_THINKFIRST_COW_DROP(sv);
5411     if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5412         Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5413     if (SvMAGICAL(sv)) {
5414         if (SvMAGICAL(nsv))
5415             mg_free(nsv);
5416         else
5417             sv_upgrade(nsv, SVt_PVMG);
5418         SvMAGIC_set(nsv, SvMAGIC(sv));
5419         SvFLAGS(nsv) |= SvMAGICAL(sv);
5420         SvMAGICAL_off(sv);
5421         SvMAGIC_set(sv, NULL);
5422     }
5423     SvREFCNT(sv) = 0;
5424     sv_clear(sv);
5425     assert(!SvREFCNT(sv));
5426 #ifdef DEBUG_LEAKING_SCALARS
5427     sv->sv_flags  = nsv->sv_flags;
5428     sv->sv_any    = nsv->sv_any;
5429     sv->sv_refcnt = nsv->sv_refcnt;
5430     sv->sv_u      = nsv->sv_u;
5431 #else
5432     StructCopy(nsv,sv,SV);
5433 #endif
5434     /* Currently could join these into one piece of pointer arithmetic, but
5435        it would be unclear.  */
5436     if(SvTYPE(sv) == SVt_IV)
5437         SvANY(sv)
5438             = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5439     else if (SvTYPE(sv) == SVt_RV) {
5440         SvANY(sv) = &sv->sv_u.svu_rv;
5441     }
5442
5443
5444 #ifdef PERL_OLD_COPY_ON_WRITE
5445     if (SvIsCOW_normal(nsv)) {
5446         /* We need to follow the pointers around the loop to make the
5447            previous SV point to sv, rather than nsv.  */
5448         SV *next;
5449         SV *current = nsv;
5450         while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5451             assert(next);
5452             current = next;
5453             assert(SvPVX_const(current) == SvPVX_const(nsv));
5454         }
5455         /* Make the SV before us point to the SV after us.  */
5456         if (DEBUG_C_TEST) {
5457             PerlIO_printf(Perl_debug_log, "previous is\n");
5458             sv_dump(current);
5459             PerlIO_printf(Perl_debug_log,
5460                           "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5461                           (UV) SV_COW_NEXT_SV(current), (UV) sv);
5462         }
5463         SV_COW_NEXT_SV_SET(current, sv);
5464     }
5465 #endif
5466     SvREFCNT(sv) = refcnt;
5467     SvFLAGS(nsv) |= SVTYPEMASK;         /* Mark as freed */
5468     SvREFCNT(nsv) = 0;
5469     del_SV(nsv);
5470 }
5471
5472 /*
5473 =for apidoc sv_clear
5474
5475 Clear an SV: call any destructors, free up any memory used by the body,
5476 and free the body itself. The SV's head is I<not> freed, although
5477 its type is set to all 1's so that it won't inadvertently be assumed
5478 to be live during global destruction etc.
5479 This function should only be called when REFCNT is zero. Most of the time
5480 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5481 instead.
5482
5483 =cut
5484 */
5485
5486 void
5487 Perl_sv_clear(pTHX_ register SV *sv)
5488 {
5489     dVAR;
5490     void** old_body_arena;
5491     size_t old_body_offset;
5492     const U32 type = SvTYPE(sv);
5493
5494     assert(sv);
5495     assert(SvREFCNT(sv) == 0);
5496
5497     if (type <= SVt_IV)
5498         return;
5499
5500     old_body_arena = 0;
5501     old_body_offset = 0;
5502
5503     if (SvOBJECT(sv)) {
5504         if (PL_defstash) {              /* Still have a symbol table? */
5505             dSP;
5506             HV* stash;
5507             do {
5508                 CV* destructor;
5509                 stash = SvSTASH(sv);
5510                 destructor = StashHANDLER(stash,DESTROY);
5511                 if (destructor) {
5512                     SV* const tmpref = newRV(sv);
5513                     SvREADONLY_on(tmpref);   /* DESTROY() could be naughty */
5514                     ENTER;
5515                     PUSHSTACKi(PERLSI_DESTROY);
5516                     EXTEND(SP, 2);
5517                     PUSHMARK(SP);
5518                     PUSHs(tmpref);
5519                     PUTBACK;
5520                     call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5521
5522
5523                     POPSTACK;
5524                     SPAGAIN;
5525                     LEAVE;
5526                     if(SvREFCNT(tmpref) < 2) {
5527                         /* tmpref is not kept alive! */
5528                         SvREFCNT(sv)--;
5529                         SvRV_set(tmpref, NULL);
5530                         SvROK_off(tmpref);
5531                     }
5532                     SvREFCNT_dec(tmpref);
5533                 }
5534             } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5535
5536
5537             if (SvREFCNT(sv)) {
5538                 if (PL_in_clean_objs)
5539                     Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5540                           HvNAME_get(stash));
5541                 /* DESTROY gave object new lease on life */
5542                 return;
5543             }
5544         }
5545
5546         if (SvOBJECT(sv)) {
5547             SvREFCNT_dec(SvSTASH(sv));  /* possibly of changed persuasion */
5548             SvOBJECT_off(sv);   /* Curse the object. */
5549             if (type != SVt_PVIO)
5550                 --PL_sv_objcount;       /* XXX Might want something more general */
5551         }
5552     }
5553     if (type >= SVt_PVMG) {
5554         if (SvMAGIC(sv))
5555             mg_free(sv);
5556         if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5557             SvREFCNT_dec(SvSTASH(sv));
5558     }
5559     switch (type) {
5560     case SVt_PVIO:
5561         if (IoIFP(sv) &&
5562             IoIFP(sv) != PerlIO_stdin() &&
5563             IoIFP(sv) != PerlIO_stdout() &&
5564             IoIFP(sv) != PerlIO_stderr())
5565         {
5566             io_close((IO*)sv, FALSE);
5567         }
5568         if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5569             PerlDir_close(IoDIRP(sv));
5570         IoDIRP(sv) = (DIR*)NULL;
5571         Safefree(IoTOP_NAME(sv));
5572         Safefree(IoFMT_NAME(sv));
5573         Safefree(IoBOTTOM_NAME(sv));
5574         /* PVIOs aren't from arenas  */
5575         goto freescalar;
5576     case SVt_PVBM:
5577         old_body_arena = (void **) &PL_xpvbm_root;
5578         goto freescalar;
5579     case SVt_PVCV:
5580         old_body_arena = (void **) &PL_xpvcv_root;
5581     case SVt_PVFM:
5582         /* PVFMs aren't from arenas  */
5583         cv_undef((CV*)sv);
5584         goto freescalar;
5585     case SVt_PVHV:
5586         hv_undef((HV*)sv);
5587         old_body_arena = (void **) &PL_xpvhv_root;
5588         old_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill);
5589         break;
5590     case SVt_PVAV:
5591         av_undef((AV*)sv);
5592         old_body_arena = (void **) &PL_xpvav_root;
5593         old_body_offset = STRUCT_OFFSET(XPVAV, xav_fill);
5594         break;
5595     case SVt_PVLV:
5596         if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5597             SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5598             HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5599             PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5600         }
5601         else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV**  */
5602             SvREFCNT_dec(LvTARG(sv));
5603         old_body_arena = (void **) &PL_xpvlv_root;
5604         goto freescalar;
5605     case SVt_PVGV:
5606         gp_free((GV*)sv);
5607         Safefree(GvNAME(sv));
5608         /* If we're in a stash, we don't own a reference to it. However it does
5609            have a back reference to us, which needs to be cleared.  */
5610         if (GvSTASH(sv))
5611             sv_del_backref((SV*)GvSTASH(sv), sv);
5612         old_body_arena = (void **) &PL_xpvgv_root;
5613         goto freescalar;
5614     case SVt_PVMG:
5615         old_body_arena = (void **) &PL_xpvmg_root;
5616         goto freescalar;
5617     case SVt_PVNV:
5618         old_body_arena = (void **) &PL_xpvnv_root;
5619         goto freescalar;
5620     case SVt_PVIV:
5621         old_body_arena = (void **) &PL_xpviv_root;
5622         old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur);
5623       freescalar:
5624         /* Don't bother with SvOOK_off(sv); as we're only going to free it.  */
5625         if (SvOOK(sv)) {
5626             SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5627             /* Don't even bother with turning off the OOK flag.  */
5628         }
5629         goto pvrv_common;
5630     case SVt_PV:
5631         old_body_arena = (void **) &PL_xpv_root;
5632         old_body_offset = STRUCT_OFFSET(XPV, xpv_cur);
5633     case SVt_RV:
5634     pvrv_common:
5635         if (SvROK(sv)) {
5636             SV *target = SvRV(sv);
5637             if (SvWEAKREF(sv))
5638                 sv_del_backref(target, sv);
5639             else
5640                 SvREFCNT_dec(target);
5641         }
5642 #ifdef PERL_OLD_COPY_ON_WRITE
5643         else if (SvPVX_const(sv)) {
5644             if (SvIsCOW(sv)) {
5645                 /* I believe I need to grab the global SV mutex here and
5646                    then recheck the COW status.  */
5647                 if (DEBUG_C_TEST) {
5648                     PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5649                     sv_dump(sv);
5650                 }
5651                 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5652                                SV_COW_NEXT_SV(sv));
5653                 /* And drop it here.  */
5654                 SvFAKE_off(sv);
5655             } else if (SvLEN(sv)) {
5656                 Safefree(SvPVX_const(sv));
5657             }
5658         }
5659 #else
5660         else if (SvPVX_const(sv) && SvLEN(sv))
5661             Safefree(SvPVX_mutable(sv));
5662         else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5663             unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5664             SvFAKE_off(sv);
5665         }
5666 #endif
5667         break;
5668     case SVt_NV:
5669         old_body_arena = (void **) &PL_xnv_root;
5670         break;
5671     }
5672
5673     SvFLAGS(sv) &= SVf_BREAK;
5674     SvFLAGS(sv) |= SVTYPEMASK;
5675
5676 #ifndef PURIFY
5677     if (old_body_arena) {
5678         del_body(((char *)SvANY(sv) + old_body_offset), old_body_arena);
5679     }
5680     else
5681 #endif
5682         if (type > SVt_RV) {
5683             my_safefree(SvANY(sv));
5684         }
5685 }
5686
5687 /*
5688 =for apidoc sv_newref
5689
5690 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5691 instead.
5692
5693 =cut
5694 */
5695
5696 SV *
5697 Perl_sv_newref(pTHX_ SV *sv)
5698 {
5699     if (sv)
5700         (SvREFCNT(sv))++;
5701     return sv;
5702 }
5703
5704 /*
5705 =for apidoc sv_free
5706
5707 Decrement an SV's reference count, and if it drops to zero, call
5708 C<sv_clear> to invoke destructors and free up any memory used by
5709 the body; finally, deallocate the SV's head itself.
5710 Normally called via a wrapper macro C<SvREFCNT_dec>.
5711
5712 =cut
5713 */
5714
5715 void
5716 Perl_sv_free(pTHX_ SV *sv)
5717 {
5718     dVAR;
5719     if (!sv)
5720         return;
5721     if (SvREFCNT(sv) == 0) {
5722         if (SvFLAGS(sv) & SVf_BREAK)
5723             /* this SV's refcnt has been artificially decremented to
5724              * trigger cleanup */
5725             return;
5726         if (PL_in_clean_all) /* All is fair */
5727             return;
5728         if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5729             /* make sure SvREFCNT(sv)==0 happens very seldom */
5730             SvREFCNT(sv) = (~(U32)0)/2;
5731             return;
5732         }
5733         if (ckWARN_d(WARN_INTERNAL)) {
5734             Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5735                         "Attempt to free unreferenced scalar: SV 0x%"UVxf
5736                         pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5737 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5738             Perl_dump_sv_child(aTHX_ sv);
5739 #endif
5740         }
5741         return;
5742     }
5743     if (--(SvREFCNT(sv)) > 0)
5744         return;
5745     Perl_sv_free2(aTHX_ sv);
5746 }
5747
5748 void
5749 Perl_sv_free2(pTHX_ SV *sv)
5750 {
5751     dVAR;
5752 #ifdef DEBUGGING
5753     if (SvTEMP(sv)) {
5754         if (ckWARN_d(WARN_DEBUGGING))
5755             Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5756                         "Attempt to free temp prematurely: SV 0x%"UVxf
5757                         pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5758         return;
5759     }
5760 #endif
5761     if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5762         /* make sure SvREFCNT(sv)==0 happens very seldom */
5763         SvREFCNT(sv) = (~(U32)0)/2;
5764         return;
5765     }
5766     sv_clear(sv);
5767     if (! SvREFCNT(sv))
5768         del_SV(sv);
5769 }
5770
5771 /*
5772 =for apidoc sv_len
5773
5774 Returns the length of the string in the SV. Handles magic and type
5775 coercion.  See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5776
5777 =cut
5778 */
5779
5780 STRLEN
5781 Perl_sv_len(pTHX_ register SV *sv)
5782 {
5783     STRLEN len;
5784
5785     if (!sv)
5786         return 0;
5787
5788     if (SvGMAGICAL(sv))
5789         len = mg_length(sv);
5790     else
5791         (void)SvPV_const(sv, len);
5792     return len;
5793 }
5794
5795 /*
5796 =for apidoc sv_len_utf8
5797
5798 Returns the number of characters in the string in an SV, counting wide
5799 UTF-8 bytes as a single character. Handles magic and type coercion.
5800
5801 =cut
5802 */
5803
5804 /*
5805  * The length is cached in PERL_UTF8_magic, in the mg_len field.  Also the
5806  * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5807  * (Note that the mg_len is not the length of the mg_ptr field.)
5808  *
5809  */
5810
5811 STRLEN
5812 Perl_sv_len_utf8(pTHX_ register SV *sv)
5813 {
5814     if (!sv)
5815         return 0;
5816
5817     if (SvGMAGICAL(sv))
5818         return mg_length(sv);
5819     else
5820     {
5821         STRLEN len, ulen;
5822         const U8 *s = (U8*)SvPV_const(sv, len);
5823         MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5824
5825         if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5826             ulen = mg->mg_len;
5827 #ifdef PERL_UTF8_CACHE_ASSERT
5828             assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5829 #endif
5830         }
5831         else {
5832             ulen = Perl_utf8_length(aTHX_ s, s + len);
5833             if (!mg && !SvREADONLY(sv)) {
5834                 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5835                 mg = mg_find(sv, PERL_MAGIC_utf8);
5836                 assert(mg);
5837             }
5838             if (mg)
5839                 mg->mg_len = ulen;
5840         }
5841         return ulen;
5842     }
5843 }
5844
5845 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5846  * a PERL_UTF8_magic.  The mg_ptr is used to store the mapping
5847  * between UTF-8 and byte offsets.  There are two (substr offset and substr
5848  * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5849  * and byte offset) cache positions.
5850  *
5851  * The mg_len field is used by sv_len_utf8(), see its comments.
5852  * Note that the mg_len is not the length of the mg_ptr field.
5853  *
5854  */
5855 STATIC bool
5856 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5857                    I32 offsetp, const U8 *s, const U8 *start)
5858 {
5859     bool found = FALSE;
5860
5861     if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5862         if (!*mgp)
5863             *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5864         assert(*mgp);
5865
5866         if ((*mgp)->mg_ptr)
5867             *cachep = (STRLEN *) (*mgp)->mg_ptr;
5868         else {
5869             Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5870             (*mgp)->mg_ptr = (char *) *cachep;
5871         }
5872         assert(*cachep);
5873
5874         (*cachep)[i]   = offsetp;
5875         (*cachep)[i+1] = s - start;
5876         found = TRUE;
5877     }
5878
5879     return found;
5880 }
5881
5882 /*
5883  * S_utf8_mg_pos() is used to query and update mg_ptr field of
5884  * a PERL_UTF8_magic.  The mg_ptr is used to store the mapping
5885  * between UTF-8 and byte offsets.  See also the comments of
5886  * S_utf8_mg_pos_init().
5887  *
5888  */
5889 STATIC bool
5890 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)
5891 {
5892     bool found = FALSE;
5893
5894     if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5895         if (!*mgp)
5896             *mgp = mg_find(sv, PERL_MAGIC_utf8);
5897         if (*mgp && (*mgp)->mg_ptr) {
5898             *cachep = (STRLEN *) (*mgp)->mg_ptr;
5899             ASSERT_UTF8_CACHE(*cachep);
5900             if ((*cachep)[i] == (STRLEN)uoff)   /* An exact match. */
5901                  found = TRUE;
5902             else {                      /* We will skip to the right spot. */
5903                  STRLEN forw  = 0;
5904                  STRLEN backw = 0;
5905                  const U8* p = NULL;
5906
5907                  /* The assumption is that going backward is half
5908                   * the speed of going forward (that's where the
5909                   * 2 * backw in the below comes from).  (The real
5910                   * figure of course depends on the UTF-8 data.) */
5911
5912                  if ((*cachep)[i] > (STRLEN)uoff) {
5913                       forw  = uoff;
5914                       backw = (*cachep)[i] - (STRLEN)uoff;
5915
5916                       if (forw < 2 * backw)
5917                            p = start;
5918                       else
5919                            p = start + (*cachep)[i+1];
5920                  }
5921                  /* Try this only for the substr offset (i == 0),
5922                   * not for the substr length (i == 2). */
5923                  else if (i == 0) { /* (*cachep)[i] < uoff */
5924                       const STRLEN ulen = sv_len_utf8(sv);
5925
5926                       if ((STRLEN)uoff < ulen) {
5927                            forw  = (STRLEN)uoff - (*cachep)[i];
5928                            backw = ulen - (STRLEN)uoff;
5929
5930                            if (forw < 2 * backw)
5931                                 p = start + (*cachep)[i+1];
5932                            else
5933                                 p = send;
5934                       }
5935
5936                       /* If the string is not long enough for uoff,
5937                        * we could extend it, but not at this low a level. */
5938                  }
5939
5940                  if (p) {
5941                       if (forw < 2 * backw) {
5942                            while (forw--)
5943                                 p += UTF8SKIP(p);
5944                       }
5945                       else {
5946                            while (backw--) {
5947                                 p--;
5948                                 while (UTF8_IS_CONTINUATION(*p))
5949                                      p--;
5950                            }
5951                       }
5952
5953                       /* Update the cache. */
5954                       (*cachep)[i]   = (STRLEN)uoff;
5955                       (*cachep)[i+1] = p - start;
5956
5957                       /* Drop the stale "length" cache */
5958                       if (i == 0) {
5959                           (*cachep)[2] = 0;
5960                           (*cachep)[3] = 0;
5961                       }
5962
5963                       found = TRUE;
5964                  }
5965             }
5966             if (found) {        /* Setup the return values. */
5967                  *offsetp = (*cachep)[i+1];
5968                  *sp = start + *offsetp;
5969                  if (*sp >= send) {
5970                       *sp = send;
5971                       *offsetp = send - start;
5972                  }
5973                  else if (*sp < start) {
5974                       *sp = start;
5975                       *offsetp = 0;
5976                  }
5977             }
5978         }
5979 #ifdef PERL_UTF8_CACHE_ASSERT
5980         if (found) {
5981              U8 *s = start;
5982              I32 n = uoff;
5983
5984              while (n-- && s < send)
5985                   s += UTF8SKIP(s);
5986
5987              if (i == 0) {
5988                   assert(*offsetp == s - start);
5989                   assert((*cachep)[0] == (STRLEN)uoff);
5990                   assert((*cachep)[1] == *offsetp);
5991              }
5992              ASSERT_UTF8_CACHE(*cachep);
5993         }
5994 #endif
5995     }
5996
5997     return found;
5998 }
5999
6000 /*
6001 =for apidoc sv_pos_u2b
6002
6003 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6004 the start of the string, to a count of the equivalent number of bytes; if
6005 lenp is non-zero, it does the same to lenp, but this time starting from
6006 the offset, rather than from the start of the string. Handles magic and
6007 type coercion.
6008
6009 =cut
6010 */
6011
6012 /*
6013  * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6014  * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6015  * byte offsets.  See also the comments of S_utf8_mg_pos().
6016  *
6017  */
6018
6019 void
6020 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6021 {
6022     const U8 *start;
6023     STRLEN len;
6024
6025     if (!sv)
6026         return;
6027
6028     start = (U8*)SvPV_const(sv, len);
6029     if (len) {
6030         STRLEN boffset = 0;
6031         STRLEN *cache = 0;
6032         const U8 *s = start;
6033         I32 uoffset = *offsetp;
6034         const U8 * const send = s + len;
6035         MAGIC *mg = 0;
6036         bool found = FALSE;
6037
6038          if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6039              found = TRUE;
6040          if (!found && uoffset > 0) {
6041               while (s < send && uoffset--)
6042                    s += UTF8SKIP(s);
6043               if (s >= send)
6044                    s = send;
6045               if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6046                   boffset = cache[1];
6047               *offsetp = s - start;
6048          }
6049          if (lenp) {
6050               found = FALSE;
6051               start = s;
6052               if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6053                   *lenp -= boffset;
6054                   found = TRUE;
6055               }
6056               if (!found && *lenp > 0) {
6057                    I32 ulen = *lenp;
6058                    if (ulen > 0)
6059                         while (s < send && ulen--)
6060                              s += UTF8SKIP(s);
6061                    if (s >= send)
6062                         s = send;
6063                    utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6064               }
6065               *lenp = s - start;
6066          }
6067          ASSERT_UTF8_CACHE(cache);
6068     }
6069     else {
6070          *offsetp = 0;
6071          if (lenp)
6072               *lenp = 0;
6073     }
6074
6075     return;
6076 }
6077
6078 /*
6079 =for apidoc sv_pos_b2u
6080
6081 Converts the value pointed to by offsetp from a count of bytes from the
6082 start of the string, to a count of the equivalent number of UTF-8 chars.
6083 Handles magic and type coercion.
6084
6085 =cut
6086 */
6087
6088 /*
6089  * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6090  * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6091  * byte offsets.  See also the comments of S_utf8_mg_pos().
6092  *
6093  */
6094
6095 void
6096 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6097 {
6098     const U8* s;
6099     STRLEN len;
6100
6101     if (!sv)
6102         return;
6103
6104     s = (const U8*)SvPV_const(sv, len);
6105     if ((I32)len < *offsetp)
6106         Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6107     else {
6108         const U8* send = s + *offsetp;
6109         MAGIC* mg = NULL;
6110         STRLEN *cache = NULL;
6111
6112         len = 0;
6113
6114         if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6115             mg = mg_find(sv, PERL_MAGIC_utf8);
6116             if (mg && mg->mg_ptr) {
6117                 cache = (STRLEN *) mg->mg_ptr;
6118                 if (cache[1] == (STRLEN)*offsetp) {
6119                     /* An exact match. */
6120                     *offsetp = cache[0];
6121
6122                     return;
6123                 }
6124                 else if (cache[1] < (STRLEN)*offsetp) {
6125                     /* We already know part of the way. */
6126                     len = cache[0];
6127                     s  += cache[1];
6128                     /* Let the below loop do the rest. */
6129                 }
6130                 else { /* cache[1] > *offsetp */
6131                     /* We already know all of the way, now we may
6132                      * be able to walk back.  The same assumption
6133                      * is made as in S_utf8_mg_pos(), namely that
6134                      * walking backward is twice slower than
6135                      * walking forward. */
6136                     const STRLEN forw  = *offsetp;
6137                     STRLEN backw = cache[1] - *offsetp;
6138
6139                     if (!(forw < 2 * backw)) {
6140                         const U8 *p = s + cache[1];
6141                         STRLEN ubackw = 0;
6142
6143                         cache[1] -= backw;
6144
6145                         while (backw--) {
6146                             p--;
6147                             while (UTF8_IS_CONTINUATION(*p)) {
6148                                 p--;
6149                                 backw--;
6150                             }
6151                             ubackw++;
6152                         }
6153
6154                         cache[0] -= ubackw;
6155                         *offsetp = cache[0];
6156
6157                         /* Drop the stale "length" cache */
6158                         cache[2] = 0;
6159                         cache[3] = 0;
6160
6161                         return;
6162                     }
6163                 }
6164             }
6165             ASSERT_UTF8_CACHE(cache);
6166         }
6167
6168         while (s < send) {
6169             STRLEN n = 1;
6170
6171             /* Call utf8n_to_uvchr() to validate the sequence
6172              * (unless a simple non-UTF character) */
6173             if (!UTF8_IS_INVARIANT(*s))
6174                 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6175             if (n > 0) {
6176                 s += n;
6177                 len++;
6178             }
6179             else
6180                 break;
6181         }
6182
6183         if (!SvREADONLY(sv)) {
6184             if (!mg) {
6185                 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6186                 mg = mg_find(sv, PERL_MAGIC_utf8);
6187             }
6188             assert(mg);
6189
6190             if (!mg->mg_ptr) {
6191                 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6192                 mg->mg_ptr = (char *) cache;
6193             }
6194             assert(cache);
6195
6196             cache[0] = len;
6197             cache[1] = *offsetp;
6198             /* Drop the stale "length" cache */
6199             cache[2] = 0;
6200             cache[3] = 0;
6201         }
6202
6203         *offsetp = len;
6204     }
6205     return;
6206 }
6207
6208 /*
6209 =for apidoc sv_eq
6210
6211 Returns a boolean indicating whether the strings in the two SVs are
6212 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6213 coerce its args to strings if necessary.
6214
6215 =cut
6216 */
6217
6218 I32
6219 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6220 {
6221     const char *pv1;
6222     STRLEN cur1;
6223     const char *pv2;
6224     STRLEN cur2;
6225     I32  eq     = 0;
6226     char *tpv   = Nullch;
6227     SV* svrecode = Nullsv;
6228
6229     if (!sv1) {
6230         pv1 = "";
6231         cur1 = 0;
6232     }
6233     else
6234         pv1 = SvPV_const(sv1, cur1);
6235
6236     if (!sv2){
6237         pv2 = "";
6238         cur2 = 0;
6239     }
6240     else
6241         pv2 = SvPV_const(sv2, cur2);
6242
6243     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6244         /* Differing utf8ness.
6245          * Do not UTF8size the comparands as a side-effect. */
6246          if (PL_encoding) {
6247               if (SvUTF8(sv1)) {
6248                    svrecode = newSVpvn(pv2, cur2);
6249                    sv_recode_to_utf8(svrecode, PL_encoding);
6250                    pv2 = SvPV_const(svrecode, cur2);
6251               }
6252               else {
6253                    svrecode = newSVpvn(pv1, cur1);
6254                    sv_recode_to_utf8(svrecode, PL_encoding);
6255                    pv1 = SvPV_const(svrecode, cur1);
6256               }
6257               /* Now both are in UTF-8. */
6258               if (cur1 != cur2) {
6259                    SvREFCNT_dec(svrecode);
6260                    return FALSE;
6261               }
6262          }
6263          else {
6264               bool is_utf8 = TRUE;
6265
6266               if (SvUTF8(sv1)) {
6267                    /* sv1 is the UTF-8 one,
6268                     * if is equal it must be downgrade-able */
6269                    char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6270                                                      &cur1, &is_utf8);
6271                    if (pv != pv1)
6272                         pv1 = tpv = pv;
6273               }
6274               else {
6275                    /* sv2 is the UTF-8 one,
6276                     * if is equal it must be downgrade-able */
6277                    char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6278                                                       &cur2, &is_utf8);
6279                    if (pv != pv2)
6280                         pv2 = tpv = pv;
6281               }
6282               if (is_utf8) {
6283                    /* Downgrade not possible - cannot be eq */
6284                    assert (tpv == 0);
6285                    return FALSE;
6286               }
6287          }
6288     }
6289
6290     if (cur1 == cur2)
6291         eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6292
6293     if (svrecode)
6294          SvREFCNT_dec(svrecode);
6295
6296     if (tpv)
6297         Safefree(tpv);
6298
6299     return eq;
6300 }
6301
6302 /*
6303 =for apidoc sv_cmp
6304
6305 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
6306 string in C<sv1> is less than, equal to, or greater than the string in
6307 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6308 coerce its args to strings if necessary.  See also C<sv_cmp_locale>.
6309
6310 =cut
6311 */
6312
6313 I32
6314 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6315 {
6316     STRLEN cur1, cur2;
6317     const char *pv1, *pv2;
6318     char *tpv = Nullch;
6319     I32  cmp;
6320     SV *svrecode = Nullsv;
6321
6322     if (!sv1) {
6323         pv1 = "";
6324         cur1 = 0;
6325     }
6326     else
6327         pv1 = SvPV_const(sv1, cur1);
6328
6329     if (!sv2) {
6330         pv2 = "";
6331         cur2 = 0;
6332     }
6333     else
6334         pv2 = SvPV_const(sv2, cur2);
6335
6336     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6337         /* Differing utf8ness.
6338          * Do not UTF8size the comparands as a side-effect. */
6339         if (SvUTF8(sv1)) {
6340             if (PL_encoding) {
6341                  svrecode = newSVpvn(pv2, cur2);
6342                  sv_recode_to_utf8(svrecode, PL_encoding);
6343                  pv2 = SvPV_const(svrecode, cur2);
6344             }
6345             else {
6346                  pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6347             }
6348         }
6349         else {
6350             if (PL_encoding) {
6351                  svrecode = newSVpvn(pv1, cur1);
6352                  sv_recode_to_utf8(svrecode, PL_encoding);
6353                  pv1 = SvPV_const(svrecode, cur1);
6354             }
6355             else {
6356                  pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6357             }
6358         }
6359     }
6360
6361     if (!cur1) {
6362         cmp = cur2 ? -1 : 0;
6363     } else if (!cur2) {
6364         cmp = 1;
6365     } else {
6366         const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6367
6368         if (retval) {
6369             cmp = retval < 0 ? -1 : 1;
6370         } else if (cur1 == cur2) {
6371             cmp = 0;
6372         } else {
6373             cmp = cur1 < cur2 ? -1 : 1;
6374         }
6375     }
6376
6377     if (svrecode)
6378          SvREFCNT_dec(svrecode);
6379
6380     if (tpv)
6381         Safefree(tpv);
6382
6383     return cmp;
6384 }
6385
6386 /*
6387 =for apidoc sv_cmp_locale
6388
6389 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6390 'use bytes' aware, handles get magic, and will coerce its args to strings
6391 if necessary.  See also C<sv_cmp_locale>.  See also C<sv_cmp>.
6392
6393 =cut
6394 */
6395
6396 I32
6397 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6398 {
6399 #ifdef USE_LOCALE_COLLATE
6400
6401     char *pv1, *pv2;
6402     STRLEN len1, len2;
6403     I32 retval;
6404
6405     if (PL_collation_standard)
6406         goto raw_compare;
6407
6408     len1 = 0;
6409     pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6410     len2 = 0;
6411     pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6412
6413     if (!pv1 || !len1) {
6414         if (pv2 && len2)
6415             return -1;
6416         else
6417             goto raw_compare;
6418     }
6419     else {
6420         if (!pv2 || !len2)
6421             return 1;
6422     }
6423
6424     retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6425
6426     if (retval)
6427         return retval < 0 ? -1 : 1;
6428
6429     /*
6430      * When the result of collation is equality, that doesn't mean
6431      * that there are no differences -- some locales exclude some
6432      * characters from consideration.  So to avoid false equalities,
6433      * we use the raw string as a tiebreaker.
6434      */
6435
6436   raw_compare:
6437     /* FALL THROUGH */
6438
6439 #endif /* USE_LOCALE_COLLATE */
6440
6441     return sv_cmp(sv1, sv2);
6442 }
6443
6444
6445 #ifdef USE_LOCALE_COLLATE
6446
6447 /*
6448 =for apidoc sv_collxfrm
6449
6450 Add Collate Transform magic to an SV if it doesn't already have it.
6451
6452 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6453 scalar data of the variable, but transformed to such a format that a normal
6454 memory comparison can be used to compare the data according to the locale
6455 settings.
6456
6457 =cut
6458 */
6459
6460 char *
6461 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6462 {
6463     MAGIC *mg;
6464
6465     mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6466     if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6467         const char *s;
6468         char *xf;
6469         STRLEN len, xlen;
6470
6471         if (mg)
6472             Safefree(mg->mg_ptr);
6473         s = SvPV_const(sv, len);
6474         if ((xf = mem_collxfrm(s, len, &xlen))) {
6475             if (SvREADONLY(sv)) {
6476                 SAVEFREEPV(xf);
6477                 *nxp = xlen;
6478                 return xf + sizeof(PL_collation_ix);
6479             }
6480             if (! mg) {
6481                 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6482                 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6483                 assert(mg);
6484             }
6485             mg->mg_ptr = xf;
6486             mg->mg_len = xlen;
6487         }
6488         else {
6489             if (mg) {
6490                 mg->mg_ptr = NULL;
6491                 mg->mg_len = -1;
6492             }
6493         }
6494     }
6495     if (mg && mg->mg_ptr) {
6496         *nxp = mg->mg_len;
6497         return mg->mg_ptr + sizeof(PL_collation_ix);
6498     }
6499     else {
6500         *nxp = 0;
6501         return NULL;
6502     }
6503 }
6504
6505 #endif /* USE_LOCALE_COLLATE */
6506
6507 /*
6508 =for apidoc sv_gets
6509
6510 Get a line from the filehandle and store it into the SV, optionally
6511 appending to the currently-stored string.
6512
6513 =cut
6514 */
6515
6516 char *
6517 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6518 {
6519     const char *rsptr;
6520     STRLEN rslen;
6521     register STDCHAR rslast;
6522     register STDCHAR *bp;
6523     register I32 cnt;
6524     I32 i = 0;
6525     I32 rspara = 0;
6526     I32 recsize;
6527
6528     if (SvTHINKFIRST(sv))
6529         sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6530     /* XXX. If you make this PVIV, then copy on write can copy scalars read
6531        from <>.
6532        However, perlbench says it's slower, because the existing swipe code
6533        is faster than copy on write.
6534        Swings and roundabouts.  */
6535     SvUPGRADE(sv, SVt_PV);
6536
6537     SvSCREAM_off(sv);
6538
6539     if (append) {
6540         if (PerlIO_isutf8(fp)) {
6541             if (!SvUTF8(sv)) {
6542                 sv_utf8_upgrade_nomg(sv);
6543                 sv_pos_u2b(sv,&append,0);
6544             }
6545         } else if (SvUTF8(sv)) {
6546             SV * const tsv = NEWSV(0,0);
6547             sv_gets(tsv, fp, 0);
6548             sv_utf8_upgrade_nomg(tsv);
6549             SvCUR_set(sv,append);
6550             sv_catsv(sv,tsv);
6551             sv_free(tsv);
6552             goto return_string_or_null;
6553         }
6554     }
6555
6556     SvPOK_only(sv);
6557     if (PerlIO_isutf8(fp))
6558         SvUTF8_on(sv);
6559
6560     if (IN_PERL_COMPILETIME) {
6561         /* we always read code in line mode */
6562         rsptr = "\n";
6563         rslen = 1;
6564     }
6565     else if (RsSNARF(PL_rs)) {
6566         /* If it is a regular disk file use size from stat() as estimate
6567            of amount we are going to read - may result in malloc-ing
6568            more memory than we realy need if layers bellow reduce
6569            size we read (e.g. CRLF or a gzip layer)
6570          */
6571         Stat_t st;
6572         if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode))  {
6573             const Off_t offset = PerlIO_tell(fp);
6574             if (offset != (Off_t) -1 && st.st_size + append > offset) {
6575                 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6576             }
6577         }
6578         rsptr = NULL;
6579         rslen = 0;
6580     }
6581     else if (RsRECORD(PL_rs)) {
6582       I32 bytesread;
6583       char *buffer;
6584
6585       /* Grab the size of the record we're getting */
6586       recsize = SvIV(SvRV(PL_rs));
6587       buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6588       /* Go yank in */
6589 #ifdef VMS
6590       /* VMS wants read instead of fread, because fread doesn't respect */
6591       /* RMS record boundaries. This is not necessarily a good thing to be */
6592       /* doing, but we've got no other real choice - except avoid stdio
6593          as implementation - perhaps write a :vms layer ?
6594        */
6595       bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6596 #else
6597       bytesread = PerlIO_read(fp, buffer, recsize);
6598 #endif
6599       if (bytesread < 0)
6600           bytesread = 0;
6601       SvCUR_set(sv, bytesread += append);
6602       buffer[bytesread] = '\0';
6603       goto return_string_or_null;
6604     }
6605     else if (RsPARA(PL_rs)) {
6606         rsptr = "\n\n";
6607         rslen = 2;
6608         rspara = 1;
6609     }
6610     else {
6611         /* Get $/ i.e. PL_rs into same encoding as stream wants */
6612         if (PerlIO_isutf8(fp)) {
6613             rsptr = SvPVutf8(PL_rs, rslen);
6614         }
6615         else {
6616             if (SvUTF8(PL_rs)) {
6617                 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6618                     Perl_croak(aTHX_ "Wide character in $/");
6619                 }
6620             }
6621             rsptr = SvPV_const(PL_rs, rslen);
6622         }
6623     }
6624
6625     rslast = rslen ? rsptr[rslen - 1] : '\0';
6626
6627     if (rspara) {               /* have to do this both before and after */
6628         do {                    /* to make sure file boundaries work right */
6629             if (PerlIO_eof(fp))
6630                 return 0;
6631             i = PerlIO_getc(fp);
6632             if (i != '\n') {
6633                 if (i == -1)
6634                     return 0;
6635                 PerlIO_ungetc(fp,i);
6636                 break;
6637             }
6638         } while (i != EOF);
6639     }
6640
6641     /* See if we know enough about I/O mechanism to cheat it ! */
6642
6643     /* This used to be #ifdef test - it is made run-time test for ease
6644        of abstracting out stdio interface. One call should be cheap
6645        enough here - and may even be a macro allowing compile
6646        time optimization.
6647      */
6648
6649     if (PerlIO_fast_gets(fp)) {
6650
6651     /*
6652      * We're going to steal some values from the stdio struct
6653      * and put EVERYTHING in the innermost loop into registers.
6654      */
6655     register STDCHAR *ptr;
6656     STRLEN bpx;
6657     I32 shortbuffered;
6658
6659 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6660     /* An ungetc()d char is handled separately from the regular
6661      * buffer, so we getc() it back out and stuff it in the buffer.
6662      */
6663     i = PerlIO_getc(fp);
6664     if (i == EOF) return 0;
6665     *(--((*fp)->_ptr)) = (unsigned char) i;
6666     (*fp)->_cnt++;
6667 #endif
6668
6669     /* Here is some breathtakingly efficient cheating */
6670
6671     cnt = PerlIO_get_cnt(fp);                   /* get count into register */
6672     /* make sure we have the room */
6673     if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6674         /* Not room for all of it
6675            if we are looking for a separator and room for some
6676          */
6677         if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6678             /* just process what we have room for */
6679             shortbuffered = cnt - SvLEN(sv) + append + 1;
6680             cnt -= shortbuffered;
6681         }
6682         else {
6683             shortbuffered = 0;
6684             /* remember that cnt can be negative */
6685             SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6686         }
6687     }
6688     else
6689         shortbuffered = 0;
6690     bp = (STDCHAR*)SvPVX_const(sv) + append;  /* move these two too to registers */
6691     ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6692     DEBUG_P(PerlIO_printf(Perl_debug_log,
6693         "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6694     DEBUG_P(PerlIO_printf(Perl_debug_log,
6695         "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6696                PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6697                PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6698     for (;;) {
6699       screamer:
6700         if (cnt > 0) {
6701             if (rslen) {
6702                 while (cnt > 0) {                    /* this     |  eat */
6703                     cnt--;
6704                     if ((*bp++ = *ptr++) == rslast)  /* really   |  dust */
6705                         goto thats_all_folks;        /* screams  |  sed :-) */
6706                 }
6707             }
6708             else {
6709                 Copy(ptr, bp, cnt, char);            /* this     |  eat */
6710                 bp += cnt;                           /* screams  |  dust */
6711                 ptr += cnt;                          /* louder   |  sed :-) */
6712                 cnt = 0;
6713             }
6714         }
6715
6716         if (shortbuffered) {            /* oh well, must extend */
6717             cnt = shortbuffered;
6718             shortbuffered = 0;
6719             bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6720             SvCUR_set(sv, bpx);
6721             SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6722             bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6723             continue;
6724         }
6725
6726         DEBUG_P(PerlIO_printf(Perl_debug_log,
6727                               "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6728                               PTR2UV(ptr),(long)cnt));
6729         PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6730 #if 0
6731         DEBUG_P(PerlIO_printf(Perl_debug_log,
6732             "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6733             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6734             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6735 #endif
6736         /* This used to call 'filbuf' in stdio form, but as that behaves like
6737            getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6738            another abstraction.  */
6739         i   = PerlIO_getc(fp);          /* get more characters */
6740 #if 0
6741         DEBUG_P(PerlIO_printf(Perl_debug_log,
6742             "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6743             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6744             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6745 #endif
6746         cnt = PerlIO_get_cnt(fp);
6747         ptr = (STDCHAR*)PerlIO_get_ptr(fp);     /* reregisterize cnt and ptr */
6748         DEBUG_P(PerlIO_printf(Perl_debug_log,
6749             "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6750
6751         if (i == EOF)                   /* all done for ever? */
6752             goto thats_really_all_folks;
6753
6754         bpx = bp - (STDCHAR*)SvPVX_const(sv);   /* box up before relocation */
6755         SvCUR_set(sv, bpx);
6756         SvGROW(sv, bpx + cnt + 2);
6757         bp = (STDCHAR*)SvPVX_const(sv) + bpx;   /* unbox after relocation */
6758
6759         *bp++ = (STDCHAR)i;             /* store character from PerlIO_getc */
6760
6761         if (rslen && (STDCHAR)i == rslast)  /* all done for now? */
6762             goto thats_all_folks;
6763     }
6764
6765 thats_all_folks:
6766     if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6767           memNE((char*)bp - rslen, rsptr, rslen))
6768         goto screamer;                          /* go back to the fray */
6769 thats_really_all_folks:
6770     if (shortbuffered)
6771         cnt += shortbuffered;
6772         DEBUG_P(PerlIO_printf(Perl_debug_log,
6773             "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6774     PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt);  /* put these back or we're in trouble */
6775     DEBUG_P(PerlIO_printf(Perl_debug_log,
6776         "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6777         PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6778         PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6779     *bp = '\0';
6780     SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv));      /* set length */
6781     DEBUG_P(PerlIO_printf(Perl_debug_log,
6782         "Screamer: done, len=%ld, string=|%.*s|\n",
6783         (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6784     }
6785    else
6786     {
6787        /*The big, slow, and stupid way. */
6788 #ifdef USE_HEAP_INSTEAD_OF_STACK        /* Even slower way. */
6789         STDCHAR *buf = 0;
6790         Newx(buf, 8192, STDCHAR);
6791         assert(buf);
6792 #else
6793         STDCHAR buf[8192];
6794 #endif
6795
6796 screamer2:
6797         if (rslen) {
6798             const register STDCHAR *bpe = buf + sizeof(buf);
6799             bp = buf;
6800             while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6801                 ; /* keep reading */
6802             cnt = bp - buf;
6803         }
6804         else {
6805             cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6806             /* Accomodate broken VAXC compiler, which applies U8 cast to
6807              * both args of ?: operator, causing EOF to change into 255
6808              */
6809             if (cnt > 0)
6810                  i = (U8)buf[cnt - 1];
6811             else
6812                  i = EOF;
6813         }
6814
6815         if (cnt < 0)
6816             cnt = 0;  /* we do need to re-set the sv even when cnt <= 0 */
6817         if (append)
6818              sv_catpvn(sv, (char *) buf, cnt);
6819         else
6820              sv_setpvn(sv, (char *) buf, cnt);
6821
6822         if (i != EOF &&                 /* joy */
6823             (!rslen ||
6824              SvCUR(sv) < rslen ||
6825              memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6826         {
6827             append = -1;
6828             /*
6829              * If we're reading from a TTY and we get a short read,
6830              * indicating that the user hit his EOF character, we need
6831              * to notice it now, because if we try to read from the TTY
6832              * again, the EOF condition will disappear.
6833              *
6834              * The comparison of cnt to sizeof(buf) is an optimization
6835              * that prevents unnecessary calls to feof().
6836              *
6837              * - jik 9/25/96
6838              */
6839             if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6840                 goto screamer2;
6841         }
6842
6843 #ifdef USE_HEAP_INSTEAD_OF_STACK
6844         Safefree(buf);
6845 #endif
6846     }
6847
6848     if (rspara) {               /* have to do this both before and after */
6849         while (i != EOF) {      /* to make sure file boundaries work right */
6850             i = PerlIO_getc(fp);
6851             if (i != '\n') {
6852                 PerlIO_ungetc(fp,i);
6853                 break;
6854             }
6855         }
6856     }
6857
6858 return_string_or_null:
6859     return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6860 }
6861
6862 /*
6863 =for apidoc sv_inc
6864
6865 Auto-increment of the value in the SV, doing string to numeric conversion
6866 if necessary. Handles 'get' magic.
6867
6868 =cut
6869 */
6870
6871 void
6872 Perl_sv_inc(pTHX_ register SV *sv)
6873 {
6874     register char *d;
6875     int flags;
6876
6877     if (!sv)
6878         return;
6879     if (SvGMAGICAL(sv))
6880         mg_get(sv);
6881     if (SvTHINKFIRST(sv)) {
6882         if (SvIsCOW(sv))
6883             sv_force_normal_flags(sv, 0);
6884         if (SvREADONLY(sv)) {
6885             if (IN_PERL_RUNTIME)
6886                 Perl_croak(aTHX_ PL_no_modify);
6887         }
6888         if (SvROK(sv)) {
6889             IV i;
6890             if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6891                 return;
6892             i = PTR2IV(SvRV(sv));
6893             sv_unref(sv);
6894             sv_setiv(sv, i);
6895         }
6896     }
6897     flags = SvFLAGS(sv);
6898     if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6899         /* It's (privately or publicly) a float, but not tested as an
6900            integer, so test it to see. */
6901         (void) SvIV(sv);
6902         flags = SvFLAGS(sv);
6903     }
6904     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6905         /* It's publicly an integer, or privately an integer-not-float */
6906 #ifdef PERL_PRESERVE_IVUV
6907       oops_its_int:
6908 #endif
6909         if (SvIsUV(sv)) {
6910             if (SvUVX(sv) == UV_MAX)
6911                 sv_setnv(sv, UV_MAX_P1);
6912             else
6913                 (void)SvIOK_only_UV(sv);
6914                 SvUV_set(sv, SvUVX(sv) + 1);
6915         } else {
6916             if (SvIVX(sv) == IV_MAX)
6917                 sv_setuv(sv, (UV)IV_MAX + 1);
6918             else {
6919                 (void)SvIOK_only(sv);
6920                 SvIV_set(sv, SvIVX(sv) + 1);
6921             }
6922         }
6923         return;
6924     }
6925     if (flags & SVp_NOK) {
6926         (void)SvNOK_only(sv);
6927         SvNV_set(sv, SvNVX(sv) + 1.0);
6928         return;
6929     }
6930
6931     if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6932         if ((flags & SVTYPEMASK) < SVt_PVIV)
6933             sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6934         (void)SvIOK_only(sv);
6935         SvIV_set(sv, 1);
6936         return;
6937     }
6938     d = SvPVX(sv);
6939     while (isALPHA(*d)) d++;
6940     while (isDIGIT(*d)) d++;
6941     if (*d) {
6942 #ifdef PERL_PRESERVE_IVUV
6943         /* Got to punt this as an integer if needs be, but we don't issue
6944            warnings. Probably ought to make the sv_iv_please() that does
6945            the conversion if possible, and silently.  */
6946         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6947         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6948             /* Need to try really hard to see if it's an integer.
6949                9.22337203685478e+18 is an integer.
6950                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6951                so $a="9.22337203685478e+18"; $a+0; $a++
6952                needs to be the same as $a="9.22337203685478e+18"; $a++
6953                or we go insane. */
6954
6955             (void) sv_2iv(sv);
6956             if (SvIOK(sv))
6957                 goto oops_its_int;
6958
6959             /* sv_2iv *should* have made this an NV */
6960             if (flags & SVp_NOK) {
6961                 (void)SvNOK_only(sv);
6962                 SvNV_set(sv, SvNVX(sv) + 1.0);
6963                 return;
6964             }
6965             /* I don't think we can get here. Maybe I should assert this
6966                And if we do get here I suspect that sv_setnv will croak. NWC
6967                Fall through. */
6968 #if defined(USE_LONG_DOUBLE)
6969             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",
6970                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6971 #else
6972             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6973                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6974 #endif
6975         }
6976 #endif /* PERL_PRESERVE_IVUV */
6977         sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6978         return;
6979     }
6980     d--;
6981     while (d >= SvPVX_const(sv)) {
6982         if (isDIGIT(*d)) {
6983             if (++*d <= '9')
6984                 return;
6985             *(d--) = '0';
6986         }
6987         else {
6988 #ifdef EBCDIC
6989             /* MKS: The original code here died if letters weren't consecutive.
6990              * at least it didn't have to worry about non-C locales.  The
6991              * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6992              * arranged in order (although not consecutively) and that only
6993              * [A-Za-z] are accepted by isALPHA in the C locale.
6994              */
6995             if (*d != 'z' && *d != 'Z') {
6996                 do { ++*d; } while (!isALPHA(*d));
6997                 return;
6998             }
6999             *(d--) -= 'z' - 'a';
7000 #else
7001             ++*d;
7002             if (isALPHA(*d))
7003                 return;
7004             *(d--) -= 'z' - 'a' + 1;
7005 #endif
7006         }
7007     }
7008     /* oh,oh, the number grew */
7009     SvGROW(sv, SvCUR(sv) + 2);
7010     SvCUR_set(sv, SvCUR(sv) + 1);
7011     for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7012         *d = d[-1];
7013     if (isDIGIT(d[1]))
7014         *d = '1';
7015     else
7016         *d = d[1];
7017 }
7018
7019 /*
7020 =for apidoc sv_dec
7021
7022 Auto-decrement of the value in the SV, doing string to numeric conversion
7023 if necessary. Handles 'get' magic.
7024
7025 =cut
7026 */
7027
7028 void
7029 Perl_sv_dec(pTHX_ register SV *sv)
7030 {
7031     int flags;
7032
7033     if (!sv)
7034         return;
7035     if (SvGMAGICAL(sv))
7036         mg_get(sv);
7037     if (SvTHINKFIRST(sv)) {
7038         if (SvIsCOW(sv))
7039             sv_force_normal_flags(sv, 0);
7040         if (SvREADONLY(sv)) {
7041             if (IN_PERL_RUNTIME)
7042                 Perl_croak(aTHX_ PL_no_modify);
7043         }
7044         if (SvROK(sv)) {
7045             IV i;
7046             if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7047                 return;
7048             i = PTR2IV(SvRV(sv));
7049             sv_unref(sv);
7050             sv_setiv(sv, i);
7051         }
7052     }
7053     /* Unlike sv_inc we don't have to worry about string-never-numbers
7054        and keeping them magic. But we mustn't warn on punting */
7055     flags = SvFLAGS(sv);
7056     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7057         /* It's publicly an integer, or privately an integer-not-float */
7058 #ifdef PERL_PRESERVE_IVUV
7059       oops_its_int:
7060 #endif
7061         if (SvIsUV(sv)) {
7062             if (SvUVX(sv) == 0) {
7063                 (void)SvIOK_only(sv);
7064                 SvIV_set(sv, -1);
7065             }
7066             else {
7067                 (void)SvIOK_only_UV(sv);
7068                 SvUV_set(sv, SvUVX(sv) - 1);
7069             }
7070         } else {
7071             if (SvIVX(sv) == IV_MIN)
7072                 sv_setnv(sv, (NV)IV_MIN - 1.0);
7073             else {
7074                 (void)SvIOK_only(sv);
7075                 SvIV_set(sv, SvIVX(sv) - 1);
7076             }
7077         }
7078         return;
7079     }
7080     if (flags & SVp_NOK) {
7081         SvNV_set(sv, SvNVX(sv) - 1.0);
7082         (void)SvNOK_only(sv);
7083         return;
7084     }
7085     if (!(flags & SVp_POK)) {
7086         if ((flags & SVTYPEMASK) < SVt_PVIV)
7087             sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7088         SvIV_set(sv, -1);
7089         (void)SvIOK_only(sv);
7090         return;
7091     }
7092 #ifdef PERL_PRESERVE_IVUV
7093     {
7094         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7095         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7096             /* Need to try really hard to see if it's an integer.
7097                9.22337203685478e+18 is an integer.
7098                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7099                so $a="9.22337203685478e+18"; $a+0; $a--
7100                needs to be the same as $a="9.22337203685478e+18"; $a--
7101                or we go insane. */
7102
7103             (void) sv_2iv(sv);
7104             if (SvIOK(sv))
7105                 goto oops_its_int;
7106
7107             /* sv_2iv *should* have made this an NV */
7108             if (flags & SVp_NOK) {
7109                 (void)SvNOK_only(sv);
7110                 SvNV_set(sv, SvNVX(sv) - 1.0);
7111                 return;
7112             }
7113             /* I don't think we can get here. Maybe I should assert this
7114                And if we do get here I suspect that sv_setnv will croak. NWC
7115                Fall through. */
7116 #if defined(USE_LONG_DOUBLE)
7117             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",
7118                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7119 #else
7120             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7121                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7122 #endif
7123         }
7124     }
7125 #endif /* PERL_PRESERVE_IVUV */
7126     sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0);   /* punt */
7127 }
7128
7129 /*
7130 =for apidoc sv_mortalcopy
7131
7132 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7133 The new SV is marked as mortal. It will be destroyed "soon", either by an
7134 explicit call to FREETMPS, or by an implicit call at places such as
7135 statement boundaries.  See also C<sv_newmortal> and C<sv_2mortal>.
7136
7137 =cut
7138 */
7139
7140 /* Make a string that will exist for the duration of the expression
7141  * evaluation.  Actually, it may have to last longer than that, but
7142  * hopefully we won't free it until it has been assigned to a
7143  * permanent location. */
7144
7145 SV *
7146 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7147 {
7148     register SV *sv;
7149
7150     new_SV(sv);
7151     sv_setsv(sv,oldstr);
7152     EXTEND_MORTAL(1);
7153     PL_tmps_stack[++PL_tmps_ix] = sv;
7154     SvTEMP_on(sv);
7155     return sv;
7156 }
7157
7158 /*
7159 =for apidoc sv_newmortal
7160
7161 Creates a new null SV which is mortal.  The reference count of the SV is
7162 set to 1. It will be destroyed "soon", either by an explicit call to
7163 FREETMPS, or by an implicit call at places such as statement boundaries.
7164 See also C<sv_mortalcopy> and C<sv_2mortal>.
7165
7166 =cut
7167 */
7168
7169 SV *
7170 Perl_sv_newmortal(pTHX)
7171 {
7172     register SV *sv;
7173
7174     new_SV(sv);
7175     SvFLAGS(sv) = SVs_TEMP;
7176     EXTEND_MORTAL(1);
7177     PL_tmps_stack[++PL_tmps_ix] = sv;
7178     return sv;
7179 }
7180
7181 /*
7182 =for apidoc sv_2mortal
7183
7184 Marks an existing SV as mortal.  The SV will be destroyed "soon", either
7185 by an explicit call to FREETMPS, or by an implicit call at places such as
7186 statement boundaries.  SvTEMP() is turned on which means that the SV's
7187 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7188 and C<sv_mortalcopy>.
7189
7190 =cut
7191 */
7192
7193 SV *
7194 Perl_sv_2mortal(pTHX_ register SV *sv)
7195 {
7196     dVAR;
7197     if (!sv)
7198         return sv;
7199     if (SvREADONLY(sv) && SvIMMORTAL(sv))
7200         return sv;
7201     EXTEND_MORTAL(1);
7202     PL_tmps_stack[++PL_tmps_ix] = sv;
7203     SvTEMP_on(sv);
7204     return sv;
7205 }
7206
7207 /*
7208 =for apidoc newSVpv
7209
7210 Creates a new SV and copies a string into it.  The reference count for the
7211 SV is set to 1.  If C<len> is zero, Perl will compute the length using
7212 strlen().  For efficiency, consider using C<newSVpvn> instead.
7213
7214 =cut
7215 */
7216
7217 SV *
7218 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7219 {
7220     register SV *sv;
7221
7222     new_SV(sv);
7223     sv_setpvn(sv,s,len ? len : strlen(s));
7224     return sv;
7225 }
7226
7227 /*
7228 =for apidoc newSVpvn
7229
7230 Creates a new SV and copies a string into it.  The reference count for the
7231 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
7232 string.  You are responsible for ensuring that the source string is at least
7233 C<len> bytes long.  If the C<s> argument is NULL the new SV will be undefined.
7234
7235 =cut
7236 */
7237
7238 SV *
7239 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7240 {
7241     register SV *sv;
7242
7243     new_SV(sv);
7244     sv_setpvn(sv,s,len);
7245     return sv;
7246 }
7247
7248
7249 /*
7250 =for apidoc newSVhek
7251
7252 Creates a new SV from the hash key structure.  It will generate scalars that
7253 point to the shared string table where possible. Returns a new (undefined)
7254 SV if the hek is NULL.
7255
7256 =cut
7257 */
7258
7259 SV *
7260 Perl_newSVhek(pTHX_ const HEK *hek)
7261 {
7262     if (!hek) {
7263         SV *sv;
7264
7265         new_SV(sv);
7266         return sv;
7267     }
7268
7269     if (HEK_LEN(hek) == HEf_SVKEY) {
7270         return newSVsv(*(SV**)HEK_KEY(hek));
7271     } else {
7272         const int flags = HEK_FLAGS(hek);
7273         if (flags & HVhek_WASUTF8) {
7274             /* Trouble :-)
7275                Andreas would like keys he put in as utf8 to come back as utf8
7276             */
7277             STRLEN utf8_len = HEK_LEN(hek);
7278             const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7279             SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7280
7281             SvUTF8_on (sv);
7282             Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7283             return sv;
7284         } else if (flags & HVhek_REHASH) {
7285             /* We don't have a pointer to the hv, so we have to replicate the
7286                flag into every HEK. This hv is using custom a hasing
7287                algorithm. Hence we can't return a shared string scalar, as
7288                that would contain the (wrong) hash value, and might get passed
7289                into an hv routine with a regular hash  */
7290
7291             SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7292             if (HEK_UTF8(hek))
7293                 SvUTF8_on (sv);
7294             return sv;
7295         }
7296         /* This will be overwhelminly the most common case.  */
7297         return newSVpvn_share(HEK_KEY(hek),
7298                               (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7299                               HEK_HASH(hek));
7300     }
7301 }
7302
7303 /*
7304 =for apidoc newSVpvn_share
7305
7306 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7307 table. If the string does not already exist in the table, it is created
7308 first.  Turns on READONLY and FAKE.  The string's hash is stored in the UV
7309 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7310 otherwise the hash is computed.  The idea here is that as the string table
7311 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7312 hash lookup will avoid string compare.
7313
7314 =cut
7315 */
7316
7317 SV *
7318 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7319 {
7320     register SV *sv;
7321     bool is_utf8 = FALSE;
7322     if (len < 0) {
7323         STRLEN tmplen = -len;
7324         is_utf8 = TRUE;
7325         /* See the note in hv.c:hv_fetch() --jhi */
7326         src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7327         len = tmplen;
7328     }
7329     if (!hash)
7330         PERL_HASH(hash, src, len);
7331     new_SV(sv);
7332     sv_upgrade(sv, SVt_PV);
7333     SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7334     SvCUR_set(sv, len);
7335     SvLEN_set(sv, 0);
7336     SvREADONLY_on(sv);
7337     SvFAKE_on(sv);
7338     SvPOK_on(sv);
7339     if (is_utf8)
7340         SvUTF8_on(sv);
7341     return sv;
7342 }
7343
7344
7345 #if defined(PERL_IMPLICIT_CONTEXT)
7346
7347 /* pTHX_ magic can't cope with varargs, so this is a no-context
7348  * version of the main function, (which may itself be aliased to us).
7349  * Don't access this version directly.
7350  */
7351
7352 SV *
7353 Perl_newSVpvf_nocontext(const char* pat, ...)
7354 {
7355     dTHX;
7356     register SV *sv;
7357     va_list args;
7358     va_start(args, pat);
7359     sv = vnewSVpvf(pat, &args);
7360     va_end(args);
7361     return sv;
7362 }
7363 #endif
7364
7365 /*
7366 =for apidoc newSVpvf
7367
7368 Creates a new SV and initializes it with the string formatted like
7369 C<sprintf>.
7370
7371 =cut
7372 */
7373
7374 SV *
7375 Perl_newSVpvf(pTHX_ const char* pat, ...)
7376 {
7377     register SV *sv;
7378     va_list args;
7379     va_start(args, pat);
7380     sv = vnewSVpvf(pat, &args);
7381     va_end(args);
7382     return sv;
7383 }
7384
7385 /* backend for newSVpvf() and newSVpvf_nocontext() */
7386
7387 SV *
7388 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7389 {
7390     register SV *sv;
7391     new_SV(sv);
7392     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7393     return sv;
7394 }
7395
7396 /*
7397 =for apidoc newSVnv
7398
7399 Creates a new SV and copies a floating point value into it.
7400 The reference count for the SV is set to 1.
7401
7402 =cut
7403 */
7404
7405 SV *
7406 Perl_newSVnv(pTHX_ NV n)
7407 {
7408     register SV *sv;
7409
7410     new_SV(sv);
7411     sv_setnv(sv,n);
7412     return sv;
7413 }
7414
7415 /*
7416 =for apidoc newSViv
7417
7418 Creates a new SV and copies an integer into it.  The reference count for the
7419 SV is set to 1.
7420
7421 =cut
7422 */
7423
7424 SV *
7425 Perl_newSViv(pTHX_ IV i)
7426 {
7427     register SV *sv;
7428
7429     new_SV(sv);
7430     sv_setiv(sv,i);
7431     return sv;
7432 }
7433
7434 /*
7435 =for apidoc newSVuv
7436
7437 Creates a new SV and copies an unsigned integer into it.
7438 The reference count for the SV is set to 1.
7439
7440 =cut
7441 */
7442
7443 SV *
7444 Perl_newSVuv(pTHX_ UV u)
7445 {
7446     register SV *sv;
7447
7448     new_SV(sv);
7449     sv_setuv(sv,u);
7450     return sv;
7451 }
7452
7453 /*
7454 =for apidoc newRV_noinc
7455
7456 Creates an RV wrapper for an SV.  The reference count for the original
7457 SV is B<not> incremented.
7458
7459 =cut
7460 */
7461
7462 SV *
7463 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7464 {
7465     register SV *sv;
7466
7467     new_SV(sv);
7468     sv_upgrade(sv, SVt_RV);
7469     SvTEMP_off(tmpRef);
7470     SvRV_set(sv, tmpRef);
7471     SvROK_on(sv);
7472     return sv;
7473 }
7474
7475 /* newRV_inc is the official function name to use now.
7476  * newRV_inc is in fact #defined to newRV in sv.h
7477  */
7478
7479 SV *
7480 Perl_newRV(pTHX_ SV *tmpRef)
7481 {
7482     return newRV_noinc(SvREFCNT_inc(tmpRef));
7483 }
7484
7485 /*
7486 =for apidoc newSVsv
7487
7488 Creates a new SV which is an exact duplicate of the original SV.
7489 (Uses C<sv_setsv>).
7490
7491 =cut
7492 */
7493
7494 SV *
7495 Perl_newSVsv(pTHX_ register SV *old)
7496 {
7497     register SV *sv;
7498
7499     if (!old)
7500         return Nullsv;
7501     if (SvTYPE(old) == SVTYPEMASK) {
7502         if (ckWARN_d(WARN_INTERNAL))
7503             Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7504         return Nullsv;
7505     }
7506     new_SV(sv);
7507     /* SV_GMAGIC is the default for sv_setv()
7508        SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7509        with SvTEMP_off and SvTEMP_on round a call to sv_setsv.  */
7510     sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7511     return sv;
7512 }
7513
7514 /*
7515 =for apidoc sv_reset
7516
7517 Underlying implementation for the C<reset> Perl function.
7518 Note that the perl-level function is vaguely deprecated.
7519
7520 =cut
7521 */
7522
7523 void
7524 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7525 {
7526     dVAR;
7527     char todo[PERL_UCHAR_MAX+1];
7528
7529     if (!stash)
7530         return;
7531
7532     if (!*s) {          /* reset ?? searches */
7533         MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7534         if (mg) {
7535             PMOP *pm = (PMOP *) mg->mg_obj;
7536             while (pm) {
7537                 pm->op_pmdynflags &= ~PMdf_USED;
7538                 pm = pm->op_pmnext;
7539             }
7540         }
7541         return;
7542     }
7543
7544     /* reset variables */
7545
7546     if (!HvARRAY(stash))
7547         return;
7548
7549     Zero(todo, 256, char);
7550     while (*s) {
7551         I32 max;
7552         I32 i = (unsigned char)*s;
7553         if (s[1] == '-') {
7554             s += 2;
7555         }
7556         max = (unsigned char)*s++;
7557         for ( ; i <= max; i++) {
7558             todo[i] = 1;
7559         }
7560         for (i = 0; i <= (I32) HvMAX(stash); i++) {
7561             HE *entry;
7562             for (entry = HvARRAY(stash)[i];
7563                  entry;
7564                  entry = HeNEXT(entry))
7565             {
7566                 register GV *gv;
7567                 register SV *sv;
7568
7569                 if (!todo[(U8)*HeKEY(entry)])
7570                     continue;
7571                 gv = (GV*)HeVAL(entry);
7572                 sv = GvSV(gv);
7573                 if (sv) {
7574                     if (SvTHINKFIRST(sv)) {
7575                         if (!SvREADONLY(sv) && SvROK(sv))
7576                             sv_unref(sv);
7577                         /* XXX Is this continue a bug? Why should THINKFIRST
7578                            exempt us from resetting arrays and hashes?  */
7579                         continue;
7580                     }
7581                     SvOK_off(sv);
7582                     if (SvTYPE(sv) >= SVt_PV) {
7583                         SvCUR_set(sv, 0);
7584                         if (SvPVX_const(sv) != Nullch)
7585                             *SvPVX(sv) = '\0';
7586                         SvTAINT(sv);
7587                     }
7588                 }
7589                 if (GvAV(gv)) {
7590                     av_clear(GvAV(gv));
7591                 }
7592                 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7593                     hv_clear(GvHV(gv));
7594 #ifndef PERL_MICRO
7595 #ifdef USE_ENVIRON_ARRAY
7596                     if (gv == PL_envgv
7597 #  ifdef USE_ITHREADS
7598                         && PL_curinterp == aTHX
7599 #  endif
7600                     )
7601                     {
7602                         environ[0] = Nullch;
7603                     }
7604 #endif
7605 #endif /* !PERL_MICRO */
7606                 }
7607             }
7608         }
7609     }
7610 }
7611
7612 /*
7613 =for apidoc sv_2io
7614
7615 Using various gambits, try to get an IO from an SV: the IO slot if its a
7616 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7617 named after the PV if we're a string.
7618
7619 =cut
7620 */
7621
7622 IO*
7623 Perl_sv_2io(pTHX_ SV *sv)
7624 {
7625     IO* io;
7626     GV* gv;
7627
7628     switch (SvTYPE(sv)) {
7629     case SVt_PVIO:
7630         io = (IO*)sv;
7631         break;
7632     case SVt_PVGV:
7633         gv = (GV*)sv;
7634         io = GvIO(gv);
7635         if (!io)
7636             Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7637         break;
7638     default:
7639         if (!SvOK(sv))
7640             Perl_croak(aTHX_ PL_no_usym, "filehandle");
7641         if (SvROK(sv))
7642             return sv_2io(SvRV(sv));
7643         gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7644         if (gv)
7645             io = GvIO(gv);
7646         else
7647             io = 0;
7648         if (!io)
7649             Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7650         break;
7651     }
7652     return io;
7653 }
7654
7655 /*
7656 =for apidoc sv_2cv
7657
7658 Using various gambits, try to get a CV from an SV; in addition, try if
7659 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7660
7661 =cut
7662 */
7663
7664 CV *
7665 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7666 {
7667     dVAR;
7668     GV *gv = Nullgv;
7669     CV *cv = Nullcv;
7670
7671     if (!sv)
7672         return *gvp = Nullgv, Nullcv;
7673     switch (SvTYPE(sv)) {
7674     case SVt_PVCV:
7675         *st = CvSTASH(sv);
7676         *gvp = Nullgv;
7677         return (CV*)sv;
7678     case SVt_PVHV:
7679     case SVt_PVAV:
7680         *gvp = Nullgv;
7681         return Nullcv;
7682     case SVt_PVGV:
7683         gv = (GV*)sv;
7684         *gvp = gv;
7685         *st = GvESTASH(gv);
7686         goto fix_gv;
7687
7688     default:
7689         if (SvGMAGICAL(sv))
7690             mg_get(sv);
7691         if (SvROK(sv)) {
7692             SV **sp = &sv;              /* Used in tryAMAGICunDEREF macro. */
7693             tryAMAGICunDEREF(to_cv);
7694
7695             sv = SvRV(sv);
7696             if (SvTYPE(sv) == SVt_PVCV) {
7697                 cv = (CV*)sv;
7698                 *gvp = Nullgv;
7699                 *st = CvSTASH(cv);
7700                 return cv;
7701             }
7702             else if(isGV(sv))
7703                 gv = (GV*)sv;
7704             else
7705                 Perl_croak(aTHX_ "Not a subroutine reference");
7706         }
7707         else if (isGV(sv))
7708             gv = (GV*)sv;
7709         else
7710             gv = gv_fetchsv(sv, lref, SVt_PVCV);
7711         *gvp = gv;
7712         if (!gv)
7713             return Nullcv;
7714         *st = GvESTASH(gv);
7715     fix_gv:
7716         if (lref && !GvCVu(gv)) {
7717             SV *tmpsv;
7718             ENTER;
7719             tmpsv = NEWSV(704,0);
7720             gv_efullname3(tmpsv, gv, Nullch);
7721             /* XXX this is probably not what they think they're getting.
7722              * It has the same effect as "sub name;", i.e. just a forward
7723              * declaration! */
7724             newSUB(start_subparse(FALSE, 0),
7725                    newSVOP(OP_CONST, 0, tmpsv),
7726                    Nullop,
7727                    Nullop);
7728             LEAVE;
7729             if (!GvCVu(gv))
7730                 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7731                            sv);
7732         }
7733         return GvCVu(gv);
7734     }
7735 }
7736
7737 /*
7738 =for apidoc sv_true
7739
7740 Returns true if the SV has a true value by Perl's rules.
7741 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7742 instead use an in-line version.
7743
7744 =cut
7745 */
7746
7747 I32
7748 Perl_sv_true(pTHX_ register SV *sv)
7749 {
7750     if (!sv)
7751         return 0;
7752     if (SvPOK(sv)) {
7753         const register XPV* tXpv;
7754         if ((tXpv = (XPV*)SvANY(sv)) &&
7755                 (tXpv->xpv_cur > 1 ||
7756                 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7757             return 1;
7758         else
7759             return 0;
7760     }
7761     else {
7762         if (SvIOK(sv))
7763             return SvIVX(sv) != 0;
7764         else {
7765             if (SvNOK(sv))
7766                 return SvNVX(sv) != 0.0;
7767             else
7768                 return sv_2bool(sv);
7769         }
7770     }
7771 }
7772
7773 /*
7774 =for apidoc sv_iv
7775
7776 A private implementation of the C<SvIVx> macro for compilers which can't
7777 cope with complex macro expressions. Always use the macro instead.
7778
7779 =cut
7780 */
7781
7782 IV
7783 Perl_sv_iv(pTHX_ register SV *sv)
7784 {
7785     if (SvIOK(sv)) {
7786         if (SvIsUV(sv))
7787             return (IV)SvUVX(sv);
7788         return SvIVX(sv);
7789     }
7790     return sv_2iv(sv);
7791 }
7792
7793 /*
7794 =for apidoc sv_uv
7795
7796 A private implementation of the C<SvUVx> macro for compilers which can't
7797 cope with complex macro expressions. Always use the macro instead.
7798
7799 =cut
7800 */
7801
7802 UV
7803 Perl_sv_uv(pTHX_ register SV *sv)
7804 {
7805     if (SvIOK(sv)) {
7806         if (SvIsUV(sv))
7807             return SvUVX(sv);
7808         return (UV)SvIVX(sv);
7809     }
7810     return sv_2uv(sv);
7811 }
7812
7813 /*
7814 =for apidoc sv_nv
7815
7816 A private implementation of the C<SvNVx> macro for compilers which can't
7817 cope with complex macro expressions. Always use the macro instead.
7818
7819 =cut
7820 */
7821
7822 NV
7823 Perl_sv_nv(pTHX_ register SV *sv)
7824 {
7825     if (SvNOK(sv))
7826         return SvNVX(sv);
7827     return sv_2nv(sv);
7828 }
7829
7830 /* sv_pv() is now a macro using SvPV_nolen();
7831  * this function provided for binary compatibility only
7832  */
7833
7834 char *
7835 Perl_sv_pv(pTHX_ SV *sv)
7836 {
7837     if (SvPOK(sv))
7838         return SvPVX(sv);
7839
7840     return sv_2pv(sv, 0);
7841 }
7842
7843 /*
7844 =for apidoc sv_pv
7845
7846 Use the C<SvPV_nolen> macro instead
7847
7848 =for apidoc sv_pvn
7849
7850 A private implementation of the C<SvPV> macro for compilers which can't
7851 cope with complex macro expressions. Always use the macro instead.
7852
7853 =cut
7854 */
7855
7856 char *
7857 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7858 {
7859     if (SvPOK(sv)) {
7860         *lp = SvCUR(sv);
7861         return SvPVX(sv);
7862     }
7863     return sv_2pv(sv, lp);
7864 }
7865
7866
7867 char *
7868 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7869 {
7870     if (SvPOK(sv)) {
7871         *lp = SvCUR(sv);
7872         return SvPVX(sv);
7873     }
7874     return sv_2pv_flags(sv, lp, 0);
7875 }
7876
7877 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7878  * this function provided for binary compatibility only
7879  */
7880
7881 char *
7882 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7883 {
7884     return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7885 }
7886
7887 /*
7888 =for apidoc sv_pvn_force
7889
7890 Get a sensible string out of the SV somehow.
7891 A private implementation of the C<SvPV_force> macro for compilers which
7892 can't cope with complex macro expressions. Always use the macro instead.
7893
7894 =for apidoc sv_pvn_force_flags
7895
7896 Get a sensible string out of the SV somehow.
7897 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7898 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7899 implemented in terms of this function.
7900 You normally want to use the various wrapper macros instead: see
7901 C<SvPV_force> and C<SvPV_force_nomg>
7902
7903 =cut
7904 */
7905
7906 char *
7907 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7908 {
7909
7910     if (SvTHINKFIRST(sv) && !SvROK(sv))
7911         sv_force_normal_flags(sv, 0);
7912
7913     if (SvPOK(sv)) {
7914         if (lp)
7915             *lp = SvCUR(sv);
7916     }
7917     else {
7918         char *s;
7919         STRLEN len;
7920
7921         if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7922             const char * const ref = sv_reftype(sv,0);
7923             if (PL_op)
7924                 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7925                            ref, OP_NAME(PL_op));
7926             else
7927                 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7928         }
7929         if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7930             Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7931                 OP_NAME(PL_op));
7932         s = sv_2pv_flags(sv, &len, flags);
7933         if (lp)
7934             *lp = len;
7935
7936         if (s != SvPVX_const(sv)) {     /* Almost, but not quite, sv_setpvn() */
7937             if (SvROK(sv))
7938                 sv_unref(sv);
7939             SvUPGRADE(sv, SVt_PV);              /* Never FALSE */
7940             SvGROW(sv, len + 1);
7941             Move(s,SvPVX_const(sv),len,char);
7942             SvCUR_set(sv, len);
7943             *SvEND(sv) = '\0';
7944         }
7945         if (!SvPOK(sv)) {
7946             SvPOK_on(sv);               /* validate pointer */
7947             SvTAINT(sv);
7948             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7949                                   PTR2UV(sv),SvPVX_const(sv)));
7950         }
7951     }
7952     return SvPVX_mutable(sv);
7953 }
7954
7955 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7956  * this function provided for binary compatibility only
7957  */
7958
7959 char *
7960 Perl_sv_pvbyte(pTHX_ SV *sv)
7961 {
7962     sv_utf8_downgrade(sv,0);
7963     return sv_pv(sv);
7964 }
7965
7966 /*
7967 =for apidoc sv_pvbyte
7968
7969 Use C<SvPVbyte_nolen> instead.
7970
7971 =for apidoc sv_pvbyten
7972
7973 A private implementation of the C<SvPVbyte> macro for compilers
7974 which can't cope with complex macro expressions. Always use the macro
7975 instead.
7976
7977 =cut
7978 */
7979
7980 char *
7981 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7982 {
7983     sv_utf8_downgrade(sv,0);
7984     return sv_pvn(sv,lp);
7985 }
7986
7987 /*
7988 =for apidoc sv_pvbyten_force
7989
7990 A private implementation of the C<SvPVbytex_force> macro for compilers
7991 which can't cope with complex macro expressions. Always use the macro
7992 instead.
7993
7994 =cut
7995 */
7996
7997 char *
7998 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7999 {
8000     sv_pvn_force(sv,lp);
8001     sv_utf8_downgrade(sv,0);
8002     *lp = SvCUR(sv);
8003     return SvPVX(sv);
8004 }
8005
8006 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8007  * this function provided for binary compatibility only
8008  */
8009
8010 char *
8011 Perl_sv_pvutf8(pTHX_ SV *sv)
8012 {
8013     sv_utf8_upgrade(sv);
8014     return sv_pv(sv);
8015 }
8016
8017 /*
8018 =for apidoc sv_pvutf8
8019
8020 Use the C<SvPVutf8_nolen> macro instead
8021
8022 =for apidoc sv_pvutf8n
8023
8024 A private implementation of the C<SvPVutf8> macro for compilers
8025 which can't cope with complex macro expressions. Always use the macro
8026 instead.
8027
8028 =cut
8029 */
8030
8031 char *
8032 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8033 {
8034     sv_utf8_upgrade(sv);
8035     return sv_pvn(sv,lp);
8036 }
8037
8038 /*
8039 =for apidoc sv_pvutf8n_force
8040
8041 A private implementation of the C<SvPVutf8_force> macro for compilers
8042 which can't cope with complex macro expressions. Always use the macro
8043 instead.
8044
8045 =cut
8046 */
8047
8048 char *
8049 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8050 {
8051     sv_pvn_force(sv,lp);
8052     sv_utf8_upgrade(sv);
8053     *lp = SvCUR(sv);
8054     return SvPVX(sv);
8055 }
8056
8057 /*
8058 =for apidoc sv_reftype
8059
8060 Returns a string describing what the SV is a reference to.
8061
8062 =cut
8063 */
8064
8065 char *
8066 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8067 {
8068     /* The fact that I don't need to downcast to char * everywhere, only in ?:
8069        inside return suggests a const propagation bug in g++.  */
8070     if (ob && SvOBJECT(sv)) {
8071         char * const name = HvNAME_get(SvSTASH(sv));
8072         return name ? name : (char *) "__ANON__";
8073     }
8074     else {
8075         switch (SvTYPE(sv)) {
8076         case SVt_NULL:
8077         case SVt_IV:
8078         case SVt_NV:
8079         case SVt_RV:
8080         case SVt_PV:
8081         case SVt_PVIV:
8082         case SVt_PVNV:
8083         case SVt_PVMG:
8084         case SVt_PVBM:
8085                                 if (SvVOK(sv))
8086                                     return "VSTRING";
8087                                 if (SvROK(sv))
8088                                     return "REF";
8089                                 else
8090                                     return "SCALAR";
8091
8092         case SVt_PVLV:          return (char *)  (SvROK(sv) ? "REF"
8093                                 /* tied lvalues should appear to be
8094                                  * scalars for backwards compatitbility */
8095                                 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8096                                     ? "SCALAR" : "LVALUE");
8097         case SVt_PVAV:          return "ARRAY";
8098         case SVt_PVHV:          return "HASH";
8099         case SVt_PVCV:          return "CODE";
8100         case SVt_PVGV:          return "GLOB";
8101         case SVt_PVFM:          return "FORMAT";
8102         case SVt_PVIO:          return "IO";
8103         default:                return "UNKNOWN";
8104         }
8105     }
8106 }
8107
8108 /*
8109 =for apidoc sv_isobject
8110
8111 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8112 object.  If the SV is not an RV, or if the object is not blessed, then this
8113 will return false.
8114
8115 =cut
8116 */
8117
8118 int
8119 Perl_sv_isobject(pTHX_ SV *sv)
8120 {
8121     if (!sv)
8122         return 0;
8123     if (SvGMAGICAL(sv))
8124         mg_get(sv);
8125     if (!SvROK(sv))
8126         return 0;
8127     sv = (SV*)SvRV(sv);
8128     if (!SvOBJECT(sv))
8129         return 0;
8130     return 1;
8131 }
8132
8133 /*
8134 =for apidoc sv_isa
8135
8136 Returns a boolean indicating whether the SV is blessed into the specified
8137 class.  This does not check for subtypes; use C<sv_derived_from> to verify
8138 an inheritance relationship.
8139
8140 =cut
8141 */
8142
8143 int
8144 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8145 {
8146     const char *hvname;
8147     if (!sv)
8148         return 0;
8149     if (SvGMAGICAL(sv))
8150         mg_get(sv);
8151     if (!SvROK(sv))
8152         return 0;
8153     sv = (SV*)SvRV(sv);
8154     if (!SvOBJECT(sv))
8155         return 0;
8156     hvname = HvNAME_get(SvSTASH(sv));
8157     if (!hvname)
8158         return 0;
8159
8160     return strEQ(hvname, name);
8161 }
8162
8163 /*
8164 =for apidoc newSVrv
8165
8166 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
8167 it will be upgraded to one.  If C<classname> is non-null then the new SV will
8168 be blessed in the specified package.  The new SV is returned and its
8169 reference count is 1.
8170
8171 =cut
8172 */
8173
8174 SV*
8175 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8176 {
8177     SV *sv;
8178
8179     new_SV(sv);
8180
8181     SV_CHECK_THINKFIRST_COW_DROP(rv);
8182     SvAMAGIC_off(rv);
8183
8184     if (SvTYPE(rv) >= SVt_PVMG) {
8185         const U32 refcnt = SvREFCNT(rv);
8186         SvREFCNT(rv) = 0;
8187         sv_clear(rv);
8188         SvFLAGS(rv) = 0;
8189         SvREFCNT(rv) = refcnt;
8190     }
8191
8192     if (SvTYPE(rv) < SVt_RV)
8193         sv_upgrade(rv, SVt_RV);
8194     else if (SvTYPE(rv) > SVt_RV) {
8195         SvPV_free(rv);
8196         SvCUR_set(rv, 0);
8197         SvLEN_set(rv, 0);
8198     }
8199
8200     SvOK_off(rv);
8201     SvRV_set(rv, sv);
8202     SvROK_on(rv);
8203
8204     if (classname) {
8205         HV* const stash = gv_stashpv(classname, TRUE);
8206         (void)sv_bless(rv, stash);
8207     }
8208     return sv;
8209 }
8210
8211 /*
8212 =for apidoc sv_setref_pv
8213
8214 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
8215 argument will be upgraded to an RV.  That RV will be modified to point to
8216 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8217 into the SV.  The C<classname> argument indicates the package for the
8218 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
8219 will have a reference count of 1, and the RV will be returned.
8220
8221 Do not use with other Perl types such as HV, AV, SV, CV, because those
8222 objects will become corrupted by the pointer copy process.
8223
8224 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8225
8226 =cut
8227 */
8228
8229 SV*
8230 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8231 {
8232     if (!pv) {
8233         sv_setsv(rv, &PL_sv_undef);
8234         SvSETMAGIC(rv);
8235     }
8236     else
8237         sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8238     return rv;
8239 }
8240
8241 /*
8242 =for apidoc sv_setref_iv
8243
8244 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
8245 argument will be upgraded to an RV.  That RV will be modified to point to
8246 the new SV.  The C<classname> argument indicates the package for the
8247 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
8248 will have a reference count of 1, and the RV will be returned.
8249
8250 =cut
8251 */
8252
8253 SV*
8254 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8255 {
8256     sv_setiv(newSVrv(rv,classname), iv);
8257     return rv;
8258 }
8259
8260 /*
8261 =for apidoc sv_setref_uv
8262
8263 Copies an unsigned integer into a new SV, optionally blessing the SV.  The C<rv>
8264 argument will be upgraded to an RV.  That RV will be modified to point to
8265 the new SV.  The C<classname> argument indicates the package for the
8266 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
8267 will have a reference count of 1, and the RV will be returned.
8268
8269 =cut
8270 */
8271
8272 SV*
8273 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8274 {
8275     sv_setuv(newSVrv(rv,classname), uv);
8276     return rv;
8277 }
8278
8279 /*
8280 =for apidoc sv_setref_nv
8281
8282 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
8283 argument will be upgraded to an RV.  That RV will be modified to point to
8284 the new SV.  The C<classname> argument indicates the package for the
8285 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
8286 will have a reference count of 1, and the RV will be returned.
8287
8288 =cut
8289 */
8290
8291 SV*
8292 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8293 {
8294     sv_setnv(newSVrv(rv,classname), nv);
8295     return rv;
8296 }
8297
8298 /*
8299 =for apidoc sv_setref_pvn
8300
8301 Copies a string into a new SV, optionally blessing the SV.  The length of the
8302 string must be specified with C<n>.  The C<rv> argument will be upgraded to
8303 an RV.  That RV will be modified to point to the new SV.  The C<classname>
8304 argument indicates the package for the blessing.  Set C<classname> to
8305 C<Nullch> to avoid the blessing.  The new SV will have a reference count
8306 of 1, and the RV will be returned.
8307
8308 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8309
8310 =cut
8311 */
8312
8313 SV*
8314 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8315 {
8316     sv_setpvn(newSVrv(rv,classname), pv, n);
8317     return rv;
8318 }
8319
8320 /*
8321 =for apidoc sv_bless
8322
8323 Blesses an SV into a specified package.  The SV must be an RV.  The package
8324 must be designated by its stash (see C<gv_stashpv()>).  The reference count
8325 of the SV is unaffected.
8326
8327 =cut
8328 */
8329
8330 SV*
8331 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8332 {
8333     SV *tmpRef;
8334     if (!SvROK(sv))
8335         Perl_croak(aTHX_ "Can't bless non-reference value");
8336     tmpRef = SvRV(sv);
8337     if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8338         if (SvREADONLY(tmpRef))
8339             Perl_croak(aTHX_ PL_no_modify);
8340         if (SvOBJECT(tmpRef)) {
8341             if (SvTYPE(tmpRef) != SVt_PVIO)
8342                 --PL_sv_objcount;
8343             SvREFCNT_dec(SvSTASH(tmpRef));
8344         }
8345     }
8346     SvOBJECT_on(tmpRef);
8347     if (SvTYPE(tmpRef) != SVt_PVIO)
8348         ++PL_sv_objcount;
8349     SvUPGRADE(tmpRef, SVt_PVMG);
8350     SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8351
8352     if (Gv_AMG(stash))
8353         SvAMAGIC_on(sv);
8354     else
8355         SvAMAGIC_off(sv);
8356
8357     if(SvSMAGICAL(tmpRef))
8358         if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8359             mg_set(tmpRef);
8360
8361
8362
8363     return sv;
8364 }
8365
8366 /* Downgrades a PVGV to a PVMG.
8367  */
8368
8369 STATIC void
8370 S_sv_unglob(pTHX_ SV *sv)
8371 {
8372     void *xpvmg;
8373
8374     assert(SvTYPE(sv) == SVt_PVGV);
8375     SvFAKE_off(sv);
8376     if (GvGP(sv))
8377         gp_free((GV*)sv);
8378     if (GvSTASH(sv)) {
8379         sv_del_backref((SV*)GvSTASH(sv), sv);
8380         GvSTASH(sv) = Nullhv;
8381     }
8382     sv_unmagic(sv, PERL_MAGIC_glob);
8383     Safefree(GvNAME(sv));
8384     GvMULTI_off(sv);
8385
8386     /* need to keep SvANY(sv) in the right arena */
8387     xpvmg = new_XPVMG();
8388     StructCopy(SvANY(sv), xpvmg, XPVMG);
8389     del_XPVGV(SvANY(sv));
8390     SvANY(sv) = xpvmg;
8391
8392     SvFLAGS(sv) &= ~SVTYPEMASK;
8393     SvFLAGS(sv) |= SVt_PVMG;
8394 }
8395
8396 /*
8397 =for apidoc sv_unref_flags
8398
8399 Unsets the RV status of the SV, and decrements the reference count of
8400 whatever was being referenced by the RV.  This can almost be thought of
8401 as a reversal of C<newSVrv>.  The C<cflags> argument can contain
8402 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8403 (otherwise the decrementing is conditional on the reference count being
8404 different from one or the reference being a readonly SV).
8405 See C<SvROK_off>.
8406
8407 =cut
8408 */
8409
8410 void
8411 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8412 {
8413     SV* const target = SvRV(ref);
8414
8415     if (SvWEAKREF(ref)) {
8416         sv_del_backref(target, ref);
8417         SvWEAKREF_off(ref);
8418         SvRV_set(ref, NULL);
8419         return;
8420     }
8421     SvRV_set(ref, NULL);
8422     SvROK_off(ref);
8423     /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8424        assigned to as BEGIN {$a = \"Foo"} will fail.  */
8425     if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8426         SvREFCNT_dec(target);
8427     else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8428         sv_2mortal(target);     /* Schedule for freeing later */
8429 }
8430
8431 /*
8432 =for apidoc sv_unref
8433
8434 Unsets the RV status of the SV, and decrements the reference count of
8435 whatever was being referenced by the RV.  This can almost be thought of
8436 as a reversal of C<newSVrv>.  This is C<sv_unref_flags> with the C<flag>
8437 being zero.  See C<SvROK_off>.
8438
8439 =cut
8440 */
8441
8442 void
8443 Perl_sv_unref(pTHX_ SV *sv)
8444 {
8445     sv_unref_flags(sv, 0);
8446 }
8447
8448 /*
8449 =for apidoc sv_taint
8450
8451 Taint an SV. Use C<SvTAINTED_on> instead.
8452 =cut
8453 */
8454
8455 void
8456 Perl_sv_taint(pTHX_ SV *sv)
8457 {
8458     sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8459 }
8460
8461 /*
8462 =for apidoc sv_untaint
8463
8464 Untaint an SV. Use C<SvTAINTED_off> instead.
8465 =cut
8466 */
8467
8468 void
8469 Perl_sv_untaint(pTHX_ SV *sv)
8470 {
8471     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8472         MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8473         if (mg)
8474             mg->mg_len &= ~1;
8475     }
8476 }
8477
8478 /*
8479 =for apidoc sv_tainted
8480
8481 Test an SV for taintedness. Use C<SvTAINTED> instead.
8482 =cut
8483 */
8484
8485 bool
8486 Perl_sv_tainted(pTHX_ SV *sv)
8487 {
8488     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8489         MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8490         if (mg && (mg->mg_len & 1) )
8491             return TRUE;
8492     }
8493     return FALSE;
8494 }
8495
8496 /*
8497 =for apidoc sv_setpviv
8498
8499 Copies an integer into the given SV, also updating its string value.
8500 Does not handle 'set' magic.  See C<sv_setpviv_mg>.
8501
8502 =cut
8503 */
8504
8505 void
8506 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8507 {
8508     char buf[TYPE_CHARS(UV)];
8509     char *ebuf;
8510     char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8511
8512     sv_setpvn(sv, ptr, ebuf - ptr);
8513 }
8514
8515 /*
8516 =for apidoc sv_setpviv_mg
8517
8518 Like C<sv_setpviv>, but also handles 'set' magic.
8519
8520 =cut
8521 */
8522
8523 void
8524 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8525 {
8526     char buf[TYPE_CHARS(UV)];
8527     char *ebuf;
8528     char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8529
8530     sv_setpvn(sv, ptr, ebuf - ptr);
8531     SvSETMAGIC(sv);
8532 }
8533
8534 #if defined(PERL_IMPLICIT_CONTEXT)
8535
8536 /* pTHX_ magic can't cope with varargs, so this is a no-context
8537  * version of the main function, (which may itself be aliased to us).
8538  * Don't access this version directly.
8539  */
8540
8541 void
8542 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8543 {
8544     dTHX;
8545     va_list args;
8546     va_start(args, pat);
8547     sv_vsetpvf(sv, pat, &args);
8548     va_end(args);
8549 }
8550
8551 /* pTHX_ magic can't cope with varargs, so this is a no-context
8552  * version of the main function, (which may itself be aliased to us).
8553  * Don't access this version directly.
8554  */
8555
8556 void
8557 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8558 {
8559     dTHX;
8560     va_list args;
8561     va_start(args, pat);
8562     sv_vsetpvf_mg(sv, pat, &args);
8563     va_end(args);
8564 }
8565 #endif
8566
8567 /*
8568 =for apidoc sv_setpvf
8569
8570 Works like C<sv_catpvf> but copies the text into the SV instead of
8571 appending it.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
8572
8573 =cut
8574 */
8575
8576 void
8577 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8578 {
8579     va_list args;
8580     va_start(args, pat);
8581     sv_vsetpvf(sv, pat, &args);
8582     va_end(args);
8583 }
8584
8585 /*
8586 =for apidoc sv_vsetpvf
8587
8588 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8589 appending it.  Does not handle 'set' magic.  See C<sv_vsetpvf_mg>.
8590
8591 Usually used via its frontend C<sv_setpvf>.
8592
8593 =cut
8594 */
8595
8596 void
8597 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8598 {
8599     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8600 }
8601
8602 /*
8603 =for apidoc sv_setpvf_mg
8604
8605 Like C<sv_setpvf>, but also handles 'set' magic.
8606
8607 =cut
8608 */
8609
8610 void
8611 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8612 {
8613     va_list args;
8614     va_start(args, pat);
8615     sv_vsetpvf_mg(sv, pat, &args);
8616     va_end(args);
8617 }
8618
8619 /*
8620 =for apidoc sv_vsetpvf_mg
8621
8622 Like C<sv_vsetpvf>, but also handles 'set' magic.
8623
8624 Usually used via its frontend C<sv_setpvf_mg>.
8625
8626 =cut
8627 */
8628
8629 void
8630 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8631 {
8632     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8633     SvSETMAGIC(sv);
8634 }
8635
8636 #if defined(PERL_IMPLICIT_CONTEXT)
8637
8638 /* pTHX_ magic can't cope with varargs, so this is a no-context
8639  * version of the main function, (which may itself be aliased to us).
8640  * Don't access this version directly.
8641  */
8642
8643 void
8644 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8645 {
8646     dTHX;
8647     va_list args;
8648     va_start(args, pat);
8649     sv_vcatpvf(sv, pat, &args);
8650     va_end(args);
8651 }
8652
8653 /* pTHX_ magic can't cope with varargs, so this is a no-context
8654  * version of the main function, (which may itself be aliased to us).
8655  * Don't access this version directly.
8656  */
8657
8658 void
8659 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8660 {
8661     dTHX;
8662     va_list args;
8663     va_start(args, pat);
8664     sv_vcatpvf_mg(sv, pat, &args);
8665     va_end(args);
8666 }
8667 #endif
8668
8669 /*
8670 =for apidoc sv_catpvf
8671
8672 Processes its arguments like C<sprintf> and appends the formatted
8673 output to an SV.  If the appended data contains "wide" characters
8674 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8675 and characters >255 formatted with %c), the original SV might get
8676 upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.  See
8677 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8678 valid UTF-8; if the original SV was bytes, the pattern should be too.
8679
8680 =cut */
8681
8682 void
8683 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8684 {
8685     va_list args;
8686     va_start(args, pat);
8687     sv_vcatpvf(sv, pat, &args);
8688     va_end(args);
8689 }
8690
8691 /*
8692 =for apidoc sv_vcatpvf
8693
8694 Processes its arguments like C<vsprintf> and appends the formatted output
8695 to an SV.  Does not handle 'set' magic.  See C<sv_vcatpvf_mg>.
8696
8697 Usually used via its frontend C<sv_catpvf>.
8698
8699 =cut
8700 */
8701
8702 void
8703 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8704 {
8705     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8706 }
8707
8708 /*
8709 =for apidoc sv_catpvf_mg
8710
8711 Like C<sv_catpvf>, but also handles 'set' magic.
8712
8713 =cut
8714 */
8715
8716 void
8717 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8718 {
8719     va_list args;
8720     va_start(args, pat);
8721     sv_vcatpvf_mg(sv, pat, &args);
8722     va_end(args);
8723 }
8724
8725 /*
8726 =for apidoc sv_vcatpvf_mg
8727
8728 Like C<sv_vcatpvf>, but also handles 'set' magic.
8729
8730 Usually used via its frontend C<sv_catpvf_mg>.
8731
8732 =cut
8733 */
8734
8735 void
8736 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8737 {
8738     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8739     SvSETMAGIC(sv);
8740 }
8741
8742 /*
8743 =for apidoc sv_vsetpvfn
8744
8745 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8746 appending it.
8747
8748 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8749
8750 =cut
8751 */
8752
8753 void
8754 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8755 {
8756     sv_setpvn(sv, "", 0);
8757     sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8758 }
8759
8760 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8761
8762 STATIC I32
8763 S_expect_number(pTHX_ char** pattern)
8764 {
8765     I32 var = 0;
8766     switch (**pattern) {
8767     case '1': case '2': case '3':
8768     case '4': case '5': case '6':
8769     case '7': case '8': case '9':
8770         while (isDIGIT(**pattern))
8771             var = var * 10 + (*(*pattern)++ - '0');
8772     }
8773     return var;
8774 }
8775 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8776
8777 static char *
8778 F0convert(NV nv, char *endbuf, STRLEN *len)
8779 {
8780     const int neg = nv < 0;
8781     UV uv;
8782
8783     if (neg)
8784         nv = -nv;
8785     if (nv < UV_MAX) {
8786         char *p = endbuf;
8787         nv += 0.5;
8788         uv = (UV)nv;
8789         if (uv & 1 && uv == nv)
8790             uv--;                       /* Round to even */
8791         do {
8792             const unsigned dig = uv % 10;
8793             *--p = '0' + dig;
8794         } while (uv /= 10);
8795         if (neg)
8796             *--p = '-';
8797         *len = endbuf - p;
8798         return p;
8799     }
8800     return Nullch;
8801 }
8802
8803
8804 /*
8805 =for apidoc sv_vcatpvfn
8806
8807 Processes its arguments like C<vsprintf> and appends the formatted output
8808 to an SV.  Uses an array of SVs if the C style variable argument list is
8809 missing (NULL).  When running with taint checks enabled, indicates via
8810 C<maybe_tainted> if results are untrustworthy (often due to the use of
8811 locales).
8812
8813 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8814
8815 =cut
8816 */
8817
8818 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8819
8820 void
8821 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8822 {
8823     char *p;
8824     char *q;
8825     const char *patend;
8826     STRLEN origlen;
8827     I32 svix = 0;
8828     static const char nullstr[] = "(null)";
8829     SV *argsv = Nullsv;
8830     bool has_utf8 = DO_UTF8(sv);    /* has the result utf8? */
8831     const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8832     SV *nsv = Nullsv;
8833     /* Times 4: a decimal digit takes more than 3 binary digits.
8834      * NV_DIG: mantissa takes than many decimal digits.
8835      * Plus 32: Playing safe. */
8836     char ebuf[IV_DIG * 4 + NV_DIG + 32];
8837     /* large enough for "%#.#f" --chip */
8838     /* what about long double NVs? --jhi */
8839
8840     PERL_UNUSED_ARG(maybe_tainted);
8841
8842     /* no matter what, this is a string now */
8843     (void)SvPV_force(sv, origlen);
8844
8845     /* special-case "", "%s", and "%-p" (SVf) */
8846     if (patlen == 0)
8847         return;
8848     if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8849             if (args) {
8850                 const char * const s = va_arg(*args, char*);
8851                 sv_catpv(sv, s ? s : nullstr);
8852             }
8853             else if (svix < svmax) {
8854                 sv_catsv(sv, *svargs);
8855                 if (DO_UTF8(*svargs))
8856                     SvUTF8_on(sv);
8857             }
8858             return;
8859     }
8860     if (patlen == 3 && pat[0] == '%' &&
8861         pat[1] == '-' && pat[2] == 'p') {
8862             if (args) {
8863                 argsv = va_arg(*args, SV*);
8864                 sv_catsv(sv, argsv);
8865                 if (DO_UTF8(argsv))
8866                     SvUTF8_on(sv);
8867                 return;
8868             }
8869     }
8870
8871 #ifndef USE_LONG_DOUBLE
8872     /* special-case "%.<number>[gf]" */
8873     if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8874          && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8875         unsigned digits = 0;
8876         const char *pp;
8877
8878         pp = pat + 2;
8879         while (*pp >= '0' && *pp <= '9')
8880             digits = 10 * digits + (*pp++ - '0');
8881         if (pp - pat == (int)patlen - 1) {
8882             NV nv;
8883
8884             if (svix < svmax)
8885                 nv = SvNV(*svargs);
8886             else
8887                 return;
8888             if (*pp == 'g') {
8889                 /* Add check for digits != 0 because it seems that some
8890                    gconverts are buggy in this case, and we don't yet have
8891                    a Configure test for this.  */
8892                 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8893                      /* 0, point, slack */
8894                     Gconvert(nv, (int)digits, 0, ebuf);
8895                     sv_catpv(sv, ebuf);
8896                     if (*ebuf)  /* May return an empty string for digits==0 */
8897                         return;
8898                 }
8899             } else if (!digits) {
8900                 STRLEN l;
8901
8902                 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8903                     sv_catpvn(sv, p, l);
8904                     return;
8905                 }
8906             }
8907         }
8908     }
8909 #endif /* !USE_LONG_DOUBLE */
8910
8911     if (!args && svix < svmax && DO_UTF8(*svargs))
8912         has_utf8 = TRUE;
8913
8914     patend = (char*)pat + patlen;
8915     for (p = (char*)pat; p < patend; p = q) {
8916         bool alt = FALSE;
8917         bool left = FALSE;
8918         bool vectorize = FALSE;
8919         bool vectorarg = FALSE;
8920         bool vec_utf8 = FALSE;
8921         char fill = ' ';
8922         char plus = 0;
8923         char intsize = 0;
8924         STRLEN width = 0;
8925         STRLEN zeros = 0;
8926         bool has_precis = FALSE;
8927         STRLEN precis = 0;
8928         I32 osvix = svix;
8929         bool is_utf8 = FALSE;  /* is this item utf8?   */
8930 #ifdef HAS_LDBL_SPRINTF_BUG
8931         /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8932            with sfio - Allen <allens@cpan.org> */
8933         bool fix_ldbl_sprintf_bug = FALSE;
8934 #endif
8935
8936         char esignbuf[4];
8937         U8 utf8buf[UTF8_MAXBYTES+1];
8938         STRLEN esignlen = 0;
8939
8940         const char *eptr = Nullch;
8941         STRLEN elen = 0;
8942         SV *vecsv = Nullsv;
8943         const U8 *vecstr = Null(U8*);
8944         STRLEN veclen = 0;
8945         char c = 0;
8946         int i;
8947         unsigned base = 0;
8948         IV iv = 0;
8949         UV uv = 0;
8950         /* we need a long double target in case HAS_LONG_DOUBLE but
8951            not USE_LONG_DOUBLE
8952         */
8953 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8954         long double nv;
8955 #else
8956         NV nv;
8957 #endif
8958         STRLEN have;
8959         STRLEN need;
8960         STRLEN gap;
8961         const char *dotstr = ".";
8962         STRLEN dotstrlen = 1;
8963         I32 efix = 0; /* explicit format parameter index */
8964         I32 ewix = 0; /* explicit width index */
8965         I32 epix = 0; /* explicit precision index */
8966         I32 evix = 0; /* explicit vector index */
8967         bool asterisk = FALSE;
8968
8969         /* echo everything up to the next format specification */
8970         for (q = p; q < patend && *q != '%'; ++q) ;
8971         if (q > p) {
8972             if (has_utf8 && !pat_utf8)
8973                 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8974             else
8975                 sv_catpvn(sv, p, q - p);
8976             p = q;
8977         }
8978         if (q++ >= patend)
8979             break;
8980
8981 /*
8982     We allow format specification elements in this order:
8983         \d+\$              explicit format parameter index
8984         [-+ 0#]+           flags
8985         v|\*(\d+\$)?v      vector with optional (optionally specified) arg
8986         0                  flag (as above): repeated to allow "v02"
8987         \d+|\*(\d+\$)?     width using optional (optionally specified) arg
8988         \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8989         [hlqLV]            size
8990     [%bcdefginopsux_DFOUX] format (mandatory)
8991 */
8992         if (EXPECT_NUMBER(q, width)) {
8993             if (*q == '$') {
8994                 ++q;
8995                 efix = width;
8996             } else {
8997                 goto gotwidth;
8998             }
8999         }
9000
9001         /* FLAGS */
9002
9003         while (*q) {
9004             switch (*q) {
9005             case ' ':
9006             case '+':
9007                 plus = *q++;
9008                 continue;
9009
9010             case '-':
9011                 left = TRUE;
9012                 q++;
9013                 continue;
9014
9015             case '0':
9016                 fill = *q++;
9017                 continue;
9018
9019             case '#':
9020                 alt = TRUE;
9021                 q++;
9022                 continue;
9023
9024             default:
9025                 break;
9026             }
9027             break;
9028         }
9029
9030       tryasterisk:
9031         if (*q == '*') {
9032             q++;
9033             if (EXPECT_NUMBER(q, ewix))
9034                 if (*q++ != '$')
9035                     goto unknown;
9036             asterisk = TRUE;
9037         }
9038         if (*q == 'v') {
9039             q++;
9040             if (vectorize)
9041                 goto unknown;
9042             if ((vectorarg = asterisk)) {
9043                 evix = ewix;
9044                 ewix = 0;
9045                 asterisk = FALSE;
9046             }
9047             vectorize = TRUE;
9048             goto tryasterisk;
9049         }
9050
9051         if (!asterisk)
9052         {
9053             if( *q == '0' )
9054                 fill = *q++;
9055             EXPECT_NUMBER(q, width);
9056         }
9057
9058         if (vectorize) {
9059             if (vectorarg) {
9060                 if (args)
9061                     vecsv = va_arg(*args, SV*);
9062                 else
9063                     vecsv = (evix ? evix <= svmax : svix < svmax) ?
9064                         svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9065                 dotstr = SvPV_const(vecsv, dotstrlen);
9066                 if (DO_UTF8(vecsv))
9067                     is_utf8 = TRUE;
9068             }
9069             if (args) {
9070                 vecsv = va_arg(*args, SV*);
9071                 vecstr = (U8*)SvPV_const(vecsv,veclen);
9072                 vec_utf8 = DO_UTF8(vecsv);
9073             }
9074             else if (efix ? efix <= svmax : svix < svmax) {
9075                 vecsv = svargs[efix ? efix-1 : svix++];
9076                 vecstr = (U8*)SvPV_const(vecsv,veclen);
9077                 vec_utf8 = DO_UTF8(vecsv);
9078                 /* if this is a version object, we need to return the
9079                  * stringified representation (which the SvPVX_const has
9080                  * already done for us), but not vectorize the args
9081                  */
9082                 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9083                 {
9084                         q++; /* skip past the rest of the %vd format */
9085                         eptr = (const char *) vecstr;
9086                         elen = strlen(eptr);
9087                         vectorize=FALSE;
9088                         goto string;
9089                 }
9090             }
9091             else {
9092                 vecstr = (U8*)"";
9093                 veclen = 0;
9094             }
9095         }
9096
9097         if (asterisk) {
9098             if (args)
9099                 i = va_arg(*args, int);
9100             else
9101                 i = (ewix ? ewix <= svmax : svix < svmax) ?
9102                     SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9103             left |= (i < 0);
9104             width = (i < 0) ? -i : i;
9105         }
9106       gotwidth:
9107
9108         /* PRECISION */
9109
9110         if (*q == '.') {
9111             q++;
9112             if (*q == '*') {
9113                 q++;
9114                 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9115                     goto unknown;
9116                 /* XXX: todo, support specified precision parameter */
9117                 if (epix)
9118                     goto unknown;
9119                 if (args)
9120                     i = va_arg(*args, int);
9121                 else
9122                     i = (ewix ? ewix <= svmax : svix < svmax)
9123                         ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9124                 precis = (i < 0) ? 0 : i;
9125             }
9126             else {
9127                 precis = 0;
9128                 while (isDIGIT(*q))
9129                     precis = precis * 10 + (*q++ - '0');
9130             }
9131             has_precis = TRUE;
9132         }
9133
9134         /* SIZE */
9135
9136         switch (*q) {
9137 #ifdef WIN32
9138         case 'I':                       /* Ix, I32x, and I64x */
9139 #  ifdef WIN64
9140             if (q[1] == '6' && q[2] == '4') {
9141                 q += 3;
9142                 intsize = 'q';
9143                 break;
9144             }
9145 #  endif
9146             if (q[1] == '3' && q[2] == '2') {
9147                 q += 3;
9148                 break;
9149             }
9150 #  ifdef WIN64
9151             intsize = 'q';
9152 #  endif
9153             q++;
9154             break;
9155 #endif
9156 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9157         case 'L':                       /* Ld */
9158             /* FALL THROUGH */
9159 #ifdef HAS_QUAD
9160         case 'q':                       /* qd */
9161 #endif
9162             intsize = 'q';
9163             q++;
9164             break;
9165 #endif
9166         case 'l':
9167 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9168             if (*(q + 1) == 'l') {      /* lld, llf */
9169                 intsize = 'q';
9170                 q += 2;
9171                 break;
9172              }
9173 #endif
9174             /* FALL THROUGH */
9175         case 'h':
9176             /* FALL THROUGH */
9177         case 'V':
9178             intsize = *q++;
9179             break;
9180         }
9181
9182         /* CONVERSION */
9183
9184         if (*q == '%') {
9185             eptr = q++;
9186             elen = 1;
9187             goto string;
9188         }
9189
9190         if (vectorize)
9191             argsv = vecsv;
9192         else if (!args)
9193             argsv = (efix ? efix <= svmax : svix < svmax) ?
9194                     svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9195
9196         switch (c = *q++) {
9197
9198             /* STRINGS */
9199
9200         case 'c':
9201             uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9202             if ((uv > 255 ||
9203                  (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9204                 && !IN_BYTES) {
9205                 eptr = (char*)utf8buf;
9206                 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9207                 is_utf8 = TRUE;
9208             }
9209             else {
9210                 c = (char)uv;
9211                 eptr = &c;
9212                 elen = 1;
9213             }
9214             goto string;
9215
9216         case 's':
9217             if (args && !vectorize) {
9218                 eptr = va_arg(*args, char*);
9219                 if (eptr)
9220 #ifdef MACOS_TRADITIONAL
9221                   /* On MacOS, %#s format is used for Pascal strings */
9222                   if (alt)
9223                     elen = *eptr++;
9224                   else
9225 #endif
9226                     elen = strlen(eptr);
9227                 else {
9228                     eptr = (char *)nullstr;
9229                     elen = sizeof nullstr - 1;
9230                 }
9231             }
9232             else {
9233                 eptr = SvPVx_const(argsv, elen);
9234                 if (DO_UTF8(argsv)) {
9235                     if (has_precis && precis < elen) {
9236                         I32 p = precis;
9237                         sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9238                         precis = p;
9239                     }
9240                     if (width) { /* fudge width (can't fudge elen) */
9241                         width += elen - sv_len_utf8(argsv);
9242                     }
9243                     is_utf8 = TRUE;
9244                 }
9245             }
9246
9247         string:
9248             vectorize = FALSE;
9249             if (has_precis && elen > precis)
9250                 elen = precis;
9251             break;
9252
9253             /* INTEGERS */
9254
9255         case 'p':
9256             if (left && args) {         /* SVf */
9257                 left = FALSE;
9258                 if (width) {
9259                     precis = width;
9260                     has_precis = TRUE;
9261                     width = 0;
9262                 }
9263                 if (vectorize)
9264                     goto unknown;
9265                 argsv = va_arg(*args, SV*);
9266                 eptr = SvPVx_const(argsv, elen);
9267                 if (DO_UTF8(argsv))
9268                     is_utf8 = TRUE;
9269                 goto string;
9270             }
9271             if (alt || vectorize)
9272                 goto unknown;
9273             uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9274             base = 16;
9275             goto integer;
9276
9277         case 'D':
9278 #ifdef IV_IS_QUAD
9279             intsize = 'q';
9280 #else
9281             intsize = 'l';
9282 #endif
9283             /* FALL THROUGH */
9284         case 'd':
9285         case 'i':
9286             if (vectorize) {
9287                 STRLEN ulen;
9288                 if (!veclen)
9289                     continue;
9290                 if (vec_utf8)
9291                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9292                                         UTF8_ALLOW_ANYUV);
9293                 else {
9294                     uv = *vecstr;
9295                     ulen = 1;
9296                 }
9297                 vecstr += ulen;
9298                 veclen -= ulen;
9299                 if (plus)
9300                      esignbuf[esignlen++] = plus;
9301             }
9302             else if (args) {
9303                 switch (intsize) {
9304                 case 'h':       iv = (short)va_arg(*args, int); break;
9305                 case 'l':       iv = va_arg(*args, long); break;
9306                 case 'V':       iv = va_arg(*args, IV); break;
9307                 default:        iv = va_arg(*args, int); break;
9308 #ifdef HAS_QUAD
9309                 case 'q':       iv = va_arg(*args, Quad_t); break;
9310 #endif
9311                 }
9312             }
9313             else {
9314                 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9315                 switch (intsize) {
9316                 case 'h':       iv = (short)tiv; break;
9317                 case 'l':       iv = (long)tiv; break;
9318                 case 'V':
9319                 default:        iv = tiv; break;
9320 #ifdef HAS_QUAD
9321                 case 'q':       iv = (Quad_t)tiv; break;
9322 #endif
9323                 }
9324             }
9325             if ( !vectorize )   /* we already set uv above */
9326             {
9327                 if (iv >= 0) {
9328                     uv = iv;
9329                     if (plus)
9330                         esignbuf[esignlen++] = plus;
9331                 }
9332                 else {
9333                     uv = -iv;
9334                     esignbuf[esignlen++] = '-';
9335                 }
9336             }
9337             base = 10;
9338             goto integer;
9339
9340         case 'U':
9341 #ifdef IV_IS_QUAD
9342             intsize = 'q';
9343 #else
9344             intsize = 'l';
9345 #endif
9346             /* FALL THROUGH */
9347         case 'u':
9348             base = 10;
9349             goto uns_integer;
9350
9351         case 'b':
9352             base = 2;
9353             goto uns_integer;
9354
9355         case 'O':
9356 #ifdef IV_IS_QUAD
9357             intsize = 'q';
9358 #else
9359             intsize = 'l';
9360 #endif
9361             /* FALL THROUGH */
9362         case 'o':
9363             base = 8;
9364             goto uns_integer;
9365
9366         case 'X':
9367         case 'x':
9368             base = 16;
9369
9370         uns_integer:
9371             if (vectorize) {
9372                 STRLEN ulen;
9373         vector:
9374                 if (!veclen)
9375                     continue;
9376                 if (vec_utf8)
9377                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9378                                         UTF8_ALLOW_ANYUV);
9379                 else {
9380                     uv = *vecstr;
9381                     ulen = 1;
9382                 }
9383                 vecstr += ulen;
9384                 veclen -= ulen;
9385             }
9386             else if (args) {
9387                 switch (intsize) {
9388                 case 'h':  uv = (unsigned short)va_arg(*args, unsigned); break;
9389                 case 'l':  uv = va_arg(*args, unsigned long); break;
9390                 case 'V':  uv = va_arg(*args, UV); break;
9391                 default:   uv = va_arg(*args, unsigned); break;
9392 #ifdef HAS_QUAD
9393                 case 'q':  uv = va_arg(*args, Uquad_t); break;
9394 #endif
9395                 }
9396             }
9397             else {
9398                 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9399                 switch (intsize) {
9400                 case 'h':       uv = (unsigned short)tuv; break;
9401                 case 'l':       uv = (unsigned long)tuv; break;
9402                 case 'V':
9403                 default:        uv = tuv; break;
9404 #ifdef HAS_QUAD
9405                 case 'q':       uv = (Uquad_t)tuv; break;
9406 #endif
9407                 }
9408             }
9409
9410         integer:
9411             {
9412                 char *ptr = ebuf + sizeof ebuf;
9413                 switch (base) {
9414                     unsigned dig;
9415                 case 16:
9416                     if (!uv)
9417                         alt = FALSE;
9418                     p = (char*)((c == 'X')
9419                                 ? "0123456789ABCDEF" : "0123456789abcdef");
9420                     do {
9421                         dig = uv & 15;
9422                         *--ptr = p[dig];
9423                     } while (uv >>= 4);
9424                     if (alt) {
9425                         esignbuf[esignlen++] = '0';
9426                         esignbuf[esignlen++] = c;  /* 'x' or 'X' */
9427                     }
9428                     break;
9429                 case 8:
9430                     do {
9431                         dig = uv & 7;
9432                         *--ptr = '0' + dig;
9433                     } while (uv >>= 3);
9434                     if (alt && *ptr != '0')
9435                         *--ptr = '0';
9436                     break;
9437                 case 2:
9438                     do {
9439                         dig = uv & 1;
9440                         *--ptr = '0' + dig;
9441                     } while (uv >>= 1);
9442                     if (alt) {
9443                         esignbuf[esignlen++] = '0';
9444                         esignbuf[esignlen++] = 'b';
9445                     }
9446                     break;
9447                 default:                /* it had better be ten or less */
9448                     do {
9449                         dig = uv % base;
9450                         *--ptr = '0' + dig;
9451                     } while (uv /= base);
9452                     break;
9453                 }
9454                 elen = (ebuf + sizeof ebuf) - ptr;
9455                 eptr = ptr;
9456                 if (has_precis) {
9457                     if (precis > elen)
9458                         zeros = precis - elen;
9459                     else if (precis == 0 && elen == 1 && *eptr == '0')
9460                         elen = 0;
9461                 }
9462             }
9463             break;
9464
9465             /* FLOATING POINT */
9466
9467         case 'F':
9468             c = 'f';            /* maybe %F isn't supported here */
9469             /* FALL THROUGH */
9470         case 'e': case 'E':
9471         case 'f':
9472         case 'g': case 'G':
9473
9474             /* This is evil, but floating point is even more evil */
9475
9476             /* for SV-style calling, we can only get NV
9477                for C-style calling, we assume %f is double;
9478                for simplicity we allow any of %Lf, %llf, %qf for long double
9479             */
9480             switch (intsize) {
9481             case 'V':
9482 #if defined(USE_LONG_DOUBLE)
9483                 intsize = 'q';
9484 #endif
9485                 break;
9486 /* [perl #20339] - we should accept and ignore %lf rather than die */
9487             case 'l':
9488                 /* FALL THROUGH */
9489             default:
9490 #if defined(USE_LONG_DOUBLE)
9491                 intsize = args ? 0 : 'q';
9492 #endif
9493                 break;
9494             case 'q':
9495 #if defined(HAS_LONG_DOUBLE)
9496                 break;
9497 #else
9498                 /* FALL THROUGH */
9499 #endif
9500             case 'h':
9501                 goto unknown;
9502             }
9503
9504             /* now we need (long double) if intsize == 'q', else (double) */
9505             nv = (args && !vectorize) ?
9506 #if LONG_DOUBLESIZE > DOUBLESIZE
9507                 intsize == 'q' ?
9508                     va_arg(*args, long double) :
9509                     va_arg(*args, double)
9510 #else
9511                     va_arg(*args, double)
9512 #endif
9513                 : SvNVx(argsv);
9514
9515             need = 0;
9516             vectorize = FALSE;
9517             if (c != 'e' && c != 'E') {
9518                 i = PERL_INT_MIN;
9519                 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9520                    will cast our (long double) to (double) */
9521                 (void)Perl_frexp(nv, &i);
9522                 if (i == PERL_INT_MIN)
9523                     Perl_die(aTHX_ "panic: frexp");
9524                 if (i > 0)
9525                     need = BIT_DIGITS(i);
9526             }
9527             need += has_precis ? precis : 6; /* known default */
9528
9529             if (need < width)
9530                 need = width;
9531
9532 #ifdef HAS_LDBL_SPRINTF_BUG
9533             /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9534                with sfio - Allen <allens@cpan.org> */
9535
9536 #  ifdef DBL_MAX
9537 #    define MY_DBL_MAX DBL_MAX
9538 #  else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9539 #    if DOUBLESIZE >= 8
9540 #      define MY_DBL_MAX 1.7976931348623157E+308L
9541 #    else
9542 #      define MY_DBL_MAX 3.40282347E+38L
9543 #    endif
9544 #  endif
9545
9546 #  ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9547 #    define MY_DBL_MAX_BUG 1L
9548 #  else
9549 #    define MY_DBL_MAX_BUG MY_DBL_MAX
9550 #  endif
9551
9552 #  ifdef DBL_MIN
9553 #    define MY_DBL_MIN DBL_MIN
9554 #  else  /* XXX guessing! -Allen */
9555 #    if DOUBLESIZE >= 8
9556 #      define MY_DBL_MIN 2.2250738585072014E-308L
9557 #    else
9558 #      define MY_DBL_MIN 1.17549435E-38L
9559 #    endif
9560 #  endif
9561
9562             if ((intsize == 'q') && (c == 'f') &&
9563                 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9564                 (need < DBL_DIG)) {
9565                 /* it's going to be short enough that
9566                  * long double precision is not needed */
9567
9568                 if ((nv <= 0L) && (nv >= -0L))
9569                     fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9570                 else {
9571                     /* would use Perl_fp_class as a double-check but not
9572                      * functional on IRIX - see perl.h comments */
9573
9574                     if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9575                         /* It's within the range that a double can represent */
9576 #if defined(DBL_MAX) && !defined(DBL_MIN)
9577                         if ((nv >= ((long double)1/DBL_MAX)) ||
9578                             (nv <= (-(long double)1/DBL_MAX)))
9579 #endif
9580                         fix_ldbl_sprintf_bug = TRUE;
9581                     }
9582                 }
9583                 if (fix_ldbl_sprintf_bug == TRUE) {
9584                     double temp;
9585
9586                     intsize = 0;
9587                     temp = (double)nv;
9588                     nv = (NV)temp;
9589                 }
9590             }
9591
9592 #  undef MY_DBL_MAX
9593 #  undef MY_DBL_MAX_BUG
9594 #  undef MY_DBL_MIN
9595
9596 #endif /* HAS_LDBL_SPRINTF_BUG */
9597
9598             need += 20; /* fudge factor */
9599             if (PL_efloatsize < need) {
9600                 Safefree(PL_efloatbuf);
9601                 PL_efloatsize = need + 20; /* more fudge */
9602                 Newx(PL_efloatbuf, PL_efloatsize, char);
9603                 PL_efloatbuf[0] = '\0';
9604             }
9605
9606             if ( !(width || left || plus || alt) && fill != '0'
9607                  && has_precis && intsize != 'q' ) {    /* Shortcuts */
9608                 /* See earlier comment about buggy Gconvert when digits,
9609                    aka precis is 0  */
9610                 if ( c == 'g' && precis) {
9611                     Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9612                     if (*PL_efloatbuf)  /* May return an empty string for digits==0 */
9613                         goto float_converted;
9614                 } else if ( c == 'f' && !precis) {
9615                     if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9616                         break;
9617                 }
9618             }
9619             {
9620                 char *ptr = ebuf + sizeof ebuf;
9621                 *--ptr = '\0';
9622                 *--ptr = c;
9623                 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9624 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9625                 if (intsize == 'q') {
9626                     /* Copy the one or more characters in a long double
9627                      * format before the 'base' ([efgEFG]) character to
9628                      * the format string. */
9629                     static char const prifldbl[] = PERL_PRIfldbl;
9630                     char const *p = prifldbl + sizeof(prifldbl) - 3;
9631                     while (p >= prifldbl) { *--ptr = *p--; }
9632                 }
9633 #endif
9634                 if (has_precis) {
9635                     base = precis;
9636                     do { *--ptr = '0' + (base % 10); } while (base /= 10);
9637                     *--ptr = '.';
9638                 }
9639                 if (width) {
9640                     base = width;
9641                     do { *--ptr = '0' + (base % 10); } while (base /= 10);
9642                 }
9643                 if (fill == '0')
9644                     *--ptr = fill;
9645                 if (left)
9646                     *--ptr = '-';
9647                 if (plus)
9648                     *--ptr = plus;
9649                 if (alt)
9650                     *--ptr = '#';
9651                 *--ptr = '%';
9652
9653                 /* No taint.  Otherwise we are in the strange situation
9654                  * where printf() taints but print($float) doesn't.
9655                  * --jhi */
9656 #if defined(HAS_LONG_DOUBLE)
9657                 if (intsize == 'q')
9658                     (void)sprintf(PL_efloatbuf, ptr, nv);
9659                 else
9660                     (void)sprintf(PL_efloatbuf, ptr, (double)nv);
9661 #else
9662                 (void)sprintf(PL_efloatbuf, ptr, nv);
9663 #endif
9664             }
9665         float_converted:
9666             eptr = PL_efloatbuf;
9667             elen = strlen(PL_efloatbuf);
9668             break;
9669
9670             /* SPECIAL */
9671
9672         case 'n':
9673             i = SvCUR(sv) - origlen;
9674             if (args && !vectorize) {
9675                 switch (intsize) {
9676                 case 'h':       *(va_arg(*args, short*)) = i; break;
9677                 default:        *(va_arg(*args, int*)) = i; break;
9678                 case 'l':       *(va_arg(*args, long*)) = i; break;
9679                 case 'V':       *(va_arg(*args, IV*)) = i; break;
9680 #ifdef HAS_QUAD
9681                 case 'q':       *(va_arg(*args, Quad_t*)) = i; break;
9682 #endif
9683                 }
9684             }
9685             else
9686                 sv_setuv_mg(argsv, (UV)i);
9687             vectorize = FALSE;
9688             continue;   /* not "break" */
9689
9690             /* UNKNOWN */
9691
9692         default:
9693       unknown:
9694             if (!args
9695                 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9696                 && ckWARN(WARN_PRINTF))
9697             {
9698                 SV *msg = sv_newmortal();
9699                 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9700                           (PL_op->op_type == OP_PRTF) ? "" : "s");
9701                 if (c) {
9702                     if (isPRINT(c))
9703                         Perl_sv_catpvf(aTHX_ msg,
9704                                        "\"%%%c\"", c & 0xFF);
9705                     else
9706                         Perl_sv_catpvf(aTHX_ msg,
9707                                        "\"%%\\%03"UVof"\"",
9708                                        (UV)c & 0xFF);
9709                 } else
9710                     sv_catpv(msg, "end of string");
9711                 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9712             }
9713
9714             /* output mangled stuff ... */
9715             if (c == '\0')
9716                 --q;
9717             eptr = p;
9718             elen = q - p;
9719
9720             /* ... right here, because formatting flags should not apply */
9721             SvGROW(sv, SvCUR(sv) + elen + 1);
9722             p = SvEND(sv);
9723             Copy(eptr, p, elen, char);
9724             p += elen;
9725             *p = '\0';
9726             SvCUR_set(sv, p - SvPVX_const(sv));
9727             svix = osvix;
9728             continue;   /* not "break" */
9729         }
9730
9731         /* calculate width before utf8_upgrade changes it */
9732         have = esignlen + zeros + elen;
9733
9734         if (is_utf8 != has_utf8) {
9735              if (is_utf8) {
9736                   if (SvCUR(sv))
9737                        sv_utf8_upgrade(sv);
9738              }
9739              else {
9740                   SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9741                   sv_utf8_upgrade(nsv);
9742                   eptr = SvPVX_const(nsv);
9743                   elen = SvCUR(nsv);
9744              }
9745              SvGROW(sv, SvCUR(sv) + elen + 1);
9746              p = SvEND(sv);
9747              *p = '\0';
9748         }
9749
9750         need = (have > width ? have : width);
9751         gap = need - have;
9752
9753         SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9754         p = SvEND(sv);
9755         if (esignlen && fill == '0') {
9756             int i;
9757             for (i = 0; i < (int)esignlen; i++)
9758                 *p++ = esignbuf[i];
9759         }
9760         if (gap && !left) {
9761             memset(p, fill, gap);
9762             p += gap;
9763         }
9764         if (esignlen && fill != '0') {
9765             int i;
9766             for (i = 0; i < (int)esignlen; i++)
9767                 *p++ = esignbuf[i];
9768         }
9769         if (zeros) {
9770             int i;
9771             for (i = zeros; i; i--)
9772                 *p++ = '0';
9773         }
9774         if (elen) {
9775             Copy(eptr, p, elen, char);
9776             p += elen;
9777         }
9778         if (gap && left) {
9779             memset(p, ' ', gap);
9780             p += gap;
9781         }
9782         if (vectorize) {
9783             if (veclen) {
9784                 Copy(dotstr, p, dotstrlen, char);
9785                 p += dotstrlen;
9786             }
9787             else
9788                 vectorize = FALSE;              /* done iterating over vecstr */
9789         }
9790         if (is_utf8)
9791             has_utf8 = TRUE;
9792         if (has_utf8)
9793             SvUTF8_on(sv);
9794         *p = '\0';
9795         SvCUR_set(sv, p - SvPVX_const(sv));
9796         if (vectorize) {
9797             esignlen = 0;
9798             goto vector;
9799         }
9800     }
9801 }
9802
9803 /* =========================================================================
9804
9805 =head1 Cloning an interpreter
9806
9807 All the macros and functions in this section are for the private use of
9808 the main function, perl_clone().
9809
9810 The foo_dup() functions make an exact copy of an existing foo thinngy.
9811 During the course of a cloning, a hash table is used to map old addresses
9812 to new addresses. The table is created and manipulated with the
9813 ptr_table_* functions.
9814
9815 =cut
9816
9817 ============================================================================*/
9818
9819
9820 #if defined(USE_ITHREADS)
9821
9822 #ifndef GpREFCNT_inc
9823 #  define GpREFCNT_inc(gp)      ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9824 #endif
9825
9826
9827 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9828 #define av_dup(s,t)     (AV*)sv_dup((SV*)s,t)
9829 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9830 #define hv_dup(s,t)     (HV*)sv_dup((SV*)s,t)
9831 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9832 #define cv_dup(s,t)     (CV*)sv_dup((SV*)s,t)
9833 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9834 #define io_dup(s,t)     (IO*)sv_dup((SV*)s,t)
9835 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9836 #define gv_dup(s,t)     (GV*)sv_dup((SV*)s,t)
9837 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9838 #define SAVEPV(p)       (p ? savepv(p) : Nullch)
9839 #define SAVEPVN(p,n)    (p ? savepvn(p,n) : Nullch)
9840
9841
9842 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9843    regcomp.c. AMS 20010712 */
9844
9845 REGEXP *
9846 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9847 {
9848     dVAR;
9849     REGEXP *ret;
9850     int i, len, npar;
9851     struct reg_substr_datum *s;
9852
9853     if (!r)
9854         return (REGEXP *)NULL;
9855
9856     if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9857         return ret;
9858
9859     len = r->offsets[0];
9860     npar = r->nparens+1;
9861
9862     Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9863     Copy(r->program, ret->program, len+1, regnode);
9864
9865     Newx(ret->startp, npar, I32);
9866     Copy(r->startp, ret->startp, npar, I32);
9867     Newx(ret->endp, npar, I32);
9868     Copy(r->startp, ret->startp, npar, I32);
9869
9870     Newx(ret->substrs, 1, struct reg_substr_data);
9871     for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9872         s->min_offset = r->substrs->data[i].min_offset;
9873         s->max_offset = r->substrs->data[i].max_offset;
9874         s->substr     = sv_dup_inc(r->substrs->data[i].substr, param);
9875         s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9876     }
9877
9878     ret->regstclass = NULL;
9879     if (r->data) {
9880         struct reg_data *d;
9881         const int count = r->data->count;
9882         int i;
9883
9884         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9885                 char, struct reg_data);
9886         Newx(d->what, count, U8);
9887
9888         d->count = count;
9889         for (i = 0; i < count; i++) {
9890             d->what[i] = r->data->what[i];
9891             switch (d->what[i]) {
9892                 /* legal options are one of: sfpont
9893                    see also regcomp.h and pregfree() */
9894             case 's':
9895                 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9896                 break;
9897             case 'p':
9898                 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9899                 break;
9900             case 'f':
9901                 /* This is cheating. */
9902                 Newx(d->data[i], 1, struct regnode_charclass_class);
9903                 StructCopy(r->data->data[i], d->data[i],
9904                             struct regnode_charclass_class);
9905                 ret->regstclass = (regnode*)d->data[i];
9906                 break;
9907             case 'o':
9908                 /* Compiled op trees are readonly, and can thus be
9909                    shared without duplication. */
9910                 OP_REFCNT_LOCK;
9911                 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9912                 OP_REFCNT_UNLOCK;
9913                 break;
9914             case 'n':
9915                 d->data[i] = r->data->data[i];
9916                 break;
9917             case 't':
9918                 d->data[i] = r->data->data[i];
9919                 OP_REFCNT_LOCK;
9920                 ((reg_trie_data*)d->data[i])->refcount++;
9921                 OP_REFCNT_UNLOCK;
9922                 break;
9923             default:
9924                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9925             }
9926         }
9927
9928         ret->data = d;
9929     }
9930     else
9931         ret->data = NULL;
9932
9933     Newx(ret->offsets, 2*len+1, U32);
9934     Copy(r->offsets, ret->offsets, 2*len+1, U32);
9935
9936     ret->precomp        = SAVEPVN(r->precomp, r->prelen);
9937     ret->refcnt         = r->refcnt;
9938     ret->minlen         = r->minlen;
9939     ret->prelen         = r->prelen;
9940     ret->nparens        = r->nparens;
9941     ret->lastparen      = r->lastparen;
9942     ret->lastcloseparen = r->lastcloseparen;
9943     ret->reganch        = r->reganch;
9944
9945     ret->sublen         = r->sublen;
9946
9947     if (RX_MATCH_COPIED(ret))
9948         ret->subbeg  = SAVEPVN(r->subbeg, r->sublen);
9949     else
9950         ret->subbeg = Nullch;
9951 #ifdef PERL_OLD_COPY_ON_WRITE
9952     ret->saved_copy = Nullsv;
9953 #endif
9954
9955     ptr_table_store(PL_ptr_table, r, ret);
9956     return ret;
9957 }
9958
9959 /* duplicate a file handle */
9960
9961 PerlIO *
9962 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9963 {
9964     PerlIO *ret;
9965
9966     PERL_UNUSED_ARG(type);
9967
9968     if (!fp)
9969         return (PerlIO*)NULL;
9970
9971     /* look for it in the table first */
9972     ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9973     if (ret)
9974         return ret;
9975
9976     /* create anew and remember what it is */
9977     ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9978     ptr_table_store(PL_ptr_table, fp, ret);
9979     return ret;
9980 }
9981
9982 /* duplicate a directory handle */
9983
9984 DIR *
9985 Perl_dirp_dup(pTHX_ DIR *dp)
9986 {
9987     if (!dp)
9988         return (DIR*)NULL;
9989     /* XXX TODO */
9990     return dp;
9991 }
9992
9993 /* duplicate a typeglob */
9994
9995 GP *
9996 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9997 {
9998     GP *ret;
9999     if (!gp)
10000         return (GP*)NULL;
10001     /* look for it in the table first */
10002     ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10003     if (ret)
10004         return ret;
10005
10006     /* create anew and remember what it is */
10007     Newxz(ret, 1, GP);
10008     ptr_table_store(PL_ptr_table, gp, ret);
10009
10010     /* clone */
10011     ret->gp_refcnt      = 0;                    /* must be before any other dups! */
10012     ret->gp_sv          = sv_dup_inc(gp->gp_sv, param);
10013     ret->gp_io          = io_dup_inc(gp->gp_io, param);
10014     ret->gp_form        = cv_dup_inc(gp->gp_form, param);
10015     ret->gp_av          = av_dup_inc(gp->gp_av, param);
10016     ret->gp_hv          = hv_dup_inc(gp->gp_hv, param);
10017     ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10018     ret->gp_cv          = cv_dup_inc(gp->gp_cv, param);
10019     ret->gp_cvgen       = gp->gp_cvgen;
10020     ret->gp_line        = gp->gp_line;
10021     ret->gp_file        = gp->gp_file;          /* points to COP.cop_file */
10022     return ret;
10023 }
10024
10025 /* duplicate a chain of magic */
10026
10027 MAGIC *
10028 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10029 {
10030     MAGIC *mgprev = (MAGIC*)NULL;
10031     MAGIC *mgret;
10032     if (!mg)
10033         return (MAGIC*)NULL;
10034     /* look for it in the table first */
10035     mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10036     if (mgret)
10037         return mgret;
10038
10039     for (; mg; mg = mg->mg_moremagic) {
10040         MAGIC *nmg;
10041         Newxz(nmg, 1, MAGIC);
10042         if (mgprev)
10043             mgprev->mg_moremagic = nmg;
10044         else
10045             mgret = nmg;
10046         nmg->mg_virtual = mg->mg_virtual;       /* XXX copy dynamic vtable? */
10047         nmg->mg_private = mg->mg_private;
10048         nmg->mg_type    = mg->mg_type;
10049         nmg->mg_flags   = mg->mg_flags;
10050         if (mg->mg_type == PERL_MAGIC_qr) {
10051             nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10052         }
10053         else if(mg->mg_type == PERL_MAGIC_backref) {
10054             const AV * const av = (AV*) mg->mg_obj;
10055             SV **svp;
10056             I32 i;
10057             (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10058             svp = AvARRAY(av);
10059             for (i = AvFILLp(av); i >= 0; i--) {
10060                 if (!svp[i]) continue;
10061                 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10062             }
10063         }
10064         else if (mg->mg_type == PERL_MAGIC_symtab) {
10065             nmg->mg_obj = mg->mg_obj;
10066         }
10067         else {
10068             nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10069                               ? sv_dup_inc(mg->mg_obj, param)
10070                               : sv_dup(mg->mg_obj, param);
10071         }
10072         nmg->mg_len     = mg->mg_len;
10073         nmg->mg_ptr     = mg->mg_ptr;   /* XXX random ptr? */
10074         if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10075             if (mg->mg_len > 0) {
10076                 nmg->mg_ptr     = SAVEPVN(mg->mg_ptr, mg->mg_len);
10077                 if (mg->mg_type == PERL_MAGIC_overload_table &&
10078                         AMT_AMAGIC((AMT*)mg->mg_ptr))
10079                 {
10080                     AMT *amtp = (AMT*)mg->mg_ptr;
10081                     AMT *namtp = (AMT*)nmg->mg_ptr;
10082                     I32 i;
10083                     for (i = 1; i < NofAMmeth; i++) {
10084                         namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10085                     }
10086                 }
10087             }
10088             else if (mg->mg_len == HEf_SVKEY)
10089                 nmg->mg_ptr     = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10090         }
10091         if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10092             CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10093         }
10094         mgprev = nmg;
10095     }
10096     return mgret;
10097 }
10098
10099 /* create a new pointer-mapping table */
10100
10101 PTR_TBL_t *
10102 Perl_ptr_table_new(pTHX)
10103 {
10104     PTR_TBL_t *tbl;
10105     Newxz(tbl, 1, PTR_TBL_t);
10106     tbl->tbl_max        = 511;
10107     tbl->tbl_items      = 0;
10108     Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10109     return tbl;
10110 }
10111
10112 #if (PTRSIZE == 8)
10113 #  define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10114 #else
10115 #  define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10116 #endif
10117
10118 #define del_pte(p)      del_body_type(p, struct ptr_tbl_ent, pte)
10119
10120 /* map an existing pointer using a table */
10121
10122 void *
10123 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10124 {
10125     PTR_TBL_ENT_t *tblent;
10126     const UV hash = PTR_TABLE_HASH(sv);
10127     assert(tbl);
10128     tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10129     for (; tblent; tblent = tblent->next) {
10130         if (tblent->oldval == sv)
10131             return tblent->newval;
10132     }
10133     return (void*)NULL;
10134 }
10135
10136 /* add a new entry to a pointer-mapping table */
10137
10138 void
10139 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldv, void *newv)
10140 {
10141     PTR_TBL_ENT_t *tblent, **otblent;
10142     /* XXX this may be pessimal on platforms where pointers aren't good
10143      * hash values e.g. if they grow faster in the most significant
10144      * bits */
10145     const UV hash = PTR_TABLE_HASH(oldv);
10146     bool empty = 1;
10147
10148     assert(tbl);
10149     otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10150     for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10151         if (tblent->oldval == oldv) {
10152             tblent->newval = newv;
10153             return;
10154         }
10155     }
10156     new_body_inline(tblent, (void**)&PL_pte_arenaroot, (void**)&PL_pte_root,
10157                     sizeof(struct ptr_tbl_ent));
10158     tblent->oldval = oldv;
10159     tblent->newval = newv;
10160     tblent->next = *otblent;
10161     *otblent = tblent;
10162     tbl->tbl_items++;
10163     if (!empty && tbl->tbl_items > tbl->tbl_max)
10164         ptr_table_split(tbl);
10165 }
10166
10167 /* double the hash bucket size of an existing ptr table */
10168
10169 void
10170 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10171 {
10172     PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10173     const UV oldsize = tbl->tbl_max + 1;
10174     UV newsize = oldsize * 2;
10175     UV i;
10176
10177     Renew(ary, newsize, PTR_TBL_ENT_t*);
10178     Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10179     tbl->tbl_max = --newsize;
10180     tbl->tbl_ary = ary;
10181     for (i=0; i < oldsize; i++, ary++) {
10182         PTR_TBL_ENT_t **curentp, **entp, *ent;
10183         if (!*ary)
10184             continue;
10185         curentp = ary + oldsize;
10186         for (entp = ary, ent = *ary; ent; ent = *entp) {
10187             if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10188                 *entp = ent->next;
10189                 ent->next = *curentp;
10190                 *curentp = ent;
10191                 continue;
10192             }
10193             else
10194                 entp = &ent->next;
10195         }
10196     }
10197 }
10198
10199 /* remove all the entries from a ptr table */
10200
10201 void
10202 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10203 {
10204     register PTR_TBL_ENT_t **array;
10205     register PTR_TBL_ENT_t *entry;
10206     UV riter = 0;
10207     UV max;
10208
10209     if (!tbl || !tbl->tbl_items) {
10210         return;
10211     }
10212
10213     array = tbl->tbl_ary;
10214     entry = array[0];
10215     max = tbl->tbl_max;
10216
10217     for (;;) {
10218         if (entry) {
10219             PTR_TBL_ENT_t *oentry = entry;
10220             entry = entry->next;
10221             del_pte(oentry);
10222         }
10223         if (!entry) {
10224             if (++riter > max) {
10225                 break;
10226             }
10227             entry = array[riter];
10228         }
10229     }
10230
10231     tbl->tbl_items = 0;
10232 }
10233
10234 /* clear and free a ptr table */
10235
10236 void
10237 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10238 {
10239     if (!tbl) {
10240         return;
10241     }
10242     ptr_table_clear(tbl);
10243     Safefree(tbl->tbl_ary);
10244     Safefree(tbl);
10245 }
10246
10247
10248 void
10249 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10250 {
10251     if (SvROK(sstr)) {
10252         SvRV_set(dstr, SvWEAKREF(sstr)
10253                        ? sv_dup(SvRV(sstr), param)
10254                        : sv_dup_inc(SvRV(sstr), param));
10255
10256     }
10257     else if (SvPVX_const(sstr)) {
10258         /* Has something there */
10259         if (SvLEN(sstr)) {
10260             /* Normal PV - clone whole allocated space */
10261             SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10262             if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10263                 /* Not that normal - actually sstr is copy on write.
10264                    But we are a true, independant SV, so:  */
10265                 SvREADONLY_off(dstr);
10266                 SvFAKE_off(dstr);
10267             }
10268         }
10269         else {
10270             /* Special case - not normally malloced for some reason */
10271             if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10272                 /* A "shared" PV - clone it as "shared" PV */
10273                 SvPV_set(dstr,
10274                          HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10275                                          param)));
10276             }
10277             else {
10278                 /* Some other special case - random pointer */
10279                 SvPV_set(dstr, SvPVX(sstr));
10280             }
10281         }
10282     }
10283     else {
10284         /* Copy the Null */
10285         if (SvTYPE(dstr) == SVt_RV)
10286             SvRV_set(dstr, NULL);
10287         else
10288             SvPV_set(dstr, 0);
10289     }
10290 }
10291
10292 /* duplicate an SV of any type (including AV, HV etc) */
10293
10294 SV *
10295 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10296 {
10297     dVAR;
10298     SV *dstr;
10299
10300     if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10301         return Nullsv;
10302     /* look for it in the table first */
10303     dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10304     if (dstr)
10305         return dstr;
10306
10307     if(param->flags & CLONEf_JOIN_IN) {
10308         /** We are joining here so we don't want do clone
10309             something that is bad **/
10310         const char *hvname;
10311
10312         if(SvTYPE(sstr) == SVt_PVHV &&
10313            (hvname = HvNAME_get(sstr))) {
10314             /** don't clone stashes if they already exist **/
10315             HV* old_stash = gv_stashpv(hvname,0);
10316             return (SV*) old_stash;
10317         }
10318     }
10319
10320     /* create anew and remember what it is */
10321     new_SV(dstr);
10322
10323 #ifdef DEBUG_LEAKING_SCALARS
10324     dstr->sv_debug_optype = sstr->sv_debug_optype;
10325     dstr->sv_debug_line = sstr->sv_debug_line;
10326     dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10327     dstr->sv_debug_cloned = 1;
10328 #  ifdef NETWARE
10329     dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10330 #  else
10331     dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10332 #  endif
10333 #endif
10334
10335     ptr_table_store(PL_ptr_table, sstr, dstr);
10336
10337     /* clone */
10338     SvFLAGS(dstr)       = SvFLAGS(sstr);
10339     SvFLAGS(dstr)       &= ~SVf_OOK;            /* don't propagate OOK hack */
10340     SvREFCNT(dstr)      = 0;                    /* must be before any other dups! */
10341
10342 #ifdef DEBUGGING
10343     if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10344         PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10345                       PL_watch_pvx, SvPVX_const(sstr));
10346 #endif
10347
10348     /* don't clone objects whose class has asked us not to */
10349     if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10350         SvFLAGS(dstr) &= ~SVTYPEMASK;
10351         SvOBJECT_off(dstr);
10352         return dstr;
10353     }
10354
10355     switch (SvTYPE(sstr)) {
10356     case SVt_NULL:
10357         SvANY(dstr)     = NULL;
10358         break;
10359     case SVt_IV:
10360         SvANY(dstr)     = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10361         SvIV_set(dstr, SvIVX(sstr));
10362         break;
10363     case SVt_NV:
10364         SvANY(dstr)     = new_XNV();
10365         SvNV_set(dstr, SvNVX(sstr));
10366         break;
10367     case SVt_RV:
10368         SvANY(dstr)     = &(dstr->sv_u.svu_rv);
10369         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10370         break;
10371     default:
10372         {
10373             /* These are all the types that need complex bodies allocating.  */
10374             size_t new_body_length;
10375             size_t new_body_offset = 0;
10376             void **new_body_arena;
10377             void **new_body_arenaroot;
10378             void *new_body;
10379
10380             switch (SvTYPE(sstr)) {
10381             default:
10382                 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
10383                            (IV)SvTYPE(sstr));
10384                 break;
10385
10386             case SVt_PVIO:
10387                 new_body = new_XPVIO();
10388                 new_body_length = sizeof(XPVIO);
10389                 break;
10390             case SVt_PVFM:
10391                 new_body = new_XPVFM();
10392                 new_body_length = sizeof(XPVFM);
10393                 break;
10394
10395             case SVt_PVHV:
10396                 new_body_arena = (void **) &PL_xpvhv_root;
10397                 new_body_arenaroot = (void **) &PL_xpvhv_arenaroot;
10398                 new_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill)
10399                     - STRUCT_OFFSET(xpvhv_allocated, xhv_fill);
10400                 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10401                     + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10402                     - new_body_offset;
10403                 goto new_body;
10404             case SVt_PVAV:
10405                 new_body_arena = (void **) &PL_xpvav_root;
10406                 new_body_arenaroot = (void **) &PL_xpvav_arenaroot;
10407                 new_body_offset = STRUCT_OFFSET(XPVAV, xav_fill)
10408                     - STRUCT_OFFSET(xpvav_allocated, xav_fill);
10409                 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10410                     + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10411                     - new_body_offset;
10412                 goto new_body;
10413             case SVt_PVBM:
10414                 new_body_length = sizeof(XPVBM);
10415                 new_body_arena = (void **) &PL_xpvbm_root;
10416                 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
10417                 goto new_body;
10418             case SVt_PVGV:
10419                 if (GvUNIQUE((GV*)sstr)) {
10420                     /* Do sharing here.  */
10421                 }
10422                 new_body_length = sizeof(XPVGV);
10423                 new_body_arena = (void **) &PL_xpvgv_root;
10424                 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
10425                 goto new_body;
10426             case SVt_PVCV:
10427                 new_body_length = sizeof(XPVCV);
10428                 new_body_arena = (void **) &PL_xpvcv_root;
10429                 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
10430                 goto new_body;
10431             case SVt_PVLV:
10432                 new_body_length = sizeof(XPVLV);
10433                 new_body_arena = (void **) &PL_xpvlv_root;
10434                 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
10435                 goto new_body;
10436             case SVt_PVMG:
10437                 new_body_length = sizeof(XPVMG);
10438                 new_body_arena = (void **) &PL_xpvmg_root;
10439                 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
10440                 goto new_body;
10441             case SVt_PVNV:
10442                 new_body_length = sizeof(XPVNV);
10443                 new_body_arena = (void **) &PL_xpvnv_root;
10444                 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
10445                 goto new_body;
10446             case SVt_PVIV:
10447                 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
10448                     - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
10449                 new_body_length = sizeof(XPVIV) - new_body_offset;
10450                 new_body_arena = (void **) &PL_xpviv_root;
10451                 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
10452                 goto new_body;
10453             case SVt_PV:
10454                 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
10455                     - STRUCT_OFFSET(xpv_allocated, xpv_cur);
10456                 new_body_length = sizeof(XPV) - new_body_offset;
10457                 new_body_arena = (void **) &PL_xpv_root;
10458                 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
10459             new_body:
10460                 assert(new_body_length);
10461 #ifndef PURIFY
10462                 new_body_inline(new_body, new_body_arenaroot, new_body_arena,
10463                                 new_body_length);
10464                 new_body = (void*)((char*)new_body - new_body_offset);
10465 #else
10466                 /* We always allocated the full length item with PURIFY */
10467                 new_body_length += new_body_offset;
10468                 new_body_offset = 0;
10469                 new_body = my_safemalloc(new_body_length);
10470 #endif
10471             }
10472             assert(new_body);
10473             SvANY(dstr) = new_body;
10474
10475             Copy(((char*)SvANY(sstr)) + new_body_offset,
10476                  ((char*)SvANY(dstr)) + new_body_offset,
10477                  new_body_length, char);
10478
10479             if (SvTYPE(sstr) != SVt_PVAV && SvTYPE(sstr) != SVt_PVHV)
10480                 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10481
10482             /* The Copy above means that all the source (unduplicated) pointers
10483                are now in the destination.  We can check the flags and the
10484                pointers in either, but it's possible that there's less cache
10485                missing by always going for the destination.
10486                FIXME - instrument and check that assumption  */
10487             if (SvTYPE(sstr) >= SVt_PVMG) {
10488                 if (SvMAGIC(dstr))
10489                     SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10490                 if (SvSTASH(dstr))
10491                     SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10492             }
10493
10494             switch (SvTYPE(sstr)) {
10495             case SVt_PV:
10496                 break;
10497             case SVt_PVIV:
10498                 break;
10499             case SVt_PVNV:
10500                 break;
10501             case SVt_PVMG:
10502                 break;
10503             case SVt_PVBM:
10504                 break;
10505             case SVt_PVLV:
10506                 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10507                 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10508                     LvTARG(dstr) = dstr;
10509                 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10510                     LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10511                 else
10512                     LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10513                 break;
10514             case SVt_PVGV:
10515                 GvNAME(dstr)    = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
10516                 GvSTASH(dstr)   = hv_dup(GvSTASH(dstr), param);
10517                 /* Don't call sv_add_backref here as it's going to be created
10518                    as part of the magic cloning of the symbol table.  */
10519                 GvGP(dstr)      = gp_dup(GvGP(dstr), param);
10520                 (void)GpREFCNT_inc(GvGP(dstr));
10521                 break;
10522             case SVt_PVIO:
10523                 IoIFP(dstr)     = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10524                 if (IoOFP(dstr) == IoIFP(sstr))
10525                     IoOFP(dstr) = IoIFP(dstr);
10526                 else
10527                     IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10528                 /* PL_rsfp_filters entries have fake IoDIRP() */
10529                 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
10530                     IoDIRP(dstr)        = dirp_dup(IoDIRP(dstr));
10531                 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10532                     /* I have no idea why fake dirp (rsfps)
10533                        should be treated differently but otherwise
10534                        we end up with leaks -- sky*/
10535                     IoTOP_GV(dstr)      = gv_dup_inc(IoTOP_GV(dstr), param);
10536                     IoFMT_GV(dstr)      = gv_dup_inc(IoFMT_GV(dstr), param);
10537                     IoBOTTOM_GV(dstr)   = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10538                 } else {
10539                     IoTOP_GV(dstr)      = gv_dup(IoTOP_GV(dstr), param);
10540                     IoFMT_GV(dstr)      = gv_dup(IoFMT_GV(dstr), param);
10541                     IoBOTTOM_GV(dstr)   = gv_dup(IoBOTTOM_GV(dstr), param);
10542                 }
10543                 IoTOP_NAME(dstr)        = SAVEPV(IoTOP_NAME(dstr));
10544                 IoFMT_NAME(dstr)        = SAVEPV(IoFMT_NAME(dstr));
10545                 IoBOTTOM_NAME(dstr)     = SAVEPV(IoBOTTOM_NAME(dstr));
10546                 break;
10547             case SVt_PVAV:
10548                 if (AvARRAY((AV*)sstr)) {
10549                     SV **dst_ary, **src_ary;
10550                     SSize_t items = AvFILLp((AV*)sstr) + 1;
10551
10552                     src_ary = AvARRAY((AV*)sstr);
10553                     Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10554                     ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10555                     SvPV_set(dstr, (char*)dst_ary);
10556                     AvALLOC((AV*)dstr) = dst_ary;
10557                     if (AvREAL((AV*)sstr)) {
10558                         while (items-- > 0)
10559                             *dst_ary++ = sv_dup_inc(*src_ary++, param);
10560                     }
10561                     else {
10562                         while (items-- > 0)
10563                             *dst_ary++ = sv_dup(*src_ary++, param);
10564                     }
10565                     items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10566                     while (items-- > 0) {
10567                         *dst_ary++ = &PL_sv_undef;
10568                     }
10569                 }
10570                 else {
10571                     SvPV_set(dstr, Nullch);
10572                     AvALLOC((AV*)dstr)  = (SV**)NULL;
10573                 }
10574                 break;
10575             case SVt_PVHV:
10576                 {
10577                     HEK *hvname = 0;
10578
10579                     if (HvARRAY((HV*)sstr)) {
10580                         STRLEN i = 0;
10581                         const bool sharekeys = !!HvSHAREKEYS(sstr);
10582                         XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10583                         XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10584                         char *darray;
10585                         Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10586                             + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10587                             char);
10588                         HvARRAY(dstr) = (HE**)darray;
10589                         while (i <= sxhv->xhv_max) {
10590                             HE *source = HvARRAY(sstr)[i];
10591                             HvARRAY(dstr)[i] = source
10592                                 ? he_dup(source, sharekeys, param) : 0;
10593                             ++i;
10594                         }
10595                         if (SvOOK(sstr)) {
10596                             struct xpvhv_aux *saux = HvAUX(sstr);
10597                             struct xpvhv_aux *daux = HvAUX(dstr);
10598                             /* This flag isn't copied.  */
10599                             /* SvOOK_on(hv) attacks the IV flags.  */
10600                             SvFLAGS(dstr) |= SVf_OOK;
10601
10602                             hvname = saux->xhv_name;
10603                             daux->xhv_name
10604                                 = hvname ? hek_dup(hvname, param) : hvname;
10605
10606                             daux->xhv_riter = saux->xhv_riter;
10607                             daux->xhv_eiter = saux->xhv_eiter
10608                                 ? he_dup(saux->xhv_eiter,
10609                                          (bool)!!HvSHAREKEYS(sstr), param) : 0;
10610                         }
10611                     }
10612                     else {
10613                         SvPV_set(dstr, Nullch);
10614                     }
10615                     /* Record stashes for possible cloning in Perl_clone(). */
10616                     if(hvname)
10617                         av_push(param->stashes, dstr);
10618                 }
10619                 break;
10620             case SVt_PVFM:
10621             case SVt_PVCV:
10622                 /* NOTE: not refcounted */
10623                 CvSTASH(dstr)   = hv_dup(CvSTASH(dstr), param);
10624                 OP_REFCNT_LOCK;
10625                 CvROOT(dstr)    = OpREFCNT_inc(CvROOT(dstr));
10626                 OP_REFCNT_UNLOCK;
10627                 if (CvCONST(dstr)) {
10628                     CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10629                         SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10630                         sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10631                 }
10632                 /* don't dup if copying back - CvGV isn't refcounted, so the
10633                  * duped GV may never be freed. A bit of a hack! DAPM */
10634                 CvGV(dstr)      = (param->flags & CLONEf_JOIN_IN) ?
10635                     Nullgv : gv_dup(CvGV(dstr), param) ;
10636                 if (!(param->flags & CLONEf_COPY_STACKS)) {
10637                     CvDEPTH(dstr) = 0;
10638                 }
10639                 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10640                 CvOUTSIDE(dstr) =
10641                     CvWEAKOUTSIDE(sstr)
10642                     ? cv_dup(    CvOUTSIDE(dstr), param)
10643                     : cv_dup_inc(CvOUTSIDE(dstr), param);
10644                 if (!CvXSUB(dstr))
10645                     CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10646                 break;
10647             }
10648         }
10649     }
10650
10651     if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10652         ++PL_sv_objcount;
10653
10654     return dstr;
10655  }
10656
10657 /* duplicate a context */
10658
10659 PERL_CONTEXT *
10660 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10661 {
10662     PERL_CONTEXT *ncxs;
10663
10664     if (!cxs)
10665         return (PERL_CONTEXT*)NULL;
10666
10667     /* look for it in the table first */
10668     ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10669     if (ncxs)
10670         return ncxs;
10671
10672     /* create anew and remember what it is */
10673     Newxz(ncxs, max + 1, PERL_CONTEXT);
10674     ptr_table_store(PL_ptr_table, cxs, ncxs);
10675
10676     while (ix >= 0) {
10677         PERL_CONTEXT *cx = &cxs[ix];
10678         PERL_CONTEXT *ncx = &ncxs[ix];
10679         ncx->cx_type    = cx->cx_type;
10680         if (CxTYPE(cx) == CXt_SUBST) {
10681             Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10682         }
10683         else {
10684             ncx->blk_oldsp      = cx->blk_oldsp;
10685             ncx->blk_oldcop     = cx->blk_oldcop;
10686             ncx->blk_oldmarksp  = cx->blk_oldmarksp;
10687             ncx->blk_oldscopesp = cx->blk_oldscopesp;
10688             ncx->blk_oldpm      = cx->blk_oldpm;
10689             ncx->blk_gimme      = cx->blk_gimme;
10690             switch (CxTYPE(cx)) {
10691             case CXt_SUB:
10692                 ncx->blk_sub.cv         = (cx->blk_sub.olddepth == 0
10693                                            ? cv_dup_inc(cx->blk_sub.cv, param)
10694                                            : cv_dup(cx->blk_sub.cv,param));
10695                 ncx->blk_sub.argarray   = (cx->blk_sub.hasargs
10696                                            ? av_dup_inc(cx->blk_sub.argarray, param)
10697                                            : Nullav);
10698                 ncx->blk_sub.savearray  = av_dup_inc(cx->blk_sub.savearray, param);
10699                 ncx->blk_sub.olddepth   = cx->blk_sub.olddepth;
10700                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
10701                 ncx->blk_sub.lval       = cx->blk_sub.lval;
10702                 ncx->blk_sub.retop      = cx->blk_sub.retop;
10703                 break;
10704             case CXt_EVAL:
10705                 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10706                 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10707                 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10708                 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10709                 ncx->blk_eval.cur_text  = sv_dup(cx->blk_eval.cur_text, param);
10710                 ncx->blk_eval.retop = cx->blk_eval.retop;
10711                 break;
10712             case CXt_LOOP:
10713                 ncx->blk_loop.label     = cx->blk_loop.label;
10714                 ncx->blk_loop.resetsp   = cx->blk_loop.resetsp;
10715                 ncx->blk_loop.redo_op   = cx->blk_loop.redo_op;
10716                 ncx->blk_loop.next_op   = cx->blk_loop.next_op;
10717                 ncx->blk_loop.last_op   = cx->blk_loop.last_op;
10718                 ncx->blk_loop.iterdata  = (CxPADLOOP(cx)
10719                                            ? cx->blk_loop.iterdata
10720                                            : gv_dup((GV*)cx->blk_loop.iterdata, param));
10721                 ncx->blk_loop.oldcomppad
10722                     = (PAD*)ptr_table_fetch(PL_ptr_table,
10723                                             cx->blk_loop.oldcomppad);
10724                 ncx->blk_loop.itersave  = sv_dup_inc(cx->blk_loop.itersave, param);
10725                 ncx->blk_loop.iterlval  = sv_dup_inc(cx->blk_loop.iterlval, param);
10726                 ncx->blk_loop.iterary   = av_dup_inc(cx->blk_loop.iterary, param);
10727                 ncx->blk_loop.iterix    = cx->blk_loop.iterix;
10728                 ncx->blk_loop.itermax   = cx->blk_loop.itermax;
10729                 break;
10730             case CXt_FORMAT:
10731                 ncx->blk_sub.cv         = cv_dup(cx->blk_sub.cv, param);
10732                 ncx->blk_sub.gv         = gv_dup(cx->blk_sub.gv, param);
10733                 ncx->blk_sub.dfoutgv    = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10734                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
10735                 ncx->blk_sub.retop      = cx->blk_sub.retop;
10736                 break;
10737             case CXt_BLOCK:
10738             case CXt_NULL:
10739                 break;
10740             }
10741         }
10742         --ix;
10743     }
10744     return ncxs;
10745 }
10746
10747 /* duplicate a stack info structure */
10748
10749 PERL_SI *
10750 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10751 {
10752     PERL_SI *nsi;
10753
10754     if (!si)
10755         return (PERL_SI*)NULL;
10756
10757     /* look for it in the table first */
10758     nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10759     if (nsi)
10760         return nsi;
10761
10762     /* create anew and remember what it is */
10763     Newxz(nsi, 1, PERL_SI);
10764     ptr_table_store(PL_ptr_table, si, nsi);
10765
10766     nsi->si_stack       = av_dup_inc(si->si_stack, param);
10767     nsi->si_cxix        = si->si_cxix;
10768     nsi->si_cxmax       = si->si_cxmax;
10769     nsi->si_cxstack     = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10770     nsi->si_type        = si->si_type;
10771     nsi->si_prev        = si_dup(si->si_prev, param);
10772     nsi->si_next        = si_dup(si->si_next, param);
10773     nsi->si_markoff     = si->si_markoff;
10774
10775     return nsi;
10776 }
10777
10778 #define POPINT(ss,ix)   ((ss)[--(ix)].any_i32)
10779 #define TOPINT(ss,ix)   ((ss)[ix].any_i32)
10780 #define POPLONG(ss,ix)  ((ss)[--(ix)].any_long)
10781 #define TOPLONG(ss,ix)  ((ss)[ix].any_long)
10782 #define POPIV(ss,ix)    ((ss)[--(ix)].any_iv)
10783 #define TOPIV(ss,ix)    ((ss)[ix].any_iv)
10784 #define POPBOOL(ss,ix)  ((ss)[--(ix)].any_bool)
10785 #define TOPBOOL(ss,ix)  ((ss)[ix].any_bool)
10786 #define POPPTR(ss,ix)   ((ss)[--(ix)].any_ptr)
10787 #define TOPPTR(ss,ix)   ((ss)[ix].any_ptr)
10788 #define POPDPTR(ss,ix)  ((ss)[--(ix)].any_dptr)
10789 #define TOPDPTR(ss,ix)  ((ss)[ix].any_dptr)
10790 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10791 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10792
10793 /* XXXXX todo */
10794 #define pv_dup_inc(p)   SAVEPV(p)
10795 #define pv_dup(p)       SAVEPV(p)
10796 #define svp_dup_inc(p,pp)       any_dup(p,pp)
10797
10798 /* map any object to the new equivent - either something in the
10799  * ptr table, or something in the interpreter structure
10800  */
10801
10802 void *
10803 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10804 {
10805     void *ret;
10806
10807     if (!v)
10808         return (void*)NULL;
10809
10810     /* look for it in the table first */
10811     ret = ptr_table_fetch(PL_ptr_table, v);
10812     if (ret)
10813         return ret;
10814
10815     /* see if it is part of the interpreter structure */
10816     if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10817         ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10818     else {
10819         ret = v;
10820     }
10821
10822     return ret;
10823 }
10824
10825 /* duplicate the save stack */
10826
10827 ANY *
10828 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10829 {
10830     ANY * const ss      = proto_perl->Tsavestack;
10831     const I32 max       = proto_perl->Tsavestack_max;
10832     I32 ix              = proto_perl->Tsavestack_ix;
10833     ANY *nss;
10834     SV *sv;
10835     GV *gv;
10836     AV *av;
10837     HV *hv;
10838     void* ptr;
10839     int intval;
10840     long longval;
10841     GP *gp;
10842     IV iv;
10843     char *c = NULL;
10844     void (*dptr) (void*);
10845     void (*dxptr) (pTHX_ void*);
10846
10847     Newxz(nss, max, ANY);
10848
10849     while (ix > 0) {
10850         I32 i = POPINT(ss,ix);
10851         TOPINT(nss,ix) = i;
10852         switch (i) {
10853         case SAVEt_ITEM:                        /* normal string */
10854             sv = (SV*)POPPTR(ss,ix);
10855             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10856             sv = (SV*)POPPTR(ss,ix);
10857             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10858             break;
10859         case SAVEt_SV:                          /* scalar reference */
10860             sv = (SV*)POPPTR(ss,ix);
10861             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10862             gv = (GV*)POPPTR(ss,ix);
10863             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10864             break;
10865         case SAVEt_GENERIC_PVREF:               /* generic char* */
10866             c = (char*)POPPTR(ss,ix);
10867             TOPPTR(nss,ix) = pv_dup(c);
10868             ptr = POPPTR(ss,ix);
10869             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10870             break;
10871         case SAVEt_SHARED_PVREF:                /* char* in shared space */
10872             c = (char*)POPPTR(ss,ix);
10873             TOPPTR(nss,ix) = savesharedpv(c);
10874             ptr = POPPTR(ss,ix);
10875             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10876             break;
10877         case SAVEt_GENERIC_SVREF:               /* generic sv */
10878         case SAVEt_SVREF:                       /* scalar reference */
10879             sv = (SV*)POPPTR(ss,ix);
10880             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10881             ptr = POPPTR(ss,ix);
10882             TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10883             break;
10884         case SAVEt_AV:                          /* array reference */
10885             av = (AV*)POPPTR(ss,ix);
10886             TOPPTR(nss,ix) = av_dup_inc(av, param);
10887             gv = (GV*)POPPTR(ss,ix);
10888             TOPPTR(nss,ix) = gv_dup(gv, param);
10889             break;
10890         case SAVEt_HV:                          /* hash reference */
10891             hv = (HV*)POPPTR(ss,ix);
10892             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10893             gv = (GV*)POPPTR(ss,ix);
10894             TOPPTR(nss,ix) = gv_dup(gv, param);
10895             break;
10896         case SAVEt_INT:                         /* int reference */
10897             ptr = POPPTR(ss,ix);
10898             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10899             intval = (int)POPINT(ss,ix);
10900             TOPINT(nss,ix) = intval;
10901             break;
10902         case SAVEt_LONG:                        /* long reference */
10903             ptr = POPPTR(ss,ix);
10904             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10905             longval = (long)POPLONG(ss,ix);
10906             TOPLONG(nss,ix) = longval;
10907             break;
10908         case SAVEt_I32:                         /* I32 reference */
10909         case SAVEt_I16:                         /* I16 reference */
10910         case SAVEt_I8:                          /* I8 reference */
10911             ptr = POPPTR(ss,ix);
10912             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10913             i = POPINT(ss,ix);
10914             TOPINT(nss,ix) = i;
10915             break;
10916         case SAVEt_IV:                          /* IV reference */
10917             ptr = POPPTR(ss,ix);
10918             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10919             iv = POPIV(ss,ix);
10920             TOPIV(nss,ix) = iv;
10921             break;
10922         case SAVEt_SPTR:                        /* SV* reference */
10923             ptr = POPPTR(ss,ix);
10924             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10925             sv = (SV*)POPPTR(ss,ix);
10926             TOPPTR(nss,ix) = sv_dup(sv, param);
10927             break;
10928         case SAVEt_VPTR:                        /* random* reference */
10929             ptr = POPPTR(ss,ix);
10930             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10931             ptr = POPPTR(ss,ix);
10932             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10933             break;
10934         case SAVEt_PPTR:                        /* char* reference */
10935             ptr = POPPTR(ss,ix);
10936             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10937             c = (char*)POPPTR(ss,ix);
10938             TOPPTR(nss,ix) = pv_dup(c);
10939             break;
10940         case SAVEt_HPTR:                        /* HV* reference */
10941             ptr = POPPTR(ss,ix);
10942             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10943             hv = (HV*)POPPTR(ss,ix);
10944             TOPPTR(nss,ix) = hv_dup(hv, param);
10945             break;
10946         case SAVEt_APTR:                        /* AV* reference */
10947             ptr = POPPTR(ss,ix);
10948             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10949             av = (AV*)POPPTR(ss,ix);
10950             TOPPTR(nss,ix) = av_dup(av, param);
10951             break;
10952         case SAVEt_NSTAB:
10953             gv = (GV*)POPPTR(ss,ix);
10954             TOPPTR(nss,ix) = gv_dup(gv, param);
10955             break;
10956         case SAVEt_GP:                          /* scalar reference */
10957             gp = (GP*)POPPTR(ss,ix);
10958             TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10959             (void)GpREFCNT_inc(gp);
10960             gv = (GV*)POPPTR(ss,ix);
10961             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10962             c = (char*)POPPTR(ss,ix);
10963             TOPPTR(nss,ix) = pv_dup(c);
10964             iv = POPIV(ss,ix);
10965             TOPIV(nss,ix) = iv;
10966             iv = POPIV(ss,ix);
10967             TOPIV(nss,ix) = iv;
10968             break;
10969         case SAVEt_FREESV:
10970         case SAVEt_MORTALIZESV:
10971             sv = (SV*)POPPTR(ss,ix);
10972             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10973             break;
10974         case SAVEt_FREEOP:
10975             ptr = POPPTR(ss,ix);
10976             if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10977                 /* these are assumed to be refcounted properly */
10978                 OP *o;
10979                 switch (((OP*)ptr)->op_type) {
10980                 case OP_LEAVESUB:
10981                 case OP_LEAVESUBLV:
10982                 case OP_LEAVEEVAL:
10983                 case OP_LEAVE:
10984                 case OP_SCOPE:
10985                 case OP_LEAVEWRITE:
10986                     TOPPTR(nss,ix) = ptr;
10987                     o = (OP*)ptr;
10988                     OpREFCNT_inc(o);
10989                     break;
10990                 default:
10991                     TOPPTR(nss,ix) = Nullop;
10992                     break;
10993                 }
10994             }
10995             else
10996                 TOPPTR(nss,ix) = Nullop;
10997             break;
10998         case SAVEt_FREEPV:
10999             c = (char*)POPPTR(ss,ix);
11000             TOPPTR(nss,ix) = pv_dup_inc(c);
11001             break;
11002         case SAVEt_CLEARSV:
11003             longval = POPLONG(ss,ix);
11004             TOPLONG(nss,ix) = longval;
11005             break;
11006         case SAVEt_DELETE:
11007             hv = (HV*)POPPTR(ss,ix);
11008             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11009             c = (char*)POPPTR(ss,ix);
11010             TOPPTR(nss,ix) = pv_dup_inc(c);
11011             i = POPINT(ss,ix);
11012             TOPINT(nss,ix) = i;
11013             break;
11014         case SAVEt_DESTRUCTOR:
11015             ptr = POPPTR(ss,ix);
11016             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
11017             dptr = POPDPTR(ss,ix);
11018             TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11019                                         any_dup(FPTR2DPTR(void *, dptr),
11020                                                 proto_perl));
11021             break;
11022         case SAVEt_DESTRUCTOR_X:
11023             ptr = POPPTR(ss,ix);
11024             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
11025             dxptr = POPDXPTR(ss,ix);
11026             TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11027                                          any_dup(FPTR2DPTR(void *, dxptr),
11028                                                  proto_perl));
11029             break;
11030         case SAVEt_REGCONTEXT:
11031         case SAVEt_ALLOC:
11032             i = POPINT(ss,ix);
11033             TOPINT(nss,ix) = i;
11034             ix -= i;
11035             break;
11036         case SAVEt_STACK_POS:           /* Position on Perl stack */
11037             i = POPINT(ss,ix);
11038             TOPINT(nss,ix) = i;
11039             break;
11040         case SAVEt_AELEM:               /* array element */
11041             sv = (SV*)POPPTR(ss,ix);
11042             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11043             i = POPINT(ss,ix);
11044             TOPINT(nss,ix) = i;
11045             av = (AV*)POPPTR(ss,ix);
11046             TOPPTR(nss,ix) = av_dup_inc(av, param);
11047             break;
11048         case SAVEt_HELEM:               /* hash element */
11049             sv = (SV*)POPPTR(ss,ix);
11050             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11051             sv = (SV*)POPPTR(ss,ix);
11052             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11053             hv = (HV*)POPPTR(ss,ix);
11054             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11055             break;
11056         case SAVEt_OP:
11057             ptr = POPPTR(ss,ix);
11058             TOPPTR(nss,ix) = ptr;
11059             break;
11060         case SAVEt_HINTS:
11061             i = POPINT(ss,ix);
11062             TOPINT(nss,ix) = i;
11063             break;
11064         case SAVEt_COMPPAD:
11065             av = (AV*)POPPTR(ss,ix);
11066             TOPPTR(nss,ix) = av_dup(av, param);
11067             break;
11068         case SAVEt_PADSV:
11069             longval = (long)POPLONG(ss,ix);
11070             TOPLONG(nss,ix) = longval;
11071             ptr = POPPTR(ss,ix);
11072             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11073             sv = (SV*)POPPTR(ss,ix);
11074             TOPPTR(nss,ix) = sv_dup(sv, param);
11075             break;
11076         case SAVEt_BOOL:
11077             ptr = POPPTR(ss,ix);
11078             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11079             longval = (long)POPBOOL(ss,ix);
11080             TOPBOOL(nss,ix) = (bool)longval;
11081             break;
11082         case SAVEt_SET_SVFLAGS:
11083             i = POPINT(ss,ix);
11084             TOPINT(nss,ix) = i;
11085             i = POPINT(ss,ix);
11086             TOPINT(nss,ix) = i;
11087             sv = (SV*)POPPTR(ss,ix);
11088             TOPPTR(nss,ix) = sv_dup(sv, param);
11089             break;
11090         default:
11091             Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11092         }
11093     }
11094
11095     return nss;
11096 }
11097
11098
11099 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11100  * flag to the result. This is done for each stash before cloning starts,
11101  * so we know which stashes want their objects cloned */
11102
11103 static void
11104 do_mark_cloneable_stash(pTHX_ SV *sv)
11105 {
11106     const HEK * const hvname = HvNAME_HEK((HV*)sv);
11107     if (hvname) {
11108         GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11109         SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11110         if (cloner && GvCV(cloner)) {
11111             dSP;
11112             UV status;
11113
11114             ENTER;
11115             SAVETMPS;
11116             PUSHMARK(SP);
11117             XPUSHs(sv_2mortal(newSVhek(hvname)));
11118             PUTBACK;
11119             call_sv((SV*)GvCV(cloner), G_SCALAR);
11120             SPAGAIN;
11121             status = POPu;
11122             PUTBACK;
11123             FREETMPS;
11124             LEAVE;
11125             if (status)
11126                 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11127         }
11128     }
11129 }
11130
11131
11132
11133 /*
11134 =for apidoc perl_clone
11135
11136 Create and return a new interpreter by cloning the current one.
11137
11138 perl_clone takes these flags as parameters:
11139
11140 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11141 without it we only clone the data and zero the stacks,
11142 with it we copy the stacks and the new perl interpreter is
11143 ready to run at the exact same point as the previous one.
11144 The pseudo-fork code uses COPY_STACKS while the
11145 threads->new doesn't.
11146
11147 CLONEf_KEEP_PTR_TABLE
11148 perl_clone keeps a ptr_table with the pointer of the old
11149 variable as a key and the new variable as a value,
11150 this allows it to check if something has been cloned and not
11151 clone it again but rather just use the value and increase the
11152 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11153 the ptr_table using the function
11154 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11155 reason to keep it around is if you want to dup some of your own
11156 variable who are outside the graph perl scans, example of this
11157 code is in threads.xs create
11158
11159 CLONEf_CLONE_HOST
11160 This is a win32 thing, it is ignored on unix, it tells perls
11161 win32host code (which is c++) to clone itself, this is needed on
11162 win32 if you want to run two threads at the same time,
11163 if you just want to do some stuff in a separate perl interpreter
11164 and then throw it away and return to the original one,
11165 you don't need to do anything.
11166
11167 =cut
11168 */
11169
11170 /* XXX the above needs expanding by someone who actually understands it ! */
11171 EXTERN_C PerlInterpreter *
11172 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11173
11174 PerlInterpreter *
11175 perl_clone(PerlInterpreter *proto_perl, UV flags)
11176 {
11177    dVAR;
11178 #ifdef PERL_IMPLICIT_SYS
11179
11180    /* perlhost.h so we need to call into it
11181    to clone the host, CPerlHost should have a c interface, sky */
11182
11183    if (flags & CLONEf_CLONE_HOST) {
11184        return perl_clone_host(proto_perl,flags);
11185    }
11186    return perl_clone_using(proto_perl, flags,
11187                             proto_perl->IMem,
11188                             proto_perl->IMemShared,
11189                             proto_perl->IMemParse,
11190                             proto_perl->IEnv,
11191                             proto_perl->IStdIO,
11192                             proto_perl->ILIO,
11193                             proto_perl->IDir,
11194                             proto_perl->ISock,
11195                             proto_perl->IProc);
11196 }
11197
11198 PerlInterpreter *
11199 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11200                  struct IPerlMem* ipM, struct IPerlMem* ipMS,
11201                  struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11202                  struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11203                  struct IPerlDir* ipD, struct IPerlSock* ipS,
11204                  struct IPerlProc* ipP)
11205 {
11206     /* XXX many of the string copies here can be optimized if they're
11207      * constants; they need to be allocated as common memory and just
11208      * their pointers copied. */
11209
11210     IV i;
11211     CLONE_PARAMS clone_params;
11212     CLONE_PARAMS* param = &clone_params;
11213
11214     PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11215     /* for each stash, determine whether its objects should be cloned */
11216     S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11217     PERL_SET_THX(my_perl);
11218
11219 #  ifdef DEBUGGING
11220     Poison(my_perl, 1, PerlInterpreter);
11221     PL_op = Nullop;
11222     PL_curcop = (COP *)Nullop;
11223     PL_markstack = 0;
11224     PL_scopestack = 0;
11225     PL_savestack = 0;
11226     PL_savestack_ix = 0;
11227     PL_savestack_max = -1;
11228     PL_sig_pending = 0;
11229     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11230 #  else /* !DEBUGGING */
11231     Zero(my_perl, 1, PerlInterpreter);
11232 #  endif        /* DEBUGGING */
11233
11234     /* host pointers */
11235     PL_Mem              = ipM;
11236     PL_MemShared        = ipMS;
11237     PL_MemParse         = ipMP;
11238     PL_Env              = ipE;
11239     PL_StdIO            = ipStd;
11240     PL_LIO              = ipLIO;
11241     PL_Dir              = ipD;
11242     PL_Sock             = ipS;
11243     PL_Proc             = ipP;
11244 #else           /* !PERL_IMPLICIT_SYS */
11245     IV i;
11246     CLONE_PARAMS clone_params;
11247     CLONE_PARAMS* param = &clone_params;
11248     PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11249     /* for each stash, determine whether its objects should be cloned */
11250     S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11251     PERL_SET_THX(my_perl);
11252
11253 #    ifdef DEBUGGING
11254     Poison(my_perl, 1, PerlInterpreter);
11255     PL_op = Nullop;
11256     PL_curcop = (COP *)Nullop;
11257     PL_markstack = 0;
11258     PL_scopestack = 0;
11259     PL_savestack = 0;
11260     PL_savestack_ix = 0;
11261     PL_savestack_max = -1;
11262     PL_sig_pending = 0;
11263     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11264 #    else       /* !DEBUGGING */
11265     Zero(my_perl, 1, PerlInterpreter);
11266 #    endif      /* DEBUGGING */
11267 #endif          /* PERL_IMPLICIT_SYS */
11268     param->flags = flags;
11269     param->proto_perl = proto_perl;
11270
11271     /* arena roots */
11272     PL_xnv_arenaroot    = NULL;
11273     PL_xnv_root         = NULL;
11274     PL_xpv_arenaroot    = NULL;
11275     PL_xpv_root         = NULL;
11276     PL_xpviv_arenaroot  = NULL;
11277     PL_xpviv_root       = NULL;
11278     PL_xpvnv_arenaroot  = NULL;
11279     PL_xpvnv_root       = NULL;
11280     PL_xpvcv_arenaroot  = NULL;
11281     PL_xpvcv_root       = NULL;
11282     PL_xpvav_arenaroot  = NULL;
11283     PL_xpvav_root       = NULL;
11284     PL_xpvhv_arenaroot  = NULL;
11285     PL_xpvhv_root       = NULL;
11286     PL_xpvmg_arenaroot  = NULL;
11287     PL_xpvmg_root       = NULL;
11288     PL_xpvgv_arenaroot  = NULL;
11289     PL_xpvgv_root       = NULL;
11290     PL_xpvlv_arenaroot  = NULL;
11291     PL_xpvlv_root       = NULL;
11292     PL_xpvbm_arenaroot  = NULL;
11293     PL_xpvbm_root       = NULL;
11294     PL_he_arenaroot     = NULL;
11295     PL_he_root          = NULL;
11296 #if defined(USE_ITHREADS)
11297     PL_pte_arenaroot    = NULL;
11298     PL_pte_root         = NULL;
11299 #endif
11300     PL_nice_chunk       = NULL;
11301     PL_nice_chunk_size  = 0;
11302     PL_sv_count         = 0;
11303     PL_sv_objcount      = 0;
11304     PL_sv_root          = Nullsv;
11305     PL_sv_arenaroot     = Nullsv;
11306
11307     PL_debug            = proto_perl->Idebug;
11308
11309     PL_hash_seed        = proto_perl->Ihash_seed;
11310     PL_rehash_seed      = proto_perl->Irehash_seed;
11311
11312 #ifdef USE_REENTRANT_API
11313     /* XXX: things like -Dm will segfault here in perlio, but doing
11314      *  PERL_SET_CONTEXT(proto_perl);
11315      * breaks too many other things
11316      */
11317     Perl_reentrant_init(aTHX);
11318 #endif
11319
11320     /* create SV map for pointer relocation */
11321     PL_ptr_table = ptr_table_new();
11322
11323     /* initialize these special pointers as early as possible */
11324     SvANY(&PL_sv_undef)         = NULL;
11325     SvREFCNT(&PL_sv_undef)      = (~(U32)0)/2;
11326     SvFLAGS(&PL_sv_undef)       = SVf_READONLY|SVt_NULL;
11327     ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11328
11329     SvANY(&PL_sv_no)            = new_XPVNV();
11330     SvREFCNT(&PL_sv_no)         = (~(U32)0)/2;
11331     SvFLAGS(&PL_sv_no)          = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11332                                   |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11333     SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11334     SvCUR_set(&PL_sv_no, 0);
11335     SvLEN_set(&PL_sv_no, 1);
11336     SvIV_set(&PL_sv_no, 0);
11337     SvNV_set(&PL_sv_no, 0);
11338     ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11339
11340     SvANY(&PL_sv_yes)           = new_XPVNV();
11341     SvREFCNT(&PL_sv_yes)        = (~(U32)0)/2;
11342     SvFLAGS(&PL_sv_yes)         = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11343                                   |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11344     SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11345     SvCUR_set(&PL_sv_yes, 1);
11346     SvLEN_set(&PL_sv_yes, 2);
11347     SvIV_set(&PL_sv_yes, 1);
11348     SvNV_set(&PL_sv_yes, 1);
11349     ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11350
11351     /* create (a non-shared!) shared string table */
11352     PL_strtab           = newHV();
11353     HvSHAREKEYS_off(PL_strtab);
11354     hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11355     ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11356
11357     PL_compiling = proto_perl->Icompiling;
11358
11359     /* These two PVs will be free'd special way so must set them same way op.c does */
11360     PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11361     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11362
11363     PL_compiling.cop_file    = savesharedpv(PL_compiling.cop_file);
11364     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11365
11366     ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11367     if (!specialWARN(PL_compiling.cop_warnings))
11368         PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11369     if (!specialCopIO(PL_compiling.cop_io))
11370         PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11371     PL_curcop           = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11372
11373     /* pseudo environmental stuff */
11374     PL_origargc         = proto_perl->Iorigargc;
11375     PL_origargv         = proto_perl->Iorigargv;
11376
11377     param->stashes      = newAV();  /* Setup array of objects to call clone on */
11378
11379     /* Set tainting stuff before PerlIO_debug can possibly get called */
11380     PL_tainting         = proto_perl->Itainting;
11381     PL_taint_warn       = proto_perl->Itaint_warn;
11382
11383 #ifdef PERLIO_LAYERS
11384     /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11385     PerlIO_clone(aTHX_ proto_perl, param);
11386 #endif
11387
11388     PL_envgv            = gv_dup(proto_perl->Ienvgv, param);
11389     PL_incgv            = gv_dup(proto_perl->Iincgv, param);
11390     PL_hintgv           = gv_dup(proto_perl->Ihintgv, param);
11391     PL_origfilename     = SAVEPV(proto_perl->Iorigfilename);
11392     PL_diehook          = sv_dup_inc(proto_perl->Idiehook, param);
11393     PL_warnhook         = sv_dup_inc(proto_perl->Iwarnhook, param);
11394
11395     /* switches */
11396     PL_minus_c          = proto_perl->Iminus_c;
11397     PL_patchlevel       = sv_dup_inc(proto_perl->Ipatchlevel, param);
11398     PL_localpatches     = proto_perl->Ilocalpatches;
11399     PL_splitstr         = proto_perl->Isplitstr;
11400     PL_preprocess       = proto_perl->Ipreprocess;
11401     PL_minus_n          = proto_perl->Iminus_n;
11402     PL_minus_p          = proto_perl->Iminus_p;
11403     PL_minus_l          = proto_perl->Iminus_l;
11404     PL_minus_a          = proto_perl->Iminus_a;
11405     PL_minus_F          = proto_perl->Iminus_F;
11406     PL_doswitches       = proto_perl->Idoswitches;
11407     PL_dowarn           = proto_perl->Idowarn;
11408     PL_doextract        = proto_perl->Idoextract;
11409     PL_sawampersand     = proto_perl->Isawampersand;
11410     PL_unsafe           = proto_perl->Iunsafe;
11411     PL_inplace          = SAVEPV(proto_perl->Iinplace);
11412     PL_e_script         = sv_dup_inc(proto_perl->Ie_script, param);
11413     PL_perldb           = proto_perl->Iperldb;
11414     PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11415     PL_exit_flags       = proto_perl->Iexit_flags;
11416
11417     /* magical thingies */
11418     /* XXX time(&PL_basetime) when asked for? */
11419     PL_basetime         = proto_perl->Ibasetime;
11420     PL_formfeed         = sv_dup(proto_perl->Iformfeed, param);
11421
11422     PL_maxsysfd         = proto_perl->Imaxsysfd;
11423     PL_multiline        = proto_perl->Imultiline;
11424     PL_statusvalue      = proto_perl->Istatusvalue;
11425 #ifdef VMS
11426     PL_statusvalue_vms  = proto_perl->Istatusvalue_vms;
11427 #endif
11428     PL_encoding         = sv_dup(proto_perl->Iencoding, param);
11429
11430     sv_setpvn(PERL_DEBUG_PAD(0), "", 0);        /* For regex debugging. */
11431     sv_setpvn(PERL_DEBUG_PAD(1), "", 0);        /* ext/re needs these */
11432     sv_setpvn(PERL_DEBUG_PAD(2), "", 0);        /* even without DEBUGGING. */
11433
11434     /* Clone the regex array */
11435     PL_regex_padav = newAV();
11436     {
11437         const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11438         SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11439         IV i;
11440         av_push(PL_regex_padav,
11441                 sv_dup_inc(regexen[0],param));
11442         for(i = 1; i <= len; i++) {
11443             if(SvREPADTMP(regexen[i])) {
11444               av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11445             } else {
11446                 av_push(PL_regex_padav,
11447                     SvREFCNT_inc(
11448                         newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11449                              SvIVX(regexen[i])), param)))
11450                        ));
11451             }
11452         }
11453     }
11454     PL_regex_pad = AvARRAY(PL_regex_padav);
11455
11456     /* shortcuts to various I/O objects */
11457     PL_stdingv          = gv_dup(proto_perl->Istdingv, param);
11458     PL_stderrgv         = gv_dup(proto_perl->Istderrgv, param);
11459     PL_defgv            = gv_dup(proto_perl->Idefgv, param);
11460     PL_argvgv           = gv_dup(proto_perl->Iargvgv, param);
11461     PL_argvoutgv        = gv_dup(proto_perl->Iargvoutgv, param);
11462     PL_argvout_stack    = av_dup_inc(proto_perl->Iargvout_stack, param);
11463
11464     /* shortcuts to regexp stuff */
11465     PL_replgv           = gv_dup(proto_perl->Ireplgv, param);
11466
11467     /* shortcuts to misc objects */
11468     PL_errgv            = gv_dup(proto_perl->Ierrgv, param);
11469
11470     /* shortcuts to debugging objects */
11471     PL_DBgv             = gv_dup(proto_perl->IDBgv, param);
11472     PL_DBline           = gv_dup(proto_perl->IDBline, param);
11473     PL_DBsub            = gv_dup(proto_perl->IDBsub, param);
11474     PL_DBsingle         = sv_dup(proto_perl->IDBsingle, param);
11475     PL_DBtrace          = sv_dup(proto_perl->IDBtrace, param);
11476     PL_DBsignal         = sv_dup(proto_perl->IDBsignal, param);
11477     PL_DBassertion      = sv_dup(proto_perl->IDBassertion, param);
11478     PL_lineary          = av_dup(proto_perl->Ilineary, param);
11479     PL_dbargs           = av_dup(proto_perl->Idbargs, param);
11480
11481     /* symbol tables */
11482     PL_defstash         = hv_dup_inc(proto_perl->Tdefstash, param);
11483     PL_curstash         = hv_dup(proto_perl->Tcurstash, param);
11484     PL_debstash         = hv_dup(proto_perl->Idebstash, param);
11485     PL_globalstash      = hv_dup(proto_perl->Iglobalstash, param);
11486     PL_curstname        = sv_dup_inc(proto_perl->Icurstname, param);
11487
11488     PL_beginav          = av_dup_inc(proto_perl->Ibeginav, param);
11489     PL_beginav_save     = av_dup_inc(proto_perl->Ibeginav_save, param);
11490     PL_checkav_save     = av_dup_inc(proto_perl->Icheckav_save, param);
11491     PL_endav            = av_dup_inc(proto_perl->Iendav, param);
11492     PL_checkav          = av_dup_inc(proto_perl->Icheckav, param);
11493     PL_initav           = av_dup_inc(proto_perl->Iinitav, param);
11494
11495     PL_sub_generation   = proto_perl->Isub_generation;
11496
11497     /* funky return mechanisms */
11498     PL_forkprocess      = proto_perl->Iforkprocess;
11499
11500     /* subprocess state */
11501     PL_fdpid            = av_dup_inc(proto_perl->Ifdpid, param);
11502
11503     /* internal state */
11504     PL_maxo             = proto_perl->Imaxo;
11505     if (proto_perl->Iop_mask)
11506         PL_op_mask      = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11507     else
11508         PL_op_mask      = Nullch;
11509     /* PL_asserting        = proto_perl->Iasserting; */
11510
11511     /* current interpreter roots */
11512     PL_main_cv          = cv_dup_inc(proto_perl->Imain_cv, param);
11513     PL_main_root        = OpREFCNT_inc(proto_perl->Imain_root);
11514     PL_main_start       = proto_perl->Imain_start;
11515     PL_eval_root        = proto_perl->Ieval_root;
11516     PL_eval_start       = proto_perl->Ieval_start;
11517
11518     /* runtime control stuff */
11519     PL_curcopdb         = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11520     PL_copline          = proto_perl->Icopline;
11521
11522     PL_filemode         = proto_perl->Ifilemode;
11523     PL_lastfd           = proto_perl->Ilastfd;
11524     PL_oldname          = proto_perl->Ioldname;         /* XXX not quite right */
11525     PL_Argv             = NULL;
11526     PL_Cmd              = Nullch;
11527     PL_gensym           = proto_perl->Igensym;
11528     PL_preambled        = proto_perl->Ipreambled;
11529     PL_preambleav       = av_dup_inc(proto_perl->Ipreambleav, param);
11530     PL_laststatval      = proto_perl->Ilaststatval;
11531     PL_laststype        = proto_perl->Ilaststype;
11532     PL_mess_sv          = Nullsv;
11533
11534     PL_ors_sv           = sv_dup_inc(proto_perl->Iors_sv, param);
11535
11536     /* interpreter atexit processing */
11537     PL_exitlistlen      = proto_perl->Iexitlistlen;
11538     if (PL_exitlistlen) {
11539         Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11540         Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11541     }
11542     else
11543         PL_exitlist     = (PerlExitListEntry*)NULL;
11544     PL_modglobal        = hv_dup_inc(proto_perl->Imodglobal, param);
11545     PL_custom_op_names  = hv_dup_inc(proto_perl->Icustom_op_names,param);
11546     PL_custom_op_descs  = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11547
11548     PL_profiledata      = NULL;
11549     PL_rsfp             = fp_dup(proto_perl->Irsfp, '<', param);
11550     /* PL_rsfp_filters entries have fake IoDIRP() */
11551     PL_rsfp_filters     = av_dup_inc(proto_perl->Irsfp_filters, param);
11552
11553     PL_compcv                   = cv_dup(proto_perl->Icompcv, param);
11554
11555     PAD_CLONE_VARS(proto_perl, param);
11556
11557 #ifdef HAVE_INTERP_INTERN
11558     sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11559 #endif
11560
11561     /* more statics moved here */
11562     PL_generation       = proto_perl->Igeneration;
11563     PL_DBcv             = cv_dup(proto_perl->IDBcv, param);
11564
11565     PL_in_clean_objs    = proto_perl->Iin_clean_objs;
11566     PL_in_clean_all     = proto_perl->Iin_clean_all;
11567
11568     PL_uid              = proto_perl->Iuid;
11569     PL_euid             = proto_perl->Ieuid;
11570     PL_gid              = proto_perl->Igid;
11571     PL_egid             = proto_perl->Iegid;
11572     PL_nomemok          = proto_perl->Inomemok;
11573     PL_an               = proto_perl->Ian;
11574     PL_evalseq          = proto_perl->Ievalseq;
11575     PL_origenviron      = proto_perl->Iorigenviron;     /* XXX not quite right */
11576     PL_origalen         = proto_perl->Iorigalen;
11577     PL_pidstatus        = newHV();                      /* XXX flag for cloning? */
11578     PL_osname           = SAVEPV(proto_perl->Iosname);
11579     PL_sighandlerp      = proto_perl->Isighandlerp;
11580
11581     PL_runops           = proto_perl->Irunops;
11582
11583     Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11584
11585 #ifdef CSH
11586     PL_cshlen           = proto_perl->Icshlen;
11587     PL_cshname          = proto_perl->Icshname; /* XXX never deallocated */
11588 #endif
11589
11590     PL_lex_state        = proto_perl->Ilex_state;
11591     PL_lex_defer        = proto_perl->Ilex_defer;
11592     PL_lex_expect       = proto_perl->Ilex_expect;
11593     PL_lex_formbrack    = proto_perl->Ilex_formbrack;
11594     PL_lex_dojoin       = proto_perl->Ilex_dojoin;
11595     PL_lex_starts       = proto_perl->Ilex_starts;
11596     PL_lex_stuff        = sv_dup_inc(proto_perl->Ilex_stuff, param);
11597     PL_lex_repl         = sv_dup_inc(proto_perl->Ilex_repl, param);
11598     PL_lex_op           = proto_perl->Ilex_op;
11599     PL_lex_inpat        = proto_perl->Ilex_inpat;
11600     PL_lex_inwhat       = proto_perl->Ilex_inwhat;
11601     PL_lex_brackets     = proto_perl->Ilex_brackets;
11602     i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11603     PL_lex_brackstack   = SAVEPVN(proto_perl->Ilex_brackstack,i);
11604     PL_lex_casemods     = proto_perl->Ilex_casemods;
11605     i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11606     PL_lex_casestack    = SAVEPVN(proto_perl->Ilex_casestack,i);
11607
11608     Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11609     Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11610     PL_nexttoke         = proto_perl->Inexttoke;
11611
11612     /* XXX This is probably masking the deeper issue of why
11613      * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11614      * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11615      * (A little debugging with a watchpoint on it may help.)
11616      */
11617     if (SvANY(proto_perl->Ilinestr)) {
11618         PL_linestr              = sv_dup_inc(proto_perl->Ilinestr, param);
11619         i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11620         PL_bufptr               = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11621         i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11622         PL_oldbufptr    = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11623         i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11624         PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11625         i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11626         PL_linestart    = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11627     }
11628     else {
11629         PL_linestr = NEWSV(65,79);
11630         sv_upgrade(PL_linestr,SVt_PVIV);
11631         sv_setpvn(PL_linestr,"",0);
11632         PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11633     }
11634     PL_bufend           = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11635     PL_pending_ident    = proto_perl->Ipending_ident;
11636     PL_sublex_info      = proto_perl->Isublex_info;     /* XXX not quite right */
11637
11638     PL_expect           = proto_perl->Iexpect;
11639
11640     PL_multi_start      = proto_perl->Imulti_start;
11641     PL_multi_end        = proto_perl->Imulti_end;
11642     PL_multi_open       = proto_perl->Imulti_open;
11643     PL_multi_close      = proto_perl->Imulti_close;
11644
11645     PL_error_count      = proto_perl->Ierror_count;
11646     PL_subline          = proto_perl->Isubline;
11647     PL_subname          = sv_dup_inc(proto_perl->Isubname, param);
11648
11649     /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11650     if (SvANY(proto_perl->Ilinestr)) {
11651         i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11652         PL_last_uni             = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11653         i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11654         PL_last_lop             = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11655         PL_last_lop_op  = proto_perl->Ilast_lop_op;
11656     }
11657     else {
11658         PL_last_uni     = SvPVX(PL_linestr);
11659         PL_last_lop     = SvPVX(PL_linestr);
11660         PL_last_lop_op  = 0;
11661     }
11662     PL_in_my            = proto_perl->Iin_my;
11663     PL_in_my_stash      = hv_dup(proto_perl->Iin_my_stash, param);
11664 #ifdef FCRYPT
11665     PL_cryptseen        = proto_perl->Icryptseen;
11666 #endif
11667
11668     PL_hints            = proto_perl->Ihints;
11669
11670     PL_amagic_generation        = proto_perl->Iamagic_generation;
11671
11672 #ifdef USE_LOCALE_COLLATE
11673     PL_collation_ix     = proto_perl->Icollation_ix;
11674     PL_collation_name   = SAVEPV(proto_perl->Icollation_name);
11675     PL_collation_standard       = proto_perl->Icollation_standard;
11676     PL_collxfrm_base    = proto_perl->Icollxfrm_base;
11677     PL_collxfrm_mult    = proto_perl->Icollxfrm_mult;
11678 #endif /* USE_LOCALE_COLLATE */
11679
11680 #ifdef USE_LOCALE_NUMERIC
11681     PL_numeric_name     = SAVEPV(proto_perl->Inumeric_name);
11682     PL_numeric_standard = proto_perl->Inumeric_standard;
11683     PL_numeric_local    = proto_perl->Inumeric_local;
11684     PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11685 #endif /* !USE_LOCALE_NUMERIC */
11686
11687     /* utf8 character classes */
11688     PL_utf8_alnum       = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11689     PL_utf8_alnumc      = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11690     PL_utf8_ascii       = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11691     PL_utf8_alpha       = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11692     PL_utf8_space       = sv_dup_inc(proto_perl->Iutf8_space, param);
11693     PL_utf8_cntrl       = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11694     PL_utf8_graph       = sv_dup_inc(proto_perl->Iutf8_graph, param);
11695     PL_utf8_digit       = sv_dup_inc(proto_perl->Iutf8_digit, param);
11696     PL_utf8_upper       = sv_dup_inc(proto_perl->Iutf8_upper, param);
11697     PL_utf8_lower       = sv_dup_inc(proto_perl->Iutf8_lower, param);
11698     PL_utf8_print       = sv_dup_inc(proto_perl->Iutf8_print, param);
11699     PL_utf8_punct       = sv_dup_inc(proto_perl->Iutf8_punct, param);
11700     PL_utf8_xdigit      = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11701     PL_utf8_mark        = sv_dup_inc(proto_perl->Iutf8_mark, param);
11702     PL_utf8_toupper     = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11703     PL_utf8_totitle     = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11704     PL_utf8_tolower     = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11705     PL_utf8_tofold      = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11706     PL_utf8_idstart     = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11707     PL_utf8_idcont      = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11708
11709     /* Did the locale setup indicate UTF-8? */
11710     PL_utf8locale       = proto_perl->Iutf8locale;
11711     /* Unicode features (see perlrun/-C) */
11712     PL_unicode          = proto_perl->Iunicode;
11713
11714     /* Pre-5.8 signals control */
11715     PL_signals          = proto_perl->Isignals;
11716
11717     /* times() ticks per second */
11718     PL_clocktick        = proto_perl->Iclocktick;
11719
11720     /* Recursion stopper for PerlIO_find_layer */
11721     PL_in_load_module   = proto_perl->Iin_load_module;
11722
11723     /* sort() routine */
11724     PL_sort_RealCmp     = proto_perl->Isort_RealCmp;
11725
11726     /* Not really needed/useful since the reenrant_retint is "volatile",
11727      * but do it for consistency's sake. */
11728     PL_reentrant_retint = proto_perl->Ireentrant_retint;
11729
11730     /* Hooks to shared SVs and locks. */
11731     PL_sharehook        = proto_perl->Isharehook;
11732     PL_lockhook         = proto_perl->Ilockhook;
11733     PL_unlockhook       = proto_perl->Iunlockhook;
11734     PL_threadhook       = proto_perl->Ithreadhook;
11735
11736     PL_runops_std       = proto_perl->Irunops_std;
11737     PL_runops_dbg       = proto_perl->Irunops_dbg;
11738
11739 #ifdef THREADS_HAVE_PIDS
11740     PL_ppid             = proto_perl->Ippid;
11741 #endif
11742
11743     /* swatch cache */
11744     PL_last_swash_hv    = Nullhv;       /* reinits on demand */
11745     PL_last_swash_klen  = 0;
11746     PL_last_swash_key[0]= '\0';
11747     PL_last_swash_tmps  = (U8*)NULL;
11748     PL_last_swash_slen  = 0;
11749
11750     PL_glob_index       = proto_perl->Iglob_index;
11751     PL_srand_called     = proto_perl->Isrand_called;
11752     PL_uudmap['M']      = 0;            /* reinits on demand */
11753     PL_bitcount         = Nullch;       /* reinits on demand */
11754
11755     if (proto_perl->Ipsig_pend) {
11756         Newxz(PL_psig_pend, SIG_SIZE, int);
11757     }
11758     else {
11759         PL_psig_pend    = (int*)NULL;
11760     }
11761
11762     if (proto_perl->Ipsig_ptr) {
11763         Newxz(PL_psig_ptr,  SIG_SIZE, SV*);
11764         Newxz(PL_psig_name, SIG_SIZE, SV*);
11765         for (i = 1; i < SIG_SIZE; i++) {
11766             PL_psig_ptr[i]  = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11767             PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11768         }
11769     }
11770     else {
11771         PL_psig_ptr     = (SV**)NULL;
11772         PL_psig_name    = (SV**)NULL;
11773     }
11774
11775     /* thrdvar.h stuff */
11776
11777     if (flags & CLONEf_COPY_STACKS) {
11778         /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11779         PL_tmps_ix              = proto_perl->Ttmps_ix;
11780         PL_tmps_max             = proto_perl->Ttmps_max;
11781         PL_tmps_floor           = proto_perl->Ttmps_floor;
11782         Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11783         i = 0;
11784         while (i <= PL_tmps_ix) {
11785             PL_tmps_stack[i]    = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11786             ++i;
11787         }
11788
11789         /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11790         i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11791         Newxz(PL_markstack, i, I32);
11792         PL_markstack_max        = PL_markstack + (proto_perl->Tmarkstack_max
11793                                                   - proto_perl->Tmarkstack);
11794         PL_markstack_ptr        = PL_markstack + (proto_perl->Tmarkstack_ptr
11795                                                   - proto_perl->Tmarkstack);
11796         Copy(proto_perl->Tmarkstack, PL_markstack,
11797              PL_markstack_ptr - PL_markstack + 1, I32);
11798
11799         /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11800          * NOTE: unlike the others! */
11801         PL_scopestack_ix        = proto_perl->Tscopestack_ix;
11802         PL_scopestack_max       = proto_perl->Tscopestack_max;
11803         Newxz(PL_scopestack, PL_scopestack_max, I32);
11804         Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11805
11806         /* NOTE: si_dup() looks at PL_markstack */
11807         PL_curstackinfo         = si_dup(proto_perl->Tcurstackinfo, param);
11808
11809         /* PL_curstack          = PL_curstackinfo->si_stack; */
11810         PL_curstack             = av_dup(proto_perl->Tcurstack, param);
11811         PL_mainstack            = av_dup(proto_perl->Tmainstack, param);
11812
11813         /* next PUSHs() etc. set *(PL_stack_sp+1) */
11814         PL_stack_base           = AvARRAY(PL_curstack);
11815         PL_stack_sp             = PL_stack_base + (proto_perl->Tstack_sp
11816                                                    - proto_perl->Tstack_base);
11817         PL_stack_max            = PL_stack_base + AvMAX(PL_curstack);
11818
11819         /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11820          * NOTE: unlike the others! */
11821         PL_savestack_ix         = proto_perl->Tsavestack_ix;
11822         PL_savestack_max        = proto_perl->Tsavestack_max;
11823         /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11824         PL_savestack            = ss_dup(proto_perl, param);
11825     }
11826     else {
11827         init_stacks();
11828         ENTER;                  /* perl_destruct() wants to LEAVE; */
11829     }
11830
11831     PL_start_env        = proto_perl->Tstart_env;       /* XXXXXX */
11832     PL_top_env          = &PL_start_env;
11833
11834     PL_op               = proto_perl->Top;
11835
11836     PL_Sv               = Nullsv;
11837     PL_Xpv              = (XPV*)NULL;
11838     PL_na               = proto_perl->Tna;
11839
11840     PL_statbuf          = proto_perl->Tstatbuf;
11841     PL_statcache        = proto_perl->Tstatcache;
11842     PL_statgv           = gv_dup(proto_perl->Tstatgv, param);
11843     PL_statname         = sv_dup_inc(proto_perl->Tstatname, param);
11844 #ifdef HAS_TIMES
11845     PL_timesbuf         = proto_perl->Ttimesbuf;
11846 #endif
11847
11848     PL_tainted          = proto_perl->Ttainted;
11849     PL_curpm            = proto_perl->Tcurpm;   /* XXX No PMOP ref count */
11850     PL_rs               = sv_dup_inc(proto_perl->Trs, param);
11851     PL_last_in_gv       = gv_dup(proto_perl->Tlast_in_gv, param);
11852     PL_ofs_sv           = sv_dup_inc(proto_perl->Tofs_sv, param);
11853     PL_defoutgv         = gv_dup_inc(proto_perl->Tdefoutgv, param);
11854     PL_chopset          = proto_perl->Tchopset; /* XXX never deallocated */
11855     PL_toptarget        = sv_dup_inc(proto_perl->Ttoptarget, param);
11856     PL_bodytarget       = sv_dup_inc(proto_perl->Tbodytarget, param);
11857     PL_formtarget       = sv_dup(proto_perl->Tformtarget, param);
11858
11859     PL_restartop        = proto_perl->Trestartop;
11860     PL_in_eval          = proto_perl->Tin_eval;
11861     PL_delaymagic       = proto_perl->Tdelaymagic;
11862     PL_dirty            = proto_perl->Tdirty;
11863     PL_localizing       = proto_perl->Tlocalizing;
11864
11865     PL_errors           = sv_dup_inc(proto_perl->Terrors, param);
11866     PL_hv_fetch_ent_mh  = Nullhe;
11867     PL_modcount         = proto_perl->Tmodcount;
11868     PL_lastgotoprobe    = Nullop;
11869     PL_dumpindent       = proto_perl->Tdumpindent;
11870
11871     PL_sortcop          = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11872     PL_sortstash        = hv_dup(proto_perl->Tsortstash, param);
11873     PL_firstgv          = gv_dup(proto_perl->Tfirstgv, param);
11874     PL_secondgv         = gv_dup(proto_perl->Tsecondgv, param);
11875     PL_sortcxix         = proto_perl->Tsortcxix;
11876     PL_efloatbuf        = Nullch;               /* reinits on demand */
11877     PL_efloatsize       = 0;                    /* reinits on demand */
11878
11879     /* regex stuff */
11880
11881     PL_screamfirst      = NULL;
11882     PL_screamnext       = NULL;
11883     PL_maxscream        = -1;                   /* reinits on demand */
11884     PL_lastscream       = Nullsv;
11885
11886     PL_watchaddr        = NULL;
11887     PL_watchok          = Nullch;
11888
11889     PL_regdummy         = proto_perl->Tregdummy;
11890     PL_regprecomp       = Nullch;
11891     PL_regnpar          = 0;
11892     PL_regsize          = 0;
11893     PL_colorset         = 0;            /* reinits PL_colors[] */
11894     /*PL_colors[6]      = {0,0,0,0,0,0};*/
11895     PL_reginput         = Nullch;
11896     PL_regbol           = Nullch;
11897     PL_regeol           = Nullch;
11898     PL_regstartp        = (I32*)NULL;
11899     PL_regendp          = (I32*)NULL;
11900     PL_reglastparen     = (U32*)NULL;
11901     PL_reglastcloseparen        = (U32*)NULL;
11902     PL_regtill          = Nullch;
11903     PL_reg_start_tmp    = (char**)NULL;
11904     PL_reg_start_tmpl   = 0;
11905     PL_regdata          = (struct reg_data*)NULL;
11906     PL_bostr            = Nullch;
11907     PL_reg_flags        = 0;
11908     PL_reg_eval_set     = 0;
11909     PL_regnarrate       = 0;
11910     PL_regprogram       = (regnode*)NULL;
11911     PL_regindent        = 0;
11912     PL_regcc            = (CURCUR*)NULL;
11913     PL_reg_call_cc      = (struct re_cc_state*)NULL;
11914     PL_reg_re           = (regexp*)NULL;
11915     PL_reg_ganch        = Nullch;
11916     PL_reg_sv           = Nullsv;
11917     PL_reg_match_utf8   = FALSE;
11918     PL_reg_magic        = (MAGIC*)NULL;
11919     PL_reg_oldpos       = 0;
11920     PL_reg_oldcurpm     = (PMOP*)NULL;
11921     PL_reg_curpm        = (PMOP*)NULL;
11922     PL_reg_oldsaved     = Nullch;
11923     PL_reg_oldsavedlen  = 0;
11924 #ifdef PERL_OLD_COPY_ON_WRITE
11925     PL_nrs              = Nullsv;
11926 #endif
11927     PL_reg_maxiter      = 0;
11928     PL_reg_leftiter     = 0;
11929     PL_reg_poscache     = Nullch;
11930     PL_reg_poscache_size= 0;
11931
11932     /* RE engine - function pointers */
11933     PL_regcompp         = proto_perl->Tregcompp;
11934     PL_regexecp         = proto_perl->Tregexecp;
11935     PL_regint_start     = proto_perl->Tregint_start;
11936     PL_regint_string    = proto_perl->Tregint_string;
11937     PL_regfree          = proto_perl->Tregfree;
11938
11939     PL_reginterp_cnt    = 0;
11940     PL_reg_starttry     = 0;
11941
11942     /* Pluggable optimizer */
11943     PL_peepp            = proto_perl->Tpeepp;
11944
11945     PL_stashcache       = newHV();
11946
11947     if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11948         ptr_table_free(PL_ptr_table);
11949         PL_ptr_table = NULL;
11950     }
11951
11952     /* Call the ->CLONE method, if it exists, for each of the stashes
11953        identified by sv_dup() above.
11954     */
11955     while(av_len(param->stashes) != -1) {
11956         HV* const stash = (HV*) av_shift(param->stashes);
11957         GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11958         if (cloner && GvCV(cloner)) {
11959             dSP;
11960             ENTER;
11961             SAVETMPS;
11962             PUSHMARK(SP);
11963             XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11964             PUTBACK;
11965             call_sv((SV*)GvCV(cloner), G_DISCARD);
11966             FREETMPS;
11967             LEAVE;
11968         }
11969     }
11970
11971     SvREFCNT_dec(param->stashes);
11972
11973     /* orphaned? eg threads->new inside BEGIN or use */
11974     if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11975         (void)SvREFCNT_inc(PL_compcv);
11976         SAVEFREESV(PL_compcv);
11977     }
11978
11979     return my_perl;
11980 }
11981
11982 #endif /* USE_ITHREADS */
11983
11984 /*
11985 =head1 Unicode Support
11986
11987 =for apidoc sv_recode_to_utf8
11988
11989 The encoding is assumed to be an Encode object, on entry the PV
11990 of the sv is assumed to be octets in that encoding, and the sv
11991 will be converted into Unicode (and UTF-8).
11992
11993 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11994 is not a reference, nothing is done to the sv.  If the encoding is not
11995 an C<Encode::XS> Encoding object, bad things will happen.
11996 (See F<lib/encoding.pm> and L<Encode>).
11997
11998 The PV of the sv is returned.
11999
12000 =cut */
12001
12002 char *
12003 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12004 {
12005     dVAR;
12006     if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12007         SV *uni;
12008         STRLEN len;
12009         const char *s;
12010         dSP;
12011         ENTER;
12012         SAVETMPS;
12013         save_re_context();
12014         PUSHMARK(sp);
12015         EXTEND(SP, 3);
12016         XPUSHs(encoding);
12017         XPUSHs(sv);
12018 /*
12019   NI-S 2002/07/09
12020   Passing sv_yes is wrong - it needs to be or'ed set of constants
12021   for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12022   remove converted chars from source.
12023
12024   Both will default the value - let them.
12025
12026         XPUSHs(&PL_sv_yes);
12027 */
12028         PUTBACK;
12029         call_method("decode", G_SCALAR);
12030         SPAGAIN;
12031         uni = POPs;
12032         PUTBACK;
12033         s = SvPV_const(uni, len);
12034         if (s != SvPVX_const(sv)) {
12035             SvGROW(sv, len + 1);
12036             Move(s, SvPVX(sv), len + 1, char);
12037             SvCUR_set(sv, len);
12038         }
12039         FREETMPS;
12040         LEAVE;
12041         SvUTF8_on(sv);
12042         return SvPVX(sv);
12043     }
12044     return SvPOKp(sv) ? SvPVX(sv) : NULL;
12045 }
12046
12047 /*
12048 =for apidoc sv_cat_decode
12049
12050 The encoding is assumed to be an Encode object, the PV of the ssv is
12051 assumed to be octets in that encoding and decoding the input starts
12052 from the position which (PV + *offset) pointed to.  The dsv will be
12053 concatenated the decoded UTF-8 string from ssv.  Decoding will terminate
12054 when the string tstr appears in decoding output or the input ends on
12055 the PV of the ssv. The value which the offset points will be modified
12056 to the last input position on the ssv.
12057
12058 Returns TRUE if the terminator was found, else returns FALSE.
12059
12060 =cut */
12061
12062 bool
12063 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12064                    SV *ssv, int *offset, char *tstr, int tlen)
12065 {
12066     dVAR;
12067     bool ret = FALSE;
12068     if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12069         SV *offsv;
12070         dSP;
12071         ENTER;
12072         SAVETMPS;
12073         save_re_context();
12074         PUSHMARK(sp);
12075         EXTEND(SP, 6);
12076         XPUSHs(encoding);
12077         XPUSHs(dsv);
12078         XPUSHs(ssv);
12079         XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12080         XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12081         PUTBACK;
12082         call_method("cat_decode", G_SCALAR);
12083         SPAGAIN;
12084         ret = SvTRUE(TOPs);
12085         *offset = SvIV(offsv);
12086         PUTBACK;
12087         FREETMPS;
12088         LEAVE;
12089     }
12090     else
12091         Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12092     return ret;
12093 }
12094
12095 /*
12096  * Local variables:
12097  * c-indentation-style: bsd
12098  * c-basic-offset: 4
12099  * indent-tabs-mode: t
12100  * End:
12101  *
12102  * ex: set ts=8 sts=4 sw=4 noet:
12103  */