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