sv.c

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