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