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