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