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, *umg;
 642  SV *key = NULL, *newkey = NULL;
 643
 644  umg = mg_find(sv, PERL_MAGIC_uvar);
 645  /* umg can't be NULL or we wouldn't be there. */
 646  key = umg->mg_obj;
 647  uf  = (struct ufuncs *) umg->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   switch (w->uvar) {
 660    case 0:
 661     continue;
 662    case 2:
 663     if (!newkey)
 664      newkey = key = umg->mg_obj = sv_2mortal(newSVsv(umg->mg_obj));
 665   }
 666   switch (action) {
 667    case 0:
 668     if (w->cb_fetch)  { vmg_cb_call2(w->cb_fetch,  sv, mg->mg_obj, key); }
 669     break;
 670    case HV_FETCH_ISSTORE:
 671    case HV_FETCH_LVALUE:
 672    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
 673     if (w->cb_store)  { vmg_cb_call2(w->cb_store,  sv, mg->mg_obj, key); }
 674     break;
 675    case HV_FETCH_ISEXISTS:
 676     if (w->cb_exists) { vmg_cb_call2(w->cb_exists, sv, mg->mg_obj, key); }
 677     break;
 678    case HV_DELETE:
 679     if (w->cb_delete) { vmg_cb_call2(w->cb_delete, sv, mg->mg_obj, key); }
 680     break;
 681   }
 682  }
 683
 684  return 0;
 685 }
 686 #endif /* VMG_UVAR */
 687
 688 /* ... Wizard destructor ................................................... */
 689
 690 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
 691  char buf[8];
 692  MGWIZ *w;
 693
 694  if (PL_dirty) /* During global destruction, the context is already freed */
 695   return 0;
 696
 697  w = SV2MGWIZ(wiz);
 698 #if VMG_MULTIPLICITY
 699  if (w->owner != aTHX)
 700   return 0;
 701  w->owner = NULL;
 702 #endif /* VMG_MULTIPLICITY */
 703
 704  {
 705   dMY_CXT;
 706   if (hv_delete(MY_CXT, buf, sprintf(buf, "%u", w->sig), 0) != wiz)
 707    return 0;
 708  }
 709  SvFLAGS(wiz) |= SVf_BREAK;
 710  FREETMPS;
 711
 712  if (w->cb_data  != NULL) { SvREFCNT_dec(SvRV(w->cb_data)); }
 713  if (w->cb_get   != NULL) { SvREFCNT_dec(SvRV(w->cb_get)); }
 714  if (w->cb_set   != NULL) { SvREFCNT_dec(SvRV(w->cb_set)); }
 715  if (w->cb_len   != NULL) { SvREFCNT_dec(SvRV(w->cb_len)); }
 716  if (w->cb_clear != NULL) { SvREFCNT_dec(SvRV(w->cb_clear)); }
 717  if (w->cb_free  != NULL) { SvREFCNT_dec(SvRV(w->cb_free)); }
 718 #if MGf_COPY
 719  if (w->cb_copy  != NULL) { SvREFCNT_dec(SvRV(w->cb_copy)); }
 720 #endif /* MGf_COPY */
 721 #if 0 /* MGf_DUP */
 722  if (w->cb_dup   != NULL) { SvREFCNT_dec(SvRV(w->cb_dup)); }
 723 #endif /* MGf_DUP */
 724 #if MGf_LOCAL
 725  if (w->cb_local != NULL) { SvREFCNT_dec(SvRV(w->cb_local)); }
 726 #endif /* MGf_LOCAL */
 727 #if VMG_UVAR
 728  if (w->cb_fetch  != NULL) { SvREFCNT_dec(SvRV(w->cb_fetch)); }
 729  if (w->cb_store  != NULL) { SvREFCNT_dec(SvRV(w->cb_store)); }
 730  if (w->cb_exists != NULL) { SvREFCNT_dec(SvRV(w->cb_exists)); }
 731  if (w->cb_delete != NULL) { SvREFCNT_dec(SvRV(w->cb_delete)); }
 732 #endif /* VMG_UVAR */
 733
 734  Safefree(w->vtbl);
 735  Safefree(w);
 736
 737  return 0;
 738 }
 739
 740 STATIC MGVTBL vmg_wizard_vtbl = {
 741  NULL,            /* get */
 742  NULL,            /* set */
 743  NULL,            /* len */
 744  NULL,            /* clear */
 745  vmg_wizard_free, /* free */
 746 #if MGf_COPY
 747  NULL,            /* copy */
 748 #endif /* MGf_COPY */
 749 #if MGf_DUP
 750  NULL,            /* dup */
 751 #endif /* MGf_DUP */
 752 #if MGf_LOCAL
 753  NULL,            /* local */
 754 #endif /* MGf_LOCAL */
 755 };
 756
 757 STATIC const char vmg_invalid_wiz[]    = "Invalid wizard object";
 758 STATIC const char vmg_invalid_sig[]    = "Invalid numeric signature";
 759 STATIC const char vmg_wrongargnum[]    = "Wrong number of arguments";
 760 STATIC const char vmg_toomanysigs[]    = "Too many magic signatures used";
 761 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
 762
 763 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
 764 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
 765  U16 sig;
 766
 767  if (SvIOK(sv)) {
 768   sig = SvUVX(sv);
 769  } else if (SvNOK(sv)) {
 770   sig = SvNVX(sv);
 771  } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
 772   sig = SvUV(sv);
 773  } else {
 774   croak(vmg_invalid_sig);
 775  }
 776  if (sig < SIG_MIN) { sig += SIG_MIN; }
 777  if (sig > SIG_MAX) { sig %= SIG_MAX + 1; }
 778
 779  return sig;
 780 }
 781
 782 STATIC U16 vmg_wizard_sig(pTHX_ SV *wiz) {
 783 #define vmg_wizard_sig(W) vmg_wizard_sig(aTHX_ (W))
 784  char buf[8];
 785  U16 sig;
 786
 787  if (SvROK(wiz)) {
 788   sig = SV2MGWIZ(SvRV(wiz))->sig;
 789  } else if (SvOK(wiz)) {
 790   sig = vmg_sv2sig(wiz);
 791  } else {
 792   croak(vmg_invalid_wiz);
 793  }
 794
 795  {
 796   dMY_CXT;
 797   if (!hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))
 798    sig = 0;
 799  }
 800  return sig;
 801 }
 802
 803 STATIC SV *vmg_wizard_wiz(pTHX_ SV *wiz) {
 804 #define vmg_wizard_wiz(W) vmg_wizard_wiz(aTHX_ (W))
 805  char buf[8];
 806  SV **old;
 807  U16 sig;
 808
 809  if (SvROK(wiz)) {
 810   wiz = SvRV(wiz);
 811 #if VMG_MULTIPLICITY
 812   if (SV2MGWIZ(wiz)->owner == aTHX)
 813    return wiz;
 814 #endif /* VMG_MULTIPLICITY */
 815   sig = SV2MGWIZ(wiz)->sig;
 816  } else if (SvOK(wiz)) {
 817   sig = vmg_sv2sig(wiz);
 818  } else {
 819   croak(vmg_invalid_wiz);
 820  }
 821
 822  {
 823   dMY_CXT;
 824   return (old = hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))
 825           ? *old : NULL;
 826  }
 827 }
 828
 829 #define VMG_SET_CB(S, N)              \
 830  cb = (S);                            \
 831  w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
 832
 833 #define VMG_SET_SVT_CB(S, N)          \
 834  cb = (S);                            \
 835  if (SvOK(cb) && SvROK(cb)) {         \
 836   t->svt_ ## N = vmg_svt_ ## N;       \
 837   w->cb_  ## N = newRV_inc(SvRV(cb)); \
 838  } else {                             \
 839   t->svt_ ## N = NULL;                \
 840   w->cb_  ## N = NULL;                \
 841  }
 842
 843 #if VMG_THREADSAFE
 844
 845 #define VMG_CLONE_CB(N) \
 846  z->cb_ ## N = (w->cb_ ## N) ? newRV_inc(vmg_clone(SvRV(w->cb_ ## N), \
 847                                          w->owner))                   \
 848                              : NULL;
 849
 850 STATIC MGWIZ *vmg_wizard_clone(pTHX_ const MGWIZ *w) {
 851 #define vmg_wizard_clone(W) vmg_wizard_clone(aTHX_ (W))
 852  MGVTBL *t;
 853  MGWIZ *z;
 854
 855  Newx(t, 1, MGVTBL);
 856  Copy(w->vtbl, t, 1, MGVTBL);
 857
 858  Newx(z, 1, MGWIZ);
 859  VMG_CLONE_CB(data);
 860  VMG_CLONE_CB(get);
 861  VMG_CLONE_CB(set);
 862  VMG_CLONE_CB(len);
 863  VMG_CLONE_CB(clear);
 864  VMG_CLONE_CB(free);
 865 #if MGf_COPY
 866  VMG_CLONE_CB(copy);
 867 #endif /* MGf_COPY */
 868 #if MGf_DUP
 869  VMG_CLONE_CB(dup);
 870 #endif /* MGf_DUP */
 871 #if MGf_LOCAL
 872  VMG_CLONE_CB(local);
 873 #endif /* MGf_LOCAL */
 874 #if VMG_UVAR
 875  VMG_CLONE_CB(fetch);
 876  VMG_CLONE_CB(store);
 877  VMG_CLONE_CB(exists);
 878  VMG_CLONE_CB(delete);
 879 #endif /* VMG_UVAR */
 880  z->owner = aTHX;
 881  z->vtbl  = t;
 882  z->sig   = w->sig;
 883  z->uvar  = w->uvar;
 884
 885  return z;
 886 }
 887
 888 #endif /* VMG_THREADSAFE */
 889
 890 /* --- XS ------------------------------------------------------------------ */
 891
 892 MODULE = Variable::Magic            PACKAGE = Variable::Magic
 893
 894 PROTOTYPES: ENABLE
 895
 896 BOOT:
 897 {
 898  HV *stash;
 899  MY_CXT_INIT;
 900  MY_CXT = newHV();
 901  hv_iterinit(MY_CXT); /* Allocate iterator */
 902  stash = gv_stashpv(__PACKAGE__, 1);
 903  newCONSTSUB(stash, "SIG_MIN",   newSVuv(SIG_MIN));
 904  newCONSTSUB(stash, "SIG_MAX",   newSVuv(SIG_MAX));
 905  newCONSTSUB(stash, "SIG_NBR",   newSVuv(SIG_NBR));
 906  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
 907  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
 908  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
 909  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
 910  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
 911                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
 912  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
 913                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
 914  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
 915                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
 916  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
 917                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
 918  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
 919  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
 920 }
 921
 922 void
 923 CLONE(...)
 924 PROTOTYPE: DISABLE
 925 PREINIT:
 926  HV *hv;
 927 CODE:
 928 #if VMG_THREADSAFE
 929  {
 930   HE *key;
 931   dMY_CXT;
 932   hv = newHV();
 933   hv_iterinit(hv); /* Allocate iterator */
 934   hv_iterinit(MY_CXT);
 935   while ((key = hv_iternext(MY_CXT))) {
 936    STRLEN len;
 937    char *sig = HePV(key, len);
 938    SV *sv;
 939    MAGIC *mg;
 940    sv = MGWIZ2SV(vmg_wizard_clone(SV2MGWIZ(HeVAL(key))));
 941    mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
 942    mg->mg_private = SIG_WIZ;
 943    SvREADONLY_on(sv);
 944    hv_store(hv, sig, len, sv, HeHASH(key));
 945   }
 946  }
 947  {
 948   MY_CXT_CLONE;
 949   MY_CXT = hv;
 950  }
 951 #endif /* VMG_THREADSAFE */
 952
 953 SV *_wizard(...)
 954 PROTOTYPE: DISABLE
 955 PREINIT:
 956  I32 i = 0;
 957  U16 sig;
 958  char buf[8];
 959  MGWIZ *w;
 960  MGVTBL *t;
 961  MAGIC *mg;
 962  SV *sv;
 963  SV *svsig;
 964  SV *cb;
 965 CODE:
 966  dMY_CXT;
 967
 968  if (items != 7
 969 #if MGf_COPY
 970               + 1
 971 #endif /* MGf_COPY */
 972 #if MGf_DUP
 973               + 1
 974 #endif /* MGf_DUP */
 975 #if MGf_LOCAL
 976               + 1
 977 #endif /* MGf_LOCAL */
 978 #if VMG_UVAR
 979               + 5
 980 #endif /* VMG_UVAR */
 981               ) { croak(vmg_wrongargnum); }
 982
 983  svsig = ST(i++);
 984  if (SvOK(svsig)) {
 985   SV **old;
 986   sig = vmg_sv2sig(svsig);
 987   if ((old = hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))) {
 988    ST(0) = sv_2mortal(newRV_inc(*old));
 989    XSRETURN(1);
 990   }
 991  } else {
 992   if (HvKEYS(MY_CXT) >= SIG_NBR) { croak(vmg_toomanysigs); }
 993   sig = vmg_gensig();
 994  }
 995
 996  Newx(t, 1, MGVTBL);
 997  Newx(w, 1, MGWIZ);
 998
 999  VMG_SET_CB(ST(i++), data);
