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