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 #ifndef VMG_MULTIPLICITY
  40 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
  41 #  define VMG_MULTIPLICITY 1
  42 # else
  43 #  define VMG_MULTIPLICITY 0
  44 # endif
  45 #endif
  46 #if VMG_MULTIPLICITY && !defined(tTHX)
  47 # define tTHX PerlInterpreter*
  48 #endif
  49
  50 #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))
  51 # define VMG_THREADSAFE 1
  52 # ifndef MY_CXT_CLONE
  53 #  define MY_CXT_CLONE \
  54     dMY_CXT_SV;                                                      \
  55     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
  56     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
  57     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
  58 # endif
  59 #else
  60 # define VMG_THREADSAFE 0
  61 # undef  dMY_CXT
  62 # define dMY_CXT      dNOOP
  63 # undef  MY_CXT
  64 # define MY_CXT       vmg_globaldata
  65 # undef  START_MY_CXT
  66 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
  67 # undef  MY_CXT_INIT
  68 # define MY_CXT_INIT  NOOP
  69 # undef  MY_CXT_CLONE
  70 # define MY_CXT_CLONE NOOP
  71 #endif
  72
  73 #if VMG_THREADSAFE
  74
  75 STATIC SV *vmg_clone(pTHX_ SV *sv, tTHX owner) {
  76 #define vmg_clone(P, O) vmg_clone(aTHX_ (P), (O))
  77  CLONE_PARAMS param;
  78  param.stashes    = NULL; /* don't need it unless sv is a PVHV */
  79  param.flags      = 0;
  80  param.proto_perl = owner;
  81  return sv_dup(sv, &param);
  82 }
  83
  84 #endif /* VMG_THREADSAFE */
  85
  86 /* --- Compatibility ------------------------------------------------------- */
  87
  88 #ifndef Newx
  89 # define Newx(v, n, c) New(0, v, n, c)
  90 #endif
  91
  92 #ifndef NewOp
  93 # define NewOp(m, var, c, type) Newz(m, var, c, type)
  94 #endif
  95
  96 #ifndef SvMAGIC_set
  97 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
  98 #endif
  99
 100 #ifndef mPUSHu
 101 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
 102 #endif
 103
 104 #ifndef SvPV_const
 105 # define SvPV_const SvPV
 106 #endif
 107
 108 #ifndef PERL_MAGIC_ext
 109 # define PERL_MAGIC_ext '~'
 110 #endif
 111
 112 #ifndef PERL_MAGIC_tied
 113 # define PERL_MAGIC_tied 'P'
 114 #endif
 115
 116 #ifndef MGf_COPY
 117 # define MGf_COPY 0
 118 #endif
 119
 120 #ifndef MGf_DUP
 121 # define MGf_DUP 0
 122 #endif
 123
 124 #ifndef MGf_LOCAL
 125 # define MGf_LOCAL 0
 126 #endif
 127
 128 #ifndef IN_PERL_COMPILETIME
 129 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
 130 #endif
 131
 132 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
 133 # ifndef PL_error_count
 134 #  define PL_error_count PL_parser->error_count
 135 # endif
 136 #else
 137 # ifndef PL_error_count
 138 #  define PL_error_count PL_Ierror_count
 139 # endif
 140 #endif
 141
 142 /* uvar magic and Hash::Util::FieldHash were commited with 28419 */
 143 #if VMG_HAS_PERL_MAINT(5, 9, 4, 28419) || VMG_HAS_PERL(5, 10, 0)
 144 # define VMG_UVAR 1
 145 #else
 146 # define VMG_UVAR 0
 147 #endif
 148
 149 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160 */
 150 #ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
 151 # if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
 152 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
 153 # else
 154 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
 155 # endif
 156 #endif
 157
 158 /* Applied to dev-5.11 as 34908 */
 159 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908)
 160 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
 161 #else
 162 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
 163 #endif
 164
 165 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
 166 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
 167 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
 168 #else
 169 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
 170 #endif
 171
 172 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969)
 173 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
 174 #else
 175 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
 176 #endif
 177
 178 #if VMG_UVAR
 179
 180 /* Bug-free mg_magical - see http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html - but specialized to our needs. */
 181 STATIC void vmg_sv_magicuvar(pTHX_ SV *sv, const char *uf, I32 len) {
 182 #define vmg_sv_magicuvar(S, U, L) vmg_sv_magicuvar(aTHX_ (S), (U), (L))
 183  const MAGIC* mg;
 184  sv_magic(sv, NULL, PERL_MAGIC_uvar, uf, len);
 185  /* uvar magic has set and get magic, hence this has set SVs_GMG and SVs_SMG. */
 186  if ((mg = SvMAGIC(sv))) {
 187   SvRMAGICAL_off(sv);
 188   do {
 189    const MGVTBL* const vtbl = mg->mg_virtual;
 190    if (vtbl) {
 191     if (vtbl->svt_clear) {
 192      SvRMAGICAL_on(sv);
 193      break;
 194     }
 195    }
 196   } while ((mg = mg->mg_moremagic));
 197  }
 198 }
 199
 200 #endif /* VMG_UVAR */
 201
 202 /* --- Context-safe global data -------------------------------------------- */
 203
 204 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 205
 206 typedef struct {
 207  HV *wizards;
 208  HV *b__op_stash;
 209 } my_cxt_t;
 210
 211 START_MY_CXT
 212
 213 /* --- Signatures ---------------------------------------------------------- */
 214
 215 #define SIG_MIN ((U16) (1u << 8))
 216 #define SIG_MAX ((U16) ((1u << 16) - 1))
 217 #define SIG_NBR (SIG_MAX - SIG_MIN + 1)
 218 #define SIG_WIZ ((U16) ((1u << 8) - 1))
 219
 220 /* ... Generate signatures ................................................. */
 221
 222 STATIC U16 vmg_gensig(pTHX) {
 223 #define vmg_gensig() vmg_gensig(aTHX)
 224  U16 sig;
 225  char buf[8];
 226  dMY_CXT;
 227
 228  do {
 229   sig = SIG_NBR * Drand01() + SIG_MIN;
 230  } while (hv_exists(MY_CXT.wizards, buf, sprintf(buf, "%u", sig)));
 231
 232  return sig;
 233 }
 234
 235 /* --- MGWIZ structure ----------------------------------------------------- */
 236
 237 typedef struct {
 238  MGVTBL *vtbl;
 239
 240  U16 sig;
 241  U8 uvar;
 242  U8 opinfo;
 243
 244  SV *cb_data;
 245  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
 246 #if MGf_COPY
 247  SV *cb_copy;
 248 #endif /* MGf_COPY */
 249 #if MGf_DUP
 250  SV *cb_dup;
 251 #endif /* MGf_DUP */
 252 #if MGf_LOCAL
 253  SV *cb_local;
 254 #endif /* MGf_LOCAL */
 255 #if VMG_UVAR
 256  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
 257 #endif /* VMG_UVAR */
 258 #if VMG_MULTIPLICITY
 259  tTHX owner;
 260 #endif /* VMG_MULTIPLICITY */
 261 } MGWIZ;
 262
 263 #define MGWIZ2SV(W) (newSVuv(PTR2UV(W)))
 264 #define SV2MGWIZ(S) (INT2PTR(MGWIZ*, SvUVX((SV *) (S))))
 265
 266 /* ... Construct private data .............................................. */
 267
 268 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, AV *args) {
 269 #define vmg_data_new(C, S, A) vmg_data_new(aTHX_ (C), (S), (A))
 270  SV *nsv;
 271  I32 i, alen = (args == NULL) ? 0 : av_len(args);
 272
 273  dSP;
 274
 275  ENTER;
 276  SAVETMPS;
 277
 278  PUSHMARK(SP);
 279  EXTEND(SP, alen + 1);
 280  PUSHs(sv_2mortal(newRV_inc(sv)));
 281  for (i = 0; i < alen; ++i)
 282   PUSHs(*av_fetch(args, i, 0));
 283  PUTBACK;
 284
 285  call_sv(ctor, G_SCALAR);
 286
 287  SPAGAIN;
 288  nsv = POPs;
 289 #if VMG_HAS_PERL(5, 8, 3)
 290  SvREFCNT_inc(nsv);    /* Or it will be destroyed in FREETMPS */
 291 #else
 292  nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
 293 #endif
 294  PUTBACK;
 295
 296  FREETMPS;
 297  LEAVE;
 298
 299  return nsv;
 300 }
 301
 302 STATIC SV *vmg_data_get(SV *sv, U16 sig) {
 303  MAGIC *mg, *moremagic;
 304
 305  if (SvTYPE(sv) >= SVt_PVMG) {
 306   for (mg = SvMAGIC(sv); mg; mg = moremagic) {
 307    moremagic = mg->mg_moremagic;
 308    if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == sig)) { break; }
 309   }
 310   if (mg) { return mg->mg_obj; }
 311  }
 312
 313  return NULL;
 314 }
 315
 316 /* ... Magic cast/dispell .................................................. */
 317
 318 #if VMG_UVAR
 319 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
 320
 321 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 322  if (prevmagic) {
 323   prevmagic->mg_moremagic = moremagic;
 324  } else {
 325   SvMAGIC_set(sv, moremagic);
 326  }
 327  mg->mg_moremagic = NULL;
 328  Safefree(mg->mg_ptr);
 329  Safefree(mg);
 330 }
 331 #endif /* VMG_UVAR */
 332
 333 STATIC UV vmg_cast(pTHX_ SV *sv, SV *wiz, AV *args) {
 334 #define vmg_cast(S, W, A) vmg_cast(aTHX_ (S), (W), (A))
 335  MAGIC *mg = NULL, *moremagic = NULL;
 336  MGWIZ *w;
 337  SV *data;
 338  U32 oldgmg = SvGMAGICAL(sv);
 339
 340  w = SV2MGWIZ(wiz);
 341
 342  if (SvTYPE(sv) >= SVt_PVMG) {
 343   for (mg = SvMAGIC(sv); mg; mg = moremagic) {
 344    moremagic = mg->mg_moremagic;
 345    if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == w->sig)) { break; }
 346   }
 347   if (mg) { return 1; }
 348  }
 349
 350  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args) : NULL;
 351  mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
 352  mg->mg_private = w->sig;
 353 #if MGf_COPY
 354  if (w->cb_copy)
 355   mg->mg_flags |= MGf_COPY;
 356 #endif /* MGf_COPY */
 357 #if 0 /* MGf_DUP */
 358  if (w->cb_dup)
 359   mg->mg_flags |= MGf_DUP;
 360 #endif /* MGf_DUP */
 361 #if MGf_LOCAL
 362  if (w->cb_local)
 363   mg->mg_flags |= MGf_LOCAL;
 364 #endif /* MGf_LOCAL */
 365
 366  if (SvTYPE(sv) < SVt_PVHV)
 367   goto done;
 368
 369  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 370   * magic is actually never called for them. If the GMAGICAL flag was off before
 371   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 372   * now on, then this wizard has get magic. Hence we can work around the
 373   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 374   * has uvar callbacks, it will be turned back on later. */
 375  if (!oldgmg && SvGMAGICAL(sv))
 376   SvGMAGICAL_off(sv);
 377
 378 #if VMG_UVAR
 379  if (w->uvar) {
 380   MAGIC *prevmagic;
 381   struct ufuncs uf[2];
 382
 383   uf[0].uf_val   = vmg_svt_val;
 384   uf[0].uf_set   = NULL;
 385   uf[0].uf_index = 0;
 386   uf[1].uf_val   = NULL;
 387   uf[1].uf_set   = NULL;
 388   uf[1].uf_index = 0;
 389
 390   /* One uvar magic in the chain is enough. */
 391   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 392    moremagic = mg->mg_moremagic;
 393    if (mg->mg_type == PERL_MAGIC_uvar) { break; }
 394   }
 395
 396   if (mg) { /* Found another uvar magic. */
 397    struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
 398    if (olduf->uf_val == vmg_svt_val) {
 399     /* It's our uvar magic, nothing to do. oldgmg was true. */
 400     goto done;
 401    } else {
 402     /* It's another uvar magic, backup it and replace it by ours. */
 403     uf[1] = *olduf;
 404     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 405    }
 406   }
 407
 408   vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
 409   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
 410    * handled by our uvar callback. */
 411  }
 412 #endif /* VMG_UVAR */
 413
 414 done:
 415  return 1;
 416 }
 417
 418 STATIC UV vmg_dispell(pTHX_ SV *sv, U16 sig) {
 419 #define vmg_dispell(S, Z) vmg_dispell(aTHX_ (S), (Z))
 420 #if VMG_UVAR
 421  U32 uvars = 0;
 422 #endif /* VMG_UVAR */
 423  MAGIC *mg, *prevmagic, *moremagic = NULL;
 424
 425  if (SvTYPE(sv) < SVt_PVMG) { return 0; }
 426
 427  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 428   moremagic = mg->mg_moremagic;
 429   if (mg->mg_type == PERL_MAGIC_ext) {
 430    if (mg->mg_private == sig) {
 431 #if VMG_UVAR
 432     /* If the current has no uvar, short-circuit uvar deletion. */
 433     uvars = (SV2MGWIZ(mg->mg_ptr)->uvar) ? (uvars + 1) : 0;
 434 #endif /* VMG_UVAR */
 435     break;
 436 #if VMG_UVAR
 437    } else if ((mg->mg_private >= SIG_MIN) &&
 438               (mg->mg_private <= SIG_MAX) &&
 439                SV2MGWIZ(mg->mg_ptr)->uvar) {
 440     ++uvars;
 441     /* We can't break here since we need to find the ext magic to delete. */
 442 #endif /* VMG_UVAR */
 443    }
 444   }
 445  }
 446  if (!mg) { return 0; }
 447
 448  if (prevmagic) {
 449   prevmagic->mg_moremagic = moremagic;
 450  } else {
 451   SvMAGIC_set(sv, moremagic);
 452  }
 453  mg->mg_moremagic = NULL;
 454
 455  if (mg->mg_obj != sv) { SvREFCNT_dec(mg->mg_obj); } /* Destroy private data */
 456  SvREFCNT_dec((SV *) mg->mg_ptr); /* Unreference the wizard */
 457  Safefree(mg);
 458
 459 #if VMG_UVAR
 460  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
 461   /* mg was the first ext magic in the chain that had uvar */
 462
 463   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
 464    if ((mg->mg_type == PERL_MAGIC_ext) &&
 465        (mg->mg_private >= SIG_MIN) &&
 466        (mg->mg_private <= SIG_MAX) &&
 467         SV2MGWIZ(mg->mg_ptr)->uvar) {
 468     ++uvars;
 469     break;
 470    }
 471   }
 472
 473   if (uvars == 1) {
 474    struct ufuncs *uf;
 475    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
 476     moremagic = mg->mg_moremagic;
 477     if (mg->mg_type == PERL_MAGIC_uvar) { break; }
 478    }
 479    /* assert(mg); */
 480    uf = (struct ufuncs *) mg->mg_ptr;
 481    /* assert(uf->uf_val == vmg_svt_val); */
 482    if (uf[1].uf_val || uf[1].uf_set) {
 483     /* Revert the original uvar magic. */
 484     uf[0] = uf[1];
 485     Renew(uf, 1, struct ufuncs);
 486     mg->mg_ptr = (char *) uf;
 487     mg->mg_len = sizeof(struct ufuncs);
 488    } else {
 489     /* Remove the uvar magic. */
 490     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 491    }
 492   }
 493  }
 494 #endif /* VMG_UVAR */
 495
 496  return 1;
 497 }
 498
 499 /* ... OP info ............................................................. */
 500
 501 #define VMG_OP_INFO_NAME   1
 502 #define VMG_OP_INFO_OBJECT 2
 503
 504 STATIC U32           vmg_op_name_init      = 0;
 505 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
 506
 507 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
 508 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
 509  switch (opinfo) {
 510   case VMG_OP_INFO_NAME:
 511    if (!vmg_op_name_init) {
 512     OPCODE t;
 513     for (t = 0; t < OP_max; ++t)
 514      vmg_op_name_len[t] = strlen(PL_op_name[t]);
 515     vmg_op_name_init = 1;
 516    }
 517    break;
 518   case VMG_OP_INFO_OBJECT: {
 519    dMY_CXT;
 520    if (!MY_CXT.b__op_stash) {
 521     require_pv("B.pm");
 522     MY_CXT.b__op_stash = gv_stashpv("B::OP", 1);
 523    }
 524    break;
 525   }
 526   default:
 527    break;
 528  }
 529 }
 530
 531 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
 532 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
 533  if (!PL_op)
 534   return &PL_sv_undef;
 535
 536  switch (opinfo) {
 537   case VMG_OP_INFO_NAME: {
 538    OPCODE t = PL_op->op_type;
 539    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
 540   }
 541   case VMG_OP_INFO_OBJECT: {
 542    dMY_CXT;
 543    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
 544                               MY_CXT.b__op_stash);
 545   }
 546   default:
 547    break;
 548  }
 549
 550  return &PL_sv_undef;
 551 }
 552
 553 /* ... svt callbacks ....................................................... */
 554
 555 #define VMG_CB_CALL_SET_RET(D) \
 556  {            \
 557   SV *svr;    \
 558   SPAGAIN;    \
 559   svr = POPs; \
 560   ret = SvOK(svr) ? SvIV(svr) : (D); \
 561   PUTBACK;    \
 562  }
 563
 564 #define VMG_CB_CALL_ARGS_MASK  15
 565 #define VMG_CB_CALL_ARGS_SHIFT 4
 566 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
 567
 568 STATIC int vmg_cb_call(pTHX_ SV *cb, SV *sv, SV *data, unsigned int flags, ...){
 569  va_list ap;
 570  int ret;
 571  unsigned int i, args, opinfo;
 572
 573  dSP;
 574
 575  args    = flags & VMG_CB_CALL_ARGS_MASK;
 576  flags >>= VMG_CB_CALL_ARGS_SHIFT;
 577  opinfo  = flags & VMG_CB_CALL_OPINFO;
 578
 579  ENTER;
 580  SAVETMPS;
 581
 582  PUSHMARK(SP);
 583  EXTEND(SP, args + 2);
 584  PUSHs(sv_2mortal(newRV_inc(sv)));
 585  PUSHs(data ? data : &PL_sv_undef);
 586  va_start(ap, flags);
 587  for (i = 0; i < args; ++i) {
 588   SV *sva = va_arg(ap, SV *);
 589   PUSHs(sva ? sva : &PL_sv_undef);
 590  }
 591  va_end(ap);
 592  if (opinfo)
 593   XPUSHs(vmg_op_info(opinfo));
 594  PUTBACK;
 595
 596  call_sv(cb, G_SCALAR);
 597
 598  VMG_CB_CALL_SET_RET(0);
 599
 600  FREETMPS;
 601  LEAVE;
 602
 603  return ret;
 604 }
 605
 606 #define vmg_cb_call1(I, S, D) \
 607         vmg_cb_call(aTHX_ (I), (S), (D), (flags << VMG_CB_CALL_ARGS_SHIFT))
 608 #define vmg_cb_call2(I, S, D, S2) \
 609         vmg_cb_call(aTHX_ (I), (S), (D), ((flags << VMG_CB_CALL_ARGS_SHIFT) | 1), (S2))
 610 #define vmg_cb_call3(I, S, D, S2, S3) \
 611         vmg_cb_call(aTHX_ (I), (S), (D), ((flags << VMG_CB_CALL_ARGS_SHIFT) | 2), (S2), (S3))
 612
 613 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
 614  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 615  unsigned int flags = w->opinfo;
 616  return vmg_cb_call1(w->cb_get, sv, mg->mg_obj);
 617 }
 618
 619 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
 620  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 621  unsigned int flags = w->opinfo;
 622  return vmg_cb_call1(w->cb_set, sv, mg->mg_obj);
 623 }
 624
 625 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
 626  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 627  unsigned int opinfo = w->opinfo;
 628  U32 len, ret;
 629  svtype t = SvTYPE(sv);
 630
 631  dSP;
 632
 633  ENTER;
 634  SAVETMPS;
 635
 636  PUSHMARK(SP);
 637  EXTEND(SP, 3);
 638  PUSHs(sv_2mortal(newRV_inc(sv)));
 639  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
 640  if (t < SVt_PVAV) {
 641   STRLEN l;
 642   U8 *s = (U8 *) SvPV_const(sv, l);
 643   if (DO_UTF8(sv))
 644    len = utf8_length(s, s + l);
 645   else
 646    len = l;
 647   mPUSHu(len);
 648  } else if (t == SVt_PVAV) {
 649   len = av_len((AV *) sv) + 1;
 650   mPUSHu(len);
 651  } else {
 652   len = 0;
 653   PUSHs(&PL_sv_undef);
 654  }
 655  if (opinfo)
 656   XPUSHs(vmg_op_info(opinfo));
 657  PUTBACK;
 658
 659  call_sv(w->cb_len, G_SCALAR);
 660
 661  VMG_CB_CALL_SET_RET(len);
 662
 663  FREETMPS;
 664  LEAVE;
 665
 666  return t == SVt_PVAV ? ret - 1 : ret;
 667 }
 668
 669 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
 670  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 671  unsigned int flags = w->opinfo;
 672  return vmg_cb_call1(w->cb_clear, sv, mg->mg_obj);
 673 }
 674
 675 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
 676  const MGWIZ *w;
 677  unsigned int had_err, has_err, flags = G_SCALAR | G_EVAL;
 678  int ret = 0;
 679
 680  dSP;
 681
 682  /* Don't even bother if we are in global destruction - the wizard is prisoner
 683   * of circular references and we are way beyond user realm */
 684  if (PL_dirty)
 685   return 0;
 686
 687  w = SV2MGWIZ(mg->mg_ptr);
 688
 689  /* So that it survives the temp cleanup below */
 690  SvREFCNT_inc(sv);
 691
 692 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
 693  /* The previous magic tokens were freed but the magic chain wasn't updated, so
 694   * if you access the sv from the callback the old deleted magics will trigger
 695   * and cause memory misreads. Change 32686 solved it that way : */
 696  SvMAGIC_set(sv, mg);
 697 #endif
 698
 699  ENTER;
 700  SAVETMPS;
 701
 702  PUSHMARK(SP);
 703  EXTEND(SP, 2);
 704  PUSHs(sv_2mortal(newRV_inc(sv)));
 705  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
 706  if (w->opinfo)
 707   XPUSHs(vmg_op_info(w->opinfo));
 708  PUTBACK;
 709
 710  had_err = SvTRUE(ERRSV);
 711  if (had_err)
 712   flags |= G_KEEPERR;
 713
 714  call_sv(w->cb_free, flags);
 715
 716  has_err = SvTRUE(ERRSV);
 717  if (IN_PERL_COMPILETIME && !had_err && has_err)
 718   ++PL_error_count;
 719
 720  VMG_CB_CALL_SET_RET(0);
 721
 722  FREETMPS;
 723  LEAVE;
 724
 725  if (has_err) {
 726   /* Get the eval context that was pushed by call_sv, and fake an entry for the
 727    * namesv, as die_where will need it to be non NULL later */
 728   PERL_CONTEXT *cx = cxstack + cxstack_ix + 1;
 729   if (!cx->blk_eval.old_namesv)
 730    cx->blk_eval.old_namesv
 731                  = sv_2mortal(newSVpvn_share("Variable/Magic/DUMMY.pm", 23, 0));
 732  }
 733
 734  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
 735   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
 736  --SvREFCNT(sv);
 737
 738  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
 739   * mg->mg_ptr reference count */
 740  return ret;
 741 }
 742
 743 #if MGf_COPY
 744 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
 745 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
 746   I32 keylen
 747 # else
 748   int keylen
 749 # endif
 750  ) {
 751  SV *keysv;
 752  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 753  unsigned int flags = w->opinfo;
 754  int ret;
 755
 756  if (keylen == HEf_SVKEY) {
 757   keysv = (SV *) key;
 758  } else {
 759   keysv = newSVpvn(key, keylen);
 760  }
 761
 762  ret = vmg_cb_call3(w->cb_copy, sv, mg->mg_obj, keysv, nsv);
 763
 764  if (keylen != HEf_SVKEY) {
 765   SvREFCNT_dec(keysv);
 766  }
 767
 768  return ret;
 769 }
 770 #endif /* MGf_COPY */
 771
 772 #if 0 /*  MGf_DUP */
 773 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
 774  return 0;
 775 }
 776 #endif /* MGf_DUP */
 777
 778 #if MGf_LOCAL
 779 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
 780  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 781  unsigned int flags = w->opinfo;
 782  return vmg_cb_call1(w->cb_local, nsv, mg->mg_obj);
 783 }
 784 #endif /* MGf_LOCAL */
 785
 786 #if VMG_UVAR
 787 STATIC OP *vmg_pp_resetuvar(pTHX) {
 788  SvRMAGICAL_on(cSVOP_sv);
 789  return NORMAL;
 790 }
 791
 792 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
 793  struct ufuncs *uf;
 794  MAGIC *mg, *umg;
 795  SV *key = NULL, *newkey = NULL;
 796  int tied = 0;
 797
 798  umg = mg_find(sv, PERL_MAGIC_uvar);
 799  /* umg can't be NULL or we wouldn't be there. */
 800  key = umg->mg_obj;
 801  uf  = (struct ufuncs *) umg->mg_ptr;
 802
 803  if (uf[1].uf_val != NULL) { uf[1].uf_val(aTHX_ action, sv); }
 804  if (uf[1].uf_set != NULL) { uf[1].uf_set(aTHX_ action, sv); }
 805
 806  action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
 807  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 808   const MGWIZ *w;
 809   unsigned int flags;
 810   switch (mg->mg_type) {
 811    case PERL_MAGIC_ext:
 812     break;
 813    case PERL_MAGIC_tied:
 814     ++tied;
 815     continue;
 816    default:
 817     continue;
 818   }
 819   if (mg->mg_private < SIG_MIN || mg->mg_private > SIG_MAX)
 820    continue;
 821   w = SV2MGWIZ(mg->mg_ptr);
 822   flags = w->opinfo;
 823   switch (w->uvar) {
 824    case 0:
 825     continue;
 826    case 2:
 827     if (!newkey)
 828      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
 829   }
 830   switch (action) {
 831    case 0:
 832     if (w->cb_fetch)  { vmg_cb_call2(w->cb_fetch,  sv, mg->mg_obj, key); }
 833     break;
 834    case HV_FETCH_ISSTORE:
 835    case HV_FETCH_LVALUE:
 836    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
 837     if (w->cb_store)  { vmg_cb_call2(w->cb_store,  sv, mg->mg_obj, key); }
 838     break;
 839    case HV_FETCH_ISEXISTS:
 840     if (w->cb_exists) { vmg_cb_call2(w->cb_exists, sv, mg->mg_obj, key); }
 841     break;
 842    case HV_DELETE:
 843     if (w->cb_delete) { vmg_cb_call2(w->cb_delete, sv, mg->mg_obj, key); }
 844     break;
 845   }
 846  }
 847
 848  if (SvRMAGICAL(sv) && !tied) {
 849   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
 850    * mistaken for a tied hash by the rest of hv_common. It will be reset by
 851    * the op_ppaddr of a new fake op injected between the current and the next
 852    * one. */
 853   OP *o = PL_op;
 854   if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
 855    SVOP *svop;
 856    NewOp(1101, svop, 1, SVOP);
 857    svop->op_type   = OP_STUB;
 858    svop->op_ppaddr = vmg_pp_resetuvar;
 859    svop->op_next   = o->op_next;
 860    svop->op_flags  = 0;
 861    svop->op_sv     = sv;
 862    o->op_next      = (OP *) svop;
 863   }
 864   SvRMAGICAL_off(sv);
 865  }
 866
 867  return 0;
 868 }
 869 #endif /* VMG_UVAR */
 870
 871 /* ... Wizard destructor ................................................... */
 872
 873 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
 874  char buf[8];
 875  MGWIZ *w;
 876
 877  if (PL_dirty) /* During global destruction, the context is already freed */
 878   return 0;
 879
 880  w = SV2MGWIZ(wiz);
 881 #if VMG_MULTIPLICITY
 882  if (w->owner != aTHX)
 883   return 0;
 884  w->owner = NULL;
 885 #endif /* VMG_MULTIPLICITY */
 886
 887  {
 888   dMY_CXT;
 889   if (hv_delete(MY_CXT.wizards, buf, sprintf(buf, "%u", w->sig), 0) != wiz)
 890    return 0;
 891  }
 892  SvFLAGS(wiz) |= SVf_BREAK;
 893  FREETMPS;
 894
 895  if (w->cb_data  != NULL) { SvREFCNT_dec(SvRV(w->cb_data)); }
 896  if (w->cb_get   != NULL) { SvREFCNT_dec(SvRV(w->cb_get)); }
 897  if (w->cb_set   != NULL) { SvREFCNT_dec(SvRV(w->cb_set)); }
 898  if (w->cb_len   != NULL) { SvREFCNT_dec(SvRV(w->cb_len)); }
 899  if (w->cb_clear != NULL) { SvREFCNT_dec(SvRV(w->cb_clear)); }
 900  if (w->cb_free  != NULL) { SvREFCNT_dec(SvRV(w->cb_free)); }
 901 #if MGf_COPY
 902  if (w->cb_copy  != NULL) { SvREFCNT_dec(SvRV(w->cb_copy)); }
 903 #endif /* MGf_COPY */
 904 #if 0 /* MGf_DUP */
 905  if (w->cb_dup   != NULL) { SvREFCNT_dec(SvRV(w->cb_dup)); }
 906 #endif /* MGf_DUP */
 907 #if MGf_LOCAL
 908  if (w->cb_local != NULL) { SvREFCNT_dec(SvRV(w->cb_local)); }
 909 #endif /* MGf_LOCAL */
 910 #if VMG_UVAR
 911  if (w->cb_fetch  != NULL) { SvREFCNT_dec(SvRV(w->cb_fetch)); }
 912  if (w->cb_store  != NULL) { SvREFCNT_dec(SvRV(w->cb_store)); }
 913  if (w->cb_exists != NULL) { SvREFCNT_dec(SvRV(w->cb_exists)); }
 914  if (w->cb_delete != NULL) { SvREFCNT_dec(SvRV(w->cb_delete)); }
 915 #endif /* VMG_UVAR */
 916
 917  Safefree(w->vtbl);
 918  Safefree(w);
 919
 920  return 0;
 921 }
 922
 923 STATIC MGVTBL vmg_wizard_vtbl = {
 924  NULL,            /* get */
 925  NULL,            /* set */
 926  NULL,            /* len */
 927  NULL,            /* clear */
 928  vmg_wizard_free, /* free */
 929 #if MGf_COPY
 930  NULL,            /* copy */
 931 #endif /* MGf_COPY */
 932 #if MGf_DUP
 933  NULL,            /* dup */
 934 #endif /* MGf_DUP */
 935 #if MGf_LOCAL
 936  NULL,            /* local */
 937 #endif /* MGf_LOCAL */
 938 };
 939
 940 STATIC const char vmg_invalid_wiz[]    = "Invalid wizard object";
 941 STATIC const char vmg_invalid_sig[]    = "Invalid numeric signature";
 942 STATIC const char vmg_wrongargnum[]    = "Wrong number of arguments";
 943 STATIC const char vmg_toomanysigs[]    = "Too many magic signatures used";
 944 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
 945 STATIC const char vmg_globstorefail[]  = "Couldn't store global wizard information";
 946
 947 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
 948 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
 949  U16 sig;
 950
 951  if (SvIOK(sv)) {
 952   sig = SvUVX(sv);
 953  } else if (SvNOK(sv)) {
 954   sig = SvNVX(sv);
 955  } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
 956   sig = SvUV(sv);
 957  } else {
 958   croak(vmg_invalid_sig);
 959  }
 960  if (sig < SIG_MIN) { sig += SIG_MIN; }
 961  if (sig > SIG_MAX) { sig %= SIG_MAX + 1; }
 962
 963  return sig;
 964 }
 965
 966 STATIC U16 vmg_wizard_sig(pTHX_ SV *wiz) {
 967 #define vmg_wizard_sig(W) vmg_wizard_sig(aTHX_ (W))
 968  char buf[8];
 969  U16 sig;
 970
 971  if (SvROK(wiz)) {
 972   sig = SV2MGWIZ(SvRV(wiz))->sig;
 973  } else if (SvOK(wiz)) {
 974   sig = vmg_sv2sig(wiz);
 975  } else {
 976   croak(vmg_invalid_wiz);
 977  }
 978
 979  {
 980   dMY_CXT;
 981   if (!hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0))
 982    sig = 0;
 983  }
 984  return sig;
 985 }
 986
 987 STATIC SV *vmg_wizard_wiz(pTHX_ SV *wiz) {
 988 #define vmg_wizard_wiz(W) vmg_wizard_wiz(aTHX_ (W))
 989  char buf[8];
 990  SV **old;
 991  U16 sig;
 992
 993  if (SvROK(wiz)) {
 994   wiz = SvRV(wiz);
 995 #if VMG_MULTIPLICITY
 996   if (SV2MGWIZ(wiz)->owner == aTHX)
 997    return wiz;
 998 #endif /* VMG_MULTIPLICITY */
 999   sig = SV2MGWIZ(wiz)->sig;
1000  } else if (SvOK(wiz)) {
1001   sig = vmg_sv2sig(wiz);
1002  } else {
1003   croak(vmg_invalid_wiz);
1004  }
1005
1006  {
1007   dMY_CXT;
1008   return (old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0))
1009           ? *old : NULL;
1010  }
1011 }
1012
1013 #define VMG_SET_CB(S, N)              \
1014  cb = (S);                            \
1015  w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
1016
1017 #define VMG_SET_SVT_CB(S, N)          \
1018  cb = (S);                            \
1019  if (SvOK(cb) && SvROK(cb)) {         \
1020   t->svt_ ## N = vmg_svt_ ## N;       \
1021   w->cb_  ## N = newRV_inc(SvRV(cb)); \
1022  } else {                             \
1023   t->svt_ ## N = NULL;                \
1024   w->cb_  ## N = NULL;                \
1025  }
1026
1027 #if VMG_THREADSAFE
1028
1029 #define VMG_CLONE_CB(N) \
1030  z->cb_ ## N = (w->cb_ ## N) ? newRV_inc(vmg_clone(SvRV(w->cb_ ## N), \
1031                                          w->owner))                   \
1032                              : NULL;
1033
1034 STATIC MGWIZ *vmg_wizard_clone(pTHX_ const MGWIZ *w) {
1035 #define vmg_wizard_clone(W) vmg_wizard_clone(aTHX_ (W))
1036  MGVTBL *t;
1037  MGWIZ *z;
1038
1039  Newx(t, 1, MGVTBL);
1040  Copy(w->vtbl, t, 1, MGVTBL);
1041
1042  Newx(z, 1, MGWIZ);
1043  VMG_CLONE_CB(data);
1044  VMG_CLONE_CB(get);
1045  VMG_CLONE_CB(set);
1046  VMG_CLONE_CB(len);
1047  VMG_CLONE_CB(clear);
1048  VMG_CLONE_CB(free);
1049 #if MGf_COPY
1050  VMG_CLONE_CB(copy);
1051 #endif /* MGf_COPY */
1052 #if MGf_DUP
1053  VMG_CLONE_CB(dup);
1054 #endif /* MGf_DUP */
1055 #if MGf_LOCAL
1056  VMG_CLONE_CB(local);
1057 #endif /* MGf_LOCAL */
1058 #if VMG_UVAR
1059  VMG_CLONE_CB(fetch);
1060  VMG_CLONE_CB(store);
1061  VMG_CLONE_CB(exists);
1062  VMG_CLONE_CB(delete);
1063 #endif /* VMG_UVAR */
1064  z->owner  = aTHX;
1065  z->vtbl   = t;
1066  z->sig    = w->sig;
1067  z->uvar   = w->uvar;
1068  z->opinfo = w->opinfo;
1069
1070  return z;
1071 }
1072
1073 #endif /* VMG_THREADSAFE */
1074
1075 /* --- XS ------------------------------------------------------------------ */
1076
1077 MODULE = Variable::Magic            PACKAGE = Variable::Magic
1078
1079 PROTOTYPES: ENABLE
1080
1081 BOOT:
1082 {
1083  HV *stash;
1084  MY_CXT_INIT;
1085  MY_CXT.wizards = newHV();
1086  hv_iterinit(MY_CXT.wizards); /* Allocate iterator */
1087  MY_CXT.b__op_stash = NULL;
1088  stash = gv_stashpv(__PACKAGE__, 1);
1089  newCONSTSUB(stash, "SIG_MIN",   newSVuv(SIG_MIN));
1090  newCONSTSUB(stash, "SIG_MAX",   newSVuv(SIG_MAX));
1091  newCONSTSUB(stash, "SIG_NBR",   newSVuv(SIG_NBR));
1092  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1093  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1094  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1095  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1096  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1097                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1098  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1099                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1100  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1101                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1102  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1103                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1104  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1105  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1106  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1107  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1108 }
1109
1110 #if VMG_THREADSAFE
1111
1112 void
1113 CLONE(...)
1114 PROTOTYPE: DISABLE
1115 PREINIT:
1116  HV *hv;
1117  U32 had_b__op_stash = 0;
1118 CODE:
1119  {
1120   HE *key;
1121   dMY_CXT;
1122   hv = newHV();
1123   hv_iterinit(hv); /* Allocate iterator */
1124   hv_iterinit(MY_CXT.wizards);
1125   while ((key = hv_iternext(MY_CXT.wizards))) {
1126    STRLEN len;
1127    char *sig = HePV(key, len);
1128    SV *sv;
1129    const MGWIZ *w;
1130    MAGIC *mg;
1131    w  = SV2MGWIZ(HeVAL(key));
1132    w  = vmg_wizard_clone(w);
1133    sv = MGWIZ2SV(w);
1134    mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1135    mg->mg_private = SIG_WIZ;
1136    SvREADONLY_on(sv);
1137    if (!hv_store(hv, sig, len, sv, HeHASH(key))) croak("%s during CLONE", vmg_globstorefail);
1138   }
1139   if (MY_CXT.b__op_stash)
1140    had_b__op_stash = 1;
1141  }
1142  {
1143   MY_CXT_CLONE;
1144   MY_CXT.wizards     = hv;
1145   MY_CXT.b__op_stash = had_b__op_stash ? gv_stashpv("B::OP", 1) : NULL;
1146  }
1147
1148 #endif /* VMG_THREADSAFE */
1149
1150 SV *_wizard(...)
1151 PROTOTYPE: DISABLE
1152 PREINIT:
1153  I32 i = 0;
1154  U16 sig;
1155  char buf[8];
1156  MGWIZ *w;
1157  MGVTBL *t;
1158  MAGIC *mg;
1159  SV *sv;
1160  SV *svsig;
1161  SV *cb;
1162 CODE:
1163  dMY_CXT;
1164
1165  if (items != 8
1166 #if MGf_COPY
1167               + 1
1168 #endif /* MGf_COPY */
1169 #if MGf_DUP
1170               + 1
1171 #endif /* MGf_DUP */
1172 #if MGf_LOCAL
1173               + 1
1174 #endif /* MGf_LOCAL */
1175 #if VMG_UVAR
1176               + 5
1177 #endif /* VMG_UVAR */
1178               ) { croak(vmg_wrongargnum); }
1179
1180  svsig = ST(i++);
1181  if (SvOK(svsig)) {
1182   SV **old;
1183   sig = vmg_sv2sig(svsig);
1184   if ((old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0))) {
1185    ST(0) = sv_2mortal(newRV_inc(*old));
1186    XSRETURN(1);
1187   }
1188  } else {
1189   if (HvKEYS(MY_CXT.wizards) >= SIG_NBR) { croak(vmg_toomanysigs); }
1190   sig = vmg_gensig();
1191  }
1192
1193  Newx(t, 1, MGVTBL);
1194  Newx(w, 1, MGWIZ);
1195
1196  VMG_SET_CB(ST(i++), data);
1197  cb = ST(i++);
1198  w->opinfo = SvOK(cb) ? SvUV(cb) : 0;
1199  if (w->opinfo)
1200   vmg_op_info_init(w->opinfo);
1201  VMG_SET_SVT_CB(ST(i++), get);
1202  VMG_SET_SVT_CB(ST(i++), set);
1203  VMG_SET_SVT_CB(ST(i++), len);
1204  VMG_SET_SVT_CB(ST(i++), clear);
1205  VMG_SET_SVT_CB(ST(i++), free);
1206 #if MGf_COPY
1207  VMG_SET_SVT_CB(ST(i++), copy);
1208 #endif /* MGf_COPY */
1209 #if MGf_DUP
1210  /* VMG_SET_SVT_CB(ST(i++), dup); */
1211  i++;
1212  t->svt_dup = NULL;
1213  w->cb_dup  = NULL;
1214 #endif /* MGf_DUP */
1215 #if MGf_LOCAL
1216  VMG_SET_SVT_CB(ST(i++), local);
1217 #endif /* MGf_LOCAL */
1218 #if VMG_UVAR
1219  VMG_SET_CB(ST(i++), fetch);
1220  VMG_SET_CB(ST(i++), store);
1221  VMG_SET_CB(ST(i++), exists);
1222  VMG_SET_CB(ST(i++), delete);
1223  cb = ST(i++);
1224  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1225   w->uvar = SvTRUE(cb) ? 2 : 1;
1226  else
1227   w->uvar = 0;
1228 #endif /* VMG_UVAR */
1229 #if VMG_MULTIPLICITY
1230  w->owner = aTHX;
1231 #endif /* VMG_MULTIPLICITY */
1232  w->vtbl  = t;
1233  w->sig   = sig;
1234
1235  sv = MGWIZ2SV(w);
1236  mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1237  mg->mg_private = SIG_WIZ;
1238  SvREADONLY_on(sv);
1239
1240  if (!hv_store(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), sv, 0)) croak(vmg_globstorefail);
1241
1242  RETVAL = newRV_noinc(sv);
1243 OUTPUT:
1244  RETVAL
1245
1246 SV *gensig()
1247 PROTOTYPE:
1248 CODE:
1249  dMY_CXT;
1250  if (HvKEYS(MY_CXT.wizards) >= SIG_NBR) { croak(vmg_toomanysigs); }
1251  RETVAL = newSVuv(vmg_gensig());
1252 OUTPUT:
1253  RETVAL
1254
1255 SV *getsig(SV *wiz)
1256 PROTOTYPE: $
1257 CODE:
1258  if (!SvROK(wiz)) { croak(vmg_invalid_wiz); }
1259  RETVAL = newSVuv(SV2MGWIZ(SvRV(wiz))->sig);
1260 OUTPUT:
1261  RETVAL
1262
1263 SV *cast(SV *sv, SV *wiz, ...)
1264 PROTOTYPE: \[$@%&*]$@
1265 PREINIT:
1266  AV *args = NULL;
1267  SV *ret;
1268 CODE:
1269  wiz = vmg_wizard_wiz(wiz);
1270  if (!wiz)
1271   XSRETURN_UNDEF;
1272  if (items > 2) {
1273   I32 i;
1274   args = newAV();
1275   av_fill(args, items - 2);
1276   for (i = 2; i < items; ++i) {
1277    SV *arg = ST(i);
1278    SvREFCNT_inc(arg);
1279    if (av_store(args, i - 2, arg) == NULL) { croak(vmg_argstorefailed); }
1280   }
1281  }
1282  ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1283  SvREFCNT_dec(args);
1284  RETVAL = ret;
1285 OUTPUT:
1286  RETVAL
1287
1288 void
1289 getdata(SV *sv, SV *wiz)
1290 PROTOTYPE: \[$@%&*]$
1291 PREINIT:
1292  SV *data;
1293  U16 sig;
1294 PPCODE:
1295  sig = vmg_wizard_sig(wiz);
1296  if (!sig)
1297   XSRETURN_UNDEF;
1298  data = vmg_data_get(SvRV(sv), sig);
1299  if (!data) { XSRETURN_UNDEF; }
1300  ST(0) = data;
1301  XSRETURN(1);
1302
1303 SV *dispell(SV *sv, SV *wiz)
1304 PROTOTYPE: \[$@%&*]$
1305 PREINIT:
1306  U16 sig;
1307 CODE:
1308  sig = vmg_wizard_sig(wiz);
1309  if (!sig)
1310   XSRETURN_UNDEF;
1311  RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));
1312 OUTPUT:
1313  RETVAL