sv.c

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