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 STATIC U32           vmg_op_name_init      = 0;
 627 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
 628
 629 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
 630 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
 631  switch (opinfo) {
 632   case VMG_OP_INFO_NAME:
 633    if (!vmg_op_name_init) {
 634     OPCODE t;
 635     for (t = 0; t < OP_max; ++t)
 636      vmg_op_name_len[t] = strlen(PL_op_name[t]);
 637     vmg_op_name_init = 1;
 638    }
 639    break;
 640   case VMG_OP_INFO_OBJECT: {
 641    dMY_CXT;
 642    if (!MY_CXT.b__op_stashes[0]) {
 643     opclass c;
 644     require_pv("B.pm");
 645     for (c = 0; c < OPc_MAX; ++c)
 646      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
 647    }
 648    break;
 649   }
 650   default:
 651    break;
 652  }
 653 }
 654
 655 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
 656 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
 657  if (!PL_op)
 658   return &PL_sv_undef;
 659
 660  switch (opinfo) {
 661   case VMG_OP_INFO_NAME: {
 662    OPCODE t = PL_op->op_type;
 663    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
 664   }
 665   case VMG_OP_INFO_OBJECT: {
 666    dMY_CXT;
 667    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
 668                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
 669   }
 670   default:
 671    break;
 672  }
 673
 674  return &PL_sv_undef;
 675 }
 676
 677 /* ... svt callbacks ....................................................... */
 678
 679 #define VMG_CB_CALL_SET_RET(D) \
 680  {            \
 681   SV *svr;    \
 682   SPAGAIN;    \
 683   svr = POPs; \
 684   ret = SvOK(svr) ? SvIV(svr) : (D); \
 685   PUTBACK;    \
 686  }
 687
 688 #define VMG_CB_CALL_ARGS_MASK  15
 689 #define VMG_CB_CALL_ARGS_SHIFT 4
 690 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
 691
 692 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
 693  va_list ap;
 694  int ret;
 695  unsigned int i, args, opinfo;
 696
 697  dSP;
 698
 699  args    = flags & VMG_CB_CALL_ARGS_MASK;
 700  flags >>= VMG_CB_CALL_ARGS_SHIFT;
 701  opinfo  = flags & VMG_CB_CALL_OPINFO;
 702
 703  ENTER;
 704  SAVETMPS;
 705
 706  PUSHMARK(SP);
 707  EXTEND(SP, args + 1);
 708  PUSHs(sv_2mortal(newRV_inc(sv)));
 709  va_start(ap, sv);
 710  for (i = 0; i < args; ++i) {
 711   SV *sva = va_arg(ap, SV *);
 712   PUSHs(sva ? sva : &PL_sv_undef);
 713  }
 714  va_end(ap);
 715  if (opinfo)
 716   XPUSHs(vmg_op_info(opinfo));
 717  PUTBACK;
 718
 719  call_sv(cb, G_SCALAR);
 720
 721  VMG_CB_CALL_SET_RET(0);
 722
 723  FREETMPS;
 724  LEAVE;
 725
 726  return ret;
 727 }
 728
 729 #define vmg_cb_call1(I, F, S, A1) \
 730         vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 1), (S), (A1))
 731 #define vmg_cb_call2(I, F, S, A1, A2) \
 732         vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 2), (S), (A1), (A2))
 733 #define vmg_cb_call3(I, F, S, A1, A2, A3) \
 734         vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 3), (S), (A1), (A2), (A3))
 735
 736 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
 737  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 738  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
 739 }
 740
 741 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
 742  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 743  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
 744 }
 745
 746 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
 747  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 748  unsigned int opinfo = w->opinfo;
 749  U32 len, ret;
 750  svtype t = SvTYPE(sv);
 751
 752  dSP;
 753
 754  ENTER;
 755  SAVETMPS;
 756
 757  PUSHMARK(SP);
 758  EXTEND(SP, 3);
 759  PUSHs(sv_2mortal(newRV_inc(sv)));
 760  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
 761  if (t < SVt_PVAV) {
 762   STRLEN l;
 763   U8 *s = (U8 *) SvPV_const(sv, l);
 764   if (DO_UTF8(sv))
 765    len = utf8_length(s, s + l);
 766   else
 767    len = l;
 768   mPUSHu(len);
 769  } else if (t == SVt_PVAV) {
 770   len = av_len((AV *) sv) + 1;
 771   mPUSHu(len);
 772  } else {
 773   len = 0;
 774   PUSHs(&PL_sv_undef);
 775  }
 776  if (opinfo)
 777   XPUSHs(vmg_op_info(opinfo));
 778  PUTBACK;
 779
 780  call_sv(w->cb_len, G_SCALAR);
 781
 782  VMG_CB_CALL_SET_RET(len);
 783
 784  FREETMPS;
 785  LEAVE;
 786
 787  return t == SVt_PVAV ? ret - 1 : ret;
 788 }
 789
 790 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
 791  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 792  return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
 793 }
 794
 795 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
 796  const MGWIZ *w;
 797  unsigned int had_err, has_err, flags = G_SCALAR | G_EVAL;
 798  int ret = 0;
 799
 800  dSP;
 801
 802  /* Don't even bother if we are in global destruction - the wizard is prisoner
 803   * of circular references and we are way beyond user realm */
 804  if (PL_dirty)
 805   return 0;
 806
 807  w = SV2MGWIZ(mg->mg_ptr);
 808
 809  /* So that it survives the temp cleanup below */
 810  SvREFCNT_inc(sv);
 811
 812 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
 813  /* The previous magic tokens were freed but the magic chain wasn't updated, so
 814   * if you access the sv from the callback the old deleted magics will trigger
 815   * and cause memory misreads. Change 32686 solved it that way : */
 816  SvMAGIC_set(sv, mg);
 817 #endif
 818
 819  ENTER;
 820  SAVETMPS;
 821
 822  PUSHMARK(SP);
 823  EXTEND(SP, 2);
 824  PUSHs(sv_2mortal(newRV_inc(sv)));
 825  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
 826  if (w->opinfo)
 827   XPUSHs(vmg_op_info(w->opinfo));
 828  PUTBACK;
 829
 830  had_err = SvTRUE(ERRSV);
 831  if (had_err)
 832   flags |= G_KEEPERR;
 833
 834  call_sv(w->cb_free, flags);
 835
 836  has_err = SvTRUE(ERRSV);
 837  if (IN_PERL_COMPILETIME && !had_err && has_err)
 838   ++PL_error_count;
 839
 840  VMG_CB_CALL_SET_RET(0);
 841
 842  FREETMPS;
 843  LEAVE;
 844
 845  if (has_err) {
 846   /* Get the eval context that was pushed by call_sv, and fake an entry for the
 847    * namesv, as die_where will need it to be non NULL later */
 848   PERL_CONTEXT *cx = cxstack + cxstack_ix + 1;
 849   if (!cx->blk_eval.old_namesv)
 850    cx->blk_eval.old_namesv
 851                  = sv_2mortal(newSVpvn_share("Variable/Magic/DUMMY.pm", 23, 0));
 852  }
 853
 854  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
 855   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
 856  --SvREFCNT(sv);
 857
 858  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
 859   * mg->mg_ptr reference count */
 860  return ret;
 861 }
 862
 863 #if MGf_COPY
 864 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
 865 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
 866   I32 keylen
 867 # else
 868   int keylen
 869 # endif
 870  ) {
 871  SV *keysv;
 872  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 873  int ret;
 874
 875  if (keylen == HEf_SVKEY) {
 876   keysv = (SV *) key;
 877  } else {
 878   keysv = newSVpvn(key, keylen);
 879  }
 880
 881  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
 882
 883  if (keylen != HEf_SVKEY) {
 884   SvREFCNT_dec(keysv);
 885  }
 886
 887  return ret;
 888 }
 889 #endif /* MGf_COPY */
 890
 891 #if 0 /*  MGf_DUP */
 892 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
 893  return 0;
 894 }
 895 #endif /* MGf_DUP */
 896
 897 #if MGf_LOCAL
 898 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
 899  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 900  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
 901 }
 902 #endif /* MGf_LOCAL */
 903
 904 #if VMG_UVAR
 905 STATIC OP *vmg_pp_resetuvar(pTHX) {
 906  SvRMAGICAL_on(cSVOP_sv);
 907  return NORMAL;
 908 }
 909
 910 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
 911  struct ufuncs *uf;
 912  MAGIC *mg, *umg;
 913  SV *key = NULL, *newkey = NULL;
 914  int tied = 0;
 915
 916  umg = mg_find(sv, PERL_MAGIC_uvar);
 917  /* umg can't be NULL or we wouldn't be there. */
 918  key = umg->mg_obj;
 919  uf  = (struct ufuncs *) umg->mg_ptr;
 920
 921  if (uf[1].uf_val != NULL) { uf[1].uf_val(aTHX_ action, sv); }
 922  if (uf[1].uf_set != NULL) { uf[1].uf_set(aTHX_ action, sv); }
 923
 924  action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
 925  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 926   const MGWIZ *w;
 927   switch (mg->mg_type) {
 928    case PERL_MAGIC_ext:
 929     break;
 930    case PERL_MAGIC_tied:
 931     ++tied;
 932     continue;
 933    default:
 934     continue;
 935   }
 936   if (mg->mg_private != SIG_WIZ) continue;
 937   w = SV2MGWIZ(mg->mg_ptr);
 938   switch (w->uvar) {
 939    case 0:
 940     continue;
 941    case 2:
 942     if (!newkey)
 943      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
 944   }
 945   switch (action) {
 946    case 0:
 947     if (w->cb_fetch)
 948      vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
 949     break;
 950    case HV_FETCH_ISSTORE:
 951    case HV_FETCH_LVALUE:
 952    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
 953     if (w->cb_store)
 954      vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
 955     break;
 956    case HV_FETCH_ISEXISTS:
 957     if (w->cb_exists)
 958      vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
 959     break;
 960    case HV_DELETE:
 961     if (w->cb_delete)
 962      vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
 963     break;
 964   }
 965  }
 966
 967  if (SvRMAGICAL(sv) && !tied) {
 968   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
 969    * mistaken for a tied hash by the rest of hv_common. It will be reset by
 970    * the op_ppaddr of a new fake op injected between the current and the next
 971    * one. */
 972   OP *o = PL_op;
 973   if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
 974    SVOP *svop;
 975    NewOp(1101, svop, 1, SVOP);
 976    svop->op_type   = OP_STUB;
 977    svop->op_ppaddr = vmg_pp_resetuvar;
 978    svop->op_next   = o->op_next;
 979    svop->op_flags  = 0;
 980    svop->op_sv     = sv;
 981    o->op_next      = (OP *) svop;
 982   }
 983   SvRMAGICAL_off(sv);
 984  }
 985
 986  return 0;
 987 }
 988 #endif /* VMG_UVAR */
 989
 990 /* ... Wizard destructor ................................................... */
 991
 992 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
 993  char buf[8];
 994  MGWIZ *w;
 995
 996  if (PL_dirty) /* During global destruction, the context is already freed */
 997   return 0;
 998
 999  w = SV2MGWIZ(wiz);
