sv.c

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