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(w->cb_data);
 367  if (w->cb_get)    SvREFCNT_dec(w->cb_get);
 368  if (w->cb_set)    SvREFCNT_dec(w->cb_set);
 369  if (w->cb_len)    SvREFCNT_dec(w->cb_len);
 370  if (w->cb_clear)  SvREFCNT_dec(w->cb_clear);
 371  if (w->cb_free)   SvREFCNT_dec(w->cb_free);
 372 #if MGf_COPY
 373  if (w->cb_copy)   SvREFCNT_dec(w->cb_copy);
 374 #endif /* MGf_COPY */
 375 #if 0 /* MGf_DUP */
 376  if (w->cb_dup)    SvREFCNT_dec(w->cb_dup);
 377 #endif /* MGf_DUP */
 378 #if MGf_LOCAL
 379  if (w->cb_local)  SvREFCNT_dec(w->cb_local);
 380 #endif /* MGf_LOCAL */
 381 #if VMG_UVAR
 382  if (w->cb_fetch)  SvREFCNT_dec(w->cb_fetch);
 383  if (w->cb_store)  SvREFCNT_dec(w->cb_store);
 384  if (w->cb_exists) SvREFCNT_dec(w->cb_exists);
 385  if (w->cb_delete) SvREFCNT_dec(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) ? vmg_clone(w->cb_ ## N, w->owner) \
 398                              : NULL;
 399
 400 STATIC MGWIZ *vmg_mgwiz_clone(pTHX_ const MGWIZ *w) {
 401 #define vmg_mgwiz_clone(W) vmg_mgwiz_clone(aTHX_ (W))
 402  MGVTBL *t;
 403  MGWIZ *z;
 404
 405  if (!w)
 406   return NULL;
 407
 408  Newx(t, 1, MGVTBL);
 409  Copy(w->vtbl, t, 1, MGVTBL);
 410
 411  Newx(z, 1, MGWIZ);
 412
 413  z->vtbl   = t;
 414  z->uvar   = w->uvar;
 415  z->opinfo = w->opinfo;
 416
 417  VMG_CLONE_CB(data);
 418  VMG_CLONE_CB(get);
 419  VMG_CLONE_CB(set);
 420  VMG_CLONE_CB(len);
 421  VMG_CLONE_CB(clear);
 422  VMG_CLONE_CB(free);
 423 #if MGf_COPY
 424  VMG_CLONE_CB(copy);
 425 #endif /* MGf_COPY */
 426 #if MGf_DUP
 427  VMG_CLONE_CB(dup);
 428 #endif /* MGf_DUP */
 429 #if MGf_LOCAL
 430  VMG_CLONE_CB(local);
 431 #endif /* MGf_LOCAL */
 432 #if VMG_UVAR
 433  VMG_CLONE_CB(fetch);
 434  VMG_CLONE_CB(store);
 435  VMG_CLONE_CB(exists);
 436  VMG_CLONE_CB(delete);
 437 #endif /* VMG_UVAR */
 438
 439  z->owner = aTHX;
 440
 441  return z;
 442 }
 443
 444 #endif /* VMG_THREADSAFE */
 445
 446 /* --- Context-safe global data -------------------------------------------- */
 447
 448 #if VMG_THREADSAFE
 449
 450 #define PTABLE_NAME        ptable
 451 #define PTABLE_VAL_FREE(V) vmg_mgwiz_free(V)
 452
 453 #define pPTBL  pTHX
 454 #define pPTBL_ pTHX_
 455 #define aPTBL  aTHX
 456 #define aPTBL_ aTHX_
 457
 458 #include "ptable.h"
 459
 460 #define ptable_store(T, K, V) ptable_store(aTHX_ (T), (K), (V))
 461 #define ptable_clear(T)       ptable_clear(aTHX_ (T))
 462 #define ptable_free(T)        ptable_free(aTHX_ (T))
 463
 464 #endif /* VMG_THREADSAFE */
 465
 466 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 467
 468 typedef struct {
 469 #if VMG_THREADSAFE
 470  ptable *wizards;
 471  tTHX    owner;
 472 #endif
 473  HV     *b__op_stashes[OPc_MAX];
 474 } my_cxt_t;
 475
 476 START_MY_CXT
 477
 478 #if VMG_THREADSAFE
 479
 480 STATIC void vmg_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
 481  my_cxt_t *ud = ud_;
 482  MGWIZ *w;
 483
 484  if (ud->owner == aTHX)
 485   return;
 486
 487  w = vmg_mgwiz_clone(ent->val);
 488  if (w)
 489   ptable_store(ud->wizards, ent->key, w);
 490 }
 491
 492 #endif /* VMG_THREADSAFE */
 493
 494 /* --- Wizard objects ------------------------------------------------------ */
 495
 496 STATIC int vmg_wizard_free(pTHX_ SV *sv, MAGIC *mg);
 497
 498 STATIC MGVTBL vmg_wizard_vtbl = {
 499  NULL,            /* get */
 500  NULL,            /* set */
 501  NULL,            /* len */
 502  NULL,            /* clear */
 503  vmg_wizard_free, /* free */
 504 #if MGf_COPY
 505  NULL,            /* copy */
 506 #endif /* MGf_COPY */
 507 #if MGf_DUP
 508  NULL,            /* dup */
 509 #endif /* MGf_DUP */
 510 #if MGf_LOCAL
 511  NULL,            /* local */
 512 #endif /* MGf_LOCAL */
 513 };
 514
 515 /* ... Wizard constructor .................................................. */
 516
 517 STATIC SV *vmg_wizard_new(pTHX_ const MGWIZ *w) {
 518 #define vmg_wizard_new(W) vmg_wizard_new(aTHX_ (W))
 519  SV *wiz = newSVuv(PTR2IV(w));
 520
 521  if (w) {
 522   MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
 523   mg->mg_private = SIG_WZO;
 524  }
 525  SvREADONLY_on(wiz);
 526
 527  return wiz;
 528 }
 529
 530 STATIC const SV *vmg_wizard_validate(pTHX_ const SV *wiz) {
 531 #define vmg_wizard_validate(W) vmg_wizard_validate(aTHX_ (W))
 532  if (SvROK(wiz)) {
 533   wiz = SvRV(wiz);
 534   if (SvIOK(wiz))
 535    return wiz;
 536  }
 537
 538  croak(vmg_invalid_wiz);
 539  /* Not reached */
 540  return NULL;
 541 }
 542
 543 #define vmg_wizard_id(W)         SvIVX((const SV *) (W))
 544 #define vmg_wizard_main_mgwiz(W) INT2PTR(const MGWIZ *, vmg_wizard_id(W))
 545
 546 /* ... Wizard destructor ................................................... */
 547
 548 STATIC int vmg_wizard_free(pTHX_ SV *sv, MAGIC *mg) {
 549  MGWIZ *w;
 550
 551  if (PL_dirty) /* During global destruction, the context is already freed */
 552   return 0;
 553
 554  w = (MGWIZ *) vmg_wizard_main_mgwiz(sv);
 555
 556 #if VMG_THREADSAFE
 557  {
 558   dMY_CXT;
 559   ptable_store(MY_CXT.wizards, w, NULL);
 560  }
 561 #else /* VMG_THREADSAFE */
 562  vmg_mgwiz_free(w);
 563 #endif /* !VMG_THREADSAFE */
 564
 565  return 0;
 566 }
 567
 568 #if VMG_THREADSAFE
 569
 570 STATIC const MGWIZ *vmg_wizard_mgwiz(pTHX_ const SV *wiz) {
 571 #define vmg_wizard_mgwiz(W) vmg_wizard_mgwiz(aTHX_ ((const SV *) (W)))
 572  const MGWIZ *w;
 573
 574  w = vmg_wizard_main_mgwiz(wiz);
 575  if (w->owner == aTHX)
 576   return w;
 577
 578  {
 579   dMY_CXT;
 580   return ptable_fetch(MY_CXT.wizards, w);
 581  }
 582 }
 583
 584 #else /* VMG_THREADSAFE */
 585
 586 #define vmg_wizard_mgwiz(W) vmg_wizard_main_mgwiz(W)
 587
 588 #endif /* !VMG_THREADSAFE */
 589
 590 /* --- User-level functions implementation --------------------------------- */
 591
 592 STATIC const MAGIC *vmg_find(const SV *sv, const SV *wiz) {
 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, SV **args, I32 items) {
 615 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
 616  I32 i;
 617  SV *nsv;
 618
 619  dSP;
 620
 621  ENTER;
 622  SAVETMPS;
 623
 624  PUSHMARK(SP);
 625  EXTEND(SP, items + 1);
 626  PUSHs(sv_2mortal(newRV_inc(sv)));
 627  for (i = 0; i < items; ++i)
 628   PUSHs(args[i]);
 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, const 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, const SV *wiz, SV **args, I32 items) {
 672 #define vmg_cast(S, W, A, I) vmg_cast(aTHX_ (S), (W), (A), (I))
 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, items) : NULL;
 685  mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
 686  SvREFCNT_dec(data);
 687  mg->mg_private = SIG_WIZ;
 688 #if MGf_COPY
 689  if (w->cb_copy)
 690   mg->mg_flags |= MGf_COPY;
 691 #endif /* MGf_COPY */
 692 #if 0 /* MGf_DUP */
 693  if (w->cb_dup)
 694   mg->mg_flags |= MGf_DUP;
 695 #endif /* MGf_DUP */
 696 #if MGf_LOCAL
 697  if (w->cb_local)
 698   mg->mg_flags |= MGf_LOCAL;
 699 #endif /* MGf_LOCAL */
 700
 701  if (SvTYPE(sv) < SVt_PVHV)
 702   goto done;
 703
 704  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 705   * magic is actually never called for them. If the GMAGICAL flag was off before
 706   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 707   * now on, then this wizard has get magic. Hence we can work around the
 708   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 709   * has uvar callbacks, it will be turned back on later. */
 710  if (!oldgmg && SvGMAGICAL(sv))
 711   SvGMAGICAL_off(sv);
 712
 713 #if VMG_UVAR
 714  if (w->uvar) {
 715   MAGIC *prevmagic;
 716   struct ufuncs uf[2];
 717
 718   uf[0].uf_val   = vmg_svt_val;
 719   uf[0].uf_set   = NULL;
 720   uf[0].uf_index = 0;
 721   uf[1].uf_val   = NULL;
 722   uf[1].uf_set   = NULL;
 723   uf[1].uf_index = 0;
 724
 725   /* One uvar magic in the chain is enough. */
 726   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 727    moremagic = mg->mg_moremagic;
 728    if (mg->mg_type == PERL_MAGIC_uvar)
 729     break;
 730   }
 731
 732   if (mg) { /* Found another uvar magic. */
 733    struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
 734    if (olduf->uf_val == vmg_svt_val) {
 735     /* It's our uvar magic, nothing to do. oldgmg was true. */
 736     goto done;
 737    } else {
 738     /* It's another uvar magic, backup it and replace it by ours. */
 739     uf[1] = *olduf;
 740     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 741    }
 742   }
 743
 744   vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
 745   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
 746    * handled by our uvar callback. */
 747  }
 748 #endif /* VMG_UVAR */
 749
 750 done:
 751  return 1;
 752 }
 753
 754 STATIC UV vmg_dispell(pTHX_ SV *sv, const SV *wiz) {
 755 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
 756 #if VMG_UVAR
 757  U32 uvars = 0;
 758 #endif /* VMG_UVAR */
 759  MAGIC *mg, *prevmagic, *moremagic = NULL;
 760  UV wid = vmg_wizard_id(wiz);
 761
 762  if (SvTYPE(sv) < SVt_PVMG)
 763   return 0;
 764
 765  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 766   moremagic = mg->mg_moremagic;
 767   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
 768    const MGWIZ *z   = vmg_wizard_mgwiz(mg->mg_ptr);
 769    UV           zid = vmg_wizard_id(mg->mg_ptr);
 770    if (zid == wid) {
 771 #if VMG_UVAR
 772     /* If the current has no uvar, short-circuit uvar deletion. */
 773     uvars = z->uvar ? (uvars + 1) : 0;
 774 #endif /* VMG_UVAR */
 775     break;
 776 #if VMG_UVAR
 777    } else if (z->uvar) {
 778     ++uvars;
 779     /* We can't break here since we need to find the ext magic to delete. */
 780 #endif /* VMG_UVAR */
 781    }
 782   }
 783  }
 784  if (!mg)
 785   return 0;
 786
 787  if (prevmagic) {
 788   prevmagic->mg_moremagic = moremagic;
 789  } else {
 790   SvMAGIC_set(sv, moremagic);
 791  }
 792  mg->mg_moremagic = NULL;
 793
 794  /* Destroy private data */
 795  if (mg->mg_obj != sv)
 796   SvREFCNT_dec(mg->mg_obj);
 797  /* Unreference the wizard */
 798  SvREFCNT_dec((SV *) mg->mg_ptr);
 799  Safefree(mg);
 800
 801 #if VMG_UVAR
 802  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
 803   /* mg was the first ext magic in the chain that had uvar */
 804
 805   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
 806    if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
 807     const MGWIZ *z = vmg_wizard_mgwiz(mg->mg_ptr);
 808     if (z->uvar) {
 809      ++uvars;
 810      break;
 811     }
 812    }
 813   }
 814
 815   if (uvars == 1) {
 816    struct ufuncs *uf;
 817    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
 818     moremagic = mg->mg_moremagic;
 819     if (mg->mg_type == PERL_MAGIC_uvar)
 820      break;
 821    }
 822    /* assert(mg); */
 823    uf = (struct ufuncs *) mg->mg_ptr;
 824    /* assert(uf->uf_val == vmg_svt_val); */
 825    if (uf[1].uf_val || uf[1].uf_set) {
 826     /* Revert the original uvar magic. */
 827     uf[0] = uf[1];
 828     Renew(uf, 1, struct ufuncs);
 829     mg->mg_ptr = (char *) uf;
 830     mg->mg_len = sizeof(struct ufuncs);
 831    } else {
 832     /* Remove the uvar magic. */
 833     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 834    }
 835   }
 836  }
 837 #endif /* VMG_UVAR */
 838
 839  return 1;
 840 }
 841
 842 /* ... OP info ............................................................. */
 843
 844 #define VMG_OP_INFO_NAME   1
 845 #define VMG_OP_INFO_OBJECT 2
 846
 847 #if VMG_THREADSAFE
 848 STATIC perl_mutex vmg_op_name_init_mutex;
 849 #endif
 850
 851 STATIC U32           vmg_op_name_init      = 0;
 852 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
 853
 854 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
 855 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
 856  switch (opinfo) {
 857   case VMG_OP_INFO_NAME:
 858 #if VMG_THREADSAFE
 859    MUTEX_LOCK(&vmg_op_name_init_mutex);
 860 #endif
 861    if (!vmg_op_name_init) {
 862     OPCODE t;
 863     for (t = 0; t < OP_max; ++t)
 864      vmg_op_name_len[t] = strlen(PL_op_name[t]);
 865     vmg_op_name_init = 1;
 866    }
 867 #if VMG_THREADSAFE
 868    MUTEX_UNLOCK(&vmg_op_name_init_mutex);
 869 #endif
 870    break;
 871   case VMG_OP_INFO_OBJECT: {
 872    dMY_CXT;
 873    if (!MY_CXT.b__op_stashes[0]) {
 874     opclass c;
 875     require_pv("B.pm");
 876     for (c = OPc_NULL; c < OPc_MAX; ++c)
 877      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
 878    }
 879    break;
 880   }
 881   default:
 882    break;
 883  }
 884 }
 885
 886 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
 887 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
 888  if (!PL_op)
 889   return &PL_sv_undef;
 890
 891  switch (opinfo) {
 892   case VMG_OP_INFO_NAME: {
 893    OPCODE t = PL_op->op_type;
 894    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
 895   }
 896   case VMG_OP_INFO_OBJECT: {
 897    dMY_CXT;
 898    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
 899                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
 900   }
 901   default:
 902    break;
 903  }
 904
 905  return &PL_sv_undef;
 906 }
 907
 908 /* ... svt callbacks ....................................................... */
 909
 910 #define VMG_CB_CALL_SET_RET(D) \
 911  {            \
 912   SV *svr;    \
 913   SPAGAIN;    \
 914   svr = POPs; \
 915   ret = SvOK(svr) ? SvIV(svr) : (D); \
 916   PUTBACK;    \
 917  }
 918
 919 #define VMG_CB_CALL_ARGS_MASK  15
 920 #define VMG_CB_CALL_ARGS_SHIFT 4
 921 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
 922
 923 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
 924  va_list ap;
 925  int ret;
 926  unsigned int i, args, opinfo;
 927
 928  dSP;
 929
 930  args    = flags & VMG_CB_CALL_ARGS_MASK;
 931  flags >>= VMG_CB_CALL_ARGS_SHIFT;
 932  opinfo  = flags & VMG_CB_CALL_OPINFO;
 933
 934  ENTER;
 935  SAVETMPS;
 936
 937  PUSHMARK(SP);
 938  EXTEND(SP, args + 1);
 939  PUSHs(sv_2mortal(newRV_inc(sv)));
 940  va_start(ap, sv);
 941  for (i = 0; i < args; ++i) {
 942   SV *sva = va_arg(ap, SV *);
 943   PUSHs(sva ? sva : &PL_sv_undef);
 944  }
 945  va_end(ap);
 946  if (opinfo)
 947   XPUSHs(vmg_op_info(opinfo));
 948  PUTBACK;
 949
 950  call_sv(cb, G_SCALAR);
 951
 952  VMG_CB_CALL_SET_RET(0);
 953
 954  FREETMPS;
 955  LEAVE;
 956
 957  return ret;
 958 }
 959
 960 #define vmg_cb_call1(I, F, S, A1) \
 961         vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 1), (S), (A1))
 962 #define vmg_cb_call2(I, F, S, A1, A2) \
 963         vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 2), (S), (A1), (A2))
 964 #define vmg_cb_call3(I, F, S, A1, A2, A3) \
 965         vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 3), (S), (A1), (A2), (A3))
 966
 967 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
 968  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
 969  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
 970 }
 971
 972 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
 973  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
 974  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
 975 }
 976
 977 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
 978  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
 979  unsigned int opinfo = w->opinfo;
 980  U32 len, ret;
 981  svtype t = SvTYPE(sv);
 982
 983  dSP;
 984
 985  ENTER;
 986  SAVETMPS;
 987
 988  PUSHMARK(SP);
 989  EXTEND(SP, 3);
 990  PUSHs(sv_2mortal(newRV_inc(sv)));
 991  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
 992  if (t < SVt_PVAV) {
 993   STRLEN l;
 994   const U8 *s = (const U8 *) SvPV_const(sv, l);
 995   if (DO_UTF8(sv))
 996    len = utf8_length(s, s + l);
 997   else
 998    len = l;
 999   mPUSHu(len);
1000  } else if (t == SVt_PVAV) {
1001   len = av_len((AV *) sv) + 1;
1002   mPUSHu(len);
1003  } else {
1004   len = 0;
1005   PUSHs(&PL_sv_undef);
1006  }
1007  if (opinfo)
1008   XPUSHs(vmg_op_info(opinfo));
1009  PUTBACK;
1010
1011  call_sv(w->cb_len, G_SCALAR);
1012
1013  VMG_CB_CALL_SET_RET(len);
1014
1015  FREETMPS;
1016  LEAVE;
1017
1018  return t == SVt_PVAV ? ret - 1 : ret;
1019 }
1020
1021 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1022  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1023  return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
1024 }
1025
1026 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1027  const MGWIZ *w;
1028 #if VMG_HAS_PERL(5, 9, 5)
1029  PERL_CONTEXT saved_cx;
1030  I32 cxix;
1031 #endif
1032  unsigned int had_err, has_err, flags = G_SCALAR | G_EVAL;
1033  int ret = 0;
1034
1035  dSP;
1036
1037  /* Don't even bother if we are in global destruction - the wizard is prisoner
1038   * of circular references and we are way beyond user realm */
1039  if (PL_dirty)
1040   return 0;
1041
1042  w = vmg_wizard_mgwiz(mg->mg_ptr);
1043
1044  /* So that it survives the temp cleanup below */
1045  SvREFCNT_inc(sv);
1046
1047 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
1048  /* The previous magic tokens were freed but the magic chain wasn't updated, so
1049   * if you access the sv from the callback the old deleted magics will trigger
1050   * and cause memory misreads. Change 32686 solved it that way : */
1051  SvMAGIC_set(sv, mg);
1052 #endif
1053
1054  ENTER;
1055  SAVETMPS;
1056
1057  PUSHMARK(SP);
1058  EXTEND(SP, 2);
1059  PUSHs(sv_2mortal(newRV_inc(sv)));
1060  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1061  if (w->opinfo)
1062   XPUSHs(vmg_op_info(w->opinfo));
1063  PUTBACK;
1064
1065  had_err = SvTRUE(ERRSV);
1066  if (had_err)
1067   flags |= G_KEEPERR;
1068
1069 #if VMG_HAS_PERL(5, 9, 5)
1070  /* This context should not be used anymore, but since we croak in places the
1071   * core doesn't even dare to, some pointers to it may remain in the upper call
1072   * stack. Make sure call_sv() doesn't clobber it. */
1073  if (cxstack_ix < cxstack_max)
1074   cxix = cxstack_ix + 1;
1075  else
1076   cxix = Perl_cxinc(aTHX);
1077  saved_cx = cxstack[cxix];
1078 #endif
1079
1080  call_sv(w->cb_free, flags);
1081
1082 #if VMG_HAS_PERL(5, 9, 5)
1083  cxstack[cxix] = saved_cx;
1084 #endif
1085
1086  has_err = SvTRUE(ERRSV);
1087  if (IN_PERL_COMPILETIME && !had_err && has_err)
1088   ++PL_error_count;
1089
1090  VMG_CB_CALL_SET_RET(0);
1091
1092  FREETMPS;
1093  LEAVE;
1094
1095  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1096   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1097  --SvREFCNT(sv);
1098
1099  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1100   * mg->mg_ptr reference count */
1101  return ret;
1102 }
1103
1104 #if MGf_COPY
1105 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
1106 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
1107   I32 keylen
1108 # else
1109   int keylen
1110 # endif
1111  ) {
1112  SV *keysv;
1113  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1114  int ret;
1115
1116  if (keylen == HEf_SVKEY) {
1117   keysv = (SV *) key;
1118  } else {
1119   keysv = newSVpvn(key, keylen);
1120  }
1121
1122  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1123
1124  if (keylen != HEf_SVKEY) {
1125   SvREFCNT_dec(keysv);
1126  }
1127
1128  return ret;
1129 }
1130 #endif /* MGf_COPY */
1131
1132 #if 0 /*  MGf_DUP */
1133 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1134  return 0;
1135 }
1136 #endif /* MGf_DUP */
1137
1138 #if MGf_LOCAL
1139 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1140  const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1141  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1142 }
1143 #endif /* MGf_LOCAL */
1144
1145 #if VMG_UVAR
1146 STATIC OP *vmg_pp_resetuvar(pTHX) {
1147  SvRMAGICAL_on(cSVOP_sv);
1148  return NORMAL;
1149 }
1150
1151 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1152  struct ufuncs *uf;
1153  MAGIC *mg, *umg;
1154  SV *key = NULL, *newkey = NULL;
1155  int tied = 0;
1156
1157  umg = mg_find(sv, PERL_MAGIC_uvar);
1158  /* umg can't be NULL or we wouldn't be there. */
1159  key = umg->mg_obj;
1160  uf  = (struct ufuncs *) umg->mg_ptr;
1161
1162  if (uf[1].uf_val)
1163   uf[1].uf_val(aTHX_ action, sv);
1164  if (uf[1].uf_set)
1165   uf[1].uf_set(aTHX_ action, sv);
1166
1167  action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
1168  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
1169   const MGWIZ *w;
1170   switch (mg->mg_type) {
1171    case PERL_MAGIC_ext:
1172     break;
1173    case PERL_MAGIC_tied:
1174     ++tied;
1175     continue;
1176    default:
1177     continue;
1178   }
1179   if (mg->mg_private != SIG_WIZ) continue;
1180   w = vmg_wizard_mgwiz(mg->mg_ptr);
1181   switch (w->uvar) {
1182    case 0:
1183     continue;
1184    case 2:
1185     if (!newkey)
1186      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1187   }
1188   switch (action) {
1189    case 0:
1190     if (w->cb_fetch)
1191      vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
1192     break;
1193    case HV_FETCH_ISSTORE:
1194    case HV_FETCH_LVALUE:
1195    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1196     if (w->cb_store)
1197      vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
1198     break;
1199    case HV_FETCH_ISEXISTS:
1200     if (w->cb_exists)
1201      vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
1202     break;
1203    case HV_DELETE:
1204     if (w->cb_delete)
1205      vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
1206     break;
1207   }
1208  }
1209
1210  if (SvRMAGICAL(sv) && !tied) {
1211   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1212    * mistaken for a tied hash by the rest of hv_common. It will be reset by
1213    * the op_ppaddr of a new fake op injected between the current and the next
1214    * one. */
1215   OP *o = PL_op;
1216   if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
1217    SVOP *svop;
1218    NewOp(1101, svop, 1, SVOP);
1219    svop->op_type   = OP_STUB;
1220    svop->op_ppaddr = vmg_pp_resetuvar;
1221    svop->op_next   = o->op_next;
1222    svop->op_flags  = 0;
1223    svop->op_sv     = sv;
1224    o->op_next      = (OP *) svop;
1225   }
1226   SvRMAGICAL_off(sv);
1227  }
1228
1229  return 0;
1230 }
1231 #endif /* VMG_UVAR */
1232
1233 /* --- Macros for the XS section ------------------------------------------- */
1234
1235 #define VMG_SET_CB(S, N)              \
1236  cb = (S);                            \
1237  w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? SvREFCNT_inc(SvRV(cb)) : NULL;
1238
1239 #define VMG_SET_SVT_CB(S, N)          \
1240  cb = (S);                            \
1241  if (SvOK(cb) && SvROK(cb)) {         \
1242   t->svt_ ## N = vmg_svt_ ## N;       \
1243   w->cb_  ## N = SvREFCNT_inc(SvRV(cb)); \
1244  } else {                             \
1245   t->svt_ ## N = NULL;                \
1246   w->cb_  ## N = NULL;                \
1247  }
1248
1249 #if VMG_THREADSAFE
1250
1251 STATIC void vmg_cleanup(pTHX_ void *ud) {
1252  dMY_CXT;
1253
1254  ptable_free(MY_CXT.wizards);
1255  MY_CXT.wizards = NULL;
1256 }
1257
1258 #endif /* VMG_THREADSAFE */
1259
1260 /* --- XS ------------------------------------------------------------------ */
1261
1262 MODULE = Variable::Magic            PACKAGE = Variable::Magic
1263
1264 PROTOTYPES: ENABLE
1265
1266 BOOT:
1267 {
1268  HV *stash;
1269
1270  MY_CXT_INIT;
1271 #if VMG_THREADSAFE
1272  MY_CXT.wizards = ptable_new();
1273  MY_CXT.owner   = aTHX;
1274 #endif
1275  MY_CXT.b__op_stashes[0] = NULL;
1276 #if VMG_THREADSAFE
1277  MUTEX_INIT(&vmg_op_name_init_mutex);
1278  call_atexit(vmg_cleanup, NULL);
1279 #endif
1280
1281  stash = gv_stashpv(__PACKAGE__, 1);
1282  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1283  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1284  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1285  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1286  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1287                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1288  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1289                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1290  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1291                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1292  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1293                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1294  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1295                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1296  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1297  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1298  newCONSTSUB(stash, "VMG_FORKSAFE",        newSVuv(VMG_FORKSAFE));
1299  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1300  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1301 }
1302
1303 #if VMG_THREADSAFE
1304
1305 void
1306 CLONE(...)
1307 PROTOTYPE: DISABLE
1308 PREINIT:
1309  ptable *t;
1310  U32     had_b__op_stash = 0;
1311  opclass c;
1312 PPCODE:
1313  {
1314   my_cxt_t ud;
1315   dMY_CXT;
1316
1317   ud.wizards = t = ptable_new();
1318   ud.owner   = MY_CXT.owner;
1319   ptable_walk(MY_CXT.wizards, vmg_ptable_clone, &ud);
1320
1321   for (c = OPc_NULL; c < OPc_MAX; ++c) {
1322    if (MY_CXT.b__op_stashes[c])
1323     had_b__op_stash |= (((U32) 1) << c);
1324   }
1325  }
1326  {
1327   MY_CXT_CLONE;
1328   MY_CXT.wizards = t;
1329   MY_CXT.owner   = aTHX;
1330   for (c = OPc_NULL; c < OPc_MAX; ++c) {
1331    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1332                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1333   }
1334  }
1335  XSRETURN(0);
1336
1337 #endif /* VMG_THREADSAFE */
1338
1339 SV *_wizard(...)
1340 PROTOTYPE: DISABLE
1341 PREINIT:
1342  I32 i = 0;
1343  MGWIZ *w;
1344  MGVTBL *t;
1345  SV *cb;
1346 CODE:
1347  dMY_CXT;
1348
1349  if (items != 7
1350 #if MGf_COPY
1351               + 1
1352 #endif /* MGf_COPY */
1353 #if MGf_DUP
1354               + 1
1355 #endif /* MGf_DUP */
1356 #if MGf_LOCAL
1357               + 1
1358 #endif /* MGf_LOCAL */
1359 #if VMG_UVAR
1360               + 5
1361 #endif /* VMG_UVAR */
1362               ) { croak(vmg_wrongargnum); }
1363
1364  Newx(t, 1, MGVTBL);
1365  Newx(w, 1, MGWIZ);
1366
1367  VMG_SET_CB(ST(i++), data);
1368  cb = ST(i++);
1369  w->opinfo = SvOK(cb) ? SvUV(cb) : 0;
1370  if (w->opinfo)
1371   vmg_op_info_init(w->opinfo);
1372  VMG_SET_SVT_CB(ST(i++), get);
1373  VMG_SET_SVT_CB(ST(i++), set);
1374  VMG_SET_SVT_CB(ST(i++), len);
1375  VMG_SET_SVT_CB(ST(i++), clear);
1376  VMG_SET_SVT_CB(ST(i++), free);
1377 #if MGf_COPY
1378  VMG_SET_SVT_CB(ST(i++), copy);
1379 #endif /* MGf_COPY */
1380 #if MGf_DUP
1381  /* VMG_SET_SVT_CB(ST(i++), dup); */
1382  i++;
1383  t->svt_dup = NULL;
1384  w->cb_dup  = NULL;
1385 #endif /* MGf_DUP */
1386 #if MGf_LOCAL
1387  VMG_SET_SVT_CB(ST(i++), local);
1388 #endif /* MGf_LOCAL */
1389 #if VMG_UVAR
1390  VMG_SET_CB(ST(i++), fetch);
1391  VMG_SET_CB(ST(i++), store);
1392  VMG_SET_CB(ST(i++), exists);
1393  VMG_SET_CB(ST(i++), delete);
1394  cb = ST(i++);
1395  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1396   w->uvar = SvTRUE(cb) ? 2 : 1;
1397  else
1398   w->uvar = 0;
1399 #endif /* VMG_UVAR */
1400 #if VMG_MULTIPLICITY
1401  w->owner = aTHX;
1402 #endif /* VMG_MULTIPLICITY */
1403  w->vtbl  = t;
1404 #if VMG_THREADSAFE
1405  ptable_store(MY_CXT.wizards, w, w);
1406 #endif /* VMG_THREADSAFE */
1407
1408  RETVAL = newRV_noinc(vmg_wizard_new(w));
1409 OUTPUT:
1410  RETVAL
1411
1412 SV *cast(SV *sv, SV *wiz, ...)
1413 PROTOTYPE: \[$@%&*]$@
1414 PREINIT:
1415  SV **args = NULL;
1416  I32 i = 0;
1417 CODE:
1418  if (items > 2) {
1419   i = items - 2;
1420   args = &ST(2);
1421  }
1422  RETVAL = newSVuv(vmg_cast(SvRV(sv), vmg_wizard_validate(wiz), args, i));
1423 OUTPUT:
1424  RETVAL
1425
1426 void
1427 getdata(SV *sv, SV *wiz)
1428 PROTOTYPE: \[$@%&*]$
1429 PREINIT:
1430  SV *data;
1431 PPCODE:
1432  data = vmg_data_get(SvRV(sv), vmg_wizard_validate(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 CODE:
1441  RETVAL = newSVuv(vmg_dispell(SvRV(sv), vmg_wizard_validate(wiz)));
1442 OUTPUT:
1443  RETVAL