]> git.vpit.fr Git - perl/modules/Variable-Magic.git/blob - Magic.xs
This is 0.55
[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 #if VMG_HAS_PERL(5, 17, 4)
143 # define VMG_COMPAT_SCALAR_NOLEN 1
144 #else
145 # define VMG_COMPAT_SCALAR_NOLEN 0
146 #endif
147
148 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
149  * reverted to dev-5.11 as 9cdcb38b */
150 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
151 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
152 #  if VMG_HAS_PERL(5, 11, 0)
153 #   define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
154 #  else
155 #   define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
156 #  endif
157 # endif
158 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
159 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
160 # endif
161 #else
162 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
163 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
164 # endif
165 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
166 #  define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
167 # endif
168 #endif
169
170 /* Applied to dev-5.11 as 34908 */
171 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908) || VMG_HAS_PERL(5, 12, 0)
172 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
173 #else
174 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
175 #endif
176
177 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
178 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
179 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
180 #else
181 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
182 #endif
183
184 #if VMG_HAS_PERL(5, 11, 0)
185 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 1
186 #else
187 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 0
188 #endif
189
190 #if VMG_HAS_PERL(5, 17, 0)
191 # define VMG_COMPAT_CODE_COPY_CLONE 1
192 #else
193 # define VMG_COMPAT_CODE_COPY_CLONE 0
194 #endif
195
196 #if VMG_HAS_PERL(5, 13, 2)
197 # define VMG_COMPAT_GLOB_GET 1
198 #else
199 # define VMG_COMPAT_GLOB_GET 0
200 #endif
201
202 #define VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE (VMG_HAS_PERL(5, 10, 0) && !VMG_HAS_PERL(5, 10, 1))
203
204 /* NewOp() isn't public in perl 5.8.0. */
205 #define VMG_RESET_RMG_NEEDS_TRAMPOLINE (VMG_UVAR && (VMG_THREADSAFE || !VMG_HAS_PERL(5, 8, 1)))
206
207 /* ... Bug-free mg_magical ................................................. */
208
209 /* See the discussion at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html */
210
211 #if VMG_HAS_PERL(5, 11, 3)
212
213 #define vmg_mg_magical(S) mg_magical(S)
214
215 #else
216
217 STATIC void vmg_mg_magical(SV *sv) {
218  const MAGIC *mg;
219
220  SvMAGICAL_off(sv);
221  if ((mg = SvMAGIC(sv))) {
222   do {
223    const MGVTBL* const vtbl = mg->mg_virtual;
224    if (vtbl) {
225     if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
226      SvGMAGICAL_on(sv);
227     if (vtbl->svt_set)
228      SvSMAGICAL_on(sv);
229     if (vtbl->svt_clear)
230      SvRMAGICAL_on(sv);
231    }
232   } while ((mg = mg->mg_moremagic));
233   if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
234    SvRMAGICAL_on(sv);
235  }
236 }
237
238 #endif
239
240 /* --- Trampoline ops ------------------------------------------------------ */
241
242 #define VMG_NEEDS_TRAMPOLINE VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE || VMG_RESET_RMG_NEEDS_TRAMPOLINE
243
244 #if VMG_NEEDS_TRAMPOLINE
245
246 typedef struct {
247  OP   temp;
248  SVOP target;
249 } vmg_trampoline;
250
251 STATIC void vmg_trampoline_init(vmg_trampoline *t, OP *(*cb)(pTHX)) {
252  t->temp.op_type    = OP_STUB;
253  t->temp.op_ppaddr  = 0;
254  t->temp.op_next    = (OP *) &t->target;
255  t->temp.op_flags   = 0;
256  t->temp.op_private = 0;
257
258  t->target.op_type    = OP_STUB;
259  t->target.op_ppaddr  = cb;
260  t->target.op_next    = NULL;
261  t->target.op_flags   = 0;
262  t->target.op_private = 0;
263  t->target.op_sv      = NULL;
264 }
265
266 STATIC OP *vmg_trampoline_bump(pTHX_ vmg_trampoline *t, SV *sv, OP *o) {
267 #define vmg_trampoline_bump(T, S, O) vmg_trampoline_bump(aTHX_ (T), (S), (O))
268  t->temp         = *o;
269  t->temp.op_next = (OP *) &t->target;
270
271  t->target.op_sv   = sv;
272  t->target.op_next = o->op_next;
273
274  return &t->temp;
275 }
276
277 #endif /* VMG_NEEDS_TRAMPOLINE */
278
279 /* --- Safe version of call_sv() ------------------------------------------- */
280
281 STATIC I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, int (*cleanup)(pTHX_ void *), void *ud) {
282 #define vmg_call_sv(S, F, C, U) vmg_call_sv(aTHX_ (S), (F), (C), (U))
283  I32 ret, cxix;
284  PERL_CONTEXT saved_cx;
285  SV *old_err = NULL;
286
287  if (SvTRUE(ERRSV)) {
288   old_err = ERRSV;
289   ERRSV   = newSV(0);
290  }
291
292  cxix     = (cxstack_ix < cxstack_max) ? (cxstack_ix + 1) : Perl_cxinc(aTHX);
293  /* The last popped context will be reused by call_sv(), but our callers may
294   * still need its previous value. Back it up so that it isn't clobbered. */
295  saved_cx = cxstack[cxix];
296
297  ret = call_sv(sv, flags | G_EVAL);
298
299  cxstack[cxix] = saved_cx;
300
301  if (SvTRUE(ERRSV)) {
302   if (old_err) {
303    sv_setsv(old_err, ERRSV);
304    SvREFCNT_dec(ERRSV);
305    ERRSV = old_err;
306   }
307   if (IN_PERL_COMPILETIME) {
308    if (!PL_in_eval) {
309     if (PL_errors)
310      sv_catsv(PL_errors, ERRSV);
311     else
312      Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
313     SvCUR_set(ERRSV, 0);
314    }
315 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
316    if (PL_parser)
317     ++PL_parser->error_count;
318 #elif defined(PL_error_count)
319    ++PL_error_count;
320 #else
321    ++PL_Ierror_count;
322 #endif
323   } else {
324    if (!cleanup || cleanup(aTHX_ ud))
325     croak(NULL);
326   }
327  } else {
328   if (old_err) {
329    SvREFCNT_dec(ERRSV);
330    ERRSV = old_err;
331   }
332  }
333
334  return ret;
335 }
336
337 /* --- Stolen chunk of B --------------------------------------------------- */
338
339 typedef enum {
340  OPc_NULL,
341  OPc_BASEOP,
342  OPc_UNOP,
343  OPc_BINOP,
344  OPc_LOGOP,
345  OPc_LISTOP,
346  OPc_PMOP,
347  OPc_SVOP,
348  OPc_PADOP,
349  OPc_PVOP,
350  OPc_LOOP,
351  OPc_COP,
352 #if VMG_HAS_PERL(5, 21, 5)
353  OPc_METHOP,
354 #endif
355  OPc_MAX
356 } opclass;
357
358 STATIC const char *const vmg_opclassnames[] = {
359  "B::NULL",
360  "B::OP",
361  "B::UNOP",
362  "B::BINOP",
363  "B::LOGOP",
364  "B::LISTOP",
365  "B::PMOP",
366  "B::SVOP",
367  "B::PADOP",
368  "B::PVOP",
369  "B::LOOP",
370  "B::COP",
371 #if VMG_HAS_PERL(5, 21, 5)
372  "B::METHOP",
373 #endif
374  NULL
375 };
376
377 STATIC opclass vmg_opclass(const OP *o) {
378 #if 0
379  if (!o)
380   return OPc_NULL;
381 #endif
382
383  if (o->op_type == 0)
384   return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
385
386  if (o->op_type == OP_SASSIGN)
387   return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
388
389  if (o->op_type == OP_AELEMFAST) {
390 #if PERL_VERSION <= 14
391   if (o->op_flags & OPf_SPECIAL)
392    return OPc_BASEOP;
393   else
394 #endif
395 #ifdef USE_ITHREADS
396    return OPc_PADOP;
397 #else
398    return OPc_SVOP;
399 #endif
400  }
401
402 #ifdef USE_ITHREADS
403  if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
404   return OPc_PADOP;
405 #endif
406
407  switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
408   case OA_BASEOP:
409    return OPc_BASEOP;
410   case OA_UNOP:
411    return OPc_UNOP;
412   case OA_BINOP:
413    return OPc_BINOP;
414   case OA_LOGOP:
415    return OPc_LOGOP;
416   case OA_LISTOP:
417    return OPc_LISTOP;
418   case OA_PMOP:
419    return OPc_PMOP;
420   case OA_SVOP:
421    return OPc_SVOP;
422   case OA_PADOP:
423    return OPc_PADOP;
424   case OA_PVOP_OR_SVOP:
425    return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
426   case OA_LOOP:
427    return OPc_LOOP;
428   case OA_COP:
429    return OPc_COP;
430   case OA_BASEOP_OR_UNOP:
431    return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
432   case OA_FILESTATOP:
433    return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
434 #ifdef USE_ITHREADS
435            (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
436 #else
437            (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
438 #endif
439   case OA_LOOPEXOP:
440    if (o->op_flags & OPf_STACKED)
441     return OPc_UNOP;
442    else if (o->op_flags & OPf_SPECIAL)
443     return OPc_BASEOP;
444    else
445     return OPc_PVOP;
446 #if VMG_HAS_PERL(5, 21, 5)
447   case OA_METHOP:
448    return OPc_METHOP;
449 #endif
450  }
451
452  return OPc_BASEOP;
453 }
454
455 /* --- Error messages ------------------------------------------------------ */
456
457 STATIC const char vmg_invalid_wiz[]    = "Invalid wizard object";
458 STATIC const char vmg_wrongargnum[]    = "Wrong number of arguments";
459 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
460
461 /* --- Context-safe global data -------------------------------------------- */
462
463 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
464
465 typedef struct {
466  HV             *b__op_stashes[OPc_MAX];
467  I32             depth;
468  MAGIC          *freed_tokens;
469 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
470  vmg_trampoline  propagate_errsv;
471 #endif
472 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
473  vmg_trampoline  reset_rmg;
474 #endif
475 } my_cxt_t;
476
477 START_MY_CXT
478
479 /* --- <vmg_vtable> structure ---------------------------------------------- */
480
481 #if VMG_THREADSAFE
482
483 typedef struct {
484  MGVTBL *vtbl;
485  U32     refcount;
486 } vmg_vtable;
487
488 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
489 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
490  vmg_vtable *t;
491
492  t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
493
494  t->vtbl     = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
495  t->refcount = 1;
496
497  return t;
498 }
499
500 #define vmg_vtable_vtbl(T) (T)->vtbl
501
502 STATIC perl_mutex vmg_vtable_refcount_mutex;
503
504 STATIC vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
505 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
506  VMG_LOCK(&vmg_vtable_refcount_mutex);
507  ++t->refcount;
508  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
509
510  return t;
511 }
512
513 STATIC void vmg_vtable_free(pTHX_ vmg_vtable *t) {
514 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
515  U32 refcount;
516
517  VMG_LOCK(&vmg_vtable_refcount_mutex);
518  refcount = --t->refcount;
519  VMG_UNLOCK(&vmg_vtable_refcount_mutex);
520
521  if (!refcount) {
522   PerlMemShared_free(t->vtbl);
523   PerlMemShared_free(t);
524  }
525 }
526
527 #else /* VMG_THREADSAFE */
528
529 typedef MGVTBL vmg_vtable;
530
531 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
532 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
533  vmg_vtable *t;
534
535  Newx(t, 1, vmg_vtable);
536
537  return t;
538 }
539
540 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
541
542 #define vmg_vtable_free(T) Safefree(T)
543
544 #endif /* !VMG_THREADSAFE */
545
546 /* --- <vmg_wizard> structure ---------------------------------------------- */
547
548 typedef struct {
549  vmg_vtable *vtable;
550
551  U8 opinfo;
552  U8 uvar;
553
554  SV *cb_data;
555  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
556  SV *cb_copy;
557  SV *cb_dup;
558 #if MGf_LOCAL
559  SV *cb_local;
560 #endif /* MGf_LOCAL */
561 #if VMG_UVAR
562  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
563 #endif /* VMG_UVAR */
564 } vmg_wizard;
565
566 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo);
567
568 STATIC vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
569 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
570  vmg_wizard *w;
571
572  Newx(w, 1, vmg_wizard);
573
574  w->uvar   = 0;
575  w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
576  if (w->opinfo)
577   vmg_op_info_init(aTHX_ w->opinfo);
578
579  w->vtable = vmg_vtable_alloc();
580
581  return w;
582 }
583
584 STATIC void vmg_wizard_free(pTHX_ vmg_wizard *w) {
585 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
586  if (!w)
587   return;
588
589  /* During global destruction, any of the callbacks may already have been
590   * freed, so we can't rely on still being able to access them. */
591  if (!PL_dirty) {
592   SvREFCNT_dec(w->cb_data);
593   SvREFCNT_dec(w->cb_get);
594   SvREFCNT_dec(w->cb_set);
595   SvREFCNT_dec(w->cb_len);
596   SvREFCNT_dec(w->cb_clear);
597   SvREFCNT_dec(w->cb_free);
598   SvREFCNT_dec(w->cb_copy);
599 #if 0
600   SvREFCNT_dec(w->cb_dup);
601 #endif
602 #if MGf_LOCAL
603   SvREFCNT_dec(w->cb_local);
604 #endif /* MGf_LOCAL */
605 #if VMG_UVAR
606   SvREFCNT_dec(w->cb_fetch);
607   SvREFCNT_dec(w->cb_store);
608   SvREFCNT_dec(w->cb_exists);
609   SvREFCNT_dec(w->cb_delete);
610 #endif /* VMG_UVAR */
611  }
612
613  /* PerlMemShared_free() and Safefree() are still fine during global
614   * destruction though. */
615  vmg_vtable_free(w->vtable);
616  Safefree(w);
617
618  return;
619 }
620
621 #if VMG_THREADSAFE
622
623 #define VMG_CLONE_CB(N) \
624  z->cb_ ## N = (w->cb_ ## N) ? SvREFCNT_inc(sv_dup(w->cb_ ## N, params)) \
625                              : NULL;
626
627 STATIC const vmg_wizard *vmg_wizard_dup(pTHX_ const vmg_wizard *w, CLONE_PARAMS *params) {
628 #define vmg_wizard_dup(W, P) vmg_wizard_dup(aTHX_ (W), (P))
629  vmg_wizard *z;
630
631  if (!w)
632   return NULL;
633
634  Newx(z, 1, vmg_wizard);
635
636  z->vtable = vmg_vtable_dup(w->vtable);
637  z->uvar   = w->uvar;
638  z->opinfo = w->opinfo;
639
640  VMG_CLONE_CB(data);
641  VMG_CLONE_CB(get);
642  VMG_CLONE_CB(set);
643  VMG_CLONE_CB(len);
644  VMG_CLONE_CB(clear);
645  VMG_CLONE_CB(free);
646  VMG_CLONE_CB(copy);
647  VMG_CLONE_CB(dup);
648 #if MGf_LOCAL
649  VMG_CLONE_CB(local);
650 #endif /* MGf_LOCAL */
651 #if VMG_UVAR
652  VMG_CLONE_CB(fetch);
653  VMG_CLONE_CB(store);
654  VMG_CLONE_CB(exists);
655  VMG_CLONE_CB(delete);
656 #endif /* VMG_UVAR */
657
658  return z;
659 }
660
661 #endif /* VMG_THREADSAFE */
662
663 #define vmg_wizard_id(W) PTR2IV(vmg_vtable_vtbl((W)->vtable))
664
665 /* --- Wizard SV objects --------------------------------------------------- */
666
667 STATIC int vmg_wizard_sv_free(pTHX_ SV *sv, MAGIC *mg) {
668  vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
669
670  return 0;
671 }
672
673 #if VMG_THREADSAFE
674
675 STATIC int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
676  mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
677
678  return 0;
679 }
680
681 #endif /* VMG_THREADSAFE */
682
683 STATIC MGVTBL vmg_wizard_sv_vtbl = {
684  NULL,               /* get */
685  NULL,               /* set */
686  NULL,               /* len */
687  NULL,               /* clear */
688  vmg_wizard_sv_free, /* free */
689  NULL,               /* copy */
690 #if VMG_THREADSAFE
691  vmg_wizard_sv_dup,  /* dup */
692 #else
693  NULL,               /* dup */
694 #endif
695 #if MGf_LOCAL
696  NULL,               /* local */
697 #endif /* MGf_LOCAL */
698 };
699
700 STATIC SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
701 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
702  SV *wiz;
703
704 #if VMG_THREADSAFE
705  wiz = newSV(0);
706 #else
707  wiz = newSViv(PTR2IV(w));
708 #endif
709
710  if (w) {
711   MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_sv_vtbl,
712                                      (const char *) w, 0);
713   mg->mg_private = 0;
714 #if VMG_THREADSAFE
715   mg->mg_flags  |= MGf_DUP;
716 #endif
717  }
718  SvREADONLY_on(wiz);
719
720  return wiz;
721 }
722
723 #if VMG_THREADSAFE
724
725 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
726
727 STATIC const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
728  MAGIC *mg;
729
730  for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
731   if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
732    return (const vmg_wizard *) mg->mg_ptr;
733  }
734
735  return NULL;
736 }
737
738 #else /* VMG_THREADSAFE */
739
740 #define vmg_sv_has_wizard_type(S) SvIOK(S)
741
742 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
743
744 #endif /* !VMG_THREADSAFE */
745
746 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
747
748 STATIC const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
749  if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
750   SV *sv = (SV *) mg->mg_ptr;
751
752   if (vmg_sv_has_wizard_type(sv))
753    return vmg_wizard_from_sv_nocheck(sv);
754  }
755
756  return NULL;
757 }
758
759 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
760
761 /* --- User-level functions implementation --------------------------------- */
762
763 STATIC const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
764  const MAGIC *mg;
765  IV wid;
766
767  if (SvTYPE(sv) < SVt_PVMG)
768   return NULL;
769
770  wid = vmg_wizard_id(w);
771
772  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
773   const vmg_wizard *z = vmg_wizard_from_mg(mg);
774
775   if (z && vmg_wizard_id(z) == wid)
776    return mg;
777  }
778
779  return NULL;
780 }
781
782 /* ... Construct private data .............................................. */
783
784 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
785 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
786  I32 i;
787  SV *nsv;
788
789  dSP;
790
791  ENTER;
792  SAVETMPS;
793
794  PUSHMARK(SP);
795  EXTEND(SP, items + 1);
796  PUSHs(sv_2mortal(newRV_inc(sv)));
797  for (i = 0; i < items; ++i)
798   PUSHs(args[i]);
799  PUTBACK;
800
801  vmg_call_sv(ctor, G_SCALAR, 0, NULL);
802
803  SPAGAIN;
804  nsv = POPs;
805 #if VMG_HAS_PERL(5, 8, 3)
806  SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
807 #else
808  nsv = sv_newref(nsv);          /* Workaround some bug in SvREFCNT_inc() */
809 #endif
810  PUTBACK;
811
812  FREETMPS;
813  LEAVE;
814
815  return nsv;
816 }
817
818 STATIC SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
819 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
820  const MAGIC *mg = vmg_find(sv, w);
821
822  return mg ? mg->mg_obj : NULL;
823 }
824
825 /* ... Magic cast/dispell .................................................. */
826
827 #if VMG_UVAR
828
829 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
830
831 typedef struct {
832  struct ufuncs new_uf;
833  struct ufuncs old_uf;
834 } vmg_uvar_ud;
835
836 #endif /* VMG_UVAR */
837
838 STATIC void vmg_mg_del(pTHX_ SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
839 #define vmg_mg_del(S, P, M, N) vmg_mg_del(aTHX_ (S), (P), (M), (N))
840  dMY_CXT;
841
842  if (prevmagic)
843   prevmagic->mg_moremagic = moremagic;
844  else
845   SvMAGIC_set(sv, moremagic);
846
847  /* Destroy private data */
848 #if VMG_UVAR
849  if (mg->mg_type == PERL_MAGIC_uvar) {
850   Safefree(mg->mg_ptr);
851  } else {
852 #endif /* VMG_UVAR */
853   if (mg->mg_obj != sv) {
854    SvREFCNT_dec(mg->mg_obj);
855    mg->mg_obj = NULL;
856   }
857   /* Unreference the wizard */
858   SvREFCNT_dec((SV *) mg->mg_ptr);
859   mg->mg_ptr = NULL;
860 #if VMG_UVAR
861  }
862 #endif /* VMG_UVAR */
863
864  if (MY_CXT.depth) {
865   mg->mg_moremagic    = MY_CXT.freed_tokens;
866   MY_CXT.freed_tokens = mg;
867  } else {
868   mg->mg_moremagic = NULL;
869   Safefree(mg);
870  }
871 }
872
873 STATIC int vmg_magic_chain_free(pTHX_ MAGIC *mg, MAGIC *skip) {
874 #define vmg_magic_chain_free(M, S) vmg_magic_chain_free(aTHX_ (M), (S))
875  int skipped = 0;
876
877  while (mg) {
878   MAGIC *moremagic = mg->mg_moremagic;
879
880   if (mg == skip)
881    ++skipped;
882   else
883    Safefree(mg);
884
885   mg = moremagic;
886  }
887
888  return skipped;
889 }
890
891 STATIC UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
892 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
893  MAGIC  *mg;
894  MGVTBL *t;
895  SV     *data;
896  U32     oldgmg;
897
898  if (vmg_find(sv, w))
899   return 1;
900
901  oldgmg = SvGMAGICAL(sv);
902
903  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
904
905  t  = vmg_vtable_vtbl(w->vtable);
906  mg = sv_magicext(sv, data, PERL_MAGIC_ext, t, (const char *) wiz, HEf_SVKEY);
907  mg->mg_private = 0;
908
909  /* sv_magicext() calls mg_magical and increments data's refcount */
910  SvREFCNT_dec(data);
911
912  if (t->svt_copy)
913   mg->mg_flags |= MGf_COPY;
914 #if 0
915  if (t->svt_dup)
916   mg->mg_flags |= MGf_DUP;
917 #endif
918 #if MGf_LOCAL
919  if (t->svt_local)
920   mg->mg_flags |= MGf_LOCAL;
921 #endif /* MGf_LOCAL */
922
923  if (SvTYPE(sv) < SVt_PVHV)
924   goto done;
925
926  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
927   * magic is actually never called for them. If the GMAGICAL flag was off before
928   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
929   * now on, then this wizard has get magic. Hence we can work around the
930   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
931   * has uvar callbacks, it will be turned back on later. */
932  if (!oldgmg && SvGMAGICAL(sv))
933   SvGMAGICAL_off(sv);
934
935 #if VMG_UVAR
936  if (w->uvar) {
937   MAGIC *prevmagic, *moremagic = NULL;
938   vmg_uvar_ud ud;
939
940   ud.new_uf.uf_val   = vmg_svt_val;
941   ud.new_uf.uf_set   = NULL;
942   ud.new_uf.uf_index = 0;
943   ud.old_uf.uf_val   = NULL;
944   ud.old_uf.uf_set   = NULL;
945   ud.old_uf.uf_index = 0;
946
947   /* One uvar magic in the chain is enough. */
948   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
949    moremagic = mg->mg_moremagic;
950    if (mg->mg_type == PERL_MAGIC_uvar)
951     break;
952   }
953
954   if (mg) { /* Found another uvar magic. */
955    struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
956    if (uf->uf_val == vmg_svt_val) {
957     /* It's our uvar magic, nothing to do. oldgmg was true. */
958     goto done;
959    } else {
960     /* It's another uvar magic, backup it and replace it by ours. */
961     ud.old_uf = *uf;
962     vmg_mg_del(sv, prevmagic, mg, moremagic);
963    }
964   }
965
966   sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
967   vmg_mg_magical(sv);
968   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
969    * handled by our uvar callback. */
970  }
971 #endif /* VMG_UVAR */
972
973 done:
974  return 1;
975 }
976
977 STATIC UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
978 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
979 #if VMG_UVAR
980  U32 uvars = 0;
981 #endif /* VMG_UVAR */
982  MAGIC *mg, *prevmagic, *moremagic = NULL;
983  IV wid = vmg_wizard_id(w);
984
985  if (SvTYPE(sv) < SVt_PVMG)
986   return 0;
987
988  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
989   const vmg_wizard *z;
990
991   moremagic = mg->mg_moremagic;
992
993   z = vmg_wizard_from_mg(mg);
994   if (z) {
995    IV zid = vmg_wizard_id(z);
996
997 #if VMG_UVAR
998    if (zid == wid) {
999     /* If the current has no uvar, short-circuit uvar deletion. */
1000     uvars = z->uvar ? (uvars + 1) : 0;
1001     break;
1002    } else if (z->uvar) {
1003     ++uvars;
1004     /* We can't break here since we need to find the ext magic to delete. */
1005    }
1006 #else /* VMG_UVAR */
1007    if (zid == wid)
1008     break;
1009 #endif /* !VMG_UVAR */
1010   }
1011  }
1012  if (!mg)
1013   return 0;
1014
1015  vmg_mg_del(sv, prevmagic, mg, moremagic);
1016
1017 #if VMG_UVAR
1018  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
1019   /* mg was the first ext magic in the chain that had uvar */
1020
1021   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
1022    const vmg_wizard *z = vmg_wizard_from_mg(mg);
1023
1024    if (z && z->uvar) {
1025     ++uvars;
1026     break;
1027    }
1028   }
1029
1030   if (uvars == 1) {
1031    vmg_uvar_ud *ud;
1032
1033    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
1034     moremagic = mg->mg_moremagic;
1035     if (mg->mg_type == PERL_MAGIC_uvar)
1036      break;
1037    }
1038
1039    ud = (vmg_uvar_ud *) mg->mg_ptr;
1040    if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
1041     /* Revert the original uvar magic. */
1042     struct ufuncs *uf;
1043     Newx(uf, 1, struct ufuncs);
1044     *uf = ud->old_uf;
1045     Safefree(ud);
1046     mg->mg_ptr = (char *) uf;
1047     mg->mg_len = sizeof(*uf);
1048    } else {
1049     /* Remove the uvar magic. */
1050     vmg_mg_del(sv, prevmagic, mg, moremagic);
1051    }
1052   }
1053  }
1054 #endif /* VMG_UVAR */
1055
1056  vmg_mg_magical(sv);
1057
1058  return 1;
1059 }
1060
1061 /* ... OP info ............................................................. */
1062
1063 #define VMG_OP_INFO_NAME   1
1064 #define VMG_OP_INFO_OBJECT 2
1065
1066 #if VMG_THREADSAFE
1067 STATIC perl_mutex vmg_op_name_init_mutex;
1068 #endif
1069
1070 STATIC U32           vmg_op_name_init      = 0;
1071 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
1072
1073 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
1074 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
1075  switch (opinfo) {
1076   case VMG_OP_INFO_NAME:
1077    VMG_LOCK(&vmg_op_name_init_mutex);
1078    if (!vmg_op_name_init) {
1079     OPCODE t;
1080     for (t = 0; t < OP_max; ++t)
1081      vmg_op_name_len[t] = strlen(PL_op_name[t]);
1082     vmg_op_name_init = 1;
1083    }
1084    VMG_UNLOCK(&vmg_op_name_init_mutex);
1085    break;
1086   case VMG_OP_INFO_OBJECT: {
1087    dMY_CXT;
1088    if (!MY_CXT.b__op_stashes[0]) {
1089     int c;
1090     require_pv("B.pm");
1091     for (c = OPc_NULL; c < OPc_MAX; ++c)
1092      MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1093    }
1094    break;
1095   }
1096   default:
1097    break;
1098  }
1099 }
1100
1101 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1102 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1103  if (!PL_op)
1104   return &PL_sv_undef;
1105
1106  switch (opinfo) {
1107   case VMG_OP_INFO_NAME: {
1108    OPCODE t = PL_op->op_type;
1109    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1110   }
1111   case VMG_OP_INFO_OBJECT: {
1112    dMY_CXT;
1113    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1114                    MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1115   }
1116   default:
1117    break;
1118  }
1119
1120  return &PL_sv_undef;
1121 }
1122
1123 /* --- svt callbacks ------------------------------------------------------- */
1124
1125 #define VMG_CB_CALL_ARGS_MASK  15
1126 #define VMG_CB_CALL_ARGS_SHIFT 4
1127 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT) /* 1|2 */
1128 #define VMG_CB_CALL_GUARD      4
1129
1130 STATIC int vmg_dispell_guard_oncroak(pTHX_ void *ud) {
1131  dMY_CXT;
1132
1133  MY_CXT.depth--;
1134
1135  /* If we're at the upmost magic call and we're about to die, we can just free
1136   * the tokens right now, since we will jump past the problematic part of our
1137   * caller. */
1138  if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1139   vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1140   MY_CXT.freed_tokens = NULL;
1141  }
1142
1143  return 1;
1144 }
1145
1146 STATIC int vmg_dispell_guard_free(pTHX_ SV *sv, MAGIC *mg) {
1147  vmg_magic_chain_free((MAGIC *) mg->mg_ptr, NULL);
1148
1149  return 0;
1150 }
1151
1152 #if VMG_THREADSAFE
1153
1154 STATIC int vmg_dispell_guard_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
1155  /* The freed magic tokens aren't cloned by perl because it cannot reach them
1156   * (they have been detached from their parent SV when they were enqueued).
1157   * Hence there's nothing to purge in the new thread. */
1158  mg->mg_ptr = NULL;
1159
1160  return 0;
1161 }
1162
1163 #endif /* VMG_THREADSAFE */
1164
1165 STATIC MGVTBL vmg_dispell_guard_vtbl = {
1166  NULL,                   /* get */
1167  NULL,                   /* set */
1168  NULL,                   /* len */
1169  NULL,                   /* clear */
1170  vmg_dispell_guard_free, /* free */
1171  NULL,                   /* copy */
1172 #if VMG_THREADSAFE
1173  vmg_dispell_guard_dup,  /* dup */
1174 #else
1175  NULL,                   /* dup */
1176 #endif
1177 #if MGf_LOCAL
1178  NULL,                   /* local */
1179 #endif /* MGf_LOCAL */
1180 };
1181
1182 STATIC SV *vmg_dispell_guard_new(pTHX_ MAGIC *root) {
1183 #define vmg_dispell_guard_new(R) vmg_dispell_guard_new(aTHX_ (R))
1184  SV *guard;
1185
1186  guard = sv_newmortal();
1187  sv_magicext(guard, NULL, PERL_MAGIC_ext, &vmg_dispell_guard_vtbl,
1188                           (char *) root, 0);
1189
1190  return guard;
1191 }
1192
1193 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1194  va_list ap;
1195  int ret = 0;
1196  unsigned int i, args, opinfo;
1197  MAGIC **chain = NULL;
1198  SV *svr;
1199
1200  dSP;
1201
1202  args    = flags & VMG_CB_CALL_ARGS_MASK;
1203  flags >>= VMG_CB_CALL_ARGS_SHIFT;
1204  opinfo  = flags & VMG_CB_CALL_OPINFO;
1205
1206  ENTER;
1207  SAVETMPS;
1208
1209  PUSHMARK(SP);
1210  EXTEND(SP, args + 1);
1211  PUSHs(sv_2mortal(newRV_inc(sv)));
1212  va_start(ap, sv);
1213  for (i = 0; i < args; ++i) {
1214   SV *sva = va_arg(ap, SV *);
1215   PUSHs(sva ? sva : &PL_sv_undef);
1216  }
1217  va_end(ap);
1218  if (opinfo)
1219   XPUSHs(vmg_op_info(opinfo));
1220  PUTBACK;
1221
1222  if (flags & VMG_CB_CALL_GUARD) {
1223   dMY_CXT;
1224   MY_CXT.depth++;
1225   vmg_call_sv(cb, G_SCALAR, vmg_dispell_guard_oncroak, NULL);
1226   MY_CXT.depth--;
1227   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens)
1228    chain = &MY_CXT.freed_tokens;
1229  } else {
1230   vmg_call_sv(cb, G_SCALAR, 0, NULL);
1231  }
1232
1233  SPAGAIN;
1234  svr = POPs;
1235  if (SvOK(svr))
1236   ret = (int) SvIV(svr);
1237  PUTBACK;
1238
1239  FREETMPS;
1240  LEAVE;
1241
1242  if (chain) {
1243   vmg_dispell_guard_new(*chain);
1244   *chain = NULL;
1245  }
1246
1247  return ret;
1248 }
1249
1250 #define VMG_CB_FLAGS(OI, A) \
1251         ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1252
1253 #define vmg_cb_call1(I, OI, S, A1) \
1254         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1255 #define vmg_cb_call2(I, OI, S, A1, A2) \
1256         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1257 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1258         vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1259
1260 /* ... Default no-op magic callback ........................................ */
1261
1262 STATIC int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1263  return 0;
1264 }
1265
1266 /* ... get magic ........................................................... */
1267
1268 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1269  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1270
1271  return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1272 }
1273
1274 #define vmg_svt_get_noop vmg_svt_default_noop
1275
1276 /* ... set magic ........................................................... */
1277
1278 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1279  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1280
1281  return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1282 }
1283
1284 #define vmg_svt_set_noop vmg_svt_default_noop
1285
1286 /* ... len magic ........................................................... */
1287
1288 STATIC U32 vmg_sv_len(pTHX_ SV *sv) {
1289 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1290  STRLEN len;
1291 #if VMG_HAS_PERL(5, 9, 3)
1292  const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1293 #else
1294  U8 *s = SvPV(sv, len);
1295 #endif
1296
1297  return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1298 }
1299
1300 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1301  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1302  unsigned int opinfo = w->opinfo;
1303  U32 len, ret;
1304  SV *svr;
1305  svtype t = SvTYPE(sv);
1306
1307  dSP;
1308
1309  ENTER;
1310  SAVETMPS;
1311
1312  PUSHMARK(SP);
1313  EXTEND(SP, 3);
1314  PUSHs(sv_2mortal(newRV_inc(sv)));
1315  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1316  if (t < SVt_PVAV) {
1317   len = vmg_sv_len(sv);
1318   mPUSHu(len);
1319  } else if (t == SVt_PVAV) {
1320   len = av_len((AV *) sv) + 1;
1321   mPUSHu(len);
1322  } else {
1323   len = 0;
1324   PUSHs(&PL_sv_undef);
1325  }
1326  if (opinfo)
1327   XPUSHs(vmg_op_info(opinfo));
1328  PUTBACK;
1329
1330  vmg_call_sv(w->cb_len, G_SCALAR, 0, NULL);
1331
1332  SPAGAIN;
1333  svr = POPs;
1334  ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1335  if (t == SVt_PVAV)
1336   --ret;
1337  PUTBACK;
1338
1339  FREETMPS;
1340  LEAVE;
1341
1342  return ret;
1343 }
1344
1345 STATIC U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1346  U32    len = 0;
1347  svtype t   = SvTYPE(sv);
1348
1349  if (t < SVt_PVAV) {
1350   len = vmg_sv_len(sv);
1351  } else if (t == SVt_PVAV) {
1352   len = (U32) av_len((AV *) sv);
1353  }
1354
1355  return len;
1356 }
1357
1358 /* ... clear magic ......................................................... */
1359
1360 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1361  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1362  unsigned int flags  = w->opinfo;
1363
1364 #if !VMG_HAS_PERL(5, 12, 0)
1365  flags |= VMG_CB_CALL_GUARD;
1366 #endif
1367
1368  return vmg_cb_call1(w->cb_clear, flags, sv, mg->mg_obj);
1369 }
1370
1371 #define vmg_svt_clear_noop vmg_svt_default_noop
1372
1373 /* ... free magic .......................................................... */
1374
1375 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1376
1377 STATIC OP *vmg_pp_propagate_errsv(pTHX) {
1378  SVOP *o = cSVOPx(PL_op);
1379
1380  if (o->op_sv) {
1381   SvREFCNT_dec(ERRSV);
1382   ERRSV    = o->op_sv;
1383   o->op_sv = NULL;
1384  }
1385
1386  return NORMAL;
1387 }
1388
1389 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1390
1391 STATIC int vmg_propagate_errsv_free(pTHX_ SV *sv, MAGIC *mg) {
1392  if (mg->mg_obj) {
1393   ERRSV         = mg->mg_obj;
1394   mg->mg_obj    = NULL;
1395   mg->mg_flags &= ~MGf_REFCOUNTED;
1396  }
1397
1398  return 0;
1399 }
1400
1401 /* perl is already kind enough to handle the cloning of the mg_obj member,
1402    hence we don't need to define a dup magic callback. */
1403
1404 STATIC MGVTBL vmg_propagate_errsv_vtbl = {
1405  0,                        /* get */
1406  0,                        /* set */
1407  0,                        /* len */
1408  0,                        /* clear */
1409  vmg_propagate_errsv_free, /* free */
1410  0,                        /* copy */
1411  0,                        /* dup */
1412 #if MGf_LOCAL
1413  0,                        /* local */
1414 #endif /* MGf_LOCAL */
1415 };
1416
1417 typedef struct {
1418  SV  *sv;
1419  int  in_eval;
1420  I32  base;
1421 } vmg_svt_free_cleanup_ud;
1422
1423 STATIC int vmg_svt_free_cleanup(pTHX_ void *ud_) {
1424  vmg_svt_free_cleanup_ud *ud = VOID2(vmg_svt_free_cleanup_ud *, ud_);
1425
1426  if (ud->in_eval) {
1427   U32 optype = PL_op ? PL_op->op_type : OP_NULL;
1428
1429   if (optype == OP_LEAVETRY || optype == OP_LEAVEEVAL) {
1430    SV *errsv = newSVsv(ERRSV);
1431
1432    FREETMPS;
1433    LEAVE_SCOPE(ud->base);
1434
1435 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1436    if (optype == OP_LEAVETRY) {
1437     dMY_CXT;
1438     PL_op = vmg_trampoline_bump(&MY_CXT.propagate_errsv, errsv, PL_op);
1439    } else if (optype == OP_LEAVEEVAL) {
1440     SV *guard = sv_newmortal();
1441     sv_magicext(guard, errsv, PERL_MAGIC_ext, &vmg_propagate_errsv_vtbl,
1442                               NULL, 0);
1443    }
1444 #else /* !VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1445 # if !VMG_HAS_PERL(5, 8, 9)
1446    {
1447     SV *guard = sv_newmortal();
1448     sv_magicext(guard, errsv, PERL_MAGIC_ext, &vmg_propagate_errsv_vtbl,
1449                               NULL, 0);
1450    }
1451 # else
1452    sv_magicext(ERRSV, errsv, PERL_MAGIC_ext, &vmg_propagate_errsv_vtbl,
1453                              NULL, 0);
1454    SvREFCNT_dec(errsv);
1455 # endif
1456 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1457
1458    SAVETMPS;
1459   }
1460
1461   /* Don't propagate */
1462   return 0;
1463  } else {
1464   SV    *sv = ud->sv;
1465   MAGIC *mg;
1466
1467   /* We are about to croak() while sv is being destroyed. Try to clean up
1468    * things a bit. */
1469   mg = SvMAGIC(sv);
1470   if (mg) {
1471    vmg_mg_del(sv, NULL, mg, mg->mg_moremagic);
1472    mg_magical(sv);
1473   }
1474   SvREFCNT_dec(sv);
1475
1476   vmg_dispell_guard_oncroak(aTHX_ NULL);
1477
1478   /* After that, propagate the error upwards. */
1479   return 1;
1480  }
1481 }
1482
1483 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1484  vmg_svt_free_cleanup_ud ud;
1485  const vmg_wizard *w;
1486  int ret = 0;
1487  SV *svr;
1488
1489  dSP;
1490
1491  /* During global destruction, we cannot be sure that the wizard and its free
1492   * callback are still alive. */
1493  if (PL_dirty)
1494   return 0;
1495
1496  w = vmg_wizard_from_mg_nocheck(mg);
1497
1498  /* So that it survives the temp cleanup below */
1499  SvREFCNT_inc_simple_void(sv);
1500
1501 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1502  /* The previous magic tokens were freed but the magic chain wasn't updated, so
1503   * if you access the sv from the callback the old deleted magics will trigger
1504   * and cause memory misreads. Change 32686 solved it that way : */
1505  SvMAGIC_set(sv, mg);
1506 #endif
1507
1508  ud.sv = sv;
1509  if (cxstack_ix < cxstack_max) {
1510   ud.in_eval = (CxTYPE(cxstack + cxstack_ix + 1) == CXt_EVAL);
1511   ud.base    = ud.in_eval ? PL_scopestack[PL_scopestack_ix] : 0;
1512  } else {
1513   ud.in_eval = 0;
1514   ud.base    = 0;
1515  }
1516
1517  ENTER;
1518  SAVETMPS;
1519
1520  PUSHMARK(SP);
1521  EXTEND(SP, 2);
1522  PUSHs(sv_2mortal(newRV_inc(sv)));
1523  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1524  if (w->opinfo)
1525   XPUSHs(vmg_op_info(w->opinfo));
1526  PUTBACK;
1527
1528  {
1529   dMY_CXT;
1530   MY_CXT.depth++;
1531   vmg_call_sv(w->cb_free, G_SCALAR, vmg_svt_free_cleanup, &ud);
1532   MY_CXT.depth--;
1533   if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1534    /* Free all the tokens in the chain but the current one (if it's present).
1535     * It will be taken care of by our caller, Perl_mg_free(). */
1536    vmg_magic_chain_free(MY_CXT.freed_tokens, mg);
1537    MY_CXT.freed_tokens = NULL;
1538   }
1539  }
1540
1541  SPAGAIN;
1542  svr = POPs;
1543  if (SvOK(svr))
1544   ret = (int) SvIV(svr);
1545  PUTBACK;
1546
1547  FREETMPS;
1548  LEAVE;
1549
1550  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1551   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1552  --SvREFCNT(sv);
1553
1554  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1555   * mg->mg_ptr reference count */
1556  return ret;
1557 }
1558
1559 #define vmg_svt_free_noop vmg_svt_default_noop
1560
1561 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1562 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1563 #else
1564 # define VMG_SVT_COPY_KEYLEN_TYPE int
1565 #endif
1566
1567 /* ... copy magic .......................................................... */
1568
1569 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1570  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1571  SV *keysv;
1572  int ret;
1573
1574  if (keylen == HEf_SVKEY) {
1575   keysv = (SV *) key;
1576  } else {
1577   keysv = newSVpvn(key, keylen);
1578  }
1579
1580  if (SvTYPE(sv) >= SVt_PVCV)
1581   nsv = sv_2mortal(newRV_inc(nsv));
1582
1583  ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1584
1585  if (keylen != HEf_SVKEY) {
1586   SvREFCNT_dec(keysv);
1587  }
1588
1589  return ret;
1590 }
1591
1592 STATIC int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1593  return 0;
1594 }
1595
1596 /* ... dup magic ........................................................... */
1597
1598 #if 0
1599 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1600  return 0;
1601 }
1602 #define vmg_svt_dup_noop vmg_svt_dup
1603 #endif
1604
1605 /* ... local magic ......................................................... */
1606
1607 #if MGf_LOCAL
1608
1609 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1610  const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1611
1612  return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1613 }
1614
1615 #define vmg_svt_local_noop vmg_svt_default_noop
1616
1617 #endif /* MGf_LOCAL */
1618
1619 /* ... uvar magic .......................................................... */
1620
1621 #if VMG_UVAR
1622
1623 STATIC OP *vmg_pp_reset_rmg(pTHX) {
1624  SVOP *o = cSVOPx(PL_op);
1625
1626  SvRMAGICAL_on(o->op_sv);
1627  o->op_sv = NULL;
1628
1629  return NORMAL;
1630 }
1631
1632 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1633  vmg_uvar_ud *ud;
1634  MAGIC *mg, *umg, *moremagic;
1635  SV *key = NULL, *newkey = NULL;
1636  int tied = 0;
1637
1638  umg = mg_find(sv, PERL_MAGIC_uvar);
1639  /* umg can't be NULL or we wouldn't be there. */
1640  key = umg->mg_obj;
1641  ud  = (vmg_uvar_ud *) umg->mg_ptr;
1642
1643  if (ud->old_uf.uf_val)
1644   ud->old_uf.uf_val(aTHX_ action, sv);
1645  if (ud->old_uf.uf_set)
1646   ud->old_uf.uf_set(aTHX_ action, sv);
1647
1648  for (mg = SvMAGIC(sv); mg; mg = moremagic) {
1649   const vmg_wizard *w;
1650
1651   /* mg may be freed later by the uvar call, so we need to fetch the next
1652    * token before reaching that fateful point. */
1653   moremagic = mg->mg_moremagic;
1654
1655   switch (mg->mg_type) {
1656    case PERL_MAGIC_ext:
1657     break;
1658    case PERL_MAGIC_tied:
1659     ++tied;
1660     continue;
1661    default:
1662     continue;
1663   }
1664
1665   w = vmg_wizard_from_mg(mg);
1666   if (!w)
1667    continue;
1668
1669   switch (w->uvar) {
1670    case 0:
1671     continue;
1672    case 2:
1673     if (!newkey)
1674      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1675   }
1676
1677   switch (action
1678              & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1679    case 0:
1680     if (w->cb_fetch)
1681      vmg_cb_call2(w->cb_fetch, w->opinfo | VMG_CB_CALL_GUARD, sv,
1682                                mg->mg_obj, key);
1683     break;
1684    case HV_FETCH_ISSTORE:
1685    case HV_FETCH_LVALUE:
1686    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1687     if (w->cb_store)
1688      vmg_cb_call2(w->cb_store, w->opinfo | VMG_CB_CALL_GUARD, sv,
1689                                mg->mg_obj, key);
1690     break;
1691    case HV_FETCH_ISEXISTS:
1692     if (w->cb_exists)
1693      vmg_cb_call2(w->cb_exists, w->opinfo | VMG_CB_CALL_GUARD, sv,
1694                                 mg->mg_obj, key);
1695     break;
1696    case HV_DELETE:
1697     if (w->cb_delete)
1698      vmg_cb_call2(w->cb_delete, w->opinfo | VMG_CB_CALL_GUARD, sv,
1699                                 mg->mg_obj, key);
1700     break;
1701   }
1702  }
1703
1704  if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1705   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1706    * mistaken for a tied hash by the rest of hv_common. It will be reset by
1707    * the op_ppaddr of a new fake op injected between the current and the next
1708    * one. */
1709
1710 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1711
1712   dMY_CXT;
1713
1714   PL_op = vmg_trampoline_bump(&MY_CXT.reset_rmg, sv, PL_op);
1715
1716 #else /* !VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1717
1718   OP   *nop  = PL_op->op_next;
1719   SVOP *svop = NULL;
1720
1721   if (nop && nop->op_ppaddr == vmg_pp_reset_rmg) {
1722    svop = (SVOP *) nop;
1723   } else {
1724    NewOp(1101, svop, 1, SVOP);
1725    svop->op_type    = OP_STUB;
1726    svop->op_ppaddr  = vmg_pp_reset_rmg;
1727    svop->op_next    = nop;
1728    svop->op_flags   = 0;
1729    svop->op_private = 0;
1730
1731    PL_op->op_next = (OP *) svop;
1732   }
1733
1734   svop->op_sv = sv;
1735
1736 #endif /* VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1737
1738   SvRMAGICAL_off(sv);
1739  }
1740
1741  return 0;
1742 }
1743
1744 #endif /* VMG_UVAR */
1745
1746 /* --- Macros for the XS section ------------------------------------------- */
1747
1748 #ifdef CvISXSUB
1749 # define VMG_CVOK(C) \
1750    ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
1751 #else
1752 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
1753 #endif
1754
1755 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
1756
1757 #define VMG_SET_CB(S, N) {       \
1758  SV *cb = (S);                   \
1759  if (SvOK(cb) && SvROK(cb)) {    \
1760   cb = SvRV(cb);                 \
1761   if (VMG_CBOK(cb))              \
1762    SvREFCNT_inc_simple_void(cb); \
1763   else                           \
1764    cb = NULL;                    \
1765  } else {                        \
1766   cb = NULL;                     \
1767  }                               \
1768  w->cb_ ## N = cb;               \
1769 }
1770
1771 #define VMG_SET_SVT_CB(S, N) {   \
1772  SV *cb = (S);                   \
1773  if (SvOK(cb) && SvROK(cb)) {    \
1774   cb = SvRV(cb);                 \
1775   if (VMG_CBOK(cb)) {            \
1776    t->svt_ ## N = vmg_svt_ ## N; \
1777    SvREFCNT_inc_simple_void(cb); \
1778   } else {                       \
1779    t->svt_ ## N = vmg_svt_ ## N ## _noop; \
1780    cb           = NULL;          \
1781   }                              \
1782  } else {                        \
1783   t->svt_ ## N = NULL;           \
1784   cb           = NULL;           \
1785  }                               \
1786  w->cb_ ## N = cb;               \
1787 }
1788
1789 /* --- XS ------------------------------------------------------------------ */
1790
1791 MODULE = Variable::Magic            PACKAGE = Variable::Magic
1792
1793 PROTOTYPES: ENABLE
1794
1795 BOOT:
1796 {
1797  HV *stash;
1798  int c;
1799
1800  MY_CXT_INIT;
1801  for (c = OPc_NULL; c < OPc_MAX; ++c)
1802   MY_CXT.b__op_stashes[c] = NULL;
1803
1804  MY_CXT.depth        = 0;
1805  MY_CXT.freed_tokens = NULL;
1806
1807  /* XS doesn't like a blank line here */
1808 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1809  vmg_trampoline_init(&MY_CXT.propagate_errsv, vmg_pp_propagate_errsv);
1810 #endif
1811 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1812  vmg_trampoline_init(&MY_CXT.reset_rmg, vmg_pp_reset_rmg);
1813 #endif
1814
1815  /* XS doesn't like a blank line here */
1816 #if VMG_THREADSAFE
1817  MUTEX_INIT(&vmg_vtable_refcount_mutex);
1818  MUTEX_INIT(&vmg_op_name_init_mutex);
1819 #endif
1820
1821  stash = gv_stashpv(__PACKAGE__, 1);
1822  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1823  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1824  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1825  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1826  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1827                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1828  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_NOLEN",
1829                     newSVuv(VMG_COMPAT_SCALAR_NOLEN));
1830  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1831                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1832  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1833                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1834  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1835                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1836  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1837                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1838  newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1839                     newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1840  newCONSTSUB(stash, "VMG_COMPAT_CODE_COPY_CLONE",
1841                     newSVuv(VMG_COMPAT_CODE_COPY_CLONE));
1842  newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1843  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1844  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1845  newCONSTSUB(stash, "VMG_FORKSAFE",        newSVuv(VMG_FORKSAFE));
1846  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1847  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1848 }
1849
1850 #if VMG_THREADSAFE
1851
1852 void
1853 CLONE(...)
1854 PROTOTYPE: DISABLE
1855 PREINIT:
1856  U32 had_b__op_stash = 0;
1857  I32 old_depth;
1858  int c;
1859 PPCODE:
1860  {
1861   dMY_CXT;
1862   for (c = OPc_NULL; c < OPc_MAX; ++c) {
1863    if (MY_CXT.b__op_stashes[c])
1864     had_b__op_stash |= (((U32) 1) << c);
1865   }
1866   old_depth = MY_CXT.depth;
1867  }
1868  {
1869   MY_CXT_CLONE;
1870   for (c = OPc_NULL; c < OPc_MAX; ++c) {
1871    MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1872                               ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1873   }
1874   MY_CXT.depth        = old_depth;
1875   MY_CXT.freed_tokens = NULL;
1876  }
1877  XSRETURN(0);
1878
1879 #endif /* VMG_THREADSAFE */
1880
1881 SV *_wizard(...)
1882 PROTOTYPE: DISABLE
1883 PREINIT:
1884  vmg_wizard *w;
1885  MGVTBL *t;
1886  SV *op_info, *copy_key;
1887  I32 i = 0;
1888 CODE:
1889  if (items != 9
1890 #if MGf_LOCAL
1891               + 1
1892 #endif /* MGf_LOCAL */
1893 #if VMG_UVAR
1894               + 5
1895 #endif /* VMG_UVAR */
1896               ) { croak(vmg_wrongargnum); }
1897
1898  op_info = ST(i++);
1899  w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
1900  t = vmg_vtable_vtbl(w->vtable);
1901
1902  VMG_SET_CB(ST(i++), data);
1903
1904  VMG_SET_SVT_CB(ST(i++), get);
1905  VMG_SET_SVT_CB(ST(i++), set);
1906  VMG_SET_SVT_CB(ST(i++), len);
1907  VMG_SET_SVT_CB(ST(i++), clear);
1908  VMG_SET_SVT_CB(ST(i++), free);
1909  VMG_SET_SVT_CB(ST(i++), copy);
1910  /* VMG_SET_SVT_CB(ST(i++), dup); */
1911  i++;
1912  t->svt_dup = NULL;
1913  w->cb_dup  = NULL;
1914 #if MGf_LOCAL
1915  VMG_SET_SVT_CB(ST(i++), local);
1916 #endif /* MGf_LOCAL */
1917 #if VMG_UVAR
1918  VMG_SET_CB(ST(i++), fetch);
1919  VMG_SET_CB(ST(i++), store);
1920  VMG_SET_CB(ST(i++), exists);
1921  VMG_SET_CB(ST(i++), delete);
1922
1923  copy_key = ST(i++);
1924  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1925   w->uvar = SvTRUE(copy_key) ? 2 : 1;
1926 #endif /* VMG_UVAR */
1927
1928  RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
1929 OUTPUT:
1930  RETVAL
1931
1932 SV *cast(SV *sv, SV *wiz, ...)
1933 PROTOTYPE: \[$@%&*]$@
1934 PREINIT:
1935  const vmg_wizard *w = NULL;
1936  SV **args = NULL;
1937  I32 i = 0;
1938 CODE:
1939  if (items > 2) {
1940   i = items - 2;
1941   args = &ST(2);
1942  }
1943  if (SvROK(wiz)) {
1944   wiz = SvRV_const(wiz);
1945   w   = vmg_wizard_from_sv(wiz);
1946  }
1947  if (!w)
1948   croak(vmg_invalid_wiz);
1949  RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
1950 OUTPUT:
1951  RETVAL
1952
1953 void
1954 getdata(SV *sv, SV *wiz)
1955 PROTOTYPE: \[$@%&*]$
1956 PREINIT:
1957  const vmg_wizard *w = NULL;
1958  SV *data;
1959 PPCODE:
1960  if (SvROK(wiz))
1961   w = vmg_wizard_from_sv(SvRV_const(wiz));
1962  if (!w)
1963   croak(vmg_invalid_wiz);
1964  data = vmg_data_get(SvRV(sv), w);
1965  if (!data)
1966   XSRETURN_EMPTY;
1967  ST(0) = data;
1968  XSRETURN(1);
1969
1970 SV *dispell(SV *sv, SV *wiz)
1971 PROTOTYPE: \[$@%&*]$
1972 PREINIT:
1973  const vmg_wizard *w = NULL;
1974 CODE:
1975  if (SvROK(wiz))
1976   w = vmg_wizard_from_sv(SvRV_const(wiz));
1977  if (!w)
1978   croak(vmg_invalid_wiz);
1979  RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));
1980 OUTPUT:
1981  RETVAL