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