sv.c

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