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
 494 /* --- Context-safe global data -------------------------------------------- */
 495
 496 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 497
 498 typedef struct {
 499  HV             *b__op_stashes[OPc_MAX];
 500  I32             depth;
 501  MAGIC          *freed_tokens;
 502 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
 503  vmg_trampoline  propagate_errsv;
 504 #endif
 505 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
 506  vmg_trampoline  reset_rmg;
 507 #endif
 508 } my_cxt_t;
 509
 510 START_MY_CXT
 511
 512 /* --- <vmg_vtable> structure ---------------------------------------------- */
 513
 514 #if VMG_THREADSAFE
 515
 516 typedef struct {
 517  MGVTBL *vtbl;
 518  U32     refcount;
 519 } vmg_vtable;
 520
 521 static vmg_vtable *vmg_vtable_alloc(pTHX) {
 522 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
 523  vmg_vtable *t;
 524
 525  t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
 526
 527  t->vtbl     = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
 528  t->refcount = 1;
 529
 530  return t;
 531 }
 532
 533 #define vmg_vtable_vtbl(T) (T)->vtbl
 534
 535 static perl_mutex vmg_vtable_refcount_mutex;
 536
 537 static vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
 538 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
 539  VMG_LOCK(&vmg_vtable_refcount_mutex);
 540  ++t->refcount;
 541  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
 542
 543  return t;
 544 }
 545
 546 static void vmg_vtable_free(pTHX_ vmg_vtable *t) {
 547 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
 548  U32 refcount;
 549
 550  VMG_LOCK(&vmg_vtable_refcount_mutex);
 551  refcount = --t->refcount;
 552  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
 553
 554  if (!refcount) {
 555   PerlMemShared_free(t->vtbl);
 556   PerlMemShared_free(t);
 557  }
 558 }
 559
 560 #else /* VMG_THREADSAFE */
 561
 562 typedef MGVTBL vmg_vtable;
 563
 564 static vmg_vtable *vmg_vtable_alloc(pTHX) {
 565 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
 566  vmg_vtable *t;
 567
 568  Newx(t, 1, vmg_vtable);
 569
 570  return t;
 571 }
 572
 573 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
 574
 575 #define vmg_vtable_free(T) Safefree(T)
 576
 577 #endif /* !VMG_THREADSAFE */
 578
 579 /* --- <vmg_wizard> structure ---------------------------------------------- */
 580
 581 typedef struct {
 582  vmg_vtable *vtable;
 583
 584  U8 opinfo;
 585  U8 uvar;
 586
 587  SV *cb_data;
 588  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
 589  SV *cb_copy;
 590  SV *cb_dup;
 591 #if MGf_LOCAL
 592  SV *cb_local;
 593 #endif /* MGf_LOCAL */
 594 #if VMG_UVAR
 595  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
 596 #endif /* VMG_UVAR */
 597 } vmg_wizard;
 598
 599 static void vmg_op_info_init(pTHX_ unsigned int opinfo);
 600
 601 static vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
 602 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
 603  vmg_wizard *w;
 604
 605  Newx(w, 1, vmg_wizard);
 606
 607  w->uvar   = 0;
 608  w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
 609  if (w->opinfo)
 610   vmg_op_info_init(aTHX_ w->opinfo);
 611
 612  w->vtable = vmg_vtable_alloc();
 613
 614  return w;
 615 }
 616
 617 static void vmg_wizard_free(pTHX_ vmg_wizard *w) {
 618 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
 619  if (!w)
 620   return;
 621
 622  /* During global destruction, any of the callbacks may already have been
 623   * freed, so we can't rely on still being able to access them. */
 624  if (!PL_dirty) {
 625   SvREFCNT_dec(w->cb_data);
 626   SvREFCNT_dec(w->cb_get);
 627   SvREFCNT_dec(w->cb_set);
 628   SvREFCNT_dec(w->cb_len);
 629   SvREFCNT_dec(w->cb_clear);
 630   SvREFCNT_dec(w->cb_free);
 631   SvREFCNT_dec(w->cb_copy);
 632 #if 0
 633   SvREFCNT_dec(w->cb_dup);
 634 #endif
 635 #if MGf_LOCAL
 636   SvREFCNT_dec(w->cb_local);
 637 #endif /* MGf_LOCAL */
 638 #if VMG_UVAR
 639   SvREFCNT_dec(w->cb_fetch);
 640   SvREFCNT_dec(w->cb_store);
 641   SvREFCNT_dec(w->cb_exists);
 642   SvREFCNT_dec(w->cb_delete);
 643 #endif /* VMG_UVAR */
 644  }
 645
 646  /* PerlMemShared_free() and Safefree() are still fine during global
 647   * destruction though. */
 648  vmg_vtable_free(w->vtable);
 649  Safefree(w);
 650
 651  return;
 652 }
 653
 654 #if VMG_THREADSAFE
 655
 656 #define VMG_CLONE_CB(N) \
 657  z->cb_ ## N = (w->cb_ ## N) ? SvREFCNT_inc(sv_dup(w->cb_ ## N, params)) \
 658                              : NULL;
 659
 660 static const vmg_wizard *vmg_wizard_dup(pTHX_ const vmg_wizard *w, CLONE_PARAMS *params) {
 661 #define vmg_wizard_dup(W, P) vmg_wizard_dup(aTHX_ (W), (P))
 662  vmg_wizard *z;
 663
 664  if (!w)
 665   return NULL;
 666
 667  Newx(z, 1, vmg_wizard);
 668
 669  z->vtable = vmg_vtable_dup(w->vtable);
 670  z->uvar   = w->uvar;
 671  z->opinfo = w->opinfo;
 672
 673  VMG_CLONE_CB(data);
 674  VMG_CLONE_CB(get);
 675  VMG_CLONE_CB(set);
 676  VMG_CLONE_CB(len);
 677  VMG_CLONE_CB(clear);
 678  VMG_CLONE_CB(free);
 679  VMG_CLONE_CB(copy);
 680  VMG_CLONE_CB(dup);
 681 #if MGf_LOCAL
 682  VMG_CLONE_CB(local);
 683 #endif /* MGf_LOCAL */
 684 #if VMG_UVAR
 685  VMG_CLONE_CB(fetch);
 686  VMG_CLONE_CB(store);
 687  VMG_CLONE_CB(exists);
 688  VMG_CLONE_CB(delete);
 689 #endif /* VMG_UVAR */
 690
 691  return z;
 692 }
 693
 694 #endif /* VMG_THREADSAFE */
 695
 696 #define vmg_wizard_id(W) PTR2IV(vmg_vtable_vtbl((W)->vtable))
 697
 698 /* --- Wizard SV objects --------------------------------------------------- */
 699
 700 static int vmg_wizard_sv_free(pTHX_ SV *sv, MAGIC *mg) {
 701  vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
 702
 703  return 0;
 704 }
 705
 706 #if VMG_THREADSAFE
 707
 708 static int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
 709  mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
 710
 711  return 0;
 712 }
 713
 714 #endif /* VMG_THREADSAFE */
 715
 716 static MGVTBL vmg_wizard_sv_vtbl = {
 717  NULL,               /* get */
 718  NULL,               /* set */
 719  NULL,               /* len */
 720  NULL,               /* clear */
 721  vmg_wizard_sv_free, /* free */
 722  NULL,               /* copy */
 723 #if VMG_THREADSAFE
 724  vmg_wizard_sv_dup,  /* dup */
 725 #else
 726  NULL,               /* dup */
 727 #endif
 728 #if MGf_LOCAL
 729  NULL,               /* local */
 730 #endif /* MGf_LOCAL */
 731 };
 732
 733 static SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
 734 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
 735  SV *wiz;
 736
 737 #if VMG_THREADSAFE
 738  wiz = newSV(0);
 739 #else
 740  wiz = newSViv(PTR2IV(w));
 741 #endif
 742
 743  vmg_sv_magicext(wiz, NULL, &vmg_wizard_sv_vtbl, w, 0);
 744
 745  SvREADONLY_on(wiz);
 746
 747  return wiz;
 748 }
 749
 750 #if VMG_THREADSAFE
 751
 752 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
 753
 754 static const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
 755  MAGIC *mg;
 756
 757  for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
 758   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
 759    return (const vmg_wizard *) mg->mg_ptr;
 760  }
 761
 762  return NULL;
 763 }
 764
 765 #else /* VMG_THREADSAFE */
 766
 767 #define vmg_sv_has_wizard_type(S) SvIOK(S)
 768
 769 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
 770
 771 #endif /* !VMG_THREADSAFE */
 772
 773 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
 774
 775 static const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
 776  if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
 777   SV *sv = (SV *) mg->mg_ptr;
 778
 779   if (vmg_sv_has_wizard_type(sv))
 780    return vmg_wizard_from_sv_nocheck(sv);
 781  }
 782
 783  return NULL;
 784 }
 785
 786 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
 787
 788 /* --- User-level functions implementation --------------------------------- */
 789
 790 static const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
 791  const MAGIC *mg;
 792  IV wid;
 793
 794  if (SvTYPE(sv) < SVt_PVMG)
 795   return NULL;
 796
 797  wid = vmg_wizard_id(w);
 798
 799  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 800   const vmg_wizard *z = vmg_wizard_from_mg(mg);
 801
 802   if (z && vmg_wizard_id(z) == wid)
 803    return mg;
 804  }
 805
 806  return NULL;
 807 }
 808
 809 /* ... Construct private data .............................................. */
 810
 811 static SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
 812 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
 813  I32 i;
 814  SV *nsv;
 815
 816  dSP;
 817
 818  ENTER;
 819  SAVETMPS;
 820
 821  PUSHMARK(SP);
 822  EXTEND(SP, items + 1);
 823  PUSHs(sv_2mortal(newRV_inc(sv)));
 824  for (i = 0; i < items; ++i)
 825   PUSHs(args[i]);
 826  PUTBACK;
 827
 828  vmg_call_sv(ctor, G_SCALAR, 0, NULL);
 829
 830  SPAGAIN;
 831  nsv = POPs;
 832 #if VMG_HAS_PERL(5, 8, 3)
 833  SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
 834 #else
 835  nsv = sv_newref(nsv);          /* Workaround some bug in SvREFCNT_inc() */
 836 #endif
 837  PUTBACK;
 838
 839  FREETMPS;
 840  LEAVE;
 841
 842  return nsv;
 843 }
 844
 845 static SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
 846 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
 847  const MAGIC *mg = vmg_find(sv, w);
 848
 849  return mg ? mg->mg_obj : NULL;
 850 }
 851
 852 /* ... Magic cast/dispell .................................................. */
 853
 854 #if VMG_UVAR
 855
 856 static I32 vmg_svt_val(pTHX_ IV, SV *);
 857
 858 typedef struct {
 859  struct ufuncs new_uf;
 860  struct ufuncs old_uf;
 861 } vmg_uvar_ud;
 862
 863 #endif /* VMG_UVAR */
 864
 865 static void vmg_mg_del(pTHX_ SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 866 #define vmg_mg_del(S, P, M, N) vmg_mg_del(aTHX_ (S), (P), (M), (N))
 867  dMY_CXT;
 868
 869  if (prevmagic)
 870   prevmagic->mg_moremagic = moremagic;
 871  else
 872   SvMAGIC_set(sv, moremagic);
 873
 874  /* Destroy private data */
 875 #if VMG_UVAR
 876  if (mg->mg_type == PERL_MAGIC_uvar) {
 877   Safefree(mg->mg_ptr);
 878  } else {
 879 #endif /* VMG_UVAR */
 880   if (mg->mg_obj != sv) {
 881    SvREFCNT_dec(mg->mg_obj);
 882    mg->mg_obj = NULL;
 883   }
 884   /* Unreference the wizard */
 885   SvREFCNT_dec((SV *) mg->mg_ptr);
 886   mg->mg_ptr = NULL;
 887 #if VMG_UVAR
 888  }
 889 #endif /* VMG_UVAR */
 890
 891  if (MY_CXT.depth) {
 892   mg->mg_moremagic    = MY_CXT.freed_tokens;
 893   MY_CXT.freed_tokens = mg;
 894  } else {
 895   mg->mg_moremagic = NULL;
 896   Safefree(mg);
 897  }
 898 }
 899
 900 static int vmg_magic_chain_free(pTHX_ MAGIC *mg, MAGIC *skip) {
 901 #define vmg_magic_chain_free(M, S) vmg_magic_chain_free(aTHX_ (M), (S))
 902  int skipped = 0;
 903
 904  while (mg) {
 905   MAGIC *moremagic = mg->mg_moremagic;
 906
 907   if (mg == skip)
 908    ++skipped;
 909   else
 910    Safefree(mg);
 911
 912   mg = moremagic;
 913  }
 914
 915  return skipped;
 916 }
 917
 918 static UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
 919 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
 920  MAGIC  *mg;
 921  MGVTBL *t;
 922  SV     *data;
 923  U32     oldgmg;
 924
 925  if (vmg_find(sv, w))
 926   return 1;
 927
 928  oldgmg = SvGMAGICAL(sv);
 929
 930  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
 931
 932  t  = vmg_vtable_vtbl(w->vtable);
 933  mg = vmg_sv_magicext(sv, data, t, wiz, HEf_SVKEY);
 934
 935  if (SvTYPE(sv) < SVt_PVHV)
 936   goto done;
 937
 938  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 939   * magic is actually never called for them. If the GMAGICAL flag was off before
 940   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 941   * now on, then this wizard has get magic. Hence we can work around the
 942   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 943   * has uvar callbacks, it will be turned back on later. */
 944  if (!oldgmg && SvGMAGICAL(sv))
 945   SvGMAGICAL_off(sv);
 946
 947 #if VMG_UVAR
 948  if (w->uvar) {
 949   MAGIC *prevmagic, *moremagic = NULL;
 950   vmg_uvar_ud ud;
 951
 952   ud.new_uf.uf_val   = vmg_svt_val;
 953   ud.new_uf.uf_set   = NULL;
 954   ud.new_uf.uf_index = 0;
 955   ud.old_uf.uf_val   = NULL;
 956   ud.old_uf.uf_set   = NULL;
 957   ud.old_uf.uf_index = 0;
 958
 959   /* One uvar magic in the chain is enough. */
 960   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 961    moremagic = mg->mg_moremagic;
 962    if (mg->mg_type == PERL_MAGIC_uvar)
 963     break;
 964   }
 965
 966   if (mg) { /* Found another uvar magic. */
 967    struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
 968    if (uf->uf_val == vmg_svt_val) {
 969     /* It's our uvar magic, nothing to do. oldgmg was true. */
 970     goto done;
 971    } else {
 972     /* It's another uvar magic, backup it and replace it by ours. */
 973     ud.old_uf = *uf;
 974     vmg_mg_del(sv, prevmagic, mg, moremagic);
 975    }
 976   }
 977
 978   sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
 979   vmg_mg_magical(sv);
 980   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
 981    * handled by our uvar callback. */
 982  }
 983 #endif /* VMG_UVAR */
 984
 985 done:
 986  return 1;
 987 }
 988
 989 static UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
 990 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
 991 #if VMG_UVAR
 992  U32 uvars = 0;
 993 #endif /* VMG_UVAR */
 994  MAGIC *mg, *prevmagic, *moremagic = NULL;
 995  IV wid = vmg_wizard_id(w);
 996
 997  if (SvTYPE(sv) < SVt_PVMG)
 998   return 0;
 999
