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