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  PUSHMARK(SP);
 861  EXTEND(SP, items + 1);
 862  PUSHs(sv_2mortal(newRV_inc(sv)));
 863  for (i = 0; i < items; ++i)
 864   PUSHs(args[i]);
 865  PUTBACK;
 866
 867  vmg_call_sv(ctor, G_SCALAR, 0, NULL);
 868
 869  SPAGAIN;
 870  nsv = POPs;
 871 #if VMG_HAS_PERL(5, 8, 3)
 872  SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
 873 #else
 874  nsv = sv_newref(nsv);          /* Workaround some bug in SvREFCNT_inc() */
 875 #endif
 876  PUTBACK;
 877
 878  FREETMPS;
 879  LEAVE;
 880
 881  return nsv;
 882 }
 883
 884 static SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
 885 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
 886  const MAGIC *mg = vmg_find(sv, w);
 887
 888  return mg ? mg->mg_obj : NULL;
 889 }
 890
 891 /* ... Magic cast/dispell .................................................. */
 892
 893 #if VMG_UVAR
 894
 895 static I32 vmg_svt_val(pTHX_ IV, SV *);
 896
 897 typedef struct {
 898  struct ufuncs new_uf;
 899  struct ufuncs old_uf;
 900 } vmg_uvar_ud;
 901
 902 #endif /* VMG_UVAR */
 903
 904 static void vmg_mg_del(pTHX_ SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 905 #define vmg_mg_del(S, P, M, N) vmg_mg_del(aTHX_ (S), (P), (M), (N))
 906  dMY_CXT;
 907
 908  if (prevmagic)
 909   prevmagic->mg_moremagic = moremagic;
 910  else
 911   SvMAGIC_set(sv, moremagic);
 912
 913  /* Destroy private data */
 914 #if VMG_UVAR
 915  if (mg->mg_type == PERL_MAGIC_uvar) {
 916   Safefree(mg->mg_ptr);
 917  } else {
 918 #endif /* VMG_UVAR */
 919   if (mg->mg_obj != sv) {
 920    SvREFCNT_dec(mg->mg_obj);
 921    mg->mg_obj = NULL;
 922   }
 923   /* Unreference the wizard */
 924   SvREFCNT_dec((SV *) mg->mg_ptr);
 925   mg->mg_ptr = NULL;
 926 #if VMG_UVAR
 927  }
 928 #endif /* VMG_UVAR */
 929
 930  if (MY_CXT.depth) {
 931   mg->mg_moremagic    = MY_CXT.freed_tokens;
 932   MY_CXT.freed_tokens = mg;
 933  } else {
 934   mg->mg_moremagic = NULL;
 935   Safefree(mg);
 936  }
 937 }
 938
 939 static int vmg_magic_chain_free(pTHX_ MAGIC *mg, MAGIC *skip) {
 940 #define vmg_magic_chain_free(M, S) vmg_magic_chain_free(aTHX_ (M), (S))
 941  int skipped = 0;
 942
 943  while (mg) {
 944   MAGIC *moremagic = mg->mg_moremagic;
 945
 946   if (mg == skip)
 947    ++skipped;
 948   else
 949    Safefree(mg);
 950
 951   mg = moremagic;
 952  }
 953
 954  return skipped;
 955 }
 956
 957 static UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
 958 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
 959  MAGIC  *mg;
 960  MGVTBL *t;
 961  SV     *data;
 962  U32     oldgmg;
 963
 964  if (vmg_find(sv, w))
 965   return 1;
 966
 967  oldgmg = SvGMAGICAL(sv);
 968
 969  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
 970
 971  t  = vmg_vtable_vtbl(w->vtable);
 972  mg = vmg_sv_magicext(sv, data, t, wiz, HEf_SVKEY);
 973
 974  if (SvTYPE(sv) < SVt_PVHV)
 975   goto done;
 976
 977  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 978   * magic is actually never called for them. If the GMAGICAL flag was off before
 979   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 980   * now on, then this wizard has get magic. Hence we can work around the
 981   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 982   * has uvar callbacks, it will be turned back on later. */
 983  if (!oldgmg && SvGMAGICAL(sv))
 984   SvGMAGICAL_off(sv);
 985
 986 #if VMG_UVAR
 987  if (w->uvar) {
 988   MAGIC *prevmagic, *moremagic = NULL;
 989   vmg_uvar_ud ud;
 990
 991   ud.new_uf.uf_val   = vmg_svt_val;
 992   ud.new_uf.uf_set   = NULL;
 993   ud.new_uf.uf_index = 0;
 994   ud.old_uf.uf_val   = NULL;
 995   ud.old_uf.uf_set   = NULL;
 996   ud.old_uf.uf_index = 0;
 997
 998   /* One uvar magic in the chain is enough. */
 999   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
1000    moremagic = mg->mg_moremagic;
1001    if (mg->mg_type == PERL_MAGIC_uvar)
1002     break;
1003   }
1004
1005   if (mg) { /* Found another uvar magic. */
1006    struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
1007    if (uf->uf_val == vmg_svt_val) {
1008     /* It's our uvar magic, nothing to do. oldgmg was true. */
1009     goto done;
1010    } else {
1011     /* It's another uvar magic, backup it and replace it by ours. */
1012     ud.old_uf = *uf;
1013     vmg_mg_del(sv, prevmagic, mg, moremagic);
1014    }
1015   }
1016
1017   sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
1018   vmg_mg_magical(sv);
1019   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
1020    * handled by our uvar callback. */
1021  }
1022 #endif /* VMG_UVAR */
1023
1024 done:
1025  return 1;
1026 }
1027
1028 static UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
1029 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
1030 #if VMG_UVAR
1031  U32 uvars = 0;
1032 #endif /* VMG_UVAR */
1033  MAGIC *mg, *prevmagic, *moremagic = NULL;
1034  IV wid = vmg_wizard_id(w);
1035
1036  if (SvTYPE(sv) < SVt_PVMG)
1037   return 0;
1038
1039  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
1040   const vmg_wizard *z;
1041
1042   moremagic = mg->mg_moremagic;
1043
1044   z = vmg_wizard_from_mg(mg);
1045   if (z) {
1046    IV zid = vmg_wizard_id(z);
1047
1048 #if VMG_UVAR
1049    if (zid == wid) {
1050     /* If the current has no uvar, short-circuit uvar deletion. */
1051     uvars = z->uvar ? (uvars + 1) : 0;
1052     break;
1053    } else if (z->uvar) {
1054     ++uvars;
1055     /* We can't break here since we need to find the ext magic to delete. */
1056    }
1057 #else /* VMG_UVAR */
1058    if (zid == wid)
1059     break;
1060 #endif /* !VMG_UVAR */
1061   }
1062  }
1063  if (!mg)
1064   return 0;
1065
1066  vmg_mg_del(sv, prevmagic, mg, moremagic);
1067
1068 #if VMG_UVAR
1069  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
1070   /* mg was the first ext magic in the chain that had uvar */
1071
1072   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
1073    const vmg_wizard *z = vmg_wizard_from_mg(mg);
1074
1075    if (z && z->uvar) {
1076     ++uvars;
1077     break;
1078    }
1079   }
1080
1081   if (uvars == 1) {
1082    vmg_uvar_ud *ud;
1083
1084    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
1085     moremagic = mg->mg_moremagic;
1086     if (mg->mg_type == PERL_MAGIC_uvar)
1087      break;
1088    }
1089
1090    ud = (vmg_uvar_ud *) mg->mg_ptr;
1091    if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
1092     /* Revert the original uvar magic. */
1093     struct ufuncs *uf;
1094     Newx(uf, 1, struct ufuncs);
1095     *uf = ud->old_uf;
1096     Safefree(ud);
1097     mg->mg_ptr = (char *) uf;
1098     mg->mg_len = sizeof(*uf);
1099    } else {
1100     /* Remove the uvar magic. */
1101     vmg_mg_del(sv, prevmagic, mg, moremagic);
1102    }
1103   }
1104  }
1105 #endif /* VMG_UVAR */
1106
1107  vmg_mg_magical(sv);
1108
1109  return 1;
1110 }
1111
1112 /* ... OP info ............................................................. */
1113
1114 #define VMG_OP_INFO_NAME   1
1115 #define VMG_OP_INFO_OBJECT 2
1116
1117 #if VMG_THREADSAFE
1118 static perl_mutex vmg_op_name_init_mutex;
1119 #endif
1120
1121 static U32           vmg_op_name_init      = 0;
1122 static unsigned char vmg_op_name_len[MAXO] = { 0 };
1123
1124 static void vmg_op_info_init(pTHX_ unsigned int opinfo) {
1125 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
1126  switch (opinfo) {
1127   case VMG_OP_INFO_NAME:
1128    VMG_LOCK(&vmg_op_name_init_mutex);
1129    if (!vmg_op_name_init) {
1130     OPCODE t;
1131     for (t = 0; t < OP_max; ++t)
1132      vmg_op_name_len[t] = strlen(PL_op_name[t]);
1133     vmg_op_name_init = 1;
1134    }
1135    VMG_UNLOCK(&vmg_op_name_init_mutex);
1136    break;
1137   case VMG_OP_INFO_OBJECT: {
1138    dMY_CXT;
1139    if (!MY_CXT.b__op_stashes[0]) {
1140     int c;
1141     require_pv("B.pm");
1142     for (c = OPc_NULL; c < OPc_MAX; ++c)
1143      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1144    }
1145    break;
1146   }
1147   default:
1148    break;
1149  }
1150 }
1151
1152 static SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1153 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1154  if (!PL_op)
1155   return &PL_sv_undef;
1156
1157  switch (opinfo) {
1158   case VMG_OP_INFO_NAME: {
1159    const char *name;
1160    STRLEN      name_len;
1161    OPCODE      t = PL_op->op_type;
1162    name     = OP_NAME(PL_op);
1163    name_len = (t == OP_CUSTOM) ? strlen(name) : vmg_op_name_len[t];
1164    return sv_2mortal(newSVpvn(name, name_len));
1165   }
1166   case VMG_OP_INFO_OBJECT: {
1167    dMY_CXT;
1168    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1169                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1170   }
1171   default:
1172    break;
1173  }
1174
1175  return &PL_sv_undef;
1176 }
1177
1178 /* --- svt callbacks ------------------------------------------------------- */
1179
1180 #define VMG_CB_CALL_ARGS_MASK  15
1181 #define VMG_CB_CALL_ARGS_SHIFT 4
1182 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT) /* 1|2 */
1183 #define VMG_CB_CALL_GUARD      4
1184
1185 static int vmg_dispell_guard_oncroak(pTHX_ void *ud) {
1186  dMY_CXT;
1187
1188  MY_CXT.depth--;
1189
1190  /* If we're at the upmost magic call and we're about to die, we can just free
1191   * the tokens right now, since we will jump past the problematic part of our
1192   * caller. */
1193  if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1194   vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1195   MY_CXT.freed_tokens = NULL;
1196  }
1197
1198  return 1;
1199 }
1200
1201 static int vmg_dispell_guard_free(pTHX_ SV *sv, MAGIC *mg) {
1202  vmg_magic_chain_free((MAGIC *) mg->mg_ptr, NULL);
1203
1204  return 0;
1205 }
1206
1207 #if VMG_THREADSAFE
1208
1209 static int vmg_dispell_guard_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
1210  /* The freed magic tokens aren't cloned by perl because it cannot reach them
1211   * (they have been detached from their parent SV when they were enqueued).
1212   * Hence there's nothing to purge in the new thread. */
1213  mg->mg_ptr = NULL;
1214
1215  return 0;
1216 }
1217
1218 #endif /* VMG_THREADSAFE */
1219
1220 static MGVTBL vmg_dispell_guard_vtbl = {
1221  NULL,                   /* get */
1222  NULL,                   /* set */
1223  NULL,                   /* len */
1224  NULL,                   /* clear */
1225  vmg_dispell_guard_free, /* free */
1226  NULL,                   /* copy */
1227 #if VMG_THREADSAFE
1228  vmg_dispell_guard_dup,  /* dup */
1229 #else
1230  NULL,                   /* dup */
1231 #endif
1232 #if MGf_LOCAL
1233  NULL,                   /* local */
1234 #endif /* MGf_LOCAL */
1235 };
1236
1237 static SV *vmg_dispell_guard_new(pTHX_ MAGIC *root) {
1238 #define vmg_dispell_guard_new(R) vmg_dispell_guard_new(aTHX_ (R))
1239  SV *guard;
1240
1241  guard = sv_newmortal();
1242  vmg_sv_magicext(guard, NULL, &vmg_dispell_guard_vtbl, root, 0);
1243
1244  return guard;
1245 }
1246
1247 static int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1248  va_list ap;
1249  int ret = 0;
1250  unsigned int i, args, opinfo;
1251  MAGIC **chain = NULL;
1252  SV *svr;
1253
1254  dSP;
1255
1256  args    = flags & VMG_CB_CALL_ARGS_MASK;
1257  flags >>= VMG_CB_CALL_ARGS_SHIFT;
1258  opinfo  = flags & VMG_CB_CALL_OPINFO;
1259
1260  ENTER;
1261  SAVETMPS;
1262
1263  PUSHMARK(SP);
1264  EXTEND(SP, args + 1);
1265  PUSHs(sv_2mortal(newRV_inc(sv)));
1266  va_start(ap, sv);
1267  for (i = 0; i < args; ++i) {
1268   SV *sva = va_arg(ap, SV *);
1269   PUSHs(sva ? sva : &PL_sv_undef);
1270  }
1271  va_end(ap);
1272  if (opinfo)
1273   XPUSHs(vmg_op_info(opinfo));
1274  PUTBACK;
1275
1276  if (flags & VMG_CB_CALL_GUARD) {
1277   dMY_CXT;
1278   MY_CXT.depth++;
1279   vmg_call_sv(cb, G_SCALAR, vmg_dispell_guard_oncroak, NULL);
1280   MY_CXT.depth--;
1281   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens)
1282    chain = &MY_CXT.freed_tokens;
1283  } else {
1284   vmg_call_sv(cb, G_SCALAR, 0, NULL);
1285  }
1286
1287  SPAGAIN;
1288  svr = POPs;
1289  if (SvOK(svr))
1290   ret = (int) SvIV(svr);
1291  if (SvROK(svr))
1292   SvREFCNT_inc(svr);
1293  else
1294   svr = NULL;
1295  PUTBACK;
1296
1297  FREETMPS;
1298  LEAVE;
1299
1300  if (svr && !SvTEMP(svr))
1301   sv_2mortal(svr);
1302
1303  if (chain) {
1304   vmg_dispell_guard_new(*chain);
1305   *chain = NULL;
1306  }
1307
1308  return ret;
1309 }
1310
1311 #define VMG_CB_FLAGS(OI, A) \
1312         ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1313
1314 #define vmg_cb_call1(I, OI, S, A1) \
1315         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1316 #define vmg_cb_call2(I, OI, S, A1, A2) \
1317         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1318 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1319         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1320
1321 /* ... Default no-op magic callback ........................................ */
1322
1323 static int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1324  return 0;
1325 }
1326
1327 /* ... get magic ........................................................... */
1328
1329 static int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1330  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1331
1332  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1333 }
1334
1335 #define vmg_svt_get_noop vmg_svt_default_noop
1336
1337 /* ... set magic ........................................................... */
1338
1339 static int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1340  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1341
1342  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1343 }
1344
1345 #define vmg_svt_set_noop vmg_svt_default_noop
1346
1347 /* ... len magic ........................................................... */
1348
1349 static U32 vmg_sv_len(pTHX_ SV *sv) {
1350 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1351  STRLEN len;
1352 #if VMG_HAS_PERL(5, 9, 3)
1353  const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1354 #else
1355  U8 *s = SvPV(sv, len);
1356 #endif
1357
1358  return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1359 }
1360
1361 static U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1362  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1363  unsigned int opinfo = w->opinfo;
1364  U32 len, ret;
1365  SV *svr;
1366  svtype t = SvTYPE(sv);
1367
1368  dSP;
1369
1370  ENTER;
1371  SAVETMPS;
1372
1373  PUSHMARK(SP);
1374  EXTEND(SP, 3);
1375  PUSHs(sv_2mortal(newRV_inc(sv)));
1376  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1377  if (t < SVt_PVAV) {
1378   len = vmg_sv_len(sv);
1379   mPUSHu(len);
1380  } else if (t == SVt_PVAV) {
1381   len = av_len((AV *) sv) + 1;
1382   mPUSHu(len);
1383  } else {
1384   len = 0;
1385   PUSHs(&PL_sv_undef);
1386  }
1387  if (opinfo)
1388   XPUSHs(vmg_op_info(opinfo));
1389  PUTBACK;
1390
1391  vmg_call_sv(w->cb_len, G_SCALAR, 0, NULL);
1392
1393  SPAGAIN;
1394  svr = POPs;
1395  ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1396  if (t == SVt_PVAV)
1397   --ret;
1398  PUTBACK;
1399
1400  FREETMPS;
1401  LEAVE;
1402
1403  return ret;
1404 }
1405
1406 static U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1407  U32    len = 0;
1408  svtype t   = SvTYPE(sv);
1409
1410  if (t < SVt_PVAV) {
1411   len = vmg_sv_len(sv);
1412  } else if (t == SVt_PVAV) {
1413   len = (U32) av_len((AV *) sv);
1414  }
1415
1416  return len;
1417 }
1418
1419 /* ... clear magic ......................................................... */
1420
1421 static int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1422  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1423  unsigned int flags  = w->opinfo;
1424
1425 #if !VMG_HAS_PERL(5, 12, 0)
1426  flags |= VMG_CB_CALL_GUARD;
1427 #endif
1428
1429  return vmg_cb_call1(w->cb_clear, flags, sv, mg->mg_obj);
1430 }
1431
1432 #define vmg_svt_clear_noop vmg_svt_default_noop
1433
1434 /* ... free magic .......................................................... */
1435
1436 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1437
1438 static OP *vmg_pp_propagate_errsv(pTHX) {
1439  SVOP *o = cSVOPx(PL_op);
1440
1441  if (o->op_sv) {
1442   sv_setsv(ERRSV, o->op_sv);
1443   SvREFCNT_dec(o->op_sv);
1444   o->op_sv = NULL;
1445  }
1446
1447  return NORMAL;
1448 }
1449
1450 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1451
1452 static int vmg_propagate_errsv_free(pTHX_ SV *sv, MAGIC *mg) {
1453  if (mg->mg_obj)
1454   sv_setsv(ERRSV, mg->mg_obj);
1455
1456  return 0;
1457 }
1458
1459 /* perl is already kind enough to handle the cloning of the mg_obj member,
1460    hence we don't need to define a dup magic callback. */
1461
1462 static MGVTBL vmg_propagate_errsv_vtbl = {
1463  0,                        /* get */
1464  0,                        /* set */
1465  0,                        /* len */
1466  0,                        /* clear */
1467  vmg_propagate_errsv_free, /* free */
1468  0,                        /* copy */
1469  0,                        /* dup */
1470 #if MGf_LOCAL
1471  0,                        /* local */
1472 #endif /* MGf_LOCAL */
1473 };
1474
1475 typedef struct {
1476  SV  *sv;
1477  int  in_eval;
1478  I32  base;
1479 } vmg_svt_free_cleanup_ud;
1480
1481 static int vmg_svt_free_cleanup(pTHX_ void *ud_) {
1482  vmg_svt_free_cleanup_ud *ud = VOID2(vmg_svt_free_cleanup_ud *, ud_);
1483
1484  if (ud->in_eval) {
1485   U32 optype = PL_op ? PL_op->op_type : OP_NULL;
1486
1487   if (optype == OP_LEAVETRY || optype == OP_LEAVEEVAL) {
1488    SV *errsv = newSVsv(ERRSV);
1489
1490    FREETMPS;
1491    LEAVE_SCOPE(ud->base);
1492
1493 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1494    if (optype == OP_LEAVETRY) {
1495     dMY_CXT;
1496     PL_op = vmg_trampoline_bump(&MY_CXT.propagate_errsv, errsv, PL_op);
1497    } else if (optype == OP_LEAVEEVAL) {
1498     SV *guard = sv_newmortal();
1499     vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1500    }
1501 #else /* !VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1502 # if !VMG_HAS_PERL(5, 8, 9)
1503    {
1504     SV *guard = sv_newmortal();
1505     vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1506    }
1507 # else
1508    vmg_sv_magicext(ERRSV, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1509 # endif
1510 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1511
1512    SAVETMPS;
1513   }
1514
1515   /* Don't propagate */
1516   return 0;
1517  } else {
1518   SV    *sv = ud->sv;
1519   MAGIC *mg;
1520
1521   /* We are about to croak() while sv is being destroyed. Try to clean up
1522    * things a bit. */
1523   mg = SvMAGIC(sv);
1524   if (mg) {
1525    vmg_mg_del(sv, NULL, mg, mg->mg_moremagic);
1526    mg_magical(sv);
1527   }
1528   SvREFCNT_dec(sv);
1529
1530   vmg_dispell_guard_oncroak(aTHX_ NULL);
1531
1532   /* After that, propagate the error upwards. */
1533   return 1;
1534  }
1535 }
1536
1537 static int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1538  vmg_svt_free_cleanup_ud ud;
1539  const vmg_wizard *w;
1540  int ret = 0;
1541  SV *svr;
1542
1543  dSP;
1544
1545  /* During global destruction, we cannot be sure that the wizard and its free
1546   * callback are still alive. */
1547  if (PL_dirty)
1548   return 0;
1549
1550  w = vmg_wizard_from_mg_nocheck(mg);
1551
1552  /* So that it survives the temp cleanup below */
1553  SvREFCNT_inc_simple_void(sv);
1554
1555 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1556  /* The previous magic tokens were freed but the magic chain wasn't updated, so
1557   * if you access the sv from the callback the old deleted magics will trigger
1558   * and cause memory misreads. Change 32686 solved it that way : */
1559  SvMAGIC_set(sv, mg);
1560 #endif
1561
1562  ud.sv = sv;
1563  if (cxstack_ix < cxstack_max) {
1564   ud.in_eval = (CxTYPE(cxstack + cxstack_ix + 1) == CXt_EVAL);
1565   ud.base    = ud.in_eval ? PL_scopestack[PL_scopestack_ix] : 0;
1566  } else {
1567   ud.in_eval = 0;
1568   ud.base    = 0;
1569  }
1570
1571  ENTER;
1572  SAVETMPS;
1573
1574  PUSHMARK(SP);
1575  EXTEND(SP, 2);
1576  PUSHs(sv_2mortal(newRV_inc(sv)));
1577  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1578  if (w->opinfo)
1579   XPUSHs(vmg_op_info(w->opinfo));
1580  PUTBACK;
1581
1582  {
1583   dMY_CXT;
1584   MY_CXT.depth++;
1585   vmg_call_sv(w->cb_free, G_SCALAR, vmg_svt_free_cleanup, &ud);
1586   MY_CXT.depth--;
1587   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1588    /* Free all the tokens in the chain but the current one (if it's present).
1589     * It will be taken care of by our caller, Perl_mg_free(). */
1590    vmg_magic_chain_free(MY_CXT.freed_tokens, mg);
1591    MY_CXT.freed_tokens = NULL;
1592   }
1593  }
1594
1595  SPAGAIN;
1596  svr = POPs;
1597  if (SvOK(svr))
1598   ret = (int) SvIV(svr);
1599  PUTBACK;
1600
1601  FREETMPS;
1602  LEAVE;
1603
1604  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1605   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1606  --SvREFCNT(sv);
1607
1608  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1609   * mg->mg_ptr reference count */
1610  return ret;
1611 }
1612
1613 #define vmg_svt_free_noop vmg_svt_default_noop
1614
1615 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1616 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1617 #else
1618 # define VMG_SVT_COPY_KEYLEN_TYPE int
1619 #endif
1620
1621 /* ... copy magic .......................................................... */
1622
1623 static int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1624  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1625  SV *keysv;
1626  int ret;
1627
1628  if (keylen == HEf_SVKEY) {
1629   keysv = (SV *) key;
1630  } else {
1631   keysv = newSVpvn(key, keylen);
1632  }
1633
1634  if (SvTYPE(sv) >= SVt_PVCV)
1635   nsv = sv_2mortal(newRV_inc(nsv));
1636
1637  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1638
1639  if (keylen != HEf_SVKEY) {
1640   SvREFCNT_dec(keysv);
1641  }
1642
1643  return ret;
1644 }
1645
1646 static int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1647  return 0;
1648 }
1649
1650 /* ... dup magic ........................................................... */
1651
1652 #if 0
1653 static int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1654  return 0;
1655 }
1656 #define vmg_svt_dup_noop vmg_svt_dup
1657 #endif
1658
1659 /* ... local magic ......................................................... */
1660
1661 #if MGf_LOCAL
1662
1663 static int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1664  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1665
1666  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1667 }
1668
1669 #define vmg_svt_local_noop vmg_svt_default_noop
1670
1671 #endif /* MGf_LOCAL */
1672
1673 /* ... uvar magic .......................................................... */
1674
1675 #if VMG_UVAR
1676
1677 static OP *vmg_pp_reset_rmg(pTHX) {
1678  SVOP *o = cSVOPx(PL_op);
1679
1680  SvRMAGICAL_on(o->op_sv);
1681  o->op_sv = NULL;
1682
1683  return NORMAL;
1684 }
1685
1686 static I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1687  vmg_uvar_ud *ud;
1688  MAGIC *mg, *umg, *moremagic;
1689  SV *key = NULL, *newkey = NULL;
1690  int tied = 0;
1691
1692  umg = mg_find(sv, PERL_MAGIC_uvar);
1693  /* umg can't be NULL or we wouldn't be there. */
1694  key = umg->mg_obj;
1695  ud  = (vmg_uvar_ud *) umg->mg_ptr;
1696
1697  if (ud->old_uf.uf_val)
1698   ud->old_uf.uf_val(aTHX_ action, sv);
1699  if (ud->old_uf.uf_set)
1700   ud->old_uf.uf_set(aTHX_ action, sv);
1701
1702  for (mg = SvMAGIC(sv); mg; mg = moremagic) {
1703   const vmg_wizard *w;
1704
1705   /* mg may be freed later by the uvar call, so we need to fetch the next
1706    * token before reaching that fateful point. */
1707   moremagic = mg->mg_moremagic;
1708
1709   switch (mg->mg_type) {
1710    case PERL_MAGIC_ext:
1711     break;
1712    case PERL_MAGIC_tied:
1713     ++tied;
1714     continue;
1715    default:
1716     continue;
1717   }
1718
1719   w = vmg_wizard_from_mg(mg);
1720   if (!w)
1721    continue;
1722
1723   switch (w->uvar) {
1724    case 0:
1725     continue;
1726    case 2:
1727     if (!newkey)
1728      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1729   }
1730
1731   switch (action
1732              & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1733    case 0:
1734     if (w->cb_fetch)
1735      vmg_cb_call2(w->cb_fetch, w->opinfo | VMG_CB_CALL_GUARD, sv,
1736                                mg->mg_obj, key);
1737     break;
1738    case HV_FETCH_ISSTORE:
1739    case HV_FETCH_LVALUE:
1740    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1741     if (w->cb_store)
1742      vmg_cb_call2(w->cb_store, w->opinfo | VMG_CB_CALL_GUARD, sv,
1743                                mg->mg_obj, key);
1744     break;
1745    case HV_FETCH_ISEXISTS:
1746     if (w->cb_exists)
1747      vmg_cb_call2(w->cb_exists, w->opinfo | VMG_CB_CALL_GUARD, sv,
1748                                 mg->mg_obj, key);
1749     break;
1750    case HV_DELETE:
1751     if (w->cb_delete)
1752      vmg_cb_call2(w->cb_delete, w->opinfo | VMG_CB_CALL_GUARD, sv,
1753                                 mg->mg_obj, key);
1754     break;
1755   }
1756  }
1757
1758  if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1759   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1760    * mistaken for a tied hash by the rest of hv_common. It will be reset by
1761    * the op_ppaddr of a new fake op injected between the current and the next
1762    * one. */
1763
1764 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1765
1766   dMY_CXT;
1767
1768   PL_op = vmg_trampoline_bump(&MY_CXT.reset_rmg, sv, PL_op);
1769
1770 #else /* !VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1771
1772   OP   *nop  = PL_op->op_next;
1773   SVOP *svop = NULL;
1774
1775   if (nop && nop->op_ppaddr == vmg_pp_reset_rmg) {
1776    svop = (SVOP *) nop;
1777   } else {
1778    NewOp(1101, svop, 1, SVOP);
1779    svop->op_type    = OP_STUB;
1780    svop->op_ppaddr  = vmg_pp_reset_rmg;
1781    svop->op_next    = nop;
1782    svop->op_flags   = 0;
1783    svop->op_private = 0;
1784
1785    PL_op->op_next = (OP *) svop;
1786   }
1787
1788   svop->op_sv = sv;
1789
1790 #endif /* VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1791
1792   SvRMAGICAL_off(sv);
1793  }
1794
1795  return 0;
1796 }
1797
1798 #endif /* VMG_UVAR */
1799
1800 /* --- Module setup/teardown ----------------------------------------------- */
1801
1802 #if VMG_THREADSAFE
1803
1804 static I32 vmg_loaded = 0;
1805
1806 /* We must use preexistent global mutexes or we will never be able to destroy
1807  * them. */
1808 # if VMG_HAS_PERL(5, 9, 3)
1809 #  define VMG_LOADED_LOCK   MUTEX_LOCK(&PL_my_ctx_mutex)
1810 #  define VMG_LOADED_UNLOCK MUTEX_UNLOCK(&PL_my_ctx_mutex)
1811 # else
1812 #  define VMG_LOADED_LOCK   OP_REFCNT_LOCK
1813 #  define VMG_LOADED_UNLOCK OP_REFCNT_UNLOCK
1814 # endif
1815
1816 static void vmg_global_teardown_late_locked(pTHX) {
1817 #define vmg_global_teardown_late_locked() vmg_global_teardown_late_locked(aTHX)
1818  MUTEX_DESTROY(&vmg_op_name_init_mutex);
1819  MUTEX_DESTROY(&vmg_vtable_refcount_mutex);
1820
1821  return;
1822 }
1823
1824 static int vmg_global_teardown_free(pTHX_ SV *sv, MAGIC *mg) {
1825  VMG_LOADED_LOCK;
1826
1827  if (vmg_loaded == 0)
1828   vmg_global_teardown_late_locked();
1829
1830  VMG_LOADED_UNLOCK;
1831
1832  return 0;
1833 }
1834
1835 static MGVTBL vmg_global_teardown_vtbl = {
1836  0,
1837  0,
1838  0,
1839  0,
1840  vmg_global_teardown_free
1841 #if MGf_COPY
1842  , 0
1843 #endif
1844 #if MGf_DUP
1845  , 0
1846 #endif
1847 #if MGf_LOCAL
1848  , 0
1849 #endif
1850 };
1851
1852 static signed char vmg_destruct_level(pTHX) {
1853 #define vmg_destruct_level() vmg_destruct_level(aTHX)
1854  signed char lvl;
1855
1856  lvl = PL_perl_destruct_level;
1857
1858 #ifdef DEBUGGING
1859  {
1860   const char *s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1861   if (s) {
1862    int i;
1863 #if VMG_HAS_PERL(5, 21, 3)
1864    if (strEQ(s, "-1")) {
1865     i = -1;
1866    } else {
1867 # if VMG_HAS_PERL(5, 21, 10)
1868     UV uv;
1869     if (Perl_grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
1870      i = (int) uv;
1871     else
1872      i = 0;
1873 # else /* VMG_HAS_PERL(5, 21, 3) && !VMG_HAS_PERL(5, 21, 10) */
1874     i = Perl_grok_atou(s, NULL);
1875 # endif
1876    }
1877 #else /* !VMG_HAS_PERL(5, 21, 3) */
1878    i = atoi(s);
1879 #endif
1880    if (lvl < i)
1881     lvl = i;
1882   }
1883  }
1884 #endif
1885
1886  return lvl;
1887 }
1888
1889 #endif /* VMG_THREADSAFE */
1890
1891 static void vmg_teardown(pTHX_ void *param) {
1892  dMY_CXT;
1893
1894 #if VMG_THREADSAFE
1895  VMG_LOADED_LOCK;
1896
1897  if (vmg_loaded == 1) {
1898   vmg_loaded = 0;
1899   if (vmg_destruct_level() == 0) {
1900    vmg_global_teardown_late_locked();
1901   } else {
1902    if (!PL_strtab)
1903     PL_strtab = newHV();
1904    vmg_sv_magicext((SV *) PL_strtab, NULL, &vmg_global_teardown_vtbl, NULL, 0);
1905   }
1906  } else {
1907   VMG_ASSERT(vmg_loaded > 1);
1908   --vmg_loaded;
1909  }
1910
1911  VMG_LOADED_UNLOCK;
1912 #endif
1913
1914  if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1915   vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1916   MY_CXT.freed_tokens = NULL;
1917  }
1918
1919  return;
1920 }
1921
1922 static void vmg_setup(pTHX) {
1923 #define vmg_setup() vmg_setup(aTHX)
1924  HV *stash;
1925  int c;
1926  MY_CXT_INIT;
1927
1928 #if VMG_THREADSAFE
1929  VMG_LOADED_LOCK;
1930
1931  if (vmg_loaded == 0) {
1932   MUTEX_INIT(&vmg_vtable_refcount_mutex);
1933   MUTEX_INIT(&vmg_op_name_init_mutex);
1934   vmg_loaded = 1;
1935  } else {
1936   VMG_ASSERT(vmg_loaded > 0);
1937   ++vmg_loaded;
1938  }
1939
1940  VMG_LOADED_UNLOCK;
1941 #endif
1942
1943  for (c = OPc_NULL; c < OPc_MAX; ++c)
1944   MY_CXT.b__op_stashes[c] = NULL;
1945
1946  MY_CXT.depth        = 0;
1947  MY_CXT.freed_tokens = NULL;
1948
1949 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1950  vmg_trampoline_init(&MY_CXT.propagate_errsv, vmg_pp_propagate_errsv);
1951 #endif
1952 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1953  vmg_trampoline_init(&MY_CXT.reset_rmg, vmg_pp_reset_rmg);
1954 #endif
1955
1956  stash = gv_stashpv(__PACKAGE__, 1);
1957  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1958  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1959  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1960  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1961  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1962                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1963  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_NOLEN",
1964                     newSVuv(VMG_COMPAT_SCALAR_NOLEN));
1965  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1966                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1967  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1968                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1969  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1970                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1971  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1972                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1973  newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1974                     newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1975  newCONSTSUB(stash, "VMG_COMPAT_CODE_COPY_CLONE",
1976                     newSVuv(VMG_COMPAT_CODE_COPY_CLONE));
1977  newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1978  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1979  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1980  newCONSTSUB(stash, "VMG_FORKSAFE",        newSVuv(VMG_FORKSAFE));
1981  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1982  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1983
1984  call_atexit(vmg_teardown, NULL);
1985
1986  return;
1987 }
1988
1989 /* --- Macros for the XS section ------------------------------------------- */
1990
1991 #ifdef CvISXSUB
1992 # define VMG_CVOK(C) \
1993    ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
1994 #else
1995 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
1996 #endif
1997
1998 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
1999
2000 #define VMG_SET_CB(S, N) {       \
2001  SV *cb = (S);                   \
2002  if (SvOK(cb) && SvROK(cb)) {    \
2003   cb = SvRV(cb);                 \
2004   if (VMG_CBOK(cb))              \
2005    SvREFCNT_inc_simple_void(cb); \
2006   else                           \
2007    cb = NULL;                    \
2008  } else {                        \
2009   cb = NULL;                     \
2010  }                               \
2011  w->cb_ ## N = cb;               \
2012 }
2013
2014 #define VMG_SET_SVT_CB(S, N) {   \
2015  SV *cb = (S);                   \
2016  if (SvOK(cb) && SvROK(cb)) {    \
2017   cb = SvRV(cb);                 \
2018   if (VMG_CBOK(cb)) {            \
2019    t->svt_ ## N = vmg_svt_ ## N; \
2020    SvREFCNT_inc_simple_void(cb); \
2021   } else {                       \
2022    t->svt_ ## N = vmg_svt_ ## N ## _noop; \
2023    cb           = NULL;          \
2024   }                              \
2025  } else {                        \
2026   t->svt_ ## N = NULL;           \
2027   cb           = NULL;           \
2028  }                               \
2029  w->cb_ ## N = cb;               \
2030 }
2031
2032 /* --- XS ------------------------------------------------------------------ */
2033
2034 MODULE = Variable::Magic            PACKAGE = Variable::Magic
2035
2036 PROTOTYPES: ENABLE
2037
2038 BOOT:
2039 {
2040  vmg_setup();
2041 }
2042
2043 #if VMG_THREADSAFE
2044
2045 void
2046 CLONE(...)
2047 PROTOTYPE: DISABLE
2048 PREINIT:
2049  U32 had_b__op_stash = 0;
2050  I32 old_depth;
2051  int c;
2052 PPCODE:
2053  {
2054   dMY_CXT;
2055   for (c = OPc_NULL; c < OPc_MAX; ++c) {
2056    if (MY_CXT.b__op_stashes[c])
2057     had_b__op_stash |= (((U32) 1) << c);
2058   }
2059   old_depth = MY_CXT.depth;
2060  }
2061  {
2062   MY_CXT_CLONE;
2063   for (c = OPc_NULL; c < OPc_MAX; ++c) {
2064    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
2065                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
2066   }
2067   MY_CXT.depth        = old_depth;
2068   MY_CXT.freed_tokens = NULL;
2069   VMG_LOADED_LOCK;
2070   VMG_ASSERT(vmg_loaded > 0);
2071   ++vmg_loaded;
2072   VMG_LOADED_UNLOCK;
2073  }
2074  XSRETURN(0);
2075
2076 #endif /* VMG_THREADSAFE */
2077
2078 SV *_wizard(...)
2079 PROTOTYPE: DISABLE
2080 PREINIT:
2081  vmg_wizard *w;
2082  MGVTBL *t;
2083  SV *op_info, *copy_key;
2084  I32 i = 0;
2085 CODE:
2086  if (items != 9
2087 #if MGf_LOCAL
2088               + 1
2089 #endif /* MGf_LOCAL */
2090 #if VMG_UVAR
2091               + 5
2092 #endif /* VMG_UVAR */
2093               ) { croak(vmg_wrongargnum); }
2094
2095  op_info = ST(i++);
2096  w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
2097  t = vmg_vtable_vtbl(w->vtable);
2098
2099  VMG_SET_CB(ST(i++), data);
2100
2101  VMG_SET_SVT_CB(ST(i++), get);
2102  VMG_SET_SVT_CB(ST(i++), set);
2103  VMG_SET_SVT_CB(ST(i++), len);
2104  VMG_SET_SVT_CB(ST(i++), clear);
2105  VMG_SET_SVT_CB(ST(i++), free);
2106  VMG_SET_SVT_CB(ST(i++), copy);
2107  /* VMG_SET_SVT_CB(ST(i++), dup); */
2108  i++;
2109  t->svt_dup = NULL;
2110  w->cb_dup  = NULL;
2111 #if MGf_LOCAL
2112  VMG_SET_SVT_CB(ST(i++), local);
2113 #endif /* MGf_LOCAL */
2114 #if VMG_UVAR
2115  VMG_SET_CB(ST(i++), fetch);
2116  VMG_SET_CB(ST(i++), store);
2117  VMG_SET_CB(ST(i++), exists);
2118  VMG_SET_CB(ST(i++), delete);
2119
2120  copy_key = ST(i++);
2121  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
2122   w->uvar = SvTRUE(copy_key) ? 2 : 1;
2123 #endif /* VMG_UVAR */
2124
2125  RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
2126 OUTPUT:
2127  RETVAL
2128
2129 SV *cast(SV *sv, SV *wiz, ...)
2130 PROTOTYPE: \[$@%&*]$@
2131 PREINIT:
2132  const vmg_wizard *w = NULL;
2133  SV **args = NULL;
2134  I32 i = 0;
2135 CODE:
2136  if (items > 2) {
2137   i = items - 2;
2138   args = &ST(2);
2139  }
2140  if (SvROK(wiz)) {
2141   wiz = SvRV_const(wiz);
2142   w   = vmg_wizard_from_sv(wiz);
2143  }
2144  if (!w)
2145   croak(vmg_invalid_wiz);
2146  RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
2147 OUTPUT:
2148  RETVAL
2149
2150 void
2151 getdata(SV *sv, SV *wiz)
2152 PROTOTYPE: \[$@%&*]$
2153 PREINIT:
2154  const vmg_wizard *w = NULL;
2155  SV *data;
2156 PPCODE:
2157  if (SvROK(wiz))
2158   w = vmg_wizard_from_sv(SvRV_const(wiz));
2159  if (!w)
2160   croak(vmg_invalid_wiz);
2161  data = vmg_data_get(SvRV(sv), w);
2162  if (!data)
2163   XSRETURN_EMPTY;
2164  ST(0) = data;
2165  XSRETURN(1);
2166
2167 SV *dispell(SV *sv, SV *wiz)
2168 PROTOTYPE: \[$@%&*]$
2169 PREINIT:
2170  const vmg_wizard *w = NULL;
2171 CODE:
2172  if (SvROK(wiz))
2173   w = vmg_wizard_from_sv(SvRV_const(wiz));
2174  if (!w)
2175   croak(vmg_invalid_wiz);
2176  RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));
2177 OUTPUT:
2178  RETVAL