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