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 #ifndef VMG_PERL_PATCHLEVEL
  16 # ifdef PERL_PATCHNUM
  17 #  define VMG_PERL_PATCHLEVEL PERL_PATCHNUM
  18 # else
  19 #  define VMG_PERL_PATCHLEVEL 0
  20 # endif
  21 #endif
  22
  23 #define VMG_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  24
  25 #define VMG_HAS_PERL_BRANCH(R, V, S) (PERL_REVISION == (R) && PERL_VERSION == (V) && PERL_SUBVERSION >= (S))
  26
  27 #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))))
  28
  29 /* --- Threads and multiplicity -------------------------------------------- */
  30
  31 #ifndef NOOP
  32 # define NOOP
  33 #endif
  34
  35 #ifndef dNOOP
  36 # define dNOOP
  37 #endif
  38
  39 /* Safe unless stated otherwise in Makefile.PL */
  40 #ifndef VMG_FORKSAFE
  41 # define VMG_FORKSAFE 1
  42 #endif
  43
  44 #ifndef VMG_MULTIPLICITY
  45 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
  46 #  define VMG_MULTIPLICITY 1
  47 # else
  48 #  define VMG_MULTIPLICITY 0
  49 # endif
  50 #endif
  51 #if VMG_MULTIPLICITY && !defined(tTHX)
  52 # define tTHX PerlInterpreter*
  53 #endif
  54
  55 #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))
  56 # define VMG_THREADSAFE 1
  57 # ifndef MY_CXT_CLONE
  58 #  define MY_CXT_CLONE \
  59     dMY_CXT_SV;                                                      \
  60     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
  61     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
  62     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
  63 # endif
  64 #else
  65 # define VMG_THREADSAFE 0
  66 # undef  dMY_CXT
  67 # define dMY_CXT      dNOOP
  68 # undef  MY_CXT
  69 # define MY_CXT       vmg_globaldata
  70 # undef  START_MY_CXT
  71 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
  72 # undef  MY_CXT_INIT
  73 # define MY_CXT_INIT  NOOP
  74 # undef  MY_CXT_CLONE
  75 # define MY_CXT_CLONE NOOP
  76 #endif
  77
  78 #if VMG_THREADSAFE
  79
  80 STATIC SV *vmg_clone(pTHX_ SV *sv, tTHX owner) {
  81 #define vmg_clone(P, O) vmg_clone(aTHX_ (P), (O))
  82  CLONE_PARAMS param;
  83
  84  param.stashes    = NULL; /* don't need it unless sv is a PVHV */
  85  param.flags      = 0;
  86  param.proto_perl = owner;
  87
  88  return SvREFCNT_inc(sv_dup(sv, &param));
  89 }
  90
  91 #endif /* VMG_THREADSAFE */
  92
  93 /* --- Compatibility ------------------------------------------------------- */
  94
  95 #ifndef Newx
  96 # define Newx(v, n, c) New(0, v, n, c)
  97 #endif
  98
  99 #ifndef SvMAGIC_set
 100 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
 101 #endif
 102
 103 #ifndef mPUSHu
 104 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
 105 #endif
 106
 107 #ifndef SvPV_const
 108 # define SvPV_const SvPV
 109 #endif
 110
 111 #ifndef PERL_MAGIC_ext
 112 # define PERL_MAGIC_ext '~'
 113 #endif
 114
 115 #ifndef PERL_MAGIC_tied
 116 # define PERL_MAGIC_tied 'P'
 117 #endif
 118
 119 #ifndef MGf_COPY
 120 # define MGf_COPY 0
 121 #endif
 122
 123 #ifndef MGf_DUP
 124 # define MGf_DUP 0
 125 #endif
 126
 127 #ifndef MGf_LOCAL
 128 # define MGf_LOCAL 0
 129 #endif
 130
 131 #ifndef IN_PERL_COMPILETIME
 132 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
 133 #endif
 134
 135 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
 136 # ifndef PL_error_count
 137 #  define PL_error_count PL_parser->error_count
 138 # endif
 139 #else
 140 # ifndef PL_error_count
 141 #  define PL_error_count PL_Ierror_count
 142 # endif
 143 #endif
 144
 145 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but only
 146  * enable it on 5.10 */
 147 #if VMG_HAS_PERL(5, 10, 0)
 148 # define VMG_UVAR 1
 149 #else
 150 # define VMG_UVAR 0
 151 #endif
 152
 153 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
 154  * reverted to dev-5.11 as 9cdcb38b */
 155 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
 156 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
 157 /* This branch should only apply for perls before the official 5.11.0 release.
 158  * Makefile.PL takes care of the higher ones. */
 159 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
 160 # endif
 161 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
 162 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
 163 # endif
 164 #else
 165 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
 166 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
 167 # endif
 168 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
 169 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
 170 # endif
 171 #endif
 172
 173 /* Applied to dev-5.11 as 34908 */
 174 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908)
 175 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
 176 #else
 177 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
 178 #endif
 179
 180 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
 181 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
 182 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
 183 #else
 184 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
 185 #endif
 186
 187 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969)
 188 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
 189 #else
 190 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
 191 #endif
 192
 193 #if VMG_UVAR
 194
 195 /* Bug-free mg_magical - see http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html - but specialized to our needs. */
 196 STATIC void vmg_sv_magicuvar(pTHX_ SV *sv, const char *uf, I32 len) {
 197 #define vmg_sv_magicuvar(S, U, L) vmg_sv_magicuvar(aTHX_ (S), (U), (L))
 198  const MAGIC* mg;
 199  sv_magic(sv, NULL, PERL_MAGIC_uvar, uf, len);
 200  /* uvar magic has set and get magic, hence this has set SVs_GMG and SVs_SMG. */
 201  if ((mg = SvMAGIC(sv))) {
 202   SvRMAGICAL_off(sv);
 203   do {
 204    const MGVTBL* const vtbl = mg->mg_virtual;
 205    if (vtbl) {
 206     if (vtbl->svt_clear) {
 207      SvRMAGICAL_on(sv);
 208      break;
 209     }
 210    }
 211   } while ((mg = mg->mg_moremagic));
 212  }
 213 }
 214
 215 #endif /* VMG_UVAR */
 216
 217 /* --- Stolen chunk of B --------------------------------------------------- */
 218
 219 typedef enum {
 220  OPc_NULL   = 0,
 221  OPc_BASEOP = 1,
 222  OPc_UNOP   = 2,
 223  OPc_BINOP  = 3,
 224  OPc_LOGOP  = 4,
 225  OPc_LISTOP = 5,
 226  OPc_PMOP   = 6,
 227  OPc_SVOP   = 7,
 228  OPc_PADOP  = 8,
 229  OPc_PVOP   = 9,
 230  OPc_LOOP   = 10,
 231  OPc_COP    = 11,
 232  OPc_MAX    = 12
 233 } opclass;
 234
 235 STATIC const char *const vmg_opclassnames[] = {
 236  "B::NULL",
 237  "B::OP",
 238  "B::UNOP",
 239  "B::BINOP",
 240  "B::LOGOP",
 241  "B::LISTOP",
 242  "B::PMOP",
 243  "B::SVOP",
 244  "B::PADOP",
 245  "B::PVOP",
 246  "B::LOOP",
 247  "B::COP"
 248 };
 249
 250 STATIC opclass vmg_opclass(const OP *o) {
 251 #if 0
 252  if (!o)
 253   return OPc_NULL;
 254 #endif
 255
 256  if (o->op_type == 0)
 257   return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 258
 259  if (o->op_type == OP_SASSIGN)
 260   return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
 261
 262  if (o->op_type == OP_AELEMFAST) {
 263   if (o->op_flags & OPf_SPECIAL)
 264    return OPc_BASEOP;
 265   else
 266 #ifdef USE_ITHREADS
 267    return OPc_PADOP;
 268 #else
 269    return OPc_SVOP;
 270 #endif
 271  }
 272
 273 #ifdef USE_ITHREADS
 274  if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
 275   return OPc_PADOP;
 276 #endif
 277
 278  switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
 279   case OA_BASEOP:
 280    return OPc_BASEOP;
 281   case OA_UNOP:
 282    return OPc_UNOP;
 283   case OA_BINOP:
 284    return OPc_BINOP;
 285   case OA_LOGOP:
 286    return OPc_LOGOP;
 287   case OA_LISTOP:
 288    return OPc_LISTOP;
 289   case OA_PMOP:
 290    return OPc_PMOP;
 291   case OA_SVOP:
 292    return OPc_SVOP;
 293   case OA_PADOP:
 294    return OPc_PADOP;
 295   case OA_PVOP_OR_SVOP:
 296    return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
 297   case OA_LOOP:
 298    return OPc_LOOP;
 299   case OA_COP:
 300    return OPc_COP;
 301   case OA_BASEOP_OR_UNOP:
 302    return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 303   case OA_FILESTATOP:
 304    return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
 305 #ifdef USE_ITHREADS
 306            (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
 307 #else
 308            (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
 309 #endif
 310   case OA_LOOPEXOP:
 311    if (o->op_flags & OPf_STACKED)
 312     return OPc_UNOP;
 313    else if (o->op_flags & OPf_SPECIAL)
 314     return OPc_BASEOP;
 315    else
 316     return OPc_PVOP;
 317  }
 318
 319  return OPc_BASEOP;
 320 }
 321
 322 /* --- Error messages ------------------------------------------------------ */
 323
 324 STATIC const char vmg_invalid_wiz[]    = "Invalid wizard object";
 325 STATIC const char vmg_wrongargnum[]    = "Wrong number of arguments";
 326 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
 327
 328 /* --- Signatures ---------------------------------------------------------- */
 329
 330 #define SIG_WZO ((U16) (0x3891))
 331 #define SIG_WIZ ((U16) (0x3892))
 332
 333 /* --- MGWIZ structure ----------------------------------------------------- */
 334
 335 typedef struct {
 336  MGVTBL *vtbl;
 337
 338  U8 uvar;
 339  U8 opinfo;
 340
 341  SV *cb_data;
 342  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
 343 #if MGf_COPY
 344  SV *cb_copy;
 345 #endif /* MGf_COPY */
 346 #if MGf_DUP
 347  SV *cb_dup;
 348 #endif /* MGf_DUP */
 349 #if MGf_LOCAL
 350  SV *cb_local;
 351 #endif /* MGf_LOCAL */
 352 #if VMG_UVAR
 353  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
 354 #endif /* VMG_UVAR */
 355
 356 #if VMG_MULTIPLICITY
 357  tTHX owner;
 358 #endif /* VMG_MULTIPLICITY */
 359 } MGWIZ;
 360
 361 STATIC void vmg_mgwiz_free(pTHX_ MGWIZ *w) {
 362 #define vmg_mgwiz_free(W) vmg_mgwiz_free(aTHX_ (W))
 363  if (!w)
 364   return;
 365
 366  if (w->cb_data)   SvREFCNT_dec(SvRV(w->cb_data));
 367  if (w->cb_get)    SvREFCNT_dec(SvRV(w->cb_get));
 368  if (w->cb_set)    SvREFCNT_dec(SvRV(w->cb_set));
 369  if (w->cb_len)    SvREFCNT_dec(SvRV(w->cb_len));
 370  if (w->cb_clear)  SvREFCNT_dec(SvRV(w->cb_clear));
 371  if (w->cb_free)   SvREFCNT_dec(SvRV(w->cb_free));
 372 #if MGf_COPY
 373  if (w->cb_copy)   SvREFCNT_dec(SvRV(w->cb_copy));
 374 #endif /* MGf_COPY */
 375 #if 0 /* MGf_DUP */
 376  if (w->cb_dup)    SvREFCNT_dec(SvRV(w->cb_dup));
 377 #endif /* MGf_DUP */
 378 #if MGf_LOCAL
 379  if (w->cb_local)  SvREFCNT_dec(SvRV(w->cb_local));
 380 #endif /* MGf_LOCAL */
 381 #if VMG_UVAR
 382  if (w->cb_fetch)  SvREFCNT_dec(SvRV(w->cb_fetch));
 383  if (w->cb_store)  SvREFCNT_dec(SvRV(w->cb_store));
 384  if (w->cb_exists) SvREFCNT_dec(SvRV(w->cb_exists));
 385  if (w->cb_delete) SvREFCNT_dec(SvRV(w->cb_delete));
 386 #endif /* VMG_UVAR */
 387
 388  Safefree(w->vtbl);
 389  Safefree(w);
 390
 391  return;
 392 }
 393
 394 #if VMG_THREADSAFE
 395
 396 #define VMG_CLONE_CB(N) \
 397  z->cb_ ## N = (w->cb_ ## N) ? newRV_noinc(vmg_clone(SvRV(w->cb_ ## N), \
 398                                            w->owner))                   \
 399                              : NULL;
 400
 401 STATIC MGWIZ *vmg_mgwiz_clone(pTHX_ const MGWIZ *w) {
 402 #define vmg_mgwiz_clone(W) vmg_mgwiz_clone(aTHX_ (W))
 403  MGVTBL *t;
 404  MGWIZ *z;
 405
 406  if (!w)
 407   return NULL;
 408
 409  Newx(t, 1, MGVTBL);
 410  Copy(w->vtbl, t, 1, MGVTBL);
 411
 412  Newx(z, 1, MGWIZ);
 413
 414  z->vtbl   = t;
 415  z->uvar   = w->uvar;
 416  z->opinfo = w->opinfo;
 417
 418  VMG_CLONE_CB(data);
 419  VMG_CLONE_CB(get);
 420  VMG_CLONE_CB(set);
 421  VMG_CLONE_CB(len);
 422  VMG_CLONE_CB(clear);
 423  VMG_CLONE_CB(free);
 424 #if MGf_COPY
 425  VMG_CLONE_CB(copy);
 426 #endif /* MGf_COPY */
 427 #if MGf_DUP
 428  VMG_CLONE_CB(dup);
 429 #endif /* MGf_DUP */
 430 #if MGf_LOCAL
 431  VMG_CLONE_CB(local);
 432 #endif /* MGf_LOCAL */
 433 #if VMG_UVAR
 434  VMG_CLONE_CB(fetch);
 435  VMG_CLONE_CB(store);
 436  VMG_CLONE_CB(exists);
 437  VMG_CLONE_CB(delete);
 438 #endif /* VMG_UVAR */
 439
 440  z->owner = aTHX;
 441
 442  return z;
 443 }
 444
 445 #endif /* VMG_THREADSAFE */
 446
 447 /* --- Context-safe global data -------------------------------------------- */
 448
 449 #if VMG_THREADSAFE
 450
 451 #define PTABLE_NAME        ptable
 452 #define PTABLE_VAL_FREE(V) vmg_mgwiz_free(V)
 453
 454 #define pPTBL  pTHX
 455 #define pPTBL_ pTHX_
 456 #define aPTBL  aTHX
 457 #define aPTBL_ aTHX_
 458
 459 #include "ptable.h"
 460
 461 #define ptable_store(T, K, V) ptable_store(aTHX_ (T), (K), (V))
 462 #define ptable_clear(T)       ptable_clear(aTHX_ (T))
 463 #define ptable_free(T)        ptable_free(aTHX_ (T))
 464
 465 #endif /* VMG_THREADSAFE */
 466
 467 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 468
 469 typedef struct {
 470 #if VMG_THREADSAFE
 471  ptable *wizards;
 472  tTHX    owner;
 473 #endif
 474  HV     *b__op_stashes[OPc_MAX];
 475 } my_cxt_t;
 476
 477 START_MY_CXT
 478
 479 #if VMG_THREADSAFE
 480
 481 STATIC void vmg_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
 482  my_cxt_t *ud = ud_;
 483  MGWIZ *w;
 484
 485  if (ud->owner == aTHX)
 486   return;
 487
 488  w = vmg_mgwiz_clone(ent->val);
 489  if (w)
 490   ptable_store(ud->wizards, ent->key, w);
 491 }
 492
 493 #endif /* VMG_THREADSAFE */
 494
 495 /* --- Wizard objects ------------------------------------------------------ */
 496
 497 STATIC int vmg_wizard_free(pTHX_ SV *sv, MAGIC *mg);
 498
 499 STATIC MGVTBL vmg_wizard_vtbl = {
 500  NULL,            /* get */
 501  NULL,            /* set */
 502  NULL,            /* len */
 503  NULL,            /* clear */
 504  vmg_wizard_free, /* free */
 505 #if MGf_COPY
 506  NULL,            /* copy */
 507 #endif /* MGf_COPY */
 508 #if MGf_DUP
 509  NULL,            /* dup */
 510 #endif /* MGf_DUP */
 511 #if MGf_LOCAL
 512  NULL,            /* local */
 513 #endif /* MGf_LOCAL */
 514 };
 515
 516 /* ... Wizard constructor .................................................. */
 517
 518 STATIC SV *vmg_wizard_new(pTHX_ const MGWIZ *w) {
 519 #define vmg_wizard_new(W) vmg_wizard_new(aTHX_ (W))
 520  SV *wiz = newSVuv(PTR2UV(w));
 521
 522  if (w) {
 523   MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
 524   mg->mg_private = SIG_WZO;
 525  }
 526  SvREADONLY_on(wiz);
 527
 528  return wiz;
 529 }
 530
 531 STATIC SV *vmg_wizard_validate(pTHX_ SV *wiz) {
 532 #define vmg_wizard_validate(W) vmg_wizard_validate(aTHX_ (W))
 533  if (SvROK(wiz)) {
 534   wiz = SvRV(wiz);
 535   if (SvIOK(wiz))
 536    return wiz;
 537  }
 538
 539  croak(vmg_invalid_wiz);
 540 }
 541
 542 #define vmg_wizard_id(W)         SvUV((SV *) (W))
 543 #define vmg_wizard_main_mgwiz(W) INT2PTR(const MGWIZ *, vmg_wizard_id(W))
 544
 545 /* ... Wizard destructor ................................................... */
 546
 547 STATIC int vmg_wizard_free(pTHX_ SV *sv, MAGIC *mg) {
 548  MGWIZ *w;
 549
 550  if (PL_dirty) /* During global destruction, the context is already freed */
 551   return 0;
 552
 553  w = (MGWIZ *) vmg_wizard_main_mgwiz(sv);
 554
 555 #if VMG_THREADSAFE
 556  {
 557   dMY_CXT;
 558   ptable_store(MY_CXT.wizards, w, NULL);
 559  }
 560 #else /* VMG_THREADSAFE */
 561  vmg_mgwiz_free(w);
 562 #endif /* !VMG_THREADSAFE */
 563
 564  return 0;
 565 }
 566
 567 #if VMG_THREADSAFE
 568
 569 STATIC const MGWIZ *vmg_wizard_mgwiz(pTHX_ SV *wiz) {
 570 #define vmg_wizard_mgwiz(W) vmg_wizard_mgwiz(aTHX_ ((SV *) (W)))
 571  const MGWIZ *w;
 572
 573  w = vmg_wizard_main_mgwiz(wiz);
 574  if (w->owner == aTHX)
 575   return w;
 576
 577  {
 578   dMY_CXT;
 579   return ptable_fetch(MY_CXT.wizards, w);
 580  }
 581 }
 582
 583 #else /* VMG_THREADSAFE */
 584
 585 #define vmg_wizard_mgwiz(W) vmg_wizard_main_mgwiz(W)
 586
 587 #endif /* !VMG_THREADSAFE */
 588
 589 /* --- User-level functions implementation --------------------------------- */
 590
 591 STATIC const MAGIC *vmg_find(pTHX_ const SV *sv, SV *wiz) {
 592 #define vmg_find(S, W) vmg_find(aTHX_ (S), (W))
 593  const MAGIC *mg, *moremagic;
 594  UV wid;
 595
 596  if (SvTYPE(sv) < SVt_PVMG)
 597   return NULL;
 598
 599  wid = vmg_wizard_id(wiz);
 600  for (mg = SvMAGIC(sv); mg; mg = moremagic) {
 601   moremagic = mg->mg_moremagic;
 602   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
 603    UV zid = vmg_wizard_id(mg->mg_ptr);
 604    if (zid == wid)
 605     return mg;
 606   }
 607  }
 608
 609  return NULL;
 610 }
 611
 612 /* ... Construct private data .............................................. */
 613
 614 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, AV *args) {
 615 #define vmg_data_new(C, S, A) vmg_data_new(aTHX_ (C), (S), (A))
 616  SV *nsv;
 617  I32 i, alen = (args == NULL) ? 0 : av_len(args);
 618
 619  dSP;
 620
 621  ENTER;
 622  SAVETMPS;
 623
 624  PUSHMARK(SP);
 625  EXTEND(SP, alen + 1);
 626  PUSHs(sv_2mortal(newRV_inc(sv)));
 627  for (i = 0; i < alen; ++i)
 628   PUSHs(*av_fetch(args, i, 0));
 629  PUTBACK;
 630
 631  call_sv(ctor, G_SCALAR);
 632
 633  SPAGAIN;
 634  nsv = POPs;
 635 #if VMG_HAS_PERL(5, 8, 3)
 636  SvREFCNT_inc(nsv);    /* Or it will be destroyed in FREETMPS */
 637 #else
 638  nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
 639 #endif
 640  PUTBACK;
 641
 642  FREETMPS;
 643  LEAVE;
 644
 645  return nsv;
 646 }
 647
 648 STATIC SV *vmg_data_get(pTHX_ SV *sv, SV *wiz) {
 649 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
 650  const MAGIC *mg = vmg_find(sv, wiz);
 651  return mg ? mg->mg_obj : NULL;
 652 }
 653
 654 /* ... Magic cast/dispell .................................................. */
 655
 656 #if VMG_UVAR
 657 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
 658
 659 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 660  if (prevmagic) {
 661   prevmagic->mg_moremagic = moremagic;
 662  } else {
 663   SvMAGIC_set(sv, moremagic);
 664  }
 665  mg->mg_moremagic = NULL;
 666  Safefree(mg->mg_ptr);
 667  Safefree(mg);
 668 }
 669 #endif /* VMG_UVAR */
 670
 671 STATIC UV vmg_cast(pTHX_ SV *sv, SV *wiz, AV *args) {
 672 #define vmg_cast(S, W, A) vmg_cast(aTHX_ (S), (W), (A))
 673  MAGIC       *mg, *moremagic = NULL;
 674  SV          *data;
 675  const MGWIZ *w;
 676  U32          oldgmg;
 677
 678  if (vmg_find(sv, wiz))
 679   return 1;
 680
 681  w = vmg_wizard_mgwiz(wiz);
 682  oldgmg = SvGMAGICAL(sv);
 683
 684  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args) : NULL;
 685  mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
 686  mg->mg_private = SIG_WIZ;
 687 #if MGf_COPY
 688  if (w->cb_copy)
 689   mg->mg_flags |= MGf_COPY;
 690 #endif /* MGf_COPY */
 691 #if 0 /* MGf_DUP */
 692  if (w->cb_dup)
 693   mg->mg_flags |= MGf_DUP;
 694 #endif /* MGf_DUP */
 695 #if MGf_LOCAL
 696  if (w->cb_local)
 697   mg->mg_flags |= MGf_LOCAL;
 698 #endif /* MGf_LOCAL */
 699
 700  if (SvTYPE(sv) < SVt_PVHV)
 701   goto done;
 702
 703  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 704   * magic is actually never called for them. If the GMAGICAL flag was off before
 705   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 706   * now on, then this wizard has get magic. Hence we can work around the
 707   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 708   * has uvar callbacks, it will be turned back on later. */
 709  if (!oldgmg && SvGMAGICAL(sv))
 710   SvGMAGICAL_off(sv);
 711
 712 #if VMG_UVAR
 713  if (w->uvar) {
 714   MAGIC *prevmagic;
 715   struct ufuncs uf[2];
 716
 717   uf[0].uf_val   = vmg_svt_val;
 718   uf[0].uf_set   = NULL;
 719   uf[0].uf_index = 0;
 720   uf[1].uf_val   = NULL;
 721   uf[1].uf_set   = NULL;
 722   uf[1].uf_index = 0;
 723
 724   /* One uvar magic in the chain is enough. */
 725   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 726    moremagic = mg->mg_moremagic;
 727    if (mg->mg_type == PERL_MAGIC_uvar)
 728     break;
 729   }
 730
 731   if (mg) { /* Found another uvar magic. */
 732    struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
 733    if (olduf->uf_val == vmg_svt_val) {
 734     /* It's our uvar magic, nothing to do. oldgmg was true. */
 735     goto done;
 736    } else {
 737     /* It's another uvar magic, backup it and replace it by ours. */
 738     uf[1] = *olduf;
 739     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 740    }
 741   }
 742
 743   vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
 744   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
 745    * handled by our uvar callback. */
 746  }
 747 #endif /* VMG_UVAR */
 748
 749 done:
 750  return 1;
 751 }
 752
 753 STATIC UV vmg_dispell(pTHX_ SV *sv, SV *wiz) {
 754 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
 755 #if VMG_UVAR
 756  U32 uvars = 0;
 757 #endif /* VMG_UVAR */
 758  MAGIC *mg, *prevmagic, *moremagic = NULL;
 759  UV wid = vmg_wizard_id(wiz);
 760
 761  if (SvTYPE(sv) < SVt_PVMG)
 762   return 0;
 763
 764  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 765   moremagic = mg->mg_moremagic;
 766   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
 767    const MGWIZ *z   = vmg_wizard_mgwiz(mg->mg_ptr);
 768    UV           zid = vmg_wizard_id(mg->mg_ptr);
 769    if (zid == wid) {
 770 #if VMG_UVAR
 771     /* If the current has no uvar, short-circuit uvar deletion. */
 772     uvars = z->uvar ? (uvars + 1) : 0;
 773 #endif /* VMG_UVAR */
 774     break;
 775 #if VMG_UVAR
 776    } else if (z->uvar) {
 777     ++uvars;
 778     /* We can't break here since we need to find the ext magic to delete. */
 779 #endif /* VMG_UVAR */
 780    }
 781   }
 782  }
 783  if (!mg)
 784   return 0;
 785
 786  if (prevmagic) {
 787   prevmagic->mg_moremagic = moremagic;
 788  } else {
 789   SvMAGIC_set(sv, moremagic);
 790  }
 791  mg->mg_moremagic = NULL;
 792
 793  /* Destroy private data */
 794  if (mg->mg_obj != sv)
 795   SvREFCNT_dec(mg->mg_obj);
 796  /* Unreference the wizard */
 797  SvREFCNT_dec((SV *) mg->mg_ptr);
 798  Safefree(mg);
 799
 800 #if VMG_UVAR
 801  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
 802   /* mg was the first ext magic in the chain that had uvar */
 803
 804   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
 805    if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
 806     const MGWIZ *z = vmg_wizard_mgwiz(mg->mg_ptr);
 807     if (z->uvar) {
 808      ++uvars;
 809      break;
 810     }
 811    }
 812   }
 813
 814   if (uvars == 1) {
 815    struct ufuncs *uf;
 816    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
 817     moremagic = mg->mg_moremagic;
 818     if (mg->mg_type == PERL_MAGIC_uvar)
 819      break;
 820    }
 821    /* assert(mg); */
 822    uf = (struct ufuncs *) mg->mg_ptr;
 823    /* assert(uf->uf_val == vmg_svt_val); */
 824    if (uf[1].uf_val || uf[1].uf_set) {
 825     /* Revert the original uvar magic. */
 826     uf[0] = uf[1];
 827     Renew(uf, 1, struct ufuncs);
 828     mg->mg_ptr = (char *) uf;
 829     mg->mg_len = sizeof(struct ufuncs);
 830    } else {
 831     /* Remove the uvar magic. */
 832     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 833    }
 834   }
 835  }
 836 #endif /* VMG_UVAR */
 837
 838  return 1;
 839 }
 840
 841 /* ... OP info ............................................................. */
 842
 843 #define VMG_OP_INFO_NAME   1
 844 #define VMG_OP_INFO_OBJECT 2
 845
 846 #if VMG_THREADSAFE
 847 STATIC perl_mutex vmg_op_name_init_mutex;
 848 #endif
 849
 850 STATIC U32           vmg_op_name_init      = 0;
 851 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
 852
 853 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
 854 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
 855  switch (opinfo) {
 856   case VMG_OP_INFO_NAME:
 857 #if VMG_THREADSAFE
 858    MUTEX_LOCK(&vmg_op_name_init_mutex);
 859 #endif
 860    if (!vmg_op_name_init) {
 861     OPCODE t;
 862     for (t = 0; t < OP_max; ++t)
 863      vmg_op_name_len[t] = strlen(PL_op_name[t]);
 864     vmg_op_name_init = 1;
 865    }
 866 #if VMG_THREADSAFE
 867    MUTEX_UNLOCK(&vmg_op_name_init_mutex);
 868 #endif
 869    break;
 870   case VMG_OP_INFO_OBJECT: {
 871    dMY_CXT;
 872    if (!MY_CXT.b__op_stashes[0]) {
 873     opclass c;
 874     require_pv("B.pm");
 875     for (c = 0; c < OPc_MAX; ++c)
 876      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
 877    }
 878    break;
 879   }
 880   default:
 881    break;
 882  }
 883 }
 884
 885 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
 886 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
 887  if (!PL_op)
 888   return &PL_sv_undef;
 889
 890  switch (opinfo) {
 891   case VMG_OP_INFO_NAME: {
 892    OPCODE t = PL_op->op_type;
 893    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
 894   }
 895   case VMG_OP_INFO_OBJECT: {
 896    dMY_CXT;
 897    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
 898                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
 899   }
 900   default:
 901    break;
 902  }
 903
 904  return &PL_sv_undef;
 905 }
 906
 907 /* ... svt callbacks ....................................................... */
 908
 909 #define VMG_CB_CALL_SET_RET(D) \
 910  {            \
 911   SV *svr;    \
 912   SPAGAIN;    \
 913   svr = POPs; \
 914   ret = SvOK(svr) ? SvIV(svr) : (D); \
 915   PUTBACK;    \
 916  }
 917
 918 #define VMG_CB_CALL_ARGS_MASK  15
 919 #define VMG_CB_CALL_ARGS_SHIFT 4
 920 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
 921
 922 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
 923  va_list ap;
 924  int ret;
 925  unsigned int i, args, opinfo;
 926
 927  dSP;
 928
 929  args    = flags & VMG_CB_CALL_ARGS_MASK;
 930  flags >>= VMG_CB_CALL_ARGS_SHIFT;
 931  opinfo  = flags & VMG_CB_CALL_OPINFO;
 932
 933  ENTER;
 934  SAVETMPS;
 935
 936  PUSHMARK(SP);
 937  EXTEND(SP, args + 1);
 938  PUSHs(sv_2mortal(newRV_inc(sv)));
 939  va_start(ap, sv);
 940  for (i = 0; i < args; ++i) {
 941   SV *sva = va_arg(ap, SV *);
 942   PUSHs(sva ? sva : &PL_sv_undef);
 943  }
 944  va_end(ap);
 945  if (opinfo)
 946   XPUSHs(vmg_op_info(opinfo));
 947  PUTBACK;
 948
 949  call_sv(cb, G_SCALAR);
 950
 951  VMG_CB_CALL_SET_RET(0);
 952
 953  FREETMPS;
 954  LEAVE;
 955
 956  return ret;
 957 }
 958
 959 #define vmg_cb_call1(I, F, S, A1) \
 960         vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 1), (S), (A1))
 961 #define vmg_cb_call2(I, F, S, A1, A2) \
 962         vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 2), (S), (A1), (A2))
 963 #define vmg_cb_call3(I, F, S, A1, A2, A3) \
 964         vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 3), (S), (A1), (A2), (A3))
 965
 966 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
 967  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
 968  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
 969 }
 970
 971 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
 972  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
 973  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
 974 }
 975
 976 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
 977  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
 978  unsigned int opinfo = w->opinfo;
 979  U32 len, ret;
 980  svtype t = SvTYPE(sv);
 981
 982  dSP;
 983
 984  ENTER;
 985  SAVETMPS;
 986
 987  PUSHMARK(SP);
 988  EXTEND(SP, 3);
 989  PUSHs(sv_2mortal(newRV_inc(sv)));
 990  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
 991  if (t < SVt_PVAV) {
 992   STRLEN l;
 993   U8 *s = (U8 *) SvPV_const(sv, l);
 994   if (DO_UTF8(sv))
 995    len = utf8_length(s, s + l);
 996   else
 997    len = l;
 998   mPUSHu(len);
 999  } else if (t == SVt_PVAV) {
1000   len = av_len((AV *) sv) + 1;
1001   mPUSHu(len);
1002  } else {
1003   len = 0;
1004   PUSHs(&PL_sv_undef);
1005  }
1006  if (opinfo)
1007   XPUSHs(vmg_op_info(opinfo));
1008  PUTBACK;
1009
1010  call_sv(w->cb_len, G_SCALAR);
1011
1012  VMG_CB_CALL_SET_RET(len);
1013
1014  FREETMPS;
1015  LEAVE;
1016
1017  return t == SVt_PVAV ? ret - 1 : ret;
1018 }
1019
1020 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1021  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1022  return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
1023 }
1024
1025 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1026  const MGWIZ *w;
1027 #if VMG_HAS_PERL(5, 9, 5)
1028  PERL_CONTEXT saved_cx;
1029  I32 cxix;
1030 #endif
1031  unsigned int had_err, has_err, flags = G_SCALAR | G_EVAL;
1032  int ret = 0;
1033
1034  dSP;
1035
1036  /* Don't even bother if we are in global destruction - the wizard is prisoner
1037   * of circular references and we are way beyond user realm */
1038  if (PL_dirty)
1039   return 0;
1040
1041  w = vmg_wizard_mgwiz(mg->mg_ptr);
1042
1043  /* So that it survives the temp cleanup below */
1044  SvREFCNT_inc(sv);
1045
1046 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
1047  /* The previous magic tokens were freed but the magic chain wasn't updated, so
1048   * if you access the sv from the callback the old deleted magics will trigger
1049   * and cause memory misreads. Change 32686 solved it that way : */
1050  SvMAGIC_set(sv, mg);
1051 #endif
1052
1053  ENTER;
1054  SAVETMPS;
1055
1056  PUSHMARK(SP);
1057  EXTEND(SP, 2);
1058  PUSHs(sv_2mortal(newRV_inc(sv)));
1059  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1060  if (w->opinfo)
1061   XPUSHs(vmg_op_info(w->opinfo));
1062  PUTBACK;
1063
1064  had_err = SvTRUE(ERRSV);
1065  if (had_err)
1066   flags |= G_KEEPERR;
1067
1068 #if VMG_HAS_PERL(5, 9, 5)
1069  /* This context should not be used anymore, but since we croak in places the
1070   * core doesn't even dare to, some pointers to it may remain in the upper call
1071   * stack. Make sure call_sv() doesn't clobber it. */
1072  if (cxstack_ix < cxstack_max)
1073   cxix = cxstack_ix + 1;
1074  else
1075   cxix = Perl_cxinc(aTHX);
1076  saved_cx = cxstack[cxix];
1077 #endif
1078
1079  call_sv(w->cb_free, flags);
1080
1081 #if VMG_HAS_PERL(5, 9, 5)
1082  cxstack[cxix] = saved_cx;
1083 #endif
1084
1085  has_err = SvTRUE(ERRSV);
1086  if (IN_PERL_COMPILETIME && !had_err && has_err)
1087   ++PL_error_count;
1088
1089  VMG_CB_CALL_SET_RET(0);
1090
1091  FREETMPS;
1092  LEAVE;
1093
1094  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1095   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1096  --SvREFCNT(sv);
1097
1098  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1099   * mg->mg_ptr reference count */
1100  return ret;
1101 }
1102
1103 #if MGf_COPY
1104 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
1105 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
1106   I32 keylen
1107 # else
1108   int keylen
1109 # endif
1110  ) {
1111  SV *keysv;
1112  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1113  int ret;
1114
1115  if (keylen == HEf_SVKEY) {
1116   keysv = (SV *) key;
1117  } else {
1118   keysv = newSVpvn(key, keylen);
1119  }
1120
1121  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1122
1123  if (keylen != HEf_SVKEY) {
1124   SvREFCNT_dec(keysv);
1125  }
1126
1127  return ret;
1128 }
1129 #endif /* MGf_COPY */
1130
1131 #if 0 /*  MGf_DUP */
1132 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1133  return 0;
1134 }
1135 #endif /* MGf_DUP */
1136
1137 #if MGf_LOCAL
1138 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1139  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1140  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1141 }
1142 #endif /* MGf_LOCAL */
1143
1144 #if VMG_UVAR
1145 STATIC OP *vmg_pp_resetuvar(pTHX) {
1146  SvRMAGICAL_on(cSVOP_sv);
1147  return NORMAL;
1148 }
1149
1150 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1151  struct ufuncs *uf;
1152  MAGIC *mg, *umg;
1153  SV *key = NULL, *newkey = NULL;
1154  int tied = 0;
1155
1156  umg = mg_find(sv, PERL_MAGIC_uvar);
1157  /* umg can't be NULL or we wouldn't be there. */
1158  key = umg->mg_obj;
1159  uf  = (struct ufuncs *) umg->mg_ptr;
1160
1161  if (uf[1].uf_val)
1162   uf[1].uf_val(aTHX_ action, sv);
1163  if (uf[1].uf_set)
1164   uf[1].uf_set(aTHX_ action, sv);
1165
1166  action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
1167  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
1168   const MGWIZ *w;
1169   switch (mg->mg_type) {
1170    case PERL_MAGIC_ext:
1171     break;
1172    case PERL_MAGIC_tied:
1173     ++tied;
1174     continue;
1175    default:
1176     continue;
1177   }
1178   if (mg->mg_private != SIG_WIZ) continue;
1179   w = vmg_wizard_mgwiz(mg->mg_ptr);
1180   switch (w->uvar) {
1181    case 0:
1182     continue;
1183    case 2:
1184     if (!newkey)
1185      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1186   }
1187   switch (action) {
1188    case 0:
1189     if (w->cb_fetch)
1190      vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
1191     break;
1192    case HV_FETCH_ISSTORE:
1193    case HV_FETCH_LVALUE:
1194    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1195     if (w->cb_store)
1196      vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
1197     break;
1198    case HV_FETCH_ISEXISTS:
1199     if (w->cb_exists)
1200      vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
1201     break;
1202    case HV_DELETE:
1203     if (w->cb_delete)
1204      vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
1205     break;
1206   }
1207  }
1208
1209  if (SvRMAGICAL(sv) && !tied) {
1210   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1211    * mistaken for a tied hash by the rest of hv_common. It will be reset by
1212    * the op_ppaddr of a new fake op injected between the current and the next
1213    * one. */
1214   OP *o = PL_op;
1215   if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
1216    SVOP *svop;
1217    NewOp(1101, svop, 1, SVOP);
1218    svop->op_type   = OP_STUB;
1219    svop->op_ppaddr = vmg_pp_resetuvar;
1220    svop->op_next   = o->op_next;
1221    svop->op_flags  = 0;
1222    svop->op_sv     = sv;
1223    o->op_next      = (OP *) svop;
1224   }
1225   SvRMAGICAL_off(sv);
1226  }
1227
1228  return 0;
1229 }
1230 #endif /* VMG_UVAR */
1231
1232 /* --- Macros for the XS section ------------------------------------------- */
1233
1234 #define VMG_SET_CB(S, N)              \
1235  cb = (S);                            \
1236  w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
1237
1238 #define VMG_SET_SVT_CB(S, N)          \
1239  cb = (S);                            \
1240  if (SvOK(cb) && SvROK(cb)) {         \
1241   t->svt_ ## N = vmg_svt_ ## N;       \
1242   w->cb_  ## N = newRV_inc(SvRV(cb)); \
1243  } else {                             \
1244   t->svt_ ## N = NULL;                \
1245   w->cb_  ## N = NULL;                \
1246  }
1247
1248 /* --- XS ------------------------------------------------------------------ */
1249
1250 MODULE = Variable::Magic            PACKAGE = Variable::Magic
1251
1252 PROTOTYPES: ENABLE
1253
1254 BOOT:
1255 {
1256  HV *stash;
1257
1258  MY_CXT_INIT;
1259 #if VMG_THREADSAFE
1260  MY_CXT.wizards = ptable_new();
1261  MY_CXT.owner   = aTHX;
1262 #endif
1263  MY_CXT.b__op_stashes[0] = NULL;
1264 #if VMG_THREADSAFE
1265  MUTEX_INIT(&vmg_op_name_init_mutex);
1266 #endif
1267
1268  stash = gv_stashpv(__PACKAGE__, 1);
1269  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1270  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1271  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1272  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1273  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1274                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1275  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1276                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1277  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1278                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1279  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1280                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1281  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1282                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1283  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1284  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1285  newCONSTSUB(stash, "VMG_FORKSAFE",        newSVuv(VMG_FORKSAFE));
1286  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1287  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1288 }
1289
1290 #if VMG_THREADSAFE
1291
1292 void
1293 CLONE(...)
1294 PROTOTYPE: DISABLE
1295 PREINIT:
1296  ptable *t;
1297  int    *level;
1298  U32     had_b__op_stash = 0;
1299  opclass c;
1300 CODE:
1301  {
1302   my_cxt_t ud;
1303   dMY_CXT;
1304
1305   ud.wizards = t = ptable_new();
1306   ud.owner   = MY_CXT.owner;
1307   ptable_walk(MY_CXT.wizards, vmg_ptable_clone, &ud);
1308
1309   for (c = 0; c < OPc_MAX; ++c) {
1310    if (MY_CXT.b__op_stashes[c])
1311     had_b__op_stash |= (((U32) 1) << c);
1312   }
1313  }
1314  {
1315   MY_CXT_CLONE;
1316   MY_CXT.wizards = t;
1317   MY_CXT.owner   = aTHX;
1318   for (c = 0; c < OPc_MAX; ++c) {
1319    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1320                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1321   }
1322  }
1323
1324 #endif /* VMG_THREADSAFE */
1325
1326 SV *_wizard(...)
1327 PROTOTYPE: DISABLE
1328 PREINIT:
1329  I32 i = 0;
1330  char buf[8];
1331  MGWIZ *w;
1332  MGVTBL *t;
1333  MAGIC *mg;
1334  SV *wiz;
1335  SV *cb;
1336 CODE:
1337  dMY_CXT;
1338
1339  if (items != 7
1340 #if MGf_COPY
1341               + 1
1342 #endif /* MGf_COPY */
1343 #if MGf_DUP
1344               + 1
1345 #endif /* MGf_DUP */
1346 #if MGf_LOCAL
1347               + 1
1348 #endif /* MGf_LOCAL */
1349 #if VMG_UVAR
1350               + 5
1351 #endif /* VMG_UVAR */
1352               ) { croak(vmg_wrongargnum); }
1353
1354  Newx(t, 1, MGVTBL);
1355  Newx(w, 1, MGWIZ);
1356
1357  VMG_SET_CB(ST(i++), data);
1358  cb = ST(i++);
1359  w->opinfo = SvOK(cb) ? SvUV(cb) : 0;
1360  if (w->opinfo)
1361   vmg_op_info_init(w->opinfo);
1362  VMG_SET_SVT_CB(ST(i++), get);
1363  VMG_SET_SVT_CB(ST(i++), set);
1364  VMG_SET_SVT_CB(ST(i++), len);
1365  VMG_SET_SVT_CB(ST(i++), clear);
1366  VMG_SET_SVT_CB(ST(i++), free);
1367 #if MGf_COPY
1368  VMG_SET_SVT_CB(ST(i++), copy);
1369 #endif /* MGf_COPY */
1370 #if MGf_DUP
1371  /* VMG_SET_SVT_CB(ST(i++), dup); */
1372  i++;
1373  t->svt_dup = NULL;
1374  w->cb_dup  = NULL;
1375 #endif /* MGf_DUP */
1376 #if MGf_LOCAL
1377  VMG_SET_SVT_CB(ST(i++), local);
1378 #endif /* MGf_LOCAL */
1379 #if VMG_UVAR
1380  VMG_SET_CB(ST(i++), fetch);
1381  VMG_SET_CB(ST(i++), store);
1382  VMG_SET_CB(ST(i++), exists);
1383  VMG_SET_CB(ST(i++), delete);
1384  cb = ST(i++);
1385  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1386   w->uvar = SvTRUE(cb) ? 2 : 1;
1387  else
1388   w->uvar = 0;
1389 #endif /* VMG_UVAR */
1390 #if VMG_MULTIPLICITY
1391  w->owner = aTHX;
1392 #endif /* VMG_MULTIPLICITY */
1393  w->vtbl  = t;
1394 #if VMG_THREADSAFE
1395  ptable_store(MY_CXT.wizards, w, w);
1396 #endif /* VMG_THREADSAFE */
1397
1398  RETVAL = newRV_noinc(vmg_wizard_new(w));
1399 OUTPUT:
1400  RETVAL
1401
1402 SV *cast(SV *sv, SV *wiz, ...)
1403 PROTOTYPE: \[$@%&*]$@
1404 PREINIT:
1405  AV *args = NULL;
1406  SV *ret;
1407 CODE:
1408  wiz = vmg_wizard_validate(wiz);
1409  if (items > 2) {
1410   I32 i;
1411   args = newAV();
1412   av_fill(args, items - 2);
1413   for (i = 2; i < items; ++i) {
1414    SV *arg = ST(i);
1415    SvREFCNT_inc(arg);
1416    if (av_store(args, i - 2, arg) == NULL) croak(vmg_argstorefailed);
1417   }
1418  }
1419  ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1420  SvREFCNT_dec(args);
1421  RETVAL = ret;
1422 OUTPUT:
1423  RETVAL
1424
1425 void
1426 getdata(SV *sv, SV *wiz)
1427 PROTOTYPE: \[$@%&*]$
1428 PREINIT:
1429  SV *data;
1430 PPCODE:
1431  wiz  = vmg_wizard_validate(wiz);
1432  data = vmg_data_get(SvRV(sv), wiz);
1433  if (!data)
1434   XSRETURN_EMPTY;
1435  ST(0) = data;
1436  XSRETURN(1);
1437
1438 SV *dispell(SV *sv, SV *wiz)
1439 PROTOTYPE: \[$@%&*]$
1440 PREINIT:
1441  U16 sig;
1442 CODE:
1443  wiz = vmg_wizard_validate(wiz);
1444  RETVAL = newSVuv(vmg_dispell(SvRV(sv), wiz));
1445 OUTPUT:
1446  RETVAL