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