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