sv.c

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