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