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