1000  VMG_SET_SVT_CB(ST(i++), get);
1001  VMG_SET_SVT_CB(ST(i++), set);
1002  VMG_SET_SVT_CB(ST(i++), len);
1003  VMG_SET_SVT_CB(ST(i++), clear);
1004  VMG_SET_SVT_CB(ST(i++), free);
1005 #if MGf_COPY
1006  VMG_SET_SVT_CB(ST(i++), copy);
1007 #endif /* MGf_COPY */
1008 #if MGf_DUP
1009  /* VMG_SET_SVT_CB(ST(i++), dup); */
1010  i++;
1011  t->svt_dup = NULL;
1012  w->cb_dup  = NULL;
1013 #endif /* MGf_DUP */
1014 #if MGf_LOCAL
1015  VMG_SET_SVT_CB(ST(i++), local);
1016 #endif /* MGf_LOCAL */
1017 #if VMG_UVAR
1018  VMG_SET_CB(ST(i++), fetch);
1019  VMG_SET_CB(ST(i++), store);
1020  VMG_SET_CB(ST(i++), exists);
1021  VMG_SET_CB(ST(i++), delete);
1022  cb = ST(i++);
1023  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1024   w->uvar = SvTRUE(cb) ? 2 : 1;
1025  else
1026   w->uvar = 0;
1027 #endif /* VMG_UVAR */
1028 #if VMG_MULTIPLICITY
1029  w->owner = aTHX;
1030 #endif /* VMG_MULTIPLICITY */
1031  w->vtbl  = t;
1032  w->sig   = sig;
1033
1034  sv = MGWIZ2SV(w);
1035  mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1036  mg->mg_private = SIG_WIZ;
1037  SvREADONLY_on(sv);
1038
1039  hv_store(MY_CXT, buf, sprintf(buf, "%u", sig), sv, 0);
1040
1041  RETVAL = newRV_noinc(sv);
1042 OUTPUT:
1043  RETVAL
1044
1045 SV *gensig()
1046 PROTOTYPE:
1047 CODE:
1048  dMY_CXT;
1049  if (HvKEYS(MY_CXT) >= SIG_NBR) { croak(vmg_toomanysigs); }
1050  RETVAL = newSVuv(vmg_gensig());
1051 OUTPUT:
1052  RETVAL
1053
1054 SV *getsig(SV *wiz)
1055 PROTOTYPE: $
1056 CODE:
1057  if (!SvROK(wiz)) { croak(vmg_invalid_wiz); }
1058  RETVAL = newSVuv(SV2MGWIZ(SvRV(wiz))->sig);
1059 OUTPUT:
1060  RETVAL
1061
1062 SV *cast(SV *sv, SV *wiz, ...)
1063 PROTOTYPE: \[$@%&*]$@
1064 PREINIT:
1065  AV *args = NULL;
1066  SV *ret;
1067 CODE:
1068  wiz = vmg_wizard_wiz(wiz);
1069  if (!wiz)
1070   XSRETURN_UNDEF;
1071  if (items > 2) {
1072   I32 i;
1073   args = newAV();
1074   av_fill(args, items - 2);
1075   for (i = 2; i < items; ++i) {
1076    SV *arg = ST(i);
1077    SvREFCNT_inc(arg);
1078    if (av_store(args, i - 2, arg) == NULL) { croak(vmg_argstorefailed); }
1079   }
1080  }
1081  ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1082  SvREFCNT_dec(args);
1083  RETVAL = ret;
1084 OUTPUT:
1085  RETVAL
1086
1087 SV *getdata(SV *sv, SV *wiz)
1088 PROTOTYPE: \[$@%&*]$
1089 PREINIT:
1090  SV *data;
1091  U16 sig;
1092 CODE:
1093  sig = vmg_wizard_sig(wiz);
1094  if (!sig)
1095   XSRETURN_UNDEF;
1096  data = vmg_data_get(SvRV(sv), sig);
1097  if (!data) { XSRETURN_UNDEF; }
1098  ST(0) = data;
1099  XSRETURN(1);
1100
1101 SV *dispell(SV *sv, SV *wiz)
1102 PROTOTYPE: \[$@%&*]$
1103 PREINIT:
1104  U16 sig;
1105 CODE:
1106  sig = vmg_wizard_sig(wiz);
1107  if (!sig)
1108   XSRETURN_UNDEF;
1109  RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));
1110 OUTPUT:
1111  RETVAL