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