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