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)
  53 #  define VMG_MULTIPLICITY 1
  54 # else
  55 #  define VMG_MULTIPLICITY 0
  56 # endif
  57 #endif
  58 #if VMG_MULTIPLICITY
  59 # ifndef PERL_IMPLICIT_CONTEXT
  60 #  error MULTIPLICITY builds must set PERL_IMPLICIT_CONTEXT
  61 # endif
  62 #endif
  63
  64 #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))
  65 # ifndef VMG_THREADSAFE
  66 #  define VMG_THREADSAFE 1
  67 # endif
  68 # ifndef MY_CXT_CLONE
  69 #  define MY_CXT_CLONE \
  70     dMY_CXT_SV;                                                      \
  71     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
  72     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
  73     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
  74 # endif
  75 #else
  76 # undef  VMG_THREADSAFE
  77 # define VMG_THREADSAFE 0
  78 # undef  dMY_CXT
  79 # define dMY_CXT      dNOOP
  80 # undef  MY_CXT
  81 # define MY_CXT       vmg_globaldata
  82 # undef  START_MY_CXT
  83 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
  84 # undef  MY_CXT_INIT
  85 # define MY_CXT_INIT  NOOP
  86 # undef  MY_CXT_CLONE
  87 # define MY_CXT_CLONE NOOP
  88 #endif
  89
  90 #if VMG_THREADSAFE
  91 # define VMG_LOCK(M)   MUTEX_LOCK(M)
  92 # define VMG_UNLOCK(M) MUTEX_UNLOCK(M)
  93 #else
  94 # define VMG_LOCK(M)
  95 # define VMG_UNLOCK(M)
  96 #endif
  97
  98 /* --- Compatibility ------------------------------------------------------- */
  99
 100 #ifndef Newx
 101 # define Newx(v, n, c) New(0, v, n, c)
 102 #endif
 103
 104 #ifndef SvMAGIC_set
 105 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
 106 #endif
 107
 108 #ifndef SvRV_const
 109 # define SvRV_const(sv) SvRV((SV *) sv)
 110 #endif
 111
 112 #ifndef SvREFCNT_inc_simple_void
 113 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
 114 #endif
 115
 116 #ifndef mPUSHu
 117 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
 118 #endif
 119
 120 #ifndef PERL_MAGIC_ext
 121 # define PERL_MAGIC_ext '~'
 122 #endif
 123
 124 #ifndef PERL_MAGIC_tied
 125 # define PERL_MAGIC_tied 'P'
 126 #endif
 127
 128 #ifndef MGf_LOCAL
 129 # define MGf_LOCAL 0
 130 #endif
 131
 132 #ifndef IN_PERL_COMPILETIME
 133 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
 134 #endif
 135
 136 #ifdef DEBUGGING
 137 # define VMG_ASSERT(C) assert(C)
 138 #else
 139 # define VMG_ASSERT(C)
 140 #endif
 141
 142 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but we only
 143  * enable them on 5.10 */
 144 #if VMG_HAS_PERL(5, 10, 0)
 145 # define VMG_UVAR 1
 146 #else
 147 # define VMG_UVAR 0
 148 #endif
 149
 150 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969) || VMG_HAS_PERL(5, 12, 0)
 151 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
 152 #else
 153 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
 154 #endif
 155
 156 #if VMG_HAS_PERL(5, 17, 4)
 157 # define VMG_COMPAT_SCALAR_NOLEN 1
 158 #else
 159 # define VMG_COMPAT_SCALAR_NOLEN 0
 160 #endif
 161
 162 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
 163  * reverted to dev-5.11 as 9cdcb38b */
 164 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
 165 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
 166 #  if VMG_HAS_PERL(5, 11, 0)
 167 #   define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
 168 #  else
 169 #   define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
 170 #  endif
 171 # endif
 172 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
 173 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
 174 # endif
 175 #else
 176 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
 177 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
 178 # endif
 179 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
 180 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
 181 # endif
 182 #endif
 183
 184 /* Applied to dev-5.11 as 34908 */
 185 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908) || VMG_HAS_PERL(5, 12, 0)
 186 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
 187 #else
 188 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
 189 #endif
 190
 191 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
 192 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
 193 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
 194 #else
 195 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
 196 #endif
 197
 198 #if VMG_HAS_PERL(5, 11, 0)
 199 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 1
 200 #else
 201 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 0
 202 #endif
 203
 204 #if VMG_HAS_PERL(5, 17, 0)
 205 # define VMG_COMPAT_CODE_COPY_CLONE 1
 206 #else
 207 # define VMG_COMPAT_CODE_COPY_CLONE 0
 208 #endif
 209
 210 #if VMG_HAS_PERL(5, 13, 2)
 211 # define VMG_COMPAT_GLOB_GET 1
 212 #else
 213 # define VMG_COMPAT_GLOB_GET 0
 214 #endif
 215
 216 #define VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE (VMG_HAS_PERL(5, 10, 0) && !VMG_HAS_PERL(5, 10, 1))
 217
 218 /* NewOp() isn't public in perl 5.8.0. */
 219 #define VMG_RESET_RMG_NEEDS_TRAMPOLINE (VMG_UVAR && (VMG_THREADSAFE || !VMG_HAS_PERL(5, 8, 1)))
 220
 221 /* ... Bug-free mg_magical ................................................. */
 222
 223 /* See the discussion at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html */
 224
 225 #if VMG_HAS_PERL(5, 11, 3)
 226
 227 #define vmg_mg_magical(S) mg_magical(S)
 228
 229 #else
 230
 231 static void vmg_mg_magical(SV *sv) {
 232  const MAGIC *mg;
 233
 234  SvMAGICAL_off(sv);
 235  if ((mg = SvMAGIC(sv))) {
 236   do {
 237    const MGVTBL* const vtbl = mg->mg_virtual;
 238    if (vtbl) {
 239     if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
 240      SvGMAGICAL_on(sv);
 241     if (vtbl->svt_set)
 242      SvSMAGICAL_on(sv);
 243     if (vtbl->svt_clear)
 244      SvRMAGICAL_on(sv);
 245    }
 246   } while ((mg = mg->mg_moremagic));
 247   if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
 248    SvRMAGICAL_on(sv);
 249  }
 250 }
 251
 252 #endif
 253
 254 /* --- Trampoline ops ------------------------------------------------------ */
 255
 256 #define VMG_NEEDS_TRAMPOLINE VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE || VMG_RESET_RMG_NEEDS_TRAMPOLINE
 257
 258 #if VMG_NEEDS_TRAMPOLINE
 259
 260 typedef struct {
 261  OP   temp;
 262  SVOP target;
 263 } vmg_trampoline;
 264
 265 static void vmg_trampoline_init(vmg_trampoline *t, OP *(*cb)(pTHX)) {
 266  t->temp.op_type    = OP_STUB;
 267  t->temp.op_ppaddr  = 0;
 268  t->temp.op_next    = (OP *) &t->target;
 269  t->temp.op_flags   = 0;
 270  t->temp.op_private = 0;
 271
 272  t->target.op_type    = OP_STUB;
 273  t->target.op_ppaddr  = cb;
 274  t->target.op_next    = NULL;
 275  t->target.op_flags   = 0;
 276  t->target.op_private = 0;
 277  t->target.op_sv      = NULL;
 278 }
 279
 280 static OP *vmg_trampoline_bump(pTHX_ vmg_trampoline *t, SV *sv, OP *o) {
 281 #define vmg_trampoline_bump(T, S, O) vmg_trampoline_bump(aTHX_ (T), (S), (O))
 282  t->temp         = *o;
 283  t->temp.op_next = (OP *) &t->target;
 284
 285  t->target.op_sv   = sv;
 286  t->target.op_next = o->op_next;
 287
 288  return &t->temp;
 289 }
 290
 291 #endif /* VMG_NEEDS_TRAMPOLINE */
 292
 293 /* --- Cleaner version of sv_magicext() ------------------------------------ */
 294
 295 static MAGIC *vmg_sv_magicext(pTHX_ SV *sv, SV *obj, const MGVTBL *vtbl, const void *ptr, I32 len) {
 296 #define vmg_sv_magicext(S, O, V, P, L) vmg_sv_magicext(aTHX_ (S), (O), (V), (P), (L))
 297  MAGIC *mg;
 298
 299  mg = sv_magicext(sv, obj, PERL_MAGIC_ext, vtbl, ptr, len);
 300  if (!mg)
 301   return NULL;
 302
 303  mg->mg_private = 0;
 304
 305  if (vtbl->svt_copy)
 306   mg->mg_flags |= MGf_COPY;
 307 #if MGf_DUP
 308  if (vtbl->svt_dup)
 309   mg->mg_flags |= MGf_DUP;
 310 #endif /* MGf_DUP */
 311 #if MGf_LOCAL
 312  if (vtbl->svt_local)
 313   mg->mg_flags |= MGf_LOCAL;
 314 #endif /* MGf_LOCAL */
 315
 316  if (mg->mg_flags & MGf_REFCOUNTED)
 317   SvREFCNT_dec(obj);
 318
 319  return mg;
 320 }
 321
 322 /* --- Safe version of call_sv() ------------------------------------------- */
 323
 324 static I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, int (*cleanup)(pTHX_ void *), void *ud) {
 325 #define vmg_call_sv(S, F, C, U) vmg_call_sv(aTHX_ (S), (F), (C), (U))
 326  I32 ret, cxix;
 327  PERL_CONTEXT saved_cx;
 328  SV *old_err = NULL;
 329
 330  if (SvTRUE(ERRSV)) {
 331   old_err = newSVsv(ERRSV);
 332   sv_setsv(ERRSV, &PL_sv_undef);
 333  }
 334
 335  cxix     = (cxstack_ix < cxstack_max) ? (cxstack_ix + 1) : Perl_cxinc(aTHX);
 336  /* The last popped context will be reused by call_sv(), but our callers may
 337   * still need its previous value. Back it up so that it isn't clobbered. */
 338  saved_cx = cxstack[cxix];
 339
 340  ret = call_sv(sv, flags | G_EVAL);
 341
 342  cxstack[cxix] = saved_cx;
 343
 344  if (SvTRUE(ERRSV)) {
 345   SvREFCNT_dec(old_err);
 346
 347   if (IN_PERL_COMPILETIME) {
 348    if (!PL_in_eval) {
 349     if (PL_errors)
 350      sv_catsv(PL_errors, ERRSV);
 351     else
 352      Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
 353     SvCUR_set(ERRSV, 0);
 354    }
 355 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
 356    if (PL_parser)
 357     ++PL_parser->error_count;
 358 #elif defined(PL_error_count)
 359    ++PL_error_count;
 360 #else
 361    ++PL_Ierror_count;
 362 #endif
 363   } else {
 364    if (!cleanup || cleanup(aTHX_ ud))
 365     croak(NULL);
 366   }
 367  } else {
 368   if (old_err) {
 369    sv_setsv(ERRSV, old_err);
 370    SvREFCNT_dec(old_err);
 371   }
 372  }
 373
 374  return ret;
 375 }
 376
 377 /* --- Stolen chunk of B --------------------------------------------------- */
 378
 379 typedef enum {
 380  OPc_NULL,
 381  OPc_BASEOP,
 382  OPc_UNOP,
 383  OPc_BINOP,
 384  OPc_LOGOP,
 385  OPc_LISTOP,
 386  OPc_PMOP,
 387  OPc_SVOP,
 388  OPc_PADOP,
 389  OPc_PVOP,
 390  OPc_LOOP,
 391  OPc_COP,
 392 #if VMG_HAS_PERL(5, 21, 5)
 393  OPc_METHOP,
 394 #endif
 395 #if VMG_HAS_PERL(5, 21, 7)
 396  OPc_UNOP_AUX,
 397 #endif
 398  OPc_MAX
 399 } opclass;
 400
 401 static const char *const vmg_opclassnames[] = {
 402  "B::NULL",
 403  "B::OP",
 404  "B::UNOP",
 405  "B::BINOP",
 406  "B::LOGOP",
 407  "B::LISTOP",
 408  "B::PMOP",
 409  "B::SVOP",
 410  "B::PADOP",
 411  "B::PVOP",
 412  "B::LOOP",
 413  "B::COP",
 414 #if VMG_HAS_PERL(5, 21, 5)
 415  "B::METHOP",
 416 #endif
 417 #if VMG_HAS_PERL(5, 21, 7)
 418  "B::UNOP_AUX",
 419 #endif
 420  NULL
 421 };
 422
 423 static opclass vmg_opclass(const OP *o) {
 424 #if 0
 425  if (!o)
 426   return OPc_NULL;
 427 #endif
 428
 429  if (o->op_type == 0) {
 430 #if VMG_HAS_PERL(5, 21, 7)
 431   if (o->op_targ == OP_NEXTSTATE || o->op_targ == OP_DBSTATE)
 432    return OPc_COP;
 433 #endif
 434   return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 435  }
 436
 437  if (o->op_type == OP_SASSIGN)
 438   return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
 439
 440  if (o->op_type == OP_AELEMFAST) {
 441 #if PERL_VERSION <= 14
 442   if (o->op_flags & OPf_SPECIAL)
 443    return OPc_BASEOP;
 444   else
 445 #endif
 446 #ifdef USE_ITHREADS
 447    return OPc_PADOP;
 448 #else
 449    return OPc_SVOP;
 450 #endif
 451  }
 452
 453 #ifdef USE_ITHREADS
 454  if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
 455   return OPc_PADOP;
 456 #endif
 457
 458  switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
 459   case OA_BASEOP:
 460    return OPc_BASEOP;
 461   case OA_UNOP:
 462    return OPc_UNOP;
 463   case OA_BINOP:
 464    return OPc_BINOP;
 465   case OA_LOGOP:
 466    return OPc_LOGOP;
 467   case OA_LISTOP:
 468    return OPc_LISTOP;
 469   case OA_PMOP:
 470    return OPc_PMOP;
 471   case OA_SVOP:
 472    return OPc_SVOP;
 473   case OA_PADOP:
 474    return OPc_PADOP;
 475   case OA_PVOP_OR_SVOP:
 476    return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
 477   case OA_LOOP:
 478    return OPc_LOOP;
 479   case OA_COP:
 480    return OPc_COP;
 481   case OA_BASEOP_OR_UNOP:
 482    return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 483   case OA_FILESTATOP:
 484    return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
 485 #ifdef USE_ITHREADS
 486            (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
 487 #else
 488            (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
 489 #endif
 490   case OA_LOOPEXOP:
 491    if (o->op_flags & OPf_STACKED)
 492     return OPc_UNOP;
 493    else if (o->op_flags & OPf_SPECIAL)
 494     return OPc_BASEOP;
 495    else
 496     return OPc_PVOP;
 497 #if VMG_HAS_PERL(5, 21, 5)
 498   case OA_METHOP:
 499    return OPc_METHOP;
 500 #endif
 501 #if VMG_HAS_PERL(5, 21, 7)
 502   case OA_UNOP_AUX:
 503    return OPc_UNOP_AUX;
 504 #endif
 505  }
 506
 507  return OPc_BASEOP;
 508 }
 509
 510 /* --- Error messages ------------------------------------------------------ */
 511
 512 static const char vmg_invalid_wiz[] = "Invalid wizard object";
 513 static const char vmg_wrongargnum[] = "Wrong number of arguments";
 514
 515 /* --- Context-safe global data -------------------------------------------- */
 516
 517 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 518
 519 typedef struct {
 520  HV             *b__op_stashes[OPc_MAX];
 521  I32             depth;
 522  MAGIC          *freed_tokens;
 523 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
 524  vmg_trampoline  propagate_errsv;
 525 #endif
 526 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
 527  vmg_trampoline  reset_rmg;
 528 #endif
 529 } my_cxt_t;
 530
 531 START_MY_CXT
 532
 533 /* --- <vmg_vtable> structure ---------------------------------------------- */
 534
 535 #if VMG_THREADSAFE
 536
 537 typedef struct {
 538  MGVTBL *vtbl;
 539  U32     refcount;
 540 } vmg_vtable;
 541
 542 static vmg_vtable *vmg_vtable_alloc(pTHX) {
 543 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
 544  vmg_vtable *t;
 545
 546  t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
 547
 548  t->vtbl     = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
 549  t->refcount = 1;
 550
 551  return t;
 552 }
 553
 554 #define vmg_vtable_vtbl(T) (T)->vtbl
 555
 556 static perl_mutex vmg_vtable_refcount_mutex;
 557
 558 static vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
 559 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
 560  VMG_LOCK(&vmg_vtable_refcount_mutex);
 561  ++t->refcount;
 562  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
 563
 564  return t;
 565 }
 566
 567 static void vmg_vtable_free(pTHX_ vmg_vtable *t) {
 568 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
 569  U32 refcount;
 570
 571  VMG_LOCK(&vmg_vtable_refcount_mutex);
 572  refcount = --t->refcount;
 573  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
 574
 575  if (!refcount) {
 576   PerlMemShared_free(t->vtbl);
 577   PerlMemShared_free(t);
 578  }
 579 }
 580
 581 #else /* VMG_THREADSAFE */
 582
 583 typedef MGVTBL vmg_vtable;
 584
 585 static vmg_vtable *vmg_vtable_alloc(pTHX) {
 586 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
 587  vmg_vtable *t;
 588
 589  Newx(t, 1, vmg_vtable);
 590
 591  return t;
 592 }
 593
 594 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
 595
 596 #define vmg_vtable_free(T) Safefree(T)
 597
 598 #endif /* !VMG_THREADSAFE */
 599
 600 /* --- <vmg_wizard> structure ---------------------------------------------- */
 601
 602 typedef struct {
 603  vmg_vtable *vtable;
 604
 605  U8 opinfo;
 606  U8 uvar;
 607
 608  SV *cb_data;
 609  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
 610  SV *cb_copy;
 611  SV *cb_dup;
 612 #if MGf_LOCAL
 613  SV *cb_local;
 614 #endif /* MGf_LOCAL */
 615 #if VMG_UVAR
 616  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
 617 #endif /* VMG_UVAR */
 618 } vmg_wizard;
 619
 620 static void vmg_op_info_init(pTHX_ unsigned int opinfo);
 621
 622 static vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
 623 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
 624  vmg_wizard *w;
 625
 626  Newx(w, 1, vmg_wizard);
 627
 628  w->uvar   = 0;
 629  w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
 630  if (w->opinfo)
 631   vmg_op_info_init(aTHX_ w->opinfo);
 632
 633  w->vtable = vmg_vtable_alloc();
 634
 635  return w;
 636 }
 637
 638 static void vmg_wizard_free(pTHX_ vmg_wizard *w) {
 639 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
 640  if (!w)
 641   return;
 642
 643  /* During global destruction, any of the callbacks may already have been
 644   * freed, so we can't rely on still being able to access them. */
 645  if (!PL_dirty) {
 646   SvREFCNT_dec(w->cb_data);
 647   SvREFCNT_dec(w->cb_get);
 648   SvREFCNT_dec(w->cb_set);
 649   SvREFCNT_dec(w->cb_len);
 650   SvREFCNT_dec(w->cb_clear);
 651   SvREFCNT_dec(w->cb_free);
 652   SvREFCNT_dec(w->cb_copy);
 653 #if 0
 654   SvREFCNT_dec(w->cb_dup);
 655 #endif
 656 #if MGf_LOCAL
 657   SvREFCNT_dec(w->cb_local);
 658 #endif /* MGf_LOCAL */
 659 #if VMG_UVAR
 660   SvREFCNT_dec(w->cb_fetch);
 661   SvREFCNT_dec(w->cb_store);
 662   SvREFCNT_dec(w->cb_exists);
 663   SvREFCNT_dec(w->cb_delete);
 664 #endif /* VMG_UVAR */
 665  }
 666
 667  /* PerlMemShared_free() and Safefree() are still fine during global
 668   * destruction though. */
 669  vmg_vtable_free(w->vtable);
 670  Safefree(w);
 671
 672  return;
 673 }
 674
 675 #if VMG_THREADSAFE
 676
 677 #define VMG_CLONE_CB(N) \
 678  z->cb_ ## N = (w->cb_ ## N) ? SvREFCNT_inc(sv_dup(w->cb_ ## N, params)) \
 679                              : NULL;
 680
 681 static const vmg_wizard *vmg_wizard_dup(pTHX_ const vmg_wizard *w, CLONE_PARAMS *params) {
 682 #define vmg_wizard_dup(W, P) vmg_wizard_dup(aTHX_ (W), (P))
 683  vmg_wizard *z;
 684
 685  if (!w)
 686   return NULL;
 687
 688  Newx(z, 1, vmg_wizard);
 689
 690  z->vtable = vmg_vtable_dup(w->vtable);
 691  z->uvar   = w->uvar;
 692  z->opinfo = w->opinfo;
 693
 694  VMG_CLONE_CB(data);
 695  VMG_CLONE_CB(get);
 696  VMG_CLONE_CB(set);
 697  VMG_CLONE_CB(len);
 698  VMG_CLONE_CB(clear);
 699  VMG_CLONE_CB(free);
 700  VMG_CLONE_CB(copy);
 701  VMG_CLONE_CB(dup);
 702 #if MGf_LOCAL
 703  VMG_CLONE_CB(local);
 704 #endif /* MGf_LOCAL */
 705 #if VMG_UVAR
 706  VMG_CLONE_CB(fetch);
 707  VMG_CLONE_CB(store);
 708  VMG_CLONE_CB(exists);
 709  VMG_CLONE_CB(delete);
 710 #endif /* VMG_UVAR */
 711
 712  return z;
 713 }
 714
 715 #endif /* VMG_THREADSAFE */
 716
 717 #define vmg_wizard_id(W) PTR2IV(vmg_vtable_vtbl((W)->vtable))
 718
 719 /* --- Wizard SV objects --------------------------------------------------- */
 720
 721 static int vmg_wizard_sv_free(pTHX_ SV *sv, MAGIC *mg) {
 722  vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
 723
 724  return 0;
 725 }
 726
 727 #if VMG_THREADSAFE
 728
 729 static int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
 730  mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
 731
 732  return 0;
 733 }
 734
 735 #endif /* VMG_THREADSAFE */
 736
 737 static MGVTBL vmg_wizard_sv_vtbl = {
 738  NULL,               /* get */
 739  NULL,               /* set */
 740  NULL,               /* len */
 741  NULL,               /* clear */
 742  vmg_wizard_sv_free, /* free */
 743  NULL,               /* copy */
 744 #if VMG_THREADSAFE
 745  vmg_wizard_sv_dup,  /* dup */
 746 #else
 747  NULL,               /* dup */
 748 #endif
 749 #if MGf_LOCAL
 750  NULL,               /* local */
 751 #endif /* MGf_LOCAL */
 752 };
 753
 754 static SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
 755 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
 756  SV *wiz;
 757
 758 #if VMG_THREADSAFE
 759  wiz = newSV(0);
 760 #else
 761  wiz = newSViv(PTR2IV(w));
 762 #endif
 763
 764  vmg_sv_magicext(wiz, NULL, &vmg_wizard_sv_vtbl, w, 0);
 765
 766  SvREADONLY_on(wiz);
 767
 768  return wiz;
 769 }
 770
 771 #if VMG_THREADSAFE
 772
 773 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
 774
 775 static const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
 776  MAGIC *mg;
 777
 778  for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
 779   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
 780    return (const vmg_wizard *) mg->mg_ptr;
 781  }
 782
 783  return NULL;
 784 }
 785
 786 #else /* VMG_THREADSAFE */
 787
 788 #define vmg_sv_has_wizard_type(S) SvIOK(S)
 789
 790 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
 791
 792 #endif /* !VMG_THREADSAFE */
 793
 794 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
 795
 796 static const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
 797  if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
 798   SV *sv = (SV *) mg->mg_ptr;
 799
 800   if (vmg_sv_has_wizard_type(sv))
 801    return vmg_wizard_from_sv_nocheck(sv);
 802  }
 803
 804  return NULL;
 805 }
 806
 807 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
 808
 809 /* --- User-level functions implementation --------------------------------- */
 810
 811 static const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
 812  const MAGIC *mg;
 813  IV wid;
 814
 815  if (SvTYPE(sv) < SVt_PVMG)
 816   return NULL;
 817
 818  wid = vmg_wizard_id(w);
 819
 820  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 821   const vmg_wizard *z = vmg_wizard_from_mg(mg);
 822
 823   if (z && vmg_wizard_id(z) == wid)
 824    return mg;
 825  }
 826
 827  return NULL;
 828 }
 829
 830 /* ... Construct private data .............................................. */
 831
 832 static SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
 833 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
 834  I32 i;
 835  SV *nsv;
 836
 837  dSP;
 838
 839  ENTER;
 840  SAVETMPS;
 841
 842  PUSHMARK(SP);
 843  EXTEND(SP, items + 1);
 844  PUSHs(sv_2mortal(newRV_inc(sv)));
 845  for (i = 0; i < items; ++i)
 846   PUSHs(args[i]);
 847  PUTBACK;
 848
 849  vmg_call_sv(ctor, G_SCALAR, 0, NULL);
 850
 851  SPAGAIN;
 852  nsv = POPs;
 853 #if VMG_HAS_PERL(5, 8, 3)
 854  SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
 855 #else
 856  nsv = sv_newref(nsv);          /* Workaround some bug in SvREFCNT_inc() */
 857 #endif
 858  PUTBACK;
 859
 860  FREETMPS;
 861  LEAVE;
 862
 863  return nsv;
 864 }
 865
 866 static SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
 867 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
 868  const MAGIC *mg = vmg_find(sv, w);
 869
 870  return mg ? mg->mg_obj : NULL;
 871 }
 872
 873 /* ... Magic cast/dispell .................................................. */
 874
 875 #if VMG_UVAR
 876
 877 static I32 vmg_svt_val(pTHX_ IV, SV *);
 878
 879 typedef struct {
 880  struct ufuncs new_uf;
 881  struct ufuncs old_uf;
 882 } vmg_uvar_ud;
 883
 884 #endif /* VMG_UVAR */
 885
 886 static void vmg_mg_del(pTHX_ SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 887 #define vmg_mg_del(S, P, M, N) vmg_mg_del(aTHX_ (S), (P), (M), (N))
 888  dMY_CXT;
 889
 890  if (prevmagic)
 891   prevmagic->mg_moremagic = moremagic;
 892  else
 893   SvMAGIC_set(sv, moremagic);
 894
 895  /* Destroy private data */
 896 #if VMG_UVAR
 897  if (mg->mg_type == PERL_MAGIC_uvar) {
 898   Safefree(mg->mg_ptr);
 899  } else {
 900 #endif /* VMG_UVAR */
 901   if (mg->mg_obj != sv) {
 902    SvREFCNT_dec(mg->mg_obj);
 903    mg->mg_obj = NULL;
 904   }
 905   /* Unreference the wizard */
 906   SvREFCNT_dec((SV *) mg->mg_ptr);
 907   mg->mg_ptr = NULL;
 908 #if VMG_UVAR
 909  }
 910 #endif /* VMG_UVAR */
 911
 912  if (MY_CXT.depth) {
 913   mg->mg_moremagic    = MY_CXT.freed_tokens;
 914   MY_CXT.freed_tokens = mg;
 915  } else {
 916   mg->mg_moremagic = NULL;
 917   Safefree(mg);
 918  }
 919 }
 920
 921 static int vmg_magic_chain_free(pTHX_ MAGIC *mg, MAGIC *skip) {
 922 #define vmg_magic_chain_free(M, S) vmg_magic_chain_free(aTHX_ (M), (S))
 923  int skipped = 0;
 924
 925  while (mg) {
 926   MAGIC *moremagic = mg->mg_moremagic;
 927
 928   if (mg == skip)
 929    ++skipped;
 930   else
 931    Safefree(mg);
 932
 933   mg = moremagic;
 934  }
 935
 936  return skipped;
 937 }
 938
 939 static UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
 940 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
 941  MAGIC  *mg;
 942  MGVTBL *t;
 943  SV     *data;
 944  U32     oldgmg;
 945
 946  if (vmg_find(sv, w))
 947   return 1;
 948
 949  oldgmg = SvGMAGICAL(sv);
 950
 951  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
 952
 953  t  = vmg_vtable_vtbl(w->vtable);
 954  mg = vmg_sv_magicext(sv, data, t, wiz, HEf_SVKEY);
 955
 956  if (SvTYPE(sv) < SVt_PVHV)
 957   goto done;
 958
 959  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 960   * magic is actually never called for them. If the GMAGICAL flag was off before
 961   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 962   * now on, then this wizard has get magic. Hence we can work around the
 963   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 964   * has uvar callbacks, it will be turned back on later. */
 965  if (!oldgmg && SvGMAGICAL(sv))
 966   SvGMAGICAL_off(sv);
 967
 968 #if VMG_UVAR
 969  if (w->uvar) {
 970   MAGIC *prevmagic, *moremagic = NULL;
 971   vmg_uvar_ud ud;
 972
 973   ud.new_uf.uf_val   = vmg_svt_val;
 974   ud.new_uf.uf_set   = NULL;
 975   ud.new_uf.uf_index = 0;
 976   ud.old_uf.uf_val   = NULL;
 977   ud.old_uf.uf_set   = NULL;
 978   ud.old_uf.uf_index = 0;
 979
 980   /* One uvar magic in the chain is enough. */
 981   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 982    moremagic = mg->mg_moremagic;
 983    if (mg->mg_type == PERL_MAGIC_uvar)
 984     break;
 985   }
 986
 987   if (mg) { /* Found another uvar magic. */
 988    struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
 989    if (uf->uf_val == vmg_svt_val) {
 990     /* It's our uvar magic, nothing to do. oldgmg was true. */
 991     goto done;
 992    } else {
 993     /* It's another uvar magic, backup it and replace it by ours. */
 994     ud.old_uf = *uf;
 995     vmg_mg_del(sv, prevmagic, mg, moremagic);
 996    }
 997   }
 998
 999   sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
