sv.c

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