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