sv.c

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