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