sv.c

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