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 F<sv.h>
  20 in the C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
  21
  22 The types are:
  23
  24     SVt_NULL
  25     SVt_IV
  26     SVt_NV
  27     SVt_RV
  28     SVt_PV
  29     SVt_PVIV
  30     SVt_PVNV
  31     SVt_PVMG
  32     SVt_INVLIST
  33     SVt_REGEXP
  34     SVt_PVGV
  35     SVt_PVLV
  36     SVt_PVAV
  37     SVt_PVHV
  38     SVt_PVCV
  39     SVt_PVFM
  40     SVt_PVIO
  41
  42 These are most easily explained from the bottom up.
  43
  44 C<SVt_PVIO> is for I/O objects, C<SVt_PVFM> for formats, C<SVt_PVCV> for
  45 subroutines, C<SVt_PVHV> for hashes and C<SVt_PVAV> for arrays.
  46
  47 All the others are scalar types, that is, things that can be bound to a
  48 C<$> variable.  For these, the internal types are mostly orthogonal to
  49 types in the Perl language.
  50
  51 Hence, checking C<< SvTYPE(sv) < SVt_PVAV >> is the best way to see whether
  52 something is a scalar.
  53
  54 C<SVt_PVGV> represents a typeglob.  If C<!SvFAKE(sv)>, then it is a real,
  55 incoercible typeglob.  If C<SvFAKE(sv)>, then it is a scalar to which a
  56 typeglob has been assigned.  Assigning to it again will stop it from being
  57 a typeglob.  C<SVt_PVLV> represents a scalar that delegates to another scalar
  58 behind the scenes.  It is used, e.g., for the return value of C<substr> and
  59 for tied hash and array elements.  It can hold any scalar value, including
  60 a typeglob.  C<SVt_REGEXP> is for regular
  61 expressions.  C<SVt_INVLIST> is for Perl
  62 core internal use only.
  63
  64 C<SVt_PVMG> represents a "normal" scalar (not a typeglob, regular expression,
  65 or delegate).  Since most scalars do not need all the internal fields of a
  66 PVMG, we save memory by allocating smaller structs when possible.  All the
  67 other types are just simpler forms of C<SVt_PVMG>, with fewer internal fields.
  68 C<SVt_NULL> can only hold undef.  C<SVt_IV> can hold undef, an integer, or a
  69 reference.  (C<SVt_RV> is an alias for C<SVt_IV>, which exists for backward
  70 compatibility.)  C<SVt_NV> can hold any of those or a double.  C<SVt_PV> can only
  71 hold C<undef> or a string.  C<SVt_PVIV> is a superset of C<SVt_PV> and C<SVt_IV>.
  72 C<SVt_PVNV> is similar.  C<SVt_PVMG> can hold anything C<SVt_PVNV> can hold, but it
  73 can, but does not have to, be blessed or magical.
  74
  75 =for apidoc AmU||SVt_NULL
  76 Type flag for scalars.  See L</svtype>.
  77
  78 =for apidoc AmU||SVt_IV
  79 Type flag for scalars.  See L</svtype>.
  80
  81 =for apidoc AmU||SVt_NV
  82 Type flag for scalars.  See L</svtype>.
  83
  84 =for apidoc AmU||SVt_PV
  85 Type flag for scalars.  See L</svtype>.
  86
  87 =for apidoc AmU||SVt_PVIV
  88 Type flag for scalars.  See L</svtype>.
  89
  90 =for apidoc AmU||SVt_PVNV
  91 Type flag for scalars.  See L</svtype>.
  92
  93 =for apidoc AmU||SVt_PVMG
  94 Type flag for scalars.  See L</svtype>.
  95
  96 =for apidoc AmU||SVt_INVLIST
  97 Type flag for scalars.  See L</svtype>.
  98
  99 =for apidoc AmU||SVt_REGEXP
 100 Type flag for regular expressions.  See L</svtype>.
 101
 102 =for apidoc AmU||SVt_PVGV
 103 Type flag for typeglobs.  See L</svtype>.
 104
 105 =for apidoc AmU||SVt_PVLV
 106 Type flag for scalars.  See L</svtype>.
 107
 108 =for apidoc AmU||SVt_PVAV
 109 Type flag for arrays.  See L</svtype>.
 110
 111 =for apidoc AmU||SVt_PVHV
 112 Type flag for hashes.  See L</svtype>.
 113
 114 =for apidoc AmU||SVt_PVCV
 115 Type flag for subroutines.  See L</svtype>.
 116
 117 =for apidoc AmU||SVt_PVFM
 118 Type flag for formats.  See L</svtype>.
 119
 120 =for apidoc AmU||SVt_PVIO
 121 Type flag for I/O objects.  See L</svtype>.
 122
 123 =cut
 124
 125   These are ordered so that the simpler types have a lower value; SvUPGRADE
 126   doesn't allow you to upgrade from a higher numbered type to a lower numbered
 127   one; also there is code that assumes that anything that has as a PV component
 128   has a type numbered >= SVt_PV.
 129 */
 130
 131
 132 typedef enum {
 133         SVt_NULL,       /* 0 */
 134         /* BIND was here, before INVLIST replaced it.  */
 135         SVt_IV,         /* 1 */
 136         SVt_NV,         /* 2 */
 137         /* RV was here, before it was merged with IV.  */
 138         SVt_PV,         /* 3 */
 139         SVt_INVLIST,    /* 4, implemented as a PV */
 140         SVt_PVIV,       /* 5 */
 141         SVt_PVNV,       /* 6 */
 142         SVt_PVMG,       /* 7 */
 143         SVt_REGEXP,     /* 8 */
 144         /* PVBM was here, before BIND replaced it.  */
 145         SVt_PVGV,       /* 9 */
 146         SVt_PVLV,       /* 10 */
 147         SVt_PVAV,       /* 11 */
 148         SVt_PVHV,       /* 12 */
 149         SVt_PVCV,       /* 13 */
 150         SVt_PVFM,       /* 14 */
 151         SVt_PVIO,       /* 15 */
 152         SVt_LAST        /* keep last in enum. used to size arrays */
 153 } svtype;
 154
 155 /* *** any alterations to the SV types above need to be reflected in
 156  * SVt_MASK and the various PL_valid_types_* tables.  As of this writing those
 157  * tables are in perl.h.  There are also two affected names tables in dump.c,
 158  * one in B.xs, and 'bodies_by_type[]' in sv.c */
 159
 160 #define SVt_MASK 0xf    /* smallest bitmask that covers all types */
 161
 162 #ifndef PERL_CORE
 163 /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
 164    purposes external code wanting to consider PVBM probably needs to think of
 165    PVMG instead.  */
 166 #  define SVt_PVBM      SVt_PVMG
 167 /* Anything wanting to create a reference from clean should ensure that it has
 168    a scalar of type SVt_IV now:  */
 169 #  define SVt_RV        SVt_IV
 170 #endif
 171
 172 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
 173    so never reaches the clause at the end that uses sv_type_details->body_size
 174    to determine whether to call safefree(). Hence body_size can be set
 175    non-zero to record the size of HEs, without fear of bogus frees.  */
 176 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
 177 #define HE_SVSLOT       SVt_NULL
 178 #endif
 179 #ifdef PERL_IN_SV_C
 180 #  define SVt_FIRST SVt_NULL    /* the type of SV that new_SV() in sv.c returns */
 181 #endif
 182
 183 #define PERL_ARENA_ROOTS_SIZE   (SVt_LAST)
 184
 185 /* typedefs to eliminate some typing */
 186 typedef struct he HE;
 187 typedef struct hek HEK;
 188
 189 /* Using C's structural equivalence to help emulate C++ inheritance here... */
 190
 191 /* start with 2 sv-head building blocks */
 192 #define _SV_HEAD(ptrtype) \
 193     ptrtype     sv_any;         /* pointer to body */   \
 194     U32         sv_refcnt;      /* how many references to us */ \
 195     U32         sv_flags        /* what we are */
 196
 197 #if NVSIZE <= IVSIZE
 198 #  define _NV_BODYLESS_UNION NV svu_nv;
 199 #else
 200 #  define _NV_BODYLESS_UNION
 201 #endif
 202
 203 #define _SV_HEAD_UNION \
 204     union {                             \
 205         char*   svu_pv;         /* pointer to malloced string */        \
 206         IV      svu_iv;                 \
 207         UV      svu_uv;                 \
 208         _NV_BODYLESS_UNION              \
 209         SV*     svu_rv;         /* pointer to another SV */             \
 210         struct regexp* svu_rx;          \
 211         SV**    svu_array;              \
 212         HE**    svu_hash;               \
 213         GP*     svu_gp;                 \
 214         PerlIO *svu_fp;                 \
 215     }   sv_u                            \
 216     _SV_HEAD_DEBUG
 217
 218 #ifdef DEBUG_LEAKING_SCALARS
 219 #define _SV_HEAD_DEBUG ;\
 220     PERL_BITFIELD32 sv_debug_optype:9;  /* the type of OP that allocated us */ \
 221     PERL_BITFIELD32 sv_debug_inpad:1;   /* was allocated in a pad for an OP */ \
 222     PERL_BITFIELD32 sv_debug_line:16;   /* the line where we were allocated */ \
 223     UV              sv_debug_serial;    /* serial number of sv allocation   */ \
 224     char *          sv_debug_file;      /* the file where we were allocated */ \
 225     SV *            sv_debug_parent     /* what we were cloned from (ithreads)*/
 226 #else
 227 #define _SV_HEAD_DEBUG
 228 #endif
 229
 230 struct STRUCT_SV {              /* struct sv { */
 231     _SV_HEAD(void*);
 232     _SV_HEAD_UNION;
 233 };
 234
 235 struct gv {
 236     _SV_HEAD(XPVGV*);           /* pointer to xpvgv body */
 237     _SV_HEAD_UNION;
 238 };
 239
 240 struct cv {
 241     _SV_HEAD(XPVCV*);           /* pointer to xpvcv body */
 242     _SV_HEAD_UNION;
 243 };
 244
 245 struct av {
 246     _SV_HEAD(XPVAV*);           /* pointer to xpvav body */
 247     _SV_HEAD_UNION;
 248 };
 249
 250 struct hv {
 251     _SV_HEAD(XPVHV*);           /* pointer to xpvhv body */
 252     _SV_HEAD_UNION;
 253 };
 254
 255 struct io {
 256     _SV_HEAD(XPVIO*);           /* pointer to xpvio body */
 257     _SV_HEAD_UNION;
 258 };
 259
 260 struct p5rx {
 261     _SV_HEAD(struct regexp*);   /* pointer to regexp body */
 262     _SV_HEAD_UNION;
 263 };
 264
 265 #undef _SV_HEAD
 266 #undef _SV_HEAD_UNION           /* ensure no pollution */
 267
 268 /*
 269 =head1 SV Manipulation Functions
 270
 271 =for apidoc Am|U32|SvREFCNT|SV* sv
 272 Returns the value of the object's reference count. Exposed
 273 to perl code via Internals::SvREFCNT().
 274
 275 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
 276 Increments the reference count of the given SV, returning the SV.
 277
 278 All of the following C<SvREFCNT_inc>* macros are optimized versions of
 279 C<SvREFCNT_inc>, and can be replaced with C<SvREFCNT_inc>.
 280
 281 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
 282 Same as C<SvREFCNT_inc>, but can only be used if you know C<sv>
 283 is not C<NULL>.  Since we don't have to check the NULLness, it's faster
 284 and smaller.
 285
 286 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
 287 Same as C<SvREFCNT_inc>, but can only be used if you don't need the
 288 return value.  The macro doesn't need to return a meaningful value.
 289
 290 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
 291 Same as C<SvREFCNT_inc>, but can only be used if you don't need the return
 292 value, and you know that C<sv> is not C<NULL>.  The macro doesn't need
 293 to return a meaningful value, or check for NULLness, so it's smaller
 294 and faster.
 295
 296 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
 297 Same as C<SvREFCNT_inc>, but can only be used with expressions without side
 298 effects.  Since we don't have to store a temporary value, it's faster.
 299
 300 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
 301 Same as C<SvREFCNT_inc_simple>, but can only be used if you know C<sv>
 302 is not C<NULL>.  Since we don't have to check the NULLness, it's faster
 303 and smaller.
 304
 305 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
 306 Same as C<SvREFCNT_inc_simple>, but can only be used if you don't need the
 307 return value.  The macro doesn't need to return a meaningful value.
 308
 309 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
 310 Same as C<SvREFCNT_inc>, but can only be used if you don't need the return
 311 value, and you know that C<sv> is not C<NULL>.  The macro doesn't need
 312 to return a meaningful value, or check for NULLness, so it's smaller
 313 and faster.
 314
 315 =for apidoc Am|void|SvREFCNT_dec|SV* sv
 316 Decrements the reference count of the given SV.  C<sv> may be C<NULL>.
 317
 318 =for apidoc Am|void|SvREFCNT_dec_NN|SV* sv
 319 Same as C<SvREFCNT_dec>, but can only be used if you know C<sv>
 320 is not C<NULL>.  Since we don't have to check the NULLness, it's faster
 321 and smaller.
 322
 323 =for apidoc Am|svtype|SvTYPE|SV* sv
 324 Returns the type of the SV.  See C<L</svtype>>.
 325
 326 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
 327 Used to upgrade an SV to a more complex form.  Uses C<sv_upgrade> to
 328 perform the upgrade if necessary.  See C<L</svtype>>.
 329
 330 =cut
 331 */
 332
 333 #define SvANY(sv)       (sv)->sv_any
 334 #define SvFLAGS(sv)     (sv)->sv_flags
 335 #define SvREFCNT(sv)    (sv)->sv_refcnt
 336
 337 #define SvREFCNT_inc(sv)                S_SvREFCNT_inc(MUTABLE_SV(sv))
 338 #define SvREFCNT_inc_simple(sv)         SvREFCNT_inc(sv)
 339 #define SvREFCNT_inc_NN(sv)             S_SvREFCNT_inc_NN(MUTABLE_SV(sv))
 340 #define SvREFCNT_inc_void(sv)           S_SvREFCNT_inc_void(MUTABLE_SV(sv))
 341
 342 /* These guys don't need the curly blocks */
 343 #define SvREFCNT_inc_simple_void(sv)    STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
 344 #define SvREFCNT_inc_simple_NN(sv)      (++(SvREFCNT(sv)),MUTABLE_SV(sv))
 345 #define SvREFCNT_inc_void_NN(sv)        (void)(++SvREFCNT(MUTABLE_SV(sv)))
 346 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
 347
 348 #define SvREFCNT_dec(sv)        S_SvREFCNT_dec(aTHX_ MUTABLE_SV(sv))
 349 #define SvREFCNT_dec_NN(sv)     S_SvREFCNT_dec_NN(aTHX_ MUTABLE_SV(sv))
 350
 351 #define SVTYPEMASK      0xff
 352 #define SvTYPE(sv)      ((svtype)((sv)->sv_flags & SVTYPEMASK))
 353
 354 /* Sadly there are some parts of the core that have pointers to already-freed
 355    SV heads, and rely on being able to tell that they are now free. So mark
 356    them all by using a consistent macro.  */
 357 #define SvIS_FREED(sv)  UNLIKELY(((sv)->sv_flags == SVTYPEMASK))
 358
 359 /* this is defined in this peculiar way to avoid compiler warnings.
 360  * See the <20121213131428.GD1842@iabyn.com> thread in p5p */
 361 #define SvUPGRADE(sv, mt) \
 362     ((void)(SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt),1)))
 363
 364 #define SVf_IOK         0x00000100  /* has valid public integer value */
 365 #define SVf_NOK         0x00000200  /* has valid public numeric value */
 366 #define SVf_POK         0x00000400  /* has valid public pointer value */
 367 #define SVf_ROK         0x00000800  /* has a valid reference pointer */
 368
 369 #define SVp_IOK         0x00001000  /* has valid non-public integer value */
 370 #define SVp_NOK         0x00002000  /* has valid non-public numeric value */
 371 #define SVp_POK         0x00004000  /* has valid non-public pointer value */
 372 #define SVp_SCREAM      0x00008000  /* method name is DOES */
 373                                     /* eval cx text is ref counted */
 374 #define SVphv_CLONEABLE SVp_SCREAM  /* PVHV (stashes) clone its objects */
 375 #define SVpgv_GP        SVp_SCREAM  /* GV has a valid GP */
 376 #define SVprv_PCS_IMPORTED  SVp_SCREAM  /* RV is a proxy for a constant
 377                                        subroutine in another package. Set the
 378                                        GvIMPORTED_CV_on() if it needs to be
 379                                        expanded to a real GV */
 380 #define SVf_PROTECT     0x00010000  /* very read-only */
 381 #define SVs_PADTMP      0x00020000  /* in use as tmp */
 382 #define SVs_PADSTALE    0x00040000  /* lexical has gone out of scope;
 383                                         only used when !PADTMP */
 384 #define SVs_TEMP        0x00080000  /* mortal (implies string is stealable) */
 385 #define SVs_OBJECT      0x00100000  /* is "blessed" */
 386 #define SVs_GMG         0x00200000  /* has magical get method */
 387 #define SVs_SMG         0x00400000  /* has magical set method */
 388 #define SVs_RMG         0x00800000  /* has random magical methods */
 389
 390 #define SVf_FAKE        0x01000000  /* 0: glob is just a copy
 391                                        1: SV head arena wasn't malloc()ed
 392                                        2: For PVCV, whether CvUNIQUE(cv)
 393                                           refers to an eval or once only
 394                                           [CvEVAL(cv), CvSPECIAL(cv)]
 395                                        3: HV: informally reserved by DAPM
 396                                           for vtables */
 397 #define SVf_OOK         0x02000000  /* has valid offset value. For a PVHV this
 398                                        means that a hv_aux struct is present
 399                                        after the main array */
 400 #define SVf_BREAK       0x04000000  /* refcnt is artificially low - used by
 401                                        SVs in final arena cleanup.
 402                                        Set in S_regtry on PL_reg_curpm, so that
 403                                        perl_destruct will skip it.
 404                                        Used for mark and sweep by OP_AASSIGN
 405                                        */
 406 #define SVf_READONLY    0x08000000  /* may not be modified */
 407
 408
 409
 410
 411 #define SVf_THINKFIRST  (SVf_READONLY|SVf_PROTECT|SVf_ROK|SVf_FAKE \
 412                         |SVs_RMG|SVf_IsCOW)
 413
 414 #define SVf_OK          (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
 415                          SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
 416
 417 #define PRIVSHIFT 4     /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
 418
 419 /* Note that SVf_AMAGIC is now only set on stashes.  */
 420 #define SVf_AMAGIC      0x10000000  /* has magical overloaded methods */
 421 #define SVf_IsCOW       0x10000000  /* copy on write (shared hash key if
 422                                        SvLEN == 0) */
 423
 424 /* Ensure this value does not clash with the GV_ADD* flags in gv.h, or the
 425    CV_CKPROTO_* flags in op.c, or the padadd_* flags in pad.h: */
 426 #define SVf_UTF8        0x20000000  /* SvPV is UTF-8 encoded
 427                                        This is also set on RVs whose overloaded
 428                                        stringification is UTF-8. This might
 429                                        only happen as a side effect of SvPV() */
 430 /* PVHV */
 431 #define SVphv_SHAREKEYS 0x20000000  /* PVHV keys live on shared string table */
 432
 433 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
 434    be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
 435    been restructured, so sometimes get used as string buffers.  */
 436
 437
 438 /* Some private flags. */
 439
 440
 441 /* The SVp_SCREAM|SVpbm_VALID (0x40008000) combination is up for grabs.
 442    Formerly it was used for pad names, but now it is available.  The core
 443    is careful to avoid setting both flags.
 444
 445    SVf_POK, SVp_POK also set:
 446    0x00004400   Normal
 447    0x0000C400   method name for DOES (SvSCREAM)
 448    0x40004400   FBM compiled (SvVALID)
 449    0x4000C400   *** Formerly used for pad names ***
 450
 451    0x00008000   GV with GP
 452    0x00008800   RV with PCS imported
 453 */
 454 /* PVAV */
 455 #define SVpav_REAL      0x40000000  /* free old entries */
 456 /* PVHV */
 457 #define SVphv_LAZYDEL   0x40000000  /* entry in xhv_eiter must be deleted */
 458 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
 459    on any regular scalar (anything <= PVLV) */
 460 #define SVpbm_VALID     0x40000000
 461 /* Only used in toke.c on an SV stored in PL_lex_repl */
 462 #define SVrepl_EVAL     0x40000000  /* Replacement part of s///e */
 463
 464 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV  */
 465 #define SVf_IVisUV      0x80000000  /* use XPVUV instead of XPVIV */
 466 /* PVAV */
 467 #define SVpav_REIFY     0x80000000  /* can become real */
 468 /* PVHV */
 469 #define SVphv_HASKFLAGS 0x80000000  /* keys have flag byte after hash */
 470 /* PVGV when SVpbm_VALID is true */
 471 #define SVpbm_TAIL      0x80000000  /* string has a fake "\n" appended */
 472 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive  */
 473 #define SVprv_WEAKREF   0x80000000  /* Weak reference */
 474 /* pad name vars only */
 475
 476 #define _XPV_HEAD                                                       \
 477     HV*         xmg_stash;      /* class package */                     \
 478     union _xmgu xmg_u;                                                  \
 479     STRLEN      xpv_cur;        /* length of svu_pv as a C string */    \
 480     union {                                                             \
 481         STRLEN  xpvlenu_len;    /* allocated size */                    \
 482         char *  xpvlenu_pv;     /* regexp string */                     \
 483     } xpv_len_u
 484
 485 #define xpv_len xpv_len_u.xpvlenu_len
 486
 487 union _xnvu {
 488     NV      xnv_nv;             /* numeric value, if any */
 489     HV *    xgv_stash;
 490     struct {
 491         U32 xlow;
 492         U32 xhigh;
 493     }       xpad_cop_seq;       /* used by pad.c for cop_sequence */
 494 };
 495
 496 union _xivu {
 497     IV      xivu_iv;            /* integer value */
 498     UV      xivu_uv;
 499     HEK *   xivu_namehek;       /* xpvlv, xpvgv: GvNAME */
 500 };
 501
 502 union _xmgu {
 503     MAGIC*  xmg_magic;          /* linked list of magicalness */
 504     STRLEN  xmg_hash_index;     /* used while freeing hash entries */
 505 };
 506
 507 struct xpv {
 508     _XPV_HEAD;
 509 };
 510
 511 struct xpviv {
 512     _XPV_HEAD;
 513     union _xivu xiv_u;
 514 };
 515
 516 #define xiv_iv xiv_u.xivu_iv
 517
 518 struct xpvuv {
 519     _XPV_HEAD;
 520     union _xivu xuv_u;
 521 };
 522
 523 #define xuv_uv xuv_u.xivu_uv
 524
 525 struct xpvnv {
 526     _XPV_HEAD;
 527     union _xivu xiv_u;
 528     union _xnvu xnv_u;
 529 };
 530
 531 /* This structure must match the beginning of struct xpvhv in hv.h. */
 532 struct xpvmg {
 533     _XPV_HEAD;
 534     union _xivu xiv_u;
 535     union _xnvu xnv_u;
 536 };
 537
 538 struct xpvlv {
 539     _XPV_HEAD;
 540     union _xivu xiv_u;
 541     union _xnvu xnv_u;
 542     union {
 543         STRLEN  xlvu_targoff;
 544         SSize_t xlvu_stargoff;
 545     } xlv_targoff_u;
 546     STRLEN      xlv_targlen;
 547     SV*         xlv_targ;
 548     char        xlv_type;       /* k=keys .=pos x=substr v=vec /=join/re
 549                                  * y=alem/helem/iter t=tie T=tied HE */
 550     char        xlv_flags;      /* 1 = negative offset  2 = negative len */
 551 };
 552
 553 #define xlv_targoff xlv_targoff_u.xlvu_targoff
 554
 555 struct xpvinvlist {
 556     _XPV_HEAD;
 557     IV          prev_index;     /* caches result of previous invlist_search() */
 558     STRLEN      iterator;       /* Stores where we are in iterating */
 559     bool        is_offset;      /* The data structure for all inversion lists
 560                                    begins with an element for code point U+0000.
 561                                    If this bool is set, the actual list contains
 562                                    that 0; otherwise, the list actually begins
 563                                    with the following element.  Thus to invert
 564                                    the list, merely toggle this flag  */
 565 };
 566
 567 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
 568    Boyer-Moore.  */
 569 struct xpvgv {
 570     _XPV_HEAD;
 571     union _xivu xiv_u;
 572     union _xnvu xnv_u;
 573 };
 574
 575 typedef U32 cv_flags_t;
 576
 577 #define _XPVCV_COMMON                                                           \
 578     HV *        xcv_stash;                                                      \
 579     union {                                                                     \
 580         OP *    xcv_start;                                                      \
 581         ANY     xcv_xsubany;                                                    \
 582     }           xcv_start_u;                                                    \
 583     union {                                                                     \
 584         OP *    xcv_root;                                                       \
 585         void    (*xcv_xsub) (pTHX_ CV*);                                        \
 586     }           xcv_root_u;                                                     \
 587     union {                                                             \
 588         GV *    xcv_gv;                                                 \
 589         HEK *   xcv_hek;                                                \
 590     }           xcv_gv_u;                                               \
 591     char *      xcv_file;                                                       \
 592     union {                                                                     \
 593         PADLIST *       xcv_padlist;                                            \
 594         void *          xcv_hscxt;                                              \
 595     }           xcv_padlist_u;                                                  \
 596     CV *        xcv_outside;                                                    \
 597     U32         xcv_outside_seq; /* the COP sequence (at the point of our       \
 598                                   * compilation) in the lexically enclosing     \
 599                                   * sub */                                      \
 600     cv_flags_t  xcv_flags;                                              \
 601     I32 xcv_depth       /* >= 2 indicates recursive call */
 602
 603 /* This structure must match XPVCV in cv.h */
 604
 605 struct xpvfm {
 606     _XPV_HEAD;
 607     _XPVCV_COMMON;
 608 };
 609
 610
 611 struct xpvio {
 612     _XPV_HEAD;
 613     union _xivu xiv_u;
 614     /* ifp and ofp are normally the same, but sockets need separate streams */
 615     PerlIO *    xio_ofp;
 616     /* Cray addresses everything by word boundaries (64 bits) and
 617      * code and data pointers cannot be mixed (which is exactly what
 618      * Perl_filter_add() tries to do with the dirp), hence the
 619      *  following union trick (as suggested by Gurusamy Sarathy).
 620      * For further information see Geir Johansen's problem report
 621      * titled [ID 20000612.002 (#3366)] Perl problem on Cray system
 622      * The any pointer (known as IoANY()) will also be a good place
 623      * to hang any IO disciplines to.
 624      */
 625     union {
 626         DIR *   xiou_dirp;      /* for opendir, readdir, etc */
 627         void *  xiou_any;       /* for alignment */
 628     } xio_dirpu;
 629     /* IV xio_lines is now in IVX  $. */
 630     IV          xio_page;       /* $% */
 631     IV          xio_page_len;   /* $= */
 632     IV          xio_lines_left; /* $- */
 633     char *      xio_top_name;   /* $^ */
 634     GV *        xio_top_gv;     /* $^ */
 635     char *      xio_fmt_name;   /* $~ */
 636     GV *        xio_fmt_gv;     /* $~ */
 637     char *      xio_bottom_name;/* $^B */
 638     GV *        xio_bottom_gv;  /* $^B */
 639     char        xio_type;
 640     U8          xio_flags;
 641 };
 642
 643 #define xio_dirp        xio_dirpu.xiou_dirp
 644 #define xio_any         xio_dirpu.xiou_any
 645
 646 #define IOf_ARGV        1       /* this fp iterates over ARGV */
 647 #define IOf_START       2       /* check for null ARGV and substitute '-' */
 648 #define IOf_FLUSH       4       /* this fp wants a flush after write op */
 649 #define IOf_DIDTOP      8       /* just did top of form */
 650 #define IOf_UNTAINT     16      /* consider this fp (and its data) "safe" */
 651 #define IOf_NOLINE      32      /* slurped a pseudo-line from empty file */
 652 #define IOf_FAKE_DIRP   64      /* xio_dirp is fake (source filters kludge)
 653                                    Also, when this is set, SvPVX() is valid */
 654
 655 /* The following macros define implementation-independent predicates on SVs. */
 656
 657 /*
 658 =for apidoc Am|U32|SvNIOK|SV* sv
 659 Returns a U32 value indicating whether the SV contains a number, integer or
 660 double.
 661
 662 =for apidoc Am|U32|SvNIOKp|SV* sv
 663 Returns a U32 value indicating whether the SV contains a number, integer or
 664 double.  Checks the B<private> setting.  Use C<SvNIOK> instead.
 665
 666 =for apidoc Am|void|SvNIOK_off|SV* sv
 667 Unsets the NV/IV status of an SV.
 668
 669 =for apidoc Am|U32|SvOK|SV* sv
 670 Returns a U32 value indicating whether the value is defined.  This is
 671 only meaningful for scalars.
 672
 673 =for apidoc Am|U32|SvIOKp|SV* sv
 674 Returns a U32 value indicating whether the SV contains an integer.  Checks
 675 the B<private> setting.  Use C<SvIOK> instead.
 676
 677 =for apidoc Am|U32|SvNOKp|SV* sv
 678 Returns a U32 value indicating whether the SV contains a double.  Checks the
 679 B<private> setting.  Use C<SvNOK> instead.
 680
 681 =for apidoc Am|U32|SvPOKp|SV* sv
 682 Returns a U32 value indicating whether the SV contains a character string.
 683 Checks the B<private> setting.  Use C<SvPOK> instead.
 684
 685 =for apidoc Am|U32|SvIOK|SV* sv
 686 Returns a U32 value indicating whether the SV contains an integer.
 687
 688 =for apidoc Am|void|SvIOK_on|SV* sv
 689 Tells an SV that it is an integer.
 690
 691 =for apidoc Am|void|SvIOK_off|SV* sv
 692 Unsets the IV status of an SV.
 693
 694 =for apidoc Am|void|SvIOK_only|SV* sv
 695 Tells an SV that it is an integer and disables all other C<OK> bits.
 696
 697 =for apidoc Am|void|SvIOK_only_UV|SV* sv
 698 Tells an SV that it is an unsigned integer and disables all other C<OK> bits.
 699
 700 =for apidoc Am|bool|SvIOK_UV|SV* sv
 701 Returns a boolean indicating whether the SV contains an integer that must be
 702 interpreted as unsigned.  A non-negative integer whose value is within the
 703 range of both an IV and a UV may be be flagged as either C<SvUOK> or C<SVIOK>.
 704
 705 =for apidoc Am|bool|SvUOK|SV* sv
 706 Returns a boolean indicating whether the SV contains an integer that must be
 707 interpreted as unsigned.  A non-negative integer whose value is within the
 708 range of both an IV and a UV may be be flagged as either C<SvUOK> or C<SVIOK>.
 709
 710 =for apidoc Am|bool|SvIOK_notUV|SV* sv
 711 Returns a boolean indicating whether the SV contains a signed integer.
 712
 713 =for apidoc Am|U32|SvNOK|SV* sv
 714 Returns a U32 value indicating whether the SV contains a double.
 715
 716 =for apidoc Am|void|SvNOK_on|SV* sv
 717 Tells an SV that it is a double.
 718
 719 =for apidoc Am|void|SvNOK_off|SV* sv
 720 Unsets the NV status of an SV.
 721
 722 =for apidoc Am|void|SvNOK_only|SV* sv
 723 Tells an SV that it is a double and disables all other OK bits.
 724
 725 =for apidoc Am|U32|SvPOK|SV* sv
 726 Returns a U32 value indicating whether the SV contains a character
 727 string.
 728
 729 =for apidoc Am|void|SvPOK_on|SV* sv
 730 Tells an SV that it is a string.
 731
 732 =for apidoc Am|void|SvPOK_off|SV* sv
 733 Unsets the PV status of an SV.
 734
 735 =for apidoc Am|void|SvPOK_only|SV* sv
 736 Tells an SV that it is a string and disables all other C<OK> bits.
 737 Will also turn off the UTF-8 status.
 738
 739 =for apidoc Am|bool|SvVOK|SV* sv
 740 Returns a boolean indicating whether the SV contains a v-string.
 741
 742 =for apidoc Am|U32|SvOOK|SV* sv
 743 Returns a U32 indicating whether the pointer to the string buffer is offset.
 744 This hack is used internally to speed up removal of characters from the
 745 beginning of a C<SvPV>.  When C<SvOOK> is true, then the start of the
 746 allocated string buffer is actually C<SvOOK_offset()> bytes before C<SvPVX>.
 747 This offset used to be stored in C<SvIVX>, but is now stored within the spare
 748 part of the buffer.
 749
 750 =for apidoc Am|U32|SvROK|SV* sv
 751 Tests if the SV is an RV.
 752
 753 =for apidoc Am|void|SvROK_on|SV* sv
 754 Tells an SV that it is an RV.
 755
 756 =for apidoc Am|void|SvROK_off|SV* sv
 757 Unsets the RV status of an SV.
 758
 759 =for apidoc Am|SV*|SvRV|SV* sv
 760 Dereferences an RV to return the SV.
 761
 762 =for apidoc Am|IV|SvIVX|SV* sv
 763 Returns the raw value in the SV's IV slot, without checks or conversions.
 764 Only use when you are sure C<SvIOK> is true.  See also C<L</SvIV>>.
 765
 766 =for apidoc Am|UV|SvUVX|SV* sv
 767 Returns the raw value in the SV's UV slot, without checks or conversions.
 768 Only use when you are sure C<SvIOK> is true.  See also C<L</SvUV>>.
 769
 770 =for apidoc Am|NV|SvNVX|SV* sv
 771 Returns the raw value in the SV's NV slot, without checks or conversions.
 772 Only use when you are sure C<SvNOK> is true.  See also C<L</SvNV>>.
 773
 774 =for apidoc Am|char*|SvPVX|SV* sv
 775 Returns a pointer to the physical string in the SV.  The SV must contain a
 776 string.  Prior to 5.9.3 it is not safe
 777 to execute this macro unless the SV's
 778 type >= C<SVt_PV>.
 779
 780 This is also used to store the name of an autoloaded subroutine in an XS
 781 AUTOLOAD routine.  See L<perlguts/Autoloading with XSUBs>.
 782
 783 =for apidoc Am|STRLEN|SvCUR|SV* sv
 784 Returns the length of the string which is in the SV.  See C<L</SvLEN>>.
 785
 786 =for apidoc Am|STRLEN|SvLEN|SV* sv
 787 Returns the size of the string buffer in the SV, not including any part
 788 attributable to C<SvOOK>.  See C<L</SvCUR>>.
 789
 790 =for apidoc Am|char*|SvEND|SV* sv
 791 Returns a pointer to the spot just after the last character in
 792 the string which is in the SV, where there is usually a trailing
 793 C<NUL> character (even though Perl scalars do not strictly require it).
 794 See C<L</SvCUR>>.  Access the character as C<*(SvEND(sv))>.
 795
 796 Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
 797 unallocated memory.
 798
 799 =for apidoc Am|HV*|SvSTASH|SV* sv
 800 Returns the stash of the SV.
 801
 802 =for apidoc Am|void|SvIV_set|SV* sv|IV val
 803 Set the value of the IV pointer in sv to val.  It is possible to perform
 804 the same function of this macro with an lvalue assignment to C<SvIVX>.
 805 With future Perls, however, it will be more efficient to use
 806 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
 807
 808 =for apidoc Am|void|SvNV_set|SV* sv|NV val
 809 Set the value of the NV pointer in C<sv> to val.  See C<L</SvIV_set>>.
 810
 811 =for apidoc Am|void|SvPV_set|SV* sv|char* val
 812 This is probably not what you want to use, you probably wanted
 813 L</sv_usepvn_flags> or L</sv_setpvn> or L</sv_setpvs>.
 814
 815 Set the value of the PV pointer in C<sv> to the Perl allocated
 816 C<NUL>-terminated string C<val>.  See also C<L</SvIV_set>>.
 817
 818 Remember to free the previous PV buffer. There are many things to check.
 819 Beware that the existing pointer may be involved in copy-on-write or other
 820 mischief, so do C<SvOOK_off(sv)> and use C<sv_force_normal> or
 821 C<SvPV_force> (or check the C<SvIsCOW> flag) first to make sure this
 822 modification is safe. Then finally, if it is not a COW, call C<SvPV_free> to
 823 free the previous PV buffer.
 824
 825 =for apidoc Am|void|SvUV_set|SV* sv|UV val
 826 Set the value of the UV pointer in C<sv> to val.  See C<L</SvIV_set>>.
 827
 828 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
 829 Set the value of the RV pointer in C<sv> to val.  See C<L</SvIV_set>>.
 830
 831 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
 832 Set the value of the MAGIC pointer in C<sv> to val.  See C<L</SvIV_set>>.
 833
 834 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
 835 Set the value of the STASH pointer in C<sv> to val.  See C<L</SvIV_set>>.
 836
 837 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
 838 Set the current length of the string which is in the SV.  See C<L</SvCUR>>
 839 and C<SvIV_set>>.
 840
 841 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
 842 Set the size of the string buffer for the SV. See C<L</SvLEN>>.
 843
 844 =cut
 845 */
 846
 847 #define SvNIOK(sv)              (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
 848 #define SvNIOKp(sv)             (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
 849 #define SvNIOK_off(sv)          (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
 850                                                   SVp_IOK|SVp_NOK|SVf_IVisUV))
 851
 852 #define assert_not_ROK(sv)      assert_(!SvROK(sv) || !SvRV(sv))
 853 #define assert_not_glob(sv)     assert_(!isGV_with_GP(sv))
 854
 855 #define SvOK(sv)                (SvFLAGS(sv) & SVf_OK || isREGEXP(sv))
 856 #define SvOK_off(sv)            (assert_not_ROK(sv) assert_not_glob(sv) \
 857                                  SvFLAGS(sv) &= ~(SVf_OK|               \
 858                                                   SVf_IVisUV|SVf_UTF8), \
 859                                                         SvOOK_off(sv))
 860 #define SvOK_off_exc_UV(sv)     (assert_not_ROK(sv)                     \
 861                                  SvFLAGS(sv) &= ~(SVf_OK|               \
 862                                                   SVf_UTF8),            \
 863                                                         SvOOK_off(sv))
 864
 865 #define SvOKp(sv)               (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
 866 #define SvIOKp(sv)              (SvFLAGS(sv) & SVp_IOK)
 867 #define SvIOKp_on(sv)           (assert_not_glob(sv)    \
 868                                     SvFLAGS(sv) |= SVp_IOK)
 869 #define SvNOKp(sv)              (SvFLAGS(sv) & SVp_NOK)
 870 #define SvNOKp_on(sv)           (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
 871 #define SvPOKp(sv)              (SvFLAGS(sv) & SVp_POK)
 872 #define SvPOKp_on(sv)           (assert_not_ROK(sv) assert_not_glob(sv) \
 873                                  SvFLAGS(sv) |= SVp_POK)
 874
 875 #define SvIOK(sv)               (SvFLAGS(sv) & SVf_IOK)
 876 #define SvIOK_on(sv)            (assert_not_glob(sv)    \
 877                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
 878 #define SvIOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
 879 #define SvIOK_only(sv)          (SvOK_off(sv), \
 880                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
 881 #define SvIOK_only_UV(sv)       (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
 882                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
 883
 884 #define SvIOK_UV(sv)            ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
 885                                  == (SVf_IOK|SVf_IVisUV))
 886 #define SvUOK(sv)               SvIOK_UV(sv)
 887 #define SvIOK_notUV(sv)         ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
 888                                  == SVf_IOK)
 889
 890 #define SvIsUV(sv)              (SvFLAGS(sv) & SVf_IVisUV)
 891 #define SvIsUV_on(sv)           (SvFLAGS(sv) |= SVf_IVisUV)
 892 #define SvIsUV_off(sv)          (SvFLAGS(sv) &= ~SVf_IVisUV)
 893
 894 #define SvNOK(sv)               (SvFLAGS(sv) & SVf_NOK)
 895 #define SvNOK_on(sv)            (assert_not_glob(sv) \
 896                                  SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
 897 #define SvNOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
 898 #define SvNOK_only(sv)          (SvOK_off(sv), \
 899                                     SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
 900
 901 /*
 902 =for apidoc Am|U32|SvUTF8|SV* sv
 903 Returns a U32 value indicating the UTF-8 status of an SV.  If things are set-up
 904 properly, this indicates whether or not the SV contains UTF-8 encoded data.
 905 You should use this I<after> a call to C<SvPV()> or one of its variants, in
 906 case any call to string overloading updates the internal flag.
 907
 908 If you want to take into account the L<bytes> pragma, use C<L</DO_UTF8>>
 909 instead.
 910
 911 =for apidoc Am|void|SvUTF8_on|SV *sv
 912 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
 913 Do not use frivolously.
 914
 915 =for apidoc Am|void|SvUTF8_off|SV *sv
 916 Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
 917 Do not use frivolously.
 918
 919 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
 920 Tells an SV that it is a string and disables all other C<OK> bits,
 921 and leaves the UTF-8 status as it was.
 922
 923 =cut
 924  */
 925
 926 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
 927 in gv.h: */
 928 #define SvUTF8(sv)              (SvFLAGS(sv) & SVf_UTF8)
 929 #define SvUTF8_on(sv)           (SvFLAGS(sv) |= (SVf_UTF8))
 930 #define SvUTF8_off(sv)          (SvFLAGS(sv) &= ~(SVf_UTF8))
 931
 932 #define SvPOK(sv)               (SvFLAGS(sv) & SVf_POK)
 933 #define SvPOK_on(sv)            (assert_not_ROK(sv) assert_not_glob(sv) \
 934                                  SvFLAGS(sv) |= (SVf_POK|SVp_POK))
 935 #define SvPOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
 936 #define SvPOK_only(sv)          (assert_not_ROK(sv) assert_not_glob(sv) \
 937                                  SvFLAGS(sv) &= ~(SVf_OK|               \
 938                                                   SVf_IVisUV|SVf_UTF8), \
 939                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
 940 #define SvPOK_only_UTF8(sv)     (assert_not_ROK(sv) assert_not_glob(sv) \
 941                                  SvFLAGS(sv) &= ~(SVf_OK|               \
 942                                                   SVf_IVisUV),          \
 943                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
 944
 945 #define SvVOK(sv)               (SvMAGICAL(sv)                          \
 946                                  && mg_find(sv,PERL_MAGIC_vstring))
 947 /* returns the vstring magic, if any */
 948 #define SvVSTRING_mg(sv)        (SvMAGICAL(sv) \
 949                                  ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
 950
 951 #define SvOOK(sv)               (SvFLAGS(sv) & SVf_OOK)
 952 #define SvOOK_on(sv)            (SvFLAGS(sv) |= SVf_OOK)
 953 #define SvOOK_off(sv)           ((void)(SvOOK(sv) && (sv_backoff(sv),0)))
 954
 955 #define SvFAKE(sv)              (SvFLAGS(sv) & SVf_FAKE)
 956 #define SvFAKE_on(sv)           (SvFLAGS(sv) |= SVf_FAKE)
 957 #define SvFAKE_off(sv)          (SvFLAGS(sv) &= ~SVf_FAKE)
 958
 959 #define SvROK(sv)               (SvFLAGS(sv) & SVf_ROK)
 960 #define SvROK_on(sv)            (SvFLAGS(sv) |= SVf_ROK)
 961 #define SvROK_off(sv)           (SvFLAGS(sv) &= ~(SVf_ROK))
 962
 963 #define SvMAGICAL(sv)           (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
 964 #define SvMAGICAL_on(sv)        (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
 965 #define SvMAGICAL_off(sv)       (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
 966
 967 #define SvGMAGICAL(sv)          (SvFLAGS(sv) & SVs_GMG)
 968 #define SvGMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_GMG)
 969 #define SvGMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_GMG)
 970
 971 #define SvSMAGICAL(sv)          (SvFLAGS(sv) & SVs_SMG)
 972 #define SvSMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_SMG)
 973 #define SvSMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_SMG)
 974
 975 #define SvRMAGICAL(sv)          (SvFLAGS(sv) & SVs_RMG)
 976 #define SvRMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_RMG)
 977 #define SvRMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_RMG)
 978
 979 #define SvAMAGIC(sv)            (SvROK(sv) && SvOBJECT(SvRV(sv)) &&     \
 980                                  HvAMAGIC(SvSTASH(SvRV(sv))))
 981
 982 /* To be used on the stashes themselves: */
 983 #define HvAMAGIC(hv)            (SvFLAGS(hv) & SVf_AMAGIC)
 984 #define HvAMAGIC_on(hv)         (SvFLAGS(hv) |= SVf_AMAGIC)
 985 #define HvAMAGIC_off(hv)        (SvFLAGS(hv) &=~ SVf_AMAGIC)
 986
 987
 988 /* "nog" means "doesn't have get magic" */
 989 #define SvPOK_nog(sv)           ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
 990 #define SvIOK_nog(sv)           ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
 991 #define SvUOK_nog(sv)           ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
 992 #define SvNOK_nog(sv)           ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
 993 #define SvNIOK_nog(sv)          (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
 994
 995 #define SvPOK_nogthink(sv)      ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
 996 #define SvIOK_nogthink(sv)      ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
 997 #define SvUOK_nogthink(sv)      ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
 998 #define SvNOK_nogthink(sv)      ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
 999 #define SvNIOK_nogthink(sv)     (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
