sv.h

   1 /*    sv.h
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
   4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 #ifdef sv_flags
  12 #undef sv_flags         /* Convex has this in <signal.h> for sigvec() */
  13 #endif
  14
  15 /*
  16 =head1 SV Flags
  17
  18 =for apidoc AmU||svtype
  19 An enum of flags for Perl types.  These are found in the file B<sv.h>
  20 in the C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
  21
  22 =for apidoc AmU||SVt_PV
  23 Pointer type flag for scalars.  See C<svtype>.
  24
  25 =for apidoc AmU||SVt_IV
  26 Integer type flag for scalars.  See C<svtype>.
  27
  28 =for apidoc AmU||SVt_NV
  29 Double type flag for scalars.  See C<svtype>.
  30
  31 =for apidoc AmU||SVt_PVMG
  32 Type flag for blessed scalars.  See C<svtype>.
  33
  34 =for apidoc AmU||SVt_PVAV
  35 Type flag for arrays.  See C<svtype>.
  36
  37 =for apidoc AmU||SVt_PVHV
  38 Type flag for hashes.  See C<svtype>.
  39
  40 =for apidoc AmU||SVt_PVCV
  41 Type flag for code refs.  See C<svtype>.
  42
  43 =cut
  44 */
  45
  46 typedef enum {
  47         SVt_NULL,       /* 0 */
  48         SVt_BIND,       /* 1 */
  49         SVt_IV,         /* 2 */
  50         SVt_NV,         /* 3 */
  51         /* RV was here, before it was merged with IV.  */
  52         SVt_PV,         /* 4 */
  53         SVt_PVIV,       /* 5 */
  54         SVt_PVNV,       /* 6 */
  55         SVt_PVMG,       /* 7 */
  56         SVt_REGEXP,     /* 8 */
  57         /* PVBM was here, before BIND replaced it.  */
  58         SVt_PVGV,       /* 9 */
  59         SVt_PVLV,       /* 10 */
  60         SVt_PVAV,       /* 11 */
  61         SVt_PVHV,       /* 12 */
  62         SVt_PVCV,       /* 13 */
  63         SVt_PVFM,       /* 14 */
  64         SVt_PVIO,       /* 15 */
  65         SVt_LAST        /* keep last in enum. used to size arrays */
  66 } svtype;
  67
  68 #ifndef PERL_CORE
  69 /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
  70    purposes eternal code wanting to consider PVBM probably needs to think of
  71    PVMG instead.  */
  72 #  define SVt_PVBM      SVt_PVMG
  73 /* Anything wanting to create a reference from clean should ensure that it has
  74    a scalar of type SVt_IV now:  */
  75 #  define SVt_RV        SVt_IV
  76 #endif
  77
  78 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
  79    so never reaches the clause at the end that uses sv_type_details->body_size
  80    to determine whether to call safefree(). Hence body_size can be set
  81    non-zero to record the size of HEs, without fear of bogus frees.  */
  82 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
  83 #define HE_SVSLOT       SVt_NULL
  84 #endif
  85
  86 #define PERL_ARENA_ROOTS_SIZE   (SVt_LAST)
  87
  88 /* typedefs to eliminate some typing */
  89 typedef struct he HE;
  90 typedef struct hek HEK;
  91
  92 /* Using C's structural equivalence to help emulate C++ inheritance here... */
  93
  94 /* start with 2 sv-head building blocks */
  95 #define _SV_HEAD(ptrtype) \
  96     ptrtype     sv_any;         /* pointer to body */   \
  97     U32         sv_refcnt;      /* how many references to us */ \
  98     U32         sv_flags        /* what we are */
  99
 100 #define _SV_HEAD_UNION \
 101     union {                             \
 102         char*   svu_pv;         /* pointer to malloced string */        \
 103         IV      svu_iv;                 \
 104         UV      svu_uv;                 \
 105         SV*     svu_rv;         /* pointer to another SV */             \
 106         SV**    svu_array;              \
 107         HE**    svu_hash;               \
 108         GP*     svu_gp;                 \
 109     }   sv_u
 110
 111
 112 struct STRUCT_SV {              /* struct sv { */
 113     _SV_HEAD(void*);
 114     _SV_HEAD_UNION;
 115 #ifdef DEBUG_LEAKING_SCALARS
 116     PERL_BITFIELD32 sv_debug_optype:9;  /* the type of OP that allocated us */
 117     PERL_BITFIELD32 sv_debug_inpad:1;   /* was allocated in a pad for an OP */
 118     PERL_BITFIELD32 sv_debug_cloned:1;  /* was cloned for an ithread */
 119     PERL_BITFIELD32 sv_debug_line:16;   /* the line where we were allocated */
 120     U32             sv_debug_serial;    /* serial number of sv allocation   */
 121     char *      sv_debug_file;          /* the file where we were allocated */
 122 #endif
 123 };
 124
 125 struct gv {
 126     _SV_HEAD(XPVGV*);           /* pointer to xpvgv body */
 127     _SV_HEAD_UNION;
 128 };
 129
 130 struct cv {
 131     _SV_HEAD(XPVCV*);           /* pointer to xpvcv body */
 132     _SV_HEAD_UNION;
 133 };
 134
 135 struct av {
 136     _SV_HEAD(XPVAV*);           /* pointer to xpvav body */
 137     _SV_HEAD_UNION;
 138 };
 139
 140 struct hv {
 141     _SV_HEAD(XPVHV*);           /* pointer to xpvhv body */
 142     _SV_HEAD_UNION;
 143 };
 144
 145 struct io {
 146     _SV_HEAD(XPVIO*);           /* pointer to xpvio body */
 147     _SV_HEAD_UNION;
 148 };
 149
 150 struct p5rx {
 151     _SV_HEAD(struct regexp*);   /* pointer to regexp body */
 152     _SV_HEAD_UNION;
 153 };
 154
 155 #undef _SV_HEAD
 156 #undef _SV_HEAD_UNION           /* ensure no pollution */
 157
 158 /*
 159 =head1 SV Manipulation Functions
 160
 161 =for apidoc Am|U32|SvREFCNT|SV* sv
 162 Returns the value of the object's reference count.
 163
 164 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
 165 Increments the reference count of the given SV.
 166
 167 All of the following SvREFCNT_inc* macros are optimized versions of
 168 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
 169
 170 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
 171 Same as SvREFCNT_inc, but can only be used if you know I<sv>
 172 is not NULL.  Since we don't have to check the NULLness, it's faster
 173 and smaller.
 174
 175 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
 176 Same as SvREFCNT_inc, but can only be used if you don't need the
 177 return value.  The macro doesn't need to return a meaningful value.
 178
 179 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
 180 Same as SvREFCNT_inc, but can only be used if you don't need the return
 181 value, and you know that I<sv> is not NULL.  The macro doesn't need
 182 to return a meaningful value, or check for NULLness, so it's smaller
 183 and faster.
 184
 185 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
 186 Same as SvREFCNT_inc, but can only be used with expressions without side
 187 effects.  Since we don't have to store a temporary value, it's faster.
 188
 189 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
 190 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
 191 is not NULL.  Since we don't have to check the NULLness, it's faster
 192 and smaller.
 193
 194 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
 195 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
 196 return value.  The macro doesn't need to return a meaningful value.
 197
 198 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
 199 Same as SvREFCNT_inc, but can only be used if you don't need the return
 200 value, and you know that I<sv> is not NULL.  The macro doesn't need
 201 to return a meaningful value, or check for NULLness, so it's smaller
 202 and faster.
 203
 204 =for apidoc Am|void|SvREFCNT_dec|SV* sv
 205 Decrements the reference count of the given SV.
 206
 207 =for apidoc Am|svtype|SvTYPE|SV* sv
 208 Returns the type of the SV.  See C<svtype>.
 209
 210 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
 211 Used to upgrade an SV to a more complex form.  Uses C<sv_upgrade> to
 212 perform the upgrade if necessary.  See C<svtype>.
 213
 214 =cut
 215 */
 216
 217 #define SvANY(sv)       (sv)->sv_any
 218 #define SvFLAGS(sv)     (sv)->sv_flags
 219 #define SvREFCNT(sv)    (sv)->sv_refcnt
 220
 221 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 222 #  define SvREFCNT_inc(sv)              \
 223     ({                                  \
 224         SV * const _sv = MUTABLE_SV(sv);        \
 225         if (_sv)                        \
 226              (SvREFCNT(_sv))++;         \
 227         _sv;                            \
 228     })
 229 #  define SvREFCNT_inc_simple(sv)       \
 230     ({                                  \
 231         if (sv)                         \
 232              (SvREFCNT(sv))++;          \
 233         MUTABLE_SV(sv);                         \
 234     })
 235 #  define SvREFCNT_inc_NN(sv)           \
 236     ({                                  \
 237         SV * const _sv = MUTABLE_SV(sv);        \
 238         SvREFCNT(_sv)++;                \
 239         _sv;                            \
 240     })
 241 #  define SvREFCNT_inc_void(sv)         \
 242     ({                                  \
 243         SV * const _sv = MUTABLE_SV(sv);        \
 244         if (_sv)                        \
 245             (void)(SvREFCNT(_sv)++);    \
 246     })
 247 #else
 248 #  define SvREFCNT_inc(sv)      \
 249         ((PL_Sv=MUTABLE_SV(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
 250 #  define SvREFCNT_inc_simple(sv) \
 251         ((sv) ? (SvREFCNT(sv)++,MUTABLE_SV(sv)) : NULL)
 252 #  define SvREFCNT_inc_NN(sv) \
 253         (PL_Sv=MUTABLE_SV(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
 254 #  define SvREFCNT_inc_void(sv) \
 255         (void)((PL_Sv=MUTABLE_SV(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
 256 #endif
 257
 258 /* These guys don't need the curly blocks */
 259 #define SvREFCNT_inc_simple_void(sv)    STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
 260 #define SvREFCNT_inc_simple_NN(sv)      (++(SvREFCNT(sv)),MUTABLE_SV(sv))
 261 #define SvREFCNT_inc_void_NN(sv)        (void)(++SvREFCNT(MUTABLE_SV(sv)))
 262 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
 263
 264 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 265 #  define SvREFCNT_dec(sv)              \
 266     ({                                  \
 267         SV * const _sv = MUTABLE_SV(sv);        \
 268         if (_sv) {                      \
 269             if (SvREFCNT(_sv)) {        \
 270                 if (--(SvREFCNT(_sv)) == 0) \
 271                     Perl_sv_free2(aTHX_ _sv);   \
 272             } else {                    \
 273                 sv_free(_sv);           \
 274             }                           \
 275         }                               \
 276     })
 277 #else
 278 #define SvREFCNT_dec(sv)        sv_free(MUTABLE_SV(sv))
 279 #endif
 280
 281 #define SVTYPEMASK      0xff
 282 #define SvTYPE(sv)      ((svtype)((sv)->sv_flags & SVTYPEMASK))
 283
 284 /* Sadly there are some parts of the core that have pointers to already-freed
 285    SV heads, and rely on being able to tell that they are now free. So mark
 286    them all by using a consistent macro.  */
 287 #define SvIS_FREED(sv)  ((sv)->sv_flags == SVTYPEMASK)
 288
 289 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
 290
 291 #define SVf_IOK         0x00000100  /* has valid public integer value */
 292 #define SVf_NOK         0x00000200  /* has valid public numeric value */
 293 #define SVf_POK         0x00000400  /* has valid public pointer value */
 294 #define SVf_ROK         0x00000800  /* has a valid reference pointer */
 295
 296 #define SVp_IOK         0x00001000  /* has valid non-public integer value */
 297 #define SVp_NOK         0x00002000  /* has valid non-public numeric value */
 298 #define SVp_POK         0x00004000  /* has valid non-public pointer value */
 299 #define SVp_SCREAM      0x00008000  /* has been studied? */
 300 #define SVphv_CLONEABLE SVp_SCREAM  /* PVHV (stashes) clone its objects */
 301 #define SVpgv_GP        SVp_SCREAM  /* GV has a valid GP */
 302 #define SVprv_PCS_IMPORTED  SVp_SCREAM  /* RV is a proxy for a constant
 303                                        subroutine in another package. Set the
 304                                        CvIMPORTED_CV_ON() if it needs to be
 305                                        expanded to a real GV */
 306
 307 #define SVs_PADSTALE    0x00010000  /* lexical has gone out of scope */
 308 #define SVpad_STATE     0x00010000  /* pad name is a "state" var */
 309 #define SVs_PADTMP      0x00020000  /* in use as tmp */
 310 #define SVpad_TYPED     0x00020000  /* pad name is a Typed Lexical */
 311 #define SVs_PADMY       0x00040000  /* in use a "my" variable */
 312 #define SVpad_OUR       0x00040000  /* pad name is "our" instead of "my" */
 313 #define SVs_TEMP        0x00080000  /* string is stealable? */
 314 #define SVs_OBJECT      0x00100000  /* is "blessed" */
 315 #define SVs_GMG         0x00200000  /* has magical get method */
 316 #define SVs_SMG         0x00400000  /* has magical set method */
 317 #define SVs_RMG         0x00800000  /* has random magical methods */
 318
 319 #define SVf_FAKE        0x01000000  /* 0: glob or lexical is just a copy
 320                                        1: SV head arena wasn't malloc()ed
 321                                        2: in conjunction with SVf_READONLY
 322                                           marks a shared hash key scalar
 323                                           (SvLEN == 0) or a copy on write
 324                                           string (SvLEN != 0) [SvIsCOW(sv)]
 325                                        3: For PVCV, whether CvUNIQUE(cv)
 326                                           refers to an eval or once only
 327                                           [CvEVAL(cv), CvSPECIAL(cv)]
 328                                        4: On a pad name SV, that slot in the
 329                                           frame AV is a REFCNT'ed reference
 330                                           to a lexical from "outside". */
 331 #define SVphv_REHASH    SVf_FAKE    /* 5: On a PVHV, hash values are being
 332                                           recalculated */
 333 #define SVf_OOK         0x02000000  /* has valid offset value. For a PVHV this
 334                                        means that a hv_aux struct is present
 335                                        after the main array */
 336 #define SVf_BREAK       0x04000000  /* refcnt is artificially low - used by
 337                                        SVs in final arena cleanup.
 338                                        Set in S_regtry on PL_reg_curpm, so that
 339                                        perl_destruct will skip it. */
 340 #define SVf_READONLY    0x08000000  /* may not be modified */
 341
 342
 343
 344
 345 #define SVf_THINKFIRST  (SVf_READONLY|SVf_ROK|SVf_FAKE)
 346
 347 #define SVf_OK          (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
 348                          SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
 349
 350 #define PRIVSHIFT 4     /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
 351
 352 #define SVf_AMAGIC      0x10000000  /* has magical overloaded methods */
 353
 354 /* Ensure this value does not clash with the GV_ADD* flags in gv.h: */
 355 #define SVf_UTF8        0x20000000  /* SvPV is UTF-8 encoded
 356                                        This is also set on RVs whose overloaded
 357                                        stringification is UTF-8. This might
 358                                        only happen as a side effect of SvPV() */
 359
 360
 361 /* Some private flags. */
 362
 363 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
 364    be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
 365    been restructured, so sometimes get used as string buffers.  */
 366
 367 /* PVHV */
 368 #define SVphv_SHAREKEYS 0x20000000  /* PVHV keys live on shared string table */
 369 /* PVNV, PVMG, presumably only inside pads */
 370 #define SVpad_NAME      0x40000000  /* This SV is a name in the PAD, so
 371                                        SVpad_TYPED, SVpad_OUR and SVpad_STATE
 372                                        apply */
 373 /* PVAV */
 374 #define SVpav_REAL      0x40000000  /* free old entries */
 375 /* PVHV */
 376 #define SVphv_LAZYDEL   0x40000000  /* entry in xhv_eiter must be deleted */
 377 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
 378    on any regular scalar (anything <= PVLV) */
 379 #define SVpbm_VALID     0x40000000
 380 /* ??? */
 381 #define SVrepl_EVAL     0x40000000  /* Replacement part of s///e */
 382
 383 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV  */
 384 /* Presumably IVs aren't stored in pads */
 385 #define SVf_IVisUV      0x80000000  /* use XPVUV instead of XPVIV */
 386 /* PVAV */
 387 #define SVpav_REIFY     0x80000000  /* can become real */
 388 /* PVHV */
 389 #define SVphv_HASKFLAGS 0x80000000  /* keys have flag byte after hash */
 390 /* PVFM */
 391 #define SVpfm_COMPILED  0x80000000  /* FORMLINE is compiled */
 392 /* PVGV when SVpbm_VALID is true */
 393 #define SVpbm_TAIL      0x80000000
 394 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive  */
 395 #define SVprv_WEAKREF   0x80000000  /* Weak reference */
 396
 397 #define _XPV_HEAD                                                       \
 398     HV*         xmg_stash;      /* class package */                     \
 399     union _xmgu xmg_u;                                                  \
 400     STRLEN      xpv_cur;        /* length of svu_pv as a C string */    \
 401     STRLEN      xpv_len         /* allocated size */
 402
 403 union _xnvu {
 404     NV      xnv_nv;             /* numeric value, if any */
 405     HV *    xgv_stash;
 406     struct {
 407         U32 xlow;
 408         U32 xhigh;
 409     }       xpad_cop_seq;       /* used by pad.c for cop_sequence */
 410     struct {
 411         U32 xbm_previous;       /* how many characters in string before rare? */
 412         U8  xbm_flags;
 413         U8  xbm_rare;           /* rarest character in string */
 414     }       xbm_s;              /* fields from PVBM */
 415 };
 416
 417 union _xivu {
 418     IV      xivu_iv;            /* integer value */
 419     UV      xivu_uv;
 420     I32     xivu_i32;           /* BmUSEFUL */
 421     HEK *   xivu_namehek;       /* xpvlv, xpvgv: GvNAME */
 422 };
 423
 424 union _xmgu {
 425     MAGIC*  xmg_magic;          /* linked list of magicalness */
 426     HV*     xmg_ourstash;       /* Stash for our (when SvPAD_OUR is true) */
 427 };
 428
 429 struct xpv {
 430     _XPV_HEAD;
 431 };
 432
 433 struct xpviv {
 434     _XPV_HEAD;
 435     union _xivu xiv_u;
 436 };
 437
 438 #define xiv_iv xiv_u.xivu_iv
 439
 440 struct xpvuv {
 441     _XPV_HEAD;
 442     union _xivu xuv_u;
 443 };
 444
 445 #define xuv_uv xuv_u.xivu_uv
 446
 447 struct xpvnv {
 448     _XPV_HEAD;
 449     union _xivu xiv_u;
 450     union _xnvu xnv_u;
 451 };
 452
 453 /* This structure must match the beginning of struct xpvhv in hv.h. */
 454 struct xpvmg {
 455     _XPV_HEAD;
 456     union _xivu xiv_u;
 457     union _xnvu xnv_u;
 458 };
 459
 460 struct xpvlv {
 461     _XPV_HEAD;
 462     union _xivu xiv_u;
 463     union _xnvu xnv_u;
 464     STRLEN      xlv_targoff;
 465     STRLEN      xlv_targlen;
 466     SV*         xlv_targ;
 467     char        xlv_type;       /* k=keys .=pos x=substr v=vec /=join/re
 468                                  * y=alem/helem/iter t=tie T=tied HE */
 469 };
 470
 471 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
 472    Boyer-Moore.  */
 473 struct xpvgv {
 474     _XPV_HEAD;
 475     union _xivu xiv_u;
 476     union _xnvu xnv_u;
 477 };
 478
 479 /* This structure must match XPVCV in cv.h */
 480
 481 typedef U16 cv_flags_t;
 482
 483 #define _XPVCV_COMMON                                                           \
 484     HV *        xcv_stash;                                                      \
 485     union {                                                                     \
 486         OP *    xcv_start;                                                      \
 487         ANY     xcv_xsubany;                                                    \
 488     }           xcv_start_u;                                                    \
 489     union {                                                                     \
 490         OP *    xcv_root;                                                       \
 491         void    (*xcv_xsub) (pTHX_ CV*);                                        \
 492     }           xcv_root_u;                                                     \
 493     GV *        xcv_gv;                                                         \
 494     char *      xcv_file;                                                       \
 495     AV *        xcv_padlist;                                                    \
 496     CV *        xcv_outside;                                                    \
 497     U32         xcv_outside_seq; /* the COP sequence (at the point of our       \
 498                                   * compilation) in the lexically enclosing     \
 499                                   * sub */                                      \
 500     cv_flags_t  xcv_flags
 501
 502 struct xpvfm {
 503     _XPV_HEAD;
 504     _XPVCV_COMMON;
 505     IV          xfm_lines;
 506 };
 507
 508 #define _XPVIO_TAIL                                                     \
 509     PerlIO *    xio_ifp;        /* ifp and ofp are normally the same */ \
 510     PerlIO *    xio_ofp;        /* but sockets need separate streams */ \
 511     /* Cray addresses everything by word boundaries (64 bits) and       \
 512      * code and data pointers cannot be mixed (which is exactly what    \
 513      * Perl_filter_add() tries to do with the dirp), hence the          \
 514      *  following union trick (as suggested by Gurusamy Sarathy).       \
 515      * For further information see Geir Johansen's problem report       \
 516      * titled [ID 20000612.002] Perl problem on Cray system             \
 517      * The any pointer (known as IoANY()) will also be a good place     \
 518      * to hang any IO disciplines to.                                   \
 519      */                                                                 \
 520     union {                                                             \
 521         DIR *   xiou_dirp;      /* for opendir, readdir, etc */         \
 522         void *  xiou_any;       /* for alignment */                     \
 523     } xio_dirpu;                                                        \
 524     /* IV xio_lines is now in IVX  $. */                                \
 525     IV          xio_page;       /* $% */                                \
 526     IV          xio_page_len;   /* $= */                                \
 527     IV          xio_lines_left; /* $- */                                \
 528     char *      xio_top_name;   /* $^ */                                \
 529     GV *        xio_top_gv;     /* $^ */                                \
 530     char *      xio_fmt_name;   /* $~ */                                \
 531     GV *        xio_fmt_gv;     /* $~ */                                \
 532     char *      xio_bottom_name;/* $^B */                               \
 533     GV *        xio_bottom_gv;  /* $^B */                               \
 534     char        xio_type;                                               \
 535     U8          xio_flags
 536
 537
 538 struct xpvio {
 539     _XPV_HEAD;
 540     union _xivu xiv_u;
 541     _XPVIO_TAIL;
 542 };
 543
 544 #define xio_dirp        xio_dirpu.xiou_dirp
 545 #define xio_any         xio_dirpu.xiou_any
 546
 547 #define IOf_ARGV        1       /* this fp iterates over ARGV */
 548 #define IOf_START       2       /* check for null ARGV and substitute '-' */
 549 #define IOf_FLUSH       4       /* this fp wants a flush after write op */
 550 #define IOf_DIDTOP      8       /* just did top of form */
 551 #define IOf_UNTAINT     16      /* consider this fp (and its data) "safe" */
 552 #define IOf_NOLINE      32      /* slurped a pseudo-line from empty file */
 553 #define IOf_FAKE_DIRP   64      /* xio_dirp is fake (source filters kludge) */
 554
 555 /* The following macros define implementation-independent predicates on SVs. */
 556
 557 /*
 558 =for apidoc Am|U32|SvNIOK|SV* sv
 559 Returns a U32 value indicating whether the SV contains a number, integer or
 560 double.
 561
 562 =for apidoc Am|U32|SvNIOKp|SV* sv
 563 Returns a U32 value indicating whether the SV contains a number, integer or
 564 double.  Checks the B<private> setting.  Use C<SvNIOK> instead.
 565
 566 =for apidoc Am|void|SvNIOK_off|SV* sv
 567 Unsets the NV/IV status of an SV.
 568
 569 =for apidoc Am|U32|SvOK|SV* sv
 570 Returns a U32 value indicating whether the value is defined. This is
 571 only meaningful for scalars.
 572
 573 =for apidoc Am|U32|SvIOKp|SV* sv
 574 Returns a U32 value indicating whether the SV contains an integer.  Checks
 575 the B<private> setting.  Use C<SvIOK> instead.
 576
 577 =for apidoc Am|U32|SvNOKp|SV* sv
 578 Returns a U32 value indicating whether the SV contains a double.  Checks the
 579 B<private> setting.  Use C<SvNOK> instead.
 580
 581 =for apidoc Am|U32|SvPOKp|SV* sv
 582 Returns a U32 value indicating whether the SV contains a character string.
 583 Checks the B<private> setting.  Use C<SvPOK> instead.
 584
 585 =for apidoc Am|U32|SvIOK|SV* sv
 586 Returns a U32 value indicating whether the SV contains an integer.
 587
 588 =for apidoc Am|void|SvIOK_on|SV* sv
 589 Tells an SV that it is an integer.
 590
 591 =for apidoc Am|void|SvIOK_off|SV* sv
 592 Unsets the IV status of an SV.
 593
 594 =for apidoc Am|void|SvIOK_only|SV* sv
 595 Tells an SV that it is an integer and disables all other OK bits.
 596
 597 =for apidoc Am|void|SvIOK_only_UV|SV* sv
 598 Tells and SV that it is an unsigned integer and disables all other OK bits.
 599
 600 =for apidoc Am|bool|SvIOK_UV|SV* sv
 601 Returns a boolean indicating whether the SV contains an unsigned integer.
 602
 603 =for apidoc Am|bool|SvUOK|SV* sv
 604 Returns a boolean indicating whether the SV contains an unsigned integer.
 605
 606 =for apidoc Am|bool|SvIOK_notUV|SV* sv
 607 Returns a boolean indicating whether the SV contains a signed integer.
 608
 609 =for apidoc Am|U32|SvNOK|SV* sv
 610 Returns a U32 value indicating whether the SV contains a double.
 611
 612 =for apidoc Am|void|SvNOK_on|SV* sv
 613 Tells an SV that it is a double.
 614
 615 =for apidoc Am|void|SvNOK_off|SV* sv
 616 Unsets the NV status of an SV.
 617
 618 =for apidoc Am|void|SvNOK_only|SV* sv
 619 Tells an SV that it is a double and disables all other OK bits.
 620
 621 =for apidoc Am|U32|SvPOK|SV* sv
 622 Returns a U32 value indicating whether the SV contains a character
 623 string.
 624
 625 =for apidoc Am|void|SvPOK_on|SV* sv
 626 Tells an SV that it is a string.
 627
 628 =for apidoc Am|void|SvPOK_off|SV* sv
 629 Unsets the PV status of an SV.
 630
 631 =for apidoc Am|void|SvPOK_only|SV* sv
 632 Tells an SV that it is a string and disables all other OK bits.
 633 Will also turn off the UTF-8 status.
 634
 635 =for apidoc Am|bool|SvVOK|SV* sv
 636 Returns a boolean indicating whether the SV contains a v-string.
 637
 638 =for apidoc Am|U32|SvOOK|SV* sv
 639 Returns a U32 indicating whether the pointer to the string buffer is offset.
 640 This hack is used internally to speed up removal of characters from the
 641 beginning of a SvPV.  When SvOOK is true, then the start of the
 642 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
 643 This offset used to be stored in SvIVX, but is now stored within the spare
 644 part of the buffer.
 645
 646 =for apidoc Am|U32|SvROK|SV* sv
 647 Tests if the SV is an RV.
 648
 649 =for apidoc Am|void|SvROK_on|SV* sv
 650 Tells an SV that it is an RV.
 651
 652 =for apidoc Am|void|SvROK_off|SV* sv
 653 Unsets the RV status of an SV.
 654
 655 =for apidoc Am|SV*|SvRV|SV* sv
 656 Dereferences an RV to return the SV.
 657
 658 =for apidoc Am|IV|SvIVX|SV* sv
 659 Returns the raw value in the SV's IV slot, without checks or conversions.
 660 Only use when you are sure SvIOK is true. See also C<SvIV()>.
 661
 662 =for apidoc Am|UV|SvUVX|SV* sv
 663 Returns the raw value in the SV's UV slot, without checks or conversions.
 664 Only use when you are sure SvIOK is true. See also C<SvUV()>.
 665
 666 =for apidoc Am|NV|SvNVX|SV* sv
 667 Returns the raw value in the SV's NV slot, without checks or conversions.
 668 Only use when you are sure SvNOK is true. See also C<SvNV()>.
 669
 670 =for apidoc Am|char*|SvPVX|SV* sv
 671 Returns a pointer to the physical string in the SV.  The SV must contain a
 672 string.
 673
 674 =for apidoc Am|STRLEN|SvCUR|SV* sv
 675 Returns the length of the string which is in the SV.  See C<SvLEN>.
 676
 677 =for apidoc Am|STRLEN|SvLEN|SV* sv
 678 Returns the size of the string buffer in the SV, not including any part
 679 attributable to C<SvOOK>.  See C<SvCUR>.
 680
 681 =for apidoc Am|char*|SvEND|SV* sv
 682 Returns a pointer to the last character in the string which is in the SV.
 683 See C<SvCUR>.  Access the character as *(SvEND(sv)).
 684
 685 =for apidoc Am|HV*|SvSTASH|SV* sv
 686 Returns the stash of the SV.
 687
 688 =for apidoc Am|void|SvIV_set|SV* sv|IV val
 689 Set the value of the IV pointer in sv to val.  It is possible to perform
 690 the same function of this macro with an lvalue assignment to C<SvIVX>.
 691 With future Perls, however, it will be more efficient to use
 692 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
 693
 694 =for apidoc Am|void|SvNV_set|SV* sv|NV val
 695 Set the value of the NV pointer in sv to val.  See C<SvIV_set>.
 696
 697 =for apidoc Am|void|SvPV_set|SV* sv|char* val
 698 Set the value of the PV pointer in sv to val.  See C<SvIV_set>.
 699
 700 =for apidoc Am|void|SvUV_set|SV* sv|UV val
 701 Set the value of the UV pointer in sv to val.  See C<SvIV_set>.
 702
 703 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
 704 Set the value of the RV pointer in sv to val.  See C<SvIV_set>.
 705
 706 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
 707 Set the value of the MAGIC pointer in sv to val.  See C<SvIV_set>.
 708
 709 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
 710 Set the value of the STASH pointer in sv to val.  See C<SvIV_set>.
 711
 712 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
 713 Set the current length of the string which is in the SV.  See C<SvCUR>
 714 and C<SvIV_set>.
 715
 716 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
 717 Set the actual length of the string which is in the SV.  See C<SvIV_set>.
 718
 719 =cut
 720 */
 721
 722 #define SvNIOK(sv)              (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
 723 #define SvNIOKp(sv)             (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
 724 #define SvNIOK_off(sv)          (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
 725                                                   SVp_IOK|SVp_NOK|SVf_IVisUV))
 726
 727 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 728 #define assert_not_ROK(sv)      ({assert(!SvROK(sv) || !SvRV(sv));}),
 729 #define assert_not_glob(sv)     ({assert(!isGV_with_GP(sv));}),
 730 #else
 731 #define assert_not_ROK(sv)
 732 #define assert_not_glob(sv)
 733 #endif
 734
 735 #define SvOK(sv)                ((SvTYPE(sv) == SVt_BIND)               \
 736                                  ? (SvFLAGS(SvRV(sv)) & SVf_OK)         \
 737                                  : (SvFLAGS(sv) & SVf_OK))
 738 #define SvOK_off(sv)            (assert_not_ROK(sv) assert_not_glob(sv) \
 739                                  SvFLAGS(sv) &= ~(SVf_OK|               \
 740                                                   SVf_IVisUV|SVf_UTF8), \
 741                                                         SvOOK_off(sv))
 742 #define SvOK_off_exc_UV(sv)     (assert_not_ROK(sv)                     \
 743                                  SvFLAGS(sv) &= ~(SVf_OK|               \
 744                                                   SVf_UTF8),            \
 745                                                         SvOOK_off(sv))
 746
 747 #define SvOKp(sv)               (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
 748 #define SvIOKp(sv)              (SvFLAGS(sv) & SVp_IOK)
 749 #define SvIOKp_on(sv)           (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
 750                                     SvFLAGS(sv) |= SVp_IOK)
 751 #define SvNOKp(sv)              (SvFLAGS(sv) & SVp_NOK)
 752 #define SvNOKp_on(sv)           (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
 753 #define SvPOKp(sv)              (SvFLAGS(sv) & SVp_POK)
 754 #define SvPOKp_on(sv)           (assert_not_ROK(sv) assert_not_glob(sv) \
 755                                  SvFLAGS(sv) |= SVp_POK)
 756
 757 #define SvIOK(sv)               (SvFLAGS(sv) & SVf_IOK)
 758 #define SvIOK_on(sv)            (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
 759                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
 760 #define SvIOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
 761 #define SvIOK_only(sv)          (SvOK_off(sv), \
 762                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
 763 #define SvIOK_only_UV(sv)       (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
 764                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
 765
 766 #define SvIOK_UV(sv)            ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
 767                                  == (SVf_IOK|SVf_IVisUV))
 768 #define SvUOK(sv)               SvIOK_UV(sv)
 769 #define SvIOK_notUV(sv)         ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
 770                                  == SVf_IOK)
 771
 772 #define SvIsUV(sv)              (SvFLAGS(sv) & SVf_IVisUV)
 773 #define SvIsUV_on(sv)           (SvFLAGS(sv) |= SVf_IVisUV)
 774 #define SvIsUV_off(sv)          (SvFLAGS(sv) &= ~SVf_IVisUV)
 775
 776 #define SvNOK(sv)               (SvFLAGS(sv) & SVf_NOK)
 777 #define SvNOK_on(sv)            (assert_not_glob(sv) \
 778                                  SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
 779 #define SvNOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
 780 #define SvNOK_only(sv)          (SvOK_off(sv), \
 781                                     SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
 782
 783 /*
 784 =for apidoc Am|U32|SvUTF8|SV* sv
 785 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
 786 Call this after SvPV() in case any call to string overloading updates the
 787 internal flag.
 788
 789 =for apidoc Am|void|SvUTF8_on|SV *sv
 790 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
 791 Do not use frivolously.
 792
 793 =for apidoc Am|void|SvUTF8_off|SV *sv
 794 Unsets the UTF-8 status of an SV.
 795
 796 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
 797 Tells an SV that it is a string and disables all other OK bits,
 798 and leaves the UTF-8 status as it was.
 799
 800 =cut
 801  */
 802
 803 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
 804 in gv.h: */
 805 #define SvUTF8(sv)              (SvFLAGS(sv) & SVf_UTF8)
 806 #define SvUTF8_on(sv)           (SvFLAGS(sv) |= (SVf_UTF8))
 807 #define SvUTF8_off(sv)          (SvFLAGS(sv) &= ~(SVf_UTF8))
 808
 809 #define SvPOK(sv)               (SvFLAGS(sv) & SVf_POK)
 810 #define SvPOK_on(sv)            (assert_not_ROK(sv) assert_not_glob(sv) \
 811                                  SvFLAGS(sv) |= (SVf_POK|SVp_POK))
 812 #define SvPOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
 813 #define SvPOK_only(sv)          (assert_not_ROK(sv) assert_not_glob(sv) \
 814                                  SvFLAGS(sv) &= ~(SVf_OK|               \
 815                                                   SVf_IVisUV|SVf_UTF8), \
 816                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
 817 #define SvPOK_only_UTF8(sv)     (assert_not_ROK(sv) assert_not_glob(sv) \
 818                                  SvFLAGS(sv) &= ~(SVf_OK|               \
 819                                                   SVf_IVisUV),          \
 820                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
 821
 822 #define SvVOK(sv)               (SvMAGICAL(sv)                          \
 823                                  && mg_find(sv,PERL_MAGIC_vstring))
 824 /* returns the vstring magic, if any */
 825 #define SvVSTRING_mg(sv)        (SvMAGICAL(sv) \
 826                                  ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
 827
 828 #define SvOOK(sv)               (SvFLAGS(sv) & SVf_OOK)
 829 #define SvOOK_on(sv)            ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
 830 #define SvOOK_off(sv)           ((void)(SvOOK(sv) && sv_backoff(sv)))
 831
 832 #define SvFAKE(sv)              (SvFLAGS(sv) & SVf_FAKE)
 833 #define SvFAKE_on(sv)           (SvFLAGS(sv) |= SVf_FAKE)
 834 #define SvFAKE_off(sv)          (SvFLAGS(sv) &= ~SVf_FAKE)
 835
 836 #define SvROK(sv)               (SvFLAGS(sv) & SVf_ROK)
 837 #define SvROK_on(sv)            (SvFLAGS(sv) |= SVf_ROK)
 838 #define SvROK_off(sv)           (SvFLAGS(sv) &= ~(SVf_ROK))
 839
 840 #define SvMAGICAL(sv)           (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
 841 #define SvMAGICAL_on(sv)        (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
 842 #define SvMAGICAL_off(sv)       (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
 843
 844 #define SvGMAGICAL(sv)          (SvFLAGS(sv) & SVs_GMG)
 845 #define SvGMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_GMG)
 846 #define SvGMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_GMG)
 847
 848 #define SvSMAGICAL(sv)          (SvFLAGS(sv) & SVs_SMG)
 849 #define SvSMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_SMG)
 850 #define SvSMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_SMG)
 851
 852 #define SvRMAGICAL(sv)          (SvFLAGS(sv) & SVs_RMG)
 853 #define SvRMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_RMG)
 854 #define SvRMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_RMG)
 855
 856 #define SvAMAGIC(sv)            (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
 857 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 858 #  define SvAMAGIC_on(sv)       ({ SV * const kloink = sv;              \
 859                                    assert(SvROK(kloink));               \
 860                                    SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
 861                                 })
 862 #  define SvAMAGIC_off(sv)      ({ SV * const kloink = sv;              \
 863                                    if(SvROK(kloink))                    \
 864                                         SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
 865                                 })
 866 #else
 867 #  define SvAMAGIC_on(sv)       (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
 868 #  define SvAMAGIC_off(sv) \
 869         (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
 870 #endif
 871
 872 /*
 873 =for apidoc Am|U32|SvGAMAGIC|SV* sv
 874
 875 Returns true if the SV has get magic or overloading. If either is true then
 876 the scalar is active data, and has the potential to return a new value every
 877 time it is accessed. Hence you must be careful to only read it once per user
 878 logical operation and work with that returned value. If neither is true then
 879 the scalar's value cannot change unless written to.
 880
 881 =cut
 882 */
 883
 884 #define SvGAMAGIC(sv)           (SvGMAGICAL(sv) || SvAMAGIC(sv))
 885
 886 #define Gv_AMG(stash)           (PL_amagic_generation && Gv_AMupdate(stash, FALSE))
 887
 888 #define SvWEAKREF(sv)           ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
 889                                   == (SVf_ROK|SVprv_WEAKREF))
 890 #define SvWEAKREF_on(sv)        (SvFLAGS(sv) |=  (SVf_ROK|SVprv_WEAKREF))
 891 #define SvWEAKREF_off(sv)       (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
 892
 893 #define SvPCS_IMPORTED(sv)      ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
 894                                  == (SVf_ROK|SVprv_PCS_IMPORTED))
 895 #define SvPCS_IMPORTED_on(sv)   (SvFLAGS(sv) |=  (SVf_ROK|SVprv_PCS_IMPORTED))
 896 #define SvPCS_IMPORTED_off(sv)  (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
 897
 898 #define SvTHINKFIRST(sv)        (SvFLAGS(sv) & SVf_THINKFIRST)
 899
 900 #define SvPADSTALE(sv)          (SvFLAGS(sv) & SVs_PADSTALE)
 901 #define SvPADSTALE_on(sv)       (SvFLAGS(sv) |= SVs_PADSTALE)
 902 #define SvPADSTALE_off(sv)      (SvFLAGS(sv) &= ~SVs_PADSTALE)
 903
 904 #define SvPADTMP(sv)            (SvFLAGS(sv) & SVs_PADTMP)
 905 #define SvPADTMP_on(sv)         (SvFLAGS(sv) |= SVs_PADTMP)
 906 #define SvPADTMP_off(sv)        (SvFLAGS(sv) &= ~SVs_PADTMP)
 907
 908 #define SvPADMY(sv)             (SvFLAGS(sv) & SVs_PADMY)
 909 #define SvPADMY_on(sv)          (SvFLAGS(sv) |= SVs_PADMY)
 910
 911 #define SvTEMP(sv)              (SvFLAGS(sv) & SVs_TEMP)
 912 #define SvTEMP_on(sv)           (SvFLAGS(sv) |= SVs_TEMP)
 913 #define SvTEMP_off(sv)          (SvFLAGS(sv) &= ~SVs_TEMP)
 914
 915 #define SvOBJECT(sv)            (SvFLAGS(sv) & SVs_OBJECT)
 916 #define SvOBJECT_on(sv)         (SvFLAGS(sv) |= SVs_OBJECT)
 917 #define SvOBJECT_off(sv)        (SvFLAGS(sv) &= ~SVs_OBJECT)
 918
 919 #define SvREADONLY(sv)          (SvFLAGS(sv) & SVf_READONLY)
 920 #define SvREADONLY_on(sv)       (SvFLAGS(sv) |= SVf_READONLY)
 921 #define SvREADONLY_off(sv)      (SvFLAGS(sv) &= ~SVf_READONLY)
 922
 923 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
 924 #define SvSCREAM_on(sv)         (SvFLAGS(sv) |= SVp_SCREAM)
 925 #define SvSCREAM_off(sv)        (SvFLAGS(sv) &= ~SVp_SCREAM)
 926
 927 #define SvCOMPILED(sv)          (SvFLAGS(sv) & SVpfm_COMPILED)
 928 #define SvCOMPILED_on(sv)       (SvFLAGS(sv) |= SVpfm_COMPILED)
 929 #define SvCOMPILED_off(sv)      (SvFLAGS(sv) &= ~SVpfm_COMPILED)
 930
 931 #define SvEVALED(sv)            (SvFLAGS(sv) & SVrepl_EVAL)
 932 #define SvEVALED_on(sv)         (SvFLAGS(sv) |= SVrepl_EVAL)
 933 #define SvEVALED_off(sv)        (SvFLAGS(sv) &= ~SVrepl_EVAL)
 934
 935 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 936 #  define SvVALID(sv)           ({ const SV *const _svvalid = (const SV*)(sv); \
 937                                    if (SvFLAGS(_svvalid) & SVpbm_VALID) \
 938                                        assert(!isGV_with_GP(_svvalid)); \
 939                                    (SvFLAGS(_svvalid) & SVpbm_VALID);   \
 940                                 })
 941 #  define SvVALID_on(sv)        ({ SV *const _svvalid = MUTABLE_SV(sv); \
 942                                    assert(!isGV_with_GP(_svvalid));     \
 943                                    (SvFLAGS(_svvalid) |= SVpbm_VALID);  \
 944                                 })
 945 #  define SvVALID_off(sv)       ({ SV *const _svvalid = MUTABLE_SV(sv); \
 946                                    assert(!isGV_with_GP(_svvalid));     \
 947                                    (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
 948                                 })
 949
 950 #  define SvTAIL(sv)    ({ const SV *const _svtail = (const SV *)(sv);  \
 951                             assert(SvTYPE(_svtail) != SVt_PVAV);                \
 952                             assert(SvTYPE(_svtail) != SVt_PVHV);                \
 953                             (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID))    \
 954                                 == (SVpbm_TAIL|SVpbm_VALID);            \
 955                         })
 956 #else
 957 #  define SvVALID(sv)           (SvFLAGS(sv) & SVpbm_VALID)
 958 #  define SvVALID_on(sv)        (SvFLAGS(sv) |= SVpbm_VALID)
 959 #  define SvVALID_off(sv)       (SvFLAGS(sv) &= ~SVpbm_VALID)
 960 #  define SvTAIL(sv)        ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID))   \
 961                              == (SVpbm_TAIL|SVpbm_VALID))
 962
 963 #endif
 964 #define SvTAIL_on(sv)           (SvFLAGS(sv) |= SVpbm_TAIL)
 965 #define SvTAIL_off(sv)          (SvFLAGS(sv) &= ~SVpbm_TAIL)
 966
 967
 968 #define SvPAD_TYPED(sv) \
 969         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
 970
 971 #define SvPAD_OUR(sv)   \
 972         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
 973
 974 #define SvPAD_STATE(sv) \
 975         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
 976
 977 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 978 #  define SvPAD_TYPED_on(sv)    ({                                      \
 979             SV *const _svpad = MUTABLE_SV(sv);                          \
 980             assert(SvTYPE(_svpad) == SVt_PVMG);                         \
 981             (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED);                \
 982         })
 983 #define SvPAD_OUR_on(sv)        ({                                      \
 984             SV *const _svpad = MUTABLE_SV(sv);                          \
 985             assert(SvTYPE(_svpad) == SVt_PVMG);                         \
 986             (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR);                  \
 987         })
 988 #define SvPAD_STATE_on(sv)      ({                                      \
 989             SV *const _svpad = MUTABLE_SV(sv);                          \
 990             assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
 991             (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE);                \
 992         })
 993 #else
 994 #  define SvPAD_TYPED_on(sv)    (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
 995 #  define SvPAD_OUR_on(sv)      (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
 996 #  define SvPAD_STATE_on(sv)    (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
 997 #endif
 998
 999 #define SvOURSTASH(sv)  \
