sv.c

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