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