sv.c

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