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