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