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