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