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