Magic.xs

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