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 mPUSHi
  97 # define mPUSHi(I) PUSHs(sv_2mortal(newSViv(I)))
  98 #endif
  99
 100 #ifndef PERL_MAGIC_ext
 101 # define PERL_MAGIC_ext '~'
 102 #endif
 103
 104 #ifndef MGf_COPY
 105 # define MGf_COPY 0
 106 #endif
 107
 108 #ifndef MGf_DUP
 109 # define MGf_DUP 0
 110 #endif
 111
 112 #ifndef MGf_LOCAL
 113 # define MGf_LOCAL 0
 114 #endif
 115
 116 #ifndef IN_PERL_COMPILETIME
 117 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
 118 #endif
 119
 120 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
 121 # ifndef PL_error_count
 122 #  define PL_error_count PL_parser->error_count
 123 # endif
 124 #else
 125 # ifndef PL_error_count
 126 #  define PL_error_count PL_Ierror_count
 127 # endif
 128 #endif
 129
 130 /* uvar magic and Hash::Util::FieldHash were commited with 28419 */
 131 #if VMG_HAS_PERL_MAINT(5, 9, 4, 28419) || VMG_HAS_PERL(5, 10, 0)
 132 # define VMG_UVAR 1
 133 #else
 134 # define VMG_UVAR 0
 135 #endif
 136
 137 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160 */
 138 #ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
 139 # if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
 140 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
 141 # else
 142 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
 143 # endif
 144 #endif
 145
 146 /* Applied to dev-5.11 as 34908 */
 147 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908)
 148 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
 149 #else
 150 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
 151 #endif
 152
 153 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
 154 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
 155 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
 156 #else
 157 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
 158 #endif
 159
 160 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969)
 161 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
 162 #else
 163 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
 164 #endif
 165
 166 #if VMG_UVAR
 167
 168 /* Bug-free mg_magical - see http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html - but specialized to our needs. */
 169 STATIC void vmg_sv_magicuvar(pTHX_ SV *sv, const char *uf, I32 len) {
 170 #define vmg_sv_magicuvar(S, U, L) vmg_sv_magicuvar(aTHX_ (S), (U), (L))
 171  const MAGIC* mg;
 172  sv_magic(sv, NULL, PERL_MAGIC_uvar, uf, len);
 173  /* uvar magic has set and get magic, hence this has set SVs_GMG and SVs_SMG. */
 174  if ((mg = SvMAGIC(sv))) {
 175   SvRMAGICAL_off(sv);
 176   do {
 177    const MGVTBL* const vtbl = mg->mg_virtual;
 178    if (vtbl) {
 179     if (vtbl->svt_clear) {
 180      SvRMAGICAL_on(sv);
 181      break;
 182     }
 183    }
 184   } while ((mg = mg->mg_moremagic));
 185  }
 186 }
 187
 188 #endif /* VMG_UVAR */
 189
 190 /* --- Context-safe global data -------------------------------------------- */
 191
 192 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 193
 194 typedef HV * my_cxt_t;
 195
 196 START_MY_CXT
 197
 198 /* --- Signatures ---------------------------------------------------------- */
 199
 200 #define SIG_MIN ((U16) (1u << 8))
 201 #define SIG_MAX ((U16) ((1u << 16) - 1))
 202 #define SIG_NBR (SIG_MAX - SIG_MIN + 1)
 203 #define SIG_WIZ ((U16) ((1u << 8) - 1))
 204
 205 /* ... Generate signatures ................................................. */
 206
 207 STATIC U16 vmg_gensig(pTHX) {
 208 #define vmg_gensig() vmg_gensig(aTHX)
 209  U16 sig;
 210  char buf[8];
 211  dMY_CXT;
 212
 213  do {
 214   sig = SIG_NBR * Drand01() + SIG_MIN;
 215  } while (hv_exists(MY_CXT, buf, sprintf(buf, "%u", sig)));
 216
 217  return sig;
 218 }
 219
 220 /* --- MGWIZ structure ----------------------------------------------------- */
 221
 222 typedef struct {
 223  MGVTBL *vtbl;
 224  U16 sig;
 225  U16 uvar;
 226  SV *cb_data;
 227  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
 228 #if MGf_COPY
 229  SV *cb_copy;
 230 #endif /* MGf_COPY */
 231 #if MGf_DUP
 232  SV *cb_dup;
 233 #endif /* MGf_DUP */
 234 #if MGf_LOCAL
 235  SV *cb_local;
 236 #endif /* MGf_LOCAL */
 237 #if VMG_UVAR
 238  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
 239 #endif /* VMG_UVAR */
 240 #if VMG_MULTIPLICITY
 241  tTHX owner;
 242 #endif /* VMG_MULTIPLICITY */
 243 } MGWIZ;
 244
 245 #define MGWIZ2SV(W) (newSVuv(PTR2UV(W)))
 246 #define SV2MGWIZ(S) (INT2PTR(MGWIZ*, SvUVX((SV *) (S))))
 247
 248 /* ... Construct private data .............................................. */
 249
 250 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, AV *args) {
 251 #define vmg_data_new(C, S, A) vmg_data_new(aTHX_ (C), (S), (A))
 252  SV *nsv;
 253  I32 i, alen = (args == NULL) ? 0 : av_len(args);
 254
 255  dSP;
 256
 257  ENTER;
 258  SAVETMPS;
 259
 260  PUSHMARK(SP);
 261  EXTEND(SP, alen + 1);
 262  PUSHs(sv_2mortal(newRV_inc(sv)));
 263  for (i = 0; i < alen; ++i)
 264   PUSHs(*av_fetch(args, i, 0));
 265  PUTBACK;
 266
 267  call_sv(ctor, G_SCALAR);
 268
 269  SPAGAIN;
 270  nsv = POPs;
 271 #if VMG_HAS_PERL(5, 8, 3)
 272  SvREFCNT_inc(nsv);    /* Or it will be destroyed in FREETMPS */
 273 #else
 274  nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
 275 #endif
 276  PUTBACK;
 277
 278  FREETMPS;
 279  LEAVE;
 280
 281  return nsv;
 282 }
 283
 284 STATIC SV *vmg_data_get(SV *sv, U16 sig) {
 285  MAGIC *mg, *moremagic;
 286
 287  if (SvTYPE(sv) >= SVt_PVMG) {
 288   for (mg = SvMAGIC(sv); mg; mg = moremagic) {
 289    moremagic = mg->mg_moremagic;
 290    if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == sig)) { break; }
 291   }
 292   if (mg) { return mg->mg_obj; }
 293  }
 294
 295  return NULL;
 296 }
 297
 298 /* ... Magic cast/dispell .................................................. */
 299
 300 #if VMG_UVAR
 301 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
 302
 303 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 304  if (prevmagic) {
 305   prevmagic->mg_moremagic = moremagic;
 306  } else {
 307   SvMAGIC_set(sv, moremagic);
 308  }
 309  mg->mg_moremagic = NULL;
 310  Safefree(mg->mg_ptr);
 311  Safefree(mg);
 312 }
 313 #endif /* VMG_UVAR */
 314
 315 STATIC UV vmg_cast(pTHX_ SV *sv, SV *wiz, AV *args) {
 316 #define vmg_cast(S, W, A) vmg_cast(aTHX_ (S), (W), (A))
 317  MAGIC *mg = NULL, *moremagic = NULL;
 318  MGWIZ *w;
 319  SV *data;
 320
 321  w = SV2MGWIZ(wiz);
 322
 323  if (SvTYPE(sv) >= SVt_PVMG) {
 324   for (mg = SvMAGIC(sv); mg; mg = moremagic) {
 325    moremagic = mg->mg_moremagic;
 326    if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == w->sig)) { break; }
 327   }
 328   if (mg) { return 1; }
 329  }
 330
 331  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args) : NULL;
 332  mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
 333  mg->mg_private = w->sig;
 334 #if MGf_COPY
 335  if (w->cb_copy)
 336   mg->mg_flags |= MGf_COPY;
 337 #endif /* MGf_COPY */
 338 #if 0 /* MGf_DUP */
 339  if (w->cb_dup)
 340   mg->mg_flags |= MGf_DUP;
 341 #endif /* MGf_DUP */
 342 #if MGf_LOCAL
 343  if (w->cb_local)
 344   mg->mg_flags |= MGf_LOCAL;
 345 #endif /* MGf_LOCAL */
 346
 347 #if VMG_UVAR
 348  if (w->uvar && SvTYPE(sv) >= SVt_PVHV) {
 349   MAGIC *prevmagic;
 350   int add_uvar = 1;
 351   struct ufuncs uf[2];
 352
 353   uf[0].uf_val   = vmg_svt_val;
 354   uf[0].uf_set   = NULL;
 355   uf[0].uf_index = 0;
 356   uf[1].uf_val   = NULL;
 357   uf[1].uf_set   = NULL;
 358   uf[1].uf_index = 0;
 359
 360   /* One uvar magic in the chain is enough. */
 361   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 362    moremagic = mg->mg_moremagic;
 363    if (mg->mg_type == PERL_MAGIC_uvar) { break; }
 364   }
 365
 366   if (mg) { /* Found another uvar magic. */
 367    struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
 368    if (olduf->uf_val == vmg_svt_val) {
 369     /* It's our uvar magic, nothing to do. */
 370     add_uvar = 0;
 371    } else {
 372     /* It's another uvar magic, backup it and replace it by ours. */
 373     uf[1] = *olduf;
 374     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 375    }
 376   }
 377
 378   if (add_uvar) {
 379    vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
 380   }
 381
 382  }
 383 #endif /* VMG_UVAR */
 384
 385  return 1;
 386 }
 387
 388 STATIC UV vmg_dispell(pTHX_ SV *sv, U16 sig) {
 389 #define vmg_dispell(S, Z) vmg_dispell(aTHX_ (S), (Z))
 390 #if VMG_UVAR
 391  U32 uvars = 0;
 392 #endif /* VMG_UVAR */
 393  MAGIC *mg, *prevmagic, *moremagic = NULL;
 394
 395  if (SvTYPE(sv) < SVt_PVMG) { return 0; }
 396
 397  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 398   moremagic = mg->mg_moremagic;
 399   if (mg->mg_type == PERL_MAGIC_ext) {
 400    if (mg->mg_private == sig) {
 401 #if VMG_UVAR
 402     /* If the current has no uvar, short-circuit uvar deletion. */
 403     uvars = (SV2MGWIZ(mg->mg_ptr)->uvar) ? (uvars + 1) : 0;
 404 #endif /* VMG_UVAR */
 405     break;
 406 #if VMG_UVAR
 407    } else if ((mg->mg_private >= SIG_MIN) &&
 408               (mg->mg_private <= SIG_MAX) &&
 409                SV2MGWIZ(mg->mg_ptr)->uvar) {
 410     ++uvars;
 411     /* We can't break here since we need to find the ext magic to delete. */
 412 #endif /* VMG_UVAR */
 413    }
 414   }
 415  }
 416  if (!mg) { return 0; }
 417
 418  if (prevmagic) {
 419   prevmagic->mg_moremagic = moremagic;
 420  } else {
 421   SvMAGIC_set(sv, moremagic);
 422  }
 423  mg->mg_moremagic = NULL;
 424
 425  if (mg->mg_obj != sv) { SvREFCNT_dec(mg->mg_obj); } /* Destroy private data */
 426  SvREFCNT_dec((SV *) mg->mg_ptr); /* Unreference the wizard */
 427  Safefree(mg);
 428
 429 #if VMG_UVAR
 430  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
 431   /* mg was the first ext magic in the chain that had uvar */
 432
 433   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
 434    if ((mg->mg_type == PERL_MAGIC_ext) &&
 435        (mg->mg_private >= SIG_MIN) &&
 436        (mg->mg_private <= SIG_MAX) &&
 437         SV2MGWIZ(mg->mg_ptr)->uvar) {
 438     ++uvars;
 439     break;
 440    }
 441   }
 442
 443   if (uvars == 1) {
 444    struct ufuncs *uf;
 445    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
 446     moremagic = mg->mg_moremagic;
 447     if (mg->mg_type == PERL_MAGIC_uvar) { break; }
 448    }
 449    /* assert(mg); */
 450    uf = (struct ufuncs *) mg->mg_ptr;
 451    /* assert(uf->uf_val == vmg_svt_val); */
 452    if (uf[1].uf_val || uf[1].uf_set) {
 453     /* Revert the original uvar magic. */
 454     uf[0] = uf[1];
 455     Renew(uf, 1, struct ufuncs);
 456     mg->mg_ptr = (char *) uf;
 457     mg->mg_len = sizeof(struct ufuncs);
 458    } else {
 459     /* Remove the uvar magic. */
 460     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 461    }
 462   }
 463  }
 464 #endif /* VMG_UVAR */
 465
 466  return 1;
 467 }
 468
 469 /* ... svt callbacks ....................................................... */
 470
 471 #define VMG_CB_CALL_ARGS_MASK 15
 472 #define VMG_CB_CALL_EVAL      16
 473
 474 STATIC int vmg_cb_call(pTHX_ SV *cb, SV *sv, SV *data, unsigned int flags, ...){
 475  va_list ap;
 476  SV *svr;
 477  int ret;
 478  unsigned int i;
 479  unsigned int args = flags & VMG_CB_CALL_ARGS_MASK;
 480  unsigned int eval = flags & VMG_CB_CALL_EVAL ? G_EVAL : 0;
 481
 482  dSP;
 483
 484  ENTER;
 485  SAVETMPS;
 486
 487  PUSHMARK(SP);
 488  EXTEND(SP, args + 2);
 489  PUSHs(sv_2mortal(newRV_inc(sv)));
 490  PUSHs(data ? data : &PL_sv_undef);
 491  va_start(ap, flags);
 492  for (i = 0; i < args; ++i) {
 493   SV *sva = va_arg(ap, SV *);
 494   PUSHs(sva ? sva : &PL_sv_undef);
 495  }
 496  va_end(ap);
 497  PUTBACK;
 498
 499  call_sv(cb, G_SCALAR | eval);
 500
 501  SPAGAIN;
 502  if (eval && IN_PERL_COMPILETIME && SvTRUE(ERRSV))
 503   ++PL_error_count;
 504  svr = POPs;
 505  ret = SvOK(svr) ? SvIV(svr) : 0;
 506  PUTBACK;
 507
 508  FREETMPS;
 509  LEAVE;
 510
 511  return ret;
 512 }
 513
 514 #define vmg_cb_call1(I, S, D)         vmg_cb_call(aTHX_ (I), (S), (D), 0)
 515 #define vmg_cb_call1e(I, S, D)        vmg_cb_call(aTHX_ (I), (S), (D), VMG_CB_CALL_EVAL)
 516 #define vmg_cb_call2(I, S, D, S2)     vmg_cb_call(aTHX_ (I), (S), (D), 1, (S2))
 517 #define vmg_cb_call3(I, S, D, S2, S3) vmg_cb_call(aTHX_ (I), (S), (D), 2, (S2), (S3))
 518
 519 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
 520  return vmg_cb_call1(SV2MGWIZ(mg->mg_ptr)->cb_get, sv, mg->mg_obj);
 521 }
 522
 523 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
 524  return vmg_cb_call1(SV2MGWIZ(mg->mg_ptr)->cb_set, sv, mg->mg_obj);
 525 }
 526
 527 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
 528  SV *svr;
 529  I32 len, has_array;
 530  U32 ret;
 531
 532  dSP;
 533  int count;
 534
 535  has_array = SvTYPE(sv) == SVt_PVAV;
 536
 537  ENTER;
 538  SAVETMPS;
 539
 540  PUSHMARK(SP);
 541  EXTEND(SP, 3);
 542  PUSHs(sv_2mortal(newRV_inc(sv)));
 543  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
 544  if (has_array) {
 545   len = av_len((AV *) sv) + 1;
 546   mPUSHi(len);
 547  } else {
 548   len = 0;
 549   PUSHs(&PL_sv_undef);
 550  }
 551  PUTBACK;
 552
 553  count = call_sv(SV2MGWIZ(mg->mg_ptr)->cb_len, G_SCALAR);
 554
 555  SPAGAIN;
 556  svr = POPs;
 557  ret = SvOK(svr) ? SvUV(svr) : len;
 558  PUTBACK;
 559
 560  FREETMPS;
 561  LEAVE;
 562
 563  return has_array ? ret - 1 : ret;
 564 }
 565
 566 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
 567  return vmg_cb_call1(SV2MGWIZ(mg->mg_ptr)->cb_clear, sv, mg->mg_obj);
 568 }
 569
 570 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
 571  SV *wiz = (SV *) mg->mg_ptr;
 572  int ret = 0;
 573
 574  /* This may happen in global destruction */
 575  if (SvTYPE(wiz) == SVTYPEMASK)
 576   return 0;
 577
 578  /* So that it can survive tmp cleanup in vmg_cb_call */
 579  SvREFCNT_inc(sv);
 580
 581 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
 582  /* The previous magic tokens were freed but the magic chain wasn't updated, so
 583   * if you access the sv from the callback the old deleted magics will trigger
 584   * and cause memory misreads. Change 32686 solved it that way : */
 585  SvMAGIC_set(sv, mg);
 586 #endif
 587
 588  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
 589   * mg->mg_ptr reference count */
 590  ret = vmg_cb_call1e(SV2MGWIZ(wiz)->cb_free, sv, mg->mg_obj);
 591
 592  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
 593   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
 594  --SvREFCNT(sv);
 595
 596  return ret;
 597 }
 598
 599 #if MGf_COPY
 600 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
 601 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
 602   I32 keylen
 603 # else
 604   int keylen
 605 # endif
 606  ) {
 607  SV *keysv;
 608  int ret;
 609
 610  if (keylen == HEf_SVKEY) {
 611   keysv = (SV *) key;
 612  } else {
 613   keysv = newSVpvn(key, keylen);
 614  }
 615
 616  ret = vmg_cb_call3(SV2MGWIZ(mg->mg_ptr)->cb_copy, sv, mg->mg_obj, keysv, nsv);
 617
 618  if (keylen != HEf_SVKEY) {
 619   SvREFCNT_dec(keysv);
 620  }
 621
 622  return ret;
 623 }
 624 #endif /* MGf_COPY */
 625
 626 #if 0 /*  MGf_DUP */
 627 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
 628  return 0;
 629 }
 630 #endif /* MGf_DUP */
 631
 632 #if MGf_LOCAL
 633 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
 634  return vmg_cb_call1(SV2MGWIZ(mg->mg_ptr)->cb_local, nsv, mg->mg_obj);
 635 }
 636 #endif /* MGf_LOCAL */
 637
 638 #if VMG_UVAR
 639 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
 640  struct ufuncs *uf;
 641  MAGIC *mg;
 642  SV *key = NULL;
 643
 644  mg  = mg_find(sv, PERL_MAGIC_uvar);
 645  /* mg can't be NULL or we wouldn't be there. */
 646  key = mg->mg_obj;
 647  uf  = (struct ufuncs *) mg->mg_ptr;
 648
 649  if (uf[1].uf_val != NULL) { uf[1].uf_val(aTHX_ action, sv); }
 650  if (uf[1].uf_set != NULL) { uf[1].uf_set(aTHX_ action, sv); }
 651
 652  action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
 653  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 654   MGWIZ *w;
 655   if ((mg->mg_type != PERL_MAGIC_ext)
 656    || (mg->mg_private < SIG_MIN)
 657    || (mg->mg_private > SIG_MAX)) { continue; }
 658   w = SV2MGWIZ(mg->mg_ptr);
 659   if (!w->uvar) { continue; }
 660   switch (action) {
 661    case 0:
 662     if (w->cb_fetch)  { vmg_cb_call2(w->cb_fetch,  sv, mg->mg_obj, key); }
 663     break;
 664    case HV_FETCH_ISSTORE:
 665    case HV_FETCH_LVALUE:
 666    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
 667     if (w->cb_store)  { vmg_cb_call2(w->cb_store,  sv, mg->mg_obj, key); }
 668     break;
 669    case HV_FETCH_ISEXISTS:
 670     if (w->cb_exists) { vmg_cb_call2(w->cb_exists, sv, mg->mg_obj, key); }
 671     break;
 672    case HV_DELETE:
 673     if (w->cb_delete) { vmg_cb_call2(w->cb_delete, sv, mg->mg_obj, key); }
 674     break;
 675   }
 676  }
 677
 678  return 0;
 679 }
 680 #endif /* VMG_UVAR */
 681
 682 /* ... Wizard destructor ................................................... */
 683
 684 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
 685  char buf[8];
 686  MGWIZ *w;
 687
 688  if (PL_dirty) /* During global destruction, the context is already freed */
 689   return 0;
 690
 691  w = SV2MGWIZ(wiz);
 692 #if VMG_MULTIPLICITY
 693  if (w->owner != aTHX)
 694   return 0;
 695  w->owner = NULL;
 696 #endif /* VMG_MULTIPLICITY */
 697
 698  {
 699   dMY_CXT;
 700   if (hv_delete(MY_CXT, buf, sprintf(buf, "%u", w->sig), 0) != wiz)
 701    return 0;
 702  }
 703  SvFLAGS(wiz) |= SVf_BREAK;
 704  FREETMPS;
 705
 706  if (w->cb_data  != NULL) { SvREFCNT_dec(SvRV(w->cb_data)); }
 707  if (w->cb_get   != NULL) { SvREFCNT_dec(SvRV(w->cb_get)); }
 708  if (w->cb_set   != NULL) { SvREFCNT_dec(SvRV(w->cb_set)); }
 709  if (w->cb_len   != NULL) { SvREFCNT_dec(SvRV(w->cb_len)); }
 710  if (w->cb_clear != NULL) { SvREFCNT_dec(SvRV(w->cb_clear)); }
 711  if (w->cb_free  != NULL) { SvREFCNT_dec(SvRV(w->cb_free)); }
 712 #if MGf_COPY
 713  if (w->cb_copy  != NULL) { SvREFCNT_dec(SvRV(w->cb_copy)); }
 714 #endif /* MGf_COPY */
 715 #if 0 /* MGf_DUP */
 716  if (w->cb_dup   != NULL) { SvREFCNT_dec(SvRV(w->cb_dup)); }
 717 #endif /* MGf_DUP */
 718 #if MGf_LOCAL
 719  if (w->cb_local != NULL) { SvREFCNT_dec(SvRV(w->cb_local)); }
 720 #endif /* MGf_LOCAL */
 721 #if VMG_UVAR
 722  if (w->cb_fetch  != NULL) { SvREFCNT_dec(SvRV(w->cb_fetch)); }
 723  if (w->cb_store  != NULL) { SvREFCNT_dec(SvRV(w->cb_store)); }
 724  if (w->cb_exists != NULL) { SvREFCNT_dec(SvRV(w->cb_exists)); }
 725  if (w->cb_delete != NULL) { SvREFCNT_dec(SvRV(w->cb_delete)); }
 726 #endif /* VMG_UVAR */
 727
 728  Safefree(w->vtbl);
 729  Safefree(w);
 730
 731  return 0;
 732 }
 733
 734 STATIC MGVTBL vmg_wizard_vtbl = {
 735  NULL,            /* get */
 736  NULL,            /* set */
 737  NULL,            /* len */
 738  NULL,            /* clear */
 739  vmg_wizard_free, /* free */
 740 #if MGf_COPY
 741  NULL,            /* copy */
 742 #endif /* MGf_COPY */
 743 #if MGf_DUP
 744  NULL,            /* dup */
 745 #endif /* MGf_DUP */
 746 #if MGf_LOCAL
 747  NULL,            /* local */
 748 #endif /* MGf_LOCAL */
 749 };
 750
 751 STATIC const char vmg_invalid_wiz[]    = "Invalid wizard object";
 752 STATIC const char vmg_invalid_sig[]    = "Invalid numeric signature";
 753 STATIC const char vmg_wrongargnum[]    = "Wrong number of arguments";
 754 STATIC const char vmg_toomanysigs[]    = "Too many magic signatures used";
 755 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
 756
 757 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
 758 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
 759  U16 sig;
 760
 761  if (SvIOK(sv)) {
 762   sig = SvUVX(sv);
 763  } else if (SvNOK(sv)) {
 764   sig = SvNVX(sv);
 765  } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
 766   sig = SvUV(sv);
 767  } else {
 768   croak(vmg_invalid_sig);
 769  }
 770  if (sig < SIG_MIN) { sig += SIG_MIN; }
 771  if (sig > SIG_MAX) { sig %= SIG_MAX + 1; }
 772
 773  return sig;
 774 }
 775
 776 STATIC U16 vmg_wizard_sig(pTHX_ SV *wiz) {
 777 #define vmg_wizard_sig(W) vmg_wizard_sig(aTHX_ (W))
 778  char buf[8];
 779  U16 sig;
 780
 781  if (SvROK(wiz)) {
 782   sig = SV2MGWIZ(SvRV(wiz))->sig;
 783  } else if (SvOK(wiz)) {
 784   sig = vmg_sv2sig(wiz);
 785  } else {
 786   croak(vmg_invalid_wiz);
 787  }
 788
 789  {
 790   dMY_CXT;
 791   if (!hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))
 792    sig = 0;
 793  }
 794  return sig;
 795 }
 796
 797 STATIC SV *vmg_wizard_wiz(pTHX_ SV *wiz) {
 798 #define vmg_wizard_wiz(W) vmg_wizard_wiz(aTHX_ (W))
 799  char buf[8];
 800  SV **old;
 801  U16 sig;
 802
 803  if (SvROK(wiz)) {
 804   wiz = SvRV(wiz);
 805 #if VMG_MULTIPLICITY
 806   if (SV2MGWIZ(wiz)->owner == aTHX)
 807    return wiz;
 808 #endif /* VMG_MULTIPLICITY */
 809   sig = SV2MGWIZ(wiz)->sig;
 810  } else if (SvOK(wiz)) {
 811   sig = vmg_sv2sig(wiz);
 812  } else {
 813   croak(vmg_invalid_wiz);
 814  }
 815
 816  {
 817   dMY_CXT;
 818   return (old = hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))
 819           ? *old : NULL;
 820  }
 821 }
 822
 823 #define VMG_SET_CB(S, N)              \
 824  cb = (S);                            \
 825  w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
 826
 827 #define VMG_SET_SVT_CB(S, N)          \
 828  cb = (S);                            \
 829  if (SvOK(cb) && SvROK(cb)) {         \
 830   t->svt_ ## N = vmg_svt_ ## N;       \
 831   w->cb_  ## N = newRV_inc(SvRV(cb)); \
 832  } else {                             \
 833   t->svt_ ## N = NULL;                \
 834   w->cb_  ## N = NULL;                \
 835  }
 836
 837 #if VMG_THREADSAFE
 838
 839 #define VMG_CLONE_CB(N) \
 840  z->cb_ ## N = (w->cb_ ## N) ? newRV_inc(vmg_clone(SvRV(w->cb_ ## N), \
 841                                          w->owner))                   \
 842                              : NULL;
 843
 844 STATIC MGWIZ *vmg_wizard_clone(pTHX_ const MGWIZ *w) {
 845 #define vmg_wizard_clone(W) vmg_wizard_clone(aTHX_ (W))
 846  MGVTBL *t;
 847  MGWIZ *z;
 848
 849  Newx(t, 1, MGVTBL);
 850  Copy(w->vtbl, t, 1, MGVTBL);
 851
 852  Newx(z, 1, MGWIZ);
 853  VMG_CLONE_CB(data);
 854  VMG_CLONE_CB(get);
 855  VMG_CLONE_CB(set);
 856  VMG_CLONE_CB(len);
 857  VMG_CLONE_CB(clear);
 858  VMG_CLONE_CB(free);
 859 #if MGf_COPY
 860  VMG_CLONE_CB(copy);
 861 #endif /* MGf_COPY */
 862 #if MGf_DUP
 863  VMG_CLONE_CB(dup);
 864 #endif /* MGf_DUP */
 865 #if MGf_LOCAL
 866  VMG_CLONE_CB(local);
 867 #endif /* MGf_LOCAL */
 868 #if VMG_UVAR
 869  VMG_CLONE_CB(fetch);
 870  VMG_CLONE_CB(store);
 871  VMG_CLONE_CB(exists);
 872  VMG_CLONE_CB(delete);
 873 #endif /* VMG_UVAR */
 874  z->owner = aTHX;
 875  z->vtbl  = t;
 876  z->sig   = w->sig;
 877  z->uvar  = w->uvar;
 878
 879  return z;
 880 }
 881
 882 #endif /* VMG_THREADSAFE */
 883
 884 /* --- XS ------------------------------------------------------------------ */
 885
 886 MODULE = Variable::Magic            PACKAGE = Variable::Magic
 887
 888 PROTOTYPES: ENABLE
 889
 890 BOOT:
 891 {
 892  HV *stash;
 893  MY_CXT_INIT;
 894  MY_CXT = newHV();
 895  hv_iterinit(MY_CXT); /* Allocate iterator */
 896  stash = gv_stashpv(__PACKAGE__, 1);
 897  newCONSTSUB(stash, "SIG_MIN",   newSVuv(SIG_MIN));
 898  newCONSTSUB(stash, "SIG_MAX",   newSVuv(SIG_MAX));
 899  newCONSTSUB(stash, "SIG_NBR",   newSVuv(SIG_NBR));
 900  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
 901  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
 902  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
 903  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
 904  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
 905                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
 906  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
 907                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
 908  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
 909                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
 910  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
 911                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
 912  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
 913  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
 914 }
 915
 916 void
 917 CLONE(...)
 918 PROTOTYPE: DISABLE
 919 PREINIT:
 920  HV *hv;
 921 CODE:
 922 #if VMG_THREADSAFE
 923  {
 924   HE *key;
 925   dMY_CXT;
 926   hv = newHV();
 927   hv_iterinit(hv); /* Allocate iterator */
 928   hv_iterinit(MY_CXT);
 929   while ((key = hv_iternext(MY_CXT))) {
 930    STRLEN len;
 931    char *sig = HePV(key, len);
 932    SV *sv;
 933    MAGIC *mg;
 934    sv = MGWIZ2SV(vmg_wizard_clone(SV2MGWIZ(HeVAL(key))));
 935    mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
 936    mg->mg_private = SIG_WIZ;
 937    SvREADONLY_on(sv);
 938    hv_store(hv, sig, len, sv, HeHASH(key));
 939   }
 940  }
 941  {
 942   MY_CXT_CLONE;
 943   MY_CXT = hv;
 944  }
 945 #endif /* VMG_THREADSAFE */
 946
 947 SV *_wizard(...)
 948 PROTOTYPE: DISABLE
 949 PREINIT:
 950  I32 i = 0;
 951  U16 sig;
 952  char buf[8];
 953  MGWIZ *w;
 954  MGVTBL *t;
 955  MAGIC *mg;
 956  SV *sv;
 957  SV *svsig;
 958  SV *cb;
 959 CODE:
 960  dMY_CXT;
 961
 962  if (items != 7
 963 #if MGf_COPY
 964               + 1
 965 #endif /* MGf_COPY */
 966 #if MGf_DUP
 967               + 1
 968 #endif /* MGf_DUP */
 969 #if MGf_LOCAL
 970               + 1
 971 #endif /* MGf_LOCAL */
 972 #if VMG_UVAR
 973               + 4
 974 #endif /* VMG_UVAR */
 975               ) { croak(vmg_wrongargnum); }
 976
 977  svsig = ST(i++);
 978  if (SvOK(svsig)) {
 979   SV **old;
 980   sig = vmg_sv2sig(svsig);
 981   if ((old = hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))) {
 982    ST(0) = sv_2mortal(newRV_inc(*old));
 983    XSRETURN(1);
 984   }
 985  } else {
 986   if (HvKEYS(MY_CXT) >= SIG_NBR) { croak(vmg_toomanysigs); }
 987   sig = vmg_gensig();
 988  }
 989
 990  Newx(t, 1, MGVTBL);
 991  Newx(w, 1, MGWIZ);
 992
 993  VMG_SET_CB(ST(i++), data);
 994  VMG_SET_SVT_CB(ST(i++), get);
 995  VMG_SET_SVT_CB(ST(i++), set);
 996  VMG_SET_SVT_CB(ST(i++), len);
 997  VMG_SET_SVT_CB(ST(i++), clear);
 998  VMG_SET_SVT_CB(ST(i++), free);
 999 #if MGf_COPY
