Magic.xs

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