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