sv.c

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