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