1 /* This file is part of the Variable::Magic Perl module.
2 * See http://search.cpan.org/dist/Variable-Magic/ */
4 #include <stdarg.h> /* <va_list>, va_{start,arg,end}, ... */
6 #include <stdio.h> /* sprintf() */
8 #define PERL_NO_GET_CONTEXT
13 #define __PACKAGE__ "Variable::Magic"
17 # define VOID2(T, P) static_cast<T>(P)
19 # define VOID2(T, P) (P)
22 #ifndef VMG_PERL_PATCHLEVEL
24 # define VMG_PERL_PATCHLEVEL PERL_PATCHNUM
26 # define VMG_PERL_PATCHLEVEL 0
30 #define VMG_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
32 #define VMG_HAS_PERL_BRANCH(R, V, S) (PERL_REVISION == (R) && PERL_VERSION == (V) && PERL_SUBVERSION >= (S))
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))))
36 /* --- Threads and multiplicity -------------------------------------------- */
46 /* Safe unless stated otherwise in Makefile.PL */
48 # define VMG_FORKSAFE 1
51 #ifndef VMG_MULTIPLICITY
52 # if defined(MULTIPLICITY)
53 # define VMG_MULTIPLICITY 1
55 # define VMG_MULTIPLICITY 0
59 # ifndef PERL_IMPLICIT_CONTEXT
60 # error MULTIPLICITY builds must set PERL_IMPLICIT_CONTEXT
64 #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))
65 # ifndef VMG_THREADSAFE
66 # define VMG_THREADSAFE 1
69 # define MY_CXT_CLONE \
71 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
72 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
73 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
76 # undef VMG_THREADSAFE
77 # define VMG_THREADSAFE 0
79 # define dMY_CXT dNOOP
81 # define MY_CXT vmg_globaldata
83 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
85 # define MY_CXT_INIT NOOP
87 # define MY_CXT_CLONE NOOP
91 # define VMG_LOCK(M) MUTEX_LOCK(M)
92 # define VMG_UNLOCK(M) MUTEX_UNLOCK(M)
95 # define VMG_UNLOCK(M)
98 /* --- Compatibility ------------------------------------------------------- */
101 # define Newx(v, n, c) New(0, v, n, c)
105 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
109 # define SvRV_const(sv) SvRV((SV *) sv)
112 #ifndef SvREFCNT_inc_simple_void
113 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
117 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
120 #ifndef PERL_MAGIC_ext
121 # define PERL_MAGIC_ext '~'
124 #ifndef PERL_MAGIC_tied
125 # define PERL_MAGIC_tied 'P'
132 #ifndef IN_PERL_COMPILETIME
133 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
136 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but we only
137 * enable them on 5.10 */
138 #if VMG_HAS_PERL(5, 10, 0)
144 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969) || VMG_HAS_PERL(5, 12, 0)
145 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
147 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
150 #if VMG_HAS_PERL(5, 17, 4)
151 # define VMG_COMPAT_SCALAR_NOLEN 1
153 # define VMG_COMPAT_SCALAR_NOLEN 0
156 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
157 * reverted to dev-5.11 as 9cdcb38b */
158 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
159 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
160 # if VMG_HAS_PERL(5, 11, 0)
161 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
163 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
166 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
167 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
170 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
171 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
173 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
174 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
178 /* Applied to dev-5.11 as 34908 */
179 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908) || VMG_HAS_PERL(5, 12, 0)
180 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
182 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
185 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
186 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
187 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
189 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
192 #if VMG_HAS_PERL(5, 11, 0)
193 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 1
195 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 0
198 #if VMG_HAS_PERL(5, 17, 0)
199 # define VMG_COMPAT_CODE_COPY_CLONE 1
201 # define VMG_COMPAT_CODE_COPY_CLONE 0
204 #if VMG_HAS_PERL(5, 13, 2)
205 # define VMG_COMPAT_GLOB_GET 1
207 # define VMG_COMPAT_GLOB_GET 0
210 #define VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE (VMG_HAS_PERL(5, 10, 0) && !VMG_HAS_PERL(5, 10, 1))
212 /* NewOp() isn't public in perl 5.8.0. */
213 #define VMG_RESET_RMG_NEEDS_TRAMPOLINE (VMG_UVAR && (VMG_THREADSAFE || !VMG_HAS_PERL(5, 8, 1)))
215 /* ... Bug-free mg_magical ................................................. */
217 /* See the discussion at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html */
219 #if VMG_HAS_PERL(5, 11, 3)
221 #define vmg_mg_magical(S) mg_magical(S)
225 static void vmg_mg_magical(SV *sv) {
229 if ((mg = SvMAGIC(sv))) {
231 const MGVTBL* const vtbl = mg->mg_virtual;
233 if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
240 } while ((mg = mg->mg_moremagic));
241 if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
248 /* --- Trampoline ops ------------------------------------------------------ */
250 #define VMG_NEEDS_TRAMPOLINE VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE || VMG_RESET_RMG_NEEDS_TRAMPOLINE
252 #if VMG_NEEDS_TRAMPOLINE
259 static void vmg_trampoline_init(vmg_trampoline *t, OP *(*cb)(pTHX)) {
260 t->temp.op_type = OP_STUB;
261 t->temp.op_ppaddr = 0;
262 t->temp.op_next = (OP *) &t->target;
263 t->temp.op_flags = 0;
264 t->temp.op_private = 0;
266 t->target.op_type = OP_STUB;
267 t->target.op_ppaddr = cb;
268 t->target.op_next = NULL;
269 t->target.op_flags = 0;
270 t->target.op_private = 0;
271 t->target.op_sv = NULL;
274 static OP *vmg_trampoline_bump(pTHX_ vmg_trampoline *t, SV *sv, OP *o) {
275 #define vmg_trampoline_bump(T, S, O) vmg_trampoline_bump(aTHX_ (T), (S), (O))
277 t->temp.op_next = (OP *) &t->target;
279 t->target.op_sv = sv;
280 t->target.op_next = o->op_next;
285 #endif /* VMG_NEEDS_TRAMPOLINE */
287 /* --- Cleaner version of sv_magicext() ------------------------------------ */
289 static MAGIC *vmg_sv_magicext(pTHX_ SV *sv, SV *obj, const MGVTBL *vtbl, const void *ptr, I32 len) {
290 #define vmg_sv_magicext(S, O, V, P, L) vmg_sv_magicext(aTHX_ (S), (O), (V), (P), (L))
293 mg = sv_magicext(sv, obj, PERL_MAGIC_ext, vtbl, ptr, len);
300 mg->mg_flags |= MGf_COPY;
303 mg->mg_flags |= MGf_DUP;
307 mg->mg_flags |= MGf_LOCAL;
308 #endif /* MGf_LOCAL */
310 if (mg->mg_flags & MGf_REFCOUNTED)
316 /* --- Safe version of call_sv() ------------------------------------------- */
318 static I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, int (*cleanup)(pTHX_ void *), void *ud) {
319 #define vmg_call_sv(S, F, C, U) vmg_call_sv(aTHX_ (S), (F), (C), (U))
321 PERL_CONTEXT saved_cx;
325 old_err = newSVsv(ERRSV);
326 sv_setsv(ERRSV, &PL_sv_undef);
329 cxix = (cxstack_ix < cxstack_max) ? (cxstack_ix + 1) : Perl_cxinc(aTHX);
330 /* The last popped context will be reused by call_sv(), but our callers may
331 * still need its previous value. Back it up so that it isn't clobbered. */
332 saved_cx = cxstack[cxix];
334 ret = call_sv(sv, flags | G_EVAL);
336 cxstack[cxix] = saved_cx;
339 SvREFCNT_dec(old_err);
341 if (IN_PERL_COMPILETIME) {
344 sv_catsv(PL_errors, ERRSV);
346 Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
349 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
351 ++PL_parser->error_count;
352 #elif defined(PL_error_count)
358 if (!cleanup || cleanup(aTHX_ ud))
363 sv_setsv(ERRSV, old_err);
364 SvREFCNT_dec(old_err);
371 /* --- Stolen chunk of B --------------------------------------------------- */
386 #if VMG_HAS_PERL(5, 21, 5)
392 static const char *const vmg_opclassnames[] = {
405 #if VMG_HAS_PERL(5, 21, 5)
411 static opclass vmg_opclass(const OP *o) {
418 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
420 if (o->op_type == OP_SASSIGN)
421 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
423 if (o->op_type == OP_AELEMFAST) {
424 #if PERL_VERSION <= 14
425 if (o->op_flags & OPf_SPECIAL)
437 if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
441 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
458 case OA_PVOP_OR_SVOP:
459 return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
464 case OA_BASEOP_OR_UNOP:
465 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
467 return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
469 (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
471 (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
474 if (o->op_flags & OPf_STACKED)
476 else if (o->op_flags & OPf_SPECIAL)
480 #if VMG_HAS_PERL(5, 21, 5)
489 /* --- Error messages ------------------------------------------------------ */
491 static const char vmg_invalid_wiz[] = "Invalid wizard object";
492 static const char vmg_wrongargnum[] = "Wrong number of arguments";
493 static const char vmg_argstorefailed[] = "Error while storing arguments";
495 /* --- Context-safe global data -------------------------------------------- */
497 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
500 HV *b__op_stashes[OPc_MAX];
503 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
504 vmg_trampoline propagate_errsv;
506 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
507 vmg_trampoline reset_rmg;
513 /* --- <vmg_vtable> structure ---------------------------------------------- */
522 static vmg_vtable *vmg_vtable_alloc(pTHX) {
523 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
526 t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
528 t->vtbl = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
534 #define vmg_vtable_vtbl(T) (T)->vtbl
536 static perl_mutex vmg_vtable_refcount_mutex;
538 static vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
539 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
540 VMG_LOCK(&vmg_vtable_refcount_mutex);
542 VMG_UNLOCK(&vmg_vtable_refcount_mutex);
547 static void vmg_vtable_free(pTHX_ vmg_vtable *t) {
548 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
551 VMG_LOCK(&vmg_vtable_refcount_mutex);
552 refcount = --t->refcount;
553 VMG_UNLOCK(&vmg_vtable_refcount_mutex);
556 PerlMemShared_free(t->vtbl);
557 PerlMemShared_free(t);
561 #else /* VMG_THREADSAFE */
563 typedef MGVTBL vmg_vtable;
565 static vmg_vtable *vmg_vtable_alloc(pTHX) {
566 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
569 Newx(t, 1, vmg_vtable);
574 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
576 #define vmg_vtable_free(T) Safefree(T)
578 #endif /* !VMG_THREADSAFE */
580 /* --- <vmg_wizard> structure ---------------------------------------------- */
589 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
594 #endif /* MGf_LOCAL */
596 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
597 #endif /* VMG_UVAR */
600 static void vmg_op_info_init(pTHX_ unsigned int opinfo);
602 static vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
603 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
606 Newx(w, 1, vmg_wizard);
609 w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
611 vmg_op_info_init(aTHX_ w->opinfo);
613 w->vtable = vmg_vtable_alloc();
618 static void vmg_wizard_free(pTHX_ vmg_wizard *w) {
619 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
623 /* During global destruction, any of the callbacks may already have been
624 * freed, so we can't rely on still being able to access them. */
626 SvREFCNT_dec(w->cb_data);
627 SvREFCNT_dec(w->cb_get);
628 SvREFCNT_dec(w->cb_set);
629 SvREFCNT_dec(w->cb_len);
630 SvREFCNT_dec(w->cb_clear);
631 SvREFCNT_dec(w->cb_free);
632 SvREFCNT_dec(w->cb_copy);
634 SvREFCNT_dec(w->cb_dup);
637 SvREFCNT_dec(w->cb_local);
638 #endif /* MGf_LOCAL */
640 SvREFCNT_dec(w->cb_fetch);
641 SvREFCNT_dec(w->cb_store);
642 SvREFCNT_dec(w->cb_exists);
643 SvREFCNT_dec(w->cb_delete);
644 #endif /* VMG_UVAR */
647 /* PerlMemShared_free() and Safefree() are still fine during global
648 * destruction though. */
649 vmg_vtable_free(w->vtable);
657 #define VMG_CLONE_CB(N) \
658 z->cb_ ## N = (w->cb_ ## N) ? SvREFCNT_inc(sv_dup(w->cb_ ## N, params)) \
661 static const vmg_wizard *vmg_wizard_dup(pTHX_ const vmg_wizard *w, CLONE_PARAMS *params) {
662 #define vmg_wizard_dup(W, P) vmg_wizard_dup(aTHX_ (W), (P))
668 Newx(z, 1, vmg_wizard);
670 z->vtable = vmg_vtable_dup(w->vtable);
672 z->opinfo = w->opinfo;
684 #endif /* MGf_LOCAL */
688 VMG_CLONE_CB(exists);
689 VMG_CLONE_CB(delete);
690 #endif /* VMG_UVAR */
695 #endif /* VMG_THREADSAFE */
697 #define vmg_wizard_id(W) PTR2IV(vmg_vtable_vtbl((W)->vtable))
699 /* --- Wizard SV objects --------------------------------------------------- */
701 static int vmg_wizard_sv_free(pTHX_ SV *sv, MAGIC *mg) {
702 vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
709 static int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
710 mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
715 #endif /* VMG_THREADSAFE */
717 static MGVTBL vmg_wizard_sv_vtbl = {
722 vmg_wizard_sv_free, /* free */
725 vmg_wizard_sv_dup, /* dup */
731 #endif /* MGf_LOCAL */
734 static SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
735 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
741 wiz = newSViv(PTR2IV(w));
744 vmg_sv_magicext(wiz, NULL, &vmg_wizard_sv_vtbl, w, 0);
753 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
755 static const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
758 for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
759 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
760 return (const vmg_wizard *) mg->mg_ptr;
766 #else /* VMG_THREADSAFE */
768 #define vmg_sv_has_wizard_type(S) SvIOK(S)
770 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
772 #endif /* !VMG_THREADSAFE */
774 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
776 static const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
777 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
778 SV *sv = (SV *) mg->mg_ptr;
780 if (vmg_sv_has_wizard_type(sv))
781 return vmg_wizard_from_sv_nocheck(sv);
787 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
789 /* --- User-level functions implementation --------------------------------- */
791 static const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
795 if (SvTYPE(sv) < SVt_PVMG)
798 wid = vmg_wizard_id(w);
800 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
801 const vmg_wizard *z = vmg_wizard_from_mg(mg);
803 if (z && vmg_wizard_id(z) == wid)
810 /* ... Construct private data .............................................. */
812 static SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
813 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
823 EXTEND(SP, items + 1);
824 PUSHs(sv_2mortal(newRV_inc(sv)));
825 for (i = 0; i < items; ++i)
829 vmg_call_sv(ctor, G_SCALAR, 0, NULL);
833 #if VMG_HAS_PERL(5, 8, 3)
834 SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
836 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
846 static SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
847 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
848 const MAGIC *mg = vmg_find(sv, w);
850 return mg ? mg->mg_obj : NULL;
853 /* ... Magic cast/dispell .................................................. */
857 static I32 vmg_svt_val(pTHX_ IV, SV *);
860 struct ufuncs new_uf;
861 struct ufuncs old_uf;
864 #endif /* VMG_UVAR */
866 static void vmg_mg_del(pTHX_ SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
867 #define vmg_mg_del(S, P, M, N) vmg_mg_del(aTHX_ (S), (P), (M), (N))
871 prevmagic->mg_moremagic = moremagic;
873 SvMAGIC_set(sv, moremagic);
875 /* Destroy private data */
877 if (mg->mg_type == PERL_MAGIC_uvar) {
878 Safefree(mg->mg_ptr);
880 #endif /* VMG_UVAR */
881 if (mg->mg_obj != sv) {
882 SvREFCNT_dec(mg->mg_obj);
885 /* Unreference the wizard */
886 SvREFCNT_dec((SV *) mg->mg_ptr);
890 #endif /* VMG_UVAR */
893 mg->mg_moremagic = MY_CXT.freed_tokens;
894 MY_CXT.freed_tokens = mg;
896 mg->mg_moremagic = NULL;
901 static int vmg_magic_chain_free(pTHX_ MAGIC *mg, MAGIC *skip) {
902 #define vmg_magic_chain_free(M, S) vmg_magic_chain_free(aTHX_ (M), (S))
906 MAGIC *moremagic = mg->mg_moremagic;
919 static UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
920 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
929 oldgmg = SvGMAGICAL(sv);
931 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
933 t = vmg_vtable_vtbl(w->vtable);
934 mg = vmg_sv_magicext(sv, data, t, wiz, HEf_SVKEY);
936 if (SvTYPE(sv) < SVt_PVHV)
939 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
940 * magic is actually never called for them. If the GMAGICAL flag was off before
941 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
942 * now on, then this wizard has get magic. Hence we can work around the
943 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
944 * has uvar callbacks, it will be turned back on later. */
945 if (!oldgmg && SvGMAGICAL(sv))
950 MAGIC *prevmagic, *moremagic = NULL;
953 ud.new_uf.uf_val = vmg_svt_val;
954 ud.new_uf.uf_set = NULL;
955 ud.new_uf.uf_index = 0;
956 ud.old_uf.uf_val = NULL;
957 ud.old_uf.uf_set = NULL;
958 ud.old_uf.uf_index = 0;
960 /* One uvar magic in the chain is enough. */
961 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
962 moremagic = mg->mg_moremagic;
963 if (mg->mg_type == PERL_MAGIC_uvar)
967 if (mg) { /* Found another uvar magic. */
968 struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
969 if (uf->uf_val == vmg_svt_val) {
970 /* It's our uvar magic, nothing to do. oldgmg was true. */
973 /* It's another uvar magic, backup it and replace it by ours. */
975 vmg_mg_del(sv, prevmagic, mg, moremagic);
979 sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
981 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
982 * handled by our uvar callback. */
984 #endif /* VMG_UVAR */
990 static UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
991 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
994 #endif /* VMG_UVAR */
995 MAGIC *mg, *prevmagic, *moremagic = NULL;
996 IV wid = vmg_wizard_id(w);
998 if (SvTYPE(sv) < SVt_PVMG)
1001 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
1002 const vmg_wizard *z;
1004 moremagic = mg->mg_moremagic;
1006 z = vmg_wizard_from_mg(mg);
1008 IV zid = vmg_wizard_id(z);
1012 /* If the current has no uvar, short-circuit uvar deletion. */
1013 uvars = z->uvar ? (uvars + 1) : 0;
1015 } else if (z->uvar) {
1017 /* We can't break here since we need to find the ext magic to delete. */
1019 #else /* VMG_UVAR */
1022 #endif /* !VMG_UVAR */
1028 vmg_mg_del(sv, prevmagic, mg, moremagic);
1031 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
1032 /* mg was the first ext magic in the chain that had uvar */
1034 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
1035 const vmg_wizard *z = vmg_wizard_from_mg(mg);
1046 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
1047 moremagic = mg->mg_moremagic;
1048 if (mg->mg_type == PERL_MAGIC_uvar)
1052 ud = (vmg_uvar_ud *) mg->mg_ptr;
1053 if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
1054 /* Revert the original uvar magic. */
1056 Newx(uf, 1, struct ufuncs);
1059 mg->mg_ptr = (char *) uf;
1060 mg->mg_len = sizeof(*uf);
1062 /* Remove the uvar magic. */
1063 vmg_mg_del(sv, prevmagic, mg, moremagic);
1067 #endif /* VMG_UVAR */
1074 /* ... OP info ............................................................. */
1076 #define VMG_OP_INFO_NAME 1
1077 #define VMG_OP_INFO_OBJECT 2
1080 static perl_mutex vmg_op_name_init_mutex;
1083 static U32 vmg_op_name_init = 0;
1084 static unsigned char vmg_op_name_len[MAXO] = { 0 };
1086 static void vmg_op_info_init(pTHX_ unsigned int opinfo) {
1087 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
1089 case VMG_OP_INFO_NAME:
1090 VMG_LOCK(&vmg_op_name_init_mutex);
1091 if (!vmg_op_name_init) {
1093 for (t = 0; t < OP_max; ++t)
1094 vmg_op_name_len[t] = strlen(PL_op_name[t]);
1095 vmg_op_name_init = 1;
1097 VMG_UNLOCK(&vmg_op_name_init_mutex);
1099 case VMG_OP_INFO_OBJECT: {
1101 if (!MY_CXT.b__op_stashes[0]) {
1104 for (c = OPc_NULL; c < OPc_MAX; ++c)
1105 MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1114 static SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1115 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1117 return &PL_sv_undef;
1120 case VMG_OP_INFO_NAME: {
1121 OPCODE t = PL_op->op_type;
1122 return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1124 case VMG_OP_INFO_OBJECT: {
1126 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1127 MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1133 return &PL_sv_undef;
1136 /* --- svt callbacks ------------------------------------------------------- */
1138 #define VMG_CB_CALL_ARGS_MASK 15
1139 #define VMG_CB_CALL_ARGS_SHIFT 4
1140 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT) /* 1|2 */
1141 #define VMG_CB_CALL_GUARD 4
1143 static int vmg_dispell_guard_oncroak(pTHX_ void *ud) {
1148 /* If we're at the upmost magic call and we're about to die, we can just free
1149 * the tokens right now, since we will jump past the problematic part of our
1151 if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1152 vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1153 MY_CXT.freed_tokens = NULL;
1159 static int vmg_dispell_guard_free(pTHX_ SV *sv, MAGIC *mg) {
1160 vmg_magic_chain_free((MAGIC *) mg->mg_ptr, NULL);
1167 static int vmg_dispell_guard_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
1168 /* The freed magic tokens aren't cloned by perl because it cannot reach them
1169 * (they have been detached from their parent SV when they were enqueued).
1170 * Hence there's nothing to purge in the new thread. */
1176 #endif /* VMG_THREADSAFE */
1178 static MGVTBL vmg_dispell_guard_vtbl = {
1183 vmg_dispell_guard_free, /* free */
1186 vmg_dispell_guard_dup, /* dup */
1192 #endif /* MGf_LOCAL */
1195 static SV *vmg_dispell_guard_new(pTHX_ MAGIC *root) {
1196 #define vmg_dispell_guard_new(R) vmg_dispell_guard_new(aTHX_ (R))
1199 guard = sv_newmortal();
1200 vmg_sv_magicext(guard, NULL, &vmg_dispell_guard_vtbl, root, 0);
1205 static int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1208 unsigned int i, args, opinfo;
1209 MAGIC **chain = NULL;
1214 args = flags & VMG_CB_CALL_ARGS_MASK;
1215 flags >>= VMG_CB_CALL_ARGS_SHIFT;
1216 opinfo = flags & VMG_CB_CALL_OPINFO;
1222 EXTEND(SP, args + 1);
1223 PUSHs(sv_2mortal(newRV_inc(sv)));
1225 for (i = 0; i < args; ++i) {
1226 SV *sva = va_arg(ap, SV *);
1227 PUSHs(sva ? sva : &PL_sv_undef);
1231 XPUSHs(vmg_op_info(opinfo));
1234 if (flags & VMG_CB_CALL_GUARD) {
1237 vmg_call_sv(cb, G_SCALAR, vmg_dispell_guard_oncroak, NULL);
1239 if (MY_CXT.depth == 0 && MY_CXT.freed_tokens)
1240 chain = &MY_CXT.freed_tokens;
1242 vmg_call_sv(cb, G_SCALAR, 0, NULL);
1248 ret = (int) SvIV(svr);
1258 if (svr && !SvTEMP(svr))
1262 vmg_dispell_guard_new(*chain);
1269 #define VMG_CB_FLAGS(OI, A) \
1270 ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1272 #define vmg_cb_call1(I, OI, S, A1) \
1273 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1274 #define vmg_cb_call2(I, OI, S, A1, A2) \
1275 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1276 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1277 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1279 /* ... Default no-op magic callback ........................................ */
1281 static int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1285 /* ... get magic ........................................................... */
1287 static int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1288 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1290 return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1293 #define vmg_svt_get_noop vmg_svt_default_noop
1295 /* ... set magic ........................................................... */
1297 static int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1298 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1300 return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1303 #define vmg_svt_set_noop vmg_svt_default_noop
1305 /* ... len magic ........................................................... */
1307 static U32 vmg_sv_len(pTHX_ SV *sv) {
1308 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1310 #if VMG_HAS_PERL(5, 9, 3)
1311 const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1313 U8 *s = SvPV(sv, len);
1316 return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1319 static U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1320 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1321 unsigned int opinfo = w->opinfo;
1324 svtype t = SvTYPE(sv);
1333 PUSHs(sv_2mortal(newRV_inc(sv)));
1334 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1336 len = vmg_sv_len(sv);
1338 } else if (t == SVt_PVAV) {
1339 len = av_len((AV *) sv) + 1;
1343 PUSHs(&PL_sv_undef);
1346 XPUSHs(vmg_op_info(opinfo));
1349 vmg_call_sv(w->cb_len, G_SCALAR, 0, NULL);
1353 ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1364 static U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1366 svtype t = SvTYPE(sv);
1369 len = vmg_sv_len(sv);
1370 } else if (t == SVt_PVAV) {
1371 len = (U32) av_len((AV *) sv);
1377 /* ... clear magic ......................................................... */
1379 static int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1380 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1381 unsigned int flags = w->opinfo;
1383 #if !VMG_HAS_PERL(5, 12, 0)
1384 flags |= VMG_CB_CALL_GUARD;
1387 return vmg_cb_call1(w->cb_clear, flags, sv, mg->mg_obj);
1390 #define vmg_svt_clear_noop vmg_svt_default_noop
1392 /* ... free magic .......................................................... */
1394 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1396 static OP *vmg_pp_propagate_errsv(pTHX) {
1397 SVOP *o = cSVOPx(PL_op);
1400 sv_setsv(ERRSV, o->op_sv);
1401 SvREFCNT_dec(o->op_sv);
1408 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1410 static int vmg_propagate_errsv_free(pTHX_ SV *sv, MAGIC *mg) {
1412 sv_setsv(ERRSV, mg->mg_obj);
1417 /* perl is already kind enough to handle the cloning of the mg_obj member,
1418 hence we don't need to define a dup magic callback. */
1420 static MGVTBL vmg_propagate_errsv_vtbl = {
1425 vmg_propagate_errsv_free, /* free */
1430 #endif /* MGf_LOCAL */
1437 } vmg_svt_free_cleanup_ud;
1439 static int vmg_svt_free_cleanup(pTHX_ void *ud_) {
1440 vmg_svt_free_cleanup_ud *ud = VOID2(vmg_svt_free_cleanup_ud *, ud_);
1443 U32 optype = PL_op ? PL_op->op_type : OP_NULL;
1445 if (optype == OP_LEAVETRY || optype == OP_LEAVEEVAL) {
1446 SV *errsv = newSVsv(ERRSV);
1449 LEAVE_SCOPE(ud->base);
1451 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1452 if (optype == OP_LEAVETRY) {
1454 PL_op = vmg_trampoline_bump(&MY_CXT.propagate_errsv, errsv, PL_op);
1455 } else if (optype == OP_LEAVEEVAL) {
1456 SV *guard = sv_newmortal();
1457 vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1459 #else /* !VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1460 # if !VMG_HAS_PERL(5, 8, 9)
1462 SV *guard = sv_newmortal();
1463 vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1466 vmg_sv_magicext(ERRSV, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1468 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1473 /* Don't propagate */
1479 /* We are about to croak() while sv is being destroyed. Try to clean up
1483 vmg_mg_del(sv, NULL, mg, mg->mg_moremagic);
1488 vmg_dispell_guard_oncroak(aTHX_ NULL);
1490 /* After that, propagate the error upwards. */
1495 static int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1496 vmg_svt_free_cleanup_ud ud;
1497 const vmg_wizard *w;
1503 /* During global destruction, we cannot be sure that the wizard and its free
1504 * callback are still alive. */
1508 w = vmg_wizard_from_mg_nocheck(mg);
1510 /* So that it survives the temp cleanup below */
1511 SvREFCNT_inc_simple_void(sv);
1513 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1514 /* The previous magic tokens were freed but the magic chain wasn't updated, so
1515 * if you access the sv from the callback the old deleted magics will trigger
1516 * and cause memory misreads. Change 32686 solved it that way : */
1517 SvMAGIC_set(sv, mg);
1521 if (cxstack_ix < cxstack_max) {
1522 ud.in_eval = (CxTYPE(cxstack + cxstack_ix + 1) == CXt_EVAL);
1523 ud.base = ud.in_eval ? PL_scopestack[PL_scopestack_ix] : 0;
1534 PUSHs(sv_2mortal(newRV_inc(sv)));
1535 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1537 XPUSHs(vmg_op_info(w->opinfo));
1543 vmg_call_sv(w->cb_free, G_SCALAR, vmg_svt_free_cleanup, &ud);
1545 if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1546 /* Free all the tokens in the chain but the current one (if it's present).
1547 * It will be taken care of by our caller, Perl_mg_free(). */
1548 vmg_magic_chain_free(MY_CXT.freed_tokens, mg);
1549 MY_CXT.freed_tokens = NULL;
1556 ret = (int) SvIV(svr);
1562 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1563 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1566 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1567 * mg->mg_ptr reference count */
1571 #define vmg_svt_free_noop vmg_svt_default_noop
1573 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1574 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1576 # define VMG_SVT_COPY_KEYLEN_TYPE int
1579 /* ... copy magic .......................................................... */
1581 static int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1582 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1586 if (keylen == HEf_SVKEY) {
1589 keysv = newSVpvn(key, keylen);
1592 if (SvTYPE(sv) >= SVt_PVCV)
1593 nsv = sv_2mortal(newRV_inc(nsv));
1595 ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1597 if (keylen != HEf_SVKEY) {
1598 SvREFCNT_dec(keysv);
1604 static int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1608 /* ... dup magic ........................................................... */
1611 static int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1614 #define vmg_svt_dup_noop vmg_svt_dup
1617 /* ... local magic ......................................................... */
1621 static int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1622 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1624 return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1627 #define vmg_svt_local_noop vmg_svt_default_noop
1629 #endif /* MGf_LOCAL */
1631 /* ... uvar magic .......................................................... */
1635 static OP *vmg_pp_reset_rmg(pTHX) {
1636 SVOP *o = cSVOPx(PL_op);
1638 SvRMAGICAL_on(o->op_sv);
1644 static I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1646 MAGIC *mg, *umg, *moremagic;
1647 SV *key = NULL, *newkey = NULL;
1650 umg = mg_find(sv, PERL_MAGIC_uvar);
1651 /* umg can't be NULL or we wouldn't be there. */
1653 ud = (vmg_uvar_ud *) umg->mg_ptr;
1655 if (ud->old_uf.uf_val)
1656 ud->old_uf.uf_val(aTHX_ action, sv);
1657 if (ud->old_uf.uf_set)
1658 ud->old_uf.uf_set(aTHX_ action, sv);
1660 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
1661 const vmg_wizard *w;
1663 /* mg may be freed later by the uvar call, so we need to fetch the next
1664 * token before reaching that fateful point. */
1665 moremagic = mg->mg_moremagic;
1667 switch (mg->mg_type) {
1668 case PERL_MAGIC_ext:
1670 case PERL_MAGIC_tied:
1677 w = vmg_wizard_from_mg(mg);
1686 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1690 & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1693 vmg_cb_call2(w->cb_fetch, w->opinfo | VMG_CB_CALL_GUARD, sv,
1696 case HV_FETCH_ISSTORE:
1697 case HV_FETCH_LVALUE:
1698 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1700 vmg_cb_call2(w->cb_store, w->opinfo | VMG_CB_CALL_GUARD, sv,
1703 case HV_FETCH_ISEXISTS:
1705 vmg_cb_call2(w->cb_exists, w->opinfo | VMG_CB_CALL_GUARD, sv,
1710 vmg_cb_call2(w->cb_delete, w->opinfo | VMG_CB_CALL_GUARD, sv,
1716 if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1717 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1718 * mistaken for a tied hash by the rest of hv_common. It will be reset by
1719 * the op_ppaddr of a new fake op injected between the current and the next
1722 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1726 PL_op = vmg_trampoline_bump(&MY_CXT.reset_rmg, sv, PL_op);
1728 #else /* !VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1730 OP *nop = PL_op->op_next;
1733 if (nop && nop->op_ppaddr == vmg_pp_reset_rmg) {
1734 svop = (SVOP *) nop;
1736 NewOp(1101, svop, 1, SVOP);
1737 svop->op_type = OP_STUB;
1738 svop->op_ppaddr = vmg_pp_reset_rmg;
1739 svop->op_next = nop;
1741 svop->op_private = 0;
1743 PL_op->op_next = (OP *) svop;
1748 #endif /* VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1756 #endif /* VMG_UVAR */
1758 /* --- Module setup/teardown ----------------------------------------------- */
1762 static I32 vmg_loaded = 0;
1764 /* We must use preexistent global mutexes or we will never be able to destroy
1766 # if VMG_HAS_PERL(5, 9, 3)
1767 # define VMG_LOADED_LOCK MUTEX_LOCK(&PL_my_ctx_mutex)
1768 # define VMG_LOADED_UNLOCK MUTEX_UNLOCK(&PL_my_ctx_mutex)
1770 # define VMG_LOADED_LOCK OP_REFCNT_LOCK
1771 # define VMG_LOADED_UNLOCK OP_REFCNT_UNLOCK
1774 static void vmg_global_teardown_late_locked(pTHX) {
1775 #define vmg_global_teardown_late_locked() vmg_global_teardown_late_locked(aTHX)
1776 MUTEX_DESTROY(&vmg_op_name_init_mutex);
1777 MUTEX_DESTROY(&vmg_vtable_refcount_mutex);
1782 static int vmg_global_teardown_free(pTHX_ SV *sv, MAGIC *mg) {
1785 if (vmg_loaded == 0)
1786 vmg_global_teardown_late_locked();
1793 static MGVTBL vmg_global_teardown_vtbl = {
1798 vmg_global_teardown_free
1810 static signed char vmg_destruct_level(pTHX) {
1811 #define vmg_destruct_level() vmg_destruct_level(aTHX)
1814 lvl = PL_perl_destruct_level;
1818 const char *s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1821 #if VMG_HAS_PERL(5, 21, 3)
1822 if (strEQ(s, "-1")) {
1825 # if VMG_HAS_PERL(5, 21, 10)
1827 if (Perl_grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
1831 # else /* VMG_HAS_PERL(5, 21, 3) && !VMG_HAS_PERL(5, 21, 10) */
1832 i = Perl_grok_atou(s, NULL);
1835 #else /* !VMG_HAS_PERL(5, 21, 3) */
1847 #endif /* VMG_THREADSAFE */
1849 static void vmg_teardown(pTHX_ void *param) {
1855 if (vmg_loaded == 1) {
1857 if (vmg_destruct_level() == 0) {
1858 vmg_global_teardown_late_locked();
1861 PL_strtab = newHV();
1862 vmg_sv_magicext((SV *) PL_strtab, NULL, &vmg_global_teardown_vtbl, NULL, 0);
1865 assert(vmg_loaded > 1);
1872 if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1873 vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1874 MY_CXT.freed_tokens = NULL;
1880 static void vmg_setup(pTHX) {
1881 #define vmg_setup() vmg_setup(aTHX)
1889 if (vmg_loaded == 0) {
1890 MUTEX_INIT(&vmg_vtable_refcount_mutex);
1891 MUTEX_INIT(&vmg_op_name_init_mutex);
1894 assert(vmg_loaded > 0);
1901 for (c = OPc_NULL; c < OPc_MAX; ++c)
1902 MY_CXT.b__op_stashes[c] = NULL;
1905 MY_CXT.freed_tokens = NULL;
1907 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1908 vmg_trampoline_init(&MY_CXT.propagate_errsv, vmg_pp_propagate_errsv);
1910 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1911 vmg_trampoline_init(&MY_CXT.reset_rmg, vmg_pp_reset_rmg);
1914 stash = gv_stashpv(__PACKAGE__, 1);
1915 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1916 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1917 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1918 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1919 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1920 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1921 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_NOLEN",
1922 newSVuv(VMG_COMPAT_SCALAR_NOLEN));
1923 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1924 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1925 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1926 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1927 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1928 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1929 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1930 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1931 newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1932 newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1933 newCONSTSUB(stash, "VMG_COMPAT_CODE_COPY_CLONE",
1934 newSVuv(VMG_COMPAT_CODE_COPY_CLONE));
1935 newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1936 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1937 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
1938 newCONSTSUB(stash, "VMG_FORKSAFE", newSVuv(VMG_FORKSAFE));
1939 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1940 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1942 call_atexit(vmg_teardown, NULL);
1947 /* --- Macros for the XS section ------------------------------------------- */
1950 # define VMG_CVOK(C) \
1951 ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
1953 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
1956 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
1958 #define VMG_SET_CB(S, N) { \
1960 if (SvOK(cb) && SvROK(cb)) { \
1963 SvREFCNT_inc_simple_void(cb); \
1972 #define VMG_SET_SVT_CB(S, N) { \
1974 if (SvOK(cb) && SvROK(cb)) { \
1976 if (VMG_CBOK(cb)) { \
1977 t->svt_ ## N = vmg_svt_ ## N; \
1978 SvREFCNT_inc_simple_void(cb); \
1980 t->svt_ ## N = vmg_svt_ ## N ## _noop; \
1984 t->svt_ ## N = NULL; \
1990 /* --- XS ------------------------------------------------------------------ */
1992 MODULE = Variable::Magic PACKAGE = Variable::Magic
2007 U32 had_b__op_stash = 0;
2013 for (c = OPc_NULL; c < OPc_MAX; ++c) {
2014 if (MY_CXT.b__op_stashes[c])
2015 had_b__op_stash |= (((U32) 1) << c);
2017 old_depth = MY_CXT.depth;
2021 for (c = OPc_NULL; c < OPc_MAX; ++c) {
2022 MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
2023 ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
2025 MY_CXT.depth = old_depth;
2026 MY_CXT.freed_tokens = NULL;
2028 assert(vmg_loaded > 0);
2034 #endif /* VMG_THREADSAFE */
2041 SV *op_info, *copy_key;
2047 #endif /* MGf_LOCAL */
2050 #endif /* VMG_UVAR */
2051 ) { croak(vmg_wrongargnum); }
2054 w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
2055 t = vmg_vtable_vtbl(w->vtable);
2057 VMG_SET_CB(ST(i++), data);
2059 VMG_SET_SVT_CB(ST(i++), get);
2060 VMG_SET_SVT_CB(ST(i++), set);
2061 VMG_SET_SVT_CB(ST(i++), len);
2062 VMG_SET_SVT_CB(ST(i++), clear);
2063 VMG_SET_SVT_CB(ST(i++), free);
2064 VMG_SET_SVT_CB(ST(i++), copy);
2065 /* VMG_SET_SVT_CB(ST(i++), dup); */
2070 VMG_SET_SVT_CB(ST(i++), local);
2071 #endif /* MGf_LOCAL */
2073 VMG_SET_CB(ST(i++), fetch);
2074 VMG_SET_CB(ST(i++), store);
2075 VMG_SET_CB(ST(i++), exists);
2076 VMG_SET_CB(ST(i++), delete);
2079 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
2080 w->uvar = SvTRUE(copy_key) ? 2 : 1;
2081 #endif /* VMG_UVAR */
2083 RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
2087 SV *cast(SV *sv, SV *wiz, ...)
2088 PROTOTYPE: \[$@%&*]$@
2090 const vmg_wizard *w = NULL;
2099 wiz = SvRV_const(wiz);
2100 w = vmg_wizard_from_sv(wiz);
2103 croak(vmg_invalid_wiz);
2104 RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
2109 getdata(SV *sv, SV *wiz)
2110 PROTOTYPE: \[$@%&*]$
2112 const vmg_wizard *w = NULL;
2116 w = vmg_wizard_from_sv(SvRV_const(wiz));
2118 croak(vmg_invalid_wiz);
2119 data = vmg_data_get(SvRV(sv), w);
2125 SV *dispell(SV *sv, SV *wiz)
2126 PROTOTYPE: \[$@%&*]$
2128 const vmg_wizard *w = NULL;
2131 w = vmg_wizard_from_sv(SvRV_const(wiz));
2133 croak(vmg_invalid_wiz);
2134 RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));