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) { break; }
 518   }
 519
 520   if (mg) { /* Found another uvar magic. */
 521    struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
 522    if (olduf->uf_val == vmg_svt_val) {
 523     /* It's our uvar magic, nothing to do. oldgmg was true. */
 524     goto done;
 525    } else {
 526     /* It's another uvar magic, backup it and replace it by ours. */
 527     uf[1] = *olduf;
 528     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 529    }
 530   }
 531
 532   vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
 533   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
 534    * handled by our uvar callback. */
 535  }
 536 #endif /* VMG_UVAR */
 537
 538 done:
 539  return 1;
 540 }
 541
 542 STATIC UV vmg_dispell(pTHX_ SV *sv, U16 sig) {
 543 #define vmg_dispell(S, Z) vmg_dispell(aTHX_ (S), (Z))
 544 #if VMG_UVAR
 545  U32 uvars = 0;
 546 #endif /* VMG_UVAR */
 547  MAGIC *mg, *prevmagic, *moremagic = NULL;
 548
 549  if (SvTYPE(sv) < SVt_PVMG) { return 0; }
 550
 551  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 552   moremagic = mg->mg_moremagic;
 553   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
 554    MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 555    if (w->sig == sig) {
 556 #if VMG_UVAR
 557     /* If the current has no uvar, short-circuit uvar deletion. */
 558     uvars = w->uvar ? (uvars + 1) : 0;
 559 #endif /* VMG_UVAR */
 560     break;
 561 #if VMG_UVAR
 562    } else if (w->uvar) {
 563     ++uvars;
 564     /* We can't break here since we need to find the ext magic to delete. */
 565 #endif /* VMG_UVAR */
 566    }
 567   }
 568  }
 569  if (!mg) { return 0; }
 570
 571  if (prevmagic) {
 572   prevmagic->mg_moremagic = moremagic;
 573  } else {
 574   SvMAGIC_set(sv, moremagic);
 575  }
 576  mg->mg_moremagic = NULL;
 577
 578  if (mg->mg_obj != sv) { SvREFCNT_dec(mg->mg_obj); } /* Destroy private data */
 579  SvREFCNT_dec((SV *) mg->mg_ptr); /* Unreference the wizard */
 580  Safefree(mg);
 581
 582 #if VMG_UVAR
 583  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
 584   /* mg was the first ext magic in the chain that had uvar */
 585
 586   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
 587    if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
 588     MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 589     if (w->uvar) {
 590      ++uvars;
 591      break;
 592     }
 593    }
 594   }
 595
 596   if (uvars == 1) {
 597    struct ufuncs *uf;
 598    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
 599     moremagic = mg->mg_moremagic;
 600     if (mg->mg_type == PERL_MAGIC_uvar) { break; }
 601    }
 602    /* assert(mg); */
 603    uf = (struct ufuncs *) mg->mg_ptr;
 604    /* assert(uf->uf_val == vmg_svt_val); */
 605    if (uf[1].uf_val || uf[1].uf_set) {
 606     /* Revert the original uvar magic. */
 607     uf[0] = uf[1];
 608     Renew(uf, 1, struct ufuncs);
 609     mg->mg_ptr = (char *) uf;
 610     mg->mg_len = sizeof(struct ufuncs);
 611    } else {
 612     /* Remove the uvar magic. */
 613     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 614    }
 615   }
 616  }
 617 #endif /* VMG_UVAR */
 618
 619  return 1;
 620 }
 621
 622 /* ... OP info ............................................................. */
 623
 624 #define VMG_OP_INFO_NAME   1
 625 #define VMG_OP_INFO_OBJECT 2
 626
 627 #if VMG_THREADSAFE
 628 STATIC perl_mutex vmg_op_name_init_mutex;
 629 #endif
 630
 631 STATIC U32           vmg_op_name_init      = 0;
 632 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
 633
 634 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
 635 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
 636  switch (opinfo) {
 637   case VMG_OP_INFO_NAME:
 638 #if VMG_THREADSAFE
 639    MUTEX_LOCK(&vmg_op_name_init_mutex);
 640 #endif
 641    if (!vmg_op_name_init) {
 642     OPCODE t;
 643     for (t = 0; t < OP_max; ++t)
 644      vmg_op_name_len[t] = strlen(PL_op_name[t]);
 645     vmg_op_name_init = 1;
 646    }
 647 #if VMG_THREADSAFE
 648    MUTEX_UNLOCK(&vmg_op_name_init_mutex);
 649 #endif
 650    break;
 651   case VMG_OP_INFO_OBJECT: {
 652    dMY_CXT;
 653    if (!MY_CXT.b__op_stashes[0]) {
 654     opclass c;
 655     require_pv("B.pm");
 656     for (c = 0; c < OPc_MAX; ++c)
 657      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
 658    }
 659    break;
 660   }
 661   default:
 662    break;
 663  }
 664 }
 665
 666 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
 667 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
 668  if (!PL_op)
 669   return &PL_sv_undef;
 670
 671  switch (opinfo) {
 672   case VMG_OP_INFO_NAME: {
 673    OPCODE t = PL_op->op_type;
 674    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
 675   }
 676   case VMG_OP_INFO_OBJECT: {
 677    dMY_CXT;
 678    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
 679                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
 680   }
 681   default:
 682    break;
 683  }
 684
 685  return &PL_sv_undef;
 686 }
 687
 688 /* ... svt callbacks ....................................................... */
 689
 690 #define VMG_CB_CALL_SET_RET(D) \
 691  {            \
 692   SV *svr;    \
 693   SPAGAIN;    \
 694   svr = POPs; \
 695   ret = SvOK(svr) ? SvIV(svr) : (D); \
 696   PUTBACK;    \
 697  }
 698
 699 #define VMG_CB_CALL_ARGS_MASK  15
 700 #define VMG_CB_CALL_ARGS_SHIFT 4
 701 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
 702
 703 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
 704  va_list ap;
 705  int ret;
 706  unsigned int i, args, opinfo;
 707
 708  dSP;
 709
 710  args    = flags & VMG_CB_CALL_ARGS_MASK;
 711  flags >>= VMG_CB_CALL_ARGS_SHIFT;
 712  opinfo  = flags & VMG_CB_CALL_OPINFO;
 713
 714  ENTER;
 715  SAVETMPS;
 716
 717  PUSHMARK(SP);
 718  EXTEND(SP, args + 1);
 719  PUSHs(sv_2mortal(newRV_inc(sv)));
 720  va_start(ap, sv);
 721  for (i = 0; i < args; ++i) {
 722   SV *sva = va_arg(ap, SV *);
 723   PUSHs(sva ? sva : &PL_sv_undef);
 724  }
 725  va_end(ap);
 726  if (opinfo)
 727   XPUSHs(vmg_op_info(opinfo));
 728  PUTBACK;
 729
 730  call_sv(cb, G_SCALAR);
 731
 732  VMG_CB_CALL_SET_RET(0);
 733
 734  FREETMPS;
 735  LEAVE;
 736
 737  return ret;
 738 }
 739
 740 #define vmg_cb_call1(I, F, S, A1) \
 741         vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 1), (S), (A1))
 742 #define vmg_cb_call2(I, F, S, A1, A2) \
 743         vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 2), (S), (A1), (A2))
 744 #define vmg_cb_call3(I, F, S, A1, A2, A3) \
 745         vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 3), (S), (A1), (A2), (A3))
 746
 747 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
 748  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 749  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
 750 }
 751
 752 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
 753  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 754  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
 755 }
 756
 757 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
 758  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 759  unsigned int opinfo = w->opinfo;
 760  U32 len, ret;
 761  svtype t = SvTYPE(sv);
 762
 763  dSP;
 764
 765  ENTER;
 766  SAVETMPS;
 767
 768  PUSHMARK(SP);
 769  EXTEND(SP, 3);
 770  PUSHs(sv_2mortal(newRV_inc(sv)));
 771  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
 772  if (t < SVt_PVAV) {
 773   STRLEN l;
 774   U8 *s = (U8 *) SvPV_const(sv, l);
 775   if (DO_UTF8(sv))
 776    len = utf8_length(s, s + l);
 777   else
 778    len = l;
 779   mPUSHu(len);
 780  } else if (t == SVt_PVAV) {
 781   len = av_len((AV *) sv) + 1;
 782   mPUSHu(len);
 783  } else {
 784   len = 0;
 785   PUSHs(&PL_sv_undef);
 786  }
 787  if (opinfo)
 788   XPUSHs(vmg_op_info(opinfo));
 789  PUTBACK;
 790
 791  call_sv(w->cb_len, G_SCALAR);
 792
 793  VMG_CB_CALL_SET_RET(len);
 794
 795  FREETMPS;
 796  LEAVE;
 797
 798  return t == SVt_PVAV ? ret - 1 : ret;
 799 }
 800
 801 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
 802  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 803  return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
 804 }
 805
 806 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
 807  const MGWIZ *w;
 808  unsigned int had_err, has_err, flags = G_SCALAR | G_EVAL;
 809  int ret = 0;
 810
 811  dSP;
 812
 813  /* Don't even bother if we are in global destruction - the wizard is prisoner
 814   * of circular references and we are way beyond user realm */
 815  if (PL_dirty)
 816   return 0;
 817
 818  w = SV2MGWIZ(mg->mg_ptr);
 819
 820  /* So that it survives the temp cleanup below */
 821  SvREFCNT_inc(sv);
 822
 823 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
 824  /* The previous magic tokens were freed but the magic chain wasn't updated, so
 825   * if you access the sv from the callback the old deleted magics will trigger
 826   * and cause memory misreads. Change 32686 solved it that way : */
 827  SvMAGIC_set(sv, mg);
 828 #endif
 829
 830  ENTER;
 831  SAVETMPS;
 832
 833  PUSHMARK(SP);
 834  EXTEND(SP, 2);
 835  PUSHs(sv_2mortal(newRV_inc(sv)));
 836  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
 837  if (w->opinfo)
 838   XPUSHs(vmg_op_info(w->opinfo));
 839  PUTBACK;
 840
 841  had_err = SvTRUE(ERRSV);
 842  if (had_err)
 843   flags |= G_KEEPERR;
 844
 845  call_sv(w->cb_free, flags);
 846
 847  has_err = SvTRUE(ERRSV);
 848  if (IN_PERL_COMPILETIME && !had_err && has_err)
 849   ++PL_error_count;
 850
 851  VMG_CB_CALL_SET_RET(0);
 852
 853  FREETMPS;
 854  LEAVE;
 855
 856  if (has_err) {
 857   /* Get the eval context that was pushed by call_sv, and fake an entry for the
 858    * namesv, as die_where will need it to be non NULL later */
 859   PERL_CONTEXT *cx = cxstack + cxstack_ix + 1;
 860   if (!cx->blk_eval.old_namesv)
 861    cx->blk_eval.old_namesv
 862                  = sv_2mortal(newSVpvn_share("Variable/Magic/DUMMY.pm", 23, 0));
 863  }
 864
 865  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
 866   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
 867  --SvREFCNT(sv);
 868
 869  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
 870   * mg->mg_ptr reference count */
 871  return ret;
 872 }
 873
 874 #if MGf_COPY
 875 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
 876 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
 877   I32 keylen
 878 # else
 879   int keylen
 880 # endif
 881  ) {
 882  SV *keysv;
 883  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 884  int ret;
 885
 886  if (keylen == HEf_SVKEY) {
 887   keysv = (SV *) key;
 888  } else {
 889   keysv = newSVpvn(key, keylen);
 890  }
 891
 892  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
 893
 894  if (keylen != HEf_SVKEY) {
 895   SvREFCNT_dec(keysv);
 896  }
 897
 898  return ret;
 899 }
 900 #endif /* MGf_COPY */
 901
 902 #if 0 /*  MGf_DUP */
 903 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
 904  return 0;
 905 }
 906 #endif /* MGf_DUP */
 907
 908 #if MGf_LOCAL
 909 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
 910  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 911  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
 912 }
 913 #endif /* MGf_LOCAL */
 914
 915 #if VMG_UVAR
 916 STATIC OP *vmg_pp_resetuvar(pTHX) {
 917  SvRMAGICAL_on(cSVOP_sv);
 918  return NORMAL;
 919 }
 920
 921 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
 922  struct ufuncs *uf;
 923  MAGIC *mg, *umg;
 924  SV *key = NULL, *newkey = NULL;
 925  int tied = 0;
 926
 927  umg = mg_find(sv, PERL_MAGIC_uvar);
 928  /* umg can't be NULL or we wouldn't be there. */
 929  key = umg->mg_obj;
 930  uf  = (struct ufuncs *) umg->mg_ptr;
 931
 932  if (uf[1].uf_val != NULL) { uf[1].uf_val(aTHX_ action, sv); }
 933  if (uf[1].uf_set != NULL) { uf[1].uf_set(aTHX_ action, sv); }
 934
 935  action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
 936  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 937   const MGWIZ *w;
 938   switch (mg->mg_type) {
 939    case PERL_MAGIC_ext:
 940     break;
 941    case PERL_MAGIC_tied:
 942     ++tied;
 943     continue;
 944    default:
 945     continue;
 946   }
 947   if (mg->mg_private != SIG_WIZ) continue;
 948   w = SV2MGWIZ(mg->mg_ptr);
 949   switch (w->uvar) {
 950    case 0:
 951     continue;
 952    case 2:
 953     if (!newkey)
 954      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
 955   }
 956   switch (action) {
 957    case 0:
 958     if (w->cb_fetch)
 959      vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
 960     break;
 961    case HV_FETCH_ISSTORE:
 962    case HV_FETCH_LVALUE:
 963    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
 964     if (w->cb_store)
 965      vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
 966     break;
 967    case HV_FETCH_ISEXISTS:
 968     if (w->cb_exists)
 969      vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
 970     break;
 971    case HV_DELETE:
 972     if (w->cb_delete)
 973      vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
 974     break;
 975   }
 976  }
 977
 978  if (SvRMAGICAL(sv) && !tied) {
 979   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
 980    * mistaken for a tied hash by the rest of hv_common. It will be reset by
 981    * the op_ppaddr of a new fake op injected between the current and the next
 982    * one. */
 983   OP *o = PL_op;
 984   if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
 985    SVOP *svop;
 986    NewOp(1101, svop, 1, SVOP);
 987    svop->op_type   = OP_STUB;
 988    svop->op_ppaddr = vmg_pp_resetuvar;
 989    svop->op_next   = o->op_next;
 990    svop->op_flags  = 0;
 991    svop->op_sv     = sv;
 992    o->op_next      = (OP *) svop;
 993   }
 994   SvRMAGICAL_off(sv);
 995  }
 996
 997  return 0;
 998 }
 999 #endif /* VMG_UVAR */
