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 #define VMG_SAVE_LAST_CX (!VMG_HAS_PERL(5, 8, 4) || VMG_HAS_PERL(5, 9, 5))
227 STATIC I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, I32 destructor) {
228 #define vmg_call_sv(S, F, D) vmg_call_sv(aTHX_ (S), (F), (D))
229 I32 ret, cxix = 0, in_eval = 0;
231 PERL_CONTEXT saved_cx;
240 if (cxstack_ix < cxstack_max) {
241 cxix = cxstack_ix + 1;
242 if (destructor && CxTYPE(cxstack + cxix) == CXt_EVAL)
247 /* The last popped context will be reused by call_sv(), but our callers may
248 * still need its previous value. Back it up so that it isn't clobbered. */
249 saved_cx = cxstack[cxix];
252 ret = call_sv(sv, flags | G_EVAL);
255 cxstack[cxix] = saved_cx;
260 sv_setsv(old_err, ERRSV);
264 if (IN_PERL_COMPILETIME) {
267 sv_catsv(PL_errors, ERRSV);
269 Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
272 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
274 ++PL_parser->error_count;
275 #elif defined(PL_error_count)
292 /* --- Stolen chunk of B --------------------------------------------------- */
310 STATIC const char *const vmg_opclassnames[] = {
325 STATIC opclass vmg_opclass(const OP *o) {
332 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
334 if (o->op_type == OP_SASSIGN)
335 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
337 if (o->op_type == OP_AELEMFAST) {
338 #if PERL_VERSION <= 14
339 if (o->op_flags & OPf_SPECIAL)
351 if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
355 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
372 case OA_PVOP_OR_SVOP:
373 return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
378 case OA_BASEOP_OR_UNOP:
379 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
381 return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
383 (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
385 (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
388 if (o->op_flags & OPf_STACKED)
390 else if (o->op_flags & OPf_SPECIAL)
399 /* --- Error messages ------------------------------------------------------ */
401 STATIC const char vmg_invalid_wiz[] = "Invalid wizard object";
402 STATIC const char vmg_wrongargnum[] = "Wrong number of arguments";
403 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
405 /* --- Context-safe global data -------------------------------------------- */
407 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
410 HV *b__op_stashes[OPc_MAX];
415 /* --- <vmg_vtable> structure ---------------------------------------------- */
424 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
425 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
428 t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
430 t->vtbl = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
436 #define vmg_vtable_vtbl(T) (T)->vtbl
438 STATIC perl_mutex vmg_vtable_refcount_mutex;
440 STATIC vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
441 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
442 VMG_LOCK(&vmg_vtable_refcount_mutex);
444 VMG_UNLOCK(&vmg_vtable_refcount_mutex);
449 STATIC void vmg_vtable_free(pTHX_ vmg_vtable *t) {
450 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
453 VMG_LOCK(&vmg_vtable_refcount_mutex);
454 refcount = --t->refcount;
455 VMG_UNLOCK(&vmg_vtable_refcount_mutex);
458 PerlMemShared_free(t->vtbl);
459 PerlMemShared_free(t);
463 #else /* VMG_THREADSAFE */
465 typedef MGVTBL vmg_vtable;
467 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
468 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
471 Newx(t, 1, vmg_vtable);
476 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
478 #define vmg_vtable_free(T) Safefree(T)
480 #endif /* !VMG_THREADSAFE */
482 /* --- <vmg_wizard> structure ---------------------------------------------- */
491 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
496 #endif /* MGf_LOCAL */
498 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
499 #endif /* VMG_UVAR */
502 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo);
504 STATIC vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
505 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
508 Newx(w, 1, vmg_wizard);
511 w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
513 vmg_op_info_init(aTHX_ w->opinfo);
515 w->vtable = vmg_vtable_alloc();
520 STATIC void vmg_wizard_free(pTHX_ vmg_wizard *w) {
521 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
525 SvREFCNT_dec(w->cb_data);
526 SvREFCNT_dec(w->cb_get);
527 SvREFCNT_dec(w->cb_set);
528 SvREFCNT_dec(w->cb_len);
529 SvREFCNT_dec(w->cb_clear);
530 SvREFCNT_dec(w->cb_free);
531 SvREFCNT_dec(w->cb_copy);
533 SvREFCNT_dec(w->cb_dup);
536 SvREFCNT_dec(w->cb_local);
537 #endif /* MGf_LOCAL */
539 SvREFCNT_dec(w->cb_fetch);
540 SvREFCNT_dec(w->cb_store);
541 SvREFCNT_dec(w->cb_exists);
542 SvREFCNT_dec(w->cb_delete);
543 #endif /* VMG_UVAR */
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 if (PL_dirty) /* During global destruction, the context is already freed */
601 vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
608 STATIC int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
609 mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
614 #endif /* VMG_THREADSAFE */
616 STATIC MGVTBL vmg_wizard_sv_vtbl = {
621 vmg_wizard_sv_free, /* free */
624 vmg_wizard_sv_dup, /* dup */
630 #endif /* MGf_LOCAL */
633 STATIC SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
634 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
640 wiz = newSViv(PTR2IV(w));
644 MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_sv_vtbl,
645 (const char *) w, 0);
648 mg->mg_flags |= MGf_DUP;
658 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
660 STATIC const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
663 for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
664 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
665 return (const vmg_wizard *) mg->mg_ptr;
671 #else /* VMG_THREADSAFE */
673 #define vmg_sv_has_wizard_type(S) SvIOK(S)
675 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
677 #endif /* !VMG_THREADSAFE */
679 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
681 STATIC const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
682 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
683 SV *sv = (SV *) mg->mg_ptr;
685 if (vmg_sv_has_wizard_type(sv))
686 return vmg_wizard_from_sv_nocheck(sv);
692 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
694 /* --- User-level functions implementation --------------------------------- */
696 STATIC const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
700 if (SvTYPE(sv) < SVt_PVMG)
703 wid = vmg_wizard_id(w);
705 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
706 const vmg_wizard *z = vmg_wizard_from_mg(mg);
708 if (z && vmg_wizard_id(z) == wid)
715 /* ... Construct private data .............................................. */
717 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
718 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
728 EXTEND(SP, items + 1);
729 PUSHs(sv_2mortal(newRV_inc(sv)));
730 for (i = 0; i < items; ++i)
734 vmg_call_sv(ctor, G_SCALAR, 0);
738 #if VMG_HAS_PERL(5, 8, 3)
739 SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
741 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
751 STATIC SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
752 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
753 const MAGIC *mg = vmg_find(sv, w);
755 return mg ? mg->mg_obj : NULL;
758 /* ... Magic cast/dispell .................................................. */
761 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
763 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
765 prevmagic->mg_moremagic = moremagic;
767 SvMAGIC_set(sv, moremagic);
769 mg->mg_moremagic = NULL;
770 Safefree(mg->mg_ptr);
773 #endif /* VMG_UVAR */
775 STATIC UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
776 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
785 oldgmg = SvGMAGICAL(sv);
787 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
789 t = vmg_vtable_vtbl(w->vtable);
790 mg = sv_magicext(sv, data, PERL_MAGIC_ext, t, (const char *) wiz, HEf_SVKEY);
793 /* sv_magicext() calls mg_magical and increments data's refcount */
797 mg->mg_flags |= MGf_COPY;
800 mg->mg_flags |= MGf_DUP;
804 mg->mg_flags |= MGf_LOCAL;
805 #endif /* MGf_LOCAL */
807 if (SvTYPE(sv) < SVt_PVHV)
810 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
811 * magic is actually never called for them. If the GMAGICAL flag was off before
812 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
813 * now on, then this wizard has get magic. Hence we can work around the
814 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
815 * has uvar callbacks, it will be turned back on later. */
816 if (!oldgmg && SvGMAGICAL(sv))
821 MAGIC *prevmagic, *moremagic = NULL;
824 uf[0].uf_val = vmg_svt_val;
831 /* One uvar magic in the chain is enough. */
832 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
833 moremagic = mg->mg_moremagic;
834 if (mg->mg_type == PERL_MAGIC_uvar)
838 if (mg) { /* Found another uvar magic. */
839 struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
840 if (olduf->uf_val == vmg_svt_val) {
841 /* It's our uvar magic, nothing to do. oldgmg was true. */
844 /* It's another uvar magic, backup it and replace it by ours. */
846 vmg_uvar_del(sv, prevmagic, mg, moremagic);
850 sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &uf, sizeof(uf));
852 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
853 * handled by our uvar callback. */
855 #endif /* VMG_UVAR */
861 STATIC UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
862 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
865 #endif /* VMG_UVAR */
866 MAGIC *mg, *prevmagic, *moremagic = NULL;
867 IV wid = vmg_wizard_id(w);
869 if (SvTYPE(sv) < SVt_PVMG)
872 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
875 moremagic = mg->mg_moremagic;
877 z = vmg_wizard_from_mg(mg);
879 IV zid = vmg_wizard_id(z);
883 /* If the current has no uvar, short-circuit uvar deletion. */
884 uvars = z->uvar ? (uvars + 1) : 0;
886 } else if (z->uvar) {
888 /* We can't break here since we need to find the ext magic to delete. */
893 #endif /* !VMG_UVAR */
900 prevmagic->mg_moremagic = moremagic;
902 SvMAGIC_set(sv, moremagic);
904 mg->mg_moremagic = NULL;
906 /* Destroy private data */
907 if (mg->mg_obj != sv)
908 SvREFCNT_dec(mg->mg_obj);
909 /* Unreference the wizard */
910 SvREFCNT_dec((SV *) mg->mg_ptr);
914 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
915 /* mg was the first ext magic in the chain that had uvar */
917 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
918 const vmg_wizard *z = vmg_wizard_from_mg(mg);
928 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
929 moremagic = mg->mg_moremagic;
930 if (mg->mg_type == PERL_MAGIC_uvar)
934 uf = (struct ufuncs *) mg->mg_ptr;
935 /* assert(uf->uf_val == vmg_svt_val); */
936 if (uf[1].uf_val || uf[1].uf_set) {
937 /* Revert the original uvar magic. */
939 Renew(uf, 1, struct ufuncs);
940 mg->mg_ptr = (char *) uf;
941 mg->mg_len = sizeof(struct ufuncs);
943 /* Remove the uvar magic. */
944 vmg_uvar_del(sv, prevmagic, mg, moremagic);
948 #endif /* VMG_UVAR */
955 /* ... OP info ............................................................. */
957 #define VMG_OP_INFO_NAME 1
958 #define VMG_OP_INFO_OBJECT 2
961 STATIC perl_mutex vmg_op_name_init_mutex;
964 STATIC U32 vmg_op_name_init = 0;
965 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
967 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
968 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
970 case VMG_OP_INFO_NAME:
971 VMG_LOCK(&vmg_op_name_init_mutex);
972 if (!vmg_op_name_init) {
974 for (t = 0; t < OP_max; ++t)
975 vmg_op_name_len[t] = strlen(PL_op_name[t]);
976 vmg_op_name_init = 1;
978 VMG_UNLOCK(&vmg_op_name_init_mutex);
980 case VMG_OP_INFO_OBJECT: {
982 if (!MY_CXT.b__op_stashes[0]) {
985 for (c = OPc_NULL; c < OPc_MAX; ++c)
986 MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
995 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
996 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1001 case VMG_OP_INFO_NAME: {
1002 OPCODE t = PL_op->op_type;
1003 return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1005 case VMG_OP_INFO_OBJECT: {
1007 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1008 MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1014 return &PL_sv_undef;
1017 /* --- svt callbacks ------------------------------------------------------- */
1019 #define VMG_CB_CALL_ARGS_MASK 15
1020 #define VMG_CB_CALL_ARGS_SHIFT 4
1021 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
1023 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1026 unsigned int i, args, opinfo;
1031 args = flags & VMG_CB_CALL_ARGS_MASK;
1032 flags >>= VMG_CB_CALL_ARGS_SHIFT;
1033 opinfo = flags & VMG_CB_CALL_OPINFO;
1039 EXTEND(SP, args + 1);
1040 PUSHs(sv_2mortal(newRV_inc(sv)));
1042 for (i = 0; i < args; ++i) {
1043 SV *sva = va_arg(ap, SV *);
1044 PUSHs(sva ? sva : &PL_sv_undef);
1048 XPUSHs(vmg_op_info(opinfo));
1051 vmg_call_sv(cb, G_SCALAR, 0);
1056 ret = (int) SvIV(svr);
1065 #define VMG_CB_FLAGS(OI, A) \
1066 ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1068 #define vmg_cb_call1(I, OI, S, A1) \
1069 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1070 #define vmg_cb_call2(I, OI, S, A1, A2) \
1071 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1072 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1073 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1075 STATIC int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1079 /* ... get magic ........................................................... */
1081 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1082 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1084 return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1087 #define vmg_svt_get_noop vmg_svt_default_noop
1089 /* ... set magic ........................................................... */
1091 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1092 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1094 return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1097 #define vmg_svt_set_noop vmg_svt_default_noop
1099 /* ... len magic ........................................................... */
1101 STATIC U32 vmg_sv_len(pTHX_ SV *sv) {
1102 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1104 #if VMG_HAS_PERL(5, 9, 3)
1105 const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1107 U8 *s = SvPV(sv, len);
1110 return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1113 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1114 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1115 unsigned int opinfo = w->opinfo;
1118 svtype t = SvTYPE(sv);
1127 PUSHs(sv_2mortal(newRV_inc(sv)));
1128 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1130 len = vmg_sv_len(sv);
1132 } else if (t == SVt_PVAV) {
1133 len = av_len((AV *) sv) + 1;
1137 PUSHs(&PL_sv_undef);
1140 XPUSHs(vmg_op_info(opinfo));
1143 vmg_call_sv(w->cb_len, G_SCALAR, 0);
1147 ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1158 STATIC U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1160 svtype t = SvTYPE(sv);
1163 len = vmg_sv_len(sv);
1164 } else if (t == SVt_PVAV) {
1165 len = (U32) av_len((AV *) sv);
1171 /* ... clear magic ......................................................... */
1173 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1174 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1176 return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
1179 #define vmg_svt_clear_noop vmg_svt_default_noop
1181 /* ... free magic .......................................................... */
1183 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1184 const vmg_wizard *w;
1190 /* Don't even bother if we are in global destruction - the wizard is prisoner
1191 * of circular references and we are way beyond user realm */
1195 w = vmg_wizard_from_mg_nocheck(mg);
1197 /* So that it survives the temp cleanup below */
1198 SvREFCNT_inc_simple_void(sv);
1200 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1201 /* The previous magic tokens were freed but the magic chain wasn't updated, so
1202 * if you access the sv from the callback the old deleted magics will trigger
1203 * and cause memory misreads. Change 32686 solved it that way : */
1204 SvMAGIC_set(sv, mg);
1212 PUSHs(sv_2mortal(newRV_inc(sv)));
1213 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1215 XPUSHs(vmg_op_info(w->opinfo));
1218 vmg_call_sv(w->cb_free, G_SCALAR, 1);
1223 ret = (int) SvIV(svr);
1229 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1230 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1233 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1234 * mg->mg_ptr reference count */
1238 #define vmg_svt_free_noop vmg_svt_default_noop
1240 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1241 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1243 # define VMG_SVT_COPY_KEYLEN_TYPE int
1246 /* ... copy magic .......................................................... */
1248 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1249 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1253 if (keylen == HEf_SVKEY) {
1256 keysv = newSVpvn(key, keylen);
1259 ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1261 if (keylen != HEf_SVKEY) {
1262 SvREFCNT_dec(keysv);
1268 STATIC int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1272 /* ... dup magic ........................................................... */
1275 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1278 #define vmg_svt_dup_noop vmg_svt_dup
1281 /* ... local magic ......................................................... */
1285 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1286 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1288 return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1291 #define vmg_svt_local_noop vmg_svt_default_noop
1293 #endif /* MGf_LOCAL */
1295 /* ... uvar magic .......................................................... */
1298 STATIC OP *vmg_pp_resetuvar(pTHX) {
1299 SvRMAGICAL_on(cSVOP_sv);
1303 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1306 SV *key = NULL, *newkey = NULL;
1309 umg = mg_find(sv, PERL_MAGIC_uvar);
1310 /* umg can't be NULL or we wouldn't be there. */
1312 uf = (struct ufuncs *) umg->mg_ptr;
1315 uf[1].uf_val(aTHX_ action, sv);
1317 uf[1].uf_set(aTHX_ action, sv);
1319 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
1320 const vmg_wizard *w;
1322 switch (mg->mg_type) {
1323 case PERL_MAGIC_ext:
1325 case PERL_MAGIC_tied:
1332 w = vmg_wizard_from_mg(mg);
1341 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1345 & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1348 vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
1350 case HV_FETCH_ISSTORE:
1351 case HV_FETCH_LVALUE:
1352 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1354 vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
1356 case HV_FETCH_ISEXISTS:
1358 vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
1362 vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
1367 if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1368 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1369 * mistaken for a tied hash by the rest of hv_common. It will be reset by
1370 * the op_ppaddr of a new fake op injected between the current and the next
1372 OP *nop = PL_op->op_next;
1373 if (!nop || nop->op_ppaddr != vmg_pp_resetuvar) {
1375 NewOp(1101, svop, 1, SVOP);
1376 svop->op_type = OP_STUB;
1377 svop->op_ppaddr = vmg_pp_resetuvar;
1378 svop->op_next = nop;
1381 PL_op->op_next = (OP *) svop;
1388 #endif /* VMG_UVAR */
1390 /* --- Macros for the XS section ------------------------------------------- */
1393 # define VMG_CVOK(C) \
1394 ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
1396 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
1399 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
1401 #define VMG_SET_CB(S, N) { \
1403 if (SvOK(cb) && SvROK(cb)) { \
1406 SvREFCNT_inc_simple_void(cb); \
1415 #define VMG_SET_SVT_CB(S, N) { \
1417 if (SvOK(cb) && SvROK(cb)) { \
1419 if (VMG_CBOK(cb)) { \
1420 t->svt_ ## N = vmg_svt_ ## N; \
1421 SvREFCNT_inc_simple_void(cb); \
1423 t->svt_ ## N = vmg_svt_ ## N ## _noop; \
1427 t->svt_ ## N = NULL; \
1433 /* --- XS ------------------------------------------------------------------ */
1435 MODULE = Variable::Magic PACKAGE = Variable::Magic
1444 MY_CXT.b__op_stashes[0] = NULL;
1446 MUTEX_INIT(&vmg_vtable_refcount_mutex);
1447 MUTEX_INIT(&vmg_op_name_init_mutex);
1450 stash = gv_stashpv(__PACKAGE__, 1);
1451 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1452 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1453 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1454 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1455 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1456 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1457 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1458 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1459 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1460 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1461 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1462 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1463 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1464 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1465 newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1466 newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1467 newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1468 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1469 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
1470 newCONSTSUB(stash, "VMG_FORKSAFE", newSVuv(VMG_FORKSAFE));
1471 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1472 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1481 U32 had_b__op_stash = 0;
1486 for (c = OPc_NULL; c < OPc_MAX; ++c) {
1487 if (MY_CXT.b__op_stashes[c])
1488 had_b__op_stash |= (((U32) 1) << c);
1493 for (c = OPc_NULL; c < OPc_MAX; ++c) {
1494 MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1495 ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1500 #endif /* VMG_THREADSAFE */
1507 SV *op_info, *copy_key;
1513 #endif /* MGf_LOCAL */
1516 #endif /* VMG_UVAR */
1517 ) { croak(vmg_wrongargnum); }
1520 w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
1521 t = vmg_vtable_vtbl(w->vtable);
1523 VMG_SET_CB(ST(i++), data);
1525 VMG_SET_SVT_CB(ST(i++), get);
1526 VMG_SET_SVT_CB(ST(i++), set);
1527 VMG_SET_SVT_CB(ST(i++), len);
1528 VMG_SET_SVT_CB(ST(i++), clear);
1529 VMG_SET_SVT_CB(ST(i++), free);
1530 VMG_SET_SVT_CB(ST(i++), copy);
1531 /* VMG_SET_SVT_CB(ST(i++), dup); */
1536 VMG_SET_SVT_CB(ST(i++), local);
1537 #endif /* MGf_LOCAL */
1539 VMG_SET_CB(ST(i++), fetch);
1540 VMG_SET_CB(ST(i++), store);
1541 VMG_SET_CB(ST(i++), exists);
1542 VMG_SET_CB(ST(i++), delete);
1545 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1546 w->uvar = SvTRUE(copy_key) ? 2 : 1;
1547 #endif /* VMG_UVAR */
1549 RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
1553 SV *cast(SV *sv, SV *wiz, ...)
1554 PROTOTYPE: \[$@%&*]$@
1556 const vmg_wizard *w = NULL;
1566 wiz = SvRV_const(wiz);
1567 w = vmg_wizard_from_sv(wiz);
1570 croak(vmg_invalid_wiz);
1571 RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
1576 getdata(SV *sv, SV *wiz)
1577 PROTOTYPE: \[$@%&*]$
1579 const vmg_wizard *w = NULL;
1583 w = vmg_wizard_from_sv(SvRV_const(wiz));
1585 croak(vmg_invalid_wiz);
1586 data = vmg_data_get(SvRV(sv), w);
1592 SV *dispell(SV *sv, SV *wiz)
1593 PROTOTYPE: \[$@%&*]$
1595 const vmg_wizard *w = NULL;
1598 w = vmg_wizard_from_sv(SvRV_const(wiz));
1600 croak(vmg_invalid_wiz);
1601 RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));