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