1000
1001 /* ... Wizard destructor ................................................... */
1002
1003 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
1004  char buf[8];
1005  MGWIZ *w;
1006
1007  if (PL_dirty) /* During global destruction, the context is already freed */
1008   return 0;
1009
1010  w = SV2MGWIZ(wiz);
1011 #if VMG_MULTIPLICITY
1012  if (w->owner != aTHX)
1013   return 0;
1014  w->owner = NULL;
1015 #endif /* VMG_MULTIPLICITY */
1016
1017  {
1018   dMY_CXT;
1019   if (hv_delete(MY_CXT.wizards, buf, sprintf(buf, "%u", w->sig), 0) != wiz)
1020    return 0;
1021  }
1022  SvFLAGS(wiz) |= SVf_BREAK;
1023  FREETMPS;
1024
1025  if (w->cb_data  != NULL) { SvREFCNT_dec(SvRV(w->cb_data)); }
1026  if (w->cb_get   != NULL) { SvREFCNT_dec(SvRV(w->cb_get)); }
1027  if (w->cb_set   != NULL) { SvREFCNT_dec(SvRV(w->cb_set)); }
1028  if (w->cb_len   != NULL) { SvREFCNT_dec(SvRV(w->cb_len)); }
1029  if (w->cb_clear != NULL) { SvREFCNT_dec(SvRV(w->cb_clear)); }
1030  if (w->cb_free  != NULL) { SvREFCNT_dec(SvRV(w->cb_free)); }
1031 #if MGf_COPY
1032  if (w->cb_copy  != NULL) { SvREFCNT_dec(SvRV(w->cb_copy)); }
1033 #endif /* MGf_COPY */
1034 #if 0 /* MGf_DUP */
1035  if (w->cb_dup   != NULL) { SvREFCNT_dec(SvRV(w->cb_dup)); }
1036 #endif /* MGf_DUP */
1037 #if MGf_LOCAL
1038  if (w->cb_local != NULL) { SvREFCNT_dec(SvRV(w->cb_local)); }
1039 #endif /* MGf_LOCAL */
1040 #if VMG_UVAR
1041  if (w->cb_fetch  != NULL) { SvREFCNT_dec(SvRV(w->cb_fetch)); }
1042  if (w->cb_store  != NULL) { SvREFCNT_dec(SvRV(w->cb_store)); }
1043  if (w->cb_exists != NULL) { SvREFCNT_dec(SvRV(w->cb_exists)); }
1044  if (w->cb_delete != NULL) { SvREFCNT_dec(SvRV(w->cb_delete)); }
1045 #endif /* VMG_UVAR */
1046
1047  Safefree(w->vtbl);
1048  Safefree(w);
1049
1050  return 0;
1051 }
1052
1053 STATIC MGVTBL vmg_wizard_vtbl = {
1054  NULL,            /* get */
1055  NULL,            /* set */
1056  NULL,            /* len */
1057  NULL,            /* clear */
1058  vmg_wizard_free, /* free */
1059 #if MGf_COPY
1060  NULL,            /* copy */
1061 #endif /* MGf_COPY */
1062 #if MGf_DUP
1063  NULL,            /* dup */
1064 #endif /* MGf_DUP */
1065 #if MGf_LOCAL
1066  NULL,            /* local */
1067 #endif /* MGf_LOCAL */
1068 };
1069
1070 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
1071 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
1072  IV sig;
1073
1074  if (SvIOK(sv)) {
1075   sig = SvIVX(sv);
1076  } else if (SvNOK(sv)) {
1077   sig = SvNVX(sv);
1078  } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
1079   sig = SvIV(sv);
1080  } else {
1081   croak(vmg_invalid_sig);
1082  }
1083
1084  if (sig < SIG_MIN || sig > SIG_MAX)
1085   croak(vmg_invalid_sig);
1086
1087  return sig;
1088 }
1089
1090 STATIC U16 vmg_wizard_sig(pTHX_ SV *wiz) {
1091 #define vmg_wizard_sig(W) vmg_wizard_sig(aTHX_ (W))
1092  U16 sig;
1093
1094  if (SvROK(wiz)) {
1095   sig = SV2MGWIZ(SvRV(wiz))->sig;
1096  } else if (SvOK(wiz)) {
1097   sig = vmg_sv2sig(wiz);
1098  } else {
1099   croak(vmg_invalid_wiz);
1100  }
1101
1102  {
1103   dMY_CXT;
1104   char buf[8];
1105   SV **old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0);
1106   if (!(old && SV2MGWIZ(*old)))
1107    croak(vmg_invalid_wiz);
1108  }
1109
1110  return sig;
1111 }
1112
1113 STATIC SV *vmg_wizard_wiz(pTHX_ SV *wiz) {
1114 #define vmg_wizard_wiz(W) vmg_wizard_wiz(aTHX_ (W))
1115  U16 sig;
1116
1117  if (SvROK(wiz)) {
1118   wiz = SvRV(wiz);
1119 #if VMG_MULTIPLICITY
1120   if (SV2MGWIZ(wiz)->owner == aTHX)
1121    return wiz;
1122 #endif /* VMG_MULTIPLICITY */
1123   sig = SV2MGWIZ(wiz)->sig;
1124  } else if (SvOK(wiz)) {
1125   sig = vmg_sv2sig(wiz);
1126  } else {
1127   croak(vmg_invalid_wiz);
1128  }
1129
1130  {
1131   dMY_CXT;
1132   char buf[8];
1133   SV **old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0);
1134   if (!(old && SV2MGWIZ(*old)))
1135    croak(vmg_invalid_wiz);
1136
1137   return *old;
1138  }
1139 }
1140
1141 #define VMG_SET_CB(S, N)              \
1142  cb = (S);                            \
1143  w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
1144
1145 #define VMG_SET_SVT_CB(S, N)          \
1146  cb = (S);                            \
1147  if (SvOK(cb) && SvROK(cb)) {         \
1148   t->svt_ ## N = vmg_svt_ ## N;       \
1149   w->cb_  ## N = newRV_inc(SvRV(cb)); \
1150  } else {                             \
1151   t->svt_ ## N = NULL;                \
1152   w->cb_  ## N = NULL;                \
1153  }
1154
1155 #if VMG_THREADSAFE
1156
1157 #define VMG_CLONE_CB(N) \
1158  z->cb_ ## N = (w->cb_ ## N) ? newRV_inc(vmg_clone(SvRV(w->cb_ ## N), \
1159                                          w->owner))                   \
1160                              : NULL;
1161
1162 STATIC MGWIZ *vmg_wizard_clone(pTHX_ const MGWIZ *w) {
1163 #define vmg_wizard_clone(W) vmg_wizard_clone(aTHX_ (W))
1164  MGVTBL *t;
1165  MGWIZ *z;
1166
1167  Newx(t, 1, MGVTBL);
1168  Copy(w->vtbl, t, 1, MGVTBL);
1169
1170  Newx(z, 1, MGWIZ);
1171  VMG_CLONE_CB(data);
1172  VMG_CLONE_CB(get);
1173  VMG_CLONE_CB(set);
1174  VMG_CLONE_CB(len);
1175  VMG_CLONE_CB(clear);
1176  VMG_CLONE_CB(free);
1177 #if MGf_COPY
1178  VMG_CLONE_CB(copy);
1179 #endif /* MGf_COPY */
1180 #if MGf_DUP
1181  VMG_CLONE_CB(dup);
1182 #endif /* MGf_DUP */
1183 #if MGf_LOCAL
1184  VMG_CLONE_CB(local);
1185 #endif /* MGf_LOCAL */
1186 #if VMG_UVAR
1187  VMG_CLONE_CB(fetch);
1188  VMG_CLONE_CB(store);
1189  VMG_CLONE_CB(exists);
1190  VMG_CLONE_CB(delete);
1191 #endif /* VMG_UVAR */
1192  z->owner  = aTHX;
1193  z->vtbl   = t;
1194  z->sig    = w->sig;
1195  z->uvar   = w->uvar;
1196  z->opinfo = w->opinfo;
1197
1198  return z;
1199 }
1200
1201 #endif /* VMG_THREADSAFE */
1202
1203 /* --- XS ------------------------------------------------------------------ */
1204
1205 MODULE = Variable::Magic            PACKAGE = Variable::Magic
1206
1207 PROTOTYPES: ENABLE
1208
1209 BOOT:
1210 {
1211  HV *stash;
1212  MY_CXT_INIT;
1213  MY_CXT.wizards = newHV();
1214  hv_iterinit(MY_CXT.wizards); /* Allocate iterator */
1215  MY_CXT.b__op_stashes[0] = NULL;
1216 #if VMG_THREADSAFE
1217  MUTEX_INIT(&vmg_op_name_init_mutex);
1218 #endif
1219
1220  stash = gv_stashpv(__PACKAGE__, 1);
1221  newCONSTSUB(stash, "SIG_MIN",   newSVuv(SIG_MIN));
1222  newCONSTSUB(stash, "SIG_MAX",   newSVuv(SIG_MAX));
1223  newCONSTSUB(stash, "SIG_NBR",   newSVuv(SIG_NBR));
1224  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1225  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1226  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1227  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1228  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1229                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1230  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1231                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1232  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1233                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1234  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1235                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1236  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1237  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1238  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1239  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1240 }
1241
1242 #if VMG_THREADSAFE
1243
1244 void
1245 CLONE(...)
1246 PROTOTYPE: DISABLE
1247 PREINIT:
1248  HV *hv;
1249  U32 had_b__op_stash = 0;
1250  opclass c;
1251 CODE:
1252  {
1253   HE *key;
1254   dMY_CXT;
1255   hv = newHV();
1256   hv_iterinit(hv); /* Allocate iterator */
1257   hv_iterinit(MY_CXT.wizards);
1258   while ((key = hv_iternext(MY_CXT.wizards))) {
1259    STRLEN len;
1260    char *sig = HePV(key, len);
1261    SV *sv;
1262    const MGWIZ *w = SV2MGWIZ(HeVAL(key));
1263    if (w) {
1264     MAGIC *mg;
1265     w  = vmg_wizard_clone(w);
1266     sv = MGWIZ2SV(w);
1267     mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1268     mg->mg_private = SIG_WZO;
1269    } else {
1270     sv = MGWIZ2SV(NULL);
1271    }
1272    SvREADONLY_on(sv);
1273    if (!hv_store(hv, sig, len, sv, HeHASH(key))) croak("%s during CLONE", vmg_globstorefail);
1274   }
1275   for (c = 0; c < OPc_MAX; ++c) {
1276    if (MY_CXT.b__op_stashes[c])
1277     had_b__op_stash |= (((U32) 1) << c);
1278   }
1279  }
1280  {
1281   MY_CXT_CLONE;
1282   MY_CXT.wizards     = hv;
1283   for (c = 0; c < OPc_MAX; ++c) {
1284    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1285                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1286   }
1287  }
1288
1289 #endif /* VMG_THREADSAFE */
1290
1291 SV *_wizard(...)
1292 PROTOTYPE: DISABLE
1293 PREINIT:
1294  I32 i = 0;
1295  U16 sig;
1296  char buf[8];
1297  MGWIZ *w;
1298  MGVTBL *t;
1299  MAGIC *mg;
1300  SV *sv;
1301  SV *svsig;
1302  SV *cb;
1303 CODE:
1304  dMY_CXT;
1305
1306  if (items != 8
1307 #if MGf_COPY
1308               + 1
1309 #endif /* MGf_COPY */
1310 #if MGf_DUP
1311               + 1
1312 #endif /* MGf_DUP */
1313 #if MGf_LOCAL
1314               + 1
1315 #endif /* MGf_LOCAL */
1316 #if VMG_UVAR
1317               + 5
1318 #endif /* VMG_UVAR */
1319               ) { croak(vmg_wrongargnum); }
1320
1321  svsig = ST(i++);
1322  if (SvOK(svsig)) {
1323   SV **old;
1324   sig = vmg_sv2sig(svsig);
1325   old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0);
1326   if (old && SV2MGWIZ(*old)) {
1327    ST(0) = sv_2mortal(newRV_inc(*old));
1328    XSRETURN(1);
1329   }
1330  } else {
1331   sig = vmg_gensig();
1332  }
1333
1334  Newx(t, 1, MGVTBL);
1335  Newx(w, 1, MGWIZ);
1336
1337  VMG_SET_CB(ST(i++), data);
1338  cb = ST(i++);
1339  w->opinfo = SvOK(cb) ? SvUV(cb) : 0;
1340  if (w->opinfo)
1341   vmg_op_info_init(w->opinfo);
1342  VMG_SET_SVT_CB(ST(i++), get);
1343  VMG_SET_SVT_CB(ST(i++), set);
1344  VMG_SET_SVT_CB(ST(i++), len);
1345  VMG_SET_SVT_CB(ST(i++), clear);
1346  VMG_SET_SVT_CB(ST(i++), free);
1347 #if MGf_COPY
1348  VMG_SET_SVT_CB(ST(i++), copy);
1349 #endif /* MGf_COPY */
1350 #if MGf_DUP
1351  /* VMG_SET_SVT_CB(ST(i++), dup); */
1352  i++;
1353  t->svt_dup = NULL;
1354  w->cb_dup  = NULL;
1355 #endif /* MGf_DUP */
1356 #if MGf_LOCAL
1357  VMG_SET_SVT_CB(ST(i++), local);
1358 #endif /* MGf_LOCAL */
1359 #if VMG_UVAR
1360  VMG_SET_CB(ST(i++), fetch);
1361  VMG_SET_CB(ST(i++), store);
1362  VMG_SET_CB(ST(i++), exists);
1363  VMG_SET_CB(ST(i++), delete);
1364  cb = ST(i++);
1365  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1366   w->uvar = SvTRUE(cb) ? 2 : 1;
1367  else
1368   w->uvar = 0;
1369 #endif /* VMG_UVAR */
1370 #if VMG_MULTIPLICITY
1371  w->owner = aTHX;
1372 #endif /* VMG_MULTIPLICITY */
1373  w->vtbl  = t;
1374  w->sig   = sig;
1375
1376  sv = MGWIZ2SV(w);
1377  mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1378  mg->mg_private = SIG_WZO;
1379  SvREADONLY_on(sv);
1380
1381  if (!hv_store(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), sv, 0)) croak(vmg_globstorefail);
1382
1383  RETVAL = newRV_noinc(sv);
1384 OUTPUT:
1385  RETVAL
1386
1387 SV *gensig()
1388 PROTOTYPE:
1389 PREINIT:
1390  U16 sig;
1391  char buf[8];
1392 CODE:
1393  dMY_CXT;
1394  sig = vmg_gensig();
1395  if (!hv_store(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), MGWIZ2SV(NULL), 0)) croak(vmg_globstorefail);
1396  RETVAL = newSVuv(sig);
1397 OUTPUT:
1398  RETVAL
1399
1400 SV *getsig(SV *wiz)
1401 PROTOTYPE: $
1402 CODE:
1403  if (!SvROK(wiz)) { croak(vmg_invalid_wiz); }
1404  RETVAL = newSVuv(SV2MGWIZ(SvRV(wiz))->sig);
1405 OUTPUT:
1406  RETVAL
1407
1408 SV *cast(SV *sv, SV *wiz, ...)
1409 PROTOTYPE: \[$@%&*]$@
1410 PREINIT:
1411  AV *args = NULL;
1412  SV *ret;
1413 CODE:
1414  wiz = vmg_wizard_wiz(wiz);
1415  if (items > 2) {
1416   I32 i;
1417   args = newAV();
1418   av_fill(args, items - 2);
1419   for (i = 2; i < items; ++i) {
1420    SV *arg = ST(i);
1421    SvREFCNT_inc(arg);
1422    if (av_store(args, i - 2, arg) == NULL) { croak(vmg_argstorefailed); }
1423   }
1424  }
1425  ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1426  SvREFCNT_dec(args);
1427  RETVAL = ret;
1428 OUTPUT:
1429  RETVAL
1430
1431 void
1432 getdata(SV *sv, SV *wiz)
1433 PROTOTYPE: \[$@%&*]$
1434 PREINIT:
1435  SV *data;
1436  U16 sig;
1437 PPCODE:
1438  sig  = vmg_wizard_sig(wiz);
1439  data = vmg_data_get(SvRV(sv), sig);
1440  if (!data) { XSRETURN_UNDEF; }
1441  ST(0) = data;
1442  XSRETURN(1);
1443
1444 SV *dispell(SV *sv, SV *wiz)
1445 PROTOTYPE: \[$@%&*]$
1446 PREINIT:
1447  U16 sig;
1448 CODE:
1449  sig = vmg_wizard_sig(wiz);
1450  RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));
1451 OUTPUT:
1452  RETVAL