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