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