1000
1001 #define SvPOK_utf8_nog(sv)      ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1002 #define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1003
1004 #define SvPOK_byte_nog(sv)      ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
1005 #define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1006
1007 #define SvPOK_pure_nogthink(sv) \
1008     ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1009 #define SvPOK_utf8_pure_nogthink(sv) \
1010     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1011 #define SvPOK_byte_pure_nogthink(sv) \
1012     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1013
1014 /*
1015 =for apidoc Am|U32|SvGAMAGIC|SV* sv
1016
1017 Returns true if the SV has get magic or
1018 overloading.  If either is true then
1019 the scalar is active data, and has the potential to return a new value every
1020 time it is accessed.  Hence you must be careful to
1021 only read it once per user logical operation and work
1022 with that returned value.  If neither is true then
1023 the scalar's value cannot change unless written to.
1024
1025 =cut
1026 */
1027
1028 #define SvGAMAGIC(sv)           (SvGMAGICAL(sv) || SvAMAGIC(sv))
1029
1030 #define Gv_AMG(stash) \
1031         (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
1032             ? 1                                     \
1033             : (HvAMAGIC_off(stash), 0))
1034
1035 #define SvWEAKREF(sv)           ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1036                                   == (SVf_ROK|SVprv_WEAKREF))
1037 #define SvWEAKREF_on(sv)        (SvFLAGS(sv) |=  (SVf_ROK|SVprv_WEAKREF))
1038 #define SvWEAKREF_off(sv)       (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1039
1040 #define SvPCS_IMPORTED(sv)      ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
1041                                  == (SVf_ROK|SVprv_PCS_IMPORTED))
1042 #define SvPCS_IMPORTED_on(sv)   (SvFLAGS(sv) |=  (SVf_ROK|SVprv_PCS_IMPORTED))
1043 #define SvPCS_IMPORTED_off(sv)  (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
1044
1045 /*
1046 =for apidoc m|U32|SvTHINKFIRST|SV *sv
1047
1048 A quick flag check to see whether an C<sv> should be passed to C<sv_force_normal>
1049 to be "downgraded" before C<SvIVX> or C<SvPVX> can be modified directly.
1050
1051 For example, if your scalar is a reference and you want to modify the C<SvIVX>
1052 slot, you can't just do C<SvROK_off>, as that will leak the referent.
1053
1054 This is used internally by various sv-modifying functions, such as
1055 C<sv_setsv>, C<sv_setiv> and C<sv_pvn_force>.
1056
1057 One case that this does not handle is a gv without SvFAKE set.  After
1058
1059     if (SvTHINKFIRST(gv)) sv_force_normal(gv);
1060
1061 it will still be a gv.
1062
1063 C<SvTHINKFIRST> sometimes produces false positives.  In those cases
1064 C<sv_force_normal> does nothing.
1065
1066 =cut
1067 */
1068
1069 #define SvTHINKFIRST(sv)        (SvFLAGS(sv) & SVf_THINKFIRST)
1070
1071 #define SVs_PADMY               0
1072 #define SvPADMY(sv)             !(SvFLAGS(sv) & SVs_PADTMP)
1073 #ifndef PERL_CORE
1074 # define SvPADMY_on(sv)         SvPADTMP_off(sv)
1075 #endif
1076
1077 #define SvPADTMP(sv)            (SvFLAGS(sv) & (SVs_PADTMP))
1078 #define SvPADSTALE(sv)          (SvFLAGS(sv) & (SVs_PADSTALE))
1079
1080 #define SvPADTMP_on(sv)         (SvFLAGS(sv) |= SVs_PADTMP)
1081 #define SvPADTMP_off(sv)        (SvFLAGS(sv) &= ~SVs_PADTMP)
1082 #define SvPADSTALE_on(sv)       S_SvPADSTALE_on(MUTABLE_SV(sv))
1083 #define SvPADSTALE_off(sv)      S_SvPADSTALE_off(MUTABLE_SV(sv))
1084
1085 #define SvTEMP(sv)              (SvFLAGS(sv) & SVs_TEMP)
1086 #define SvTEMP_on(sv)           (SvFLAGS(sv) |= SVs_TEMP)
1087 #define SvTEMP_off(sv)          (SvFLAGS(sv) &= ~SVs_TEMP)
1088
1089 #define SvOBJECT(sv)            (SvFLAGS(sv) & SVs_OBJECT)
1090 #define SvOBJECT_on(sv)         (SvFLAGS(sv) |= SVs_OBJECT)
1091 #define SvOBJECT_off(sv)        (SvFLAGS(sv) &= ~SVs_OBJECT)
1092
1093 /*
1094 =for apidoc Am|U32|SvREADONLY|SV* sv
1095 Returns true if the argument is readonly, otherwise returns false.
1096 Exposed to to perl code via Internals::SvREADONLY().
1097
1098 =for apidoc Am|U32|SvREADONLY_on|SV* sv
1099 Mark an object as readonly. Exactly what this means depends on the object
1100 type. Exposed to perl code via Internals::SvREADONLY().
1101
1102 =for apidoc Am|U32|SvREADONLY_off|SV* sv
1103 Mark an object as not-readonly. Exactly what this mean depends on the
1104 object type. Exposed to perl code via Internals::SvREADONLY().
1105
1106 =cut
1107 */
1108
1109 #define SvREADONLY(sv)          (SvFLAGS(sv) & (SVf_READONLY|SVf_PROTECT))
1110 #ifdef PERL_CORE
1111 # define SvREADONLY_on(sv)      (SvFLAGS(sv) |= (SVf_READONLY|SVf_PROTECT))
1112 # define SvREADONLY_off(sv)     (SvFLAGS(sv) &=~(SVf_READONLY|SVf_PROTECT))
1113 #else
1114 # define SvREADONLY_on(sv)      (SvFLAGS(sv) |= SVf_READONLY)
1115 # define SvREADONLY_off(sv)     (SvFLAGS(sv) &= ~SVf_READONLY)
1116 #endif
1117
1118 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1119 #define SvSCREAM_on(sv)         (SvFLAGS(sv) |= SVp_SCREAM)
1120 #define SvSCREAM_off(sv)        (SvFLAGS(sv) &= ~SVp_SCREAM)
1121
1122 #ifndef PERL_CORE
1123 #  define SvCOMPILED(sv)        0
1124 #  define SvCOMPILED_on(sv)
1125 #  define SvCOMPILED_off(sv)
1126 #endif
1127
1128 #define SvEVALED(sv)            (SvFLAGS(sv) & SVrepl_EVAL)
1129 #define SvEVALED_on(sv)         (SvFLAGS(sv) |= SVrepl_EVAL)
1130 #define SvEVALED_off(sv)        (SvFLAGS(sv) &= ~SVrepl_EVAL)
1131
1132 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1133 #  define SvVALID(sv)           ({ const SV *const _svvalid = (const SV*)(sv); \
1134                                    if (SvFLAGS(_svvalid) & SVpbm_VALID && !SvSCREAM(_svvalid)) \
1135                                        assert(!isGV_with_GP(_svvalid)); \
1136                                    (SvFLAGS(_svvalid) & SVpbm_VALID);   \
1137                                 })
1138 #  define SvVALID_on(sv)        ({ SV *const _svvalid = MUTABLE_SV(sv); \
1139                                    assert(!isGV_with_GP(_svvalid));     \
1140                                    assert(!SvSCREAM(_svvalid));         \
1141                                    (SvFLAGS(_svvalid) |= SVpbm_VALID);  \
1142                                 })
1143 #  define SvVALID_off(sv)       ({ SV *const _svvalid = MUTABLE_SV(sv); \
1144                                    assert(!isGV_with_GP(_svvalid));     \
1145                                    assert(!SvSCREAM(_svvalid));         \
1146                                    (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
1147                                 })
1148
1149 #  define SvTAIL(sv)    ({ const SV *const _svtail = (const SV *)(sv);  \
1150                             assert(SvTYPE(_svtail) != SVt_PVAV);        \
1151                             assert(SvTYPE(_svtail) != SVt_PVHV);        \
1152                             assert(!SvSCREAM(_svtail));                 \
1153                             (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID))    \
1154                                 == (SVpbm_TAIL|SVpbm_VALID);            \
1155                         })
1156 #else
1157 #  define SvVALID(sv)           ((SvFLAGS(sv) & SVpbm_VALID) && !SvSCREAM(sv))
1158 #  define SvVALID_on(sv)        (SvFLAGS(sv) |= SVpbm_VALID)
1159 #  define SvVALID_off(sv)       (SvFLAGS(sv) &= ~SVpbm_VALID)
1160 #  define SvTAIL(sv)        ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID))   \
1161                              == (SVpbm_TAIL|SVpbm_VALID))
1162
1163 #endif
1164 #define SvTAIL_on(sv)           (SvFLAGS(sv) |= SVpbm_TAIL)
1165 #define SvTAIL_off(sv)          (SvFLAGS(sv) &= ~SVpbm_TAIL)
1166
1167 #define SvRVx(sv) SvRV(sv)
1168
1169 #ifdef PERL_DEBUG_COW
1170 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1171    +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1172 #  define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1173 #  define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1174 #  define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1175 #  define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1176 #  define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1177 /* Don't test the core XS code yet.  */
1178 #  if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1179 #    define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
1180 #  else
1181 #  define SvPVX(sv) SvPVX_mutable(sv)
1182 #  endif
1183 #  define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1184 #  define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1185 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1186
1187 #  define SvMAGIC(sv)   (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic))
1188 #  define SvSTASH(sv)   (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*)  SvANY(sv))->xmg_stash))
1189 #else
1190 #  define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1191 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1192
1193 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1194 /* These get expanded inside other macros that already use a variable _sv  */
1195 #    define SvPVX(sv)                                                   \
1196         (*({ SV *const _svpvx = MUTABLE_SV(sv);                         \
1197             assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]);      \
1198             assert(!isGV_with_GP(_svpvx));                              \
1199             assert(!(SvTYPE(_svpvx) == SVt_PVIO                         \
1200                      && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP)));           \
1201             &((_svpvx)->sv_u.svu_pv);                                   \
1202          }))
1203 #    define SvCUR(sv)                                                   \
1204         (*({ const SV *const _svcur = (const SV *)(sv);                 \
1205             assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK]        \
1206                 || SvTYPE(_svcur) == SVt_REGEXP);                       \
1207             assert(!isGV_with_GP(_svcur));                              \
1208             assert(!(SvTYPE(_svcur) == SVt_PVIO                         \
1209                      && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP)));           \
1210             &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur);            \
1211          }))
1212 #    define SvIVX(sv)                                                   \
1213         (*({ const SV *const _svivx = (const SV *)(sv);                 \
1214             assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]);      \
1215             assert(!isGV_with_GP(_svivx));                              \
1216             &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv);           \
1217          }))
1218 #    define SvUVX(sv)                                                   \
1219         (*({ const SV *const _svuvx = (const SV *)(sv);                 \
1220             assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]);      \
1221             assert(!isGV_with_GP(_svuvx));                              \
1222             &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv);           \
1223          }))
1224 #    define SvNVX(sv)                                                   \
1225         (*({ const SV *const _svnvx = (const SV *)(sv);                 \
1226             assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]);      \
1227             assert(!isGV_with_GP(_svnvx));                              \
1228             &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv);     \
1229          }))
1230 #    define SvRV(sv)                                                    \
1231         (*({ SV *const _svrv = MUTABLE_SV(sv);                          \
1232             assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]);        \
1233             assert(!isGV_with_GP(_svrv));                               \
1234             assert(!(SvTYPE(_svrv) == SVt_PVIO                          \
1235                      && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP)));            \
1236             &((_svrv)->sv_u.svu_rv);                                    \
1237          }))
1238 #    define SvRV_const(sv)                                              \
1239         ({ const SV *const _svrv = (const SV *)(sv);                    \
1240             assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]);        \
1241             assert(!isGV_with_GP(_svrv));                               \
1242             assert(!(SvTYPE(_svrv) == SVt_PVIO                          \
1243                      && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP)));            \
1244             (_svrv)->sv_u.svu_rv;                                       \
1245          })
1246 #    define SvMAGIC(sv)                                                 \
1247         (*({ const SV *const _svmagic = (const SV *)(sv);               \
1248             assert(SvTYPE(_svmagic) >= SVt_PVMG);                       \
1249             &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1250           }))
1251 #    define SvSTASH(sv)                                                 \
1252         (*({ const SV *const _svstash = (const SV *)(sv);               \
1253             assert(SvTYPE(_svstash) >= SVt_PVMG);                       \
1254             &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash);      \
1255           }))
1256 #  else
1257 #    define SvPVX(sv) ((sv)->sv_u.svu_pv)
1258 #    define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1259 #    define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1260 #    define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1261 #    define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1262 #    define SvRV(sv) ((sv)->sv_u.svu_rv)
1263 #    define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1264 #    define SvMAGIC(sv) ((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic
1265 #    define SvSTASH(sv) ((XPVMG*)  SvANY(sv))->xmg_stash
1266 #  endif
1267 #endif
1268
1269 #ifndef PERL_POISON
1270 /* Given that these two are new, there can't be any existing code using them
1271  *  as LVALUEs  */
1272 #  define SvPVX_mutable(sv)     (0 + (sv)->sv_u.svu_pv)
1273 #  define SvPVX_const(sv)       ((const char*)(0 + (sv)->sv_u.svu_pv))
1274 #else
1275 /* Except for the poison code, which uses & to scribble over the pointer after
1276    free() is called.  */
1277 #  define SvPVX_mutable(sv)     ((sv)->sv_u.svu_pv)
1278 #  define SvPVX_const(sv)       ((const char*)((sv)->sv_u.svu_pv))
1279 #endif
1280
1281 #define SvIVXx(sv) SvIVX(sv)
1282 #define SvUVXx(sv) SvUVX(sv)
1283 #define SvNVXx(sv) SvNVX(sv)
1284 #define SvPVXx(sv) SvPVX(sv)
1285 #define SvLENx(sv) SvLEN(sv)
1286 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1287
1288
1289 /* Ask a scalar nicely to try to become an IV, if possible.
1290    Not guaranteed to stay returning void */
1291 /* Macro won't actually call sv_2iv if already IOK */
1292 #define SvIV_please(sv) \
1293         STMT_START {if (!SvIOKp(sv) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK))) \
1294                 (void) SvIV(sv); } STMT_END
1295 #define SvIV_please_nomg(sv) \
1296         (!(SvFLAGS(sv) & (SVf_IOK|SVp_IOK)) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK)) \
1297             ? (sv_2iv_flags(sv, 0), SvIOK(sv))    \
1298             : SvIOK(sv))
1299 #define SvIV_set(sv, val) \
1300         STMT_START { \
1301                 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]);   \
1302                 assert(!isGV_with_GP(sv));              \
1303                 (((XPVIV*)  SvANY(sv))->xiv_iv = (val)); } STMT_END
1304 #define SvNV_set(sv, val) \
1305         STMT_START { \
1306                 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]);   \
1307                 assert(!isGV_with_GP(sv));              \
1308                 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1309 #define SvPV_set(sv, val) \
1310         STMT_START { \
1311                 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]);      \
1312                 assert(!isGV_with_GP(sv));              \
1313                 assert(!(SvTYPE(sv) == SVt_PVIO         \
1314                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1315                 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1316 #define SvUV_set(sv, val) \
1317         STMT_START { \
1318                 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]);   \
1319                 assert(!isGV_with_GP(sv));              \
1320                 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1321 #define SvRV_set(sv, val) \
1322         STMT_START { \
1323                 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]);       \
1324                 assert(!isGV_with_GP(sv));              \
1325                 assert(!(SvTYPE(sv) == SVt_PVIO         \
1326                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1327                 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1328 #define SvMAGIC_set(sv, val) \
1329         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1330                 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1331 #define SvSTASH_set(sv, val) \
1332         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1333                 (((XPVMG*)  SvANY(sv))->xmg_stash = (val)); } STMT_END
1334 #define SvCUR_set(sv, val) \
1335         STMT_START { \
1336                 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]        \
1337                         || SvTYPE(sv) == SVt_REGEXP);   \
1338                 assert(!isGV_with_GP(sv));              \
1339                 assert(!(SvTYPE(sv) == SVt_PVIO         \
1340                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1341                 (((XPV*)  SvANY(sv))->xpv_cur = (val)); } STMT_END
1342 #define SvLEN_set(sv, val) \
1343         STMT_START { \
1344                 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]);      \
1345                 assert(!isGV_with_GP(sv));      \
1346                 assert(!(SvTYPE(sv) == SVt_PVIO         \
1347                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1348                 (((XPV*)  SvANY(sv))->xpv_len = (val)); } STMT_END
1349 #define SvEND_set(sv, val) \
1350         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1351                 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1352
1353 #define SvPV_renew(sv,n) \
1354         STMT_START { SvLEN_set(sv, n); \
1355                 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char)                 \
1356                                 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1357                                                    (MEM_SIZE)((n)))));  \
1358                  } STMT_END
1359
1360 #define SvPV_shrink_to_cur(sv) STMT_START { \
1361                    const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1362                    SvPV_renew(sv, _lEnGtH); \
1363                  } STMT_END
1364
1365 #define SvPV_free(sv)                                                   \
1366     STMT_START {                                                        \
1367                      assert(SvTYPE(sv) >= SVt_PV);                      \
1368                      if (SvLEN(sv)) {                                   \
1369                          assert(!SvROK(sv));                            \
1370                          if(UNLIKELY(SvOOK(sv))) {                      \
1371                              STRLEN zok;                                \
1372                              SvOOK_offset(sv, zok);                     \
1373                              SvPV_set(sv, SvPVX_mutable(sv) - zok);     \
1374                              SvFLAGS(sv) &= ~SVf_OOK;                   \
1375                          }                                              \
1376                          Safefree(SvPVX(sv));                           \
1377                      }                                                  \
1378                  } STMT_END
1379
1380 #ifdef PERL_CORE
1381 /* Code that crops up in three places to take a scalar and ready it to hold
1382    a reference */
1383 #  define prepare_SV_for_RV(sv)                                         \
1384     STMT_START {                                                        \
1385                     if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV)    \
1386                         sv_upgrade(sv, SVt_IV);                         \
1387                     else if (SvTYPE(sv) >= SVt_PV) {                    \
1388                         SvPV_free(sv);                                  \
1389                         SvLEN_set(sv, 0);                               \
1390                         SvCUR_set(sv, 0);                               \
1391                     }                                                   \
1392                  } STMT_END
1393 #endif
1394
1395 #ifndef PERL_CORE
1396 #  define BmFLAGS(sv)           (SvTAIL(sv) ? FBMcf_TAIL : 0)
1397 #endif
1398
1399 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1400 #  define BmUSEFUL(sv)                                                  \
1401         (*({ SV *const _bmuseful = MUTABLE_SV(sv);                      \
1402             assert(SvTYPE(_bmuseful) >= SVt_PVIV);                      \
1403             assert(SvVALID(_bmuseful));                                 \
1404             assert(!SvIOK(_bmuseful));                                  \
1405             &(((XPVIV*) SvANY(_bmuseful))->xiv_u.xivu_iv);              \
1406          }))
1407 #else
1408 #  define BmUSEFUL(sv)          ((XPVIV*) SvANY(sv))->xiv_u.xivu_iv
1409
1410 #endif
1411
1412 #ifndef PERL_CORE
1413 # define BmRARE(sv)     0
1414 # define BmPREVIOUS(sv) 0
1415 #endif
1416
1417 #define FmLINES(sv)     ((XPVIV*)  SvANY(sv))->xiv_iv
1418
1419 #define LvTYPE(sv)      ((XPVLV*)  SvANY(sv))->xlv_type
1420 #define LvTARG(sv)      ((XPVLV*)  SvANY(sv))->xlv_targ
1421 #define LvTARGOFF(sv)   ((XPVLV*)  SvANY(sv))->xlv_targoff
1422 #define LvSTARGOFF(sv)  ((XPVLV*)  SvANY(sv))->xlv_targoff_u.xlvu_stargoff
1423 #define LvTARGLEN(sv)   ((XPVLV*)  SvANY(sv))->xlv_targlen
1424 #define LvFLAGS(sv)     ((XPVLV*)  SvANY(sv))->xlv_flags
1425
1426 #define IoIFP(sv)       (sv)->sv_u.svu_fp
1427 #define IoOFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ofp
1428 #define IoDIRP(sv)      ((XPVIO*)  SvANY(sv))->xio_dirp
1429 #define IoANY(sv)       ((XPVIO*)  SvANY(sv))->xio_any
1430 #define IoLINES(sv)     ((XPVIO*)  SvANY(sv))->xiv_u.xivu_iv
1431 #define IoPAGE(sv)      ((XPVIO*)  SvANY(sv))->xio_page
1432 #define IoPAGE_LEN(sv)  ((XPVIO*)  SvANY(sv))->xio_page_len
1433 #define IoLINES_LEFT(sv)((XPVIO*)  SvANY(sv))->xio_lines_left
1434 #define IoTOP_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_top_name
1435 #define IoTOP_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_top_gv
1436 #define IoFMT_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_fmt_name
1437 #define IoFMT_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_fmt_gv
1438 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1439 #define IoBOTTOM_GV(sv) ((XPVIO*)  SvANY(sv))->xio_bottom_gv
1440 #define IoTYPE(sv)      ((XPVIO*)  SvANY(sv))->xio_type
1441 #define IoFLAGS(sv)     ((XPVIO*)  SvANY(sv))->xio_flags
1442
1443 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1444 #define IoTYPE_RDONLY           '<'
1445 #define IoTYPE_WRONLY           '>'
1446 #define IoTYPE_RDWR             '+'
1447 #define IoTYPE_APPEND           'a'
1448 #define IoTYPE_PIPE             '|'
1449 #define IoTYPE_STD              '-'     /* stdin or stdout */
1450 #define IoTYPE_SOCKET           's'
1451 #define IoTYPE_CLOSED           ' '
1452 #define IoTYPE_IMPLICIT         'I'     /* stdin or stdout or stderr */
1453 #define IoTYPE_NUMERIC          '#'     /* fdopen */
1454
1455 /*
1456 =for apidoc Am|bool|SvTAINTED|SV* sv
1457 Checks to see if an SV is tainted.  Returns TRUE if it is, FALSE if
1458 not.
1459
1460 =for apidoc Am|void|SvTAINTED_on|SV* sv
1461 Marks an SV as tainted if tainting is enabled.
1462
1463 =for apidoc Am|void|SvTAINTED_off|SV* sv
1464 Untaints an SV.  Be I<very> careful with this routine, as it short-circuits
1465 some of Perl's fundamental security features.  XS module authors should not
1466 use this function unless they fully understand all the implications of
1467 unconditionally untainting the value.  Untainting should be done in the
1468 standard perl fashion, via a carefully crafted regexp, rather than directly
1469 untainting variables.
1470
1471 =for apidoc Am|void|SvTAINT|SV* sv
1472 Taints an SV if tainting is enabled, and if some input to the current
1473 expression is tainted--usually a variable, but possibly also implicit
1474 inputs such as locale settings.  C<SvTAINT> propagates that taintedness to
1475 the outputs of an expression in a pessimistic fashion; i.e., without paying
1476 attention to precisely which outputs are influenced by which inputs.
1477
1478 =cut
1479 */
1480
1481 #define sv_taint(sv)      sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1482
1483 #ifdef NO_TAINT_SUPPORT
1484 #   define SvTAINTED(sv) 0
1485 #else
1486 #   define SvTAINTED(sv)          (SvMAGICAL(sv) && sv_tainted(sv))
1487 #endif
1488 #define SvTAINTED_on(sv)  STMT_START{ if(UNLIKELY(TAINTING_get)){sv_taint(sv);}   }STMT_END
1489 #define SvTAINTED_off(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_untaint(sv);} }STMT_END
1490
1491 #define SvTAINT(sv)                     \
1492     STMT_START {                        \
1493         assert(TAINTING_get || !TAINT_get); \
1494         if (UNLIKELY(TAINT_get))        \
1495             SvTAINTED_on(sv);           \
1496     } STMT_END
1497
1498 /*
1499 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1500 Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1501 only a string (C<SvPOK_only>), by hook or by crook.  You need force if you are
1502 going to update the C<SvPVX> directly.  Processes get magic.
1503
1504 Note that coercing an arbitrary scalar into a plain PV will potentially
1505 strip useful data from it.  For example if the SV was C<SvROK>, then the
1506 referent will have its reference count decremented, and the SV itself may
1507 be converted to an C<SvPOK> scalar with a string buffer containing a value
1508 such as C<"ARRAY(0x1234)">.
1509
1510 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1511 Like C<SvPV_force>, but doesn't process get magic.
1512
1513 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1514 Returns a pointer to the string in the SV, or a stringified form of
1515 the SV if the SV does not contain a string.  The SV may cache the
1516 stringified version becoming C<SvPOK>.  Handles 'get' magic.  The
1517 C<len> variable will be set to the length of the string (this is a macro, so
1518 don't use C<&len>).  See also C<L</SvPVx>> for a version which guarantees to
1519 evaluate C<sv> only once.
1520
1521 Note that there is no guarantee that the return value of C<SvPV()> is
1522 equal to C<SvPVX(sv)>, or that C<SvPVX(sv)> contains valid data, or that
1523 successive calls to C<SvPV(sv)> will return the same pointer value each
1524 time.  This is due to the way that things like overloading and
1525 Copy-On-Write are handled.  In these cases, the return value may point to
1526 a temporary buffer or similar.  If you absolutely need the C<SvPVX> field to
1527 be valid (for example, if you intend to write to it), then see
1528 C<L</SvPV_force>>.
1529
1530 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1531 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1532 Only use this if C<sv> is an expression with side effects, otherwise use the
1533 more efficient C<SvPV>.
1534
1535 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1536 Like C<SvPV> but doesn't process magic.
1537
1538 =for apidoc Am|char*|SvPV_nolen|SV* sv
1539 Like C<SvPV> but doesn't set a length variable.
1540
1541 =for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1542 Like C<SvPV_nolen> but doesn't process magic.
1543
1544 =for apidoc Am|IV|SvIV|SV* sv
1545 Coerces the given SV to an integer and returns it.  See C<L</SvIVx>> for a
1546 version which guarantees to evaluate C<sv> only once.
1547
1548 =for apidoc Am|IV|SvIV_nomg|SV* sv
1549 Like C<SvIV> but doesn't process magic.
1550
1551 =for apidoc Am|IV|SvIVx|SV* sv
1552 Coerces the given SV to an integer and returns it.
1553 Guarantees to evaluate C<sv> only once.  Only use
1554 this if C<sv> is an expression with side effects,
1555 otherwise use the more efficient C<SvIV>.
1556
1557 =for apidoc Am|NV|SvNV|SV* sv
1558 Coerce the given SV to a double and return it.  See C<L</SvNVx>> for a version
1559 which guarantees to evaluate C<sv> only once.
1560
1561 =for apidoc Am|NV|SvNV_nomg|SV* sv
1562 Like C<SvNV> but doesn't process magic.
1563
1564 =for apidoc Am|NV|SvNVx|SV* sv
1565 Coerces the given SV to a double and returns it.
1566 Guarantees to evaluate C<sv> only once.  Only use
1567 this if C<sv> is an expression with side effects,
1568 otherwise use the more efficient C<SvNV>.
1569
1570 =for apidoc Am|UV|SvUV|SV* sv
1571 Coerces the given SV to an unsigned integer and returns it.  See C<L</SvUVx>>
1572 for a version which guarantees to evaluate C<sv> only once.
1573
1574 =for apidoc Am|UV|SvUV_nomg|SV* sv
1575 Like C<SvUV> but doesn't process magic.
1576
1577 =for apidoc Am|UV|SvUVx|SV* sv
1578 Coerces the given SV to an unsigned integer and
1579 returns it.  Guarantees to evaluate C<sv> only once.  Only
1580 use this if C<sv> is an expression with side effects,
1581 otherwise use the more efficient C<SvUV>.
1582
1583 =for apidoc Am|bool|SvTRUE|SV* sv
1584 Returns a boolean indicating whether Perl would evaluate the SV as true or
1585 false.  See C<L</SvOK>> for a defined/undefined test.  Handles 'get' magic
1586 unless the scalar is already C<SvPOK>, C<SvIOK> or C<SvNOK> (the public, not the
1587 private flags).
1588
1589 =for apidoc Am|bool|SvTRUE_nomg|SV* sv
1590 Returns a boolean indicating whether Perl would evaluate the SV as true or
1591 false.  See C<L</SvOK>> for a defined/undefined test.  Does not handle 'get' magic.
1592
1593 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1594 Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
1595
1596 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1597 Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
1598
1599 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1600 Like C<SvPV_nolen>, but converts C<sv> to UTF-8 first if necessary.
1601
1602 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1603 Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary.
1604
1605 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1606 Like C<SvPV>, but converts C<sv> to byte representation first if necessary.
1607
1608 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1609 Like C<SvPV_nolen>, but converts C<sv> to byte representation first if necessary.
1610
1611 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1612 Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
1613 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVutf8_force>
1614 otherwise.
1615
1616 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1617 Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
1618 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVutf8>
1619 otherwise.
1620
1621 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1622 Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary.
1623 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte_force>
1624 otherwise.
1625
1626 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1627 Like C<SvPV>, but converts C<sv> to byte representation first if necessary.
1628 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte>
1629 otherwise.
1630
1631 =for apidoc Am|U32|SvIsCOW|SV* sv
1632 Returns a U32 value indicating whether the SV is Copy-On-Write (either shared
1633 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1634 COW).
1635
1636 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1637 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1638 scalar.
1639
1640 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1641 Like C<sv_catpvn> but doesn't process magic.
1642
1643 =for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1644 Like C<sv_catpv> but doesn't process magic.
1645
1646 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1647 Like C<sv_setsv> but doesn't process magic.
1648
1649 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1650 Like C<sv_catsv> but doesn't process magic.
1651
1652 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1653
1654 Like C<sv_utf8_upgrade>, but doesn't do magic on C<sv>.
1655
1656 =cut
1657 */
1658
1659 /* Let us hope that bitmaps for UV and IV are the same */
1660 #define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv))
1661 #define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv))
1662 #define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv))
1663
1664 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1665 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1666 #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
1667
1668 /* ----*/
1669
1670 #define SvPV(sv, lp)         SvPV_flags(sv, lp, SV_GMAGIC)
1671 #define SvPV_const(sv, lp)   SvPV_flags_const(sv, lp, SV_GMAGIC)
1672 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1673
1674 #define SvPV_flags(sv, lp, flags) \
1675     (SvPOK_nog(sv) \
1676      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1677 #define SvPV_flags_const(sv, lp, flags) \
1678     (SvPOK_nog(sv) \
1679      ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1680      (const char*) sv_2pv_flags(sv, &lp, (flags|SV_CONST_RETURN)))
1681 #define SvPV_flags_const_nolen(sv, flags) \
1682     (SvPOK_nog(sv) \
1683      ? SvPVX_const(sv) : \
1684      (const char*) sv_2pv_flags(sv, 0, (flags|SV_CONST_RETURN)))
1685 #define SvPV_flags_mutable(sv, lp, flags) \
1686     (SvPOK_nog(sv) \
1687      ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1688      sv_2pv_flags(sv, &lp, (flags|SV_MUTABLE_RETURN)))
1689
1690 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1691 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1692 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1693
1694 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1695 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1696
1697 #define SvPV_force_flags(sv, lp, flags) \
1698     (SvPOK_pure_nogthink(sv) \
1699      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1700
1701 #define SvPV_force_flags_nolen(sv, flags) \
1702     (SvPOK_pure_nogthink(sv) \
1703      ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1704
1705 #define SvPV_force_flags_mutable(sv, lp, flags) \
1706     (SvPOK_pure_nogthink(sv) \
1707      ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1708      : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1709
1710 #define SvPV_nolen(sv) \
1711     (SvPOK_nog(sv) \
1712      ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1713
1714 /* "_nomg" in these defines means no mg_get() */
1715 #define SvPV_nomg_nolen(sv) \
1716     (SvPOK_nog(sv) \
1717      ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1718
1719 #define SvPV_nolen_const(sv) \
1720     (SvPOK_nog(sv) \
1721      ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1722
1723 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1724 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1725 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1726
1727 /* ----*/
1728
1729 #define SvPVutf8(sv, lp) \
1730     (SvPOK_utf8_nog(sv) \
1731      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1732
1733 #define SvPVutf8_force(sv, lp) \
1734     (SvPOK_utf8_pure_nogthink(sv) \
1735      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1736
1737 #define SvPVutf8_nolen(sv) \
1738     (SvPOK_utf8_nog(sv) \
1739      ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1740
1741 /* ----*/
1742
1743 #define SvPVbyte(sv, lp) \
1744     (SvPOK_byte_nog(sv) \
1745      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1746
1747 #define SvPVbyte_force(sv, lp) \
1748     (SvPOK_byte_pure_nogthink(sv) \
1749      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1750
1751 #define SvPVbyte_nolen(sv) \
1752     (SvPOK_byte_nog(sv) \
1753      ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1754
1755
1756 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1757  * var to evaluate the arg once; failing that, use a global if possible;
1758  * failing that, call a function to do the work
1759  */
1760
1761 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1762 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1763 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1764
1765 #define SvTRUE(sv)        (LIKELY(sv) && (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv))))
1766 #define SvTRUE_nomg(sv)   (LIKELY(sv) && (                                SvTRUE_common(sv, sv_2bool_nomg(sv))))
1767 #define SvTRUE_NN(sv)              (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv)))
1768 #define SvTRUE_nomg_NN(sv) (                                        SvTRUE_common(sv, sv_2bool_nomg(sv)))
1769 #define SvTRUE_common(sv,fallback) (                    \
1770       !SvOK(sv)                                         \
1771         ? 0                                             \
1772     : SvPOK(sv)                                         \
1773         ? SvPVXtrue(sv)                                 \
1774     : (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))                 \
1775         ? (   (SvIOK(sv) && SvIVX(sv) != 0)             \
1776            || (SvNOK(sv) && SvNVX(sv) != 0.0))          \
1777     : (fallback))
1778
1779 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1780
1781 #  define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1782 #  define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1783 #  define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1784 #  define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1785 #  define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1786 #  define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1787 #  define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1788 #  define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1789 #  define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1790 #  define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1791 #  define SvTRUEx(sv)      ({SV *_sv = (sv); SvTRUE(_sv); })
1792 #  define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); })
1793
1794 #else /* __GNUC__ */
1795
1796 /* These inlined macros use globals, which will require a thread
1797  * declaration in user code, so we avoid them under threads */
1798
1799 #  define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1800 #  define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1801 #  define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1802 #  define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1803 #  define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1804 #  define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1805 #  define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1806 #  define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1807 #  define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1808 #  define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1809 #  define SvTRUEx(sv)      ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1810 #  define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv))
1811 #endif /* __GNU__ */
1812
1813 #define SvPVXtrue(sv)   (                                       \
1814     ((XPV*)SvANY((sv)))                                         \
1815      && (                                                       \
1816         ((XPV*)SvANY((sv)))->xpv_cur > 1                        \
1817         || (                                                    \
1818             ((XPV*)SvANY((sv)))->xpv_cur                        \
1819             && *(sv)->sv_u.svu_pv != '0'                                \
1820         )                                                       \
1821     )                                                           \
1822 )
1823
1824 #define SvIsCOW(sv)             (SvFLAGS(sv) & SVf_IsCOW)
1825 #define SvIsCOW_on(sv)          (SvFLAGS(sv) |= SVf_IsCOW)
1826 #define SvIsCOW_off(sv)         (SvFLAGS(sv) &= ~SVf_IsCOW)
1827 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1828
1829 #define SvSHARED_HEK_FROM_PV(pvx) \
1830         ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1831 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1832
1833 /* flag values for sv_*_flags functions */
1834 #define SV_IMMEDIATE_UNREF      1
1835 #define SV_GMAGIC               2
1836 #define SV_COW_DROP_PV          4
1837 #define SV_UTF8_NO_ENCODING     8
1838 #define SV_NOSTEAL              16
1839 #define SV_CONST_RETURN         32
1840 #define SV_MUTABLE_RETURN       64
1841 #define SV_SMAGIC               128
1842 #define SV_HAS_TRAILING_NUL     256
1843 #define SV_COW_SHARED_HASH_KEYS 512
1844 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1845 /* XXX This flag actually enabled for any COW.  But it appears not to do
1846        anything.  Can we just remove it?  Or will it serve some future
1847        purpose.  */
1848 #define SV_COW_OTHER_PVS        1024
1849 /* Make sv_2pv_flags return NULL if something is undefined.  */
1850 #define SV_UNDEF_RETURNS_NULL   2048
1851 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1852  * This is used when the caller has already determined it is, and avoids
1853  * redundant work */
1854 #define SV_FORCE_UTF8_UPGRADE   4096
1855 /* if (after resolving magic etc), the SV is found to be overloaded,
1856  * don't call the overload magic, just return as-is */
1857 #define SV_SKIP_OVERLOAD        8192
1858 #define SV_CATBYTES             16384
1859 #define SV_CATUTF8              32768
1860
1861 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1862    So only default to doing the COW setup if we're in the core.
1863  */
1864 #ifdef PERL_CORE
1865 #  ifndef SV_DO_COW_SVSETSV
1866 #    define SV_DO_COW_SVSETSV   SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1867 #  endif
1868 #endif
1869
1870 #ifndef SV_DO_COW_SVSETSV
1871 #  define SV_DO_COW_SVSETSV     0
1872 #endif
1873
1874
1875 #define sv_unref(sv)            sv_unref_flags(sv, 0)
1876 #define sv_force_normal(sv)     sv_force_normal_flags(sv, 0)
1877 #define sv_usepvn(sv, p, l)     sv_usepvn_flags(sv, p, l, 0)
1878 #define sv_usepvn_mg(sv, p, l)  sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1879
1880 /* We are about to replace the SV's current value. So if it's copy on write
1881    we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1882    the value is about to get thrown away, so drop the PV rather than go to
1883    the effort of making a read-write copy only for it to get immediately
1884    discarded.  */
1885
1886 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1887                                     sv_force_normal_flags(sv, SV_COW_DROP_PV)
1888
1889 #ifdef PERL_COPY_ON_WRITE
1890 #   define SvCANCOW(sv)                                     \
1891         (SvIsCOW(sv)                                         \
1892          ? SvLEN(sv) ? CowREFCNT(sv) != SV_COW_REFCNT_MAX : 1 \
1893          : (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS       \
1894                             && SvCUR(sv)+1 < SvLEN(sv))
1895    /* Note: To allow 256 COW "copies", a refcnt of 0 means 1. */
1896 #   define CowREFCNT(sv)        (*(U8 *)(SvPVX(sv)+SvLEN(sv)-1))
1897 #   define SV_COW_REFCNT_MAX    ((1 << sizeof(U8)*8) - 1)
1898 #   define CAN_COW_MASK (SVf_POK|SVf_ROK|SVp_POK|SVf_FAKE| \
1899                          SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_PROTECT)
1900 #endif
1901
1902 #define CAN_COW_FLAGS   (SVp_POK|SVf_POK)
1903
1904 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1905                                     sv_force_normal_flags(sv, 0)
1906
1907
1908 /* all these 'functions' are now just macros */
1909
1910 #define sv_pv(sv) SvPV_nolen(sv)
1911 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1912 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1913
1914 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1915 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1916 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1917 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1918 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
1919 #define sv_setsv(dsv, ssv) \
1920         sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1921 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1922 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1923 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1924 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1925 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1926 #define sv_catpvn_mg(sv, sstr, slen) sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1927 #define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
1928 #define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
1929 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1930 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1931 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1932 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1933 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1934 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1935 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1936 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1937 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1938 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1939 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
1940 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1941 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
1942 #define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
1943 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
1944 #define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
1945 #define sv_insert(bigstr, offset, len, little, littlelen)               \
1946         Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little),  \
1947                              (littlelen), SV_GMAGIC)
1948 #define sv_mortalcopy(sv) \
1949         Perl_sv_mortalcopy_flags(aTHX_ sv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1950 #define sv_cathek(sv,hek)                                           \
1951         STMT_START {                                                 \
1952             HEK * const bmxk = hek;                                   \
1953             sv_catpvn_flags(sv, HEK_KEY(bmxk), HEK_LEN(bmxk),          \
1954                             HEK_UTF8(bmxk) ? SV_CATUTF8 : SV_CATBYTES); \
1955         } STMT_END
1956
1957 /* Should be named SvCatPVN_utf8_upgrade? */
1958 #define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv)       \
1959         STMT_START {                                    \
1960             if (!(nsv))                                 \
1961                 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP);     \
1962             else                                        \
1963                 sv_setpvn(nsv, sstr, slen);             \
1964             SvUTF8_off(nsv);                            \
1965             sv_utf8_upgrade(nsv);                       \
1966             sv_catsv_nomg(dsv, nsv);                    \
1967         } STMT_END
1968 #define sv_catpvn_nomg_maybeutf8(dsv, sstr, slen, is_utf8) \
1969         sv_catpvn_flags(dsv, sstr, slen, (is_utf8)?SV_CATUTF8:SV_CATBYTES)
1970
1971 #if defined(PERL_CORE) || defined(PERL_EXT)
1972 # define sv_or_pv_len_utf8(sv, pv, bytelen)           \
1973     (SvGAMAGIC(sv)                                     \
1974         ? utf8_length((U8 *)(pv), (U8 *)(pv)+(bytelen)) \
1975         : sv_len_utf8(sv))
1976 #endif
1977
1978 /*
1979 =for apidoc Am|SV*|newRV_inc|SV* sv
1980
1981 Creates an RV wrapper for an SV.  The reference count for the original SV is
1982 incremented.
1983
1984 =cut
1985 */
1986
1987 #define newRV_inc(sv)   newRV(sv)
1988
1989 /* the following macros update any magic values this C<sv> is associated with */
1990
1991 /*
1992 =head1 Magical Functions
1993
1994 =for apidoc Am|void|SvGETMAGIC|SV* sv
1995 Invokes C<mg_get> on an SV if it has 'get' magic.  For example, this
1996 will call C<FETCH> on a tied variable.  This macro evaluates its
1997 argument more than once.
1998
1999 =for apidoc Am|void|SvSETMAGIC|SV* sv
2000 Invokes C<mg_set> on an SV if it has 'set' magic.  This is necessary
2001 after modifying a scalar, in case it is a magical variable like C<$|>
2002 or a tied variable (it calls C<STORE>).  This macro evaluates its
2003 argument more than once.
2004
2005 =for apidoc Am|void|SvSetSV|SV* dsv|SV* ssv
2006 Calls C<sv_setsv> if C<dsv> is not the same as C<ssv>.  May evaluate arguments
2007 more than once.  Does not handle 'set' magic on the destination SV.
2008
2009 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
2010 Calls a non-destructive version of C<sv_setsv> if C<dsv> is not the same as
2011 C<ssv>.  May evaluate arguments more than once.
2012
2013 =for apidoc Am|void|SvSetMagicSV|SV* dsv|SV* ssv
2014 Like C<SvSetSV>, but does any set magic required afterwards.
2015
2016 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
2017 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2018
2019 =for apidoc Am|void|SvSHARE|SV* sv
2020 Arranges for C<sv> to be shared between threads if a suitable module
2021 has been loaded.
2022
2023 =for apidoc Am|void|SvLOCK|SV* sv
2024 Arranges for a mutual exclusion lock to be obtained on C<sv> if a suitable module
2025 has been loaded.
2026
2027 =for apidoc Am|void|SvUNLOCK|SV* sv
2028 Releases a mutual exclusion lock on C<sv> if a suitable module
2029 has been loaded.
2030
2031 =head1 SV Manipulation Functions
2032
2033 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
2034 Expands the character buffer in the SV so that it has room for the
2035 indicated number of bytes (remember to reserve space for an extra trailing
2036 C<NUL> character).  Calls C<sv_grow> to perform the expansion if necessary.
2037 Returns a pointer to the character
2038 buffer.  SV must be of type >= C<SVt_PV>.  One
2039 alternative is to call C<sv_grow> if you are not sure of the type of SV.
2040
2041 =cut
2042 */
2043
2044 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
2045 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
2046 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
2047 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
2048
2049 #define SvGETMAGIC(x) ((void)(UNLIKELY(SvGMAGICAL(x)) && mg_get(x)))
2050 #define SvSETMAGIC(x) STMT_START { if (UNLIKELY(SvSMAGICAL(x))) mg_set(x); } STMT_END
2051
2052 #define SvSetSV_and(dst,src,finally) \
2053         STMT_START {                                    \
2054             if (LIKELY((dst) != (src))) {               \
2055                 sv_setsv(dst, src);                     \
2056                 finally;                                \
2057             }                                           \
2058         } STMT_END
2059 #define SvSetSV_nosteal_and(dst,src,finally) \
2060         STMT_START {                                    \
2061             if (LIKELY((dst) != (src))) {                       \
2062                 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV);   \
2063                 finally;                                \
2064             }                                           \
2065         } STMT_END
2066
2067 #define SvSetSV(dst,src) \
2068                 SvSetSV_and(dst,src,/*nothing*/;)
2069 #define SvSetSV_nosteal(dst,src) \
2070                 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
2071
2072 #define SvSetMagicSV(dst,src) \
2073                 SvSetSV_and(dst,src,SvSETMAGIC(dst))
2074 #define SvSetMagicSV_nosteal(dst,src) \
2075                 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
2076
2077
2078 #if !defined(SKIP_DEBUGGING)
2079 #define SvPEEK(sv) sv_peek(sv)
2080 #else
2081 #define SvPEEK(sv) ""
2082 #endif
2083
2084 #define SvIMMORTAL(sv) (SvREADONLY(sv) && ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder))
2085
2086 #ifdef DEBUGGING
2087    /* exercise the immortal resurrection code in sv_free2() */
2088 #  define SvREFCNT_IMMORTAL 1000
2089 #else
2090 #  define SvREFCNT_IMMORTAL ((~(U32)0)/2)
2091 #endif
2092
2093 /*
2094 =for apidoc Am|SV *|boolSV|bool b
2095
2096 Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
2097
2098 See also C<L</PL_sv_yes>> and C<L</PL_sv_no>>.
2099
2100 =cut
2101 */
2102
2103 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2104
2105 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2106 /* If I give every macro argument a different name, then there won't be bugs
2107    where nested macros get confused. Been there, done that.  */
2108 #define isGV_with_GP(pwadak) \
2109         (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP)   \
2110         && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2111 #define isGV_with_GP_on(sv)     STMT_START {                           \
2112         assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2113         assert (!SvPOKp(sv));                                          \
2114         assert (!SvIOKp(sv));                                          \
2115         (SvFLAGS(sv) |= SVpgv_GP);                                     \
2116     } STMT_END
2117 #define isGV_with_GP_off(sv)    STMT_START {                           \
2118         assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2119         assert (!SvPOKp(sv));                                          \
2120         assert (!SvIOKp(sv));                                          \
2121         (SvFLAGS(sv) &= ~SVpgv_GP);                                    \
2122     } STMT_END
2123 #define isREGEXP(sv) \
2124     (SvTYPE(sv) == SVt_REGEXP                                 \
2125      || (SvFLAGS(sv) & (SVTYPEMASK|SVp_POK|SVpgv_GP|SVf_FAKE)) \
2126          == (SVt_PVLV|SVf_FAKE))
2127
2128
2129 #ifdef PERL_ANY_COW
2130 # define SvGROW(sv,len) \
2131         (SvIsCOW(sv) || SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2132 #else
2133 # define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2134 #endif
2135 #define SvGROW_mutable(sv,len) \
2136     (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2137 #define Sv_Grow sv_grow
2138
2139 #define CLONEf_COPY_STACKS 1
2140 #define CLONEf_KEEP_PTR_TABLE 2
2141 #define CLONEf_CLONE_HOST 4
2142 #define CLONEf_JOIN_IN 8
2143
2144 struct clone_params {
2145   AV* stashes;
2146   UV  flags;
2147   PerlInterpreter *proto_perl;
2148   PerlInterpreter *new_perl;
2149   AV *unreferenced;
2150 };
2151
2152 /*
2153 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2154
2155 Creates a new SV and copies a string (which may contain C<NUL> (C<\0>)
2156 characters) into it.  If C<utf8> is true, calls
2157 C<SvUTF8_on> on the new SV.  Implemented as a wrapper around C<newSVpvn_flags>.
2158
2159 =cut
2160 */
2161
2162 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2163
2164 /*
2165 =for apidoc Amx|SV*|newSVpadname|PADNAME *pn
2166
2167 Creates a new SV containing the pad name.
2168
2169 =cut
2170 */
2171
2172 #define newSVpadname(pn) newSVpvn_utf8(PadnamePV(pn), PadnameLEN(pn), TRUE)
2173
2174 /*
2175 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2176
2177 Reads into C<len> the offset from C<SvPVX> back to the true start of the
2178 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2179 efficiently remove characters from start of the buffer.  Implemented as a
2180 macro, which takes the address of C<len>, which must be of type C<STRLEN>.
2181 Evaluates C<sv> more than once.  Sets C<len> to 0 if C<SvOOK(sv)> is false.
2182
2183 =cut
2184 */
2185
2186 #ifdef DEBUGGING
2187 /* Does the bot know something I don't?
2188 10:28 <@Nicholas> metabatman
2189 10:28 <+meta> Nicholas: crash
2190 */
2191 #  define SvOOK_offset(sv, offset) STMT_START {                         \
2192         assert(sizeof(offset) == sizeof(STRLEN));                       \
2193         if (SvOOK(sv)) {                                                \
2194             const U8 *_crash = (U8*)SvPVX_const(sv);                    \
2195             (offset) = *--_crash;                                       \
2196             if (!(offset)) {                                            \
2197                 _crash -= sizeof(STRLEN);                               \
2198                 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8);      \
2199             }                                                           \
2200             {                                                           \
2201                 /* Validate the preceding buffer's sentinels to         \
2202                    verify that no-one is using it.  */                  \
2203                 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2204                 while (_crash > _bonk) {                                \
2205                     --_crash;                                           \
2206                     assert (*_crash == (U8)PTR2UV(_crash));             \
2207                 }                                                       \
2208             }                                                           \
2209         } else {                                                        \
2210             (offset) = 0;                                               \
2211         }                                                               \
2212     } STMT_END
2213 #else
2214     /* This is the same code, but avoids using any temporary variables:  */
2215 #  define SvOOK_offset(sv, offset) STMT_START {                         \
2216         assert(sizeof(offset) == sizeof(STRLEN));                       \
2217         if (SvOOK(sv)) {                                                \
2218             (offset) = ((U8*)SvPVX_const(sv))[-1];                      \
2219             if (!(offset)) {                                            \
2220                 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN),              \
2221                      (U8*)&(offset), sizeof(STRLEN), U8);               \
2222             }                                                           \
2223         } else {                                                        \
2224             (offset) = 0;                                               \
2225         }                                                               \
2226     } STMT_END
2227 #endif
2228
2229 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2230
2231 #define SV_CONST(name) \
2232         PL_sv_consts[SV_CONST_##name] \
2233                 ? PL_sv_consts[SV_CONST_##name] \
2234                 : (PL_sv_consts[SV_CONST_##name] = newSVpv_share(#name, 0))
2235
2236 #define SV_CONST_TIESCALAR 0
2237 #define SV_CONST_TIEARRAY 1
2238 #define SV_CONST_TIEHASH 2
2239 #define SV_CONST_TIEHANDLE 3
2240
2241 #define SV_CONST_FETCH 4
2242 #define SV_CONST_FETCHSIZE 5
2243 #define SV_CONST_STORE 6
2244 #define SV_CONST_STORESIZE 7
2245 #define SV_CONST_EXISTS 8
2246
2247 #define SV_CONST_PUSH 9
2248 #define SV_CONST_POP 10
2249 #define SV_CONST_SHIFT 11
2250 #define SV_CONST_UNSHIFT 12
2251 #define SV_CONST_SPLICE 13
2252 #define SV_CONST_EXTEND 14
2253
2254 #define SV_CONST_FIRSTKEY 15
2255 #define SV_CONST_NEXTKEY 16
2256 #define SV_CONST_SCALAR 17
2257
2258 #define SV_CONST_OPEN 18
2259 #define SV_CONST_WRITE 19
2260 #define SV_CONST_PRINT 20
2261 #define SV_CONST_PRINTF 21
2262 #define SV_CONST_READ 22
2263 #define SV_CONST_READLINE 23
2264 #define SV_CONST_GETC 24
2265 #define SV_CONST_SEEK 25
2266 #define SV_CONST_TELL 26
2267 #define SV_CONST_EOF 27
2268 #define SV_CONST_BINMODE 28
2269 #define SV_CONST_FILENO 29
2270 #define SV_CONST_CLOSE 30
2271
2272 #define SV_CONST_DELETE 31
2273 #define SV_CONST_CLEAR 32
2274 #define SV_CONST_UNTIE 33
2275 #define SV_CONST_DESTROY 34
2276
2277 #define SV_CONSTS_COUNT 35
2278
2279 /*
2280  * Bodyless IVs and NVs!
2281  *
2282  * Since 5.9.2, we can avoid allocating a body for SVt_IV-type SVs.
2283  * Since the larger IV-holding variants of SVs store their integer
2284  * values in their respective bodies, the family of SvIV() accessor
2285  * macros would  naively have to branch on the SV type to find the
2286  * integer value either in the HEAD or BODY. In order to avoid this
2287  * expensive branch, a clever soul has deployed a great hack:
2288  * We set up the SvANY pointer such that instead of pointing to a
2289  * real body, it points into the memory before the location of the
2290  * head. We compute this pointer such that the location of
2291  * the integer member of the hypothetical body struct happens to
2292  * be the same as the location of the integer member of the bodyless
2293  * SV head. This now means that the SvIV() family of accessors can
2294  * always read from the (hypothetical or real) body via SvANY.
2295  *
2296  * Since the 5.21 dev series, we employ the same trick for NVs
2297  * if the architecture can support it (NVSIZE <= IVSIZE).
2298  */
2299
2300 /* The following two macros compute the necessary offsets for the above
2301  * trick and store them in SvANY for SvIV() (and friends) to use. */
2302
2303 #ifdef PERL_CORE
2304 #  define SET_SVANY_FOR_BODYLESS_IV(sv) \
2305         SvANY(sv) =   (XPVIV*)((char*)&(sv->sv_u.svu_iv) \
2306                     - STRUCT_OFFSET(XPVIV, xiv_iv))
2307
2308 #  define SET_SVANY_FOR_BODYLESS_NV(sv) \
2309         SvANY(sv) =   (XPVNV*)((char*)&(sv->sv_u.svu_nv) \
2310                     - STRUCT_OFFSET(XPVNV, xnv_u.xnv_nv))
2311 #endif
2312
2313 /*
2314  * ex: set ts=8 sts=4 sw=4 et:
2315  */