1000  VMG_SET_SVT_CB(ST(i++), copy);
1001 #endif /* MGf_COPY */
1002 #if MGf_DUP
1003  /* VMG_SET_SVT_CB(ST(i++), dup); */
1004  i++;
1005  t->svt_dup = NULL;
1006  w->cb_dup  = NULL;
1007 #endif /* MGf_DUP */
1008 #if MGf_LOCAL
1009  VMG_SET_SVT_CB(ST(i++), local);
1010 #endif /* MGf_LOCAL */
1011 #if VMG_UVAR
1012  VMG_SET_CB(ST(i++), fetch);
1013  VMG_SET_CB(ST(i++), store);
1014  VMG_SET_CB(ST(i++), exists);
1015  VMG_SET_CB(ST(i++), delete);
1016 #endif /* VMG_UVAR */
1017 #if VMG_MULTIPLICITY
1018  w->owner = aTHX;
1019 #endif /* VMG_MULTIPLICITY */
1020
1021  w->vtbl = t;
1022  w->sig  = sig;
1023 #if VMG_UVAR
1024  w->uvar = (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete);
1025 #endif /* VMG_UVAR */
1026
1027  sv = MGWIZ2SV(w);
1028  mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1029  mg->mg_private = SIG_WIZ;
1030  SvREADONLY_on(sv);
1031
1032  hv_store(MY_CXT, buf, sprintf(buf, "%u", sig), sv, 0);
1033
1034  RETVAL = newRV_noinc(sv);
1035 OUTPUT:
1036  RETVAL
1037
1038 SV *gensig()
1039 PROTOTYPE:
1040 CODE:
1041  dMY_CXT;
1042  if (HvKEYS(MY_CXT) >= SIG_NBR) { croak(vmg_toomanysigs); }
1043  RETVAL = newSVuv(vmg_gensig());
1044 OUTPUT:
1045  RETVAL
1046
1047 SV *getsig(SV *wiz)
1048 PROTOTYPE: $
1049 CODE:
1050  if (!SvROK(wiz)) { croak(vmg_invalid_wiz); }
1051  RETVAL = newSVuv(SV2MGWIZ(SvRV(wiz))->sig);
1052 OUTPUT:
1053  RETVAL
1054
1055 SV *cast(SV *sv, SV *wiz, ...)
1056 PROTOTYPE: \[$@%&*]$@
1057 PREINIT:
1058  AV *args = NULL;
1059  SV *ret;
1060 CODE:
1061  wiz = vmg_wizard_wiz(wiz);
1062  if (!wiz)
1063   XSRETURN_UNDEF;
1064  if (items > 2) {
1065   I32 i;
1066   args = newAV();
1067   av_fill(args, items - 2);
1068   for (i = 2; i < items; ++i) {
1069    SV *arg = ST(i);
1070    SvREFCNT_inc(arg);
1071    if (av_store(args, i - 2, arg) == NULL) { croak(vmg_argstorefailed); }
1072   }
1073  }
1074  ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1075  SvREFCNT_dec(args);
1076  RETVAL = ret;
1077 OUTPUT:
1078  RETVAL
1079
1080 SV *getdata(SV *sv, SV *wiz)
1081 PROTOTYPE: \[$@%&*]$
1082 PREINIT:
1083  SV *data;
1084  U16 sig;
1085 CODE:
1086  sig = vmg_wizard_sig(wiz);
1087  if (!sig)
1088   XSRETURN_UNDEF;
1089  data = vmg_data_get(SvRV(sv), sig);
1090  if (!data) { XSRETURN_UNDEF; }
1091  ST(0) = data;
1092  XSRETURN(1);
1093
1094 SV *dispell(SV *sv, SV *wiz)
1095 PROTOTYPE: \[$@%&*]$
1096 PREINIT:
1097  U16 sig;
1098 CODE:
1099  sig = vmg_wizard_sig(wiz);
1100  if (!sig)
1101   XSRETURN_UNDEF;
1102  RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));
1103 OUTPUT:
1104  RETVAL