Magic.xs

   1 /* This file is part of the Variable::Magic Perl module.
   2  * See http://search.cpan.org/dist/Variable-Magic/ */
   3
   4 #include <stdarg.h> /* <va_list>, va_{start,arg,end}, ... */
   5
   6 #include <stdio.h>  /* sprintf() */
   7
   8 #define PERL_NO_GET_CONTEXT
   9 #include "EXTERN.h"
  10 #include "perl.h"
  11 #include "XSUB.h"
  12
  13 #define __PACKAGE__ "Variable::Magic"
  14
  15 #undef VOID2
  16 #ifdef __cplusplus
  17 # define VOID2(T, P) static_cast<T>(P)
  18 #else
  19 # define VOID2(T, P) (P)
  20 #endif
  21
  22 #ifndef VMG_PERL_PATCHLEVEL
  23 # ifdef PERL_PATCHNUM
  24 #  define VMG_PERL_PATCHLEVEL PERL_PATCHNUM
  25 # else
  26 #  define VMG_PERL_PATCHLEVEL 0
  27 # endif
  28 #endif
  29
  30 #define VMG_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  31
  32 #define VMG_HAS_PERL_BRANCH(R, V, S) (PERL_REVISION == (R) && PERL_VERSION == (V) && PERL_SUBVERSION >= (S))
  33
  34 #define VMG_HAS_PERL_MAINT(R, V, S, P) (PERL_REVISION == (R) && PERL_VERSION == (V) && (VMG_PERL_PATCHLEVEL >= (P) || (!VMG_PERL_PATCHLEVEL && PERL_SUBVERSION >= (S))))
  35
  36 /* --- Threads and multiplicity -------------------------------------------- */
  37
  38 #ifndef NOOP
  39 # define NOOP
  40 #endif
  41
  42 #ifndef dNOOP
  43 # define dNOOP
  44 #endif
  45
  46 /* Safe unless stated otherwise in Makefile.PL */
  47 #ifndef VMG_FORKSAFE
  48 # define VMG_FORKSAFE 1
  49 #endif
  50
  51 #ifndef VMG_MULTIPLICITY
  52 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
  53 #  define VMG_MULTIPLICITY 1
  54 # else
  55 #  define VMG_MULTIPLICITY 0
  56 # endif
  57 #endif
  58
  59 #if VMG_MULTIPLICITY && defined(USE_ITHREADS) && defined(dMY_CXT) && defined(MY_CXT) && defined(START_MY_CXT) && defined(MY_CXT_INIT) && (defined(MY_CXT_CLONE) || defined(dMY_CXT_SV))
  60 # define VMG_THREADSAFE 1
  61 # ifndef MY_CXT_CLONE
  62 #  define MY_CXT_CLONE \
  63     dMY_CXT_SV;                                                      \
  64     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
  65     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
  66     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
  67 # endif
  68 #else
  69 # define VMG_THREADSAFE 0
  70 # undef  dMY_CXT
  71 # define dMY_CXT      dNOOP
  72 # undef  MY_CXT
  73 # define MY_CXT       vmg_globaldata
  74 # undef  START_MY_CXT
  75 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
  76 # undef  MY_CXT_INIT
  77 # define MY_CXT_INIT  NOOP
  78 # undef  MY_CXT_CLONE
  79 # define MY_CXT_CLONE NOOP
  80 #endif
  81
  82 #if VMG_THREADSAFE
  83 # define VMG_LOCK(M)   MUTEX_LOCK(M)
  84 # define VMG_UNLOCK(M) MUTEX_UNLOCK(M)
  85 #else
  86 # define VMG_LOCK(M)
  87 # define VMG_UNLOCK(M)
  88 #endif
  89
  90 /* --- Compatibility ------------------------------------------------------- */
  91
  92 #ifndef Newx
  93 # define Newx(v, n, c) New(0, v, n, c)
  94 #endif
  95
  96 #ifndef SvMAGIC_set
  97 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
  98 #endif
  99
 100 #ifndef SvRV_const
 101 # define SvRV_const(sv) SvRV((SV *) sv)
 102 #endif
 103
 104 #ifndef SvREFCNT_inc_simple_void
 105 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
 106 #endif
 107
 108 #ifndef mPUSHu
 109 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
 110 #endif
 111
 112 #ifndef PERL_MAGIC_ext
 113 # define PERL_MAGIC_ext '~'
 114 #endif
 115
 116 #ifndef PERL_MAGIC_tied
 117 # define PERL_MAGIC_tied 'P'
 118 #endif
 119
 120 #ifndef MGf_LOCAL
 121 # define MGf_LOCAL 0
 122 #endif
 123
 124 #ifndef IN_PERL_COMPILETIME
 125 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
 126 #endif
 127
 128 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but we only
 129  * enable them on 5.10 */
 130 #if VMG_HAS_PERL(5, 10, 0)
 131 # define VMG_UVAR 1
 132 #else
 133 # define VMG_UVAR 0
 134 #endif
 135
 136 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969) || VMG_HAS_PERL(5, 12, 0)
 137 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
 138 #else
 139 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
 140 #endif
 141
 142 #if VMG_HAS_PERL(5, 17, 4)
 143 # define VMG_COMPAT_SCALAR_NOLEN 1
 144 #else
 145 # define VMG_COMPAT_SCALAR_NOLEN 0
 146 #endif
 147
 148 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
 149  * reverted to dev-5.11 as 9cdcb38b */
 150 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
 151 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
 152 #  if VMG_HAS_PERL(5, 11, 0)
 153 #   define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
 154 #  else
 155 #   define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
 156 #  endif
 157 # endif
 158 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
 159 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
 160 # endif
 161 #else
 162 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
 163 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
 164 # endif
 165 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
 166 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
 167 # endif
 168 #endif
 169
 170 /* Applied to dev-5.11 as 34908 */
 171 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908) || VMG_HAS_PERL(5, 12, 0)
 172 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
 173 #else
 174 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
 175 #endif
 176
 177 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
 178 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
 179 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
 180 #else
 181 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
 182 #endif
 183
 184 #if VMG_HAS_PERL(5, 11, 0)
 185 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 1
 186 #else
 187 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 0
 188 #endif
 189
 190 #if VMG_HAS_PERL(5, 17, 0)
 191 # define VMG_COMPAT_CODE_COPY_CLONE 1
 192 #else
 193 # define VMG_COMPAT_CODE_COPY_CLONE 0
 194 #endif
 195
 196 #if VMG_HAS_PERL(5, 13, 2)
 197 # define VMG_COMPAT_GLOB_GET 1
 198 #else
 199 # define VMG_COMPAT_GLOB_GET 0
 200 #endif
 201
 202 #define VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE (VMG_HAS_PERL(5, 10, 0) && !VMG_HAS_PERL(5, 10, 1))
 203
 204 /* NewOp() isn't public in perl 5.8.0. */
 205 #define VMG_RESET_RMG_NEEDS_TRAMPOLINE (VMG_UVAR && (VMG_THREADSAFE || !VMG_HAS_PERL(5, 8, 1)))
 206
 207 /* ... Bug-free mg_magical ................................................. */
 208
 209 /* See the discussion at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html */
 210
 211 #if VMG_HAS_PERL(5, 11, 3)
 212
 213 #define vmg_mg_magical(S) mg_magical(S)
 214
 215 #else
 216
 217 static void vmg_mg_magical(SV *sv) {
 218  const MAGIC *mg;
 219
 220  SvMAGICAL_off(sv);
 221  if ((mg = SvMAGIC(sv))) {
 222   do {
 223    const MGVTBL* const vtbl = mg->mg_virtual;
 224    if (vtbl) {
 225     if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
 226      SvGMAGICAL_on(sv);
 227     if (vtbl->svt_set)
 228      SvSMAGICAL_on(sv);
 229     if (vtbl->svt_clear)
 230      SvRMAGICAL_on(sv);
 231    }
 232   } while ((mg = mg->mg_moremagic));
 233   if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
 234    SvRMAGICAL_on(sv);
 235  }
 236 }
 237
 238 #endif
 239
 240 /* --- Trampoline ops ------------------------------------------------------ */
 241
 242 #define VMG_NEEDS_TRAMPOLINE VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE || VMG_RESET_RMG_NEEDS_TRAMPOLINE
 243
 244 #if VMG_NEEDS_TRAMPOLINE
 245
 246 typedef struct {
 247  OP   temp;
 248  SVOP target;
 249 } vmg_trampoline;
 250
 251 static void vmg_trampoline_init(vmg_trampoline *t, OP *(*cb)(pTHX)) {
 252  t->temp.op_type    = OP_STUB;
 253  t->temp.op_ppaddr  = 0;
 254  t->temp.op_next    = (OP *) &t->target;
 255  t->temp.op_flags   = 0;
 256  t->temp.op_private = 0;
 257
 258  t->target.op_type    = OP_STUB;
 259  t->target.op_ppaddr  = cb;
 260  t->target.op_next    = NULL;
 261  t->target.op_flags   = 0;
 262  t->target.op_private = 0;
 263  t->target.op_sv      = NULL;
 264 }
 265
 266 static OP *vmg_trampoline_bump(pTHX_ vmg_trampoline *t, SV *sv, OP *o) {
 267 #define vmg_trampoline_bump(T, S, O) vmg_trampoline_bump(aTHX_ (T), (S), (O))
 268  t->temp         = *o;
 269  t->temp.op_next = (OP *) &t->target;
 270
 271  t->target.op_sv   = sv;
 272  t->target.op_next = o->op_next;
 273
 274  return &t->temp;
 275 }
 276
 277 #endif /* VMG_NEEDS_TRAMPOLINE */
 278
 279 /* --- Cleaner version of sv_magicext() ------------------------------------ */
 280
 281 static MAGIC *vmg_sv_magicext(pTHX_ SV *sv, SV *obj, const MGVTBL *vtbl, const void *ptr, I32 len) {
 282 #define vmg_sv_magicext(S, O, V, P, L) vmg_sv_magicext(aTHX_ (S), (O), (V), (P), (L))
 283  MAGIC *mg;
 284
 285  mg = sv_magicext(sv, obj, PERL_MAGIC_ext, vtbl, ptr, len);
 286  if (!mg)
 287   return NULL;
 288
 289  mg->mg_private = 0;
 290
 291  if (vtbl->svt_copy)
 292   mg->mg_flags |= MGf_COPY;
 293 #if MGf_DUP
 294  if (vtbl->svt_dup)
 295   mg->mg_flags |= MGf_DUP;
 296 #endif /* MGf_DUP */
 297 #if MGf_LOCAL
 298  if (vtbl->svt_local)
 299   mg->mg_flags |= MGf_LOCAL;
 300 #endif /* MGf_LOCAL */
 301
 302  if (mg->mg_flags & MGf_REFCOUNTED)
 303   SvREFCNT_dec(obj);
 304
 305  return mg;
 306 }
 307
 308 /* --- Safe version of call_sv() ------------------------------------------- */
 309
 310 static I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, int (*cleanup)(pTHX_ void *), void *ud) {
 311 #define vmg_call_sv(S, F, C, U) vmg_call_sv(aTHX_ (S), (F), (C), (U))
 312  I32 ret, cxix;
 313  PERL_CONTEXT saved_cx;
 314  SV *old_err = NULL;
 315
 316  if (SvTRUE(ERRSV)) {
 317   old_err = newSVsv(ERRSV);
 318   sv_setsv(ERRSV, &PL_sv_undef);
 319  }
 320
 321  cxix     = (cxstack_ix < cxstack_max) ? (cxstack_ix + 1) : Perl_cxinc(aTHX);
 322  /* The last popped context will be reused by call_sv(), but our callers may
 323   * still need its previous value. Back it up so that it isn't clobbered. */
 324  saved_cx = cxstack[cxix];
 325
 326  ret = call_sv(sv, flags | G_EVAL);
 327
 328  cxstack[cxix] = saved_cx;
 329
 330  if (SvTRUE(ERRSV)) {
 331   SvREFCNT_dec(old_err);
 332
 333   if (IN_PERL_COMPILETIME) {
 334    if (!PL_in_eval) {
 335     if (PL_errors)
 336      sv_catsv(PL_errors, ERRSV);
 337     else
 338      Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
 339     SvCUR_set(ERRSV, 0);
 340    }
 341 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
 342    if (PL_parser)
 343     ++PL_parser->error_count;
 344 #elif defined(PL_error_count)
 345    ++PL_error_count;
 346 #else
 347    ++PL_Ierror_count;
 348 #endif
 349   } else {
 350    if (!cleanup || cleanup(aTHX_ ud))
 351     croak(NULL);
 352   }
 353  } else {
 354   if (old_err) {
 355    sv_setsv(ERRSV, old_err);
 356    SvREFCNT_dec(old_err);
 357   }
 358  }
 359
 360  return ret;
 361 }
 362
 363 /* --- Stolen chunk of B --------------------------------------------------- */
 364
 365 typedef enum {
 366  OPc_NULL,
 367  OPc_BASEOP,
 368  OPc_UNOP,
 369  OPc_BINOP,
 370  OPc_LOGOP,
 371  OPc_LISTOP,
 372  OPc_PMOP,
 373  OPc_SVOP,
 374  OPc_PADOP,
 375  OPc_PVOP,
 376  OPc_LOOP,
 377  OPc_COP,
 378 #if VMG_HAS_PERL(5, 21, 5)
 379  OPc_METHOP,
 380 #endif
 381  OPc_MAX
 382 } opclass;
 383
 384 static const char *const vmg_opclassnames[] = {
 385  "B::NULL",
 386  "B::OP",
 387  "B::UNOP",
 388  "B::BINOP",
 389  "B::LOGOP",
 390  "B::LISTOP",
 391  "B::PMOP",
 392  "B::SVOP",
 393  "B::PADOP",
 394  "B::PVOP",
 395  "B::LOOP",
 396  "B::COP",
 397 #if VMG_HAS_PERL(5, 21, 5)
 398  "B::METHOP",
 399 #endif
 400  NULL
 401 };
 402
 403 static opclass vmg_opclass(const OP *o) {
 404 #if 0
 405  if (!o)
 406   return OPc_NULL;
 407 #endif
 408
 409  if (o->op_type == 0)
 410   return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 411
 412  if (o->op_type == OP_SASSIGN)
 413   return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
 414
 415  if (o->op_type == OP_AELEMFAST) {
 416 #if PERL_VERSION <= 14
 417   if (o->op_flags & OPf_SPECIAL)
 418    return OPc_BASEOP;
 419   else
 420 #endif
 421 #ifdef USE_ITHREADS
 422    return OPc_PADOP;
 423 #else
 424    return OPc_SVOP;
 425 #endif
 426  }
 427
 428 #ifdef USE_ITHREADS
 429  if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
 430   return OPc_PADOP;
 431 #endif
 432
 433  switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
 434   case OA_BASEOP:
 435    return OPc_BASEOP;
 436   case OA_UNOP:
 437    return OPc_UNOP;
 438   case OA_BINOP:
 439    return OPc_BINOP;
 440   case OA_LOGOP:
 441    return OPc_LOGOP;
 442   case OA_LISTOP:
 443    return OPc_LISTOP;
 444   case OA_PMOP:
 445    return OPc_PMOP;
 446   case OA_SVOP:
 447    return OPc_SVOP;
 448   case OA_PADOP:
 449    return OPc_PADOP;
 450   case OA_PVOP_OR_SVOP:
 451    return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
 452   case OA_LOOP:
 453    return OPc_LOOP;
 454   case OA_COP:
 455    return OPc_COP;
 456   case OA_BASEOP_OR_UNOP:
 457    return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 458   case OA_FILESTATOP:
 459    return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
 460 #ifdef USE_ITHREADS
 461            (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
 462 #else
 463            (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
 464 #endif
 465   case OA_LOOPEXOP:
 466    if (o->op_flags & OPf_STACKED)
 467     return OPc_UNOP;
 468    else if (o->op_flags & OPf_SPECIAL)
 469     return OPc_BASEOP;
 470    else
 471     return OPc_PVOP;
 472 #if VMG_HAS_PERL(5, 21, 5)
 473   case OA_METHOP:
 474    return OPc_METHOP;
 475 #endif
 476  }
 477
 478  return OPc_BASEOP;
 479 }
 480
 481 /* --- Error messages ------------------------------------------------------ */
 482
 483 static const char vmg_invalid_wiz[]    = "Invalid wizard object";
 484 static const char vmg_wrongargnum[]    = "Wrong number of arguments";
 485 static const char vmg_argstorefailed[] = "Error while storing arguments";
 486
 487 /* --- Context-safe global data -------------------------------------------- */
 488
 489 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 490
 491 typedef struct {
 492  HV             *b__op_stashes[OPc_MAX];
 493  I32             depth;
 494  MAGIC          *freed_tokens;
 495 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
 496  vmg_trampoline  propagate_errsv;
 497 #endif
 498 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
 499  vmg_trampoline  reset_rmg;
 500 #endif
 501 } my_cxt_t;
 502
 503 START_MY_CXT
 504
 505 /* --- <vmg_vtable> structure ---------------------------------------------- */
 506
 507 #if VMG_THREADSAFE
 508
 509 typedef struct {
 510  MGVTBL *vtbl;
 511  U32     refcount;
 512 } vmg_vtable;
 513
 514 static vmg_vtable *vmg_vtable_alloc(pTHX) {
 515 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
 516  vmg_vtable *t;
 517
 518  t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
 519
 520  t->vtbl     = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
 521  t->refcount = 1;
 522
 523  return t;
 524 }
 525
 526 #define vmg_vtable_vtbl(T) (T)->vtbl
 527
 528 static perl_mutex vmg_vtable_refcount_mutex;
 529
 530 static vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
 531 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
 532  VMG_LOCK(&vmg_vtable_refcount_mutex);
 533  ++t->refcount;
 534  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
 535
 536  return t;
 537 }
 538
 539 static void vmg_vtable_free(pTHX_ vmg_vtable *t) {
 540 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
 541  U32 refcount;
 542
 543  VMG_LOCK(&vmg_vtable_refcount_mutex);
 544  refcount = --t->refcount;
 545  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
 546
 547  if (!refcount) {
 548   PerlMemShared_free(t->vtbl);
 549   PerlMemShared_free(t);
 550  }
 551 }
 552
 553 #else /* VMG_THREADSAFE */
 554
 555 typedef MGVTBL vmg_vtable;
 556
 557 static vmg_vtable *vmg_vtable_alloc(pTHX) {
 558 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
 559  vmg_vtable *t;
 560
 561  Newx(t, 1, vmg_vtable);
 562
 563  return t;
 564 }
 565
 566 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
 567
 568 #define vmg_vtable_free(T) Safefree(T)
 569
 570 #endif /* !VMG_THREADSAFE */
 571
 572 /* --- <vmg_wizard> structure ---------------------------------------------- */
 573
 574 typedef struct {
 575  vmg_vtable *vtable;
 576
 577  U8 opinfo;
 578  U8 uvar;
 579
 580  SV *cb_data;
 581  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
 582  SV *cb_copy;
 583  SV *cb_dup;
 584 #if MGf_LOCAL
 585  SV *cb_local;
 586 #endif /* MGf_LOCAL */
 587 #if VMG_UVAR
 588  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
 589 #endif /* VMG_UVAR */
 590 } vmg_wizard;
 591
 592 static void vmg_op_info_init(pTHX_ unsigned int opinfo);
 593
 594 static vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
 595 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
 596  vmg_wizard *w;
 597
 598  Newx(w, 1, vmg_wizard);
 599
 600  w->uvar   = 0;
 601  w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
 602  if (w->opinfo)
 603   vmg_op_info_init(aTHX_ w->opinfo);
 604
 605  w->vtable = vmg_vtable_alloc();
 606
 607  return w;
 608 }
 609
 610 static void vmg_wizard_free(pTHX_ vmg_wizard *w) {
 611 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
 612  if (!w)
 613   return;
 614
 615  /* During global destruction, any of the callbacks may already have been
 616   * freed, so we can't rely on still being able to access them. */
 617  if (!PL_dirty) {
 618   SvREFCNT_dec(w->cb_data);
 619   SvREFCNT_dec(w->cb_get);
 620   SvREFCNT_dec(w->cb_set);
 621   SvREFCNT_dec(w->cb_len);
 622   SvREFCNT_dec(w->cb_clear);
 623   SvREFCNT_dec(w->cb_free);
 624   SvREFCNT_dec(w->cb_copy);
 625 #if 0
 626   SvREFCNT_dec(w->cb_dup);
 627 #endif
 628 #if MGf_LOCAL
 629   SvREFCNT_dec(w->cb_local);
 630 #endif /* MGf_LOCAL */
 631 #if VMG_UVAR
 632   SvREFCNT_dec(w->cb_fetch);
 633   SvREFCNT_dec(w->cb_store);
 634   SvREFCNT_dec(w->cb_exists);
 635   SvREFCNT_dec(w->cb_delete);
 636 #endif /* VMG_UVAR */
 637  }
 638
 639  /* PerlMemShared_free() and Safefree() are still fine during global
 640   * destruction though. */
 641  vmg_vtable_free(w->vtable);
 642  Safefree(w);
 643
 644  return;
 645 }
 646
 647 #if VMG_THREADSAFE
 648
 649 #define VMG_CLONE_CB(N) \
 650  z->cb_ ## N = (w->cb_ ## N) ? SvREFCNT_inc(sv_dup(w->cb_ ## N, params)) \
 651                              : NULL;
 652
 653 static const vmg_wizard *vmg_wizard_dup(pTHX_ const vmg_wizard *w, CLONE_PARAMS *params) {
 654 #define vmg_wizard_dup(W, P) vmg_wizard_dup(aTHX_ (W), (P))
 655  vmg_wizard *z;
 656
 657  if (!w)
 658   return NULL;
 659
 660  Newx(z, 1, vmg_wizard);
 661
 662  z->vtable = vmg_vtable_dup(w->vtable);
 663  z->uvar   = w->uvar;
 664  z->opinfo = w->opinfo;
 665
 666  VMG_CLONE_CB(data);
 667  VMG_CLONE_CB(get);
 668  VMG_CLONE_CB(set);
 669  VMG_CLONE_CB(len);
 670  VMG_CLONE_CB(clear);
 671  VMG_CLONE_CB(free);
 672  VMG_CLONE_CB(copy);
 673  VMG_CLONE_CB(dup);
 674 #if MGf_LOCAL
 675  VMG_CLONE_CB(local);
 676 #endif /* MGf_LOCAL */
 677 #if VMG_UVAR
 678  VMG_CLONE_CB(fetch);
 679  VMG_CLONE_CB(store);
 680  VMG_CLONE_CB(exists);
 681  VMG_CLONE_CB(delete);
 682 #endif /* VMG_UVAR */
 683
 684  return z;
 685 }
 686
 687 #endif /* VMG_THREADSAFE */
 688
 689 #define vmg_wizard_id(W) PTR2IV(vmg_vtable_vtbl((W)->vtable))
 690
 691 /* --- Wizard SV objects --------------------------------------------------- */
 692
 693 static int vmg_wizard_sv_free(pTHX_ SV *sv, MAGIC *mg) {
 694  vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
 695
 696  return 0;
 697 }
 698
 699 #if VMG_THREADSAFE
 700
 701 static int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
 702  mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
 703
 704  return 0;
 705 }
 706
 707 #endif /* VMG_THREADSAFE */
 708
 709 static MGVTBL vmg_wizard_sv_vtbl = {
 710  NULL,               /* get */
 711  NULL,               /* set */
 712  NULL,               /* len */
 713  NULL,               /* clear */
 714  vmg_wizard_sv_free, /* free */
 715  NULL,               /* copy */
 716 #if VMG_THREADSAFE
 717  vmg_wizard_sv_dup,  /* dup */
 718 #else
 719  NULL,               /* dup */
 720 #endif
 721 #if MGf_LOCAL
 722  NULL,               /* local */
 723 #endif /* MGf_LOCAL */
 724 };
 725
 726 static SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
 727 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
 728  SV *wiz;
 729
 730 #if VMG_THREADSAFE
 731  wiz = newSV(0);
 732 #else
 733  wiz = newSViv(PTR2IV(w));
 734 #endif
 735
 736  vmg_sv_magicext(wiz, NULL, &vmg_wizard_sv_vtbl, w, 0);
 737
 738  SvREADONLY_on(wiz);
 739
 740  return wiz;
 741 }
 742
 743 #if VMG_THREADSAFE
 744
 745 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
 746
 747 static const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
 748  MAGIC *mg;
 749
 750  for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
 751   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
 752    return (const vmg_wizard *) mg->mg_ptr;
 753  }
 754
 755  return NULL;
 756 }
 757
 758 #else /* VMG_THREADSAFE */
 759
 760 #define vmg_sv_has_wizard_type(S) SvIOK(S)
 761
 762 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
 763
 764 #endif /* !VMG_THREADSAFE */
 765
 766 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
 767
 768 static const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
 769  if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
 770   SV *sv = (SV *) mg->mg_ptr;
 771
 772   if (vmg_sv_has_wizard_type(sv))
 773    return vmg_wizard_from_sv_nocheck(sv);
 774  }
 775
 776  return NULL;
 777 }
 778
 779 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
 780
 781 /* --- User-level functions implementation --------------------------------- */
 782
 783 static const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
 784  const MAGIC *mg;
 785  IV wid;
 786
 787  if (SvTYPE(sv) < SVt_PVMG)
 788   return NULL;
 789
 790  wid = vmg_wizard_id(w);
 791
 792  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 793   const vmg_wizard *z = vmg_wizard_from_mg(mg);
 794
 795   if (z && vmg_wizard_id(z) == wid)
 796    return mg;
 797  }
 798
 799  return NULL;
 800 }
 801
 802 /* ... Construct private data .............................................. */
 803
 804 static SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
 805 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
 806  I32 i;
 807  SV *nsv;
 808
 809  dSP;
 810
 811  ENTER;
 812  SAVETMPS;
 813
 814  PUSHMARK(SP);
 815  EXTEND(SP, items + 1);
 816  PUSHs(sv_2mortal(newRV_inc(sv)));
 817  for (i = 0; i < items; ++i)
 818   PUSHs(args[i]);
 819  PUTBACK;
 820
 821  vmg_call_sv(ctor, G_SCALAR, 0, NULL);
 822
 823  SPAGAIN;
 824  nsv = POPs;
 825 #if VMG_HAS_PERL(5, 8, 3)
 826  SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
 827 #else
 828  nsv = sv_newref(nsv);          /* Workaround some bug in SvREFCNT_inc() */
 829 #endif
 830  PUTBACK;
 831
 832  FREETMPS;
 833  LEAVE;
 834
 835  return nsv;
 836 }
 837
 838 static SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
 839 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
 840  const MAGIC *mg = vmg_find(sv, w);
 841
 842  return mg ? mg->mg_obj : NULL;
 843 }
 844
 845 /* ... Magic cast/dispell .................................................. */
 846
 847 #if VMG_UVAR
 848
 849 static I32 vmg_svt_val(pTHX_ IV, SV *);
 850
 851 typedef struct {
 852  struct ufuncs new_uf;
 853  struct ufuncs old_uf;
 854 } vmg_uvar_ud;
 855
 856 #endif /* VMG_UVAR */
 857
 858 static void vmg_mg_del(pTHX_ SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 859 #define vmg_mg_del(S, P, M, N) vmg_mg_del(aTHX_ (S), (P), (M), (N))
 860  dMY_CXT;
 861
 862  if (prevmagic)
 863   prevmagic->mg_moremagic = moremagic;
 864  else
 865   SvMAGIC_set(sv, moremagic);
 866
 867  /* Destroy private data */
 868 #if VMG_UVAR
 869  if (mg->mg_type == PERL_MAGIC_uvar) {
 870   Safefree(mg->mg_ptr);
 871  } else {
 872 #endif /* VMG_UVAR */
 873   if (mg->mg_obj != sv) {
 874    SvREFCNT_dec(mg->mg_obj);
 875    mg->mg_obj = NULL;
 876   }
 877   /* Unreference the wizard */
 878   SvREFCNT_dec((SV *) mg->mg_ptr);
 879   mg->mg_ptr = NULL;
 880 #if VMG_UVAR
 881  }
 882 #endif /* VMG_UVAR */
 883
 884  if (MY_CXT.depth) {
 885   mg->mg_moremagic    = MY_CXT.freed_tokens;
 886   MY_CXT.freed_tokens = mg;
 887  } else {
 888   mg->mg_moremagic = NULL;
 889   Safefree(mg);
 890  }
 891 }
 892
 893 static int vmg_magic_chain_free(pTHX_ MAGIC *mg, MAGIC *skip) {
 894 #define vmg_magic_chain_free(M, S) vmg_magic_chain_free(aTHX_ (M), (S))
 895  int skipped = 0;
 896
 897  while (mg) {
 898   MAGIC *moremagic = mg->mg_moremagic;
 899
 900   if (mg == skip)
 901    ++skipped;
 902   else
 903    Safefree(mg);
 904
 905   mg = moremagic;
 906  }
 907
 908  return skipped;
 909 }
 910
 911 static UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
 912 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
 913  MAGIC  *mg;
 914  MGVTBL *t;
 915  SV     *data;
 916  U32     oldgmg;
 917
 918  if (vmg_find(sv, w))
 919   return 1;
 920
 921  oldgmg = SvGMAGICAL(sv);
 922
 923  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
 924
 925  t  = vmg_vtable_vtbl(w->vtable);
 926  mg = vmg_sv_magicext(sv, data, t, wiz, HEf_SVKEY);
 927
 928  if (SvTYPE(sv) < SVt_PVHV)
 929   goto done;
 930
 931  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 932   * magic is actually never called for them. If the GMAGICAL flag was off before
 933   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 934   * now on, then this wizard has get magic. Hence we can work around the
 935   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 936   * has uvar callbacks, it will be turned back on later. */
 937  if (!oldgmg && SvGMAGICAL(sv))
 938   SvGMAGICAL_off(sv);
 939
 940 #if VMG_UVAR
 941  if (w->uvar) {
 942   MAGIC *prevmagic, *moremagic = NULL;
 943   vmg_uvar_ud ud;
 944
 945   ud.new_uf.uf_val   = vmg_svt_val;
 946   ud.new_uf.uf_set   = NULL;
 947   ud.new_uf.uf_index = 0;
 948   ud.old_uf.uf_val   = NULL;
 949   ud.old_uf.uf_set   = NULL;
 950   ud.old_uf.uf_index = 0;
 951
 952   /* One uvar magic in the chain is enough. */
 953   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 954    moremagic = mg->mg_moremagic;
 955    if (mg->mg_type == PERL_MAGIC_uvar)
 956     break;
 957   }
 958
 959   if (mg) { /* Found another uvar magic. */
 960    struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
 961    if (uf->uf_val == vmg_svt_val) {
 962     /* It's our uvar magic, nothing to do. oldgmg was true. */
 963     goto done;
 964    } else {
 965     /* It's another uvar magic, backup it and replace it by ours. */
 966     ud.old_uf = *uf;
 967     vmg_mg_del(sv, prevmagic, mg, moremagic);
 968    }
 969   }
 970
 971   sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
 972   vmg_mg_magical(sv);
 973   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
 974    * handled by our uvar callback. */
 975  }
 976 #endif /* VMG_UVAR */
 977
 978 done:
 979  return 1;
 980 }
 981
 982 static UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
 983 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
 984 #if VMG_UVAR
 985  U32 uvars = 0;
 986 #endif /* VMG_UVAR */
 987  MAGIC *mg, *prevmagic, *moremagic = NULL;
 988  IV wid = vmg_wizard_id(w);
 989
 990  if (SvTYPE(sv) < SVt_PVMG)
 991   return 0;
 992
 993  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 994   const vmg_wizard *z;
 995
 996   moremagic = mg->mg_moremagic;
 997
 998   z = vmg_wizard_from_mg(mg);
 999   if (z) {
1000    IV zid = vmg_wizard_id(z);
1001
1002 #if VMG_UVAR
1003    if (zid == wid) {
1004     /* If the current has no uvar, short-circuit uvar deletion. */
1005     uvars = z->uvar ? (uvars + 1) : 0;
1006     break;
1007    } else if (z->uvar) {
1008     ++uvars;
1009     /* We can't break here since we need to find the ext magic to delete. */
1010    }
1011 #else /* VMG_UVAR */
1012    if (zid == wid)
1013     break;
1014 #endif /* !VMG_UVAR */
1015   }
1016  }
1017  if (!mg)
1018   return 0;
1019
1020  vmg_mg_del(sv, prevmagic, mg, moremagic);
1021
1022 #if VMG_UVAR
1023  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
1024   /* mg was the first ext magic in the chain that had uvar */
1025
1026   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
1027    const vmg_wizard *z = vmg_wizard_from_mg(mg);
1028
1029    if (z && z->uvar) {
1030     ++uvars;
1031     break;
1032    }
1033   }
1034
1035   if (uvars == 1) {
1036    vmg_uvar_ud *ud;
1037
1038    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
1039     moremagic = mg->mg_moremagic;
1040     if (mg->mg_type == PERL_MAGIC_uvar)
1041      break;
1042    }
1043
1044    ud = (vmg_uvar_ud *) mg->mg_ptr;
1045    if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
1046     /* Revert the original uvar magic. */
1047     struct ufuncs *uf;
1048     Newx(uf, 1, struct ufuncs);
1049     *uf = ud->old_uf;
1050     Safefree(ud);
1051     mg->mg_ptr = (char *) uf;
1052     mg->mg_len = sizeof(*uf);
1053    } else {
1054     /* Remove the uvar magic. */
1055     vmg_mg_del(sv, prevmagic, mg, moremagic);
1056    }
1057   }
1058  }
1059 #endif /* VMG_UVAR */
1060
1061  vmg_mg_magical(sv);
1062
1063  return 1;
1064 }
1065
1066 /* ... OP info ............................................................. */
1067
1068 #define VMG_OP_INFO_NAME   1
1069 #define VMG_OP_INFO_OBJECT 2
1070
1071 #if VMG_THREADSAFE
1072 static perl_mutex vmg_op_name_init_mutex;
1073 #endif
1074
1075 static U32           vmg_op_name_init      = 0;
1076 static unsigned char vmg_op_name_len[MAXO] = { 0 };
1077
1078 static void vmg_op_info_init(pTHX_ unsigned int opinfo) {
1079 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
1080  switch (opinfo) {
1081   case VMG_OP_INFO_NAME:
1082    VMG_LOCK(&vmg_op_name_init_mutex);
1083    if (!vmg_op_name_init) {
1084     OPCODE t;
1085     for (t = 0; t < OP_max; ++t)
1086      vmg_op_name_len[t] = strlen(PL_op_name[t]);
1087     vmg_op_name_init = 1;
1088    }
1089    VMG_UNLOCK(&vmg_op_name_init_mutex);
1090    break;
1091   case VMG_OP_INFO_OBJECT: {
1092    dMY_CXT;
1093    if (!MY_CXT.b__op_stashes[0]) {
1094     int c;
1095     require_pv("B.pm");
1096     for (c = OPc_NULL; c < OPc_MAX; ++c)
1097      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1098    }
1099    break;
1100   }
1101   default:
1102    break;
1103  }
1104 }
1105
1106 static SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1107 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1108  if (!PL_op)
1109   return &PL_sv_undef;
1110
1111  switch (opinfo) {
1112   case VMG_OP_INFO_NAME: {
1113    OPCODE t = PL_op->op_type;
1114    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1115   }
1116   case VMG_OP_INFO_OBJECT: {
1117    dMY_CXT;
1118    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1119                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1120   }
1121   default:
1122    break;
1123  }
1124
1125  return &PL_sv_undef;
1126 }
1127
1128 /* --- svt callbacks ------------------------------------------------------- */
1129
1130 #define VMG_CB_CALL_ARGS_MASK  15
1131 #define VMG_CB_CALL_ARGS_SHIFT 4
1132 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT) /* 1|2 */
1133 #define VMG_CB_CALL_GUARD      4
1134
1135 static int vmg_dispell_guard_oncroak(pTHX_ void *ud) {
1136  dMY_CXT;
1137
1138  MY_CXT.depth--;
1139
1140  /* If we're at the upmost magic call and we're about to die, we can just free
1141   * the tokens right now, since we will jump past the problematic part of our
1142   * caller. */
1143  if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1144   vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1145   MY_CXT.freed_tokens = NULL;
1146  }
1147
1148  return 1;
1149 }
1150
1151 static int vmg_dispell_guard_free(pTHX_ SV *sv, MAGIC *mg) {
1152  vmg_magic_chain_free((MAGIC *) mg->mg_ptr, NULL);
1153
1154  return 0;
1155 }
1156
1157 #if VMG_THREADSAFE
1158
1159 static int vmg_dispell_guard_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
1160  /* The freed magic tokens aren't cloned by perl because it cannot reach them
1161   * (they have been detached from their parent SV when they were enqueued).
1162   * Hence there's nothing to purge in the new thread. */
1163  mg->mg_ptr = NULL;
1164
1165  return 0;
1166 }
1167
1168 #endif /* VMG_THREADSAFE */
1169
1170 static MGVTBL vmg_dispell_guard_vtbl = {
1171  NULL,                   /* get */
1172  NULL,                   /* set */
1173  NULL,                   /* len */
1174  NULL,                   /* clear */
1175  vmg_dispell_guard_free, /* free */
1176  NULL,                   /* copy */
1177 #if VMG_THREADSAFE
1178  vmg_dispell_guard_dup,  /* dup */
1179 #else
1180  NULL,                   /* dup */
1181 #endif
1182 #if MGf_LOCAL
1183  NULL,                   /* local */
1184 #endif /* MGf_LOCAL */
1185 };
1186
1187 static SV *vmg_dispell_guard_new(pTHX_ MAGIC *root) {
1188 #define vmg_dispell_guard_new(R) vmg_dispell_guard_new(aTHX_ (R))
1189  SV *guard;
1190
1191  guard = sv_newmortal();
1192  vmg_sv_magicext(guard, NULL, &vmg_dispell_guard_vtbl, root, 0);
1193
1194  return guard;
1195 }
1196
1197 static int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1198  va_list ap;
1199  int ret = 0;
1200  unsigned int i, args, opinfo;
1201  MAGIC **chain = NULL;
1202  SV *svr;
1203
1204  dSP;
1205
1206  args    = flags & VMG_CB_CALL_ARGS_MASK;
1207  flags >>= VMG_CB_CALL_ARGS_SHIFT;
1208  opinfo  = flags & VMG_CB_CALL_OPINFO;
1209
1210  ENTER;
1211  SAVETMPS;
1212
1213  PUSHMARK(SP);
1214  EXTEND(SP, args + 1);
1215  PUSHs(sv_2mortal(newRV_inc(sv)));
1216  va_start(ap, sv);
1217  for (i = 0; i < args; ++i) {
1218   SV *sva = va_arg(ap, SV *);
1219   PUSHs(sva ? sva : &PL_sv_undef);
1220  }
1221  va_end(ap);
1222  if (opinfo)
1223   XPUSHs(vmg_op_info(opinfo));
1224  PUTBACK;
1225
1226  if (flags & VMG_CB_CALL_GUARD) {
1227   dMY_CXT;
1228   MY_CXT.depth++;
1229   vmg_call_sv(cb, G_SCALAR, vmg_dispell_guard_oncroak, NULL);
1230   MY_CXT.depth--;
1231   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens)
1232    chain = &MY_CXT.freed_tokens;
1233  } else {
1234   vmg_call_sv(cb, G_SCALAR, 0, NULL);
1235  }
1236
1237  SPAGAIN;
1238  svr = POPs;
1239  if (SvOK(svr))
1240   ret = (int) SvIV(svr);
1241  PUTBACK;
1242
1243  FREETMPS;
1244  LEAVE;
1245
1246  if (chain) {
1247   vmg_dispell_guard_new(*chain);
1248   *chain = NULL;
1249  }
1250
1251  return ret;
1252 }
1253
1254 #define VMG_CB_FLAGS(OI, A) \
1255         ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1256
1257 #define vmg_cb_call1(I, OI, S, A1) \
1258         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1259 #define vmg_cb_call2(I, OI, S, A1, A2) \
1260         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1261 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1262         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1263
1264 /* ... Default no-op magic callback ........................................ */
1265
1266 static int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1267  return 0;
1268 }
1269
1270 /* ... get magic ........................................................... */
1271
1272 static int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1273  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1274
1275  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1276 }
1277
1278 #define vmg_svt_get_noop vmg_svt_default_noop
1279
1280 /* ... set magic ........................................................... */
1281
1282 static int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1283  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1284
1285  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1286 }
1287
1288 #define vmg_svt_set_noop vmg_svt_default_noop
1289
1290 /* ... len magic ........................................................... */
1291
1292 static U32 vmg_sv_len(pTHX_ SV *sv) {
1293 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1294  STRLEN len;
1295 #if VMG_HAS_PERL(5, 9, 3)
1296  const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1297 #else
1298  U8 *s = SvPV(sv, len);
1299 #endif
1300
1301  return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1302 }
1303
1304 static U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1305  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1306  unsigned int opinfo = w->opinfo;
1307  U32 len, ret;
1308  SV *svr;
1309  svtype t = SvTYPE(sv);
1310
1311  dSP;
1312
1313  ENTER;
1314  SAVETMPS;
1315
1316  PUSHMARK(SP);
1317  EXTEND(SP, 3);
1318  PUSHs(sv_2mortal(newRV_inc(sv)));
1319  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1320  if (t < SVt_PVAV) {
1321   len = vmg_sv_len(sv);
1322   mPUSHu(len);
1323  } else if (t == SVt_PVAV) {
1324   len = av_len((AV *) sv) + 1;
1325   mPUSHu(len);
1326  } else {
1327   len = 0;
1328   PUSHs(&PL_sv_undef);
1329  }
1330  if (opinfo)
1331   XPUSHs(vmg_op_info(opinfo));
1332  PUTBACK;
1333
1334  vmg_call_sv(w->cb_len, G_SCALAR, 0, NULL);
1335
1336  SPAGAIN;
1337  svr = POPs;
1338  ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1339  if (t == SVt_PVAV)
1340   --ret;
1341  PUTBACK;
1342
1343  FREETMPS;
1344  LEAVE;
1345
1346  return ret;
1347 }
1348
1349 static U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1350  U32    len = 0;
1351  svtype t   = SvTYPE(sv);
1352
1353  if (t < SVt_PVAV) {
1354   len = vmg_sv_len(sv);
1355  } else if (t == SVt_PVAV) {
1356   len = (U32) av_len((AV *) sv);
1357  }
1358
1359  return len;
1360 }
1361
1362 /* ... clear magic ......................................................... */
1363
1364 static int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1365  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1366  unsigned int flags  = w->opinfo;
1367
1368 #if !VMG_HAS_PERL(5, 12, 0)
1369  flags |= VMG_CB_CALL_GUARD;
1370 #endif
1371
1372  return vmg_cb_call1(w->cb_clear, flags, sv, mg->mg_obj);
1373 }
1374
1375 #define vmg_svt_clear_noop vmg_svt_default_noop
1376
1377 /* ... free magic .......................................................... */
1378
1379 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1380
1381 static OP *vmg_pp_propagate_errsv(pTHX) {
1382  SVOP *o = cSVOPx(PL_op);
1383
1384  if (o->op_sv) {
1385   sv_setsv(ERRSV, o->op_sv);
1386   SvREFCNT_dec(o->op_sv);
1387   o->op_sv = NULL;
1388  }
1389
1390  return NORMAL;
1391 }
1392
1393 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1394
1395 static int vmg_propagate_errsv_free(pTHX_ SV *sv, MAGIC *mg) {
1396  if (mg->mg_obj)
1397   sv_setsv(ERRSV, mg->mg_obj);
1398
1399  return 0;
1400 }
1401
1402 /* perl is already kind enough to handle the cloning of the mg_obj member,
1403    hence we don't need to define a dup magic callback. */
1404
1405 static MGVTBL vmg_propagate_errsv_vtbl = {
1406  0,                        /* get */
1407  0,                        /* set */
1408  0,                        /* len */
1409  0,                        /* clear */
1410  vmg_propagate_errsv_free, /* free */
1411  0,                        /* copy */
1412  0,                        /* dup */
1413 #if MGf_LOCAL
1414  0,                        /* local */
1415 #endif /* MGf_LOCAL */
1416 };
1417
1418 typedef struct {
1419  SV  *sv;
1420  int  in_eval;
1421  I32  base;
1422 } vmg_svt_free_cleanup_ud;
1423
1424 static int vmg_svt_free_cleanup(pTHX_ void *ud_) {
1425  vmg_svt_free_cleanup_ud *ud = VOID2(vmg_svt_free_cleanup_ud *, ud_);
1426
1427  if (ud->in_eval) {
1428   U32 optype = PL_op ? PL_op->op_type : OP_NULL;
1429
1430   if (optype == OP_LEAVETRY || optype == OP_LEAVEEVAL) {
1431    SV *errsv = newSVsv(ERRSV);
1432
1433    FREETMPS;
1434    LEAVE_SCOPE(ud->base);
1435
1436 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1437    if (optype == OP_LEAVETRY) {
1438     dMY_CXT;
1439     PL_op = vmg_trampoline_bump(&MY_CXT.propagate_errsv, errsv, PL_op);
1440    } else if (optype == OP_LEAVEEVAL) {
1441     SV *guard = sv_newmortal();
1442     vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1443    }
1444 #else /* !VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1445 # if !VMG_HAS_PERL(5, 8, 9)
1446    {
1447     SV *guard = sv_newmortal();
1448     vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1449    }
1450 # else
1451    vmg_sv_magicext(ERRSV, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1452 # endif
1453 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1454
1455    SAVETMPS;
1456   }
1457
1458   /* Don't propagate */
1459   return 0;
1460  } else {
1461   SV    *sv = ud->sv;
1462   MAGIC *mg;
1463
1464   /* We are about to croak() while sv is being destroyed. Try to clean up
1465    * things a bit. */
1466   mg = SvMAGIC(sv);
1467   if (mg) {
1468    vmg_mg_del(sv, NULL, mg, mg->mg_moremagic);
1469    mg_magical(sv);
1470   }
1471   SvREFCNT_dec(sv);
1472
1473   vmg_dispell_guard_oncroak(aTHX_ NULL);
1474
1475   /* After that, propagate the error upwards. */
1476   return 1;
1477  }
1478 }
1479
1480 static int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1481  vmg_svt_free_cleanup_ud ud;
1482  const vmg_wizard *w;
1483  int ret = 0;
1484  SV *svr;
1485
1486  dSP;
1487
1488  /* During global destruction, we cannot be sure that the wizard and its free
1489   * callback are still alive. */
1490  if (PL_dirty)
1491   return 0;
1492
1493  w = vmg_wizard_from_mg_nocheck(mg);
1494
1495  /* So that it survives the temp cleanup below */
1496  SvREFCNT_inc_simple_void(sv);
1497
1498 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1499  /* The previous magic tokens were freed but the magic chain wasn't updated, so
1500   * if you access the sv from the callback the old deleted magics will trigger
1501   * and cause memory misreads. Change 32686 solved it that way : */
1502  SvMAGIC_set(sv, mg);
1503 #endif
1504
1505  ud.sv = sv;
1506  if (cxstack_ix < cxstack_max) {
1507   ud.in_eval = (CxTYPE(cxstack + cxstack_ix + 1) == CXt_EVAL);
1508   ud.base    = ud.in_eval ? PL_scopestack[PL_scopestack_ix] : 0;
1509  } else {
1510   ud.in_eval = 0;
1511   ud.base    = 0;
1512  }
1513
1514  ENTER;
1515  SAVETMPS;
1516
1517  PUSHMARK(SP);
1518  EXTEND(SP, 2);
1519  PUSHs(sv_2mortal(newRV_inc(sv)));
1520  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1521  if (w->opinfo)
1522   XPUSHs(vmg_op_info(w->opinfo));
1523  PUTBACK;
1524
1525  {
1526   dMY_CXT;
1527   MY_CXT.depth++;
1528   vmg_call_sv(w->cb_free, G_SCALAR, vmg_svt_free_cleanup, &ud);
1529   MY_CXT.depth--;
1530   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1531    /* Free all the tokens in the chain but the current one (if it's present).
1532     * It will be taken care of by our caller, Perl_mg_free(). */
1533    vmg_magic_chain_free(MY_CXT.freed_tokens, mg);
1534    MY_CXT.freed_tokens = NULL;
1535   }
1536  }
1537
1538  SPAGAIN;
1539  svr = POPs;
1540  if (SvOK(svr))
1541   ret = (int) SvIV(svr);
1542  PUTBACK;
1543
1544  FREETMPS;
1545  LEAVE;
1546
1547  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1548   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1549  --SvREFCNT(sv);
1550
1551  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1552   * mg->mg_ptr reference count */
1553  return ret;
1554 }
1555
1556 #define vmg_svt_free_noop vmg_svt_default_noop
1557
1558 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1559 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1560 #else
1561 # define VMG_SVT_COPY_KEYLEN_TYPE int
1562 #endif
1563
1564 /* ... copy magic .......................................................... */
1565
1566 static int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1567  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1568  SV *keysv;
1569  int ret;
1570
1571  if (keylen == HEf_SVKEY) {
1572   keysv = (SV *) key;
1573  } else {
1574   keysv = newSVpvn(key, keylen);
1575  }
1576
1577  if (SvTYPE(sv) >= SVt_PVCV)
1578   nsv = sv_2mortal(newRV_inc(nsv));
1579
1580  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1581
1582  if (keylen != HEf_SVKEY) {
1583   SvREFCNT_dec(keysv);
1584  }
1585
1586  return ret;
1587 }
1588
1589 static int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1590  return 0;
1591 }
1592
1593 /* ... dup magic ........................................................... */
1594
1595 #if 0
1596 static int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1597  return 0;
1598 }
1599 #define vmg_svt_dup_noop vmg_svt_dup
1600 #endif
1601
1602 /* ... local magic ......................................................... */
1603
1604 #if MGf_LOCAL
1605
1606 static int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1607  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1608
1609  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1610 }
1611
1612 #define vmg_svt_local_noop vmg_svt_default_noop
1613
1614 #endif /* MGf_LOCAL */
1615
1616 /* ... uvar magic .......................................................... */
1617
1618 #if VMG_UVAR
1619
1620 static OP *vmg_pp_reset_rmg(pTHX) {
1621  SVOP *o = cSVOPx(PL_op);
1622
1623  SvRMAGICAL_on(o->op_sv);
1624  o->op_sv = NULL;
1625
1626  return NORMAL;
1627 }
1628
1629 static I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1630  vmg_uvar_ud *ud;
1631  MAGIC *mg, *umg, *moremagic;
1632  SV *key = NULL, *newkey = NULL;
1633  int tied = 0;
1634
1635  umg = mg_find(sv, PERL_MAGIC_uvar);
1636  /* umg can't be NULL or we wouldn't be there. */
1637  key = umg->mg_obj;
1638  ud  = (vmg_uvar_ud *) umg->mg_ptr;
1639
1640  if (ud->old_uf.uf_val)
1641   ud->old_uf.uf_val(aTHX_ action, sv);
1642  if (ud->old_uf.uf_set)
1643   ud->old_uf.uf_set(aTHX_ action, sv);
1644
1645  for (mg = SvMAGIC(sv); mg; mg = moremagic) {
1646   const vmg_wizard *w;
1647
1648   /* mg may be freed later by the uvar call, so we need to fetch the next
1649    * token before reaching that fateful point. */
1650   moremagic = mg->mg_moremagic;
1651
1652   switch (mg->mg_type) {
1653    case PERL_MAGIC_ext:
1654     break;
1655    case PERL_MAGIC_tied:
1656     ++tied;
1657     continue;
1658    default:
1659     continue;
1660   }
1661
1662   w = vmg_wizard_from_mg(mg);
1663   if (!w)
1664    continue;
1665
1666   switch (w->uvar) {
1667    case 0:
1668     continue;
1669    case 2:
1670     if (!newkey)
1671      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1672   }
1673
1674   switch (action
1675              & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1676    case 0:
1677     if (w->cb_fetch)
1678      vmg_cb_call2(w->cb_fetch, w->opinfo | VMG_CB_CALL_GUARD, sv,
1679                                mg->mg_obj, key);
1680     break;
1681    case HV_FETCH_ISSTORE:
1682    case HV_FETCH_LVALUE:
1683    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1684     if (w->cb_store)
1685      vmg_cb_call2(w->cb_store, w->opinfo | VMG_CB_CALL_GUARD, sv,
1686                                mg->mg_obj, key);
1687     break;
1688    case HV_FETCH_ISEXISTS:
1689     if (w->cb_exists)
1690      vmg_cb_call2(w->cb_exists, w->opinfo | VMG_CB_CALL_GUARD, sv,
1691                                 mg->mg_obj, key);
1692     break;
1693    case HV_DELETE:
1694     if (w->cb_delete)
1695      vmg_cb_call2(w->cb_delete, w->opinfo | VMG_CB_CALL_GUARD, sv,
1696                                 mg->mg_obj, key);
1697     break;
1698   }
1699  }
1700
1701  if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1702   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1703    * mistaken for a tied hash by the rest of hv_common. It will be reset by
1704    * the op_ppaddr of a new fake op injected between the current and the next
1705    * one. */
1706
1707 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1708
1709   dMY_CXT;
1710
1711   PL_op = vmg_trampoline_bump(&MY_CXT.reset_rmg, sv, PL_op);
1712
1713 #else /* !VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1714
1715   OP   *nop  = PL_op->op_next;
1716   SVOP *svop = NULL;
1717
1718   if (nop && nop->op_ppaddr == vmg_pp_reset_rmg) {
1719    svop = (SVOP *) nop;
1720   } else {
1721    NewOp(1101, svop, 1, SVOP);
1722    svop->op_type    = OP_STUB;
1723    svop->op_ppaddr  = vmg_pp_reset_rmg;
1724    svop->op_next    = nop;
1725    svop->op_flags   = 0;
1726    svop->op_private = 0;
1727
1728    PL_op->op_next = (OP *) svop;
1729   }
1730
1731   svop->op_sv = sv;
1732
1733 #endif /* VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1734
1735   SvRMAGICAL_off(sv);
1736  }
1737
1738  return 0;
1739 }
1740
1741 #endif /* VMG_UVAR */
1742
1743 /* --- Macros for the XS section ------------------------------------------- */
1744
1745 #ifdef CvISXSUB
1746 # define VMG_CVOK(C) \
1747    ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
1748 #else
1749 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
1750 #endif
1751
1752 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
1753
1754 #define VMG_SET_CB(S, N) {       \
1755  SV *cb = (S);                   \
1756  if (SvOK(cb) && SvROK(cb)) {    \
1757   cb = SvRV(cb);                 \
1758   if (VMG_CBOK(cb))              \
1759    SvREFCNT_inc_simple_void(cb); \
1760   else                           \
1761    cb = NULL;                    \
1762  } else {                        \
1763   cb = NULL;                     \
1764  }                               \
1765  w->cb_ ## N = cb;               \
1766 }
1767
1768 #define VMG_SET_SVT_CB(S, N) {   \
1769  SV *cb = (S);                   \
1770  if (SvOK(cb) && SvROK(cb)) {    \
1771   cb = SvRV(cb);                 \
1772   if (VMG_CBOK(cb)) {            \
1773    t->svt_ ## N = vmg_svt_ ## N; \
1774    SvREFCNT_inc_simple_void(cb); \
1775   } else {                       \
1776    t->svt_ ## N = vmg_svt_ ## N ## _noop; \
1777    cb           = NULL;          \
1778   }                              \
1779  } else {                        \
1780   t->svt_ ## N = NULL;           \
1781   cb           = NULL;           \
1782  }                               \
1783  w->cb_ ## N = cb;               \
1784 }
1785
1786 /* --- XS ------------------------------------------------------------------ */
1787
1788 MODULE = Variable::Magic            PACKAGE = Variable::Magic
1789
1790 PROTOTYPES: ENABLE
1791
1792 BOOT:
1793 {
1794  HV *stash;
1795  int c;
1796
1797  MY_CXT_INIT;
1798  for (c = OPc_NULL; c < OPc_MAX; ++c)
1799   MY_CXT.b__op_stashes[c] = NULL;
1800
1801  MY_CXT.depth        = 0;
1802  MY_CXT.freed_tokens = NULL;
1803
1804  /* XS doesn't like a blank line here */
1805 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1806  vmg_trampoline_init(&MY_CXT.propagate_errsv, vmg_pp_propagate_errsv);
1807 #endif
1808 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1809  vmg_trampoline_init(&MY_CXT.reset_rmg, vmg_pp_reset_rmg);
1810 #endif
1811
1812  /* XS doesn't like a blank line here */
1813 #if VMG_THREADSAFE
1814  MUTEX_INIT(&vmg_vtable_refcount_mutex);
1815  MUTEX_INIT(&vmg_op_name_init_mutex);
1816 #endif
1817
1818  stash = gv_stashpv(__PACKAGE__, 1);
1819  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1820  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1821  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1822  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1823  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1824                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1825  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_NOLEN",
1826                     newSVuv(VMG_COMPAT_SCALAR_NOLEN));
1827  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1828                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1829  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1830                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1831  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1832                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1833  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1834                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1835  newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1836                     newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1837  newCONSTSUB(stash, "VMG_COMPAT_CODE_COPY_CLONE",
1838                     newSVuv(VMG_COMPAT_CODE_COPY_CLONE));
1839  newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1840  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1841  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1842  newCONSTSUB(stash, "VMG_FORKSAFE",        newSVuv(VMG_FORKSAFE));
1843  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1844  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1845 }
1846
1847 #if VMG_THREADSAFE
1848
1849 void
1850 CLONE(...)
1851 PROTOTYPE: DISABLE
1852 PREINIT:
1853  U32 had_b__op_stash = 0;
1854  I32 old_depth;
1855  int c;
1856 PPCODE:
1857  {
1858   dMY_CXT;
1859   for (c = OPc_NULL; c < OPc_MAX; ++c) {
1860    if (MY_CXT.b__op_stashes[c])
1861     had_b__op_stash |= (((U32) 1) << c);
1862   }
1863   old_depth = MY_CXT.depth;
1864  }
1865  {
1866   MY_CXT_CLONE;
1867   for (c = OPc_NULL; c < OPc_MAX; ++c) {
1868    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1869                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1870   }
1871   MY_CXT.depth        = old_depth;
1872   MY_CXT.freed_tokens = NULL;
1873  }
1874  XSRETURN(0);
1875
1876 #endif /* VMG_THREADSAFE */
1877
1878 SV *_wizard(...)
1879 PROTOTYPE: DISABLE
1880 PREINIT:
1881  vmg_wizard *w;
1882  MGVTBL *t;
1883  SV *op_info, *copy_key;
1884  I32 i = 0;
1885 CODE:
1886  if (items != 9
1887 #if MGf_LOCAL
1888               + 1
1889 #endif /* MGf_LOCAL */
1890 #if VMG_UVAR
1891               + 5
1892 #endif /* VMG_UVAR */
1893               ) { croak(vmg_wrongargnum); }
1894
1895  op_info = ST(i++);
1896  w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
1897  t = vmg_vtable_vtbl(w->vtable);
1898
1899  VMG_SET_CB(ST(i++), data);
1900
1901  VMG_SET_SVT_CB(ST(i++), get);
1902  VMG_SET_SVT_CB(ST(i++), set);
1903  VMG_SET_SVT_CB(ST(i++), len);
1904  VMG_SET_SVT_CB(ST(i++), clear);
1905  VMG_SET_SVT_CB(ST(i++), free);
1906  VMG_SET_SVT_CB(ST(i++), copy);
1907  /* VMG_SET_SVT_CB(ST(i++), dup); */
1908  i++;
1909  t->svt_dup = NULL;
1910  w->cb_dup  = NULL;
1911 #if MGf_LOCAL
1912  VMG_SET_SVT_CB(ST(i++), local);
1913 #endif /* MGf_LOCAL */
1914 #if VMG_UVAR
1915  VMG_SET_CB(ST(i++), fetch);
1916  VMG_SET_CB(ST(i++), store);
1917  VMG_SET_CB(ST(i++), exists);
1918  VMG_SET_CB(ST(i++), delete);
1919
1920  copy_key = ST(i++);
1921  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1922   w->uvar = SvTRUE(copy_key) ? 2 : 1;
1923 #endif /* VMG_UVAR */
1924
1925  RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
1926 OUTPUT:
1927  RETVAL
1928
1929 SV *cast(SV *sv, SV *wiz, ...)
1930 PROTOTYPE: \[$@%&*]$@
1931 PREINIT:
1932  const vmg_wizard *w = NULL;
1933  SV **args = NULL;
1934  I32 i = 0;
1935 CODE:
1936  if (items > 2) {
1937   i = items - 2;
1938   args = &ST(2);
1939  }
1940  if (SvROK(wiz)) {
1941   wiz = SvRV_const(wiz);
1942   w   = vmg_wizard_from_sv(wiz);
1943  }
1944  if (!w)
1945   croak(vmg_invalid_wiz);
1946  RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
1947 OUTPUT:
1948  RETVAL
1949
1950 void
1951 getdata(SV *sv, SV *wiz)
1952 PROTOTYPE: \[$@%&*]$
1953 PREINIT:
1954  const vmg_wizard *w = NULL;
1955  SV *data;
1956 PPCODE:
1957  if (SvROK(wiz))
1958   w = vmg_wizard_from_sv(SvRV_const(wiz));
1959  if (!w)
1960   croak(vmg_invalid_wiz);
1961  data = vmg_data_get(SvRV(sv), w);
1962  if (!data)
1963   XSRETURN_EMPTY;
1964  ST(0) = data;
1965  XSRETURN(1);
1966
1967 SV *dispell(SV *sv, SV *wiz)
1968 PROTOTYPE: \[$@%&*]$
1969 PREINIT:
1970  const vmg_wizard *w = NULL;
1971 CODE:
1972  if (SvROK(wiz))
1973   w = vmg_wizard_from_sv(SvRV_const(wiz));
1974  if (!w)
1975   croak(vmg_invalid_wiz);
1976  RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));
1977 OUTPUT:
1978  RETVAL