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