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 *ref)
 418 {
 419     SV* target;
 420
 421     if (SvROK(ref) && SvOBJECT(target = SvRV(ref))) {
 422         DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
 423         if (SvWEAKREF(ref)) {
 424             sv_del_backref(target, ref);
 425             SvWEAKREF_off(ref);
 426             SvRV_set(ref, NULL);
 427         } else {
 428             SvROK_off(ref);
 429             SvRV_set(ref, NULL);
 430             SvREFCNT_dec(target);
 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 ** const 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 * const sv = NEWSV(0,0);
 702         *SvPVX(name) = '$';
 703         Perl_sv_catpvf(aTHX_ name, "{%s}",
 704             pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
 705         SvREFCNT_dec(sv);
 706     }
 707     else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
 708         *SvPVX(name) = '$';
 709         Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
 710     }
 711     else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
 712         sv_insert(name, 0, 0,  "within ", 7);
 713
 714     return name;
 715 }
 716
 717
 718 /*
 719 =for apidoc find_uninit_var
 720
 721 Find the name of the undefined variable (if any) that caused the operator o
 722 to issue a "Use of uninitialized value" warning.
 723 If match is true, only return a name if it's value matches uninit_sv.
 724 So roughly speaking, if a unary operator (such as OP_COS) generates a
 725 warning, then following the direct child of the op may yield an
 726 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
 727 other hand, with OP_ADD there are two branches to follow, so we only print
 728 the variable name if we get an exact match.
 729
 730 The name is returned as a mortal SV.
 731
 732 Assumes that PL_op is the op that originally triggered the error, and that
 733 PL_comppad/PL_curpad points to the currently executing pad.
 734
 735 =cut
 736 */
 737
 738 STATIC SV *
 739 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
 740 {
 741     dVAR;
 742     SV *sv;
 743     AV *av;
 744     GV *gv;
 745     OP *o, *o2, *kid;
 746
 747     if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
 748                             uninit_sv == &PL_sv_placeholder)))
 749         return Nullsv;
 750
 751     switch (obase->op_type) {
 752
 753     case OP_RV2AV:
 754     case OP_RV2HV:
 755     case OP_PADAV:
 756     case OP_PADHV:
 757       {
 758         const bool pad  = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
 759         const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
 760         I32 index = 0;
 761         SV *keysv = Nullsv;
 762         int subscript_type = FUV_SUBSCRIPT_WITHIN;
 763
 764         if (pad) { /* @lex, %lex */
 765             sv = PAD_SVl(obase->op_targ);
 766             gv = Nullgv;
 767         }
 768         else {
 769             if (cUNOPx(obase)->op_first->op_type == OP_GV) {
 770             /* @global, %global */
 771                 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
 772                 if (!gv)
 773                     break;
 774                 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
 775             }
 776             else /* @{expr}, %{expr} */
 777                 return find_uninit_var(cUNOPx(obase)->op_first,
 778                                                     uninit_sv, match);
 779         }
 780
 781         /* attempt to find a match within the aggregate */
 782         if (hash) {
 783             keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
 784             if (keysv)
 785                 subscript_type = FUV_SUBSCRIPT_HASH;
 786         }
 787         else {
 788             index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
 789             if (index >= 0)
 790                 subscript_type = FUV_SUBSCRIPT_ARRAY;
 791         }
 792
 793         if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
 794             break;
 795
 796         return varname(gv, hash ? "%" : "@", obase->op_targ,
 797                                     keysv, index, subscript_type);
 798       }
 799
 800     case OP_PADSV:
 801         if (match && PAD_SVl(obase->op_targ) != uninit_sv)
 802             break;
 803         return varname(Nullgv, "$", obase->op_targ,
 804                                     Nullsv, 0, FUV_SUBSCRIPT_NONE);
 805
 806     case OP_GVSV:
 807         gv = cGVOPx_gv(obase);
 808         if (!gv || (match && GvSV(gv) != uninit_sv))
 809             break;
 810         return varname(gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
 811
 812     case OP_AELEMFAST:
 813         if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
 814             if (match) {
 815                 SV **svp;
 816                 av = (AV*)PAD_SV(obase->op_targ);
 817                 if (!av || SvRMAGICAL(av))
 818                     break;
 819                 svp = av_fetch(av, (I32)obase->op_private, FALSE);
 820                 if (!svp || *svp != uninit_sv)
 821                     break;
 822             }
 823             return varname(Nullgv, "$", obase->op_targ,
 824                     Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
 825         }
 826         else {
 827             gv = cGVOPx_gv(obase);
 828             if (!gv)
 829                 break;
 830             if (match) {
 831                 SV **svp;
 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 varname(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                     SV ** const 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 varname(gv, "%", o->op_targ,
 895                             cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
 896             else
 897                 return varname(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 varname(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 varname(gv, "@", o->op_targ,
 914                                         Nullsv, index, FUV_SUBSCRIPT_ARRAY);
 915             }
 916             if (match)
 917                 break;
 918             return varname(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 varname(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         return;
1409     case SVt_NV:
1410         assert(old_type == SVt_NULL);
1411         SvANY(sv) = new_XNV();
1412         SvNV_set(sv, 0);
1413         return;
1414     case SVt_RV:
1415         assert(old_type == SVt_NULL);
1416         SvANY(sv) = &sv->sv_u.svu_rv;
1417         SvRV_set(sv, 0);
1418         return;
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      const 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) = GvSTASH(sstr);
3847                 if (GvSTASH(dstr))
3848                     Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3849                 GvNAME(dstr) = savepvn(name, len);
3850                 GvNAMELEN(dstr) = len;
3851                 SvFAKE_on(dstr);        /* can coerce to non-glob */
3852             }
3853             /* ahem, death to those who redefine active sort subs */
3854             else if (PL_curstackinfo->si_type == PERLSI_SORT
3855                      && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3856                 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3857                       GvNAME(dstr));
3858
3859 #ifdef GV_UNIQUE_CHECK
3860                 if (GvUNIQUE((GV*)dstr)) {
3861                     Perl_croak(aTHX_ PL_no_modify);
3862                 }
3863 #endif
3864
3865             (void)SvOK_off(dstr);
3866             GvINTRO_off(dstr);          /* one-shot flag */
3867             gp_free((GV*)dstr);
3868             GvGP(dstr) = gp_ref(GvGP(sstr));
3869             if (SvTAINTED(sstr))
3870                 SvTAINT(dstr);
3871             if (GvIMPORTED(dstr) != GVf_IMPORTED
3872                 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3873             {
3874                 GvIMPORTED_on(dstr);
3875             }
3876             GvMULTI_on(dstr);
3877             return;
3878         }
3879         /* FALL THROUGH */
3880
3881     default:
3882         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3883             mg_get(sstr);
3884             if ((int)SvTYPE(sstr) != stype) {
3885                 stype = SvTYPE(sstr);
3886                 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3887                     goto glob_assign;
3888             }
3889         }
3890         if (stype == SVt_PVLV)
3891             SvUPGRADE(dstr, SVt_PVNV);
3892         else
3893             SvUPGRADE(dstr, (U32)stype);
3894     }
3895
3896     sflags = SvFLAGS(sstr);
3897
3898     if (sflags & SVf_ROK) {
3899         if (dtype >= SVt_PV) {
3900             if (dtype == SVt_PVGV) {
3901                 SV *sref = SvREFCNT_inc(SvRV(sstr));
3902                 SV *dref = 0;
3903                 const int intro = GvINTRO(dstr);
3904
3905 #ifdef GV_UNIQUE_CHECK
3906                 if (GvUNIQUE((GV*)dstr)) {
3907                     Perl_croak(aTHX_ PL_no_modify);
3908                 }
3909 #endif
3910
3911                 if (intro) {
3912                     GvINTRO_off(dstr);  /* one-shot flag */
3913                     GvLINE(dstr) = CopLINE(PL_curcop);
3914                     GvEGV(dstr) = (GV*)dstr;
3915                 }
3916                 GvMULTI_on(dstr);
3917                 switch (SvTYPE(sref)) {
3918                 case SVt_PVAV:
3919                     if (intro)
3920                         SAVEGENERICSV(GvAV(dstr));
3921                     else
3922                         dref = (SV*)GvAV(dstr);
3923                     GvAV(dstr) = (AV*)sref;
3924                     if (!GvIMPORTED_AV(dstr)
3925                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3926                     {
3927                         GvIMPORTED_AV_on(dstr);
3928                     }
3929                     break;
3930                 case SVt_PVHV:
3931                     if (intro)
3932                         SAVEGENERICSV(GvHV(dstr));
3933                     else
3934                         dref = (SV*)GvHV(dstr);
3935                     GvHV(dstr) = (HV*)sref;
3936                     if (!GvIMPORTED_HV(dstr)
3937                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3938                     {
3939                         GvIMPORTED_HV_on(dstr);
3940                     }
3941                     break;
3942                 case SVt_PVCV:
3943                     if (intro) {
3944                         if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3945                             SvREFCNT_dec(GvCV(dstr));
3946                             GvCV(dstr) = Nullcv;
3947                             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3948                             PL_sub_generation++;
3949                         }
3950                         SAVEGENERICSV(GvCV(dstr));
3951                     }
3952                     else
3953                         dref = (SV*)GvCV(dstr);
3954                     if (GvCV(dstr) != (CV*)sref) {
3955                         CV* cv = GvCV(dstr);
3956                         if (cv) {
3957                             if (!GvCVGEN((GV*)dstr) &&
3958                                 (CvROOT(cv) || CvXSUB(cv)))
3959                             {
3960                                 /* ahem, death to those who redefine
3961                                  * active sort subs */
3962                                 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3963                                       PL_sortcop == CvSTART(cv))
3964                                     Perl_croak(aTHX_
3965                                     "Can't redefine active sort subroutine %s",
3966                                           GvENAME((GV*)dstr));
3967                                 /* Redefining a sub - warning is mandatory if
3968                                    it was a const and its value changed. */
3969                                 if (ckWARN(WARN_REDEFINE)
3970                                     || (CvCONST(cv)
3971                                         && (!CvCONST((CV*)sref)
3972                                             || sv_cmp(cv_const_sv(cv),
3973                                                       cv_const_sv((CV*)sref)))))
3974                                 {
3975                                     Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3976                                         CvCONST(cv)
3977                                         ? "Constant subroutine %s::%s redefined"
3978                                         : "Subroutine %s::%s redefined",
3979                                         HvNAME_get(GvSTASH((GV*)dstr)),
3980                                         GvENAME((GV*)dstr));
3981                                 }
3982                             }
3983                             if (!intro)
3984                                 cv_ckproto(cv, (GV*)dstr,
3985                                            SvPOK(sref)
3986                                            ? SvPVX_const(sref) : Nullch);
3987                         }
3988                         GvCV(dstr) = (CV*)sref;
3989                         GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3990                         GvASSUMECV_on(dstr);
3991                         PL_sub_generation++;
3992                     }
3993                     if (!GvIMPORTED_CV(dstr)
3994                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3995                     {
3996                         GvIMPORTED_CV_on(dstr);
3997                     }
3998                     break;
3999                 case SVt_PVIO:
4000                     if (intro)
4001                         SAVEGENERICSV(GvIOp(dstr));
4002                     else
4003                         dref = (SV*)GvIOp(dstr);
4004                     GvIOp(dstr) = (IO*)sref;
4005                     break;
4006                 case SVt_PVFM:
4007                     if (intro)
4008                         SAVEGENERICSV(GvFORM(dstr));
4009                     else
4010                         dref = (SV*)GvFORM(dstr);
4011                     GvFORM(dstr) = (CV*)sref;
4012                     break;
4013                 default:
4014                     if (intro)
4015                         SAVEGENERICSV(GvSV(dstr));
4016                     else
4017                         dref = (SV*)GvSV(dstr);
4018                     GvSV(dstr) = sref;
4019                     if (!GvIMPORTED_SV(dstr)
4020                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4021                     {
4022                         GvIMPORTED_SV_on(dstr);
4023                     }
4024                     break;
4025                 }
4026                 if (dref)
4027                     SvREFCNT_dec(dref);
4028                 if (SvTAINTED(sstr))
4029                     SvTAINT(dstr);
4030                 return;
4031             }
4032             if (SvPVX_const(dstr)) {
4033                 SvPV_free(dstr);
4034                 SvLEN_set(dstr, 0);
4035                 SvCUR_set(dstr, 0);
4036             }
4037         }
4038         (void)SvOK_off(dstr);
4039         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4040         SvROK_on(dstr);
4041         if (sflags & SVp_NOK) {
4042             SvNOKp_on(dstr);
4043             /* Only set the public OK flag if the source has public OK.  */
4044             if (sflags & SVf_NOK)
4045                 SvFLAGS(dstr) |= SVf_NOK;
4046             SvNV_set(dstr, SvNVX(sstr));
4047         }
4048         if (sflags & SVp_IOK) {
4049             (void)SvIOKp_on(dstr);
4050             if (sflags & SVf_IOK)
4051                 SvFLAGS(dstr) |= SVf_IOK;
4052             if (sflags & SVf_IVisUV)
4053                 SvIsUV_on(dstr);
4054             SvIV_set(dstr, SvIVX(sstr));
4055         }
4056         if (SvAMAGIC(sstr)) {
4057             SvAMAGIC_on(dstr);
4058         }
4059     }
4060     else if (sflags & SVp_POK) {
4061         bool isSwipe = 0;
4062
4063         /*
4064          * Check to see if we can just swipe the string.  If so, it's a
4065          * possible small lose on short strings, but a big win on long ones.
4066          * It might even be a win on short strings if SvPVX_const(dstr)
4067          * has to be allocated and SvPVX_const(sstr) has to be freed.
4068          */
4069
4070         /* Whichever path we take through the next code, we want this true,
4071            and doing it now facilitates the COW check.  */
4072         (void)SvPOK_only(dstr);
4073
4074         if (
4075             /* We're not already COW  */
4076             ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4077 #ifndef PERL_OLD_COPY_ON_WRITE
4078              /* or we are, but dstr isn't a suitable target.  */
4079              || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4080 #endif
4081              )
4082             &&
4083             !(isSwipe =
4084                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
4085                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
4086                  (!(flags & SV_NOSTEAL)) &&
4087                                         /* and we're allowed to steal temps */
4088                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
4089                  SvLEN(sstr)    &&        /* and really is a string */
4090                                 /* and won't be needed again, potentially */
4091               !(PL_op && PL_op->op_type == OP_AASSIGN))
4092 #ifdef PERL_OLD_COPY_ON_WRITE
4093             && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4094                  && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4095                  && SvTYPE(sstr) >= SVt_PVIV)
4096 #endif
4097             ) {
4098             /* Failed the swipe test, and it's not a shared hash key either.
4099                Have to copy the string.  */
4100             STRLEN len = SvCUR(sstr);
4101             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
4102             Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4103             SvCUR_set(dstr, len);
4104             *SvEND(dstr) = '\0';
4105         } else {
4106             /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4107                be true in here.  */
4108             /* Either it's a shared hash key, or it's suitable for
4109                copy-on-write or we can swipe the string.  */
4110             if (DEBUG_C_TEST) {
4111                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4112                 sv_dump(sstr);
4113                 sv_dump(dstr);
4114             }
4115 #ifdef PERL_OLD_COPY_ON_WRITE
4116             if (!isSwipe) {
4117                 /* I believe I should acquire a global SV mutex if
4118                    it's a COW sv (not a shared hash key) to stop
4119                    it going un copy-on-write.
4120                    If the source SV has gone un copy on write between up there
4121                    and down here, then (assert() that) it is of the correct
4122                    form to make it copy on write again */
4123                 if ((sflags & (SVf_FAKE | SVf_READONLY))
4124                     != (SVf_FAKE | SVf_READONLY)) {
4125                     SvREADONLY_on(sstr);
4126                     SvFAKE_on(sstr);
4127                     /* Make the source SV into a loop of 1.
4128                        (about to become 2) */
4129                     SV_COW_NEXT_SV_SET(sstr, sstr);
4130                 }
4131             }
4132 #endif
4133             /* Initial code is common.  */
4134             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
4135                 SvPV_free(dstr);
4136             }
4137
4138             if (!isSwipe) {
4139                 /* making another shared SV.  */
4140                 STRLEN cur = SvCUR(sstr);
4141                 STRLEN len = SvLEN(sstr);
4142 #ifdef PERL_OLD_COPY_ON_WRITE
4143                 if (len) {
4144                     assert (SvTYPE(dstr) >= SVt_PVIV);
4145                     /* SvIsCOW_normal */
4146                     /* splice us in between source and next-after-source.  */
4147                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4148                     SV_COW_NEXT_SV_SET(sstr, dstr);
4149                     SvPV_set(dstr, SvPVX_mutable(sstr));
4150                 } else
4151 #endif
4152                 {
4153                     /* SvIsCOW_shared_hash */
4154                     DEBUG_C(PerlIO_printf(Perl_debug_log,
4155                                           "Copy on write: Sharing hash\n"));
4156
4157                     assert (SvTYPE(dstr) >= SVt_PV);
4158                     SvPV_set(dstr,
4159                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4160                 }
4161                 SvLEN_set(dstr, len);
4162                 SvCUR_set(dstr, cur);
4163                 SvREADONLY_on(dstr);
4164                 SvFAKE_on(dstr);
4165                 /* Relesase a global SV mutex.  */
4166             }
4167             else
4168                 {       /* Passes the swipe test.  */
4169                 SvPV_set(dstr, SvPVX_mutable(sstr));
4170                 SvLEN_set(dstr, SvLEN(sstr));
4171                 SvCUR_set(dstr, SvCUR(sstr));
4172
4173                 SvTEMP_off(dstr);
4174                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
4175                 SvPV_set(sstr, Nullch);
4176                 SvLEN_set(sstr, 0);
4177                 SvCUR_set(sstr, 0);
4178                 SvTEMP_off(sstr);
4179             }
4180         }
4181         if (sflags & SVf_UTF8)
4182             SvUTF8_on(dstr);
4183         if (sflags & SVp_NOK) {
4184             SvNOKp_on(dstr);
4185             if (sflags & SVf_NOK)
4186                 SvFLAGS(dstr) |= SVf_NOK;
4187             SvNV_set(dstr, SvNVX(sstr));
4188         }
4189         if (sflags & SVp_IOK) {
4190             (void)SvIOKp_on(dstr);
4191             if (sflags & SVf_IOK)
4192                 SvFLAGS(dstr) |= SVf_IOK;
4193             if (sflags & SVf_IVisUV)
4194                 SvIsUV_on(dstr);
4195             SvIV_set(dstr, SvIVX(sstr));
4196         }
4197         if (SvVOK(sstr)) {
4198             MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4199             sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4200                         smg->mg_ptr, smg->mg_len);
4201             SvRMAGICAL_on(dstr);
4202         }
4203     }
4204     else if (sflags & SVp_IOK) {
4205         if (sflags & SVf_IOK)
4206             (void)SvIOK_only(dstr);
4207         else {
4208             (void)SvOK_off(dstr);
4209             (void)SvIOKp_on(dstr);
4210         }
4211         /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
4212         if (sflags & SVf_IVisUV)
4213             SvIsUV_on(dstr);
4214         SvIV_set(dstr, SvIVX(sstr));
4215         if (sflags & SVp_NOK) {
4216             if (sflags & SVf_NOK)
4217                 (void)SvNOK_on(dstr);
4218             else
4219                 (void)SvNOKp_on(dstr);
4220             SvNV_set(dstr, SvNVX(sstr));
4221         }
4222     }
4223     else if (sflags & SVp_NOK) {
4224         if (sflags & SVf_NOK)
4225             (void)SvNOK_only(dstr);
4226         else {
4227             (void)SvOK_off(dstr);
4228             SvNOKp_on(dstr);
4229         }
4230         SvNV_set(dstr, SvNVX(sstr));
4231     }
4232     else {
4233         if (dtype == SVt_PVGV) {
4234             if (ckWARN(WARN_MISC))
4235                 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4236         }
4237         else
4238             (void)SvOK_off(dstr);
4239     }
4240     if (SvTAINTED(sstr))
4241         SvTAINT(dstr);
4242 }
4243
4244 /*
4245 =for apidoc sv_setsv_mg
4246
4247 Like C<sv_setsv>, but also handles 'set' magic.
4248
4249 =cut
4250 */
4251
4252 void
4253 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4254 {
4255     sv_setsv(dstr,sstr);
4256     SvSETMAGIC(dstr);
4257 }
4258
4259 #ifdef PERL_OLD_COPY_ON_WRITE
4260 SV *
4261 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4262 {
4263     STRLEN cur = SvCUR(sstr);
4264     STRLEN len = SvLEN(sstr);
4265     register char *new_pv;
4266
4267     if (DEBUG_C_TEST) {
4268         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4269                       sstr, dstr);
4270         sv_dump(sstr);
4271         if (dstr)
4272                     sv_dump(dstr);
4273     }
4274
4275     if (dstr) {
4276         if (SvTHINKFIRST(dstr))
4277             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4278         else if (SvPVX_const(dstr))
4279             Safefree(SvPVX_const(dstr));
4280     }
4281     else
4282         new_SV(dstr);
4283     SvUPGRADE(dstr, SVt_PVIV);
4284
4285     assert (SvPOK(sstr));
4286     assert (SvPOKp(sstr));
4287     assert (!SvIOK(sstr));
4288     assert (!SvIOKp(sstr));
4289     assert (!SvNOK(sstr));
4290     assert (!SvNOKp(sstr));
4291
4292     if (SvIsCOW(sstr)) {
4293
4294         if (SvLEN(sstr) == 0) {
4295             /* source is a COW shared hash key.  */
4296             DEBUG_C(PerlIO_printf(Perl_debug_log,
4297                                   "Fast copy on write: Sharing hash\n"));
4298             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4299             goto common_exit;
4300         }
4301         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4302     } else {
4303         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4304         SvUPGRADE(sstr, SVt_PVIV);
4305         SvREADONLY_on(sstr);
4306         SvFAKE_on(sstr);
4307         DEBUG_C(PerlIO_printf(Perl_debug_log,
4308                               "Fast copy on write: Converting sstr to COW\n"));
4309         SV_COW_NEXT_SV_SET(dstr, sstr);
4310     }
4311     SV_COW_NEXT_SV_SET(sstr, dstr);
4312     new_pv = SvPVX_mutable(sstr);
4313
4314   common_exit:
4315     SvPV_set(dstr, new_pv);
4316     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4317     if (SvUTF8(sstr))
4318         SvUTF8_on(dstr);
4319     SvLEN_set(dstr, len);
4320     SvCUR_set(dstr, cur);
4321     if (DEBUG_C_TEST) {
4322         sv_dump(dstr);
4323     }
4324     return dstr;
4325 }
4326 #endif
4327
4328 /*
4329 =for apidoc sv_setpvn
4330
4331 Copies a string into an SV.  The C<len> parameter indicates the number of
4332 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
4333 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
4334
4335 =cut
4336 */
4337
4338 void
4339 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4340 {
4341     register char *dptr;
4342
4343     SV_CHECK_THINKFIRST_COW_DROP(sv);
4344     if (!ptr) {
4345         (void)SvOK_off(sv);
4346         return;
4347     }
4348     else {
4349         /* len is STRLEN which is unsigned, need to copy to signed */
4350         const IV iv = len;
4351         if (iv < 0)
4352             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4353     }
4354     SvUPGRADE(sv, SVt_PV);
4355
4356     dptr = SvGROW(sv, len + 1);
4357     Move(ptr,dptr,len,char);
4358     dptr[len] = '\0';
4359     SvCUR_set(sv, len);
4360     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4361     SvTAINT(sv);
4362 }
4363
4364 /*
4365 =for apidoc sv_setpvn_mg
4366
4367 Like C<sv_setpvn>, but also handles 'set' magic.
4368
4369 =cut
4370 */
4371
4372 void
4373 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4374 {
4375     sv_setpvn(sv,ptr,len);
4376     SvSETMAGIC(sv);
4377 }
4378
4379 /*
4380 =for apidoc sv_setpv
4381
4382 Copies a string into an SV.  The string must be null-terminated.  Does not
4383 handle 'set' magic.  See C<sv_setpv_mg>.
4384
4385 =cut
4386 */
4387
4388 void
4389 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4390 {
4391     register STRLEN len;
4392
4393     SV_CHECK_THINKFIRST_COW_DROP(sv);
4394     if (!ptr) {
4395         (void)SvOK_off(sv);
4396         return;
4397     }
4398     len = strlen(ptr);
4399     SvUPGRADE(sv, SVt_PV);
4400
4401     SvGROW(sv, len + 1);
4402     Move(ptr,SvPVX(sv),len+1,char);
4403     SvCUR_set(sv, len);
4404     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4405     SvTAINT(sv);
4406 }
4407
4408 /*
4409 =for apidoc sv_setpv_mg
4410
4411 Like C<sv_setpv>, but also handles 'set' magic.
4412
4413 =cut
4414 */
4415
4416 void
4417 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4418 {
4419     sv_setpv(sv,ptr);
4420     SvSETMAGIC(sv);
4421 }
4422
4423 /*
4424 =for apidoc sv_usepvn
4425
4426 Tells an SV to use C<ptr> to find its string value.  Normally the string is
4427 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4428 The C<ptr> should point to memory that was allocated by C<malloc>.  The
4429 string length, C<len>, must be supplied.  This function will realloc the
4430 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4431 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
4432 See C<sv_usepvn_mg>.
4433
4434 =cut
4435 */
4436
4437 void
4438 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4439 {
4440     STRLEN allocate;
4441     SV_CHECK_THINKFIRST_COW_DROP(sv);
4442     SvUPGRADE(sv, SVt_PV);
4443     if (!ptr) {
4444         (void)SvOK_off(sv);
4445         return;
4446     }
4447     if (SvPVX_const(sv))
4448         SvPV_free(sv);
4449
4450     allocate = PERL_STRLEN_ROUNDUP(len + 1);
4451     ptr = saferealloc (ptr, allocate);
4452     SvPV_set(sv, ptr);
4453     SvCUR_set(sv, len);
4454     SvLEN_set(sv, allocate);
4455     *SvEND(sv) = '\0';
4456     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4457     SvTAINT(sv);
4458 }
4459
4460 /*
4461 =for apidoc sv_usepvn_mg
4462
4463 Like C<sv_usepvn>, but also handles 'set' magic.
4464
4465 =cut
4466 */
4467
4468 void
4469 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4470 {
4471     sv_usepvn(sv,ptr,len);
4472     SvSETMAGIC(sv);
4473 }
4474
4475 #ifdef PERL_OLD_COPY_ON_WRITE
4476 /* Need to do this *after* making the SV normal, as we need the buffer
4477    pointer to remain valid until after we've copied it.  If we let go too early,
4478    another thread could invalidate it by unsharing last of the same hash key
4479    (which it can do by means other than releasing copy-on-write Svs)
4480    or by changing the other copy-on-write SVs in the loop.  */
4481 STATIC void
4482 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4483 {
4484     if (len) { /* this SV was SvIsCOW_normal(sv) */
4485          /* we need to find the SV pointing to us.  */
4486         SV *current = SV_COW_NEXT_SV(after);
4487
4488         if (current == sv) {
4489             /* The SV we point to points back to us (there were only two of us
4490                in the loop.)
4491                Hence other SV is no longer copy on write either.  */
4492             SvFAKE_off(after);
4493             SvREADONLY_off(after);
4494         } else {
4495             /* We need to follow the pointers around the loop.  */
4496             SV *next;
4497             while ((next = SV_COW_NEXT_SV(current)) != sv) {
4498                 assert (next);
4499                 current = next;
4500                  /* don't loop forever if the structure is bust, and we have
4501                     a pointer into a closed loop.  */
4502                 assert (current != after);
4503                 assert (SvPVX_const(current) == pvx);
4504             }
4505             /* Make the SV before us point to the SV after us.  */
4506             SV_COW_NEXT_SV_SET(current, after);
4507         }
4508     } else {
4509         unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4510     }
4511 }
4512
4513 int
4514 Perl_sv_release_IVX(pTHX_ register SV *sv)
4515 {
4516     if (SvIsCOW(sv))
4517         sv_force_normal_flags(sv, 0);
4518     SvOOK_off(sv);
4519     return 0;
4520 }
4521 #endif
4522 /*
4523 =for apidoc sv_force_normal_flags
4524
4525 Undo various types of fakery on an SV: if the PV is a shared string, make
4526 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4527 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4528 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4529 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4530 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4531 set to some other value.) In addition, the C<flags> parameter gets passed to
4532 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4533 with flags set to 0.
4534
4535 =cut
4536 */
4537
4538 void
4539 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4540 {
4541 #ifdef PERL_OLD_COPY_ON_WRITE
4542     if (SvREADONLY(sv)) {
4543         /* At this point I believe I should acquire a global SV mutex.  */
4544         if (SvFAKE(sv)) {
4545             const char *pvx = SvPVX_const(sv);
4546             const STRLEN len = SvLEN(sv);
4547             const STRLEN cur = SvCUR(sv);
4548             SV * const next = SV_COW_NEXT_SV(sv);   /* next COW sv in the loop. */
4549             if (DEBUG_C_TEST) {
4550                 PerlIO_printf(Perl_debug_log,
4551                               "Copy on write: Force normal %ld\n",
4552                               (long) flags);
4553                 sv_dump(sv);
4554             }
4555             SvFAKE_off(sv);
4556             SvREADONLY_off(sv);
4557             /* This SV doesn't own the buffer, so need to New() a new one:  */
4558             SvPV_set(sv, (char*)0);
4559             SvLEN_set(sv, 0);
4560             if (flags & SV_COW_DROP_PV) {
4561                 /* OK, so we don't need to copy our buffer.  */
4562                 SvPOK_off(sv);
4563             } else {
4564                 SvGROW(sv, cur + 1);
4565                 Move(pvx,SvPVX(sv),cur,char);
4566                 SvCUR_set(sv, cur);
4567                 *SvEND(sv) = '\0';
4568             }
4569             sv_release_COW(sv, pvx, len, next);
4570             if (DEBUG_C_TEST) {
4571                 sv_dump(sv);
4572             }
4573         }
4574         else if (IN_PERL_RUNTIME)
4575             Perl_croak(aTHX_ PL_no_modify);
4576         /* At this point I believe that I can drop the global SV mutex.  */
4577     }
4578 #else
4579     if (SvREADONLY(sv)) {
4580         if (SvFAKE(sv)) {
4581             const char *pvx = SvPVX_const(sv);
4582             const STRLEN len = SvCUR(sv);
4583             SvFAKE_off(sv);
4584             SvREADONLY_off(sv);
4585             SvPV_set(sv, Nullch);
4586             SvLEN_set(sv, 0);
4587             SvGROW(sv, len + 1);
4588             Move(pvx,SvPVX_const(sv),len,char);
4589             *SvEND(sv) = '\0';
4590             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4591         }
4592         else if (IN_PERL_RUNTIME)
4593             Perl_croak(aTHX_ PL_no_modify);
4594     }
4595 #endif
4596     if (SvROK(sv))
4597         sv_unref_flags(sv, flags);
4598     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4599         sv_unglob(sv);
4600 }
4601
4602 /*
4603 =for apidoc sv_force_normal
4604
4605 Undo various types of fakery on an SV: if the PV is a shared string, make
4606 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4607 an xpvmg. See also C<sv_force_normal_flags>.
4608
4609 =cut
4610 */
4611
4612 void
4613 Perl_sv_force_normal(pTHX_ register SV *sv)
4614 {
4615     sv_force_normal_flags(sv, 0);
4616 }
4617
4618 /*
4619 =for apidoc sv_chop
4620
4621 Efficient removal of characters from the beginning of the string buffer.
4622 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4623 the string buffer.  The C<ptr> becomes the first character of the adjusted
4624 string. Uses the "OOK hack".
4625 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4626 refer to the same chunk of data.
4627
4628 =cut
4629 */
4630
4631 void
4632 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4633 {
4634     register STRLEN delta;
4635     if (!ptr || !SvPOKp(sv))
4636         return;
4637     delta = ptr - SvPVX_const(sv);
4638     SV_CHECK_THINKFIRST(sv);
4639     if (SvTYPE(sv) < SVt_PVIV)
4640         sv_upgrade(sv,SVt_PVIV);
4641
4642     if (!SvOOK(sv)) {
4643         if (!SvLEN(sv)) { /* make copy of shared string */
4644             const char *pvx = SvPVX_const(sv);
4645             const STRLEN len = SvCUR(sv);
4646             SvGROW(sv, len + 1);
4647             Move(pvx,SvPVX_const(sv),len,char);
4648             *SvEND(sv) = '\0';
4649         }
4650         SvIV_set(sv, 0);
4651         /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4652            and we do that anyway inside the SvNIOK_off
4653         */
4654         SvFLAGS(sv) |= SVf_OOK;
4655     }
4656     SvNIOK_off(sv);
4657     SvLEN_set(sv, SvLEN(sv) - delta);
4658     SvCUR_set(sv, SvCUR(sv) - delta);
4659     SvPV_set(sv, SvPVX(sv) + delta);
4660     SvIV_set(sv, SvIVX(sv) + delta);
4661 }
4662
4663 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
4664  * this function provided for binary compatibility only
4665  */
4666
4667 void
4668 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
4669 {
4670     sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
4671 }
4672
4673 /*
4674 =for apidoc sv_catpvn
4675
4676 Concatenates the string onto the end of the string which is in the SV.  The
4677 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4678 status set, then the bytes appended should be valid UTF-8.
4679 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4680
4681 =for apidoc sv_catpvn_flags
4682
4683 Concatenates the string onto the end of the string which is in the SV.  The
4684 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4685 status set, then the bytes appended should be valid UTF-8.
4686 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4687 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4688 in terms of this function.
4689
4690 =cut
4691 */
4692
4693 void
4694 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4695 {
4696     STRLEN dlen;
4697     const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4698
4699     SvGROW(dsv, dlen + slen + 1);
4700     if (sstr == dstr)
4701         sstr = SvPVX_const(dsv);
4702     Move(sstr, SvPVX(dsv) + dlen, slen, char);
4703     SvCUR_set(dsv, SvCUR(dsv) + slen);
4704     *SvEND(dsv) = '\0';
4705     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
4706     SvTAINT(dsv);
4707 }
4708
4709 /*
4710 =for apidoc sv_catpvn_mg
4711
4712 Like C<sv_catpvn>, but also handles 'set' magic.
4713
4714 =cut
4715 */
4716
4717 void
4718 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4719 {
4720     sv_catpvn(sv,ptr,len);
4721     SvSETMAGIC(sv);
4722 }
4723
4724 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
4725  * this function provided for binary compatibility only
4726  */
4727
4728 void
4729 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
4730 {
4731     sv_catsv_flags(dstr, sstr, SV_GMAGIC);
4732 }
4733
4734 /*
4735 =for apidoc sv_catsv
4736
4737 Concatenates the string from SV C<ssv> onto the end of the string in
4738 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
4739 not 'set' magic.  See C<sv_catsv_mg>.
4740
4741 =for apidoc sv_catsv_flags
4742
4743 Concatenates the string from SV C<ssv> onto the end of the string in
4744 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
4745 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4746 and C<sv_catsv_nomg> are implemented in terms of this function.
4747
4748 =cut */
4749
4750 void
4751 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4752 {
4753     const char *spv;
4754     STRLEN slen;
4755     if (!ssv)
4756         return;
4757     if ((spv = SvPV_const(ssv, slen))) {
4758         /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4759             gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4760             Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4761             get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
4762             dsv->sv_flags doesn't have that bit set.
4763                 Andy Dougherty  12 Oct 2001
4764         */
4765         const I32 sutf8 = DO_UTF8(ssv);
4766         I32 dutf8;
4767
4768         if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4769             mg_get(dsv);
4770         dutf8 = DO_UTF8(dsv);
4771
4772         if (dutf8 != sutf8) {
4773             if (dutf8) {
4774                 /* Not modifying source SV, so taking a temporary copy. */
4775                 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4776
4777                 sv_utf8_upgrade(csv);
4778                 spv = SvPV_const(csv, slen);
4779             }
4780             else
4781                 sv_utf8_upgrade_nomg(dsv);
4782         }
4783         sv_catpvn_nomg(dsv, spv, slen);
4784     }
4785 }
4786
4787 /*
4788 =for apidoc sv_catsv_mg
4789
4790 Like C<sv_catsv>, but also handles 'set' magic.
4791
4792 =cut
4793 */
4794
4795 void
4796 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4797 {
4798     sv_catsv(dsv,ssv);
4799     SvSETMAGIC(dsv);
4800 }
4801
4802 /*
4803 =for apidoc sv_catpv
4804
4805 Concatenates the string onto the end of the string which is in the SV.
4806 If the SV has the UTF-8 status set, then the bytes appended should be
4807 valid UTF-8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
4808
4809 =cut */
4810
4811 void
4812 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4813 {
4814     register STRLEN len;
4815     STRLEN tlen;
4816     char *junk;
4817
4818     if (!ptr)
4819         return;
4820     junk = SvPV_force(sv, tlen);
4821     len = strlen(ptr);
4822     SvGROW(sv, tlen + len + 1);
4823     if (ptr == junk)
4824         ptr = SvPVX_const(sv);
4825     Move(ptr,SvPVX(sv)+tlen,len+1,char);
4826     SvCUR_set(sv, SvCUR(sv) + len);
4827     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4828     SvTAINT(sv);
4829 }
4830
4831 /*
4832 =for apidoc sv_catpv_mg
4833
4834 Like C<sv_catpv>, but also handles 'set' magic.
4835
4836 =cut
4837 */
4838
4839 void
4840 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4841 {
4842     sv_catpv(sv,ptr);
4843     SvSETMAGIC(sv);
4844 }
4845
4846 /*
4847 =for apidoc newSV
4848
4849 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4850 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4851 macro.
4852
4853 =cut
4854 */
4855
4856 SV *
4857 Perl_newSV(pTHX_ STRLEN len)
4858 {
4859     register SV *sv;
4860
4861     new_SV(sv);
4862     if (len) {
4863         sv_upgrade(sv, SVt_PV);
4864         SvGROW(sv, len + 1);
4865     }
4866     return sv;
4867 }
4868 /*
4869 =for apidoc sv_magicext
4870
4871 Adds magic to an SV, upgrading it if necessary. Applies the
4872 supplied vtable and returns a pointer to the magic added.
4873
4874 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4875 In particular, you can add magic to SvREADONLY SVs, and add more than
4876 one instance of the same 'how'.
4877
4878 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4879 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4880 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4881 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4882
4883 (This is now used as a subroutine by C<sv_magic>.)
4884
4885 =cut
4886 */
4887 MAGIC *
4888 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4889                  const char* name, I32 namlen)
4890 {
4891     MAGIC* mg;
4892
4893     if (SvTYPE(sv) < SVt_PVMG) {
4894         SvUPGRADE(sv, SVt_PVMG);
4895     }
4896     Newz(702,mg, 1, MAGIC);
4897     mg->mg_moremagic = SvMAGIC(sv);
4898     SvMAGIC_set(sv, mg);
4899
4900     /* Sometimes a magic contains a reference loop, where the sv and
4901        object refer to each other.  To prevent a reference loop that
4902        would prevent such objects being freed, we look for such loops
4903        and if we find one we avoid incrementing the object refcount.
4904
4905        Note we cannot do this to avoid self-tie loops as intervening RV must
4906        have its REFCNT incremented to keep it in existence.
4907
4908     */
4909     if (!obj || obj == sv ||
4910         how == PERL_MAGIC_arylen ||
4911         how == PERL_MAGIC_qr ||
4912         how == PERL_MAGIC_symtab ||
4913         (SvTYPE(obj) == SVt_PVGV &&
4914             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4915             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4916             GvFORM(obj) == (CV*)sv)))
4917     {
4918         mg->mg_obj = obj;
4919     }
4920     else {
4921         mg->mg_obj = SvREFCNT_inc(obj);
4922         mg->mg_flags |= MGf_REFCOUNTED;
4923     }
4924
4925     /* Normal self-ties simply pass a null object, and instead of
4926        using mg_obj directly, use the SvTIED_obj macro to produce a
4927        new RV as needed.  For glob "self-ties", we are tieing the PVIO
4928        with an RV obj pointing to the glob containing the PVIO.  In
4929        this case, to avoid a reference loop, we need to weaken the
4930        reference.
4931     */
4932
4933     if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4934         obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4935     {
4936       sv_rvweaken(obj);
4937     }
4938
4939     mg->mg_type = how;
4940     mg->mg_len = namlen;
4941     if (name) {
4942         if (namlen > 0)
4943             mg->mg_ptr = savepvn(name, namlen);
4944         else if (namlen == HEf_SVKEY)
4945             mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4946         else
4947             mg->mg_ptr = (char *) name;
4948     }
4949     mg->mg_virtual = vtable;
4950
4951     mg_magical(sv);
4952     if (SvGMAGICAL(sv))
4953         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4954     return mg;
4955 }
4956
4957 /*
4958 =for apidoc sv_magic
4959
4960 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4961 then adds a new magic item of type C<how> to the head of the magic list.
4962
4963 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4964 handling of the C<name> and C<namlen> arguments.
4965
4966 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4967 to add more than one instance of the same 'how'.
4968
4969 =cut
4970 */
4971
4972 void
4973 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4974 {
4975     const MGVTBL *vtable = 0;
4976     MAGIC* mg;
4977
4978 #ifdef PERL_OLD_COPY_ON_WRITE
4979     if (SvIsCOW(sv))
4980         sv_force_normal_flags(sv, 0);
4981 #endif
4982     if (SvREADONLY(sv)) {
4983         if (IN_PERL_RUNTIME
4984             && how != PERL_MAGIC_regex_global
4985             && how != PERL_MAGIC_bm
4986             && how != PERL_MAGIC_fm
4987             && how != PERL_MAGIC_sv
4988             && how != PERL_MAGIC_backref
4989            )
4990         {
4991             Perl_croak(aTHX_ PL_no_modify);
4992         }
4993     }
4994     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4995         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4996             /* sv_magic() refuses to add a magic of the same 'how' as an
4997                existing one
4998              */
4999             if (how == PERL_MAGIC_taint)
5000                 mg->mg_len |= 1;
5001             return;
5002         }
5003     }
5004
5005     switch (how) {
5006     case PERL_MAGIC_sv:
5007         vtable = &PL_vtbl_sv;
5008         break;
5009     case PERL_MAGIC_overload:
5010         vtable = &PL_vtbl_amagic;
5011         break;
5012     case PERL_MAGIC_overload_elem:
5013         vtable = &PL_vtbl_amagicelem;
5014         break;
5015     case PERL_MAGIC_overload_table:
5016         vtable = &PL_vtbl_ovrld;
5017         break;
5018     case PERL_MAGIC_bm:
5019         vtable = &PL_vtbl_bm;
5020         break;
5021     case PERL_MAGIC_regdata:
5022         vtable = &PL_vtbl_regdata;
5023         break;
5024     case PERL_MAGIC_regdatum:
5025         vtable = &PL_vtbl_regdatum;
5026         break;
5027     case PERL_MAGIC_env:
5028         vtable = &PL_vtbl_env;
5029         break;
5030     case PERL_MAGIC_fm:
5031         vtable = &PL_vtbl_fm;
5032         break;
5033     case PERL_MAGIC_envelem:
5034         vtable = &PL_vtbl_envelem;
5035         break;
5036     case PERL_MAGIC_regex_global:
5037         vtable = &PL_vtbl_mglob;
5038         break;
5039     case PERL_MAGIC_isa:
5040         vtable = &PL_vtbl_isa;
5041         break;
5042     case PERL_MAGIC_isaelem:
5043         vtable = &PL_vtbl_isaelem;
5044         break;
5045     case PERL_MAGIC_nkeys:
5046         vtable = &PL_vtbl_nkeys;
5047         break;
5048     case PERL_MAGIC_dbfile:
5049         vtable = 0;
5050         break;
5051     case PERL_MAGIC_dbline:
5052         vtable = &PL_vtbl_dbline;
5053         break;
5054 #ifdef USE_LOCALE_COLLATE
5055     case PERL_MAGIC_collxfrm:
5056         vtable = &PL_vtbl_collxfrm;
5057         break;
5058 #endif /* USE_LOCALE_COLLATE */
5059     case PERL_MAGIC_tied:
5060         vtable = &PL_vtbl_pack;
5061         break;
5062     case PERL_MAGIC_tiedelem:
5063     case PERL_MAGIC_tiedscalar:
5064         vtable = &PL_vtbl_packelem;
5065         break;
5066     case PERL_MAGIC_qr:
5067         vtable = &PL_vtbl_regexp;
5068         break;
5069     case PERL_MAGIC_sig:
5070         vtable = &PL_vtbl_sig;
5071         break;
5072     case PERL_MAGIC_sigelem:
5073         vtable = &PL_vtbl_sigelem;
5074         break;
5075     case PERL_MAGIC_taint:
5076         vtable = &PL_vtbl_taint;
5077         break;
5078     case PERL_MAGIC_uvar:
5079         vtable = &PL_vtbl_uvar;
5080         break;
5081     case PERL_MAGIC_vec:
5082         vtable = &PL_vtbl_vec;
5083         break;
5084     case PERL_MAGIC_arylen_p:
5085     case PERL_MAGIC_rhash:
5086     case PERL_MAGIC_symtab:
5087     case PERL_MAGIC_vstring:
5088         vtable = 0;
5089         break;
5090     case PERL_MAGIC_utf8:
5091         vtable = &PL_vtbl_utf8;
5092         break;
5093     case PERL_MAGIC_substr:
5094         vtable = &PL_vtbl_substr;
5095         break;
5096     case PERL_MAGIC_defelem:
5097         vtable = &PL_vtbl_defelem;
5098         break;
5099     case PERL_MAGIC_glob:
5100         vtable = &PL_vtbl_glob;
5101         break;
5102     case PERL_MAGIC_arylen:
5103         vtable = &PL_vtbl_arylen;
5104         break;
5105     case PERL_MAGIC_pos:
5106         vtable = &PL_vtbl_pos;
5107         break;
5108     case PERL_MAGIC_backref:
5109         vtable = &PL_vtbl_backref;
5110         break;
5111     case PERL_MAGIC_ext:
5112         /* Reserved for use by extensions not perl internals.           */
5113         /* Useful for attaching extension internal data to perl vars.   */
5114         /* Note that multiple extensions may clash if magical scalars   */
5115         /* etc holding private data from one are passed to another.     */
5116         break;
5117     default:
5118         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5119     }
5120
5121     /* Rest of work is done else where */
5122     mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5123
5124     switch (how) {
5125     case PERL_MAGIC_taint:
5126         mg->mg_len = 1;
5127         break;
5128     case PERL_MAGIC_ext:
5129     case PERL_MAGIC_dbfile:
5130         SvRMAGICAL_on(sv);
5131         break;
5132     }
5133 }
5134
5135 /*
5136 =for apidoc sv_unmagic
5137
5138 Removes all magic of type C<type> from an SV.
5139
5140 =cut
5141 */
5142
5143 int
5144 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5145 {
5146     MAGIC* mg;
5147     MAGIC** mgp;
5148     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5149         return 0;
5150     mgp = &SvMAGIC(sv);
5151     for (mg = *mgp; mg; mg = *mgp) {
5152         if (mg->mg_type == type) {
5153             const MGVTBL* const vtbl = mg->mg_virtual;
5154             *mgp = mg->mg_moremagic;
5155             if (vtbl && vtbl->svt_free)
5156                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5157             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5158                 if (mg->mg_len > 0)
5159                     Safefree(mg->mg_ptr);
5160                 else if (mg->mg_len == HEf_SVKEY)
5161                     SvREFCNT_dec((SV*)mg->mg_ptr);
5162                 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5163                     Safefree(mg->mg_ptr);
5164             }
5165             if (mg->mg_flags & MGf_REFCOUNTED)
5166                 SvREFCNT_dec(mg->mg_obj);
5167             Safefree(mg);
5168         }
5169         else
5170             mgp = &mg->mg_moremagic;
5171     }
5172     if (!SvMAGIC(sv)) {
5173         SvMAGICAL_off(sv);
5174        SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5175     }
5176
5177     return 0;
5178 }
5179
5180 /*
5181 =for apidoc sv_rvweaken
5182
5183 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5184 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5185 push a back-reference to this RV onto the array of backreferences
5186 associated with that magic.
5187
5188 =cut
5189 */
5190
5191 SV *
5192 Perl_sv_rvweaken(pTHX_ SV *sv)
5193 {
5194     SV *tsv;
5195     if (!SvOK(sv))  /* let undefs pass */
5196         return sv;
5197     if (!SvROK(sv))
5198         Perl_croak(aTHX_ "Can't weaken a nonreference");
5199     else if (SvWEAKREF(sv)) {
5200         if (ckWARN(WARN_MISC))
5201             Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5202         return sv;
5203     }
5204     tsv = SvRV(sv);
5205     Perl_sv_add_backref(aTHX_ tsv, sv);
5206     SvWEAKREF_on(sv);
5207     SvREFCNT_dec(tsv);
5208     return sv;
5209 }
5210
5211 /* Give tsv backref magic if it hasn't already got it, then push a
5212  * back-reference to sv onto the array associated with the backref magic.
5213  */
5214
5215 void
5216 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5217 {
5218     AV *av;
5219     MAGIC *mg;
5220     if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5221         av = (AV*)mg->mg_obj;
5222     else {
5223         av = newAV();
5224         sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5225         /* av now has a refcnt of 2, which avoids it getting freed
5226          * before us during global cleanup. The extra ref is removed
5227          * by magic_killbackrefs() when tsv is being freed */
5228     }
5229     if (AvFILLp(av) >= AvMAX(av)) {
5230         av_extend(av, AvFILLp(av)+1);
5231     }
5232     AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5233 }
5234
5235 /* delete a back-reference to ourselves from the backref magic associated
5236  * with the SV we point to.
5237  */
5238
5239 STATIC void
5240 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
5241 {
5242     AV *av;
5243     SV **svp;
5244     I32 i;
5245     MAGIC *mg = NULL;
5246     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
5247         if (PL_in_clean_all)
5248             return;
5249     }
5250     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5251         Perl_croak(aTHX_ "panic: del_backref");
5252     av = (AV *)mg->mg_obj;
5253     svp = AvARRAY(av);
5254     /* We shouldn't be in here more than once, but for paranoia reasons lets
5255        not assume this.  */
5256     for (i = AvFILLp(av); i >= 0; i--) {
5257         if (svp[i] == sv) {
5258             const SSize_t fill = AvFILLp(av);
5259             if (i != fill) {
5260                 /* We weren't the last entry.
5261                    An unordered list has this property that you can take the
5262                    last element off the end to fill the hole, and it's still
5263                    an unordered list :-)
5264                 */
5265                 svp[i] = svp[fill];
5266             }
5267             svp[fill] = Nullsv;
5268             AvFILLp(av) = fill - 1;
5269         }
5270     }
5271 }
5272
5273 /*
5274 =for apidoc sv_insert
5275
5276 Inserts a string at the specified offset/length within the SV. Similar to
5277 the Perl substr() function.
5278
5279 =cut
5280 */
5281
5282 void
5283 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5284 {
5285     register char *big;
5286     register char *mid;
5287     register char *midend;
5288     register char *bigend;
5289     register I32 i;
5290     STRLEN curlen;
5291
5292
5293     if (!bigstr)
5294         Perl_croak(aTHX_ "Can't modify non-existent substring");
5295     SvPV_force(bigstr, curlen);
5296     (void)SvPOK_only_UTF8(bigstr);
5297     if (offset + len > curlen) {
5298         SvGROW(bigstr, offset+len+1);
5299         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5300         SvCUR_set(bigstr, offset+len);
5301     }
5302
5303     SvTAINT(bigstr);
5304     i = littlelen - len;
5305     if (i > 0) {                        /* string might grow */
5306         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5307         mid = big + offset + len;
5308         midend = bigend = big + SvCUR(bigstr);
5309         bigend += i;
5310         *bigend = '\0';
5311         while (midend > mid)            /* shove everything down */
5312             *--bigend = *--midend;
5313         Move(little,big+offset,littlelen,char);
5314         SvCUR_set(bigstr, SvCUR(bigstr) + i);
5315         SvSETMAGIC(bigstr);
5316         return;
5317     }
5318     else if (i == 0) {
5319         Move(little,SvPVX(bigstr)+offset,len,char);
5320         SvSETMAGIC(bigstr);
5321         return;
5322     }
5323
5324     big = SvPVX(bigstr);
5325     mid = big + offset;
5326     midend = mid + len;
5327     bigend = big + SvCUR(bigstr);
5328
5329     if (midend > bigend)
5330         Perl_croak(aTHX_ "panic: sv_insert");
5331
5332     if (mid - big > bigend - midend) {  /* faster to shorten from end */
5333         if (littlelen) {
5334             Move(little, mid, littlelen,char);
5335             mid += littlelen;
5336         }
5337         i = bigend - midend;
5338         if (i > 0) {
5339             Move(midend, mid, i,char);
5340             mid += i;
5341         }
5342         *mid = '\0';
5343         SvCUR_set(bigstr, mid - big);
5344     }
5345     else if ((i = mid - big)) { /* faster from front */
5346         midend -= littlelen;
5347         mid = midend;
5348         sv_chop(bigstr,midend-i);
5349         big += i;
5350         while (i--)
5351             *--midend = *--big;
5352         if (littlelen)
5353             Move(little, mid, littlelen,char);
5354     }
5355     else if (littlelen) {
5356         midend -= littlelen;
5357         sv_chop(bigstr,midend);
5358         Move(little,midend,littlelen,char);
5359     }
5360     else {
5361         sv_chop(bigstr,midend);
5362     }
5363     SvSETMAGIC(bigstr);
5364 }
5365
5366 /*
5367 =for apidoc sv_replace
5368
5369 Make the first argument a copy of the second, then delete the original.
5370 The target SV physically takes over ownership of the body of the source SV
5371 and inherits its flags; however, the target keeps any magic it owns,
5372 and any magic in the source is discarded.
5373 Note that this is a rather specialist SV copying operation; most of the
5374 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5375
5376 =cut
5377 */
5378
5379 void
5380 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5381 {
5382     const U32 refcnt = SvREFCNT(sv);
5383     SV_CHECK_THINKFIRST_COW_DROP(sv);
5384     if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5385         Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5386     if (SvMAGICAL(sv)) {
5387         if (SvMAGICAL(nsv))
5388             mg_free(nsv);
5389         else
5390             sv_upgrade(nsv, SVt_PVMG);
5391         SvMAGIC_set(nsv, SvMAGIC(sv));
5392         SvFLAGS(nsv) |= SvMAGICAL(sv);
5393         SvMAGICAL_off(sv);
5394         SvMAGIC_set(sv, NULL);
5395     }
5396     SvREFCNT(sv) = 0;
5397     sv_clear(sv);
5398     assert(!SvREFCNT(sv));
5399 #ifdef DEBUG_LEAKING_SCALARS
5400     sv->sv_flags  = nsv->sv_flags;
5401     sv->sv_any    = nsv->sv_any;
5402     sv->sv_refcnt = nsv->sv_refcnt;
5403     sv->sv_u      = nsv->sv_u;
5404 #else
5405     StructCopy(nsv,sv,SV);
5406 #endif
5407     /* Currently could join these into one piece of pointer arithmetic, but
5408        it would be unclear.  */
5409     if(SvTYPE(sv) == SVt_IV)
5410         SvANY(sv)
5411             = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5412     else if (SvTYPE(sv) == SVt_RV) {
5413         SvANY(sv) = &sv->sv_u.svu_rv;
5414     }
5415
5416
5417 #ifdef PERL_OLD_COPY_ON_WRITE
5418     if (SvIsCOW_normal(nsv)) {
5419         /* We need to follow the pointers around the loop to make the
5420            previous SV point to sv, rather than nsv.  */
5421         SV *next;
5422         SV *current = nsv;
5423         while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5424             assert(next);
5425             current = next;
5426             assert(SvPVX_const(current) == SvPVX_const(nsv));
5427         }
5428         /* Make the SV before us point to the SV after us.  */
5429         if (DEBUG_C_TEST) {
5430             PerlIO_printf(Perl_debug_log, "previous is\n");
5431             sv_dump(current);
5432             PerlIO_printf(Perl_debug_log,
5433                           "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5434                           (UV) SV_COW_NEXT_SV(current), (UV) sv);
5435         }
5436         SV_COW_NEXT_SV_SET(current, sv);
5437     }
5438 #endif
5439     SvREFCNT(sv) = refcnt;
5440     SvFLAGS(nsv) |= SVTYPEMASK;         /* Mark as freed */
5441     SvREFCNT(nsv) = 0;
5442     del_SV(nsv);
5443 }
5444
5445 /*
5446 =for apidoc sv_clear
5447
5448 Clear an SV: call any destructors, free up any memory used by the body,
5449 and free the body itself. The SV's head is I<not> freed, although
5450 its type is set to all 1's so that it won't inadvertently be assumed
5451 to be live during global destruction etc.
5452 This function should only be called when REFCNT is zero. Most of the time
5453 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5454 instead.
5455
5456 =cut
5457 */
5458
5459 void
5460 Perl_sv_clear(pTHX_ register SV *sv)
5461 {
5462     dVAR;
5463     HV* stash;
5464     assert(sv);
5465     assert(SvREFCNT(sv) == 0);
5466
5467     if (SvOBJECT(sv)) {
5468         if (PL_defstash) {              /* Still have a symbol table? */
5469             dSP;
5470             do {
5471                 CV* destructor;
5472                 stash = SvSTASH(sv);
5473                 destructor = StashHANDLER(stash,DESTROY);
5474                 if (destructor) {
5475                     SV* const tmpref = newRV(sv);
5476                     SvREADONLY_on(tmpref);   /* DESTROY() could be naughty */
5477                     ENTER;
5478                     PUSHSTACKi(PERLSI_DESTROY);
5479                     EXTEND(SP, 2);
5480                     PUSHMARK(SP);
5481                     PUSHs(tmpref);
5482                     PUTBACK;
5483                     call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5484
5485
5486                     POPSTACK;
5487                     SPAGAIN;
5488                     LEAVE;
5489                     if(SvREFCNT(tmpref) < 2) {
5490                         /* tmpref is not kept alive! */
5491                         SvREFCNT(sv)--;
5492                         SvRV_set(tmpref, NULL);
5493                         SvROK_off(tmpref);
5494                     }
5495                     SvREFCNT_dec(tmpref);
5496                 }
5497             } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5498
5499
5500             if (SvREFCNT(sv)) {
5501                 if (PL_in_clean_objs)
5502                     Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5503                           HvNAME_get(stash));
5504                 /* DESTROY gave object new lease on life */
5505                 return;
5506             }
5507         }
5508
5509         if (SvOBJECT(sv)) {
5510             SvREFCNT_dec(SvSTASH(sv));  /* possibly of changed persuasion */
5511             SvOBJECT_off(sv);   /* Curse the object. */
5512             if (SvTYPE(sv) != SVt_PVIO)
5513                 --PL_sv_objcount;       /* XXX Might want something more general */
5514         }
5515     }
5516     if (SvTYPE(sv) >= SVt_PVMG) {
5517         if (SvMAGIC(sv))
5518             mg_free(sv);
5519         if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5520             SvREFCNT_dec(SvSTASH(sv));
5521     }
5522     stash = NULL;
5523     switch (SvTYPE(sv)) {
5524     case SVt_PVIO:
5525         if (IoIFP(sv) &&
5526             IoIFP(sv) != PerlIO_stdin() &&
5527             IoIFP(sv) != PerlIO_stdout() &&
5528             IoIFP(sv) != PerlIO_stderr())
5529         {
5530             io_close((IO*)sv, FALSE);
5531         }
5532         if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5533             PerlDir_close(IoDIRP(sv));
5534         IoDIRP(sv) = (DIR*)NULL;
5535         Safefree(IoTOP_NAME(sv));
5536         Safefree(IoFMT_NAME(sv));
5537         Safefree(IoBOTTOM_NAME(sv));
5538         /* FALL THROUGH */
5539     case SVt_PVBM:
5540         goto freescalar;
5541     case SVt_PVCV:
5542     case SVt_PVFM:
5543         cv_undef((CV*)sv);
5544         goto freescalar;
5545     case SVt_PVHV:
5546         hv_undef((HV*)sv);
5547         break;
5548     case SVt_PVAV:
5549         av_undef((AV*)sv);
5550         break;
5551     case SVt_PVLV:
5552         if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5553             SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5554             HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5555             PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5556         }
5557         else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV**  */
5558             SvREFCNT_dec(LvTARG(sv));
5559         goto freescalar;
5560     case SVt_PVGV:
5561         gp_free((GV*)sv);
5562         Safefree(GvNAME(sv));
5563         /* cannot decrease stash refcount yet, as we might recursively delete
5564            ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5565            of stash until current sv is completely gone.
5566            -- JohnPC, 27 Mar 1998 */
5567         stash = GvSTASH(sv);
5568         /* FALL THROUGH */
5569     case SVt_PVMG:
5570     case SVt_PVNV:
5571     case SVt_PVIV:
5572       freescalar:
5573         /* Don't bother with SvOOK_off(sv); as we're only going to free it.  */
5574         if (SvOOK(sv)) {
5575             SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5576             /* Don't even bother with turning off the OOK flag.  */
5577         }
5578         /* FALL THROUGH */
5579     case SVt_PV:
5580     case SVt_RV:
5581         if (SvROK(sv)) {
5582             SV *target = SvRV(sv);
5583             if (SvWEAKREF(sv))
5584                 sv_del_backref(target, sv);
5585             else
5586                 SvREFCNT_dec(target);
5587         }
5588 #ifdef PERL_OLD_COPY_ON_WRITE
5589         else if (SvPVX_const(sv)) {
5590             if (SvIsCOW(sv)) {
5591                 /* I believe I need to grab the global SV mutex here and
5592                    then recheck the COW status.  */
5593                 if (DEBUG_C_TEST) {
5594                     PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5595                     sv_dump(sv);
5596                 }
5597                 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5598                                SV_COW_NEXT_SV(sv));
5599                 /* And drop it here.  */
5600                 SvFAKE_off(sv);
5601             } else if (SvLEN(sv)) {
5602                 Safefree(SvPVX_const(sv));
5603             }
5604         }
5605 #else
5606         else if (SvPVX_const(sv) && SvLEN(sv))
5607             Safefree(SvPVX_mutable(sv));
5608         else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5609             unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5610             SvFAKE_off(sv);
5611         }
5612 #endif
5613         break;
5614 /*
5615     case SVt_NV:
5616     case SVt_IV:
5617     case SVt_NULL:
5618         break;
5619 */
5620     }
5621
5622     switch (SvTYPE(sv)) {
5623     case SVt_NULL:
5624         break;
5625     case SVt_IV:
5626         break;
5627     case SVt_NV:
5628         del_XNV(SvANY(sv));
5629         break;
5630     case SVt_RV:
5631         break;
5632     case SVt_PV:
5633         del_XPV(SvANY(sv));
5634         break;
5635     case SVt_PVIV:
5636         del_XPVIV(SvANY(sv));
5637         break;
5638     case SVt_PVNV:
5639         del_XPVNV(SvANY(sv));
5640         break;
5641     case SVt_PVMG:
5642         del_XPVMG(SvANY(sv));
5643         break;
5644     case SVt_PVLV:
5645         del_XPVLV(SvANY(sv));
5646         break;
5647     case SVt_PVAV:
5648         del_XPVAV(SvANY(sv));
5649         break;
5650     case SVt_PVHV:
5651         del_XPVHV(SvANY(sv));
5652         break;
5653     case SVt_PVCV:
5654         del_XPVCV(SvANY(sv));
5655         break;
5656     case SVt_PVGV:
5657         del_XPVGV(SvANY(sv));
5658         /* code duplication for increased performance. */
5659         SvFLAGS(sv) &= SVf_BREAK;
5660         SvFLAGS(sv) |= SVTYPEMASK;
5661         /* decrease refcount of the stash that owns this GV, if any */
5662         if (stash)
5663             sv_del_backref((SV*)stash, sv);
5664         return; /* not break, SvFLAGS reset already happened */
5665     case SVt_PVBM:
5666         del_XPVBM(SvANY(sv));
5667         break;
5668     case SVt_PVFM:
5669         del_XPVFM(SvANY(sv));
5670         break;
5671     case SVt_PVIO:
5672         del_XPVIO(SvANY(sv));
5673         break;
5674     }
5675     SvFLAGS(sv) &= SVf_BREAK;
5676     SvFLAGS(sv) |= SVTYPEMASK;
5677 }
5678
5679 /*
5680 =for apidoc sv_newref
5681
5682 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5683 instead.
5684
5685 =cut
5686 */
5687
5688 SV *
5689 Perl_sv_newref(pTHX_ SV *sv)
5690 {
5691     if (sv)
5692         (SvREFCNT(sv))++;
5693     return sv;
5694 }
5695
5696 /*
5697 =for apidoc sv_free
5698
5699 Decrement an SV's reference count, and if it drops to zero, call
5700 C<sv_clear> to invoke destructors and free up any memory used by
5701 the body; finally, deallocate the SV's head itself.
5702 Normally called via a wrapper macro C<SvREFCNT_dec>.
5703
5704 =cut
5705 */
5706
5707 void
5708 Perl_sv_free(pTHX_ SV *sv)
5709 {
5710     dVAR;
5711     if (!sv)
5712         return;
5713     if (SvREFCNT(sv) == 0) {
5714         if (SvFLAGS(sv) & SVf_BREAK)
5715             /* this SV's refcnt has been artificially decremented to
5716              * trigger cleanup */
5717             return;
5718         if (PL_in_clean_all) /* All is fair */
5719             return;
5720         if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5721             /* make sure SvREFCNT(sv)==0 happens very seldom */
5722             SvREFCNT(sv) = (~(U32)0)/2;
5723             return;
5724         }
5725         if (ckWARN_d(WARN_INTERNAL)) {
5726             Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5727                         "Attempt to free unreferenced scalar: SV 0x%"UVxf
5728                         pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5729 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5730             Perl_dump_sv_child(aTHX_ sv);
5731 #endif
5732         }
5733         return;
5734     }
5735     if (--(SvREFCNT(sv)) > 0)
5736         return;
5737     Perl_sv_free2(aTHX_ sv);
5738 }
5739
5740 void
5741 Perl_sv_free2(pTHX_ SV *sv)
5742 {
5743     dVAR;
5744 #ifdef DEBUGGING
5745     if (SvTEMP(sv)) {
5746         if (ckWARN_d(WARN_DEBUGGING))
5747             Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5748                         "Attempt to free temp prematurely: SV 0x%"UVxf
5749                         pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5750         return;
5751     }
5752 #endif
5753     if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5754         /* make sure SvREFCNT(sv)==0 happens very seldom */
5755         SvREFCNT(sv) = (~(U32)0)/2;
5756         return;
5757     }
5758     sv_clear(sv);
5759     if (! SvREFCNT(sv))
5760         del_SV(sv);
5761 }
5762
5763 /*
5764 =for apidoc sv_len
5765
5766 Returns the length of the string in the SV. Handles magic and type
5767 coercion.  See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5768
5769 =cut
5770 */
5771
5772 STRLEN
5773 Perl_sv_len(pTHX_ register SV *sv)
5774 {
5775     STRLEN len;
5776
5777     if (!sv)
5778         return 0;
5779
5780     if (SvGMAGICAL(sv))
5781         len = mg_length(sv);
5782     else
5783         (void)SvPV_const(sv, len);
5784     return len;
5785 }
5786
5787 /*
5788 =for apidoc sv_len_utf8
5789
5790 Returns the number of characters in the string in an SV, counting wide
5791 UTF-8 bytes as a single character. Handles magic and type coercion.
5792
5793 =cut
5794 */
5795
5796 /*
5797  * The length is cached in PERL_UTF8_magic, in the mg_len field.  Also the
5798  * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5799  * (Note that the mg_len is not the length of the mg_ptr field.)
5800  *
5801  */
5802
5803 STRLEN
5804 Perl_sv_len_utf8(pTHX_ register SV *sv)
5805 {
5806     if (!sv)
5807         return 0;
5808
5809     if (SvGMAGICAL(sv))
5810         return mg_length(sv);
5811     else
5812     {
5813         STRLEN len, ulen;
5814         const U8 *s = (U8*)SvPV_const(sv, len);
5815         MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5816
5817         if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5818             ulen = mg->mg_len;
5819 #ifdef PERL_UTF8_CACHE_ASSERT
5820             assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5821 #endif
5822         }
5823         else {
5824             ulen = Perl_utf8_length(aTHX_ s, s + len);
5825             if (!mg && !SvREADONLY(sv)) {
5826                 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5827                 mg = mg_find(sv, PERL_MAGIC_utf8);
5828                 assert(mg);
5829             }
5830             if (mg)
5831                 mg->mg_len = ulen;
5832         }
5833         return ulen;
5834     }
5835 }
5836
5837 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5838  * a PERL_UTF8_magic.  The mg_ptr is used to store the mapping
5839  * between UTF-8 and byte offsets.  There are two (substr offset and substr
5840  * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5841  * and byte offset) cache positions.
5842  *
5843  * The mg_len field is used by sv_len_utf8(), see its comments.
5844  * Note that the mg_len is not the length of the mg_ptr field.
5845  *
5846  */
5847 STATIC bool
5848 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5849                    I32 offsetp, const U8 *s, const U8 *start)
5850 {
5851     bool found = FALSE;
5852
5853     if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5854         if (!*mgp)
5855             *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5856         assert(*mgp);
5857
5858         if ((*mgp)->mg_ptr)
5859             *cachep = (STRLEN *) (*mgp)->mg_ptr;
5860         else {
5861             Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5862             (*mgp)->mg_ptr = (char *) *cachep;
5863         }
5864         assert(*cachep);
5865
5866         (*cachep)[i]   = offsetp;
5867         (*cachep)[i+1] = s - start;
5868         found = TRUE;
5869     }
5870
5871     return found;
5872 }
5873
5874 /*
5875  * S_utf8_mg_pos() is used to query and update mg_ptr field of
5876  * a PERL_UTF8_magic.  The mg_ptr is used to store the mapping
5877  * between UTF-8 and byte offsets.  See also the comments of
5878  * S_utf8_mg_pos_init().
5879  *
5880  */
5881 STATIC bool
5882 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)
5883 {
5884     bool found = FALSE;
5885
5886     if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5887         if (!*mgp)
5888             *mgp = mg_find(sv, PERL_MAGIC_utf8);
5889         if (*mgp && (*mgp)->mg_ptr) {
5890             *cachep = (STRLEN *) (*mgp)->mg_ptr;
5891             ASSERT_UTF8_CACHE(*cachep);
5892             if ((*cachep)[i] == (STRLEN)uoff)   /* An exact match. */
5893                  found = TRUE;
5894             else {                      /* We will skip to the right spot. */
5895                  STRLEN forw  = 0;
5896                  STRLEN backw = 0;
5897                  const U8* p = NULL;
5898
5899                  /* The assumption is that going backward is half
5900                   * the speed of going forward (that's where the
5901                   * 2 * backw in the below comes from).  (The real
5902                   * figure of course depends on the UTF-8 data.) */
5903
5904                  if ((*cachep)[i] > (STRLEN)uoff) {
5905                       forw  = uoff;
5906                       backw = (*cachep)[i] - (STRLEN)uoff;
5907
5908                       if (forw < 2 * backw)
5909                            p = start;
5910                       else
5911                            p = start + (*cachep)[i+1];
5912                  }
5913                  /* Try this only for the substr offset (i == 0),
5914                   * not for the substr length (i == 2). */
5915                  else if (i == 0) { /* (*cachep)[i] < uoff */
5916                       const STRLEN ulen = sv_len_utf8(sv);
5917
5918                       if ((STRLEN)uoff < ulen) {
5919                            forw  = (STRLEN)uoff - (*cachep)[i];
5920                            backw = ulen - (STRLEN)uoff;
5921
5922                            if (forw < 2 * backw)
5923                                 p = start + (*cachep)[i+1];
5924                            else
5925                                 p = send;
5926                       }
5927
5928                       /* If the string is not long enough for uoff,
5929                        * we could extend it, but not at this low a level. */
5930                  }
5931
5932                  if (p) {
5933                       if (forw < 2 * backw) {
5934                            while (forw--)
5935                                 p += UTF8SKIP(p);
5936                       }
5937                       else {
5938                            while (backw--) {
5939                                 p--;
5940                                 while (UTF8_IS_CONTINUATION(*p))
5941                                      p--;
5942                            }
5943                       }
5944
5945                       /* Update the cache. */
5946                       (*cachep)[i]   = (STRLEN)uoff;
5947                       (*cachep)[i+1] = p - start;
5948
5949                       /* Drop the stale "length" cache */
5950                       if (i == 0) {
5951                           (*cachep)[2] = 0;
5952                           (*cachep)[3] = 0;
5953                       }
5954
5955                       found = TRUE;
5956                  }
5957             }
5958             if (found) {        /* Setup the return values. */
5959                  *offsetp = (*cachep)[i+1];
5960                  *sp = start + *offsetp;
5961                  if (*sp >= send) {
5962                       *sp = send;
5963                       *offsetp = send - start;
5964                  }
5965                  else if (*sp < start) {
5966                       *sp = start;
5967                       *offsetp = 0;
5968                  }
5969             }
5970         }
5971 #ifdef PERL_UTF8_CACHE_ASSERT
5972         if (found) {
5973              U8 *s = start;
5974              I32 n = uoff;
5975
5976              while (n-- && s < send)
5977                   s += UTF8SKIP(s);
5978
5979              if (i == 0) {
5980                   assert(*offsetp == s - start);
5981                   assert((*cachep)[0] == (STRLEN)uoff);
5982                   assert((*cachep)[1] == *offsetp);
5983              }
5984              ASSERT_UTF8_CACHE(*cachep);
5985         }
5986 #endif
5987     }
5988
5989     return found;
5990 }
5991
5992 /*
5993 =for apidoc sv_pos_u2b
5994
5995 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5996 the start of the string, to a count of the equivalent number of bytes; if
5997 lenp is non-zero, it does the same to lenp, but this time starting from
5998 the offset, rather than from the start of the string. Handles magic and
5999 type coercion.
6000
6001 =cut
6002 */
6003
6004 /*
6005  * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6006  * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6007  * byte offsets.  See also the comments of S_utf8_mg_pos().
6008  *
6009  */
6010
6011 void
6012 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6013 {
6014     const U8 *start;
6015     STRLEN len;
6016
6017     if (!sv)
6018         return;
6019
6020     start = (U8*)SvPV_const(sv, len);
6021     if (len) {
6022         STRLEN boffset = 0;
6023         STRLEN *cache = 0;
6024         const U8 *s = start;
6025         I32 uoffset = *offsetp;
6026         const U8 *send = s + len;
6027         MAGIC *mg = 0;
6028         bool found = FALSE;
6029
6030          if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6031              found = TRUE;
6032          if (!found && uoffset > 0) {
6033               while (s < send && uoffset--)
6034                    s += UTF8SKIP(s);
6035               if (s >= send)
6036                    s = send;
6037               if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
6038                   boffset = cache[1];
6039               *offsetp = s - start;
6040          }
6041          if (lenp) {
6042               found = FALSE;
6043               start = s;
6044               if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6045                   *lenp -= boffset;
6046                   found = TRUE;
6047               }
6048               if (!found && *lenp > 0) {
6049                    I32 ulen = *lenp;
6050                    if (ulen > 0)
6051                         while (s < send && ulen--)
6052                              s += UTF8SKIP(s);
6053                    if (s >= send)
6054                         s = send;
6055                    utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
6056               }
6057               *lenp = s - start;
6058          }
6059          ASSERT_UTF8_CACHE(cache);
6060     }
6061     else {
6062          *offsetp = 0;
6063          if (lenp)
6064               *lenp = 0;
6065     }
6066
6067     return;
6068 }
6069
6070 /*
6071 =for apidoc sv_pos_b2u
6072
6073 Converts the value pointed to by offsetp from a count of bytes from the
6074 start of the string, to a count of the equivalent number of UTF-8 chars.
6075 Handles magic and type coercion.
6076
6077 =cut
6078 */
6079
6080 /*
6081  * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6082  * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6083  * byte offsets.  See also the comments of S_utf8_mg_pos().
6084  *
6085  */
6086
6087 void
6088 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6089 {
6090     const U8* s;
6091     STRLEN len;
6092
6093     if (!sv)
6094         return;
6095
6096     s = (const U8*)SvPV_const(sv, len);
6097     if ((I32)len < *offsetp)
6098         Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6099     else {
6100         const U8* send = s + *offsetp;
6101         MAGIC* mg = NULL;
6102         STRLEN *cache = NULL;
6103
6104         len = 0;
6105
6106         if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6107             mg = mg_find(sv, PERL_MAGIC_utf8);
6108             if (mg && mg->mg_ptr) {
6109                 cache = (STRLEN *) mg->mg_ptr;
6110                 if (cache[1] == (STRLEN)*offsetp) {
6111                     /* An exact match. */
6112                     *offsetp = cache[0];
6113
6114                     return;
6115                 }
6116                 else if (cache[1] < (STRLEN)*offsetp) {
6117                     /* We already know part of the way. */
6118                     len = cache[0];
6119                     s  += cache[1];
6120                     /* Let the below loop do the rest. */
6121                 }
6122                 else { /* cache[1] > *offsetp */
6123                     /* We already know all of the way, now we may
6124                      * be able to walk back.  The same assumption
6125                      * is made as in S_utf8_mg_pos(), namely that
6126                      * walking backward is twice slower than
6127                      * walking forward. */
6128                     STRLEN forw  = *offsetp;
6129                     STRLEN backw = cache[1] - *offsetp;
6130
6131                     if (!(forw < 2 * backw)) {
6132                         const U8 *p = s + cache[1];
6133                         STRLEN ubackw = 0;
6134
6135                         cache[1] -= backw;
6136
6137                         while (backw--) {
6138                             p--;
6139                             while (UTF8_IS_CONTINUATION(*p)) {
6140                                 p--;
6141                                 backw--;
6142                             }
6143                             ubackw++;
6144                         }
6145
6146                         cache[0] -= ubackw;
6147                         *offsetp = cache[0];
6148
6149                         /* Drop the stale "length" cache */
6150                         cache[2] = 0;
6151                         cache[3] = 0;
6152
6153                         return;
6154                     }
6155                 }
6156             }
6157             ASSERT_UTF8_CACHE(cache);
6158         }
6159
6160         while (s < send) {
6161             STRLEN n = 1;
6162
6163             /* Call utf8n_to_uvchr() to validate the sequence
6164              * (unless a simple non-UTF character) */
6165             if (!UTF8_IS_INVARIANT(*s))
6166                 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6167             if (n > 0) {
6168                 s += n;
6169                 len++;
6170             }
6171             else
6172                 break;
6173         }
6174
6175         if (!SvREADONLY(sv)) {
6176             if (!mg) {
6177                 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6178                 mg = mg_find(sv, PERL_MAGIC_utf8);
6179             }
6180             assert(mg);
6181
6182             if (!mg->mg_ptr) {
6183                 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6184                 mg->mg_ptr = (char *) cache;
6185             }
6186             assert(cache);
6187
6188             cache[0] = len;
6189             cache[1] = *offsetp;
6190             /* Drop the stale "length" cache */
6191             cache[2] = 0;
6192             cache[3] = 0;
6193         }
6194
6195         *offsetp = len;
6196     }
6197     return;
6198 }
6199
6200 /*
6201 =for apidoc sv_eq
6202
6203 Returns a boolean indicating whether the strings in the two SVs are
6204 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6205 coerce its args to strings if necessary.
6206
6207 =cut
6208 */
6209
6210 I32
6211 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6212 {
6213     const char *pv1;
6214     STRLEN cur1;
6215     const char *pv2;
6216     STRLEN cur2;
6217     I32  eq     = 0;
6218     char *tpv   = Nullch;
6219     SV* svrecode = Nullsv;
6220
6221     if (!sv1) {
6222         pv1 = "";
6223         cur1 = 0;
6224     }
6225     else
6226         pv1 = SvPV_const(sv1, cur1);
6227
6228     if (!sv2){
6229         pv2 = "";
6230         cur2 = 0;
6231     }
6232     else
6233         pv2 = SvPV_const(sv2, cur2);
6234
6235     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6236         /* Differing utf8ness.
6237          * Do not UTF8size the comparands as a side-effect. */
6238          if (PL_encoding) {
6239               if (SvUTF8(sv1)) {
6240                    svrecode = newSVpvn(pv2, cur2);
6241                    sv_recode_to_utf8(svrecode, PL_encoding);
6242                    pv2 = SvPV_const(svrecode, cur2);
6243               }
6244               else {
6245                    svrecode = newSVpvn(pv1, cur1);
6246                    sv_recode_to_utf8(svrecode, PL_encoding);
6247                    pv1 = SvPV_const(svrecode, cur1);
6248               }
6249               /* Now both are in UTF-8. */
6250               if (cur1 != cur2) {
6251                    SvREFCNT_dec(svrecode);
6252                    return FALSE;
6253               }
6254          }
6255          else {
6256               bool is_utf8 = TRUE;
6257
6258               if (SvUTF8(sv1)) {
6259                    /* sv1 is the UTF-8 one,
6260                     * if is equal it must be downgrade-able */
6261                    char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6262                                                      &cur1, &is_utf8);
6263                    if (pv != pv1)
6264                         pv1 = tpv = pv;
6265               }
6266               else {
6267                    /* sv2 is the UTF-8 one,
6268                     * if is equal it must be downgrade-able */
6269                    char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6270                                                       &cur2, &is_utf8);
6271                    if (pv != pv2)
6272                         pv2 = tpv = pv;
6273               }
6274               if (is_utf8) {
6275                    /* Downgrade not possible - cannot be eq */
6276                    assert (tpv == 0);
6277                    return FALSE;
6278               }
6279          }
6280     }
6281
6282     if (cur1 == cur2)
6283         eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6284
6285     if (svrecode)
6286          SvREFCNT_dec(svrecode);
6287
6288     if (tpv)
6289         Safefree(tpv);
6290
6291     return eq;
6292 }
6293
6294 /*
6295 =for apidoc sv_cmp
6296
6297 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
6298 string in C<sv1> is less than, equal to, or greater than the string in
6299 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6300 coerce its args to strings if necessary.  See also C<sv_cmp_locale>.
6301
6302 =cut
6303 */
6304
6305 I32
6306 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6307 {
6308     STRLEN cur1, cur2;
6309     const char *pv1, *pv2;
6310     char *tpv = Nullch;
6311     I32  cmp;
6312     SV *svrecode = Nullsv;
6313
6314     if (!sv1) {
6315         pv1 = "";
6316         cur1 = 0;
6317     }
6318     else
6319         pv1 = SvPV_const(sv1, cur1);
6320
6321     if (!sv2) {
6322         pv2 = "";
6323         cur2 = 0;
6324     }
6325     else
6326         pv2 = SvPV_const(sv2, cur2);
6327
6328     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6329         /* Differing utf8ness.
6330          * Do not UTF8size the comparands as a side-effect. */
6331         if (SvUTF8(sv1)) {
6332             if (PL_encoding) {
6333                  svrecode = newSVpvn(pv2, cur2);
6334                  sv_recode_to_utf8(svrecode, PL_encoding);
6335                  pv2 = SvPV_const(svrecode, cur2);
6336             }
6337             else {
6338                  pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6339             }
6340         }
6341         else {
6342             if (PL_encoding) {
6343                  svrecode = newSVpvn(pv1, cur1);
6344                  sv_recode_to_utf8(svrecode, PL_encoding);
6345                  pv1 = SvPV_const(svrecode, cur1);
6346             }
6347             else {
6348                  pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6349             }
6350         }
6351     }
6352
6353     if (!cur1) {
6354         cmp = cur2 ? -1 : 0;
6355     } else if (!cur2) {
6356         cmp = 1;
6357     } else {
6358         const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6359
6360         if (retval) {
6361             cmp = retval < 0 ? -1 : 1;
6362         } else if (cur1 == cur2) {
6363             cmp = 0;
6364         } else {
6365             cmp = cur1 < cur2 ? -1 : 1;
6366         }
6367     }
6368
6369     if (svrecode)
6370          SvREFCNT_dec(svrecode);
6371
6372     if (tpv)
6373         Safefree(tpv);
6374
6375     return cmp;
6376 }
6377
6378 /*
6379 =for apidoc sv_cmp_locale
6380
6381 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6382 'use bytes' aware, handles get magic, and will coerce its args to strings
6383 if necessary.  See also C<sv_cmp_locale>.  See also C<sv_cmp>.
6384
6385 =cut
6386 */
6387
6388 I32
6389 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6390 {
6391 #ifdef USE_LOCALE_COLLATE
6392
6393     char *pv1, *pv2;
6394     STRLEN len1, len2;
6395     I32 retval;
6396
6397     if (PL_collation_standard)
6398         goto raw_compare;
6399
6400     len1 = 0;
6401     pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6402     len2 = 0;
6403     pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6404
6405     if (!pv1 || !len1) {
6406         if (pv2 && len2)
6407             return -1;
6408         else
6409             goto raw_compare;
6410     }
6411     else {
6412         if (!pv2 || !len2)
6413             return 1;
6414     }
6415
6416     retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6417
6418     if (retval)
6419         return retval < 0 ? -1 : 1;
6420
6421     /*
6422      * When the result of collation is equality, that doesn't mean
6423      * that there are no differences -- some locales exclude some
6424      * characters from consideration.  So to avoid false equalities,
6425      * we use the raw string as a tiebreaker.
6426      */
6427
6428   raw_compare:
6429     /* FALL THROUGH */
6430
6431 #endif /* USE_LOCALE_COLLATE */
6432
6433     return sv_cmp(sv1, sv2);
6434 }
6435
6436
6437 #ifdef USE_LOCALE_COLLATE
6438
6439 /*
6440 =for apidoc sv_collxfrm
6441
6442 Add Collate Transform magic to an SV if it doesn't already have it.
6443
6444 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6445 scalar data of the variable, but transformed to such a format that a normal
6446 memory comparison can be used to compare the data according to the locale
6447 settings.
6448
6449 =cut
6450 */
6451
6452 char *
6453 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6454 {
6455     MAGIC *mg;
6456
6457     mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6458     if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6459         const char *s;
6460         char *xf;
6461         STRLEN len, xlen;
6462
6463         if (mg)
6464             Safefree(mg->mg_ptr);
6465         s = SvPV_const(sv, len);
6466         if ((xf = mem_collxfrm(s, len, &xlen))) {
6467             if (SvREADONLY(sv)) {
6468                 SAVEFREEPV(xf);
6469                 *nxp = xlen;
6470                 return xf + sizeof(PL_collation_ix);
6471             }
6472             if (! mg) {
6473                 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6474                 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6475                 assert(mg);
6476             }
6477             mg->mg_ptr = xf;
6478             mg->mg_len = xlen;
6479         }
6480         else {
6481             if (mg) {
6482                 mg->mg_ptr = NULL;
6483                 mg->mg_len = -1;
6484             }
6485         }
6486     }
6487     if (mg && mg->mg_ptr) {
6488         *nxp = mg->mg_len;
6489         return mg->mg_ptr + sizeof(PL_collation_ix);
6490     }
6491     else {
6492         *nxp = 0;
6493         return NULL;
6494     }
6495 }
6496
6497 #endif /* USE_LOCALE_COLLATE */
6498
6499 /*
6500 =for apidoc sv_gets
6501
6502 Get a line from the filehandle and store it into the SV, optionally
6503 appending to the currently-stored string.
6504
6505 =cut
6506 */
6507
6508 char *
6509 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6510 {
6511     const char *rsptr;
6512     STRLEN rslen;
6513     register STDCHAR rslast;
6514     register STDCHAR *bp;
6515     register I32 cnt;
6516     I32 i = 0;
6517     I32 rspara = 0;
6518     I32 recsize;
6519
6520     if (SvTHINKFIRST(sv))
6521         sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6522     /* XXX. If you make this PVIV, then copy on write can copy scalars read
6523        from <>.
6524        However, perlbench says it's slower, because the existing swipe code
6525        is faster than copy on write.
6526        Swings and roundabouts.  */
6527     SvUPGRADE(sv, SVt_PV);
6528
6529     SvSCREAM_off(sv);
6530
6531     if (append) {
6532         if (PerlIO_isutf8(fp)) {
6533             if (!SvUTF8(sv)) {
6534                 sv_utf8_upgrade_nomg(sv);
6535                 sv_pos_u2b(sv,&append,0);
6536             }
6537         } else if (SvUTF8(sv)) {
6538             SV * const tsv = NEWSV(0,0);
6539             sv_gets(tsv, fp, 0);
6540             sv_utf8_upgrade_nomg(tsv);
6541             SvCUR_set(sv,append);
6542             sv_catsv(sv,tsv);
6543             sv_free(tsv);
6544             goto return_string_or_null;
6545         }
6546     }
6547
6548     SvPOK_only(sv);
6549     if (PerlIO_isutf8(fp))
6550         SvUTF8_on(sv);
6551
6552     if (IN_PERL_COMPILETIME) {
6553         /* we always read code in line mode */
6554         rsptr = "\n";
6555         rslen = 1;
6556     }
6557     else if (RsSNARF(PL_rs)) {
6558         /* If it is a regular disk file use size from stat() as estimate
6559            of amount we are going to read - may result in malloc-ing
6560            more memory than we realy need if layers bellow reduce
6561            size we read (e.g. CRLF or a gzip layer)
6562          */
6563         Stat_t st;
6564         if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode))  {
6565             const Off_t offset = PerlIO_tell(fp);
6566             if (offset != (Off_t) -1 && st.st_size + append > offset) {
6567                 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6568             }
6569         }
6570         rsptr = NULL;
6571         rslen = 0;
6572     }
6573     else if (RsRECORD(PL_rs)) {
6574       I32 bytesread;
6575       char *buffer;
6576
6577       /* Grab the size of the record we're getting */
6578       recsize = SvIV(SvRV(PL_rs));
6579       buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6580       /* Go yank in */
6581 #ifdef VMS
6582       /* VMS wants read instead of fread, because fread doesn't respect */
6583       /* RMS record boundaries. This is not necessarily a good thing to be */
6584       /* doing, but we've got no other real choice - except avoid stdio
6585          as implementation - perhaps write a :vms layer ?
6586        */
6587       bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6588 #else
6589       bytesread = PerlIO_read(fp, buffer, recsize);
6590 #endif
6591       if (bytesread < 0)
6592           bytesread = 0;
6593       SvCUR_set(sv, bytesread += append);
6594       buffer[bytesread] = '\0';
6595       goto return_string_or_null;
6596     }
6597     else if (RsPARA(PL_rs)) {
6598         rsptr = "\n\n";
6599         rslen = 2;
6600         rspara = 1;
6601     }
6602     else {
6603         /* Get $/ i.e. PL_rs into same encoding as stream wants */
6604         if (PerlIO_isutf8(fp)) {
6605             rsptr = SvPVutf8(PL_rs, rslen);
6606         }
6607         else {
6608             if (SvUTF8(PL_rs)) {
6609                 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6610                     Perl_croak(aTHX_ "Wide character in $/");
6611                 }
6612             }
6613             rsptr = SvPV_const(PL_rs, rslen);
6614         }
6615     }
6616
6617     rslast = rslen ? rsptr[rslen - 1] : '\0';
6618
6619     if (rspara) {               /* have to do this both before and after */
6620         do {                    /* to make sure file boundaries work right */
6621             if (PerlIO_eof(fp))
6622                 return 0;
6623             i = PerlIO_getc(fp);
6624             if (i != '\n') {
6625                 if (i == -1)
6626                     return 0;
6627                 PerlIO_ungetc(fp,i);
6628                 break;
6629             }
6630         } while (i != EOF);
6631     }
6632
6633     /* See if we know enough about I/O mechanism to cheat it ! */
6634
6635     /* This used to be #ifdef test - it is made run-time test for ease
6636        of abstracting out stdio interface. One call should be cheap
6637        enough here - and may even be a macro allowing compile
6638        time optimization.
6639      */
6640
6641     if (PerlIO_fast_gets(fp)) {
6642
6643     /*
6644      * We're going to steal some values from the stdio struct
6645      * and put EVERYTHING in the innermost loop into registers.
6646      */
6647     register STDCHAR *ptr;
6648     STRLEN bpx;
6649     I32 shortbuffered;
6650
6651 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6652     /* An ungetc()d char is handled separately from the regular
6653      * buffer, so we getc() it back out and stuff it in the buffer.
6654      */
6655     i = PerlIO_getc(fp);
6656     if (i == EOF) return 0;
6657     *(--((*fp)->_ptr)) = (unsigned char) i;
6658     (*fp)->_cnt++;
6659 #endif
6660
6661     /* Here is some breathtakingly efficient cheating */
6662
6663     cnt = PerlIO_get_cnt(fp);                   /* get count into register */
6664     /* make sure we have the room */
6665     if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6666         /* Not room for all of it
6667            if we are looking for a separator and room for some
6668          */
6669         if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6670             /* just process what we have room for */
6671             shortbuffered = cnt - SvLEN(sv) + append + 1;
6672             cnt -= shortbuffered;
6673         }
6674         else {
6675             shortbuffered = 0;
6676             /* remember that cnt can be negative */
6677             SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6678         }
6679     }
6680     else
6681         shortbuffered = 0;
6682     bp = (STDCHAR*)SvPVX_const(sv) + append;  /* move these two too to registers */
6683     ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6684     DEBUG_P(PerlIO_printf(Perl_debug_log,
6685         "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6686     DEBUG_P(PerlIO_printf(Perl_debug_log,
6687         "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6688                PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6689                PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6690     for (;;) {
6691       screamer:
6692         if (cnt > 0) {
6693             if (rslen) {
6694                 while (cnt > 0) {                    /* this     |  eat */
6695                     cnt--;
6696                     if ((*bp++ = *ptr++) == rslast)  /* really   |  dust */
6697                         goto thats_all_folks;        /* screams  |  sed :-) */
6698                 }
6699             }
6700             else {
6701                 Copy(ptr, bp, cnt, char);            /* this     |  eat */
6702                 bp += cnt;                           /* screams  |  dust */
6703                 ptr += cnt;                          /* louder   |  sed :-) */
6704                 cnt = 0;
6705             }
6706         }
6707
6708         if (shortbuffered) {            /* oh well, must extend */
6709             cnt = shortbuffered;
6710             shortbuffered = 0;
6711             bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6712             SvCUR_set(sv, bpx);
6713             SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6714             bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6715             continue;
6716         }
6717
6718         DEBUG_P(PerlIO_printf(Perl_debug_log,
6719                               "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6720                               PTR2UV(ptr),(long)cnt));
6721         PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6722 #if 0
6723         DEBUG_P(PerlIO_printf(Perl_debug_log,
6724             "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6725             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6726             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6727 #endif
6728         /* This used to call 'filbuf' in stdio form, but as that behaves like
6729            getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6730            another abstraction.  */
6731         i   = PerlIO_getc(fp);          /* get more characters */
6732 #if 0
6733         DEBUG_P(PerlIO_printf(Perl_debug_log,
6734             "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6735             PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6736             PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6737 #endif
6738         cnt = PerlIO_get_cnt(fp);
6739         ptr = (STDCHAR*)PerlIO_get_ptr(fp);     /* reregisterize cnt and ptr */
6740         DEBUG_P(PerlIO_printf(Perl_debug_log,
6741             "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6742
6743         if (i == EOF)                   /* all done for ever? */
6744             goto thats_really_all_folks;
6745
6746         bpx = bp - (STDCHAR*)SvPVX_const(sv);   /* box up before relocation */
6747         SvCUR_set(sv, bpx);
6748         SvGROW(sv, bpx + cnt + 2);
6749         bp = (STDCHAR*)SvPVX_const(sv) + bpx;   /* unbox after relocation */
6750
6751         *bp++ = (STDCHAR)i;             /* store character from PerlIO_getc */
6752
6753         if (rslen && (STDCHAR)i == rslast)  /* all done for now? */
6754             goto thats_all_folks;
6755     }
6756
6757 thats_all_folks:
6758     if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6759           memNE((char*)bp - rslen, rsptr, rslen))
6760         goto screamer;                          /* go back to the fray */
6761 thats_really_all_folks:
6762     if (shortbuffered)
6763         cnt += shortbuffered;
6764         DEBUG_P(PerlIO_printf(Perl_debug_log,
6765             "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6766     PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt);  /* put these back or we're in trouble */
6767     DEBUG_P(PerlIO_printf(Perl_debug_log,
6768         "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6769         PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6770         PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6771     *bp = '\0';
6772     SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv));      /* set length */
6773     DEBUG_P(PerlIO_printf(Perl_debug_log,
6774         "Screamer: done, len=%ld, string=|%.*s|\n",
6775         (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6776     }
6777    else
6778     {
6779        /*The big, slow, and stupid way. */
6780 #ifdef USE_HEAP_INSTEAD_OF_STACK        /* Even slower way. */
6781         STDCHAR *buf = 0;
6782         New(0, buf, 8192, STDCHAR);
6783         assert(buf);
6784 #else
6785         STDCHAR buf[8192];
6786 #endif
6787
6788 screamer2:
6789         if (rslen) {
6790             const register STDCHAR *bpe = buf + sizeof(buf);
6791             bp = buf;
6792             while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6793                 ; /* keep reading */
6794             cnt = bp - buf;
6795         }
6796         else {
6797             cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6798             /* Accomodate broken VAXC compiler, which applies U8 cast to
6799              * both args of ?: operator, causing EOF to change into 255
6800              */
6801             if (cnt > 0)
6802                  i = (U8)buf[cnt - 1];
6803             else
6804                  i = EOF;
6805         }
6806
6807         if (cnt < 0)
6808             cnt = 0;  /* we do need to re-set the sv even when cnt <= 0 */
6809         if (append)
6810              sv_catpvn(sv, (char *) buf, cnt);
6811         else
6812              sv_setpvn(sv, (char *) buf, cnt);
6813
6814         if (i != EOF &&                 /* joy */
6815             (!rslen ||
6816              SvCUR(sv) < rslen ||
6817              memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6818         {
6819             append = -1;
6820             /*
6821              * If we're reading from a TTY and we get a short read,
6822              * indicating that the user hit his EOF character, we need
6823              * to notice it now, because if we try to read from the TTY
6824              * again, the EOF condition will disappear.
6825              *
6826              * The comparison of cnt to sizeof(buf) is an optimization
6827              * that prevents unnecessary calls to feof().
6828              *
6829              * - jik 9/25/96
6830              */
6831             if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6832                 goto screamer2;
6833         }
6834
6835 #ifdef USE_HEAP_INSTEAD_OF_STACK
6836         Safefree(buf);
6837 #endif
6838     }
6839
6840     if (rspara) {               /* have to do this both before and after */
6841         while (i != EOF) {      /* to make sure file boundaries work right */
6842             i = PerlIO_getc(fp);
6843             if (i != '\n') {
6844                 PerlIO_ungetc(fp,i);
6845                 break;
6846             }
6847         }
6848     }
6849
6850 return_string_or_null:
6851     return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6852 }
6853
6854 /*
6855 =for apidoc sv_inc
6856
6857 Auto-increment of the value in the SV, doing string to numeric conversion
6858 if necessary. Handles 'get' magic.
6859
6860 =cut
6861 */
6862
6863 void
6864 Perl_sv_inc(pTHX_ register SV *sv)
6865 {
6866     register char *d;
6867     int flags;
6868
6869     if (!sv)
6870         return;
6871     if (SvGMAGICAL(sv))
6872         mg_get(sv);
6873     if (SvTHINKFIRST(sv)) {
6874         if (SvIsCOW(sv))
6875             sv_force_normal_flags(sv, 0);
6876         if (SvREADONLY(sv)) {
6877             if (IN_PERL_RUNTIME)
6878                 Perl_croak(aTHX_ PL_no_modify);
6879         }
6880         if (SvROK(sv)) {
6881             IV i;
6882             if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6883                 return;
6884             i = PTR2IV(SvRV(sv));
6885             sv_unref(sv);
6886             sv_setiv(sv, i);
6887         }
6888     }
6889     flags = SvFLAGS(sv);
6890     if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6891         /* It's (privately or publicly) a float, but not tested as an
6892            integer, so test it to see. */
6893         (void) SvIV(sv);
6894         flags = SvFLAGS(sv);
6895     }
6896     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6897         /* It's publicly an integer, or privately an integer-not-float */
6898 #ifdef PERL_PRESERVE_IVUV
6899       oops_its_int:
6900 #endif
6901         if (SvIsUV(sv)) {
6902             if (SvUVX(sv) == UV_MAX)
6903                 sv_setnv(sv, UV_MAX_P1);
6904             else
6905                 (void)SvIOK_only_UV(sv);
6906                 SvUV_set(sv, SvUVX(sv) + 1);
6907         } else {
6908             if (SvIVX(sv) == IV_MAX)
6909                 sv_setuv(sv, (UV)IV_MAX + 1);
6910             else {
6911                 (void)SvIOK_only(sv);
6912                 SvIV_set(sv, SvIVX(sv) + 1);
6913             }
6914         }
6915         return;
6916     }
6917     if (flags & SVp_NOK) {
6918         (void)SvNOK_only(sv);
6919         SvNV_set(sv, SvNVX(sv) + 1.0);
6920         return;
6921     }
6922
6923     if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6924         if ((flags & SVTYPEMASK) < SVt_PVIV)
6925             sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6926         (void)SvIOK_only(sv);
6927         SvIV_set(sv, 1);
6928         return;
6929     }
6930     d = SvPVX(sv);
6931     while (isALPHA(*d)) d++;
6932     while (isDIGIT(*d)) d++;
6933     if (*d) {
6934 #ifdef PERL_PRESERVE_IVUV
6935         /* Got to punt this as an integer if needs be, but we don't issue
6936            warnings. Probably ought to make the sv_iv_please() that does
6937            the conversion if possible, and silently.  */
6938         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6939         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6940             /* Need to try really hard to see if it's an integer.
6941                9.22337203685478e+18 is an integer.
6942                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6943                so $a="9.22337203685478e+18"; $a+0; $a++
6944                needs to be the same as $a="9.22337203685478e+18"; $a++
6945                or we go insane. */
6946
6947             (void) sv_2iv(sv);
6948             if (SvIOK(sv))
6949                 goto oops_its_int;
6950
6951             /* sv_2iv *should* have made this an NV */
6952             if (flags & SVp_NOK) {
6953                 (void)SvNOK_only(sv);
6954                 SvNV_set(sv, SvNVX(sv) + 1.0);
6955                 return;
6956             }
6957             /* I don't think we can get here. Maybe I should assert this
6958                And if we do get here I suspect that sv_setnv will croak. NWC
6959                Fall through. */
6960 #if defined(USE_LONG_DOUBLE)
6961             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",
6962                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6963 #else
6964             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6965                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6966 #endif
6967         }
6968 #endif /* PERL_PRESERVE_IVUV */
6969         sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6970         return;
6971     }
6972     d--;
6973     while (d >= SvPVX_const(sv)) {
6974         if (isDIGIT(*d)) {
6975             if (++*d <= '9')
6976                 return;
6977             *(d--) = '0';
6978         }
6979         else {
6980 #ifdef EBCDIC
6981             /* MKS: The original code here died if letters weren't consecutive.
6982              * at least it didn't have to worry about non-C locales.  The
6983              * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6984              * arranged in order (although not consecutively) and that only
6985              * [A-Za-z] are accepted by isALPHA in the C locale.
6986              */
6987             if (*d != 'z' && *d != 'Z') {
6988                 do { ++*d; } while (!isALPHA(*d));
6989                 return;
6990             }
6991             *(d--) -= 'z' - 'a';
6992 #else
6993             ++*d;
6994             if (isALPHA(*d))
6995                 return;
6996             *(d--) -= 'z' - 'a' + 1;
6997 #endif
6998         }
6999     }
7000     /* oh,oh, the number grew */
7001     SvGROW(sv, SvCUR(sv) + 2);
7002     SvCUR_set(sv, SvCUR(sv) + 1);
7003     for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7004         *d = d[-1];
7005     if (isDIGIT(d[1]))
7006         *d = '1';
7007     else
7008         *d = d[1];
7009 }
7010
7011 /*
7012 =for apidoc sv_dec
7013
7014 Auto-decrement of the value in the SV, doing string to numeric conversion
7015 if necessary. Handles 'get' magic.
7016
7017 =cut
7018 */
7019
7020 void
7021 Perl_sv_dec(pTHX_ register SV *sv)
7022 {
7023     int flags;
7024
7025     if (!sv)
7026         return;
7027     if (SvGMAGICAL(sv))
7028         mg_get(sv);
7029     if (SvTHINKFIRST(sv)) {
7030         if (SvIsCOW(sv))
7031             sv_force_normal_flags(sv, 0);
7032         if (SvREADONLY(sv)) {
7033             if (IN_PERL_RUNTIME)
7034                 Perl_croak(aTHX_ PL_no_modify);
7035         }
7036         if (SvROK(sv)) {
7037             IV i;
7038             if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7039                 return;
7040             i = PTR2IV(SvRV(sv));
7041             sv_unref(sv);
7042             sv_setiv(sv, i);
7043         }
7044     }
7045     /* Unlike sv_inc we don't have to worry about string-never-numbers
7046        and keeping them magic. But we mustn't warn on punting */
7047     flags = SvFLAGS(sv);
7048     if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7049         /* It's publicly an integer, or privately an integer-not-float */
7050 #ifdef PERL_PRESERVE_IVUV
7051       oops_its_int:
7052 #endif
7053         if (SvIsUV(sv)) {
7054             if (SvUVX(sv) == 0) {
7055                 (void)SvIOK_only(sv);
7056                 SvIV_set(sv, -1);
7057             }
7058             else {
7059                 (void)SvIOK_only_UV(sv);
7060                 SvUV_set(sv, SvUVX(sv) + 1);
7061             }
7062         } else {
7063             if (SvIVX(sv) == IV_MIN)
7064                 sv_setnv(sv, (NV)IV_MIN - 1.0);
7065             else {
7066                 (void)SvIOK_only(sv);
7067                 SvIV_set(sv, SvIVX(sv) - 1);
7068             }
7069         }
7070         return;
7071     }
7072     if (flags & SVp_NOK) {
7073         SvNV_set(sv, SvNVX(sv) - 1.0);
7074         (void)SvNOK_only(sv);
7075         return;
7076     }
7077     if (!(flags & SVp_POK)) {
7078         if ((flags & SVTYPEMASK) < SVt_PVNV)
7079             sv_upgrade(sv, SVt_NV);
7080         SvNV_set(sv, 1.0);
7081         (void)SvNOK_only(sv);
7082         return;
7083     }
7084 #ifdef PERL_PRESERVE_IVUV
7085     {
7086         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7087         if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7088             /* Need to try really hard to see if it's an integer.
7089                9.22337203685478e+18 is an integer.
7090                but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7091                so $a="9.22337203685478e+18"; $a+0; $a--
7092                needs to be the same as $a="9.22337203685478e+18"; $a--
7093                or we go insane. */
7094
7095             (void) sv_2iv(sv);
7096             if (SvIOK(sv))
7097                 goto oops_its_int;
7098
7099             /* sv_2iv *should* have made this an NV */
7100             if (flags & SVp_NOK) {
7101                 (void)SvNOK_only(sv);
7102                 SvNV_set(sv, SvNVX(sv) - 1.0);
7103                 return;
7104             }
7105             /* I don't think we can get here. Maybe I should assert this
7106                And if we do get here I suspect that sv_setnv will croak. NWC
7107                Fall through. */
7108 #if defined(USE_LONG_DOUBLE)
7109             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",
7110                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7111 #else
7112             DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7113                                   SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7114 #endif
7115         }
7116     }
7117 #endif /* PERL_PRESERVE_IVUV */
7118     sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0);   /* punt */
7119 }
7120
7121 /*
7122 =for apidoc sv_mortalcopy
7123
7124 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7125 The new SV is marked as mortal. It will be destroyed "soon", either by an
7126 explicit call to FREETMPS, or by an implicit call at places such as
7127 statement boundaries.  See also C<sv_newmortal> and C<sv_2mortal>.
7128
7129 =cut
7130 */
7131
7132 /* Make a string that will exist for the duration of the expression
7133  * evaluation.  Actually, it may have to last longer than that, but
7134  * hopefully we won't free it until it has been assigned to a
7135  * permanent location. */
7136
7137 SV *
7138 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7139 {
7140     register SV *sv;
7141
7142     new_SV(sv);
7143     sv_setsv(sv,oldstr);
7144     EXTEND_MORTAL(1);
7145     PL_tmps_stack[++PL_tmps_ix] = sv;
7146     SvTEMP_on(sv);
7147     return sv;
7148 }
7149
7150 /*
7151 =for apidoc sv_newmortal
7152
7153 Creates a new null SV which is mortal.  The reference count of the SV is
7154 set to 1. It will be destroyed "soon", either by an explicit call to
7155 FREETMPS, or by an implicit call at places such as statement boundaries.
7156 See also C<sv_mortalcopy> and C<sv_2mortal>.
7157
7158 =cut
7159 */
7160
7161 SV *
7162 Perl_sv_newmortal(pTHX)
7163 {
7164     register SV *sv;
7165
7166     new_SV(sv);
7167     SvFLAGS(sv) = SVs_TEMP;
7168     EXTEND_MORTAL(1);
7169     PL_tmps_stack[++PL_tmps_ix] = sv;
7170     return sv;
7171 }
7172
7173 /*
7174 =for apidoc sv_2mortal
7175
7176 Marks an existing SV as mortal.  The SV will be destroyed "soon", either
7177 by an explicit call to FREETMPS, or by an implicit call at places such as
7178 statement boundaries.  SvTEMP() is turned on which means that the SV's
7179 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7180 and C<sv_mortalcopy>.
7181
7182 =cut
7183 */
7184
7185 SV *
7186 Perl_sv_2mortal(pTHX_ register SV *sv)
7187 {
7188     dVAR;
7189     if (!sv)
7190         return sv;
7191     if (SvREADONLY(sv) && SvIMMORTAL(sv))
7192         return sv;
7193     EXTEND_MORTAL(1);
7194     PL_tmps_stack[++PL_tmps_ix] = sv;
7195     SvTEMP_on(sv);
7196     return sv;
7197 }
7198
7199 /*
7200 =for apidoc newSVpv
7201
7202 Creates a new SV and copies a string into it.  The reference count for the
7203 SV is set to 1.  If C<len> is zero, Perl will compute the length using
7204 strlen().  For efficiency, consider using C<newSVpvn> instead.
7205
7206 =cut
7207 */
7208
7209 SV *
7210 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7211 {
7212     register SV *sv;
7213
7214     new_SV(sv);
7215     sv_setpvn(sv,s,len ? len : strlen(s));
7216     return sv;
7217 }
7218
7219 /*
7220 =for apidoc newSVpvn
7221
7222 Creates a new SV and copies a string into it.  The reference count for the
7223 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
7224 string.  You are responsible for ensuring that the source string is at least
7225 C<len> bytes long.  If the C<s> argument is NULL the new SV will be undefined.
7226
7227 =cut
7228 */
7229
7230 SV *
7231 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7232 {
7233     register SV *sv;
7234
7235     new_SV(sv);
7236     sv_setpvn(sv,s,len);
7237     return sv;
7238 }
7239
7240
7241 /*
7242 =for apidoc newSVhek
7243
7244 Creates a new SV from the hash key structure.  It will generate scalars that
7245 point to the shared string table where possible. Returns a new (undefined)
7246 SV if the hek is NULL.
7247
7248 =cut
7249 */
7250
7251 SV *
7252 Perl_newSVhek(pTHX_ const HEK *hek)
7253 {
7254     if (!hek) {
7255         SV *sv;
7256
7257         new_SV(sv);
7258         return sv;
7259     }
7260
7261     if (HEK_LEN(hek) == HEf_SVKEY) {
7262         return newSVsv(*(SV**)HEK_KEY(hek));
7263     } else {
7264         const int flags = HEK_FLAGS(hek);
7265         if (flags & HVhek_WASUTF8) {
7266             /* Trouble :-)
7267                Andreas would like keys he put in as utf8 to come back as utf8
7268             */
7269             STRLEN utf8_len = HEK_LEN(hek);
7270             U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7271             SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7272
7273             SvUTF8_on (sv);
7274             Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7275             return sv;
7276         } else if (flags & HVhek_REHASH) {
7277             /* We don't have a pointer to the hv, so we have to replicate the
7278                flag into every HEK. This hv is using custom a hasing
7279                algorithm. Hence we can't return a shared string scalar, as
7280                that would contain the (wrong) hash value, and might get passed
7281                into an hv routine with a regular hash  */
7282
7283             SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7284             if (HEK_UTF8(hek))
7285                 SvUTF8_on (sv);
7286             return sv;
7287         }
7288         /* This will be overwhelminly the most common case.  */
7289         return newSVpvn_share(HEK_KEY(hek),
7290                               (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7291                               HEK_HASH(hek));
7292     }
7293 }
7294
7295 /*
7296 =for apidoc newSVpvn_share
7297
7298 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7299 table. If the string does not already exist in the table, it is created
7300 first.  Turns on READONLY and FAKE.  The string's hash is stored in the UV
7301 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7302 otherwise the hash is computed.  The idea here is that as the string table
7303 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7304 hash lookup will avoid string compare.
7305
7306 =cut
7307 */
7308
7309 SV *
7310 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7311 {
7312     register SV *sv;
7313     bool is_utf8 = FALSE;
7314     if (len < 0) {
7315         STRLEN tmplen = -len;
7316         is_utf8 = TRUE;
7317         /* See the note in hv.c:hv_fetch() --jhi */
7318         src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7319         len = tmplen;
7320     }
7321     if (!hash)
7322         PERL_HASH(hash, src, len);
7323     new_SV(sv);
7324     sv_upgrade(sv, SVt_PV);
7325     SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7326     SvCUR_set(sv, len);
7327     SvLEN_set(sv, 0);
7328     SvREADONLY_on(sv);
7329     SvFAKE_on(sv);
7330     SvPOK_on(sv);
7331     if (is_utf8)
7332         SvUTF8_on(sv);
7333     return sv;
7334 }
7335
7336
7337 #if defined(PERL_IMPLICIT_CONTEXT)
7338
7339 /* pTHX_ magic can't cope with varargs, so this is a no-context
7340  * version of the main function, (which may itself be aliased to us).
7341  * Don't access this version directly.
7342  */
7343
7344 SV *
7345 Perl_newSVpvf_nocontext(const char* pat, ...)
7346 {
7347     dTHX;
7348     register SV *sv;
7349     va_list args;
7350     va_start(args, pat);
7351     sv = vnewSVpvf(pat, &args);
7352     va_end(args);
7353     return sv;
7354 }
7355 #endif
7356
7357 /*
7358 =for apidoc newSVpvf
7359
7360 Creates a new SV and initializes it with the string formatted like
7361 C<sprintf>.
7362
7363 =cut
7364 */
7365
7366 SV *
7367 Perl_newSVpvf(pTHX_ const char* pat, ...)
7368 {
7369     register SV *sv;
7370     va_list args;
7371     va_start(args, pat);
7372     sv = vnewSVpvf(pat, &args);
7373     va_end(args);
7374     return sv;
7375 }
7376
7377 /* backend for newSVpvf() and newSVpvf_nocontext() */
7378
7379 SV *
7380 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7381 {
7382     register SV *sv;
7383     new_SV(sv);
7384     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7385     return sv;
7386 }
7387
7388 /*
7389 =for apidoc newSVnv
7390
7391 Creates a new SV and copies a floating point value into it.
7392 The reference count for the SV is set to 1.
7393
7394 =cut
7395 */
7396
7397 SV *
7398 Perl_newSVnv(pTHX_ NV n)
7399 {
7400     register SV *sv;
7401
7402     new_SV(sv);
7403     sv_setnv(sv,n);
7404     return sv;
7405 }
7406
7407 /*
7408 =for apidoc newSViv
7409
7410 Creates a new SV and copies an integer into it.  The reference count for the
7411 SV is set to 1.
7412
7413 =cut
7414 */
7415
7416 SV *
7417 Perl_newSViv(pTHX_ IV i)
7418 {
7419     register SV *sv;
7420
7421     new_SV(sv);
7422     sv_setiv(sv,i);
7423     return sv;
7424 }
7425
7426 /*
7427 =for apidoc newSVuv
7428
7429 Creates a new SV and copies an unsigned integer into it.
7430 The reference count for the SV is set to 1.
7431
7432 =cut
7433 */
7434
7435 SV *
7436 Perl_newSVuv(pTHX_ UV u)
7437 {
7438     register SV *sv;
7439
7440     new_SV(sv);
7441     sv_setuv(sv,u);
7442     return sv;
7443 }
7444
7445 /*
7446 =for apidoc newRV_noinc
7447
7448 Creates an RV wrapper for an SV.  The reference count for the original
7449 SV is B<not> incremented.
7450
7451 =cut
7452 */
7453
7454 SV *
7455 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7456 {
7457     register SV *sv;
7458
7459     new_SV(sv);
7460     sv_upgrade(sv, SVt_RV);
7461     SvTEMP_off(tmpRef);
7462     SvRV_set(sv, tmpRef);
7463     SvROK_on(sv);
7464     return sv;
7465 }
7466
7467 /* newRV_inc is the official function name to use now.
7468  * newRV_inc is in fact #defined to newRV in sv.h
7469  */
7470
7471 SV *
7472 Perl_newRV(pTHX_ SV *tmpRef)
7473 {
7474     return newRV_noinc(SvREFCNT_inc(tmpRef));
7475 }
7476
7477 /*
7478 =for apidoc newSVsv
7479
7480 Creates a new SV which is an exact duplicate of the original SV.
7481 (Uses C<sv_setsv>).
7482
7483 =cut
7484 */
7485
7486 SV *
7487 Perl_newSVsv(pTHX_ register SV *old)
7488 {
7489     register SV *sv;
7490
7491     if (!old)
7492         return Nullsv;
7493     if (SvTYPE(old) == SVTYPEMASK) {
7494         if (ckWARN_d(WARN_INTERNAL))
7495             Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7496         return Nullsv;
7497     }
7498     new_SV(sv);
7499     /* SV_GMAGIC is the default for sv_setv()
7500        SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7501        with SvTEMP_off and SvTEMP_on round a call to sv_setsv.  */
7502     sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7503     return sv;
7504 }
7505
7506 /*
7507 =for apidoc sv_reset
7508
7509 Underlying implementation for the C<reset> Perl function.
7510 Note that the perl-level function is vaguely deprecated.
7511
7512 =cut
7513 */
7514
7515 void
7516 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7517 {
7518     dVAR;
7519     char todo[PERL_UCHAR_MAX+1];
7520
7521     if (!stash)
7522         return;
7523
7524     if (!*s) {          /* reset ?? searches */
7525         MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7526         if (mg) {
7527             PMOP *pm = (PMOP *) mg->mg_obj;
7528             while (pm) {
7529                 pm->op_pmdynflags &= ~PMdf_USED;
7530                 pm = pm->op_pmnext;
7531             }
7532         }
7533         return;
7534     }
7535
7536     /* reset variables */
7537
7538     if (!HvARRAY(stash))
7539         return;
7540
7541     Zero(todo, 256, char);
7542     while (*s) {
7543         I32 max;
7544         I32 i = (unsigned char)*s;
7545         if (s[1] == '-') {
7546             s += 2;
7547         }
7548         max = (unsigned char)*s++;
7549         for ( ; i <= max; i++) {
7550             todo[i] = 1;
7551         }
7552         for (i = 0; i <= (I32) HvMAX(stash); i++) {
7553             HE *entry;
7554             for (entry = HvARRAY(stash)[i];
7555                  entry;
7556                  entry = HeNEXT(entry))
7557             {
7558                 register GV *gv;
7559                 register SV *sv;
7560
7561                 if (!todo[(U8)*HeKEY(entry)])
7562                     continue;
7563                 gv = (GV*)HeVAL(entry);
7564                 sv = GvSV(gv);
7565                 if (SvTHINKFIRST(sv)) {
7566                     if (!SvREADONLY(sv) && SvROK(sv))
7567                         sv_unref(sv);
7568                     continue;
7569                 }
7570                 SvOK_off(sv);
7571                 if (SvTYPE(sv) >= SVt_PV) {
7572                     SvCUR_set(sv, 0);
7573                     if (SvPVX_const(sv) != Nullch)
7574                         *SvPVX(sv) = '\0';
7575                     SvTAINT(sv);
7576                 }
7577                 if (GvAV(gv)) {
7578                     av_clear(GvAV(gv));
7579                 }
7580                 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7581                     hv_clear(GvHV(gv));
7582 #ifndef PERL_MICRO
7583 #ifdef USE_ENVIRON_ARRAY
7584                     if (gv == PL_envgv
7585 #  ifdef USE_ITHREADS
7586                         && PL_curinterp == aTHX
7587 #  endif
7588                     )
7589                     {
7590                         environ[0] = Nullch;
7591                     }
7592 #endif
7593 #endif /* !PERL_MICRO */
7594                 }
7595             }
7596         }
7597     }
7598 }
7599
7600 /*
7601 =for apidoc sv_2io
7602
7603 Using various gambits, try to get an IO from an SV: the IO slot if its a
7604 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7605 named after the PV if we're a string.
7606
7607 =cut
7608 */
7609
7610 IO*
7611 Perl_sv_2io(pTHX_ SV *sv)
7612 {
7613     IO* io;
7614     GV* gv;
7615
7616     switch (SvTYPE(sv)) {
7617     case SVt_PVIO:
7618         io = (IO*)sv;
7619         break;
7620     case SVt_PVGV:
7621         gv = (GV*)sv;
7622         io = GvIO(gv);
7623         if (!io)
7624             Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7625         break;
7626     default:
7627         if (!SvOK(sv))
7628             Perl_croak(aTHX_ PL_no_usym, "filehandle");
7629         if (SvROK(sv))
7630             return sv_2io(SvRV(sv));
7631         gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7632         if (gv)
7633             io = GvIO(gv);
7634         else
7635             io = 0;
7636         if (!io)
7637             Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7638         break;
7639     }
7640     return io;
7641 }
7642
7643 /*
7644 =for apidoc sv_2cv
7645
7646 Using various gambits, try to get a CV from an SV; in addition, try if
7647 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7648
7649 =cut
7650 */
7651
7652 CV *
7653 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7654 {
7655     dVAR;
7656     GV *gv = Nullgv;
7657     CV *cv = Nullcv;
7658
7659     if (!sv)
7660         return *gvp = Nullgv, Nullcv;
7661     switch (SvTYPE(sv)) {
7662     case SVt_PVCV:
7663         *st = CvSTASH(sv);
7664         *gvp = Nullgv;
7665         return (CV*)sv;
7666     case SVt_PVHV:
7667     case SVt_PVAV:
7668         *gvp = Nullgv;
7669         return Nullcv;
7670     case SVt_PVGV:
7671         gv = (GV*)sv;
7672         *gvp = gv;
7673         *st = GvESTASH(gv);
7674         goto fix_gv;
7675
7676     default:
7677         if (SvGMAGICAL(sv))
7678             mg_get(sv);
7679         if (SvROK(sv)) {
7680             SV **sp = &sv;              /* Used in tryAMAGICunDEREF macro. */
7681             tryAMAGICunDEREF(to_cv);
7682
7683             sv = SvRV(sv);
7684             if (SvTYPE(sv) == SVt_PVCV) {
7685                 cv = (CV*)sv;
7686                 *gvp = Nullgv;
7687                 *st = CvSTASH(cv);
7688                 return cv;
7689             }
7690             else if(isGV(sv))
7691                 gv = (GV*)sv;
7692             else
7693                 Perl_croak(aTHX_ "Not a subroutine reference");
7694         }
7695         else if (isGV(sv))
7696             gv = (GV*)sv;
7697         else
7698             gv = gv_fetchsv(sv, lref, SVt_PVCV);
7699         *gvp = gv;
7700         if (!gv)
7701             return Nullcv;
7702         *st = GvESTASH(gv);
7703     fix_gv:
7704         if (lref && !GvCVu(gv)) {
7705             SV *tmpsv;
7706             ENTER;
7707             tmpsv = NEWSV(704,0);
7708             gv_efullname3(tmpsv, gv, Nullch);
7709             /* XXX this is probably not what they think they're getting.
7710              * It has the same effect as "sub name;", i.e. just a forward
7711              * declaration! */
7712             newSUB(start_subparse(FALSE, 0),
7713                    newSVOP(OP_CONST, 0, tmpsv),
7714                    Nullop,
7715                    Nullop);
7716             LEAVE;
7717             if (!GvCVu(gv))
7718                 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7719                            sv);
7720         }
7721         return GvCVu(gv);
7722     }
7723 }
7724
7725 /*
7726 =for apidoc sv_true
7727
7728 Returns true if the SV has a true value by Perl's rules.
7729 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7730 instead use an in-line version.
7731
7732 =cut
7733 */
7734
7735 I32
7736 Perl_sv_true(pTHX_ register SV *sv)
7737 {
7738     if (!sv)
7739         return 0;
7740     if (SvPOK(sv)) {
7741         const register XPV* tXpv;
7742         if ((tXpv = (XPV*)SvANY(sv)) &&
7743                 (tXpv->xpv_cur > 1 ||
7744                 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7745             return 1;
7746         else
7747             return 0;
7748     }
7749     else {
7750         if (SvIOK(sv))
7751             return SvIVX(sv) != 0;
7752         else {
7753             if (SvNOK(sv))
7754                 return SvNVX(sv) != 0.0;
7755             else
7756                 return sv_2bool(sv);
7757         }
7758     }
7759 }
7760
7761 /*
7762 =for apidoc sv_iv
7763
7764 A private implementation of the C<SvIVx> macro for compilers which can't
7765 cope with complex macro expressions. Always use the macro instead.
7766
7767 =cut
7768 */
7769
7770 IV
7771 Perl_sv_iv(pTHX_ register SV *sv)
7772 {
7773     if (SvIOK(sv)) {
7774         if (SvIsUV(sv))
7775             return (IV)SvUVX(sv);
7776         return SvIVX(sv);
7777     }
7778     return sv_2iv(sv);
7779 }
7780
7781 /*
7782 =for apidoc sv_uv
7783
7784 A private implementation of the C<SvUVx> macro for compilers which can't
7785 cope with complex macro expressions. Always use the macro instead.
7786
7787 =cut
7788 */
7789
7790 UV
7791 Perl_sv_uv(pTHX_ register SV *sv)
7792 {
7793     if (SvIOK(sv)) {
7794         if (SvIsUV(sv))
7795             return SvUVX(sv);
7796         return (UV)SvIVX(sv);
7797     }
7798     return sv_2uv(sv);
7799 }
7800
7801 /*
7802 =for apidoc sv_nv
7803
7804 A private implementation of the C<SvNVx> macro for compilers which can't
7805 cope with complex macro expressions. Always use the macro instead.
7806
7807 =cut
7808 */
7809
7810 NV
7811 Perl_sv_nv(pTHX_ register SV *sv)
7812 {
7813     if (SvNOK(sv))
7814         return SvNVX(sv);
7815     return sv_2nv(sv);
7816 }
7817
7818 /* sv_pv() is now a macro using SvPV_nolen();
7819  * this function provided for binary compatibility only
7820  */
7821
7822 char *
7823 Perl_sv_pv(pTHX_ SV *sv)
7824 {
7825     if (SvPOK(sv))
7826         return SvPVX(sv);
7827
7828     return sv_2pv(sv, 0);
7829 }
7830
7831 /*
7832 =for apidoc sv_pv
7833
7834 Use the C<SvPV_nolen> macro instead
7835
7836 =for apidoc sv_pvn
7837
7838 A private implementation of the C<SvPV> macro for compilers which can't
7839 cope with complex macro expressions. Always use the macro instead.
7840
7841 =cut
7842 */
7843
7844 char *
7845 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7846 {
7847     if (SvPOK(sv)) {
7848         *lp = SvCUR(sv);
7849         return SvPVX(sv);
7850     }
7851     return sv_2pv(sv, lp);
7852 }
7853
7854
7855 char *
7856 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7857 {
7858     if (SvPOK(sv)) {
7859         *lp = SvCUR(sv);
7860         return SvPVX(sv);
7861     }
7862     return sv_2pv_flags(sv, lp, 0);
7863 }
7864
7865 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
7866  * this function provided for binary compatibility only
7867  */
7868
7869 char *
7870 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
7871 {
7872     return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
7873 }
7874
7875 /*
7876 =for apidoc sv_pvn_force
7877
7878 Get a sensible string out of the SV somehow.
7879 A private implementation of the C<SvPV_force> macro for compilers which
7880 can't cope with complex macro expressions. Always use the macro instead.
7881
7882 =for apidoc sv_pvn_force_flags
7883
7884 Get a sensible string out of the SV somehow.
7885 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7886 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7887 implemented in terms of this function.
7888 You normally want to use the various wrapper macros instead: see
7889 C<SvPV_force> and C<SvPV_force_nomg>
7890
7891 =cut
7892 */
7893
7894 char *
7895 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7896 {
7897
7898     if (SvTHINKFIRST(sv) && !SvROK(sv))
7899         sv_force_normal_flags(sv, 0);
7900
7901     if (SvPOK(sv)) {
7902         if (lp)
7903             *lp = SvCUR(sv);
7904     }
7905     else {
7906         char *s;
7907         STRLEN len;
7908
7909         if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7910             if (PL_op)
7911                 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7912                            sv_reftype(sv,0), OP_NAME(PL_op));
7913             else
7914                 Perl_croak(aTHX_ "Can't coerce readonly %s to string",
7915                            sv_reftype(sv,0));
7916         }
7917         if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
7918             Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7919                 OP_NAME(PL_op));
7920         }
7921         else
7922             s = sv_2pv_flags(sv, &len, flags);
7923         if (lp)
7924             *lp = len;
7925
7926         if (s != SvPVX_const(sv)) {     /* Almost, but not quite, sv_setpvn() */
7927             if (SvROK(sv))
7928                 sv_unref(sv);
7929             SvUPGRADE(sv, SVt_PV);              /* Never FALSE */
7930             SvGROW(sv, len + 1);
7931             Move(s,SvPVX_const(sv),len,char);
7932             SvCUR_set(sv, len);
7933             *SvEND(sv) = '\0';
7934         }
7935         if (!SvPOK(sv)) {
7936             SvPOK_on(sv);               /* validate pointer */
7937             SvTAINT(sv);
7938             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7939                                   PTR2UV(sv),SvPVX_const(sv)));
7940         }
7941     }
7942     return SvPVX_mutable(sv);
7943 }
7944
7945 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
7946  * this function provided for binary compatibility only
7947  */
7948
7949 char *
7950 Perl_sv_pvbyte(pTHX_ SV *sv)
7951 {
7952     sv_utf8_downgrade(sv,0);
7953     return sv_pv(sv);
7954 }
7955
7956 /*
7957 =for apidoc sv_pvbyte
7958
7959 Use C<SvPVbyte_nolen> instead.
7960
7961 =for apidoc sv_pvbyten
7962
7963 A private implementation of the C<SvPVbyte> macro for compilers
7964 which can't cope with complex macro expressions. Always use the macro
7965 instead.
7966
7967 =cut
7968 */
7969
7970 char *
7971 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7972 {
7973     sv_utf8_downgrade(sv,0);
7974     return sv_pvn(sv,lp);
7975 }
7976
7977 /*
7978 =for apidoc sv_pvbyten_force
7979
7980 A private implementation of the C<SvPVbytex_force> macro for compilers
7981 which can't cope with complex macro expressions. Always use the macro
7982 instead.
7983
7984 =cut
7985 */
7986
7987 char *
7988 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7989 {
7990     sv_pvn_force(sv,lp);
7991     sv_utf8_downgrade(sv,0);
7992     *lp = SvCUR(sv);
7993     return SvPVX(sv);
7994 }
7995
7996 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
7997  * this function provided for binary compatibility only
7998  */
7999
8000 char *
8001 Perl_sv_pvutf8(pTHX_ SV *sv)
8002 {
8003     sv_utf8_upgrade(sv);
8004     return sv_pv(sv);
8005 }
8006
8007 /*
8008 =for apidoc sv_pvutf8
8009
8010 Use the C<SvPVutf8_nolen> macro instead
8011
8012 =for apidoc sv_pvutf8n
8013
8014 A private implementation of the C<SvPVutf8> macro for compilers
8015 which can't cope with complex macro expressions. Always use the macro
8016 instead.
8017
8018 =cut
8019 */
8020
8021 char *
8022 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8023 {
8024     sv_utf8_upgrade(sv);
8025     return sv_pvn(sv,lp);
8026 }
8027
8028 /*
8029 =for apidoc sv_pvutf8n_force
8030
8031 A private implementation of the C<SvPVutf8_force> macro for compilers
8032 which can't cope with complex macro expressions. Always use the macro
8033 instead.
8034
8035 =cut
8036 */
8037
8038 char *
8039 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8040 {
8041     sv_pvn_force(sv,lp);
8042     sv_utf8_upgrade(sv);
8043     *lp = SvCUR(sv);
8044     return SvPVX(sv);
8045 }
8046
8047 /*
8048 =for apidoc sv_reftype
8049
8050 Returns a string describing what the SV is a reference to.
8051
8052 =cut
8053 */
8054
8055 char *
8056 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8057 {
8058     /* The fact that I don't need to downcast to char * everywhere, only in ?:
8059        inside return suggests a const propagation bug in g++.  */
8060     if (ob && SvOBJECT(sv)) {
8061         char * const name = HvNAME_get(SvSTASH(sv));
8062         return name ? name : (char *) "__ANON__";
8063     }
8064     else {
8065         switch (SvTYPE(sv)) {
8066         case SVt_NULL:
8067         case SVt_IV:
8068         case SVt_NV:
8069         case SVt_RV:
8070         case SVt_PV:
8071         case SVt_PVIV:
8072         case SVt_PVNV:
8073         case SVt_PVMG:
8074         case SVt_PVBM:
8075                                 if (SvVOK(sv))
8076                                     return "VSTRING";
8077                                 if (SvROK(sv))
8078                                     return "REF";
8079                                 else
8080                                     return "SCALAR";
8081
8082         case SVt_PVLV:          return (char *)  (SvROK(sv) ? "REF"
8083                                 /* tied lvalues should appear to be
8084                                  * scalars for backwards compatitbility */
8085                                 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8086                                     ? "SCALAR" : "LVALUE");
8087         case SVt_PVAV:          return "ARRAY";
8088         case SVt_PVHV:          return "HASH";
8089         case SVt_PVCV:          return "CODE";
8090         case SVt_PVGV:          return "GLOB";
8091         case SVt_PVFM:          return "FORMAT";
8092         case SVt_PVIO:          return "IO";
8093         default:                return "UNKNOWN";
8094         }
8095     }
8096 }
8097
8098 /*
8099 =for apidoc sv_isobject
8100
8101 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8102 object.  If the SV is not an RV, or if the object is not blessed, then this
8103 will return false.
8104
8105 =cut
8106 */
8107
8108 int
8109 Perl_sv_isobject(pTHX_ SV *sv)
8110 {
8111     if (!sv)
8112         return 0;
8113     if (SvGMAGICAL(sv))
8114         mg_get(sv);
8115     if (!SvROK(sv))
8116         return 0;
8117     sv = (SV*)SvRV(sv);
8118     if (!SvOBJECT(sv))
8119         return 0;
8120     return 1;
8121 }
8122
8123 /*
8124 =for apidoc sv_isa
8125
8126 Returns a boolean indicating whether the SV is blessed into the specified
8127 class.  This does not check for subtypes; use C<sv_derived_from> to verify
8128 an inheritance relationship.
8129
8130 =cut
8131 */
8132
8133 int
8134 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8135 {
8136     const char *hvname;
8137     if (!sv)
8138         return 0;
8139     if (SvGMAGICAL(sv))
8140         mg_get(sv);
8141     if (!SvROK(sv))
8142         return 0;
8143     sv = (SV*)SvRV(sv);
8144     if (!SvOBJECT(sv))
8145         return 0;
8146     hvname = HvNAME_get(SvSTASH(sv));
8147     if (!hvname)
8148         return 0;
8149
8150     return strEQ(hvname, name);
8151 }
8152
8153 /*
8154 =for apidoc newSVrv
8155
8156 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
8157 it will be upgraded to one.  If C<classname> is non-null then the new SV will
8158 be blessed in the specified package.  The new SV is returned and its
8159 reference count is 1.
8160
8161 =cut
8162 */
8163
8164 SV*
8165 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8166 {
8167     SV *sv;
8168
8169     new_SV(sv);
8170
8171     SV_CHECK_THINKFIRST_COW_DROP(rv);
8172     SvAMAGIC_off(rv);
8173
8174     if (SvTYPE(rv) >= SVt_PVMG) {
8175         const U32 refcnt = SvREFCNT(rv);
8176         SvREFCNT(rv) = 0;
8177         sv_clear(rv);
8178         SvFLAGS(rv) = 0;
8179         SvREFCNT(rv) = refcnt;
8180     }
8181
8182     if (SvTYPE(rv) < SVt_RV)
8183         sv_upgrade(rv, SVt_RV);
8184     else if (SvTYPE(rv) > SVt_RV) {
8185         SvPV_free(rv);
8186         SvCUR_set(rv, 0);
8187         SvLEN_set(rv, 0);
8188     }
8189
8190     SvOK_off(rv);
8191     SvRV_set(rv, sv);
8192     SvROK_on(rv);
8193
8194     if (classname) {
8195         HV* const stash = gv_stashpv(classname, TRUE);
8196         (void)sv_bless(rv, stash);
8197     }
8198     return sv;
8199 }
8200
8201 /*
8202 =for apidoc sv_setref_pv
8203
8204 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
8205 argument will be upgraded to an RV.  That RV will be modified to point to
8206 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8207 into the SV.  The C<classname> argument indicates the package for the
8208 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
8209 will have a reference count of 1, and the RV will be returned.
8210
8211 Do not use with other Perl types such as HV, AV, SV, CV, because those
8212 objects will become corrupted by the pointer copy process.
8213
8214 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8215
8216 =cut
8217 */
8218
8219 SV*
8220 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8221 {
8222     if (!pv) {
8223         sv_setsv(rv, &PL_sv_undef);
8224         SvSETMAGIC(rv);
8225     }
8226     else
8227         sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8228     return rv;
8229 }
8230
8231 /*
8232 =for apidoc sv_setref_iv
8233
8234 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
8235 argument will be upgraded to an RV.  That RV will be modified to point to
8236 the new SV.  The C<classname> argument indicates the package for the
8237 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
8238 will have a reference count of 1, and the RV will be returned.
8239
8240 =cut
8241 */
8242
8243 SV*
8244 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8245 {
8246     sv_setiv(newSVrv(rv,classname), iv);
8247     return rv;
8248 }
8249
8250 /*
8251 =for apidoc sv_setref_uv
8252
8253 Copies an unsigned integer into a new SV, optionally blessing the SV.  The C<rv>
8254 argument will be upgraded to an RV.  That RV will be modified to point to
8255 the new SV.  The C<classname> argument indicates the package for the
8256 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
8257 will have a reference count of 1, and the RV will be returned.
8258
8259 =cut
8260 */
8261
8262 SV*
8263 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8264 {
8265     sv_setuv(newSVrv(rv,classname), uv);
8266     return rv;
8267 }
8268
8269 /*
8270 =for apidoc sv_setref_nv
8271
8272 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
8273 argument will be upgraded to an RV.  That RV will be modified to point to
8274 the new SV.  The C<classname> argument indicates the package for the
8275 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
8276 will have a reference count of 1, and the RV will be returned.
8277
8278 =cut
8279 */
8280
8281 SV*
8282 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8283 {
8284     sv_setnv(newSVrv(rv,classname), nv);
8285     return rv;
8286 }
8287
8288 /*
8289 =for apidoc sv_setref_pvn
8290
8291 Copies a string into a new SV, optionally blessing the SV.  The length of the
8292 string must be specified with C<n>.  The C<rv> argument will be upgraded to
8293 an RV.  That RV will be modified to point to the new SV.  The C<classname>
8294 argument indicates the package for the blessing.  Set C<classname> to
8295 C<Nullch> to avoid the blessing.  The new SV will have a reference count
8296 of 1, and the RV will be returned.
8297
8298 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8299
8300 =cut
8301 */
8302
8303 SV*
8304 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8305 {
8306     sv_setpvn(newSVrv(rv,classname), pv, n);
8307     return rv;
8308 }
8309
8310 /*
8311 =for apidoc sv_bless
8312
8313 Blesses an SV into a specified package.  The SV must be an RV.  The package
8314 must be designated by its stash (see C<gv_stashpv()>).  The reference count
8315 of the SV is unaffected.
8316
8317 =cut
8318 */
8319
8320 SV*
8321 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8322 {
8323     SV *tmpRef;
8324     if (!SvROK(sv))
8325         Perl_croak(aTHX_ "Can't bless non-reference value");
8326     tmpRef = SvRV(sv);
8327     if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8328         if (SvREADONLY(tmpRef))
8329             Perl_croak(aTHX_ PL_no_modify);
8330         if (SvOBJECT(tmpRef)) {
8331             if (SvTYPE(tmpRef) != SVt_PVIO)
8332                 --PL_sv_objcount;
8333             SvREFCNT_dec(SvSTASH(tmpRef));
8334         }
8335     }
8336     SvOBJECT_on(tmpRef);
8337     if (SvTYPE(tmpRef) != SVt_PVIO)
8338         ++PL_sv_objcount;
8339     SvUPGRADE(tmpRef, SVt_PVMG);
8340     SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8341
8342     if (Gv_AMG(stash))
8343         SvAMAGIC_on(sv);
8344     else
8345         SvAMAGIC_off(sv);
8346
8347     if(SvSMAGICAL(tmpRef))
8348         if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8349             mg_set(tmpRef);
8350
8351
8352
8353     return sv;
8354 }
8355
8356 /* Downgrades a PVGV to a PVMG.
8357  */
8358
8359 STATIC void
8360 S_sv_unglob(pTHX_ SV *sv)
8361 {
8362     void *xpvmg;
8363
8364     assert(SvTYPE(sv) == SVt_PVGV);
8365     SvFAKE_off(sv);
8366     if (GvGP(sv))
8367         gp_free((GV*)sv);
8368     if (GvSTASH(sv)) {
8369         sv_del_backref((SV*)GvSTASH(sv), sv);
8370         GvSTASH(sv) = Nullhv;
8371     }
8372     sv_unmagic(sv, PERL_MAGIC_glob);
8373     Safefree(GvNAME(sv));
8374     GvMULTI_off(sv);
8375
8376     /* need to keep SvANY(sv) in the right arena */
8377     xpvmg = new_XPVMG();
8378     StructCopy(SvANY(sv), xpvmg, XPVMG);
8379     del_XPVGV(SvANY(sv));
8380     SvANY(sv) = xpvmg;
8381
8382     SvFLAGS(sv) &= ~SVTYPEMASK;
8383     SvFLAGS(sv) |= SVt_PVMG;
8384 }
8385
8386 /*
8387 =for apidoc sv_unref_flags
8388
8389 Unsets the RV status of the SV, and decrements the reference count of
8390 whatever was being referenced by the RV.  This can almost be thought of
8391 as a reversal of C<newSVrv>.  The C<cflags> argument can contain
8392 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8393 (otherwise the decrementing is conditional on the reference count being
8394 different from one or the reference being a readonly SV).
8395 See C<SvROK_off>.
8396
8397 =cut
8398 */
8399
8400 void
8401 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8402 {
8403     SV* target = SvRV(ref);
8404
8405     if (SvWEAKREF(ref)) {
8406         sv_del_backref(target, ref);
8407         SvWEAKREF_off(ref);
8408         SvRV_set(ref, NULL);
8409         return;
8410     }
8411     SvRV_set(ref, NULL);
8412     SvROK_off(ref);
8413     /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8414        assigned to as BEGIN {$a = \"Foo"} will fail.  */
8415     if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8416         SvREFCNT_dec(target);
8417     else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8418         sv_2mortal(target);     /* Schedule for freeing later */
8419 }
8420
8421 /*
8422 =for apidoc sv_unref
8423
8424 Unsets the RV status of the SV, and decrements the reference count of
8425 whatever was being referenced by the RV.  This can almost be thought of
8426 as a reversal of C<newSVrv>.  This is C<sv_unref_flags> with the C<flag>
8427 being zero.  See C<SvROK_off>.
8428
8429 =cut
8430 */
8431
8432 void
8433 Perl_sv_unref(pTHX_ SV *sv)
8434 {
8435     sv_unref_flags(sv, 0);
8436 }
8437
8438 /*
8439 =for apidoc sv_taint
8440
8441 Taint an SV. Use C<SvTAINTED_on> instead.
8442 =cut
8443 */
8444
8445 void
8446 Perl_sv_taint(pTHX_ SV *sv)
8447 {
8448     sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8449 }
8450
8451 /*
8452 =for apidoc sv_untaint
8453
8454 Untaint an SV. Use C<SvTAINTED_off> instead.
8455 =cut
8456 */
8457
8458 void
8459 Perl_sv_untaint(pTHX_ SV *sv)
8460 {
8461     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8462         MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8463         if (mg)
8464             mg->mg_len &= ~1;
8465     }
8466 }
8467
8468 /*
8469 =for apidoc sv_tainted
8470
8471 Test an SV for taintedness. Use C<SvTAINTED> instead.
8472 =cut
8473 */
8474
8475 bool
8476 Perl_sv_tainted(pTHX_ SV *sv)
8477 {
8478     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8479         MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8480         if (mg && (mg->mg_len & 1) )
8481             return TRUE;
8482     }
8483     return FALSE;
8484 }
8485
8486 /*
8487 =for apidoc sv_setpviv
8488
8489 Copies an integer into the given SV, also updating its string value.
8490 Does not handle 'set' magic.  See C<sv_setpviv_mg>.
8491
8492 =cut
8493 */
8494
8495 void
8496 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8497 {
8498     char buf[TYPE_CHARS(UV)];
8499     char *ebuf;
8500     char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8501
8502     sv_setpvn(sv, ptr, ebuf - ptr);
8503 }
8504
8505 /*
8506 =for apidoc sv_setpviv_mg
8507
8508 Like C<sv_setpviv>, but also handles 'set' magic.
8509
8510 =cut
8511 */
8512
8513 void
8514 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8515 {
8516     char buf[TYPE_CHARS(UV)];
8517     char *ebuf;
8518     char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8519
8520     sv_setpvn(sv, ptr, ebuf - ptr);
8521     SvSETMAGIC(sv);
8522 }
8523
8524 #if defined(PERL_IMPLICIT_CONTEXT)
8525
8526 /* pTHX_ magic can't cope with varargs, so this is a no-context
8527  * version of the main function, (which may itself be aliased to us).
8528  * Don't access this version directly.
8529  */
8530
8531 void
8532 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8533 {
8534     dTHX;
8535     va_list args;
8536     va_start(args, pat);
8537     sv_vsetpvf(sv, pat, &args);
8538     va_end(args);
8539 }
8540
8541 /* pTHX_ magic can't cope with varargs, so this is a no-context
8542  * version of the main function, (which may itself be aliased to us).
8543  * Don't access this version directly.
8544  */
8545
8546 void
8547 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8548 {
8549     dTHX;
8550     va_list args;
8551     va_start(args, pat);
8552     sv_vsetpvf_mg(sv, pat, &args);
8553     va_end(args);
8554 }
8555 #endif
8556
8557 /*
8558 =for apidoc sv_setpvf
8559
8560 Works like C<sv_catpvf> but copies the text into the SV instead of
8561 appending it.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
8562
8563 =cut
8564 */
8565
8566 void
8567 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8568 {
8569     va_list args;
8570     va_start(args, pat);
8571     sv_vsetpvf(sv, pat, &args);
8572     va_end(args);
8573 }
8574
8575 /*
8576 =for apidoc sv_vsetpvf
8577
8578 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8579 appending it.  Does not handle 'set' magic.  See C<sv_vsetpvf_mg>.
8580
8581 Usually used via its frontend C<sv_setpvf>.
8582
8583 =cut
8584 */
8585
8586 void
8587 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8588 {
8589     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8590 }
8591
8592 /*
8593 =for apidoc sv_setpvf_mg
8594
8595 Like C<sv_setpvf>, but also handles 'set' magic.
8596
8597 =cut
8598 */
8599
8600 void
8601 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8602 {
8603     va_list args;
8604     va_start(args, pat);
8605     sv_vsetpvf_mg(sv, pat, &args);
8606     va_end(args);
8607 }
8608
8609 /*
8610 =for apidoc sv_vsetpvf_mg
8611
8612 Like C<sv_vsetpvf>, but also handles 'set' magic.
8613
8614 Usually used via its frontend C<sv_setpvf_mg>.
8615
8616 =cut
8617 */
8618
8619 void
8620 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8621 {
8622     sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8623     SvSETMAGIC(sv);
8624 }
8625
8626 #if defined(PERL_IMPLICIT_CONTEXT)
8627
8628 /* pTHX_ magic can't cope with varargs, so this is a no-context
8629  * version of the main function, (which may itself be aliased to us).
8630  * Don't access this version directly.
8631  */
8632
8633 void
8634 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8635 {
8636     dTHX;
8637     va_list args;
8638     va_start(args, pat);
8639     sv_vcatpvf(sv, pat, &args);
8640     va_end(args);
8641 }
8642
8643 /* pTHX_ magic can't cope with varargs, so this is a no-context
8644  * version of the main function, (which may itself be aliased to us).
8645  * Don't access this version directly.
8646  */
8647
8648 void
8649 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8650 {
8651     dTHX;
8652     va_list args;
8653     va_start(args, pat);
8654     sv_vcatpvf_mg(sv, pat, &args);
8655     va_end(args);
8656 }
8657 #endif
8658
8659 /*
8660 =for apidoc sv_catpvf
8661
8662 Processes its arguments like C<sprintf> and appends the formatted
8663 output to an SV.  If the appended data contains "wide" characters
8664 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8665 and characters >255 formatted with %c), the original SV might get
8666 upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.  See
8667 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8668 valid UTF-8; if the original SV was bytes, the pattern should be too.
8669
8670 =cut */
8671
8672 void
8673 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8674 {
8675     va_list args;
8676     va_start(args, pat);
8677     sv_vcatpvf(sv, pat, &args);
8678     va_end(args);
8679 }
8680
8681 /*
8682 =for apidoc sv_vcatpvf
8683
8684 Processes its arguments like C<vsprintf> and appends the formatted output
8685 to an SV.  Does not handle 'set' magic.  See C<sv_vcatpvf_mg>.
8686
8687 Usually used via its frontend C<sv_catpvf>.
8688
8689 =cut
8690 */
8691
8692 void
8693 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8694 {
8695     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8696 }
8697
8698 /*
8699 =for apidoc sv_catpvf_mg
8700
8701 Like C<sv_catpvf>, but also handles 'set' magic.
8702
8703 =cut
8704 */
8705
8706 void
8707 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8708 {
8709     va_list args;
8710     va_start(args, pat);
8711     sv_vcatpvf_mg(sv, pat, &args);
8712     va_end(args);
8713 }
8714
8715 /*
8716 =for apidoc sv_vcatpvf_mg
8717
8718 Like C<sv_vcatpvf>, but also handles 'set' magic.
8719
8720 Usually used via its frontend C<sv_catpvf_mg>.
8721
8722 =cut
8723 */
8724
8725 void
8726 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8727 {
8728     sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8729     SvSETMAGIC(sv);
8730 }
8731
8732 /*
8733 =for apidoc sv_vsetpvfn
8734
8735 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8736 appending it.
8737
8738 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8739
8740 =cut
8741 */
8742
8743 void
8744 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8745 {
8746     sv_setpvn(sv, "", 0);
8747     sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8748 }
8749
8750 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8751
8752 STATIC I32
8753 S_expect_number(pTHX_ char** pattern)
8754 {
8755     I32 var = 0;
8756     switch (**pattern) {
8757     case '1': case '2': case '3':
8758     case '4': case '5': case '6':
8759     case '7': case '8': case '9':
8760         while (isDIGIT(**pattern))
8761             var = var * 10 + (*(*pattern)++ - '0');
8762     }
8763     return var;
8764 }
8765 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8766
8767 static char *
8768 F0convert(NV nv, char *endbuf, STRLEN *len)
8769 {
8770     const int neg = nv < 0;
8771     UV uv;
8772
8773     if (neg)
8774         nv = -nv;
8775     if (nv < UV_MAX) {
8776         char *p = endbuf;
8777         nv += 0.5;
8778         uv = (UV)nv;
8779         if (uv & 1 && uv == nv)
8780             uv--;                       /* Round to even */
8781         do {
8782             const unsigned dig = uv % 10;
8783             *--p = '0' + dig;
8784         } while (uv /= 10);
8785         if (neg)
8786             *--p = '-';
8787         *len = endbuf - p;
8788         return p;
8789     }
8790     return Nullch;
8791 }
8792
8793
8794 /*
8795 =for apidoc sv_vcatpvfn
8796
8797 Processes its arguments like C<vsprintf> and appends the formatted output
8798 to an SV.  Uses an array of SVs if the C style variable argument list is
8799 missing (NULL).  When running with taint checks enabled, indicates via
8800 C<maybe_tainted> if results are untrustworthy (often due to the use of
8801 locales).
8802
8803 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8804
8805 =cut
8806 */
8807
8808 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8809
8810 void
8811 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8812 {
8813     char *p;
8814     char *q;
8815     const char *patend;
8816     STRLEN origlen;
8817     I32 svix = 0;
8818     static const char nullstr[] = "(null)";
8819     SV *argsv = Nullsv;
8820     bool has_utf8 = DO_UTF8(sv);    /* has the result utf8? */
8821     const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8822     SV *nsv = Nullsv;
8823     /* Times 4: a decimal digit takes more than 3 binary digits.
8824      * NV_DIG: mantissa takes than many decimal digits.
8825      * Plus 32: Playing safe. */
8826     char ebuf[IV_DIG * 4 + NV_DIG + 32];
8827     /* large enough for "%#.#f" --chip */
8828     /* what about long double NVs? --jhi */
8829
8830     PERL_UNUSED_ARG(maybe_tainted);
8831
8832     /* no matter what, this is a string now */
8833     (void)SvPV_force(sv, origlen);
8834
8835     /* special-case "", "%s", and "%-p" (SVf) */
8836     if (patlen == 0)
8837         return;
8838     if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8839             if (args) {
8840                 const char * const s = va_arg(*args, char*);
8841                 sv_catpv(sv, s ? s : nullstr);
8842             }
8843             else if (svix < svmax) {
8844                 sv_catsv(sv, *svargs);
8845                 if (DO_UTF8(*svargs))
8846                     SvUTF8_on(sv);
8847             }
8848             return;
8849     }
8850     if (patlen == 3 && pat[0] == '%' &&
8851         pat[1] == '-' && pat[2] == 'p') {
8852             if (args) {
8853                 argsv = va_arg(*args, SV*);
8854                 sv_catsv(sv, argsv);
8855                 if (DO_UTF8(argsv))
8856                     SvUTF8_on(sv);
8857                 return;
8858             }
8859     }
8860
8861 #ifndef USE_LONG_DOUBLE
8862     /* special-case "%.<number>[gf]" */
8863     if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8864          && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8865         unsigned digits = 0;
8866         const char *pp;
8867
8868         pp = pat + 2;
8869         while (*pp >= '0' && *pp <= '9')
8870             digits = 10 * digits + (*pp++ - '0');
8871         if (pp - pat == (int)patlen - 1) {
8872             NV nv;
8873
8874             if (svix < svmax)
8875                 nv = SvNV(*svargs);
8876             else
8877                 return;
8878             if (*pp == 'g') {
8879                 /* Add check for digits != 0 because it seems that some
8880                    gconverts are buggy in this case, and we don't yet have
8881                    a Configure test for this.  */
8882                 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8883                      /* 0, point, slack */
8884                     Gconvert(nv, (int)digits, 0, ebuf);
8885                     sv_catpv(sv, ebuf);
8886                     if (*ebuf)  /* May return an empty string for digits==0 */
8887                         return;
8888                 }
8889             } else if (!digits) {
8890                 STRLEN l;
8891
8892                 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8893                     sv_catpvn(sv, p, l);
8894                     return;
8895                 }
8896             }
8897         }
8898     }
8899 #endif /* !USE_LONG_DOUBLE */
8900
8901     if (!args && svix < svmax && DO_UTF8(*svargs))
8902         has_utf8 = TRUE;
8903
8904     patend = (char*)pat + patlen;
8905     for (p = (char*)pat; p < patend; p = q) {
8906         bool alt = FALSE;
8907         bool left = FALSE;
8908         bool vectorize = FALSE;
8909         bool vectorarg = FALSE;
8910         bool vec_utf8 = FALSE;
8911         char fill = ' ';
8912         char plus = 0;
8913         char intsize = 0;
8914         STRLEN width = 0;
8915         STRLEN zeros = 0;
8916         bool has_precis = FALSE;
8917         STRLEN precis = 0;
8918         I32 osvix = svix;
8919         bool is_utf8 = FALSE;  /* is this item utf8?   */
8920 #ifdef HAS_LDBL_SPRINTF_BUG
8921         /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8922            with sfio - Allen <allens@cpan.org> */
8923         bool fix_ldbl_sprintf_bug = FALSE;
8924 #endif
8925
8926         char esignbuf[4];
8927         U8 utf8buf[UTF8_MAXBYTES+1];
8928         STRLEN esignlen = 0;
8929
8930         const char *eptr = Nullch;
8931         STRLEN elen = 0;
8932         SV *vecsv = Nullsv;
8933         const U8 *vecstr = Null(U8*);
8934         STRLEN veclen = 0;
8935         char c = 0;
8936         int i;
8937         unsigned base = 0;
8938         IV iv = 0;
8939         UV uv = 0;
8940         /* we need a long double target in case HAS_LONG_DOUBLE but
8941            not USE_LONG_DOUBLE
8942         */
8943 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8944         long double nv;
8945 #else
8946         NV nv;
8947 #endif
8948         STRLEN have;
8949         STRLEN need;
8950         STRLEN gap;
8951         const char *dotstr = ".";
8952         STRLEN dotstrlen = 1;
8953         I32 efix = 0; /* explicit format parameter index */
8954         I32 ewix = 0; /* explicit width index */
8955         I32 epix = 0; /* explicit precision index */
8956         I32 evix = 0; /* explicit vector index */
8957         bool asterisk = FALSE;
8958
8959         /* echo everything up to the next format specification */
8960         for (q = p; q < patend && *q != '%'; ++q) ;
8961         if (q > p) {
8962             if (has_utf8 && !pat_utf8)
8963                 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8964             else
8965                 sv_catpvn(sv, p, q - p);
8966             p = q;
8967         }
8968         if (q++ >= patend)
8969             break;
8970
8971 /*
8972     We allow format specification elements in this order:
8973         \d+\$              explicit format parameter index
8974         [-+ 0#]+           flags
8975         v|\*(\d+\$)?v      vector with optional (optionally specified) arg
8976         0                  flag (as above): repeated to allow "v02"
8977         \d+|\*(\d+\$)?     width using optional (optionally specified) arg
8978         \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8979         [hlqLV]            size
8980     [%bcdefginopsux_DFOUX] format (mandatory)
8981 */
8982         if (EXPECT_NUMBER(q, width)) {
8983             if (*q == '$') {
8984                 ++q;
8985                 efix = width;
8986             } else {
8987                 goto gotwidth;
8988             }
8989         }
8990
8991         /* FLAGS */
8992
8993         while (*q) {
8994             switch (*q) {
8995             case ' ':
8996             case '+':
8997                 plus = *q++;
8998                 continue;
8999
9000             case '-':
9001                 left = TRUE;
9002                 q++;
9003                 continue;
9004
9005             case '0':
9006                 fill = *q++;
9007                 continue;
9008
9009             case '#':
9010                 alt = TRUE;
9011                 q++;
9012                 continue;
9013
9014             default:
9015                 break;
9016             }
9017             break;
9018         }
9019
9020       tryasterisk:
9021         if (*q == '*') {
9022             q++;
9023             if (EXPECT_NUMBER(q, ewix))
9024                 if (*q++ != '$')
9025                     goto unknown;
9026             asterisk = TRUE;
9027         }
9028         if (*q == 'v') {
9029             q++;
9030             if (vectorize)
9031                 goto unknown;
9032             if ((vectorarg = asterisk)) {
9033                 evix = ewix;
9034                 ewix = 0;
9035                 asterisk = FALSE;
9036             }
9037             vectorize = TRUE;
9038             goto tryasterisk;
9039         }
9040
9041         if (!asterisk)
9042             if( *q == '0' )
9043                 fill = *q++;
9044             EXPECT_NUMBER(q, width);
9045
9046         if (vectorize) {
9047             if (vectorarg) {
9048                 if (args)
9049                     vecsv = va_arg(*args, SV*);
9050                 else
9051                     vecsv = (evix ? evix <= svmax : svix < svmax) ?
9052                         svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9053                 dotstr = SvPV_const(vecsv, dotstrlen);
9054                 if (DO_UTF8(vecsv))
9055                     is_utf8 = TRUE;
9056             }
9057             if (args) {
9058                 vecsv = va_arg(*args, SV*);
9059                 vecstr = (U8*)SvPV_const(vecsv,veclen);
9060                 vec_utf8 = DO_UTF8(vecsv);
9061             }
9062             else if (efix ? efix <= svmax : svix < svmax) {
9063                 vecsv = svargs[efix ? efix-1 : svix++];
9064                 vecstr = (U8*)SvPV_const(vecsv,veclen);
9065                 vec_utf8 = DO_UTF8(vecsv);
9066                 /* if this is a version object, we need to return the
9067                  * stringified representation (which the SvPVX_const has
9068                  * already done for us), but not vectorize the args
9069                  */
9070                 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9071                 {
9072                         q++; /* skip past the rest of the %vd format */
9073                         eptr = (const char *) vecstr;
9074                         elen = strlen(eptr);
9075                         vectorize=FALSE;
9076                         goto string;
9077                 }
9078             }
9079             else {
9080                 vecstr = (U8*)"";
9081                 veclen = 0;
9082             }
9083         }
9084
9085         if (asterisk) {
9086             if (args)
9087                 i = va_arg(*args, int);
9088             else
9089                 i = (ewix ? ewix <= svmax : svix < svmax) ?
9090                     SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9091             left |= (i < 0);
9092             width = (i < 0) ? -i : i;
9093         }
9094       gotwidth:
9095
9096         /* PRECISION */
9097
9098         if (*q == '.') {
9099             q++;
9100             if (*q == '*') {
9101                 q++;
9102                 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9103                     goto unknown;
9104                 /* XXX: todo, support specified precision parameter */
9105                 if (epix)
9106                     goto unknown;
9107                 if (args)
9108                     i = va_arg(*args, int);
9109                 else
9110                     i = (ewix ? ewix <= svmax : svix < svmax)
9111                         ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9112                 precis = (i < 0) ? 0 : i;
9113             }
9114             else {
9115                 precis = 0;
9116                 while (isDIGIT(*q))
9117                     precis = precis * 10 + (*q++ - '0');
9118             }
9119             has_precis = TRUE;
9120         }
9121
9122         /* SIZE */
9123
9124         switch (*q) {
9125 #ifdef WIN32
9126         case 'I':                       /* Ix, I32x, and I64x */
9127 #  ifdef WIN64
9128             if (q[1] == '6' && q[2] == '4') {
9129                 q += 3;
9130                 intsize = 'q';
9131                 break;
9132             }
9133 #  endif
9134             if (q[1] == '3' && q[2] == '2') {
9135                 q += 3;
9136                 break;
9137             }
9138 #  ifdef WIN64
9139             intsize = 'q';
9140 #  endif
9141             q++;
9142             break;
9143 #endif
9144 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9145         case 'L':                       /* Ld */
9146             /* FALL THROUGH */
9147 #ifdef HAS_QUAD
9148         case 'q':                       /* qd */
9149 #endif
9150             intsize = 'q';
9151             q++;
9152             break;
9153 #endif
9154         case 'l':
9155 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9156             if (*(q + 1) == 'l') {      /* lld, llf */
9157                 intsize = 'q';
9158                 q += 2;
9159                 break;
9160              }
9161 #endif
9162             /* FALL THROUGH */
9163         case 'h':
9164             /* FALL THROUGH */
9165         case 'V':
9166             intsize = *q++;
9167             break;
9168         }
9169
9170         /* CONVERSION */
9171
9172         if (*q == '%') {
9173             eptr = q++;
9174             elen = 1;
9175             goto string;
9176         }
9177
9178         if (vectorize)
9179             argsv = vecsv;
9180         else if (!args)
9181             argsv = (efix ? efix <= svmax : svix < svmax) ?
9182                     svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9183
9184         switch (c = *q++) {
9185
9186             /* STRINGS */
9187
9188         case 'c':
9189             uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9190             if ((uv > 255 ||
9191                  (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9192                 && !IN_BYTES) {
9193                 eptr = (char*)utf8buf;
9194                 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9195                 is_utf8 = TRUE;
9196             }
9197             else {
9198                 c = (char)uv;
9199                 eptr = &c;
9200                 elen = 1;
9201             }
9202             goto string;
9203
9204         case 's':
9205             if (args && !vectorize) {
9206                 eptr = va_arg(*args, char*);
9207                 if (eptr)
9208 #ifdef MACOS_TRADITIONAL
9209                   /* On MacOS, %#s format is used for Pascal strings */
9210                   if (alt)
9211                     elen = *eptr++;
9212                   else
9213 #endif
9214                     elen = strlen(eptr);
9215                 else {
9216                     eptr = (char *)nullstr;
9217                     elen = sizeof nullstr - 1;
9218                 }
9219             }
9220             else {
9221                 eptr = SvPVx_const(argsv, elen);
9222                 if (DO_UTF8(argsv)) {
9223                     if (has_precis && precis < elen) {
9224                         I32 p = precis;
9225                         sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9226                         precis = p;
9227                     }
9228                     if (width) { /* fudge width (can't fudge elen) */
9229                         width += elen - sv_len_utf8(argsv);
9230                     }
9231                     is_utf8 = TRUE;
9232                 }
9233             }
9234
9235         string:
9236             vectorize = FALSE;
9237             if (has_precis && elen > precis)
9238                 elen = precis;
9239             break;
9240
9241             /* INTEGERS */
9242
9243         case 'p':
9244             if (left && args) {         /* SVf */
9245                 left = FALSE;
9246                 if (width) {
9247                     precis = width;
9248                     has_precis = TRUE;
9249                     width = 0;
9250                 }
9251                 if (vectorize)
9252                     goto unknown;
9253                 argsv = va_arg(*args, SV*);
9254                 eptr = SvPVx_const(argsv, elen);
9255                 if (DO_UTF8(argsv))
9256                     is_utf8 = TRUE;
9257                 goto string;
9258             }
9259             if (alt || vectorize)
9260                 goto unknown;
9261             uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9262             base = 16;
9263             goto integer;
9264
9265         case 'D':
9266 #ifdef IV_IS_QUAD
9267             intsize = 'q';
9268 #else
9269             intsize = 'l';
9270 #endif
9271             /* FALL THROUGH */
9272         case 'd':
9273         case 'i':
9274             if (vectorize) {
9275                 STRLEN ulen;
9276                 if (!veclen)
9277                     continue;
9278                 if (vec_utf8)
9279                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9280                                         UTF8_ALLOW_ANYUV);
9281                 else {
9282                     uv = *vecstr;
9283                     ulen = 1;
9284                 }
9285                 vecstr += ulen;
9286                 veclen -= ulen;
9287                 if (plus)
9288                      esignbuf[esignlen++] = plus;
9289             }
9290             else if (args) {
9291                 switch (intsize) {
9292                 case 'h':       iv = (short)va_arg(*args, int); break;
9293                 case 'l':       iv = va_arg(*args, long); break;
9294                 case 'V':       iv = va_arg(*args, IV); break;
9295                 default:        iv = va_arg(*args, int); break;
9296 #ifdef HAS_QUAD
9297                 case 'q':       iv = va_arg(*args, Quad_t); break;
9298 #endif
9299                 }
9300             }
9301             else {
9302                 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9303                 switch (intsize) {
9304                 case 'h':       iv = (short)tiv; break;
9305                 case 'l':       iv = (long)tiv; break;
9306                 case 'V':
9307                 default:        iv = tiv; break;
9308 #ifdef HAS_QUAD
9309                 case 'q':       iv = (Quad_t)tiv; break;
9310 #endif
9311                 }
9312             }
9313             if ( !vectorize )   /* we already set uv above */
9314             {
9315                 if (iv >= 0) {
9316                     uv = iv;
9317                     if (plus)
9318                         esignbuf[esignlen++] = plus;
9319                 }
9320                 else {
9321                     uv = -iv;
9322                     esignbuf[esignlen++] = '-';
9323                 }
9324             }
9325             base = 10;
9326             goto integer;
9327
9328         case 'U':
9329 #ifdef IV_IS_QUAD
9330             intsize = 'q';
9331 #else
9332             intsize = 'l';
9333 #endif
9334             /* FALL THROUGH */
9335         case 'u':
9336             base = 10;
9337             goto uns_integer;
9338
9339         case 'b':
9340             base = 2;
9341             goto uns_integer;
9342
9343         case 'O':
9344 #ifdef IV_IS_QUAD
9345             intsize = 'q';
9346 #else
9347             intsize = 'l';
9348 #endif
9349             /* FALL THROUGH */
9350         case 'o':
9351             base = 8;
9352             goto uns_integer;
9353
9354         case 'X':
9355         case 'x':
9356             base = 16;
9357
9358         uns_integer:
9359             if (vectorize) {
9360                 STRLEN ulen;
9361         vector:
9362                 if (!veclen)
9363                     continue;
9364                 if (vec_utf8)
9365                     uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9366                                         UTF8_ALLOW_ANYUV);
9367                 else {
9368                     uv = *vecstr;
9369                     ulen = 1;
9370                 }
9371                 vecstr += ulen;
9372                 veclen -= ulen;
9373             }
9374             else if (args) {
9375                 switch (intsize) {
9376                 case 'h':  uv = (unsigned short)va_arg(*args, unsigned); break;
9377                 case 'l':  uv = va_arg(*args, unsigned long); break;
9378                 case 'V':  uv = va_arg(*args, UV); break;
9379                 default:   uv = va_arg(*args, unsigned); break;
9380 #ifdef HAS_QUAD
9381                 case 'q':  uv = va_arg(*args, Uquad_t); break;
9382 #endif
9383                 }
9384             }
9385             else {
9386                 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9387                 switch (intsize) {
9388                 case 'h':       uv = (unsigned short)tuv; break;
9389                 case 'l':       uv = (unsigned long)tuv; break;
9390                 case 'V':
9391                 default:        uv = tuv; break;
9392 #ifdef HAS_QUAD
9393                 case 'q':       uv = (Uquad_t)tuv; break;
9394 #endif
9395                 }
9396             }
9397
9398         integer:
9399             {
9400                 char *ptr = ebuf + sizeof ebuf;
9401                 switch (base) {
9402                     unsigned dig;
9403                 case 16:
9404                     if (!uv)
9405                         alt = FALSE;
9406                     p = (char*)((c == 'X')
9407                                 ? "0123456789ABCDEF" : "0123456789abcdef");
9408                     do {
9409                         dig = uv & 15;
9410                         *--ptr = p[dig];
9411                     } while (uv >>= 4);
9412                     if (alt) {
9413                         esignbuf[esignlen++] = '0';
9414                         esignbuf[esignlen++] = c;  /* 'x' or 'X' */
9415                     }
9416                     break;
9417                 case 8:
9418                     do {
9419                         dig = uv & 7;
9420                         *--ptr = '0' + dig;
9421                     } while (uv >>= 3);
9422                     if (alt && *ptr != '0')
9423                         *--ptr = '0';
9424                     break;
9425                 case 2:
9426                     do {
9427                         dig = uv & 1;
9428                         *--ptr = '0' + dig;
9429                     } while (uv >>= 1);
9430                     if (alt) {
9431                         esignbuf[esignlen++] = '0';
9432                         esignbuf[esignlen++] = 'b';
9433                     }
9434                     break;
9435                 default:                /* it had better be ten or less */
9436                     do {
9437                         dig = uv % base;
9438                         *--ptr = '0' + dig;
9439                     } while (uv /= base);
9440                     break;
9441                 }
9442                 elen = (ebuf + sizeof ebuf) - ptr;
9443                 eptr = ptr;
9444                 if (has_precis) {
9445                     if (precis > elen)
9446                         zeros = precis - elen;
9447                     else if (precis == 0 && elen == 1 && *eptr == '0')
9448                         elen = 0;
9449                 }
9450             }
9451             break;
9452
9453             /* FLOATING POINT */
9454
9455         case 'F':
9456             c = 'f';            /* maybe %F isn't supported here */
9457             /* FALL THROUGH */
9458         case 'e': case 'E':
9459         case 'f':
9460         case 'g': case 'G':
9461
9462             /* This is evil, but floating point is even more evil */
9463
9464             /* for SV-style calling, we can only get NV
9465                for C-style calling, we assume %f is double;
9466                for simplicity we allow any of %Lf, %llf, %qf for long double
9467             */
9468             switch (intsize) {
9469             case 'V':
9470 #if defined(USE_LONG_DOUBLE)
9471                 intsize = 'q';
9472 #endif
9473                 break;
9474 /* [perl #20339] - we should accept and ignore %lf rather than die */
9475             case 'l':
9476                 /* FALL THROUGH */
9477             default:
9478 #if defined(USE_LONG_DOUBLE)
9479                 intsize = args ? 0 : 'q';
9480 #endif
9481                 break;
9482             case 'q':
9483 #if defined(HAS_LONG_DOUBLE)
9484                 break;
9485 #else
9486                 /* FALL THROUGH */
9487 #endif
9488             case 'h':
9489                 goto unknown;
9490             }
9491
9492             /* now we need (long double) if intsize == 'q', else (double) */
9493             nv = (args && !vectorize) ?
9494 #if LONG_DOUBLESIZE > DOUBLESIZE
9495                 intsize == 'q' ?
9496                     va_arg(*args, long double) :
9497                     va_arg(*args, double)
9498 #else
9499                     va_arg(*args, double)
9500 #endif
9501                 : SvNVx(argsv);
9502
9503             need = 0;
9504             vectorize = FALSE;
9505             if (c != 'e' && c != 'E') {
9506                 i = PERL_INT_MIN;
9507                 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9508                    will cast our (long double) to (double) */
9509                 (void)Perl_frexp(nv, &i);
9510                 if (i == PERL_INT_MIN)
9511                     Perl_die(aTHX_ "panic: frexp");
9512                 if (i > 0)
9513                     need = BIT_DIGITS(i);
9514             }
9515             need += has_precis ? precis : 6; /* known default */
9516
9517             if (need < width)
9518                 need = width;
9519
9520 #ifdef HAS_LDBL_SPRINTF_BUG
9521             /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9522                with sfio - Allen <allens@cpan.org> */
9523
9524 #  ifdef DBL_MAX
9525 #    define MY_DBL_MAX DBL_MAX
9526 #  else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9527 #    if DOUBLESIZE >= 8
9528 #      define MY_DBL_MAX 1.7976931348623157E+308L
9529 #    else
9530 #      define MY_DBL_MAX 3.40282347E+38L
9531 #    endif
9532 #  endif
9533
9534 #  ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9535 #    define MY_DBL_MAX_BUG 1L
9536 #  else
9537 #    define MY_DBL_MAX_BUG MY_DBL_MAX
9538 #  endif
9539
9540 #  ifdef DBL_MIN
9541 #    define MY_DBL_MIN DBL_MIN
9542 #  else  /* XXX guessing! -Allen */
9543 #    if DOUBLESIZE >= 8
9544 #      define MY_DBL_MIN 2.2250738585072014E-308L
9545 #    else
9546 #      define MY_DBL_MIN 1.17549435E-38L
9547 #    endif
9548 #  endif
9549
9550             if ((intsize == 'q') && (c == 'f') &&
9551                 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9552                 (need < DBL_DIG)) {
9553                 /* it's going to be short enough that
9554                  * long double precision is not needed */
9555
9556                 if ((nv <= 0L) && (nv >= -0L))
9557                     fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9558                 else {
9559                     /* would use Perl_fp_class as a double-check but not
9560                      * functional on IRIX - see perl.h comments */
9561
9562                     if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9563                         /* It's within the range that a double can represent */
9564 #if defined(DBL_MAX) && !defined(DBL_MIN)
9565                         if ((nv >= ((long double)1/DBL_MAX)) ||
9566                             (nv <= (-(long double)1/DBL_MAX)))
9567 #endif
9568                         fix_ldbl_sprintf_bug = TRUE;
9569                     }
9570                 }
9571                 if (fix_ldbl_sprintf_bug == TRUE) {
9572                     double temp;
9573
9574                     intsize = 0;
9575                     temp = (double)nv;
9576                     nv = (NV)temp;
9577                 }
9578             }
9579
9580 #  undef MY_DBL_MAX
9581 #  undef MY_DBL_MAX_BUG
9582 #  undef MY_DBL_MIN
9583
9584 #endif /* HAS_LDBL_SPRINTF_BUG */
9585
9586             need += 20; /* fudge factor */
9587             if (PL_efloatsize < need) {
9588                 Safefree(PL_efloatbuf);
9589                 PL_efloatsize = need + 20; /* more fudge */
9590                 New(906, PL_efloatbuf, PL_efloatsize, char);
9591                 PL_efloatbuf[0] = '\0';
9592             }
9593
9594             if ( !(width || left || plus || alt) && fill != '0'
9595                  && has_precis && intsize != 'q' ) {    /* Shortcuts */
9596                 /* See earlier comment about buggy Gconvert when digits,
9597                    aka precis is 0  */
9598                 if ( c == 'g' && precis) {
9599                     Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9600                     if (*PL_efloatbuf)  /* May return an empty string for digits==0 */
9601                         goto float_converted;
9602                 } else if ( c == 'f' && !precis) {
9603                     if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9604                         break;
9605                 }
9606             }
9607             {
9608                 char *ptr = ebuf + sizeof ebuf;
9609                 *--ptr = '\0';
9610                 *--ptr = c;
9611                 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9612 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9613                 if (intsize == 'q') {
9614                     /* Copy the one or more characters in a long double
9615                      * format before the 'base' ([efgEFG]) character to
9616                      * the format string. */
9617                     static char const prifldbl[] = PERL_PRIfldbl;
9618                     char const *p = prifldbl + sizeof(prifldbl) - 3;
9619                     while (p >= prifldbl) { *--ptr = *p--; }
9620                 }
9621 #endif
9622                 if (has_precis) {
9623                     base = precis;
9624                     do { *--ptr = '0' + (base % 10); } while (base /= 10);
9625                     *--ptr = '.';
9626                 }
9627                 if (width) {
9628                     base = width;
9629                     do { *--ptr = '0' + (base % 10); } while (base /= 10);
9630                 }
9631                 if (fill == '0')
9632                     *--ptr = fill;
9633                 if (left)
9634                     *--ptr = '-';
9635                 if (plus)
9636                     *--ptr = plus;
9637                 if (alt)
9638                     *--ptr = '#';
9639                 *--ptr = '%';
9640
9641                 /* No taint.  Otherwise we are in the strange situation
9642                  * where printf() taints but print($float) doesn't.
9643                  * --jhi */
9644 #if defined(HAS_LONG_DOUBLE)
9645                 if (intsize == 'q')
9646                     (void)sprintf(PL_efloatbuf, ptr, nv);
9647                 else
9648                     (void)sprintf(PL_efloatbuf, ptr, (double)nv);
9649 #else
9650                 (void)sprintf(PL_efloatbuf, ptr, nv);
9651 #endif
9652             }
9653         float_converted:
9654             eptr = PL_efloatbuf;
9655             elen = strlen(PL_efloatbuf);
9656             break;
9657
9658             /* SPECIAL */
9659
9660         case 'n':
9661             i = SvCUR(sv) - origlen;
9662             if (args && !vectorize) {
9663                 switch (intsize) {
9664                 case 'h':       *(va_arg(*args, short*)) = i; break;
9665                 default:        *(va_arg(*args, int*)) = i; break;
9666                 case 'l':       *(va_arg(*args, long*)) = i; break;
9667                 case 'V':       *(va_arg(*args, IV*)) = i; break;
9668 #ifdef HAS_QUAD
9669                 case 'q':       *(va_arg(*args, Quad_t*)) = i; break;
9670 #endif
9671                 }
9672             }
9673             else
9674                 sv_setuv_mg(argsv, (UV)i);
9675             vectorize = FALSE;
9676             continue;   /* not "break" */
9677
9678             /* UNKNOWN */
9679
9680         default:
9681       unknown:
9682             if (!args && ckWARN(WARN_PRINTF) &&
9683                   (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9684                 SV *msg = sv_newmortal();
9685                 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9686                           (PL_op->op_type == OP_PRTF) ? "" : "s");
9687                 if (c) {
9688                     if (isPRINT(c))
9689                         Perl_sv_catpvf(aTHX_ msg,
9690                                        "\"%%%c\"", c & 0xFF);
9691                     else
9692                         Perl_sv_catpvf(aTHX_ msg,
9693                                        "\"%%\\%03"UVof"\"",
9694                                        (UV)c & 0xFF);
9695                 } else
9696                     sv_catpv(msg, "end of string");
9697                 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9698             }
9699
9700             /* output mangled stuff ... */
9701             if (c == '\0')
9702                 --q;
9703             eptr = p;
9704             elen = q - p;
9705
9706             /* ... right here, because formatting flags should not apply */
9707             SvGROW(sv, SvCUR(sv) + elen + 1);
9708             p = SvEND(sv);
9709             Copy(eptr, p, elen, char);
9710             p += elen;
9711             *p = '\0';
9712             SvCUR_set(sv, p - SvPVX_const(sv));
9713             svix = osvix;
9714             continue;   /* not "break" */
9715         }
9716
9717         /* calculate width before utf8_upgrade changes it */
9718         have = esignlen + zeros + elen;
9719
9720         if (is_utf8 != has_utf8) {
9721              if (is_utf8) {
9722                   if (SvCUR(sv))
9723                        sv_utf8_upgrade(sv);
9724              }
9725              else {
9726                   SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9727                   sv_utf8_upgrade(nsv);
9728                   eptr = SvPVX_const(nsv);
9729                   elen = SvCUR(nsv);
9730              }
9731              SvGROW(sv, SvCUR(sv) + elen + 1);
9732              p = SvEND(sv);
9733              *p = '\0';
9734         }
9735
9736         need = (have > width ? have : width);
9737         gap = need - have;
9738
9739         SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9740         p = SvEND(sv);
9741         if (esignlen && fill == '0') {
9742             int i;
9743             for (i = 0; i < (int)esignlen; i++)
9744                 *p++ = esignbuf[i];
9745         }
9746         if (gap && !left) {
9747             memset(p, fill, gap);
9748             p += gap;
9749         }
9750         if (esignlen && fill != '0') {
9751             int i;
9752             for (i = 0; i < (int)esignlen; i++)
9753                 *p++ = esignbuf[i];
9754         }
9755         if (zeros) {
9756             int i;
9757             for (i = zeros; i; i--)
9758                 *p++ = '0';
9759         }
9760         if (elen) {
9761             Copy(eptr, p, elen, char);
9762             p += elen;
9763         }
9764         if (gap && left) {
9765             memset(p, ' ', gap);
9766             p += gap;
9767         }
9768         if (vectorize) {
9769             if (veclen) {
9770                 Copy(dotstr, p, dotstrlen, char);
9771                 p += dotstrlen;
9772             }
9773             else
9774                 vectorize = FALSE;              /* done iterating over vecstr */
9775         }
9776         if (is_utf8)
9777             has_utf8 = TRUE;
9778         if (has_utf8)
9779             SvUTF8_on(sv);
9780         *p = '\0';
9781         SvCUR_set(sv, p - SvPVX_const(sv));
9782         if (vectorize) {
9783             esignlen = 0;
9784             goto vector;
9785         }
9786     }
9787 }
9788
9789 /* =========================================================================
9790
9791 =head1 Cloning an interpreter
9792
9793 All the macros and functions in this section are for the private use of
9794 the main function, perl_clone().
9795
9796 The foo_dup() functions make an exact copy of an existing foo thinngy.
9797 During the course of a cloning, a hash table is used to map old addresses
9798 to new addresses. The table is created and manipulated with the
9799 ptr_table_* functions.
9800
9801 =cut
9802
9803 ============================================================================*/
9804
9805
9806 #if defined(USE_ITHREADS)
9807
9808 #ifndef GpREFCNT_inc
9809 #  define GpREFCNT_inc(gp)      ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9810 #endif
9811
9812
9813 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9814 #define av_dup(s,t)     (AV*)sv_dup((SV*)s,t)
9815 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9816 #define hv_dup(s,t)     (HV*)sv_dup((SV*)s,t)
9817 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9818 #define cv_dup(s,t)     (CV*)sv_dup((SV*)s,t)
9819 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9820 #define io_dup(s,t)     (IO*)sv_dup((SV*)s,t)
9821 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9822 #define gv_dup(s,t)     (GV*)sv_dup((SV*)s,t)
9823 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9824 #define SAVEPV(p)       (p ? savepv(p) : Nullch)
9825 #define SAVEPVN(p,n)    (p ? savepvn(p,n) : Nullch)
9826
9827
9828 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9829    regcomp.c. AMS 20010712 */
9830
9831 REGEXP *
9832 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9833 {
9834     dVAR;
9835     REGEXP *ret;
9836     int i, len, npar;
9837     struct reg_substr_datum *s;
9838
9839     if (!r)
9840         return (REGEXP *)NULL;
9841
9842     if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9843         return ret;
9844
9845     len = r->offsets[0];
9846     npar = r->nparens+1;
9847
9848     Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9849     Copy(r->program, ret->program, len+1, regnode);
9850
9851     New(0, ret->startp, npar, I32);
9852     Copy(r->startp, ret->startp, npar, I32);
9853     New(0, ret->endp, npar, I32);
9854     Copy(r->startp, ret->startp, npar, I32);
9855
9856     New(0, ret->substrs, 1, struct reg_substr_data);
9857     for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9858         s->min_offset = r->substrs->data[i].min_offset;
9859         s->max_offset = r->substrs->data[i].max_offset;
9860         s->substr     = sv_dup_inc(r->substrs->data[i].substr, param);
9861         s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9862     }
9863
9864     ret->regstclass = NULL;
9865     if (r->data) {
9866         struct reg_data *d;
9867         const int count = r->data->count;
9868         int i;
9869
9870         Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9871                 char, struct reg_data);
9872         New(0, d->what, count, U8);
9873
9874         d->count = count;
9875         for (i = 0; i < count; i++) {
9876             d->what[i] = r->data->what[i];
9877             switch (d->what[i]) {
9878                 /* legal options are one of: sfpont
9879                    see also regcomp.h and pregfree() */
9880             case 's':
9881                 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9882                 break;
9883             case 'p':
9884                 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9885                 break;
9886             case 'f':
9887                 /* This is cheating. */
9888                 New(0, d->data[i], 1, struct regnode_charclass_class);
9889                 StructCopy(r->data->data[i], d->data[i],
9890                             struct regnode_charclass_class);
9891                 ret->regstclass = (regnode*)d->data[i];
9892                 break;
9893             case 'o':
9894                 /* Compiled op trees are readonly, and can thus be
9895                    shared without duplication. */
9896                 OP_REFCNT_LOCK;
9897                 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9898                 OP_REFCNT_UNLOCK;
9899                 break;
9900             case 'n':
9901                 d->data[i] = r->data->data[i];
9902                 break;
9903             case 't':
9904                 d->data[i] = r->data->data[i];
9905                 OP_REFCNT_LOCK;
9906                 ((reg_trie_data*)d->data[i])->refcount++;
9907                 OP_REFCNT_UNLOCK;
9908                 break;
9909             default:
9910                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9911             }
9912         }
9913
9914         ret->data = d;
9915     }
9916     else
9917         ret->data = NULL;
9918
9919     New(0, ret->offsets, 2*len+1, U32);
9920     Copy(r->offsets, ret->offsets, 2*len+1, U32);
9921
9922     ret->precomp        = SAVEPVN(r->precomp, r->prelen);
9923     ret->refcnt         = r->refcnt;
9924     ret->minlen         = r->minlen;
9925     ret->prelen         = r->prelen;
9926     ret->nparens        = r->nparens;
9927     ret->lastparen      = r->lastparen;
9928     ret->lastcloseparen = r->lastcloseparen;
9929     ret->reganch        = r->reganch;
9930
9931     ret->sublen         = r->sublen;
9932
9933     if (RX_MATCH_COPIED(ret))
9934         ret->subbeg  = SAVEPVN(r->subbeg, r->sublen);
9935     else
9936         ret->subbeg = Nullch;
9937 #ifdef PERL_OLD_COPY_ON_WRITE
9938     ret->saved_copy = Nullsv;
9939 #endif
9940
9941     ptr_table_store(PL_ptr_table, r, ret);
9942     return ret;
9943 }
9944
9945 /* duplicate a file handle */
9946
9947 PerlIO *
9948 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9949 {
9950     PerlIO *ret;
9951
9952     PERL_UNUSED_ARG(type);
9953
9954     if (!fp)
9955         return (PerlIO*)NULL;
9956
9957     /* look for it in the table first */
9958     ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9959     if (ret)
9960         return ret;
9961
9962     /* create anew and remember what it is */
9963     ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9964     ptr_table_store(PL_ptr_table, fp, ret);
9965     return ret;
9966 }
9967
9968 /* duplicate a directory handle */
9969
9970 DIR *
9971 Perl_dirp_dup(pTHX_ DIR *dp)
9972 {
9973     if (!dp)
9974         return (DIR*)NULL;
9975     /* XXX TODO */
9976     return dp;
9977 }
9978
9979 /* duplicate a typeglob */
9980
9981 GP *
9982 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9983 {
9984     GP *ret;
9985     if (!gp)
9986         return (GP*)NULL;
9987     /* look for it in the table first */
9988     ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9989     if (ret)
9990         return ret;
9991
9992     /* create anew and remember what it is */
9993     Newz(0, ret, 1, GP);
9994     ptr_table_store(PL_ptr_table, gp, ret);
9995
9996     /* clone */
9997     ret->gp_refcnt      = 0;                    /* must be before any other dups! */
9998     ret->gp_sv          = sv_dup_inc(gp->gp_sv, param);
9999     ret->gp_io          = io_dup_inc(gp->gp_io, param);
10000     ret->gp_form        = cv_dup_inc(gp->gp_form, param);
10001     ret->gp_av          = av_dup_inc(gp->gp_av, param);
10002     ret->gp_hv          = hv_dup_inc(gp->gp_hv, param);
10003     ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10004     ret->gp_cv          = cv_dup_inc(gp->gp_cv, param);
10005     ret->gp_cvgen       = gp->gp_cvgen;
10006     ret->gp_flags       = gp->gp_flags;
10007     ret->gp_line        = gp->gp_line;
10008     ret->gp_file        = gp->gp_file;          /* points to COP.cop_file */
10009     return ret;
10010 }
10011
10012 /* duplicate a chain of magic */
10013
10014 MAGIC *
10015 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10016 {
10017     MAGIC *mgprev = (MAGIC*)NULL;
10018     MAGIC *mgret;
10019     if (!mg)
10020         return (MAGIC*)NULL;
10021     /* look for it in the table first */
10022     mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10023     if (mgret)
10024         return mgret;
10025
10026     for (; mg; mg = mg->mg_moremagic) {
10027         MAGIC *nmg;
10028         Newz(0, nmg, 1, MAGIC);
10029         if (mgprev)
10030             mgprev->mg_moremagic = nmg;
10031         else
10032             mgret = nmg;
10033         nmg->mg_virtual = mg->mg_virtual;       /* XXX copy dynamic vtable? */
10034         nmg->mg_private = mg->mg_private;
10035         nmg->mg_type    = mg->mg_type;
10036         nmg->mg_flags   = mg->mg_flags;
10037         if (mg->mg_type == PERL_MAGIC_qr) {
10038             nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10039         }
10040         else if(mg->mg_type == PERL_MAGIC_backref) {
10041             const AV * const av = (AV*) mg->mg_obj;
10042             SV **svp;
10043             I32 i;
10044             (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10045             svp = AvARRAY(av);
10046             for (i = AvFILLp(av); i >= 0; i--) {
10047                 if (!svp[i]) continue;
10048                 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10049             }
10050         }
10051         else if (mg->mg_type == PERL_MAGIC_symtab) {
10052             nmg->mg_obj = mg->mg_obj;
10053         }
10054         else {
10055             nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10056                               ? sv_dup_inc(mg->mg_obj, param)
10057                               : sv_dup(mg->mg_obj, param);
10058         }
10059         nmg->mg_len     = mg->mg_len;
10060         nmg->mg_ptr     = mg->mg_ptr;   /* XXX random ptr? */
10061         if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10062             if (mg->mg_len > 0) {
10063                 nmg->mg_ptr     = SAVEPVN(mg->mg_ptr, mg->mg_len);
10064                 if (mg->mg_type == PERL_MAGIC_overload_table &&
10065                         AMT_AMAGIC((AMT*)mg->mg_ptr))
10066                 {
10067                     AMT *amtp = (AMT*)mg->mg_ptr;
10068                     AMT *namtp = (AMT*)nmg->mg_ptr;
10069                     I32 i;
10070                     for (i = 1; i < NofAMmeth; i++) {
10071                         namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10072                     }
10073                 }
10074             }
10075             else if (mg->mg_len == HEf_SVKEY)
10076                 nmg->mg_ptr     = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10077         }
10078         if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10079             CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10080         }
10081         mgprev = nmg;
10082     }
10083     return mgret;
10084 }
10085
10086 /* create a new pointer-mapping table */
10087
10088 PTR_TBL_t *
10089 Perl_ptr_table_new(pTHX)
10090 {
10091     PTR_TBL_t *tbl;
10092     Newz(0, tbl, 1, PTR_TBL_t);
10093     tbl->tbl_max        = 511;
10094     tbl->tbl_items      = 0;
10095     Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10096     return tbl;
10097 }
10098
10099 #if (PTRSIZE == 8)
10100 #  define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10101 #else
10102 #  define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10103 #endif
10104
10105 #define new_pte()       new_body(struct ptr_tbl_ent, pte)
10106 #define del_pte(p)      del_body_type(p, struct ptr_tbl_ent, pte)
10107
10108 /* map an existing pointer using a table */
10109
10110 void *
10111 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10112 {
10113     PTR_TBL_ENT_t *tblent;
10114     const UV hash = PTR_TABLE_HASH(sv);
10115     assert(tbl);
10116     tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10117     for (; tblent; tblent = tblent->next) {
10118         if (tblent->oldval == sv)
10119             return tblent->newval;
10120     }
10121     return (void*)NULL;
10122 }
10123
10124 /* add a new entry to a pointer-mapping table */
10125
10126 void
10127 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldv, void *newv)
10128 {
10129     PTR_TBL_ENT_t *tblent, **otblent;
10130     /* XXX this may be pessimal on platforms where pointers aren't good
10131      * hash values e.g. if they grow faster in the most significant
10132      * bits */
10133     const UV hash = PTR_TABLE_HASH(oldv);
10134     bool empty = 1;
10135
10136     assert(tbl);
10137     otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10138     for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10139         if (tblent->oldval == oldv) {
10140             tblent->newval = newv;
10141             return;
10142         }
10143     }
10144     tblent = new_pte();
10145     tblent->oldval = oldv;
10146     tblent->newval = newv;
10147     tblent->next = *otblent;
10148     *otblent = tblent;
10149     tbl->tbl_items++;
10150     if (!empty && tbl->tbl_items > tbl->tbl_max)
10151         ptr_table_split(tbl);
10152 }
10153
10154 /* double the hash bucket size of an existing ptr table */
10155
10156 void
10157 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10158 {
10159     PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10160     const UV oldsize = tbl->tbl_max + 1;
10161     UV newsize = oldsize * 2;
10162     UV i;
10163
10164     Renew(ary, newsize, PTR_TBL_ENT_t*);
10165     Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10166     tbl->tbl_max = --newsize;
10167     tbl->tbl_ary = ary;
10168     for (i=0; i < oldsize; i++, ary++) {
10169         PTR_TBL_ENT_t **curentp, **entp, *ent;
10170         if (!*ary)
10171             continue;
10172         curentp = ary + oldsize;
10173         for (entp = ary, ent = *ary; ent; ent = *entp) {
10174             if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10175                 *entp = ent->next;
10176                 ent->next = *curentp;
10177                 *curentp = ent;
10178                 continue;
10179             }
10180             else
10181                 entp = &ent->next;
10182         }
10183     }
10184 }
10185
10186 /* remove all the entries from a ptr table */
10187
10188 void
10189 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10190 {
10191     register PTR_TBL_ENT_t **array;
10192     register PTR_TBL_ENT_t *entry;
10193     UV riter = 0;
10194     UV max;
10195
10196     if (!tbl || !tbl->tbl_items) {
10197         return;
10198     }
10199
10200     array = tbl->tbl_ary;
10201     entry = array[0];
10202     max = tbl->tbl_max;
10203
10204     for (;;) {
10205         if (entry) {
10206             PTR_TBL_ENT_t *oentry = entry;
10207             entry = entry->next;
10208             del_pte(oentry);
10209         }
10210         if (!entry) {
10211             if (++riter > max) {
10212                 break;
10213             }
10214             entry = array[riter];
10215         }
10216     }
10217
10218     tbl->tbl_items = 0;
10219 }
10220
10221 /* clear and free a ptr table */
10222
10223 void
10224 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10225 {
10226     if (!tbl) {
10227         return;
10228     }
10229     ptr_table_clear(tbl);
10230     Safefree(tbl->tbl_ary);
10231     Safefree(tbl);
10232 }
10233
10234
10235 void
10236 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10237 {
10238     if (SvROK(sstr)) {
10239         SvRV_set(dstr, SvWEAKREF(sstr)
10240                        ? sv_dup(SvRV(sstr), param)
10241                        : sv_dup_inc(SvRV(sstr), param));
10242
10243     }
10244     else if (SvPVX_const(sstr)) {
10245         /* Has something there */
10246         if (SvLEN(sstr)) {
10247             /* Normal PV - clone whole allocated space */
10248             SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10249             if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10250                 /* Not that normal - actually sstr is copy on write.
10251                    But we are a true, independant SV, so:  */
10252                 SvREADONLY_off(dstr);
10253                 SvFAKE_off(dstr);
10254             }
10255         }
10256         else {
10257             /* Special case - not normally malloced for some reason */
10258             if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10259                 /* A "shared" PV - clone it as "shared" PV */
10260                 SvPV_set(dstr,
10261                          HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10262                                          param)));
10263             }
10264             else {
10265                 /* Some other special case - random pointer */
10266                 SvPV_set(dstr, SvPVX(sstr));
10267             }
10268         }
10269     }
10270     else {
10271         /* Copy the Null */
10272         if (SvTYPE(dstr) == SVt_RV)
10273             SvRV_set(dstr, NULL);
10274         else
10275             SvPV_set(dstr, 0);
10276     }
10277 }
10278
10279 /* duplicate an SV of any type (including AV, HV etc) */
10280
10281 SV *
10282 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10283 {
10284     dVAR;
10285     SV *dstr;
10286
10287     if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10288         return Nullsv;
10289     /* look for it in the table first */
10290     dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10291     if (dstr)
10292         return dstr;
10293
10294     if(param->flags & CLONEf_JOIN_IN) {
10295         /** We are joining here so we don't want do clone
10296             something that is bad **/
10297         const char *hvname;
10298
10299         if(SvTYPE(sstr) == SVt_PVHV &&
10300            (hvname = HvNAME_get(sstr))) {
10301             /** don't clone stashes if they already exist **/
10302             HV* old_stash = gv_stashpv(hvname,0);
10303             return (SV*) old_stash;
10304         }
10305     }
10306
10307     /* create anew and remember what it is */
10308     new_SV(dstr);
10309
10310 #ifdef DEBUG_LEAKING_SCALARS
10311     dstr->sv_debug_optype = sstr->sv_debug_optype;
10312     dstr->sv_debug_line = sstr->sv_debug_line;
10313     dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10314     dstr->sv_debug_cloned = 1;
10315 #  ifdef NETWARE
10316     dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10317 #  else
10318     dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10319 #  endif
10320 #endif
10321
10322     ptr_table_store(PL_ptr_table, sstr, dstr);
10323
10324     /* clone */
10325     SvFLAGS(dstr)       = SvFLAGS(sstr);
10326     SvFLAGS(dstr)       &= ~SVf_OOK;            /* don't propagate OOK hack */
10327     SvREFCNT(dstr)      = 0;                    /* must be before any other dups! */
10328
10329 #ifdef DEBUGGING
10330     if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10331         PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10332                       PL_watch_pvx, SvPVX_const(sstr));
10333 #endif
10334
10335     /* don't clone objects whose class has asked us not to */
10336     if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10337         SvFLAGS(dstr) &= ~SVTYPEMASK;
10338         SvOBJECT_off(dstr);
10339         return dstr;
10340     }
10341
10342     switch (SvTYPE(sstr)) {
10343     case SVt_NULL:
10344         SvANY(dstr)     = NULL;
10345         break;
10346     case SVt_IV:
10347         SvANY(dstr)     = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10348         SvIV_set(dstr, SvIVX(sstr));
10349         break;
10350     case SVt_NV:
10351         SvANY(dstr)     = new_XNV();
10352         SvNV_set(dstr, SvNVX(sstr));
10353         break;
10354     case SVt_RV:
10355         SvANY(dstr)     = &(dstr->sv_u.svu_rv);
10356         Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10357         break;
10358     default:
10359         {
10360             /* These are all the types that need complex bodies allocating.  */
10361             size_t new_body_length;
10362             size_t new_body_offset = 0;
10363             void **new_body_arena;
10364             void **new_body_arenaroot;
10365             void *new_body;
10366
10367             switch (SvTYPE(sstr)) {
10368             default:
10369                 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
10370                            (IV)SvTYPE(sstr));
10371                 break;
10372
10373             case SVt_PVIO:
10374                 new_body = new_XPVIO();
10375                 new_body_length = sizeof(XPVIO);
10376                 break;
10377             case SVt_PVFM:
10378                 new_body = new_XPVFM();
10379                 new_body_length = sizeof(XPVFM);
10380                 break;
10381
10382             case SVt_PVHV:
10383                 new_body_arena = (void **) &PL_xpvhv_root;
10384                 new_body_arenaroot = (void **) &PL_xpvhv_arenaroot;
10385                 new_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill)
10386                     - STRUCT_OFFSET(xpvhv_allocated, xhv_fill);
10387                 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10388                     + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10389                     - new_body_offset;
10390                 goto new_body;
10391             case SVt_PVAV:
10392                 new_body_arena = (void **) &PL_xpvav_root;
10393                 new_body_arenaroot = (void **) &PL_xpvav_arenaroot;
10394                 new_body_offset = STRUCT_OFFSET(XPVAV, xav_fill)
10395                     - STRUCT_OFFSET(xpvav_allocated, xav_fill);
10396                 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10397                     + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10398                     - new_body_offset;
10399                 goto new_body;
10400             case SVt_PVBM:
10401                 new_body_length = sizeof(XPVBM);
10402                 new_body_arena = (void **) &PL_xpvbm_root;
10403                 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
10404                 goto new_body;
10405             case SVt_PVGV:
10406                 if (GvUNIQUE((GV*)sstr)) {
10407                     /* Do sharing here.  */
10408                 }
10409                 new_body_length = sizeof(XPVGV);
10410                 new_body_arena = (void **) &PL_xpvgv_root;
10411                 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
10412                 goto new_body;
10413             case SVt_PVCV:
10414                 new_body_length = sizeof(XPVCV);
10415                 new_body_arena = (void **) &PL_xpvcv_root;
10416                 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
10417                 goto new_body;
10418             case SVt_PVLV:
10419                 new_body_length = sizeof(XPVLV);
10420                 new_body_arena = (void **) &PL_xpvlv_root;
10421                 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
10422                 goto new_body;
10423             case SVt_PVMG:
10424                 new_body_length = sizeof(XPVMG);
10425                 new_body_arena = (void **) &PL_xpvmg_root;
10426                 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
10427                 goto new_body;
10428             case SVt_PVNV:
10429                 new_body_length = sizeof(XPVNV);
10430                 new_body_arena = (void **) &PL_xpvnv_root;
10431                 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
10432                 goto new_body;
10433             case SVt_PVIV:
10434                 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
10435                     - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
10436                 new_body_length = sizeof(XPVIV) - new_body_offset;
10437                 new_body_arena = (void **) &PL_xpviv_root;
10438                 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
10439                 goto new_body;
10440             case SVt_PV:
10441                 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
10442                     - STRUCT_OFFSET(xpv_allocated, xpv_cur);
10443                 new_body_length = sizeof(XPV) - new_body_offset;
10444                 new_body_arena = (void **) &PL_xpv_root;
10445                 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
10446             new_body:
10447                 assert(new_body_length);
10448 #ifndef PURIFY
10449                 new_body = (void*)((char*)S_new_body(aTHX_ new_body_arenaroot,
10450                                                      new_body_arena,
10451                                                      new_body_length)
10452                                    - new_body_offset);
10453 #else
10454                 /* We always allocated the full length item with PURIFY */
10455                 new_body_length += new_body_offset;
10456                 new_body_offset = 0;
10457                 new_body = my_safemalloc(new_body_length);
10458 #endif
10459             }
10460             assert(new_body);
10461             SvANY(dstr) = new_body;
10462
10463             Copy(((char*)SvANY(sstr)) + new_body_offset,
10464                  ((char*)SvANY(dstr)) + new_body_offset,
10465                  new_body_length, char);
10466
10467             if (SvTYPE(sstr) != SVt_PVAV && SvTYPE(sstr) != SVt_PVHV)
10468                 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10469
10470             /* The Copy above means that all the source (unduplicated) pointers
10471                are now in the destination.  We can check the flags and the
10472                pointers in either, but it's possible that there's less cache
10473                missing by always going for the destination.
10474                FIXME - instrument and check that assumption  */
10475             if (SvTYPE(sstr) >= SVt_PVMG) {
10476                 if (SvMAGIC(dstr))
10477                     SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10478                 if (SvSTASH(dstr))
10479                     SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10480             }
10481
10482             switch (SvTYPE(sstr)) {
10483             case SVt_PV:
10484                 break;
10485             case SVt_PVIV:
10486                 break;
10487             case SVt_PVNV:
10488                 break;
10489             case SVt_PVMG:
10490                 break;
10491             case SVt_PVBM:
10492                 break;
10493             case SVt_PVLV:
10494                 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10495                 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10496                     LvTARG(dstr) = dstr;
10497                 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10498                     LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10499                 else
10500                     LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10501                 break;
10502             case SVt_PVGV:
10503                 GvNAME(dstr)    = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
10504                 GvSTASH(dstr)   = hv_dup(GvSTASH(dstr), param);
10505                 /* Don't call sv_add_backref here as it's going to be created
10506                    as part of the magic cloning of the symbol table.  */
10507                 GvGP(dstr)      = gp_dup(GvGP(dstr), param);
10508                 (void)GpREFCNT_inc(GvGP(dstr));
10509                 break;
10510             case SVt_PVIO:
10511                 IoIFP(dstr)     = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10512                 if (IoOFP(dstr) == IoIFP(sstr))
10513                     IoOFP(dstr) = IoIFP(dstr);
10514                 else
10515                     IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10516                 /* PL_rsfp_filters entries have fake IoDIRP() */
10517                 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
10518                     IoDIRP(dstr)        = dirp_dup(IoDIRP(dstr));
10519                 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10520                     /* I have no idea why fake dirp (rsfps)
10521                        should be treated differently but otherwise
10522                        we end up with leaks -- sky*/
10523                     IoTOP_GV(dstr)      = gv_dup_inc(IoTOP_GV(dstr), param);
10524                     IoFMT_GV(dstr)      = gv_dup_inc(IoFMT_GV(dstr), param);
10525                     IoBOTTOM_GV(dstr)   = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10526                 } else {
10527                     IoTOP_GV(dstr)      = gv_dup(IoTOP_GV(dstr), param);
10528                     IoFMT_GV(dstr)      = gv_dup(IoFMT_GV(dstr), param);
10529                     IoBOTTOM_GV(dstr)   = gv_dup(IoBOTTOM_GV(dstr), param);
10530                 }
10531                 IoTOP_NAME(dstr)        = SAVEPV(IoTOP_NAME(dstr));
10532                 IoFMT_NAME(dstr)        = SAVEPV(IoFMT_NAME(dstr));
10533                 IoBOTTOM_NAME(dstr)     = SAVEPV(IoBOTTOM_NAME(dstr));
10534                 break;
10535             case SVt_PVAV:
10536                 if (AvARRAY((AV*)sstr)) {
10537                     SV **dst_ary, **src_ary;
10538                     SSize_t items = AvFILLp((AV*)sstr) + 1;
10539
10540                     src_ary = AvARRAY((AV*)sstr);
10541                     Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10542                     ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10543                     SvPV_set(dstr, (char*)dst_ary);
10544                     AvALLOC((AV*)dstr) = dst_ary;
10545                     if (AvREAL((AV*)sstr)) {
10546                         while (items-- > 0)
10547                             *dst_ary++ = sv_dup_inc(*src_ary++, param);
10548                     }
10549                     else {
10550                         while (items-- > 0)
10551                             *dst_ary++ = sv_dup(*src_ary++, param);
10552                     }
10553                     items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10554                     while (items-- > 0) {
10555                         *dst_ary++ = &PL_sv_undef;
10556                     }
10557                 }
10558                 else {
10559                     SvPV_set(dstr, Nullch);
10560                     AvALLOC((AV*)dstr)  = (SV**)NULL;
10561                 }
10562                 break;
10563             case SVt_PVHV:
10564                 {
10565                     HEK *hvname = 0;
10566
10567                     if (HvARRAY((HV*)sstr)) {
10568                         STRLEN i = 0;
10569                         const bool sharekeys = !!HvSHAREKEYS(sstr);
10570                         XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10571                         XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10572                         char *darray;
10573                         New(0, darray,
10574                             PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10575                             + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10576                             char);
10577                         HvARRAY(dstr) = (HE**)darray;
10578                         while (i <= sxhv->xhv_max) {
10579                             HE *source = HvARRAY(sstr)[i];
10580                             HvARRAY(dstr)[i] = source
10581                                 ? he_dup(source, sharekeys, param) : 0;
10582                             ++i;
10583                         }
10584                         if (SvOOK(sstr)) {
10585                             struct xpvhv_aux *saux = HvAUX(sstr);
10586                             struct xpvhv_aux *daux = HvAUX(dstr);
10587                             /* This flag isn't copied.  */
10588                             /* SvOOK_on(hv) attacks the IV flags.  */
10589                             SvFLAGS(dstr) |= SVf_OOK;
10590
10591                             hvname = saux->xhv_name;
10592                             daux->xhv_name
10593                                 = hvname ? hek_dup(hvname, param) : hvname;
10594
10595                             daux->xhv_riter = saux->xhv_riter;
10596                             daux->xhv_eiter = saux->xhv_eiter
10597                                 ? he_dup(saux->xhv_eiter,
10598                                          (bool)!!HvSHAREKEYS(sstr), param) : 0;
10599                         }
10600                     }
10601                     else {
10602                         SvPV_set(dstr, Nullch);
10603                     }
10604                     /* Record stashes for possible cloning in Perl_clone(). */
10605                     if(hvname)
10606                         av_push(param->stashes, dstr);
10607                 }
10608                 break;
10609             case SVt_PVFM:
10610             case SVt_PVCV:
10611                 /* NOTE: not refcounted */
10612                 CvSTASH(dstr)   = hv_dup(CvSTASH(dstr), param);
10613                 OP_REFCNT_LOCK;
10614                 CvROOT(dstr)    = OpREFCNT_inc(CvROOT(dstr));
10615                 OP_REFCNT_UNLOCK;
10616                 if (CvCONST(dstr)) {
10617                     CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10618                         SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10619                         sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10620                 }
10621                 /* don't dup if copying back - CvGV isn't refcounted, so the
10622                  * duped GV may never be freed. A bit of a hack! DAPM */
10623                 CvGV(dstr)      = (param->flags & CLONEf_JOIN_IN) ?
10624                     Nullgv : gv_dup(CvGV(dstr), param) ;
10625                 if (!(param->flags & CLONEf_COPY_STACKS)) {
10626                     CvDEPTH(dstr) = 0;
10627                 }
10628                 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10629                 CvOUTSIDE(dstr) =
10630                     CvWEAKOUTSIDE(sstr)
10631                     ? cv_dup(    CvOUTSIDE(dstr), param)
10632                     : cv_dup_inc(CvOUTSIDE(dstr), param);
10633                 if (!CvXSUB(dstr))
10634                     CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10635                 break;
10636             }
10637         }
10638     }
10639
10640     if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10641         ++PL_sv_objcount;
10642
10643     return dstr;
10644  }
10645
10646 /* duplicate a context */
10647
10648 PERL_CONTEXT *
10649 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10650 {
10651     PERL_CONTEXT *ncxs;
10652
10653     if (!cxs)
10654         return (PERL_CONTEXT*)NULL;
10655
10656     /* look for it in the table first */
10657     ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10658     if (ncxs)
10659         return ncxs;
10660
10661     /* create anew and remember what it is */
10662     Newz(56, ncxs, max + 1, PERL_CONTEXT);
10663     ptr_table_store(PL_ptr_table, cxs, ncxs);
10664
10665     while (ix >= 0) {
10666         PERL_CONTEXT *cx = &cxs[ix];
10667         PERL_CONTEXT *ncx = &ncxs[ix];
10668         ncx->cx_type    = cx->cx_type;
10669         if (CxTYPE(cx) == CXt_SUBST) {
10670             Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10671         }
10672         else {
10673             ncx->blk_oldsp      = cx->blk_oldsp;
10674             ncx->blk_oldcop     = cx->blk_oldcop;
10675             ncx->blk_oldmarksp  = cx->blk_oldmarksp;
10676             ncx->blk_oldscopesp = cx->blk_oldscopesp;
10677             ncx->blk_oldpm      = cx->blk_oldpm;
10678             ncx->blk_gimme      = cx->blk_gimme;
10679             switch (CxTYPE(cx)) {
10680             case CXt_SUB:
10681                 ncx->blk_sub.cv         = (cx->blk_sub.olddepth == 0
10682                                            ? cv_dup_inc(cx->blk_sub.cv, param)
10683                                            : cv_dup(cx->blk_sub.cv,param));
10684                 ncx->blk_sub.argarray   = (cx->blk_sub.hasargs
10685                                            ? av_dup_inc(cx->blk_sub.argarray, param)
10686                                            : Nullav);
10687                 ncx->blk_sub.savearray  = av_dup_inc(cx->blk_sub.savearray, param);
10688                 ncx->blk_sub.olddepth   = cx->blk_sub.olddepth;
10689                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
10690                 ncx->blk_sub.lval       = cx->blk_sub.lval;
10691                 ncx->blk_sub.retop      = cx->blk_sub.retop;
10692                 break;
10693             case CXt_EVAL:
10694                 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10695                 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10696                 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10697                 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10698                 ncx->blk_eval.cur_text  = sv_dup(cx->blk_eval.cur_text, param);
10699                 ncx->blk_eval.retop = cx->blk_eval.retop;
10700                 break;
10701             case CXt_LOOP:
10702                 ncx->blk_loop.label     = cx->blk_loop.label;
10703                 ncx->blk_loop.resetsp   = cx->blk_loop.resetsp;
10704                 ncx->blk_loop.redo_op   = cx->blk_loop.redo_op;
10705                 ncx->blk_loop.next_op   = cx->blk_loop.next_op;
10706                 ncx->blk_loop.last_op   = cx->blk_loop.last_op;
10707                 ncx->blk_loop.iterdata  = (CxPADLOOP(cx)
10708                                            ? cx->blk_loop.iterdata
10709                                            : gv_dup((GV*)cx->blk_loop.iterdata, param));
10710                 ncx->blk_loop.oldcomppad
10711                     = (PAD*)ptr_table_fetch(PL_ptr_table,
10712                                             cx->blk_loop.oldcomppad);
10713                 ncx->blk_loop.itersave  = sv_dup_inc(cx->blk_loop.itersave, param);
10714                 ncx->blk_loop.iterlval  = sv_dup_inc(cx->blk_loop.iterlval, param);
10715                 ncx->blk_loop.iterary   = av_dup_inc(cx->blk_loop.iterary, param);
10716                 ncx->blk_loop.iterix    = cx->blk_loop.iterix;
10717                 ncx->blk_loop.itermax   = cx->blk_loop.itermax;
10718                 break;
10719             case CXt_FORMAT:
10720                 ncx->blk_sub.cv         = cv_dup(cx->blk_sub.cv, param);
10721                 ncx->blk_sub.gv         = gv_dup(cx->blk_sub.gv, param);
10722                 ncx->blk_sub.dfoutgv    = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10723                 ncx->blk_sub.hasargs    = cx->blk_sub.hasargs;
10724                 ncx->blk_sub.retop      = cx->blk_sub.retop;
10725                 break;
10726             case CXt_BLOCK:
10727             case CXt_NULL:
10728                 break;
10729             }
10730         }
10731         --ix;
10732     }
10733     return ncxs;
10734 }
10735
10736 /* duplicate a stack info structure */
10737
10738 PERL_SI *
10739 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10740 {
10741     PERL_SI *nsi;
10742
10743     if (!si)
10744         return (PERL_SI*)NULL;
10745
10746     /* look for it in the table first */
10747     nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10748     if (nsi)
10749         return nsi;
10750
10751     /* create anew and remember what it is */
10752     Newz(56, nsi, 1, PERL_SI);
10753     ptr_table_store(PL_ptr_table, si, nsi);
10754
10755     nsi->si_stack       = av_dup_inc(si->si_stack, param);
10756     nsi->si_cxix        = si->si_cxix;
10757     nsi->si_cxmax       = si->si_cxmax;
10758     nsi->si_cxstack     = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10759     nsi->si_type        = si->si_type;
10760     nsi->si_prev        = si_dup(si->si_prev, param);
10761     nsi->si_next        = si_dup(si->si_next, param);
10762     nsi->si_markoff     = si->si_markoff;
10763
10764     return nsi;
10765 }
10766
10767 #define POPINT(ss,ix)   ((ss)[--(ix)].any_i32)
10768 #define TOPINT(ss,ix)   ((ss)[ix].any_i32)
10769 #define POPLONG(ss,ix)  ((ss)[--(ix)].any_long)
10770 #define TOPLONG(ss,ix)  ((ss)[ix].any_long)
10771 #define POPIV(ss,ix)    ((ss)[--(ix)].any_iv)
10772 #define TOPIV(ss,ix)    ((ss)[ix].any_iv)
10773 #define POPBOOL(ss,ix)  ((ss)[--(ix)].any_bool)
10774 #define TOPBOOL(ss,ix)  ((ss)[ix].any_bool)
10775 #define POPPTR(ss,ix)   ((ss)[--(ix)].any_ptr)
10776 #define TOPPTR(ss,ix)   ((ss)[ix].any_ptr)
10777 #define POPDPTR(ss,ix)  ((ss)[--(ix)].any_dptr)
10778 #define TOPDPTR(ss,ix)  ((ss)[ix].any_dptr)
10779 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10780 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10781
10782 /* XXXXX todo */
10783 #define pv_dup_inc(p)   SAVEPV(p)
10784 #define pv_dup(p)       SAVEPV(p)
10785 #define svp_dup_inc(p,pp)       any_dup(p,pp)
10786
10787 /* map any object to the new equivent - either something in the
10788  * ptr table, or something in the interpreter structure
10789  */
10790
10791 void *
10792 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10793 {
10794     void *ret;
10795
10796     if (!v)
10797         return (void*)NULL;
10798
10799     /* look for it in the table first */
10800     ret = ptr_table_fetch(PL_ptr_table, v);
10801     if (ret)
10802         return ret;
10803
10804     /* see if it is part of the interpreter structure */
10805     if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10806         ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10807     else {
10808         ret = v;
10809     }
10810
10811     return ret;
10812 }
10813
10814 /* duplicate the save stack */
10815
10816 ANY *
10817 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10818 {
10819     ANY * const ss      = proto_perl->Tsavestack;
10820     const I32 max       = proto_perl->Tsavestack_max;
10821     I32 ix              = proto_perl->Tsavestack_ix;
10822     ANY *nss;
10823     SV *sv;
10824     GV *gv;
10825     AV *av;
10826     HV *hv;
10827     void* ptr;
10828     int intval;
10829     long longval;
10830     GP *gp;
10831     IV iv;
10832     char *c = NULL;
10833     void (*dptr) (void*);
10834     void (*dxptr) (pTHX_ void*);
10835
10836     Newz(54, nss, max, ANY);
10837
10838     while (ix > 0) {
10839         I32 i = POPINT(ss,ix);
10840         TOPINT(nss,ix) = i;
10841         switch (i) {
10842         case SAVEt_ITEM:                        /* normal string */
10843             sv = (SV*)POPPTR(ss,ix);
10844             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10845             sv = (SV*)POPPTR(ss,ix);
10846             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10847             break;
10848         case SAVEt_SV:                          /* scalar reference */
10849             sv = (SV*)POPPTR(ss,ix);
10850             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10851             gv = (GV*)POPPTR(ss,ix);
10852             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10853             break;
10854         case SAVEt_GENERIC_PVREF:               /* generic char* */
10855             c = (char*)POPPTR(ss,ix);
10856             TOPPTR(nss,ix) = pv_dup(c);
10857             ptr = POPPTR(ss,ix);
10858             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10859             break;
10860         case SAVEt_SHARED_PVREF:                /* char* in shared space */
10861             c = (char*)POPPTR(ss,ix);
10862             TOPPTR(nss,ix) = savesharedpv(c);
10863             ptr = POPPTR(ss,ix);
10864             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10865             break;
10866         case SAVEt_GENERIC_SVREF:               /* generic sv */
10867         case SAVEt_SVREF:                       /* scalar reference */
10868             sv = (SV*)POPPTR(ss,ix);
10869             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10870             ptr = POPPTR(ss,ix);
10871             TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10872             break;
10873         case SAVEt_AV:                          /* array reference */
10874             av = (AV*)POPPTR(ss,ix);
10875             TOPPTR(nss,ix) = av_dup_inc(av, param);
10876             gv = (GV*)POPPTR(ss,ix);
10877             TOPPTR(nss,ix) = gv_dup(gv, param);
10878             break;
10879         case SAVEt_HV:                          /* hash reference */
10880             hv = (HV*)POPPTR(ss,ix);
10881             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10882             gv = (GV*)POPPTR(ss,ix);
10883             TOPPTR(nss,ix) = gv_dup(gv, param);
10884             break;
10885         case SAVEt_INT:                         /* int reference */
10886             ptr = POPPTR(ss,ix);
10887             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10888             intval = (int)POPINT(ss,ix);
10889             TOPINT(nss,ix) = intval;
10890             break;
10891         case SAVEt_LONG:                        /* long reference */
10892             ptr = POPPTR(ss,ix);
10893             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10894             longval = (long)POPLONG(ss,ix);
10895             TOPLONG(nss,ix) = longval;
10896             break;
10897         case SAVEt_I32:                         /* I32 reference */
10898         case SAVEt_I16:                         /* I16 reference */
10899         case SAVEt_I8:                          /* I8 reference */
10900             ptr = POPPTR(ss,ix);
10901             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10902             i = POPINT(ss,ix);
10903             TOPINT(nss,ix) = i;
10904             break;
10905         case SAVEt_IV:                          /* IV reference */
10906             ptr = POPPTR(ss,ix);
10907             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10908             iv = POPIV(ss,ix);
10909             TOPIV(nss,ix) = iv;
10910             break;
10911         case SAVEt_SPTR:                        /* SV* reference */
10912             ptr = POPPTR(ss,ix);
10913             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10914             sv = (SV*)POPPTR(ss,ix);
10915             TOPPTR(nss,ix) = sv_dup(sv, param);
10916             break;
10917         case SAVEt_VPTR:                        /* random* reference */
10918             ptr = POPPTR(ss,ix);
10919             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10920             ptr = POPPTR(ss,ix);
10921             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10922             break;
10923         case SAVEt_PPTR:                        /* char* reference */
10924             ptr = POPPTR(ss,ix);
10925             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10926             c = (char*)POPPTR(ss,ix);
10927             TOPPTR(nss,ix) = pv_dup(c);
10928             break;
10929         case SAVEt_HPTR:                        /* HV* reference */
10930             ptr = POPPTR(ss,ix);
10931             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10932             hv = (HV*)POPPTR(ss,ix);
10933             TOPPTR(nss,ix) = hv_dup(hv, param);
10934             break;
10935         case SAVEt_APTR:                        /* AV* reference */
10936             ptr = POPPTR(ss,ix);
10937             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10938             av = (AV*)POPPTR(ss,ix);
10939             TOPPTR(nss,ix) = av_dup(av, param);
10940             break;
10941         case SAVEt_NSTAB:
10942             gv = (GV*)POPPTR(ss,ix);
10943             TOPPTR(nss,ix) = gv_dup(gv, param);
10944             break;
10945         case SAVEt_GP:                          /* scalar reference */
10946             gp = (GP*)POPPTR(ss,ix);
10947             TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10948             (void)GpREFCNT_inc(gp);
10949             gv = (GV*)POPPTR(ss,ix);
10950             TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10951             c = (char*)POPPTR(ss,ix);
10952             TOPPTR(nss,ix) = pv_dup(c);
10953             iv = POPIV(ss,ix);
10954             TOPIV(nss,ix) = iv;
10955             iv = POPIV(ss,ix);
10956             TOPIV(nss,ix) = iv;
10957             break;
10958         case SAVEt_FREESV:
10959         case SAVEt_MORTALIZESV:
10960             sv = (SV*)POPPTR(ss,ix);
10961             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10962             break;
10963         case SAVEt_FREEOP:
10964             ptr = POPPTR(ss,ix);
10965             if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10966                 /* these are assumed to be refcounted properly */
10967                 OP *o;
10968                 switch (((OP*)ptr)->op_type) {
10969                 case OP_LEAVESUB:
10970                 case OP_LEAVESUBLV:
10971                 case OP_LEAVEEVAL:
10972                 case OP_LEAVE:
10973                 case OP_SCOPE:
10974                 case OP_LEAVEWRITE:
10975                     TOPPTR(nss,ix) = ptr;
10976                     o = (OP*)ptr;
10977                     OpREFCNT_inc(o);
10978                     break;
10979                 default:
10980                     TOPPTR(nss,ix) = Nullop;
10981                     break;
10982                 }
10983             }
10984             else
10985                 TOPPTR(nss,ix) = Nullop;
10986             break;
10987         case SAVEt_FREEPV:
10988             c = (char*)POPPTR(ss,ix);
10989             TOPPTR(nss,ix) = pv_dup_inc(c);
10990             break;
10991         case SAVEt_CLEARSV:
10992             longval = POPLONG(ss,ix);
10993             TOPLONG(nss,ix) = longval;
10994             break;
10995         case SAVEt_DELETE:
10996             hv = (HV*)POPPTR(ss,ix);
10997             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10998             c = (char*)POPPTR(ss,ix);
10999             TOPPTR(nss,ix) = pv_dup_inc(c);
11000             i = POPINT(ss,ix);
11001             TOPINT(nss,ix) = i;
11002             break;
11003         case SAVEt_DESTRUCTOR:
11004             ptr = POPPTR(ss,ix);
11005             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
11006             dptr = POPDPTR(ss,ix);
11007             TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11008                                         any_dup(FPTR2DPTR(void *, dptr),
11009                                                 proto_perl));
11010             break;
11011         case SAVEt_DESTRUCTOR_X:
11012             ptr = POPPTR(ss,ix);
11013             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);  /* XXX quite arbitrary */
11014             dxptr = POPDXPTR(ss,ix);
11015             TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11016                                          any_dup(FPTR2DPTR(void *, dxptr),
11017                                                  proto_perl));
11018             break;
11019         case SAVEt_REGCONTEXT:
11020         case SAVEt_ALLOC:
11021             i = POPINT(ss,ix);
11022             TOPINT(nss,ix) = i;
11023             ix -= i;
11024             break;
11025         case SAVEt_STACK_POS:           /* Position on Perl stack */
11026             i = POPINT(ss,ix);
11027             TOPINT(nss,ix) = i;
11028             break;
11029         case SAVEt_AELEM:               /* array element */
11030             sv = (SV*)POPPTR(ss,ix);
11031             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11032             i = POPINT(ss,ix);
11033             TOPINT(nss,ix) = i;
11034             av = (AV*)POPPTR(ss,ix);
11035             TOPPTR(nss,ix) = av_dup_inc(av, param);
11036             break;
11037         case SAVEt_HELEM:               /* hash element */
11038             sv = (SV*)POPPTR(ss,ix);
11039             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11040             sv = (SV*)POPPTR(ss,ix);
11041             TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11042             hv = (HV*)POPPTR(ss,ix);
11043             TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11044             break;
11045         case SAVEt_OP:
11046             ptr = POPPTR(ss,ix);
11047             TOPPTR(nss,ix) = ptr;
11048             break;
11049         case SAVEt_HINTS:
11050             i = POPINT(ss,ix);
11051             TOPINT(nss,ix) = i;
11052             break;
11053         case SAVEt_COMPPAD:
11054             av = (AV*)POPPTR(ss,ix);
11055             TOPPTR(nss,ix) = av_dup(av, param);
11056             break;
11057         case SAVEt_PADSV:
11058             longval = (long)POPLONG(ss,ix);
11059             TOPLONG(nss,ix) = longval;
11060             ptr = POPPTR(ss,ix);
11061             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11062             sv = (SV*)POPPTR(ss,ix);
11063             TOPPTR(nss,ix) = sv_dup(sv, param);
11064             break;
11065         case SAVEt_BOOL:
11066             ptr = POPPTR(ss,ix);
11067             TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11068             longval = (long)POPBOOL(ss,ix);
11069             TOPBOOL(nss,ix) = (bool)longval;
11070             break;
11071         case SAVEt_SET_SVFLAGS:
11072             i = POPINT(ss,ix);
11073             TOPINT(nss,ix) = i;
11074             i = POPINT(ss,ix);
11075             TOPINT(nss,ix) = i;
11076             sv = (SV*)POPPTR(ss,ix);
11077             TOPPTR(nss,ix) = sv_dup(sv, param);
11078             break;
11079         default:
11080             Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11081         }
11082     }
11083
11084     return nss;
11085 }
11086
11087
11088 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11089  * flag to the result. This is done for each stash before cloning starts,
11090  * so we know which stashes want their objects cloned */
11091
11092 static void
11093 do_mark_cloneable_stash(pTHX_ SV *sv)
11094 {
11095     const HEK * const hvname = HvNAME_HEK((HV*)sv);
11096     if (hvname) {
11097         GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11098         SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11099         if (cloner && GvCV(cloner)) {
11100             dSP;
11101             UV status;
11102
11103             ENTER;
11104             SAVETMPS;
11105             PUSHMARK(SP);
11106             XPUSHs(sv_2mortal(newSVhek(hvname)));
11107             PUTBACK;
11108             call_sv((SV*)GvCV(cloner), G_SCALAR);
11109             SPAGAIN;
11110             status = POPu;
11111             PUTBACK;
11112             FREETMPS;
11113             LEAVE;
11114             if (status)
11115                 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11116         }
11117     }
11118 }
11119
11120
11121
11122 /*
11123 =for apidoc perl_clone
11124
11125 Create and return a new interpreter by cloning the current one.
11126
11127 perl_clone takes these flags as parameters:
11128
11129 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11130 without it we only clone the data and zero the stacks,
11131 with it we copy the stacks and the new perl interpreter is
11132 ready to run at the exact same point as the previous one.
11133 The pseudo-fork code uses COPY_STACKS while the
11134 threads->new doesn't.
11135
11136 CLONEf_KEEP_PTR_TABLE
11137 perl_clone keeps a ptr_table with the pointer of the old
11138 variable as a key and the new variable as a value,
11139 this allows it to check if something has been cloned and not
11140 clone it again but rather just use the value and increase the
11141 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11142 the ptr_table using the function
11143 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11144 reason to keep it around is if you want to dup some of your own
11145 variable who are outside the graph perl scans, example of this
11146 code is in threads.xs create
11147
11148 CLONEf_CLONE_HOST
11149 This is a win32 thing, it is ignored on unix, it tells perls
11150 win32host code (which is c++) to clone itself, this is needed on
11151 win32 if you want to run two threads at the same time,
11152 if you just want to do some stuff in a separate perl interpreter
11153 and then throw it away and return to the original one,
11154 you don't need to do anything.
11155
11156 =cut
11157 */
11158
11159 /* XXX the above needs expanding by someone who actually understands it ! */
11160 EXTERN_C PerlInterpreter *
11161 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11162
11163 PerlInterpreter *
11164 perl_clone(PerlInterpreter *proto_perl, UV flags)
11165 {
11166    dVAR;
11167 #ifdef PERL_IMPLICIT_SYS
11168
11169    /* perlhost.h so we need to call into it
11170    to clone the host, CPerlHost should have a c interface, sky */
11171
11172    if (flags & CLONEf_CLONE_HOST) {
11173        return perl_clone_host(proto_perl,flags);
11174    }
11175    return perl_clone_using(proto_perl, flags,
11176                             proto_perl->IMem,
11177                             proto_perl->IMemShared,
11178                             proto_perl->IMemParse,
11179                             proto_perl->IEnv,
11180                             proto_perl->IStdIO,
11181                             proto_perl->ILIO,
11182                             proto_perl->IDir,
11183                             proto_perl->ISock,
11184                             proto_perl->IProc);
11185 }
11186
11187 PerlInterpreter *
11188 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11189                  struct IPerlMem* ipM, struct IPerlMem* ipMS,
11190                  struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11191                  struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11192                  struct IPerlDir* ipD, struct IPerlSock* ipS,
11193                  struct IPerlProc* ipP)
11194 {
11195     /* XXX many of the string copies here can be optimized if they're
11196      * constants; they need to be allocated as common memory and just
11197      * their pointers copied. */
11198
11199     IV i;
11200     CLONE_PARAMS clone_params;
11201     CLONE_PARAMS* param = &clone_params;
11202
11203     PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11204     /* for each stash, determine whether its objects should be cloned */
11205     S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11206     PERL_SET_THX(my_perl);
11207
11208 #  ifdef DEBUGGING
11209     Poison(my_perl, 1, PerlInterpreter);
11210     PL_op = Nullop;
11211     PL_curcop = (COP *)Nullop;
11212     PL_markstack = 0;
11213     PL_scopestack = 0;
11214     PL_savestack = 0;
11215     PL_savestack_ix = 0;
11216     PL_savestack_max = -1;
11217     PL_sig_pending = 0;
11218     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11219 #  else /* !DEBUGGING */
11220     Zero(my_perl, 1, PerlInterpreter);
11221 #  endif        /* DEBUGGING */
11222
11223     /* host pointers */
11224     PL_Mem              = ipM;
11225     PL_MemShared        = ipMS;
11226     PL_MemParse         = ipMP;
11227     PL_Env              = ipE;
11228     PL_StdIO            = ipStd;
11229     PL_LIO              = ipLIO;
11230     PL_Dir              = ipD;
11231     PL_Sock             = ipS;
11232     PL_Proc             = ipP;
11233 #else           /* !PERL_IMPLICIT_SYS */
11234     IV i;
11235     CLONE_PARAMS clone_params;
11236     CLONE_PARAMS* param = &clone_params;
11237     PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11238     /* for each stash, determine whether its objects should be cloned */
11239     S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11240     PERL_SET_THX(my_perl);
11241
11242 #    ifdef DEBUGGING
11243     Poison(my_perl, 1, PerlInterpreter);
11244     PL_op = Nullop;
11245     PL_curcop = (COP *)Nullop;
11246     PL_markstack = 0;
11247     PL_scopestack = 0;
11248     PL_savestack = 0;
11249     PL_savestack_ix = 0;
11250     PL_savestack_max = -1;
11251     PL_sig_pending = 0;
11252     Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11253 #    else       /* !DEBUGGING */
11254     Zero(my_perl, 1, PerlInterpreter);
11255 #    endif      /* DEBUGGING */
11256 #endif          /* PERL_IMPLICIT_SYS */
11257     param->flags = flags;
11258     param->proto_perl = proto_perl;
11259
11260     /* arena roots */
11261     PL_xnv_arenaroot    = NULL;
11262     PL_xnv_root         = NULL;
11263     PL_xpv_arenaroot    = NULL;
11264     PL_xpv_root         = NULL;
11265     PL_xpviv_arenaroot  = NULL;
11266     PL_xpviv_root       = NULL;
11267     PL_xpvnv_arenaroot  = NULL;
11268     PL_xpvnv_root       = NULL;
11269     PL_xpvcv_arenaroot  = NULL;
11270     PL_xpvcv_root       = NULL;
11271     PL_xpvav_arenaroot  = NULL;
11272     PL_xpvav_root       = NULL;
11273     PL_xpvhv_arenaroot  = NULL;
11274     PL_xpvhv_root       = NULL;
11275     PL_xpvmg_arenaroot  = NULL;
11276     PL_xpvmg_root       = NULL;
11277     PL_xpvgv_arenaroot  = NULL;
11278     PL_xpvgv_root       = NULL;
11279     PL_xpvlv_arenaroot  = NULL;
11280     PL_xpvlv_root       = NULL;
11281     PL_xpvbm_arenaroot  = NULL;
11282     PL_xpvbm_root       = NULL;
11283     PL_he_arenaroot     = NULL;
11284     PL_he_root          = NULL;
11285 #if defined(USE_ITHREADS)
11286     PL_pte_arenaroot    = NULL;
11287     PL_pte_root         = NULL;
11288 #endif
11289     PL_nice_chunk       = NULL;
11290     PL_nice_chunk_size  = 0;
11291     PL_sv_count         = 0;
11292     PL_sv_objcount      = 0;
11293     PL_sv_root          = Nullsv;
11294     PL_sv_arenaroot     = Nullsv;
11295
11296     PL_debug            = proto_perl->Idebug;
11297
11298     PL_hash_seed        = proto_perl->Ihash_seed;
11299     PL_rehash_seed      = proto_perl->Irehash_seed;
11300
11301 #ifdef USE_REENTRANT_API
11302     /* XXX: things like -Dm will segfault here in perlio, but doing
11303      *  PERL_SET_CONTEXT(proto_perl);
11304      * breaks too many other things
11305      */
11306     Perl_reentrant_init(aTHX);
11307 #endif
11308
11309     /* create SV map for pointer relocation */
11310     PL_ptr_table = ptr_table_new();
11311
11312     /* initialize these special pointers as early as possible */
11313     SvANY(&PL_sv_undef)         = NULL;
11314     SvREFCNT(&PL_sv_undef)      = (~(U32)0)/2;
11315     SvFLAGS(&PL_sv_undef)       = SVf_READONLY|SVt_NULL;
11316     ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11317
11318     SvANY(&PL_sv_no)            = new_XPVNV();
11319     SvREFCNT(&PL_sv_no)         = (~(U32)0)/2;
11320     SvFLAGS(&PL_sv_no)          = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11321                                   |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11322     SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11323     SvCUR_set(&PL_sv_no, 0);
11324     SvLEN_set(&PL_sv_no, 1);
11325     SvIV_set(&PL_sv_no, 0);
11326     SvNV_set(&PL_sv_no, 0);
11327     ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11328
11329     SvANY(&PL_sv_yes)           = new_XPVNV();
11330     SvREFCNT(&PL_sv_yes)        = (~(U32)0)/2;
11331     SvFLAGS(&PL_sv_yes)         = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11332                                   |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11333     SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11334     SvCUR_set(&PL_sv_yes, 1);
11335     SvLEN_set(&PL_sv_yes, 2);
11336     SvIV_set(&PL_sv_yes, 1);
11337     SvNV_set(&PL_sv_yes, 1);
11338     ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11339
11340     /* create (a non-shared!) shared string table */
11341     PL_strtab           = newHV();
11342     HvSHAREKEYS_off(PL_strtab);
11343     hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11344     ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11345
11346     PL_compiling = proto_perl->Icompiling;
11347
11348     /* These two PVs will be free'd special way so must set them same way op.c does */
11349     PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11350     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11351
11352     PL_compiling.cop_file    = savesharedpv(PL_compiling.cop_file);
11353     ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11354
11355     ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11356     if (!specialWARN(PL_compiling.cop_warnings))
11357         PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11358     if (!specialCopIO(PL_compiling.cop_io))
11359         PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11360     PL_curcop           = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11361
11362     /* pseudo environmental stuff */
11363     PL_origargc         = proto_perl->Iorigargc;
11364     PL_origargv         = proto_perl->Iorigargv;
11365
11366     param->stashes      = newAV();  /* Setup array of objects to call clone on */
11367
11368 #ifdef PERLIO_LAYERS
11369     /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11370     PerlIO_clone(aTHX_ proto_perl, param);
11371 #endif
11372
11373     PL_envgv            = gv_dup(proto_perl->Ienvgv, param);
11374     PL_incgv            = gv_dup(proto_perl->Iincgv, param);
11375     PL_hintgv           = gv_dup(proto_perl->Ihintgv, param);
11376     PL_origfilename     = SAVEPV(proto_perl->Iorigfilename);
11377     PL_diehook          = sv_dup_inc(proto_perl->Idiehook, param);
11378     PL_warnhook         = sv_dup_inc(proto_perl->Iwarnhook, param);
11379
11380     /* switches */
11381     PL_minus_c          = proto_perl->Iminus_c;
11382     PL_patchlevel       = sv_dup_inc(proto_perl->Ipatchlevel, param);
11383     PL_localpatches     = proto_perl->Ilocalpatches;
11384     PL_splitstr         = proto_perl->Isplitstr;
11385     PL_preprocess       = proto_perl->Ipreprocess;
11386     PL_minus_n          = proto_perl->Iminus_n;
11387     PL_minus_p          = proto_perl->Iminus_p;
11388     PL_minus_l          = proto_perl->Iminus_l;
11389     PL_minus_a          = proto_perl->Iminus_a;
11390     PL_minus_F          = proto_perl->Iminus_F;
11391     PL_doswitches       = proto_perl->Idoswitches;
11392     PL_dowarn           = proto_perl->Idowarn;
11393     PL_doextract        = proto_perl->Idoextract;
11394     PL_sawampersand     = proto_perl->Isawampersand;
11395     PL_unsafe           = proto_perl->Iunsafe;
11396     PL_inplace          = SAVEPV(proto_perl->Iinplace);
11397     PL_e_script         = sv_dup_inc(proto_perl->Ie_script, param);
11398     PL_perldb           = proto_perl->Iperldb;
11399     PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11400     PL_exit_flags       = proto_perl->Iexit_flags;
11401
11402     /* magical thingies */
11403     /* XXX time(&PL_basetime) when asked for? */
11404     PL_basetime         = proto_perl->Ibasetime;
11405     PL_formfeed         = sv_dup(proto_perl->Iformfeed, param);
11406
11407     PL_maxsysfd         = proto_perl->Imaxsysfd;
11408     PL_multiline        = proto_perl->Imultiline;
11409     PL_statusvalue      = proto_perl->Istatusvalue;
11410 #ifdef VMS
11411     PL_statusvalue_vms  = proto_perl->Istatusvalue_vms;
11412 #endif
11413     PL_encoding         = sv_dup(proto_perl->Iencoding, param);
11414
11415     sv_setpvn(PERL_DEBUG_PAD(0), "", 0);        /* For regex debugging. */
11416     sv_setpvn(PERL_DEBUG_PAD(1), "", 0);        /* ext/re needs these */
11417     sv_setpvn(PERL_DEBUG_PAD(2), "", 0);        /* even without DEBUGGING. */
11418
11419     /* Clone the regex array */
11420     PL_regex_padav = newAV();
11421     {
11422         const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11423         SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11424         IV i;
11425         av_push(PL_regex_padav,
11426                 sv_dup_inc(regexen[0],param));
11427         for(i = 1; i <= len; i++) {
11428             if(SvREPADTMP(regexen[i])) {
11429               av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11430             } else {
11431                 av_push(PL_regex_padav,
11432                     SvREFCNT_inc(
11433                         newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11434                              SvIVX(regexen[i])), param)))
11435                        ));
11436             }
11437         }
11438     }
11439     PL_regex_pad = AvARRAY(PL_regex_padav);
11440
11441     /* shortcuts to various I/O objects */
11442     PL_stdingv          = gv_dup(proto_perl->Istdingv, param);
11443     PL_stderrgv         = gv_dup(proto_perl->Istderrgv, param);
11444     PL_defgv            = gv_dup(proto_perl->Idefgv, param);
11445     PL_argvgv           = gv_dup(proto_perl->Iargvgv, param);
11446     PL_argvoutgv        = gv_dup(proto_perl->Iargvoutgv, param);
11447     PL_argvout_stack    = av_dup_inc(proto_perl->Iargvout_stack, param);
11448
11449     /* shortcuts to regexp stuff */
11450     PL_replgv           = gv_dup(proto_perl->Ireplgv, param);
11451
11452     /* shortcuts to misc objects */
11453     PL_errgv            = gv_dup(proto_perl->Ierrgv, param);
11454
11455     /* shortcuts to debugging objects */
11456     PL_DBgv             = gv_dup(proto_perl->IDBgv, param);
11457     PL_DBline           = gv_dup(proto_perl->IDBline, param);
11458     PL_DBsub            = gv_dup(proto_perl->IDBsub, param);
11459     PL_DBsingle         = sv_dup(proto_perl->IDBsingle, param);
11460     PL_DBtrace          = sv_dup(proto_perl->IDBtrace, param);
11461     PL_DBsignal         = sv_dup(proto_perl->IDBsignal, param);
11462     PL_DBassertion      = sv_dup(proto_perl->IDBassertion, param);
11463     PL_lineary          = av_dup(proto_perl->Ilineary, param);
11464     PL_dbargs           = av_dup(proto_perl->Idbargs, param);
11465
11466     /* symbol tables */
11467     PL_defstash         = hv_dup_inc(proto_perl->Tdefstash, param);
11468     PL_curstash         = hv_dup(proto_perl->Tcurstash, param);
11469     PL_debstash         = hv_dup(proto_perl->Idebstash, param);
11470     PL_globalstash      = hv_dup(proto_perl->Iglobalstash, param);
11471     PL_curstname        = sv_dup_inc(proto_perl->Icurstname, param);
11472
11473     PL_beginav          = av_dup_inc(proto_perl->Ibeginav, param);
11474     PL_beginav_save     = av_dup_inc(proto_perl->Ibeginav_save, param);
11475     PL_checkav_save     = av_dup_inc(proto_perl->Icheckav_save, param);
11476     PL_endav            = av_dup_inc(proto_perl->Iendav, param);
11477     PL_checkav          = av_dup_inc(proto_perl->Icheckav, param);
11478     PL_initav           = av_dup_inc(proto_perl->Iinitav, param);
11479
11480     PL_sub_generation   = proto_perl->Isub_generation;
11481
11482     /* funky return mechanisms */
11483     PL_forkprocess      = proto_perl->Iforkprocess;
11484
11485     /* subprocess state */
11486     PL_fdpid            = av_dup_inc(proto_perl->Ifdpid, param);
11487
11488     /* internal state */
11489     PL_tainting         = proto_perl->Itainting;
11490     PL_taint_warn       = proto_perl->Itaint_warn;
11491     PL_maxo             = proto_perl->Imaxo;
11492     if (proto_perl->Iop_mask)
11493         PL_op_mask      = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11494     else
11495         PL_op_mask      = Nullch;
11496     /* PL_asserting        = proto_perl->Iasserting; */
11497
11498     /* current interpreter roots */
11499     PL_main_cv          = cv_dup_inc(proto_perl->Imain_cv, param);
11500     PL_main_root        = OpREFCNT_inc(proto_perl->Imain_root);
11501     PL_main_start       = proto_perl->Imain_start;
11502     PL_eval_root        = proto_perl->Ieval_root;
11503     PL_eval_start       = proto_perl->Ieval_start;
11504
11505     /* runtime control stuff */
11506     PL_curcopdb         = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11507     PL_copline          = proto_perl->Icopline;
11508
11509     PL_filemode         = proto_perl->Ifilemode;
11510     PL_lastfd           = proto_perl->Ilastfd;
11511     PL_oldname          = proto_perl->Ioldname;         /* XXX not quite right */
11512     PL_Argv             = NULL;
11513     PL_Cmd              = Nullch;
11514     PL_gensym           = proto_perl->Igensym;
11515     PL_preambled        = proto_perl->Ipreambled;
11516     PL_preambleav       = av_dup_inc(proto_perl->Ipreambleav, param);
11517     PL_laststatval      = proto_perl->Ilaststatval;
11518     PL_laststype        = proto_perl->Ilaststype;
11519     PL_mess_sv          = Nullsv;
11520
11521     PL_ors_sv           = sv_dup_inc(proto_perl->Iors_sv, param);
11522
11523     /* interpreter atexit processing */
11524     PL_exitlistlen      = proto_perl->Iexitlistlen;
11525     if (PL_exitlistlen) {
11526         New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11527         Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11528     }
11529     else
11530         PL_exitlist     = (PerlExitListEntry*)NULL;
11531     PL_modglobal        = hv_dup_inc(proto_perl->Imodglobal, param);
11532     PL_custom_op_names  = hv_dup_inc(proto_perl->Icustom_op_names,param);
11533     PL_custom_op_descs  = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11534
11535     PL_profiledata      = NULL;
11536     PL_rsfp             = fp_dup(proto_perl->Irsfp, '<', param);
11537     /* PL_rsfp_filters entries have fake IoDIRP() */
11538     PL_rsfp_filters     = av_dup_inc(proto_perl->Irsfp_filters, param);
11539
11540     PL_compcv                   = cv_dup(proto_perl->Icompcv, param);
11541
11542     PAD_CLONE_VARS(proto_perl, param);
11543
11544 #ifdef HAVE_INTERP_INTERN
11545     sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11546 #endif
11547
11548     /* more statics moved here */
11549     PL_generation       = proto_perl->Igeneration;
11550     PL_DBcv             = cv_dup(proto_perl->IDBcv, param);
11551
11552     PL_in_clean_objs    = proto_perl->Iin_clean_objs;
11553     PL_in_clean_all     = proto_perl->Iin_clean_all;
11554
11555     PL_uid              = proto_perl->Iuid;
11556     PL_euid             = proto_perl->Ieuid;
11557     PL_gid              = proto_perl->Igid;
11558     PL_egid             = proto_perl->Iegid;
11559     PL_nomemok          = proto_perl->Inomemok;
11560     PL_an               = proto_perl->Ian;
11561     PL_evalseq          = proto_perl->Ievalseq;
11562     PL_origenviron      = proto_perl->Iorigenviron;     /* XXX not quite right */
11563     PL_origalen         = proto_perl->Iorigalen;
11564     PL_pidstatus        = newHV();                      /* XXX flag for cloning? */
11565     PL_osname           = SAVEPV(proto_perl->Iosname);
11566     PL_sh_path_compat   = proto_perl->Ish_path_compat; /* XXX never deallocated */
11567     PL_sighandlerp      = proto_perl->Isighandlerp;
11568
11569
11570     PL_runops           = proto_perl->Irunops;
11571
11572     Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11573
11574 #ifdef CSH
11575     PL_cshlen           = proto_perl->Icshlen;
11576     PL_cshname          = proto_perl->Icshname; /* XXX never deallocated */
11577 #endif
11578
11579     PL_lex_state        = proto_perl->Ilex_state;
11580     PL_lex_defer        = proto_perl->Ilex_defer;
11581     PL_lex_expect       = proto_perl->Ilex_expect;
11582     PL_lex_formbrack    = proto_perl->Ilex_formbrack;
11583     PL_lex_dojoin       = proto_perl->Ilex_dojoin;
11584     PL_lex_starts       = proto_perl->Ilex_starts;
11585     PL_lex_stuff        = sv_dup_inc(proto_perl->Ilex_stuff, param);
11586     PL_lex_repl         = sv_dup_inc(proto_perl->Ilex_repl, param);
11587     PL_lex_op           = proto_perl->Ilex_op;
11588     PL_lex_inpat        = proto_perl->Ilex_inpat;
11589     PL_lex_inwhat       = proto_perl->Ilex_inwhat;
11590     PL_lex_brackets     = proto_perl->Ilex_brackets;
11591     i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11592     PL_lex_brackstack   = SAVEPVN(proto_perl->Ilex_brackstack,i);
11593     PL_lex_casemods     = proto_perl->Ilex_casemods;
11594     i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11595     PL_lex_casestack    = SAVEPVN(proto_perl->Ilex_casestack,i);
11596
11597     Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11598     Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11599     PL_nexttoke         = proto_perl->Inexttoke;
11600
11601     /* XXX This is probably masking the deeper issue of why
11602      * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11603      * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11604      * (A little debugging with a watchpoint on it may help.)
11605      */
11606     if (SvANY(proto_perl->Ilinestr)) {
11607         PL_linestr              = sv_dup_inc(proto_perl->Ilinestr, param);
11608         i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11609         PL_bufptr               = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11610         i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11611         PL_oldbufptr    = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11612         i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11613         PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11614         i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11615         PL_linestart    = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11616     }
11617     else {
11618         PL_linestr = NEWSV(65,79);
11619         sv_upgrade(PL_linestr,SVt_PVIV);
11620         sv_setpvn(PL_linestr,"",0);
11621         PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11622     }
11623     PL_bufend           = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11624     PL_pending_ident    = proto_perl->Ipending_ident;
11625     PL_sublex_info      = proto_perl->Isublex_info;     /* XXX not quite right */
11626
11627     PL_expect           = proto_perl->Iexpect;
11628
11629     PL_multi_start      = proto_perl->Imulti_start;
11630     PL_multi_end        = proto_perl->Imulti_end;
11631     PL_multi_open       = proto_perl->Imulti_open;
11632     PL_multi_close      = proto_perl->Imulti_close;
11633
11634     PL_error_count      = proto_perl->Ierror_count;
11635     PL_subline          = proto_perl->Isubline;
11636     PL_subname          = sv_dup_inc(proto_perl->Isubname, param);
11637
11638     /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11639     if (SvANY(proto_perl->Ilinestr)) {
11640         i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11641         PL_last_uni             = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11642         i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11643         PL_last_lop             = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11644         PL_last_lop_op  = proto_perl->Ilast_lop_op;
11645     }
11646     else {
11647         PL_last_uni     = SvPVX(PL_linestr);
11648         PL_last_lop     = SvPVX(PL_linestr);
11649         PL_last_lop_op  = 0;
11650     }
11651     PL_in_my            = proto_perl->Iin_my;
11652     PL_in_my_stash      = hv_dup(proto_perl->Iin_my_stash, param);
11653 #ifdef FCRYPT
11654     PL_cryptseen        = proto_perl->Icryptseen;
11655 #endif
11656
11657     PL_hints            = proto_perl->Ihints;
11658
11659     PL_amagic_generation        = proto_perl->Iamagic_generation;
11660
11661 #ifdef USE_LOCALE_COLLATE
11662     PL_collation_ix     = proto_perl->Icollation_ix;
11663     PL_collation_name   = SAVEPV(proto_perl->Icollation_name);
11664     PL_collation_standard       = proto_perl->Icollation_standard;
11665     PL_collxfrm_base    = proto_perl->Icollxfrm_base;
11666     PL_collxfrm_mult    = proto_perl->Icollxfrm_mult;
11667 #endif /* USE_LOCALE_COLLATE */
11668
11669 #ifdef USE_LOCALE_NUMERIC
11670     PL_numeric_name     = SAVEPV(proto_perl->Inumeric_name);
11671     PL_numeric_standard = proto_perl->Inumeric_standard;
11672     PL_numeric_local    = proto_perl->Inumeric_local;
11673     PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11674 #endif /* !USE_LOCALE_NUMERIC */
11675
11676     /* utf8 character classes */
11677     PL_utf8_alnum       = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11678     PL_utf8_alnumc      = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11679     PL_utf8_ascii       = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11680     PL_utf8_alpha       = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11681     PL_utf8_space       = sv_dup_inc(proto_perl->Iutf8_space, param);
11682     PL_utf8_cntrl       = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11683     PL_utf8_graph       = sv_dup_inc(proto_perl->Iutf8_graph, param);
11684     PL_utf8_digit       = sv_dup_inc(proto_perl->Iutf8_digit, param);
11685     PL_utf8_upper       = sv_dup_inc(proto_perl->Iutf8_upper, param);
11686     PL_utf8_lower       = sv_dup_inc(proto_perl->Iutf8_lower, param);
11687     PL_utf8_print       = sv_dup_inc(proto_perl->Iutf8_print, param);
11688     PL_utf8_punct       = sv_dup_inc(proto_perl->Iutf8_punct, param);
11689     PL_utf8_xdigit      = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11690     PL_utf8_mark        = sv_dup_inc(proto_perl->Iutf8_mark, param);
11691     PL_utf8_toupper     = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11692     PL_utf8_totitle     = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11693     PL_utf8_tolower     = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11694     PL_utf8_tofold      = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11695     PL_utf8_idstart     = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11696     PL_utf8_idcont      = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11697
11698     /* Did the locale setup indicate UTF-8? */
11699     PL_utf8locale       = proto_perl->Iutf8locale;
11700     /* Unicode features (see perlrun/-C) */
11701     PL_unicode          = proto_perl->Iunicode;
11702
11703     /* Pre-5.8 signals control */
11704     PL_signals          = proto_perl->Isignals;
11705
11706     /* times() ticks per second */
11707     PL_clocktick        = proto_perl->Iclocktick;
11708
11709     /* Recursion stopper for PerlIO_find_layer */
11710     PL_in_load_module   = proto_perl->Iin_load_module;
11711
11712     /* sort() routine */
11713     PL_sort_RealCmp     = proto_perl->Isort_RealCmp;
11714
11715     /* Not really needed/useful since the reenrant_retint is "volatile",
11716      * but do it for consistency's sake. */
11717     PL_reentrant_retint = proto_perl->Ireentrant_retint;
11718
11719     /* Hooks to shared SVs and locks. */
11720     PL_sharehook        = proto_perl->Isharehook;
11721     PL_lockhook         = proto_perl->Ilockhook;
11722     PL_unlockhook       = proto_perl->Iunlockhook;
11723     PL_threadhook       = proto_perl->Ithreadhook;
11724
11725     PL_runops_std       = proto_perl->Irunops_std;
11726     PL_runops_dbg       = proto_perl->Irunops_dbg;
11727
11728 #ifdef THREADS_HAVE_PIDS
11729     PL_ppid             = proto_perl->Ippid;
11730 #endif
11731
11732     /* swatch cache */
11733     PL_last_swash_hv    = Nullhv;       /* reinits on demand */
11734     PL_last_swash_klen  = 0;
11735     PL_last_swash_key[0]= '\0';
11736     PL_last_swash_tmps  = (U8*)NULL;
11737     PL_last_swash_slen  = 0;
11738
11739     PL_glob_index       = proto_perl->Iglob_index;
11740     PL_srand_called     = proto_perl->Isrand_called;
11741     PL_uudmap['M']      = 0;            /* reinits on demand */
11742     PL_bitcount         = Nullch;       /* reinits on demand */
11743
11744     if (proto_perl->Ipsig_pend) {
11745         Newz(0, PL_psig_pend, SIG_SIZE, int);
11746     }
11747     else {
11748         PL_psig_pend    = (int*)NULL;
11749     }
11750
11751     if (proto_perl->Ipsig_ptr) {
11752         Newz(0, PL_psig_ptr,  SIG_SIZE, SV*);
11753         Newz(0, PL_psig_name, SIG_SIZE, SV*);
11754         for (i = 1; i < SIG_SIZE; i++) {
11755             PL_psig_ptr[i]  = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11756             PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11757         }
11758     }
11759     else {
11760         PL_psig_ptr     = (SV**)NULL;
11761         PL_psig_name    = (SV**)NULL;
11762     }
11763
11764     /* thrdvar.h stuff */
11765
11766     if (flags & CLONEf_COPY_STACKS) {
11767         /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11768         PL_tmps_ix              = proto_perl->Ttmps_ix;
11769         PL_tmps_max             = proto_perl->Ttmps_max;
11770         PL_tmps_floor           = proto_perl->Ttmps_floor;
11771         Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
11772         i = 0;
11773         while (i <= PL_tmps_ix) {
11774             PL_tmps_stack[i]    = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11775             ++i;
11776         }
11777
11778         /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11779         i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11780         Newz(54, PL_markstack, i, I32);
11781         PL_markstack_max        = PL_markstack + (proto_perl->Tmarkstack_max
11782                                                   - proto_perl->Tmarkstack);
11783         PL_markstack_ptr        = PL_markstack + (proto_perl->Tmarkstack_ptr
11784                                                   - proto_perl->Tmarkstack);
11785         Copy(proto_perl->Tmarkstack, PL_markstack,
11786              PL_markstack_ptr - PL_markstack + 1, I32);
11787
11788         /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11789          * NOTE: unlike the others! */
11790         PL_scopestack_ix        = proto_perl->Tscopestack_ix;
11791         PL_scopestack_max       = proto_perl->Tscopestack_max;
11792         Newz(54, PL_scopestack, PL_scopestack_max, I32);
11793         Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11794
11795         /* NOTE: si_dup() looks at PL_markstack */
11796         PL_curstackinfo         = si_dup(proto_perl->Tcurstackinfo, param);
11797
11798         /* PL_curstack          = PL_curstackinfo->si_stack; */
11799         PL_curstack             = av_dup(proto_perl->Tcurstack, param);
11800         PL_mainstack            = av_dup(proto_perl->Tmainstack, param);
11801
11802         /* next PUSHs() etc. set *(PL_stack_sp+1) */
11803         PL_stack_base           = AvARRAY(PL_curstack);
11804         PL_stack_sp             = PL_stack_base + (proto_perl->Tstack_sp
11805                                                    - proto_perl->Tstack_base);
11806         PL_stack_max            = PL_stack_base + AvMAX(PL_curstack);
11807
11808         /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11809          * NOTE: unlike the others! */
11810         PL_savestack_ix         = proto_perl->Tsavestack_ix;
11811         PL_savestack_max        = proto_perl->Tsavestack_max;
11812         /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
11813         PL_savestack            = ss_dup(proto_perl, param);
11814     }
11815     else {
11816         init_stacks();
11817         ENTER;                  /* perl_destruct() wants to LEAVE; */
11818     }
11819
11820     PL_start_env        = proto_perl->Tstart_env;       /* XXXXXX */
11821     PL_top_env          = &PL_start_env;
11822
11823     PL_op               = proto_perl->Top;
11824
11825     PL_Sv               = Nullsv;
11826     PL_Xpv              = (XPV*)NULL;
11827     PL_na               = proto_perl->Tna;
11828
11829     PL_statbuf          = proto_perl->Tstatbuf;
11830     PL_statcache        = proto_perl->Tstatcache;
11831     PL_statgv           = gv_dup(proto_perl->Tstatgv, param);
11832     PL_statname         = sv_dup_inc(proto_perl->Tstatname, param);
11833 #ifdef HAS_TIMES
11834     PL_timesbuf         = proto_perl->Ttimesbuf;
11835 #endif
11836
11837     PL_tainted          = proto_perl->Ttainted;
11838     PL_curpm            = proto_perl->Tcurpm;   /* XXX No PMOP ref count */
11839     PL_rs               = sv_dup_inc(proto_perl->Trs, param);
11840     PL_last_in_gv       = gv_dup(proto_perl->Tlast_in_gv, param);
11841     PL_ofs_sv           = sv_dup_inc(proto_perl->Tofs_sv, param);
11842     PL_defoutgv         = gv_dup_inc(proto_perl->Tdefoutgv, param);
11843     PL_chopset          = proto_perl->Tchopset; /* XXX never deallocated */
11844     PL_toptarget        = sv_dup_inc(proto_perl->Ttoptarget, param);
11845     PL_bodytarget       = sv_dup_inc(proto_perl->Tbodytarget, param);
11846     PL_formtarget       = sv_dup(proto_perl->Tformtarget, param);
11847
11848     PL_restartop        = proto_perl->Trestartop;
11849     PL_in_eval          = proto_perl->Tin_eval;
11850     PL_delaymagic       = proto_perl->Tdelaymagic;
11851     PL_dirty            = proto_perl->Tdirty;
11852     PL_localizing       = proto_perl->Tlocalizing;
11853
11854     PL_errors           = sv_dup_inc(proto_perl->Terrors, param);
11855     PL_hv_fetch_ent_mh  = Nullhe;
11856     PL_modcount         = proto_perl->Tmodcount;
11857     PL_lastgotoprobe    = Nullop;
11858     PL_dumpindent       = proto_perl->Tdumpindent;
11859
11860     PL_sortcop          = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11861     PL_sortstash        = hv_dup(proto_perl->Tsortstash, param);
11862     PL_firstgv          = gv_dup(proto_perl->Tfirstgv, param);
11863     PL_secondgv         = gv_dup(proto_perl->Tsecondgv, param);
11864     PL_sortcxix         = proto_perl->Tsortcxix;
11865     PL_efloatbuf        = Nullch;               /* reinits on demand */
11866     PL_efloatsize       = 0;                    /* reinits on demand */
11867
11868     /* regex stuff */
11869
11870     PL_screamfirst      = NULL;
11871     PL_screamnext       = NULL;
11872     PL_maxscream        = -1;                   /* reinits on demand */
11873     PL_lastscream       = Nullsv;
11874
11875     PL_watchaddr        = NULL;
11876     PL_watchok          = Nullch;
11877
11878     PL_regdummy         = proto_perl->Tregdummy;
11879     PL_regprecomp       = Nullch;
11880     PL_regnpar          = 0;
11881     PL_regsize          = 0;
11882     PL_colorset         = 0;            /* reinits PL_colors[] */
11883     /*PL_colors[6]      = {0,0,0,0,0,0};*/
11884     PL_reginput         = Nullch;
11885     PL_regbol           = Nullch;
11886     PL_regeol           = Nullch;
11887     PL_regstartp        = (I32*)NULL;
11888     PL_regendp          = (I32*)NULL;
11889     PL_reglastparen     = (U32*)NULL;
11890     PL_reglastcloseparen        = (U32*)NULL;
11891     PL_regtill          = Nullch;
11892     PL_reg_start_tmp    = (char**)NULL;
11893     PL_reg_start_tmpl   = 0;
11894     PL_regdata          = (struct reg_data*)NULL;
11895     PL_bostr            = Nullch;
11896     PL_reg_flags        = 0;
11897     PL_reg_eval_set     = 0;
11898     PL_regnarrate       = 0;
11899     PL_regprogram       = (regnode*)NULL;
11900     PL_regindent        = 0;
11901     PL_regcc            = (CURCUR*)NULL;
11902     PL_reg_call_cc      = (struct re_cc_state*)NULL;
11903     PL_reg_re           = (regexp*)NULL;
11904     PL_reg_ganch        = Nullch;
11905     PL_reg_sv           = Nullsv;
11906     PL_reg_match_utf8   = FALSE;
11907     PL_reg_magic        = (MAGIC*)NULL;
11908     PL_reg_oldpos       = 0;
11909     PL_reg_oldcurpm     = (PMOP*)NULL;
11910     PL_reg_curpm        = (PMOP*)NULL;
11911     PL_reg_oldsaved     = Nullch;
11912     PL_reg_oldsavedlen  = 0;
11913 #ifdef PERL_OLD_COPY_ON_WRITE
11914     PL_nrs              = Nullsv;
11915 #endif
11916     PL_reg_maxiter      = 0;
11917     PL_reg_leftiter     = 0;
11918     PL_reg_poscache     = Nullch;
11919     PL_reg_poscache_size= 0;
11920
11921     /* RE engine - function pointers */
11922     PL_regcompp         = proto_perl->Tregcompp;
11923     PL_regexecp         = proto_perl->Tregexecp;
11924     PL_regint_start     = proto_perl->Tregint_start;
11925     PL_regint_string    = proto_perl->Tregint_string;
11926     PL_regfree          = proto_perl->Tregfree;
11927
11928     PL_reginterp_cnt    = 0;
11929     PL_reg_starttry     = 0;
11930
11931     /* Pluggable optimizer */
11932     PL_peepp            = proto_perl->Tpeepp;
11933
11934     PL_stashcache       = newHV();
11935
11936     if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11937         ptr_table_free(PL_ptr_table);
11938         PL_ptr_table = NULL;
11939     }
11940
11941     /* Call the ->CLONE method, if it exists, for each of the stashes
11942        identified by sv_dup() above.
11943     */
11944     while(av_len(param->stashes) != -1) {
11945         HV* const stash = (HV*) av_shift(param->stashes);
11946         GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11947         if (cloner && GvCV(cloner)) {
11948             dSP;
11949             ENTER;
11950             SAVETMPS;
11951             PUSHMARK(SP);
11952             XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11953             PUTBACK;
11954             call_sv((SV*)GvCV(cloner), G_DISCARD);
11955             FREETMPS;
11956             LEAVE;
11957         }
11958     }
11959
11960     SvREFCNT_dec(param->stashes);
11961
11962     /* orphaned? eg threads->new inside BEGIN or use */
11963     if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11964         (void)SvREFCNT_inc(PL_compcv);
11965         SAVEFREESV(PL_compcv);
11966     }
11967
11968     return my_perl;
11969 }
11970
11971 #endif /* USE_ITHREADS */
11972
11973 /*
11974 =head1 Unicode Support
11975
11976 =for apidoc sv_recode_to_utf8
11977
11978 The encoding is assumed to be an Encode object, on entry the PV
11979 of the sv is assumed to be octets in that encoding, and the sv
11980 will be converted into Unicode (and UTF-8).
11981
11982 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11983 is not a reference, nothing is done to the sv.  If the encoding is not
11984 an C<Encode::XS> Encoding object, bad things will happen.
11985 (See F<lib/encoding.pm> and L<Encode>).
11986
11987 The PV of the sv is returned.
11988
11989 =cut */
11990
11991 char *
11992 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11993 {
11994     dVAR;
11995     if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11996         SV *uni;
11997         STRLEN len;
11998         const char *s;
11999         dSP;
12000         ENTER;
12001         SAVETMPS;
12002         save_re_context();
12003         PUSHMARK(sp);
12004         EXTEND(SP, 3);
12005         XPUSHs(encoding);
12006         XPUSHs(sv);
12007 /*
12008   NI-S 2002/07/09
12009   Passing sv_yes is wrong - it needs to be or'ed set of constants
12010   for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12011   remove converted chars from source.
12012
12013   Both will default the value - let them.
12014
12015         XPUSHs(&PL_sv_yes);
12016 */
12017         PUTBACK;
12018         call_method("decode", G_SCALAR);
12019         SPAGAIN;
12020         uni = POPs;
12021         PUTBACK;
12022         s = SvPV_const(uni, len);
12023         if (s != SvPVX_const(sv)) {
12024             SvGROW(sv, len + 1);
12025             Move(s, SvPVX(sv), len + 1, char);
12026             SvCUR_set(sv, len);
12027         }
12028         FREETMPS;
12029         LEAVE;
12030         SvUTF8_on(sv);
12031         return SvPVX(sv);
12032     }
12033     return SvPOKp(sv) ? SvPVX(sv) : NULL;
12034 }
12035
12036 /*
12037 =for apidoc sv_cat_decode
12038
12039 The encoding is assumed to be an Encode object, the PV of the ssv is
12040 assumed to be octets in that encoding and decoding the input starts
12041 from the position which (PV + *offset) pointed to.  The dsv will be
12042 concatenated the decoded UTF-8 string from ssv.  Decoding will terminate
12043 when the string tstr appears in decoding output or the input ends on
12044 the PV of the ssv. The value which the offset points will be modified
12045 to the last input position on the ssv.
12046
12047 Returns TRUE if the terminator was found, else returns FALSE.
12048
12049 =cut */
12050
12051 bool
12052 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12053                    SV *ssv, int *offset, char *tstr, int tlen)
12054 {
12055     dVAR;
12056     bool ret = FALSE;
12057     if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12058         SV *offsv;
12059         dSP;
12060         ENTER;
12061         SAVETMPS;
12062         save_re_context();
12063         PUSHMARK(sp);
12064         EXTEND(SP, 6);
12065         XPUSHs(encoding);
12066         XPUSHs(dsv);
12067         XPUSHs(ssv);
12068         XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12069         XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12070         PUTBACK;
12071         call_method("cat_decode", G_SCALAR);
12072         SPAGAIN;
12073         ret = SvTRUE(TOPs);
12074         *offset = SvIV(offsv);
12075         PUTBACK;
12076         FREETMPS;
12077         LEAVE;
12078     }
12079     else
12080         Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12081     return ret;
12082 }
12083
12084 /*
12085  * Local variables:
12086  * c-indentation-style: bsd
12087  * c-basic-offset: 4
12088  * indent-tabs-mode: t
12089  * End:
12090  *
12091  * ex: set ts=8 sts=4 sw=4 noet:
12092  */