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