1000         (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1001 #define SvOURSTASH_set(sv, st)                                  \
1002         STMT_START {                                            \
1003             assert(SvTYPE(sv) == SVt_PVMG);                     \
1004             ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st;      \
1005         } STMT_END
1006
1007 #ifdef PERL_DEBUG_COW
1008 #else
1009 #endif
1010 #define SvRVx(sv) SvRV(sv)
1011
1012 #ifdef PERL_DEBUG_COW
1013 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1014    +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1015 #  define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1016 #  define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1017 #  define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1018 #  define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1019 #  define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1020 /* Don't test the core XS code yet.  */
1021 #  if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1022 #    define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1023 #  else
1024 #  define SvPVX(sv) SvPVX_mutable(sv)
1025 #  endif
1026 #  define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1027 #  define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1028 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1029
1030 #  ifdef DEBUGGING
1031 #    define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic))
1032 #    define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_stash))
1033 #  else
1034 #    define SvMAGIC(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic)
1035 #    define SvSTASH(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_stash)
1036 #  endif
1037 #else
1038 #  define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1039 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1040
1041 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1042 /* These get expanded inside other macros that already use a variable _sv  */
1043 #    define SvPVX(sv)                                                   \
1044         (*({ SV *const _svpvx = MUTABLE_SV(sv);                         \
1045             assert(SvTYPE(_svpvx) >= SVt_PV);                           \
1046             assert(SvTYPE(_svpvx) != SVt_PVAV);                         \
1047             assert(SvTYPE(_svpvx) != SVt_PVHV);                         \
1048             assert(!isGV_with_GP(_svpvx));                              \
1049             &((_svpvx)->sv_u.svu_pv);                                   \
1050          }))
1051 #    define SvCUR(sv)                                                   \
1052         (*({ const SV *const _svcur = (const SV *)(sv);                 \
1053             assert(SvTYPE(_svcur) >= SVt_PV);                           \
1054             assert(SvTYPE(_svcur) != SVt_PVAV);                         \
1055             assert(SvTYPE(_svcur) != SVt_PVHV);                         \
1056             assert(!isGV_with_GP(_svcur));                              \
1057             &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur);            \
1058          }))
1059 #    define SvIVX(sv)                                                   \
1060         (*({ const SV *const _svivx = (const SV *)(sv);                 \
1061             assert(SvTYPE(_svivx) == SVt_IV || SvTYPE(_svivx) >= SVt_PVIV); \
1062             assert(SvTYPE(_svivx) != SVt_PVAV);                         \
1063             assert(SvTYPE(_svivx) != SVt_PVHV);                         \
1064             assert(SvTYPE(_svivx) != SVt_PVCV);                         \
1065             assert(SvTYPE(_svivx) != SVt_PVFM);                         \
1066             assert(SvTYPE(_svivx) != SVt_PVIO);                         \
1067             assert(SvTYPE(_svivx) != SVt_REGEXP);                       \
1068             assert(!isGV_with_GP(_svivx));                              \
1069             &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv);           \
1070          }))
1071 #    define SvUVX(sv)                                                   \
1072         (*({ const SV *const _svuvx = (const SV *)(sv);                 \
1073             assert(SvTYPE(_svuvx) == SVt_IV || SvTYPE(_svuvx) >= SVt_PVIV); \
1074             assert(SvTYPE(_svuvx) != SVt_PVAV);                         \
1075             assert(SvTYPE(_svuvx) != SVt_PVHV);                         \
1076             assert(SvTYPE(_svuvx) != SVt_PVCV);                         \
1077             assert(SvTYPE(_svuvx) != SVt_PVFM);                         \
1078             assert(SvTYPE(_svuvx) != SVt_PVIO);                         \
1079             assert(SvTYPE(_svuvx) != SVt_REGEXP);                       \
1080             assert(!isGV_with_GP(_svuvx));                              \
1081             &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv);           \
1082          }))
1083 #    define SvNVX(sv)                                                   \
1084         (*({ const SV *const _svnvx = (const SV *)(sv);                 \
1085             assert(SvTYPE(_svnvx) == SVt_NV || SvTYPE(_svnvx) >= SVt_PVNV); \
1086             assert(SvTYPE(_svnvx) != SVt_PVAV);                         \
1087             assert(SvTYPE(_svnvx) != SVt_PVHV);                         \
1088             assert(SvTYPE(_svnvx) != SVt_PVCV);                         \
1089             assert(SvTYPE(_svnvx) != SVt_PVFM);                         \
1090             assert(SvTYPE(_svnvx) != SVt_PVIO);                         \
1091             assert(SvTYPE(_svnvx) != SVt_REGEXP);                       \
1092             assert(!isGV_with_GP(_svnvx));                              \
1093             &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv);     \
1094          }))
1095 #    define SvRV(sv)                                                    \
1096         (*({ SV *const _svrv = MUTABLE_SV(sv);                          \
1097             assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1098             assert(SvTYPE(_svrv) != SVt_PVAV);                          \
1099             assert(SvTYPE(_svrv) != SVt_PVHV);                          \
1100             assert(SvTYPE(_svrv) != SVt_PVCV);                          \
1101             assert(SvTYPE(_svrv) != SVt_PVFM);                          \
1102             assert(!isGV_with_GP(_svrv));                               \
1103             &((_svrv)->sv_u.svu_rv);                                    \
1104          }))
1105 #    define SvRV_const(sv)                                              \
1106         ({ const SV *const _svrv = (const SV *)(sv);                    \
1107             assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1108             assert(SvTYPE(_svrv) != SVt_PVAV);                          \
1109             assert(SvTYPE(_svrv) != SVt_PVHV);                          \
1110             assert(SvTYPE(_svrv) != SVt_PVCV);                          \
1111             assert(SvTYPE(_svrv) != SVt_PVFM);                          \
1112             assert(!isGV_with_GP(_svrv));                               \
1113             (_svrv)->sv_u.svu_rv;                                       \
1114          })
1115 #    define SvMAGIC(sv)                                                 \
1116         (*({ const SV *const _svmagic = (const SV *)(sv);               \
1117             assert(SvTYPE(_svmagic) >= SVt_PVMG);                       \
1118             if(SvTYPE(_svmagic) == SVt_PVMG)                            \
1119                 assert(!SvPAD_OUR(_svmagic));                           \
1120             &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1121           }))
1122 #    define SvSTASH(sv)                                                 \
1123         (*({ const SV *const _svstash = (const SV *)(sv);               \
1124             assert(SvTYPE(_svstash) >= SVt_PVMG);                       \
1125             &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash);      \
1126           }))
1127 #  else
1128 #    define SvPVX(sv) ((sv)->sv_u.svu_pv)
1129 #    define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1130 #    define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1131 #    define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1132 #    define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1133 #    define SvRV(sv) ((sv)->sv_u.svu_rv)
1134 #    define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1135 #    define SvMAGIC(sv) ((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic
1136 #    define SvSTASH(sv) ((XPVMG*)  SvANY(sv))->xmg_stash
1137 #  endif
1138 #endif
1139
1140 #ifndef PERL_POISON
1141 /* Given that these two are new, there can't be any existing code using them
1142  *  as LVALUEs  */
1143 #  define SvPVX_mutable(sv)     (0 + (sv)->sv_u.svu_pv)
1144 #  define SvPVX_const(sv)       ((const char*)(0 + (sv)->sv_u.svu_pv))
1145 #else
1146 /* Except for the poison code, which uses & to scribble over the pointer after
1147    free() is called.  */
1148 #  define SvPVX_mutable(sv)     ((sv)->sv_u.svu_pv)
1149 #  define SvPVX_const(sv)       ((const char*)((sv)->sv_u.svu_pv))
1150 #endif
1151
1152 #define SvIVXx(sv) SvIVX(sv)
1153 #define SvUVXx(sv) SvUVX(sv)
1154 #define SvNVXx(sv) SvNVX(sv)
1155 #define SvPVXx(sv) SvPVX(sv)
1156 #define SvLENx(sv) SvLEN(sv)
1157 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1158
1159
1160 /* Ask a scalar nicely to try to become an IV, if possible.
1161    Not guaranteed to stay returning void */
1162 /* Macro won't actually call sv_2iv if already IOK */
1163 #define SvIV_please(sv) \
1164         STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1165                 (void) SvIV(sv); } STMT_END
1166 #define SvIV_set(sv, val) \
1167         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1168                 assert(SvTYPE(sv) != SVt_PVAV);         \
1169                 assert(SvTYPE(sv) != SVt_PVHV);         \
1170                 assert(SvTYPE(sv) != SVt_PVCV);         \
1171                 assert(!isGV_with_GP(sv));              \
1172                 (((XPVIV*)  SvANY(sv))->xiv_iv = (val)); } STMT_END
1173 #define SvNV_set(sv, val) \
1174         STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1175             assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1176             assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
1177                 assert(SvTYPE(sv) != SVt_PVIO);         \
1178                 assert(!isGV_with_GP(sv));              \
1179                 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1180 #define SvPV_set(sv, val) \
1181         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1182                 assert(SvTYPE(sv) != SVt_PVAV);         \
1183                 assert(SvTYPE(sv) != SVt_PVHV);         \
1184                 assert(!isGV_with_GP(sv));              \
1185                 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1186 #define SvUV_set(sv, val) \
1187         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1188                 assert(SvTYPE(sv) != SVt_PVAV);         \
1189                 assert(SvTYPE(sv) != SVt_PVHV);         \
1190                 assert(SvTYPE(sv) != SVt_PVCV);         \
1191                 assert(!isGV_with_GP(sv));              \
1192                 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1193 #define SvRV_set(sv, val) \
1194         STMT_START { assert(SvTYPE(sv) >=  SVt_PV || SvTYPE(sv) ==  SVt_IV); \
1195                 assert(SvTYPE(sv) != SVt_PVAV);         \
1196                 assert(SvTYPE(sv) != SVt_PVHV);         \
1197                 assert(SvTYPE(sv) != SVt_PVCV);         \
1198                 assert(SvTYPE(sv) != SVt_PVFM);         \
1199                 assert(!isGV_with_GP(sv));              \
1200                 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1201 #define SvMAGIC_set(sv, val) \
1202         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1203                 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1204 #define SvSTASH_set(sv, val) \
1205         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1206                 (((XPVMG*)  SvANY(sv))->xmg_stash = (val)); } STMT_END
1207 #define SvCUR_set(sv, val) \
1208         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1209                 assert(SvTYPE(sv) != SVt_PVAV);         \
1210                 assert(SvTYPE(sv) != SVt_PVHV);         \
1211                 assert(!isGV_with_GP(sv));              \
1212                 (((XPV*)  SvANY(sv))->xpv_cur = (val)); } STMT_END
1213 #define SvLEN_set(sv, val) \
1214         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1215                 assert(SvTYPE(sv) != SVt_PVAV); \
1216                 assert(SvTYPE(sv) != SVt_PVHV); \
1217                 assert(!isGV_with_GP(sv));      \
1218                 (((XPV*)  SvANY(sv))->xpv_len = (val)); } STMT_END
1219 #define SvEND_set(sv, val) \
1220         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1221                 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1222
1223 #define SvPV_renew(sv,n) \
1224         STMT_START { SvLEN_set(sv, n); \
1225                 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char)                 \
1226                                 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1227                                                    (MEM_SIZE)((n)))));  \
1228                  } STMT_END
1229
1230 #define SvPV_shrink_to_cur(sv) STMT_START { \
1231                    const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1232                    SvPV_renew(sv, _lEnGtH); \
1233                  } STMT_END
1234
1235 #define SvPV_free(sv)                                                   \
1236     STMT_START {                                                        \
1237                      assert(SvTYPE(sv) >= SVt_PV);                      \
1238                      if (SvLEN(sv)) {                                   \
1239                          assert(!SvROK(sv));                            \
1240                          if(SvOOK(sv)) {                                \
1241                              STRLEN zok;                                \
1242                              SvOOK_offset(sv, zok);                     \
1243                              SvPV_set(sv, SvPVX_mutable(sv) - zok);     \
1244                              SvFLAGS(sv) &= ~SVf_OOK;                   \
1245                          }                                              \
1246                          Safefree(SvPVX(sv));                           \
1247                      }                                                  \
1248                  } STMT_END
1249
1250 #ifdef PERL_CORE
1251 /* Code that crops up in three places to take a scalar and ready it to hold
1252    a reference */
1253 #  define prepare_SV_for_RV(sv)                                         \
1254     STMT_START {                                                        \
1255                     if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV)    \
1256                         sv_upgrade(sv, SVt_IV);                         \
1257                     else if (SvTYPE(sv) >= SVt_PV) {                    \
1258                         SvPV_free(sv);                                  \
1259                         SvLEN_set(sv, 0);                               \
1260                         SvCUR_set(sv, 0);                               \
1261                     }                                                   \
1262                  } STMT_END
1263 #endif
1264
1265 #define PERL_FBM_TABLE_OFFSET 1 /* Number of bytes between EOS and table */
1266
1267 /* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1268    perl -T -e '/$^X/'
1269 */
1270 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1271 #  define BmFLAGS(sv)                                                   \
1272         (*({ SV *const _bmflags = MUTABLE_SV(sv);                       \
1273                 assert(SvTYPE(_bmflags) == SVt_PVGV);                   \
1274                 assert(SvVALID(_bmflags));                              \
1275             &(((XPVGV*) SvANY(_bmflags))->xnv_u.xbm_s.xbm_flags);       \
1276          }))
1277 #  define BmRARE(sv)                                                    \
1278         (*({ SV *const _bmrare = MUTABLE_SV(sv);                        \
1279                 assert(SvTYPE(_bmrare) == SVt_PVGV);                    \
1280                 assert(SvVALID(_bmrare));                               \
1281             &(((XPVGV*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare);         \
1282          }))
1283 #  define BmUSEFUL(sv)                                                  \
1284         (*({ SV *const _bmuseful = MUTABLE_SV(sv);                      \
1285             assert(SvTYPE(_bmuseful) == SVt_PVGV);                      \
1286             assert(SvVALID(_bmuseful));                                 \
1287             assert(!SvIOK(_bmuseful));                                  \
1288             &(((XPVGV*) SvANY(_bmuseful))->xiv_u.xivu_i32);             \
1289          }))
1290 #  define BmPREVIOUS(sv)                                                \
1291     (*({ SV *const _bmprevious = MUTABLE_SV(sv);                        \
1292                 assert(SvTYPE(_bmprevious) == SVt_PVGV);                \
1293                 assert(SvVALID(_bmprevious));                           \
1294             &(((XPVGV*) SvANY(_bmprevious))->xnv_u.xbm_s.xbm_previous); \
1295          }))
1296 #else
1297 #  define BmFLAGS(sv)           ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_flags
1298 #  define BmRARE(sv)            ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1299 #  define BmUSEFUL(sv)          ((XPVGV*) SvANY(sv))->xiv_u.xivu_i32
1300 #  define BmPREVIOUS(sv)        ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_previous
1301
1302 #endif
1303
1304 #define FmLINES(sv)     ((XPVFM*)  SvANY(sv))->xfm_lines
1305
1306 #define LvTYPE(sv)      ((XPVLV*)  SvANY(sv))->xlv_type
1307 #define LvTARG(sv)      ((XPVLV*)  SvANY(sv))->xlv_targ
1308 #define LvTARGOFF(sv)   ((XPVLV*)  SvANY(sv))->xlv_targoff
1309 #define LvTARGLEN(sv)   ((XPVLV*)  SvANY(sv))->xlv_targlen
1310
1311 #define IoIFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ifp
1312 #define IoOFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ofp
1313 #define IoDIRP(sv)      ((XPVIO*)  SvANY(sv))->xio_dirp
1314 #define IoANY(sv)       ((XPVIO*)  SvANY(sv))->xio_any
1315 #define IoLINES(sv)     ((XPVIO*)  SvANY(sv))->xiv_u.xivu_iv
1316 #define IoPAGE(sv)      ((XPVIO*)  SvANY(sv))->xio_page
1317 #define IoPAGE_LEN(sv)  ((XPVIO*)  SvANY(sv))->xio_page_len
1318 #define IoLINES_LEFT(sv)((XPVIO*)  SvANY(sv))->xio_lines_left
1319 #define IoTOP_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_top_name
1320 #define IoTOP_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_top_gv
1321 #define IoFMT_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_fmt_name
1322 #define IoFMT_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_fmt_gv
1323 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1324 #define IoBOTTOM_GV(sv) ((XPVIO*)  SvANY(sv))->xio_bottom_gv
1325 #define IoTYPE(sv)      ((XPVIO*)  SvANY(sv))->xio_type
1326 #define IoFLAGS(sv)     ((XPVIO*)  SvANY(sv))->xio_flags
1327
1328 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1329 #define IoTYPE_RDONLY           '<'
1330 #define IoTYPE_WRONLY           '>'
1331 #define IoTYPE_RDWR             '+'
1332 #define IoTYPE_APPEND           'a'
1333 #define IoTYPE_PIPE             '|'
1334 #define IoTYPE_STD              '-'     /* stdin or stdout */
1335 #define IoTYPE_SOCKET           's'
1336 #define IoTYPE_CLOSED           ' '
1337 #define IoTYPE_IMPLICIT         'I'     /* stdin or stdout or stderr */
1338 #define IoTYPE_NUMERIC          '#'     /* fdopen */
1339
1340 /*
1341 =for apidoc Am|bool|SvTAINTED|SV* sv
1342 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1343 not.
1344
1345 =for apidoc Am|void|SvTAINTED_on|SV* sv
1346 Marks an SV as tainted if tainting is enabled.
1347
1348 =for apidoc Am|void|SvTAINTED_off|SV* sv
1349 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1350 some of Perl's fundamental security features. XS module authors should not
1351 use this function unless they fully understand all the implications of
1352 unconditionally untainting the value. Untainting should be done in the
1353 standard perl fashion, via a carefully crafted regexp, rather than directly
1354 untainting variables.
1355
1356 =for apidoc Am|void|SvTAINT|SV* sv
1357 Taints an SV if tainting is enabled.
1358
1359 =cut
1360 */
1361
1362 #define sv_taint(sv)      sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1363
1364 #define SvTAINTED(sv)     (SvMAGICAL(sv) && sv_tainted(sv))
1365 #define SvTAINTED_on(sv)  STMT_START{ if(PL_tainting){sv_taint(sv);}   }STMT_END
1366 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1367
1368 #define SvTAINT(sv)                     \
1369     STMT_START {                        \
1370         if (PL_tainting) {              \
1371             if (PL_tainted)             \
1372                 SvTAINTED_on(sv);       \
1373         }                               \
1374     } STMT_END
1375
1376 /*
1377 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1378 Like C<SvPV> but will force the SV into containing just a string
1379 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1380 directly.
1381
1382 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1383 Like C<SvPV> but will force the SV into containing just a string
1384 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1385 directly. Doesn't process magic.
1386
1387 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1388 Returns a pointer to the string in the SV, or a stringified form of
1389 the SV if the SV does not contain a string.  The SV may cache the
1390 stringified version becoming C<SvPOK>.  Handles 'get' magic. See also
1391 C<SvPVx> for a version which guarantees to evaluate sv only once.
1392
1393 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1394 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1395 Only use this if C<sv> is an expression with side effects, otherwise use the
1396 more efficient C<SvPVX>.
1397
1398 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1399 Like C<SvPV> but doesn't process magic.
1400
1401 =for apidoc Am|char*|SvPV_nolen|SV* sv
1402 Returns a pointer to the string in the SV, or a stringified form of
1403 the SV if the SV does not contain a string.  The SV may cache the
1404 stringified form becoming C<SvPOK>.  Handles 'get' magic.
1405
1406 =for apidoc Am|IV|SvIV|SV* sv
1407 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1408 version which guarantees to evaluate sv only once.
1409
1410 =for apidoc Am|IV|SvIV_nomg|SV* sv
1411 Like C<SvIV> but doesn't process magic.
1412
1413 =for apidoc Am|IV|SvIVx|SV* sv
1414 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1415 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1416 otherwise use the more efficient C<SvIV>.
1417
1418 =for apidoc Am|NV|SvNV|SV* sv
1419 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1420 which guarantees to evaluate sv only once.
1421
1422 =for apidoc Am|NV|SvNVx|SV* sv
1423 Coerces the given SV to a double and returns it. Guarantees to evaluate
1424 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1425 otherwise use the more efficient C<SvNV>.
1426
1427 =for apidoc Am|UV|SvUV|SV* sv
1428 Coerces the given SV to an unsigned integer and returns it.  See C<SvUVx>
1429 for a version which guarantees to evaluate sv only once.
1430
1431 =for apidoc Am|UV|SvUV_nomg|SV* sv
1432 Like C<SvUV> but doesn't process magic.
1433
1434 =for apidoc Am|UV|SvUVx|SV* sv
1435 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1436 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1437 otherwise use the more efficient C<SvUV>.
1438
1439 =for apidoc Am|bool|SvTRUE|SV* sv
1440 Returns a boolean indicating whether Perl would evaluate the SV as true or
1441 false.  See SvOK() for a defined/undefined test.  Does not handle 'get' magic.
1442
1443 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1444 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1445
1446 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1447 Like C<SvPV>, but converts sv to utf8 first if necessary.
1448
1449 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1450 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1451
1452 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1453 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1454
1455 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1456 Like C<SvPV>, but converts sv to byte representation first if necessary.
1457
1458 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1459 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1460
1461 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1462 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1463 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1464 otherwise.
1465
1466 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1467 Like C<SvPV>, but converts sv to utf8 first if necessary.
1468 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1469 otherwise.
1470
1471 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1472 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1473 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1474 otherwise.
1475
1476 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1477 Like C<SvPV>, but converts sv to byte representation first if necessary.
1478 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1479 otherwise.
1480
1481 =for apidoc Am|bool|SvIsCOW|SV* sv
1482 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1483 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1484 COW)
1485
1486 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1487 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1488 scalar.
1489
1490 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1491 Like C<sv_catpvn> but doesn't process magic.
1492
1493 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1494 Like C<sv_setsv> but doesn't process magic.
1495
1496 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1497 Like C<sv_catsv> but doesn't process magic.
1498
1499 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1500
1501 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
1502
1503 =cut
1504 */
1505
1506 /* Let us hope that bitmaps for UV and IV are the same */
1507 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1508 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1509 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1510
1511 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1512 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1513
1514 /* ----*/
1515
1516 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1517 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1518 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1519
1520 #define SvPV_flags(sv, lp, flags) \
1521     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1522      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1523 #define SvPV_flags_const(sv, lp, flags) \
1524     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1525      ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1526      (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1527 #define SvPV_flags_const_nolen(sv, flags) \
1528     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1529      ? SvPVX_const(sv) : \
1530      (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1531 #define SvPV_flags_mutable(sv, lp, flags) \
1532     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1533      ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1534      sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1535
1536 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1537 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1538 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1539
1540 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1541 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1542
1543 #define SvPV_force_flags(sv, lp, flags) \
1544     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1545     ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1546 #define SvPV_force_flags_nolen(sv, flags) \
1547     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1548     ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1549 #define SvPV_force_flags_mutable(sv, lp, flags) \
1550     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1551     ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1552      : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1553
1554 #define SvPV_nolen(sv) \
1555     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1556      ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1557
1558 #define SvPV_nolen_const(sv) \
1559     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1560      ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1561
1562 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1563 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1564 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1565
1566 /* ----*/
1567
1568 #define SvPVutf8(sv, lp) \
1569     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1570      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1571
1572 #define SvPVutf8_force(sv, lp) \
1573     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1574      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1575
1576
1577 #define SvPVutf8_nolen(sv) \
1578     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1579      ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1580
1581 /* ----*/
1582
1583 #define SvPVbyte(sv, lp) \
1584     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1585      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1586
1587 #define SvPVbyte_force(sv, lp) \
1588     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1589      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1590
1591 #define SvPVbyte_nolen(sv) \
1592     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1593      ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1594
1595
1596
1597 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1598  * var to evaluate the arg once; failing that, use a global if possible;
1599  * failing that, call a function to do the work
1600  */
1601
1602 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1603 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1604 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1605
1606 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1607
1608 #  define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1609 #  define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1610 #  define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1611 #  define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1612 #  define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1613 #  define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1614 #  define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1615 #  define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1616 #  define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1617 #  define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1618 #  define SvTRUE(sv) (                                          \
1619     !sv                                                         \
1620     ? 0                                                         \
1621     :    SvPOK(sv)                                              \
1622         ?   (({XPV *nxpv = (XPV*)SvANY(sv);                     \
1623              nxpv &&                                            \
1624              (nxpv->xpv_cur > 1 ||                              \
1625               (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1626              ? 1                                                \
1627              : 0)                                               \
1628         :                                                       \
1629             SvIOK(sv)                                           \
1630             ? SvIVX(sv) != 0                                    \
1631             :   SvNOK(sv)                                       \
1632                 ? SvNVX(sv) != 0.0                              \
1633                 : sv_2bool(sv) )
1634 #  define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1635
1636 #else /* __GNUC__ */
1637
1638 /* These inlined macros use globals, which will require a thread
1639  * declaration in user code, so we avoid them under threads */
1640
1641 #  define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1642 #  define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1643 #  define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1644 #  define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1645 #  define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1646 #  define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1647 #  define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1648 #  define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1649 #  define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1650 #  define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1651 #  define SvTRUE(sv) (                                          \
1652     !sv                                                         \
1653     ? 0                                                         \
1654     :    SvPOK(sv)                                              \
1655         ?   ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) &&            \
1656              (PL_Xpv->xpv_cur > 1 ||                            \
1657               (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0'))  \
1658              ? 1                                                \
1659              : 0)                                               \
1660         :                                                       \
1661             SvIOK(sv)                                           \
1662             ? SvIVX(sv) != 0                                    \
1663             :   SvNOK(sv)                                       \
1664                 ? SvNVX(sv) != 0.0                              \
1665                 : sv_2bool(sv) )
1666 #  define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1667 #endif /* __GNU__ */
1668
1669 #define SvIsCOW(sv)             ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1670                                     (SVf_FAKE | SVf_READONLY))
1671 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1672
1673 #define SvSHARED_HEK_FROM_PV(pvx) \
1674         ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1675 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1676
1677 /* flag values for sv_*_flags functions */
1678 #define SV_IMMEDIATE_UNREF      1
1679 #define SV_GMAGIC               2
1680 #define SV_COW_DROP_PV          4
1681 #define SV_UTF8_NO_ENCODING     8
1682 #define SV_NOSTEAL              16
1683 #define SV_CONST_RETURN         32
1684 #define SV_MUTABLE_RETURN       64
1685 #define SV_SMAGIC               128
1686 #define SV_HAS_TRAILING_NUL     256
1687 #define SV_COW_SHARED_HASH_KEYS 512
1688 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1689 #define SV_COW_OTHER_PVS        1024
1690 /* Make sv_2pv_flags return NULL if something is undefined.  */
1691 #define SV_UNDEF_RETURNS_NULL   2048
1692 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1693  * This is used when the caller has already determined it is, and avoids
1694  * redundant work */
1695 #define SV_FORCE_UTF8_UPGRADE   4096
1696 /* if (after resolving magic etc), the SV is found to be overloaded,
1697  * don't call the overload magic, just return as-is */
1698 #define SV_SKIP_OVERLOAD        8192
1699
1700 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1701    So only default to doing the COW setup if we're in the core.
1702  */
1703 #ifdef PERL_CORE
1704 #  ifndef SV_DO_COW_SVSETSV
1705 #    define SV_DO_COW_SVSETSV   SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1706 #  endif
1707 #endif
1708
1709 #ifndef SV_DO_COW_SVSETSV
1710 #  define SV_DO_COW_SVSETSV     0
1711 #endif
1712
1713
1714 #define sv_unref(sv)            sv_unref_flags(sv, 0)
1715 #define sv_force_normal(sv)     sv_force_normal_flags(sv, 0)
1716 #define sv_usepvn(sv, p, l)     sv_usepvn_flags(sv, p, l, 0)
1717 #define sv_usepvn_mg(sv, p, l)  sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1718
1719 /* We are about to replace the SV's current value. So if it's copy on write
1720    we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1721    the value is about to get thrown away, so drop the PV rather than go to
1722    the effort of making a read-write copy only for it to get immediately
1723    discarded.  */
1724
1725 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1726                                     sv_force_normal_flags(sv, SV_COW_DROP_PV)
1727
1728 #ifdef PERL_OLD_COPY_ON_WRITE
1729 #define SvRELEASE_IVX(sv)   \
1730     ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1731 #  define SvIsCOW_normal(sv)    (SvIsCOW(sv) && SvLEN(sv))
1732 #  define SvRELEASE_IVX_(sv)    SvRELEASE_IVX(sv),
1733 #else
1734 #  define SvRELEASE_IVX(sv)   0
1735 /* This little game brought to you by the need to shut this warning up:
1736 mg.c: In function `Perl_magic_get':
1737 mg.c:1024: warning: left-hand operand of comma expression has no effect
1738 */
1739 #  define SvRELEASE_IVX_(sv)  /**/
1740 #endif /* PERL_OLD_COPY_ON_WRITE */
1741
1742 #define CAN_COW_MASK    (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1743                          SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1744                          SVf_OOK|SVf_BREAK|SVf_READONLY)
1745 #define CAN_COW_FLAGS   (SVp_POK|SVf_POK)
1746
1747 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1748                                     sv_force_normal_flags(sv, 0)
1749
1750
1751 /* all these 'functions' are now just macros */
1752
1753 #define sv_pv(sv) SvPV_nolen(sv)
1754 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1755 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1756
1757 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1758 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1759 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1760 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1761 #define sv_setsv(dsv, ssv) \
1762         sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1763 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1764 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1765 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1766 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1767 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1768 #define sv_catpvn_mg(sv, sstr, slen) \
1769         sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1770 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1771 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1772 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1773 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1774 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1775 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1776 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1777 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1778 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1779 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1780 #define sv_insert(bigstr, offset, len, little, littlelen)               \
1781         Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little),  \
1782                              (littlelen), SV_GMAGIC)
1783
1784 /* Should be named SvCatPVN_utf8_upgrade? */
1785 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv)    \
1786         STMT_START {                                    \
1787             if (!(nsv))                                 \
1788                 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP);     \
1789             else                                        \
1790                 sv_setpvn(nsv, sstr, slen);             \
1791             SvUTF8_off(nsv);                            \
1792             sv_utf8_upgrade(nsv);                       \
1793             sv_catsv(dsv, nsv); \
1794         } STMT_END
1795
1796 /*
1797 =for apidoc Am|SV*|newRV_inc|SV* sv
1798
1799 Creates an RV wrapper for an SV.  The reference count for the original SV is
1800 incremented.
1801
1802 =cut
1803 */
1804
1805 #define newRV_inc(sv)   newRV(sv)
1806
1807 /* the following macros update any magic values this sv is associated with */
1808
1809 /*
1810 =head1 Magical Functions
1811
1812 =for apidoc Am|void|SvGETMAGIC|SV* sv
1813 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates its
1814 argument more than once.
1815
1816 =for apidoc Am|void|SvSETMAGIC|SV* sv
1817 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates its
1818 argument more than once.
1819
1820 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1821 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
1822 more than once.
1823
1824 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1825 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1826 ssv. May evaluate arguments more than once.
1827
1828 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1829 Like C<SvSetSV>, but does any set magic required afterwards.
1830
1831 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1832 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1833
1834 =for apidoc Am|void|SvSHARE|SV* sv
1835 Arranges for sv to be shared between threads if a suitable module
1836 has been loaded.
1837
1838 =for apidoc Am|void|SvLOCK|SV* sv
1839 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1840 has been loaded.
1841
1842 =for apidoc Am|void|SvUNLOCK|SV* sv
1843 Releases a mutual exclusion lock on sv if a suitable module
1844 has been loaded.
1845
1846 =head1 SV Manipulation Functions
1847
1848 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1849 Expands the character buffer in the SV so that it has room for the
1850 indicated number of bytes (remember to reserve space for an extra trailing
1851 NUL character).  Calls C<sv_grow> to perform the expansion if necessary.
1852 Returns a pointer to the character buffer.
1853
1854 =cut
1855 */
1856
1857 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1858 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1859 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1860 #define SvDESTROYABLE(sv) CALL_FPTR(PL_destroyhook)(aTHX_ sv)
1861
1862 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1863 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1864
1865 #define SvSetSV_and(dst,src,finally) \
1866         STMT_START {                                    \
1867             if ((dst) != (src)) {                       \
1868                 sv_setsv(dst, src);                     \
1869                 finally;                                \
1870             }                                           \
1871         } STMT_END
1872 #define SvSetSV_nosteal_and(dst,src,finally) \
1873         STMT_START {                                    \
1874             if ((dst) != (src)) {                       \
1875                 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV);   \
1876                 finally;                                \
1877             }                                           \
1878         } STMT_END
1879
1880 #define SvSetSV(dst,src) \
1881                 SvSetSV_and(dst,src,/*nothing*/;)
1882 #define SvSetSV_nosteal(dst,src) \
1883                 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1884
1885 #define SvSetMagicSV(dst,src) \
1886                 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1887 #define SvSetMagicSV_nosteal(dst,src) \
1888                 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1889
1890
1891 #if !defined(SKIP_DEBUGGING)
1892 #define SvPEEK(sv) sv_peek(sv)
1893 #else
1894 #define SvPEEK(sv) ""
1895 #endif
1896
1897 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1898
1899 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1900
1901 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1902 /* If I give every macro argument a different name, then there won't be bugs
1903    where nested macros get confused. Been there, done that.  */
1904 #define isGV_with_GP(pwadak) \
1905         (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP)   \
1906         && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
1907 #define isGV_with_GP_on(sv)     STMT_START {                           \
1908         assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1909         assert (!SvPOKp(sv));                                          \
1910         assert (!SvIOKp(sv));                                          \
1911         (SvFLAGS(sv) |= SVpgv_GP);                                     \
1912     } STMT_END
1913 #define isGV_with_GP_off(sv)    STMT_START {                           \
1914         assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1915         assert (!SvPOKp(sv));                                          \
1916         assert (!SvIOKp(sv));                                          \
1917         (SvFLAGS(sv) &= ~SVpgv_GP);                                    \
1918     } STMT_END
1919
1920
1921 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1922 #define SvGROW_mutable(sv,len) \
1923     (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1924 #define Sv_Grow sv_grow
1925
1926 #define CLONEf_COPY_STACKS 1
1927 #define CLONEf_KEEP_PTR_TABLE 2
1928 #define CLONEf_CLONE_HOST 4
1929 #define CLONEf_JOIN_IN 8
1930
1931 struct clone_params {
1932   AV* stashes;
1933   UV  flags;
1934   PerlInterpreter *proto_perl;
1935 };
1936
1937 /*
1938 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
1939
1940 Creates a new SV and copies a string into it.  If utf8 is true, calls
1941 C<SvUTF8_on> on the new SV.  Implemented as a wrapper around C<newSVpvn_flags>.
1942
1943 =cut
1944 */
1945
1946 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
1947
1948 /*
1949 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
1950
1951 Reads into I<len> the offset from SvPVX back to the true start of the
1952 allocated buffer, which will be non-zero if C<sv_chop> has been used to
1953 efficiently remove characters from start of the buffer. Implemented as a
1954 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
1955 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
1956
1957 =cut
1958 */
1959
1960 #ifdef DEBUGGING
1961 /* Does the bot know something I don't?
1962 10:28 <@Nicholas> metabatman
1963 10:28 <+meta> Nicholas: crash
1964 */
1965 #  define SvOOK_offset(sv, offset) STMT_START {                         \
1966         assert(sizeof(offset) == sizeof(STRLEN));                       \
1967         if (SvOOK(sv)) {                                                \
1968             const U8 *crash = (U8*)SvPVX_const(sv);                     \
1969             offset = *--crash;                                          \
1970             if (!offset) {                                              \
1971                 crash -= sizeof(STRLEN);                                \
1972                 Copy(crash, (U8 *)&offset, sizeof(STRLEN), U8);         \
1973             }                                                           \
1974             {                                                           \
1975                 /* Validate the preceding buffer's sentinels to         \
1976                    verify that no-one is using it.  */                  \
1977                 const U8 *const bonk = (U8 *) SvPVX_const(sv) - offset; \
1978                 while (crash > bonk) {                                  \
1979                     --crash;                                            \
1980                     assert (*crash == (U8)PTR2UV(crash));               \
1981                 }                                                       \
1982             }                                                           \
1983         } else {                                                        \
1984             offset = 0;                                                 \
1985         }                                                               \
1986     } STMT_END
1987 #else
1988     /* This is the same code, but avoids using any temporary variables:  */
1989 #  define SvOOK_offset(sv, offset) STMT_START {                         \
1990         assert(sizeof(offset) == sizeof(STRLEN));                       \
1991         if (SvOOK(sv)) {                                                \
1992             offset = ((U8*)SvPVX_const(sv))[-1];                        \
1993             if (!offset) {                                              \
1994                 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN),              \
1995                      (U8 *)&offset, sizeof(STRLEN), U8);                \
1996             }                                                           \
1997         } else {                                                        \
1998             offset = 0;                                                 \
1999         }                                                               \
2000     } STMT_END
2001 #endif
2002
2003 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2004
2005 /*
2006  * Local variables:
2007  * c-indentation-style: bsd
2008  * c-basic-offset: 4
2009  * indent-tabs-mode: t
2010  * End:
2011  *
2012  * ex: set ts=8 sts=4 sw=4 noet:
2013  */