Magic.xs

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