Magic.xs

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