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