sv.c

   1 /*    sv.c
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
   4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall
   5  *    and others
   6  *
   7  *    You may distribute under the terms of either the GNU General Public
   8  *    License or the Artistic License, as specified in the README file.
   9  *
  10  */
  11
  12 /*
  13  * 'I wonder what the Entish is for "yes" and "no",' he thought.
  14  *                                                      --Pippin
  15  *
  16  *     [p.480 of _The Lord of the Rings_, III/iv: "Treebeard"]
  17  */
  18
  19 /*
  20  *
  21  *
  22  * This file contains the code that creates, manipulates and destroys
  23  * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
  24  * structure of an SV, so their creation and destruction is handled
  25  * here; higher-level functions are in av.c, hv.c, and so on. Opcode
  26  * level functions (eg. substr, split, join) for each of the types are
  27  * in the pp*.c files.
  28  */
  29
  30 #include "EXTERN.h"
  31 #define PERL_IN_SV_C
  32 #include "perl.h"
  33 #include "regcomp.h"
  34
  35 #ifndef HAS_C99
  36 # if __STDC_VERSION__ >= 199901L && !defined(VMS)
  37 #  define HAS_C99 1
  38 # endif
  39 #endif
  40 #if HAS_C99
  41 # include <stdint.h>
  42 #endif
  43
  44 #define FCALL *f
  45
  46 #ifdef __Lynx__
  47 /* Missing proto on LynxOS */
  48   char *gconvert(double, int, int,  char *);
  49 #endif
  50
  51 #ifdef PERL_UTF8_CACHE_ASSERT
  52 /* if adding more checks watch out for the following tests:
  53  *   t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
  54  *   lib/utf8.t lib/Unicode/Collate/t/index.t
  55  * --jhi
  56  */
  57 #   define ASSERT_UTF8_CACHE(cache) \
  58     STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
  59                               assert((cache)[2] <= (cache)[3]); \
  60                               assert((cache)[3] <= (cache)[1]);} \
  61                               } STMT_END
  62 #else
  63 #   define ASSERT_UTF8_CACHE(cache) NOOP
  64 #endif
  65
  66 #ifdef PERL_OLD_COPY_ON_WRITE
  67 #define SV_COW_NEXT_SV(sv)      INT2PTR(SV *,SvUVX(sv))
  68 #define SV_COW_NEXT_SV_SET(current,next)        SvUV_set(current, PTR2UV(next))
  69 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
  70    on-write.  */
  71 #endif
  72
  73 /* ============================================================================
  74
  75 =head1 Allocation and deallocation of SVs.
  76
  77 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
  78 sv, av, hv...) contains type and reference count information, and for
  79 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
  80 contains fields specific to each type.  Some types store all they need
  81 in the head, so don't have a body.
  82
  83 In all but the most memory-paranoid configurations (ex: PURIFY), heads
  84 and bodies are allocated out of arenas, which by default are
  85 approximately 4K chunks of memory parcelled up into N heads or bodies.
  86 Sv-bodies are allocated by their sv-type, guaranteeing size
  87 consistency needed to allocate safely from arrays.
  88
  89 For SV-heads, the first slot in each arena is reserved, and holds a
  90 link to the next arena, some flags, and a note of the number of slots.
  91 Snaked through each arena chain is a linked list of free items; when
  92 this becomes empty, an extra arena is allocated and divided up into N
  93 items which are threaded into the free list.
  94
  95 SV-bodies are similar, but they use arena-sets by default, which
  96 separate the link and info from the arena itself, and reclaim the 1st
  97 slot in the arena.  SV-bodies are further described later.
  98
  99 The following global variables are associated with arenas:
 100
 101     PL_sv_arenaroot     pointer to list of SV arenas
 102     PL_sv_root          pointer to list of free SV structures
 103
 104     PL_body_arenas      head of linked-list of body arenas
 105     PL_body_roots[]     array of pointers to list of free bodies of svtype
 106                         arrays are indexed by the svtype needed
 107
 108 A few special SV heads are not allocated from an arena, but are
 109 instead directly created in the interpreter structure, eg PL_sv_undef.
 110 The size of arenas can be changed from the default by setting
 111 PERL_ARENA_SIZE appropriately at compile time.
 112
 113 The SV arena serves the secondary purpose of allowing still-live SVs
 114 to be located and destroyed during final cleanup.
 115
 116 At the lowest level, the macros new_SV() and del_SV() grab and free
 117 an SV head.  (If debugging with -DD, del_SV() calls the function S_del_sv()
 118 to return the SV to the free list with error checking.) new_SV() calls
 119 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
 120 SVs in the free list have their SvTYPE field set to all ones.
 121
 122 At the time of very final cleanup, sv_free_arenas() is called from
 123 perl_destruct() to physically free all the arenas allocated since the
 124 start of the interpreter.
 125
 126 The function visit() scans the SV arenas list, and calls a specified
 127 function for each SV it finds which is still live - ie which has an SvTYPE
 128 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
 129 following functions (specified as [function that calls visit()] / [function
 130 called by visit() for each SV]):
 131
 132     sv_report_used() / do_report_used()
 133                         dump all remaining SVs (debugging aid)
 134
 135     sv_clean_objs() / do_clean_objs(),do_clean_named_objs(),
 136                       do_clean_named_io_objs()
 137                         Attempt to free all objects pointed to by RVs,
 138                         and try to do the same for all objects indirectly
 139                         referenced by typeglobs too.  Called once from
 140                         perl_destruct(), prior to calling sv_clean_all()
 141                         below.
 142
 143     sv_clean_all() / do_clean_all()
 144                         SvREFCNT_dec(sv) each remaining SV, possibly
 145                         triggering an sv_free(). It also sets the
 146                         SVf_BREAK flag on the SV to indicate that the
 147                         refcnt has been artificially lowered, and thus
 148                         stopping sv_free() from giving spurious warnings
 149                         about SVs which unexpectedly have a refcnt
 150                         of zero.  called repeatedly from perl_destruct()
 151                         until there are no SVs left.
 152
 153 =head2 Arena allocator API Summary
 154
 155 Private API to rest of sv.c
 156
 157     new_SV(),  del_SV(),
 158
 159     new_XPVNV(), del_XPVGV(),
 160     etc
 161
 162 Public API:
 163
 164     sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
 165
 166 =cut
 167
 168  * ========================================================================= */
 169
 170 /*
 171  * "A time to plant, and a time to uproot what was planted..."
 172  */
 173
 174 #ifdef PERL_MEM_LOG
 175 #  define MEM_LOG_NEW_SV(sv, file, line, func)  \
 176             Perl_mem_log_new_sv(sv, file, line, func)
 177 #  define MEM_LOG_DEL_SV(sv, file, line, func)  \
 178             Perl_mem_log_del_sv(sv, file, line, func)
 179 #else
 180 #  define MEM_LOG_NEW_SV(sv, file, line, func)  NOOP
 181 #  define MEM_LOG_DEL_SV(sv, file, line, func)  NOOP
 182 #endif
 183
 184 #ifdef DEBUG_LEAKING_SCALARS
 185 #  define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
 186 #  define DEBUG_SV_SERIAL(sv)                                               \
 187     DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) del_SV\n",    \
 188             PTR2UV(sv), (long)(sv)->sv_debug_serial))
 189 #else
 190 #  define FREE_SV_DEBUG_FILE(sv)
 191 #  define DEBUG_SV_SERIAL(sv)   NOOP
 192 #endif
 193
 194 #ifdef PERL_POISON
 195 #  define SvARENA_CHAIN(sv)     ((sv)->sv_u.svu_rv)
 196 #  define SvARENA_CHAIN_SET(sv,val)     (sv)->sv_u.svu_rv = MUTABLE_SV((val))
 197 /* Whilst I'd love to do this, it seems that things like to check on
 198    unreferenced scalars
 199 #  define POSION_SV_HEAD(sv)    PoisonNew(sv, 1, struct STRUCT_SV)
 200 */
 201 #  define POSION_SV_HEAD(sv)    PoisonNew(&SvANY(sv), 1, void *), \
 202                                 PoisonNew(&SvREFCNT(sv), 1, U32)
 203 #else
 204 #  define SvARENA_CHAIN(sv)     SvANY(sv)
 205 #  define SvARENA_CHAIN_SET(sv,val)     SvANY(sv) = (void *)(val)
 206 #  define POSION_SV_HEAD(sv)
 207 #endif
 208
 209 /* Mark an SV head as unused, and add to free list.
 210  *
 211  * If SVf_BREAK is set, skip adding it to the free list, as this SV had
 212  * its refcount artificially decremented during global destruction, so
 213  * there may be dangling pointers to it. The last thing we want in that
 214  * case is for it to be reused. */
 215
 216 #define plant_SV(p) \
 217     STMT_START {                                        \
 218         const U32 old_flags = SvFLAGS(p);                       \
 219         MEM_LOG_DEL_SV(p, __FILE__, __LINE__, FUNCTION__);  \
 220         DEBUG_SV_SERIAL(p);                             \
 221         FREE_SV_DEBUG_FILE(p);                          \
 222         POSION_SV_HEAD(p);                              \
 223         SvFLAGS(p) = SVTYPEMASK;                        \
 224         if (!(old_flags & SVf_BREAK)) {         \
 225             SvARENA_CHAIN_SET(p, PL_sv_root);   \
 226             PL_sv_root = (p);                           \
 227         }                                               \
 228         --PL_sv_count;                                  \
 229     } STMT_END
 230
 231 #define uproot_SV(p) \
 232     STMT_START {                                        \
 233         (p) = PL_sv_root;                               \
 234         PL_sv_root = MUTABLE_SV(SvARENA_CHAIN(p));              \
 235         ++PL_sv_count;                                  \
 236     } STMT_END
 237
 238
 239 /* make some more SVs by adding another arena */
 240
 241 STATIC SV*
 242 S_more_sv(pTHX)
 243 {
 244     dVAR;
 245     SV* sv;
 246     char *chunk;                /* must use New here to match call to */
 247     Newx(chunk,PERL_ARENA_SIZE,char);  /* Safefree() in sv_free_arenas() */
 248     sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
 249     uproot_SV(sv);
 250     return sv;
 251 }
 252
 253 /* new_SV(): return a new, empty SV head */
 254
 255 #ifdef DEBUG_LEAKING_SCALARS
 256 /* provide a real function for a debugger to play with */
 257 STATIC SV*
 258 S_new_SV(pTHX_ const char *file, int line, const char *func)
 259 {
 260     SV* sv;
 261
 262     if (PL_sv_root)
 263         uproot_SV(sv);
 264     else
 265         sv = S_more_sv(aTHX);
 266     SvANY(sv) = 0;
 267     SvREFCNT(sv) = 1;
 268     SvFLAGS(sv) = 0;
 269     sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
 270     sv->sv_debug_line = (U16) (PL_parser && PL_parser->copline != NOLINE
 271                 ? PL_parser->copline
 272                 :  PL_curcop
 273                     ? CopLINE(PL_curcop)
 274                     : 0
 275             );
 276     sv->sv_debug_inpad = 0;
 277     sv->sv_debug_parent = NULL;
 278     sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
 279
 280     sv->sv_debug_serial = PL_sv_serial++;
 281
 282     MEM_LOG_NEW_SV(sv, file, line, func);
 283     DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) new_SV (from %s:%d [%s])\n",
 284             PTR2UV(sv), (long)sv->sv_debug_serial, file, line, func));
 285
 286     return sv;
 287 }
 288 #  define new_SV(p) (p)=S_new_SV(aTHX_ __FILE__, __LINE__, FUNCTION__)
 289
 290 #else
 291 #  define new_SV(p) \
 292     STMT_START {                                        \
 293         if (PL_sv_root)                                 \
 294             uproot_SV(p);                               \
 295         else                                            \
 296             (p) = S_more_sv(aTHX);                      \
 297         SvANY(p) = 0;                                   \
 298         SvREFCNT(p) = 1;                                \
 299         SvFLAGS(p) = 0;                                 \
 300         MEM_LOG_NEW_SV(p, __FILE__, __LINE__, FUNCTION__);  \
 301     } STMT_END
 302 #endif
 303
 304
 305 /* del_SV(): return an empty SV head to the free list */
 306
 307 #ifdef DEBUGGING
 308
 309 #define del_SV(p) \
 310     STMT_START {                                        \
 311         if (DEBUG_D_TEST)                               \
 312             del_sv(p);                                  \
 313         else                                            \
 314             plant_SV(p);                                \
 315     } STMT_END
 316
 317 STATIC void
 318 S_del_sv(pTHX_ SV *p)
 319 {
 320     dVAR;
 321
 322     PERL_ARGS_ASSERT_DEL_SV;
 323
 324     if (DEBUG_D_TEST) {
 325         SV* sva;
 326         bool ok = 0;
 327         for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
 328             const SV * const sv = sva + 1;
 329             const SV * const svend = &sva[SvREFCNT(sva)];
 330             if (p >= sv && p < svend) {
 331                 ok = 1;
 332                 break;
 333             }
 334         }
 335         if (!ok) {
 336             Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
 337                              "Attempt to free non-arena SV: 0x%"UVxf
 338                              pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
 339             return;
 340         }
 341     }
 342     plant_SV(p);
 343 }
 344
 345 #else /* ! DEBUGGING */
 346
 347 #define del_SV(p)   plant_SV(p)
 348
 349 #endif /* DEBUGGING */
 350
 351
 352 /*
 353 =head1 SV Manipulation Functions
 354
 355 =for apidoc sv_add_arena
 356
 357 Given a chunk of memory, link it to the head of the list of arenas,
 358 and split it into a list of free SVs.
 359
 360 =cut
 361 */
 362
 363 static void
 364 S_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
 365 {
 366     dVAR;
 367     SV *const sva = MUTABLE_SV(ptr);
 368     register SV* sv;
 369     register SV* svend;
 370
 371     PERL_ARGS_ASSERT_SV_ADD_ARENA;
 372
 373     /* The first SV in an arena isn't an SV. */
 374     SvANY(sva) = (void *) PL_sv_arenaroot;              /* ptr to next arena */
 375     SvREFCNT(sva) = size / sizeof(SV);          /* number of SV slots */
 376     SvFLAGS(sva) = flags;                       /* FAKE if not to be freed */
 377
 378     PL_sv_arenaroot = sva;
 379     PL_sv_root = sva + 1;
 380
 381     svend = &sva[SvREFCNT(sva) - 1];
 382     sv = sva + 1;
 383     while (sv < svend) {
 384         SvARENA_CHAIN_SET(sv, (sv + 1));
 385 #ifdef DEBUGGING
 386         SvREFCNT(sv) = 0;
 387 #endif
 388         /* Must always set typemask because it's always checked in on cleanup
 389            when the arenas are walked looking for objects.  */
 390         SvFLAGS(sv) = SVTYPEMASK;
 391         sv++;
 392     }
 393     SvARENA_CHAIN_SET(sv, 0);
 394 #ifdef DEBUGGING
 395     SvREFCNT(sv) = 0;
 396 #endif
 397     SvFLAGS(sv) = SVTYPEMASK;
 398 }
 399
 400 /* visit(): call the named function for each non-free SV in the arenas
 401  * whose flags field matches the flags/mask args. */
 402
 403 STATIC I32
 404 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
 405 {
 406     dVAR;
 407     SV* sva;
 408     I32 visited = 0;
 409
 410     PERL_ARGS_ASSERT_VISIT;
 411
 412     for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
 413         register const SV * const svend = &sva[SvREFCNT(sva)];
 414         register SV* sv;
 415         for (sv = sva + 1; sv < svend; ++sv) {
 416             if (SvTYPE(sv) != SVTYPEMASK
 417                     && (sv->sv_flags & mask) == flags
 418                     && SvREFCNT(sv))
 419             {
 420                 (FCALL)(aTHX_ sv);
 421                 ++visited;
 422             }
 423         }
 424     }
 425     return visited;
 426 }
 427
 428 #ifdef DEBUGGING
 429
 430 /* called by sv_report_used() for each live SV */
 431
 432 static void
 433 do_report_used(pTHX_ SV *const sv)
 434 {
 435     if (SvTYPE(sv) != SVTYPEMASK) {
 436         PerlIO_printf(Perl_debug_log, "****\n");
 437         sv_dump(sv);
 438     }
 439 }
 440 #endif
 441
 442 /*
 443 =for apidoc sv_report_used
 444
 445 Dump the contents of all SVs not yet freed. (Debugging aid).
 446
 447 =cut
 448 */
 449
 450 void
 451 Perl_sv_report_used(pTHX)
 452 {
 453 #ifdef DEBUGGING
 454     visit(do_report_used, 0, 0);
 455 #else
 456     PERL_UNUSED_CONTEXT;
 457 #endif
 458 }
 459
 460 /* called by sv_clean_objs() for each live SV */
 461
 462 static void
 463 do_clean_objs(pTHX_ SV *const ref)
 464 {
 465     dVAR;
 466     assert (SvROK(ref));
 467     {
 468         SV * const target = SvRV(ref);
 469         if (SvOBJECT(target)) {
 470             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
 471             if (SvWEAKREF(ref)) {
 472                 sv_del_backref(target, ref);
 473                 SvWEAKREF_off(ref);
 474                 SvRV_set(ref, NULL);
 475             } else {
 476                 SvROK_off(ref);
 477                 SvRV_set(ref, NULL);
 478                 SvREFCNT_dec(target);
 479             }
 480         }
 481     }
 482
 483     /* XXX Might want to check arrays, etc. */
 484 }
 485
 486
 487 /* clear any slots in a GV which hold objects - except IO;
 488  * called by sv_clean_objs() for each live GV */
 489
 490 static void
 491 do_clean_named_objs(pTHX_ SV *const sv)
 492 {
 493     dVAR;
 494     SV *obj;
 495     assert(SvTYPE(sv) == SVt_PVGV);
 496     assert(isGV_with_GP(sv));
 497     if (!GvGP(sv))
 498         return;
 499
 500     /* freeing GP entries may indirectly free the current GV;
 501      * hold onto it while we mess with the GP slots */
 502     SvREFCNT_inc(sv);
 503
 504     if ( ((obj = GvSV(sv) )) && SvOBJECT(obj)) {
 505         DEBUG_D((PerlIO_printf(Perl_debug_log,
 506                 "Cleaning named glob SV object:\n "), sv_dump(obj)));
 507         GvSV(sv) = NULL;
 508         SvREFCNT_dec(obj);
 509     }
 510     if ( ((obj = MUTABLE_SV(GvAV(sv)) )) && SvOBJECT(obj)) {
 511         DEBUG_D((PerlIO_printf(Perl_debug_log,
 512                 "Cleaning named glob AV object:\n "), sv_dump(obj)));
 513         GvAV(sv) = NULL;
 514         SvREFCNT_dec(obj);
 515     }
 516     if ( ((obj = MUTABLE_SV(GvHV(sv)) )) && SvOBJECT(obj)) {
 517         DEBUG_D((PerlIO_printf(Perl_debug_log,
 518                 "Cleaning named glob HV object:\n "), sv_dump(obj)));
 519         GvHV(sv) = NULL;
 520         SvREFCNT_dec(obj);
 521     }
 522     if ( ((obj = MUTABLE_SV(GvCV(sv)) )) && SvOBJECT(obj)) {
 523         DEBUG_D((PerlIO_printf(Perl_debug_log,
 524                 "Cleaning named glob CV object:\n "), sv_dump(obj)));
 525         GvCV_set(sv, NULL);
 526         SvREFCNT_dec(obj);
 527     }
 528     SvREFCNT_dec(sv); /* undo the inc above */
 529 }
 530
 531 /* clear any IO slots in a GV which hold objects (except stderr, defout);
 532  * called by sv_clean_objs() for each live GV */
 533
 534 static void
 535 do_clean_named_io_objs(pTHX_ SV *const sv)
 536 {
 537     dVAR;
 538     SV *obj;
 539     assert(SvTYPE(sv) == SVt_PVGV);
 540     assert(isGV_with_GP(sv));
 541     if (!GvGP(sv) || sv == (SV*)PL_stderrgv || sv == (SV*)PL_defoutgv)
 542         return;
 543
 544     SvREFCNT_inc(sv);
 545     if ( ((obj = MUTABLE_SV(GvIO(sv)) )) && SvOBJECT(obj)) {
 546         DEBUG_D((PerlIO_printf(Perl_debug_log,
 547                 "Cleaning named glob IO object:\n "), sv_dump(obj)));
 548         GvIOp(sv) = NULL;
 549         SvREFCNT_dec(obj);
 550     }
 551     SvREFCNT_dec(sv); /* undo the inc above */
 552 }
 553
 554 /* Void wrapper to pass to visit() */
 555 static void
 556 do_curse(pTHX_ SV * const sv) {
 557     if ((PL_stderrgv && GvGP(PL_stderrgv) && (SV*)GvIO(PL_stderrgv) == sv)
 558      || (PL_defoutgv && GvGP(PL_defoutgv) && (SV*)GvIO(PL_defoutgv) == sv))
 559         return;
 560     (void)curse(sv, 0);
 561 }
 562
 563 /*
 564 =for apidoc sv_clean_objs
 565
 566 Attempt to destroy all objects not yet freed
 567
 568 =cut
 569 */
 570
 571 void
 572 Perl_sv_clean_objs(pTHX)
 573 {
 574     dVAR;
 575     GV *olddef, *olderr;
 576     PL_in_clean_objs = TRUE;
 577     visit(do_clean_objs, SVf_ROK, SVf_ROK);
 578     /* Some barnacles may yet remain, clinging to typeglobs.
 579      * Run the non-IO destructors first: they may want to output
 580      * error messages, close files etc */
 581     visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
 582     visit(do_clean_named_io_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
 583     /* And if there are some very tenacious barnacles clinging to arrays,
 584        closures, or what have you.... */
 585     visit(do_curse, SVs_OBJECT, SVs_OBJECT);
 586     olddef = PL_defoutgv;
 587     PL_defoutgv = NULL; /* disable skip of PL_defoutgv */
 588     if (olddef && isGV_with_GP(olddef))
 589         do_clean_named_io_objs(aTHX_ MUTABLE_SV(olddef));
 590     olderr = PL_stderrgv;
 591     PL_stderrgv = NULL; /* disable skip of PL_stderrgv */
 592     if (olderr && isGV_with_GP(olderr))
 593         do_clean_named_io_objs(aTHX_ MUTABLE_SV(olderr));
 594     SvREFCNT_dec(olddef);
 595     PL_in_clean_objs = FALSE;
 596 }
 597
 598 /* called by sv_clean_all() for each live SV */
 599
 600 static void
 601 do_clean_all(pTHX_ SV *const sv)
 602 {
 603     dVAR;
 604     if (sv == (const SV *) PL_fdpid || sv == (const SV *)PL_strtab) {
 605         /* don't clean pid table and strtab */
 606         return;
 607     }
 608     DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
 609     SvFLAGS(sv) |= SVf_BREAK;
 610     SvREFCNT_dec(sv);
 611 }
 612
 613 /*
 614 =for apidoc sv_clean_all
 615
 616 Decrement the refcnt of each remaining SV, possibly triggering a
 617 cleanup. This function may have to be called multiple times to free
 618 SVs which are in complex self-referential hierarchies.
 619
 620 =cut
 621 */
 622
 623 I32
 624 Perl_sv_clean_all(pTHX)
 625 {
 626     dVAR;
 627     I32 cleaned;
 628     PL_in_clean_all = TRUE;
 629     cleaned = visit(do_clean_all, 0,0);
 630     return cleaned;
 631 }
 632
 633 /*
 634   ARENASETS: a meta-arena implementation which separates arena-info
 635   into struct arena_set, which contains an array of struct
 636   arena_descs, each holding info for a single arena.  By separating
 637   the meta-info from the arena, we recover the 1st slot, formerly
 638   borrowed for list management.  The arena_set is about the size of an
 639   arena, avoiding the needless malloc overhead of a naive linked-list.
 640
 641   The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
 642   memory in the last arena-set (1/2 on average).  In trade, we get
 643   back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
 644   smaller types).  The recovery of the wasted space allows use of
 645   small arenas for large, rare body types, by changing array* fields
 646   in body_details_by_type[] below.
 647 */
 648 struct arena_desc {
 649     char       *arena;          /* the raw storage, allocated aligned */
 650     size_t      size;           /* its size ~4k typ */
 651     svtype      utype;          /* bodytype stored in arena */
 652 };
 653
 654 struct arena_set;
 655
 656 /* Get the maximum number of elements in set[] such that struct arena_set
 657    will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
 658    therefore likely to be 1 aligned memory page.  */
 659
 660 #define ARENAS_PER_SET  ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
 661                           - 2 * sizeof(int)) / sizeof (struct arena_desc))
 662
 663 struct arena_set {
 664     struct arena_set* next;
 665     unsigned int   set_size;    /* ie ARENAS_PER_SET */
 666     unsigned int   curr;        /* index of next available arena-desc */
 667     struct arena_desc set[ARENAS_PER_SET];
 668 };
 669
 670 /*
 671 =for apidoc sv_free_arenas
 672
 673 Deallocate the memory used by all arenas. Note that all the individual SV
 674 heads and bodies within the arenas must already have been freed.
 675
 676 =cut
 677 */
 678 void
 679 Perl_sv_free_arenas(pTHX)
 680 {
 681     dVAR;
 682     SV* sva;
 683     SV* svanext;
 684     unsigned int i;
 685
 686     /* Free arenas here, but be careful about fake ones.  (We assume
 687        contiguity of the fake ones with the corresponding real ones.) */
 688
 689     for (sva = PL_sv_arenaroot; sva; sva = svanext) {
 690         svanext = MUTABLE_SV(SvANY(sva));
 691         while (svanext && SvFAKE(svanext))
 692             svanext = MUTABLE_SV(SvANY(svanext));
 693
 694         if (!SvFAKE(sva))
 695             Safefree(sva);
 696     }
 697
 698     {
 699         struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
 700
 701         while (aroot) {
 702             struct arena_set *current = aroot;
 703             i = aroot->curr;
 704             while (i--) {
 705                 assert(aroot->set[i].arena);
 706                 Safefree(aroot->set[i].arena);
 707             }
 708             aroot = aroot->next;
 709             Safefree(current);
 710         }
 711     }
 712     PL_body_arenas = 0;
 713
 714     i = PERL_ARENA_ROOTS_SIZE;
 715     while (i--)
 716         PL_body_roots[i] = 0;
 717
 718     PL_sv_arenaroot = 0;
 719     PL_sv_root = 0;
 720 }
 721
 722 /*
 723   Here are mid-level routines that manage the allocation of bodies out
 724   of the various arenas.  There are 5 kinds of arenas:
 725
 726   1. SV-head arenas, which are discussed and handled above
 727   2. regular body arenas
 728   3. arenas for reduced-size bodies
 729   4. Hash-Entry arenas
 730
 731   Arena types 2 & 3 are chained by body-type off an array of
 732   arena-root pointers, which is indexed by svtype.  Some of the
 733   larger/less used body types are malloced singly, since a large
 734   unused block of them is wasteful.  Also, several svtypes dont have
 735   bodies; the data fits into the sv-head itself.  The arena-root
 736   pointer thus has a few unused root-pointers (which may be hijacked
 737   later for arena types 4,5)
 738
 739   3 differs from 2 as an optimization; some body types have several
 740   unused fields in the front of the structure (which are kept in-place
 741   for consistency).  These bodies can be allocated in smaller chunks,
 742   because the leading fields arent accessed.  Pointers to such bodies
 743   are decremented to point at the unused 'ghost' memory, knowing that
 744   the pointers are used with offsets to the real memory.
 745
 746
 747 =head1 SV-Body Allocation
 748
 749 Allocation of SV-bodies is similar to SV-heads, differing as follows;
 750 the allocation mechanism is used for many body types, so is somewhat
 751 more complicated, it uses arena-sets, and has no need for still-live
 752 SV detection.
 753
 754 At the outermost level, (new|del)_X*V macros return bodies of the
 755 appropriate type.  These macros call either (new|del)_body_type or
 756 (new|del)_body_allocated macro pairs, depending on specifics of the
 757 type.  Most body types use the former pair, the latter pair is used to
 758 allocate body types with "ghost fields".
 759
 760 "ghost fields" are fields that are unused in certain types, and
 761 consequently don't need to actually exist.  They are declared because
 762 they're part of a "base type", which allows use of functions as
 763 methods.  The simplest examples are AVs and HVs, 2 aggregate types
 764 which don't use the fields which support SCALAR semantics.
 765
 766 For these types, the arenas are carved up into appropriately sized
 767 chunks, we thus avoid wasted memory for those unaccessed members.
 768 When bodies are allocated, we adjust the pointer back in memory by the
 769 size of the part not allocated, so it's as if we allocated the full
 770 structure.  (But things will all go boom if you write to the part that
 771 is "not there", because you'll be overwriting the last members of the
 772 preceding structure in memory.)
 773
 774 We calculate the correction using the STRUCT_OFFSET macro on the first
 775 member present. If the allocated structure is smaller (no initial NV
 776 actually allocated) then the net effect is to subtract the size of the NV
 777 from the pointer, to return a new pointer as if an initial NV were actually
 778 allocated. (We were using structures named *_allocated for this, but
 779 this turned out to be a subtle bug, because a structure without an NV
 780 could have a lower alignment constraint, but the compiler is allowed to
 781 optimised accesses based on the alignment constraint of the actual pointer
 782 to the full structure, for example, using a single 64 bit load instruction
 783 because it "knows" that two adjacent 32 bit members will be 8-byte aligned.)
 784
 785 This is the same trick as was used for NV and IV bodies. Ironically it
 786 doesn't need to be used for NV bodies any more, because NV is now at
 787 the start of the structure. IV bodies don't need it either, because
 788 they are no longer allocated.
 789
 790 In turn, the new_body_* allocators call S_new_body(), which invokes
 791 new_body_inline macro, which takes a lock, and takes a body off the
 792 linked list at PL_body_roots[sv_type], calling Perl_more_bodies() if
 793 necessary to refresh an empty list.  Then the lock is released, and
 794 the body is returned.
 795
 796 Perl_more_bodies allocates a new arena, and carves it up into an array of N
 797 bodies, which it strings into a linked list.  It looks up arena-size
 798 and body-size from the body_details table described below, thus
 799 supporting the multiple body-types.
 800
 801 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
 802 the (new|del)_X*V macros are mapped directly to malloc/free.
 803
 804 For each sv-type, struct body_details bodies_by_type[] carries
 805 parameters which control these aspects of SV handling:
 806
 807 Arena_size determines whether arenas are used for this body type, and if
 808 so, how big they are.  PURIFY or PERL_ARENA_SIZE=0 set this field to
 809 zero, forcing individual mallocs and frees.
 810
 811 Body_size determines how big a body is, and therefore how many fit into
 812 each arena.  Offset carries the body-pointer adjustment needed for
 813 "ghost fields", and is used in *_allocated macros.
 814
 815 But its main purpose is to parameterize info needed in
 816 Perl_sv_upgrade().  The info here dramatically simplifies the function
 817 vs the implementation in 5.8.8, making it table-driven.  All fields
 818 are used for this, except for arena_size.
 819
 820 For the sv-types that have no bodies, arenas are not used, so those
 821 PL_body_roots[sv_type] are unused, and can be overloaded.  In
 822 something of a special case, SVt_NULL is borrowed for HE arenas;
 823 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
 824 bodies_by_type[SVt_NULL] slot is not used, as the table is not
 825 available in hv.c.
 826
 827 */
 828
 829 struct body_details {
 830     U8 body_size;       /* Size to allocate  */
 831     U8 copy;            /* Size of structure to copy (may be shorter)  */
 832     U8 offset;
 833     unsigned int type : 4;          /* We have space for a sanity check.  */
 834     unsigned int cant_upgrade : 1;  /* Cannot upgrade this type */
 835     unsigned int zero_nv : 1;       /* zero the NV when upgrading from this */
 836     unsigned int arena : 1;         /* Allocated from an arena */
 837     size_t arena_size;              /* Size of arena to allocate */
 838 };
 839
 840 #define HADNV FALSE
 841 #define NONV TRUE
 842
 843
 844 #ifdef PURIFY
 845 /* With -DPURFIY we allocate everything directly, and don't use arenas.
 846    This seems a rather elegant way to simplify some of the code below.  */
 847 #define HASARENA FALSE
 848 #else
 849 #define HASARENA TRUE
 850 #endif
 851 #define NOARENA FALSE
 852
 853 /* Size the arenas to exactly fit a given number of bodies.  A count
 854    of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
 855    simplifying the default.  If count > 0, the arena is sized to fit
 856    only that many bodies, allowing arenas to be used for large, rare
 857    bodies (XPVFM, XPVIO) without undue waste.  The arena size is
 858    limited by PERL_ARENA_SIZE, so we can safely oversize the
 859    declarations.
 860  */
 861 #define FIT_ARENA0(body_size)                           \
 862     ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
 863 #define FIT_ARENAn(count,body_size)                     \
 864     ( count * body_size <= PERL_ARENA_SIZE)             \
 865     ? count * body_size                                 \
 866     : FIT_ARENA0 (body_size)
 867 #define FIT_ARENA(count,body_size)                      \
 868     count                                               \
 869     ? FIT_ARENAn (count, body_size)                     \
 870     : FIT_ARENA0 (body_size)
 871
 872 /* Calculate the length to copy. Specifically work out the length less any
 873    final padding the compiler needed to add.  See the comment in sv_upgrade
 874    for why copying the padding proved to be a bug.  */
 875
 876 #define copy_length(type, last_member) \
 877         STRUCT_OFFSET(type, last_member) \
 878         + sizeof (((type*)SvANY((const SV *)0))->last_member)
 879
 880 static const struct body_details bodies_by_type[] = {
 881     /* HEs use this offset for their arena.  */
 882     { 0, 0, 0, SVt_NULL, FALSE, NONV, NOARENA, 0 },
 883
 884     /* The bind placeholder pretends to be an RV for now.
 885        Also it's marked as "can't upgrade" to stop anyone using it before it's
 886        implemented.  */
 887     { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
 888
 889     /* IVs are in the head, so the allocation size is 0.  */
 890     { 0,
 891       sizeof(IV), /* This is used to copy out the IV body.  */
 892       STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
 893       NOARENA /* IVS don't need an arena  */, 0
 894     },
 895
 896     /* 8 bytes on most ILP32 with IEEE doubles */
 897     { sizeof(NV), sizeof(NV),
 898       STRUCT_OFFSET(XPVNV, xnv_u),
 899       SVt_NV, FALSE, HADNV, HASARENA, FIT_ARENA(0, sizeof(NV)) },
 900
 901     /* 8 bytes on most ILP32 with IEEE doubles */
 902     { sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur),
 903       copy_length(XPV, xpv_len) - STRUCT_OFFSET(XPV, xpv_cur),
 904       + STRUCT_OFFSET(XPV, xpv_cur),
 905       SVt_PV, FALSE, NONV, HASARENA,
 906       FIT_ARENA(0, sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur)) },
 907
 908     /* 12 */
 909     { sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur),
 910       copy_length(XPVIV, xiv_u) - STRUCT_OFFSET(XPV, xpv_cur),
 911       + STRUCT_OFFSET(XPV, xpv_cur),
 912       SVt_PVIV, FALSE, NONV, HASARENA,
 913       FIT_ARENA(0, sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur)) },
 914
 915     /* 20 */
 916     { sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur),
 917       copy_length(XPVNV, xnv_u) - STRUCT_OFFSET(XPV, xpv_cur),
 918       + STRUCT_OFFSET(XPV, xpv_cur),
 919       SVt_PVNV, FALSE, HADNV, HASARENA,
 920       FIT_ARENA(0, sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur)) },
 921
 922     /* 28 */
 923     { sizeof(XPVMG), copy_length(XPVMG, xnv_u), 0, SVt_PVMG, FALSE, HADNV,
 924       HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
 925
 926     /* something big */
 927     { sizeof(regexp),
 928       sizeof(regexp),
 929       0,
 930       SVt_REGEXP, FALSE, NONV, HASARENA,
 931       FIT_ARENA(0, sizeof(regexp))
 932     },
 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),
 943       copy_length(XPVAV, xav_alloc),
 944       0,
 945       SVt_PVAV, TRUE, NONV, HASARENA,
 946       FIT_ARENA(0, sizeof(XPVAV)) },
 947
 948     { sizeof(XPVHV),
 949       copy_length(XPVHV, xhv_max),
 950       0,
 951       SVt_PVHV, TRUE, NONV, HASARENA,
 952       FIT_ARENA(0, sizeof(XPVHV)) },
 953
 954     /* 56 */
 955     { sizeof(XPVCV),
 956       sizeof(XPVCV),
 957       0,
 958       SVt_PVCV, TRUE, NONV, HASARENA,
 959       FIT_ARENA(0, sizeof(XPVCV)) },
 960
 961     { sizeof(XPVFM),
 962       sizeof(XPVFM),
 963       0,
 964       SVt_PVFM, TRUE, NONV, NOARENA,
 965       FIT_ARENA(20, sizeof(XPVFM)) },
 966
 967     /* XPVIO is 84 bytes, fits 48x */
 968     { sizeof(XPVIO),
 969       sizeof(XPVIO),
 970       0,
 971       SVt_PVIO, TRUE, NONV, HASARENA,
 972       FIT_ARENA(24, sizeof(XPVIO)) },
 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 /* return a thing to the free list */
 980
 981 #define del_body(thing, root)                           \
 982     STMT_START {                                        \
 983         void ** const thing_copy = (void **)thing;      \
 984         *thing_copy = *root;                            \
 985         *root = (void*)thing_copy;                      \
 986     } STMT_END
 987
 988 #ifdef PURIFY
 989
 990 #define new_XNV()       safemalloc(sizeof(XPVNV))
 991 #define new_XPVNV()     safemalloc(sizeof(XPVNV))
 992 #define new_XPVMG()     safemalloc(sizeof(XPVMG))
 993
 994 #define del_XPVGV(p)    safefree(p)
 995
 996 #else /* !PURIFY */
 997
 998 #define new_XNV()       new_body_allocated(SVt_NV)
 999 #define new_XPVNV()     new_body_allocated(SVt_PVNV)
1000 #define new_XPVMG()     new_body_allocated(SVt_PVMG)
1001
1002 #define del_XPVGV(p)    del_body(p + bodies_by_type[SVt_PVGV].offset,   \
1003                                  &PL_body_roots[SVt_PVGV])
1004
1005 #endif /* PURIFY */
1006
1007 /* no arena for you! */
1008
1009 #define new_NOARENA(details) \
1010         safemalloc((details)->body_size + (details)->offset)
1011 #define new_NOARENAZ(details) \
1012         safecalloc((details)->body_size + (details)->offset, 1)
1013
1014 void *
1015 Perl_more_bodies (pTHX_ const svtype sv_type, const size_t body_size,
1016                   const size_t arena_size)
1017 {
1018     dVAR;
1019     void ** const root = &PL_body_roots[sv_type];
1020     struct arena_desc *adesc;
1021     struct arena_set *aroot = (struct arena_set *) PL_body_arenas;
1022     unsigned int curr;
1023     char *start;
1024     const char *end;
1025     const size_t good_arena_size = Perl_malloc_good_size(arena_size);
1026 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1027     static bool done_sanity_check;
1028
1029     /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1030      * variables like done_sanity_check. */
1031     if (!done_sanity_check) {
1032         unsigned int i = SVt_LAST;
1033
1034         done_sanity_check = TRUE;
1035
1036         while (i--)
1037             assert (bodies_by_type[i].type == i);
1038     }
1039 #endif
1040
1041     assert(arena_size);
1042
1043     /* may need new arena-set to hold new arena */
1044     if (!aroot || aroot->curr >= aroot->set_size) {
1045         struct arena_set *newroot;
1046         Newxz(newroot, 1, struct arena_set);
1047         newroot->set_size = ARENAS_PER_SET;
1048         newroot->next = aroot;
1049         aroot = newroot;
1050         PL_body_arenas = (void *) newroot;
1051         DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
1052     }
1053
1054     /* ok, now have arena-set with at least 1 empty/available arena-desc */
1055     curr = aroot->curr++;
1056     adesc = &(aroot->set[curr]);
1057     assert(!adesc->arena);
1058
1059     Newx(adesc->arena, good_arena_size, char);
1060     adesc->size = good_arena_size;
1061     adesc->utype = sv_type;
1062     DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
1063                           curr, (void*)adesc->arena, (UV)good_arena_size));
1064
1065     start = (char *) adesc->arena;
1066
1067     /* Get the address of the byte after the end of the last body we can fit.
1068        Remember, this is integer division:  */
1069     end = start + good_arena_size / body_size * body_size;
1070
1071     /* computed count doesn't reflect the 1st slot reservation */
1072 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1073     DEBUG_m(PerlIO_printf(Perl_debug_log,
1074                           "arena %p end %p arena-size %d (from %d) type %d "
1075                           "size %d ct %d\n",
1076                           (void*)start, (void*)end, (int)good_arena_size,
1077                           (int)arena_size, sv_type, (int)body_size,
1078                           (int)good_arena_size / (int)body_size));
1079 #else
1080     DEBUG_m(PerlIO_printf(Perl_debug_log,
1081                           "arena %p end %p arena-size %d type %d size %d ct %d\n",
1082                           (void*)start, (void*)end,
1083                           (int)arena_size, sv_type, (int)body_size,
1084                           (int)good_arena_size / (int)body_size));
1085 #endif
1086     *root = (void *)start;
1087
1088     while (1) {
1089         /* Where the next body would start:  */
1090         char * const next = start + body_size;
1091
1092         if (next >= end) {
1093             /* This is the last body:  */
1094             assert(next == end);
1095
1096             *(void **)start = 0;
1097             return *root;
1098         }
1099
1100         *(void**) start = (void *)next;
1101         start = next;
1102     }
1103 }
1104
1105 /* grab a new thing from the free list, allocating more if necessary.
1106    The inline version is used for speed in hot routines, and the
1107    function using it serves the rest (unless PURIFY).
1108 */
1109 #define new_body_inline(xpv, sv_type) \
1110     STMT_START { \
1111         void ** const r3wt = &PL_body_roots[sv_type]; \
1112         xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt))      \
1113           ? *((void **)(r3wt)) : Perl_more_bodies(aTHX_ sv_type, \
1114                                              bodies_by_type[sv_type].body_size,\
1115                                              bodies_by_type[sv_type].arena_size)); \
1116         *(r3wt) = *(void**)(xpv); \
1117     } STMT_END
1118
1119 #ifndef PURIFY
1120
1121 STATIC void *
1122 S_new_body(pTHX_ const svtype sv_type)
1123 {
1124     dVAR;
1125     void *xpv;
1126     new_body_inline(xpv, sv_type);
1127     return xpv;
1128 }
1129
1130 #endif
1131
1132 static const struct body_details fake_rv =
1133     { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1134
1135 /*
1136 =for apidoc sv_upgrade
1137
1138 Upgrade an SV to a more complex form.  Generally adds a new body type to the
1139 SV, then copies across as much information as possible from the old body.
1140 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1141
1142 =cut
1143 */
1144
1145 void
1146 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1147 {
1148     dVAR;
1149     void*       old_body;
1150     void*       new_body;
1151     const svtype old_type = SvTYPE(sv);
1152     const struct body_details *new_type_details;
1153     const struct body_details *old_type_details
1154         = bodies_by_type + old_type;
1155     SV *referant = NULL;
1156
1157     PERL_ARGS_ASSERT_SV_UPGRADE;
1158
1159     if (old_type == new_type)
1160         return;
1161
1162     /* This clause was purposefully added ahead of the early return above to
1163        the shared string hackery for (sort {$a <=> $b} keys %hash), with the
1164        inference by Nick I-S that it would fix other troublesome cases. See
1165        changes 7162, 7163 (f130fd4589cf5fbb24149cd4db4137c8326f49c1 and parent)
1166
1167        Given that shared hash key scalars are no longer PVIV, but PV, there is
1168        no longer need to unshare so as to free up the IVX slot for its proper
1169        purpose. So it's safe to move the early return earlier.  */
1170
1171     if (new_type != SVt_PV && SvIsCOW(sv)) {
1172         sv_force_normal_flags(sv, 0);
1173     }
1174
1175     old_body = SvANY(sv);
1176
1177     /* Copying structures onto other structures that have been neatly zeroed
1178        has a subtle gotcha. Consider XPVMG
1179
1180        +------+------+------+------+------+-------+-------+
1181        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH |
1182        +------+------+------+------+------+-------+-------+
1183        0      4      8     12     16     20      24      28
1184
1185        where NVs are aligned to 8 bytes, so that sizeof that structure is
1186        actually 32 bytes long, with 4 bytes of padding at the end:
1187
1188        +------+------+------+------+------+-------+-------+------+
1189        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH | ???  |
1190        +------+------+------+------+------+-------+-------+------+
1191        0      4      8     12     16     20      24      28     32
1192
1193        so what happens if you allocate memory for this structure:
1194
1195        +------+------+------+------+------+-------+-------+------+------+...
1196        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH |  GP  | NAME |
1197        +------+------+------+------+------+-------+-------+------+------+...
1198        0      4      8     12     16     20      24      28     32     36
1199
1200        zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1201        expect, because you copy the area marked ??? onto GP. Now, ??? may have
1202        started out as zero once, but it's quite possible that it isn't. So now,
1203        rather than a nicely zeroed GP, you have it pointing somewhere random.
1204        Bugs ensue.
1205
1206        (In fact, GP ends up pointing at a previous GP structure, because the
1207        principle cause of the padding in XPVMG getting garbage is a copy of
1208        sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1209        this happens to be moot because XPVGV has been re-ordered, with GP
1210        no longer after STASH)
1211
1212        So we are careful and work out the size of used parts of all the
1213        structures.  */
1214
1215     switch (old_type) {
1216     case SVt_NULL:
1217         break;
1218     case SVt_IV:
1219         if (SvROK(sv)) {
1220             referant = SvRV(sv);
1221             old_type_details = &fake_rv;
1222             if (new_type == SVt_NV)
1223                 new_type = SVt_PVNV;
1224         } else {
1225             if (new_type < SVt_PVIV) {
1226                 new_type = (new_type == SVt_NV)
1227                     ? SVt_PVNV : SVt_PVIV;
1228             }
1229         }
1230         break;
1231     case SVt_NV:
1232         if (new_type < SVt_PVNV) {
1233             new_type = SVt_PVNV;
1234         }
1235         break;
1236     case SVt_PV:
1237         assert(new_type > SVt_PV);
1238         assert(SVt_IV < SVt_PV);
1239         assert(SVt_NV < SVt_PV);
1240         break;
1241     case SVt_PVIV:
1242         break;
1243     case SVt_PVNV:
1244         break;
1245     case SVt_PVMG:
1246         /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1247            there's no way that it can be safely upgraded, because perl.c
1248            expects to Safefree(SvANY(PL_mess_sv))  */
1249         assert(sv != PL_mess_sv);
1250         /* This flag bit is used to mean other things in other scalar types.
1251            Given that it only has meaning inside the pad, it shouldn't be set
1252            on anything that can get upgraded.  */
1253         assert(!SvPAD_TYPED(sv));
1254         break;
1255     default:
1256         if (old_type_details->cant_upgrade)
1257             Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1258                        sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1259     }
1260
1261     if (old_type > new_type)
1262         Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1263                 (int)old_type, (int)new_type);
1264
1265     new_type_details = bodies_by_type + new_type;
1266
1267     SvFLAGS(sv) &= ~SVTYPEMASK;
1268     SvFLAGS(sv) |= new_type;
1269
1270     /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1271        the return statements above will have triggered.  */
1272     assert (new_type != SVt_NULL);
1273     switch (new_type) {
1274     case SVt_IV:
1275         assert(old_type == SVt_NULL);
1276         SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1277         SvIV_set(sv, 0);
1278         return;
1279     case SVt_NV:
1280         assert(old_type == SVt_NULL);
1281         SvANY(sv) = new_XNV();
1282         SvNV_set(sv, 0);
1283         return;
1284     case SVt_PVHV:
1285     case SVt_PVAV:
1286         assert(new_type_details->body_size);
1287
1288 #ifndef PURIFY
1289         assert(new_type_details->arena);
1290         assert(new_type_details->arena_size);
1291         /* This points to the start of the allocated area.  */
1292         new_body_inline(new_body, new_type);
1293         Zero(new_body, new_type_details->body_size, char);
1294         new_body = ((char *)new_body) - new_type_details->offset;
1295 #else
1296         /* We always allocated the full length item with PURIFY. To do this
1297            we fake things so that arena is false for all 16 types..  */
1298         new_body = new_NOARENAZ(new_type_details);
1299 #endif
1300         SvANY(sv) = new_body;
1301         if (new_type == SVt_PVAV) {
1302             AvMAX(sv)   = -1;
1303             AvFILLp(sv) = -1;
1304             AvREAL_only(sv);
1305             if (old_type_details->body_size) {
1306                 AvALLOC(sv) = 0;
1307             } else {
1308                 /* It will have been zeroed when the new body was allocated.
1309                    Lets not write to it, in case it confuses a write-back
1310                    cache.  */
1311             }
1312         } else {
1313             assert(!SvOK(sv));
1314             SvOK_off(sv);
1315 #ifndef NODEFAULT_SHAREKEYS
1316             HvSHAREKEYS_on(sv);         /* key-sharing on by default */
1317 #endif
1318             HvMAX(sv) = 7; /* (start with 8 buckets) */
1319         }
1320
1321         /* SVt_NULL isn't the only thing upgraded to AV or HV.
1322            The target created by newSVrv also is, and it can have magic.
1323            However, it never has SvPVX set.
1324         */
1325         if (old_type == SVt_IV) {
1326             assert(!SvROK(sv));
1327         } else if (old_type >= SVt_PV) {
1328             assert(SvPVX_const(sv) == 0);
1329         }
1330
1331         if (old_type >= SVt_PVMG) {
1332             SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1333             SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1334         } else {
1335             sv->sv_u.svu_array = NULL; /* or svu_hash  */
1336         }
1337         break;
1338
1339
1340     case SVt_REGEXP:
1341         /* This ensures that SvTHINKFIRST(sv) is true, and hence that
1342            sv_force_normal_flags(sv) is called.  */
1343         SvFAKE_on(sv);
1344     case SVt_PVIV:
1345         /* XXX Is this still needed?  Was it ever needed?   Surely as there is
1346            no route from NV to PVIV, NOK can never be true  */
1347         assert(!SvNOKp(sv));
1348         assert(!SvNOK(sv));
1349     case SVt_PVIO:
1350     case SVt_PVFM:
1351     case SVt_PVGV:
1352     case SVt_PVCV:
1353     case SVt_PVLV:
1354     case SVt_PVMG:
1355     case SVt_PVNV:
1356     case SVt_PV:
1357
1358         assert(new_type_details->body_size);
1359         /* We always allocated the full length item with PURIFY. To do this
1360            we fake things so that arena is false for all 16 types..  */
1361         if(new_type_details->arena) {
1362             /* This points to the start of the allocated area.  */
1363             new_body_inline(new_body, new_type);
1364             Zero(new_body, new_type_details->body_size, char);
1365             new_body = ((char *)new_body) - new_type_details->offset;
1366         } else {
1367             new_body = new_NOARENAZ(new_type_details);
1368         }
1369         SvANY(sv) = new_body;
1370
1371         if (old_type_details->copy) {
1372             /* There is now the potential for an upgrade from something without
1373                an offset (PVNV or PVMG) to something with one (PVCV, PVFM)  */
1374             int offset = old_type_details->offset;
1375             int length = old_type_details->copy;
1376
1377             if (new_type_details->offset > old_type_details->offset) {
1378                 const int difference
1379                     = new_type_details->offset - old_type_details->offset;
1380                 offset += difference;
1381                 length -= difference;
1382             }
1383             assert (length >= 0);
1384
1385             Copy((char *)old_body + offset, (char *)new_body + offset, length,
1386                  char);
1387         }
1388
1389 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1390         /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1391          * correct 0.0 for us.  Otherwise, if the old body didn't have an
1392          * NV slot, but the new one does, then we need to initialise the
1393          * freshly created NV slot with whatever the correct bit pattern is
1394          * for 0.0  */
1395         if (old_type_details->zero_nv && !new_type_details->zero_nv
1396             && !isGV_with_GP(sv))
1397             SvNV_set(sv, 0);
1398 #endif
1399
1400         if (new_type == SVt_PVIO) {
1401             IO * const io = MUTABLE_IO(sv);
1402             GV *iogv = gv_fetchpvs("IO::File::", GV_ADD, SVt_PVHV);
1403
1404             SvOBJECT_on(io);
1405             /* Clear the stashcache because a new IO could overrule a package
1406                name */
1407             hv_clear(PL_stashcache);
1408
1409             SvSTASH_set(io, MUTABLE_HV(SvREFCNT_inc(GvHV(iogv))));
1410             IoPAGE_LEN(sv) = 60;
1411         }
1412         if (old_type < SVt_PV) {
1413             /* referant will be NULL unless the old type was SVt_IV emulating
1414                SVt_RV */
1415             sv->sv_u.svu_rv = referant;
1416         }
1417         break;
1418     default:
1419         Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1420                    (unsigned long)new_type);
1421     }
1422
1423     if (old_type > SVt_IV) {
1424 #ifdef PURIFY
1425         safefree(old_body);
1426 #else
1427         /* Note that there is an assumption that all bodies of types that
1428            can be upgraded came from arenas. Only the more complex non-
1429            upgradable types are allowed to be directly malloc()ed.  */
1430         assert(old_type_details->arena);
1431         del_body((void*)((char*)old_body + old_type_details->offset),
1432                  &PL_body_roots[old_type]);
1433 #endif
1434     }
1435 }
1436
1437 /*
1438 =for apidoc sv_backoff
1439
1440 Remove any string offset. You should normally use the C<SvOOK_off> macro
1441 wrapper instead.
1442
1443 =cut
1444 */
1445
1446 int
1447 Perl_sv_backoff(pTHX_ register SV *const sv)
1448 {
1449     STRLEN delta;
1450     const char * const s = SvPVX_const(sv);
1451
1452     PERL_ARGS_ASSERT_SV_BACKOFF;
1453     PERL_UNUSED_CONTEXT;
1454
1455     assert(SvOOK(sv));
1456     assert(SvTYPE(sv) != SVt_PVHV);
1457     assert(SvTYPE(sv) != SVt_PVAV);
1458
1459     SvOOK_offset(sv, delta);
1460
1461     SvLEN_set(sv, SvLEN(sv) + delta);
1462     SvPV_set(sv, SvPVX(sv) - delta);
1463     Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1464     SvFLAGS(sv) &= ~SVf_OOK;
1465     return 0;
1466 }
1467
1468 /*
1469 =for apidoc sv_grow
1470
1471 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
1472 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
1473 Use the C<SvGROW> wrapper instead.
1474
1475 =cut
1476 */
1477
1478 char *
1479 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1480 {
1481     register char *s;
1482
1483     PERL_ARGS_ASSERT_SV_GROW;
1484
1485     if (PL_madskills && newlen >= 0x100000) {
1486         PerlIO_printf(Perl_debug_log,
1487                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1488     }
1489 #ifdef HAS_64K_LIMIT
1490     if (newlen >= 0x10000) {
1491         PerlIO_printf(Perl_debug_log,
1492                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1493         my_exit(1);
1494     }
1495 #endif /* HAS_64K_LIMIT */
1496     if (SvROK(sv))
1497         sv_unref(sv);
1498     if (SvTYPE(sv) < SVt_PV) {
1499         sv_upgrade(sv, SVt_PV);
1500         s = SvPVX_mutable(sv);
1501     }
1502     else if (SvOOK(sv)) {       /* pv is offset? */
1503         sv_backoff(sv);
1504         s = SvPVX_mutable(sv);
1505         if (newlen > SvLEN(sv))
1506             newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1507 #ifdef HAS_64K_LIMIT
1508         if (newlen >= 0x10000)
1509             newlen = 0xFFFF;
1510 #endif
1511     }
1512     else
1513         s = SvPVX_mutable(sv);
1514
1515     if (newlen > SvLEN(sv)) {           /* need more room? */
1516         STRLEN minlen = SvCUR(sv);
1517         minlen += (minlen >> PERL_STRLEN_EXPAND_SHIFT) + 10;
1518         if (newlen < minlen)
1519             newlen = minlen;
1520 #ifndef Perl_safesysmalloc_size
1521         newlen = PERL_STRLEN_ROUNDUP(newlen);
1522 #endif
1523         if (SvLEN(sv) && s) {
1524             s = (char*)saferealloc(s, newlen);
1525         }
1526         else {
1527             s = (char*)safemalloc(newlen);
1528             if (SvPVX_const(sv) && SvCUR(sv)) {
1529                 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1530             }
1531         }
1532         SvPV_set(sv, s);
1533 #ifdef Perl_safesysmalloc_size
1534         /* Do this here, do it once, do it right, and then we will never get
1535            called back into sv_grow() unless there really is some growing
1536            needed.  */
1537         SvLEN_set(sv, Perl_safesysmalloc_size(s));
1538 #else
1539         SvLEN_set(sv, newlen);
1540 #endif
1541     }
1542     return s;
1543 }
1544
1545 /*
1546 =for apidoc sv_setiv
1547
1548 Copies an integer into the given SV, upgrading first if necessary.
1549 Does not handle 'set' magic.  See also C<sv_setiv_mg>.
1550
1551 =cut
1552 */
1553
1554 void
1555 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1556 {
1557     dVAR;
1558
1559     PERL_ARGS_ASSERT_SV_SETIV;
1560
1561     SV_CHECK_THINKFIRST_COW_DROP(sv);
1562     switch (SvTYPE(sv)) {
1563     case SVt_NULL:
1564     case SVt_NV:
1565         sv_upgrade(sv, SVt_IV);
1566         break;
1567     case SVt_PV:
1568         sv_upgrade(sv, SVt_PVIV);
1569         break;
1570
1571     case SVt_PVGV:
1572         if (!isGV_with_GP(sv))
1573             break;
1574     case SVt_PVAV:
1575     case SVt_PVHV:
1576     case SVt_PVCV:
1577     case SVt_PVFM:
1578     case SVt_PVIO:
1579         /* diag_listed_as: Can't coerce %s to %s in %s */
1580         Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1581                    OP_DESC(PL_op));
1582     default: NOOP;
1583     }
1584     (void)SvIOK_only(sv);                       /* validate number */
1585     SvIV_set(sv, i);
1586     SvTAINT(sv);
1587 }
1588
1589 /*
1590 =for apidoc sv_setiv_mg
1591
1592 Like C<sv_setiv>, but also handles 'set' magic.
1593
1594 =cut
1595 */
1596
1597 void
1598 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1599 {
1600     PERL_ARGS_ASSERT_SV_SETIV_MG;
1601
1602     sv_setiv(sv,i);
1603     SvSETMAGIC(sv);
1604 }
1605
1606 /*
1607 =for apidoc sv_setuv
1608
1609 Copies an unsigned integer into the given SV, upgrading first if necessary.
1610 Does not handle 'set' magic.  See also C<sv_setuv_mg>.
1611
1612 =cut
1613 */
1614
1615 void
1616 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1617 {
1618     PERL_ARGS_ASSERT_SV_SETUV;
1619
1620     /* With these two if statements:
1621        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1622
1623        without
1624        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1625
1626        If you wish to remove them, please benchmark to see what the effect is
1627     */
1628     if (u <= (UV)IV_MAX) {
1629        sv_setiv(sv, (IV)u);
1630        return;
1631     }
1632     sv_setiv(sv, 0);
1633     SvIsUV_on(sv);
1634     SvUV_set(sv, u);
1635 }
1636
1637 /*
1638 =for apidoc sv_setuv_mg
1639
1640 Like C<sv_setuv>, but also handles 'set' magic.
1641
1642 =cut
1643 */
1644
1645 void
1646 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1647 {
1648     PERL_ARGS_ASSERT_SV_SETUV_MG;
1649
1650     sv_setuv(sv,u);
1651     SvSETMAGIC(sv);
1652 }
1653
1654 /*
1655 =for apidoc sv_setnv
1656
1657 Copies a double into the given SV, upgrading first if necessary.
1658 Does not handle 'set' magic.  See also C<sv_setnv_mg>.
1659
1660 =cut
1661 */
1662
1663 void
1664 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1665 {
1666     dVAR;
1667
1668     PERL_ARGS_ASSERT_SV_SETNV;
1669
1670     SV_CHECK_THINKFIRST_COW_DROP(sv);
1671     switch (SvTYPE(sv)) {
1672     case SVt_NULL:
1673     case SVt_IV:
1674         sv_upgrade(sv, SVt_NV);
1675         break;
1676     case SVt_PV:
1677     case SVt_PVIV:
1678         sv_upgrade(sv, SVt_PVNV);
1679         break;
1680
1681     case SVt_PVGV:
1682         if (!isGV_with_GP(sv))
1683             break;
1684     case SVt_PVAV:
1685     case SVt_PVHV:
1686     case SVt_PVCV:
1687     case SVt_PVFM:
1688     case SVt_PVIO:
1689         /* diag_listed_as: Can't coerce %s to %s in %s */
1690         Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1691                    OP_DESC(PL_op));
1692     default: NOOP;
1693     }
1694     SvNV_set(sv, num);
1695     (void)SvNOK_only(sv);                       /* validate number */
1696     SvTAINT(sv);
1697 }
1698
1699 /*
1700 =for apidoc sv_setnv_mg
1701
1702 Like C<sv_setnv>, but also handles 'set' magic.
1703
1704 =cut
1705 */
1706
1707 void
1708 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1709 {
1710     PERL_ARGS_ASSERT_SV_SETNV_MG;
1711
1712     sv_setnv(sv,num);
1713     SvSETMAGIC(sv);
1714 }
1715
1716 /* Print an "isn't numeric" warning, using a cleaned-up,
1717  * printable version of the offending string
1718  */
1719
1720 STATIC void
1721 S_not_a_number(pTHX_ SV *const sv)
1722 {
1723      dVAR;
1724      SV *dsv;
1725      char tmpbuf[64];
1726      const char *pv;
1727
1728      PERL_ARGS_ASSERT_NOT_A_NUMBER;
1729
1730      if (DO_UTF8(sv)) {
1731           dsv = newSVpvs_flags("", SVs_TEMP);
1732           pv = sv_uni_display(dsv, sv, 10, 0);
1733      } else {
1734           char *d = tmpbuf;
1735           const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1736           /* each *s can expand to 4 chars + "...\0",
1737              i.e. need room for 8 chars */
1738
1739           const char *s = SvPVX_const(sv);
1740           const char * const end = s + SvCUR(sv);
1741           for ( ; s < end && d < limit; s++ ) {
1742                int ch = *s & 0xFF;
1743                if (ch & 128 && !isPRINT_LC(ch)) {
1744                     *d++ = 'M';
1745                     *d++ = '-';
1746                     ch &= 127;
1747                }
1748                if (ch == '\n') {
1749                     *d++ = '\\';
1750                     *d++ = 'n';
1751                }
1752                else if (ch == '\r') {
1753                     *d++ = '\\';
1754                     *d++ = 'r';
1755                }
1756                else if (ch == '\f') {
1757                     *d++ = '\\';
1758                     *d++ = 'f';
1759                }
1760                else if (ch == '\\') {
1761                     *d++ = '\\';
1762                     *d++ = '\\';
1763                }
1764                else if (ch == '\0') {
1765                     *d++ = '\\';
1766                     *d++ = '0';
1767                }
1768                else if (isPRINT_LC(ch))
1769                     *d++ = ch;
1770                else {
1771                     *d++ = '^';
1772                     *d++ = toCTRL(ch);
1773                }
1774           }
1775           if (s < end) {
1776                *d++ = '.';
1777                *d++ = '.';
1778                *d++ = '.';
1779           }
1780           *d = '\0';
1781           pv = tmpbuf;
1782     }
1783
1784     if (PL_op)
1785         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1786                     "Argument \"%s\" isn't numeric in %s", pv,
1787                     OP_DESC(PL_op));
1788     else
1789         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1790                     "Argument \"%s\" isn't numeric", pv);
1791 }
1792
1793 /*
1794 =for apidoc looks_like_number
1795
1796 Test if the content of an SV looks like a number (or is a number).
1797 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1798 non-numeric warning), even if your atof() doesn't grok them.
1799
1800 =cut
1801 */
1802
1803 I32
1804 Perl_looks_like_number(pTHX_ SV *const sv)
1805 {
1806     register const char *sbegin;
1807     STRLEN len;
1808
1809     PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1810
1811     if (SvPOK(sv)) {
1812         sbegin = SvPVX_const(sv);
1813         len = SvCUR(sv);
1814     }
1815     else if (SvPOKp(sv))
1816         sbegin = SvPV_const(sv, len);
1817     else
1818         return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1819     return grok_number(sbegin, len, NULL);
1820 }
1821
1822 STATIC bool
1823 S_glob_2number(pTHX_ GV * const gv)
1824 {
1825     const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1826     SV *const buffer = sv_newmortal();
1827
1828     PERL_ARGS_ASSERT_GLOB_2NUMBER;
1829
1830     /* FAKE globs can get coerced, so need to turn this off temporarily if it
1831        is on.  */
1832     SvFAKE_off(gv);
1833     gv_efullname3(buffer, gv, "*");
1834     SvFLAGS(gv) |= wasfake;
1835
1836     /* We know that all GVs stringify to something that is not-a-number,
1837         so no need to test that.  */
1838     if (ckWARN(WARN_NUMERIC))
1839         not_a_number(buffer);
1840     /* We just want something true to return, so that S_sv_2iuv_common
1841         can tail call us and return true.  */
1842     return TRUE;
1843 }
1844
1845 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1846    until proven guilty, assume that things are not that bad... */
1847
1848 /*
1849    NV_PRESERVES_UV:
1850
1851    As 64 bit platforms often have an NV that doesn't preserve all bits of
1852    an IV (an assumption perl has been based on to date) it becomes necessary
1853    to remove the assumption that the NV always carries enough precision to
1854    recreate the IV whenever needed, and that the NV is the canonical form.
1855    Instead, IV/UV and NV need to be given equal rights. So as to not lose
1856    precision as a side effect of conversion (which would lead to insanity
1857    and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1858    1) to distinguish between IV/UV/NV slots that have cached a valid
1859       conversion where precision was lost and IV/UV/NV slots that have a
1860       valid conversion which has lost no precision
1861    2) to ensure that if a numeric conversion to one form is requested that
1862       would lose precision, the precise conversion (or differently
1863       imprecise conversion) is also performed and cached, to prevent
1864       requests for different numeric formats on the same SV causing
1865       lossy conversion chains. (lossless conversion chains are perfectly
1866       acceptable (still))
1867
1868
1869    flags are used:
1870    SvIOKp is true if the IV slot contains a valid value
1871    SvIOK  is true only if the IV value is accurate (UV if SvIOK_UV true)
1872    SvNOKp is true if the NV slot contains a valid value
1873    SvNOK  is true only if the NV value is accurate
1874
1875    so
1876    while converting from PV to NV, check to see if converting that NV to an
1877    IV(or UV) would lose accuracy over a direct conversion from PV to
1878    IV(or UV). If it would, cache both conversions, return NV, but mark
1879    SV as IOK NOKp (ie not NOK).
1880
1881    While converting from PV to IV, check to see if converting that IV to an
1882    NV would lose accuracy over a direct conversion from PV to NV. If it
1883    would, cache both conversions, flag similarly.
1884
1885    Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1886    correctly because if IV & NV were set NV *always* overruled.
1887    Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1888    changes - now IV and NV together means that the two are interchangeable:
1889    SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1890
1891    The benefit of this is that operations such as pp_add know that if
1892    SvIOK is true for both left and right operands, then integer addition
1893    can be used instead of floating point (for cases where the result won't
1894    overflow). Before, floating point was always used, which could lead to
1895    loss of precision compared with integer addition.
1896
1897    * making IV and NV equal status should make maths accurate on 64 bit
1898      platforms
1899    * may speed up maths somewhat if pp_add and friends start to use
1900      integers when possible instead of fp. (Hopefully the overhead in
1901      looking for SvIOK and checking for overflow will not outweigh the
1902      fp to integer speedup)
1903    * will slow down integer operations (callers of SvIV) on "inaccurate"
1904      values, as the change from SvIOK to SvIOKp will cause a call into
1905      sv_2iv each time rather than a macro access direct to the IV slot
1906    * should speed up number->string conversion on integers as IV is
1907      favoured when IV and NV are equally accurate
1908
1909    ####################################################################
1910    You had better be using SvIOK_notUV if you want an IV for arithmetic:
1911    SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1912    On the other hand, SvUOK is true iff UV.
1913    ####################################################################
1914
1915    Your mileage will vary depending your CPU's relative fp to integer
1916    performance ratio.
1917 */
1918
1919 #ifndef NV_PRESERVES_UV
1920 #  define IS_NUMBER_UNDERFLOW_IV 1
1921 #  define IS_NUMBER_UNDERFLOW_UV 2
1922 #  define IS_NUMBER_IV_AND_UV    2
1923 #  define IS_NUMBER_OVERFLOW_IV  4
1924 #  define IS_NUMBER_OVERFLOW_UV  5
1925
1926 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1927
1928 /* For sv_2nv these three cases are "SvNOK and don't bother casting"  */
1929 STATIC int
1930 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1931 #  ifdef DEBUGGING
1932                        , I32 numtype
1933 #  endif
1934                        )
1935 {
1936     dVAR;
1937
1938     PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1939
1940     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));
1941     if (SvNVX(sv) < (NV)IV_MIN) {
1942         (void)SvIOKp_on(sv);
1943         (void)SvNOK_on(sv);
1944         SvIV_set(sv, IV_MIN);
1945         return IS_NUMBER_UNDERFLOW_IV;
1946     }
1947     if (SvNVX(sv) > (NV)UV_MAX) {
1948         (void)SvIOKp_on(sv);
1949         (void)SvNOK_on(sv);
1950         SvIsUV_on(sv);
1951         SvUV_set(sv, UV_MAX);
1952         return IS_NUMBER_OVERFLOW_UV;
1953     }
1954     (void)SvIOKp_on(sv);
1955     (void)SvNOK_on(sv);
1956     /* Can't use strtol etc to convert this string.  (See truth table in
1957        sv_2iv  */
1958     if (SvNVX(sv) <= (UV)IV_MAX) {
1959         SvIV_set(sv, I_V(SvNVX(sv)));
1960         if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1961             SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1962         } else {
1963             /* Integer is imprecise. NOK, IOKp */
1964         }
1965         return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1966     }
1967     SvIsUV_on(sv);
1968     SvUV_set(sv, U_V(SvNVX(sv)));
1969     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1970         if (SvUVX(sv) == UV_MAX) {
1971             /* As we know that NVs don't preserve UVs, UV_MAX cannot
1972                possibly be preserved by NV. Hence, it must be overflow.
1973                NOK, IOKp */
1974             return IS_NUMBER_OVERFLOW_UV;
1975         }
1976         SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1977     } else {
1978         /* Integer is imprecise. NOK, IOKp */
1979     }
1980     return IS_NUMBER_OVERFLOW_IV;
1981 }
1982 #endif /* !NV_PRESERVES_UV*/
1983
1984 STATIC bool
1985 S_sv_2iuv_common(pTHX_ SV *const sv)
1986 {
1987     dVAR;
1988
1989     PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1990
1991     if (SvNOKp(sv)) {
1992         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1993          * without also getting a cached IV/UV from it at the same time
1994          * (ie PV->NV conversion should detect loss of accuracy and cache
1995          * IV or UV at same time to avoid this. */
1996         /* IV-over-UV optimisation - choose to cache IV if possible */
1997
1998         if (SvTYPE(sv) == SVt_NV)
1999             sv_upgrade(sv, SVt_PVNV);
2000
2001         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
2002         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2003            certainly cast into the IV range at IV_MAX, whereas the correct
2004            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2005            cases go to UV */
2006 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
2007         if (Perl_isnan(SvNVX(sv))) {
2008             SvUV_set(sv, 0);
2009             SvIsUV_on(sv);
2010             return FALSE;
2011         }
2012 #endif
2013         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2014             SvIV_set(sv, I_V(SvNVX(sv)));
2015             if (SvNVX(sv) == (NV) SvIVX(sv)
2016 #ifndef NV_PRESERVES_UV
2017                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2018                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2019                 /* Don't flag it as "accurately an integer" if the number
2020                    came from a (by definition imprecise) NV operation, and
2021                    we're outside the range of NV integer precision */
2022 #endif
2023                 ) {
2024                 if (SvNOK(sv))
2025                     SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2026                 else {
2027                     /* scalar has trailing garbage, eg "42a" */
2028                 }
2029                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2030                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2031                                       PTR2UV(sv),
2032                                       SvNVX(sv),
2033                                       SvIVX(sv)));
2034
2035             } else {
2036                 /* IV not precise.  No need to convert from PV, as NV
2037                    conversion would already have cached IV if it detected
2038                    that PV->IV would be better than PV->NV->IV
2039                    flags already correct - don't set public IOK.  */
2040                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2041                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2042                                       PTR2UV(sv),
2043                                       SvNVX(sv),
2044                                       SvIVX(sv)));
2045             }
2046             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2047                but the cast (NV)IV_MIN rounds to a the value less (more
2048                negative) than IV_MIN which happens to be equal to SvNVX ??
2049                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2050                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2051                (NV)UVX == NVX are both true, but the values differ. :-(
2052                Hopefully for 2s complement IV_MIN is something like
2053                0x8000000000000000 which will be exact. NWC */
2054         }
2055         else {
2056             SvUV_set(sv, U_V(SvNVX(sv)));
2057             if (
2058                 (SvNVX(sv) == (NV) SvUVX(sv))
2059 #ifndef  NV_PRESERVES_UV
2060                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2061                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2062                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2063                 /* Don't flag it as "accurately an integer" if the number
2064                    came from a (by definition imprecise) NV operation, and
2065                    we're outside the range of NV integer precision */
2066 #endif
2067                 && SvNOK(sv)
2068                 )
2069                 SvIOK_on(sv);
2070             SvIsUV_on(sv);
2071             DEBUG_c(PerlIO_printf(Perl_debug_log,
2072                                   "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2073                                   PTR2UV(sv),
2074                                   SvUVX(sv),
2075                                   SvUVX(sv)));
2076         }
2077     }
2078     else if (SvPOKp(sv) && SvLEN(sv)) {
2079         UV value;
2080         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2081         /* We want to avoid a possible problem when we cache an IV/ a UV which
2082            may be later translated to an NV, and the resulting NV is not
2083            the same as the direct translation of the initial string
2084            (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2085            be careful to ensure that the value with the .456 is around if the
2086            NV value is requested in the future).
2087
2088            This means that if we cache such an IV/a UV, we need to cache the
2089            NV as well.  Moreover, we trade speed for space, and do not
2090            cache the NV if we are sure it's not needed.
2091          */
2092
2093         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
2094         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2095              == IS_NUMBER_IN_UV) {
2096             /* It's definitely an integer, only upgrade to PVIV */
2097             if (SvTYPE(sv) < SVt_PVIV)
2098                 sv_upgrade(sv, SVt_PVIV);
2099             (void)SvIOK_on(sv);
2100         } else if (SvTYPE(sv) < SVt_PVNV)
2101             sv_upgrade(sv, SVt_PVNV);
2102
2103         /* If NVs preserve UVs then we only use the UV value if we know that
2104            we aren't going to call atof() below. If NVs don't preserve UVs
2105            then the value returned may have more precision than atof() will
2106            return, even though value isn't perfectly accurate.  */
2107         if ((numtype & (IS_NUMBER_IN_UV
2108 #ifdef NV_PRESERVES_UV
2109                         | IS_NUMBER_NOT_INT
2110 #endif
2111             )) == IS_NUMBER_IN_UV) {
2112             /* This won't turn off the public IOK flag if it was set above  */
2113             (void)SvIOKp_on(sv);
2114
2115             if (!(numtype & IS_NUMBER_NEG)) {
2116                 /* positive */;
2117                 if (value <= (UV)IV_MAX) {
2118                     SvIV_set(sv, (IV)value);
2119                 } else {
2120                     /* it didn't overflow, and it was positive. */
2121                     SvUV_set(sv, value);
2122                     SvIsUV_on(sv);
2123                 }
2124             } else {
2125                 /* 2s complement assumption  */
2126                 if (value <= (UV)IV_MIN) {
2127                     SvIV_set(sv, -(IV)value);
2128                 } else {
2129                     /* Too negative for an IV.  This is a double upgrade, but
2130                        I'm assuming it will be rare.  */
2131                     if (SvTYPE(sv) < SVt_PVNV)
2132                         sv_upgrade(sv, SVt_PVNV);
2133                     SvNOK_on(sv);
2134                     SvIOK_off(sv);
2135                     SvIOKp_on(sv);
2136                     SvNV_set(sv, -(NV)value);
2137                     SvIV_set(sv, IV_MIN);
2138                 }
2139             }
2140         }
2141         /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2142            will be in the previous block to set the IV slot, and the next
2143            block to set the NV slot.  So no else here.  */
2144
2145         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2146             != IS_NUMBER_IN_UV) {
2147             /* It wasn't an (integer that doesn't overflow the UV). */
2148             SvNV_set(sv, Atof(SvPVX_const(sv)));
2149
2150             if (! numtype && ckWARN(WARN_NUMERIC))
2151                 not_a_number(sv);
2152
2153 #if defined(USE_LONG_DOUBLE)
2154             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2155                                   PTR2UV(sv), SvNVX(sv)));
2156 #else
2157             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2158                                   PTR2UV(sv), SvNVX(sv)));
2159 #endif
2160
2161 #ifdef NV_PRESERVES_UV
2162             (void)SvIOKp_on(sv);
2163             (void)SvNOK_on(sv);
2164             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2165                 SvIV_set(sv, I_V(SvNVX(sv)));
2166                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2167                     SvIOK_on(sv);
2168                 } else {
2169                     NOOP;  /* Integer is imprecise. NOK, IOKp */
2170                 }
2171                 /* UV will not work better than IV */
2172             } else {
2173                 if (SvNVX(sv) > (NV)UV_MAX) {
2174                     SvIsUV_on(sv);
2175                     /* Integer is inaccurate. NOK, IOKp, is UV */
2176                     SvUV_set(sv, UV_MAX);
2177                 } else {
2178                     SvUV_set(sv, U_V(SvNVX(sv)));
2179                     /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2180                        NV preservse UV so can do correct comparison.  */
2181                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2182                         SvIOK_on(sv);
2183                     } else {
2184                         NOOP;   /* Integer is imprecise. NOK, IOKp, is UV */
2185                     }
2186                 }
2187                 SvIsUV_on(sv);
2188             }
2189 #else /* NV_PRESERVES_UV */
2190             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2191                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2192                 /* The IV/UV slot will have been set from value returned by
2193                    grok_number above.  The NV slot has just been set using
2194                    Atof.  */
2195                 SvNOK_on(sv);
2196                 assert (SvIOKp(sv));
2197             } else {
2198                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2199                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2200                     /* Small enough to preserve all bits. */
2201                     (void)SvIOKp_on(sv);
2202                     SvNOK_on(sv);
2203                     SvIV_set(sv, I_V(SvNVX(sv)));
2204                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2205                         SvIOK_on(sv);
2206                     /* Assumption: first non-preserved integer is < IV_MAX,
2207                        this NV is in the preserved range, therefore: */
2208                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2209                           < (UV)IV_MAX)) {
2210                         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);
2211                     }
2212                 } else {
2213                     /* IN_UV NOT_INT
2214                          0      0       already failed to read UV.
2215                          0      1       already failed to read UV.
2216                          1      0       you won't get here in this case. IV/UV
2217                                         slot set, public IOK, Atof() unneeded.
2218                          1      1       already read UV.
2219                        so there's no point in sv_2iuv_non_preserve() attempting
2220                        to use atol, strtol, strtoul etc.  */
2221 #  ifdef DEBUGGING
2222                     sv_2iuv_non_preserve (sv, numtype);
2223 #  else
2224                     sv_2iuv_non_preserve (sv);
2225 #  endif
2226                 }
2227             }
2228 #endif /* NV_PRESERVES_UV */
2229         /* It might be more code efficient to go through the entire logic above
2230            and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2231            gets complex and potentially buggy, so more programmer efficient
2232            to do it this way, by turning off the public flags:  */
2233         if (!numtype)
2234             SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2235         }
2236     }
2237     else  {
2238         if (isGV_with_GP(sv))
2239             return glob_2number(MUTABLE_GV(sv));
2240
2241         if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2242             if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2243                 report_uninit(sv);
2244         }
2245         if (SvTYPE(sv) < SVt_IV)
2246             /* Typically the caller expects that sv_any is not NULL now.  */
2247             sv_upgrade(sv, SVt_IV);
2248         /* Return 0 from the caller.  */
2249         return TRUE;
2250     }
2251     return FALSE;
2252 }
2253
2254 /*
2255 =for apidoc sv_2iv_flags
2256
2257 Return the integer value of an SV, doing any necessary string
2258 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2259 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2260
2261 =cut
2262 */
2263
2264 IV
2265 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2266 {
2267     dVAR;
2268     if (!sv)
2269         return 0;
2270     if (SvGMAGICAL(sv) || SvVALID(sv)) {
2271         /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2272            the same flag bit as SVf_IVisUV, so must not let them cache IVs.
2273            In practice they are extremely unlikely to actually get anywhere
2274            accessible by user Perl code - the only way that I'm aware of is when
2275            a constant subroutine which is used as the second argument to index.
2276         */
2277         if (flags & SV_GMAGIC)
2278             mg_get(sv);
2279         if (SvIOKp(sv))
2280             return SvIVX(sv);
2281         if (SvNOKp(sv)) {
2282             return I_V(SvNVX(sv));
2283         }
2284         if (SvPOKp(sv) && SvLEN(sv)) {
2285             UV value;
2286             const int numtype
2287                 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2288
2289             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2290                 == IS_NUMBER_IN_UV) {
2291                 /* It's definitely an integer */
2292                 if (numtype & IS_NUMBER_NEG) {
2293                     if (value < (UV)IV_MIN)
2294                         return -(IV)value;
2295                 } else {
2296                     if (value < (UV)IV_MAX)
2297                         return (IV)value;
2298                 }
2299             }
2300             if (!numtype) {
2301                 if (ckWARN(WARN_NUMERIC))
2302                     not_a_number(sv);
2303             }
2304             return I_V(Atof(SvPVX_const(sv)));
2305         }
2306         if (SvROK(sv)) {
2307             goto return_rok;
2308         }
2309         assert(SvTYPE(sv) >= SVt_PVMG);
2310         /* This falls through to the report_uninit inside S_sv_2iuv_common.  */
2311     } else if (SvTHINKFIRST(sv)) {
2312         if (SvROK(sv)) {
2313         return_rok:
2314             if (SvAMAGIC(sv)) {
2315                 SV * tmpstr;
2316                 if (flags & SV_SKIP_OVERLOAD)
2317                     return 0;
2318                 tmpstr = AMG_CALLunary(sv, numer_amg);
2319                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2320                     return SvIV(tmpstr);
2321                 }
2322             }
2323             return PTR2IV(SvRV(sv));
2324         }
2325         if (SvIsCOW(sv)) {
2326             sv_force_normal_flags(sv, 0);
2327         }
2328         if (SvREADONLY(sv) && !SvOK(sv)) {
2329             if (ckWARN(WARN_UNINITIALIZED))
2330                 report_uninit(sv);
2331             return 0;
2332         }
2333     }
2334     if (!SvIOKp(sv)) {
2335         if (S_sv_2iuv_common(aTHX_ sv))
2336             return 0;
2337     }
2338     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2339         PTR2UV(sv),SvIVX(sv)));
2340     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2341 }
2342
2343 /*
2344 =for apidoc sv_2uv_flags
2345
2346 Return the unsigned integer value of an SV, doing any necessary string
2347 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2348 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2349
2350 =cut
2351 */
2352
2353 UV
2354 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2355 {
2356     dVAR;
2357     if (!sv)
2358         return 0;
2359     if (SvGMAGICAL(sv) || SvVALID(sv)) {
2360         /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2361            the same flag bit as SVf_IVisUV, so must not let them cache IVs.  */
2362         if (flags & SV_GMAGIC)
2363             mg_get(sv);
2364         if (SvIOKp(sv))
2365             return SvUVX(sv);
2366         if (SvNOKp(sv))
2367             return U_V(SvNVX(sv));
2368         if (SvPOKp(sv) && SvLEN(sv)) {
2369             UV value;
2370             const int numtype
2371                 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2372
2373             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2374                 == IS_NUMBER_IN_UV) {
2375                 /* It's definitely an integer */
2376                 if (!(numtype & IS_NUMBER_NEG))
2377                     return value;
2378             }
2379             if (!numtype) {
2380                 if (ckWARN(WARN_NUMERIC))
2381                     not_a_number(sv);
2382             }
2383             return U_V(Atof(SvPVX_const(sv)));
2384         }
2385         if (SvROK(sv)) {
2386             goto return_rok;
2387         }
2388         assert(SvTYPE(sv) >= SVt_PVMG);
2389         /* This falls through to the report_uninit inside S_sv_2iuv_common.  */
2390     } else if (SvTHINKFIRST(sv)) {
2391         if (SvROK(sv)) {
2392         return_rok:
2393             if (SvAMAGIC(sv)) {
2394                 SV *tmpstr;
2395                 if (flags & SV_SKIP_OVERLOAD)
2396                     return 0;
2397                 tmpstr = AMG_CALLunary(sv, numer_amg);
2398                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2399                     return SvUV(tmpstr);
2400                 }
2401             }
2402             return PTR2UV(SvRV(sv));
2403         }
2404         if (SvIsCOW(sv)) {
2405             sv_force_normal_flags(sv, 0);
2406         }
2407         if (SvREADONLY(sv) && !SvOK(sv)) {
2408             if (ckWARN(WARN_UNINITIALIZED))
2409                 report_uninit(sv);
2410             return 0;
2411         }
2412     }
2413     if (!SvIOKp(sv)) {
2414         if (S_sv_2iuv_common(aTHX_ sv))
2415             return 0;
2416     }
2417
2418     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2419                           PTR2UV(sv),SvUVX(sv)));
2420     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2421 }
2422
2423 /*
2424 =for apidoc sv_2nv_flags
2425
2426 Return the num value of an SV, doing any necessary string or integer
2427 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2428 Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
2429
2430 =cut
2431 */
2432
2433 NV
2434 Perl_sv_2nv_flags(pTHX_ register SV *const sv, const I32 flags)
2435 {
2436     dVAR;
2437     if (!sv)
2438         return 0.0;
2439     if (SvGMAGICAL(sv) || SvVALID(sv)) {
2440         /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2441            the same flag bit as SVf_IVisUV, so must not let them cache NVs.  */
2442         if (flags & SV_GMAGIC)
2443             mg_get(sv);
2444         if (SvNOKp(sv))
2445             return SvNVX(sv);
2446         if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2447             if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2448                 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2449                 not_a_number(sv);
2450             return Atof(SvPVX_const(sv));
2451         }
2452         if (SvIOKp(sv)) {
2453             if (SvIsUV(sv))
2454                 return (NV)SvUVX(sv);
2455             else
2456                 return (NV)SvIVX(sv);
2457         }
2458         if (SvROK(sv)) {
2459             goto return_rok;
2460         }
2461         assert(SvTYPE(sv) >= SVt_PVMG);
2462         /* This falls through to the report_uninit near the end of the
2463            function. */
2464     } else if (SvTHINKFIRST(sv)) {
2465         if (SvROK(sv)) {
2466         return_rok:
2467             if (SvAMAGIC(sv)) {
2468                 SV *tmpstr;
2469                 if (flags & SV_SKIP_OVERLOAD)
2470                     return 0;
2471                 tmpstr = AMG_CALLunary(sv, numer_amg);
2472                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2473                     return SvNV(tmpstr);
2474                 }
2475             }
2476             return PTR2NV(SvRV(sv));
2477         }
2478         if (SvIsCOW(sv)) {
2479             sv_force_normal_flags(sv, 0);
2480         }
2481         if (SvREADONLY(sv) && !SvOK(sv)) {
2482             if (ckWARN(WARN_UNINITIALIZED))
2483                 report_uninit(sv);
2484             return 0.0;
2485         }
2486     }
2487     if (SvTYPE(sv) < SVt_NV) {
2488         /* The logic to use SVt_PVNV if necessary is in sv_upgrade.  */
2489         sv_upgrade(sv, SVt_NV);
2490 #ifdef USE_LONG_DOUBLE
2491         DEBUG_c({
2492             STORE_NUMERIC_LOCAL_SET_STANDARD();
2493             PerlIO_printf(Perl_debug_log,
2494                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2495                           PTR2UV(sv), SvNVX(sv));
2496             RESTORE_NUMERIC_LOCAL();
2497         });
2498 #else
2499         DEBUG_c({
2500             STORE_NUMERIC_LOCAL_SET_STANDARD();
2501             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2502                           PTR2UV(sv), SvNVX(sv));
2503             RESTORE_NUMERIC_LOCAL();
2504         });
2505 #endif
2506     }
2507     else if (SvTYPE(sv) < SVt_PVNV)
2508         sv_upgrade(sv, SVt_PVNV);
2509     if (SvNOKp(sv)) {
2510         return SvNVX(sv);
2511     }
2512     if (SvIOKp(sv)) {
2513         SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2514 #ifdef NV_PRESERVES_UV
2515         if (SvIOK(sv))
2516             SvNOK_on(sv);
2517         else
2518             SvNOKp_on(sv);
2519 #else
2520         /* Only set the public NV OK flag if this NV preserves the IV  */
2521         /* Check it's not 0xFFFFFFFFFFFFFFFF */
2522         if (SvIOK(sv) &&
2523             SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2524                        : (SvIVX(sv) == I_V(SvNVX(sv))))
2525             SvNOK_on(sv);
2526         else
2527             SvNOKp_on(sv);
2528 #endif
2529     }
2530     else if (SvPOKp(sv) && SvLEN(sv)) {
2531         UV value;
2532         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2533         if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2534             not_a_number(sv);
2535 #ifdef NV_PRESERVES_UV
2536         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2537             == IS_NUMBER_IN_UV) {
2538             /* It's definitely an integer */
2539             SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2540         } else
2541             SvNV_set(sv, Atof(SvPVX_const(sv)));
2542         if (numtype)
2543             SvNOK_on(sv);
2544         else
2545             SvNOKp_on(sv);
2546 #else
2547         SvNV_set(sv, Atof(SvPVX_const(sv)));
2548         /* Only set the public NV OK flag if this NV preserves the value in
2549            the PV at least as well as an IV/UV would.
2550            Not sure how to do this 100% reliably. */
2551         /* if that shift count is out of range then Configure's test is
2552            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2553            UV_BITS */
2554         if (((UV)1 << NV_PRESERVES_UV_BITS) >
2555             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2556             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2557         } else if (!(numtype & IS_NUMBER_IN_UV)) {
2558             /* Can't use strtol etc to convert this string, so don't try.
2559                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
2560             SvNOK_on(sv);
2561         } else {
2562             /* value has been set.  It may not be precise.  */
2563             if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2564                 /* 2s complement assumption for (UV)IV_MIN  */
2565                 SvNOK_on(sv); /* Integer is too negative.  */
2566             } else {
2567                 SvNOKp_on(sv);
2568                 SvIOKp_on(sv);
2569
2570                 if (numtype & IS_NUMBER_NEG) {
2571                     SvIV_set(sv, -(IV)value);
2572                 } else if (value <= (UV)IV_MAX) {
2573                     SvIV_set(sv, (IV)value);
2574                 } else {
2575                     SvUV_set(sv, value);
2576                     SvIsUV_on(sv);
2577                 }
2578
2579                 if (numtype & IS_NUMBER_NOT_INT) {
2580                     /* I believe that even if the original PV had decimals,
2581                        they are lost beyond the limit of the FP precision.
2582                        However, neither is canonical, so both only get p
2583                        flags.  NWC, 2000/11/25 */
2584                     /* Both already have p flags, so do nothing */
2585                 } else {
2586                     const NV nv = SvNVX(sv);
2587                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2588                         if (SvIVX(sv) == I_V(nv)) {
2589                             SvNOK_on(sv);
2590                         } else {
2591                             /* It had no "." so it must be integer.  */
2592                         }
2593                         SvIOK_on(sv);
2594                     } else {
2595                         /* between IV_MAX and NV(UV_MAX).
2596                            Could be slightly > UV_MAX */
2597
2598                         if (numtype & IS_NUMBER_NOT_INT) {
2599                             /* UV and NV both imprecise.  */
2600                         } else {
2601                             const UV nv_as_uv = U_V(nv);
2602
2603                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2604                                 SvNOK_on(sv);
2605                             }
2606                             SvIOK_on(sv);
2607                         }
2608                     }
2609                 }
2610             }
2611         }
2612         /* It might be more code efficient to go through the entire logic above
2613            and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2614            gets complex and potentially buggy, so more programmer efficient
2615            to do it this way, by turning off the public flags:  */
2616         if (!numtype)
2617             SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2618 #endif /* NV_PRESERVES_UV */
2619     }
2620     else  {
2621         if (isGV_with_GP(sv)) {
2622             glob_2number(MUTABLE_GV(sv));
2623             return 0.0;
2624         }
2625
2626         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2627             report_uninit(sv);
2628         assert (SvTYPE(sv) >= SVt_NV);
2629         /* Typically the caller expects that sv_any is not NULL now.  */
2630         /* XXX Ilya implies that this is a bug in callers that assume this
2631            and ideally should be fixed.  */
2632         return 0.0;
2633     }
2634 #if defined(USE_LONG_DOUBLE)
2635     DEBUG_c({
2636         STORE_NUMERIC_LOCAL_SET_STANDARD();
2637         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2638                       PTR2UV(sv), SvNVX(sv));
2639         RESTORE_NUMERIC_LOCAL();
2640     });
2641 #else
2642     DEBUG_c({
2643         STORE_NUMERIC_LOCAL_SET_STANDARD();
2644         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2645                       PTR2UV(sv), SvNVX(sv));
2646         RESTORE_NUMERIC_LOCAL();
2647     });
2648 #endif
2649     return SvNVX(sv);
2650 }
2651
2652 /*
2653 =for apidoc sv_2num
2654
2655 Return an SV with the numeric value of the source SV, doing any necessary
2656 reference or overload conversion.  You must use the C<SvNUM(sv)> macro to
2657 access this function.
2658
2659 =cut
2660 */
2661
2662 SV *
2663 Perl_sv_2num(pTHX_ register SV *const sv)
2664 {
2665     PERL_ARGS_ASSERT_SV_2NUM;
2666
2667     if (!SvROK(sv))
2668         return sv;
2669     if (SvAMAGIC(sv)) {
2670         SV * const tmpsv = AMG_CALLunary(sv, numer_amg);
2671         TAINT_IF(tmpsv && SvTAINTED(tmpsv));
2672         if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2673             return sv_2num(tmpsv);
2674     }
2675     return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2676 }
2677
2678 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2679  * UV as a string towards the end of buf, and return pointers to start and
2680  * end of it.
2681  *
2682  * We assume that buf is at least TYPE_CHARS(UV) long.
2683  */
2684
2685 static char *
2686 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2687 {
2688     char *ptr = buf + TYPE_CHARS(UV);
2689     char * const ebuf = ptr;
2690     int sign;
2691
2692     PERL_ARGS_ASSERT_UIV_2BUF;
2693
2694     if (is_uv)
2695         sign = 0;
2696     else if (iv >= 0) {
2697         uv = iv;
2698         sign = 0;
2699     } else {
2700         uv = -iv;
2701         sign = 1;
2702     }
2703     do {
2704         *--ptr = '0' + (char)(uv % 10);
2705     } while (uv /= 10);
2706     if (sign)
2707         *--ptr = '-';
2708     *peob = ebuf;
2709     return ptr;
2710 }
2711
2712 /*
2713 =for apidoc sv_2pv_flags
2714
2715 Returns a pointer to the string value of an SV, and sets *lp to its length.
2716 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2717 if necessary.
2718 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2719 usually end up here too.
2720
2721 =cut
2722 */
2723
2724 char *
2725 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2726 {
2727     dVAR;
2728     register char *s;
2729
2730     if (!sv) {
2731         if (lp)
2732             *lp = 0;
2733         return (char *)"";
2734     }
2735     if (SvGMAGICAL(sv)) {
2736         if (flags & SV_GMAGIC)
2737             mg_get(sv);
2738         if (SvPOKp(sv)) {
2739             if (lp)
2740                 *lp = SvCUR(sv);
2741             if (flags & SV_MUTABLE_RETURN)
2742                 return SvPVX_mutable(sv);
2743             if (flags & SV_CONST_RETURN)
2744                 return (char *)SvPVX_const(sv);
2745             return SvPVX(sv);
2746         }
2747         if (SvIOKp(sv) || SvNOKp(sv)) {
2748             char tbuf[64];  /* Must fit sprintf/Gconvert of longest IV/NV */
2749             STRLEN len;
2750
2751             if (SvIOKp(sv)) {
2752                 len = SvIsUV(sv)
2753                     ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2754                     : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2755             } else if(SvNVX(sv) == 0.0) {
2756                     tbuf[0] = '0';
2757                     tbuf[1] = 0;
2758                     len = 1;
2759             } else {
2760                 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2761                 len = strlen(tbuf);
2762             }
2763             assert(!SvROK(sv));
2764             {
2765                 dVAR;
2766
2767                 SvUPGRADE(sv, SVt_PV);
2768                 if (lp)
2769                     *lp = len;
2770                 s = SvGROW_mutable(sv, len + 1);
2771                 SvCUR_set(sv, len);
2772                 SvPOKp_on(sv);
2773                 return (char*)memcpy(s, tbuf, len + 1);
2774             }
2775         }
2776         if (SvROK(sv)) {
2777             goto return_rok;
2778         }
2779         assert(SvTYPE(sv) >= SVt_PVMG);
2780         /* This falls through to the report_uninit near the end of the
2781            function. */
2782     } else if (SvTHINKFIRST(sv)) {
2783         if (SvROK(sv)) {
2784         return_rok:
2785             if (SvAMAGIC(sv)) {
2786                 SV *tmpstr;
2787                 if (flags & SV_SKIP_OVERLOAD)
2788                     return NULL;
2789                 tmpstr = AMG_CALLunary(sv, string_amg);
2790                 TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2791                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2792                     /* Unwrap this:  */
2793                     /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2794                      */
2795
2796                     char *pv;
2797                     if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2798                         if (flags & SV_CONST_RETURN) {
2799                             pv = (char *) SvPVX_const(tmpstr);
2800                         } else {
2801                             pv = (flags & SV_MUTABLE_RETURN)
2802                                 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2803                         }
2804                         if (lp)
2805                             *lp = SvCUR(tmpstr);
2806                     } else {
2807                         pv = sv_2pv_flags(tmpstr, lp, flags);
2808                     }
2809                     if (SvUTF8(tmpstr))
2810                         SvUTF8_on(sv);
2811                     else
2812                         SvUTF8_off(sv);
2813                     return pv;
2814                 }
2815             }
2816             {
2817                 STRLEN len;
2818                 char *retval;
2819                 char *buffer;
2820                 SV *const referent = SvRV(sv);
2821
2822                 if (!referent) {
2823                     len = 7;
2824                     retval = buffer = savepvn("NULLREF", len);
2825                 } else if (SvTYPE(referent) == SVt_REGEXP) {
2826                     REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2827                     I32 seen_evals = 0;
2828
2829                     assert(re);
2830
2831                     /* If the regex is UTF-8 we want the containing scalar to
2832                        have an UTF-8 flag too */
2833                     if (RX_UTF8(re))
2834                         SvUTF8_on(sv);
2835                     else
2836                         SvUTF8_off(sv);
2837
2838                     if ((seen_evals = RX_SEEN_EVALS(re)))
2839                         PL_reginterp_cnt += seen_evals;
2840
2841                     if (lp)
2842                         *lp = RX_WRAPLEN(re);
2843
2844                     return RX_WRAPPED(re);
2845                 } else {
2846                     const char *const typestr = sv_reftype(referent, 0);
2847                     const STRLEN typelen = strlen(typestr);
2848                     UV addr = PTR2UV(referent);
2849                     const char *stashname = NULL;
2850                     STRLEN stashnamelen = 0; /* hush, gcc */
2851                     const char *buffer_end;
2852
2853                     if (SvOBJECT(referent)) {
2854                         const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2855
2856                         if (name) {
2857                             stashname = HEK_KEY(name);
2858                             stashnamelen = HEK_LEN(name);
2859
2860                             if (HEK_UTF8(name)) {
2861                                 SvUTF8_on(sv);
2862                             } else {
2863                                 SvUTF8_off(sv);
2864                             }
2865                         } else {
2866                             stashname = "__ANON__";
2867                             stashnamelen = 8;
2868                         }
2869                         len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2870                             + 2 * sizeof(UV) + 2 /* )\0 */;
2871                     } else {
2872                         len = typelen + 3 /* (0x */
2873                             + 2 * sizeof(UV) + 2 /* )\0 */;
2874                     }
2875
2876                     Newx(buffer, len, char);
2877                     buffer_end = retval = buffer + len;
2878
2879                     /* Working backwards  */
2880                     *--retval = '\0';
2881                     *--retval = ')';
2882                     do {
2883                         *--retval = PL_hexdigit[addr & 15];
2884                     } while (addr >>= 4);
2885                     *--retval = 'x';
2886                     *--retval = '0';
2887                     *--retval = '(';
2888
2889                     retval -= typelen;
2890                     memcpy(retval, typestr, typelen);
2891
2892                     if (stashname) {
2893                         *--retval = '=';
2894                         retval -= stashnamelen;
2895                         memcpy(retval, stashname, stashnamelen);
2896                     }
2897                     /* retval may not necessarily have reached the start of the
2898                        buffer here.  */
2899                     assert (retval >= buffer);
2900
2901                     len = buffer_end - retval - 1; /* -1 for that \0  */
2902                 }
2903                 if (lp)
2904                     *lp = len;
2905                 SAVEFREEPV(buffer);
2906                 return retval;
2907             }
2908         }
2909         if (SvREADONLY(sv) && !SvOK(sv)) {
2910             if (lp)
2911                 *lp = 0;
2912             if (flags & SV_UNDEF_RETURNS_NULL)
2913                 return NULL;
2914             if (ckWARN(WARN_UNINITIALIZED))
2915                 report_uninit(sv);
2916             return (char *)"";
2917         }
2918     }
2919     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2920         /* I'm assuming that if both IV and NV are equally valid then
2921            converting the IV is going to be more efficient */
2922         const U32 isUIOK = SvIsUV(sv);
2923         char buf[TYPE_CHARS(UV)];
2924         char *ebuf, *ptr;
2925         STRLEN len;
2926
2927         if (SvTYPE(sv) < SVt_PVIV)
2928             sv_upgrade(sv, SVt_PVIV);
2929         ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2930         len = ebuf - ptr;
2931         /* inlined from sv_setpvn */
2932         s = SvGROW_mutable(sv, len + 1);
2933         Move(ptr, s, len, char);
2934         s += len;
2935         *s = '\0';
2936     }
2937     else if (SvNOKp(sv)) {
2938         if (SvTYPE(sv) < SVt_PVNV)
2939             sv_upgrade(sv, SVt_PVNV);
2940         if (SvNVX(sv) == 0.0) {
2941             s = SvGROW_mutable(sv, 2);
2942             *s++ = '0';
2943             *s = '\0';
2944         } else {
2945             dSAVE_ERRNO;
2946             /* The +20 is pure guesswork.  Configure test needed. --jhi */
2947             s = SvGROW_mutable(sv, NV_DIG + 20);
2948             /* some Xenix systems wipe out errno here */
2949             Gconvert(SvNVX(sv), NV_DIG, 0, s);
2950             RESTORE_ERRNO;
2951             while (*s) s++;
2952         }
2953 #ifdef hcx
2954         if (s[-1] == '.')
2955             *--s = '\0';
2956 #endif
2957     }
2958     else {
2959         if (isGV_with_GP(sv)) {
2960             GV *const gv = MUTABLE_GV(sv);
2961             const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
2962             SV *const buffer = sv_newmortal();
2963
2964             /* FAKE globs can get coerced, so need to turn this off temporarily
2965                if it is on.  */
2966             SvFAKE_off(gv);
2967             gv_efullname3(buffer, gv, "*");
2968             SvFLAGS(gv) |= wasfake;
2969
2970             if (SvPOK(buffer)) {
2971                 if (lp) {
2972                     *lp = SvCUR(buffer);
2973                 }
2974                 return SvPVX(buffer);
2975             }
2976             else {
2977                 if (lp)
2978                     *lp = 0;
2979                 return (char *)"";
2980             }
2981         }
2982
2983         if (lp)
2984             *lp = 0;
2985         if (flags & SV_UNDEF_RETURNS_NULL)
2986             return NULL;
2987         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2988             report_uninit(sv);
2989         if (SvTYPE(sv) < SVt_PV)
2990             /* Typically the caller expects that sv_any is not NULL now.  */
2991             sv_upgrade(sv, SVt_PV);
2992         return (char *)"";
2993     }
2994     {
2995         const STRLEN len = s - SvPVX_const(sv);
2996         if (lp)
2997             *lp = len;
2998         SvCUR_set(sv, len);
2999     }
3000     SvPOK_on(sv);
3001     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3002                           PTR2UV(sv),SvPVX_const(sv)));
3003     if (flags & SV_CONST_RETURN)
3004         return (char *)SvPVX_const(sv);
3005     if (flags & SV_MUTABLE_RETURN)
3006         return SvPVX_mutable(sv);
3007     return SvPVX(sv);
3008 }
3009
3010 /*
3011 =for apidoc sv_copypv
3012
3013 Copies a stringified representation of the source SV into the
3014 destination SV.  Automatically performs any necessary mg_get and
3015 coercion of numeric values into strings.  Guaranteed to preserve
3016 UTF8 flag even from overloaded objects.  Similar in nature to
3017 sv_2pv[_flags] but operates directly on an SV instead of just the
3018 string.  Mostly uses sv_2pv_flags to do its work, except when that
3019 would lose the UTF-8'ness of the PV.
3020
3021 =cut
3022 */
3023
3024 void
3025 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3026 {
3027     STRLEN len;
3028     const char * const s = SvPV_const(ssv,len);
3029
3030     PERL_ARGS_ASSERT_SV_COPYPV;
3031
3032     sv_setpvn(dsv,s,len);
3033     if (SvUTF8(ssv))
3034         SvUTF8_on(dsv);
3035     else
3036         SvUTF8_off(dsv);
3037 }
3038
3039 /*
3040 =for apidoc sv_2pvbyte
3041
3042 Return a pointer to the byte-encoded representation of the SV, and set *lp
3043 to its length.  May cause the SV to be downgraded from UTF-8 as a
3044 side-effect.
3045
3046 Usually accessed via the C<SvPVbyte> macro.
3047
3048 =cut
3049 */
3050
3051 char *
3052 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3053 {
3054     PERL_ARGS_ASSERT_SV_2PVBYTE;
3055
3056     SvGETMAGIC(sv);
3057     sv_utf8_downgrade(sv,0);
3058     return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3059 }
3060
3061 /*
3062 =for apidoc sv_2pvutf8
3063
3064 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3065 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
3066
3067 Usually accessed via the C<SvPVutf8> macro.
3068
3069 =cut
3070 */
3071
3072 char *
3073 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3074 {
3075     PERL_ARGS_ASSERT_SV_2PVUTF8;
3076
3077     sv_utf8_upgrade(sv);
3078     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3079 }
3080
3081
3082 /*
3083 =for apidoc sv_2bool
3084
3085 This macro is only used by sv_true() or its macro equivalent, and only if
3086 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3087 It calls sv_2bool_flags with the SV_GMAGIC flag.
3088
3089 =for apidoc sv_2bool_flags
3090
3091 This function is only used by sv_true() and friends,  and only if
3092 the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3093 contain SV_GMAGIC, then it does an mg_get() first.
3094
3095
3096 =cut
3097 */
3098
3099 bool
3100 Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
3101 {
3102     dVAR;
3103
3104     PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3105
3106     if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3107
3108     if (!SvOK(sv))
3109         return 0;
3110     if (SvROK(sv)) {
3111         if (SvAMAGIC(sv)) {
3112             SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
3113             if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3114                 return cBOOL(SvTRUE(tmpsv));
3115         }
3116         return SvRV(sv) != 0;
3117     }
3118     if (SvPOKp(sv)) {
3119         register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3120         if (Xpvtmp &&
3121                 (*sv->sv_u.svu_pv > '0' ||
3122                 Xpvtmp->xpv_cur > 1 ||
3123                 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3124             return 1;
3125         else
3126             return 0;
3127     }
3128     else {
3129         if (SvIOKp(sv))
3130             return SvIVX(sv) != 0;
3131         else {
3132             if (SvNOKp(sv))
3133                 return SvNVX(sv) != 0.0;
3134             else {
3135                 if (isGV_with_GP(sv))
3136                     return TRUE;
3137                 else
3138                     return FALSE;
3139             }
3140         }
3141     }
3142 }
3143
3144 /*
3145 =for apidoc sv_utf8_upgrade
3146
3147 Converts the PV of an SV to its UTF-8-encoded form.
3148 Forces the SV to string form if it is not already.
3149 Will C<mg_get> on C<sv> if appropriate.
3150 Always sets the SvUTF8 flag to avoid future validity checks even
3151 if the whole string is the same in UTF-8 as not.
3152 Returns the number of bytes in the converted string
3153
3154 This is not as a general purpose byte encoding to Unicode interface:
3155 use the Encode extension for that.
3156
3157 =for apidoc sv_utf8_upgrade_nomg
3158
3159 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
3160
3161 =for apidoc sv_utf8_upgrade_flags
3162
3163 Converts the PV of an SV to its UTF-8-encoded form.
3164 Forces the SV to string form if it is not already.
3165 Always sets the SvUTF8 flag to avoid future validity checks even
3166 if all the bytes are invariant in UTF-8. If C<flags> has C<SV_GMAGIC> bit set,
3167 will C<mg_get> on C<sv> if appropriate, else not.
3168 Returns the number of bytes in the converted string
3169 C<sv_utf8_upgrade> and
3170 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3171
3172 This is not as a general purpose byte encoding to Unicode interface:
3173 use the Encode extension for that.
3174
3175 =cut
3176
3177 The grow version is currently not externally documented.  It adds a parameter,
3178 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3179 have free after it upon return.  This allows the caller to reserve extra space
3180 that it intends to fill, to avoid extra grows.
3181
3182 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3183 which can be used to tell this function to not first check to see if there are
3184 any characters that are different in UTF-8 (variant characters) which would
3185 force it to allocate a new string to sv, but to assume there are.  Typically
3186 this flag is used by a routine that has already parsed the string to find that
3187 there are such characters, and passes this information on so that the work
3188 doesn't have to be repeated.
3189
3190 (One might think that the calling routine could pass in the position of the
3191 first such variant, so it wouldn't have to be found again.  But that is not the
3192 case, because typically when the caller is likely to use this flag, it won't be
3193 calling this routine unless it finds something that won't fit into a byte.
3194 Otherwise it tries to not upgrade and just use bytes.  But some things that
3195 do fit into a byte are variants in utf8, and the caller may not have been
3196 keeping track of these.)
3197
3198 If the routine itself changes the string, it adds a trailing NUL.  Such a NUL
3199 isn't guaranteed due to having other routines do the work in some input cases,
3200 or if the input is already flagged as being in utf8.
3201
3202 The speed of this could perhaps be improved for many cases if someone wanted to
3203 write a fast function that counts the number of variant characters in a string,
3204 especially if it could return the position of the first one.
3205
3206 */
3207
3208 STRLEN
3209 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3210 {
3211     dVAR;
3212
3213     PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3214
3215     if (sv == &PL_sv_undef)
3216         return 0;
3217     if (!SvPOK(sv)) {
3218         STRLEN len = 0;
3219         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3220             (void) sv_2pv_flags(sv,&len, flags);
3221             if (SvUTF8(sv)) {
3222                 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3223                 return len;
3224             }
3225         } else {
3226             (void) SvPV_force_flags(sv,len,flags & SV_GMAGIC);
3227         }
3228     }
3229
3230     if (SvUTF8(sv)) {
3231         if (extra) SvGROW(sv, SvCUR(sv) + extra);
3232         return SvCUR(sv);
3233     }
3234
3235     if (SvIsCOW(sv)) {
3236         sv_force_normal_flags(sv, 0);
3237     }
3238
3239     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3240         sv_recode_to_utf8(sv, PL_encoding);
3241         if (extra) SvGROW(sv, SvCUR(sv) + extra);
3242         return SvCUR(sv);
3243     }
3244
3245     if (SvCUR(sv) == 0) {
3246         if (extra) SvGROW(sv, extra);
3247     } else { /* Assume Latin-1/EBCDIC */
3248         /* This function could be much more efficient if we
3249          * had a FLAG in SVs to signal if there are any variant
3250          * chars in the PV.  Given that there isn't such a flag
3251          * make the loop as fast as possible (although there are certainly ways
3252          * to speed this up, eg. through vectorization) */
3253         U8 * s = (U8 *) SvPVX_const(sv);
3254         U8 * e = (U8 *) SvEND(sv);
3255         U8 *t = s;
3256         STRLEN two_byte_count = 0;
3257
3258         if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3259
3260         /* See if really will need to convert to utf8.  We mustn't rely on our
3261          * incoming SV being well formed and having a trailing '\0', as certain
3262          * code in pp_formline can send us partially built SVs. */
3263
3264         while (t < e) {
3265             const U8 ch = *t++;
3266             if (NATIVE_IS_INVARIANT(ch)) continue;
3267
3268             t--;    /* t already incremented; re-point to first variant */
3269             two_byte_count = 1;
3270             goto must_be_utf8;
3271         }
3272
3273         /* utf8 conversion not needed because all are invariants.  Mark as
3274          * UTF-8 even if no variant - saves scanning loop */
3275         SvUTF8_on(sv);
3276         return SvCUR(sv);
3277
3278 must_be_utf8:
3279
3280         /* Here, the string should be converted to utf8, either because of an
3281          * input flag (two_byte_count = 0), or because a character that
3282          * requires 2 bytes was found (two_byte_count = 1).  t points either to
3283          * the beginning of the string (if we didn't examine anything), or to
3284          * the first variant.  In either case, everything from s to t - 1 will
3285          * occupy only 1 byte each on output.
3286          *
3287          * There are two main ways to convert.  One is to create a new string
3288          * and go through the input starting from the beginning, appending each
3289          * converted value onto the new string as we go along.  It's probably
3290          * best to allocate enough space in the string for the worst possible
3291          * case rather than possibly running out of space and having to
3292          * reallocate and then copy what we've done so far.  Since everything
3293          * from s to t - 1 is invariant, the destination can be initialized
3294          * with these using a fast memory copy
3295          *
3296          * The other way is to figure out exactly how big the string should be
3297          * by parsing the entire input.  Then you don't have to make it big
3298          * enough to handle the worst possible case, and more importantly, if
3299          * the string you already have is large enough, you don't have to
3300          * allocate a new string, you can copy the last character in the input
3301          * string to the final position(s) that will be occupied by the
3302          * converted string and go backwards, stopping at t, since everything
3303          * before that is invariant.
3304          *
3305          * There are advantages and disadvantages to each method.
3306          *
3307          * In the first method, we can allocate a new string, do the memory
3308          * copy from the s to t - 1, and then proceed through the rest of the
3309          * string byte-by-byte.
3310          *
3311          * In the second method, we proceed through the rest of the input
3312          * string just calculating how big the converted string will be.  Then
3313          * there are two cases:
3314          *  1)  if the string has enough extra space to handle the converted
3315          *      value.  We go backwards through the string, converting until we
3316          *      get to the position we are at now, and then stop.  If this
3317          *      position is far enough along in the string, this method is
3318          *      faster than the other method.  If the memory copy were the same
3319          *      speed as the byte-by-byte loop, that position would be about
3320          *      half-way, as at the half-way mark, parsing to the end and back
3321          *      is one complete string's parse, the same amount as starting
3322          *      over and going all the way through.  Actually, it would be
3323          *      somewhat less than half-way, as it's faster to just count bytes
3324          *      than to also copy, and we don't have the overhead of allocating
3325          *      a new string, changing the scalar to use it, and freeing the
3326          *      existing one.  But if the memory copy is fast, the break-even
3327          *      point is somewhere after half way.  The counting loop could be
3328          *      sped up by vectorization, etc, to move the break-even point
3329          *      further towards the beginning.
3330          *  2)  if the string doesn't have enough space to handle the converted
3331          *      value.  A new string will have to be allocated, and one might
3332          *      as well, given that, start from the beginning doing the first
3333          *      method.  We've spent extra time parsing the string and in
3334          *      exchange all we've gotten is that we know precisely how big to
3335          *      make the new one.  Perl is more optimized for time than space,
3336          *      so this case is a loser.
3337          * So what I've decided to do is not use the 2nd method unless it is
3338          * guaranteed that a new string won't have to be allocated, assuming
3339          * the worst case.  I also decided not to put any more conditions on it
3340          * than this, for now.  It seems likely that, since the worst case is
3341          * twice as big as the unknown portion of the string (plus 1), we won't
3342          * be guaranteed enough space, causing us to go to the first method,
3343          * unless the string is short, or the first variant character is near
3344          * the end of it.  In either of these cases, it seems best to use the
3345          * 2nd method.  The only circumstance I can think of where this would
3346          * be really slower is if the string had once had much more data in it
3347          * than it does now, but there is still a substantial amount in it  */
3348
3349         {
3350             STRLEN invariant_head = t - s;
3351             STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3352             if (SvLEN(sv) < size) {
3353
3354                 /* Here, have decided to allocate a new string */
3355
3356                 U8 *dst;
3357                 U8 *d;
3358
3359                 Newx(dst, size, U8);
3360
3361                 /* If no known invariants at the beginning of the input string,
3362                  * set so starts from there.  Otherwise, can use memory copy to
3363                  * get up to where we are now, and then start from here */
3364
3365                 if (invariant_head <= 0) {
3366                     d = dst;
3367                 } else {
3368                     Copy(s, dst, invariant_head, char);
3369                     d = dst + invariant_head;
3370                 }
3371
3372                 while (t < e) {
3373                     const UV uv = NATIVE8_TO_UNI(*t++);
3374                     if (UNI_IS_INVARIANT(uv))
3375                         *d++ = (U8)UNI_TO_NATIVE(uv);
3376                     else {
3377                         *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3378                         *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3379                     }
3380                 }
3381                 *d = '\0';
3382                 SvPV_free(sv); /* No longer using pre-existing string */
3383                 SvPV_set(sv, (char*)dst);
3384                 SvCUR_set(sv, d - dst);
3385                 SvLEN_set(sv, size);
3386             } else {
3387
3388                 /* Here, have decided to get the exact size of the string.
3389                  * Currently this happens only when we know that there is
3390                  * guaranteed enough space to fit the converted string, so
3391                  * don't have to worry about growing.  If two_byte_count is 0,
3392                  * then t points to the first byte of the string which hasn't
3393                  * been examined yet.  Otherwise two_byte_count is 1, and t
3394                  * points to the first byte in the string that will expand to
3395                  * two.  Depending on this, start examining at t or 1 after t.
3396                  * */
3397
3398                 U8 *d = t + two_byte_count;
3399
3400
3401                 /* Count up the remaining bytes that expand to two */
3402
3403                 while (d < e) {
3404                     const U8 chr = *d++;
3405                     if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3406                 }
3407
3408                 /* The string will expand by just the number of bytes that
3409                  * occupy two positions.  But we are one afterwards because of
3410                  * the increment just above.  This is the place to put the
3411                  * trailing NUL, and to set the length before we decrement */
3412
3413                 d += two_byte_count;
3414                 SvCUR_set(sv, d - s);
3415                 *d-- = '\0';
3416
3417
3418                 /* Having decremented d, it points to the position to put the
3419                  * very last byte of the expanded string.  Go backwards through
3420                  * the string, copying and expanding as we go, stopping when we
3421                  * get to the part that is invariant the rest of the way down */
3422
3423                 e--;
3424                 while (e >= t) {
3425                     const U8 ch = NATIVE8_TO_UNI(*e--);
3426                     if (UNI_IS_INVARIANT(ch)) {
3427                         *d-- = UNI_TO_NATIVE(ch);
3428                     } else {
3429                         *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3430                         *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3431                     }
3432                 }
3433             }
3434
3435             if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3436                 /* Update pos. We do it at the end rather than during
3437                  * the upgrade, to avoid slowing down the common case
3438                  * (upgrade without pos) */
3439                 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3440                 if (mg) {
3441                     I32 pos = mg->mg_len;
3442                     if (pos > 0 && (U32)pos > invariant_head) {
3443                         U8 *d = (U8*) SvPVX(sv) + invariant_head;
3444                         STRLEN n = (U32)pos - invariant_head;
3445                         while (n > 0) {
3446                             if (UTF8_IS_START(*d))
3447                                 d++;
3448                             d++;
3449                             n--;
3450                         }
3451                         mg->mg_len  = d - (U8*)SvPVX(sv);
3452                     }
3453                 }
3454                 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3455                     magic_setutf8(sv,mg); /* clear UTF8 cache */
3456             }
3457         }
3458     }
3459
3460     /* Mark as UTF-8 even if no variant - saves scanning loop */
3461     SvUTF8_on(sv);
3462     return SvCUR(sv);
3463 }
3464
3465 /*
3466 =for apidoc sv_utf8_downgrade
3467
3468 Attempts to convert the PV of an SV from characters to bytes.
3469 If the PV contains a character that cannot fit
3470 in a byte, this conversion will fail;
3471 in this case, either returns false or, if C<fail_ok> is not
3472 true, croaks.
3473
3474 This is not as a general purpose Unicode to byte encoding interface:
3475 use the Encode extension for that.
3476
3477 =cut
3478 */
3479
3480 bool
3481 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3482 {
3483     dVAR;
3484
3485     PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3486
3487     if (SvPOKp(sv) && SvUTF8(sv)) {
3488         if (SvCUR(sv)) {
3489             U8 *s;
3490             STRLEN len;
3491             int mg_flags = SV_GMAGIC;
3492
3493             if (SvIsCOW(sv)) {
3494                 sv_force_normal_flags(sv, 0);
3495             }
3496             if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3497                 /* update pos */
3498                 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3499                 if (mg) {
3500                     I32 pos = mg->mg_len;
3501                     if (pos > 0) {
3502                         sv_pos_b2u(sv, &pos);
3503                         mg_flags = 0; /* sv_pos_b2u does get magic */
3504                         mg->mg_len  = pos;
3505                     }
3506                 }
3507                 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3508                     magic_setutf8(sv,mg); /* clear UTF8 cache */
3509
3510             }
3511             s = (U8 *) SvPV_flags(sv, len, mg_flags);
3512
3513             if (!utf8_to_bytes(s, &len)) {
3514                 if (fail_ok)
3515                     return FALSE;
3516                 else {
3517                     if (PL_op)
3518                         Perl_croak(aTHX_ "Wide character in %s",
3519                                    OP_DESC(PL_op));
3520                     else
3521                         Perl_croak(aTHX_ "Wide character");
3522                 }
3523             }
3524             SvCUR_set(sv, len);
3525         }
3526     }
3527     SvUTF8_off(sv);
3528     return TRUE;
3529 }
3530
3531 /*
3532 =for apidoc sv_utf8_encode
3533
3534 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3535 flag off so that it looks like octets again.
3536
3537 =cut
3538 */
3539
3540 void
3541 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3542 {
3543     PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3544
3545     if (SvIsCOW(sv)) {
3546         sv_force_normal_flags(sv, 0);
3547     }
3548     if (SvREADONLY(sv)) {
3549         Perl_croak_no_modify(aTHX);
3550     }
3551     (void) sv_utf8_upgrade(sv);
3552     SvUTF8_off(sv);
3553 }
3554
3555 /*
3556 =for apidoc sv_utf8_decode
3557
3558 If the PV of the SV is an octet sequence in UTF-8
3559 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3560 so that it looks like a character. If the PV contains only single-byte
3561 characters, the C<SvUTF8> flag stays off.
3562 Scans PV for validity and returns false if the PV is invalid UTF-8.
3563
3564 =cut
3565 */
3566
3567 bool
3568 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3569 {
3570     PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3571
3572     if (SvPOKp(sv)) {
3573         const U8 *start, *c;
3574         const U8 *e;
3575
3576         /* The octets may have got themselves encoded - get them back as
3577          * bytes
3578          */
3579         if (!sv_utf8_downgrade(sv, TRUE))
3580             return FALSE;
3581
3582         /* it is actually just a matter of turning the utf8 flag on, but
3583          * we want to make sure everything inside is valid utf8 first.
3584          */
3585         c = start = (const U8 *) SvPVX_const(sv);
3586         if (!is_utf8_string(c, SvCUR(sv)+1))
3587             return FALSE;
3588         e = (const U8 *) SvEND(sv);
3589         while (c < e) {
3590             const U8 ch = *c++;
3591             if (!UTF8_IS_INVARIANT(ch)) {
3592                 SvUTF8_on(sv);
3593                 break;
3594             }
3595         }
3596         if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3597             /* adjust pos to the start of a UTF8 char sequence */
3598             MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3599             if (mg) {
3600                 I32 pos = mg->mg_len;
3601                 if (pos > 0) {
3602                     for (c = start + pos; c > start; c--) {
3603                         if (UTF8_IS_START(*c))
3604                             break;
3605                     }
3606                     mg->mg_len  = c - start;
3607                 }
3608             }
3609             if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3610                 magic_setutf8(sv,mg); /* clear UTF8 cache */
3611         }
3612     }
3613     return TRUE;
3614 }
3615
3616 /*
3617 =for apidoc sv_setsv
3618
3619 Copies the contents of the source SV C<ssv> into the destination SV
3620 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3621 function if the source SV needs to be reused. Does not handle 'set' magic.
3622 Loosely speaking, it performs a copy-by-value, obliterating any previous
3623 content of the destination.
3624
3625 You probably want to use one of the assortment of wrappers, such as
3626 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3627 C<SvSetMagicSV_nosteal>.
3628
3629 =for apidoc sv_setsv_flags
3630
3631 Copies the contents of the source SV C<ssv> into the destination SV
3632 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3633 function if the source SV needs to be reused. Does not handle 'set' magic.
3634 Loosely speaking, it performs a copy-by-value, obliterating any previous
3635 content of the destination.
3636 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3637 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3638 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3639 and C<sv_setsv_nomg> are implemented in terms of this function.
3640
3641 You probably want to use one of the assortment of wrappers, such as
3642 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3643 C<SvSetMagicSV_nosteal>.
3644
3645 This is the primary function for copying scalars, and most other
3646 copy-ish functions and macros use this underneath.
3647
3648 =cut
3649 */
3650
3651 static void
3652 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3653 {
3654     I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3655     HV *old_stash = NULL;
3656
3657     PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3658
3659     if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3660         const char * const name = GvNAME(sstr);
3661         const STRLEN len = GvNAMELEN(sstr);
3662         {
3663             if (dtype >= SVt_PV) {
3664                 SvPV_free(dstr);
3665                 SvPV_set(dstr, 0);
3666                 SvLEN_set(dstr, 0);
3667                 SvCUR_set(dstr, 0);
3668             }
3669             SvUPGRADE(dstr, SVt_PVGV);
3670             (void)SvOK_off(dstr);
3671             /* FIXME - why are we doing this, then turning it off and on again
3672                below?  */
3673             isGV_with_GP_on(dstr);
3674         }
3675         GvSTASH(dstr) = GvSTASH(sstr);
3676         if (GvSTASH(dstr))
3677             Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3678         gv_name_set(MUTABLE_GV(dstr), name, len, GV_ADD);
3679         SvFAKE_on(dstr);        /* can coerce to non-glob */
3680     }
3681
3682     if(GvGP(MUTABLE_GV(sstr))) {
3683         /* If source has method cache entry, clear it */
3684         if(GvCVGEN(sstr)) {
3685             SvREFCNT_dec(GvCV(sstr));
3686             GvCV_set(sstr, NULL);
3687             GvCVGEN(sstr) = 0;
3688         }
3689         /* If source has a real method, then a method is
3690            going to change */
3691         else if(
3692          GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3693         ) {
3694             mro_changes = 1;
3695         }
3696     }
3697
3698     /* If dest already had a real method, that's a change as well */
3699     if(
3700         !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3701      && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3702     ) {
3703         mro_changes = 1;
3704     }
3705
3706     /* We don’t need to check the name of the destination if it was not a
3707        glob to begin with. */
3708     if(dtype == SVt_PVGV) {
3709         const char * const name = GvNAME((const GV *)dstr);
3710         if(
3711             strEQ(name,"ISA")
3712          /* The stash may have been detached from the symbol table, so
3713             check its name. */
3714          && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3715          && GvAV((const GV *)sstr)
3716         )
3717             mro_changes = 2;
3718         else {
3719             const STRLEN len = GvNAMELEN(dstr);
3720             if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
3721              || (len == 1 && name[0] == ':')) {
3722                 mro_changes = 3;
3723
3724                 /* Set aside the old stash, so we can reset isa caches on
3725                    its subclasses. */
3726                 if((old_stash = GvHV(dstr)))
3727                     /* Make sure we do not lose it early. */
3728                     SvREFCNT_inc_simple_void_NN(
3729                      sv_2mortal((SV *)old_stash)
3730                     );
3731             }
3732         }
3733     }
3734
3735     gp_free(MUTABLE_GV(dstr));
3736     isGV_with_GP_off(dstr);
3737     (void)SvOK_off(dstr);
3738     isGV_with_GP_on(dstr);
3739     GvINTRO_off(dstr);          /* one-shot flag */
3740     GvGP_set(dstr, gp_ref(GvGP(sstr)));
3741     if (SvTAINTED(sstr))
3742         SvTAINT(dstr);
3743     if (GvIMPORTED(dstr) != GVf_IMPORTED
3744         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3745         {
3746             GvIMPORTED_on(dstr);
3747         }
3748     GvMULTI_on(dstr);
3749     if(mro_changes == 2) {
3750         MAGIC *mg;
3751         SV * const sref = (SV *)GvAV((const GV *)dstr);
3752         if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3753             if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3754                 AV * const ary = newAV();
3755                 av_push(ary, mg->mg_obj); /* takes the refcount */
3756                 mg->mg_obj = (SV *)ary;
3757             }
3758             av_push((AV *)mg->mg_obj, SvREFCNT_inc_simple_NN(dstr));
3759         }
3760         else sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3761         mro_isa_changed_in(GvSTASH(dstr));
3762     }
3763     else if(mro_changes == 3) {
3764         HV * const stash = GvHV(dstr);
3765         if(old_stash ? (HV *)HvENAME_get(old_stash) : stash)
3766             mro_package_moved(
3767                 stash, old_stash,
3768                 (GV *)dstr, 0
3769             );
3770     }
3771     else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3772     return;
3773 }
3774
3775 static void
3776 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3777 {
3778     SV * const sref = SvREFCNT_inc(SvRV(sstr));
3779     SV *dref = NULL;
3780     const int intro = GvINTRO(dstr);
3781     SV **location;
3782     U8 import_flag = 0;
3783     const U32 stype = SvTYPE(sref);
3784
3785     PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3786
3787     if (intro) {
3788         GvINTRO_off(dstr);      /* one-shot flag */
3789         GvLINE(dstr) = CopLINE(PL_curcop);
3790         GvEGV(dstr) = MUTABLE_GV(dstr);
3791     }
3792     GvMULTI_on(dstr);
3793     switch (stype) {
3794     case SVt_PVCV:
3795         location = (SV **) &(GvGP(dstr)->gp_cv); /* XXX bypassing GvCV_set */
3796         import_flag = GVf_IMPORTED_CV;
3797         goto common;
3798     case SVt_PVHV:
3799         location = (SV **) &GvHV(dstr);
3800         import_flag = GVf_IMPORTED_HV;
3801         goto common;
3802     case SVt_PVAV:
3803         location = (SV **) &GvAV(dstr);
3804         import_flag = GVf_IMPORTED_AV;
3805         goto common;
3806     case SVt_PVIO:
3807         location = (SV **) &GvIOp(dstr);
3808         goto common;
3809     case SVt_PVFM:
3810         location = (SV **) &GvFORM(dstr);
3811         goto common;
3812     default:
3813         location = &GvSV(dstr);
3814         import_flag = GVf_IMPORTED_SV;
3815     common:
3816         if (intro) {
3817             if (stype == SVt_PVCV) {
3818                 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3819                 if (GvCVGEN(dstr)) {
3820                     SvREFCNT_dec(GvCV(dstr));
3821                     GvCV_set(dstr, NULL);
3822                     GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3823                 }
3824             }
3825             SAVEGENERICSV(*location);
3826         }
3827         else
3828             dref = *location;
3829         if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3830             CV* const cv = MUTABLE_CV(*location);
3831             if (cv) {
3832                 if (!GvCVGEN((const GV *)dstr) &&
3833                     (CvROOT(cv) || CvXSUB(cv)))
3834                     {
3835                         /* Redefining a sub - warning is mandatory if
3836                            it was a const and its value changed. */
3837                         if (CvCONST(cv) && CvCONST((const CV *)sref)
3838                             && cv_const_sv(cv)
3839                             == cv_const_sv((const CV *)sref)) {
3840                             NOOP;
3841                             /* They are 2 constant subroutines generated from
3842                                the same constant. This probably means that
3843                                they are really the "same" proxy subroutine
3844                                instantiated in 2 places. Most likely this is
3845                                when a constant is exported twice.  Don't warn.
3846                             */
3847                         }
3848                         else if (ckWARN(WARN_REDEFINE)
3849                                  || (CvCONST(cv)
3850                                      && (!CvCONST((const CV *)sref)
3851                                          || sv_cmp(cv_const_sv(cv),
3852                                                    cv_const_sv((const CV *)
3853                                                                sref))))) {
3854                             Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3855                                         (const char *)
3856                                         (CvCONST(cv)
3857                                          ? "Constant subroutine %s::%s redefined"
3858                                          : "Subroutine %s::%s redefined"),
3859                                         HvNAME_get(GvSTASH((const GV *)dstr)),
3860                                         GvENAME(MUTABLE_GV(dstr)));
3861                         }
3862                     }
3863                 if (!intro)
3864                     cv_ckproto_len(cv, (const GV *)dstr,
3865                                    SvPOK(sref) ? SvPVX_const(sref) : NULL,
3866                                    SvPOK(sref) ? SvCUR(sref) : 0);
3867             }
3868             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3869             GvASSUMECV_on(dstr);
3870             if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3871         }
3872         *location = sref;
3873         if (import_flag && !(GvFLAGS(dstr) & import_flag)
3874             && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3875             GvFLAGS(dstr) |= import_flag;
3876         }
3877         if (stype == SVt_PVHV) {
3878             const char * const name = GvNAME((GV*)dstr);
3879             const STRLEN len = GvNAMELEN(dstr);
3880             if (
3881                 (
3882                    (len > 1 && name[len-2] == ':' && name[len-1] == ':')
3883                 || (len == 1 && name[0] == ':')
3884                 )
3885              && (!dref || HvENAME_get(dref))
3886             ) {
3887                 mro_package_moved(
3888                     (HV *)sref, (HV *)dref,
3889                     (GV *)dstr, 0
3890                 );
3891             }
3892         }
3893         else if (
3894             stype == SVt_PVAV && sref != dref
3895          && strEQ(GvNAME((GV*)dstr), "ISA")
3896          /* The stash may have been detached from the symbol table, so
3897             check its name before doing anything. */
3898          && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3899         ) {
3900             MAGIC *mg;
3901             MAGIC * const omg = dref && SvSMAGICAL(dref)
3902                                  ? mg_find(dref, PERL_MAGIC_isa)
3903                                  : NULL;
3904             if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3905                 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3906                     AV * const ary = newAV();
3907                     av_push(ary, mg->mg_obj); /* takes the refcount */
3908                     mg->mg_obj = (SV *)ary;
3909                 }
3910                 if (omg) {
3911                     if (SvTYPE(omg->mg_obj) == SVt_PVAV) {
3912                         SV **svp = AvARRAY((AV *)omg->mg_obj);
3913                         I32 items = AvFILLp((AV *)omg->mg_obj) + 1;
3914                         while (items--)
3915                             av_push(
3916                              (AV *)mg->mg_obj,
3917                              SvREFCNT_inc_simple_NN(*svp++)
3918                             );
3919                     }
3920                     else
3921                         av_push(
3922                          (AV *)mg->mg_obj,
3923                          SvREFCNT_inc_simple_NN(omg->mg_obj)
3924                         );
3925                 }
3926                 else
3927                     av_push((AV *)mg->mg_obj,SvREFCNT_inc_simple_NN(dstr));
3928             }
3929             else
3930             {
3931                 sv_magic(
3932                  sref, omg ? omg->mg_obj : dstr, PERL_MAGIC_isa, NULL, 0
3933                 );
3934                 mg = mg_find(sref, PERL_MAGIC_isa);
3935             }
3936             /* Since the *ISA assignment could have affected more than
3937                one stash, don’t call mro_isa_changed_in directly, but let
3938                magic_clearisa do it for us, as it already has the logic for
3939                dealing with globs vs arrays of globs. */
3940             assert(mg);
3941             Perl_magic_clearisa(aTHX_ NULL, mg);
3942         }
3943         break;
3944     }
3945     SvREFCNT_dec(dref);
3946     if (SvTAINTED(sstr))
3947         SvTAINT(dstr);
3948     return;
3949 }
3950
3951 void
3952 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3953 {
3954     dVAR;
3955     register U32 sflags;
3956     register int dtype;
3957     register svtype stype;
3958
3959     PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3960
3961     if (sstr == dstr)
3962         return;
3963
3964     if (SvIS_FREED(dstr)) {
3965         Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3966                    " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3967     }
3968     SV_CHECK_THINKFIRST_COW_DROP(dstr);
3969     if (!sstr)
3970         sstr = &PL_sv_undef;
3971     if (SvIS_FREED(sstr)) {
3972         Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3973                    (void*)sstr, (void*)dstr);
3974     }
3975     stype = SvTYPE(sstr);
3976     dtype = SvTYPE(dstr);
3977
3978     (void)SvAMAGIC_off(dstr);
3979     if ( SvVOK(dstr) )
3980     {
3981         /* need to nuke the magic */
3982         mg_free(dstr);
3983     }
3984
3985     /* There's a lot of redundancy below but we're going for speed here */
3986
3987     switch (stype) {
3988     case SVt_NULL:
3989       undef_sstr:
3990         if (dtype != SVt_PVGV && dtype != SVt_PVLV) {
3991             (void)SvOK_off(dstr);
3992             return;
3993         }
3994         break;
3995     case SVt_IV:
3996         if (SvIOK(sstr)) {
3997             switch (dtype) {
3998             case SVt_NULL:
3999                 sv_upgrade(dstr, SVt_IV);
4000                 break;
4001             case SVt_NV:
4002             case SVt_PV:
4003                 sv_upgrade(dstr, SVt_PVIV);
4004                 break;
4005             case SVt_PVGV:
4006             case SVt_PVLV:
4007                 goto end_of_first_switch;
4008             }
4009             (void)SvIOK_only(dstr);
4010             SvIV_set(dstr,  SvIVX(sstr));
4011             if (SvIsUV(sstr))
4012                 SvIsUV_on(dstr);
4013             /* SvTAINTED can only be true if the SV has taint magic, which in
4014                turn means that the SV type is PVMG (or greater). This is the
4015                case statement for SVt_IV, so this cannot be true (whatever gcov
4016                may say).  */
4017             assert(!SvTAINTED(sstr));
4018             return;
4019         }
4020         if (!SvROK(sstr))
4021             goto undef_sstr;
4022         if (dtype < SVt_PV && dtype != SVt_IV)
4023             sv_upgrade(dstr, SVt_IV);
4024         break;
4025
4026     case SVt_NV:
4027         if (SvNOK(sstr)) {
4028             switch (dtype) {
4029             case SVt_NULL:
4030             case SVt_IV:
4031                 sv_upgrade(dstr, SVt_NV);
4032                 break;
4033             case SVt_PV:
4034             case SVt_PVIV:
4035                 sv_upgrade(dstr, SVt_PVNV);
4036                 break;
4037             case SVt_PVGV:
4038             case SVt_PVLV:
4039                 goto end_of_first_switch;
4040             }
4041             SvNV_set(dstr, SvNVX(sstr));
4042             (void)SvNOK_only(dstr);
4043             /* SvTAINTED can only be true if the SV has taint magic, which in
4044                turn means that the SV type is PVMG (or greater). This is the
4045                case statement for SVt_NV, so this cannot be true (whatever gcov
4046                may say).  */
4047             assert(!SvTAINTED(sstr));
4048             return;
4049         }
4050         goto undef_sstr;
4051
4052     case SVt_PVFM:
4053 #ifdef PERL_OLD_COPY_ON_WRITE
4054         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4055             if (dtype < SVt_PVIV)
4056                 sv_upgrade(dstr, SVt_PVIV);
4057             break;
4058         }
4059         /* Fall through */
4060 #endif
4061     case SVt_PV:
4062         if (dtype < SVt_PV)
4063             sv_upgrade(dstr, SVt_PV);
4064         break;
4065     case SVt_PVIV:
4066         if (dtype < SVt_PVIV)
4067             sv_upgrade(dstr, SVt_PVIV);
4068         break;
4069     case SVt_PVNV:
4070         if (dtype < SVt_PVNV)
4071             sv_upgrade(dstr, SVt_PVNV);
4072         break;
4073     default:
4074         {
4075         const char * const type = sv_reftype(sstr,0);
4076         if (PL_op)
4077             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
4078         else
4079             Perl_croak(aTHX_ "Bizarre copy of %s", type);
4080         }
4081         break;
4082
4083     case SVt_REGEXP:
4084         if (dtype < SVt_REGEXP)
4085             sv_upgrade(dstr, SVt_REGEXP);
4086         break;
4087
4088         /* case SVt_BIND: */
4089     case SVt_PVLV:
4090     case SVt_PVGV:
4091     case SVt_PVMG:
4092         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4093             mg_get(sstr);
4094             if (SvTYPE(sstr) != stype)
4095                 stype = SvTYPE(sstr);
4096         }
4097         if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
4098                     glob_assign_glob(dstr, sstr, dtype);
4099                     return;
4100         }
4101         if (stype == SVt_PVLV)
4102             SvUPGRADE(dstr, SVt_PVNV);
4103         else
4104             SvUPGRADE(dstr, (svtype)stype);
4105     }
4106  end_of_first_switch:
4107
4108     /* dstr may have been upgraded.  */
4109     dtype = SvTYPE(dstr);
4110     sflags = SvFLAGS(sstr);
4111
4112     if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
4113         /* Assigning to a subroutine sets the prototype.  */
4114         if (SvOK(sstr)) {
4115             STRLEN len;
4116             const char *const ptr = SvPV_const(sstr, len);
4117
4118             SvGROW(dstr, len + 1);
4119             Copy(ptr, SvPVX(dstr), len + 1, char);
4120             SvCUR_set(dstr, len);
4121             SvPOK_only(dstr);
4122             SvFLAGS(dstr) |= sflags & SVf_UTF8;
4123         } else {
4124             SvOK_off(dstr);
4125         }
4126     } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
4127         const char * const type = sv_reftype(dstr,0);
4128         if (PL_op)
4129             Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
4130         else
4131             Perl_croak(aTHX_ "Cannot copy to %s", type);
4132     } else if (sflags & SVf_ROK) {
4133         if (isGV_with_GP(dstr)
4134             && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
4135             sstr = SvRV(sstr);
4136             if (sstr == dstr) {
4137                 if (GvIMPORTED(dstr) != GVf_IMPORTED
4138                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4139                 {
4140                     GvIMPORTED_on(dstr);
4141                 }
4142                 GvMULTI_on(dstr);
4143                 return;
4144             }
4145             glob_assign_glob(dstr, sstr, dtype);
4146             return;
4147         }
4148
4149         if (dtype >= SVt_PV) {
4150             if (isGV_with_GP(dstr)) {
4151                 glob_assign_ref(dstr, sstr);
4152                 return;
4153             }
4154             if (SvPVX_const(dstr)) {
4155                 SvPV_free(dstr);
4156                 SvLEN_set(dstr, 0);
4157                 SvCUR_set(dstr, 0);
4158             }
4159         }
4160         (void)SvOK_off(dstr);
4161         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4162         SvFLAGS(dstr) |= sflags & SVf_ROK;
4163         assert(!(sflags & SVp_NOK));
4164         assert(!(sflags & SVp_IOK));
4165         assert(!(sflags & SVf_NOK));
4166         assert(!(sflags & SVf_IOK));
4167     }
4168     else if (isGV_with_GP(dstr)) {
4169         if (!(sflags & SVf_OK)) {
4170             Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4171                            "Undefined value assigned to typeglob");
4172         }
4173         else {
4174             GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
4175             if (dstr != (const SV *)gv) {
4176                 const char * const name = GvNAME((const GV *)dstr);
4177                 const STRLEN len = GvNAMELEN(dstr);
4178                 HV *old_stash = NULL;
4179                 bool reset_isa = FALSE;
4180                 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
4181                  || (len == 1 && name[0] == ':')) {
4182                     /* Set aside the old stash, so we can reset isa caches
4183                        on its subclasses. */
4184                     if((old_stash = GvHV(dstr))) {
4185                         /* Make sure we do not lose it early. */
4186                         SvREFCNT_inc_simple_void_NN(
4187                          sv_2mortal((SV *)old_stash)
4188                         );
4189                     }
4190                     reset_isa = TRUE;
4191                 }
4192
4193                 if (GvGP(dstr))
4194                     gp_free(MUTABLE_GV(dstr));
4195                 GvGP_set(dstr, gp_ref(GvGP(gv)));
4196
4197                 if (reset_isa) {
4198                     HV * const stash = GvHV(dstr);
4199                     if(
4200                         old_stash ? (HV *)HvENAME_get(old_stash) : stash
4201                     )
4202                         mro_package_moved(
4203                          stash, old_stash,
4204                          (GV *)dstr, 0
4205                         );
4206                 }
4207             }
4208         }
4209     }
4210     else if (dtype == SVt_REGEXP && stype == SVt_REGEXP) {
4211         reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4212     }
4213     else if (sflags & SVp_POK) {
4214         bool isSwipe = 0;
4215
4216         /*
4217          * Check to see if we can just swipe the string.  If so, it's a
4218          * possible small lose on short strings, but a big win on long ones.
4219          * It might even be a win on short strings if SvPVX_const(dstr)
4220          * has to be allocated and SvPVX_const(sstr) has to be freed.
4221          * Likewise if we can set up COW rather than doing an actual copy, we
4222          * drop to the else clause, as the swipe code and the COW setup code
4223          * have much in common.
4224          */
4225
4226         /* Whichever path we take through the next code, we want this true,
4227            and doing it now facilitates the COW check.  */
4228         (void)SvPOK_only(dstr);
4229
4230         if (
4231             /* If we're already COW then this clause is not true, and if COW
4232                is allowed then we drop down to the else and make dest COW
4233                with us.  If caller hasn't said that we're allowed to COW
4234                shared hash keys then we don't do the COW setup, even if the
4235                source scalar is a shared hash key scalar.  */
4236             (((flags & SV_COW_SHARED_HASH_KEYS)
4237                ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4238                : 1 /* If making a COW copy is forbidden then the behaviour we
4239                        desire is as if the source SV isn't actually already
4240                        COW, even if it is.  So we act as if the source flags
4241                        are not COW, rather than actually testing them.  */
4242               )
4243 #ifndef PERL_OLD_COPY_ON_WRITE
4244              /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4245                 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4246                 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4247                 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4248                 but in turn, it's somewhat dead code, never expected to go
4249                 live, but more kept as a placeholder on how to do it better
4250                 in a newer implementation.  */
4251              /* If we are COW and dstr is a suitable target then we drop down
4252                 into the else and make dest a COW of us.  */
4253              || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4254 #endif
4255              )
4256             &&
4257             !(isSwipe =
4258                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
4259                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
4260                  (!(flags & SV_NOSTEAL)) &&
4261                                         /* and we're allowed to steal temps */
4262                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
4263                  SvLEN(sstr))             /* and really is a string */
4264 #ifdef PERL_OLD_COPY_ON_WRITE
4265             && ((flags & SV_COW_SHARED_HASH_KEYS)
4266                 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4267                      && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4268                      && SvTYPE(sstr) >= SVt_PVIV && SvTYPE(sstr) != SVt_PVFM))
4269                 : 1)
4270 #endif
4271             ) {
4272             /* Failed the swipe test, and it's not a shared hash key either.
4273                Have to copy the string.  */
4274             STRLEN len = SvCUR(sstr);
4275             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
4276             Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4277             SvCUR_set(dstr, len);
4278             *SvEND(dstr) = '\0';
4279         } else {
4280             /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4281                be true in here.  */
4282             /* Either it's a shared hash key, or it's suitable for
4283                copy-on-write or we can swipe the string.  */
4284             if (DEBUG_C_TEST) {
4285                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4286                 sv_dump(sstr);
4287                 sv_dump(dstr);
4288             }
4289 #ifdef PERL_OLD_COPY_ON_WRITE
4290             if (!isSwipe) {
4291                 if ((sflags & (SVf_FAKE | SVf_READONLY))
4292                     != (SVf_FAKE | SVf_READONLY)) {
4293                     SvREADONLY_on(sstr);
4294                     SvFAKE_on(sstr);
4295                     /* Make the source SV into a loop of 1.
4296                        (about to become 2) */
4297                     SV_COW_NEXT_SV_SET(sstr, sstr);
4298                 }
4299             }
4300 #endif
4301             /* Initial code is common.  */
4302             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
4303                 SvPV_free(dstr);
4304             }
4305
4306             if (!isSwipe) {
4307                 /* making another shared SV.  */
4308                 STRLEN cur = SvCUR(sstr);
4309                 STRLEN len = SvLEN(sstr);
4310 #ifdef PERL_OLD_COPY_ON_WRITE
4311                 if (len) {
4312                     assert (SvTYPE(dstr) >= SVt_PVIV);
4313                     /* SvIsCOW_normal */
4314                     /* splice us in between source and next-after-source.  */
4315                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4316                     SV_COW_NEXT_SV_SET(sstr, dstr);
4317                     SvPV_set(dstr, SvPVX_mutable(sstr));
4318                 } else
4319 #endif
4320                 {
4321                     /* SvIsCOW_shared_hash */
4322                     DEBUG_C(PerlIO_printf(Perl_debug_log,
4323                                           "Copy on write: Sharing hash\n"));
4324
4325                     assert (SvTYPE(dstr) >= SVt_PV);
4326                     SvPV_set(dstr,
4327                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4328                 }
4329                 SvLEN_set(dstr, len);
4330                 SvCUR_set(dstr, cur);
4331                 SvREADONLY_on(dstr);
4332                 SvFAKE_on(dstr);
4333             }
4334             else
4335                 {       /* Passes the swipe test.  */
4336                 SvPV_set(dstr, SvPVX_mutable(sstr));
4337                 SvLEN_set(dstr, SvLEN(sstr));
4338                 SvCUR_set(dstr, SvCUR(sstr));
4339
4340                 SvTEMP_off(dstr);
4341                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
4342                 SvPV_set(sstr, NULL);
4343                 SvLEN_set(sstr, 0);
4344                 SvCUR_set(sstr, 0);
4345                 SvTEMP_off(sstr);
4346             }
4347         }
4348         if (sflags & SVp_NOK) {
4349             SvNV_set(dstr, SvNVX(sstr));
4350         }
4351         if (sflags & SVp_IOK) {
4352             SvIV_set(dstr, SvIVX(sstr));
4353             /* Must do this otherwise some other overloaded use of 0x80000000
4354                gets confused. I guess SVpbm_VALID */
4355             if (sflags & SVf_IVisUV)
4356                 SvIsUV_on(dstr);
4357         }
4358         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4359         {
4360             const MAGIC * const smg = SvVSTRING_mg(sstr);
4361             if (smg) {
4362                 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4363                          smg->mg_ptr, smg->mg_len);
4364                 SvRMAGICAL_on(dstr);
4365             }
4366         }
4367     }
4368     else if (sflags & (SVp_IOK|SVp_NOK)) {
4369         (void)SvOK_off(dstr);
4370         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4371         if (sflags & SVp_IOK) {
4372             /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
4373             SvIV_set(dstr, SvIVX(sstr));
4374         }
4375         if (sflags & SVp_NOK) {
4376             SvNV_set(dstr, SvNVX(sstr));
4377         }
4378     }
4379     else {
4380         if (isGV_with_GP(sstr)) {
4381             /* This stringification rule for globs is spread in 3 places.
4382                This feels bad. FIXME.  */
4383             const U32 wasfake = sflags & SVf_FAKE;
4384
4385             /* FAKE globs can get coerced, so need to turn this off
4386                temporarily if it is on.  */
4387             SvFAKE_off(sstr);
4388             gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4389             SvFLAGS(sstr) |= wasfake;
4390         }
4391         else
4392             (void)SvOK_off(dstr);
4393     }
4394     if (SvTAINTED(sstr))
4395         SvTAINT(dstr);
4396 }
4397
4398 /*
4399 =for apidoc sv_setsv_mg
4400
4401 Like C<sv_setsv>, but also handles 'set' magic.
4402
4403 =cut
4404 */
4405
4406 void
4407 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4408 {
4409     PERL_ARGS_ASSERT_SV_SETSV_MG;
4410
4411     sv_setsv(dstr,sstr);
4412     SvSETMAGIC(dstr);
4413 }
4414
4415 #ifdef PERL_OLD_COPY_ON_WRITE
4416 SV *
4417 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4418 {
4419     STRLEN cur = SvCUR(sstr);
4420     STRLEN len = SvLEN(sstr);
4421     register char *new_pv;
4422
4423     PERL_ARGS_ASSERT_SV_SETSV_COW;
4424
4425     if (DEBUG_C_TEST) {
4426         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4427                       (void*)sstr, (void*)dstr);
4428         sv_dump(sstr);
4429         if (dstr)
4430                     sv_dump(dstr);
4431     }
4432
4433     if (dstr) {
4434         if (SvTHINKFIRST(dstr))
4435             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4436         else if (SvPVX_const(dstr))
4437             Safefree(SvPVX_const(dstr));
4438     }
4439     else
4440         new_SV(dstr);
4441     SvUPGRADE(dstr, SVt_PVIV);
4442
4443     assert (SvPOK(sstr));
4444     assert (SvPOKp(sstr));
4445     assert (!SvIOK(sstr));
4446     assert (!SvIOKp(sstr));
4447     assert (!SvNOK(sstr));
4448     assert (!SvNOKp(sstr));
4449
4450     if (SvIsCOW(sstr)) {
4451
4452         if (SvLEN(sstr) == 0) {
4453             /* source is a COW shared hash key.  */
4454             DEBUG_C(PerlIO_printf(Perl_debug_log,
4455                                   "Fast copy on write: Sharing hash\n"));
4456             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4457             goto common_exit;
4458         }
4459         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4460     } else {
4461         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4462         SvUPGRADE(sstr, SVt_PVIV);
4463         SvREADONLY_on(sstr);
4464         SvFAKE_on(sstr);
4465         DEBUG_C(PerlIO_printf(Perl_debug_log,
4466                               "Fast copy on write: Converting sstr to COW\n"));
4467         SV_COW_NEXT_SV_SET(dstr, sstr);
4468     }
4469     SV_COW_NEXT_SV_SET(sstr, dstr);
4470     new_pv = SvPVX_mutable(sstr);
4471
4472   common_exit:
4473     SvPV_set(dstr, new_pv);
4474     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4475     if (SvUTF8(sstr))
4476         SvUTF8_on(dstr);
4477     SvLEN_set(dstr, len);
4478     SvCUR_set(dstr, cur);
4479     if (DEBUG_C_TEST) {
4480         sv_dump(dstr);
4481     }
4482     return dstr;
4483 }
4484 #endif
4485
4486 /*
4487 =for apidoc sv_setpvn
4488
4489 Copies a string into an SV.  The C<len> parameter indicates the number of
4490 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
4491 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
4492
4493 =cut
4494 */
4495
4496 void
4497 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4498 {
4499     dVAR;
4500     register char *dptr;
4501
4502     PERL_ARGS_ASSERT_SV_SETPVN;
4503
4504     SV_CHECK_THINKFIRST_COW_DROP(sv);
4505     if (!ptr) {
4506         (void)SvOK_off(sv);
4507         return;
4508     }
4509     else {
4510         /* len is STRLEN which is unsigned, need to copy to signed */
4511         const IV iv = len;
4512         if (iv < 0)
4513             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4514     }
4515     SvUPGRADE(sv, SVt_PV);
4516
4517     dptr = SvGROW(sv, len + 1);
4518     Move(ptr,dptr,len,char);
4519     dptr[len] = '\0';
4520     SvCUR_set(sv, len);
4521     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4522     SvTAINT(sv);
4523 }
4524
4525 /*
4526 =for apidoc sv_setpvn_mg
4527
4528 Like C<sv_setpvn>, but also handles 'set' magic.
4529
4530 =cut
4531 */
4532
4533 void
4534 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4535 {
4536     PERL_ARGS_ASSERT_SV_SETPVN_MG;
4537
4538     sv_setpvn(sv,ptr,len);
4539     SvSETMAGIC(sv);
4540 }
4541
4542 /*
4543 =for apidoc sv_setpv
4544
4545 Copies a string into an SV.  The string must be null-terminated.  Does not
4546 handle 'set' magic.  See C<sv_setpv_mg>.
4547
4548 =cut
4549 */
4550
4551 void
4552 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4553 {
4554     dVAR;
4555     register STRLEN len;
4556
4557     PERL_ARGS_ASSERT_SV_SETPV;
4558
4559     SV_CHECK_THINKFIRST_COW_DROP(sv);
4560     if (!ptr) {
4561         (void)SvOK_off(sv);
4562         return;
4563     }
4564     len = strlen(ptr);
4565     SvUPGRADE(sv, SVt_PV);
4566
4567     SvGROW(sv, len + 1);
4568     Move(ptr,SvPVX(sv),len+1,char);
4569     SvCUR_set(sv, len);
4570     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4571     SvTAINT(sv);
4572 }
4573
4574 /*
4575 =for apidoc sv_setpv_mg
4576
4577 Like C<sv_setpv>, but also handles 'set' magic.
4578
4579 =cut
4580 */
4581
4582 void
4583 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4584 {
4585     PERL_ARGS_ASSERT_SV_SETPV_MG;
4586
4587     sv_setpv(sv,ptr);
4588     SvSETMAGIC(sv);
4589 }
4590
4591 /*
4592 =for apidoc sv_usepvn_flags
4593
4594 Tells an SV to use C<ptr> to find its string value.  Normally the
4595 string is stored inside the SV but sv_usepvn allows the SV to use an
4596 outside string.  The C<ptr> should point to memory that was allocated
4597 by C<malloc>.  The string length, C<len>, must be supplied.  By default
4598 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4599 so that pointer should not be freed or used by the programmer after
4600 giving it to sv_usepvn, and neither should any pointers from "behind"
4601 that pointer (e.g. ptr + 1) be used.
4602
4603 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4604 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4605 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4606 C<len>, and already meets the requirements for storing in C<SvPVX>)
4607
4608 =cut
4609 */
4610
4611 void
4612 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4613 {
4614     dVAR;
4615     STRLEN allocate;
4616
4617     PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4618
4619     SV_CHECK_THINKFIRST_COW_DROP(sv);
4620     SvUPGRADE(sv, SVt_PV);
4621     if (!ptr) {
4622         (void)SvOK_off(sv);
4623         if (flags & SV_SMAGIC)
4624             SvSETMAGIC(sv);
4625         return;
4626     }
4627     if (SvPVX_const(sv))
4628         SvPV_free(sv);
4629
4630 #ifdef DEBUGGING
4631     if (flags & SV_HAS_TRAILING_NUL)
4632         assert(ptr[len] == '\0');
4633 #endif
4634
4635     allocate = (flags & SV_HAS_TRAILING_NUL)
4636         ? len + 1 :
4637 #ifdef Perl_safesysmalloc_size
4638         len + 1;
4639 #else
4640         PERL_STRLEN_ROUNDUP(len + 1);
4641 #endif
4642     if (flags & SV_HAS_TRAILING_NUL) {
4643         /* It's long enough - do nothing.
4644            Specifically Perl_newCONSTSUB is relying on this.  */
4645     } else {
4646 #ifdef DEBUGGING
4647         /* Force a move to shake out bugs in callers.  */
4648         char *new_ptr = (char*)safemalloc(allocate);
4649         Copy(ptr, new_ptr, len, char);
4650         PoisonFree(ptr,len,char);
4651         Safefree(ptr);
4652         ptr = new_ptr;
4653 #else
4654         ptr = (char*) saferealloc (ptr, allocate);
4655 #endif
4656     }
4657 #ifdef Perl_safesysmalloc_size
4658     SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4659 #else
4660     SvLEN_set(sv, allocate);
4661 #endif
4662     SvCUR_set(sv, len);
4663     SvPV_set(sv, ptr);
4664     if (!(flags & SV_HAS_TRAILING_NUL)) {
4665         ptr[len] = '\0';
4666     }
4667     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4668     SvTAINT(sv);
4669     if (flags & SV_SMAGIC)
4670         SvSETMAGIC(sv);
4671 }
4672
4673 #ifdef PERL_OLD_COPY_ON_WRITE
4674 /* Need to do this *after* making the SV normal, as we need the buffer
4675    pointer to remain valid until after we've copied it.  If we let go too early,
4676    another thread could invalidate it by unsharing last of the same hash key
4677    (which it can do by means other than releasing copy-on-write Svs)
4678    or by changing the other copy-on-write SVs in the loop.  */
4679 STATIC void
4680 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4681 {
4682     PERL_ARGS_ASSERT_SV_RELEASE_COW;
4683
4684     { /* this SV was SvIsCOW_normal(sv) */
4685          /* we need to find the SV pointing to us.  */
4686         SV *current = SV_COW_NEXT_SV(after);
4687
4688         if (current == sv) {
4689             /* The SV we point to points back to us (there were only two of us
4690                in the loop.)
4691                Hence other SV is no longer copy on write either.  */
4692             SvFAKE_off(after);
4693             SvREADONLY_off(after);
4694         } else {
4695             /* We need to follow the pointers around the loop.  */
4696             SV *next;
4697             while ((next = SV_COW_NEXT_SV(current)) != sv) {
4698                 assert (next);
4699                 current = next;
4700                  /* don't loop forever if the structure is bust, and we have
4701                     a pointer into a closed loop.  */
4702                 assert (current != after);
4703                 assert (SvPVX_const(current) == pvx);
4704             }
4705             /* Make the SV before us point to the SV after us.  */
4706             SV_COW_NEXT_SV_SET(current, after);
4707         }
4708     }
4709 }
4710 #endif
4711 /*
4712 =for apidoc sv_force_normal_flags
4713
4714 Undo various types of fakery on an SV: if the PV is a shared string, make
4715 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4716 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4717 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4718 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4719 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4720 set to some other value.) In addition, the C<flags> parameter gets passed to
4721 C<sv_unref_flags()> when unreffing. C<sv_force_normal> calls this function
4722 with flags set to 0.
4723
4724 =cut
4725 */
4726
4727 void
4728 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4729 {
4730     dVAR;
4731
4732     PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4733
4734 #ifdef PERL_OLD_COPY_ON_WRITE
4735     if (SvREADONLY(sv)) {
4736         if (SvFAKE(sv)) {
4737             const char * const pvx = SvPVX_const(sv);
4738             const STRLEN len = SvLEN(sv);
4739             const STRLEN cur = SvCUR(sv);
4740             /* next COW sv in the loop.  If len is 0 then this is a shared-hash
4741                key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4742                we'll fail an assertion.  */
4743             SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4744
4745             if (DEBUG_C_TEST) {
4746                 PerlIO_printf(Perl_debug_log,
4747                               "Copy on write: Force normal %ld\n",
4748                               (long) flags);
4749                 sv_dump(sv);
4750             }
4751             SvFAKE_off(sv);
4752             SvREADONLY_off(sv);
4753             /* This SV doesn't own the buffer, so need to Newx() a new one:  */
4754             SvPV_set(sv, NULL);
4755             SvLEN_set(sv, 0);
4756             if (flags & SV_COW_DROP_PV) {
4757                 /* OK, so we don't need to copy our buffer.  */
4758                 SvPOK_off(sv);
4759             } else {
4760                 SvGROW(sv, cur + 1);
4761                 Move(pvx,SvPVX(sv),cur,char);
4762                 SvCUR_set(sv, cur);
4763                 *SvEND(sv) = '\0';
4764             }
4765             if (len) {
4766                 sv_release_COW(sv, pvx, next);
4767             } else {
4768                 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4769             }
4770             if (DEBUG_C_TEST) {
4771                 sv_dump(sv);
4772             }
4773         }
4774         else if (IN_PERL_RUNTIME)
4775             Perl_croak_no_modify(aTHX);
4776     }
4777 #else
4778     if (SvREADONLY(sv)) {
4779         if (SvFAKE(sv)) {
4780             const char * const pvx = SvPVX_const(sv);
4781             const STRLEN len = SvCUR(sv);
4782             SvFAKE_off(sv);
4783             SvREADONLY_off(sv);
4784             SvPV_set(sv, NULL);
4785             SvLEN_set(sv, 0);
4786             SvGROW(sv, len + 1);
4787             Move(pvx,SvPVX(sv),len,char);
4788             *SvEND(sv) = '\0';
4789             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4790         }
4791         else if (IN_PERL_RUNTIME)
4792             Perl_croak_no_modify(aTHX);
4793     }
4794 #endif
4795     if (SvROK(sv))
4796         sv_unref_flags(sv, flags);
4797     else if (SvFAKE(sv) && isGV_with_GP(sv))
4798         sv_unglob(sv);
4799     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_REGEXP) {
4800         /* Need to downgrade the REGEXP to a simple(r) scalar. This is analogous
4801            to sv_unglob. We only need it here, so inline it.  */
4802         const svtype new_type = SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4803         SV *const temp = newSV_type(new_type);
4804         void *const temp_p = SvANY(sv);
4805
4806         if (new_type == SVt_PVMG) {
4807             SvMAGIC_set(temp, SvMAGIC(sv));
4808             SvMAGIC_set(sv, NULL);
4809             SvSTASH_set(temp, SvSTASH(sv));
4810             SvSTASH_set(sv, NULL);
4811         }
4812         SvCUR_set(temp, SvCUR(sv));
4813         /* Remember that SvPVX is in the head, not the body. */
4814         if (SvLEN(temp)) {
4815             SvLEN_set(temp, SvLEN(sv));
4816             /* This signals "buffer is owned by someone else" in sv_clear,
4817                which is the least effort way to stop it freeing the buffer.
4818             */
4819             SvLEN_set(sv, SvLEN(sv)+1);
4820         } else {
4821             /* Their buffer is already owned by someone else. */
4822             SvPVX(sv) = savepvn(SvPVX(sv), SvCUR(sv));
4823             SvLEN_set(temp, SvCUR(sv)+1);
4824         }
4825
4826         /* Now swap the rest of the bodies. */
4827
4828         SvFLAGS(sv) &= ~(SVf_FAKE|SVTYPEMASK);
4829         SvFLAGS(sv) |= new_type;
4830         SvANY(sv) = SvANY(temp);
4831
4832         SvFLAGS(temp) &= ~(SVTYPEMASK);
4833         SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4834         SvANY(temp) = temp_p;
4835
4836         SvREFCNT_dec(temp);
4837     }
4838 }
4839
4840 /*
4841 =for apidoc sv_chop
4842
4843 Efficient removal of characters from the beginning of the string buffer.
4844 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4845 the string buffer.  The C<ptr> becomes the first character of the adjusted
4846 string. Uses the "OOK hack".
4847 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4848 refer to the same chunk of data.
4849
4850 =cut
4851 */
4852
4853 void
4854 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4855 {
4856     STRLEN delta;
4857     STRLEN old_delta;
4858     U8 *p;
4859 #ifdef DEBUGGING
4860     const U8 *real_start;
4861 #endif
4862     STRLEN max_delta;
4863
4864     PERL_ARGS_ASSERT_SV_CHOP;
4865
4866     if (!ptr || !SvPOKp(sv))
4867         return;
4868     delta = ptr - SvPVX_const(sv);
4869     if (!delta) {
4870         /* Nothing to do.  */
4871         return;
4872     }
4873     /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), but after this line,
4874        nothing uses the value of ptr any more.  */
4875     max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4876     if (ptr <= SvPVX_const(sv))
4877         Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4878                    ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4879     SV_CHECK_THINKFIRST(sv);
4880     if (delta > max_delta)
4881         Perl_croak(aTHX_ "panic: sv_chop ptr=%p (was %p), start=%p, end=%p",
4882                    SvPVX_const(sv) + delta, ptr, SvPVX_const(sv),
4883                    SvPVX_const(sv) + max_delta);
4884
4885     if (!SvOOK(sv)) {
4886         if (!SvLEN(sv)) { /* make copy of shared string */
4887             const char *pvx = SvPVX_const(sv);
4888             const STRLEN len = SvCUR(sv);
4889             SvGROW(sv, len + 1);
4890             Move(pvx,SvPVX(sv),len,char);
4891             *SvEND(sv) = '\0';
4892         }
4893         SvFLAGS(sv) |= SVf_OOK;
4894         old_delta = 0;
4895     } else {
4896         SvOOK_offset(sv, old_delta);
4897     }
4898     SvLEN_set(sv, SvLEN(sv) - delta);
4899     SvCUR_set(sv, SvCUR(sv) - delta);
4900     SvPV_set(sv, SvPVX(sv) + delta);
4901
4902     p = (U8 *)SvPVX_const(sv);
4903
4904     delta += old_delta;
4905
4906 #ifdef DEBUGGING
4907     real_start = p - delta;
4908 #endif
4909
4910     assert(delta);
4911     if (delta < 0x100) {
4912         *--p = (U8) delta;
4913     } else {
4914         *--p = 0;
4915         p -= sizeof(STRLEN);
4916         Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4917     }
4918
4919 #ifdef DEBUGGING
4920     /* Fill the preceding buffer with sentinals to verify that no-one is
4921        using it.  */
4922     while (p > real_start) {
4923         --p;
4924         *p = (U8)PTR2UV(p);
4925     }
4926 #endif
4927 }
4928
4929 /*
4930 =for apidoc sv_catpvn
4931
4932 Concatenates the string onto the end of the string which is in the SV.  The
4933 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4934 status set, then the bytes appended should be valid UTF-8.
4935 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4936
4937 =for apidoc sv_catpvn_flags
4938
4939 Concatenates the string onto the end of the string which is in the SV.  The
4940 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4941 status set, then the bytes appended should be valid UTF-8.
4942 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4943 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4944 in terms of this function.
4945
4946 =cut
4947 */
4948
4949 void
4950 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4951 {
4952     dVAR;
4953     STRLEN dlen;
4954     const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4955
4956     PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4957
4958     SvGROW(dsv, dlen + slen + 1);
4959     if (sstr == dstr)
4960         sstr = SvPVX_const(dsv);
4961     Move(sstr, SvPVX(dsv) + dlen, slen, char);
4962     SvCUR_set(dsv, SvCUR(dsv) + slen);
4963     *SvEND(dsv) = '\0';
4964     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
4965     SvTAINT(dsv);
4966     if (flags & SV_SMAGIC)
4967         SvSETMAGIC(dsv);
4968 }
4969
4970 /*
4971 =for apidoc sv_catsv
4972
4973 Concatenates the string from SV C<ssv> onto the end of the string in
4974 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
4975 not 'set' magic.  See C<sv_catsv_mg>.
4976
4977 =for apidoc sv_catsv_flags
4978
4979 Concatenates the string from SV C<ssv> onto the end of the string in
4980 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
4981 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4982 and C<sv_catsv_nomg> are implemented in terms of this function.
4983
4984 =cut */
4985
4986 void
4987 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4988 {
4989     dVAR;
4990
4991     PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4992
4993    if (ssv) {
4994         STRLEN slen;
4995         const char *spv = SvPV_flags_const(ssv, slen, flags);
4996         if (spv) {
4997             /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4998                 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4999                 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5000                 get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
5001                 dsv->sv_flags doesn't have that bit set.
5002                 Andy Dougherty  12 Oct 2001
5003             */
5004             const I32 sutf8 = DO_UTF8(ssv);
5005             I32 dutf8;
5006
5007             if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5008                 mg_get(dsv);
5009             dutf8 = DO_UTF8(dsv);
5010
5011             if (dutf8 != sutf8) {
5012                 if (dutf8) {
5013                     /* Not modifying source SV, so taking a temporary copy. */
5014                     SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
5015
5016                     sv_utf8_upgrade(csv);
5017                     spv = SvPV_const(csv, slen);
5018                 }
5019                 else
5020                     /* Leave enough space for the cat that's about to happen */
5021                     sv_utf8_upgrade_flags_grow(dsv, 0, slen);
5022             }
5023             sv_catpvn_nomg(dsv, spv, slen);
5024         }
5025     }
5026     if (flags & SV_SMAGIC)
5027         SvSETMAGIC(dsv);
5028 }
5029
5030 /*
5031 =for apidoc sv_catpv
5032
5033 Concatenates the string onto the end of the string which is in the SV.
5034 If the SV has the UTF-8 status set, then the bytes appended should be
5035 valid UTF-8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
5036
5037 =cut */
5038
5039 void
5040 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
5041 {
5042     dVAR;
5043     register STRLEN len;
5044     STRLEN tlen;
5045     char *junk;
5046
5047     PERL_ARGS_ASSERT_SV_CATPV;
5048
5049     if (!ptr)
5050         return;
5051     junk = SvPV_force(sv, tlen);
5052     len = strlen(ptr);
5053     SvGROW(sv, tlen + len + 1);
5054     if (ptr == junk)
5055         ptr = SvPVX_const(sv);
5056     Move(ptr,SvPVX(sv)+tlen,len+1,char);
5057     SvCUR_set(sv, SvCUR(sv) + len);
5058     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
5059     SvTAINT(sv);
5060 }
5061
5062 /*
5063 =for apidoc sv_catpv_flags
5064
5065 Concatenates the string onto the end of the string which is in the SV.
5066 If the SV has the UTF-8 status set, then the bytes appended should
5067 be valid UTF-8.  If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get>
5068 on the SVs if appropriate, else not.
5069
5070 =cut
5071 */
5072
5073 void
5074 Perl_sv_catpv_flags(pTHX_ SV *dstr, const char *sstr, const I32 flags)
5075 {
5076     PERL_ARGS_ASSERT_SV_CATPV_FLAGS;
5077     sv_catpvn_flags(dstr, sstr, strlen(sstr), flags);
5078 }
5079
5080 /*
5081 =for apidoc sv_catpv_mg
5082
5083 Like C<sv_catpv>, but also handles 'set' magic.
5084
5085 =cut
5086 */
5087
5088 void
5089 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
5090 {
5091     PERL_ARGS_ASSERT_SV_CATPV_MG;
5092
5093     sv_catpv(sv,ptr);
5094     SvSETMAGIC(sv);
5095 }
5096
5097 /*
5098 =for apidoc newSV
5099
5100 Creates a new SV.  A non-zero C<len> parameter indicates the number of
5101 bytes of preallocated string space the SV should have.  An extra byte for a
5102 trailing NUL is also reserved.  (SvPOK is not set for the SV even if string
5103 space is allocated.)  The reference count for the new SV is set to 1.
5104
5105 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5106 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5107 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5108 L<perlhacktips/PERL_MEM_LOG>).  The older API is still there for use in XS
5109 modules supporting older perls.
5110
5111 =cut
5112 */
5113
5114 SV *
5115 Perl_newSV(pTHX_ const STRLEN len)
5116 {
5117     dVAR;
5118     register SV *sv;
5119
5120     new_SV(sv);
5121     if (len) {
5122         sv_upgrade(sv, SVt_PV);
5123         SvGROW(sv, len + 1);
5124     }
5125     return sv;
5126 }
5127 /*
5128 =for apidoc sv_magicext
5129
5130 Adds magic to an SV, upgrading it if necessary. Applies the
5131 supplied vtable and returns a pointer to the magic added.
5132
5133 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5134 In particular, you can add magic to SvREADONLY SVs, and add more than
5135 one instance of the same 'how'.
5136
5137 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5138 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5139 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5140 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5141
5142 (This is now used as a subroutine by C<sv_magic>.)
5143
5144 =cut
5145 */
5146 MAGIC *
5147 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
5148                 const MGVTBL *const vtable, const char *const name, const I32 namlen)
5149 {
5150     dVAR;
5151     MAGIC* mg;
5152
5153     PERL_ARGS_ASSERT_SV_MAGICEXT;
5154
5155     SvUPGRADE(sv, SVt_PVMG);
5156     Newxz(mg, 1, MAGIC);
5157     mg->mg_moremagic = SvMAGIC(sv);
5158     SvMAGIC_set(sv, mg);
5159
5160     /* Sometimes a magic contains a reference loop, where the sv and
5161        object refer to each other.  To prevent a reference loop that
5162        would prevent such objects being freed, we look for such loops
5163        and if we find one we avoid incrementing the object refcount.
5164
5165        Note we cannot do this to avoid self-tie loops as intervening RV must
5166        have its REFCNT incremented to keep it in existence.
5167
5168     */
5169     if (!obj || obj == sv ||
5170         how == PERL_MAGIC_arylen ||
5171         how == PERL_MAGIC_symtab ||
5172         (SvTYPE(obj) == SVt_PVGV &&
5173             (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
5174              || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
5175              || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
5176     {
5177         mg->mg_obj = obj;
5178     }
5179     else {
5180         mg->mg_obj = SvREFCNT_inc_simple(obj);
5181         mg->mg_flags |= MGf_REFCOUNTED;
5182     }
5183
5184     /* Normal self-ties simply pass a null object, and instead of
5185        using mg_obj directly, use the SvTIED_obj macro to produce a
5186        new RV as needed.  For glob "self-ties", we are tieing the PVIO
5187        with an RV obj pointing to the glob containing the PVIO.  In
5188        this case, to avoid a reference loop, we need to weaken the
5189        reference.
5190     */
5191
5192     if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5193         obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
5194     {
5195       sv_rvweaken(obj);
5196     }
5197
5198     mg->mg_type = how;
5199     mg->mg_len = namlen;
5200     if (name) {
5201         if (namlen > 0)
5202             mg->mg_ptr = savepvn(name, namlen);
5203         else if (namlen == HEf_SVKEY) {
5204             /* Yes, this is casting away const. This is only for the case of
5205                HEf_SVKEY. I think we need to document this aberation of the
5206                constness of the API, rather than making name non-const, as
5207                that change propagating outwards a long way.  */
5208             mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
5209         } else
5210             mg->mg_ptr = (char *) name;
5211     }
5212     mg->mg_virtual = (MGVTBL *) vtable;
5213
5214     mg_magical(sv);
5215     if (SvGMAGICAL(sv))
5216         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5217     return mg;
5218 }
5219
5220 /*
5221 =for apidoc sv_magic
5222
5223 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5224 then adds a new magic item of type C<how> to the head of the magic list.
5225
5226 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5227 handling of the C<name> and C<namlen> arguments.
5228
5229 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5230 to add more than one instance of the same 'how'.
5231
5232 =cut
5233 */
5234
5235 void
5236 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
5237              const char *const name, const I32 namlen)
5238 {
5239     dVAR;
5240     const MGVTBL *vtable;
5241     MAGIC* mg;
5242     unsigned int flags;
5243     unsigned int vtable_index;
5244
5245     PERL_ARGS_ASSERT_SV_MAGIC;
5246
5247     if (how < 0 || how > C_ARRAY_LENGTH(PL_magic_data)
5248         || ((flags = PL_magic_data[how]),
5249             (vtable_index = flags & PERL_MAGIC_VTABLE_MASK)
5250             > magic_vtable_max))
5251         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5252
5253     /* PERL_MAGIC_ext is reserved for use by extensions not perl internals.
5254        Useful for attaching extension internal data to perl vars.
5255        Note that multiple extensions may clash if magical scalars
5256        etc holding private data from one are passed to another. */
5257
5258     vtable = (vtable_index == magic_vtable_max)
5259         ? NULL : PL_magic_vtables + vtable_index;
5260
5261 #ifdef PERL_OLD_COPY_ON_WRITE
5262     if (SvIsCOW(sv))
5263         sv_force_normal_flags(sv, 0);
5264 #endif
5265     if (SvREADONLY(sv)) {
5266         if (
5267             /* its okay to attach magic to shared strings; the subsequent
5268              * upgrade to PVMG will unshare the string */
5269             !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
5270
5271             && IN_PERL_RUNTIME
5272             && !PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(how)
5273            )
5274         {
5275             Perl_croak_no_modify(aTHX);
5276         }
5277     }
5278     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5279         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5280             /* sv_magic() refuses to add a magic of the same 'how' as an
5281                existing one
5282              */
5283             if (how == PERL_MAGIC_taint) {
5284                 mg->mg_len |= 1;
5285                 /* Any scalar which already had taint magic on which someone
5286                    (erroneously?) did SvIOK_on() or similar will now be
5287                    incorrectly sporting public "OK" flags.  */
5288                 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5289             }
5290             return;
5291         }
5292     }
5293
5294     /* Rest of work is done else where */
5295     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5296
5297     switch (how) {
5298     case PERL_MAGIC_taint:
5299         mg->mg_len = 1;
5300         break;
5301     case PERL_MAGIC_ext:
5302     case PERL_MAGIC_dbfile:
5303         SvRMAGICAL_on(sv);
5304         break;
5305     }
5306 }
5307
5308 static int
5309 S_sv_unmagicext_flags(pTHX_ SV *const sv, const int type, MGVTBL *vtbl, const U32 flags)
5310 {
5311     MAGIC* mg;
5312     MAGIC** mgp;
5313
5314     assert(flags <= 1);
5315
5316     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5317         return 0;
5318     mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5319     for (mg = *mgp; mg; mg = *mgp) {
5320         const MGVTBL* const virt = mg->mg_virtual;
5321         if (mg->mg_type == type && (!flags || virt == vtbl)) {
5322             *mgp = mg->mg_moremagic;
5323             if (virt && virt->svt_free)
5324                 virt->svt_free(aTHX_ sv, mg);
5325             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5326                 if (mg->mg_len > 0)
5327                     Safefree(mg->mg_ptr);
5328                 else if (mg->mg_len == HEf_SVKEY)
5329                     SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5330                 else if (mg->mg_type == PERL_MAGIC_utf8)
5331                     Safefree(mg->mg_ptr);
5332             }
5333             if (mg->mg_flags & MGf_REFCOUNTED)
5334                 SvREFCNT_dec(mg->mg_obj);
5335             Safefree(mg);
5336         }
5337         else
5338             mgp = &mg->mg_moremagic;
5339     }
5340     if (SvMAGIC(sv)) {
5341         if (SvMAGICAL(sv))      /* if we're under save_magic, wait for restore_magic; */
5342             mg_magical(sv);     /*    else fix the flags now */
5343     }
5344     else {
5345         SvMAGICAL_off(sv);
5346         SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5347     }
5348     return 0;
5349 }
5350
5351 /*
5352 =for apidoc sv_unmagic
5353
5354 Removes all magic of type C<type> from an SV.
5355
5356 =cut
5357 */
5358
5359 int
5360 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5361 {
5362     PERL_ARGS_ASSERT_SV_UNMAGIC;
5363     return S_sv_unmagicext_flags(aTHX_ sv, type, NULL, 0);
5364 }
5365
5366 /*
5367 =for apidoc sv_unmagicext
5368
5369 Removes all magic of type C<type> with the specified C<vtbl> from an SV.
5370
5371 =cut
5372 */
5373
5374 int
5375 Perl_sv_unmagicext(pTHX_ SV *const sv, const int type, MGVTBL *vtbl)
5376 {
5377     PERL_ARGS_ASSERT_SV_UNMAGICEXT;
5378     return S_sv_unmagicext_flags(aTHX_ sv, type, vtbl, 1);
5379 }
5380
5381 /*
5382 =for apidoc sv_rvweaken
5383
5384 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5385 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5386 push a back-reference to this RV onto the array of backreferences
5387 associated with that magic. If the RV is magical, set magic will be
5388 called after the RV is cleared.
5389
5390 =cut
5391 */
5392
5393 SV *
5394 Perl_sv_rvweaken(pTHX_ SV *const sv)
5395 {
5396     SV *tsv;
5397
5398     PERL_ARGS_ASSERT_SV_RVWEAKEN;
5399
5400     if (!SvOK(sv))  /* let undefs pass */
5401         return sv;
5402     if (!SvROK(sv))
5403         Perl_croak(aTHX_ "Can't weaken a nonreference");
5404     else if (SvWEAKREF(sv)) {
5405         Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5406         return sv;
5407     }
5408     tsv = SvRV(sv);
5409     Perl_sv_add_backref(aTHX_ tsv, sv);
5410     SvWEAKREF_on(sv);
5411     SvREFCNT_dec(tsv);
5412     return sv;
5413 }
5414
5415 /* Give tsv backref magic if it hasn't already got it, then push a
5416  * back-reference to sv onto the array associated with the backref magic.
5417  *
5418  * As an optimisation, if there's only one backref and it's not an AV,
5419  * store it directly in the HvAUX or mg_obj slot, avoiding the need to
5420  * allocate an AV. (Whether the slot holds an AV tells us whether this is
5421  * active.)
5422  */
5423
5424 /* A discussion about the backreferences array and its refcount:
5425  *
5426  * The AV holding the backreferences is pointed to either as the mg_obj of
5427  * PERL_MAGIC_backref, or in the specific case of a HV, from the
5428  * xhv_backreferences field. The array is created with a refcount
5429  * of 2. This means that if during global destruction the array gets
5430  * picked on before its parent to have its refcount decremented by the
5431  * random zapper, it won't actually be freed, meaning it's still there for
5432  * when its parent gets freed.
5433  *
5434  * When the parent SV is freed, the extra ref is killed by
5435  * Perl_sv_kill_backrefs.  The other ref is killed, in the case of magic,
5436  * by mg_free() / MGf_REFCOUNTED, or for a hash, by Perl_hv_kill_backrefs.
5437  *
5438  * When a single backref SV is stored directly, it is not reference
5439  * counted.
5440  */
5441
5442 void
5443 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5444 {
5445     dVAR;
5446     SV **svp;
5447     AV *av = NULL;
5448     MAGIC *mg = NULL;
5449
5450     PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5451
5452     /* find slot to store array or singleton backref */
5453
5454     if (SvTYPE(tsv) == SVt_PVHV) {
5455         svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5456     } else {
5457         if (! ((mg =
5458             (SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL))))
5459         {
5460             sv_magic(tsv, NULL, PERL_MAGIC_backref, NULL, 0);
5461             mg = mg_find(tsv, PERL_MAGIC_backref);
5462         }
5463         svp = &(mg->mg_obj);
5464     }
5465
5466     /* create or retrieve the array */
5467
5468     if (   (!*svp && SvTYPE(sv) == SVt_PVAV)
5469         || (*svp && SvTYPE(*svp) != SVt_PVAV)
5470     ) {
5471         /* create array */
5472         av = newAV();
5473         AvREAL_off(av);
5474         SvREFCNT_inc_simple_void(av);
5475         /* av now has a refcnt of 2; see discussion above */
5476         if (*svp) {
5477             /* move single existing backref to the array */
5478             av_extend(av, 1);
5479             AvARRAY(av)[++AvFILLp(av)] = *svp; /* av_push() */
5480         }
5481         *svp = (SV*)av;
5482         if (mg)
5483             mg->mg_flags |= MGf_REFCOUNTED;
5484     }
5485     else
5486         av = MUTABLE_AV(*svp);
5487
5488     if (!av) {
5489         /* optimisation: store single backref directly in HvAUX or mg_obj */
5490         *svp = sv;
5491         return;
5492     }
5493     /* push new backref */
5494     assert(SvTYPE(av) == SVt_PVAV);
5495     if (AvFILLp(av) >= AvMAX(av)) {
5496         av_extend(av, AvFILLp(av)+1);
5497     }
5498     AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5499 }
5500
5501 /* delete a back-reference to ourselves from the backref magic associated
5502  * with the SV we point to.
5503  */
5504
5505 void
5506 Perl_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5507 {
5508     dVAR;
5509     SV **svp = NULL;
5510
5511     PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5512
5513     if (SvTYPE(tsv) == SVt_PVHV) {
5514         if (SvOOK(tsv))
5515             svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5516     }
5517     else {
5518         MAGIC *const mg
5519             = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5520         svp =  mg ? &(mg->mg_obj) : NULL;
5521     }
5522
5523     if (!svp || !*svp)
5524         Perl_croak(aTHX_ "panic: del_backref");
5525
5526     if (SvTYPE(*svp) == SVt_PVAV) {
5527 #ifdef DEBUGGING
5528         int count = 1;
5529 #endif
5530         AV * const av = (AV*)*svp;
5531         SSize_t fill;
5532         assert(!SvIS_FREED(av));
5533         fill = AvFILLp(av);
5534         assert(fill > -1);
5535         svp = AvARRAY(av);
5536         /* for an SV with N weak references to it, if all those
5537          * weak refs are deleted, then sv_del_backref will be called
5538          * N times and O(N^2) compares will be done within the backref
5539          * array. To ameliorate this potential slowness, we:
5540          * 1) make sure this code is as tight as possible;
5541          * 2) when looking for SV, look for it at both the head and tail of the
5542          *    array first before searching the rest, since some create/destroy
5543          *    patterns will cause the backrefs to be freed in order.
5544          */
5545         if (*svp == sv) {
5546             AvARRAY(av)++;
5547             AvMAX(av)--;
5548         }
5549         else {
5550             SV **p = &svp[fill];
5551             SV *const topsv = *p;
5552             if (topsv != sv) {
5553 #ifdef DEBUGGING
5554                 count = 0;
5555 #endif
5556                 while (--p > svp) {
5557                     if (*p == sv) {
5558                         /* We weren't the last entry.
5559                            An unordered list has this property that you
5560                            can take the last element off the end to fill
5561                            the hole, and it's still an unordered list :-)
5562                         */
5563                         *p = topsv;
5564 #ifdef DEBUGGING
5565                         count++;
5566 #else
5567                         break; /* should only be one */
5568 #endif
5569                     }
5570                 }
5571             }
5572         }
5573         assert(count ==1);
5574         AvFILLp(av) = fill-1;
5575     }
5576     else {
5577         /* optimisation: only a single backref, stored directly */
5578         if (*svp != sv)
5579             Perl_croak(aTHX_ "panic: del_backref");
5580         *svp = NULL;
5581     }
5582
5583 }
5584
5585 void
5586 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5587 {
5588     SV **svp;
5589     SV **last;
5590     bool is_array;
5591
5592     PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5593
5594     if (!av)
5595         return;
5596
5597     /* after multiple passes through Perl_sv_clean_all() for a thinngy
5598      * that has badly leaked, the backref array may have gotten freed,
5599      * since we only protect it against 1 round of cleanup */
5600     if (SvIS_FREED(av)) {
5601         if (PL_in_clean_all) /* All is fair */
5602             return;
5603         Perl_croak(aTHX_
5604                    "panic: magic_killbackrefs (freed backref AV/SV)");
5605     }
5606
5607
5608     is_array = (SvTYPE(av) == SVt_PVAV);
5609     if (is_array) {
5610         assert(!SvIS_FREED(av));
5611         svp = AvARRAY(av);
5612         if (svp)
5613             last = svp + AvFILLp(av);
5614     }
5615     else {
5616         /* optimisation: only a single backref, stored directly */
5617         svp = (SV**)&av;
5618         last = svp;
5619     }
5620
5621     if (svp) {
5622         while (svp <= last) {
5623             if (*svp) {
5624                 SV *const referrer = *svp;
5625                 if (SvWEAKREF(referrer)) {
5626                     /* XXX Should we check that it hasn't changed? */
5627                     assert(SvROK(referrer));
5628                     SvRV_set(referrer, 0);
5629                     SvOK_off(referrer);
5630                     SvWEAKREF_off(referrer);
5631                     SvSETMAGIC(referrer);
5632                 } else if (SvTYPE(referrer) == SVt_PVGV ||
5633                            SvTYPE(referrer) == SVt_PVLV) {
5634                     assert(SvTYPE(sv) == SVt_PVHV); /* stash backref */
5635                     /* You lookin' at me?  */
5636                     assert(GvSTASH(referrer));
5637                     assert(GvSTASH(referrer) == (const HV *)sv);
5638                     GvSTASH(referrer) = 0;
5639                 } else if (SvTYPE(referrer) == SVt_PVCV ||
5640                            SvTYPE(referrer) == SVt_PVFM) {
5641                     if (SvTYPE(sv) == SVt_PVHV) { /* stash backref */
5642                         /* You lookin' at me?  */
5643                         assert(CvSTASH(referrer));
5644                         assert(CvSTASH(referrer) == (const HV *)sv);
5645                         SvANY(MUTABLE_CV(referrer))->xcv_stash = 0;
5646                     }
5647                     else {
5648                         assert(SvTYPE(sv) == SVt_PVGV);
5649                         /* You lookin' at me?  */
5650                         assert(CvGV(referrer));
5651                         assert(CvGV(referrer) == (const GV *)sv);
5652                         anonymise_cv_maybe(MUTABLE_GV(sv),
5653                                                 MUTABLE_CV(referrer));
5654                     }
5655
5656                 } else {
5657                     Perl_croak(aTHX_
5658                                "panic: magic_killbackrefs (flags=%"UVxf")",
5659                                (UV)SvFLAGS(referrer));
5660                 }
5661
5662                 if (is_array)
5663                     *svp = NULL;
5664             }
5665             svp++;
5666         }
5667     }
5668     if (is_array) {
5669         AvFILLp(av) = -1;
5670         SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5671     }
5672     return;
5673 }
5674
5675 /*
5676 =for apidoc sv_insert
5677
5678 Inserts a string at the specified offset/length within the SV. Similar to
5679 the Perl substr() function. Handles get magic.
5680
5681 =for apidoc sv_insert_flags
5682
5683 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5684
5685 =cut
5686 */
5687
5688 void
5689 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5690 {
5691     dVAR;
5692     register char *big;
5693     register char *mid;
5694     register char *midend;
5695     register char *bigend;
5696     register I32 i;
5697     STRLEN curlen;
5698
5699     PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5700
5701     if (!bigstr)
5702         Perl_croak(aTHX_ "Can't modify non-existent substring");
5703     SvPV_force_flags(bigstr, curlen, flags);
5704     (void)SvPOK_only_UTF8(bigstr);
5705     if (offset + len > curlen) {
5706         SvGROW(bigstr, offset+len+1);
5707         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5708         SvCUR_set(bigstr, offset+len);
5709     }
5710
5711     SvTAINT(bigstr);
5712     i = littlelen - len;
5713     if (i > 0) {                        /* string might grow */
5714         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5715         mid = big + offset + len;
5716         midend = bigend = big + SvCUR(bigstr);
5717         bigend += i;
5718         *bigend = '\0';
5719         while (midend > mid)            /* shove everything down */
5720             *--bigend = *--midend;
5721         Move(little,big+offset,littlelen,char);
5722         SvCUR_set(bigstr, SvCUR(bigstr) + i);
5723         SvSETMAGIC(bigstr);
5724         return;
5725     }
5726     else if (i == 0) {
5727         Move(little,SvPVX(bigstr)+offset,len,char);
5728         SvSETMAGIC(bigstr);
5729         return;
5730     }
5731
5732     big = SvPVX(bigstr);
5733     mid = big + offset;
5734     midend = mid + len;
5735     bigend = big + SvCUR(bigstr);
5736
5737     if (midend > bigend)
5738         Perl_croak(aTHX_ "panic: sv_insert");
5739
5740     if (mid - big > bigend - midend) {  /* faster to shorten from end */
5741         if (littlelen) {
5742             Move(little, mid, littlelen,char);
5743             mid += littlelen;
5744         }
5745         i = bigend - midend;
5746         if (i > 0) {
5747             Move(midend, mid, i,char);
5748             mid += i;
5749         }
5750         *mid = '\0';
5751         SvCUR_set(bigstr, mid - big);
5752     }
5753     else if ((i = mid - big)) { /* faster from front */
5754         midend -= littlelen;
5755         mid = midend;
5756         Move(big, midend - i, i, char);
5757         sv_chop(bigstr,midend-i);
5758         if (littlelen)
5759             Move(little, mid, littlelen,char);
5760     }
5761     else if (littlelen) {
5762         midend -= littlelen;
5763         sv_chop(bigstr,midend);
5764         Move(little,midend,littlelen,char);
5765     }
5766     else {
5767         sv_chop(bigstr,midend);
5768     }
5769     SvSETMAGIC(bigstr);
5770 }
5771
5772 /*
5773 =for apidoc sv_replace
5774
5775 Make the first argument a copy of the second, then delete the original.
5776 The target SV physically takes over ownership of the body of the source SV
5777 and inherits its flags; however, the target keeps any magic it owns,
5778 and any magic in the source is discarded.
5779 Note that this is a rather specialist SV copying operation; most of the
5780 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5781
5782 =cut
5783 */
5784
5785 void
5786 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5787 {
5788     dVAR;
5789     const U32 refcnt = SvREFCNT(sv);
5790
5791     PERL_ARGS_ASSERT_SV_REPLACE;
5792
5793     SV_CHECK_THINKFIRST_COW_DROP(sv);
5794     if (SvREFCNT(nsv) != 1) {
5795         Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
5796                    " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
5797     }
5798     if (SvMAGICAL(sv)) {
5799         if (SvMAGICAL(nsv))
5800             mg_free(nsv);
5801         else
5802             sv_upgrade(nsv, SVt_PVMG);
5803         SvMAGIC_set(nsv, SvMAGIC(sv));
5804         SvFLAGS(nsv) |= SvMAGICAL(sv);
5805         SvMAGICAL_off(sv);
5806         SvMAGIC_set(sv, NULL);
5807     }
5808     SvREFCNT(sv) = 0;
5809     sv_clear(sv);
5810     assert(!SvREFCNT(sv));
5811 #ifdef DEBUG_LEAKING_SCALARS
5812     sv->sv_flags  = nsv->sv_flags;
5813     sv->sv_any    = nsv->sv_any;
5814     sv->sv_refcnt = nsv->sv_refcnt;
5815     sv->sv_u      = nsv->sv_u;
5816 #else
5817     StructCopy(nsv,sv,SV);
5818 #endif
5819     if(SvTYPE(sv) == SVt_IV) {
5820         SvANY(sv)
5821             = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5822     }
5823
5824
5825 #ifdef PERL_OLD_COPY_ON_WRITE
5826     if (SvIsCOW_normal(nsv)) {
5827         /* We need to follow the pointers around the loop to make the
5828            previous SV point to sv, rather than nsv.  */
5829         SV *next;
5830         SV *current = nsv;
5831         while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5832             assert(next);
5833             current = next;
5834             assert(SvPVX_const(current) == SvPVX_const(nsv));
5835         }
5836         /* Make the SV before us point to the SV after us.  */
5837         if (DEBUG_C_TEST) {
5838             PerlIO_printf(Perl_debug_log, "previous is\n");
5839             sv_dump(current);
5840             PerlIO_printf(Perl_debug_log,
5841                           "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5842                           (UV) SV_COW_NEXT_SV(current), (UV) sv);
5843         }
5844         SV_COW_NEXT_SV_SET(current, sv);
5845     }
5846 #endif
5847     SvREFCNT(sv) = refcnt;
5848     SvFLAGS(nsv) |= SVTYPEMASK;         /* Mark as freed */
5849     SvREFCNT(nsv) = 0;
5850     del_SV(nsv);
5851 }
5852
5853 /* We're about to free a GV which has a CV that refers back to us.
5854  * If that CV will outlive us, make it anonymous (i.e. fix up its CvGV
5855  * field) */
5856
5857 STATIC void
5858 S_anonymise_cv_maybe(pTHX_ GV *gv, CV* cv)
5859 {
5860     char *stash;
5861     SV *gvname;
5862     GV *anongv;
5863
5864     PERL_ARGS_ASSERT_ANONYMISE_CV_MAYBE;
5865
5866     /* be assertive! */
5867     assert(SvREFCNT(gv) == 0);
5868     assert(isGV(gv) && isGV_with_GP(gv));
5869     assert(GvGP(gv));
5870     assert(!CvANON(cv));
5871     assert(CvGV(cv) == gv);
5872
5873     /* will the CV shortly be freed by gp_free() ? */
5874     if (GvCV(gv) == cv && GvGP(gv)->gp_refcnt < 2 && SvREFCNT(cv) < 2) {
5875         SvANY(cv)->xcv_gv = NULL;
5876         return;
5877     }
5878
5879     /* if not, anonymise: */
5880     stash  = GvSTASH(gv) && HvNAME(GvSTASH(gv))
5881               ? HvENAME(GvSTASH(gv)) : NULL;
5882     gvname = Perl_newSVpvf(aTHX_ "%s::__ANON__",
5883                                         stash ? stash : "__ANON__");
5884     anongv = gv_fetchsv(gvname, GV_ADDMULTI, SVt_PVCV);
5885     SvREFCNT_dec(gvname);
5886
5887     CvANON_on(cv);
5888     CvCVGV_RC_on(cv);
5889     SvANY(cv)->xcv_gv = MUTABLE_GV(SvREFCNT_inc(anongv));
5890 }
5891
5892
5893 /*
5894 =for apidoc sv_clear
5895
5896 Clear an SV: call any destructors, free up any memory used by the body,
5897 and free the body itself. The SV's head is I<not> freed, although
5898 its type is set to all 1's so that it won't inadvertently be assumed
5899 to be live during global destruction etc.
5900 This function should only be called when REFCNT is zero. Most of the time
5901 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5902 instead.
5903
5904 =cut
5905 */
5906
5907 void
5908 Perl_sv_clear(pTHX_ SV *const orig_sv)
5909 {
5910     dVAR;
5911     HV *stash;
5912     U32 type;
5913     const struct body_details *sv_type_details;
5914     SV* iter_sv = NULL;
5915     SV* next_sv = NULL;
5916     register SV *sv = orig_sv;
5917     STRLEN hash_index;
5918
5919     PERL_ARGS_ASSERT_SV_CLEAR;
5920
5921     /* within this loop, sv is the SV currently being freed, and
5922      * iter_sv is the most recent AV or whatever that's being iterated
5923      * over to provide more SVs */
5924
5925     while (sv) {
5926
5927         type = SvTYPE(sv);
5928
5929         assert(SvREFCNT(sv) == 0);
5930         assert(SvTYPE(sv) != SVTYPEMASK);
5931
5932         if (type <= SVt_IV) {
5933             /* See the comment in sv.h about the collusion between this
5934              * early return and the overloading of the NULL slots in the
5935              * size table.  */
5936             if (SvROK(sv))
5937                 goto free_rv;
5938             SvFLAGS(sv) &= SVf_BREAK;
5939             SvFLAGS(sv) |= SVTYPEMASK;
5940             goto free_head;
5941         }
5942
5943         assert(!SvOBJECT(sv) || type >= SVt_PVMG); /* objs are always >= MG */
5944
5945         if (type >= SVt_PVMG) {
5946             if (SvOBJECT(sv)) {
5947                 if (!curse(sv, 1)) goto get_next_sv;
5948                 type = SvTYPE(sv); /* destructor may have changed it */
5949             }
5950             /* Free back-references before magic, in case the magic calls
5951              * Perl code that has weak references to sv. */
5952             if (type == SVt_PVHV) {
5953                 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
5954                 if (SvMAGIC(sv))
5955                     mg_free(sv);
5956             }
5957             else if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5958                 SvREFCNT_dec(SvOURSTASH(sv));
5959             } else if (SvMAGIC(sv)) {
5960                 /* Free back-references before other types of magic. */
5961                 sv_unmagic(sv, PERL_MAGIC_backref);
5962                 mg_free(sv);
5963             }
5964             if (type == SVt_PVMG && SvPAD_TYPED(sv))
5965                 SvREFCNT_dec(SvSTASH(sv));
5966         }
5967         switch (type) {
5968             /* case SVt_BIND: */
5969         case SVt_PVIO:
5970             if (IoIFP(sv) &&
5971                 IoIFP(sv) != PerlIO_stdin() &&
5972                 IoIFP(sv) != PerlIO_stdout() &&
5973                 IoIFP(sv) != PerlIO_stderr() &&
5974                 !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5975             {
5976                 io_close(MUTABLE_IO(sv), FALSE);
5977             }
5978             if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5979                 PerlDir_close(IoDIRP(sv));
5980             IoDIRP(sv) = (DIR*)NULL;
5981             Safefree(IoTOP_NAME(sv));
5982             Safefree(IoFMT_NAME(sv));
5983             Safefree(IoBOTTOM_NAME(sv));
5984             goto freescalar;
5985         case SVt_REGEXP:
5986             /* FIXME for plugins */
5987             pregfree2((REGEXP*) sv);
5988             goto freescalar;
5989         case SVt_PVCV:
5990         case SVt_PVFM:
5991             cv_undef(MUTABLE_CV(sv));
5992             /* If we're in a stash, we don't own a reference to it.
5993              * However it does have a back reference to us, which needs to
5994              * be cleared.  */
5995             if ((stash = CvSTASH(sv)))
5996                 sv_del_backref(MUTABLE_SV(stash), sv);
5997             goto freescalar;
5998         case SVt_PVHV:
5999             if (PL_last_swash_hv == (const HV *)sv) {
6000                 PL_last_swash_hv = NULL;
6001             }
6002             if (HvTOTALKEYS((HV*)sv) > 0) {
6003                 const char *name;
6004                 /* this statement should match the one at the beginning of
6005                  * hv_undef_flags() */
6006                 if (   PL_phase != PERL_PHASE_DESTRUCT
6007                     && (name = HvNAME((HV*)sv)))
6008                 {
6009                     if (PL_stashcache)
6010                         (void)hv_delete(PL_stashcache, name,
6011                             HvNAMELEN_get((HV*)sv), G_DISCARD);
6012                     hv_name_set((HV*)sv, NULL, 0, 0);
6013                 }
6014
6015                 /* save old iter_sv in unused SvSTASH field */
6016                 assert(!SvOBJECT(sv));
6017                 SvSTASH(sv) = (HV*)iter_sv;
6018                 iter_sv = sv;
6019
6020                 /* XXX ideally we should save the old value of hash_index
6021                  * too, but I can't think of any place to hide it. The
6022                  * effect of not saving it is that for freeing hashes of
6023                  * hashes, we become quadratic in scanning the HvARRAY of
6024                  * the top hash looking for new entries to free; but
6025                  * hopefully this will be dwarfed by the freeing of all
6026                  * the nested hashes. */
6027                 hash_index = 0;
6028                 next_sv = Perl_hfree_next_entry(aTHX_ (HV*)sv, &hash_index);
6029                 goto get_next_sv; /* process this new sv */
6030             }
6031             /* free empty hash */
6032             Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6033             assert(!HvARRAY((HV*)sv));
6034             break;
6035         case SVt_PVAV:
6036             {
6037                 AV* av = MUTABLE_AV(sv);
6038                 if (PL_comppad == av) {
6039                     PL_comppad = NULL;
6040                     PL_curpad = NULL;
6041                 }
6042                 if (AvREAL(av) && AvFILLp(av) > -1) {
6043                     next_sv = AvARRAY(av)[AvFILLp(av)--];
6044                     /* save old iter_sv in top-most slot of AV,
6045                      * and pray that it doesn't get wiped in the meantime */
6046                     AvARRAY(av)[AvMAX(av)] = iter_sv;
6047                     iter_sv = sv;
6048                     goto get_next_sv; /* process this new sv */
6049                 }
6050                 Safefree(AvALLOC(av));
6051             }
6052
6053             break;
6054         case SVt_PVLV:
6055             if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
6056                 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
6057                 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
6058                 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
6059             }
6060             else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV**  */
6061                 SvREFCNT_dec(LvTARG(sv));
6062         case SVt_PVGV:
6063             if (isGV_with_GP(sv)) {
6064                 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
6065                    && HvENAME_get(stash))
6066                     mro_method_changed_in(stash);
6067                 gp_free(MUTABLE_GV(sv));
6068                 if (GvNAME_HEK(sv))
6069                     unshare_hek(GvNAME_HEK(sv));
6070                 /* If we're in a stash, we don't own a reference to it.
6071                  * However it does have a back reference to us, which
6072                  * needs to be cleared.  */
6073                 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
6074                         sv_del_backref(MUTABLE_SV(stash), sv);
6075             }
6076             /* FIXME. There are probably more unreferenced pointers to SVs
6077              * in the interpreter struct that we should check and tidy in
6078              * a similar fashion to this:  */
6079             if ((const GV *)sv == PL_last_in_gv)
6080                 PL_last_in_gv = NULL;
6081         case SVt_PVMG:
6082         case SVt_PVNV:
6083         case SVt_PVIV:
6084         case SVt_PV:
6085           freescalar:
6086             /* Don't bother with SvOOK_off(sv); as we're only going to
6087              * free it.  */
6088             if (SvOOK(sv)) {
6089                 STRLEN offset;
6090                 SvOOK_offset(sv, offset);
6091                 SvPV_set(sv, SvPVX_mutable(sv) - offset);
6092                 /* Don't even bother with turning off the OOK flag.  */
6093             }
6094             if (SvROK(sv)) {
6095             free_rv:
6096                 {
6097                     SV * const target = SvRV(sv);
6098                     if (SvWEAKREF(sv))
6099                         sv_del_backref(target, sv);
6100                     else
6101                         next_sv = target;
6102                 }
6103             }
6104 #ifdef PERL_OLD_COPY_ON_WRITE
6105             else if (SvPVX_const(sv)
6106                      && !(SvTYPE(sv) == SVt_PVIO
6107                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6108             {
6109                 if (SvIsCOW(sv)) {
6110                     if (DEBUG_C_TEST) {
6111                         PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6112                         sv_dump(sv);
6113                     }
6114                     if (SvLEN(sv)) {
6115                         sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
6116                     } else {
6117                         unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6118                     }
6119
6120                     SvFAKE_off(sv);
6121                 } else if (SvLEN(sv)) {
6122                     Safefree(SvPVX_const(sv));
6123                 }
6124             }
6125 #else
6126             else if (SvPVX_const(sv) && SvLEN(sv)
6127                      && !(SvTYPE(sv) == SVt_PVIO
6128                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6129                 Safefree(SvPVX_mutable(sv));
6130             else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6131                 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6132                 SvFAKE_off(sv);
6133             }
6134 #endif
6135             break;
6136         case SVt_NV:
6137             break;
6138         }
6139
6140       free_body:
6141
6142         SvFLAGS(sv) &= SVf_BREAK;
6143         SvFLAGS(sv) |= SVTYPEMASK;
6144
6145         sv_type_details = bodies_by_type + type;
6146         if (sv_type_details->arena) {
6147             del_body(((char *)SvANY(sv) + sv_type_details->offset),
6148                      &PL_body_roots[type]);
6149         }
6150         else if (sv_type_details->body_size) {
6151             safefree(SvANY(sv));
6152         }
6153
6154       free_head:
6155         /* caller is responsible for freeing the head of the original sv */
6156         if (sv != orig_sv && !SvREFCNT(sv))
6157             del_SV(sv);
6158
6159         /* grab and free next sv, if any */
6160       get_next_sv:
6161         while (1) {
6162             sv = NULL;
6163             if (next_sv) {
6164                 sv = next_sv;
6165                 next_sv = NULL;
6166             }
6167             else if (!iter_sv) {
6168                 break;
6169             } else if (SvTYPE(iter_sv) == SVt_PVAV) {
6170                 AV *const av = (AV*)iter_sv;
6171                 if (AvFILLp(av) > -1) {
6172                     sv = AvARRAY(av)[AvFILLp(av)--];
6173                 }
6174                 else { /* no more elements of current AV to free */
6175                     sv = iter_sv;
6176                     type = SvTYPE(sv);
6177                     /* restore previous value, squirrelled away */
6178                     iter_sv = AvARRAY(av)[AvMAX(av)];
6179                     Safefree(AvALLOC(av));
6180                     goto free_body;
6181                 }
6182             } else if (SvTYPE(iter_sv) == SVt_PVHV) {
6183                 if (!HvTOTALKEYS((HV *)iter_sv)) {
6184                     /* no more elements of current HV to free */
6185                     sv = iter_sv;
6186                     type = SvTYPE(sv);
6187                     /* Restore previous value of iter_sv, squirrelled away */
6188                     assert(!SvOBJECT(sv));
6189                     iter_sv = (SV*)SvSTASH(sv);
6190
6191                     /* ideally we should restore the old hash_index here,
6192                      * but we don't currently save the old value */
6193                     hash_index = 0;
6194
6195                     /* free any remaining detritus from the hash struct */
6196                     Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6197                     assert(!HvARRAY((HV*)sv));
6198                     goto free_body;
6199                 }
6200                 sv = Perl_hfree_next_entry(aTHX_ (HV*)iter_sv, &hash_index);
6201             }
6202
6203             /* unrolled SvREFCNT_dec and sv_free2 follows: */
6204
6205             if (!sv)
6206                 continue;
6207             if (!SvREFCNT(sv)) {
6208                 sv_free(sv);
6209                 continue;
6210             }
6211             if (--(SvREFCNT(sv)))
6212                 continue;
6213 #ifdef DEBUGGING
6214             if (SvTEMP(sv)) {
6215                 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6216                          "Attempt to free temp prematurely: SV 0x%"UVxf
6217                          pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6218                 continue;
6219             }
6220 #endif
6221             if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6222                 /* make sure SvREFCNT(sv)==0 happens very seldom */
6223                 SvREFCNT(sv) = (~(U32)0)/2;
6224                 continue;
6225             }
6226             break;
6227         } /* while 1 */
6228
6229     } /* while sv */
6230 }
6231
6232 /* This routine curses the sv itself, not the object referenced by sv. So
6233    sv does not have to be ROK. */
6234
6235 static bool
6236 S_curse(pTHX_ SV * const sv, const bool check_refcnt) {
6237     dVAR;
6238
6239     PERL_ARGS_ASSERT_CURSE;
6240     assert(SvOBJECT(sv));
6241
6242     if (PL_defstash &&  /* Still have a symbol table? */
6243         SvDESTROYABLE(sv))
6244     {
6245         dSP;
6246         HV* stash;
6247         do {
6248             CV* destructor;
6249             stash = SvSTASH(sv);
6250             destructor = StashHANDLER(stash,DESTROY);
6251             if (destructor
6252                 /* A constant subroutine can have no side effects, so
6253                    don't bother calling it.  */
6254                 && !CvCONST(destructor)
6255                 /* Don't bother calling an empty destructor */
6256                 && (CvISXSUB(destructor)
6257                 || (CvSTART(destructor)
6258                     && (CvSTART(destructor)->op_next->op_type
6259                                         != OP_LEAVESUB))))
6260             {
6261                 SV* const tmpref = newRV(sv);
6262                 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
6263                 ENTER;
6264                 PUSHSTACKi(PERLSI_DESTROY);
6265                 EXTEND(SP, 2);
6266                 PUSHMARK(SP);
6267                 PUSHs(tmpref);
6268                 PUTBACK;
6269                 call_sv(MUTABLE_SV(destructor),
6270                             G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
6271                 POPSTACK;
6272                 SPAGAIN;
6273                 LEAVE;
6274                 if(SvREFCNT(tmpref) < 2) {
6275                     /* tmpref is not kept alive! */
6276                     SvREFCNT(sv)--;
6277                     SvRV_set(tmpref, NULL);
6278                     SvROK_off(tmpref);
6279                 }
6280                 SvREFCNT_dec(tmpref);
6281             }
6282         } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
6283
6284
6285         if (check_refcnt && SvREFCNT(sv)) {
6286             if (PL_in_clean_objs)
6287                 Perl_croak(aTHX_
6288                     "DESTROY created new reference to dead object '%s'",
6289                     HvNAME_get(stash));
6290             /* DESTROY gave object new lease on life */
6291             return FALSE;
6292         }
6293     }
6294
6295     if (SvOBJECT(sv)) {
6296         SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
6297         SvOBJECT_off(sv);       /* Curse the object. */
6298         if (SvTYPE(sv) != SVt_PVIO)
6299             --PL_sv_objcount;/* XXX Might want something more general */
6300     }
6301     return TRUE;
6302 }
6303
6304 /*
6305 =for apidoc sv_newref
6306
6307 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6308 instead.
6309
6310 =cut
6311 */
6312
6313 SV *
6314 Perl_sv_newref(pTHX_ SV *const sv)
6315 {
6316     PERL_UNUSED_CONTEXT;
6317     if (sv)
6318         (SvREFCNT(sv))++;
6319     return sv;
6320 }
6321
6322 /*
6323 =for apidoc sv_free
6324
6325 Decrement an SV's reference count, and if it drops to zero, call
6326 C<sv_clear> to invoke destructors and free up any memory used by
6327 the body; finally, deallocate the SV's head itself.
6328 Normally called via a wrapper macro C<SvREFCNT_dec>.
6329
6330 =cut
6331 */
6332
6333 void
6334 Perl_sv_free(pTHX_ SV *const sv)
6335 {
6336     dVAR;
6337     if (!sv)
6338         return;
6339     if (SvREFCNT(sv) == 0) {
6340         if (SvFLAGS(sv) & SVf_BREAK)
6341             /* this SV's refcnt has been artificially decremented to
6342              * trigger cleanup */
6343             return;
6344         if (PL_in_clean_all) /* All is fair */
6345             return;
6346         if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6347             /* make sure SvREFCNT(sv)==0 happens very seldom */
6348             SvREFCNT(sv) = (~(U32)0)/2;
6349             return;
6350         }
6351         if (ckWARN_d(WARN_INTERNAL)) {
6352 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
6353             Perl_dump_sv_child(aTHX_ sv);
6354 #else
6355   #ifdef DEBUG_LEAKING_SCALARS
6356             sv_dump(sv);
6357   #endif
6358 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6359             if (PL_warnhook == PERL_WARNHOOK_FATAL
6360                 || ckDEAD(packWARN(WARN_INTERNAL))) {
6361                 /* Don't let Perl_warner cause us to escape our fate:  */
6362                 abort();
6363             }
6364 #endif
6365             /* This may not return:  */
6366             Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6367                         "Attempt to free unreferenced scalar: SV 0x%"UVxf
6368                         pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6369 #endif
6370         }
6371 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6372         abort();
6373 #endif
6374         return;
6375     }
6376     if (--(SvREFCNT(sv)) > 0)
6377         return;
6378     Perl_sv_free2(aTHX_ sv);
6379 }
6380
6381 void
6382 Perl_sv_free2(pTHX_ SV *const sv)
6383 {
6384     dVAR;
6385
6386     PERL_ARGS_ASSERT_SV_FREE2;
6387
6388 #ifdef DEBUGGING
6389     if (SvTEMP(sv)) {
6390         Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6391                          "Attempt to free temp prematurely: SV 0x%"UVxf
6392                          pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6393         return;
6394     }
6395 #endif
6396     if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6397         /* make sure SvREFCNT(sv)==0 happens very seldom */
6398         SvREFCNT(sv) = (~(U32)0)/2;
6399         return;
6400     }
6401     sv_clear(sv);
6402     if (! SvREFCNT(sv))
6403         del_SV(sv);
6404 }
6405
6406 /*
6407 =for apidoc sv_len
6408
6409 Returns the length of the string in the SV. Handles magic and type
6410 coercion.  See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6411
6412 =cut
6413 */
6414
6415 STRLEN
6416 Perl_sv_len(pTHX_ register SV *const sv)
6417 {
6418     STRLEN len;
6419
6420     if (!sv)
6421         return 0;
6422
6423     if (SvGMAGICAL(sv))
6424         len = mg_length(sv);
6425     else
6426         (void)SvPV_const(sv, len);
6427     return len;
6428 }
6429
6430 /*
6431 =for apidoc sv_len_utf8
6432
6433 Returns the number of characters in the string in an SV, counting wide
6434 UTF-8 bytes as a single character. Handles magic and type coercion.
6435
6436 =cut
6437 */
6438
6439 /*
6440  * The length is cached in PERL_MAGIC_utf8, in the mg_len field.  Also the
6441  * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
6442  * (Note that the mg_len is not the length of the mg_ptr field.
6443  * This allows the cache to store the character length of the string without
6444  * needing to malloc() extra storage to attach to the mg_ptr.)
6445  *
6446  */
6447
6448 STRLEN
6449 Perl_sv_len_utf8(pTHX_ register SV *const sv)
6450 {
6451     if (!sv)
6452         return 0;
6453
6454     if (SvGMAGICAL(sv))
6455         return mg_length(sv);
6456     else
6457     {
6458         STRLEN len;
6459         const U8 *s = (U8*)SvPV_const(sv, len);
6460
6461         if (PL_utf8cache) {
6462             STRLEN ulen;
6463             MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
6464
6465             if (mg && (mg->mg_len != -1 || mg->mg_ptr)) {
6466                 if (mg->mg_len != -1)
6467                     ulen = mg->mg_len;
6468                 else {
6469                     /* We can use the offset cache for a headstart.
6470                        The longer value is stored in the first pair.  */
6471                     STRLEN *cache = (STRLEN *) mg->mg_ptr;
6472
6473                     ulen = cache[0] + Perl_utf8_length(aTHX_ s + cache[1],
6474                                                        s + len);
6475                 }
6476
6477                 if (PL_utf8cache < 0) {
6478                     const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
6479                     assert_uft8_cache_coherent("sv_len_utf8", ulen, real, sv);
6480                 }
6481             }
6482             else {
6483                 ulen = Perl_utf8_length(aTHX_ s, s + len);
6484                 utf8_mg_len_cache_update(sv, &mg, ulen);
6485             }
6486             return ulen;
6487         }
6488         return Perl_utf8_length(aTHX_ s, s + len);
6489     }
6490 }
6491
6492 /* Walk forwards to find the byte corresponding to the passed in UTF-8
6493    offset.  */
6494 static STRLEN
6495 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
6496                       STRLEN *const uoffset_p, bool *const at_end)
6497 {
6498     const U8 *s = start;
6499     STRLEN uoffset = *uoffset_p;
6500
6501     PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
6502
6503     while (s < send && uoffset) {
6504         --uoffset;
6505         s += UTF8SKIP(s);
6506     }
6507     if (s == send) {
6508         *at_end = TRUE;
6509     }
6510     else if (s > send) {
6511         *at_end = TRUE;
6512         /* This is the existing behaviour. Possibly it should be a croak, as
6513            it's actually a bounds error  */
6514         s = send;
6515     }
6516     *uoffset_p -= uoffset;
6517     return s - start;
6518 }
6519
6520 /* Given the length of the string in both bytes and UTF-8 characters, decide
6521    whether to walk forwards or backwards to find the byte corresponding to
6522    the passed in UTF-8 offset.  */
6523 static STRLEN
6524 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
6525                     STRLEN uoffset, const STRLEN uend)
6526 {
6527     STRLEN backw = uend - uoffset;
6528
6529     PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
6530
6531     if (uoffset < 2 * backw) {
6532         /* The assumption is that going forwards is twice the speed of going
6533            forward (that's where the 2 * backw comes from).
6534            (The real figure of course depends on the UTF-8 data.)  */
6535         const U8 *s = start;
6536
6537         while (s < send && uoffset--)
6538             s += UTF8SKIP(s);
6539         assert (s <= send);
6540         if (s > send)
6541             s = send;
6542         return s - start;
6543     }
6544
6545     while (backw--) {
6546         send--;
6547         while (UTF8_IS_CONTINUATION(*send))
6548             send--;
6549     }
6550     return send - start;
6551 }
6552
6553 /* For the string representation of the given scalar, find the byte
6554    corresponding to the passed in UTF-8 offset.  uoffset0 and boffset0
6555    give another position in the string, *before* the sought offset, which
6556    (which is always true, as 0, 0 is a valid pair of positions), which should
6557    help reduce the amount of linear searching.
6558    If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
6559    will be used to reduce the amount of linear searching. The cache will be
6560    created if necessary, and the found value offered to it for update.  */
6561 static STRLEN
6562 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
6563                     const U8 *const send, STRLEN uoffset,
6564                     STRLEN uoffset0, STRLEN boffset0)
6565 {
6566     STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy.  */
6567     bool found = FALSE;
6568     bool at_end = FALSE;
6569
6570     PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
6571
6572     assert (uoffset >= uoffset0);
6573
6574     if (!uoffset)
6575         return 0;
6576
6577     if (!SvREADONLY(sv)
6578         && PL_utf8cache
6579         && (*mgp || (SvTYPE(sv) >= SVt_PVMG &&
6580                      (*mgp = mg_find(sv, PERL_MAGIC_utf8))))) {
6581         if ((*mgp)->mg_ptr) {
6582             STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
6583             if (cache[0] == uoffset) {
6584                 /* An exact match. */
6585                 return cache[1];
6586             }
6587             if (cache[2] == uoffset) {
6588                 /* An exact match. */
6589                 return cache[3];
6590             }
6591
6592             if (cache[0] < uoffset) {
6593                 /* The cache already knows part of the way.   */
6594                 if (cache[0] > uoffset0) {
6595                     /* The cache knows more than the passed in pair  */
6596                     uoffset0 = cache[0];
6597                     boffset0 = cache[1];
6598                 }
6599                 if ((*mgp)->mg_len != -1) {
6600                     /* And we know the end too.  */
6601                     boffset = boffset0
6602                         + sv_pos_u2b_midway(start + boffset0, send,
6603                                               uoffset - uoffset0,
6604                                               (*mgp)->mg_len - uoffset0);
6605                 } else {
6606                     uoffset -= uoffset0;
6607                     boffset = boffset0
6608                         + sv_pos_u2b_forwards(start + boffset0,
6609                                               send, &uoffset, &at_end);
6610                     uoffset += uoffset0;
6611                 }
6612             }
6613             else if (cache[2] < uoffset) {
6614                 /* We're between the two cache entries.  */
6615                 if (cache[2] > uoffset0) {
6616                     /* and the cache knows more than the passed in pair  */
6617                     uoffset0 = cache[2];
6618                     boffset0 = cache[3];
6619                 }
6620
6621                 boffset = boffset0
6622                     + sv_pos_u2b_midway(start + boffset0,
6623                                           start + cache[1],
6624                                           uoffset - uoffset0,
6625                                           cache[0] - uoffset0);
6626             } else {
6627                 boffset = boffset0
6628                     + sv_pos_u2b_midway(start + boffset0,
6629                                           start + cache[3],
6630                                           uoffset - uoffset0,
6631                                           cache[2] - uoffset0);
6632             }
6633             found = TRUE;
6634         }
6635         else if ((*mgp)->mg_len != -1) {
6636             /* If we can take advantage of a passed in offset, do so.  */
6637             /* In fact, offset0 is either 0, or less than offset, so don't
6638                need to worry about the other possibility.  */
6639             boffset = boffset0
6640                 + sv_pos_u2b_midway(start + boffset0, send,
6641                                       uoffset - uoffset0,
6642                                       (*mgp)->mg_len - uoffset0);
6643             found = TRUE;
6644         }
6645     }
6646
6647     if (!found || PL_utf8cache < 0) {
6648         STRLEN real_boffset;
6649         uoffset -= uoffset0;
6650         real_boffset = boffset0 + sv_pos_u2b_forwards(start + boffset0,
6651                                                       send, &uoffset, &at_end);
6652         uoffset += uoffset0;
6653
6654         if (found && PL_utf8cache < 0)
6655             assert_uft8_cache_coherent("sv_pos_u2b_cache", boffset,
6656                                        real_boffset, sv);
6657         boffset = real_boffset;
6658     }
6659
6660     if (PL_utf8cache) {
6661         if (at_end)
6662             utf8_mg_len_cache_update(sv, mgp, uoffset);
6663         else
6664             utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
6665     }
6666     return boffset;
6667 }
6668
6669
6670 /*
6671 =for apidoc sv_pos_u2b_flags
6672
6673 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6674 the start of the string, to a count of the equivalent number of bytes; if
6675 lenp is non-zero, it does the same to lenp, but this time starting from
6676 the offset, rather than from the start of the string. Handles type coercion.
6677 I<flags> is passed to C<SvPV_flags>, and usually should be
6678 C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
6679
6680 =cut
6681 */
6682
6683 /*
6684  * sv_pos_u2b_flags() uses, like sv_pos_b2u(), the mg_ptr of the potential
6685  * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6686  * byte offsets.  See also the comments of S_utf8_mg_pos_cache_update().
6687  *
6688  */
6689
6690 STRLEN
6691 Perl_sv_pos_u2b_flags(pTHX_ SV *const sv, STRLEN uoffset, STRLEN *const lenp,
6692                       U32 flags)
6693 {
6694     const U8 *start;
6695     STRLEN len;
6696     STRLEN boffset;
6697
6698     PERL_ARGS_ASSERT_SV_POS_U2B_FLAGS;
6699
6700     start = (U8*)SvPV_flags(sv, len, flags);
6701     if (len) {
6702         const U8 * const send = start + len;
6703         MAGIC *mg = NULL;
6704         boffset = sv_pos_u2b_cached(sv, &mg, start, send, uoffset, 0, 0);
6705
6706         if (lenp
6707             && *lenp /* don't bother doing work for 0, as its bytes equivalent
6708                         is 0, and *lenp is already set to that.  */) {
6709             /* Convert the relative offset to absolute.  */
6710             const STRLEN uoffset2 = uoffset + *lenp;
6711             const STRLEN boffset2
6712                 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6713                                       uoffset, boffset) - boffset;
6714
6715             *lenp = boffset2;
6716         }
6717     } else {
6718         if (lenp)
6719             *lenp = 0;
6720         boffset = 0;
6721     }
6722
6723     return boffset;
6724 }
6725
6726 /*
6727 =for apidoc sv_pos_u2b
6728
6729 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6730 the start of the string, to a count of the equivalent number of bytes; if
6731 lenp is non-zero, it does the same to lenp, but this time starting from
6732 the offset, rather than from the start of the string. Handles magic and
6733 type coercion.
6734
6735 Use C<sv_pos_u2b_flags> in preference, which correctly handles strings longer
6736 than 2Gb.
6737
6738 =cut
6739 */
6740
6741 /*
6742  * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6743  * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6744  * byte offsets.  See also the comments of S_utf8_mg_pos_cache_update().
6745  *
6746  */
6747
6748 /* This function is subject to size and sign problems */
6749
6750 void
6751 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
6752 {
6753     PERL_ARGS_ASSERT_SV_POS_U2B;
6754
6755     if (lenp) {
6756         STRLEN ulen = (STRLEN)*lenp;
6757         *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, &ulen,
6758                                          SV_GMAGIC|SV_CONST_RETURN);
6759         *lenp = (I32)ulen;
6760     } else {
6761         *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, NULL,
6762                                          SV_GMAGIC|SV_CONST_RETURN);
6763     }
6764 }
6765
6766 static void
6767 S_utf8_mg_len_cache_update(pTHX_ SV *const sv, MAGIC **const mgp,
6768                            const STRLEN ulen)
6769 {
6770     PERL_ARGS_ASSERT_UTF8_MG_LEN_CACHE_UPDATE;
6771     if (SvREADONLY(sv))
6772         return;
6773
6774     if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6775                   !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6776         *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6777     }
6778     assert(*mgp);
6779
6780     (*mgp)->mg_len = ulen;
6781     /* For now, treat "overflowed" as "still unknown". See RT #72924.  */
6782     if (ulen != (STRLEN) (*mgp)->mg_len)
6783         (*mgp)->mg_len = -1;
6784 }
6785
6786 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6787    byte length pairing. The (byte) length of the total SV is passed in too,
6788    as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6789    may not have updated SvCUR, so we can't rely on reading it directly.
6790
6791    The proffered utf8/byte length pairing isn't used if the cache already has
6792    two pairs, and swapping either for the proffered pair would increase the
6793    RMS of the intervals between known byte offsets.
6794
6795    The cache itself consists of 4 STRLEN values
6796    0: larger UTF-8 offset
6797    1: corresponding byte offset
6798    2: smaller UTF-8 offset
6799    3: corresponding byte offset
6800
6801    Unused cache pairs have the value 0, 0.
6802    Keeping the cache "backwards" means that the invariant of
6803    cache[0] >= cache[2] is maintained even with empty slots, which means that
6804    the code that uses it doesn't need to worry if only 1 entry has actually
6805    been set to non-zero.  It also makes the "position beyond the end of the
6806    cache" logic much simpler, as the first slot is always the one to start
6807    from.
6808 */
6809 static void
6810 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6811                            const STRLEN utf8, const STRLEN blen)
6812 {
6813     STRLEN *cache;
6814
6815     PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6816
6817     if (SvREADONLY(sv))
6818         return;
6819
6820     if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6821                   !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6822         *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6823                            0);
6824         (*mgp)->mg_len = -1;
6825     }
6826     assert(*mgp);
6827
6828     if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6829         Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6830         (*mgp)->mg_ptr = (char *) cache;
6831     }
6832     assert(cache);
6833
6834     if (PL_utf8cache < 0 && SvPOKp(sv)) {
6835         /* SvPOKp() because it's possible that sv has string overloading, and
6836            therefore is a reference, hence SvPVX() is actually a pointer.
6837            This cures the (very real) symptoms of RT 69422, but I'm not actually
6838            sure whether we should even be caching the results of UTF-8
6839            operations on overloading, given that nothing stops overloading
6840            returning a different value every time it's called.  */
6841         const U8 *start = (const U8 *) SvPVX_const(sv);
6842         const STRLEN realutf8 = utf8_length(start, start + byte);
6843
6844         assert_uft8_cache_coherent("utf8_mg_pos_cache_update", utf8, realutf8,
6845                                    sv);
6846     }
6847
6848     /* Cache is held with the later position first, to simplify the code
6849        that deals with unbounded ends.  */
6850
6851     ASSERT_UTF8_CACHE(cache);
6852     if (cache[1] == 0) {
6853         /* Cache is totally empty  */
6854         cache[0] = utf8;
6855         cache[1] = byte;
6856     } else if (cache[3] == 0) {
6857         if (byte > cache[1]) {
6858             /* New one is larger, so goes first.  */
6859             cache[2] = cache[0];
6860             cache[3] = cache[1];
6861             cache[0] = utf8;
6862             cache[1] = byte;
6863         } else {
6864             cache[2] = utf8;
6865             cache[3] = byte;
6866         }
6867     } else {
6868 #define THREEWAY_SQUARE(a,b,c,d) \
6869             ((float)((d) - (c))) * ((float)((d) - (c))) \
6870             + ((float)((c) - (b))) * ((float)((c) - (b))) \
6871                + ((float)((b) - (a))) * ((float)((b) - (a)))
6872
6873         /* Cache has 2 slots in use, and we know three potential pairs.
6874            Keep the two that give the lowest RMS distance. Do the
6875            calculation in bytes simply because we always know the byte
6876            length.  squareroot has the same ordering as the positive value,
6877            so don't bother with the actual square root.  */
6878         const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6879         if (byte > cache[1]) {
6880             /* New position is after the existing pair of pairs.  */
6881             const float keep_earlier
6882                 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6883             const float keep_later
6884                 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6885
6886             if (keep_later < keep_earlier) {
6887                 if (keep_later < existing) {
6888                     cache[2] = cache[0];
6889                     cache[3] = cache[1];
6890                     cache[0] = utf8;
6891                     cache[1] = byte;
6892                 }
6893             }
6894             else {
6895                 if (keep_earlier < existing) {
6896                     cache[0] = utf8;
6897                     cache[1] = byte;
6898                 }
6899             }
6900         }
6901         else if (byte > cache[3]) {
6902             /* New position is between the existing pair of pairs.  */
6903             const float keep_earlier
6904                 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6905             const float keep_later
6906                 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6907
6908             if (keep_later < keep_earlier) {
6909                 if (keep_later < existing) {
6910                     cache[2] = utf8;
6911                     cache[3] = byte;
6912                 }
6913             }
6914             else {
6915                 if (keep_earlier < existing) {
6916                     cache[0] = utf8;
6917                     cache[1] = byte;
6918                 }
6919             }
6920         }
6921         else {
6922             /* New position is before the existing pair of pairs.  */
6923             const float keep_earlier
6924                 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6925             const float keep_later
6926                 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6927
6928             if (keep_later < keep_earlier) {
6929                 if (keep_later < existing) {
6930                     cache[2] = utf8;
6931                     cache[3] = byte;
6932                 }
6933             }
6934             else {
6935                 if (keep_earlier < existing) {
6936                     cache[0] = cache[2];
6937                     cache[1] = cache[3];
6938                     cache[2] = utf8;
6939                     cache[3] = byte;
6940                 }
6941             }
6942         }
6943     }
6944     ASSERT_UTF8_CACHE(cache);
6945 }
6946
6947 /* We already know all of the way, now we may be able to walk back.  The same
6948    assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6949    backward is half the speed of walking forward. */
6950 static STRLEN
6951 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6952                     const U8 *end, STRLEN endu)
6953 {
6954     const STRLEN forw = target - s;
6955     STRLEN backw = end - target;
6956
6957     PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6958
6959     if (forw < 2 * backw) {
6960         return utf8_length(s, target);
6961     }
6962
6963     while (end > target) {
6964         end--;
6965         while (UTF8_IS_CONTINUATION(*end)) {
6966             end--;
6967         }
6968         endu--;
6969     }
6970     return endu;
6971 }
6972
6973 /*
6974 =for apidoc sv_pos_b2u
6975
6976 Converts the value pointed to by offsetp from a count of bytes from the
6977 start of the string, to a count of the equivalent number of UTF-8 chars.
6978 Handles magic and type coercion.
6979
6980 =cut
6981 */
6982
6983 /*
6984  * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6985  * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6986  * byte offsets.
6987  *
6988  */
6989 void
6990 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6991 {
6992     const U8* s;
6993     const STRLEN byte = *offsetp;
6994     STRLEN len = 0; /* Actually always set, but let's keep gcc happy.  */
6995     STRLEN blen;
6996     MAGIC* mg = NULL;
6997     const U8* send;
6998     bool found = FALSE;
6999
7000     PERL_ARGS_ASSERT_SV_POS_B2U;
7001
7002     if (!sv)
7003         return;
7004
7005     s = (const U8*)SvPV_const(sv, blen);
7006
7007     if (blen < byte)
7008         Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
7009
7010     send = s + byte;
7011
7012     if (!SvREADONLY(sv)
7013         && PL_utf8cache
7014         && SvTYPE(sv) >= SVt_PVMG
7015         && (mg = mg_find(sv, PERL_MAGIC_utf8)))
7016     {
7017         if (mg->mg_ptr) {
7018             STRLEN * const cache = (STRLEN *) mg->mg_ptr;
7019             if (cache[1] == byte) {
7020                 /* An exact match. */
7021                 *offsetp = cache[0];
7022                 return;
7023             }
7024             if (cache[3] == byte) {
7025                 /* An exact match. */
7026                 *offsetp = cache[2];
7027                 return;
7028             }
7029
7030             if (cache[1] < byte) {
7031                 /* We already know part of the way. */
7032                 if (mg->mg_len != -1) {
7033                     /* Actually, we know the end too.  */
7034                     len = cache[0]
7035                         + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
7036                                               s + blen, mg->mg_len - cache[0]);
7037                 } else {
7038                     len = cache[0] + utf8_length(s + cache[1], send);
7039                 }
7040             }
7041             else if (cache[3] < byte) {
7042                 /* We're between the two cached pairs, so we do the calculation
7043                    offset by the byte/utf-8 positions for the earlier pair,
7044                    then add the utf-8 characters from the string start to
7045                    there.  */
7046                 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
7047                                           s + cache[1], cache[0] - cache[2])
7048                     + cache[2];
7049
7050             }
7051             else { /* cache[3] > byte */
7052                 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
7053                                           cache[2]);
7054
7055             }
7056             ASSERT_UTF8_CACHE(cache);
7057             found = TRUE;
7058         } else if (mg->mg_len != -1) {
7059             len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
7060             found = TRUE;
7061         }
7062     }
7063     if (!found || PL_utf8cache < 0) {
7064         const STRLEN real_len = utf8_length(s, send);
7065
7066         if (found && PL_utf8cache < 0)
7067             assert_uft8_cache_coherent("sv_pos_b2u", len, real_len, sv);
7068         len = real_len;
7069     }
7070     *offsetp = len;
7071
7072     if (PL_utf8cache) {
7073         if (blen == byte)
7074             utf8_mg_len_cache_update(sv, &mg, len);
7075         else
7076             utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
7077     }
7078 }
7079
7080 static void
7081 S_assert_uft8_cache_coherent(pTHX_ const char *const func, STRLEN from_cache,
7082                              STRLEN real, SV *const sv)
7083 {
7084     PERL_ARGS_ASSERT_ASSERT_UFT8_CACHE_COHERENT;
7085
7086     /* As this is debugging only code, save space by keeping this test here,
7087        rather than inlining it in all the callers.  */
7088     if (from_cache == real)
7089         return;
7090
7091     /* Need to turn the assertions off otherwise we may recurse infinitely
7092        while printing error messages.  */
7093     SAVEI8(PL_utf8cache);
7094     PL_utf8cache = 0;
7095     Perl_croak(aTHX_ "panic: %s cache %"UVuf" real %"UVuf" for %"SVf,
7096                func, (UV) from_cache, (UV) real, SVfARG(sv));
7097 }
7098
7099 /*
7100 =for apidoc sv_eq
7101
7102 Returns a boolean indicating whether the strings in the two SVs are
7103 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7104 coerce its args to strings if necessary.
7105
7106 =for apidoc sv_eq_flags
7107
7108 Returns a boolean indicating whether the strings in the two SVs are
7109 identical. Is UTF-8 and 'use bytes' aware and coerces its args to strings
7110 if necessary. If the flags include SV_GMAGIC, it handles get-magic, too.
7111
7112 =cut
7113 */
7114
7115 I32
7116 Perl_sv_eq_flags(pTHX_ register SV *sv1, register SV *sv2, const U32 flags)
7117 {
7118     dVAR;
7119     const char *pv1;
7120     STRLEN cur1;
7121     const char *pv2;
7122     STRLEN cur2;
7123     I32  eq     = 0;
7124     char *tpv   = NULL;
7125     SV* svrecode = NULL;
7126
7127     if (!sv1) {
7128         pv1 = "";
7129         cur1 = 0;
7130     }
7131     else {
7132         /* if pv1 and pv2 are the same, second SvPV_const call may
7133          * invalidate pv1 (if we are handling magic), so we may need to
7134          * make a copy */
7135         if (sv1 == sv2 && flags & SV_GMAGIC
7136          && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
7137             pv1 = SvPV_const(sv1, cur1);
7138             sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
7139         }
7140         pv1 = SvPV_flags_const(sv1, cur1, flags);
7141     }
7142
7143     if (!sv2){
7144         pv2 = "";
7145         cur2 = 0;
7146     }
7147     else
7148         pv2 = SvPV_flags_const(sv2, cur2, flags);
7149
7150     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7151         /* Differing utf8ness.
7152          * Do not UTF8size the comparands as a side-effect. */
7153          if (PL_encoding) {
7154               if (SvUTF8(sv1)) {
7155                    svrecode = newSVpvn(pv2, cur2);
7156                    sv_recode_to_utf8(svrecode, PL_encoding);
7157                    pv2 = SvPV_const(svrecode, cur2);
7158               }
7159               else {
7160                    svrecode = newSVpvn(pv1, cur1);
7161                    sv_recode_to_utf8(svrecode, PL_encoding);
7162                    pv1 = SvPV_const(svrecode, cur1);
7163               }
7164               /* Now both are in UTF-8. */
7165               if (cur1 != cur2) {
7166                    SvREFCNT_dec(svrecode);
7167                    return FALSE;
7168               }
7169          }
7170          else {
7171               if (SvUTF8(sv1)) {
7172                   /* sv1 is the UTF-8 one  */
7173                   return bytes_cmp_utf8((const U8*)pv2, cur2,
7174                                         (const U8*)pv1, cur1) == 0;
7175               }
7176               else {
7177                   /* sv2 is the UTF-8 one  */
7178                   return bytes_cmp_utf8((const U8*)pv1, cur1,
7179                                         (const U8*)pv2, cur2) == 0;
7180               }
7181          }
7182     }
7183
7184     if (cur1 == cur2)
7185         eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
7186
7187     SvREFCNT_dec(svrecode);
7188     if (tpv)
7189         Safefree(tpv);
7190
7191     return eq;
7192 }
7193
7194 /*
7195 =for apidoc sv_cmp
7196
7197 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
7198 string in C<sv1> is less than, equal to, or greater than the string in
7199 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7200 coerce its args to strings if necessary.  See also C<sv_cmp_locale>.
7201
7202 =for apidoc sv_cmp_flags
7203
7204 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
7205 string in C<sv1> is less than, equal to, or greater than the string in
7206 C<sv2>. Is UTF-8 and 'use bytes' aware and will coerce its args to strings
7207 if necessary. If the flags include SV_GMAGIC, it handles get magic. See
7208 also C<sv_cmp_locale_flags>.
7209
7210 =cut
7211 */
7212
7213 I32
7214 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
7215 {
7216     return sv_cmp_flags(sv1, sv2, SV_GMAGIC);
7217 }
7218
7219 I32
7220 Perl_sv_cmp_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7221                   const U32 flags)
7222 {
7223     dVAR;
7224     STRLEN cur1, cur2;
7225     const char *pv1, *pv2;
7226     char *tpv = NULL;
7227     I32  cmp;
7228     SV *svrecode = NULL;
7229
7230     if (!sv1) {
7231         pv1 = "";
7232         cur1 = 0;
7233     }
7234     else
7235         pv1 = SvPV_flags_const(sv1, cur1, flags);
7236
7237     if (!sv2) {
7238         pv2 = "";
7239         cur2 = 0;
7240     }
7241     else
7242         pv2 = SvPV_flags_const(sv2, cur2, flags);
7243
7244     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7245         /* Differing utf8ness.
7246          * Do not UTF8size the comparands as a side-effect. */
7247         if (SvUTF8(sv1)) {
7248             if (PL_encoding) {
7249                  svrecode = newSVpvn(pv2, cur2);
7250                  sv_recode_to_utf8(svrecode, PL_encoding);
7251                  pv2 = SvPV_const(svrecode, cur2);
7252             }
7253             else {
7254                 const int retval = -bytes_cmp_utf8((const U8*)pv2, cur2,
7255                                                    (const U8*)pv1, cur1);
7256                 return retval ? retval < 0 ? -1 : +1 : 0;
7257             }
7258         }
7259         else {
7260             if (PL_encoding) {
7261                  svrecode = newSVpvn(pv1, cur1);
7262                  sv_recode_to_utf8(svrecode, PL_encoding);
7263                  pv1 = SvPV_const(svrecode, cur1);
7264             }
7265             else {
7266                 const int retval = bytes_cmp_utf8((const U8*)pv1, cur1,
7267                                                   (const U8*)pv2, cur2);
7268                 return retval ? retval < 0 ? -1 : +1 : 0;
7269             }
7270         }
7271     }
7272
7273     if (!cur1) {
7274         cmp = cur2 ? -1 : 0;
7275     } else if (!cur2) {
7276         cmp = 1;
7277     } else {
7278         const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
7279
7280         if (retval) {
7281             cmp = retval < 0 ? -1 : 1;
7282         } else if (cur1 == cur2) {
7283             cmp = 0;
7284         } else {
7285             cmp = cur1 < cur2 ? -1 : 1;
7286         }
7287     }
7288
7289     SvREFCNT_dec(svrecode);
7290     if (tpv)
7291         Safefree(tpv);
7292
7293     return cmp;
7294 }
7295
7296 /*
7297 =for apidoc sv_cmp_locale
7298
7299 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7300 'use bytes' aware, handles get magic, and will coerce its args to strings
7301 if necessary.  See also C<sv_cmp>.
7302
7303 =for apidoc sv_cmp_locale_flags
7304
7305 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7306 'use bytes' aware and will coerce its args to strings if necessary. If the
7307 flags contain SV_GMAGIC, it handles get magic. See also C<sv_cmp_flags>.
7308
7309 =cut
7310 */
7311
7312 I32
7313 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
7314 {
7315     return sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC);
7316 }
7317
7318 I32
7319 Perl_sv_cmp_locale_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7320                          const U32 flags)
7321 {
7322     dVAR;
7323 #ifdef USE_LOCALE_COLLATE
7324
7325     char *pv1, *pv2;
7326     STRLEN len1, len2;
7327     I32 retval;
7328
7329     if (PL_collation_standard)
7330         goto raw_compare;
7331
7332     len1 = 0;
7333     pv1 = sv1 ? sv_collxfrm_flags(sv1, &len1, flags) : (char *) NULL;
7334     len2 = 0;
7335     pv2 = sv2 ? sv_collxfrm_flags(sv2, &len2, flags) : (char *) NULL;
7336
7337     if (!pv1 || !len1) {
7338         if (pv2 && len2)
7339             return -1;
7340         else
7341             goto raw_compare;
7342     }
7343     else {
7344         if (!pv2 || !len2)
7345             return 1;
7346     }
7347
7348     retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
7349
7350     if (retval)
7351         return retval < 0 ? -1 : 1;
7352
7353     /*
7354      * When the result of collation is equality, that doesn't mean
7355      * that there are no differences -- some locales exclude some
7356      * characters from consideration.  So to avoid false equalities,
7357      * we use the raw string as a tiebreaker.
7358      */
7359
7360   raw_compare:
7361     /*FALLTHROUGH*/
7362
7363 #endif /* USE_LOCALE_COLLATE */
7364
7365     return sv_cmp(sv1, sv2);
7366 }
7367
7368
7369 #ifdef USE_LOCALE_COLLATE
7370
7371 /*
7372 =for apidoc sv_collxfrm
7373
7374 This calls C<sv_collxfrm_flags> with the SV_GMAGIC flag. See
7375 C<sv_collxfrm_flags>.
7376
7377 =for apidoc sv_collxfrm_flags
7378
7379 Add Collate Transform magic to an SV if it doesn't already have it. If the
7380 flags contain SV_GMAGIC, it handles get-magic.
7381
7382 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
7383 scalar data of the variable, but transformed to such a format that a normal
7384 memory comparison can be used to compare the data according to the locale
7385 settings.
7386
7387 =cut
7388 */
7389
7390 char *
7391 Perl_sv_collxfrm_flags(pTHX_ SV *const sv, STRLEN *const nxp, const I32 flags)
7392 {
7393     dVAR;
7394     MAGIC *mg;
7395
7396     PERL_ARGS_ASSERT_SV_COLLXFRM_FLAGS;
7397
7398     mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
7399     if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
7400         const char *s;
7401         char *xf;
7402         STRLEN len, xlen;
7403
7404         if (mg)
7405             Safefree(mg->mg_ptr);
7406         s = SvPV_flags_const(sv, len, flags);
7407         if ((xf = mem_collxfrm(s, len, &xlen))) {
7408             if (! mg) {
7409 #ifdef PERL_OLD_COPY_ON_WRITE
7410                 if (SvIsCOW(sv))
7411                     sv_force_normal_flags(sv, 0);
7412 #endif
7413                 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
7414                                  0, 0);
7415                 assert(mg);
7416             }
7417             mg->mg_ptr = xf;
7418             mg->mg_len = xlen;
7419         }
7420         else {
7421             if (mg) {
7422                 mg->mg_ptr = NULL;
7423                 mg->mg_len = -1;
7424             }
7425         }
7426     }
7427     if (mg && mg->mg_ptr) {
7428         *nxp = mg->mg_len;
7429         return mg->mg_ptr + sizeof(PL_collation_ix);
7430     }
7431     else {
7432         *nxp = 0;
7433         return NULL;
7434     }
7435 }
7436
7437 #endif /* USE_LOCALE_COLLATE */
7438
7439 static char *
7440 S_sv_gets_append_to_utf8(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7441 {
7442     SV * const tsv = newSV(0);
7443     ENTER;
7444     SAVEFREESV(tsv);
7445     sv_gets(tsv, fp, 0);
7446     sv_utf8_upgrade_nomg(tsv);
7447     SvCUR_set(sv,append);
7448     sv_catsv(sv,tsv);
7449     LEAVE;
7450     return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7451 }
7452
7453 static char *
7454 S_sv_gets_read_record(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7455 {
7456     I32 bytesread;
7457     const U32 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
7458       /* Grab the size of the record we're getting */
7459     char *const buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
7460 #ifdef VMS
7461     int fd;
7462 #endif
7463
7464     /* Go yank in */
7465 #ifdef VMS
7466     /* VMS wants read instead of fread, because fread doesn't respect */
7467     /* RMS record boundaries. This is not necessarily a good thing to be */
7468     /* doing, but we've got no other real choice - except avoid stdio
7469        as implementation - perhaps write a :vms layer ?
7470     */
7471     fd = PerlIO_fileno(fp);
7472     if (fd != -1) {
7473         bytesread = PerlLIO_read(fd, buffer, recsize);
7474     }
7475     else /* in-memory file from PerlIO::Scalar */
7476 #endif
7477     {
7478         bytesread = PerlIO_read(fp, buffer, recsize);
7479     }
7480
7481     if (bytesread < 0)
7482         bytesread = 0;
7483     SvCUR_set(sv, bytesread + append);
7484     buffer[bytesread] = '\0';
7485     return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7486 }
7487
7488 /*
7489 =for apidoc sv_gets
7490
7491 Get a line from the filehandle and store it into the SV, optionally
7492 appending to the currently-stored string.
7493
7494 =cut
7495 */
7496
7497 char *
7498 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
7499 {
7500     dVAR;
7501     const char *rsptr;
7502     STRLEN rslen;
7503     register STDCHAR rslast;
7504     register STDCHAR *bp;
7505     register I32 cnt;
7506     I32 i = 0;
7507     I32 rspara = 0;
7508
7509     PERL_ARGS_ASSERT_SV_GETS;
7510
7511     if (SvTHINKFIRST(sv))
7512         sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
7513     /* XXX. If you make this PVIV, then copy on write can copy scalars read
7514        from <>.
7515        However, perlbench says it's slower, because the existing swipe code
7516        is faster than copy on write.
7517        Swings and roundabouts.  */
7518     SvUPGRADE(sv, SVt_PV);
7519
7520     SvSCREAM_off(sv);
7521
7522     if (append) {
7523         if (PerlIO_isutf8(fp)) {
7524             if (!SvUTF8(sv)) {
7525                 sv_utf8_upgrade_nomg(sv);
7526                 sv_pos_u2b(sv,&append,0);
7527             }
7528         } else if (SvUTF8(sv)) {
7529             return S_sv_gets_append_to_utf8(aTHX_ sv, fp, append);
7530         }
7531     }
7532
7533     SvPOK_only(sv);
7534     if (!append) {
7535         SvCUR_set(sv,0);
7536     }
7537     if (PerlIO_isutf8(fp))
7538         SvUTF8_on(sv);
7539
7540     if (IN_PERL_COMPILETIME) {
7541         /* we always read code in line mode */
7542         rsptr = "\n";
7543         rslen = 1;
7544     }
7545     else if (RsSNARF(PL_rs)) {
7546         /* If it is a regular disk file use size from stat() as estimate
7547            of amount we are going to read -- may result in mallocing
7548            more memory than we really need if the layers below reduce
7549            the size we read (e.g. CRLF or a gzip layer).
7550          */
7551         Stat_t st;
7552         if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode))  {
7553             const Off_t offset = PerlIO_tell(fp);
7554             if (offset != (Off_t) -1 && st.st_size + append > offset) {
7555                 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
7556             }
7557         }
7558         rsptr = NULL;
7559         rslen = 0;
7560     }
7561     else if (RsRECORD(PL_rs)) {
7562         return S_sv_gets_read_record(aTHX_ sv, fp, append);
7563     }
7564     else if (RsPARA(PL_rs)) {
7565         rsptr = "\n\n";
7566         rslen = 2;
7567         rspara = 1;
7568     }
7569     else {
7570         /* Get $/ i.e. PL_rs into same encoding as stream wants */
7571         if (PerlIO_isutf8(fp)) {
7572             rsptr = SvPVutf8(PL_rs, rslen);
7573         }
7574         else {
7575             if (SvUTF8(PL_rs)) {
7576                 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7577                     Perl_croak(aTHX_ "Wide character in $/");
7578                 }
7579             }
7580             rsptr = SvPV_const(PL_rs, rslen);
7581         }
7582     }
7583
7584     rslast = rslen ? rsptr[rslen - 1] : '\0';
7585
7586     if (rspara) {               /* have to do this both before and after */
7587         do {                    /* to make sure file boundaries work right */
7588             if (PerlIO_eof(fp))
7589                 return 0;
7590             i = PerlIO_getc(fp);
7591             if (i != '\n') {
7592                 if (i == -1)
7593                     return 0;
7594                 PerlIO_ungetc(fp,i);
7595                 break;
7596             }
7597         } while (i != EOF);
7598     }
7599
7600     /* See if we know enough about I/O mechanism to cheat it ! */
7601
7602     /* This used to be #ifdef test - it is made run-time test for ease
7603        of abstracting out stdio interface. One call should be cheap
7604        enough here - and may even be a macro allowing compile
7605        time optimization.
7606      */
7607
7608     if (PerlIO_fast_gets(fp)) {
7609
7610     /*
7611      * We're going to steal some values from the stdio struct
7612      * and put EVERYTHING in the innermost loop into registers.
7613      */
7614     register STDCHAR *ptr;
7615     STRLEN bpx;
7616     I32 shortbuffered;
7617
7618 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7619     /* An ungetc()d char is handled separately from the regular
7620      * buffer, so we getc() it back out and stuff it in the buffer.
7621      */
7622     i = PerlIO_getc(fp);
7623     if (i == EOF) return 0;
7624     *(--((*fp)->_ptr)) = (unsigned char) i;
7625     (*fp)->_cnt++;
7626 #endif
7627
7628     /* Here is some breathtakingly efficient cheating */
7629
7630     cnt = PerlIO_get_cnt(fp);                   /* get count into register */
7631     /* make sure we have the room */
7632     if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7633         /* Not room for all of it
7634            if we are looking for a separator and room for some
7635          */
7636         if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7637             /* just process what we have room for */
7638             shortbuffered = cnt - SvLEN(sv) + append + 1;
7639             cnt -= shortbuffered;
7640         }
7641         else {
7642             shortbuffered = 0;
7643             /* remember that cnt can be negative */
7644             SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7645         }
7646     }
7647     else
7648         shortbuffered = 0;
7649     bp = (STDCHAR*)SvPVX_const(sv) + append;  /* move these two too to registers */
7650     ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7651     DEBUG_P(PerlIO_printf(Perl_debug_log,
7652         "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7653     DEBUG_P(PerlIO_printf(Perl_debug_log,
7654         "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7655                PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7656                PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7657     for (;;) {
7658       screamer:
7659         if (cnt > 0) {
7660             if (rslen) {
7661                 while (cnt > 0) {                    /* this     |  eat */
7662                     cnt--;
7663                     if ((*bp++ = *ptr++) == rslast)  /* really   |  dust */
7664                         goto thats_all_folks;        /* screams  |  sed :-) */
7665                 }
7666             }
7667             else {
7668                 Copy(ptr, bp, cnt, char);            /* this     |  eat */
7669                 bp += cnt;                           /* screams  |  dust */
7670                 ptr += cnt;                          /* louder   |  sed :-) */
7671                 cnt = 0;
7672                 assert (!shortbuffered);
7673                 goto cannot_be_shortbuffered;
7674             }
7675         }
7676
7677         if (shortbuffered) {            /* oh well, must extend */
7678             cnt = shortbuffered;
7679             shortbuffered = 0;
7680             bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7681             SvCUR_set(sv, bpx);
7682             SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7683             bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7684             continue;
7685         }
7686
7687     cannot_be_shortbuffered:
7688         DEBUG_P(PerlIO_printf(Perl_debug_log,
7689                               "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7690                               PTR2UV(ptr),(long)cnt));
7691         PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7692
7693         DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7694             "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7695             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7696             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7697
7698         /* This used to call 'filbuf' in stdio form, but as that behaves like
7699            getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7700            another abstraction.  */
7701         i   = PerlIO_getc(fp);          /* get more characters */
7702
7703         DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7704             "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7705             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7706             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7707
7708         cnt = PerlIO_get_cnt(fp);
7709         ptr = (STDCHAR*)PerlIO_get_ptr(fp);     /* reregisterize cnt and ptr */
7710         DEBUG_P(PerlIO_printf(Perl_debug_log,
7711             "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7712
7713         if (i == EOF)                   /* all done for ever? */
7714             goto thats_really_all_folks;
7715
7716         bpx = bp - (STDCHAR*)SvPVX_const(sv);   /* box up before relocation */
7717         SvCUR_set(sv, bpx);
7718         SvGROW(sv, bpx + cnt + 2);
7719         bp = (STDCHAR*)SvPVX_const(sv) + bpx;   /* unbox after relocation */
7720
7721         *bp++ = (STDCHAR)i;             /* store character from PerlIO_getc */
7722
7723         if (rslen && (STDCHAR)i == rslast)  /* all done for now? */
7724             goto thats_all_folks;
7725     }
7726
7727 thats_all_folks:
7728     if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7729           memNE((char*)bp - rslen, rsptr, rslen))
7730         goto screamer;                          /* go back to the fray */
7731 thats_really_all_folks:
7732     if (shortbuffered)
7733         cnt += shortbuffered;
7734         DEBUG_P(PerlIO_printf(Perl_debug_log,
7735             "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7736     PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt);  /* put these back or we're in trouble */
7737     DEBUG_P(PerlIO_printf(Perl_debug_log,
7738         "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7739         PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7740         PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7741     *bp = '\0';
7742     SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv));      /* set length */
7743     DEBUG_P(PerlIO_printf(Perl_debug_log,
7744         "Screamer: done, len=%ld, string=|%.*s|\n",
7745         (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7746     }
7747    else
7748     {
7749        /*The big, slow, and stupid way. */
7750 #ifdef USE_HEAP_INSTEAD_OF_STACK        /* Even slower way. */
7751         STDCHAR *buf = NULL;
7752         Newx(buf, 8192, STDCHAR);
7753         assert(buf);
7754 #else
7755         STDCHAR buf[8192];
7756 #endif
7757
7758 screamer2:
7759         if (rslen) {
7760             register const STDCHAR * const bpe = buf + sizeof(buf);
7761             bp = buf;
7762             while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7763                 ; /* keep reading */
7764             cnt = bp - buf;
7765         }
7766         else {
7767             cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7768             /* Accommodate broken VAXC compiler, which applies U8 cast to
7769              * both args of ?: operator, causing EOF to change into 255
7770              */
7771             if (cnt > 0)
7772                  i = (U8)buf[cnt - 1];
7773             else
7774                  i = EOF;
7775         }
7776
7777         if (cnt < 0)
7778             cnt = 0;  /* we do need to re-set the sv even when cnt <= 0 */
7779         if (append)
7780              sv_catpvn(sv, (char *) buf, cnt);
7781         else
7782              sv_setpvn(sv, (char *) buf, cnt);
7783
7784         if (i != EOF &&                 /* joy */
7785             (!rslen ||
7786              SvCUR(sv) < rslen ||
7787              memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7788         {
7789             append = -1;
7790             /*
7791              * If we're reading from a TTY and we get a short read,
7792              * indicating that the user hit his EOF character, we need
7793              * to notice it now, because if we try to read from the TTY
7794              * again, the EOF condition will disappear.
7795              *
7796              * The comparison of cnt to sizeof(buf) is an optimization
7797              * that prevents unnecessary calls to feof().
7798              *
7799              * - jik 9/25/96
7800              */
7801             if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
7802                 goto screamer2;
7803         }
7804
7805 #ifdef USE_HEAP_INSTEAD_OF_STACK
7806         Safefree(buf);
7807 #endif
7808     }
7809
7810     if (rspara) {               /* have to do this both before and after */
7811         while (i != EOF) {      /* to make sure file boundaries work right */
7812             i = PerlIO_getc(fp);
7813             if (i != '\n') {
7814                 PerlIO_ungetc(fp,i);
7815                 break;
7816             }
7817         }
7818     }
7819
7820     return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7821 }
7822
7823 /*
7824 =for apidoc sv_inc
7825
7826 Auto-increment of the value in the SV, doing string to numeric conversion
7827 if necessary. Handles 'get' magic and operator overloading.
7828
7829 =cut
7830 */
7831
7832 void
7833 Perl_sv_inc(pTHX_ register SV *const sv)
7834 {
7835     if (!sv)
7836         return;
7837     SvGETMAGIC(sv);
7838     sv_inc_nomg(sv);
7839 }
7840
7841 /*
7842 =for apidoc sv_inc_nomg
7843
7844 Auto-increment of the value in the SV, doing string to numeric conversion
7845 if necessary. Handles operator overloading. Skips handling 'get' magic.
7846
7847 =cut
7848 */
7849
7850 void
7851 Perl_sv_inc_nomg(pTHX_ register SV *const sv)
7852 {
7853     dVAR;
7854     register char *d;
7855     int flags;
7856
7857     if (!sv)
7858         return;
7859     if (SvTHINKFIRST(sv)) {
7860         if (SvIsCOW(sv))
7861             sv_force_normal_flags(sv, 0);
7862         if (SvREADONLY(sv)) {
7863             if (IN_PERL_RUNTIME)
7864                 Perl_croak_no_modify(aTHX);
7865         }
7866         if (SvROK(sv)) {
7867             IV i;
7868             if (SvAMAGIC(sv) && AMG_CALLunary(sv, inc_amg))
7869                 return;
7870             i = PTR2IV(SvRV(sv));
7871             sv_unref(sv);
7872             sv_setiv(sv, i);
7873         }
7874     }
7875     flags = SvFLAGS(sv);
7876     if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7877         /* It's (privately or publicly) a float, but not tested as an
7878            integer, so test it to see. */
7879         (void) SvIV(sv);
7880         flags = SvFLAGS(sv);
7881     }
7882     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7883         /* It's publicly an integer, or privately an integer-not-float */
7884 #ifdef PERL_PRESERVE_IVUV
7885       oops_its_int:
7886 #endif
7887         if (SvIsUV(sv)) {
7888             if (SvUVX(sv) == UV_MAX)
7889                 sv_setnv(sv, UV_MAX_P1);
7890             else
7891                 (void)SvIOK_only_UV(sv);
7892                 SvUV_set(sv, SvUVX(sv) + 1);
7893         } else {
7894             if (SvIVX(sv) == IV_MAX)
7895                 sv_setuv(sv, (UV)IV_MAX + 1);
7896             else {
7897                 (void)SvIOK_only(sv);
7898                 SvIV_set(sv, SvIVX(sv) + 1);
7899             }
7900         }
7901         return;
7902     }
7903     if (flags & SVp_NOK) {
7904         const NV was = SvNVX(sv);
7905         if (NV_OVERFLOWS_INTEGERS_AT &&
7906             was >= NV_OVERFLOWS_INTEGERS_AT) {
7907             Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
7908                            "Lost precision when incrementing %" NVff " by 1",
7909                            was);
7910         }
7911         (void)SvNOK_only(sv);
7912         SvNV_set(sv, was + 1.0);
7913         return;
7914     }
7915
7916     if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7917         if ((flags & SVTYPEMASK) < SVt_PVIV)
7918             sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7919         (void)SvIOK_only(sv);
7920         SvIV_set(sv, 1);
7921         return;
7922     }
7923     d = SvPVX(sv);
7924     while (isALPHA(*d)) d++;
7925     while (isDIGIT(*d)) d++;
7926     if (d < SvEND(sv)) {
7927 #ifdef PERL_PRESERVE_IVUV
7928         /* Got to punt this as an integer if needs be, but we don't issue
7929            warnings. Probably ought to make the sv_iv_please() that does
7930            the conversion if possible, and silently.  */
7931         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7932         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7933             /* Need to try really hard to see if it's an integer.
7934                9.22337203685478e+18 is an integer.
7935                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7936                so $a="9.22337203685478e+18"; $a+0; $a++
7937                needs to be the same as $a="9.22337203685478e+18"; $a++
7938                or we go insane. */
7939
7940             (void) sv_2iv(sv);
7941             if (SvIOK(sv))
7942                 goto oops_its_int;
7943
7944             /* sv_2iv *should* have made this an NV */
7945             if (flags & SVp_NOK) {
7946                 (void)SvNOK_only(sv);
7947                 SvNV_set(sv, SvNVX(sv) + 1.0);
7948                 return;
7949             }
7950             /* I don't think we can get here. Maybe I should assert this
7951                And if we do get here I suspect that sv_setnv will croak. NWC
7952                Fall through. */
7953 #if defined(USE_LONG_DOUBLE)
7954             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",
7955                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7956 #else
7957             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7958                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7959 #endif
7960         }
7961 #endif /* PERL_PRESERVE_IVUV */
7962         sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7963         return;
7964     }
7965     d--;
7966     while (d >= SvPVX_const(sv)) {
7967         if (isDIGIT(*d)) {
7968             if (++*d <= '9')
7969                 return;
7970             *(d--) = '0';
7971         }
7972         else {
7973 #ifdef EBCDIC
7974             /* MKS: The original code here died if letters weren't consecutive.
7975              * at least it didn't have to worry about non-C locales.  The
7976              * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7977              * arranged in order (although not consecutively) and that only
7978              * [A-Za-z] are accepted by isALPHA in the C locale.
7979              */
7980             if (*d != 'z' && *d != 'Z') {
7981                 do { ++*d; } while (!isALPHA(*d));
7982                 return;
7983             }
7984             *(d--) -= 'z' - 'a';
7985 #else
7986             ++*d;
7987             if (isALPHA(*d))
7988                 return;
7989             *(d--) -= 'z' - 'a' + 1;
7990 #endif
7991         }
7992     }
7993     /* oh,oh, the number grew */
7994     SvGROW(sv, SvCUR(sv) + 2);
7995     SvCUR_set(sv, SvCUR(sv) + 1);
7996     for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7997         *d = d[-1];
7998     if (isDIGIT(d[1]))
7999         *d = '1';
8000     else
8001         *d = d[1];
8002 }
8003
8004 /*
8005 =for apidoc sv_dec
8006
8007 Auto-decrement of the value in the SV, doing string to numeric conversion
8008 if necessary. Handles 'get' magic and operator overloading.
8009
8010 =cut
8011 */
8012
8013 void
8014 Perl_sv_dec(pTHX_ register SV *const sv)
8015 {
8016     dVAR;
8017     if (!sv)
8018         return;
8019     SvGETMAGIC(sv);
8020     sv_dec_nomg(sv);
8021 }
8022
8023 /*
8024 =for apidoc sv_dec_nomg
8025
8026 Auto-decrement of the value in the SV, doing string to numeric conversion
8027 if necessary. Handles operator overloading. Skips handling 'get' magic.
8028
8029 =cut
8030 */
8031
8032 void
8033 Perl_sv_dec_nomg(pTHX_ register SV *const sv)
8034 {
8035     dVAR;
8036     int flags;
8037
8038     if (!sv)
8039         return;
8040     if (SvTHINKFIRST(sv)) {
8041         if (SvIsCOW(sv))
8042             sv_force_normal_flags(sv, 0);
8043         if (SvREADONLY(sv)) {
8044             if (IN_PERL_RUNTIME)
8045                 Perl_croak_no_modify(aTHX);
8046         }
8047         if (SvROK(sv)) {
8048             IV i;
8049             if (SvAMAGIC(sv) && AMG_CALLunary(sv, dec_amg))
8050                 return;
8051             i = PTR2IV(SvRV(sv));
8052             sv_unref(sv);
8053             sv_setiv(sv, i);
8054         }
8055     }
8056     /* Unlike sv_inc we don't have to worry about string-never-numbers
8057        and keeping them magic. But we mustn't warn on punting */
8058     flags = SvFLAGS(sv);
8059     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8060         /* It's publicly an integer, or privately an integer-not-float */
8061 #ifdef PERL_PRESERVE_IVUV
8062       oops_its_int:
8063 #endif
8064         if (SvIsUV(sv)) {
8065             if (SvUVX(sv) == 0) {
8066                 (void)SvIOK_only(sv);
8067                 SvIV_set(sv, -1);
8068             }
8069             else {
8070                 (void)SvIOK_only_UV(sv);
8071                 SvUV_set(sv, SvUVX(sv) - 1);
8072             }
8073         } else {
8074             if (SvIVX(sv) == IV_MIN) {
8075                 sv_setnv(sv, (NV)IV_MIN);
8076                 goto oops_its_num;
8077             }
8078             else {
8079                 (void)SvIOK_only(sv);
8080                 SvIV_set(sv, SvIVX(sv) - 1);
8081             }
8082         }
8083         return;
8084     }
8085     if (flags & SVp_NOK) {
8086     oops_its_num:
8087         {
8088             const NV was = SvNVX(sv);
8089             if (NV_OVERFLOWS_INTEGERS_AT &&
8090                 was <= -NV_OVERFLOWS_INTEGERS_AT) {
8091                 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8092                                "Lost precision when decrementing %" NVff " by 1",
8093                                was);
8094             }
8095             (void)SvNOK_only(sv);
8096             SvNV_set(sv, was - 1.0);
8097             return;
8098         }
8099     }
8100     if (!(flags & SVp_POK)) {
8101         if ((flags & SVTYPEMASK) < SVt_PVIV)
8102             sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
8103         SvIV_set(sv, -1);
8104         (void)SvIOK_only(sv);
8105         return;
8106     }
8107 #ifdef PERL_PRESERVE_IVUV
8108     {
8109         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8110         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8111             /* Need to try really hard to see if it's an integer.
8112                9.22337203685478e+18 is an integer.
8113                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8114                so $a="9.22337203685478e+18"; $a+0; $a--
8115                needs to be the same as $a="9.22337203685478e+18"; $a--
8116                or we go insane. */
8117
8118             (void) sv_2iv(sv);
8119             if (SvIOK(sv))
8120                 goto oops_its_int;
8121
8122             /* sv_2iv *should* have made this an NV */
8123             if (flags & SVp_NOK) {
8124                 (void)SvNOK_only(sv);
8125                 SvNV_set(sv, SvNVX(sv) - 1.0);
8126                 return;
8127             }
8128             /* I don't think we can get here. Maybe I should assert this
8129                And if we do get here I suspect that sv_setnv will croak. NWC
8130                Fall through. */
8131 #if defined(USE_LONG_DOUBLE)
8132             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",
8133                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8134 #else
8135             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8136                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8137 #endif
8138         }
8139     }
8140 #endif /* PERL_PRESERVE_IVUV */
8141     sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0);   /* punt */
8142 }
8143
8144 /* this define is used to eliminate a chunk of duplicated but shared logic
8145  * it has the suffix __SV_C to signal that it isnt API, and isnt meant to be
8146  * used anywhere but here - yves
8147  */
8148 #define PUSH_EXTEND_MORTAL__SV_C(AnSv) \
8149     STMT_START {      \
8150         EXTEND_MORTAL(1); \
8151         PL_tmps_stack[++PL_tmps_ix] = (AnSv); \
8152     } STMT_END
8153
8154 /*
8155 =for apidoc sv_mortalcopy
8156
8157 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
8158 The new SV is marked as mortal. It will be destroyed "soon", either by an
8159 explicit call to FREETMPS, or by an implicit call at places such as
8160 statement boundaries.  See also C<sv_newmortal> and C<sv_2mortal>.
8161
8162 =cut
8163 */
8164
8165 /* Make a string that will exist for the duration of the expression
8166  * evaluation.  Actually, it may have to last longer than that, but
8167  * hopefully we won't free it until it has been assigned to a
8168  * permanent location. */
8169
8170 SV *
8171 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
8172 {
8173     dVAR;
8174     register SV *sv;
8175
8176     new_SV(sv);
8177     sv_setsv(sv,oldstr);
8178     PUSH_EXTEND_MORTAL__SV_C(sv);
8179     SvTEMP_on(sv);
8180     return sv;
8181 }
8182
8183 /*
8184 =for apidoc sv_newmortal
8185
8186 Creates a new null SV which is mortal.  The reference count of the SV is
8187 set to 1. It will be destroyed "soon", either by an explicit call to
8188 FREETMPS, or by an implicit call at places such as statement boundaries.
8189 See also C<sv_mortalcopy> and C<sv_2mortal>.
8190
8191 =cut
8192 */
8193
8194 SV *
8195 Perl_sv_newmortal(pTHX)
8196 {
8197     dVAR;
8198     register SV *sv;
8199
8200     new_SV(sv);
8201     SvFLAGS(sv) = SVs_TEMP;
8202     PUSH_EXTEND_MORTAL__SV_C(sv);
8203     return sv;
8204 }
8205
8206
8207 /*
8208 =for apidoc newSVpvn_flags
8209
8210 Creates a new SV and copies a string into it.  The reference count for the
8211 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
8212 string.  You are responsible for ensuring that the source string is at least
8213 C<len> bytes long.  If the C<s> argument is NULL the new SV will be undefined.
8214 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
8215 If C<SVs_TEMP> is set, then C<sv_2mortal()> is called on the result before
8216 returning. If C<SVf_UTF8> is set, C<s> is considered to be in UTF-8 and the
8217 C<SVf_UTF8> flag will be set on the new SV.
8218 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
8219
8220     #define newSVpvn_utf8(s, len, u)                    \
8221         newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
8222
8223 =cut
8224 */
8225
8226 SV *
8227 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
8228 {
8229     dVAR;
8230     register SV *sv;
8231
8232     /* All the flags we don't support must be zero.
8233        And we're new code so I'm going to assert this from the start.  */
8234     assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
8235     new_SV(sv);
8236     sv_setpvn(sv,s,len);
8237
8238     /* This code used to a sv_2mortal(), however we now unroll the call to sv_2mortal()
8239      * and do what it does ourselves here.
8240      * Since we have asserted that flags can only have the SVf_UTF8 and/or SVs_TEMP flags
8241      * set above we can use it to enable the sv flags directly (bypassing SvTEMP_on), which
8242      * in turn means we dont need to mask out the SVf_UTF8 flag below, which means that we
8243      * eliminate quite a few steps than it looks - Yves (explaining patch by gfx)
8244      */
8245
8246     SvFLAGS(sv) |= flags;
8247
8248     if(flags & SVs_TEMP){
8249         PUSH_EXTEND_MORTAL__SV_C(sv);
8250     }
8251
8252     return sv;
8253 }
8254
8255 /*
8256 =for apidoc sv_2mortal
8257
8258 Marks an existing SV as mortal.  The SV will be destroyed "soon", either
8259 by an explicit call to FREETMPS, or by an implicit call at places such as
8260 statement boundaries.  SvTEMP() is turned on which means that the SV's
8261 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
8262 and C<sv_mortalcopy>.
8263
8264 =cut
8265 */
8266
8267 SV *
8268 Perl_sv_2mortal(pTHX_ register SV *const sv)
8269 {
8270     dVAR;
8271     if (!sv)
8272         return NULL;
8273     if (SvREADONLY(sv) && SvIMMORTAL(sv))
8274         return sv;
8275     PUSH_EXTEND_MORTAL__SV_C(sv);
8276     SvTEMP_on(sv);
8277     return sv;
8278 }
8279
8280 /*
8281 =for apidoc newSVpv
8282
8283 Creates a new SV and copies a string into it.  The reference count for the
8284 SV is set to 1.  If C<len> is zero, Perl will compute the length using
8285 strlen().  For efficiency, consider using C<newSVpvn> instead.
8286
8287 =cut
8288 */
8289
8290 SV *
8291 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
8292 {
8293     dVAR;
8294     register SV *sv;
8295
8296     new_SV(sv);
8297     sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
8298     return sv;
8299 }
8300
8301 /*
8302 =for apidoc newSVpvn
8303
8304 Creates a new SV and copies a string into it.  The reference count for the
8305 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
8306 string.  You are responsible for ensuring that the source string is at least
8307 C<len> bytes long.  If the C<s> argument is NULL the new SV will be undefined.
8308
8309 =cut
8310 */
8311
8312 SV *
8313 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
8314 {
8315     dVAR;
8316     register SV *sv;
8317
8318     new_SV(sv);
8319     sv_setpvn(sv,s,len);
8320     return sv;
8321 }
8322
8323 /*
8324 =for apidoc newSVhek
8325
8326 Creates a new SV from the hash key structure.  It will generate scalars that
8327 point to the shared string table where possible. Returns a new (undefined)
8328 SV if the hek is NULL.
8329
8330 =cut
8331 */
8332
8333 SV *
8334 Perl_newSVhek(pTHX_ const HEK *const hek)
8335 {
8336     dVAR;
8337     if (!hek) {
8338         SV *sv;
8339
8340         new_SV(sv);
8341         return sv;
8342     }
8343
8344     if (HEK_LEN(hek) == HEf_SVKEY) {
8345         return newSVsv(*(SV**)HEK_KEY(hek));
8346     } else {
8347         const int flags = HEK_FLAGS(hek);
8348         if (flags & HVhek_WASUTF8) {
8349             /* Trouble :-)
8350                Andreas would like keys he put in as utf8 to come back as utf8
8351             */
8352             STRLEN utf8_len = HEK_LEN(hek);
8353             SV * const sv = newSV_type(SVt_PV);
8354             char *as_utf8 = (char *)bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
8355             /* bytes_to_utf8() allocates a new string, which we can repurpose: */
8356             sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
8357             SvUTF8_on (sv);
8358             return sv;
8359         } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
8360             /* We don't have a pointer to the hv, so we have to replicate the
8361                flag into every HEK. This hv is using custom a hasing
8362                algorithm. Hence we can't return a shared string scalar, as
8363                that would contain the (wrong) hash value, and might get passed
8364                into an hv routine with a regular hash.
8365                Similarly, a hash that isn't using shared hash keys has to have
8366                the flag in every key so that we know not to try to call
8367                share_hek_kek on it.  */
8368
8369             SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
8370             if (HEK_UTF8(hek))
8371                 SvUTF8_on (sv);
8372             return sv;
8373         }
8374         /* This will be overwhelminly the most common case.  */
8375         {
8376             /* Inline most of newSVpvn_share(), because share_hek_hek() is far
8377                more efficient than sharepvn().  */
8378             SV *sv;
8379
8380             new_SV(sv);
8381             sv_upgrade(sv, SVt_PV);
8382             SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
8383             SvCUR_set(sv, HEK_LEN(hek));
8384             SvLEN_set(sv, 0);
8385             SvREADONLY_on(sv);
8386             SvFAKE_on(sv);
8387             SvPOK_on(sv);
8388             if (HEK_UTF8(hek))
8389                 SvUTF8_on(sv);
8390             return sv;
8391         }
8392     }
8393 }
8394
8395 /*
8396 =for apidoc newSVpvn_share
8397
8398 Creates a new SV with its SvPVX_const pointing to a shared string in the string
8399 table. If the string does not already exist in the table, it is created
8400 first.  Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
8401 value is used; otherwise the hash is computed. The string's hash can be later
8402 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
8403 that as the string table is used for shared hash keys these strings will have
8404 SvPVX_const == HeKEY and hash lookup will avoid string compare.
8405
8406 =cut
8407 */
8408
8409 SV *
8410 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
8411 {
8412     dVAR;
8413     register SV *sv;
8414     bool is_utf8 = FALSE;
8415     const char *const orig_src = src;
8416
8417     if (len < 0) {
8418         STRLEN tmplen = -len;
8419         is_utf8 = TRUE;
8420         /* See the note in hv.c:hv_fetch() --jhi */
8421         src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
8422         len = tmplen;
8423     }
8424     if (!hash)
8425         PERL_HASH(hash, src, len);
8426     new_SV(sv);
8427     /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
8428        changes here, update it there too.  */
8429     sv_upgrade(sv, SVt_PV);
8430     SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
8431     SvCUR_set(sv, len);
8432     SvLEN_set(sv, 0);
8433     SvREADONLY_on(sv);
8434     SvFAKE_on(sv);
8435     SvPOK_on(sv);
8436     if (is_utf8)
8437         SvUTF8_on(sv);
8438     if (src != orig_src)
8439         Safefree(src);
8440     return sv;
8441 }
8442
8443 /*
8444 =for apidoc newSVpv_share
8445
8446 Like C<newSVpvn_share>, but takes a nul-terminated string instead of a
8447 string/length pair.
8448
8449 =cut
8450 */
8451
8452 SV *
8453 Perl_newSVpv_share(pTHX_ const char *src, U32 hash)
8454 {
8455     return newSVpvn_share(src, strlen(src), hash);
8456 }
8457
8458 #if defined(PERL_IMPLICIT_CONTEXT)
8459
8460 /* pTHX_ magic can't cope with varargs, so this is a no-context
8461  * version of the main function, (which may itself be aliased to us).
8462  * Don't access this version directly.
8463  */
8464
8465 SV *
8466 Perl_newSVpvf_nocontext(const char *const pat, ...)
8467 {
8468     dTHX;
8469     register SV *sv;
8470     va_list args;
8471
8472     PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
8473
8474     va_start(args, pat);
8475     sv = vnewSVpvf(pat, &args);
8476     va_end(args);
8477     return sv;
8478 }
8479 #endif
8480
8481 /*
8482 =for apidoc newSVpvf
8483
8484 Creates a new SV and initializes it with the string formatted like
8485 C<sprintf>.
8486
8487 =cut
8488 */
8489
8490 SV *
8491 Perl_newSVpvf(pTHX_ const char *const pat, ...)
8492 {
8493     register SV *sv;
8494     va_list args;
8495
8496     PERL_ARGS_ASSERT_NEWSVPVF;
8497
8498     va_start(args, pat);
8499     sv = vnewSVpvf(pat, &args);
8500     va_end(args);
8501     return sv;
8502 }
8503
8504 /* backend for newSVpvf() and newSVpvf_nocontext() */
8505
8506 SV *
8507 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
8508 {
8509     dVAR;
8510     register SV *sv;
8511
8512     PERL_ARGS_ASSERT_VNEWSVPVF;
8513
8514     new_SV(sv);
8515     sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8516     return sv;
8517 }
8518
8519 /*
8520 =for apidoc newSVnv
8521
8522 Creates a new SV and copies a floating point value into it.
8523 The reference count for the SV is set to 1.
8524
8525 =cut
8526 */
8527
8528 SV *
8529 Perl_newSVnv(pTHX_ const NV n)
8530 {
8531     dVAR;
8532     register SV *sv;
8533
8534     new_SV(sv);
8535     sv_setnv(sv,n);
8536     return sv;
8537 }
8538
8539 /*
8540 =for apidoc newSViv
8541
8542 Creates a new SV and copies an integer into it.  The reference count for the
8543 SV is set to 1.
8544
8545 =cut
8546 */
8547
8548 SV *
8549 Perl_newSViv(pTHX_ const IV i)
8550 {
8551     dVAR;
8552     register SV *sv;
8553
8554     new_SV(sv);
8555     sv_setiv(sv,i);
8556     return sv;
8557 }
8558
8559 /*
8560 =for apidoc newSVuv
8561
8562 Creates a new SV and copies an unsigned integer into it.
8563 The reference count for the SV is set to 1.
8564
8565 =cut
8566 */
8567
8568 SV *
8569 Perl_newSVuv(pTHX_ const UV u)
8570 {
8571     dVAR;
8572     register SV *sv;
8573
8574     new_SV(sv);
8575     sv_setuv(sv,u);
8576     return sv;
8577 }
8578
8579 /*
8580 =for apidoc newSV_type
8581
8582 Creates a new SV, of the type specified.  The reference count for the new SV
8583 is set to 1.
8584
8585 =cut
8586 */
8587
8588 SV *
8589 Perl_newSV_type(pTHX_ const svtype type)
8590 {
8591     register SV *sv;
8592
8593     new_SV(sv);
8594     sv_upgrade(sv, type);
8595     return sv;
8596 }
8597
8598 /*
8599 =for apidoc newRV_noinc
8600
8601 Creates an RV wrapper for an SV.  The reference count for the original
8602 SV is B<not> incremented.
8603
8604 =cut
8605 */
8606
8607 SV *
8608 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
8609 {
8610     dVAR;
8611     register SV *sv = newSV_type(SVt_IV);
8612
8613     PERL_ARGS_ASSERT_NEWRV_NOINC;
8614
8615     SvTEMP_off(tmpRef);
8616     SvRV_set(sv, tmpRef);
8617     SvROK_on(sv);
8618     return sv;
8619 }
8620
8621 /* newRV_inc is the official function name to use now.
8622  * newRV_inc is in fact #defined to newRV in sv.h
8623  */
8624
8625 SV *
8626 Perl_newRV(pTHX_ SV *const sv)
8627 {
8628     dVAR;
8629
8630     PERL_ARGS_ASSERT_NEWRV;
8631
8632     return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
8633 }
8634
8635 /*
8636 =for apidoc newSVsv
8637
8638 Creates a new SV which is an exact duplicate of the original SV.
8639 (Uses C<sv_setsv>).
8640
8641 =cut
8642 */
8643
8644 SV *
8645 Perl_newSVsv(pTHX_ register SV *const old)
8646 {
8647     dVAR;
8648     register SV *sv;
8649
8650     if (!old)
8651         return NULL;
8652     if (SvTYPE(old) == SVTYPEMASK) {
8653         Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
8654         return NULL;
8655     }
8656     new_SV(sv);
8657     /* SV_GMAGIC is the default for sv_setv()
8658        SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
8659        with SvTEMP_off and SvTEMP_on round a call to sv_setsv.  */
8660     sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
8661     return sv;
8662 }
8663
8664 /*
8665 =for apidoc sv_reset
8666
8667 Underlying implementation for the C<reset> Perl function.
8668 Note that the perl-level function is vaguely deprecated.
8669
8670 =cut
8671 */
8672
8673 void
8674 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
8675 {
8676     dVAR;
8677     char todo[PERL_UCHAR_MAX+1];
8678
8679     PERL_ARGS_ASSERT_SV_RESET;
8680
8681     if (!stash)
8682         return;
8683
8684     if (!*s) {          /* reset ?? searches */
8685         MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
8686         if (mg) {
8687             const U32 count = mg->mg_len / sizeof(PMOP**);
8688             PMOP **pmp = (PMOP**) mg->mg_ptr;
8689             PMOP *const *const end = pmp + count;
8690
8691             while (pmp < end) {
8692 #ifdef USE_ITHREADS
8693                 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
8694 #else
8695                 (*pmp)->op_pmflags &= ~PMf_USED;
8696 #endif
8697                 ++pmp;
8698             }
8699         }
8700         return;
8701     }
8702
8703     /* reset variables */
8704
8705     if (!HvARRAY(stash))
8706         return;
8707
8708     Zero(todo, 256, char);
8709     while (*s) {
8710         I32 max;
8711         I32 i = (unsigned char)*s;
8712         if (s[1] == '-') {
8713             s += 2;
8714         }
8715         max = (unsigned char)*s++;
8716         for ( ; i <= max; i++) {
8717             todo[i] = 1;
8718         }
8719         for (i = 0; i <= (I32) HvMAX(stash); i++) {
8720             HE *entry;
8721             for (entry = HvARRAY(stash)[i];
8722                  entry;
8723                  entry = HeNEXT(entry))
8724             {
8725                 register GV *gv;
8726                 register SV *sv;
8727
8728                 if (!todo[(U8)*HeKEY(entry)])
8729                     continue;
8730                 gv = MUTABLE_GV(HeVAL(entry));
8731                 sv = GvSV(gv);
8732                 if (sv) {
8733                     if (SvTHINKFIRST(sv)) {
8734                         if (!SvREADONLY(sv) && SvROK(sv))
8735                             sv_unref(sv);
8736                         /* XXX Is this continue a bug? Why should THINKFIRST
8737                            exempt us from resetting arrays and hashes?  */
8738                         continue;
8739                     }
8740                     SvOK_off(sv);
8741                     if (SvTYPE(sv) >= SVt_PV) {
8742                         SvCUR_set(sv, 0);
8743                         if (SvPVX_const(sv) != NULL)
8744                             *SvPVX(sv) = '\0';
8745                         SvTAINT(sv);
8746                     }
8747                 }
8748                 if (GvAV(gv)) {
8749                     av_clear(GvAV(gv));
8750                 }
8751                 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
8752 #if defined(VMS)
8753                     Perl_die(aTHX_ "Can't reset %%ENV on this system");
8754 #else /* ! VMS */
8755                     hv_clear(GvHV(gv));
8756 #  if defined(USE_ENVIRON_ARRAY)
8757                     if (gv == PL_envgv)
8758                         my_clearenv();
8759 #  endif /* USE_ENVIRON_ARRAY */
8760 #endif /* VMS */
8761                 }
8762             }
8763         }
8764     }
8765 }
8766
8767 /*
8768 =for apidoc sv_2io
8769
8770 Using various gambits, try to get an IO from an SV: the IO slot if its a
8771 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8772 named after the PV if we're a string.
8773
8774 =cut
8775 */
8776
8777 IO*
8778 Perl_sv_2io(pTHX_ SV *const sv)
8779 {
8780     IO* io;
8781     GV* gv;
8782
8783     PERL_ARGS_ASSERT_SV_2IO;
8784
8785     switch (SvTYPE(sv)) {
8786     case SVt_PVIO:
8787         io = MUTABLE_IO(sv);
8788         break;
8789     case SVt_PVGV:
8790     case SVt_PVLV:
8791         if (isGV_with_GP(sv)) {
8792             gv = MUTABLE_GV(sv);
8793             io = GvIO(gv);
8794             if (!io)
8795                 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
8796             break;
8797         }
8798         /* FALL THROUGH */
8799     default:
8800         if (!SvOK(sv))
8801             Perl_croak(aTHX_ PL_no_usym, "filehandle");
8802         if (SvROK(sv))
8803             return sv_2io(SvRV(sv));
8804         gv = gv_fetchsv(sv, 0, SVt_PVIO);
8805         if (gv)
8806             io = GvIO(gv);
8807         else
8808             io = 0;
8809         if (!io)
8810             Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
8811         break;
8812     }
8813     return io;
8814 }
8815
8816 /*
8817 =for apidoc sv_2cv
8818
8819 Using various gambits, try to get a CV from an SV; in addition, try if
8820 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8821 The flags in C<lref> are passed to gv_fetchsv.
8822
8823 =cut
8824 */
8825
8826 CV *
8827 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
8828 {
8829     dVAR;
8830     GV *gv = NULL;
8831     CV *cv = NULL;
8832
8833     PERL_ARGS_ASSERT_SV_2CV;
8834
8835     if (!sv) {
8836         *st = NULL;
8837         *gvp = NULL;
8838         return NULL;
8839     }
8840     switch (SvTYPE(sv)) {
8841     case SVt_PVCV:
8842         *st = CvSTASH(sv);
8843         *gvp = NULL;
8844         return MUTABLE_CV(sv);
8845     case SVt_PVHV:
8846     case SVt_PVAV:
8847         *st = NULL;
8848         *gvp = NULL;
8849         return NULL;
8850     case SVt_PVGV:
8851         if (isGV_with_GP(sv)) {
8852             gv = MUTABLE_GV(sv);
8853             *gvp = gv;
8854             *st = GvESTASH(gv);
8855             goto fix_gv;
8856         }
8857         /* FALL THROUGH */
8858
8859     default:
8860         if (SvROK(sv)) {
8861             SvGETMAGIC(sv);
8862             if (SvAMAGIC(sv))
8863                 sv = amagic_deref_call(sv, to_cv_amg);
8864             /* At this point I'd like to do SPAGAIN, but really I need to
8865                force it upon my callers. Hmmm. This is a mess... */
8866
8867             sv = SvRV(sv);
8868             if (SvTYPE(sv) == SVt_PVCV) {
8869                 cv = MUTABLE_CV(sv);
8870                 *gvp = NULL;
8871                 *st = CvSTASH(cv);
8872                 return cv;
8873             }
8874             else if(isGV_with_GP(sv))
8875                 gv = MUTABLE_GV(sv);
8876             else
8877                 Perl_croak(aTHX_ "Not a subroutine reference");
8878         }
8879         else if (isGV_with_GP(sv)) {
8880             SvGETMAGIC(sv);
8881             gv = MUTABLE_GV(sv);
8882         }
8883         else
8884             gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
8885         *gvp = gv;
8886         if (!gv) {
8887             *st = NULL;
8888             return NULL;
8889         }
8890         /* Some flags to gv_fetchsv mean don't really create the GV  */
8891         if (!isGV_with_GP(gv)) {
8892             *st = NULL;
8893             return NULL;
8894         }
8895         *st = GvESTASH(gv);
8896     fix_gv:
8897         if (lref && !GvCVu(gv)) {
8898             SV *tmpsv;
8899             ENTER;
8900             tmpsv = newSV(0);
8901             gv_efullname3(tmpsv, gv, NULL);
8902             /* XXX this is probably not what they think they're getting.
8903              * It has the same effect as "sub name;", i.e. just a forward
8904              * declaration! */
8905             newSUB(start_subparse(FALSE, 0),
8906                    newSVOP(OP_CONST, 0, tmpsv),
8907                    NULL, NULL);
8908             LEAVE;
8909             if (!GvCVu(gv))
8910                 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8911                            SVfARG(SvOK(sv) ? sv : &PL_sv_no));
8912         }
8913         return GvCVu(gv);
8914     }
8915 }
8916
8917 /*
8918 =for apidoc sv_true
8919
8920 Returns true if the SV has a true value by Perl's rules.
8921 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8922 instead use an in-line version.
8923
8924 =cut
8925 */
8926
8927 I32
8928 Perl_sv_true(pTHX_ register SV *const sv)
8929 {
8930     if (!sv)
8931         return 0;
8932     if (SvPOK(sv)) {
8933         register const XPV* const tXpv = (XPV*)SvANY(sv);
8934         if (tXpv &&
8935                 (tXpv->xpv_cur > 1 ||
8936                 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8937             return 1;
8938         else
8939             return 0;
8940     }
8941     else {
8942         if (SvIOK(sv))
8943             return SvIVX(sv) != 0;
8944         else {
8945             if (SvNOK(sv))
8946                 return SvNVX(sv) != 0.0;
8947             else
8948                 return sv_2bool(sv);
8949         }
8950     }
8951 }
8952
8953 /*
8954 =for apidoc sv_pvn_force
8955
8956 Get a sensible string out of the SV somehow.
8957 A private implementation of the C<SvPV_force> macro for compilers which
8958 can't cope with complex macro expressions. Always use the macro instead.
8959
8960 =for apidoc sv_pvn_force_flags
8961
8962 Get a sensible string out of the SV somehow.
8963 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8964 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8965 implemented in terms of this function.
8966 You normally want to use the various wrapper macros instead: see
8967 C<SvPV_force> and C<SvPV_force_nomg>
8968
8969 =cut
8970 */
8971
8972 char *
8973 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
8974 {
8975     dVAR;
8976
8977     PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
8978
8979     if (SvTHINKFIRST(sv) && !SvROK(sv))
8980         sv_force_normal_flags(sv, 0);
8981
8982     if (SvPOK(sv)) {
8983         if (lp)
8984             *lp = SvCUR(sv);
8985     }
8986     else {
8987         char *s;
8988         STRLEN len;
8989
8990         if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8991             const char * const ref = sv_reftype(sv,0);
8992             if (PL_op)
8993                 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8994                            ref, OP_DESC(PL_op));
8995             else
8996                 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8997         }
8998         if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8999             || isGV_with_GP(sv))
9000             /* diag_listed_as: Can't coerce %s to %s in %s */
9001             Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
9002                 OP_DESC(PL_op));
9003         s = sv_2pv_flags(sv, &len, flags);
9004         if (lp)
9005             *lp = len;
9006
9007         if (s != SvPVX_const(sv)) {     /* Almost, but not quite, sv_setpvn() */
9008             if (SvROK(sv))
9009                 sv_unref(sv);
9010             SvUPGRADE(sv, SVt_PV);              /* Never FALSE */
9011             SvGROW(sv, len + 1);
9012             Move(s,SvPVX(sv),len,char);
9013             SvCUR_set(sv, len);
9014             SvPVX(sv)[len] = '\0';
9015         }
9016         if (!SvPOK(sv)) {
9017             SvPOK_on(sv);               /* validate pointer */
9018             SvTAINT(sv);
9019             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
9020                                   PTR2UV(sv),SvPVX_const(sv)));
9021         }
9022     }
9023     return SvPVX_mutable(sv);
9024 }
9025
9026 /*
9027 =for apidoc sv_pvbyten_force
9028
9029 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
9030
9031 =cut
9032 */
9033
9034 char *
9035 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
9036 {
9037     PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
9038
9039     sv_pvn_force(sv,lp);
9040     sv_utf8_downgrade(sv,0);
9041     *lp = SvCUR(sv);
9042     return SvPVX(sv);
9043 }
9044
9045 /*
9046 =for apidoc sv_pvutf8n_force
9047
9048 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
9049
9050 =cut
9051 */
9052
9053 char *
9054 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
9055 {
9056     PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
9057
9058     sv_pvn_force(sv,lp);
9059     sv_utf8_upgrade(sv);
9060     *lp = SvCUR(sv);
9061     return SvPVX(sv);
9062 }
9063
9064 /*
9065 =for apidoc sv_reftype
9066
9067 Returns a string describing what the SV is a reference to.
9068
9069 =cut
9070 */
9071
9072 const char *
9073 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
9074 {
9075     PERL_ARGS_ASSERT_SV_REFTYPE;
9076
9077     /* The fact that I don't need to downcast to char * everywhere, only in ?:
9078        inside return suggests a const propagation bug in g++.  */
9079     if (ob && SvOBJECT(sv)) {
9080         char * const name = HvNAME_get(SvSTASH(sv));
9081         return name ? name : (char *) "__ANON__";
9082     }
9083     else {
9084         switch (SvTYPE(sv)) {
9085         case SVt_NULL:
9086         case SVt_IV:
9087         case SVt_NV:
9088         case SVt_PV:
9089         case SVt_PVIV:
9090         case SVt_PVNV:
9091         case SVt_PVMG:
9092                                 if (SvVOK(sv))
9093                                     return "VSTRING";
9094                                 if (SvROK(sv))
9095                                     return "REF";
9096                                 else
9097                                     return "SCALAR";
9098
9099         case SVt_PVLV:          return (char *)  (SvROK(sv) ? "REF"
9100                                 /* tied lvalues should appear to be
9101                                  * scalars for backwards compatibility */
9102                                 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
9103                                     ? "SCALAR" : "LVALUE");
9104         case SVt_PVAV:          return "ARRAY";
9105         case SVt_PVHV:          return "HASH";
9106         case SVt_PVCV:          return "CODE";
9107         case SVt_PVGV:          return (char *) (isGV_with_GP(sv)
9108                                     ? "GLOB" : "SCALAR");
9109         case SVt_PVFM:          return "FORMAT";
9110         case SVt_PVIO:          return "IO";
9111         case SVt_BIND:          return "BIND";
9112         case SVt_REGEXP:        return "REGEXP";
9113         default:                return "UNKNOWN";
9114         }
9115     }
9116 }
9117
9118 /*
9119 =for apidoc sv_isobject
9120
9121 Returns a boolean indicating whether the SV is an RV pointing to a blessed
9122 object.  If the SV is not an RV, or if the object is not blessed, then this
9123 will return false.
9124
9125 =cut
9126 */
9127
9128 int
9129 Perl_sv_isobject(pTHX_ SV *sv)
9130 {
9131     if (!sv)
9132         return 0;
9133     SvGETMAGIC(sv);
9134     if (!SvROK(sv))
9135         return 0;
9136     sv = SvRV(sv);
9137     if (!SvOBJECT(sv))
9138         return 0;
9139     return 1;
9140 }
9141
9142 /*
9143 =for apidoc sv_isa
9144
9145 Returns a boolean indicating whether the SV is blessed into the specified
9146 class.  This does not check for subtypes; use C<sv_derived_from> to verify
9147 an inheritance relationship.
9148
9149 =cut
9150 */
9151
9152 int
9153 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
9154 {
9155     const char *hvname;
9156
9157     PERL_ARGS_ASSERT_SV_ISA;
9158
9159     if (!sv)
9160         return 0;
9161     SvGETMAGIC(sv);
9162     if (!SvROK(sv))
9163         return 0;
9164     sv = SvRV(sv);
9165     if (!SvOBJECT(sv))
9166         return 0;
9167     hvname = HvNAME_get(SvSTASH(sv));
9168     if (!hvname)
9169         return 0;
9170
9171     return strEQ(hvname, name);
9172 }
9173
9174 /*
9175 =for apidoc newSVrv
9176
9177 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
9178 it will be upgraded to one.  If C<classname> is non-null then the new SV will
9179 be blessed in the specified package.  The new SV is returned and its
9180 reference count is 1.
9181
9182 =cut
9183 */
9184
9185 SV*
9186 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
9187 {
9188     dVAR;
9189     SV *sv;
9190
9191     PERL_ARGS_ASSERT_NEWSVRV;
9192
9193     new_SV(sv);
9194
9195     SV_CHECK_THINKFIRST_COW_DROP(rv);
9196     (void)SvAMAGIC_off(rv);
9197
9198     if (SvTYPE(rv) >= SVt_PVMG) {
9199         const U32 refcnt = SvREFCNT(rv);
9200         SvREFCNT(rv) = 0;
9201         sv_clear(rv);
9202         SvFLAGS(rv) = 0;
9203         SvREFCNT(rv) = refcnt;
9204
9205         sv_upgrade(rv, SVt_IV);
9206     } else if (SvROK(rv)) {
9207         SvREFCNT_dec(SvRV(rv));
9208     } else {
9209         prepare_SV_for_RV(rv);
9210     }
9211
9212     SvOK_off(rv);
9213     SvRV_set(rv, sv);
9214     SvROK_on(rv);
9215
9216     if (classname) {
9217         HV* const stash = gv_stashpv(classname, GV_ADD);
9218         (void)sv_bless(rv, stash);
9219     }
9220     return sv;
9221 }
9222
9223 /*
9224 =for apidoc sv_setref_pv
9225
9226 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
9227 argument will be upgraded to an RV.  That RV will be modified to point to
9228 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
9229 into the SV.  The C<classname> argument indicates the package for the
9230 blessing.  Set C<classname> to C<NULL> to avoid the blessing.  The new SV
9231 will have a reference count of 1, and the RV will be returned.
9232
9233 Do not use with other Perl types such as HV, AV, SV, CV, because those
9234 objects will become corrupted by the pointer copy process.
9235
9236 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
9237
9238 =cut
9239 */
9240
9241 SV*
9242 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
9243 {
9244     dVAR;
9245
9246     PERL_ARGS_ASSERT_SV_SETREF_PV;
9247
9248     if (!pv) {
9249         sv_setsv(rv, &PL_sv_undef);
9250         SvSETMAGIC(rv);
9251     }
9252     else
9253         sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
9254     return rv;
9255 }
9256
9257 /*
9258 =for apidoc sv_setref_iv
9259
9260 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
9261 argument will be upgraded to an RV.  That RV will be modified to point to
9262 the new SV.  The C<classname> argument indicates the package for the
9263 blessing.  Set C<classname> to C<NULL> to avoid the blessing.  The new SV
9264 will have a reference count of 1, and the RV will be returned.
9265
9266 =cut
9267 */
9268
9269 SV*
9270 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
9271 {
9272     PERL_ARGS_ASSERT_SV_SETREF_IV;
9273
9274     sv_setiv(newSVrv(rv,classname), iv);
9275     return rv;
9276 }
9277
9278 /*
9279 =for apidoc sv_setref_uv
9280
9281 Copies an unsigned integer into a new SV, optionally blessing the SV.  The C<rv>
9282 argument will be upgraded to an RV.  That RV will be modified to point to
9283 the new SV.  The C<classname> argument indicates the package for the
9284 blessing.  Set C<classname> to C<NULL> to avoid the blessing.  The new SV
9285 will have a reference count of 1, and the RV will be returned.
9286
9287 =cut
9288 */
9289
9290 SV*
9291 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
9292 {
9293     PERL_ARGS_ASSERT_SV_SETREF_UV;
9294
9295     sv_setuv(newSVrv(rv,classname), uv);
9296     return rv;
9297 }
9298
9299 /*
9300 =for apidoc sv_setref_nv
9301
9302 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
9303 argument will be upgraded to an RV.  That RV will be modified to point to
9304 the new SV.  The C<classname> argument indicates the package for the
9305 blessing.  Set C<classname> to C<NULL> to avoid the blessing.  The new SV
9306 will have a reference count of 1, and the RV will be returned.
9307
9308 =cut
9309 */
9310
9311 SV*
9312 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
9313 {
9314     PERL_ARGS_ASSERT_SV_SETREF_NV;
9315
9316     sv_setnv(newSVrv(rv,classname), nv);
9317     return rv;
9318 }
9319
9320 /*
9321 =for apidoc sv_setref_pvn
9322
9323 Copies a string into a new SV, optionally blessing the SV.  The length of the
9324 string must be specified with C<n>.  The C<rv> argument will be upgraded to
9325 an RV.  That RV will be modified to point to the new SV.  The C<classname>
9326 argument indicates the package for the blessing.  Set C<classname> to
9327 C<NULL> to avoid the blessing.  The new SV will have a reference count
9328 of 1, and the RV will be returned.
9329
9330 Note that C<sv_setref_pv> copies the pointer while this copies the string.
9331
9332 =cut
9333 */
9334
9335 SV*
9336 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
9337                    const char *const pv, const STRLEN n)
9338 {
9339     PERL_ARGS_ASSERT_SV_SETREF_PVN;
9340
9341     sv_setpvn(newSVrv(rv,classname), pv, n);
9342     return rv;
9343 }
9344
9345 /*
9346 =for apidoc sv_bless
9347
9348 Blesses an SV into a specified package.  The SV must be an RV.  The package
9349 must be designated by its stash (see C<gv_stashpv()>).  The reference count
9350 of the SV is unaffected.
9351
9352 =cut
9353 */
9354
9355 SV*
9356 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
9357 {
9358     dVAR;
9359     SV *tmpRef;
9360
9361     PERL_ARGS_ASSERT_SV_BLESS;
9362
9363     if (!SvROK(sv))
9364         Perl_croak(aTHX_ "Can't bless non-reference value");
9365     tmpRef = SvRV(sv);
9366     if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
9367         if (SvIsCOW(tmpRef))
9368             sv_force_normal_flags(tmpRef, 0);
9369         if (SvREADONLY(tmpRef))
9370             Perl_croak_no_modify(aTHX);
9371         if (SvOBJECT(tmpRef)) {
9372             if (SvTYPE(tmpRef) != SVt_PVIO)
9373                 --PL_sv_objcount;
9374             SvREFCNT_dec(SvSTASH(tmpRef));
9375         }
9376     }
9377     SvOBJECT_on(tmpRef);
9378     if (SvTYPE(tmpRef) != SVt_PVIO)
9379         ++PL_sv_objcount;
9380     SvUPGRADE(tmpRef, SVt_PVMG);
9381     SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
9382
9383     if (Gv_AMG(stash))
9384         SvAMAGIC_on(sv);
9385     else
9386         (void)SvAMAGIC_off(sv);
9387
9388     if(SvSMAGICAL(tmpRef))
9389         if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
9390             mg_set(tmpRef);
9391
9392
9393
9394     return sv;
9395 }
9396
9397 /* Downgrades a PVGV to a PVMG. If it’s actually a PVLV, we leave the type
9398  * as it is after unglobbing it.
9399  */
9400
9401 STATIC void
9402 S_sv_unglob(pTHX_ SV *const sv)
9403 {
9404     dVAR;
9405     void *xpvmg;
9406     HV *stash;
9407     SV * const temp = sv_newmortal();
9408
9409     PERL_ARGS_ASSERT_SV_UNGLOB;
9410
9411     assert(SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV);
9412     SvFAKE_off(sv);
9413     gv_efullname3(temp, MUTABLE_GV(sv), "*");
9414
9415     if (GvGP(sv)) {
9416         if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
9417            && HvNAME_get(stash))
9418             mro_method_changed_in(stash);
9419         gp_free(MUTABLE_GV(sv));
9420     }
9421     if (GvSTASH(sv)) {
9422         sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
9423         GvSTASH(sv) = NULL;
9424     }
9425     GvMULTI_off(sv);
9426     if (GvNAME_HEK(sv)) {
9427         unshare_hek(GvNAME_HEK(sv));
9428     }
9429     isGV_with_GP_off(sv);
9430
9431     if(SvTYPE(sv) == SVt_PVGV) {
9432         /* need to keep SvANY(sv) in the right arena */
9433         xpvmg = new_XPVMG();
9434         StructCopy(SvANY(sv), xpvmg, XPVMG);
9435         del_XPVGV(SvANY(sv));
9436         SvANY(sv) = xpvmg;
9437
9438         SvFLAGS(sv) &= ~SVTYPEMASK;
9439         SvFLAGS(sv) |= SVt_PVMG;
9440     }
9441
9442     /* Intentionally not calling any local SET magic, as this isn't so much a
9443        set operation as merely an internal storage change.  */
9444     sv_setsv_flags(sv, temp, 0);
9445 }
9446
9447 /*
9448 =for apidoc sv_unref_flags
9449
9450 Unsets the RV status of the SV, and decrements the reference count of
9451 whatever was being referenced by the RV.  This can almost be thought of
9452 as a reversal of C<newSVrv>.  The C<cflags> argument can contain
9453 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
9454 (otherwise the decrementing is conditional on the reference count being
9455 different from one or the reference being a readonly SV).
9456 See C<SvROK_off>.
9457
9458 =cut
9459 */
9460
9461 void
9462 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
9463 {
9464     SV* const target = SvRV(ref);
9465
9466     PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
9467
9468     if (SvWEAKREF(ref)) {
9469         sv_del_backref(target, ref);
9470         SvWEAKREF_off(ref);
9471         SvRV_set(ref, NULL);
9472         return;
9473     }
9474     SvRV_set(ref, NULL);
9475     SvROK_off(ref);
9476     /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
9477        assigned to as BEGIN {$a = \"Foo"} will fail.  */
9478     if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
9479         SvREFCNT_dec(target);
9480     else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
9481         sv_2mortal(target);     /* Schedule for freeing later */
9482 }
9483
9484 /*
9485 =for apidoc sv_untaint
9486
9487 Untaint an SV. Use C<SvTAINTED_off> instead.
9488 =cut
9489 */
9490
9491 void
9492 Perl_sv_untaint(pTHX_ SV *const sv)
9493 {
9494     PERL_ARGS_ASSERT_SV_UNTAINT;
9495
9496     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9497         MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9498         if (mg)
9499             mg->mg_len &= ~1;
9500     }
9501 }
9502
9503 /*
9504 =for apidoc sv_tainted
9505
9506 Test an SV for taintedness. Use C<SvTAINTED> instead.
9507 =cut
9508 */
9509
9510 bool
9511 Perl_sv_tainted(pTHX_ SV *const sv)
9512 {
9513     PERL_ARGS_ASSERT_SV_TAINTED;
9514
9515     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9516         const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9517         if (mg && (mg->mg_len & 1) )
9518             return TRUE;
9519     }
9520     return FALSE;
9521 }
9522
9523 /*
9524 =for apidoc sv_setpviv
9525
9526 Copies an integer into the given SV, also updating its string value.
9527 Does not handle 'set' magic.  See C<sv_setpviv_mg>.
9528
9529 =cut
9530 */
9531
9532 void
9533 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
9534 {
9535     char buf[TYPE_CHARS(UV)];
9536     char *ebuf;
9537     char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
9538
9539     PERL_ARGS_ASSERT_SV_SETPVIV;
9540
9541     sv_setpvn(sv, ptr, ebuf - ptr);
9542 }
9543
9544 /*
9545 =for apidoc sv_setpviv_mg
9546
9547 Like C<sv_setpviv>, but also handles 'set' magic.
9548
9549 =cut
9550 */
9551
9552 void
9553 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
9554 {
9555     PERL_ARGS_ASSERT_SV_SETPVIV_MG;
9556
9557     sv_setpviv(sv, iv);
9558     SvSETMAGIC(sv);
9559 }
9560
9561 #if defined(PERL_IMPLICIT_CONTEXT)
9562
9563 /* pTHX_ magic can't cope with varargs, so this is a no-context
9564  * version of the main function, (which may itself be aliased to us).
9565  * Don't access this version directly.
9566  */
9567
9568 void
9569 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
9570 {
9571     dTHX;
9572     va_list args;
9573
9574     PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
9575
9576     va_start(args, pat);
9577     sv_vsetpvf(sv, pat, &args);
9578     va_end(args);
9579 }
9580
9581 /* pTHX_ magic can't cope with varargs, so this is a no-context
9582  * version of the main function, (which may itself be aliased to us).
9583  * Don't access this version directly.
9584  */
9585
9586 void
9587 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9588 {
9589     dTHX;
9590     va_list args;
9591
9592     PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
9593
9594     va_start(args, pat);
9595     sv_vsetpvf_mg(sv, pat, &args);
9596     va_end(args);
9597 }
9598 #endif
9599
9600 /*
9601 =for apidoc sv_setpvf
9602
9603 Works like C<sv_catpvf> but copies the text into the SV instead of
9604 appending it.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
9605
9606 =cut
9607 */
9608
9609 void
9610 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
9611 {
9612     va_list args;
9613
9614     PERL_ARGS_ASSERT_SV_SETPVF;
9615
9616     va_start(args, pat);
9617     sv_vsetpvf(sv, pat, &args);
9618     va_end(args);
9619 }
9620
9621 /*
9622 =for apidoc sv_vsetpvf
9623
9624 Works like C<sv_vcatpvf> but copies the text into the SV instead of
9625 appending it.  Does not handle 'set' magic.  See C<sv_vsetpvf_mg>.
9626
9627 Usually used via its frontend C<sv_setpvf>.
9628
9629 =cut
9630 */
9631
9632 void
9633 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9634 {
9635     PERL_ARGS_ASSERT_SV_VSETPVF;
9636
9637     sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9638 }
9639
9640 /*
9641 =for apidoc sv_setpvf_mg
9642
9643 Like C<sv_setpvf>, but also handles 'set' magic.
9644
9645 =cut
9646 */
9647
9648 void
9649 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9650 {
9651     va_list args;
9652
9653     PERL_ARGS_ASSERT_SV_SETPVF_MG;
9654
9655     va_start(args, pat);
9656     sv_vsetpvf_mg(sv, pat, &args);
9657     va_end(args);
9658 }
9659
9660 /*
9661 =for apidoc sv_vsetpvf_mg
9662
9663 Like C<sv_vsetpvf>, but also handles 'set' magic.
9664
9665 Usually used via its frontend C<sv_setpvf_mg>.
9666
9667 =cut
9668 */
9669
9670 void
9671 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9672 {
9673     PERL_ARGS_ASSERT_SV_VSETPVF_MG;
9674
9675     sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9676     SvSETMAGIC(sv);
9677 }
9678
9679 #if defined(PERL_IMPLICIT_CONTEXT)
9680
9681 /* pTHX_ magic can't cope with varargs, so this is a no-context
9682  * version of the main function, (which may itself be aliased to us).
9683  * Don't access this version directly.
9684  */
9685
9686 void
9687 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
9688 {
9689     dTHX;
9690     va_list args;
9691
9692     PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
9693
9694     va_start(args, pat);
9695     sv_vcatpvf(sv, pat, &args);
9696     va_end(args);
9697 }
9698
9699 /* pTHX_ magic can't cope with varargs, so this is a no-context
9700  * version of the main function, (which may itself be aliased to us).
9701  * Don't access this version directly.
9702  */
9703
9704 void
9705 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9706 {
9707     dTHX;
9708     va_list args;
9709
9710     PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
9711
9712     va_start(args, pat);
9713     sv_vcatpvf_mg(sv, pat, &args);
9714     va_end(args);
9715 }
9716 #endif
9717
9718 /*
9719 =for apidoc sv_catpvf
9720
9721 Processes its arguments like C<sprintf> and appends the formatted
9722 output to an SV.  If the appended data contains "wide" characters
9723 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9724 and characters >255 formatted with %c), the original SV might get
9725 upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.  See
9726 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9727 valid UTF-8; if the original SV was bytes, the pattern should be too.
9728
9729 =cut */
9730
9731 void
9732 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
9733 {
9734     va_list args;
9735
9736     PERL_ARGS_ASSERT_SV_CATPVF;
9737
9738     va_start(args, pat);
9739     sv_vcatpvf(sv, pat, &args);
9740     va_end(args);
9741 }
9742
9743 /*
9744 =for apidoc sv_vcatpvf
9745
9746 Processes its arguments like C<vsprintf> and appends the formatted output
9747 to an SV.  Does not handle 'set' magic.  See C<sv_vcatpvf_mg>.
9748
9749 Usually used via its frontend C<sv_catpvf>.
9750
9751 =cut
9752 */
9753
9754 void
9755 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9756 {
9757     PERL_ARGS_ASSERT_SV_VCATPVF;
9758
9759     sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9760 }
9761
9762 /*
9763 =for apidoc sv_catpvf_mg
9764
9765 Like C<sv_catpvf>, but also handles 'set' magic.
9766
9767 =cut
9768 */
9769
9770 void
9771 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9772 {
9773     va_list args;
9774
9775     PERL_ARGS_ASSERT_SV_CATPVF_MG;
9776
9777     va_start(args, pat);
9778     sv_vcatpvf_mg(sv, pat, &args);
9779     va_end(args);
9780 }
9781
9782 /*
9783 =for apidoc sv_vcatpvf_mg
9784
9785 Like C<sv_vcatpvf>, but also handles 'set' magic.
9786
9787 Usually used via its frontend C<sv_catpvf_mg>.
9788
9789 =cut
9790 */
9791
9792 void
9793 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9794 {
9795     PERL_ARGS_ASSERT_SV_VCATPVF_MG;
9796
9797     sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9798     SvSETMAGIC(sv);
9799 }
9800
9801 /*
9802 =for apidoc sv_vsetpvfn
9803
9804 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9805 appending it.
9806
9807 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9808
9809 =cut
9810 */
9811
9812 void
9813 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9814                  va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9815 {
9816     PERL_ARGS_ASSERT_SV_VSETPVFN;
9817
9818     sv_setpvs(sv, "");
9819     sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9820 }
9821
9822
9823 /*
9824  * Warn of missing argument to sprintf, and then return a defined value
9825  * to avoid inappropriate "use of uninit" warnings [perl #71000].
9826  */
9827 #define WARN_MISSING WARN_UNINITIALIZED /* Not sure we want a new category */
9828 STATIC SV*
9829 S_vcatpvfn_missing_argument(pTHX) {
9830     if (ckWARN(WARN_MISSING)) {
9831         Perl_warner(aTHX_ packWARN(WARN_MISSING), "Missing argument in %s",
9832                 PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn()");
9833     }
9834     return &PL_sv_no;
9835 }
9836
9837
9838 STATIC I32
9839 S_expect_number(pTHX_ char **const pattern)
9840 {
9841     dVAR;
9842     I32 var = 0;
9843
9844     PERL_ARGS_ASSERT_EXPECT_NUMBER;
9845
9846     switch (**pattern) {
9847     case '1': case '2': case '3':
9848     case '4': case '5': case '6':
9849     case '7': case '8': case '9':
9850         var = *(*pattern)++ - '0';
9851         while (isDIGIT(**pattern)) {
9852             const I32 tmp = var * 10 + (*(*pattern)++ - '0');
9853             if (tmp < var)
9854                 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn"));
9855             var = tmp;
9856         }
9857     }
9858     return var;
9859 }
9860
9861 STATIC char *
9862 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
9863 {
9864     const int neg = nv < 0;
9865     UV uv;
9866
9867     PERL_ARGS_ASSERT_F0CONVERT;
9868
9869     if (neg)
9870         nv = -nv;
9871     if (nv < UV_MAX) {
9872         char *p = endbuf;
9873         nv += 0.5;
9874         uv = (UV)nv;
9875         if (uv & 1 && uv == nv)
9876             uv--;                       /* Round to even */
9877         do {
9878             const unsigned dig = uv % 10;
9879             *--p = '0' + dig;
9880         } while (uv /= 10);
9881         if (neg)
9882             *--p = '-';
9883         *len = endbuf - p;
9884         return p;
9885     }
9886     return NULL;
9887 }
9888
9889
9890 /*
9891 =for apidoc sv_vcatpvfn
9892
9893 Processes its arguments like C<vsprintf> and appends the formatted output
9894 to an SV.  Uses an array of SVs if the C style variable argument list is
9895 missing (NULL).  When running with taint checks enabled, indicates via
9896 C<maybe_tainted> if results are untrustworthy (often due to the use of
9897 locales).
9898
9899 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9900
9901 =cut
9902 */
9903
9904
9905 #define VECTORIZE_ARGS  vecsv = va_arg(*args, SV*);\
9906                         vecstr = (U8*)SvPV_const(vecsv,veclen);\
9907                         vec_utf8 = DO_UTF8(vecsv);
9908
9909 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9910
9911 void
9912 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9913                  va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9914 {
9915     dVAR;
9916     char *p;
9917     char *q;
9918     const char *patend;
9919     STRLEN origlen;
9920     I32 svix = 0;
9921     static const char nullstr[] = "(null)";
9922     SV *argsv = NULL;
9923     bool has_utf8 = DO_UTF8(sv);    /* has the result utf8? */
9924     const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9925     SV *nsv = NULL;
9926     /* Times 4: a decimal digit takes more than 3 binary digits.
9927      * NV_DIG: mantissa takes than many decimal digits.
9928      * Plus 32: Playing safe. */
9929     char ebuf[IV_DIG * 4 + NV_DIG + 32];
9930     /* large enough for "%#.#f" --chip */
9931     /* what about long double NVs? --jhi */
9932
9933     PERL_ARGS_ASSERT_SV_VCATPVFN;
9934     PERL_UNUSED_ARG(maybe_tainted);
9935
9936     /* no matter what, this is a string now */
9937     (void)SvPV_force(sv, origlen);
9938
9939     /* special-case "", "%s", and "%-p" (SVf - see below) */
9940     if (patlen == 0)
9941         return;
9942     if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9943         if (args) {
9944             const char * const s = va_arg(*args, char*);
9945             sv_catpv(sv, s ? s : nullstr);
9946         }
9947         else if (svix < svmax) {
9948             sv_catsv(sv, *svargs);
9949         }
9950         else
9951             S_vcatpvfn_missing_argument(aTHX);
9952         return;
9953     }
9954     if (args && patlen == 3 && pat[0] == '%' &&
9955                 pat[1] == '-' && pat[2] == 'p') {
9956         argsv = MUTABLE_SV(va_arg(*args, void*));
9957         sv_catsv(sv, argsv);
9958         return;
9959     }
9960
9961 #ifndef USE_LONG_DOUBLE
9962     /* special-case "%.<number>[gf]" */
9963     if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9964          && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9965         unsigned digits = 0;
9966         const char *pp;
9967
9968         pp = pat + 2;
9969         while (*pp >= '0' && *pp <= '9')
9970             digits = 10 * digits + (*pp++ - '0');
9971         if (pp - pat == (int)patlen - 1 && svix < svmax) {
9972             const NV nv = SvNV(*svargs);
9973             if (*pp == 'g') {
9974                 /* Add check for digits != 0 because it seems that some
9975                    gconverts are buggy in this case, and we don't yet have
9976                    a Configure test for this.  */
9977                 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9978                      /* 0, point, slack */
9979                     Gconvert(nv, (int)digits, 0, ebuf);
9980                     sv_catpv(sv, ebuf);
9981                     if (*ebuf)  /* May return an empty string for digits==0 */
9982                         return;
9983                 }
9984             } else if (!digits) {
9985                 STRLEN l;
9986
9987                 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9988                     sv_catpvn(sv, p, l);
9989                     return;
9990                 }
9991             }
9992         }
9993     }
9994 #endif /* !USE_LONG_DOUBLE */
9995
9996     if (!args && svix < svmax && DO_UTF8(*svargs))
9997         has_utf8 = TRUE;
9998
9999     patend = (char*)pat + patlen;
10000     for (p = (char*)pat; p < patend; p = q) {
10001         bool alt = FALSE;
10002         bool left = FALSE;
10003         bool vectorize = FALSE;
10004         bool vectorarg = FALSE;
10005         bool vec_utf8 = FALSE;
10006         char fill = ' ';
10007         char plus = 0;
10008         char intsize = 0;
10009         STRLEN width = 0;
10010         STRLEN zeros = 0;
10011         bool has_precis = FALSE;
10012         STRLEN precis = 0;
10013         const I32 osvix = svix;
10014         bool is_utf8 = FALSE;  /* is this item utf8?   */
10015 #ifdef HAS_LDBL_SPRINTF_BUG
10016         /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10017            with sfio - Allen <allens@cpan.org> */
10018         bool fix_ldbl_sprintf_bug = FALSE;
10019 #endif
10020
10021         char esignbuf[4];
10022         U8 utf8buf[UTF8_MAXBYTES+1];
10023         STRLEN esignlen = 0;
10024
10025         const char *eptr = NULL;
10026         const char *fmtstart;
10027         STRLEN elen = 0;
10028         SV *vecsv = NULL;
10029         const U8 *vecstr = NULL;
10030         STRLEN veclen = 0;
10031         char c = 0;
10032         int i;
10033         unsigned base = 0;
10034         IV iv = 0;
10035         UV uv = 0;
10036         /* we need a long double target in case HAS_LONG_DOUBLE but
10037            not USE_LONG_DOUBLE
10038         */
10039 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
10040         long double nv;
10041 #else
10042         NV nv;
10043 #endif
10044         STRLEN have;
10045         STRLEN need;
10046         STRLEN gap;
10047         const char *dotstr = ".";
10048         STRLEN dotstrlen = 1;
10049         I32 efix = 0; /* explicit format parameter index */
10050         I32 ewix = 0; /* explicit width index */
10051         I32 epix = 0; /* explicit precision index */
10052         I32 evix = 0; /* explicit vector index */
10053         bool asterisk = FALSE;
10054
10055         /* echo everything up to the next format specification */
10056         for (q = p; q < patend && *q != '%'; ++q) ;
10057         if (q > p) {
10058             if (has_utf8 && !pat_utf8)
10059                 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
10060             else
10061                 sv_catpvn(sv, p, q - p);
10062             p = q;
10063         }
10064         if (q++ >= patend)
10065             break;
10066
10067         fmtstart = q;
10068
10069 /*
10070     We allow format specification elements in this order:
10071         \d+\$              explicit format parameter index
10072         [-+ 0#]+           flags
10073         v|\*(\d+\$)?v      vector with optional (optionally specified) arg
10074         0                  flag (as above): repeated to allow "v02"
10075         \d+|\*(\d+\$)?     width using optional (optionally specified) arg
10076         \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
10077         [hlqLV]            size
10078     [%bcdefginopsuxDFOUX] format (mandatory)
10079 */
10080
10081         if (args) {
10082 /*
10083         As of perl5.9.3, printf format checking is on by default.
10084         Internally, perl uses %p formats to provide an escape to
10085         some extended formatting.  This block deals with those
10086         extensions: if it does not match, (char*)q is reset and
10087         the normal format processing code is used.
10088
10089         Currently defined extensions are:
10090                 %p              include pointer address (standard)
10091                 %-p     (SVf)   include an SV (previously %_)
10092                 %-<num>p        include an SV with precision <num>
10093                 %<num>p         reserved for future extensions
10094
10095         Robin Barker 2005-07-14
10096
10097                 %1p     (VDf)   removed.  RMB 2007-10-19
10098 */
10099             char* r = q;
10100             bool sv = FALSE;
10101             STRLEN n = 0;
10102             if (*q == '-')
10103                 sv = *q++;
10104             n = expect_number(&q);
10105             if (*q++ == 'p') {
10106                 if (sv) {                       /* SVf */
10107                     if (n) {
10108                         precis = n;
10109                         has_precis = TRUE;
10110                     }
10111                     argsv = MUTABLE_SV(va_arg(*args, void*));
10112                     eptr = SvPV_const(argsv, elen);
10113                     if (DO_UTF8(argsv))
10114                         is_utf8 = TRUE;
10115                     goto string;
10116                 }
10117                 else if (n) {
10118                     Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
10119                                      "internal %%<num>p might conflict with future printf extensions");
10120                 }
10121             }
10122             q = r;
10123         }
10124
10125         if ( (width = expect_number(&q)) ) {
10126             if (*q == '$') {
10127                 ++q;
10128                 efix = width;
10129             } else {
10130                 goto gotwidth;
10131             }
10132         }
10133
10134         /* FLAGS */
10135
10136         while (*q) {
10137             switch (*q) {
10138             case ' ':
10139             case '+':
10140                 if (plus == '+' && *q == ' ') /* '+' over ' ' */
10141                     q++;
10142                 else
10143                     plus = *q++;
10144                 continue;
10145
10146             case '-':
10147                 left = TRUE;
10148                 q++;
10149                 continue;
10150
10151             case '0':
10152                 fill = *q++;
10153                 continue;
10154
10155             case '#':
10156                 alt = TRUE;
10157                 q++;
10158                 continue;
10159
10160             default:
10161                 break;
10162             }
10163             break;
10164         }
10165
10166       tryasterisk:
10167         if (*q == '*') {
10168             q++;
10169             if ( (ewix = expect_number(&q)) )
10170                 if (*q++ != '$')
10171                     goto unknown;
10172             asterisk = TRUE;
10173         }
10174         if (*q == 'v') {
10175             q++;
10176             if (vectorize)
10177                 goto unknown;
10178             if ((vectorarg = asterisk)) {
10179                 evix = ewix;
10180                 ewix = 0;
10181                 asterisk = FALSE;
10182             }
10183             vectorize = TRUE;
10184             goto tryasterisk;
10185         }
10186
10187         if (!asterisk)
10188         {
10189             if( *q == '0' )
10190                 fill = *q++;
10191             width = expect_number(&q);
10192         }
10193
10194         if (vectorize && vectorarg) {
10195             /* vectorizing, but not with the default "." */
10196             if (args)
10197                 vecsv = va_arg(*args, SV*);
10198             else if (evix) {
10199                 vecsv = (evix > 0 && evix <= svmax)
10200                     ? svargs[evix-1] : S_vcatpvfn_missing_argument(aTHX);
10201             } else {
10202                 vecsv = svix < svmax
10203                     ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10204             }
10205             dotstr = SvPV_const(vecsv, dotstrlen);
10206             /* Keep the DO_UTF8 test *after* the SvPV call, else things go
10207                bad with tied or overloaded values that return UTF8.  */
10208             if (DO_UTF8(vecsv))
10209                 is_utf8 = TRUE;
10210             else if (has_utf8) {
10211                 vecsv = sv_mortalcopy(vecsv);
10212                 sv_utf8_upgrade(vecsv);
10213                 dotstr = SvPV_const(vecsv, dotstrlen);
10214                 is_utf8 = TRUE;
10215             }
10216         }
10217
10218         if (asterisk) {
10219             if (args)
10220                 i = va_arg(*args, int);
10221             else
10222                 i = (ewix ? ewix <= svmax : svix < svmax) ?
10223                     SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10224             left |= (i < 0);
10225             width = (i < 0) ? -i : i;
10226         }
10227       gotwidth:
10228
10229         /* PRECISION */
10230
10231         if (*q == '.') {
10232             q++;
10233             if (*q == '*') {
10234                 q++;
10235                 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
10236                     goto unknown;
10237                 /* XXX: todo, support specified precision parameter */
10238                 if (epix)
10239                     goto unknown;
10240                 if (args)
10241                     i = va_arg(*args, int);
10242                 else
10243                     i = (ewix ? ewix <= svmax : svix < svmax)
10244                         ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10245                 precis = i;
10246                 has_precis = !(i < 0);
10247             }
10248             else {
10249                 precis = 0;
10250                 while (isDIGIT(*q))
10251                     precis = precis * 10 + (*q++ - '0');
10252                 has_precis = TRUE;
10253             }
10254         }
10255
10256         if (vectorize) {
10257             if (args) {
10258                 VECTORIZE_ARGS
10259             }
10260             else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
10261                 vecsv = svargs[efix ? efix-1 : svix++];
10262                 vecstr = (U8*)SvPV_const(vecsv,veclen);
10263                 vec_utf8 = DO_UTF8(vecsv);
10264
10265                 /* if this is a version object, we need to convert
10266                  * back into v-string notation and then let the
10267                  * vectorize happen normally
10268                  */
10269                 if (sv_derived_from(vecsv, "version")) {
10270                     char *version = savesvpv(vecsv);
10271                     if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
10272                         Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
10273                         "vector argument not supported with alpha versions");
10274                         goto unknown;
10275                     }
10276                     vecsv = sv_newmortal();
10277                     scan_vstring(version, version + veclen, vecsv);
10278                     vecstr = (U8*)SvPV_const(vecsv, veclen);
10279                     vec_utf8 = DO_UTF8(vecsv);
10280                     Safefree(version);
10281                 }
10282             }
10283             else {
10284                 vecstr = (U8*)"";
10285                 veclen = 0;
10286             }
10287         }
10288
10289         /* SIZE */
10290
10291         switch (*q) {
10292 #ifdef WIN32
10293         case 'I':                       /* Ix, I32x, and I64x */
10294 #  ifdef WIN64
10295             if (q[1] == '6' && q[2] == '4') {
10296                 q += 3;
10297                 intsize = 'q';
10298                 break;
10299             }
10300 #  endif
10301             if (q[1] == '3' && q[2] == '2') {
10302                 q += 3;
10303                 break;
10304             }
10305 #  ifdef WIN64
10306             intsize = 'q';
10307 #  endif
10308             q++;
10309             break;
10310 #endif
10311 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10312         case 'L':                       /* Ld */
10313             /*FALLTHROUGH*/
10314 #ifdef HAS_QUAD
10315         case 'q':                       /* qd */
10316 #endif
10317             intsize = 'q';
10318             q++;
10319             break;
10320 #endif
10321         case 'l':
10322             ++q;
10323 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10324             if (*q == 'l') {    /* lld, llf */
10325                 intsize = 'q';
10326                 ++q;
10327             }
10328             else
10329 #endif
10330                 intsize = 'l';
10331             break;
10332         case 'h':
10333             if (*++q == 'h') {  /* hhd, hhu */
10334                 intsize = 'c';
10335                 ++q;
10336             }
10337             else
10338                 intsize = 'h';
10339             break;
10340         case 'V':
10341         case 'z':
10342         case 't':
10343 #if HAS_C99
10344         case 'j':
10345 #endif
10346             intsize = *q++;
10347             break;
10348         }
10349
10350         /* CONVERSION */
10351
10352         if (*q == '%') {
10353             eptr = q++;
10354             elen = 1;
10355             if (vectorize) {
10356                 c = '%';
10357                 goto unknown;
10358             }
10359             goto string;
10360         }
10361
10362         if (!vectorize && !args) {
10363             if (efix) {
10364                 const I32 i = efix-1;
10365                 argsv = (i >= 0 && i < svmax)
10366                     ? svargs[i] : S_vcatpvfn_missing_argument(aTHX);
10367             } else {
10368                 argsv = (svix >= 0 && svix < svmax)
10369                     ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10370             }
10371         }
10372
10373         switch (c = *q++) {
10374
10375             /* STRINGS */
10376
10377         case 'c':
10378             if (vectorize)
10379                 goto unknown;
10380             uv = (args) ? va_arg(*args, int) : SvIV(argsv);
10381             if ((uv > 255 ||
10382                  (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
10383                 && !IN_BYTES) {
10384                 eptr = (char*)utf8buf;
10385                 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
10386                 is_utf8 = TRUE;
10387             }
10388             else {
10389                 c = (char)uv;
10390                 eptr = &c;
10391                 elen = 1;
10392             }
10393             goto string;
10394
10395         case 's':
10396             if (vectorize)
10397                 goto unknown;
10398             if (args) {
10399                 eptr = va_arg(*args, char*);
10400                 if (eptr)
10401                     elen = strlen(eptr);
10402                 else {
10403                     eptr = (char *)nullstr;
10404                     elen = sizeof nullstr - 1;
10405                 }
10406             }
10407             else {
10408                 eptr = SvPV_const(argsv, elen);
10409                 if (DO_UTF8(argsv)) {
10410                     STRLEN old_precis = precis;
10411                     if (has_precis && precis < elen) {
10412                         STRLEN ulen = sv_len_utf8(argsv);
10413                         I32 p = precis > ulen ? ulen : precis;
10414                         sv_pos_u2b(argsv, &p, 0); /* sticks at end */
10415                         precis = p;
10416                     }
10417                     if (width) { /* fudge width (can't fudge elen) */
10418                         if (has_precis && precis < elen)
10419                             width += precis - old_precis;
10420                         else
10421                             width += elen - sv_len_utf8(argsv);
10422                     }
10423                     is_utf8 = TRUE;
10424                 }
10425             }
10426
10427         string:
10428             if (has_precis && precis < elen)
10429                 elen = precis;
10430             break;
10431
10432             /* INTEGERS */
10433
10434         case 'p':
10435             if (alt || vectorize)
10436                 goto unknown;
10437             uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
10438             base = 16;
10439             goto integer;
10440
10441         case 'D':
10442 #ifdef IV_IS_QUAD
10443             intsize = 'q';
10444 #else
10445             intsize = 'l';
10446 #endif
10447             /*FALLTHROUGH*/
10448         case 'd':
10449         case 'i':
10450 #if vdNUMBER
10451         format_vd:
10452 #endif
10453             if (vectorize) {
10454                 STRLEN ulen;
10455                 if (!veclen)
10456                     continue;
10457                 if (vec_utf8)
10458                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10459                                         UTF8_ALLOW_ANYUV);
10460                 else {
10461                     uv = *vecstr;
10462                     ulen = 1;
10463                 }
10464                 vecstr += ulen;
10465                 veclen -= ulen;
10466                 if (plus)
10467                      esignbuf[esignlen++] = plus;
10468             }
10469             else if (args) {
10470                 switch (intsize) {
10471                 case 'c':       iv = (char)va_arg(*args, int); break;
10472                 case 'h':       iv = (short)va_arg(*args, int); break;
10473                 case 'l':       iv = va_arg(*args, long); break;
10474                 case 'V':       iv = va_arg(*args, IV); break;
10475                 case 'z':       iv = va_arg(*args, SSize_t); break;
10476                 case 't':       iv = va_arg(*args, ptrdiff_t); break;
10477                 default:        iv = va_arg(*args, int); break;
10478 #if HAS_C99
10479                 case 'j':       iv = va_arg(*args, intmax_t); break;
10480 #endif
10481                 case 'q':
10482 #ifdef HAS_QUAD
10483                                 iv = va_arg(*args, Quad_t); break;
10484 #else
10485                                 goto unknown;
10486 #endif
10487                 }
10488             }
10489             else {
10490                 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
10491                 switch (intsize) {
10492                 case 'c':       iv = (char)tiv; break;
10493                 case 'h':       iv = (short)tiv; break;
10494                 case 'l':       iv = (long)tiv; break;
10495                 case 'V':
10496                 default:        iv = tiv; break;
10497                 case 'q':
10498 #ifdef HAS_QUAD
10499                                 iv = (Quad_t)tiv; break;
10500 #else
10501                                 goto unknown;
10502 #endif
10503                 }
10504             }
10505             if ( !vectorize )   /* we already set uv above */
10506             {
10507                 if (iv >= 0) {
10508                     uv = iv;
10509                     if (plus)
10510                         esignbuf[esignlen++] = plus;
10511                 }
10512                 else {
10513                     uv = -iv;
10514                     esignbuf[esignlen++] = '-';
10515                 }
10516             }
10517             base = 10;
10518             goto integer;
10519
10520         case 'U':
10521 #ifdef IV_IS_QUAD
10522             intsize = 'q';
10523 #else
10524             intsize = 'l';
10525 #endif
10526             /*FALLTHROUGH*/
10527         case 'u':
10528             base = 10;
10529             goto uns_integer;
10530
10531         case 'B':
10532         case 'b':
10533             base = 2;
10534             goto uns_integer;
10535
10536         case 'O':
10537 #ifdef IV_IS_QUAD
10538             intsize = 'q';
10539 #else
10540             intsize = 'l';
10541 #endif
10542             /*FALLTHROUGH*/
10543         case 'o':
10544             base = 8;
10545             goto uns_integer;
10546
10547         case 'X':
10548         case 'x':
10549             base = 16;
10550
10551         uns_integer:
10552             if (vectorize) {
10553                 STRLEN ulen;
10554         vector:
10555                 if (!veclen)
10556                     continue;
10557                 if (vec_utf8)
10558                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10559                                         UTF8_ALLOW_ANYUV);
10560                 else {
10561                     uv = *vecstr;
10562                     ulen = 1;
10563                 }
10564                 vecstr += ulen;
10565                 veclen -= ulen;
10566             }
10567             else if (args) {
10568                 switch (intsize) {
10569                 case 'c':  uv = (unsigned char)va_arg(*args, unsigned); break;
10570                 case 'h':  uv = (unsigned short)va_arg(*args, unsigned); break;
10571                 case 'l':  uv = va_arg(*args, unsigned long); break;
10572                 case 'V':  uv = va_arg(*args, UV); break;
10573                 case 'z':  uv = va_arg(*args, Size_t); break;
10574                 case 't':  uv = va_arg(*args, ptrdiff_t); break; /* will sign extend, but there is no uptrdiff_t, so oh well */
10575 #if HAS_C99
10576                 case 'j':  uv = va_arg(*args, uintmax_t); break;
10577 #endif
10578                 default:   uv = va_arg(*args, unsigned); break;
10579                 case 'q':
10580 #ifdef HAS_QUAD
10581                            uv = va_arg(*args, Uquad_t); break;
10582 #else
10583                            goto unknown;
10584 #endif
10585                 }
10586             }
10587             else {
10588                 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
10589                 switch (intsize) {
10590                 case 'c':       uv = (unsigned char)tuv; break;
10591                 case 'h':       uv = (unsigned short)tuv; break;
10592                 case 'l':       uv = (unsigned long)tuv; break;
10593                 case 'V':
10594                 default:        uv = tuv; break;
10595                 case 'q':
10596 #ifdef HAS_QUAD
10597                                 uv = (Uquad_t)tuv; break;
10598 #else
10599                                 goto unknown;
10600 #endif
10601                 }
10602             }
10603
10604         integer:
10605             {
10606                 char *ptr = ebuf + sizeof ebuf;
10607                 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
10608                 zeros = 0;
10609
10610                 switch (base) {
10611                     unsigned dig;
10612                 case 16:
10613                     p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
10614                     do {
10615                         dig = uv & 15;
10616                         *--ptr = p[dig];
10617                     } while (uv >>= 4);
10618                     if (tempalt) {
10619                         esignbuf[esignlen++] = '0';
10620                         esignbuf[esignlen++] = c;  /* 'x' or 'X' */
10621                     }
10622                     break;
10623                 case 8:
10624                     do {
10625                         dig = uv & 7;
10626                         *--ptr = '0' + dig;
10627                     } while (uv >>= 3);
10628                     if (alt && *ptr != '0')
10629                         *--ptr = '0';
10630                     break;
10631                 case 2:
10632                     do {
10633                         dig = uv & 1;
10634                         *--ptr = '0' + dig;
10635                     } while (uv >>= 1);
10636                     if (tempalt) {
10637                         esignbuf[esignlen++] = '0';
10638                         esignbuf[esignlen++] = c;
10639                     }
10640                     break;
10641                 default:                /* it had better be ten or less */
10642                     do {
10643                         dig = uv % base;
10644                         *--ptr = '0' + dig;
10645                     } while (uv /= base);
10646                     break;
10647                 }
10648                 elen = (ebuf + sizeof ebuf) - ptr;
10649                 eptr = ptr;
10650                 if (has_precis) {
10651                     if (precis > elen)
10652                         zeros = precis - elen;
10653                     else if (precis == 0 && elen == 1 && *eptr == '0'
10654                              && !(base == 8 && alt)) /* "%#.0o" prints "0" */
10655                         elen = 0;
10656
10657                 /* a precision nullifies the 0 flag. */
10658                     if (fill == '0')
10659                         fill = ' ';
10660                 }
10661             }
10662             break;
10663
10664             /* FLOATING POINT */
10665
10666         case 'F':
10667             c = 'f';            /* maybe %F isn't supported here */
10668             /*FALLTHROUGH*/
10669         case 'e': case 'E':
10670         case 'f':
10671         case 'g': case 'G':
10672             if (vectorize)
10673                 goto unknown;
10674
10675             /* This is evil, but floating point is even more evil */
10676
10677             /* for SV-style calling, we can only get NV
10678                for C-style calling, we assume %f is double;
10679                for simplicity we allow any of %Lf, %llf, %qf for long double
10680             */
10681             switch (intsize) {
10682             case 'V':
10683 #if defined(USE_LONG_DOUBLE)
10684                 intsize = 'q';
10685 #endif
10686                 break;
10687 /* [perl #20339] - we should accept and ignore %lf rather than die */
10688             case 'l':
10689                 /*FALLTHROUGH*/
10690             default:
10691 #if defined(USE_LONG_DOUBLE)
10692                 intsize = args ? 0 : 'q';
10693 #endif
10694                 break;
10695             case 'q':
10696 #if defined(HAS_LONG_DOUBLE)
10697                 break;
10698 #else
10699                 /*FALLTHROUGH*/
10700 #endif
10701             case 'c':
10702             case 'h':
10703             case 'z':
10704             case 't':
10705             case 'j':
10706                 goto unknown;
10707             }
10708
10709             /* now we need (long double) if intsize == 'q', else (double) */
10710             nv = (args) ?
10711 #if LONG_DOUBLESIZE > DOUBLESIZE
10712                 intsize == 'q' ?
10713                     va_arg(*args, long double) :
10714                     va_arg(*args, double)
10715 #else
10716                     va_arg(*args, double)
10717 #endif
10718                 : SvNV(argsv);
10719
10720             need = 0;
10721             /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
10722                else. frexp() has some unspecified behaviour for those three */
10723             if (c != 'e' && c != 'E' && (nv * 0) == 0) {
10724                 i = PERL_INT_MIN;
10725                 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
10726                    will cast our (long double) to (double) */
10727                 (void)Perl_frexp(nv, &i);
10728                 if (i == PERL_INT_MIN)
10729                     Perl_die(aTHX_ "panic: frexp");
10730                 if (i > 0)
10731                     need = BIT_DIGITS(i);
10732             }
10733             need += has_precis ? precis : 6; /* known default */
10734
10735             if (need < width)
10736                 need = width;
10737
10738 #ifdef HAS_LDBL_SPRINTF_BUG
10739             /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10740                with sfio - Allen <allens@cpan.org> */
10741
10742 #  ifdef DBL_MAX
10743 #    define MY_DBL_MAX DBL_MAX
10744 #  else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
10745 #    if DOUBLESIZE >= 8
10746 #      define MY_DBL_MAX 1.7976931348623157E+308L
10747 #    else
10748 #      define MY_DBL_MAX 3.40282347E+38L
10749 #    endif
10750 #  endif
10751
10752 #  ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
10753 #    define MY_DBL_MAX_BUG 1L
10754 #  else
10755 #    define MY_DBL_MAX_BUG MY_DBL_MAX
10756 #  endif
10757
10758 #  ifdef DBL_MIN
10759 #    define MY_DBL_MIN DBL_MIN
10760 #  else  /* XXX guessing! -Allen */
10761 #    if DOUBLESIZE >= 8
10762 #      define MY_DBL_MIN 2.2250738585072014E-308L
10763 #    else
10764 #      define MY_DBL_MIN 1.17549435E-38L
10765 #    endif
10766 #  endif
10767
10768             if ((intsize == 'q') && (c == 'f') &&
10769                 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
10770                 (need < DBL_DIG)) {
10771                 /* it's going to be short enough that
10772                  * long double precision is not needed */
10773
10774                 if ((nv <= 0L) && (nv >= -0L))
10775                     fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
10776                 else {
10777                     /* would use Perl_fp_class as a double-check but not
10778                      * functional on IRIX - see perl.h comments */
10779
10780                     if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
10781                         /* It's within the range that a double can represent */
10782 #if defined(DBL_MAX) && !defined(DBL_MIN)
10783                         if ((nv >= ((long double)1/DBL_MAX)) ||
10784                             (nv <= (-(long double)1/DBL_MAX)))
10785 #endif
10786                         fix_ldbl_sprintf_bug = TRUE;
10787                     }
10788                 }
10789                 if (fix_ldbl_sprintf_bug == TRUE) {
10790                     double temp;
10791
10792                     intsize = 0;
10793                     temp = (double)nv;
10794                     nv = (NV)temp;
10795                 }
10796             }
10797
10798 #  undef MY_DBL_MAX
10799 #  undef MY_DBL_MAX_BUG
10800 #  undef MY_DBL_MIN
10801
10802 #endif /* HAS_LDBL_SPRINTF_BUG */
10803
10804             need += 20; /* fudge factor */
10805             if (PL_efloatsize < need) {
10806                 Safefree(PL_efloatbuf);
10807                 PL_efloatsize = need + 20; /* more fudge */
10808                 Newx(PL_efloatbuf, PL_efloatsize, char);
10809                 PL_efloatbuf[0] = '\0';
10810             }
10811
10812             if ( !(width || left || plus || alt) && fill != '0'
10813                  && has_precis && intsize != 'q' ) {    /* Shortcuts */
10814                 /* See earlier comment about buggy Gconvert when digits,
10815                    aka precis is 0  */
10816                 if ( c == 'g' && precis) {
10817                     Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
10818                     /* May return an empty string for digits==0 */
10819                     if (*PL_efloatbuf) {
10820                         elen = strlen(PL_efloatbuf);
10821                         goto float_converted;
10822                     }
10823                 } else if ( c == 'f' && !precis) {
10824                     if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10825                         break;
10826                 }
10827             }
10828             {
10829                 char *ptr = ebuf + sizeof ebuf;
10830                 *--ptr = '\0';
10831                 *--ptr = c;
10832                 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10833 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10834                 if (intsize == 'q') {
10835                     /* Copy the one or more characters in a long double
10836                      * format before the 'base' ([efgEFG]) character to
10837                      * the format string. */
10838                     static char const prifldbl[] = PERL_PRIfldbl;
10839                     char const *p = prifldbl + sizeof(prifldbl) - 3;
10840                     while (p >= prifldbl) { *--ptr = *p--; }
10841                 }
10842 #endif
10843                 if (has_precis) {
10844                     base = precis;
10845                     do { *--ptr = '0' + (base % 10); } while (base /= 10);
10846                     *--ptr = '.';
10847                 }
10848                 if (width) {
10849                     base = width;
10850                     do { *--ptr = '0' + (base % 10); } while (base /= 10);
10851                 }
10852                 if (fill == '0')
10853                     *--ptr = fill;
10854                 if (left)
10855                     *--ptr = '-';
10856                 if (plus)
10857                     *--ptr = plus;
10858                 if (alt)
10859                     *--ptr = '#';
10860                 *--ptr = '%';
10861
10862                 /* No taint.  Otherwise we are in the strange situation
10863                  * where printf() taints but print($float) doesn't.
10864                  * --jhi */
10865 #if defined(HAS_LONG_DOUBLE)
10866                 elen = ((intsize == 'q')
10867                         ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
10868                         : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
10869 #else
10870                 elen = my_sprintf(PL_efloatbuf, ptr, nv);
10871 #endif
10872             }
10873         float_converted:
10874             eptr = PL_efloatbuf;
10875             break;
10876
10877             /* SPECIAL */
10878
10879         case 'n':
10880             if (vectorize)
10881                 goto unknown;
10882             i = SvCUR(sv) - origlen;
10883             if (args) {
10884                 switch (intsize) {
10885                 case 'c':       *(va_arg(*args, char*)) = i; break;
10886                 case 'h':       *(va_arg(*args, short*)) = i; break;
10887                 default:        *(va_arg(*args, int*)) = i; break;
10888                 case 'l':       *(va_arg(*args, long*)) = i; break;
10889                 case 'V':       *(va_arg(*args, IV*)) = i; break;
10890                 case 'z':       *(va_arg(*args, SSize_t*)) = i; break;
10891                 case 't':       *(va_arg(*args, ptrdiff_t*)) = i; break;
10892 #if HAS_C99
10893                 case 'j':       *(va_arg(*args, intmax_t*)) = i; break;
10894 #endif
10895                 case 'q':
10896 #ifdef HAS_QUAD
10897                                 *(va_arg(*args, Quad_t*)) = i; break;
10898 #else
10899                                 goto unknown;
10900 #endif
10901                 }
10902             }
10903             else
10904                 sv_setuv_mg(argsv, (UV)i);
10905             continue;   /* not "break" */
10906
10907             /* UNKNOWN */
10908
10909         default:
10910       unknown:
10911             if (!args
10912                 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
10913                 && ckWARN(WARN_PRINTF))
10914             {
10915                 SV * const msg = sv_newmortal();
10916                 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10917                           (PL_op->op_type == OP_PRTF) ? "" : "s");
10918                 if (fmtstart < patend) {
10919                     const char * const fmtend = q < patend ? q : patend;
10920                     const char * f;
10921                     sv_catpvs(msg, "\"%");
10922                     for (f = fmtstart; f < fmtend; f++) {
10923                         if (isPRINT(*f)) {
10924                             sv_catpvn(msg, f, 1);
10925                         } else {
10926                             Perl_sv_catpvf(aTHX_ msg,
10927                                            "\\%03"UVof, (UV)*f & 0xFF);
10928                         }
10929                     }
10930                     sv_catpvs(msg, "\"");
10931                 } else {
10932                     sv_catpvs(msg, "end of string");
10933                 }
10934                 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
10935             }
10936
10937             /* output mangled stuff ... */
10938             if (c == '\0')
10939                 --q;
10940             eptr = p;
10941             elen = q - p;
10942
10943             /* ... right here, because formatting flags should not apply */
10944             SvGROW(sv, SvCUR(sv) + elen + 1);
10945             p = SvEND(sv);
10946             Copy(eptr, p, elen, char);
10947             p += elen;
10948             *p = '\0';
10949             SvCUR_set(sv, p - SvPVX_const(sv));
10950             svix = osvix;
10951             continue;   /* not "break" */
10952         }
10953
10954         if (is_utf8 != has_utf8) {
10955             if (is_utf8) {
10956                 if (SvCUR(sv))
10957                     sv_utf8_upgrade(sv);
10958             }
10959             else {
10960                 const STRLEN old_elen = elen;
10961                 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
10962                 sv_utf8_upgrade(nsv);
10963                 eptr = SvPVX_const(nsv);
10964                 elen = SvCUR(nsv);
10965
10966                 if (width) { /* fudge width (can't fudge elen) */
10967                     width += elen - old_elen;
10968                 }
10969                 is_utf8 = TRUE;
10970             }
10971         }
10972
10973         have = esignlen + zeros + elen;
10974         if (have < zeros)
10975             Perl_croak_nocontext("%s", PL_memory_wrap);
10976
10977         need = (have > width ? have : width);
10978         gap = need - have;
10979
10980         if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
10981             Perl_croak_nocontext("%s", PL_memory_wrap);
10982         SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10983         p = SvEND(sv);
10984         if (esignlen && fill == '0') {
10985             int i;
10986             for (i = 0; i < (int)esignlen; i++)
10987                 *p++ = esignbuf[i];
10988         }
10989         if (gap && !left) {
10990             memset(p, fill, gap);
10991             p += gap;
10992         }
10993         if (esignlen && fill != '0') {
10994             int i;
10995             for (i = 0; i < (int)esignlen; i++)
10996                 *p++ = esignbuf[i];
10997         }
10998         if (zeros) {
10999             int i;
11000             for (i = zeros; i; i--)
11001                 *p++ = '0';
11002         }
11003         if (elen) {
11004             Copy(eptr, p, elen, char);
11005             p += elen;
11006         }
11007         if (gap && left) {
11008             memset(p, ' ', gap);
11009             p += gap;
11010         }
11011         if (vectorize) {
11012             if (veclen) {
11013                 Copy(dotstr, p, dotstrlen, char);
11014                 p += dotstrlen;
11015             }
11016             else
11017                 vectorize = FALSE;              /* done iterating over vecstr */
11018         }
11019         if (is_utf8)
11020             has_utf8 = TRUE;
11021         if (has_utf8)
11022             SvUTF8_on(sv);
11023         *p = '\0';
11024         SvCUR_set(sv, p - SvPVX_const(sv));
11025         if (vectorize) {
11026             esignlen = 0;
11027             goto vector;
11028         }
11029     }
11030     SvTAINT(sv);
11031 }
11032
11033 /* =========================================================================
11034
11035 =head1 Cloning an interpreter
11036
11037 All the macros and functions in this section are for the private use of
11038 the main function, perl_clone().
11039
11040 The foo_dup() functions make an exact copy of an existing foo thingy.
11041 During the course of a cloning, a hash table is used to map old addresses
11042 to new addresses. The table is created and manipulated with the
11043 ptr_table_* functions.
11044
11045 =cut
11046
11047  * =========================================================================*/
11048
11049
11050 #if defined(USE_ITHREADS)
11051
11052 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
11053 #ifndef GpREFCNT_inc
11054 #  define GpREFCNT_inc(gp)      ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
11055 #endif
11056
11057
11058 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
11059    that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
11060    If this changes, please unmerge ss_dup.
11061    Likewise, sv_dup_inc_multiple() relies on this fact.  */
11062 #define sv_dup_inc_NN(s,t)      SvREFCNT_inc_NN(sv_dup_inc(s,t))
11063 #define av_dup(s,t)     MUTABLE_AV(sv_dup((const SV *)s,t))
11064 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
11065 #define hv_dup(s,t)     MUTABLE_HV(sv_dup((const SV *)s,t))
11066 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
11067 #define cv_dup(s,t)     MUTABLE_CV(sv_dup((const SV *)s,t))
11068 #define cv_dup_inc(s,t) MUTABLE_CV(sv_dup_inc((const SV *)s,t))
11069 #define io_dup(s,t)     MUTABLE_IO(sv_dup((const SV *)s,t))
11070 #define io_dup_inc(s,t) MUTABLE_IO(sv_dup_inc((const SV *)s,t))
11071 #define gv_dup(s,t)     MUTABLE_GV(sv_dup((const SV *)s,t))
11072 #define gv_dup_inc(s,t) MUTABLE_GV(sv_dup_inc((const SV *)s,t))
11073 #define SAVEPV(p)       ((p) ? savepv(p) : NULL)
11074 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
11075
11076 /* clone a parser */
11077
11078 yy_parser *
11079 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
11080 {
11081     yy_parser *parser;
11082
11083     PERL_ARGS_ASSERT_PARSER_DUP;
11084
11085     if (!proto)
11086         return NULL;
11087
11088     /* look for it in the table first */
11089     parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
11090     if (parser)
11091         return parser;
11092
11093     /* create anew and remember what it is */
11094     Newxz(parser, 1, yy_parser);
11095     ptr_table_store(PL_ptr_table, proto, parser);
11096
11097     /* XXX these not yet duped */
11098     parser->old_parser = NULL;
11099     parser->stack = NULL;
11100     parser->ps = NULL;
11101     parser->stack_size = 0;
11102     /* XXX parser->stack->state = 0; */
11103
11104     /* XXX eventually, just Copy() most of the parser struct ? */
11105
11106     parser->lex_brackets = proto->lex_brackets;
11107     parser->lex_casemods = proto->lex_casemods;
11108     parser->lex_brackstack = savepvn(proto->lex_brackstack,
11109                     (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
11110     parser->lex_casestack = savepvn(proto->lex_casestack,
11111                     (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
11112     parser->lex_defer   = proto->lex_defer;
11113     parser->lex_dojoin  = proto->lex_dojoin;
11114     parser->lex_expect  = proto->lex_expect;
11115     parser->lex_formbrack = proto->lex_formbrack;
11116     parser->lex_inpat   = proto->lex_inpat;
11117     parser->lex_inwhat  = proto->lex_inwhat;
11118     parser->lex_op      = proto->lex_op;
11119     parser->lex_repl    = sv_dup_inc(proto->lex_repl, param);
11120     parser->lex_starts  = proto->lex_starts;
11121     parser->lex_stuff   = sv_dup_inc(proto->lex_stuff, param);
11122     parser->multi_close = proto->multi_close;
11123     parser->multi_open  = proto->multi_open;
11124     parser->multi_start = proto->multi_start;
11125     parser->multi_end   = proto->multi_end;
11126     parser->pending_ident = proto->pending_ident;
11127     parser->preambled   = proto->preambled;
11128     parser->sublex_info = proto->sublex_info; /* XXX not quite right */
11129     parser->linestr     = sv_dup_inc(proto->linestr, param);
11130     parser->expect      = proto->expect;
11131     parser->copline     = proto->copline;
11132     parser->last_lop_op = proto->last_lop_op;
11133     parser->lex_state   = proto->lex_state;
11134     parser->rsfp        = fp_dup(proto->rsfp, '<', param);
11135     /* rsfp_filters entries have fake IoDIRP() */
11136     parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
11137     parser->in_my       = proto->in_my;
11138     parser->in_my_stash = hv_dup(proto->in_my_stash, param);
11139     parser->error_count = proto->error_count;
11140
11141
11142     parser->linestr     = sv_dup_inc(proto->linestr, param);
11143
11144     {
11145         char * const ols = SvPVX(proto->linestr);
11146         char * const ls  = SvPVX(parser->linestr);
11147
11148         parser->bufptr      = ls + (proto->bufptr >= ols ?
11149                                     proto->bufptr -  ols : 0);
11150         parser->oldbufptr   = ls + (proto->oldbufptr >= ols ?
11151                                     proto->oldbufptr -  ols : 0);
11152         parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
11153                                     proto->oldoldbufptr -  ols : 0);
11154         parser->linestart   = ls + (proto->linestart >= ols ?
11155                                     proto->linestart -  ols : 0);
11156         parser->last_uni    = ls + (proto->last_uni >= ols ?
11157                                     proto->last_uni -  ols : 0);
11158         parser->last_lop    = ls + (proto->last_lop >= ols ?
11159                                     proto->last_lop -  ols : 0);
11160
11161         parser->bufend      = ls + SvCUR(parser->linestr);
11162     }
11163
11164     Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
11165
11166
11167 #ifdef PERL_MAD
11168     parser->endwhite    = proto->endwhite;
11169     parser->faketokens  = proto->faketokens;
11170     parser->lasttoke    = proto->lasttoke;
11171     parser->nextwhite   = proto->nextwhite;
11172     parser->realtokenstart = proto->realtokenstart;
11173     parser->skipwhite   = proto->skipwhite;
11174     parser->thisclose   = proto->thisclose;
11175     parser->thismad     = proto->thismad;
11176     parser->thisopen    = proto->thisopen;
11177     parser->thisstuff   = proto->thisstuff;
11178     parser->thistoken   = proto->thistoken;
11179     parser->thiswhite   = proto->thiswhite;
11180
11181     Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
11182     parser->curforce    = proto->curforce;
11183 #else
11184     Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
11185     Copy(proto->nexttype, parser->nexttype, 5,  I32);
11186     parser->nexttoke    = proto->nexttoke;
11187 #endif
11188
11189     /* XXX should clone saved_curcop here, but we aren't passed
11190      * proto_perl; so do it in perl_clone_using instead */
11191
11192     return parser;
11193 }
11194
11195
11196 /* duplicate a file handle */
11197
11198 PerlIO *
11199 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
11200 {
11201     PerlIO *ret;
11202
11203     PERL_ARGS_ASSERT_FP_DUP;
11204     PERL_UNUSED_ARG(type);
11205
11206     if (!fp)
11207         return (PerlIO*)NULL;
11208
11209     /* look for it in the table first */
11210     ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
11211     if (ret)
11212         return ret;
11213
11214     /* create anew and remember what it is */
11215     ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
11216     ptr_table_store(PL_ptr_table, fp, ret);
11217     return ret;
11218 }
11219
11220 /* duplicate a directory handle */
11221
11222 DIR *
11223 Perl_dirp_dup(pTHX_ DIR *const dp, CLONE_PARAMS *const param)
11224 {
11225     DIR *ret;
11226
11227 #ifdef HAS_FCHDIR
11228     DIR *pwd;
11229     register const Direntry_t *dirent;
11230     char smallbuf[256];
11231     char *name = NULL;
11232     STRLEN len = -1;
11233     long pos;
11234 #endif
11235
11236     PERL_UNUSED_CONTEXT;
11237     PERL_ARGS_ASSERT_DIRP_DUP;
11238
11239     if (!dp)
11240         return (DIR*)NULL;
11241
11242     /* look for it in the table first */
11243     ret = (DIR*)ptr_table_fetch(PL_ptr_table, dp);
11244     if (ret)
11245         return ret;
11246
11247 #ifdef HAS_FCHDIR
11248
11249     PERL_UNUSED_ARG(param);
11250
11251     /* create anew */
11252
11253     /* open the current directory (so we can switch back) */
11254     if (!(pwd = PerlDir_open("."))) return (DIR *)NULL;
11255
11256     /* chdir to our dir handle and open the present working directory */
11257     if (fchdir(my_dirfd(dp)) < 0 || !(ret = PerlDir_open("."))) {
11258         PerlDir_close(pwd);
11259         return (DIR *)NULL;
11260     }
11261     /* Now we should have two dir handles pointing to the same dir. */
11262
11263     /* Be nice to the calling code and chdir back to where we were. */
11264     fchdir(my_dirfd(pwd)); /* If this fails, then what? */
11265
11266     /* We have no need of the pwd handle any more. */
11267     PerlDir_close(pwd);
11268
11269 #ifdef DIRNAMLEN
11270 # define d_namlen(d) (d)->d_namlen
11271 #else
11272 # define d_namlen(d) strlen((d)->d_name)
11273 #endif
11274     /* Iterate once through dp, to get the file name at the current posi-
11275        tion. Then step back. */
11276     pos = PerlDir_tell(dp);
11277     if ((dirent = PerlDir_read(dp))) {
11278         len = d_namlen(dirent);
11279         if (len <= sizeof smallbuf) name = smallbuf;
11280         else Newx(name, len, char);
11281         Move(dirent->d_name, name, len, char);
11282     }
11283     PerlDir_seek(dp, pos);
11284
11285     /* Iterate through the new dir handle, till we find a file with the
11286        right name. */
11287     if (!dirent) /* just before the end */
11288         for(;;) {
11289             pos = PerlDir_tell(ret);
11290             if (PerlDir_read(ret)) continue; /* not there yet */
11291             PerlDir_seek(ret, pos); /* step back */
11292             break;
11293         }
11294     else {
11295         const long pos0 = PerlDir_tell(ret);
11296         for(;;) {
11297             pos = PerlDir_tell(ret);
11298             if ((dirent = PerlDir_read(ret))) {
11299                 if (len == d_namlen(dirent)
11300                  && memEQ(name, dirent->d_name, len)) {
11301                     /* found it */
11302                     PerlDir_seek(ret, pos); /* step back */
11303                     break;
11304                 }
11305                 /* else we are not there yet; keep iterating */
11306             }
11307             else { /* This is not meant to happen. The best we can do is
11308                       reset the iterator to the beginning. */
11309                 PerlDir_seek(ret, pos0);
11310                 break;
11311             }
11312         }
11313     }
11314 #undef d_namlen
11315
11316     if (name && name != smallbuf)
11317         Safefree(name);
11318 #endif
11319
11320 #ifdef WIN32
11321     ret = win32_dirp_dup(dp, param);
11322 #endif
11323
11324     /* pop it in the pointer table */
11325     if (ret)
11326         ptr_table_store(PL_ptr_table, dp, ret);
11327
11328     return ret;
11329 }
11330
11331 /* duplicate a typeglob */
11332
11333 GP *
11334 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
11335 {
11336     GP *ret;
11337
11338     PERL_ARGS_ASSERT_GP_DUP;
11339
11340     if (!gp)
11341         return (GP*)NULL;
11342     /* look for it in the table first */
11343     ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
11344     if (ret)
11345         return ret;
11346
11347     /* create anew and remember what it is */
11348     Newxz(ret, 1, GP);
11349     ptr_table_store(PL_ptr_table, gp, ret);
11350
11351     /* clone */
11352     /* ret->gp_refcnt must be 0 before any other dups are called. We're relying
11353        on Newxz() to do this for us.  */
11354     ret->gp_sv          = sv_dup_inc(gp->gp_sv, param);
11355     ret->gp_io          = io_dup_inc(gp->gp_io, param);
11356     ret->gp_form        = cv_dup_inc(gp->gp_form, param);
11357     ret->gp_av          = av_dup_inc(gp->gp_av, param);
11358     ret->gp_hv          = hv_dup_inc(gp->gp_hv, param);
11359     ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
11360     ret->gp_cv          = cv_dup_inc(gp->gp_cv, param);
11361     ret->gp_cvgen       = gp->gp_cvgen;
11362     ret->gp_line        = gp->gp_line;
11363     ret->gp_file_hek    = hek_dup(gp->gp_file_hek, param);
11364     return ret;
11365 }
11366
11367 /* duplicate a chain of magic */
11368
11369 MAGIC *
11370 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
11371 {
11372     MAGIC *mgret = NULL;
11373     MAGIC **mgprev_p = &mgret;
11374
11375     PERL_ARGS_ASSERT_MG_DUP;
11376
11377     for (; mg; mg = mg->mg_moremagic) {
11378         MAGIC *nmg;
11379
11380         if ((param->flags & CLONEf_JOIN_IN)
11381                 && mg->mg_type == PERL_MAGIC_backref)
11382             /* when joining, we let the individual SVs add themselves to
11383              * backref as needed. */
11384             continue;
11385
11386         Newx(nmg, 1, MAGIC);
11387         *mgprev_p = nmg;
11388         mgprev_p = &(nmg->mg_moremagic);
11389
11390         /* There was a comment "XXX copy dynamic vtable?" but as we don't have
11391            dynamic vtables, I'm not sure why Sarathy wrote it. The comment dates
11392            from the original commit adding Perl_mg_dup() - revision 4538.
11393            Similarly there is the annotation "XXX random ptr?" next to the
11394            assignment to nmg->mg_ptr.  */
11395         *nmg = *mg;
11396
11397         /* FIXME for plugins
11398         if (nmg->mg_type == PERL_MAGIC_qr) {
11399             nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)nmg->mg_obj, param));
11400         }
11401         else
11402         */
11403         nmg->mg_obj = (nmg->mg_flags & MGf_REFCOUNTED)
11404                           ? nmg->mg_type == PERL_MAGIC_backref
11405                                 /* The backref AV has its reference
11406                                  * count deliberately bumped by 1 */
11407                                 ? SvREFCNT_inc(av_dup_inc((const AV *)
11408                                                     nmg->mg_obj, param))
11409                                 : sv_dup_inc(nmg->mg_obj, param)
11410                           : sv_dup(nmg->mg_obj, param);
11411
11412         if (nmg->mg_ptr && nmg->mg_type != PERL_MAGIC_regex_global) {
11413             if (nmg->mg_len > 0) {
11414                 nmg->mg_ptr     = SAVEPVN(nmg->mg_ptr, nmg->mg_len);
11415                 if (nmg->mg_type == PERL_MAGIC_overload_table &&
11416                         AMT_AMAGIC((AMT*)nmg->mg_ptr))
11417                 {
11418                     AMT * const namtp = (AMT*)nmg->mg_ptr;
11419                     sv_dup_inc_multiple((SV**)(namtp->table),
11420                                         (SV**)(namtp->table), NofAMmeth, param);
11421                 }
11422             }
11423             else if (nmg->mg_len == HEf_SVKEY)
11424                 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)nmg->mg_ptr, param);
11425         }
11426         if ((nmg->mg_flags & MGf_DUP) && nmg->mg_virtual && nmg->mg_virtual->svt_dup) {
11427             nmg->mg_virtual->svt_dup(aTHX_ nmg, param);
11428         }
11429     }
11430     return mgret;
11431 }
11432
11433 #endif /* USE_ITHREADS */
11434
11435 struct ptr_tbl_arena {
11436     struct ptr_tbl_arena *next;
11437     struct ptr_tbl_ent array[1023/3]; /* as ptr_tbl_ent has 3 pointers.  */
11438 };
11439
11440 /* create a new pointer-mapping table */
11441
11442 PTR_TBL_t *
11443 Perl_ptr_table_new(pTHX)
11444 {
11445     PTR_TBL_t *tbl;
11446     PERL_UNUSED_CONTEXT;
11447
11448     Newx(tbl, 1, PTR_TBL_t);
11449     tbl->tbl_max        = 511;
11450     tbl->tbl_items      = 0;
11451     tbl->tbl_arena      = NULL;
11452     tbl->tbl_arena_next = NULL;
11453     tbl->tbl_arena_end  = NULL;
11454     Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
11455     return tbl;
11456 }
11457
11458 #define PTR_TABLE_HASH(ptr) \
11459   ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
11460
11461 /* map an existing pointer using a table */
11462
11463 STATIC PTR_TBL_ENT_t *
11464 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
11465 {
11466     PTR_TBL_ENT_t *tblent;
11467     const UV hash = PTR_TABLE_HASH(sv);
11468
11469     PERL_ARGS_ASSERT_PTR_TABLE_FIND;
11470
11471     tblent = tbl->tbl_ary[hash & tbl->tbl_max];
11472     for (; tblent; tblent = tblent->next) {
11473         if (tblent->oldval == sv)
11474             return tblent;
11475     }
11476     return NULL;
11477 }
11478
11479 void *
11480 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
11481 {
11482     PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
11483
11484     PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
11485     PERL_UNUSED_CONTEXT;
11486
11487     return tblent ? tblent->newval : NULL;
11488 }
11489
11490 /* add a new entry to a pointer-mapping table */
11491
11492 void
11493 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
11494 {
11495     PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
11496
11497     PERL_ARGS_ASSERT_PTR_TABLE_STORE;
11498     PERL_UNUSED_CONTEXT;
11499
11500     if (tblent) {
11501         tblent->newval = newsv;
11502     } else {
11503         const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
11504
11505         if (tbl->tbl_arena_next == tbl->tbl_arena_end) {
11506             struct ptr_tbl_arena *new_arena;
11507
11508             Newx(new_arena, 1, struct ptr_tbl_arena);
11509             new_arena->next = tbl->tbl_arena;
11510             tbl->tbl_arena = new_arena;
11511             tbl->tbl_arena_next = new_arena->array;
11512             tbl->tbl_arena_end = new_arena->array
11513                 + sizeof(new_arena->array) / sizeof(new_arena->array[0]);
11514         }
11515
11516         tblent = tbl->tbl_arena_next++;
11517
11518         tblent->oldval = oldsv;
11519         tblent->newval = newsv;
11520         tblent->next = tbl->tbl_ary[entry];
11521         tbl->tbl_ary[entry] = tblent;
11522         tbl->tbl_items++;
11523         if (tblent->next && tbl->tbl_items > tbl->tbl_max)
11524             ptr_table_split(tbl);
11525     }
11526 }
11527
11528 /* double the hash bucket size of an existing ptr table */
11529
11530 void
11531 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
11532 {
11533     PTR_TBL_ENT_t **ary = tbl->tbl_ary;
11534     const UV oldsize = tbl->tbl_max + 1;
11535     UV newsize = oldsize * 2;
11536     UV i;
11537
11538     PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
11539     PERL_UNUSED_CONTEXT;
11540
11541     Renew(ary, newsize, PTR_TBL_ENT_t*);
11542     Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
11543     tbl->tbl_max = --newsize;
11544     tbl->tbl_ary = ary;
11545     for (i=0; i < oldsize; i++, ary++) {
11546         PTR_TBL_ENT_t **entp = ary;
11547         PTR_TBL_ENT_t *ent = *ary;
11548         PTR_TBL_ENT_t **curentp;
11549         if (!ent)
11550             continue;
11551         curentp = ary + oldsize;
11552         do {
11553             if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
11554                 *entp = ent->next;
11555                 ent->next = *curentp;
11556                 *curentp = ent;
11557             }
11558             else
11559                 entp = &ent->next;
11560             ent = *entp;
11561         } while (ent);
11562     }
11563 }
11564
11565 /* remove all the entries from a ptr table */
11566 /* Deprecated - will be removed post 5.14 */
11567
11568 void
11569 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
11570 {
11571     if (tbl && tbl->tbl_items) {
11572         struct ptr_tbl_arena *arena = tbl->tbl_arena;
11573
11574         Zero(tbl->tbl_ary, tbl->tbl_max + 1, struct ptr_tbl_ent **);
11575
11576         while (arena) {
11577             struct ptr_tbl_arena *next = arena->next;
11578
11579             Safefree(arena);
11580             arena = next;
11581         };
11582
11583         tbl->tbl_items = 0;
11584         tbl->tbl_arena = NULL;
11585         tbl->tbl_arena_next = NULL;
11586         tbl->tbl_arena_end = NULL;
11587     }
11588 }
11589
11590 /* clear and free a ptr table */
11591
11592 void
11593 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
11594 {
11595     struct ptr_tbl_arena *arena;
11596
11597     if (!tbl) {
11598         return;
11599     }
11600
11601     arena = tbl->tbl_arena;
11602
11603     while (arena) {
11604         struct ptr_tbl_arena *next = arena->next;
11605
11606         Safefree(arena);
11607         arena = next;
11608     }
11609
11610     Safefree(tbl->tbl_ary);
11611     Safefree(tbl);
11612 }
11613
11614 #if defined(USE_ITHREADS)
11615
11616 void
11617 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
11618 {
11619     PERL_ARGS_ASSERT_RVPV_DUP;
11620
11621     if (SvROK(sstr)) {
11622         if (SvWEAKREF(sstr)) {
11623             SvRV_set(dstr, sv_dup(SvRV_const(sstr), param));
11624             if (param->flags & CLONEf_JOIN_IN) {
11625                 /* if joining, we add any back references individually rather
11626                  * than copying the whole backref array */
11627                 Perl_sv_add_backref(aTHX_ SvRV(dstr), dstr);
11628             }
11629         }
11630         else
11631             SvRV_set(dstr, sv_dup_inc(SvRV_const(sstr), param));
11632     }
11633     else if (SvPVX_const(sstr)) {
11634         /* Has something there */
11635         if (SvLEN(sstr)) {
11636             /* Normal PV - clone whole allocated space */
11637             SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
11638             if (SvREADONLY(sstr) && SvFAKE(sstr)) {
11639                 /* Not that normal - actually sstr is copy on write.
11640                    But we are a true, independent SV, so:  */
11641                 SvREADONLY_off(dstr);
11642                 SvFAKE_off(dstr);
11643             }
11644         }
11645         else {
11646             /* Special case - not normally malloced for some reason */
11647             if (isGV_with_GP(sstr)) {
11648                 /* Don't need to do anything here.  */
11649             }
11650             else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
11651                 /* A "shared" PV - clone it as "shared" PV */
11652                 SvPV_set(dstr,
11653                          HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
11654                                          param)));
11655             }
11656             else {
11657                 /* Some other special case - random pointer */
11658                 SvPV_set(dstr, (char *) SvPVX_const(sstr));
11659             }
11660         }
11661     }
11662     else {
11663         /* Copy the NULL */
11664         SvPV_set(dstr, NULL);
11665     }
11666 }
11667
11668 /* duplicate a list of SVs. source and dest may point to the same memory.  */
11669 static SV **
11670 S_sv_dup_inc_multiple(pTHX_ SV *const *source, SV **dest,
11671                       SSize_t items, CLONE_PARAMS *const param)
11672 {
11673     PERL_ARGS_ASSERT_SV_DUP_INC_MULTIPLE;
11674
11675     while (items-- > 0) {
11676         *dest++ = sv_dup_inc(*source++, param);
11677     }
11678
11679     return dest;
11680 }
11681
11682 /* duplicate an SV of any type (including AV, HV etc) */
11683
11684 static SV *
11685 S_sv_dup_common(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
11686 {
11687     dVAR;
11688     SV *dstr;
11689
11690     PERL_ARGS_ASSERT_SV_DUP_COMMON;
11691
11692     if (SvTYPE(sstr) == SVTYPEMASK) {
11693 #ifdef DEBUG_LEAKING_SCALARS_ABORT
11694         abort();
11695 #endif
11696         return NULL;
11697     }
11698     /* look for it in the table first */
11699     dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
11700     if (dstr)
11701         return dstr;
11702
11703     if(param->flags & CLONEf_JOIN_IN) {
11704         /** We are joining here so we don't want do clone
11705             something that is bad **/
11706         if (SvTYPE(sstr) == SVt_PVHV) {
11707             const HEK * const hvname = HvNAME_HEK(sstr);
11708             if (hvname) {
11709                 /** don't clone stashes if they already exist **/
11710                 dstr = MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0));
11711                 ptr_table_store(PL_ptr_table, sstr, dstr);
11712                 return dstr;
11713             }
11714         }
11715     }
11716
11717     /* create anew and remember what it is */
11718     new_SV(dstr);
11719
11720 #ifdef DEBUG_LEAKING_SCALARS
11721     dstr->sv_debug_optype = sstr->sv_debug_optype;
11722     dstr->sv_debug_line = sstr->sv_debug_line;
11723     dstr->sv_debug_inpad = sstr->sv_debug_inpad;
11724     dstr->sv_debug_parent = (SV*)sstr;
11725     FREE_SV_DEBUG_FILE(dstr);
11726     dstr->sv_debug_file = savepv(sstr->sv_debug_file);
11727 #endif
11728
11729     ptr_table_store(PL_ptr_table, sstr, dstr);
11730
11731     /* clone */
11732     SvFLAGS(dstr)       = SvFLAGS(sstr);
11733     SvFLAGS(dstr)       &= ~SVf_OOK;            /* don't propagate OOK hack */
11734     SvREFCNT(dstr)      = 0;                    /* must be before any other dups! */
11735
11736 #ifdef DEBUGGING
11737     if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
11738         PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
11739                       (void*)PL_watch_pvx, SvPVX_const(sstr));
11740 #endif
11741
11742     /* don't clone objects whose class has asked us not to */
11743     if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
11744         SvFLAGS(dstr) = 0;
11745         return dstr;
11746     }
11747
11748     switch (SvTYPE(sstr)) {
11749     case SVt_NULL:
11750         SvANY(dstr)     = NULL;
11751         break;
11752     case SVt_IV:
11753         SvANY(dstr)     = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
11754         if(SvROK(sstr)) {
11755             Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11756         } else {
11757             SvIV_set(dstr, SvIVX(sstr));
11758         }
11759         break;
11760     case SVt_NV:
11761         SvANY(dstr)     = new_XNV();
11762         SvNV_set(dstr, SvNVX(sstr));
11763         break;
11764         /* case SVt_BIND: */
11765     default:
11766         {
11767             /* These are all the types that need complex bodies allocating.  */
11768             void *new_body;
11769             const svtype sv_type = SvTYPE(sstr);
11770             const struct body_details *const sv_type_details
11771                 = bodies_by_type + sv_type;
11772
11773             switch (sv_type) {
11774             default:
11775                 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11776                 break;
11777
11778             case SVt_PVGV:
11779             case SVt_PVIO:
11780             case SVt_PVFM:
11781             case SVt_PVHV:
11782             case SVt_PVAV:
11783             case SVt_PVCV:
11784             case SVt_PVLV:
11785             case SVt_REGEXP:
11786             case SVt_PVMG:
11787             case SVt_PVNV:
11788             case SVt_PVIV:
11789             case SVt_PV:
11790                 assert(sv_type_details->body_size);
11791                 if (sv_type_details->arena) {
11792                     new_body_inline(new_body, sv_type);
11793                     new_body
11794                         = (void*)((char*)new_body - sv_type_details->offset);
11795                 } else {
11796                     new_body = new_NOARENA(sv_type_details);
11797                 }
11798             }
11799             assert(new_body);
11800             SvANY(dstr) = new_body;
11801
11802 #ifndef PURIFY
11803             Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
11804                  ((char*)SvANY(dstr)) + sv_type_details->offset,
11805                  sv_type_details->copy, char);
11806 #else
11807             Copy(((char*)SvANY(sstr)),
11808                  ((char*)SvANY(dstr)),
11809                  sv_type_details->body_size + sv_type_details->offset, char);
11810 #endif
11811
11812             if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
11813                 && !isGV_with_GP(dstr)
11814                 && !(sv_type == SVt_PVIO && !(IoFLAGS(dstr) & IOf_FAKE_DIRP)))
11815                 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11816
11817             /* The Copy above means that all the source (unduplicated) pointers
11818                are now in the destination.  We can check the flags and the
11819                pointers in either, but it's possible that there's less cache
11820                missing by always going for the destination.
11821                FIXME - instrument and check that assumption  */
11822             if (sv_type >= SVt_PVMG) {
11823                 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
11824                     SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
11825                 } else if (SvMAGIC(dstr))
11826                     SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
11827                 if (SvSTASH(dstr))
11828                     SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
11829             }
11830
11831             /* The cast silences a GCC warning about unhandled types.  */
11832             switch ((int)sv_type) {
11833             case SVt_PV:
11834                 break;
11835             case SVt_PVIV:
11836                 break;
11837             case SVt_PVNV:
11838                 break;
11839             case SVt_PVMG:
11840                 break;
11841             case SVt_REGEXP:
11842                 /* FIXME for plugins */
11843                 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
11844                 break;
11845             case SVt_PVLV:
11846                 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
11847                 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
11848                     LvTARG(dstr) = dstr;
11849                 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
11850                     LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
11851                 else
11852                     LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
11853             case SVt_PVGV:
11854                 /* non-GP case already handled above */
11855                 if(isGV_with_GP(sstr)) {
11856                     GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
11857                     /* Don't call sv_add_backref here as it's going to be
11858                        created as part of the magic cloning of the symbol
11859                        table--unless this is during a join and the stash
11860                        is not actually being cloned.  */
11861                     /* Danger Will Robinson - GvGP(dstr) isn't initialised
11862                        at the point of this comment.  */
11863                     GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
11864                     if (param->flags & CLONEf_JOIN_IN)
11865                         Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
11866                     GvGP_set(dstr, gp_dup(GvGP(sstr), param));
11867                     (void)GpREFCNT_inc(GvGP(dstr));
11868                 }
11869                 break;
11870             case SVt_PVIO:
11871                 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
11872                 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
11873                     /* I have no idea why fake dirp (rsfps)
11874                        should be treated differently but otherwise
11875                        we end up with leaks -- sky*/
11876                     IoTOP_GV(dstr)      = gv_dup_inc(IoTOP_GV(dstr), param);
11877                     IoFMT_GV(dstr)      = gv_dup_inc(IoFMT_GV(dstr), param);
11878                     IoBOTTOM_GV(dstr)   = gv_dup_inc(IoBOTTOM_GV(dstr), param);
11879                 } else {
11880                     IoTOP_GV(dstr)      = gv_dup(IoTOP_GV(dstr), param);
11881                     IoFMT_GV(dstr)      = gv_dup(IoFMT_GV(dstr), param);
11882                     IoBOTTOM_GV(dstr)   = gv_dup(IoBOTTOM_GV(dstr), param);
11883                     if (IoDIRP(dstr)) {
11884                         IoDIRP(dstr)    = dirp_dup(IoDIRP(dstr), param);
11885                     } else {
11886                         NOOP;
11887                         /* IoDIRP(dstr) is already a copy of IoDIRP(sstr)  */
11888                     }
11889                     IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(dstr), param);
11890                 }
11891                 if (IoOFP(dstr) == IoIFP(sstr))
11892                     IoOFP(dstr) = IoIFP(dstr);
11893                 else
11894                     IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
11895                 IoTOP_NAME(dstr)        = SAVEPV(IoTOP_NAME(dstr));
11896                 IoFMT_NAME(dstr)        = SAVEPV(IoFMT_NAME(dstr));
11897                 IoBOTTOM_NAME(dstr)     = SAVEPV(IoBOTTOM_NAME(dstr));
11898                 break;
11899             case SVt_PVAV:
11900                 /* avoid cloning an empty array */
11901                 if (AvARRAY((const AV *)sstr) && AvFILLp((const AV *)sstr) >= 0) {
11902                     SV **dst_ary, **src_ary;
11903                     SSize_t items = AvFILLp((const AV *)sstr) + 1;
11904
11905                     src_ary = AvARRAY((const AV *)sstr);
11906                     Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
11907                     ptr_table_store(PL_ptr_table, src_ary, dst_ary);
11908                     AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
11909                     AvALLOC((const AV *)dstr) = dst_ary;
11910                     if (AvREAL((const AV *)sstr)) {
11911                         dst_ary = sv_dup_inc_multiple(src_ary, dst_ary, items,
11912                                                       param);
11913                     }
11914                     else {
11915                         while (items-- > 0)
11916                             *dst_ary++ = sv_dup(*src_ary++, param);
11917                     }
11918                     items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
11919                     while (items-- > 0) {
11920                         *dst_ary++ = &PL_sv_undef;
11921                     }
11922                 }
11923                 else {
11924                     AvARRAY(MUTABLE_AV(dstr))   = NULL;
11925                     AvALLOC((const AV *)dstr)   = (SV**)NULL;
11926                     AvMAX(  (const AV *)dstr)   = -1;
11927                     AvFILLp((const AV *)dstr)   = -1;
11928                 }
11929                 break;
11930             case SVt_PVHV:
11931                 if (HvARRAY((const HV *)sstr)) {
11932                     STRLEN i = 0;
11933                     const bool sharekeys = !!HvSHAREKEYS(sstr);
11934                     XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
11935                     XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
11936                     char *darray;
11937                     Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
11938                         + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
11939                         char);
11940                     HvARRAY(dstr) = (HE**)darray;
11941                     while (i <= sxhv->xhv_max) {
11942                         const HE * const source = HvARRAY(sstr)[i];
11943                         HvARRAY(dstr)[i] = source
11944                             ? he_dup(source, sharekeys, param) : 0;
11945                         ++i;
11946                     }
11947                     if (SvOOK(sstr)) {
11948                         const struct xpvhv_aux * const saux = HvAUX(sstr);
11949                         struct xpvhv_aux * const daux = HvAUX(dstr);
11950                         /* This flag isn't copied.  */
11951                         /* SvOOK_on(hv) attacks the IV flags.  */
11952                         SvFLAGS(dstr) |= SVf_OOK;
11953
11954                         if (saux->xhv_name_count) {
11955                             HEK ** const sname = saux->xhv_name_u.xhvnameu_names;
11956                             const I32 count
11957                              = saux->xhv_name_count < 0
11958                                 ? -saux->xhv_name_count
11959                                 :  saux->xhv_name_count;
11960                             HEK **shekp = sname + count;
11961                             HEK **dhekp;
11962                             Newx(daux->xhv_name_u.xhvnameu_names, count, HEK *);
11963                             dhekp = daux->xhv_name_u.xhvnameu_names + count;
11964                             while (shekp-- > sname) {
11965                                 dhekp--;
11966                                 *dhekp = hek_dup(*shekp, param);
11967                             }
11968                         }
11969                         else {
11970                             daux->xhv_name_u.xhvnameu_name
11971                                 = hek_dup(saux->xhv_name_u.xhvnameu_name,
11972                                           param);
11973                         }
11974                         daux->xhv_name_count = saux->xhv_name_count;
11975
11976                         daux->xhv_riter = saux->xhv_riter;
11977                         daux->xhv_eiter = saux->xhv_eiter
11978                             ? he_dup(saux->xhv_eiter,
11979                                         cBOOL(HvSHAREKEYS(sstr)), param) : 0;
11980                         /* backref array needs refcnt=2; see sv_add_backref */
11981                         daux->xhv_backreferences =
11982                             (param->flags & CLONEf_JOIN_IN)
11983                                 /* when joining, we let the individual GVs and
11984                                  * CVs add themselves to backref as
11985                                  * needed. This avoids pulling in stuff
11986                                  * that isn't required, and simplifies the
11987                                  * case where stashes aren't cloned back
11988                                  * if they already exist in the parent
11989                                  * thread */
11990                             ? NULL
11991                             : saux->xhv_backreferences
11992                                 ? (SvTYPE(saux->xhv_backreferences) == SVt_PVAV)
11993                                     ? MUTABLE_AV(SvREFCNT_inc(
11994                                           sv_dup_inc((const SV *)
11995                                             saux->xhv_backreferences, param)))
11996                                     : MUTABLE_AV(sv_dup((const SV *)
11997                                             saux->xhv_backreferences, param))
11998                                 : 0;
11999
12000                         daux->xhv_mro_meta = saux->xhv_mro_meta
12001                             ? mro_meta_dup(saux->xhv_mro_meta, param)
12002                             : 0;
12003
12004                         /* Record stashes for possible cloning in Perl_clone(). */
12005                         if (HvNAME(sstr))
12006                             av_push(param->stashes, dstr);
12007                     }
12008                 }
12009                 else
12010                     HvARRAY(MUTABLE_HV(dstr)) = NULL;
12011                 break;
12012             case SVt_PVCV:
12013                 if (!(param->flags & CLONEf_COPY_STACKS)) {
12014                     CvDEPTH(dstr) = 0;
12015                 }
12016                 /*FALLTHROUGH*/
12017             case SVt_PVFM:
12018                 /* NOTE: not refcounted */
12019                 SvANY(MUTABLE_CV(dstr))->xcv_stash =
12020                     hv_dup(CvSTASH(dstr), param);
12021                 if ((param->flags & CLONEf_JOIN_IN) && CvSTASH(dstr))
12022                     Perl_sv_add_backref(aTHX_ MUTABLE_SV(CvSTASH(dstr)), dstr);
12023                 if (!CvISXSUB(dstr)) {
12024                     OP_REFCNT_LOCK;
12025                     CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
12026                     OP_REFCNT_UNLOCK;
12027                     CvFILE(dstr) = SAVEPV(CvFILE(dstr));
12028                 } else if (CvCONST(dstr)) {
12029                     CvXSUBANY(dstr).any_ptr =
12030                         sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
12031                 }
12032                 /* don't dup if copying back - CvGV isn't refcounted, so the
12033                  * duped GV may never be freed. A bit of a hack! DAPM */
12034                 SvANY(MUTABLE_CV(dstr))->xcv_gv =
12035                     CvCVGV_RC(dstr)
12036                     ? gv_dup_inc(CvGV(sstr), param)
12037                     : (param->flags & CLONEf_JOIN_IN)
12038                         ? NULL
12039                         : gv_dup(CvGV(sstr), param);
12040
12041                 CvPADLIST(dstr) = padlist_dup(CvPADLIST(sstr), param);
12042                 CvOUTSIDE(dstr) =
12043                     CvWEAKOUTSIDE(sstr)
12044                     ? cv_dup(    CvOUTSIDE(dstr), param)
12045                     : cv_dup_inc(CvOUTSIDE(dstr), param);
12046                 break;
12047             }
12048         }
12049     }
12050
12051     if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
12052         ++PL_sv_objcount;
12053
12054     return dstr;
12055  }
12056
12057 SV *
12058 Perl_sv_dup_inc(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12059 {
12060     PERL_ARGS_ASSERT_SV_DUP_INC;
12061     return sstr ? SvREFCNT_inc(sv_dup_common(sstr, param)) : NULL;
12062 }
12063
12064 SV *
12065 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12066 {
12067     SV *dstr = sstr ? sv_dup_common(sstr, param) : NULL;
12068     PERL_ARGS_ASSERT_SV_DUP;
12069
12070     /* Track every SV that (at least initially) had a reference count of 0.
12071        We need to do this by holding an actual reference to it in this array.
12072        If we attempt to cheat, turn AvREAL_off(), and store only pointers
12073        (akin to the stashes hash, and the perl stack), we come unstuck if
12074        a weak reference (or other SV legitimately SvREFCNT() == 0 for this
12075        thread) is manipulated in a CLONE method, because CLONE runs before the
12076        unreferenced array is walked to find SVs still with SvREFCNT() == 0
12077        (and fix things up by giving each a reference via the temps stack).
12078        Instead, during CLONE, if the 0-referenced SV has SvREFCNT_inc() and
12079        then SvREFCNT_dec(), it will be cleaned up (and added to the free list)
12080        before the walk of unreferenced happens and a reference to that is SV
12081        added to the temps stack. At which point we have the same SV considered
12082        to be in use, and free to be re-used. Not good.
12083     */
12084     if (dstr && !(param->flags & CLONEf_COPY_STACKS) && !SvREFCNT(dstr)) {
12085         assert(param->unreferenced);
12086         av_push(param->unreferenced, SvREFCNT_inc(dstr));
12087     }
12088
12089     return dstr;
12090 }
12091
12092 /* duplicate a context */
12093
12094 PERL_CONTEXT *
12095 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
12096 {
12097     PERL_CONTEXT *ncxs;
12098
12099     PERL_ARGS_ASSERT_CX_DUP;
12100
12101     if (!cxs)
12102         return (PERL_CONTEXT*)NULL;
12103
12104     /* look for it in the table first */
12105     ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
12106     if (ncxs)
12107         return ncxs;
12108
12109     /* create anew and remember what it is */
12110     Newx(ncxs, max + 1, PERL_CONTEXT);
12111     ptr_table_store(PL_ptr_table, cxs, ncxs);
12112     Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
12113
12114     while (ix >= 0) {
12115         PERL_CONTEXT * const ncx = &ncxs[ix];
12116         if (CxTYPE(ncx) == CXt_SUBST) {
12117             Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
12118         }
12119         else {
12120             switch (CxTYPE(ncx)) {
12121             case CXt_SUB:
12122                 ncx->blk_sub.cv         = (ncx->blk_sub.olddepth == 0
12123                                            ? cv_dup_inc(ncx->blk_sub.cv, param)
12124                                            : cv_dup(ncx->blk_sub.cv,param));
12125                 ncx->blk_sub.argarray   = (CxHASARGS(ncx)
12126                                            ? av_dup_inc(ncx->blk_sub.argarray,
12127                                                         param)
12128                                            : NULL);
12129                 ncx->blk_sub.savearray  = av_dup_inc(ncx->blk_sub.savearray,
12130                                                      param);
12131                 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
12132                                            ncx->blk_sub.oldcomppad);
12133                 break;
12134             case CXt_EVAL:
12135                 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
12136                                                       param);
12137                 ncx->blk_eval.cur_text  = sv_dup(ncx->blk_eval.cur_text, param);
12138                 break;
12139             case CXt_LOOP_LAZYSV:
12140                 ncx->blk_loop.state_u.lazysv.end
12141                     = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
12142                 /* We are taking advantage of av_dup_inc and sv_dup_inc
12143                    actually being the same function, and order equivalence of
12144                    the two unions.
12145                    We can assert the later [but only at run time :-(]  */
12146                 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
12147                         (void *) &ncx->blk_loop.state_u.lazysv.cur);
12148             case CXt_LOOP_FOR:
12149                 ncx->blk_loop.state_u.ary.ary
12150                     = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
12151             case CXt_LOOP_LAZYIV:
12152             case CXt_LOOP_PLAIN:
12153                 if (CxPADLOOP(ncx)) {
12154                     ncx->blk_loop.itervar_u.oldcomppad
12155                         = (PAD*)ptr_table_fetch(PL_ptr_table,
12156                                         ncx->blk_loop.itervar_u.oldcomppad);
12157                 } else {
12158                     ncx->blk_loop.itervar_u.gv
12159                         = gv_dup((const GV *)ncx->blk_loop.itervar_u.gv,
12160                                     param);
12161                 }
12162                 break;
12163             case CXt_FORMAT:
12164                 ncx->blk_format.cv      = cv_dup(ncx->blk_format.cv, param);
12165                 ncx->blk_format.gv      = gv_dup(ncx->blk_format.gv, param);
12166                 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
12167                                                      param);
12168                 break;
12169             case CXt_BLOCK:
12170             case CXt_NULL:
12171                 break;
12172             }
12173         }
12174         --ix;
12175     }
12176     return ncxs;
12177 }
12178
12179 /* duplicate a stack info structure */
12180
12181 PERL_SI *
12182 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
12183 {
12184     PERL_SI *nsi;
12185
12186     PERL_ARGS_ASSERT_SI_DUP;
12187
12188     if (!si)
12189         return (PERL_SI*)NULL;
12190
12191     /* look for it in the table first */
12192     nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
12193     if (nsi)
12194         return nsi;
12195
12196     /* create anew and remember what it is */
12197     Newxz(nsi, 1, PERL_SI);
12198     ptr_table_store(PL_ptr_table, si, nsi);
12199
12200     nsi->si_stack       = av_dup_inc(si->si_stack, param);
12201     nsi->si_cxix        = si->si_cxix;
12202     nsi->si_cxmax       = si->si_cxmax;
12203     nsi->si_cxstack     = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
12204     nsi->si_type        = si->si_type;
12205     nsi->si_prev        = si_dup(si->si_prev, param);
12206     nsi->si_next        = si_dup(si->si_next, param);
12207     nsi->si_markoff     = si->si_markoff;
12208
12209     return nsi;
12210 }
12211
12212 #define POPINT(ss,ix)   ((ss)[--(ix)].any_i32)
12213 #define TOPINT(ss,ix)   ((ss)[ix].any_i32)
12214 #define POPLONG(ss,ix)  ((ss)[--(ix)].any_long)
12215 #define TOPLONG(ss,ix)  ((ss)[ix].any_long)
12216 #define POPIV(ss,ix)    ((ss)[--(ix)].any_iv)
12217 #define TOPIV(ss,ix)    ((ss)[ix].any_iv)
12218 #define POPUV(ss,ix)    ((ss)[--(ix)].any_uv)
12219 #define TOPUV(ss,ix)    ((ss)[ix].any_uv)
12220 #define POPBOOL(ss,ix)  ((ss)[--(ix)].any_bool)
12221 #define TOPBOOL(ss,ix)  ((ss)[ix].any_bool)
12222 #define POPPTR(ss,ix)   ((ss)[--(ix)].any_ptr)
12223 #define TOPPTR(ss,ix)   ((ss)[ix].any_ptr)
12224 #define POPDPTR(ss,ix)  ((ss)[--(ix)].any_dptr)
12225 #define TOPDPTR(ss,ix)  ((ss)[ix].any_dptr)
12226 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
12227 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
12228
12229 /* XXXXX todo */
12230 #define pv_dup_inc(p)   SAVEPV(p)
12231 #define pv_dup(p)       SAVEPV(p)
12232 #define svp_dup_inc(p,pp)       any_dup(p,pp)
12233
12234 /* map any object to the new equivent - either something in the
12235  * ptr table, or something in the interpreter structure
12236  */
12237
12238 void *
12239 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
12240 {
12241     void *ret;
12242
12243     PERL_ARGS_ASSERT_ANY_DUP;
12244
12245     if (!v)
12246         return (void*)NULL;
12247
12248     /* look for it in the table first */
12249     ret = ptr_table_fetch(PL_ptr_table, v);
12250     if (ret)
12251         return ret;
12252
12253     /* see if it is part of the interpreter structure */
12254     if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
12255         ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
12256     else {
12257         ret = v;
12258     }
12259
12260     return ret;
12261 }
12262
12263 /* duplicate the save stack */
12264
12265 ANY *
12266 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
12267 {
12268     dVAR;
12269     ANY * const ss      = proto_perl->Isavestack;
12270     const I32 max       = proto_perl->Isavestack_max;
12271     I32 ix              = proto_perl->Isavestack_ix;
12272     ANY *nss;
12273     const SV *sv;
12274     const GV *gv;
12275     const AV *av;
12276     const HV *hv;
12277     void* ptr;
12278     int intval;
12279     long longval;
12280     GP *gp;
12281     IV iv;
12282     I32 i;
12283     char *c = NULL;
12284     void (*dptr) (void*);
12285     void (*dxptr) (pTHX_ void*);
12286
12287     PERL_ARGS_ASSERT_SS_DUP;
12288
12289     Newxz(nss, max, ANY);
12290
12291     while (ix > 0) {
12292         const UV uv = POPUV(ss,ix);
12293         const U8 type = (U8)uv & SAVE_MASK;
12294
12295         TOPUV(nss,ix) = uv;
12296         switch (type) {
12297         case SAVEt_CLEARSV:
12298             break;
12299         case SAVEt_HELEM:               /* hash element */
12300             sv = (const SV *)POPPTR(ss,ix);
12301             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12302             /* fall through */
12303         case SAVEt_ITEM:                        /* normal string */
12304         case SAVEt_GVSV:                        /* scalar slot in GV */
12305         case SAVEt_SV:                          /* scalar reference */
12306             sv = (const SV *)POPPTR(ss,ix);
12307             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12308             /* fall through */
12309         case SAVEt_FREESV:
12310         case SAVEt_MORTALIZESV:
12311             sv = (const SV *)POPPTR(ss,ix);
12312             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12313             break;
12314         case SAVEt_SHARED_PVREF:                /* char* in shared space */
12315             c = (char*)POPPTR(ss,ix);
12316             TOPPTR(nss,ix) = savesharedpv(c);
12317             ptr = POPPTR(ss,ix);
12318             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12319             break;
12320         case SAVEt_GENERIC_SVREF:               /* generic sv */
12321         case SAVEt_SVREF:                       /* scalar reference */
12322             sv = (const SV *)POPPTR(ss,ix);
12323             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12324             ptr = POPPTR(ss,ix);
12325             TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
12326             break;
12327         case SAVEt_HV:                          /* hash reference */
12328         case SAVEt_AV:                          /* array reference */
12329             sv = (const SV *) POPPTR(ss,ix);
12330             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12331             /* fall through */
12332         case SAVEt_COMPPAD:
12333         case SAVEt_NSTAB:
12334             sv = (const SV *) POPPTR(ss,ix);
12335             TOPPTR(nss,ix) = sv_dup(sv, param);
12336             break;
12337         case SAVEt_INT:                         /* int reference */
12338             ptr = POPPTR(ss,ix);
12339             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12340             intval = (int)POPINT(ss,ix);
12341             TOPINT(nss,ix) = intval;
12342             break;
12343         case SAVEt_LONG:                        /* long reference */
12344             ptr = POPPTR(ss,ix);
12345             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12346             longval = (long)POPLONG(ss,ix);
12347             TOPLONG(nss,ix) = longval;
12348             break;
12349         case SAVEt_I32:                         /* I32 reference */
12350         case SAVEt_COP_ARYBASE:                 /* call CopARYBASE_set */
12351             ptr = POPPTR(ss,ix);
12352             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12353             i = POPINT(ss,ix);
12354             TOPINT(nss,ix) = i;
12355             break;
12356         case SAVEt_IV:                          /* IV reference */
12357             ptr = POPPTR(ss,ix);
12358             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12359             iv = POPIV(ss,ix);
12360             TOPIV(nss,ix) = iv;
12361             break;
12362         case SAVEt_HPTR:                        /* HV* reference */
12363         case SAVEt_APTR:                        /* AV* reference */
12364         case SAVEt_SPTR:                        /* SV* reference */
12365             ptr = POPPTR(ss,ix);
12366             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12367             sv = (const SV *)POPPTR(ss,ix);
12368             TOPPTR(nss,ix) = sv_dup(sv, param);
12369             break;
12370         case SAVEt_VPTR:                        /* random* reference */
12371             ptr = POPPTR(ss,ix);
12372             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12373             /* Fall through */
12374         case SAVEt_INT_SMALL:
12375         case SAVEt_I32_SMALL:
12376         case SAVEt_I16:                         /* I16 reference */
12377         case SAVEt_I8:                          /* I8 reference */
12378         case SAVEt_BOOL:
12379             ptr = POPPTR(ss,ix);
12380             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12381             break;
12382         case SAVEt_GENERIC_PVREF:               /* generic char* */
12383         case SAVEt_PPTR:                        /* char* reference */
12384             ptr = POPPTR(ss,ix);
12385             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12386             c = (char*)POPPTR(ss,ix);
12387             TOPPTR(nss,ix) = pv_dup(c);
12388             break;
12389         case SAVEt_GP:                          /* scalar reference */
12390             gp = (GP*)POPPTR(ss,ix);
12391             TOPPTR(nss,ix) = gp = gp_dup(gp, param);
12392             (void)GpREFCNT_inc(gp);
12393             gv = (const GV *)POPPTR(ss,ix);
12394             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
12395             break;
12396         case SAVEt_FREEOP:
12397             ptr = POPPTR(ss,ix);
12398             if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
12399                 /* these are assumed to be refcounted properly */
12400                 OP *o;
12401                 switch (((OP*)ptr)->op_type) {
12402                 case OP_LEAVESUB:
12403                 case OP_LEAVESUBLV:
12404                 case OP_LEAVEEVAL:
12405                 case OP_LEAVE:
12406                 case OP_SCOPE:
12407                 case OP_LEAVEWRITE:
12408                     TOPPTR(nss,ix) = ptr;
12409                     o = (OP*)ptr;
12410                     OP_REFCNT_LOCK;
12411                     (void) OpREFCNT_inc(o);
12412                     OP_REFCNT_UNLOCK;
12413                     break;
12414                 default:
12415                     TOPPTR(nss,ix) = NULL;
12416                     break;
12417                 }
12418             }
12419             else
12420                 TOPPTR(nss,ix) = NULL;
12421             break;
12422         case SAVEt_FREECOPHH:
12423             ptr = POPPTR(ss,ix);
12424             TOPPTR(nss,ix) = cophh_copy((COPHH *)ptr);
12425             break;
12426         case SAVEt_DELETE:
12427             hv = (const HV *)POPPTR(ss,ix);
12428             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12429             i = POPINT(ss,ix);
12430             TOPINT(nss,ix) = i;
12431             /* Fall through */
12432         case SAVEt_FREEPV:
12433             c = (char*)POPPTR(ss,ix);
12434             TOPPTR(nss,ix) = pv_dup_inc(c);
12435             break;
12436         case SAVEt_STACK_POS:           /* Position on Perl stack */
12437             i = POPINT(ss,ix);
12438             TOPINT(nss,ix) = i;
12439             break;
12440         case SAVEt_DESTRUCTOR:
12441             ptr = POPPTR(ss,ix);
12442             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
12443             dptr = POPDPTR(ss,ix);
12444             TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
12445                                         any_dup(FPTR2DPTR(void *, dptr),
12446                                                 proto_perl));
12447             break;
12448         case SAVEt_DESTRUCTOR_X:
12449             ptr = POPPTR(ss,ix);
12450             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
12451             dxptr = POPDXPTR(ss,ix);
12452             TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
12453                                          any_dup(FPTR2DPTR(void *, dxptr),
12454                                                  proto_perl));
12455             break;
12456         case SAVEt_REGCONTEXT:
12457         case SAVEt_ALLOC:
12458             ix -= uv >> SAVE_TIGHT_SHIFT;
12459             break;
12460         case SAVEt_AELEM:               /* array element */
12461             sv = (const SV *)POPPTR(ss,ix);
12462             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12463             i = POPINT(ss,ix);
12464             TOPINT(nss,ix) = i;
12465             av = (const AV *)POPPTR(ss,ix);
12466             TOPPTR(nss,ix) = av_dup_inc(av, param);
12467             break;
12468         case SAVEt_OP:
12469             ptr = POPPTR(ss,ix);
12470             TOPPTR(nss,ix) = ptr;
12471             break;
12472         case SAVEt_HINTS:
12473             ptr = POPPTR(ss,ix);
12474             ptr = cophh_copy((COPHH*)ptr);
12475             TOPPTR(nss,ix) = ptr;
12476             i = POPINT(ss,ix);
12477             TOPINT(nss,ix) = i;
12478             if (i & HINT_LOCALIZE_HH) {
12479                 hv = (const HV *)POPPTR(ss,ix);
12480                 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12481             }
12482             break;
12483         case SAVEt_PADSV_AND_MORTALIZE:
12484             longval = (long)POPLONG(ss,ix);
12485             TOPLONG(nss,ix) = longval;
12486             ptr = POPPTR(ss,ix);
12487             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12488             sv = (const SV *)POPPTR(ss,ix);
12489             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12490             break;
12491         case SAVEt_SET_SVFLAGS:
12492             i = POPINT(ss,ix);
12493             TOPINT(nss,ix) = i;
12494             i = POPINT(ss,ix);
12495             TOPINT(nss,ix) = i;
12496             sv = (const SV *)POPPTR(ss,ix);
12497             TOPPTR(nss,ix) = sv_dup(sv, param);
12498             break;
12499         case SAVEt_RE_STATE:
12500             {
12501                 const struct re_save_state *const old_state
12502                     = (struct re_save_state *)
12503                     (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12504                 struct re_save_state *const new_state
12505                     = (struct re_save_state *)
12506                     (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12507
12508                 Copy(old_state, new_state, 1, struct re_save_state);
12509                 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
12510
12511                 new_state->re_state_bostr
12512                     = pv_dup(old_state->re_state_bostr);
12513                 new_state->re_state_reginput
12514                     = pv_dup(old_state->re_state_reginput);
12515                 new_state->re_state_regeol
12516                     = pv_dup(old_state->re_state_regeol);
12517                 new_state->re_state_regoffs
12518                     = (regexp_paren_pair*)
12519                         any_dup(old_state->re_state_regoffs, proto_perl);
12520                 new_state->re_state_reglastparen
12521                     = (U32*) any_dup(old_state->re_state_reglastparen,
12522                               proto_perl);
12523                 new_state->re_state_reglastcloseparen
12524                     = (U32*)any_dup(old_state->re_state_reglastcloseparen,
12525                               proto_perl);
12526                 /* XXX This just has to be broken. The old save_re_context
12527                    code did SAVEGENERICPV(PL_reg_start_tmp);
12528                    PL_reg_start_tmp is char **.
12529                    Look above to what the dup code does for
12530                    SAVEt_GENERIC_PVREF
12531                    It can never have worked.
12532                    So this is merely a faithful copy of the exiting bug:  */
12533                 new_state->re_state_reg_start_tmp
12534                     = (char **) pv_dup((char *)
12535                                       old_state->re_state_reg_start_tmp);
12536                 /* I assume that it only ever "worked" because no-one called
12537                    (pseudo)fork while the regexp engine had re-entered itself.
12538                 */
12539 #ifdef PERL_OLD_COPY_ON_WRITE
12540                 new_state->re_state_nrs
12541                     = sv_dup(old_state->re_state_nrs, param);
12542 #endif
12543                 new_state->re_state_reg_magic
12544                     = (MAGIC*) any_dup(old_state->re_state_reg_magic,
12545                                proto_perl);
12546                 new_state->re_state_reg_oldcurpm
12547                     = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
12548                               proto_perl);
12549                 new_state->re_state_reg_curpm
12550                     = (PMOP*)  any_dup(old_state->re_state_reg_curpm,
12551                                proto_perl);
12552                 new_state->re_state_reg_oldsaved
12553                     = pv_dup(old_state->re_state_reg_oldsaved);
12554                 new_state->re_state_reg_poscache
12555                     = pv_dup(old_state->re_state_reg_poscache);
12556                 new_state->re_state_reg_starttry
12557                     = pv_dup(old_state->re_state_reg_starttry);
12558                 break;
12559             }
12560         case SAVEt_COMPILE_WARNINGS:
12561             ptr = POPPTR(ss,ix);
12562             TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
12563             break;
12564         case SAVEt_PARSER:
12565             ptr = POPPTR(ss,ix);
12566             TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
12567             break;
12568         default:
12569             Perl_croak(aTHX_
12570                        "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
12571         }
12572     }
12573
12574     return nss;
12575 }
12576
12577
12578 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
12579  * flag to the result. This is done for each stash before cloning starts,
12580  * so we know which stashes want their objects cloned */
12581
12582 static void
12583 do_mark_cloneable_stash(pTHX_ SV *const sv)
12584 {
12585     const HEK * const hvname = HvNAME_HEK((const HV *)sv);
12586     if (hvname) {
12587         GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
12588         SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
12589         if (cloner && GvCV(cloner)) {
12590             dSP;
12591             UV status;
12592
12593             ENTER;
12594             SAVETMPS;
12595             PUSHMARK(SP);
12596             mXPUSHs(newSVhek(hvname));
12597             PUTBACK;
12598             call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
12599             SPAGAIN;
12600             status = POPu;
12601             PUTBACK;
12602             FREETMPS;
12603             LEAVE;
12604             if (status)
12605                 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
12606         }
12607     }
12608 }
12609
12610
12611
12612 /*
12613 =for apidoc perl_clone
12614
12615 Create and return a new interpreter by cloning the current one.
12616
12617 perl_clone takes these flags as parameters:
12618
12619 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
12620 without it we only clone the data and zero the stacks,
12621 with it we copy the stacks and the new perl interpreter is
12622 ready to run at the exact same point as the previous one.
12623 The pseudo-fork code uses COPY_STACKS while the
12624 threads->create doesn't.
12625
12626 CLONEf_KEEP_PTR_TABLE
12627 perl_clone keeps a ptr_table with the pointer of the old
12628 variable as a key and the new variable as a value,
12629 this allows it to check if something has been cloned and not
12630 clone it again but rather just use the value and increase the
12631 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
12632 the ptr_table using the function
12633 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
12634 reason to keep it around is if you want to dup some of your own
12635 variable who are outside the graph perl scans, example of this
12636 code is in threads.xs create
12637
12638 CLONEf_CLONE_HOST
12639 This is a win32 thing, it is ignored on unix, it tells perls
12640 win32host code (which is c++) to clone itself, this is needed on
12641 win32 if you want to run two threads at the same time,
12642 if you just want to do some stuff in a separate perl interpreter
12643 and then throw it away and return to the original one,
12644 you don't need to do anything.
12645
12646 =cut
12647 */
12648
12649 /* XXX the above needs expanding by someone who actually understands it ! */
12650 EXTERN_C PerlInterpreter *
12651 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
12652
12653 PerlInterpreter *
12654 perl_clone(PerlInterpreter *proto_perl, UV flags)
12655 {
12656    dVAR;
12657 #ifdef PERL_IMPLICIT_SYS
12658
12659     PERL_ARGS_ASSERT_PERL_CLONE;
12660
12661    /* perlhost.h so we need to call into it
12662    to clone the host, CPerlHost should have a c interface, sky */
12663
12664    if (flags & CLONEf_CLONE_HOST) {
12665        return perl_clone_host(proto_perl,flags);
12666    }
12667    return perl_clone_using(proto_perl, flags,
12668                             proto_perl->IMem,
12669                             proto_perl->IMemShared,
12670                             proto_perl->IMemParse,
12671                             proto_perl->IEnv,
12672                             proto_perl->IStdIO,
12673                             proto_perl->ILIO,
12674                             proto_perl->IDir,
12675                             proto_perl->ISock,
12676                             proto_perl->IProc);
12677 }
12678
12679 PerlInterpreter *
12680 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
12681                  struct IPerlMem* ipM, struct IPerlMem* ipMS,
12682                  struct IPerlMem* ipMP, struct IPerlEnv* ipE,
12683                  struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
12684                  struct IPerlDir* ipD, struct IPerlSock* ipS,
12685                  struct IPerlProc* ipP)
12686 {
12687     /* XXX many of the string copies here can be optimized if they're
12688      * constants; they need to be allocated as common memory and just
12689      * their pointers copied. */
12690
12691     IV i;
12692     CLONE_PARAMS clone_params;
12693     CLONE_PARAMS* const param = &clone_params;
12694
12695     PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
12696
12697     PERL_ARGS_ASSERT_PERL_CLONE_USING;
12698 #else           /* !PERL_IMPLICIT_SYS */
12699     IV i;
12700     CLONE_PARAMS clone_params;
12701     CLONE_PARAMS* param = &clone_params;
12702     PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
12703
12704     PERL_ARGS_ASSERT_PERL_CLONE;
12705 #endif          /* PERL_IMPLICIT_SYS */
12706
12707     /* for each stash, determine whether its objects should be cloned */
12708     S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
12709     PERL_SET_THX(my_perl);
12710
12711 #ifdef DEBUGGING
12712     PoisonNew(my_perl, 1, PerlInterpreter);
12713     PL_op = NULL;
12714     PL_curcop = NULL;
12715     PL_defstash = NULL; /* may be used by perl malloc() */
12716     PL_markstack = 0;
12717     PL_scopestack = 0;
12718     PL_scopestack_name = 0;
12719     PL_savestack = 0;
12720     PL_savestack_ix = 0;
12721     PL_savestack_max = -1;
12722     PL_sig_pending = 0;
12723     PL_parser = NULL;
12724     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
12725 #  ifdef DEBUG_LEAKING_SCALARS
12726     PL_sv_serial = (((UV)my_perl >> 2) & 0xfff) * 1000000;
12727 #  endif
12728 #else   /* !DEBUGGING */
12729     Zero(my_perl, 1, PerlInterpreter);
12730 #endif  /* DEBUGGING */
12731
12732 #ifdef PERL_IMPLICIT_SYS
12733     /* host pointers */
12734     PL_Mem              = ipM;
12735     PL_MemShared        = ipMS;
12736     PL_MemParse         = ipMP;
12737     PL_Env              = ipE;
12738     PL_StdIO            = ipStd;
12739     PL_LIO              = ipLIO;
12740     PL_Dir              = ipD;
12741     PL_Sock             = ipS;
12742     PL_Proc             = ipP;
12743 #endif          /* PERL_IMPLICIT_SYS */
12744
12745     param->flags = flags;
12746     /* Nothing in the core code uses this, but we make it available to
12747        extensions (using mg_dup).  */
12748     param->proto_perl = proto_perl;
12749     /* Likely nothing will use this, but it is initialised to be consistent
12750        with Perl_clone_params_new().  */
12751     param->new_perl = my_perl;
12752     param->unreferenced = NULL;
12753
12754     INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
12755
12756     PL_body_arenas = NULL;
12757     Zero(&PL_body_roots, 1, PL_body_roots);
12758
12759     PL_sv_count         = 0;
12760     PL_sv_objcount      = 0;
12761     PL_sv_root          = NULL;
12762     PL_sv_arenaroot     = NULL;
12763
12764     PL_debug            = proto_perl->Idebug;
12765
12766     PL_hash_seed        = proto_perl->Ihash_seed;
12767     PL_rehash_seed      = proto_perl->Irehash_seed;
12768
12769     SvANY(&PL_sv_undef)         = NULL;
12770     SvREFCNT(&PL_sv_undef)      = (~(U32)0)/2;
12771     SvFLAGS(&PL_sv_undef)       = SVf_READONLY|SVt_NULL;
12772     SvREFCNT(&PL_sv_no)         = (~(U32)0)/2;
12773     SvFLAGS(&PL_sv_no)          = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12774                                   |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12775
12776     SvANY(&PL_sv_yes)           = new_XPVNV();
12777     SvREFCNT(&PL_sv_yes)        = (~(U32)0)/2;
12778     SvFLAGS(&PL_sv_yes)         = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12779                                   |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12780
12781     /* dbargs array probably holds garbage */
12782     PL_dbargs           = NULL;
12783
12784     PL_compiling = proto_perl->Icompiling;
12785
12786 #ifdef PERL_DEBUG_READONLY_OPS
12787     PL_slabs = NULL;
12788     PL_slab_count = 0;
12789 #endif
12790
12791     /* pseudo environmental stuff */
12792     PL_origargc         = proto_perl->Iorigargc;
12793     PL_origargv         = proto_perl->Iorigargv;
12794
12795     /* Set tainting stuff before PerlIO_debug can possibly get called */
12796     PL_tainting         = proto_perl->Itainting;
12797     PL_taint_warn       = proto_perl->Itaint_warn;
12798
12799     PL_minus_c          = proto_perl->Iminus_c;
12800
12801     PL_localpatches     = proto_perl->Ilocalpatches;
12802     PL_splitstr         = proto_perl->Isplitstr;
12803     PL_minus_n          = proto_perl->Iminus_n;
12804     PL_minus_p          = proto_perl->Iminus_p;
12805     PL_minus_l          = proto_perl->Iminus_l;
12806     PL_minus_a          = proto_perl->Iminus_a;
12807     PL_minus_E          = proto_perl->Iminus_E;
12808     PL_minus_F          = proto_perl->Iminus_F;
12809     PL_doswitches       = proto_perl->Idoswitches;
12810     PL_dowarn           = proto_perl->Idowarn;
12811     PL_sawampersand     = proto_perl->Isawampersand;
12812     PL_unsafe           = proto_perl->Iunsafe;
12813     PL_perldb           = proto_perl->Iperldb;
12814     PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
12815     PL_exit_flags       = proto_perl->Iexit_flags;
12816
12817     /* XXX time(&PL_basetime) when asked for? */
12818     PL_basetime         = proto_perl->Ibasetime;
12819
12820     PL_maxsysfd         = proto_perl->Imaxsysfd;
12821     PL_statusvalue      = proto_perl->Istatusvalue;
12822 #ifdef VMS
12823     PL_statusvalue_vms  = proto_perl->Istatusvalue_vms;
12824 #else
12825     PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
12826 #endif
12827
12828     /* RE engine related */
12829     Zero(&PL_reg_state, 1, struct re_save_state);
12830     PL_reginterp_cnt    = 0;
12831     PL_regmatch_slab    = NULL;
12832
12833     PL_sub_generation   = proto_perl->Isub_generation;
12834
12835     /* funky return mechanisms */
12836     PL_forkprocess      = proto_perl->Iforkprocess;
12837
12838     /* internal state */
12839     PL_maxo             = proto_perl->Imaxo;
12840
12841     PL_main_start       = proto_perl->Imain_start;
12842     PL_eval_root        = proto_perl->Ieval_root;
12843     PL_eval_start       = proto_perl->Ieval_start;
12844
12845     PL_filemode         = proto_perl->Ifilemode;
12846     PL_lastfd           = proto_perl->Ilastfd;
12847     PL_oldname          = proto_perl->Ioldname;         /* XXX not quite right */
12848     PL_Argv             = NULL;
12849     PL_Cmd              = NULL;
12850     PL_gensym           = proto_perl->Igensym;
12851
12852     PL_laststatval      = proto_perl->Ilaststatval;
12853     PL_laststype        = proto_perl->Ilaststype;
12854     PL_mess_sv          = NULL;
12855
12856     PL_profiledata      = NULL;
12857
12858     PL_generation       = proto_perl->Igeneration;
12859
12860     PL_in_clean_objs    = proto_perl->Iin_clean_objs;
12861     PL_in_clean_all     = proto_perl->Iin_clean_all;
12862
12863     PL_uid              = proto_perl->Iuid;
12864     PL_euid             = proto_perl->Ieuid;
12865     PL_gid              = proto_perl->Igid;
12866     PL_egid             = proto_perl->Iegid;
12867     PL_nomemok          = proto_perl->Inomemok;
12868     PL_an               = proto_perl->Ian;
12869     PL_evalseq          = proto_perl->Ievalseq;
12870     PL_origenviron      = proto_perl->Iorigenviron;     /* XXX not quite right */
12871     PL_origalen         = proto_perl->Iorigalen;
12872
12873     PL_sighandlerp      = proto_perl->Isighandlerp;
12874
12875     PL_runops           = proto_perl->Irunops;
12876
12877     PL_subline          = proto_perl->Isubline;
12878
12879 #ifdef FCRYPT
12880     PL_cryptseen        = proto_perl->Icryptseen;
12881 #endif
12882
12883     PL_hints            = proto_perl->Ihints;
12884
12885     PL_amagic_generation        = proto_perl->Iamagic_generation;
12886
12887 #ifdef USE_LOCALE_COLLATE
12888     PL_collation_ix     = proto_perl->Icollation_ix;
12889     PL_collation_standard       = proto_perl->Icollation_standard;
12890     PL_collxfrm_base    = proto_perl->Icollxfrm_base;
12891     PL_collxfrm_mult    = proto_perl->Icollxfrm_mult;
12892 #endif /* USE_LOCALE_COLLATE */
12893
12894 #ifdef USE_LOCALE_NUMERIC
12895     PL_numeric_standard = proto_perl->Inumeric_standard;
12896     PL_numeric_local    = proto_perl->Inumeric_local;
12897 #endif /* !USE_LOCALE_NUMERIC */
12898
12899     /* Did the locale setup indicate UTF-8? */
12900     PL_utf8locale       = proto_perl->Iutf8locale;
12901     /* Unicode features (see perlrun/-C) */
12902     PL_unicode          = proto_perl->Iunicode;
12903
12904     /* Pre-5.8 signals control */
12905     PL_signals          = proto_perl->Isignals;
12906
12907     /* times() ticks per second */
12908     PL_clocktick        = proto_perl->Iclocktick;
12909
12910     /* Recursion stopper for PerlIO_find_layer */
12911     PL_in_load_module   = proto_perl->Iin_load_module;
12912
12913     /* sort() routine */
12914     PL_sort_RealCmp     = proto_perl->Isort_RealCmp;
12915
12916     /* Not really needed/useful since the reenrant_retint is "volatile",
12917      * but do it for consistency's sake. */
12918     PL_reentrant_retint = proto_perl->Ireentrant_retint;
12919
12920     /* Hooks to shared SVs and locks. */
12921     PL_sharehook        = proto_perl->Isharehook;
12922     PL_lockhook         = proto_perl->Ilockhook;
12923     PL_unlockhook       = proto_perl->Iunlockhook;
12924     PL_threadhook       = proto_perl->Ithreadhook;
12925     PL_destroyhook      = proto_perl->Idestroyhook;
12926     PL_signalhook       = proto_perl->Isignalhook;
12927
12928 #ifdef THREADS_HAVE_PIDS
12929     PL_ppid             = proto_perl->Ippid;
12930 #endif
12931
12932     /* swatch cache */
12933     PL_last_swash_hv    = NULL; /* reinits on demand */
12934     PL_last_swash_klen  = 0;
12935     PL_last_swash_key[0]= '\0';
12936     PL_last_swash_tmps  = (U8*)NULL;
12937     PL_last_swash_slen  = 0;
12938
12939     PL_glob_index       = proto_perl->Iglob_index;
12940     PL_srand_called     = proto_perl->Isrand_called;
12941
12942     if (flags & CLONEf_COPY_STACKS) {
12943         /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12944         PL_tmps_ix              = proto_perl->Itmps_ix;
12945         PL_tmps_max             = proto_perl->Itmps_max;
12946         PL_tmps_floor           = proto_perl->Itmps_floor;
12947
12948         /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12949          * NOTE: unlike the others! */
12950         PL_scopestack_ix        = proto_perl->Iscopestack_ix;
12951         PL_scopestack_max       = proto_perl->Iscopestack_max;
12952
12953         /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12954          * NOTE: unlike the others! */
12955         PL_savestack_ix         = proto_perl->Isavestack_ix;
12956         PL_savestack_max        = proto_perl->Isavestack_max;
12957     }
12958
12959     PL_start_env        = proto_perl->Istart_env;       /* XXXXXX */
12960     PL_top_env          = &PL_start_env;
12961
12962     PL_op               = proto_perl->Iop;
12963
12964     PL_Sv               = NULL;
12965     PL_Xpv              = (XPV*)NULL;
12966     my_perl->Ina        = proto_perl->Ina;
12967
12968     PL_statbuf          = proto_perl->Istatbuf;
12969     PL_statcache        = proto_perl->Istatcache;
12970
12971 #ifdef HAS_TIMES
12972     PL_timesbuf         = proto_perl->Itimesbuf;
12973 #endif
12974
12975     PL_tainted          = proto_perl->Itainted;
12976     PL_curpm            = proto_perl->Icurpm;   /* XXX No PMOP ref count */
12977
12978     PL_chopset          = proto_perl->Ichopset; /* XXX never deallocated */
12979
12980     PL_restartjmpenv    = proto_perl->Irestartjmpenv;
12981     PL_restartop        = proto_perl->Irestartop;
12982     PL_in_eval          = proto_perl->Iin_eval;
12983     PL_delaymagic       = proto_perl->Idelaymagic;
12984     PL_phase            = proto_perl->Iphase;
12985     PL_localizing       = proto_perl->Ilocalizing;
12986
12987     PL_hv_fetch_ent_mh  = NULL;
12988     PL_modcount         = proto_perl->Imodcount;
12989     PL_lastgotoprobe    = NULL;
12990     PL_dumpindent       = proto_perl->Idumpindent;
12991
12992     PL_efloatbuf        = NULL;         /* reinits on demand */
12993     PL_efloatsize       = 0;                    /* reinits on demand */
12994
12995     /* regex stuff */
12996
12997     PL_screamfirst      = NULL;
12998     PL_screamnext       = NULL;
12999     PL_maxscream        = -1;                   /* reinits on demand */
13000     PL_lastscream       = NULL;
13001
13002
13003     PL_regdummy         = proto_perl->Iregdummy;
13004     PL_colorset         = 0;            /* reinits PL_colors[] */
13005     /*PL_colors[6]      = {0,0,0,0,0,0};*/
13006
13007     /* Pluggable optimizer */
13008     PL_peepp            = proto_perl->Ipeepp;
13009     PL_rpeepp           = proto_perl->Irpeepp;
13010     /* op_free() hook */
13011     PL_opfreehook       = proto_perl->Iopfreehook;
13012
13013 #ifdef USE_REENTRANT_API
13014     /* XXX: things like -Dm will segfault here in perlio, but doing
13015      *  PERL_SET_CONTEXT(proto_perl);
13016      * breaks too many other things
13017      */
13018     Perl_reentrant_init(aTHX);
13019 #endif
13020
13021     /* create SV map for pointer relocation */
13022     PL_ptr_table = ptr_table_new();
13023
13024     /* initialize these special pointers as early as possible */
13025     ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
13026
13027     SvANY(&PL_sv_no)            = new_XPVNV();
13028     SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
13029     SvCUR_set(&PL_sv_no, 0);
13030     SvLEN_set(&PL_sv_no, 1);
13031     SvIV_set(&PL_sv_no, 0);
13032     SvNV_set(&PL_sv_no, 0);
13033     ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
13034
13035     SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
13036     SvCUR_set(&PL_sv_yes, 1);
13037     SvLEN_set(&PL_sv_yes, 2);
13038     SvIV_set(&PL_sv_yes, 1);
13039     SvNV_set(&PL_sv_yes, 1);
13040     ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
13041
13042     /* create (a non-shared!) shared string table */
13043     PL_strtab           = newHV();
13044     HvSHAREKEYS_off(PL_strtab);
13045     hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
13046     ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
13047
13048     /* These two PVs will be free'd special way so must set them same way op.c does */
13049     PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
13050     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
13051
13052     PL_compiling.cop_file    = savesharedpv(PL_compiling.cop_file);
13053     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
13054
13055     ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
13056     PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
13057     CopHINTHASH_set(&PL_compiling, cophh_copy(CopHINTHASH_get(&PL_compiling)));
13058     PL_curcop           = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
13059
13060     param->stashes      = newAV();  /* Setup array of objects to call clone on */
13061     /* This makes no difference to the implementation, as it always pushes
13062        and shifts pointers to other SVs without changing their reference
13063        count, with the array becoming empty before it is freed. However, it
13064        makes it conceptually clear what is going on, and will avoid some
13065        work inside av.c, filling slots between AvFILL() and AvMAX() with
13066        &PL_sv_undef, and SvREFCNT_dec()ing those.  */
13067     AvREAL_off(param->stashes);
13068
13069     if (!(flags & CLONEf_COPY_STACKS)) {
13070         param->unreferenced = newAV();
13071     }
13072
13073 #ifdef PERLIO_LAYERS
13074     /* Clone PerlIO tables as soon as we can handle general xx_dup() */
13075     PerlIO_clone(aTHX_ proto_perl, param);
13076 #endif
13077
13078     PL_envgv            = gv_dup(proto_perl->Ienvgv, param);
13079     PL_incgv            = gv_dup(proto_perl->Iincgv, param);
13080     PL_hintgv           = gv_dup(proto_perl->Ihintgv, param);
13081     PL_origfilename     = SAVEPV(proto_perl->Iorigfilename);
13082     PL_diehook          = sv_dup_inc(proto_perl->Idiehook, param);
13083     PL_warnhook         = sv_dup_inc(proto_perl->Iwarnhook, param);
13084
13085     /* switches */
13086     PL_patchlevel       = sv_dup_inc(proto_perl->Ipatchlevel, param);
13087     PL_apiversion       = sv_dup_inc(proto_perl->Iapiversion, param);
13088     PL_inplace          = SAVEPV(proto_perl->Iinplace);
13089     PL_e_script         = sv_dup_inc(proto_perl->Ie_script, param);
13090
13091     /* magical thingies */
13092     PL_formfeed         = sv_dup(proto_perl->Iformfeed, param);
13093
13094     PL_encoding         = sv_dup(proto_perl->Iencoding, param);
13095
13096     sv_setpvs(PERL_DEBUG_PAD(0), "");   /* For regex debugging. */
13097     sv_setpvs(PERL_DEBUG_PAD(1), "");   /* ext/re needs these */
13098     sv_setpvs(PERL_DEBUG_PAD(2), "");   /* even without DEBUGGING. */
13099
13100
13101     /* Clone the regex array */
13102     /* ORANGE FIXME for plugins, probably in the SV dup code.
13103        newSViv(PTR2IV(CALLREGDUPE(
13104        INT2PTR(REGEXP *, SvIVX(regex)), param))))
13105     */
13106     PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
13107     PL_regex_pad = AvARRAY(PL_regex_padav);
13108
13109     /* shortcuts to various I/O objects */
13110     PL_ofsgv            = gv_dup_inc(proto_perl->Iofsgv, param);
13111     PL_stdingv          = gv_dup(proto_perl->Istdingv, param);
13112     PL_stderrgv         = gv_dup(proto_perl->Istderrgv, param);
13113     PL_defgv            = gv_dup(proto_perl->Idefgv, param);
13114     PL_argvgv           = gv_dup(proto_perl->Iargvgv, param);
13115     PL_argvoutgv        = gv_dup(proto_perl->Iargvoutgv, param);
13116     PL_argvout_stack    = av_dup_inc(proto_perl->Iargvout_stack, param);
13117
13118     /* shortcuts to regexp stuff */
13119     PL_replgv           = gv_dup(proto_perl->Ireplgv, param);
13120
13121     /* shortcuts to misc objects */
13122     PL_errgv            = gv_dup(proto_perl->Ierrgv, param);
13123
13124     /* shortcuts to debugging objects */
13125     PL_DBgv             = gv_dup(proto_perl->IDBgv, param);
13126     PL_DBline           = gv_dup(proto_perl->IDBline, param);
13127     PL_DBsub            = gv_dup(proto_perl->IDBsub, param);
13128     PL_DBsingle         = sv_dup(proto_perl->IDBsingle, param);
13129     PL_DBtrace          = sv_dup(proto_perl->IDBtrace, param);
13130     PL_DBsignal         = sv_dup(proto_perl->IDBsignal, param);
13131
13132     /* symbol tables */
13133     PL_defstash         = hv_dup_inc(proto_perl->Idefstash, param);
13134     PL_curstash         = hv_dup(proto_perl->Icurstash, param);
13135     PL_debstash         = hv_dup(proto_perl->Idebstash, param);
13136     PL_globalstash      = hv_dup(proto_perl->Iglobalstash, param);
13137     PL_curstname        = sv_dup_inc(proto_perl->Icurstname, param);
13138
13139     PL_beginav          = av_dup_inc(proto_perl->Ibeginav, param);
13140     PL_beginav_save     = av_dup_inc(proto_perl->Ibeginav_save, param);
13141     PL_checkav_save     = av_dup_inc(proto_perl->Icheckav_save, param);
13142     PL_unitcheckav      = av_dup_inc(proto_perl->Iunitcheckav, param);
13143     PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
13144     PL_endav            = av_dup_inc(proto_perl->Iendav, param);
13145     PL_checkav          = av_dup_inc(proto_perl->Icheckav, param);
13146     PL_initav           = av_dup_inc(proto_perl->Iinitav, param);
13147
13148     PL_isarev           = hv_dup_inc(proto_perl->Iisarev, param);
13149
13150     /* subprocess state */
13151     PL_fdpid            = av_dup_inc(proto_perl->Ifdpid, param);
13152
13153     if (proto_perl->Iop_mask)
13154         PL_op_mask      = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
13155     else
13156         PL_op_mask      = NULL;
13157     /* PL_asserting        = proto_perl->Iasserting; */
13158
13159     /* current interpreter roots */
13160     PL_main_cv          = cv_dup_inc(proto_perl->Imain_cv, param);
13161     OP_REFCNT_LOCK;
13162     PL_main_root        = OpREFCNT_inc(proto_perl->Imain_root);
13163     OP_REFCNT_UNLOCK;
13164
13165     /* runtime control stuff */
13166     PL_curcopdb         = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
13167
13168     PL_preambleav       = av_dup_inc(proto_perl->Ipreambleav, param);
13169
13170     PL_ors_sv           = sv_dup_inc(proto_perl->Iors_sv, param);
13171
13172     /* interpreter atexit processing */
13173     PL_exitlistlen      = proto_perl->Iexitlistlen;
13174     if (PL_exitlistlen) {
13175         Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13176         Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13177     }
13178     else
13179         PL_exitlist     = (PerlExitListEntry*)NULL;
13180
13181     PL_my_cxt_size = proto_perl->Imy_cxt_size;
13182     if (PL_my_cxt_size) {
13183         Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
13184         Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
13185 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13186         Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
13187         Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
13188 #endif
13189     }
13190     else {
13191         PL_my_cxt_list  = (void**)NULL;
13192 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13193         PL_my_cxt_keys  = (const char**)NULL;
13194 #endif
13195     }
13196     PL_modglobal        = hv_dup_inc(proto_perl->Imodglobal, param);
13197     PL_custom_op_names  = hv_dup_inc(proto_perl->Icustom_op_names,param);
13198     PL_custom_op_descs  = hv_dup_inc(proto_perl->Icustom_op_descs,param);
13199     PL_custom_ops       = hv_dup_inc(proto_perl->Icustom_ops, param);
13200
13201     PL_compcv                   = cv_dup(proto_perl->Icompcv, param);
13202
13203     PAD_CLONE_VARS(proto_perl, param);
13204
13205 #ifdef HAVE_INTERP_INTERN
13206     sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
13207 #endif
13208
13209     PL_DBcv             = cv_dup(proto_perl->IDBcv, param);
13210
13211 #ifdef PERL_USES_PL_PIDSTATUS
13212     PL_pidstatus        = newHV();                      /* XXX flag for cloning? */
13213 #endif
13214     PL_osname           = SAVEPV(proto_perl->Iosname);
13215     PL_parser           = parser_dup(proto_perl->Iparser, param);
13216
13217     /* XXX this only works if the saved cop has already been cloned */
13218     if (proto_perl->Iparser) {
13219         PL_parser->saved_curcop = (COP*)any_dup(
13220                                     proto_perl->Iparser->saved_curcop,
13221                                     proto_perl);
13222     }
13223
13224     PL_subname          = sv_dup_inc(proto_perl->Isubname, param);
13225
13226 #ifdef USE_LOCALE_COLLATE
13227     PL_collation_name   = SAVEPV(proto_perl->Icollation_name);
13228 #endif /* USE_LOCALE_COLLATE */
13229
13230 #ifdef USE_LOCALE_NUMERIC
13231     PL_numeric_name     = SAVEPV(proto_perl->Inumeric_name);
13232     PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
13233 #endif /* !USE_LOCALE_NUMERIC */
13234
13235     /* utf8 character classes */
13236     PL_utf8_alnum       = sv_dup_inc(proto_perl->Iutf8_alnum, param);
13237     PL_utf8_ascii       = sv_dup_inc(proto_perl->Iutf8_ascii, param);
13238     PL_utf8_alpha       = sv_dup_inc(proto_perl->Iutf8_alpha, param);
13239     PL_utf8_space       = sv_dup_inc(proto_perl->Iutf8_space, param);
13240     PL_utf8_cntrl       = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
13241     PL_utf8_graph       = sv_dup_inc(proto_perl->Iutf8_graph, param);
13242     PL_utf8_digit       = sv_dup_inc(proto_perl->Iutf8_digit, param);
13243     PL_utf8_upper       = sv_dup_inc(proto_perl->Iutf8_upper, param);
13244     PL_utf8_lower       = sv_dup_inc(proto_perl->Iutf8_lower, param);
13245     PL_utf8_print       = sv_dup_inc(proto_perl->Iutf8_print, param);
13246     PL_utf8_punct       = sv_dup_inc(proto_perl->Iutf8_punct, param);
13247     PL_utf8_xdigit      = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
13248     PL_utf8_mark        = sv_dup_inc(proto_perl->Iutf8_mark, param);
13249     PL_utf8_X_begin     = sv_dup_inc(proto_perl->Iutf8_X_begin, param);
13250     PL_utf8_X_extend    = sv_dup_inc(proto_perl->Iutf8_X_extend, param);
13251     PL_utf8_X_prepend   = sv_dup_inc(proto_perl->Iutf8_X_prepend, param);
13252     PL_utf8_X_non_hangul        = sv_dup_inc(proto_perl->Iutf8_X_non_hangul, param);
13253     PL_utf8_X_L = sv_dup_inc(proto_perl->Iutf8_X_L, param);
13254     PL_utf8_X_LV        = sv_dup_inc(proto_perl->Iutf8_X_LV, param);
13255     PL_utf8_X_LVT       = sv_dup_inc(proto_perl->Iutf8_X_LVT, param);
13256     PL_utf8_X_T = sv_dup_inc(proto_perl->Iutf8_X_T, param);
13257     PL_utf8_X_V = sv_dup_inc(proto_perl->Iutf8_X_V, param);
13258     PL_utf8_X_LV_LVT_V  = sv_dup_inc(proto_perl->Iutf8_X_LV_LVT_V, param);
13259     PL_utf8_toupper     = sv_dup_inc(proto_perl->Iutf8_toupper, param);
13260     PL_utf8_totitle     = sv_dup_inc(proto_perl->Iutf8_totitle, param);
13261     PL_utf8_tolower     = sv_dup_inc(proto_perl->Iutf8_tolower, param);
13262     PL_utf8_tofold      = sv_dup_inc(proto_perl->Iutf8_tofold, param);
13263     PL_utf8_idstart     = sv_dup_inc(proto_perl->Iutf8_idstart, param);
13264     PL_utf8_xidstart    = sv_dup_inc(proto_perl->Iutf8_xidstart, param);
13265     PL_utf8_idcont      = sv_dup_inc(proto_perl->Iutf8_idcont, param);
13266     PL_utf8_xidcont     = sv_dup_inc(proto_perl->Iutf8_xidcont, param);
13267     PL_utf8_foldable    = hv_dup_inc(proto_perl->Iutf8_foldable, param);
13268
13269
13270     if (proto_perl->Ipsig_pend) {
13271         Newxz(PL_psig_pend, SIG_SIZE, int);
13272     }
13273     else {
13274         PL_psig_pend    = (int*)NULL;
13275     }
13276
13277     if (proto_perl->Ipsig_name) {
13278         Newx(PL_psig_name, 2 * SIG_SIZE, SV*);
13279         sv_dup_inc_multiple(proto_perl->Ipsig_name, PL_psig_name, 2 * SIG_SIZE,
13280                             param);
13281         PL_psig_ptr = PL_psig_name + SIG_SIZE;
13282     }
13283     else {
13284         PL_psig_ptr     = (SV**)NULL;
13285         PL_psig_name    = (SV**)NULL;
13286     }
13287
13288     if (flags & CLONEf_COPY_STACKS) {
13289         Newx(PL_tmps_stack, PL_tmps_max, SV*);
13290         sv_dup_inc_multiple(proto_perl->Itmps_stack, PL_tmps_stack,
13291                             PL_tmps_ix+1, param);
13292
13293         /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
13294         i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
13295         Newxz(PL_markstack, i, I32);
13296         PL_markstack_max        = PL_markstack + (proto_perl->Imarkstack_max
13297                                                   - proto_perl->Imarkstack);
13298         PL_markstack_ptr        = PL_markstack + (proto_perl->Imarkstack_ptr
13299                                                   - proto_perl->Imarkstack);
13300         Copy(proto_perl->Imarkstack, PL_markstack,
13301              PL_markstack_ptr - PL_markstack + 1, I32);
13302
13303         /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13304          * NOTE: unlike the others! */
13305         Newxz(PL_scopestack, PL_scopestack_max, I32);
13306         Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
13307
13308 #ifdef DEBUGGING
13309         Newxz(PL_scopestack_name, PL_scopestack_max, const char *);
13310         Copy(proto_perl->Iscopestack_name, PL_scopestack_name, PL_scopestack_ix, const char *);
13311 #endif
13312         /* NOTE: si_dup() looks at PL_markstack */
13313         PL_curstackinfo         = si_dup(proto_perl->Icurstackinfo, param);
13314
13315         /* PL_curstack          = PL_curstackinfo->si_stack; */
13316         PL_curstack             = av_dup(proto_perl->Icurstack, param);
13317         PL_mainstack            = av_dup(proto_perl->Imainstack, param);
13318
13319         /* next PUSHs() etc. set *(PL_stack_sp+1) */
13320         PL_stack_base           = AvARRAY(PL_curstack);
13321         PL_stack_sp             = PL_stack_base + (proto_perl->Istack_sp
13322                                                    - proto_perl->Istack_base);
13323         PL_stack_max            = PL_stack_base + AvMAX(PL_curstack);
13324
13325         /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
13326         PL_savestack            = ss_dup(proto_perl, param);
13327     }
13328     else {
13329         init_stacks();
13330         ENTER;                  /* perl_destruct() wants to LEAVE; */
13331     }
13332
13333     PL_statgv           = gv_dup(proto_perl->Istatgv, param);
13334     PL_statname         = sv_dup_inc(proto_perl->Istatname, param);
13335
13336     PL_rs               = sv_dup_inc(proto_perl->Irs, param);
13337     PL_last_in_gv       = gv_dup(proto_perl->Ilast_in_gv, param);
13338     PL_defoutgv         = gv_dup_inc(proto_perl->Idefoutgv, param);
13339     PL_toptarget        = sv_dup_inc(proto_perl->Itoptarget, param);
13340     PL_bodytarget       = sv_dup_inc(proto_perl->Ibodytarget, param);
13341     PL_formtarget       = sv_dup(proto_perl->Iformtarget, param);
13342
13343     PL_errors           = sv_dup_inc(proto_perl->Ierrors, param);
13344
13345     PL_sortcop          = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
13346     PL_sortstash        = hv_dup(proto_perl->Isortstash, param);
13347     PL_firstgv          = gv_dup(proto_perl->Ifirstgv, param);
13348     PL_secondgv         = gv_dup(proto_perl->Isecondgv, param);
13349
13350     PL_stashcache       = newHV();
13351
13352     PL_watchaddr        = (char **) ptr_table_fetch(PL_ptr_table,
13353                                             proto_perl->Iwatchaddr);
13354     PL_watchok          = PL_watchaddr ? * PL_watchaddr : NULL;
13355     if (PL_debug && PL_watchaddr) {
13356         PerlIO_printf(Perl_debug_log,
13357           "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
13358           PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
13359           PTR2UV(PL_watchok));
13360     }
13361
13362     PL_registered_mros  = hv_dup_inc(proto_perl->Iregistered_mros, param);
13363     PL_blockhooks       = av_dup_inc(proto_perl->Iblockhooks, param);
13364     PL_utf8_foldclosures = hv_dup_inc(proto_perl->Iutf8_foldclosures, param);
13365
13366     /* Call the ->CLONE method, if it exists, for each of the stashes
13367        identified by sv_dup() above.
13368     */
13369     while(av_len(param->stashes) != -1) {
13370         HV* const stash = MUTABLE_HV(av_shift(param->stashes));
13371         GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
13372         if (cloner && GvCV(cloner)) {
13373             dSP;
13374             ENTER;
13375             SAVETMPS;
13376             PUSHMARK(SP);
13377             mXPUSHs(newSVhek(HvNAME_HEK(stash)));
13378             PUTBACK;
13379             call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
13380             FREETMPS;
13381             LEAVE;
13382         }
13383     }
13384
13385     if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
13386         ptr_table_free(PL_ptr_table);
13387         PL_ptr_table = NULL;
13388     }
13389
13390     if (!(flags & CLONEf_COPY_STACKS)) {
13391         unreferenced_to_tmp_stack(param->unreferenced);
13392     }
13393
13394     SvREFCNT_dec(param->stashes);
13395
13396     /* orphaned? eg threads->new inside BEGIN or use */
13397     if (PL_compcv && ! SvREFCNT(PL_compcv)) {
13398         SvREFCNT_inc_simple_void(PL_compcv);
13399         SAVEFREESV(PL_compcv);
13400     }
13401
13402     return my_perl;
13403 }
13404
13405 static void
13406 S_unreferenced_to_tmp_stack(pTHX_ AV *const unreferenced)
13407 {
13408     PERL_ARGS_ASSERT_UNREFERENCED_TO_TMP_STACK;
13409
13410     if (AvFILLp(unreferenced) > -1) {
13411         SV **svp = AvARRAY(unreferenced);
13412         SV **const last = svp + AvFILLp(unreferenced);
13413         SSize_t count = 0;
13414
13415         do {
13416             if (SvREFCNT(*svp) == 1)
13417                 ++count;
13418         } while (++svp <= last);
13419
13420         EXTEND_MORTAL(count);
13421         svp = AvARRAY(unreferenced);
13422
13423         do {
13424             if (SvREFCNT(*svp) == 1) {
13425                 /* Our reference is the only one to this SV. This means that
13426                    in this thread, the scalar effectively has a 0 reference.
13427                    That doesn't work (cleanup never happens), so donate our
13428                    reference to it onto the save stack. */
13429                 PL_tmps_stack[++PL_tmps_ix] = *svp;
13430             } else {
13431                 /* As an optimisation, because we are already walking the
13432                    entire array, instead of above doing either
13433                    SvREFCNT_inc(*svp) or *svp = &PL_sv_undef, we can instead
13434                    release our reference to the scalar, so that at the end of
13435                    the array owns zero references to the scalars it happens to
13436                    point to. We are effectively converting the array from
13437                    AvREAL() on to AvREAL() off. This saves the av_clear()
13438                    (triggered by the SvREFCNT_dec(unreferenced) below) from
13439                    walking the array a second time.  */
13440                 SvREFCNT_dec(*svp);
13441             }
13442
13443         } while (++svp <= last);
13444         AvREAL_off(unreferenced);
13445     }
13446     SvREFCNT_dec(unreferenced);
13447 }
13448
13449 void
13450 Perl_clone_params_del(CLONE_PARAMS *param)
13451 {
13452     /* This seemingly funky ordering keeps the build with PERL_GLOBAL_STRUCT
13453        happy: */
13454     PerlInterpreter *const to = param->new_perl;
13455     dTHXa(to);
13456     PerlInterpreter *const was = PERL_GET_THX;
13457
13458     PERL_ARGS_ASSERT_CLONE_PARAMS_DEL;
13459
13460     if (was != to) {
13461         PERL_SET_THX(to);
13462     }
13463
13464     SvREFCNT_dec(param->stashes);
13465     if (param->unreferenced)
13466         unreferenced_to_tmp_stack(param->unreferenced);
13467
13468     Safefree(param);
13469
13470     if (was != to) {
13471         PERL_SET_THX(was);
13472     }
13473 }
13474
13475 CLONE_PARAMS *
13476 Perl_clone_params_new(PerlInterpreter *const from, PerlInterpreter *const to)
13477 {
13478     dVAR;
13479     /* Need to play this game, as newAV() can call safesysmalloc(), and that
13480        does a dTHX; to get the context from thread local storage.
13481        FIXME - under PERL_CORE Newx(), Safefree() and friends should expand to
13482        a version that passes in my_perl.  */
13483     PerlInterpreter *const was = PERL_GET_THX;
13484     CLONE_PARAMS *param;
13485
13486     PERL_ARGS_ASSERT_CLONE_PARAMS_NEW;
13487
13488     if (was != to) {
13489         PERL_SET_THX(to);
13490     }
13491
13492     /* Given that we've set the context, we can do this unshared.  */
13493     Newx(param, 1, CLONE_PARAMS);
13494
13495     param->flags = 0;
13496     param->proto_perl = from;
13497     param->new_perl = to;
13498     param->stashes = (AV *)Perl_newSV_type(to, SVt_PVAV);
13499     AvREAL_off(param->stashes);
13500     param->unreferenced = (AV *)Perl_newSV_type(to, SVt_PVAV);
13501
13502     if (was != to) {
13503         PERL_SET_THX(was);
13504     }
13505     return param;
13506 }
13507
13508 #endif /* USE_ITHREADS */
13509
13510 /*
13511 =head1 Unicode Support
13512
13513 =for apidoc sv_recode_to_utf8
13514
13515 The encoding is assumed to be an Encode object, on entry the PV
13516 of the sv is assumed to be octets in that encoding, and the sv
13517 will be converted into Unicode (and UTF-8).
13518
13519 If the sv already is UTF-8 (or if it is not POK), or if the encoding
13520 is not a reference, nothing is done to the sv.  If the encoding is not
13521 an C<Encode::XS> Encoding object, bad things will happen.
13522 (See F<lib/encoding.pm> and L<Encode>).
13523
13524 The PV of the sv is returned.
13525
13526 =cut */
13527
13528 char *
13529 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
13530 {
13531     dVAR;
13532
13533     PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
13534
13535     if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
13536         SV *uni;
13537         STRLEN len;
13538         const char *s;
13539         dSP;
13540         ENTER;
13541         SAVETMPS;
13542         save_re_context();
13543         PUSHMARK(sp);
13544         EXTEND(SP, 3);
13545         XPUSHs(encoding);
13546         XPUSHs(sv);
13547 /*
13548   NI-S 2002/07/09
13549   Passing sv_yes is wrong - it needs to be or'ed set of constants
13550   for Encode::XS, while UTf-8 decode (currently) assumes a true value means
13551   remove converted chars from source.
13552
13553   Both will default the value - let them.
13554
13555         XPUSHs(&PL_sv_yes);
13556 */
13557         PUTBACK;
13558         call_method("decode", G_SCALAR);
13559         SPAGAIN;
13560         uni = POPs;
13561         PUTBACK;
13562         s = SvPV_const(uni, len);
13563         if (s != SvPVX_const(sv)) {
13564             SvGROW(sv, len + 1);
13565             Move(s, SvPVX(sv), len + 1, char);
13566             SvCUR_set(sv, len);
13567         }
13568         FREETMPS;
13569         LEAVE;
13570         if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
13571             /* clear pos and any utf8 cache */
13572             MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
13573             if (mg)
13574                 mg->mg_len = -1;
13575             if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
13576                 magic_setutf8(sv,mg); /* clear UTF8 cache */
13577         }
13578         SvUTF8_on(sv);
13579         return SvPVX(sv);
13580     }
13581     return SvPOKp(sv) ? SvPVX(sv) : NULL;
13582 }
13583
13584 /*
13585 =for apidoc sv_cat_decode
13586
13587 The encoding is assumed to be an Encode object, the PV of the ssv is
13588 assumed to be octets in that encoding and decoding the input starts
13589 from the position which (PV + *offset) pointed to.  The dsv will be
13590 concatenated the decoded UTF-8 string from ssv.  Decoding will terminate
13591 when the string tstr appears in decoding output or the input ends on
13592 the PV of the ssv. The value which the offset points will be modified
13593 to the last input position on the ssv.
13594
13595 Returns TRUE if the terminator was found, else returns FALSE.
13596
13597 =cut */
13598
13599 bool
13600 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
13601                    SV *ssv, int *offset, char *tstr, int tlen)
13602 {
13603     dVAR;
13604     bool ret = FALSE;
13605
13606     PERL_ARGS_ASSERT_SV_CAT_DECODE;
13607
13608     if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
13609         SV *offsv;
13610         dSP;
13611         ENTER;
13612         SAVETMPS;
13613         save_re_context();
13614         PUSHMARK(sp);
13615         EXTEND(SP, 6);
13616         XPUSHs(encoding);
13617         XPUSHs(dsv);
13618         XPUSHs(ssv);
13619         offsv = newSViv(*offset);
13620         mXPUSHs(offsv);
13621         mXPUSHp(tstr, tlen);
13622         PUTBACK;
13623         call_method("cat_decode", G_SCALAR);
13624         SPAGAIN;
13625         ret = SvTRUE(TOPs);
13626         *offset = SvIV(offsv);
13627         PUTBACK;
13628         FREETMPS;
13629         LEAVE;
13630     }
13631     else
13632         Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
13633     return ret;
13634
13635 }
13636
13637 /* ---------------------------------------------------------------------
13638  *
13639  * support functions for report_uninit()
13640  */
13641
13642 /* the maxiumum size of array or hash where we will scan looking
13643  * for the undefined element that triggered the warning */
13644
13645 #define FUV_MAX_SEARCH_SIZE 1000
13646
13647 /* Look for an entry in the hash whose value has the same SV as val;
13648  * If so, return a mortal copy of the key. */
13649
13650 STATIC SV*
13651 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
13652 {
13653     dVAR;
13654     register HE **array;
13655     I32 i;
13656
13657     PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
13658
13659     if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
13660                         (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
13661         return NULL;
13662
13663     array = HvARRAY(hv);
13664
13665     for (i=HvMAX(hv); i>0; i--) {
13666         register HE *entry;
13667         for (entry = array[i]; entry; entry = HeNEXT(entry)) {
13668             if (HeVAL(entry) != val)
13669                 continue;
13670             if (    HeVAL(entry) == &PL_sv_undef ||
13671                     HeVAL(entry) == &PL_sv_placeholder)
13672                 continue;
13673             if (!HeKEY(entry))
13674                 return NULL;
13675             if (HeKLEN(entry) == HEf_SVKEY)
13676                 return sv_mortalcopy(HeKEY_sv(entry));
13677             return sv_2mortal(newSVhek(HeKEY_hek(entry)));
13678         }
13679     }
13680     return NULL;
13681 }
13682
13683 /* Look for an entry in the array whose value has the same SV as val;
13684  * If so, return the index, otherwise return -1. */
13685
13686 STATIC I32
13687 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
13688 {
13689     dVAR;
13690
13691     PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
13692
13693     if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
13694                         (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
13695         return -1;
13696
13697     if (val != &PL_sv_undef) {
13698         SV ** const svp = AvARRAY(av);
13699         I32 i;
13700
13701         for (i=AvFILLp(av); i>=0; i--)
13702             if (svp[i] == val)
13703                 return i;
13704     }
13705     return -1;
13706 }
13707
13708 /* S_varname(): return the name of a variable, optionally with a subscript.
13709  * If gv is non-zero, use the name of that global, along with gvtype (one
13710  * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
13711  * targ.  Depending on the value of the subscript_type flag, return:
13712  */
13713
13714 #define FUV_SUBSCRIPT_NONE      1       /* "@foo"          */
13715 #define FUV_SUBSCRIPT_ARRAY     2       /* "$foo[aindex]"  */
13716 #define FUV_SUBSCRIPT_HASH      3       /* "$foo{keyname}" */
13717 #define FUV_SUBSCRIPT_WITHIN    4       /* "within @foo"   */
13718
13719 STATIC SV*
13720 S_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
13721         const SV *const keyname, I32 aindex, int subscript_type)
13722 {
13723
13724     SV * const name = sv_newmortal();
13725     if (gv) {
13726         char buffer[2];
13727         buffer[0] = gvtype;
13728         buffer[1] = 0;
13729
13730         /* as gv_fullname4(), but add literal '^' for $^FOO names  */
13731
13732         gv_fullname4(name, gv, buffer, 0);
13733
13734         if ((unsigned int)SvPVX(name)[1] <= 26) {
13735             buffer[0] = '^';
13736             buffer[1] = SvPVX(name)[1] + 'A' - 1;
13737
13738             /* Swap the 1 unprintable control character for the 2 byte pretty
13739                version - ie substr($name, 1, 1) = $buffer; */
13740             sv_insert(name, 1, 1, buffer, 2);
13741         }
13742     }
13743     else {
13744         CV * const cv = find_runcv(NULL);
13745         SV *sv;
13746         AV *av;
13747
13748         if (!cv || !CvPADLIST(cv))
13749             return NULL;
13750         av = MUTABLE_AV((*av_fetch(CvPADLIST(cv), 0, FALSE)));
13751         sv = *av_fetch(av, targ, FALSE);
13752         sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
13753     }
13754
13755     if (subscript_type == FUV_SUBSCRIPT_HASH) {
13756         SV * const sv = newSV(0);
13757         *SvPVX(name) = '$';
13758         Perl_sv_catpvf(aTHX_ name, "{%s}",
13759             pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
13760         SvREFCNT_dec(sv);
13761     }
13762     else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
13763         *SvPVX(name) = '$';
13764         Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
13765     }
13766     else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
13767         /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
13768         Perl_sv_insert_flags(aTHX_ name, 0, 0,  STR_WITH_LEN("within "), 0);
13769     }
13770
13771     return name;
13772 }
13773
13774
13775 /*
13776 =for apidoc find_uninit_var
13777
13778 Find the name of the undefined variable (if any) that caused the operator o
13779 to issue a "Use of uninitialized value" warning.
13780 If match is true, only return a name if it's value matches uninit_sv.
13781 So roughly speaking, if a unary operator (such as OP_COS) generates a
13782 warning, then following the direct child of the op may yield an
13783 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
13784 other hand, with OP_ADD there are two branches to follow, so we only print
13785 the variable name if we get an exact match.
13786
13787 The name is returned as a mortal SV.
13788
13789 Assumes that PL_op is the op that originally triggered the error, and that
13790 PL_comppad/PL_curpad points to the currently executing pad.
13791
13792 =cut
13793 */
13794
13795 STATIC SV *
13796 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
13797                   bool match)
13798 {
13799     dVAR;
13800     SV *sv;
13801     const GV *gv;
13802     const OP *o, *o2, *kid;
13803
13804     if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
13805                             uninit_sv == &PL_sv_placeholder)))
13806         return NULL;
13807
13808     switch (obase->op_type) {
13809
13810     case OP_RV2AV:
13811     case OP_RV2HV:
13812     case OP_PADAV:
13813     case OP_PADHV:
13814       {
13815         const bool pad  = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
13816         const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
13817         I32 index = 0;
13818         SV *keysv = NULL;
13819         int subscript_type = FUV_SUBSCRIPT_WITHIN;
13820
13821         if (pad) { /* @lex, %lex */
13822             sv = PAD_SVl(obase->op_targ);
13823             gv = NULL;
13824         }
13825         else {
13826             if (cUNOPx(obase)->op_first->op_type == OP_GV) {
13827             /* @global, %global */
13828                 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
13829                 if (!gv)
13830                     break;
13831                 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
13832             }
13833             else /* @{expr}, %{expr} */
13834                 return find_uninit_var(cUNOPx(obase)->op_first,
13835                                                     uninit_sv, match);
13836         }
13837
13838         /* attempt to find a match within the aggregate */
13839         if (hash) {
13840             keysv = find_hash_subscript((const HV*)sv, uninit_sv);
13841             if (keysv)
13842                 subscript_type = FUV_SUBSCRIPT_HASH;
13843         }
13844         else {
13845             index = find_array_subscript((const AV *)sv, uninit_sv);
13846             if (index >= 0)
13847                 subscript_type = FUV_SUBSCRIPT_ARRAY;
13848         }
13849
13850         if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
13851             break;
13852
13853         return varname(gv, hash ? '%' : '@', obase->op_targ,
13854                                     keysv, index, subscript_type);
13855       }
13856
13857     case OP_PADSV:
13858         if (match && PAD_SVl(obase->op_targ) != uninit_sv)
13859             break;
13860         return varname(NULL, '$', obase->op_targ,
13861                                     NULL, 0, FUV_SUBSCRIPT_NONE);
13862
13863     case OP_GVSV:
13864         gv = cGVOPx_gv(obase);
13865         if (!gv || (match && GvSV(gv) != uninit_sv) || !GvSTASH(gv))
13866             break;
13867         return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
13868
13869     case OP_AELEMFAST_LEX:
13870         if (match) {
13871             SV **svp;
13872             AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
13873             if (!av || SvRMAGICAL(av))
13874                 break;
13875             svp = av_fetch(av, (I32)obase->op_private, FALSE);
13876             if (!svp || *svp != uninit_sv)
13877                 break;
13878         }
13879         return varname(NULL, '$', obase->op_targ,
13880                        NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
13881     case OP_AELEMFAST:
13882         {
13883             gv = cGVOPx_gv(obase);
13884             if (!gv)
13885                 break;
13886             if (match) {
13887                 SV **svp;
13888                 AV *const av = GvAV(gv);
13889                 if (!av || SvRMAGICAL(av))
13890                     break;
13891                 svp = av_fetch(av, (I32)obase->op_private, FALSE);
13892                 if (!svp || *svp != uninit_sv)
13893                     break;
13894             }
13895             return varname(gv, '$', 0,
13896                     NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
13897         }
13898         break;
13899
13900     case OP_EXISTS:
13901         o = cUNOPx(obase)->op_first;
13902         if (!o || o->op_type != OP_NULL ||
13903                 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
13904             break;
13905         return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
13906
13907     case OP_AELEM:
13908     case OP_HELEM:
13909         if (PL_op == obase)
13910             /* $a[uninit_expr] or $h{uninit_expr} */
13911             return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
13912
13913         gv = NULL;
13914         o = cBINOPx(obase)->op_first;
13915         kid = cBINOPx(obase)->op_last;
13916
13917         /* get the av or hv, and optionally the gv */
13918         sv = NULL;
13919         if  (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
13920             sv = PAD_SV(o->op_targ);
13921         }
13922         else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
13923                 && cUNOPo->op_first->op_type == OP_GV)
13924         {
13925             gv = cGVOPx_gv(cUNOPo->op_first);
13926             if (!gv)
13927                 break;
13928             sv = o->op_type
13929                 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
13930         }
13931         if (!sv)
13932             break;
13933
13934         if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
13935             /* index is constant */
13936             if (match) {
13937                 if (SvMAGICAL(sv))
13938                     break;
13939                 if (obase->op_type == OP_HELEM) {
13940                     HE* he = hv_fetch_ent(MUTABLE_HV(sv), cSVOPx_sv(kid), 0, 0);
13941                     if (!he || HeVAL(he) != uninit_sv)
13942                         break;
13943                 }
13944                 else {
13945                     SV * const * const svp = av_fetch(MUTABLE_AV(sv), SvIV(cSVOPx_sv(kid)), FALSE);
13946                     if (!svp || *svp != uninit_sv)
13947                         break;
13948                 }
13949             }
13950             if (obase->op_type == OP_HELEM)
13951                 return varname(gv, '%', o->op_targ,
13952                             cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
13953             else
13954                 return varname(gv, '@', o->op_targ, NULL,
13955                             SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
13956         }
13957         else  {
13958             /* index is an expression;
13959              * attempt to find a match within the aggregate */
13960             if (obase->op_type == OP_HELEM) {
13961                 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
13962                 if (keysv)
13963                     return varname(gv, '%', o->op_targ,
13964                                                 keysv, 0, FUV_SUBSCRIPT_HASH);
13965             }
13966             else {
13967                 const I32 index
13968                     = find_array_subscript((const AV *)sv, uninit_sv);
13969                 if (index >= 0)
13970                     return varname(gv, '@', o->op_targ,
13971                                         NULL, index, FUV_SUBSCRIPT_ARRAY);
13972             }
13973             if (match)
13974                 break;
13975             return varname(gv,
13976                 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
13977                 ? '@' : '%',
13978                 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
13979         }
13980         break;
13981
13982     case OP_AASSIGN:
13983         /* only examine RHS */
13984         return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
13985
13986     case OP_OPEN:
13987         o = cUNOPx(obase)->op_first;
13988         if (o->op_type == OP_PUSHMARK)
13989             o = o->op_sibling;
13990
13991         if (!o->op_sibling) {
13992             /* one-arg version of open is highly magical */
13993
13994             if (o->op_type == OP_GV) { /* open FOO; */
13995                 gv = cGVOPx_gv(o);
13996                 if (match && GvSV(gv) != uninit_sv)
13997                     break;
13998                 return varname(gv, '$', 0,
13999                             NULL, 0, FUV_SUBSCRIPT_NONE);
14000             }
14001             /* other possibilities not handled are:
14002              * open $x; or open my $x;  should return '${*$x}'
14003              * open expr;               should return '$'.expr ideally
14004              */
14005              break;
14006         }
14007         goto do_op;
14008
14009     /* ops where $_ may be an implicit arg */
14010     case OP_TRANS:
14011     case OP_SUBST:
14012     case OP_MATCH:
14013         if ( !(obase->op_flags & OPf_STACKED)) {
14014             if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
14015                                  ? PAD_SVl(obase->op_targ)
14016                                  : DEFSV))
14017             {
14018                 sv = sv_newmortal();
14019                 sv_setpvs(sv, "$_");
14020                 return sv;
14021             }
14022         }
14023         goto do_op;
14024
14025     case OP_PRTF:
14026     case OP_PRINT:
14027     case OP_SAY:
14028         match = 1; /* print etc can return undef on defined args */
14029         /* skip filehandle as it can't produce 'undef' warning  */
14030         o = cUNOPx(obase)->op_first;
14031         if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
14032             o = o->op_sibling->op_sibling;
14033         goto do_op2;
14034
14035
14036     case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
14037     case OP_RV2SV:
14038     case OP_CUSTOM: /* XS or custom code could trigger random warnings */
14039
14040         /* the following ops are capable of returning PL_sv_undef even for
14041          * defined arg(s) */
14042
14043     case OP_BACKTICK:
14044     case OP_PIPE_OP:
14045     case OP_FILENO:
14046     case OP_BINMODE:
14047     case OP_TIED:
14048     case OP_GETC:
14049     case OP_SYSREAD:
14050     case OP_SEND:
14051     case OP_IOCTL:
14052     case OP_SOCKET:
14053     case OP_SOCKPAIR:
14054     case OP_BIND:
14055     case OP_CONNECT:
14056     case OP_LISTEN:
14057     case OP_ACCEPT:
14058     case OP_SHUTDOWN:
14059     case OP_SSOCKOPT:
14060     case OP_GETPEERNAME:
14061     case OP_FTRREAD:
14062     case OP_FTRWRITE:
14063     case OP_FTREXEC:
14064     case OP_FTROWNED:
14065     case OP_FTEREAD:
14066     case OP_FTEWRITE:
14067     case OP_FTEEXEC:
14068     case OP_FTEOWNED:
14069     case OP_FTIS:
14070     case OP_FTZERO:
14071     case OP_FTSIZE:
14072     case OP_FTFILE:
14073     case OP_FTDIR:
14074     case OP_FTLINK:
14075     case OP_FTPIPE:
14076     case OP_FTSOCK:
14077     case OP_FTBLK:
14078     case OP_FTCHR:
14079     case OP_FTTTY:
14080     case OP_FTSUID:
14081     case OP_FTSGID:
14082     case OP_FTSVTX:
14083     case OP_FTTEXT:
14084     case OP_FTBINARY:
14085     case OP_FTMTIME:
14086     case OP_FTATIME:
14087     case OP_FTCTIME:
14088     case OP_READLINK:
14089     case OP_OPEN_DIR:
14090     case OP_READDIR:
14091     case OP_TELLDIR:
14092     case OP_SEEKDIR:
14093     case OP_REWINDDIR:
14094     case OP_CLOSEDIR:
14095     case OP_GMTIME:
14096     case OP_ALARM:
14097     case OP_SEMGET:
14098     case OP_GETLOGIN:
14099     case OP_UNDEF:
14100     case OP_SUBSTR:
14101     case OP_AEACH:
14102     case OP_EACH:
14103     case OP_SORT:
14104     case OP_CALLER:
14105     case OP_DOFILE:
14106     case OP_PROTOTYPE:
14107     case OP_NCMP:
14108     case OP_SMARTMATCH:
14109     case OP_UNPACK:
14110     case OP_SYSOPEN:
14111     case OP_SYSSEEK:
14112         match = 1;
14113         goto do_op;
14114
14115     case OP_ENTERSUB:
14116     case OP_GOTO:
14117         /* XXX tmp hack: these two may call an XS sub, and currently
14118           XS subs don't have a SUB entry on the context stack, so CV and
14119           pad determination goes wrong, and BAD things happen. So, just
14120           don't try to determine the value under those circumstances.
14121           Need a better fix at dome point. DAPM 11/2007 */
14122         break;
14123
14124     case OP_FLIP:
14125     case OP_FLOP:
14126     {
14127         GV * const gv = gv_fetchpvs(".", GV_NOTQUAL, SVt_PV);
14128         if (gv && GvSV(gv) == uninit_sv)
14129             return newSVpvs_flags("$.", SVs_TEMP);
14130         goto do_op;
14131     }
14132
14133     case OP_POS:
14134         /* def-ness of rval pos() is independent of the def-ness of its arg */
14135         if ( !(obase->op_flags & OPf_MOD))
14136             break;
14137
14138     case OP_SCHOMP:
14139     case OP_CHOMP:
14140         if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
14141             return newSVpvs_flags("${$/}", SVs_TEMP);
14142         /*FALLTHROUGH*/
14143
14144     default:
14145     do_op:
14146         if (!(obase->op_flags & OPf_KIDS))
14147             break;
14148         o = cUNOPx(obase)->op_first;
14149
14150     do_op2:
14151         if (!o)
14152             break;
14153
14154         /* if all except one arg are constant, or have no side-effects,
14155          * or are optimized away, then it's unambiguous */
14156         o2 = NULL;
14157         for (kid=o; kid; kid = kid->op_sibling) {
14158             if (kid) {
14159                 const OPCODE type = kid->op_type;
14160                 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
14161                   || (type == OP_NULL  && ! (kid->op_flags & OPf_KIDS))
14162                   || (type == OP_PUSHMARK)
14163                   || (
14164                       /* @$a and %$a, but not @a or %a */
14165                         (type == OP_RV2AV || type == OP_RV2HV)
14166                      && cUNOPx(kid)->op_first
14167                      && cUNOPx(kid)->op_first->op_type != OP_GV
14168                      )
14169                 )
14170                 continue;
14171             }
14172             if (o2) { /* more than one found */
14173                 o2 = NULL;
14174                 break;
14175             }
14176             o2 = kid;
14177         }
14178         if (o2)
14179             return find_uninit_var(o2, uninit_sv, match);
14180
14181         /* scan all args */
14182         while (o) {
14183             sv = find_uninit_var(o, uninit_sv, 1);
14184             if (sv)
14185                 return sv;
14186             o = o->op_sibling;
14187         }
14188         break;
14189     }
14190     return NULL;
14191 }
14192
14193
14194 /*
14195 =for apidoc report_uninit
14196
14197 Print appropriate "Use of uninitialized variable" warning
14198
14199 =cut
14200 */
14201
14202 void
14203 Perl_report_uninit(pTHX_ const SV *uninit_sv)
14204 {
14205     dVAR;
14206     if (PL_op) {
14207         SV* varname = NULL;
14208         if (uninit_sv) {
14209             varname = find_uninit_var(PL_op, uninit_sv,0);
14210             if (varname)
14211                 sv_insert(varname, 0, 0, " ", 1);
14212         }
14213         Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14214                 varname ? SvPV_nolen_const(varname) : "",
14215                 " in ", OP_DESC(PL_op));
14216     }
14217     else
14218         Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14219                     "", "", "");
14220 }
14221
14222 /*
14223  * Local variables:
14224  * c-indentation-style: bsd
14225  * c-basic-offset: 4
14226  * indent-tabs-mode: t
14227  * End:
14228  *
14229  * ex: set ts=8 sts=4 sw=4 noet:
14230  */