Magic.xs

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