sv.c

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