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