sv.c

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