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