Magic.xs

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