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