sv.c

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