sv.h

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