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