sv.c

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