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