sv.c

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