sv.c

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