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) || defined(PERL_IMPLICIT_CONTEXT)
53 # define VMG_MULTIPLICITY 1
55 # define VMG_MULTIPLICITY 0
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
62 # define MY_CXT_CLONE \
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))
69 # define VMG_THREADSAFE 0
71 # define dMY_CXT dNOOP
73 # define MY_CXT vmg_globaldata
75 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
77 # define MY_CXT_INIT NOOP
79 # define MY_CXT_CLONE NOOP
83 # define VMG_LOCK(M) MUTEX_LOCK(M)
84 # define VMG_UNLOCK(M) MUTEX_UNLOCK(M)
87 # define VMG_UNLOCK(M)
90 /* --- Compatibility ------------------------------------------------------- */
93 # define Newx(v, n, c) New(0, v, n, c)
97 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
101 # define SvRV_const(sv) SvRV((SV *) sv)
104 #ifndef SvREFCNT_inc_simple_void
105 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
109 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
112 #ifndef PERL_MAGIC_ext
113 # define PERL_MAGIC_ext '~'
116 #ifndef PERL_MAGIC_tied
117 # define PERL_MAGIC_tied 'P'
124 #ifndef IN_PERL_COMPILETIME
125 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
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)
136 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969) || VMG_HAS_PERL(5, 12, 0)
137 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
139 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
142 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
143 * reverted to dev-5.11 as 9cdcb38b */
144 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
145 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
146 # if VMG_HAS_PERL(5, 11, 0)
147 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
149 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
152 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
153 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
156 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
157 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
159 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
160 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
164 /* Applied to dev-5.11 as 34908 */
165 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908) || VMG_HAS_PERL(5, 12, 0)
166 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
168 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
171 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
172 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
173 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
175 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
178 #if VMG_HAS_PERL(5, 11, 0)
179 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 1
181 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 0
184 #if VMG_HAS_PERL(5, 13, 2)
185 # define VMG_COMPAT_GLOB_GET 1
187 # define VMG_COMPAT_GLOB_GET 0
190 /* ... Bug-free mg_magical ................................................. */
192 /* See the discussion at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html */
194 #if VMG_HAS_PERL(5, 11, 3)
196 #define vmg_mg_magical(S) mg_magical(S)
200 STATIC void vmg_mg_magical(SV *sv) {
204 if ((mg = SvMAGIC(sv))) {
206 const MGVTBL* const vtbl = mg->mg_virtual;
208 if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
215 } while ((mg = mg->mg_moremagic));
216 if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
223 /* ... Safe version of call_sv() ........................................... */
225 STATIC I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, int (*cleanup)(pTHX_ void *), void *ud) {
226 #define vmg_call_sv(S, F, C, U) vmg_call_sv(aTHX_ (S), (F), (C), (U))
227 I32 ret, cxix, in_eval = 0;
228 PERL_CONTEXT saved_cx;
236 if (cxstack_ix < cxstack_max) {
237 cxix = cxstack_ix + 1;
238 in_eval = CxTYPE(cxstack + cxix) == CXt_EVAL;
240 cxix = Perl_cxinc(aTHX);
242 /* The last popped context will be reused by call_sv(), but our callers may
243 * still need its previous value. Back it up so that it isn't clobbered. */
244 saved_cx = cxstack[cxix];
246 ret = call_sv(sv, flags | G_EVAL);
248 cxstack[cxix] = saved_cx;
252 sv_setsv(old_err, ERRSV);
256 if (IN_PERL_COMPILETIME) {
259 sv_catsv(PL_errors, ERRSV);
261 Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
264 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
266 ++PL_parser->error_count;
267 #elif defined(PL_error_count)
272 } else if (!in_eval) {
273 if (!cleanup || cleanup(aTHX_ ud))
286 /* --- Stolen chunk of B --------------------------------------------------- */
304 STATIC const char *const vmg_opclassnames[] = {
319 STATIC opclass vmg_opclass(const OP *o) {
326 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
328 if (o->op_type == OP_SASSIGN)
329 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
331 if (o->op_type == OP_AELEMFAST) {
332 #if PERL_VERSION <= 14
333 if (o->op_flags & OPf_SPECIAL)
345 if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
349 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
366 case OA_PVOP_OR_SVOP:
367 return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
372 case OA_BASEOP_OR_UNOP:
373 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
375 return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
377 (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
379 (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
382 if (o->op_flags & OPf_STACKED)
384 else if (o->op_flags & OPf_SPECIAL)
393 /* --- Error messages ------------------------------------------------------ */
395 STATIC const char vmg_invalid_wiz[] = "Invalid wizard object";
396 STATIC const char vmg_wrongargnum[] = "Wrong number of arguments";
397 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
399 /* --- Context-safe global data -------------------------------------------- */
401 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
404 HV *b__op_stashes[OPc_MAX];
409 /* --- <vmg_vtable> structure ---------------------------------------------- */
418 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
419 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
422 t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
424 t->vtbl = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
430 #define vmg_vtable_vtbl(T) (T)->vtbl
432 STATIC perl_mutex vmg_vtable_refcount_mutex;
434 STATIC vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
435 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
436 VMG_LOCK(&vmg_vtable_refcount_mutex);
438 VMG_UNLOCK(&vmg_vtable_refcount_mutex);
443 STATIC void vmg_vtable_free(pTHX_ vmg_vtable *t) {
444 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
447 VMG_LOCK(&vmg_vtable_refcount_mutex);
448 refcount = --t->refcount;
449 VMG_UNLOCK(&vmg_vtable_refcount_mutex);
452 PerlMemShared_free(t->vtbl);
453 PerlMemShared_free(t);
457 #else /* VMG_THREADSAFE */
459 typedef MGVTBL vmg_vtable;
461 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
462 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
465 Newx(t, 1, vmg_vtable);
470 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
472 #define vmg_vtable_free(T) Safefree(T)
474 #endif /* !VMG_THREADSAFE */
476 /* --- <vmg_wizard> structure ---------------------------------------------- */
485 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
490 #endif /* MGf_LOCAL */
492 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
493 #endif /* VMG_UVAR */
496 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo);
498 STATIC vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
499 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
502 Newx(w, 1, vmg_wizard);
505 w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
507 vmg_op_info_init(aTHX_ w->opinfo);
509 w->vtable = vmg_vtable_alloc();
514 STATIC void vmg_wizard_free(pTHX_ vmg_wizard *w) {
515 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
519 /* During global destruction, any of the callbacks may already have been
520 * freed, so we can't rely on still being able to access them. */
522 SvREFCNT_dec(w->cb_data);
523 SvREFCNT_dec(w->cb_get);
524 SvREFCNT_dec(w->cb_set);
525 SvREFCNT_dec(w->cb_len);
526 SvREFCNT_dec(w->cb_clear);
527 SvREFCNT_dec(w->cb_free);
528 SvREFCNT_dec(w->cb_copy);
530 SvREFCNT_dec(w->cb_dup);
533 SvREFCNT_dec(w->cb_local);
534 #endif /* MGf_LOCAL */
536 SvREFCNT_dec(w->cb_fetch);
537 SvREFCNT_dec(w->cb_store);
538 SvREFCNT_dec(w->cb_exists);
539 SvREFCNT_dec(w->cb_delete);
540 #endif /* VMG_UVAR */
543 /* PerlMemShared_free() and Safefree() are still fine during global
544 * destruction though. */
545 vmg_vtable_free(w->vtable);
553 #define VMG_CLONE_CB(N) \
554 z->cb_ ## N = (w->cb_ ## N) ? SvREFCNT_inc(sv_dup(w->cb_ ## N, params)) \
557 STATIC const vmg_wizard *vmg_wizard_dup(pTHX_ const vmg_wizard *w, CLONE_PARAMS *params) {
558 #define vmg_wizard_dup(W, P) vmg_wizard_dup(aTHX_ (W), (P))
564 Newx(z, 1, vmg_wizard);
566 z->vtable = vmg_vtable_dup(w->vtable);
568 z->opinfo = w->opinfo;
580 #endif /* MGf_LOCAL */
584 VMG_CLONE_CB(exists);
585 VMG_CLONE_CB(delete);
586 #endif /* VMG_UVAR */
591 #endif /* VMG_THREADSAFE */
593 #define vmg_wizard_id(W) PTR2IV(vmg_vtable_vtbl((W)->vtable))
595 /* --- Wizard SV objects --------------------------------------------------- */
597 STATIC int vmg_wizard_sv_free(pTHX_ SV *sv, MAGIC *mg) {
598 vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
605 STATIC int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
606 mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
611 #endif /* VMG_THREADSAFE */
613 STATIC MGVTBL vmg_wizard_sv_vtbl = {
618 vmg_wizard_sv_free, /* free */
621 vmg_wizard_sv_dup, /* dup */
627 #endif /* MGf_LOCAL */
630 STATIC SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
631 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
637 wiz = newSViv(PTR2IV(w));
641 MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_sv_vtbl,
642 (const char *) w, 0);
645 mg->mg_flags |= MGf_DUP;
655 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
657 STATIC const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
660 for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
661 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
662 return (const vmg_wizard *) mg->mg_ptr;
668 #else /* VMG_THREADSAFE */
670 #define vmg_sv_has_wizard_type(S) SvIOK(S)
672 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
674 #endif /* !VMG_THREADSAFE */
676 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
678 STATIC const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
679 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
680 SV *sv = (SV *) mg->mg_ptr;
682 if (vmg_sv_has_wizard_type(sv))
683 return vmg_wizard_from_sv_nocheck(sv);
689 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
691 /* --- User-level functions implementation --------------------------------- */
693 STATIC const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
697 if (SvTYPE(sv) < SVt_PVMG)
700 wid = vmg_wizard_id(w);
702 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
703 const vmg_wizard *z = vmg_wizard_from_mg(mg);
705 if (z && vmg_wizard_id(z) == wid)
712 /* ... Construct private data .............................................. */
714 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
715 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
725 EXTEND(SP, items + 1);
726 PUSHs(sv_2mortal(newRV_inc(sv)));
727 for (i = 0; i < items; ++i)
731 vmg_call_sv(ctor, G_SCALAR, 0, NULL);
735 #if VMG_HAS_PERL(5, 8, 3)
736 SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
738 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
748 STATIC SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
749 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
750 const MAGIC *mg = vmg_find(sv, w);
752 return mg ? mg->mg_obj : NULL;
755 /* ... Magic cast/dispell .................................................. */
758 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
761 struct ufuncs new_uf;
762 struct ufuncs old_uf;
765 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
767 prevmagic->mg_moremagic = moremagic;
769 SvMAGIC_set(sv, moremagic);
771 mg->mg_moremagic = NULL;
772 Safefree(mg->mg_ptr);
775 #endif /* VMG_UVAR */
777 STATIC UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
778 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
787 oldgmg = SvGMAGICAL(sv);
789 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
791 t = vmg_vtable_vtbl(w->vtable);
792 mg = sv_magicext(sv, data, PERL_MAGIC_ext, t, (const char *) wiz, HEf_SVKEY);
795 /* sv_magicext() calls mg_magical and increments data's refcount */
799 mg->mg_flags |= MGf_COPY;
802 mg->mg_flags |= MGf_DUP;
806 mg->mg_flags |= MGf_LOCAL;
807 #endif /* MGf_LOCAL */
809 if (SvTYPE(sv) < SVt_PVHV)
812 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
813 * magic is actually never called for them. If the GMAGICAL flag was off before
814 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
815 * now on, then this wizard has get magic. Hence we can work around the
816 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
817 * has uvar callbacks, it will be turned back on later. */
818 if (!oldgmg && SvGMAGICAL(sv))
823 MAGIC *prevmagic, *moremagic = NULL;
826 ud.new_uf.uf_val = vmg_svt_val;
827 ud.new_uf.uf_set = NULL;
828 ud.new_uf.uf_index = 0;
829 ud.old_uf.uf_val = NULL;
830 ud.old_uf.uf_set = NULL;
831 ud.old_uf.uf_index = 0;
833 /* One uvar magic in the chain is enough. */
834 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
835 moremagic = mg->mg_moremagic;
836 if (mg->mg_type == PERL_MAGIC_uvar)
840 if (mg) { /* Found another uvar magic. */
841 struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
842 if (uf->uf_val == vmg_svt_val) {
843 /* It's our uvar magic, nothing to do. oldgmg was true. */
846 /* It's another uvar magic, backup it and replace it by ours. */
848 vmg_uvar_del(sv, prevmagic, mg, moremagic);
852 sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
854 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
855 * handled by our uvar callback. */
857 #endif /* VMG_UVAR */
863 STATIC UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
864 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
867 #endif /* VMG_UVAR */
868 MAGIC *mg, *prevmagic, *moremagic = NULL;
869 IV wid = vmg_wizard_id(w);
871 if (SvTYPE(sv) < SVt_PVMG)
874 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
877 moremagic = mg->mg_moremagic;
879 z = vmg_wizard_from_mg(mg);
881 IV zid = vmg_wizard_id(z);
885 /* If the current has no uvar, short-circuit uvar deletion. */
886 uvars = z->uvar ? (uvars + 1) : 0;
888 } else if (z->uvar) {
890 /* We can't break here since we need to find the ext magic to delete. */
895 #endif /* !VMG_UVAR */
902 prevmagic->mg_moremagic = moremagic;
904 SvMAGIC_set(sv, moremagic);
906 mg->mg_moremagic = NULL;
908 /* Destroy private data */
909 if (mg->mg_obj != sv)
910 SvREFCNT_dec(mg->mg_obj);
911 /* Unreference the wizard */
912 SvREFCNT_dec((SV *) mg->mg_ptr);
916 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
917 /* mg was the first ext magic in the chain that had uvar */
919 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
920 const vmg_wizard *z = vmg_wizard_from_mg(mg);
931 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
932 moremagic = mg->mg_moremagic;
933 if (mg->mg_type == PERL_MAGIC_uvar)
937 ud = (vmg_uvar_ud *) mg->mg_ptr;
938 if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
939 /* Revert the original uvar magic. */
941 Newx(uf, 1, struct ufuncs);
944 mg->mg_ptr = (char *) uf;
945 mg->mg_len = sizeof(*uf);
947 /* Remove the uvar magic. */
948 vmg_uvar_del(sv, prevmagic, mg, moremagic);
952 #endif /* VMG_UVAR */
959 /* ... OP info ............................................................. */
961 #define VMG_OP_INFO_NAME 1
962 #define VMG_OP_INFO_OBJECT 2
965 STATIC perl_mutex vmg_op_name_init_mutex;
968 STATIC U32 vmg_op_name_init = 0;
969 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
971 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
972 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
974 case VMG_OP_INFO_NAME:
975 VMG_LOCK(&vmg_op_name_init_mutex);
976 if (!vmg_op_name_init) {
978 for (t = 0; t < OP_max; ++t)
979 vmg_op_name_len[t] = strlen(PL_op_name[t]);
980 vmg_op_name_init = 1;
982 VMG_UNLOCK(&vmg_op_name_init_mutex);
984 case VMG_OP_INFO_OBJECT: {
986 if (!MY_CXT.b__op_stashes[0]) {
989 for (c = OPc_NULL; c < OPc_MAX; ++c)
990 MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
999 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1000 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1002 return &PL_sv_undef;
1005 case VMG_OP_INFO_NAME: {
1006 OPCODE t = PL_op->op_type;
1007 return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1009 case VMG_OP_INFO_OBJECT: {
1011 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1012 MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1018 return &PL_sv_undef;
1021 /* --- svt callbacks ------------------------------------------------------- */
1023 #define VMG_CB_CALL_ARGS_MASK 15
1024 #define VMG_CB_CALL_ARGS_SHIFT 4
1025 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
1027 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1030 unsigned int i, args, opinfo;
1035 args = flags & VMG_CB_CALL_ARGS_MASK;
1036 flags >>= VMG_CB_CALL_ARGS_SHIFT;
1037 opinfo = flags & VMG_CB_CALL_OPINFO;
1043 EXTEND(SP, args + 1);
1044 PUSHs(sv_2mortal(newRV_inc(sv)));
1046 for (i = 0; i < args; ++i) {
1047 SV *sva = va_arg(ap, SV *);
1048 PUSHs(sva ? sva : &PL_sv_undef);
1052 XPUSHs(vmg_op_info(opinfo));
1055 vmg_call_sv(cb, G_SCALAR, 0, NULL);
1060 ret = (int) SvIV(svr);
1069 #define VMG_CB_FLAGS(OI, A) \
1070 ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1072 #define vmg_cb_call1(I, OI, S, A1) \
1073 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1074 #define vmg_cb_call2(I, OI, S, A1, A2) \
1075 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1076 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1077 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1079 STATIC int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1083 /* ... get magic ........................................................... */
1085 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1086 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1088 return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1091 #define vmg_svt_get_noop vmg_svt_default_noop
1093 /* ... set magic ........................................................... */
1095 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1096 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1098 return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1101 #define vmg_svt_set_noop vmg_svt_default_noop
1103 /* ... len magic ........................................................... */
1105 STATIC U32 vmg_sv_len(pTHX_ SV *sv) {
1106 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1108 #if VMG_HAS_PERL(5, 9, 3)
1109 const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1111 U8 *s = SvPV(sv, len);
1114 return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1117 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1118 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1119 unsigned int opinfo = w->opinfo;
1122 svtype t = SvTYPE(sv);
1131 PUSHs(sv_2mortal(newRV_inc(sv)));
1132 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1134 len = vmg_sv_len(sv);
1136 } else if (t == SVt_PVAV) {
1137 len = av_len((AV *) sv) + 1;
1141 PUSHs(&PL_sv_undef);
1144 XPUSHs(vmg_op_info(opinfo));
1147 vmg_call_sv(w->cb_len, G_SCALAR, 0, NULL);
1151 ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1162 STATIC U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1164 svtype t = SvTYPE(sv);
1167 len = vmg_sv_len(sv);
1168 } else if (t == SVt_PVAV) {
1169 len = (U32) av_len((AV *) sv);
1175 /* ... clear magic ......................................................... */
1177 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1178 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1180 return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
1183 #define vmg_svt_clear_noop vmg_svt_default_noop
1185 /* ... free magic .......................................................... */
1187 STATIC int vmg_svt_free_cleanup(pTHX_ void *ud) {
1188 SV *sv = VOID2(SV *, ud);
1191 /* We are about to croak() while sv is being destroyed. Try to clean up
1194 SvREFCNT_dec((SV *) mg->mg_ptr);
1195 /* mg->mg_obj may not be refcounted if the data constructor returned the
1196 * variable itself. */
1197 if (mg->mg_flags & MGf_REFCOUNTED)
1198 SvREFCNT_dec(mg->mg_obj);
1199 SvMAGIC_set(sv, mg->mg_moremagic);
1204 /* After that, propagate the error upwards. */
1208 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1209 const vmg_wizard *w;
1215 /* During global destruction, we cannot be sure that the wizard and its free
1216 * callback are still alive. */
1220 w = vmg_wizard_from_mg_nocheck(mg);
1222 /* So that it survives the temp cleanup below */
1223 SvREFCNT_inc_simple_void(sv);
1225 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1226 /* The previous magic tokens were freed but the magic chain wasn't updated, so
1227 * if you access the sv from the callback the old deleted magics will trigger
1228 * and cause memory misreads. Change 32686 solved it that way : */
1229 SvMAGIC_set(sv, mg);
1237 PUSHs(sv_2mortal(newRV_inc(sv)));
1238 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1240 XPUSHs(vmg_op_info(w->opinfo));
1243 vmg_call_sv(w->cb_free, G_SCALAR, vmg_svt_free_cleanup, sv);
1248 ret = (int) SvIV(svr);
1254 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1255 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1258 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1259 * mg->mg_ptr reference count */
1263 #define vmg_svt_free_noop vmg_svt_default_noop
1265 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1266 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1268 # define VMG_SVT_COPY_KEYLEN_TYPE int
1271 /* ... copy magic .......................................................... */
1273 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1274 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1278 if (keylen == HEf_SVKEY) {
1281 keysv = newSVpvn(key, keylen);
1284 ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1286 if (keylen != HEf_SVKEY) {
1287 SvREFCNT_dec(keysv);
1293 STATIC int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1297 /* ... dup magic ........................................................... */
1300 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1303 #define vmg_svt_dup_noop vmg_svt_dup
1306 /* ... local magic ......................................................... */
1310 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1311 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1313 return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1316 #define vmg_svt_local_noop vmg_svt_default_noop
1318 #endif /* MGf_LOCAL */
1320 /* ... uvar magic .......................................................... */
1323 STATIC OP *vmg_pp_resetuvar(pTHX) {
1324 SvRMAGICAL_on(cSVOP_sv);
1328 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1331 SV *key = NULL, *newkey = NULL;
1334 umg = mg_find(sv, PERL_MAGIC_uvar);
1335 /* umg can't be NULL or we wouldn't be there. */
1337 ud = (vmg_uvar_ud *) umg->mg_ptr;
1339 if (ud->old_uf.uf_val)
1340 ud->old_uf.uf_val(aTHX_ action, sv);
1341 if (ud->old_uf.uf_set)
1342 ud->old_uf.uf_set(aTHX_ action, sv);
1344 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
1345 const vmg_wizard *w;
1347 switch (mg->mg_type) {
1348 case PERL_MAGIC_ext:
1350 case PERL_MAGIC_tied:
1357 w = vmg_wizard_from_mg(mg);
1366 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1370 & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1373 vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
1375 case HV_FETCH_ISSTORE:
1376 case HV_FETCH_LVALUE:
1377 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1379 vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
1381 case HV_FETCH_ISEXISTS:
1383 vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
1387 vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
1392 if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1393 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1394 * mistaken for a tied hash by the rest of hv_common. It will be reset by
1395 * the op_ppaddr of a new fake op injected between the current and the next
1397 OP *nop = PL_op->op_next;
1398 if (!nop || nop->op_ppaddr != vmg_pp_resetuvar) {
1400 NewOp(1101, svop, 1, SVOP);
1401 svop->op_type = OP_STUB;
1402 svop->op_ppaddr = vmg_pp_resetuvar;
1403 svop->op_next = nop;
1406 PL_op->op_next = (OP *) svop;
1413 #endif /* VMG_UVAR */
1415 /* --- Macros for the XS section ------------------------------------------- */
1418 # define VMG_CVOK(C) \
1419 ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
1421 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
1424 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
1426 #define VMG_SET_CB(S, N) { \
1428 if (SvOK(cb) && SvROK(cb)) { \
1431 SvREFCNT_inc_simple_void(cb); \
1440 #define VMG_SET_SVT_CB(S, N) { \
1442 if (SvOK(cb) && SvROK(cb)) { \
1444 if (VMG_CBOK(cb)) { \
1445 t->svt_ ## N = vmg_svt_ ## N; \
1446 SvREFCNT_inc_simple_void(cb); \
1448 t->svt_ ## N = vmg_svt_ ## N ## _noop; \
1452 t->svt_ ## N = NULL; \
1458 /* --- XS ------------------------------------------------------------------ */
1460 MODULE = Variable::Magic PACKAGE = Variable::Magic
1469 MY_CXT.b__op_stashes[0] = NULL;
1471 MUTEX_INIT(&vmg_vtable_refcount_mutex);
1472 MUTEX_INIT(&vmg_op_name_init_mutex);
1475 stash = gv_stashpv(__PACKAGE__, 1);
1476 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1477 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1478 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1479 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1480 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1481 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1482 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1483 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1484 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1485 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1486 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1487 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1488 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1489 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1490 newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1491 newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1492 newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1493 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1494 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
1495 newCONSTSUB(stash, "VMG_FORKSAFE", newSVuv(VMG_FORKSAFE));
1496 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1497 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1506 U32 had_b__op_stash = 0;
1511 for (c = OPc_NULL; c < OPc_MAX; ++c) {
1512 if (MY_CXT.b__op_stashes[c])
1513 had_b__op_stash |= (((U32) 1) << c);
1518 for (c = OPc_NULL; c < OPc_MAX; ++c) {
1519 MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1520 ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1525 #endif /* VMG_THREADSAFE */
1532 SV *op_info, *copy_key;
1538 #endif /* MGf_LOCAL */
1541 #endif /* VMG_UVAR */
1542 ) { croak(vmg_wrongargnum); }
1545 w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
1546 t = vmg_vtable_vtbl(w->vtable);
1548 VMG_SET_CB(ST(i++), data);
1550 VMG_SET_SVT_CB(ST(i++), get);
1551 VMG_SET_SVT_CB(ST(i++), set);
1552 VMG_SET_SVT_CB(ST(i++), len);
1553 VMG_SET_SVT_CB(ST(i++), clear);
1554 VMG_SET_SVT_CB(ST(i++), free);
1555 VMG_SET_SVT_CB(ST(i++), copy);
1556 /* VMG_SET_SVT_CB(ST(i++), dup); */
1561 VMG_SET_SVT_CB(ST(i++), local);
1562 #endif /* MGf_LOCAL */
1564 VMG_SET_CB(ST(i++), fetch);
1565 VMG_SET_CB(ST(i++), store);
1566 VMG_SET_CB(ST(i++), exists);
1567 VMG_SET_CB(ST(i++), delete);
1570 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1571 w->uvar = SvTRUE(copy_key) ? 2 : 1;
1572 #endif /* VMG_UVAR */
1574 RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
1578 SV *cast(SV *sv, SV *wiz, ...)
1579 PROTOTYPE: \[$@%&*]$@
1581 const vmg_wizard *w = NULL;
1591 wiz = SvRV_const(wiz);
1592 w = vmg_wizard_from_sv(wiz);
1595 croak(vmg_invalid_wiz);
1596 RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
1601 getdata(SV *sv, SV *wiz)
1602 PROTOTYPE: \[$@%&*]$
1604 const vmg_wizard *w = NULL;
1608 w = vmg_wizard_from_sv(SvRV_const(wiz));
1610 croak(vmg_invalid_wiz);
1611 data = vmg_data_get(SvRV(sv), w);
1617 SV *dispell(SV *sv, SV *wiz)
1618 PROTOTYPE: \[$@%&*]$
1620 const vmg_wizard *w = NULL;
1623 w = vmg_wizard_from_sv(SvRV_const(wiz));
1625 croak(vmg_invalid_wiz);
1626 RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));