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