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)
137 # define OP_NAME(O) (PL_op_name[(O)->op_type])
141 # define OP_CLASS(O) (PL_opargs[(O)->op_type] & OA_CLASS_MASK)
145 # define VMG_ASSERT(C) assert(C)
147 # define VMG_ASSERT(C)
150 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but we only
151 * enable them on 5.10 */
152 #if VMG_HAS_PERL(5, 10, 0)
158 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969) || VMG_HAS_PERL(5, 12, 0)
159 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
161 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
164 #if VMG_HAS_PERL(5, 17, 4)
165 # define VMG_COMPAT_SCALAR_NOLEN 1
167 # define VMG_COMPAT_SCALAR_NOLEN 0
170 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
171 * reverted to dev-5.11 as 9cdcb38b */
172 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
173 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
174 # if VMG_HAS_PERL(5, 11, 0)
175 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
177 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
180 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
181 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
184 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
185 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
187 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
188 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
192 /* Applied to dev-5.11 as 34908 */
193 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908) || VMG_HAS_PERL(5, 12, 0)
194 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
196 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
199 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
200 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
201 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
203 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
206 #if VMG_HAS_PERL(5, 11, 0)
207 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 1
209 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 0
212 #if VMG_HAS_PERL(5, 17, 0)
213 # define VMG_COMPAT_CODE_COPY_CLONE 1
215 # define VMG_COMPAT_CODE_COPY_CLONE 0
218 #if VMG_HAS_PERL(5, 13, 2)
219 # define VMG_COMPAT_GLOB_GET 1
221 # define VMG_COMPAT_GLOB_GET 0
224 #define VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE (VMG_HAS_PERL(5, 10, 0) && !VMG_HAS_PERL(5, 10, 1))
226 /* NewOp() isn't public in perl 5.8.0. */
227 #define VMG_RESET_RMG_NEEDS_TRAMPOLINE (VMG_UVAR && (VMG_THREADSAFE || !VMG_HAS_PERL(5, 8, 1)))
229 /* ... Bug-free mg_magical ................................................. */
231 /* See the discussion at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html */
233 #if VMG_HAS_PERL(5, 11, 3)
235 #define vmg_mg_magical(S) mg_magical(S)
239 static void vmg_mg_magical(SV *sv) {
243 if ((mg = SvMAGIC(sv))) {
245 const MGVTBL* const vtbl = mg->mg_virtual;
247 if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
254 } while ((mg = mg->mg_moremagic));
255 if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
262 /* --- Trampoline ops ------------------------------------------------------ */
264 #define VMG_NEEDS_TRAMPOLINE VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE || VMG_RESET_RMG_NEEDS_TRAMPOLINE
266 #if VMG_NEEDS_TRAMPOLINE
273 static void vmg_trampoline_init(vmg_trampoline *t, OP *(*cb)(pTHX)) {
274 t->temp.op_type = OP_STUB;
275 t->temp.op_ppaddr = 0;
276 t->temp.op_next = (OP *) &t->target;
277 t->temp.op_flags = 0;
278 t->temp.op_private = 0;
280 t->target.op_type = OP_STUB;
281 t->target.op_ppaddr = cb;
282 t->target.op_next = NULL;
283 t->target.op_flags = 0;
284 t->target.op_private = 0;
285 t->target.op_sv = NULL;
288 static OP *vmg_trampoline_bump(pTHX_ vmg_trampoline *t, SV *sv, OP *o) {
289 #define vmg_trampoline_bump(T, S, O) vmg_trampoline_bump(aTHX_ (T), (S), (O))
291 t->temp.op_next = (OP *) &t->target;
293 t->target.op_sv = sv;
294 t->target.op_next = o->op_next;
299 #endif /* VMG_NEEDS_TRAMPOLINE */
301 /* --- Cleaner version of sv_magicext() ------------------------------------ */
303 static MAGIC *vmg_sv_magicext(pTHX_ SV *sv, SV *obj, const MGVTBL *vtbl, const void *ptr, I32 len) {
304 #define vmg_sv_magicext(S, O, V, P, L) vmg_sv_magicext(aTHX_ (S), (O), (V), (P), (L))
307 mg = sv_magicext(sv, obj, PERL_MAGIC_ext, vtbl, ptr, len);
314 mg->mg_flags |= MGf_COPY;
317 mg->mg_flags |= MGf_DUP;
321 mg->mg_flags |= MGf_LOCAL;
322 #endif /* MGf_LOCAL */
324 if (mg->mg_flags & MGf_REFCOUNTED)
330 /* --- Safe version of call_sv() ------------------------------------------- */
332 static I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, int (*cleanup)(pTHX_ void *), void *ud) {
333 #define vmg_call_sv(S, F, C, U) vmg_call_sv(aTHX_ (S), (F), (C), (U))
338 old_err = newSVsv(ERRSV);
339 sv_setsv(ERRSV, &PL_sv_undef);
342 ret = call_sv(sv, flags | G_EVAL);
345 SvREFCNT_dec(old_err);
347 if (IN_PERL_COMPILETIME) {
350 sv_catsv(PL_errors, ERRSV);
352 Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
355 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
357 ++PL_parser->error_count;
358 #elif defined(PL_error_count)
364 if (!cleanup || cleanup(aTHX_ ud))
369 sv_setsv(ERRSV, old_err);
370 SvREFCNT_dec(old_err);
377 /* --- Stolen chunk of B --------------------------------------------------- */
392 #if VMG_HAS_PERL(5, 21, 5)
395 #if VMG_HAS_PERL(5, 21, 7)
401 static const char *const vmg_opclassnames[] = {
414 #if VMG_HAS_PERL(5, 21, 5)
417 #if VMG_HAS_PERL(5, 21, 7)
423 static opclass vmg_opclass(pTHX_ const OP *o) {
424 #define vmg_opclass(O) vmg_opclass(aTHX_ (O))
430 if (o->op_type == 0) {
431 #if VMG_HAS_PERL(5, 21, 7)
432 if (o->op_targ == OP_NEXTSTATE || o->op_targ == OP_DBSTATE)
435 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
438 if (o->op_type == OP_SASSIGN)
439 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
441 if (o->op_type == OP_AELEMFAST) {
442 #if PERL_VERSION <= 14
443 if (o->op_flags & OPf_SPECIAL)
455 if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
459 switch (OP_CLASS(o)) {
476 case OA_PVOP_OR_SVOP:
478 #if VMG_HAS_PERL(5, 13, 7)
479 (o->op_type != OP_CUSTOM) &&
481 (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)))
482 #if defined(USE_ITHREADS) && VMG_HAS_PERL(5, 8, 9)
483 ? OPc_PADOP : OPc_PVOP;
485 ? OPc_SVOP : OPc_PVOP;
491 case OA_BASEOP_OR_UNOP:
492 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
494 return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
496 (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
498 (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
501 if (o->op_flags & OPf_STACKED)
503 else if (o->op_flags & OPf_SPECIAL)
507 #if VMG_HAS_PERL(5, 21, 5)
511 #if VMG_HAS_PERL(5, 21, 7)
520 /* --- Error messages ------------------------------------------------------ */
522 static const char vmg_invalid_wiz[] = "Invalid wizard object";
523 static const char vmg_wrongargnum[] = "Wrong number of arguments";
525 /* --- Context-safe global data -------------------------------------------- */
527 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
530 HV *b__op_stashes[OPc_MAX];
533 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
534 vmg_trampoline propagate_errsv;
536 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
537 vmg_trampoline reset_rmg;
543 /* --- <vmg_vtable> structure ---------------------------------------------- */
552 static vmg_vtable *vmg_vtable_alloc(pTHX) {
553 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
556 t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
558 t->vtbl = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
564 #define vmg_vtable_vtbl(T) (T)->vtbl
566 static perl_mutex vmg_vtable_refcount_mutex;
568 static vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
569 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
570 VMG_LOCK(&vmg_vtable_refcount_mutex);
572 VMG_UNLOCK(&vmg_vtable_refcount_mutex);
577 static void vmg_vtable_free(pTHX_ vmg_vtable *t) {
578 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
581 VMG_LOCK(&vmg_vtable_refcount_mutex);
582 refcount = --t->refcount;
583 VMG_UNLOCK(&vmg_vtable_refcount_mutex);
586 PerlMemShared_free(t->vtbl);
587 PerlMemShared_free(t);
591 #else /* VMG_THREADSAFE */
593 typedef MGVTBL vmg_vtable;
595 static vmg_vtable *vmg_vtable_alloc(pTHX) {
596 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
599 Newx(t, 1, vmg_vtable);
604 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
606 #define vmg_vtable_free(T) Safefree(T)
608 #endif /* !VMG_THREADSAFE */
610 /* --- <vmg_wizard> structure ---------------------------------------------- */
619 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
624 #endif /* MGf_LOCAL */
626 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
627 #endif /* VMG_UVAR */
630 static void vmg_op_info_init(pTHX_ unsigned int opinfo);
632 static vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
633 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
636 Newx(w, 1, vmg_wizard);
639 w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
641 vmg_op_info_init(aTHX_ w->opinfo);
643 w->vtable = vmg_vtable_alloc();
648 static void vmg_wizard_free(pTHX_ vmg_wizard *w) {
649 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
653 /* During global destruction, any of the callbacks may already have been
654 * freed, so we can't rely on still being able to access them. */
656 SvREFCNT_dec(w->cb_data);
657 SvREFCNT_dec(w->cb_get);
658 SvREFCNT_dec(w->cb_set);
659 SvREFCNT_dec(w->cb_len);
660 SvREFCNT_dec(w->cb_clear);
661 SvREFCNT_dec(w->cb_free);
662 SvREFCNT_dec(w->cb_copy);
664 SvREFCNT_dec(w->cb_dup);
667 SvREFCNT_dec(w->cb_local);
668 #endif /* MGf_LOCAL */
670 SvREFCNT_dec(w->cb_fetch);
671 SvREFCNT_dec(w->cb_store);
672 SvREFCNT_dec(w->cb_exists);
673 SvREFCNT_dec(w->cb_delete);
674 #endif /* VMG_UVAR */
677 /* PerlMemShared_free() and Safefree() are still fine during global
678 * destruction though. */
679 vmg_vtable_free(w->vtable);
687 #define VMG_CLONE_CB(N) \
688 z->cb_ ## N = (w->cb_ ## N) ? SvREFCNT_inc(sv_dup(w->cb_ ## N, params)) \
691 static const vmg_wizard *vmg_wizard_dup(pTHX_ const vmg_wizard *w, CLONE_PARAMS *params) {
692 #define vmg_wizard_dup(W, P) vmg_wizard_dup(aTHX_ (W), (P))
698 Newx(z, 1, vmg_wizard);
700 z->vtable = vmg_vtable_dup(w->vtable);
702 z->opinfo = w->opinfo;
714 #endif /* MGf_LOCAL */
718 VMG_CLONE_CB(exists);
719 VMG_CLONE_CB(delete);
720 #endif /* VMG_UVAR */
725 #endif /* VMG_THREADSAFE */
727 #define vmg_wizard_id(W) PTR2IV(vmg_vtable_vtbl((W)->vtable))
729 /* --- Wizard SV objects --------------------------------------------------- */
731 static int vmg_wizard_sv_free(pTHX_ SV *sv, MAGIC *mg) {
732 vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
739 static int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
740 mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
745 #endif /* VMG_THREADSAFE */
747 static MGVTBL vmg_wizard_sv_vtbl = {
752 vmg_wizard_sv_free, /* free */
755 vmg_wizard_sv_dup, /* dup */
761 #endif /* MGf_LOCAL */
764 static SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
765 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
771 wiz = newSViv(PTR2IV(w));
774 vmg_sv_magicext(wiz, NULL, &vmg_wizard_sv_vtbl, w, 0);
783 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
785 static const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
788 for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
789 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
790 return (const vmg_wizard *) mg->mg_ptr;
796 #else /* VMG_THREADSAFE */
798 #define vmg_sv_has_wizard_type(S) SvIOK(S)
800 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
802 #endif /* !VMG_THREADSAFE */
804 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
806 static const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
807 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
808 SV *sv = (SV *) mg->mg_ptr;
810 if (vmg_sv_has_wizard_type(sv))
811 return vmg_wizard_from_sv_nocheck(sv);
817 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
819 /* --- User-level functions implementation --------------------------------- */
821 static const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
825 if (SvTYPE(sv) < SVt_PVMG)
828 wid = vmg_wizard_id(w);
830 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
831 const vmg_wizard *z = vmg_wizard_from_mg(mg);
833 if (z && vmg_wizard_id(z) == wid)
840 /* ... Construct private data .............................................. */
842 static SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
843 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
852 PUSHSTACKi(PERLSI_MAGIC);
855 EXTEND(SP, items + 1);
856 PUSHs(sv_2mortal(newRV_inc(sv)));
857 for (i = 0; i < items; ++i)
861 vmg_call_sv(ctor, G_SCALAR, 0, NULL);
865 #if VMG_HAS_PERL(5, 8, 3)
866 SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
868 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
880 static SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
881 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
882 const MAGIC *mg = vmg_find(sv, w);
884 return mg ? mg->mg_obj : NULL;
887 /* ... Magic cast/dispell .................................................. */
891 static I32 vmg_svt_val(pTHX_ IV, SV *);
894 struct ufuncs new_uf;
895 struct ufuncs old_uf;
898 #endif /* VMG_UVAR */
900 static void vmg_mg_del(pTHX_ SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
901 #define vmg_mg_del(S, P, M, N) vmg_mg_del(aTHX_ (S), (P), (M), (N))
905 prevmagic->mg_moremagic = moremagic;
907 SvMAGIC_set(sv, moremagic);
909 /* Destroy private data */
911 if (mg->mg_type == PERL_MAGIC_uvar) {
912 Safefree(mg->mg_ptr);
914 #endif /* VMG_UVAR */
915 if (mg->mg_obj != sv) {
916 SvREFCNT_dec(mg->mg_obj);
919 /* Unreference the wizard */
920 SvREFCNT_dec((SV *) mg->mg_ptr);
924 #endif /* VMG_UVAR */
927 mg->mg_moremagic = MY_CXT.freed_tokens;
928 MY_CXT.freed_tokens = mg;
930 mg->mg_moremagic = NULL;
935 static int vmg_magic_chain_free(pTHX_ MAGIC *mg, MAGIC *skip) {
936 #define vmg_magic_chain_free(M, S) vmg_magic_chain_free(aTHX_ (M), (S))
940 MAGIC *moremagic = mg->mg_moremagic;
953 static UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
954 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
963 oldgmg = SvGMAGICAL(sv);
965 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
967 t = vmg_vtable_vtbl(w->vtable);
968 mg = vmg_sv_magicext(sv, data, t, wiz, HEf_SVKEY);
970 if (SvTYPE(sv) < SVt_PVHV)
973 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
974 * magic is actually never called for them. If the GMAGICAL flag was off before
975 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
976 * now on, then this wizard has get magic. Hence we can work around the
977 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
978 * has uvar callbacks, it will be turned back on later. */
979 if (!oldgmg && SvGMAGICAL(sv))
984 MAGIC *prevmagic, *moremagic = NULL;
987 ud.new_uf.uf_val = vmg_svt_val;
988 ud.new_uf.uf_set = NULL;
989 ud.new_uf.uf_index = 0;
990 ud.old_uf.uf_val = NULL;
991 ud.old_uf.uf_set = NULL;
992 ud.old_uf.uf_index = 0;
994 /* One uvar magic in the chain is enough. */
995 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
996 moremagic = mg->mg_moremagic;
997 if (mg->mg_type == PERL_MAGIC_uvar)
1001 if (mg) { /* Found another uvar magic. */
1002 struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
1003 if (uf->uf_val == vmg_svt_val) {
1004 /* It's our uvar magic, nothing to do. oldgmg was true. */
1007 /* It's another uvar magic, backup it and replace it by ours. */
1009 vmg_mg_del(sv, prevmagic, mg, moremagic);
1013 sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
1015 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
1016 * handled by our uvar callback. */
1018 #endif /* VMG_UVAR */
1024 static UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
1025 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
1028 #endif /* VMG_UVAR */
1029 MAGIC *mg, *prevmagic, *moremagic = NULL;
1030 IV wid = vmg_wizard_id(w);
1032 if (SvTYPE(sv) < SVt_PVMG)
1035 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
1036 const vmg_wizard *z;
1038 moremagic = mg->mg_moremagic;
1040 z = vmg_wizard_from_mg(mg);
1042 IV zid = vmg_wizard_id(z);
1046 /* If the current has no uvar, short-circuit uvar deletion. */
1047 uvars = z->uvar ? (uvars + 1) : 0;
1049 } else if (z->uvar) {
1051 /* We can't break here since we need to find the ext magic to delete. */
1053 #else /* VMG_UVAR */
1056 #endif /* !VMG_UVAR */
1062 vmg_mg_del(sv, prevmagic, mg, moremagic);
1065 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
1066 /* mg was the first ext magic in the chain that had uvar */
1068 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
1069 const vmg_wizard *z = vmg_wizard_from_mg(mg);
1080 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
1081 moremagic = mg->mg_moremagic;
1082 if (mg->mg_type == PERL_MAGIC_uvar)
1086 ud = (vmg_uvar_ud *) mg->mg_ptr;
1087 if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
1088 /* Revert the original uvar magic. */
1090 Newx(uf, 1, struct ufuncs);
1093 mg->mg_ptr = (char *) uf;
1094 mg->mg_len = sizeof(*uf);
1096 /* Remove the uvar magic. */
1097 vmg_mg_del(sv, prevmagic, mg, moremagic);
1101 #endif /* VMG_UVAR */
1108 /* ... OP info ............................................................. */
1110 #define VMG_OP_INFO_NAME 1
1111 #define VMG_OP_INFO_OBJECT 2
1114 static perl_mutex vmg_op_name_init_mutex;
1117 static U32 vmg_op_name_init = 0;
1118 static unsigned char vmg_op_name_len[MAXO] = { 0 };
1120 static void vmg_op_info_init(pTHX_ unsigned int opinfo) {
1121 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
1123 case VMG_OP_INFO_NAME:
1124 VMG_LOCK(&vmg_op_name_init_mutex);
1125 if (!vmg_op_name_init) {
1127 for (t = 0; t < OP_max; ++t)
1128 vmg_op_name_len[t] = strlen(PL_op_name[t]);
1129 vmg_op_name_init = 1;
1131 VMG_UNLOCK(&vmg_op_name_init_mutex);
1133 case VMG_OP_INFO_OBJECT: {
1135 if (!MY_CXT.b__op_stashes[0]) {
1138 for (c = OPc_NULL; c < OPc_MAX; ++c)
1139 MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1148 static SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1149 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1151 return &PL_sv_undef;
1154 case VMG_OP_INFO_NAME: {
1157 OPCODE t = PL_op->op_type;
1158 name = OP_NAME(PL_op);
1159 name_len = (t == OP_CUSTOM) ? strlen(name) : vmg_op_name_len[t];
1160 return sv_2mortal(newSVpvn(name, name_len));
1162 case VMG_OP_INFO_OBJECT: {
1164 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1165 MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1171 return &PL_sv_undef;
1174 /* --- svt callbacks ------------------------------------------------------- */
1176 #define VMG_CB_CALL_ARGS_MASK 15
1177 #define VMG_CB_CALL_ARGS_SHIFT 4
1178 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT) /* 1|2 */
1179 #define VMG_CB_CALL_GUARD 4
1181 static int vmg_dispell_guard_oncroak(pTHX_ void *ud) {
1186 /* If we're at the upmost magic call and we're about to die, we can just free
1187 * the tokens right now, since we will jump past the problematic part of our
1189 if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1190 vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1191 MY_CXT.freed_tokens = NULL;
1197 static int vmg_dispell_guard_free(pTHX_ SV *sv, MAGIC *mg) {
1198 vmg_magic_chain_free((MAGIC *) mg->mg_ptr, NULL);
1205 static int vmg_dispell_guard_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
1206 /* The freed magic tokens aren't cloned by perl because it cannot reach them
1207 * (they have been detached from their parent SV when they were enqueued).
1208 * Hence there's nothing to purge in the new thread. */
1214 #endif /* VMG_THREADSAFE */
1216 static MGVTBL vmg_dispell_guard_vtbl = {
1221 vmg_dispell_guard_free, /* free */
1224 vmg_dispell_guard_dup, /* dup */
1230 #endif /* MGf_LOCAL */
1233 static SV *vmg_dispell_guard_new(pTHX_ MAGIC *root) {
1234 #define vmg_dispell_guard_new(R) vmg_dispell_guard_new(aTHX_ (R))
1237 guard = sv_newmortal();
1238 vmg_sv_magicext(guard, NULL, &vmg_dispell_guard_vtbl, root, 0);
1243 static int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1246 unsigned int i, args, opinfo;
1247 MAGIC **chain = NULL;
1252 args = flags & VMG_CB_CALL_ARGS_MASK;
1253 flags >>= VMG_CB_CALL_ARGS_SHIFT;
1254 opinfo = flags & VMG_CB_CALL_OPINFO;
1259 PUSHSTACKi(PERLSI_MAGIC);
1262 EXTEND(SP, args + 1);
1263 PUSHs(sv_2mortal(newRV_inc(sv)));
1265 for (i = 0; i < args; ++i) {
1266 SV *sva = va_arg(ap, SV *);
1267 PUSHs(sva ? sva : &PL_sv_undef);
1271 XPUSHs(vmg_op_info(opinfo));
1274 if (flags & VMG_CB_CALL_GUARD) {
1277 vmg_call_sv(cb, G_SCALAR, vmg_dispell_guard_oncroak, NULL);
1279 if (MY_CXT.depth == 0 && MY_CXT.freed_tokens)
1280 chain = &MY_CXT.freed_tokens;
1282 vmg_call_sv(cb, G_SCALAR, 0, NULL);
1288 ret = (int) SvIV(svr);
1300 if (svr && !SvTEMP(svr))
1304 vmg_dispell_guard_new(*chain);
1311 #define VMG_CB_FLAGS(OI, A) \
1312 ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1314 #define vmg_cb_call1(I, OI, S, A1) \
1315 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1316 #define vmg_cb_call2(I, OI, S, A1, A2) \
1317 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1318 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1319 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1321 /* ... Default no-op magic callback ........................................ */
1323 static int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1327 /* ... get magic ........................................................... */
1329 static int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1330 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1332 return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1335 #define vmg_svt_get_noop vmg_svt_default_noop
1337 /* ... set magic ........................................................... */
1339 static int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1340 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1342 return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1345 #define vmg_svt_set_noop vmg_svt_default_noop
1347 /* ... len magic ........................................................... */
1349 static U32 vmg_sv_len(pTHX_ SV *sv) {
1350 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1352 #if VMG_HAS_PERL(5, 9, 3)
1353 const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1355 U8 *s = SvPV(sv, len);
1358 return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1361 static U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1362 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1363 unsigned int opinfo = w->opinfo;
1366 svtype t = SvTYPE(sv);
1373 PUSHSTACKi(PERLSI_MAGIC);
1377 PUSHs(sv_2mortal(newRV_inc(sv)));
1378 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1380 len = vmg_sv_len(sv);
1382 } else if (t == SVt_PVAV) {
1383 len = av_len((AV *) sv) + 1;
1387 PUSHs(&PL_sv_undef);
1390 XPUSHs(vmg_op_info(opinfo));
1393 vmg_call_sv(w->cb_len, G_SCALAR, 0, NULL);
1397 ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1410 static U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1412 svtype t = SvTYPE(sv);
1415 len = vmg_sv_len(sv);
1416 } else if (t == SVt_PVAV) {
1417 len = (U32) av_len((AV *) sv);
1423 /* ... clear magic ......................................................... */
1425 static int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1426 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1427 unsigned int flags = w->opinfo;
1429 #if !VMG_HAS_PERL(5, 12, 0)
1430 flags |= VMG_CB_CALL_GUARD;
1433 return vmg_cb_call1(w->cb_clear, flags, sv, mg->mg_obj);
1436 #define vmg_svt_clear_noop vmg_svt_default_noop
1438 /* ... free magic .......................................................... */
1440 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1442 static OP *vmg_pp_propagate_errsv(pTHX) {
1443 SVOP *o = cSVOPx(PL_op);
1446 sv_setsv(ERRSV, o->op_sv);
1447 SvREFCNT_dec(o->op_sv);
1454 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1456 static int vmg_propagate_errsv_free(pTHX_ SV *sv, MAGIC *mg) {
1458 sv_setsv(ERRSV, mg->mg_obj);
1463 /* perl is already kind enough to handle the cloning of the mg_obj member,
1464 hence we don't need to define a dup magic callback. */
1466 static MGVTBL vmg_propagate_errsv_vtbl = {
1471 vmg_propagate_errsv_free, /* free */
1476 #endif /* MGf_LOCAL */
1483 } vmg_svt_free_cleanup_ud;
1485 static int vmg_svt_free_cleanup(pTHX_ void *ud_) {
1486 vmg_svt_free_cleanup_ud *ud = VOID2(vmg_svt_free_cleanup_ud *, ud_);
1489 U32 optype = PL_op ? PL_op->op_type : OP_NULL;
1491 if (optype == OP_LEAVETRY || optype == OP_LEAVEEVAL) {
1492 SV *errsv = newSVsv(ERRSV);
1495 LEAVE_SCOPE(ud->base);
1497 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1498 if (optype == OP_LEAVETRY) {
1500 PL_op = vmg_trampoline_bump(&MY_CXT.propagate_errsv, errsv, PL_op);
1501 } else if (optype == OP_LEAVEEVAL) {
1502 SV *guard = sv_newmortal();
1503 vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1505 #else /* !VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1506 # if !VMG_HAS_PERL(5, 8, 9)
1508 SV *guard = sv_newmortal();
1509 vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1512 vmg_sv_magicext(ERRSV, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1514 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1519 /* Don't propagate */
1525 /* We are about to croak() while sv is being destroyed. Try to clean up
1529 vmg_mg_del(sv, NULL, mg, mg->mg_moremagic);
1534 vmg_dispell_guard_oncroak(aTHX_ NULL);
1536 /* After that, propagate the error upwards. */
1541 static int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1542 vmg_svt_free_cleanup_ud ud;
1543 const vmg_wizard *w;
1549 /* During global destruction, we cannot be sure that the wizard and its free
1550 * callback are still alive. */
1554 w = vmg_wizard_from_mg_nocheck(mg);
1556 /* So that it survives the temp cleanup below */
1557 SvREFCNT_inc_simple_void(sv);
1559 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1560 /* The previous magic tokens were freed but the magic chain wasn't updated, so
1561 * if you access the sv from the callback the old deleted magics will trigger
1562 * and cause memory misreads. Change 32686 solved it that way : */
1563 SvMAGIC_set(sv, mg);
1567 if (cxstack_ix < cxstack_max) {
1568 ud.in_eval = (CxTYPE(cxstack + cxstack_ix + 1) == CXt_EVAL);
1569 ud.base = ud.in_eval ? PL_scopestack[PL_scopestack_ix] : 0;
1578 PUSHSTACKi(PERLSI_MAGIC);
1582 PUSHs(sv_2mortal(newRV_inc(sv)));
1583 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1585 XPUSHs(vmg_op_info(w->opinfo));
1591 vmg_call_sv(w->cb_free, G_SCALAR, vmg_svt_free_cleanup, &ud);
1593 if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1594 /* Free all the tokens in the chain but the current one (if it's present).
1595 * It will be taken care of by our caller, Perl_mg_free(). */
1596 vmg_magic_chain_free(MY_CXT.freed_tokens, mg);
1597 MY_CXT.freed_tokens = NULL;
1604 ret = (int) SvIV(svr);
1612 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1613 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1616 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1617 * mg->mg_ptr reference count */
1621 #define vmg_svt_free_noop vmg_svt_default_noop
1623 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1624 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1626 # define VMG_SVT_COPY_KEYLEN_TYPE int
1629 /* ... copy magic .......................................................... */
1631 static int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1632 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1636 if (keylen == HEf_SVKEY) {
1639 keysv = newSVpvn(key, keylen);
1642 if (SvTYPE(sv) >= SVt_PVCV)
1643 nsv = sv_2mortal(newRV_inc(nsv));
1645 ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1647 if (keylen != HEf_SVKEY) {
1648 SvREFCNT_dec(keysv);
1654 static int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1658 /* ... dup magic ........................................................... */
1661 static int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1664 #define vmg_svt_dup_noop vmg_svt_dup
1667 /* ... local magic ......................................................... */
1671 static int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1672 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1674 return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1677 #define vmg_svt_local_noop vmg_svt_default_noop
1679 #endif /* MGf_LOCAL */
1681 /* ... uvar magic .......................................................... */
1685 static OP *vmg_pp_reset_rmg(pTHX) {
1686 SVOP *o = cSVOPx(PL_op);
1688 SvRMAGICAL_on(o->op_sv);
1694 static I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1696 MAGIC *mg, *umg, *moremagic;
1697 SV *key = NULL, *newkey = NULL;
1700 umg = mg_find(sv, PERL_MAGIC_uvar);
1701 /* umg can't be NULL or we wouldn't be there. */
1703 ud = (vmg_uvar_ud *) umg->mg_ptr;
1705 if (ud->old_uf.uf_val)
1706 ud->old_uf.uf_val(aTHX_ action, sv);
1707 if (ud->old_uf.uf_set)
1708 ud->old_uf.uf_set(aTHX_ action, sv);
1710 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
1711 const vmg_wizard *w;
1713 /* mg may be freed later by the uvar call, so we need to fetch the next
1714 * token before reaching that fateful point. */
1715 moremagic = mg->mg_moremagic;
1717 switch (mg->mg_type) {
1718 case PERL_MAGIC_ext:
1720 case PERL_MAGIC_tied:
1727 w = vmg_wizard_from_mg(mg);
1736 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1740 & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1743 vmg_cb_call2(w->cb_fetch, w->opinfo | VMG_CB_CALL_GUARD, sv,
1746 case HV_FETCH_ISSTORE:
1747 case HV_FETCH_LVALUE:
1748 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1750 vmg_cb_call2(w->cb_store, w->opinfo | VMG_CB_CALL_GUARD, sv,
1753 case HV_FETCH_ISEXISTS:
1755 vmg_cb_call2(w->cb_exists, w->opinfo | VMG_CB_CALL_GUARD, sv,
1760 vmg_cb_call2(w->cb_delete, w->opinfo | VMG_CB_CALL_GUARD, sv,
1766 if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1767 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1768 * mistaken for a tied hash by the rest of hv_common. It will be reset by
1769 * the op_ppaddr of a new fake op injected between the current and the next
1772 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1776 PL_op = vmg_trampoline_bump(&MY_CXT.reset_rmg, sv, PL_op);
1778 #else /* !VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1780 OP *nop = PL_op->op_next;
1783 if (nop && nop->op_ppaddr == vmg_pp_reset_rmg) {
1784 svop = (SVOP *) nop;
1786 NewOp(1101, svop, 1, SVOP);
1787 svop->op_type = OP_STUB;
1788 svop->op_ppaddr = vmg_pp_reset_rmg;
1789 svop->op_next = nop;
1791 svop->op_private = 0;
1793 PL_op->op_next = (OP *) svop;
1798 #endif /* VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1806 #endif /* VMG_UVAR */
1808 /* --- Module setup/teardown ----------------------------------------------- */
1812 static I32 vmg_loaded = 0;
1814 /* We must use preexistent global mutexes or we will never be able to destroy
1816 # if VMG_HAS_PERL(5, 9, 3)
1817 # define VMG_LOADED_LOCK MUTEX_LOCK(&PL_my_ctx_mutex)
1818 # define VMG_LOADED_UNLOCK MUTEX_UNLOCK(&PL_my_ctx_mutex)
1820 # define VMG_LOADED_LOCK OP_REFCNT_LOCK
1821 # define VMG_LOADED_UNLOCK OP_REFCNT_UNLOCK
1824 static void vmg_global_teardown_late_locked(pTHX) {
1825 #define vmg_global_teardown_late_locked() vmg_global_teardown_late_locked(aTHX)
1826 MUTEX_DESTROY(&vmg_op_name_init_mutex);
1827 MUTEX_DESTROY(&vmg_vtable_refcount_mutex);
1832 static int vmg_global_teardown_free(pTHX_ SV *sv, MAGIC *mg) {
1835 if (vmg_loaded == 0)
1836 vmg_global_teardown_late_locked();
1843 static MGVTBL vmg_global_teardown_vtbl = {
1848 vmg_global_teardown_free
1860 static signed char vmg_destruct_level(pTHX) {
1861 #define vmg_destruct_level() vmg_destruct_level(aTHX)
1864 lvl = PL_perl_destruct_level;
1868 const char *s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1871 #if VMG_HAS_PERL(5, 21, 3)
1872 if (strEQ(s, "-1")) {
1875 # if VMG_HAS_PERL(5, 21, 10)
1877 if (Perl_grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
1881 # else /* VMG_HAS_PERL(5, 21, 3) && !VMG_HAS_PERL(5, 21, 10) */
1882 i = Perl_grok_atou(s, NULL);
1885 #else /* !VMG_HAS_PERL(5, 21, 3) */
1897 #endif /* VMG_THREADSAFE */
1899 static void vmg_teardown(pTHX_ void *param) {
1905 if (vmg_loaded == 1) {
1907 if (vmg_destruct_level() == 0) {
1908 vmg_global_teardown_late_locked();
1911 PL_strtab = newHV();
1912 vmg_sv_magicext((SV *) PL_strtab, NULL, &vmg_global_teardown_vtbl, NULL, 0);
1915 VMG_ASSERT(vmg_loaded > 1);
1922 if (MY_CXT.depth == 0 && MY_CXT.freed_tokens) {
1923 vmg_magic_chain_free(MY_CXT.freed_tokens, NULL);
1924 MY_CXT.freed_tokens = NULL;
1930 static void vmg_setup(pTHX) {
1931 #define vmg_setup() vmg_setup(aTHX)
1939 if (vmg_loaded == 0) {
1940 MUTEX_INIT(&vmg_vtable_refcount_mutex);
1941 MUTEX_INIT(&vmg_op_name_init_mutex);
1944 VMG_ASSERT(vmg_loaded > 0);
1951 for (c = OPc_NULL; c < OPc_MAX; ++c)
1952 MY_CXT.b__op_stashes[c] = NULL;
1955 MY_CXT.freed_tokens = NULL;
1957 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1958 vmg_trampoline_init(&MY_CXT.propagate_errsv, vmg_pp_propagate_errsv);
1960 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1961 vmg_trampoline_init(&MY_CXT.reset_rmg, vmg_pp_reset_rmg);
1964 stash = gv_stashpv(__PACKAGE__, 1);
1965 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1966 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1967 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1968 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1969 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1970 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1971 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_NOLEN",
1972 newSVuv(VMG_COMPAT_SCALAR_NOLEN));
1973 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1974 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1975 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1976 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1977 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1978 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1979 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1980 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1981 newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1982 newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1983 newCONSTSUB(stash, "VMG_COMPAT_CODE_COPY_CLONE",
1984 newSVuv(VMG_COMPAT_CODE_COPY_CLONE));
1985 newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1986 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1987 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
1988 newCONSTSUB(stash, "VMG_FORKSAFE", newSVuv(VMG_FORKSAFE));
1989 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1990 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1992 call_atexit(vmg_teardown, NULL);
1997 /* --- Macros for the XS section ------------------------------------------- */
2000 # define VMG_CVOK(C) \
2001 ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
2003 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
2006 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
2008 #define VMG_SET_CB(S, N) { \
2010 if (SvOK(cb) && SvROK(cb)) { \
2013 SvREFCNT_inc_simple_void(cb); \
2022 #define VMG_SET_SVT_CB(S, N) { \
2024 if (SvOK(cb) && SvROK(cb)) { \
2026 if (VMG_CBOK(cb)) { \
2027 t->svt_ ## N = vmg_svt_ ## N; \
2028 SvREFCNT_inc_simple_void(cb); \
2030 t->svt_ ## N = vmg_svt_ ## N ## _noop; \
2034 t->svt_ ## N = NULL; \
2040 /* --- XS ------------------------------------------------------------------ */
2042 MODULE = Variable::Magic PACKAGE = Variable::Magic
2057 U32 had_b__op_stash = 0;
2063 for (c = OPc_NULL; c < OPc_MAX; ++c) {
2064 if (MY_CXT.b__op_stashes[c])
2065 had_b__op_stash |= (((U32) 1) << c);
2067 old_depth = MY_CXT.depth;
2071 for (c = OPc_NULL; c < OPc_MAX; ++c) {
2072 MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
2073 ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
2075 MY_CXT.depth = old_depth;
2076 MY_CXT.freed_tokens = NULL;
2078 VMG_ASSERT(vmg_loaded > 0);
2084 #endif /* VMG_THREADSAFE */
2091 SV *op_info, *copy_key;
2097 #endif /* MGf_LOCAL */
2100 #endif /* VMG_UVAR */
2101 ) { croak(vmg_wrongargnum); }
2104 w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
2105 t = vmg_vtable_vtbl(w->vtable);
2107 VMG_SET_CB(ST(i++), data);
2109 VMG_SET_SVT_CB(ST(i++), get);
2110 VMG_SET_SVT_CB(ST(i++), set);
2111 VMG_SET_SVT_CB(ST(i++), len);
2112 VMG_SET_SVT_CB(ST(i++), clear);
2113 VMG_SET_SVT_CB(ST(i++), free);
2114 VMG_SET_SVT_CB(ST(i++), copy);
2115 /* VMG_SET_SVT_CB(ST(i++), dup); */
2120 VMG_SET_SVT_CB(ST(i++), local);
2121 #endif /* MGf_LOCAL */
2123 VMG_SET_CB(ST(i++), fetch);
2124 VMG_SET_CB(ST(i++), store);
2125 VMG_SET_CB(ST(i++), exists);
2126 VMG_SET_CB(ST(i++), delete);
2129 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
2130 w->uvar = SvTRUE(copy_key) ? 2 : 1;
2131 #endif /* VMG_UVAR */
2133 RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
2137 SV *cast(SV *sv, SV *wiz, ...)
2138 PROTOTYPE: \[$@%&*]$@
2140 const vmg_wizard *w = NULL;
2149 wiz = SvRV_const(wiz);
2150 w = vmg_wizard_from_sv(wiz);
2153 croak(vmg_invalid_wiz);
2154 RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
2159 getdata(SV *sv, SV *wiz)
2160 PROTOTYPE: \[$@%&*]$
2162 const vmg_wizard *w = NULL;
2166 w = vmg_wizard_from_sv(SvRV_const(wiz));
2168 croak(vmg_invalid_wiz);
2169 data = vmg_data_get(SvRV(sv), w);
2175 SV *dispell(SV *sv, SV *wiz)
2176 PROTOTYPE: \[$@%&*]$
2178 const vmg_wizard *w = NULL;
2181 w = vmg_wizard_from_sv(SvRV_const(wiz));
2183 croak(vmg_invalid_wiz);
2184 RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));