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