sv.h

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