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