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