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