sv.c

   1 /*    sv.c
   2  *
   3  *    Copyright (c) 1991-2001, Larry Wall
   4  *
   5  *    You may distribute under the terms of either the GNU General Public
   6  *    License or the Artistic License, as specified in the README file.
   7  *
   8  */
   9
  10 /*
  11  * "I wonder what the Entish is for 'yes' and 'no'," he thought.
  12  */
  13
  14 #include "EXTERN.h"
  15 #define PERL_IN_SV_C
  16 #include "perl.h"
  17
  18 #define FCALL *f
  19 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) sv_force_normal(sv)
  20
  21 static void do_report_used(pTHXo_ SV *sv);
  22 static void do_clean_objs(pTHXo_ SV *sv);
  23 #ifndef DISABLE_DESTRUCTOR_KLUDGE
  24 static void do_clean_named_objs(pTHXo_ SV *sv);
  25 #endif
  26 static void do_clean_all(pTHXo_ SV *sv);
  27
  28 /*
  29  * "A time to plant, and a time to uproot what was planted..."
  30  */
  31
  32 #define plant_SV(p) \
  33     STMT_START {                                        \
  34         SvANY(p) = (void *)PL_sv_root;                  \
  35         SvFLAGS(p) = SVTYPEMASK;                        \
  36         PL_sv_root = (p);                               \
  37         --PL_sv_count;                                  \
  38     } STMT_END
  39
  40 /* sv_mutex must be held while calling uproot_SV() */
  41 #define uproot_SV(p) \
  42     STMT_START {                                        \
  43         (p) = PL_sv_root;                               \
  44         PL_sv_root = (SV*)SvANY(p);                     \
  45         ++PL_sv_count;                                  \
  46     } STMT_END
  47
  48 #define new_SV(p) \
  49     STMT_START {                                        \
  50         LOCK_SV_MUTEX;                                  \
  51         if (PL_sv_root)                                 \
  52             uproot_SV(p);                               \
  53         else                                            \
  54             (p) = more_sv();                            \
  55         UNLOCK_SV_MUTEX;                                \
  56         SvANY(p) = 0;                                   \
  57         SvREFCNT(p) = 1;                                \
  58         SvFLAGS(p) = 0;                                 \
  59     } STMT_END
  60
  61 #ifdef DEBUGGING
  62
  63 #define del_SV(p) \
  64     STMT_START {                                        \
  65         LOCK_SV_MUTEX;                                  \
  66         if (PL_debug & 32768)                           \
  67             del_sv(p);                                  \
  68         else                                            \
  69             plant_SV(p);                                \
  70         UNLOCK_SV_MUTEX;                                \
  71     } STMT_END
  72
  73 STATIC void
  74 S_del_sv(pTHX_ SV *p)
  75 {
  76     if (PL_debug & 32768) {
  77         SV* sva;
  78         SV* sv;
  79         SV* svend;
  80         int ok = 0;
  81         for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
  82             sv = sva + 1;
  83             svend = &sva[SvREFCNT(sva)];
  84             if (p >= sv && p < svend)
  85                 ok = 1;
  86         }
  87         if (!ok) {
  88             if (ckWARN_d(WARN_INTERNAL))
  89                 Perl_warner(aTHX_ WARN_INTERNAL,
  90                             "Attempt to free non-arena SV: 0x%"UVxf,
  91                             PTR2UV(p));
  92             return;
  93         }
  94     }
  95     plant_SV(p);
  96 }
  97
  98 #else /* ! DEBUGGING */
  99
 100 #define del_SV(p)   plant_SV(p)
 101
 102 #endif /* DEBUGGING */
 103
 104 void
 105 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
 106 {
 107     SV* sva = (SV*)ptr;
 108     register SV* sv;
 109     register SV* svend;
 110     Zero(ptr, size, char);
 111
 112     /* The first SV in an arena isn't an SV. */
 113     SvANY(sva) = (void *) PL_sv_arenaroot;              /* ptr to next arena */
 114     SvREFCNT(sva) = size / sizeof(SV);          /* number of SV slots */
 115     SvFLAGS(sva) = flags;                       /* FAKE if not to be freed */
 116
 117     PL_sv_arenaroot = sva;
 118     PL_sv_root = sva + 1;
 119
 120     svend = &sva[SvREFCNT(sva) - 1];
 121     sv = sva + 1;
 122     while (sv < svend) {
 123         SvANY(sv) = (void *)(SV*)(sv + 1);
 124         SvFLAGS(sv) = SVTYPEMASK;
 125         sv++;
 126     }
 127     SvANY(sv) = 0;
 128     SvFLAGS(sv) = SVTYPEMASK;
 129 }
 130
 131 /* sv_mutex must be held while calling more_sv() */
 132 STATIC SV*
 133 S_more_sv(pTHX)
 134 {
 135     register SV* sv;
 136
 137     if (PL_nice_chunk) {
 138         sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
 139         PL_nice_chunk = Nullch;
 140     }
 141     else {
 142         char *chunk;                /* must use New here to match call to */
 143         New(704,chunk,1008,char);   /* Safefree() in sv_free_arenas()     */
 144         sv_add_arena(chunk, 1008, 0);
 145     }
 146     uproot_SV(sv);
 147     return sv;
 148 }
 149
 150 STATIC void
 151 S_visit(pTHX_ SVFUNC_t f)
 152 {
 153     SV* sva;
 154     SV* sv;
 155     register SV* svend;
 156
 157     for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
 158         svend = &sva[SvREFCNT(sva)];
 159         for (sv = sva + 1; sv < svend; ++sv) {
 160             if (SvTYPE(sv) != SVTYPEMASK)
 161                 (FCALL)(aTHXo_ sv);
 162         }
 163     }
 164 }
 165
 166 void
 167 Perl_sv_report_used(pTHX)
 168 {
 169     visit(do_report_used);
 170 }
 171
 172 void
 173 Perl_sv_clean_objs(pTHX)
 174 {
 175     PL_in_clean_objs = TRUE;
 176     visit(do_clean_objs);
 177 #ifndef DISABLE_DESTRUCTOR_KLUDGE
 178     /* some barnacles may yet remain, clinging to typeglobs */
 179     visit(do_clean_named_objs);
 180 #endif
 181     PL_in_clean_objs = FALSE;
 182 }
 183
 184 void
 185 Perl_sv_clean_all(pTHX)
 186 {
 187     PL_in_clean_all = TRUE;
 188     visit(do_clean_all);
 189     PL_in_clean_all = FALSE;
 190 }
 191
 192 void
 193 Perl_sv_free_arenas(pTHX)
 194 {
 195     SV* sva;
 196     SV* svanext;
 197     XPV *arena, *arenanext;
 198
 199     /* Free arenas here, but be careful about fake ones.  (We assume
 200        contiguity of the fake ones with the corresponding real ones.) */
 201
 202     for (sva = PL_sv_arenaroot; sva; sva = svanext) {
 203         svanext = (SV*) SvANY(sva);
 204         while (svanext && SvFAKE(svanext))
 205             svanext = (SV*) SvANY(svanext);
 206
 207         if (!SvFAKE(sva))
 208             Safefree((void *)sva);
 209     }
 210
 211     for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
 212         arenanext = (XPV*)arena->xpv_pv;
 213         Safefree(arena);
 214     }
 215     PL_xiv_arenaroot = 0;
 216
 217     for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
 218         arenanext = (XPV*)arena->xpv_pv;
 219         Safefree(arena);
 220     }
 221     PL_xnv_arenaroot = 0;
 222
 223     for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
 224         arenanext = (XPV*)arena->xpv_pv;
 225         Safefree(arena);
 226     }
 227     PL_xrv_arenaroot = 0;
 228
 229     for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
 230         arenanext = (XPV*)arena->xpv_pv;
 231         Safefree(arena);
 232     }
 233     PL_xpv_arenaroot = 0;
 234
 235     for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
 236         arenanext = (XPV*)arena->xpv_pv;
 237         Safefree(arena);
 238     }
 239     PL_xpviv_arenaroot = 0;
 240
 241     for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
 242         arenanext = (XPV*)arena->xpv_pv;
 243         Safefree(arena);
 244     }
 245     PL_xpvnv_arenaroot = 0;
 246
 247     for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
 248         arenanext = (XPV*)arena->xpv_pv;
 249         Safefree(arena);
 250     }
 251     PL_xpvcv_arenaroot = 0;
 252
 253     for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
 254         arenanext = (XPV*)arena->xpv_pv;
 255         Safefree(arena);
 256     }
 257     PL_xpvav_arenaroot = 0;
 258
 259     for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
 260         arenanext = (XPV*)arena->xpv_pv;
 261         Safefree(arena);
 262     }
 263     PL_xpvhv_arenaroot = 0;
 264
 265     for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
 266         arenanext = (XPV*)arena->xpv_pv;
 267         Safefree(arena);
 268     }
 269     PL_xpvmg_arenaroot = 0;
 270
 271     for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
 272         arenanext = (XPV*)arena->xpv_pv;
 273         Safefree(arena);
 274     }
 275     PL_xpvlv_arenaroot = 0;
 276
 277     for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
 278         arenanext = (XPV*)arena->xpv_pv;
 279         Safefree(arena);
 280     }
 281     PL_xpvbm_arenaroot = 0;
 282
 283     for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
 284         arenanext = (XPV*)arena->xpv_pv;
 285         Safefree(arena);
 286     }
 287     PL_he_arenaroot = 0;
 288
 289     if (PL_nice_chunk)
 290         Safefree(PL_nice_chunk);
 291     PL_nice_chunk = Nullch;
 292     PL_nice_chunk_size = 0;
 293     PL_sv_arenaroot = 0;
 294     PL_sv_root = 0;
 295 }
 296
 297 void
 298 Perl_report_uninit(pTHX)
 299 {
 300     if (PL_op)
 301         Perl_warner(aTHX_ WARN_UNINITIALIZED, PL_warn_uninit,
 302                     " in ", PL_op_desc[PL_op->op_type]);
 303     else
 304         Perl_warner(aTHX_ WARN_UNINITIALIZED, PL_warn_uninit, "", "");
 305 }
 306
 307 STATIC XPVIV*
 308 S_new_xiv(pTHX)
 309 {
 310     IV* xiv;
 311     LOCK_SV_MUTEX;
 312     if (!PL_xiv_root)
 313         more_xiv();
 314     xiv = PL_xiv_root;
 315     /*
 316      * See comment in more_xiv() -- RAM.
 317      */
 318     PL_xiv_root = *(IV**)xiv;
 319     UNLOCK_SV_MUTEX;
 320     return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
 321 }
 322
 323 STATIC void
 324 S_del_xiv(pTHX_ XPVIV *p)
 325 {
 326     IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
 327     LOCK_SV_MUTEX;
 328     *(IV**)xiv = PL_xiv_root;
 329     PL_xiv_root = xiv;
 330     UNLOCK_SV_MUTEX;
 331 }
 332
 333 STATIC void
 334 S_more_xiv(pTHX)
 335 {
 336     register IV* xiv;
 337     register IV* xivend;
 338     XPV* ptr;
 339     New(705, ptr, 1008/sizeof(XPV), XPV);
 340     ptr->xpv_pv = (char*)PL_xiv_arenaroot;              /* linked list of xiv arenas */
 341     PL_xiv_arenaroot = ptr;                     /* to keep Purify happy */
 342
 343     xiv = (IV*) ptr;
 344     xivend = &xiv[1008 / sizeof(IV) - 1];
 345     xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1;   /* fudge by size of XPV */
 346     PL_xiv_root = xiv;
 347     while (xiv < xivend) {
 348         *(IV**)xiv = (IV *)(xiv + 1);
 349         xiv++;
 350     }
 351     *(IV**)xiv = 0;
 352 }
 353
 354 STATIC XPVNV*
 355 S_new_xnv(pTHX)
 356 {
 357     NV* xnv;
 358     LOCK_SV_MUTEX;
 359     if (!PL_xnv_root)
 360         more_xnv();
 361     xnv = PL_xnv_root;
 362     PL_xnv_root = *(NV**)xnv;
 363     UNLOCK_SV_MUTEX;
 364     return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
 365 }
 366
 367 STATIC void
 368 S_del_xnv(pTHX_ XPVNV *p)
 369 {
 370     NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
 371     LOCK_SV_MUTEX;
 372     *(NV**)xnv = PL_xnv_root;
 373     PL_xnv_root = xnv;
 374     UNLOCK_SV_MUTEX;
 375 }
 376
 377 STATIC void
 378 S_more_xnv(pTHX)
 379 {
 380     register NV* xnv;
 381     register NV* xnvend;
 382     XPV *ptr;
 383     New(711, ptr, 1008/sizeof(XPV), XPV);
 384     ptr->xpv_pv = (char*)PL_xnv_arenaroot;
 385     PL_xnv_arenaroot = ptr;
 386
 387     xnv = (NV*) ptr;
 388     xnvend = &xnv[1008 / sizeof(NV) - 1];
 389     xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
 390     PL_xnv_root = xnv;
 391     while (xnv < xnvend) {
 392         *(NV**)xnv = (NV*)(xnv + 1);
 393         xnv++;
 394     }
 395     *(NV**)xnv = 0;
 396 }
 397
 398 STATIC XRV*
 399 S_new_xrv(pTHX)
 400 {
 401     XRV* xrv;
 402     LOCK_SV_MUTEX;
 403     if (!PL_xrv_root)
 404         more_xrv();
 405     xrv = PL_xrv_root;
 406     PL_xrv_root = (XRV*)xrv->xrv_rv;
 407     UNLOCK_SV_MUTEX;
 408     return xrv;
 409 }
 410
 411 STATIC void
 412 S_del_xrv(pTHX_ XRV *p)
 413 {
 414     LOCK_SV_MUTEX;
 415     p->xrv_rv = (SV*)PL_xrv_root;
 416     PL_xrv_root = p;
 417     UNLOCK_SV_MUTEX;
 418 }
 419
 420 STATIC void
 421 S_more_xrv(pTHX)
 422 {
 423     register XRV* xrv;
 424     register XRV* xrvend;
 425     XPV *ptr;
 426     New(712, ptr, 1008/sizeof(XPV), XPV);
 427     ptr->xpv_pv = (char*)PL_xrv_arenaroot;
 428     PL_xrv_arenaroot = ptr;
 429
 430     xrv = (XRV*) ptr;
 431     xrvend = &xrv[1008 / sizeof(XRV) - 1];
 432     xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
 433     PL_xrv_root = xrv;
 434     while (xrv < xrvend) {
 435         xrv->xrv_rv = (SV*)(xrv + 1);
 436         xrv++;
 437     }
 438     xrv->xrv_rv = 0;
 439 }
 440
 441 STATIC XPV*
 442 S_new_xpv(pTHX)
 443 {
 444     XPV* xpv;
 445     LOCK_SV_MUTEX;
 446     if (!PL_xpv_root)
 447         more_xpv();
 448     xpv = PL_xpv_root;
 449     PL_xpv_root = (XPV*)xpv->xpv_pv;
 450     UNLOCK_SV_MUTEX;
 451     return xpv;
 452 }
 453
 454 STATIC void
 455 S_del_xpv(pTHX_ XPV *p)
 456 {
 457     LOCK_SV_MUTEX;
 458     p->xpv_pv = (char*)PL_xpv_root;
 459     PL_xpv_root = p;
 460     UNLOCK_SV_MUTEX;
 461 }
 462
 463 STATIC void
 464 S_more_xpv(pTHX)
 465 {
 466     register XPV* xpv;
 467     register XPV* xpvend;
 468     New(713, xpv, 1008/sizeof(XPV), XPV);
 469     xpv->xpv_pv = (char*)PL_xpv_arenaroot;
 470     PL_xpv_arenaroot = xpv;
 471
 472     xpvend = &xpv[1008 / sizeof(XPV) - 1];
 473     PL_xpv_root = ++xpv;
 474     while (xpv < xpvend) {
 475         xpv->xpv_pv = (char*)(xpv + 1);
 476         xpv++;
 477     }
 478     xpv->xpv_pv = 0;
 479 }
 480
 481 STATIC XPVIV*
 482 S_new_xpviv(pTHX)
 483 {
 484     XPVIV* xpviv;
 485     LOCK_SV_MUTEX;
 486     if (!PL_xpviv_root)
 487         more_xpviv();
 488     xpviv = PL_xpviv_root;
 489     PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
 490     UNLOCK_SV_MUTEX;
 491     return xpviv;
 492 }
 493
 494 STATIC void
 495 S_del_xpviv(pTHX_ XPVIV *p)
 496 {
 497     LOCK_SV_MUTEX;
 498     p->xpv_pv = (char*)PL_xpviv_root;
 499     PL_xpviv_root = p;
 500     UNLOCK_SV_MUTEX;
 501 }
 502
 503 STATIC void
 504 S_more_xpviv(pTHX)
 505 {
 506     register XPVIV* xpviv;
 507     register XPVIV* xpvivend;
 508     New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
 509     xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
 510     PL_xpviv_arenaroot = xpviv;
 511
 512     xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
 513     PL_xpviv_root = ++xpviv;
 514     while (xpviv < xpvivend) {
 515         xpviv->xpv_pv = (char*)(xpviv + 1);
 516         xpviv++;
 517     }
 518     xpviv->xpv_pv = 0;
 519 }
 520
 521 STATIC XPVNV*
 522 S_new_xpvnv(pTHX)
 523 {
 524     XPVNV* xpvnv;
 525     LOCK_SV_MUTEX;
 526     if (!PL_xpvnv_root)
 527         more_xpvnv();
 528     xpvnv = PL_xpvnv_root;
 529     PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
 530     UNLOCK_SV_MUTEX;
 531     return xpvnv;
 532 }
 533
 534 STATIC void
 535 S_del_xpvnv(pTHX_ XPVNV *p)
 536 {
 537     LOCK_SV_MUTEX;
 538     p->xpv_pv = (char*)PL_xpvnv_root;
 539     PL_xpvnv_root = p;
 540     UNLOCK_SV_MUTEX;
 541 }
 542
 543 STATIC void
 544 S_more_xpvnv(pTHX)
 545 {
 546     register XPVNV* xpvnv;
 547     register XPVNV* xpvnvend;
 548     New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
 549     xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
 550     PL_xpvnv_arenaroot = xpvnv;
 551
 552     xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
 553     PL_xpvnv_root = ++xpvnv;
 554     while (xpvnv < xpvnvend) {
 555         xpvnv->xpv_pv = (char*)(xpvnv + 1);
 556         xpvnv++;
 557     }
 558     xpvnv->xpv_pv = 0;
 559 }
 560
 561 STATIC XPVCV*
 562 S_new_xpvcv(pTHX)
 563 {
 564     XPVCV* xpvcv;
 565     LOCK_SV_MUTEX;
 566     if (!PL_xpvcv_root)
 567         more_xpvcv();
 568     xpvcv = PL_xpvcv_root;
 569     PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
 570     UNLOCK_SV_MUTEX;
 571     return xpvcv;
 572 }
 573
 574 STATIC void
 575 S_del_xpvcv(pTHX_ XPVCV *p)
 576 {
 577     LOCK_SV_MUTEX;
 578     p->xpv_pv = (char*)PL_xpvcv_root;
 579     PL_xpvcv_root = p;
 580     UNLOCK_SV_MUTEX;
 581 }
 582
 583 STATIC void
 584 S_more_xpvcv(pTHX)
 585 {
 586     register XPVCV* xpvcv;
 587     register XPVCV* xpvcvend;
 588     New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
 589     xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
 590     PL_xpvcv_arenaroot = xpvcv;
 591
 592     xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
 593     PL_xpvcv_root = ++xpvcv;
 594     while (xpvcv < xpvcvend) {
 595         xpvcv->xpv_pv = (char*)(xpvcv + 1);
 596         xpvcv++;
 597     }
 598     xpvcv->xpv_pv = 0;
 599 }
 600
 601 STATIC XPVAV*
 602 S_new_xpvav(pTHX)
 603 {
 604     XPVAV* xpvav;
 605     LOCK_SV_MUTEX;
 606     if (!PL_xpvav_root)
 607         more_xpvav();
 608     xpvav = PL_xpvav_root;
 609     PL_xpvav_root = (XPVAV*)xpvav->xav_array;
 610     UNLOCK_SV_MUTEX;
 611     return xpvav;
 612 }
 613
 614 STATIC void
 615 S_del_xpvav(pTHX_ XPVAV *p)
 616 {
 617     LOCK_SV_MUTEX;
 618     p->xav_array = (char*)PL_xpvav_root;
 619     PL_xpvav_root = p;
 620     UNLOCK_SV_MUTEX;
 621 }
 622
 623 STATIC void
 624 S_more_xpvav(pTHX)
 625 {
 626     register XPVAV* xpvav;
 627     register XPVAV* xpvavend;
 628     New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
 629     xpvav->xav_array = (char*)PL_xpvav_arenaroot;
 630     PL_xpvav_arenaroot = xpvav;
 631
 632     xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
 633     PL_xpvav_root = ++xpvav;
 634     while (xpvav < xpvavend) {
 635         xpvav->xav_array = (char*)(xpvav + 1);
 636         xpvav++;
 637     }
 638     xpvav->xav_array = 0;
 639 }
 640
 641 STATIC XPVHV*
 642 S_new_xpvhv(pTHX)
 643 {
 644     XPVHV* xpvhv;
 645     LOCK_SV_MUTEX;
 646     if (!PL_xpvhv_root)
 647         more_xpvhv();
 648     xpvhv = PL_xpvhv_root;
 649     PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
 650     UNLOCK_SV_MUTEX;
 651     return xpvhv;
 652 }
 653
 654 STATIC void
 655 S_del_xpvhv(pTHX_ XPVHV *p)
 656 {
 657     LOCK_SV_MUTEX;
 658     p->xhv_array = (char*)PL_xpvhv_root;
 659     PL_xpvhv_root = p;
 660     UNLOCK_SV_MUTEX;
 661 }
 662
 663 STATIC void
 664 S_more_xpvhv(pTHX)
 665 {
 666     register XPVHV* xpvhv;
 667     register XPVHV* xpvhvend;
 668     New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
 669     xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
 670     PL_xpvhv_arenaroot = xpvhv;
 671
 672     xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
 673     PL_xpvhv_root = ++xpvhv;
 674     while (xpvhv < xpvhvend) {
 675         xpvhv->xhv_array = (char*)(xpvhv + 1);
 676         xpvhv++;
 677     }
 678     xpvhv->xhv_array = 0;
 679 }
 680
 681 STATIC XPVMG*
 682 S_new_xpvmg(pTHX)
 683 {
 684     XPVMG* xpvmg;
 685     LOCK_SV_MUTEX;
 686     if (!PL_xpvmg_root)
 687         more_xpvmg();
 688     xpvmg = PL_xpvmg_root;
 689     PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
 690     UNLOCK_SV_MUTEX;
 691     return xpvmg;
 692 }
 693
 694 STATIC void
 695 S_del_xpvmg(pTHX_ XPVMG *p)
 696 {
 697     LOCK_SV_MUTEX;
 698     p->xpv_pv = (char*)PL_xpvmg_root;
 699     PL_xpvmg_root = p;
 700     UNLOCK_SV_MUTEX;
 701 }
 702
 703 STATIC void
 704 S_more_xpvmg(pTHX)
 705 {
 706     register XPVMG* xpvmg;
 707     register XPVMG* xpvmgend;
 708     New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
 709     xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
 710     PL_xpvmg_arenaroot = xpvmg;
 711
 712     xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
 713     PL_xpvmg_root = ++xpvmg;
 714     while (xpvmg < xpvmgend) {
 715         xpvmg->xpv_pv = (char*)(xpvmg + 1);
 716         xpvmg++;
 717     }
 718     xpvmg->xpv_pv = 0;
 719 }
 720
 721 STATIC XPVLV*
 722 S_new_xpvlv(pTHX)
 723 {
 724     XPVLV* xpvlv;
 725     LOCK_SV_MUTEX;
 726     if (!PL_xpvlv_root)
 727         more_xpvlv();
 728     xpvlv = PL_xpvlv_root;
 729     PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
 730     UNLOCK_SV_MUTEX;
 731     return xpvlv;
 732 }
 733
 734 STATIC void
 735 S_del_xpvlv(pTHX_ XPVLV *p)
 736 {
 737     LOCK_SV_MUTEX;
 738     p->xpv_pv = (char*)PL_xpvlv_root;
 739     PL_xpvlv_root = p;
 740     UNLOCK_SV_MUTEX;
 741 }
 742
 743 STATIC void
 744 S_more_xpvlv(pTHX)
 745 {
 746     register XPVLV* xpvlv;
 747     register XPVLV* xpvlvend;
 748     New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
 749     xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
 750     PL_xpvlv_arenaroot = xpvlv;
 751
 752     xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
 753     PL_xpvlv_root = ++xpvlv;
 754     while (xpvlv < xpvlvend) {
 755         xpvlv->xpv_pv = (char*)(xpvlv + 1);
 756         xpvlv++;
 757     }
 758     xpvlv->xpv_pv = 0;
 759 }
 760
 761 STATIC XPVBM*
 762 S_new_xpvbm(pTHX)
 763 {
 764     XPVBM* xpvbm;
 765     LOCK_SV_MUTEX;
 766     if (!PL_xpvbm_root)
 767         more_xpvbm();
 768     xpvbm = PL_xpvbm_root;
 769     PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
 770     UNLOCK_SV_MUTEX;
 771     return xpvbm;
 772 }
 773
 774 STATIC void
 775 S_del_xpvbm(pTHX_ XPVBM *p)
 776 {
 777     LOCK_SV_MUTEX;
 778     p->xpv_pv = (char*)PL_xpvbm_root;
 779     PL_xpvbm_root = p;
 780     UNLOCK_SV_MUTEX;
 781 }
 782
 783 STATIC void
 784 S_more_xpvbm(pTHX)
 785 {
 786     register XPVBM* xpvbm;
 787     register XPVBM* xpvbmend;
 788     New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
 789     xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
 790     PL_xpvbm_arenaroot = xpvbm;
 791
 792     xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
 793     PL_xpvbm_root = ++xpvbm;
 794     while (xpvbm < xpvbmend) {
 795         xpvbm->xpv_pv = (char*)(xpvbm + 1);
 796         xpvbm++;
 797     }
 798     xpvbm->xpv_pv = 0;
 799 }
 800
 801 #ifdef LEAKTEST
 802 #  define my_safemalloc(s)      (void*)safexmalloc(717,s)
 803 #  define my_safefree(p)        safexfree((char*)p)
 804 #else
 805 #  define my_safemalloc(s)      (void*)safemalloc(s)
 806 #  define my_safefree(p)        safefree((char*)p)
 807 #endif
 808
 809 #ifdef PURIFY
 810
 811 #define new_XIV()       my_safemalloc(sizeof(XPVIV))
 812 #define del_XIV(p)      my_safefree(p)
 813
 814 #define new_XNV()       my_safemalloc(sizeof(XPVNV))
 815 #define del_XNV(p)      my_safefree(p)
 816
 817 #define new_XRV()       my_safemalloc(sizeof(XRV))
 818 #define del_XRV(p)      my_safefree(p)
 819
 820 #define new_XPV()       my_safemalloc(sizeof(XPV))
 821 #define del_XPV(p)      my_safefree(p)
 822
 823 #define new_XPVIV()     my_safemalloc(sizeof(XPVIV))
 824 #define del_XPVIV(p)    my_safefree(p)
 825
 826 #define new_XPVNV()     my_safemalloc(sizeof(XPVNV))
 827 #define del_XPVNV(p)    my_safefree(p)
 828
 829 #define new_XPVCV()     my_safemalloc(sizeof(XPVCV))
 830 #define del_XPVCV(p)    my_safefree(p)
 831
 832 #define new_XPVAV()     my_safemalloc(sizeof(XPVAV))
 833 #define del_XPVAV(p)    my_safefree(p)
 834
 835 #define new_XPVHV()     my_safemalloc(sizeof(XPVHV))
 836 #define del_XPVHV(p)    my_safefree(p)
 837
 838 #define new_XPVMG()     my_safemalloc(sizeof(XPVMG))
 839 #define del_XPVMG(p)    my_safefree(p)
 840
 841 #define new_XPVLV()     my_safemalloc(sizeof(XPVLV))
 842 #define del_XPVLV(p)    my_safefree(p)
 843
 844 #define new_XPVBM()     my_safemalloc(sizeof(XPVBM))
 845 #define del_XPVBM(p)    my_safefree(p)
 846
 847 #else /* !PURIFY */
 848
 849 #define new_XIV()       (void*)new_xiv()
 850 #define del_XIV(p)      del_xiv((XPVIV*) p)
 851
 852 #define new_XNV()       (void*)new_xnv()
 853 #define del_XNV(p)      del_xnv((XPVNV*) p)
 854
 855 #define new_XRV()       (void*)new_xrv()
 856 #define del_XRV(p)      del_xrv((XRV*) p)
 857
 858 #define new_XPV()       (void*)new_xpv()
 859 #define del_XPV(p)      del_xpv((XPV *)p)
 860
 861 #define new_XPVIV()     (void*)new_xpviv()
 862 #define del_XPVIV(p)    del_xpviv((XPVIV *)p)
 863
 864 #define new_XPVNV()     (void*)new_xpvnv()
 865 #define del_XPVNV(p)    del_xpvnv((XPVNV *)p)
 866
 867 #define new_XPVCV()     (void*)new_xpvcv()
 868 #define del_XPVCV(p)    del_xpvcv((XPVCV *)p)
 869
 870 #define new_XPVAV()     (void*)new_xpvav()
 871 #define del_XPVAV(p)    del_xpvav((XPVAV *)p)
 872
 873 #define new_XPVHV()     (void*)new_xpvhv()
 874 #define del_XPVHV(p)    del_xpvhv((XPVHV *)p)
 875
 876 #define new_XPVMG()     (void*)new_xpvmg()
 877 #define del_XPVMG(p)    del_xpvmg((XPVMG *)p)
 878
 879 #define new_XPVLV()     (void*)new_xpvlv()
 880 #define del_XPVLV(p)    del_xpvlv((XPVLV *)p)
 881
 882 #define new_XPVBM()     (void*)new_xpvbm()
 883 #define del_XPVBM(p)    del_xpvbm((XPVBM *)p)
 884
 885 #endif /* PURIFY */
 886
 887 #define new_XPVGV()     my_safemalloc(sizeof(XPVGV))
 888 #define del_XPVGV(p)    my_safefree(p)
 889
 890 #define new_XPVFM()     my_safemalloc(sizeof(XPVFM))
 891 #define del_XPVFM(p)    my_safefree(p)
 892
 893 #define new_XPVIO()     my_safemalloc(sizeof(XPVIO))
 894 #define del_XPVIO(p)    my_safefree(p)
 895
 896 /*
 897 =for apidoc sv_upgrade
 898
 899 Upgrade an SV to a more complex form.  Use C<SvUPGRADE>.  See
 900 C<svtype>.
 901
 902 =cut
 903 */
 904
 905 bool
 906 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
 907 {
 908     char*       pv;
 909     U32         cur;
 910     U32         len;
 911     IV          iv;
 912     NV          nv;
 913     MAGIC*      magic;
 914     HV*         stash;
 915
 916     if (mt != SVt_PV && SvREADONLY(sv) && SvFAKE(sv)) {
 917         sv_force_normal(sv);
 918     }
 919
 920     if (SvTYPE(sv) == mt)
 921         return TRUE;
 922
 923     if (mt < SVt_PVIV)
 924         (void)SvOOK_off(sv);
 925
 926     switch (SvTYPE(sv)) {
 927     case SVt_NULL:
 928         pv      = 0;
 929         cur     = 0;
 930         len     = 0;
 931         iv      = 0;
 932         nv      = 0.0;
 933         magic   = 0;
 934         stash   = 0;
 935         break;
 936     case SVt_IV:
 937         pv      = 0;
 938         cur     = 0;
 939         len     = 0;
 940         iv      = SvIVX(sv);
 941         nv      = (NV)SvIVX(sv);
 942         del_XIV(SvANY(sv));
 943         magic   = 0;
 944         stash   = 0;
 945         if (mt == SVt_NV)
 946             mt = SVt_PVNV;
 947         else if (mt < SVt_PVIV)
 948             mt = SVt_PVIV;
 949         break;
 950     case SVt_NV:
 951         pv      = 0;
 952         cur     = 0;
 953         len     = 0;
 954         nv      = SvNVX(sv);
 955         iv      = I_V(nv);
 956         magic   = 0;
 957         stash   = 0;
 958         del_XNV(SvANY(sv));
 959         SvANY(sv) = 0;
 960         if (mt < SVt_PVNV)
 961             mt = SVt_PVNV;
 962         break;
 963     case SVt_RV:
 964         pv      = (char*)SvRV(sv);
 965         cur     = 0;
 966         len     = 0;
 967         iv      = PTR2IV(pv);
 968         nv      = PTR2NV(pv);
 969         del_XRV(SvANY(sv));
 970         magic   = 0;
 971         stash   = 0;
 972         break;
 973     case SVt_PV:
 974         pv      = SvPVX(sv);
 975         cur     = SvCUR(sv);
 976         len     = SvLEN(sv);
 977         iv      = 0;
 978         nv      = 0.0;
 979         magic   = 0;
 980         stash   = 0;
 981         del_XPV(SvANY(sv));
 982         if (mt <= SVt_IV)
 983             mt = SVt_PVIV;
 984         else if (mt == SVt_NV)
 985             mt = SVt_PVNV;
 986         break;
 987     case SVt_PVIV:
 988         pv      = SvPVX(sv);
 989         cur     = SvCUR(sv);
 990         len     = SvLEN(sv);
 991         iv      = SvIVX(sv);
 992         nv      = 0.0;
 993         magic   = 0;
 994         stash   = 0;
 995         del_XPVIV(SvANY(sv));
 996         break;
 997     case SVt_PVNV:
 998         pv      = SvPVX(sv);
 999         cur     = SvCUR(sv);
1000         len     = SvLEN(sv);
1001         iv      = SvIVX(sv);
1002         nv      = SvNVX(sv);
1003         magic   = 0;
1004         stash   = 0;
1005         del_XPVNV(SvANY(sv));
1006         break;
1007     case SVt_PVMG:
1008         pv      = SvPVX(sv);
1009         cur     = SvCUR(sv);
1010         len     = SvLEN(sv);
1011         iv      = SvIVX(sv);
1012         nv      = SvNVX(sv);
1013         magic   = SvMAGIC(sv);
1014         stash   = SvSTASH(sv);
1015         del_XPVMG(SvANY(sv));
1016         break;
1017     default:
1018         Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1019     }
1020
1021     switch (mt) {
1022     case SVt_NULL:
1023         Perl_croak(aTHX_ "Can't upgrade to undef");
1024     case SVt_IV:
1025         SvANY(sv) = new_XIV();
1026         SvIVX(sv)       = iv;
1027         break;
1028     case SVt_NV:
1029         SvANY(sv) = new_XNV();
1030         SvNVX(sv)       = nv;
1031         break;
1032     case SVt_RV:
1033         SvANY(sv) = new_XRV();
1034         SvRV(sv) = (SV*)pv;
1035         break;
1036     case SVt_PV:
1037         SvANY(sv) = new_XPV();
1038         SvPVX(sv)       = pv;
1039         SvCUR(sv)       = cur;
1040         SvLEN(sv)       = len;
1041         break;
1042     case SVt_PVIV:
1043         SvANY(sv) = new_XPVIV();
1044         SvPVX(sv)       = pv;
1045         SvCUR(sv)       = cur;
1046         SvLEN(sv)       = len;
1047         SvIVX(sv)       = iv;
1048         if (SvNIOK(sv))
1049             (void)SvIOK_on(sv);
1050         SvNOK_off(sv);
1051         break;
1052     case SVt_PVNV:
1053         SvANY(sv) = new_XPVNV();
1054         SvPVX(sv)       = pv;
1055         SvCUR(sv)       = cur;
1056         SvLEN(sv)       = len;
1057         SvIVX(sv)       = iv;
1058         SvNVX(sv)       = nv;
1059         break;
1060     case SVt_PVMG:
1061         SvANY(sv) = new_XPVMG();
1062         SvPVX(sv)       = pv;
1063         SvCUR(sv)       = cur;
1064         SvLEN(sv)       = len;
1065         SvIVX(sv)       = iv;
1066         SvNVX(sv)       = nv;
1067         SvMAGIC(sv)     = magic;
1068         SvSTASH(sv)     = stash;
1069         break;
1070     case SVt_PVLV:
1071         SvANY(sv) = new_XPVLV();
1072         SvPVX(sv)       = pv;
1073         SvCUR(sv)       = cur;
1074         SvLEN(sv)       = len;
1075         SvIVX(sv)       = iv;
1076         SvNVX(sv)       = nv;
1077         SvMAGIC(sv)     = magic;
1078         SvSTASH(sv)     = stash;
1079         LvTARGOFF(sv)   = 0;
1080         LvTARGLEN(sv)   = 0;
1081         LvTARG(sv)      = 0;
1082         LvTYPE(sv)      = 0;
1083         break;
1084     case SVt_PVAV:
1085         SvANY(sv) = new_XPVAV();
1086         if (pv)
1087             Safefree(pv);
1088         SvPVX(sv)       = 0;
1089         AvMAX(sv)       = -1;
1090         AvFILLp(sv)     = -1;
1091         SvIVX(sv)       = 0;
1092         SvNVX(sv)       = 0.0;
1093         SvMAGIC(sv)     = magic;
1094         SvSTASH(sv)     = stash;
1095         AvALLOC(sv)     = 0;
1096         AvARYLEN(sv)    = 0;
1097         AvFLAGS(sv)     = 0;
1098         break;
1099     case SVt_PVHV:
1100         SvANY(sv) = new_XPVHV();
1101         if (pv)
1102             Safefree(pv);
1103         SvPVX(sv)       = 0;
1104         HvFILL(sv)      = 0;
1105         HvMAX(sv)       = 0;
1106         HvKEYS(sv)      = 0;
1107         SvNVX(sv)       = 0.0;
1108         SvMAGIC(sv)     = magic;
1109         SvSTASH(sv)     = stash;
1110         HvRITER(sv)     = 0;
1111         HvEITER(sv)     = 0;
1112         HvPMROOT(sv)    = 0;
1113         HvNAME(sv)      = 0;
1114         break;
1115     case SVt_PVCV:
1116         SvANY(sv) = new_XPVCV();
1117         Zero(SvANY(sv), 1, XPVCV);
1118         SvPVX(sv)       = pv;
1119         SvCUR(sv)       = cur;
1120         SvLEN(sv)       = len;
1121         SvIVX(sv)       = iv;
1122         SvNVX(sv)       = nv;
1123         SvMAGIC(sv)     = magic;
1124         SvSTASH(sv)     = stash;
1125         break;
1126     case SVt_PVGV:
1127         SvANY(sv) = new_XPVGV();
1128         SvPVX(sv)       = pv;
1129         SvCUR(sv)       = cur;
1130         SvLEN(sv)       = len;
1131         SvIVX(sv)       = iv;
1132         SvNVX(sv)       = nv;
1133         SvMAGIC(sv)     = magic;
1134         SvSTASH(sv)     = stash;
1135         GvGP(sv)        = 0;
1136         GvNAME(sv)      = 0;
1137         GvNAMELEN(sv)   = 0;
1138         GvSTASH(sv)     = 0;
1139         GvFLAGS(sv)     = 0;
1140         break;
1141     case SVt_PVBM:
1142         SvANY(sv) = new_XPVBM();
1143         SvPVX(sv)       = pv;
1144         SvCUR(sv)       = cur;
1145         SvLEN(sv)       = len;
1146         SvIVX(sv)       = iv;
1147         SvNVX(sv)       = nv;
1148         SvMAGIC(sv)     = magic;
1149         SvSTASH(sv)     = stash;
1150         BmRARE(sv)      = 0;
1151         BmUSEFUL(sv)    = 0;
1152         BmPREVIOUS(sv)  = 0;
1153         break;
1154     case SVt_PVFM:
1155         SvANY(sv) = new_XPVFM();
1156         Zero(SvANY(sv), 1, XPVFM);
1157         SvPVX(sv)       = pv;
1158         SvCUR(sv)       = cur;
1159         SvLEN(sv)       = len;
1160         SvIVX(sv)       = iv;
1161         SvNVX(sv)       = nv;
1162         SvMAGIC(sv)     = magic;
1163         SvSTASH(sv)     = stash;
1164         break;
1165     case SVt_PVIO:
1166         SvANY(sv) = new_XPVIO();
1167         Zero(SvANY(sv), 1, XPVIO);
1168         SvPVX(sv)       = pv;
1169         SvCUR(sv)       = cur;
1170         SvLEN(sv)       = len;
1171         SvIVX(sv)       = iv;
1172         SvNVX(sv)       = nv;
1173         SvMAGIC(sv)     = magic;
1174         SvSTASH(sv)     = stash;
1175         IoPAGE_LEN(sv)  = 60;
1176         break;
1177     }
1178     SvFLAGS(sv) &= ~SVTYPEMASK;
1179     SvFLAGS(sv) |= mt;
1180     return TRUE;
1181 }
1182
1183 int
1184 Perl_sv_backoff(pTHX_ register SV *sv)
1185 {
1186     assert(SvOOK(sv));
1187     if (SvIVX(sv)) {
1188         char *s = SvPVX(sv);
1189         SvLEN(sv) += SvIVX(sv);
1190         SvPVX(sv) -= SvIVX(sv);
1191         SvIV_set(sv, 0);
1192         Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1193     }
1194     SvFLAGS(sv) &= ~SVf_OOK;
1195     return 0;
1196 }
1197
1198 /*
1199 =for apidoc sv_grow
1200
1201 Expands the character buffer in the SV.  This will use C<sv_unref> and will
1202 upgrade the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
1203 Use C<SvGROW>.
1204
1205 =cut
1206 */
1207
1208 char *
1209 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1210 {
1211     register char *s;
1212
1213 #ifdef HAS_64K_LIMIT
1214     if (newlen >= 0x10000) {
1215         PerlIO_printf(Perl_debug_log,
1216                       "Allocation too large: %"UVxf"\n", (UV)newlen);
1217         my_exit(1);
1218     }
1219 #endif /* HAS_64K_LIMIT */
1220     if (SvROK(sv))
1221         sv_unref(sv);
1222     if (SvTYPE(sv) < SVt_PV) {
1223         sv_upgrade(sv, SVt_PV);
1224         s = SvPVX(sv);
1225     }
1226     else if (SvOOK(sv)) {       /* pv is offset? */
1227         sv_backoff(sv);
1228         s = SvPVX(sv);
1229         if (newlen > SvLEN(sv))
1230             newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1231 #ifdef HAS_64K_LIMIT
1232         if (newlen >= 0x10000)
1233             newlen = 0xFFFF;
1234 #endif
1235     }
1236     else
1237         s = SvPVX(sv);
1238     if (newlen > SvLEN(sv)) {           /* need more room? */
1239         if (SvLEN(sv) && s) {
1240 #if defined(MYMALLOC) && !defined(LEAKTEST)
1241             STRLEN l = malloced_size((void*)SvPVX(sv));
1242             if (newlen <= l) {
1243                 SvLEN_set(sv, l);
1244                 return s;
1245             } else
1246 #endif
1247             Renew(s,newlen,char);
1248         }
1249         else
1250             New(703,s,newlen,char);
1251         SvPV_set(sv, s);
1252         SvLEN_set(sv, newlen);
1253     }
1254     return s;
1255 }
1256
1257 /*
1258 =for apidoc sv_setiv
1259
1260 Copies an integer into the given SV.  Does not handle 'set' magic.  See
1261 C<sv_setiv_mg>.
1262
1263 =cut
1264 */
1265
1266 void
1267 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1268 {
1269     SV_CHECK_THINKFIRST(sv);
1270     switch (SvTYPE(sv)) {
1271     case SVt_NULL:
1272         sv_upgrade(sv, SVt_IV);
1273         break;
1274     case SVt_NV:
1275         sv_upgrade(sv, SVt_PVNV);
1276         break;
1277     case SVt_RV:
1278     case SVt_PV:
1279         sv_upgrade(sv, SVt_PVIV);
1280         break;
1281
1282     case SVt_PVGV:
1283     case SVt_PVAV:
1284     case SVt_PVHV:
1285     case SVt_PVCV:
1286     case SVt_PVFM:
1287     case SVt_PVIO:
1288         Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1289                    PL_op_desc[PL_op->op_type]);
1290     }
1291     (void)SvIOK_only(sv);                       /* validate number */
1292     SvIVX(sv) = i;
1293     SvTAINT(sv);
1294 }
1295
1296 /*
1297 =for apidoc sv_setiv_mg
1298
1299 Like C<sv_setiv>, but also handles 'set' magic.
1300
1301 =cut
1302 */
1303
1304 void
1305 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1306 {
1307     sv_setiv(sv,i);
1308     SvSETMAGIC(sv);
1309 }
1310
1311 /*
1312 =for apidoc sv_setuv
1313
1314 Copies an unsigned integer into the given SV.  Does not handle 'set' magic.
1315 See C<sv_setuv_mg>.
1316
1317 =cut
1318 */
1319
1320 void
1321 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1322 {
1323     /* With these two if statements:
1324        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1325
1326        without
1327        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1328
1329        If you wish to remove them, please benchmark to see what the effect is
1330     */
1331     if (u <= (UV)IV_MAX) {
1332        sv_setiv(sv, (IV)u);
1333        return;
1334     }
1335     sv_setiv(sv, 0);
1336     SvIsUV_on(sv);
1337     SvUVX(sv) = u;
1338 }
1339
1340 /*
1341 =for apidoc sv_setuv_mg
1342
1343 Like C<sv_setuv>, but also handles 'set' magic.
1344
1345 =cut
1346 */
1347
1348 void
1349 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1350 {
1351     /* With these two if statements:
1352        u=1.49  s=0.52  cu=72.49  cs=10.64  scripts=270  tests=20865
1353
1354        without
1355        u=1.35  s=0.47  cu=73.45  cs=11.43  scripts=270  tests=20865
1356
1357        If you wish to remove them, please benchmark to see what the effect is
1358     */
1359     if (u <= (UV)IV_MAX) {
1360        sv_setiv(sv, (IV)u);
1361     } else {
1362        sv_setiv(sv, 0);
1363        SvIsUV_on(sv);
1364        sv_setuv(sv,u);
1365     }
1366     SvSETMAGIC(sv);
1367 }
1368
1369 /*
1370 =for apidoc sv_setnv
1371
1372 Copies a double into the given SV.  Does not handle 'set' magic.  See
1373 C<sv_setnv_mg>.
1374
1375 =cut
1376 */
1377
1378 void
1379 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1380 {
1381     SV_CHECK_THINKFIRST(sv);
1382     switch (SvTYPE(sv)) {
1383     case SVt_NULL:
1384     case SVt_IV:
1385         sv_upgrade(sv, SVt_NV);
1386         break;
1387     case SVt_RV:
1388     case SVt_PV:
1389     case SVt_PVIV:
1390         sv_upgrade(sv, SVt_PVNV);
1391         break;
1392
1393     case SVt_PVGV:
1394     case SVt_PVAV:
1395     case SVt_PVHV:
1396     case SVt_PVCV:
1397     case SVt_PVFM:
1398     case SVt_PVIO:
1399         Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1400                    PL_op_name[PL_op->op_type]);
1401     }
1402     SvNVX(sv) = num;
1403     (void)SvNOK_only(sv);                       /* validate number */
1404     SvTAINT(sv);
1405 }
1406
1407 /*
1408 =for apidoc sv_setnv_mg
1409
1410 Like C<sv_setnv>, but also handles 'set' magic.
1411
1412 =cut
1413 */
1414
1415 void
1416 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1417 {
1418     sv_setnv(sv,num);
1419     SvSETMAGIC(sv);
1420 }
1421
1422 STATIC void
1423 S_not_a_number(pTHX_ SV *sv)
1424 {
1425     char tmpbuf[64];
1426     char *d = tmpbuf;
1427     char *s;
1428     char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1429                   /* each *s can expand to 4 chars + "...\0",
1430                      i.e. need room for 8 chars */
1431
1432     for (s = SvPVX(sv); *s && d < limit; s++) {
1433         int ch = *s & 0xFF;
1434         if (ch & 128 && !isPRINT_LC(ch)) {
1435             *d++ = 'M';
1436             *d++ = '-';
1437             ch &= 127;
1438         }
1439         if (ch == '\n') {
1440             *d++ = '\\';
1441             *d++ = 'n';
1442         }
1443         else if (ch == '\r') {
1444             *d++ = '\\';
1445             *d++ = 'r';
1446         }
1447         else if (ch == '\f') {
1448             *d++ = '\\';
1449             *d++ = 'f';
1450         }
1451         else if (ch == '\\') {
1452             *d++ = '\\';
1453             *d++ = '\\';
1454         }
1455         else if (isPRINT_LC(ch))
1456             *d++ = ch;
1457         else {
1458             *d++ = '^';
1459             *d++ = toCTRL(ch);
1460         }
1461     }
1462     if (*s) {
1463         *d++ = '.';
1464         *d++ = '.';
1465         *d++ = '.';
1466     }
1467     *d = '\0';
1468
1469     if (PL_op)
1470         Perl_warner(aTHX_ WARN_NUMERIC,
1471                     "Argument \"%s\" isn't numeric in %s", tmpbuf,
1472                 PL_op_desc[PL_op->op_type]);
1473     else
1474         Perl_warner(aTHX_ WARN_NUMERIC,
1475                     "Argument \"%s\" isn't numeric", tmpbuf);
1476 }
1477
1478 /* the number can be converted to integer with atol() or atoll() although */
1479 #define IS_NUMBER_TO_INT_BY_ATOL     0x01 /* integer (may have decimals) */
1480 #define IS_NUMBER_TO_INT_BY_STRTOL   0x02 /* it may exceed IV_MAX */
1481 #define IS_NUMBER_TO_INT_BY_ATOF     0x04 /* seen something like 123e4 */
1482 #define IS_NUMBER_LONGER_THAN_IV_MAX 0x08 /* more digits than IV_MAX */
1483 #define IS_NUMBER_AS_LONG_AS_IV_MAX  0x10 /* may(be not) larger than IV_MAX */
1484 #define IS_NUMBER_NOT_INT            0x20 /* seen a decimal point or e */
1485 #define IS_NUMBER_NEG                0x40 /* seen a leading - */
1486 #define IS_NUMBER_INFINITY           0x80 /* /^\s*-?Infinity\s*$/i */
1487
1488 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1489    until proven guilty, assume that things are not that bad... */
1490
1491 /* As 64 bit platforms often have an NV that doesn't preserve all bits of
1492    an IV (an assumption perl has been based on to date) it becomes necessary
1493    to remove the assumption that the NV always carries enough precision to
1494    recreate the IV whenever needed, and that the NV is the canonical form.
1495    Instead, IV/UV and NV need to be given equal rights. So as to not lose
1496    precision as an side effect of conversion (which would lead to insanity
1497    and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1498    1) to distinguish between IV/UV/NV slots that have cached a valid
1499       conversion where precision was lost and IV/UV/NV slots that have a
1500       valid conversion which has lost no precision
1501    2) to ensure that if a numeric conversion to one form is request that
1502       would lose precision, the precise conversion (or differently
1503       imprecise conversion) is also performed and cached, to prevent
1504       requests for different numeric formats on the same SV causing
1505       lossy conversion chains. (lossless conversion chains are perfectly
1506       acceptable (still))
1507
1508
1509    flags are used:
1510    SvIOKp is true if the IV slot contains a valid value
1511    SvIOK  is true only if the IV value is accurate (UV if SvIOK_UV true)
1512    SvNOKp is true if the NV slot contains a valid value
1513    SvNOK  is true only if the NV value is accurate
1514
1515    so
1516    while converting from PV to NV check to see if converting that NV to an
1517    IV(or UV) would lose accuracy over a direct conversion from PV to
1518    IV(or UV). If it would, cache both conversions, return NV, but mark
1519    SV as IOK NOKp (ie not NOK).
1520
1521    while converting from PV to IV check to see if converting that IV to an
1522    NV would lose accuracy over a direct conversion from PV to NV. If it
1523    would, cache both conversions, flag similarly.
1524
1525    Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1526    correctly because if IV & NV were set NV *always* overruled.
1527    Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flags meaning
1528    changes - now IV and NV together means that the two are interchangeable
1529    SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1530
1531    The benefit of this is operations such as pp_add know that if SvIOK is
1532    true for both left and right operands, then integer addition can be
1533    used instead of floating point. (for cases where the result won't
1534    overflow) Before, floating point was always used, which could lead to
1535    loss of precision compared with integer addition.
1536
1537    * making IV and NV equal status should make maths accurate on 64 bit
1538      platforms
1539    * may speed up maths somewhat if pp_add and friends start to use
1540      integers when possible instead of fp. (hopefully the overhead in
1541      looking for SvIOK and checking for overflow will not outweigh the
1542      fp to integer speedup)
1543    * will slow down integer operations (callers of SvIV) on "inaccurate"
1544      values, as the change from SvIOK to SvIOKp will cause a call into
1545      sv_2iv each time rather than a macro access direct to the IV slot
1546    * should speed up number->string conversion on integers as IV is
1547      favoured when IV and NV equally accurate
1548
1549    ####################################################################
1550    You had better be using SvIOK_notUV if you want an IV for arithmetic
1551    SvIOK is true if (IV or UV), so you might be getting (IV)SvUV
1552    SvUOK is true iff UV.
1553    ####################################################################
1554
1555    Your mileage will vary depending your CPUs relative fp to integer
1556    performance ratio.
1557 */
1558
1559 #ifndef NV_PRESERVES_UV
1560 #define IS_NUMBER_UNDERFLOW_IV 1
1561 #define IS_NUMBER_UNDERFLOW_UV 2
1562 #define IS_NUMBER_IV_AND_UV 2
1563 #define IS_NUMBER_OVERFLOW_IV 4
1564 #define IS_NUMBER_OVERFLOW_UV 5
1565 /* Hopefully your optimiser will consider inlining these two functions.  */
1566 STATIC int
1567 S_sv_2inuv_non_preserve (pTHX_ register SV *sv, I32 numtype) {
1568     NV nv = SvNVX(sv);          /* Code simpler and had compiler problems if */
1569     UV nv_as_uv = U_V(nv);      /*  these are not in simple variables.   */
1570     DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2inuv_non '%s', IV=0x%"UVxf" NV=%g inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), nv, (UV)numtype));
1571     if (nv_as_uv <= (UV)IV_MAX) {
1572         (void)SvIOKp_on(sv);
1573         (void)SvNOKp_on(sv);
1574         /* Within suitable range to fit in an IV,  atol won't overflow */
1575         /* XXX quite sure? Is that your final answer? not really, I'm
1576            trusting that nv_as_uv to round down if NV is (IV_MAX + 1) */
1577         SvIVX(sv) = (IV)Atol(SvPVX(sv));
1578         if (numtype & IS_NUMBER_NOT_INT) {
1579             /* I believe that even if the original PV had decimals, they
1580                are lost beyond the limit of the FP precision.
1581                However, neither is canonical, so both only get p flags.
1582                NWC, 2000/11/25 */
1583             /* Both already have p flags, so do nothing */
1584         } else if (SvIVX(sv) == I_V(nv)) {
1585             SvNOK_on(sv);
1586             SvIOK_on(sv);
1587         } else {
1588             SvIOK_on(sv);
1589             /* It had no "." so it must be integer.  assert (get in here from
1590                sv_2iv and sv_2uv only for ndef HAS_STRTOL and
1591                IS_NUMBER_AS_LONG_AS_IV_MAX) or my logic is faulty and all
1592                conversion routines need audit.  */
1593         }
1594         return nv < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1595     }
1596     /* between IV_MAX and NV(UV_MAX). Could be slightly> UV_MAX */
1597     (void)SvIOKp_on(sv);
1598     (void)SvNOKp_on(sv);
1599 #ifdef HAS_STRTOUL
1600     {
1601         int save_errno = errno;
1602         errno = 0;
1603         SvUVX(sv) = Strtoul(SvPVX(sv), Null(char**), 10);
1604         if (errno == 0) {
1605             if (numtype & IS_NUMBER_NOT_INT) {
1606                 /* UV and NV both imprecise.  */
1607                 SvIsUV_on(sv);
1608             } else if (SvUVX(sv) == nv_as_uv && SvUVX(sv) != UV_MAX) {
1609                 SvNOK_on(sv);
1610                 SvIOK_on(sv);
1611                 SvIsUV_on(sv);
1612             } else {
1613                 SvIOK_on(sv);
1614                 SvIsUV_on(sv);
1615             }
1616             errno = save_errno;
1617             return IS_NUMBER_OVERFLOW_IV;
1618         }
1619         errno = save_errno;
1620         SvNOK_on(sv);
1621         /* Must have just overflowed UV, but not enough that an NV could spot
1622            this.. */
1623         return IS_NUMBER_OVERFLOW_UV;
1624     }
1625 #else
1626     /* We've just lost integer precision, nothing we could do. */
1627     SvUVX(sv) = nv_as_uv;
1628     DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2niuv_non UV? '%s', UV=0x%"UVxf" NV=%g U_V(NV)=0x%"UVxf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), nv, nv_as_uv, (UV)numtype));
1629     /* UV and NV slots equally valid only if we have casting symmetry. */
1630     if (numtype & IS_NUMBER_NOT_INT) {
1631         SvIsUV_on(sv);
1632     } else if (SvUVX(sv) == nv_as_uv && SvUVX(sv) != UV_MAX) {
1633         /* UV_MAX can cast up to NV (UV_MAX+1), that NV casts down to UV_MAX
1634            UV_MAX ought to be 0xFF...FFF which won't preserve (We only
1635            get to this point if NVs don't preserve UVs) */
1636         SvNOK_on(sv);
1637         SvIOK_on(sv);
1638         SvIsUV_on(sv);
1639     } else {
1640         /* As above, I believe UV at least as good as NV */
1641         SvIsUV_on(sv);
1642     }
1643 #endif /* HAS_STRTOUL */
1644     return IS_NUMBER_OVERFLOW_IV;
1645 }
1646
1647 /* For sv_2nv these three cases are "SvNOK and don't bother casting"  */
1648 STATIC int
1649 S_sv_2iuv_non_preserve (pTHX_ register SV *sv, I32 numtype)
1650 {
1651     DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%g inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1652     if (SvNVX(sv) < (NV)IV_MIN) {
1653         (void)SvIOKp_on(sv);
1654         (void)SvNOK_on(sv);
1655         SvIVX(sv) = IV_MIN;
1656         return IS_NUMBER_UNDERFLOW_IV;
1657     }
1658     if (SvNVX(sv) > (NV)UV_MAX) {
1659         (void)SvIOKp_on(sv);
1660         (void)SvNOK_on(sv);
1661         SvIsUV_on(sv);
1662         SvUVX(sv) = UV_MAX;
1663         return IS_NUMBER_OVERFLOW_UV;
1664     }
1665     if (!(numtype & (IS_NUMBER_TO_INT_BY_ATOL | IS_NUMBER_TO_INT_BY_STRTOL))) {
1666         (void)SvIOKp_on(sv);
1667         (void)SvNOK_on(sv);
1668         /* Can't use strtol etc to convert this string */
1669         if (SvNVX(sv) <= (UV)IV_MAX) {
1670             SvIVX(sv) = I_V(SvNVX(sv));
1671             if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1672                 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1673             } else {
1674                 /* Integer is imprecise. NOK, IOKp */
1675             }
1676             return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1677         }
1678         SvIsUV_on(sv);
1679         SvUVX(sv) = U_V(SvNVX(sv));
1680         if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1681             if (SvUVX(sv) == UV_MAX) {
1682                 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1683                    possibly be preserved by NV. Hence, it must be overflow.
1684                    NOK, IOKp */
1685                 return IS_NUMBER_OVERFLOW_UV;
1686             }
1687             SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1688         } else {
1689             /* Integer is imprecise. NOK, IOKp */
1690         }
1691         return IS_NUMBER_OVERFLOW_IV;
1692     }
1693     return S_sv_2inuv_non_preserve(aTHX_ sv, numtype);
1694 }
1695 #endif /* NV_PRESERVES_UV*/
1696
1697 IV
1698 Perl_sv_2iv(pTHX_ register SV *sv)
1699 {
1700     if (!sv)
1701         return 0;
1702     if (SvGMAGICAL(sv)) {
1703         mg_get(sv);
1704         if (SvIOKp(sv))
1705             return SvIVX(sv);
1706         if (SvNOKp(sv)) {
1707             return I_V(SvNVX(sv));
1708         }
1709         if (SvPOKp(sv) && SvLEN(sv))
1710             return asIV(sv);
1711         if (!SvROK(sv)) {
1712             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1713                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
1714                     report_uninit();
1715             }
1716             return 0;
1717         }
1718     }
1719     if (SvTHINKFIRST(sv)) {
1720         if (SvROK(sv)) {
1721           SV* tmpstr;
1722           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
1723                   (SvRV(tmpstr) != SvRV(sv)))
1724               return SvIV(tmpstr);
1725           return PTR2IV(SvRV(sv));
1726         }
1727         if (SvREADONLY(sv) && SvFAKE(sv)) {
1728             sv_force_normal(sv);
1729         }
1730         if (SvREADONLY(sv) && !SvOK(sv)) {
1731             if (ckWARN(WARN_UNINITIALIZED))
1732                 report_uninit();
1733             return 0;
1734         }
1735     }
1736     if (SvIOKp(sv)) {
1737         if (SvIsUV(sv)) {
1738             return (IV)(SvUVX(sv));
1739         }
1740         else {
1741             return SvIVX(sv);
1742         }
1743     }
1744     if (SvNOKp(sv)) {
1745         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1746          * without also getting a cached IV/UV from it at the same time
1747          * (ie PV->NV conversion should detect loss of accuracy and cache
1748          * IV or UV at same time to avoid this.  NWC */
1749
1750         if (SvTYPE(sv) == SVt_NV)
1751             sv_upgrade(sv, SVt_PVNV);
1752
1753         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
1754         /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1755            certainly cast into the IV range at IV_MAX, whereas the correct
1756            answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1757            cases go to UV */
1758         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1759             SvIVX(sv) = I_V(SvNVX(sv));
1760             if (SvNVX(sv) == (NV) SvIVX(sv)
1761 #ifndef NV_PRESERVES_UV
1762                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1763                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1764                 /* Don't flag it as "accurately an integer" if the number
1765                    came from a (by definition imprecise) NV operation, and
1766                    we're outside the range of NV integer precision */
1767 #endif
1768                 ) {
1769                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
1770                 DEBUG_c(PerlIO_printf(Perl_debug_log,
1771                                       "0x%"UVxf" iv(%g => %"IVdf") (precise)\n",
1772                                       PTR2UV(sv),
1773                                       SvNVX(sv),
1774                                       SvIVX(sv)));
1775
1776             } else {
1777                 /* IV not precise.  No need to convert from PV, as NV
1778                    conversion would already have cached IV if it detected
1779                    that PV->IV would be better than PV->NV->IV
1780                    flags already correct - don't set public IOK.  */
1781                 DEBUG_c(PerlIO_printf(Perl_debug_log,
1782                                       "0x%"UVxf" iv(%g => %"IVdf") (imprecise)\n",
1783                                       PTR2UV(sv),
1784                                       SvNVX(sv),
1785                                       SvIVX(sv)));
1786             }
1787             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1788                but the cast (NV)IV_MIN rounds to a the value less (more
1789                negative) than IV_MIN which happens to be equal to SvNVX ??
1790                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1791                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1792                (NV)UVX == NVX are both true, but the values differ. :-(
1793                Hopefully for 2s complement IV_MIN is something like
1794                0x8000000000000000 which will be exact. NWC */
1795         }
1796         else {
1797             SvUVX(sv) = U_V(SvNVX(sv));
1798             if (
1799                 (SvNVX(sv) == (NV) SvUVX(sv))
1800 #ifndef  NV_PRESERVES_UV
1801                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1802                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1803                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1804                 /* Don't flag it as "accurately an integer" if the number
1805                    came from a (by definition imprecise) NV operation, and
1806                    we're outside the range of NV integer precision */
1807 #endif
1808                 )
1809                 SvIOK_on(sv);
1810             SvIsUV_on(sv);
1811           ret_iv_max:
1812             DEBUG_c(PerlIO_printf(Perl_debug_log,
1813                                   "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1814                                   PTR2UV(sv),
1815                                   SvUVX(sv),
1816                                   SvUVX(sv)));
1817             return (IV)SvUVX(sv);
1818         }
1819     }
1820     else if (SvPOKp(sv) && SvLEN(sv)) {
1821         I32 numtype = looks_like_number(sv);
1822
1823         /* We want to avoid a possible problem when we cache an IV which
1824            may be later translated to an NV, and the resulting NV is not
1825            the translation of the initial data.
1826
1827            This means that if we cache such an IV, we need to cache the
1828            NV as well.  Moreover, we trade speed for space, and do not
1829            cache the NV if we are sure it's not needed.
1830          */
1831
1832         if ((numtype & ~IS_NUMBER_NEG) == IS_NUMBER_TO_INT_BY_ATOL) {
1833             /* The NV may be reconstructed from IV - safe to cache IV,
1834                 which may be calculated by atol(). */
1835             if (SvTYPE(sv) < SVt_PVIV)
1836                 sv_upgrade(sv, SVt_PVIV);
1837             (void)SvIOK_on(sv);
1838             SvIVX(sv) = Atol(SvPVX(sv));
1839         } else {
1840 #ifdef HAS_STRTOL
1841             IV i;
1842             int save_errno = errno;
1843             /* Is it an integer that we could convert with strtol?
1844                So try it, and if it doesn't set errno then it's pukka.
1845                This should be faster than going atof and then thinking.  */
1846             if (((numtype & (IS_NUMBER_TO_INT_BY_STRTOL | IS_NUMBER_NOT_INT))
1847                   == IS_NUMBER_TO_INT_BY_STRTOL)
1848                 /* && is a sequence point. Without it not sure if I'm trying
1849                    to do too much between sequence points and hence going
1850                    undefined */
1851                 && ((errno = 0), 1) /* , 1 so always true */
1852                 && ((i = Strtol(SvPVX(sv), Null(char**), 10)), 1)
1853                 && (errno == 0)) {
1854                 if (SvTYPE(sv) < SVt_PVIV)
1855                     sv_upgrade(sv, SVt_PVIV);
1856                 (void)SvIOK_on(sv);
1857                 SvIVX(sv) = i;
1858                 errno = save_errno;
1859             } else
1860 #endif
1861             {
1862                 NV d;
1863 #ifdef HAS_STRTOL
1864                 /* Hopefully trace flow will optimise this away where possible
1865                  */
1866                 errno = save_errno;
1867 #endif
1868                 /* It wasn't an integer, or it overflowed, or we don't have
1869                    strtol. Do things the slow way - check if it's a UV etc. */
1870                 d = Atof(SvPVX(sv));
1871
1872                 if (SvTYPE(sv) < SVt_PVNV)
1873                     sv_upgrade(sv, SVt_PVNV);
1874                 SvNVX(sv) = d;
1875
1876                 if (! numtype && ckWARN(WARN_NUMERIC))
1877                     not_a_number(sv);
1878
1879 #if defined(USE_LONG_DOUBLE)
1880                 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1881                                       PTR2UV(sv), SvNVX(sv)));
1882 #else
1883                 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%g)\n",
1884                                       PTR2UV(sv), SvNVX(sv)));
1885 #endif
1886
1887
1888 #ifdef NV_PRESERVES_UV
1889                 (void)SvIOKp_on(sv);
1890                 (void)SvNOK_on(sv);
1891                 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1892                     SvIVX(sv) = I_V(SvNVX(sv));
1893                     if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1894                         SvIOK_on(sv);
1895                     } else {
1896                         /* Integer is imprecise. NOK, IOKp */
1897                     }
1898                     /* UV will not work better than IV */
1899                 } else {
1900                     if (SvNVX(sv) > (NV)UV_MAX) {
1901                         SvIsUV_on(sv);
1902                         /* Integer is inaccurate. NOK, IOKp, is UV */
1903                         SvUVX(sv) = UV_MAX;
1904                         SvIsUV_on(sv);
1905                     } else {
1906                         SvUVX(sv) = U_V(SvNVX(sv));
1907                         /* 0xFFFFFFFFFFFFFFFF not an issue in here */
1908                         if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1909                             SvIOK_on(sv);
1910                             SvIsUV_on(sv);
1911                         } else {
1912                             /* Integer is imprecise. NOK, IOKp, is UV */
1913                             SvIsUV_on(sv);
1914                         }
1915                     }
1916                     goto ret_iv_max;
1917                 }
1918 #else /* NV_PRESERVES_UV */
1919                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1920                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1921                     /* Small enough to preserve all bits. */
1922                     (void)SvIOKp_on(sv);
1923                     SvNOK_on(sv);
1924                     SvIVX(sv) = I_V(SvNVX(sv));
1925                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
1926                         SvIOK_on(sv);
1927                     /* Assumption: first non-preserved integer is < IV_MAX,
1928                        this NV is in the preserved range, therefore: */
1929                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1930                           < (UV)IV_MAX)) {
1931                         Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs(SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%g U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
1932                     }
1933                 } else if (sv_2iuv_non_preserve (sv, numtype)
1934                            >= IS_NUMBER_OVERFLOW_IV)
1935                     goto ret_iv_max;
1936 #endif /* NV_PRESERVES_UV */
1937             }
1938         }
1939     } else  {
1940         if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
1941             report_uninit();
1942         if (SvTYPE(sv) < SVt_IV)
1943             /* Typically the caller expects that sv_any is not NULL now.  */
1944             sv_upgrade(sv, SVt_IV);
1945         return 0;
1946     }
1947     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1948         PTR2UV(sv),SvIVX(sv)));
1949     return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1950 }
1951
1952 UV
1953 Perl_sv_2uv(pTHX_ register SV *sv)
1954 {
1955     if (!sv)
1956         return 0;
1957     if (SvGMAGICAL(sv)) {
1958         mg_get(sv);
1959         if (SvIOKp(sv))
1960             return SvUVX(sv);
1961         if (SvNOKp(sv))
1962             return U_V(SvNVX(sv));
1963         if (SvPOKp(sv) && SvLEN(sv))
1964             return asUV(sv);
1965         if (!SvROK(sv)) {
1966             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1967                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
1968                     report_uninit();
1969             }
1970             return 0;
1971         }
1972     }
1973     if (SvTHINKFIRST(sv)) {
1974         if (SvROK(sv)) {
1975           SV* tmpstr;
1976           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
1977                   (SvRV(tmpstr) != SvRV(sv)))
1978               return SvUV(tmpstr);
1979           return PTR2UV(SvRV(sv));
1980         }
1981         if (SvREADONLY(sv) && SvFAKE(sv)) {
1982             sv_force_normal(sv);
1983         }
1984         if (SvREADONLY(sv) && !SvOK(sv)) {
1985             if (ckWARN(WARN_UNINITIALIZED))
1986                 report_uninit();
1987             return 0;
1988         }
1989     }
1990     if (SvIOKp(sv)) {
1991         if (SvIsUV(sv)) {
1992             return SvUVX(sv);
1993         }
1994         else {
1995             return (UV)SvIVX(sv);
1996         }
1997     }
1998     if (SvNOKp(sv)) {
1999         /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2000          * without also getting a cached IV/UV from it at the same time
2001          * (ie PV->NV conversion should detect loss of accuracy and cache
2002          * IV or UV at same time to avoid this. */
2003         /* IV-over-UV optimisation - choose to cache IV if possible */
2004
2005         if (SvTYPE(sv) == SVt_NV)
2006             sv_upgrade(sv, SVt_PVNV);
2007
2008         (void)SvIOKp_on(sv);    /* Must do this first, to clear any SvOOK */
2009         if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2010             SvIVX(sv) = I_V(SvNVX(sv));
2011             if (SvNVX(sv) == (NV) SvIVX(sv)
2012 #ifndef NV_PRESERVES_UV
2013                 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2014                     (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2015                 /* Don't flag it as "accurately an integer" if the number
2016                    came from a (by definition imprecise) NV operation, and
2017                    we're outside the range of NV integer precision */
2018 #endif
2019                 ) {
2020                 SvIOK_on(sv);  /* Can this go wrong with rounding? NWC */
2021                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2022                                       "0x%"UVxf" uv(%g => %"IVdf") (precise)\n",
2023                                       PTR2UV(sv),
2024                                       SvNVX(sv),
2025                                       SvIVX(sv)));
2026
2027             } else {
2028                 /* IV not precise.  No need to convert from PV, as NV
2029                    conversion would already have cached IV if it detected
2030                    that PV->IV would be better than PV->NV->IV
2031                    flags already correct - don't set public IOK.  */
2032                 DEBUG_c(PerlIO_printf(Perl_debug_log,
2033                                       "0x%"UVxf" uv(%g => %"IVdf") (imprecise)\n",
2034                                       PTR2UV(sv),
2035                                       SvNVX(sv),
2036                                       SvIVX(sv)));
2037             }
2038             /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2039                but the cast (NV)IV_MIN rounds to a the value less (more
2040                negative) than IV_MIN which happens to be equal to SvNVX ??
2041                Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2042                NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2043                (NV)UVX == NVX are both true, but the values differ. :-(
2044                Hopefully for 2s complement IV_MIN is something like
2045                0x8000000000000000 which will be exact. NWC */
2046         }
2047         else {
2048             SvUVX(sv) = U_V(SvNVX(sv));
2049             if (
2050                 (SvNVX(sv) == (NV) SvUVX(sv))
2051 #ifndef  NV_PRESERVES_UV
2052                 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2053                 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2054                 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2055                 /* Don't flag it as "accurately an integer" if the number
2056                    came from a (by definition imprecise) NV operation, and
2057                    we're outside the range of NV integer precision */
2058 #endif
2059                 )
2060                 SvIOK_on(sv);
2061             SvIsUV_on(sv);
2062             DEBUG_c(PerlIO_printf(Perl_debug_log,
2063                                   "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2064                                   PTR2UV(sv),
2065                                   SvUVX(sv),
2066                                   SvUVX(sv)));
2067         }
2068     }
2069     else if (SvPOKp(sv) && SvLEN(sv)) {
2070         I32 numtype = looks_like_number(sv);
2071
2072         /* We want to avoid a possible problem when we cache a UV which
2073            may be later translated to an NV, and the resulting NV is not
2074            the translation of the initial data.
2075
2076            This means that if we cache such a UV, we need to cache the
2077            NV as well.  Moreover, we trade speed for space, and do not
2078            cache the NV if not needed.
2079          */
2080
2081         if ((numtype & ~IS_NUMBER_NEG) == IS_NUMBER_TO_INT_BY_ATOL) {
2082             /* The NV may be reconstructed from IV - safe to cache IV,
2083                 which may be calculated by atol(). */
2084             if (SvTYPE(sv) < SVt_PVIV)
2085                 sv_upgrade(sv, SVt_PVIV);
2086             (void)SvIOK_on(sv);
2087             SvIVX(sv) = Atol(SvPVX(sv));
2088         } else {
2089 #ifdef HAS_STRTOUL
2090             UV u;
2091             char *num_begin = SvPVX(sv);
2092             int save_errno = errno;
2093
2094             /* seems that strtoul taking numbers that start with - is
2095                implementation dependant, and can't be relied upon.  */
2096             if (numtype & IS_NUMBER_NEG) {
2097                 /* Not totally defensive. assumine that looks_like_num
2098                    didn't lie about a - sign */
2099                 while (isSPACE(*num_begin))
2100                     num_begin++;
2101                 if (*num_begin == '-')
2102                     num_begin++;
2103             }
2104
2105             /* Is it an integer that we could convert with strtoul?
2106                So try it, and if it doesn't set errno then it's pukka.
2107                This should be faster than going atof and then thinking.  */
2108             if (((numtype & (IS_NUMBER_TO_INT_BY_STRTOL | IS_NUMBER_NOT_INT))
2109                  == IS_NUMBER_TO_INT_BY_STRTOL)
2110                 && ((errno = 0), 1) /* always true */
2111                 && ((u = Strtoul(num_begin, Null(char**), 10)), 1) /* ditto */
2112                 && (errno == 0)
2113                 /* If known to be negative, check it didn't undeflow IV
2114                    XXX possibly we should put more negative values as NVs
2115                    direct rather than go via atof below */
2116                 && ((numtype & IS_NUMBER_NEG) ? (u <= (UV)IV_MIN) : 1)) {
2117                 errno = save_errno;
2118
2119                 if (SvTYPE(sv) < SVt_PVIV)
2120                     sv_upgrade(sv, SVt_PVIV);
2121                 (void)SvIOK_on(sv);
2122
2123                 /* If it's negative must use IV.
2124                    IV-over-UV optimisation */
2125                 if (numtype & IS_NUMBER_NEG) {
2126                     SvIVX(sv) = -(IV)u;
2127                 } else if (u <= (UV) IV_MAX) {
2128                     SvIVX(sv) = (IV)u;
2129                 } else {
2130                     /* it didn't overflow, and it was positive. */
2131                     SvUVX(sv) = u;
2132                     SvIsUV_on(sv);
2133                 }
2134             } else
2135 #endif
2136             {
2137                 NV d;
2138 #ifdef HAS_STRTOUL
2139                 /* Hopefully trace flow will optimise this away where possible
2140                  */
2141                 errno = save_errno;
2142 #endif
2143                 /* It wasn't an integer, or it overflowed, or we don't have
2144                    strtol. Do things the slow way - check if it's a IV etc. */
2145                 d = Atof(SvPVX(sv));
2146
2147                 if (SvTYPE(sv) < SVt_PVNV)
2148                     sv_upgrade(sv, SVt_PVNV);
2149                 SvNVX(sv) = d;
2150
2151                 if (! numtype && ckWARN(WARN_NUMERIC))
2152                     not_a_number(sv);
2153
2154 #if defined(USE_LONG_DOUBLE)
2155                 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2156                                       PTR2UV(sv), SvNVX(sv)));
2157 #else
2158                 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%g)\n",
2159                                       PTR2UV(sv), SvNVX(sv)));
2160 #endif
2161
2162 #ifdef NV_PRESERVES_UV
2163                 (void)SvIOKp_on(sv);
2164                 (void)SvNOK_on(sv);
2165                 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2166                     SvIVX(sv) = I_V(SvNVX(sv));
2167                     if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2168                         SvIOK_on(sv);
2169                     } else {
2170                         /* Integer is imprecise. NOK, IOKp */
2171                     }
2172                     /* UV will not work better than IV */
2173                 } else {
2174                     if (SvNVX(sv) > (NV)UV_MAX) {
2175                         SvIsUV_on(sv);
2176                         /* Integer is inaccurate. NOK, IOKp, is UV */
2177                         SvUVX(sv) = UV_MAX;
2178                         SvIsUV_on(sv);
2179                     } else {
2180                         SvUVX(sv) = U_V(SvNVX(sv));
2181                         /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2182                            NV preservse UV so can do correct comparison.  */
2183                         if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2184                             SvIOK_on(sv);
2185                             SvIsUV_on(sv);
2186                         } else {
2187                             /* Integer is imprecise. NOK, IOKp, is UV */
2188                             SvIsUV_on(sv);
2189                         }
2190                     }
2191                 }
2192 #else /* NV_PRESERVES_UV */
2193                 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2194                     U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2195                     /* Small enough to preserve all bits. */
2196                     (void)SvIOKp_on(sv);
2197                     SvNOK_on(sv);
2198                     SvIVX(sv) = I_V(SvNVX(sv));
2199                     if ((NV)(SvIVX(sv)) == SvNVX(sv))
2200                         SvIOK_on(sv);
2201                     /* Assumption: first non-preserved integer is < IV_MAX,
2202                        this NV is in the preserved range, therefore: */
2203                     if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2204                           < (UV)IV_MAX)) {
2205                         Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs(SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%g U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2206                     }
2207                 } else
2208                     sv_2iuv_non_preserve (sv, numtype);
2209 #endif /* NV_PRESERVES_UV */
2210             }
2211         }
2212     }
2213     else  {
2214         if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2215             if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2216                 report_uninit();
2217         }
2218         if (SvTYPE(sv) < SVt_IV)
2219             /* Typically the caller expects that sv_any is not NULL now.  */
2220             sv_upgrade(sv, SVt_IV);
2221         return 0;
2222     }
2223
2224     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2225                           PTR2UV(sv),SvUVX(sv)));
2226     return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2227 }
2228
2229 NV
2230 Perl_sv_2nv(pTHX_ register SV *sv)
2231 {
2232     if (!sv)
2233         return 0.0;
2234     if (SvGMAGICAL(sv)) {
2235         mg_get(sv);
2236         if (SvNOKp(sv))
2237             return SvNVX(sv);
2238         if (SvPOKp(sv) && SvLEN(sv)) {
2239             if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !looks_like_number(sv))
2240                 not_a_number(sv);
2241             return Atof(SvPVX(sv));
2242         }
2243         if (SvIOKp(sv)) {
2244             if (SvIsUV(sv))
2245                 return (NV)SvUVX(sv);
2246             else
2247                 return (NV)SvIVX(sv);
2248         }
2249         if (!SvROK(sv)) {
2250             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2251                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2252                     report_uninit();
2253             }
2254             return 0;
2255         }
2256     }
2257     if (SvTHINKFIRST(sv)) {
2258         if (SvROK(sv)) {
2259           SV* tmpstr;
2260           if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2261                   (SvRV(tmpstr) != SvRV(sv)))
2262               return SvNV(tmpstr);
2263           return PTR2NV(SvRV(sv));
2264         }
2265         if (SvREADONLY(sv) && SvFAKE(sv)) {
2266             sv_force_normal(sv);
2267         }
2268         if (SvREADONLY(sv) && !SvOK(sv)) {
2269             if (ckWARN(WARN_UNINITIALIZED))
2270                 report_uninit();
2271             return 0.0;
2272         }
2273     }
2274     if (SvTYPE(sv) < SVt_NV) {
2275         if (SvTYPE(sv) == SVt_IV)
2276             sv_upgrade(sv, SVt_PVNV);
2277         else
2278             sv_upgrade(sv, SVt_NV);
2279 #if defined(USE_LONG_DOUBLE)
2280         DEBUG_c({
2281             STORE_NUMERIC_LOCAL_SET_STANDARD();
2282             PerlIO_printf(Perl_debug_log,
2283                           "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2284                           PTR2UV(sv), SvNVX(sv));
2285             RESTORE_NUMERIC_LOCAL();
2286         });
2287 #else
2288         DEBUG_c({
2289             STORE_NUMERIC_LOCAL_SET_STANDARD();
2290             PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%g)\n",
2291                           PTR2UV(sv), SvNVX(sv));
2292             RESTORE_NUMERIC_LOCAL();
2293         });
2294 #endif
2295     }
2296     else if (SvTYPE(sv) < SVt_PVNV)
2297         sv_upgrade(sv, SVt_PVNV);
2298     if (SvIOKp(sv) &&
2299             (!SvPOKp(sv) || !strchr(SvPVX(sv),'.') || !looks_like_number(sv)))
2300     {
2301         SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
2302 #ifdef NV_PRESERVES_UV
2303         SvNOK_on(sv);
2304 #else
2305         /* Only set the public NV OK flag if this NV preserves the IV  */
2306         /* Check it's not 0xFFFFFFFFFFFFFFFF */
2307         if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2308                        : (SvIVX(sv) == I_V(SvNVX(sv))))
2309             SvNOK_on(sv);
2310         else
2311             SvNOKp_on(sv);
2312 #endif
2313     }
2314     else if (SvPOKp(sv) && SvLEN(sv)) {
2315         if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !looks_like_number(sv))
2316             not_a_number(sv);
2317         SvNVX(sv) = Atof(SvPVX(sv));
2318 #ifdef NV_PRESERVES_UV
2319         SvNOK_on(sv);
2320 #else
2321         /* Only set the public NV OK flag if this NV preserves the value in
2322            the PV at least as well as an IV/UV would.
2323            Not sure how to do this 100% reliably. */
2324         /* if that shift count is out of range then Configure's test is
2325            wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2326            UV_BITS */
2327         if (((UV)1 << NV_PRESERVES_UV_BITS) >
2328             U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv)))
2329             SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2330         else if (SvNVX(sv) < (NV)IV_MIN || SvNVX(sv) > (NV)UV_MAX) {
2331                 /* Definitely too large/small to fit in an integer, so no loss
2332                    of precision going to integer in the future via NV */
2333             SvNOK_on(sv);
2334         } else {
2335             /* Is it something we can run through strtol etc (ie no
2336                trailing exponent part)? */
2337             int numtype = looks_like_number(sv);
2338             /* XXX probably should cache this if called above */
2339
2340             if (!(numtype &
2341                   (IS_NUMBER_TO_INT_BY_ATOL | IS_NUMBER_TO_INT_BY_STRTOL))) {
2342                 /* Can't use strtol etc to convert this string, so don't try */
2343                 SvNOK_on(sv);
2344             } else
2345                 sv_2inuv_non_preserve (sv, numtype);
2346         }
2347 #endif /* NV_PRESERVES_UV */
2348     }
2349     else  {
2350         if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2351             report_uninit();
2352         if (SvTYPE(sv) < SVt_NV)
2353             /* Typically the caller expects that sv_any is not NULL now.  */
2354             /* XXX Ilya implies that this is a bug in callers that assume this
2355                and ideally should be fixed.  */
2356             sv_upgrade(sv, SVt_NV);
2357         return 0.0;
2358     }
2359 #if defined(USE_LONG_DOUBLE)
2360     DEBUG_c({
2361         STORE_NUMERIC_LOCAL_SET_STANDARD();
2362         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2363                       PTR2UV(sv), SvNVX(sv));
2364         RESTORE_NUMERIC_LOCAL();
2365     });
2366 #else
2367     DEBUG_c({
2368         STORE_NUMERIC_LOCAL_SET_STANDARD();
2369         PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%g)\n",
2370                       PTR2UV(sv), SvNVX(sv));
2371         RESTORE_NUMERIC_LOCAL();
2372     });
2373 #endif
2374     return SvNVX(sv);
2375 }
2376
2377 STATIC IV
2378 S_asIV(pTHX_ SV *sv)
2379 {
2380     I32 numtype = looks_like_number(sv);
2381     NV d;
2382
2383     if (numtype & IS_NUMBER_TO_INT_BY_ATOL)
2384         return Atol(SvPVX(sv));
2385     if (!numtype) {
2386         if (ckWARN(WARN_NUMERIC))
2387             not_a_number(sv);
2388     }
2389     d = Atof(SvPVX(sv));
2390     return I_V(d);
2391 }
2392
2393 STATIC UV
2394 S_asUV(pTHX_ SV *sv)
2395 {
2396     I32 numtype = looks_like_number(sv);
2397
2398 #ifdef HAS_STRTOUL
2399     if (numtype & IS_NUMBER_TO_INT_BY_ATOL)
2400         return Strtoul(SvPVX(sv), Null(char**), 10);
2401 #endif
2402     if (!numtype) {
2403         if (ckWARN(WARN_NUMERIC))
2404             not_a_number(sv);
2405     }
2406     return U_V(Atof(SvPVX(sv)));
2407 }
2408
2409 /*
2410  * Returns a combination of (advisory only - can get false negatives)
2411  * IS_NUMBER_TO_INT_BY_ATOL, IS_NUMBER_TO_INT_BY_ATOF
2412  * IS_NUMBER_LONGER_THAN_IV_MAX, IS_NUMBER_AS_LONG_AS_IV_MAX
2413  * IS_NUMBER_NOT_INT, IS_NUMBER_NEG, IS_NUMBER_INFINITY
2414  * 0 if does not look like number.
2415  *
2416  * (atol and strtol stop when they hit a decimal point. strtol will return
2417  * LONG_MAX and LONG_MIN when given out of range values. ANSI says they should
2418  * do this, and vendors have had 11 years to get it right.
2419  * However, will try to make it still work with only atol
2420  *
2421  * IS_NUMBER_TO_INT_BY_ATOL     123456789 or 123456789.3  definitely < IV_MAX
2422  * IS_NUMBER_TO_INT_BY_STRTOL   123456789 or 123456789.3  if digits = IV_MAX
2423  * IS_NUMBER_TO_INT_BY_ATOF     123456789e0               or >> IV_MAX
2424  * IS_NUMBER_LONGER_THAN_IV_MAX   lots of digits, don't bother with atol
2425  * IS_NUMBER_AS_LONG_AS_IV_MAX    atol might hit LONG_MAX, might not.
2426  * IS_NUMBER_NOT_INT            saw "." or "e"
2427  * IS_NUMBER_NEG
2428  * IS_NUMBER_INFINITY
2429  */
2430
2431 /*
2432 =for apidoc looks_like_number
2433
2434 Test if an the content of an SV looks like a number (or is a
2435 number). C<Inf> and C<Infinity> are treated as numbers (so will not
2436 issue a non-numeric warning), even if your atof() doesn't grok them.
2437
2438 =cut
2439 */
2440
2441 I32
2442 Perl_looks_like_number(pTHX_ SV *sv)
2443 {
2444     register char *s;
2445     register char *send;
2446     register char *sbegin;
2447     register char *nbegin;
2448     I32 numtype = 0;
2449     I32 sawinf  = 0;
2450     STRLEN len;
2451 #ifdef USE_LOCALE_NUMERIC
2452     bool specialradix = FALSE;
2453 #endif
2454
2455     if (SvPOK(sv)) {
2456         sbegin = SvPVX(sv);
2457         len = SvCUR(sv);
2458     }
2459     else if (SvPOKp(sv))
2460         sbegin = SvPV(sv, len);
2461     else
2462         return 1;
2463     send = sbegin + len;
2464
2465     s = sbegin;
2466     while (isSPACE(*s))
2467         s++;
2468     if (*s == '-') {
2469         s++;
2470         numtype = IS_NUMBER_NEG;
2471     }
2472     else if (*s == '+')
2473         s++;
2474
2475     nbegin = s;
2476     /*
2477      * we return IS_NUMBER_TO_INT_BY_ATOL if the number can converted to
2478      * integer with atol() without overflow, IS_NUMBER_TO_INT_BY_STRTOL if
2479      * possibly slightly larger than max int, IS_NUMBER_TO_INT_BY_ATOF if you
2480      * will need (int)atof().
2481      */
2482
2483     /* next must be digit or the radix separator or beginning of infinity */
2484     if (isDIGIT(*s)) {
2485         do {
2486             s++;
2487         } while (isDIGIT(*s));
2488
2489         /* Aaargh. long long really is irritating.
2490            In the gospel according to ANSI 1989, it is an axiom that "long"
2491            is the longest integer type, and that if you don't know how long
2492            something is you can cast it to long, and nothing will be lost
2493            (except possibly speed of execution if long is slower than the
2494            type is was).
2495            Now, one can't be sure if the old rules apply, or long long
2496            (or some other newfangled thing) is actually longer than the
2497            (formerly) longest thing.
2498         */
2499         /* This lot will work for 64 bit  *as long as* either
2500            either long is 64 bit
2501            or     we can find both strtol/strtoq and strtoul/strtouq
2502            If not, we really should refuse to let the user use 64 bit IVs
2503            By "64 bit" I really mean IVs that don't get preserved by NVs
2504            It also should work for 128 bit IVs. Can any lend me a machine to
2505            test this?
2506         */
2507         if (s - nbegin > TYPE_DIGITS(UV)) /* Cannot cache ato[ul]() */
2508             numtype |= IS_NUMBER_TO_INT_BY_ATOF | IS_NUMBER_LONGER_THAN_IV_MAX;
2509         else if (s - nbegin < BIT_DIGITS(((sizeof (IV)>sizeof (long))
2510                                           ? sizeof(long) : sizeof (IV))*8-1))
2511             numtype |= IS_NUMBER_TO_INT_BY_ATOL;
2512         else
2513             /* Can't be sure either way. (For 64 bit UV, 63 bit IV is 1 decimal
2514                digit less (IV_MAX=  9223372036854775807,
2515                            UV_MAX= 18446744073709551615) so be cautious  */
2516             numtype |= IS_NUMBER_TO_INT_BY_STRTOL | IS_NUMBER_AS_LONG_AS_IV_MAX;
2517
2518         if (*s == '.'
2519 #ifdef USE_LOCALE_NUMERIC
2520             || (specialradix = IS_NUMERIC_RADIX(s))
2521 #endif
2522             ) {
2523 #ifdef USE_LOCALE_NUMERIC
2524             if (specialradix)
2525                 s += SvCUR(PL_numeric_radix);
2526             else
2527 #endif
2528                 s++;
2529             numtype |= IS_NUMBER_NOT_INT;
2530             while (isDIGIT(*s))  /* optional digits after the radix */
2531                 s++;
2532         }
2533     }
2534     else if (*s == '.'
2535 #ifdef USE_LOCALE_NUMERIC
2536             || (specialradix = IS_NUMERIC_RADIX(s))
2537 #endif
2538             ) {
2539 #ifdef USE_LOCALE_NUMERIC
2540         if (specialradix)
2541             s += SvCUR(PL_numeric_radix);
2542         else
2543 #endif
2544             s++;
2545         numtype |= IS_NUMBER_TO_INT_BY_ATOL | IS_NUMBER_NOT_INT;
2546         /* no digits before the radix means we need digits after it */
2547         if (isDIGIT(*s)) {
2548             do {
2549                 s++;
2550             } while (isDIGIT(*s));
2551         }
2552         else
2553             return 0;
2554     }
2555     else if (*s == 'I' || *s == 'i') {
2556         s++; if (*s != 'N' && *s != 'n') return 0;
2557         s++; if (*s != 'F' && *s != 'f') return 0;
2558         s++; if (*s == 'I' || *s == 'i') {
2559             s++; if (*s != 'N' && *s != 'n') return 0;
2560             s++; if (*s != 'I' && *s != 'i') return 0;
2561             s++; if (*s != 'T' && *s != 't') return 0;
2562             s++; if (*s != 'Y' && *s != 'y') return 0;
2563             s++;
2564         }
2565         sawinf = 1;
2566     }
2567     else
2568         return 0;
2569
2570     if (sawinf)
2571         numtype = (numtype & IS_NUMBER_NEG) /* Keep track of sign  */
2572           | IS_NUMBER_INFINITY | IS_NUMBER_NOT_INT;
2573     else {
2574         /* we can have an optional exponent part */
2575         if (*s == 'e' || *s == 'E') {
2576             numtype &= IS_NUMBER_NEG;
2577             numtype |= IS_NUMBER_TO_INT_BY_ATOF | IS_NUMBER_NOT_INT;
2578             s++;
2579             if (*s == '+' || *s == '-')
2580                 s++;
2581             if (isDIGIT(*s)) {
2582                 do {
2583                     s++;
2584                 } while (isDIGIT(*s));
2585             }
2586             else
2587                 return 0;
2588         }
2589     }
2590     while (isSPACE(*s))
2591         s++;
2592     if (s >= send)
2593         return numtype;
2594     if (len == 10 && memEQ(sbegin, "0 but true", 10))
2595         return IS_NUMBER_TO_INT_BY_ATOL;
2596     return 0;
2597 }
2598
2599 char *
2600 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2601 {
2602     STRLEN n_a;
2603     return sv_2pv(sv, &n_a);
2604 }
2605
2606 /* We assume that buf is at least TYPE_CHARS(UV) long. */
2607 static char *
2608 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2609 {
2610     char *ptr = buf + TYPE_CHARS(UV);
2611     char *ebuf = ptr;
2612     int sign;
2613
2614     if (is_uv)
2615         sign = 0;
2616     else if (iv >= 0) {
2617         uv = iv;
2618         sign = 0;
2619     } else {
2620         uv = -iv;
2621         sign = 1;
2622     }
2623     do {
2624         *--ptr = '0' + (uv % 10);
2625     } while (uv /= 10);
2626     if (sign)
2627         *--ptr = '-';
2628     *peob = ebuf;
2629     return ptr;
2630 }
2631
2632 char *
2633 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
2634 {
2635     register char *s;
2636     int olderrno;
2637     SV *tsv;
2638     char tbuf[64];      /* Must fit sprintf/Gconvert of longest IV/NV */
2639     char *tmpbuf = tbuf;
2640
2641     if (!sv) {
2642         *lp = 0;
2643         return "";
2644     }
2645     if (SvGMAGICAL(sv)) {
2646         mg_get(sv);
2647         if (SvPOKp(sv)) {
2648             *lp = SvCUR(sv);
2649             return SvPVX(sv);
2650         }
2651         if (SvIOKp(sv)) {
2652             if (SvIsUV(sv))
2653                 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2654             else
2655                 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2656             tsv = Nullsv;
2657             goto tokensave;
2658         }
2659         if (SvNOKp(sv)) {
2660             Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2661             tsv = Nullsv;
2662             goto tokensave;
2663         }
2664         if (!SvROK(sv)) {
2665             if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2666                 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2667                     report_uninit();
2668             }
2669             *lp = 0;
2670             return "";
2671         }
2672     }
2673     if (SvTHINKFIRST(sv)) {
2674         if (SvROK(sv)) {
2675             SV* tmpstr;
2676             if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2677                     (SvRV(tmpstr) != SvRV(sv)))
2678                 return SvPV(tmpstr,*lp);
2679             sv = (SV*)SvRV(sv);
2680             if (!sv)
2681                 s = "NULLREF";
2682             else {
2683                 MAGIC *mg;
2684
2685                 switch (SvTYPE(sv)) {
2686                 case SVt_PVMG:
2687                     if ( ((SvFLAGS(sv) &
2688                            (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2689                           == (SVs_OBJECT|SVs_RMG))
2690                          && strEQ(s=HvNAME(SvSTASH(sv)), "Regexp")
2691                          && (mg = mg_find(sv, 'r'))) {
2692                         regexp *re = (regexp *)mg->mg_obj;
2693
2694                         if (!mg->mg_ptr) {
2695                             char *fptr = "msix";
2696                             char reflags[6];
2697                             char ch;
2698                             int left = 0;
2699                             int right = 4;
2700                             U16 reganch = (re->reganch & PMf_COMPILETIME) >> 12;
2701
2702                             while((ch = *fptr++)) {
2703                                 if(reganch & 1) {
2704                                     reflags[left++] = ch;
2705                                 }
2706                                 else {
2707                                     reflags[right--] = ch;
2708                                 }
2709                                 reganch >>= 1;
2710                             }
2711                             if(left != 4) {
2712                                 reflags[left] = '-';
2713                                 left = 5;
2714                             }
2715
2716                             mg->mg_len = re->prelen + 4 + left;
2717                             New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
2718                             Copy("(?", mg->mg_ptr, 2, char);
2719                             Copy(reflags, mg->mg_ptr+2, left, char);
2720                             Copy(":", mg->mg_ptr+left+2, 1, char);
2721                             Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2722                             mg->mg_ptr[mg->mg_len - 1] = ')';
2723                             mg->mg_ptr[mg->mg_len] = 0;
2724                         }
2725                         PL_reginterp_cnt += re->program[0].next_off;
2726                         *lp = mg->mg_len;
2727                         return mg->mg_ptr;
2728                     }
2729                                         /* Fall through */
2730                 case SVt_NULL:
2731                 case SVt_IV:
2732                 case SVt_NV:
2733                 case SVt_RV:
2734                 case SVt_PV:
2735                 case SVt_PVIV:
2736                 case SVt_PVNV:
2737                 case SVt_PVBM:  if (SvROK(sv))
2738                                     s = "REF";
2739                                 else
2740                                     s = "SCALAR";               break;
2741                 case SVt_PVLV:  s = "LVALUE";                   break;
2742                 case SVt_PVAV:  s = "ARRAY";                    break;
2743                 case SVt_PVHV:  s = "HASH";                     break;
2744                 case SVt_PVCV:  s = "CODE";                     break;
2745                 case SVt_PVGV:  s = "GLOB";                     break;
2746                 case SVt_PVFM:  s = "FORMAT";                   break;
2747                 case SVt_PVIO:  s = "IO";                       break;
2748                 default:        s = "UNKNOWN";                  break;
2749                 }
2750                 tsv = NEWSV(0,0);
2751                 if (SvOBJECT(sv))
2752                     Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
2753                 else
2754                     sv_setpv(tsv, s);
2755                 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
2756                 goto tokensaveref;
2757             }
2758             *lp = strlen(s);
2759             return s;
2760         }
2761         if (SvREADONLY(sv) && !SvOK(sv)) {
2762             if (ckWARN(WARN_UNINITIALIZED))
2763                 report_uninit();
2764             *lp = 0;
2765             return "";
2766         }
2767     }
2768     if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2769         /* I'm assuming that if both IV and NV are equally valid then
2770            converting the IV is going to be more efficient */
2771         U32 isIOK = SvIOK(sv);
2772         U32 isUIOK = SvIsUV(sv);
2773         char buf[TYPE_CHARS(UV)];
2774         char *ebuf, *ptr;
2775
2776         if (SvTYPE(sv) < SVt_PVIV)
2777             sv_upgrade(sv, SVt_PVIV);
2778         if (isUIOK)
2779             ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2780         else
2781             ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2782         SvGROW(sv, ebuf - ptr + 1);     /* inlined from sv_setpvn */
2783         Move(ptr,SvPVX(sv),ebuf - ptr,char);
2784         SvCUR_set(sv, ebuf - ptr);
2785         s = SvEND(sv);
2786         *s = '\0';
2787         if (isIOK)
2788             SvIOK_on(sv);
2789         else
2790             SvIOKp_on(sv);
2791         if (isUIOK)
2792             SvIsUV_on(sv);
2793     }
2794     else if (SvNOKp(sv)) {
2795         if (SvTYPE(sv) < SVt_PVNV)
2796             sv_upgrade(sv, SVt_PVNV);
2797         /* The +20 is pure guesswork.  Configure test needed. --jhi */
2798         SvGROW(sv, NV_DIG + 20);
2799         s = SvPVX(sv);
2800         olderrno = errno;       /* some Xenix systems wipe out errno here */
2801 #ifdef apollo
2802         if (SvNVX(sv) == 0.0)
2803             (void)strcpy(s,"0");
2804         else
2805 #endif /*apollo*/
2806         {
2807             Gconvert(SvNVX(sv), NV_DIG, 0, s);
2808         }
2809         errno = olderrno;
2810 #ifdef FIXNEGATIVEZERO
2811         if (*s == '-' && s[1] == '0' && !s[2])
2812             strcpy(s,"0");
2813 #endif
2814         while (*s) s++;
2815 #ifdef hcx
2816         if (s[-1] == '.')
2817             *--s = '\0';
2818 #endif
2819     }
2820     else {
2821         if (ckWARN(WARN_UNINITIALIZED)
2822             && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2823             report_uninit();
2824         *lp = 0;
2825         if (SvTYPE(sv) < SVt_PV)
2826             /* Typically the caller expects that sv_any is not NULL now.  */
2827             sv_upgrade(sv, SVt_PV);
2828         return "";
2829     }
2830     *lp = s - SvPVX(sv);
2831     SvCUR_set(sv, *lp);
2832     SvPOK_on(sv);
2833     DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2834                           PTR2UV(sv),SvPVX(sv)));
2835     return SvPVX(sv);
2836
2837   tokensave:
2838     if (SvROK(sv)) {    /* XXX Skip this when sv_pvn_force calls */
2839         /* Sneaky stuff here */
2840
2841       tokensaveref:
2842         if (!tsv)
2843             tsv = newSVpv(tmpbuf, 0);
2844         sv_2mortal(tsv);
2845         *lp = SvCUR(tsv);
2846         return SvPVX(tsv);
2847     }
2848     else {
2849         STRLEN len;
2850         char *t;
2851
2852         if (tsv) {
2853             sv_2mortal(tsv);
2854             t = SvPVX(tsv);
2855             len = SvCUR(tsv);
2856         }
2857         else {
2858             t = tmpbuf;
2859             len = strlen(tmpbuf);
2860         }
2861 #ifdef FIXNEGATIVEZERO
2862         if (len == 2 && t[0] == '-' && t[1] == '0') {
2863             t = "0";
2864             len = 1;
2865         }
2866 #endif
2867         (void)SvUPGRADE(sv, SVt_PV);
2868         *lp = len;
2869         s = SvGROW(sv, len + 1);
2870         SvCUR_set(sv, len);
2871         (void)strcpy(s, t);
2872         SvPOKp_on(sv);
2873         return s;
2874     }
2875 }
2876
2877 char *
2878 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
2879 {
2880     STRLEN n_a;
2881     return sv_2pvbyte(sv, &n_a);
2882 }
2883
2884 char *
2885 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2886 {
2887     return sv_2pv(sv,lp);
2888 }
2889
2890 char *
2891 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
2892 {
2893     STRLEN n_a;
2894     return sv_2pvutf8(sv, &n_a);
2895 }
2896
2897 char *
2898 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2899 {
2900     sv_utf8_upgrade(sv);
2901     return SvPV(sv,*lp);
2902 }
2903
2904 /* This function is only called on magical items */
2905 bool
2906 Perl_sv_2bool(pTHX_ register SV *sv)
2907 {
2908     if (SvGMAGICAL(sv))
2909         mg_get(sv);
2910
2911     if (!SvOK(sv))
2912         return 0;
2913     if (SvROK(sv)) {
2914         SV* tmpsv;
2915         if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2916                 (SvRV(tmpsv) != SvRV(sv)))
2917             return SvTRUE(tmpsv);
2918       return SvRV(sv) != 0;
2919     }
2920     if (SvPOKp(sv)) {
2921         register XPV* Xpvtmp;
2922         if ((Xpvtmp = (XPV*)SvANY(sv)) &&
2923                 (*Xpvtmp->xpv_pv > '0' ||
2924                 Xpvtmp->xpv_cur > 1 ||
2925                 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
2926             return 1;
2927         else
2928             return 0;
2929     }
2930     else {
2931         if (SvIOKp(sv))
2932             return SvIVX(sv) != 0;
2933         else {
2934             if (SvNOKp(sv))
2935                 return SvNVX(sv) != 0.0;
2936             else
2937                 return FALSE;
2938         }
2939     }
2940 }
2941
2942 /*
2943 =for apidoc sv_utf8_upgrade
2944
2945 Convert the PV of an SV to its UTF8-encoded form.
2946
2947 =cut
2948 */
2949
2950 void
2951 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
2952 {
2953     char *s, *t, *e;
2954     int  hibit = 0;
2955
2956     if (!sv || !SvPOK(sv) || SvUTF8(sv))
2957         return;
2958
2959     /* This function could be much more efficient if we had a FLAG in SVs
2960      * to signal if there are any hibit chars in the PV.
2961      * Given that there isn't make loop fast as possible
2962      */
2963     s = SvPVX(sv);
2964     e = SvEND(sv);
2965     t = s;
2966     while (t < e) {
2967         if ((hibit = UTF8_IS_CONTINUED(*t++)))
2968             break;
2969     }
2970
2971     if (hibit) {
2972         STRLEN len;
2973
2974         if (SvREADONLY(sv) && SvFAKE(sv)) {
2975             sv_force_normal(sv);
2976             s = SvPVX(sv);
2977         }
2978         len = SvCUR(sv) + 1; /* Plus the \0 */
2979         SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
2980         SvCUR(sv) = len - 1;
2981         if (SvLEN(sv) != 0)
2982             Safefree(s); /* No longer using what was there before. */
2983         SvLEN(sv) = len; /* No longer know the real size. */
2984         SvUTF8_on(sv);
2985     }
2986 }
2987
2988 /*
2989 =for apidoc sv_utf8_downgrade
2990
2991 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
2992 This may not be possible if the PV contains non-byte encoding characters;
2993 if this is the case, either returns false or, if C<fail_ok> is not
2994 true, croaks.
2995
2996 =cut
2997 */
2998
2999 bool
3000 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3001 {
3002     if (SvPOK(sv) && SvUTF8(sv)) {
3003         if (SvCUR(sv)) {
3004             char *s;
3005             STRLEN len;
3006
3007             if (SvREADONLY(sv) && SvFAKE(sv))
3008                 sv_force_normal(sv);
3009             s = SvPV(sv, len);
3010             if (!utf8_to_bytes((U8*)s, &len)) {
3011                 if (fail_ok)
3012                     return FALSE;
3013                 else {
3014                     if (PL_op)
3015                         Perl_croak(aTHX_ "Wide character in %s",
3016                                    PL_op_desc[PL_op->op_type]);
3017                     else
3018                         Perl_croak(aTHX_ "Wide character");
3019                 }
3020             }
3021             SvCUR(sv) = len;
3022         }
3023         SvUTF8_off(sv);
3024     }
3025
3026     return TRUE;
3027 }
3028
3029 /*
3030 =for apidoc sv_utf8_encode
3031
3032 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3033 flag so that it looks like bytes again. Nothing calls this.
3034
3035 =cut
3036 */
3037
3038 void
3039 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3040 {
3041     sv_utf8_upgrade(sv);
3042     SvUTF8_off(sv);
3043 }
3044
3045 bool
3046 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3047 {
3048     if (SvPOK(sv)) {
3049         char *c;
3050         char *e;
3051         bool has_utf = FALSE;
3052         if (!sv_utf8_downgrade(sv, TRUE))
3053             return FALSE;
3054
3055         /* it is actually just a matter of turning the utf8 flag on, but
3056          * we want to make sure everything inside is valid utf8 first.
3057          */
3058         c = SvPVX(sv);
3059         if (!is_utf8_string((U8*)c, SvCUR(sv)+1))
3060             return FALSE;
3061         e = SvEND(sv);
3062         while (c < e) {
3063             if (UTF8_IS_CONTINUED(*c++)) {
3064                 SvUTF8_on(sv);
3065                 break;
3066             }
3067         }
3068     }
3069     return TRUE;
3070 }
3071
3072
3073 /* Note: sv_setsv() should not be called with a source string that needs
3074  * to be reused, since it may destroy the source string if it is marked
3075  * as temporary.
3076  */
3077
3078 /*
3079 =for apidoc sv_setsv
3080
3081 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
3082 The source SV may be destroyed if it is mortal.  Does not handle 'set'
3083 magic.  See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and
3084 C<sv_setsv_mg>.
3085
3086 =cut
3087 */
3088
3089 void
3090 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
3091 {
3092     register U32 sflags;
3093     register int dtype;
3094     register int stype;
3095
3096     if (sstr == dstr)
3097         return;
3098     SV_CHECK_THINKFIRST(dstr);
3099     if (!sstr)
3100         sstr = &PL_sv_undef;
3101     stype = SvTYPE(sstr);
3102     dtype = SvTYPE(dstr);
3103
3104     SvAMAGIC_off(dstr);
3105
3106     /* There's a lot of redundancy below but we're going for speed here */
3107
3108     switch (stype) {
3109     case SVt_NULL:
3110       undef_sstr:
3111         if (dtype != SVt_PVGV) {
3112             (void)SvOK_off(dstr);
3113             return;
3114         }
3115         break;
3116     case SVt_IV:
3117         if (SvIOK(sstr)) {
3118             switch (dtype) {
3119             case SVt_NULL:
3120                 sv_upgrade(dstr, SVt_IV);
3121                 break;
3122             case SVt_NV:
3123                 sv_upgrade(dstr, SVt_PVNV);
3124                 break;
3125             case SVt_RV:
3126             case SVt_PV:
3127                 sv_upgrade(dstr, SVt_PVIV);
3128                 break;
3129             }
3130             (void)SvIOK_only(dstr);
3131             SvIVX(dstr) = SvIVX(sstr);
3132             if (SvIsUV(sstr))
3133                 SvIsUV_on(dstr);
3134             if (SvTAINTED(sstr))
3135                 SvTAINT(dstr);
3136             return;
3137         }
3138         goto undef_sstr;
3139
3140     case SVt_NV:
3141         if (SvNOK(sstr)) {
3142             switch (dtype) {
3143             case SVt_NULL:
3144             case SVt_IV:
3145                 sv_upgrade(dstr, SVt_NV);
3146                 break;
3147             case SVt_RV:
3148             case SVt_PV:
3149             case SVt_PVIV:
3150                 sv_upgrade(dstr, SVt_PVNV);
3151                 break;
3152             }
3153             SvNVX(dstr) = SvNVX(sstr);
3154             (void)SvNOK_only(dstr);
3155             if (SvTAINTED(sstr))
3156                 SvTAINT(dstr);
3157             return;
3158         }
3159         goto undef_sstr;
3160
3161     case SVt_RV:
3162         if (dtype < SVt_RV)
3163             sv_upgrade(dstr, SVt_RV);
3164         else if (dtype == SVt_PVGV &&
3165                  SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3166             sstr = SvRV(sstr);
3167             if (sstr == dstr) {
3168                 if (GvIMPORTED(dstr) != GVf_IMPORTED
3169                     && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3170                 {
3171                     GvIMPORTED_on(dstr);
3172                 }
3173                 GvMULTI_on(dstr);
3174                 return;
3175             }
3176             goto glob_assign;
3177         }
3178         break;
3179     case SVt_PV:
3180     case SVt_PVFM:
3181         if (dtype < SVt_PV)
3182             sv_upgrade(dstr, SVt_PV);
3183         break;
3184     case SVt_PVIV:
3185         if (dtype < SVt_PVIV)
3186             sv_upgrade(dstr, SVt_PVIV);
3187         break;
3188     case SVt_PVNV:
3189         if (dtype < SVt_PVNV)
3190             sv_upgrade(dstr, SVt_PVNV);
3191         break;
3192     case SVt_PVAV:
3193     case SVt_PVHV:
3194     case SVt_PVCV:
3195     case SVt_PVIO:
3196         if (PL_op)
3197             Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
3198                 PL_op_name[PL_op->op_type]);
3199         else
3200             Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
3201         break;
3202
3203     case SVt_PVGV:
3204         if (dtype <= SVt_PVGV) {
3205   glob_assign:
3206             if (dtype != SVt_PVGV) {
3207                 char *name = GvNAME(sstr);
3208                 STRLEN len = GvNAMELEN(sstr);
3209                 sv_upgrade(dstr, SVt_PVGV);
3210                 sv_magic(dstr, dstr, '*', Nullch, 0);
3211                 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
3212                 GvNAME(dstr) = savepvn(name, len);
3213                 GvNAMELEN(dstr) = len;
3214                 SvFAKE_on(dstr);        /* can coerce to non-glob */
3215             }
3216             /* ahem, death to those who redefine active sort subs */
3217             else if (PL_curstackinfo->si_type == PERLSI_SORT
3218                      && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3219                 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3220                       GvNAME(dstr));
3221
3222 #ifdef GV_SHARED_CHECK
3223                 if (GvSHARED((GV*)dstr)) {
3224                     Perl_croak(aTHX_ PL_no_modify);
3225                 }
3226 #endif
3227
3228             (void)SvOK_off(dstr);
3229             GvINTRO_off(dstr);          /* one-shot flag */
3230             gp_free((GV*)dstr);
3231             GvGP(dstr) = gp_ref(GvGP(sstr));
3232             if (SvTAINTED(sstr))
3233                 SvTAINT(dstr);
3234             if (GvIMPORTED(dstr) != GVf_IMPORTED
3235                 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3236             {
3237                 GvIMPORTED_on(dstr);
3238             }
3239             GvMULTI_on(dstr);
3240             return;
3241         }
3242         /* FALL THROUGH */
3243
3244     default:
3245         if (SvGMAGICAL(sstr)) {
3246             mg_get(sstr);
3247             if (SvTYPE(sstr) != stype) {
3248                 stype = SvTYPE(sstr);
3249                 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3250                     goto glob_assign;
3251             }
3252         }
3253         if (stype == SVt_PVLV)
3254             (void)SvUPGRADE(dstr, SVt_PVNV);
3255         else
3256             (void)SvUPGRADE(dstr, stype);
3257     }
3258
3259     sflags = SvFLAGS(sstr);
3260
3261     if (sflags & SVf_ROK) {
3262         if (dtype >= SVt_PV) {
3263             if (dtype == SVt_PVGV) {
3264                 SV *sref = SvREFCNT_inc(SvRV(sstr));
3265                 SV *dref = 0;
3266                 int intro = GvINTRO(dstr);
3267
3268 #ifdef GV_SHARED_CHECK
3269                 if (GvSHARED((GV*)dstr)) {
3270                     Perl_croak(aTHX_ PL_no_modify);
3271                 }
3272 #endif
3273
3274                 if (intro) {
3275                     GP *gp;
3276                     gp_free((GV*)dstr);
3277                     GvINTRO_off(dstr);  /* one-shot flag */
3278                     Newz(602,gp, 1, GP);
3279                     GvGP(dstr) = gp_ref(gp);
3280                     GvSV(dstr) = NEWSV(72,0);
3281                     GvLINE(dstr) = CopLINE(PL_curcop);
3282                     GvEGV(dstr) = (GV*)dstr;
3283                 }
3284                 GvMULTI_on(dstr);
3285                 switch (SvTYPE(sref)) {
3286                 case SVt_PVAV:
3287                     if (intro)
3288                         SAVESPTR(GvAV(dstr));
3289                     else
3290                         dref = (SV*)GvAV(dstr);
3291                     GvAV(dstr) = (AV*)sref;
3292                     if (!GvIMPORTED_AV(dstr)
3293                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3294                     {
3295                         GvIMPORTED_AV_on(dstr);
3296                     }
3297                     break;
3298                 case SVt_PVHV:
3299                     if (intro)
3300                         SAVESPTR(GvHV(dstr));
3301                     else
3302                         dref = (SV*)GvHV(dstr);
3303                     GvHV(dstr) = (HV*)sref;
3304                     if (!GvIMPORTED_HV(dstr)
3305                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3306                     {
3307                         GvIMPORTED_HV_on(dstr);
3308                     }
3309                     break;
3310                 case SVt_PVCV:
3311                     if (intro) {
3312                         if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3313                             SvREFCNT_dec(GvCV(dstr));
3314                             GvCV(dstr) = Nullcv;
3315                             GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3316                             PL_sub_generation++;
3317                         }
3318                         SAVESPTR(GvCV(dstr));
3319                     }
3320                     else
3321                         dref = (SV*)GvCV(dstr);
3322                     if (GvCV(dstr) != (CV*)sref) {
3323                         CV* cv = GvCV(dstr);
3324                         if (cv) {
3325                             if (!GvCVGEN((GV*)dstr) &&
3326                                 (CvROOT(cv) || CvXSUB(cv)))
3327                             {
3328                                 SV *const_sv;
3329                                 /* ahem, death to those who redefine
3330                                  * active sort subs */
3331                                 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3332                                       PL_sortcop == CvSTART(cv))
3333                                     Perl_croak(aTHX_
3334                                     "Can't redefine active sort subroutine %s",
3335                                           GvENAME((GV*)dstr));
3336                                 /* Redefining a sub - warning is mandatory if
3337                                    it was a const and its value changed. */
3338                                 if (ckWARN(WARN_REDEFINE)
3339                                     || (CvCONST(cv)
3340                                         && (!CvCONST((CV*)sref)
3341                                             || sv_cmp(cv_const_sv(cv),
3342                                                       cv_const_sv((CV*)sref)))))
3343                                 {
3344                                     Perl_warner(aTHX_ WARN_REDEFINE,
3345                                         CvCONST(cv)
3346                                         ? "Constant subroutine %s redefined"
3347                                         : "Subroutine %s redefined",
3348                                         GvENAME((GV*)dstr));
3349                                 }
3350                             }
3351                             cv_ckproto(cv, (GV*)dstr,
3352                                        SvPOK(sref) ? SvPVX(sref) : Nullch);
3353                         }
3354                         GvCV(dstr) = (CV*)sref;
3355                         GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3356                         GvASSUMECV_on(dstr);
3357                         PL_sub_generation++;
3358                     }
3359                     if (!GvIMPORTED_CV(dstr)
3360                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3361                     {
3362                         GvIMPORTED_CV_on(dstr);
3363                     }
3364                     break;
3365                 case SVt_PVIO:
3366                     if (intro)
3367                         SAVESPTR(GvIOp(dstr));
3368                     else
3369                         dref = (SV*)GvIOp(dstr);
3370                     GvIOp(dstr) = (IO*)sref;
3371                     break;
3372                 case SVt_PVFM:
3373                     if (intro)
3374                         SAVESPTR(GvFORM(dstr));
3375                     else
3376                         dref = (SV*)GvFORM(dstr);
3377                     GvFORM(dstr) = (CV*)sref;
3378                     break;
3379                 default:
3380                     if (intro)
3381                         SAVESPTR(GvSV(dstr));
3382                     else
3383                         dref = (SV*)GvSV(dstr);
3384                     GvSV(dstr) = sref;
3385                     if (!GvIMPORTED_SV(dstr)
3386                         && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3387                     {
3388                         GvIMPORTED_SV_on(dstr);
3389                     }
3390                     break;
3391                 }
3392                 if (dref)
3393                     SvREFCNT_dec(dref);
3394                 if (intro)
3395                     SAVEFREESV(sref);
3396                 if (SvTAINTED(sstr))
3397                     SvTAINT(dstr);
3398                 return;
3399             }
3400             if (SvPVX(dstr)) {
3401                 (void)SvOOK_off(dstr);          /* backoff */
3402                 if (SvLEN(dstr))
3403                     Safefree(SvPVX(dstr));
3404                 SvLEN(dstr)=SvCUR(dstr)=0;
3405             }
3406         }
3407         (void)SvOK_off(dstr);
3408         SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
3409         SvROK_on(dstr);
3410         if (sflags & SVp_NOK) {
3411             SvNOKp_on(dstr);
3412             /* Only set the public OK flag if the source has public OK.  */
3413             if (sflags & SVf_NOK)
3414                 SvFLAGS(dstr) |= SVf_NOK;
3415             SvNVX(dstr) = SvNVX(sstr);
3416         }
3417         if (sflags & SVp_IOK) {
3418             (void)SvIOKp_on(dstr);
3419             if (sflags & SVf_IOK)
3420                 SvFLAGS(dstr) |= SVf_IOK;
3421             if (sflags & SVf_IVisUV)
3422                 SvIsUV_on(dstr);
3423             SvIVX(dstr) = SvIVX(sstr);
3424         }
3425         if (SvAMAGIC(sstr)) {
3426             SvAMAGIC_on(dstr);
3427         }
3428     }
3429     else if (sflags & SVp_POK) {
3430
3431         /*
3432          * Check to see if we can just swipe the string.  If so, it's a
3433          * possible small lose on short strings, but a big win on long ones.
3434          * It might even be a win on short strings if SvPVX(dstr)
3435          * has to be allocated and SvPVX(sstr) has to be freed.
3436          */
3437
3438         if (SvTEMP(sstr) &&             /* slated for free anyway? */
3439             SvREFCNT(sstr) == 1 &&      /* and no other references to it? */
3440             !(sflags & SVf_OOK) &&      /* and not involved in OOK hack? */
3441             SvLEN(sstr)         &&      /* and really is a string */
3442             !(PL_op && PL_op->op_type == OP_AASSIGN)) /* and won't be needed again, potentially */
3443         {
3444             if (SvPVX(dstr)) {          /* we know that dtype >= SVt_PV */
3445                 if (SvOOK(dstr)) {
3446                     SvFLAGS(dstr) &= ~SVf_OOK;
3447                     Safefree(SvPVX(dstr) - SvIVX(dstr));
3448                 }
3449                 else if (SvLEN(dstr))
3450                     Safefree(SvPVX(dstr));
3451             }
3452             (void)SvPOK_only(dstr);
3453             SvPV_set(dstr, SvPVX(sstr));
3454             SvLEN_set(dstr, SvLEN(sstr));
3455             SvCUR_set(dstr, SvCUR(sstr));
3456
3457             SvTEMP_off(dstr);
3458             (void)SvOK_off(sstr);               /* NOTE: nukes most SvFLAGS on sstr */
3459             SvPV_set(sstr, Nullch);
3460             SvLEN_set(sstr, 0);
3461             SvCUR_set(sstr, 0);
3462             SvTEMP_off(sstr);
3463         }
3464         else {                                  /* have to copy actual string */
3465             STRLEN len = SvCUR(sstr);
3466
3467             SvGROW(dstr, len + 1);              /* inlined from sv_setpvn */
3468             Move(SvPVX(sstr),SvPVX(dstr),len,char);
3469             SvCUR_set(dstr, len);
3470             *SvEND(dstr) = '\0';
3471             (void)SvPOK_only(dstr);
3472         }
3473         if (sflags & SVf_UTF8)
3474             SvUTF8_on(dstr);
3475         /*SUPPRESS 560*/
3476         if (sflags & SVp_NOK) {
3477             SvNOKp_on(dstr);
3478             if (sflags & SVf_NOK)
3479                 SvFLAGS(dstr) |= SVf_NOK;
3480             SvNVX(dstr) = SvNVX(sstr);
3481         }
3482         if (sflags & SVp_IOK) {
3483             (void)SvIOKp_on(dstr);
3484             if (sflags & SVf_IOK)
3485                 SvFLAGS(dstr) |= SVf_IOK;
3486             if (sflags & SVf_IVisUV)
3487                 SvIsUV_on(dstr);
3488             SvIVX(dstr) = SvIVX(sstr);
3489         }
3490     }
3491     else if (sflags & SVp_IOK) {
3492         if (sflags & SVf_IOK)
3493             (void)SvIOK_only(dstr);
3494         else {
3495             SvOK_off(dstr);
3496             SvIOKp_on(dstr);
3497         }
3498         /* XXXX Do we want to set IsUV for IV(ROK)?  Be extra safe... */
3499         if (sflags & SVf_IVisUV)
3500             SvIsUV_on(dstr);
3501         SvIVX(dstr) = SvIVX(sstr);
3502         if (sflags & SVp_NOK) {
3503             if (sflags & SVf_NOK)
3504                 (void)SvNOK_on(dstr);
3505             else
3506                 (void)SvNOKp_on(dstr);
3507             SvNVX(dstr) = SvNVX(sstr);
3508         }
3509     }
3510     else if (sflags & SVp_NOK) {
3511         if (sflags & SVf_NOK)
3512             (void)SvNOK_only(dstr);
3513         else {
3514             SvOK_off(dstr);
3515             SvNOKp_on(dstr);
3516         }
3517         SvNVX(dstr) = SvNVX(sstr);
3518     }
3519     else {
3520         if (dtype == SVt_PVGV) {
3521             if (ckWARN(WARN_MISC))
3522                 Perl_warner(aTHX_ WARN_MISC, "Undefined value assigned to typeglob");
3523         }
3524         else
3525             (void)SvOK_off(dstr);
3526     }
3527     if (SvTAINTED(sstr))
3528         SvTAINT(dstr);
3529 }
3530
3531 /*
3532 =for apidoc sv_setsv_mg
3533
3534 Like C<sv_setsv>, but also handles 'set' magic.
3535
3536 =cut
3537 */
3538
3539 void
3540 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3541 {
3542     sv_setsv(dstr,sstr);
3543     SvSETMAGIC(dstr);
3544 }
3545
3546 /*
3547 =for apidoc sv_setpvn
3548
3549 Copies a string into an SV.  The C<len> parameter indicates the number of
3550 bytes to be copied.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
3551
3552 =cut
3553 */
3554
3555 void
3556 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3557 {
3558     register char *dptr;
3559
3560     SV_CHECK_THINKFIRST(sv);
3561     if (!ptr) {
3562         (void)SvOK_off(sv);
3563         return;
3564     }
3565     else {
3566         /* len is STRLEN which is unsigned, need to copy to signed */
3567         IV iv = len;
3568         assert(iv >= 0);
3569     }
3570     (void)SvUPGRADE(sv, SVt_PV);
3571
3572     SvGROW(sv, len + 1);
3573     dptr = SvPVX(sv);
3574     Move(ptr,dptr,len,char);
3575     dptr[len] = '\0';
3576     SvCUR_set(sv, len);
3577     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3578     SvTAINT(sv);
3579 }
3580
3581 /*
3582 =for apidoc sv_setpvn_mg
3583
3584 Like C<sv_setpvn>, but also handles 'set' magic.
3585
3586 =cut
3587 */
3588
3589 void
3590 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3591 {
3592     sv_setpvn(sv,ptr,len);
3593     SvSETMAGIC(sv);
3594 }
3595
3596 /*
3597 =for apidoc sv_setpv
3598
3599 Copies a string into an SV.  The string must be null-terminated.  Does not
3600 handle 'set' magic.  See C<sv_setpv_mg>.
3601
3602 =cut
3603 */
3604
3605 void
3606 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3607 {
3608     register STRLEN len;
3609
3610     SV_CHECK_THINKFIRST(sv);
3611     if (!ptr) {
3612         (void)SvOK_off(sv);
3613         return;
3614     }
3615     len = strlen(ptr);
3616     (void)SvUPGRADE(sv, SVt_PV);
3617
3618     SvGROW(sv, len + 1);
3619     Move(ptr,SvPVX(sv),len+1,char);
3620     SvCUR_set(sv, len);
3621     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3622     SvTAINT(sv);
3623 }
3624
3625 /*
3626 =for apidoc sv_setpv_mg
3627
3628 Like C<sv_setpv>, but also handles 'set' magic.
3629
3630 =cut
3631 */
3632
3633 void
3634 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3635 {
3636     sv_setpv(sv,ptr);
3637     SvSETMAGIC(sv);
3638 }
3639
3640 /*
3641 =for apidoc sv_usepvn
3642
3643 Tells an SV to use C<ptr> to find its string value.  Normally the string is
3644 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3645 The C<ptr> should point to memory that was allocated by C<malloc>.  The
3646 string length, C<len>, must be supplied.  This function will realloc the
3647 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3648 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
3649 See C<sv_usepvn_mg>.
3650
3651 =cut
3652 */
3653
3654 void
3655 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3656 {
3657     SV_CHECK_THINKFIRST(sv);
3658     (void)SvUPGRADE(sv, SVt_PV);
3659     if (!ptr) {
3660         (void)SvOK_off(sv);
3661         return;
3662     }
3663     (void)SvOOK_off(sv);
3664     if (SvPVX(sv) && SvLEN(sv))
3665         Safefree(SvPVX(sv));
3666     Renew(ptr, len+1, char);
3667     SvPVX(sv) = ptr;
3668     SvCUR_set(sv, len);
3669     SvLEN_set(sv, len+1);
3670     *SvEND(sv) = '\0';
3671     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3672     SvTAINT(sv);
3673 }
3674
3675 /*
3676 =for apidoc sv_usepvn_mg
3677
3678 Like C<sv_usepvn>, but also handles 'set' magic.
3679
3680 =cut
3681 */
3682
3683 void
3684 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3685 {
3686     sv_usepvn(sv,ptr,len);
3687     SvSETMAGIC(sv);
3688 }
3689
3690 void
3691 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3692 {
3693     if (SvREADONLY(sv)) {
3694         if (SvFAKE(sv)) {
3695             char *pvx = SvPVX(sv);
3696             STRLEN len = SvCUR(sv);
3697             U32 hash   = SvUVX(sv);
3698             SvGROW(sv, len + 1);
3699             Move(pvx,SvPVX(sv),len,char);
3700             *SvEND(sv) = '\0';
3701             SvFAKE_off(sv);
3702             SvREADONLY_off(sv);
3703             unsharepvn(pvx,SvUTF8(sv)?-len:len,hash);
3704         }
3705         else if (PL_curcop != &PL_compiling)
3706             Perl_croak(aTHX_ PL_no_modify);
3707     }
3708     if (SvROK(sv))
3709         sv_unref_flags(sv, flags);
3710     else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3711         sv_unglob(sv);
3712 }
3713
3714 void
3715 Perl_sv_force_normal(pTHX_ register SV *sv)
3716 {
3717     sv_force_normal_flags(sv, 0);
3718 }
3719
3720 /*
3721 =for apidoc sv_chop
3722
3723 Efficient removal of characters from the beginning of the string buffer.
3724 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3725 the string buffer.  The C<ptr> becomes the first character of the adjusted
3726 string.
3727
3728 =cut
3729 */
3730
3731 void
3732 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr) /* like set but assuming ptr is in sv */
3733
3734
3735 {
3736     register STRLEN delta;
3737
3738     if (!ptr || !SvPOKp(sv))
3739         return;
3740     SV_CHECK_THINKFIRST(sv);
3741     if (SvTYPE(sv) < SVt_PVIV)
3742         sv_upgrade(sv,SVt_PVIV);
3743
3744     if (!SvOOK(sv)) {
3745         if (!SvLEN(sv)) { /* make copy of shared string */
3746             char *pvx = SvPVX(sv);
3747             STRLEN len = SvCUR(sv);
3748             SvGROW(sv, len + 1);
3749             Move(pvx,SvPVX(sv),len,char);
3750             *SvEND(sv) = '\0';
3751         }
3752         SvIVX(sv) = 0;
3753         SvFLAGS(sv) |= SVf_OOK;
3754     }
3755     SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVp_IOK|SVp_NOK|SVf_IVisUV);
3756     delta = ptr - SvPVX(sv);
3757     SvLEN(sv) -= delta;
3758     SvCUR(sv) -= delta;
3759     SvPVX(sv) += delta;
3760     SvIVX(sv) += delta;
3761 }
3762
3763 /*
3764 =for apidoc sv_catpvn
3765
3766 Concatenates the string onto the end of the string which is in the SV.  The
3767 C<len> indicates number of bytes to copy.  Handles 'get' magic, but not
3768 'set' magic.  See C<sv_catpvn_mg>.
3769
3770 =cut
3771 */
3772
3773 void
3774 Perl_sv_catpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3775 {
3776     STRLEN tlen;
3777     char *junk;
3778
3779     junk = SvPV_force(sv, tlen);
3780     SvGROW(sv, tlen + len + 1);
3781     if (ptr == junk)
3782         ptr = SvPVX(sv);
3783     Move(ptr,SvPVX(sv)+tlen,len,char);
3784     SvCUR(sv) += len;
3785     *SvEND(sv) = '\0';
3786     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3787     SvTAINT(sv);
3788 }
3789
3790 /*
3791 =for apidoc sv_catpvn_mg
3792
3793 Like C<sv_catpvn>, but also handles 'set' magic.
3794
3795 =cut
3796 */
3797
3798 void
3799 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3800 {
3801     sv_catpvn(sv,ptr,len);
3802     SvSETMAGIC(sv);
3803 }
3804
3805 /*
3806 =for apidoc sv_catsv
3807
3808 Concatenates the string from SV C<ssv> onto the end of the string in
3809 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
3810 not 'set' magic.  See C<sv_catsv_mg>.
3811
3812 =cut */
3813
3814 void
3815 Perl_sv_catsv(pTHX_ SV *dsv, register SV *ssv)
3816 {
3817     char *spv;
3818     STRLEN slen;
3819     if (!ssv)
3820         return;
3821     if ((spv = SvPV(ssv, slen))) {
3822         bool dutf8 = DO_UTF8(dsv);
3823         bool sutf8 = DO_UTF8(ssv);
3824
3825         if (dutf8 == sutf8)
3826             sv_catpvn(dsv,spv,slen);
3827         else {
3828             if (dutf8) {
3829                 /* Not modifying source SV, so taking a temporary copy. */
3830                 SV* csv = sv_2mortal(newSVsv(ssv));
3831                 char *cpv;
3832                 STRLEN clen;
3833
3834                 sv_utf8_upgrade(csv);
3835                 cpv = SvPV(csv,clen);
3836                 sv_catpvn(dsv,cpv,clen);
3837             }
3838             else {
3839                 sv_utf8_upgrade(dsv);
3840                 sv_catpvn(dsv,spv,slen);
3841                 SvUTF8_on(dsv); /* If dsv has no wide characters. */
3842             }
3843         }
3844     }
3845 }
3846
3847 /*
3848 =for apidoc sv_catsv_mg
3849
3850 Like C<sv_catsv>, but also handles 'set' magic.
3851
3852 =cut
3853 */
3854
3855 void
3856 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
3857 {
3858     sv_catsv(dsv,ssv);
3859     SvSETMAGIC(dsv);
3860 }
3861
3862 /*
3863 =for apidoc sv_catpv
3864
3865 Concatenates the string onto the end of the string which is in the SV.
3866 Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
3867
3868 =cut
3869 */
3870
3871 void
3872 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3873 {
3874     register STRLEN len;
3875     STRLEN tlen;
3876     char *junk;
3877
3878     if (!ptr)
3879         return;
3880     junk = SvPV_force(sv, tlen);
3881     len = strlen(ptr);
3882     SvGROW(sv, tlen + len + 1);
3883     if (ptr == junk)
3884         ptr = SvPVX(sv);
3885     Move(ptr,SvPVX(sv)+tlen,len+1,char);
3886     SvCUR(sv) += len;
3887     (void)SvPOK_only_UTF8(sv);          /* validate pointer */
3888     SvTAINT(sv);
3889 }
3890
3891 /*
3892 =for apidoc sv_catpv_mg
3893
3894 Like C<sv_catpv>, but also handles 'set' magic.
3895
3896 =cut
3897 */
3898
3899 void
3900 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3901 {
3902     sv_catpv(sv,ptr);
3903     SvSETMAGIC(sv);
3904 }
3905
3906 SV *
3907 Perl_newSV(pTHX_ STRLEN len)
3908 {
3909     register SV *sv;
3910
3911     new_SV(sv);
3912     if (len) {
3913         sv_upgrade(sv, SVt_PV);
3914         SvGROW(sv, len + 1);
3915     }
3916     return sv;
3917 }
3918
3919 /* name is assumed to contain an SV* if (name && namelen == HEf_SVKEY) */
3920
3921 /*
3922 =for apidoc sv_magic
3923
3924 Adds magic to an SV.
3925
3926 =cut
3927 */
3928
3929 void
3930 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
3931 {
3932     MAGIC* mg;
3933
3934     if (SvREADONLY(sv)) {
3935         if (PL_curcop != &PL_compiling && !strchr("gBf", how))
3936             Perl_croak(aTHX_ PL_no_modify);
3937     }
3938     if (SvMAGICAL(sv) || (how == 't' && SvTYPE(sv) >= SVt_PVMG)) {
3939         if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
3940             if (how == 't')
3941                 mg->mg_len |= 1;
3942             return;
3943         }
3944     }
3945     else {
3946         (void)SvUPGRADE(sv, SVt_PVMG);
3947     }
3948     Newz(702,mg, 1, MAGIC);
3949     mg->mg_moremagic = SvMAGIC(sv);
3950
3951     SvMAGIC(sv) = mg;
3952     if (!obj || obj == sv || how == '#' || how == 'r')
3953         mg->mg_obj = obj;
3954     else {
3955         mg->mg_obj = SvREFCNT_inc(obj);
3956         mg->mg_flags |= MGf_REFCOUNTED;
3957     }
3958     mg->mg_type = how;
3959     mg->mg_len = namlen;
3960     if (name)
3961         if (namlen >= 0)
3962             mg->mg_ptr = savepvn(name, namlen);
3963         else if (namlen == HEf_SVKEY)
3964             mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
3965
3966     switch (how) {
3967     case 0:
3968         mg->mg_virtual = &PL_vtbl_sv;
3969         break;
3970     case 'A':
3971         mg->mg_virtual = &PL_vtbl_amagic;
3972         break;
3973     case 'a':
3974         mg->mg_virtual = &PL_vtbl_amagicelem;
3975         break;
3976     case 'c':
3977         mg->mg_virtual = &PL_vtbl_ovrld;
3978         break;
3979     case 'B':
3980         mg->mg_virtual = &PL_vtbl_bm;
3981         break;
3982     case 'D':
3983         mg->mg_virtual = &PL_vtbl_regdata;
3984         break;
3985     case 'd':
3986         mg->mg_virtual = &PL_vtbl_regdatum;
3987         break;
3988     case 'E':
3989         mg->mg_virtual = &PL_vtbl_env;
3990         break;
3991     case 'f':
3992         mg->mg_virtual = &PL_vtbl_fm;
3993         break;
3994     case 'e':
3995         mg->mg_virtual = &PL_vtbl_envelem;
3996         break;
3997     case 'g':
3998         mg->mg_virtual = &PL_vtbl_mglob;
3999         break;
4000     case 'I':
4001         mg->mg_virtual = &PL_vtbl_isa;
4002         break;
4003     case 'i':
4004         mg->mg_virtual = &PL_vtbl_isaelem;
4005         break;
4006     case 'k':
4007         mg->mg_virtual = &PL_vtbl_nkeys;
4008         break;
4009     case 'L':
4010         SvRMAGICAL_on(sv);
4011         mg->mg_virtual = 0;
4012         break;
4013     case 'l':
4014         mg->mg_virtual = &PL_vtbl_dbline;
4015         break;
4016 #ifdef USE_THREADS
4017     case 'm':
4018         mg->mg_virtual = &PL_vtbl_mutex;
4019         break;
4020 #endif /* USE_THREADS */
4021 #ifdef USE_LOCALE_COLLATE
4022     case 'o':
4023         mg->mg_virtual = &PL_vtbl_collxfrm;
4024         break;
4025 #endif /* USE_LOCALE_COLLATE */
4026     case 'P':
4027         mg->mg_virtual = &PL_vtbl_pack;
4028         break;
4029     case 'p':
4030     case 'q':
4031         mg->mg_virtual = &PL_vtbl_packelem;
4032         break;
4033     case 'r':
4034         mg->mg_virtual = &PL_vtbl_regexp;
4035         break;
4036     case 'S':
4037         mg->mg_virtual = &PL_vtbl_sig;
4038         break;
4039     case 's':
4040         mg->mg_virtual = &PL_vtbl_sigelem;
4041         break;
4042     case 't':
4043         mg->mg_virtual = &PL_vtbl_taint;
4044         mg->mg_len = 1;
4045         break;
4046     case 'U':
4047         mg->mg_virtual = &PL_vtbl_uvar;
4048         break;
4049     case 'v':
4050         mg->mg_virtual = &PL_vtbl_vec;
4051         break;
4052     case 'x':
4053         mg->mg_virtual = &PL_vtbl_substr;
4054         break;
4055     case 'y':
4056         mg->mg_virtual = &PL_vtbl_defelem;
4057         break;
4058     case '*':
4059         mg->mg_virtual = &PL_vtbl_glob;
4060         break;
4061     case '#':
4062         mg->mg_virtual = &PL_vtbl_arylen;
4063         break;
4064     case '.':
4065         mg->mg_virtual = &PL_vtbl_pos;
4066         break;
4067     case '<':
4068         mg->mg_virtual = &PL_vtbl_backref;
4069         break;
4070     case '~':   /* Reserved for use by extensions not perl internals.   */
4071         /* Useful for attaching extension internal data to perl vars.   */
4072         /* Note that multiple extensions may clash if magical scalars   */
4073         /* etc holding private data from one are passed to another.     */
4074         SvRMAGICAL_on(sv);
4075         break;
4076     default:
4077         Perl_croak(aTHX_ "Don't know how to handle magic of type '%c'", how);
4078     }
4079     mg_magical(sv);
4080     if (SvGMAGICAL(sv))
4081         SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4082 }
4083
4084 /*
4085 =for apidoc sv_unmagic
4086
4087 Removes magic from an SV.
4088
4089 =cut
4090 */
4091
4092 int
4093 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4094 {
4095     MAGIC* mg;
4096     MAGIC** mgp;
4097     if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4098         return 0;
4099     mgp = &SvMAGIC(sv);
4100     for (mg = *mgp; mg; mg = *mgp) {
4101         if (mg->mg_type == type) {
4102             MGVTBL* vtbl = mg->mg_virtual;
4103             *mgp = mg->mg_moremagic;
4104             if (vtbl && vtbl->svt_free)
4105                 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4106             if (mg->mg_ptr && mg->mg_type != 'g')
4107                 if (mg->mg_len >= 0)
4108                     Safefree(mg->mg_ptr);
4109                 else if (mg->mg_len == HEf_SVKEY)
4110                     SvREFCNT_dec((SV*)mg->mg_ptr);
4111             if (mg->mg_flags & MGf_REFCOUNTED)
4112                 SvREFCNT_dec(mg->mg_obj);
4113             Safefree(mg);
4114         }
4115         else
4116             mgp = &mg->mg_moremagic;
4117     }
4118     if (!SvMAGIC(sv)) {
4119         SvMAGICAL_off(sv);
4120         SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4121     }
4122
4123     return 0;
4124 }
4125
4126 /*
4127 =for apidoc sv_rvweaken
4128
4129 Weaken a reference.
4130
4131 =cut
4132 */
4133
4134 SV *
4135 Perl_sv_rvweaken(pTHX_ SV *sv)
4136 {
4137     SV *tsv;
4138     if (!SvOK(sv))  /* let undefs pass */
4139         return sv;
4140     if (!SvROK(sv))
4141         Perl_croak(aTHX_ "Can't weaken a nonreference");
4142     else if (SvWEAKREF(sv)) {
4143         if (ckWARN(WARN_MISC))
4144             Perl_warner(aTHX_ WARN_MISC, "Reference is already weak");
4145         return sv;
4146     }
4147     tsv = SvRV(sv);
4148     sv_add_backref(tsv, sv);
4149     SvWEAKREF_on(sv);
4150     SvREFCNT_dec(tsv);
4151     return sv;
4152 }
4153
4154 STATIC void
4155 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4156 {
4157     AV *av;
4158     MAGIC *mg;
4159     if (SvMAGICAL(tsv) && (mg = mg_find(tsv, '<')))
4160         av = (AV*)mg->mg_obj;
4161     else {
4162         av = newAV();
4163         sv_magic(tsv, (SV*)av, '<', NULL, 0);
4164         SvREFCNT_dec(av);           /* for sv_magic */
4165     }
4166     av_push(av,sv);
4167 }
4168
4169 STATIC void
4170 S_sv_del_backref(pTHX_ SV *sv)
4171 {
4172     AV *av;
4173     SV **svp;
4174     I32 i;
4175     SV *tsv = SvRV(sv);
4176     MAGIC *mg;
4177     if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, '<')))
4178         Perl_croak(aTHX_ "panic: del_backref");
4179     av = (AV *)mg->mg_obj;
4180     svp = AvARRAY(av);
4181     i = AvFILLp(av);
4182     while (i >= 0) {
4183         if (svp[i] == sv) {
4184             svp[i] = &PL_sv_undef; /* XXX */
4185         }
4186         i--;
4187     }
4188 }
4189
4190 /*
4191 =for apidoc sv_insert
4192
4193 Inserts a string at the specified offset/length within the SV. Similar to
4194 the Perl substr() function.
4195
4196 =cut
4197 */
4198
4199 void
4200 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
4201 {
4202     register char *big;
4203     register char *mid;
4204     register char *midend;
4205     register char *bigend;
4206     register I32 i;
4207     STRLEN curlen;
4208
4209
4210     if (!bigstr)
4211         Perl_croak(aTHX_ "Can't modify non-existent substring");
4212     SvPV_force(bigstr, curlen);
4213     (void)SvPOK_only_UTF8(bigstr);
4214     if (offset + len > curlen) {
4215         SvGROW(bigstr, offset+len+1);
4216         Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4217         SvCUR_set(bigstr, offset+len);
4218     }
4219
4220     SvTAINT(bigstr);
4221     i = littlelen - len;
4222     if (i > 0) {                        /* string might grow */
4223         big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4224         mid = big + offset + len;
4225         midend = bigend = big + SvCUR(bigstr);
4226         bigend += i;
4227         *bigend = '\0';
4228         while (midend > mid)            /* shove everything down */
4229             *--bigend = *--midend;
4230         Move(little,big+offset,littlelen,char);
4231         SvCUR(bigstr) += i;
4232         SvSETMAGIC(bigstr);
4233         return;
4234     }
4235     else if (i == 0) {
4236         Move(little,SvPVX(bigstr)+offset,len,char);
4237         SvSETMAGIC(bigstr);
4238         return;
4239     }
4240
4241     big = SvPVX(bigstr);
4242     mid = big + offset;
4243     midend = mid + len;
4244     bigend = big + SvCUR(bigstr);
4245
4246     if (midend > bigend)
4247         Perl_croak(aTHX_ "panic: sv_insert");
4248
4249     if (mid - big > bigend - midend) {  /* faster to shorten from end */
4250         if (littlelen) {
4251             Move(little, mid, littlelen,char);
4252             mid += littlelen;
4253         }
4254         i = bigend - midend;
4255         if (i > 0) {
4256             Move(midend, mid, i,char);
4257             mid += i;
4258         }
4259         *mid = '\0';
4260         SvCUR_set(bigstr, mid - big);
4261     }
4262     /*SUPPRESS 560*/
4263     else if ((i = mid - big)) { /* faster from front */
4264         midend -= littlelen;
4265         mid = midend;
4266         sv_chop(bigstr,midend-i);
4267         big += i;
4268         while (i--)
4269             *--midend = *--big;
4270         if (littlelen)
4271             Move(little, mid, littlelen,char);
4272     }
4273     else if (littlelen) {
4274         midend -= littlelen;
4275         sv_chop(bigstr,midend);
4276         Move(little,midend,littlelen,char);
4277     }
4278     else {
4279         sv_chop(bigstr,midend);
4280     }
4281     SvSETMAGIC(bigstr);
4282 }
4283
4284 /*
4285 =for apidoc sv_replace
4286
4287 Make the first argument a copy of the second, then delete the original.
4288
4289 =cut
4290 */
4291
4292 void
4293 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4294 {
4295     U32 refcnt = SvREFCNT(sv);
4296     SV_CHECK_THINKFIRST(sv);
4297     if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
4298         Perl_warner(aTHX_ WARN_INTERNAL, "Reference miscount in sv_replace()");
4299     if (SvMAGICAL(sv)) {
4300         if (SvMAGICAL(nsv))
4301             mg_free(nsv);
4302         else
4303             sv_upgrade(nsv, SVt_PVMG);
4304         SvMAGIC(nsv) = SvMAGIC(sv);
4305         SvFLAGS(nsv) |= SvMAGICAL(sv);
4306         SvMAGICAL_off(sv);
4307         SvMAGIC(sv) = 0;
4308     }
4309     SvREFCNT(sv) = 0;
4310     sv_clear(sv);
4311     assert(!SvREFCNT(sv));
4312     StructCopy(nsv,sv,SV);
4313     SvREFCNT(sv) = refcnt;
4314     SvFLAGS(nsv) |= SVTYPEMASK;         /* Mark as freed */
4315     del_SV(nsv);
4316 }
4317
4318 /*
4319 =for apidoc sv_clear
4320
4321 Clear an SV, making it empty. Does not free the memory used by the SV
4322 itself.
4323
4324 =cut
4325 */
4326
4327 void
4328 Perl_sv_clear(pTHX_ register SV *sv)
4329 {
4330     HV* stash;
4331     assert(sv);
4332     assert(SvREFCNT(sv) == 0);
4333
4334     if (SvOBJECT(sv)) {
4335         if (PL_defstash) {              /* Still have a symbol table? */
4336             djSP;
4337             CV* destructor;
4338             SV tmpref;
4339
4340             Zero(&tmpref, 1, SV);
4341             sv_upgrade(&tmpref, SVt_RV);
4342             SvROK_on(&tmpref);
4343             SvREADONLY_on(&tmpref);     /* DESTROY() could be naughty */
4344             SvREFCNT(&tmpref) = 1;
4345
4346             do {
4347                 stash = SvSTASH(sv);
4348                 destructor = StashHANDLER(stash,DESTROY);
4349                 if (destructor) {
4350                     ENTER;
4351                     PUSHSTACKi(PERLSI_DESTROY);
4352                     SvRV(&tmpref) = SvREFCNT_inc(sv);
4353                     EXTEND(SP, 2);
4354                     PUSHMARK(SP);
4355                     PUSHs(&tmpref);
4356                     PUTBACK;
4357                     call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR);
4358                     SvREFCNT(sv)--;
4359                     POPSTACK;
4360                     SPAGAIN;
4361                     LEAVE;
4362                 }
4363             } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4364
4365             del_XRV(SvANY(&tmpref));
4366
4367             if (SvREFCNT(sv)) {
4368                 if (PL_in_clean_objs)
4369                     Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4370                           HvNAME(stash));
4371                 /* DESTROY gave object new lease on life */
4372                 return;
4373             }
4374         }
4375
4376         if (SvOBJECT(sv)) {
4377             SvREFCNT_dec(SvSTASH(sv));  /* possibly of changed persuasion */
4378             SvOBJECT_off(sv);   /* Curse the object. */
4379             if (SvTYPE(sv) != SVt_PVIO)
4380                 --PL_sv_objcount;       /* XXX Might want something more general */
4381         }
4382     }
4383     if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv))
4384         mg_free(sv);
4385     stash = NULL;
4386     switch (SvTYPE(sv)) {
4387     case SVt_PVIO:
4388         if (IoIFP(sv) &&
4389             IoIFP(sv) != PerlIO_stdin() &&
4390             IoIFP(sv) != PerlIO_stdout() &&
4391             IoIFP(sv) != PerlIO_stderr())
4392         {
4393             io_close((IO*)sv, FALSE);
4394         }
4395         if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4396             PerlDir_close(IoDIRP(sv));
4397         IoDIRP(sv) = (DIR*)NULL;
4398         Safefree(IoTOP_NAME(sv));
4399         Safefree(IoFMT_NAME(sv));
4400         Safefree(IoBOTTOM_NAME(sv));
4401         /* FALL THROUGH */
4402     case SVt_PVBM:
4403         goto freescalar;
4404     case SVt_PVCV:
4405     case SVt_PVFM:
4406         cv_undef((CV*)sv);
4407         goto freescalar;
4408     case SVt_PVHV:
4409         hv_undef((HV*)sv);
4410         break;
4411     case SVt_PVAV:
4412         av_undef((AV*)sv);
4413         break;
4414     case SVt_PVLV:
4415         SvREFCNT_dec(LvTARG(sv));
4416         goto freescalar;
4417     case SVt_PVGV:
4418         gp_free((GV*)sv);
4419         Safefree(GvNAME(sv));
4420         /* cannot decrease stash refcount yet, as we might recursively delete
4421            ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
4422            of stash until current sv is completely gone.
4423            -- JohnPC, 27 Mar 1998 */
4424         stash = GvSTASH(sv);
4425         /* FALL THROUGH */
4426     case SVt_PVMG:
4427     case SVt_PVNV:
4428     case SVt_PVIV:
4429       freescalar:
4430         (void)SvOOK_off(sv);
4431         /* FALL THROUGH */
4432     case SVt_PV:
4433     case SVt_RV:
4434         if (SvROK(sv)) {
4435             if (SvWEAKREF(sv))
4436                 sv_del_backref(sv);
4437             else
4438                 SvREFCNT_dec(SvRV(sv));
4439         }
4440         else if (SvPVX(sv) && SvLEN(sv))
4441             Safefree(SvPVX(sv));
4442         else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4443             unsharepvn(SvPVX(sv),SvUTF8(sv)?-SvCUR(sv):SvCUR(sv),SvUVX(sv));
4444             SvFAKE_off(sv);
4445         }
4446         break;
4447 /*
4448     case SVt_NV:
4449     case SVt_IV:
4450     case SVt_NULL:
4451         break;
4452 */
4453     }
4454
4455     switch (SvTYPE(sv)) {
4456     case SVt_NULL:
4457         break;
4458     case SVt_IV:
4459         del_XIV(SvANY(sv));
4460         break;
4461     case SVt_NV:
4462         del_XNV(SvANY(sv));
4463         break;
4464     case SVt_RV:
4465         del_XRV(SvANY(sv));
4466         break;
4467     case SVt_PV:
4468         del_XPV(SvANY(sv));
4469         break;
4470     case SVt_PVIV:
4471         del_XPVIV(SvANY(sv));
4472         break;
4473     case SVt_PVNV:
4474         del_XPVNV(SvANY(sv));
4475         break;
4476     case SVt_PVMG:
4477         del_XPVMG(SvANY(sv));
4478         break;
4479     case SVt_PVLV:
4480         del_XPVLV(SvANY(sv));
4481         break;
4482     case SVt_PVAV:
4483         del_XPVAV(SvANY(sv));
4484         break;
4485     case SVt_PVHV:
4486         del_XPVHV(SvANY(sv));
4487         break;
4488     case SVt_PVCV:
4489         del_XPVCV(SvANY(sv));
4490         break;
4491     case SVt_PVGV:
4492         del_XPVGV(SvANY(sv));
4493         /* code duplication for increased performance. */
4494         SvFLAGS(sv) &= SVf_BREAK;
4495         SvFLAGS(sv) |= SVTYPEMASK;
4496         /* decrease refcount of the stash that owns this GV, if any */
4497         if (stash)
4498             SvREFCNT_dec(stash);
4499         return; /* not break, SvFLAGS reset already happened */
4500     case SVt_PVBM:
4501         del_XPVBM(SvANY(sv));
4502         break;
4503     case SVt_PVFM:
4504         del_XPVFM(SvANY(sv));
4505         break;
4506     case SVt_PVIO:
4507         del_XPVIO(SvANY(sv));
4508         break;
4509     }
4510     SvFLAGS(sv) &= SVf_BREAK;
4511     SvFLAGS(sv) |= SVTYPEMASK;
4512 }
4513
4514 SV *
4515 Perl_sv_newref(pTHX_ SV *sv)
4516 {
4517     if (sv)
4518         ATOMIC_INC(SvREFCNT(sv));
4519     return sv;
4520 }
4521
4522 /*
4523 =for apidoc sv_free
4524
4525 Free the memory used by an SV.
4526
4527 =cut
4528 */
4529
4530 void
4531 Perl_sv_free(pTHX_ SV *sv)
4532 {
4533     int refcount_is_zero;
4534
4535     if (!sv)
4536         return;
4537     if (SvREFCNT(sv) == 0) {
4538         if (SvFLAGS(sv) & SVf_BREAK)
4539             return;
4540         if (PL_in_clean_all) /* All is fair */
4541             return;
4542         if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4543             /* make sure SvREFCNT(sv)==0 happens very seldom */
4544             SvREFCNT(sv) = (~(U32)0)/2;
4545             return;
4546         }
4547         if (ckWARN_d(WARN_INTERNAL))
4548             Perl_warner(aTHX_ WARN_INTERNAL, "Attempt to free unreferenced scalar");
4549         return;
4550     }
4551     ATOMIC_DEC_AND_TEST(refcount_is_zero, SvREFCNT(sv));
4552     if (!refcount_is_zero)
4553         return;
4554 #ifdef DEBUGGING
4555     if (SvTEMP(sv)) {
4556         if (ckWARN_d(WARN_DEBUGGING))
4557             Perl_warner(aTHX_ WARN_DEBUGGING,
4558                         "Attempt to free temp prematurely: SV 0x%"UVxf,
4559                         PTR2UV(sv));
4560         return;
4561     }
4562 #endif
4563     if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4564         /* make sure SvREFCNT(sv)==0 happens very seldom */
4565         SvREFCNT(sv) = (~(U32)0)/2;
4566         return;
4567     }
4568     sv_clear(sv);
4569     if (! SvREFCNT(sv))
4570         del_SV(sv);
4571 }
4572
4573 /*
4574 =for apidoc sv_len
4575
4576 Returns the length of the string in the SV.  See also C<SvCUR>.
4577
4578 =cut
4579 */
4580
4581 STRLEN
4582 Perl_sv_len(pTHX_ register SV *sv)
4583 {
4584     char *junk;
4585     STRLEN len;
4586
4587     if (!sv)
4588         return 0;
4589
4590     if (SvGMAGICAL(sv))
4591         len = mg_length(sv);
4592     else
4593         junk = SvPV(sv, len);
4594     return len;
4595 }
4596
4597 /*
4598 =for apidoc sv_len_utf8
4599
4600 Returns the number of characters in the string in an SV, counting wide
4601 UTF8 bytes as a single character.
4602
4603 =cut
4604 */
4605
4606 STRLEN
4607 Perl_sv_len_utf8(pTHX_ register SV *sv)
4608 {
4609     if (!sv)
4610         return 0;
4611
4612     if (SvGMAGICAL(sv))
4613         return mg_length(sv);
4614     else
4615     {
4616         STRLEN len;
4617         U8 *s = (U8*)SvPV(sv, len);
4618
4619         return Perl_utf8_length(aTHX_ s, s + len);
4620     }
4621 }
4622
4623 void
4624 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
4625 {
4626     U8 *start;
4627     U8 *s;
4628     U8 *send;
4629     I32 uoffset = *offsetp;
4630     STRLEN len;
4631
4632     if (!sv)
4633         return;
4634
4635     start = s = (U8*)SvPV(sv, len);
4636     send = s + len;
4637     while (s < send && uoffset--)
4638         s += UTF8SKIP(s);
4639     if (s >= send)
4640         s = send;
4641     *offsetp = s - start;
4642     if (lenp) {
4643         I32 ulen = *lenp;
4644         start = s;
4645         while (s < send && ulen--)
4646             s += UTF8SKIP(s);
4647         if (s >= send)
4648             s = send;
4649         *lenp = s - start;
4650     }
4651     return;
4652 }
4653
4654 void
4655 Perl_sv_pos_b2u(pTHX_ register SV *sv, I32* offsetp)
4656 {
4657     U8 *s;
4658     U8 *send;
4659     STRLEN len;
4660
4661     if (!sv)
4662         return;
4663
4664     s = (U8*)SvPV(sv, len);
4665     if (len < *offsetp)
4666         Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
4667     send = s + *offsetp;
4668     len = 0;
4669     while (s < send) {
4670         STRLEN n;
4671
4672         if (utf8_to_uv(s, UTF8SKIP(s), &n, 0)) {
4673             s += n;
4674             len++;
4675         }
4676         else
4677             break;
4678     }
4679     *offsetp = len;
4680     return;
4681 }
4682
4683 /*
4684 =for apidoc sv_eq
4685
4686 Returns a boolean indicating whether the strings in the two SVs are
4687 identical.
4688
4689 =cut
4690 */
4691
4692 I32
4693 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
4694 {
4695     char *pv1;
4696     STRLEN cur1;
4697     char *pv2;
4698     STRLEN cur2;
4699     I32  eq     = 0;
4700     bool pv1tmp = FALSE;
4701     bool pv2tmp = FALSE;
4702
4703     if (!sv1) {
4704         pv1 = "";
4705         cur1 = 0;
4706     }
4707     else
4708         pv1 = SvPV(sv1, cur1);
4709
4710     if (!sv2){
4711         pv2 = "";
4712         cur2 = 0;
4713     }
4714     else
4715         pv2 = SvPV(sv2, cur2);
4716
4717     /* do not utf8ize the comparands as a side-effect */
4718     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTE) {
4719         bool is_utf8 = TRUE;
4720
4721         if (PL_hints & HINT_UTF8_DISTINCT)
4722             return FALSE;
4723
4724         if (SvUTF8(sv1)) {
4725             char *pv = (char*)bytes_from_utf8((U8*)pv1, &cur1, &is_utf8);
4726             if (is_utf8)
4727                 return 0;
4728             pv1tmp = (pv != pv1);
4729             pv1 = pv;
4730         }
4731         else {
4732             char *pv = (char *)bytes_from_utf8((U8*)pv2, &cur2, &is_utf8);
4733             if (is_utf8)
4734                 return 0;
4735             pv2tmp = (pv != pv2);
4736             pv2 = pv;
4737         }
4738     }
4739
4740     if (cur1 == cur2)
4741         eq = memEQ(pv1, pv2, cur1);
4742
4743     if (pv1tmp)
4744         Safefree(pv1);
4745     if (pv2tmp)
4746         Safefree(pv2);
4747
4748     return eq;
4749 }
4750
4751 /*
4752 =for apidoc sv_cmp
4753
4754 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
4755 string in C<sv1> is less than, equal to, or greater than the string in
4756 C<sv2>.
4757
4758 =cut
4759 */
4760
4761 I32
4762 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
4763 {
4764     STRLEN cur1, cur2;
4765     char *pv1, *pv2;
4766     I32  cmp;
4767     bool pv1tmp = FALSE;
4768     bool pv2tmp = FALSE;
4769
4770     if (!sv1) {
4771         pv1 = "";
4772         cur1 = 0;
4773     }
4774     else
4775         pv1 = SvPV(sv1, cur1);
4776
4777     if (!sv2){
4778         pv2 = "";
4779         cur2 = 0;
4780     }
4781     else
4782         pv2 = SvPV(sv2, cur2);
4783
4784     /* do not utf8ize the comparands as a side-effect */
4785     if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTE) {
4786         if (PL_hints & HINT_UTF8_DISTINCT)
4787             return SvUTF8(sv1) ? 1 : -1;
4788
4789         if (SvUTF8(sv1)) {
4790             pv2 = (char*)bytes_to_utf8((U8*)pv2, &cur2);
4791             pv2tmp = TRUE;
4792         }
4793         else {
4794             pv1 = (char*)bytes_to_utf8((U8*)pv1, &cur1);
4795             pv1tmp = TRUE;
4796         }
4797     }
4798
4799     if (!cur1) {
4800         cmp = cur2 ? -1 : 0;
4801     } else if (!cur2) {
4802         cmp = 1;
4803     } else {
4804         I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
4805
4806         if (retval) {
4807             cmp = retval < 0 ? -1 : 1;
4808         } else if (cur1 == cur2) {
4809             cmp = 0;
4810         } else {
4811             cmp = cur1 < cur2 ? -1 : 1;
4812         }
4813     }
4814
4815     if (pv1tmp)
4816         Safefree(pv1);
4817     if (pv2tmp)
4818         Safefree(pv2);
4819
4820     return cmp;
4821 }
4822
4823 /*
4824 =for apidoc sv_cmp_locale
4825
4826 Compares the strings in two SVs in a locale-aware manner. See
4827 L</sv_cmp_locale>
4828
4829 =cut
4830 */
4831
4832 I32
4833 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
4834 {
4835 #ifdef USE_LOCALE_COLLATE
4836
4837     char *pv1, *pv2;
4838     STRLEN len1, len2;
4839     I32 retval;
4840
4841     if (PL_collation_standard)
4842         goto raw_compare;
4843
4844     len1 = 0;
4845     pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
4846     len2 = 0;
4847     pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
4848
4849     if (!pv1 || !len1) {
4850         if (pv2 && len2)
4851             return -1;
4852         else
4853             goto raw_compare;
4854     }
4855     else {
4856         if (!pv2 || !len2)
4857             return 1;
4858     }
4859
4860     retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
4861
4862     if (retval)
4863         return retval < 0 ? -1 : 1;
4864
4865     /*
4866      * When the result of collation is equality, that doesn't mean
4867      * that there are no differences -- some locales exclude some
4868      * characters from consideration.  So to avoid false equalities,
4869      * we use the raw string as a tiebreaker.
4870      */
4871
4872   raw_compare:
4873     /* FALL THROUGH */
4874
4875 #endif /* USE_LOCALE_COLLATE */
4876
4877     return sv_cmp(sv1, sv2);
4878 }
4879
4880 #ifdef USE_LOCALE_COLLATE
4881 /*
4882  * Any scalar variable may carry an 'o' magic that contains the
4883  * scalar data of the variable transformed to such a format that
4884  * a normal memory comparison can be used to compare the data
4885  * according to the locale settings.
4886  */
4887 char *
4888 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
4889 {
4890     MAGIC *mg;
4891
4892     mg = SvMAGICAL(sv) ? mg_find(sv, 'o') : (MAGIC *) NULL;
4893     if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
4894         char *s, *xf;
4895         STRLEN len, xlen;
4896
4897         if (mg)
4898             Safefree(mg->mg_ptr);
4899         s = SvPV(sv, l