1000  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
1001   const vmg_wizard *z;
1002
1003   moremagic = mg->mg_moremagic;
1004
1005   z = vmg_wizard_from_mg(mg);
1006   if (z) {
1007    IV zid = vmg_wizard_id(z);
1008
1009 #if VMG_UVAR
1010    if (zid == wid) {
1011     /* If the current has no uvar, short-circuit uvar deletion. */
1012     uvars = z->uvar ? (uvars + 1) : 0;
1013     break;
1014    } else if (z->uvar) {
1015     ++uvars;
1016     /* We can't break here since we need to find the ext magic to delete. */
1017    }
1018 #else /* VMG_UVAR */
1019    if (zid == wid)
1020     break;
1021 #endif /* !VMG_UVAR */
1022   }
1023  }
1024  if (!mg)
1025   return 0;
1026
1027  vmg_mg_del(sv, prevmagic, mg, moremagic);
1028
1029 #if VMG_UVAR
1030  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
1031   /* mg was the first ext magic in the chain that had uvar */
1032
1033   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
1034    const vmg_wizard *z = vmg_wizard_from_mg(mg);
1035
1036    if (z && z->uvar) {
1037     ++uvars;
1038     break;
1039    }
1040   }
1041
1042   if (uvars == 1) {
1043    vmg_uvar_ud *ud;
1044
1045    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
1046     moremagic = mg->mg_moremagic;
1047     if (mg->mg_type == PERL_MAGIC_uvar)
1048      break;
1049    }
1050
1051    ud = (vmg_uvar_ud *) mg->mg_ptr;
1052    if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
1053     /* Revert the original uvar magic. */
1054     struct ufuncs *uf;
1055     Newx(uf, 1, struct ufuncs);
1056     *uf = ud->old_uf;
1057     Safefree(ud);
1058     mg->mg_ptr = (char *) uf;
1059     mg->mg_len = sizeof(*uf);
1060    } else {
1061     /* Remove the uvar magic. */
1062     vmg_mg_del(sv, prevmagic, mg, moremagic);
1063    }
1064   }
1065  }
1066 #endif /* VMG_UVAR */
1067
1068  vmg_mg_magical(sv);
1069
1070  return 1;
1071 }
1072
1073 /* ... OP info ............................................................. */
1074
1075 #define VMG_OP_INFO_NAME   1
1076 #define VMG_OP_INFO_OBJECT 2
1077
1078 #if VMG_THREADSAFE
1079 static perl_mutex vmg_op_name_init_mutex;
1080 #endif
1081
1082 static U32           vmg_op_name_init      = 0;
1083 static unsigned char vmg_op_name_len[MAXO] = { 0 };
1084
1085 static void vmg_op_info_init(pTHX_ unsigned int opinfo) {
1086 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
1087  switch (opinfo) {
1088   case VMG_OP_INFO_NAME:
1089    VMG_LOCK(&vmg_op_name_init_mutex);
1090    if (!vmg_op_name_init) {
1091     OPCODE t;
1092     for (t = 0; t < OP_max; ++t)
1093      vmg_op_name_len[t] = strlen(PL_op_name[t]);
1094     vmg_op_name_init = 1;
1095    }
1096    VMG_UNLOCK(&vmg_op_name_init_mutex);
1097    break;
1098   case VMG_OP_INFO_OBJECT: {
1099    dMY_CXT;
1100    if (!MY_CXT.b__op_stashes[0]) {
1101     int c;
1102     require_pv("B.pm");
1103     for (c = OPc_NULL; c < OPc_MAX; ++c)
1104      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1105    }
1106    break;
1107   }
1108   default:
1109    break;
1110  }
1111 }
1112
1113 static SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1114 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1115  if (!PL_op)
1116   return &PL_sv_undef;
1117
1118  switch (opinfo) {
1119   case VMG_OP_INFO_NAME: {
1120    OPCODE t = PL_op->op_type;
1121    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1122   }
1123   case VMG_OP_INFO_OBJECT: {
1124    dMY_CXT;
1125    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1126                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1127   }
1128   default:
1129    break;
1130  }
1131
1132  return &PL_sv_undef;
1133 }
1134
1135 /* --- svt callbacks ------------------------------------------------------- */
1136
1137 #define VMG_CB_CALL_ARGS_MASK  15
1138 #define VMG_CB_CALL_ARGS_SHIFT 4
1139 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT) /* 1|2 */
1140 #define VMG_CB_CALL_GUARD      4
1141
1142 static int vmg_dispell_guard_oncroak(pTHX_ void *ud) {
1143  dMY_CXT;
1144
1145  MY_CXT.depth--;
1146
1147  /* If we're at the upmost magic call and we're about to die, we can just free
1148   * the tokens right now, since we will jump past the problematic part of our
1149   * caller. */
1150  if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1151   vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1152   MY_CXT.freed_tokens = NULL;
1153  }
1154
1155  return 1;
1156 }
1157
1158 static int vmg_dispell_guard_free(pTHX_ SV *sv, MAGIC *mg) {
1159  vmg_magic_chain_free((MAGIC *) mg->mg_ptr, NULL);
1160
1161  return 0;
1162 }
1163
1164 #if VMG_THREADSAFE
1165
1166 static int vmg_dispell_guard_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
1167  /* The freed magic tokens aren't cloned by perl because it cannot reach them
1168   * (they have been detached from their parent SV when they were enqueued).
1169   * Hence there's nothing to purge in the new thread. */
1170  mg->mg_ptr = NULL;
1171
1172  return 0;
1173 }
1174
1175 #endif /* VMG_THREADSAFE */
1176
1177 static MGVTBL vmg_dispell_guard_vtbl = {
1178  NULL,                   /* get */
1179  NULL,                   /* set */
1180  NULL,                   /* len */
1181  NULL,                   /* clear */
1182  vmg_dispell_guard_free, /* free */
1183  NULL,                   /* copy */
1184 #if VMG_THREADSAFE
1185  vmg_dispell_guard_dup,  /* dup */
1186 #else
1187  NULL,                   /* dup */
1188 #endif
1189 #if MGf_LOCAL
1190  NULL,                   /* local */
1191 #endif /* MGf_LOCAL */
1192 };
1193
1194 static SV *vmg_dispell_guard_new(pTHX_ MAGIC *root) {
1195 #define vmg_dispell_guard_new(R) vmg_dispell_guard_new(aTHX_ (R))
1196  SV *guard;
1197
1198  guard = sv_newmortal();
1199  vmg_sv_magicext(guard, NULL, &vmg_dispell_guard_vtbl, root, 0);
1200
1201  return guard;
1202 }
1203
1204 static int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1205  va_list ap;
1206  int ret = 0;
1207  unsigned int i, args, opinfo;
1208  MAGIC **chain = NULL;
1209  SV *svr;
1210
1211  dSP;
1212
1213  args    = flags & VMG_CB_CALL_ARGS_MASK;
1214  flags >>= VMG_CB_CALL_ARGS_SHIFT;
1215  opinfo  = flags & VMG_CB_CALL_OPINFO;
1216
1217  ENTER;
1218  SAVETMPS;
1219
1220  PUSHMARK(SP);
1221  EXTEND(SP, args + 1);
1222  PUSHs(sv_2mortal(newRV_inc(sv)));
1223  va_start(ap, sv);
1224  for (i = 0; i < args; ++i) {
1225   SV *sva = va_arg(ap, SV *);
1226   PUSHs(sva ? sva : &PL_sv_undef);
1227  }
1228  va_end(ap);
1229  if (opinfo)
1230   XPUSHs(vmg_op_info(opinfo));
1231  PUTBACK;
1232
1233  if (flags & VMG_CB_CALL_GUARD) {
1234   dMY_CXT;
1235   MY_CXT.depth++;
1236   vmg_call_sv(cb, G_SCALAR, vmg_dispell_guard_oncroak, NULL);
1237   MY_CXT.depth--;
1238   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens)
1239    chain = &MY_CXT.freed_tokens;
1240  } else {
1241   vmg_call_sv(cb, G_SCALAR, 0, NULL);
1242  }
1243
1244  SPAGAIN;
1245  svr = POPs;
1246  if (SvOK(svr))
1247   ret = (int) SvIV(svr);
1248  if (SvROK(svr))
1249   SvREFCNT_inc(svr);
1250  else
1251   svr = NULL;
1252  PUTBACK;
1253
1254  FREETMPS;
1255  LEAVE;
1256
1257  if (svr && !SvTEMP(svr))
1258   sv_2mortal(svr);
1259
1260  if (chain) {
1261   vmg_dispell_guard_new(*chain);
1262   *chain = NULL;
1263  }
1264
1265  return ret;
1266 }
1267
1268 #define VMG_CB_FLAGS(OI, A) \
1269         ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1270
1271 #define vmg_cb_call1(I, OI, S, A1) \
1272         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1273 #define vmg_cb_call2(I, OI, S, A1, A2) \
1274         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1275 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1276         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1277
1278 /* ... Default no-op magic callback ........................................ */
1279
1280 static int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1281  return 0;
1282 }
1283
1284 /* ... get magic ........................................................... */
1285
1286 static int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1287  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1288
1289  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1290 }
1291
1292 #define vmg_svt_get_noop vmg_svt_default_noop
1293
1294 /* ... set magic ........................................................... */
1295
1296 static int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1297  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1298
1299  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1300 }
1301
1302 #define vmg_svt_set_noop vmg_svt_default_noop
1303
1304 /* ... len magic ........................................................... */
1305
1306 static U32 vmg_sv_len(pTHX_ SV *sv) {
1307 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1308  STRLEN len;
1309 #if VMG_HAS_PERL(5, 9, 3)
1310  const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1311 #else
1312  U8 *s = SvPV(sv, len);
1313 #endif
1314
1315  return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1316 }
1317
1318 static U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1319  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1320  unsigned int opinfo = w->opinfo;
1321  U32 len, ret;
1322  SV *svr;
1323  svtype t = SvTYPE(sv);
1324
1325  dSP;
1326
1327  ENTER;
1328  SAVETMPS;
1329
1330  PUSHMARK(SP);
1331  EXTEND(SP, 3);
1332  PUSHs(sv_2mortal(newRV_inc(sv)));
1333  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1334  if (t < SVt_PVAV) {
1335   len = vmg_sv_len(sv);
1336   mPUSHu(len);
1337  } else if (t == SVt_PVAV) {
1338   len = av_len((AV *) sv) + 1;
1339   mPUSHu(len);
1340  } else {
1341   len = 0;
1342   PUSHs(&PL_sv_undef);
1343  }
1344  if (opinfo)
1345   XPUSHs(vmg_op_info(opinfo));
1346  PUTBACK;
1347
1348  vmg_call_sv(w->cb_len, G_SCALAR, 0, NULL);
1349
1350  SPAGAIN;
1351  svr = POPs;
1352  ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1353  if (t == SVt_PVAV)
1354   --ret;
1355  PUTBACK;
1356
1357  FREETMPS;
1358  LEAVE;
1359
1360  return ret;
1361 }
1362
1363 static U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1364  U32    len = 0;
1365  svtype t   = SvTYPE(sv);
1366
1367  if (t < SVt_PVAV) {
1368   len = vmg_sv_len(sv);
1369  } else if (t == SVt_PVAV) {
1370   len = (U32) av_len((AV *) sv);
1371  }
1372
1373  return len;
1374 }
1375
1376 /* ... clear magic ......................................................... */
1377
1378 static int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1379  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1380  unsigned int flags  = w->opinfo;
1381
1382 #if !VMG_HAS_PERL(5, 12, 0)
1383  flags |= VMG_CB_CALL_GUARD;
1384 #endif
1385
1386  return vmg_cb_call1(w->cb_clear, flags, sv, mg->mg_obj);
1387 }
1388
1389 #define vmg_svt_clear_noop vmg_svt_default_noop
1390
1391 /* ... free magic .......................................................... */
1392
1393 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1394
1395 static OP *vmg_pp_propagate_errsv(pTHX) {
1396  SVOP *o = cSVOPx(PL_op);
1397
1398  if (o->op_sv) {
1399   sv_setsv(ERRSV, o->op_sv);
1400   SvREFCNT_dec(o->op_sv);
1401   o->op_sv = NULL;
1402  }
1403
1404  return NORMAL;
1405 }
1406
1407 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1408
1409 static int vmg_propagate_errsv_free(pTHX_ SV *sv, MAGIC *mg) {
1410  if (mg->mg_obj)
1411   sv_setsv(ERRSV, mg->mg_obj);
1412
1413  return 0;
1414 }
1415
1416 /* perl is already kind enough to handle the cloning of the mg_obj member,
1417    hence we don't need to define a dup magic callback. */
1418
1419 static MGVTBL vmg_propagate_errsv_vtbl = {
1420  0,                        /* get */
1421  0,                        /* set */
1422  0,                        /* len */
1423  0,                        /* clear */
1424  vmg_propagate_errsv_free, /* free */
1425  0,                        /* copy */
1426  0,                        /* dup */
1427 #if MGf_LOCAL
1428  0,                        /* local */
1429 #endif /* MGf_LOCAL */
1430 };
1431
1432 typedef struct {
1433  SV  *sv;
1434  int  in_eval;
1435  I32  base;
1436 } vmg_svt_free_cleanup_ud;
1437
1438 static int vmg_svt_free_cleanup(pTHX_ void *ud_) {
1439  vmg_svt_free_cleanup_ud *ud = VOID2(vmg_svt_free_cleanup_ud *, ud_);
1440
1441  if (ud->in_eval) {
1442   U32 optype = PL_op ? PL_op->op_type : OP_NULL;
1443
1444   if (optype == OP_LEAVETRY || optype == OP_LEAVEEVAL) {
1445    SV *errsv = newSVsv(ERRSV);
1446
1447    FREETMPS;
1448    LEAVE_SCOPE(ud->base);
1449
1450 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1451    if (optype == OP_LEAVETRY) {
1452     dMY_CXT;
1453     PL_op = vmg_trampoline_bump(&MY_CXT.propagate_errsv, errsv, PL_op);
1454    } else if (optype == OP_LEAVEEVAL) {
1455     SV *guard = sv_newmortal();
1456     vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1457    }
1458 #else /* !VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1459 # if !VMG_HAS_PERL(5, 8, 9)
1460    {
1461     SV *guard = sv_newmortal();
1462     vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1463    }
1464 # else
1465    vmg_sv_magicext(ERRSV, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1466 # endif
1467 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1468
1469    SAVETMPS;
1470   }
1471
1472   /* Don't propagate */
1473   return 0;
1474  } else {
1475   SV    *sv = ud->sv;
1476   MAGIC *mg;
1477
1478   /* We are about to croak() while sv is being destroyed. Try to clean up
1479    * things a bit. */
1480   mg = SvMAGIC(sv);
1481   if (mg) {
1482    vmg_mg_del(sv, NULL, mg, mg->mg_moremagic);
1483    mg_magical(sv);
1484   }
1485   SvREFCNT_dec(sv);
1486
1487   vmg_dispell_guard_oncroak(aTHX_ NULL);
1488
1489   /* After that, propagate the error upwards. */
1490   return 1;
1491  }
1492 }
1493
1494 static int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1495  vmg_svt_free_cleanup_ud ud;
1496  const vmg_wizard *w;
1497  int ret = 0;
1498  SV *svr;
1499
1500  dSP;
1501
1502  /* During global destruction, we cannot be sure that the wizard and its free
1503   * callback are still alive. */
1504  if (PL_dirty)
1505   return 0;
1506
1507  w = vmg_wizard_from_mg_nocheck(mg);
1508
1509  /* So that it survives the temp cleanup below */
1510  SvREFCNT_inc_simple_void(sv);
1511
1512 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1513  /* The previous magic tokens were freed but the magic chain wasn't updated, so
1514   * if you access the sv from the callback the old deleted magics will trigger
1515   * and cause memory misreads. Change 32686 solved it that way : */
1516  SvMAGIC_set(sv, mg);
1517 #endif
1518
1519  ud.sv = sv;
1520  if (cxstack_ix < cxstack_max) {
1521   ud.in_eval = (CxTYPE(cxstack + cxstack_ix + 1) == CXt_EVAL);
1522   ud.base    = ud.in_eval ? PL_scopestack[PL_scopestack_ix] : 0;
1523  } else {
1524   ud.in_eval = 0;
1525   ud.base    = 0;
1526  }
1527
1528  ENTER;
1529  SAVETMPS;
1530
1531  PUSHMARK(SP);
1532  EXTEND(SP, 2);
1533  PUSHs(sv_2mortal(newRV_inc(sv)));
1534  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1535  if (w->opinfo)
1536   XPUSHs(vmg_op_info(w->opinfo));
1537  PUTBACK;
1538
1539  {
1540   dMY_CXT;
1541   MY_CXT.depth++;
1542   vmg_call_sv(w->cb_free, G_SCALAR, vmg_svt_free_cleanup, &ud);
1543   MY_CXT.depth--;
1544   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1545    /* Free all the tokens in the chain but the current one (if it's present).
1546     * It will be taken care of by our caller, Perl_mg_free(). */
1547    vmg_magic_chain_free(MY_CXT.freed_tokens, mg);
1548    MY_CXT.freed_tokens = NULL;
1549   }
1550  }
1551
1552  SPAGAIN;
1553  svr = POPs;
1554  if (SvOK(svr))
1555   ret = (int) SvIV(svr);
1556  PUTBACK;
1557
1558  FREETMPS;
1559  LEAVE;
1560
1561  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1562   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1563  --SvREFCNT(sv);
1564
1565  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1566   * mg->mg_ptr reference count */
1567  return ret;
1568 }
1569
1570 #define vmg_svt_free_noop vmg_svt_default_noop
1571
1572 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1573 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1574 #else
1575 # define VMG_SVT_COPY_KEYLEN_TYPE int
1576 #endif
1577
1578 /* ... copy magic .......................................................... */
1579
1580 static int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1581  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1582  SV *keysv;
1583  int ret;
1584
1585  if (keylen == HEf_SVKEY) {
1586   keysv = (SV *) key;
1587  } else {
1588   keysv = newSVpvn(key, keylen);
1589  }
1590
1591  if (SvTYPE(sv) >= SVt_PVCV)
1592   nsv = sv_2mortal(newRV_inc(nsv));
1593
1594  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1595
1596  if (keylen != HEf_SVKEY) {
1597   SvREFCNT_dec(keysv);
1598  }
1599
1600  return ret;
1601 }
1602
1603 static int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1604  return 0;
1605 }
1606
1607 /* ... dup magic ........................................................... */
1608
1609 #if 0
1610 static int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1611  return 0;
1612 }
1613 #define vmg_svt_dup_noop vmg_svt_dup
1614 #endif
1615
1616 /* ... local magic ......................................................... */
1617
1618 #if MGf_LOCAL
1619
1620 static int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1621  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1622
1623  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1624 }
1625
1626 #define vmg_svt_local_noop vmg_svt_default_noop
1627
1628 #endif /* MGf_LOCAL */
1629
1630 /* ... uvar magic .......................................................... */
1631
1632 #if VMG_UVAR
1633
1634 static OP *vmg_pp_reset_rmg(pTHX) {
1635  SVOP *o = cSVOPx(PL_op);
1636
1637  SvRMAGICAL_on(o->op_sv);
1638  o->op_sv = NULL;
1639
1640  return NORMAL;
1641 }
1642
1643 static I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1644  vmg_uvar_ud *ud;
1645  MAGIC *mg, *umg, *moremagic;
1646  SV *key = NULL, *newkey = NULL;
1647  int tied = 0;
1648
1649  umg = mg_find(sv, PERL_MAGIC_uvar);
1650  /* umg can't be NULL or we wouldn't be there. */
1651  key = umg->mg_obj;
1652  ud  = (vmg_uvar_ud *) umg->mg_ptr;
1653
1654  if (ud->old_uf.uf_val)
1655   ud->old_uf.uf_val(aTHX_ action, sv);
1656  if (ud->old_uf.uf_set)
1657   ud->old_uf.uf_set(aTHX_ action, sv);
1658
1659  for (mg = SvMAGIC(sv); mg; mg = moremagic) {
1660   const vmg_wizard *w;
1661
1662   /* mg may be freed later by the uvar call, so we need to fetch the next
1663    * token before reaching that fateful point. */
1664   moremagic = mg->mg_moremagic;
1665
1666   switch (mg->mg_type) {
1667    case PERL_MAGIC_ext:
1668     break;
1669    case PERL_MAGIC_tied:
1670     ++tied;
1671     continue;
1672    default:
1673     continue;
1674   }
1675
1676   w = vmg_wizard_from_mg(mg);
1677   if (!w)
1678    continue;
1679
1680   switch (w->uvar) {
1681    case 0:
1682     continue;
1683    case 2:
1684     if (!newkey)
1685      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1686   }
1687
1688   switch (action
1689              & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1690    case 0:
1691     if (w->cb_fetch)
1692      vmg_cb_call2(w->cb_fetch, w->opinfo | VMG_CB_CALL_GUARD, sv,
1693                                mg->mg_obj, key);
1694     break;
1695    case HV_FETCH_ISSTORE:
1696    case HV_FETCH_LVALUE:
1697    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1698     if (w->cb_store)
1699      vmg_cb_call2(w->cb_store, w->opinfo | VMG_CB_CALL_GUARD, sv,
1700                                mg->mg_obj, key);
1701     break;
1702    case HV_FETCH_ISEXISTS:
1703     if (w->cb_exists)
1704      vmg_cb_call2(w->cb_exists, w->opinfo | VMG_CB_CALL_GUARD, sv,
1705                                 mg->mg_obj, key);
1706     break;
1707    case HV_DELETE:
1708     if (w->cb_delete)
1709      vmg_cb_call2(w->cb_delete, w->opinfo | VMG_CB_CALL_GUARD, sv,
1710                                 mg->mg_obj, key);
1711     break;
1712   }
1713  }
1714
1715  if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1716   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1717    * mistaken for a tied hash by the rest of hv_common. It will be reset by
1718    * the op_ppaddr of a new fake op injected between the current and the next
1719    * one. */
1720
1721 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1722
1723   dMY_CXT;
1724
1725   PL_op = vmg_trampoline_bump(&MY_CXT.reset_rmg, sv, PL_op);
1726
1727 #else /* !VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1728
1729   OP   *nop  = PL_op->op_next;
1730   SVOP *svop = NULL;
1731
1732   if (nop && nop->op_ppaddr == vmg_pp_reset_rmg) {
1733    svop = (SVOP *) nop;
1734   } else {
1735    NewOp(1101, svop, 1, SVOP);
1736    svop->op_type    = OP_STUB;
1737    svop->op_ppaddr  = vmg_pp_reset_rmg;
1738    svop->op_next    = nop;
1739    svop->op_flags   = 0;
1740    svop->op_private = 0;
1741
1742    PL_op->op_next = (OP *) svop;
1743   }
1744
1745   svop->op_sv = sv;
1746
1747 #endif /* VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1748
1749   SvRMAGICAL_off(sv);
1750  }
1751
1752  return 0;
1753 }
1754
1755 #endif /* VMG_UVAR */
1756
1757 /* --- Module setup/teardown ----------------------------------------------- */
1758
1759 #if VMG_THREADSAFE
1760
1761 static I32 vmg_loaded = 0;
1762
1763 /* We must use preexistent global mutexes or we will never be able to destroy
1764  * them. */
1765 # if VMG_HAS_PERL(5, 9, 3)
1766 #  define VMG_LOADED_LOCK   MUTEX_LOCK(&PL_my_ctx_mutex)
1767 #  define VMG_LOADED_UNLOCK MUTEX_UNLOCK(&PL_my_ctx_mutex)
1768 # else
1769 #  define VMG_LOADED_LOCK   OP_REFCNT_LOCK
1770 #  define VMG_LOADED_UNLOCK OP_REFCNT_UNLOCK
1771 # endif
1772
1773 static void vmg_global_teardown_late_locked(pTHX) {
1774 #define vmg_global_teardown_late_locked() vmg_global_teardown_late_locked(aTHX)
1775  MUTEX_DESTROY(&vmg_op_name_init_mutex);
1776  MUTEX_DESTROY(&vmg_vtable_refcount_mutex);
1777
1778  return;
1779 }
1780
1781 static int vmg_global_teardown_free(pTHX_ SV *sv, MAGIC *mg) {
1782  VMG_LOADED_LOCK;
1783
1784  if (vmg_loaded == 0)
1785   vmg_global_teardown_late_locked();
1786
1787  VMG_LOADED_UNLOCK;
1788
1789  return 0;
1790 }
1791
1792 static MGVTBL vmg_global_teardown_vtbl = {
1793  0,
1794  0,
1795  0,
1796  0,
1797  vmg_global_teardown_free
1798 #if MGf_COPY
1799  , 0
1800 #endif
1801 #if MGf_DUP
1802  , 0
1803 #endif
1804 #if MGf_LOCAL
1805  , 0
1806 #endif
1807 };
1808
1809 static signed char vmg_destruct_level(pTHX) {
1810 #define vmg_destruct_level() vmg_destruct_level(aTHX)
1811  signed char lvl;
1812
1813  lvl = PL_perl_destruct_level;
1814
1815 #ifdef DEBUGGING
1816  {
1817   const char *s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1818   if (s) {
1819    int i;
1820 #if VMG_HAS_PERL(5, 21, 3)
1821    if (strEQ(s, "-1")) {
1822     i = -1;
1823    } else {
1824 # if VMG_HAS_PERL(5, 21, 10)
1825     UV uv;
1826     if (Perl_grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
1827      i = (int) uv;
1828     else
1829      i = 0;
1830 # else /* VMG_HAS_PERL(5, 21, 3) && !VMG_HAS_PERL(5, 21, 10) */
1831     i = Perl_grok_atou(s, NULL);
1832 # endif
1833    }
1834 #else /* !VMG_HAS_PERL(5, 21, 3) */
1835    i = atoi(s);
1836 #endif
1837    if (lvl < i)
1838     lvl = i;
1839   }
1840  }
1841 #endif
1842
1843  return lvl;
1844 }
1845
1846 #endif /* VMG_THREADSAFE */
1847
1848 static void vmg_teardown(pTHX_ void *param) {
1849  dMY_CXT;
1850
1851 #if VMG_THREADSAFE
1852  VMG_LOADED_LOCK;
1853
1854  if (vmg_loaded == 1) {
1855   vmg_loaded = 0;
1856   if (vmg_destruct_level() == 0) {
1857    vmg_global_teardown_late_locked();
1858   } else {
1859    if (!PL_strtab)
1860     PL_strtab = newHV();
1861    vmg_sv_magicext((SV *) PL_strtab, NULL, &vmg_global_teardown_vtbl, NULL, 0);
1862   }
1863  } else {
1864   assert(vmg_loaded > 1);
1865   --vmg_loaded;
1866  }
1867
1868  VMG_LOADED_UNLOCK;
1869 #endif
1870
1871  if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1872   vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1873   MY_CXT.freed_tokens = NULL;
1874  }
1875
1876  return;
1877 }
1878
1879 static void vmg_setup(pTHX) {
1880 #define vmg_setup() vmg_setup(aTHX)
1881  HV *stash;
1882  int c;
1883  MY_CXT_INIT;
1884
1885 #if VMG_THREADSAFE
1886  VMG_LOADED_LOCK;
1887
1888  if (vmg_loaded == 0) {
1889   MUTEX_INIT(&vmg_vtable_refcount_mutex);
1890   MUTEX_INIT(&vmg_op_name_init_mutex);
1891   vmg_loaded = 1;
1892  } else {
1893   assert(vmg_loaded > 0);
1894   ++vmg_loaded;
1895  }
1896
1897  VMG_LOADED_UNLOCK;
1898 #endif
1899
1900  for (c = OPc_NULL; c < OPc_MAX; ++c)
1901   MY_CXT.b__op_stashes[c] = NULL;
1902
1903  MY_CXT.depth        = 0;
1904  MY_CXT.freed_tokens = NULL;
1905
1906 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1907  vmg_trampoline_init(&MY_CXT.propagate_errsv, vmg_pp_propagate_errsv);
1908 #endif
1909 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1910  vmg_trampoline_init(&MY_CXT.reset_rmg, vmg_pp_reset_rmg);
1911 #endif
1912
1913  stash = gv_stashpv(__PACKAGE__, 1);
1914  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1915  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1916  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1917  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1918  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1919                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1920  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_NOLEN",
1921                     newSVuv(VMG_COMPAT_SCALAR_NOLEN));
1922  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1923                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1924  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1925                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1926  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1927                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1928  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1929                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1930  newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1931                     newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1932  newCONSTSUB(stash, "VMG_COMPAT_CODE_COPY_CLONE",
1933                     newSVuv(VMG_COMPAT_CODE_COPY_CLONE));
1934  newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1935  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1936  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1937  newCONSTSUB(stash, "VMG_FORKSAFE",        newSVuv(VMG_FORKSAFE));
1938  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1939  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1940
1941  call_atexit(vmg_teardown, NULL);
1942
1943  return;
1944 }
1945
1946 /* --- Macros for the XS section ------------------------------------------- */
1947
1948 #ifdef CvISXSUB
1949 # define VMG_CVOK(C) \
1950    ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
1951 #else
1952 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
1953 #endif
1954
1955 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
1956
1957 #define VMG_SET_CB(S, N) {       \
1958  SV *cb = (S);                   \
1959  if (SvOK(cb) && SvROK(cb)) {    \
1960   cb = SvRV(cb);                 \
1961   if (VMG_CBOK(cb))              \
1962    SvREFCNT_inc_simple_void(cb); \
1963   else                           \
1964    cb = NULL;                    \
1965  } else {                        \
1966   cb = NULL;                     \
1967  }                               \
1968  w->cb_ ## N = cb;               \
1969 }
1970
1971 #define VMG_SET_SVT_CB(S, N) {   \
1972  SV *cb = (S);                   \
1973  if (SvOK(cb) && SvROK(cb)) {    \
1974   cb = SvRV(cb);                 \
1975   if (VMG_CBOK(cb)) {            \
1976    t->svt_ ## N = vmg_svt_ ## N; \
1977    SvREFCNT_inc_simple_void(cb); \
1978   } else {                       \
1979    t->svt_ ## N = vmg_svt_ ## N ## _noop; \
1980    cb           = NULL;          \
1981   }                              \
1982  } else {                        \
1983   t->svt_ ## N = NULL;           \
1984   cb           = NULL;           \
1985  }                               \
1986  w->cb_ ## N = cb;               \
1987 }
1988
1989 /* --- XS ------------------------------------------------------------------ */
1990
1991 MODULE = Variable::Magic            PACKAGE = Variable::Magic
1992
1993 PROTOTYPES: ENABLE
1994
1995 BOOT:
1996 {
1997  vmg_setup();
1998 }
1999
2000 #if VMG_THREADSAFE
2001
2002 void
2003 CLONE(...)
2004 PROTOTYPE: DISABLE
2005 PREINIT:
2006  U32 had_b__op_stash = 0;
2007  I32 old_depth;
2008  int c;
2009 PPCODE:
2010  {
2011   dMY_CXT;
2012   for (c = OPc_NULL; c < OPc_MAX; ++c) {
2013    if (MY_CXT.b__op_stashes[c])
2014     had_b__op_stash |= (((U32) 1) << c);
2015   }
2016   old_depth = MY_CXT.depth;
2017  }
2018  {
2019   MY_CXT_CLONE;
2020   for (c = OPc_NULL; c < OPc_MAX; ++c) {
2021    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
2022                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
2023   }
2024   MY_CXT.depth        = old_depth;
2025   MY_CXT.freed_tokens = NULL;
2026   VMG_LOADED_LOCK;
2027   assert(vmg_loaded > 0);
2028   ++vmg_loaded;
2029   VMG_LOADED_UNLOCK;
2030  }
2031  XSRETURN(0);
2032
2033 #endif /* VMG_THREADSAFE */
2034
2035 SV *_wizard(...)
2036 PROTOTYPE: DISABLE
2037 PREINIT:
2038  vmg_wizard *w;
2039  MGVTBL *t;
2040  SV *op_info, *copy_key;
2041  I32 i = 0;
2042 CODE:
2043  if (items != 9
2044 #if MGf_LOCAL
2045               + 1
2046 #endif /* MGf_LOCAL */
2047 #if VMG_UVAR
2048               + 5
2049 #endif /* VMG_UVAR */
2050               ) { croak(vmg_wrongargnum); }
2051
2052  op_info = ST(i++);
2053  w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
2054  t = vmg_vtable_vtbl(w->vtable);
2055
2056  VMG_SET_CB(ST(i++), data);
2057
2058  VMG_SET_SVT_CB(ST(i++), get);
2059  VMG_SET_SVT_CB(ST(i++), set);
2060  VMG_SET_SVT_CB(ST(i++), len);
2061  VMG_SET_SVT_CB(ST(i++), clear);
2062  VMG_SET_SVT_CB(ST(i++), free);
2063  VMG_SET_SVT_CB(ST(i++), copy);
2064  /* VMG_SET_SVT_CB(ST(i++), dup); */
2065  i++;
2066  t->svt_dup = NULL;
2067  w->cb_dup  = NULL;
2068 #if MGf_LOCAL
2069  VMG_SET_SVT_CB(ST(i++), local);
2070 #endif /* MGf_LOCAL */
2071 #if VMG_UVAR
2072  VMG_SET_CB(ST(i++), fetch);
2073  VMG_SET_CB(ST(i++), store);
2074  VMG_SET_CB(ST(i++), exists);
2075  VMG_SET_CB(ST(i++), delete);
2076
2077  copy_key = ST(i++);
2078  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
2079   w->uvar = SvTRUE(copy_key) ? 2 : 1;
2080 #endif /* VMG_UVAR */
2081
2082  RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
2083 OUTPUT:
2084  RETVAL
2085
2086 SV *cast(SV *sv, SV *wiz, ...)
2087 PROTOTYPE: \[$@%&*]$@
2088 PREINIT:
2089  const vmg_wizard *w = NULL;
2090  SV **args = NULL;
2091  I32 i = 0;
2092 CODE:
2093  if (items > 2) {
2094   i = items - 2;
2095   args = &ST(2);
2096  }
2097  if (SvROK(wiz)) {
2098   wiz = SvRV_const(wiz);
2099   w   = vmg_wizard_from_sv(wiz);
2100  }
2101  if (!w)
2102   croak(vmg_invalid_wiz);
2103  RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
2104 OUTPUT:
2105  RETVAL
2106
2107 void
2108 getdata(SV *sv, SV *wiz)
2109 PROTOTYPE: \[$@%&*]$
2110 PREINIT:
2111  const vmg_wizard *w = NULL;
2112  SV *data;
2113 PPCODE:
2114  if (SvROK(wiz))
2115   w = vmg_wizard_from_sv(SvRV_const(wiz));
2116  if (!w)
2117   croak(vmg_invalid_wiz);
2118  data = vmg_data_get(SvRV(sv), w);
2119  if (!data)
2120   XSRETURN_EMPTY;
2121  ST(0) = data;
2122  XSRETURN(1);
2123
2124 SV *dispell(SV *sv, SV *wiz)
2125 PROTOTYPE: \[$@%&*]$
2126 PREINIT:
2127  const vmg_wizard *w = NULL;
2128 CODE:
2129  if (SvROK(wiz))
2130   w = vmg_wizard_from_sv(SvRV_const(wiz));
2131  if (!w)
2132   croak(vmg_invalid_wiz);
2133  RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));
2134 OUTPUT:
2135  RETVAL