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 STATIC I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, int (*cleanup)(pTHX_ void *), void *ud) {
 226 #define vmg_call_sv(S, F, C, U) vmg_call_sv(aTHX_ (S), (F), (C), (U))
 227  I32 ret, cxix, in_eval = 0;
 228  PERL_CONTEXT saved_cx;
 229  SV *old_err = NULL;
 230
 231  if (SvTRUE(ERRSV)) {
 232   old_err = ERRSV;
 233   ERRSV   = newSV(0);
 234  }
 235
 236  if (cxstack_ix < cxstack_max) {
 237   cxix    = cxstack_ix + 1;
 238   in_eval = CxTYPE(cxstack + cxix) == CXt_EVAL;
 239  } else {
 240   cxix    = Perl_cxinc(aTHX);
 241  }
 242  /* The last popped context will be reused by call_sv(), but our callers may
 243   * still need its previous value. Back it up so that it isn't clobbered. */
 244  saved_cx = cxstack[cxix];
 245
 246  ret = call_sv(sv, flags | G_EVAL);
 247
 248  cxstack[cxix] = saved_cx;
 249
 250  if (SvTRUE(ERRSV)) {
 251   if (old_err) {
 252    sv_setsv(old_err, ERRSV);
 253    SvREFCNT_dec(ERRSV);
 254    ERRSV = old_err;
 255   }
 256   if (IN_PERL_COMPILETIME) {
 257    if (!PL_in_eval) {
 258     if (PL_errors)
 259      sv_catsv(PL_errors, ERRSV);
 260     else
 261      Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
 262     SvCUR_set(ERRSV, 0);
 263    }
 264 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
 265    if (PL_parser)
 266     ++PL_parser->error_count;
 267 #elif defined(PL_error_count)
 268    ++PL_error_count;
 269 #else
 270    ++PL_Ierror_count;
 271 #endif
 272    } else if (!in_eval) {
 273     if (!cleanup || cleanup(aTHX_ ud))
 274      croak(NULL);
 275    }
 276  } else {
 277   if (old_err) {
 278    SvREFCNT_dec(ERRSV);
 279    ERRSV = old_err;
 280   }
 281  }
 282
 283  return ret;
 284 }
 285
 286 /* --- Stolen chunk of B --------------------------------------------------- */
 287
 288 typedef enum {
 289  OPc_NULL   = 0,
 290  OPc_BASEOP = 1,
 291  OPc_UNOP   = 2,
 292  OPc_BINOP  = 3,
 293  OPc_LOGOP  = 4,
 294  OPc_LISTOP = 5,
 295  OPc_PMOP   = 6,
 296  OPc_SVOP   = 7,
 297  OPc_PADOP  = 8,
 298  OPc_PVOP   = 9,
 299  OPc_LOOP   = 10,
 300  OPc_COP    = 11,
 301  OPc_MAX    = 12
 302 } opclass;
 303
 304 STATIC const char *const vmg_opclassnames[] = {
 305  "B::NULL",
 306  "B::OP",
 307  "B::UNOP",
 308  "B::BINOP",
 309  "B::LOGOP",
 310  "B::LISTOP",
 311  "B::PMOP",
 312  "B::SVOP",
 313  "B::PADOP",
 314  "B::PVOP",
 315  "B::LOOP",
 316  "B::COP"
 317 };
 318
 319 STATIC opclass vmg_opclass(const OP *o) {
 320 #if 0
 321  if (!o)
 322   return OPc_NULL;
 323 #endif
 324
 325  if (o->op_type == 0)
 326   return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 327
 328  if (o->op_type == OP_SASSIGN)
 329   return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
 330
 331  if (o->op_type == OP_AELEMFAST) {
 332 #if PERL_VERSION <= 14
 333   if (o->op_flags & OPf_SPECIAL)
 334    return OPc_BASEOP;
 335   else
 336 #endif
 337 #ifdef USE_ITHREADS
 338    return OPc_PADOP;
 339 #else
 340    return OPc_SVOP;
 341 #endif
 342  }
 343
 344 #ifdef USE_ITHREADS
 345  if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
 346   return OPc_PADOP;
 347 #endif
 348
 349  switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
 350   case OA_BASEOP:
 351    return OPc_BASEOP;
 352   case OA_UNOP:
 353    return OPc_UNOP;
 354   case OA_BINOP:
 355    return OPc_BINOP;
 356   case OA_LOGOP:
 357    return OPc_LOGOP;
 358   case OA_LISTOP:
 359    return OPc_LISTOP;
 360   case OA_PMOP:
 361    return OPc_PMOP;
 362   case OA_SVOP:
 363    return OPc_SVOP;
 364   case OA_PADOP:
 365    return OPc_PADOP;
 366   case OA_PVOP_OR_SVOP:
 367    return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
 368   case OA_LOOP:
 369    return OPc_LOOP;
 370   case OA_COP:
 371    return OPc_COP;
 372   case OA_BASEOP_OR_UNOP:
 373    return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 374   case OA_FILESTATOP:
 375    return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
 376 #ifdef USE_ITHREADS
 377            (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
 378 #else
 379            (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
 380 #endif
 381   case OA_LOOPEXOP:
 382    if (o->op_flags & OPf_STACKED)
 383     return OPc_UNOP;
 384    else if (o->op_flags & OPf_SPECIAL)
 385     return OPc_BASEOP;
 386    else
 387     return OPc_PVOP;
 388  }
 389
 390  return OPc_BASEOP;
 391 }
 392
 393 /* --- Error messages ------------------------------------------------------ */
 394
 395 STATIC const char vmg_invalid_wiz[]    = "Invalid wizard object";
 396 STATIC const char vmg_wrongargnum[]    = "Wrong number of arguments";
 397 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
 398
 399 /* --- Context-safe global data -------------------------------------------- */
 400
 401 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 402
 403 typedef struct {
 404  HV *b__op_stashes[OPc_MAX];
 405 } my_cxt_t;
 406
 407 START_MY_CXT
 408
 409 /* --- <vmg_vtable> structure ---------------------------------------------- */
 410
 411 #if VMG_THREADSAFE
 412
 413 typedef struct {
 414  MGVTBL *vtbl;
 415  U32     refcount;
 416 } vmg_vtable;
 417
 418 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
 419 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
 420  vmg_vtable *t;
 421
 422  t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
 423
 424  t->vtbl     = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
 425  t->refcount = 1;
 426
 427  return t;
 428 }
 429
 430 #define vmg_vtable_vtbl(T) (T)->vtbl
 431
 432 STATIC perl_mutex vmg_vtable_refcount_mutex;
 433
 434 STATIC vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
 435 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
 436  VMG_LOCK(&vmg_vtable_refcount_mutex);
 437  ++t->refcount;
 438  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
 439
 440  return t;
 441 }
 442
 443 STATIC void vmg_vtable_free(pTHX_ vmg_vtable *t) {
 444 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
 445  U32 refcount;
 446
 447  VMG_LOCK(&vmg_vtable_refcount_mutex);
 448  refcount = --t->refcount;
 449  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
 450
 451  if (!refcount) {
 452   PerlMemShared_free(t->vtbl);
 453   PerlMemShared_free(t);
 454  }
 455 }
 456
 457 #else /* VMG_THREADSAFE */
 458
 459 typedef MGVTBL vmg_vtable;
 460
 461 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
 462 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
 463  vmg_vtable *t;
 464
 465  Newx(t, 1, vmg_vtable);
 466
 467  return t;
 468 }
 469
 470 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
 471
 472 #define vmg_vtable_free(T) Safefree(T)
 473
 474 #endif /* !VMG_THREADSAFE */
 475
 476 /* --- <vmg_wizard> structure ---------------------------------------------- */
 477
 478 typedef struct {
 479  vmg_vtable *vtable;
 480
 481  U8 opinfo;
 482  U8 uvar;
 483
 484  SV *cb_data;
 485  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
 486  SV *cb_copy;
 487  SV *cb_dup;
 488 #if MGf_LOCAL
 489  SV *cb_local;
 490 #endif /* MGf_LOCAL */
 491 #if VMG_UVAR
 492  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
 493 #endif /* VMG_UVAR */
 494 } vmg_wizard;
 495
 496 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo);
 497
 498 STATIC vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
 499 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
 500  vmg_wizard *w;
 501
 502  Newx(w, 1, vmg_wizard);
 503
 504  w->uvar   = 0;
 505  w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
 506  if (w->opinfo)
 507   vmg_op_info_init(aTHX_ w->opinfo);
 508
 509  w->vtable = vmg_vtable_alloc();
 510
 511  return w;
 512 }
 513
 514 STATIC void vmg_wizard_free(pTHX_ vmg_wizard *w) {
 515 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
 516  if (!w)
 517   return;
 518
 519  /* During global destruction, any of the callbacks may already have been
 520   * freed, so we can't rely on still being able to access them. */
 521  if (!PL_dirty) {
 522   SvREFCNT_dec(w->cb_data);
 523   SvREFCNT_dec(w->cb_get);
 524   SvREFCNT_dec(w->cb_set);
 525   SvREFCNT_dec(w->cb_len);
 526   SvREFCNT_dec(w->cb_clear);
 527   SvREFCNT_dec(w->cb_free);
 528   SvREFCNT_dec(w->cb_copy);
 529 #if 0
 530   SvREFCNT_dec(w->cb_dup);
 531 #endif
 532 #if MGf_LOCAL
 533   SvREFCNT_dec(w->cb_local);
 534 #endif /* MGf_LOCAL */
 535 #if VMG_UVAR
 536   SvREFCNT_dec(w->cb_fetch);
 537   SvREFCNT_dec(w->cb_store);
 538   SvREFCNT_dec(w->cb_exists);
 539   SvREFCNT_dec(w->cb_delete);
 540 #endif /* VMG_UVAR */
 541  }
 542
 543  /* PerlMemShared_free() and Safefree() are still fine during global
 544   * destruction though. */
 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  vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
 599
 600  return 0;
 601 }
 602
 603 #if VMG_THREADSAFE
 604
 605 STATIC int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
 606  mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
 607
 608  return 0;
 609 }
 610
 611 #endif /* VMG_THREADSAFE */
 612
 613 STATIC MGVTBL vmg_wizard_sv_vtbl = {
 614  NULL,               /* get */
 615  NULL,               /* set */
 616  NULL,               /* len */
 617  NULL,               /* clear */
 618  vmg_wizard_sv_free, /* free */
 619  NULL,               /* copy */
 620 #if VMG_THREADSAFE
 621  vmg_wizard_sv_dup,  /* dup */
 622 #else
 623  NULL,               /* dup */
 624 #endif
 625 #if MGf_LOCAL
 626  NULL,               /* local */
 627 #endif /* MGf_LOCAL */
 628 };
 629
 630 STATIC SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
 631 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
 632  SV *wiz;
 633
 634 #if VMG_THREADSAFE
 635  wiz = newSV(0);
 636 #else
 637  wiz = newSViv(PTR2IV(w));
 638 #endif
 639
 640  if (w) {
 641   MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_sv_vtbl,
 642                                      (const char *) w, 0);
 643   mg->mg_private = 0;
 644 #if VMG_THREADSAFE
 645   mg->mg_flags  |= MGf_DUP;
 646 #endif
 647  }
 648  SvREADONLY_on(wiz);
 649
 650  return wiz;
 651 }
 652
 653 #if VMG_THREADSAFE
 654
 655 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
 656
 657 STATIC const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
 658  MAGIC *mg;
 659
 660  for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
 661   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
 662    return (const vmg_wizard *) mg->mg_ptr;
 663  }
 664
 665  return NULL;
 666 }
 667
 668 #else /* VMG_THREADSAFE */
 669
 670 #define vmg_sv_has_wizard_type(S) SvIOK(S)
 671
 672 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
 673
 674 #endif /* !VMG_THREADSAFE */
 675
 676 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
 677
 678 STATIC const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
 679  if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
 680   SV *sv = (SV *) mg->mg_ptr;
 681
 682   if (vmg_sv_has_wizard_type(sv))
 683    return vmg_wizard_from_sv_nocheck(sv);
 684  }
 685
 686  return NULL;
 687 }
 688
 689 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
 690
 691 /* --- User-level functions implementation --------------------------------- */
 692
 693 STATIC const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
 694  const MAGIC *mg;
 695  IV wid;
 696
 697  if (SvTYPE(sv) < SVt_PVMG)
 698   return NULL;
 699
 700  wid = vmg_wizard_id(w);
 701
 702  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 703   const vmg_wizard *z = vmg_wizard_from_mg(mg);
 704
 705   if (z && vmg_wizard_id(z) == wid)
 706    return mg;
 707  }
 708
 709  return NULL;
 710 }
 711
 712 /* ... Construct private data .............................................. */
 713
 714 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
 715 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
 716  I32 i;
 717  SV *nsv;
 718
 719  dSP;
 720
 721  ENTER;
 722  SAVETMPS;
 723
 724  PUSHMARK(SP);
 725  EXTEND(SP, items + 1);
 726  PUSHs(sv_2mortal(newRV_inc(sv)));
 727  for (i = 0; i < items; ++i)
 728   PUSHs(args[i]);
 729  PUTBACK;
 730
 731  vmg_call_sv(ctor, G_SCALAR, 0, NULL);
 732
 733  SPAGAIN;
 734  nsv = POPs;
 735 #if VMG_HAS_PERL(5, 8, 3)
 736  SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
 737 #else
 738  nsv = sv_newref(nsv);          /* Workaround some bug in SvREFCNT_inc() */
 739 #endif
 740  PUTBACK;
 741
 742  FREETMPS;
 743  LEAVE;
 744
 745  return nsv;
 746 }
 747
 748 STATIC SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
 749 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
 750  const MAGIC *mg = vmg_find(sv, w);
 751
 752  return mg ? mg->mg_obj : NULL;
 753 }
 754
 755 /* ... Magic cast/dispell .................................................. */
 756
 757 #if VMG_UVAR
 758 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
 759
 760 typedef struct {
 761  struct ufuncs new_uf;
 762  struct ufuncs old_uf;
 763 } vmg_uvar_ud;
 764
 765 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 766  if (prevmagic) {
 767   prevmagic->mg_moremagic = moremagic;
 768  } else {
 769   SvMAGIC_set(sv, moremagic);
 770  }
 771  mg->mg_moremagic = NULL;
 772  Safefree(mg->mg_ptr);
 773  Safefree(mg);
 774 }
 775 #endif /* VMG_UVAR */
 776
 777 STATIC UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
 778 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
 779  MAGIC  *mg;
 780  MGVTBL *t;
 781  SV     *data;
 782  U32     oldgmg;
 783
 784  if (vmg_find(sv, w))
 785   return 1;
 786
 787  oldgmg = SvGMAGICAL(sv);
 788
 789  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
 790
 791  t  = vmg_vtable_vtbl(w->vtable);
 792  mg = sv_magicext(sv, data, PERL_MAGIC_ext, t, (const char *) wiz, HEf_SVKEY);
 793  mg->mg_private = 0;
 794
 795  /* sv_magicext() calls mg_magical and increments data's refcount */
 796  SvREFCNT_dec(data);
 797
 798  if (t->svt_copy)
 799   mg->mg_flags |= MGf_COPY;
 800 #if 0
 801  if (t->svt_dup)
 802   mg->mg_flags |= MGf_DUP;
 803 #endif
 804 #if MGf_LOCAL
 805  if (t->svt_local)
 806   mg->mg_flags |= MGf_LOCAL;
 807 #endif /* MGf_LOCAL */
 808
 809  if (SvTYPE(sv) < SVt_PVHV)
 810   goto done;
 811
 812  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 813   * magic is actually never called for them. If the GMAGICAL flag was off before
 814   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 815   * now on, then this wizard has get magic. Hence we can work around the
 816   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 817   * has uvar callbacks, it will be turned back on later. */
 818  if (!oldgmg && SvGMAGICAL(sv))
 819   SvGMAGICAL_off(sv);
 820
 821 #if VMG_UVAR
 822  if (w->uvar) {
 823   MAGIC *prevmagic, *moremagic = NULL;
 824   vmg_uvar_ud ud;
 825
 826   ud.new_uf.uf_val   = vmg_svt_val;
 827   ud.new_uf.uf_set   = NULL;
 828   ud.new_uf.uf_index = 0;
 829   ud.old_uf.uf_val   = NULL;
 830   ud.old_uf.uf_set   = NULL;
 831   ud.old_uf.uf_index = 0;
 832
 833   /* One uvar magic in the chain is enough. */
 834   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 835    moremagic = mg->mg_moremagic;
 836    if (mg->mg_type == PERL_MAGIC_uvar)
 837     break;
 838   }
 839
 840   if (mg) { /* Found another uvar magic. */
 841    struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
 842    if (uf->uf_val == vmg_svt_val) {
 843     /* It's our uvar magic, nothing to do. oldgmg was true. */
 844     goto done;
 845    } else {
 846     /* It's another uvar magic, backup it and replace it by ours. */
 847     ud.old_uf = *uf;
 848     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 849    }
 850   }
 851
 852   sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
 853   vmg_mg_magical(sv);
 854   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
 855    * handled by our uvar callback. */
 856  }
 857 #endif /* VMG_UVAR */
 858
 859 done:
 860  return 1;
 861 }
 862
 863 STATIC UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
 864 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
 865 #if VMG_UVAR
 866  U32 uvars = 0;
 867 #endif /* VMG_UVAR */
 868  MAGIC *mg, *prevmagic, *moremagic = NULL;
 869  IV wid = vmg_wizard_id(w);
 870
 871  if (SvTYPE(sv) < SVt_PVMG)
 872   return 0;
 873
 874  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 875   const vmg_wizard *z;
 876
 877   moremagic = mg->mg_moremagic;
 878
 879   z = vmg_wizard_from_mg(mg);
 880   if (z) {
 881    IV zid = vmg_wizard_id(z);
 882
 883 #if VMG_UVAR
 884    if (zid == wid) {
 885     /* If the current has no uvar, short-circuit uvar deletion. */
 886     uvars = z->uvar ? (uvars + 1) : 0;
 887     break;
 888    } else if (z->uvar) {
 889     ++uvars;
 890     /* We can't break here since we need to find the ext magic to delete. */
 891    }
 892 #else /* VMG_UVAR */
 893    if (zid == wid)
 894     break;
 895 #endif /* !VMG_UVAR */
 896   }
 897  }
 898  if (!mg)
 899   return 0;
 900
 901  if (prevmagic) {
 902   prevmagic->mg_moremagic = moremagic;
 903  } else {
 904   SvMAGIC_set(sv, moremagic);
 905  }
 906  mg->mg_moremagic = NULL;
 907
 908  /* Destroy private data */
 909  if (mg->mg_obj != sv)
 910   SvREFCNT_dec(mg->mg_obj);
 911  /* Unreference the wizard */
 912  SvREFCNT_dec((SV *) mg->mg_ptr);
 913  Safefree(mg);
 914
 915 #if VMG_UVAR
 916  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
 917   /* mg was the first ext magic in the chain that had uvar */
 918
 919   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
 920    const vmg_wizard *z = vmg_wizard_from_mg(mg);
 921
 922    if (z && z->uvar) {
 923     ++uvars;
 924     break;
 925    }
 926   }
 927
 928   if (uvars == 1) {
 929    vmg_uvar_ud *ud;
 930
 931    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
 932     moremagic = mg->mg_moremagic;
 933     if (mg->mg_type == PERL_MAGIC_uvar)
 934      break;
 935    }
 936
 937    ud = (vmg_uvar_ud *) mg->mg_ptr;
 938    if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
 939     /* Revert the original uvar magic. */
 940     struct ufuncs *uf;
 941     Newx(uf, 1, struct ufuncs);
 942     *uf = ud->old_uf;
 943     Safefree(ud);
 944     mg->mg_ptr = (char *) uf;
 945     mg->mg_len = sizeof(*uf);
 946    } else {
 947     /* Remove the uvar magic. */
 948     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 949    }
 950   }
 951  }
 952 #endif /* VMG_UVAR */
 953
 954  vmg_mg_magical(sv);
 955
 956  return 1;
 957 }
 958
 959 /* ... OP info ............................................................. */
 960
 961 #define VMG_OP_INFO_NAME   1
 962 #define VMG_OP_INFO_OBJECT 2
 963
 964 #if VMG_THREADSAFE
 965 STATIC perl_mutex vmg_op_name_init_mutex;
 966 #endif
 967
 968 STATIC U32           vmg_op_name_init      = 0;
 969 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
 970
 971 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
 972 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
 973  switch (opinfo) {
 974   case VMG_OP_INFO_NAME:
 975    VMG_LOCK(&vmg_op_name_init_mutex);
 976    if (!vmg_op_name_init) {
 977     OPCODE t;
 978     for (t = 0; t < OP_max; ++t)
 979      vmg_op_name_len[t] = strlen(PL_op_name[t]);
 980     vmg_op_name_init = 1;
 981    }
 982    VMG_UNLOCK(&vmg_op_name_init_mutex);
 983    break;
 984   case VMG_OP_INFO_OBJECT: {
 985    dMY_CXT;
 986    if (!MY_CXT.b__op_stashes[0]) {
 987     int c;
 988     require_pv("B.pm");
 989     for (c = OPc_NULL; c < OPc_MAX; ++c)
 990      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
 991    }
 992    break;
 993   }
 994   default:
 995    break;
 996  }
 997 }
 998
 999 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1000 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1001  if (!PL_op)
