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