Magic.xs

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