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