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