1000 #if VMG_MULTIPLICITY
1001  if (w->owner != aTHX)
1002   return 0;
1003  w->owner = NULL;
1004 #endif /* VMG_MULTIPLICITY */
1005
1006  {
1007   dMY_CXT;
1008   if (hv_delete(MY_CXT.wizards, buf, sprintf(buf, "%u", w->sig), 0) != wiz)
1009    return 0;
1010  }
1011  SvFLAGS(wiz) |= SVf_BREAK;
1012  FREETMPS;
1013
1014  if (w->cb_data  != NULL) { SvREFCNT_dec(SvRV(w->cb_data)); }
1015  if (w->cb_get   != NULL) { SvREFCNT_dec(SvRV(w->cb_get)); }
1016  if (w->cb_set   != NULL) { SvREFCNT_dec(SvRV(w->cb_set)); }
1017  if (w->cb_len   != NULL) { SvREFCNT_dec(SvRV(w->cb_len)); }
1018  if (w->cb_clear != NULL) { SvREFCNT_dec(SvRV(w->cb_clear)); }
1019  if (w->cb_free  != NULL) { SvREFCNT_dec(SvRV(w->cb_free)); }
1020 #if MGf_COPY
1021  if (w->cb_copy  != NULL) { SvREFCNT_dec(SvRV(w->cb_copy)); }
1022 #endif /* MGf_COPY */
1023 #if 0 /* MGf_DUP */
1024  if (w->cb_dup   != NULL) { SvREFCNT_dec(SvRV(w->cb_dup)); }
1025 #endif /* MGf_DUP */
1026 #if MGf_LOCAL
1027  if (w->cb_local != NULL) { SvREFCNT_dec(SvRV(w->cb_local)); }
1028 #endif /* MGf_LOCAL */
1029 #if VMG_UVAR
1030  if (w->cb_fetch  != NULL) { SvREFCNT_dec(SvRV(w->cb_fetch)); }
1031  if (w->cb_store  != NULL) { SvREFCNT_dec(SvRV(w->cb_store)); }
1032  if (w->cb_exists != NULL) { SvREFCNT_dec(SvRV(w->cb_exists)); }
1033  if (w->cb_delete != NULL) { SvREFCNT_dec(SvRV(w->cb_delete)); }
1034 #endif /* VMG_UVAR */
1035
1036  Safefree(w->vtbl);
1037  Safefree(w);
1038
1039  return 0;
1040 }
1041
1042 STATIC MGVTBL vmg_wizard_vtbl = {
1043  NULL,            /* get */
1044  NULL,            /* set */
1045  NULL,            /* len */
1046  NULL,            /* clear */
1047  vmg_wizard_free, /* free */
1048 #if MGf_COPY
1049  NULL,            /* copy */
1050 #endif /* MGf_COPY */
1051 #if MGf_DUP
1052  NULL,            /* dup */
1053 #endif /* MGf_DUP */
1054 #if MGf_LOCAL
1055  NULL,            /* local */
1056 #endif /* MGf_LOCAL */
1057 };
1058
1059 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
1060 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
1061  IV sig;
1062
1063  if (SvIOK(sv)) {
1064   sig = SvIVX(sv);
1065  } else if (SvNOK(sv)) {
1066   sig = SvNVX(sv);
1067  } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
1068   sig = SvIV(sv);
1069  } else {
1070   croak(vmg_invalid_sig);
1071  }
1072
1073  if (sig < SIG_MIN || sig > SIG_MAX)
1074   croak(vmg_invalid_sig);
1075
1076  return sig;
1077 }
1078
1079 STATIC U16 vmg_wizard_sig(pTHX_ SV *wiz) {
1080 #define vmg_wizard_sig(W) vmg_wizard_sig(aTHX_ (W))
1081  char buf[8];
1082  U16 sig;
1083
1084  if (SvROK(wiz)) {
1085   sig = SV2MGWIZ(SvRV(wiz))->sig;
1086  } else if (SvOK(wiz)) {
1087   sig = vmg_sv2sig(wiz);
1088  } else {
1089   croak(vmg_invalid_wiz);
1090  }
1091
1092  {
1093   dMY_CXT;
1094   if (!hv_exists(MY_CXT.wizards, buf, sprintf(buf, "%u", sig)))
1095    croak(vmg_invalid_wiz);
1096  }
1097
1098  return sig;
1099 }
1100
1101 STATIC SV *vmg_wizard_wiz(pTHX_ SV *wiz) {
1102 #define vmg_wizard_wiz(W) vmg_wizard_wiz(aTHX_ (W))
1103  char buf[8];
1104  SV **old;
1105  U16 sig;
1106
1107  if (SvROK(wiz)) {
1108   wiz = SvRV(wiz);
1109 #if VMG_MULTIPLICITY
1110   if (SV2MGWIZ(wiz)->owner == aTHX)
1111    return wiz;
1112 #endif /* VMG_MULTIPLICITY */
1113   sig = SV2MGWIZ(wiz)->sig;
1114  } else if (SvOK(wiz)) {
1115   sig = vmg_sv2sig(wiz);
1116  } else {
1117   croak(vmg_invalid_wiz);
1118  }
1119
1120  {
1121   dMY_CXT;
1122   return (old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0))
1123           ? *old : NULL;
1124  }
1125 }
1126
1127 #define VMG_SET_CB(S, N)              \
1128  cb = (S);                            \
1129  w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
1130
1131 #define VMG_SET_SVT_CB(S, N)          \
1132  cb = (S);                            \
1133  if (SvOK(cb) && SvROK(cb)) {         \
1134   t->svt_ ## N = vmg_svt_ ## N;       \
1135   w->cb_  ## N = newRV_inc(SvRV(cb)); \
1136  } else {                             \
1137   t->svt_ ## N = NULL;                \
1138   w->cb_  ## N = NULL;                \
1139  }
1140
1141 #if VMG_THREADSAFE
1142
1143 #define VMG_CLONE_CB(N) \
1144  z->cb_ ## N = (w->cb_ ## N) ? newRV_inc(vmg_clone(SvRV(w->cb_ ## N), \
1145                                          w->owner))                   \
1146                              : NULL;
1147
1148 STATIC MGWIZ *vmg_wizard_clone(pTHX_ const MGWIZ *w) {
1149 #define vmg_wizard_clone(W) vmg_wizard_clone(aTHX_ (W))
1150  MGVTBL *t;
1151  MGWIZ *z;
1152
1153  Newx(t, 1, MGVTBL);
1154  Copy(w->vtbl, t, 1, MGVTBL);
1155
1156  Newx(z, 1, MGWIZ);
1157  VMG_CLONE_CB(data);
1158  VMG_CLONE_CB(get);
1159  VMG_CLONE_CB(set);
1160  VMG_CLONE_CB(len);
1161  VMG_CLONE_CB(clear);
1162  VMG_CLONE_CB(free);
1163 #if MGf_COPY
1164  VMG_CLONE_CB(copy);
1165 #endif /* MGf_COPY */
1166 #if MGf_DUP
1167  VMG_CLONE_CB(dup);
1168 #endif /* MGf_DUP */
1169 #if MGf_LOCAL
1170  VMG_CLONE_CB(local);
1171 #endif /* MGf_LOCAL */
1172 #if VMG_UVAR
1173  VMG_CLONE_CB(fetch);
1174  VMG_CLONE_CB(store);
1175  VMG_CLONE_CB(exists);
1176  VMG_CLONE_CB(delete);
1177 #endif /* VMG_UVAR */
1178  z->owner  = aTHX;
1179  z->vtbl   = t;
1180  z->sig    = w->sig;
1181  z->uvar   = w->uvar;
1182  z->opinfo = w->opinfo;
1183
1184  return z;
1185 }
1186
1187 #endif /* VMG_THREADSAFE */
1188
1189 /* --- XS ------------------------------------------------------------------ */
1190
1191 MODULE = Variable::Magic            PACKAGE = Variable::Magic
1192
1193 PROTOTYPES: ENABLE
1194
1195 BOOT:
1196 {
1197  HV *stash;
1198  MY_CXT_INIT;
1199  MY_CXT.wizards = newHV();
1200  hv_iterinit(MY_CXT.wizards); /* Allocate iterator */
1201  MY_CXT.b__op_stashes[0] = NULL;
1202  stash = gv_stashpv(__PACKAGE__, 1);
1203  newCONSTSUB(stash, "SIG_MIN",   newSVuv(SIG_MIN));
1204  newCONSTSUB(stash, "SIG_MAX",   newSVuv(SIG_MAX));
1205  newCONSTSUB(stash, "SIG_NBR",   newSVuv(SIG_NBR));
1206  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1207  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1208  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1209  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1210  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1211                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1212  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1213                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1214  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1215                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1216  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1217                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1218  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1219  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1220  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1221  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1222 }
1223
1224 #if VMG_THREADSAFE
1225
1226 void
1227 CLONE(...)
1228 PROTOTYPE: DISABLE
1229 PREINIT:
1230  HV *hv;
1231  U32 had_b__op_stash = 0;
1232  opclass c;
1233 CODE:
1234  {
1235   HE *key;
1236   dMY_CXT;
1237   hv = newHV();
1238   hv_iterinit(hv); /* Allocate iterator */
1239   hv_iterinit(MY_CXT.wizards);
1240   while ((key = hv_iternext(MY_CXT.wizards))) {
1241    STRLEN len;
1242    char *sig = HePV(key, len);
1243    SV *sv;
1244    const MGWIZ *w;
1245    MAGIC *mg;
1246    w  = SV2MGWIZ(HeVAL(key));
1247    w  = vmg_wizard_clone(w);
1248    sv = MGWIZ2SV(w);
1249    mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1250    mg->mg_private = SIG_WZO;
1251    SvREADONLY_on(sv);
1252    if (!hv_store(hv, sig, len, sv, HeHASH(key))) croak("%s during CLONE", vmg_globstorefail);
1253   }
1254   for (c = 0; c < OPc_MAX; ++c) {
1255    if (MY_CXT.b__op_stashes[c])
1256     had_b__op_stash |= (((U32) 1) << c);
1257   }
1258  }
1259  {
1260   MY_CXT_CLONE;
1261   MY_CXT.wizards     = hv;
1262   for (c = 0; c < OPc_MAX; ++c) {
1263    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1264                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1265   }
1266  }
1267
1268 #endif /* VMG_THREADSAFE */
1269
1270 SV *_wizard(...)
1271 PROTOTYPE: DISABLE
1272 PREINIT:
1273  I32 i = 0;
1274  U16 sig;
1275  char buf[8];
1276  MGWIZ *w;
1277  MGVTBL *t;
1278  MAGIC *mg;
1279  SV *sv;
1280  SV *svsig;
1281  SV *cb;
1282 CODE:
1283  dMY_CXT;
1284
1285  if (items != 8
1286 #if MGf_COPY
1287               + 1
1288 #endif /* MGf_COPY */
1289 #if MGf_DUP
1290               + 1
1291 #endif /* MGf_DUP */
1292 #if MGf_LOCAL
1293               + 1
1294 #endif /* MGf_LOCAL */
1295 #if VMG_UVAR
1296               + 5
1297 #endif /* VMG_UVAR */
1298               ) { croak(vmg_wrongargnum); }
1299
1300  svsig = ST(i++);
1301  if (SvOK(svsig)) {
1302   SV **old;
1303   sig = vmg_sv2sig(svsig);
1304   if ((old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0))) {
1305    ST(0) = sv_2mortal(newRV_inc(*old));
1306    XSRETURN(1);
1307   }
1308  } else {
1309   sig = vmg_gensig();
1310  }
1311
1312  Newx(t, 1, MGVTBL);
1313  Newx(w, 1, MGWIZ);
1314
1315  VMG_SET_CB(ST(i++), data);
1316  cb = ST(i++);
1317  w->opinfo = SvOK(cb) ? SvUV(cb) : 0;
1318  if (w->opinfo)
1319   vmg_op_info_init(w->opinfo);
1320  VMG_SET_SVT_CB(ST(i++), get);
1321  VMG_SET_SVT_CB(ST(i++), set);
1322  VMG_SET_SVT_CB(ST(i++), len);
1323  VMG_SET_SVT_CB(ST(i++), clear);
1324  VMG_SET_SVT_CB(ST(i++), free);
1325 #if MGf_COPY
1326  VMG_SET_SVT_CB(ST(i++), copy);
1327 #endif /* MGf_COPY */
1328 #if MGf_DUP
1329  /* VMG_SET_SVT_CB(ST(i++), dup); */
1330  i++;
1331  t->svt_dup = NULL;
1332  w->cb_dup  = NULL;
1333 #endif /* MGf_DUP */
1334 #if MGf_LOCAL
1335  VMG_SET_SVT_CB(ST(i++), local);
1336 #endif /* MGf_LOCAL */
1337 #if VMG_UVAR
1338  VMG_SET_CB(ST(i++), fetch);
1339  VMG_SET_CB(ST(i++), store);
1340  VMG_SET_CB(ST(i++), exists);
1341  VMG_SET_CB(ST(i++), delete);
1342  cb = ST(i++);
1343  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1344   w->uvar = SvTRUE(cb) ? 2 : 1;
1345  else
1346   w->uvar = 0;
1347 #endif /* VMG_UVAR */
1348 #if VMG_MULTIPLICITY
1349  w->owner = aTHX;
1350 #endif /* VMG_MULTIPLICITY */
1351  w->vtbl  = t;
1352  w->sig   = sig;
1353
1354  sv = MGWIZ2SV(w);
1355  mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1356  mg->mg_private = SIG_WZO;
1357  SvREADONLY_on(sv);
1358
1359  if (!hv_store(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), sv, 0)) croak(vmg_globstorefail);
1360
1361  RETVAL = newRV_noinc(sv);
1362 OUTPUT:
1363  RETVAL
1364
1365 SV *gensig()
1366 PROTOTYPE:
1367 CODE:
1368  RETVAL = newSVuv(vmg_gensig());
1369 OUTPUT:
1370  RETVAL
1371
1372 SV *getsig(SV *wiz)
1373 PROTOTYPE: $
1374 CODE:
1375  if (!SvROK(wiz)) { croak(vmg_invalid_wiz); }
1376  RETVAL = newSVuv(SV2MGWIZ(SvRV(wiz))->sig);
1377 OUTPUT:
1378  RETVAL
1379
1380 SV *cast(SV *sv, SV *wiz, ...)
1381 PROTOTYPE: \[$@%&*]$@
1382 PREINIT:
1383  AV *args = NULL;
1384  SV *ret;
1385 CODE:
1386  wiz = vmg_wizard_wiz(wiz);
1387  if (!wiz)
1388   XSRETURN_UNDEF;
1389  if (items > 2) {
1390   I32 i;
1391   args = newAV();
1392   av_fill(args, items - 2);
1393   for (i = 2; i < items; ++i) {
1394    SV *arg = ST(i);
1395    SvREFCNT_inc(arg);
1396    if (av_store(args, i - 2, arg) == NULL) { croak(vmg_argstorefailed); }
1397   }
1398  }
1399  ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1400  SvREFCNT_dec(args);
1401  RETVAL = ret;
1402 OUTPUT:
1403  RETVAL
1404
1405 void
1406 getdata(SV *sv, SV *wiz)
1407 PROTOTYPE: \[$@%&*]$
1408 PREINIT:
1409  SV *data;
1410  U16 sig;
1411 PPCODE:
1412  sig  = vmg_wizard_sig(wiz);
1413  data = vmg_data_get(SvRV(sv), sig);
1414  if (!data) { XSRETURN_UNDEF; }
1415  ST(0) = data;
1416  XSRETURN(1);
1417
1418 SV *dispell(SV *sv, SV *wiz)
1419 PROTOTYPE: \[$@%&*]$
1420 PREINIT:
1421  U16 sig;
1422 CODE:
1423  sig = vmg_wizard_sig(wiz);
1424  RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));
1425 OUTPUT:
1426  RETVAL