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