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