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