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