sv.h

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