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 typedef struct {
 782  struct ufuncs new_uf;
 783  struct ufuncs old_uf;
 784 } vmg_uvar_ud;
 785
 786 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 787  if (prevmagic) {
 788   prevmagic->mg_moremagic = moremagic;
 789  } else {
 790   SvMAGIC_set(sv, moremagic);
 791  }
 792  mg->mg_moremagic = NULL;
 793  Safefree(mg->mg_ptr);
 794  Safefree(mg);
 795 }
 796 #endif /* VMG_UVAR */
 797
 798 STATIC UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
 799 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
 800  MAGIC  *mg;
 801  MGVTBL *t;
 802  SV     *data;
 803  U32     oldgmg;
 804
 805  if (vmg_find(sv, w))
 806   return 1;
 807
 808  oldgmg = SvGMAGICAL(sv);
 809
 810  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
 811
 812  t  = vmg_vtable_vtbl(w->vtable);
 813  mg = sv_magicext(sv, data, PERL_MAGIC_ext, t, (const char *) wiz, HEf_SVKEY);
 814  mg->mg_private = 0;
 815
 816  /* sv_magicext() calls mg_magical and increments data's refcount */
 817  SvREFCNT_dec(data);
 818
 819  if (t->svt_copy)
 820   mg->mg_flags |= MGf_COPY;
 821 #if 0
 822  if (t->svt_dup)
 823   mg->mg_flags |= MGf_DUP;
 824 #endif
 825 #if MGf_LOCAL
 826  if (t->svt_local)
 827   mg->mg_flags |= MGf_LOCAL;
 828 #endif /* MGf_LOCAL */
 829
 830  if (SvTYPE(sv) < SVt_PVHV)
 831   goto done;
 832
 833  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 834   * magic is actually never called for them. If the GMAGICAL flag was off before
 835   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 836   * now on, then this wizard has get magic. Hence we can work around the
 837   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 838   * has uvar callbacks, it will be turned back on later. */
 839  if (!oldgmg && SvGMAGICAL(sv))
 840   SvGMAGICAL_off(sv);
 841
 842 #if VMG_UVAR
 843  if (w->uvar) {
 844   MAGIC *prevmagic, *moremagic = NULL;
 845   vmg_uvar_ud ud;
 846
 847   ud.new_uf.uf_val   = vmg_svt_val;
 848   ud.new_uf.uf_set   = NULL;
 849   ud.new_uf.uf_index = 0;
 850   ud.old_uf.uf_val   = NULL;
 851   ud.old_uf.uf_set   = NULL;
 852   ud.old_uf.uf_index = 0;
 853
 854   /* One uvar magic in the chain is enough. */
 855   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 856    moremagic = mg->mg_moremagic;
 857    if (mg->mg_type == PERL_MAGIC_uvar)
 858     break;
 859   }
 860
 861   if (mg) { /* Found another uvar magic. */
 862    struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
 863    if (uf->uf_val == vmg_svt_val) {
 864     /* It's our uvar magic, nothing to do. oldgmg was true. */
 865     goto done;
 866    } else {
 867     /* It's another uvar magic, backup it and replace it by ours. */
 868     ud.old_uf = *uf;
 869     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 870    }
 871   }
 872
 873   sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
 874   vmg_mg_magical(sv);
 875   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
 876    * handled by our uvar callback. */
 877  }
 878 #endif /* VMG_UVAR */
 879
 880 done:
 881  return 1;
 882 }
 883
 884 STATIC UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
 885 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
 886 #if VMG_UVAR
 887  U32 uvars = 0;
 888 #endif /* VMG_UVAR */
 889  MAGIC *mg, *prevmagic, *moremagic = NULL;
 890  IV wid = vmg_wizard_id(w);
 891
 892  if (SvTYPE(sv) < SVt_PVMG)
 893   return 0;
 894
 895  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 896   const vmg_wizard *z;
 897
 898   moremagic = mg->mg_moremagic;
 899
 900   z = vmg_wizard_from_mg(mg);
 901   if (z) {
 902    IV zid = vmg_wizard_id(z);
 903
 904 #if VMG_UVAR
 905    if (zid == wid) {
 906     /* If the current has no uvar, short-circuit uvar deletion. */
 907     uvars = z->uvar ? (uvars + 1) : 0;
 908     break;
 909    } else if (z->uvar) {
 910     ++uvars;
 911     /* We can't break here since we need to find the ext magic to delete. */
 912    }
 913 #else /* VMG_UVAR */
 914    if (zid == wid)
 915     break;
 916 #endif /* !VMG_UVAR */
 917   }
 918  }
 919  if (!mg)
 920   return 0;
 921
 922  if (prevmagic) {
 923   prevmagic->mg_moremagic = moremagic;
 924  } else {
 925   SvMAGIC_set(sv, moremagic);
 926  }
 927  mg->mg_moremagic = NULL;
 928
 929  /* Destroy private data */
 930  if (mg->mg_obj != sv)
 931   SvREFCNT_dec(mg->mg_obj);
 932  /* Unreference the wizard */
 933  SvREFCNT_dec((SV *) mg->mg_ptr);
 934  Safefree(mg);
 935
 936 #if VMG_UVAR
 937  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
 938   /* mg was the first ext magic in the chain that had uvar */
 939
 940   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
 941    const vmg_wizard *z = vmg_wizard_from_mg(mg);
 942
 943    if (z && z->uvar) {
 944     ++uvars;
 945     break;
 946    }
 947   }
 948
 949   if (uvars == 1) {
 950    vmg_uvar_ud *ud;
 951
 952    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
 953     moremagic = mg->mg_moremagic;
 954     if (mg->mg_type == PERL_MAGIC_uvar)
 955      break;
 956    }
 957
 958    ud = (vmg_uvar_ud *) mg->mg_ptr;
 959    if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
 960     /* Revert the original uvar magic. */
 961     struct ufuncs *uf;
 962     Newx(uf, 1, struct ufuncs);
 963     *uf = ud->old_uf;
 964     Safefree(ud);
 965     mg->mg_ptr = (char *) uf;
 966     mg->mg_len = sizeof(*uf);
 967    } else {
 968     /* Remove the uvar magic. */
 969     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 970    }
 971   }
 972  }
 973 #endif /* VMG_UVAR */
 974
 975  vmg_mg_magical(sv);
 976
 977  return 1;
 978 }
 979
 980 /* ... OP info ............................................................. */
 981
 982 #define VMG_OP_INFO_NAME   1
 983 #define VMG_OP_INFO_OBJECT 2
 984
 985 #if VMG_THREADSAFE
 986 STATIC perl_mutex vmg_op_name_init_mutex;
 987 #endif
 988
 989 STATIC U32           vmg_op_name_init      = 0;
 990 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
 991
 992 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
 993 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
 994  switch (opinfo) {
 995   case VMG_OP_INFO_NAME:
 996    VMG_LOCK(&vmg_op_name_init_mutex);
 997    if (!vmg_op_name_init) {
 998     OPCODE t;
 999     for (t = 0; t < OP_max; ++t)
1000      vmg_op_name_len[t] = strlen(PL_op_name[t]);
1001     vmg_op_name_init = 1;
1002    }
1003    VMG_UNLOCK(&vmg_op_name_init_mutex);
1004    break;
1005   case VMG_OP_INFO_OBJECT: {
1006    dMY_CXT;
1007    if (!MY_CXT.b__op_stashes[0]) {
1008     int c;
1009     require_pv("B.pm");
1010     for (c = OPc_NULL; c < OPc_MAX; ++c)
1011      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1012    }
1013    break;
1014   }
1015   default:
1016    break;
1017  }
1018 }
1019
1020 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1021 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1022  if (!PL_op)
1023   return &PL_sv_undef;
1024
1025  switch (opinfo) {
1026   case VMG_OP_INFO_NAME: {
1027    OPCODE t = PL_op->op_type;
1028    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1029   }
1030   case VMG_OP_INFO_OBJECT: {
1031    dMY_CXT;
1032    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1033                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1034   }
1035   default:
1036    break;
1037  }
1038
1039  return &PL_sv_undef;
1040 }
1041
1042 /* --- svt callbacks ------------------------------------------------------- */
1043
1044 #define VMG_CB_CALL_ARGS_MASK  15
1045 #define VMG_CB_CALL_ARGS_SHIFT 4
1046 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
1047
1048 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1049  va_list ap;
1050  int ret = 0;
1051  unsigned int i, args, opinfo;
1052  SV *svr;
1053
1054  dSP;
1055
1056  args    = flags & VMG_CB_CALL_ARGS_MASK;
1057  flags >>= VMG_CB_CALL_ARGS_SHIFT;
1058  opinfo  = flags & VMG_CB_CALL_OPINFO;
1059
1060  ENTER;
1061  SAVETMPS;
1062
1063  PUSHMARK(SP);
1064  EXTEND(SP, args + 1);
1065  PUSHs(sv_2mortal(newRV_inc(sv)));
1066  va_start(ap, sv);
1067  for (i = 0; i < args; ++i) {
1068   SV *sva = va_arg(ap, SV *);
1069   PUSHs(sva ? sva : &PL_sv_undef);
1070  }
1071  va_end(ap);
1072  if (opinfo)
1073   XPUSHs(vmg_op_info(opinfo));
1074  PUTBACK;
1075
1076  vmg_call_sv(cb, G_SCALAR, NULL);
1077
1078  SPAGAIN;
1079  svr = POPs;
1080  if (SvOK(svr))
1081   ret = (int) SvIV(svr);
1082  PUTBACK;
1083
1084  FREETMPS;
1085  LEAVE;
1086
1087  return ret;
1088 }
1089
1090 #define VMG_CB_FLAGS(OI, A) \
1091         ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1092
1093 #define vmg_cb_call1(I, OI, S, A1) \
1094         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1095 #define vmg_cb_call2(I, OI, S, A1, A2) \
1096         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1097 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1098         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1099
1100 STATIC int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1101  return 0;
1102 }
1103
1104 /* ... get magic ........................................................... */
1105
1106 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1107  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1108
1109  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1110 }
1111
1112 #define vmg_svt_get_noop vmg_svt_default_noop
1113
1114 /* ... set magic ........................................................... */
1115
1116 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1117  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1118
1119  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1120 }
1121
1122 #define vmg_svt_set_noop vmg_svt_default_noop
1123
1124 /* ... len magic ........................................................... */
1125
1126 STATIC U32 vmg_sv_len(pTHX_ SV *sv) {
1127 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1128  STRLEN len;
1129 #if VMG_HAS_PERL(5, 9, 3)
1130  const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1131 #else
1132  U8 *s = SvPV(sv, len);
1133 #endif
1134
1135  return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1136 }
1137
1138 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1139  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1140  unsigned int opinfo = w->opinfo;
1141  U32 len, ret;
1142  SV *svr;
1143  svtype t = SvTYPE(sv);
1144
1145  dSP;
1146
1147  ENTER;
1148  SAVETMPS;
1149
1150  PUSHMARK(SP);
1151  EXTEND(SP, 3);
1152  PUSHs(sv_2mortal(newRV_inc(sv)));
1153  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1154  if (t < SVt_PVAV) {
1155   len = vmg_sv_len(sv);
1156   mPUSHu(len);
1157  } else if (t == SVt_PVAV) {
1158   len = av_len((AV *) sv) + 1;
1159   mPUSHu(len);
1160  } else {
1161   len = 0;
1162   PUSHs(&PL_sv_undef);
1163  }
1164  if (opinfo)
1165   XPUSHs(vmg_op_info(opinfo));
1166  PUTBACK;
1167
1168  vmg_call_sv(w->cb_len, G_SCALAR, NULL);
1169
1170  SPAGAIN;
1171  svr = POPs;
1172  ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1173  if (t == SVt_PVAV)
1174   --ret;
1175  PUTBACK;
1176
1177  FREETMPS;
1178  LEAVE;
1179
1180  return ret;
1181 }
1182
1183 STATIC U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1184  U32    len = 0;
1185  svtype t   = SvTYPE(sv);
1186
1187  if (t < SVt_PVAV) {
1188   len = vmg_sv_len(sv);
1189  } else if (t == SVt_PVAV) {
1190   len = (U32) av_len((AV *) sv);
1191  }
1192
1193  return len;
1194 }
1195
1196 /* ... clear magic ......................................................... */
1197
1198 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1199  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1200
1201  return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
1202 }
1203
1204 #define vmg_svt_clear_noop vmg_svt_default_noop
1205
1206 /* ... free magic .......................................................... */
1207
1208 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1209  const vmg_wizard *w;
1210  int ret = 0;
1211  SV *svr;
1212
1213  dSP;
1214
1215  /* During global destruction, we cannot be sure that the wizard and its free
1216   * callback are still alive. */
1217  if (PL_dirty)
1218   return 0;
1219
1220  w = vmg_wizard_from_mg_nocheck(mg);
1221
1222  /* So that it survives the temp cleanup below */
1223  SvREFCNT_inc_simple_void(sv);
1224
1225 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1226  /* The previous magic tokens were freed but the magic chain wasn't updated, so
1227   * if you access the sv from the callback the old deleted magics will trigger
1228   * and cause memory misreads. Change 32686 solved it that way : */
1229  SvMAGIC_set(sv, mg);
1230 #endif
1231
1232  ENTER;
1233  SAVETMPS;
1234
1235  PUSHMARK(SP);
1236  EXTEND(SP, 2);
1237  PUSHs(sv_2mortal(newRV_inc(sv)));
1238  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1239  if (w->opinfo)
1240   XPUSHs(vmg_op_info(w->opinfo));
1241  PUTBACK;
1242
1243  vmg_call_sv(w->cb_free, G_SCALAR, sv);
1244
1245  SPAGAIN;
1246  svr = POPs;
1247  if (SvOK(svr))
1248   ret = (int) SvIV(svr);
1249  PUTBACK;
1250
1251  FREETMPS;
1252  LEAVE;
1253
1254  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1255   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1256  --SvREFCNT(sv);
1257
1258  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1259   * mg->mg_ptr reference count */
1260  return ret;
1261 }
1262
1263 #define vmg_svt_free_noop vmg_svt_default_noop
1264
1265 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1266 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1267 #else
1268 # define VMG_SVT_COPY_KEYLEN_TYPE int
1269 #endif
1270
1271 /* ... copy magic .......................................................... */
1272
1273 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1274  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1275  SV *keysv;
1276  int ret;
1277
1278  if (keylen == HEf_SVKEY) {
1279   keysv = (SV *) key;
1280  } else {
1281   keysv = newSVpvn(key, keylen);
1282  }
1283
1284  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1285
1286  if (keylen != HEf_SVKEY) {
1287   SvREFCNT_dec(keysv);
1288  }
1289
1290  return ret;
1291 }
1292
1293 STATIC int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1294  return 0;
1295 }
1296
1297 /* ... dup magic ........................................................... */
1298
1299 #if 0
1300 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1301  return 0;
1302 }
1303 #define vmg_svt_dup_noop vmg_svt_dup
1304 #endif
1305
1306 /* ... local magic ......................................................... */
1307
1308 #if MGf_LOCAL
1309
1310 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1311  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1312
1313  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1314 }
1315
1316 #define vmg_svt_local_noop vmg_svt_default_noop
1317
1318 #endif /* MGf_LOCAL */
1319
1320 /* ... uvar magic .......................................................... */
1321
1322 #if VMG_UVAR
1323 STATIC OP *vmg_pp_resetuvar(pTHX) {
1324  SvRMAGICAL_on(cSVOP_sv);
1325  return NORMAL;
1326 }
1327
1328 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1329  vmg_uvar_ud *ud;
1330  MAGIC *mg, *umg;
1331  SV *key = NULL, *newkey = NULL;
1332  int tied = 0;
1333
1334  umg = mg_find(sv, PERL_MAGIC_uvar);
1335  /* umg can't be NULL or we wouldn't be there. */
1336  key = umg->mg_obj;
1337  ud  = (vmg_uvar_ud *) umg->mg_ptr;
1338
1339  if (ud->old_uf.uf_val)
1340   ud->old_uf.uf_val(aTHX_ action, sv);
1341  if (ud->old_uf.uf_set)
1342   ud->old_uf.uf_set(aTHX_ action, sv);
1343
1344  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
1345   const vmg_wizard *w;
1346
1347   switch (mg->mg_type) {
1348    case PERL_MAGIC_ext:
1349     break;
1350    case PERL_MAGIC_tied:
1351     ++tied;
1352     continue;
1353    default:
1354     continue;
1355   }
1356
1357   w = vmg_wizard_from_mg(mg);
1358   if (!w)
1359    continue;
1360
1361   switch (w->uvar) {
1362    case 0:
1363     continue;
1364    case 2:
1365     if (!newkey)
1366      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1367   }
1368
1369   switch (action
1370              & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1371    case 0:
1372     if (w->cb_fetch)
1373      vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
1374     break;
1375    case HV_FETCH_ISSTORE:
1376    case HV_FETCH_LVALUE:
1377    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1378     if (w->cb_store)
1379      vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
1380     break;
1381    case HV_FETCH_ISEXISTS:
1382     if (w->cb_exists)
1383      vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
1384     break;
1385    case HV_DELETE:
1386     if (w->cb_delete)
1387      vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
1388     break;
1389   }
1390  }
1391
1392  if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1393   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1394    * mistaken for a tied hash by the rest of hv_common. It will be reset by
1395    * the op_ppaddr of a new fake op injected between the current and the next
1396    * one. */
1397   OP *nop = PL_op->op_next;
1398   if (!nop || nop->op_ppaddr != vmg_pp_resetuvar) {
1399    SVOP *svop;
1400    NewOp(1101, svop, 1, SVOP);
1401    svop->op_type   = OP_STUB;
1402    svop->op_ppaddr = vmg_pp_resetuvar;
1403    svop->op_next   = nop;
1404    svop->op_flags  = 0;
1405    svop->op_sv     = sv;
1406    PL_op->op_next  = (OP *) svop;
1407   }
1408   SvRMAGICAL_off(sv);
1409  }
1410
1411  return 0;
1412 }
1413 #endif /* VMG_UVAR */
1414
1415 /* --- Macros for the XS section ------------------------------------------- */
1416
1417 #ifdef CvISXSUB
1418 # define VMG_CVOK(C) \
1419    ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
1420 #else
1421 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
1422 #endif
1423
1424 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
1425
1426 #define VMG_SET_CB(S, N) {       \
1427  SV *cb = (S);                   \
1428  if (SvOK(cb) && SvROK(cb)) {    \
1429   cb = SvRV(cb);                 \
1430   if (VMG_CBOK(cb))              \
1431    SvREFCNT_inc_simple_void(cb); \
1432   else                           \
1433    cb = NULL;                    \
1434  } else {                        \
1435   cb = NULL;                     \
1436  }                               \
1437  w->cb_ ## N = cb;               \
1438 }
1439
1440 #define VMG_SET_SVT_CB(S, N) {   \
1441  SV *cb = (S);                   \
1442  if (SvOK(cb) && SvROK(cb)) {    \
1443   cb = SvRV(cb);                 \
1444   if (VMG_CBOK(cb)) {            \
1445    t->svt_ ## N = vmg_svt_ ## N; \
1446    SvREFCNT_inc_simple_void(cb); \
1447   } else {                       \
1448    t->svt_ ## N = vmg_svt_ ## N ## _noop; \
1449    cb           = NULL;          \
1450   }                              \
1451  } else {                        \
1452   t->svt_ ## N = NULL;           \
1453   cb           = NULL;           \
1454  }                               \
1455  w->cb_ ## N = cb;               \
1456 }
1457
1458 /* --- XS ------------------------------------------------------------------ */
1459
1460 MODULE = Variable::Magic            PACKAGE = Variable::Magic
1461
1462 PROTOTYPES: ENABLE
1463
1464 BOOT:
1465 {
1466  HV *stash;
1467
1468  MY_CXT_INIT;
1469  MY_CXT.b__op_stashes[0] = NULL;
1470 #if VMG_THREADSAFE
1471  MUTEX_INIT(&vmg_vtable_refcount_mutex);
1472  MUTEX_INIT(&vmg_op_name_init_mutex);
1473 #endif
1474
1475  stash = gv_stashpv(__PACKAGE__, 1);
1476  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1477  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1478  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1479  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1480  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1481                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1482  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1483                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1484  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1485                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1486  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1487                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1488  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1489                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1490  newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1491                     newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1492  newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1493  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1494  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1495  newCONSTSUB(stash, "VMG_FORKSAFE",        newSVuv(VMG_FORKSAFE));
1496  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1497  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1498 }
1499
1500 #if VMG_THREADSAFE
1501
1502 void
1503 CLONE(...)
1504 PROTOTYPE: DISABLE
1505 PREINIT:
1506  U32 had_b__op_stash = 0;
1507  int c;
1508 PPCODE:
1509  {
1510   dMY_CXT;
1511   for (c = OPc_NULL; c < OPc_MAX; ++c) {
1512    if (MY_CXT.b__op_stashes[c])
1513     had_b__op_stash |= (((U32) 1) << c);
1514   }
1515  }
1516  {
1517   MY_CXT_CLONE;
1518   for (c = OPc_NULL; c < OPc_MAX; ++c) {
1519    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1520                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1521   }
1522  }
1523  XSRETURN(0);
1524
1525 #endif /* VMG_THREADSAFE */
1526
1527 SV *_wizard(...)
1528 PROTOTYPE: DISABLE
1529 PREINIT:
1530  vmg_wizard *w;
1531  MGVTBL *t;
1532  SV *op_info, *copy_key;
1533  I32 i = 0;
1534 CODE:
1535  if (items != 9
1536 #if MGf_LOCAL
1537               + 1
1538 #endif /* MGf_LOCAL */
1539 #if VMG_UVAR
1540               + 5
1541 #endif /* VMG_UVAR */
1542               ) { croak(vmg_wrongargnum); }
1543
1544  op_info = ST(i++);
1545  w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
1546  t = vmg_vtable_vtbl(w->vtable);
1547
1548  VMG_SET_CB(ST(i++), data);
1549
1550  VMG_SET_SVT_CB(ST(i++), get);
1551  VMG_SET_SVT_CB(ST(i++), set);
1552  VMG_SET_SVT_CB(ST(i++), len);
1553  VMG_SET_SVT_CB(ST(i++), clear);
1554  VMG_SET_SVT_CB(ST(i++), free);
1555  VMG_SET_SVT_CB(ST(i++), copy);
1556  /* VMG_SET_SVT_CB(ST(i++), dup); */
1557  i++;
1558  t->svt_dup = NULL;
1559  w->cb_dup  = NULL;
1560 #if MGf_LOCAL
1561  VMG_SET_SVT_CB(ST(i++), local);
1562 #endif /* MGf_LOCAL */
1563 #if VMG_UVAR
1564  VMG_SET_CB(ST(i++), fetch);
1565  VMG_SET_CB(ST(i++), store);
1566  VMG_SET_CB(ST(i++), exists);
1567  VMG_SET_CB(ST(i++), delete);
1568
1569  copy_key = ST(i++);
1570  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1571   w->uvar = SvTRUE(copy_key) ? 2 : 1;
1572 #endif /* VMG_UVAR */
1573
1574  RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
1575 OUTPUT:
1576  RETVAL
1577
1578 SV *cast(SV *sv, SV *wiz, ...)
1579 PROTOTYPE: \[$@%&*]$@
1580 PREINIT:
1581  const vmg_wizard *w = NULL;
1582  SV **args = NULL;
1583  UV ret;
1584  I32 i = 0;
1585 CODE:
1586  if (items > 2) {
1587   i = items - 2;
1588   args = &ST(2);
1589  }
1590  if (SvROK(wiz)) {
1591   wiz = SvRV_const(wiz);
1592   w   = vmg_wizard_from_sv(wiz);
1593  }
1594  if (!w)
1595   croak(vmg_invalid_wiz);
1596  RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
1597 OUTPUT:
1598  RETVAL
1599
1600 void
1601 getdata(SV *sv, SV *wiz)
1602 PROTOTYPE: \[$@%&*]$
1603 PREINIT:
1604  const vmg_wizard *w = NULL;
1605  SV *data;
1606 PPCODE:
1607  if (SvROK(wiz))
1608   w = vmg_wizard_from_sv(SvRV_const(wiz));
1609  if (!w)
1610   croak(vmg_invalid_wiz);
1611  data = vmg_data_get(SvRV(sv), w);
1612  if (!data)
1613   XSRETURN_EMPTY;
1614  ST(0) = data;
1615  XSRETURN(1);
1616
1617 SV *dispell(SV *sv, SV *wiz)
1618 PROTOTYPE: \[$@%&*]$
1619 PREINIT:
1620  const vmg_wizard *w = NULL;
1621 CODE:
1622  if (SvROK(wiz))
1623   w = vmg_wizard_from_sv(SvRV_const(wiz));
1624  if (!w)
1625   croak(vmg_invalid_wiz);
1626  RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));
1627 OUTPUT:
1628  RETVAL