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