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