sv.c

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