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