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