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