]> git.vpit.fr Git - perl/modules/Variable-Magic.git/blob - Magic.xs
d87c651834fb44073924f65f940f042e31e50414
[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 #undef VOID2
16 #ifdef __cplusplus
17 # define VOID2(T, P) static_cast<T>(P)
18 #else
19 # define VOID2(T, P) (P)
20 #endif
21
22 #ifndef VMG_PERL_PATCHLEVEL
23 # ifdef PERL_PATCHNUM
24 #  define VMG_PERL_PATCHLEVEL PERL_PATCHNUM
25 # else
26 #  define VMG_PERL_PATCHLEVEL 0
27 # endif
28 #endif
29
30 #define VMG_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
31
32 #define VMG_HAS_PERL_BRANCH(R, V, S) (PERL_REVISION == (R) && PERL_VERSION == (V) && PERL_SUBVERSION >= (S))
33
34 #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))))
35
36 /* --- Threads and multiplicity -------------------------------------------- */
37
38 #ifndef NOOP
39 # define NOOP
40 #endif
41
42 #ifndef dNOOP
43 # define dNOOP
44 #endif
45
46 /* Safe unless stated otherwise in Makefile.PL */
47 #ifndef VMG_FORKSAFE
48 # define VMG_FORKSAFE 1
49 #endif
50
51 #ifndef VMG_MULTIPLICITY
52 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
53 #  define VMG_MULTIPLICITY 1
54 # else
55 #  define VMG_MULTIPLICITY 0
56 # endif
57 #endif
58
59 #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))
60 # define VMG_THREADSAFE 1
61 # ifndef MY_CXT_CLONE
62 #  define MY_CXT_CLONE \
63     dMY_CXT_SV;                                                      \
64     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
65     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
66     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
67 # endif
68 #else
69 # define VMG_THREADSAFE 0
70 # undef  dMY_CXT
71 # define dMY_CXT      dNOOP
72 # undef  MY_CXT
73 # define MY_CXT       vmg_globaldata
74 # undef  START_MY_CXT
75 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
76 # undef  MY_CXT_INIT
77 # define MY_CXT_INIT  NOOP
78 # undef  MY_CXT_CLONE
79 # define MY_CXT_CLONE NOOP
80 #endif
81
82 #if VMG_THREADSAFE
83 # define VMG_LOCK(M)   MUTEX_LOCK(M)
84 # define VMG_UNLOCK(M) MUTEX_UNLOCK(M)
85 #else
86 # define VMG_LOCK(M)
87 # define VMG_UNLOCK(M)
88 #endif
89
90 /* --- Compatibility ------------------------------------------------------- */
91
92 #ifndef Newx
93 # define Newx(v, n, c) New(0, v, n, c)
94 #endif
95
96 #ifndef SvMAGIC_set
97 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
98 #endif
99
100 #ifndef SvRV_const
101 # define SvRV_const(sv) SvRV((SV *) sv)
102 #endif
103
104 #ifndef SvREFCNT_inc_simple_void
105 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
106 #endif
107
108 #ifndef mPUSHu
109 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
110 #endif
111
112 #ifndef PERL_MAGIC_ext
113 # define PERL_MAGIC_ext '~'
114 #endif
115
116 #ifndef PERL_MAGIC_tied
117 # define PERL_MAGIC_tied 'P'
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 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but we only
129  * enable them on 5.10 */
130 #if VMG_HAS_PERL(5, 10, 0)
131 # define VMG_UVAR 1
132 #else
133 # define VMG_UVAR 0
134 #endif
135
136 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969) || VMG_HAS_PERL(5, 12, 0)
137 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
138 #else
139 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
140 #endif
141
142 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
143  * reverted to dev-5.11 as 9cdcb38b */
144 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
145 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
146 #  if VMG_HAS_PERL(5, 11, 0)
147 #   define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
148 #  else
149 #   define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
150 #  endif
151 # endif
152 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
153 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
154 # endif
155 #else
156 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
157 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
158 # endif
159 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
160 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
161 # endif
162 #endif
163
164 /* Applied to dev-5.11 as 34908 */
165 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908) || VMG_HAS_PERL(5, 12, 0)
166 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
167 #else
168 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
169 #endif
170
171 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
172 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
173 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
174 #else
175 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
176 #endif
177
178 #if VMG_HAS_PERL(5, 11, 0)
179 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 1
180 #else
181 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 0
182 #endif
183
184 #if VMG_HAS_PERL(5, 13, 2)
185 # define VMG_COMPAT_GLOB_GET 1
186 #else
187 # define VMG_COMPAT_GLOB_GET 0
188 #endif
189
190 /* ... Bug-free mg_magical ................................................. */
191
192 /* See the discussion at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html */
193
194 #if VMG_HAS_PERL(5, 11, 3)
195
196 #define vmg_mg_magical(S) mg_magical(S)
197
198 #else
199
200 STATIC void vmg_mg_magical(SV *sv) {
201  const MAGIC *mg;
202
203  SvMAGICAL_off(sv);
204  if ((mg = SvMAGIC(sv))) {
205   do {
206    const MGVTBL* const vtbl = mg->mg_virtual;
207    if (vtbl) {
208     if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
209      SvGMAGICAL_on(sv);
210     if (vtbl->svt_set)
211      SvSMAGICAL_on(sv);
212     if (vtbl->svt_clear)
213      SvRMAGICAL_on(sv);
214    }
215   } while ((mg = mg->mg_moremagic));
216   if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
217    SvRMAGICAL_on(sv);
218  }
219 }
220
221 #endif
222
223 /* ... Safe version of call_sv() ........................................... */
224
225 STATIC I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, SV *dsv) {
226 #define vmg_call_sv(S, F, D) vmg_call_sv(aTHX_ (S), (F), (D))
227  I32 ret, cxix, in_eval = 0;
228  PERL_CONTEXT saved_cx;
229  SV *old_err = NULL;
230
231  if (SvTRUE(ERRSV)) {
232   old_err = ERRSV;
233   ERRSV   = newSV(0);
234  }
235
236  if (cxstack_ix < cxstack_max) {
237   cxix    = cxstack_ix + 1;
238   in_eval = CxTYPE(cxstack + cxix) == CXt_EVAL;
239  } else {
240   cxix    = Perl_cxinc(aTHX);
241  }
242  /* The last popped context will be reused by call_sv(), but our callers may
243   * still need its previous value. Back it up so that it isn't clobbered. */
244  saved_cx = cxstack[cxix];
245
246  ret = call_sv(sv, flags | G_EVAL);
247
248  cxstack[cxix] = saved_cx;
249
250  if (SvTRUE(ERRSV)) {
251   if (old_err) {
252    sv_setsv(old_err, ERRSV);
253    SvREFCNT_dec(ERRSV);
254    ERRSV = old_err;
255   }
256   if (IN_PERL_COMPILETIME) {
257    if (!PL_in_eval) {
258     if (PL_errors)
259      sv_catsv(PL_errors, ERRSV);
260     else
261      Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
262     SvCUR_set(ERRSV, 0);
263    }
264 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
265    if (PL_parser)
266     ++PL_parser->error_count;
267 #elif defined(PL_error_count)
268    ++PL_error_count;
269 #else
270    ++PL_Ierror_count;
271 #endif
272    } else if (!in_eval) {
273     if (dsv) {
274      /* We are about to croak() while dsv is being destroyed. Try to clean up
275       * things a bit. */
276      MAGIC *mg = SvMAGIC(dsv);
277      SvREFCNT_dec((SV *) mg->mg_ptr);
278      /* mg->mg_obj may not be refcounted if the data constructor returned the
279       * variable itself. */
280      if (mg->mg_flags & MGf_REFCOUNTED)
281       SvREFCNT_dec(mg->mg_obj);
282      SvMAGIC_set(dsv, mg->mg_moremagic);
283      Safefree(mg);
284      mg_magical(dsv);
285      SvREFCNT_dec(dsv);
286     }
287     croak(NULL);
288    }
289  } else {
290   if (old_err) {
291    SvREFCNT_dec(ERRSV);
292    ERRSV = old_err;
293   }
294  }
295
296  return ret;
297 }
298
299 /* --- Stolen chunk of B --------------------------------------------------- */
300
301 typedef enum {
302  OPc_NULL   = 0,
303  OPc_BASEOP = 1,
304  OPc_UNOP   = 2,
305  OPc_BINOP  = 3,
306  OPc_LOGOP  = 4,
307  OPc_LISTOP = 5,
308  OPc_PMOP   = 6,
309  OPc_SVOP   = 7,
310  OPc_PADOP  = 8,
311  OPc_PVOP   = 9,
312  OPc_LOOP   = 10,
313  OPc_COP    = 11,
314  OPc_MAX    = 12
315 } opclass;
316
317 STATIC const char *const vmg_opclassnames[] = {
318  "B::NULL",
319  "B::OP",
320  "B::UNOP",
321  "B::BINOP",
322  "B::LOGOP",
323  "B::LISTOP",
324  "B::PMOP",
325  "B::SVOP",
326  "B::PADOP",
327  "B::PVOP",
328  "B::LOOP",
329  "B::COP"
330 };
331
332 STATIC opclass vmg_opclass(const OP *o) {
333 #if 0
334  if (!o)
335   return OPc_NULL;
336 #endif
337
338  if (o->op_type == 0)
339   return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
340
341  if (o->op_type == OP_SASSIGN)
342   return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
343
344  if (o->op_type == OP_AELEMFAST) {
345 #if PERL_VERSION <= 14
346   if (o->op_flags & OPf_SPECIAL)
347    return OPc_BASEOP;
348   else
349 #endif
350 #ifdef USE_ITHREADS
351    return OPc_PADOP;
352 #else
353    return OPc_SVOP;
354 #endif
355  }
356
357 #ifdef USE_ITHREADS
358  if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
359   return OPc_PADOP;
360 #endif
361
362  switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
363   case OA_BASEOP:
364    return OPc_BASEOP;
365   case OA_UNOP:
366    return OPc_UNOP;
367   case OA_BINOP:
368    return OPc_BINOP;
369   case OA_LOGOP:
370    return OPc_LOGOP;
371   case OA_LISTOP:
372    return OPc_LISTOP;
373   case OA_PMOP:
374    return OPc_PMOP;
375   case OA_SVOP:
376    return OPc_SVOP;
377   case OA_PADOP:
378    return OPc_PADOP;
379   case OA_PVOP_OR_SVOP:
380    return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
381   case OA_LOOP:
382    return OPc_LOOP;
383   case OA_COP:
384    return OPc_COP;
385   case OA_BASEOP_OR_UNOP:
386    return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
387   case OA_FILESTATOP:
388    return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
389 #ifdef USE_ITHREADS
390            (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
391 #else
392            (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
393 #endif
394   case OA_LOOPEXOP:
395    if (o->op_flags & OPf_STACKED)
396     return OPc_UNOP;
397    else if (o->op_flags & OPf_SPECIAL)
398     return OPc_BASEOP;
399    else
400     return OPc_PVOP;
401  }
402
403  return OPc_BASEOP;
404 }
405
406 /* --- Error messages ------------------------------------------------------ */
407
408 STATIC const char vmg_invalid_wiz[]    = "Invalid wizard object";
409 STATIC const char vmg_wrongargnum[]    = "Wrong number of arguments";
410 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
411
412 /* --- Context-safe global data -------------------------------------------- */
413
414 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
415
416 typedef struct {
417  HV *b__op_stashes[OPc_MAX];
418 } my_cxt_t;
419
420 START_MY_CXT
421
422 /* --- <vmg_vtable> structure ---------------------------------------------- */
423
424 #if VMG_THREADSAFE
425
426 typedef struct {
427  MGVTBL *vtbl;
428  U32     refcount;
429 } vmg_vtable;
430
431 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
432 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
433  vmg_vtable *t;
434
435  t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
436
437  t->vtbl     = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
438  t->refcount = 1;
439
440  return t;
441 }
442
443 #define vmg_vtable_vtbl(T) (T)->vtbl
444
445 STATIC perl_mutex vmg_vtable_refcount_mutex;
446
447 STATIC vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
448 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
449  VMG_LOCK(&vmg_vtable_refcount_mutex);
450  ++t->refcount;
451  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
452
453  return t;
454 }
455
456 STATIC void vmg_vtable_free(pTHX_ vmg_vtable *t) {
457 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
458  U32 refcount;
459
460  VMG_LOCK(&vmg_vtable_refcount_mutex);
461  refcount = --t->refcount;
462  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
463
464  if (!refcount) {
465   PerlMemShared_free(t->vtbl);
466   PerlMemShared_free(t);
467  }
468 }
469
470 #else /* VMG_THREADSAFE */
471
472 typedef MGVTBL vmg_vtable;
473
474 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
475 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
476  vmg_vtable *t;
477
478  Newx(t, 1, vmg_vtable);
479
480  return t;
481 }
482
483 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
484
485 #define vmg_vtable_free(T) Safefree(T)
486
487 #endif /* !VMG_THREADSAFE */
488
489 /* --- <vmg_wizard> structure ---------------------------------------------- */
490
491 typedef struct {
492  vmg_vtable *vtable;
493
494  U8 opinfo;
495  U8 uvar;
496
497  SV *cb_data;
498  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
499  SV *cb_copy;
500  SV *cb_dup;
501 #if MGf_LOCAL
502  SV *cb_local;
503 #endif /* MGf_LOCAL */
504 #if VMG_UVAR
505  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
506 #endif /* VMG_UVAR */
507 } vmg_wizard;
508
509 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo);
510
511 STATIC vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
512 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
513  vmg_wizard *w;
514
515  Newx(w, 1, vmg_wizard);
516
517  w->uvar   = 0;
518  w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
519  if (w->opinfo)
520   vmg_op_info_init(aTHX_ w->opinfo);
521
522  w->vtable = vmg_vtable_alloc();
523
524  return w;
525 }
526
527 STATIC void vmg_wizard_free(pTHX_ vmg_wizard *w) {
528 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
529  if (!w)
530   return;
531
532  /* During global destruction, any of the callbacks may already have been
533   * freed, so we can't rely on still being able to access them. */
534  if (!PL_dirty) {
535   SvREFCNT_dec(w->cb_data);
536   SvREFCNT_dec(w->cb_get);
537   SvREFCNT_dec(w->cb_set);
538   SvREFCNT_dec(w->cb_len);
539   SvREFCNT_dec(w->cb_clear);
540   SvREFCNT_dec(w->cb_free);
541   SvREFCNT_dec(w->cb_copy);
542 #if 0
543   SvREFCNT_dec(w->cb_dup);
544 #endif
545 #if MGf_LOCAL
546   SvREFCNT_dec(w->cb_local);
547 #endif /* MGf_LOCAL */
548 #if VMG_UVAR
549   SvREFCNT_dec(w->cb_fetch);
550   SvREFCNT_dec(w->cb_store);
551   SvREFCNT_dec(w->cb_exists);
552   SvREFCNT_dec(w->cb_delete);
553 #endif /* VMG_UVAR */
554  }
555
556  /* PerlMemShared_free() and Safefree() are still fine during global
557   * destruction though. */
558  vmg_vtable_free(w->vtable);
559  Safefree(w);
560
561  return;
562 }
563
564 #if VMG_THREADSAFE
565
566 #define VMG_CLONE_CB(N) \
567  z->cb_ ## N = (w->cb_ ## N) ? SvREFCNT_inc(sv_dup(w->cb_ ## N, params)) \
568                              : NULL;
569
570 STATIC const vmg_wizard *vmg_wizard_dup(pTHX_ const vmg_wizard *w, CLONE_PARAMS *params) {
571 #define vmg_wizard_dup(W, P) vmg_wizard_dup(aTHX_ (W), (P))
572  vmg_wizard *z;
573
574  if (!w)
575   return NULL;
576
577  Newx(z, 1, vmg_wizard);
578
579  z->vtable = vmg_vtable_dup(w->vtable);
580  z->uvar   = w->uvar;
581  z->opinfo = w->opinfo;
582
583  VMG_CLONE_CB(data);
584  VMG_CLONE_CB(get);
585  VMG_CLONE_CB(set);
586  VMG_CLONE_CB(len);
587  VMG_CLONE_CB(clear);
588  VMG_CLONE_CB(free);
589  VMG_CLONE_CB(copy);
590  VMG_CLONE_CB(dup);
591 #if MGf_LOCAL
592  VMG_CLONE_CB(local);
593 #endif /* MGf_LOCAL */
594 #if VMG_UVAR
595  VMG_CLONE_CB(fetch);
596  VMG_CLONE_CB(store);
597  VMG_CLONE_CB(exists);
598  VMG_CLONE_CB(delete);
599 #endif /* VMG_UVAR */
600
601  return z;
602 }
603
604 #endif /* VMG_THREADSAFE */
605
606 #define vmg_wizard_id(W) PTR2IV(vmg_vtable_vtbl((W)->vtable))
607
608 /* --- Wizard SV objects --------------------------------------------------- */
609
610 STATIC int vmg_wizard_sv_free(pTHX_ SV *sv, MAGIC *mg) {
611  vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
612
613  return 0;
614 }
615
616 #if VMG_THREADSAFE
617
618 STATIC int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
619  mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
620
621  return 0;
622 }
623
624 #endif /* VMG_THREADSAFE */
625
626 STATIC MGVTBL vmg_wizard_sv_vtbl = {
627  NULL,               /* get */
628  NULL,               /* set */
629  NULL,               /* len */
630  NULL,               /* clear */
631  vmg_wizard_sv_free, /* free */
632  NULL,               /* copy */
633 #if VMG_THREADSAFE
634  vmg_wizard_sv_dup,  /* dup */
635 #else
636  NULL,               /* dup */
637 #endif
638 #if MGf_LOCAL
639  NULL,               /* local */
640 #endif /* MGf_LOCAL */
641 };
642
643 STATIC SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
644 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
645  SV *wiz;
646
647 #if VMG_THREADSAFE
648  wiz = newSV(0);
649 #else
650  wiz = newSViv(PTR2IV(w));
651 #endif
652
653  if (w) {
654   MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_sv_vtbl,
655                                      (const char *) w, 0);
656   mg->mg_private = 0;
657 #if VMG_THREADSAFE
658   mg->mg_flags  |= MGf_DUP;
659 #endif
660  }
661  SvREADONLY_on(wiz);
662
663  return wiz;
664 }
665
666 #if VMG_THREADSAFE
667
668 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
669
670 STATIC const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
671  MAGIC *mg;
672
673  for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
674   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
675    return (const vmg_wizard *) mg->mg_ptr;
676  }
677
678  return NULL;
679 }
680
681 #else /* VMG_THREADSAFE */
682
683 #define vmg_sv_has_wizard_type(S) SvIOK(S)
684
685 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
686
687 #endif /* !VMG_THREADSAFE */
688
689 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
690
691 STATIC const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
692  if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
693   SV *sv = (SV *) mg->mg_ptr;
694
695   if (vmg_sv_has_wizard_type(sv))
696    return vmg_wizard_from_sv_nocheck(sv);
697  }
698
699  return NULL;
700 }
701
702 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
703
704 /* --- User-level functions implementation --------------------------------- */
705
706 STATIC const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
707  const MAGIC *mg;
708  IV wid;
709
710  if (SvTYPE(sv) < SVt_PVMG)
711   return NULL;
712
713  wid = vmg_wizard_id(w);
714
715  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
716   const vmg_wizard *z = vmg_wizard_from_mg(mg);
717
718   if (z && vmg_wizard_id(z) == wid)
719    return mg;
720  }
721
722  return NULL;
723 }
724
725 /* ... Construct private data .............................................. */
726
727 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
728 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
729  I32 i;
730  SV *nsv;
731
732  dSP;
733
734  ENTER;
735  SAVETMPS;
736
737  PUSHMARK(SP);
738  EXTEND(SP, items + 1);
739  PUSHs(sv_2mortal(newRV_inc(sv)));
740  for (i = 0; i < items; ++i)
741   PUSHs(args[i]);
742  PUTBACK;
743
744  vmg_call_sv(ctor, G_SCALAR, NULL);
745
746  SPAGAIN;
747  nsv = POPs;
748 #if VMG_HAS_PERL(5, 8, 3)
749  SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
750 #else
751  nsv = sv_newref(nsv);          /* Workaround some bug in SvREFCNT_inc() */
752 #endif
753  PUTBACK;
754
755  FREETMPS;
756  LEAVE;
757
758  return nsv;
759 }
760
761 STATIC SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
762 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
763  const MAGIC *mg = vmg_find(sv, w);
764
765  return mg ? mg->mg_obj : NULL;
766 }
767
768 /* ... Magic cast/dispell .................................................. */
769
770 #if VMG_UVAR
771 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
772
773 typedef struct {
774  struct ufuncs new_uf;
775  struct ufuncs old_uf;
776 } vmg_uvar_ud;
777
778 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
779  if (prevmagic) {
780   prevmagic->mg_moremagic = moremagic;
781  } else {
782   SvMAGIC_set(sv, moremagic);
783  }
784  mg->mg_moremagic = NULL;
785  Safefree(mg->mg_ptr);
786  Safefree(mg);
787 }
788 #endif /* VMG_UVAR */
789
790 STATIC UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
791 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
792  MAGIC  *mg;
793  MGVTBL *t;
794  SV     *data;
795  U32     oldgmg;
796
797  if (vmg_find(sv, w))
798   return 1;
799
800  oldgmg = SvGMAGICAL(sv);
801
802  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
803
804  t  = vmg_vtable_vtbl(w->vtable);
805  mg = sv_magicext(sv, data, PERL_MAGIC_ext, t, (const char *) wiz, HEf_SVKEY);
806  mg->mg_private = 0;
807
808  /* sv_magicext() calls mg_magical and increments data's refcount */
809  SvREFCNT_dec(data);
810
811  if (t->svt_copy)
812   mg->mg_flags |= MGf_COPY;
813 #if 0
814  if (t->svt_dup)
815   mg->mg_flags |= MGf_DUP;
816 #endif
817 #if MGf_LOCAL
818  if (t->svt_local)
819   mg->mg_flags |= MGf_LOCAL;
820 #endif /* MGf_LOCAL */
821
822  if (SvTYPE(sv) < SVt_PVHV)
823   goto done;
824
825  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
826   * magic is actually never called for them. If the GMAGICAL flag was off before
827   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
828   * now on, then this wizard has get magic. Hence we can work around the
829   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
830   * has uvar callbacks, it will be turned back on later. */
831  if (!oldgmg && SvGMAGICAL(sv))
832   SvGMAGICAL_off(sv);
833
834 #if VMG_UVAR
835  if (w->uvar) {
836   MAGIC *prevmagic, *moremagic = NULL;
837   vmg_uvar_ud ud;
838
839   ud.new_uf.uf_val   = vmg_svt_val;
840   ud.new_uf.uf_set   = NULL;
841   ud.new_uf.uf_index = 0;
842   ud.old_uf.uf_val   = NULL;
843   ud.old_uf.uf_set   = NULL;
844   ud.old_uf.uf_index = 0;
845
846   /* One uvar magic in the chain is enough. */
847   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
848    moremagic = mg->mg_moremagic;
849    if (mg->mg_type == PERL_MAGIC_uvar)
850     break;
851   }
852
853   if (mg) { /* Found another uvar magic. */
854    struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
855    if (uf->uf_val == vmg_svt_val) {
856     /* It's our uvar magic, nothing to do. oldgmg was true. */
857     goto done;
858    } else {
859     /* It's another uvar magic, backup it and replace it by ours. */
860     ud.old_uf = *uf;
861     vmg_uvar_del(sv, prevmagic, mg, moremagic);
862    }
863   }
864
865   sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
866   vmg_mg_magical(sv);
867   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
868    * handled by our uvar callback. */
869  }
870 #endif /* VMG_UVAR */
871
872 done:
873  return 1;
874 }
875
876 STATIC UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
877 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
878 #if VMG_UVAR
879  U32 uvars = 0;
880 #endif /* VMG_UVAR */
881  MAGIC *mg, *prevmagic, *moremagic = NULL;
882  IV wid = vmg_wizard_id(w);
883
884  if (SvTYPE(sv) < SVt_PVMG)
885   return 0;
886
887  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
888   const vmg_wizard *z;
889
890   moremagic = mg->mg_moremagic;
891
892   z = vmg_wizard_from_mg(mg);
893   if (z) {
894    IV zid = vmg_wizard_id(z);
895
896 #if VMG_UVAR
897    if (zid == wid) {
898     /* If the current has no uvar, short-circuit uvar deletion. */
899     uvars = z->uvar ? (uvars + 1) : 0;
900     break;
901    } else if (z->uvar) {
902     ++uvars;
903     /* We can't break here since we need to find the ext magic to delete. */
904    }
905 #else /* VMG_UVAR */
906    if (zid == wid)
907     break;
908 #endif /* !VMG_UVAR */
909   }
910  }
911  if (!mg)
912   return 0;
913
914  if (prevmagic) {
915   prevmagic->mg_moremagic = moremagic;
916  } else {
917   SvMAGIC_set(sv, moremagic);
918  }
919  mg->mg_moremagic = NULL;
920
921  /* Destroy private data */
922  if (mg->mg_obj != sv)
923   SvREFCNT_dec(mg->mg_obj);
924  /* Unreference the wizard */
925  SvREFCNT_dec((SV *) mg->mg_ptr);
926  Safefree(mg);
927
928 #if VMG_UVAR
929  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
930   /* mg was the first ext magic in the chain that had uvar */
931
932   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
933    const vmg_wizard *z = vmg_wizard_from_mg(mg);
934
935    if (z && z->uvar) {
936     ++uvars;
937     break;
938    }
939   }
940
941   if (uvars == 1) {
942    vmg_uvar_ud *ud;
943
944    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
945     moremagic = mg->mg_moremagic;
946     if (mg->mg_type == PERL_MAGIC_uvar)
947      break;
948    }
949
950    ud = (vmg_uvar_ud *) mg->mg_ptr;
951    if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
952     /* Revert the original uvar magic. */
953     struct ufuncs *uf;
954     Newx(uf, 1, struct ufuncs);
955     *uf = ud->old_uf;
956     Safefree(ud);
957     mg->mg_ptr = (char *) uf;
958     mg->mg_len = sizeof(*uf);
959    } else {
960     /* Remove the uvar magic. */
961     vmg_uvar_del(sv, prevmagic, mg, moremagic);
962    }
963   }
964  }
965 #endif /* VMG_UVAR */
966
967  vmg_mg_magical(sv);
968
969  return 1;
970 }
971
972 /* ... OP info ............................................................. */
973
974 #define VMG_OP_INFO_NAME   1
975 #define VMG_OP_INFO_OBJECT 2
976
977 #if VMG_THREADSAFE
978 STATIC perl_mutex vmg_op_name_init_mutex;
979 #endif
980
981 STATIC U32           vmg_op_name_init      = 0;
982 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
983
984 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
985 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
986  switch (opinfo) {
987   case VMG_OP_INFO_NAME:
988    VMG_LOCK(&vmg_op_name_init_mutex);
989    if (!vmg_op_name_init) {
990     OPCODE t;
991     for (t = 0; t < OP_max; ++t)
992      vmg_op_name_len[t] = strlen(PL_op_name[t]);
993     vmg_op_name_init = 1;
994    }
995    VMG_UNLOCK(&vmg_op_name_init_mutex);
996    break;
997   case VMG_OP_INFO_OBJECT: {
998    dMY_CXT;
999    if (!MY_CXT.b__op_stashes[0]) {
1000     int c;
1001     require_pv("B.pm");
1002     for (c = OPc_NULL; c < OPc_MAX; ++c)
1003      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1004    }
1005    break;
1006   }
1007   default:
1008    break;
1009  }
1010 }
1011
1012 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1013 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1014  if (!PL_op)
1015   return &PL_sv_undef;
1016
1017  switch (opinfo) {
1018   case VMG_OP_INFO_NAME: {
1019    OPCODE t = PL_op->op_type;
1020    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1021   }
1022   case VMG_OP_INFO_OBJECT: {
1023    dMY_CXT;
1024    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1025                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1026   }
1027   default:
1028    break;
1029  }
1030
1031  return &PL_sv_undef;
1032 }
1033
1034 /* --- svt callbacks ------------------------------------------------------- */
1035
1036 #define VMG_CB_CALL_ARGS_MASK  15
1037 #define VMG_CB_CALL_ARGS_SHIFT 4
1038 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
1039
1040 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1041  va_list ap;
1042  int ret = 0;
1043  unsigned int i, args, opinfo;
1044  SV *svr;
1045
1046  dSP;
1047
1048  args    = flags & VMG_CB_CALL_ARGS_MASK;
1049  flags >>= VMG_CB_CALL_ARGS_SHIFT;
1050  opinfo  = flags & VMG_CB_CALL_OPINFO;
1051
1052  ENTER;
1053  SAVETMPS;
1054
1055  PUSHMARK(SP);
1056  EXTEND(SP, args + 1);
1057  PUSHs(sv_2mortal(newRV_inc(sv)));
1058  va_start(ap, sv);
1059  for (i = 0; i < args; ++i) {
1060   SV *sva = va_arg(ap, SV *);
1061   PUSHs(sva ? sva : &PL_sv_undef);
1062  }
1063  va_end(ap);
1064  if (opinfo)
1065   XPUSHs(vmg_op_info(opinfo));
1066  PUTBACK;
1067
1068  vmg_call_sv(cb, G_SCALAR, NULL);
1069
1070  SPAGAIN;
1071  svr = POPs;
1072  if (SvOK(svr))
1073   ret = (int) SvIV(svr);
1074  PUTBACK;
1075
1076  FREETMPS;
1077  LEAVE;
1078
1079  return ret;
1080 }
1081
1082 #define VMG_CB_FLAGS(OI, A) \
1083         ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1084
1085 #define vmg_cb_call1(I, OI, S, A1) \
1086         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1087 #define vmg_cb_call2(I, OI, S, A1, A2) \
1088         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1089 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1090         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1091
1092 STATIC int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1093  return 0;
1094 }
1095
1096 /* ... get magic ........................................................... */
1097
1098 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1099  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1100
1101  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1102 }
1103
1104 #define vmg_svt_get_noop vmg_svt_default_noop
1105
1106 /* ... set magic ........................................................... */
1107
1108 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1109  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1110
1111  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1112 }
1113
1114 #define vmg_svt_set_noop vmg_svt_default_noop
1115
1116 /* ... len magic ........................................................... */
1117
1118 STATIC U32 vmg_sv_len(pTHX_ SV *sv) {
1119 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1120  STRLEN len;
1121 #if VMG_HAS_PERL(5, 9, 3)
1122  const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1123 #else
1124  U8 *s = SvPV(sv, len);
1125 #endif
1126
1127  return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1128 }
1129
1130 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1131  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1132  unsigned int opinfo = w->opinfo;
1133  U32 len, ret;
1134  SV *svr;
1135  svtype t = SvTYPE(sv);
1136
1137  dSP;
1138
1139  ENTER;
1140  SAVETMPS;
1141
1142  PUSHMARK(SP);
1143  EXTEND(SP, 3);
1144  PUSHs(sv_2mortal(newRV_inc(sv)));
1145  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1146  if (t < SVt_PVAV) {
1147   len = vmg_sv_len(sv);
1148   mPUSHu(len);
1149  } else if (t == SVt_PVAV) {
1150   len = av_len((AV *) sv) + 1;
1151   mPUSHu(len);
1152  } else {
1153   len = 0;
1154   PUSHs(&PL_sv_undef);
1155  }
1156  if (opinfo)
1157   XPUSHs(vmg_op_info(opinfo));
1158  PUTBACK;
1159
1160  vmg_call_sv(w->cb_len, G_SCALAR, NULL);
1161
1162  SPAGAIN;
1163  svr = POPs;
1164  ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1165  if (t == SVt_PVAV)
1166   --ret;
1167  PUTBACK;
1168
1169  FREETMPS;
1170  LEAVE;
1171
1172  return ret;
1173 }
1174
1175 STATIC U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1176  U32    len = 0;
1177  svtype t   = SvTYPE(sv);
1178
1179  if (t < SVt_PVAV) {
1180   len = vmg_sv_len(sv);
1181  } else if (t == SVt_PVAV) {
1182   len = (U32) av_len((AV *) sv);
1183  }
1184
1185  return len;
1186 }
1187
1188 /* ... clear magic ......................................................... */
1189
1190 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1191  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1192
1193  return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
1194 }
1195
1196 #define vmg_svt_clear_noop vmg_svt_default_noop
1197
1198 /* ... free magic .......................................................... */
1199
1200 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1201  const vmg_wizard *w;
1202  int ret = 0;
1203  SV *svr;
1204
1205  dSP;
1206
1207  /* During global destruction, we cannot be sure that the wizard and its free
1208   * callback are still alive. */
1209  if (PL_dirty)
1210   return 0;
1211
1212  w = vmg_wizard_from_mg_nocheck(mg);
1213
1214  /* So that it survives the temp cleanup below */
1215  SvREFCNT_inc_simple_void(sv);
1216
1217 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1218  /* The previous magic tokens were freed but the magic chain wasn't updated, so
1219   * if you access the sv from the callback the old deleted magics will trigger
1220   * and cause memory misreads. Change 32686 solved it that way : */
1221  SvMAGIC_set(sv, mg);
1222 #endif
1223
1224  ENTER;
1225  SAVETMPS;
1226
1227  PUSHMARK(SP);
1228  EXTEND(SP, 2);
1229  PUSHs(sv_2mortal(newRV_inc(sv)));
1230  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1231  if (w->opinfo)
1232   XPUSHs(vmg_op_info(w->opinfo));
1233  PUTBACK;
1234
1235  vmg_call_sv(w->cb_free, G_SCALAR, sv);
1236
1237  SPAGAIN;
1238  svr = POPs;
1239  if (SvOK(svr))
1240   ret = (int) SvIV(svr);
1241  PUTBACK;
1242
1243  FREETMPS;
1244  LEAVE;
1245
1246  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1247   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1248  --SvREFCNT(sv);
1249
1250  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1251   * mg->mg_ptr reference count */
1252  return ret;
1253 }
1254
1255 #define vmg_svt_free_noop vmg_svt_default_noop
1256
1257 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1258 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1259 #else
1260 # define VMG_SVT_COPY_KEYLEN_TYPE int
1261 #endif
1262
1263 /* ... copy magic .......................................................... */
1264
1265 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1266  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1267  SV *keysv;
1268  int ret;
1269
1270  if (keylen == HEf_SVKEY) {
1271   keysv = (SV *) key;
1272  } else {
1273   keysv = newSVpvn(key, keylen);
1274  }
1275
1276  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1277
1278  if (keylen != HEf_SVKEY) {
1279   SvREFCNT_dec(keysv);
1280  }
1281
1282  return ret;
1283 }
1284
1285 STATIC int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1286  return 0;
1287 }
1288
1289 /* ... dup magic ........................................................... */
1290
1291 #if 0
1292 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1293  return 0;
1294 }
1295 #define vmg_svt_dup_noop vmg_svt_dup
1296 #endif
1297
1298 /* ... local magic ......................................................... */
1299
1300 #if MGf_LOCAL
1301
1302 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1303  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1304
1305  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1306 }
1307
1308 #define vmg_svt_local_noop vmg_svt_default_noop
1309
1310 #endif /* MGf_LOCAL */
1311
1312 /* ... uvar magic .......................................................... */
1313
1314 #if VMG_UVAR
1315 STATIC OP *vmg_pp_resetuvar(pTHX) {
1316  SvRMAGICAL_on(cSVOP_sv);
1317  return NORMAL;
1318 }
1319
1320 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1321  vmg_uvar_ud *ud;
1322  MAGIC *mg, *umg;
1323  SV *key = NULL, *newkey = NULL;
1324  int tied = 0;
1325
1326  umg = mg_find(sv, PERL_MAGIC_uvar);
1327  /* umg can't be NULL or we wouldn't be there. */
1328  key = umg->mg_obj;
1329  ud  = (vmg_uvar_ud *) umg->mg_ptr;
1330
1331  if (ud->old_uf.uf_val)
1332   ud->old_uf.uf_val(aTHX_ action, sv);
1333  if (ud->old_uf.uf_set)
1334   ud->old_uf.uf_set(aTHX_ action, sv);
1335
1336  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
1337   const vmg_wizard *w;
1338
1339   switch (mg->mg_type) {
1340    case PERL_MAGIC_ext:
1341     break;
1342    case PERL_MAGIC_tied:
1343     ++tied;
1344     continue;
1345    default:
1346     continue;
1347   }
1348
1349   w = vmg_wizard_from_mg(mg);
1350   if (!w)
1351    continue;
1352
1353   switch (w->uvar) {
1354    case 0:
1355     continue;
1356    case 2:
1357     if (!newkey)
1358      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1359   }
1360
1361   switch (action
1362              & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1363    case 0:
1364     if (w->cb_fetch)
1365      vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
1366     break;
1367    case HV_FETCH_ISSTORE:
1368    case HV_FETCH_LVALUE:
1369    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1370     if (w->cb_store)
1371      vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
1372     break;
1373    case HV_FETCH_ISEXISTS:
1374     if (w->cb_exists)
1375      vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
1376     break;
1377    case HV_DELETE:
1378     if (w->cb_delete)
1379      vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
1380     break;
1381   }
1382  }
1383
1384  if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1385   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1386    * mistaken for a tied hash by the rest of hv_common. It will be reset by
1387    * the op_ppaddr of a new fake op injected between the current and the next
1388    * one. */
1389   OP *nop = PL_op->op_next;
1390   if (!nop || nop->op_ppaddr != vmg_pp_resetuvar) {
1391    SVOP *svop;
1392    NewOp(1101, svop, 1, SVOP);
1393    svop->op_type   = OP_STUB;
1394    svop->op_ppaddr = vmg_pp_resetuvar;
1395    svop->op_next   = nop;
1396    svop->op_flags  = 0;
1397    svop->op_sv     = sv;
1398    PL_op->op_next  = (OP *) svop;
1399   }
1400   SvRMAGICAL_off(sv);
1401  }
1402
1403  return 0;
1404 }
1405 #endif /* VMG_UVAR */
1406
1407 /* --- Macros for the XS section ------------------------------------------- */
1408
1409 #ifdef CvISXSUB
1410 # define VMG_CVOK(C) \
1411    ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
1412 #else
1413 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
1414 #endif
1415
1416 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
1417
1418 #define VMG_SET_CB(S, N) {       \
1419  SV *cb = (S);                   \
1420  if (SvOK(cb) && SvROK(cb)) {    \
1421   cb = SvRV(cb);                 \
1422   if (VMG_CBOK(cb))              \
1423    SvREFCNT_inc_simple_void(cb); \
1424   else                           \
1425    cb = NULL;                    \
1426  } else {                        \
1427   cb = NULL;                     \
1428  }                               \
1429  w->cb_ ## N = cb;               \
1430 }
1431
1432 #define VMG_SET_SVT_CB(S, N) {   \
1433  SV *cb = (S);                   \
1434  if (SvOK(cb) && SvROK(cb)) {    \
1435   cb = SvRV(cb);                 \
1436   if (VMG_CBOK(cb)) {            \
1437    t->svt_ ## N = vmg_svt_ ## N; \
1438    SvREFCNT_inc_simple_void(cb); \
1439   } else {                       \
1440    t->svt_ ## N = vmg_svt_ ## N ## _noop; \
1441    cb           = NULL;          \
1442   }                              \
1443  } else {                        \
1444   t->svt_ ## N = NULL;           \
1445   cb           = NULL;           \
1446  }                               \
1447  w->cb_ ## N = cb;               \
1448 }
1449
1450 /* --- XS ------------------------------------------------------------------ */
1451
1452 MODULE = Variable::Magic            PACKAGE = Variable::Magic
1453
1454 PROTOTYPES: ENABLE
1455
1456 BOOT:
1457 {
1458  HV *stash;
1459
1460  MY_CXT_INIT;
1461  MY_CXT.b__op_stashes[0] = NULL;
1462 #if VMG_THREADSAFE
1463  MUTEX_INIT(&vmg_vtable_refcount_mutex);
1464  MUTEX_INIT(&vmg_op_name_init_mutex);
1465 #endif
1466
1467  stash = gv_stashpv(__PACKAGE__, 1);
1468  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1469  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1470  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1471  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1472  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1473                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1474  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1475                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1476  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1477                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1478  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1479                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1480  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1481                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1482  newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1483                     newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1484  newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1485  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1486  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1487  newCONSTSUB(stash, "VMG_FORKSAFE",        newSVuv(VMG_FORKSAFE));
1488  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1489  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1490 }
1491
1492 #if VMG_THREADSAFE
1493
1494 void
1495 CLONE(...)
1496 PROTOTYPE: DISABLE
1497 PREINIT:
1498  U32 had_b__op_stash = 0;
1499  int c;
1500 PPCODE:
1501  {
1502   dMY_CXT;
1503   for (c = OPc_NULL; c < OPc_MAX; ++c) {
1504    if (MY_CXT.b__op_stashes[c])
1505     had_b__op_stash |= (((U32) 1) << c);
1506   }
1507  }
1508  {
1509   MY_CXT_CLONE;
1510   for (c = OPc_NULL; c < OPc_MAX; ++c) {
1511    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1512                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1513   }
1514  }
1515  XSRETURN(0);
1516
1517 #endif /* VMG_THREADSAFE */
1518
1519 SV *_wizard(...)
1520 PROTOTYPE: DISABLE
1521 PREINIT:
1522  vmg_wizard *w;
1523  MGVTBL *t;
1524  SV *op_info, *copy_key;
1525  I32 i = 0;
1526 CODE:
1527  if (items != 9
1528 #if MGf_LOCAL
1529               + 1
1530 #endif /* MGf_LOCAL */
1531 #if VMG_UVAR
1532               + 5
1533 #endif /* VMG_UVAR */
1534               ) { croak(vmg_wrongargnum); }
1535
1536  op_info = ST(i++);
1537  w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
1538  t = vmg_vtable_vtbl(w->vtable);
1539
1540  VMG_SET_CB(ST(i++), data);
1541
1542  VMG_SET_SVT_CB(ST(i++), get);
1543  VMG_SET_SVT_CB(ST(i++), set);
1544  VMG_SET_SVT_CB(ST(i++), len);
1545  VMG_SET_SVT_CB(ST(i++), clear);
1546  VMG_SET_SVT_CB(ST(i++), free);
1547  VMG_SET_SVT_CB(ST(i++), copy);
1548  /* VMG_SET_SVT_CB(ST(i++), dup); */
1549  i++;
1550  t->svt_dup = NULL;
1551  w->cb_dup  = NULL;
1552 #if MGf_LOCAL
1553  VMG_SET_SVT_CB(ST(i++), local);
1554 #endif /* MGf_LOCAL */
1555 #if VMG_UVAR
1556  VMG_SET_CB(ST(i++), fetch);
1557  VMG_SET_CB(ST(i++), store);
1558  VMG_SET_CB(ST(i++), exists);
1559  VMG_SET_CB(ST(i++), delete);
1560
1561  copy_key = ST(i++);
1562  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1563   w->uvar = SvTRUE(copy_key) ? 2 : 1;
1564 #endif /* VMG_UVAR */
1565
1566  RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
1567 OUTPUT:
1568  RETVAL
1569
1570 SV *cast(SV *sv, SV *wiz, ...)
1571 PROTOTYPE: \[$@%&*]$@
1572 PREINIT:
1573  const vmg_wizard *w = NULL;
1574  SV **args = NULL;
1575  UV ret;
1576  I32 i = 0;
1577 CODE:
1578  if (items > 2) {
1579   i = items - 2;
1580   args = &ST(2);
1581  }
1582  if (SvROK(wiz)) {
1583   wiz = SvRV_const(wiz);
1584   w   = vmg_wizard_from_sv(wiz);
1585  }
1586  if (!w)
1587   croak(vmg_invalid_wiz);
1588  RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
1589 OUTPUT:
1590  RETVAL
1591
1592 void
1593 getdata(SV *sv, SV *wiz)
1594 PROTOTYPE: \[$@%&*]$
1595 PREINIT:
1596  const vmg_wizard *w = NULL;
1597  SV *data;
1598 PPCODE:
1599  if (SvROK(wiz))
1600   w = vmg_wizard_from_sv(SvRV_const(wiz));
1601  if (!w)
1602   croak(vmg_invalid_wiz);
1603  data = vmg_data_get(SvRV(sv), w);
1604  if (!data)
1605   XSRETURN_EMPTY;
1606  ST(0) = data;
1607  XSRETURN(1);
1608
1609 SV *dispell(SV *sv, SV *wiz)
1610 PROTOTYPE: \[$@%&*]$
1611 PREINIT:
1612  const vmg_wizard *w = NULL;
1613 CODE:
1614  if (SvROK(wiz))
1615   w = vmg_wizard_from_sv(SvRV_const(wiz));
1616  if (!w)
1617   croak(vmg_invalid_wiz);
1618  RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));
1619 OUTPUT:
1620  RETVAL