sv.h

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