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, 2006, 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 /* if adding more checks watch out for the following tests:
  34  *   t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
  35  *   lib/utf8.t lib/Unicode/Collate/t/index.t
  36  * --jhi
  37  */
  38 #   define ASSERT_UTF8_CACHE(cache) \
  39     STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
  40                               assert((cache)[2] <= (cache)[3]); \
  41                               assert((cache)[3] <= (cache)[1]);} \
  42                               } STMT_END
  43 #else
  44 #   define ASSERT_UTF8_CACHE(cache) NOOP
  45 #endif
  46
  47 #ifdef PERL_OLD_COPY_ON_WRITE
  48 #define SV_COW_NEXT_SV(sv)      INT2PTR(SV *,SvUVX(sv))
  49 #define SV_COW_NEXT_SV_SET(current,next)        SvUV_set(current, PTR2UV(next))
  50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
  51    on-write.  */
  52 #endif
  53
  54 /* ============================================================================
  55
  56 =head1 Allocation and deallocation of SVs.
  57
  58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
  59 sv, av, hv...) contains type and reference count information, and for
  60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
  61 contains fields specific to each type.  Some types store all they need
  62 in the head, so don't have a body.
  63
  64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
  65 and bodies are allocated out of arenas, which by default are
  66 approximately 4K chunks of memory parcelled up into N heads or bodies.
  67 Sv-bodies are allocated by their sv-type, guaranteeing size
  68 consistency needed to allocate safely from arrays.
  69
  70 For SV-heads, the first slot in each arena is reserved, and holds a
  71 link to the next arena, some flags, and a note of the number of slots.
  72 Snaked through each arena chain is a linked list of free items; when
  73 this becomes empty, an extra arena is allocated and divided up into N
  74 items which are threaded into the free list.
  75
  76 SV-bodies are similar, but they use arena-sets by default, which
  77 separate the link and info from the arena itself, and reclaim the 1st
  78 slot in the arena.  SV-bodies are further described later.
  79
  80 The following global variables are associated with arenas:
  81
  82     PL_sv_arenaroot     pointer to list of SV arenas
  83     PL_sv_root          pointer to list of free SV structures
  84
  85     PL_body_arenas      head of linked-list of body arenas
  86     PL_body_roots[]     array of pointers to list of free bodies of svtype
  87                         arrays are indexed by the svtype needed
  88
  89 A few special SV heads are not allocated from an arena, but are
  90 instead directly created in the interpreter structure, eg PL_sv_undef.
  91 The size of arenas can be changed from the default by setting
  92 PERL_ARENA_SIZE appropriately at compile time.
  93
  94 The SV arena serves the secondary purpose of allowing still-live SVs
  95 to be located and destroyed during final cleanup.
  96
  97 At the lowest level, the macros new_SV() and del_SV() grab and free
  98 an SV head.  (If debugging with -DD, del_SV() calls the function S_del_sv()
  99 to return the SV to the free list with error checking.) new_SV() calls
 100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
 101 SVs in the free list have their SvTYPE field set to all ones.
 102
 103 At the time of very final cleanup, sv_free_arenas() is called from
 104 perl_destruct() to physically free all the arenas allocated since the
 105 start of the interpreter.
 106
 107 Manipulation of any of the PL_*root pointers is protected by enclosing
 108 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
 109 if threads are enabled.
 110
 111 The function visit() scans the SV arenas list, and calls a specified
 112 function for each SV it finds which is still live - ie which has an SvTYPE
 113 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
 114 following functions (specified as [function that calls visit()] / [function
 115 called by visit() for each SV]):
 116
 117     sv_report_used() / do_report_used()
 118                         dump all remaining SVs (debugging aid)
 119
 120     sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
 121                         Attempt to free all objects pointed to by RVs,
 122                         and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
 123                         try to do the same for all objects indirectly
 124                         referenced by typeglobs too.  Called once from
 125                         perl_destruct(), prior to calling sv_clean_all()
 126                         below.
 127
 128     sv_clean_all() / do_clean_all()
 129                         SvREFCNT_dec(sv) each remaining SV, possibly
 130                         triggering an sv_free(). It also sets the
 131                         SVf_BREAK flag on the SV to indicate that the
 132                         refcnt has been artificially lowered, and thus
 133                         stopping sv_free() from giving spurious warnings
 134                         about SVs which unexpectedly have a refcnt
 135                         of zero.  called repeatedly from perl_destruct()
 136                         until there are no SVs left.
 137
 138 =head2 Arena allocator API Summary
 139
 140 Private API to rest of sv.c
 141
 142     new_SV(),  del_SV(),
 143
 144     new_XIV(), del_XIV(),
 145     new_XNV(), del_XNV(),
 146     etc
 147
 148 Public API:
 149
 150     sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
 151
 152 =cut
 153
 154 ============================================================================ */
 155
 156 /*
 157  * "A time to plant, and a time to uproot what was planted..."
 158  */
 159
 160 /*
 161  * nice_chunk and nice_chunk size need to be set
 162  * and queried under the protection of sv_mutex
 163  */
 164 void
 165 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
 166 {
 167     dVAR;
 168     void *new_chunk;
 169     U32 new_chunk_size;
 170     LOCK_SV_MUTEX;
 171     new_chunk = (void *)(chunk);
 172     new_chunk_size = (chunk_size);
 173     if (new_chunk_size > PL_nice_chunk_size) {
 174         Safefree(PL_nice_chunk);
 175         PL_nice_chunk = (char *) new_chunk;
 176         PL_nice_chunk_size = new_chunk_size;
 177     } else {
 178         Safefree(chunk);
 179     }
 180     UNLOCK_SV_MUTEX;
 181 }
 182
 183 #ifdef DEBUG_LEAKING_SCALARS
 184 #  define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
 185 #else
 186 #  define FREE_SV_DEBUG_FILE(sv)
 187 #endif
 188
 189 #ifdef PERL_POISON
 190 #  define SvARENA_CHAIN(sv)     ((sv)->sv_u.svu_rv)
 191 /* Whilst I'd love to do this, it seems that things like to check on
 192    unreferenced scalars
 193 #  define POSION_SV_HEAD(sv)    PoisonNew(sv, 1, struct STRUCT_SV)
 194 */
 195 #  define POSION_SV_HEAD(sv)    PoisonNew(&SvANY(sv), 1, void *), \
 196                                 PoisonNew(&SvREFCNT(sv), 1, U32)
 197 #else
 198 #  define SvARENA_CHAIN(sv)     SvANY(sv)
 199 #  define POSION_SV_HEAD(sv)
 200 #endif
 201
 202 #define plant_SV(p) \
 203     STMT_START {                                        \
 204         FREE_SV_DEBUG_FILE(p);                          \
 205         POSION_SV_HEAD(p);                              \
 206         SvARENA_CHAIN(p) = (void *)PL_sv_root;          \
 207         SvFLAGS(p) = SVTYPEMASK;                        \
 208         PL_sv_root = (p);                               \
 209         --PL_sv_count;                                  \
 210     } STMT_END
 211
 212 /* sv_mutex must be held while calling uproot_SV() */
 213 #define uproot_SV(p) \
 214     STMT_START {                                        \
 215         (p) = PL_sv_root;                               \
 216         PL_sv_root = (SV*)SvARENA_CHAIN(p);             \
 217         ++PL_sv_count;                                  \
 218     } STMT_END
 219
 220
 221 /* make some more SVs by adding another arena */
 222
 223 /* sv_mutex must be held while calling more_sv() */
 224 STATIC SV*
 225 S_more_sv(pTHX)
 226 {
 227     dVAR;
 228     SV* sv;
 229
 230     if (PL_nice_chunk) {
 231         sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
 232         PL_nice_chunk = NULL;
 233         PL_nice_chunk_size = 0;
 234     }
 235     else {
 236         char *chunk;                /* must use New here to match call to */
 237         Newx(chunk,PERL_ARENA_SIZE,char);  /* Safefree() in sv_free_arenas() */
 238         sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
 239     }
 240     uproot_SV(sv);
 241     return sv;
 242 }
 243
 244 /* new_SV(): return a new, empty SV head */
 245
 246 #ifdef DEBUG_LEAKING_SCALARS
 247 /* provide a real function for a debugger to play with */
 248 STATIC SV*
 249 S_new_SV(pTHX)
 250 {
 251     SV* sv;
 252
 253     LOCK_SV_MUTEX;
 254     if (PL_sv_root)
 255         uproot_SV(sv);
 256     else
 257         sv = S_more_sv(aTHX);
 258     UNLOCK_SV_MUTEX;
 259     SvANY(sv) = 0;
 260     SvREFCNT(sv) = 1;
 261     SvFLAGS(sv) = 0;
 262     sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
 263     sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
 264         (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
 265     sv->sv_debug_inpad = 0;
 266     sv->sv_debug_cloned = 0;
 267     sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
 268
 269     return sv;
 270 }
 271 #  define new_SV(p) (p)=S_new_SV(aTHX)
 272
 273 #else
 274 #  define new_SV(p) \
 275     STMT_START {                                        \
 276         LOCK_SV_MUTEX;                                  \
 277         if (PL_sv_root)                                 \
 278             uproot_SV(p);                               \
 279         else                                            \
 280             (p) = S_more_sv(aTHX);                      \
 281         UNLOCK_SV_MUTEX;                                \
 282         SvANY(p) = 0;                                   \
 283         SvREFCNT(p) = 1;                                \
 284         SvFLAGS(p) = 0;                                 \
 285     } STMT_END
 286 #endif
 287
 288
 289 /* del_SV(): return an empty SV head to the free list */
 290
 291 #ifdef DEBUGGING
 292
 293 #define del_SV(p) \
 294     STMT_START {                                        \
 295         LOCK_SV_MUTEX;                                  \
 296         if (DEBUG_D_TEST)                               \
 297             del_sv(p);                                  \
 298         else                                            \
 299             plant_SV(p);                                \
 300         UNLOCK_SV_MUTEX;                                \
 301     } STMT_END
 302
 303 STATIC void
 304 S_del_sv(pTHX_ SV *p)
 305 {
 306     dVAR;
 307     if (DEBUG_D_TEST) {
 308         SV* sva;
 309         bool ok = 0;
 310         for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
 311             const SV * const sv = sva + 1;
 312             const SV * const svend = &sva[SvREFCNT(sva)];
 313             if (p >= sv && p < svend) {
 314                 ok = 1;
 315                 break;
 316             }
 317         }
 318         if (!ok) {
 319             if (ckWARN_d(WARN_INTERNAL))
 320                 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
 321                             "Attempt to free non-arena SV: 0x%"UVxf
 322                             pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
 323             return;
 324         }
 325     }
 326     plant_SV(p);
 327 }
 328
 329 #else /* ! DEBUGGING */
 330
 331 #define del_SV(p)   plant_SV(p)
 332
 333 #endif /* DEBUGGING */
 334
 335
 336 /*
 337 =head1 SV Manipulation Functions
 338
 339 =for apidoc sv_add_arena
 340
 341 Given a chunk of memory, link it to the head of the list of arenas,
 342 and split it into a list of free SVs.
 343
 344 =cut
 345 */
 346
 347 void
 348 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
 349 {
 350     dVAR;
 351     SV* const sva = (SV*)ptr;
 352     register SV* sv;
 353     register SV* svend;
 354
 355     /* The first SV in an arena isn't an SV. */
 356     SvANY(sva) = (void *) PL_sv_arenaroot;              /* ptr to next arena */
 357     SvREFCNT(sva) = size / sizeof(SV);          /* number of SV slots */
 358     SvFLAGS(sva) = flags;                       /* FAKE if not to be freed */
 359
 360     PL_sv_arenaroot = sva;
 361     PL_sv_root = sva + 1;
 362
 363     svend = &sva[SvREFCNT(sva) - 1];
 364     sv = sva + 1;
 365     while (sv < svend) {
 366         SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
 367 #ifdef DEBUGGING
 368         SvREFCNT(sv) = 0;
 369 #endif
 370         /* Must always set typemask because it's awlays checked in on cleanup
 371            when the arenas are walked looking for objects.  */
 372         SvFLAGS(sv) = SVTYPEMASK;
 373         sv++;
 374     }
 375     SvARENA_CHAIN(sv) = 0;
 376 #ifdef DEBUGGING
 377     SvREFCNT(sv) = 0;
 378 #endif
 379     SvFLAGS(sv) = SVTYPEMASK;
 380 }
 381
 382 /* visit(): call the named function for each non-free SV in the arenas
 383  * whose flags field matches the flags/mask args. */
 384
 385 STATIC I32
 386 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
 387 {
 388     dVAR;
 389     SV* sva;
 390     I32 visited = 0;
 391
 392     for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
 393         register const SV * const svend = &sva[SvREFCNT(sva)];
 394         register SV* sv;
 395         for (sv = sva + 1; sv < svend; ++sv) {
 396             if (SvTYPE(sv) != SVTYPEMASK
 397                     && (sv->sv_flags & mask) == flags
 398                     && SvREFCNT(sv))
 399             {
 400                 (FCALL)(aTHX_ sv);
 401                 ++visited;
 402             }
 403         }
 404     }
 405     return visited;
 406 }
 407
 408 #ifdef DEBUGGING
 409
 410 /* called by sv_report_used() for each live SV */
 411
 412 static void
 413 do_report_used(pTHX_ SV *sv)
 414 {
 415     if (SvTYPE(sv) != SVTYPEMASK) {
 416         PerlIO_printf(Perl_debug_log, "****\n");
 417         sv_dump(sv);
 418     }
 419 }
 420 #endif
 421
 422 /*
 423 =for apidoc sv_report_used
 424
 425 Dump the contents of all SVs not yet freed. (Debugging aid).
 426
 427 =cut
 428 */
 429
 430 void
 431 Perl_sv_report_used(pTHX)
 432 {
 433 #ifdef DEBUGGING
 434     visit(do_report_used, 0, 0);
 435 #else
 436     PERL_UNUSED_CONTEXT;
 437 #endif
 438 }
 439
 440 /* called by sv_clean_objs() for each live SV */
 441
 442 static void
 443 do_clean_objs(pTHX_ SV *ref)
 444 {
 445     dVAR;
 446     if (SvROK(ref)) {
 447         SV * const target = SvRV(ref);
 448         if (SvOBJECT(target)) {
 449             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
 450             if (SvWEAKREF(ref)) {
 451                 sv_del_backref(target, ref);
 452                 SvWEAKREF_off(ref);
 453                 SvRV_set(ref, NULL);
 454             } else {
 455                 SvROK_off(ref);
 456                 SvRV_set(ref, NULL);
 457                 SvREFCNT_dec(target);
 458             }
 459         }
 460     }
 461
 462     /* XXX Might want to check arrays, etc. */
 463 }
 464
 465 /* called by sv_clean_objs() for each live SV */
 466
 467 #ifndef DISABLE_DESTRUCTOR_KLUDGE
 468 static void
 469 do_clean_named_objs(pTHX_ SV *sv)
 470 {
 471     dVAR;
 472     if (SvTYPE(sv) == SVt_PVGV && isGV_with_GP(sv) && GvGP(sv)) {
 473         if ((
 474 #ifdef PERL_DONT_CREATE_GVSV
 475              GvSV(sv) &&
 476 #endif
 477              SvOBJECT(GvSV(sv))) ||
 478              (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
 479              (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
 480              (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
 481              (GvCV(sv) && SvOBJECT(GvCV(sv))) )
 482         {
 483             DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
 484             SvFLAGS(sv) |= SVf_BREAK;
 485             SvREFCNT_dec(sv);
 486         }
 487     }
 488 }
 489 #endif
 490
 491 /*
 492 =for apidoc sv_clean_objs
 493
 494 Attempt to destroy all objects not yet freed
 495
 496 =cut
 497 */
 498
 499 void
 500 Perl_sv_clean_objs(pTHX)
 501 {
 502     dVAR;
 503     PL_in_clean_objs = TRUE;
 504     visit(do_clean_objs, SVf_ROK, SVf_ROK);
 505 #ifndef DISABLE_DESTRUCTOR_KLUDGE
 506     /* some barnacles may yet remain, clinging to typeglobs */
 507     visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
 508 #endif
 509     PL_in_clean_objs = FALSE;
 510 }
 511
 512 /* called by sv_clean_all() for each live SV */
 513
 514 static void
 515 do_clean_all(pTHX_ SV *sv)
 516 {
 517     dVAR;
 518     DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
 519     SvFLAGS(sv) |= SVf_BREAK;
 520     if (PL_comppad == (AV*)sv) {
 521         PL_comppad = NULL;
 522         PL_curpad = NULL;
 523     }
 524     SvREFCNT_dec(sv);
 525 }
 526
 527 /*
 528 =for apidoc sv_clean_all
 529
 530 Decrement the refcnt of each remaining SV, possibly triggering a
 531 cleanup. This function may have to be called multiple times to free
 532 SVs which are in complex self-referential hierarchies.
 533
 534 =cut
 535 */
 536
 537 I32
 538 Perl_sv_clean_all(pTHX)
 539 {
 540     dVAR;
 541     I32 cleaned;
 542     PL_in_clean_all = TRUE;
 543     cleaned = visit(do_clean_all, 0,0);
 544     PL_in_clean_all = FALSE;
 545     return cleaned;
 546 }
 547
 548 /*
 549   ARENASETS: a meta-arena implementation which separates arena-info
 550   into struct arena_set, which contains an array of struct
 551   arena_descs, each holding info for a single arena.  By separating
 552   the meta-info from the arena, we recover the 1st slot, formerly
 553   borrowed for list management.  The arena_set is about the size of an
 554   arena, avoiding the needless malloc overhead of a naive linked-list
 555
 556   The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
 557   memory in the last arena-set (1/2 on average).  In trade, we get
 558   back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
 559   smaller types).  The recovery of the wasted space allows use of
 560   small arenas for large, rare body types,
 561 */
 562 struct arena_desc {
 563     char       *arena;          /* the raw storage, allocated aligned */
 564     size_t      size;           /* its size ~4k typ */
 565     int         unit_type;      /* useful for arena audits */
 566     /* info for sv-heads (eventually)
 567        int count, flags;
 568     */
 569 };
 570
 571 struct arena_set;
 572
 573 /* Get the maximum number of elements in set[] such that struct arena_set
 574    will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
 575    therefore likely to be 1 aligned memory page.  */
 576
 577 #define ARENAS_PER_SET  ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
 578                           - 2 * sizeof(int)) / sizeof (struct arena_desc))
 579
 580 struct arena_set {
 581     struct arena_set* next;
 582     int   set_size;             /* ie ARENAS_PER_SET */
 583     int   curr;                 /* index of next available arena-desc */
 584     struct arena_desc set[ARENAS_PER_SET];
 585 };
 586
 587 /*
 588 =for apidoc sv_free_arenas
 589
 590 Deallocate the memory used by all arenas. Note that all the individual SV
 591 heads and bodies within the arenas must already have been freed.
 592
 593 =cut
 594 */
 595 void
 596 Perl_sv_free_arenas(pTHX)
 597 {
 598     dVAR;
 599     SV* sva;
 600     SV* svanext;
 601     int i;
 602
 603     /* Free arenas here, but be careful about fake ones.  (We assume
 604        contiguity of the fake ones with the corresponding real ones.) */
 605
 606     for (sva = PL_sv_arenaroot; sva; sva = svanext) {
 607         svanext = (SV*) SvANY(sva);
 608         while (svanext && SvFAKE(svanext))
 609             svanext = (SV*) SvANY(svanext);
 610
 611         if (!SvFAKE(sva))
 612             Safefree(sva);
 613     }
 614
 615     {
 616         struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
 617
 618         for (; aroot; aroot = next) {
 619             const int max = aroot->curr;
 620             for (i=0; i<max; i++) {
 621                 assert(aroot->set[i].arena);
 622                 Safefree(aroot->set[i].arena);
 623             }
 624             next = aroot->next;
 625             Safefree(aroot);
 626         }
 627     }
 628     PL_body_arenas = 0;
 629
 630     for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
 631         PL_body_roots[i] = 0;
 632
 633     Safefree(PL_nice_chunk);
 634     PL_nice_chunk = NULL;
 635     PL_nice_chunk_size = 0;
 636     PL_sv_arenaroot = 0;
 637     PL_sv_root = 0;
 638 }
 639
 640 /*
 641   Here are mid-level routines that manage the allocation of bodies out
 642   of the various arenas.  There are 5 kinds of arenas:
 643
 644   1. SV-head arenas, which are discussed and handled above
 645   2. regular body arenas
 646   3. arenas for reduced-size bodies
 647   4. Hash-Entry arenas
 648   5. pte arenas (thread related)
 649
 650   Arena types 2 & 3 are chained by body-type off an array of
 651   arena-root pointers, which is indexed by svtype.  Some of the
 652   larger/less used body types are malloced singly, since a large
 653   unused block of them is wasteful.  Also, several svtypes dont have
 654   bodies; the data fits into the sv-head itself.  The arena-root
 655   pointer thus has a few unused root-pointers (which may be hijacked
 656   later for arena types 4,5)
 657
 658   3 differs from 2 as an optimization; some body types have several
 659   unused fields in the front of the structure (which are kept in-place
 660   for consistency).  These bodies can be allocated in smaller chunks,
 661   because the leading fields arent accessed.  Pointers to such bodies
 662   are decremented to point at the unused 'ghost' memory, knowing that
 663   the pointers are used with offsets to the real memory.
 664
 665   HE, HEK arenas are managed separately, with separate code, but may
 666   be merge-able later..
 667
 668   PTE arenas are not sv-bodies, but they share these mid-level
 669   mechanics, so are considered here.  The new mid-level mechanics rely
 670   on the sv_type of the body being allocated, so we just reserve one
 671   of the unused body-slots for PTEs, then use it in those (2) PTE
 672   contexts below (line ~10k)
 673 */
 674
 675 /* get_arena(size): this creates custom-sized arenas
 676    TBD: export properly for hv.c: S_more_he().
 677 */
 678 void*
 679 Perl_get_arena(pTHX_ int arena_size)
 680 {
 681     dVAR;
 682     struct arena_desc* adesc;
 683     struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
 684     int curr;
 685
 686     /* shouldnt need this
 687     if (!arena_size)    arena_size = PERL_ARENA_SIZE;
 688     */
 689
 690     /* may need new arena-set to hold new arena */
 691     if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
 692         Newxz(newroot, 1, struct arena_set);
 693         newroot->set_size = ARENAS_PER_SET;
 694         newroot->next = *aroot;
 695         *aroot = newroot;
 696         DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)*aroot));
 697     }
 698
 699     /* ok, now have arena-set with at least 1 empty/available arena-desc */
 700     curr = (*aroot)->curr++;
 701     adesc = &((*aroot)->set[curr]);
 702     assert(!adesc->arena);
 703
 704     Newxz(adesc->arena, arena_size, char);
 705     adesc->size = arena_size;
 706     DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
 707                           curr, adesc->arena, arena_size));
 708
 709     return adesc->arena;
 710 }
 711
 712
 713 /* return a thing to the free list */
 714
 715 #define del_body(thing, root)                   \
 716     STMT_START {                                \
 717         void ** const thing_copy = (void **)thing;\
 718         LOCK_SV_MUTEX;                          \
 719         *thing_copy = *root;                    \
 720         *root = (void*)thing_copy;              \
 721         UNLOCK_SV_MUTEX;                        \
 722     } STMT_END
 723
 724 /*
 725
 726 =head1 SV-Body Allocation
 727
 728 Allocation of SV-bodies is similar to SV-heads, differing as follows;
 729 the allocation mechanism is used for many body types, so is somewhat
 730 more complicated, it uses arena-sets, and has no need for still-live
 731 SV detection.
 732
 733 At the outermost level, (new|del)_X*V macros return bodies of the
 734 appropriate type.  These macros call either (new|del)_body_type or
 735 (new|del)_body_allocated macro pairs, depending on specifics of the
 736 type.  Most body types use the former pair, the latter pair is used to
 737 allocate body types with "ghost fields".
 738
 739 "ghost fields" are fields that are unused in certain types, and
 740 consequently dont need to actually exist.  They are declared because
 741 they're part of a "base type", which allows use of functions as
 742 methods.  The simplest examples are AVs and HVs, 2 aggregate types
 743 which don't use the fields which support SCALAR semantics.
 744
 745 For these types, the arenas are carved up into *_allocated size
 746 chunks, we thus avoid wasted memory for those unaccessed members.
 747 When bodies are allocated, we adjust the pointer back in memory by the
 748 size of the bit not allocated, so it's as if we allocated the full
 749 structure.  (But things will all go boom if you write to the part that
 750 is "not there", because you'll be overwriting the last members of the
 751 preceding structure in memory.)
 752
 753 We calculate the correction using the STRUCT_OFFSET macro. For
 754 example, if xpv_allocated is the same structure as XPV then the two
 755 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
 756 structure is smaller (no initial NV actually allocated) then the net
 757 effect is to subtract the size of the NV from the pointer, to return a
 758 new pointer as if an initial NV were actually allocated.
 759
 760 This is the same trick as was used for NV and IV bodies. Ironically it
 761 doesn't need to be used for NV bodies any more, because NV is now at
 762 the start of the structure. IV bodies don't need it either, because
 763 they are no longer allocated.
 764
 765 In turn, the new_body_* allocators call S_new_body(), which invokes
 766 new_body_inline macro, which takes a lock, and takes a body off the
 767 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
 768 necessary to refresh an empty list.  Then the lock is released, and
 769 the body is returned.
 770
 771 S_more_bodies calls get_arena(), and carves it up into an array of N
 772 bodies, which it strings into a linked list.  It looks up arena-size
 773 and body-size from the body_details table described below, thus
 774 supporting the multiple body-types.
 775
 776 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
 777 the (new|del)_X*V macros are mapped directly to malloc/free.
 778
 779 */
 780
 781 /*
 782
 783 For each sv-type, struct body_details bodies_by_type[] carries
 784 parameters which control these aspects of SV handling:
 785
 786 Arena_size determines whether arenas are used for this body type, and if
 787 so, how big they are.  PURIFY or PERL_ARENA_SIZE=0 set this field to
 788 zero, forcing individual mallocs and frees.
 789
 790 Body_size determines how big a body is, and therefore how many fit into
 791 each arena.  Offset carries the body-pointer adjustment needed for
 792 *_allocated body types, and is used in *_allocated macros.
 793
 794 But its main purpose is to parameterize info needed in
 795 Perl_sv_upgrade().  The info here dramatically simplifies the function
 796 vs the implementation in 5.8.7, making it table-driven.  All fields
 797 are used for this, except for arena_size.
 798
 799 For the sv-types that have no bodies, arenas are not used, so those
 800 PL_body_roots[sv_type] are unused, and can be overloaded.  In
 801 something of a special case, SVt_NULL is borrowed for HE arenas;
 802 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
 803 bodies_by_type[SVt_NULL] slot is not used, as the table is not
 804 available in hv.c,
 805
 806 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
 807 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
 808 they can just use the same allocation semantics.  At first, PTEs were
 809 also overloaded to a non-body sv-type, but this yielded hard-to-find
 810 malloc bugs, so was simplified by claiming a new slot.  This choice
 811 has no consequence at this time.
 812
 813 */
 814
 815 struct body_details {
 816     U8 body_size;       /* Size to allocate  */
 817     U8 copy;            /* Size of structure to copy (may be shorter)  */
 818     U8 offset;
 819     unsigned int type : 4;          /* We have space for a sanity check.  */
 820     unsigned int cant_upgrade : 1;  /* Cannot upgrade this type */
 821     unsigned int zero_nv : 1;       /* zero the NV when upgrading from this */
 822     unsigned int arena : 1;         /* Allocated from an arena */
 823     size_t arena_size;              /* Size of arena to allocate */
 824 };
 825
 826 #define HADNV FALSE
 827 #define NONV TRUE
 828
 829
 830 #ifdef PURIFY
 831 /* With -DPURFIY we allocate everything directly, and don't use arenas.
 832    This seems a rather elegant way to simplify some of the code below.  */
 833 #define HASARENA FALSE
 834 #else
 835 #define HASARENA TRUE
 836 #endif
 837 #define NOARENA FALSE
 838
 839 /* Size the arenas to exactly fit a given number of bodies.  A count
 840    of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
 841    simplifying the default.  If count > 0, the arena is sized to fit
 842    only that many bodies, allowing arenas to be used for large, rare
 843    bodies (XPVFM, XPVIO) without undue waste.  The arena size is
 844    limited by PERL_ARENA_SIZE, so we can safely oversize the
 845    declarations.
 846  */
 847 #define FIT_ARENA0(body_size)                           \
 848     ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
 849 #define FIT_ARENAn(count,body_size)                     \
 850     ( count * body_size <= PERL_ARENA_SIZE)             \
 851     ? count * body_size                                 \
 852     : FIT_ARENA0 (body_size)
 853 #define FIT_ARENA(count,body_size)                      \
 854     count                                               \
 855     ? FIT_ARENAn (count, body_size)                     \
 856     : FIT_ARENA0 (body_size)
 857
 858 /* A macro to work out the offset needed to subtract from a pointer to (say)
 859
 860 typedef struct {
 861     STRLEN      xpv_cur;
 862     STRLEN      xpv_len;
 863 } xpv_allocated;
 864
 865 to make its members accessible via a pointer to (say)
 866
 867 struct xpv {
 868     NV          xnv_nv;
 869     STRLEN      xpv_cur;
 870     STRLEN      xpv_len;
 871 };
 872
 873 */
 874
 875 #define relative_STRUCT_OFFSET(longer, shorter, member) \
 876     (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
 877
 878 /* Calculate the length to copy. Specifically work out the length less any
 879    final padding the compiler needed to add.  See the comment in sv_upgrade
 880    for why copying the padding proved to be a bug.  */
 881
 882 #define copy_length(type, last_member) \
 883         STRUCT_OFFSET(type, last_member) \
 884         + sizeof (((type*)SvANY((SV*)0))->last_member)
 885
 886 static const struct body_details bodies_by_type[] = {
 887     { sizeof(HE), 0, 0, SVt_NULL,
 888       FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
 889
 890     /* IVs are in the head, so the allocation size is 0.
 891        However, the slot is overloaded for PTEs.  */
 892     { sizeof(struct ptr_tbl_ent), /* This is used for PTEs.  */
 893       sizeof(IV), /* This is used to copy out the IV body.  */
 894       STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
 895       NOARENA /* IVS don't need an arena  */,
 896       /* But PTEs need to know the size of their arena  */
 897       FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
 898     },
 899
 900     /* 8 bytes on most ILP32 with IEEE doubles */
 901     { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
 902       FIT_ARENA(0, sizeof(NV)) },
 903
 904     /* RVs are in the head now.  */
 905     { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
 906
 907     /* 8 bytes on most ILP32 with IEEE doubles */
 908     { sizeof(xpv_allocated),
 909       copy_length(XPV, xpv_len)
 910       - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
 911       + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
 912       SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
 913
 914     /* 12 */
 915     { sizeof(xpviv_allocated),
 916       copy_length(XPVIV, xiv_u)
 917       - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
 918       + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
 919       SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
 920
 921     /* 20 */
 922     { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
 923       HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
 924
 925     /* 28 */
 926     { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
 927       HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
 928
 929     /* 36 */
 930     { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
 931       HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
 932
 933     /* 48 */
 934     { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
 935       HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
 936
 937     /* 64 */
 938     { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
 939       HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
 940
 941     { sizeof(xpvav_allocated),
 942       copy_length(XPVAV, xmg_stash)
 943       - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
 944       + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
 945       SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
 946
 947     { sizeof(xpvhv_allocated),
 948       copy_length(XPVHV, xmg_stash)
 949       - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
 950       + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
 951       SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
 952
 953     /* 56 */
 954     { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
 955       + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
 956       SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
 957
 958     { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
 959       + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
 960       SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
 961
 962     /* XPVIO is 84 bytes, fits 48x */
 963     { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
 964       HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
 965 };
 966
 967 #define new_body_type(sv_type)          \
 968     (void *)((char *)S_new_body(aTHX_ sv_type))
 969
 970 #define del_body_type(p, sv_type)       \
 971     del_body(p, &PL_body_roots[sv_type])
 972
 973
 974 #define new_body_allocated(sv_type)             \
 975     (void *)((char *)S_new_body(aTHX_ sv_type)  \
 976              - bodies_by_type[sv_type].offset)
 977
 978 #define del_body_allocated(p, sv_type)          \
 979     del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
 980
 981
 982 #define my_safemalloc(s)        (void*)safemalloc(s)
 983 #define my_safecalloc(s)        (void*)safecalloc(s, 1)
 984 #define my_safefree(p)  safefree((char*)p)
 985
 986 #ifdef PURIFY
 987
 988 #define new_XNV()       my_safemalloc(sizeof(XPVNV))
 989 #define del_XNV(p)      my_safefree(p)
 990
 991 #define new_XPVNV()     my_safemalloc(sizeof(XPVNV))
 992 #define del_XPVNV(p)    my_safefree(p)
 993
 994 #define new_XPVAV()     my_safemalloc(sizeof(XPVAV))
 995 #define del_XPVAV(p)    my_safefree(p)
 996
 997 #define new_XPVHV()     my_safemalloc(sizeof(XPVHV))
 998 #define del_XPVHV(p)    my_safefree(p)
 999
1000 #define new_XPVMG()     my_safemalloc(sizeof(XPVMG))
1001 #define del_XPVMG(p)    my_safefree(p)
1002
1003 #define new_XPVGV()     my_safemalloc(sizeof(XPVGV))
1004 #define del_XPVGV(p)    my_safefree(p)
1005
1006 #else /* !PURIFY */
1007
1008 #define new_XNV()       new_body_type(SVt_NV)
1009 #define del_XNV(p)      del_body_type(p, SVt_NV)
1010
1011 #define new_XPVNV()     new_body_type(SVt_PVNV)
1012 #define del_XPVNV(p)    del_body_type(p, SVt_PVNV)
1013
1014 #define new_XPVAV()     new_body_allocated(SVt_PVAV)
1015 #define del_XPVAV(p)    del_body_allocated(p, SVt_PVAV)
1016
1017 #define new_XPVHV()     new_body_allocated(SVt_PVHV)
1018 #define del_XPVHV(p)    del_body_allocated(p, SVt_PVHV)
1019
1020 #define new_XPVMG()     new_body_type(SVt_PVMG)
1021 #define del_XPVMG(p)    del_body_type(p, SVt_PVMG)
1022
1023 #define new_XPVGV()     new_body_type(SVt_PVGV)
1024 #define del_XPVGV(p)    del_body_type(p, SVt_PVGV)
1025
1026 #endif /* PURIFY */
1027
1028 /* no arena for you! */
1029
1030 #define new_NOARENA(details) \
1031         my_safemalloc((details)->body_size + (details)->offset)
1032 #define new_NOARENAZ(details) \
1033         my_safecalloc((details)->body_size + (details)->offset)
1034
1035 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1036 static bool done_sanity_check;
1037 #endif
1038
1039 STATIC void *
1040 S_more_bodies (pTHX_ svtype sv_type)
1041 {
1042     dVAR;
1043     void ** const root = &PL_body_roots[sv_type];
1044     const struct body_details * const bdp = &bodies_by_type[sv_type];
1045     const size_t body_size = bdp->body_size;
1046     char *start;
1047     const char *end;
1048
1049     assert(bdp->arena_size);
1050
1051 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1052     /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1053      * variables like done_sanity_check. */
1054     if (!done_sanity_check) {
1055         unsigned int i = SVt_LAST;
1056
1057         done_sanity_check = TRUE;
1058
1059         while (i--)
1060             assert (bodies_by_type[i].type == i);
1061     }
1062 #endif
1063
1064     start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1065
1066     end = start + bdp->arena_size - body_size;
1067
1068     /* computed count doesnt reflect the 1st slot reservation */
1069     DEBUG_m(PerlIO_printf(Perl_debug_log,
1070                           "arena %p end %p arena-size %d type %d size %d ct %d\n",
1071                           start, end,
1072                           (int)bdp->arena_size, sv_type, (int)body_size,
1073                           (int)bdp->arena_size / (int)body_size));
1074
1075     *root = (void *)start;
1076
1077     while (start < end) {
1078         char * const next = start + body_size;
1079         *(void**) start = (void *)next;
1080         start = next;
1081     }
1082     *(void **)start = 0;
1083
1084     return *root;
1085 }
1086
1087 /* grab a new thing from the free list, allocating more if necessary.
1088    The inline version is used for speed in hot routines, and the
1089    function using it serves the rest (unless PURIFY).
1090 */
1091 #define new_body_inline(xpv, sv_type) \
1092     STMT_START { \
1093         void ** const r3wt = &PL_body_roots[sv_type]; \
1094         LOCK_SV_MUTEX; \
1095         xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt))      \
1096           ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1097         *(r3wt) = *(void**)(xpv); \
1098         UNLOCK_SV_MUTEX; \
1099     } STMT_END
1100
1101 #ifndef PURIFY
1102
1103 STATIC void *
1104 S_new_body(pTHX_ svtype sv_type)
1105 {
1106     dVAR;
1107     void *xpv;
1108     new_body_inline(xpv, sv_type);
1109     return xpv;
1110 }
1111
1112 #endif
1113
1114 /*
1115 =for apidoc sv_upgrade
1116
1117 Upgrade an SV to a more complex form.  Generally adds a new body type to the
1118 SV, then copies across as much information as possible from the old body.
1119 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1120
1121 =cut
1122 */
1123
1124 void
1125 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1126 {
1127     dVAR;
1128     void*       old_body;
1129     void*       new_body;
1130     const svtype old_type = SvTYPE(sv);
1131     const struct body_details *new_type_details;
1132     const struct body_details *const old_type_details
1133         = bodies_by_type + old_type;
1134
1135     if (new_type != SVt_PV && SvIsCOW(sv)) {
1136         sv_force_normal_flags(sv, 0);
1137     }
1138
1139     if (old_type == new_type)
1140         return;
1141
1142     if (old_type > new_type)
1143         Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1144                 (int)old_type, (int)new_type);
1145
1146
1147     old_body = SvANY(sv);
1148
1149     /* Copying structures onto other structures that have been neatly zeroed
1150        has a subtle gotcha. Consider XPVMG
1151
1152        +------+------+------+------+------+-------+-------+
1153        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH |
1154        +------+------+------+------+------+-------+-------+
1155        0      4      8     12     16     20      24      28
1156
1157        where NVs are aligned to 8 bytes, so that sizeof that structure is
1158        actually 32 bytes long, with 4 bytes of padding at the end:
1159
1160        +------+------+------+------+------+-------+-------+------+
1161        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH | ???  |
1162        +------+------+------+------+------+-------+-------+------+
1163        0      4      8     12     16     20      24      28     32
1164
1165        so what happens if you allocate memory for this structure:
1166
1167        +------+------+------+------+------+-------+-------+------+------+...
1168        |     NV      | CUR  | LEN  |  IV  | MAGIC | STASH |  GP  | NAME |
1169        +------+------+------+------+------+-------+-------+------+------+...
1170        0      4      8     12     16     20      24      28     32     36
1171
1172        zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1173        expect, because you copy the area marked ??? onto GP. Now, ??? may have
1174        started out as zero once, but it's quite possible that it isn't. So now,
1175        rather than a nicely zeroed GP, you have it pointing somewhere random.
1176        Bugs ensue.
1177
1178        (In fact, GP ends up pointing at a previous GP structure, because the
1179        principle cause of the padding in XPVMG getting garbage is a copy of
1180        sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1181
1182        So we are careful and work out the size of used parts of all the
1183        structures.  */
1184
1185     switch (old_type) {
1186     case SVt_NULL:
1187         break;
1188     case SVt_IV:
1189         if (new_type < SVt_PVIV) {
1190             new_type = (new_type == SVt_NV)
1191                 ? SVt_PVNV : SVt_PVIV;
1192         }
1193         break;
1194     case SVt_NV:
1195         if (new_type < SVt_PVNV) {
1196             new_type = SVt_PVNV;
1197         }
1198         break;
1199     case SVt_RV:
1200         break;
1201     case SVt_PV:
1202         assert(new_type > SVt_PV);
1203         assert(SVt_IV < SVt_PV);
1204         assert(SVt_NV < SVt_PV);
1205         break;
1206     case SVt_PVIV:
1207         break;
1208     case SVt_PVNV:
1209         break;
1210     case SVt_PVMG:
1211         /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1212            there's no way that it can be safely upgraded, because perl.c
1213            expects to Safefree(SvANY(PL_mess_sv))  */
1214         assert(sv != PL_mess_sv);
1215         /* This flag bit is used to mean other things in other scalar types.
1216            Given that it only has meaning inside the pad, it shouldn't be set
1217            on anything that can get upgraded.  */
1218         assert(!SvPAD_TYPED(sv));
1219         break;
1220     default:
1221         if (old_type_details->cant_upgrade)
1222             Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1223                        sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1224     }
1225     new_type_details = bodies_by_type + new_type;
1226
1227     SvFLAGS(sv) &= ~SVTYPEMASK;
1228     SvFLAGS(sv) |= new_type;
1229
1230     /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1231        the return statements above will have triggered.  */
1232     assert (new_type != SVt_NULL);
1233     switch (new_type) {
1234     case SVt_IV:
1235         assert(old_type == SVt_NULL);
1236         SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1237         SvIV_set(sv, 0);
1238         return;
1239     case SVt_NV:
1240         assert(old_type == SVt_NULL);
1241         SvANY(sv) = new_XNV();
1242         SvNV_set(sv, 0);
1243         return;
1244     case SVt_RV:
1245         assert(old_type == SVt_NULL);
1246         SvANY(sv) = &sv->sv_u.svu_rv;
1247         SvRV_set(sv, 0);
1248         return;
1249     case SVt_PVHV:
1250     case SVt_PVAV:
1251         assert(new_type_details->body_size);
1252
1253 #ifndef PURIFY
1254         assert(new_type_details->arena);
1255         assert(new_type_details->arena_size);
1256         /* This points to the start of the allocated area.  */
1257         new_body_inline(new_body, new_type);
1258         Zero(new_body, new_type_details->body_size, char);
1259         new_body = ((char *)new_body) - new_type_details->offset;
1260 #else
1261         /* We always allocated the full length item with PURIFY. To do this
1262            we fake things so that arena is false for all 16 types..  */
1263         new_body = new_NOARENAZ(new_type_details);
1264 #endif
1265         SvANY(sv) = new_body;
1266         if (new_type == SVt_PVAV) {
1267             AvMAX(sv)   = -1;
1268             AvFILLp(sv) = -1;
1269             AvREAL_only(sv);
1270         }
1271
1272         /* SVt_NULL isn't the only thing upgraded to AV or HV.
1273            The target created by newSVrv also is, and it can have magic.
1274            However, it never has SvPVX set.
1275         */
1276         if (old_type >= SVt_RV) {
1277             assert(SvPVX_const(sv) == 0);
1278         }
1279
1280         if (old_type >= SVt_PVMG) {
1281             SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1282             SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1283         } else {
1284             sv->sv_u.svu_array = NULL; /* or svu_hash  */
1285         }
1286         break;
1287
1288
1289     case SVt_PVIV:
1290         /* XXX Is this still needed?  Was it ever needed?   Surely as there is
1291            no route from NV to PVIV, NOK can never be true  */
1292         assert(!SvNOKp(sv));
1293         assert(!SvNOK(sv));
1294     case SVt_PVIO:
1295     case SVt_PVFM:
1296     case SVt_PVBM:
1297     case SVt_PVGV:
1298     case SVt_PVCV:
1299     case SVt_PVLV:
1300     case SVt_PVMG:
1301     case SVt_PVNV:
1302     case SVt_PV:
1303
1304         assert(new_type_details->body_size);
1305         /* We always allocated the full length item with PURIFY. To do this
1306            we fake things so that arena is false for all 16 types..  */
1307         if(new_type_details->arena) {
1308             /* This points to the start of the allocated area.  */
1309             new_body_inline(new_body, new_type);
1310             Zero(new_body, new_type_details->body_size, char);
1311             new_body = ((char *)new_body) - new_type_details->offset;
1312         } else {
1313             new_body = new_NOARENAZ(new_type_details);
1314         }
1315         SvANY(sv) = new_body;
1316
1317         if (old_type_details->copy) {
1318             /* There is now the potential for an upgrade from something without
1319                an offset (PVNV or PVMG) to something with one (PVCV, PVFM)  */
1320             int offset = old_type_details->offset;
1321             int length = old_type_details->copy;
1322
1323             if (new_type_details->offset > old_type_details->offset) {
1324                 const int difference
1325                     = new_type_details->offset - old_type_details->offset;
1326                 offset += difference;
1327                 length -= difference;
1328             }
1329             assert (length >= 0);
1330
1331             Copy((char *)old_body + offset, (char *)new_body + offset, length,
1332                  char);
1333         }
1334
1335 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1336         /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1337          * correct 0.0 for us.  Otherwise, if the old body didn't have an
1338          * NV slot, but the new one does, then we need to initialise the
1339          * freshly created NV slot with whatever the correct bit pattern is
1340          * for 0.0  */
1341         if (old_type_details->zero_nv && !new_type_details->zero_nv)
1342             SvNV_set(sv, 0);
1343 #endif
1344
1345         if (new_type == SVt_PVIO)
1346             IoPAGE_LEN(sv) = 60;
1347         if (old_type < SVt_RV)
1348             SvPV_set(sv, NULL);
1349         break;
1350     default:
1351         Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1352                    (unsigned long)new_type);
1353     }
1354
1355     if (old_type_details->arena) {
1356         /* If there was an old body, then we need to free it.
1357            Note that there is an assumption that all bodies of types that
1358            can be upgraded came from arenas. Only the more complex non-
1359            upgradable types are allowed to be directly malloc()ed.  */
1360 #ifdef PURIFY
1361         my_safefree(old_body);
1362 #else
1363         del_body((void*)((char*)old_body + old_type_details->offset),
1364                  &PL_body_roots[old_type]);
1365 #endif
1366     }
1367 }
1368
1369 /*
1370 =for apidoc sv_backoff
1371
1372 Remove any string offset. You should normally use the C<SvOOK_off> macro
1373 wrapper instead.
1374
1375 =cut
1376 */
1377
1378 int
1379 Perl_sv_backoff(pTHX_ register SV *sv)
1380 {
1381     PERL_UNUSED_CONTEXT;
1382     assert(SvOOK(sv));
1383     assert(SvTYPE(sv) != SVt_PVHV);
1384     assert(SvTYPE(sv) != SVt_PVAV);
1385     if (SvIVX(sv)) {
1386         const char * const s = SvPVX_const(sv);
1387         SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1388         SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1389         SvIV_set(sv, 0);
1390         Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1391     }
1392     SvFLAGS(sv) &= ~SVf_OOK;
1393     return 0;
1394 }
1395
1396 /*
1397 =for apidoc sv_grow
1398
1399 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
1400 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
1401 Use the C<SvGROW> wrapper instead.
1402
1403 =cut
1404 */
1405
1406 char *
1407 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1408 {
1409     register char *s;
1410
1411     if (PL_madskills && newlen >= 0x100000) {
1412         PerlIO_printf(Perl_debug_log,
1413                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1414     }
1415 #ifdef HAS_64K_LIMIT
1416     if (newlen >= 0x10000) {
1417         PerlIO_printf(Perl_debug_log,
1418                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1419         my_exit(1);
1420     }
1421 #endif /* HAS_64K_LIMIT */
1422     if (SvROK(sv))
1423         sv_unref(sv);
1424     if (SvTYPE(sv) < SVt_PV) {
1425         sv_upgrade(sv, SVt_PV);
1426         s = SvPVX_mutable(sv);
1427     }
1428     else if (SvOOK(sv)) {       /* pv is offset? */
1429         sv_backoff(sv);
1430         s = SvPVX_mutable(sv);
1431         if (newlen > SvLEN(sv))
1432             newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1433 #ifdef HAS_64K_LIMIT
1434         if (newlen >= 0x10000)
1435             newlen = 0xFFFF;
1436 #endif
1437     }
1438     else
1439         s = SvPVX_mutable(sv);
1440
1441     if (newlen > SvLEN(sv)) {           /* need more room? */
1442         newlen = PERL_STRLEN_ROUNDUP(newlen);
1443         if (SvLEN(sv) && s) {
1444 #ifdef MYMALLOC
1445             const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1446             if (newlen <= l) {
1447                 SvLEN_set(sv, l);
1448                 return s;
1449             } else
1450 #endif
1451             s = (char*)saferealloc(s, newlen);
1452         }
1453         else {
1454             s = (char*)safemalloc(newlen);
1455             if (SvPVX_const(sv) && SvCUR(sv)) {
1456                 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1457             }
1458         }
1459         SvPV_set(sv, s);
1460         SvLEN_set(sv, newlen);
1461     }
1462     return s;
1463 }
1464
1465 /*
1466 =for apidoc sv_setiv
1467
1468 Copies an integer into the given SV, upgrading first if necessary.
1469 Does not handle 'set' magic.  See also C<sv_setiv_mg>.
1470
1471 =cut
1472 */
1473
1474 void
1475 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1476 {
1477     dVAR;
1478     SV_CHECK_THINKFIRST_COW_DROP(sv);
1479     switch (SvTYPE(sv)) {
1480     case SVt_NULL:
1481         sv_upgrade(sv, SVt_IV);
1482         break;
1483     case SVt_NV:
1484         sv_upgrade(sv, SVt_PVNV);
1485         break;
1486     case SVt_RV:
1487     case SVt_PV:
1488         sv_upgrade(sv, SVt_PVIV);
1489         break;
1490
1491     case SVt_PVGV:
1492     case SVt_PVAV:
1493     case SVt_PVHV:
1494     case SVt_PVCV:
1495     case SVt_PVFM:
1496     case SVt_PVIO:
1497         Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1498                    OP_DESC(PL_op));
1499     default: NOOP;
1500     }
1501     (void)SvIOK_only(sv);                       /* validate number */
1502     SvIV_set(sv, i);
1503     SvTAINT(sv);
1504 }
1505
1506 /*
1507 =for apidoc sv_setiv_mg
1508
1509 Like C<sv_setiv>, but also handles 'set' magic.
1510
1511 =cut
1512 */
1513
1514 void
1515 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1516 {
1517     sv_setiv(sv,i);
1518     SvSETMAGIC(sv);
1519 }
1520
1521 /*
1522 =for apidoc sv_setuv
1523
1524 Copies an unsigned integer into the given SV, upgrading first if necessary.
1525 Does not handle 'set' magic.  See also C<sv_setuv_mg>.
1526
1527 =cut
1528 */
1529
1530 void
1531 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1532 {
1533     /* With these two if statements:
1534        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1535
1536        without
1537        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1538
1539        If you wish to remove them, please benchmark to see what the effect is
1540     */
1541     if (u <= (UV)IV_MAX) {
1542        sv_setiv(sv, (IV)u);
1543        return;
1544     }
1545     sv_setiv(sv, 0);
1546     SvIsUV_on(sv);
1547     SvUV_set(sv, u);
1548 }
1549
1550 /*
1551 =for apidoc sv_setuv_mg
1552
1553 Like C<sv_setuv>, but also handles 'set' magic.
1554
1555 =cut
1556 */
1557
1558 void
1559 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1560 {
1561     sv_setuv(sv,u);
1562     SvSETMAGIC(sv);
1563 }
1564
1565 /*
1566 =for apidoc sv_setnv
1567
1568 Copies a double into the given SV, upgrading first if necessary.
1569 Does not handle 'set' magic.  See also C<sv_setnv_mg>.
1570
1571 =cut
1572 */
1573
1574 void
1575 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1576 {
1577     dVAR;
1578     SV_CHECK_THINKFIRST_COW_DROP(sv);
1579     switch (SvTYPE(sv)) {
1580     case SVt_NULL:
1581     case SVt_IV:
1582         sv_upgrade(sv, SVt_NV);
1583         break;
1584     case SVt_RV:
1585     case SVt_PV:
1586     case SVt_PVIV:
1587         sv_upgrade(sv, SVt_PVNV);
1588         break;
1589
1590     case SVt_PVGV:
1591     case SVt_PVAV:
1592     case SVt_PVHV:
1593     case SVt_PVCV:
1594     case SVt_PVFM:
1595     case SVt_PVIO:
1596         Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1597                    OP_NAME(PL_op));
1598     default: NOOP;
1599     }
1600     SvNV_set(sv, num);
1601     (void)SvNOK_only(sv);                       /* validate number */
1602     SvTAINT(sv);
1603 }
1604
1605 /*
1606 =for apidoc sv_setnv_mg
1607
1608 Like C<sv_setnv>, but also handles 'set' magic.
1609
1610 =cut
1611 */
1612
1613 void
1614 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1615 {
1616     sv_setnv(sv,num);
1617     SvSETMAGIC(sv);
1618 }
1619
1620 /* Print an "isn't numeric" warning, using a cleaned-up,
1621  * printable version of the offending string
1622  */
1623
1624 STATIC void
1625 S_not_a_number(pTHX_ SV *sv)
1626 {
1627      dVAR;
1628      SV *dsv;
1629      char tmpbuf[64];
1630      const char *pv;
1631
1632      if (DO_UTF8(sv)) {
1633           dsv = sv_2mortal(newSVpvs(""));
1634           pv = sv_uni_display(dsv, sv, 10, 0);
1635      } else {
1636           char *d = tmpbuf;
1637           const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1638           /* each *s can expand to 4 chars + "...\0",
1639              i.e. need room for 8 chars */
1640
1641           const char *s = SvPVX_const(sv);
1642           const char * const end = s + SvCUR(sv);
1643           for ( ; s < end && d < limit; s++ ) {
1644                int ch = *s & 0xFF;
1645                if (ch & 128 && !isPRINT_LC(ch)) {
1646                     *d++ = 'M';
1647                     *d++ = '-';
1648                     ch &= 127;
1649                }
1650                if (ch == '\n') {
1651                     *d++ = '\\';
1652                     *d++ = 'n';
1653                }
1654                else if (ch == '\r') {
1655                     *d++ = '\\';
1656                     *d++ = 'r';
1657                }
1658                else if (ch == '\f') {
1659                     *d++ = '\\';
1660                     *d++ = 'f';
1661                }
1662                else if (ch == '\\') {
1663                     *d++ = '\\';
1664                     *d++ = '\\';
1665                }
1666                else if (ch == '\0') {
1667                     *d++ = '\\';
1668                     *d++ = '0';
1669                }
1670                else if (isPRINT_LC(ch))
1671                     *d++ = ch;
1672                else {
1673                     *d++ = '^';
1674                     *d++ = toCTRL(ch);
1675                }
1676           }
1677           if (s < end) {
1678                *d++ = '.';
1679                *d++ = '.';
1680                *d++ = '.';
1681           }
1682           *d = '\0';
1683           pv = tmpbuf;
1684     }
1685
1686     if (PL_op)
1687         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1688                     "Argument \"%s\" isn't numeric in %s", pv,
1689                     OP_DESC(PL_op));
1690     else
1691         Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1692                     "Argument \"%s\" isn't numeric", pv);
1693 }
1694
1695 /*
1696 =for apidoc looks_like_number
1697
1698 Test if the content of an SV looks like a number (or is a number).
1699 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1700 non-numeric warning), even if your atof() doesn't grok them.
1701
1702 =cut
1703 */
1704
1705 I32
1706 Perl_looks_like_number(pTHX_ SV *sv)
1707 {
1708     register const char *sbegin;
1709     STRLEN len;
1710
1711     if (SvPOK(sv)) {
1712         sbegin = SvPVX_const(sv);
1713         len = SvCUR(sv);
1714     }
1715     else if (SvPOKp(sv))
1716         sbegin = SvPV_const(sv, len);
1717     else
1718         return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1719     return grok_number(sbegin, len, NULL);
1720 }
1721
1722 STATIC bool
1723 S_glob_2number(pTHX_ GV * const gv)
1724 {
1725     const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1726     SV *const buffer = sv_newmortal();
1727
1728     /* FAKE globs can get coerced, so need to turn this off temporarily if it
1729        is on.  */
1730     SvFAKE_off(gv);
1731     gv_efullname3(buffer, gv, "*");
1732     SvFLAGS(gv) |= wasfake;
1733
1734     /* We know that all GVs stringify to something that is not-a-number,
1735         so no need to test that.  */
1736     if (ckWARN(WARN_NUMERIC))
1737         not_a_number(buffer);
1738     /* We just want something true to return, so that S_sv_2iuv_common
1739         can tail call us and return true.  */
1740     return TRUE;
1741 }
1742
1743 STATIC char *
1744 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1745 {
1746     const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1747     SV *const buffer = sv_newmortal();
1748
1749     /* FAKE globs can get coerced, so need to turn this off temporarily if it
1750        is on.  */
1751     SvFAKE_off(gv);
1752     gv_efullname3(buffer, gv, "*");
1753     SvFLAGS(gv) |= wasfake;
1754
1755     assert(SvPOK(buffer));
1756     if (len) {
1757         *len = SvCUR(buffer);
1758     }
1759     return SvPVX(buffer);
1760 }
1761
1762 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1763    until proven guilty, assume that things are not that bad... */
1764
1765 /*
1766    NV_PRESERVES_UV:
1767
1768    As 64 bit platforms often have an NV that doesn't preserve all bits of
1769    an IV (an assumption perl has been based on to date) it becomes necessary
1770    to remove the assumption that the NV always carries enough precision to
1771    recreate the IV whenever needed, and that the NV is the canonical form.
1772    Instead, IV/UV and NV need to be given equal rights. So as to not lose
1773    precision as a side effect of conversion (which would lead to insanity
1774    and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1775    1) to distinguish between IV/UV/NV slots that have cached a valid
1776       conversion where precision was lost and IV/UV/NV slots that have a
1777       valid conversion which has lost no precision
1778    2) to ensure that if a numeric conversion to one form is requested that
1779       would lose precision, the precise conversion (or differently
1780       imprecise conversion) is also performed and cached, to prevent
1781       requests for different numeric formats on the same SV causing
1782       lossy conversion chains. (lossless conversion chains are perfectly
1783       acceptable (still))
1784
1785
1786    flags are used:
1787    SvIOKp is true if the IV slot contains a valid value
1788    SvIOK  is true only if the IV value is accurate (UV if SvIOK_UV true)
1789    SvNOKp is true if the NV slot contains a valid value
1790    SvNOK  is true only if the NV value is accurate
1791
1792    so
1793    while converting from PV to NV, check to see if converting that NV to an
1794    IV(or UV) would lose accuracy over a direct conversion from PV to
1795    IV(or UV). If it would, cache both conversions, return NV, but mark
1796    SV as IOK NOKp (ie not NOK).
1797
1798    While converting from PV to IV, check to see if converting that IV to an
1799    NV would lose accuracy over a direct conversion from PV to NV. If it
1800    would, cache both conversions, flag similarly.
1801
1802    Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1803    correctly because if IV & NV were set NV *always* overruled.
1804    Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1805    changes - now IV and NV together means that the two are interchangeable:
1806    SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1807
1808    The benefit of this is that operations such as pp_add know that if
1809    SvIOK is true for both left and right operands, then integer addition
1810    can be used instead of floating point (for cases where the result won't
1811    overflow). Before, floating point was always used, which could lead to
1812    loss of precision compared with integer addition.
1813
1814    * making IV and NV equal status should make maths accurate on 64 bit
1815      platforms
1816    * may speed up maths somewhat if pp_add and friends start to use
1817      integers when possible instead of fp. (Hopefully the overhead in
1818      looking for SvIOK and checking for overflow will not outweigh the
1819      fp to integer speedup)
1820    * will slow down integer operations (callers of SvIV) on "inaccurate"
1821      values, as the change from SvIOK to SvIOKp will cause a call into
1822      sv_2iv each time rather than a macro access direct to the IV slot
1823    * should speed up number->string conversion on integers as IV is
1824      favoured when IV and NV are equally accurate
1825
1826    ####################################################################
1827    You had better be using SvIOK_notUV if you want an IV for arithmetic:
1828    SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1829    On the other hand, SvUOK is true iff UV.
1830    ####################################################################
1831
1832    Your mileage will vary depending your CPU's relative fp to integer
1833    performance ratio.
1834 */
1835
1836 #ifndef NV_PRESERVES_UV
1837 #  define IS_NUMBER_UNDERFLOW_IV 1
1838 #  define IS_NUMBER_UNDERFLOW_UV 2
1839 #  define IS_NUMBER_IV_AND_UV    2
1840 #  define IS_NUMBER_OVERFLOW_IV  4
1841 #  define IS_NUMBER_OVERFLOW_UV  5
1842
1843 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1844
1845 /* For sv_2nv these three cases are "SvNOK and don't bother casting"  */
1846 STATIC int
1847 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1848 {
1849     dVAR;
1850     PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1851     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));
1852     if (SvNVX(sv) < (NV)IV_MIN) {
1853         (void)SvIOKp_on(sv);
1854         (void)SvNOK_on(sv);
1855         SvIV_set(sv, IV_MIN);
1856         return IS_NUMBER_UNDERFLOW_IV;
1857     }
1858     if (SvNVX(sv) > (NV)UV_MAX) {
1859         (void)SvIOKp_on(sv);
1860         (void)SvNOK_on(sv);
1861         SvIsUV_on(sv);
1862         SvUV_set(sv, UV_MAX);
1863         return IS_NUMBER_OVERFLOW_UV;
1864     }
1865     (void)SvIOKp_on(sv);
1866     (void)SvNOK_on(sv);
1867     /* Can't use strtol etc to convert this string.  (See truth table in
1868        sv_2iv  */
1869     if (SvNVX(sv) <= (UV)IV_MAX) {
1870         SvIV_set(sv, I_V(SvNVX(sv)));
1871         if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1872             SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1873         } else {
1874             /* Integer is imprecise. NOK, IOKp */
1875         }
1876         return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1877     }
1878     SvIsUV_on(sv);
1879     SvUV_set(sv, U_V(SvNVX(sv)));
1880     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1881         if (SvUVX(sv) == UV_MAX) {
1882             /* As we know that NVs don't preserve UVs, UV_MAX cannot
1883                possibly be preserved by NV. Hence, it must be overflow.
1884                NOK, IOKp */
1885             return IS_NUMBER_OVERFLOW_UV;
1886         }
1887         SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1888     } else {
1889         /* Integer is imprecise. NOK, IOKp */
1890     }
1891     return IS_NUMBER_OVERFLOW_IV;
1892 }
1893 #endif /* !NV_PRESERVES_UV*/
1894
1895 STATIC bool
1896 S_sv_2iuv_common(pTHX_ SV *sv) {
1897     dVAR;
1898     if (SvNOKp(sv)) {
1899         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1900          * without also getting a cached IV/UV from it at the same time
1901          * (ie PV->NV conversion should detect loss of accuracy and cache
1902          * IV or UV at same time to avoid this. */
1903         /* IV-over-UV optimisation - choose to cache IV if possible */
1904
1905         if (SvTYPE(sv) == SVt_NV)
1906             sv_upgrade(sv, SVt_PVNV);
1907
1908         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
1909         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1910            certainly cast into the IV range at IV_MAX, whereas the correct
1911            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1912            cases go to UV */
1913 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1914         if (Perl_isnan(SvNVX(sv))) {
1915             SvUV_set(sv, 0);
1916             SvIsUV_on(sv);
1917             return FALSE;
1918         }
1919 #endif
1920         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1921             SvIV_set(sv, I_V(SvNVX(sv)));
1922             if (SvNVX(sv) == (NV) SvIVX(sv)
1923 #ifndef NV_PRESERVES_UV
1924                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1925                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1926                 /* Don't flag it as "accurately an integer" if the number
1927                    came from a (by definition imprecise) NV operation, and
1928                    we're outside the range of NV integer precision */
1929 #endif
1930                 ) {
1931                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
1932                 DEBUG_c(PerlIO_printf(Perl_debug_log,
1933                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1934                                       PTR2UV(sv),
1935                                       SvNVX(sv),
1936                                       SvIVX(sv)));
1937
1938             } else {
1939                 /* IV not precise.  No need to convert from PV, as NV
1940                    conversion would already have cached IV if it detected
1941                    that PV->IV would be better than PV->NV->IV
1942                    flags already correct - don't set public IOK.  */
1943                 DEBUG_c(PerlIO_printf(Perl_debug_log,
1944                                       "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1945                                       PTR2UV(sv),
1946                                       SvNVX(sv),
1947                                       SvIVX(sv)));
1948             }
1949             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1950                but the cast (NV)IV_MIN rounds to a the value less (more
1951                negative) than IV_MIN which happens to be equal to SvNVX ??
1952                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1953                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1954                (NV)UVX == NVX are both true, but the values differ. :-(
1955                Hopefully for 2s complement IV_MIN is something like
1956                0x8000000000000000 which will be exact. NWC */
1957         }
1958         else {
1959             SvUV_set(sv, U_V(SvNVX(sv)));
1960             if (
1961                 (SvNVX(sv) == (NV) SvUVX(sv))
1962 #ifndef  NV_PRESERVES_UV
1963                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1964                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1965                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1966                 /* Don't flag it as "accurately an integer" if the number
1967                    came from a (by definition imprecise) NV operation, and
1968                    we're outside the range of NV integer precision */
1969 #endif
1970                 )
1971                 SvIOK_on(sv);
1972             SvIsUV_on(sv);
1973             DEBUG_c(PerlIO_printf(Perl_debug_log,
1974                                   "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1975                                   PTR2UV(sv),
1976                                   SvUVX(sv),
1977                                   SvUVX(sv)));
1978         }
1979     }
1980     else if (SvPOKp(sv) && SvLEN(sv)) {
1981         UV value;
1982         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1983         /* We want to avoid a possible problem when we cache an IV/ a UV which
1984            may be later translated to an NV, and the resulting NV is not
1985            the same as the direct translation of the initial string
1986            (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1987            be careful to ensure that the value with the .456 is around if the
1988            NV value is requested in the future).
1989
1990            This means that if we cache such an IV/a UV, we need to cache the
1991            NV as well.  Moreover, we trade speed for space, and do not
1992            cache the NV if we are sure it's not needed.
1993          */
1994
1995         /* SVt_PVNV is one higher than SVt_PVIV, hence this order  */
1996         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1997              == IS_NUMBER_IN_UV) {
1998             /* It's definitely an integer, only upgrade to PVIV */
1999             if (SvTYPE(sv) < SVt_PVIV)
2000                 sv_upgrade(sv, SVt_PVIV);
2001             (void)SvIOK_on(sv);
2002         } else if (SvTYPE(sv) < SVt_PVNV)
2003             sv_upgrade(sv, SVt_PVNV);
2004
2005         /* If NVs preserve UVs then we only use the UV value if we know that
2006            we aren't going to call atof() below. If NVs don't preserve UVs
2007            then the value returned may have more precision than atof() will
2008            return, even though value isn't perfectly accurate.  */
2009         if ((numtype & (IS_NUMBER_IN_UV
2010 #ifdef NV_PRESERVES_UV
2011                         | IS_NUMBER_NOT_INT
2012 #endif
2013             )) == IS_NUMBER_IN_UV) {
2014             /* This won't turn off the public IOK flag if it was set above  */
2015             (void)SvIOKp_on(sv);
2016
2017             if (!(numtype & IS_NUMBER_NEG)) {
2018                 /* positive */;
2019                 if (value <= (UV)IV_MAX) {
2020                     SvIV_set(sv, (IV)value);
2021                 } else {
2022                     /* it didn't overflow, and it was positive. */
2023                     SvUV_set(sv, value);
2024                     SvIsUV_on(sv);
2025                 }
2026             } else {
2027                 /* 2s complement assumption  */
2028                 if (value <= (UV)IV_MIN) {
2029                     SvIV_set(sv, -(IV)value);
2030                 } else {
2031                     /* Too negative for an IV.  This is a double upgrade, but
2032                        I'm assuming it will be rare.  */
2033                     if (SvTYPE(sv) < SVt_PVNV)
2034                         sv_upgrade(sv, SVt_PVNV);
2035                     SvNOK_on(sv);
2036                     SvIOK_off(sv);
2037                     SvIOKp_on(sv);
2038                     SvNV_set(sv, -(NV)value);
2039                     SvIV_set(sv, IV_MIN);
2040                 }
2041             }
2042         }
2043         /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2044            will be in the previous block to set the IV slot, and the next
2045            block to set the NV slot.  So no else here.  */
2046
2047         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2048             != IS_NUMBER_IN_UV) {
2049             /* It wasn't an (integer that doesn't overflow the UV). */
2050             SvNV_set(sv, Atof(SvPVX_const(sv)));
2051
2052             if (! numtype && ckWARN(WARN_NUMERIC))
2053                 not_a_number(sv);
2054
2055 #if defined(USE_LONG_DOUBLE)
2056             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2057                                   PTR2UV(sv), SvNVX(sv)));
2058 #else
2059             DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2060                                   PTR2UV(sv), SvNVX(sv)));
2061 #endif
2062
2063 #ifdef NV_PRESERVES_UV
2064             (void)SvIOKp_on(sv);
2065             (void)SvNOK_on(sv);
2066             if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2067                 SvIV_set(sv, I_V(SvNVX(sv)));
2068                 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2069                     SvIOK_on(sv);
2070                 } else {
2071                     NOOP;  /* Integer is imprecise. NOK, IOKp */
2072                 }
2073                 /* UV will not work better than IV */
2074             } else {
2075                 if (SvNVX(sv) > (NV)UV_MAX) {
2076                     SvIsUV_on(sv);
2077                     /* Integer is inaccurate. NOK, IOKp, is UV */
2078                     SvUV_set(sv, UV_MAX);
2079                 } else {
2080                     SvUV_set(sv, U_V(SvNVX(sv)));
2081                     /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2082                        NV preservse UV so can do correct comparison.  */
2083                     if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2084                         SvIOK_on(sv);
2085                     } else {
2086                         NOOP;   /* Integer is imprecise. NOK, IOKp, is UV */
2087                     }
2088                 }
2089                 SvIsUV_on(sv);
2090             }
2091 #else /* NV_PRESERVES_UV */
2092             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2093                 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2094                 /* The IV/UV slot will have been set from value returned by
2095                    grok_number above.  The NV slot has just been set using
2096                    Atof.  */
2097                 SvNOK_on(sv);
2098                 assert (SvIOKp(sv));
2099             } else {
2100                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2101                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2102                     /* Small enough to preserve all bits. */
2103                     (void)SvIOKp_on(sv);
2104                     SvNOK_on(sv);
2105                     SvIV_set(sv, I_V(SvNVX(sv)));
2106                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2107                         SvIOK_on(sv);
2108                     /* Assumption: first non-preserved integer is < IV_MAX,
2109                        this NV is in the preserved range, therefore: */
2110                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2111                           < (UV)IV_MAX)) {
2112                         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);
2113                     }
2114                 } else {
2115                     /* IN_UV NOT_INT
2116                          0      0       already failed to read UV.
2117                          0      1       already failed to read UV.
2118                          1      0       you won't get here in this case. IV/UV
2119                                         slot set, public IOK, Atof() unneeded.
2120                          1      1       already read UV.
2121                        so there's no point in sv_2iuv_non_preserve() attempting
2122                        to use atol, strtol, strtoul etc.  */
2123                     sv_2iuv_non_preserve (sv, numtype);
2124                 }
2125             }
2126 #endif /* NV_PRESERVES_UV */
2127         }
2128     }
2129     else  {
2130         if (isGV_with_GP(sv))
2131             return glob_2number((GV *)sv);
2132
2133         if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2134             if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2135                 report_uninit(sv);
2136         }
2137         if (SvTYPE(sv) < SVt_IV)
2138             /* Typically the caller expects that sv_any is not NULL now.  */
2139             sv_upgrade(sv, SVt_IV);
2140         /* Return 0 from the caller.  */
2141         return TRUE;
2142     }
2143     return FALSE;
2144 }
2145
2146 /*
2147 =for apidoc sv_2iv_flags
2148
2149 Return the integer value of an SV, doing any necessary string
2150 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2151 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2152
2153 =cut
2154 */
2155
2156 IV
2157 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2158 {
2159     dVAR;
2160     if (!sv)
2161         return 0;
2162     if (SvGMAGICAL(sv) || SvTYPE(sv) == SVt_PVBM) {
2163         /* PVBMs use the same flag bit as SVf_IVisUV, so must let them
2164            cache IVs just in case. In practice it seems that they never
2165            actually anywhere accessible by user Perl code, let alone get used
2166            in anything other than a string context.  */
2167         if (flags & SV_GMAGIC)
2168             mg_get(sv);
2169         if (SvIOKp(sv))
2170             return SvIVX(sv);
2171         if (SvNOKp(sv)) {
2172             return I_V(SvNVX(sv));
2173         }
2174         if (SvPOKp(sv) && SvLEN(sv)) {
2175             UV value;
2176             const int numtype
2177                 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2178
2179             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2180                 == IS_NUMBER_IN_UV) {
2181                 /* It's definitely an integer */
2182                 if (numtype & IS_NUMBER_NEG) {
2183                     if (value < (UV)IV_MIN)
2184                         return -(IV)value;
2185                 } else {
2186                     if (value < (UV)IV_MAX)
2187                         return (IV)value;
2188                 }
2189             }
2190             if (!numtype) {
2191                 if (ckWARN(WARN_NUMERIC))
2192                     not_a_number(sv);
2193             }
2194             return I_V(Atof(SvPVX_const(sv)));
2195         }
2196         if (SvROK(sv)) {
2197             goto return_rok;
2198         }
2199         assert(SvTYPE(sv) >= SVt_PVMG);
2200         /* This falls through to the report_uninit inside S_sv_2iuv_common.  */
2201     } else if (SvTHINKFIRST(sv)) {
2202         if (SvROK(sv)) {
2203         return_rok:
2204             if (SvAMAGIC(sv)) {
2205                 SV * const tmpstr=AMG_CALLun(sv,numer);
2206                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2207                     return SvIV(tmpstr);
2208                 }
2209             }
2210             return PTR2IV(SvRV(sv));
2211         }
2212         if (SvIsCOW(sv)) {
2213             sv_force_normal_flags(sv, 0);
2214         }
2215         if (SvREADONLY(sv) && !SvOK(sv)) {
2216             if (ckWARN(WARN_UNINITIALIZED))
2217                 report_uninit(sv);
2218             return 0;
2219         }
2220     }
2221     if (!SvIOKp(sv)) {
2222         if (S_sv_2iuv_common(aTHX_ sv))
2223             return 0;
2224     }
2225     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2226         PTR2UV(sv),SvIVX(sv)));
2227     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2228 }
2229
2230 /*
2231 =for apidoc sv_2uv_flags
2232
2233 Return the unsigned integer value of an SV, doing any necessary string
2234 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
2235 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2236
2237 =cut
2238 */
2239
2240 UV
2241 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2242 {
2243     dVAR;
2244     if (!sv)
2245         return 0;
2246     if (SvGMAGICAL(sv) || SvTYPE(sv) == SVt_PVBM) {
2247         /* PVBMs use the same flag bit as SVf_IVisUV, so must let them
2248            cache IVs just in case.  */
2249         if (flags & SV_GMAGIC)
2250             mg_get(sv);
2251         if (SvIOKp(sv))
2252             return SvUVX(sv);
2253         if (SvNOKp(sv))
2254             return U_V(SvNVX(sv));
2255         if (SvPOKp(sv) && SvLEN(sv)) {
2256             UV value;
2257             const int numtype
2258                 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2259
2260             if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2261                 == IS_NUMBER_IN_UV) {
2262                 /* It's definitely an integer */
2263                 if (!(numtype & IS_NUMBER_NEG))
2264                     return value;
2265             }
2266             if (!numtype) {
2267                 if (ckWARN(WARN_NUMERIC))
2268                     not_a_number(sv);
2269             }
2270             return U_V(Atof(SvPVX_const(sv)));
2271         }
2272         if (SvROK(sv)) {
2273             goto return_rok;
2274         }
2275         assert(SvTYPE(sv) >= SVt_PVMG);
2276         /* This falls through to the report_uninit inside S_sv_2iuv_common.  */
2277     } else if (SvTHINKFIRST(sv)) {
2278         if (SvROK(sv)) {
2279         return_rok:
2280             if (SvAMAGIC(sv)) {
2281                 SV *const tmpstr = AMG_CALLun(sv,numer);
2282                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2283                     return SvUV(tmpstr);
2284                 }
2285             }
2286             return PTR2UV(SvRV(sv));
2287         }
2288         if (SvIsCOW(sv)) {
2289             sv_force_normal_flags(sv, 0);
2290         }
2291         if (SvREADONLY(sv) && !SvOK(sv)) {
2292             if (ckWARN(WARN_UNINITIALIZED))
2293                 report_uninit(sv);
2294             return 0;
2295         }
2296     }
2297     if (!SvIOKp(sv)) {
2298         if (S_sv_2iuv_common(aTHX_ sv))
2299             return 0;
2300     }
2301
2302     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2303                           PTR2UV(sv),SvUVX(sv)));
2304     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2305 }
2306
2307 /*
2308 =for apidoc sv_2nv
2309
2310 Return the num value of an SV, doing any necessary string or integer
2311 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2312 macros.
2313
2314 =cut
2315 */
2316
2317 NV
2318 Perl_sv_2nv(pTHX_ register SV *sv)
2319 {
2320     dVAR;
2321     if (!sv)
2322         return 0.0;
2323     if (SvGMAGICAL(sv) || SvTYPE(sv) == SVt_PVBM) {
2324         /* PVBMs use the same flag bit as SVf_IVisUV, so must let them
2325            cache IVs just in case.  */
2326         mg_get(sv);
2327         if (SvNOKp(sv))
2328             return SvNVX(sv);
2329         if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2330             if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2331                 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2332                 not_a_number(sv);
2333             return Atof(SvPVX_const(sv));
2334         }
2335         if (SvIOKp(sv)) {
2336             if (SvIsUV(sv))
2337                 return (NV)SvUVX(sv);
2338             else
2339                 return (NV)SvIVX(sv);
2340         }
2341         if (SvROK(sv)) {
2342             goto return_rok;
2343         }
2344         assert(SvTYPE(sv) >= SVt_PVMG);
2345         /* This falls through to the report_uninit near the end of the
2346            function. */
2347     } else if (SvTHINKFIRST(sv)) {
2348         if (SvROK(sv)) {
2349         return_rok:
2350             if (SvAMAGIC(sv)) {
2351                 SV *const tmpstr = AMG_CALLun(sv,numer);
2352                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2353                     return SvNV(tmpstr);
2354                 }
2355             }
2356             return PTR2NV(SvRV(sv));
2357         }
2358         if (SvIsCOW(sv)) {
2359             sv_force_normal_flags(sv, 0);
2360         }
2361         if (SvREADONLY(sv) && !SvOK(sv)) {
2362             if (ckWARN(WARN_UNINITIALIZED))
2363                 report_uninit(sv);
2364             return 0.0;
2365         }
2366     }
2367     if (SvTYPE(sv) < SVt_NV) {
2368         /* The logic to use SVt_PVNV if necessary is in sv_upgrade.  */
2369         sv_upgrade(sv, SVt_NV);
2370 #ifdef USE_LONG_DOUBLE
2371         DEBUG_c({
2372             STORE_NUMERIC_LOCAL_SET_STANDARD();
2373             PerlIO_printf(Perl_debug_log,
2374                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2375                           PTR2UV(sv), SvNVX(sv));
2376             RESTORE_NUMERIC_LOCAL();
2377         });
2378 #else
2379         DEBUG_c({
2380             STORE_NUMERIC_LOCAL_SET_STANDARD();
2381             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2382                           PTR2UV(sv), SvNVX(sv));
2383             RESTORE_NUMERIC_LOCAL();
2384         });
2385 #endif
2386     }
2387     else if (SvTYPE(sv) < SVt_PVNV)
2388         sv_upgrade(sv, SVt_PVNV);
2389     if (SvNOKp(sv)) {
2390         return SvNVX(sv);
2391     }
2392     if (SvIOKp(sv)) {
2393         SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2394 #ifdef NV_PRESERVES_UV
2395         SvNOK_on(sv);
2396 #else
2397         /* Only set the public NV OK flag if this NV preserves the IV  */
2398         /* Check it's not 0xFFFFFFFFFFFFFFFF */
2399         if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2400                        : (SvIVX(sv) == I_V(SvNVX(sv))))
2401             SvNOK_on(sv);
2402         else
2403             SvNOKp_on(sv);
2404 #endif
2405     }
2406     else if (SvPOKp(sv) && SvLEN(sv)) {
2407         UV value;
2408         const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2409         if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2410             not_a_number(sv);
2411 #ifdef NV_PRESERVES_UV
2412         if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2413             == IS_NUMBER_IN_UV) {
2414             /* It's definitely an integer */
2415             SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2416         } else
2417             SvNV_set(sv, Atof(SvPVX_const(sv)));
2418         SvNOK_on(sv);
2419 #else
2420         SvNV_set(sv, Atof(SvPVX_const(sv)));
2421         /* Only set the public NV OK flag if this NV preserves the value in
2422            the PV at least as well as an IV/UV would.
2423            Not sure how to do this 100% reliably. */
2424         /* if that shift count is out of range then Configure's test is
2425            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2426            UV_BITS */
2427         if (((UV)1 << NV_PRESERVES_UV_BITS) >
2428             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2429             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2430         } else if (!(numtype & IS_NUMBER_IN_UV)) {
2431             /* Can't use strtol etc to convert this string, so don't try.
2432                sv_2iv and sv_2uv will use the NV to convert, not the PV.  */
2433             SvNOK_on(sv);
2434         } else {
2435             /* value has been set.  It may not be precise.  */
2436             if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2437                 /* 2s complement assumption for (UV)IV_MIN  */
2438                 SvNOK_on(sv); /* Integer is too negative.  */
2439             } else {
2440                 SvNOKp_on(sv);
2441                 SvIOKp_on(sv);
2442
2443                 if (numtype & IS_NUMBER_NEG) {
2444                     SvIV_set(sv, -(IV)value);
2445                 } else if (value <= (UV)IV_MAX) {
2446                     SvIV_set(sv, (IV)value);
2447                 } else {
2448                     SvUV_set(sv, value);
2449                     SvIsUV_on(sv);
2450                 }
2451
2452                 if (numtype & IS_NUMBER_NOT_INT) {
2453                     /* I believe that even if the original PV had decimals,
2454                        they are lost beyond the limit of the FP precision.
2455                        However, neither is canonical, so both only get p
2456                        flags.  NWC, 2000/11/25 */
2457                     /* Both already have p flags, so do nothing */
2458                 } else {
2459                     const NV nv = SvNVX(sv);
2460                     if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2461                         if (SvIVX(sv) == I_V(nv)) {
2462                             SvNOK_on(sv);
2463                         } else {
2464                             /* It had no "." so it must be integer.  */
2465                         }
2466                         SvIOK_on(sv);
2467                     } else {
2468                         /* between IV_MAX and NV(UV_MAX).
2469                            Could be slightly > UV_MAX */
2470
2471                         if (numtype & IS_NUMBER_NOT_INT) {
2472                             /* UV and NV both imprecise.  */
2473                         } else {
2474                             const UV nv_as_uv = U_V(nv);
2475
2476                             if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2477                                 SvNOK_on(sv);
2478                             }
2479                             SvIOK_on(sv);
2480                         }
2481                     }
2482                 }
2483             }
2484         }
2485 #endif /* NV_PRESERVES_UV */
2486     }
2487     else  {
2488         if (isGV_with_GP(sv)) {
2489             glob_2number((GV *)sv);
2490             return 0.0;
2491         }
2492
2493         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2494             report_uninit(sv);
2495         assert (SvTYPE(sv) >= SVt_NV);
2496         /* Typically the caller expects that sv_any is not NULL now.  */
2497         /* XXX Ilya implies that this is a bug in callers that assume this
2498            and ideally should be fixed.  */
2499         return 0.0;
2500     }
2501 #if defined(USE_LONG_DOUBLE)
2502     DEBUG_c({
2503         STORE_NUMERIC_LOCAL_SET_STANDARD();
2504         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2505                       PTR2UV(sv), SvNVX(sv));
2506         RESTORE_NUMERIC_LOCAL();
2507     });
2508 #else
2509     DEBUG_c({
2510         STORE_NUMERIC_LOCAL_SET_STANDARD();
2511         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2512                       PTR2UV(sv), SvNVX(sv));
2513         RESTORE_NUMERIC_LOCAL();
2514     });
2515 #endif
2516     return SvNVX(sv);
2517 }
2518
2519 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2520  * UV as a string towards the end of buf, and return pointers to start and
2521  * end of it.
2522  *
2523  * We assume that buf is at least TYPE_CHARS(UV) long.
2524  */
2525
2526 static char *
2527 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2528 {
2529     char *ptr = buf + TYPE_CHARS(UV);
2530     char * const ebuf = ptr;
2531     int sign;
2532
2533     if (is_uv)
2534         sign = 0;
2535     else if (iv >= 0) {
2536         uv = iv;
2537         sign = 0;
2538     } else {
2539         uv = -iv;
2540         sign = 1;
2541     }
2542     do {
2543         *--ptr = '0' + (char)(uv % 10);
2544     } while (uv /= 10);
2545     if (sign)
2546         *--ptr = '-';
2547     *peob = ebuf;
2548     return ptr;
2549 }
2550
2551 /*
2552 =for apidoc sv_2pv_flags
2553
2554 Returns a pointer to the string value of an SV, and sets *lp to its length.
2555 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2556 if necessary.
2557 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2558 usually end up here too.
2559
2560 =cut
2561 */
2562
2563 char *
2564 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2565 {
2566     dVAR;
2567     register char *s;
2568
2569     if (!sv) {
2570         if (lp)
2571             *lp = 0;
2572         return (char *)"";
2573     }
2574     if (SvGMAGICAL(sv)) {
2575         if (flags & SV_GMAGIC)
2576             mg_get(sv);
2577         if (SvPOKp(sv)) {
2578             if (lp)
2579                 *lp = SvCUR(sv);
2580             if (flags & SV_MUTABLE_RETURN)
2581                 return SvPVX_mutable(sv);
2582             if (flags & SV_CONST_RETURN)
2583                 return (char *)SvPVX_const(sv);
2584             return SvPVX(sv);
2585         }
2586         if (SvIOKp(sv) || SvNOKp(sv)) {
2587             char tbuf[64];  /* Must fit sprintf/Gconvert of longest IV/NV */
2588             STRLEN len;
2589
2590             if (SvIOKp(sv)) {
2591                 len = SvIsUV(sv)
2592                     ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2593                     : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2594             } else {
2595                 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2596                 len = strlen(tbuf);
2597             }
2598             assert(!SvROK(sv));
2599             {
2600                 dVAR;
2601
2602 #ifdef FIXNEGATIVEZERO
2603                 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2604                     tbuf[0] = '0';
2605                     tbuf[1] = 0;
2606                     len = 1;
2607                 }
2608 #endif
2609                 SvUPGRADE(sv, SVt_PV);
2610                 if (lp)
2611                     *lp = len;
2612                 s = SvGROW_mutable(sv, len + 1);
2613                 SvCUR_set(sv, len);
2614                 SvPOKp_on(sv);
2615                 return (char*)memcpy(s, tbuf, len + 1);
2616             }
2617         }
2618         if (SvROK(sv)) {
2619             goto return_rok;
2620         }
2621         assert(SvTYPE(sv) >= SVt_PVMG);
2622         /* This falls through to the report_uninit near the end of the
2623            function. */
2624     } else if (SvTHINKFIRST(sv)) {
2625         if (SvROK(sv)) {
2626         return_rok:
2627             if (SvAMAGIC(sv)) {
2628                 SV *const tmpstr = AMG_CALLun(sv,string);
2629                 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2630                     /* Unwrap this:  */
2631                     /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2632                      */
2633
2634                     char *pv;
2635                     if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2636                         if (flags & SV_CONST_RETURN) {
2637                             pv = (char *) SvPVX_const(tmpstr);
2638                         } else {
2639                             pv = (flags & SV_MUTABLE_RETURN)
2640                                 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2641                         }
2642                         if (lp)
2643                             *lp = SvCUR(tmpstr);
2644                     } else {
2645                         pv = sv_2pv_flags(tmpstr, lp, flags);
2646                     }
2647                     if (SvUTF8(tmpstr))
2648                         SvUTF8_on(sv);
2649                     else
2650                         SvUTF8_off(sv);
2651                     return pv;
2652                 }
2653             }
2654             {
2655                 STRLEN len;
2656                 char *retval;
2657                 char *buffer;
2658                 MAGIC *mg;
2659                 const SV *const referent = (SV*)SvRV(sv);
2660
2661                 if (!referent) {
2662                     len = 7;
2663                     retval = buffer = savepvn("NULLREF", len);
2664                 } else if (SvTYPE(referent) == SVt_PVMG
2665                            && ((SvFLAGS(referent) &
2666                                 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2667                                == (SVs_OBJECT|SVs_SMG))
2668                            && (mg = mg_find(referent, PERL_MAGIC_qr)))
2669                 {
2670                     char *str = NULL;
2671                     I32 haseval = 0;
2672                     U32 flags = 0;
2673                     (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2674                     if (flags & 1)
2675                         SvUTF8_on(sv);
2676                     else
2677                         SvUTF8_off(sv);
2678                     PL_reginterp_cnt += haseval;
2679                     return str;
2680                 } else {
2681                     const char *const typestr = sv_reftype(referent, 0);
2682                     const STRLEN typelen = strlen(typestr);
2683                     UV addr = PTR2UV(referent);
2684                     const char *stashname = NULL;
2685                     STRLEN stashnamelen = 0; /* hush, gcc */
2686                     const char *buffer_end;
2687
2688                     if (SvOBJECT(referent)) {
2689                         const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2690
2691                         if (name) {
2692                             stashname = HEK_KEY(name);
2693                             stashnamelen = HEK_LEN(name);
2694
2695                             if (HEK_UTF8(name)) {
2696                                 SvUTF8_on(sv);
2697                             } else {
2698                                 SvUTF8_off(sv);
2699                             }
2700                         } else {
2701                             stashname = "__ANON__";
2702                             stashnamelen = 8;
2703                         }
2704                         len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2705                             + 2 * sizeof(UV) + 2 /* )\0 */;
2706                     } else {
2707                         len = typelen + 3 /* (0x */
2708                             + 2 * sizeof(UV) + 2 /* )\0 */;
2709                     }
2710
2711                     Newx(buffer, len, char);
2712                     buffer_end = retval = buffer + len;
2713
2714                     /* Working backwards  */
2715                     *--retval = '\0';
2716                     *--retval = ')';
2717                     do {
2718                         *--retval = PL_hexdigit[addr & 15];
2719                     } while (addr >>= 4);
2720                     *--retval = 'x';
2721                     *--retval = '0';
2722                     *--retval = '(';
2723
2724                     retval -= typelen;
2725                     memcpy(retval, typestr, typelen);
2726
2727                     if (stashname) {
2728                         *--retval = '=';
2729                         retval -= stashnamelen;
2730                         memcpy(retval, stashname, stashnamelen);
2731                     }
2732                     /* retval may not neccesarily have reached the start of the
2733                        buffer here.  */
2734                     assert (retval >= buffer);
2735
2736                     len = buffer_end - retval - 1; /* -1 for that \0  */
2737                 }
2738                 if (lp)
2739                     *lp = len;
2740                 SAVEFREEPV(buffer);
2741                 return retval;
2742             }
2743         }
2744         if (SvREADONLY(sv) && !SvOK(sv)) {
2745             if (ckWARN(WARN_UNINITIALIZED))
2746                 report_uninit(sv);
2747             if (lp)
2748                 *lp = 0;
2749             return (char *)"";
2750         }
2751     }
2752     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2753         /* I'm assuming that if both IV and NV are equally valid then
2754            converting the IV is going to be more efficient */
2755         const U32 isUIOK = SvIsUV(sv);
2756         char buf[TYPE_CHARS(UV)];
2757         char *ebuf, *ptr;
2758
2759         if (SvTYPE(sv) < SVt_PVIV)
2760             sv_upgrade(sv, SVt_PVIV);
2761         ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2762         /* inlined from sv_setpvn */
2763         SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2764         Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2765         SvCUR_set(sv, ebuf - ptr);
2766         s = SvEND(sv);
2767         *s = '\0';
2768     }
2769     else if (SvNOKp(sv)) {
2770         const int olderrno = errno;
2771         if (SvTYPE(sv) < SVt_PVNV)
2772             sv_upgrade(sv, SVt_PVNV);
2773         /* The +20 is pure guesswork.  Configure test needed. --jhi */
2774         s = SvGROW_mutable(sv, NV_DIG + 20);
2775         /* some Xenix systems wipe out errno here */
2776 #ifdef apollo
2777         if (SvNVX(sv) == 0.0)
2778             my_strlcpy(s, "0", SvLEN(sv));
2779         else
2780 #endif /*apollo*/
2781         {
2782             Gconvert(SvNVX(sv), NV_DIG, 0, s);
2783         }
2784         errno = olderrno;
2785 #ifdef FIXNEGATIVEZERO
2786         if (*s == '-' && s[1] == '0' && !s[2])
2787             my_strlcpy(s, "0", SvLEN(s));
2788 #endif
2789         while (*s) s++;
2790 #ifdef hcx
2791         if (s[-1] == '.')
2792             *--s = '\0';
2793 #endif
2794     }
2795     else {
2796         if (isGV_with_GP(sv))
2797             return glob_2pv((GV *)sv, lp);
2798
2799         if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2800             report_uninit(sv);
2801         if (lp)
2802             *lp = 0;
2803         if (SvTYPE(sv) < SVt_PV)
2804             /* Typically the caller expects that sv_any is not NULL now.  */
2805             sv_upgrade(sv, SVt_PV);
2806         return (char *)"";
2807     }
2808     {
2809         const STRLEN len = s - SvPVX_const(sv);
2810         if (lp)
2811             *lp = len;
2812         SvCUR_set(sv, len);
2813     }
2814     SvPOK_on(sv);
2815     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2816                           PTR2UV(sv),SvPVX_const(sv)));
2817     if (flags & SV_CONST_RETURN)
2818         return (char *)SvPVX_const(sv);
2819     if (flags & SV_MUTABLE_RETURN)
2820         return SvPVX_mutable(sv);
2821     return SvPVX(sv);
2822 }
2823
2824 /*
2825 =for apidoc sv_copypv
2826
2827 Copies a stringified representation of the source SV into the
2828 destination SV.  Automatically performs any necessary mg_get and
2829 coercion of numeric values into strings.  Guaranteed to preserve
2830 UTF-8 flag even from overloaded objects.  Similar in nature to
2831 sv_2pv[_flags] but operates directly on an SV instead of just the
2832 string.  Mostly uses sv_2pv_flags to do its work, except when that
2833 would lose the UTF-8'ness of the PV.
2834
2835 =cut
2836 */
2837
2838 void
2839 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2840 {
2841     STRLEN len;
2842     const char * const s = SvPV_const(ssv,len);
2843     sv_setpvn(dsv,s,len);
2844     if (SvUTF8(ssv))
2845         SvUTF8_on(dsv);
2846     else
2847         SvUTF8_off(dsv);
2848 }
2849
2850 /*
2851 =for apidoc sv_2pvbyte
2852
2853 Return a pointer to the byte-encoded representation of the SV, and set *lp
2854 to its length.  May cause the SV to be downgraded from UTF-8 as a
2855 side-effect.
2856
2857 Usually accessed via the C<SvPVbyte> macro.
2858
2859 =cut
2860 */
2861
2862 char *
2863 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2864 {
2865     sv_utf8_downgrade(sv,0);
2866     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2867 }
2868
2869 /*
2870 =for apidoc sv_2pvutf8
2871
2872 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2873 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
2874
2875 Usually accessed via the C<SvPVutf8> macro.
2876
2877 =cut
2878 */
2879
2880 char *
2881 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2882 {
2883     sv_utf8_upgrade(sv);
2884     return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2885 }
2886
2887
2888 /*
2889 =for apidoc sv_2bool
2890
2891 This function is only called on magical items, and is only used by
2892 sv_true() or its macro equivalent.
2893
2894 =cut
2895 */
2896
2897 bool
2898 Perl_sv_2bool(pTHX_ register SV *sv)
2899 {
2900     dVAR;
2901     SvGETMAGIC(sv);
2902
2903     if (!SvOK(sv))
2904         return 0;
2905     if (SvROK(sv)) {
2906         if (SvAMAGIC(sv)) {
2907             SV * const tmpsv = AMG_CALLun(sv,bool_);
2908             if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2909                 return (bool)SvTRUE(tmpsv);
2910         }
2911         return SvRV(sv) != 0;
2912     }
2913     if (SvPOKp(sv)) {
2914         register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2915         if (Xpvtmp &&
2916                 (*sv->sv_u.svu_pv > '0' ||
2917                 Xpvtmp->xpv_cur > 1 ||
2918                 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2919             return 1;
2920         else
2921             return 0;
2922     }
2923     else {
2924         if (SvIOKp(sv))
2925             return SvIVX(sv) != 0;
2926         else {
2927             if (SvNOKp(sv))
2928                 return SvNVX(sv) != 0.0;
2929             else {
2930                 if (isGV_with_GP(sv))
2931                     return TRUE;
2932                 else
2933                     return FALSE;
2934             }
2935         }
2936     }
2937 }
2938
2939 /*
2940 =for apidoc sv_utf8_upgrade
2941
2942 Converts the PV of an SV to its UTF-8-encoded form.
2943 Forces the SV to string form if it is not already.
2944 Always sets the SvUTF8 flag to avoid future validity checks even
2945 if all the bytes have hibit clear.
2946
2947 This is not as a general purpose byte encoding to Unicode interface:
2948 use the Encode extension for that.
2949
2950 =for apidoc sv_utf8_upgrade_flags
2951
2952 Converts the PV of an SV to its UTF-8-encoded form.
2953 Forces the SV to string form if it is not already.
2954 Always sets the SvUTF8 flag to avoid future validity checks even
2955 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2956 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2957 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2958
2959 This is not as a general purpose byte encoding to Unicode interface:
2960 use the Encode extension for that.
2961
2962 =cut
2963 */
2964
2965 STRLEN
2966 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2967 {
2968     dVAR;
2969     if (sv == &PL_sv_undef)
2970         return 0;
2971     if (!SvPOK(sv)) {
2972         STRLEN len = 0;
2973         if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2974             (void) sv_2pv_flags(sv,&len, flags);
2975             if (SvUTF8(sv))
2976                 return len;
2977         } else {
2978             (void) SvPV_force(sv,len);
2979         }
2980     }
2981
2982     if (SvUTF8(sv)) {
2983         return SvCUR(sv);
2984     }
2985
2986     if (SvIsCOW(sv)) {
2987         sv_force_normal_flags(sv, 0);
2988     }
2989
2990     if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2991         sv_recode_to_utf8(sv, PL_encoding);
2992     else { /* Assume Latin-1/EBCDIC */
2993         /* This function could be much more efficient if we
2994          * had a FLAG in SVs to signal if there are any hibit
2995          * chars in the PV.  Given that there isn't such a flag
2996          * make the loop as fast as possible. */
2997         const U8 * const s = (U8 *) SvPVX_const(sv);
2998         const U8 * const e = (U8 *) SvEND(sv);
2999         const U8 *t = s;
3000
3001         while (t < e) {
3002             const U8 ch = *t++;
3003             /* Check for hi bit */
3004             if (!NATIVE_IS_INVARIANT(ch)) {
3005                 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3006                 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3007
3008                 SvPV_free(sv); /* No longer using what was there before. */
3009                 SvPV_set(sv, (char*)recoded);
3010                 SvCUR_set(sv, len - 1);
3011                 SvLEN_set(sv, len); /* No longer know the real size. */
3012                 break;
3013             }
3014         }
3015         /* Mark as UTF-8 even if no hibit - saves scanning loop */
3016         SvUTF8_on(sv);
3017     }
3018     return SvCUR(sv);
3019 }
3020
3021 /*
3022 =for apidoc sv_utf8_downgrade
3023
3024 Attempts to convert the PV of an SV from characters to bytes.
3025 If the PV contains a character beyond byte, this conversion will fail;
3026 in this case, either returns false or, if C<fail_ok> is not
3027 true, croaks.
3028
3029 This is not as a general purpose Unicode to byte encoding interface:
3030 use the Encode extension for that.
3031
3032 =cut
3033 */
3034
3035 bool
3036 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3037 {
3038     dVAR;
3039     if (SvPOKp(sv) && SvUTF8(sv)) {
3040         if (SvCUR(sv)) {
3041             U8 *s;
3042             STRLEN len;
3043
3044             if (SvIsCOW(sv)) {
3045                 sv_force_normal_flags(sv, 0);
3046             }
3047             s = (U8 *) SvPV(sv, len);
3048             if (!utf8_to_bytes(s, &len)) {
3049                 if (fail_ok)
3050                     return FALSE;
3051                 else {
3052                     if (PL_op)
3053                         Perl_croak(aTHX_ "Wide character in %s",
3054                                    OP_DESC(PL_op));
3055                     else
3056                         Perl_croak(aTHX_ "Wide character");
3057                 }
3058             }
3059             SvCUR_set(sv, len);
3060         }
3061     }
3062     SvUTF8_off(sv);
3063     return TRUE;
3064 }
3065
3066 /*
3067 =for apidoc sv_utf8_encode
3068
3069 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3070 flag off so that it looks like octets again.
3071
3072 =cut
3073 */
3074
3075 void
3076 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3077 {
3078     if (SvIsCOW(sv)) {
3079         sv_force_normal_flags(sv, 0);
3080     }
3081     if (SvREADONLY(sv)) {
3082         Perl_croak(aTHX_ PL_no_modify);
3083     }
3084     (void) sv_utf8_upgrade(sv);
3085     SvUTF8_off(sv);
3086 }
3087
3088 /*
3089 =for apidoc sv_utf8_decode
3090
3091 If the PV of the SV is an octet sequence in UTF-8
3092 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3093 so that it looks like a character. If the PV contains only single-byte
3094 characters, the C<SvUTF8> flag stays being off.
3095 Scans PV for validity and returns false if the PV is invalid UTF-8.
3096
3097 =cut
3098 */
3099
3100 bool
3101 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3102 {
3103     if (SvPOKp(sv)) {
3104         const U8 *c;
3105         const U8 *e;
3106
3107         /* The octets may have got themselves encoded - get them back as
3108          * bytes
3109          */
3110         if (!sv_utf8_downgrade(sv, TRUE))
3111             return FALSE;
3112
3113         /* it is actually just a matter of turning the utf8 flag on, but
3114          * we want to make sure everything inside is valid utf8 first.
3115          */
3116         c = (const U8 *) SvPVX_const(sv);
3117         if (!is_utf8_string(c, SvCUR(sv)+1))
3118             return FALSE;
3119         e = (const U8 *) SvEND(sv);
3120         while (c < e) {
3121             const U8 ch = *c++;
3122             if (!UTF8_IS_INVARIANT(ch)) {
3123                 SvUTF8_on(sv);
3124                 break;
3125             }
3126         }
3127     }
3128     return TRUE;
3129 }
3130
3131 /*
3132 =for apidoc sv_setsv
3133
3134 Copies the contents of the source SV C<ssv> into the destination SV
3135 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3136 function if the source SV needs to be reused. Does not handle 'set' magic.
3137 Loosely speaking, it performs a copy-by-value, obliterating any previous
3138 content of the destination.
3139
3140 You probably want to use one of the assortment of wrappers, such as
3141 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3142 C<SvSetMagicSV_nosteal>.
3143
3144 =for apidoc sv_setsv_flags
3145
3146 Copies the contents of the source SV C<ssv> into the destination SV
3147 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3148 function if the source SV needs to be reused. Does not handle 'set' magic.
3149 Loosely speaking, it performs a copy-by-value, obliterating any previous
3150 content of the destination.
3151 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3152 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3153 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3154 and C<sv_setsv_nomg> are implemented in terms of this function.
3155
3156 You probably want to use one of the assortment of wrappers, such as
3157 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3158 C<SvSetMagicSV_nosteal>.
3159
3160 This is the primary function for copying scalars, and most other
3161 copy-ish functions and macros use this underneath.
3162
3163 =cut
3164 */
3165
3166 static void
3167 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3168 {
3169     if (dtype != SVt_PVGV) {
3170         const char * const name = GvNAME(sstr);
3171         const STRLEN len = GvNAMELEN(sstr);
3172         /* don't upgrade SVt_PVLV: it can hold a glob */
3173         if (dtype != SVt_PVLV) {
3174             if (dtype >= SVt_PV) {
3175                 SvPV_free(dstr);
3176                 SvPV_set(dstr, 0);
3177                 SvLEN_set(dstr, 0);
3178                 SvCUR_set(dstr, 0);
3179             }
3180             sv_upgrade(dstr, SVt_PVGV);
3181             (void)SvOK_off(dstr);
3182             SvSCREAM_on(dstr);
3183         }
3184         GvSTASH(dstr) = GvSTASH(sstr);
3185         if (GvSTASH(dstr))
3186             Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3187         gv_name_set((GV *)dstr, name, len, GV_ADD);
3188         SvFAKE_on(dstr);        /* can coerce to non-glob */
3189     }
3190
3191 #ifdef GV_UNIQUE_CHECK
3192     if (GvUNIQUE((GV*)dstr)) {
3193         Perl_croak(aTHX_ PL_no_modify);
3194     }
3195 #endif
3196
3197     gp_free((GV*)dstr);
3198     SvSCREAM_off(dstr);
3199     (void)SvOK_off(dstr);
3200     SvSCREAM_on(dstr);
3201     GvINTRO_off(dstr);          /* one-shot flag */
3202     GvGP(dstr) = gp_ref(GvGP(sstr));
3203     if (SvTAINTED(sstr))
3204         SvTAINT(dstr);
3205     if (GvIMPORTED(dstr) != GVf_IMPORTED
3206         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3207         {
3208             GvIMPORTED_on(dstr);
3209         }
3210     GvMULTI_on(dstr);
3211     return;
3212 }
3213
3214 static void
3215 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3216     SV * const sref = SvREFCNT_inc(SvRV(sstr));
3217     SV *dref = NULL;
3218     const int intro = GvINTRO(dstr);
3219     SV **location;
3220     U8 import_flag = 0;
3221     const U32 stype = SvTYPE(sref);
3222
3223
3224 #ifdef GV_UNIQUE_CHECK
3225     if (GvUNIQUE((GV*)dstr)) {
3226         Perl_croak(aTHX_ PL_no_modify);
3227     }
3228 #endif
3229
3230     if (intro) {
3231         GvINTRO_off(dstr);      /* one-shot flag */
3232         GvLINE(dstr) = CopLINE(PL_curcop);
3233         GvEGV(dstr) = (GV*)dstr;
3234     }
3235     GvMULTI_on(dstr);
3236     switch (stype) {
3237     case SVt_PVCV:
3238         location = (SV **) &GvCV(dstr);
3239         import_flag = GVf_IMPORTED_CV;
3240         goto common;
3241     case SVt_PVHV:
3242         location = (SV **) &GvHV(dstr);
3243         import_flag = GVf_IMPORTED_HV;
3244         goto common;
3245     case SVt_PVAV:
3246         location = (SV **) &GvAV(dstr);
3247         import_flag = GVf_IMPORTED_AV;
3248         goto common;
3249     case SVt_PVIO:
3250         location = (SV **) &GvIOp(dstr);
3251         goto common;
3252     case SVt_PVFM:
3253         location = (SV **) &GvFORM(dstr);
3254     default:
3255         location = &GvSV(dstr);
3256         import_flag = GVf_IMPORTED_SV;
3257     common:
3258         if (intro) {
3259             if (stype == SVt_PVCV) {
3260                 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3261                     SvREFCNT_dec(GvCV(dstr));
3262                     GvCV(dstr) = NULL;
3263                     GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3264                     PL_sub_generation++;
3265                 }
3266             }
3267             SAVEGENERICSV(*location);
3268         }
3269         else
3270             dref = *location;
3271         if (stype == SVt_PVCV && *location != sref) {
3272             CV* const cv = (CV*)*location;
3273             if (cv) {
3274                 if (!GvCVGEN((GV*)dstr) &&
3275                     (CvROOT(cv) || CvXSUB(cv)))
3276                     {
3277                         /* Redefining a sub - warning is mandatory if
3278                            it was a const and its value changed. */
3279                         if (CvCONST(cv) && CvCONST((CV*)sref)
3280                             && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3281                             NOOP;
3282                             /* They are 2 constant subroutines generated from
3283                                the same constant. This probably means that
3284                                they are really the "same" proxy subroutine
3285                                instantiated in 2 places. Most likely this is
3286                                when a constant is exported twice.  Don't warn.
3287                             */
3288                         }
3289                         else if (ckWARN(WARN_REDEFINE)
3290                                  || (CvCONST(cv)
3291                                      && (!CvCONST((CV*)sref)
3292                                          || sv_cmp(cv_const_sv(cv),
3293                                                    cv_const_sv((CV*)sref))))) {
3294                             Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3295                                         (const char *)
3296                                         (CvCONST(cv)
3297                                          ? "Constant subroutine %s::%s redefined"
3298                                          : "Subroutine %s::%s redefined"),
3299                                         HvNAME_get(GvSTASH((GV*)dstr)),
3300                                         GvENAME((GV*)dstr));
3301                         }
3302                     }
3303                 if (!intro)
3304                     cv_ckproto_len(cv, (GV*)dstr,
3305                                    SvPOK(sref) ? SvPVX_const(sref) : NULL,
3306                                    SvPOK(sref) ? SvCUR(sref) : 0);
3307             }
3308             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3309             GvASSUMECV_on(dstr);
3310             PL_sub_generation++;
3311         }
3312         *location = sref;
3313         if (import_flag && !(GvFLAGS(dstr) & import_flag)
3314             && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3315             GvFLAGS(dstr) |= import_flag;
3316         }
3317         break;
3318     }
3319     SvREFCNT_dec(dref);
3320     if (SvTAINTED(sstr))
3321         SvTAINT(dstr);
3322     return;
3323 }
3324
3325 void
3326 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3327 {
3328     dVAR;
3329     register U32 sflags;
3330     register int dtype;
3331     register svtype stype;
3332
3333     if (sstr == dstr)
3334         return;
3335
3336     if (SvIS_FREED(dstr)) {
3337         Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3338                    " to a freed scalar %p", sstr, dstr);
3339     }
3340     SV_CHECK_THINKFIRST_COW_DROP(dstr);
3341     if (!sstr)
3342         sstr = &PL_sv_undef;
3343     if (SvIS_FREED(sstr)) {
3344         Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p", sstr,
3345                    dstr);
3346     }
3347     stype = SvTYPE(sstr);
3348     dtype = SvTYPE(dstr);
3349
3350     SvAMAGIC_off(dstr);
3351     if ( SvVOK(dstr) )
3352     {
3353         /* need to nuke the magic */
3354         mg_free(dstr);
3355         SvRMAGICAL_off(dstr);
3356     }
3357
3358     /* There's a lot of redundancy below but we're going for speed here */
3359
3360     switch (stype) {
3361     case SVt_NULL:
3362       undef_sstr:
3363         if (dtype != SVt_PVGV) {
3364             (void)SvOK_off(dstr);
3365             return;
3366         }
3367         break;
3368     case SVt_IV:
3369         if (SvIOK(sstr)) {
3370             switch (dtype) {
3371             case SVt_NULL:
3372                 sv_upgrade(dstr, SVt_IV);
3373                 break;
3374             case SVt_NV:
3375             case SVt_RV:
3376             case SVt_PV:
3377                 sv_upgrade(dstr, SVt_PVIV);
3378                 break;
3379             }
3380             (void)SvIOK_only(dstr);
3381             SvIV_set(dstr,  SvIVX(sstr));
3382             if (SvIsUV(sstr))
3383                 SvIsUV_on(dstr);
3384             /* SvTAINTED can only be true if the SV has taint magic, which in
3385                turn means that the SV type is PVMG (or greater). This is the
3386                case statement for SVt_IV, so this cannot be true (whatever gcov
3387                may say).  */
3388             assert(!SvTAINTED(sstr));
3389             return;
3390         }
3391         goto undef_sstr;
3392
3393     case SVt_NV:
3394         if (SvNOK(sstr)) {
3395             switch (dtype) {
3396             case SVt_NULL:
3397             case SVt_IV:
3398                 sv_upgrade(dstr, SVt_NV);
3399                 break;
3400             case SVt_RV:
3401             case SVt_PV:
3402             case SVt_PVIV:
3403                 sv_upgrade(dstr, SVt_PVNV);
3404                 break;
3405             }
3406             SvNV_set(dstr, SvNVX(sstr));
3407             (void)SvNOK_only(dstr);
3408             /* SvTAINTED can only be true if the SV has taint magic, which in
3409                turn means that the SV type is PVMG (or greater). This is the
3410                case statement for SVt_NV, so this cannot be true (whatever gcov
3411                may say).  */
3412             assert(!SvTAINTED(sstr));
3413             return;
3414         }
3415         goto undef_sstr;
3416
3417     case SVt_RV:
3418         if (dtype < SVt_RV)
3419             sv_upgrade(dstr, SVt_RV);
3420         break;
3421     case SVt_PVFM:
3422 #ifdef PERL_OLD_COPY_ON_WRITE
3423         if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3424             if (dtype < SVt_PVIV)
3425                 sv_upgrade(dstr, SVt_PVIV);
3426             break;
3427         }
3428         /* Fall through */
3429 #endif
3430     case SVt_PV:
3431         if (dtype < SVt_PV)
3432             sv_upgrade(dstr, SVt_PV);
3433         break;
3434     case SVt_PVIV:
3435         if (dtype < SVt_PVIV)
3436             sv_upgrade(dstr, SVt_PVIV);
3437         break;
3438     case SVt_PVNV:
3439         if (dtype < SVt_PVNV)
3440             sv_upgrade(dstr, SVt_PVNV);
3441         break;
3442     default:
3443         {
3444         const char * const type = sv_reftype(sstr,0);
3445         if (PL_op)
3446             Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3447         else
3448             Perl_croak(aTHX_ "Bizarre copy of %s", type);
3449         }
3450         break;
3451
3452     case SVt_PVGV:
3453         if (dtype <= SVt_PVGV) {
3454             glob_assign_glob(dstr, sstr, dtype);
3455             return;
3456         }
3457         /*FALLTHROUGH*/
3458
3459     case SVt_PVMG:
3460     case SVt_PVLV:
3461     case SVt_PVBM:
3462         if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3463             mg_get(sstr);
3464             if (SvTYPE(sstr) != stype) {
3465                 stype = SvTYPE(sstr);
3466                 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3467                     glob_assign_glob(dstr, sstr, dtype);
3468                     return;
3469                 }
3470             }
3471         }
3472         if (stype == SVt_PVLV)
3473             SvUPGRADE(dstr, SVt_PVNV);
3474         else
3475             SvUPGRADE(dstr, (svtype)stype);
3476     }
3477
3478     /* dstr may have been upgraded.  */
3479     dtype = SvTYPE(dstr);
3480     sflags = SvFLAGS(sstr);
3481
3482     if (dtype == SVt_PVCV) {
3483         /* Assigning to a subroutine sets the prototype.  */
3484         if (SvOK(sstr)) {
3485             STRLEN len;
3486             const char *const ptr = SvPV_const(sstr, len);
3487
3488             SvGROW(dstr, len + 1);
3489             Copy(ptr, SvPVX(dstr), len + 1, char);
3490             SvCUR_set(dstr, len);
3491             SvPOK_only(dstr);
3492         } else {
3493             SvOK_off(dstr);
3494         }
3495     } else if (sflags & SVf_ROK) {
3496         if (dtype == SVt_PVGV && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3497             sstr = SvRV(sstr);
3498             if (sstr == dstr) {
3499                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3500                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3501                 {
3502                     GvIMPORTED_on(dstr);
3503                 }
3504                 GvMULTI_on(dstr);
3505                 return;
3506             }
3507             glob_assign_glob(dstr, sstr, dtype);
3508             return;
3509         }
3510
3511         if (dtype >= SVt_PV) {
3512             if (dtype == SVt_PVGV) {
3513                 glob_assign_ref(dstr, sstr);
3514                 return;
3515             }
3516             if (SvPVX_const(dstr)) {
3517                 SvPV_free(dstr);
3518                 SvLEN_set(dstr, 0);
3519                 SvCUR_set(dstr, 0);
3520             }
3521         }
3522         (void)SvOK_off(dstr);
3523         SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3524         SvFLAGS(dstr) |= sflags & SVf_ROK;
3525         assert(!(sflags & SVp_NOK));
3526         assert(!(sflags & SVp_IOK));
3527         assert(!(sflags & SVf_NOK));
3528         assert(!(sflags & SVf_IOK));
3529     }
3530     else if (dtype == SVt_PVGV) {
3531         if (!(sflags & SVf_OK)) {
3532             if (ckWARN(WARN_MISC))
3533                 Perl_warner(aTHX_ packWARN(WARN_MISC),
3534                             "Undefined value assigned to typeglob");
3535         }
3536         else {
3537             GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3538             if (dstr != (SV*)gv) {
3539                 if (GvGP(dstr))
3540                     gp_free((GV*)dstr);
3541                 GvGP(dstr) = gp_ref(GvGP(gv));
3542             }
3543         }
3544     }
3545     else if (sflags & SVp_POK) {
3546         bool isSwipe = 0;
3547
3548         /*
3549          * Check to see if we can just swipe the string.  If so, it's a
3550          * possible small lose on short strings, but a big win on long ones.
3551          * It might even be a win on short strings if SvPVX_const(dstr)
3552          * has to be allocated and SvPVX_const(sstr) has to be freed.
3553          * Likewise if we can set up COW rather than doing an actual copy, we
3554          * drop to the else clause, as the swipe code and the COW setup code
3555          * have much in common.
3556          */
3557
3558         /* Whichever path we take through the next code, we want this true,
3559            and doing it now facilitates the COW check.  */
3560         (void)SvPOK_only(dstr);
3561
3562         if (
3563             /* If we're already COW then this clause is not true, and if COW
3564                is allowed then we drop down to the else and make dest COW
3565                with us.  If caller hasn't said that we're allowed to COW
3566                shared hash keys then we don't do the COW setup, even if the
3567                source scalar is a shared hash key scalar.  */
3568             (((flags & SV_COW_SHARED_HASH_KEYS)
3569                ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3570                : 1 /* If making a COW copy is forbidden then the behaviour we
3571                        desire is as if the source SV isn't actually already
3572                        COW, even if it is.  So we act as if the source flags
3573                        are not COW, rather than actually testing them.  */
3574               )
3575 #ifndef PERL_OLD_COPY_ON_WRITE
3576              /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3577                 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3578                 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3579                 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3580                 but in turn, it's somewhat dead code, never expected to go
3581                 live, but more kept as a placeholder on how to do it better
3582                 in a newer implementation.  */
3583              /* If we are COW and dstr is a suitable target then we drop down
3584                 into the else and make dest a COW of us.  */
3585              || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3586 #endif
3587              )
3588             &&
3589             !(isSwipe =
3590                  (sflags & SVs_TEMP) &&   /* slated for free anyway? */
3591                  !(sflags & SVf_OOK) &&   /* and not involved in OOK hack? */
3592                  (!(flags & SV_NOSTEAL)) &&
3593                                         /* and we're allowed to steal temps */
3594                  SvREFCNT(sstr) == 1 &&   /* and no other references to it? */
3595                  SvLEN(sstr)    &&        /* and really is a string */
3596                                 /* and won't be needed again, potentially */
3597               !(PL_op && PL_op->op_type == OP_AASSIGN))
3598 #ifdef PERL_OLD_COPY_ON_WRITE
3599             && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3600                  && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3601                  && SvTYPE(sstr) >= SVt_PVIV)
3602 #endif
3603             ) {
3604             /* Failed the swipe test, and it's not a shared hash key either.
3605                Have to copy the string.  */
3606             STRLEN len = SvCUR(sstr);
3607             SvGROW(dstr, len + 1);      /* inlined from sv_setpvn */
3608             Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3609             SvCUR_set(dstr, len);
3610             *SvEND(dstr) = '\0';
3611         } else {
3612             /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3613                be true in here.  */
3614             /* Either it's a shared hash key, or it's suitable for
3615                copy-on-write or we can swipe the string.  */
3616             if (DEBUG_C_TEST) {
3617                 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3618                 sv_dump(sstr);
3619                 sv_dump(dstr);
3620             }
3621 #ifdef PERL_OLD_COPY_ON_WRITE
3622             if (!isSwipe) {
3623                 /* I believe I should acquire a global SV mutex if
3624                    it's a COW sv (not a shared hash key) to stop
3625                    it going un copy-on-write.
3626                    If the source SV has gone un copy on write between up there
3627                    and down here, then (assert() that) it is of the correct
3628                    form to make it copy on write again */
3629                 if ((sflags & (SVf_FAKE | SVf_READONLY))
3630                     != (SVf_FAKE | SVf_READONLY)) {
3631                     SvREADONLY_on(sstr);
3632                     SvFAKE_on(sstr);
3633                     /* Make the source SV into a loop of 1.
3634                        (about to become 2) */
3635                     SV_COW_NEXT_SV_SET(sstr, sstr);
3636                 }
3637             }
3638 #endif
3639             /* Initial code is common.  */
3640             if (SvPVX_const(dstr)) {    /* we know that dtype >= SVt_PV */
3641                 SvPV_free(dstr);
3642             }
3643
3644             if (!isSwipe) {
3645                 /* making another shared SV.  */
3646                 STRLEN cur = SvCUR(sstr);
3647                 STRLEN len = SvLEN(sstr);
3648 #ifdef PERL_OLD_COPY_ON_WRITE
3649                 if (len) {
3650                     assert (SvTYPE(dstr) >= SVt_PVIV);
3651                     /* SvIsCOW_normal */
3652                     /* splice us in between source and next-after-source.  */
3653                     SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3654                     SV_COW_NEXT_SV_SET(sstr, dstr);
3655                     SvPV_set(dstr, SvPVX_mutable(sstr));
3656                 } else
3657 #endif
3658                 {
3659                     /* SvIsCOW_shared_hash */
3660                     DEBUG_C(PerlIO_printf(Perl_debug_log,
3661                                           "Copy on write: Sharing hash\n"));
3662
3663                     assert (SvTYPE(dstr) >= SVt_PV);
3664                     SvPV_set(dstr,
3665                              HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3666                 }
3667                 SvLEN_set(dstr, len);
3668                 SvCUR_set(dstr, cur);
3669                 SvREADONLY_on(dstr);
3670                 SvFAKE_on(dstr);
3671                 /* Relesase a global SV mutex.  */
3672             }
3673             else
3674                 {       /* Passes the swipe test.  */
3675                 SvPV_set(dstr, SvPVX_mutable(sstr));
3676                 SvLEN_set(dstr, SvLEN(sstr));
3677                 SvCUR_set(dstr, SvCUR(sstr));
3678
3679                 SvTEMP_off(dstr);
3680                 (void)SvOK_off(sstr);   /* NOTE: nukes most SvFLAGS on sstr */
3681                 SvPV_set(sstr, NULL);
3682                 SvLEN_set(sstr, 0);
3683                 SvCUR_set(sstr, 0);
3684                 SvTEMP_off(sstr);
3685             }
3686         }
3687         if (sflags & SVp_NOK) {
3688             SvNV_set(dstr, SvNVX(sstr));
3689         }
3690         if (sflags & SVp_IOK) {
3691             SvRELEASE_IVX(dstr);
3692             SvIV_set(dstr, SvIVX(sstr));
3693             /* Must do this otherwise some other overloaded use of 0x80000000
3694                gets confused. I guess SVpbm_VALID */
3695             if (sflags & SVf_IVisUV)
3696                 SvIsUV_on(dstr);
3697         }
3698         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3699         {
3700             const MAGIC * const smg = SvVSTRING_mg(sstr);
3701             if (smg) {
3702                 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3703                          smg->mg_ptr, smg->mg_len);
3704                 SvRMAGICAL_on(dstr);
3705             }
3706         }
3707     }
3708     else if (sflags & (SVp_IOK|SVp_NOK)) {
3709         (void)SvOK_off(dstr);
3710         SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3711         if (sflags & SVp_IOK) {
3712             /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
3713             SvIV_set(dstr, SvIVX(sstr));
3714         }
3715         if (sflags & SVp_NOK) {
3716             SvNV_set(dstr, SvNVX(sstr));
3717         }
3718     }
3719     else {
3720         if (isGV_with_GP(sstr)) {
3721             /* This stringification rule for globs is spread in 3 places.
3722                This feels bad. FIXME.  */
3723             const U32 wasfake = sflags & SVf_FAKE;
3724
3725             /* FAKE globs can get coerced, so need to turn this off
3726                temporarily if it is on.  */
3727             SvFAKE_off(sstr);
3728             gv_efullname3(dstr, (GV *)sstr, "*");
3729             SvFLAGS(sstr) |= wasfake;
3730         }
3731         else
3732             (void)SvOK_off(dstr);
3733     }
3734     if (SvTAINTED(sstr))
3735         SvTAINT(dstr);
3736 }
3737
3738 /*
3739 =for apidoc sv_setsv_mg
3740
3741 Like C<sv_setsv>, but also handles 'set' magic.
3742
3743 =cut
3744 */
3745
3746 void
3747 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3748 {
3749     sv_setsv(dstr,sstr);
3750     SvSETMAGIC(dstr);
3751 }
3752
3753 #ifdef PERL_OLD_COPY_ON_WRITE
3754 SV *
3755 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3756 {
3757     STRLEN cur = SvCUR(sstr);
3758     STRLEN len = SvLEN(sstr);
3759     register char *new_pv;
3760
3761     if (DEBUG_C_TEST) {
3762         PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3763                       sstr, dstr);
3764         sv_dump(sstr);
3765         if (dstr)
3766                     sv_dump(dstr);
3767     }
3768
3769     if (dstr) {
3770         if (SvTHINKFIRST(dstr))
3771             sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3772         else if (SvPVX_const(dstr))
3773             Safefree(SvPVX_const(dstr));
3774     }
3775     else
3776         new_SV(dstr);
3777     SvUPGRADE(dstr, SVt_PVIV);
3778
3779     assert (SvPOK(sstr));
3780     assert (SvPOKp(sstr));
3781     assert (!SvIOK(sstr));
3782     assert (!SvIOKp(sstr));
3783     assert (!SvNOK(sstr));
3784     assert (!SvNOKp(sstr));
3785
3786     if (SvIsCOW(sstr)) {
3787
3788         if (SvLEN(sstr) == 0) {
3789             /* source is a COW shared hash key.  */
3790             DEBUG_C(PerlIO_printf(Perl_debug_log,
3791                                   "Fast copy on write: Sharing hash\n"));
3792             new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3793             goto common_exit;
3794         }
3795         SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3796     } else {
3797         assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3798         SvUPGRADE(sstr, SVt_PVIV);
3799         SvREADONLY_on(sstr);
3800         SvFAKE_on(sstr);
3801         DEBUG_C(PerlIO_printf(Perl_debug_log,
3802                               "Fast copy on write: Converting sstr to COW\n"));
3803         SV_COW_NEXT_SV_SET(dstr, sstr);
3804     }
3805     SV_COW_NEXT_SV_SET(sstr, dstr);
3806     new_pv = SvPVX_mutable(sstr);
3807
3808   common_exit:
3809     SvPV_set(dstr, new_pv);
3810     SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3811     if (SvUTF8(sstr))
3812         SvUTF8_on(dstr);
3813     SvLEN_set(dstr, len);
3814     SvCUR_set(dstr, cur);
3815     if (DEBUG_C_TEST) {
3816         sv_dump(dstr);
3817     }
3818     return dstr;
3819 }
3820 #endif
3821
3822 /*
3823 =for apidoc sv_setpvn
3824
3825 Copies a string into an SV.  The C<len> parameter indicates the number of
3826 bytes to be copied.  If the C<ptr> argument is NULL the SV will become
3827 undefined.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
3828
3829 =cut
3830 */
3831
3832 void
3833 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3834 {
3835     dVAR;
3836     register char *dptr;
3837
3838     SV_CHECK_THINKFIRST_COW_DROP(sv);
3839     if (!ptr) {
3840         (void)SvOK_off(sv);
3841         return;
3842     }
3843     else {
3844         /* len is STRLEN which is unsigned, need to copy to signed */
3845         const IV iv = len;
3846         if (iv < 0)
3847             Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3848     }
3849     SvUPGRADE(sv, SVt_PV);
3850
3851     dptr = SvGROW(sv, len + 1);
3852     Move(ptr,dptr,len,char);
3853     dptr[len] = '\0';
3854     SvCUR_set(sv, len);
3855     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3856     SvTAINT(sv);
3857 }
3858
3859 /*
3860 =for apidoc sv_setpvn_mg
3861
3862 Like C<sv_setpvn>, but also handles 'set' magic.
3863
3864 =cut
3865 */
3866
3867 void
3868 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3869 {
3870     sv_setpvn(sv,ptr,len);
3871     SvSETMAGIC(sv);
3872 }
3873
3874 /*
3875 =for apidoc sv_setpv
3876
3877 Copies a string into an SV.  The string must be null-terminated.  Does not
3878 handle 'set' magic.  See C<sv_setpv_mg>.
3879
3880 =cut
3881 */
3882
3883 void
3884 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3885 {
3886     dVAR;
3887     register STRLEN len;
3888
3889     SV_CHECK_THINKFIRST_COW_DROP(sv);
3890     if (!ptr) {
3891         (void)SvOK_off(sv);
3892         return;
3893     }
3894     len = strlen(ptr);
3895     SvUPGRADE(sv, SVt_PV);
3896
3897     SvGROW(sv, len + 1);
3898     Move(ptr,SvPVX(sv),len+1,char);
3899     SvCUR_set(sv, len);
3900     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3901     SvTAINT(sv);
3902 }
3903
3904 /*
3905 =for apidoc sv_setpv_mg
3906
3907 Like C<sv_setpv>, but also handles 'set' magic.
3908
3909 =cut
3910 */
3911
3912 void
3913 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3914 {
3915     sv_setpv(sv,ptr);
3916     SvSETMAGIC(sv);
3917 }
3918
3919 /*
3920 =for apidoc sv_usepvn_flags
3921
3922 Tells an SV to use C<ptr> to find its string value.  Normally the
3923 string is stored inside the SV but sv_usepvn allows the SV to use an
3924 outside string.  The C<ptr> should point to memory that was allocated
3925 by C<malloc>.  The string length, C<len>, must be supplied.  By default
3926 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3927 so that pointer should not be freed or used by the programmer after
3928 giving it to sv_usepvn, and neither should any pointers from "behind"
3929 that pointer (e.g. ptr + 1) be used.
3930
3931 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3932 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3933 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3934 C<len>, and already meets the requirements for storing in C<SvPVX>)
3935
3936 =cut
3937 */
3938
3939 void
3940 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3941 {
3942     dVAR;
3943     STRLEN allocate;
3944     SV_CHECK_THINKFIRST_COW_DROP(sv);
3945     SvUPGRADE(sv, SVt_PV);
3946     if (!ptr) {
3947         (void)SvOK_off(sv);
3948         if (flags & SV_SMAGIC)
3949             SvSETMAGIC(sv);
3950         return;
3951     }
3952     if (SvPVX_const(sv))
3953         SvPV_free(sv);
3954
3955 #ifdef DEBUGGING
3956     if (flags & SV_HAS_TRAILING_NUL)
3957         assert(ptr[len] == '\0');
3958 #endif
3959
3960     allocate = (flags & SV_HAS_TRAILING_NUL)
3961         ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3962     if (flags & SV_HAS_TRAILING_NUL) {
3963         /* It's long enough - do nothing.
3964            Specfically Perl_newCONSTSUB is relying on this.  */
3965     } else {
3966 #ifdef DEBUGGING
3967         /* Force a move to shake out bugs in callers.  */
3968         char *new_ptr = (char*)safemalloc(allocate);
3969         Copy(ptr, new_ptr, len, char);
3970         PoisonFree(ptr,len,char);
3971         Safefree(ptr);
3972         ptr = new_ptr;
3973 #else
3974         ptr = (char*) saferealloc (ptr, allocate);
3975 #endif
3976     }
3977     SvPV_set(sv, ptr);
3978     SvCUR_set(sv, len);
3979     SvLEN_set(sv, allocate);
3980     if (!(flags & SV_HAS_TRAILING_NUL)) {
3981         *SvEND(sv) = '\0';
3982     }
3983     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3984     SvTAINT(sv);
3985     if (flags & SV_SMAGIC)
3986         SvSETMAGIC(sv);
3987 }
3988
3989 #ifdef PERL_OLD_COPY_ON_WRITE
3990 /* Need to do this *after* making the SV normal, as we need the buffer
3991    pointer to remain valid until after we've copied it.  If we let go too early,
3992    another thread could invalidate it by unsharing last of the same hash key
3993    (which it can do by means other than releasing copy-on-write Svs)
3994    or by changing the other copy-on-write SVs in the loop.  */
3995 STATIC void
3996 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3997 {
3998     if (len) { /* this SV was SvIsCOW_normal(sv) */
3999          /* we need to find the SV pointing to us.  */
4000         SV *current = SV_COW_NEXT_SV(after);
4001
4002         if (current == sv) {
4003             /* The SV we point to points back to us (there were only two of us
4004                in the loop.)
4005                Hence other SV is no longer copy on write either.  */
4006             SvFAKE_off(after);
4007             SvREADONLY_off(after);
4008         } else {
4009             /* We need to follow the pointers around the loop.  */
4010             SV *next;
4011             while ((next = SV_COW_NEXT_SV(current)) != sv) {
4012                 assert (next);
4013                 current = next;
4014                  /* don't loop forever if the structure is bust, and we have
4015                     a pointer into a closed loop.  */
4016                 assert (current != after);
4017                 assert (SvPVX_const(current) == pvx);
4018             }
4019             /* Make the SV before us point to the SV after us.  */
4020             SV_COW_NEXT_SV_SET(current, after);
4021         }
4022     } else {
4023         unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4024     }
4025 }
4026
4027 int
4028 Perl_sv_release_IVX(pTHX_ register SV *sv)
4029 {
4030     if (SvIsCOW(sv))
4031         sv_force_normal_flags(sv, 0);
4032     SvOOK_off(sv);
4033     return 0;
4034 }
4035 #endif
4036 /*
4037 =for apidoc sv_force_normal_flags
4038
4039 Undo various types of fakery on an SV: if the PV is a shared string, make
4040 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4041 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4042 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4043 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4044 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4045 set to some other value.) In addition, the C<flags> parameter gets passed to
4046 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4047 with flags set to 0.
4048
4049 =cut
4050 */
4051
4052 void
4053 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4054 {
4055     dVAR;
4056 #ifdef PERL_OLD_COPY_ON_WRITE
4057     if (SvREADONLY(sv)) {
4058         /* At this point I believe I should acquire a global SV mutex.  */
4059         if (SvFAKE(sv)) {
4060             const char * const pvx = SvPVX_const(sv);
4061             const STRLEN len = SvLEN(sv);
4062             const STRLEN cur = SvCUR(sv);
4063             SV * const next = SV_COW_NEXT_SV(sv);   /* next COW sv in the loop. */
4064             if (DEBUG_C_TEST) {
4065                 PerlIO_printf(Perl_debug_log,
4066                               "Copy on write: Force normal %ld\n",
4067                               (long) flags);
4068                 sv_dump(sv);
4069             }
4070             SvFAKE_off(sv);
4071             SvREADONLY_off(sv);
4072             /* This SV doesn't own the buffer, so need to Newx() a new one:  */
4073             SvPV_set(sv, NULL);
4074             SvLEN_set(sv, 0);
4075             if (flags & SV_COW_DROP_PV) {
4076                 /* OK, so we don't need to copy our buffer.  */
4077                 SvPOK_off(sv);
4078             } else {
4079                 SvGROW(sv, cur + 1);
4080                 Move(pvx,SvPVX(sv),cur,char);
4081                 SvCUR_set(sv, cur);
4082                 *SvEND(sv) = '\0';
4083             }
4084             sv_release_COW(sv, pvx, len, next);
4085             if (DEBUG_C_TEST) {
4086                 sv_dump(sv);
4087             }
4088         }
4089         else if (IN_PERL_RUNTIME)
4090             Perl_croak(aTHX_ PL_no_modify);
4091         /* At this point I believe that I can drop the global SV mutex.  */
4092     }
4093 #else
4094     if (SvREADONLY(sv)) {
4095         if (SvFAKE(sv)) {
4096             const char * const pvx = SvPVX_const(sv);
4097             const STRLEN len = SvCUR(sv);
4098             SvFAKE_off(sv);
4099             SvREADONLY_off(sv);
4100             SvPV_set(sv, NULL);
4101             SvLEN_set(sv, 0);
4102             SvGROW(sv, len + 1);
4103             Move(pvx,SvPVX(sv),len,char);
4104             *SvEND(sv) = '\0';
4105             unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4106         }
4107         else if (IN_PERL_RUNTIME)
4108             Perl_croak(aTHX_ PL_no_modify);
4109     }
4110 #endif
4111     if (SvROK(sv))
4112         sv_unref_flags(sv, flags);
4113     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4114         sv_unglob(sv);
4115 }
4116
4117 /*
4118 =for apidoc sv_chop
4119
4120 Efficient removal of characters from the beginning of the string buffer.
4121 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4122 the string buffer.  The C<ptr> becomes the first character of the adjusted
4123 string. Uses the "OOK hack".
4124 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4125 refer to the same chunk of data.
4126
4127 =cut
4128 */
4129
4130 void
4131 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4132 {
4133     register STRLEN delta;
4134     if (!ptr || !SvPOKp(sv))
4135         return;
4136     delta = ptr - SvPVX_const(sv);
4137     SV_CHECK_THINKFIRST(sv);
4138     if (SvTYPE(sv) < SVt_PVIV)
4139         sv_upgrade(sv,SVt_PVIV);
4140
4141     if (!SvOOK(sv)) {
4142         if (!SvLEN(sv)) { /* make copy of shared string */
4143             const char *pvx = SvPVX_const(sv);
4144             const STRLEN len = SvCUR(sv);
4145             SvGROW(sv, len + 1);
4146             Move(pvx,SvPVX(sv),len,char);
4147             *SvEND(sv) = '\0';
4148         }
4149         SvIV_set(sv, 0);
4150         /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4151            and we do that anyway inside the SvNIOK_off
4152         */
4153         SvFLAGS(sv) |= SVf_OOK;
4154     }
4155     SvNIOK_off(sv);
4156     SvLEN_set(sv, SvLEN(sv) - delta);
4157     SvCUR_set(sv, SvCUR(sv) - delta);
4158     SvPV_set(sv, SvPVX(sv) + delta);
4159     SvIV_set(sv, SvIVX(sv) + delta);
4160 }
4161
4162 /*
4163 =for apidoc sv_catpvn
4164
4165 Concatenates the string onto the end of the string which is in the SV.  The
4166 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4167 status set, then the bytes appended should be valid UTF-8.
4168 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
4169
4170 =for apidoc sv_catpvn_flags
4171
4172 Concatenates the string onto the end of the string which is in the SV.  The
4173 C<len> indicates number of bytes to copy.  If the SV has the UTF-8
4174 status set, then the bytes appended should be valid UTF-8.
4175 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4176 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4177 in terms of this function.
4178
4179 =cut
4180 */
4181
4182 void
4183 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4184 {
4185     dVAR;
4186     STRLEN dlen;
4187     const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4188
4189     SvGROW(dsv, dlen + slen + 1);
4190     if (sstr == dstr)
4191         sstr = SvPVX_const(dsv);
4192     Move(sstr, SvPVX(dsv) + dlen, slen, char);
4193     SvCUR_set(dsv, SvCUR(dsv) + slen);
4194     *SvEND(dsv) = '\0';
4195     (void)SvPOK_only_UTF8(dsv);         /* validate pointer */
4196     SvTAINT(dsv);
4197     if (flags & SV_SMAGIC)
4198         SvSETMAGIC(dsv);
4199 }
4200
4201 /*
4202 =for apidoc sv_catsv
4203
4204 Concatenates the string from SV C<ssv> onto the end of the string in
4205 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
4206 not 'set' magic.  See C<sv_catsv_mg>.
4207
4208 =for apidoc sv_catsv_flags
4209
4210 Concatenates the string from SV C<ssv> onto the end of the string in
4211 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
4212 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4213 and C<sv_catsv_nomg> are implemented in terms of this function.
4214
4215 =cut */
4216
4217 void
4218 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4219 {
4220     dVAR;
4221     if (ssv) {
4222         STRLEN slen;
4223         const char *spv = SvPV_const(ssv, slen);
4224         if (spv) {
4225             /*  sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4226                 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4227                 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4228                 get dutf8 = 0x20000000, (i.e.  SVf_UTF8) even though
4229                 dsv->sv_flags doesn't have that bit set.
4230                 Andy Dougherty  12 Oct 2001
4231             */
4232             const I32 sutf8 = DO_UTF8(ssv);
4233             I32 dutf8;
4234
4235             if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4236                 mg_get(dsv);
4237             dutf8 = DO_UTF8(dsv);
4238
4239             if (dutf8 != sutf8) {
4240                 if (dutf8) {
4241                     /* Not modifying source SV, so taking a temporary copy. */
4242                     SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4243
4244                     sv_utf8_upgrade(csv);
4245                     spv = SvPV_const(csv, slen);
4246                 }
4247                 else
4248                     sv_utf8_upgrade_nomg(dsv);
4249             }
4250             sv_catpvn_nomg(dsv, spv, slen);
4251         }
4252     }
4253     if (flags & SV_SMAGIC)
4254         SvSETMAGIC(dsv);
4255 }
4256
4257 /*
4258 =for apidoc sv_catpv
4259
4260 Concatenates the string onto the end of the string which is in the SV.
4261 If the SV has the UTF-8 status set, then the bytes appended should be
4262 valid UTF-8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
4263
4264 =cut */
4265
4266 void
4267 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4268 {
4269     dVAR;
4270     register STRLEN len;
4271     STRLEN tlen;
4272     char *junk;
4273
4274     if (!ptr)
4275         return;
4276     junk = SvPV_force(sv, tlen);
4277     len = strlen(ptr);
4278     SvGROW(sv, tlen + len + 1);
4279     if (ptr == junk)
4280         ptr = SvPVX_const(sv);
4281     Move(ptr,SvPVX(sv)+tlen,len+1,char);
4282     SvCUR_set(sv, SvCUR(sv) + len);
4283     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
4284     SvTAINT(sv);
4285 }
4286
4287 /*
4288 =for apidoc sv_catpv_mg
4289
4290 Like C<sv_catpv>, but also handles 'set' magic.
4291
4292 =cut
4293 */
4294
4295 void
4296 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4297 {
4298     sv_catpv(sv,ptr);
4299     SvSETMAGIC(sv);
4300 }
4301
4302 /*
4303 =for apidoc newSV
4304
4305 Creates a new SV.  A non-zero C<len> parameter indicates the number of
4306 bytes of preallocated string space the SV should have.  An extra byte for a
4307 trailing NUL is also reserved.  (SvPOK is not set for the SV even if string
4308 space is allocated.)  The reference count for the new SV is set to 1.
4309
4310 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4311 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4312 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4313 L<perlhack/PERL_MEM_LOG>).  The older API is still there for use in XS
4314 modules supporting older perls.
4315
4316 =cut
4317 */
4318
4319 SV *
4320 Perl_newSV(pTHX_ STRLEN len)
4321 {
4322     dVAR;
4323     register SV *sv;
4324
4325     new_SV(sv);
4326     if (len) {
4327         sv_upgrade(sv, SVt_PV);
4328         SvGROW(sv, len + 1);
4329     }
4330     return sv;
4331 }
4332 /*
4333 =for apidoc sv_magicext
4334
4335 Adds magic to an SV, upgrading it if necessary. Applies the
4336 supplied vtable and returns a pointer to the magic added.
4337
4338 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4339 In particular, you can add magic to SvREADONLY SVs, and add more than
4340 one instance of the same 'how'.
4341
4342 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4343 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4344 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4345 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4346
4347 (This is now used as a subroutine by C<sv_magic>.)
4348
4349 =cut
4350 */
4351 MAGIC *
4352 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4353                  const char* name, I32 namlen)
4354 {
4355     dVAR;
4356     MAGIC* mg;
4357
4358     if (SvTYPE(sv) < SVt_PVMG) {
4359         SvUPGRADE(sv, SVt_PVMG);
4360     }
4361     Newxz(mg, 1, MAGIC);
4362     mg->mg_moremagic = SvMAGIC(sv);
4363     SvMAGIC_set(sv, mg);
4364
4365     /* Sometimes a magic contains a reference loop, where the sv and
4366        object refer to each other.  To prevent a reference loop that
4367        would prevent such objects being freed, we look for such loops
4368        and if we find one we avoid incrementing the object refcount.
4369
4370        Note we cannot do this to avoid self-tie loops as intervening RV must
4371        have its REFCNT incremented to keep it in existence.
4372
4373     */
4374     if (!obj || obj == sv ||
4375         how == PERL_MAGIC_arylen ||
4376         how == PERL_MAGIC_qr ||
4377         how == PERL_MAGIC_symtab ||
4378         (SvTYPE(obj) == SVt_PVGV &&
4379             (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4380             GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4381             GvFORM(obj) == (CV*)sv)))
4382     {
4383         mg->mg_obj = obj;
4384     }
4385     else {
4386         mg->mg_obj = SvREFCNT_inc_simple(obj);
4387         mg->mg_flags |= MGf_REFCOUNTED;
4388     }
4389
4390     /* Normal self-ties simply pass a null object, and instead of
4391        using mg_obj directly, use the SvTIED_obj macro to produce a
4392        new RV as needed.  For glob "self-ties", we are tieing the PVIO
4393        with an RV obj pointing to the glob containing the PVIO.  In
4394        this case, to avoid a reference loop, we need to weaken the
4395        reference.
4396     */
4397
4398     if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4399         obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4400     {
4401       sv_rvweaken(obj);
4402     }
4403
4404     mg->mg_type = how;
4405     mg->mg_len = namlen;
4406     if (name) {
4407         if (namlen > 0)
4408             mg->mg_ptr = savepvn(name, namlen);
4409         else if (namlen == HEf_SVKEY)
4410             mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4411         else
4412             mg->mg_ptr = (char *) name;
4413     }
4414     mg->mg_virtual = vtable;
4415
4416     mg_magical(sv);
4417     if (SvGMAGICAL(sv))
4418         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4419     return mg;
4420 }
4421
4422 /*
4423 =for apidoc sv_magic
4424
4425 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4426 then adds a new magic item of type C<how> to the head of the magic list.
4427
4428 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4429 handling of the C<name> and C<namlen> arguments.
4430
4431 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4432 to add more than one instance of the same 'how'.
4433
4434 =cut
4435 */
4436
4437 void
4438 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4439 {
4440     dVAR;
4441     MGVTBL *vtable;
4442     MAGIC* mg;
4443
4444 #ifdef PERL_OLD_COPY_ON_WRITE
4445     if (SvIsCOW(sv))
4446         sv_force_normal_flags(sv, 0);
4447 #endif
4448     if (SvREADONLY(sv)) {
4449         if (
4450             /* its okay to attach magic to shared strings; the subsequent
4451              * upgrade to PVMG will unshare the string */
4452             !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4453
4454             && IN_PERL_RUNTIME
4455             && how != PERL_MAGIC_regex_global
4456             && how != PERL_MAGIC_bm
4457             && how != PERL_MAGIC_fm
4458             && how != PERL_MAGIC_sv
4459             && how != PERL_MAGIC_backref
4460            )
4461         {
4462             Perl_croak(aTHX_ PL_no_modify);
4463         }
4464     }
4465     if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4466         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4467             /* sv_magic() refuses to add a magic of the same 'how' as an
4468                existing one
4469              */
4470             if (how == PERL_MAGIC_taint) {
4471                 mg->mg_len |= 1;
4472                 /* Any scalar which already had taint magic on which someone
4473                    (erroneously?) did SvIOK_on() or similar will now be
4474                    incorrectly sporting public "OK" flags.  */
4475                 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4476             }
4477             return;
4478         }
4479     }
4480
4481     switch (how) {
4482     case PERL_MAGIC_sv:
4483         vtable = &PL_vtbl_sv;
4484         break;
4485     case PERL_MAGIC_overload:
4486         vtable = &PL_vtbl_amagic;
4487         break;
4488     case PERL_MAGIC_overload_elem:
4489         vtable = &PL_vtbl_amagicelem;
4490         break;
4491     case PERL_MAGIC_overload_table:
4492         vtable = &PL_vtbl_ovrld;
4493         break;
4494     case PERL_MAGIC_bm:
4495         vtable = &PL_vtbl_bm;
4496         break;
4497     case PERL_MAGIC_regdata:
4498         vtable = &PL_vtbl_regdata;
4499         break;
4500     case PERL_MAGIC_regdata_names:
4501         vtable = &PL_vtbl_regdata_names;
4502         break;
4503     case PERL_MAGIC_regdatum:
4504         vtable = &PL_vtbl_regdatum;
4505         break;
4506     case PERL_MAGIC_env:
4507         vtable = &PL_vtbl_env;
4508         break;
4509     case PERL_MAGIC_fm:
4510         vtable = &PL_vtbl_fm;
4511         break;
4512     case PERL_MAGIC_envelem:
4513         vtable = &PL_vtbl_envelem;
4514         break;
4515     case PERL_MAGIC_regex_global:
4516         vtable = &PL_vtbl_mglob;
4517         break;
4518     case PERL_MAGIC_isa:
4519         vtable = &PL_vtbl_isa;
4520         break;
4521     case PERL_MAGIC_isaelem:
4522         vtable = &PL_vtbl_isaelem;
4523         break;
4524     case PERL_MAGIC_nkeys:
4525         vtable = &PL_vtbl_nkeys;
4526         break;
4527     case PERL_MAGIC_dbfile:
4528         vtable = NULL;
4529         break;
4530     case PERL_MAGIC_dbline:
4531         vtable = &PL_vtbl_dbline;
4532         break;
4533 #ifdef USE_LOCALE_COLLATE
4534     case PERL_MAGIC_collxfrm:
4535         vtable = &PL_vtbl_collxfrm;
4536         break;
4537 #endif /* USE_LOCALE_COLLATE */
4538     case PERL_MAGIC_tied:
4539         vtable = &PL_vtbl_pack;
4540         break;
4541     case PERL_MAGIC_tiedelem:
4542     case PERL_MAGIC_tiedscalar:
4543         vtable = &PL_vtbl_packelem;
4544         break;
4545     case PERL_MAGIC_qr:
4546         vtable = &PL_vtbl_regexp;
4547         break;
4548     case PERL_MAGIC_hints:
4549         /* As this vtable is all NULL, we can reuse it.  */
4550     case PERL_MAGIC_sig:
4551         vtable = &PL_vtbl_sig;
4552         break;
4553     case PERL_MAGIC_sigelem:
4554         vtable = &PL_vtbl_sigelem;
4555         break;
4556     case PERL_MAGIC_taint:
4557         vtable = &PL_vtbl_taint;
4558         break;
4559     case PERL_MAGIC_uvar:
4560         vtable = &PL_vtbl_uvar;
4561         break;
4562     case PERL_MAGIC_vec:
4563         vtable = &PL_vtbl_vec;
4564         break;
4565     case PERL_MAGIC_arylen_p:
4566     case PERL_MAGIC_rhash:
4567     case PERL_MAGIC_symtab:
4568     case PERL_MAGIC_vstring:
4569         vtable = NULL;
4570         break;
4571     case PERL_MAGIC_utf8:
4572         vtable = &PL_vtbl_utf8;
4573         break;
4574     case PERL_MAGIC_substr:
4575         vtable = &PL_vtbl_substr;
4576         break;
4577     case PERL_MAGIC_defelem:
4578         vtable = &PL_vtbl_defelem;
4579         break;
4580     case PERL_MAGIC_arylen:
4581         vtable = &PL_vtbl_arylen;
4582         break;
4583     case PERL_MAGIC_pos:
4584         vtable = &PL_vtbl_pos;
4585         break;
4586     case PERL_MAGIC_backref:
4587         vtable = &PL_vtbl_backref;
4588         break;
4589     case PERL_MAGIC_hintselem:
4590         vtable = &PL_vtbl_hintselem;
4591         break;
4592     case PERL_MAGIC_ext:
4593         /* Reserved for use by extensions not perl internals.           */
4594         /* Useful for attaching extension internal data to perl vars.   */
4595         /* Note that multiple extensions may clash if magical scalars   */
4596         /* etc holding private data from one are passed to another.     */
4597         vtable = NULL;
4598         break;
4599     default:
4600         Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4601     }
4602
4603     /* Rest of work is done else where */
4604     mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4605
4606     switch (how) {
4607     case PERL_MAGIC_taint:
4608         mg->mg_len = 1;
4609         break;
4610     case PERL_MAGIC_ext:
4611     case PERL_MAGIC_dbfile:
4612         SvRMAGICAL_on(sv);
4613         break;
4614     }
4615 }
4616
4617 /*
4618 =for apidoc sv_unmagic
4619
4620 Removes all magic of type C<type> from an SV.
4621
4622 =cut
4623 */
4624
4625 int
4626 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4627 {
4628     MAGIC* mg;
4629     MAGIC** mgp;
4630     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4631         return 0;
4632     mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4633     for (mg = *mgp; mg; mg = *mgp) {
4634         if (mg->mg_type == type) {
4635             const MGVTBL* const vtbl = mg->mg_virtual;
4636             *mgp = mg->mg_moremagic;
4637             if (vtbl && vtbl->svt_free)
4638                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4639             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4640                 if (mg->mg_len > 0)
4641                     Safefree(mg->mg_ptr);
4642                 else if (mg->mg_len == HEf_SVKEY)
4643                     SvREFCNT_dec((SV*)mg->mg_ptr);
4644                 else if (mg->mg_type == PERL_MAGIC_utf8)
4645                     Safefree(mg->mg_ptr);
4646             }
4647             if (mg->mg_flags & MGf_REFCOUNTED)
4648                 SvREFCNT_dec(mg->mg_obj);
4649             Safefree(mg);
4650         }
4651         else
4652             mgp = &mg->mg_moremagic;
4653     }
4654     if (!SvMAGIC(sv)) {
4655         SvMAGICAL_off(sv);
4656         SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4657         SvMAGIC_set(sv, NULL);
4658     }
4659
4660     return 0;
4661 }
4662
4663 /*
4664 =for apidoc sv_rvweaken
4665
4666 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4667 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4668 push a back-reference to this RV onto the array of backreferences
4669 associated with that magic. If the RV is magical, set magic will be
4670 called after the RV is cleared.
4671
4672 =cut
4673 */
4674
4675 SV *
4676 Perl_sv_rvweaken(pTHX_ SV *sv)
4677 {
4678     SV *tsv;
4679     if (!SvOK(sv))  /* let undefs pass */
4680         return sv;
4681     if (!SvROK(sv))
4682         Perl_croak(aTHX_ "Can't weaken a nonreference");
4683     else if (SvWEAKREF(sv)) {
4684         if (ckWARN(WARN_MISC))
4685             Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4686         return sv;
4687     }
4688     tsv = SvRV(sv);
4689     Perl_sv_add_backref(aTHX_ tsv, sv);
4690     SvWEAKREF_on(sv);
4691     SvREFCNT_dec(tsv);
4692     return sv;
4693 }
4694
4695 /* Give tsv backref magic if it hasn't already got it, then push a
4696  * back-reference to sv onto the array associated with the backref magic.
4697  */
4698
4699 void
4700 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4701 {
4702     dVAR;
4703     AV *av;
4704
4705     if (SvTYPE(tsv) == SVt_PVHV) {
4706         AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4707
4708         av = *avp;
4709         if (!av) {
4710             /* There is no AV in the offical place - try a fixup.  */
4711             MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4712
4713             if (mg) {
4714                 /* Aha. They've got it stowed in magic.  Bring it back.  */
4715                 av = (AV*)mg->mg_obj;
4716                 /* Stop mg_free decreasing the refernce count.  */
4717                 mg->mg_obj = NULL;
4718                 /* Stop mg_free even calling the destructor, given that
4719                    there's no AV to free up.  */
4720                 mg->mg_virtual = 0;
4721                 sv_unmagic(tsv, PERL_MAGIC_backref);
4722             } else {
4723                 av = newAV();
4724                 AvREAL_off(av);
4725                 SvREFCNT_inc_simple_void(av);
4726             }
4727             *avp = av;
4728         }
4729     } else {
4730         const MAGIC *const mg
4731             = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4732         if (mg)
4733             av = (AV*)mg->mg_obj;
4734         else {
4735             av = newAV();
4736             AvREAL_off(av);
4737             sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4738             /* av now has a refcnt of 2, which avoids it getting freed
4739              * before us during global cleanup. The extra ref is removed
4740              * by magic_killbackrefs() when tsv is being freed */
4741         }
4742     }
4743     if (AvFILLp(av) >= AvMAX(av)) {
4744         av_extend(av, AvFILLp(av)+1);
4745     }
4746     AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4747 }
4748
4749 /* delete a back-reference to ourselves from the backref magic associated
4750  * with the SV we point to.
4751  */
4752
4753 STATIC void
4754 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4755 {
4756     dVAR;