1002   return &PL_sv_undef;
1003
1004  switch (opinfo) {
1005   case VMG_OP_INFO_NAME: {
1006    OPCODE t = PL_op->op_type;
1007    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1008   }
1009   case VMG_OP_INFO_OBJECT: {
1010    dMY_CXT;
1011    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1012                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1013   }
1014   default:
1015    break;
1016  }
1017
1018  return &PL_sv_undef;
1019 }
1020
1021 /* --- svt callbacks ------------------------------------------------------- */
1022
1023 #define VMG_CB_CALL_ARGS_MASK  15
1024 #define VMG_CB_CALL_ARGS_SHIFT 4
1025 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
1026
1027 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1028  va_list ap;
1029  int ret = 0;
1030  unsigned int i, args, opinfo;
1031  SV *svr;
1032
1033  dSP;
1034
1035  args    = flags & VMG_CB_CALL_ARGS_MASK;
1036  flags >>= VMG_CB_CALL_ARGS_SHIFT;
1037  opinfo  = flags & VMG_CB_CALL_OPINFO;
1038
1039  ENTER;
1040  SAVETMPS;
1041
1042  PUSHMARK(SP);
1043  EXTEND(SP, args + 1);
1044  PUSHs(sv_2mortal(newRV_inc(sv)));
1045  va_start(ap, sv);
1046  for (i = 0; i < args; ++i) {
1047   SV *sva = va_arg(ap, SV *);
1048   PUSHs(sva ? sva : &PL_sv_undef);
1049  }
1050  va_end(ap);
1051  if (opinfo)
1052   XPUSHs(vmg_op_info(opinfo));
1053  PUTBACK;
1054
1055  vmg_call_sv(cb, G_SCALAR, 0, NULL);
1056
1057  SPAGAIN;
1058  svr = POPs;
1059  if (SvOK(svr))
1060   ret = (int) SvIV(svr);
1061  PUTBACK;
1062
1063  FREETMPS;
1064  LEAVE;
1065
1066  return ret;
1067 }
1068
1069 #define VMG_CB_FLAGS(OI, A) \
1070         ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1071
1072 #define vmg_cb_call1(I, OI, S, A1) \
1073         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1074 #define vmg_cb_call2(I, OI, S, A1, A2) \
1075         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1076 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1077         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1078
1079 STATIC int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1080  return 0;
1081 }
1082
1083 /* ... get magic ........................................................... */
1084
1085 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1086  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1087
1088  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1089 }
1090
1091 #define vmg_svt_get_noop vmg_svt_default_noop
1092
1093 /* ... set magic ........................................................... */
1094
1095 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1096  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1097
1098  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1099 }
1100
1101 #define vmg_svt_set_noop vmg_svt_default_noop
1102
1103 /* ... len magic ........................................................... */
1104
1105 STATIC U32 vmg_sv_len(pTHX_ SV *sv) {
1106 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1107  STRLEN len;
1108 #if VMG_HAS_PERL(5, 9, 3)
1109  const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1110 #else
1111  U8 *s = SvPV(sv, len);
1112 #endif
1113
1114  return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1115 }
1116
1117 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1118  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1119  unsigned int opinfo = w->opinfo;
1120  U32 len, ret;
1121  SV *svr;
1122  svtype t = SvTYPE(sv);
1123
1124  dSP;
1125
1126  ENTER;
1127  SAVETMPS;
1128
1129  PUSHMARK(SP);
1130  EXTEND(SP, 3);
1131  PUSHs(sv_2mortal(newRV_inc(sv)));
1132  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1133  if (t < SVt_PVAV) {
1134   len = vmg_sv_len(sv);
1135   mPUSHu(len);
1136  } else if (t == SVt_PVAV) {
1137   len = av_len((AV *) sv) + 1;
1138   mPUSHu(len);
1139  } else {
1140   len = 0;
1141   PUSHs(&PL_sv_undef);
1142  }
1143  if (opinfo)
1144   XPUSHs(vmg_op_info(opinfo));
1145  PUTBACK;
1146
1147  vmg_call_sv(w->cb_len, G_SCALAR, 0, NULL);
1148
1149  SPAGAIN;
1150  svr = POPs;
1151  ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1152  if (t == SVt_PVAV)
1153   --ret;
1154  PUTBACK;
1155
1156  FREETMPS;
1157  LEAVE;
1158
1159  return ret;
1160 }
1161
1162 STATIC U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1163  U32    len = 0;
1164  svtype t   = SvTYPE(sv);
1165
1166  if (t < SVt_PVAV) {
1167   len = vmg_sv_len(sv);
1168  } else if (t == SVt_PVAV) {
1169   len = (U32) av_len((AV *) sv);
1170  }
1171
1172  return len;
1173 }
1174
1175 /* ... clear magic ......................................................... */
1176
1177 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1178  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1179
1180  return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
1181 }
1182
1183 #define vmg_svt_clear_noop vmg_svt_default_noop
1184
1185 /* ... free magic .......................................................... */
1186
1187 STATIC int vmg_svt_free_cleanup(pTHX_ void *ud) {
1188  SV    *sv = VOID2(SV *, ud);
1189  MAGIC *mg;
1190
1191  /* We are about to croak() while sv is being destroyed. Try to clean up
1192   * things a bit. */
1193  mg = SvMAGIC(sv);
1194  SvREFCNT_dec((SV *) mg->mg_ptr);
1195  /* mg->mg_obj may not be refcounted if the data constructor returned the
1196   * variable itself. */
1197  if (mg->mg_flags & MGf_REFCOUNTED)
1198   SvREFCNT_dec(mg->mg_obj);
1199  SvMAGIC_set(sv, mg->mg_moremagic);
1200  Safefree(mg);
1201  mg_magical(sv);
1202  SvREFCNT_dec(sv);
1203
1204  /* After that, propagate the error upwards. */
1205  return 1;
1206 }
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, vmg_svt_free_cleanup, 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