sv.c

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