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