Magic.xs

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