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