1000   vmg_mg_magical(sv);
1001   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
1002    * handled by our uvar callback. */
1003  }
1004 #endif /* VMG_UVAR */
1005
1006 done:
1007  return 1;
1008 }
1009
1010 static UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
1011 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
1012 #if VMG_UVAR
1013  U32 uvars = 0;
1014 #endif /* VMG_UVAR */
1015  MAGIC *mg, *prevmagic, *moremagic = NULL;
1016  IV wid = vmg_wizard_id(w);
1017
1018  if (SvTYPE(sv) < SVt_PVMG)
1019   return 0;
1020
1021  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
1022   const vmg_wizard *z;
1023
1024   moremagic = mg->mg_moremagic;
1025
1026   z = vmg_wizard_from_mg(mg);
1027   if (z) {
1028    IV zid = vmg_wizard_id(z);
1029
1030 #if VMG_UVAR
1031    if (zid == wid) {
1032     /* If the current has no uvar, short-circuit uvar deletion. */
1033     uvars = z->uvar ? (uvars + 1) : 0;
1034     break;
1035    } else if (z->uvar) {
1036     ++uvars;
1037     /* We can't break here since we need to find the ext magic to delete. */
1038    }
1039 #else /* VMG_UVAR */
1040    if (zid == wid)
1041     break;
1042 #endif /* !VMG_UVAR */
1043   }
1044  }
1045  if (!mg)
1046   return 0;
1047
1048  vmg_mg_del(sv, prevmagic, mg, moremagic);
1049
1050 #if VMG_UVAR
1051  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
1052   /* mg was the first ext magic in the chain that had uvar */
1053
1054   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
1055    const vmg_wizard *z = vmg_wizard_from_mg(mg);
1056
1057    if (z && z->uvar) {
1058     ++uvars;
1059     break;
1060    }
1061   }
1062
1063   if (uvars == 1) {
1064    vmg_uvar_ud *ud;
1065
1066    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
1067     moremagic = mg->mg_moremagic;
1068     if (mg->mg_type == PERL_MAGIC_uvar)
1069      break;
1070    }
1071
1072    ud = (vmg_uvar_ud *) mg->mg_ptr;
1073    if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
1074     /* Revert the original uvar magic. */
1075     struct ufuncs *uf;
1076     Newx(uf, 1, struct ufuncs);
1077     *uf = ud->old_uf;
1078     Safefree(ud);
1079     mg->mg_ptr = (char *) uf;
1080     mg->mg_len = sizeof(*uf);
1081    } else {
1082     /* Remove the uvar magic. */
1083     vmg_mg_del(sv, prevmagic, mg, moremagic);
1084    }
1085   }
1086  }
1087 #endif /* VMG_UVAR */
1088
1089  vmg_mg_magical(sv);
1090
1091  return 1;
1092 }
1093
1094 /* ... OP info ............................................................. */
1095
1096 #define VMG_OP_INFO_NAME   1
1097 #define VMG_OP_INFO_OBJECT 2
1098
1099 #if VMG_THREADSAFE
1100 static perl_mutex vmg_op_name_init_mutex;
1101 #endif
1102
1103 static U32           vmg_op_name_init      = 0;
1104 static unsigned char vmg_op_name_len[MAXO] = { 0 };
1105
1106 static void vmg_op_info_init(pTHX_ unsigned int opinfo) {
1107 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
1108  switch (opinfo) {
1109   case VMG_OP_INFO_NAME:
1110    VMG_LOCK(&vmg_op_name_init_mutex);
1111    if (!vmg_op_name_init) {
1112     OPCODE t;
1113     for (t = 0; t < OP_max; ++t)
1114      vmg_op_name_len[t] = strlen(PL_op_name[t]);
1115     vmg_op_name_init = 1;
1116    }
1117    VMG_UNLOCK(&vmg_op_name_init_mutex);
1118    break;
1119   case VMG_OP_INFO_OBJECT: {
1120    dMY_CXT;
1121    if (!MY_CXT.b__op_stashes[0]) {
1122     int c;
1123     require_pv("B.pm");
1124     for (c = OPc_NULL; c < OPc_MAX; ++c)
1125      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1126    }
1127    break;
1128   }
1129   default:
1130    break;
1131  }
1132 }
1133
1134 static SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1135 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1136  if (!PL_op)
1137   return &PL_sv_undef;
1138
1139  switch (opinfo) {
1140   case VMG_OP_INFO_NAME: {
1141    OPCODE t = PL_op->op_type;
1142    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1143   }
1144   case VMG_OP_INFO_OBJECT: {
1145    dMY_CXT;
1146    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1147                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1148   }
1149   default:
1150    break;
1151  }
1152
1153  return &PL_sv_undef;
1154 }
1155
1156 /* --- svt callbacks ------------------------------------------------------- */
1157
1158 #define VMG_CB_CALL_ARGS_MASK  15
1159 #define VMG_CB_CALL_ARGS_SHIFT 4
1160 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT) /* 1|2 */
1161 #define VMG_CB_CALL_GUARD      4
1162
1163 static int vmg_dispell_guard_oncroak(pTHX_ void *ud) {
1164  dMY_CXT;
1165
1166  MY_CXT.depth--;
1167
1168  /* If we're at the upmost magic call and we're about to die, we can just free
1169   * the tokens right now, since we will jump past the problematic part of our
1170   * caller. */
1171  if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1172   vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1173   MY_CXT.freed_tokens = NULL;
1174  }
1175
1176  return 1;
1177 }
1178
1179 static int vmg_dispell_guard_free(pTHX_ SV *sv, MAGIC *mg) {
1180  vmg_magic_chain_free((MAGIC *) mg->mg_ptr, NULL);
1181
1182  return 0;
1183 }
1184
1185 #if VMG_THREADSAFE
1186
1187 static int vmg_dispell_guard_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
1188  /* The freed magic tokens aren't cloned by perl because it cannot reach them
1189   * (they have been detached from their parent SV when they were enqueued).
1190   * Hence there's nothing to purge in the new thread. */
1191  mg->mg_ptr = NULL;
1192
1193  return 0;
1194 }
1195
1196 #endif /* VMG_THREADSAFE */
1197
1198 static MGVTBL vmg_dispell_guard_vtbl = {
1199  NULL,                   /* get */
1200  NULL,                   /* set */
1201  NULL,                   /* len */
1202  NULL,                   /* clear */
1203  vmg_dispell_guard_free, /* free */
1204  NULL,                   /* copy */
1205 #if VMG_THREADSAFE
1206  vmg_dispell_guard_dup,  /* dup */
1207 #else
1208  NULL,                   /* dup */
1209 #endif
1210 #if MGf_LOCAL
1211  NULL,                   /* local */
1212 #endif /* MGf_LOCAL */
1213 };
1214
1215 static SV *vmg_dispell_guard_new(pTHX_ MAGIC *root) {
1216 #define vmg_dispell_guard_new(R) vmg_dispell_guard_new(aTHX_ (R))
1217  SV *guard;
1218
1219  guard = sv_newmortal();
1220  vmg_sv_magicext(guard, NULL, &vmg_dispell_guard_vtbl, root, 0);
1221
1222  return guard;
1223 }
1224
1225 static int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1226  va_list ap;
1227  int ret = 0;
1228  unsigned int i, args, opinfo;
1229  MAGIC **chain = NULL;
1230  SV *svr;
1231
1232  dSP;
1233
1234  args    = flags & VMG_CB_CALL_ARGS_MASK;
1235  flags >>= VMG_CB_CALL_ARGS_SHIFT;
1236  opinfo  = flags & VMG_CB_CALL_OPINFO;
1237
1238  ENTER;
1239  SAVETMPS;
1240
1241  PUSHMARK(SP);
1242  EXTEND(SP, args + 1);
1243  PUSHs(sv_2mortal(newRV_inc(sv)));
1244  va_start(ap, sv);
1245  for (i = 0; i < args; ++i) {
1246   SV *sva = va_arg(ap, SV *);
1247   PUSHs(sva ? sva : &PL_sv_undef);
1248  }
1249  va_end(ap);
1250  if (opinfo)
1251   XPUSHs(vmg_op_info(opinfo));
1252  PUTBACK;
1253
1254  if (flags & VMG_CB_CALL_GUARD) {
1255   dMY_CXT;
1256   MY_CXT.depth++;
1257   vmg_call_sv(cb, G_SCALAR, vmg_dispell_guard_oncroak, NULL);
1258   MY_CXT.depth--;
1259   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens)
1260    chain = &MY_CXT.freed_tokens;
1261  } else {
1262   vmg_call_sv(cb, G_SCALAR, 0, NULL);
1263  }
1264
1265  SPAGAIN;
1266  svr = POPs;
1267  if (SvOK(svr))
1268   ret = (int) SvIV(svr);
1269  if (SvROK(svr))
1270   SvREFCNT_inc(svr);
1271  else
1272   svr = NULL;
1273  PUTBACK;
1274
1275  FREETMPS;
1276  LEAVE;
1277
1278  if (svr && !SvTEMP(svr))
1279   sv_2mortal(svr);
1280
1281  if (chain) {
1282   vmg_dispell_guard_new(*chain);
1283   *chain = NULL;
1284  }
1285
1286  return ret;
1287 }
1288
1289 #define VMG_CB_FLAGS(OI, A) \
1290         ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1291
1292 #define vmg_cb_call1(I, OI, S, A1) \
1293         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1294 #define vmg_cb_call2(I, OI, S, A1, A2) \
1295         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1296 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1297         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1298
1299 /* ... Default no-op magic callback ........................................ */
1300
1301 static int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1302  return 0;
1303 }
1304
1305 /* ... get magic ........................................................... */
1306
1307 static int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1308  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1309
1310  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1311 }
1312
1313 #define vmg_svt_get_noop vmg_svt_default_noop
1314
1315 /* ... set magic ........................................................... */
1316
1317 static int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1318  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1319
1320  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1321 }
1322
1323 #define vmg_svt_set_noop vmg_svt_default_noop
1324
1325 /* ... len magic ........................................................... */
1326
1327 static U32 vmg_sv_len(pTHX_ SV *sv) {
1328 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1329  STRLEN len;
1330 #if VMG_HAS_PERL(5, 9, 3)
1331  const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1332 #else
1333  U8 *s = SvPV(sv, len);
1334 #endif
1335
1336  return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1337 }
1338
1339 static U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1340  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1341  unsigned int opinfo = w->opinfo;
1342  U32 len, ret;
1343  SV *svr;
1344  svtype t = SvTYPE(sv);
1345
1346  dSP;
1347
1348  ENTER;
1349  SAVETMPS;
1350
1351  PUSHMARK(SP);
1352  EXTEND(SP, 3);
1353  PUSHs(sv_2mortal(newRV_inc(sv)));
1354  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1355  if (t < SVt_PVAV) {
1356   len = vmg_sv_len(sv);
1357   mPUSHu(len);
1358  } else if (t == SVt_PVAV) {
1359   len = av_len((AV *) sv) + 1;
1360   mPUSHu(len);
1361  } else {
1362   len = 0;
1363   PUSHs(&PL_sv_undef);
1364  }
1365  if (opinfo)
1366   XPUSHs(vmg_op_info(opinfo));
1367  PUTBACK;
1368
1369  vmg_call_sv(w->cb_len, G_SCALAR, 0, NULL);
1370
1371  SPAGAIN;
1372  svr = POPs;
1373  ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1374  if (t == SVt_PVAV)
1375   --ret;
1376  PUTBACK;
1377
1378  FREETMPS;
1379  LEAVE;
1380
1381  return ret;
1382 }
1383
1384 static U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1385  U32    len = 0;
1386  svtype t   = SvTYPE(sv);
1387
1388  if (t < SVt_PVAV) {
1389   len = vmg_sv_len(sv);
1390  } else if (t == SVt_PVAV) {
1391   len = (U32) av_len((AV *) sv);
1392  }
1393
1394  return len;
1395 }
1396
1397 /* ... clear magic ......................................................... */
1398
1399 static int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1400  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1401  unsigned int flags  = w->opinfo;
1402
1403 #if !VMG_HAS_PERL(5, 12, 0)
1404  flags |= VMG_CB_CALL_GUARD;
1405 #endif
1406
1407  return vmg_cb_call1(w->cb_clear, flags, sv, mg->mg_obj);
1408 }
1409
1410 #define vmg_svt_clear_noop vmg_svt_default_noop
1411
1412 /* ... free magic .......................................................... */
1413
1414 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1415
1416 static OP *vmg_pp_propagate_errsv(pTHX) {
1417  SVOP *o = cSVOPx(PL_op);
1418
1419  if (o->op_sv) {
1420   sv_setsv(ERRSV, o->op_sv);
1421   SvREFCNT_dec(o->op_sv);
1422   o->op_sv = NULL;
1423  }
1424
1425  return NORMAL;
1426 }
1427
1428 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1429
1430 static int vmg_propagate_errsv_free(pTHX_ SV *sv, MAGIC *mg) {
1431  if (mg->mg_obj)
1432   sv_setsv(ERRSV, mg->mg_obj);
1433
1434  return 0;
1435 }
1436
1437 /* perl is already kind enough to handle the cloning of the mg_obj member,
1438    hence we don't need to define a dup magic callback. */
1439
1440 static MGVTBL vmg_propagate_errsv_vtbl = {
1441  0,                        /* get */
1442  0,                        /* set */
1443  0,                        /* len */
1444  0,                        /* clear */
1445  vmg_propagate_errsv_free, /* free */
1446  0,                        /* copy */
1447  0,                        /* dup */
1448 #if MGf_LOCAL
1449  0,                        /* local */
1450 #endif /* MGf_LOCAL */
1451 };
1452
1453 typedef struct {
1454  SV  *sv;
1455  int  in_eval;
1456  I32  base;
1457 } vmg_svt_free_cleanup_ud;
1458
1459 static int vmg_svt_free_cleanup(pTHX_ void *ud_) {
1460  vmg_svt_free_cleanup_ud *ud = VOID2(vmg_svt_free_cleanup_ud *, ud_);
1461
1462  if (ud->in_eval) {
1463   U32 optype = PL_op ? PL_op->op_type : OP_NULL;
1464
1465   if (optype == OP_LEAVETRY || optype == OP_LEAVEEVAL) {
1466    SV *errsv = newSVsv(ERRSV);
1467
1468    FREETMPS;
1469    LEAVE_SCOPE(ud->base);
1470
1471 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1472    if (optype == OP_LEAVETRY) {
1473     dMY_CXT;
1474     PL_op = vmg_trampoline_bump(&MY_CXT.propagate_errsv, errsv, PL_op);
1475    } else if (optype == OP_LEAVEEVAL) {
1476     SV *guard = sv_newmortal();
1477     vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1478    }
1479 #else /* !VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1480 # if !VMG_HAS_PERL(5, 8, 9)
1481    {
1482     SV *guard = sv_newmortal();
1483     vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1484    }
1485 # else
1486    vmg_sv_magicext(ERRSV, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1487 # endif
1488 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1489
1490    SAVETMPS;
1491   }
1492
1493   /* Don't propagate */
1494   return 0;
1495  } else {
1496   SV    *sv = ud->sv;
1497   MAGIC *mg;
1498
1499   /* We are about to croak() while sv is being destroyed. Try to clean up
1500    * things a bit. */
1501   mg = SvMAGIC(sv);
1502   if (mg) {
1503    vmg_mg_del(sv, NULL, mg, mg->mg_moremagic);
1504    mg_magical(sv);
1505   }
1506   SvREFCNT_dec(sv);
1507
1508   vmg_dispell_guard_oncroak(aTHX_ NULL);
1509
1510   /* After that, propagate the error upwards. */
1511   return 1;
1512  }
1513 }
1514
1515 static int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1516  vmg_svt_free_cleanup_ud ud;
1517  const vmg_wizard *w;
1518  int ret = 0;
1519  SV *svr;
1520
1521  dSP;
1522
1523  /* During global destruction, we cannot be sure that the wizard and its free
1524   * callback are still alive. */
1525  if (PL_dirty)
1526   return 0;
1527
1528  w = vmg_wizard_from_mg_nocheck(mg);
1529
1530  /* So that it survives the temp cleanup below */
1531  SvREFCNT_inc_simple_void(sv);
1532
1533 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1534  /* The previous magic tokens were freed but the magic chain wasn't updated, so
1535   * if you access the sv from the callback the old deleted magics will trigger
1536   * and cause memory misreads. Change 32686 solved it that way : */
1537  SvMAGIC_set(sv, mg);
1538 #endif
1539
1540  ud.sv = sv;
1541  if (cxstack_ix < cxstack_max) {
1542   ud.in_eval = (CxTYPE(cxstack + cxstack_ix + 1) == CXt_EVAL);
1543   ud.base    = ud.in_eval ? PL_scopestack[PL_scopestack_ix] : 0;
1544  } else {
1545   ud.in_eval = 0;
1546   ud.base    = 0;
1547  }
1548
1549  ENTER;
1550  SAVETMPS;
1551
1552  PUSHMARK(SP);
1553  EXTEND(SP, 2);
1554  PUSHs(sv_2mortal(newRV_inc(sv)));
1555  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1556  if (w->opinfo)
1557   XPUSHs(vmg_op_info(w->opinfo));
1558  PUTBACK;
1559
1560  {
1561   dMY_CXT;
1562   MY_CXT.depth++;
1563   vmg_call_sv(w->cb_free, G_SCALAR, vmg_svt_free_cleanup, &ud);
1564   MY_CXT.depth--;
1565   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1566    /* Free all the tokens in the chain but the current one (if it's present).
1567     * It will be taken care of by our caller, Perl_mg_free(). */
1568    vmg_magic_chain_free(MY_CXT.freed_tokens, mg);
1569    MY_CXT.freed_tokens = NULL;
1570   }
1571  }
1572
1573  SPAGAIN;
1574  svr = POPs;
1575  if (SvOK(svr))
1576   ret = (int) SvIV(svr);
1577  PUTBACK;
1578
1579  FREETMPS;
1580  LEAVE;
1581
1582  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1583   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1584  --SvREFCNT(sv);
1585
1586  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1587   * mg->mg_ptr reference count */
1588  return ret;
1589 }
1590
1591 #define vmg_svt_free_noop vmg_svt_default_noop
1592
1593 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1594 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1595 #else
1596 # define VMG_SVT_COPY_KEYLEN_TYPE int
1597 #endif
1598
1599 /* ... copy magic .......................................................... */
1600
1601 static int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1602  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1603  SV *keysv;
1604  int ret;
1605
1606  if (keylen == HEf_SVKEY) {
1607   keysv = (SV *) key;
1608  } else {
1609   keysv = newSVpvn(key, keylen);
1610  }
1611
1612  if (SvTYPE(sv) >= SVt_PVCV)
1613   nsv = sv_2mortal(newRV_inc(nsv));
1614
1615  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1616
1617  if (keylen != HEf_SVKEY) {
1618   SvREFCNT_dec(keysv);
1619  }
1620
1621  return ret;
1622 }
1623
1624 static int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1625  return 0;
1626 }
1627
1628 /* ... dup magic ........................................................... */
1629
1630 #if 0
1631 static int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1632  return 0;
1633 }
1634 #define vmg_svt_dup_noop vmg_svt_dup
1635 #endif
1636
1637 /* ... local magic ......................................................... */
1638
1639 #if MGf_LOCAL
1640
1641 static int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1642  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1643
1644  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1645 }
1646
1647 #define vmg_svt_local_noop vmg_svt_default_noop
1648
1649 #endif /* MGf_LOCAL */
1650
1651 /* ... uvar magic .......................................................... */
1652
1653 #if VMG_UVAR
1654
1655 static OP *vmg_pp_reset_rmg(pTHX) {
1656  SVOP *o = cSVOPx(PL_op);
1657
1658  SvRMAGICAL_on(o->op_sv);
1659  o->op_sv = NULL;
1660
1661  return NORMAL;
1662 }
1663
1664 static I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1665  vmg_uvar_ud *ud;
1666  MAGIC *mg, *umg, *moremagic;
1667  SV *key = NULL, *newkey = NULL;
1668  int tied = 0;
1669
1670  umg = mg_find(sv, PERL_MAGIC_uvar);
1671  /* umg can't be NULL or we wouldn't be there. */
1672  key = umg->mg_obj;
1673  ud  = (vmg_uvar_ud *) umg->mg_ptr;
1674
1675  if (ud->old_uf.uf_val)
1676   ud->old_uf.uf_val(aTHX_ action, sv);
1677  if (ud->old_uf.uf_set)
1678   ud->old_uf.uf_set(aTHX_ action, sv);
1679
1680  for (mg = SvMAGIC(sv); mg; mg = moremagic) {
1681   const vmg_wizard *w;
1682
1683   /* mg may be freed later by the uvar call, so we need to fetch the next
1684    * token before reaching that fateful point. */
1685   moremagic = mg->mg_moremagic;
1686
1687   switch (mg->mg_type) {
1688    case PERL_MAGIC_ext:
1689     break;
1690    case PERL_MAGIC_tied:
1691     ++tied;
1692     continue;
1693    default:
1694     continue;
1695   }
1696
1697   w = vmg_wizard_from_mg(mg);
1698   if (!w)
1699    continue;
1700
1701   switch (w->uvar) {
1702    case 0:
1703     continue;
1704    case 2:
1705     if (!newkey)
1706      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1707   }
1708
1709   switch (action
1710              & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1711    case 0:
1712     if (w->cb_fetch)
1713      vmg_cb_call2(w->cb_fetch, w->opinfo | VMG_CB_CALL_GUARD, sv,
1714                                mg->mg_obj, key);
1715     break;
1716    case HV_FETCH_ISSTORE:
1717    case HV_FETCH_LVALUE:
1718    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1719     if (w->cb_store)
1720      vmg_cb_call2(w->cb_store, w->opinfo | VMG_CB_CALL_GUARD, sv,
1721                                mg->mg_obj, key);
1722     break;
1723    case HV_FETCH_ISEXISTS:
1724     if (w->cb_exists)
1725      vmg_cb_call2(w->cb_exists, w->opinfo | VMG_CB_CALL_GUARD, sv,
1726                                 mg->mg_obj, key);
1727     break;
1728    case HV_DELETE:
1729     if (w->cb_delete)
1730      vmg_cb_call2(w->cb_delete, w->opinfo | VMG_CB_CALL_GUARD, sv,
1731                                 mg->mg_obj, key);
1732     break;
1733   }
1734  }
1735
1736  if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1737   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1738    * mistaken for a tied hash by the rest of hv_common. It will be reset by
1739    * the op_ppaddr of a new fake op injected between the current and the next
1740    * one. */
1741
1742 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1743
1744   dMY_CXT;
1745
1746   PL_op = vmg_trampoline_bump(&MY_CXT.reset_rmg, sv, PL_op);
1747
1748 #else /* !VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1749
1750   OP   *nop  = PL_op->op_next;
1751   SVOP *svop = NULL;
1752
1753   if (nop && nop->op_ppaddr == vmg_pp_reset_rmg) {
1754    svop = (SVOP *) nop;
1755   } else {
1756    NewOp(1101, svop, 1, SVOP);
1757    svop->op_type    = OP_STUB;
1758    svop->op_ppaddr  = vmg_pp_reset_rmg;
1759    svop->op_next    = nop;
1760    svop->op_flags   = 0;
1761    svop->op_private = 0;
1762
1763    PL_op->op_next = (OP *) svop;
1764   }
1765
1766   svop->op_sv = sv;
1767
1768 #endif /* VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1769
1770   SvRMAGICAL_off(sv);
1771  }
1772
1773  return 0;
1774 }
1775
1776 #endif /* VMG_UVAR */
1777
1778 /* --- Module setup/teardown ----------------------------------------------- */
1779
1780 #if VMG_THREADSAFE
1781
1782 static I32 vmg_loaded = 0;
1783
1784 /* We must use preexistent global mutexes or we will never be able to destroy
1785  * them. */
1786 # if VMG_HAS_PERL(5, 9, 3)
1787 #  define VMG_LOADED_LOCK   MUTEX_LOCK(&PL_my_ctx_mutex)
1788 #  define VMG_LOADED_UNLOCK MUTEX_UNLOCK(&PL_my_ctx_mutex)
1789 # else
1790 #  define VMG_LOADED_LOCK   OP_REFCNT_LOCK
1791 #  define VMG_LOADED_UNLOCK OP_REFCNT_UNLOCK
1792 # endif
1793
1794 static void vmg_global_teardown_late_locked(pTHX) {
1795 #define vmg_global_teardown_late_locked() vmg_global_teardown_late_locked(aTHX)
1796  MUTEX_DESTROY(&vmg_op_name_init_mutex);
1797  MUTEX_DESTROY(&vmg_vtable_refcount_mutex);
1798
1799  return;
1800 }
1801
1802 static int vmg_global_teardown_free(pTHX_ SV *sv, MAGIC *mg) {
1803  VMG_LOADED_LOCK;
1804
1805  if (vmg_loaded == 0)
1806   vmg_global_teardown_late_locked();
1807
1808  VMG_LOADED_UNLOCK;
1809
1810  return 0;
1811 }
1812
1813 static MGVTBL vmg_global_teardown_vtbl = {
1814  0,
1815  0,
1816  0,
1817  0,
1818  vmg_global_teardown_free
1819 #if MGf_COPY
1820  , 0
1821 #endif
1822 #if MGf_DUP
1823  , 0
1824 #endif
1825 #if MGf_LOCAL
1826  , 0
1827 #endif
1828 };
1829
1830 static signed char vmg_destruct_level(pTHX) {
1831 #define vmg_destruct_level() vmg_destruct_level(aTHX)
1832  signed char lvl;
1833
1834  lvl = PL_perl_destruct_level;
1835
1836 #ifdef DEBUGGING
1837  {
1838   const char *s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1839   if (s) {
1840    int i;
1841 #if VMG_HAS_PERL(5, 21, 3)
1842    if (strEQ(s, "-1")) {
1843     i = -1;
1844    } else {
1845 # if VMG_HAS_PERL(5, 21, 10)
1846     UV uv;
1847     if (Perl_grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
1848      i = (int) uv;
1849     else
1850      i = 0;
1851 # else /* VMG_HAS_PERL(5, 21, 3) && !VMG_HAS_PERL(5, 21, 10) */
1852     i = Perl_grok_atou(s, NULL);
1853 # endif
1854    }
1855 #else /* !VMG_HAS_PERL(5, 21, 3) */
1856    i = atoi(s);
1857 #endif
1858    if (lvl < i)
1859     lvl = i;
1860   }
1861  }
1862 #endif
1863
1864  return lvl;
1865 }
1866
1867 #endif /* VMG_THREADSAFE */
1868
1869 static void vmg_teardown(pTHX_ void *param) {
1870  dMY_CXT;
1871
1872 #if VMG_THREADSAFE
1873  VMG_LOADED_LOCK;
1874
1875  if (vmg_loaded == 1) {
1876   vmg_loaded = 0;
1877   if (vmg_destruct_level() == 0) {
1878    vmg_global_teardown_late_locked();
1879   } else {
1880    if (!PL_strtab)
1881     PL_strtab = newHV();
1882    vmg_sv_magicext((SV *) PL_strtab, NULL, &vmg_global_teardown_vtbl, NULL, 0);
1883   }
1884  } else {
1885   VMG_ASSERT(vmg_loaded > 1);
1886   --vmg_loaded;
1887  }
1888
1889  VMG_LOADED_UNLOCK;
1890 #endif
1891
1892  if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1893   vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1894   MY_CXT.freed_tokens = NULL;
1895  }
1896
1897  return;
1898 }
1899
1900 static void vmg_setup(pTHX) {
1901 #define vmg_setup() vmg_setup(aTHX)
1902  HV *stash;
1903  int c;
1904  MY_CXT_INIT;
1905
1906 #if VMG_THREADSAFE
1907  VMG_LOADED_LOCK;
1908
1909  if (vmg_loaded == 0) {
1910   MUTEX_INIT(&vmg_vtable_refcount_mutex);
1911   MUTEX_INIT(&vmg_op_name_init_mutex);
1912   vmg_loaded = 1;
1913  } else {
1914   VMG_ASSERT(vmg_loaded > 0);
1915   ++vmg_loaded;
1916  }
1917
1918  VMG_LOADED_UNLOCK;
1919 #endif
1920
1921  for (c = OPc_NULL; c < OPc_MAX; ++c)
1922   MY_CXT.b__op_stashes[c] = NULL;
1923
1924  MY_CXT.depth        = 0;
1925  MY_CXT.freed_tokens = NULL;
1926
1927 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1928  vmg_trampoline_init(&MY_CXT.propagate_errsv, vmg_pp_propagate_errsv);
1929 #endif
1930 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1931  vmg_trampoline_init(&MY_CXT.reset_rmg, vmg_pp_reset_rmg);
1932 #endif
1933
1934  stash = gv_stashpv(__PACKAGE__, 1);
1935  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1936  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1937  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1938  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1939  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1940                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1941  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_NOLEN",
1942                     newSVuv(VMG_COMPAT_SCALAR_NOLEN));
1943  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1944                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1945  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1946                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1947  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1948                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1949  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1950                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1951  newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1952                     newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1953  newCONSTSUB(stash, "VMG_COMPAT_CODE_COPY_CLONE",
1954                     newSVuv(VMG_COMPAT_CODE_COPY_CLONE));
1955  newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1956  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1957  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1958  newCONSTSUB(stash, "VMG_FORKSAFE",        newSVuv(VMG_FORKSAFE));
1959  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1960  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1961
1962  call_atexit(vmg_teardown, NULL);
1963
1964  return;
1965 }
1966
1967 /* --- Macros for the XS section ------------------------------------------- */
1968
1969 #ifdef CvISXSUB
1970 # define VMG_CVOK(C) \
1971    ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
1972 #else
1973 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
1974 #endif
1975
1976 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
1977
1978 #define VMG_SET_CB(S, N) {       \
1979  SV *cb = (S);                   \
1980  if (SvOK(cb) && SvROK(cb)) {    \
1981   cb = SvRV(cb);                 \
1982   if (VMG_CBOK(cb))              \
1983    SvREFCNT_inc_simple_void(cb); \
1984   else                           \
1985    cb = NULL;                    \
1986  } else {                        \
1987   cb = NULL;                     \
1988  }                               \
1989  w->cb_ ## N = cb;               \
1990 }
1991
1992 #define VMG_SET_SVT_CB(S, N) {   \
1993  SV *cb = (S);                   \
1994  if (SvOK(cb) && SvROK(cb)) {    \
1995   cb = SvRV(cb);                 \
1996   if (VMG_CBOK(cb)) {            \
1997    t->svt_ ## N = vmg_svt_ ## N; \
1998    SvREFCNT_inc_simple_void(cb); \
1999   } else {                       \
2000    t->svt_ ## N = vmg_svt_ ## N ## _noop; \
2001    cb           = NULL;          \
2002   }                              \
2003  } else {                        \
2004   t->svt_ ## N = NULL;           \
2005   cb           = NULL;           \
2006  }                               \
2007  w->cb_ ## N = cb;               \
2008 }
2009
2010 /* --- XS ------------------------------------------------------------------ */
2011
2012 MODULE = Variable::Magic            PACKAGE = Variable::Magic
2013
2014 PROTOTYPES: ENABLE
2015
2016 BOOT:
2017 {
2018  vmg_setup();
2019 }
2020
2021 #if VMG_THREADSAFE
2022
2023 void
2024 CLONE(...)
2025 PROTOTYPE: DISABLE
2026 PREINIT:
2027  U32 had_b__op_stash = 0;
2028  I32 old_depth;
2029  int c;
2030 PPCODE:
2031  {
2032   dMY_CXT;
2033   for (c = OPc_NULL; c < OPc_MAX; ++c) {
2034    if (MY_CXT.b__op_stashes[c])
2035     had_b__op_stash |= (((U32) 1) << c);
2036   }
2037   old_depth = MY_CXT.depth;
2038  }
2039  {
2040   MY_CXT_CLONE;
2041   for (c = OPc_NULL; c < OPc_MAX; ++c) {
2042    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
2043                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
2044   }
2045   MY_CXT.depth        = old_depth;
2046   MY_CXT.freed_tokens = NULL;
2047   VMG_LOADED_LOCK;
2048   VMG_ASSERT(vmg_loaded > 0);
2049   ++vmg_loaded;
2050   VMG_LOADED_UNLOCK;
2051  }
2052  XSRETURN(0);
2053
2054 #endif /* VMG_THREADSAFE */
2055
2056 SV *_wizard(...)
2057 PROTOTYPE: DISABLE
2058 PREINIT:
2059  vmg_wizard *w;
2060  MGVTBL *t;
2061  SV *op_info, *copy_key;
2062  I32 i = 0;
2063 CODE:
2064  if (items != 9
2065 #if MGf_LOCAL
2066               + 1
2067 #endif /* MGf_LOCAL */
2068 #if VMG_UVAR
2069               + 5
2070 #endif /* VMG_UVAR */
2071               ) { croak(vmg_wrongargnum); }
2072
2073  op_info = ST(i++);
2074  w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
2075  t = vmg_vtable_vtbl(w->vtable);
2076
2077  VMG_SET_CB(ST(i++), data);
2078
2079  VMG_SET_SVT_CB(ST(i++), get);
2080  VMG_SET_SVT_CB(ST(i++), set);
2081  VMG_SET_SVT_CB(ST(i++), len);
2082  VMG_SET_SVT_CB(ST(i++), clear);
2083  VMG_SET_SVT_CB(ST(i++), free);
2084  VMG_SET_SVT_CB(ST(i++), copy);
2085  /* VMG_SET_SVT_CB(ST(i++), dup); */
2086  i++;
2087  t->svt_dup = NULL;
2088  w->cb_dup  = NULL;
2089 #if MGf_LOCAL
2090  VMG_SET_SVT_CB(ST(i++), local);
2091 #endif /* MGf_LOCAL */
2092 #if VMG_UVAR
2093  VMG_SET_CB(ST(i++), fetch);
2094  VMG_SET_CB(ST(i++), store);
2095  VMG_SET_CB(ST(i++), exists);
2096  VMG_SET_CB(ST(i++), delete);
2097
2098  copy_key = ST(i++);
2099  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
2100   w->uvar = SvTRUE(copy_key) ? 2 : 1;
2101 #endif /* VMG_UVAR */
2102
2103  RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
2104 OUTPUT:
2105  RETVAL
2106
2107 SV *cast(SV *sv, SV *wiz, ...)
2108 PROTOTYPE: \[$@%&*]$@
2109 PREINIT:
2110  const vmg_wizard *w = NULL;
2111  SV **args = NULL;
2112  I32 i = 0;
2113 CODE:
2114  if (items > 2) {
2115   i = items - 2;
2116   args = &ST(2);
2117  }
2118  if (SvROK(wiz)) {
2119   wiz = SvRV_const(wiz);
2120   w   = vmg_wizard_from_sv(wiz);
2121  }
2122  if (!w)
2123   croak(vmg_invalid_wiz);
2124  RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
2125 OUTPUT:
2126  RETVAL
2127
2128 void
2129 getdata(SV *sv, SV *wiz)
2130 PROTOTYPE: \[$@%&*]$
2131 PREINIT:
2132  const vmg_wizard *w = NULL;
2133  SV *data;
2134 PPCODE:
2135  if (SvROK(wiz))
2136   w = vmg_wizard_from_sv(SvRV_const(wiz));
2137  if (!w)
2138   croak(vmg_invalid_wiz);
2139  data = vmg_data_get(SvRV(sv), w);
2140  if (!data)
2141   XSRETURN_EMPTY;
2142  ST(0) = data;
2143  XSRETURN(1);
2144
2145 SV *dispell(SV *sv, SV *wiz)
2146 PROTOTYPE: \[$@%&*]$
2147 PREINIT:
2148  const vmg_wizard *w = NULL;
2149 CODE:
2150  if (SvROK(wiz))
2151   w = vmg_wizard_from_sv(SvRV_const(wiz));
2152  if (!w)
2153   croak(vmg_invalid_wiz);
2154  RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));
2155 OUTPUT:
2156  RETVAL