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