sv.c

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