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 /* --- Safe version of call_sv() ------------------------------------------- */
 280
 281 STATIC I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, int (*cleanup)(pTHX_ void *), void *ud) {
 282 #define vmg_call_sv(S, F, C, U) vmg_call_sv(aTHX_ (S), (F), (C), (U))
 283  I32 ret, cxix;
 284  PERL_CONTEXT saved_cx;
 285  SV *old_err = NULL;
 286
 287  if (SvTRUE(ERRSV)) {
 288   old_err = newSVsv(ERRSV);
 289   sv_setsv(ERRSV, &PL_sv_undef);
 290  }
 291
 292  cxix     = (cxstack_ix < cxstack_max) ? (cxstack_ix + 1) : Perl_cxinc(aTHX);
 293  /* The last popped context will be reused by call_sv(), but our callers may
 294   * still need its previous value. Back it up so that it isn't clobbered. */
 295  saved_cx = cxstack[cxix];
 296
 297  ret = call_sv(sv, flags | G_EVAL);
 298
 299  cxstack[cxix] = saved_cx;
 300
 301  if (SvTRUE(ERRSV)) {
 302   SvREFCNT_dec(old_err);
 303
 304   if (IN_PERL_COMPILETIME) {
 305    if (!PL_in_eval) {
 306     if (PL_errors)
 307      sv_catsv(PL_errors, ERRSV);
 308     else
 309      Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
 310     SvCUR_set(ERRSV, 0);
 311    }
 312 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
 313    if (PL_parser)
 314     ++PL_parser->error_count;
 315 #elif defined(PL_error_count)
 316    ++PL_error_count;
 317 #else
 318    ++PL_Ierror_count;
 319 #endif
 320   } else {
 321    if (!cleanup || cleanup(aTHX_ ud))
 322     croak(NULL);
 323   }
 324  } else {
 325   if (old_err) {
 326    sv_setsv(ERRSV, old_err);
 327    SvREFCNT_dec(old_err);
 328   }
 329  }
 330
 331  return ret;
 332 }
 333
 334 /* --- Stolen chunk of B --------------------------------------------------- */
 335
 336 typedef enum {
 337  OPc_NULL,
 338  OPc_BASEOP,
 339  OPc_UNOP,
 340  OPc_BINOP,
 341  OPc_LOGOP,
 342  OPc_LISTOP,
 343  OPc_PMOP,
 344  OPc_SVOP,
 345  OPc_PADOP,
 346  OPc_PVOP,
 347  OPc_LOOP,
 348  OPc_COP,
 349 #if VMG_HAS_PERL(5, 21, 5)
 350  OPc_METHOP,
 351 #endif
 352  OPc_MAX
 353 } opclass;
 354
 355 STATIC const char *const vmg_opclassnames[] = {
 356  "B::NULL",
 357  "B::OP",
 358  "B::UNOP",
 359  "B::BINOP",
 360  "B::LOGOP",
 361  "B::LISTOP",
 362  "B::PMOP",
 363  "B::SVOP",
 364  "B::PADOP",
 365  "B::PVOP",
 366  "B::LOOP",
 367  "B::COP",
 368 #if VMG_HAS_PERL(5, 21, 5)
 369  "B::METHOP",
 370 #endif
 371  NULL
 372 };
 373
 374 STATIC opclass vmg_opclass(const OP *o) {
 375 #if 0
 376  if (!o)
 377   return OPc_NULL;
 378 #endif
 379
 380  if (o->op_type == 0)
 381   return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 382
 383  if (o->op_type == OP_SASSIGN)
 384   return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
 385
 386  if (o->op_type == OP_AELEMFAST) {
 387 #if PERL_VERSION <= 14
 388   if (o->op_flags & OPf_SPECIAL)
 389    return OPc_BASEOP;
 390   else
 391 #endif
 392 #ifdef USE_ITHREADS
 393    return OPc_PADOP;
 394 #else
 395    return OPc_SVOP;
 396 #endif
 397  }
 398
 399 #ifdef USE_ITHREADS
 400  if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
 401   return OPc_PADOP;
 402 #endif
 403
 404  switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
 405   case OA_BASEOP:
 406    return OPc_BASEOP;
 407   case OA_UNOP:
 408    return OPc_UNOP;
 409   case OA_BINOP:
 410    return OPc_BINOP;
 411   case OA_LOGOP:
 412    return OPc_LOGOP;
 413   case OA_LISTOP:
 414    return OPc_LISTOP;
 415   case OA_PMOP:
 416    return OPc_PMOP;
 417   case OA_SVOP:
 418    return OPc_SVOP;
 419   case OA_PADOP:
 420    return OPc_PADOP;
 421   case OA_PVOP_OR_SVOP:
 422    return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
 423   case OA_LOOP:
 424    return OPc_LOOP;
 425   case OA_COP:
 426    return OPc_COP;
 427   case OA_BASEOP_OR_UNOP:
 428    return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 429   case OA_FILESTATOP:
 430    return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
 431 #ifdef USE_ITHREADS
 432            (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
 433 #else
 434            (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
 435 #endif
 436   case OA_LOOPEXOP:
 437    if (o->op_flags & OPf_STACKED)
 438     return OPc_UNOP;
 439    else if (o->op_flags & OPf_SPECIAL)
 440     return OPc_BASEOP;
 441    else
 442     return OPc_PVOP;
 443 #if VMG_HAS_PERL(5, 21, 5)
 444   case OA_METHOP:
 445    return OPc_METHOP;
 446 #endif
 447  }
 448
 449  return OPc_BASEOP;
 450 }
 451
 452 /* --- Error messages ------------------------------------------------------ */
 453
 454 STATIC const char vmg_invalid_wiz[]    = "Invalid wizard object";
 455 STATIC const char vmg_wrongargnum[]    = "Wrong number of arguments";
 456 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
 457
 458 /* --- Context-safe global data -------------------------------------------- */
 459
 460 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 461
 462 typedef struct {
 463  HV             *b__op_stashes[OPc_MAX];
 464  I32             depth;
 465  MAGIC          *freed_tokens;
 466 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
 467  vmg_trampoline  propagate_errsv;
 468 #endif
 469 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
 470  vmg_trampoline  reset_rmg;
 471 #endif
 472 } my_cxt_t;
 473
 474 START_MY_CXT
 475
 476 /* --- <vmg_vtable> structure ---------------------------------------------- */
 477
 478 #if VMG_THREADSAFE
 479
 480 typedef struct {
 481  MGVTBL *vtbl;
 482  U32     refcount;
 483 } vmg_vtable;
 484
 485 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
 486 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
 487  vmg_vtable *t;
 488
 489  t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
 490
 491  t->vtbl     = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
 492  t->refcount = 1;
 493
 494  return t;
 495 }
 496
 497 #define vmg_vtable_vtbl(T) (T)->vtbl
 498
 499 STATIC perl_mutex vmg_vtable_refcount_mutex;
 500
 501 STATIC vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
 502 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
 503  VMG_LOCK(&vmg_vtable_refcount_mutex);
 504  ++t->refcount;
 505  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
 506
 507  return t;
 508 }
 509
 510 STATIC void vmg_vtable_free(pTHX_ vmg_vtable *t) {
 511 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
 512  U32 refcount;
 513
 514  VMG_LOCK(&vmg_vtable_refcount_mutex);
 515  refcount = --t->refcount;
 516  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
 517
 518  if (!refcount) {
 519   PerlMemShared_free(t->vtbl);
 520   PerlMemShared_free(t);
 521  }
 522 }
 523
 524 #else /* VMG_THREADSAFE */
 525
 526 typedef MGVTBL vmg_vtable;
 527
 528 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
 529 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
 530  vmg_vtable *t;
 531
 532  Newx(t, 1, vmg_vtable);
 533
 534  return t;
 535 }
 536
 537 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
 538
 539 #define vmg_vtable_free(T) Safefree(T)
 540
 541 #endif /* !VMG_THREADSAFE */
 542
 543 /* --- <vmg_wizard> structure ---------------------------------------------- */
 544
 545 typedef struct {
 546  vmg_vtable *vtable;
 547
 548  U8 opinfo;
 549  U8 uvar;
 550
 551  SV *cb_data;
 552  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
 553  SV *cb_copy;
 554  SV *cb_dup;
 555 #if MGf_LOCAL
 556  SV *cb_local;
 557 #endif /* MGf_LOCAL */
 558 #if VMG_UVAR
 559  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
 560 #endif /* VMG_UVAR */
 561 } vmg_wizard;
 562
 563 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo);
 564
 565 STATIC vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
 566 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
 567  vmg_wizard *w;
 568
 569  Newx(w, 1, vmg_wizard);
 570
 571  w->uvar   = 0;
 572  w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
 573  if (w->opinfo)
 574   vmg_op_info_init(aTHX_ w->opinfo);
 575
 576  w->vtable = vmg_vtable_alloc();
 577
 578  return w;
 579 }
 580
 581 STATIC void vmg_wizard_free(pTHX_ vmg_wizard *w) {
 582 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
 583  if (!w)
 584   return;
 585
 586  /* During global destruction, any of the callbacks may already have been
 587   * freed, so we can't rely on still being able to access them. */
 588  if (!PL_dirty) {
 589   SvREFCNT_dec(w->cb_data);
 590   SvREFCNT_dec(w->cb_get);
 591   SvREFCNT_dec(w->cb_set);
 592   SvREFCNT_dec(w->cb_len);
 593   SvREFCNT_dec(w->cb_clear);
 594   SvREFCNT_dec(w->cb_free);
 595   SvREFCNT_dec(w->cb_copy);
 596 #if 0
 597   SvREFCNT_dec(w->cb_dup);
 598 #endif
 599 #if MGf_LOCAL
 600   SvREFCNT_dec(w->cb_local);
 601 #endif /* MGf_LOCAL */
 602 #if VMG_UVAR
 603   SvREFCNT_dec(w->cb_fetch);
 604   SvREFCNT_dec(w->cb_store);
 605   SvREFCNT_dec(w->cb_exists);
 606   SvREFCNT_dec(w->cb_delete);
 607 #endif /* VMG_UVAR */
 608  }
 609
 610  /* PerlMemShared_free() and Safefree() are still fine during global
 611   * destruction though. */
 612  vmg_vtable_free(w->vtable);
 613  Safefree(w);
 614
 615  return;
 616 }
 617
 618 #if VMG_THREADSAFE
 619
 620 #define VMG_CLONE_CB(N) \
 621  z->cb_ ## N = (w->cb_ ## N) ? SvREFCNT_inc(sv_dup(w->cb_ ## N, params)) \
 622                              : NULL;
 623
 624 STATIC const vmg_wizard *vmg_wizard_dup(pTHX_ const vmg_wizard *w, CLONE_PARAMS *params) {
 625 #define vmg_wizard_dup(W, P) vmg_wizard_dup(aTHX_ (W), (P))
 626  vmg_wizard *z;
 627
 628  if (!w)
 629   return NULL;
 630
 631  Newx(z, 1, vmg_wizard);
 632
 633  z->vtable = vmg_vtable_dup(w->vtable);
 634  z->uvar   = w->uvar;
 635  z->opinfo = w->opinfo;
 636
 637  VMG_CLONE_CB(data);
 638  VMG_CLONE_CB(get);
 639  VMG_CLONE_CB(set);
 640  VMG_CLONE_CB(len);
 641  VMG_CLONE_CB(clear);
 642  VMG_CLONE_CB(free);
 643  VMG_CLONE_CB(copy);
 644  VMG_CLONE_CB(dup);
 645 #if MGf_LOCAL
 646  VMG_CLONE_CB(local);
 647 #endif /* MGf_LOCAL */
 648 #if VMG_UVAR
 649  VMG_CLONE_CB(fetch);
 650  VMG_CLONE_CB(store);
 651  VMG_CLONE_CB(exists);
 652  VMG_CLONE_CB(delete);
 653 #endif /* VMG_UVAR */
 654
 655  return z;
 656 }
 657
 658 #endif /* VMG_THREADSAFE */
 659
 660 #define vmg_wizard_id(W) PTR2IV(vmg_vtable_vtbl((W)->vtable))
 661
 662 /* --- Wizard SV objects --------------------------------------------------- */
 663
 664 STATIC int vmg_wizard_sv_free(pTHX_ SV *sv, MAGIC *mg) {
 665  vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
 666
 667  return 0;
 668 }
 669
 670 #if VMG_THREADSAFE
 671
 672 STATIC int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
 673  mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
 674
 675  return 0;
 676 }
 677
 678 #endif /* VMG_THREADSAFE */
 679
 680 STATIC MGVTBL vmg_wizard_sv_vtbl = {
 681  NULL,               /* get */
 682  NULL,               /* set */
 683  NULL,               /* len */
 684  NULL,               /* clear */
 685  vmg_wizard_sv_free, /* free */
 686  NULL,               /* copy */
 687 #if VMG_THREADSAFE
 688  vmg_wizard_sv_dup,  /* dup */
 689 #else
 690  NULL,               /* dup */
 691 #endif
 692 #if MGf_LOCAL
 693  NULL,               /* local */
 694 #endif /* MGf_LOCAL */
 695 };
 696
 697 STATIC SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
 698 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
 699  SV *wiz;
 700
 701 #if VMG_THREADSAFE
 702  wiz = newSV(0);
 703 #else
 704  wiz = newSViv(PTR2IV(w));
 705 #endif
 706
 707  if (w) {
 708   MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_sv_vtbl,
 709                                      (const char *) w, 0);
 710   mg->mg_private = 0;
 711 #if VMG_THREADSAFE
 712   mg->mg_flags  |= MGf_DUP;
 713 #endif
 714  }
 715  SvREADONLY_on(wiz);
 716
 717  return wiz;
 718 }
 719
 720 #if VMG_THREADSAFE
 721
 722 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
 723
 724 STATIC const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
 725  MAGIC *mg;
 726
 727  for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
 728   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
 729    return (const vmg_wizard *) mg->mg_ptr;
 730  }
 731
 732  return NULL;
 733 }
 734
 735 #else /* VMG_THREADSAFE */
 736
 737 #define vmg_sv_has_wizard_type(S) SvIOK(S)
 738
 739 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
 740
 741 #endif /* !VMG_THREADSAFE */
 742
 743 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
 744
 745 STATIC const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
 746  if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
 747   SV *sv = (SV *) mg->mg_ptr;
 748
 749   if (vmg_sv_has_wizard_type(sv))
 750    return vmg_wizard_from_sv_nocheck(sv);
 751  }
 752
 753  return NULL;
 754 }
 755
 756 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
 757
 758 /* --- User-level functions implementation --------------------------------- */
 759
 760 STATIC const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
 761  const MAGIC *mg;
 762  IV wid;
 763
 764  if (SvTYPE(sv) < SVt_PVMG)
 765   return NULL;
 766
 767  wid = vmg_wizard_id(w);
 768
 769  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 770   const vmg_wizard *z = vmg_wizard_from_mg(mg);
 771
 772   if (z && vmg_wizard_id(z) == wid)
 773    return mg;
 774  }
 775
 776  return NULL;
 777 }
 778
 779 /* ... Construct private data .............................................. */
 780
 781 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
 782 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
 783  I32 i;
 784  SV *nsv;
 785
 786  dSP;
 787
 788  ENTER;
 789  SAVETMPS;
 790
 791  PUSHMARK(SP);
 792  EXTEND(SP, items + 1);
 793  PUSHs(sv_2mortal(newRV_inc(sv)));
 794  for (i = 0; i < items; ++i)
 795   PUSHs(args[i]);
 796  PUTBACK;
 797
 798  vmg_call_sv(ctor, G_SCALAR, 0, NULL);
 799
 800  SPAGAIN;
 801  nsv = POPs;
 802 #if VMG_HAS_PERL(5, 8, 3)
 803  SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
 804 #else
 805  nsv = sv_newref(nsv);          /* Workaround some bug in SvREFCNT_inc() */
 806 #endif
 807  PUTBACK;
 808
 809  FREETMPS;
 810  LEAVE;
 811
 812  return nsv;
 813 }
 814
 815 STATIC SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
 816 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
 817  const MAGIC *mg = vmg_find(sv, w);
 818
 819  return mg ? mg->mg_obj : NULL;
 820 }
 821
 822 /* ... Magic cast/dispell .................................................. */
 823
 824 #if VMG_UVAR
 825
 826 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
 827
 828 typedef struct {
 829  struct ufuncs new_uf;
 830  struct ufuncs old_uf;
 831 } vmg_uvar_ud;
 832
 833 #endif /* VMG_UVAR */
 834
 835 STATIC void vmg_mg_del(pTHX_ SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 836 #define vmg_mg_del(S, P, M, N) vmg_mg_del(aTHX_ (S), (P), (M), (N))
 837  dMY_CXT;
 838
 839  if (prevmagic)
 840   prevmagic->mg_moremagic = moremagic;
 841  else
 842   SvMAGIC_set(sv, moremagic);
 843
 844  /* Destroy private data */
 845 #if VMG_UVAR
 846  if (mg->mg_type == PERL_MAGIC_uvar) {
 847   Safefree(mg->mg_ptr);
 848  } else {
 849 #endif /* VMG_UVAR */
 850   if (mg->mg_obj != sv) {
 851    SvREFCNT_dec(mg->mg_obj);
 852    mg->mg_obj = NULL;
 853   }
 854   /* Unreference the wizard */
 855   SvREFCNT_dec((SV *) mg->mg_ptr);
 856   mg->mg_ptr = NULL;
 857 #if VMG_UVAR
 858  }
 859 #endif /* VMG_UVAR */
 860
 861  if (MY_CXT.depth) {
 862   mg->mg_moremagic    = MY_CXT.freed_tokens;
 863   MY_CXT.freed_tokens = mg;
 864  } else {
 865   mg->mg_moremagic = NULL;
 866   Safefree(mg);
 867  }
 868 }
 869
 870 STATIC int vmg_magic_chain_free(pTHX_ MAGIC *mg, MAGIC *skip) {
 871 #define vmg_magic_chain_free(M, S) vmg_magic_chain_free(aTHX_ (M), (S))
 872  int skipped = 0;
 873
 874  while (mg) {
 875   MAGIC *moremagic = mg->mg_moremagic;
 876
 877   if (mg == skip)
 878    ++skipped;
 879   else
 880    Safefree(mg);
 881
 882   mg = moremagic;
 883  }
 884
 885  return skipped;
 886 }
 887
 888 STATIC UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
 889 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
 890  MAGIC  *mg;
 891  MGVTBL *t;
 892  SV     *data;
 893  U32     oldgmg;
 894
 895  if (vmg_find(sv, w))
 896   return 1;
 897
 898  oldgmg = SvGMAGICAL(sv);
 899
 900  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
 901
 902  t  = vmg_vtable_vtbl(w->vtable);
 903  mg = sv_magicext(sv, data, PERL_MAGIC_ext, t, (const char *) wiz, HEf_SVKEY);
 904  mg->mg_private = 0;
 905
 906  /* sv_magicext() calls mg_magical and increments data's refcount */
 907  SvREFCNT_dec(data);
 908
 909  if (t->svt_copy)
 910   mg->mg_flags |= MGf_COPY;
 911 #if 0
 912  if (t->svt_dup)
 913   mg->mg_flags |= MGf_DUP;
 914 #endif
 915 #if MGf_LOCAL
 916  if (t->svt_local)
 917   mg->mg_flags |= MGf_LOCAL;
 918 #endif /* MGf_LOCAL */
 919
 920  if (SvTYPE(sv) < SVt_PVHV)
 921   goto done;
 922
 923  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 924   * magic is actually never called for them. If the GMAGICAL flag was off before
 925   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 926   * now on, then this wizard has get magic. Hence we can work around the
 927   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 928   * has uvar callbacks, it will be turned back on later. */
 929  if (!oldgmg && SvGMAGICAL(sv))
 930   SvGMAGICAL_off(sv);
 931
 932 #if VMG_UVAR
 933  if (w->uvar) {
 934   MAGIC *prevmagic, *moremagic = NULL;
 935   vmg_uvar_ud ud;
 936
 937   ud.new_uf.uf_val   = vmg_svt_val;
 938   ud.new_uf.uf_set   = NULL;
 939   ud.new_uf.uf_index = 0;
 940   ud.old_uf.uf_val   = NULL;
 941   ud.old_uf.uf_set   = NULL;
 942   ud.old_uf.uf_index = 0;
 943
 944   /* One uvar magic in the chain is enough. */
 945   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 946    moremagic = mg->mg_moremagic;
 947    if (mg->mg_type == PERL_MAGIC_uvar)
 948     break;
 949   }
 950
 951   if (mg) { /* Found another uvar magic. */
 952    struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
 953    if (uf->uf_val == vmg_svt_val) {
 954     /* It's our uvar magic, nothing to do. oldgmg was true. */
 955     goto done;
 956    } else {
 957     /* It's another uvar magic, backup it and replace it by ours. */
 958     ud.old_uf = *uf;
 959     vmg_mg_del(sv, prevmagic, mg, moremagic);
 960    }
 961   }
 962
 963   sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
 964   vmg_mg_magical(sv);
 965   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
 966    * handled by our uvar callback. */
 967  }
 968 #endif /* VMG_UVAR */
 969
 970 done:
 971  return 1;
 972 }
 973
 974 STATIC UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
 975 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
 976 #if VMG_UVAR
 977  U32 uvars = 0;
 978 #endif /* VMG_UVAR */
 979  MAGIC *mg, *prevmagic, *moremagic = NULL;
 980  IV wid = vmg_wizard_id(w);
 981
 982  if (SvTYPE(sv) < SVt_PVMG)
 983   return 0;
 984
 985  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 986   const vmg_wizard *z;
 987
 988   moremagic = mg->mg_moremagic;
 989
 990   z = vmg_wizard_from_mg(mg);
 991   if (z) {
 992    IV zid = vmg_wizard_id(z);
 993
 994 #if VMG_UVAR
 995    if (zid == wid) {
 996     /* If the current has no uvar, short-circuit uvar deletion. */
 997     uvars = z->uvar ? (uvars + 1) : 0;
 998     break;
 999    } else if (z->uvar) {
1000     ++uvars;
1001     /* We can't break here since we need to find the ext magic to delete. */
1002    }
1003 #else /* VMG_UVAR */
1004    if (zid == wid)
1005     break;
1006 #endif /* !VMG_UVAR */
1007   }
1008  }
1009  if (!mg)
1010   return 0;
1011
1012  vmg_mg_del(sv, prevmagic, mg, moremagic);
1013
1014 #if VMG_UVAR
1015  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
1016   /* mg was the first ext magic in the chain that had uvar */
1017
1018   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
1019    const vmg_wizard *z = vmg_wizard_from_mg(mg);
1020
1021    if (z && z->uvar) {
1022     ++uvars;
1023     break;
1024    }
1025   }
1026
1027   if (uvars == 1) {
1028    vmg_uvar_ud *ud;
1029
1030    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
1031     moremagic = mg->mg_moremagic;
1032     if (mg->mg_type == PERL_MAGIC_uvar)
1033      break;
1034    }
1035
1036    ud = (vmg_uvar_ud *) mg->mg_ptr;
1037    if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
1038     /* Revert the original uvar magic. */
1039     struct ufuncs *uf;
1040     Newx(uf, 1, struct ufuncs);
1041     *uf = ud->old_uf;
1042     Safefree(ud);
1043     mg->mg_ptr = (char *) uf;
1044     mg->mg_len = sizeof(*uf);
1045    } else {
1046     /* Remove the uvar magic. */
1047     vmg_mg_del(sv, prevmagic, mg, moremagic);
1048    }
1049   }
1050  }
1051 #endif /* VMG_UVAR */
1052
1053  vmg_mg_magical(sv);
1054
1055  return 1;
1056 }
1057
1058 /* ... OP info ............................................................. */
1059
1060 #define VMG_OP_INFO_NAME   1
1061 #define VMG_OP_INFO_OBJECT 2
1062
1063 #if VMG_THREADSAFE
1064 STATIC perl_mutex vmg_op_name_init_mutex;
1065 #endif
1066
1067 STATIC U32           vmg_op_name_init      = 0;
1068 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
1069
1070 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
1071 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
1072  switch (opinfo) {
1073   case VMG_OP_INFO_NAME:
1074    VMG_LOCK(&vmg_op_name_init_mutex);
1075    if (!vmg_op_name_init) {
1076     OPCODE t;
1077     for (t = 0; t < OP_max; ++t)
1078      vmg_op_name_len[t] = strlen(PL_op_name[t]);
1079     vmg_op_name_init = 1;
1080    }
1081    VMG_UNLOCK(&vmg_op_name_init_mutex);
1082    break;
1083   case VMG_OP_INFO_OBJECT: {
1084    dMY_CXT;
1085    if (!MY_CXT.b__op_stashes[0]) {
1086     int c;
1087     require_pv("B.pm");
1088     for (c = OPc_NULL; c < OPc_MAX; ++c)
1089      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1090    }
1091    break;
1092   }
1093   default:
1094    break;
1095  }
1096 }
1097
1098 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1099 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1100  if (!PL_op)
1101   return &PL_sv_undef;
1102
1103  switch (opinfo) {
1104   case VMG_OP_INFO_NAME: {
1105    OPCODE t = PL_op->op_type;
1106    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1107   }
1108   case VMG_OP_INFO_OBJECT: {
1109    dMY_CXT;
1110    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1111                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1112   }
1113   default:
1114    break;
1115  }
1116
1117  return &PL_sv_undef;
1118 }
1119
1120 /* --- svt callbacks ------------------------------------------------------- */
1121
1122 #define VMG_CB_CALL_ARGS_MASK  15
1123 #define VMG_CB_CALL_ARGS_SHIFT 4
1124 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT) /* 1|2 */
1125 #define VMG_CB_CALL_GUARD      4
1126
1127 STATIC int vmg_dispell_guard_oncroak(pTHX_ void *ud) {
1128  dMY_CXT;
1129
1130  MY_CXT.depth--;
1131
1132  /* If we're at the upmost magic call and we're about to die, we can just free
1133   * the tokens right now, since we will jump past the problematic part of our
1134   * caller. */
1135  if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1136   vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1137   MY_CXT.freed_tokens = NULL;
1138  }
1139
1140  return 1;
1141 }
1142
1143 STATIC int vmg_dispell_guard_free(pTHX_ SV *sv, MAGIC *mg) {
1144  vmg_magic_chain_free((MAGIC *) mg->mg_ptr, NULL);
1145
1146  return 0;
1147 }
1148
1149 #if VMG_THREADSAFE
1150
1151 STATIC int vmg_dispell_guard_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
1152  /* The freed magic tokens aren't cloned by perl because it cannot reach them
1153   * (they have been detached from their parent SV when they were enqueued).
1154   * Hence there's nothing to purge in the new thread. */
1155  mg->mg_ptr = NULL;
1156
1157  return 0;
1158 }
1159
1160 #endif /* VMG_THREADSAFE */
1161
1162 STATIC MGVTBL vmg_dispell_guard_vtbl = {
1163  NULL,                   /* get */
1164  NULL,                   /* set */
1165  NULL,                   /* len */
1166  NULL,                   /* clear */
1167  vmg_dispell_guard_free, /* free */
1168  NULL,                   /* copy */
1169 #if VMG_THREADSAFE
1170  vmg_dispell_guard_dup,  /* dup */
1171 #else
1172  NULL,                   /* dup */
1173 #endif
1174 #if MGf_LOCAL
1175  NULL,                   /* local */
1176 #endif /* MGf_LOCAL */
1177 };
1178
1179 STATIC SV *vmg_dispell_guard_new(pTHX_ MAGIC *root) {
1180 #define vmg_dispell_guard_new(R) vmg_dispell_guard_new(aTHX_ (R))
1181  SV *guard;
1182
1183  guard = sv_newmortal();
1184  sv_magicext(guard, NULL, PERL_MAGIC_ext, &vmg_dispell_guard_vtbl,
1185                           (char *) root, 0);
1186
1187  return guard;
1188 }
1189
1190 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1191  va_list ap;
1192  int ret = 0;
1193  unsigned int i, args, opinfo;
1194  MAGIC **chain = NULL;
1195  SV *svr;
1196
1197  dSP;
1198
1199  args    = flags & VMG_CB_CALL_ARGS_MASK;
1200  flags >>= VMG_CB_CALL_ARGS_SHIFT;
1201  opinfo  = flags & VMG_CB_CALL_OPINFO;
1202
1203  ENTER;
1204  SAVETMPS;
1205
1206  PUSHMARK(SP);
1207  EXTEND(SP, args + 1);
1208  PUSHs(sv_2mortal(newRV_inc(sv)));
1209  va_start(ap, sv);
1210  for (i = 0; i < args; ++i) {
1211   SV *sva = va_arg(ap, SV *);
1212   PUSHs(sva ? sva : &PL_sv_undef);
1213  }
1214  va_end(ap);
1215  if (opinfo)
1216   XPUSHs(vmg_op_info(opinfo));
1217  PUTBACK;
1218
1219  if (flags & VMG_CB_CALL_GUARD) {
1220   dMY_CXT;
1221   MY_CXT.depth++;
1222   vmg_call_sv(cb, G_SCALAR, vmg_dispell_guard_oncroak, NULL);
1223   MY_CXT.depth--;
1224   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens)
1225    chain = &MY_CXT.freed_tokens;
1226  } else {
1227   vmg_call_sv(cb, G_SCALAR, 0, NULL);
1228  }
1229
1230  SPAGAIN;
1231  svr = POPs;
1232  if (SvOK(svr))
1233   ret = (int) SvIV(svr);
1234  PUTBACK;
1235
1236  FREETMPS;
1237  LEAVE;
1238
1239  if (chain) {
1240   vmg_dispell_guard_new(*chain);
1241   *chain = NULL;
1242  }
1243
1244  return ret;
1245 }
1246
1247 #define VMG_CB_FLAGS(OI, A) \
1248         ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1249
1250 #define vmg_cb_call1(I, OI, S, A1) \
1251         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1252 #define vmg_cb_call2(I, OI, S, A1, A2) \
1253         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1254 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1255         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1256
1257 /* ... Default no-op magic callback ........................................ */
1258
1259 STATIC int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1260  return 0;
1261 }
1262
1263 /* ... get magic ........................................................... */
1264
1265 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1266  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1267
1268  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1269 }
1270
1271 #define vmg_svt_get_noop vmg_svt_default_noop
1272
1273 /* ... set magic ........................................................... */
1274
1275 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1276  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1277
1278  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1279 }
1280
1281 #define vmg_svt_set_noop vmg_svt_default_noop
1282
1283 /* ... len magic ........................................................... */
1284
1285 STATIC U32 vmg_sv_len(pTHX_ SV *sv) {
1286 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1287  STRLEN len;
1288 #if VMG_HAS_PERL(5, 9, 3)
1289  const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1290 #else
1291  U8 *s = SvPV(sv, len);
1292 #endif
1293
1294  return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1295 }
1296
1297 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1298  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1299  unsigned int opinfo = w->opinfo;
1300  U32 len, ret;
1301  SV *svr;
1302  svtype t = SvTYPE(sv);
1303
1304  dSP;
1305
1306  ENTER;
1307  SAVETMPS;
1308
1309  PUSHMARK(SP);
1310  EXTEND(SP, 3);
1311  PUSHs(sv_2mortal(newRV_inc(sv)));
1312  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1313  if (t < SVt_PVAV) {
1314   len = vmg_sv_len(sv);
1315   mPUSHu(len);
1316  } else if (t == SVt_PVAV) {
1317   len = av_len((AV *) sv) + 1;
1318   mPUSHu(len);
1319  } else {
1320   len = 0;
1321   PUSHs(&PL_sv_undef);
1322  }
1323  if (opinfo)
1324   XPUSHs(vmg_op_info(opinfo));
1325  PUTBACK;
1326
1327  vmg_call_sv(w->cb_len, G_SCALAR, 0, NULL);
1328
1329  SPAGAIN;
1330  svr = POPs;
1331  ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1332  if (t == SVt_PVAV)
1333   --ret;
1334  PUTBACK;
1335
1336  FREETMPS;
1337  LEAVE;
1338
1339  return ret;
1340 }
1341
1342 STATIC U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1343  U32    len = 0;
1344  svtype t   = SvTYPE(sv);
1345
1346  if (t < SVt_PVAV) {
1347   len = vmg_sv_len(sv);
1348  } else if (t == SVt_PVAV) {
1349   len = (U32) av_len((AV *) sv);
1350  }
1351
1352  return len;
1353 }
1354
1355 /* ... clear magic ......................................................... */
1356
1357 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1358  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1359  unsigned int flags  = w->opinfo;
1360
1361 #if !VMG_HAS_PERL(5, 12, 0)
1362  flags |= VMG_CB_CALL_GUARD;
1363 #endif
1364
1365  return vmg_cb_call1(w->cb_clear, flags, sv, mg->mg_obj);
1366 }
1367
1368 #define vmg_svt_clear_noop vmg_svt_default_noop
1369
1370 /* ... free magic .......................................................... */
1371
1372 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1373
1374 STATIC OP *vmg_pp_propagate_errsv(pTHX) {
1375  SVOP *o = cSVOPx(PL_op);
1376
1377  if (o->op_sv) {
1378   sv_setsv(ERRSV, o->op_sv);
1379   SvREFCNT_dec(o->op_sv);
1380   o->op_sv = NULL;
1381  }
1382
1383  return NORMAL;
1384 }
1385
1386 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1387
1388 STATIC int vmg_propagate_errsv_free(pTHX_ SV *sv, MAGIC *mg) {
1389  if (mg->mg_obj) {
1390   ERRSV         = mg->mg_obj;
1391   mg->mg_obj    = NULL;
1392   mg->mg_flags &= ~MGf_REFCOUNTED;
1393  }
1394
1395  return 0;
1396 }
1397
1398 /* perl is already kind enough to handle the cloning of the mg_obj member,
1399    hence we don't need to define a dup magic callback. */
1400
1401 STATIC MGVTBL vmg_propagate_errsv_vtbl = {
1402  0,                        /* get */
1403  0,                        /* set */
1404  0,                        /* len */
1405  0,                        /* clear */
1406  vmg_propagate_errsv_free, /* free */
1407  0,                        /* copy */
1408  0,                        /* dup */
1409 #if MGf_LOCAL
1410  0,                        /* local */
1411 #endif /* MGf_LOCAL */
1412 };
1413
1414 typedef struct {
1415  SV  *sv;
1416  int  in_eval;
1417  I32  base;
1418 } vmg_svt_free_cleanup_ud;
1419
1420 STATIC int vmg_svt_free_cleanup(pTHX_ void *ud_) {
1421  vmg_svt_free_cleanup_ud *ud = VOID2(vmg_svt_free_cleanup_ud *, ud_);
1422
1423  if (ud->in_eval) {
1424   U32 optype = PL_op ? PL_op->op_type : OP_NULL;
1425
1426   if (optype == OP_LEAVETRY || optype == OP_LEAVEEVAL) {
1427    SV *errsv = newSVsv(ERRSV);
1428
1429    FREETMPS;
1430    LEAVE_SCOPE(ud->base);
1431
1432 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1433    if (optype == OP_LEAVETRY) {
1434     dMY_CXT;
1435     PL_op = vmg_trampoline_bump(&MY_CXT.propagate_errsv, errsv, PL_op);
1436    } else if (optype == OP_LEAVEEVAL) {
1437     SV *guard = sv_newmortal();
1438     sv_magicext(guard, errsv, PERL_MAGIC_ext, &vmg_propagate_errsv_vtbl,
1439                               NULL, 0);
1440    }
1441 #else /* !VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1442 # if !VMG_HAS_PERL(5, 8, 9)
1443    {
1444     SV *guard = sv_newmortal();
1445     sv_magicext(guard, errsv, PERL_MAGIC_ext, &vmg_propagate_errsv_vtbl,
1446                               NULL, 0);
1447    }
1448 # else
1449    sv_magicext(ERRSV, errsv, PERL_MAGIC_ext, &vmg_propagate_errsv_vtbl,
1450                              NULL, 0);
1451    SvREFCNT_dec(errsv);
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