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