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